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