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         unsigned int            max_cached;
 194         size_t                  elem_size;
 195 };
 196
 197 struct io_ring_ctx {
 198         /* const or read-mostly hot data */
 199         struct {
 200                 unsigned int            flags;
 201                 unsigned int            drain_next: 1;
 202                 unsigned int            restricted: 1;
 203                 unsigned int            off_timeout_used: 1;
 204                 unsigned int            drain_active: 1;
 205                 unsigned int            has_evfd: 1;
 206                 /* all CQEs should be posted only by the submitter task */
 207                 unsigned int            task_complete: 1;
 208                 unsigned int            syscall_iopoll: 1;
 209                 unsigned int            poll_activated: 1;
 210                 unsigned int            drain_disabled: 1;
 211                 unsigned int            compat: 1;
 212
 213                 enum task_work_notify_mode      notify_method;
 214
 215                 /*
 216                  * If IORING_SETUP_NO_MMAP is used, then the below holds
 217                  * the gup'ed pages for the two rings, and the sqes.
 218                  */
 219                 unsigned short          n_ring_pages;
 220                 unsigned short          n_sqe_pages;
 221                 struct page             **ring_pages;
 222                 struct page             **sqe_pages;
 223
 224                 struct io_rings                 *rings;
 225                 struct task_struct              *submitter_task;
 226                 struct percpu_ref               refs;
 227         } ____cacheline_aligned_in_smp;
 228
 229         /* submission data */
 230         struct {
 231                 struct mutex            uring_lock;
 232
 233                 /*
 234                  * Ring buffer of indices into array of io_uring_sqe, which is
 235                  * mmapped by the application using the IORING_OFF_SQES offset.
 236                  *
 237                  * This indirection could e.g. be used to assign fixed
 238                  * io_uring_sqe entries to operations and only submit them to
 239                  * the queue when needed.
 240                  *
 241                  * The kernel modifies neither the indices array nor the entries
 242                  * array.
 243                  */
 244                 u32                     *sq_array;
 245                 struct io_uring_sqe     *sq_sqes;
 246                 unsigned                cached_sq_head;
 247                 unsigned                sq_entries;
 248
 249                 /*
 250                  * Fixed resources fast path, should be accessed only under
 251                  * uring_lock, and updated through io_uring_register(2)
 252                  */
 253                 struct io_rsrc_node     *rsrc_node;
 254                 atomic_t                cancel_seq;
 255                 struct io_file_table    file_table;
 256                 unsigned                nr_user_files;
 257                 unsigned                nr_user_bufs;
 258                 struct io_mapped_ubuf   **user_bufs;
 259
 260                 struct io_submit_state  submit_state;
 261
 262                 struct io_buffer_list   *io_bl;
 263                 struct xarray           io_bl_xa;
 264                 struct list_head        io_buffers_cache;
 265
 266                 struct io_hash_table    cancel_table_locked;
 267                 struct list_head        cq_overflow_list;
 268                 struct io_alloc_cache   apoll_cache;
 269                 struct io_alloc_cache   netmsg_cache;
 270         } ____cacheline_aligned_in_smp;
 271
 272         /* IRQ completion list, under ->completion_lock */
 273         struct io_wq_work_list  locked_free_list;
 274         unsigned int            locked_free_nr;
 275
 276         const struct cred       *sq_creds;      /* cred used for __io_sq_thread() */
 277         struct io_sq_data       *sq_data;       /* if using sq thread polling */
 278
 279         struct wait_queue_head  sqo_sq_wait;
 280         struct list_head        sqd_list;
 281
 282         unsigned long           check_cq;
 283
 284         unsigned int            file_alloc_start;
 285         unsigned int            file_alloc_end;
 286
 287         struct xarray           personalities;
 288         u32                     pers_next;
 289
 290         struct {
 291                 /*
 292                  * We cache a range of free CQEs we can use, once exhausted it
 293                  * should go through a slower range setup, see __io_get_cqe()
 294                  */
 295                 struct io_uring_cqe     *cqe_cached;
 296                 struct io_uring_cqe     *cqe_sentinel;
 297
 298                 unsigned                cached_cq_tail;
 299                 unsigned                cq_entries;
 300                 struct io_ev_fd __rcu   *io_ev_fd;
 301                 struct wait_queue_head  cq_wait;
 302                 unsigned                cq_extra;
 303         } ____cacheline_aligned_in_smp;
 304
 305         struct {
 306                 spinlock_t              completion_lock;
 307
 308                 bool                    poll_multi_queue;
 309                 atomic_t                cq_wait_nr;
 310
 311                 /*
 312                  * ->iopoll_list is protected by the ctx->uring_lock for
 313                  * io_uring instances that don't use IORING_SETUP_SQPOLL.
 314                  * For SQPOLL, only the single threaded io_sq_thread() will
 315                  * manipulate the list, hence no extra locking is needed there.
 316                  */
 317                 struct io_wq_work_list  iopoll_list;
 318                 struct io_hash_table    cancel_table;
 319
 320                 struct llist_head       work_llist;
 321
 322                 struct list_head        io_buffers_comp;
 323         } ____cacheline_aligned_in_smp;
 324
 325         /* timeouts */
 326         struct {
 327                 spinlock_t              timeout_lock;
 328                 atomic_t                cq_timeouts;
 329                 struct list_head        timeout_list;
 330                 struct list_head        ltimeout_list;
 331                 unsigned                cq_last_tm_flush;
 332         } ____cacheline_aligned_in_smp;
 333
 334         /* Keep this last, we don't need it for the fast path */
 335         struct wait_queue_head          poll_wq;
 336         struct io_restriction           restrictions;
 337
 338         /* slow path rsrc auxilary data, used by update/register */
 339         struct io_mapped_ubuf           *dummy_ubuf;
 340         struct io_rsrc_data             *file_data;
 341         struct io_rsrc_data             *buf_data;
 342
 343         /* protected by ->uring_lock */
 344         struct list_head                rsrc_ref_list;
 345         struct io_alloc_cache           rsrc_node_cache;
 346         struct wait_queue_head          rsrc_quiesce_wq;
 347         unsigned                        rsrc_quiesce;
 348
 349         struct list_head                io_buffers_pages;
 350
 351         #if defined(CONFIG_UNIX)
 352                 struct socket           *ring_sock;
 353         #endif
 354         /* hashed buffered write serialization */
 355         struct io_wq_hash               *hash_map;
 356
 357         /* Only used for accounting purposes */
 358         struct user_struct              *user;
 359         struct mm_struct                *mm_account;
 360
 361         /* ctx exit and cancelation */
 362         struct llist_head               fallback_llist;
 363         struct delayed_work             fallback_work;
 364         struct work_struct              exit_work;
 365         struct list_head                tctx_list;
 366         struct completion               ref_comp;
 367
 368         /* io-wq management, e.g. thread count */
 369         u32                             iowq_limits[2];
 370         bool                            iowq_limits_set;
 371
 372         struct callback_head            poll_wq_task_work;
 373         struct list_head                defer_list;
 374         unsigned                        sq_thread_idle;
 375         /* protected by ->completion_lock */
 376         unsigned                        evfd_last_cq_tail;
 377 };
 378
 379 struct io_tw_state {
 380         /* ->uring_lock is taken, callbacks can use io_tw_lock to lock it */
 381         bool locked;
 382 };
 383
 384 enum {
 385         REQ_F_FIXED_FILE_BIT    = IOSQE_FIXED_FILE_BIT,
 386         REQ_F_IO_DRAIN_BIT      = IOSQE_IO_DRAIN_BIT,
 387         REQ_F_LINK_BIT          = IOSQE_IO_LINK_BIT,
 388         REQ_F_HARDLINK_BIT      = IOSQE_IO_HARDLINK_BIT,
 389         REQ_F_FORCE_ASYNC_BIT   = IOSQE_ASYNC_BIT,
 390         REQ_F_BUFFER_SELECT_BIT = IOSQE_BUFFER_SELECT_BIT,
 391         REQ_F_CQE_SKIP_BIT      = IOSQE_CQE_SKIP_SUCCESS_BIT,
 392
 393         /* first byte is taken by user flags, shift it to not overlap */
 394         REQ_F_FAIL_BIT          = 8,
 395         REQ_F_INFLIGHT_BIT,
 396         REQ_F_CUR_POS_BIT,
 397         REQ_F_NOWAIT_BIT,
 398         REQ_F_LINK_TIMEOUT_BIT,
 399         REQ_F_NEED_CLEANUP_BIT,
 400         REQ_F_POLLED_BIT,
 401         REQ_F_BUFFER_SELECTED_BIT,
 402         REQ_F_BUFFER_RING_BIT,
 403         REQ_F_REISSUE_BIT,
 404         REQ_F_CREDS_BIT,
 405         REQ_F_REFCOUNT_BIT,
 406         REQ_F_ARM_LTIMEOUT_BIT,
 407         REQ_F_ASYNC_DATA_BIT,
 408         REQ_F_SKIP_LINK_CQES_BIT,
 409         REQ_F_SINGLE_POLL_BIT,
 410         REQ_F_DOUBLE_POLL_BIT,
 411         REQ_F_PARTIAL_IO_BIT,
 412         REQ_F_CQE32_INIT_BIT,
 413         REQ_F_APOLL_MULTISHOT_BIT,
 414         REQ_F_CLEAR_POLLIN_BIT,
 415         REQ_F_HASH_LOCKED_BIT,
 416         /* keep async read/write and isreg together and in order */
 417         REQ_F_SUPPORT_NOWAIT_BIT,
 418         REQ_F_ISREG_BIT,
 419
 420         /* not a real bit, just to check we're not overflowing the space */
 421         __REQ_F_LAST_BIT,
 422 };
 423
 424 enum {
 425         /* ctx owns file */
 426         REQ_F_FIXED_FILE        = BIT(REQ_F_FIXED_FILE_BIT),
 427         /* drain existing IO first */
 428         REQ_F_IO_DRAIN          = BIT(REQ_F_IO_DRAIN_BIT),
 429         /* linked sqes */
 430         REQ_F_LINK              = BIT(REQ_F_LINK_BIT),
 431         /* doesn't sever on completion < 0 */
 432         REQ_F_HARDLINK          = BIT(REQ_F_HARDLINK_BIT),
 433         /* IOSQE_ASYNC */
 434         REQ_F_FORCE_ASYNC       = BIT(REQ_F_FORCE_ASYNC_BIT),
 435         /* IOSQE_BUFFER_SELECT */
 436         REQ_F_BUFFER_SELECT     = BIT(REQ_F_BUFFER_SELECT_BIT),
 437         /* IOSQE_CQE_SKIP_SUCCESS */
 438         REQ_F_CQE_SKIP          = BIT(REQ_F_CQE_SKIP_BIT),
 439
 440         /* fail rest of links */
 441         REQ_F_FAIL              = BIT(REQ_F_FAIL_BIT),
 442         /* on inflight list, should be cancelled and waited on exit reliably */
 443         REQ_F_INFLIGHT          = BIT(REQ_F_INFLIGHT_BIT),
 444         /* read/write uses file position */
 445         REQ_F_CUR_POS           = BIT(REQ_F_CUR_POS_BIT),
 446         /* must not punt to workers */
 447         REQ_F_NOWAIT            = BIT(REQ_F_NOWAIT_BIT),
 448         /* has or had linked timeout */
 449         REQ_F_LINK_TIMEOUT      = BIT(REQ_F_LINK_TIMEOUT_BIT),
 450         /* needs cleanup */
 451         REQ_F_NEED_CLEANUP      = BIT(REQ_F_NEED_CLEANUP_BIT),
 452         /* already went through poll handler */
 453         REQ_F_POLLED            = BIT(REQ_F_POLLED_BIT),
 454         /* buffer already selected */
 455         REQ_F_BUFFER_SELECTED   = BIT(REQ_F_BUFFER_SELECTED_BIT),
 456         /* buffer selected from ring, needs commit */
 457         REQ_F_BUFFER_RING       = BIT(REQ_F_BUFFER_RING_BIT),
 458         /* caller should reissue async */
 459         REQ_F_REISSUE           = BIT(REQ_F_REISSUE_BIT),
 460         /* supports async reads/writes */
 461         REQ_F_SUPPORT_NOWAIT    = BIT(REQ_F_SUPPORT_NOWAIT_BIT),
 462         /* regular file */
 463         REQ_F_ISREG             = BIT(REQ_F_ISREG_BIT),
 464         /* has creds assigned */
 465         REQ_F_CREDS             = BIT(REQ_F_CREDS_BIT),
 466         /* skip refcounting if not set */
 467         REQ_F_REFCOUNT          = BIT(REQ_F_REFCOUNT_BIT),
 468         /* there is a linked timeout that has to be armed */
 469         REQ_F_ARM_LTIMEOUT      = BIT(REQ_F_ARM_LTIMEOUT_BIT),
 470         /* ->async_data allocated */
 471         REQ_F_ASYNC_DATA        = BIT(REQ_F_ASYNC_DATA_BIT),
 472         /* don't post CQEs while failing linked requests */
 473         REQ_F_SKIP_LINK_CQES    = BIT(REQ_F_SKIP_LINK_CQES_BIT),
 474         /* single poll may be active */
 475         REQ_F_SINGLE_POLL       = BIT(REQ_F_SINGLE_POLL_BIT),
 476         /* double poll may active */
 477         REQ_F_DOUBLE_POLL       = BIT(REQ_F_DOUBLE_POLL_BIT),
 478         /* request has already done partial IO */
 479         REQ_F_PARTIAL_IO        = BIT(REQ_F_PARTIAL_IO_BIT),
 480         /* fast poll multishot mode */
 481         REQ_F_APOLL_MULTISHOT   = BIT(REQ_F_APOLL_MULTISHOT_BIT),
 482         /* ->extra1 and ->extra2 are initialised */
 483         REQ_F_CQE32_INIT        = BIT(REQ_F_CQE32_INIT_BIT),
 484         /* recvmsg special flag, clear EPOLLIN */
 485         REQ_F_CLEAR_POLLIN      = BIT(REQ_F_CLEAR_POLLIN_BIT),
 486         /* hashed into ->cancel_hash_locked, protected by ->uring_lock */
 487         REQ_F_HASH_LOCKED       = BIT(REQ_F_HASH_LOCKED_BIT),
 488 };
 489
 490 typedef void (*io_req_tw_func_t)(struct io_kiocb *req, struct io_tw_state *ts);
 491
 492 struct io_task_work {
 493         struct llist_node               node;
 494         io_req_tw_func_t                func;
 495 };
 496
 497 struct io_cqe {
 498         __u64   user_data;
 499         __s32   res;
 500         /* fd initially, then cflags for completion */
 501         union {
 502                 __u32   flags;
 503                 int     fd;
 504         };
 505 };
 506
 507 /*
 508  * Each request type overlays its private data structure on top of this one.
 509  * They must not exceed this one in size.
 510  */
 511 struct io_cmd_data {
 512         struct file             *file;
 513         /* each command gets 56 bytes of data */
 514         __u8                    data[56];
 515 };
 516
 517 static inline void io_kiocb_cmd_sz_check(size_t cmd_sz)
 518 {
 519         BUILD_BUG_ON(cmd_sz > sizeof(struct io_cmd_data));
 520 }
 521 #define io_kiocb_to_cmd(req, cmd_type) ( \
 522         io_kiocb_cmd_sz_check(sizeof(cmd_type)) , \
 523         ((cmd_type *)&(req)->cmd) \
 524 )
 525 #define cmd_to_io_kiocb(ptr)    ((struct io_kiocb *) ptr)
 526
 527 struct io_kiocb {
 528         union {
 529                 /*
 530                  * NOTE! Each of the io_kiocb union members has the file pointer
 531                  * as the first entry in their struct definition. So you can
 532                  * access the file pointer through any of the sub-structs,
 533                  * or directly as just 'file' in this struct.
 534                  */
 535                 struct file             *file;
 536                 struct io_cmd_data      cmd;
 537         };
 538
 539         u8                              opcode;
 540         /* polled IO has completed */
 541         u8                              iopoll_completed;
 542         /*
 543          * Can be either a fixed buffer index, or used with provided buffers.
 544          * For the latter, before issue it points to the buffer group ID,
 545          * and after selection it points to the buffer ID itself.
 546          */
 547         u16                             buf_index;
 548         unsigned int                    flags;
 549
 550         struct io_cqe                   cqe;
 551
 552         struct io_ring_ctx              *ctx;
 553         struct task_struct              *task;
 554
 555         struct io_rsrc_node             *rsrc_node;
 556
 557         union {
 558                 /* store used ubuf, so we can prevent reloading */
 559                 struct io_mapped_ubuf   *imu;
 560
 561                 /* stores selected buf, valid IFF REQ_F_BUFFER_SELECTED is set */
 562                 struct io_buffer        *kbuf;
 563
 564                 /*
 565                  * stores buffer ID for ring provided buffers, valid IFF
 566                  * REQ_F_BUFFER_RING is set.
 567                  */
 568                 struct io_buffer_list   *buf_list;
 569         };
 570
 571         union {
 572                 /* used by request caches, completion batching and iopoll */
 573                 struct io_wq_work_node  comp_list;
 574                 /* cache ->apoll->events */
 575                 __poll_t apoll_events;
 576         };
 577         atomic_t                        refs;
 578         atomic_t                        poll_refs;
 579         struct io_task_work             io_task_work;
 580         unsigned                        nr_tw;
 581         /* for polled requests, i.e. IORING_OP_POLL_ADD and async armed poll */
 582         union {
 583                 struct hlist_node       hash_node;
 584                 struct {
 585                         u64             extra1;
 586                         u64             extra2;
 587                 };
 588         };
 589         /* internal polling, see IORING_FEAT_FAST_POLL */
 590         struct async_poll               *apoll;
 591         /* opcode allocated if it needs to store data for async defer */
 592         void                            *async_data;
 593         /* linked requests, IFF REQ_F_HARDLINK or REQ_F_LINK are set */
 594         struct io_kiocb                 *link;
 595         /* custom credentials, valid IFF REQ_F_CREDS is set */
 596         const struct cred               *creds;
 597         struct io_wq_work               work;
 598 };
 599
 600 struct io_overflow_cqe {
 601         struct list_head list;
 602         struct io_uring_cqe cqe;
 603 };
 604
 605 #endif