850 lines · c
1/* SPDX-License-Identifier: (GPL-2.0 WITH Linux-syscall-note) OR MIT */2/*3 * Header file for the io_uring interface.4 *5 * Copyright (C) 2019 Jens Axboe6 * Copyright (C) 2019 Christoph Hellwig7 */8#ifndef LINUX_IO_URING_H9#define LINUX_IO_URING_H10 11#include <linux/fs.h>12#include <linux/types.h>13/*14 * this file is shared with liburing and that has to autodetect15 * if linux/time_types.h is available or not, it can16 * define UAPI_LINUX_IO_URING_H_SKIP_LINUX_TIME_TYPES_H17 * if linux/time_types.h is not available18 */19#ifndef UAPI_LINUX_IO_URING_H_SKIP_LINUX_TIME_TYPES_H20#include <linux/time_types.h>21#endif22 23#ifdef __cplusplus24extern "C" {25#endif26 27/*28 * IO submission data structure (Submission Queue Entry)29 */30struct io_uring_sqe {31 __u8 opcode; /* type of operation for this sqe */32 __u8 flags; /* IOSQE_ flags */33 __u16 ioprio; /* ioprio for the request */34 __s32 fd; /* file descriptor to do IO on */35 union {36 __u64 off; /* offset into file */37 __u64 addr2;38 struct {39 __u32 cmd_op;40 __u32 __pad1;41 };42 };43 union {44 __u64 addr; /* pointer to buffer or iovecs */45 __u64 splice_off_in;46 struct {47 __u32 level;48 __u32 optname;49 };50 };51 __u32 len; /* buffer size or number of iovecs */52 union {53 __kernel_rwf_t rw_flags;54 __u32 fsync_flags;55 __u16 poll_events; /* compatibility */56 __u32 poll32_events; /* word-reversed for BE */57 __u32 sync_range_flags;58 __u32 msg_flags;59 __u32 timeout_flags;60 __u32 accept_flags;61 __u32 cancel_flags;62 __u32 open_flags;63 __u32 statx_flags;64 __u32 fadvise_advice;65 __u32 splice_flags;66 __u32 rename_flags;67 __u32 unlink_flags;68 __u32 hardlink_flags;69 __u32 xattr_flags;70 __u32 msg_ring_flags;71 __u32 uring_cmd_flags;72 __u32 waitid_flags;73 __u32 futex_flags;74 __u32 install_fd_flags;75 __u32 nop_flags;76 };77 __u64 user_data; /* data to be passed back at completion time */78 /* pack this to avoid bogus arm OABI complaints */79 union {80 /* index into fixed buffers, if used */81 __u16 buf_index;82 /* for grouped buffer selection */83 __u16 buf_group;84 } __attribute__((packed));85 /* personality to use, if used */86 __u16 personality;87 union {88 __s32 splice_fd_in;89 __u32 file_index;90 __u32 optlen;91 struct {92 __u16 addr_len;93 __u16 __pad3[1];94 };95 };96 union {97 struct {98 __u64 addr3;99 __u64 __pad2[1];100 };101 __u64 optval;102 /*103 * If the ring is initialized with IORING_SETUP_SQE128, then104 * this field is used for 80 bytes of arbitrary command data105 */106 __u8 cmd[0];107 };108};109 110/*111 * If sqe->file_index is set to this for opcodes that instantiate a new112 * direct descriptor (like openat/openat2/accept), then io_uring will allocate113 * an available direct descriptor instead of having the application pass one114 * in. The picked direct descriptor will be returned in cqe->res, or -ENFILE115 * if the space is full.116 */117#define IORING_FILE_INDEX_ALLOC (~0U)118 119enum io_uring_sqe_flags_bit {120 IOSQE_FIXED_FILE_BIT,121 IOSQE_IO_DRAIN_BIT,122 IOSQE_IO_LINK_BIT,123 IOSQE_IO_HARDLINK_BIT,124 IOSQE_ASYNC_BIT,125 IOSQE_BUFFER_SELECT_BIT,126 IOSQE_CQE_SKIP_SUCCESS_BIT,127};128 129/*130 * sqe->flags131 */132/* use fixed fileset */133#define IOSQE_FIXED_FILE (1U << IOSQE_FIXED_FILE_BIT)134/* issue after inflight IO */135#define IOSQE_IO_DRAIN (1U << IOSQE_IO_DRAIN_BIT)136/* links next sqe */137#define IOSQE_IO_LINK (1U << IOSQE_IO_LINK_BIT)138/* like LINK, but stronger */139#define IOSQE_IO_HARDLINK (1U << IOSQE_IO_HARDLINK_BIT)140/* always go async */141#define IOSQE_ASYNC (1U << IOSQE_ASYNC_BIT)142/* select buffer from sqe->buf_group */143#define IOSQE_BUFFER_SELECT (1U << IOSQE_BUFFER_SELECT_BIT)144/* don't post CQE if request succeeded */145#define IOSQE_CQE_SKIP_SUCCESS (1U << IOSQE_CQE_SKIP_SUCCESS_BIT)146 147/*148 * io_uring_setup() flags149 */150#define IORING_SETUP_IOPOLL (1U << 0) /* io_context is polled */151#define IORING_SETUP_SQPOLL (1U << 1) /* SQ poll thread */152#define IORING_SETUP_SQ_AFF (1U << 2) /* sq_thread_cpu is valid */153#define IORING_SETUP_CQSIZE (1U << 3) /* app defines CQ size */154#define IORING_SETUP_CLAMP (1U << 4) /* clamp SQ/CQ ring sizes */155#define IORING_SETUP_ATTACH_WQ (1U << 5) /* attach to existing wq */156#define IORING_SETUP_R_DISABLED (1U << 6) /* start with ring disabled */157#define IORING_SETUP_SUBMIT_ALL (1U << 7) /* continue submit on error */158/*159 * Cooperative task running. When requests complete, they often require160 * forcing the submitter to transition to the kernel to complete. If this161 * flag is set, work will be done when the task transitions anyway, rather162 * than force an inter-processor interrupt reschedule. This avoids interrupting163 * a task running in userspace, and saves an IPI.164 */165#define IORING_SETUP_COOP_TASKRUN (1U << 8)166/*167 * If COOP_TASKRUN is set, get notified if task work is available for168 * running and a kernel transition would be needed to run it. This sets169 * IORING_SQ_TASKRUN in the sq ring flags. Not valid with COOP_TASKRUN.170 */171#define IORING_SETUP_TASKRUN_FLAG (1U << 9)172#define IORING_SETUP_SQE128 (1U << 10) /* SQEs are 128 byte */173#define IORING_SETUP_CQE32 (1U << 11) /* CQEs are 32 byte */174/*175 * Only one task is allowed to submit requests176 */177#define IORING_SETUP_SINGLE_ISSUER (1U << 12)178 179/*180 * Defer running task work to get events.181 * Rather than running bits of task work whenever the task transitions182 * try to do it just before it is needed.183 */184#define IORING_SETUP_DEFER_TASKRUN (1U << 13)185 186/*187 * Application provides the memory for the rings188 */189#define IORING_SETUP_NO_MMAP (1U << 14)190 191/*192 * Register the ring fd in itself for use with193 * IORING_REGISTER_USE_REGISTERED_RING; return a registered fd index rather194 * than an fd.195 */196#define IORING_SETUP_REGISTERED_FD_ONLY (1U << 15)197 198/*199 * Removes indirection through the SQ index array.200 */201#define IORING_SETUP_NO_SQARRAY (1U << 16)202 203enum io_uring_op {204 IORING_OP_NOP,205 IORING_OP_READV,206 IORING_OP_WRITEV,207 IORING_OP_FSYNC,208 IORING_OP_READ_FIXED,209 IORING_OP_WRITE_FIXED,210 IORING_OP_POLL_ADD,211 IORING_OP_POLL_REMOVE,212 IORING_OP_SYNC_FILE_RANGE,213 IORING_OP_SENDMSG,214 IORING_OP_RECVMSG,215 IORING_OP_TIMEOUT,216 IORING_OP_TIMEOUT_REMOVE,217 IORING_OP_ACCEPT,218 IORING_OP_ASYNC_CANCEL,219 IORING_OP_LINK_TIMEOUT,220 IORING_OP_CONNECT,221 IORING_OP_FALLOCATE,222 IORING_OP_OPENAT,223 IORING_OP_CLOSE,224 IORING_OP_FILES_UPDATE,225 IORING_OP_STATX,226 IORING_OP_READ,227 IORING_OP_WRITE,228 IORING_OP_FADVISE,229 IORING_OP_MADVISE,230 IORING_OP_SEND,231 IORING_OP_RECV,232 IORING_OP_OPENAT2,233 IORING_OP_EPOLL_CTL,234 IORING_OP_SPLICE,235 IORING_OP_PROVIDE_BUFFERS,236 IORING_OP_REMOVE_BUFFERS,237 IORING_OP_TEE,238 IORING_OP_SHUTDOWN,239 IORING_OP_RENAMEAT,240 IORING_OP_UNLINKAT,241 IORING_OP_MKDIRAT,242 IORING_OP_SYMLINKAT,243 IORING_OP_LINKAT,244 IORING_OP_MSG_RING,245 IORING_OP_FSETXATTR,246 IORING_OP_SETXATTR,247 IORING_OP_FGETXATTR,248 IORING_OP_GETXATTR,249 IORING_OP_SOCKET,250 IORING_OP_URING_CMD,251 IORING_OP_SEND_ZC,252 IORING_OP_SENDMSG_ZC,253 IORING_OP_READ_MULTISHOT,254 IORING_OP_WAITID,255 IORING_OP_FUTEX_WAIT,256 IORING_OP_FUTEX_WAKE,257 IORING_OP_FUTEX_WAITV,258 IORING_OP_FIXED_FD_INSTALL,259 IORING_OP_FTRUNCATE,260 IORING_OP_BIND,261 IORING_OP_LISTEN,262 263 /* this goes last, obviously */264 IORING_OP_LAST,265};266 267/*268 * sqe->uring_cmd_flags top 8bits aren't available for userspace269 * IORING_URING_CMD_FIXED use registered buffer; pass this flag270 * along with setting sqe->buf_index.271 */272#define IORING_URING_CMD_FIXED (1U << 0)273#define IORING_URING_CMD_MASK IORING_URING_CMD_FIXED274 275 276/*277 * sqe->fsync_flags278 */279#define IORING_FSYNC_DATASYNC (1U << 0)280 281/*282 * sqe->timeout_flags283 */284#define IORING_TIMEOUT_ABS (1U << 0)285#define IORING_TIMEOUT_UPDATE (1U << 1)286#define IORING_TIMEOUT_BOOTTIME (1U << 2)287#define IORING_TIMEOUT_REALTIME (1U << 3)288#define IORING_LINK_TIMEOUT_UPDATE (1U << 4)289#define IORING_TIMEOUT_ETIME_SUCCESS (1U << 5)290#define IORING_TIMEOUT_MULTISHOT (1U << 6)291#define IORING_TIMEOUT_CLOCK_MASK (IORING_TIMEOUT_BOOTTIME | IORING_TIMEOUT_REALTIME)292#define IORING_TIMEOUT_UPDATE_MASK (IORING_TIMEOUT_UPDATE | IORING_LINK_TIMEOUT_UPDATE)293/*294 * sqe->splice_flags295 * extends splice(2) flags296 */297#define SPLICE_F_FD_IN_FIXED (1U << 31) /* the last bit of __u32 */298 299/*300 * POLL_ADD flags. Note that since sqe->poll_events is the flag space, the301 * command flags for POLL_ADD are stored in sqe->len.302 *303 * IORING_POLL_ADD_MULTI Multishot poll. Sets IORING_CQE_F_MORE if304 * the poll handler will continue to report305 * CQEs on behalf of the same SQE.306 *307 * IORING_POLL_UPDATE Update existing poll request, matching308 * sqe->addr as the old user_data field.309 *310 * IORING_POLL_LEVEL Level triggered poll.311 */312#define IORING_POLL_ADD_MULTI (1U << 0)313#define IORING_POLL_UPDATE_EVENTS (1U << 1)314#define IORING_POLL_UPDATE_USER_DATA (1U << 2)315#define IORING_POLL_ADD_LEVEL (1U << 3)316 317/*318 * ASYNC_CANCEL flags.319 *320 * IORING_ASYNC_CANCEL_ALL Cancel all requests that match the given key321 * IORING_ASYNC_CANCEL_FD Key off 'fd' for cancelation rather than the322 * request 'user_data'323 * IORING_ASYNC_CANCEL_ANY Match any request324 * IORING_ASYNC_CANCEL_FD_FIXED 'fd' passed in is a fixed descriptor325 * IORING_ASYNC_CANCEL_USERDATA Match on user_data, default for no other key326 * IORING_ASYNC_CANCEL_OP Match request based on opcode327 */328#define IORING_ASYNC_CANCEL_ALL (1U << 0)329#define IORING_ASYNC_CANCEL_FD (1U << 1)330#define IORING_ASYNC_CANCEL_ANY (1U << 2)331#define IORING_ASYNC_CANCEL_FD_FIXED (1U << 3)332#define IORING_ASYNC_CANCEL_USERDATA (1U << 4)333#define IORING_ASYNC_CANCEL_OP (1U << 5)334 335/*336 * send/sendmsg and recv/recvmsg flags (sqe->ioprio)337 *338 * IORING_RECVSEND_POLL_FIRST If set, instead of first attempting to send339 * or receive and arm poll if that yields an340 * -EAGAIN result, arm poll upfront and skip341 * the initial transfer attempt.342 *343 * IORING_RECV_MULTISHOT Multishot recv. Sets IORING_CQE_F_MORE if344 * the handler will continue to report345 * CQEs on behalf of the same SQE.346 *347 * IORING_RECVSEND_FIXED_BUF Use registered buffers, the index is stored in348 * the buf_index field.349 *350 * IORING_SEND_ZC_REPORT_USAGE351 * If set, SEND[MSG]_ZC should report352 * the zerocopy usage in cqe.res353 * for the IORING_CQE_F_NOTIF cqe.354 * 0 is reported if zerocopy was actually possible.355 * IORING_NOTIF_USAGE_ZC_COPIED if data was copied356 * (at least partially).357 *358 * IORING_RECVSEND_BUNDLE Used with IOSQE_BUFFER_SELECT. If set, send or359 * recv will grab as many buffers from the buffer360 * group ID given and send them all. The completion361 * result will be the number of buffers send, with362 * the starting buffer ID in cqe->flags as per363 * usual for provided buffer usage. The buffers364 * will be contigious from the starting buffer ID.365 */366#define IORING_RECVSEND_POLL_FIRST (1U << 0)367#define IORING_RECV_MULTISHOT (1U << 1)368#define IORING_RECVSEND_FIXED_BUF (1U << 2)369#define IORING_SEND_ZC_REPORT_USAGE (1U << 3)370#define IORING_RECVSEND_BUNDLE (1U << 4)371 372/*373 * cqe.res for IORING_CQE_F_NOTIF if374 * IORING_SEND_ZC_REPORT_USAGE was requested375 *376 * It should be treated as a flag, all other377 * bits of cqe.res should be treated as reserved!378 */379#define IORING_NOTIF_USAGE_ZC_COPIED (1U << 31)380 381/*382 * accept flags stored in sqe->ioprio383 */384#define IORING_ACCEPT_MULTISHOT (1U << 0)385#define IORING_ACCEPT_DONTWAIT (1U << 1)386#define IORING_ACCEPT_POLL_FIRST (1U << 2)387 388/*389 * IORING_OP_MSG_RING command types, stored in sqe->addr390 */391enum io_uring_msg_ring_flags {392 IORING_MSG_DATA, /* pass sqe->len as 'res' and off as user_data */393 IORING_MSG_SEND_FD, /* send a registered fd to another ring */394};395 396/*397 * IORING_OP_MSG_RING flags (sqe->msg_ring_flags)398 *399 * IORING_MSG_RING_CQE_SKIP Don't post a CQE to the target ring. Not400 * applicable for IORING_MSG_DATA, obviously.401 */402#define IORING_MSG_RING_CQE_SKIP (1U << 0)403/* Pass through the flags from sqe->file_index to cqe->flags */404#define IORING_MSG_RING_FLAGS_PASS (1U << 1)405 406/*407 * IORING_OP_FIXED_FD_INSTALL flags (sqe->install_fd_flags)408 *409 * IORING_FIXED_FD_NO_CLOEXEC Don't mark the fd as O_CLOEXEC410 */411#define IORING_FIXED_FD_NO_CLOEXEC (1U << 0)412 413/*414 * IORING_OP_NOP flags (sqe->nop_flags)415 *416 * IORING_NOP_INJECT_RESULT Inject result from sqe->result417 */418#define IORING_NOP_INJECT_RESULT (1U << 0)419 420/*421 * IO completion data structure (Completion Queue Entry)422 */423struct io_uring_cqe {424 __u64 user_data; /* sqe->user_data value passed back */425 __s32 res; /* result code for this event */426 __u32 flags;427 428 /*429 * If the ring is initialized with IORING_SETUP_CQE32, then this field430 * contains 16-bytes of padding, doubling the size of the CQE.431 */432 __u64 big_cqe[];433};434 435/*436 * cqe->flags437 *438 * IORING_CQE_F_BUFFER If set, the upper 16 bits are the buffer ID439 * IORING_CQE_F_MORE If set, parent SQE will generate more CQE entries440 * IORING_CQE_F_SOCK_NONEMPTY If set, more data to read after socket recv441 * IORING_CQE_F_NOTIF Set for notification CQEs. Can be used to distinct442 * them from sends.443 * IORING_CQE_F_BUF_MORE If set, the buffer ID set in the completion will get444 * more completions. In other words, the buffer is being445 * partially consumed, and will be used by the kernel for446 * more completions. This is only set for buffers used via447 * the incremental buffer consumption, as provided by448 * a ring buffer setup with IOU_PBUF_RING_INC. For any449 * other provided buffer type, all completions with a450 * buffer passed back is automatically returned to the451 * application.452 */453#define IORING_CQE_F_BUFFER (1U << 0)454#define IORING_CQE_F_MORE (1U << 1)455#define IORING_CQE_F_SOCK_NONEMPTY (1U << 2)456#define IORING_CQE_F_NOTIF (1U << 3)457#define IORING_CQE_F_BUF_MORE (1U << 4)458 459#define IORING_CQE_BUFFER_SHIFT 16460 461/*462 * Magic offsets for the application to mmap the data it needs463 */464#define IORING_OFF_SQ_RING 0ULL465#define IORING_OFF_CQ_RING 0x8000000ULL466#define IORING_OFF_SQES 0x10000000ULL467#define IORING_OFF_PBUF_RING 0x80000000ULL468#define IORING_OFF_PBUF_SHIFT 16469#define IORING_OFF_MMAP_MASK 0xf8000000ULL470 471/*472 * Filled with the offset for mmap(2)473 */474struct io_sqring_offsets {475 __u32 head;476 __u32 tail;477 __u32 ring_mask;478 __u32 ring_entries;479 __u32 flags;480 __u32 dropped;481 __u32 array;482 __u32 resv1;483 __u64 user_addr;484};485 486/*487 * sq_ring->flags488 */489#define IORING_SQ_NEED_WAKEUP (1U << 0) /* needs io_uring_enter wakeup */490#define IORING_SQ_CQ_OVERFLOW (1U << 1) /* CQ ring is overflown */491#define IORING_SQ_TASKRUN (1U << 2) /* task should enter the kernel */492 493struct io_cqring_offsets {494 __u32 head;495 __u32 tail;496 __u32 ring_mask;497 __u32 ring_entries;498 __u32 overflow;499 __u32 cqes;500 __u32 flags;501 __u32 resv1;502 __u64 user_addr;503};504 505/*506 * cq_ring->flags507 */508 509/* disable eventfd notifications */510#define IORING_CQ_EVENTFD_DISABLED (1U << 0)511 512/*513 * io_uring_enter(2) flags514 */515#define IORING_ENTER_GETEVENTS (1U << 0)516#define IORING_ENTER_SQ_WAKEUP (1U << 1)517#define IORING_ENTER_SQ_WAIT (1U << 2)518#define IORING_ENTER_EXT_ARG (1U << 3)519#define IORING_ENTER_REGISTERED_RING (1U << 4)520#define IORING_ENTER_ABS_TIMER (1U << 5)521 522/*523 * Passed in for io_uring_setup(2). Copied back with updated info on success524 */525struct io_uring_params {526 __u32 sq_entries;527 __u32 cq_entries;528 __u32 flags;529 __u32 sq_thread_cpu;530 __u32 sq_thread_idle;531 __u32 features;532 __u32 wq_fd;533 __u32 resv[3];534 struct io_sqring_offsets sq_off;535 struct io_cqring_offsets cq_off;536};537 538/*539 * io_uring_params->features flags540 */541#define IORING_FEAT_SINGLE_MMAP (1U << 0)542#define IORING_FEAT_NODROP (1U << 1)543#define IORING_FEAT_SUBMIT_STABLE (1U << 2)544#define IORING_FEAT_RW_CUR_POS (1U << 3)545#define IORING_FEAT_CUR_PERSONALITY (1U << 4)546#define IORING_FEAT_FAST_POLL (1U << 5)547#define IORING_FEAT_POLL_32BITS (1U << 6)548#define IORING_FEAT_SQPOLL_NONFIXED (1U << 7)549#define IORING_FEAT_EXT_ARG (1U << 8)550#define IORING_FEAT_NATIVE_WORKERS (1U << 9)551#define IORING_FEAT_RSRC_TAGS (1U << 10)552#define IORING_FEAT_CQE_SKIP (1U << 11)553#define IORING_FEAT_LINKED_FILE (1U << 12)554#define IORING_FEAT_REG_REG_RING (1U << 13)555#define IORING_FEAT_RECVSEND_BUNDLE (1U << 14)556#define IORING_FEAT_MIN_TIMEOUT (1U << 15)557 558/*559 * io_uring_register(2) opcodes and arguments560 */561enum io_uring_register_op {562 IORING_REGISTER_BUFFERS = 0,563 IORING_UNREGISTER_BUFFERS = 1,564 IORING_REGISTER_FILES = 2,565 IORING_UNREGISTER_FILES = 3,566 IORING_REGISTER_EVENTFD = 4,567 IORING_UNREGISTER_EVENTFD = 5,568 IORING_REGISTER_FILES_UPDATE = 6,569 IORING_REGISTER_EVENTFD_ASYNC = 7,570 IORING_REGISTER_PROBE = 8,571 IORING_REGISTER_PERSONALITY = 9,572 IORING_UNREGISTER_PERSONALITY = 10,573 IORING_REGISTER_RESTRICTIONS = 11,574 IORING_REGISTER_ENABLE_RINGS = 12,575 576 /* extended with tagging */577 IORING_REGISTER_FILES2 = 13,578 IORING_REGISTER_FILES_UPDATE2 = 14,579 IORING_REGISTER_BUFFERS2 = 15,580 IORING_REGISTER_BUFFERS_UPDATE = 16,581 582 /* set/clear io-wq thread affinities */583 IORING_REGISTER_IOWQ_AFF = 17,584 IORING_UNREGISTER_IOWQ_AFF = 18,585 586 /* set/get max number of io-wq workers */587 IORING_REGISTER_IOWQ_MAX_WORKERS = 19,588 589 /* register/unregister io_uring fd with the ring */590 IORING_REGISTER_RING_FDS = 20,591 IORING_UNREGISTER_RING_FDS = 21,592 593 /* register ring based provide buffer group */594 IORING_REGISTER_PBUF_RING = 22,595 IORING_UNREGISTER_PBUF_RING = 23,596 597 /* sync cancelation API */598 IORING_REGISTER_SYNC_CANCEL = 24,599 600 /* register a range of fixed file slots for automatic slot allocation */601 IORING_REGISTER_FILE_ALLOC_RANGE = 25,602 603 /* return status information for a buffer group */604 IORING_REGISTER_PBUF_STATUS = 26,605 606 /* set/clear busy poll settings */607 IORING_REGISTER_NAPI = 27,608 IORING_UNREGISTER_NAPI = 28,609 610 IORING_REGISTER_CLOCK = 29,611 612 /* clone registered buffers from source ring to current ring */613 IORING_REGISTER_CLONE_BUFFERS = 30,614 615 /* this goes last */616 IORING_REGISTER_LAST,617 618 /* flag added to the opcode to use a registered ring fd */619 IORING_REGISTER_USE_REGISTERED_RING = 1U << 31620};621 622/* io-wq worker categories */623enum io_wq_type {624 IO_WQ_BOUND,625 IO_WQ_UNBOUND,626};627 628/* deprecated, see struct io_uring_rsrc_update */629struct io_uring_files_update {630 __u32 offset;631 __u32 resv;632 __aligned_u64 /* __s32 * */ fds;633};634 635/*636 * Register a fully sparse file space, rather than pass in an array of all637 * -1 file descriptors.638 */639#define IORING_RSRC_REGISTER_SPARSE (1U << 0)640 641struct io_uring_rsrc_register {642 __u32 nr;643 __u32 flags;644 __u64 resv2;645 __aligned_u64 data;646 __aligned_u64 tags;647};648 649struct io_uring_rsrc_update {650 __u32 offset;651 __u32 resv;652 __aligned_u64 data;653};654 655struct io_uring_rsrc_update2 {656 __u32 offset;657 __u32 resv;658 __aligned_u64 data;659 __aligned_u64 tags;660 __u32 nr;661 __u32 resv2;662};663 664/* Skip updating fd indexes set to this value in the fd table */665#define IORING_REGISTER_FILES_SKIP (-2)666 667#define IO_URING_OP_SUPPORTED (1U << 0)668 669struct io_uring_probe_op {670 __u8 op;671 __u8 resv;672 __u16 flags; /* IO_URING_OP_* flags */673 __u32 resv2;674};675 676struct io_uring_probe {677 __u8 last_op; /* last opcode supported */678 __u8 ops_len; /* length of ops[] array below */679 __u16 resv;680 __u32 resv2[3];681 struct io_uring_probe_op ops[];682};683 684struct io_uring_restriction {685 __u16 opcode;686 union {687 __u8 register_op; /* IORING_RESTRICTION_REGISTER_OP */688 __u8 sqe_op; /* IORING_RESTRICTION_SQE_OP */689 __u8 sqe_flags; /* IORING_RESTRICTION_SQE_FLAGS_* */690 };691 __u8 resv;692 __u32 resv2[3];693};694 695struct io_uring_clock_register {696 __u32 clockid;697 __u32 __resv[3];698};699 700enum {701 IORING_REGISTER_SRC_REGISTERED = 1,702};703 704struct io_uring_clone_buffers {705 __u32 src_fd;706 __u32 flags;707 __u32 pad[6];708};709 710struct io_uring_buf {711 __u64 addr;712 __u32 len;713 __u16 bid;714 __u16 resv;715};716 717struct io_uring_buf_ring {718 union {719 /*720 * To avoid spilling into more pages than we need to, the721 * ring tail is overlaid with the io_uring_buf->resv field.722 */723 struct {724 __u64 resv1;725 __u32 resv2;726 __u16 resv3;727 __u16 tail;728 };729 __DECLARE_FLEX_ARRAY(struct io_uring_buf, bufs);730 };731};732 733/*734 * Flags for IORING_REGISTER_PBUF_RING.735 *736 * IOU_PBUF_RING_MMAP: If set, kernel will allocate the memory for the ring.737 * The application must not set a ring_addr in struct738 * io_uring_buf_reg, instead it must subsequently call739 * mmap(2) with the offset set as:740 * IORING_OFF_PBUF_RING | (bgid << IORING_OFF_PBUF_SHIFT)741 * to get a virtual mapping for the ring.742 * IOU_PBUF_RING_INC: If set, buffers consumed from this buffer ring can be743 * consumed incrementally. Normally one (or more) buffers744 * are fully consumed. With incremental consumptions, it's745 * feasible to register big ranges of buffers, and each746 * use of it will consume only as much as it needs. This747 * requires that both the kernel and application keep748 * track of where the current read/recv index is at.749 */750enum io_uring_register_pbuf_ring_flags {751 IOU_PBUF_RING_MMAP = 1,752 IOU_PBUF_RING_INC = 2,753};754 755/* argument for IORING_(UN)REGISTER_PBUF_RING */756struct io_uring_buf_reg {757 __u64 ring_addr;758 __u32 ring_entries;759 __u16 bgid;760 __u16 flags;761 __u64 resv[3];762};763 764/* argument for IORING_REGISTER_PBUF_STATUS */765struct io_uring_buf_status {766 __u32 buf_group; /* input */767 __u32 head; /* output */768 __u32 resv[8];769};770 771/* argument for IORING_(UN)REGISTER_NAPI */772struct io_uring_napi {773 __u32 busy_poll_to;774 __u8 prefer_busy_poll;775 __u8 pad[3];776 __u64 resv;777};778 779/*780 * io_uring_restriction->opcode values781 */782enum io_uring_register_restriction_op {783 /* Allow an io_uring_register(2) opcode */784 IORING_RESTRICTION_REGISTER_OP = 0,785 786 /* Allow an sqe opcode */787 IORING_RESTRICTION_SQE_OP = 1,788 789 /* Allow sqe flags */790 IORING_RESTRICTION_SQE_FLAGS_ALLOWED = 2,791 792 /* Require sqe flags (these flags must be set on each submission) */793 IORING_RESTRICTION_SQE_FLAGS_REQUIRED = 3,794 795 IORING_RESTRICTION_LAST796};797 798struct io_uring_getevents_arg {799 __u64 sigmask;800 __u32 sigmask_sz;801 __u32 min_wait_usec;802 __u64 ts;803};804 805/*806 * Argument for IORING_REGISTER_SYNC_CANCEL807 */808struct io_uring_sync_cancel_reg {809 __u64 addr;810 __s32 fd;811 __u32 flags;812 struct __kernel_timespec timeout;813 __u8 opcode;814 __u8 pad[7];815 __u64 pad2[3];816};817 818/*819 * Argument for IORING_REGISTER_FILE_ALLOC_RANGE820 * The range is specified as [off, off + len)821 */822struct io_uring_file_index_range {823 __u32 off;824 __u32 len;825 __u64 resv;826};827 828struct io_uring_recvmsg_out {829 __u32 namelen;830 __u32 controllen;831 __u32 payloadlen;832 __u32 flags;833};834 835/*836 * Argument for IORING_OP_URING_CMD when file is a socket837 */838enum io_uring_socket_op {839 SOCKET_URING_OP_SIOCINQ = 0,840 SOCKET_URING_OP_SIOCOUTQ,841 SOCKET_URING_OP_GETSOCKOPT,842 SOCKET_URING_OP_SETSOCKOPT,843};844 845#ifdef __cplusplus846}847#endif848 849#endif850