xref: /openbmc/qemu/include/block/raw-aio.h (revision 39920a04)
1 /*
2  * Declarations for AIO in the raw protocol
3  *
4  * Copyright IBM, Corp. 2008
5  *
6  * Authors:
7  *  Anthony Liguori   <aliguori@us.ibm.com>
8  *
9  * This work is licensed under the terms of the GNU GPL, version 2.  See
10  * the COPYING file in the top-level directory.
11  *
12  * Contributions after 2012-01-13 are licensed under the terms of the
13  * GNU GPL, version 2 or (at your option) any later version.
14  */
15 
16 #ifndef QEMU_RAW_AIO_H
17 #define QEMU_RAW_AIO_H
18 
19 #include "block/aio.h"
20 #include "qemu/iov.h"
21 
22 /* AIO request types */
23 #define QEMU_AIO_READ         0x0001
24 #define QEMU_AIO_WRITE        0x0002
25 #define QEMU_AIO_IOCTL        0x0004
26 #define QEMU_AIO_FLUSH        0x0008
27 #define QEMU_AIO_DISCARD      0x0010
28 #define QEMU_AIO_WRITE_ZEROES 0x0020
29 #define QEMU_AIO_COPY_RANGE   0x0040
30 #define QEMU_AIO_TRUNCATE     0x0080
31 #define QEMU_AIO_TYPE_MASK \
32         (QEMU_AIO_READ | \
33          QEMU_AIO_WRITE | \
34          QEMU_AIO_IOCTL | \
35          QEMU_AIO_FLUSH | \
36          QEMU_AIO_DISCARD | \
37          QEMU_AIO_WRITE_ZEROES | \
38          QEMU_AIO_COPY_RANGE | \
39          QEMU_AIO_TRUNCATE)
40 
41 /* AIO flags */
42 #define QEMU_AIO_MISALIGNED   0x1000
43 #define QEMU_AIO_BLKDEV       0x2000
44 #define QEMU_AIO_NO_FALLBACK  0x4000
45 
46 
47 /* linux-aio.c - Linux native implementation */
48 #ifdef CONFIG_LINUX_AIO
49 typedef struct LinuxAioState LinuxAioState;
50 LinuxAioState *laio_init(Error **errp);
51 void laio_cleanup(LinuxAioState *s);
52 
53 /* laio_co_submit: submit I/O requests in the thread's current AioContext. */
54 int coroutine_fn laio_co_submit(int fd, uint64_t offset, QEMUIOVector *qiov,
55                                 int type, uint64_t dev_max_batch);
56 
57 void laio_detach_aio_context(LinuxAioState *s, AioContext *old_context);
58 void laio_attach_aio_context(LinuxAioState *s, AioContext *new_context);
59 
60 /*
61  * laio_io_plug/unplug work in the thread's current AioContext, therefore the
62  * caller must ensure that they are paired in the same IOThread.
63  */
64 void laio_io_plug(void);
65 void laio_io_unplug(uint64_t dev_max_batch);
66 #endif
67 /* io_uring.c - Linux io_uring implementation */
68 #ifdef CONFIG_LINUX_IO_URING
69 typedef struct LuringState LuringState;
70 LuringState *luring_init(Error **errp);
71 void luring_cleanup(LuringState *s);
72 
73 /* luring_co_submit: submit I/O requests in the thread's current AioContext. */
74 int coroutine_fn luring_co_submit(BlockDriverState *bs, int fd, uint64_t offset,
75                                   QEMUIOVector *qiov, int type);
76 void luring_detach_aio_context(LuringState *s, AioContext *old_context);
77 void luring_attach_aio_context(LuringState *s, AioContext *new_context);
78 
79 /*
80  * luring_io_plug/unplug work in the thread's current AioContext, therefore the
81  * caller must ensure that they are paired in the same IOThread.
82  */
83 void luring_io_plug(void);
84 void luring_io_unplug(void);
85 #endif
86 
87 #ifdef _WIN32
88 typedef struct QEMUWin32AIOState QEMUWin32AIOState;
89 QEMUWin32AIOState *win32_aio_init(void);
90 void win32_aio_cleanup(QEMUWin32AIOState *aio);
91 int win32_aio_attach(QEMUWin32AIOState *aio, HANDLE hfile);
92 BlockAIOCB *win32_aio_submit(BlockDriverState *bs,
93         QEMUWin32AIOState *aio, HANDLE hfile,
94         uint64_t offset, uint64_t bytes, QEMUIOVector *qiov,
95         BlockCompletionFunc *cb, void *opaque, int type);
96 void win32_aio_detach_aio_context(QEMUWin32AIOState *aio,
97                                   AioContext *old_context);
98 void win32_aio_attach_aio_context(QEMUWin32AIOState *aio,
99                                   AioContext *new_context);
100 #endif
101 
102 #endif /* QEMU_RAW_AIO_H */
103