xref: /linux/io_uring/kbuf.c (revision 4b5713ef2f929dd8720fcdb66c063643ef9e3bcb)
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/vmalloc.h>
11 #include <linux/io_uring.h>
12 
13 #include <uapi/linux/io_uring.h>
14 
15 #include "io_uring.h"
16 #include "opdef.h"
17 #include "kbuf.h"
18 #include "memmap.h"
19 
20 /* BIDs are addressed by a 16-bit field in a CQE */
21 #define MAX_BIDS_PER_BGID (1 << 16)
22 
23 /* Mapped buffer ring, return io_uring_buf from head */
24 #define io_ring_head_to_buf(br, head, mask)	&(br)->bufs[(head) & (mask)]
25 
26 struct io_provide_buf {
27 	struct file			*file;
28 	__u64				addr;
29 	__u32				len;
30 	__u32				bgid;
31 	__u32				nbufs;
32 	__u16				bid;
33 };
34 
35 static bool io_kbuf_inc_commit(struct io_buffer_list *bl, int len)
36 {
37 	/* No data consumed, return false early to avoid consuming the buffer */
38 	if (!len)
39 		return false;
40 
41 	while (len) {
42 		struct io_uring_buf *buf;
43 		u32 buf_len, this_len;
44 
45 		buf = io_ring_head_to_buf(bl->buf_ring, bl->head, bl->mask);
46 		buf_len = READ_ONCE(buf->len);
47 		this_len = min_t(u32, len, buf_len);
48 		buf_len -= this_len;
49 		/* Stop looping for invalid buffer length of 0 */
50 		if (buf_len > bl->min_left_sub_one || !this_len) {
51 			WRITE_ONCE(buf->addr, READ_ONCE(buf->addr) + this_len);
52 			WRITE_ONCE(buf->len, buf_len);
53 			return false;
54 		}
55 		WRITE_ONCE(buf->len, 0);
56 		bl->head++;
57 		len -= this_len;
58 	}
59 	return true;
60 }
61 
62 bool io_kbuf_commit(struct io_kiocb *req,
63 		    struct io_buffer_list *bl, int len, int nr)
64 {
65 	if (unlikely(!(req->flags & REQ_F_BUFFERS_COMMIT)))
66 		return true;
67 
68 	req->flags &= ~REQ_F_BUFFERS_COMMIT;
69 
70 	if (unlikely(len < 0))
71 		return true;
72 	if (bl->flags & IOBL_INC)
73 		return io_kbuf_inc_commit(bl, len);
74 	bl->head += nr;
75 	return true;
76 }
77 
78 static inline struct io_buffer_list *io_buffer_get_list(struct io_ring_ctx *ctx,
79 							unsigned int bgid)
80 {
81 	lockdep_assert_held(&ctx->uring_lock);
82 
83 	return xa_load(&ctx->io_bl_xa, bgid);
84 }
85 
86 static int io_buffer_add_list(struct io_ring_ctx *ctx,
87 			      struct io_buffer_list *bl, unsigned int bgid)
88 {
89 	/*
90 	 * Store buffer group ID and finally mark the list as visible.
91 	 * The normal lookup doesn't care about the visibility as we're
92 	 * always under the ->uring_lock, but lookups from mmap do.
93 	 */
94 	bl->bgid = bgid;
95 	guard(mutex)(&ctx->mmap_lock);
96 	return xa_err(xa_store(&ctx->io_bl_xa, bgid, bl, GFP_KERNEL));
97 }
98 
99 void io_kbuf_drop_legacy(struct io_kiocb *req)
100 {
101 	if (WARN_ON_ONCE(!(req->flags & REQ_F_BUFFER_SELECTED)))
102 		return;
103 	req->flags &= ~REQ_F_BUFFER_SELECTED;
104 	kfree(req->kbuf);
105 	req->kbuf = NULL;
106 }
107 
108 bool io_kbuf_recycle_legacy(struct io_kiocb *req, unsigned issue_flags)
109 {
110 	struct io_ring_ctx *ctx = req->ctx;
111 	struct io_buffer_list *bl;
112 	struct io_buffer *buf;
113 
114 	io_ring_submit_lock(ctx, issue_flags);
115 
116 	buf = req->kbuf;
117 	bl = io_buffer_get_list(ctx, buf->bgid);
118 	/*
119 	 * If the buffer list was upgraded to a ring-based one, or removed,
120 	 * while the request was in-flight in io-wq, drop it.
121 	 */
122 	if (bl && !(bl->flags & IOBL_BUF_RING)) {
123 		list_add(&buf->list, &bl->buf_list);
124 		bl->nbufs++;
125 	} else {
126 		kfree(buf);
127 	}
128 	req->flags &= ~REQ_F_BUFFER_SELECTED;
129 	req->kbuf = NULL;
130 
131 	io_ring_submit_unlock(ctx, issue_flags);
132 	return true;
133 }
134 
135 static void __user *io_provided_buffer_select(struct io_kiocb *req, size_t *len,
136 					      struct io_buffer_list *bl)
137 {
138 	if (!list_empty(&bl->buf_list)) {
139 		struct io_buffer *kbuf;
140 
141 		kbuf = list_first_entry(&bl->buf_list, struct io_buffer, list);
142 		list_del(&kbuf->list);
143 		bl->nbufs--;
144 		if (*len == 0 || *len > kbuf->len)
145 			*len = kbuf->len;
146 		if (list_empty(&bl->buf_list))
147 			req->flags |= REQ_F_BL_EMPTY;
148 		req->flags |= REQ_F_BUFFER_SELECTED;
149 		req->kbuf = kbuf;
150 		req->buf_index = kbuf->bid;
151 		return u64_to_user_ptr(kbuf->addr);
152 	}
153 	return NULL;
154 }
155 
156 static int io_provided_buffers_select(struct io_kiocb *req, size_t *len,
157 				      struct io_buffer_list *bl,
158 				      struct iovec *iov)
159 {
160 	void __user *buf;
161 
162 	buf = io_provided_buffer_select(req, len, bl);
163 	if (unlikely(!buf))
164 		return -ENOBUFS;
165 
166 	iov[0].iov_base = buf;
167 	iov[0].iov_len = *len;
168 	return 1;
169 }
170 
171 static bool io_should_commit(struct io_kiocb *req, unsigned int issue_flags)
172 {
173 	/*
174 	* If we came in unlocked, we have no choice but to consume the
175 	* buffer here, otherwise nothing ensures that the buffer won't
176 	* get used by others. This does mean it'll be pinned until the
177 	* IO completes, coming in unlocked means we're being called from
178 	* io-wq context and there may be further retries in async hybrid
179 	* mode. For the locked case, the caller must call commit when
180 	* the transfer completes (or if we get -EAGAIN and must poll of
181 	* retry).
182 	*/
183 	if (issue_flags & IO_URING_F_UNLOCKED)
184 		return true;
185 
186 	/* uring_cmd commits kbuf upfront, no need to auto-commit */
187 	if (!io_file_can_poll(req) && !io_is_uring_cmd(req))
188 		return true;
189 	return false;
190 }
191 
192 static struct io_br_sel io_ring_buffer_select(struct io_kiocb *req, size_t *len,
193 					      struct io_buffer_list *bl,
194 					      unsigned int issue_flags)
195 {
196 	struct io_uring_buf_ring *br = bl->buf_ring;
197 	__u16 tail, head = bl->head;
198 	struct io_br_sel sel = { };
199 	struct io_uring_buf *buf;
200 	u32 buf_len;
201 
202 	tail = smp_load_acquire(&br->tail);
203 	if (unlikely(tail == head))
204 		return sel;
205 
206 	if (head + 1 == tail)
207 		req->flags |= REQ_F_BL_EMPTY;
208 
209 	buf = io_ring_head_to_buf(br, head, bl->mask);
210 	buf_len = READ_ONCE(buf->len);
211 	if (*len == 0 || *len > buf_len)
212 		*len = buf_len;
213 	req->flags |= REQ_F_BUFFER_RING | REQ_F_BUFFERS_COMMIT;
214 	req->buf_index = READ_ONCE(buf->bid);
215 	sel.buf_list = bl;
216 	sel.addr = u64_to_user_ptr(READ_ONCE(buf->addr));
217 
218 	if (io_should_commit(req, issue_flags)) {
219 		if (!io_kbuf_commit(req, sel.buf_list, *len, 1))
220 			req->flags |= REQ_F_BUF_MORE;
221 		sel.buf_list = NULL;
222 	}
223 	return sel;
224 }
225 
226 struct io_br_sel io_buffer_select(struct io_kiocb *req, size_t *len,
227 				  unsigned buf_group, unsigned int issue_flags)
228 {
229 	struct io_ring_ctx *ctx = req->ctx;
230 	struct io_br_sel sel = { };
231 	struct io_buffer_list *bl;
232 
233 	io_ring_submit_lock(ctx, issue_flags);
234 
235 	bl = io_buffer_get_list(ctx, buf_group);
236 	if (likely(bl)) {
237 		if (bl->flags & IOBL_BUF_RING)
238 			sel = io_ring_buffer_select(req, len, bl, issue_flags);
239 		else
240 			sel.addr = io_provided_buffer_select(req, len, bl);
241 	}
242 	io_ring_submit_unlock(ctx, issue_flags);
243 	return sel;
244 }
245 
246 /* cap it at a reasonable 256, will be one page even for 4K */
247 #define PEEK_MAX_IMPORT		256
248 
249 static int io_ring_buffers_peek(struct io_kiocb *req, struct buf_sel_arg *arg,
250 				struct io_buffer_list *bl)
251 {
252 	struct io_uring_buf_ring *br = bl->buf_ring;
253 	struct iovec *iov = arg->iovs;
254 	int nr_iovs = arg->nr_iovs;
255 	__u16 nr_avail, tail, head;
256 	struct io_uring_buf *buf;
257 
258 	tail = smp_load_acquire(&br->tail);
259 	head = bl->head;
260 	nr_avail = min_t(__u16, tail - head, UIO_MAXIOV);
261 	if (unlikely(!nr_avail))
262 		return -ENOBUFS;
263 
264 	buf = io_ring_head_to_buf(br, head, bl->mask);
265 	if (arg->max_len) {
266 		u32 len = READ_ONCE(buf->len);
267 		size_t needed;
268 
269 		if (unlikely(!len))
270 			return -ENOBUFS;
271 		needed = (arg->max_len + len - 1) / len;
272 		needed = min_not_zero(needed, (size_t) PEEK_MAX_IMPORT);
273 		if (nr_avail > needed)
274 			nr_avail = needed;
275 	}
276 
277 	/*
278 	 * only alloc a bigger array if we know we have data to map, eg not
279 	 * a speculative peek operation.
280 	 */
281 	if (arg->mode & KBUF_MODE_EXPAND && nr_avail > nr_iovs && arg->max_len) {
282 		iov = kmalloc_objs(struct iovec, nr_avail);
283 		if (unlikely(!iov))
284 			return -ENOMEM;
285 		if (arg->mode & KBUF_MODE_FREE)
286 			kfree(arg->iovs);
287 		arg->iovs = iov;
288 		nr_iovs = nr_avail;
289 	} else if (nr_avail < nr_iovs) {
290 		nr_iovs = nr_avail;
291 	}
292 
293 	/* set it to max, if not set, so we can use it unconditionally */
294 	if (!arg->max_len)
295 		arg->max_len = INT_MAX;
296 
297 	req->buf_index = READ_ONCE(buf->bid);
298 	do {
299 		u32 len = READ_ONCE(buf->len);
300 
301 		/* truncate end piece, if needed, for non partial buffers */
302 		if (len > arg->max_len) {
303 			len = arg->max_len;
304 			if (!(bl->flags & IOBL_INC)) {
305 				arg->partial_map = 1;
306 				if (iov != arg->iovs)
307 					break;
308 			}
309 		}
310 
311 		iov->iov_base = u64_to_user_ptr(READ_ONCE(buf->addr));
312 		iov->iov_len = len;
313 		iov++;
314 
315 		arg->out_len += len;
316 		arg->max_len -= len;
317 		if (!arg->max_len)
318 			break;
319 
320 		buf = io_ring_head_to_buf(br, ++head, bl->mask);
321 	} while (--nr_iovs);
322 
323 	if (head == tail)
324 		req->flags |= REQ_F_BL_EMPTY;
325 
326 	req->flags |= REQ_F_BUFFER_RING;
327 	return iov - arg->iovs;
328 }
329 
330 int io_buffers_select(struct io_kiocb *req, struct buf_sel_arg *arg,
331 		      struct io_br_sel *sel, unsigned int issue_flags)
332 {
333 	struct io_ring_ctx *ctx = req->ctx;
334 	int ret = -ENOENT;
335 
336 	io_ring_submit_lock(ctx, issue_flags);
337 	sel->buf_list = io_buffer_get_list(ctx, arg->buf_group);
338 	if (unlikely(!sel->buf_list))
339 		goto out_unlock;
340 
341 	if (sel->buf_list->flags & IOBL_BUF_RING) {
342 		ret = io_ring_buffers_peek(req, arg, sel->buf_list);
343 		/*
344 		 * Don't recycle these buffers if we need to go through poll.
345 		 * Nobody else can use them anyway, and holding on to provided
346 		 * buffers for a send/write operation would happen on the app
347 		 * side anyway with normal buffers. Besides, we already
348 		 * committed them, they cannot be put back in the queue.
349 		 */
350 		if (ret > 0) {
351 			req->flags |= REQ_F_BUFFERS_COMMIT | REQ_F_BL_NO_RECYCLE;
352 			if (!io_kbuf_commit(req, sel->buf_list, arg->out_len, ret))
353 				req->flags |= REQ_F_BUF_MORE;
354 		}
355 	} else {
356 		ret = io_provided_buffers_select(req, &arg->out_len, sel->buf_list, arg->iovs);
357 	}
358 out_unlock:
359 	if (issue_flags & IO_URING_F_UNLOCKED) {
360 		sel->buf_list = NULL;
361 		mutex_unlock(&ctx->uring_lock);
362 	}
363 	return ret;
364 }
365 
366 int io_buffers_peek(struct io_kiocb *req, struct buf_sel_arg *arg,
367 		    struct io_br_sel *sel)
368 {
369 	struct io_ring_ctx *ctx = req->ctx;
370 	struct io_buffer_list *bl;
371 	int ret;
372 
373 	lockdep_assert_held(&ctx->uring_lock);
374 
375 	bl = io_buffer_get_list(ctx, arg->buf_group);
376 	if (unlikely(!bl))
377 		return -ENOENT;
378 
379 	if (bl->flags & IOBL_BUF_RING) {
380 		ret = io_ring_buffers_peek(req, arg, bl);
381 		if (ret > 0)
382 			req->flags |= REQ_F_BUFFERS_COMMIT;
383 		sel->buf_list = bl;
384 		return ret;
385 	}
386 
387 	/* don't support multiple buffer selections for legacy */
388 	sel->buf_list = NULL;
389 	return io_provided_buffers_select(req, &arg->max_len, bl, arg->iovs);
390 }
391 
392 static inline bool __io_put_kbuf_ring(struct io_kiocb *req,
393 				      struct io_buffer_list *bl, int len, int nr)
394 {
395 	bool ret = true;
396 
397 	if (bl)
398 		ret = io_kbuf_commit(req, bl, len, nr);
399 	if (ret && (req->flags & REQ_F_BUF_MORE))
400 		ret = false;
401 
402 	req->flags &= ~(REQ_F_BUFFER_RING | REQ_F_BUF_MORE);
403 	return ret;
404 }
405 
406 unsigned int __io_put_kbufs(struct io_kiocb *req, struct io_buffer_list *bl,
407 			    int len, int nbufs)
408 {
409 	unsigned int ret;
410 
411 	ret = IORING_CQE_F_BUFFER | (req->buf_index << IORING_CQE_BUFFER_SHIFT);
412 
413 	if (unlikely(!(req->flags & REQ_F_BUFFER_RING))) {
414 		io_kbuf_drop_legacy(req);
415 		return ret;
416 	}
417 
418 	if (!__io_put_kbuf_ring(req, bl, len, nbufs))
419 		ret |= IORING_CQE_F_BUF_MORE;
420 	return ret;
421 }
422 
423 static int io_remove_buffers_legacy(struct io_ring_ctx *ctx,
424 				    struct io_buffer_list *bl,
425 				    unsigned long nbufs)
426 {
427 	unsigned long i = 0;
428 	struct io_buffer *nxt;
429 
430 	/* protects io_buffers_cache */
431 	lockdep_assert_held(&ctx->uring_lock);
432 	WARN_ON_ONCE(bl->flags & IOBL_BUF_RING);
433 
434 	for (i = 0; i < nbufs && !list_empty(&bl->buf_list); i++) {
435 		nxt = list_first_entry(&bl->buf_list, struct io_buffer, list);
436 		list_del(&nxt->list);
437 		bl->nbufs--;
438 		kfree(nxt);
439 		cond_resched();
440 	}
441 	return i;
442 }
443 
444 static void io_put_bl(struct io_ring_ctx *ctx, struct io_buffer_list *bl)
445 {
446 	if (bl->flags & IOBL_BUF_RING)
447 		io_free_region(ctx->user, &bl->region);
448 	else
449 		io_remove_buffers_legacy(ctx, bl, -1U);
450 
451 	kfree(bl);
452 }
453 
454 void io_destroy_buffers(struct io_ring_ctx *ctx)
455 {
456 	struct io_buffer_list *bl;
457 
458 	while (1) {
459 		unsigned long index = 0;
460 
461 		scoped_guard(mutex, &ctx->mmap_lock) {
462 			bl = xa_find(&ctx->io_bl_xa, &index, ULONG_MAX, XA_PRESENT);
463 			if (bl)
464 				xa_erase(&ctx->io_bl_xa, bl->bgid);
465 		}
466 		if (!bl)
467 			break;
468 		io_put_bl(ctx, bl);
469 	}
470 }
471 
472 static void io_destroy_bl(struct io_ring_ctx *ctx, struct io_buffer_list *bl)
473 {
474 	scoped_guard(mutex, &ctx->mmap_lock)
475 		WARN_ON_ONCE(xa_erase(&ctx->io_bl_xa, bl->bgid) != bl);
476 	io_put_bl(ctx, bl);
477 }
478 
479 int io_remove_buffers_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe)
480 {
481 	struct io_provide_buf *p = io_kiocb_to_cmd(req, struct io_provide_buf);
482 	u64 tmp;
483 
484 	if (sqe->rw_flags || sqe->addr || sqe->len || sqe->off ||
485 	    sqe->splice_fd_in)
486 		return -EINVAL;
487 
488 	tmp = READ_ONCE(sqe->fd);
489 	if (!tmp || tmp > MAX_BIDS_PER_BGID)
490 		return -EINVAL;
491 
492 	memset(p, 0, sizeof(*p));
493 	p->nbufs = tmp;
494 	p->bgid = READ_ONCE(sqe->buf_group);
495 	return 0;
496 }
497 
498 int io_provide_buffers_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe)
499 {
500 	unsigned long size, tmp_check;
501 	struct io_provide_buf *p = io_kiocb_to_cmd(req, struct io_provide_buf);
502 	u64 tmp;
503 
504 	if (sqe->rw_flags || sqe->splice_fd_in)
505 		return -EINVAL;
506 
507 	tmp = READ_ONCE(sqe->fd);
508 	if (!tmp || tmp > MAX_BIDS_PER_BGID)
509 		return -E2BIG;
510 	p->nbufs = tmp;
511 	p->addr = READ_ONCE(sqe->addr);
512 	p->len = READ_ONCE(sqe->len);
513 	if (!p->len)
514 		return -EINVAL;
515 
516 	if (check_mul_overflow((unsigned long)p->len, (unsigned long)p->nbufs,
517 				&size))
518 		return -EOVERFLOW;
519 	if (check_add_overflow((unsigned long)p->addr, size, &tmp_check))
520 		return -EOVERFLOW;
521 	if (!access_ok(u64_to_user_ptr(p->addr), size))
522 		return -EFAULT;
523 
524 	p->bgid = READ_ONCE(sqe->buf_group);
525 	tmp = READ_ONCE(sqe->off);
526 	if (tmp > USHRT_MAX)
527 		return -E2BIG;
528 	if (tmp + p->nbufs > MAX_BIDS_PER_BGID)
529 		return -EINVAL;
530 	p->bid = tmp;
531 	return 0;
532 }
533 
534 static int io_add_buffers(struct io_ring_ctx *ctx, struct io_provide_buf *pbuf,
535 			  struct io_buffer_list *bl)
536 {
537 	struct io_buffer *buf;
538 	u64 addr = pbuf->addr;
539 	int ret = -ENOMEM, i, bid = pbuf->bid;
540 
541 	for (i = 0; i < pbuf->nbufs; i++) {
542 		/*
543 		 * Nonsensical to have more than sizeof(bid) buffers in a
544 		 * buffer list, as the application then has no way of knowing
545 		 * which duplicate bid refers to what buffer.
546 		 */
547 		if (bl->nbufs == USHRT_MAX) {
548 			ret = -EOVERFLOW;
549 			break;
550 		}
551 		buf = kmalloc_obj(*buf, GFP_KERNEL_ACCOUNT);
552 		if (!buf)
553 			break;
554 
555 		list_add_tail(&buf->list, &bl->buf_list);
556 		bl->nbufs++;
557 		buf->addr = addr;
558 		buf->len = min_t(__u32, pbuf->len, MAX_RW_COUNT);
559 		buf->bid = bid;
560 		buf->bgid = pbuf->bgid;
561 		addr += pbuf->len;
562 		bid++;
563 		cond_resched();
564 	}
565 
566 	return i ? 0 : ret;
567 }
568 
569 static int __io_manage_buffers_legacy(struct io_kiocb *req,
570 					struct io_buffer_list *bl)
571 {
572 	struct io_provide_buf *p = io_kiocb_to_cmd(req, struct io_provide_buf);
573 	int ret;
574 
575 	if (!bl) {
576 		if (req->opcode != IORING_OP_PROVIDE_BUFFERS)
577 			return -ENOENT;
578 		bl = kzalloc_obj(*bl, GFP_KERNEL_ACCOUNT);
579 		if (!bl)
580 			return -ENOMEM;
581 
582 		INIT_LIST_HEAD(&bl->buf_list);
583 		ret = io_buffer_add_list(req->ctx, bl, p->bgid);
584 		if (ret) {
585 			kfree(bl);
586 			return ret;
587 		}
588 	}
589 	/* can't use provide/remove buffers command on mapped buffers */
590 	if (bl->flags & IOBL_BUF_RING)
591 		return -EINVAL;
592 	if (req->opcode == IORING_OP_PROVIDE_BUFFERS)
593 		return io_add_buffers(req->ctx, p, bl);
594 	return io_remove_buffers_legacy(req->ctx, bl, p->nbufs);
595 }
596 
597 int io_manage_buffers_legacy(struct io_kiocb *req, unsigned int issue_flags)
598 {
599 	struct io_provide_buf *p = io_kiocb_to_cmd(req, struct io_provide_buf);
600 	struct io_ring_ctx *ctx = req->ctx;
601 	struct io_buffer_list *bl;
602 	int ret;
603 
604 	io_ring_submit_lock(ctx, issue_flags);
605 	bl = io_buffer_get_list(ctx, p->bgid);
606 	ret = __io_manage_buffers_legacy(req, bl);
607 	io_ring_submit_unlock(ctx, issue_flags);
608 
609 	if (ret < 0)
610 		req_set_fail(req);
611 	io_req_set_res(req, ret, 0);
612 	return IOU_COMPLETE;
613 }
614 
615 int io_register_pbuf_ring(struct io_ring_ctx *ctx, void __user *arg)
616 {
617 	struct io_uring_buf_reg reg;
618 	struct io_buffer_list *bl;
619 	struct io_uring_region_desc rd;
620 	struct io_uring_buf_ring *br;
621 	unsigned long mmap_offset;
622 	unsigned long ring_size;
623 	int ret;
624 
625 	lockdep_assert_held(&ctx->uring_lock);
626 
627 	if (copy_from_user(&reg, arg, sizeof(reg)))
628 		return -EFAULT;
629 	if (!mem_is_zero(reg.resv, sizeof(reg.resv)))
630 		return -EINVAL;
631 	if (reg.flags & ~(IOU_PBUF_RING_MMAP | IOU_PBUF_RING_INC))
632 		return -EINVAL;
633 	if (!is_power_of_2(reg.ring_entries))
634 		return -EINVAL;
635 	/* cannot disambiguate full vs empty due to head/tail size */
636 	if (reg.ring_entries >= 65536)
637 		return -EINVAL;
638 
639 	/* minimum left byte count is a property of incremental buffers */
640 	if (!(reg.flags & IOU_PBUF_RING_INC) && reg.min_left)
641 		return -EINVAL;
642 
643 	bl = io_buffer_get_list(ctx, reg.bgid);
644 	if (bl) {
645 		/* if mapped buffer ring OR classic exists, don't allow */
646 		if (bl->flags & IOBL_BUF_RING || !list_empty(&bl->buf_list))
647 			return -EEXIST;
648 		io_destroy_bl(ctx, bl);
649 	}
650 
651 	bl = kzalloc_obj(*bl, GFP_KERNEL_ACCOUNT);
652 	if (!bl)
653 		return -ENOMEM;
654 
655 	mmap_offset = (unsigned long)reg.bgid << IORING_OFF_PBUF_SHIFT;
656 	ring_size = flex_array_size(br, bufs, reg.ring_entries);
657 
658 	memset(&rd, 0, sizeof(rd));
659 	rd.size = PAGE_ALIGN(ring_size);
660 	if (!(reg.flags & IOU_PBUF_RING_MMAP)) {
661 		rd.user_addr = reg.ring_addr;
662 		rd.flags |= IORING_MEM_REGION_TYPE_USER;
663 	}
664 	ret = io_create_region(ctx, &bl->region, &rd, mmap_offset);
665 	if (ret)
666 		goto fail;
667 	br = io_region_get_ptr(&bl->region);
668 
669 #ifdef SHM_COLOUR
670 	/*
671 	 * On platforms that have specific aliasing requirements, SHM_COLOUR
672 	 * is set and we must guarantee that the kernel and user side align
673 	 * nicely. We cannot do that if IOU_PBUF_RING_MMAP isn't set and
674 	 * the application mmap's the provided ring buffer. Fail the request
675 	 * if we, by chance, don't end up with aligned addresses. The app
676 	 * should use IOU_PBUF_RING_MMAP instead, and liburing will handle
677 	 * this transparently.
678 	 */
679 	if (!(reg.flags & IOU_PBUF_RING_MMAP) &&
680 	    ((reg.ring_addr | (unsigned long)br) & (SHM_COLOUR - 1))) {
681 		ret = -EINVAL;
682 		goto fail;
683 	}
684 #endif
685 
686 	bl->mask = reg.ring_entries - 1;
687 	bl->flags |= IOBL_BUF_RING;
688 	bl->buf_ring = br;
689 	if (reg.min_left)
690 		bl->min_left_sub_one = reg.min_left - 1;
691 	if (reg.flags & IOU_PBUF_RING_INC)
692 		bl->flags |= IOBL_INC;
693 	ret = io_buffer_add_list(ctx, bl, reg.bgid);
694 	if (!ret)
695 		return 0;
696 fail:
697 	io_free_region(ctx->user, &bl->region);
698 	kfree(bl);
699 	return ret;
700 }
701 
702 int io_unregister_pbuf_ring(struct io_ring_ctx *ctx, void __user *arg)
703 {
704 	struct io_uring_buf_reg reg;
705 	struct io_buffer_list *bl;
706 
707 	lockdep_assert_held(&ctx->uring_lock);
708 
709 	if (copy_from_user(&reg, arg, sizeof(reg)))
710 		return -EFAULT;
711 	if (!mem_is_zero(reg.resv, sizeof(reg.resv)) || reg.flags)
712 		return -EINVAL;
713 
714 	bl = io_buffer_get_list(ctx, reg.bgid);
715 	if (!bl)
716 		return -ENOENT;
717 	if (!(bl->flags & IOBL_BUF_RING))
718 		return -EINVAL;
719 
720 	scoped_guard(mutex, &ctx->mmap_lock)
721 		xa_erase(&ctx->io_bl_xa, bl->bgid);
722 
723 	io_put_bl(ctx, bl);
724 	return 0;
725 }
726 
727 int io_register_pbuf_status(struct io_ring_ctx *ctx, void __user *arg)
728 {
729 	struct io_uring_buf_status buf_status;
730 	struct io_buffer_list *bl;
731 
732 	if (copy_from_user(&buf_status, arg, sizeof(buf_status)))
733 		return -EFAULT;
734 	if (!mem_is_zero(buf_status.resv, sizeof(buf_status.resv)))
735 		return -EINVAL;
736 
737 	bl = io_buffer_get_list(ctx, buf_status.buf_group);
738 	if (!bl)
739 		return -ENOENT;
740 	if (!(bl->flags & IOBL_BUF_RING))
741 		return -EINVAL;
742 
743 	buf_status.head = bl->head;
744 	if (copy_to_user(arg, &buf_status, sizeof(buf_status)))
745 		return -EFAULT;
746 
747 	return 0;
748 }
749 
750 struct io_mapped_region *io_pbuf_get_region(struct io_ring_ctx *ctx,
751 					    unsigned int bgid)
752 {
753 	struct io_buffer_list *bl;
754 
755 	lockdep_assert_held(&ctx->mmap_lock);
756 
757 	bl = xa_load(&ctx->io_bl_xa, bgid);
758 	if (!bl || !(bl->flags & IOBL_BUF_RING))
759 		return NULL;
760 	return &bl->region;
761 }
762