2cbf33996c3b77f23f11fc3f1ea9260a0c7dc214
[linux-block.git] / io_uring / io_uring.c
1 // SPDX-License-Identifier: GPL-2.0
2 /*
3  * Shared application/kernel submission and completion ring pairs, for
4  * supporting fast/efficient IO.
5  *
6  * A note on the read/write ordering memory barriers that are matched between
7  * the application and kernel side.
8  *
9  * After the application reads the CQ ring tail, it must use an
10  * appropriate smp_rmb() to pair with the smp_wmb() the kernel uses
11  * before writing the tail (using smp_load_acquire to read the tail will
12  * do). It also needs a smp_mb() before updating CQ head (ordering the
13  * entry load(s) with the head store), pairing with an implicit barrier
14  * through a control-dependency in io_get_cqe (smp_store_release to
15  * store head will do). Failure to do so could lead to reading invalid
16  * CQ entries.
17  *
18  * Likewise, the application must use an appropriate smp_wmb() before
19  * writing the SQ tail (ordering SQ entry stores with the tail store),
20  * which pairs with smp_load_acquire in io_get_sqring (smp_store_release
21  * to store the tail will do). And it needs a barrier ordering the SQ
22  * head load before writing new SQ entries (smp_load_acquire to read
23  * head will do).
24  *
25  * When using the SQ poll thread (IORING_SETUP_SQPOLL), the application
26  * needs to check the SQ flags for IORING_SQ_NEED_WAKEUP *after*
27  * updating the SQ tail; a full memory barrier smp_mb() is needed
28  * between.
29  *
30  * Also see the examples in the liburing library:
31  *
32  *      git://git.kernel.dk/liburing
33  *
34  * io_uring also uses READ/WRITE_ONCE() for _any_ store or load that happens
35  * from data shared between the kernel and application. This is done both
36  * for ordering purposes, but also to ensure that once a value is loaded from
37  * data that the application could potentially modify, it remains stable.
38  *
39  * Copyright (C) 2018-2019 Jens Axboe
40  * Copyright (c) 2018-2019 Christoph Hellwig
41  */
42 #include <linux/kernel.h>
43 #include <linux/init.h>
44 #include <linux/errno.h>
45 #include <linux/syscalls.h>
46 #include <net/compat.h>
47 #include <linux/refcount.h>
48 #include <linux/uio.h>
49 #include <linux/bits.h>
50
51 #include <linux/sched/signal.h>
52 #include <linux/fs.h>
53 #include <linux/file.h>
54 #include <linux/fdtable.h>
55 #include <linux/mm.h>
56 #include <linux/mman.h>
57 #include <linux/percpu.h>
58 #include <linux/slab.h>
59 #include <linux/bvec.h>
60 #include <linux/net.h>
61 #include <net/sock.h>
62 #include <net/af_unix.h>
63 #include <net/scm.h>
64 #include <linux/anon_inodes.h>
65 #include <linux/sched/mm.h>
66 #include <linux/uaccess.h>
67 #include <linux/nospec.h>
68 #include <linux/highmem.h>
69 #include <linux/fsnotify.h>
70 #include <linux/fadvise.h>
71 #include <linux/task_work.h>
72 #include <linux/io_uring.h>
73 #include <linux/audit.h>
74 #include <linux/security.h>
75
76 #define CREATE_TRACE_POINTS
77 #include <trace/events/io_uring.h>
78
79 #include <uapi/linux/io_uring.h>
80
81 #include "io-wq.h"
82
83 #include "io_uring.h"
84 #include "opdef.h"
85 #include "refs.h"
86 #include "tctx.h"
87 #include "sqpoll.h"
88 #include "fdinfo.h"
89 #include "kbuf.h"
90 #include "rsrc.h"
91 #include "cancel.h"
92 #include "net.h"
93 #include "notif.h"
94
95 #include "timeout.h"
96 #include "poll.h"
97 #include "alloc_cache.h"
98
99 #define IORING_MAX_ENTRIES      32768
100 #define IORING_MAX_CQ_ENTRIES   (2 * IORING_MAX_ENTRIES)
101
102 #define IORING_MAX_RESTRICTIONS (IORING_RESTRICTION_LAST + \
103                                  IORING_REGISTER_LAST + IORING_OP_LAST)
104
105 #define SQE_COMMON_FLAGS (IOSQE_FIXED_FILE | IOSQE_IO_LINK | \
106                           IOSQE_IO_HARDLINK | IOSQE_ASYNC)
107
108 #define SQE_VALID_FLAGS (SQE_COMMON_FLAGS | IOSQE_BUFFER_SELECT | \
109                         IOSQE_IO_DRAIN | IOSQE_CQE_SKIP_SUCCESS)
110
111 #define IO_REQ_CLEAN_FLAGS (REQ_F_BUFFER_SELECTED | REQ_F_NEED_CLEANUP | \
112                                 REQ_F_POLLED | REQ_F_INFLIGHT | REQ_F_CREDS | \
113                                 REQ_F_ASYNC_DATA)
114
115 #define IO_REQ_CLEAN_SLOW_FLAGS (REQ_F_REFCOUNT | REQ_F_LINK | REQ_F_HARDLINK |\
116                                  IO_REQ_CLEAN_FLAGS)
117
118 #define IO_TCTX_REFS_CACHE_NR   (1U << 10)
119
120 #define IO_COMPL_BATCH                  32
121 #define IO_REQ_ALLOC_BATCH              8
122
123 enum {
124         IO_CHECK_CQ_OVERFLOW_BIT,
125         IO_CHECK_CQ_DROPPED_BIT,
126 };
127
128 enum {
129         IO_EVENTFD_OP_SIGNAL_BIT,
130         IO_EVENTFD_OP_FREE_BIT,
131 };
132
133 struct io_defer_entry {
134         struct list_head        list;
135         struct io_kiocb         *req;
136         u32                     seq;
137 };
138
139 /* requests with any of those set should undergo io_disarm_next() */
140 #define IO_DISARM_MASK (REQ_F_ARM_LTIMEOUT | REQ_F_LINK_TIMEOUT | REQ_F_FAIL)
141 #define IO_REQ_LINK_FLAGS (REQ_F_LINK | REQ_F_HARDLINK)
142
143 static bool io_uring_try_cancel_requests(struct io_ring_ctx *ctx,
144                                          struct task_struct *task,
145                                          bool cancel_all);
146
147 static void io_dismantle_req(struct io_kiocb *req);
148 static void io_clean_op(struct io_kiocb *req);
149 static void io_queue_sqe(struct io_kiocb *req);
150 static void io_move_task_work_from_local(struct io_ring_ctx *ctx);
151 static void __io_submit_flush_completions(struct io_ring_ctx *ctx);
152 static __cold void io_fallback_tw(struct io_uring_task *tctx);
153
154 static struct kmem_cache *req_cachep;
155
156 struct sock *io_uring_get_socket(struct file *file)
157 {
158 #if defined(CONFIG_UNIX)
159         if (io_is_uring_fops(file)) {
160                 struct io_ring_ctx *ctx = file->private_data;
161
162                 return ctx->ring_sock->sk;
163         }
164 #endif
165         return NULL;
166 }
167 EXPORT_SYMBOL(io_uring_get_socket);
168
169 static inline void io_submit_flush_completions(struct io_ring_ctx *ctx)
170 {
171         if (!wq_list_empty(&ctx->submit_state.compl_reqs) ||
172             ctx->submit_state.cqes_count)
173                 __io_submit_flush_completions(ctx);
174 }
175
176 static inline unsigned int __io_cqring_events(struct io_ring_ctx *ctx)
177 {
178         return ctx->cached_cq_tail - READ_ONCE(ctx->rings->cq.head);
179 }
180
181 static inline unsigned int __io_cqring_events_user(struct io_ring_ctx *ctx)
182 {
183         return READ_ONCE(ctx->rings->cq.tail) - READ_ONCE(ctx->rings->cq.head);
184 }
185
186 static bool io_match_linked(struct io_kiocb *head)
187 {
188         struct io_kiocb *req;
189
190         io_for_each_link(req, head) {
191                 if (req->flags & REQ_F_INFLIGHT)
192                         return true;
193         }
194         return false;
195 }
196
197 /*
198  * As io_match_task() but protected against racing with linked timeouts.
199  * User must not hold timeout_lock.
200  */
201 bool io_match_task_safe(struct io_kiocb *head, struct task_struct *task,
202                         bool cancel_all)
203 {
204         bool matched;
205
206         if (task && head->task != task)
207                 return false;
208         if (cancel_all)
209                 return true;
210
211         if (head->flags & REQ_F_LINK_TIMEOUT) {
212                 struct io_ring_ctx *ctx = head->ctx;
213
214                 /* protect against races with linked timeouts */
215                 spin_lock_irq(&ctx->timeout_lock);
216                 matched = io_match_linked(head);
217                 spin_unlock_irq(&ctx->timeout_lock);
218         } else {
219                 matched = io_match_linked(head);
220         }
221         return matched;
222 }
223
224 static inline void req_fail_link_node(struct io_kiocb *req, int res)
225 {
226         req_set_fail(req);
227         io_req_set_res(req, res, 0);
228 }
229
230 static inline void io_req_add_to_cache(struct io_kiocb *req, struct io_ring_ctx *ctx)
231 {
232         wq_stack_add_head(&req->comp_list, &ctx->submit_state.free_list);
233 }
234
235 static __cold void io_ring_ctx_ref_free(struct percpu_ref *ref)
236 {
237         struct io_ring_ctx *ctx = container_of(ref, struct io_ring_ctx, refs);
238
239         complete(&ctx->ref_comp);
240 }
241
242 static __cold void io_fallback_req_func(struct work_struct *work)
243 {
244         struct io_ring_ctx *ctx = container_of(work, struct io_ring_ctx,
245                                                 fallback_work.work);
246         struct llist_node *node = llist_del_all(&ctx->fallback_llist);
247         struct io_kiocb *req, *tmp;
248         bool locked = false;
249
250         percpu_ref_get(&ctx->refs);
251         llist_for_each_entry_safe(req, tmp, node, io_task_work.node)
252                 req->io_task_work.func(req, &locked);
253
254         if (locked) {
255                 io_submit_flush_completions(ctx);
256                 mutex_unlock(&ctx->uring_lock);
257         }
258         percpu_ref_put(&ctx->refs);
259 }
260
261 static int io_alloc_hash_table(struct io_hash_table *table, unsigned bits)
262 {
263         unsigned hash_buckets = 1U << bits;
264         size_t hash_size = hash_buckets * sizeof(table->hbs[0]);
265
266         table->hbs = kmalloc(hash_size, GFP_KERNEL);
267         if (!table->hbs)
268                 return -ENOMEM;
269
270         table->hash_bits = bits;
271         init_hash_table(table, hash_buckets);
272         return 0;
273 }
274
275 static __cold struct io_ring_ctx *io_ring_ctx_alloc(struct io_uring_params *p)
276 {
277         struct io_ring_ctx *ctx;
278         int hash_bits;
279
280         ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
281         if (!ctx)
282                 return NULL;
283
284         xa_init(&ctx->io_bl_xa);
285
286         /*
287          * Use 5 bits less than the max cq entries, that should give us around
288          * 32 entries per hash list if totally full and uniformly spread, but
289          * don't keep too many buckets to not overconsume memory.
290          */
291         hash_bits = ilog2(p->cq_entries) - 5;
292         hash_bits = clamp(hash_bits, 1, 8);
293         if (io_alloc_hash_table(&ctx->cancel_table, hash_bits))
294                 goto err;
295         if (io_alloc_hash_table(&ctx->cancel_table_locked, hash_bits))
296                 goto err;
297
298         ctx->dummy_ubuf = kzalloc(sizeof(*ctx->dummy_ubuf), GFP_KERNEL);
299         if (!ctx->dummy_ubuf)
300                 goto err;
301         /* set invalid range, so io_import_fixed() fails meeting it */
302         ctx->dummy_ubuf->ubuf = -1UL;
303
304         if (percpu_ref_init(&ctx->refs, io_ring_ctx_ref_free,
305                             0, GFP_KERNEL))
306                 goto err;
307
308         ctx->flags = p->flags;
309         init_waitqueue_head(&ctx->sqo_sq_wait);
310         INIT_LIST_HEAD(&ctx->sqd_list);
311         INIT_LIST_HEAD(&ctx->cq_overflow_list);
312         INIT_LIST_HEAD(&ctx->io_buffers_cache);
313         io_alloc_cache_init(&ctx->apoll_cache);
314         io_alloc_cache_init(&ctx->netmsg_cache);
315         init_completion(&ctx->ref_comp);
316         xa_init_flags(&ctx->personalities, XA_FLAGS_ALLOC1);
317         mutex_init(&ctx->uring_lock);
318         init_waitqueue_head(&ctx->cq_wait);
319         spin_lock_init(&ctx->completion_lock);
320         spin_lock_init(&ctx->timeout_lock);
321         INIT_WQ_LIST(&ctx->iopoll_list);
322         INIT_LIST_HEAD(&ctx->io_buffers_pages);
323         INIT_LIST_HEAD(&ctx->io_buffers_comp);
324         INIT_LIST_HEAD(&ctx->defer_list);
325         INIT_LIST_HEAD(&ctx->timeout_list);
326         INIT_LIST_HEAD(&ctx->ltimeout_list);
327         spin_lock_init(&ctx->rsrc_ref_lock);
328         INIT_LIST_HEAD(&ctx->rsrc_ref_list);
329         INIT_DELAYED_WORK(&ctx->rsrc_put_work, io_rsrc_put_work);
330         init_task_work(&ctx->rsrc_put_tw, io_rsrc_put_tw);
331         init_llist_head(&ctx->rsrc_put_llist);
332         init_llist_head(&ctx->work_llist);
333         INIT_LIST_HEAD(&ctx->tctx_list);
334         ctx->submit_state.free_list.next = NULL;
335         INIT_WQ_LIST(&ctx->locked_free_list);
336         INIT_DELAYED_WORK(&ctx->fallback_work, io_fallback_req_func);
337         INIT_WQ_LIST(&ctx->submit_state.compl_reqs);
338         return ctx;
339 err:
340         kfree(ctx->dummy_ubuf);
341         kfree(ctx->cancel_table.hbs);
342         kfree(ctx->cancel_table_locked.hbs);
343         kfree(ctx->io_bl);
344         xa_destroy(&ctx->io_bl_xa);
345         kfree(ctx);
346         return NULL;
347 }
348
349 static void io_account_cq_overflow(struct io_ring_ctx *ctx)
350 {
351         struct io_rings *r = ctx->rings;
352
353         WRITE_ONCE(r->cq_overflow, READ_ONCE(r->cq_overflow) + 1);
354         ctx->cq_extra--;
355 }
356
357 static bool req_need_defer(struct io_kiocb *req, u32 seq)
358 {
359         if (unlikely(req->flags & REQ_F_IO_DRAIN)) {
360                 struct io_ring_ctx *ctx = req->ctx;
361
362                 return seq + READ_ONCE(ctx->cq_extra) != ctx->cached_cq_tail;
363         }
364
365         return false;
366 }
367
368 static inline void io_req_track_inflight(struct io_kiocb *req)
369 {
370         if (!(req->flags & REQ_F_INFLIGHT)) {
371                 req->flags |= REQ_F_INFLIGHT;
372                 atomic_inc(&req->task->io_uring->inflight_tracked);
373         }
374 }
375
376 static struct io_kiocb *__io_prep_linked_timeout(struct io_kiocb *req)
377 {
378         if (WARN_ON_ONCE(!req->link))
379                 return NULL;
380
381         req->flags &= ~REQ_F_ARM_LTIMEOUT;
382         req->flags |= REQ_F_LINK_TIMEOUT;
383
384         /* linked timeouts should have two refs once prep'ed */
385         io_req_set_refcount(req);
386         __io_req_set_refcount(req->link, 2);
387         return req->link;
388 }
389
390 static inline struct io_kiocb *io_prep_linked_timeout(struct io_kiocb *req)
391 {
392         if (likely(!(req->flags & REQ_F_ARM_LTIMEOUT)))
393                 return NULL;
394         return __io_prep_linked_timeout(req);
395 }
396
397 static noinline void __io_arm_ltimeout(struct io_kiocb *req)
398 {
399         io_queue_linked_timeout(__io_prep_linked_timeout(req));
400 }
401
402 static inline void io_arm_ltimeout(struct io_kiocb *req)
403 {
404         if (unlikely(req->flags & REQ_F_ARM_LTIMEOUT))
405                 __io_arm_ltimeout(req);
406 }
407
408 static void io_prep_async_work(struct io_kiocb *req)
409 {
410         const struct io_op_def *def = &io_op_defs[req->opcode];
411         struct io_ring_ctx *ctx = req->ctx;
412
413         if (!(req->flags & REQ_F_CREDS)) {
414                 req->flags |= REQ_F_CREDS;
415                 req->creds = get_current_cred();
416         }
417
418         req->work.list.next = NULL;
419         req->work.flags = 0;
420         req->work.cancel_seq = atomic_read(&ctx->cancel_seq);
421         if (req->flags & REQ_F_FORCE_ASYNC)
422                 req->work.flags |= IO_WQ_WORK_CONCURRENT;
423
424         if (req->file && !io_req_ffs_set(req))
425                 req->flags |= io_file_get_flags(req->file) << REQ_F_SUPPORT_NOWAIT_BIT;
426
427         if (req->flags & REQ_F_ISREG) {
428                 if (def->hash_reg_file || (ctx->flags & IORING_SETUP_IOPOLL))
429                         io_wq_hash_work(&req->work, file_inode(req->file));
430         } else if (!req->file || !S_ISBLK(file_inode(req->file)->i_mode)) {
431                 if (def->unbound_nonreg_file)
432                         req->work.flags |= IO_WQ_WORK_UNBOUND;
433         }
434 }
435
436 static void io_prep_async_link(struct io_kiocb *req)
437 {
438         struct io_kiocb *cur;
439
440         if (req->flags & REQ_F_LINK_TIMEOUT) {
441                 struct io_ring_ctx *ctx = req->ctx;
442
443                 spin_lock_irq(&ctx->timeout_lock);
444                 io_for_each_link(cur, req)
445                         io_prep_async_work(cur);
446                 spin_unlock_irq(&ctx->timeout_lock);
447         } else {
448                 io_for_each_link(cur, req)
449                         io_prep_async_work(cur);
450         }
451 }
452
453 void io_queue_iowq(struct io_kiocb *req, bool *dont_use)
454 {
455         struct io_kiocb *link = io_prep_linked_timeout(req);
456         struct io_uring_task *tctx = req->task->io_uring;
457
458         BUG_ON(!tctx);
459         BUG_ON(!tctx->io_wq);
460
461         /* init ->work of the whole link before punting */
462         io_prep_async_link(req);
463
464         /*
465          * Not expected to happen, but if we do have a bug where this _can_
466          * happen, catch it here and ensure the request is marked as
467          * canceled. That will make io-wq go through the usual work cancel
468          * procedure rather than attempt to run this request (or create a new
469          * worker for it).
470          */
471         if (WARN_ON_ONCE(!same_thread_group(req->task, current)))
472                 req->work.flags |= IO_WQ_WORK_CANCEL;
473
474         trace_io_uring_queue_async_work(req, io_wq_is_hashed(&req->work));
475         io_wq_enqueue(tctx->io_wq, &req->work);
476         if (link)
477                 io_queue_linked_timeout(link);
478 }
479
480 static __cold void io_queue_deferred(struct io_ring_ctx *ctx)
481 {
482         while (!list_empty(&ctx->defer_list)) {
483                 struct io_defer_entry *de = list_first_entry(&ctx->defer_list,
484                                                 struct io_defer_entry, list);
485
486                 if (req_need_defer(de->req, de->seq))
487                         break;
488                 list_del_init(&de->list);
489                 io_req_task_queue(de->req);
490                 kfree(de);
491         }
492 }
493
494
495 static void io_eventfd_ops(struct rcu_head *rcu)
496 {
497         struct io_ev_fd *ev_fd = container_of(rcu, struct io_ev_fd, rcu);
498         int ops = atomic_xchg(&ev_fd->ops, 0);
499
500         if (ops & BIT(IO_EVENTFD_OP_SIGNAL_BIT))
501                 eventfd_signal_mask(ev_fd->cq_ev_fd, 1, EPOLL_URING_WAKE);
502
503         /* IO_EVENTFD_OP_FREE_BIT may not be set here depending on callback
504          * ordering in a race but if references are 0 we know we have to free
505          * it regardless.
506          */
507         if (atomic_dec_and_test(&ev_fd->refs)) {
508                 eventfd_ctx_put(ev_fd->cq_ev_fd);
509                 kfree(ev_fd);
510         }
511 }
512
513 static void io_eventfd_signal(struct io_ring_ctx *ctx)
514 {
515         struct io_ev_fd *ev_fd = NULL;
516
517         rcu_read_lock();
518         /*
519          * rcu_dereference ctx->io_ev_fd once and use it for both for checking
520          * and eventfd_signal
521          */
522         ev_fd = rcu_dereference(ctx->io_ev_fd);
523
524         /*
525          * Check again if ev_fd exists incase an io_eventfd_unregister call
526          * completed between the NULL check of ctx->io_ev_fd at the start of
527          * the function and rcu_read_lock.
528          */
529         if (unlikely(!ev_fd))
530                 goto out;
531         if (READ_ONCE(ctx->rings->cq_flags) & IORING_CQ_EVENTFD_DISABLED)
532                 goto out;
533         if (ev_fd->eventfd_async && !io_wq_current_is_worker())
534                 goto out;
535
536         if (likely(eventfd_signal_allowed())) {
537                 eventfd_signal_mask(ev_fd->cq_ev_fd, 1, EPOLL_URING_WAKE);
538         } else {
539                 atomic_inc(&ev_fd->refs);
540                 if (!atomic_fetch_or(BIT(IO_EVENTFD_OP_SIGNAL_BIT), &ev_fd->ops))
541                         call_rcu_hurry(&ev_fd->rcu, io_eventfd_ops);
542                 else
543                         atomic_dec(&ev_fd->refs);
544         }
545
546 out:
547         rcu_read_unlock();
548 }
549
550 static void io_eventfd_flush_signal(struct io_ring_ctx *ctx)
551 {
552         bool skip;
553
554         spin_lock(&ctx->completion_lock);
555
556         /*
557          * Eventfd should only get triggered when at least one event has been
558          * posted. Some applications rely on the eventfd notification count
559          * only changing IFF a new CQE has been added to the CQ ring. There's
560          * no depedency on 1:1 relationship between how many times this
561          * function is called (and hence the eventfd count) and number of CQEs
562          * posted to the CQ ring.
563          */
564         skip = ctx->cached_cq_tail == ctx->evfd_last_cq_tail;
565         ctx->evfd_last_cq_tail = ctx->cached_cq_tail;
566         spin_unlock(&ctx->completion_lock);
567         if (skip)
568                 return;
569
570         io_eventfd_signal(ctx);
571 }
572
573 void __io_commit_cqring_flush(struct io_ring_ctx *ctx)
574 {
575         if (ctx->off_timeout_used)
576                 io_flush_timeouts(ctx);
577         if (ctx->drain_active) {
578                 spin_lock(&ctx->completion_lock);
579                 io_queue_deferred(ctx);
580                 spin_unlock(&ctx->completion_lock);
581         }
582         if (ctx->has_evfd)
583                 io_eventfd_flush_signal(ctx);
584 }
585
586 static inline void __io_cq_lock(struct io_ring_ctx *ctx)
587         __acquires(ctx->completion_lock)
588 {
589         if (!ctx->task_complete)
590                 spin_lock(&ctx->completion_lock);
591 }
592
593 static inline void __io_cq_unlock(struct io_ring_ctx *ctx)
594 {
595         if (!ctx->task_complete)
596                 spin_unlock(&ctx->completion_lock);
597 }
598
599 static inline void io_cq_lock(struct io_ring_ctx *ctx)
600         __acquires(ctx->completion_lock)
601 {
602         spin_lock(&ctx->completion_lock);
603 }
604
605 static inline void io_cq_unlock(struct io_ring_ctx *ctx)
606         __releases(ctx->completion_lock)
607 {
608         spin_unlock(&ctx->completion_lock);
609 }
610
611 /* keep it inlined for io_submit_flush_completions() */
612 static inline void __io_cq_unlock_post(struct io_ring_ctx *ctx)
613         __releases(ctx->completion_lock)
614 {
615         io_commit_cqring(ctx);
616         __io_cq_unlock(ctx);
617         io_commit_cqring_flush(ctx);
618         io_cqring_wake(ctx);
619 }
620
621 void io_cq_unlock_post(struct io_ring_ctx *ctx)
622         __releases(ctx->completion_lock)
623 {
624         io_commit_cqring(ctx);
625         spin_unlock(&ctx->completion_lock);
626         io_commit_cqring_flush(ctx);
627         io_cqring_wake(ctx);
628 }
629
630 /* Returns true if there are no backlogged entries after the flush */
631 static void io_cqring_overflow_kill(struct io_ring_ctx *ctx)
632 {
633         struct io_overflow_cqe *ocqe;
634         LIST_HEAD(list);
635
636         io_cq_lock(ctx);
637         list_splice_init(&ctx->cq_overflow_list, &list);
638         clear_bit(IO_CHECK_CQ_OVERFLOW_BIT, &ctx->check_cq);
639         io_cq_unlock(ctx);
640
641         while (!list_empty(&list)) {
642                 ocqe = list_first_entry(&list, struct io_overflow_cqe, list);
643                 list_del(&ocqe->list);
644                 kfree(ocqe);
645         }
646 }
647
648 /* Returns true if there are no backlogged entries after the flush */
649 static void __io_cqring_overflow_flush(struct io_ring_ctx *ctx)
650 {
651         size_t cqe_size = sizeof(struct io_uring_cqe);
652
653         if (__io_cqring_events(ctx) == ctx->cq_entries)
654                 return;
655
656         if (ctx->flags & IORING_SETUP_CQE32)
657                 cqe_size <<= 1;
658
659         io_cq_lock(ctx);
660         while (!list_empty(&ctx->cq_overflow_list)) {
661                 struct io_uring_cqe *cqe = io_get_cqe_overflow(ctx, true);
662                 struct io_overflow_cqe *ocqe;
663
664                 if (!cqe)
665                         break;
666                 ocqe = list_first_entry(&ctx->cq_overflow_list,
667                                         struct io_overflow_cqe, list);
668                 memcpy(cqe, &ocqe->cqe, cqe_size);
669                 list_del(&ocqe->list);
670                 kfree(ocqe);
671         }
672
673         if (list_empty(&ctx->cq_overflow_list)) {
674                 clear_bit(IO_CHECK_CQ_OVERFLOW_BIT, &ctx->check_cq);
675                 atomic_andnot(IORING_SQ_CQ_OVERFLOW, &ctx->rings->sq_flags);
676         }
677         io_cq_unlock_post(ctx);
678 }
679
680 static void io_cqring_do_overflow_flush(struct io_ring_ctx *ctx)
681 {
682         /* iopoll syncs against uring_lock, not completion_lock */
683         if (ctx->flags & IORING_SETUP_IOPOLL)
684                 mutex_lock(&ctx->uring_lock);
685         __io_cqring_overflow_flush(ctx);
686         if (ctx->flags & IORING_SETUP_IOPOLL)
687                 mutex_unlock(&ctx->uring_lock);
688 }
689
690 static void io_cqring_overflow_flush(struct io_ring_ctx *ctx)
691 {
692         if (test_bit(IO_CHECK_CQ_OVERFLOW_BIT, &ctx->check_cq))
693                 io_cqring_do_overflow_flush(ctx);
694 }
695
696 void __io_put_task(struct task_struct *task, int nr)
697 {
698         struct io_uring_task *tctx = task->io_uring;
699
700         percpu_counter_sub(&tctx->inflight, nr);
701         if (unlikely(atomic_read(&tctx->in_idle)))
702                 wake_up(&tctx->wait);
703         put_task_struct_many(task, nr);
704 }
705
706 void io_task_refs_refill(struct io_uring_task *tctx)
707 {
708         unsigned int refill = -tctx->cached_refs + IO_TCTX_REFS_CACHE_NR;
709
710         percpu_counter_add(&tctx->inflight, refill);
711         refcount_add(refill, &current->usage);
712         tctx->cached_refs += refill;
713 }
714
715 static __cold void io_uring_drop_tctx_refs(struct task_struct *task)
716 {
717         struct io_uring_task *tctx = task->io_uring;
718         unsigned int refs = tctx->cached_refs;
719
720         if (refs) {
721                 tctx->cached_refs = 0;
722                 percpu_counter_sub(&tctx->inflight, refs);
723                 put_task_struct_many(task, refs);
724         }
725 }
726
727 static bool io_cqring_event_overflow(struct io_ring_ctx *ctx, u64 user_data,
728                                      s32 res, u32 cflags, u64 extra1, u64 extra2)
729 {
730         struct io_overflow_cqe *ocqe;
731         size_t ocq_size = sizeof(struct io_overflow_cqe);
732         bool is_cqe32 = (ctx->flags & IORING_SETUP_CQE32);
733
734         lockdep_assert_held(&ctx->completion_lock);
735
736         if (is_cqe32)
737                 ocq_size += sizeof(struct io_uring_cqe);
738
739         ocqe = kmalloc(ocq_size, GFP_ATOMIC | __GFP_ACCOUNT);
740         trace_io_uring_cqe_overflow(ctx, user_data, res, cflags, ocqe);
741         if (!ocqe) {
742                 /*
743                  * If we're in ring overflow flush mode, or in task cancel mode,
744                  * or cannot allocate an overflow entry, then we need to drop it
745                  * on the floor.
746                  */
747                 io_account_cq_overflow(ctx);
748                 set_bit(IO_CHECK_CQ_DROPPED_BIT, &ctx->check_cq);
749                 return false;
750         }
751         if (list_empty(&ctx->cq_overflow_list)) {
752                 set_bit(IO_CHECK_CQ_OVERFLOW_BIT, &ctx->check_cq);
753                 atomic_or(IORING_SQ_CQ_OVERFLOW, &ctx->rings->sq_flags);
754
755         }
756         ocqe->cqe.user_data = user_data;
757         ocqe->cqe.res = res;
758         ocqe->cqe.flags = cflags;
759         if (is_cqe32) {
760                 ocqe->cqe.big_cqe[0] = extra1;
761                 ocqe->cqe.big_cqe[1] = extra2;
762         }
763         list_add_tail(&ocqe->list, &ctx->cq_overflow_list);
764         return true;
765 }
766
767 bool io_req_cqe_overflow(struct io_kiocb *req)
768 {
769         if (!(req->flags & REQ_F_CQE32_INIT)) {
770                 req->extra1 = 0;
771                 req->extra2 = 0;
772         }
773         return io_cqring_event_overflow(req->ctx, req->cqe.user_data,
774                                         req->cqe.res, req->cqe.flags,
775                                         req->extra1, req->extra2);
776 }
777
778 /*
779  * writes to the cq entry need to come after reading head; the
780  * control dependency is enough as we're using WRITE_ONCE to
781  * fill the cq entry
782  */
783 struct io_uring_cqe *__io_get_cqe(struct io_ring_ctx *ctx, bool overflow)
784 {
785         struct io_rings *rings = ctx->rings;
786         unsigned int off = ctx->cached_cq_tail & (ctx->cq_entries - 1);
787         unsigned int free, queued, len;
788
789         /*
790          * Posting into the CQ when there are pending overflowed CQEs may break
791          * ordering guarantees, which will affect links, F_MORE users and more.
792          * Force overflow the completion.
793          */
794         if (!overflow && (ctx->check_cq & BIT(IO_CHECK_CQ_OVERFLOW_BIT)))
795                 return NULL;
796
797         /* userspace may cheat modifying the tail, be safe and do min */
798         queued = min(__io_cqring_events(ctx), ctx->cq_entries);
799         free = ctx->cq_entries - queued;
800         /* we need a contiguous range, limit based on the current array offset */
801         len = min(free, ctx->cq_entries - off);
802         if (!len)
803                 return NULL;
804
805         if (ctx->flags & IORING_SETUP_CQE32) {
806                 off <<= 1;
807                 len <<= 1;
808         }
809
810         ctx->cqe_cached = &rings->cqes[off];
811         ctx->cqe_sentinel = ctx->cqe_cached + len;
812
813         ctx->cached_cq_tail++;
814         ctx->cqe_cached++;
815         if (ctx->flags & IORING_SETUP_CQE32)
816                 ctx->cqe_cached++;
817         return &rings->cqes[off];
818 }
819
820 static bool io_fill_cqe_aux(struct io_ring_ctx *ctx, u64 user_data, s32 res,
821                               u32 cflags)
822 {
823         struct io_uring_cqe *cqe;
824
825         ctx->cq_extra++;
826
827         /*
828          * If we can't get a cq entry, userspace overflowed the
829          * submission (by quite a lot). Increment the overflow count in
830          * the ring.
831          */
832         cqe = io_get_cqe(ctx);
833         if (likely(cqe)) {
834                 trace_io_uring_complete(ctx, NULL, user_data, res, cflags, 0, 0);
835
836                 WRITE_ONCE(cqe->user_data, user_data);
837                 WRITE_ONCE(cqe->res, res);
838                 WRITE_ONCE(cqe->flags, cflags);
839
840                 if (ctx->flags & IORING_SETUP_CQE32) {
841                         WRITE_ONCE(cqe->big_cqe[0], 0);
842                         WRITE_ONCE(cqe->big_cqe[1], 0);
843                 }
844                 return true;
845         }
846         return false;
847 }
848
849 static void __io_flush_post_cqes(struct io_ring_ctx *ctx)
850         __must_hold(&ctx->uring_lock)
851 {
852         struct io_submit_state *state = &ctx->submit_state;
853         unsigned int i;
854
855         lockdep_assert_held(&ctx->uring_lock);
856         for (i = 0; i < state->cqes_count; i++) {
857                 struct io_uring_cqe *cqe = &state->cqes[i];
858
859                 if (!io_fill_cqe_aux(ctx, cqe->user_data, cqe->res, cqe->flags)) {
860                         if (ctx->task_complete) {
861                                 spin_lock(&ctx->completion_lock);
862                                 io_cqring_event_overflow(ctx, cqe->user_data,
863                                                         cqe->res, cqe->flags, 0, 0);
864                                 spin_unlock(&ctx->completion_lock);
865                         } else {
866                                 io_cqring_event_overflow(ctx, cqe->user_data,
867                                                         cqe->res, cqe->flags, 0, 0);
868                         }
869                 }
870         }
871         state->cqes_count = 0;
872 }
873
874 static bool __io_post_aux_cqe(struct io_ring_ctx *ctx, u64 user_data, s32 res, u32 cflags,
875                               bool allow_overflow)
876 {
877         bool filled;
878
879         io_cq_lock(ctx);
880         filled = io_fill_cqe_aux(ctx, user_data, res, cflags);
881         if (!filled && allow_overflow)
882                 filled = io_cqring_event_overflow(ctx, user_data, res, cflags, 0, 0);
883
884         io_cq_unlock_post(ctx);
885         return filled;
886 }
887
888 bool io_post_aux_cqe(struct io_ring_ctx *ctx, u64 user_data, s32 res, u32 cflags)
889 {
890         return __io_post_aux_cqe(ctx, user_data, res, cflags, true);
891 }
892
893 bool io_aux_cqe(struct io_ring_ctx *ctx, bool defer, u64 user_data, s32 res, u32 cflags,
894                 bool allow_overflow)
895 {
896         struct io_uring_cqe *cqe;
897         unsigned int length;
898
899         if (!defer)
900                 return __io_post_aux_cqe(ctx, user_data, res, cflags, allow_overflow);
901
902         length = ARRAY_SIZE(ctx->submit_state.cqes);
903
904         lockdep_assert_held(&ctx->uring_lock);
905
906         if (ctx->submit_state.cqes_count == length) {
907                 __io_cq_lock(ctx);
908                 __io_flush_post_cqes(ctx);
909                 /* no need to flush - flush is deferred */
910                 __io_cq_unlock_post(ctx);
911         }
912
913         /* For defered completions this is not as strict as it is otherwise,
914          * however it's main job is to prevent unbounded posted completions,
915          * and in that it works just as well.
916          */
917         if (!allow_overflow && test_bit(IO_CHECK_CQ_OVERFLOW_BIT, &ctx->check_cq))
918                 return false;
919
920         cqe = &ctx->submit_state.cqes[ctx->submit_state.cqes_count++];
921         cqe->user_data = user_data;
922         cqe->res = res;
923         cqe->flags = cflags;
924         return true;
925 }
926
927 static void __io_req_complete_post(struct io_kiocb *req)
928 {
929         struct io_ring_ctx *ctx = req->ctx;
930
931         io_cq_lock(ctx);
932         if (!(req->flags & REQ_F_CQE_SKIP))
933                 io_fill_cqe_req(ctx, req);
934
935         /*
936          * If we're the last reference to this request, add to our locked
937          * free_list cache.
938          */
939         if (req_ref_put_and_test(req)) {
940                 if (req->flags & IO_REQ_LINK_FLAGS) {
941                         if (req->flags & IO_DISARM_MASK)
942                                 io_disarm_next(req);
943                         if (req->link) {
944                                 io_req_task_queue(req->link);
945                                 req->link = NULL;
946                         }
947                 }
948                 io_req_put_rsrc(req);
949                 /*
950                  * Selected buffer deallocation in io_clean_op() assumes that
951                  * we don't hold ->completion_lock. Clean them here to avoid
952                  * deadlocks.
953                  */
954                 io_put_kbuf_comp(req);
955                 io_dismantle_req(req);
956                 io_put_task(req->task, 1);
957                 wq_list_add_head(&req->comp_list, &ctx->locked_free_list);
958                 ctx->locked_free_nr++;
959         }
960         io_cq_unlock_post(ctx);
961 }
962
963 void io_req_complete_post(struct io_kiocb *req, unsigned issue_flags)
964 {
965         if (req->ctx->task_complete && (issue_flags & IO_URING_F_IOWQ)) {
966                 req->io_task_work.func = io_req_task_complete;
967                 io_req_task_work_add(req);
968         } else if (!(issue_flags & IO_URING_F_UNLOCKED) ||
969                    !(req->ctx->flags & IORING_SETUP_IOPOLL)) {
970                 __io_req_complete_post(req);
971         } else {
972                 struct io_ring_ctx *ctx = req->ctx;
973
974                 mutex_lock(&ctx->uring_lock);
975                 __io_req_complete_post(req);
976                 mutex_unlock(&ctx->uring_lock);
977         }
978 }
979
980 void io_req_defer_failed(struct io_kiocb *req, s32 res)
981         __must_hold(&ctx->uring_lock)
982 {
983         const struct io_op_def *def = &io_op_defs[req->opcode];
984
985         lockdep_assert_held(&req->ctx->uring_lock);
986
987         req_set_fail(req);
988         io_req_set_res(req, res, io_put_kbuf(req, IO_URING_F_UNLOCKED));
989         if (def->fail)
990                 def->fail(req);
991         io_req_complete_defer(req);
992 }
993
994 /*
995  * Don't initialise the fields below on every allocation, but do that in
996  * advance and keep them valid across allocations.
997  */
998 static void io_preinit_req(struct io_kiocb *req, struct io_ring_ctx *ctx)
999 {
1000         req->ctx = ctx;
1001         req->link = NULL;
1002         req->async_data = NULL;
1003         /* not necessary, but safer to zero */
1004         req->cqe.res = 0;
1005 }
1006
1007 static void io_flush_cached_locked_reqs(struct io_ring_ctx *ctx,
1008                                         struct io_submit_state *state)
1009 {
1010         spin_lock(&ctx->completion_lock);
1011         wq_list_splice(&ctx->locked_free_list, &state->free_list);
1012         ctx->locked_free_nr = 0;
1013         spin_unlock(&ctx->completion_lock);
1014 }
1015
1016 /*
1017  * A request might get retired back into the request caches even before opcode
1018  * handlers and io_issue_sqe() are done with it, e.g. inline completion path.
1019  * Because of that, io_alloc_req() should be called only under ->uring_lock
1020  * and with extra caution to not get a request that is still worked on.
1021  */
1022 __cold bool __io_alloc_req_refill(struct io_ring_ctx *ctx)
1023         __must_hold(&ctx->uring_lock)
1024 {
1025         gfp_t gfp = GFP_KERNEL | __GFP_NOWARN;
1026         void *reqs[IO_REQ_ALLOC_BATCH];
1027         int ret, i;
1028
1029         /*
1030          * If we have more than a batch's worth of requests in our IRQ side
1031          * locked cache, grab the lock and move them over to our submission
1032          * side cache.
1033          */
1034         if (data_race(ctx->locked_free_nr) > IO_COMPL_BATCH) {
1035                 io_flush_cached_locked_reqs(ctx, &ctx->submit_state);
1036                 if (!io_req_cache_empty(ctx))
1037                         return true;
1038         }
1039
1040         ret = kmem_cache_alloc_bulk(req_cachep, gfp, ARRAY_SIZE(reqs), reqs);
1041
1042         /*
1043          * Bulk alloc is all-or-nothing. If we fail to get a batch,
1044          * retry single alloc to be on the safe side.
1045          */
1046         if (unlikely(ret <= 0)) {
1047                 reqs[0] = kmem_cache_alloc(req_cachep, gfp);
1048                 if (!reqs[0])
1049                         return false;
1050                 ret = 1;
1051         }
1052
1053         percpu_ref_get_many(&ctx->refs, ret);
1054         for (i = 0; i < ret; i++) {
1055                 struct io_kiocb *req = reqs[i];
1056
1057                 io_preinit_req(req, ctx);
1058                 io_req_add_to_cache(req, ctx);
1059         }
1060         return true;
1061 }
1062
1063 static inline void io_dismantle_req(struct io_kiocb *req)
1064 {
1065         unsigned int flags = req->flags;
1066
1067         if (unlikely(flags & IO_REQ_CLEAN_FLAGS))
1068                 io_clean_op(req);
1069         if (!(flags & REQ_F_FIXED_FILE))
1070                 io_put_file(req->file);
1071 }
1072
1073 __cold void io_free_req(struct io_kiocb *req)
1074 {
1075         struct io_ring_ctx *ctx = req->ctx;
1076
1077         io_req_put_rsrc(req);
1078         io_dismantle_req(req);
1079         io_put_task(req->task, 1);
1080
1081         spin_lock(&ctx->completion_lock);
1082         wq_list_add_head(&req->comp_list, &ctx->locked_free_list);
1083         ctx->locked_free_nr++;
1084         spin_unlock(&ctx->completion_lock);
1085 }
1086
1087 static void __io_req_find_next_prep(struct io_kiocb *req)
1088 {
1089         struct io_ring_ctx *ctx = req->ctx;
1090
1091         spin_lock(&ctx->completion_lock);
1092         io_disarm_next(req);
1093         spin_unlock(&ctx->completion_lock);
1094 }
1095
1096 static inline struct io_kiocb *io_req_find_next(struct io_kiocb *req)
1097 {
1098         struct io_kiocb *nxt;
1099
1100         /*
1101          * If LINK is set, we have dependent requests in this chain. If we
1102          * didn't fail this request, queue the first one up, moving any other
1103          * dependencies to the next request. In case of failure, fail the rest
1104          * of the chain.
1105          */
1106         if (unlikely(req->flags & IO_DISARM_MASK))
1107                 __io_req_find_next_prep(req);
1108         nxt = req->link;
1109         req->link = NULL;
1110         return nxt;
1111 }
1112
1113 static void ctx_flush_and_put(struct io_ring_ctx *ctx, bool *locked)
1114 {
1115         if (!ctx)
1116                 return;
1117         if (ctx->flags & IORING_SETUP_TASKRUN_FLAG)
1118                 atomic_andnot(IORING_SQ_TASKRUN, &ctx->rings->sq_flags);
1119         if (*locked) {
1120                 io_submit_flush_completions(ctx);
1121                 mutex_unlock(&ctx->uring_lock);
1122                 *locked = false;
1123         }
1124         percpu_ref_put(&ctx->refs);
1125 }
1126
1127 static unsigned int handle_tw_list(struct llist_node *node,
1128                                    struct io_ring_ctx **ctx, bool *locked,
1129                                    struct llist_node *last)
1130 {
1131         unsigned int count = 0;
1132
1133         while (node != last) {
1134                 struct llist_node *next = node->next;
1135                 struct io_kiocb *req = container_of(node, struct io_kiocb,
1136                                                     io_task_work.node);
1137
1138                 prefetch(container_of(next, struct io_kiocb, io_task_work.node));
1139
1140                 if (req->ctx != *ctx) {
1141                         ctx_flush_and_put(*ctx, locked);
1142                         *ctx = req->ctx;
1143                         /* if not contended, grab and improve batching */
1144                         *locked = mutex_trylock(&(*ctx)->uring_lock);
1145                         percpu_ref_get(&(*ctx)->refs);
1146                 }
1147                 req->io_task_work.func(req, locked);
1148                 node = next;
1149                 count++;
1150         }
1151
1152         return count;
1153 }
1154
1155 /**
1156  * io_llist_xchg - swap all entries in a lock-less list
1157  * @head:       the head of lock-less list to delete all entries
1158  * @new:        new entry as the head of the list
1159  *
1160  * If list is empty, return NULL, otherwise, return the pointer to the first entry.
1161  * The order of entries returned is from the newest to the oldest added one.
1162  */
1163 static inline struct llist_node *io_llist_xchg(struct llist_head *head,
1164                                                struct llist_node *new)
1165 {
1166         return xchg(&head->first, new);
1167 }
1168
1169 /**
1170  * io_llist_cmpxchg - possibly swap all entries in a lock-less list
1171  * @head:       the head of lock-less list to delete all entries
1172  * @old:        expected old value of the first entry of the list
1173  * @new:        new entry as the head of the list
1174  *
1175  * perform a cmpxchg on the first entry of the list.
1176  */
1177
1178 static inline struct llist_node *io_llist_cmpxchg(struct llist_head *head,
1179                                                   struct llist_node *old,
1180                                                   struct llist_node *new)
1181 {
1182         return cmpxchg(&head->first, old, new);
1183 }
1184
1185 void tctx_task_work(struct callback_head *cb)
1186 {
1187         bool uring_locked = false;
1188         struct io_ring_ctx *ctx = NULL;
1189         struct io_uring_task *tctx = container_of(cb, struct io_uring_task,
1190                                                   task_work);
1191         struct llist_node fake = {};
1192         struct llist_node *node;
1193         unsigned int loops = 1;
1194         unsigned int count;
1195
1196         if (unlikely(current->flags & PF_EXITING)) {
1197                 io_fallback_tw(tctx);
1198                 return;
1199         }
1200
1201         node = io_llist_xchg(&tctx->task_list, &fake);
1202         count = handle_tw_list(node, &ctx, &uring_locked, NULL);
1203         node = io_llist_cmpxchg(&tctx->task_list, &fake, NULL);
1204         while (node != &fake) {
1205                 loops++;
1206                 node = io_llist_xchg(&tctx->task_list, &fake);
1207                 count += handle_tw_list(node, &ctx, &uring_locked, &fake);
1208                 node = io_llist_cmpxchg(&tctx->task_list, &fake, NULL);
1209         }
1210
1211         ctx_flush_and_put(ctx, &uring_locked);
1212
1213         /* relaxed read is enough as only the task itself sets ->in_idle */
1214         if (unlikely(atomic_read(&tctx->in_idle)))
1215                 io_uring_drop_tctx_refs(current);
1216
1217         trace_io_uring_task_work_run(tctx, count, loops);
1218 }
1219
1220 static __cold void io_fallback_tw(struct io_uring_task *tctx)
1221 {
1222         struct llist_node *node = llist_del_all(&tctx->task_list);
1223         struct io_kiocb *req;
1224
1225         while (node) {
1226                 req = container_of(node, struct io_kiocb, io_task_work.node);
1227                 node = node->next;
1228                 if (llist_add(&req->io_task_work.node,
1229                               &req->ctx->fallback_llist))
1230                         schedule_delayed_work(&req->ctx->fallback_work, 1);
1231         }
1232 }
1233
1234 static void io_req_local_work_add(struct io_kiocb *req)
1235 {
1236         struct io_ring_ctx *ctx = req->ctx;
1237
1238         percpu_ref_get(&ctx->refs);
1239
1240         if (!llist_add(&req->io_task_work.node, &ctx->work_llist)) {
1241                 percpu_ref_put(&ctx->refs);
1242                 return;
1243         }
1244         /* need it for the following io_cqring_wake() */
1245         smp_mb__after_atomic();
1246
1247         if (unlikely(atomic_read(&req->task->io_uring->in_idle))) {
1248                 io_move_task_work_from_local(ctx);
1249                 percpu_ref_put(&ctx->refs);
1250                 return;
1251         }
1252
1253         if (ctx->flags & IORING_SETUP_TASKRUN_FLAG)
1254                 atomic_or(IORING_SQ_TASKRUN, &ctx->rings->sq_flags);
1255
1256         if (ctx->has_evfd)
1257                 io_eventfd_signal(ctx);
1258         __io_cqring_wake(ctx);
1259         percpu_ref_put(&ctx->refs);
1260 }
1261
1262 void __io_req_task_work_add(struct io_kiocb *req, bool allow_local)
1263 {
1264         struct io_uring_task *tctx = req->task->io_uring;
1265         struct io_ring_ctx *ctx = req->ctx;
1266
1267         if (allow_local && ctx->flags & IORING_SETUP_DEFER_TASKRUN) {
1268                 io_req_local_work_add(req);
1269                 return;
1270         }
1271
1272         /* task_work already pending, we're done */
1273         if (!llist_add(&req->io_task_work.node, &tctx->task_list))
1274                 return;
1275
1276         if (ctx->flags & IORING_SETUP_TASKRUN_FLAG)
1277                 atomic_or(IORING_SQ_TASKRUN, &ctx->rings->sq_flags);
1278
1279         if (likely(!task_work_add(req->task, &tctx->task_work, ctx->notify_method)))
1280                 return;
1281
1282         io_fallback_tw(tctx);
1283 }
1284
1285 static void __cold io_move_task_work_from_local(struct io_ring_ctx *ctx)
1286 {
1287         struct llist_node *node;
1288
1289         node = llist_del_all(&ctx->work_llist);
1290         while (node) {
1291                 struct io_kiocb *req = container_of(node, struct io_kiocb,
1292                                                     io_task_work.node);
1293
1294                 node = node->next;
1295                 __io_req_task_work_add(req, false);
1296         }
1297 }
1298
1299 int __io_run_local_work(struct io_ring_ctx *ctx, bool *locked)
1300 {
1301         struct llist_node *node;
1302         struct llist_node fake;
1303         struct llist_node *current_final = NULL;
1304         int ret = 0;
1305         unsigned int loops = 1;
1306
1307         if (WARN_ON_ONCE(ctx->submitter_task != current))
1308                 return -EEXIST;
1309
1310         node = io_llist_xchg(&ctx->work_llist, &fake);
1311 again:
1312         while (node != current_final) {
1313                 struct llist_node *next = node->next;
1314                 struct io_kiocb *req = container_of(node, struct io_kiocb,
1315                                                     io_task_work.node);
1316                 prefetch(container_of(next, struct io_kiocb, io_task_work.node));
1317                 req->io_task_work.func(req, locked);
1318                 ret++;
1319                 node = next;
1320         }
1321
1322         if (ctx->flags & IORING_SETUP_TASKRUN_FLAG)
1323                 atomic_andnot(IORING_SQ_TASKRUN, &ctx->rings->sq_flags);
1324
1325         node = io_llist_cmpxchg(&ctx->work_llist, &fake, NULL);
1326         if (node != &fake) {
1327                 loops++;
1328                 current_final = &fake;
1329                 node = io_llist_xchg(&ctx->work_llist, &fake);
1330                 goto again;
1331         }
1332
1333         if (*locked)
1334                 io_submit_flush_completions(ctx);
1335         trace_io_uring_local_work_run(ctx, ret, loops);
1336         return ret;
1337
1338 }
1339
1340 int io_run_local_work(struct io_ring_ctx *ctx)
1341 {
1342         bool locked;
1343         int ret;
1344
1345         __set_current_state(TASK_RUNNING);
1346         locked = mutex_trylock(&ctx->uring_lock);
1347         ret = __io_run_local_work(ctx, &locked);
1348         if (locked)
1349                 mutex_unlock(&ctx->uring_lock);
1350
1351         return ret;
1352 }
1353
1354 static void io_req_task_cancel(struct io_kiocb *req, bool *locked)
1355 {
1356         io_tw_lock(req->ctx, locked);
1357         io_req_defer_failed(req, req->cqe.res);
1358 }
1359
1360 void io_req_task_submit(struct io_kiocb *req, bool *locked)
1361 {
1362         io_tw_lock(req->ctx, locked);
1363         /* req->task == current here, checking PF_EXITING is safe */
1364         if (likely(!(req->task->flags & PF_EXITING)))
1365                 io_queue_sqe(req);
1366         else
1367                 io_req_defer_failed(req, -EFAULT);
1368 }
1369
1370 void io_req_task_queue_fail(struct io_kiocb *req, int ret)
1371 {
1372         io_req_set_res(req, ret, 0);
1373         req->io_task_work.func = io_req_task_cancel;
1374         io_req_task_work_add(req);
1375 }
1376
1377 void io_req_task_queue(struct io_kiocb *req)
1378 {
1379         req->io_task_work.func = io_req_task_submit;
1380         io_req_task_work_add(req);
1381 }
1382
1383 void io_queue_next(struct io_kiocb *req)
1384 {
1385         struct io_kiocb *nxt = io_req_find_next(req);
1386
1387         if (nxt)
1388                 io_req_task_queue(nxt);
1389 }
1390
1391 void io_free_batch_list(struct io_ring_ctx *ctx, struct io_wq_work_node *node)
1392         __must_hold(&ctx->uring_lock)
1393 {
1394         struct task_struct *task = NULL;
1395         int task_refs = 0;
1396
1397         do {
1398                 struct io_kiocb *req = container_of(node, struct io_kiocb,
1399                                                     comp_list);
1400
1401                 if (unlikely(req->flags & IO_REQ_CLEAN_SLOW_FLAGS)) {
1402                         if (req->flags & REQ_F_REFCOUNT) {
1403                                 node = req->comp_list.next;
1404                                 if (!req_ref_put_and_test(req))
1405                                         continue;
1406                         }
1407                         if ((req->flags & REQ_F_POLLED) && req->apoll) {
1408                                 struct async_poll *apoll = req->apoll;
1409
1410                                 if (apoll->double_poll)
1411                                         kfree(apoll->double_poll);
1412                                 if (!io_alloc_cache_put(&ctx->apoll_cache, &apoll->cache))
1413                                         kfree(apoll);
1414                                 req->flags &= ~REQ_F_POLLED;
1415                         }
1416                         if (req->flags & IO_REQ_LINK_FLAGS)
1417                                 io_queue_next(req);
1418                         if (unlikely(req->flags & IO_REQ_CLEAN_FLAGS))
1419                                 io_clean_op(req);
1420                 }
1421                 if (!(req->flags & REQ_F_FIXED_FILE))
1422                         io_put_file(req->file);
1423
1424                 io_req_put_rsrc_locked(req, ctx);
1425
1426                 if (req->task != task) {
1427                         if (task)
1428                                 io_put_task(task, task_refs);
1429                         task = req->task;
1430                         task_refs = 0;
1431                 }
1432                 task_refs++;
1433                 node = req->comp_list.next;
1434                 io_req_add_to_cache(req, ctx);
1435         } while (node);
1436
1437         if (task)
1438                 io_put_task(task, task_refs);
1439 }
1440
1441 static void __io_submit_flush_completions(struct io_ring_ctx *ctx)
1442         __must_hold(&ctx->uring_lock)
1443 {
1444         struct io_wq_work_node *node, *prev;
1445         struct io_submit_state *state = &ctx->submit_state;
1446
1447         __io_cq_lock(ctx);
1448         /* must come first to preserve CQE ordering in failure cases */
1449         if (state->cqes_count)
1450                 __io_flush_post_cqes(ctx);
1451         wq_list_for_each(node, prev, &state->compl_reqs) {
1452                 struct io_kiocb *req = container_of(node, struct io_kiocb,
1453                                             comp_list);
1454
1455                 if (!(req->flags & REQ_F_CQE_SKIP) &&
1456                     unlikely(!__io_fill_cqe_req(ctx, req))) {
1457                         if (ctx->task_complete) {
1458                                 spin_lock(&ctx->completion_lock);
1459                                 io_req_cqe_overflow(req);
1460                                 spin_unlock(&ctx->completion_lock);
1461                         } else {
1462                                 io_req_cqe_overflow(req);
1463                         }
1464                 }
1465         }
1466         __io_cq_unlock_post(ctx);
1467
1468         if (!wq_list_empty(&ctx->submit_state.compl_reqs)) {
1469                 io_free_batch_list(ctx, state->compl_reqs.first);
1470                 INIT_WQ_LIST(&state->compl_reqs);
1471         }
1472 }
1473
1474 /*
1475  * Drop reference to request, return next in chain (if there is one) if this
1476  * was the last reference to this request.
1477  */
1478 static inline struct io_kiocb *io_put_req_find_next(struct io_kiocb *req)
1479 {
1480         struct io_kiocb *nxt = NULL;
1481
1482         if (req_ref_put_and_test(req)) {
1483                 if (unlikely(req->flags & IO_REQ_LINK_FLAGS))
1484                         nxt = io_req_find_next(req);
1485                 io_free_req(req);
1486         }
1487         return nxt;
1488 }
1489
1490 static unsigned io_cqring_events(struct io_ring_ctx *ctx)
1491 {
1492         /* See comment at the top of this file */
1493         smp_rmb();
1494         return __io_cqring_events(ctx);
1495 }
1496
1497 /*
1498  * We can't just wait for polled events to come to us, we have to actively
1499  * find and complete them.
1500  */
1501 static __cold void io_iopoll_try_reap_events(struct io_ring_ctx *ctx)
1502 {
1503         if (!(ctx->flags & IORING_SETUP_IOPOLL))
1504                 return;
1505
1506         mutex_lock(&ctx->uring_lock);
1507         while (!wq_list_empty(&ctx->iopoll_list)) {
1508                 /* let it sleep and repeat later if can't complete a request */
1509                 if (io_do_iopoll(ctx, true) == 0)
1510                         break;
1511                 /*
1512                  * Ensure we allow local-to-the-cpu processing to take place,
1513                  * in this case we need to ensure that we reap all events.
1514                  * Also let task_work, etc. to progress by releasing the mutex
1515                  */
1516                 if (need_resched()) {
1517                         mutex_unlock(&ctx->uring_lock);
1518                         cond_resched();
1519                         mutex_lock(&ctx->uring_lock);
1520                 }
1521         }
1522         mutex_unlock(&ctx->uring_lock);
1523 }
1524
1525 static int io_iopoll_check(struct io_ring_ctx *ctx, long min)
1526 {
1527         unsigned int nr_events = 0;
1528         int ret = 0;
1529         unsigned long check_cq;
1530
1531         if (!io_allowed_run_tw(ctx))
1532                 return -EEXIST;
1533
1534         check_cq = READ_ONCE(ctx->check_cq);
1535         if (unlikely(check_cq)) {
1536                 if (check_cq & BIT(IO_CHECK_CQ_OVERFLOW_BIT))
1537                         __io_cqring_overflow_flush(ctx);
1538                 /*
1539                  * Similarly do not spin if we have not informed the user of any
1540                  * dropped CQE.
1541                  */
1542                 if (check_cq & BIT(IO_CHECK_CQ_DROPPED_BIT))
1543                         return -EBADR;
1544         }
1545         /*
1546          * Don't enter poll loop if we already have events pending.
1547          * If we do, we can potentially be spinning for commands that
1548          * already triggered a CQE (eg in error).
1549          */
1550         if (io_cqring_events(ctx))
1551                 return 0;
1552
1553         do {
1554                 /*
1555                  * If a submit got punted to a workqueue, we can have the
1556                  * application entering polling for a command before it gets
1557                  * issued. That app will hold the uring_lock for the duration
1558                  * of the poll right here, so we need to take a breather every
1559                  * now and then to ensure that the issue has a chance to add
1560                  * the poll to the issued list. Otherwise we can spin here
1561                  * forever, while the workqueue is stuck trying to acquire the
1562                  * very same mutex.
1563                  */
1564                 if (wq_list_empty(&ctx->iopoll_list) ||
1565                     io_task_work_pending(ctx)) {
1566                         u32 tail = ctx->cached_cq_tail;
1567
1568                         (void) io_run_local_work_locked(ctx);
1569
1570                         if (task_work_pending(current) ||
1571                             wq_list_empty(&ctx->iopoll_list)) {
1572                                 mutex_unlock(&ctx->uring_lock);
1573                                 io_run_task_work();
1574                                 mutex_lock(&ctx->uring_lock);
1575                         }
1576                         /* some requests don't go through iopoll_list */
1577                         if (tail != ctx->cached_cq_tail ||
1578                             wq_list_empty(&ctx->iopoll_list))
1579                                 break;
1580                 }
1581                 ret = io_do_iopoll(ctx, !min);
1582                 if (ret < 0)
1583                         break;
1584                 nr_events += ret;
1585                 ret = 0;
1586         } while (nr_events < min && !need_resched());
1587
1588         return ret;
1589 }
1590
1591 void io_req_task_complete(struct io_kiocb *req, bool *locked)
1592 {
1593         if (*locked)
1594                 io_req_complete_defer(req);
1595         else
1596                 io_req_complete_post(req, IO_URING_F_UNLOCKED);
1597 }
1598
1599 /*
1600  * After the iocb has been issued, it's safe to be found on the poll list.
1601  * Adding the kiocb to the list AFTER submission ensures that we don't
1602  * find it from a io_do_iopoll() thread before the issuer is done
1603  * accessing the kiocb cookie.
1604  */
1605 static void io_iopoll_req_issued(struct io_kiocb *req, unsigned int issue_flags)
1606 {
1607         struct io_ring_ctx *ctx = req->ctx;
1608         const bool needs_lock = issue_flags & IO_URING_F_UNLOCKED;
1609
1610         /* workqueue context doesn't hold uring_lock, grab it now */
1611         if (unlikely(needs_lock))
1612                 mutex_lock(&ctx->uring_lock);
1613
1614         /*
1615          * Track whether we have multiple files in our lists. This will impact
1616          * how we do polling eventually, not spinning if we're on potentially
1617          * different devices.
1618          */
1619         if (wq_list_empty(&ctx->iopoll_list)) {
1620                 ctx->poll_multi_queue = false;
1621         } else if (!ctx->poll_multi_queue) {
1622                 struct io_kiocb *list_req;
1623
1624                 list_req = container_of(ctx->iopoll_list.first, struct io_kiocb,
1625                                         comp_list);
1626                 if (list_req->file != req->file)
1627                         ctx->poll_multi_queue = true;
1628         }
1629
1630         /*
1631          * For fast devices, IO may have already completed. If it has, add
1632          * it to the front so we find it first.
1633          */
1634         if (READ_ONCE(req->iopoll_completed))
1635                 wq_list_add_head(&req->comp_list, &ctx->iopoll_list);
1636         else
1637                 wq_list_add_tail(&req->comp_list, &ctx->iopoll_list);
1638
1639         if (unlikely(needs_lock)) {
1640                 /*
1641                  * If IORING_SETUP_SQPOLL is enabled, sqes are either handle
1642                  * in sq thread task context or in io worker task context. If
1643                  * current task context is sq thread, we don't need to check
1644                  * whether should wake up sq thread.
1645                  */
1646                 if ((ctx->flags & IORING_SETUP_SQPOLL) &&
1647                     wq_has_sleeper(&ctx->sq_data->wait))
1648                         wake_up(&ctx->sq_data->wait);
1649
1650                 mutex_unlock(&ctx->uring_lock);
1651         }
1652 }
1653
1654 static bool io_bdev_nowait(struct block_device *bdev)
1655 {
1656         return !bdev || bdev_nowait(bdev);
1657 }
1658
1659 /*
1660  * If we tracked the file through the SCM inflight mechanism, we could support
1661  * any file. For now, just ensure that anything potentially problematic is done
1662  * inline.
1663  */
1664 static bool __io_file_supports_nowait(struct file *file, umode_t mode)
1665 {
1666         if (S_ISBLK(mode)) {
1667                 if (IS_ENABLED(CONFIG_BLOCK) &&
1668                     io_bdev_nowait(I_BDEV(file->f_mapping->host)))
1669                         return true;
1670                 return false;
1671         }
1672         if (S_ISSOCK(mode))
1673                 return true;
1674         if (S_ISREG(mode)) {
1675                 if (IS_ENABLED(CONFIG_BLOCK) &&
1676                     io_bdev_nowait(file->f_inode->i_sb->s_bdev) &&
1677                     !io_is_uring_fops(file))
1678                         return true;
1679                 return false;
1680         }
1681
1682         /* any ->read/write should understand O_NONBLOCK */
1683         if (file->f_flags & O_NONBLOCK)
1684                 return true;
1685         return file->f_mode & FMODE_NOWAIT;
1686 }
1687
1688 /*
1689  * If we tracked the file through the SCM inflight mechanism, we could support
1690  * any file. For now, just ensure that anything potentially problematic is done
1691  * inline.
1692  */
1693 unsigned int io_file_get_flags(struct file *file)
1694 {
1695         umode_t mode = file_inode(file)->i_mode;
1696         unsigned int res = 0;
1697
1698         if (S_ISREG(mode))
1699                 res |= FFS_ISREG;
1700         if (__io_file_supports_nowait(file, mode))
1701                 res |= FFS_NOWAIT;
1702         return res;
1703 }
1704
1705 bool io_alloc_async_data(struct io_kiocb *req)
1706 {
1707         WARN_ON_ONCE(!io_op_defs[req->opcode].async_size);
1708         req->async_data = kmalloc(io_op_defs[req->opcode].async_size, GFP_KERNEL);
1709         if (req->async_data) {
1710                 req->flags |= REQ_F_ASYNC_DATA;
1711                 return false;
1712         }
1713         return true;
1714 }
1715
1716 int io_req_prep_async(struct io_kiocb *req)
1717 {
1718         const struct io_op_def *def = &io_op_defs[req->opcode];
1719
1720         /* assign early for deferred execution for non-fixed file */
1721         if (def->needs_file && !(req->flags & REQ_F_FIXED_FILE))
1722                 req->file = io_file_get_normal(req, req->cqe.fd);
1723         if (!def->prep_async)
1724                 return 0;
1725         if (WARN_ON_ONCE(req_has_async_data(req)))
1726                 return -EFAULT;
1727         if (!io_op_defs[req->opcode].manual_alloc) {
1728                 if (io_alloc_async_data(req))
1729                         return -EAGAIN;
1730         }
1731         return def->prep_async(req);
1732 }
1733
1734 static u32 io_get_sequence(struct io_kiocb *req)
1735 {
1736         u32 seq = req->ctx->cached_sq_head;
1737         struct io_kiocb *cur;
1738
1739         /* need original cached_sq_head, but it was increased for each req */
1740         io_for_each_link(cur, req)
1741                 seq--;
1742         return seq;
1743 }
1744
1745 static __cold void io_drain_req(struct io_kiocb *req)
1746         __must_hold(&ctx->uring_lock)
1747 {
1748         struct io_ring_ctx *ctx = req->ctx;
1749         struct io_defer_entry *de;
1750         int ret;
1751         u32 seq = io_get_sequence(req);
1752
1753         /* Still need defer if there is pending req in defer list. */
1754         spin_lock(&ctx->completion_lock);
1755         if (!req_need_defer(req, seq) && list_empty_careful(&ctx->defer_list)) {
1756                 spin_unlock(&ctx->completion_lock);
1757 queue:
1758                 ctx->drain_active = false;
1759                 io_req_task_queue(req);
1760                 return;
1761         }
1762         spin_unlock(&ctx->completion_lock);
1763
1764         io_prep_async_link(req);
1765         de = kmalloc(sizeof(*de), GFP_KERNEL);
1766         if (!de) {
1767                 ret = -ENOMEM;
1768                 io_req_defer_failed(req, ret);
1769                 return;
1770         }
1771
1772         spin_lock(&ctx->completion_lock);
1773         if (!req_need_defer(req, seq) && list_empty(&ctx->defer_list)) {
1774                 spin_unlock(&ctx->completion_lock);
1775                 kfree(de);
1776                 goto queue;
1777         }
1778
1779         trace_io_uring_defer(req);
1780         de->req = req;
1781         de->seq = seq;
1782         list_add_tail(&de->list, &ctx->defer_list);
1783         spin_unlock(&ctx->completion_lock);
1784 }
1785
1786 static void io_clean_op(struct io_kiocb *req)
1787 {
1788         if (req->flags & REQ_F_BUFFER_SELECTED) {
1789                 spin_lock(&req->ctx->completion_lock);
1790                 io_put_kbuf_comp(req);
1791                 spin_unlock(&req->ctx->completion_lock);
1792         }
1793
1794         if (req->flags & REQ_F_NEED_CLEANUP) {
1795                 const struct io_op_def *def = &io_op_defs[req->opcode];
1796
1797                 if (def->cleanup)
1798                         def->cleanup(req);
1799         }
1800         if ((req->flags & REQ_F_POLLED) && req->apoll) {
1801                 kfree(req->apoll->double_poll);
1802                 kfree(req->apoll);
1803                 req->apoll = NULL;
1804         }
1805         if (req->flags & REQ_F_INFLIGHT) {
1806                 struct io_uring_task *tctx = req->task->io_uring;
1807
1808                 atomic_dec(&tctx->inflight_tracked);
1809         }
1810         if (req->flags & REQ_F_CREDS)
1811                 put_cred(req->creds);
1812         if (req->flags & REQ_F_ASYNC_DATA) {
1813                 kfree(req->async_data);
1814                 req->async_data = NULL;
1815         }
1816         req->flags &= ~IO_REQ_CLEAN_FLAGS;
1817 }
1818
1819 static bool io_assign_file(struct io_kiocb *req, unsigned int issue_flags)
1820 {
1821         if (req->file || !io_op_defs[req->opcode].needs_file)
1822                 return true;
1823
1824         if (req->flags & REQ_F_FIXED_FILE)
1825                 req->file = io_file_get_fixed(req, req->cqe.fd, issue_flags);
1826         else
1827                 req->file = io_file_get_normal(req, req->cqe.fd);
1828
1829         return !!req->file;
1830 }
1831
1832 static int io_issue_sqe(struct io_kiocb *req, unsigned int issue_flags)
1833 {
1834         const struct io_op_def *def = &io_op_defs[req->opcode];
1835         const struct cred *creds = NULL;
1836         int ret;
1837
1838         if (unlikely(!io_assign_file(req, issue_flags)))
1839                 return -EBADF;
1840
1841         if (unlikely((req->flags & REQ_F_CREDS) && req->creds != current_cred()))
1842                 creds = override_creds(req->creds);
1843
1844         if (!def->audit_skip)
1845                 audit_uring_entry(req->opcode);
1846
1847         ret = def->issue(req, issue_flags);
1848
1849         if (!def->audit_skip)
1850                 audit_uring_exit(!ret, ret);
1851
1852         if (creds)
1853                 revert_creds(creds);
1854
1855         if (ret == IOU_OK) {
1856                 if (issue_flags & IO_URING_F_COMPLETE_DEFER)
1857                         io_req_complete_defer(req);
1858                 else
1859                         io_req_complete_post(req, issue_flags);
1860         } else if (ret != IOU_ISSUE_SKIP_COMPLETE)
1861                 return ret;
1862
1863         /* If the op doesn't have a file, we're not polling for it */
1864         if ((req->ctx->flags & IORING_SETUP_IOPOLL) && def->iopoll_queue)
1865                 io_iopoll_req_issued(req, issue_flags);
1866
1867         return 0;
1868 }
1869
1870 int io_poll_issue(struct io_kiocb *req, bool *locked)
1871 {
1872         io_tw_lock(req->ctx, locked);
1873         return io_issue_sqe(req, IO_URING_F_NONBLOCK|IO_URING_F_MULTISHOT|
1874                                  IO_URING_F_COMPLETE_DEFER);
1875 }
1876
1877 struct io_wq_work *io_wq_free_work(struct io_wq_work *work)
1878 {
1879         struct io_kiocb *req = container_of(work, struct io_kiocb, work);
1880
1881         req = io_put_req_find_next(req);
1882         return req ? &req->work : NULL;
1883 }
1884
1885 void io_wq_submit_work(struct io_wq_work *work)
1886 {
1887         struct io_kiocb *req = container_of(work, struct io_kiocb, work);
1888         const struct io_op_def *def = &io_op_defs[req->opcode];
1889         unsigned int issue_flags = IO_URING_F_UNLOCKED | IO_URING_F_IOWQ;
1890         bool needs_poll = false;
1891         int ret = 0, err = -ECANCELED;
1892
1893         /* one will be dropped by ->io_wq_free_work() after returning to io-wq */
1894         if (!(req->flags & REQ_F_REFCOUNT))
1895                 __io_req_set_refcount(req, 2);
1896         else
1897                 req_ref_get(req);
1898
1899         io_arm_ltimeout(req);
1900
1901         /* either cancelled or io-wq is dying, so don't touch tctx->iowq */
1902         if (work->flags & IO_WQ_WORK_CANCEL) {
1903 fail:
1904                 io_req_task_queue_fail(req, err);
1905                 return;
1906         }
1907         if (!io_assign_file(req, issue_flags)) {
1908                 err = -EBADF;
1909                 work->flags |= IO_WQ_WORK_CANCEL;
1910                 goto fail;
1911         }
1912
1913         if (req->flags & REQ_F_FORCE_ASYNC) {
1914                 bool opcode_poll = def->pollin || def->pollout;
1915
1916                 if (opcode_poll && file_can_poll(req->file)) {
1917                         needs_poll = true;
1918                         issue_flags |= IO_URING_F_NONBLOCK;
1919                 }
1920         }
1921
1922         do {
1923                 ret = io_issue_sqe(req, issue_flags);
1924                 if (ret != -EAGAIN)
1925                         break;
1926                 /*
1927                  * We can get EAGAIN for iopolled IO even though we're
1928                  * forcing a sync submission from here, since we can't
1929                  * wait for request slots on the block side.
1930                  */
1931                 if (!needs_poll) {
1932                         if (!(req->ctx->flags & IORING_SETUP_IOPOLL))
1933                                 break;
1934                         cond_resched();
1935                         continue;
1936                 }
1937
1938                 if (io_arm_poll_handler(req, issue_flags) == IO_APOLL_OK)
1939                         return;
1940                 /* aborted or ready, in either case retry blocking */
1941                 needs_poll = false;
1942                 issue_flags &= ~IO_URING_F_NONBLOCK;
1943         } while (1);
1944
1945         /* avoid locking problems by failing it from a clean context */
1946         if (ret < 0)
1947                 io_req_task_queue_fail(req, ret);
1948 }
1949
1950 inline struct file *io_file_get_fixed(struct io_kiocb *req, int fd,
1951                                       unsigned int issue_flags)
1952 {
1953         struct io_ring_ctx *ctx = req->ctx;
1954         struct file *file = NULL;
1955         unsigned long file_ptr;
1956
1957         io_ring_submit_lock(ctx, issue_flags);
1958
1959         if (unlikely((unsigned int)fd >= ctx->nr_user_files))
1960                 goto out;
1961         fd = array_index_nospec(fd, ctx->nr_user_files);
1962         file_ptr = io_fixed_file_slot(&ctx->file_table, fd)->file_ptr;
1963         file = (struct file *) (file_ptr & FFS_MASK);
1964         file_ptr &= ~FFS_MASK;
1965         /* mask in overlapping REQ_F and FFS bits */
1966         req->flags |= (file_ptr << REQ_F_SUPPORT_NOWAIT_BIT);
1967         io_req_set_rsrc_node(req, ctx, 0);
1968 out:
1969         io_ring_submit_unlock(ctx, issue_flags);
1970         return file;
1971 }
1972
1973 struct file *io_file_get_normal(struct io_kiocb *req, int fd)
1974 {
1975         struct file *file = fget(fd);
1976
1977         trace_io_uring_file_get(req, fd);
1978
1979         /* we don't allow fixed io_uring files */
1980         if (file && io_is_uring_fops(file))
1981                 io_req_track_inflight(req);
1982         return file;
1983 }
1984
1985 static void io_queue_async(struct io_kiocb *req, int ret)
1986         __must_hold(&req->ctx->uring_lock)
1987 {
1988         struct io_kiocb *linked_timeout;
1989
1990         if (ret != -EAGAIN || (req->flags & REQ_F_NOWAIT)) {
1991                 io_req_defer_failed(req, ret);
1992                 return;
1993         }
1994
1995         linked_timeout = io_prep_linked_timeout(req);
1996
1997         switch (io_arm_poll_handler(req, 0)) {
1998         case IO_APOLL_READY:
1999                 io_kbuf_recycle(req, 0);
2000                 io_req_task_queue(req);
2001                 break;
2002         case IO_APOLL_ABORTED:
2003                 io_kbuf_recycle(req, 0);
2004                 io_queue_iowq(req, NULL);
2005                 break;
2006         case IO_APOLL_OK:
2007                 break;
2008         }
2009
2010         if (linked_timeout)
2011                 io_queue_linked_timeout(linked_timeout);
2012 }
2013
2014 static inline void io_queue_sqe(struct io_kiocb *req)
2015         __must_hold(&req->ctx->uring_lock)
2016 {
2017         int ret;
2018
2019         ret = io_issue_sqe(req, IO_URING_F_NONBLOCK|IO_URING_F_COMPLETE_DEFER);
2020
2021         /*
2022          * We async punt it if the file wasn't marked NOWAIT, or if the file
2023          * doesn't support non-blocking read/write attempts
2024          */
2025         if (likely(!ret))
2026                 io_arm_ltimeout(req);
2027         else
2028                 io_queue_async(req, ret);
2029 }
2030
2031 static void io_queue_sqe_fallback(struct io_kiocb *req)
2032         __must_hold(&req->ctx->uring_lock)
2033 {
2034         if (unlikely(req->flags & REQ_F_FAIL)) {
2035                 /*
2036                  * We don't submit, fail them all, for that replace hardlinks
2037                  * with normal links. Extra REQ_F_LINK is tolerated.
2038                  */
2039                 req->flags &= ~REQ_F_HARDLINK;
2040                 req->flags |= REQ_F_LINK;
2041                 io_req_defer_failed(req, req->cqe.res);
2042         } else {
2043                 int ret = io_req_prep_async(req);
2044
2045                 if (unlikely(ret)) {
2046                         io_req_defer_failed(req, ret);
2047                         return;
2048                 }
2049
2050                 if (unlikely(req->ctx->drain_active))
2051                         io_drain_req(req);
2052                 else
2053                         io_queue_iowq(req, NULL);
2054         }
2055 }
2056
2057 /*
2058  * Check SQE restrictions (opcode and flags).
2059  *
2060  * Returns 'true' if SQE is allowed, 'false' otherwise.
2061  */
2062 static inline bool io_check_restriction(struct io_ring_ctx *ctx,
2063                                         struct io_kiocb *req,
2064                                         unsigned int sqe_flags)
2065 {
2066         if (!test_bit(req->opcode, ctx->restrictions.sqe_op))
2067                 return false;
2068
2069         if ((sqe_flags & ctx->restrictions.sqe_flags_required) !=
2070             ctx->restrictions.sqe_flags_required)
2071                 return false;
2072
2073         if (sqe_flags & ~(ctx->restrictions.sqe_flags_allowed |
2074                           ctx->restrictions.sqe_flags_required))
2075                 return false;
2076
2077         return true;
2078 }
2079
2080 static void io_init_req_drain(struct io_kiocb *req)
2081 {
2082         struct io_ring_ctx *ctx = req->ctx;
2083         struct io_kiocb *head = ctx->submit_state.link.head;
2084
2085         ctx->drain_active = true;
2086         if (head) {
2087                 /*
2088                  * If we need to drain a request in the middle of a link, drain
2089                  * the head request and the next request/link after the current
2090                  * link. Considering sequential execution of links,
2091                  * REQ_F_IO_DRAIN will be maintained for every request of our
2092                  * link.
2093                  */
2094                 head->flags |= REQ_F_IO_DRAIN | REQ_F_FORCE_ASYNC;
2095                 ctx->drain_next = true;
2096         }
2097 }
2098
2099 static int io_init_req(struct io_ring_ctx *ctx, struct io_kiocb *req,
2100                        const struct io_uring_sqe *sqe)
2101         __must_hold(&ctx->uring_lock)
2102 {
2103         const struct io_op_def *def;
2104         unsigned int sqe_flags;
2105         int personality;
2106         u8 opcode;
2107
2108         /* req is partially pre-initialised, see io_preinit_req() */
2109         req->opcode = opcode = READ_ONCE(sqe->opcode);
2110         /* same numerical values with corresponding REQ_F_*, safe to copy */
2111         req->flags = sqe_flags = READ_ONCE(sqe->flags);
2112         req->cqe.user_data = READ_ONCE(sqe->user_data);
2113         req->file = NULL;
2114         req->rsrc_node = NULL;
2115         req->task = current;
2116
2117         if (unlikely(opcode >= IORING_OP_LAST)) {
2118                 req->opcode = 0;
2119                 return -EINVAL;
2120         }
2121         def = &io_op_defs[opcode];
2122         if (unlikely(sqe_flags & ~SQE_COMMON_FLAGS)) {
2123                 /* enforce forwards compatibility on users */
2124                 if (sqe_flags & ~SQE_VALID_FLAGS)
2125                         return -EINVAL;
2126                 if (sqe_flags & IOSQE_BUFFER_SELECT) {
2127                         if (!def->buffer_select)
2128                                 return -EOPNOTSUPP;
2129                         req->buf_index = READ_ONCE(sqe->buf_group);
2130                 }
2131                 if (sqe_flags & IOSQE_CQE_SKIP_SUCCESS)
2132                         ctx->drain_disabled = true;
2133                 if (sqe_flags & IOSQE_IO_DRAIN) {
2134                         if (ctx->drain_disabled)
2135                                 return -EOPNOTSUPP;
2136                         io_init_req_drain(req);
2137                 }
2138         }
2139         if (unlikely(ctx->restricted || ctx->drain_active || ctx->drain_next)) {
2140                 if (ctx->restricted && !io_check_restriction(ctx, req, sqe_flags))
2141                         return -EACCES;
2142                 /* knock it to the slow queue path, will be drained there */
2143                 if (ctx->drain_active)
2144                         req->flags |= REQ_F_FORCE_ASYNC;
2145                 /* if there is no link, we're at "next" request and need to drain */
2146                 if (unlikely(ctx->drain_next) && !ctx->submit_state.link.head) {
2147                         ctx->drain_next = false;
2148                         ctx->drain_active = true;
2149                         req->flags |= REQ_F_IO_DRAIN | REQ_F_FORCE_ASYNC;
2150                 }
2151         }
2152
2153         if (!def->ioprio && sqe->ioprio)
2154                 return -EINVAL;
2155         if (!def->iopoll && (ctx->flags & IORING_SETUP_IOPOLL))
2156                 return -EINVAL;
2157
2158         if (def->needs_file) {
2159                 struct io_submit_state *state = &ctx->submit_state;
2160
2161                 req->cqe.fd = READ_ONCE(sqe->fd);
2162
2163                 /*
2164                  * Plug now if we have more than 2 IO left after this, and the
2165                  * target is potentially a read/write to block based storage.
2166                  */
2167                 if (state->need_plug && def->plug) {
2168                         state->plug_started = true;
2169                         state->need_plug = false;
2170                         blk_start_plug_nr_ios(&state->plug, state->submit_nr);
2171                 }
2172         }
2173
2174         personality = READ_ONCE(sqe->personality);
2175         if (personality) {
2176                 int ret;
2177
2178                 req->creds = xa_load(&ctx->personalities, personality);
2179                 if (!req->creds)
2180                         return -EINVAL;
2181                 get_cred(req->creds);
2182                 ret = security_uring_override_creds(req->creds);
2183                 if (ret) {
2184                         put_cred(req->creds);
2185                         return ret;
2186                 }
2187                 req->flags |= REQ_F_CREDS;
2188         }
2189
2190         return def->prep(req, sqe);
2191 }
2192
2193 static __cold int io_submit_fail_init(const struct io_uring_sqe *sqe,
2194                                       struct io_kiocb *req, int ret)
2195 {
2196         struct io_ring_ctx *ctx = req->ctx;
2197         struct io_submit_link *link = &ctx->submit_state.link;
2198         struct io_kiocb *head = link->head;
2199
2200         trace_io_uring_req_failed(sqe, req, ret);
2201
2202         /*
2203          * Avoid breaking links in the middle as it renders links with SQPOLL
2204          * unusable. Instead of failing eagerly, continue assembling the link if
2205          * applicable and mark the head with REQ_F_FAIL. The link flushing code
2206          * should find the flag and handle the rest.
2207          */
2208         req_fail_link_node(req, ret);
2209         if (head && !(head->flags & REQ_F_FAIL))
2210                 req_fail_link_node(head, -ECANCELED);
2211
2212         if (!(req->flags & IO_REQ_LINK_FLAGS)) {
2213                 if (head) {
2214                         link->last->link = req;
2215                         link->head = NULL;
2216                         req = head;
2217                 }
2218                 io_queue_sqe_fallback(req);
2219                 return ret;
2220         }
2221
2222         if (head)
2223                 link->last->link = req;
2224         else
2225                 link->head = req;
2226         link->last = req;
2227         return 0;
2228 }
2229
2230 static inline int io_submit_sqe(struct io_ring_ctx *ctx, struct io_kiocb *req,
2231                          const struct io_uring_sqe *sqe)
2232         __must_hold(&ctx->uring_lock)
2233 {
2234         struct io_submit_link *link = &ctx->submit_state.link;
2235         int ret;
2236
2237         ret = io_init_req(ctx, req, sqe);
2238         if (unlikely(ret))
2239                 return io_submit_fail_init(sqe, req, ret);
2240
2241         /* don't need @sqe from now on */
2242         trace_io_uring_submit_sqe(req, true);
2243
2244         /*
2245          * If we already have a head request, queue this one for async
2246          * submittal once the head completes. If we don't have a head but
2247          * IOSQE_IO_LINK is set in the sqe, start a new head. This one will be
2248          * submitted sync once the chain is complete. If none of those
2249          * conditions are true (normal request), then just queue it.
2250          */
2251         if (unlikely(link->head)) {
2252                 ret = io_req_prep_async(req);
2253                 if (unlikely(ret))
2254                         return io_submit_fail_init(sqe, req, ret);
2255
2256                 trace_io_uring_link(req, link->head);
2257                 link->last->link = req;
2258                 link->last = req;
2259
2260                 if (req->flags & IO_REQ_LINK_FLAGS)
2261                         return 0;
2262                 /* last request of the link, flush it */
2263                 req = link->head;
2264                 link->head = NULL;
2265                 if (req->flags & (REQ_F_FORCE_ASYNC | REQ_F_FAIL))
2266                         goto fallback;
2267
2268         } else if (unlikely(req->flags & (IO_REQ_LINK_FLAGS |
2269                                           REQ_F_FORCE_ASYNC | REQ_F_FAIL))) {
2270                 if (req->flags & IO_REQ_LINK_FLAGS) {
2271                         link->head = req;
2272                         link->last = req;
2273                 } else {
2274 fallback:
2275                         io_queue_sqe_fallback(req);
2276                 }
2277                 return 0;
2278         }
2279
2280         io_queue_sqe(req);
2281         return 0;
2282 }
2283
2284 /*
2285  * Batched submission is done, ensure local IO is flushed out.
2286  */
2287 static void io_submit_state_end(struct io_ring_ctx *ctx)
2288 {
2289         struct io_submit_state *state = &ctx->submit_state;
2290
2291         if (unlikely(state->link.head))
2292                 io_queue_sqe_fallback(state->link.head);
2293         /* flush only after queuing links as they can generate completions */
2294         io_submit_flush_completions(ctx);
2295         if (state->plug_started)
2296                 blk_finish_plug(&state->plug);
2297 }
2298
2299 /*
2300  * Start submission side cache.
2301  */
2302 static void io_submit_state_start(struct io_submit_state *state,
2303                                   unsigned int max_ios)
2304 {
2305         state->plug_started = false;
2306         state->need_plug = max_ios > 2;
2307         state->submit_nr = max_ios;
2308         /* set only head, no need to init link_last in advance */
2309         state->link.head = NULL;
2310 }
2311
2312 static void io_commit_sqring(struct io_ring_ctx *ctx)
2313 {
2314         struct io_rings *rings = ctx->rings;
2315
2316         /*
2317          * Ensure any loads from the SQEs are done at this point,
2318          * since once we write the new head, the application could
2319          * write new data to them.
2320          */
2321         smp_store_release(&rings->sq.head, ctx->cached_sq_head);
2322 }
2323
2324 /*
2325  * Fetch an sqe, if one is available. Note this returns a pointer to memory
2326  * that is mapped by userspace. This means that care needs to be taken to
2327  * ensure that reads are stable, as we cannot rely on userspace always
2328  * being a good citizen. If members of the sqe are validated and then later
2329  * used, it's important that those reads are done through READ_ONCE() to
2330  * prevent a re-load down the line.
2331  */
2332 static const struct io_uring_sqe *io_get_sqe(struct io_ring_ctx *ctx)
2333 {
2334         unsigned head, mask = ctx->sq_entries - 1;
2335         unsigned sq_idx = ctx->cached_sq_head++ & mask;
2336
2337         /*
2338          * The cached sq head (or cq tail) serves two purposes:
2339          *
2340          * 1) allows us to batch the cost of updating the user visible
2341          *    head updates.
2342          * 2) allows the kernel side to track the head on its own, even
2343          *    though the application is the one updating it.
2344          */
2345         head = READ_ONCE(ctx->sq_array[sq_idx]);
2346         if (likely(head < ctx->sq_entries)) {
2347                 /* double index for 128-byte SQEs, twice as long */
2348                 if (ctx->flags & IORING_SETUP_SQE128)
2349                         head <<= 1;
2350                 return &ctx->sq_sqes[head];
2351         }
2352
2353         /* drop invalid entries */
2354         ctx->cq_extra--;
2355         WRITE_ONCE(ctx->rings->sq_dropped,
2356                    READ_ONCE(ctx->rings->sq_dropped) + 1);
2357         return NULL;
2358 }
2359
2360 int io_submit_sqes(struct io_ring_ctx *ctx, unsigned int nr)
2361         __must_hold(&ctx->uring_lock)
2362 {
2363         unsigned int entries = io_sqring_entries(ctx);
2364         unsigned int left;
2365         int ret;
2366
2367         if (unlikely(!entries))
2368                 return 0;
2369         /* make sure SQ entry isn't read before tail */
2370         ret = left = min3(nr, ctx->sq_entries, entries);
2371         io_get_task_refs(left);
2372         io_submit_state_start(&ctx->submit_state, left);
2373
2374         do {
2375                 const struct io_uring_sqe *sqe;
2376                 struct io_kiocb *req;
2377
2378                 if (unlikely(!io_alloc_req_refill(ctx)))
2379                         break;
2380                 req = io_alloc_req(ctx);
2381                 sqe = io_get_sqe(ctx);
2382                 if (unlikely(!sqe)) {
2383                         io_req_add_to_cache(req, ctx);
2384                         break;
2385                 }
2386
2387                 /*
2388                  * Continue submitting even for sqe failure if the
2389                  * ring was setup with IORING_SETUP_SUBMIT_ALL
2390                  */
2391                 if (unlikely(io_submit_sqe(ctx, req, sqe)) &&
2392                     !(ctx->flags & IORING_SETUP_SUBMIT_ALL)) {
2393                         left--;
2394                         break;
2395                 }
2396         } while (--left);
2397
2398         if (unlikely(left)) {
2399                 ret -= left;
2400                 /* try again if it submitted nothing and can't allocate a req */
2401                 if (!ret && io_req_cache_empty(ctx))
2402                         ret = -EAGAIN;
2403                 current->io_uring->cached_refs += left;
2404         }
2405
2406         io_submit_state_end(ctx);
2407          /* Commit SQ ring head once we've consumed and submitted all SQEs */
2408         io_commit_sqring(ctx);
2409         return ret;
2410 }
2411
2412 struct io_wait_queue {
2413         struct wait_queue_entry wq;
2414         struct io_ring_ctx *ctx;
2415         unsigned cq_tail;
2416         unsigned nr_timeouts;
2417 };
2418
2419 static inline bool io_has_work(struct io_ring_ctx *ctx)
2420 {
2421         return test_bit(IO_CHECK_CQ_OVERFLOW_BIT, &ctx->check_cq) ||
2422                ((ctx->flags & IORING_SETUP_DEFER_TASKRUN) &&
2423                 !llist_empty(&ctx->work_llist));
2424 }
2425
2426 static inline bool io_should_wake(struct io_wait_queue *iowq)
2427 {
2428         struct io_ring_ctx *ctx = iowq->ctx;
2429         int dist = READ_ONCE(ctx->rings->cq.tail) - (int) iowq->cq_tail;
2430
2431         /*
2432          * Wake up if we have enough events, or if a timeout occurred since we
2433          * started waiting. For timeouts, we always want to return to userspace,
2434          * regardless of event count.
2435          */
2436         return dist >= 0 || atomic_read(&ctx->cq_timeouts) != iowq->nr_timeouts;
2437 }
2438
2439 static int io_wake_function(struct wait_queue_entry *curr, unsigned int mode,
2440                             int wake_flags, void *key)
2441 {
2442         struct io_wait_queue *iowq = container_of(curr, struct io_wait_queue,
2443                                                         wq);
2444         struct io_ring_ctx *ctx = iowq->ctx;
2445
2446         /*
2447          * Cannot safely flush overflowed CQEs from here, ensure we wake up
2448          * the task, and the next invocation will do it.
2449          */
2450         if (io_should_wake(iowq) || io_has_work(ctx))
2451                 return autoremove_wake_function(curr, mode, wake_flags, key);
2452         return -1;
2453 }
2454
2455 int io_run_task_work_sig(struct io_ring_ctx *ctx)
2456 {
2457         if (!llist_empty(&ctx->work_llist)) {
2458                 if (io_run_local_work(ctx) > 0)
2459                         return 1;
2460         }
2461         if (io_run_task_work() > 0)
2462                 return 1;
2463         if (task_sigpending(current))
2464                 return -EINTR;
2465         return 0;
2466 }
2467
2468 /* when returns >0, the caller should retry */
2469 static inline int io_cqring_wait_schedule(struct io_ring_ctx *ctx,
2470                                           struct io_wait_queue *iowq,
2471                                           ktime_t *timeout)
2472 {
2473         if (unlikely(READ_ONCE(ctx->check_cq)))
2474                 return 1;
2475         if (unlikely(!llist_empty(&ctx->work_llist)))
2476                 return 1;
2477         if (unlikely(test_thread_flag(TIF_NOTIFY_SIGNAL)))
2478                 return 1;
2479         if (unlikely(task_sigpending(current)))
2480                 return -EINTR;
2481         if (unlikely(io_should_wake(iowq)))
2482                 return 0;
2483         if (!schedule_hrtimeout(timeout, HRTIMER_MODE_ABS))
2484                 return -ETIME;
2485         return 0;
2486 }
2487
2488 /*
2489  * Wait until events become available, if we don't already have some. The
2490  * application must reap them itself, as they reside on the shared cq ring.
2491  */
2492 static int io_cqring_wait(struct io_ring_ctx *ctx, int min_events,
2493                           const sigset_t __user *sig, size_t sigsz,
2494                           struct __kernel_timespec __user *uts)
2495 {
2496         struct io_wait_queue iowq;
2497         struct io_rings *rings = ctx->rings;
2498         ktime_t timeout = KTIME_MAX;
2499         int ret;
2500
2501         if (!io_allowed_run_tw(ctx))
2502                 return -EEXIST;
2503         if (!llist_empty(&ctx->work_llist))
2504                 io_run_local_work(ctx);
2505         io_run_task_work();
2506         io_cqring_overflow_flush(ctx);
2507         /* if user messes with these they will just get an early return */
2508         if (__io_cqring_events_user(ctx) >= min_events)
2509                 return 0;
2510
2511         if (sig) {
2512 #ifdef CONFIG_COMPAT
2513                 if (in_compat_syscall())
2514                         ret = set_compat_user_sigmask((const compat_sigset_t __user *)sig,
2515                                                       sigsz);
2516                 else
2517 #endif
2518                         ret = set_user_sigmask(sig, sigsz);
2519
2520                 if (ret)
2521                         return ret;
2522         }
2523
2524         if (uts) {
2525                 struct timespec64 ts;
2526
2527                 if (get_timespec64(&ts, uts))
2528                         return -EFAULT;
2529                 timeout = ktime_add_ns(timespec64_to_ktime(ts), ktime_get_ns());
2530         }
2531
2532         init_waitqueue_func_entry(&iowq.wq, io_wake_function);
2533         iowq.wq.private = current;
2534         INIT_LIST_HEAD(&iowq.wq.entry);
2535         iowq.ctx = ctx;
2536         iowq.nr_timeouts = atomic_read(&ctx->cq_timeouts);
2537         iowq.cq_tail = READ_ONCE(ctx->rings->cq.head) + min_events;
2538
2539         trace_io_uring_cqring_wait(ctx, min_events);
2540         do {
2541                 unsigned long check_cq;
2542
2543                 prepare_to_wait_exclusive(&ctx->cq_wait, &iowq.wq,
2544                                                 TASK_INTERRUPTIBLE);
2545                 ret = io_cqring_wait_schedule(ctx, &iowq, &timeout);
2546                 if (ret < 0)
2547                         break;
2548                 /*
2549                  * Run task_work after scheduling and before io_should_wake().
2550                  * If we got woken because of task_work being processed, run it
2551                  * now rather than let the caller do another wait loop.
2552                  */
2553                 io_run_task_work();
2554                 if (!llist_empty(&ctx->work_llist))
2555                         io_run_local_work(ctx);
2556
2557                 check_cq = READ_ONCE(ctx->check_cq);
2558                 if (unlikely(check_cq)) {
2559                         /* let the caller flush overflows, retry */
2560                         if (check_cq & BIT(IO_CHECK_CQ_OVERFLOW_BIT)) {
2561                                 finish_wait(&ctx->cq_wait, &iowq.wq);
2562                                 io_cqring_do_overflow_flush(ctx);
2563                         }
2564                         if (check_cq & BIT(IO_CHECK_CQ_DROPPED_BIT)) {
2565                                 ret = -EBADR;
2566                                 break;
2567                         }
2568                 }
2569
2570                 if (io_should_wake(&iowq)) {
2571                         ret = 0;
2572                         break;
2573                 }
2574                 cond_resched();
2575         } while (1);
2576
2577         finish_wait(&ctx->cq_wait, &iowq.wq);
2578         restore_saved_sigmask_unless(ret == -EINTR);
2579
2580         return READ_ONCE(rings->cq.head) == READ_ONCE(rings->cq.tail) ? ret : 0;
2581 }
2582
2583 static void io_mem_free(void *ptr)
2584 {
2585         struct page *page;
2586
2587         if (!ptr)
2588                 return;
2589
2590         page = virt_to_head_page(ptr);
2591         if (put_page_testzero(page))
2592                 free_compound_page(page);
2593 }
2594
2595 static void *io_mem_alloc(size_t size)
2596 {
2597         gfp_t gfp = GFP_KERNEL_ACCOUNT | __GFP_ZERO | __GFP_NOWARN | __GFP_COMP;
2598
2599         return (void *) __get_free_pages(gfp, get_order(size));
2600 }
2601
2602 static unsigned long rings_size(struct io_ring_ctx *ctx, unsigned int sq_entries,
2603                                 unsigned int cq_entries, size_t *sq_offset)
2604 {
2605         struct io_rings *rings;
2606         size_t off, sq_array_size;
2607
2608         off = struct_size(rings, cqes, cq_entries);
2609         if (off == SIZE_MAX)
2610                 return SIZE_MAX;
2611         if (ctx->flags & IORING_SETUP_CQE32) {
2612                 if (check_shl_overflow(off, 1, &off))
2613                         return SIZE_MAX;
2614         }
2615
2616 #ifdef CONFIG_SMP
2617         off = ALIGN(off, SMP_CACHE_BYTES);
2618         if (off == 0)
2619                 return SIZE_MAX;
2620 #endif
2621
2622         if (sq_offset)
2623                 *sq_offset = off;
2624
2625         sq_array_size = array_size(sizeof(u32), sq_entries);
2626         if (sq_array_size == SIZE_MAX)
2627                 return SIZE_MAX;
2628
2629         if (check_add_overflow(off, sq_array_size, &off))
2630                 return SIZE_MAX;
2631
2632         return off;
2633 }
2634
2635 static int io_eventfd_register(struct io_ring_ctx *ctx, void __user *arg,
2636                                unsigned int eventfd_async)
2637 {
2638         struct io_ev_fd *ev_fd;
2639         __s32 __user *fds = arg;
2640         int fd;
2641
2642         ev_fd = rcu_dereference_protected(ctx->io_ev_fd,
2643                                         lockdep_is_held(&ctx->uring_lock));
2644         if (ev_fd)
2645                 return -EBUSY;
2646
2647         if (copy_from_user(&fd, fds, sizeof(*fds)))
2648                 return -EFAULT;
2649
2650         ev_fd = kmalloc(sizeof(*ev_fd), GFP_KERNEL);
2651         if (!ev_fd)
2652                 return -ENOMEM;
2653
2654         ev_fd->cq_ev_fd = eventfd_ctx_fdget(fd);
2655         if (IS_ERR(ev_fd->cq_ev_fd)) {
2656                 int ret = PTR_ERR(ev_fd->cq_ev_fd);
2657                 kfree(ev_fd);
2658                 return ret;
2659         }
2660
2661         spin_lock(&ctx->completion_lock);
2662         ctx->evfd_last_cq_tail = ctx->cached_cq_tail;
2663         spin_unlock(&ctx->completion_lock);
2664
2665         ev_fd->eventfd_async = eventfd_async;
2666         ctx->has_evfd = true;
2667         rcu_assign_pointer(ctx->io_ev_fd, ev_fd);
2668         atomic_set(&ev_fd->refs, 1);
2669         atomic_set(&ev_fd->ops, 0);
2670         return 0;
2671 }
2672
2673 static int io_eventfd_unregister(struct io_ring_ctx *ctx)
2674 {
2675         struct io_ev_fd *ev_fd;
2676
2677         ev_fd = rcu_dereference_protected(ctx->io_ev_fd,
2678                                         lockdep_is_held(&ctx->uring_lock));
2679         if (ev_fd) {
2680                 ctx->has_evfd = false;
2681                 rcu_assign_pointer(ctx->io_ev_fd, NULL);
2682                 if (!atomic_fetch_or(BIT(IO_EVENTFD_OP_FREE_BIT), &ev_fd->ops))
2683                         call_rcu(&ev_fd->rcu, io_eventfd_ops);
2684                 return 0;
2685         }
2686
2687         return -ENXIO;
2688 }
2689
2690 static void io_req_caches_free(struct io_ring_ctx *ctx)
2691 {
2692         int nr = 0;
2693
2694         mutex_lock(&ctx->uring_lock);
2695         io_flush_cached_locked_reqs(ctx, &ctx->submit_state);
2696
2697         while (!io_req_cache_empty(ctx)) {
2698                 struct io_kiocb *req = io_alloc_req(ctx);
2699
2700                 kmem_cache_free(req_cachep, req);
2701                 nr++;
2702         }
2703         if (nr)
2704                 percpu_ref_put_many(&ctx->refs, nr);
2705         mutex_unlock(&ctx->uring_lock);
2706 }
2707
2708 static __cold void io_ring_ctx_free(struct io_ring_ctx *ctx)
2709 {
2710         io_sq_thread_finish(ctx);
2711         io_rsrc_refs_drop(ctx);
2712         /* __io_rsrc_put_work() may need uring_lock to progress, wait w/o it */
2713         io_wait_rsrc_data(ctx->buf_data);
2714         io_wait_rsrc_data(ctx->file_data);
2715
2716         mutex_lock(&ctx->uring_lock);
2717         if (ctx->buf_data)
2718                 __io_sqe_buffers_unregister(ctx);
2719         if (ctx->file_data)
2720                 __io_sqe_files_unregister(ctx);
2721         io_cqring_overflow_kill(ctx);
2722         io_eventfd_unregister(ctx);
2723         io_alloc_cache_free(&ctx->apoll_cache, io_apoll_cache_free);
2724         io_alloc_cache_free(&ctx->netmsg_cache, io_netmsg_cache_free);
2725         mutex_unlock(&ctx->uring_lock);
2726         io_destroy_buffers(ctx);
2727         if (ctx->sq_creds)
2728                 put_cred(ctx->sq_creds);
2729         if (ctx->submitter_task)
2730                 put_task_struct(ctx->submitter_task);
2731
2732         /* there are no registered resources left, nobody uses it */
2733         if (ctx->rsrc_node)
2734                 io_rsrc_node_destroy(ctx->rsrc_node);
2735         if (ctx->rsrc_backup_node)
2736                 io_rsrc_node_destroy(ctx->rsrc_backup_node);
2737         flush_delayed_work(&ctx->rsrc_put_work);
2738         flush_delayed_work(&ctx->fallback_work);
2739
2740         WARN_ON_ONCE(!list_empty(&ctx->rsrc_ref_list));
2741         WARN_ON_ONCE(!llist_empty(&ctx->rsrc_put_llist));
2742
2743 #if defined(CONFIG_UNIX)
2744         if (ctx->ring_sock) {
2745                 ctx->ring_sock->file = NULL; /* so that iput() is called */
2746                 sock_release(ctx->ring_sock);
2747         }
2748 #endif
2749         WARN_ON_ONCE(!list_empty(&ctx->ltimeout_list));
2750
2751         if (ctx->mm_account) {
2752                 mmdrop(ctx->mm_account);
2753                 ctx->mm_account = NULL;
2754         }
2755         io_mem_free(ctx->rings);
2756         io_mem_free(ctx->sq_sqes);
2757
2758         percpu_ref_exit(&ctx->refs);
2759         free_uid(ctx->user);
2760         io_req_caches_free(ctx);
2761         if (ctx->hash_map)
2762                 io_wq_put_hash(ctx->hash_map);
2763         kfree(ctx->cancel_table.hbs);
2764         kfree(ctx->cancel_table_locked.hbs);
2765         kfree(ctx->dummy_ubuf);
2766         kfree(ctx->io_bl);
2767         xa_destroy(&ctx->io_bl_xa);
2768         kfree(ctx);
2769 }
2770
2771 static __poll_t io_uring_poll(struct file *file, poll_table *wait)
2772 {
2773         struct io_ring_ctx *ctx = file->private_data;
2774         __poll_t mask = 0;
2775
2776         poll_wait(file, &ctx->cq_wait, wait);
2777         /*
2778          * synchronizes with barrier from wq_has_sleeper call in
2779          * io_commit_cqring
2780          */
2781         smp_rmb();
2782         if (!io_sqring_full(ctx))
2783                 mask |= EPOLLOUT | EPOLLWRNORM;
2784
2785         /*
2786          * Don't flush cqring overflow list here, just do a simple check.
2787          * Otherwise there could possible be ABBA deadlock:
2788          *      CPU0                    CPU1
2789          *      ----                    ----
2790          * lock(&ctx->uring_lock);
2791          *                              lock(&ep->mtx);
2792          *                              lock(&ctx->uring_lock);
2793          * lock(&ep->mtx);
2794          *
2795          * Users may get EPOLLIN meanwhile seeing nothing in cqring, this
2796          * pushes them to do the flush.
2797          */
2798
2799         if (io_cqring_events(ctx) || io_has_work(ctx))
2800                 mask |= EPOLLIN | EPOLLRDNORM;
2801
2802         return mask;
2803 }
2804
2805 static int io_unregister_personality(struct io_ring_ctx *ctx, unsigned id)
2806 {
2807         const struct cred *creds;
2808
2809         creds = xa_erase(&ctx->personalities, id);
2810         if (creds) {
2811                 put_cred(creds);
2812                 return 0;
2813         }
2814
2815         return -EINVAL;
2816 }
2817
2818 struct io_tctx_exit {
2819         struct callback_head            task_work;
2820         struct completion               completion;
2821         struct io_ring_ctx              *ctx;
2822 };
2823
2824 static __cold void io_tctx_exit_cb(struct callback_head *cb)
2825 {
2826         struct io_uring_task *tctx = current->io_uring;
2827         struct io_tctx_exit *work;
2828
2829         work = container_of(cb, struct io_tctx_exit, task_work);
2830         /*
2831          * When @in_idle, we're in cancellation and it's racy to remove the
2832          * node. It'll be removed by the end of cancellation, just ignore it.
2833          * tctx can be NULL if the queueing of this task_work raced with
2834          * work cancelation off the exec path.
2835          */
2836         if (tctx && !atomic_read(&tctx->in_idle))
2837                 io_uring_del_tctx_node((unsigned long)work->ctx);
2838         complete(&work->completion);
2839 }
2840
2841 static __cold bool io_cancel_ctx_cb(struct io_wq_work *work, void *data)
2842 {
2843         struct io_kiocb *req = container_of(work, struct io_kiocb, work);
2844
2845         return req->ctx == data;
2846 }
2847
2848 static __cold void io_ring_exit_work(struct work_struct *work)
2849 {
2850         struct io_ring_ctx *ctx = container_of(work, struct io_ring_ctx, exit_work);
2851         unsigned long timeout = jiffies + HZ * 60 * 5;
2852         unsigned long interval = HZ / 20;
2853         struct io_tctx_exit exit;
2854         struct io_tctx_node *node;
2855         int ret;
2856
2857         /*
2858          * If we're doing polled IO and end up having requests being
2859          * submitted async (out-of-line), then completions can come in while
2860          * we're waiting for refs to drop. We need to reap these manually,
2861          * as nobody else will be looking for them.
2862          */
2863         do {
2864                 if (test_bit(IO_CHECK_CQ_OVERFLOW_BIT, &ctx->check_cq)) {
2865                         mutex_lock(&ctx->uring_lock);
2866                         io_cqring_overflow_kill(ctx);
2867                         mutex_unlock(&ctx->uring_lock);
2868                 }
2869
2870                 if (ctx->flags & IORING_SETUP_DEFER_TASKRUN)
2871                         io_move_task_work_from_local(ctx);
2872
2873                 while (io_uring_try_cancel_requests(ctx, NULL, true))
2874                         cond_resched();
2875
2876                 if (ctx->sq_data) {
2877                         struct io_sq_data *sqd = ctx->sq_data;
2878                         struct task_struct *tsk;
2879
2880                         io_sq_thread_park(sqd);
2881                         tsk = sqd->thread;
2882                         if (tsk && tsk->io_uring && tsk->io_uring->io_wq)
2883                                 io_wq_cancel_cb(tsk->io_uring->io_wq,
2884                                                 io_cancel_ctx_cb, ctx, true);
2885                         io_sq_thread_unpark(sqd);
2886                 }
2887
2888                 io_req_caches_free(ctx);
2889
2890                 if (WARN_ON_ONCE(time_after(jiffies, timeout))) {
2891                         /* there is little hope left, don't run it too often */
2892                         interval = HZ * 60;
2893                 }
2894         } while (!wait_for_completion_timeout(&ctx->ref_comp, interval));
2895
2896         init_completion(&exit.completion);
2897         init_task_work(&exit.task_work, io_tctx_exit_cb);
2898         exit.ctx = ctx;
2899         /*
2900          * Some may use context even when all refs and requests have been put,
2901          * and they are free to do so while still holding uring_lock or
2902          * completion_lock, see io_req_task_submit(). Apart from other work,
2903          * this lock/unlock section also waits them to finish.
2904          */
2905         mutex_lock(&ctx->uring_lock);
2906         while (!list_empty(&ctx->tctx_list)) {
2907                 WARN_ON_ONCE(time_after(jiffies, timeout));
2908
2909                 node = list_first_entry(&ctx->tctx_list, struct io_tctx_node,
2910                                         ctx_node);
2911                 /* don't spin on a single task if cancellation failed */
2912                 list_rotate_left(&ctx->tctx_list);
2913                 ret = task_work_add(node->task, &exit.task_work, TWA_SIGNAL);
2914                 if (WARN_ON_ONCE(ret))
2915                         continue;
2916
2917                 mutex_unlock(&ctx->uring_lock);
2918                 wait_for_completion(&exit.completion);
2919                 mutex_lock(&ctx->uring_lock);
2920         }
2921         mutex_unlock(&ctx->uring_lock);
2922         spin_lock(&ctx->completion_lock);
2923         spin_unlock(&ctx->completion_lock);
2924
2925         io_ring_ctx_free(ctx);
2926 }
2927
2928 static __cold void io_ring_ctx_wait_and_kill(struct io_ring_ctx *ctx)
2929 {
2930         unsigned long index;
2931         struct creds *creds;
2932
2933         mutex_lock(&ctx->uring_lock);
2934         percpu_ref_kill(&ctx->refs);
2935         xa_for_each(&ctx->personalities, index, creds)
2936                 io_unregister_personality(ctx, index);
2937         if (ctx->rings)
2938                 io_poll_remove_all(ctx, NULL, true);
2939         mutex_unlock(&ctx->uring_lock);
2940
2941         /*
2942          * If we failed setting up the ctx, we might not have any rings
2943          * and therefore did not submit any requests
2944          */
2945         if (ctx->rings)
2946                 io_kill_timeouts(ctx, NULL, true);
2947
2948         INIT_WORK(&ctx->exit_work, io_ring_exit_work);
2949         /*
2950          * Use system_unbound_wq to avoid spawning tons of event kworkers
2951          * if we're exiting a ton of rings at the same time. It just adds
2952          * noise and overhead, there's no discernable change in runtime
2953          * over using system_wq.
2954          */
2955         queue_work(system_unbound_wq, &ctx->exit_work);
2956 }
2957
2958 static int io_uring_release(struct inode *inode, struct file *file)
2959 {
2960         struct io_ring_ctx *ctx = file->private_data;
2961
2962         file->private_data = NULL;
2963         io_ring_ctx_wait_and_kill(ctx);
2964         return 0;
2965 }
2966
2967 struct io_task_cancel {
2968         struct task_struct *task;
2969         bool all;
2970 };
2971
2972 static bool io_cancel_task_cb(struct io_wq_work *work, void *data)
2973 {
2974         struct io_kiocb *req = container_of(work, struct io_kiocb, work);
2975         struct io_task_cancel *cancel = data;
2976
2977         return io_match_task_safe(req, cancel->task, cancel->all);
2978 }
2979
2980 static __cold bool io_cancel_defer_files(struct io_ring_ctx *ctx,
2981                                          struct task_struct *task,
2982                                          bool cancel_all)
2983 {
2984         struct io_defer_entry *de;
2985         LIST_HEAD(list);
2986
2987         spin_lock(&ctx->completion_lock);
2988         list_for_each_entry_reverse(de, &ctx->defer_list, list) {
2989                 if (io_match_task_safe(de->req, task, cancel_all)) {
2990                         list_cut_position(&list, &ctx->defer_list, &de->list);
2991                         break;
2992                 }
2993         }
2994         spin_unlock(&ctx->completion_lock);
2995         if (list_empty(&list))
2996                 return false;
2997
2998         while (!list_empty(&list)) {
2999                 de = list_first_entry(&list, struct io_defer_entry, list);
3000                 list_del_init(&de->list);
3001                 io_req_task_queue_fail(de->req, -ECANCELED);
3002                 kfree(de);
3003         }
3004         return true;
3005 }
3006
3007 static __cold bool io_uring_try_cancel_iowq(struct io_ring_ctx *ctx)
3008 {
3009         struct io_tctx_node *node;
3010         enum io_wq_cancel cret;
3011         bool ret = false;
3012
3013         mutex_lock(&ctx->uring_lock);
3014         list_for_each_entry(node, &ctx->tctx_list, ctx_node) {
3015                 struct io_uring_task *tctx = node->task->io_uring;
3016
3017                 /*
3018                  * io_wq will stay alive while we hold uring_lock, because it's
3019                  * killed after ctx nodes, which requires to take the lock.
3020                  */
3021                 if (!tctx || !tctx->io_wq)
3022                         continue;
3023                 cret = io_wq_cancel_cb(tctx->io_wq, io_cancel_ctx_cb, ctx, true);
3024                 ret |= (cret != IO_WQ_CANCEL_NOTFOUND);
3025         }
3026         mutex_unlock(&ctx->uring_lock);
3027
3028         return ret;
3029 }
3030
3031 static __cold bool io_uring_try_cancel_requests(struct io_ring_ctx *ctx,
3032                                                 struct task_struct *task,
3033                                                 bool cancel_all)
3034 {
3035         struct io_task_cancel cancel = { .task = task, .all = cancel_all, };
3036         struct io_uring_task *tctx = task ? task->io_uring : NULL;
3037         enum io_wq_cancel cret;
3038         bool ret = false;
3039
3040         /* failed during ring init, it couldn't have issued any requests */
3041         if (!ctx->rings)
3042                 return false;
3043
3044         if (!task) {
3045                 ret |= io_uring_try_cancel_iowq(ctx);
3046         } else if (tctx && tctx->io_wq) {
3047                 /*
3048                  * Cancels requests of all rings, not only @ctx, but
3049                  * it's fine as the task is in exit/exec.
3050                  */
3051                 cret = io_wq_cancel_cb(tctx->io_wq, io_cancel_task_cb,
3052                                        &cancel, true);
3053                 ret |= (cret != IO_WQ_CANCEL_NOTFOUND);
3054         }
3055
3056         /* SQPOLL thread does its own polling */
3057         if ((!(ctx->flags & IORING_SETUP_SQPOLL) && cancel_all) ||
3058             (ctx->sq_data && ctx->sq_data->thread == current)) {
3059                 while (!wq_list_empty(&ctx->iopoll_list)) {
3060                         io_iopoll_try_reap_events(ctx);
3061                         ret = true;
3062                 }
3063         }
3064
3065         if ((ctx->flags & IORING_SETUP_DEFER_TASKRUN) &&
3066             io_allowed_defer_tw_run(ctx))
3067                 ret |= io_run_local_work(ctx) > 0;
3068         ret |= io_cancel_defer_files(ctx, task, cancel_all);
3069         mutex_lock(&ctx->uring_lock);
3070         ret |= io_poll_remove_all(ctx, task, cancel_all);
3071         mutex_unlock(&ctx->uring_lock);
3072         ret |= io_kill_timeouts(ctx, task, cancel_all);
3073         if (task)
3074                 ret |= io_run_task_work() > 0;
3075         return ret;
3076 }
3077
3078 static s64 tctx_inflight(struct io_uring_task *tctx, bool tracked)
3079 {
3080         if (tracked)
3081                 return atomic_read(&tctx->inflight_tracked);
3082         return percpu_counter_sum(&tctx->inflight);
3083 }
3084
3085 /*
3086  * Find any io_uring ctx that this task has registered or done IO on, and cancel
3087  * requests. @sqd should be not-null IFF it's an SQPOLL thread cancellation.
3088  */
3089 __cold void io_uring_cancel_generic(bool cancel_all, struct io_sq_data *sqd)
3090 {
3091         struct io_uring_task *tctx = current->io_uring;
3092         struct io_ring_ctx *ctx;
3093         s64 inflight;
3094         DEFINE_WAIT(wait);
3095
3096         WARN_ON_ONCE(sqd && sqd->thread != current);
3097
3098         if (!current->io_uring)
3099                 return;
3100         if (tctx->io_wq)
3101                 io_wq_exit_start(tctx->io_wq);
3102
3103         atomic_inc(&tctx->in_idle);
3104         do {
3105                 bool loop = false;
3106
3107                 io_uring_drop_tctx_refs(current);
3108                 /* read completions before cancelations */
3109                 inflight = tctx_inflight(tctx, !cancel_all);
3110                 if (!inflight)
3111                         break;
3112
3113                 if (!sqd) {
3114                         struct io_tctx_node *node;
3115                         unsigned long index;
3116
3117                         xa_for_each(&tctx->xa, index, node) {
3118                                 /* sqpoll task will cancel all its requests */
3119                                 if (node->ctx->sq_data)
3120                                         continue;
3121                                 loop |= io_uring_try_cancel_requests(node->ctx,
3122                                                         current, cancel_all);
3123                         }
3124                 } else {
3125                         list_for_each_entry(ctx, &sqd->ctx_list, sqd_list)
3126                                 loop |= io_uring_try_cancel_requests(ctx,
3127                                                                      current,
3128                                                                      cancel_all);
3129                 }
3130
3131                 if (loop) {
3132                         cond_resched();
3133                         continue;
3134                 }
3135
3136                 prepare_to_wait(&tctx->wait, &wait, TASK_INTERRUPTIBLE);
3137                 io_run_task_work();
3138                 io_uring_drop_tctx_refs(current);
3139
3140                 /*
3141                  * If we've seen completions, retry without waiting. This
3142                  * avoids a race where a completion comes in before we did
3143                  * prepare_to_wait().
3144                  */
3145                 if (inflight == tctx_inflight(tctx, !cancel_all))
3146                         schedule();
3147                 finish_wait(&tctx->wait, &wait);
3148         } while (1);
3149
3150         io_uring_clean_tctx(tctx);
3151         if (cancel_all) {
3152                 /*
3153                  * We shouldn't run task_works after cancel, so just leave
3154                  * ->in_idle set for normal exit.
3155                  */
3156                 atomic_dec(&tctx->in_idle);
3157                 /* for exec all current's requests should be gone, kill tctx */
3158                 __io_uring_free(current);
3159         }
3160 }
3161
3162 void __io_uring_cancel(bool cancel_all)
3163 {
3164         io_uring_cancel_generic(cancel_all, NULL);
3165 }
3166
3167 static void *io_uring_validate_mmap_request(struct file *file,
3168                                             loff_t pgoff, size_t sz)
3169 {
3170         struct io_ring_ctx *ctx = file->private_data;
3171         loff_t offset = pgoff << PAGE_SHIFT;
3172         struct page *page;
3173         void *ptr;
3174
3175         switch (offset) {
3176         case IORING_OFF_SQ_RING:
3177         case IORING_OFF_CQ_RING:
3178                 ptr = ctx->rings;
3179                 break;
3180         case IORING_OFF_SQES:
3181                 ptr = ctx->sq_sqes;
3182                 break;
3183         default:
3184                 return ERR_PTR(-EINVAL);
3185         }
3186
3187         page = virt_to_head_page(ptr);
3188         if (sz > page_size(page))
3189                 return ERR_PTR(-EINVAL);
3190
3191         return ptr;
3192 }
3193
3194 #ifdef CONFIG_MMU
3195
3196 static __cold int io_uring_mmap(struct file *file, struct vm_area_struct *vma)
3197 {
3198         size_t sz = vma->vm_end - vma->vm_start;
3199         unsigned long pfn;
3200         void *ptr;
3201
3202         ptr = io_uring_validate_mmap_request(file, vma->vm_pgoff, sz);
3203         if (IS_ERR(ptr))
3204                 return PTR_ERR(ptr);
3205
3206         pfn = virt_to_phys(ptr) >> PAGE_SHIFT;
3207         return remap_pfn_range(vma, vma->vm_start, pfn, sz, vma->vm_page_prot);
3208 }
3209
3210 #else /* !CONFIG_MMU */
3211
3212 static int io_uring_mmap(struct file *file, struct vm_area_struct *vma)
3213 {
3214         return vma->vm_flags & (VM_SHARED | VM_MAYSHARE) ? 0 : -EINVAL;
3215 }
3216
3217 static unsigned int io_uring_nommu_mmap_capabilities(struct file *file)
3218 {
3219         return NOMMU_MAP_DIRECT | NOMMU_MAP_READ | NOMMU_MAP_WRITE;
3220 }
3221
3222 static unsigned long io_uring_nommu_get_unmapped_area(struct file *file,
3223         unsigned long addr, unsigned long len,
3224         unsigned long pgoff, unsigned long flags)
3225 {
3226         void *ptr;
3227
3228         ptr = io_uring_validate_mmap_request(file, pgoff, len);
3229         if (IS_ERR(ptr))
3230                 return PTR_ERR(ptr);
3231
3232         return (unsigned long) ptr;
3233 }
3234
3235 #endif /* !CONFIG_MMU */
3236
3237 static int io_validate_ext_arg(unsigned flags, const void __user *argp, size_t argsz)
3238 {
3239         if (flags & IORING_ENTER_EXT_ARG) {
3240                 struct io_uring_getevents_arg arg;
3241
3242                 if (argsz != sizeof(arg))
3243                         return -EINVAL;
3244                 if (copy_from_user(&arg, argp, sizeof(arg)))
3245                         return -EFAULT;
3246         }
3247         return 0;
3248 }
3249
3250 static int io_get_ext_arg(unsigned flags, const void __user *argp, size_t *argsz,
3251                           struct __kernel_timespec __user **ts,
3252                           const sigset_t __user **sig)
3253 {
3254         struct io_uring_getevents_arg arg;
3255
3256         /*
3257          * If EXT_ARG isn't set, then we have no timespec and the argp pointer
3258          * is just a pointer to the sigset_t.
3259          */
3260         if (!(flags & IORING_ENTER_EXT_ARG)) {
3261                 *sig = (const sigset_t __user *) argp;
3262                 *ts = NULL;
3263                 return 0;
3264         }
3265
3266         /*
3267          * EXT_ARG is set - ensure we agree on the size of it and copy in our
3268          * timespec and sigset_t pointers if good.
3269          */
3270         if (*argsz != sizeof(arg))
3271                 return -EINVAL;
3272         if (copy_from_user(&arg, argp, sizeof(arg)))
3273                 return -EFAULT;
3274         if (arg.pad)
3275                 return -EINVAL;
3276         *sig = u64_to_user_ptr(arg.sigmask);
3277         *argsz = arg.sigmask_sz;
3278         *ts = u64_to_user_ptr(arg.ts);
3279         return 0;
3280 }
3281
3282 SYSCALL_DEFINE6(io_uring_enter, unsigned int, fd, u32, to_submit,
3283                 u32, min_complete, u32, flags, const void __user *, argp,
3284                 size_t, argsz)
3285 {
3286         struct io_ring_ctx *ctx;
3287         struct fd f;
3288         long ret;
3289
3290         if (unlikely(flags & ~(IORING_ENTER_GETEVENTS | IORING_ENTER_SQ_WAKEUP |
3291                                IORING_ENTER_SQ_WAIT | IORING_ENTER_EXT_ARG |
3292                                IORING_ENTER_REGISTERED_RING)))
3293                 return -EINVAL;
3294
3295         /*
3296          * Ring fd has been registered via IORING_REGISTER_RING_FDS, we
3297          * need only dereference our task private array to find it.
3298          */
3299         if (flags & IORING_ENTER_REGISTERED_RING) {
3300                 struct io_uring_task *tctx = current->io_uring;
3301
3302                 if (unlikely(!tctx || fd >= IO_RINGFD_REG_MAX))
3303                         return -EINVAL;
3304                 fd = array_index_nospec(fd, IO_RINGFD_REG_MAX);
3305                 f.file = tctx->registered_rings[fd];
3306                 f.flags = 0;
3307                 if (unlikely(!f.file))
3308                         return -EBADF;
3309         } else {
3310                 f = fdget(fd);
3311                 if (unlikely(!f.file))
3312                         return -EBADF;
3313                 ret = -EOPNOTSUPP;
3314                 if (unlikely(!io_is_uring_fops(f.file)))
3315                         goto out;
3316         }
3317
3318         ctx = f.file->private_data;
3319         ret = -EBADFD;
3320         if (unlikely(ctx->flags & IORING_SETUP_R_DISABLED))
3321                 goto out;
3322
3323         /*
3324          * For SQ polling, the thread will do all submissions and completions.
3325          * Just return the requested submit count, and wake the thread if
3326          * we were asked to.
3327          */
3328         ret = 0;
3329         if (ctx->flags & IORING_SETUP_SQPOLL) {
3330                 io_cqring_overflow_flush(ctx);
3331
3332                 if (unlikely(ctx->sq_data->thread == NULL)) {
3333                         ret = -EOWNERDEAD;
3334                         goto out;
3335                 }
3336                 if (flags & IORING_ENTER_SQ_WAKEUP)
3337                         wake_up(&ctx->sq_data->wait);
3338                 if (flags & IORING_ENTER_SQ_WAIT) {
3339                         ret = io_sqpoll_wait_sq(ctx);
3340                         if (ret)
3341                                 goto out;
3342                 }
3343                 ret = to_submit;
3344         } else if (to_submit) {
3345                 ret = io_uring_add_tctx_node(ctx);
3346                 if (unlikely(ret))
3347                         goto out;
3348
3349                 mutex_lock(&ctx->uring_lock);
3350                 ret = io_submit_sqes(ctx, to_submit);
3351                 if (ret != to_submit) {
3352                         mutex_unlock(&ctx->uring_lock);
3353                         goto out;
3354                 }
3355                 if (flags & IORING_ENTER_GETEVENTS) {
3356                         if (ctx->syscall_iopoll)
3357                                 goto iopoll_locked;
3358                         /*
3359                          * Ignore errors, we'll soon call io_cqring_wait() and
3360                          * it should handle ownership problems if any.
3361                          */
3362                         if (ctx->flags & IORING_SETUP_DEFER_TASKRUN)
3363                                 (void)io_run_local_work_locked(ctx);
3364                 }
3365                 mutex_unlock(&ctx->uring_lock);
3366         }
3367
3368         if (flags & IORING_ENTER_GETEVENTS) {
3369                 int ret2;
3370
3371                 if (ctx->syscall_iopoll) {
3372                         /*
3373                          * We disallow the app entering submit/complete with
3374                          * polling, but we still need to lock the ring to
3375                          * prevent racing with polled issue that got punted to
3376                          * a workqueue.
3377                          */
3378                         mutex_lock(&ctx->uring_lock);
3379 iopoll_locked:
3380                         ret2 = io_validate_ext_arg(flags, argp, argsz);
3381                         if (likely(!ret2)) {
3382                                 min_complete = min(min_complete,
3383                                                    ctx->cq_entries);
3384                                 ret2 = io_iopoll_check(ctx, min_complete);
3385                         }
3386                         mutex_unlock(&ctx->uring_lock);
3387                 } else {
3388                         const sigset_t __user *sig;
3389                         struct __kernel_timespec __user *ts;
3390
3391                         ret2 = io_get_ext_arg(flags, argp, &argsz, &ts, &sig);
3392                         if (likely(!ret2)) {
3393                                 min_complete = min(min_complete,
3394                                                    ctx->cq_entries);
3395                                 ret2 = io_cqring_wait(ctx, min_complete, sig,
3396                                                       argsz, ts);
3397                         }
3398                 }
3399
3400                 if (!ret) {
3401                         ret = ret2;
3402
3403                         /*
3404                          * EBADR indicates that one or more CQE were dropped.
3405                          * Once the user has been informed we can clear the bit
3406                          * as they are obviously ok with those drops.
3407                          */
3408                         if (unlikely(ret2 == -EBADR))
3409                                 clear_bit(IO_CHECK_CQ_DROPPED_BIT,
3410                                           &ctx->check_cq);
3411                 }
3412         }
3413 out:
3414         fdput(f);
3415         return ret;
3416 }
3417
3418 static const struct file_operations io_uring_fops = {
3419         .release        = io_uring_release,
3420         .mmap           = io_uring_mmap,
3421 #ifndef CONFIG_MMU
3422         .get_unmapped_area = io_uring_nommu_get_unmapped_area,
3423         .mmap_capabilities = io_uring_nommu_mmap_capabilities,
3424 #endif
3425         .poll           = io_uring_poll,
3426 #ifdef CONFIG_PROC_FS
3427         .show_fdinfo    = io_uring_show_fdinfo,
3428 #endif
3429 };
3430
3431 bool io_is_uring_fops(struct file *file)
3432 {
3433         return file->f_op == &io_uring_fops;
3434 }
3435
3436 static __cold int io_allocate_scq_urings(struct io_ring_ctx *ctx,
3437                                          struct io_uring_params *p)
3438 {
3439         struct io_rings *rings;
3440         size_t size, sq_array_offset;
3441
3442         /* make sure these are sane, as we already accounted them */
3443         ctx->sq_entries = p->sq_entries;
3444         ctx->cq_entries = p->cq_entries;
3445
3446         size = rings_size(ctx, p->sq_entries, p->cq_entries, &sq_array_offset);
3447         if (size == SIZE_MAX)
3448                 return -EOVERFLOW;
3449
3450         rings = io_mem_alloc(size);
3451         if (!rings)
3452                 return -ENOMEM;
3453
3454         ctx->rings = rings;
3455         ctx->sq_array = (u32 *)((char *)rings + sq_array_offset);
3456         rings->sq_ring_mask = p->sq_entries - 1;
3457         rings->cq_ring_mask = p->cq_entries - 1;
3458         rings->sq_ring_entries = p->sq_entries;
3459         rings->cq_ring_entries = p->cq_entries;
3460
3461         if (p->flags & IORING_SETUP_SQE128)
3462                 size = array_size(2 * sizeof(struct io_uring_sqe), p->sq_entries);
3463         else
3464                 size = array_size(sizeof(struct io_uring_sqe), p->sq_entries);
3465         if (size == SIZE_MAX) {
3466                 io_mem_free(ctx->rings);
3467                 ctx->rings = NULL;
3468                 return -EOVERFLOW;
3469         }
3470
3471         ctx->sq_sqes = io_mem_alloc(size);
3472         if (!ctx->sq_sqes) {
3473                 io_mem_free(ctx->rings);
3474                 ctx->rings = NULL;
3475                 return -ENOMEM;
3476         }
3477
3478         return 0;
3479 }
3480
3481 static int io_uring_install_fd(struct io_ring_ctx *ctx, struct file *file)
3482 {
3483         int ret, fd;
3484
3485         fd = get_unused_fd_flags(O_RDWR | O_CLOEXEC);
3486         if (fd < 0)
3487                 return fd;
3488
3489         ret = __io_uring_add_tctx_node(ctx);
3490         if (ret) {
3491                 put_unused_fd(fd);
3492                 return ret;
3493         }
3494         fd_install(fd, file);
3495         return fd;
3496 }
3497
3498 /*
3499  * Allocate an anonymous fd, this is what constitutes the application
3500  * visible backing of an io_uring instance. The application mmaps this
3501  * fd to gain access to the SQ/CQ ring details. If UNIX sockets are enabled,
3502  * we have to tie this fd to a socket for file garbage collection purposes.
3503  */
3504 static struct file *io_uring_get_file(struct io_ring_ctx *ctx)
3505 {
3506         struct file *file;
3507 #if defined(CONFIG_UNIX)
3508         int ret;
3509
3510         ret = sock_create_kern(&init_net, PF_UNIX, SOCK_RAW, IPPROTO_IP,
3511                                 &ctx->ring_sock);
3512         if (ret)
3513                 return ERR_PTR(ret);
3514 #endif
3515
3516         file = anon_inode_getfile_secure("[io_uring]", &io_uring_fops, ctx,
3517                                          O_RDWR | O_CLOEXEC, NULL);
3518 #if defined(CONFIG_UNIX)
3519         if (IS_ERR(file)) {
3520                 sock_release(ctx->ring_sock);
3521                 ctx->ring_sock = NULL;
3522         } else {
3523                 ctx->ring_sock->file = file;
3524         }
3525 #endif
3526         return file;
3527 }
3528
3529 static __cold int io_uring_create(unsigned entries, struct io_uring_params *p,
3530                                   struct io_uring_params __user *params)
3531 {
3532         struct io_ring_ctx *ctx;
3533         struct file *file;
3534         int ret;
3535
3536         if (!entries)
3537                 return -EINVAL;
3538         if (entries > IORING_MAX_ENTRIES) {
3539                 if (!(p->flags & IORING_SETUP_CLAMP))
3540                         return -EINVAL;
3541                 entries = IORING_MAX_ENTRIES;
3542         }
3543
3544         /*
3545          * Use twice as many entries for the CQ ring. It's possible for the
3546          * application to drive a higher depth than the size of the SQ ring,
3547          * since the sqes are only used at submission time. This allows for
3548          * some flexibility in overcommitting a bit. If the application has
3549          * set IORING_SETUP_CQSIZE, it will have passed in the desired number
3550          * of CQ ring entries manually.
3551          */
3552         p->sq_entries = roundup_pow_of_two(entries);
3553         if (p->flags & IORING_SETUP_CQSIZE) {
3554                 /*
3555                  * If IORING_SETUP_CQSIZE is set, we do the same roundup
3556                  * to a power-of-two, if it isn't already. We do NOT impose
3557                  * any cq vs sq ring sizing.
3558                  */
3559                 if (!p->cq_entries)
3560                         return -EINVAL;
3561                 if (p->cq_entries > IORING_MAX_CQ_ENTRIES) {
3562                         if (!(p->flags & IORING_SETUP_CLAMP))
3563                                 return -EINVAL;
3564                         p->cq_entries = IORING_MAX_CQ_ENTRIES;
3565                 }
3566                 p->cq_entries = roundup_pow_of_two(p->cq_entries);
3567                 if (p->cq_entries < p->sq_entries)
3568                         return -EINVAL;
3569         } else {
3570                 p->cq_entries = 2 * p->sq_entries;
3571         }
3572
3573         ctx = io_ring_ctx_alloc(p);
3574         if (!ctx)
3575                 return -ENOMEM;
3576
3577         if ((ctx->flags & IORING_SETUP_DEFER_TASKRUN) &&
3578             !(ctx->flags & IORING_SETUP_IOPOLL) &&
3579             !(ctx->flags & IORING_SETUP_SQPOLL))
3580                 ctx->task_complete = true;
3581
3582         /*
3583          * When SETUP_IOPOLL and SETUP_SQPOLL are both enabled, user
3584          * space applications don't need to do io completion events
3585          * polling again, they can rely on io_sq_thread to do polling
3586          * work, which can reduce cpu usage and uring_lock contention.
3587          */
3588         if (ctx->flags & IORING_SETUP_IOPOLL &&
3589             !(ctx->flags & IORING_SETUP_SQPOLL))
3590                 ctx->syscall_iopoll = 1;
3591
3592         ctx->compat = in_compat_syscall();
3593         if (!capable(CAP_IPC_LOCK))
3594                 ctx->user = get_uid(current_user());
3595
3596         /*
3597          * For SQPOLL, we just need a wakeup, always. For !SQPOLL, if
3598          * COOP_TASKRUN is set, then IPIs are never needed by the app.
3599          */
3600         ret = -EINVAL;
3601         if (ctx->flags & IORING_SETUP_SQPOLL) {
3602                 /* IPI related flags don't make sense with SQPOLL */
3603                 if (ctx->flags & (IORING_SETUP_COOP_TASKRUN |
3604                                   IORING_SETUP_TASKRUN_FLAG |
3605                                   IORING_SETUP_DEFER_TASKRUN))
3606                         goto err;
3607                 ctx->notify_method = TWA_SIGNAL_NO_IPI;
3608         } else if (ctx->flags & IORING_SETUP_COOP_TASKRUN) {
3609                 ctx->notify_method = TWA_SIGNAL_NO_IPI;
3610         } else {
3611                 if (ctx->flags & IORING_SETUP_TASKRUN_FLAG &&
3612                     !(ctx->flags & IORING_SETUP_DEFER_TASKRUN))
3613                         goto err;
3614                 ctx->notify_method = TWA_SIGNAL;
3615         }
3616
3617         /*
3618          * For DEFER_TASKRUN we require the completion task to be the same as the
3619          * submission task. This implies that there is only one submitter, so enforce
3620          * that.
3621          */
3622         if (ctx->flags & IORING_SETUP_DEFER_TASKRUN &&
3623             !(ctx->flags & IORING_SETUP_SINGLE_ISSUER)) {
3624                 goto err;
3625         }
3626
3627         /*
3628          * This is just grabbed for accounting purposes. When a process exits,
3629          * the mm is exited and dropped before the files, hence we need to hang
3630          * on to this mm purely for the purposes of being able to unaccount
3631          * memory (locked/pinned vm). It's not used for anything else.
3632          */
3633         mmgrab(current->mm);
3634         ctx->mm_account = current->mm;
3635
3636         ret = io_allocate_scq_urings(ctx, p);
3637         if (ret)
3638                 goto err;
3639
3640         ret = io_sq_offload_create(ctx, p);
3641         if (ret)
3642                 goto err;
3643         /* always set a rsrc node */
3644         ret = io_rsrc_node_switch_start(ctx);
3645         if (ret)
3646                 goto err;
3647         io_rsrc_node_switch(ctx, NULL);
3648
3649         memset(&p->sq_off, 0, sizeof(p->sq_off));
3650         p->sq_off.head = offsetof(struct io_rings, sq.head);
3651         p->sq_off.tail = offsetof(struct io_rings, sq.tail);
3652         p->sq_off.ring_mask = offsetof(struct io_rings, sq_ring_mask);
3653         p->sq_off.ring_entries = offsetof(struct io_rings, sq_ring_entries);
3654         p->sq_off.flags = offsetof(struct io_rings, sq_flags);
3655         p->sq_off.dropped = offsetof(struct io_rings, sq_dropped);
3656         p->sq_off.array = (char *)ctx->sq_array - (char *)ctx->rings;
3657
3658         memset(&p->cq_off, 0, sizeof(p->cq_off));
3659         p->cq_off.head = offsetof(struct io_rings, cq.head);
3660         p->cq_off.tail = offsetof(struct io_rings, cq.tail);
3661         p->cq_off.ring_mask = offsetof(struct io_rings, cq_ring_mask);
3662         p->cq_off.ring_entries = offsetof(struct io_rings, cq_ring_entries);
3663         p->cq_off.overflow = offsetof(struct io_rings, cq_overflow);
3664         p->cq_off.cqes = offsetof(struct io_rings, cqes);
3665         p->cq_off.flags = offsetof(struct io_rings, cq_flags);
3666
3667         p->features = IORING_FEAT_SINGLE_MMAP | IORING_FEAT_NODROP |
3668                         IORING_FEAT_SUBMIT_STABLE | IORING_FEAT_RW_CUR_POS |
3669                         IORING_FEAT_CUR_PERSONALITY | IORING_FEAT_FAST_POLL |
3670                         IORING_FEAT_POLL_32BITS | IORING_FEAT_SQPOLL_NONFIXED |
3671                         IORING_FEAT_EXT_ARG | IORING_FEAT_NATIVE_WORKERS |
3672                         IORING_FEAT_RSRC_TAGS | IORING_FEAT_CQE_SKIP |
3673                         IORING_FEAT_LINKED_FILE;
3674
3675         if (copy_to_user(params, p, sizeof(*p))) {
3676                 ret = -EFAULT;
3677                 goto err;
3678         }
3679
3680         if (ctx->flags & IORING_SETUP_SINGLE_ISSUER
3681             && !(ctx->flags & IORING_SETUP_R_DISABLED))
3682                 WRITE_ONCE(ctx->submitter_task, get_task_struct(current));
3683
3684         file = io_uring_get_file(ctx);
3685         if (IS_ERR(file)) {
3686                 ret = PTR_ERR(file);
3687                 goto err;
3688         }
3689
3690         /*
3691          * Install ring fd as the very last thing, so we don't risk someone
3692          * having closed it before we finish setup
3693          */
3694         ret = io_uring_install_fd(ctx, file);
3695         if (ret < 0) {
3696                 /* fput will clean it up */
3697                 fput(file);
3698                 return ret;
3699         }
3700
3701         trace_io_uring_create(ret, ctx, p->sq_entries, p->cq_entries, p->flags);
3702         return ret;
3703 err:
3704         io_ring_ctx_wait_and_kill(ctx);
3705         return ret;
3706 }
3707
3708 /*
3709  * Sets up an aio uring context, and returns the fd. Applications asks for a
3710  * ring size, we return the actual sq/cq ring sizes (among other things) in the
3711  * params structure passed in.
3712  */
3713 static long io_uring_setup(u32 entries, struct io_uring_params __user *params)
3714 {
3715         struct io_uring_params p;
3716         int i;
3717
3718         if (copy_from_user(&p, params, sizeof(p)))
3719                 return -EFAULT;
3720         for (i = 0; i < ARRAY_SIZE(p.resv); i++) {
3721                 if (p.resv[i])
3722                         return -EINVAL;
3723         }
3724
3725         if (p.flags & ~(IORING_SETUP_IOPOLL | IORING_SETUP_SQPOLL |
3726                         IORING_SETUP_SQ_AFF | IORING_SETUP_CQSIZE |
3727                         IORING_SETUP_CLAMP | IORING_SETUP_ATTACH_WQ |
3728                         IORING_SETUP_R_DISABLED | IORING_SETUP_SUBMIT_ALL |
3729                         IORING_SETUP_COOP_TASKRUN | IORING_SETUP_TASKRUN_FLAG |
3730                         IORING_SETUP_SQE128 | IORING_SETUP_CQE32 |
3731                         IORING_SETUP_SINGLE_ISSUER | IORING_SETUP_DEFER_TASKRUN))
3732                 return -EINVAL;
3733
3734         return io_uring_create(entries, &p, params);
3735 }
3736
3737 SYSCALL_DEFINE2(io_uring_setup, u32, entries,
3738                 struct io_uring_params __user *, params)
3739 {
3740         return io_uring_setup(entries, params);
3741 }
3742
3743 static __cold int io_probe(struct io_ring_ctx *ctx, void __user *arg,
3744                            unsigned nr_args)
3745 {
3746         struct io_uring_probe *p;
3747         size_t size;
3748         int i, ret;
3749
3750         size = struct_size(p, ops, nr_args);
3751         if (size == SIZE_MAX)
3752                 return -EOVERFLOW;
3753         p = kzalloc(size, GFP_KERNEL);
3754         if (!p)
3755                 return -ENOMEM;
3756
3757         ret = -EFAULT;
3758         if (copy_from_user(p, arg, size))
3759                 goto out;
3760         ret = -EINVAL;
3761         if (memchr_inv(p, 0, size))
3762                 goto out;
3763
3764         p->last_op = IORING_OP_LAST - 1;
3765         if (nr_args > IORING_OP_LAST)
3766                 nr_args = IORING_OP_LAST;
3767
3768         for (i = 0; i < nr_args; i++) {
3769                 p->ops[i].op = i;
3770                 if (!io_op_defs[i].not_supported)
3771                         p->ops[i].flags = IO_URING_OP_SUPPORTED;
3772         }
3773         p->ops_len = i;
3774
3775         ret = 0;
3776         if (copy_to_user(arg, p, size))
3777                 ret = -EFAULT;
3778 out:
3779         kfree(p);
3780         return ret;
3781 }
3782
3783 static int io_register_personality(struct io_ring_ctx *ctx)
3784 {
3785         const struct cred *creds;
3786         u32 id;
3787         int ret;
3788
3789         creds = get_current_cred();
3790
3791         ret = xa_alloc_cyclic(&ctx->personalities, &id, (void *)creds,
3792                         XA_LIMIT(0, USHRT_MAX), &ctx->pers_next, GFP_KERNEL);
3793         if (ret < 0) {
3794                 put_cred(creds);
3795                 return ret;
3796         }
3797         return id;
3798 }
3799
3800 static __cold int io_register_restrictions(struct io_ring_ctx *ctx,
3801                                            void __user *arg, unsigned int nr_args)
3802 {
3803         struct io_uring_restriction *res;
3804         size_t size;
3805         int i, ret;
3806
3807         /* Restrictions allowed only if rings started disabled */
3808         if (!(ctx->flags & IORING_SETUP_R_DISABLED))
3809                 return -EBADFD;
3810
3811         /* We allow only a single restrictions registration */
3812         if (ctx->restrictions.registered)
3813                 return -EBUSY;
3814
3815         if (!arg || nr_args > IORING_MAX_RESTRICTIONS)
3816                 return -EINVAL;
3817
3818         size = array_size(nr_args, sizeof(*res));
3819         if (size == SIZE_MAX)
3820                 return -EOVERFLOW;
3821
3822         res = memdup_user(arg, size);
3823         if (IS_ERR(res))
3824                 return PTR_ERR(res);
3825
3826         ret = 0;
3827
3828         for (i = 0; i < nr_args; i++) {
3829                 switch (res[i].opcode) {
3830                 case IORING_RESTRICTION_REGISTER_OP:
3831                         if (res[i].register_op >= IORING_REGISTER_LAST) {
3832                                 ret = -EINVAL;
3833                                 goto out;
3834                         }
3835
3836                         __set_bit(res[i].register_op,
3837                                   ctx->restrictions.register_op);
3838                         break;
3839                 case IORING_RESTRICTION_SQE_OP:
3840                         if (res[i].sqe_op >= IORING_OP_LAST) {
3841                                 ret = -EINVAL;
3842                                 goto out;
3843                         }
3844
3845                         __set_bit(res[i].sqe_op, ctx->restrictions.sqe_op);
3846                         break;
3847                 case IORING_RESTRICTION_SQE_FLAGS_ALLOWED:
3848                         ctx->restrictions.sqe_flags_allowed = res[i].sqe_flags;
3849                         break;
3850                 case IORING_RESTRICTION_SQE_FLAGS_REQUIRED:
3851                         ctx->restrictions.sqe_flags_required = res[i].sqe_flags;
3852                         break;
3853                 default:
3854                         ret = -EINVAL;
3855                         goto out;
3856                 }
3857         }
3858
3859 out:
3860         /* Reset all restrictions if an error happened */
3861         if (ret != 0)
3862                 memset(&ctx->restrictions, 0, sizeof(ctx->restrictions));
3863         else
3864                 ctx->restrictions.registered = true;
3865
3866         kfree(res);
3867         return ret;
3868 }
3869
3870 static int io_register_enable_rings(struct io_ring_ctx *ctx)
3871 {
3872         if (!(ctx->flags & IORING_SETUP_R_DISABLED))
3873                 return -EBADFD;
3874
3875         if (ctx->flags & IORING_SETUP_SINGLE_ISSUER && !ctx->submitter_task)
3876                 WRITE_ONCE(ctx->submitter_task, get_task_struct(current));
3877
3878         if (ctx->restrictions.registered)
3879                 ctx->restricted = 1;
3880
3881         ctx->flags &= ~IORING_SETUP_R_DISABLED;
3882         if (ctx->sq_data && wq_has_sleeper(&ctx->sq_data->wait))
3883                 wake_up(&ctx->sq_data->wait);
3884         return 0;
3885 }
3886
3887 static __cold int io_register_iowq_aff(struct io_ring_ctx *ctx,
3888                                        void __user *arg, unsigned len)
3889 {
3890         struct io_uring_task *tctx = current->io_uring;
3891         cpumask_var_t new_mask;
3892         int ret;
3893
3894         if (!tctx || !tctx->io_wq)
3895                 return -EINVAL;
3896
3897         if (!alloc_cpumask_var(&new_mask, GFP_KERNEL))
3898                 return -ENOMEM;
3899
3900         cpumask_clear(new_mask);
3901         if (len > cpumask_size())
3902                 len = cpumask_size();
3903
3904         if (in_compat_syscall()) {
3905                 ret = compat_get_bitmap(cpumask_bits(new_mask),
3906                                         (const compat_ulong_t __user *)arg,
3907                                         len * 8 /* CHAR_BIT */);
3908         } else {
3909                 ret = copy_from_user(new_mask, arg, len);
3910         }
3911
3912         if (ret) {
3913                 free_cpumask_var(new_mask);
3914                 return -EFAULT;
3915         }
3916
3917         ret = io_wq_cpu_affinity(tctx->io_wq, new_mask);
3918         free_cpumask_var(new_mask);
3919         return ret;
3920 }
3921
3922 static __cold int io_unregister_iowq_aff(struct io_ring_ctx *ctx)
3923 {
3924         struct io_uring_task *tctx = current->io_uring;
3925
3926         if (!tctx || !tctx->io_wq)
3927                 return -EINVAL;
3928
3929         return io_wq_cpu_affinity(tctx->io_wq, NULL);
3930 }
3931
3932 static __cold int io_register_iowq_max_workers(struct io_ring_ctx *ctx,
3933                                                void __user *arg)
3934         __must_hold(&ctx->uring_lock)
3935 {
3936         struct io_tctx_node *node;
3937         struct io_uring_task *tctx = NULL;
3938         struct io_sq_data *sqd = NULL;
3939         __u32 new_count[2];
3940         int i, ret;
3941
3942         if (copy_from_user(new_count, arg, sizeof(new_count)))
3943                 return -EFAULT;
3944         for (i = 0; i < ARRAY_SIZE(new_count); i++)
3945                 if (new_count[i] > INT_MAX)
3946                         return -EINVAL;
3947
3948         if (ctx->flags & IORING_SETUP_SQPOLL) {
3949                 sqd = ctx->sq_data;
3950                 if (sqd) {
3951                         /*
3952                          * Observe the correct sqd->lock -> ctx->uring_lock
3953                          * ordering. Fine to drop uring_lock here, we hold
3954                          * a ref to the ctx.
3955                          */
3956                         refcount_inc(&sqd->refs);
3957                         mutex_unlock(&ctx->uring_lock);
3958                         mutex_lock(&sqd->lock);
3959                         mutex_lock(&ctx->uring_lock);
3960                         if (sqd->thread)
3961                                 tctx = sqd->thread->io_uring;
3962                 }
3963         } else {
3964                 tctx = current->io_uring;
3965         }
3966
3967         BUILD_BUG_ON(sizeof(new_count) != sizeof(ctx->iowq_limits));
3968
3969         for (i = 0; i < ARRAY_SIZE(new_count); i++)
3970                 if (new_count[i])
3971                         ctx->iowq_limits[i] = new_count[i];
3972         ctx->iowq_limits_set = true;
3973
3974         if (tctx && tctx->io_wq) {
3975                 ret = io_wq_max_workers(tctx->io_wq, new_count);
3976                 if (ret)
3977                         goto err;
3978         } else {
3979                 memset(new_count, 0, sizeof(new_count));
3980         }
3981
3982         if (sqd) {
3983                 mutex_unlock(&sqd->lock);
3984                 io_put_sq_data(sqd);
3985         }
3986
3987         if (copy_to_user(arg, new_count, sizeof(new_count)))
3988                 return -EFAULT;
3989
3990         /* that's it for SQPOLL, only the SQPOLL task creates requests */
3991         if (sqd)
3992                 return 0;
3993
3994         /* now propagate the restriction to all registered users */
3995         list_for_each_entry(node, &ctx->tctx_list, ctx_node) {
3996                 struct io_uring_task *tctx = node->task->io_uring;
3997
3998                 if (WARN_ON_ONCE(!tctx->io_wq))
3999                         continue;
4000
4001                 for (i = 0; i < ARRAY_SIZE(new_count); i++)
4002                         new_count[i] = ctx->iowq_limits[i];
4003                 /* ignore errors, it always returns zero anyway */
4004                 (void)io_wq_max_workers(tctx->io_wq, new_count);
4005         }
4006         return 0;
4007 err:
4008         if (sqd) {
4009                 mutex_unlock(&sqd->lock);
4010                 io_put_sq_data(sqd);
4011         }
4012         return ret;
4013 }
4014
4015 static int __io_uring_register(struct io_ring_ctx *ctx, unsigned opcode,
4016                                void __user *arg, unsigned nr_args)
4017         __releases(ctx->uring_lock)
4018         __acquires(ctx->uring_lock)
4019 {
4020         int ret;
4021
4022         /*
4023          * We don't quiesce the refs for register anymore and so it can't be
4024          * dying as we're holding a file ref here.
4025          */
4026         if (WARN_ON_ONCE(percpu_ref_is_dying(&ctx->refs)))
4027                 return -ENXIO;
4028
4029         if (ctx->submitter_task && ctx->submitter_task != current)
4030                 return -EEXIST;
4031
4032         if (ctx->restricted) {
4033                 opcode = array_index_nospec(opcode, IORING_REGISTER_LAST);
4034                 if (!test_bit(opcode, ctx->restrictions.register_op))
4035                         return -EACCES;
4036         }
4037
4038         switch (opcode) {
4039         case IORING_REGISTER_BUFFERS:
4040                 ret = -EFAULT;
4041                 if (!arg)
4042                         break;
4043                 ret = io_sqe_buffers_register(ctx, arg, nr_args, NULL);
4044                 break;
4045         case IORING_UNREGISTER_BUFFERS:
4046                 ret = -EINVAL;
4047                 if (arg || nr_args)
4048                         break;
4049                 ret = io_sqe_buffers_unregister(ctx);
4050                 break;
4051         case IORING_REGISTER_FILES:
4052                 ret = -EFAULT;
4053                 if (!arg)
4054                         break;
4055                 ret = io_sqe_files_register(ctx, arg, nr_args, NULL);
4056                 break;
4057         case IORING_UNREGISTER_FILES:
4058                 ret = -EINVAL;
4059                 if (arg || nr_args)
4060                         break;
4061                 ret = io_sqe_files_unregister(ctx);
4062                 break;
4063         case IORING_REGISTER_FILES_UPDATE:
4064                 ret = io_register_files_update(ctx, arg, nr_args);
4065                 break;
4066         case IORING_REGISTER_EVENTFD:
4067                 ret = -EINVAL;
4068                 if (nr_args != 1)
4069                         break;
4070                 ret = io_eventfd_register(ctx, arg, 0);
4071                 break;
4072         case IORING_REGISTER_EVENTFD_ASYNC:
4073                 ret = -EINVAL;
4074                 if (nr_args != 1)
4075                         break;
4076                 ret = io_eventfd_register(ctx, arg, 1);
4077                 break;
4078         case IORING_UNREGISTER_EVENTFD:
4079                 ret = -EINVAL;
4080                 if (arg || nr_args)
4081                         break;
4082                 ret = io_eventfd_unregister(ctx);
4083                 break;
4084         case IORING_REGISTER_PROBE:
4085                 ret = -EINVAL;
4086                 if (!arg || nr_args > 256)
4087                         break;
4088                 ret = io_probe(ctx, arg, nr_args);
4089                 break;
4090         case IORING_REGISTER_PERSONALITY:
4091                 ret = -EINVAL;
4092                 if (arg || nr_args)
4093                         break;
4094                 ret = io_register_personality(ctx);
4095                 break;
4096         case IORING_UNREGISTER_PERSONALITY:
4097                 ret = -EINVAL;
4098                 if (arg)
4099                         break;
4100                 ret = io_unregister_personality(ctx, nr_args);
4101                 break;
4102         case IORING_REGISTER_ENABLE_RINGS:
4103                 ret = -EINVAL;
4104                 if (arg || nr_args)
4105                         break;
4106                 ret = io_register_enable_rings(ctx);
4107                 break;
4108         case IORING_REGISTER_RESTRICTIONS:
4109                 ret = io_register_restrictions(ctx, arg, nr_args);
4110                 break;
4111         case IORING_REGISTER_FILES2:
4112                 ret = io_register_rsrc(ctx, arg, nr_args, IORING_RSRC_FILE);
4113                 break;
4114         case IORING_REGISTER_FILES_UPDATE2:
4115                 ret = io_register_rsrc_update(ctx, arg, nr_args,
4116                                               IORING_RSRC_FILE);
4117                 break;
4118         case IORING_REGISTER_BUFFERS2:
4119                 ret = io_register_rsrc(ctx, arg, nr_args, IORING_RSRC_BUFFER);
4120                 break;
4121         case IORING_REGISTER_BUFFERS_UPDATE:
4122                 ret = io_register_rsrc_update(ctx, arg, nr_args,
4123                                               IORING_RSRC_BUFFER);
4124                 break;
4125         case IORING_REGISTER_IOWQ_AFF:
4126                 ret = -EINVAL;
4127                 if (!arg || !nr_args)
4128                         break;
4129                 ret = io_register_iowq_aff(ctx, arg, nr_args);
4130                 break;
4131         case IORING_UNREGISTER_IOWQ_AFF:
4132                 ret = -EINVAL;
4133                 if (arg || nr_args)
4134                         break;
4135                 ret = io_unregister_iowq_aff(ctx);
4136                 break;
4137         case IORING_REGISTER_IOWQ_MAX_WORKERS:
4138                 ret = -EINVAL;
4139                 if (!arg || nr_args != 2)
4140                         break;
4141                 ret = io_register_iowq_max_workers(ctx, arg);
4142                 break;
4143         case IORING_REGISTER_RING_FDS:
4144                 ret = io_ringfd_register(ctx, arg, nr_args);
4145                 break;
4146         case IORING_UNREGISTER_RING_FDS:
4147                 ret = io_ringfd_unregister(ctx, arg, nr_args);
4148                 break;
4149         case IORING_REGISTER_PBUF_RING:
4150                 ret = -EINVAL;
4151                 if (!arg || nr_args != 1)
4152                         break;
4153                 ret = io_register_pbuf_ring(ctx, arg);
4154                 break;
4155         case IORING_UNREGISTER_PBUF_RING:
4156                 ret = -EINVAL;
4157                 if (!arg || nr_args != 1)
4158                         break;
4159                 ret = io_unregister_pbuf_ring(ctx, arg);
4160                 break;
4161         case IORING_REGISTER_SYNC_CANCEL:
4162                 ret = -EINVAL;
4163                 if (!arg || nr_args != 1)
4164                         break;
4165                 ret = io_sync_cancel(ctx, arg);
4166                 break;
4167         case IORING_REGISTER_FILE_ALLOC_RANGE:
4168                 ret = -EINVAL;
4169                 if (!arg || nr_args)
4170                         break;
4171                 ret = io_register_file_alloc_range(ctx, arg);
4172                 break;
4173         default:
4174                 ret = -EINVAL;
4175                 break;
4176         }
4177
4178         return ret;
4179 }
4180
4181 SYSCALL_DEFINE4(io_uring_register, unsigned int, fd, unsigned int, opcode,
4182                 void __user *, arg, unsigned int, nr_args)
4183 {
4184         struct io_ring_ctx *ctx;
4185         long ret = -EBADF;
4186         struct fd f;
4187
4188         if (opcode >= IORING_REGISTER_LAST)
4189                 return -EINVAL;
4190
4191         f = fdget(fd);
4192         if (!f.file)
4193                 return -EBADF;
4194
4195         ret = -EOPNOTSUPP;
4196         if (!io_is_uring_fops(f.file))
4197                 goto out_fput;
4198
4199         ctx = f.file->private_data;
4200
4201         mutex_lock(&ctx->uring_lock);
4202         ret = __io_uring_register(ctx, opcode, arg, nr_args);
4203         mutex_unlock(&ctx->uring_lock);
4204         trace_io_uring_register(ctx, opcode, ctx->nr_user_files, ctx->nr_user_bufs, ret);
4205 out_fput:
4206         fdput(f);
4207         return ret;
4208 }
4209
4210 static int __init io_uring_init(void)
4211 {
4212 #define __BUILD_BUG_VERIFY_OFFSET_SIZE(stype, eoffset, esize, ename) do { \
4213         BUILD_BUG_ON(offsetof(stype, ename) != eoffset); \
4214         BUILD_BUG_ON(sizeof_field(stype, ename) != esize); \
4215 } while (0)
4216
4217 #define BUILD_BUG_SQE_ELEM(eoffset, etype, ename) \
4218         __BUILD_BUG_VERIFY_OFFSET_SIZE(struct io_uring_sqe, eoffset, sizeof(etype), ename)
4219 #define BUILD_BUG_SQE_ELEM_SIZE(eoffset, esize, ename) \
4220         __BUILD_BUG_VERIFY_OFFSET_SIZE(struct io_uring_sqe, eoffset, esize, ename)
4221         BUILD_BUG_ON(sizeof(struct io_uring_sqe) != 64);
4222         BUILD_BUG_SQE_ELEM(0,  __u8,   opcode);
4223         BUILD_BUG_SQE_ELEM(1,  __u8,   flags);
4224         BUILD_BUG_SQE_ELEM(2,  __u16,  ioprio);
4225         BUILD_BUG_SQE_ELEM(4,  __s32,  fd);
4226         BUILD_BUG_SQE_ELEM(8,  __u64,  off);
4227         BUILD_BUG_SQE_ELEM(8,  __u64,  addr2);
4228         BUILD_BUG_SQE_ELEM(8,  __u32,  cmd_op);
4229         BUILD_BUG_SQE_ELEM(12, __u32, __pad1);
4230         BUILD_BUG_SQE_ELEM(16, __u64,  addr);
4231         BUILD_BUG_SQE_ELEM(16, __u64,  splice_off_in);
4232         BUILD_BUG_SQE_ELEM(24, __u32,  len);
4233         BUILD_BUG_SQE_ELEM(28,     __kernel_rwf_t, rw_flags);
4234         BUILD_BUG_SQE_ELEM(28, /* compat */   int, rw_flags);
4235         BUILD_BUG_SQE_ELEM(28, /* compat */ __u32, rw_flags);
4236         BUILD_BUG_SQE_ELEM(28, __u32,  fsync_flags);
4237         BUILD_BUG_SQE_ELEM(28, /* compat */ __u16,  poll_events);
4238         BUILD_BUG_SQE_ELEM(28, __u32,  poll32_events);
4239         BUILD_BUG_SQE_ELEM(28, __u32,  sync_range_flags);
4240         BUILD_BUG_SQE_ELEM(28, __u32,  msg_flags);
4241         BUILD_BUG_SQE_ELEM(28, __u32,  timeout_flags);
4242         BUILD_BUG_SQE_ELEM(28, __u32,  accept_flags);
4243         BUILD_BUG_SQE_ELEM(28, __u32,  cancel_flags);
4244         BUILD_BUG_SQE_ELEM(28, __u32,  open_flags);
4245         BUILD_BUG_SQE_ELEM(28, __u32,  statx_flags);
4246         BUILD_BUG_SQE_ELEM(28, __u32,  fadvise_advice);
4247         BUILD_BUG_SQE_ELEM(28, __u32,  splice_flags);
4248         BUILD_BUG_SQE_ELEM(28, __u32,  rename_flags);
4249         BUILD_BUG_SQE_ELEM(28, __u32,  unlink_flags);
4250         BUILD_BUG_SQE_ELEM(28, __u32,  hardlink_flags);
4251         BUILD_BUG_SQE_ELEM(28, __u32,  xattr_flags);
4252         BUILD_BUG_SQE_ELEM(28, __u32,  msg_ring_flags);
4253         BUILD_BUG_SQE_ELEM(32, __u64,  user_data);
4254         BUILD_BUG_SQE_ELEM(40, __u16,  buf_index);
4255         BUILD_BUG_SQE_ELEM(40, __u16,  buf_group);
4256         BUILD_BUG_SQE_ELEM(42, __u16,  personality);
4257         BUILD_BUG_SQE_ELEM(44, __s32,  splice_fd_in);
4258         BUILD_BUG_SQE_ELEM(44, __u32,  file_index);
4259         BUILD_BUG_SQE_ELEM(44, __u16,  addr_len);
4260         BUILD_BUG_SQE_ELEM(46, __u16,  __pad3[0]);
4261         BUILD_BUG_SQE_ELEM(48, __u64,  addr3);
4262         BUILD_BUG_SQE_ELEM_SIZE(48, 0, cmd);
4263         BUILD_BUG_SQE_ELEM(56, __u64,  __pad2);
4264
4265         BUILD_BUG_ON(sizeof(struct io_uring_files_update) !=
4266                      sizeof(struct io_uring_rsrc_update));
4267         BUILD_BUG_ON(sizeof(struct io_uring_rsrc_update) >
4268                      sizeof(struct io_uring_rsrc_update2));
4269
4270         /* ->buf_index is u16 */
4271         BUILD_BUG_ON(offsetof(struct io_uring_buf_ring, bufs) != 0);
4272         BUILD_BUG_ON(offsetof(struct io_uring_buf, resv) !=
4273                      offsetof(struct io_uring_buf_ring, tail));
4274
4275         /* should fit into one byte */
4276         BUILD_BUG_ON(SQE_VALID_FLAGS >= (1 << 8));
4277         BUILD_BUG_ON(SQE_COMMON_FLAGS >= (1 << 8));
4278         BUILD_BUG_ON((SQE_VALID_FLAGS | SQE_COMMON_FLAGS) != SQE_VALID_FLAGS);
4279
4280         BUILD_BUG_ON(__REQ_F_LAST_BIT > 8 * sizeof(int));
4281
4282         BUILD_BUG_ON(sizeof(atomic_t) != sizeof(u32));
4283
4284         io_uring_optable_init();
4285
4286         req_cachep = KMEM_CACHE(io_kiocb, SLAB_HWCACHE_ALIGN | SLAB_PANIC |
4287                                 SLAB_ACCOUNT);
4288         return 0;
4289 };
4290 __initcall(io_uring_init);