blob: 100de2626e4788bd2e5ebdd6ee1c8556a6432b44 [file] [log] [blame]
Jens Axboef3b44f92022-06-13 07:27:03 -06001// SPDX-License-Identifier: GPL-2.0
2#include <linux/kernel.h>
3#include <linux/errno.h>
4#include <linux/fs.h>
5#include <linux/file.h>
6#include <linux/blk-mq.h>
7#include <linux/mm.h>
8#include <linux/slab.h>
9#include <linux/fsnotify.h>
10#include <linux/poll.h>
11#include <linux/nospec.h>
12#include <linux/compat.h>
13#include <linux/io_uring.h>
14
15#include <uapi/linux/io_uring.h>
16
Jens Axboef3b44f92022-06-13 07:27:03 -060017#include "io_uring.h"
18#include "opdef.h"
19#include "kbuf.h"
20#include "rsrc.h"
21#include "rw.h"
22
23struct io_rw {
24 /* NOTE: kiocb has the file as the first member, so don't do it here */
25 struct kiocb kiocb;
26 u64 addr;
27 u32 len;
28 rwf_t flags;
29};
30
31static inline bool io_file_supports_nowait(struct io_kiocb *req)
32{
33 return req->flags & REQ_F_SUPPORT_NOWAIT;
34}
35
Dylan Yudaken4ab9d462022-09-07 09:51:52 -070036#ifdef CONFIG_COMPAT
37static int io_iov_compat_buffer_select_prep(struct io_rw *rw)
38{
39 struct compat_iovec __user *uiov;
40 compat_ssize_t clen;
41
42 uiov = u64_to_user_ptr(rw->addr);
43 if (!access_ok(uiov, sizeof(*uiov)))
44 return -EFAULT;
45 if (__get_user(clen, &uiov->iov_len))
46 return -EFAULT;
47 if (clen < 0)
48 return -EINVAL;
49
50 rw->len = clen;
51 return 0;
52}
53#endif
54
55static int io_iov_buffer_select_prep(struct io_kiocb *req)
56{
57 struct iovec __user *uiov;
58 struct iovec iov;
59 struct io_rw *rw = io_kiocb_to_cmd(req, struct io_rw);
60
61 if (rw->len != 1)
62 return -EINVAL;
63
64#ifdef CONFIG_COMPAT
65 if (req->ctx->compat)
66 return io_iov_compat_buffer_select_prep(rw);
67#endif
68
69 uiov = u64_to_user_ptr(rw->addr);
70 if (copy_from_user(&iov, uiov, sizeof(*uiov)))
71 return -EFAULT;
72 rw->len = iov.iov_len;
73 return 0;
74}
75
Jens Axboef3b44f92022-06-13 07:27:03 -060076int io_prep_rw(struct io_kiocb *req, const struct io_uring_sqe *sqe)
77{
Stefan Metzmacherf2ccb5a2022-08-11 09:11:15 +020078 struct io_rw *rw = io_kiocb_to_cmd(req, struct io_rw);
Jens Axboef3b44f92022-06-13 07:27:03 -060079 unsigned ioprio;
80 int ret;
81
82 rw->kiocb.ki_pos = READ_ONCE(sqe->off);
83 /* used for fixed read/write too - just read unconditionally */
84 req->buf_index = READ_ONCE(sqe->buf_index);
85
86 if (req->opcode == IORING_OP_READ_FIXED ||
87 req->opcode == IORING_OP_WRITE_FIXED) {
88 struct io_ring_ctx *ctx = req->ctx;
89 u16 index;
90
91 if (unlikely(req->buf_index >= ctx->nr_user_bufs))
92 return -EFAULT;
93 index = array_index_nospec(req->buf_index, ctx->nr_user_bufs);
94 req->imu = ctx->user_bufs[index];
95 io_req_set_rsrc_node(req, ctx, 0);
96 }
97
98 ioprio = READ_ONCE(sqe->ioprio);
99 if (ioprio) {
100 ret = ioprio_check_cap(ioprio);
101 if (ret)
102 return ret;
103
104 rw->kiocb.ki_ioprio = ioprio;
105 } else {
106 rw->kiocb.ki_ioprio = get_current_ioprio();
107 }
108
109 rw->addr = READ_ONCE(sqe->addr);
110 rw->len = READ_ONCE(sqe->len);
111 rw->flags = READ_ONCE(sqe->rw_flags);
Dylan Yudaken4ab9d462022-09-07 09:51:52 -0700112
113 /* Have to do this validation here, as this is in io_read() rw->len might
114 * have chanaged due to buffer selection
115 */
116 if (req->opcode == IORING_OP_READV && req->flags & REQ_F_BUFFER_SELECT) {
117 ret = io_iov_buffer_select_prep(req);
118 if (ret)
119 return ret;
120 }
121
Jens Axboef3b44f92022-06-13 07:27:03 -0600122 return 0;
123}
124
125void io_readv_writev_cleanup(struct io_kiocb *req)
126{
127 struct io_async_rw *io = req->async_data;
128
129 kfree(io->free_iovec);
130}
131
132static inline void io_rw_done(struct kiocb *kiocb, ssize_t ret)
133{
134 switch (ret) {
135 case -EIOCBQUEUED:
136 break;
137 case -ERESTARTSYS:
138 case -ERESTARTNOINTR:
139 case -ERESTARTNOHAND:
140 case -ERESTART_RESTARTBLOCK:
141 /*
142 * We can't just restart the syscall, since previously
143 * submitted sqes may already be in progress. Just fail this
144 * IO with EINTR.
145 */
146 ret = -EINTR;
147 fallthrough;
148 default:
149 kiocb->ki_complete(kiocb, ret);
150 }
151}
152
153static inline loff_t *io_kiocb_update_pos(struct io_kiocb *req)
154{
Stefan Metzmacherf2ccb5a2022-08-11 09:11:15 +0200155 struct io_rw *rw = io_kiocb_to_cmd(req, struct io_rw);
Jens Axboef3b44f92022-06-13 07:27:03 -0600156
157 if (rw->kiocb.ki_pos != -1)
158 return &rw->kiocb.ki_pos;
159
160 if (!(req->file->f_mode & FMODE_STREAM)) {
161 req->flags |= REQ_F_CUR_POS;
162 rw->kiocb.ki_pos = req->file->f_pos;
163 return &rw->kiocb.ki_pos;
164 }
165
166 rw->kiocb.ki_pos = 0;
167 return NULL;
168}
169
170static void io_req_task_queue_reissue(struct io_kiocb *req)
171{
172 req->io_task_work.func = io_queue_iowq;
173 io_req_task_work_add(req);
174}
175
176#ifdef CONFIG_BLOCK
177static bool io_resubmit_prep(struct io_kiocb *req)
178{
179 struct io_async_rw *io = req->async_data;
180
181 if (!req_has_async_data(req))
182 return !io_req_prep_async(req);
183 iov_iter_restore(&io->s.iter, &io->s.iter_state);
184 return true;
185}
186
187static bool io_rw_should_reissue(struct io_kiocb *req)
188{
189 umode_t mode = file_inode(req->file)->i_mode;
190 struct io_ring_ctx *ctx = req->ctx;
191
192 if (!S_ISBLK(mode) && !S_ISREG(mode))
193 return false;
194 if ((req->flags & REQ_F_NOWAIT) || (io_wq_current_is_worker() &&
195 !(ctx->flags & IORING_SETUP_IOPOLL)))
196 return false;
197 /*
198 * If ref is dying, we might be running poll reap from the exit work.
199 * Don't attempt to reissue from that path, just let it fail with
200 * -EAGAIN.
201 */
202 if (percpu_ref_is_dying(&ctx->refs))
203 return false;
204 /*
205 * Play it safe and assume not safe to re-import and reissue if we're
206 * not in the original thread group (or in task context).
207 */
208 if (!same_thread_group(req->task, current) || !in_task())
209 return false;
210 return true;
211}
212#else
213static bool io_resubmit_prep(struct io_kiocb *req)
214{
215 return false;
216}
217static bool io_rw_should_reissue(struct io_kiocb *req)
218{
219 return false;
220}
221#endif
222
223static void kiocb_end_write(struct io_kiocb *req)
224{
225 /*
226 * Tell lockdep we inherited freeze protection from submission
227 * thread.
228 */
229 if (req->flags & REQ_F_ISREG) {
230 struct super_block *sb = file_inode(req->file)->i_sb;
231
232 __sb_writers_acquired(sb, SB_FREEZE_WRITE);
233 sb_end_write(sb);
234 }
235}
236
Jens Axboe2ec33a62022-10-11 09:06:23 -0600237/*
238 * Trigger the notifications after having done some IO, and finish the write
239 * accounting, if any.
240 */
241static void io_req_io_end(struct io_kiocb *req)
242{
243 struct io_rw *rw = io_kiocb_to_cmd(req, struct io_rw);
244
245 WARN_ON(!in_task());
246
247 if (rw->kiocb.ki_flags & IOCB_WRITE) {
248 kiocb_end_write(req);
249 fsnotify_modify(req->file);
250 } else {
251 fsnotify_access(req->file);
252 }
253}
254
Jens Axboef3b44f92022-06-13 07:27:03 -0600255static bool __io_complete_rw_common(struct io_kiocb *req, long res)
256{
Jens Axboef3b44f92022-06-13 07:27:03 -0600257 if (unlikely(res != req->cqe.res)) {
258 if ((res == -EAGAIN || res == -EOPNOTSUPP) &&
259 io_rw_should_reissue(req)) {
Jens Axboe2ec33a62022-10-11 09:06:23 -0600260 /*
261 * Reissue will start accounting again, finish the
262 * current cycle.
263 */
264 io_req_io_end(req);
Jens Axboef3b44f92022-06-13 07:27:03 -0600265 req->flags |= REQ_F_REISSUE | REQ_F_PARTIAL_IO;
266 return true;
267 }
268 req_set_fail(req);
269 req->cqe.res = res;
270 }
271 return false;
272}
273
Pavel Begunkov62bb0642022-09-13 13:21:23 +0100274static inline int io_fixup_rw_res(struct io_kiocb *req, long res)
Pavel Begunkov4d9cb922022-09-09 12:11:49 +0100275{
276 struct io_async_rw *io = req->async_data;
277
278 /* add previously done IO, if any */
279 if (req_has_async_data(req) && io->bytes_done > 0) {
280 if (res < 0)
281 res = io->bytes_done;
282 else
283 res += io->bytes_done;
284 }
285 return res;
286}
287
Jens Axboeb0001452022-09-29 10:57:05 -0600288static void io_req_rw_complete(struct io_kiocb *req, bool *locked)
289{
Jens Axboe2ec33a62022-10-11 09:06:23 -0600290 io_req_io_end(req);
Jens Axboeb0001452022-09-29 10:57:05 -0600291 io_req_task_complete(req, locked);
292}
293
Jens Axboef3b44f92022-06-13 07:27:03 -0600294static void io_complete_rw(struct kiocb *kiocb, long res)
295{
296 struct io_rw *rw = container_of(kiocb, struct io_rw, kiocb);
297 struct io_kiocb *req = cmd_to_io_kiocb(rw);
298
299 if (__io_complete_rw_common(req, res))
300 return;
Pavel Begunkov4d9cb922022-09-09 12:11:49 +0100301 io_req_set_res(req, io_fixup_rw_res(req, res), 0);
Jens Axboeb0001452022-09-29 10:57:05 -0600302 req->io_task_work.func = io_req_rw_complete;
Dylan Yudakened5ccb32022-06-22 06:40:21 -0700303 io_req_task_work_add(req);
Jens Axboef3b44f92022-06-13 07:27:03 -0600304}
305
306static void io_complete_rw_iopoll(struct kiocb *kiocb, long res)
307{
308 struct io_rw *rw = container_of(kiocb, struct io_rw, kiocb);
309 struct io_kiocb *req = cmd_to_io_kiocb(rw);
310
311 if (kiocb->ki_flags & IOCB_WRITE)
312 kiocb_end_write(req);
313 if (unlikely(res != req->cqe.res)) {
314 if (res == -EAGAIN && io_rw_should_reissue(req)) {
315 req->flags |= REQ_F_REISSUE | REQ_F_PARTIAL_IO;
316 return;
317 }
318 req->cqe.res = res;
319 }
320
321 /* order with io_iopoll_complete() checking ->iopoll_completed */
322 smp_store_release(&req->iopoll_completed, 1);
323}
324
Pavel Begunkovdf9830d2022-06-16 10:21:57 +0100325static int kiocb_done(struct io_kiocb *req, ssize_t ret,
Jens Axboef3b44f92022-06-13 07:27:03 -0600326 unsigned int issue_flags)
327{
Stefan Metzmacherf2ccb5a2022-08-11 09:11:15 +0200328 struct io_rw *rw = io_kiocb_to_cmd(req, struct io_rw);
Pavel Begunkov4d9cb922022-09-09 12:11:49 +0100329 unsigned final_ret = io_fixup_rw_res(req, ret);
Jens Axboef3b44f92022-06-13 07:27:03 -0600330
331 if (req->flags & REQ_F_CUR_POS)
332 req->file->f_pos = rw->kiocb.ki_pos;
Pavel Begunkovdf9830d2022-06-16 10:21:57 +0100333 if (ret >= 0 && (rw->kiocb.ki_complete == io_complete_rw)) {
334 if (!__io_complete_rw_common(req, ret)) {
Jens Axboe2ec33a62022-10-11 09:06:23 -0600335 /*
336 * Safe to call io_end from here as we're inline
337 * from the submission path.
338 */
339 io_req_io_end(req);
Pavel Begunkov4d9cb922022-09-09 12:11:49 +0100340 io_req_set_res(req, final_ret,
Pavel Begunkovdf9830d2022-06-16 10:21:57 +0100341 io_put_kbuf(req, issue_flags));
342 return IOU_OK;
343 }
344 } else {
Jens Axboef3b44f92022-06-13 07:27:03 -0600345 io_rw_done(&rw->kiocb, ret);
Pavel Begunkovdf9830d2022-06-16 10:21:57 +0100346 }
Jens Axboef3b44f92022-06-13 07:27:03 -0600347
348 if (req->flags & REQ_F_REISSUE) {
349 req->flags &= ~REQ_F_REISSUE;
350 if (io_resubmit_prep(req))
351 io_req_task_queue_reissue(req);
352 else
Pavel Begunkov4d9cb922022-09-09 12:11:49 +0100353 io_req_task_queue_fail(req, final_ret);
Jens Axboef3b44f92022-06-13 07:27:03 -0600354 }
Pavel Begunkovdf9830d2022-06-16 10:21:57 +0100355 return IOU_ISSUE_SKIP_COMPLETE;
Jens Axboef3b44f92022-06-13 07:27:03 -0600356}
357
Jens Axboef3b44f92022-06-13 07:27:03 -0600358static struct iovec *__io_import_iovec(int ddir, struct io_kiocb *req,
359 struct io_rw_state *s,
360 unsigned int issue_flags)
361{
Stefan Metzmacherf2ccb5a2022-08-11 09:11:15 +0200362 struct io_rw *rw = io_kiocb_to_cmd(req, struct io_rw);
Jens Axboef3b44f92022-06-13 07:27:03 -0600363 struct iov_iter *iter = &s->iter;
364 u8 opcode = req->opcode;
365 struct iovec *iovec;
366 void __user *buf;
367 size_t sqe_len;
368 ssize_t ret;
369
370 if (opcode == IORING_OP_READ_FIXED || opcode == IORING_OP_WRITE_FIXED) {
Pavel Begunkovf337a842022-06-20 01:25:58 +0100371 ret = io_import_fixed(ddir, iter, req->imu, rw->addr, rw->len);
Jens Axboef3b44f92022-06-13 07:27:03 -0600372 if (ret)
373 return ERR_PTR(ret);
374 return NULL;
375 }
376
377 buf = u64_to_user_ptr(rw->addr);
378 sqe_len = rw->len;
379
Dylan Yudaken4ab9d462022-09-07 09:51:52 -0700380 if (opcode == IORING_OP_READ || opcode == IORING_OP_WRITE ||
381 (req->flags & REQ_F_BUFFER_SELECT)) {
Jens Axboef3b44f92022-06-13 07:27:03 -0600382 if (io_do_buffer_select(req)) {
383 buf = io_buffer_select(req, &sqe_len, issue_flags);
384 if (!buf)
385 return ERR_PTR(-ENOBUFS);
386 rw->addr = (unsigned long) buf;
387 rw->len = sqe_len;
388 }
389
390 ret = import_single_range(ddir, buf, sqe_len, s->fast_iov, iter);
391 if (ret)
392 return ERR_PTR(ret);
393 return NULL;
394 }
395
396 iovec = s->fast_iov;
Jens Axboef3b44f92022-06-13 07:27:03 -0600397 ret = __import_iovec(ddir, buf, sqe_len, UIO_FASTIOV, &iovec, iter,
398 req->ctx->compat);
399 if (unlikely(ret < 0))
400 return ERR_PTR(ret);
401 return iovec;
402}
403
404static inline int io_import_iovec(int rw, struct io_kiocb *req,
405 struct iovec **iovec, struct io_rw_state *s,
406 unsigned int issue_flags)
407{
408 *iovec = __io_import_iovec(rw, req, s, issue_flags);
409 if (unlikely(IS_ERR(*iovec)))
410 return PTR_ERR(*iovec);
411
412 iov_iter_save_state(&s->iter, &s->iter_state);
413 return 0;
414}
415
416static inline loff_t *io_kiocb_ppos(struct kiocb *kiocb)
417{
418 return (kiocb->ki_filp->f_mode & FMODE_STREAM) ? NULL : &kiocb->ki_pos;
419}
420
421/*
422 * For files that don't have ->read_iter() and ->write_iter(), handle them
423 * by looping over ->read() or ->write() manually.
424 */
425static ssize_t loop_rw_iter(int ddir, struct io_rw *rw, struct iov_iter *iter)
426{
427 struct kiocb *kiocb = &rw->kiocb;
428 struct file *file = kiocb->ki_filp;
429 ssize_t ret = 0;
430 loff_t *ppos;
431
432 /*
433 * Don't support polled IO through this interface, and we can't
434 * support non-blocking either. For the latter, this just causes
435 * the kiocb to be handled from an async context.
436 */
437 if (kiocb->ki_flags & IOCB_HIPRI)
438 return -EOPNOTSUPP;
439 if ((kiocb->ki_flags & IOCB_NOWAIT) &&
440 !(kiocb->ki_filp->f_flags & O_NONBLOCK))
441 return -EAGAIN;
442
443 ppos = io_kiocb_ppos(kiocb);
444
445 while (iov_iter_count(iter)) {
446 struct iovec iovec;
447 ssize_t nr;
448
449 if (!iov_iter_is_bvec(iter)) {
450 iovec = iov_iter_iovec(iter);
451 } else {
452 iovec.iov_base = u64_to_user_ptr(rw->addr);
453 iovec.iov_len = rw->len;
454 }
455
456 if (ddir == READ) {
457 nr = file->f_op->read(file, iovec.iov_base,
458 iovec.iov_len, ppos);
459 } else {
460 nr = file->f_op->write(file, iovec.iov_base,
461 iovec.iov_len, ppos);
462 }
463
464 if (nr < 0) {
465 if (!ret)
466 ret = nr;
467 break;
468 }
469 ret += nr;
470 if (!iov_iter_is_bvec(iter)) {
471 iov_iter_advance(iter, nr);
472 } else {
473 rw->addr += nr;
474 rw->len -= nr;
475 if (!rw->len)
476 break;
477 }
478 if (nr != iovec.iov_len)
479 break;
480 }
481
482 return ret;
483}
484
485static void io_req_map_rw(struct io_kiocb *req, const struct iovec *iovec,
486 const struct iovec *fast_iov, struct iov_iter *iter)
487{
488 struct io_async_rw *io = req->async_data;
489
490 memcpy(&io->s.iter, iter, sizeof(*iter));
491 io->free_iovec = iovec;
492 io->bytes_done = 0;
493 /* can only be fixed buffers, no need to do anything */
494 if (iov_iter_is_bvec(iter))
495 return;
496 if (!iovec) {
497 unsigned iov_off = 0;
498
499 io->s.iter.iov = io->s.fast_iov;
500 if (iter->iov != fast_iov) {
501 iov_off = iter->iov - fast_iov;
502 io->s.iter.iov += iov_off;
503 }
504 if (io->s.fast_iov != fast_iov)
505 memcpy(io->s.fast_iov + iov_off, fast_iov + iov_off,
506 sizeof(struct iovec) * iter->nr_segs);
507 } else {
508 req->flags |= REQ_F_NEED_CLEANUP;
509 }
510}
511
512static int io_setup_async_rw(struct io_kiocb *req, const struct iovec *iovec,
513 struct io_rw_state *s, bool force)
514{
515 if (!force && !io_op_defs[req->opcode].prep_async)
516 return 0;
517 if (!req_has_async_data(req)) {
518 struct io_async_rw *iorw;
519
520 if (io_alloc_async_data(req)) {
521 kfree(iovec);
522 return -ENOMEM;
523 }
524
525 io_req_map_rw(req, iovec, s->fast_iov, &s->iter);
526 iorw = req->async_data;
527 /* we've copied and mapped the iter, ensure state is saved */
528 iov_iter_save_state(&iorw->s.iter, &iorw->s.iter_state);
529 }
530 return 0;
531}
532
533static inline int io_rw_prep_async(struct io_kiocb *req, int rw)
534{
535 struct io_async_rw *iorw = req->async_data;
536 struct iovec *iov;
537 int ret;
538
539 /* submission path, ->uring_lock should already be taken */
540 ret = io_import_iovec(rw, req, &iov, &iorw->s, 0);
541 if (unlikely(ret < 0))
542 return ret;
543
544 iorw->bytes_done = 0;
545 iorw->free_iovec = iov;
546 if (iov)
547 req->flags |= REQ_F_NEED_CLEANUP;
548 return 0;
549}
550
551int io_readv_prep_async(struct io_kiocb *req)
552{
553 return io_rw_prep_async(req, READ);
554}
555
556int io_writev_prep_async(struct io_kiocb *req)
557{
558 return io_rw_prep_async(req, WRITE);
559}
560
561/*
562 * This is our waitqueue callback handler, registered through __folio_lock_async()
563 * when we initially tried to do the IO with the iocb armed our waitqueue.
564 * This gets called when the page is unlocked, and we generally expect that to
565 * happen when the page IO is completed and the page is now uptodate. This will
566 * queue a task_work based retry of the operation, attempting to copy the data
567 * again. If the latter fails because the page was NOT uptodate, then we will
568 * do a thread based blocking retry of the operation. That's the unexpected
569 * slow path.
570 */
571static int io_async_buf_func(struct wait_queue_entry *wait, unsigned mode,
572 int sync, void *arg)
573{
574 struct wait_page_queue *wpq;
575 struct io_kiocb *req = wait->private;
Stefan Metzmacherf2ccb5a2022-08-11 09:11:15 +0200576 struct io_rw *rw = io_kiocb_to_cmd(req, struct io_rw);
Jens Axboef3b44f92022-06-13 07:27:03 -0600577 struct wait_page_key *key = arg;
578
579 wpq = container_of(wait, struct wait_page_queue, wait);
580
581 if (!wake_page_match(wpq, key))
582 return 0;
583
584 rw->kiocb.ki_flags &= ~IOCB_WAITQ;
585 list_del_init(&wait->entry);
586 io_req_task_queue(req);
587 return 1;
588}
589
590/*
591 * This controls whether a given IO request should be armed for async page
592 * based retry. If we return false here, the request is handed to the async
593 * worker threads for retry. If we're doing buffered reads on a regular file,
594 * we prepare a private wait_page_queue entry and retry the operation. This
595 * will either succeed because the page is now uptodate and unlocked, or it
596 * will register a callback when the page is unlocked at IO completion. Through
597 * that callback, io_uring uses task_work to setup a retry of the operation.
598 * That retry will attempt the buffered read again. The retry will generally
599 * succeed, or in rare cases where it fails, we then fall back to using the
600 * async worker threads for a blocking retry.
601 */
602static bool io_rw_should_retry(struct io_kiocb *req)
603{
604 struct io_async_rw *io = req->async_data;
605 struct wait_page_queue *wait = &io->wpq;
Stefan Metzmacherf2ccb5a2022-08-11 09:11:15 +0200606 struct io_rw *rw = io_kiocb_to_cmd(req, struct io_rw);
Jens Axboef3b44f92022-06-13 07:27:03 -0600607 struct kiocb *kiocb = &rw->kiocb;
608
609 /* never retry for NOWAIT, we just complete with -EAGAIN */
610 if (req->flags & REQ_F_NOWAIT)
611 return false;
612
613 /* Only for buffered IO */
614 if (kiocb->ki_flags & (IOCB_DIRECT | IOCB_HIPRI))
615 return false;
616
617 /*
618 * just use poll if we can, and don't attempt if the fs doesn't
619 * support callback based unlocks
620 */
621 if (file_can_poll(req->file) || !(req->file->f_mode & FMODE_BUF_RASYNC))
622 return false;
623
624 wait->wait.func = io_async_buf_func;
625 wait->wait.private = req;
626 wait->wait.flags = 0;
627 INIT_LIST_HEAD(&wait->wait.entry);
628 kiocb->ki_flags |= IOCB_WAITQ;
629 kiocb->ki_flags &= ~IOCB_NOWAIT;
630 kiocb->ki_waitq = wait;
631 return true;
632}
633
634static inline int io_iter_do_read(struct io_rw *rw, struct iov_iter *iter)
635{
636 struct file *file = rw->kiocb.ki_filp;
637
638 if (likely(file->f_op->read_iter))
639 return call_read_iter(file, &rw->kiocb, iter);
640 else if (file->f_op->read)
641 return loop_rw_iter(READ, rw, iter);
642 else
643 return -EINVAL;
644}
645
Stefan Roesch4e17aaa2022-06-16 14:22:18 -0700646static bool need_complete_io(struct io_kiocb *req)
Jens Axboef3b44f92022-06-13 07:27:03 -0600647{
648 return req->flags & REQ_F_ISREG ||
649 S_ISBLK(file_inode(req->file)->i_mode);
650}
651
Jens Axboef3b44f92022-06-13 07:27:03 -0600652static int io_rw_init_file(struct io_kiocb *req, fmode_t mode)
653{
Stefan Metzmacherf2ccb5a2022-08-11 09:11:15 +0200654 struct io_rw *rw = io_kiocb_to_cmd(req, struct io_rw);
Jens Axboef3b44f92022-06-13 07:27:03 -0600655 struct kiocb *kiocb = &rw->kiocb;
656 struct io_ring_ctx *ctx = req->ctx;
657 struct file *file = req->file;
658 int ret;
659
660 if (unlikely(!file || !(file->f_mode & mode)))
661 return -EBADF;
662
663 if (!io_req_ffs_set(req))
664 req->flags |= io_file_get_flags(file) << REQ_F_SUPPORT_NOWAIT_BIT;
665
Linus Torvalds52644062022-08-03 13:50:22 -0700666 kiocb->ki_flags = file->f_iocb_flags;
Jens Axboef3b44f92022-06-13 07:27:03 -0600667 ret = kiocb_set_rw_flags(kiocb, rw->flags);
668 if (unlikely(ret))
669 return ret;
670
671 /*
672 * If the file is marked O_NONBLOCK, still allow retry for it if it
673 * supports async. Otherwise it's impossible to use O_NONBLOCK files
674 * reliably. If not, or it IOCB_NOWAIT is set, don't retry.
675 */
676 if ((kiocb->ki_flags & IOCB_NOWAIT) ||
677 ((file->f_flags & O_NONBLOCK) && !io_file_supports_nowait(req)))
678 req->flags |= REQ_F_NOWAIT;
679
680 if (ctx->flags & IORING_SETUP_IOPOLL) {
681 if (!(kiocb->ki_flags & IOCB_DIRECT) || !file->f_op->iopoll)
682 return -EOPNOTSUPP;
683
684 kiocb->private = NULL;
685 kiocb->ki_flags |= IOCB_HIPRI | IOCB_ALLOC_CACHE;
686 kiocb->ki_complete = io_complete_rw_iopoll;
687 req->iopoll_completed = 0;
688 } else {
689 if (kiocb->ki_flags & IOCB_HIPRI)
690 return -EINVAL;
691 kiocb->ki_complete = io_complete_rw;
692 }
693
694 return 0;
695}
696
697int io_read(struct io_kiocb *req, unsigned int issue_flags)
698{
Stefan Metzmacherf2ccb5a2022-08-11 09:11:15 +0200699 struct io_rw *rw = io_kiocb_to_cmd(req, struct io_rw);
Jens Axboef3b44f92022-06-13 07:27:03 -0600700 struct io_rw_state __s, *s = &__s;
701 struct iovec *iovec;
702 struct kiocb *kiocb = &rw->kiocb;
703 bool force_nonblock = issue_flags & IO_URING_F_NONBLOCK;
704 struct io_async_rw *io;
705 ssize_t ret, ret2;
706 loff_t *ppos;
707
708 if (!req_has_async_data(req)) {
709 ret = io_import_iovec(READ, req, &iovec, s, issue_flags);
710 if (unlikely(ret < 0))
711 return ret;
712 } else {
713 io = req->async_data;
714 s = &io->s;
715
716 /*
717 * Safe and required to re-import if we're using provided
718 * buffers, as we dropped the selected one before retry.
719 */
720 if (io_do_buffer_select(req)) {
721 ret = io_import_iovec(READ, req, &iovec, s, issue_flags);
722 if (unlikely(ret < 0))
723 return ret;
724 }
725
726 /*
727 * We come here from an earlier attempt, restore our state to
728 * match in case it doesn't. It's cheap enough that we don't
729 * need to make this conditional.
730 */
731 iov_iter_restore(&s->iter, &s->iter_state);
732 iovec = NULL;
733 }
734 ret = io_rw_init_file(req, FMODE_READ);
735 if (unlikely(ret)) {
736 kfree(iovec);
737 return ret;
738 }
739 req->cqe.res = iov_iter_count(&s->iter);
740
741 if (force_nonblock) {
742 /* If the file doesn't support async, just async punt */
743 if (unlikely(!io_file_supports_nowait(req))) {
744 ret = io_setup_async_rw(req, iovec, s, true);
745 return ret ?: -EAGAIN;
746 }
747 kiocb->ki_flags |= IOCB_NOWAIT;
748 } else {
749 /* Ensure we clear previously set non-block flag */
750 kiocb->ki_flags &= ~IOCB_NOWAIT;
751 }
752
753 ppos = io_kiocb_update_pos(req);
754
755 ret = rw_verify_area(READ, req->file, ppos, req->cqe.res);
756 if (unlikely(ret)) {
757 kfree(iovec);
758 return ret;
759 }
760
761 ret = io_iter_do_read(rw, &s->iter);
762
763 if (ret == -EAGAIN || (req->flags & REQ_F_REISSUE)) {
764 req->flags &= ~REQ_F_REISSUE;
765 /* if we can poll, just do that */
766 if (req->opcode == IORING_OP_READ && file_can_poll(req->file))
767 return -EAGAIN;
768 /* IOPOLL retry should happen for io-wq threads */
769 if (!force_nonblock && !(req->ctx->flags & IORING_SETUP_IOPOLL))
770 goto done;
771 /* no retry on NONBLOCK nor RWF_NOWAIT */
772 if (req->flags & REQ_F_NOWAIT)
773 goto done;
774 ret = 0;
775 } else if (ret == -EIOCBQUEUED) {
Pavel Begunkovdf9830d2022-06-16 10:21:57 +0100776 if (iovec)
777 kfree(iovec);
778 return IOU_ISSUE_SKIP_COMPLETE;
Jens Axboef3b44f92022-06-13 07:27:03 -0600779 } else if (ret == req->cqe.res || ret <= 0 || !force_nonblock ||
Stefan Roesch4e17aaa2022-06-16 14:22:18 -0700780 (req->flags & REQ_F_NOWAIT) || !need_complete_io(req)) {
Jens Axboef3b44f92022-06-13 07:27:03 -0600781 /* read all, failed, already did sync or don't want to retry */
782 goto done;
783 }
784
785 /*
786 * Don't depend on the iter state matching what was consumed, or being
787 * untouched in case of error. Restore it and we'll advance it
788 * manually if we need to.
789 */
790 iov_iter_restore(&s->iter, &s->iter_state);
791
792 ret2 = io_setup_async_rw(req, iovec, s, true);
Jens Axboef3b44f92022-06-13 07:27:03 -0600793 iovec = NULL;
Pavel Begunkovc278d9f2022-09-27 00:44:40 +0100794 if (ret2) {
795 ret = ret > 0 ? ret : ret2;
796 goto done;
797 }
798
Jens Axboef3b44f92022-06-13 07:27:03 -0600799 io = req->async_data;
800 s = &io->s;
801 /*
802 * Now use our persistent iterator and state, if we aren't already.
803 * We've restored and mapped the iter to match.
804 */
805
806 do {
807 /*
808 * We end up here because of a partial read, either from
809 * above or inside this loop. Advance the iter by the bytes
810 * that were consumed.
811 */
812 iov_iter_advance(&s->iter, ret);
813 if (!iov_iter_count(&s->iter))
814 break;
815 io->bytes_done += ret;
816 iov_iter_save_state(&s->iter, &s->iter_state);
817
818 /* if we can retry, do so with the callbacks armed */
819 if (!io_rw_should_retry(req)) {
820 kiocb->ki_flags &= ~IOCB_WAITQ;
821 return -EAGAIN;
822 }
823
Pavel Begunkovbf68b5b2022-09-27 00:44:39 +0100824 req->cqe.res = iov_iter_count(&s->iter);
Jens Axboef3b44f92022-06-13 07:27:03 -0600825 /*
826 * Now retry read with the IOCB_WAITQ parts set in the iocb. If
827 * we get -EIOCBQUEUED, then we'll get a notification when the
828 * desired page gets unlocked. We can also get a partial read
829 * here, and if we do, then just retry at the new offset.
830 */
831 ret = io_iter_do_read(rw, &s->iter);
832 if (ret == -EIOCBQUEUED)
833 return IOU_ISSUE_SKIP_COMPLETE;
834 /* we got some bytes, but not all. retry. */
835 kiocb->ki_flags &= ~IOCB_WAITQ;
836 iov_iter_restore(&s->iter, &s->iter_state);
837 } while (ret > 0);
838done:
Jens Axboef3b44f92022-06-13 07:27:03 -0600839 /* it's faster to check here then delegate to kfree */
840 if (iovec)
841 kfree(iovec);
Pavel Begunkovdf9830d2022-06-16 10:21:57 +0100842 return kiocb_done(req, ret, issue_flags);
Jens Axboef3b44f92022-06-13 07:27:03 -0600843}
844
845int io_write(struct io_kiocb *req, unsigned int issue_flags)
846{
Stefan Metzmacherf2ccb5a2022-08-11 09:11:15 +0200847 struct io_rw *rw = io_kiocb_to_cmd(req, struct io_rw);
Jens Axboef3b44f92022-06-13 07:27:03 -0600848 struct io_rw_state __s, *s = &__s;
849 struct iovec *iovec;
850 struct kiocb *kiocb = &rw->kiocb;
851 bool force_nonblock = issue_flags & IO_URING_F_NONBLOCK;
852 ssize_t ret, ret2;
853 loff_t *ppos;
854
855 if (!req_has_async_data(req)) {
856 ret = io_import_iovec(WRITE, req, &iovec, s, issue_flags);
857 if (unlikely(ret < 0))
858 return ret;
859 } else {
860 struct io_async_rw *io = req->async_data;
861
862 s = &io->s;
863 iov_iter_restore(&s->iter, &s->iter_state);
864 iovec = NULL;
865 }
866 ret = io_rw_init_file(req, FMODE_WRITE);
867 if (unlikely(ret)) {
868 kfree(iovec);
869 return ret;
870 }
871 req->cqe.res = iov_iter_count(&s->iter);
872
873 if (force_nonblock) {
874 /* If the file doesn't support async, just async punt */
875 if (unlikely(!io_file_supports_nowait(req)))
876 goto copy_iov;
877
Stefan Roesch4e17aaa2022-06-16 14:22:18 -0700878 /* File path supports NOWAIT for non-direct_IO only for block devices. */
879 if (!(kiocb->ki_flags & IOCB_DIRECT) &&
880 !(kiocb->ki_filp->f_mode & FMODE_BUF_WASYNC) &&
881 (req->flags & REQ_F_ISREG))
Jens Axboef3b44f92022-06-13 07:27:03 -0600882 goto copy_iov;
883
884 kiocb->ki_flags |= IOCB_NOWAIT;
885 } else {
886 /* Ensure we clear previously set non-block flag */
887 kiocb->ki_flags &= ~IOCB_NOWAIT;
888 }
889
890 ppos = io_kiocb_update_pos(req);
891
892 ret = rw_verify_area(WRITE, req->file, ppos, req->cqe.res);
Pavel Begunkovdf9830d2022-06-16 10:21:57 +0100893 if (unlikely(ret)) {
894 kfree(iovec);
895 return ret;
896 }
Jens Axboef3b44f92022-06-13 07:27:03 -0600897
898 /*
899 * Open-code file_start_write here to grab freeze protection,
900 * which will be released by another thread in
901 * io_complete_rw(). Fool lockdep by telling it the lock got
902 * released so that it doesn't complain about the held lock when
903 * we return to userspace.
904 */
905 if (req->flags & REQ_F_ISREG) {
906 sb_start_write(file_inode(req->file)->i_sb);
907 __sb_writers_release(file_inode(req->file)->i_sb,
908 SB_FREEZE_WRITE);
909 }
910 kiocb->ki_flags |= IOCB_WRITE;
911
912 if (likely(req->file->f_op->write_iter))
913 ret2 = call_write_iter(req->file, kiocb, &s->iter);
914 else if (req->file->f_op->write)
915 ret2 = loop_rw_iter(WRITE, rw, &s->iter);
916 else
917 ret2 = -EINVAL;
918
919 if (req->flags & REQ_F_REISSUE) {
920 req->flags &= ~REQ_F_REISSUE;
921 ret2 = -EAGAIN;
922 }
923
924 /*
925 * Raw bdev writes will return -EOPNOTSUPP for IOCB_NOWAIT. Just
926 * retry them without IOCB_NOWAIT.
927 */
928 if (ret2 == -EOPNOTSUPP && (kiocb->ki_flags & IOCB_NOWAIT))
929 ret2 = -EAGAIN;
930 /* no retry on NONBLOCK nor RWF_NOWAIT */
931 if (ret2 == -EAGAIN && (req->flags & REQ_F_NOWAIT))
932 goto done;
933 if (!force_nonblock || ret2 != -EAGAIN) {
934 /* IOPOLL retry should happen for io-wq threads */
935 if (ret2 == -EAGAIN && (req->ctx->flags & IORING_SETUP_IOPOLL))
936 goto copy_iov;
Stefan Roesch4e17aaa2022-06-16 14:22:18 -0700937
938 if (ret2 != req->cqe.res && ret2 >= 0 && need_complete_io(req)) {
Stefan Roeschc86416c2022-10-10 16:43:30 -0700939 struct io_async_rw *io;
Stefan Roesch4e17aaa2022-06-16 14:22:18 -0700940
Stefan Roesch1c849b42022-06-16 14:22:19 -0700941 trace_io_uring_short_write(req->ctx, kiocb->ki_pos - ret2,
942 req->cqe.res, ret2);
943
Stefan Roesch4e17aaa2022-06-16 14:22:18 -0700944 /* This is a partial write. The file pos has already been
945 * updated, setup the async struct to complete the request
946 * in the worker. Also update bytes_done to account for
947 * the bytes already written.
948 */
949 iov_iter_save_state(&s->iter, &s->iter_state);
950 ret = io_setup_async_rw(req, iovec, s, true);
951
Stefan Roeschc86416c2022-10-10 16:43:30 -0700952 io = req->async_data;
953 if (io)
954 io->bytes_done += ret2;
Stefan Roesch4e17aaa2022-06-16 14:22:18 -0700955
Jens Axboee053aaf42022-06-24 10:24:45 -0600956 if (kiocb->ki_flags & IOCB_WRITE)
957 kiocb_end_write(req);
Stefan Roesch4e17aaa2022-06-16 14:22:18 -0700958 return ret ? ret : -EAGAIN;
959 }
Jens Axboef3b44f92022-06-13 07:27:03 -0600960done:
Pavel Begunkovdf9830d2022-06-16 10:21:57 +0100961 ret = kiocb_done(req, ret2, issue_flags);
Jens Axboef3b44f92022-06-13 07:27:03 -0600962 } else {
963copy_iov:
964 iov_iter_restore(&s->iter, &s->iter_state);
965 ret = io_setup_async_rw(req, iovec, s, false);
Jens Axboee053aaf42022-06-24 10:24:45 -0600966 if (!ret) {
967 if (kiocb->ki_flags & IOCB_WRITE)
968 kiocb_end_write(req);
969 return -EAGAIN;
970 }
971 return ret;
Jens Axboef3b44f92022-06-13 07:27:03 -0600972 }
Jens Axboef3b44f92022-06-13 07:27:03 -0600973 /* it's reportedly faster than delegating the null check to kfree() */
974 if (iovec)
975 kfree(iovec);
976 return ret;
977}
978
979static void io_cqring_ev_posted_iopoll(struct io_ring_ctx *ctx)
980{
Pavel Begunkov46929b02022-06-20 01:25:57 +0100981 io_commit_cqring_flush(ctx);
Jens Axboef3b44f92022-06-13 07:27:03 -0600982 if (ctx->flags & IORING_SETUP_SQPOLL)
983 io_cqring_wake(ctx);
984}
985
Pavel Begunkov47b4c682022-09-21 12:17:47 +0100986void io_rw_fail(struct io_kiocb *req)
987{
988 int res;
989
990 res = io_fixup_rw_res(req, req->cqe.res);
991 io_req_set_res(req, res, req->cqe.flags);
992}
993
Jens Axboef3b44f92022-06-13 07:27:03 -0600994int io_do_iopoll(struct io_ring_ctx *ctx, bool force_nonspin)
995{
996 struct io_wq_work_node *pos, *start, *prev;
997 unsigned int poll_flags = BLK_POLL_NOSLEEP;
998 DEFINE_IO_COMP_BATCH(iob);
999 int nr_events = 0;
1000
1001 /*
1002 * Only spin for completions if we don't have multiple devices hanging
1003 * off our complete list.
1004 */
1005 if (ctx->poll_multi_queue || force_nonspin)
1006 poll_flags |= BLK_POLL_ONESHOT;
1007
1008 wq_list_for_each(pos, start, &ctx->iopoll_list) {
1009 struct io_kiocb *req = container_of(pos, struct io_kiocb, comp_list);
Jens Axboea1119fb2022-09-02 15:16:29 -06001010 struct file *file = req->file;
Jens Axboef3b44f92022-06-13 07:27:03 -06001011 int ret;
1012
1013 /*
1014 * Move completed and retryable entries to our local lists.
1015 * If we find a request that requires polling, break out
1016 * and complete those lists first, if we have entries there.
1017 */
1018 if (READ_ONCE(req->iopoll_completed))
1019 break;
1020
Kanchan Joshi5756a3a2022-08-23 21:44:41 +05301021 if (req->opcode == IORING_OP_URING_CMD) {
Jens Axboea1119fb2022-09-02 15:16:29 -06001022 struct io_uring_cmd *ioucmd;
Kanchan Joshi5756a3a2022-08-23 21:44:41 +05301023
Jens Axboea1119fb2022-09-02 15:16:29 -06001024 ioucmd = io_kiocb_to_cmd(req, struct io_uring_cmd);
Jens Axboede97fcb32022-09-02 15:18:05 -06001025 ret = file->f_op->uring_cmd_iopoll(ioucmd, &iob,
1026 poll_flags);
Jens Axboea1119fb2022-09-02 15:16:29 -06001027 } else {
1028 struct io_rw *rw = io_kiocb_to_cmd(req, struct io_rw);
1029
1030 ret = file->f_op->iopoll(&rw->kiocb, &iob, poll_flags);
1031 }
Jens Axboef3b44f92022-06-13 07:27:03 -06001032 if (unlikely(ret < 0))
1033 return ret;
1034 else if (ret)
1035 poll_flags |= BLK_POLL_ONESHOT;
1036
1037 /* iopoll may have completed current req */
1038 if (!rq_list_empty(iob.req_list) ||
1039 READ_ONCE(req->iopoll_completed))
1040 break;
1041 }
1042
1043 if (!rq_list_empty(iob.req_list))
1044 iob.complete(&iob);
1045 else if (!pos)
1046 return 0;
1047
1048 prev = start;
1049 wq_list_for_each_resume(pos, prev) {
1050 struct io_kiocb *req = container_of(pos, struct io_kiocb, comp_list);
1051
1052 /* order with io_complete_rw_iopoll(), e.g. ->result updates */
1053 if (!smp_load_acquire(&req->iopoll_completed))
1054 break;
1055 nr_events++;
1056 if (unlikely(req->flags & REQ_F_CQE_SKIP))
1057 continue;
1058
1059 req->cqe.flags = io_put_kbuf(req, 0);
1060 __io_fill_cqe_req(req->ctx, req);
1061 }
1062
1063 if (unlikely(!nr_events))
1064 return 0;
1065
1066 io_commit_cqring(ctx);
1067 io_cqring_ev_posted_iopoll(ctx);
1068 pos = start ? start->next : ctx->iopoll_list.first;
1069 wq_list_cut(&ctx->iopoll_list, prev, start);
1070 io_free_batch_list(ctx, pos);
1071 return nr_events;
1072}