os/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
  14 /*
  15  * IO submission data structure (Submission Queue Entry)
  16  */
  17 struct io_uring_sqe {
  18         __u8    opcode;         /* type of operation for this sqe */
  19         __u8    flags;          /* IOSQE_ flags */
  20         __u16   ioprio;         /* ioprio for the request */
  21         __s32   fd;             /* file descriptor to do IO on */
  22         union {
  23                 __u64   off;    /* offset into file */
  24                 __u64   addr2;
  25         };
  26         union {
  27                 __u64   addr;   /* pointer to buffer or iovecs */
  28                 __u64   splice_off_in;
  29         };
  30         __u32   len;            /* buffer size or number of iovecs */
  31         union {
  32                 __kernel_rwf_t  rw_flags;
  33                 __u32           fsync_flags;
  34                 __u16           poll_events;    /* compatibility */
  35                 __u32           poll32_events;  /* word-reversed for BE */
  36                 __u32           sync_range_flags;
  37                 __u32           msg_flags;
  38                 __u32           timeout_flags;
  39                 __u32           accept_flags;
  40                 __u32           cancel_flags;
  41                 __u32           open_flags;
  42                 __u32           statx_flags;
  43                 __u32           fadvise_advice;
  44                 __u32           splice_flags;
  45                 __u32           rename_flags;
  46                 __u32           unlink_flags;
  47                 __u32           hardlink_flags;
  48         };
  49         __u64   user_data;      /* data to be passed back at completion time */
  50         /* pack this to avoid bogus arm OABI complaints */
  51         union {
  52                 /* index into fixed buffers, if used */
  53                 __u16   buf_index;
  54                 /* for grouped buffer selection */
  55                 __u16   buf_group;
  56         } __attribute__((packed));
  57         /* personality to use, if used */
  58         __u16   personality;
  59         union {
  60                 __s32   splice_fd_in;
  61                 __u32   file_index;
  62         };
  63         union {
  64                 struct {
  65                         __u64   addr3;
  66                         __u64   __pad2[1];
  67                 };
  68                 /*
  69                  * If the ring is initialized with IORING_SETUP_SQE128, then
  70                  * this field is used for 80 bytes of arbitrary command data
  71                  */
  72                 __u8    cmd[0];
  73         };
  74 };
  75
  76 enum {
  77         IOSQE_FIXED_FILE_BIT,
  78         IOSQE_IO_DRAIN_BIT,
  79         IOSQE_IO_LINK_BIT,
  80         IOSQE_IO_HARDLINK_BIT,
  81         IOSQE_ASYNC_BIT,
  82         IOSQE_BUFFER_SELECT_BIT,
  83         IOSQE_CQE_SKIP_SUCCESS_BIT,
  84 };
  85
  86 /*
  87  * sqe->flags
  88  */
  89 /* use fixed fileset */
  90 #define IOSQE_FIXED_FILE        (1U << IOSQE_FIXED_FILE_BIT)
  91 /* issue after inflight IO */
  92 #define IOSQE_IO_DRAIN          (1U << IOSQE_IO_DRAIN_BIT)
  93 /* links next sqe */
  94 #define IOSQE_IO_LINK           (1U << IOSQE_IO_LINK_BIT)
  95 /* like LINK, but stronger */
  96 #define IOSQE_IO_HARDLINK       (1U << IOSQE_IO_HARDLINK_BIT)
  97 /* always go async */
  98 #define IOSQE_ASYNC             (1U << IOSQE_ASYNC_BIT)
  99 /* select buffer from sqe->buf_group */
 100 #define IOSQE_BUFFER_SELECT     (1U << IOSQE_BUFFER_SELECT_BIT)
 101 /* don't post CQE if request succeeded */
 102 #define IOSQE_CQE_SKIP_SUCCESS  (1U << IOSQE_CQE_SKIP_SUCCESS_BIT)
 103
 104 /*
 105  * io_uring_setup() flags
 106  */
 107 #define IORING_SETUP_IOPOLL     (1U << 0)       /* io_context is polled */
 108 #define IORING_SETUP_SQPOLL     (1U << 1)       /* SQ poll thread */
 109 #define IORING_SETUP_SQ_AFF     (1U << 2)       /* sq_thread_cpu is valid */
 110 #define IORING_SETUP_CQSIZE     (1U << 3)       /* app defines CQ size */
 111 #define IORING_SETUP_CLAMP      (1U << 4)       /* clamp SQ/CQ ring sizes */
 112 #define IORING_SETUP_ATTACH_WQ  (1U << 5)       /* attach to existing wq */
 113 #define IORING_SETUP_R_DISABLED (1U << 6)       /* start with ring disabled */
 114 #define IORING_SETUP_SUBMIT_ALL (1U << 7)       /* continue submit on error */
 115 /*
 116  * Cooperative task running. When requests complete, they often require
 117  * forcing the submitter to transition to the kernel to complete. If this
 118  * flag is set, work will be done when the task transitions anyway, rather
 119  * than force an inter-processor interrupt reschedule. This avoids interrupting
 120  * a task running in userspace, and saves an IPI.
 121  */
 122 #define IORING_SETUP_COOP_TASKRUN       (1U << 8)
 123 /*
 124  * If COOP_TASKRUN is set, get notified if task work is available for
 125  * running and a kernel transition would be needed to run it. This sets
 126  * IORING_SQ_TASKRUN in the sq ring flags. Not valid with COOP_TASKRUN.
 127  */
 128 #define IORING_SETUP_TASKRUN_FLAG       (1U << 9)
 129
 130 #define IORING_SETUP_SQE128             (1U << 10) /* SQEs are 128 byte */
 131 #define IORING_SETUP_CQE32              (1U << 11) /* CQEs are 32 byte */
 132
 133 enum {
 134         IORING_OP_NOP,
 135         IORING_OP_READV,
 136         IORING_OP_WRITEV,
 137         IORING_OP_FSYNC,
 138         IORING_OP_READ_FIXED,
 139         IORING_OP_WRITE_FIXED,
 140         IORING_OP_POLL_ADD,
 141         IORING_OP_POLL_REMOVE,
 142         IORING_OP_SYNC_FILE_RANGE,
 143         IORING_OP_SENDMSG,
 144         IORING_OP_RECVMSG,
 145         IORING_OP_TIMEOUT,
 146         IORING_OP_TIMEOUT_REMOVE,
 147         IORING_OP_ACCEPT,
 148         IORING_OP_ASYNC_CANCEL,
 149         IORING_OP_LINK_TIMEOUT,
 150         IORING_OP_CONNECT,
 151         IORING_OP_FALLOCATE,
 152         IORING_OP_OPENAT,
 153         IORING_OP_CLOSE,
 154         IORING_OP_FILES_UPDATE,
 155         IORING_OP_STATX,
 156         IORING_OP_READ,
 157         IORING_OP_WRITE,
 158         IORING_OP_FADVISE,
 159         IORING_OP_MADVISE,
 160         IORING_OP_SEND,
 161         IORING_OP_RECV,
 162         IORING_OP_OPENAT2,
 163         IORING_OP_EPOLL_CTL,
 164         IORING_OP_SPLICE,
 165         IORING_OP_PROVIDE_BUFFERS,
 166         IORING_OP_REMOVE_BUFFERS,
 167         IORING_OP_TEE,
 168         IORING_OP_SHUTDOWN,
 169         IORING_OP_RENAMEAT,
 170         IORING_OP_UNLINKAT,
 171         IORING_OP_MKDIRAT,
 172         IORING_OP_SYMLINKAT,
 173         IORING_OP_LINKAT,
 174
 175         /* this goes last, obviously */
 176         IORING_OP_LAST,
 177 };
 178
 179 /*
 180  * sqe->fsync_flags
 181  */
 182 #define IORING_FSYNC_DATASYNC   (1U << 0)
 183
 184 /*
 185  * sqe->timeout_flags
 186  */
 187 #define IORING_TIMEOUT_ABS              (1U << 0)
 188 #define IORING_TIMEOUT_UPDATE           (1U << 1)
 189 #define IORING_TIMEOUT_BOOTTIME         (1U << 2)
 190 #define IORING_TIMEOUT_REALTIME         (1U << 3)
 191 #define IORING_LINK_TIMEOUT_UPDATE      (1U << 4)
 192 #define IORING_TIMEOUT_ETIME_SUCCESS    (1U << 5)
 193 #define IORING_TIMEOUT_CLOCK_MASK       (IORING_TIMEOUT_BOOTTIME | IORING_TIMEOUT_REALTIME)
 194 #define IORING_TIMEOUT_UPDATE_MASK      (IORING_TIMEOUT_UPDATE | IORING_LINK_TIMEOUT_UPDATE)
 195 /*
 196  * sqe->splice_flags
 197  * extends splice(2) flags
 198  */
 199 #define SPLICE_F_FD_IN_FIXED    (1U << 31) /* the last bit of __u32 */
 200
 201 /*
 202  * POLL_ADD flags. Note that since sqe->poll_events is the flag space, the
 203  * command flags for POLL_ADD are stored in sqe->len.
 204  *
 205  * IORING_POLL_ADD_MULTI        Multishot poll. Sets IORING_CQE_F_MORE if
 206  *                              the poll handler will continue to report
 207  *                              CQEs on behalf of the same SQE.
 208  *
 209  * IORING_POLL_UPDATE           Update existing poll request, matching
 210  *                              sqe->addr as the old user_data field.
 211  */
 212 #define IORING_POLL_ADD_MULTI   (1U << 0)
 213 #define IORING_POLL_UPDATE_EVENTS       (1U << 1)
 214 #define IORING_POLL_UPDATE_USER_DATA    (1U << 2)
 215
 216 /*
 217  * IO completion data structure (Completion Queue Entry)
 218  */
 219 struct io_uring_cqe {
 220         __u64   user_data;      /* sqe->data submission passed back */
 221         __s32   res;            /* result code for this event */
 222         __u32   flags;
 223
 224         /*
 225          * If the ring is initialized with IORING_SETUP_CQE32, then this field
 226          * contains 16-bytes of padding, doubling the size of the CQE.
 227          */
 228         __u64 big_cqe[];
 229 };
 230
 231 /*
 232  * cqe->flags
 233  *
 234  * IORING_CQE_F_BUFFER  If set, the upper 16 bits are the buffer ID
 235  * IORING_CQE_F_MORE    If set, parent SQE will generate more CQE entries
 236  */
 237 #define IORING_CQE_F_BUFFER             (1U << 0)
 238 #define IORING_CQE_F_MORE               (1U << 1)
 239
 240 enum {
 241         IORING_CQE_BUFFER_SHIFT         = 16,
 242 };
 243
 244 /*
 245  * Magic offsets for the application to mmap the data it needs
 246  */
 247 #define IORING_OFF_SQ_RING              0ULL
 248 #define IORING_OFF_CQ_RING              0x8000000ULL
 249 #define IORING_OFF_SQES                 0x10000000ULL
 250
 251 /*
 252  * Filled with the offset for mmap(2)
 253  */
 254 struct io_sqring_offsets {
 255         __u32 head;
 256         __u32 tail;
 257         __u32 ring_mask;
 258         __u32 ring_entries;
 259         __u32 flags;
 260         __u32 dropped;
 261         __u32 array;
 262         __u32 resv1;
 263         __u64 resv2;
 264 };
 265
 266 /*
 267  * sq_ring->flags
 268  */
 269 #define IORING_SQ_NEED_WAKEUP   (1U << 0) /* needs io_uring_enter wakeup */
 270 #define IORING_SQ_CQ_OVERFLOW   (1U << 1) /* CQ ring is overflown */
 271
 272 struct io_cqring_offsets {
 273         __u32 head;
 274         __u32 tail;
 275         __u32 ring_mask;
 276         __u32 ring_entries;
 277         __u32 overflow;
 278         __u32 cqes;
 279         __u32 flags;
 280         __u32 resv1;
 281         __u64 resv2;
 282 };
 283
 284 /*
 285  * cq_ring->flags
 286  */
 287
 288 /* disable eventfd notifications */
 289 #define IORING_CQ_EVENTFD_DISABLED      (1U << 0)
 290
 291 /*
 292  * io_uring_enter(2) flags
 293  */
 294 #define IORING_ENTER_GETEVENTS          (1U << 0)
 295 #define IORING_ENTER_SQ_WAKEUP          (1U << 1)
 296 #define IORING_ENTER_SQ_WAIT            (1U << 2)
 297 #define IORING_ENTER_EXT_ARG            (1U << 3)
 298 #define IORING_ENTER_REGISTERED_RING    (1U << 4)
 299
 300 /*
 301  * Passed in for io_uring_setup(2). Copied back with updated info on success
 302  */
 303 struct io_uring_params {
 304         __u32 sq_entries;
 305         __u32 cq_entries;
 306         __u32 flags;
 307         __u32 sq_thread_cpu;
 308         __u32 sq_thread_idle;
 309         __u32 features;
 310         __u32 wq_fd;
 311         __u32 resv[3];
 312         struct io_sqring_offsets sq_off;
 313         struct io_cqring_offsets cq_off;
 314 };
 315
 316 /*
 317  * io_uring_params->features flags
 318  */
 319 #define IORING_FEAT_SINGLE_MMAP         (1U << 0)
 320 #define IORING_FEAT_NODROP              (1U << 1)
 321 #define IORING_FEAT_SUBMIT_STABLE       (1U << 2)
 322 #define IORING_FEAT_RW_CUR_POS          (1U << 3)
 323 #define IORING_FEAT_CUR_PERSONALITY     (1U << 4)
 324 #define IORING_FEAT_FAST_POLL           (1U << 5)
 325 #define IORING_FEAT_POLL_32BITS         (1U << 6)
 326 #define IORING_FEAT_SQPOLL_NONFIXED     (1U << 7)
 327 #define IORING_FEAT_EXT_ARG             (1U << 8)
 328 #define IORING_FEAT_NATIVE_WORKERS      (1U << 9)
 329 #define IORING_FEAT_RSRC_TAGS           (1U << 10)
 330 #define IORING_FEAT_CQE_SKIP            (1U << 11)
 331
 332 /*
 333  * io_uring_register(2) opcodes and arguments
 334  */
 335 enum {
 336         IORING_REGISTER_BUFFERS                 = 0,
 337         IORING_UNREGISTER_BUFFERS               = 1,
 338         IORING_REGISTER_FILES                   = 2,
 339         IORING_UNREGISTER_FILES                 = 3,
 340         IORING_REGISTER_EVENTFD                 = 4,
 341         IORING_UNREGISTER_EVENTFD               = 5,
 342         IORING_REGISTER_FILES_UPDATE            = 6,
 343         IORING_REGISTER_EVENTFD_ASYNC           = 7,
 344         IORING_REGISTER_PROBE                   = 8,
 345         IORING_REGISTER_PERSONALITY             = 9,
 346         IORING_UNREGISTER_PERSONALITY           = 10,
 347         IORING_REGISTER_RESTRICTIONS            = 11,
 348         IORING_REGISTER_ENABLE_RINGS            = 12,
 349
 350         /* extended with tagging */
 351         IORING_REGISTER_FILES2                  = 13,
 352         IORING_REGISTER_FILES_UPDATE2           = 14,
 353         IORING_REGISTER_BUFFERS2                = 15,
 354         IORING_REGISTER_BUFFERS_UPDATE          = 16,
 355
 356         /* set/clear io-wq thread affinities */
 357         IORING_REGISTER_IOWQ_AFF                = 17,
 358         IORING_UNREGISTER_IOWQ_AFF              = 18,
 359
 360         /* set/get max number of io-wq workers */
 361         IORING_REGISTER_IOWQ_MAX_WORKERS        = 19,
 362
 363         /* register/unregister io_uring fd with the ring */
 364         IORING_REGISTER_RING_FDS                = 20,
 365         IORING_UNREGISTER_RING_FDS              = 21,
 366
 367         /* this goes last */
 368         IORING_REGISTER_LAST
 369 };
 370
 371 /* io-wq worker categories */
 372 enum {
 373         IO_WQ_BOUND,
 374         IO_WQ_UNBOUND,
 375 };
 376
 377 /* deprecated, see struct io_uring_rsrc_update */
 378 struct io_uring_files_update {
 379         __u32 offset;
 380         __u32 resv;
 381         __aligned_u64 /* __s32 * */ fds;
 382 };
 383
 384 struct io_uring_rsrc_register {
 385         __u32 nr;
 386         __u32 resv;
 387         __u64 resv2;
 388         __aligned_u64 data;
 389         __aligned_u64 tags;
 390 };
 391
 392 struct io_uring_rsrc_update {
 393         __u32 offset;
 394         __u32 resv;
 395         __aligned_u64 data;
 396 };
 397
 398 struct io_uring_rsrc_update2 {
 399         __u32 offset;
 400         __u32 resv;
 401         __aligned_u64 data;
 402         __aligned_u64 tags;
 403         __u32 nr;
 404         __u32 resv2;
 405 };
 406
 407 /* Skip updating fd indexes set to this value in the fd table */
 408 #define IORING_REGISTER_FILES_SKIP      (-2)
 409
 410 #define IO_URING_OP_SUPPORTED   (1U << 0)
 411
 412 struct io_uring_probe_op {
 413         __u8 op;
 414         __u8 resv;
 415         __u16 flags;    /* IO_URING_OP_* flags */
 416         __u32 resv2;
 417 };
 418
 419 struct io_uring_probe {
 420         __u8 last_op;   /* last opcode supported */
 421         __u8 ops_len;   /* length of ops[] array below */
 422         __u16 resv;
 423         __u32 resv2[3];
 424         struct io_uring_probe_op ops[0];
 425 };
 426
 427 struct io_uring_restriction {
 428         __u16 opcode;
 429         union {
 430                 __u8 register_op; /* IORING_RESTRICTION_REGISTER_OP */
 431                 __u8 sqe_op;      /* IORING_RESTRICTION_SQE_OP */
 432                 __u8 sqe_flags;   /* IORING_RESTRICTION_SQE_FLAGS_* */
 433         };
 434         __u8 resv;
 435         __u32 resv2[3];
 436 };
 437
 438 /*
 439  * io_uring_restriction->opcode values
 440  */
 441 enum {
 442         /* Allow an io_uring_register(2) opcode */
 443         IORING_RESTRICTION_REGISTER_OP          = 0,
 444
 445         /* Allow an sqe opcode */
 446         IORING_RESTRICTION_SQE_OP               = 1,
 447
 448         /* Allow sqe flags */
 449         IORING_RESTRICTION_SQE_FLAGS_ALLOWED    = 2,
 450
 451         /* Require sqe flags (these flags must be set on each submission) */
 452         IORING_RESTRICTION_SQE_FLAGS_REQUIRED   = 3,
 453
 454         IORING_RESTRICTION_LAST
 455 };
 456
 457 struct io_uring_getevents_arg {
 458         __u64   sigmask;
 459         __u32   sigmask_sz;
 460         __u32   pad;
 461         __u64   ts;
 462 };
 463
 464 #endif