blob: 38d274fc0f251674761460cea8390234d0886252 [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 Axboe2b188cc2019-01-07 10:46:33 -0700325 u64 user_data;
Jens Axboe9e645e112019-05-10 16:07:28 -0600326 u32 result;
Jens Axboede0617e2019-04-06 21:51:27 -0600327 u32 sequence;
Jens Axboe2b188cc2019-01-07 10:46:33 -0700328
329 struct work_struct work;
330};
331
332#define IO_PLUG_THRESHOLD 2
Jens Axboedef596e2019-01-09 08:59:42 -0700333#define IO_IOPOLL_BATCH 8
Jens Axboe2b188cc2019-01-07 10:46:33 -0700334
Jens Axboe9a56a232019-01-09 09:06:50 -0700335struct io_submit_state {
336 struct blk_plug plug;
337
338 /*
Jens Axboe2579f912019-01-09 09:10:43 -0700339 * io_kiocb alloc cache
340 */
341 void *reqs[IO_IOPOLL_BATCH];
342 unsigned int free_reqs;
343 unsigned int cur_req;
344
345 /*
Jens Axboe9a56a232019-01-09 09:06:50 -0700346 * File reference cache
347 */
348 struct file *file;
349 unsigned int fd;
350 unsigned int has_refs;
351 unsigned int used_refs;
352 unsigned int ios_left;
353};
354
Jens Axboede0617e2019-04-06 21:51:27 -0600355static void io_sq_wq_submit_work(struct work_struct *work);
Jens Axboe5262f562019-09-17 12:26:57 -0600356static void io_cqring_fill_event(struct io_ring_ctx *ctx, u64 ki_user_data,
357 long res);
Jackie Liu4fe2c962019-09-09 20:50:40 +0800358static void __io_free_req(struct io_kiocb *req);
Jens Axboede0617e2019-04-06 21:51:27 -0600359
Jens Axboe2b188cc2019-01-07 10:46:33 -0700360static struct kmem_cache *req_cachep;
361
362static const struct file_operations io_uring_fops;
363
364struct sock *io_uring_get_socket(struct file *file)
365{
366#if defined(CONFIG_UNIX)
367 if (file->f_op == &io_uring_fops) {
368 struct io_ring_ctx *ctx = file->private_data;
369
370 return ctx->ring_sock->sk;
371 }
372#endif
373 return NULL;
374}
375EXPORT_SYMBOL(io_uring_get_socket);
376
377static void io_ring_ctx_ref_free(struct percpu_ref *ref)
378{
379 struct io_ring_ctx *ctx = container_of(ref, struct io_ring_ctx, refs);
380
381 complete(&ctx->ctx_done);
382}
383
384static struct io_ring_ctx *io_ring_ctx_alloc(struct io_uring_params *p)
385{
386 struct io_ring_ctx *ctx;
Jens Axboe31b51512019-01-18 22:56:34 -0700387 int i;
Jens Axboe2b188cc2019-01-07 10:46:33 -0700388
389 ctx = kzalloc(sizeof(*ctx), GFP_KERNEL);
390 if (!ctx)
391 return NULL;
392
Roman Gushchin21482892019-05-07 10:01:48 -0700393 if (percpu_ref_init(&ctx->refs, io_ring_ctx_ref_free,
394 PERCPU_REF_ALLOW_REINIT, GFP_KERNEL)) {
Jens Axboe2b188cc2019-01-07 10:46:33 -0700395 kfree(ctx);
396 return NULL;
397 }
398
399 ctx->flags = p->flags;
400 init_waitqueue_head(&ctx->cq_wait);
401 init_completion(&ctx->ctx_done);
Jackie Liua4c0b3d2019-07-08 13:41:12 +0800402 init_completion(&ctx->sqo_thread_started);
Jens Axboe2b188cc2019-01-07 10:46:33 -0700403 mutex_init(&ctx->uring_lock);
404 init_waitqueue_head(&ctx->wait);
Jens Axboe31b51512019-01-18 22:56:34 -0700405 for (i = 0; i < ARRAY_SIZE(ctx->pending_async); i++) {
406 spin_lock_init(&ctx->pending_async[i].lock);
407 INIT_LIST_HEAD(&ctx->pending_async[i].list);
408 atomic_set(&ctx->pending_async[i].cnt, 0);
409 }
Jens Axboe2b188cc2019-01-07 10:46:33 -0700410 spin_lock_init(&ctx->completion_lock);
Jens Axboedef596e2019-01-09 08:59:42 -0700411 INIT_LIST_HEAD(&ctx->poll_list);
Jens Axboe221c5eb2019-01-17 09:41:58 -0700412 INIT_LIST_HEAD(&ctx->cancel_list);
Jens Axboede0617e2019-04-06 21:51:27 -0600413 INIT_LIST_HEAD(&ctx->defer_list);
Jens Axboe5262f562019-09-17 12:26:57 -0600414 INIT_LIST_HEAD(&ctx->timeout_list);
Jens Axboe2b188cc2019-01-07 10:46:33 -0700415 return ctx;
416}
417
Jens Axboe7adf4ea2019-10-10 21:42:58 -0600418static inline bool __io_sequence_defer(struct io_ring_ctx *ctx,
419 struct io_kiocb *req)
Jens Axboede0617e2019-04-06 21:51:27 -0600420{
Hristo Venev75b28af2019-08-26 17:23:46 +0000421 return req->sequence != ctx->cached_cq_tail + ctx->rings->sq_dropped;
Jens Axboede0617e2019-04-06 21:51:27 -0600422}
423
Jens Axboe7adf4ea2019-10-10 21:42:58 -0600424static inline bool io_sequence_defer(struct io_ring_ctx *ctx,
425 struct io_kiocb *req)
426{
427 if ((req->flags & (REQ_F_IO_DRAIN|REQ_F_IO_DRAINED)) != REQ_F_IO_DRAIN)
428 return false;
429
430 return __io_sequence_defer(ctx, req);
431}
432
433static struct io_kiocb *io_get_deferred_req(struct io_ring_ctx *ctx)
Jens Axboede0617e2019-04-06 21:51:27 -0600434{
435 struct io_kiocb *req;
436
Jens Axboe7adf4ea2019-10-10 21:42:58 -0600437 req = list_first_entry_or_null(&ctx->defer_list, struct io_kiocb, list);
438 if (req && !io_sequence_defer(ctx, req)) {
Jens Axboede0617e2019-04-06 21:51:27 -0600439 list_del_init(&req->list);
440 return req;
441 }
442
443 return NULL;
444}
445
Jens Axboe5262f562019-09-17 12:26:57 -0600446static struct io_kiocb *io_get_timeout_req(struct io_ring_ctx *ctx)
447{
Jens Axboe7adf4ea2019-10-10 21:42:58 -0600448 struct io_kiocb *req;
449
450 req = list_first_entry_or_null(&ctx->timeout_list, struct io_kiocb, list);
451 if (req && !__io_sequence_defer(ctx, req)) {
452 list_del_init(&req->list);
453 return req;
454 }
455
456 return NULL;
Jens Axboe5262f562019-09-17 12:26:57 -0600457}
458
Jens Axboede0617e2019-04-06 21:51:27 -0600459static void __io_commit_cqring(struct io_ring_ctx *ctx)
Jens Axboe2b188cc2019-01-07 10:46:33 -0700460{
Hristo Venev75b28af2019-08-26 17:23:46 +0000461 struct io_rings *rings = ctx->rings;
Jens Axboe2b188cc2019-01-07 10:46:33 -0700462
Hristo Venev75b28af2019-08-26 17:23:46 +0000463 if (ctx->cached_cq_tail != READ_ONCE(rings->cq.tail)) {
Jens Axboe2b188cc2019-01-07 10:46:33 -0700464 /* order cqe stores with ring update */
Hristo Venev75b28af2019-08-26 17:23:46 +0000465 smp_store_release(&rings->cq.tail, ctx->cached_cq_tail);
Jens Axboe2b188cc2019-01-07 10:46:33 -0700466
Jens Axboe2b188cc2019-01-07 10:46:33 -0700467 if (wq_has_sleeper(&ctx->cq_wait)) {
468 wake_up_interruptible(&ctx->cq_wait);
469 kill_fasync(&ctx->cq_fasync, SIGIO, POLL_IN);
470 }
471 }
472}
473
Jens Axboe18d9be12019-09-10 09:13:05 -0600474static inline void io_queue_async_work(struct io_ring_ctx *ctx,
475 struct io_kiocb *req)
476{
Jens Axboe6cc47d12019-09-18 11:18:23 -0600477 int rw = 0;
Jens Axboe54a91f32019-09-10 09:15:04 -0600478
Jens Axboe6cc47d12019-09-18 11:18:23 -0600479 if (req->submit.sqe) {
480 switch (req->submit.sqe->opcode) {
481 case IORING_OP_WRITEV:
482 case IORING_OP_WRITE_FIXED:
483 rw = !(req->rw.ki_flags & IOCB_DIRECT);
484 break;
485 }
Jens Axboe54a91f32019-09-10 09:15:04 -0600486 }
487
488 queue_work(ctx->sqo_wq[rw], &req->work);
Jens Axboe18d9be12019-09-10 09:13:05 -0600489}
490
Jens Axboe5262f562019-09-17 12:26:57 -0600491static void io_kill_timeout(struct io_kiocb *req)
492{
493 int ret;
494
495 ret = hrtimer_try_to_cancel(&req->timeout.timer);
496 if (ret != -1) {
497 atomic_inc(&req->ctx->cq_timeouts);
498 list_del(&req->list);
499 io_cqring_fill_event(req->ctx, req->user_data, 0);
500 __io_free_req(req);
501 }
502}
503
504static void io_kill_timeouts(struct io_ring_ctx *ctx)
505{
506 struct io_kiocb *req, *tmp;
507
508 spin_lock_irq(&ctx->completion_lock);
509 list_for_each_entry_safe(req, tmp, &ctx->timeout_list, list)
510 io_kill_timeout(req);
511 spin_unlock_irq(&ctx->completion_lock);
512}
513
Jens Axboede0617e2019-04-06 21:51:27 -0600514static void io_commit_cqring(struct io_ring_ctx *ctx)
515{
516 struct io_kiocb *req;
517
Jens Axboe5262f562019-09-17 12:26:57 -0600518 while ((req = io_get_timeout_req(ctx)) != NULL)
519 io_kill_timeout(req);
520
Jens Axboede0617e2019-04-06 21:51:27 -0600521 __io_commit_cqring(ctx);
522
523 while ((req = io_get_deferred_req(ctx)) != NULL) {
Jackie Liu4fe2c962019-09-09 20:50:40 +0800524 if (req->flags & REQ_F_SHADOW_DRAIN) {
525 /* Just for drain, free it. */
526 __io_free_req(req);
527 continue;
528 }
Jens Axboede0617e2019-04-06 21:51:27 -0600529 req->flags |= REQ_F_IO_DRAINED;
Jens Axboe18d9be12019-09-10 09:13:05 -0600530 io_queue_async_work(ctx, req);
Jens Axboede0617e2019-04-06 21:51:27 -0600531 }
532}
533
Jens Axboe2b188cc2019-01-07 10:46:33 -0700534static struct io_uring_cqe *io_get_cqring(struct io_ring_ctx *ctx)
535{
Hristo Venev75b28af2019-08-26 17:23:46 +0000536 struct io_rings *rings = ctx->rings;
Jens Axboe2b188cc2019-01-07 10:46:33 -0700537 unsigned tail;
538
539 tail = ctx->cached_cq_tail;
Stefan Bühler115e12e2019-04-24 23:54:18 +0200540 /*
541 * writes to the cq entry need to come after reading head; the
542 * control dependency is enough as we're using WRITE_ONCE to
543 * fill the cq entry
544 */
Hristo Venev75b28af2019-08-26 17:23:46 +0000545 if (tail - READ_ONCE(rings->cq.head) == rings->cq_ring_entries)
Jens Axboe2b188cc2019-01-07 10:46:33 -0700546 return NULL;
547
548 ctx->cached_cq_tail++;
Hristo Venev75b28af2019-08-26 17:23:46 +0000549 return &rings->cqes[tail & ctx->cq_mask];
Jens Axboe2b188cc2019-01-07 10:46:33 -0700550}
551
552static void io_cqring_fill_event(struct io_ring_ctx *ctx, u64 ki_user_data,
Jens Axboec71ffb62019-05-13 20:58:29 -0600553 long res)
Jens Axboe2b188cc2019-01-07 10:46:33 -0700554{
555 struct io_uring_cqe *cqe;
556
557 /*
558 * If we can't get a cq entry, userspace overflowed the
559 * submission (by quite a lot). Increment the overflow count in
560 * the ring.
561 */
562 cqe = io_get_cqring(ctx);
563 if (cqe) {
564 WRITE_ONCE(cqe->user_data, ki_user_data);
565 WRITE_ONCE(cqe->res, res);
Jens Axboec71ffb62019-05-13 20:58:29 -0600566 WRITE_ONCE(cqe->flags, 0);
Jens Axboe2b188cc2019-01-07 10:46:33 -0700567 } else {
Hristo Venev75b28af2019-08-26 17:23:46 +0000568 unsigned overflow = READ_ONCE(ctx->rings->cq_overflow);
Jens Axboe2b188cc2019-01-07 10:46:33 -0700569
Hristo Venev75b28af2019-08-26 17:23:46 +0000570 WRITE_ONCE(ctx->rings->cq_overflow, overflow + 1);
Jens Axboe2b188cc2019-01-07 10:46:33 -0700571 }
572}
573
Jens Axboe8c838782019-03-12 15:48:16 -0600574static void io_cqring_ev_posted(struct io_ring_ctx *ctx)
575{
576 if (waitqueue_active(&ctx->wait))
577 wake_up(&ctx->wait);
578 if (waitqueue_active(&ctx->sqo_wait))
579 wake_up(&ctx->sqo_wait);
Jens Axboe9b402842019-04-11 11:45:41 -0600580 if (ctx->cq_ev_fd)
581 eventfd_signal(ctx->cq_ev_fd, 1);
Jens Axboe8c838782019-03-12 15:48:16 -0600582}
583
584static void io_cqring_add_event(struct io_ring_ctx *ctx, u64 user_data,
Jens Axboec71ffb62019-05-13 20:58:29 -0600585 long res)
Jens Axboe2b188cc2019-01-07 10:46:33 -0700586{
587 unsigned long flags;
588
589 spin_lock_irqsave(&ctx->completion_lock, flags);
Jens Axboec71ffb62019-05-13 20:58:29 -0600590 io_cqring_fill_event(ctx, user_data, res);
Jens Axboe2b188cc2019-01-07 10:46:33 -0700591 io_commit_cqring(ctx);
592 spin_unlock_irqrestore(&ctx->completion_lock, flags);
593
Jens Axboe8c838782019-03-12 15:48:16 -0600594 io_cqring_ev_posted(ctx);
Jens Axboe2b188cc2019-01-07 10:46:33 -0700595}
596
Jens Axboe2579f912019-01-09 09:10:43 -0700597static struct io_kiocb *io_get_req(struct io_ring_ctx *ctx,
598 struct io_submit_state *state)
Jens Axboe2b188cc2019-01-07 10:46:33 -0700599{
Jens Axboefd6fab22019-03-14 16:30:06 -0600600 gfp_t gfp = GFP_KERNEL | __GFP_NOWARN;
Jens Axboe2b188cc2019-01-07 10:46:33 -0700601 struct io_kiocb *req;
602
603 if (!percpu_ref_tryget(&ctx->refs))
604 return NULL;
605
Jens Axboe2579f912019-01-09 09:10:43 -0700606 if (!state) {
Jens Axboefd6fab22019-03-14 16:30:06 -0600607 req = kmem_cache_alloc(req_cachep, gfp);
Jens Axboe2579f912019-01-09 09:10:43 -0700608 if (unlikely(!req))
609 goto out;
610 } else if (!state->free_reqs) {
611 size_t sz;
612 int ret;
613
614 sz = min_t(size_t, state->ios_left, ARRAY_SIZE(state->reqs));
Jens Axboefd6fab22019-03-14 16:30:06 -0600615 ret = kmem_cache_alloc_bulk(req_cachep, gfp, sz, state->reqs);
616
617 /*
618 * Bulk alloc is all-or-nothing. If we fail to get a batch,
619 * retry single alloc to be on the safe side.
620 */
621 if (unlikely(ret <= 0)) {
622 state->reqs[0] = kmem_cache_alloc(req_cachep, gfp);
623 if (!state->reqs[0])
624 goto out;
625 ret = 1;
626 }
Jens Axboe2579f912019-01-09 09:10:43 -0700627 state->free_reqs = ret - 1;
628 state->cur_req = 1;
629 req = state->reqs[0];
630 } else {
631 req = state->reqs[state->cur_req];
632 state->free_reqs--;
633 state->cur_req++;
Jens Axboe2b188cc2019-01-07 10:46:33 -0700634 }
635
Jens Axboe60c112b2019-06-21 10:20:18 -0600636 req->file = NULL;
Jens Axboe2579f912019-01-09 09:10:43 -0700637 req->ctx = ctx;
638 req->flags = 0;
Jens Axboee65ef562019-03-12 10:16:44 -0600639 /* one is dropped after submission, the other at completion */
640 refcount_set(&req->refs, 2);
Jens Axboe9e645e112019-05-10 16:07:28 -0600641 req->result = 0;
Jens Axboe2579f912019-01-09 09:10:43 -0700642 return req;
643out:
Pavel Begunkov6805b322019-10-08 02:18:42 +0300644 percpu_ref_put(&ctx->refs);
Jens Axboe2b188cc2019-01-07 10:46:33 -0700645 return NULL;
646}
647
Jens Axboedef596e2019-01-09 08:59:42 -0700648static void io_free_req_many(struct io_ring_ctx *ctx, void **reqs, int *nr)
649{
650 if (*nr) {
651 kmem_cache_free_bulk(req_cachep, *nr, reqs);
Pavel Begunkov6805b322019-10-08 02:18:42 +0300652 percpu_ref_put_many(&ctx->refs, *nr);
Jens Axboedef596e2019-01-09 08:59:42 -0700653 *nr = 0;
654 }
655}
656
Jens Axboe9e645e112019-05-10 16:07:28 -0600657static void __io_free_req(struct io_kiocb *req)
Jens Axboe2b188cc2019-01-07 10:46:33 -0700658{
Jens Axboe09bb8392019-03-13 12:39:28 -0600659 if (req->file && !(req->flags & REQ_F_FIXED_FILE))
660 fput(req->file);
Pavel Begunkov6805b322019-10-08 02:18:42 +0300661 percpu_ref_put(&req->ctx->refs);
Jens Axboee65ef562019-03-12 10:16:44 -0600662 kmem_cache_free(req_cachep, req);
663}
664
Jens Axboe9e645e112019-05-10 16:07:28 -0600665static void io_req_link_next(struct io_kiocb *req)
666{
667 struct io_kiocb *nxt;
668
669 /*
670 * The list should never be empty when we are called here. But could
671 * potentially happen if the chain is messed up, check to be on the
672 * safe side.
673 */
674 nxt = list_first_entry_or_null(&req->link_list, struct io_kiocb, list);
675 if (nxt) {
676 list_del(&nxt->list);
677 if (!list_empty(&req->link_list)) {
678 INIT_LIST_HEAD(&nxt->link_list);
679 list_splice(&req->link_list, &nxt->link_list);
680 nxt->flags |= REQ_F_LINK;
681 }
682
Zhengyuan Liuf7b76ac2019-07-16 23:26:14 +0800683 nxt->flags |= REQ_F_LINK_DONE;
Jens Axboe9e645e112019-05-10 16:07:28 -0600684 INIT_WORK(&nxt->work, io_sq_wq_submit_work);
Jens Axboe18d9be12019-09-10 09:13:05 -0600685 io_queue_async_work(req->ctx, nxt);
Jens Axboe9e645e112019-05-10 16:07:28 -0600686 }
687}
688
689/*
690 * Called if REQ_F_LINK is set, and we fail the head request
691 */
692static void io_fail_links(struct io_kiocb *req)
693{
694 struct io_kiocb *link;
695
696 while (!list_empty(&req->link_list)) {
697 link = list_first_entry(&req->link_list, struct io_kiocb, list);
698 list_del(&link->list);
699
700 io_cqring_add_event(req->ctx, link->user_data, -ECANCELED);
701 __io_free_req(link);
702 }
703}
704
705static void io_free_req(struct io_kiocb *req)
706{
707 /*
708 * If LINK is set, we have dependent requests in this chain. If we
709 * didn't fail this request, queue the first one up, moving any other
710 * dependencies to the next request. In case of failure, fail the rest
711 * of the chain.
712 */
713 if (req->flags & REQ_F_LINK) {
714 if (req->flags & REQ_F_FAIL_LINK)
715 io_fail_links(req);
716 else
717 io_req_link_next(req);
718 }
719
720 __io_free_req(req);
721}
722
Jens Axboee65ef562019-03-12 10:16:44 -0600723static void io_put_req(struct io_kiocb *req)
724{
725 if (refcount_dec_and_test(&req->refs))
726 io_free_req(req);
Jens Axboe2b188cc2019-01-07 10:46:33 -0700727}
728
Hristo Venev75b28af2019-08-26 17:23:46 +0000729static unsigned io_cqring_events(struct io_rings *rings)
Jens Axboea3a0e432019-08-20 11:03:11 -0600730{
731 /* See comment at the top of this file */
732 smp_rmb();
Hristo Venev75b28af2019-08-26 17:23:46 +0000733 return READ_ONCE(rings->cq.tail) - READ_ONCE(rings->cq.head);
Jens Axboea3a0e432019-08-20 11:03:11 -0600734}
735
Jens Axboedef596e2019-01-09 08:59:42 -0700736/*
737 * Find and free completed poll iocbs
738 */
739static void io_iopoll_complete(struct io_ring_ctx *ctx, unsigned int *nr_events,
740 struct list_head *done)
741{
742 void *reqs[IO_IOPOLL_BATCH];
743 struct io_kiocb *req;
Jens Axboe09bb8392019-03-13 12:39:28 -0600744 int to_free;
Jens Axboedef596e2019-01-09 08:59:42 -0700745
Jens Axboe09bb8392019-03-13 12:39:28 -0600746 to_free = 0;
Jens Axboedef596e2019-01-09 08:59:42 -0700747 while (!list_empty(done)) {
748 req = list_first_entry(done, struct io_kiocb, list);
749 list_del(&req->list);
750
Jens Axboe9e645e112019-05-10 16:07:28 -0600751 io_cqring_fill_event(ctx, req->user_data, req->result);
Jens Axboedef596e2019-01-09 08:59:42 -0700752 (*nr_events)++;
753
Jens Axboe09bb8392019-03-13 12:39:28 -0600754 if (refcount_dec_and_test(&req->refs)) {
755 /* If we're not using fixed files, we have to pair the
756 * completion part with the file put. Use regular
757 * completions for those, only batch free for fixed
Jens Axboe9e645e112019-05-10 16:07:28 -0600758 * file and non-linked commands.
Jens Axboe09bb8392019-03-13 12:39:28 -0600759 */
Jens Axboe9e645e112019-05-10 16:07:28 -0600760 if ((req->flags & (REQ_F_FIXED_FILE|REQ_F_LINK)) ==
761 REQ_F_FIXED_FILE) {
Jens Axboe09bb8392019-03-13 12:39:28 -0600762 reqs[to_free++] = req;
763 if (to_free == ARRAY_SIZE(reqs))
764 io_free_req_many(ctx, reqs, &to_free);
Jens Axboe6b063142019-01-10 22:13:58 -0700765 } else {
Jens Axboe09bb8392019-03-13 12:39:28 -0600766 io_free_req(req);
Jens Axboe6b063142019-01-10 22:13:58 -0700767 }
Jens Axboe9a56a232019-01-09 09:06:50 -0700768 }
Jens Axboedef596e2019-01-09 08:59:42 -0700769 }
Jens Axboedef596e2019-01-09 08:59:42 -0700770
Jens Axboe09bb8392019-03-13 12:39:28 -0600771 io_commit_cqring(ctx);
Jens Axboedef596e2019-01-09 08:59:42 -0700772 io_free_req_many(ctx, reqs, &to_free);
773}
774
775static int io_do_iopoll(struct io_ring_ctx *ctx, unsigned int *nr_events,
776 long min)
777{
778 struct io_kiocb *req, *tmp;
779 LIST_HEAD(done);
780 bool spin;
781 int ret;
782
783 /*
784 * Only spin for completions if we don't have multiple devices hanging
785 * off our complete list, and we're under the requested amount.
786 */
787 spin = !ctx->poll_multi_file && *nr_events < min;
788
789 ret = 0;
790 list_for_each_entry_safe(req, tmp, &ctx->poll_list, list) {
791 struct kiocb *kiocb = &req->rw;
792
793 /*
794 * Move completed entries to our local list. If we find a
795 * request that requires polling, break out and complete
796 * the done list first, if we have entries there.
797 */
798 if (req->flags & REQ_F_IOPOLL_COMPLETED) {
799 list_move_tail(&req->list, &done);
800 continue;
801 }
802 if (!list_empty(&done))
803 break;
804
805 ret = kiocb->ki_filp->f_op->iopoll(kiocb, spin);
806 if (ret < 0)
807 break;
808
809 if (ret && spin)
810 spin = false;
811 ret = 0;
812 }
813
814 if (!list_empty(&done))
815 io_iopoll_complete(ctx, nr_events, &done);
816
817 return ret;
818}
819
820/*
821 * Poll for a mininum of 'min' events. Note that if min == 0 we consider that a
822 * non-spinning poll check - we'll still enter the driver poll loop, but only
823 * as a non-spinning completion check.
824 */
825static int io_iopoll_getevents(struct io_ring_ctx *ctx, unsigned int *nr_events,
826 long min)
827{
Jens Axboe08f54392019-08-21 22:19:11 -0600828 while (!list_empty(&ctx->poll_list) && !need_resched()) {
Jens Axboedef596e2019-01-09 08:59:42 -0700829 int ret;
830
831 ret = io_do_iopoll(ctx, nr_events, min);
832 if (ret < 0)
833 return ret;
834 if (!min || *nr_events >= min)
835 return 0;
836 }
837
838 return 1;
839}
840
841/*
842 * We can't just wait for polled events to come to us, we have to actively
843 * find and complete them.
844 */
845static void io_iopoll_reap_events(struct io_ring_ctx *ctx)
846{
847 if (!(ctx->flags & IORING_SETUP_IOPOLL))
848 return;
849
850 mutex_lock(&ctx->uring_lock);
851 while (!list_empty(&ctx->poll_list)) {
852 unsigned int nr_events = 0;
853
854 io_iopoll_getevents(ctx, &nr_events, 1);
Jens Axboe08f54392019-08-21 22:19:11 -0600855
856 /*
857 * Ensure we allow local-to-the-cpu processing to take place,
858 * in this case we need to ensure that we reap all events.
859 */
860 cond_resched();
Jens Axboedef596e2019-01-09 08:59:42 -0700861 }
862 mutex_unlock(&ctx->uring_lock);
863}
864
865static int io_iopoll_check(struct io_ring_ctx *ctx, unsigned *nr_events,
866 long min)
867{
Jens Axboe500f9fb2019-08-19 12:15:59 -0600868 int iters, ret = 0;
Jens Axboedef596e2019-01-09 08:59:42 -0700869
Jens Axboe500f9fb2019-08-19 12:15:59 -0600870 /*
871 * We disallow the app entering submit/complete with polling, but we
872 * still need to lock the ring to prevent racing with polled issue
873 * that got punted to a workqueue.
874 */
875 mutex_lock(&ctx->uring_lock);
876
877 iters = 0;
Jens Axboedef596e2019-01-09 08:59:42 -0700878 do {
879 int tmin = 0;
880
Jens Axboe500f9fb2019-08-19 12:15:59 -0600881 /*
Jens Axboea3a0e432019-08-20 11:03:11 -0600882 * Don't enter poll loop if we already have events pending.
883 * If we do, we can potentially be spinning for commands that
884 * already triggered a CQE (eg in error).
885 */
Hristo Venev75b28af2019-08-26 17:23:46 +0000886 if (io_cqring_events(ctx->rings))
Jens Axboea3a0e432019-08-20 11:03:11 -0600887 break;
888
889 /*
Jens Axboe500f9fb2019-08-19 12:15:59 -0600890 * If a submit got punted to a workqueue, we can have the
891 * application entering polling for a command before it gets
892 * issued. That app will hold the uring_lock for the duration
893 * of the poll right here, so we need to take a breather every
894 * now and then to ensure that the issue has a chance to add
895 * the poll to the issued list. Otherwise we can spin here
896 * forever, while the workqueue is stuck trying to acquire the
897 * very same mutex.
898 */
899 if (!(++iters & 7)) {
900 mutex_unlock(&ctx->uring_lock);
901 mutex_lock(&ctx->uring_lock);
902 }
903
Jens Axboedef596e2019-01-09 08:59:42 -0700904 if (*nr_events < min)
905 tmin = min - *nr_events;
906
907 ret = io_iopoll_getevents(ctx, nr_events, tmin);
908 if (ret <= 0)
909 break;
910 ret = 0;
911 } while (min && !*nr_events && !need_resched());
912
Jens Axboe500f9fb2019-08-19 12:15:59 -0600913 mutex_unlock(&ctx->uring_lock);
Jens Axboedef596e2019-01-09 08:59:42 -0700914 return ret;
915}
916
Jens Axboe2b188cc2019-01-07 10:46:33 -0700917static void kiocb_end_write(struct kiocb *kiocb)
918{
919 if (kiocb->ki_flags & IOCB_WRITE) {
920 struct inode *inode = file_inode(kiocb->ki_filp);
921
922 /*
923 * Tell lockdep we inherited freeze protection from submission
924 * thread.
925 */
926 if (S_ISREG(inode->i_mode))
927 __sb_writers_acquired(inode->i_sb, SB_FREEZE_WRITE);
928 file_end_write(kiocb->ki_filp);
929 }
930}
931
932static void io_complete_rw(struct kiocb *kiocb, long res, long res2)
933{
934 struct io_kiocb *req = container_of(kiocb, struct io_kiocb, rw);
935
936 kiocb_end_write(kiocb);
937
Jens Axboe9e645e112019-05-10 16:07:28 -0600938 if ((req->flags & REQ_F_LINK) && res != req->result)
939 req->flags |= REQ_F_FAIL_LINK;
Jens Axboec71ffb62019-05-13 20:58:29 -0600940 io_cqring_add_event(req->ctx, req->user_data, res);
Jens Axboee65ef562019-03-12 10:16:44 -0600941 io_put_req(req);
Jens Axboe2b188cc2019-01-07 10:46:33 -0700942}
943
Jens Axboedef596e2019-01-09 08:59:42 -0700944static void io_complete_rw_iopoll(struct kiocb *kiocb, long res, long res2)
945{
946 struct io_kiocb *req = container_of(kiocb, struct io_kiocb, rw);
947
948 kiocb_end_write(kiocb);
949
Jens Axboe9e645e112019-05-10 16:07:28 -0600950 if ((req->flags & REQ_F_LINK) && res != req->result)
951 req->flags |= REQ_F_FAIL_LINK;
952 req->result = res;
Jens Axboedef596e2019-01-09 08:59:42 -0700953 if (res != -EAGAIN)
954 req->flags |= REQ_F_IOPOLL_COMPLETED;
955}
956
957/*
958 * After the iocb has been issued, it's safe to be found on the poll list.
959 * Adding the kiocb to the list AFTER submission ensures that we don't
960 * find it from a io_iopoll_getevents() thread before the issuer is done
961 * accessing the kiocb cookie.
962 */
963static void io_iopoll_req_issued(struct io_kiocb *req)
964{
965 struct io_ring_ctx *ctx = req->ctx;
966
967 /*
968 * Track whether we have multiple files in our lists. This will impact
969 * how we do polling eventually, not spinning if we're on potentially
970 * different devices.
971 */
972 if (list_empty(&ctx->poll_list)) {
973 ctx->poll_multi_file = false;
974 } else if (!ctx->poll_multi_file) {
975 struct io_kiocb *list_req;
976
977 list_req = list_first_entry(&ctx->poll_list, struct io_kiocb,
978 list);
979 if (list_req->rw.ki_filp != req->rw.ki_filp)
980 ctx->poll_multi_file = true;
981 }
982
983 /*
984 * For fast devices, IO may have already completed. If it has, add
985 * it to the front so we find it first.
986 */
987 if (req->flags & REQ_F_IOPOLL_COMPLETED)
988 list_add(&req->list, &ctx->poll_list);
989 else
990 list_add_tail(&req->list, &ctx->poll_list);
991}
992
Jens Axboe3d6770f2019-04-13 11:50:54 -0600993static void io_file_put(struct io_submit_state *state)
Jens Axboe9a56a232019-01-09 09:06:50 -0700994{
Jens Axboe3d6770f2019-04-13 11:50:54 -0600995 if (state->file) {
Jens Axboe9a56a232019-01-09 09:06:50 -0700996 int diff = state->has_refs - state->used_refs;
997
998 if (diff)
999 fput_many(state->file, diff);
1000 state->file = NULL;
1001 }
1002}
1003
1004/*
1005 * Get as many references to a file as we have IOs left in this submission,
1006 * assuming most submissions are for one file, or at least that each file
1007 * has more than one submission.
1008 */
1009static struct file *io_file_get(struct io_submit_state *state, int fd)
1010{
1011 if (!state)
1012 return fget(fd);
1013
1014 if (state->file) {
1015 if (state->fd == fd) {
1016 state->used_refs++;
1017 state->ios_left--;
1018 return state->file;
1019 }
Jens Axboe3d6770f2019-04-13 11:50:54 -06001020 io_file_put(state);
Jens Axboe9a56a232019-01-09 09:06:50 -07001021 }
1022 state->file = fget_many(fd, state->ios_left);
1023 if (!state->file)
1024 return NULL;
1025
1026 state->fd = fd;
1027 state->has_refs = state->ios_left;
1028 state->used_refs = 1;
1029 state->ios_left--;
1030 return state->file;
1031}
1032
Jens Axboe2b188cc2019-01-07 10:46:33 -07001033/*
1034 * If we tracked the file through the SCM inflight mechanism, we could support
1035 * any file. For now, just ensure that anything potentially problematic is done
1036 * inline.
1037 */
1038static bool io_file_supports_async(struct file *file)
1039{
1040 umode_t mode = file_inode(file)->i_mode;
1041
1042 if (S_ISBLK(mode) || S_ISCHR(mode))
1043 return true;
1044 if (S_ISREG(mode) && file->f_op != &io_uring_fops)
1045 return true;
1046
1047 return false;
1048}
1049
Jens Axboe6c271ce2019-01-10 11:22:30 -07001050static int io_prep_rw(struct io_kiocb *req, const struct sqe_submit *s,
Jens Axboe8358e3a2019-04-23 08:17:58 -06001051 bool force_nonblock)
Jens Axboe2b188cc2019-01-07 10:46:33 -07001052{
Jens Axboe6c271ce2019-01-10 11:22:30 -07001053 const struct io_uring_sqe *sqe = s->sqe;
Jens Axboedef596e2019-01-09 08:59:42 -07001054 struct io_ring_ctx *ctx = req->ctx;
Jens Axboe2b188cc2019-01-07 10:46:33 -07001055 struct kiocb *kiocb = &req->rw;
Jens Axboe09bb8392019-03-13 12:39:28 -06001056 unsigned ioprio;
1057 int ret;
Jens Axboe2b188cc2019-01-07 10:46:33 -07001058
Jens Axboe09bb8392019-03-13 12:39:28 -06001059 if (!req->file)
1060 return -EBADF;
Jens Axboe2b188cc2019-01-07 10:46:33 -07001061
Jens Axboe09bb8392019-03-13 12:39:28 -06001062 if (force_nonblock && !io_file_supports_async(req->file))
1063 force_nonblock = false;
Jens Axboe6b063142019-01-10 22:13:58 -07001064
Jens Axboe2b188cc2019-01-07 10:46:33 -07001065 kiocb->ki_pos = READ_ONCE(sqe->off);
1066 kiocb->ki_flags = iocb_flags(kiocb->ki_filp);
1067 kiocb->ki_hint = ki_hint_validate(file_write_hint(kiocb->ki_filp));
1068
1069 ioprio = READ_ONCE(sqe->ioprio);
1070 if (ioprio) {
1071 ret = ioprio_check_cap(ioprio);
1072 if (ret)
Jens Axboe09bb8392019-03-13 12:39:28 -06001073 return ret;
Jens Axboe2b188cc2019-01-07 10:46:33 -07001074
1075 kiocb->ki_ioprio = ioprio;
1076 } else
1077 kiocb->ki_ioprio = get_current_ioprio();
1078
1079 ret = kiocb_set_rw_flags(kiocb, READ_ONCE(sqe->rw_flags));
1080 if (unlikely(ret))
Jens Axboe09bb8392019-03-13 12:39:28 -06001081 return ret;
Stefan Bühler8449eed2019-04-27 20:34:19 +02001082
1083 /* don't allow async punt if RWF_NOWAIT was requested */
1084 if (kiocb->ki_flags & IOCB_NOWAIT)
1085 req->flags |= REQ_F_NOWAIT;
1086
1087 if (force_nonblock)
Jens Axboe2b188cc2019-01-07 10:46:33 -07001088 kiocb->ki_flags |= IOCB_NOWAIT;
Stefan Bühler8449eed2019-04-27 20:34:19 +02001089
Jens Axboedef596e2019-01-09 08:59:42 -07001090 if (ctx->flags & IORING_SETUP_IOPOLL) {
Jens Axboedef596e2019-01-09 08:59:42 -07001091 if (!(kiocb->ki_flags & IOCB_DIRECT) ||
1092 !kiocb->ki_filp->f_op->iopoll)
Jens Axboe09bb8392019-03-13 12:39:28 -06001093 return -EOPNOTSUPP;
Jens Axboe2b188cc2019-01-07 10:46:33 -07001094
Jens Axboedef596e2019-01-09 08:59:42 -07001095 kiocb->ki_flags |= IOCB_HIPRI;
1096 kiocb->ki_complete = io_complete_rw_iopoll;
1097 } else {
Jens Axboe09bb8392019-03-13 12:39:28 -06001098 if (kiocb->ki_flags & IOCB_HIPRI)
1099 return -EINVAL;
Jens Axboedef596e2019-01-09 08:59:42 -07001100 kiocb->ki_complete = io_complete_rw;
1101 }
Jens Axboe2b188cc2019-01-07 10:46:33 -07001102 return 0;
Jens Axboe2b188cc2019-01-07 10:46:33 -07001103}
1104
1105static inline void io_rw_done(struct kiocb *kiocb, ssize_t ret)
1106{
1107 switch (ret) {
1108 case -EIOCBQUEUED:
1109 break;
1110 case -ERESTARTSYS:
1111 case -ERESTARTNOINTR:
1112 case -ERESTARTNOHAND:
1113 case -ERESTART_RESTARTBLOCK:
1114 /*
1115 * We can't just restart the syscall, since previously
1116 * submitted sqes may already be in progress. Just fail this
1117 * IO with EINTR.
1118 */
1119 ret = -EINTR;
1120 /* fall through */
1121 default:
1122 kiocb->ki_complete(kiocb, ret, 0);
1123 }
1124}
1125
Jens Axboeedafcce2019-01-09 09:16:05 -07001126static int io_import_fixed(struct io_ring_ctx *ctx, int rw,
1127 const struct io_uring_sqe *sqe,
1128 struct iov_iter *iter)
1129{
1130 size_t len = READ_ONCE(sqe->len);
1131 struct io_mapped_ubuf *imu;
1132 unsigned index, buf_index;
1133 size_t offset;
1134 u64 buf_addr;
1135
1136 /* attempt to use fixed buffers without having provided iovecs */
1137 if (unlikely(!ctx->user_bufs))
1138 return -EFAULT;
1139
1140 buf_index = READ_ONCE(sqe->buf_index);
1141 if (unlikely(buf_index >= ctx->nr_user_bufs))
1142 return -EFAULT;
1143
1144 index = array_index_nospec(buf_index, ctx->nr_user_bufs);
1145 imu = &ctx->user_bufs[index];
1146 buf_addr = READ_ONCE(sqe->addr);
1147
1148 /* overflow */
1149 if (buf_addr + len < buf_addr)
1150 return -EFAULT;
1151 /* not inside the mapped region */
1152 if (buf_addr < imu->ubuf || buf_addr + len > imu->ubuf + imu->len)
1153 return -EFAULT;
1154
1155 /*
1156 * May not be a start of buffer, set size appropriately
1157 * and advance us to the beginning.
1158 */
1159 offset = buf_addr - imu->ubuf;
1160 iov_iter_bvec(iter, rw, imu->bvec, imu->nr_bvecs, offset + len);
Jens Axboebd11b3a2019-07-20 08:37:31 -06001161
1162 if (offset) {
1163 /*
1164 * Don't use iov_iter_advance() here, as it's really slow for
1165 * using the latter parts of a big fixed buffer - it iterates
1166 * over each segment manually. We can cheat a bit here, because
1167 * we know that:
1168 *
1169 * 1) it's a BVEC iter, we set it up
1170 * 2) all bvecs are PAGE_SIZE in size, except potentially the
1171 * first and last bvec
1172 *
1173 * So just find our index, and adjust the iterator afterwards.
1174 * If the offset is within the first bvec (or the whole first
1175 * bvec, just use iov_iter_advance(). This makes it easier
1176 * since we can just skip the first segment, which may not
1177 * be PAGE_SIZE aligned.
1178 */
1179 const struct bio_vec *bvec = imu->bvec;
1180
1181 if (offset <= bvec->bv_len) {
1182 iov_iter_advance(iter, offset);
1183 } else {
1184 unsigned long seg_skip;
1185
1186 /* skip first vec */
1187 offset -= bvec->bv_len;
1188 seg_skip = 1 + (offset >> PAGE_SHIFT);
1189
1190 iter->bvec = bvec + seg_skip;
1191 iter->nr_segs -= seg_skip;
Aleix Roca Nonell99c79f62019-08-15 14:03:22 +02001192 iter->count -= bvec->bv_len + offset;
Jens Axboebd11b3a2019-07-20 08:37:31 -06001193 iter->iov_offset = offset & ~PAGE_MASK;
Jens Axboebd11b3a2019-07-20 08:37:31 -06001194 }
1195 }
1196
Jens Axboeedafcce2019-01-09 09:16:05 -07001197 return 0;
1198}
1199
Jens Axboe87e5e6d2019-05-14 16:02:22 -06001200static ssize_t io_import_iovec(struct io_ring_ctx *ctx, int rw,
1201 const struct sqe_submit *s, struct iovec **iovec,
1202 struct iov_iter *iter)
Jens Axboe2b188cc2019-01-07 10:46:33 -07001203{
1204 const struct io_uring_sqe *sqe = s->sqe;
1205 void __user *buf = u64_to_user_ptr(READ_ONCE(sqe->addr));
1206 size_t sqe_len = READ_ONCE(sqe->len);
Jens Axboeedafcce2019-01-09 09:16:05 -07001207 u8 opcode;
1208
1209 /*
1210 * We're reading ->opcode for the second time, but the first read
1211 * doesn't care whether it's _FIXED or not, so it doesn't matter
1212 * whether ->opcode changes concurrently. The first read does care
1213 * about whether it is a READ or a WRITE, so we don't trust this read
1214 * for that purpose and instead let the caller pass in the read/write
1215 * flag.
1216 */
1217 opcode = READ_ONCE(sqe->opcode);
1218 if (opcode == IORING_OP_READ_FIXED ||
1219 opcode == IORING_OP_WRITE_FIXED) {
Jens Axboe87e5e6d2019-05-14 16:02:22 -06001220 ssize_t ret = io_import_fixed(ctx, rw, sqe, iter);
Jens Axboeedafcce2019-01-09 09:16:05 -07001221 *iovec = NULL;
1222 return ret;
1223 }
Jens Axboe2b188cc2019-01-07 10:46:33 -07001224
1225 if (!s->has_user)
1226 return -EFAULT;
1227
1228#ifdef CONFIG_COMPAT
1229 if (ctx->compat)
1230 return compat_import_iovec(rw, buf, sqe_len, UIO_FASTIOV,
1231 iovec, iter);
1232#endif
1233
1234 return import_iovec(rw, buf, sqe_len, UIO_FASTIOV, iovec, iter);
1235}
1236
Jens Axboe6d5d5ac2019-09-11 10:16:13 -06001237static inline bool io_should_merge(struct async_list *al, struct kiocb *kiocb)
1238{
1239 if (al->file == kiocb->ki_filp) {
1240 off_t start, end;
1241
1242 /*
1243 * Allow merging if we're anywhere in the range of the same
1244 * page. Generally this happens for sub-page reads or writes,
1245 * and it's beneficial to allow the first worker to bring the
1246 * page in and the piggy backed work can then work on the
1247 * cached page.
1248 */
1249 start = al->io_start & PAGE_MASK;
1250 end = (al->io_start + al->io_len + PAGE_SIZE - 1) & PAGE_MASK;
1251 if (kiocb->ki_pos >= start && kiocb->ki_pos <= end)
1252 return true;
1253 }
1254
1255 al->file = NULL;
1256 return false;
1257}
1258
Jens Axboe31b51512019-01-18 22:56:34 -07001259/*
1260 * Make a note of the last file/offset/direction we punted to async
1261 * context. We'll use this information to see if we can piggy back a
1262 * sequential request onto the previous one, if it's still hasn't been
1263 * completed by the async worker.
1264 */
1265static void io_async_list_note(int rw, struct io_kiocb *req, size_t len)
1266{
1267 struct async_list *async_list = &req->ctx->pending_async[rw];
1268 struct kiocb *kiocb = &req->rw;
1269 struct file *filp = kiocb->ki_filp;
Jens Axboe31b51512019-01-18 22:56:34 -07001270
Jens Axboe6d5d5ac2019-09-11 10:16:13 -06001271 if (io_should_merge(async_list, kiocb)) {
Zhengyuan Liu9310a7ba2019-07-22 10:23:27 +08001272 unsigned long max_bytes;
Jens Axboe31b51512019-01-18 22:56:34 -07001273
1274 /* Use 8x RA size as a decent limiter for both reads/writes */
Zhengyuan Liu9310a7ba2019-07-22 10:23:27 +08001275 max_bytes = filp->f_ra.ra_pages << (PAGE_SHIFT + 3);
1276 if (!max_bytes)
1277 max_bytes = VM_READAHEAD_PAGES << (PAGE_SHIFT + 3);
Jens Axboe31b51512019-01-18 22:56:34 -07001278
Zhengyuan Liu9310a7ba2019-07-22 10:23:27 +08001279 /* If max len are exceeded, reset the state */
1280 if (async_list->io_len + len <= max_bytes) {
Jens Axboe31b51512019-01-18 22:56:34 -07001281 req->flags |= REQ_F_SEQ_PREV;
Zhengyuan Liu9310a7ba2019-07-22 10:23:27 +08001282 async_list->io_len += len;
Jens Axboe31b51512019-01-18 22:56:34 -07001283 } else {
Jens Axboe6d5d5ac2019-09-11 10:16:13 -06001284 async_list->file = NULL;
Jens Axboe31b51512019-01-18 22:56:34 -07001285 }
1286 }
1287
1288 /* New file? Reset state. */
1289 if (async_list->file != filp) {
Jens Axboe6d5d5ac2019-09-11 10:16:13 -06001290 async_list->io_start = kiocb->ki_pos;
1291 async_list->io_len = len;
Jens Axboe31b51512019-01-18 22:56:34 -07001292 async_list->file = filp;
1293 }
Jens Axboe31b51512019-01-18 22:56:34 -07001294}
1295
Jens Axboe32960612019-09-23 11:05:34 -06001296/*
1297 * For files that don't have ->read_iter() and ->write_iter(), handle them
1298 * by looping over ->read() or ->write() manually.
1299 */
1300static ssize_t loop_rw_iter(int rw, struct file *file, struct kiocb *kiocb,
1301 struct iov_iter *iter)
1302{
1303 ssize_t ret = 0;
1304
1305 /*
1306 * Don't support polled IO through this interface, and we can't
1307 * support non-blocking either. For the latter, this just causes
1308 * the kiocb to be handled from an async context.
1309 */
1310 if (kiocb->ki_flags & IOCB_HIPRI)
1311 return -EOPNOTSUPP;
1312 if (kiocb->ki_flags & IOCB_NOWAIT)
1313 return -EAGAIN;
1314
1315 while (iov_iter_count(iter)) {
1316 struct iovec iovec = iov_iter_iovec(iter);
1317 ssize_t nr;
1318
1319 if (rw == READ) {
1320 nr = file->f_op->read(file, iovec.iov_base,
1321 iovec.iov_len, &kiocb->ki_pos);
1322 } else {
1323 nr = file->f_op->write(file, iovec.iov_base,
1324 iovec.iov_len, &kiocb->ki_pos);
1325 }
1326
1327 if (nr < 0) {
1328 if (!ret)
1329 ret = nr;
1330 break;
1331 }
1332 ret += nr;
1333 if (nr != iovec.iov_len)
1334 break;
1335 iov_iter_advance(iter, nr);
1336 }
1337
1338 return ret;
1339}
1340
Jens Axboee0c5c572019-03-12 10:18:47 -06001341static int io_read(struct io_kiocb *req, const struct sqe_submit *s,
Jens Axboe8358e3a2019-04-23 08:17:58 -06001342 bool force_nonblock)
Jens Axboe2b188cc2019-01-07 10:46:33 -07001343{
1344 struct iovec inline_vecs[UIO_FASTIOV], *iovec = inline_vecs;
1345 struct kiocb *kiocb = &req->rw;
1346 struct iov_iter iter;
1347 struct file *file;
Jens Axboe31b51512019-01-18 22:56:34 -07001348 size_t iov_count;
Jens Axboe9d93a3f2019-05-15 13:53:07 -06001349 ssize_t read_size, ret;
Jens Axboe2b188cc2019-01-07 10:46:33 -07001350
Jens Axboe8358e3a2019-04-23 08:17:58 -06001351 ret = io_prep_rw(req, s, force_nonblock);
Jens Axboe2b188cc2019-01-07 10:46:33 -07001352 if (ret)
1353 return ret;
1354 file = kiocb->ki_filp;
1355
Jens Axboe2b188cc2019-01-07 10:46:33 -07001356 if (unlikely(!(file->f_mode & FMODE_READ)))
Jens Axboe09bb8392019-03-13 12:39:28 -06001357 return -EBADF;
Jens Axboe2b188cc2019-01-07 10:46:33 -07001358
1359 ret = io_import_iovec(req->ctx, READ, s, &iovec, &iter);
Jens Axboe87e5e6d2019-05-14 16:02:22 -06001360 if (ret < 0)
Jens Axboe09bb8392019-03-13 12:39:28 -06001361 return ret;
Jens Axboe2b188cc2019-01-07 10:46:33 -07001362
Jens Axboe9d93a3f2019-05-15 13:53:07 -06001363 read_size = ret;
Jens Axboe9e645e112019-05-10 16:07:28 -06001364 if (req->flags & REQ_F_LINK)
1365 req->result = read_size;
1366
Jens Axboe31b51512019-01-18 22:56:34 -07001367 iov_count = iov_iter_count(&iter);
1368 ret = rw_verify_area(READ, file, &kiocb->ki_pos, iov_count);
Jens Axboe2b188cc2019-01-07 10:46:33 -07001369 if (!ret) {
1370 ssize_t ret2;
1371
Jens Axboe32960612019-09-23 11:05:34 -06001372 if (file->f_op->read_iter)
1373 ret2 = call_read_iter(file, kiocb, &iter);
1374 else
1375 ret2 = loop_rw_iter(READ, file, kiocb, &iter);
1376
Jens Axboe9d93a3f2019-05-15 13:53:07 -06001377 /*
1378 * In case of a short read, punt to async. This can happen
1379 * if we have data partially cached. Alternatively we can
1380 * return the short read, in which case the application will
1381 * need to issue another SQE and wait for it. That SQE will
1382 * need async punt anyway, so it's more efficient to do it
1383 * here.
1384 */
1385 if (force_nonblock && ret2 > 0 && ret2 < read_size)
1386 ret2 = -EAGAIN;
1387 /* Catch -EAGAIN return for forced non-blocking submission */
Jens Axboe31b51512019-01-18 22:56:34 -07001388 if (!force_nonblock || ret2 != -EAGAIN) {
Jens Axboe2b188cc2019-01-07 10:46:33 -07001389 io_rw_done(kiocb, ret2);
Jens Axboe31b51512019-01-18 22:56:34 -07001390 } else {
1391 /*
1392 * If ->needs_lock is true, we're already in async
1393 * context.
1394 */
1395 if (!s->needs_lock)
1396 io_async_list_note(READ, req, iov_count);
Jens Axboe2b188cc2019-01-07 10:46:33 -07001397 ret = -EAGAIN;
Jens Axboe31b51512019-01-18 22:56:34 -07001398 }
Jens Axboe2b188cc2019-01-07 10:46:33 -07001399 }
1400 kfree(iovec);
Jens Axboe2b188cc2019-01-07 10:46:33 -07001401 return ret;
1402}
1403
Jens Axboee0c5c572019-03-12 10:18:47 -06001404static int io_write(struct io_kiocb *req, const struct sqe_submit *s,
Jens Axboe8358e3a2019-04-23 08:17:58 -06001405 bool force_nonblock)
Jens Axboe2b188cc2019-01-07 10:46:33 -07001406{
1407 struct iovec inline_vecs[UIO_FASTIOV], *iovec = inline_vecs;
1408 struct kiocb *kiocb = &req->rw;
1409 struct iov_iter iter;
1410 struct file *file;
Jens Axboe31b51512019-01-18 22:56:34 -07001411 size_t iov_count;
Jens Axboe87e5e6d2019-05-14 16:02:22 -06001412 ssize_t ret;
Jens Axboe2b188cc2019-01-07 10:46:33 -07001413
Jens Axboe8358e3a2019-04-23 08:17:58 -06001414 ret = io_prep_rw(req, s, force_nonblock);
Jens Axboe2b188cc2019-01-07 10:46:33 -07001415 if (ret)
1416 return ret;
Jens Axboe2b188cc2019-01-07 10:46:33 -07001417
Jens Axboe2b188cc2019-01-07 10:46:33 -07001418 file = kiocb->ki_filp;
1419 if (unlikely(!(file->f_mode & FMODE_WRITE)))
Jens Axboe09bb8392019-03-13 12:39:28 -06001420 return -EBADF;
Jens Axboe2b188cc2019-01-07 10:46:33 -07001421
1422 ret = io_import_iovec(req->ctx, WRITE, s, &iovec, &iter);
Jens Axboe87e5e6d2019-05-14 16:02:22 -06001423 if (ret < 0)
Jens Axboe09bb8392019-03-13 12:39:28 -06001424 return ret;
Jens Axboe2b188cc2019-01-07 10:46:33 -07001425
Jens Axboe9e645e112019-05-10 16:07:28 -06001426 if (req->flags & REQ_F_LINK)
1427 req->result = ret;
1428
Jens Axboe31b51512019-01-18 22:56:34 -07001429 iov_count = iov_iter_count(&iter);
1430
1431 ret = -EAGAIN;
1432 if (force_nonblock && !(kiocb->ki_flags & IOCB_DIRECT)) {
1433 /* If ->needs_lock is true, we're already in async context. */
1434 if (!s->needs_lock)
1435 io_async_list_note(WRITE, req, iov_count);
1436 goto out_free;
1437 }
1438
1439 ret = rw_verify_area(WRITE, file, &kiocb->ki_pos, iov_count);
Jens Axboe2b188cc2019-01-07 10:46:33 -07001440 if (!ret) {
Roman Penyaev9bf79332019-03-25 20:09:24 +01001441 ssize_t ret2;
1442
Jens Axboe2b188cc2019-01-07 10:46:33 -07001443 /*
1444 * Open-code file_start_write here to grab freeze protection,
1445 * which will be released by another thread in
1446 * io_complete_rw(). Fool lockdep by telling it the lock got
1447 * released so that it doesn't complain about the held lock when
1448 * we return to userspace.
1449 */
1450 if (S_ISREG(file_inode(file)->i_mode)) {
1451 __sb_start_write(file_inode(file)->i_sb,
1452 SB_FREEZE_WRITE, true);
1453 __sb_writers_release(file_inode(file)->i_sb,
1454 SB_FREEZE_WRITE);
1455 }
1456 kiocb->ki_flags |= IOCB_WRITE;
Roman Penyaev9bf79332019-03-25 20:09:24 +01001457
Jens Axboe32960612019-09-23 11:05:34 -06001458 if (file->f_op->write_iter)
1459 ret2 = call_write_iter(file, kiocb, &iter);
1460 else
1461 ret2 = loop_rw_iter(WRITE, file, kiocb, &iter);
Roman Penyaev9bf79332019-03-25 20:09:24 +01001462 if (!force_nonblock || ret2 != -EAGAIN) {
1463 io_rw_done(kiocb, ret2);
1464 } else {
1465 /*
1466 * If ->needs_lock is true, we're already in async
1467 * context.
1468 */
1469 if (!s->needs_lock)
1470 io_async_list_note(WRITE, req, iov_count);
1471 ret = -EAGAIN;
1472 }
Jens Axboe2b188cc2019-01-07 10:46:33 -07001473 }
Jens Axboe31b51512019-01-18 22:56:34 -07001474out_free:
Jens Axboe2b188cc2019-01-07 10:46:33 -07001475 kfree(iovec);
Jens Axboe2b188cc2019-01-07 10:46:33 -07001476 return ret;
1477}
1478
1479/*
1480 * IORING_OP_NOP just posts a completion event, nothing else.
1481 */
1482static int io_nop(struct io_kiocb *req, u64 user_data)
1483{
1484 struct io_ring_ctx *ctx = req->ctx;
1485 long err = 0;
1486
Jens Axboedef596e2019-01-09 08:59:42 -07001487 if (unlikely(ctx->flags & IORING_SETUP_IOPOLL))
1488 return -EINVAL;
1489
Jens Axboec71ffb62019-05-13 20:58:29 -06001490 io_cqring_add_event(ctx, user_data, err);
Jens Axboee65ef562019-03-12 10:16:44 -06001491 io_put_req(req);
Jens Axboe2b188cc2019-01-07 10:46:33 -07001492 return 0;
1493}
1494
Christoph Hellwigc992fe22019-01-11 09:43:02 -07001495static int io_prep_fsync(struct io_kiocb *req, const struct io_uring_sqe *sqe)
1496{
Jens Axboe6b063142019-01-10 22:13:58 -07001497 struct io_ring_ctx *ctx = req->ctx;
Christoph Hellwigc992fe22019-01-11 09:43:02 -07001498
Jens Axboe09bb8392019-03-13 12:39:28 -06001499 if (!req->file)
1500 return -EBADF;
Christoph Hellwigc992fe22019-01-11 09:43:02 -07001501
Jens Axboe6b063142019-01-10 22:13:58 -07001502 if (unlikely(ctx->flags & IORING_SETUP_IOPOLL))
Jens Axboedef596e2019-01-09 08:59:42 -07001503 return -EINVAL;
Jens Axboeedafcce2019-01-09 09:16:05 -07001504 if (unlikely(sqe->addr || sqe->ioprio || sqe->buf_index))
Christoph Hellwigc992fe22019-01-11 09:43:02 -07001505 return -EINVAL;
1506
Christoph Hellwigc992fe22019-01-11 09:43:02 -07001507 return 0;
1508}
1509
1510static int io_fsync(struct io_kiocb *req, const struct io_uring_sqe *sqe,
1511 bool force_nonblock)
1512{
1513 loff_t sqe_off = READ_ONCE(sqe->off);
1514 loff_t sqe_len = READ_ONCE(sqe->len);
1515 loff_t end = sqe_off + sqe_len;
1516 unsigned fsync_flags;
1517 int ret;
1518
1519 fsync_flags = READ_ONCE(sqe->fsync_flags);
1520 if (unlikely(fsync_flags & ~IORING_FSYNC_DATASYNC))
1521 return -EINVAL;
1522
1523 ret = io_prep_fsync(req, sqe);
1524 if (ret)
1525 return ret;
1526
1527 /* fsync always requires a blocking context */
1528 if (force_nonblock)
1529 return -EAGAIN;
1530
1531 ret = vfs_fsync_range(req->rw.ki_filp, sqe_off,
1532 end > 0 ? end : LLONG_MAX,
1533 fsync_flags & IORING_FSYNC_DATASYNC);
1534
Jens Axboe9e645e112019-05-10 16:07:28 -06001535 if (ret < 0 && (req->flags & REQ_F_LINK))
1536 req->flags |= REQ_F_FAIL_LINK;
Jens Axboec71ffb62019-05-13 20:58:29 -06001537 io_cqring_add_event(req->ctx, sqe->user_data, ret);
Jens Axboee65ef562019-03-12 10:16:44 -06001538 io_put_req(req);
Christoph Hellwigc992fe22019-01-11 09:43:02 -07001539 return 0;
1540}
1541
Jens Axboe5d17b4a2019-04-09 14:56:44 -06001542static int io_prep_sfr(struct io_kiocb *req, const struct io_uring_sqe *sqe)
1543{
1544 struct io_ring_ctx *ctx = req->ctx;
1545 int ret = 0;
1546
1547 if (!req->file)
1548 return -EBADF;
Jens Axboe5d17b4a2019-04-09 14:56:44 -06001549
1550 if (unlikely(ctx->flags & IORING_SETUP_IOPOLL))
1551 return -EINVAL;
1552 if (unlikely(sqe->addr || sqe->ioprio || sqe->buf_index))
1553 return -EINVAL;
1554
Jens Axboe5d17b4a2019-04-09 14:56:44 -06001555 return ret;
1556}
1557
1558static int io_sync_file_range(struct io_kiocb *req,
1559 const struct io_uring_sqe *sqe,
1560 bool force_nonblock)
1561{
1562 loff_t sqe_off;
1563 loff_t sqe_len;
1564 unsigned flags;
1565 int ret;
1566
1567 ret = io_prep_sfr(req, sqe);
1568 if (ret)
1569 return ret;
1570
1571 /* sync_file_range always requires a blocking context */
1572 if (force_nonblock)
1573 return -EAGAIN;
1574
1575 sqe_off = READ_ONCE(sqe->off);
1576 sqe_len = READ_ONCE(sqe->len);
1577 flags = READ_ONCE(sqe->sync_range_flags);
1578
1579 ret = sync_file_range(req->rw.ki_filp, sqe_off, sqe_len, flags);
1580
Jens Axboe9e645e112019-05-10 16:07:28 -06001581 if (ret < 0 && (req->flags & REQ_F_LINK))
1582 req->flags |= REQ_F_FAIL_LINK;
Jens Axboec71ffb62019-05-13 20:58:29 -06001583 io_cqring_add_event(req->ctx, sqe->user_data, ret);
Jens Axboe5d17b4a2019-04-09 14:56:44 -06001584 io_put_req(req);
1585 return 0;
1586}
1587
Jens Axboe0fa03c62019-04-19 13:34:07 -06001588#if defined(CONFIG_NET)
Jens Axboeaa1fa282019-04-19 13:38:09 -06001589static int io_send_recvmsg(struct io_kiocb *req, const struct io_uring_sqe *sqe,
1590 bool force_nonblock,
1591 long (*fn)(struct socket *, struct user_msghdr __user *,
1592 unsigned int))
1593{
Jens Axboe0fa03c62019-04-19 13:34:07 -06001594 struct socket *sock;
1595 int ret;
1596
1597 if (unlikely(req->ctx->flags & IORING_SETUP_IOPOLL))
1598 return -EINVAL;
1599
1600 sock = sock_from_file(req->file, &ret);
1601 if (sock) {
1602 struct user_msghdr __user *msg;
1603 unsigned flags;
1604
1605 flags = READ_ONCE(sqe->msg_flags);
1606 if (flags & MSG_DONTWAIT)
1607 req->flags |= REQ_F_NOWAIT;
1608 else if (force_nonblock)
1609 flags |= MSG_DONTWAIT;
1610
1611 msg = (struct user_msghdr __user *) (unsigned long)
1612 READ_ONCE(sqe->addr);
1613
Jens Axboeaa1fa282019-04-19 13:38:09 -06001614 ret = fn(sock, msg, flags);
Jens Axboe0fa03c62019-04-19 13:34:07 -06001615 if (force_nonblock && ret == -EAGAIN)
1616 return ret;
1617 }
1618
1619 io_cqring_add_event(req->ctx, sqe->user_data, ret);
1620 io_put_req(req);
1621 return 0;
Jens Axboeaa1fa282019-04-19 13:38:09 -06001622}
1623#endif
1624
1625static int io_sendmsg(struct io_kiocb *req, const struct io_uring_sqe *sqe,
1626 bool force_nonblock)
1627{
1628#if defined(CONFIG_NET)
1629 return io_send_recvmsg(req, sqe, force_nonblock, __sys_sendmsg_sock);
1630#else
1631 return -EOPNOTSUPP;
1632#endif
1633}
1634
1635static int io_recvmsg(struct io_kiocb *req, const struct io_uring_sqe *sqe,
1636 bool force_nonblock)
1637{
1638#if defined(CONFIG_NET)
1639 return io_send_recvmsg(req, sqe, force_nonblock, __sys_recvmsg_sock);
Jens Axboe0fa03c62019-04-19 13:34:07 -06001640#else
1641 return -EOPNOTSUPP;
1642#endif
1643}
1644
Jens Axboe221c5eb2019-01-17 09:41:58 -07001645static void io_poll_remove_one(struct io_kiocb *req)
1646{
1647 struct io_poll_iocb *poll = &req->poll;
1648
1649 spin_lock(&poll->head->lock);
1650 WRITE_ONCE(poll->canceled, true);
1651 if (!list_empty(&poll->wait.entry)) {
1652 list_del_init(&poll->wait.entry);
Jens Axboe18d9be12019-09-10 09:13:05 -06001653 io_queue_async_work(req->ctx, req);
Jens Axboe221c5eb2019-01-17 09:41:58 -07001654 }
1655 spin_unlock(&poll->head->lock);
1656
1657 list_del_init(&req->list);
1658}
1659
1660static void io_poll_remove_all(struct io_ring_ctx *ctx)
1661{
1662 struct io_kiocb *req;
1663
1664 spin_lock_irq(&ctx->completion_lock);
1665 while (!list_empty(&ctx->cancel_list)) {
1666 req = list_first_entry(&ctx->cancel_list, struct io_kiocb,list);
1667 io_poll_remove_one(req);
1668 }
1669 spin_unlock_irq(&ctx->completion_lock);
1670}
1671
1672/*
1673 * Find a running poll command that matches one specified in sqe->addr,
1674 * and remove it if found.
1675 */
1676static int io_poll_remove(struct io_kiocb *req, const struct io_uring_sqe *sqe)
1677{
1678 struct io_ring_ctx *ctx = req->ctx;
1679 struct io_kiocb *poll_req, *next;
1680 int ret = -ENOENT;
1681
1682 if (unlikely(req->ctx->flags & IORING_SETUP_IOPOLL))
1683 return -EINVAL;
1684 if (sqe->ioprio || sqe->off || sqe->len || sqe->buf_index ||
1685 sqe->poll_events)
1686 return -EINVAL;
1687
1688 spin_lock_irq(&ctx->completion_lock);
1689 list_for_each_entry_safe(poll_req, next, &ctx->cancel_list, list) {
1690 if (READ_ONCE(sqe->addr) == poll_req->user_data) {
1691 io_poll_remove_one(poll_req);
1692 ret = 0;
1693 break;
1694 }
1695 }
1696 spin_unlock_irq(&ctx->completion_lock);
1697
Jens Axboec71ffb62019-05-13 20:58:29 -06001698 io_cqring_add_event(req->ctx, sqe->user_data, ret);
Jens Axboee65ef562019-03-12 10:16:44 -06001699 io_put_req(req);
Jens Axboe221c5eb2019-01-17 09:41:58 -07001700 return 0;
1701}
1702
Jens Axboe8c838782019-03-12 15:48:16 -06001703static void io_poll_complete(struct io_ring_ctx *ctx, struct io_kiocb *req,
1704 __poll_t mask)
Jens Axboe221c5eb2019-01-17 09:41:58 -07001705{
Jens Axboe8c838782019-03-12 15:48:16 -06001706 req->poll.done = true;
Jens Axboec71ffb62019-05-13 20:58:29 -06001707 io_cqring_fill_event(ctx, req->user_data, mangle_poll(mask));
Jens Axboe8c838782019-03-12 15:48:16 -06001708 io_commit_cqring(ctx);
Jens Axboe221c5eb2019-01-17 09:41:58 -07001709}
1710
1711static void io_poll_complete_work(struct work_struct *work)
1712{
1713 struct io_kiocb *req = container_of(work, struct io_kiocb, work);
1714 struct io_poll_iocb *poll = &req->poll;
1715 struct poll_table_struct pt = { ._key = poll->events };
1716 struct io_ring_ctx *ctx = req->ctx;
1717 __poll_t mask = 0;
1718
1719 if (!READ_ONCE(poll->canceled))
1720 mask = vfs_poll(poll->file, &pt) & poll->events;
1721
1722 /*
1723 * Note that ->ki_cancel callers also delete iocb from active_reqs after
1724 * calling ->ki_cancel. We need the ctx_lock roundtrip here to
1725 * synchronize with them. In the cancellation case the list_del_init
1726 * itself is not actually needed, but harmless so we keep it in to
1727 * avoid further branches in the fast path.
1728 */
1729 spin_lock_irq(&ctx->completion_lock);
1730 if (!mask && !READ_ONCE(poll->canceled)) {
1731 add_wait_queue(poll->head, &poll->wait);
1732 spin_unlock_irq(&ctx->completion_lock);
1733 return;
1734 }
1735 list_del_init(&req->list);
Jens Axboe8c838782019-03-12 15:48:16 -06001736 io_poll_complete(ctx, req, mask);
Jens Axboe221c5eb2019-01-17 09:41:58 -07001737 spin_unlock_irq(&ctx->completion_lock);
1738
Jens Axboe8c838782019-03-12 15:48:16 -06001739 io_cqring_ev_posted(ctx);
1740 io_put_req(req);
Jens Axboe221c5eb2019-01-17 09:41:58 -07001741}
1742
1743static int io_poll_wake(struct wait_queue_entry *wait, unsigned mode, int sync,
1744 void *key)
1745{
1746 struct io_poll_iocb *poll = container_of(wait, struct io_poll_iocb,
1747 wait);
1748 struct io_kiocb *req = container_of(poll, struct io_kiocb, poll);
1749 struct io_ring_ctx *ctx = req->ctx;
1750 __poll_t mask = key_to_poll(key);
Jens Axboe8c838782019-03-12 15:48:16 -06001751 unsigned long flags;
Jens Axboe221c5eb2019-01-17 09:41:58 -07001752
1753 /* for instances that support it check for an event match first: */
Jens Axboe8c838782019-03-12 15:48:16 -06001754 if (mask && !(mask & poll->events))
1755 return 0;
Jens Axboe221c5eb2019-01-17 09:41:58 -07001756
1757 list_del_init(&poll->wait.entry);
Jens Axboe8c838782019-03-12 15:48:16 -06001758
1759 if (mask && spin_trylock_irqsave(&ctx->completion_lock, flags)) {
1760 list_del(&req->list);
1761 io_poll_complete(ctx, req, mask);
1762 spin_unlock_irqrestore(&ctx->completion_lock, flags);
1763
1764 io_cqring_ev_posted(ctx);
1765 io_put_req(req);
1766 } else {
Jens Axboe18d9be12019-09-10 09:13:05 -06001767 io_queue_async_work(ctx, req);
Jens Axboe8c838782019-03-12 15:48:16 -06001768 }
1769
Jens Axboe221c5eb2019-01-17 09:41:58 -07001770 return 1;
1771}
1772
1773struct io_poll_table {
1774 struct poll_table_struct pt;
1775 struct io_kiocb *req;
1776 int error;
1777};
1778
1779static void io_poll_queue_proc(struct file *file, struct wait_queue_head *head,
1780 struct poll_table_struct *p)
1781{
1782 struct io_poll_table *pt = container_of(p, struct io_poll_table, pt);
1783
1784 if (unlikely(pt->req->poll.head)) {
1785 pt->error = -EINVAL;
1786 return;
1787 }
1788
1789 pt->error = 0;
1790 pt->req->poll.head = head;
1791 add_wait_queue(head, &pt->req->poll.wait);
1792}
1793
1794static int io_poll_add(struct io_kiocb *req, const struct io_uring_sqe *sqe)
1795{
1796 struct io_poll_iocb *poll = &req->poll;
1797 struct io_ring_ctx *ctx = req->ctx;
1798 struct io_poll_table ipt;
Jens Axboe8c838782019-03-12 15:48:16 -06001799 bool cancel = false;
Jens Axboe221c5eb2019-01-17 09:41:58 -07001800 __poll_t mask;
1801 u16 events;
Jens Axboe221c5eb2019-01-17 09:41:58 -07001802
1803 if (unlikely(req->ctx->flags & IORING_SETUP_IOPOLL))
1804 return -EINVAL;
1805 if (sqe->addr || sqe->ioprio || sqe->off || sqe->len || sqe->buf_index)
1806 return -EINVAL;
Jens Axboe09bb8392019-03-13 12:39:28 -06001807 if (!poll->file)
1808 return -EBADF;
Jens Axboe221c5eb2019-01-17 09:41:58 -07001809
Jens Axboe6cc47d12019-09-18 11:18:23 -06001810 req->submit.sqe = NULL;
Jens Axboe221c5eb2019-01-17 09:41:58 -07001811 INIT_WORK(&req->work, io_poll_complete_work);
1812 events = READ_ONCE(sqe->poll_events);
1813 poll->events = demangle_poll(events) | EPOLLERR | EPOLLHUP;
1814
Jens Axboe221c5eb2019-01-17 09:41:58 -07001815 poll->head = NULL;
Jens Axboe8c838782019-03-12 15:48:16 -06001816 poll->done = false;
Jens Axboe221c5eb2019-01-17 09:41:58 -07001817 poll->canceled = false;
1818
1819 ipt.pt._qproc = io_poll_queue_proc;
1820 ipt.pt._key = poll->events;
1821 ipt.req = req;
1822 ipt.error = -EINVAL; /* same as no support for IOCB_CMD_POLL */
1823
1824 /* initialized the list so that we can do list_empty checks */
1825 INIT_LIST_HEAD(&poll->wait.entry);
1826 init_waitqueue_func_entry(&poll->wait, io_poll_wake);
1827
Jens Axboe36703242019-07-25 10:20:18 -06001828 INIT_LIST_HEAD(&req->list);
1829
Jens Axboe221c5eb2019-01-17 09:41:58 -07001830 mask = vfs_poll(poll->file, &ipt.pt) & poll->events;
Jens Axboe221c5eb2019-01-17 09:41:58 -07001831
1832 spin_lock_irq(&ctx->completion_lock);
Jens Axboe8c838782019-03-12 15:48:16 -06001833 if (likely(poll->head)) {
1834 spin_lock(&poll->head->lock);
1835 if (unlikely(list_empty(&poll->wait.entry))) {
1836 if (ipt.error)
1837 cancel = true;
1838 ipt.error = 0;
1839 mask = 0;
1840 }
1841 if (mask || ipt.error)
1842 list_del_init(&poll->wait.entry);
1843 else if (cancel)
1844 WRITE_ONCE(poll->canceled, true);
1845 else if (!poll->done) /* actually waiting for an event */
1846 list_add_tail(&req->list, &ctx->cancel_list);
1847 spin_unlock(&poll->head->lock);
Jens Axboe221c5eb2019-01-17 09:41:58 -07001848 }
Jens Axboe8c838782019-03-12 15:48:16 -06001849 if (mask) { /* no async, we'd stolen it */
Jens Axboe8c838782019-03-12 15:48:16 -06001850 ipt.error = 0;
1851 io_poll_complete(ctx, req, mask);
1852 }
Jens Axboe221c5eb2019-01-17 09:41:58 -07001853 spin_unlock_irq(&ctx->completion_lock);
1854
Jens Axboe8c838782019-03-12 15:48:16 -06001855 if (mask) {
1856 io_cqring_ev_posted(ctx);
Jens Axboee65ef562019-03-12 10:16:44 -06001857 io_put_req(req);
Jens Axboe221c5eb2019-01-17 09:41:58 -07001858 }
Jens Axboe8c838782019-03-12 15:48:16 -06001859 return ipt.error;
Jens Axboe221c5eb2019-01-17 09:41:58 -07001860}
1861
Jens Axboe5262f562019-09-17 12:26:57 -06001862static enum hrtimer_restart io_timeout_fn(struct hrtimer *timer)
1863{
1864 struct io_ring_ctx *ctx;
1865 struct io_kiocb *req;
1866 unsigned long flags;
1867
1868 req = container_of(timer, struct io_kiocb, timeout.timer);
1869 ctx = req->ctx;
1870 atomic_inc(&ctx->cq_timeouts);
1871
1872 spin_lock_irqsave(&ctx->completion_lock, flags);
1873 list_del(&req->list);
1874
1875 io_cqring_fill_event(ctx, req->user_data, -ETIME);
1876 io_commit_cqring(ctx);
1877 spin_unlock_irqrestore(&ctx->completion_lock, flags);
1878
1879 io_cqring_ev_posted(ctx);
1880
1881 io_put_req(req);
1882 return HRTIMER_NORESTART;
1883}
1884
1885static int io_timeout(struct io_kiocb *req, const struct io_uring_sqe *sqe)
1886{
1887 unsigned count, req_dist, tail_index;
1888 struct io_ring_ctx *ctx = req->ctx;
1889 struct list_head *entry;
Arnd Bergmannbdf20072019-10-01 09:53:29 -06001890 struct timespec64 ts;
Jens Axboe5262f562019-09-17 12:26:57 -06001891
1892 if (unlikely(ctx->flags & IORING_SETUP_IOPOLL))
1893 return -EINVAL;
1894 if (sqe->flags || sqe->ioprio || sqe->buf_index || sqe->timeout_flags ||
1895 sqe->len != 1)
1896 return -EINVAL;
Arnd Bergmannbdf20072019-10-01 09:53:29 -06001897
1898 if (get_timespec64(&ts, u64_to_user_ptr(sqe->addr)))
Jens Axboe5262f562019-09-17 12:26:57 -06001899 return -EFAULT;
1900
1901 /*
1902 * sqe->off holds how many events that need to occur for this
1903 * timeout event to be satisfied.
1904 */
1905 count = READ_ONCE(sqe->off);
1906 if (!count)
1907 count = 1;
1908
1909 req->sequence = ctx->cached_sq_head + count - 1;
1910 req->flags |= REQ_F_TIMEOUT;
1911
1912 /*
1913 * Insertion sort, ensuring the first entry in the list is always
1914 * the one we need first.
1915 */
1916 tail_index = ctx->cached_cq_tail - ctx->rings->sq_dropped;
1917 req_dist = req->sequence - tail_index;
1918 spin_lock_irq(&ctx->completion_lock);
1919 list_for_each_prev(entry, &ctx->timeout_list) {
1920 struct io_kiocb *nxt = list_entry(entry, struct io_kiocb, list);
1921 unsigned dist;
1922
1923 dist = nxt->sequence - tail_index;
1924 if (req_dist >= dist)
1925 break;
1926 }
1927 list_add(&req->list, entry);
1928 spin_unlock_irq(&ctx->completion_lock);
1929
1930 hrtimer_init(&req->timeout.timer, CLOCK_MONOTONIC, HRTIMER_MODE_REL);
1931 req->timeout.timer.function = io_timeout_fn;
Arnd Bergmannbdf20072019-10-01 09:53:29 -06001932 hrtimer_start(&req->timeout.timer, timespec64_to_ktime(ts),
Jens Axboe5262f562019-09-17 12:26:57 -06001933 HRTIMER_MODE_REL);
1934 return 0;
1935}
1936
Jens Axboede0617e2019-04-06 21:51:27 -06001937static int io_req_defer(struct io_ring_ctx *ctx, struct io_kiocb *req,
1938 const struct io_uring_sqe *sqe)
1939{
1940 struct io_uring_sqe *sqe_copy;
1941
1942 if (!io_sequence_defer(ctx, req) && list_empty(&ctx->defer_list))
1943 return 0;
1944
1945 sqe_copy = kmalloc(sizeof(*sqe_copy), GFP_KERNEL);
1946 if (!sqe_copy)
1947 return -EAGAIN;
1948
1949 spin_lock_irq(&ctx->completion_lock);
1950 if (!io_sequence_defer(ctx, req) && list_empty(&ctx->defer_list)) {
1951 spin_unlock_irq(&ctx->completion_lock);
1952 kfree(sqe_copy);
1953 return 0;
1954 }
1955
1956 memcpy(sqe_copy, sqe, sizeof(*sqe_copy));
1957 req->submit.sqe = sqe_copy;
1958
1959 INIT_WORK(&req->work, io_sq_wq_submit_work);
1960 list_add_tail(&req->list, &ctx->defer_list);
1961 spin_unlock_irq(&ctx->completion_lock);
1962 return -EIOCBQUEUED;
1963}
1964
Jens Axboe2b188cc2019-01-07 10:46:33 -07001965static int __io_submit_sqe(struct io_ring_ctx *ctx, struct io_kiocb *req,
Jens Axboe8358e3a2019-04-23 08:17:58 -06001966 const struct sqe_submit *s, bool force_nonblock)
Jens Axboe2b188cc2019-01-07 10:46:33 -07001967{
Jens Axboee0c5c572019-03-12 10:18:47 -06001968 int ret, opcode;
Jens Axboe2b188cc2019-01-07 10:46:33 -07001969
Jens Axboe9e645e112019-05-10 16:07:28 -06001970 req->user_data = READ_ONCE(s->sqe->user_data);
1971
Jens Axboe2b188cc2019-01-07 10:46:33 -07001972 if (unlikely(s->index >= ctx->sq_entries))
1973 return -EINVAL;
Jens Axboe2b188cc2019-01-07 10:46:33 -07001974
1975 opcode = READ_ONCE(s->sqe->opcode);
1976 switch (opcode) {
1977 case IORING_OP_NOP:
1978 ret = io_nop(req, req->user_data);
1979 break;
1980 case IORING_OP_READV:
Jens Axboeedafcce2019-01-09 09:16:05 -07001981 if (unlikely(s->sqe->buf_index))
1982 return -EINVAL;
Jens Axboe8358e3a2019-04-23 08:17:58 -06001983 ret = io_read(req, s, force_nonblock);
Jens Axboe2b188cc2019-01-07 10:46:33 -07001984 break;
1985 case IORING_OP_WRITEV:
Jens Axboeedafcce2019-01-09 09:16:05 -07001986 if (unlikely(s->sqe->buf_index))
1987 return -EINVAL;
Jens Axboe8358e3a2019-04-23 08:17:58 -06001988 ret = io_write(req, s, force_nonblock);
Jens Axboeedafcce2019-01-09 09:16:05 -07001989 break;
1990 case IORING_OP_READ_FIXED:
Jens Axboe8358e3a2019-04-23 08:17:58 -06001991 ret = io_read(req, s, force_nonblock);
Jens Axboeedafcce2019-01-09 09:16:05 -07001992 break;
1993 case IORING_OP_WRITE_FIXED:
Jens Axboe8358e3a2019-04-23 08:17:58 -06001994 ret = io_write(req, s, force_nonblock);
Jens Axboe2b188cc2019-01-07 10:46:33 -07001995 break;
Christoph Hellwigc992fe22019-01-11 09:43:02 -07001996 case IORING_OP_FSYNC:
1997 ret = io_fsync(req, s->sqe, force_nonblock);
1998 break;
Jens Axboe221c5eb2019-01-17 09:41:58 -07001999 case IORING_OP_POLL_ADD:
2000 ret = io_poll_add(req, s->sqe);
2001 break;
2002 case IORING_OP_POLL_REMOVE:
2003 ret = io_poll_remove(req, s->sqe);
2004 break;
Jens Axboe5d17b4a2019-04-09 14:56:44 -06002005 case IORING_OP_SYNC_FILE_RANGE:
2006 ret = io_sync_file_range(req, s->sqe, force_nonblock);
2007 break;
Jens Axboe0fa03c62019-04-19 13:34:07 -06002008 case IORING_OP_SENDMSG:
2009 ret = io_sendmsg(req, s->sqe, force_nonblock);
2010 break;
Jens Axboeaa1fa282019-04-19 13:38:09 -06002011 case IORING_OP_RECVMSG:
2012 ret = io_recvmsg(req, s->sqe, force_nonblock);
2013 break;
Jens Axboe5262f562019-09-17 12:26:57 -06002014 case IORING_OP_TIMEOUT:
2015 ret = io_timeout(req, s->sqe);
2016 break;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002017 default:
2018 ret = -EINVAL;
2019 break;
2020 }
2021
Jens Axboedef596e2019-01-09 08:59:42 -07002022 if (ret)
2023 return ret;
2024
2025 if (ctx->flags & IORING_SETUP_IOPOLL) {
Jens Axboe9e645e112019-05-10 16:07:28 -06002026 if (req->result == -EAGAIN)
Jens Axboedef596e2019-01-09 08:59:42 -07002027 return -EAGAIN;
2028
2029 /* workqueue context doesn't hold uring_lock, grab it now */
2030 if (s->needs_lock)
2031 mutex_lock(&ctx->uring_lock);
2032 io_iopoll_req_issued(req);
2033 if (s->needs_lock)
2034 mutex_unlock(&ctx->uring_lock);
2035 }
2036
2037 return 0;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002038}
2039
Jens Axboe31b51512019-01-18 22:56:34 -07002040static struct async_list *io_async_list_from_sqe(struct io_ring_ctx *ctx,
2041 const struct io_uring_sqe *sqe)
2042{
2043 switch (sqe->opcode) {
2044 case IORING_OP_READV:
2045 case IORING_OP_READ_FIXED:
2046 return &ctx->pending_async[READ];
2047 case IORING_OP_WRITEV:
2048 case IORING_OP_WRITE_FIXED:
2049 return &ctx->pending_async[WRITE];
2050 default:
2051 return NULL;
2052 }
2053}
2054
Jens Axboeedafcce2019-01-09 09:16:05 -07002055static inline bool io_sqe_needs_user(const struct io_uring_sqe *sqe)
2056{
2057 u8 opcode = READ_ONCE(sqe->opcode);
2058
2059 return !(opcode == IORING_OP_READ_FIXED ||
2060 opcode == IORING_OP_WRITE_FIXED);
2061}
2062
Jens Axboe2b188cc2019-01-07 10:46:33 -07002063static void io_sq_wq_submit_work(struct work_struct *work)
2064{
2065 struct io_kiocb *req = container_of(work, struct io_kiocb, work);
Jens Axboe2b188cc2019-01-07 10:46:33 -07002066 struct io_ring_ctx *ctx = req->ctx;
Jens Axboe31b51512019-01-18 22:56:34 -07002067 struct mm_struct *cur_mm = NULL;
2068 struct async_list *async_list;
2069 LIST_HEAD(req_list);
Jens Axboeedafcce2019-01-09 09:16:05 -07002070 mm_segment_t old_fs;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002071 int ret;
2072
Jens Axboe31b51512019-01-18 22:56:34 -07002073 async_list = io_async_list_from_sqe(ctx, req->submit.sqe);
2074restart:
2075 do {
2076 struct sqe_submit *s = &req->submit;
2077 const struct io_uring_sqe *sqe = s->sqe;
Jackie Liud0ee8792019-07-31 14:39:33 +08002078 unsigned int flags = req->flags;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002079
Stefan Bühler8449eed2019-04-27 20:34:19 +02002080 /* Ensure we clear previously set non-block flag */
Jens Axboe31b51512019-01-18 22:56:34 -07002081 req->rw.ki_flags &= ~IOCB_NOWAIT;
2082
2083 ret = 0;
2084 if (io_sqe_needs_user(sqe) && !cur_mm) {
2085 if (!mmget_not_zero(ctx->sqo_mm)) {
2086 ret = -EFAULT;
2087 } else {
2088 cur_mm = ctx->sqo_mm;
2089 use_mm(cur_mm);
2090 old_fs = get_fs();
2091 set_fs(USER_DS);
2092 }
2093 }
2094
2095 if (!ret) {
2096 s->has_user = cur_mm != NULL;
2097 s->needs_lock = true;
2098 do {
Jens Axboe8358e3a2019-04-23 08:17:58 -06002099 ret = __io_submit_sqe(ctx, req, s, false);
Jens Axboe31b51512019-01-18 22:56:34 -07002100 /*
2101 * We can get EAGAIN for polled IO even though
2102 * we're forcing a sync submission from here,
2103 * since we can't wait for request slots on the
2104 * block side.
2105 */
2106 if (ret != -EAGAIN)
2107 break;
2108 cond_resched();
2109 } while (1);
2110 }
Jens Axboe817869d2019-04-30 14:44:05 -06002111
2112 /* drop submission reference */
2113 io_put_req(req);
2114
Jens Axboe31b51512019-01-18 22:56:34 -07002115 if (ret) {
Jens Axboec71ffb62019-05-13 20:58:29 -06002116 io_cqring_add_event(ctx, sqe->user_data, ret);
Jens Axboee65ef562019-03-12 10:16:44 -06002117 io_put_req(req);
Jens Axboe31b51512019-01-18 22:56:34 -07002118 }
2119
2120 /* async context always use a copy of the sqe */
2121 kfree(sqe);
2122
Zhengyuan Liuf7b76ac2019-07-16 23:26:14 +08002123 /* req from defer and link list needn't decrease async cnt */
Jackie Liud0ee8792019-07-31 14:39:33 +08002124 if (flags & (REQ_F_IO_DRAINED | REQ_F_LINK_DONE))
Zhengyuan Liuf7b76ac2019-07-16 23:26:14 +08002125 goto out;
2126
Jens Axboe31b51512019-01-18 22:56:34 -07002127 if (!async_list)
2128 break;
2129 if (!list_empty(&req_list)) {
2130 req = list_first_entry(&req_list, struct io_kiocb,
2131 list);
2132 list_del(&req->list);
2133 continue;
2134 }
2135 if (list_empty(&async_list->list))
2136 break;
2137
2138 req = NULL;
2139 spin_lock(&async_list->lock);
2140 if (list_empty(&async_list->list)) {
2141 spin_unlock(&async_list->lock);
2142 break;
2143 }
2144 list_splice_init(&async_list->list, &req_list);
2145 spin_unlock(&async_list->lock);
2146
2147 req = list_first_entry(&req_list, struct io_kiocb, list);
2148 list_del(&req->list);
2149 } while (req);
Jens Axboeedafcce2019-01-09 09:16:05 -07002150
2151 /*
Jens Axboe31b51512019-01-18 22:56:34 -07002152 * Rare case of racing with a submitter. If we find the count has
2153 * dropped to zero AND we have pending work items, then restart
2154 * the processing. This is a tiny race window.
Jens Axboeedafcce2019-01-09 09:16:05 -07002155 */
Jens Axboe31b51512019-01-18 22:56:34 -07002156 if (async_list) {
2157 ret = atomic_dec_return(&async_list->cnt);
2158 while (!ret && !list_empty(&async_list->list)) {
2159 spin_lock(&async_list->lock);
2160 atomic_inc(&async_list->cnt);
2161 list_splice_init(&async_list->list, &req_list);
2162 spin_unlock(&async_list->lock);
2163
2164 if (!list_empty(&req_list)) {
2165 req = list_first_entry(&req_list,
2166 struct io_kiocb, list);
2167 list_del(&req->list);
2168 goto restart;
2169 }
2170 ret = atomic_dec_return(&async_list->cnt);
Jens Axboeedafcce2019-01-09 09:16:05 -07002171 }
Jens Axboeedafcce2019-01-09 09:16:05 -07002172 }
Jens Axboe2b188cc2019-01-07 10:46:33 -07002173
Zhengyuan Liuf7b76ac2019-07-16 23:26:14 +08002174out:
Jens Axboe31b51512019-01-18 22:56:34 -07002175 if (cur_mm) {
Jens Axboeedafcce2019-01-09 09:16:05 -07002176 set_fs(old_fs);
Jens Axboe31b51512019-01-18 22:56:34 -07002177 unuse_mm(cur_mm);
2178 mmput(cur_mm);
Jens Axboeedafcce2019-01-09 09:16:05 -07002179 }
Jens Axboe31b51512019-01-18 22:56:34 -07002180}
Jens Axboe2b188cc2019-01-07 10:46:33 -07002181
Jens Axboe31b51512019-01-18 22:56:34 -07002182/*
2183 * See if we can piggy back onto previously submitted work, that is still
2184 * running. We currently only allow this if the new request is sequential
2185 * to the previous one we punted.
2186 */
2187static bool io_add_to_prev_work(struct async_list *list, struct io_kiocb *req)
2188{
Jens Axboe6d5d5ac2019-09-11 10:16:13 -06002189 bool ret;
Jens Axboe31b51512019-01-18 22:56:34 -07002190
2191 if (!list)
2192 return false;
2193 if (!(req->flags & REQ_F_SEQ_PREV))
2194 return false;
2195 if (!atomic_read(&list->cnt))
2196 return false;
2197
2198 ret = true;
2199 spin_lock(&list->lock);
2200 list_add_tail(&req->list, &list->list);
Zhengyuan Liuc0e48f92019-07-18 20:44:00 +08002201 /*
2202 * Ensure we see a simultaneous modification from io_sq_wq_submit_work()
2203 */
2204 smp_mb();
Jens Axboe31b51512019-01-18 22:56:34 -07002205 if (!atomic_read(&list->cnt)) {
2206 list_del_init(&req->list);
2207 ret = false;
2208 }
2209 spin_unlock(&list->lock);
2210 return ret;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002211}
2212
Jens Axboe09bb8392019-03-13 12:39:28 -06002213static bool io_op_needs_file(const struct io_uring_sqe *sqe)
2214{
2215 int op = READ_ONCE(sqe->opcode);
2216
2217 switch (op) {
2218 case IORING_OP_NOP:
2219 case IORING_OP_POLL_REMOVE:
2220 return false;
2221 default:
2222 return true;
2223 }
2224}
2225
2226static int io_req_set_file(struct io_ring_ctx *ctx, const struct sqe_submit *s,
2227 struct io_submit_state *state, struct io_kiocb *req)
2228{
2229 unsigned flags;
2230 int fd;
2231
2232 flags = READ_ONCE(s->sqe->flags);
2233 fd = READ_ONCE(s->sqe->fd);
2234
Jackie Liu4fe2c962019-09-09 20:50:40 +08002235 if (flags & IOSQE_IO_DRAIN)
Jens Axboede0617e2019-04-06 21:51:27 -06002236 req->flags |= REQ_F_IO_DRAIN;
Jackie Liu4fe2c962019-09-09 20:50:40 +08002237 /*
2238 * All io need record the previous position, if LINK vs DARIN,
2239 * it can be used to mark the position of the first IO in the
2240 * link list.
2241 */
2242 req->sequence = s->sequence;
Jens Axboede0617e2019-04-06 21:51:27 -06002243
Jens Axboe60c112b2019-06-21 10:20:18 -06002244 if (!io_op_needs_file(s->sqe))
Jens Axboe09bb8392019-03-13 12:39:28 -06002245 return 0;
Jens Axboe09bb8392019-03-13 12:39:28 -06002246
2247 if (flags & IOSQE_FIXED_FILE) {
2248 if (unlikely(!ctx->user_files ||
2249 (unsigned) fd >= ctx->nr_user_files))
2250 return -EBADF;
2251 req->file = ctx->user_files[fd];
2252 req->flags |= REQ_F_FIXED_FILE;
2253 } else {
2254 if (s->needs_fixed_file)
2255 return -EBADF;
2256 req->file = io_file_get(state, fd);
2257 if (unlikely(!req->file))
2258 return -EBADF;
2259 }
2260
2261 return 0;
2262}
2263
Jackie Liu4fe2c962019-09-09 20:50:40 +08002264static int __io_queue_sqe(struct io_ring_ctx *ctx, struct io_kiocb *req,
Jens Axboec57666682019-09-09 16:19:45 -06002265 struct sqe_submit *s, bool force_nonblock)
Jens Axboe2b188cc2019-01-07 10:46:33 -07002266{
Jens Axboee0c5c572019-03-12 10:18:47 -06002267 int ret;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002268
Jens Axboec57666682019-09-09 16:19:45 -06002269 ret = __io_submit_sqe(ctx, req, s, force_nonblock);
Stefan Bühler8449eed2019-04-27 20:34:19 +02002270 if (ret == -EAGAIN && !(req->flags & REQ_F_NOWAIT)) {
Jens Axboe2b188cc2019-01-07 10:46:33 -07002271 struct io_uring_sqe *sqe_copy;
2272
Jackie Liu954dab12019-09-18 10:37:52 +08002273 sqe_copy = kmemdup(s->sqe, sizeof(*sqe_copy), GFP_KERNEL);
Jens Axboe2b188cc2019-01-07 10:46:33 -07002274 if (sqe_copy) {
Jens Axboe31b51512019-01-18 22:56:34 -07002275 struct async_list *list;
2276
Jens Axboe2b188cc2019-01-07 10:46:33 -07002277 s->sqe = sqe_copy;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002278 memcpy(&req->submit, s, sizeof(*s));
Jens Axboe31b51512019-01-18 22:56:34 -07002279 list = io_async_list_from_sqe(ctx, s->sqe);
2280 if (!io_add_to_prev_work(list, req)) {
2281 if (list)
2282 atomic_inc(&list->cnt);
2283 INIT_WORK(&req->work, io_sq_wq_submit_work);
Jens Axboe18d9be12019-09-10 09:13:05 -06002284 io_queue_async_work(ctx, req);
Jens Axboe31b51512019-01-18 22:56:34 -07002285 }
Jens Axboee65ef562019-03-12 10:16:44 -06002286
2287 /*
2288 * Queued up for async execution, worker will release
Jens Axboe9e645e112019-05-10 16:07:28 -06002289 * submit reference when the iocb is actually submitted.
Jens Axboee65ef562019-03-12 10:16:44 -06002290 */
2291 return 0;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002292 }
2293 }
Jens Axboee65ef562019-03-12 10:16:44 -06002294
2295 /* drop submission reference */
2296 io_put_req(req);
2297
2298 /* and drop final reference, if we failed */
Jens Axboe9e645e112019-05-10 16:07:28 -06002299 if (ret) {
2300 io_cqring_add_event(ctx, req->user_data, ret);
2301 if (req->flags & REQ_F_LINK)
2302 req->flags |= REQ_F_FAIL_LINK;
Jens Axboee65ef562019-03-12 10:16:44 -06002303 io_put_req(req);
Jens Axboe9e645e112019-05-10 16:07:28 -06002304 }
Jens Axboe2b188cc2019-01-07 10:46:33 -07002305
2306 return ret;
2307}
2308
Jackie Liu4fe2c962019-09-09 20:50:40 +08002309static int io_queue_sqe(struct io_ring_ctx *ctx, struct io_kiocb *req,
Jens Axboec57666682019-09-09 16:19:45 -06002310 struct sqe_submit *s, bool force_nonblock)
Jackie Liu4fe2c962019-09-09 20:50:40 +08002311{
2312 int ret;
2313
2314 ret = io_req_defer(ctx, req, s->sqe);
2315 if (ret) {
2316 if (ret != -EIOCBQUEUED) {
2317 io_free_req(req);
2318 io_cqring_add_event(ctx, s->sqe->user_data, ret);
2319 }
2320 return 0;
2321 }
2322
Jens Axboec57666682019-09-09 16:19:45 -06002323 return __io_queue_sqe(ctx, req, s, force_nonblock);
Jackie Liu4fe2c962019-09-09 20:50:40 +08002324}
2325
2326static int io_queue_link_head(struct io_ring_ctx *ctx, struct io_kiocb *req,
Jens Axboec57666682019-09-09 16:19:45 -06002327 struct sqe_submit *s, struct io_kiocb *shadow,
2328 bool force_nonblock)
Jackie Liu4fe2c962019-09-09 20:50:40 +08002329{
2330 int ret;
2331 int need_submit = false;
2332
2333 if (!shadow)
Jens Axboec57666682019-09-09 16:19:45 -06002334 return io_queue_sqe(ctx, req, s, force_nonblock);
Jackie Liu4fe2c962019-09-09 20:50:40 +08002335
2336 /*
2337 * Mark the first IO in link list as DRAIN, let all the following
2338 * IOs enter the defer list. all IO needs to be completed before link
2339 * list.
2340 */
2341 req->flags |= REQ_F_IO_DRAIN;
2342 ret = io_req_defer(ctx, req, s->sqe);
2343 if (ret) {
2344 if (ret != -EIOCBQUEUED) {
2345 io_free_req(req);
2346 io_cqring_add_event(ctx, s->sqe->user_data, ret);
2347 return 0;
2348 }
2349 } else {
2350 /*
2351 * If ret == 0 means that all IOs in front of link io are
2352 * running done. let's queue link head.
2353 */
2354 need_submit = true;
2355 }
2356
2357 /* Insert shadow req to defer_list, blocking next IOs */
2358 spin_lock_irq(&ctx->completion_lock);
2359 list_add_tail(&shadow->list, &ctx->defer_list);
2360 spin_unlock_irq(&ctx->completion_lock);
2361
2362 if (need_submit)
Jens Axboec57666682019-09-09 16:19:45 -06002363 return __io_queue_sqe(ctx, req, s, force_nonblock);
Jackie Liu4fe2c962019-09-09 20:50:40 +08002364
2365 return 0;
2366}
2367
Jens Axboe9e645e112019-05-10 16:07:28 -06002368#define SQE_VALID_FLAGS (IOSQE_FIXED_FILE|IOSQE_IO_DRAIN|IOSQE_IO_LINK)
2369
2370static void io_submit_sqe(struct io_ring_ctx *ctx, struct sqe_submit *s,
Jens Axboec57666682019-09-09 16:19:45 -06002371 struct io_submit_state *state, struct io_kiocb **link,
2372 bool force_nonblock)
Jens Axboe9e645e112019-05-10 16:07:28 -06002373{
2374 struct io_uring_sqe *sqe_copy;
2375 struct io_kiocb *req;
2376 int ret;
2377
2378 /* enforce forwards compatibility on users */
2379 if (unlikely(s->sqe->flags & ~SQE_VALID_FLAGS)) {
2380 ret = -EINVAL;
2381 goto err;
2382 }
2383
2384 req = io_get_req(ctx, state);
2385 if (unlikely(!req)) {
2386 ret = -EAGAIN;
2387 goto err;
2388 }
2389
2390 ret = io_req_set_file(ctx, s, state, req);
2391 if (unlikely(ret)) {
2392err_req:
2393 io_free_req(req);
2394err:
2395 io_cqring_add_event(ctx, s->sqe->user_data, ret);
2396 return;
2397 }
2398
Jens Axboe9e645e112019-05-10 16:07:28 -06002399 /*
2400 * If we already have a head request, queue this one for async
2401 * submittal once the head completes. If we don't have a head but
2402 * IOSQE_IO_LINK is set in the sqe, start a new head. This one will be
2403 * submitted sync once the chain is complete. If none of those
2404 * conditions are true (normal request), then just queue it.
2405 */
2406 if (*link) {
2407 struct io_kiocb *prev = *link;
2408
2409 sqe_copy = kmemdup(s->sqe, sizeof(*sqe_copy), GFP_KERNEL);
2410 if (!sqe_copy) {
2411 ret = -EAGAIN;
2412 goto err_req;
2413 }
2414
2415 s->sqe = sqe_copy;
2416 memcpy(&req->submit, s, sizeof(*s));
2417 list_add_tail(&req->list, &prev->link_list);
2418 } else if (s->sqe->flags & IOSQE_IO_LINK) {
2419 req->flags |= REQ_F_LINK;
2420
2421 memcpy(&req->submit, s, sizeof(*s));
2422 INIT_LIST_HEAD(&req->link_list);
2423 *link = req;
2424 } else {
Jens Axboec57666682019-09-09 16:19:45 -06002425 io_queue_sqe(ctx, req, s, force_nonblock);
Jens Axboe9e645e112019-05-10 16:07:28 -06002426 }
2427}
2428
Jens Axboe9a56a232019-01-09 09:06:50 -07002429/*
2430 * Batched submission is done, ensure local IO is flushed out.
2431 */
2432static void io_submit_state_end(struct io_submit_state *state)
2433{
2434 blk_finish_plug(&state->plug);
Jens Axboe3d6770f2019-04-13 11:50:54 -06002435 io_file_put(state);
Jens Axboe2579f912019-01-09 09:10:43 -07002436 if (state->free_reqs)
2437 kmem_cache_free_bulk(req_cachep, state->free_reqs,
2438 &state->reqs[state->cur_req]);
Jens Axboe9a56a232019-01-09 09:06:50 -07002439}
2440
2441/*
2442 * Start submission side cache.
2443 */
2444static void io_submit_state_start(struct io_submit_state *state,
2445 struct io_ring_ctx *ctx, unsigned max_ios)
2446{
2447 blk_start_plug(&state->plug);
Jens Axboe2579f912019-01-09 09:10:43 -07002448 state->free_reqs = 0;
Jens Axboe9a56a232019-01-09 09:06:50 -07002449 state->file = NULL;
2450 state->ios_left = max_ios;
2451}
2452
Jens Axboe2b188cc2019-01-07 10:46:33 -07002453static void io_commit_sqring(struct io_ring_ctx *ctx)
2454{
Hristo Venev75b28af2019-08-26 17:23:46 +00002455 struct io_rings *rings = ctx->rings;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002456
Hristo Venev75b28af2019-08-26 17:23:46 +00002457 if (ctx->cached_sq_head != READ_ONCE(rings->sq.head)) {
Jens Axboe2b188cc2019-01-07 10:46:33 -07002458 /*
2459 * Ensure any loads from the SQEs are done at this point,
2460 * since once we write the new head, the application could
2461 * write new data to them.
2462 */
Hristo Venev75b28af2019-08-26 17:23:46 +00002463 smp_store_release(&rings->sq.head, ctx->cached_sq_head);
Jens Axboe2b188cc2019-01-07 10:46:33 -07002464 }
2465}
2466
2467/*
Jens Axboe2b188cc2019-01-07 10:46:33 -07002468 * Fetch an sqe, if one is available. Note that s->sqe will point to memory
2469 * that is mapped by userspace. This means that care needs to be taken to
2470 * ensure that reads are stable, as we cannot rely on userspace always
2471 * being a good citizen. If members of the sqe are validated and then later
2472 * used, it's important that those reads are done through READ_ONCE() to
2473 * prevent a re-load down the line.
2474 */
2475static bool io_get_sqring(struct io_ring_ctx *ctx, struct sqe_submit *s)
2476{
Hristo Venev75b28af2019-08-26 17:23:46 +00002477 struct io_rings *rings = ctx->rings;
2478 u32 *sq_array = ctx->sq_array;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002479 unsigned head;
2480
2481 /*
2482 * The cached sq head (or cq tail) serves two purposes:
2483 *
2484 * 1) allows us to batch the cost of updating the user visible
2485 * head updates.
2486 * 2) allows the kernel side to track the head on its own, even
2487 * though the application is the one updating it.
2488 */
2489 head = ctx->cached_sq_head;
Stefan Bühlere523a292019-04-19 11:57:44 +02002490 /* make sure SQ entry isn't read before tail */
Hristo Venev75b28af2019-08-26 17:23:46 +00002491 if (head == smp_load_acquire(&rings->sq.tail))
Jens Axboe2b188cc2019-01-07 10:46:33 -07002492 return false;
2493
Hristo Venev75b28af2019-08-26 17:23:46 +00002494 head = READ_ONCE(sq_array[head & ctx->sq_mask]);
Jens Axboe2b188cc2019-01-07 10:46:33 -07002495 if (head < ctx->sq_entries) {
2496 s->index = head;
2497 s->sqe = &ctx->sq_sqes[head];
Jackie Liu8776f3f2019-09-09 20:50:39 +08002498 s->sequence = ctx->cached_sq_head;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002499 ctx->cached_sq_head++;
2500 return true;
2501 }
2502
2503 /* drop invalid entries */
2504 ctx->cached_sq_head++;
Hristo Venev75b28af2019-08-26 17:23:46 +00002505 rings->sq_dropped++;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002506 return false;
2507}
2508
Jens Axboe6c271ce2019-01-10 11:22:30 -07002509static int io_submit_sqes(struct io_ring_ctx *ctx, struct sqe_submit *sqes,
2510 unsigned int nr, bool has_user, bool mm_fault)
2511{
2512 struct io_submit_state state, *statep = NULL;
Jens Axboe9e645e112019-05-10 16:07:28 -06002513 struct io_kiocb *link = NULL;
Jackie Liu4fe2c962019-09-09 20:50:40 +08002514 struct io_kiocb *shadow_req = NULL;
Jens Axboe9e645e112019-05-10 16:07:28 -06002515 bool prev_was_link = false;
2516 int i, submitted = 0;
Jens Axboe6c271ce2019-01-10 11:22:30 -07002517
2518 if (nr > IO_PLUG_THRESHOLD) {
2519 io_submit_state_start(&state, ctx, nr);
2520 statep = &state;
2521 }
2522
2523 for (i = 0; i < nr; i++) {
Jens Axboe9e645e112019-05-10 16:07:28 -06002524 /*
2525 * If previous wasn't linked and we have a linked command,
2526 * that's the end of the chain. Submit the previous link.
2527 */
2528 if (!prev_was_link && link) {
Jens Axboec57666682019-09-09 16:19:45 -06002529 io_queue_link_head(ctx, link, &link->submit, shadow_req,
2530 true);
Jens Axboe9e645e112019-05-10 16:07:28 -06002531 link = NULL;
Jackie Liu5f5ad9c2019-09-18 10:37:53 +08002532 shadow_req = NULL;
Jens Axboe9e645e112019-05-10 16:07:28 -06002533 }
2534 prev_was_link = (sqes[i].sqe->flags & IOSQE_IO_LINK) != 0;
2535
Jackie Liu4fe2c962019-09-09 20:50:40 +08002536 if (link && (sqes[i].sqe->flags & IOSQE_IO_DRAIN)) {
2537 if (!shadow_req) {
2538 shadow_req = io_get_req(ctx, NULL);
Jackie Liua1041c22019-09-18 17:25:52 +08002539 if (unlikely(!shadow_req))
2540 goto out;
Jackie Liu4fe2c962019-09-09 20:50:40 +08002541 shadow_req->flags |= (REQ_F_IO_DRAIN | REQ_F_SHADOW_DRAIN);
2542 refcount_dec(&shadow_req->refs);
2543 }
2544 shadow_req->sequence = sqes[i].sequence;
2545 }
2546
Jackie Liua1041c22019-09-18 17:25:52 +08002547out:
Jens Axboe6c271ce2019-01-10 11:22:30 -07002548 if (unlikely(mm_fault)) {
Jens Axboe9e645e112019-05-10 16:07:28 -06002549 io_cqring_add_event(ctx, sqes[i].sqe->user_data,
2550 -EFAULT);
Jens Axboe6c271ce2019-01-10 11:22:30 -07002551 } else {
2552 sqes[i].has_user = has_user;
2553 sqes[i].needs_lock = true;
2554 sqes[i].needs_fixed_file = true;
Jens Axboec57666682019-09-09 16:19:45 -06002555 io_submit_sqe(ctx, &sqes[i], statep, &link, true);
Jens Axboe6c271ce2019-01-10 11:22:30 -07002556 submitted++;
Jens Axboe6c271ce2019-01-10 11:22:30 -07002557 }
Jens Axboe6c271ce2019-01-10 11:22:30 -07002558 }
2559
Jens Axboe9e645e112019-05-10 16:07:28 -06002560 if (link)
Jens Axboec57666682019-09-09 16:19:45 -06002561 io_queue_link_head(ctx, link, &link->submit, shadow_req, true);
Jens Axboe6c271ce2019-01-10 11:22:30 -07002562 if (statep)
2563 io_submit_state_end(&state);
2564
2565 return submitted;
2566}
2567
2568static int io_sq_thread(void *data)
2569{
2570 struct sqe_submit sqes[IO_IOPOLL_BATCH];
2571 struct io_ring_ctx *ctx = data;
2572 struct mm_struct *cur_mm = NULL;
2573 mm_segment_t old_fs;
2574 DEFINE_WAIT(wait);
2575 unsigned inflight;
2576 unsigned long timeout;
2577
Jackie Liua4c0b3d2019-07-08 13:41:12 +08002578 complete(&ctx->sqo_thread_started);
2579
Jens Axboe6c271ce2019-01-10 11:22:30 -07002580 old_fs = get_fs();
2581 set_fs(USER_DS);
2582
2583 timeout = inflight = 0;
Roman Penyaev2bbcd6d2019-05-16 10:53:57 +02002584 while (!kthread_should_park()) {
Jens Axboe6c271ce2019-01-10 11:22:30 -07002585 bool all_fixed, mm_fault = false;
2586 int i;
2587
2588 if (inflight) {
2589 unsigned nr_events = 0;
2590
2591 if (ctx->flags & IORING_SETUP_IOPOLL) {
Jens Axboe6c271ce2019-01-10 11:22:30 -07002592 io_iopoll_check(ctx, &nr_events, 0);
Jens Axboe6c271ce2019-01-10 11:22:30 -07002593 } else {
2594 /*
2595 * Normal IO, just pretend everything completed.
2596 * We don't have to poll completions for that.
2597 */
2598 nr_events = inflight;
2599 }
2600
2601 inflight -= nr_events;
2602 if (!inflight)
2603 timeout = jiffies + ctx->sq_thread_idle;
2604 }
2605
2606 if (!io_get_sqring(ctx, &sqes[0])) {
2607 /*
2608 * We're polling. If we're within the defined idle
2609 * period, then let us spin without work before going
2610 * to sleep.
2611 */
2612 if (inflight || !time_after(jiffies, timeout)) {
Jens Axboe9831a902019-09-19 09:48:55 -06002613 cond_resched();
Jens Axboe6c271ce2019-01-10 11:22:30 -07002614 continue;
2615 }
2616
2617 /*
2618 * Drop cur_mm before scheduling, we can't hold it for
2619 * long periods (or over schedule()). Do this before
2620 * adding ourselves to the waitqueue, as the unuse/drop
2621 * may sleep.
2622 */
2623 if (cur_mm) {
2624 unuse_mm(cur_mm);
2625 mmput(cur_mm);
2626 cur_mm = NULL;
2627 }
2628
2629 prepare_to_wait(&ctx->sqo_wait, &wait,
2630 TASK_INTERRUPTIBLE);
2631
2632 /* Tell userspace we may need a wakeup call */
Hristo Venev75b28af2019-08-26 17:23:46 +00002633 ctx->rings->sq_flags |= IORING_SQ_NEED_WAKEUP;
Stefan Bühler0d7bae62019-04-19 11:57:45 +02002634 /* make sure to read SQ tail after writing flags */
2635 smp_mb();
Jens Axboe6c271ce2019-01-10 11:22:30 -07002636
2637 if (!io_get_sqring(ctx, &sqes[0])) {
Roman Penyaev2bbcd6d2019-05-16 10:53:57 +02002638 if (kthread_should_park()) {
Jens Axboe6c271ce2019-01-10 11:22:30 -07002639 finish_wait(&ctx->sqo_wait, &wait);
2640 break;
2641 }
2642 if (signal_pending(current))
2643 flush_signals(current);
2644 schedule();
2645 finish_wait(&ctx->sqo_wait, &wait);
2646
Hristo Venev75b28af2019-08-26 17:23:46 +00002647 ctx->rings->sq_flags &= ~IORING_SQ_NEED_WAKEUP;
Jens Axboe6c271ce2019-01-10 11:22:30 -07002648 continue;
2649 }
2650 finish_wait(&ctx->sqo_wait, &wait);
2651
Hristo Venev75b28af2019-08-26 17:23:46 +00002652 ctx->rings->sq_flags &= ~IORING_SQ_NEED_WAKEUP;
Jens Axboe6c271ce2019-01-10 11:22:30 -07002653 }
2654
2655 i = 0;
2656 all_fixed = true;
2657 do {
2658 if (all_fixed && io_sqe_needs_user(sqes[i].sqe))
2659 all_fixed = false;
2660
2661 i++;
2662 if (i == ARRAY_SIZE(sqes))
2663 break;
2664 } while (io_get_sqring(ctx, &sqes[i]));
2665
2666 /* Unless all new commands are FIXED regions, grab mm */
2667 if (!all_fixed && !cur_mm) {
2668 mm_fault = !mmget_not_zero(ctx->sqo_mm);
2669 if (!mm_fault) {
2670 use_mm(ctx->sqo_mm);
2671 cur_mm = ctx->sqo_mm;
2672 }
2673 }
2674
2675 inflight += io_submit_sqes(ctx, sqes, i, cur_mm != NULL,
2676 mm_fault);
2677
2678 /* Commit SQ ring head once we've consumed all SQEs */
2679 io_commit_sqring(ctx);
2680 }
2681
2682 set_fs(old_fs);
2683 if (cur_mm) {
2684 unuse_mm(cur_mm);
2685 mmput(cur_mm);
2686 }
Jens Axboe06058632019-04-13 09:26:03 -06002687
Roman Penyaev2bbcd6d2019-05-16 10:53:57 +02002688 kthread_parkme();
Jens Axboe06058632019-04-13 09:26:03 -06002689
Jens Axboe6c271ce2019-01-10 11:22:30 -07002690 return 0;
2691}
2692
Jens Axboec57666682019-09-09 16:19:45 -06002693static int io_ring_submit(struct io_ring_ctx *ctx, unsigned int to_submit,
2694 bool block_for_last)
Jens Axboe2b188cc2019-01-07 10:46:33 -07002695{
Jens Axboe9a56a232019-01-09 09:06:50 -07002696 struct io_submit_state state, *statep = NULL;
Jens Axboe9e645e112019-05-10 16:07:28 -06002697 struct io_kiocb *link = NULL;
Jackie Liu4fe2c962019-09-09 20:50:40 +08002698 struct io_kiocb *shadow_req = NULL;
Jens Axboe9e645e112019-05-10 16:07:28 -06002699 bool prev_was_link = false;
Jens Axboe5c8b0b52019-04-30 10:16:07 -06002700 int i, submit = 0;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002701
Jens Axboe9a56a232019-01-09 09:06:50 -07002702 if (to_submit > IO_PLUG_THRESHOLD) {
2703 io_submit_state_start(&state, ctx, to_submit);
2704 statep = &state;
2705 }
Jens Axboe2b188cc2019-01-07 10:46:33 -07002706
2707 for (i = 0; i < to_submit; i++) {
Jens Axboec57666682019-09-09 16:19:45 -06002708 bool force_nonblock = true;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002709 struct sqe_submit s;
2710
2711 if (!io_get_sqring(ctx, &s))
2712 break;
2713
Jens Axboe9e645e112019-05-10 16:07:28 -06002714 /*
2715 * If previous wasn't linked and we have a linked command,
2716 * that's the end of the chain. Submit the previous link.
2717 */
2718 if (!prev_was_link && link) {
Jens Axboec57666682019-09-09 16:19:45 -06002719 io_queue_link_head(ctx, link, &link->submit, shadow_req,
2720 force_nonblock);
Jens Axboe9e645e112019-05-10 16:07:28 -06002721 link = NULL;
Jackie Liu5f5ad9c2019-09-18 10:37:53 +08002722 shadow_req = NULL;
Jens Axboe9e645e112019-05-10 16:07:28 -06002723 }
2724 prev_was_link = (s.sqe->flags & IOSQE_IO_LINK) != 0;
2725
Jackie Liu4fe2c962019-09-09 20:50:40 +08002726 if (link && (s.sqe->flags & IOSQE_IO_DRAIN)) {
2727 if (!shadow_req) {
2728 shadow_req = io_get_req(ctx, NULL);
Jackie Liua1041c22019-09-18 17:25:52 +08002729 if (unlikely(!shadow_req))
2730 goto out;
Jackie Liu4fe2c962019-09-09 20:50:40 +08002731 shadow_req->flags |= (REQ_F_IO_DRAIN | REQ_F_SHADOW_DRAIN);
2732 refcount_dec(&shadow_req->refs);
2733 }
2734 shadow_req->sequence = s.sequence;
2735 }
2736
Jackie Liua1041c22019-09-18 17:25:52 +08002737out:
Jens Axboe2b188cc2019-01-07 10:46:33 -07002738 s.has_user = true;
Jens Axboedef596e2019-01-09 08:59:42 -07002739 s.needs_lock = false;
Jens Axboe6c271ce2019-01-10 11:22:30 -07002740 s.needs_fixed_file = false;
Jens Axboe5c8b0b52019-04-30 10:16:07 -06002741 submit++;
Jens Axboec57666682019-09-09 16:19:45 -06002742
2743 /*
2744 * The caller will block for events after submit, submit the
2745 * last IO non-blocking. This is either the only IO it's
2746 * submitting, or it already submitted the previous ones. This
2747 * improves performance by avoiding an async punt that we don't
2748 * need to do.
2749 */
2750 if (block_for_last && submit == to_submit)
2751 force_nonblock = false;
2752
2753 io_submit_sqe(ctx, &s, statep, &link, force_nonblock);
Jens Axboe2b188cc2019-01-07 10:46:33 -07002754 }
2755 io_commit_sqring(ctx);
2756
Jens Axboe9e645e112019-05-10 16:07:28 -06002757 if (link)
Jens Axboec57666682019-09-09 16:19:45 -06002758 io_queue_link_head(ctx, link, &link->submit, shadow_req,
Pavel Begunkovbf7ec932019-10-04 17:01:08 +03002759 !block_for_last);
Jens Axboe9a56a232019-01-09 09:06:50 -07002760 if (statep)
2761 io_submit_state_end(statep);
Jens Axboe2b188cc2019-01-07 10:46:33 -07002762
Jens Axboe5c8b0b52019-04-30 10:16:07 -06002763 return submit;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002764}
2765
Jens Axboe2b188cc2019-01-07 10:46:33 -07002766/*
2767 * Wait until events become available, if we don't already have some. The
2768 * application must reap them itself, as they reside on the shared cq ring.
2769 */
2770static int io_cqring_wait(struct io_ring_ctx *ctx, int min_events,
2771 const sigset_t __user *sig, size_t sigsz)
2772{
Hristo Venev75b28af2019-08-26 17:23:46 +00002773 struct io_rings *rings = ctx->rings;
Jens Axboe5262f562019-09-17 12:26:57 -06002774 unsigned nr_timeouts;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002775 int ret;
2776
Hristo Venev75b28af2019-08-26 17:23:46 +00002777 if (io_cqring_events(rings) >= min_events)
Jens Axboe2b188cc2019-01-07 10:46:33 -07002778 return 0;
2779
2780 if (sig) {
Arnd Bergmann9e75ad52019-03-25 15:34:53 +01002781#ifdef CONFIG_COMPAT
2782 if (in_compat_syscall())
2783 ret = set_compat_user_sigmask((const compat_sigset_t __user *)sig,
Oleg Nesterovb7724342019-07-16 16:29:53 -07002784 sigsz);
Arnd Bergmann9e75ad52019-03-25 15:34:53 +01002785 else
2786#endif
Oleg Nesterovb7724342019-07-16 16:29:53 -07002787 ret = set_user_sigmask(sig, sigsz);
Arnd Bergmann9e75ad52019-03-25 15:34:53 +01002788
Jens Axboe2b188cc2019-01-07 10:46:33 -07002789 if (ret)
2790 return ret;
2791 }
2792
Jens Axboe5262f562019-09-17 12:26:57 -06002793 nr_timeouts = atomic_read(&ctx->cq_timeouts);
2794 /*
2795 * Return if we have enough events, or if a timeout occured since
2796 * we started waiting. For timeouts, we always want to return to
2797 * userspace.
2798 */
2799 ret = wait_event_interruptible(ctx->wait,
2800 io_cqring_events(rings) >= min_events ||
2801 atomic_read(&ctx->cq_timeouts) != nr_timeouts);
Oleg Nesterovb7724342019-07-16 16:29:53 -07002802 restore_saved_sigmask_unless(ret == -ERESTARTSYS);
Oleg Nesterov97abc882019-06-28 12:06:50 -07002803 if (ret == -ERESTARTSYS)
2804 ret = -EINTR;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002805
Hristo Venev75b28af2019-08-26 17:23:46 +00002806 return READ_ONCE(rings->cq.head) == READ_ONCE(rings->cq.tail) ? ret : 0;
Jens Axboe2b188cc2019-01-07 10:46:33 -07002807}
2808
Jens Axboe6b063142019-01-10 22:13:58 -07002809static void __io_sqe_files_unregister(struct io_ring_ctx *ctx)
2810{
2811#if defined(CONFIG_UNIX)
2812 if (ctx->ring_sock) {
2813 struct sock *sock = ctx->ring_sock->sk;
2814 struct sk_buff *skb;
2815
2816 while ((skb = skb_dequeue(&sock->sk_receive_queue)) != NULL)
2817 kfree_skb(skb);
2818 }
2819#else
2820 int i;
2821
2822 for (i = 0; i < ctx->nr_user_files; i++)
2823 fput(ctx->user_files[i]);
2824#endif
2825}
2826
2827static int io_sqe_files_unregister(struct io_ring_ctx *ctx)
2828{
2829 if (!ctx->user_files)
2830 return -ENXIO;
2831
2832 __io_sqe_files_unregister(ctx);
2833 kfree(ctx->user_files);
2834 ctx->user_files = NULL;
2835 ctx->nr_user_files = 0;
2836 return 0;
2837}
2838
Jens Axboe6c271ce2019-01-10 11:22:30 -07002839static void io_sq_thread_stop(struct io_ring_ctx *ctx)
2840{
2841 if (ctx->sqo_thread) {
Jackie Liua4c0b3d2019-07-08 13:41:12 +08002842 wait_for_completion(&ctx->sqo_thread_started);
Roman Penyaev2bbcd6d2019-05-16 10:53:57 +02002843 /*
2844 * The park is a bit of a work-around, without it we get
2845 * warning spews on shutdown with SQPOLL set and affinity
2846 * set to a single CPU.
2847 */
Jens Axboe06058632019-04-13 09:26:03 -06002848 kthread_park(ctx->sqo_thread);
Jens Axboe6c271ce2019-01-10 11:22:30 -07002849 kthread_stop(ctx->sqo_thread);
2850 ctx->sqo_thread = NULL;
2851 }
2852}
2853
Jens Axboe6b063142019-01-10 22:13:58 -07002854static void io_finish_async(struct io_ring_ctx *ctx)
2855{
Jens Axboe54a91f32019-09-10 09:15:04 -06002856 int i;
2857
Jens Axboe6c271ce2019-01-10 11:22:30 -07002858 io_sq_thread_stop(ctx);
2859
Jens Axboe54a91f32019-09-10 09:15:04 -06002860 for (i = 0; i < ARRAY_SIZE(ctx->sqo_wq); i++) {
2861 if (ctx->sqo_wq[i]) {
2862 destroy_workqueue(ctx->sqo_wq[i]);
2863 ctx->sqo_wq[i] = NULL;
2864 }
Jens Axboe6b063142019-01-10 22:13:58 -07002865 }
2866}
2867
2868#if defined(CONFIG_UNIX)
2869static void io_destruct_skb(struct sk_buff *skb)
2870{
2871 struct io_ring_ctx *ctx = skb->sk->sk_user_data;
Jens Axboe8a997342019-10-09 14:40:13 -06002872 int i;
Jens Axboe6b063142019-01-10 22:13:58 -07002873
Jens Axboe8a997342019-10-09 14:40:13 -06002874 for (i = 0; i < ARRAY_SIZE(ctx->sqo_wq); i++)
2875 if (ctx->sqo_wq[i])
2876 flush_workqueue(ctx->sqo_wq[i]);
2877
Jens Axboe6b063142019-01-10 22:13:58 -07002878 unix_destruct_scm(skb);
2879}
2880
2881/*
2882 * Ensure the UNIX gc is aware of our file set, so we are certain that
2883 * the io_uring can be safely unregistered on process exit, even if we have
2884 * loops in the file referencing.
2885 */
2886static int __io_sqe_files_scm(struct io_ring_ctx *ctx, int nr, int offset)
2887{
2888 struct sock *sk = ctx->ring_sock->sk;
2889 struct scm_fp_list *fpl;
2890 struct sk_buff *skb;
2891 int i;
2892
2893 if (!capable(CAP_SYS_RESOURCE) && !capable(CAP_SYS_ADMIN)) {
2894 unsigned long inflight = ctx->user->unix_inflight + nr;
2895
2896 if (inflight > task_rlimit(current, RLIMIT_NOFILE))
2897 return -EMFILE;
2898 }
2899
2900 fpl = kzalloc(sizeof(*fpl), GFP_KERNEL);
2901 if (!fpl)
2902 return -ENOMEM;
2903
2904 skb = alloc_skb(0, GFP_KERNEL);
2905 if (!skb) {
2906 kfree(fpl);
2907 return -ENOMEM;
2908 }
2909
2910 skb->sk = sk;
2911 skb->destructor = io_destruct_skb;
2912
2913 fpl->user = get_uid(ctx->user);
2914 for (i = 0; i < nr; i++) {
2915 fpl->fp[i] = get_file(ctx->user_files[i + offset]);
2916 unix_inflight(fpl->user, fpl->fp[i]);
2917 }
2918
2919 fpl->max = fpl->count = nr;
2920 UNIXCB(skb).fp = fpl;
2921 refcount_add(skb->truesize, &sk->sk_wmem_alloc);
2922 skb_queue_head(&sk->sk_receive_queue, skb);
2923
2924 for (i = 0; i < nr; i++)
2925 fput(fpl->fp[i]);
2926
2927 return 0;
2928}
2929
2930/*
2931 * If UNIX sockets are enabled, fd passing can cause a reference cycle which
2932 * causes regular reference counting to break down. We rely on the UNIX
2933 * garbage collection to take care of this problem for us.
2934 */
2935static int io_sqe_files_scm(struct io_ring_ctx *ctx)
2936{
2937 unsigned left, total;
2938 int ret = 0;
2939
2940 total = 0;
2941 left = ctx->nr_user_files;
2942 while (left) {
2943 unsigned this_files = min_t(unsigned, left, SCM_MAX_FD);
Jens Axboe6b063142019-01-10 22:13:58 -07002944
2945 ret = __io_sqe_files_scm(ctx, this_files, total);
2946 if (ret)
2947 break;
2948 left -= this_files;
2949 total += this_files;
2950 }
2951
2952 if (!ret)
2953 return 0;
2954
2955 while (total < ctx->nr_user_files) {
2956 fput(ctx->user_files[total]);
2957 total++;
2958 }
2959
2960 return ret;
2961}
2962#else
2963static int io_sqe_files_scm(struct io_ring_ctx *ctx)
2964{
2965 return 0;
2966}
2967#endif
2968
2969static int io_sqe_files_register(struct io_ring_ctx *ctx, void __user *arg,
2970 unsigned nr_args)
2971{
2972 __s32 __user *fds = (__s32 __user *) arg;
2973 int fd, ret = 0;
2974 unsigned i;
2975
2976 if (ctx->user_files)
2977 return -EBUSY;
2978 if (!nr_args)
2979 return -EINVAL;
2980 if (nr_args > IORING_MAX_FIXED_FILES)
2981 return -EMFILE;
2982
2983 ctx->user_files = kcalloc(nr_args, sizeof(struct file *), GFP_KERNEL);
2984 if (!ctx->user_files)
2985 return -ENOMEM;
2986
2987 for (i = 0; i < nr_args; i++) {
2988 ret = -EFAULT;
2989 if (copy_from_user(&fd, &fds[i], sizeof(fd)))
2990 break;
2991
2992 ctx->user_files[i] = fget(fd);
2993
2994 ret = -EBADF;
2995 if (!ctx->user_files[i])
2996 break;
2997 /*
2998 * Don't allow io_uring instances to be registered. If UNIX
2999 * isn't enabled, then this causes a reference cycle and this
3000 * instance can never get freed. If UNIX is enabled we'll
3001 * handle it just fine, but there's still no point in allowing
3002 * a ring fd as it doesn't support regular read/write anyway.
3003 */
3004 if (ctx->user_files[i]->f_op == &io_uring_fops) {
3005 fput(ctx->user_files[i]);
3006 break;
3007 }
3008 ctx->nr_user_files++;
3009 ret = 0;
3010 }
3011
3012 if (ret) {
3013 for (i = 0; i < ctx->nr_user_files; i++)
3014 fput(ctx->user_files[i]);
3015
3016 kfree(ctx->user_files);
Jens Axboe25adf502019-04-03 09:52:40 -06003017 ctx->user_files = NULL;
Jens Axboe6b063142019-01-10 22:13:58 -07003018 ctx->nr_user_files = 0;
3019 return ret;
3020 }
3021
3022 ret = io_sqe_files_scm(ctx);
3023 if (ret)
3024 io_sqe_files_unregister(ctx);
3025
3026 return ret;
3027}
3028
Jens Axboe6c271ce2019-01-10 11:22:30 -07003029static int io_sq_offload_start(struct io_ring_ctx *ctx,
3030 struct io_uring_params *p)
Jens Axboe2b188cc2019-01-07 10:46:33 -07003031{
3032 int ret;
3033
Jens Axboe6c271ce2019-01-10 11:22:30 -07003034 init_waitqueue_head(&ctx->sqo_wait);
Jens Axboe2b188cc2019-01-07 10:46:33 -07003035 mmgrab(current->mm);
3036 ctx->sqo_mm = current->mm;
3037
Jens Axboe6c271ce2019-01-10 11:22:30 -07003038 if (ctx->flags & IORING_SETUP_SQPOLL) {
Jens Axboe3ec482d2019-04-08 10:51:01 -06003039 ret = -EPERM;
3040 if (!capable(CAP_SYS_ADMIN))
3041 goto err;
3042
Jens Axboe917257d2019-04-13 09:28:55 -06003043 ctx->sq_thread_idle = msecs_to_jiffies(p->sq_thread_idle);
3044 if (!ctx->sq_thread_idle)
3045 ctx->sq_thread_idle = HZ;
3046
Jens Axboe6c271ce2019-01-10 11:22:30 -07003047 if (p->flags & IORING_SETUP_SQ_AFF) {
Jens Axboe44a9bd12019-05-14 20:00:30 -06003048 int cpu = p->sq_thread_cpu;
Jens Axboe6c271ce2019-01-10 11:22:30 -07003049
Jens Axboe917257d2019-04-13 09:28:55 -06003050 ret = -EINVAL;
Jens Axboe44a9bd12019-05-14 20:00:30 -06003051 if (cpu >= nr_cpu_ids)
3052 goto err;
Shenghui Wang7889f442019-05-07 16:03:19 +08003053 if (!cpu_online(cpu))
Jens Axboe917257d2019-04-13 09:28:55 -06003054 goto err;
3055
Jens Axboe6c271ce2019-01-10 11:22:30 -07003056 ctx->sqo_thread = kthread_create_on_cpu(io_sq_thread,
3057 ctx, cpu,
3058 "io_uring-sq");
3059 } else {
3060 ctx->sqo_thread = kthread_create(io_sq_thread, ctx,
3061 "io_uring-sq");
3062 }
3063 if (IS_ERR(ctx->sqo_thread)) {
3064 ret = PTR_ERR(ctx->sqo_thread);
3065 ctx->sqo_thread = NULL;
3066 goto err;
3067 }
3068 wake_up_process(ctx->sqo_thread);
3069 } else if (p->flags & IORING_SETUP_SQ_AFF) {
3070 /* Can't have SQ_AFF without SQPOLL */
3071 ret = -EINVAL;
3072 goto err;
3073 }
3074
Jens Axboe2b188cc2019-01-07 10:46:33 -07003075 /* Do QD, or 2 * CPUS, whatever is smallest */
Jens Axboe54a91f32019-09-10 09:15:04 -06003076 ctx->sqo_wq[0] = alloc_workqueue("io_ring-wq",
3077 WQ_UNBOUND | WQ_FREEZABLE,
Jens Axboe2b188cc2019-01-07 10:46:33 -07003078 min(ctx->sq_entries - 1, 2 * num_online_cpus()));
Jens Axboe54a91f32019-09-10 09:15:04 -06003079 if (!ctx->sqo_wq[0]) {
3080 ret = -ENOMEM;
3081 goto err;
3082 }
3083
3084 /*
3085 * This is for buffered writes, where we want to limit the parallelism
3086 * due to file locking in file systems. As "normal" buffered writes
3087 * should parellelize on writeout quite nicely, limit us to having 2
3088 * pending. This avoids massive contention on the inode when doing
3089 * buffered async writes.
3090 */
3091 ctx->sqo_wq[1] = alloc_workqueue("io_ring-write-wq",
3092 WQ_UNBOUND | WQ_FREEZABLE, 2);
3093 if (!ctx->sqo_wq[1]) {
Jens Axboe2b188cc2019-01-07 10:46:33 -07003094 ret = -ENOMEM;
3095 goto err;
3096 }
3097
3098 return 0;
3099err:
Jens Axboe54a91f32019-09-10 09:15:04 -06003100 io_finish_async(ctx);
Jens Axboe2b188cc2019-01-07 10:46:33 -07003101 mmdrop(ctx->sqo_mm);
3102 ctx->sqo_mm = NULL;
3103 return ret;
3104}
3105
3106static void io_unaccount_mem(struct user_struct *user, unsigned long nr_pages)
3107{
3108 atomic_long_sub(nr_pages, &user->locked_vm);
3109}
3110
3111static int io_account_mem(struct user_struct *user, unsigned long nr_pages)
3112{
3113 unsigned long page_limit, cur_pages, new_pages;
3114
3115 /* Don't allow more pages than we can safely lock */
3116 page_limit = rlimit(RLIMIT_MEMLOCK) >> PAGE_SHIFT;
3117
3118 do {
3119 cur_pages = atomic_long_read(&user->locked_vm);
3120 new_pages = cur_pages + nr_pages;
3121 if (new_pages > page_limit)
3122 return -ENOMEM;
3123 } while (atomic_long_cmpxchg(&user->locked_vm, cur_pages,
3124 new_pages) != cur_pages);
3125
3126 return 0;
3127}
3128
3129static void io_mem_free(void *ptr)
3130{
Mark Rutland52e04ef2019-04-30 17:30:21 +01003131 struct page *page;
Jens Axboe2b188cc2019-01-07 10:46:33 -07003132
Mark Rutland52e04ef2019-04-30 17:30:21 +01003133 if (!ptr)
3134 return;
3135
3136 page = virt_to_head_page(ptr);
Jens Axboe2b188cc2019-01-07 10:46:33 -07003137 if (put_page_testzero(page))
3138 free_compound_page(page);
3139}
3140
3141static void *io_mem_alloc(size_t size)
3142{
3143 gfp_t gfp_flags = GFP_KERNEL | __GFP_ZERO | __GFP_NOWARN | __GFP_COMP |
3144 __GFP_NORETRY;
3145
3146 return (void *) __get_free_pages(gfp_flags, get_order(size));
3147}
3148
Hristo Venev75b28af2019-08-26 17:23:46 +00003149static unsigned long rings_size(unsigned sq_entries, unsigned cq_entries,
3150 size_t *sq_offset)
3151{
3152 struct io_rings *rings;
3153 size_t off, sq_array_size;
3154
3155 off = struct_size(rings, cqes, cq_entries);
3156 if (off == SIZE_MAX)
3157 return SIZE_MAX;
3158
3159#ifdef CONFIG_SMP
3160 off = ALIGN(off, SMP_CACHE_BYTES);
3161 if (off == 0)
3162 return SIZE_MAX;
3163#endif
3164
3165 sq_array_size = array_size(sizeof(u32), sq_entries);
3166 if (sq_array_size == SIZE_MAX)
3167 return SIZE_MAX;
3168
3169 if (check_add_overflow(off, sq_array_size, &off))
3170 return SIZE_MAX;
3171
3172 if (sq_offset)
3173 *sq_offset = off;
3174
3175 return off;
3176}
3177
Jens Axboe2b188cc2019-01-07 10:46:33 -07003178static unsigned long ring_pages(unsigned sq_entries, unsigned cq_entries)
3179{
Hristo Venev75b28af2019-08-26 17:23:46 +00003180 size_t pages;
Jens Axboe2b188cc2019-01-07 10:46:33 -07003181
Hristo Venev75b28af2019-08-26 17:23:46 +00003182 pages = (size_t)1 << get_order(
3183 rings_size(sq_entries, cq_entries, NULL));
3184 pages += (size_t)1 << get_order(
3185 array_size(sizeof(struct io_uring_sqe), sq_entries));
Jens Axboe2b188cc2019-01-07 10:46:33 -07003186
Hristo Venev75b28af2019-08-26 17:23:46 +00003187 return pages;
Jens Axboe2b188cc2019-01-07 10:46:33 -07003188}
3189
Jens Axboeedafcce2019-01-09 09:16:05 -07003190static int io_sqe_buffer_unregister(struct io_ring_ctx *ctx)
3191{
3192 int i, j;
3193
3194 if (!ctx->user_bufs)
3195 return -ENXIO;
3196
3197 for (i = 0; i < ctx->nr_user_bufs; i++) {
3198 struct io_mapped_ubuf *imu = &ctx->user_bufs[i];
3199
3200 for (j = 0; j < imu->nr_bvecs; j++)
John Hubbard27c4d3a2019-08-04 19:32:06 -07003201 put_user_page(imu->bvec[j].bv_page);
Jens Axboeedafcce2019-01-09 09:16:05 -07003202
3203 if (ctx->account_mem)
3204 io_unaccount_mem(ctx->user, imu->nr_bvecs);
Mark Rutlandd4ef6472019-05-01 16:59:16 +01003205 kvfree(imu->bvec);
Jens Axboeedafcce2019-01-09 09:16:05 -07003206 imu->nr_bvecs = 0;
3207 }
3208
3209 kfree(ctx->user_bufs);
3210 ctx->user_bufs = NULL;
3211 ctx->nr_user_bufs = 0;
3212 return 0;
3213}
3214
3215static int io_copy_iov(struct io_ring_ctx *ctx, struct iovec *dst,
3216 void __user *arg, unsigned index)
3217{
3218 struct iovec __user *src;
3219
3220#ifdef CONFIG_COMPAT
3221 if (ctx->compat) {
3222 struct compat_iovec __user *ciovs;
3223 struct compat_iovec ciov;
3224
3225 ciovs = (struct compat_iovec __user *) arg;
3226 if (copy_from_user(&ciov, &ciovs[index], sizeof(ciov)))
3227 return -EFAULT;
3228
3229 dst->iov_base = (void __user *) (unsigned long) ciov.iov_base;
3230 dst->iov_len = ciov.iov_len;
3231 return 0;
3232 }
3233#endif
3234 src = (struct iovec __user *) arg;
3235 if (copy_from_user(dst, &src[index], sizeof(*dst)))
3236 return -EFAULT;
3237 return 0;
3238}
3239
3240static int io_sqe_buffer_register(struct io_ring_ctx *ctx, void __user *arg,
3241 unsigned nr_args)
3242{
3243 struct vm_area_struct **vmas = NULL;
3244 struct page **pages = NULL;
3245 int i, j, got_pages = 0;
3246 int ret = -EINVAL;
3247
3248 if (ctx->user_bufs)
3249 return -EBUSY;
3250 if (!nr_args || nr_args > UIO_MAXIOV)
3251 return -EINVAL;
3252
3253 ctx->user_bufs = kcalloc(nr_args, sizeof(struct io_mapped_ubuf),
3254 GFP_KERNEL);
3255 if (!ctx->user_bufs)
3256 return -ENOMEM;
3257
3258 for (i = 0; i < nr_args; i++) {
3259 struct io_mapped_ubuf *imu = &ctx->user_bufs[i];
3260 unsigned long off, start, end, ubuf;
3261 int pret, nr_pages;
3262 struct iovec iov;
3263 size_t size;
3264
3265 ret = io_copy_iov(ctx, &iov, arg, i);
3266 if (ret)
Pavel Begunkova2786822019-05-26 12:35:47 +03003267 goto err;
Jens Axboeedafcce2019-01-09 09:16:05 -07003268
3269 /*
3270 * Don't impose further limits on the size and buffer
3271 * constraints here, we'll -EINVAL later when IO is
3272 * submitted if they are wrong.
3273 */
3274 ret = -EFAULT;
3275 if (!iov.iov_base || !iov.iov_len)
3276 goto err;
3277
3278 /* arbitrary limit, but we need something */
3279 if (iov.iov_len > SZ_1G)
3280 goto err;
3281
3282 ubuf = (unsigned long) iov.iov_base;
3283 end = (ubuf + iov.iov_len + PAGE_SIZE - 1) >> PAGE_SHIFT;
3284 start = ubuf >> PAGE_SHIFT;
3285 nr_pages = end - start;
3286
3287 if (ctx->account_mem) {
3288 ret = io_account_mem(ctx->user, nr_pages);
3289 if (ret)
3290 goto err;
3291 }
3292
3293 ret = 0;
3294 if (!pages || nr_pages > got_pages) {
3295 kfree(vmas);
3296 kfree(pages);
Mark Rutlandd4ef6472019-05-01 16:59:16 +01003297 pages = kvmalloc_array(nr_pages, sizeof(struct page *),
Jens Axboeedafcce2019-01-09 09:16:05 -07003298 GFP_KERNEL);
Mark Rutlandd4ef6472019-05-01 16:59:16 +01003299 vmas = kvmalloc_array(nr_pages,
Jens Axboeedafcce2019-01-09 09:16:05 -07003300 sizeof(struct vm_area_struct *),
3301 GFP_KERNEL);
3302 if (!pages || !vmas) {
3303 ret = -ENOMEM;
3304 if (ctx->account_mem)
3305 io_unaccount_mem(ctx->user, nr_pages);
3306 goto err;
3307 }
3308 got_pages = nr_pages;
3309 }
3310
Mark Rutlandd4ef6472019-05-01 16:59:16 +01003311 imu->bvec = kvmalloc_array(nr_pages, sizeof(struct bio_vec),
Jens Axboeedafcce2019-01-09 09:16:05 -07003312 GFP_KERNEL);
3313 ret = -ENOMEM;
3314 if (!imu->bvec) {
3315 if (ctx->account_mem)
3316 io_unaccount_mem(ctx->user, nr_pages);
3317 goto err;
3318 }
3319
3320 ret = 0;
3321 down_read(&current->mm->mmap_sem);
Ira Weiny932f4a62019-05-13 17:17:03 -07003322 pret = get_user_pages(ubuf, nr_pages,
3323 FOLL_WRITE | FOLL_LONGTERM,
3324 pages, vmas);
Jens Axboeedafcce2019-01-09 09:16:05 -07003325 if (pret == nr_pages) {
3326 /* don't support file backed memory */
3327 for (j = 0; j < nr_pages; j++) {
3328 struct vm_area_struct *vma = vmas[j];
3329
3330 if (vma->vm_file &&
3331 !is_file_hugepages(vma->vm_file)) {
3332 ret = -EOPNOTSUPP;
3333 break;
3334 }
3335 }
3336 } else {
3337 ret = pret < 0 ? pret : -EFAULT;
3338 }
3339 up_read(&current->mm->mmap_sem);
3340 if (ret) {
3341 /*
3342 * if we did partial map, or found file backed vmas,
3343 * release any pages we did get
3344 */
John Hubbard27c4d3a2019-08-04 19:32:06 -07003345 if (pret > 0)
3346 put_user_pages(pages, pret);
Jens Axboeedafcce2019-01-09 09:16:05 -07003347 if (ctx->account_mem)
3348 io_unaccount_mem(ctx->user, nr_pages);
Mark Rutlandd4ef6472019-05-01 16:59:16 +01003349 kvfree(imu->bvec);
Jens Axboeedafcce2019-01-09 09:16:05 -07003350 goto err;
3351 }
3352
3353 off = ubuf & ~PAGE_MASK;
3354 size = iov.iov_len;
3355 for (j = 0; j < nr_pages; j++) {
3356 size_t vec_len;
3357
3358 vec_len = min_t(size_t, size, PAGE_SIZE - off);
3359 imu->bvec[j].bv_page = pages[j];
3360 imu->bvec[j].bv_len = vec_len;
3361 imu->bvec[j].bv_offset = off;
3362 off = 0;
3363 size -= vec_len;
3364 }
3365 /* store original address for later verification */
3366 imu->ubuf = ubuf;
3367 imu->len = iov.iov_len;
3368 imu->nr_bvecs = nr_pages;
3369
3370 ctx->nr_user_bufs++;
3371 }
Mark Rutlandd4ef6472019-05-01 16:59:16 +01003372 kvfree(pages);
3373 kvfree(vmas);
Jens Axboeedafcce2019-01-09 09:16:05 -07003374 return 0;
3375err:
Mark Rutlandd4ef6472019-05-01 16:59:16 +01003376 kvfree(pages);
3377 kvfree(vmas);
Jens Axboeedafcce2019-01-09 09:16:05 -07003378 io_sqe_buffer_unregister(ctx);
3379 return ret;
3380}
3381
Jens Axboe9b402842019-04-11 11:45:41 -06003382static int io_eventfd_register(struct io_ring_ctx *ctx, void __user *arg)
3383{
3384 __s32 __user *fds = arg;
3385 int fd;
3386
3387 if (ctx->cq_ev_fd)
3388 return -EBUSY;
3389
3390 if (copy_from_user(&fd, fds, sizeof(*fds)))
3391 return -EFAULT;
3392
3393 ctx->cq_ev_fd = eventfd_ctx_fdget(fd);
3394 if (IS_ERR(ctx->cq_ev_fd)) {
3395 int ret = PTR_ERR(ctx->cq_ev_fd);
3396 ctx->cq_ev_fd = NULL;
3397 return ret;
3398 }
3399
3400 return 0;
3401}
3402
3403static int io_eventfd_unregister(struct io_ring_ctx *ctx)
3404{
3405 if (ctx->cq_ev_fd) {
3406 eventfd_ctx_put(ctx->cq_ev_fd);
3407 ctx->cq_ev_fd = NULL;
3408 return 0;
3409 }
3410
3411 return -ENXIO;
3412}
3413
Jens Axboe2b188cc2019-01-07 10:46:33 -07003414static void io_ring_ctx_free(struct io_ring_ctx *ctx)
3415{
Jens Axboe6b063142019-01-10 22:13:58 -07003416 io_finish_async(ctx);
Jens Axboe2b188cc2019-01-07 10:46:33 -07003417 if (ctx->sqo_mm)
3418 mmdrop(ctx->sqo_mm);
Jens Axboedef596e2019-01-09 08:59:42 -07003419
3420 io_iopoll_reap_events(ctx);
Jens Axboeedafcce2019-01-09 09:16:05 -07003421 io_sqe_buffer_unregister(ctx);
Jens Axboe6b063142019-01-10 22:13:58 -07003422 io_sqe_files_unregister(ctx);
Jens Axboe9b402842019-04-11 11:45:41 -06003423 io_eventfd_unregister(ctx);
Jens Axboedef596e2019-01-09 08:59:42 -07003424
Jens Axboe2b188cc2019-01-07 10:46:33 -07003425#if defined(CONFIG_UNIX)
Eric Biggers355e8d22019-06-12 14:58:43 -07003426 if (ctx->ring_sock) {
3427 ctx->ring_sock->file = NULL; /* so that iput() is called */
Jens Axboe2b188cc2019-01-07 10:46:33 -07003428 sock_release(ctx->ring_sock);
Eric Biggers355e8d22019-06-12 14:58:43 -07003429 }
Jens Axboe2b188cc2019-01-07 10:46:33 -07003430#endif
3431
Hristo Venev75b28af2019-08-26 17:23:46 +00003432 io_mem_free(ctx->rings);
Jens Axboe2b188cc2019-01-07 10:46:33 -07003433 io_mem_free(ctx->sq_sqes);
Jens Axboe2b188cc2019-01-07 10:46:33 -07003434
3435 percpu_ref_exit(&ctx->refs);
3436 if (ctx->account_mem)
3437 io_unaccount_mem(ctx->user,
3438 ring_pages(ctx->sq_entries, ctx->cq_entries));
3439 free_uid(ctx->user);
3440 kfree(ctx);
3441}
3442
3443static __poll_t io_uring_poll(struct file *file, poll_table *wait)
3444{
3445 struct io_ring_ctx *ctx = file->private_data;
3446 __poll_t mask = 0;
3447
3448 poll_wait(file, &ctx->cq_wait, wait);
Stefan Bühler4f7067c2019-04-24 23:54:17 +02003449 /*
3450 * synchronizes with barrier from wq_has_sleeper call in
3451 * io_commit_cqring
3452 */
Jens Axboe2b188cc2019-01-07 10:46:33 -07003453 smp_rmb();
Hristo Venev75b28af2019-08-26 17:23:46 +00003454 if (READ_ONCE(ctx->rings->sq.tail) - ctx->cached_sq_head !=
3455 ctx->rings->sq_ring_entries)
Jens Axboe2b188cc2019-01-07 10:46:33 -07003456 mask |= EPOLLOUT | EPOLLWRNORM;
Hristo Venev75b28af2019-08-26 17:23:46 +00003457 if (READ_ONCE(ctx->rings->sq.head) != ctx->cached_cq_tail)
Jens Axboe2b188cc2019-01-07 10:46:33 -07003458 mask |= EPOLLIN | EPOLLRDNORM;
3459
3460 return mask;
3461}
3462
3463static int io_uring_fasync(int fd, struct file *file, int on)
3464{
3465 struct io_ring_ctx *ctx = file->private_data;
3466
3467 return fasync_helper(fd, file, on, &ctx->cq_fasync);
3468}
3469
3470static void io_ring_ctx_wait_and_kill(struct io_ring_ctx *ctx)
3471{
3472 mutex_lock(&ctx->uring_lock);
3473 percpu_ref_kill(&ctx->refs);
3474 mutex_unlock(&ctx->uring_lock);
3475
Jens Axboe5262f562019-09-17 12:26:57 -06003476 io_kill_timeouts(ctx);
Jens Axboe221c5eb2019-01-17 09:41:58 -07003477 io_poll_remove_all(ctx);
Jens Axboedef596e2019-01-09 08:59:42 -07003478 io_iopoll_reap_events(ctx);
Jens Axboe2b188cc2019-01-07 10:46:33 -07003479 wait_for_completion(&ctx->ctx_done);
3480 io_ring_ctx_free(ctx);
3481}
3482
3483static int io_uring_release(struct inode *inode, struct file *file)
3484{
3485 struct io_ring_ctx *ctx = file->private_data;
3486
3487 file->private_data = NULL;
3488 io_ring_ctx_wait_and_kill(ctx);
3489 return 0;
3490}
3491
3492static int io_uring_mmap(struct file *file, struct vm_area_struct *vma)
3493{
3494 loff_t offset = (loff_t) vma->vm_pgoff << PAGE_SHIFT;
3495 unsigned long sz = vma->vm_end - vma->vm_start;
3496 struct io_ring_ctx *ctx = file->private_data;
3497 unsigned long pfn;
3498 struct page *page;
3499 void *ptr;
3500
3501 switch (offset) {
3502 case IORING_OFF_SQ_RING:
Hristo Venev75b28af2019-08-26 17:23:46 +00003503 case IORING_OFF_CQ_RING:
3504 ptr = ctx->rings;
Jens Axboe2b188cc2019-01-07 10:46:33 -07003505 break;
3506 case IORING_OFF_SQES:
3507 ptr = ctx->sq_sqes;
3508 break;
Jens Axboe2b188cc2019-01-07 10:46:33 -07003509 default:
3510 return -EINVAL;
3511 }
3512
3513 page = virt_to_head_page(ptr);
Matthew Wilcox (Oracle)a50b8542019-09-23 15:34:25 -07003514 if (sz > page_size(page))
Jens Axboe2b188cc2019-01-07 10:46:33 -07003515 return -EINVAL;
3516
3517 pfn = virt_to_phys(ptr) >> PAGE_SHIFT;
3518 return remap_pfn_range(vma, vma->vm_start, pfn, sz, vma->vm_page_prot);
3519}
3520
3521SYSCALL_DEFINE6(io_uring_enter, unsigned int, fd, u32, to_submit,
3522 u32, min_complete, u32, flags, const sigset_t __user *, sig,
3523 size_t, sigsz)
3524{
3525 struct io_ring_ctx *ctx;
3526 long ret = -EBADF;
3527 int submitted = 0;
3528 struct fd f;
3529
Jens Axboe6c271ce2019-01-10 11:22:30 -07003530 if (flags & ~(IORING_ENTER_GETEVENTS | IORING_ENTER_SQ_WAKEUP))
Jens Axboe2b188cc2019-01-07 10:46:33 -07003531 return -EINVAL;
3532
3533 f = fdget(fd);
3534 if (!f.file)
3535 return -EBADF;
3536
3537 ret = -EOPNOTSUPP;
3538 if (f.file->f_op != &io_uring_fops)
3539 goto out_fput;
3540
3541 ret = -ENXIO;
3542 ctx = f.file->private_data;
3543 if (!percpu_ref_tryget(&ctx->refs))
3544 goto out_fput;
3545
Jens Axboe6c271ce2019-01-10 11:22:30 -07003546 /*
3547 * For SQ polling, the thread will do all submissions and completions.
3548 * Just return the requested submit count, and wake the thread if
3549 * we were asked to.
3550 */
Jens Axboeb2a9ead2019-09-12 14:19:16 -06003551 ret = 0;
Jens Axboe6c271ce2019-01-10 11:22:30 -07003552 if (ctx->flags & IORING_SETUP_SQPOLL) {
3553 if (flags & IORING_ENTER_SQ_WAKEUP)
3554 wake_up(&ctx->sqo_wait);
3555 submitted = to_submit;
Jens Axboeb2a9ead2019-09-12 14:19:16 -06003556 } else if (to_submit) {
Jens Axboec57666682019-09-09 16:19:45 -06003557 bool block_for_last = false;
3558
Jens Axboe2b188cc2019-01-07 10:46:33 -07003559 to_submit = min(to_submit, ctx->sq_entries);
3560
Jens Axboec57666682019-09-09 16:19:45 -06003561 /*
3562 * Allow last submission to block in a series, IFF the caller
3563 * asked to wait for events and we don't currently have
3564 * enough. This potentially avoids an async punt.
3565 */
3566 if (to_submit == min_complete &&
3567 io_cqring_events(ctx->rings) < min_complete)
3568 block_for_last = true;
3569
Jens Axboe2b188cc2019-01-07 10:46:33 -07003570 mutex_lock(&ctx->uring_lock);
Jens Axboec57666682019-09-09 16:19:45 -06003571 submitted = io_ring_submit(ctx, to_submit, block_for_last);
Jens Axboe2b188cc2019-01-07 10:46:33 -07003572 mutex_unlock(&ctx->uring_lock);
Jens Axboe2b188cc2019-01-07 10:46:33 -07003573 }
3574 if (flags & IORING_ENTER_GETEVENTS) {
Jens Axboedef596e2019-01-09 08:59:42 -07003575 unsigned nr_events = 0;
3576
Jens Axboe2b188cc2019-01-07 10:46:33 -07003577 min_complete = min(min_complete, ctx->cq_entries);
3578
Jens Axboedef596e2019-01-09 08:59:42 -07003579 if (ctx->flags & IORING_SETUP_IOPOLL) {
Jens Axboedef596e2019-01-09 08:59:42 -07003580 ret = io_iopoll_check(ctx, &nr_events, min_complete);
Jens Axboedef596e2019-01-09 08:59:42 -07003581 } else {
3582 ret = io_cqring_wait(ctx, min_complete, sig, sigsz);
3583 }
Jens Axboe2b188cc2019-01-07 10:46:33 -07003584 }
3585
Pavel Begunkov6805b322019-10-08 02:18:42 +03003586 percpu_ref_put(&ctx->refs);
Jens Axboe2b188cc2019-01-07 10:46:33 -07003587out_fput:
3588 fdput(f);
3589 return submitted ? submitted : ret;
3590}
3591
3592static const struct file_operations io_uring_fops = {
3593 .release = io_uring_release,
3594 .mmap = io_uring_mmap,
3595 .poll = io_uring_poll,
3596 .fasync = io_uring_fasync,
3597};
3598
3599static int io_allocate_scq_urings(struct io_ring_ctx *ctx,
3600 struct io_uring_params *p)
3601{
Hristo Venev75b28af2019-08-26 17:23:46 +00003602 struct io_rings *rings;
3603 size_t size, sq_array_offset;
Jens Axboe2b188cc2019-01-07 10:46:33 -07003604
Hristo Venev75b28af2019-08-26 17:23:46 +00003605 size = rings_size(p->sq_entries, p->cq_entries, &sq_array_offset);
3606 if (size == SIZE_MAX)
3607 return -EOVERFLOW;
3608
3609 rings = io_mem_alloc(size);
3610 if (!rings)
Jens Axboe2b188cc2019-01-07 10:46:33 -07003611 return -ENOMEM;
3612
Hristo Venev75b28af2019-08-26 17:23:46 +00003613 ctx->rings = rings;
3614 ctx->sq_array = (u32 *)((char *)rings + sq_array_offset);
3615 rings->sq_ring_mask = p->sq_entries - 1;
3616 rings->cq_ring_mask = p->cq_entries - 1;
3617 rings->sq_ring_entries = p->sq_entries;
3618 rings->cq_ring_entries = p->cq_entries;
3619 ctx->sq_mask = rings->sq_ring_mask;
3620 ctx->cq_mask = rings->cq_ring_mask;
3621 ctx->sq_entries = rings->sq_ring_entries;
3622 ctx->cq_entries = rings->cq_ring_entries;
Jens Axboe2b188cc2019-01-07 10:46:33 -07003623
3624 size = array_size(sizeof(struct io_uring_sqe), p->sq_entries);
3625 if (size == SIZE_MAX)
3626 return -EOVERFLOW;
3627
3628 ctx->sq_sqes = io_mem_alloc(size);
Mark Rutland52e04ef2019-04-30 17:30:21 +01003629 if (!ctx->sq_sqes)
Jens Axboe2b188cc2019-01-07 10:46:33 -07003630 return -ENOMEM;
Jens Axboe2b188cc2019-01-07 10:46:33 -07003631
Jens Axboe2b188cc2019-01-07 10:46:33 -07003632 return 0;
3633}
3634
3635/*
3636 * Allocate an anonymous fd, this is what constitutes the application
3637 * visible backing of an io_uring instance. The application mmaps this
3638 * fd to gain access to the SQ/CQ ring details. If UNIX sockets are enabled,
3639 * we have to tie this fd to a socket for file garbage collection purposes.
3640 */
3641static int io_uring_get_fd(struct io_ring_ctx *ctx)
3642{
3643 struct file *file;
3644 int ret;
3645
3646#if defined(CONFIG_UNIX)
3647 ret = sock_create_kern(&init_net, PF_UNIX, SOCK_RAW, IPPROTO_IP,
3648 &ctx->ring_sock);
3649 if (ret)
3650 return ret;
3651#endif
3652
3653 ret = get_unused_fd_flags(O_RDWR | O_CLOEXEC);
3654 if (ret < 0)
3655 goto err;
3656
3657 file = anon_inode_getfile("[io_uring]", &io_uring_fops, ctx,
3658 O_RDWR | O_CLOEXEC);
3659 if (IS_ERR(file)) {
3660 put_unused_fd(ret);
3661 ret = PTR_ERR(file);
3662 goto err;
3663 }
3664
3665#if defined(CONFIG_UNIX)
3666 ctx->ring_sock->file = file;
Jens Axboe6b063142019-01-10 22:13:58 -07003667 ctx->ring_sock->sk->sk_user_data = ctx;
Jens Axboe2b188cc2019-01-07 10:46:33 -07003668#endif
3669 fd_install(ret, file);
3670 return ret;
3671err:
3672#if defined(CONFIG_UNIX)
3673 sock_release(ctx->ring_sock);
3674 ctx->ring_sock = NULL;
3675#endif
3676 return ret;
3677}
3678
3679static int io_uring_create(unsigned entries, struct io_uring_params *p)
3680{
3681 struct user_struct *user = NULL;
3682 struct io_ring_ctx *ctx;
3683 bool account_mem;
3684 int ret;
3685
3686 if (!entries || entries > IORING_MAX_ENTRIES)
3687 return -EINVAL;
3688
3689 /*
3690 * Use twice as many entries for the CQ ring. It's possible for the
3691 * application to drive a higher depth than the size of the SQ ring,
3692 * since the sqes are only used at submission time. This allows for
3693 * some flexibility in overcommitting a bit.
3694 */
3695 p->sq_entries = roundup_pow_of_two(entries);
3696 p->cq_entries = 2 * p->sq_entries;
3697
3698 user = get_uid(current_user());
3699 account_mem = !capable(CAP_IPC_LOCK);
3700
3701 if (account_mem) {
3702 ret = io_account_mem(user,
3703 ring_pages(p->sq_entries, p->cq_entries));
3704 if (ret) {
3705 free_uid(user);
3706 return ret;
3707 }
3708 }
3709
3710 ctx = io_ring_ctx_alloc(p);
3711 if (!ctx) {
3712 if (account_mem)
3713 io_unaccount_mem(user, ring_pages(p->sq_entries,
3714 p->cq_entries));
3715 free_uid(user);
3716 return -ENOMEM;
3717 }
3718 ctx->compat = in_compat_syscall();
3719 ctx->account_mem = account_mem;
3720 ctx->user = user;
3721
3722 ret = io_allocate_scq_urings(ctx, p);
3723 if (ret)
3724 goto err;
3725
Jens Axboe6c271ce2019-01-10 11:22:30 -07003726 ret = io_sq_offload_start(ctx, p);
Jens Axboe2b188cc2019-01-07 10:46:33 -07003727 if (ret)
3728 goto err;
3729
3730 ret = io_uring_get_fd(ctx);
3731 if (ret < 0)
3732 goto err;
3733
3734 memset(&p->sq_off, 0, sizeof(p->sq_off));
Hristo Venev75b28af2019-08-26 17:23:46 +00003735 p->sq_off.head = offsetof(struct io_rings, sq.head);
3736 p->sq_off.tail = offsetof(struct io_rings, sq.tail);
3737 p->sq_off.ring_mask = offsetof(struct io_rings, sq_ring_mask);
3738 p->sq_off.ring_entries = offsetof(struct io_rings, sq_ring_entries);
3739 p->sq_off.flags = offsetof(struct io_rings, sq_flags);
3740 p->sq_off.dropped = offsetof(struct io_rings, sq_dropped);
3741 p->sq_off.array = (char *)ctx->sq_array - (char *)ctx->rings;
Jens Axboe2b188cc2019-01-07 10:46:33 -07003742
3743 memset(&p->cq_off, 0, sizeof(p->cq_off));
Hristo Venev75b28af2019-08-26 17:23:46 +00003744 p->cq_off.head = offsetof(struct io_rings, cq.head);
3745 p->cq_off.tail = offsetof(struct io_rings, cq.tail);
3746 p->cq_off.ring_mask = offsetof(struct io_rings, cq_ring_mask);
3747 p->cq_off.ring_entries = offsetof(struct io_rings, cq_ring_entries);
3748 p->cq_off.overflow = offsetof(struct io_rings, cq_overflow);
3749 p->cq_off.cqes = offsetof(struct io_rings, cqes);
Jens Axboeac90f242019-09-06 10:26:21 -06003750
3751 p->features = IORING_FEAT_SINGLE_MMAP;
Jens Axboe2b188cc2019-01-07 10:46:33 -07003752 return ret;
3753err:
3754 io_ring_ctx_wait_and_kill(ctx);
3755 return ret;
3756}
3757
3758/*
3759 * Sets up an aio uring context, and returns the fd. Applications asks for a
3760 * ring size, we return the actual sq/cq ring sizes (among other things) in the
3761 * params structure passed in.
3762 */
3763static long io_uring_setup(u32 entries, struct io_uring_params __user *params)
3764{
3765 struct io_uring_params p;
3766 long ret;
3767 int i;
3768
3769 if (copy_from_user(&p, params, sizeof(p)))
3770 return -EFAULT;
3771 for (i = 0; i < ARRAY_SIZE(p.resv); i++) {
3772 if (p.resv[i])
3773 return -EINVAL;
3774 }
3775
Jens Axboe6c271ce2019-01-10 11:22:30 -07003776 if (p.flags & ~(IORING_SETUP_IOPOLL | IORING_SETUP_SQPOLL |
3777 IORING_SETUP_SQ_AFF))
Jens Axboe2b188cc2019-01-07 10:46:33 -07003778 return -EINVAL;
3779
3780 ret = io_uring_create(entries, &p);
3781 if (ret < 0)
3782 return ret;
3783
3784 if (copy_to_user(params, &p, sizeof(p)))
3785 return -EFAULT;
3786
3787 return ret;
3788}
3789
3790SYSCALL_DEFINE2(io_uring_setup, u32, entries,
3791 struct io_uring_params __user *, params)
3792{
3793 return io_uring_setup(entries, params);
3794}
3795
Jens Axboeedafcce2019-01-09 09:16:05 -07003796static int __io_uring_register(struct io_ring_ctx *ctx, unsigned opcode,
3797 void __user *arg, unsigned nr_args)
Jens Axboeb19062a2019-04-15 10:49:38 -06003798 __releases(ctx->uring_lock)
3799 __acquires(ctx->uring_lock)
Jens Axboeedafcce2019-01-09 09:16:05 -07003800{
3801 int ret;
3802
Jens Axboe35fa71a2019-04-22 10:23:23 -06003803 /*
3804 * We're inside the ring mutex, if the ref is already dying, then
3805 * someone else killed the ctx or is already going through
3806 * io_uring_register().
3807 */
3808 if (percpu_ref_is_dying(&ctx->refs))
3809 return -ENXIO;
3810
Jens Axboeedafcce2019-01-09 09:16:05 -07003811 percpu_ref_kill(&ctx->refs);
Jens Axboeb19062a2019-04-15 10:49:38 -06003812
3813 /*
3814 * Drop uring mutex before waiting for references to exit. If another
3815 * thread is currently inside io_uring_enter() it might need to grab
3816 * the uring_lock to make progress. If we hold it here across the drain
3817 * wait, then we can deadlock. It's safe to drop the mutex here, since
3818 * no new references will come in after we've killed the percpu ref.
3819 */
3820 mutex_unlock(&ctx->uring_lock);
Jens Axboeedafcce2019-01-09 09:16:05 -07003821 wait_for_completion(&ctx->ctx_done);
Jens Axboeb19062a2019-04-15 10:49:38 -06003822 mutex_lock(&ctx->uring_lock);
Jens Axboeedafcce2019-01-09 09:16:05 -07003823
3824 switch (opcode) {
3825 case IORING_REGISTER_BUFFERS:
3826 ret = io_sqe_buffer_register(ctx, arg, nr_args);
3827 break;
3828 case IORING_UNREGISTER_BUFFERS:
3829 ret = -EINVAL;
3830 if (arg || nr_args)
3831 break;
3832 ret = io_sqe_buffer_unregister(ctx);
3833 break;
Jens Axboe6b063142019-01-10 22:13:58 -07003834 case IORING_REGISTER_FILES:
3835 ret = io_sqe_files_register(ctx, arg, nr_args);
3836 break;
3837 case IORING_UNREGISTER_FILES:
3838 ret = -EINVAL;
3839 if (arg || nr_args)
3840 break;
3841 ret = io_sqe_files_unregister(ctx);
3842 break;
Jens Axboe9b402842019-04-11 11:45:41 -06003843 case IORING_REGISTER_EVENTFD:
3844 ret = -EINVAL;
3845 if (nr_args != 1)
3846 break;
3847 ret = io_eventfd_register(ctx, arg);
3848 break;
3849 case IORING_UNREGISTER_EVENTFD:
3850 ret = -EINVAL;
3851 if (arg || nr_args)
3852 break;
3853 ret = io_eventfd_unregister(ctx);
3854 break;
Jens Axboeedafcce2019-01-09 09:16:05 -07003855 default:
3856 ret = -EINVAL;
3857 break;
3858 }
3859
3860 /* bring the ctx back to life */
3861 reinit_completion(&ctx->ctx_done);
3862 percpu_ref_reinit(&ctx->refs);
3863 return ret;
3864}
3865
3866SYSCALL_DEFINE4(io_uring_register, unsigned int, fd, unsigned int, opcode,
3867 void __user *, arg, unsigned int, nr_args)
3868{
3869 struct io_ring_ctx *ctx;
3870 long ret = -EBADF;
3871 struct fd f;
3872
3873 f = fdget(fd);
3874 if (!f.file)
3875 return -EBADF;
3876
3877 ret = -EOPNOTSUPP;
3878 if (f.file->f_op != &io_uring_fops)
3879 goto out_fput;
3880
3881 ctx = f.file->private_data;
3882
3883 mutex_lock(&ctx->uring_lock);
3884 ret = __io_uring_register(ctx, opcode, arg, nr_args);
3885 mutex_unlock(&ctx->uring_lock);
3886out_fput:
3887 fdput(f);
3888 return ret;
3889}
3890
Jens Axboe2b188cc2019-01-07 10:46:33 -07003891static int __init io_uring_init(void)
3892{
3893 req_cachep = KMEM_CACHE(io_kiocb, SLAB_HWCACHE_ALIGN | SLAB_PANIC);
3894 return 0;
3895};
3896__initcall(io_uring_init);