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