include/linux/io_uring_types.h

   1 #ifndef IO_URING_TYPES_H
   2 #define IO_URING_TYPES_H
   3
   4 #include <linux/blkdev.h>
   5 #include <linux/task_work.h>
   6 #include <linux/bitmap.h>
   7 #include <uapi/linux/io_uring.h>
   8
   9 struct io_wq_work_node {
  10         struct io_wq_work_node *next;
  11 };
  12
  13 struct io_wq_work_list {
  14         struct io_wq_work_node *first;
  15         struct io_wq_work_node *last;
  16 };
  17
  18 struct io_wq_work {
  19         struct io_wq_work_node list;
  20         unsigned flags;
  21         /* place it here instead of io_kiocb as it fills padding and saves 4B */
  22         int cancel_seq;
  23 };
  24
  25 struct io_fixed_file {
  26         /* file * with additional FFS_* flags */
  27         unsigned long file_ptr;
  28 };
  29
  30 struct io_file_table {
  31         struct io_fixed_file *files;
  32         unsigned long *bitmap;
  33         unsigned int alloc_hint;
  34 };
  35
  36 struct io_hash_bucket {
  37         spinlock_t              lock;
  38         struct hlist_head       list;
  39 } ____cacheline_aligned_in_smp;
  40
  41 struct io_hash_table {
  42         struct io_hash_bucket   *hbs;
  43         unsigned                hash_bits;
  44 };
  45
  46 struct io_uring {
  47         u32 head ____cacheline_aligned_in_smp;
  48         u32 tail ____cacheline_aligned_in_smp;
  49 };
  50
  51 /*
  52  * This data is shared with the application through the mmap at offsets
  53  * IORING_OFF_SQ_RING and IORING_OFF_CQ_RING.
  54  *
  55  * The offsets to the member fields are published through struct
  56  * io_sqring_offsets when calling io_uring_setup.
  57  */
  58 struct io_rings {
  59         /*
  60          * Head and tail offsets into the ring; the offsets need to be
  61          * masked to get valid indices.
  62          *
  63          * The kernel controls head of the sq ring and the tail of the cq ring,
  64          * and the application controls tail of the sq ring and the head of the
  65          * cq ring.
  66          */
  67         struct io_uring         sq, cq;
  68         /*
  69          * Bitmasks to apply to head and tail offsets (constant, equals
  70          * ring_entries - 1)
  71          */
  72         u32                     sq_ring_mask, cq_ring_mask;
  73         /* Ring sizes (constant, power of 2) */
  74         u32                     sq_ring_entries, cq_ring_entries;
  75         /*
  76          * Number of invalid entries dropped by the kernel due to
  77          * invalid index stored in array
  78          *
  79          * Written by the kernel, shouldn't be modified by the
  80          * application (i.e. get number of "new events" by comparing to
  81          * cached value).
  82          *
  83          * After a new SQ head value was read by the application this
  84          * counter includes all submissions that were dropped reaching
  85          * the new SQ head (and possibly more).
  86          */
  87         u32                     sq_dropped;
  88         /*
  89          * Runtime SQ flags
  90          *
  91          * Written by the kernel, shouldn't be modified by the
  92          * application.
  93          *
  94          * The application needs a full memory barrier before checking
  95          * for IORING_SQ_NEED_WAKEUP after updating the sq tail.
  96          */
  97         atomic_t                sq_flags;
  98         /*
  99          * Runtime CQ flags
 100          *
 101          * Written by the application, shouldn't be modified by the
 102          * kernel.
 103          */
 104         u32                     cq_flags;
 105         /*
 106          * Number of completion events lost because the queue was full;
 107          * this should be avoided by the application by making sure
 108          * there are not more requests pending than there is space in
 109          * the completion queue.
 110          *
 111          * Written by the kernel, shouldn't be modified by the
 112          * application (i.e. get number of "new events" by comparing to
 113          * cached value).
 114          *
 115          * As completion events come in out of order this counter is not
 116          * ordered with any other data.
 117          */
 118         u32                     cq_overflow;
 119         /*
 120          * Ring buffer of completion events.
 121          *
 122          * The kernel writes completion events fresh every time they are
 123          * produced, so the application is allowed to modify pending
 124          * entries.
 125          */
 126         struct io_uring_cqe     cqes[] ____cacheline_aligned_in_smp;
 127 };
 128
 129 struct io_restriction {
 130         DECLARE_BITMAP(register_op, IORING_REGISTER_LAST);
 131         DECLARE_BITMAP(sqe_op, IORING_OP_LAST);
 132         u8 sqe_flags_allowed;
 133         u8 sqe_flags_required;
 134         bool registered;
 135 };
 136
 137 struct io_submit_link {
 138         struct io_kiocb         *head;
 139         struct io_kiocb         *last;
 140 };
 141
 142 struct io_submit_state {
 143         /* inline/task_work completion list, under ->uring_lock */
 144         struct io_wq_work_node  free_list;
 145         /* batch completion logic */
 146         struct io_wq_work_list  compl_reqs;
 147         struct io_submit_link   link;
 148
 149         bool                    plug_started;
 150         bool                    need_plug;
 151         unsigned short          submit_nr;
 152         struct blk_plug         plug;
 153 };
 154
 155 struct io_ev_fd {
 156         struct eventfd_ctx      *cq_ev_fd;
 157         unsigned int            eventfd_async: 1;
 158         struct rcu_head         rcu;
 159 };
 160
 161 struct io_ring_ctx {
 162         /* const or read-mostly hot data */
 163         struct {
 164                 struct percpu_ref       refs;
 165
 166                 struct io_rings         *rings;
 167                 unsigned int            flags;
 168                 enum task_work_notify_mode      notify_method;
 169                 unsigned int            compat: 1;
 170                 unsigned int            drain_next: 1;
 171                 unsigned int            restricted: 1;
 172                 unsigned int            off_timeout_used: 1;
 173                 unsigned int            drain_active: 1;
 174                 unsigned int            drain_disabled: 1;
 175                 unsigned int            has_evfd: 1;
 176                 unsigned int            syscall_iopoll: 1;
 177         } ____cacheline_aligned_in_smp;
 178
 179         /* submission data */
 180         struct {
 181                 struct mutex            uring_lock;
 182
 183                 /*
 184                  * Ring buffer of indices into array of io_uring_sqe, which is
 185                  * mmapped by the application using the IORING_OFF_SQES offset.
 186                  *
 187                  * This indirection could e.g. be used to assign fixed
 188                  * io_uring_sqe entries to operations and only submit them to
 189                  * the queue when needed.
 190                  *
 191                  * The kernel modifies neither the indices array nor the entries
 192                  * array.
 193                  */
 194                 u32                     *sq_array;
 195                 struct io_uring_sqe     *sq_sqes;
 196                 unsigned                cached_sq_head;
 197                 unsigned                sq_entries;
 198
 199                 /*
 200                  * Fixed resources fast path, should be accessed only under
 201                  * uring_lock, and updated through io_uring_register(2)
 202                  */
 203                 struct io_rsrc_node     *rsrc_node;
 204                 int                     rsrc_cached_refs;
 205                 atomic_t                cancel_seq;
 206                 struct io_file_table    file_table;
 207                 unsigned                nr_user_files;
 208                 unsigned                nr_user_bufs;
 209                 struct io_mapped_ubuf   **user_bufs;
 210
 211                 struct io_submit_state  submit_state;
 212
 213                 struct io_buffer_list   *io_bl;
 214                 struct xarray           io_bl_xa;
 215                 struct list_head        io_buffers_cache;
 216
 217                 struct io_hash_table    cancel_table_locked;
 218                 struct list_head        cq_overflow_list;
 219                 struct list_head        apoll_cache;
 220                 struct xarray           personalities;
 221                 u32                     pers_next;
 222         } ____cacheline_aligned_in_smp;
 223
 224         /* IRQ completion list, under ->completion_lock */
 225         struct io_wq_work_list  locked_free_list;
 226         unsigned int            locked_free_nr;
 227
 228         const struct cred       *sq_creds;      /* cred used for __io_sq_thread() */
 229         struct io_sq_data       *sq_data;       /* if using sq thread polling */
 230
 231         struct wait_queue_head  sqo_sq_wait;
 232         struct list_head        sqd_list;
 233
 234         unsigned long           check_cq;
 235
 236         unsigned int            file_alloc_start;
 237         unsigned int            file_alloc_end;
 238
 239         struct {
 240                 /*
 241                  * We cache a range of free CQEs we can use, once exhausted it
 242                  * should go through a slower range setup, see __io_get_cqe()
 243                  */
 244                 struct io_uring_cqe     *cqe_cached;
 245                 struct io_uring_cqe     *cqe_sentinel;
 246
 247                 unsigned                cached_cq_tail;
 248                 unsigned                cq_entries;
 249                 struct io_ev_fd __rcu   *io_ev_fd;
 250                 struct wait_queue_head  cq_wait;
 251                 unsigned                cq_extra;
 252         } ____cacheline_aligned_in_smp;
 253
 254         struct {
 255                 spinlock_t              completion_lock;
 256
 257                 /*
 258                  * ->iopoll_list is protected by the ctx->uring_lock for
 259                  * io_uring instances that don't use IORING_SETUP_SQPOLL.
 260                  * For SQPOLL, only the single threaded io_sq_thread() will
 261                  * manipulate the list, hence no extra locking is needed there.
 262                  */
 263                 struct io_wq_work_list  iopoll_list;
 264                 struct io_hash_table    cancel_table;
 265                 bool                    poll_multi_queue;
 266
 267                 struct list_head        io_buffers_comp;
 268         } ____cacheline_aligned_in_smp;
 269
 270         /* timeouts */
 271         struct {
 272                 spinlock_t              timeout_lock;
 273                 atomic_t                cq_timeouts;
 274                 struct list_head        timeout_list;
 275                 struct list_head        ltimeout_list;
 276                 unsigned                cq_last_tm_flush;
 277         } ____cacheline_aligned_in_smp;
 278
 279         /* Keep this last, we don't need it for the fast path */
 280
 281         struct io_restriction           restrictions;
 282         struct task_struct              *submitter_task;
 283
 284         /* slow path rsrc auxilary data, used by update/register */
 285         struct io_rsrc_node             *rsrc_backup_node;
 286         struct io_mapped_ubuf           *dummy_ubuf;
 287         struct io_rsrc_data             *file_data;
 288         struct io_rsrc_data             *buf_data;
 289
 290         struct delayed_work             rsrc_put_work;
 291         struct llist_head               rsrc_put_llist;
 292         struct list_head                rsrc_ref_list;
 293         spinlock_t                      rsrc_ref_lock;
 294
 295         struct list_head                io_buffers_pages;
 296
 297         #if defined(CONFIG_UNIX)
 298                 struct socket           *ring_sock;
 299         #endif
 300         /* hashed buffered write serialization */
 301         struct io_wq_hash               *hash_map;
 302
 303         /* Only used for accounting purposes */
 304         struct user_struct              *user;
 305         struct mm_struct                *mm_account;
 306
 307         /* ctx exit and cancelation */
 308         struct llist_head               fallback_llist;
 309         struct delayed_work             fallback_work;
 310         struct work_struct              exit_work;
 311         struct list_head                tctx_list;
 312         struct completion               ref_comp;
 313
 314         /* io-wq management, e.g. thread count */
 315         u32                             iowq_limits[2];
 316         bool                            iowq_limits_set;
 317
 318         struct list_head                defer_list;
 319         unsigned                        sq_thread_idle;
 320         /* protected by ->completion_lock */
 321         unsigned                        evfd_last_cq_tail;
 322 };
 323
 324 enum {
 325         REQ_F_FIXED_FILE_BIT    = IOSQE_FIXED_FILE_BIT,
 326         REQ_F_IO_DRAIN_BIT      = IOSQE_IO_DRAIN_BIT,
 327         REQ_F_LINK_BIT          = IOSQE_IO_LINK_BIT,
 328         REQ_F_HARDLINK_BIT      = IOSQE_IO_HARDLINK_BIT,
 329         REQ_F_FORCE_ASYNC_BIT   = IOSQE_ASYNC_BIT,
 330         REQ_F_BUFFER_SELECT_BIT = IOSQE_BUFFER_SELECT_BIT,
 331         REQ_F_CQE_SKIP_BIT      = IOSQE_CQE_SKIP_SUCCESS_BIT,
 332
 333         /* first byte is taken by user flags, shift it to not overlap */
 334         REQ_F_FAIL_BIT          = 8,
 335         REQ_F_INFLIGHT_BIT,
 336         REQ_F_CUR_POS_BIT,
 337         REQ_F_NOWAIT_BIT,
 338         REQ_F_LINK_TIMEOUT_BIT,
 339         REQ_F_NEED_CLEANUP_BIT,
 340         REQ_F_POLLED_BIT,
 341         REQ_F_BUFFER_SELECTED_BIT,
 342         REQ_F_BUFFER_RING_BIT,
 343         REQ_F_REISSUE_BIT,
 344         REQ_F_CREDS_BIT,
 345         REQ_F_REFCOUNT_BIT,
 346         REQ_F_ARM_LTIMEOUT_BIT,
 347         REQ_F_ASYNC_DATA_BIT,
 348         REQ_F_SKIP_LINK_CQES_BIT,
 349         REQ_F_SINGLE_POLL_BIT,
 350         REQ_F_DOUBLE_POLL_BIT,
 351         REQ_F_PARTIAL_IO_BIT,
 352         REQ_F_CQE32_INIT_BIT,
 353         REQ_F_APOLL_MULTISHOT_BIT,
 354         REQ_F_CLEAR_POLLIN_BIT,
 355         REQ_F_HASH_LOCKED_BIT,
 356         /* keep async read/write and isreg together and in order */
 357         REQ_F_SUPPORT_NOWAIT_BIT,
 358         REQ_F_ISREG_BIT,
 359
 360         /* not a real bit, just to check we're not overflowing the space */
 361         __REQ_F_LAST_BIT,
 362 };
 363
 364 enum {
 365         /* ctx owns file */
 366         REQ_F_FIXED_FILE        = BIT(REQ_F_FIXED_FILE_BIT),
 367         /* drain existing IO first */
 368         REQ_F_IO_DRAIN          = BIT(REQ_F_IO_DRAIN_BIT),
 369         /* linked sqes */
 370         REQ_F_LINK              = BIT(REQ_F_LINK_BIT),
 371         /* doesn't sever on completion < 0 */
 372         REQ_F_HARDLINK          = BIT(REQ_F_HARDLINK_BIT),
 373         /* IOSQE_ASYNC */
 374         REQ_F_FORCE_ASYNC       = BIT(REQ_F_FORCE_ASYNC_BIT),
 375         /* IOSQE_BUFFER_SELECT */
 376         REQ_F_BUFFER_SELECT     = BIT(REQ_F_BUFFER_SELECT_BIT),
 377         /* IOSQE_CQE_SKIP_SUCCESS */
 378         REQ_F_CQE_SKIP          = BIT(REQ_F_CQE_SKIP_BIT),
 379
 380         /* fail rest of links */
 381         REQ_F_FAIL              = BIT(REQ_F_FAIL_BIT),
 382         /* on inflight list, should be cancelled and waited on exit reliably */
 383         REQ_F_INFLIGHT          = BIT(REQ_F_INFLIGHT_BIT),
 384         /* read/write uses file position */
 385         REQ_F_CUR_POS           = BIT(REQ_F_CUR_POS_BIT),
 386         /* must not punt to workers */
 387         REQ_F_NOWAIT            = BIT(REQ_F_NOWAIT_BIT),
 388         /* has or had linked timeout */
 389         REQ_F_LINK_TIMEOUT      = BIT(REQ_F_LINK_TIMEOUT_BIT),
 390         /* needs cleanup */
 391         REQ_F_NEED_CLEANUP      = BIT(REQ_F_NEED_CLEANUP_BIT),
 392         /* already went through poll handler */
 393         REQ_F_POLLED            = BIT(REQ_F_POLLED_BIT),
 394         /* buffer already selected */
 395         REQ_F_BUFFER_SELECTED   = BIT(REQ_F_BUFFER_SELECTED_BIT),
 396         /* buffer selected from ring, needs commit */
 397         REQ_F_BUFFER_RING       = BIT(REQ_F_BUFFER_RING_BIT),
 398         /* caller should reissue async */
 399         REQ_F_REISSUE           = BIT(REQ_F_REISSUE_BIT),
 400         /* supports async reads/writes */
 401         REQ_F_SUPPORT_NOWAIT    = BIT(REQ_F_SUPPORT_NOWAIT_BIT),
 402         /* regular file */
 403         REQ_F_ISREG             = BIT(REQ_F_ISREG_BIT),
 404         /* has creds assigned */
 405         REQ_F_CREDS             = BIT(REQ_F_CREDS_BIT),
 406         /* skip refcounting if not set */
 407         REQ_F_REFCOUNT          = BIT(REQ_F_REFCOUNT_BIT),
 408         /* there is a linked timeout that has to be armed */
 409         REQ_F_ARM_LTIMEOUT      = BIT(REQ_F_ARM_LTIMEOUT_BIT),
 410         /* ->async_data allocated */
 411         REQ_F_ASYNC_DATA        = BIT(REQ_F_ASYNC_DATA_BIT),
 412         /* don't post CQEs while failing linked requests */
 413         REQ_F_SKIP_LINK_CQES    = BIT(REQ_F_SKIP_LINK_CQES_BIT),
 414         /* single poll may be active */
 415         REQ_F_SINGLE_POLL       = BIT(REQ_F_SINGLE_POLL_BIT),
 416         /* double poll may active */
 417         REQ_F_DOUBLE_POLL       = BIT(REQ_F_DOUBLE_POLL_BIT),
 418         /* request has already done partial IO */
 419         REQ_F_PARTIAL_IO        = BIT(REQ_F_PARTIAL_IO_BIT),
 420         /* fast poll multishot mode */
 421         REQ_F_APOLL_MULTISHOT   = BIT(REQ_F_APOLL_MULTISHOT_BIT),
 422         /* ->extra1 and ->extra2 are initialised */
 423         REQ_F_CQE32_INIT        = BIT(REQ_F_CQE32_INIT_BIT),
 424         /* recvmsg special flag, clear EPOLLIN */
 425         REQ_F_CLEAR_POLLIN      = BIT(REQ_F_CLEAR_POLLIN_BIT),
 426         /* hashed into ->cancel_hash_locked, protected by ->uring_lock */
 427         REQ_F_HASH_LOCKED       = BIT(REQ_F_HASH_LOCKED_BIT),
 428 };
 429
 430 typedef void (*io_req_tw_func_t)(struct io_kiocb *req, bool *locked);
 431
 432 struct io_task_work {
 433         struct llist_node               node;
 434         io_req_tw_func_t                func;
 435 };
 436
 437 struct io_cqe {
 438         __u64   user_data;
 439         __s32   res;
 440         /* fd initially, then cflags for completion */
 441         union {
 442                 __u32   flags;
 443                 int     fd;
 444         };
 445 };
 446
 447 /*
 448  * Each request type overlays its private data structure on top of this one.
 449  * They must not exceed this one in size.
 450  */
 451 struct io_cmd_data {
 452         struct file             *file;
 453         /* each command gets 56 bytes of data */
 454         __u8                    data[56];
 455 };
 456
 457 #define io_kiocb_to_cmd(req)    ((void *) &(req)->cmd)
 458 #define cmd_to_io_kiocb(ptr)    ((struct io_kiocb *) ptr)
 459
 460 struct io_kiocb {
 461         union {
 462                 /*
 463                  * NOTE! Each of the io_kiocb union members has the file pointer
 464                  * as the first entry in their struct definition. So you can
 465                  * access the file pointer through any of the sub-structs,
 466                  * or directly as just 'file' in this struct.
 467                  */
 468                 struct file             *file;
 469                 struct io_cmd_data      cmd;
 470         };
 471
 472         u8                              opcode;
 473         /* polled IO has completed */
 474         u8                              iopoll_completed;
 475         /*
 476          * Can be either a fixed buffer index, or used with provided buffers.
 477          * For the latter, before issue it points to the buffer group ID,
 478          * and after selection it points to the buffer ID itself.
 479          */
 480         u16                             buf_index;
 481         unsigned int                    flags;
 482
 483         struct io_cqe                   cqe;
 484
 485         struct io_ring_ctx              *ctx;
 486         struct task_struct              *task;
 487
 488         struct io_rsrc_node             *rsrc_node;
 489
 490         union {
 491                 /* store used ubuf, so we can prevent reloading */
 492                 struct io_mapped_ubuf   *imu;
 493
 494                 /* stores selected buf, valid IFF REQ_F_BUFFER_SELECTED is set */
 495                 struct io_buffer        *kbuf;
 496
 497                 /*
 498                  * stores buffer ID for ring provided buffers, valid IFF
 499                  * REQ_F_BUFFER_RING is set.
 500                  */
 501                 struct io_buffer_list   *buf_list;
 502         };
 503
 504         union {
 505                 /* used by request caches, completion batching and iopoll */
 506                 struct io_wq_work_node  comp_list;
 507                 /* cache ->apoll->events */
 508                 __poll_t apoll_events;
 509         };
 510         atomic_t                        refs;
 511         atomic_t                        poll_refs;
 512         struct io_task_work             io_task_work;
 513         /* for polled requests, i.e. IORING_OP_POLL_ADD and async armed poll */
 514         union {
 515                 struct hlist_node       hash_node;
 516                 struct {
 517                         u64             extra1;
 518                         u64             extra2;
 519                 };
 520         };
 521         /* internal polling, see IORING_FEAT_FAST_POLL */
 522         struct async_poll               *apoll;
 523         /* opcode allocated if it needs to store data for async defer */
 524         void                            *async_data;
 525         /* linked requests, IFF REQ_F_HARDLINK or REQ_F_LINK are set */
 526         struct io_kiocb                 *link;
 527         /* custom credentials, valid IFF REQ_F_CREDS is set */
 528         const struct cred               *creds;
 529         struct io_wq_work               work;
 530 };
 531
 532 struct io_overflow_cqe {
 533         struct list_head list;
 534         struct io_uring_cqe cqe;
 535 };
 536
 537 #endif