1 #ifndef IO_URING_TYPES_H
2 #define IO_URING_TYPES_H
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>
10 struct io_wq_work_node {
11 struct io_wq_work_node *next;
14 struct io_wq_work_list {
15 struct io_wq_work_node *first;
16 struct io_wq_work_node *last;
20 struct io_wq_work_node list;
22 /* place it here instead of io_kiocb as it fills padding and saves 4B */
26 struct io_fixed_file {
27 /* file * with additional FFS_* flags */
28 unsigned long file_ptr;
31 struct io_file_table {
32 struct io_fixed_file *files;
33 unsigned long *bitmap;
34 unsigned int alloc_hint;
37 struct io_hash_bucket {
39 struct hlist_head list;
40 } ____cacheline_aligned_in_smp;
42 struct io_hash_table {
43 struct io_hash_bucket *hbs;
48 * Arbitrary limit, can be raised if need be
50 #define IO_RINGFD_REG_MAX 16
52 struct io_uring_task {
55 const struct io_ring_ctx *last;
57 struct file *registered_rings[IO_RINGFD_REG_MAX];
60 struct wait_queue_head wait;
62 atomic_t inflight_tracked;
63 struct percpu_counter inflight;
65 struct { /* task_work */
66 struct llist_head task_list;
67 struct callback_head task_work;
68 } ____cacheline_aligned_in_smp;
72 u32 head ____cacheline_aligned_in_smp;
73 u32 tail ____cacheline_aligned_in_smp;
77 * This data is shared with the application through the mmap at offsets
78 * IORING_OFF_SQ_RING and IORING_OFF_CQ_RING.
80 * The offsets to the member fields are published through struct
81 * io_sqring_offsets when calling io_uring_setup.
85 * Head and tail offsets into the ring; the offsets need to be
86 * masked to get valid indices.
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
92 struct io_uring sq, cq;
94 * Bitmasks to apply to head and tail offsets (constant, equals
97 u32 sq_ring_mask, cq_ring_mask;
98 /* Ring sizes (constant, power of 2) */
99 u32 sq_ring_entries, cq_ring_entries;
101 * Number of invalid entries dropped by the kernel due to
102 * invalid index stored in array
104 * Written by the kernel, shouldn't be modified by the
105 * application (i.e. get number of "new events" by comparing to
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).
116 * Written by the kernel, shouldn't be modified by the
119 * The application needs a full memory barrier before checking
120 * for IORING_SQ_NEED_WAKEUP after updating the sq tail.
126 * Written by the application, shouldn't be modified by the
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.
136 * Written by the kernel, shouldn't be modified by the
137 * application (i.e. get number of "new events" by comparing to
140 * As completion events come in out of order this counter is not
141 * ordered with any other data.
145 * Ring buffer of completion events.
147 * The kernel writes completion events fresh every time they are
148 * produced, so the application is allowed to modify pending
151 struct io_uring_cqe cqes[] ____cacheline_aligned_in_smp;
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;
162 struct io_submit_link {
163 struct io_kiocb *head;
164 struct io_kiocb *last;
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;
176 unsigned short submit_nr;
177 unsigned int cqes_count;
178 struct blk_plug plug;
179 struct io_uring_cqe cqes[16];
183 struct eventfd_ctx *cq_ev_fd;
184 unsigned int eventfd_async: 1;
190 struct io_alloc_cache {
191 struct hlist_head list;
192 unsigned int nr_cached;
196 /* const or read-mostly hot data */
198 struct percpu_ref refs;
200 struct io_rings *rings;
202 enum task_work_notify_mode notify_method;
203 unsigned int compat: 1;
204 unsigned int drain_next: 1;
205 unsigned int restricted: 1;
206 unsigned int off_timeout_used: 1;
207 unsigned int drain_active: 1;
208 unsigned int drain_disabled: 1;
209 unsigned int has_evfd: 1;
210 unsigned int syscall_iopoll: 1;
211 /* all CQEs should be posted only by the submitter task */
212 unsigned int task_complete: 1;
213 } ____cacheline_aligned_in_smp;
215 /* submission data */
217 struct mutex uring_lock;
220 * Ring buffer of indices into array of io_uring_sqe, which is
221 * mmapped by the application using the IORING_OFF_SQES offset.
223 * This indirection could e.g. be used to assign fixed
224 * io_uring_sqe entries to operations and only submit them to
225 * the queue when needed.
227 * The kernel modifies neither the indices array nor the entries
231 struct io_uring_sqe *sq_sqes;
232 unsigned cached_sq_head;
236 * Fixed resources fast path, should be accessed only under
237 * uring_lock, and updated through io_uring_register(2)
239 struct io_rsrc_node *rsrc_node;
240 int rsrc_cached_refs;
242 struct io_file_table file_table;
243 unsigned nr_user_files;
244 unsigned nr_user_bufs;
245 struct io_mapped_ubuf **user_bufs;
247 struct io_submit_state submit_state;
249 struct io_buffer_list *io_bl;
250 struct xarray io_bl_xa;
251 struct list_head io_buffers_cache;
253 struct io_hash_table cancel_table_locked;
254 struct list_head cq_overflow_list;
255 struct io_alloc_cache apoll_cache;
256 struct io_alloc_cache netmsg_cache;
257 } ____cacheline_aligned_in_smp;
259 /* IRQ completion list, under ->completion_lock */
260 struct io_wq_work_list locked_free_list;
261 unsigned int locked_free_nr;
263 const struct cred *sq_creds; /* cred used for __io_sq_thread() */
264 struct io_sq_data *sq_data; /* if using sq thread polling */
266 struct wait_queue_head sqo_sq_wait;
267 struct list_head sqd_list;
269 unsigned long check_cq;
271 unsigned int file_alloc_start;
272 unsigned int file_alloc_end;
274 struct xarray personalities;
279 * We cache a range of free CQEs we can use, once exhausted it
280 * should go through a slower range setup, see __io_get_cqe()
282 struct io_uring_cqe *cqe_cached;
283 struct io_uring_cqe *cqe_sentinel;
285 unsigned cached_cq_tail;
287 struct io_ev_fd __rcu *io_ev_fd;
288 struct wait_queue_head cq_wait;
290 } ____cacheline_aligned_in_smp;
293 spinlock_t completion_lock;
295 bool poll_multi_queue;
298 * ->iopoll_list is protected by the ctx->uring_lock for
299 * io_uring instances that don't use IORING_SETUP_SQPOLL.
300 * For SQPOLL, only the single threaded io_sq_thread() will
301 * manipulate the list, hence no extra locking is needed there.
303 struct io_wq_work_list iopoll_list;
304 struct io_hash_table cancel_table;
306 struct llist_head work_llist;
308 struct list_head io_buffers_comp;
309 } ____cacheline_aligned_in_smp;
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;
320 /* Keep this last, we don't need it for the fast path */
322 struct io_restriction restrictions;
323 struct task_struct *submitter_task;
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;
331 struct delayed_work rsrc_put_work;
332 struct callback_head rsrc_put_tw;
333 struct llist_head rsrc_put_llist;
334 struct list_head rsrc_ref_list;
335 spinlock_t rsrc_ref_lock;
337 struct list_head io_buffers_pages;
339 #if defined(CONFIG_UNIX)
340 struct socket *ring_sock;
342 /* hashed buffered write serialization */
343 struct io_wq_hash *hash_map;
345 /* Only used for accounting purposes */
346 struct user_struct *user;
347 struct mm_struct *mm_account;
349 /* ctx exit and cancelation */
350 struct llist_head fallback_llist;
351 struct delayed_work fallback_work;
352 struct work_struct exit_work;
353 struct list_head tctx_list;
354 struct completion ref_comp;
356 /* io-wq management, e.g. thread count */
358 bool iowq_limits_set;
360 struct list_head defer_list;
361 unsigned sq_thread_idle;
362 /* protected by ->completion_lock */
363 unsigned evfd_last_cq_tail;
367 REQ_F_FIXED_FILE_BIT = IOSQE_FIXED_FILE_BIT,
368 REQ_F_IO_DRAIN_BIT = IOSQE_IO_DRAIN_BIT,
369 REQ_F_LINK_BIT = IOSQE_IO_LINK_BIT,
370 REQ_F_HARDLINK_BIT = IOSQE_IO_HARDLINK_BIT,
371 REQ_F_FORCE_ASYNC_BIT = IOSQE_ASYNC_BIT,
372 REQ_F_BUFFER_SELECT_BIT = IOSQE_BUFFER_SELECT_BIT,
373 REQ_F_CQE_SKIP_BIT = IOSQE_CQE_SKIP_SUCCESS_BIT,
375 /* first byte is taken by user flags, shift it to not overlap */
380 REQ_F_LINK_TIMEOUT_BIT,
381 REQ_F_NEED_CLEANUP_BIT,
383 REQ_F_BUFFER_SELECTED_BIT,
384 REQ_F_BUFFER_RING_BIT,
388 REQ_F_ARM_LTIMEOUT_BIT,
389 REQ_F_ASYNC_DATA_BIT,
390 REQ_F_SKIP_LINK_CQES_BIT,
391 REQ_F_SINGLE_POLL_BIT,
392 REQ_F_DOUBLE_POLL_BIT,
393 REQ_F_PARTIAL_IO_BIT,
394 REQ_F_CQE32_INIT_BIT,
395 REQ_F_APOLL_MULTISHOT_BIT,
396 REQ_F_CLEAR_POLLIN_BIT,
397 REQ_F_HASH_LOCKED_BIT,
398 /* keep async read/write and isreg together and in order */
399 REQ_F_SUPPORT_NOWAIT_BIT,
402 /* not a real bit, just to check we're not overflowing the space */
408 REQ_F_FIXED_FILE = BIT(REQ_F_FIXED_FILE_BIT),
409 /* drain existing IO first */
410 REQ_F_IO_DRAIN = BIT(REQ_F_IO_DRAIN_BIT),
412 REQ_F_LINK = BIT(REQ_F_LINK_BIT),
413 /* doesn't sever on completion < 0 */
414 REQ_F_HARDLINK = BIT(REQ_F_HARDLINK_BIT),
416 REQ_F_FORCE_ASYNC = BIT(REQ_F_FORCE_ASYNC_BIT),
417 /* IOSQE_BUFFER_SELECT */
418 REQ_F_BUFFER_SELECT = BIT(REQ_F_BUFFER_SELECT_BIT),
419 /* IOSQE_CQE_SKIP_SUCCESS */
420 REQ_F_CQE_SKIP = BIT(REQ_F_CQE_SKIP_BIT),
422 /* fail rest of links */
423 REQ_F_FAIL = BIT(REQ_F_FAIL_BIT),
424 /* on inflight list, should be cancelled and waited on exit reliably */
425 REQ_F_INFLIGHT = BIT(REQ_F_INFLIGHT_BIT),
426 /* read/write uses file position */
427 REQ_F_CUR_POS = BIT(REQ_F_CUR_POS_BIT),
428 /* must not punt to workers */
429 REQ_F_NOWAIT = BIT(REQ_F_NOWAIT_BIT),
430 /* has or had linked timeout */
431 REQ_F_LINK_TIMEOUT = BIT(REQ_F_LINK_TIMEOUT_BIT),
433 REQ_F_NEED_CLEANUP = BIT(REQ_F_NEED_CLEANUP_BIT),
434 /* already went through poll handler */
435 REQ_F_POLLED = BIT(REQ_F_POLLED_BIT),
436 /* buffer already selected */
437 REQ_F_BUFFER_SELECTED = BIT(REQ_F_BUFFER_SELECTED_BIT),
438 /* buffer selected from ring, needs commit */
439 REQ_F_BUFFER_RING = BIT(REQ_F_BUFFER_RING_BIT),
440 /* caller should reissue async */
441 REQ_F_REISSUE = BIT(REQ_F_REISSUE_BIT),
442 /* supports async reads/writes */
443 REQ_F_SUPPORT_NOWAIT = BIT(REQ_F_SUPPORT_NOWAIT_BIT),
445 REQ_F_ISREG = BIT(REQ_F_ISREG_BIT),
446 /* has creds assigned */
447 REQ_F_CREDS = BIT(REQ_F_CREDS_BIT),
448 /* skip refcounting if not set */
449 REQ_F_REFCOUNT = BIT(REQ_F_REFCOUNT_BIT),
450 /* there is a linked timeout that has to be armed */
451 REQ_F_ARM_LTIMEOUT = BIT(REQ_F_ARM_LTIMEOUT_BIT),
452 /* ->async_data allocated */
453 REQ_F_ASYNC_DATA = BIT(REQ_F_ASYNC_DATA_BIT),
454 /* don't post CQEs while failing linked requests */
455 REQ_F_SKIP_LINK_CQES = BIT(REQ_F_SKIP_LINK_CQES_BIT),
456 /* single poll may be active */
457 REQ_F_SINGLE_POLL = BIT(REQ_F_SINGLE_POLL_BIT),
458 /* double poll may active */
459 REQ_F_DOUBLE_POLL = BIT(REQ_F_DOUBLE_POLL_BIT),
460 /* request has already done partial IO */
461 REQ_F_PARTIAL_IO = BIT(REQ_F_PARTIAL_IO_BIT),
462 /* fast poll multishot mode */
463 REQ_F_APOLL_MULTISHOT = BIT(REQ_F_APOLL_MULTISHOT_BIT),
464 /* ->extra1 and ->extra2 are initialised */
465 REQ_F_CQE32_INIT = BIT(REQ_F_CQE32_INIT_BIT),
466 /* recvmsg special flag, clear EPOLLIN */
467 REQ_F_CLEAR_POLLIN = BIT(REQ_F_CLEAR_POLLIN_BIT),
468 /* hashed into ->cancel_hash_locked, protected by ->uring_lock */
469 REQ_F_HASH_LOCKED = BIT(REQ_F_HASH_LOCKED_BIT),
472 typedef void (*io_req_tw_func_t)(struct io_kiocb *req, bool *locked);
474 struct io_task_work {
475 struct llist_node node;
476 io_req_tw_func_t func;
482 /* fd initially, then cflags for completion */
490 * Each request type overlays its private data structure on top of this one.
491 * They must not exceed this one in size.
495 /* each command gets 56 bytes of data */
499 static inline void io_kiocb_cmd_sz_check(size_t cmd_sz)
501 BUILD_BUG_ON(cmd_sz > sizeof(struct io_cmd_data));
503 #define io_kiocb_to_cmd(req, cmd_type) ( \
504 io_kiocb_cmd_sz_check(sizeof(cmd_type)) , \
505 ((cmd_type *)&(req)->cmd) \
507 #define cmd_to_io_kiocb(ptr) ((struct io_kiocb *) ptr)
512 * NOTE! Each of the io_kiocb union members has the file pointer
513 * as the first entry in their struct definition. So you can
514 * access the file pointer through any of the sub-structs,
515 * or directly as just 'file' in this struct.
518 struct io_cmd_data cmd;
522 /* polled IO has completed */
525 * Can be either a fixed buffer index, or used with provided buffers.
526 * For the latter, before issue it points to the buffer group ID,
527 * and after selection it points to the buffer ID itself.
534 struct io_ring_ctx *ctx;
535 struct task_struct *task;
537 struct io_rsrc_node *rsrc_node;
540 /* store used ubuf, so we can prevent reloading */
541 struct io_mapped_ubuf *imu;
543 /* stores selected buf, valid IFF REQ_F_BUFFER_SELECTED is set */
544 struct io_buffer *kbuf;
547 * stores buffer ID for ring provided buffers, valid IFF
548 * REQ_F_BUFFER_RING is set.
550 struct io_buffer_list *buf_list;
554 /* used by request caches, completion batching and iopoll */
555 struct io_wq_work_node comp_list;
556 /* cache ->apoll->events */
557 __poll_t apoll_events;
561 struct io_task_work io_task_work;
562 /* for polled requests, i.e. IORING_OP_POLL_ADD and async armed poll */
564 struct hlist_node hash_node;
570 /* internal polling, see IORING_FEAT_FAST_POLL */
571 struct async_poll *apoll;
572 /* opcode allocated if it needs to store data for async defer */
574 /* linked requests, IFF REQ_F_HARDLINK or REQ_F_LINK are set */
575 struct io_kiocb *link;
576 /* custom credentials, valid IFF REQ_F_CREDS is set */
577 const struct cred *creds;
578 struct io_wq_work work;
581 struct io_overflow_cqe {
582 struct list_head list;
583 struct io_uring_cqe cqe;