1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
3 * Header file for the io_uring interface.
5 * Copyright (C) 2019 Jens Axboe
6 * Copyright (C) 2019 Christoph Hellwig
8 #ifndef LINUX_IO_URING_H
9 #define LINUX_IO_URING_H
12 #include <linux/types.h>
15 * IO submission data structure (Submission Queue Entry)
29 __kernel_rwf_t rw_flags;
35 * io_uring_setup() flags
37 #define IORING_SETUP_IOPOLL (1 << 0) /* io_context is polled */
38 #define IORING_SETUP_SQTHREAD (1 << 1) /* Use SQ thread */
39 #define IORING_SETUP_SQWQ (1 << 2) /* Use SQ workqueue */
40 #define IORING_SETUP_SQPOLL (1 << 3) /* SQ thread polls */
42 #define IORING_OP_READV 1
43 #define IORING_OP_WRITEV 2
44 #define IORING_OP_FSYNC 3
45 #define IORING_OP_FDSYNC 4
46 #define IORING_OP_READ_FIXED 5
47 #define IORING_OP_WRITE_FIXED 6
50 * IO completion data structure (Completion Queue Entry)
53 __u64 index; /* what sqe this event came from */
54 __s32 res; /* result code for this event */
59 * io_uring_event->flags
61 #define IOCQE_FLAG_CACHEHIT (1 << 0) /* IO did not hit media */
64 * Magic offsets for the application to mmap the data it needs
66 #define IORING_OFF_SQ_RING 0ULL
67 #define IORING_OFF_CQ_RING 0x8000000ULL
68 #define IORING_OFF_SQES 0x10000000ULL
71 * Filled with the offset for mmap(2)
73 struct io_sqring_offsets {
84 #define IORING_SQ_NEED_WAKEUP (1 << 0) /* needs io_uring_enter wakeup */
86 struct io_cqring_offsets {
97 * io_uring_enter(2) flags
99 #define IORING_ENTER_GETEVENTS (1 << 0)
102 * Passed in for io_uring_setup(2). Copied back with updated info on success
104 struct io_uring_params {
110 struct io_sqring_offsets sq_off;
111 struct io_cqring_offsets cq_off;