2
0
mirror of https://github.com/openvswitch/ovs synced 2025-08-22 09:58:01 +00:00
ovs/lib/async-append.h
Ben Pfaff 888e0cf441 async-append: Refactor to avoid requiring enabling while single threaded.
Until now, the async append interface has required async_append_enable()
to be called while the process was still single-threaded, with the
rationale being that async_append_enable() could race with
async_append_write() on some existing async_append object.  This was a
difficult problem when the async append interface was introduced, because
at the time Open vSwitch did not have any infrastructure for inter-thread
synchronization.

Now it is easy to solve, by introducing synchronization into the
async append module.  However, that's more or less wasted, because the
client is already required to serialize access to async append objects.
Moreover, vlog, the only existing client, needs to serialize access for
other reasons, so it wouldn't even be possible to just drop the client's
synchronization.

This commit therefore takes another approach.  It drops the
async_append_enable() interface entirely.  Now any existing async_append
object is always enabled.  The responsibility for "enabling", then, now
rests in whether the client creates and uses an async_append object, and
so vlog now takes care of that by itself.  Also, since vlog now has to
deal with sometimes having an async_append and sometimes not having one,
we might as well allow creating an async_append to fail, thereby slightly
simplifying the "no async I/O" implementation from "write synchronously"
to "always fail creating an async_append".

Reported-by: Shih-Hao Li <shihli@nicira.com>
Signed-off-by: Ben Pfaff <blp@nicira.com>
2013-08-02 20:03:52 -07:00

54 lines
2.0 KiB
C

/* Copyright (c) 2013 Nicira, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#ifndef ASYNC_APPEND_H
#define ASYNC_APPEND_H 1
#include <stddef.h>
/* This module defines a simple, abstract interface to asynchronous file I/O.
* It is currently used only for logging. Thus, for now the interface only
* supports appending to a file. Multiple implementations are possible
* depending on the operating system's degree and form of support for
* asynchronous I/O.
*
* The comments below document the requirements on any implementation.
*
* Thread-safety
* =============
*
* Only a single thread may use a given 'struct async_append' at one time.
*/
/* Creates and returns a new asynchronous appender for file descriptor 'fd',
* which the caller must have opened in append mode (O_APPEND). If the system
* is for some reason unable to support asynchronous I/O on 'fd' this function
* may return NULL. */
struct async_append *async_append_create(int fd);
/* Destroys 'ap', without closing its underlying file descriptor. */
void async_append_destroy(struct async_append *ap);
/* Appends the 'size' bytes of 'data' to 'ap', asynchronously if possible. */
void async_append_write(struct async_append *ap,
const void *data, size_t size);
/* Blocks until all data asynchronously written to 'ap' with
* async_append_write() has been committed to the point that it will be written
* to disk barring an operating system or hardware failure. */
void async_append_flush(struct async_append *ap);
#endif /* async-append.h */