io_uring/kbuf.c

   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.h"
  15 #include "opdef.h"
  16 #include "kbuf.h"
  17
  18 #define IO_BUFFER_LIST_BUF_PER_PAGE (PAGE_SIZE / sizeof(struct io_uring_buf))
  19
  20 #define BGID_ARRAY      64
  21
  22 struct io_provide_buf {
  23         struct file                     *file;
  24         __u64                           addr;
  25         __u32                           len;
  26         __u32                           bgid;
  27         __u16                           nbufs;
  28         __u16                           bid;
  29 };
  30
  31 static inline struct io_buffer_list *io_buffer_get_list(struct io_ring_ctx *ctx,
  32                                                         unsigned int bgid)
  33 {
  34         if (ctx->io_bl && bgid < BGID_ARRAY)
  35                 return &ctx->io_bl[bgid];
  36
  37         return xa_load(&ctx->io_bl_xa, bgid);
  38 }
  39
  40 static int io_buffer_add_list(struct io_ring_ctx *ctx,
  41                               struct io_buffer_list *bl, unsigned int bgid)
  42 {
  43         bl->bgid = bgid;
  44         if (bgid < BGID_ARRAY)
  45                 return 0;
  46
  47         return xa_err(xa_store(&ctx->io_bl_xa, bgid, bl, GFP_KERNEL));
  48 }
  49
  50 void io_kbuf_recycle_legacy(struct io_kiocb *req, unsigned issue_flags)
  51 {
  52         struct io_ring_ctx *ctx = req->ctx;
  53         struct io_buffer_list *bl;
  54         struct io_buffer *buf;
  55
  56         /*
  57          * For legacy provided buffer mode, don't recycle if we already did
  58          * IO to this buffer. For ring-mapped provided buffer mode, we should
  59          * increment ring->head to explicitly monopolize the buffer to avoid
  60          * multiple use.
  61          */
  62         if (req->flags & REQ_F_PARTIAL_IO)
  63                 return;
  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         return;
  75 }
  76
  77 unsigned int __io_put_kbuf(struct io_kiocb *req, unsigned issue_flags)
  78 {
  79         unsigned int cflags;
  80
  81         /*
  82          * We can add this buffer back to two lists:
  83          *
  84          * 1) The io_buffers_cache list. This one is protected by the
  85          *    ctx->uring_lock. If we already hold this lock, add back to this
  86          *    list as we can grab it from issue as well.
  87          * 2) The io_buffers_comp list. This one is protected by the
  88          *    ctx->completion_lock.
  89          *
  90          * We migrate buffers from the comp_list to the issue cache list
  91          * when we need one.
  92          */
  93         if (req->flags & REQ_F_BUFFER_RING) {
  94                 /* no buffers to recycle for this case */
  95                 cflags = __io_put_kbuf_list(req, NULL);
  96         } else if (issue_flags & IO_URING_F_UNLOCKED) {
  97                 struct io_ring_ctx *ctx = req->ctx;
  98
  99                 spin_lock(&ctx->completion_lock);
 100                 cflags = __io_put_kbuf_list(req, &ctx->io_buffers_comp);
 101                 spin_unlock(&ctx->completion_lock);
 102         } else {
 103                 lockdep_assert_held(&req->ctx->uring_lock);
 104
 105                 cflags = __io_put_kbuf_list(req, &req->ctx->io_buffers_cache);
 106         }
 107         return cflags;
 108 }
 109
 110 static void __user *io_provided_buffer_select(struct io_kiocb *req, size_t *len,
 111                                               struct io_buffer_list *bl)
 112 {
 113         if (!list_empty(&bl->buf_list)) {
 114                 struct io_buffer *kbuf;
 115
 116                 kbuf = list_first_entry(&bl->buf_list, struct io_buffer, list);
 117                 list_del(&kbuf->list);
 118                 if (*len == 0 || *len > kbuf->len)
 119                         *len = kbuf->len;
 120                 req->flags |= REQ_F_BUFFER_SELECTED;
 121                 req->kbuf = kbuf;
 122                 req->buf_index = kbuf->bid;
 123                 return u64_to_user_ptr(kbuf->addr);
 124         }
 125         return NULL;
 126 }
 127
 128 static void __user *io_ring_buffer_select(struct io_kiocb *req, size_t *len,
 129                                           struct io_buffer_list *bl,
 130                                           unsigned int issue_flags)
 131 {
 132         struct io_uring_buf_ring *br = bl->buf_ring;
 133         struct io_uring_buf *buf;
 134         __u16 head = bl->head;
 135
 136         if (unlikely(smp_load_acquire(&br->tail) == head))
 137                 return NULL;
 138
 139         head &= bl->mask;
 140         /* mmaped buffers are always contig */
 141         if (bl->is_mmap || head < IO_BUFFER_LIST_BUF_PER_PAGE) {
 142                 buf = &br->bufs[head];
 143         } else {
 144                 int off = head & (IO_BUFFER_LIST_BUF_PER_PAGE - 1);
 145                 int index = head / IO_BUFFER_LIST_BUF_PER_PAGE;
 146                 buf = page_address(bl->buf_pages[index]);
 147                 buf += off;
 148         }
 149         if (*len == 0 || *len > buf->len)
 150                 *len = buf->len;
 151         req->flags |= REQ_F_BUFFER_RING;
 152         req->buf_list = bl;
 153         req->buf_index = buf->bid;
 154
 155         if (issue_flags & IO_URING_F_UNLOCKED || !file_can_poll(req->file)) {
 156                 /*
 157                  * If we came in unlocked, we have no choice but to consume the
 158                  * buffer here, otherwise nothing ensures that the buffer won't
 159                  * get used by others. This does mean it'll be pinned until the
 160                  * IO completes, coming in unlocked means we're being called from
 161                  * io-wq context and there may be further retries in async hybrid
 162                  * mode. For the locked case, the caller must call commit when
 163                  * the transfer completes (or if we get -EAGAIN and must poll of
 164                  * retry).
 165                  */
 166                 req->buf_list = NULL;
 167                 bl->head++;
 168         }
 169         return u64_to_user_ptr(buf->addr);
 170 }
 171
 172 void __user *io_buffer_select(struct io_kiocb *req, size_t *len,
 173                               unsigned int issue_flags)
 174 {
 175         struct io_ring_ctx *ctx = req->ctx;
 176         struct io_buffer_list *bl;
 177         void __user *ret = NULL;
 178
 179         io_ring_submit_lock(req->ctx, issue_flags);
 180
 181         bl = io_buffer_get_list(ctx, req->buf_index);
 182         if (likely(bl)) {
 183                 if (bl->is_mapped)
 184                         ret = io_ring_buffer_select(req, len, bl, issue_flags);
 185                 else
 186                         ret = io_provided_buffer_select(req, len, bl);
 187         }
 188         io_ring_submit_unlock(req->ctx, issue_flags);
 189         return ret;
 190 }
 191
 192 static __cold int io_init_bl_list(struct io_ring_ctx *ctx)
 193 {
 194         int i;
 195
 196         ctx->io_bl = kcalloc(BGID_ARRAY, sizeof(struct io_buffer_list),
 197                                 GFP_KERNEL);
 198         if (!ctx->io_bl)
 199                 return -ENOMEM;
 200
 201         for (i = 0; i < BGID_ARRAY; i++) {
 202                 INIT_LIST_HEAD(&ctx->io_bl[i].buf_list);
 203                 ctx->io_bl[i].bgid = i;
 204         }
 205
 206         return 0;
 207 }
 208
 209 static int __io_remove_buffers(struct io_ring_ctx *ctx,
 210                                struct io_buffer_list *bl, unsigned nbufs)
 211 {
 212         unsigned i = 0;
 213
 214         /* shouldn't happen */
 215         if (!nbufs)
 216                 return 0;
 217
 218         if (bl->is_mapped) {
 219                 i = bl->buf_ring->tail - bl->head;
 220                 if (bl->is_mmap) {
 221                         struct page *page;
 222
 223                         page = virt_to_head_page(bl->buf_ring);
 224                         if (put_page_testzero(page))
 225                                 free_compound_page(page);
 226                         bl->buf_ring = NULL;
 227                         bl->is_mmap = 0;
 228                 } else if (bl->buf_nr_pages) {
 229                         int j;
 230
 231                         for (j = 0; j < bl->buf_nr_pages; j++)
 232                                 unpin_user_page(bl->buf_pages[j]);
 233                         kvfree(bl->buf_pages);
 234                         bl->buf_pages = NULL;
 235                         bl->buf_nr_pages = 0;
 236                 }
 237                 /* make sure it's seen as empty */
 238                 INIT_LIST_HEAD(&bl->buf_list);
 239                 bl->is_mapped = 0;
 240                 return i;
 241         }
 242
 243         /* the head kbuf is the list itself */
 244         while (!list_empty(&bl->buf_list)) {
 245                 struct io_buffer *nxt;
 246
 247                 nxt = list_first_entry(&bl->buf_list, struct io_buffer, list);
 248                 list_del(&nxt->list);
 249                 if (++i == nbufs)
 250                         return i;
 251                 cond_resched();
 252         }
 253         i++;
 254
 255         return i;
 256 }
 257
 258 void io_destroy_buffers(struct io_ring_ctx *ctx)
 259 {
 260         struct io_buffer_list *bl;
 261         unsigned long index;
 262         int i;
 263
 264         for (i = 0; i < BGID_ARRAY; i++) {
 265                 if (!ctx->io_bl)
 266                         break;
 267                 __io_remove_buffers(ctx, &ctx->io_bl[i], -1U);
 268         }
 269
 270         xa_for_each(&ctx->io_bl_xa, index, bl) {
 271                 xa_erase(&ctx->io_bl_xa, bl->bgid);
 272                 __io_remove_buffers(ctx, bl, -1U);
 273                 kfree(bl);
 274         }
 275
 276         while (!list_empty(&ctx->io_buffers_pages)) {
 277                 struct page *page;
 278
 279                 page = list_first_entry(&ctx->io_buffers_pages, struct page, lru);
 280                 list_del_init(&page->lru);
 281                 __free_page(page);
 282         }
 283 }
 284
 285 int io_remove_buffers_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe)
 286 {
 287         struct io_provide_buf *p = io_kiocb_to_cmd(req, struct io_provide_buf);
 288         u64 tmp;
 289
 290         if (sqe->rw_flags || sqe->addr || sqe->len || sqe->off ||
 291             sqe->splice_fd_in)
 292                 return -EINVAL;
 293
 294         tmp = READ_ONCE(sqe->fd);
 295         if (!tmp || tmp > USHRT_MAX)
 296                 return -EINVAL;
 297
 298         memset(p, 0, sizeof(*p));
 299         p->nbufs = tmp;
 300         p->bgid = READ_ONCE(sqe->buf_group);
 301         return 0;
 302 }
 303
 304 int io_remove_buffers(struct io_kiocb *req, unsigned int issue_flags)
 305 {
 306         struct io_provide_buf *p = io_kiocb_to_cmd(req, struct io_provide_buf);
 307         struct io_ring_ctx *ctx = req->ctx;
 308         struct io_buffer_list *bl;
 309         int ret = 0;
 310
 311         io_ring_submit_lock(ctx, issue_flags);
 312
 313         ret = -ENOENT;
 314         bl = io_buffer_get_list(ctx, p->bgid);
 315         if (bl) {
 316                 ret = -EINVAL;
 317                 /* can't use provide/remove buffers command on mapped buffers */
 318                 if (!bl->is_mapped)
 319                         ret = __io_remove_buffers(ctx, bl, p->nbufs);
 320         }
 321         io_ring_submit_unlock(ctx, issue_flags);
 322         if (ret < 0)
 323                 req_set_fail(req);
 324         io_req_set_res(req, ret, 0);
 325         return IOU_OK;
 326 }
 327
 328 int io_provide_buffers_prep(struct io_kiocb *req, const struct io_uring_sqe *sqe)
 329 {
 330         unsigned long size, tmp_check;
 331         struct io_provide_buf *p = io_kiocb_to_cmd(req, struct io_provide_buf);
 332         u64 tmp;
 333
 334         if (sqe->rw_flags || sqe->splice_fd_in)
 335                 return -EINVAL;
 336
 337         tmp = READ_ONCE(sqe->fd);
 338         if (!tmp || tmp > USHRT_MAX)
 339                 return -E2BIG;
 340         p->nbufs = tmp;
 341         p->addr = READ_ONCE(sqe->addr);
 342         p->len = READ_ONCE(sqe->len);
 343
 344         if (check_mul_overflow((unsigned long)p->len, (unsigned long)p->nbufs,
 345                                 &size))
 346                 return -EOVERFLOW;
 347         if (check_add_overflow((unsigned long)p->addr, size, &tmp_check))
 348                 return -EOVERFLOW;
 349
 350         size = (unsigned long)p->len * p->nbufs;
 351         if (!access_ok(u64_to_user_ptr(p->addr), size))
 352                 return -EFAULT;
 353
 354         p->bgid = READ_ONCE(sqe->buf_group);
 355         tmp = READ_ONCE(sqe->off);
 356         if (tmp > USHRT_MAX)
 357                 return -E2BIG;
 358         if (tmp + p->nbufs >= USHRT_MAX)
 359                 return -EINVAL;
 360         p->bid = tmp;
 361         return 0;
 362 }
 363
 364 static int io_refill_buffer_cache(struct io_ring_ctx *ctx)
 365 {
 366         struct io_buffer *buf;
 367         struct page *page;
 368         int bufs_in_page;
 369
 370         /*
 371          * Completions that don't happen inline (eg not under uring_lock) will
 372          * add to ->io_buffers_comp. If we don't have any free buffers, check
 373          * the completion list and splice those entries first.
 374          */
 375         if (!list_empty_careful(&ctx->io_buffers_comp)) {
 376                 spin_lock(&ctx->completion_lock);
 377                 if (!list_empty(&ctx->io_buffers_comp)) {
 378                         list_splice_init(&ctx->io_buffers_comp,
 379                                                 &ctx->io_buffers_cache);
 380                         spin_unlock(&ctx->completion_lock);
 381                         return 0;
 382                 }
 383                 spin_unlock(&ctx->completion_lock);
 384         }
 385
 386         /*
 387          * No free buffers and no completion entries either. Allocate a new
 388          * page worth of buffer entries and add those to our freelist.
 389          */
 390         page = alloc_page(GFP_KERNEL_ACCOUNT);
 391         if (!page)
 392                 return -ENOMEM;
 393
 394         list_add(&page->lru, &ctx->io_buffers_pages);
 395
 396         buf = page_address(page);
 397         bufs_in_page = PAGE_SIZE / sizeof(*buf);
 398         while (bufs_in_page) {
 399                 list_add_tail(&buf->list, &ctx->io_buffers_cache);
 400                 buf++;
 401                 bufs_in_page--;
 402         }
 403
 404         return 0;
 405 }
 406
 407 static int io_add_buffers(struct io_ring_ctx *ctx, struct io_provide_buf *pbuf,
 408                           struct io_buffer_list *bl)
 409 {
 410         struct io_buffer *buf;
 411         u64 addr = pbuf->addr;
 412         int i, bid = pbuf->bid;
 413
 414         for (i = 0; i < pbuf->nbufs; i++) {
 415                 if (list_empty(&ctx->io_buffers_cache) &&
 416                     io_refill_buffer_cache(ctx))
 417                         break;
 418                 buf = list_first_entry(&ctx->io_buffers_cache, struct io_buffer,
 419                                         list);
 420                 list_move_tail(&buf->list, &bl->buf_list);
 421                 buf->addr = addr;
 422                 buf->len = min_t(__u32, pbuf->len, MAX_RW_COUNT);
 423                 buf->bid = bid;
 424                 buf->bgid = pbuf->bgid;
 425                 addr += pbuf->len;
 426                 bid++;
 427                 cond_resched();
 428         }
 429
 430         return i ? 0 : -ENOMEM;
 431 }
 432
 433 int io_provide_buffers(struct io_kiocb *req, unsigned int issue_flags)
 434 {
 435         struct io_provide_buf *p = io_kiocb_to_cmd(req, struct io_provide_buf);
 436         struct io_ring_ctx *ctx = req->ctx;
 437         struct io_buffer_list *bl;
 438         int ret = 0;
 439
 440         io_ring_submit_lock(ctx, issue_flags);
 441
 442         if (unlikely(p->bgid < BGID_ARRAY && !ctx->io_bl)) {
 443                 ret = io_init_bl_list(ctx);
 444                 if (ret)
 445                         goto err;
 446         }
 447
 448         bl = io_buffer_get_list(ctx, p->bgid);
 449         if (unlikely(!bl)) {
 450                 bl = kzalloc(sizeof(*bl), GFP_KERNEL_ACCOUNT);
 451                 if (!bl) {
 452                         ret = -ENOMEM;
 453                         goto err;
 454                 }
 455                 INIT_LIST_HEAD(&bl->buf_list);
 456                 ret = io_buffer_add_list(ctx, bl, p->bgid);
 457                 if (ret) {
 458                         kfree(bl);
 459                         goto err;
 460                 }
 461         }
 462         /* can't add buffers via this command for a mapped buffer ring */
 463         if (bl->is_mapped) {
 464                 ret = -EINVAL;
 465                 goto err;
 466         }
 467
 468         ret = io_add_buffers(ctx, p, bl);
 469 err:
 470         io_ring_submit_unlock(ctx, issue_flags);
 471
 472         if (ret < 0)
 473                 req_set_fail(req);
 474         io_req_set_res(req, ret, 0);
 475         return IOU_OK;
 476 }
 477
 478 static int io_pin_pbuf_ring(struct io_uring_buf_reg *reg,
 479                             struct io_buffer_list *bl)
 480 {
 481         struct io_uring_buf_ring *br;
 482         struct page **pages;
 483         int nr_pages;
 484
 485         pages = io_pin_pages(reg->ring_addr,
 486                              flex_array_size(br, bufs, reg->ring_entries),
 487                              &nr_pages);
 488         if (IS_ERR(pages))
 489                 return PTR_ERR(pages);
 490
 491         br = page_address(pages[0]);
 492 #ifdef SHM_COLOUR
 493         /*
 494          * On platforms that have specific aliasing requirements, SHM_COLOUR
 495          * is set and we must guarantee that the kernel and user side align
 496          * nicely. We cannot do that if IOU_PBUF_RING_MMAP isn't set and
 497          * the application mmap's the provided ring buffer. Fail the request
 498          * if we, by chance, don't end up with aligned addresses. The app
 499          * should use IOU_PBUF_RING_MMAP instead, and liburing will handle
 500          * this transparently.
 501          */
 502         if ((reg->ring_addr | (unsigned long) br) & (SHM_COLOUR - 1)) {
 503                 int i;
 504
 505                 for (i = 0; i < nr_pages; i++)
 506                         unpin_user_page(pages[i]);
 507                 return -EINVAL;
 508         }
 509 #endif
 510         bl->buf_pages = pages;
 511         bl->buf_nr_pages = nr_pages;
 512         bl->buf_ring = br;
 513         bl->is_mapped = 1;
 514         bl->is_mmap = 0;
 515         return 0;
 516 }
 517
 518 static int io_alloc_pbuf_ring(struct io_uring_buf_reg *reg,
 519                               struct io_buffer_list *bl)
 520 {
 521         gfp_t gfp = GFP_KERNEL_ACCOUNT | __GFP_ZERO | __GFP_NOWARN | __GFP_COMP;
 522         size_t ring_size;
 523         void *ptr;
 524
 525         ring_size = reg->ring_entries * sizeof(struct io_uring_buf_ring);
 526         ptr = (void *) __get_free_pages(gfp, get_order(ring_size));
 527         if (!ptr)
 528                 return -ENOMEM;
 529
 530         bl->buf_ring = ptr;
 531         bl->is_mapped = 1;
 532         bl->is_mmap = 1;
 533         return 0;
 534 }
 535
 536 int io_register_pbuf_ring(struct io_ring_ctx *ctx, void __user *arg)
 537 {
 538         struct io_uring_buf_reg reg;
 539         struct io_buffer_list *bl, *free_bl = NULL;
 540         int ret;
 541
 542         if (copy_from_user(&reg, arg, sizeof(reg)))
 543                 return -EFAULT;
 544
 545         if (reg.resv[0] || reg.resv[1] || reg.resv[2])
 546                 return -EINVAL;
 547         if (reg.flags & ~IOU_PBUF_RING_MMAP)
 548                 return -EINVAL;
 549         if (!(reg.flags & IOU_PBUF_RING_MMAP)) {
 550                 if (!reg.ring_addr)
 551                         return -EFAULT;
 552                 if (reg.ring_addr & ~PAGE_MASK)
 553                         return -EINVAL;
 554         } else {
 555                 if (reg.ring_addr)
 556                         return -EINVAL;
 557         }
 558
 559         if (!is_power_of_2(reg.ring_entries))
 560                 return -EINVAL;
 561
 562         /* cannot disambiguate full vs empty due to head/tail size */
 563         if (reg.ring_entries >= 65536)
 564                 return -EINVAL;
 565
 566         if (unlikely(reg.bgid < BGID_ARRAY && !ctx->io_bl)) {
 567                 int ret = io_init_bl_list(ctx);
 568                 if (ret)
 569                         return ret;
 570         }
 571
 572         bl = io_buffer_get_list(ctx, reg.bgid);
 573         if (bl) {
 574                 /* if mapped buffer ring OR classic exists, don't allow */
 575                 if (bl->is_mapped || !list_empty(&bl->buf_list))
 576                         return -EEXIST;
 577         } else {
 578                 free_bl = bl = kzalloc(sizeof(*bl), GFP_KERNEL);
 579                 if (!bl)
 580                         return -ENOMEM;
 581         }
 582
 583         if (!(reg.flags & IOU_PBUF_RING_MMAP))
 584                 ret = io_pin_pbuf_ring(&reg, bl);
 585         else
 586                 ret = io_alloc_pbuf_ring(&reg, bl);
 587
 588         if (!ret) {
 589                 bl->nr_entries = reg.ring_entries;
 590                 bl->mask = reg.ring_entries - 1;
 591
 592                 io_buffer_add_list(ctx, bl, reg.bgid);
 593                 return 0;
 594         }
 595
 596         kfree(free_bl);
 597         return ret;
 598 }
 599
 600 int io_unregister_pbuf_ring(struct io_ring_ctx *ctx, void __user *arg)
 601 {
 602         struct io_uring_buf_reg reg;
 603         struct io_buffer_list *bl;
 604
 605         if (copy_from_user(&reg, arg, sizeof(reg)))
 606                 return -EFAULT;
 607         if (reg.resv[0] || reg.resv[1] || reg.resv[2])
 608                 return -EINVAL;
 609         if (reg.flags)
 610                 return -EINVAL;
 611
 612         bl = io_buffer_get_list(ctx, reg.bgid);
 613         if (!bl)
 614                 return -ENOENT;
 615         if (!bl->is_mapped)
 616                 return -EINVAL;
 617
 618         __io_remove_buffers(ctx, bl, -1U);
 619         if (bl->bgid >= BGID_ARRAY) {
 620                 xa_erase(&ctx->io_bl_xa, bl->bgid);
 621                 kfree(bl);
 622         }
 623         return 0;
 624 }
 625
 626 void *io_pbuf_get_address(struct io_ring_ctx *ctx, unsigned long bgid)
 627 {
 628         struct io_buffer_list *bl;
 629
 630         bl = io_buffer_get_list(ctx, bgid);
 631         if (!bl || !bl->is_mmap)
 632                 return NULL;
 633
 634         return bl->buf_ring;
 635 }