2008-09-22 21:17:18 +02:00
|
|
|
/*
|
|
|
|
* QEMU aio implementation
|
|
|
|
*
|
|
|
|
* Copyright IBM, Corp. 2008
|
|
|
|
*
|
|
|
|
* Authors:
|
|
|
|
* Anthony Liguori <aliguori@us.ibm.com>
|
|
|
|
*
|
|
|
|
* This work is licensed under the terms of the GNU GPL, version 2. See
|
|
|
|
* the COPYING file in the top-level directory.
|
|
|
|
*
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef QEMU_AIO_H
|
|
|
|
#define QEMU_AIO_H
|
|
|
|
|
|
|
|
#include "qemu-common.h"
|
2012-09-13 12:28:51 +02:00
|
|
|
#include "qemu-queue.h"
|
2012-06-09 03:44:00 +02:00
|
|
|
#include "event_notifier.h"
|
2008-09-22 21:17:18 +02:00
|
|
|
|
2012-03-12 17:01:48 +01:00
|
|
|
typedef struct BlockDriverAIOCB BlockDriverAIOCB;
|
|
|
|
typedef void BlockDriverCompletionFunc(void *opaque, int ret);
|
|
|
|
|
|
|
|
typedef struct AIOPool {
|
|
|
|
void (*cancel)(BlockDriverAIOCB *acb);
|
|
|
|
int aiocb_size;
|
|
|
|
BlockDriverAIOCB *free_aiocb;
|
|
|
|
} AIOPool;
|
|
|
|
|
|
|
|
struct BlockDriverAIOCB {
|
|
|
|
AIOPool *pool;
|
|
|
|
BlockDriverState *bs;
|
|
|
|
BlockDriverCompletionFunc *cb;
|
|
|
|
void *opaque;
|
|
|
|
BlockDriverAIOCB *next;
|
|
|
|
};
|
|
|
|
|
|
|
|
void *qemu_aio_get(AIOPool *pool, BlockDriverState *bs,
|
|
|
|
BlockDriverCompletionFunc *cb, void *opaque);
|
|
|
|
void qemu_aio_release(void *p);
|
|
|
|
|
2012-10-29 23:45:23 +01:00
|
|
|
typedef struct AioHandler AioHandler;
|
|
|
|
typedef void QEMUBHFunc(void *opaque);
|
|
|
|
typedef void IOHandler(void *opaque);
|
|
|
|
|
|
|
|
typedef struct AioContext {
|
2012-09-13 12:28:51 +02:00
|
|
|
/* The list of registered AIO handlers */
|
|
|
|
QLIST_HEAD(, AioHandler) aio_handlers;
|
|
|
|
|
|
|
|
/* This is a simple lock used to protect the aio_handlers list.
|
|
|
|
* Specifically, it's used to ensure that no callbacks are removed while
|
|
|
|
* we're walking and dispatching callbacks.
|
|
|
|
*/
|
|
|
|
int walking_handlers;
|
|
|
|
|
2012-10-29 23:45:23 +01:00
|
|
|
/* Anchor of the list of Bottom Halves belonging to the context */
|
|
|
|
struct QEMUBH *first_bh;
|
|
|
|
|
|
|
|
/* A simple lock used to protect the first_bh list, and ensure that
|
|
|
|
* no callbacks are removed while we're walking and dispatching callbacks.
|
|
|
|
*/
|
|
|
|
int walking_bh;
|
|
|
|
} AioContext;
|
|
|
|
|
2008-09-22 21:17:18 +02:00
|
|
|
/* Returns 1 if there are still outstanding AIO requests; 0 otherwise */
|
2012-06-09 03:44:00 +02:00
|
|
|
typedef int (AioFlushEventNotifierHandler)(EventNotifier *e);
|
2008-09-22 21:17:18 +02:00
|
|
|
|
2012-10-29 23:45:23 +01:00
|
|
|
/**
|
|
|
|
* aio_context_new: Allocate a new AioContext.
|
|
|
|
*
|
|
|
|
* AioContext provide a mini event-loop that can be waited on synchronously.
|
|
|
|
* They also provide bottom halves, a service to execute a piece of code
|
|
|
|
* as soon as possible.
|
|
|
|
*/
|
|
|
|
AioContext *aio_context_new(void);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* aio_bh_new: Allocate a new bottom half structure.
|
|
|
|
*
|
|
|
|
* Bottom halves are lightweight callbacks whose invocation is guaranteed
|
|
|
|
* to be wait-free, thread-safe and signal-safe. The #QEMUBH structure
|
|
|
|
* is opaque and must be allocated prior to its use.
|
|
|
|
*/
|
|
|
|
QEMUBH *aio_bh_new(AioContext *ctx, QEMUBHFunc *cb, void *opaque);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* aio_bh_poll: Poll bottom halves for an AioContext.
|
|
|
|
*
|
|
|
|
* These are internal functions used by the QEMU main loop.
|
|
|
|
*/
|
|
|
|
int aio_bh_poll(AioContext *ctx);
|
|
|
|
void aio_bh_update_timeout(AioContext *ctx, uint32_t *timeout);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* qemu_bh_schedule: Schedule a bottom half.
|
|
|
|
*
|
|
|
|
* Scheduling a bottom half interrupts the main loop and causes the
|
|
|
|
* execution of the callback that was passed to qemu_bh_new.
|
|
|
|
*
|
|
|
|
* Bottom halves that are scheduled from a bottom half handler are instantly
|
|
|
|
* invoked. This can create an infinite loop if a bottom half handler
|
|
|
|
* schedules itself.
|
|
|
|
*
|
|
|
|
* @bh: The bottom half to be scheduled.
|
|
|
|
*/
|
|
|
|
void qemu_bh_schedule(QEMUBH *bh);
|
|
|
|
|
|
|
|
/**
|
|
|
|
* qemu_bh_cancel: Cancel execution of a bottom half.
|
|
|
|
*
|
|
|
|
* Canceling execution of a bottom half undoes the effect of calls to
|
|
|
|
* qemu_bh_schedule without freeing its resources yet. While cancellation
|
|
|
|
* itself is also wait-free and thread-safe, it can of course race with the
|
|
|
|
* loop that executes bottom halves unless you are holding the iothread
|
|
|
|
* mutex. This makes it mostly useless if you are not holding the mutex.
|
|
|
|
*
|
|
|
|
* @bh: The bottom half to be canceled.
|
|
|
|
*/
|
|
|
|
void qemu_bh_cancel(QEMUBH *bh);
|
|
|
|
|
|
|
|
/**
|
|
|
|
*qemu_bh_delete: Cancel execution of a bottom half and free its resources.
|
|
|
|
*
|
|
|
|
* Deleting a bottom half frees the memory that was allocated for it by
|
|
|
|
* qemu_bh_new. It also implies canceling the bottom half if it was
|
|
|
|
* scheduled.
|
|
|
|
*
|
|
|
|
* @bh: The bottom half to be deleted.
|
|
|
|
*/
|
|
|
|
void qemu_bh_delete(QEMUBH *bh);
|
|
|
|
|
2008-09-22 21:17:18 +02:00
|
|
|
/* Flush any pending AIO operation. This function will block until all
|
|
|
|
* outstanding AIO operations have been completed or cancelled. */
|
2012-09-13 12:28:51 +02:00
|
|
|
void aio_flush(AioContext *ctx);
|
2008-09-22 21:17:18 +02:00
|
|
|
|
2012-09-24 14:37:53 +02:00
|
|
|
/* Progress in completing AIO work to occur. This can issue new pending
|
|
|
|
* aio as a result of executing I/O completion or bh callbacks.
|
2012-04-12 14:00:55 +02:00
|
|
|
*
|
2012-09-24 14:37:53 +02:00
|
|
|
* If there is no pending AIO operation or completion (bottom half),
|
|
|
|
* return false. If there are pending bottom halves, return true.
|
|
|
|
*
|
|
|
|
* If there are no pending bottom halves, but there are pending AIO
|
|
|
|
* operations, it may not be possible to make any progress without
|
|
|
|
* blocking. If @blocking is true, this function will wait until one
|
|
|
|
* or more AIO events have completed, to ensure something has moved
|
|
|
|
* before returning.
|
|
|
|
*
|
|
|
|
* If @blocking is false, this function will also return false if the
|
|
|
|
* function cannot make any progress without blocking.
|
|
|
|
*/
|
|
|
|
bool aio_poll(AioContext *ctx, bool blocking);
|
2008-09-22 21:17:18 +02:00
|
|
|
|
2012-06-09 03:44:00 +02:00
|
|
|
#ifdef CONFIG_POSIX
|
|
|
|
/* Returns 1 if there are still outstanding AIO requests; 0 otherwise */
|
|
|
|
typedef int (AioFlushHandler)(void *opaque);
|
|
|
|
|
2008-09-22 21:17:18 +02:00
|
|
|
/* Register a file descriptor and associated callbacks. Behaves very similarly
|
|
|
|
* to qemu_set_fd_handler2. Unlike qemu_set_fd_handler2, these callbacks will
|
|
|
|
* be invoked when using either qemu_aio_wait() or qemu_aio_flush().
|
|
|
|
*
|
|
|
|
* Code that invokes AIO completion functions should rely on this function
|
|
|
|
* instead of qemu_set_fd_handler[2].
|
|
|
|
*/
|
2012-09-13 12:28:51 +02:00
|
|
|
void aio_set_fd_handler(AioContext *ctx,
|
|
|
|
int fd,
|
|
|
|
IOHandler *io_read,
|
|
|
|
IOHandler *io_write,
|
|
|
|
AioFlushHandler *io_flush,
|
|
|
|
void *opaque);
|
2012-06-09 03:44:00 +02:00
|
|
|
#endif
|
|
|
|
|
|
|
|
/* Register an event notifier and associated callbacks. Behaves very similarly
|
|
|
|
* to event_notifier_set_handler. Unlike event_notifier_set_handler, these callbacks
|
|
|
|
* will be invoked when using either qemu_aio_wait() or qemu_aio_flush().
|
|
|
|
*
|
|
|
|
* Code that invokes AIO completion functions should rely on this function
|
|
|
|
* instead of event_notifier_set_handler.
|
|
|
|
*/
|
2012-09-13 12:28:51 +02:00
|
|
|
void aio_set_event_notifier(AioContext *ctx,
|
|
|
|
EventNotifier *notifier,
|
|
|
|
EventNotifierHandler *io_read,
|
|
|
|
AioFlushEventNotifierHandler *io_flush);
|
|
|
|
|
|
|
|
/* Functions to operate on the main QEMU AioContext. */
|
|
|
|
|
|
|
|
void qemu_aio_flush(void);
|
|
|
|
bool qemu_aio_wait(void);
|
2012-06-09 03:44:00 +02:00
|
|
|
void qemu_aio_set_event_notifier(EventNotifier *notifier,
|
|
|
|
EventNotifierHandler *io_read,
|
|
|
|
AioFlushEventNotifierHandler *io_flush);
|
2008-09-22 21:17:18 +02:00
|
|
|
|
2012-09-13 12:28:51 +02:00
|
|
|
#ifdef CONFIG_POSIX
|
|
|
|
void qemu_aio_set_fd_handler(int fd,
|
|
|
|
IOHandler *io_read,
|
|
|
|
IOHandler *io_write,
|
|
|
|
AioFlushHandler *io_flush,
|
|
|
|
void *opaque);
|
|
|
|
#endif
|
|
|
|
|
2008-09-22 21:17:18 +02:00
|
|
|
#endif
|