include/uapi/linux/io_uring.h

   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 Axboe
   6  * Copyright (C) 2019 Christoph Hellwig
   7  */
   8 #ifndef LINUX_IO_URING_H
   9 #define LINUX_IO_URING_H
  10
  11 #include <linux/fs.h>
  12 #include <linux/types.h>
  13 #include <linux/time_types.h>
  14
  15 #ifdef __cplusplus
  16 extern "C" {
  17 #endif
  18
  19 /*
  20  * IO submission data structure (Submission Queue Entry)
  21  */
  22 struct io_uring_sqe {
  23         __u8    opcode;         /* type of operation for this sqe */
  24         __u8    flags;          /* IOSQE_ flags */
  25         __u16   ioprio;         /* ioprio for the request */
  26         __s32   fd;             /* file descriptor to do IO on */
  27         union {
  28                 __u64   off;    /* offset into file */
  29                 __u64   addr2;
  30                 struct {
  31                         __u32   cmd_op;
  32                         __u32   __pad1;
  33                 };
  34         };
  35         union {
  36                 __u64   addr;   /* pointer to buffer or iovecs */
  37                 __u64   splice_off_in;
  38         };
  39         __u32   len;            /* buffer size or number of iovecs */
  40         union {
  41                 __kernel_rwf_t  rw_flags;
  42                 __u32           fsync_flags;
  43                 __u16           poll_events;    /* compatibility */
  44                 __u32           poll32_events;  /* word-reversed for BE */
  45                 __u32           sync_range_flags;
  46                 __u32           msg_flags;
  47                 __u32           timeout_flags;
  48                 __u32           accept_flags;
  49                 __u32           cancel_flags;
  50                 __u32           open_flags;
  51                 __u32           statx_flags;
  52                 __u32           fadvise_advice;
  53                 __u32           splice_flags;
  54                 __u32           rename_flags;
  55                 __u32           unlink_flags;
  56                 __u32           hardlink_flags;
  57                 __u32           xattr_flags;
  58                 __u32           msg_ring_flags;
  59         };
  60         __u64   user_data;      /* data to be passed back at completion time */
  61         /* pack this to avoid bogus arm OABI complaints */
  62         union {
  63                 /* index into fixed buffers, if used */
  64                 __u16   buf_index;
  65                 /* for grouped buffer selection */
  66                 __u16   buf_group;
  67         } __attribute__((packed));
  68         /* personality to use, if used */
  69         __u16   personality;
  70         union {
  71                 __s32   splice_fd_in;
  72                 __u32   file_index;
  73                 struct {
  74                         __u16   notification_idx;
  75                         __u16   addr_len;
  76                 };
  77         };
  78         union {
  79                 struct {
  80                         __u64   addr3;
  81                         __u64   __pad2[1];
  82                 };
  83                 /*
  84                  * If the ring is initialized with IORING_SETUP_SQE128, then
  85                  * this field is used for 80 bytes of arbitrary command data
  86                  */
  87                 __u8    cmd[0];
  88         };
  89 };
  90
  91 /*
  92  * If sqe->file_index is set to this for opcodes that instantiate a new
  93  * direct descriptor (like openat/openat2/accept), then io_uring will allocate
  94  * an available direct descriptor instead of having the application pass one
  95  * in. The picked direct descriptor will be returned in cqe->res, or -ENFILE
  96  * if the space is full.
  97  */
  98 #define IORING_FILE_INDEX_ALLOC         (~0U)
  99
 100 enum {
 101         IOSQE_FIXED_FILE_BIT,
 102         IOSQE_IO_DRAIN_BIT,
 103         IOSQE_IO_LINK_BIT,
 104         IOSQE_IO_HARDLINK_BIT,
 105         IOSQE_ASYNC_BIT,
 106         IOSQE_BUFFER_SELECT_BIT,
 107         IOSQE_CQE_SKIP_SUCCESS_BIT,
 108 };
 109
 110 /*
 111  * sqe->flags
 112  */
 113 /* use fixed fileset */
 114 #define IOSQE_FIXED_FILE        (1U << IOSQE_FIXED_FILE_BIT)
 115 /* issue after inflight IO */
 116 #define IOSQE_IO_DRAIN          (1U << IOSQE_IO_DRAIN_BIT)
 117 /* links next sqe */
 118 #define IOSQE_IO_LINK           (1U << IOSQE_IO_LINK_BIT)
 119 /* like LINK, but stronger */
 120 #define IOSQE_IO_HARDLINK       (1U << IOSQE_IO_HARDLINK_BIT)
 121 /* always go async */
 122 #define IOSQE_ASYNC             (1U << IOSQE_ASYNC_BIT)
 123 /* select buffer from sqe->buf_group */
 124 #define IOSQE_BUFFER_SELECT     (1U << IOSQE_BUFFER_SELECT_BIT)
 125 /* don't post CQE if request succeeded */
 126 #define IOSQE_CQE_SKIP_SUCCESS  (1U << IOSQE_CQE_SKIP_SUCCESS_BIT)
 127
 128 /*
 129  * io_uring_setup() flags
 130  */
 131 #define IORING_SETUP_IOPOLL     (1U << 0)       /* io_context is polled */
 132 #define IORING_SETUP_SQPOLL     (1U << 1)       /* SQ poll thread */
 133 #define IORING_SETUP_SQ_AFF     (1U << 2)       /* sq_thread_cpu is valid */
 134 #define IORING_SETUP_CQSIZE     (1U << 3)       /* app defines CQ size */
 135 #define IORING_SETUP_CLAMP      (1U << 4)       /* clamp SQ/CQ ring sizes */
 136 #define IORING_SETUP_ATTACH_WQ  (1U << 5)       /* attach to existing wq */
 137 #define IORING_SETUP_R_DISABLED (1U << 6)       /* start with ring disabled */
 138 #define IORING_SETUP_SUBMIT_ALL (1U << 7)       /* continue submit on error */
 139 /*
 140  * Cooperative task running. When requests complete, they often require
 141  * forcing the submitter to transition to the kernel to complete. If this
 142  * flag is set, work will be done when the task transitions anyway, rather
 143  * than force an inter-processor interrupt reschedule. This avoids interrupting
 144  * a task running in userspace, and saves an IPI.
 145  */
 146 #define IORING_SETUP_COOP_TASKRUN       (1U << 8)
 147 /*
 148  * If COOP_TASKRUN is set, get notified if task work is available for
 149  * running and a kernel transition would be needed to run it. This sets
 150  * IORING_SQ_TASKRUN in the sq ring flags. Not valid with COOP_TASKRUN.
 151  */
 152 #define IORING_SETUP_TASKRUN_FLAG       (1U << 9)
 153 #define IORING_SETUP_SQE128             (1U << 10) /* SQEs are 128 byte */
 154 #define IORING_SETUP_CQE32              (1U << 11) /* CQEs are 32 byte */
 155 /*
 156  * Only one task is allowed to submit requests
 157  */
 158 #define IORING_SETUP_SINGLE_ISSUER      (1U << 12)
 159
 160 enum io_uring_op {
 161         IORING_OP_NOP,
 162         IORING_OP_READV,
 163         IORING_OP_WRITEV,
 164         IORING_OP_FSYNC,
 165         IORING_OP_READ_FIXED,
 166         IORING_OP_WRITE_FIXED,
 167         IORING_OP_POLL_ADD,
 168         IORING_OP_POLL_REMOVE,
 169         IORING_OP_SYNC_FILE_RANGE,
 170         IORING_OP_SENDMSG,
 171         IORING_OP_RECVMSG,
 172         IORING_OP_TIMEOUT,
 173         IORING_OP_TIMEOUT_REMOVE,
 174         IORING_OP_ACCEPT,
 175         IORING_OP_ASYNC_CANCEL,
 176         IORING_OP_LINK_TIMEOUT,
 177         IORING_OP_CONNECT,
 178         IORING_OP_FALLOCATE,
 179         IORING_OP_OPENAT,
 180         IORING_OP_CLOSE,
 181         IORING_OP_RSRC_UPDATE,
 182         IORING_OP_FILES_UPDATE = IORING_OP_RSRC_UPDATE,
 183         IORING_OP_STATX,
 184         IORING_OP_READ,
 185         IORING_OP_WRITE,
 186         IORING_OP_FADVISE,
 187         IORING_OP_MADVISE,
 188         IORING_OP_SEND,
 189         IORING_OP_RECV,
 190         IORING_OP_OPENAT2,
 191         IORING_OP_EPOLL_CTL,
 192         IORING_OP_SPLICE,
 193         IORING_OP_PROVIDE_BUFFERS,
 194         IORING_OP_REMOVE_BUFFERS,
 195         IORING_OP_TEE,
 196         IORING_OP_SHUTDOWN,
 197         IORING_OP_RENAMEAT,
 198         IORING_OP_UNLINKAT,
 199         IORING_OP_MKDIRAT,
 200         IORING_OP_SYMLINKAT,
 201         IORING_OP_LINKAT,
 202         IORING_OP_MSG_RING,
 203         IORING_OP_FSETXATTR,
 204         IORING_OP_SETXATTR,
 205         IORING_OP_FGETXATTR,
 206         IORING_OP_GETXATTR,
 207         IORING_OP_SOCKET,
 208         IORING_OP_URING_CMD,
 209         IORING_OP_SENDZC_NOTIF,
 210
 211         /* this goes last, obviously */
 212         IORING_OP_LAST,
 213 };
 214
 215 /*
 216  * sqe->fsync_flags
 217  */
 218 #define IORING_FSYNC_DATASYNC   (1U << 0)
 219
 220 /*
 221  * sqe->timeout_flags
 222  */
 223 #define IORING_TIMEOUT_ABS              (1U << 0)
 224 #define IORING_TIMEOUT_UPDATE           (1U << 1)
 225 #define IORING_TIMEOUT_BOOTTIME         (1U << 2)
 226 #define IORING_TIMEOUT_REALTIME         (1U << 3)
 227 #define IORING_LINK_TIMEOUT_UPDATE      (1U << 4)
 228 #define IORING_TIMEOUT_ETIME_SUCCESS    (1U << 5)
 229 #define IORING_TIMEOUT_CLOCK_MASK       (IORING_TIMEOUT_BOOTTIME | IORING_TIMEOUT_REALTIME)
 230 #define IORING_TIMEOUT_UPDATE_MASK      (IORING_TIMEOUT_UPDATE | IORING_LINK_TIMEOUT_UPDATE)
 231
 232 /*
 233  * sqe->splice_flags
 234  * extends splice(2) flags
 235  */
 236 #define SPLICE_F_FD_IN_FIXED    (1U << 31) /* the last bit of __u32 */
 237
 238 /*
 239  * POLL_ADD flags. Note that since sqe->poll_events is the flag space, the
 240  * command flags for POLL_ADD are stored in sqe->len.
 241  *
 242  * IORING_POLL_ADD_MULTI        Multishot poll. Sets IORING_CQE_F_MORE if
 243  *                              the poll handler will continue to report
 244  *                              CQEs on behalf of the same SQE.
 245  *
 246  * IORING_POLL_UPDATE           Update existing poll request, matching
 247  *                              sqe->addr as the old user_data field.
 248  *
 249  * IORING_POLL_LEVEL            Level triggered poll.
 250  */
 251 #define IORING_POLL_ADD_MULTI   (1U << 0)
 252 #define IORING_POLL_UPDATE_EVENTS       (1U << 1)
 253 #define IORING_POLL_UPDATE_USER_DATA    (1U << 2)
 254 #define IORING_POLL_ADD_LEVEL           (1U << 3)
 255
 256 /*
 257  * ASYNC_CANCEL flags.
 258  *
 259  * IORING_ASYNC_CANCEL_ALL      Cancel all requests that match the given key
 260  * IORING_ASYNC_CANCEL_FD       Key off 'fd' for cancelation rather than the
 261  *                              request 'user_data'
 262  * IORING_ASYNC_CANCEL_ANY      Match any request
 263  * IORING_ASYNC_CANCEL_FD_FIXED 'fd' passed in is a fixed descriptor
 264  */
 265 #define IORING_ASYNC_CANCEL_ALL (1U << 0)
 266 #define IORING_ASYNC_CANCEL_FD  (1U << 1)
 267 #define IORING_ASYNC_CANCEL_ANY (1U << 2)
 268 #define IORING_ASYNC_CANCEL_FD_FIXED    (1U << 3)
 269
 270 /*
 271  * send/sendmsg and recv/recvmsg flags (sqe->ioprio)
 272  *
 273  * IORING_RECVSEND_POLL_FIRST   If set, instead of first attempting to send
 274  *                              or receive and arm poll if that yields an
 275  *                              -EAGAIN result, arm poll upfront and skip
 276  *                              the initial transfer attempt.
 277  *
 278  * IORING_RECV_MULTISHOT        Multishot recv. Sets IORING_CQE_F_MORE if
 279  *                              the handler will continue to report
 280  *                              CQEs on behalf of the same SQE.
 281  *
 282  * IORING_RECVSEND_FIXED_BUF    Use registered buffers, the index is stored in
 283  *                              the buf_index field.
 284  *
 285  * IORING_RECVSEND_NOTIF_FLUSH  Flush a notification after a successful
 286  *                              successful. Only for zerocopy sends.
 287  */
 288 #define IORING_RECVSEND_POLL_FIRST      (1U << 0)
 289 #define IORING_RECV_MULTISHOT           (1U << 1)
 290 #define IORING_RECVSEND_FIXED_BUF       (1U << 2)
 291 #define IORING_RECVSEND_NOTIF_FLUSH     (1U << 3)
 292
 293 /*
 294  * accept flags stored in sqe->ioprio
 295  */
 296 #define IORING_ACCEPT_MULTISHOT (1U << 0)
 297
 298
 299 /*
 300  * IORING_OP_RSRC_UPDATE flags
 301  */
 302 enum {
 303         IORING_RSRC_UPDATE_FILES,
 304 };
 305
 306 /*
 307  * IORING_OP_MSG_RING command types, stored in sqe->addr
 308  */
 309 enum {
 310         IORING_MSG_DATA,        /* pass sqe->len as 'res' and off as user_data */
 311         IORING_MSG_SEND_FD,     /* send a registered fd to another ring */
 312 };
 313
 314 /*
 315  * IORING_OP_MSG_RING flags (sqe->msg_ring_flags)
 316  *
 317  * IORING_MSG_RING_CQE_SKIP     Don't post a CQE to the target ring. Not
 318  *                              applicable for IORING_MSG_DATA, obviously.
 319  */
 320 #define IORING_MSG_RING_CQE_SKIP        (1U << 0)
 321
 322 /*
 323  * IO completion data structure (Completion Queue Entry)
 324  */
 325 struct io_uring_cqe {
 326         __u64   user_data;      /* sqe->data submission passed back */
 327         __s32   res;            /* result code for this event */
 328         __u32   flags;
 329
 330         /*
 331          * If the ring is initialized with IORING_SETUP_CQE32, then this field
 332          * contains 16-bytes of padding, doubling the size of the CQE.
 333          */
 334         __u64 big_cqe[];
 335 };
 336
 337 /*
 338  * cqe->flags
 339  *
 340  * IORING_CQE_F_BUFFER  If set, the upper 16 bits are the buffer ID
 341  * IORING_CQE_F_MORE    If set, parent SQE will generate more CQE entries
 342  * IORING_CQE_F_SOCK_NONEMPTY   If set, more data to read after socket recv
 343  */
 344 #define IORING_CQE_F_BUFFER             (1U << 0)
 345 #define IORING_CQE_F_MORE               (1U << 1)
 346 #define IORING_CQE_F_SOCK_NONEMPTY      (1U << 2)
 347
 348 enum {
 349         IORING_CQE_BUFFER_SHIFT         = 16,
 350 };
 351
 352 /*
 353  * Magic offsets for the application to mmap the data it needs
 354  */
 355 #define IORING_OFF_SQ_RING              0ULL
 356 #define IORING_OFF_CQ_RING              0x8000000ULL
 357 #define IORING_OFF_SQES                 0x10000000ULL
 358
 359 /*
 360  * Filled with the offset for mmap(2)
 361  */
 362 struct io_sqring_offsets {
 363         __u32 head;
 364         __u32 tail;
 365         __u32 ring_mask;
 366         __u32 ring_entries;
 367         __u32 flags;
 368         __u32 dropped;
 369         __u32 array;
 370         __u32 resv1;
 371         __u64 resv2;
 372 };
 373
 374 /*
 375  * sq_ring->flags
 376  */
 377 #define IORING_SQ_NEED_WAKEUP   (1U << 0) /* needs io_uring_enter wakeup */
 378 #define IORING_SQ_CQ_OVERFLOW   (1U << 1) /* CQ ring is overflown */
 379 #define IORING_SQ_TASKRUN       (1U << 2) /* task should enter the kernel */
 380
 381 struct io_cqring_offsets {
 382         __u32 head;
 383         __u32 tail;
 384         __u32 ring_mask;
 385         __u32 ring_entries;
 386         __u32 overflow;
 387         __u32 cqes;
 388         __u32 flags;
 389         __u32 resv1;
 390         __u64 resv2;
 391 };
 392
 393 /*
 394  * cq_ring->flags
 395  */
 396
 397 /* disable eventfd notifications */
 398 #define IORING_CQ_EVENTFD_DISABLED      (1U << 0)
 399
 400 /*
 401  * io_uring_enter(2) flags
 402  */
 403 #define IORING_ENTER_GETEVENTS          (1U << 0)
 404 #define IORING_ENTER_SQ_WAKEUP          (1U << 1)
 405 #define IORING_ENTER_SQ_WAIT            (1U << 2)
 406 #define IORING_ENTER_EXT_ARG            (1U << 3)
 407 #define IORING_ENTER_REGISTERED_RING    (1U << 4)
 408
 409 /*
 410  * Passed in for io_uring_setup(2). Copied back with updated info on success
 411  */
 412 struct io_uring_params {
 413         __u32 sq_entries;
 414         __u32 cq_entries;
 415         __u32 flags;
 416         __u32 sq_thread_cpu;
 417         __u32 sq_thread_idle;
 418         __u32 features;
 419         __u32 wq_fd;
 420         __u32 resv[3];
 421         struct io_sqring_offsets sq_off;
 422         struct io_cqring_offsets cq_off;
 423 };
 424
 425 /*
 426  * io_uring_params->features flags
 427  */
 428 #define IORING_FEAT_SINGLE_MMAP         (1U << 0)
 429 #define IORING_FEAT_NODROP              (1U << 1)
 430 #define IORING_FEAT_SUBMIT_STABLE       (1U << 2)
 431 #define IORING_FEAT_RW_CUR_POS          (1U << 3)
 432 #define IORING_FEAT_CUR_PERSONALITY     (1U << 4)
 433 #define IORING_FEAT_FAST_POLL           (1U << 5)
 434 #define IORING_FEAT_POLL_32BITS         (1U << 6)
 435 #define IORING_FEAT_SQPOLL_NONFIXED     (1U << 7)
 436 #define IORING_FEAT_EXT_ARG             (1U << 8)
 437 #define IORING_FEAT_NATIVE_WORKERS      (1U << 9)
 438 #define IORING_FEAT_RSRC_TAGS           (1U << 10)
 439 #define IORING_FEAT_CQE_SKIP            (1U << 11)
 440 #define IORING_FEAT_LINKED_FILE         (1U << 12)
 441
 442 /*
 443  * io_uring_register(2) opcodes and arguments
 444  */
 445 enum {
 446         IORING_REGISTER_BUFFERS                 = 0,
 447         IORING_UNREGISTER_BUFFERS               = 1,
 448         IORING_REGISTER_FILES                   = 2,
 449         IORING_UNREGISTER_FILES                 = 3,
 450         IORING_REGISTER_EVENTFD                 = 4,
 451         IORING_UNREGISTER_EVENTFD               = 5,
 452         IORING_REGISTER_FILES_UPDATE            = 6,
 453         IORING_REGISTER_EVENTFD_ASYNC           = 7,
 454         IORING_REGISTER_PROBE                   = 8,
 455         IORING_REGISTER_PERSONALITY             = 9,
 456         IORING_UNREGISTER_PERSONALITY           = 10,
 457         IORING_REGISTER_RESTRICTIONS            = 11,
 458         IORING_REGISTER_ENABLE_RINGS            = 12,
 459
 460         /* extended with tagging */
 461         IORING_REGISTER_FILES2                  = 13,
 462         IORING_REGISTER_FILES_UPDATE2           = 14,
 463         IORING_REGISTER_BUFFERS2                = 15,
 464         IORING_REGISTER_BUFFERS_UPDATE          = 16,
 465
 466         /* set/clear io-wq thread affinities */
 467         IORING_REGISTER_IOWQ_AFF                = 17,
 468         IORING_UNREGISTER_IOWQ_AFF              = 18,
 469
 470         /* set/get max number of io-wq workers */
 471         IORING_REGISTER_IOWQ_MAX_WORKERS        = 19,
 472
 473         /* register/unregister io_uring fd with the ring */
 474         IORING_REGISTER_RING_FDS                = 20,
 475         IORING_UNREGISTER_RING_FDS              = 21,
 476
 477         /* register ring based provide buffer group */
 478         IORING_REGISTER_PBUF_RING               = 22,
 479         IORING_UNREGISTER_PBUF_RING             = 23,
 480
 481         /* sync cancelation API */
 482         IORING_REGISTER_SYNC_CANCEL             = 24,
 483
 484         /* register a range of fixed file slots for automatic slot allocation */
 485         IORING_REGISTER_FILE_ALLOC_RANGE        = 25,
 486
 487         /* zerocopy notification API */
 488         IORING_REGISTER_NOTIFIERS               = 26,
 489         IORING_UNREGISTER_NOTIFIERS             = 27,
 490
 491         /* this goes last */
 492         IORING_REGISTER_LAST
 493 };
 494
 495 /* io-wq worker categories */
 496 enum {
 497         IO_WQ_BOUND,
 498         IO_WQ_UNBOUND,
 499 };
 500
 501 /* deprecated, see struct io_uring_rsrc_update */
 502 struct io_uring_files_update {
 503         __u32 offset;
 504         __u32 resv;
 505         __aligned_u64 /* __s32 * */ fds;
 506 };
 507
 508 /*
 509  * Register a fully sparse file space, rather than pass in an array of all
 510  * -1 file descriptors.
 511  */
 512 #define IORING_RSRC_REGISTER_SPARSE     (1U << 0)
 513
 514 struct io_uring_rsrc_register {
 515         __u32 nr;
 516         __u32 flags;
 517         __u64 resv2;
 518         __aligned_u64 data;
 519         __aligned_u64 tags;
 520 };
 521
 522 struct io_uring_rsrc_update {
 523         __u32 offset;
 524         __u32 resv;
 525         __aligned_u64 data;
 526 };
 527
 528 struct io_uring_rsrc_update2 {
 529         __u32 offset;
 530         __u32 resv;
 531         __aligned_u64 data;
 532         __aligned_u64 tags;
 533         __u32 nr;
 534         __u32 resv2;
 535 };
 536
 537 struct io_uring_notification_slot {
 538         __u64 tag;
 539         __u64 resv[3];
 540 };
 541
 542 struct io_uring_notification_register {
 543         __u32 nr_slots;
 544         __u32 resv;
 545         __u64 resv2;
 546         __u64 data;
 547         __u64 resv3;
 548 };
 549
 550 /* Skip updating fd indexes set to this value in the fd table */
 551 #define IORING_REGISTER_FILES_SKIP      (-2)
 552
 553 #define IO_URING_OP_SUPPORTED   (1U << 0)
 554
 555 struct io_uring_probe_op {
 556         __u8 op;
 557         __u8 resv;
 558         __u16 flags;    /* IO_URING_OP_* flags */
 559         __u32 resv2;
 560 };
 561
 562 struct io_uring_probe {
 563         __u8 last_op;   /* last opcode supported */
 564         __u8 ops_len;   /* length of ops[] array below */
 565         __u16 resv;
 566         __u32 resv2[3];
 567         struct io_uring_probe_op ops[];
 568 };
 569
 570 struct io_uring_restriction {
 571         __u16 opcode;
 572         union {
 573                 __u8 register_op; /* IORING_RESTRICTION_REGISTER_OP */
 574                 __u8 sqe_op;      /* IORING_RESTRICTION_SQE_OP */
 575                 __u8 sqe_flags;   /* IORING_RESTRICTION_SQE_FLAGS_* */
 576         };
 577         __u8 resv;
 578         __u32 resv2[3];
 579 };
 580
 581 struct io_uring_buf {
 582         __u64   addr;
 583         __u32   len;
 584         __u16   bid;
 585         __u16   resv;
 586 };
 587
 588 struct io_uring_buf_ring {
 589         union {
 590                 /*
 591                  * To avoid spilling into more pages than we need to, the
 592                  * ring tail is overlaid with the io_uring_buf->resv field.
 593                  */
 594                 struct {
 595                         __u64   resv1;
 596                         __u32   resv2;
 597                         __u16   resv3;
 598                         __u16   tail;
 599                 };
 600                 struct io_uring_buf     bufs[0];
 601         };
 602 };
 603
 604 /* argument for IORING_(UN)REGISTER_PBUF_RING */
 605 struct io_uring_buf_reg {
 606         __u64   ring_addr;
 607         __u32   ring_entries;
 608         __u16   bgid;
 609         __u16   pad;
 610         __u64   resv[3];
 611 };
 612
 613 /*
 614  * io_uring_restriction->opcode values
 615  */
 616 enum {
 617         /* Allow an io_uring_register(2) opcode */
 618         IORING_RESTRICTION_REGISTER_OP          = 0,
 619
 620         /* Allow an sqe opcode */
 621         IORING_RESTRICTION_SQE_OP               = 1,
 622
 623         /* Allow sqe flags */
 624         IORING_RESTRICTION_SQE_FLAGS_ALLOWED    = 2,
 625
 626         /* Require sqe flags (these flags must be set on each submission) */
 627         IORING_RESTRICTION_SQE_FLAGS_REQUIRED   = 3,
 628
 629         IORING_RESTRICTION_LAST
 630 };
 631
 632 struct io_uring_getevents_arg {
 633         __u64   sigmask;
 634         __u32   sigmask_sz;
 635         __u32   pad;
 636         __u64   ts;
 637 };
 638
 639 /*
 640  * Argument for IORING_REGISTER_SYNC_CANCEL
 641  */
 642 struct io_uring_sync_cancel_reg {
 643         __u64                           addr;
 644         __s32                           fd;
 645         __u32                           flags;
 646         struct __kernel_timespec        timeout;
 647         __u64                           pad[4];
 648 };
 649
 650 /*
 651  * Argument for IORING_REGISTER_FILE_ALLOC_RANGE
 652  * The range is specified as [off, off + len)
 653  */
 654 struct io_uring_file_index_range {
 655         __u32   off;
 656         __u32   len;
 657         __u64   resv;
 658 };
 659
 660 struct io_uring_recvmsg_out {
 661         __u32 namelen;
 662         __u32 controllen;
 663         __u32 payloadlen;
 664         __u32 flags;
 665 };
 666
 667 #ifdef __cplusplus
 668 }
 669 #endif
 670
 671 #endif