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