os/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;          /* as of now unused */
  20         __u16   ioprio;         /* ioprio for the request */
  21         __s32   fd;             /* file descriptor to do IO on */
  22         __u64   off;            /* offset into file */
  23         union {
  24                 void    *addr;  /* buffer or iovecs */
  25                 __u64   __pad;
  26         };
  27         __u32   len;            /* buffer size or number of iovecs */
  28         union {
  29                 __kernel_rwf_t  rw_flags;
  30                 __u32           __resv;
  31         };
  32         __u16   index;          /* index into fixed buffers, if used */
  33         __u16   __pad2[3];
  34         __u64   data;           /* data to be passed back at completion time */
  35 };
  36
  37 /*
  38  * io_uring_setup() flags
  39  */
  40 #define IORING_SETUP_IOPOLL     (1 << 0)        /* io_context is polled */
  41 #define IORING_SETUP_SQTHREAD   (1 << 1)        /* Use SQ thread */
  42 #define IORING_SETUP_SQWQ       (1 << 2)        /* Use SQ workqueue */
  43 #define IORING_SETUP_SQPOLL     (1 << 3)        /* SQ thread polls */
  44
  45 #define IORING_OP_READV         1
  46 #define IORING_OP_WRITEV        2
  47 #define IORING_OP_FSYNC         3
  48 #define IORING_OP_FDSYNC        4
  49 #define IORING_OP_READ_FIXED    5
  50 #define IORING_OP_WRITE_FIXED   6
  51
  52 /*
  53  * IO completion data structure (Completion Queue Entry)
  54  */
  55 struct io_uring_cqe {
  56         __u64   data;           /* sqe->data submission passed back */
  57         __s32   res;            /* result code for this event */
  58         __u32   flags;
  59 };
  60
  61 /*
  62  * io_uring_event->flags
  63  */
  64 #define IOCQE_FLAG_CACHEHIT     (1 << 0)        /* IO did not hit media */
  65
  66 /*
  67  * Magic offsets for the application to mmap the data it needs
  68  */
  69 #define IORING_OFF_SQ_RING              0ULL
  70 #define IORING_OFF_CQ_RING              0x8000000ULL
  71 #define IORING_OFF_SQES                 0x10000000ULL
  72
  73 /*
  74  * Filled with the offset for mmap(2)
  75  */
  76 struct io_sqring_offsets {
  77         __u32 head;
  78         __u32 tail;
  79         __u32 ring_mask;
  80         __u32 ring_entries;
  81         __u32 flags;
  82         __u32 dropped;
  83         __u32 array;
  84         __u32 resv[3];
  85 };
  86
  87 #define IORING_SQ_NEED_WAKEUP   (1 << 0) /* needs io_uring_enter wakeup */
  88
  89 struct io_cqring_offsets {
  90         __u32 head;
  91         __u32 tail;
  92         __u32 ring_mask;
  93         __u32 ring_entries;
  94         __u32 overflow;
  95         __u32 cqes;
  96         __u32 resv[4];
  97 };
  98
  99 /*
 100  * io_uring_enter(2) flags
 101  */
 102 #define IORING_ENTER_GETEVENTS  (1 << 0)
 103
 104 /*
 105  * Passed in for io_uring_setup(2). Copied back with updated info on success
 106  */
 107 struct io_uring_params {
 108         __u32 sq_entries;
 109         __u32 cq_entries;
 110         __u32 flags;
 111         __u16 sq_thread_cpu;
 112         __u16 resv[9];
 113         struct io_sqring_offsets sq_off;
 114         struct io_cqring_offsets cq_off;
 115 };
 116
 117 #endif