io_uring: refactor io_req_task_complete()
[linux-2.6-block.git] / io_uring / kbuf.c
CommitLineData
3b77495a
JA
1// 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/mm.h>
7#include <linux/slab.h>
8#include <linux/namei.h>
9#include <linux/poll.h>
10#include <linux/io_uring.h>
11
12#include <uapi/linux/io_uring.h>
13
14#include "io_uring_types.h"
15#include "io_uring.h"
16#include "opdef.h"
17#include "kbuf.h"
18
19#define IO_BUFFER_LIST_BUF_PER_PAGE (PAGE_SIZE / sizeof(struct io_uring_buf))
20
21#define BGID_ARRAY 64
22
23struct io_provide_buf {
24 struct file *file;
25 __u64 addr;
26 __u32 len;
27 __u32 bgid;
28 __u16 nbufs;
29 __u16 bid;
30};
31
32static inline struct io_buffer_list *io_buffer_get_list(struct io_ring_ctx *ctx,
33 unsigned int bgid)
34{
35 if (ctx->io_bl && bgid < BGID_ARRAY)
36 return &ctx->io_bl[bgid];
37
38 return xa_load(&ctx->io_bl_xa, bgid);
39}
40
41void __io_kbuf_recycle(struct io_kiocb *req, unsigned issue_flags)
42{
43 struct io_ring_ctx *ctx = req->ctx;
44 struct io_buffer_list *bl;
45 struct io_buffer *buf;
46
47 /*
48 * We don't need to recycle for REQ_F_BUFFER_RING, we can just clear
49 * the flag and hence ensure that bl->head doesn't get incremented.
50 * If the tail has already been incremented, hang on to it.
51 */
52 if (req->flags & REQ_F_BUFFER_RING) {
53 if (req->buf_list) {
54 if (req->flags & REQ_F_PARTIAL_IO) {
55 req->buf_list->head++;
56 req->buf_list = NULL;
57 } else {
58 req->buf_index = req->buf_list->bgid;
59 req->flags &= ~REQ_F_BUFFER_RING;
60 }
61 }
62 return;
63 }
64
65 io_ring_submit_lock(ctx, issue_flags);
66
67 buf = req->kbuf;
68 bl = io_buffer_get_list(ctx, buf->bgid);
69 list_add(&buf->list, &bl->buf_list);
70 req->flags &= ~REQ_F_BUFFER_SELECTED;
71 req->buf_index = buf->bgid;
72
73 io_ring_submit_unlock(ctx, issue_flags);
74}
75
76static int io_buffer_add_list(struct io_ring_ctx *ctx,
77 struct io_buffer_list *bl, unsigned int bgid)
78{
79 bl->bgid = bgid;
80 if (bgid < BGID_ARRAY)
81 return 0;
82
83 return xa_err(xa_store(&ctx->io_bl_xa, bgid, bl, GFP_KERNEL));
84}
85
86static void __user *io_provided_buffer_select(struct io_kiocb *req, size_t *len,
87 struct io_buffer_list *bl)
88{
89 if (!list_empty(&bl->buf_list)) {
90 struct io_buffer *kbuf;
91
92 kbuf = list_first_entry(&bl->buf_list, struct io_buffer, list);
93 list_del(&kbuf->list);
94 if (*len > kbuf->len)
95 *len = kbuf->len;
96 req->flags |= REQ_F_BUFFER_SELECTED;
97 req->kbuf = kbuf;
98 req->buf_index = kbuf->bid;
99 return u64_to_user_ptr(kbuf->addr);
100 }
101 return NULL;
102}
103
104static void __user *io_ring_buffer_select(struct io_kiocb *req, size_t *len,
105 struct io_buffer_list *bl,
106 unsigned int issue_flags)
107{
108 struct io_uring_buf_ring *br = bl->buf_ring;
109 struct io_uring_buf *buf;
110 __u16 head = bl->head;
111
112 if (unlikely(smp_load_acquire(&br->tail) == head))
113 return NULL;
114
115 head &= bl->mask;
116 if (head < IO_BUFFER_LIST_BUF_PER_PAGE) {
117 buf = &br->bufs[head];
118 } else {
119 int off = head & (IO_BUFFER_LIST_BUF_PER_PAGE - 1);
120 int index = head / IO_BUFFER_LIST_BUF_PER_PAGE;
121 buf = page_address(bl->buf_pages[index]);
122 buf += off;
123 }
124 if (*len > buf->len)
125 *len = buf->len;
126 req->flags |= REQ_F_BUFFER_RING;
127 req->buf_list = bl;
128 req->buf_index = buf->bid;
129
130 if (issue_flags & IO_URING_F_UNLOCKED || !file_can_poll(req->file)) {
131 /*
132 * If we came in unlocked, we have no choice but to consume the
133 * buffer here. This does mean it'll be pinned until the IO
134 * completes. But coming in unlocked means we're in io-wq
135 * context, hence there should be no further retry. For the
136 * locked case, the caller must ensure to call the commit when
137 * the transfer completes (or if we get -EAGAIN and must poll
138 * or retry).
139 */
140 req->buf_list = NULL;
141 bl->head++;
142 }
143 return u64_to_user_ptr(buf->addr);
144}
145
146void __user *io_buffer_select(struct io_kiocb *req, size_t *len,
147 unsigned int issue_flags)
148{
149 struct io_ring_ctx *ctx = req->ctx;
150 struct io_buffer_list *bl;
151 void __user *ret = NULL;
152
153 io_ring_submit_lock(req->ctx, issue_flags);
154
155 bl = io_buffer_get_list(ctx, req->buf_index);
156 if (likely(bl)) {
157 if (bl->buf_nr_pages)
158 ret = io_ring_buffer_select(req, len, bl, issue_flags);
159 else
160 ret = io_provided_buffer_select(req, len, bl);
161 }
162 io_ring_submit_unlock(req->ctx, issue_flags);
163 return ret;
164}
165
166static __cold int io_init_bl_list(struct io_ring_ctx *ctx)
167{
168 int i;
169
170 ctx->io_bl = kcalloc(BGID_ARRAY, sizeof(struct io_buffer_list),
171 GFP_KERNEL);
172 if (!ctx->io_bl)
173 return -ENOMEM;
174
175 for (i = 0; i < BGID_ARRAY; i++) {
176 INIT_LIST_HEAD(&ctx->io_bl[i].buf_list);
177 ctx->io_bl[i].bgid = i;
178 }
179
180 return 0;
181}
182
183static int __io_remove_buffers(struct io_ring_ctx *ctx,
184 struct io_buffer_list *bl, unsigned nbufs)
185{
186 unsigned i = 0;
187
188 /* shouldn't happen */
189 if (!nbufs)
190 return 0;
191
192 if (bl->buf_nr_pages) {
193 int j;
194
195 i = bl->buf_ring->tail - bl->head;
196 for (j = 0; j < bl->buf_nr_pages; j++)
197 unpin_user_page(bl->buf_pages[j]);
198 kvfree(bl->buf_pages);
199 bl->buf_pages = NULL;
200 bl->buf_nr_pages = 0;
201 /* make sure it's seen as empty */
202 INIT_LIST_HEAD(&bl->buf_list);
203 return i;
204 }
205
206 /* the head kbuf is the list itself */
207 while (!list_empty(&bl->buf_list)) {
208 struct io_buffer *nxt;
209
210 nxt = list_first_entry(&bl->buf_list, struct io_buffer, list);
211 list_del(&nxt->list);
212 if (++i == nbufs)
213 return i;
214 cond_resched();
215 }
216 i++;
217
218 return i;
219}
220
221void io_destroy_buffers(struct io_ring_ctx *ctx)
222{
223 struct io_buffer_list *bl;
224 unsigned long index;
225 int i;
226
227 for (i = 0; i < BGID_ARRAY; i++) {
228 if (!ctx->io_bl)
229 break;
230 __io_remove_buffers(ctx, &ctx->io_bl[i], -1U);
231 }
232
233 xa_for_each(&ctx->io_bl_xa, index, bl) {
234 xa_erase(&ctx->io_bl_xa, bl->bgid);
235 __io_remove_buffers(ctx, bl, -1U);
236 kfree(bl);
237 }
238
239 while (!list_empty(&ctx->io_buffers_pages)) {
240 struct page *page;
241
242 page = list_first_entry(&ctx->io_buffers_pages, struct page, lru);
243 list_del_init(&page->lru);
244 __free_page(page);
245 }
246}
247
248int io_remove_buffers_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe)
249{
250 struct io_provide_buf *p = io_kiocb_to_cmd(req);
251 u64 tmp;
252
253 if (sqe->rw_flags || sqe->addr || sqe->len || sqe->off ||
254 sqe->splice_fd_in)
255 return -EINVAL;
256
257 tmp = READ_ONCE(sqe->fd);
258 if (!tmp || tmp > USHRT_MAX)
259 return -EINVAL;
260
261 memset(p, 0, sizeof(*p));
262 p->nbufs = tmp;
263 p->bgid = READ_ONCE(sqe->buf_group);
264 return 0;
265}
266
267int io_remove_buffers(struct io_kiocb *req, unsigned int issue_flags)
268{
269 struct io_provide_buf *p = io_kiocb_to_cmd(req);
270 struct io_ring_ctx *ctx = req->ctx;
271 struct io_buffer_list *bl;
272 int ret = 0;
273
274 io_ring_submit_lock(ctx, issue_flags);
275
276 ret = -ENOENT;
277 bl = io_buffer_get_list(ctx, p->bgid);
278 if (bl) {
279 ret = -EINVAL;
280 /* can't use provide/remove buffers command on mapped buffers */
281 if (!bl->buf_nr_pages)
282 ret = __io_remove_buffers(ctx, bl, p->nbufs);
283 }
284 if (ret < 0)
285 req_set_fail(req);
286
287 /* complete before unlock, IOPOLL may need the lock */
288 io_req_set_res(req, ret, 0);
289 __io_req_complete(req, issue_flags);
290 io_ring_submit_unlock(ctx, issue_flags);
291 return IOU_ISSUE_SKIP_COMPLETE;
292}
293
294int io_provide_buffers_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe)
295{
296 unsigned long size, tmp_check;
297 struct io_provide_buf *p = io_kiocb_to_cmd(req);
298 u64 tmp;
299
300 if (sqe->rw_flags || sqe->splice_fd_in)
301 return -EINVAL;
302
303 tmp = READ_ONCE(sqe->fd);
304 if (!tmp || tmp > USHRT_MAX)
305 return -E2BIG;
306 p->nbufs = tmp;
307 p->addr = READ_ONCE(sqe->addr);
308 p->len = READ_ONCE(sqe->len);
309
310 if (check_mul_overflow((unsigned long)p->len, (unsigned long)p->nbufs,
311 &size))
312 return -EOVERFLOW;
313 if (check_add_overflow((unsigned long)p->addr, size, &tmp_check))
314 return -EOVERFLOW;
315
316 size = (unsigned long)p->len * p->nbufs;
317 if (!access_ok(u64_to_user_ptr(p->addr), size))
318 return -EFAULT;
319
320 p->bgid = READ_ONCE(sqe->buf_group);
321 tmp = READ_ONCE(sqe->off);
322 if (tmp > USHRT_MAX)
323 return -E2BIG;
324 p->bid = tmp;
325 return 0;
326}
327
328static int io_refill_buffer_cache(struct io_ring_ctx *ctx)
329{
330 struct io_buffer *buf;
331 struct page *page;
332 int bufs_in_page;
333
334 /*
335 * Completions that don't happen inline (eg not under uring_lock) will
336 * add to ->io_buffers_comp. If we don't have any free buffers, check
337 * the completion list and splice those entries first.
338 */
339 if (!list_empty_careful(&ctx->io_buffers_comp)) {
340 spin_lock(&ctx->completion_lock);
341 if (!list_empty(&ctx->io_buffers_comp)) {
342 list_splice_init(&ctx->io_buffers_comp,
343 &ctx->io_buffers_cache);
344 spin_unlock(&ctx->completion_lock);
345 return 0;
346 }
347 spin_unlock(&ctx->completion_lock);
348 }
349
350 /*
351 * No free buffers and no completion entries either. Allocate a new
352 * page worth of buffer entries and add those to our freelist.
353 */
354 page = alloc_page(GFP_KERNEL_ACCOUNT);
355 if (!page)
356 return -ENOMEM;
357
358 list_add(&page->lru, &ctx->io_buffers_pages);
359
360 buf = page_address(page);
361 bufs_in_page = PAGE_SIZE / sizeof(*buf);
362 while (bufs_in_page) {
363 list_add_tail(&buf->list, &ctx->io_buffers_cache);
364 buf++;
365 bufs_in_page--;
366 }
367
368 return 0;
369}
370
371static int io_add_buffers(struct io_ring_ctx *ctx, struct io_provide_buf *pbuf,
372 struct io_buffer_list *bl)
373{
374 struct io_buffer *buf;
375 u64 addr = pbuf->addr;
376 int i, bid = pbuf->bid;
377
378 for (i = 0; i < pbuf->nbufs; i++) {
379 if (list_empty(&ctx->io_buffers_cache) &&
380 io_refill_buffer_cache(ctx))
381 break;
382 buf = list_first_entry(&ctx->io_buffers_cache, struct io_buffer,
383 list);
384 list_move_tail(&buf->list, &bl->buf_list);
385 buf->addr = addr;
386 buf->len = min_t(__u32, pbuf->len, MAX_RW_COUNT);
387 buf->bid = bid;
388 buf->bgid = pbuf->bgid;
389 addr += pbuf->len;
390 bid++;
391 cond_resched();
392 }
393
394 return i ? 0 : -ENOMEM;
395}
396
397int io_provide_buffers(struct io_kiocb *req, unsigned int issue_flags)
398{
399 struct io_provide_buf *p = io_kiocb_to_cmd(req);
400 struct io_ring_ctx *ctx = req->ctx;
401 struct io_buffer_list *bl;
402 int ret = 0;
403
404 io_ring_submit_lock(ctx, issue_flags);
405
406 if (unlikely(p->bgid < BGID_ARRAY && !ctx->io_bl)) {
407 ret = io_init_bl_list(ctx);
408 if (ret)
409 goto err;
410 }
411
412 bl = io_buffer_get_list(ctx, p->bgid);
413 if (unlikely(!bl)) {
414 bl = kzalloc(sizeof(*bl), GFP_KERNEL);
415 if (!bl) {
416 ret = -ENOMEM;
417 goto err;
418 }
419 INIT_LIST_HEAD(&bl->buf_list);
420 ret = io_buffer_add_list(ctx, bl, p->bgid);
421 if (ret) {
422 kfree(bl);
423 goto err;
424 }
425 }
426 /* can't add buffers via this command for a mapped buffer ring */
427 if (bl->buf_nr_pages) {
428 ret = -EINVAL;
429 goto err;
430 }
431
432 ret = io_add_buffers(ctx, p, bl);
433err:
434 if (ret < 0)
435 req_set_fail(req);
436 /* complete before unlock, IOPOLL may need the lock */
437 io_req_set_res(req, ret, 0);
438 __io_req_complete(req, issue_flags);
439 io_ring_submit_unlock(ctx, issue_flags);
440 return IOU_ISSUE_SKIP_COMPLETE;
441}
442
443int io_register_pbuf_ring(struct io_ring_ctx *ctx, void __user *arg)
444{
445 struct io_uring_buf_ring *br;
446 struct io_uring_buf_reg reg;
447 struct io_buffer_list *bl, *free_bl = NULL;
448 struct page **pages;
449 int nr_pages;
450
451 if (copy_from_user(&reg, arg, sizeof(reg)))
452 return -EFAULT;
453
454 if (reg.pad || reg.resv[0] || reg.resv[1] || reg.resv[2])
455 return -EINVAL;
456 if (!reg.ring_addr)
457 return -EFAULT;
458 if (reg.ring_addr & ~PAGE_MASK)
459 return -EINVAL;
460 if (!is_power_of_2(reg.ring_entries))
461 return -EINVAL;
462
463 /* cannot disambiguate full vs empty due to head/tail size */
464 if (reg.ring_entries >= 65536)
465 return -EINVAL;
466
467 if (unlikely(reg.bgid < BGID_ARRAY && !ctx->io_bl)) {
468 int ret = io_init_bl_list(ctx);
469 if (ret)
470 return ret;
471 }
472
473 bl = io_buffer_get_list(ctx, reg.bgid);
474 if (bl) {
475 /* if mapped buffer ring OR classic exists, don't allow */
476 if (bl->buf_nr_pages || !list_empty(&bl->buf_list))
477 return -EEXIST;
478 } else {
479 free_bl = bl = kzalloc(sizeof(*bl), GFP_KERNEL);
480 if (!bl)
481 return -ENOMEM;
482 }
483
484 pages = io_pin_pages(reg.ring_addr,
485 struct_size(br, bufs, reg.ring_entries),
486 &nr_pages);
487 if (IS_ERR(pages)) {
488 kfree(free_bl);
489 return PTR_ERR(pages);
490 }
491
492 br = page_address(pages[0]);
493 bl->buf_pages = pages;
494 bl->buf_nr_pages = nr_pages;
495 bl->nr_entries = reg.ring_entries;
496 bl->buf_ring = br;
497 bl->mask = reg.ring_entries - 1;
498 io_buffer_add_list(ctx, bl, reg.bgid);
499 return 0;
500}
501
502int io_unregister_pbuf_ring(struct io_ring_ctx *ctx, void __user *arg)
503{
504 struct io_uring_buf_reg reg;
505 struct io_buffer_list *bl;
506
507 if (copy_from_user(&reg, arg, sizeof(reg)))
508 return -EFAULT;
509 if (reg.pad || reg.resv[0] || reg.resv[1] || reg.resv[2])
510 return -EINVAL;
511
512 bl = io_buffer_get_list(ctx, reg.bgid);
513 if (!bl)
514 return -ENOENT;
515 if (!bl->buf_nr_pages)
516 return -EINVAL;
517
518 __io_remove_buffers(ctx, bl, -1U);
519 if (bl->bgid >= BGID_ARRAY) {
520 xa_erase(&ctx->io_bl_xa, bl->bgid);
521 kfree(bl);
522 }
523 return 0;
524}