blob: 1b46c72f8975f0f870ca67b80b0da2f3c9dfa0a8 [file] [log] [blame]
Jens Axboe2b188cc2019-01-07 10:46:33 -07001// 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
Stefan Bühler1e84b972019-04-24 23:54:16 +02007 * 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_cqring (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.
Jens Axboe2b188cc2019-01-07 10:46:33 -070029 *
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
Christoph Hellwigc992fe22019-01-11 09:43:02 -070040 * Copyright (c) 2018-2019 Christoph Hellwig
Jens Axboe2b188cc2019-01-07 10:46:33 -070041 */
42#include <linux/kernel.h>
43#include <linux/init.h>
44#include <linux/errno.h>
45#include <linux/syscalls.h>
46#include <linux/compat.h>
47#include <linux/refcount.h>
48#include <linux/uio.h>
49
50#include <linux/sched/signal.h>
51#include <linux/fs.h>
52#include <linux/file.h>
53#include <linux/fdtable.h>
54#include <linux/mm.h>
55#include <linux/mman.h>
56#include <linux/mmu_context.h>
57#include <linux/percpu.h>
58#include <linux/slab.h>
59#include <linux/workqueue.h>
Jens Axboe6c271ce2019-01-10 11:22:30 -070060#include <linux/kthread.h>
Jens Axboe2b188cc2019-01-07 10:46:33 -070061#include <linux/blkdev.h>
Jens Axboeedafcce2019-01-09 09:16:05 -070062#include <linux/bvec.h>
Jens Axboe2b188cc2019-01-07 10:46:33 -070063#include <linux/net.h>
64#include <net/sock.h>
65#include <net/af_unix.h>
Jens Axboe6b063142019-01-10 22:13:58 -070066#include <net/scm.h>
Jens Axboe2b188cc2019-01-07 10:46:33 -070067#include <linux/anon_inodes.h>
68#include <linux/sched/mm.h>
69#include <linux/uaccess.h>
70#include <linux/nospec.h>
Jens Axboeedafcce2019-01-09 09:16:05 -070071#include <linux/sizes.h>
72#include <linux/hugetlb.h>
Jens Axboe2b188cc2019-01-07 10:46:33 -070073
74#include <uapi/linux/io_uring.h>
75
76#include "internal.h"
77
Daniel Xu5277dea2019-09-14 14:23:45 -070078#define IORING_MAX_ENTRIES 32768
Jens Axboe6b063142019-01-10 22:13:58 -070079#define IORING_MAX_FIXED_FILES 1024
Jens Axboe2b188cc2019-01-07 10:46:33 -070080
81struct io_uring {
82 u32 head ____cacheline_aligned_in_smp;
83 u32 tail ____cacheline_aligned_in_smp;
84};
85
Stefan Bühler1e84b972019-04-24 23:54:16 +020086/*
Hristo Venev75b28af2019-08-26 17:23:46 +000087 * This data is shared with the application through the mmap at offsets
88 * IORING_OFF_SQ_RING and IORING_OFF_CQ_RING.
Stefan Bühler1e84b972019-04-24 23:54:16 +020089 *
90 * The offsets to the member fields are published through struct
91 * io_sqring_offsets when calling io_uring_setup.
92 */
Hristo Venev75b28af2019-08-26 17:23:46 +000093struct io_rings {
Stefan Bühler1e84b972019-04-24 23:54:16 +020094 /*
95 * Head and tail offsets into the ring; the offsets need to be
96 * masked to get valid indices.
97 *
Hristo Venev75b28af2019-08-26 17:23:46 +000098 * The kernel controls head of the sq ring and the tail of the cq ring,
99 * and the application controls tail of the sq ring and the head of the
100 * cq ring.
Stefan Bühler1e84b972019-04-24 23:54:16 +0200101 */
Hristo Venev75b28af2019-08-26 17:23:46 +0000102 struct io_uring sq, cq;
Stefan Bühler1e84b972019-04-24 23:54:16 +0200103 /*
Hristo Venev75b28af2019-08-26 17:23:46 +0000104 * Bitmasks to apply to head and tail offsets (constant, equals
Stefan Bühler1e84b972019-04-24 23:54:16 +0200105 * ring_entries - 1)
106 */
Hristo Venev75b28af2019-08-26 17:23:46 +0000107 u32 sq_ring_mask, cq_ring_mask;
108 /* Ring sizes (constant, power of 2) */
109 u32 sq_ring_entries, cq_ring_entries;
Stefan Bühler1e84b972019-04-24 23:54:16 +0200110 /*
111 * Number of invalid entries dropped by the kernel due to
112 * invalid index stored in array
113 *
114 * Written by the kernel, shouldn't be modified by the
115 * application (i.e. get number of "new events" by comparing to
116 * cached value).
117 *
118 * After a new SQ head value was read by the application this
119 * counter includes all submissions that were dropped reaching
120 * the new SQ head (and possibly more).
121 */
Hristo Venev75b28af2019-08-26 17:23:46 +0000122 u32 sq_dropped;
Stefan Bühler1e84b972019-04-24 23:54:16 +0200123 /*
124 * Runtime flags
125 *
126 * Written by the kernel, shouldn't be modified by the
127 * application.
128 *
129 * The application needs a full memory barrier before checking
130 * for IORING_SQ_NEED_WAKEUP after updating the sq tail.
131 */
Hristo Venev75b28af2019-08-26 17:23:46 +0000132 u32 sq_flags;
Stefan Bühler1e84b972019-04-24 23:54:16 +0200133 /*
134 * Number of completion events lost because the queue was full;
135 * this should be avoided by the application by making sure
136 * there are not more requests pending thatn there is space in
137 * the completion queue.
138 *
139 * Written by the kernel, shouldn't be modified by the
140 * application (i.e. get number of "new events" by comparing to
141 * cached value).
142 *
143 * As completion events come in out of order this counter is not
144 * ordered with any other data.
145 */
Hristo Venev75b28af2019-08-26 17:23:46 +0000146 u32 cq_overflow;
Stefan Bühler1e84b972019-04-24 23:54:16 +0200147 /*
148 * Ring buffer of completion events.
149 *
150 * The kernel writes completion events fresh every time they are
151 * produced, so the application is allowed to modify pending
152 * entries.
153 */
Hristo Venev75b28af2019-08-26 17:23:46 +0000154 struct io_uring_cqe cqes[] ____cacheline_aligned_in_smp;
Jens Axboe2b188cc2019-01-07 10:46:33 -0700155};
156
Jens Axboeedafcce2019-01-09 09:16:05 -0700157struct io_mapped_ubuf {
158 u64 ubuf;
159 size_t len;
160 struct bio_vec *bvec;
161 unsigned int nr_bvecs;
162};
163
Jens Axboe31b51512019-01-18 22:56:34 -0700164struct async_list {
165 spinlock_t lock;
166 atomic_t cnt;
167 struct list_head list;
168
169 struct file *file;
Jens Axboe6d5d5ac2019-09-11 10:16:13 -0600170 off_t io_start;
Zhengyuan Liu9310a7ba2019-07-22 10:23:27 +0800171 size_t io_len;
Jens Axboe31b51512019-01-18 22:56:34 -0700172};
173
Jens Axboe2b188cc2019-01-07 10:46:33 -0700174struct io_ring_ctx {
175 struct {
176 struct percpu_ref refs;
177 } ____cacheline_aligned_in_smp;
178
179 struct {
180 unsigned int flags;
181 bool compat;
182 bool account_mem;
183
Hristo Venev75b28af2019-08-26 17:23:46 +0000184 /*
185 * Ring buffer of indices into array of io_uring_sqe, which is
186 * mmapped by the application using the IORING_OFF_SQES offset.
187 *
188 * This indirection could e.g. be used to assign fixed
189 * io_uring_sqe entries to operations and only submit them to
190 * the queue when needed.
191 *
192 * The kernel modifies neither the indices array nor the entries
193 * array.
194 */
195 u32 *sq_array;
Jens Axboe2b188cc2019-01-07 10:46:33 -0700196 unsigned cached_sq_head;
197 unsigned sq_entries;
198 unsigned sq_mask;
Jens Axboe6c271ce2019-01-10 11:22:30 -0700199 unsigned sq_thread_idle;
Jens Axboe2b188cc2019-01-07 10:46:33 -0700200 struct io_uring_sqe *sq_sqes;
Jens Axboede0617e2019-04-06 21:51:27 -0600201
202 struct list_head defer_list;
Jens Axboe5262f562019-09-17 12:26:57 -0600203 struct list_head timeout_list;
Jens Axboe2b188cc2019-01-07 10:46:33 -0700204 } ____cacheline_aligned_in_smp;
205
206 /* IO offload */
Jens Axboe54a91f32019-09-10 09:15:04 -0600207 struct workqueue_struct *sqo_wq[2];
Jens Axboe6c271ce2019-01-10 11:22:30 -0700208 struct task_struct *sqo_thread; /* if using sq thread polling */
Jens Axboe2b188cc2019-01-07 10:46:33 -0700209 struct mm_struct *sqo_mm;
Jens Axboe6c271ce2019-01-10 11:22:30 -0700210 wait_queue_head_t sqo_wait;
Jackie Liua4c0b3d2019-07-08 13:41:12 +0800211 struct completion sqo_thread_started;
Jens Axboe2b188cc2019-01-07 10:46:33 -0700212
213 struct {
Jens Axboe2b188cc2019-01-07 10:46:33 -0700214 unsigned cached_cq_tail;
215 unsigned cq_entries;
216 unsigned cq_mask;
217 struct wait_queue_head cq_wait;
218 struct fasync_struct *cq_fasync;
Jens Axboe9b402842019-04-11 11:45:41 -0600219 struct eventfd_ctx *cq_ev_fd;
Jens Axboe5262f562019-09-17 12:26:57 -0600220 atomic_t cq_timeouts;
Jens Axboe2b188cc2019-01-07 10:46:33 -0700221 } ____cacheline_aligned_in_smp;
222
Hristo Venev75b28af2019-08-26 17:23:46 +0000223 struct io_rings *rings;
224
Jens Axboe6b063142019-01-10 22:13:58 -0700225 /*
226 * If used, fixed file set. Writers must ensure that ->refs is dead,
227 * readers must ensure that ->refs is alive as long as the file* is
228 * used. Only updated through io_uring_register(2).
229 */
230 struct file **user_files;
231 unsigned nr_user_files;
232
Jens Axboeedafcce2019-01-09 09:16:05 -0700233 /* if used, fixed mapped user buffers */
234 unsigned nr_user_bufs;
235 struct io_mapped_ubuf *user_bufs;
236
Jens Axboe2b188cc2019-01-07 10:46:33 -0700237 struct user_struct *user;
238
239 struct completion ctx_done;
240
241 struct {
242 struct mutex uring_lock;
243 wait_queue_head_t wait;
244 } ____cacheline_aligned_in_smp;
245
246 struct {
247 spinlock_t completion_lock;
Jens Axboedef596e2019-01-09 08:59:42 -0700248 bool poll_multi_file;
249 /*
250 * ->poll_list is protected by the ctx->uring_lock for
251 * io_uring instances that don't use IORING_SETUP_SQPOLL.
252 * For SQPOLL, only the single threaded io_sq_thread() will
253 * manipulate the list, hence no extra locking is needed there.
254 */
255 struct list_head poll_list;
Jens Axboe221c5eb2019-01-17 09:41:58 -0700256 struct list_head cancel_list;
Jens Axboe2b188cc2019-01-07 10:46:33 -0700257 } ____cacheline_aligned_in_smp;
258
Jens Axboe31b51512019-01-18 22:56:34 -0700259 struct async_list pending_async[2];
260
Jens Axboe2b188cc2019-01-07 10:46:33 -0700261#if defined(CONFIG_UNIX)
262 struct socket *ring_sock;
263#endif
264};
265
266struct sqe_submit {
267 const struct io_uring_sqe *sqe;
268 unsigned short index;
Jackie Liu8776f3f2019-09-09 20:50:39 +0800269 u32 sequence;
Jens Axboe2b188cc2019-01-07 10:46:33 -0700270 bool has_user;
Jens Axboedef596e2019-01-09 08:59:42 -0700271 bool needs_lock;
Jens Axboe6c271ce2019-01-10 11:22:30 -0700272 bool needs_fixed_file;
Jens Axboe2b188cc2019-01-07 10:46:33 -0700273};
274
Jens Axboe09bb8392019-03-13 12:39:28 -0600275/*
276 * First field must be the file pointer in all the
277 * iocb unions! See also 'struct kiocb' in <linux/fs.h>
278 */
Jens Axboe221c5eb2019-01-17 09:41:58 -0700279struct io_poll_iocb {
280 struct file *file;
281 struct wait_queue_head *head;
282 __poll_t events;
Jens Axboe8c838782019-03-12 15:48:16 -0600283 bool done;
Jens Axboe221c5eb2019-01-17 09:41:58 -0700284 bool canceled;
285 struct wait_queue_entry wait;
286};
287
Jens Axboe5262f562019-09-17 12:26:57 -0600288struct io_timeout {
289 struct file *file;
290 struct hrtimer timer;
291};
292
Jens Axboe09bb8392019-03-13 12:39:28 -0600293/*
294 * NOTE! Each of the iocb union members has the file pointer
295 * as the first entry in their struct definition. So you can
296 * access the file pointer through any of the sub-structs,
297 * or directly as just 'ki_filp' in this struct.
298 */
Jens Axboe2b188cc2019-01-07 10:46:33 -0700299struct io_kiocb {
Jens Axboe221c5eb2019-01-17 09:41:58 -0700300 union {
Jens Axboe09bb8392019-03-13 12:39:28 -0600301 struct file *file;
Jens Axboe221c5eb2019-01-17 09:41:58 -0700302 struct kiocb rw;
303 struct io_poll_iocb poll;
Jens Axboe5262f562019-09-17 12:26:57 -0600304 struct io_timeout timeout;
Jens Axboe221c5eb2019-01-17 09:41:58 -0700305 };
Jens Axboe2b188cc2019-01-07 10:46:33 -0700306
307 struct sqe_submit submit;
308
309 struct io_ring_ctx *ctx;
310 struct list_head list;
Jens Axboe9e645e112019-05-10 16:07:28 -0600311 struct list_head link_list;
Jens Axboe2b188cc2019-01-07 10:46:33 -0700312 unsigned int flags;
Jens Axboec16361c2019-01-17 08:39:48 -0700313 refcount_t refs;
Stefan Bühler8449eed2019-04-27 20:34:19 +0200314#define REQ_F_NOWAIT 1 /* must not punt to workers */
Jens Axboedef596e2019-01-09 08:59:42 -0700315#define REQ_F_IOPOLL_COMPLETED 2 /* polled IO has completed */
Jens Axboe6b063142019-01-10 22:13:58 -0700316#define REQ_F_FIXED_FILE 4 /* ctx owns file */
Jens Axboe31b51512019-01-18 22:56:34 -0700317#define REQ_F_SEQ_PREV 8 /* sequential with previous */
Stefan Bühlere2033e32019-05-11 19:08:01 +0200318#define REQ_F_IO_DRAIN 16 /* drain existing IO first */
319#define REQ_F_IO_DRAINED 32 /* drain done */
Jens Axboe9e645e112019-05-10 16:07:28 -0600320#define REQ_F_LINK 64 /* linked sqes */
Zhengyuan Liuf7b76ac2019-07-16 23:26:14 +0800321#define REQ_F_LINK_DONE 128 /* linked sqes done */
322#define REQ_F_FAIL_LINK 256 /* fail rest of links */
Jackie Liu4fe2c962019-09-09 20:50:40 +0800323#define REQ_F_SHADOW_DRAIN 512 /* link-drain shadow req */
Jens Axboe5262f562019-09-17 12:26:57 -0600324#define REQ_F_TIMEOUT 1024 /* timeout request */
Jens Axboe491381ce2019-10-17 09:20:46 -0600325#define REQ_F_ISREG 2048 /* regular file */
326#define REQ_F_MUST_PUNT 4096 /* must be punted even for NONBLOCK */
Jens Axboe2b188cc2019-01-07 10:46:33 -0700327 u64 user_data;
Jens Axboe9e645e112019-05-10 16:07:28 -0600328 u32 result;
Jens Axboede0617e2019-04-06 21:51:27 -0600329 u32 sequence;
Jens Axboe2b188cc2019-01-07 10:46:33 -0700330
331 struct work_struct work;
332};
333
334#define IO_PLUG_THRESHOLD 2
Jens Axboedef596e2019-01-09 08:59:42 -0700335#define IO_IOPOLL_BATCH 8
Jens Axboe2b188cc2019-01-07 10:46:33 -0700336
Jens Axboe9a56a232019-01-09 09:06:50 -0700337struct io_submit_state {
338 struct blk_plug plug;
339
340 /*
Jens Axboe2579f912019-01-09 09:10:43 -0700341 * io_kiocb alloc cache
342 */
343 void *reqs[IO_IOPOLL_BATCH];
344 unsigned int free_reqs;
345 unsigned int cur_req;
346
347 /*
Jens Axboe9a56a232019-01-09 09:06:50 -0700348 * File reference cache
349 */
350 struct file *file;
351 unsigned int fd;
352 unsigned int has_refs;
353 unsigned int used_refs;
354 unsigned int ios_left;
355};
356
Jens Axboede0617e2019-04-06 21:51:27 -0600357static void io_sq_wq_submit_work(struct work_struct *work);
Jens Axboe5262f562019-09-17 12:26:57 -0600358static void io_cqring_fill_event(struct io_ring_ctx *ctx, u64 ki_user_data,
359 long res);
Jackie Liu4fe2c962019-09-09 20:50:40 +0800360static void __io_free_req(struct io_kiocb *req);
Jens Axboede0617e2019-04-06 21:51:27 -0600361
Jens Axboe2b188cc2019-01-07 10:46:33 -0700362static struct kmem_cache *req_cachep;
363
364static const struct file_operations io_uring_fops;
365
366struct sock *io_uring_get_socket(struct file *file)
367{
368#if defined(CONFIG_UNIX)
369 if (file->f_op == &io_uring_fops) {
370 struct io_ring_ctx *ctx = file->private_data;
371
372 return ctx->ring_sock->sk;
373 }
374#endif
375 return NULL;
376}
377EXPORT_SYMBOL(io_uring_get_socket);
378
379static void io_ring_ctx_ref_free(struct percpu_ref *ref)
380{
381 struct io_ring_ctx *ctx = container_of(ref, struct io_ring_ctx, refs);
382
383 complete(&ctx->ctx_done);
384}
385
386static struct io_ring_ctx *io_ring_ctx_alloc(struct io_uring_params *p)
387{
388 struct io_ring_ctx *ctx;
Jens Axboe31b51512019-01-18 22:56:34 -0700389 int i;
Jens Axboe2b188cc2019-01-07 10:46:33 -0700390
391 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
392 if (!ctx)
393 return NULL;
394
Roman Gushchin21482892019-05-07 10:01:48 -0700395 if (percpu_ref_init(&ctx->refs, io_ring_ctx_ref_free,
396 PERCPU_REF_ALLOW_REINIT, GFP_KERNEL)) {
Jens Axboe2b188cc2019-01-07 10:46:33 -0700397 kfree(ctx);
398 return NULL;
399 }
400
401 ctx->flags = p->flags;
402 init_waitqueue_head(&ctx->cq_wait);
403 init_completion(&ctx->ctx_done);
Jackie Liua4c0b3d2019-07-08 13:41:12 +0800404 init_completion(&ctx->sqo_thread_started);
Jens Axboe2b188cc2019-01-07 10:46:33 -0700405 mutex_init(&ctx->uring_lock);
406 init_waitqueue_head(&ctx->wait);
Jens Axboe31b51512019-01-18 22:56:34 -0700407 for (i = 0; i < ARRAY_SIZE(ctx->pending_async); i++) {
408 spin_lock_init(&ctx->pending_async[i].lock);
409 INIT_LIST_HEAD(&ctx->pending_async[i].list);
410 atomic_set(&ctx->pending_async[i].cnt, 0);
411 }
Jens Axboe2b188cc2019-01-07 10:46:33 -0700412 spin_lock_init(&ctx->completion_lock);
Jens Axboedef596e2019-01-09 08:59:42 -0700413 INIT_LIST_HEAD(&ctx->poll_list);
Jens Axboe221c5eb2019-01-17 09:41:58 -0700414 INIT_LIST_HEAD(&ctx->cancel_list);
Jens Axboede0617e2019-04-06 21:51:27 -0600415 INIT_LIST_HEAD(&ctx->defer_list);
Jens Axboe5262f562019-09-17 12:26:57 -0600416 INIT_LIST_HEAD(&ctx->timeout_list);
Jens Axboe2b188cc2019-01-07 10:46:33 -0700417 return ctx;
418}
419
Jens Axboe7adf4ea2019-10-10 21:42:58 -0600420static inline bool __io_sequence_defer(struct io_ring_ctx *ctx,
421 struct io_kiocb *req)
Jens Axboede0617e2019-04-06 21:51:27 -0600422{
Hristo Venev75b28af2019-08-26 17:23:46 +0000423 return req->sequence != ctx->cached_cq_tail + ctx->rings->sq_dropped;
Jens Axboede0617e2019-04-06 21:51:27 -0600424}
425
Jens Axboe7adf4ea2019-10-10 21:42:58 -0600426static inline bool io_sequence_defer(struct io_ring_ctx *ctx,
427 struct io_kiocb *req)
428{
429 if ((req->flags & (REQ_F_IO_DRAIN|REQ_F_IO_DRAINED)) != REQ_F_IO_DRAIN)
430 return false;
431
432 return __io_sequence_defer(ctx, req);
433}
434
435static struct io_kiocb *io_get_deferred_req(struct io_ring_ctx *ctx)
Jens Axboede0617e2019-04-06 21:51:27 -0600436{
437 struct io_kiocb *req;
438
Jens Axboe7adf4ea2019-10-10 21:42:58 -0600439 req = list_first_entry_or_null(&ctx->defer_list, struct io_kiocb, list);
440 if (req && !io_sequence_defer(ctx, req)) {
Jens Axboede0617e2019-04-06 21:51:27 -0600441 list_del_init(&req->list);
442 return req;
443 }
444
445 return NULL;
446}
447
Jens Axboe5262f562019-09-17 12:26:57 -0600448static struct io_kiocb *io_get_timeout_req(struct io_ring_ctx *ctx)
449{
Jens Axboe7adf4ea2019-10-10 21:42:58 -0600450 struct io_kiocb *req;
451
452 req = list_first_entry_or_null(&ctx->timeout_list, struct io_kiocb, list);
453 if (req && !__io_sequence_defer(ctx, req)) {
454 list_del_init(&req->list);
455 return req;
456 }
457
458 return NULL;
Jens Axboe5262f562019-09-17 12:26:57 -0600459}
460
Jens Axboede0617e2019-04-06 21:51:27 -0600461static void __io_commit_cqring(struct io_ring_ctx *ctx)
Jens Axboe2b188cc2019-01-07 10:46:33 -0700462{
Hristo Venev75b28af2019-08-26 17:23:46 +0000463 struct io_rings *rings = ctx->rings;
Jens Axboe2b188cc2019-01-07 10:46:33 -0700464
Hristo Venev75b28af2019-08-26 17:23:46 +0000465 if (ctx->cached_cq_tail != READ_ONCE(rings->cq.tail)) {
Jens Axboe2b188cc2019-01-07 10:46:33 -0700466 /* order cqe stores with ring update */
Hristo Venev75b28af2019-08-26 17:23:46 +0000467 smp_store_release(&rings->cq.tail, ctx->cached_cq_tail);
Jens Axboe2b188cc2019-01-07 10:46:33 -0700468
Jens Axboe2b188cc2019-01-07 10:46:33 -0700469 if (wq_has_sleeper(&ctx->cq_wait)) {
470 wake_up_interruptible(&ctx->cq_wait);
471 kill_fasync(&ctx->cq_fasync, SIGIO, POLL_IN);
472 }
473 }
474}
475
Jens Axboe18d9be12019-09-10 09:13:05 -0600476static inline void io_queue_async_work(struct io_ring_ctx *ctx,
477 struct io_kiocb *req)
478{
Jens Axboe6cc47d12019-09-18 11:18:23 -0600479 int rw = 0;
Jens Axboe54a91f32019-09-10 09:15:04 -0600480
Jens Axboe6cc47d12019-09-18 11:18:23 -0600481 if (req->submit.sqe) {
482 switch (req->submit.sqe->opcode) {
483 case IORING_OP_WRITEV:
484 case IORING_OP_WRITE_FIXED:
485 rw = !(req->rw.ki_flags & IOCB_DIRECT);
486 break;
487 }
Jens Axboe54a91f32019-09-10 09:15:04 -0600488 }
489
490 queue_work(ctx->sqo_wq[rw], &req->work);
Jens Axboe18d9be12019-09-10 09:13:05 -0600491}
492
Jens Axboe5262f562019-09-17 12:26:57 -0600493static void io_kill_timeout(struct io_kiocb *req)
494{
495 int ret;
496
497 ret = hrtimer_try_to_cancel(&req->timeout.timer);
498 if (ret != -1) {
499 atomic_inc(&req->ctx->cq_timeouts);
500 list_del(&req->list);
501 io_cqring_fill_event(req->ctx, req->user_data, 0);
502 __io_free_req(req);
503 }
504}
505
506static void io_kill_timeouts(struct io_ring_ctx *ctx)
507{
508 struct io_kiocb *req, *tmp;
509
510 spin_lock_irq(&ctx->completion_lock);
511 list_for_each_entry_safe(req, tmp, &ctx->timeout_list, list)
512 io_kill_timeout(req);
513 spin_unlock_irq(&ctx->completion_lock);
514}
515
Jens Axboede0617e2019-04-06 21:51:27 -0600516static void io_commit_cqring(struct io_ring_ctx *ctx)
517{
518 struct io_kiocb *req;
519
Jens Axboe5262f562019-09-17 12:26:57 -0600520 while ((req = io_get_timeout_req(ctx)) != NULL)
521 io_kill_timeout(req);
522
Jens Axboede0617e2019-04-06 21:51:27 -0600523 __io_commit_cqring(ctx);
524
525 while ((req = io_get_deferred_req(ctx)) != NULL) {
Jackie Liu4fe2c962019-09-09 20:50:40 +0800526 if (req->flags & REQ_F_SHADOW_DRAIN) {
527 /* Just for drain, free it. */
528 __io_free_req(req);
529 continue;
530 }
Jens Axboede0617e2019-04-06 21:51:27 -0600531 req->flags |= REQ_F_IO_DRAINED;
Jens Axboe18d9be12019-09-10 09:13:05 -0600532 io_queue_async_work(ctx, req);
Jens Axboede0617e2019-04-06 21:51:27 -0600533 }
534}
535
Jens Axboe2b188cc2019-01-07 10:46:33 -0700536static struct io_uring_cqe *io_get_cqring(struct io_ring_ctx *ctx)
537{
Hristo Venev75b28af2019-08-26 17:23:46 +0000538 struct io_rings *rings = ctx->rings;
Jens Axboe2b188cc2019-01-07 10:46:33 -0700539 unsigned tail;
540
541 tail = ctx->cached_cq_tail;
Stefan Bühler115e12e2019-04-24 23:54:18 +0200542 /*
543 * writes to the cq entry need to come after reading head; the
544 * control dependency is enough as we're using WRITE_ONCE to
545 * fill the cq entry
546 */
Hristo Venev75b28af2019-08-26 17:23:46 +0000547 if (tail - READ_ONCE(rings->cq.head) == rings->cq_ring_entries)
Jens Axboe2b188cc2019-01-07 10:46:33 -0700548 return NULL;
549
550 ctx->cached_cq_tail++;
Hristo Venev75b28af2019-08-26 17:23:46 +0000551 return &rings->cqes[tail & ctx->cq_mask];
Jens Axboe2b188cc2019-01-07 10:46:33 -0700552}
553
554static void io_cqring_fill_event(struct io_ring_ctx *ctx, u64 ki_user_data,
Jens Axboec71ffb62019-05-13 20:58:29 -0600555 long res)
Jens Axboe2b188cc2019-01-07 10:46:33 -0700556{
557 struct io_uring_cqe *cqe;
558
559 /*
560 * If we can't get a cq entry, userspace overflowed the
561 * submission (by quite a lot). Increment the overflow count in
562 * the ring.
563 */
564 cqe = io_get_cqring(ctx);
565 if (cqe) {
566 WRITE_ONCE(cqe->user_data, ki_user_data);
567 WRITE_ONCE(cqe->res, res);
Jens Axboec71ffb62019-05-13 20:58:29 -0600568 WRITE_ONCE(cqe->flags, 0);
Jens Axboe2b188cc2019-01-07 10:46:33 -0700569 } else {
Hristo Venev75b28af2019-08-26 17:23:46 +0000570 unsigned overflow = READ_ONCE(ctx->rings->cq_overflow);
Jens Axboe2b188cc2019-01-07 10:46:33 -0700571
Hristo Venev75b28af2019-08-26 17:23:46 +0000572 WRITE_ONCE(ctx->rings->cq_overflow, overflow + 1);
Jens Axboe2b188cc2019-01-07 10:46:33 -0700573 }
574}
575
Jens Axboe8c838782019-03-12 15:48:16 -0600576static void io_cqring_ev_posted(struct io_ring_ctx *ctx)
577{
578 if (waitqueue_active(&ctx->wait))
579 wake_up(&ctx->wait);
580 if (waitqueue_active(&ctx->sqo_wait))
581 wake_up(&ctx->sqo_wait);
Jens Axboe9b402842019-04-11 11:45:41 -0600582 if (ctx->cq_ev_fd)
583 eventfd_signal(ctx->cq_ev_fd, 1);
Jens Axboe8c838782019-03-12 15:48:16 -0600584}
585
586static void io_cqring_add_event(struct io_ring_ctx *ctx, u64 user_data,
Jens Axboec71ffb62019-05-13 20:58:29 -0600587 long res)
Jens Axboe2b188cc2019-01-07 10:46:33 -0700588{
589 unsigned long flags;
590
591 spin_lock_irqsave(&ctx->completion_lock, flags);
Jens Axboec71ffb62019-05-13 20:58:29 -0600592 io_cqring_fill_event(ctx, user_data, res);
Jens Axboe2b188cc2019-01-07 10:46:33 -0700593 io_commit_cqring(ctx);
594 spin_unlock_irqrestore(&ctx->completion_lock, flags);
595
Jens Axboe8c838782019-03-12 15:48:16 -0600596 io_cqring_ev_posted(ctx);
Jens Axboe2b188cc2019-01-07 10:46:33 -0700597}
598
Jens Axboe2579f912019-01-09 09:10:43 -0700599static struct io_kiocb *io_get_req(struct io_ring_ctx *ctx,
600 struct io_submit_state *state)
Jens Axboe2b188cc2019-01-07 10:46:33 -0700601{
Jens Axboefd6fab22019-03-14 16:30:06 -0600602 gfp_t gfp = GFP_KERNEL | __GFP_NOWARN;
Jens Axboe2b188cc2019-01-07 10:46:33 -0700603 struct io_kiocb *req;
604
605 if (!percpu_ref_tryget(&ctx->refs))
606 return NULL;
607
Jens Axboe2579f912019-01-09 09:10:43 -0700608 if (!state) {
Jens Axboefd6fab22019-03-14 16:30:06 -0600609 req = kmem_cache_alloc(req_cachep, gfp);
Jens Axboe2579f912019-01-09 09:10:43 -0700610 if (unlikely(!req))
611 goto out;
612 } else if (!state->free_reqs) {
613 size_t sz;
614 int ret;
615
616 sz = min_t(size_t, state->ios_left, ARRAY_SIZE(state->reqs));
Jens Axboefd6fab22019-03-14 16:30:06 -0600617 ret = kmem_cache_alloc_bulk(req_cachep, gfp, sz, state->reqs);
618
619 /*
620 * Bulk alloc is all-or-nothing. If we fail to get a batch,
621 * retry single alloc to be on the safe side.
622 */
623 if (unlikely(ret <= 0)) {
624 state->reqs[0] = kmem_cache_alloc(req_cachep, gfp);
625 if (!state->reqs[0])
626 goto out;
627 ret = 1;
628 }
Jens Axboe2579f912019-01-09 09:10:43 -0700629 state->free_reqs = ret - 1;
630 state->cur_req = 1;
631 req = state->reqs[0];
632 } else {
633 req = state->reqs[state->cur_req];
634 state->free_reqs--;
635 state->cur_req++;
Jens Axboe2b188cc2019-01-07 10:46:33 -0700636 }
637
Jens Axboe60c112b2019-06-21 10:20:18 -0600638 req->file = NULL;
Jens Axboe2579f912019-01-09 09:10:43 -0700639 req->ctx = ctx;
640 req->flags = 0;
Jens Axboee65ef562019-03-12 10:16:44 -0600641 /* one is dropped after submission, the other at completion */
642 refcount_set(&req->refs, 2);
Jens Axboe9e645e112019-05-10 16:07:28 -0600643 req->result = 0;
Jens Axboe2579f912019-01-09 09:10:43 -0700644 return req;
645out:
Pavel Begunkov6805b322019-10-08 02:18:42 +0300646 percpu_ref_put(&ctx->refs);
Jens Axboe2b188cc2019-01-07 10:46:33 -0700647 return NULL;
648}
649
Jens Axboedef596e2019-01-09 08:59:42 -0700650static void io_free_req_many(struct io_ring_ctx *ctx, void **reqs, int *nr)
651{
652 if (*nr) {
653 kmem_cache_free_bulk(req_cachep, *nr, reqs);
Pavel Begunkov6805b322019-10-08 02:18:42 +0300654 percpu_ref_put_many(&ctx->refs, *nr);
Jens Axboedef596e2019-01-09 08:59:42 -0700655 *nr = 0;
656 }
657}
658
Jens Axboe9e645e112019-05-10 16:07:28 -0600659static void __io_free_req(struct io_kiocb *req)
Jens Axboe2b188cc2019-01-07 10:46:33 -0700660{
Jens Axboe09bb8392019-03-13 12:39:28 -0600661 if (req->file && !(req->flags & REQ_F_FIXED_FILE))
662 fput(req->file);
Pavel Begunkov6805b322019-10-08 02:18:42 +0300663 percpu_ref_put(&req->ctx->refs);
Jens Axboee65ef562019-03-12 10:16:44 -0600664 kmem_cache_free(req_cachep, req);
665}
666
Jens Axboe9e645e112019-05-10 16:07:28 -0600667static void io_req_link_next(struct io_kiocb *req)
668{
669 struct io_kiocb *nxt;
670
671 /*
672 * The list should never be empty when we are called here. But could
673 * potentially happen if the chain is messed up, check to be on the
674 * safe side.
675 */
676 nxt = list_first_entry_or_null(&req->link_list, struct io_kiocb, list);
677 if (nxt) {
678 list_del(&nxt->list);
679 if (!list_empty(&req->link_list)) {
680 INIT_LIST_HEAD(&nxt->link_list);
681 list_splice(&req->link_list, &nxt->link_list);
682 nxt->flags |= REQ_F_LINK;
683 }
684
Zhengyuan Liuf7b76ac2019-07-16 23:26:14 +0800685 nxt->flags |= REQ_F_LINK_DONE;
Jens Axboe9e645e112019-05-10 16:07:28 -0600686 INIT_WORK(&nxt->work, io_sq_wq_submit_work);
Jens Axboe18d9be12019-09-10 09:13:05 -0600687 io_queue_async_work(req->ctx, nxt);
Jens Axboe9e645e112019-05-10 16:07:28 -0600688 }
689}
690
691/*
692 * Called if REQ_F_LINK is set, and we fail the head request
693 */
694static void io_fail_links(struct io_kiocb *req)
695{
696 struct io_kiocb *link;
697
698 while (!list_empty(&req->link_list)) {
699 link = list_first_entry(&req->link_list, struct io_kiocb, list);
700 list_del(&link->list);
701
702 io_cqring_add_event(req->ctx, link->user_data, -ECANCELED);
703 __io_free_req(link);
704 }
705}
706
707static void io_free_req(struct io_kiocb *req)
708{
709 /*
710 * If LINK is set, we have dependent requests in this chain. If we
711 * didn't fail this request, queue the first one up, moving any other
712 * dependencies to the next request. In case of failure, fail the rest
713 * of the chain.
714 */
715 if (req->flags & REQ_F_LINK) {
716 if (req->flags & REQ_F_FAIL_LINK)
717 io_fail_links(req);
718 else
719 io_req_link_next(req);
720 }
721
722 __io_free_req(req);
723}
724
Jens Axboee65ef562019-03-12 10:16:44 -0600725static void io_put_req(struct io_kiocb *req)
726{
727 if (refcount_dec_and_test(&req->refs))
728 io_free_req(req);
Jens Axboe2b188cc2019-01-07 10:46:33 -0700729}
730
Hristo Venev75b28af2019-08-26 17:23:46 +0000731static unsigned io_cqring_events(struct io_rings *rings)
Jens Axboea3a0e432019-08-20 11:03:11 -0600732{
733 /* See comment at the top of this file */
734 smp_rmb();
Hristo Venev75b28af2019-08-26 17:23:46 +0000735 return READ_ONCE(rings->cq.tail) - READ_ONCE(rings->cq.head);
Jens Axboea3a0e432019-08-20 11:03:11 -0600736}
737
Jens Axboedef596e2019-01-09 08:59:42 -0700738/*
739 * Find and free completed poll iocbs
740 */
741static void io_iopoll_complete(struct io_ring_ctx *ctx, unsigned int *nr_events,
742 struct list_head *done)
743{
744 void *reqs[IO_IOPOLL_BATCH];
745 struct io_kiocb *req;
Jens Axboe09bb8392019-03-13 12:39:28 -0600746 int to_free;
Jens Axboedef596e2019-01-09 08:59:42 -0700747
Jens Axboe09bb8392019-03-13 12:39:28 -0600748 to_free = 0;
Jens Axboedef596e2019-01-09 08:59:42 -0700749 while (!list_empty(done)) {
750 req = list_first_entry(done, struct io_kiocb, list);
751 list_del(&req->list);
752
Jens Axboe9e645e112019-05-10 16:07:28 -0600753 io_cqring_fill_event(ctx, req->user_data, req->result);
Jens Axboedef596e2019-01-09 08:59:42 -0700754 (*nr_events)++;
755
Jens Axboe09bb8392019-03-13 12:39:28 -0600756 if (refcount_dec_and_test(&req->refs)) {
757 /* If we're not using fixed files, we have to pair the
758 * completion part with the file put. Use regular
759 * completions for those, only batch free for fixed
Jens Axboe9e645e112019-05-10 16:07:28 -0600760 * file and non-linked commands.
Jens Axboe09bb8392019-03-13 12:39:28 -0600761 */
Jens Axboe9e645e112019-05-10 16:07:28 -0600762 if ((req->flags & (REQ_F_FIXED_FILE|REQ_F_LINK)) ==
763 REQ_F_FIXED_FILE) {
Jens Axboe09bb8392019-03-13 12:39:28 -0600764 reqs[to_free++] = req;
765 if (to_free == ARRAY_SIZE(reqs))
766 io_free_req_many(ctx, reqs, &to_free);
Jens Axboe6b063142019-01-10 22:13:58 -0700767 } else {
Jens Axboe09bb8392019-03-13 12:39:28 -0600768 io_free_req(req);
Jens Axboe6b063142019-01-10 22:13:58 -0700769 }
Jens Axboe9a56a232019-01-09 09:06:50 -0700770 }
Jens Axboedef596e2019-01-09 08:59:42 -0700771 }
Jens Axboedef596e2019-01-09 08:59:42 -0700772
Jens Axboe09bb8392019-03-13 12:39:28 -0600773 io_commit_cqring(ctx);
Jens Axboedef596e2019-01-09 08:59:42 -0700774 io_free_req_many(ctx, reqs, &to_free);
775}
776
777static int io_do_iopoll(struct io_ring_ctx *ctx, unsigned int *nr_events,
778 long min)
779{
780 struct io_kiocb *req, *tmp;
781 LIST_HEAD(done);
782 bool spin;
783 int ret;
784
785 /*
786 * Only spin for completions if we don't have multiple devices hanging
787 * off our complete list, and we're under the requested amount.
788 */
789 spin = !ctx->poll_multi_file && *nr_events < min;
790
791 ret = 0;
792 list_for_each_entry_safe(req, tmp, &ctx->poll_list, list) {
793 struct kiocb *kiocb = &req->rw;
794
795 /*
796 * Move completed entries to our local list. If we find a
797 * request that requires polling, break out and complete
798 * the done list first, if we have entries there.
799 */
800 if (req->flags & REQ_F_IOPOLL_COMPLETED) {
801 list_move_tail(&req->list, &done);
802 continue;
803 }
804 if (!list_empty(&done))
805 break;
806
807 ret = kiocb->ki_filp->f_op->iopoll(kiocb, spin);
808 if (ret < 0)
809 break;
810
811 if (ret && spin)
812 spin = false;
813 ret = 0;
814 }
815
816 if (!list_empty(&done))
817 io_iopoll_complete(ctx, nr_events, &done);
818
819 return ret;
820}
821
822/*
823 * Poll for a mininum of 'min' events. Note that if min == 0 we consider that a
824 * non-spinning poll check - we'll still enter the driver poll loop, but only
825 * as a non-spinning completion check.
826 */
827static int io_iopoll_getevents(struct io_ring_ctx *ctx, unsigned int *nr_events,
828 long min)
829{
Jens Axboe08f54392019-08-21 22:19:11 -0600830 while (!list_empty(&ctx->poll_list) && !need_resched()) {
Jens Axboedef596e2019-01-09 08:59:42 -0700831 int ret;
832
833 ret = io_do_iopoll(ctx, nr_events, min);
834 if (ret < 0)
835 return ret;
836 if (!min || *nr_events >= min)
837 return 0;
838 }
839
840 return 1;
841}
842
843/*
844 * We can't just wait for polled events to come to us, we have to actively
845 * find and complete them.
846 */
847static void io_iopoll_reap_events(struct io_ring_ctx *ctx)
848{
849 if (!(ctx->flags & IORING_SETUP_IOPOLL))
850 return;
851
852 mutex_lock(&ctx->uring_lock);
853 while (!list_empty(&ctx->poll_list)) {
854 unsigned int nr_events = 0;
855
856 io_iopoll_getevents(ctx, &nr_events, 1);
Jens Axboe08f54392019-08-21 22:19:11 -0600857
858 /*
859 * Ensure we allow local-to-the-cpu processing to take place,
860 * in this case we need to ensure that we reap all events.
861 */
862 cond_resched();
Jens Axboedef596e2019-01-09 08:59:42 -0700863 }
864 mutex_unlock(&ctx->uring_lock);
865}
866
867static int io_iopoll_check(struct io_ring_ctx *ctx, unsigned *nr_events,
868 long min)
869{
Jens Axboe500f9fb2019-08-19 12:15:59 -0600870 int iters, ret = 0;
Jens Axboedef596e2019-01-09 08:59:42 -0700871
Jens Axboe500f9fb2019-08-19 12:15:59 -0600872 /*
873 * We disallow the app entering submit/complete with polling, but we
874 * still need to lock the ring to prevent racing with polled issue
875 * that got punted to a workqueue.
876 */
877 mutex_lock(&ctx->uring_lock);
878
879 iters = 0;
Jens Axboedef596e2019-01-09 08:59:42 -0700880 do {
881 int tmin = 0;
882
Jens Axboe500f9fb2019-08-19 12:15:59 -0600883 /*
Jens Axboea3a0e432019-08-20 11:03:11 -0600884 * Don't enter poll loop if we already have events pending.
885 * If we do, we can potentially be spinning for commands that
886 * already triggered a CQE (eg in error).
887 */
Hristo Venev75b28af2019-08-26 17:23:46 +0000888 if (io_cqring_events(ctx->rings))
Jens Axboea3a0e432019-08-20 11:03:11 -0600889 break;
890
891 /*
Jens Axboe500f9fb2019-08-19 12:15:59 -0600892 * If a submit got punted to a workqueue, we can have the
893 * application entering polling for a command before it gets
894 * issued. That app will hold the uring_lock for the duration
895 * of the poll right here, so we need to take a breather every
896 * now and then to ensure that the issue has a chance to add
897 * the poll to the issued list. Otherwise we can spin here
898 * forever, while the workqueue is stuck trying to acquire the
899 * very same mutex.
900 */
901 if (!(++iters & 7)) {
902 mutex_unlock(&ctx->uring_lock);
903 mutex_lock(&ctx->uring_lock);
904 }
905
Jens Axboedef596e2019-01-09 08:59:42 -0700906 if (*nr_events < min)
907 tmin = min - *nr_events;
908
909 ret = io_iopoll_getevents(ctx, nr_events, tmin);
910 if (ret <= 0)
911 break;
912 ret = 0;
913 } while (min && !*nr_events && !need_resched());
914
Jens Axboe500f9fb2019-08-19 12:15:59 -0600915 mutex_unlock(&ctx->uring_lock);
Jens Axboedef596e2019-01-09 08:59:42 -0700916 return ret;
917}
918
Jens Axboe491381ce2019-10-17 09:20:46 -0600919static void kiocb_end_write(struct io_kiocb *req)
Jens Axboe2b188cc2019-01-07 10:46:33 -0700920{
Jens Axboe491381ce2019-10-17 09:20:46 -0600921 /*
922 * Tell lockdep we inherited freeze protection from submission
923 * thread.
924 */
925 if (req->flags & REQ_F_ISREG) {
926 struct inode *inode = file_inode(req->file);
Jens Axboe2b188cc2019-01-07 10:46:33 -0700927
Jens Axboe491381ce2019-10-17 09:20:46 -0600928 __sb_writers_acquired(inode->i_sb, SB_FREEZE_WRITE);
Jens Axboe2b188cc2019-01-07 10:46:33 -0700929 }
Jens Axboe491381ce2019-10-17 09:20:46 -0600930 file_end_write(req->file);
Jens Axboe2b188cc2019-01-07 10:46:33 -0700931}
932
933static void io_complete_rw(struct kiocb *kiocb, long res, long res2)
934{
935 struct io_kiocb *req = container_of(kiocb, struct io_kiocb, rw);
936
Jens Axboe491381ce2019-10-17 09:20:46 -0600937 if (kiocb->ki_flags & IOCB_WRITE)
938 kiocb_end_write(req);
Jens Axboe2b188cc2019-01-07 10:46:33 -0700939
Jens Axboe9e645e112019-05-10 16:07:28 -0600940 if ((req->flags & REQ_F_LINK) && res != req->result)
941 req->flags |= REQ_F_FAIL_LINK;
Jens Axboec71ffb62019-05-13 20:58:29 -0600942 io_cqring_add_event(req->ctx, req->user_data, res);
Jens Axboee65ef562019-03-12 10:16:44 -0600943 io_put_req(req);
Jens Axboe2b188cc2019-01-07 10:46:33 -0700944}
945
Jens Axboedef596e2019-01-09 08:59:42 -0700946static void io_complete_rw_iopoll(struct kiocb *kiocb, long res, long res2)
947{
948 struct io_kiocb *req = container_of(kiocb, struct io_kiocb, rw);
949
Jens Axboe491381ce2019-10-17 09:20:46 -0600950 if (kiocb->ki_flags & IOCB_WRITE)
951 kiocb_end_write(req);
Jens Axboedef596e2019-01-09 08:59:42 -0700952
Jens Axboe9e645e112019-05-10 16:07:28 -0600953 if ((req->flags & REQ_F_LINK) && res != req->result)
954 req->flags |= REQ_F_FAIL_LINK;
955 req->result = res;
Jens Axboedef596e2019-01-09 08:59:42 -0700956 if (res != -EAGAIN)
957 req->flags |= REQ_F_IOPOLL_COMPLETED;
958}
959
960/*
961 * After the iocb has been issued, it's safe to be found on the poll list.
962 * Adding the kiocb to the list AFTER submission ensures that we don't
963 * find it from a io_iopoll_getevents() thread before the issuer is done
964 * accessing the kiocb cookie.
965 */
966static void io_iopoll_req_issued(struct io_kiocb *req)
967{
968 struct io_ring_ctx *ctx = req->ctx;
969
970 /*
971 * Track whether we have multiple files in our lists. This will impact
972 * how we do polling eventually, not spinning if we're on potentially
973 * different devices.
974 */
975 if (list_empty(&ctx->poll_list)) {
976 ctx->poll_multi_file = false;
977 } else if (!ctx->poll_multi_file) {
978 struct io_kiocb *list_req;
979
980 list_req = list_first_entry(&ctx->poll_list, struct io_kiocb,
981 list);
982 if (list_req->rw.ki_filp != req->rw.ki_filp)
983 ctx->poll_multi_file = true;
984 }
985
986 /*
987 * For fast devices, IO may have already completed. If it has, add
988 * it to the front so we find it first.
989 */
990 if (req->flags & REQ_F_IOPOLL_COMPLETED)
991 list_add(&req->list, &ctx->poll_list);
992 else
993 list_add_tail(&req->list, &ctx->poll_list);
994}
995
Jens Axboe3d6770f2019-04-13 11:50:54 -0600996static void io_file_put(struct io_submit_state *state)
Jens Axboe9a56a232019-01-09 09:06:50 -0700997{
Jens Axboe3d6770f2019-04-13 11:50:54 -0600998 if (state->file) {
Jens Axboe9a56a232019-01-09 09:06:50 -0700999 int diff = state->has_refs - state->used_refs;
1000
1001 if (diff)
1002 fput_many(state->file, diff);
1003 state->file = NULL;
1004 }
1005}
1006
1007/*
1008 * Get as many references to a file as we have IOs left in this submission,
1009 * assuming most submissions are for one file, or at least that each file
1010 * has more than one submission.
1011 */
1012static struct file *io_file_get(struct io_submit_state *state, int fd)
1013{
1014 if (!state)
1015 return fget(fd);
1016
1017 if (state->file) {
1018 if (state->fd == fd) {
1019 state->used_refs++;
1020 state->ios_left--;
1021 return state->file;
1022 }
Jens Axboe3d6770f2019-04-13 11:50:54 -06001023 io_file_put(state);
Jens Axboe9a56a232019-01-09 09:06:50 -07001024 }
1025 state->file = fget_many(fd, state->ios_left);
1026 if (!state->file)
1027 return NULL;
1028
1029 state->fd = fd;
1030 state->has_refs = state->ios_left;
1031 state->used_refs = 1;
1032 state->ios_left--;
1033 return state->file;
1034}
1035
Jens Axboe2b188cc2019-01-07 10:46:33 -07001036/*
1037 * If we tracked the file through the SCM inflight mechanism, we could support
1038 * any file. For now, just ensure that anything potentially problematic is done
1039 * inline.
1040 */
1041static bool io_file_supports_async(struct file *file)
1042{
1043 umode_t mode = file_inode(file)->i_mode;
1044
1045 if (S_ISBLK(mode) || S_ISCHR(mode))
1046 return true;
1047 if (S_ISREG(mode) && file->f_op != &io_uring_fops)
1048 return true;
1049
1050 return false;
1051}
1052
Jens Axboe6c271ce2019-01-10 11:22:30 -07001053static int io_prep_rw(struct io_kiocb *req, const struct sqe_submit *s,
Jens Axboe8358e3a2019-04-23 08:17:58 -06001054 bool force_nonblock)
Jens Axboe2b188cc2019-01-07 10:46:33 -07001055{
Jens Axboe6c271ce2019-01-10 11:22:30 -07001056 const struct io_uring_sqe *sqe = s->sqe;
Jens Axboedef596e2019-01-09 08:59:42 -07001057 struct io_ring_ctx *ctx = req->ctx;
Jens Axboe2b188cc2019-01-07 10:46:33 -07001058 struct kiocb *kiocb = &req->rw;
Jens Axboe09bb8392019-03-13 12:39:28 -06001059 unsigned ioprio;
1060 int ret;
Jens Axboe2b188cc2019-01-07 10:46:33 -07001061
Jens Axboe09bb8392019-03-13 12:39:28 -06001062 if (!req->file)
1063 return -EBADF;
Jens Axboe2b188cc2019-01-07 10:46:33 -07001064
Jens Axboe491381ce2019-10-17 09:20:46 -06001065 if (S_ISREG(file_inode(req->file)->i_mode))
1066 req->flags |= REQ_F_ISREG;
1067
1068 /*
1069 * If the file doesn't support async, mark it as REQ_F_MUST_PUNT so
1070 * we know to async punt it even if it was opened O_NONBLOCK
1071 */
1072 if (force_nonblock && !io_file_supports_async(req->file)) {
1073 req->flags |= REQ_F_MUST_PUNT;
1074 return -EAGAIN;
1075 }
Jens Axboe6b063142019-01-10 22:13:58 -07001076
Jens Axboe2b188cc2019-01-07 10:46:33 -07001077 kiocb->ki_pos = READ_ONCE(sqe->off);
1078 kiocb->ki_flags = iocb_flags(kiocb->ki_filp);
1079 kiocb->ki_hint = ki_hint_validate(file_write_hint(kiocb->ki_filp));
1080
1081 ioprio = READ_ONCE(sqe->ioprio);
1082 if (ioprio) {
1083 ret = ioprio_check_cap(ioprio);
1084 if (ret)
Jens Axboe09bb8392019-03-13 12:39:28 -06001085 return ret;
Jens Axboe2b188cc2019-01-07 10:46:33 -07001086
1087 kiocb->ki_ioprio = ioprio;
1088 } else
1089 kiocb->ki_ioprio = get_current_ioprio();
1090
1091 ret = kiocb_set_rw_flags(kiocb, READ_ONCE(sqe->rw_flags));
1092 if (unlikely(ret))
Jens Axboe09bb8392019-03-13 12:39:28 -06001093 return ret;
Stefan Bühler8449eed2019-04-27 20:34:19 +02001094
1095 /* don't allow async punt if RWF_NOWAIT was requested */
Jens Axboe491381ce2019-10-17 09:20:46 -06001096 if ((kiocb->ki_flags & IOCB_NOWAIT) ||
1097 (req->file->f_flags & O_NONBLOCK))
Stefan Bühler8449eed2019-04-27 20:34:19 +02001098 req->flags |= REQ_F_NOWAIT;
1099
1100 if (force_nonblock)
Jens Axboe2b188cc2019-01-07 10:46:33 -07001101 kiocb->ki_flags |= IOCB_NOWAIT;
Stefan Bühler8449eed2019-04-27 20:34:19 +02001102
Jens Axboedef596e2019-01-09 08:59:42 -07001103 if (ctx->flags & IORING_SETUP_IOPOLL) {
Jens Axboedef596e2019-01-09 08:59:42 -07001104 if (!(kiocb->ki_flags & IOCB_DIRECT) ||
1105 !kiocb->ki_filp->f_op->iopoll)
Jens Axboe09bb8392019-03-13 12:39:28 -06001106 return -EOPNOTSUPP;
Jens Axboe2b188cc2019-01-07 10:46:33 -07001107
Jens Axboedef596e2019-01-09 08:59:42 -07001108 kiocb->ki_flags |= IOCB_HIPRI;
1109 kiocb->ki_complete = io_complete_rw_iopoll;
1110 } else {
Jens Axboe09bb8392019-03-13 12:39:28 -06001111 if (kiocb->ki_flags & IOCB_HIPRI)
1112 return -EINVAL;
Jens Axboedef596e2019-01-09 08:59:42 -07001113 kiocb->ki_complete = io_complete_rw;
1114 }
Jens Axboe2b188cc2019-01-07 10:46:33 -07001115 return 0;
Jens Axboe2b188cc2019-01-07 10:46:33 -07001116}
1117
1118static inline void io_rw_done(struct kiocb *kiocb, ssize_t ret)
1119{
1120 switch (ret) {
1121 case -EIOCBQUEUED:
1122 break;
1123 case -ERESTARTSYS:
1124 case -ERESTARTNOINTR:
1125 case -ERESTARTNOHAND:
1126 case -ERESTART_RESTARTBLOCK:
1127 /*
1128 * We can't just restart the syscall, since previously
1129 * submitted sqes may already be in progress. Just fail this
1130 * IO with EINTR.
1131 */
1132 ret = -EINTR;
1133 /* fall through */
1134 default:
1135 kiocb->ki_complete(kiocb, ret, 0);
1136 }
1137}
1138
Jens Axboeedafcce2019-01-09 09:16:05 -07001139static int io_import_fixed(struct io_ring_ctx *ctx, int rw,
1140 const struct io_uring_sqe *sqe,
1141 struct iov_iter *iter)
1142{
1143 size_t len = READ_ONCE(sqe->len);
1144 struct io_mapped_ubuf *imu;
1145 unsigned index, buf_index;
1146 size_t offset;
1147 u64 buf_addr;
1148
1149 /* attempt to use fixed buffers without having provided iovecs */
1150 if (unlikely(!ctx->user_bufs))
1151 return -EFAULT;
1152
1153 buf_index = READ_ONCE(sqe->buf_index);
1154 if (unlikely(buf_index >= ctx->nr_user_bufs))
1155 return -EFAULT;
1156
1157 index = array_index_nospec(buf_index, ctx->nr_user_bufs);
1158 imu = &ctx->user_bufs[index];
1159 buf_addr = READ_ONCE(sqe->addr);
1160
1161 /* overflow */
1162 if (buf_addr + len < buf_addr)
1163 return -EFAULT;
1164 /* not inside the mapped region */
1165 if (buf_addr < imu->ubuf || buf_addr + len > imu->ubuf + imu->len)
1166 return -EFAULT;
1167
1168 /*
1169 * May not be a start of buffer, set size appropriately
1170 * and advance us to the beginning.
1171 */
1172 offset = buf_addr - imu->ubuf;
1173 iov_iter_bvec(iter, rw, imu->bvec, imu->nr_bvecs, offset + len);
Jens Axboebd11b3a2019-07-20 08:37:31 -06001174
1175 if (offset) {
1176 /*
1177 * Don't use iov_iter_advance() here, as it's really slow for
1178 * using the latter parts of a big fixed buffer - it iterates
1179 * over each segment manually. We can cheat a bit here, because
1180 * we know that:
1181 *
1182 * 1) it's a BVEC iter, we set it up
1183 * 2) all bvecs are PAGE_SIZE in size, except potentially the
1184 * first and last bvec
1185 *
1186 * So just find our index, and adjust the iterator afterwards.
1187 * If the offset is within the first bvec (or the whole first
1188 * bvec, just use iov_iter_advance(). This makes it easier
1189 * since we can just skip the first segment, which may not
1190 * be PAGE_SIZE aligned.
1191 */
1192 const struct bio_vec *bvec = imu->bvec;
1193
1194 if (offset <= bvec->bv_len) {
1195 iov_iter_advance(iter, offset);
1196 } else {
1197 unsigned long seg_skip;
1198
1199 /* skip first vec */
1200 offset -= bvec->bv_len;
1201 seg_skip = 1 + (offset >> PAGE_SHIFT);
1202
1203 iter->bvec = bvec + seg_skip;
1204 iter->nr_segs -= seg_skip;
Aleix Roca Nonell99c79f62019-08-15 14:03:22 +02001205 iter->count -= bvec->bv_len + offset;
Jens Axboebd11b3a2019-07-20 08:37:31 -06001206 iter->iov_offset = offset & ~PAGE_MASK;
Jens Axboebd11b3a2019-07-20 08:37:31 -06001207 }
1208 }
1209
Jens Axboeedafcce2019-01-09 09:16:05 -07001210 return 0;
1211}
1212
Jens Axboe87e5e6d2019-05-14 16:02:22 -06001213static ssize_t io_import_iovec(struct io_ring_ctx *ctx, int rw,
1214 const struct sqe_submit *s, struct iovec **iovec,
1215 struct iov_iter *iter)
Jens Axboe2b188cc2019-01-07 10:46:33 -07001216{
1217 const struct io_uring_sqe *sqe = s->sqe;
1218 void __user *buf = u64_to_user_ptr(READ_ONCE(sqe->addr));
1219 size_t sqe_len = READ_ONCE(sqe->len);
Jens Axboeedafcce2019-01-09 09:16:05 -07001220 u8 opcode;
1221
1222 /*
1223 * We're reading ->opcode for the second time, but the first read
1224 * doesn't care whether it's _FIXED or not, so it doesn't matter
1225 * whether ->opcode changes concurrently. The first read does care
1226 * about whether it is a READ or a WRITE, so we don't trust this read
1227 * for that purpose and instead let the caller pass in the read/write
1228 * flag.
1229 */
1230 opcode = READ_ONCE(sqe->opcode);
1231 if (opcode == IORING_OP_READ_FIXED ||
1232 opcode == IORING_OP_WRITE_FIXED) {
Jens Axboe87e5e6d2019-05-14 16:02:22 -06001233 ssize_t ret = io_import_fixed(ctx, rw, sqe, iter);
Jens Axboeedafcce2019-01-09 09:16:05 -07001234 *iovec = NULL;
1235 return ret;
1236 }
Jens Axboe2b188cc2019-01-07 10:46:33 -07001237
1238 if (!s->has_user)
1239 return -EFAULT;
1240
1241#ifdef CONFIG_COMPAT
1242 if (ctx->compat)
1243 return compat_import_iovec(rw, buf, sqe_len, UIO_FASTIOV,
1244 iovec, iter);
1245#endif
1246
1247 return import_iovec(rw, buf, sqe_len, UIO_FASTIOV, iovec, iter);
1248}
1249
Jens Axboe6d5d5ac2019-09-11 10:16:13 -06001250static inline bool io_should_merge(struct async_list *al, struct kiocb *kiocb)
1251{
1252 if (al->file == kiocb->ki_filp) {
1253 off_t start, end;
1254
1255 /*
1256 * Allow merging if we're anywhere in the range of the same
1257 * page. Generally this happens for sub-page reads or writes,
1258 * and it's beneficial to allow the first worker to bring the
1259 * page in and the piggy backed work can then work on the
1260 * cached page.
1261 */
1262 start = al->io_start & PAGE_MASK;
1263 end = (al->io_start + al->io_len + PAGE_SIZE - 1) & PAGE_MASK;
1264 if (kiocb->ki_pos >= start && kiocb->ki_pos <= end)
1265 return true;
1266 }
1267
1268 al->file = NULL;
1269 return false;
1270}
1271
Jens Axboe31b51512019-01-18 22:56:34 -07001272/*
1273 * Make a note of the last file/offset/direction we punted to async
1274 * context. We'll use this information to see if we can piggy back a
1275 * sequential request onto the previous one, if it's still hasn't been
1276 * completed by the async worker.
1277 */
1278static void io_async_list_note(int rw, struct io_kiocb *req, size_t len)
1279{
1280 struct async_list *async_list = &req->ctx->pending_async[rw];
1281 struct kiocb *kiocb = &req->rw;
1282 struct file *filp = kiocb->ki_filp;
Jens Axboe31b51512019-01-18 22:56:34 -07001283
Jens Axboe6d5d5ac2019-09-11 10:16:13 -06001284 if (io_should_merge(async_list, kiocb)) {
Zhengyuan Liu9310a7ba2019-07-22 10:23:27 +08001285 unsigned long max_bytes;
Jens Axboe31b51512019-01-18 22:56:34 -07001286
1287 /* Use 8x RA size as a decent limiter for both reads/writes */
Zhengyuan Liu9310a7ba2019-07-22 10:23:27 +08001288 max_bytes = filp->f_ra.ra_pages << (PAGE_SHIFT + 3);
1289 if (!max_bytes)
1290 max_bytes = VM_READAHEAD_PAGES << (PAGE_SHIFT + 3);
Jens Axboe31b51512019-01-18 22:56:34 -07001291
Zhengyuan Liu9310a7ba2019-07-22 10:23:27 +08001292 /* If max len are exceeded, reset the state */
1293 if (async_list->io_len + len <= max_bytes) {
Jens Axboe31b51512019-01-18 22:56:34 -07001294 req->flags |= REQ_F_SEQ_PREV;
Zhengyuan Liu9310a7ba2019-07-22 10:23:27 +08001295 async_list->io_len += len;
Jens Axboe31b51512019-01-18 22:56:34 -07001296 } else {
Jens Axboe6d5d5ac2019-09-11 10:16:13 -06001297 async_list->file = NULL;
Jens Axboe31b51512019-01-18 22:56:34 -07001298 }
1299 }
1300
1301 /* New file? Reset state. */
1302 if (async_list->file != filp) {
Jens Axboe6d5d5ac2019-09-11 10:16:13 -06001303 async_list->io_start = kiocb->ki_pos;
1304 async_list->io_len = len;
Jens Axboe31b51512019-01-18 22:56:34 -07001305 async_list->file = filp;
1306 }
Jens Axboe31b51512019-01-18 22:56:34 -07001307}
1308
Jens Axboe32960612019-09-23 11:05:34 -06001309/*
1310 * For files that don't have ->read_iter() and ->write_iter(), handle them
1311 * by looping over ->read() or ->write() manually.
1312 */
1313static ssize_t loop_rw_iter(int rw, struct file *file, struct kiocb *kiocb,
1314 struct iov_iter *iter)
1315{
1316 ssize_t ret = 0;
1317
1318 /*
1319 * Don't support polled IO through this interface, and we can't
1320 * support non-blocking either. For the latter, this just causes
1321 * the kiocb to be handled from an async context.
1322 */
1323 if (kiocb->ki_flags & IOCB_HIPRI)
1324 return -EOPNOTSUPP;
1325 if (kiocb->ki_flags & IOCB_NOWAIT)
1326 return -EAGAIN;
1327
1328 while (iov_iter_count(iter)) {
1329 struct iovec iovec = iov_iter_iovec(iter);
1330 ssize_t nr;
1331
1332 if (rw == READ) {
1333 nr = file->f_op->read(file, iovec.iov_base,
1334 iovec.iov_len, &kiocb->ki_pos);
1335 } else {
1336 nr = file->f_op->write(file, iovec.iov_base,
1337 iovec.iov_len, &kiocb->ki_pos);
1338 }
1339
1340 if (nr < 0) {
1341 if (!ret)
1342 ret = nr;
1343 break;
1344 }
1345 ret += nr;
1346 if (nr != iovec.iov_len)
1347 break;
1348 iov_iter_advance(iter, nr);
1349 }
1350
1351 return ret;
1352}
1353
Jens Axboee0c5c572019-03-12 10:18:47 -06001354static int io_read(struct io_kiocb *req, const struct sqe_submit *s,
Jens Axboe8358e3a2019-04-23 08:17:58 -06001355 bool force_nonblock)
Jens Axboe2b188cc2019-01-07 10:46:33 -07001356{
1357 struct iovec inline_vecs[UIO_FASTIOV], *iovec = inline_vecs;
1358 struct kiocb *kiocb = &req->rw;
1359 struct iov_iter iter;
1360 struct file *file;
Jens Axboe31b51512019-01-18 22:56:34 -07001361 size_t iov_count;
Jens Axboe9d93a3f2019-05-15 13:53:07 -06001362 ssize_t read_size, ret;
Jens Axboe2b188cc2019-01-07 10:46:33 -07001363
Jens Axboe8358e3a2019-04-23 08:17:58 -06001364 ret = io_prep_rw(req, s, force_nonblock);
Jens Axboe2b188cc2019-01-07 10:46:33 -07001365 if (ret)
1366 return ret;
1367 file = kiocb->ki_filp;
1368
Jens Axboe2b188cc2019-01-07 10:46:33 -07001369 if (unlikely(!(file->f_mode & FMODE_READ)))
Jens Axboe09bb8392019-03-13 12:39:28 -06001370 return -EBADF;
Jens Axboe2b188cc2019-01-07 10:46:33 -07001371
1372 ret = io_import_iovec(req->ctx, READ, s, &iovec, &iter);
Jens Axboe87e5e6d2019-05-14 16:02:22 -06001373 if (ret < 0)
Jens Axboe09bb8392019-03-13 12:39:28 -06001374 return ret;
Jens Axboe2b188cc2019-01-07 10:46:33 -07001375
Jens Axboe9d93a3f2019-05-15 13:53:07 -06001376 read_size = ret;
Jens Axboe9e645e112019-05-10 16:07:28 -06001377 if (req->flags & REQ_F_LINK)
1378 req->result = read_size;
1379
Jens Axboe31b51512019-01-18 22:56:34 -07001380 iov_count = iov_iter_count(&iter);
1381 ret = rw_verify_area(READ, file, &kiocb->ki_pos, iov_count);
Jens Axboe2b188cc2019-01-07 10:46:33 -07001382 if (!ret) {
1383 ssize_t ret2;
1384
Jens Axboe32960612019-09-23 11:05:34 -06001385 if (file->f_op->read_iter)
1386 ret2 = call_read_iter(file, kiocb, &iter);
1387 else
1388 ret2 = loop_rw_iter(READ, file, kiocb, &iter);
1389
Jens Axboe9d93a3f2019-05-15 13:53:07 -06001390 /*
1391 * In case of a short read, punt to async. This can happen
1392 * if we have data partially cached. Alternatively we can
1393 * return the short read, in which case the application will
1394 * need to issue another SQE and wait for it. That SQE will
1395 * need async punt anyway, so it's more efficient to do it
1396 * here.
1397 */
Jens Axboe491381ce2019-10-17 09:20:46 -06001398 if (force_nonblock && !(req->flags & REQ_F_NOWAIT) &&
1399 (req->flags & REQ_F_ISREG) &&
1400 ret2 > 0 && ret2 < read_size)
Jens Axboe9d93a3f2019-05-15 13:53:07 -06001401 ret2 = -EAGAIN;
1402 /* Catch -EAGAIN return for forced non-blocking submission */
Jens Axboe31b51512019-01-18 22:56:34 -07001403 if (!force_nonblock || ret2 != -EAGAIN) {
Jens Axboe2b188cc2019-01-07 10:46:33 -07001404 io_rw_done(kiocb, ret2);
Jens Axboe31b51512019-01-18 22:56:34 -07001405 } else {
1406 /*
1407 * If ->needs_lock is true, we're already in async
1408 * context.
1409 */
1410 if (!s->needs_lock)
1411 io_async_list_note(READ, req, iov_count);
Jens Axboe2b188cc2019-01-07 10:46:33 -07001412 ret = -EAGAIN;
Jens Axboe31b51512019-01-18 22:56:34 -07001413 }
Jens Axboe2b188cc2019-01-07 10:46:33 -07001414 }
1415 kfree(iovec);
Jens Axboe2b188cc2019-01-07 10:46:33 -07001416 return ret;
1417}
1418
Jens Axboee0c5c572019-03-12 10:18:47 -06001419static int io_write(struct io_kiocb *req, const struct sqe_submit *s,
Jens Axboe8358e3a2019-04-23 08:17:58 -06001420 bool force_nonblock)
Jens Axboe2b188cc2019-01-07 10:46:33 -07001421{
1422 struct iovec inline_vecs[UIO_FASTIOV], *iovec = inline_vecs;
1423 struct kiocb *kiocb = &req->rw;
1424 struct iov_iter iter;
1425 struct file *file;
Jens Axboe31b51512019-01-18 22:56:34 -07001426 size_t iov_count;
Jens Axboe87e5e6d2019-05-14 16:02:22 -06001427 ssize_t ret;
Jens Axboe2b188cc2019-01-07 10:46:33 -07001428
Jens Axboe8358e3a2019-04-23 08:17:58 -06001429 ret = io_prep_rw(req, s, force_nonblock);
Jens Axboe2b188cc2019-01-07 10:46:33 -07001430 if (ret)
1431 return ret;
Jens Axboe2b188cc2019-01-07 10:46:33 -07001432
Jens Axboe2b188cc2019-01-07 10:46:33 -07001433 file = kiocb->ki_filp;
1434 if (unlikely(!(file->f_mode & FMODE_WRITE)))
Jens Axboe09bb8392019-03-13 12:39:28 -06001435 return -EBADF;
Jens Axboe2b188cc2019-01-07 10:46:33 -07001436
1437 ret = io_import_iovec(req->ctx, WRITE, s, &iovec, &iter);
Jens Axboe87e5e6d2019-05-14 16:02:22 -06001438 if (ret < 0)
Jens Axboe09bb8392019-03-13 12:39:28 -06001439 return ret;
Jens Axboe2b188cc2019-01-07 10:46:33 -07001440
Jens Axboe9e645e112019-05-10 16:07:28 -06001441 if (req->flags & REQ_F_LINK)
1442 req->result = ret;
1443
Jens Axboe31b51512019-01-18 22:56:34 -07001444 iov_count = iov_iter_count(&iter);
1445
1446 ret = -EAGAIN;
1447 if (force_nonblock && !(kiocb->ki_flags & IOCB_DIRECT)) {
1448 /* If ->needs_lock is true, we're already in async context. */
1449 if (!s->needs_lock)
1450 io_async_list_note(WRITE, req, iov_count);
1451 goto out_free;
1452 }
1453
1454 ret = rw_verify_area(WRITE, file, &kiocb->ki_pos, iov_count);
Jens Axboe2b188cc2019-01-07 10:46:33 -07001455 if (!ret) {
Roman Penyaev9bf79332019-03-25 20:09:24 +01001456 ssize_t ret2;
1457
Jens Axboe2b188cc2019-01-07 10:46:33 -07001458 /*
1459 * Open-code file_start_write here to grab freeze protection,
1460 * which will be released by another thread in
1461 * io_complete_rw(). Fool lockdep by telling it the lock got
1462 * released so that it doesn't complain about the held lock when
1463 * we return to userspace.
1464 */
Jens Axboe491381ce2019-10-17 09:20:46 -06001465 if (req->flags & REQ_F_ISREG) {
Jens Axboe2b188cc2019-01-07 10:46:33 -07001466 __sb_start_write(file_inode(file)->i_sb,
1467 SB_FREEZE_WRITE, true);
1468 __sb_writers_release(file_inode(file)->i_sb,
1469 SB_FREEZE_WRITE);
1470 }
1471 kiocb->ki_flags |= IOCB_WRITE;
Roman Penyaev9bf79332019-03-25 20:09:24 +01001472
Jens Axboe32960612019-09-23 11:05:34 -06001473 if (file->f_op->write_iter)
1474 ret2 = call_write_iter(file, kiocb, &iter);
1475 else
1476 ret2 = loop_rw_iter(WRITE, file, kiocb, &iter);
Roman Penyaev9bf79332019-03-25 20:09:24 +01001477 if (!force_nonblock || ret2 != -EAGAIN) {
1478 io_rw_done(kiocb, ret2);
1479 } else {
1480 /*
1481 * If ->needs_lock is true, we're already in async
1482 * context.
1483 */
1484 if (!s->needs_lock)
1485 io_async_list_note(WRITE, req, iov_count);
1486 ret = -EAGAIN;
1487 }
Jens Axboe2b188cc2019-01-07 10:46:33 -07001488 }
Jens Axboe31b51512019-01-18 22:56:34 -07001489out_free:
Jens Axboe2b188cc2019-01-07 10:46:33 -07001490 kfree(iovec);
Jens Axboe2b188cc2019-01-07 10:46:33 -07001491 return ret;
1492}
1493
1494/*
1495 * IORING_OP_NOP just posts a completion event, nothing else.
1496 */
1497static int io_nop(struct io_kiocb *req, u64 user_data)
1498{
1499 struct io_ring_ctx *ctx = req->ctx;
1500 long err = 0;
1501
Jens Axboedef596e2019-01-09 08:59:42 -07001502 if (unlikely(ctx->flags & IORING_SETUP_IOPOLL))
1503 return -EINVAL;
1504
Jens Axboec71ffb62019-05-13 20:58:29 -06001505 io_cqring_add_event(ctx, user_data, err);
Jens Axboee65ef562019-03-12 10:16:44 -06001506 io_put_req(req);
Jens Axboe2b188cc2019-01-07 10:46:33 -07001507 return 0;
1508}
1509
Christoph Hellwigc992fe22019-01-11 09:43:02 -07001510static int io_prep_fsync(struct io_kiocb *req, const struct io_uring_sqe *sqe)
1511{
Jens Axboe6b063142019-01-10 22:13:58 -07001512 struct io_ring_ctx *ctx = req->ctx;
Christoph Hellwigc992fe22019-01-11 09:43:02 -07001513
Jens Axboe09bb8392019-03-13 12:39:28 -06001514 if (!req->file)
1515 return -EBADF;
Christoph Hellwigc992fe22019-01-11 09:43:02 -07001516
Jens Axboe6b063142019-01-10 22:13:58 -07001517 if (unlikely(ctx->flags & IORING_SETUP_IOPOLL))
Jens Axboedef596e2019-01-09 08:59:42 -07001518 return -EINVAL;
Jens Axboeedafcce2019-01-09 09:16:05 -07001519 if (unlikely(sqe->addr || sqe->ioprio || sqe->buf_index))
Christoph Hellwigc992fe22019-01-11 09:43:02 -07001520 return -EINVAL;
1521
Christoph Hellwigc992fe22019-01-11 09:43:02 -07001522 return 0;
1523}
1524
1525static int io_fsync(struct io_kiocb *req, const struct io_uring_sqe *sqe,
1526 bool force_nonblock)
1527{
1528 loff_t sqe_off = READ_ONCE(sqe->off);
1529 loff_t sqe_len = READ_ONCE(sqe->len);
1530 loff_t end = sqe_off + sqe_len;
1531 unsigned fsync_flags;
1532 int ret;
1533
1534 fsync_flags = READ_ONCE(sqe->fsync_flags);
1535 if (unlikely(fsync_flags & ~IORING_FSYNC_DATASYNC))
1536 return -EINVAL;
1537
1538 ret = io_prep_fsync(req, sqe);
1539 if (ret)
1540 return ret;
1541
1542 /* fsync always requires a blocking context */
1543 if (force_nonblock)
1544 return -EAGAIN;
1545
1546 ret = vfs_fsync_range(req->rw.ki_filp, sqe_off,
1547 end > 0 ? end : LLONG_MAX,
1548 fsync_flags & IORING_FSYNC_DATASYNC);
1549
Jens Axboe9e645e112019-05-10 16:07:28 -06001550 if (ret < 0 && (req->flags & REQ_F_LINK))
1551 req->flags |= REQ_F_FAIL_LINK;
Jens Axboec71ffb62019-05-13 20:58:29 -06001552 io_cqring_add_event(req->ctx, sqe->user_data, ret);
Jens Axboee65ef562019-03-12 10:16:44 -06001553 io_put_req(req);
Christoph Hellwigc992fe22019-01-11 09:43:02 -07001554 return 0;
1555}
1556
Jens Axboe5d17b4a2019-04-09 14:56:44 -06001557static int io_prep_sfr(struct io_kiocb *req, const struct io_uring_sqe *sqe)
1558{
1559 struct io_ring_ctx *ctx = req->ctx;
1560 int ret = 0;
1561
1562 if (!req->file)
1563 return -EBADF;
Jens Axboe5d17b4a2019-04-09 14:56:44 -06001564
1565 if (unlikely(ctx->flags & IORING_SETUP_IOPOLL))
1566 return -EINVAL;
1567 if (unlikely(sqe->addr || sqe->ioprio || sqe->buf_index))
1568 return -EINVAL;
1569
Jens Axboe5d17b4a2019-04-09 14:56:44 -06001570 return ret;
1571}
1572
1573static int io_sync_file_range(struct io_kiocb *req,
1574 const struct io_uring_sqe *sqe,
1575 bool force_nonblock)
1576{
1577 loff_t sqe_off;
1578 loff_t sqe_len;
1579 unsigned flags;
1580 int ret;
1581
1582 ret = io_prep_sfr(req, sqe);
1583 if (ret)
1584 return ret;
1585
1586 /* sync_file_range always requires a blocking context */
1587 if (force_nonblock)
1588 return -EAGAIN;
1589
1590 sqe_off = READ_ONCE(sqe->off);
1591 sqe_len = READ_ONCE(sqe->len);
1592 flags = READ_ONCE(sqe->sync_range_flags);
1593
1594 ret = sync_file_range(req->rw.ki_filp, sqe_off, sqe_len, flags);
1595
Jens Axboe9e645e112019-05-10 16:07:28 -06001596 if (ret < 0 && (req->flags & REQ_F_LINK))
1597 req->flags |= REQ_F_FAIL_LINK;
Jens Axboec71ffb62019-05-13 20:58:29 -06001598 io_cqring_add_event(req->ctx, sqe->user_data, ret);
Jens Axboe5d17b4a2019-04-09 14:56:44 -06001599 io_put_req(req);
1600 return 0;
1601}
1602
Jens Axboe0fa03c62019-04-19 13:34:07 -06001603#if defined(CONFIG_NET)
Jens Axboeaa1fa282019-04-19 13:38:09 -06001604static int io_send_recvmsg(struct io_kiocb *req, const struct io_uring_sqe *sqe,
1605 bool force_nonblock,
1606 long (*fn)(struct socket *, struct user_msghdr __user *,
1607 unsigned int))
1608{
Jens Axboe0fa03c62019-04-19 13:34:07 -06001609 struct socket *sock;
1610 int ret;
1611
1612 if (unlikely(req->ctx->flags & IORING_SETUP_IOPOLL))
1613 return -EINVAL;
1614
1615 sock = sock_from_file(req->file, &ret);
1616 if (sock) {
1617 struct user_msghdr __user *msg;
1618 unsigned flags;
1619
1620 flags = READ_ONCE(sqe->msg_flags);
1621 if (flags & MSG_DONTWAIT)
1622 req->flags |= REQ_F_NOWAIT;
1623 else if (force_nonblock)
1624 flags |= MSG_DONTWAIT;
1625
1626 msg = (struct user_msghdr __user *) (unsigned long)
1627 READ_ONCE(sqe->addr);
1628
Jens Axboeaa1fa282019-04-19 13:38:09 -06001629 ret = fn(sock, msg, flags);
Jens Axboe0fa03c62019-04-19 13:34:07 -06001630 if (force_nonblock && ret == -EAGAIN)
1631 return ret;
1632 }
1633
1634 io_cqring_add_event(req->ctx, sqe->user_data, ret);
1635 io_put_req(req);
1636 return 0;
Jens Axboeaa1fa282019-04-19 13:38:09 -06001637}
1638#endif
1639
1640static int io_sendmsg(struct io_kiocb *req, const struct io_uring_sqe *sqe,
1641 bool force_nonblock)
1642{
1643#if defined(CONFIG_NET)
1644 return io_send_recvmsg(req, sqe, force_nonblock, __sys_sendmsg_sock);
1645#else
1646 return -EOPNOTSUPP;
1647#endif
1648}
1649
1650static int io_recvmsg(struct io_kiocb *req, const struct io_uring_sqe *sqe,
1651 bool force_nonblock)
1652{
1653#if defined(CONFIG_NET)
1654 return io_send_recvmsg(req, sqe, force_nonblock, __sys_recvmsg_sock);
Jens Axboe0fa03c62019-04-19 13:34:07 -06001655#else
1656 return -EOPNOTSUPP;
1657#endif
1658}
1659
Jens Axboe221c5eb2019-01-17 09:41:58 -07001660static void io_poll_remove_one(struct io_kiocb *req)
1661{
1662 struct io_poll_iocb *poll = &req->poll;
1663
1664 spin_lock(&poll->head->lock);
1665 WRITE_ONCE(poll->canceled, true);
1666 if (!list_empty(&poll->wait.entry)) {
1667 list_del_init(&poll->wait.entry);
Jens Axboe18d9be12019-09-10 09:13:05 -06001668 io_queue_async_work(req->ctx, req);
Jens Axboe221c5eb2019-01-17 09:41:58 -07001669 }
1670 spin_unlock(&poll->head->lock);
1671
1672 list_del_init(&req->list);
1673}
1674
1675static void io_poll_remove_all(struct io_ring_ctx *ctx)
1676{
1677 struct io_kiocb *req;
1678
1679 spin_lock_irq(&ctx->completion_lock);
1680 while (!list_empty(&ctx->cancel_list)) {
1681 req = list_first_entry(&ctx->cancel_list, struct io_kiocb,list);
1682 io_poll_remove_one(req);
1683 }
1684 spin_unlock_irq(&ctx->completion_lock);
1685}
1686
1687/*
1688 * Find a running poll command that matches one specified in sqe->addr,
1689 * and remove it if found.
1690 */
1691static int io_poll_remove(struct io_kiocb *req, const struct io_uring_sqe *sqe)
1692{
1693 struct io_ring_ctx *ctx = req->ctx;
1694 struct io_kiocb *poll_req, *next;
1695 int ret = -ENOENT;
1696
1697 if (unlikely(req->ctx->flags & IORING_SETUP_IOPOLL))
1698 return -EINVAL;
1699 if (sqe->ioprio || sqe->off || sqe->len || sqe->buf_index ||
1700 sqe->poll_events)
1701 return -EINVAL;
1702
1703 spin_lock_irq(&ctx->completion_lock);
1704 list_for_each_entry_safe(poll_req, next, &ctx->cancel_list, list) {
1705 if (READ_ONCE(sqe->addr) == poll_req->user_data) {
1706 io_poll_remove_one(poll_req);
1707 ret = 0;
1708 break;
1709 }
1710 }
1711 spin_unlock_irq(&ctx->completion_lock);
1712
Jens Axboec71ffb62019-05-13 20:58:29 -06001713 io_cqring_add_event(req->ctx, sqe->user_data, ret);
Jens Axboee65ef562019-03-12 10:16:44 -06001714 io_put_req(req);
Jens Axboe221c5eb2019-01-17 09:41:58 -07001715 return 0;
1716}
1717
Jens Axboe8c838782019-03-12 15:48:16 -06001718static void io_poll_complete(struct io_ring_ctx *ctx, struct io_kiocb *req,
1719 __poll_t mask)
Jens Axboe221c5eb2019-01-17 09:41:58 -07001720{
Jens Axboe8c838782019-03-12 15:48:16 -06001721 req->poll.done = true;
Jens Axboec71ffb62019-05-13 20:58:29 -06001722 io_cqring_fill_event(ctx, req->user_data, mangle_poll(mask));
Jens Axboe8c838782019-03-12 15:48:16 -06001723 io_commit_cqring(ctx);
Jens Axboe221c5eb2019-01-17 09:41:58 -07001724}
1725
1726static void io_poll_complete_work(struct work_struct *work)
1727{
1728 struct io_kiocb *req = container_of(work, struct io_kiocb, work);
1729 struct io_poll_iocb *poll = &req->poll;
1730 struct poll_table_struct pt = { ._key = poll->events };
1731 struct io_ring_ctx *ctx = req->ctx;
1732 __poll_t mask = 0;
1733
1734 if (!READ_ONCE(poll->canceled))
1735 mask = vfs_poll(poll->file, &pt) & poll->events;
1736
1737 /*
1738 * Note that ->ki_cancel callers also delete iocb from active_reqs after
1739 * calling ->ki_cancel. We need the ctx_lock roundtrip here to
1740 * synchronize with them. In the cancellation case the list_del_init
1741 * itself is not actually needed, but harmless so we keep it in to
1742 * avoid further branches in the fast path.
1743 */
1744 spin_lock_irq(&ctx->completion_lock);
1745 if (!mask && !READ_ONCE(poll->canceled)) {
1746 add_wait_queue(poll->head, &poll->wait);
1747 spin_unlock_irq(&ctx->completion_lock);
1748 return;
1749 }
1750 list_del_init(&req->list);
Jens Axboe8c838782019-03-12 15:48:16 -06001751 io_poll_complete(ctx, req, mask);
Jens Axboe221c5eb2019-01-17 09:41:58 -07001752 spin_unlock_irq(&ctx->completion_lock);
1753
Jens Axboe8c838782019-03-12 15:48:16 -06001754 io_cqring_ev_posted(ctx);
1755 io_put_req(req);
Jens Axboe221c5eb2019-01-17 09:41:58 -07001756}
1757
1758static int io_poll_wake(struct wait_queue_entry *wait, unsigned mode, int sync,
1759 void *key)
1760{
1761 struct io_poll_iocb *poll = container_of(wait, struct io_poll_iocb,
1762 wait);
1763 struct io_kiocb *req = container_of(poll, struct io_kiocb, poll);
1764 struct io_ring_ctx *ctx = req->ctx;
1765 __poll_t mask = key_to_poll(key);
Jens Axboe8c838782019-03-12 15:48:16 -06001766 unsigned long flags;
Jens Axboe221c5eb2019-01-17 09:41:58 -07001767
1768 /* for instances that support it check for an event match first: */
Jens Axboe8c838782019-03-12 15:48:16 -06001769 if (mask && !(mask & poll->events))
1770 return 0;
Jens Axboe221c5eb2019-01-17 09:41:58 -07001771
1772 list_del_init(&poll->wait.entry);
Jens Axboe8c838782019-03-12 15:48:16 -06001773
1774 if (mask && spin_trylock_irqsave(&ctx->completion_lock, flags)) {
1775 list_del(&req->list);
1776 io_poll_complete(ctx, req, mask);
1777 spin_unlock_irqrestore(&ctx->completion_lock, flags);
1778
1779 io_cqring_ev_posted(ctx);
1780 io_put_req(req);
1781 } else {
Jens Axboe18d9be12019-09-10 09:13:05 -06001782 io_queue_async_work(ctx, req);
Jens Axboe8c838782019-03-12 15:48:16 -06001783 }
1784
Jens Axboe221c5eb2019-01-17 09:41:58 -07001785 return 1;
1786}
1787
1788struct io_poll_table {
1789 struct poll_table_struct pt;
1790 struct io_kiocb *req;
1791 int error;
1792};
1793
1794static void io_poll_queue_proc(struct file *file, struct wait_queue_head *head,
1795 struct poll_table_struct *p)
1796{
1797 struct io_poll_table *pt = container_of(p, struct io_poll_table, pt);
1798
1799 if (unlikely(pt->req->poll.head)) {
1800 pt->error = -EINVAL;
1801 return;
1802 }
1803
1804 pt->error = 0;
1805 pt->req->poll.head = head;
1806 add_wait_queue(head, &pt->req->poll.wait);
1807}
1808
1809static int io_poll_add(struct io_kiocb *req, const struct io_uring_sqe *sqe)
1810{
1811 struct io_poll_iocb *poll = &req->poll;
1812 struct io_ring_ctx *ctx = req->ctx;
1813 struct io_poll_table ipt;
Jens Axboe8c838782019-03-12 15:48:16 -06001814 bool cancel = false;
Jens Axboe221c5eb2019-01-17 09:41:58 -07001815 __poll_t mask;
1816 u16 events;
Jens Axboe221c5eb2019-01-17 09:41:58 -07001817
1818 if (unlikely(req->ctx->flags & IORING_SETUP_IOPOLL))
1819 return -EINVAL;
1820 if (sqe->addr || sqe->ioprio || sqe->off || sqe->len || sqe->buf_index)
1821 return -EINVAL;
Jens Axboe09bb8392019-03-13 12:39:28 -06001822 if (!poll->file)
1823 return -EBADF;
Jens Axboe221c5eb2019-01-17 09:41:58 -07001824
Jens Axboe6cc47d12019-09-18 11:18:23 -06001825 req->submit.sqe = NULL;
Jens Axboe221c5eb2019-01-17 09:41:58 -07001826 INIT_WORK(&req->work, io_poll_complete_work);
1827 events = READ_ONCE(sqe->poll_events);
1828 poll->events = demangle_poll(events) | EPOLLERR | EPOLLHUP;
1829
Jens Axboe221c5eb2019-01-17 09:41:58 -07001830 poll->head = NULL;
Jens Axboe8c838782019-03-12 15:48:16 -06001831 poll->done = false;
Jens Axboe221c5eb2019-01-17 09:41:58 -07001832 poll->canceled = false;
1833
1834 ipt.pt._qproc = io_poll_queue_proc;
1835 ipt.pt._key = poll->events;
1836 ipt.req = req;
1837 ipt.error = -EINVAL; /* same as no support for IOCB_CMD_POLL */
1838
1839 /* initialized the list so that we can do list_empty checks */
1840 INIT_LIST_HEAD(&poll->wait.entry);
1841 init_waitqueue_func_entry(&poll->wait, io_poll_wake);
1842
Jens Axboe36703242019-07-25 10:20:18 -06001843 INIT_LIST_HEAD(&req->list);
1844
Jens Axboe221c5eb2019-01-17 09:41:58 -07001845 mask = vfs_poll(poll->file, &ipt.pt) & poll->events;
Jens Axboe221c5eb2019-01-17 09:41:58 -07001846
1847 spin_lock_irq(&ctx->completion_lock);
Jens Axboe8c838782019-03-12 15:48:16 -06001848 if (likely(poll->head)) {
1849 spin_lock(&poll->head->lock);
1850 if (unlikely(list_empty(&poll->wait.entry))) {
1851 if (ipt.error)
1852 cancel = true;
1853 ipt.error = 0;
1854 mask = 0;
1855 }
1856 if (mask || ipt.error)
1857 list_del_init(&poll->wait.entry);
1858 else if (cancel)
1859 WRITE_ONCE(poll->canceled, true);
1860 else if (!poll->done) /* actually waiting for an event */
1861 list_add_tail(&req->list, &ctx->cancel_list);
1862 spin_unlock(&poll->head->lock);
Jens Axboe221c5eb2019-01-17 09:41:58 -07001863 }
Jens Axboe8c838782019-03-12 15:48:16 -06001864 if (mask) { /* no async, we'd stolen it */
Jens Axboe8c838782019-03-12 15:48:16 -06001865 ipt.error = 0;
1866 io_poll_complete(ctx, req, mask);
1867 }
Jens Axboe221c5eb2019-01-17 09:41:58 -07001868 spin_unlock_irq(&ctx->completion_lock);
1869
Jens Axboe8c838782019-03-12 15:48:16 -06001870 if (mask) {
1871 io_cqring_ev_posted(ctx);
Jens Axboee65ef562019-03-12 10:16:44 -06001872 io_put_req(req);
Jens Axboe221c5eb2019-01-17 09:41:58 -07001873 }
Jens Axboe8c838782019-03-12 15:48:16 -06001874 return ipt.error;
Jens Axboe221c5eb2019-01-17 09:41:58 -07001875}
1876
Jens Axboe5262f562019-09-17 12:26:57 -06001877static enum hrtimer_restart io_timeout_fn(struct hrtimer *timer)
1878{
1879 struct io_ring_ctx *ctx;
zhangyi (F)ef036812019-10-23 15:10:08 +08001880 struct io_kiocb *req, *prev;
Jens Axboe5262f562019-09-17 12:26:57 -06001881 unsigned long flags;
1882
1883 req = container_of(timer, struct io_kiocb, timeout.timer);
1884 ctx = req->ctx;
1885 atomic_inc(&ctx->cq_timeouts);
1886
1887 spin_lock_irqsave(&ctx->completion_lock, flags);
zhangyi (F)ef036812019-10-23 15:10:08 +08001888 /*
1889 * Adjust the reqs sequence before the current one because it
1890 * will consume a slot in the cq_ring and the the cq_tail pointer
1891 * will be increased, otherwise other timeout reqs may return in
1892 * advance without waiting for enough wait_nr.
1893 */
1894 prev = req;
1895 list_for_each_entry_continue_reverse(prev, &ctx->timeout_list, list)
1896 prev->sequence++;
Jens Axboe5262f562019-09-17 12:26:57 -06001897 list_del(&req->list);
1898
1899 io_cqring_fill_event(ctx, req->user_data, -ETIME);
1900 io_commit_cqring(ctx);
1901 spin_unlock_irqrestore(&ctx->completion_lock, flags);
1902
1903 io_cqring_ev_posted(ctx);
1904
1905 io_put_req(req);
1906 return HRTIMER_NORESTART;
1907}
1908
1909static int io_timeout(struct io_kiocb *req, const struct io_uring_sqe *sqe)
1910{
yangerkun5da0fb12019-10-15 21:59:29 +08001911 unsigned count;
Jens Axboe5262f562019-09-17 12:26:57 -06001912 struct io_ring_ctx *ctx = req->ctx;
1913 struct list_head *entry;
Arnd Bergmannbdf20072019-10-01 09:53:29 -06001914 struct timespec64 ts;
zhangyi (F)a1f58ba2019-10-23 15:10:09 +08001915 unsigned span = 0;
Jens Axboe5262f562019-09-17 12:26:57 -06001916
1917 if (unlikely(ctx->flags & IORING_SETUP_IOPOLL))
1918 return -EINVAL;
1919 if (sqe->flags || sqe->ioprio || sqe->buf_index || sqe->timeout_flags ||
1920 sqe->len != 1)
1921 return -EINVAL;
Arnd Bergmannbdf20072019-10-01 09:53:29 -06001922
1923 if (get_timespec64(&ts, u64_to_user_ptr(sqe->addr)))
Jens Axboe5262f562019-09-17 12:26:57 -06001924 return -EFAULT;
1925
1926 /*
1927 * sqe->off holds how many events that need to occur for this
1928 * timeout event to be satisfied.
1929 */
1930 count = READ_ONCE(sqe->off);
1931 if (!count)
1932 count = 1;
1933
1934 req->sequence = ctx->cached_sq_head + count - 1;
yangerkun5da0fb12019-10-15 21:59:29 +08001935 /* reuse it to store the count */
1936 req->submit.sequence = count;
Jens Axboe5262f562019-09-17 12:26:57 -06001937 req->flags |= REQ_F_TIMEOUT;
1938
1939 /*
1940 * Insertion sort, ensuring the first entry in the list is always
1941 * the one we need first.
1942 */
Jens Axboe5262f562019-09-17 12:26:57 -06001943 spin_lock_irq(&ctx->completion_lock);
1944 list_for_each_prev(entry, &ctx->timeout_list) {
1945 struct io_kiocb *nxt = list_entry(entry, struct io_kiocb, list);
yangerkun5da0fb12019-10-15 21:59:29 +08001946 unsigned nxt_sq_head;
1947 long long tmp, tmp_nxt;
Jens Axboe5262f562019-09-17 12:26:57 -06001948
yangerkun5da0fb12019-10-15 21:59:29 +08001949 /*
1950 * Since cached_sq_head + count - 1 can overflow, use type long
1951 * long to store it.
1952 */
1953 tmp = (long long)ctx->cached_sq_head + count - 1;
1954 nxt_sq_head = nxt->sequence - nxt->submit.sequence + 1;
1955 tmp_nxt = (long long)nxt_sq_head + nxt->submit.sequence - 1;
1956
1957 /*
1958 * cached_sq_head may overflow, and it will never overflow twice
1959 * once there is some timeout req still be valid.
1960 */
1961 if (ctx->cached_sq_head < nxt_sq_head)
yangerkun8b07a652019-10-17 12:12:35 +08001962 tmp += UINT_MAX;
yangerkun5da0fb12019-10-15 21:59:29 +08001963
zhangyi (F)a1f58ba2019-10-23 15:10:09 +08001964 if (tmp > tmp_nxt)
Jens Axboe5262f562019-09-17 12:26:57 -06001965 break;
zhangyi (F)a1f58ba2019-10-23 15:10:09 +08001966
1967 /*
1968 * Sequence of reqs after the insert one and itself should
1969 * be adjusted because each timeout req consumes a slot.
1970 */
1971 span++;
1972 nxt->sequence++;
Jens Axboe5262f562019-09-17 12:26:57 -06001973 }
zhangyi (F)a1f58ba2019-10-23 15:10:09 +08001974 req->sequence -= span;
Jens Axboe5262f562019-09-17 12:26:57 -06001975 list_add(&req->list, entry);
1976 spin_unlock_irq(&ctx->completion_lock);
1977
1978 hrtimer_init(&req->timeout.timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
1979 req->timeout.timer.function = io_timeout_fn;
Arnd Bergmannbdf20072019-10-01 09:53:29 -06001980 hrtimer_start(&req->timeout.timer, timespec64_to_ktime(ts),
Jens Axboe5262f562019-09-17 12:26:57 -06001981 HRTIMER_MODE_REL);
1982 return 0;
1983}
1984
Jens Axboede0617e2019-04-06 21:51:27 -06001985static int io_req_defer(struct io_ring_ctx *ctx, struct io_kiocb *req,
1986 const struct io_uring_sqe *sqe)
1987{
1988 struct io_uring_sqe *sqe_copy;
1989
1990 if (!io_sequence_defer(ctx, req) && list_empty(&ctx->defer_list))
1991 return 0;
1992
1993 sqe_copy = kmalloc(sizeof(*sqe_copy), GFP_KERNEL);
1994 if (!sqe_copy)
1995 return -EAGAIN;
1996
1997 spin_lock_irq(&ctx->completion_lock);
1998 if (!io_sequence_defer(ctx, req) && list_empty(&ctx->defer_list)) {
1999 spin_unlock_irq(&ctx->completion_lock);
2000 kfree(sqe_copy);
2001 return 0;
2002 }
2003
2004 memcpy(sqe_copy, sqe, sizeof(*sqe_copy));
2005 req->submit.sqe = sqe_copy;
2006
2007 INIT_WORK(&req->work, io_sq_wq_submit_work);
2008 list_add_tail(&req->list, &ctx->defer_list);
2009 spin_unlock_irq(&ctx->completion_lock);
2010 return -EIOCBQUEUED;
2011}
2012
Jens Axboe2b188cc2019-01-07 10:46:33 -07002013static int __io_submit_sqe(struct io_ring_ctx *ctx, struct io_kiocb *req,
Jens Axboe8358e3a2019-04-23 08:17:58 -06002014 const struct sqe_submit *s, bool force_nonblock)
Jens Axboe2b188cc2019-01-07 10:46:33 -07002015{
Jens Axboee0c5c572019-03-12 10:18:47 -06002016 int ret, opcode;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002017
Jens Axboe9e645e112019-05-10 16:07:28 -06002018 req->user_data = READ_ONCE(s->sqe->user_data);
2019
Jens Axboe2b188cc2019-01-07 10:46:33 -07002020 if (unlikely(s->index >= ctx->sq_entries))
2021 return -EINVAL;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002022
2023 opcode = READ_ONCE(s->sqe->opcode);
2024 switch (opcode) {
2025 case IORING_OP_NOP:
2026 ret = io_nop(req, req->user_data);
2027 break;
2028 case IORING_OP_READV:
Jens Axboeedafcce2019-01-09 09:16:05 -07002029 if (unlikely(s->sqe->buf_index))
2030 return -EINVAL;
Jens Axboe8358e3a2019-04-23 08:17:58 -06002031 ret = io_read(req, s, force_nonblock);
Jens Axboe2b188cc2019-01-07 10:46:33 -07002032 break;
2033 case IORING_OP_WRITEV:
Jens Axboeedafcce2019-01-09 09:16:05 -07002034 if (unlikely(s->sqe->buf_index))
2035 return -EINVAL;
Jens Axboe8358e3a2019-04-23 08:17:58 -06002036 ret = io_write(req, s, force_nonblock);
Jens Axboeedafcce2019-01-09 09:16:05 -07002037 break;
2038 case IORING_OP_READ_FIXED:
Jens Axboe8358e3a2019-04-23 08:17:58 -06002039 ret = io_read(req, s, force_nonblock);
Jens Axboeedafcce2019-01-09 09:16:05 -07002040 break;
2041 case IORING_OP_WRITE_FIXED:
Jens Axboe8358e3a2019-04-23 08:17:58 -06002042 ret = io_write(req, s, force_nonblock);
Jens Axboe2b188cc2019-01-07 10:46:33 -07002043 break;
Christoph Hellwigc992fe22019-01-11 09:43:02 -07002044 case IORING_OP_FSYNC:
2045 ret = io_fsync(req, s->sqe, force_nonblock);
2046 break;
Jens Axboe221c5eb2019-01-17 09:41:58 -07002047 case IORING_OP_POLL_ADD:
2048 ret = io_poll_add(req, s->sqe);
2049 break;
2050 case IORING_OP_POLL_REMOVE:
2051 ret = io_poll_remove(req, s->sqe);
2052 break;
Jens Axboe5d17b4a2019-04-09 14:56:44 -06002053 case IORING_OP_SYNC_FILE_RANGE:
2054 ret = io_sync_file_range(req, s->sqe, force_nonblock);
2055 break;
Jens Axboe0fa03c62019-04-19 13:34:07 -06002056 case IORING_OP_SENDMSG:
2057 ret = io_sendmsg(req, s->sqe, force_nonblock);
2058 break;
Jens Axboeaa1fa282019-04-19 13:38:09 -06002059 case IORING_OP_RECVMSG:
2060 ret = io_recvmsg(req, s->sqe, force_nonblock);
2061 break;
Jens Axboe5262f562019-09-17 12:26:57 -06002062 case IORING_OP_TIMEOUT:
2063 ret = io_timeout(req, s->sqe);
2064 break;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002065 default:
2066 ret = -EINVAL;
2067 break;
2068 }
2069
Jens Axboedef596e2019-01-09 08:59:42 -07002070 if (ret)
2071 return ret;
2072
2073 if (ctx->flags & IORING_SETUP_IOPOLL) {
Jens Axboe9e645e112019-05-10 16:07:28 -06002074 if (req->result == -EAGAIN)
Jens Axboedef596e2019-01-09 08:59:42 -07002075 return -EAGAIN;
2076
2077 /* workqueue context doesn't hold uring_lock, grab it now */
2078 if (s->needs_lock)
2079 mutex_lock(&ctx->uring_lock);
2080 io_iopoll_req_issued(req);
2081 if (s->needs_lock)
2082 mutex_unlock(&ctx->uring_lock);
2083 }
2084
2085 return 0;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002086}
2087
Jens Axboe31b51512019-01-18 22:56:34 -07002088static struct async_list *io_async_list_from_sqe(struct io_ring_ctx *ctx,
2089 const struct io_uring_sqe *sqe)
2090{
2091 switch (sqe->opcode) {
2092 case IORING_OP_READV:
2093 case IORING_OP_READ_FIXED:
2094 return &ctx->pending_async[READ];
2095 case IORING_OP_WRITEV:
2096 case IORING_OP_WRITE_FIXED:
2097 return &ctx->pending_async[WRITE];
2098 default:
2099 return NULL;
2100 }
2101}
2102
Jens Axboeedafcce2019-01-09 09:16:05 -07002103static inline bool io_sqe_needs_user(const struct io_uring_sqe *sqe)
2104{
2105 u8 opcode = READ_ONCE(sqe->opcode);
2106
2107 return !(opcode == IORING_OP_READ_FIXED ||
2108 opcode == IORING_OP_WRITE_FIXED);
2109}
2110
Jens Axboe2b188cc2019-01-07 10:46:33 -07002111static void io_sq_wq_submit_work(struct work_struct *work)
2112{
2113 struct io_kiocb *req = container_of(work, struct io_kiocb, work);
Jens Axboe2b188cc2019-01-07 10:46:33 -07002114 struct io_ring_ctx *ctx = req->ctx;
Jens Axboe31b51512019-01-18 22:56:34 -07002115 struct mm_struct *cur_mm = NULL;
2116 struct async_list *async_list;
2117 LIST_HEAD(req_list);
Jens Axboeedafcce2019-01-09 09:16:05 -07002118 mm_segment_t old_fs;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002119 int ret;
2120
Jens Axboe31b51512019-01-18 22:56:34 -07002121 async_list = io_async_list_from_sqe(ctx, req->submit.sqe);
2122restart:
2123 do {
2124 struct sqe_submit *s = &req->submit;
2125 const struct io_uring_sqe *sqe = s->sqe;
Jackie Liud0ee8792019-07-31 14:39:33 +08002126 unsigned int flags = req->flags;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002127
Stefan Bühler8449eed2019-04-27 20:34:19 +02002128 /* Ensure we clear previously set non-block flag */
Jens Axboe31b51512019-01-18 22:56:34 -07002129 req->rw.ki_flags &= ~IOCB_NOWAIT;
2130
2131 ret = 0;
2132 if (io_sqe_needs_user(sqe) && !cur_mm) {
2133 if (!mmget_not_zero(ctx->sqo_mm)) {
2134 ret = -EFAULT;
2135 } else {
2136 cur_mm = ctx->sqo_mm;
2137 use_mm(cur_mm);
2138 old_fs = get_fs();
2139 set_fs(USER_DS);
2140 }
2141 }
2142
2143 if (!ret) {
2144 s->has_user = cur_mm != NULL;
2145 s->needs_lock = true;
2146 do {
Jens Axboe8358e3a2019-04-23 08:17:58 -06002147 ret = __io_submit_sqe(ctx, req, s, false);
Jens Axboe31b51512019-01-18 22:56:34 -07002148 /*
2149 * We can get EAGAIN for polled IO even though
2150 * we're forcing a sync submission from here,
2151 * since we can't wait for request slots on the
2152 * block side.
2153 */
2154 if (ret != -EAGAIN)
2155 break;
2156 cond_resched();
2157 } while (1);
2158 }
Jens Axboe817869d2019-04-30 14:44:05 -06002159
2160 /* drop submission reference */
2161 io_put_req(req);
2162
Jens Axboe31b51512019-01-18 22:56:34 -07002163 if (ret) {
Jens Axboec71ffb62019-05-13 20:58:29 -06002164 io_cqring_add_event(ctx, sqe->user_data, ret);
Jens Axboee65ef562019-03-12 10:16:44 -06002165 io_put_req(req);
Jens Axboe31b51512019-01-18 22:56:34 -07002166 }
2167
2168 /* async context always use a copy of the sqe */
2169 kfree(sqe);
2170
Zhengyuan Liuf7b76ac2019-07-16 23:26:14 +08002171 /* req from defer and link list needn't decrease async cnt */
Jackie Liud0ee8792019-07-31 14:39:33 +08002172 if (flags & (REQ_F_IO_DRAINED | REQ_F_LINK_DONE))
Zhengyuan Liuf7b76ac2019-07-16 23:26:14 +08002173 goto out;
2174
Jens Axboe31b51512019-01-18 22:56:34 -07002175 if (!async_list)
2176 break;
2177 if (!list_empty(&req_list)) {
2178 req = list_first_entry(&req_list, struct io_kiocb,
2179 list);
2180 list_del(&req->list);
2181 continue;
2182 }
2183 if (list_empty(&async_list->list))
2184 break;
2185
2186 req = NULL;
2187 spin_lock(&async_list->lock);
2188 if (list_empty(&async_list->list)) {
2189 spin_unlock(&async_list->lock);
2190 break;
2191 }
2192 list_splice_init(&async_list->list, &req_list);
2193 spin_unlock(&async_list->lock);
2194
2195 req = list_first_entry(&req_list, struct io_kiocb, list);
2196 list_del(&req->list);
2197 } while (req);
Jens Axboeedafcce2019-01-09 09:16:05 -07002198
2199 /*
Jens Axboe31b51512019-01-18 22:56:34 -07002200 * Rare case of racing with a submitter. If we find the count has
2201 * dropped to zero AND we have pending work items, then restart
2202 * the processing. This is a tiny race window.
Jens Axboeedafcce2019-01-09 09:16:05 -07002203 */
Jens Axboe31b51512019-01-18 22:56:34 -07002204 if (async_list) {
2205 ret = atomic_dec_return(&async_list->cnt);
2206 while (!ret && !list_empty(&async_list->list)) {
2207 spin_lock(&async_list->lock);
2208 atomic_inc(&async_list->cnt);
2209 list_splice_init(&async_list->list, &req_list);
2210 spin_unlock(&async_list->lock);
2211
2212 if (!list_empty(&req_list)) {
2213 req = list_first_entry(&req_list,
2214 struct io_kiocb, list);
2215 list_del(&req->list);
2216 goto restart;
2217 }
2218 ret = atomic_dec_return(&async_list->cnt);
Jens Axboeedafcce2019-01-09 09:16:05 -07002219 }
Jens Axboeedafcce2019-01-09 09:16:05 -07002220 }
Jens Axboe2b188cc2019-01-07 10:46:33 -07002221
Zhengyuan Liuf7b76ac2019-07-16 23:26:14 +08002222out:
Jens Axboe31b51512019-01-18 22:56:34 -07002223 if (cur_mm) {
Jens Axboeedafcce2019-01-09 09:16:05 -07002224 set_fs(old_fs);
Jens Axboe31b51512019-01-18 22:56:34 -07002225 unuse_mm(cur_mm);
2226 mmput(cur_mm);
Jens Axboeedafcce2019-01-09 09:16:05 -07002227 }
Jens Axboe31b51512019-01-18 22:56:34 -07002228}
Jens Axboe2b188cc2019-01-07 10:46:33 -07002229
Jens Axboe31b51512019-01-18 22:56:34 -07002230/*
2231 * See if we can piggy back onto previously submitted work, that is still
2232 * running. We currently only allow this if the new request is sequential
2233 * to the previous one we punted.
2234 */
2235static bool io_add_to_prev_work(struct async_list *list, struct io_kiocb *req)
2236{
Jens Axboe6d5d5ac2019-09-11 10:16:13 -06002237 bool ret;
Jens Axboe31b51512019-01-18 22:56:34 -07002238
2239 if (!list)
2240 return false;
2241 if (!(req->flags & REQ_F_SEQ_PREV))
2242 return false;
2243 if (!atomic_read(&list->cnt))
2244 return false;
2245
2246 ret = true;
2247 spin_lock(&list->lock);
2248 list_add_tail(&req->list, &list->list);
Zhengyuan Liuc0e48f92019-07-18 20:44:00 +08002249 /*
2250 * Ensure we see a simultaneous modification from io_sq_wq_submit_work()
2251 */
2252 smp_mb();
Jens Axboe31b51512019-01-18 22:56:34 -07002253 if (!atomic_read(&list->cnt)) {
2254 list_del_init(&req->list);
2255 ret = false;
2256 }
2257 spin_unlock(&list->lock);
2258 return ret;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002259}
2260
Jens Axboe09bb8392019-03-13 12:39:28 -06002261static bool io_op_needs_file(const struct io_uring_sqe *sqe)
2262{
2263 int op = READ_ONCE(sqe->opcode);
2264
2265 switch (op) {
2266 case IORING_OP_NOP:
2267 case IORING_OP_POLL_REMOVE:
2268 return false;
2269 default:
2270 return true;
2271 }
2272}
2273
2274static int io_req_set_file(struct io_ring_ctx *ctx, const struct sqe_submit *s,
2275 struct io_submit_state *state, struct io_kiocb *req)
2276{
2277 unsigned flags;
2278 int fd;
2279
2280 flags = READ_ONCE(s->sqe->flags);
2281 fd = READ_ONCE(s->sqe->fd);
2282
Jackie Liu4fe2c962019-09-09 20:50:40 +08002283 if (flags & IOSQE_IO_DRAIN)
Jens Axboede0617e2019-04-06 21:51:27 -06002284 req->flags |= REQ_F_IO_DRAIN;
Jackie Liu4fe2c962019-09-09 20:50:40 +08002285 /*
2286 * All io need record the previous position, if LINK vs DARIN,
2287 * it can be used to mark the position of the first IO in the
2288 * link list.
2289 */
2290 req->sequence = s->sequence;
Jens Axboede0617e2019-04-06 21:51:27 -06002291
Jens Axboe60c112b2019-06-21 10:20:18 -06002292 if (!io_op_needs_file(s->sqe))
Jens Axboe09bb8392019-03-13 12:39:28 -06002293 return 0;
Jens Axboe09bb8392019-03-13 12:39:28 -06002294
2295 if (flags & IOSQE_FIXED_FILE) {
2296 if (unlikely(!ctx->user_files ||
2297 (unsigned) fd >= ctx->nr_user_files))
2298 return -EBADF;
2299 req->file = ctx->user_files[fd];
2300 req->flags |= REQ_F_FIXED_FILE;
2301 } else {
2302 if (s->needs_fixed_file)
2303 return -EBADF;
2304 req->file = io_file_get(state, fd);
2305 if (unlikely(!req->file))
2306 return -EBADF;
2307 }
2308
2309 return 0;
2310}
2311
Jackie Liu4fe2c962019-09-09 20:50:40 +08002312static int __io_queue_sqe(struct io_ring_ctx *ctx, struct io_kiocb *req,
Jens Axboebc808bc2019-10-22 13:14:37 -06002313 struct sqe_submit *s)
Jens Axboe2b188cc2019-01-07 10:46:33 -07002314{
Jens Axboee0c5c572019-03-12 10:18:47 -06002315 int ret;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002316
Jens Axboebc808bc2019-10-22 13:14:37 -06002317 ret = __io_submit_sqe(ctx, req, s, true);
Jens Axboe491381ce2019-10-17 09:20:46 -06002318
2319 /*
2320 * We async punt it if the file wasn't marked NOWAIT, or if the file
2321 * doesn't support non-blocking read/write attempts
2322 */
2323 if (ret == -EAGAIN && (!(req->flags & REQ_F_NOWAIT) ||
2324 (req->flags & REQ_F_MUST_PUNT))) {
Jens Axboe2b188cc2019-01-07 10:46:33 -07002325 struct io_uring_sqe *sqe_copy;
2326
Jackie Liu954dab12019-09-18 10:37:52 +08002327 sqe_copy = kmemdup(s->sqe, sizeof(*sqe_copy), GFP_KERNEL);
Jens Axboe2b188cc2019-01-07 10:46:33 -07002328 if (sqe_copy) {
Jens Axboe31b51512019-01-18 22:56:34 -07002329 struct async_list *list;
2330
Jens Axboe2b188cc2019-01-07 10:46:33 -07002331 s->sqe = sqe_copy;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002332 memcpy(&req->submit, s, sizeof(*s));
Jens Axboe31b51512019-01-18 22:56:34 -07002333 list = io_async_list_from_sqe(ctx, s->sqe);
2334 if (!io_add_to_prev_work(list, req)) {
2335 if (list)
2336 atomic_inc(&list->cnt);
2337 INIT_WORK(&req->work, io_sq_wq_submit_work);
Jens Axboe18d9be12019-09-10 09:13:05 -06002338 io_queue_async_work(ctx, req);
Jens Axboe31b51512019-01-18 22:56:34 -07002339 }
Jens Axboee65ef562019-03-12 10:16:44 -06002340
2341 /*
2342 * Queued up for async execution, worker will release
Jens Axboe9e645e112019-05-10 16:07:28 -06002343 * submit reference when the iocb is actually submitted.
Jens Axboee65ef562019-03-12 10:16:44 -06002344 */
2345 return 0;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002346 }
2347 }
Jens Axboee65ef562019-03-12 10:16:44 -06002348
2349 /* drop submission reference */
2350 io_put_req(req);
2351
2352 /* and drop final reference, if we failed */
Jens Axboe9e645e112019-05-10 16:07:28 -06002353 if (ret) {
2354 io_cqring_add_event(ctx, req->user_data, ret);
2355 if (req->flags & REQ_F_LINK)
2356 req->flags |= REQ_F_FAIL_LINK;
Jens Axboee65ef562019-03-12 10:16:44 -06002357 io_put_req(req);
Jens Axboe9e645e112019-05-10 16:07:28 -06002358 }
Jens Axboe2b188cc2019-01-07 10:46:33 -07002359
2360 return ret;
2361}
2362
Jackie Liu4fe2c962019-09-09 20:50:40 +08002363static int io_queue_sqe(struct io_ring_ctx *ctx, struct io_kiocb *req,
Jens Axboebc808bc2019-10-22 13:14:37 -06002364 struct sqe_submit *s)
Jackie Liu4fe2c962019-09-09 20:50:40 +08002365{
2366 int ret;
2367
2368 ret = io_req_defer(ctx, req, s->sqe);
2369 if (ret) {
2370 if (ret != -EIOCBQUEUED) {
2371 io_free_req(req);
2372 io_cqring_add_event(ctx, s->sqe->user_data, ret);
2373 }
2374 return 0;
2375 }
2376
Jens Axboebc808bc2019-10-22 13:14:37 -06002377 return __io_queue_sqe(ctx, req, s);
Jackie Liu4fe2c962019-09-09 20:50:40 +08002378}
2379
2380static int io_queue_link_head(struct io_ring_ctx *ctx, struct io_kiocb *req,
Jens Axboebc808bc2019-10-22 13:14:37 -06002381 struct sqe_submit *s, struct io_kiocb *shadow)
Jackie Liu4fe2c962019-09-09 20:50:40 +08002382{
2383 int ret;
2384 int need_submit = false;
2385
2386 if (!shadow)
Jens Axboebc808bc2019-10-22 13:14:37 -06002387 return io_queue_sqe(ctx, req, s);
Jackie Liu4fe2c962019-09-09 20:50:40 +08002388
2389 /*
2390 * Mark the first IO in link list as DRAIN, let all the following
2391 * IOs enter the defer list. all IO needs to be completed before link
2392 * list.
2393 */
2394 req->flags |= REQ_F_IO_DRAIN;
2395 ret = io_req_defer(ctx, req, s->sqe);
2396 if (ret) {
2397 if (ret != -EIOCBQUEUED) {
2398 io_free_req(req);
2399 io_cqring_add_event(ctx, s->sqe->user_data, ret);
2400 return 0;
2401 }
2402 } else {
2403 /*
2404 * If ret == 0 means that all IOs in front of link io are
2405 * running done. let's queue link head.
2406 */
2407 need_submit = true;
2408 }
2409
2410 /* Insert shadow req to defer_list, blocking next IOs */
2411 spin_lock_irq(&ctx->completion_lock);
2412 list_add_tail(&shadow->list, &ctx->defer_list);
2413 spin_unlock_irq(&ctx->completion_lock);
2414
2415 if (need_submit)
Jens Axboebc808bc2019-10-22 13:14:37 -06002416 return __io_queue_sqe(ctx, req, s);
Jackie Liu4fe2c962019-09-09 20:50:40 +08002417
2418 return 0;
2419}
2420
Jens Axboe9e645e112019-05-10 16:07:28 -06002421#define SQE_VALID_FLAGS (IOSQE_FIXED_FILE|IOSQE_IO_DRAIN|IOSQE_IO_LINK)
2422
2423static void io_submit_sqe(struct io_ring_ctx *ctx, struct sqe_submit *s,
Jens Axboebc808bc2019-10-22 13:14:37 -06002424 struct io_submit_state *state, struct io_kiocb **link)
Jens Axboe9e645e112019-05-10 16:07:28 -06002425{
2426 struct io_uring_sqe *sqe_copy;
2427 struct io_kiocb *req;
2428 int ret;
2429
2430 /* enforce forwards compatibility on users */
2431 if (unlikely(s->sqe->flags & ~SQE_VALID_FLAGS)) {
2432 ret = -EINVAL;
2433 goto err;
2434 }
2435
2436 req = io_get_req(ctx, state);
2437 if (unlikely(!req)) {
2438 ret = -EAGAIN;
2439 goto err;
2440 }
2441
2442 ret = io_req_set_file(ctx, s, state, req);
2443 if (unlikely(ret)) {
2444err_req:
2445 io_free_req(req);
2446err:
2447 io_cqring_add_event(ctx, s->sqe->user_data, ret);
2448 return;
2449 }
2450
Jens Axboe9e645e112019-05-10 16:07:28 -06002451 /*
2452 * If we already have a head request, queue this one for async
2453 * submittal once the head completes. If we don't have a head but
2454 * IOSQE_IO_LINK is set in the sqe, start a new head. This one will be
2455 * submitted sync once the chain is complete. If none of those
2456 * conditions are true (normal request), then just queue it.
2457 */
2458 if (*link) {
2459 struct io_kiocb *prev = *link;
2460
2461 sqe_copy = kmemdup(s->sqe, sizeof(*sqe_copy), GFP_KERNEL);
2462 if (!sqe_copy) {
2463 ret = -EAGAIN;
2464 goto err_req;
2465 }
2466
2467 s->sqe = sqe_copy;
2468 memcpy(&req->submit, s, sizeof(*s));
2469 list_add_tail(&req->list, &prev->link_list);
2470 } else if (s->sqe->flags & IOSQE_IO_LINK) {
2471 req->flags |= REQ_F_LINK;
2472
2473 memcpy(&req->submit, s, sizeof(*s));
2474 INIT_LIST_HEAD(&req->link_list);
2475 *link = req;
2476 } else {
Jens Axboebc808bc2019-10-22 13:14:37 -06002477 io_queue_sqe(ctx, req, s);
Jens Axboe9e645e112019-05-10 16:07:28 -06002478 }
2479}
2480
Jens Axboe9a56a232019-01-09 09:06:50 -07002481/*
2482 * Batched submission is done, ensure local IO is flushed out.
2483 */
2484static void io_submit_state_end(struct io_submit_state *state)
2485{
2486 blk_finish_plug(&state->plug);
Jens Axboe3d6770f2019-04-13 11:50:54 -06002487 io_file_put(state);
Jens Axboe2579f912019-01-09 09:10:43 -07002488 if (state->free_reqs)
2489 kmem_cache_free_bulk(req_cachep, state->free_reqs,
2490 &state->reqs[state->cur_req]);
Jens Axboe9a56a232019-01-09 09:06:50 -07002491}
2492
2493/*
2494 * Start submission side cache.
2495 */
2496static void io_submit_state_start(struct io_submit_state *state,
2497 struct io_ring_ctx *ctx, unsigned max_ios)
2498{
2499 blk_start_plug(&state->plug);
Jens Axboe2579f912019-01-09 09:10:43 -07002500 state->free_reqs = 0;
Jens Axboe9a56a232019-01-09 09:06:50 -07002501 state->file = NULL;
2502 state->ios_left = max_ios;
2503}
2504
Jens Axboe2b188cc2019-01-07 10:46:33 -07002505static void io_commit_sqring(struct io_ring_ctx *ctx)
2506{
Hristo Venev75b28af2019-08-26 17:23:46 +00002507 struct io_rings *rings = ctx->rings;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002508
Hristo Venev75b28af2019-08-26 17:23:46 +00002509 if (ctx->cached_sq_head != READ_ONCE(rings->sq.head)) {
Jens Axboe2b188cc2019-01-07 10:46:33 -07002510 /*
2511 * Ensure any loads from the SQEs are done at this point,
2512 * since once we write the new head, the application could
2513 * write new data to them.
2514 */
Hristo Venev75b28af2019-08-26 17:23:46 +00002515 smp_store_release(&rings->sq.head, ctx->cached_sq_head);
Jens Axboe2b188cc2019-01-07 10:46:33 -07002516 }
2517}
2518
2519/*
Jens Axboe2b188cc2019-01-07 10:46:33 -07002520 * Fetch an sqe, if one is available. Note that s->sqe will point to memory
2521 * that is mapped by userspace. This means that care needs to be taken to
2522 * ensure that reads are stable, as we cannot rely on userspace always
2523 * being a good citizen. If members of the sqe are validated and then later
2524 * used, it's important that those reads are done through READ_ONCE() to
2525 * prevent a re-load down the line.
2526 */
2527static bool io_get_sqring(struct io_ring_ctx *ctx, struct sqe_submit *s)
2528{
Hristo Venev75b28af2019-08-26 17:23:46 +00002529 struct io_rings *rings = ctx->rings;
2530 u32 *sq_array = ctx->sq_array;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002531 unsigned head;
2532
2533 /*
2534 * The cached sq head (or cq tail) serves two purposes:
2535 *
2536 * 1) allows us to batch the cost of updating the user visible
2537 * head updates.
2538 * 2) allows the kernel side to track the head on its own, even
2539 * though the application is the one updating it.
2540 */
2541 head = ctx->cached_sq_head;
Stefan Bühlere523a292019-04-19 11:57:44 +02002542 /* make sure SQ entry isn't read before tail */
Hristo Venev75b28af2019-08-26 17:23:46 +00002543 if (head == smp_load_acquire(&rings->sq.tail))
Jens Axboe2b188cc2019-01-07 10:46:33 -07002544 return false;
2545
Hristo Venev75b28af2019-08-26 17:23:46 +00002546 head = READ_ONCE(sq_array[head & ctx->sq_mask]);
Jens Axboe2b188cc2019-01-07 10:46:33 -07002547 if (head < ctx->sq_entries) {
2548 s->index = head;
2549 s->sqe = &ctx->sq_sqes[head];
Jackie Liu8776f3f2019-09-09 20:50:39 +08002550 s->sequence = ctx->cached_sq_head;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002551 ctx->cached_sq_head++;
2552 return true;
2553 }
2554
2555 /* drop invalid entries */
2556 ctx->cached_sq_head++;
Hristo Venev75b28af2019-08-26 17:23:46 +00002557 rings->sq_dropped++;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002558 return false;
2559}
2560
Jens Axboe6c271ce2019-01-10 11:22:30 -07002561static int io_submit_sqes(struct io_ring_ctx *ctx, struct sqe_submit *sqes,
2562 unsigned int nr, bool has_user, bool mm_fault)
2563{
2564 struct io_submit_state state, *statep = NULL;
Jens Axboe9e645e112019-05-10 16:07:28 -06002565 struct io_kiocb *link = NULL;
Jackie Liu4fe2c962019-09-09 20:50:40 +08002566 struct io_kiocb *shadow_req = NULL;
Jens Axboe9e645e112019-05-10 16:07:28 -06002567 bool prev_was_link = false;
2568 int i, submitted = 0;
Jens Axboe6c271ce2019-01-10 11:22:30 -07002569
2570 if (nr > IO_PLUG_THRESHOLD) {
2571 io_submit_state_start(&state, ctx, nr);
2572 statep = &state;
2573 }
2574
2575 for (i = 0; i < nr; i++) {
Jens Axboe9e645e112019-05-10 16:07:28 -06002576 /*
2577 * If previous wasn't linked and we have a linked command,
2578 * that's the end of the chain. Submit the previous link.
2579 */
2580 if (!prev_was_link && link) {
Jens Axboebc808bc2019-10-22 13:14:37 -06002581 io_queue_link_head(ctx, link, &link->submit, shadow_req);
Jens Axboe9e645e112019-05-10 16:07:28 -06002582 link = NULL;
Jackie Liu5f5ad9c2019-09-18 10:37:53 +08002583 shadow_req = NULL;
Jens Axboe9e645e112019-05-10 16:07:28 -06002584 }
2585 prev_was_link = (sqes[i].sqe->flags & IOSQE_IO_LINK) != 0;
2586
Jackie Liu4fe2c962019-09-09 20:50:40 +08002587 if (link && (sqes[i].sqe->flags & IOSQE_IO_DRAIN)) {
2588 if (!shadow_req) {
2589 shadow_req = io_get_req(ctx, NULL);
Jackie Liua1041c22019-09-18 17:25:52 +08002590 if (unlikely(!shadow_req))
2591 goto out;
Jackie Liu4fe2c962019-09-09 20:50:40 +08002592 shadow_req->flags |= (REQ_F_IO_DRAIN | REQ_F_SHADOW_DRAIN);
2593 refcount_dec(&shadow_req->refs);
2594 }
2595 shadow_req->sequence = sqes[i].sequence;
2596 }
2597
Jackie Liua1041c22019-09-18 17:25:52 +08002598out:
Jens Axboe6c271ce2019-01-10 11:22:30 -07002599 if (unlikely(mm_fault)) {
Jens Axboe9e645e112019-05-10 16:07:28 -06002600 io_cqring_add_event(ctx, sqes[i].sqe->user_data,
2601 -EFAULT);
Jens Axboe6c271ce2019-01-10 11:22:30 -07002602 } else {
2603 sqes[i].has_user = has_user;
2604 sqes[i].needs_lock = true;
2605 sqes[i].needs_fixed_file = true;
Jens Axboebc808bc2019-10-22 13:14:37 -06002606 io_submit_sqe(ctx, &sqes[i], statep, &link);
Jens Axboe6c271ce2019-01-10 11:22:30 -07002607 submitted++;
Jens Axboe6c271ce2019-01-10 11:22:30 -07002608 }
Jens Axboe6c271ce2019-01-10 11:22:30 -07002609 }
2610
Jens Axboe9e645e112019-05-10 16:07:28 -06002611 if (link)
Jens Axboebc808bc2019-10-22 13:14:37 -06002612 io_queue_link_head(ctx, link, &link->submit, shadow_req);
Jens Axboe6c271ce2019-01-10 11:22:30 -07002613 if (statep)
2614 io_submit_state_end(&state);
2615
2616 return submitted;
2617}
2618
2619static int io_sq_thread(void *data)
2620{
2621 struct sqe_submit sqes[IO_IOPOLL_BATCH];
2622 struct io_ring_ctx *ctx = data;
2623 struct mm_struct *cur_mm = NULL;
2624 mm_segment_t old_fs;
2625 DEFINE_WAIT(wait);
2626 unsigned inflight;
2627 unsigned long timeout;
2628
Jackie Liua4c0b3d2019-07-08 13:41:12 +08002629 complete(&ctx->sqo_thread_started);
2630
Jens Axboe6c271ce2019-01-10 11:22:30 -07002631 old_fs = get_fs();
2632 set_fs(USER_DS);
2633
2634 timeout = inflight = 0;
Roman Penyaev2bbcd6d2019-05-16 10:53:57 +02002635 while (!kthread_should_park()) {
Jens Axboe6c271ce2019-01-10 11:22:30 -07002636 bool all_fixed, mm_fault = false;
2637 int i;
2638
2639 if (inflight) {
2640 unsigned nr_events = 0;
2641
2642 if (ctx->flags & IORING_SETUP_IOPOLL) {
Jens Axboe6c271ce2019-01-10 11:22:30 -07002643 io_iopoll_check(ctx, &nr_events, 0);
Jens Axboe6c271ce2019-01-10 11:22:30 -07002644 } else {
2645 /*
2646 * Normal IO, just pretend everything completed.
2647 * We don't have to poll completions for that.
2648 */
2649 nr_events = inflight;
2650 }
2651
2652 inflight -= nr_events;
2653 if (!inflight)
2654 timeout = jiffies + ctx->sq_thread_idle;
2655 }
2656
2657 if (!io_get_sqring(ctx, &sqes[0])) {
2658 /*
2659 * We're polling. If we're within the defined idle
2660 * period, then let us spin without work before going
2661 * to sleep.
2662 */
2663 if (inflight || !time_after(jiffies, timeout)) {
Jens Axboe9831a902019-09-19 09:48:55 -06002664 cond_resched();
Jens Axboe6c271ce2019-01-10 11:22:30 -07002665 continue;
2666 }
2667
2668 /*
2669 * Drop cur_mm before scheduling, we can't hold it for
2670 * long periods (or over schedule()). Do this before
2671 * adding ourselves to the waitqueue, as the unuse/drop
2672 * may sleep.
2673 */
2674 if (cur_mm) {
2675 unuse_mm(cur_mm);
2676 mmput(cur_mm);
2677 cur_mm = NULL;
2678 }
2679
2680 prepare_to_wait(&ctx->sqo_wait, &wait,
2681 TASK_INTERRUPTIBLE);
2682
2683 /* Tell userspace we may need a wakeup call */
Hristo Venev75b28af2019-08-26 17:23:46 +00002684 ctx->rings->sq_flags |= IORING_SQ_NEED_WAKEUP;
Stefan Bühler0d7bae62019-04-19 11:57:45 +02002685 /* make sure to read SQ tail after writing flags */
2686 smp_mb();
Jens Axboe6c271ce2019-01-10 11:22:30 -07002687
2688 if (!io_get_sqring(ctx, &sqes[0])) {
Roman Penyaev2bbcd6d2019-05-16 10:53:57 +02002689 if (kthread_should_park()) {
Jens Axboe6c271ce2019-01-10 11:22:30 -07002690 finish_wait(&ctx->sqo_wait, &wait);
2691 break;
2692 }
2693 if (signal_pending(current))
2694 flush_signals(current);
2695 schedule();
2696 finish_wait(&ctx->sqo_wait, &wait);
2697
Hristo Venev75b28af2019-08-26 17:23:46 +00002698 ctx->rings->sq_flags &= ~IORING_SQ_NEED_WAKEUP;
Jens Axboe6c271ce2019-01-10 11:22:30 -07002699 continue;
2700 }
2701 finish_wait(&ctx->sqo_wait, &wait);
2702
Hristo Venev75b28af2019-08-26 17:23:46 +00002703 ctx->rings->sq_flags &= ~IORING_SQ_NEED_WAKEUP;
Jens Axboe6c271ce2019-01-10 11:22:30 -07002704 }
2705
2706 i = 0;
2707 all_fixed = true;
2708 do {
2709 if (all_fixed && io_sqe_needs_user(sqes[i].sqe))
2710 all_fixed = false;
2711
2712 i++;
2713 if (i == ARRAY_SIZE(sqes))
2714 break;
2715 } while (io_get_sqring(ctx, &sqes[i]));
2716
2717 /* Unless all new commands are FIXED regions, grab mm */
2718 if (!all_fixed && !cur_mm) {
2719 mm_fault = !mmget_not_zero(ctx->sqo_mm);
2720 if (!mm_fault) {
2721 use_mm(ctx->sqo_mm);
2722 cur_mm = ctx->sqo_mm;
2723 }
2724 }
2725
2726 inflight += io_submit_sqes(ctx, sqes, i, cur_mm != NULL,
2727 mm_fault);
2728
2729 /* Commit SQ ring head once we've consumed all SQEs */
2730 io_commit_sqring(ctx);
2731 }
2732
2733 set_fs(old_fs);
2734 if (cur_mm) {
2735 unuse_mm(cur_mm);
2736 mmput(cur_mm);
2737 }
Jens Axboe06058632019-04-13 09:26:03 -06002738
Roman Penyaev2bbcd6d2019-05-16 10:53:57 +02002739 kthread_parkme();
Jens Axboe06058632019-04-13 09:26:03 -06002740
Jens Axboe6c271ce2019-01-10 11:22:30 -07002741 return 0;
2742}
2743
Jens Axboebc808bc2019-10-22 13:14:37 -06002744static int io_ring_submit(struct io_ring_ctx *ctx, unsigned int to_submit)
Jens Axboe2b188cc2019-01-07 10:46:33 -07002745{
Jens Axboe9a56a232019-01-09 09:06:50 -07002746 struct io_submit_state state, *statep = NULL;
Jens Axboe9e645e112019-05-10 16:07:28 -06002747 struct io_kiocb *link = NULL;
Jackie Liu4fe2c962019-09-09 20:50:40 +08002748 struct io_kiocb *shadow_req = NULL;
Jens Axboe9e645e112019-05-10 16:07:28 -06002749 bool prev_was_link = false;
Jens Axboe5c8b0b52019-04-30 10:16:07 -06002750 int i, submit = 0;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002751
Jens Axboe9a56a232019-01-09 09:06:50 -07002752 if (to_submit > IO_PLUG_THRESHOLD) {
2753 io_submit_state_start(&state, ctx, to_submit);
2754 statep = &state;
2755 }
Jens Axboe2b188cc2019-01-07 10:46:33 -07002756
2757 for (i = 0; i < to_submit; i++) {
2758 struct sqe_submit s;
2759
2760 if (!io_get_sqring(ctx, &s))
2761 break;
2762
Jens Axboe9e645e112019-05-10 16:07:28 -06002763 /*
2764 * If previous wasn't linked and we have a linked command,
2765 * that's the end of the chain. Submit the previous link.
2766 */
2767 if (!prev_was_link && link) {
Jens Axboebc808bc2019-10-22 13:14:37 -06002768 io_queue_link_head(ctx, link, &link->submit, shadow_req);
Jens Axboe9e645e112019-05-10 16:07:28 -06002769 link = NULL;
Jackie Liu5f5ad9c2019-09-18 10:37:53 +08002770 shadow_req = NULL;
Jens Axboe9e645e112019-05-10 16:07:28 -06002771 }
2772 prev_was_link = (s.sqe->flags & IOSQE_IO_LINK) != 0;
2773
Jackie Liu4fe2c962019-09-09 20:50:40 +08002774 if (link && (s.sqe->flags & IOSQE_IO_DRAIN)) {
2775 if (!shadow_req) {
2776 shadow_req = io_get_req(ctx, NULL);
Jackie Liua1041c22019-09-18 17:25:52 +08002777 if (unlikely(!shadow_req))
2778 goto out;
Jackie Liu4fe2c962019-09-09 20:50:40 +08002779 shadow_req->flags |= (REQ_F_IO_DRAIN | REQ_F_SHADOW_DRAIN);
2780 refcount_dec(&shadow_req->refs);
2781 }
2782 shadow_req->sequence = s.sequence;
2783 }
2784
Jackie Liua1041c22019-09-18 17:25:52 +08002785out:
Jens Axboe2b188cc2019-01-07 10:46:33 -07002786 s.has_user = true;
Jens Axboedef596e2019-01-09 08:59:42 -07002787 s.needs_lock = false;
Jens Axboe6c271ce2019-01-10 11:22:30 -07002788 s.needs_fixed_file = false;
Jens Axboe5c8b0b52019-04-30 10:16:07 -06002789 submit++;
Jens Axboebc808bc2019-10-22 13:14:37 -06002790 io_submit_sqe(ctx, &s, statep, &link);
Jens Axboe2b188cc2019-01-07 10:46:33 -07002791 }
2792 io_commit_sqring(ctx);
2793
Jens Axboe9e645e112019-05-10 16:07:28 -06002794 if (link)
Jens Axboebc808bc2019-10-22 13:14:37 -06002795 io_queue_link_head(ctx, link, &link->submit, shadow_req);
Jens Axboe9a56a232019-01-09 09:06:50 -07002796 if (statep)
2797 io_submit_state_end(statep);
Jens Axboe2b188cc2019-01-07 10:46:33 -07002798
Jens Axboe5c8b0b52019-04-30 10:16:07 -06002799 return submit;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002800}
2801
Jens Axboebda52162019-09-24 13:47:15 -06002802struct io_wait_queue {
2803 struct wait_queue_entry wq;
2804 struct io_ring_ctx *ctx;
2805 unsigned to_wait;
2806 unsigned nr_timeouts;
2807};
2808
2809static inline bool io_should_wake(struct io_wait_queue *iowq)
2810{
2811 struct io_ring_ctx *ctx = iowq->ctx;
2812
2813 /*
2814 * Wake up if we have enough events, or if a timeout occured since we
2815 * started waiting. For timeouts, we always want to return to userspace,
2816 * regardless of event count.
2817 */
2818 return io_cqring_events(ctx->rings) >= iowq->to_wait ||
2819 atomic_read(&ctx->cq_timeouts) != iowq->nr_timeouts;
2820}
2821
2822static int io_wake_function(struct wait_queue_entry *curr, unsigned int mode,
2823 int wake_flags, void *key)
2824{
2825 struct io_wait_queue *iowq = container_of(curr, struct io_wait_queue,
2826 wq);
2827
2828 if (!io_should_wake(iowq))
2829 return -1;
2830
2831 return autoremove_wake_function(curr, mode, wake_flags, key);
2832}
2833
Jens Axboe2b188cc2019-01-07 10:46:33 -07002834/*
2835 * Wait until events become available, if we don't already have some. The
2836 * application must reap them itself, as they reside on the shared cq ring.
2837 */
2838static int io_cqring_wait(struct io_ring_ctx *ctx, int min_events,
2839 const sigset_t __user *sig, size_t sigsz)
2840{
Jens Axboebda52162019-09-24 13:47:15 -06002841 struct io_wait_queue iowq = {
2842 .wq = {
2843 .private = current,
2844 .func = io_wake_function,
2845 .entry = LIST_HEAD_INIT(iowq.wq.entry),
2846 },
2847 .ctx = ctx,
2848 .to_wait = min_events,
2849 };
Hristo Venev75b28af2019-08-26 17:23:46 +00002850 struct io_rings *rings = ctx->rings;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002851 int ret;
2852
Hristo Venev75b28af2019-08-26 17:23:46 +00002853 if (io_cqring_events(rings) >= min_events)
Jens Axboe2b188cc2019-01-07 10:46:33 -07002854 return 0;
2855
2856 if (sig) {
Arnd Bergmann9e75ad52019-03-25 15:34:53 +01002857#ifdef CONFIG_COMPAT
2858 if (in_compat_syscall())
2859 ret = set_compat_user_sigmask((const compat_sigset_t __user *)sig,
Oleg Nesterovb7724342019-07-16 16:29:53 -07002860 sigsz);
Arnd Bergmann9e75ad52019-03-25 15:34:53 +01002861 else
2862#endif
Oleg Nesterovb7724342019-07-16 16:29:53 -07002863 ret = set_user_sigmask(sig, sigsz);
Arnd Bergmann9e75ad52019-03-25 15:34:53 +01002864
Jens Axboe2b188cc2019-01-07 10:46:33 -07002865 if (ret)
2866 return ret;
2867 }
2868
Jens Axboebda52162019-09-24 13:47:15 -06002869 ret = 0;
2870 iowq.nr_timeouts = atomic_read(&ctx->cq_timeouts);
2871 do {
2872 prepare_to_wait_exclusive(&ctx->wait, &iowq.wq,
2873 TASK_INTERRUPTIBLE);
2874 if (io_should_wake(&iowq))
2875 break;
2876 schedule();
2877 if (signal_pending(current)) {
2878 ret = -ERESTARTSYS;
2879 break;
2880 }
2881 } while (1);
2882 finish_wait(&ctx->wait, &iowq.wq);
2883
Oleg Nesterovb7724342019-07-16 16:29:53 -07002884 restore_saved_sigmask_unless(ret == -ERESTARTSYS);
Oleg Nesterov97abc882019-06-28 12:06:50 -07002885 if (ret == -ERESTARTSYS)
2886 ret = -EINTR;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002887
Hristo Venev75b28af2019-08-26 17:23:46 +00002888 return READ_ONCE(rings->cq.head) == READ_ONCE(rings->cq.tail) ? ret : 0;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002889}
2890
Jens Axboe6b063142019-01-10 22:13:58 -07002891static void __io_sqe_files_unregister(struct io_ring_ctx *ctx)
2892{
2893#if defined(CONFIG_UNIX)
2894 if (ctx->ring_sock) {
2895 struct sock *sock = ctx->ring_sock->sk;
2896 struct sk_buff *skb;
2897
2898 while ((skb = skb_dequeue(&sock->sk_receive_queue)) != NULL)
2899 kfree_skb(skb);
2900 }
2901#else
2902 int i;
2903
2904 for (i = 0; i < ctx->nr_user_files; i++)
2905 fput(ctx->user_files[i]);
2906#endif
2907}
2908
2909static int io_sqe_files_unregister(struct io_ring_ctx *ctx)
2910{
2911 if (!ctx->user_files)
2912 return -ENXIO;
2913
2914 __io_sqe_files_unregister(ctx);
2915 kfree(ctx->user_files);
2916 ctx->user_files = NULL;
2917 ctx->nr_user_files = 0;
2918 return 0;
2919}
2920
Jens Axboe6c271ce2019-01-10 11:22:30 -07002921static void io_sq_thread_stop(struct io_ring_ctx *ctx)
2922{
2923 if (ctx->sqo_thread) {
Jackie Liua4c0b3d2019-07-08 13:41:12 +08002924 wait_for_completion(&ctx->sqo_thread_started);
Roman Penyaev2bbcd6d2019-05-16 10:53:57 +02002925 /*
2926 * The park is a bit of a work-around, without it we get
2927 * warning spews on shutdown with SQPOLL set and affinity
2928 * set to a single CPU.
2929 */
Jens Axboe06058632019-04-13 09:26:03 -06002930 kthread_park(ctx->sqo_thread);
Jens Axboe6c271ce2019-01-10 11:22:30 -07002931 kthread_stop(ctx->sqo_thread);
2932 ctx->sqo_thread = NULL;
2933 }
2934}
2935
Jens Axboe6b063142019-01-10 22:13:58 -07002936static void io_finish_async(struct io_ring_ctx *ctx)
2937{
Jens Axboe54a91f32019-09-10 09:15:04 -06002938 int i;
2939
Jens Axboe6c271ce2019-01-10 11:22:30 -07002940 io_sq_thread_stop(ctx);
2941
Jens Axboe54a91f32019-09-10 09:15:04 -06002942 for (i = 0; i < ARRAY_SIZE(ctx->sqo_wq); i++) {
2943 if (ctx->sqo_wq[i]) {
2944 destroy_workqueue(ctx->sqo_wq[i]);
2945 ctx->sqo_wq[i] = NULL;
2946 }
Jens Axboe6b063142019-01-10 22:13:58 -07002947 }
2948}
2949
2950#if defined(CONFIG_UNIX)
2951static void io_destruct_skb(struct sk_buff *skb)
2952{
2953 struct io_ring_ctx *ctx = skb->sk->sk_user_data;
Jens Axboe8a997342019-10-09 14:40:13 -06002954 int i;
Jens Axboe6b063142019-01-10 22:13:58 -07002955
Jens Axboe8a997342019-10-09 14:40:13 -06002956 for (i = 0; i < ARRAY_SIZE(ctx->sqo_wq); i++)
2957 if (ctx->sqo_wq[i])
2958 flush_workqueue(ctx->sqo_wq[i]);
2959
Jens Axboe6b063142019-01-10 22:13:58 -07002960 unix_destruct_scm(skb);
2961}
2962
2963/*
2964 * Ensure the UNIX gc is aware of our file set, so we are certain that
2965 * the io_uring can be safely unregistered on process exit, even if we have
2966 * loops in the file referencing.
2967 */
2968static int __io_sqe_files_scm(struct io_ring_ctx *ctx, int nr, int offset)
2969{
2970 struct sock *sk = ctx->ring_sock->sk;
2971 struct scm_fp_list *fpl;
2972 struct sk_buff *skb;
2973 int i;
2974
2975 if (!capable(CAP_SYS_RESOURCE) && !capable(CAP_SYS_ADMIN)) {
2976 unsigned long inflight = ctx->user->unix_inflight + nr;
2977
2978 if (inflight > task_rlimit(current, RLIMIT_NOFILE))
2979 return -EMFILE;
2980 }
2981
2982 fpl = kzalloc(sizeof(*fpl), GFP_KERNEL);
2983 if (!fpl)
2984 return -ENOMEM;
2985
2986 skb = alloc_skb(0, GFP_KERNEL);
2987 if (!skb) {
2988 kfree(fpl);
2989 return -ENOMEM;
2990 }
2991
2992 skb->sk = sk;
2993 skb->destructor = io_destruct_skb;
2994
2995 fpl->user = get_uid(ctx->user);
2996 for (i = 0; i < nr; i++) {
2997 fpl->fp[i] = get_file(ctx->user_files[i + offset]);
2998 unix_inflight(fpl->user, fpl->fp[i]);
2999 }
3000
3001 fpl->max = fpl->count = nr;
3002 UNIXCB(skb).fp = fpl;
3003 refcount_add(skb->truesize, &sk->sk_wmem_alloc);
3004 skb_queue_head(&sk->sk_receive_queue, skb);
3005
3006 for (i = 0; i < nr; i++)
3007 fput(fpl->fp[i]);
3008
3009 return 0;
3010}
3011
3012/*
3013 * If UNIX sockets are enabled, fd passing can cause a reference cycle which
3014 * causes regular reference counting to break down. We rely on the UNIX
3015 * garbage collection to take care of this problem for us.
3016 */
3017static int io_sqe_files_scm(struct io_ring_ctx *ctx)
3018{
3019 unsigned left, total;
3020 int ret = 0;
3021
3022 total = 0;
3023 left = ctx->nr_user_files;
3024 while (left) {
3025 unsigned this_files = min_t(unsigned, left, SCM_MAX_FD);
Jens Axboe6b063142019-01-10 22:13:58 -07003026
3027 ret = __io_sqe_files_scm(ctx, this_files, total);
3028 if (ret)
3029 break;
3030 left -= this_files;
3031 total += this_files;
3032 }
3033
3034 if (!ret)
3035 return 0;
3036
3037 while (total < ctx->nr_user_files) {
3038 fput(ctx->user_files[total]);
3039 total++;
3040 }
3041
3042 return ret;
3043}
3044#else
3045static int io_sqe_files_scm(struct io_ring_ctx *ctx)
3046{
3047 return 0;
3048}
3049#endif
3050
3051static int io_sqe_files_register(struct io_ring_ctx *ctx, void __user *arg,
3052 unsigned nr_args)
3053{
3054 __s32 __user *fds = (__s32 __user *) arg;
3055 int fd, ret = 0;
3056 unsigned i;
3057
3058 if (ctx->user_files)
3059 return -EBUSY;
3060 if (!nr_args)
3061 return -EINVAL;
3062 if (nr_args > IORING_MAX_FIXED_FILES)
3063 return -EMFILE;
3064
3065 ctx->user_files = kcalloc(nr_args, sizeof(struct file *), GFP_KERNEL);
3066 if (!ctx->user_files)
3067 return -ENOMEM;
3068
3069 for (i = 0; i < nr_args; i++) {
3070 ret = -EFAULT;
3071 if (copy_from_user(&fd, &fds[i], sizeof(fd)))
3072 break;
3073
3074 ctx->user_files[i] = fget(fd);
3075
3076 ret = -EBADF;
3077 if (!ctx->user_files[i])
3078 break;
3079 /*
3080 * Don't allow io_uring instances to be registered. If UNIX
3081 * isn't enabled, then this causes a reference cycle and this
3082 * instance can never get freed. If UNIX is enabled we'll
3083 * handle it just fine, but there's still no point in allowing
3084 * a ring fd as it doesn't support regular read/write anyway.
3085 */
3086 if (ctx->user_files[i]->f_op == &io_uring_fops) {
3087 fput(ctx->user_files[i]);
3088 break;
3089 }
3090 ctx->nr_user_files++;
3091 ret = 0;
3092 }
3093
3094 if (ret) {
3095 for (i = 0; i < ctx->nr_user_files; i++)
3096 fput(ctx->user_files[i]);
3097
3098 kfree(ctx->user_files);
Jens Axboe25adf502019-04-03 09:52:40 -06003099 ctx->user_files = NULL;
Jens Axboe6b063142019-01-10 22:13:58 -07003100 ctx->nr_user_files = 0;
3101 return ret;
3102 }
3103
3104 ret = io_sqe_files_scm(ctx);
3105 if (ret)
3106 io_sqe_files_unregister(ctx);
3107
3108 return ret;
3109}
3110
Jens Axboe6c271ce2019-01-10 11:22:30 -07003111static int io_sq_offload_start(struct io_ring_ctx *ctx,
3112 struct io_uring_params *p)
Jens Axboe2b188cc2019-01-07 10:46:33 -07003113{
3114 int ret;
3115
Jens Axboe6c271ce2019-01-10 11:22:30 -07003116 init_waitqueue_head(&ctx->sqo_wait);
Jens Axboe2b188cc2019-01-07 10:46:33 -07003117 mmgrab(current->mm);
3118 ctx->sqo_mm = current->mm;
3119
Jens Axboe6c271ce2019-01-10 11:22:30 -07003120 if (ctx->flags & IORING_SETUP_SQPOLL) {
Jens Axboe3ec482d2019-04-08 10:51:01 -06003121 ret = -EPERM;
3122 if (!capable(CAP_SYS_ADMIN))
3123 goto err;
3124
Jens Axboe917257d2019-04-13 09:28:55 -06003125 ctx->sq_thread_idle = msecs_to_jiffies(p->sq_thread_idle);
3126 if (!ctx->sq_thread_idle)
3127 ctx->sq_thread_idle = HZ;
3128
Jens Axboe6c271ce2019-01-10 11:22:30 -07003129 if (p->flags & IORING_SETUP_SQ_AFF) {
Jens Axboe44a9bd12019-05-14 20:00:30 -06003130 int cpu = p->sq_thread_cpu;
Jens Axboe6c271ce2019-01-10 11:22:30 -07003131
Jens Axboe917257d2019-04-13 09:28:55 -06003132 ret = -EINVAL;
Jens Axboe44a9bd12019-05-14 20:00:30 -06003133 if (cpu >= nr_cpu_ids)
3134 goto err;
Shenghui Wang7889f442019-05-07 16:03:19 +08003135 if (!cpu_online(cpu))
Jens Axboe917257d2019-04-13 09:28:55 -06003136 goto err;
3137
Jens Axboe6c271ce2019-01-10 11:22:30 -07003138 ctx->sqo_thread = kthread_create_on_cpu(io_sq_thread,
3139 ctx, cpu,
3140 "io_uring-sq");
3141 } else {
3142 ctx->sqo_thread = kthread_create(io_sq_thread, ctx,
3143 "io_uring-sq");
3144 }
3145 if (IS_ERR(ctx->sqo_thread)) {
3146 ret = PTR_ERR(ctx->sqo_thread);
3147 ctx->sqo_thread = NULL;
3148 goto err;
3149 }
3150 wake_up_process(ctx->sqo_thread);
3151 } else if (p->flags & IORING_SETUP_SQ_AFF) {
3152 /* Can't have SQ_AFF without SQPOLL */
3153 ret = -EINVAL;
3154 goto err;
3155 }
3156
Jens Axboe2b188cc2019-01-07 10:46:33 -07003157 /* Do QD, or 2 * CPUS, whatever is smallest */
Jens Axboe54a91f32019-09-10 09:15:04 -06003158 ctx->sqo_wq[0] = alloc_workqueue("io_ring-wq",
3159 WQ_UNBOUND | WQ_FREEZABLE,
Jens Axboe2b188cc2019-01-07 10:46:33 -07003160 min(ctx->sq_entries - 1, 2 * num_online_cpus()));
Jens Axboe54a91f32019-09-10 09:15:04 -06003161 if (!ctx->sqo_wq[0]) {
3162 ret = -ENOMEM;
3163 goto err;
3164 }
3165
3166 /*
3167 * This is for buffered writes, where we want to limit the parallelism
3168 * due to file locking in file systems. As "normal" buffered writes
3169 * should parellelize on writeout quite nicely, limit us to having 2
3170 * pending. This avoids massive contention on the inode when doing
3171 * buffered async writes.
3172 */
3173 ctx->sqo_wq[1] = alloc_workqueue("io_ring-write-wq",
3174 WQ_UNBOUND | WQ_FREEZABLE, 2);
3175 if (!ctx->sqo_wq[1]) {
Jens Axboe2b188cc2019-01-07 10:46:33 -07003176 ret = -ENOMEM;
3177 goto err;
3178 }
3179
3180 return 0;
3181err:
Jens Axboe54a91f32019-09-10 09:15:04 -06003182 io_finish_async(ctx);
Jens Axboe2b188cc2019-01-07 10:46:33 -07003183 mmdrop(ctx->sqo_mm);
3184 ctx->sqo_mm = NULL;
3185 return ret;
3186}
3187
3188static void io_unaccount_mem(struct user_struct *user, unsigned long nr_pages)
3189{
3190 atomic_long_sub(nr_pages, &user->locked_vm);
3191}
3192
3193static int io_account_mem(struct user_struct *user, unsigned long nr_pages)
3194{
3195 unsigned long page_limit, cur_pages, new_pages;
3196
3197 /* Don't allow more pages than we can safely lock */
3198 page_limit = rlimit(RLIMIT_MEMLOCK) >> PAGE_SHIFT;
3199
3200 do {
3201 cur_pages = atomic_long_read(&user->locked_vm);
3202 new_pages = cur_pages + nr_pages;
3203 if (new_pages > page_limit)
3204 return -ENOMEM;
3205 } while (atomic_long_cmpxchg(&user->locked_vm, cur_pages,
3206 new_pages) != cur_pages);
3207
3208 return 0;
3209}
3210
3211static void io_mem_free(void *ptr)
3212{
Mark Rutland52e04ef2019-04-30 17:30:21 +01003213 struct page *page;
Jens Axboe2b188cc2019-01-07 10:46:33 -07003214
Mark Rutland52e04ef2019-04-30 17:30:21 +01003215 if (!ptr)
3216 return;
3217
3218 page = virt_to_head_page(ptr);
Jens Axboe2b188cc2019-01-07 10:46:33 -07003219 if (put_page_testzero(page))
3220 free_compound_page(page);
3221}
3222
3223static void *io_mem_alloc(size_t size)
3224{
3225 gfp_t gfp_flags = GFP_KERNEL | __GFP_ZERO | __GFP_NOWARN | __GFP_COMP |
3226 __GFP_NORETRY;
3227
3228 return (void *) __get_free_pages(gfp_flags, get_order(size));
3229}
3230
Hristo Venev75b28af2019-08-26 17:23:46 +00003231static unsigned long rings_size(unsigned sq_entries, unsigned cq_entries,
3232 size_t *sq_offset)
3233{
3234 struct io_rings *rings;
3235 size_t off, sq_array_size;
3236
3237 off = struct_size(rings, cqes, cq_entries);
3238 if (off == SIZE_MAX)
3239 return SIZE_MAX;
3240
3241#ifdef CONFIG_SMP
3242 off = ALIGN(off, SMP_CACHE_BYTES);
3243 if (off == 0)
3244 return SIZE_MAX;
3245#endif
3246
3247 sq_array_size = array_size(sizeof(u32), sq_entries);
3248 if (sq_array_size == SIZE_MAX)
3249 return SIZE_MAX;
3250
3251 if (check_add_overflow(off, sq_array_size, &off))
3252 return SIZE_MAX;
3253
3254 if (sq_offset)
3255 *sq_offset = off;
3256
3257 return off;
3258}
3259
Jens Axboe2b188cc2019-01-07 10:46:33 -07003260static unsigned long ring_pages(unsigned sq_entries, unsigned cq_entries)
3261{
Hristo Venev75b28af2019-08-26 17:23:46 +00003262 size_t pages;
Jens Axboe2b188cc2019-01-07 10:46:33 -07003263
Hristo Venev75b28af2019-08-26 17:23:46 +00003264 pages = (size_t)1 << get_order(
3265 rings_size(sq_entries, cq_entries, NULL));
3266 pages += (size_t)1 << get_order(
3267 array_size(sizeof(struct io_uring_sqe), sq_entries));
Jens Axboe2b188cc2019-01-07 10:46:33 -07003268
Hristo Venev75b28af2019-08-26 17:23:46 +00003269 return pages;
Jens Axboe2b188cc2019-01-07 10:46:33 -07003270}
3271
Jens Axboeedafcce2019-01-09 09:16:05 -07003272static int io_sqe_buffer_unregister(struct io_ring_ctx *ctx)
3273{
3274 int i, j;
3275
3276 if (!ctx->user_bufs)
3277 return -ENXIO;
3278
3279 for (i = 0; i < ctx->nr_user_bufs; i++) {
3280 struct io_mapped_ubuf *imu = &ctx->user_bufs[i];
3281
3282 for (j = 0; j < imu->nr_bvecs; j++)
John Hubbard27c4d3a2019-08-04 19:32:06 -07003283 put_user_page(imu->bvec[j].bv_page);
Jens Axboeedafcce2019-01-09 09:16:05 -07003284
3285 if (ctx->account_mem)
3286 io_unaccount_mem(ctx->user, imu->nr_bvecs);
Mark Rutlandd4ef6472019-05-01 16:59:16 +01003287 kvfree(imu->bvec);
Jens Axboeedafcce2019-01-09 09:16:05 -07003288 imu->nr_bvecs = 0;
3289 }
3290
3291 kfree(ctx->user_bufs);
3292 ctx->user_bufs = NULL;
3293 ctx->nr_user_bufs = 0;
3294 return 0;
3295}
3296
3297static int io_copy_iov(struct io_ring_ctx *ctx, struct iovec *dst,
3298 void __user *arg, unsigned index)
3299{
3300 struct iovec __user *src;
3301
3302#ifdef CONFIG_COMPAT
3303 if (ctx->compat) {
3304 struct compat_iovec __user *ciovs;
3305 struct compat_iovec ciov;
3306
3307 ciovs = (struct compat_iovec __user *) arg;
3308 if (copy_from_user(&ciov, &ciovs[index], sizeof(ciov)))
3309 return -EFAULT;
3310
3311 dst->iov_base = (void __user *) (unsigned long) ciov.iov_base;
3312 dst->iov_len = ciov.iov_len;
3313 return 0;
3314 }
3315#endif
3316 src = (struct iovec __user *) arg;
3317 if (copy_from_user(dst, &src[index], sizeof(*dst)))
3318 return -EFAULT;
3319 return 0;
3320}
3321
3322static int io_sqe_buffer_register(struct io_ring_ctx *ctx, void __user *arg,
3323 unsigned nr_args)
3324{
3325 struct vm_area_struct **vmas = NULL;
3326 struct page **pages = NULL;
3327 int i, j, got_pages = 0;
3328 int ret = -EINVAL;
3329
3330 if (ctx->user_bufs)
3331 return -EBUSY;
3332 if (!nr_args || nr_args > UIO_MAXIOV)
3333 return -EINVAL;
3334
3335 ctx->user_bufs = kcalloc(nr_args, sizeof(struct io_mapped_ubuf),
3336 GFP_KERNEL);
3337 if (!ctx->user_bufs)
3338 return -ENOMEM;
3339
3340 for (i = 0; i < nr_args; i++) {
3341 struct io_mapped_ubuf *imu = &ctx->user_bufs[i];
3342 unsigned long off, start, end, ubuf;
3343 int pret, nr_pages;
3344 struct iovec iov;
3345 size_t size;
3346
3347 ret = io_copy_iov(ctx, &iov, arg, i);
3348 if (ret)
Pavel Begunkova2786822019-05-26 12:35:47 +03003349 goto err;
Jens Axboeedafcce2019-01-09 09:16:05 -07003350
3351 /*
3352 * Don't impose further limits on the size and buffer
3353 * constraints here, we'll -EINVAL later when IO is
3354 * submitted if they are wrong.
3355 */
3356 ret = -EFAULT;
3357 if (!iov.iov_base || !iov.iov_len)
3358 goto err;
3359
3360 /* arbitrary limit, but we need something */
3361 if (iov.iov_len > SZ_1G)
3362 goto err;
3363
3364 ubuf = (unsigned long) iov.iov_base;
3365 end = (ubuf + iov.iov_len + PAGE_SIZE - 1) >> PAGE_SHIFT;
3366 start = ubuf >> PAGE_SHIFT;
3367 nr_pages = end - start;
3368
3369 if (ctx->account_mem) {
3370 ret = io_account_mem(ctx->user, nr_pages);
3371 if (ret)
3372 goto err;
3373 }
3374
3375 ret = 0;
3376 if (!pages || nr_pages > got_pages) {
3377 kfree(vmas);
3378 kfree(pages);
Mark Rutlandd4ef6472019-05-01 16:59:16 +01003379 pages = kvmalloc_array(nr_pages, sizeof(struct page *),
Jens Axboeedafcce2019-01-09 09:16:05 -07003380 GFP_KERNEL);
Mark Rutlandd4ef6472019-05-01 16:59:16 +01003381 vmas = kvmalloc_array(nr_pages,
Jens Axboeedafcce2019-01-09 09:16:05 -07003382 sizeof(struct vm_area_struct *),
3383 GFP_KERNEL);
3384 if (!pages || !vmas) {
3385 ret = -ENOMEM;
3386 if (ctx->account_mem)
3387 io_unaccount_mem(ctx->user, nr_pages);
3388 goto err;
3389 }
3390 got_pages = nr_pages;
3391 }
3392
Mark Rutlandd4ef6472019-05-01 16:59:16 +01003393 imu->bvec = kvmalloc_array(nr_pages, sizeof(struct bio_vec),
Jens Axboeedafcce2019-01-09 09:16:05 -07003394 GFP_KERNEL);
3395 ret = -ENOMEM;
3396 if (!imu->bvec) {
3397 if (ctx->account_mem)
3398 io_unaccount_mem(ctx->user, nr_pages);
3399 goto err;
3400 }
3401
3402 ret = 0;
3403 down_read(&current->mm->mmap_sem);
Ira Weiny932f4a62019-05-13 17:17:03 -07003404 pret = get_user_pages(ubuf, nr_pages,
3405 FOLL_WRITE | FOLL_LONGTERM,
3406 pages, vmas);
Jens Axboeedafcce2019-01-09 09:16:05 -07003407 if (pret == nr_pages) {
3408 /* don't support file backed memory */
3409 for (j = 0; j < nr_pages; j++) {
3410 struct vm_area_struct *vma = vmas[j];
3411
3412 if (vma->vm_file &&
3413 !is_file_hugepages(vma->vm_file)) {
3414 ret = -EOPNOTSUPP;
3415 break;
3416 }
3417 }
3418 } else {
3419 ret = pret < 0 ? pret : -EFAULT;
3420 }
3421 up_read(&current->mm->mmap_sem);
3422 if (ret) {
3423 /*
3424 * if we did partial map, or found file backed vmas,
3425 * release any pages we did get
3426 */
John Hubbard27c4d3a2019-08-04 19:32:06 -07003427 if (pret > 0)
3428 put_user_pages(pages, pret);
Jens Axboeedafcce2019-01-09 09:16:05 -07003429 if (ctx->account_mem)
3430 io_unaccount_mem(ctx->user, nr_pages);
Mark Rutlandd4ef6472019-05-01 16:59:16 +01003431 kvfree(imu->bvec);
Jens Axboeedafcce2019-01-09 09:16:05 -07003432 goto err;
3433 }
3434
3435 off = ubuf & ~PAGE_MASK;
3436 size = iov.iov_len;
3437 for (j = 0; j < nr_pages; j++) {
3438 size_t vec_len;
3439
3440 vec_len = min_t(size_t, size, PAGE_SIZE - off);
3441 imu->bvec[j].bv_page = pages[j];
3442 imu->bvec[j].bv_len = vec_len;
3443 imu->bvec[j].bv_offset = off;
3444 off = 0;
3445 size -= vec_len;
3446 }
3447 /* store original address for later verification */
3448 imu->ubuf = ubuf;
3449 imu->len = iov.iov_len;
3450 imu->nr_bvecs = nr_pages;
3451
3452 ctx->nr_user_bufs++;
3453 }
Mark Rutlandd4ef6472019-05-01 16:59:16 +01003454 kvfree(pages);
3455 kvfree(vmas);
Jens Axboeedafcce2019-01-09 09:16:05 -07003456 return 0;
3457err:
Mark Rutlandd4ef6472019-05-01 16:59:16 +01003458 kvfree(pages);
3459 kvfree(vmas);
Jens Axboeedafcce2019-01-09 09:16:05 -07003460 io_sqe_buffer_unregister(ctx);
3461 return ret;
3462}
3463
Jens Axboe9b402842019-04-11 11:45:41 -06003464static int io_eventfd_register(struct io_ring_ctx *ctx, void __user *arg)
3465{
3466 __s32 __user *fds = arg;
3467 int fd;
3468
3469 if (ctx->cq_ev_fd)
3470 return -EBUSY;
3471
3472 if (copy_from_user(&fd, fds, sizeof(*fds)))
3473 return -EFAULT;
3474
3475 ctx->cq_ev_fd = eventfd_ctx_fdget(fd);
3476 if (IS_ERR(ctx->cq_ev_fd)) {
3477 int ret = PTR_ERR(ctx->cq_ev_fd);
3478 ctx->cq_ev_fd = NULL;
3479 return ret;
3480 }
3481
3482 return 0;
3483}
3484
3485static int io_eventfd_unregister(struct io_ring_ctx *ctx)
3486{
3487 if (ctx->cq_ev_fd) {
3488 eventfd_ctx_put(ctx->cq_ev_fd);
3489 ctx->cq_ev_fd = NULL;
3490 return 0;
3491 }
3492
3493 return -ENXIO;
3494}
3495
Jens Axboe2b188cc2019-01-07 10:46:33 -07003496static void io_ring_ctx_free(struct io_ring_ctx *ctx)
3497{
Jens Axboe6b063142019-01-10 22:13:58 -07003498 io_finish_async(ctx);
Jens Axboe2b188cc2019-01-07 10:46:33 -07003499 if (ctx->sqo_mm)
3500 mmdrop(ctx->sqo_mm);
Jens Axboedef596e2019-01-09 08:59:42 -07003501
3502 io_iopoll_reap_events(ctx);
Jens Axboeedafcce2019-01-09 09:16:05 -07003503 io_sqe_buffer_unregister(ctx);
Jens Axboe6b063142019-01-10 22:13:58 -07003504 io_sqe_files_unregister(ctx);
Jens Axboe9b402842019-04-11 11:45:41 -06003505 io_eventfd_unregister(ctx);
Jens Axboedef596e2019-01-09 08:59:42 -07003506
Jens Axboe2b188cc2019-01-07 10:46:33 -07003507#if defined(CONFIG_UNIX)
Eric Biggers355e8d22019-06-12 14:58:43 -07003508 if (ctx->ring_sock) {
3509 ctx->ring_sock->file = NULL; /* so that iput() is called */
Jens Axboe2b188cc2019-01-07 10:46:33 -07003510 sock_release(ctx->ring_sock);
Eric Biggers355e8d22019-06-12 14:58:43 -07003511 }
Jens Axboe2b188cc2019-01-07 10:46:33 -07003512#endif
3513
Hristo Venev75b28af2019-08-26 17:23:46 +00003514 io_mem_free(ctx->rings);
Jens Axboe2b188cc2019-01-07 10:46:33 -07003515 io_mem_free(ctx->sq_sqes);
Jens Axboe2b188cc2019-01-07 10:46:33 -07003516
3517 percpu_ref_exit(&ctx->refs);
3518 if (ctx->account_mem)
3519 io_unaccount_mem(ctx->user,
3520 ring_pages(ctx->sq_entries, ctx->cq_entries));
3521 free_uid(ctx->user);
3522 kfree(ctx);
3523}
3524
3525static __poll_t io_uring_poll(struct file *file, poll_table *wait)
3526{
3527 struct io_ring_ctx *ctx = file->private_data;
3528 __poll_t mask = 0;
3529
3530 poll_wait(file, &ctx->cq_wait, wait);
Stefan Bühler4f7067c2019-04-24 23:54:17 +02003531 /*
3532 * synchronizes with barrier from wq_has_sleeper call in
3533 * io_commit_cqring
3534 */
Jens Axboe2b188cc2019-01-07 10:46:33 -07003535 smp_rmb();
Hristo Venev75b28af2019-08-26 17:23:46 +00003536 if (READ_ONCE(ctx->rings->sq.tail) - ctx->cached_sq_head !=
3537 ctx->rings->sq_ring_entries)
Jens Axboe2b188cc2019-01-07 10:46:33 -07003538 mask |= EPOLLOUT | EPOLLWRNORM;
yangerkundaa5de52019-09-24 20:53:34 +08003539 if (READ_ONCE(ctx->rings->cq.head) != ctx->cached_cq_tail)
Jens Axboe2b188cc2019-01-07 10:46:33 -07003540 mask |= EPOLLIN | EPOLLRDNORM;
3541
3542 return mask;
3543}
3544
3545static int io_uring_fasync(int fd, struct file *file, int on)
3546{
3547 struct io_ring_ctx *ctx = file->private_data;
3548
3549 return fasync_helper(fd, file, on, &ctx->cq_fasync);
3550}
3551
3552static void io_ring_ctx_wait_and_kill(struct io_ring_ctx *ctx)
3553{
3554 mutex_lock(&ctx->uring_lock);
3555 percpu_ref_kill(&ctx->refs);
3556 mutex_unlock(&ctx->uring_lock);
3557
Jens Axboe5262f562019-09-17 12:26:57 -06003558 io_kill_timeouts(ctx);
Jens Axboe221c5eb2019-01-17 09:41:58 -07003559 io_poll_remove_all(ctx);
Jens Axboedef596e2019-01-09 08:59:42 -07003560 io_iopoll_reap_events(ctx);
Jens Axboe2b188cc2019-01-07 10:46:33 -07003561 wait_for_completion(&ctx->ctx_done);
3562 io_ring_ctx_free(ctx);
3563}
3564
3565static int io_uring_release(struct inode *inode, struct file *file)
3566{
3567 struct io_ring_ctx *ctx = file->private_data;
3568
3569 file->private_data = NULL;
3570 io_ring_ctx_wait_and_kill(ctx);
3571 return 0;
3572}
3573
3574static int io_uring_mmap(struct file *file, struct vm_area_struct *vma)
3575{
3576 loff_t offset = (loff_t) vma->vm_pgoff << PAGE_SHIFT;
3577 unsigned long sz = vma->vm_end - vma->vm_start;
3578 struct io_ring_ctx *ctx = file->private_data;
3579 unsigned long pfn;
3580 struct page *page;
3581 void *ptr;
3582
3583 switch (offset) {
3584 case IORING_OFF_SQ_RING:
Hristo Venev75b28af2019-08-26 17:23:46 +00003585 case IORING_OFF_CQ_RING:
3586 ptr = ctx->rings;
Jens Axboe2b188cc2019-01-07 10:46:33 -07003587 break;
3588 case IORING_OFF_SQES:
3589 ptr = ctx->sq_sqes;
3590 break;
Jens Axboe2b188cc2019-01-07 10:46:33 -07003591 default:
3592 return -EINVAL;
3593 }
3594
3595 page = virt_to_head_page(ptr);
Matthew Wilcox (Oracle)a50b8542019-09-23 15:34:25 -07003596 if (sz > page_size(page))
Jens Axboe2b188cc2019-01-07 10:46:33 -07003597 return -EINVAL;
3598
3599 pfn = virt_to_phys(ptr) >> PAGE_SHIFT;
3600 return remap_pfn_range(vma, vma->vm_start, pfn, sz, vma->vm_page_prot);
3601}
3602
3603SYSCALL_DEFINE6(io_uring_enter, unsigned int, fd, u32, to_submit,
3604 u32, min_complete, u32, flags, const sigset_t __user *, sig,
3605 size_t, sigsz)
3606{
3607 struct io_ring_ctx *ctx;
3608 long ret = -EBADF;
3609 int submitted = 0;
3610 struct fd f;
3611
Jens Axboe6c271ce2019-01-10 11:22:30 -07003612 if (flags & ~(IORING_ENTER_GETEVENTS | IORING_ENTER_SQ_WAKEUP))
Jens Axboe2b188cc2019-01-07 10:46:33 -07003613 return -EINVAL;
3614
3615 f = fdget(fd);
3616 if (!f.file)
3617 return -EBADF;
3618
3619 ret = -EOPNOTSUPP;
3620 if (f.file->f_op != &io_uring_fops)
3621 goto out_fput;
3622
3623 ret = -ENXIO;
3624 ctx = f.file->private_data;
3625 if (!percpu_ref_tryget(&ctx->refs))
3626 goto out_fput;
3627
Jens Axboe6c271ce2019-01-10 11:22:30 -07003628 /*
3629 * For SQ polling, the thread will do all submissions and completions.
3630 * Just return the requested submit count, and wake the thread if
3631 * we were asked to.
3632 */
Jens Axboeb2a9ead2019-09-12 14:19:16 -06003633 ret = 0;
Jens Axboe6c271ce2019-01-10 11:22:30 -07003634 if (ctx->flags & IORING_SETUP_SQPOLL) {
3635 if (flags & IORING_ENTER_SQ_WAKEUP)
3636 wake_up(&ctx->sqo_wait);
3637 submitted = to_submit;
Jens Axboeb2a9ead2019-09-12 14:19:16 -06003638 } else if (to_submit) {
Jens Axboe2b188cc2019-01-07 10:46:33 -07003639 to_submit = min(to_submit, ctx->sq_entries);
3640
3641 mutex_lock(&ctx->uring_lock);
Jens Axboebc808bc2019-10-22 13:14:37 -06003642 submitted = io_ring_submit(ctx, to_submit);
Jens Axboe2b188cc2019-01-07 10:46:33 -07003643 mutex_unlock(&ctx->uring_lock);
Jens Axboe2b188cc2019-01-07 10:46:33 -07003644 }
3645 if (flags & IORING_ENTER_GETEVENTS) {
Jens Axboedef596e2019-01-09 08:59:42 -07003646 unsigned nr_events = 0;
3647
Jens Axboe2b188cc2019-01-07 10:46:33 -07003648 min_complete = min(min_complete, ctx->cq_entries);
3649
Jens Axboedef596e2019-01-09 08:59:42 -07003650 if (ctx->flags & IORING_SETUP_IOPOLL) {
Jens Axboedef596e2019-01-09 08:59:42 -07003651 ret = io_iopoll_check(ctx, &nr_events, min_complete);
Jens Axboedef596e2019-01-09 08:59:42 -07003652 } else {
3653 ret = io_cqring_wait(ctx, min_complete, sig, sigsz);
3654 }
Jens Axboe2b188cc2019-01-07 10:46:33 -07003655 }
3656
Pavel Begunkov6805b322019-10-08 02:18:42 +03003657 percpu_ref_put(&ctx->refs);
Jens Axboe2b188cc2019-01-07 10:46:33 -07003658out_fput:
3659 fdput(f);
3660 return submitted ? submitted : ret;
3661}
3662
3663static const struct file_operations io_uring_fops = {
3664 .release = io_uring_release,
3665 .mmap = io_uring_mmap,
3666 .poll = io_uring_poll,
3667 .fasync = io_uring_fasync,
3668};
3669
3670static int io_allocate_scq_urings(struct io_ring_ctx *ctx,
3671 struct io_uring_params *p)
3672{
Hristo Venev75b28af2019-08-26 17:23:46 +00003673 struct io_rings *rings;
3674 size_t size, sq_array_offset;
Jens Axboe2b188cc2019-01-07 10:46:33 -07003675
Hristo Venev75b28af2019-08-26 17:23:46 +00003676 size = rings_size(p->sq_entries, p->cq_entries, &sq_array_offset);
3677 if (size == SIZE_MAX)
3678 return -EOVERFLOW;
3679
3680 rings = io_mem_alloc(size);
3681 if (!rings)
Jens Axboe2b188cc2019-01-07 10:46:33 -07003682 return -ENOMEM;
3683
Hristo Venev75b28af2019-08-26 17:23:46 +00003684 ctx->rings = rings;
3685 ctx->sq_array = (u32 *)((char *)rings + sq_array_offset);
3686 rings->sq_ring_mask = p->sq_entries - 1;
3687 rings->cq_ring_mask = p->cq_entries - 1;
3688 rings->sq_ring_entries = p->sq_entries;
3689 rings->cq_ring_entries = p->cq_entries;
3690 ctx->sq_mask = rings->sq_ring_mask;
3691 ctx->cq_mask = rings->cq_ring_mask;
3692 ctx->sq_entries = rings->sq_ring_entries;
3693 ctx->cq_entries = rings->cq_ring_entries;
Jens Axboe2b188cc2019-01-07 10:46:33 -07003694
3695 size = array_size(sizeof(struct io_uring_sqe), p->sq_entries);
3696 if (size == SIZE_MAX)
3697 return -EOVERFLOW;
3698
3699 ctx->sq_sqes = io_mem_alloc(size);
Mark Rutland52e04ef2019-04-30 17:30:21 +01003700 if (!ctx->sq_sqes)
Jens Axboe2b188cc2019-01-07 10:46:33 -07003701 return -ENOMEM;
Jens Axboe2b188cc2019-01-07 10:46:33 -07003702
Jens Axboe2b188cc2019-01-07 10:46:33 -07003703 return 0;
3704}
3705
3706/*
3707 * Allocate an anonymous fd, this is what constitutes the application
3708 * visible backing of an io_uring instance. The application mmaps this
3709 * fd to gain access to the SQ/CQ ring details. If UNIX sockets are enabled,
3710 * we have to tie this fd to a socket for file garbage collection purposes.
3711 */
3712static int io_uring_get_fd(struct io_ring_ctx *ctx)
3713{
3714 struct file *file;
3715 int ret;
3716
3717#if defined(CONFIG_UNIX)
3718 ret = sock_create_kern(&init_net, PF_UNIX, SOCK_RAW, IPPROTO_IP,
3719 &ctx->ring_sock);
3720 if (ret)
3721 return ret;
3722#endif
3723
3724 ret = get_unused_fd_flags(O_RDWR | O_CLOEXEC);
3725 if (ret < 0)
3726 goto err;
3727
3728 file = anon_inode_getfile("[io_uring]", &io_uring_fops, ctx,
3729 O_RDWR | O_CLOEXEC);
3730 if (IS_ERR(file)) {
3731 put_unused_fd(ret);
3732 ret = PTR_ERR(file);
3733 goto err;
3734 }
3735
3736#if defined(CONFIG_UNIX)
3737 ctx->ring_sock->file = file;
Jens Axboe6b063142019-01-10 22:13:58 -07003738 ctx->ring_sock->sk->sk_user_data = ctx;
Jens Axboe2b188cc2019-01-07 10:46:33 -07003739#endif
3740 fd_install(ret, file);
3741 return ret;
3742err:
3743#if defined(CONFIG_UNIX)
3744 sock_release(ctx->ring_sock);
3745 ctx->ring_sock = NULL;
3746#endif
3747 return ret;
3748}
3749
3750static int io_uring_create(unsigned entries, struct io_uring_params *p)
3751{
3752 struct user_struct *user = NULL;
3753 struct io_ring_ctx *ctx;
3754 bool account_mem;
3755 int ret;
3756
3757 if (!entries || entries > IORING_MAX_ENTRIES)
3758 return -EINVAL;
3759
3760 /*
3761 * Use twice as many entries for the CQ ring. It's possible for the
3762 * application to drive a higher depth than the size of the SQ ring,
3763 * since the sqes are only used at submission time. This allows for
3764 * some flexibility in overcommitting a bit.
3765 */
3766 p->sq_entries = roundup_pow_of_two(entries);
3767 p->cq_entries = 2 * p->sq_entries;
3768
3769 user = get_uid(current_user());
3770 account_mem = !capable(CAP_IPC_LOCK);
3771
3772 if (account_mem) {
3773 ret = io_account_mem(user,
3774 ring_pages(p->sq_entries, p->cq_entries));
3775 if (ret) {
3776 free_uid(user);
3777 return ret;
3778 }
3779 }
3780
3781 ctx = io_ring_ctx_alloc(p);
3782 if (!ctx) {
3783 if (account_mem)
3784 io_unaccount_mem(user, ring_pages(p->sq_entries,
3785 p->cq_entries));
3786 free_uid(user);
3787 return -ENOMEM;
3788 }
3789 ctx->compat = in_compat_syscall();
3790 ctx->account_mem = account_mem;
3791 ctx->user = user;
3792
3793 ret = io_allocate_scq_urings(ctx, p);
3794 if (ret)
3795 goto err;
3796
Jens Axboe6c271ce2019-01-10 11:22:30 -07003797 ret = io_sq_offload_start(ctx, p);
Jens Axboe2b188cc2019-01-07 10:46:33 -07003798 if (ret)
3799 goto err;
3800
3801 ret = io_uring_get_fd(ctx);
3802 if (ret < 0)
3803 goto err;
3804
3805 memset(&p->sq_off, 0, sizeof(p->sq_off));
Hristo Venev75b28af2019-08-26 17:23:46 +00003806 p->sq_off.head = offsetof(struct io_rings, sq.head);
3807 p->sq_off.tail = offsetof(struct io_rings, sq.tail);
3808 p->sq_off.ring_mask = offsetof(struct io_rings, sq_ring_mask);
3809 p->sq_off.ring_entries = offsetof(struct io_rings, sq_ring_entries);
3810 p->sq_off.flags = offsetof(struct io_rings, sq_flags);
3811 p->sq_off.dropped = offsetof(struct io_rings, sq_dropped);
3812 p->sq_off.array = (char *)ctx->sq_array - (char *)ctx->rings;
Jens Axboe2b188cc2019-01-07 10:46:33 -07003813
3814 memset(&p->cq_off, 0, sizeof(p->cq_off));
Hristo Venev75b28af2019-08-26 17:23:46 +00003815 p->cq_off.head = offsetof(struct io_rings, cq.head);
3816 p->cq_off.tail = offsetof(struct io_rings, cq.tail);
3817 p->cq_off.ring_mask = offsetof(struct io_rings, cq_ring_mask);
3818 p->cq_off.ring_entries = offsetof(struct io_rings, cq_ring_entries);
3819 p->cq_off.overflow = offsetof(struct io_rings, cq_overflow);
3820 p->cq_off.cqes = offsetof(struct io_rings, cqes);
Jens Axboeac90f242019-09-06 10:26:21 -06003821
3822 p->features = IORING_FEAT_SINGLE_MMAP;
Jens Axboe2b188cc2019-01-07 10:46:33 -07003823 return ret;
3824err:
3825 io_ring_ctx_wait_and_kill(ctx);
3826 return ret;
3827}
3828
3829/*
3830 * Sets up an aio uring context, and returns the fd. Applications asks for a
3831 * ring size, we return the actual sq/cq ring sizes (among other things) in the
3832 * params structure passed in.
3833 */
3834static long io_uring_setup(u32 entries, struct io_uring_params __user *params)
3835{
3836 struct io_uring_params p;
3837 long ret;
3838 int i;
3839
3840 if (copy_from_user(&p, params, sizeof(p)))
3841 return -EFAULT;
3842 for (i = 0; i < ARRAY_SIZE(p.resv); i++) {
3843 if (p.resv[i])
3844 return -EINVAL;
3845 }
3846
Jens Axboe6c271ce2019-01-10 11:22:30 -07003847 if (p.flags & ~(IORING_SETUP_IOPOLL | IORING_SETUP_SQPOLL |
3848 IORING_SETUP_SQ_AFF))
Jens Axboe2b188cc2019-01-07 10:46:33 -07003849 return -EINVAL;
3850
3851 ret = io_uring_create(entries, &p);
3852 if (ret < 0)
3853 return ret;
3854
3855 if (copy_to_user(params, &p, sizeof(p)))
3856 return -EFAULT;
3857
3858 return ret;
3859}
3860
3861SYSCALL_DEFINE2(io_uring_setup, u32, entries,
3862 struct io_uring_params __user *, params)
3863{
3864 return io_uring_setup(entries, params);
3865}
3866
Jens Axboeedafcce2019-01-09 09:16:05 -07003867static int __io_uring_register(struct io_ring_ctx *ctx, unsigned opcode,
3868 void __user *arg, unsigned nr_args)
Jens Axboeb19062a2019-04-15 10:49:38 -06003869 __releases(ctx->uring_lock)
3870 __acquires(ctx->uring_lock)
Jens Axboeedafcce2019-01-09 09:16:05 -07003871{
3872 int ret;
3873
Jens Axboe35fa71a2019-04-22 10:23:23 -06003874 /*
3875 * We're inside the ring mutex, if the ref is already dying, then
3876 * someone else killed the ctx or is already going through
3877 * io_uring_register().
3878 */
3879 if (percpu_ref_is_dying(&ctx->refs))
3880 return -ENXIO;
3881
Jens Axboeedafcce2019-01-09 09:16:05 -07003882 percpu_ref_kill(&ctx->refs);
Jens Axboeb19062a2019-04-15 10:49:38 -06003883
3884 /*
3885 * Drop uring mutex before waiting for references to exit. If another
3886 * thread is currently inside io_uring_enter() it might need to grab
3887 * the uring_lock to make progress. If we hold it here across the drain
3888 * wait, then we can deadlock. It's safe to drop the mutex here, since
3889 * no new references will come in after we've killed the percpu ref.
3890 */
3891 mutex_unlock(&ctx->uring_lock);
Jens Axboeedafcce2019-01-09 09:16:05 -07003892 wait_for_completion(&ctx->ctx_done);
Jens Axboeb19062a2019-04-15 10:49:38 -06003893 mutex_lock(&ctx->uring_lock);
Jens Axboeedafcce2019-01-09 09:16:05 -07003894
3895 switch (opcode) {
3896 case IORING_REGISTER_BUFFERS:
3897 ret = io_sqe_buffer_register(ctx, arg, nr_args);
3898 break;
3899 case IORING_UNREGISTER_BUFFERS:
3900 ret = -EINVAL;
3901 if (arg || nr_args)
3902 break;
3903 ret = io_sqe_buffer_unregister(ctx);
3904 break;
Jens Axboe6b063142019-01-10 22:13:58 -07003905 case IORING_REGISTER_FILES:
3906 ret = io_sqe_files_register(ctx, arg, nr_args);
3907 break;
3908 case IORING_UNREGISTER_FILES:
3909 ret = -EINVAL;
3910 if (arg || nr_args)
3911 break;
3912 ret = io_sqe_files_unregister(ctx);
3913 break;
Jens Axboe9b402842019-04-11 11:45:41 -06003914 case IORING_REGISTER_EVENTFD:
3915 ret = -EINVAL;
3916 if (nr_args != 1)
3917 break;
3918 ret = io_eventfd_register(ctx, arg);
3919 break;
3920 case IORING_UNREGISTER_EVENTFD:
3921 ret = -EINVAL;
3922 if (arg || nr_args)
3923 break;
3924 ret = io_eventfd_unregister(ctx);
3925 break;
Jens Axboeedafcce2019-01-09 09:16:05 -07003926 default:
3927 ret = -EINVAL;
3928 break;
3929 }
3930
3931 /* bring the ctx back to life */
3932 reinit_completion(&ctx->ctx_done);
3933 percpu_ref_reinit(&ctx->refs);
3934 return ret;
3935}
3936
3937SYSCALL_DEFINE4(io_uring_register, unsigned int, fd, unsigned int, opcode,
3938 void __user *, arg, unsigned int, nr_args)
3939{
3940 struct io_ring_ctx *ctx;
3941 long ret = -EBADF;
3942 struct fd f;
3943
3944 f = fdget(fd);
3945 if (!f.file)
3946 return -EBADF;
3947
3948 ret = -EOPNOTSUPP;
3949 if (f.file->f_op != &io_uring_fops)
3950 goto out_fput;
3951
3952 ctx = f.file->private_data;
3953
3954 mutex_lock(&ctx->uring_lock);
3955 ret = __io_uring_register(ctx, opcode, arg, nr_args);
3956 mutex_unlock(&ctx->uring_lock);
3957out_fput:
3958 fdput(f);
3959 return ret;
3960}
3961
Jens Axboe2b188cc2019-01-07 10:46:33 -07003962static int __init io_uring_init(void)
3963{
3964 req_cachep = KMEM_CACHE(io_kiocb, SLAB_HWCACHE_ALIGN | SLAB_PANIC);
3965 return 0;
3966};
3967__initcall(io_uring_init);