include/uapi/linux/io_uring.h

   1 /* SPDX-License-Identifier: GPL-2.0 WITH Linux-syscall-note */
   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         __u64   addr;           /* pointer to buffer or iovecs */
  27         __u32   len;            /* buffer size or number of iovecs */
  28         union {
  29                 __kernel_rwf_t  rw_flags;
  30                 __u32           fsync_flags;
  31                 __u16           poll_events;
  32                 __u32           sync_range_flags;
  33                 __u32           msg_flags;
  34                 __u32           timeout_flags;
  35                 __u32           accept_flags;
  36                 __u32           cancel_flags;
  37                 __u32           open_flags;
  38                 __u32           statx_flags;
  39                 __u32           fadvise_advice;
  40         };
  41         __u64   user_data;      /* data to be passed back at completion time */
  42         union {
  43                 __u16   buf_index;      /* index into fixed buffers, if used */
  44                 __u64   __pad2[3];
  45         };
  46 };
  47
  48 enum {
  49         IOSQE_FIXED_FILE_BIT,
  50         IOSQE_IO_DRAIN_BIT,
  51         IOSQE_IO_LINK_BIT,
  52         IOSQE_IO_HARDLINK_BIT,
  53         IOSQE_ASYNC_BIT,
  54 };
  55
  56 /*
  57  * sqe->flags
  58  */
  59 /* use fixed fileset */
  60 #define IOSQE_FIXED_FILE        (1U << IOSQE_FIXED_FILE_BIT)
  61 /* issue after inflight IO */
  62 #define IOSQE_IO_DRAIN          (1U << IOSQE_IO_DRAIN_BIT)
  63 /* links next sqe */
  64 #define IOSQE_IO_LINK           (1U << IOSQE_IO_LINK_BIT)
  65 /* like LINK, but stronger */
  66 #define IOSQE_IO_HARDLINK       (1U << IOSQE_IO_HARDLINK_BIT)
  67 /* always go async */
  68 #define IOSQE_ASYNC             (1U << IOSQE_ASYNC_BIT)
  69
  70 /*
  71  * io_uring_setup() flags
  72  */
  73 #define IORING_SETUP_IOPOLL     (1U << 0)       /* io_context is polled */
  74 #define IORING_SETUP_SQPOLL     (1U << 1)       /* SQ poll thread */
  75 #define IORING_SETUP_SQ_AFF     (1U << 2)       /* sq_thread_cpu is valid */
  76 #define IORING_SETUP_CQSIZE     (1U << 3)       /* app defines CQ size */
  77 #define IORING_SETUP_CLAMP      (1U << 4)       /* clamp SQ/CQ ring sizes */
  78
  79 enum {
  80         IORING_OP_NOP,
  81         IORING_OP_READV,
  82         IORING_OP_WRITEV,
  83         IORING_OP_FSYNC,
  84         IORING_OP_READ_FIXED,
  85         IORING_OP_WRITE_FIXED,
  86         IORING_OP_POLL_ADD,
  87         IORING_OP_POLL_REMOVE,
  88         IORING_OP_SYNC_FILE_RANGE,
  89         IORING_OP_SENDMSG,
  90         IORING_OP_RECVMSG,
  91         IORING_OP_TIMEOUT,
  92         IORING_OP_TIMEOUT_REMOVE,
  93         IORING_OP_ACCEPT,
  94         IORING_OP_ASYNC_CANCEL,
  95         IORING_OP_LINK_TIMEOUT,
  96         IORING_OP_CONNECT,
  97         IORING_OP_FALLOCATE,
  98         IORING_OP_OPENAT,
  99         IORING_OP_CLOSE,
 100         IORING_OP_FILES_UPDATE,
 101         IORING_OP_STATX,
 102         IORING_OP_READ,
 103         IORING_OP_WRITE,
 104         IORING_OP_FADVISE,
 105         IORING_OP_MADVISE,
 106         IORING_OP_SEND,
 107         IORING_OP_RECV,
 108         IORING_OP_OPENAT2,
 109
 110         /* this goes last, obviously */
 111         IORING_OP_LAST,
 112 };
 113
 114 /*
 115  * sqe->fsync_flags
 116  */
 117 #define IORING_FSYNC_DATASYNC   (1U << 0)
 118
 119 /*
 120  * sqe->timeout_flags
 121  */
 122 #define IORING_TIMEOUT_ABS      (1U << 0)
 123
 124 /*
 125  * IO completion data structure (Completion Queue Entry)
 126  */
 127 struct io_uring_cqe {
 128         __u64   user_data;      /* sqe->data submission passed back */
 129         __s32   res;            /* result code for this event */
 130         __u32   flags;
 131 };
 132
 133 /*
 134  * Magic offsets for the application to mmap the data it needs
 135  */
 136 #define IORING_OFF_SQ_RING              0ULL
 137 #define IORING_OFF_CQ_RING              0x8000000ULL
 138 #define IORING_OFF_SQES                 0x10000000ULL
 139
 140 /*
 141  * Filled with the offset for mmap(2)
 142  */
 143 struct io_sqring_offsets {
 144         __u32 head;
 145         __u32 tail;
 146         __u32 ring_mask;
 147         __u32 ring_entries;
 148         __u32 flags;
 149         __u32 dropped;
 150         __u32 array;
 151         __u32 resv1;
 152         __u64 resv2;
 153 };
 154
 155 /*
 156  * sq_ring->flags
 157  */
 158 #define IORING_SQ_NEED_WAKEUP   (1U << 0) /* needs io_uring_enter wakeup */
 159
 160 struct io_cqring_offsets {
 161         __u32 head;
 162         __u32 tail;
 163         __u32 ring_mask;
 164         __u32 ring_entries;
 165         __u32 overflow;
 166         __u32 cqes;
 167         __u64 resv[2];
 168 };
 169
 170 /*
 171  * io_uring_enter(2) flags
 172  */
 173 #define IORING_ENTER_GETEVENTS  (1U << 0)
 174 #define IORING_ENTER_SQ_WAKEUP  (1U << 1)
 175
 176 /*
 177  * Passed in for io_uring_setup(2). Copied back with updated info on success
 178  */
 179 struct io_uring_params {
 180         __u32 sq_entries;
 181         __u32 cq_entries;
 182         __u32 flags;
 183         __u32 sq_thread_cpu;
 184         __u32 sq_thread_idle;
 185         __u32 features;
 186         __u32 resv[4];
 187         struct io_sqring_offsets sq_off;
 188         struct io_cqring_offsets cq_off;
 189 };
 190
 191 /*
 192  * io_uring_params->features flags
 193  */
 194 #define IORING_FEAT_SINGLE_MMAP         (1U << 0)
 195 #define IORING_FEAT_NODROP              (1U << 1)
 196 #define IORING_FEAT_SUBMIT_STABLE       (1U << 2)
 197 #define IORING_FEAT_RW_CUR_POS          (1U << 3)
 198
 199 /*
 200  * io_uring_register(2) opcodes and arguments
 201  */
 202 #define IORING_REGISTER_BUFFERS         0
 203 #define IORING_UNREGISTER_BUFFERS       1
 204 #define IORING_REGISTER_FILES           2
 205 #define IORING_UNREGISTER_FILES         3
 206 #define IORING_REGISTER_EVENTFD         4
 207 #define IORING_UNREGISTER_EVENTFD       5
 208 #define IORING_REGISTER_FILES_UPDATE    6
 209 #define IORING_REGISTER_EVENTFD_ASYNC   7
 210 #define IORING_REGISTER_PROBE           8
 211
 212 struct io_uring_files_update {
 213         __u32 offset;
 214         __u32 resv;
 215         __aligned_u64 /* __s32 * */ fds;
 216 };
 217
 218 #define IO_URING_OP_SUPPORTED   (1U << 0)
 219
 220 struct io_uring_probe_op {
 221         __u8 op;
 222         __u8 resv;
 223         __u16 flags;    /* IO_URING_OP_* flags */
 224         __u32 resv2;
 225 };
 226
 227 struct io_uring_probe {
 228         __u8 last_op;   /* last opcode supported */
 229         __u8 ops_len;   /* length of ops[] array below */
 230         __u16 resv;
 231         __u32 resv2[3];
 232         struct io_uring_probe_op ops[0];
 233 };
 234
 235 #endif