drivers/infiniband/core/umem.c

   1 /*
   2  * Copyright (c) 2005 Topspin Communications.  All rights reserved.
   3  * Copyright (c) 2005 Cisco Systems.  All rights reserved.
   4  * Copyright (c) 2005 Mellanox Technologies. All rights reserved.
   5  *
   6  * This software is available to you under a choice of one of two
   7  * licenses.  You may choose to be licensed under the terms of the GNU
   8  * General Public License (GPL) Version 2, available from the file
   9  * COPYING in the main directory of this source tree, or the
  10  * OpenIB.org BSD license below:
  11  *
  12  *     Redistribution and use in source and binary forms, with or
  13  *     without modification, are permitted provided that the following
  14  *     conditions are met:
  15  *
  16  *      - Redistributions of source code must retain the above
  17  *        copyright notice, this list of conditions and the following
  18  *        disclaimer.
  19  *
  20  *      - Redistributions in binary form must reproduce the above
  21  *        copyright notice, this list of conditions and the following
  22  *        disclaimer in the documentation and/or other materials
  23  *        provided with the distribution.
  24  *
  25  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  26  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  27  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  28  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  29  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  30  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  31  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  32  * SOFTWARE.
  33  */
  34
  35 #include <linux/mm.h>
  36 #include <linux/dma-mapping.h>
  37 #include <linux/sched/signal.h>
  38 #include <linux/sched/mm.h>
  39 #include <linux/export.h>
  40 #include <linux/hugetlb.h>
  41 #include <linux/slab.h>
  42 #include <rdma/ib_umem_odp.h>
  43
  44 #include "uverbs.h"
  45
  46
  47 static void __ib_umem_release(struct ib_device *dev, struct ib_umem *umem, int dirty)
  48 {
  49         struct scatterlist *sg;
  50         struct page *page;
  51         int i;
  52
  53         if (umem->nmap > 0)
  54                 ib_dma_unmap_sg(dev, umem->sg_head.sgl,
  55                                 umem->npages,
  56                                 DMA_BIDIRECTIONAL);
  57
  58         for_each_sg(umem->sg_head.sgl, sg, umem->npages, i) {
  59
  60                 page = sg_page(sg);
  61                 if (!PageDirty(page) && umem->writable && dirty)
  62                         set_page_dirty_lock(page);
  63                 put_page(page);
  64         }
  65
  66         sg_free_table(&umem->sg_head);
  67 }
  68
  69 /**
  70  * ib_umem_get - Pin and DMA map userspace memory.
  71  *
  72  * If access flags indicate ODP memory, avoid pinning. Instead, stores
  73  * the mm for future page fault handling in conjunction with MMU notifiers.
  74  *
  75  * @context: userspace context to pin memory for
  76  * @addr: userspace virtual address to start at
  77  * @size: length of region to pin
  78  * @access: IB_ACCESS_xxx flags for memory being pinned
  79  * @dmasync: flush in-flight DMA when the memory region is written
  80  */
  81 struct ib_umem *ib_umem_get(struct ib_ucontext *context, unsigned long addr,
  82                             size_t size, int access, int dmasync)
  83 {
  84         struct ib_umem *umem;
  85         struct page **page_list;
  86         struct vm_area_struct **vma_list;
  87         unsigned long lock_limit;
  88         unsigned long cur_base;
  89         struct mm_struct *mm;
  90         unsigned long npages;
  91         int ret;
  92         int i;
  93         unsigned long dma_attrs = 0;
  94         struct scatterlist *sg, *sg_list_start;
  95         unsigned int gup_flags = FOLL_WRITE;
  96
  97         if (dmasync)
  98                 dma_attrs |= DMA_ATTR_WRITE_BARRIER;
  99
 100         /*
 101          * If the combination of the addr and size requested for this memory
 102          * region causes an integer overflow, return error.
 103          */
 104         if (((addr + size) < addr) ||
 105             PAGE_ALIGN(addr + size) < (addr + size))
 106                 return ERR_PTR(-EINVAL);
 107
 108         if (!can_do_mlock())
 109                 return ERR_PTR(-EPERM);
 110
 111         if (access & IB_ACCESS_ON_DEMAND) {
 112                 umem = kzalloc(sizeof(struct ib_umem_odp), GFP_KERNEL);
 113                 if (!umem)
 114                         return ERR_PTR(-ENOMEM);
 115                 umem->is_odp = 1;
 116         } else {
 117                 umem = kzalloc(sizeof(*umem), GFP_KERNEL);
 118                 if (!umem)
 119                         return ERR_PTR(-ENOMEM);
 120         }
 121
 122         umem->context    = context;
 123         umem->length     = size;
 124         umem->address    = addr;
 125         umem->page_shift = PAGE_SHIFT;
 126         umem->writable   = ib_access_writable(access);
 127         umem->owning_mm = mm = current->mm;
 128         mmgrab(mm);
 129
 130         if (access & IB_ACCESS_ON_DEMAND) {
 131                 ret = ib_umem_odp_get(to_ib_umem_odp(umem), access);
 132                 if (ret)
 133                         goto umem_kfree;
 134                 return umem;
 135         }
 136
 137         /* We assume the memory is from hugetlb until proved otherwise */
 138         umem->hugetlb   = 1;
 139
 140         page_list = (struct page **) __get_free_page(GFP_KERNEL);
 141         if (!page_list) {
 142                 ret = -ENOMEM;
 143                 goto umem_kfree;
 144         }
 145
 146         /*
 147          * if we can't alloc the vma_list, it's not so bad;
 148          * just assume the memory is not hugetlb memory
 149          */
 150         vma_list = (struct vm_area_struct **) __get_free_page(GFP_KERNEL);
 151         if (!vma_list)
 152                 umem->hugetlb = 0;
 153
 154         npages = ib_umem_num_pages(umem);
 155
 156         lock_limit = rlimit(RLIMIT_MEMLOCK) >> PAGE_SHIFT;
 157
 158         down_write(&mm->mmap_sem);
 159         mm->pinned_vm += npages;
 160         if ((mm->pinned_vm > lock_limit) && !capable(CAP_IPC_LOCK)) {
 161                 up_write(&mm->mmap_sem);
 162                 ret = -ENOMEM;
 163                 goto vma;
 164         }
 165         up_write(&mm->mmap_sem);
 166
 167         cur_base = addr & PAGE_MASK;
 168
 169         if (npages == 0 || npages > UINT_MAX) {
 170                 ret = -EINVAL;
 171                 goto vma;
 172         }
 173
 174         ret = sg_alloc_table(&umem->sg_head, npages, GFP_KERNEL);
 175         if (ret)
 176                 goto vma;
 177
 178         if (!umem->writable)
 179                 gup_flags |= FOLL_FORCE;
 180
 181         sg_list_start = umem->sg_head.sgl;
 182
 183         down_read(&mm->mmap_sem);
 184         while (npages) {
 185                 ret = get_user_pages_longterm(cur_base,
 186                                      min_t(unsigned long, npages,
 187                                            PAGE_SIZE / sizeof (struct page *)),
 188                                      gup_flags, page_list, vma_list);
 189                 if (ret < 0) {
 190                         up_read(&mm->mmap_sem);
 191                         goto umem_release;
 192                 }
 193
 194                 umem->npages += ret;
 195                 cur_base += ret * PAGE_SIZE;
 196                 npages   -= ret;
 197
 198                 for_each_sg(sg_list_start, sg, ret, i) {
 199                         if (vma_list && !is_vm_hugetlb_page(vma_list[i]))
 200                                 umem->hugetlb = 0;
 201
 202                         sg_set_page(sg, page_list[i], PAGE_SIZE, 0);
 203                 }
 204
 205                 /* preparing for next loop */
 206                 sg_list_start = sg;
 207         }
 208         up_read(&mm->mmap_sem);
 209
 210         umem->nmap = ib_dma_map_sg_attrs(context->device,
 211                                   umem->sg_head.sgl,
 212                                   umem->npages,
 213                                   DMA_BIDIRECTIONAL,
 214                                   dma_attrs);
 215
 216         if (!umem->nmap) {
 217                 ret = -ENOMEM;
 218                 goto umem_release;
 219         }
 220
 221         ret = 0;
 222         goto out;
 223
 224 umem_release:
 225         __ib_umem_release(context->device, umem, 0);
 226 vma:
 227         down_write(&current->mm->mmap_sem);
 228         current->mm->pinned_vm -= ib_umem_num_pages(umem);
 229         up_write(&current->mm->mmap_sem);
 230 out:
 231         if (vma_list)
 232                 free_page((unsigned long) vma_list);
 233         free_page((unsigned long) page_list);
 234 umem_kfree:
 235         if (ret) {
 236                 mmdrop(umem->owning_mm);
 237                 kfree(umem);
 238         }
 239         return ret ? ERR_PTR(ret) : umem;
 240 }
 241 EXPORT_SYMBOL(ib_umem_get);
 242
 243 static void __ib_umem_release_tail(struct ib_umem *umem)
 244 {
 245         mmdrop(umem->owning_mm);
 246         if (umem->is_odp)
 247                 kfree(to_ib_umem_odp(umem));
 248         else
 249                 kfree(umem);
 250 }
 251
 252 static void ib_umem_release_defer(struct work_struct *work)
 253 {
 254         struct ib_umem *umem = container_of(work, struct ib_umem, work);
 255
 256         down_write(&umem->owning_mm->mmap_sem);
 257         umem->owning_mm->pinned_vm -= ib_umem_num_pages(umem);
 258         up_write(&umem->owning_mm->mmap_sem);
 259
 260         __ib_umem_release_tail(umem);
 261 }
 262
 263 /**
 264  * ib_umem_release - release memory pinned with ib_umem_get
 265  * @umem: umem struct to release
 266  */
 267 void ib_umem_release(struct ib_umem *umem)
 268 {
 269         struct ib_ucontext *context = umem->context;
 270
 271         if (umem->is_odp) {
 272                 ib_umem_odp_release(to_ib_umem_odp(umem));
 273                 __ib_umem_release_tail(umem);
 274                 return;
 275         }
 276
 277         __ib_umem_release(umem->context->device, umem, 1);
 278
 279         /*
 280          * We may be called with the mm's mmap_sem already held.  This
 281          * can happen when a userspace munmap() is the call that drops
 282          * the last reference to our file and calls our release
 283          * method.  If there are memory regions to destroy, we'll end
 284          * up here and not be able to take the mmap_sem.  In that case
 285          * we defer the vm_locked accounting a workqueue.
 286          */
 287         if (context->closing) {
 288                 if (!down_write_trylock(&umem->owning_mm->mmap_sem)) {
 289                         INIT_WORK(&umem->work, ib_umem_release_defer);
 290                         queue_work(ib_wq, &umem->work);
 291                         return;
 292                 }
 293         } else {
 294                 down_write(&umem->owning_mm->mmap_sem);
 295         }
 296         umem->owning_mm->pinned_vm -= ib_umem_num_pages(umem);
 297         up_write(&umem->owning_mm->mmap_sem);
 298
 299         __ib_umem_release_tail(umem);
 300 }
 301 EXPORT_SYMBOL(ib_umem_release);
 302
 303 int ib_umem_page_count(struct ib_umem *umem)
 304 {
 305         int i;
 306         int n;
 307         struct scatterlist *sg;
 308
 309         if (umem->is_odp)
 310                 return ib_umem_num_pages(umem);
 311
 312         n = 0;
 313         for_each_sg(umem->sg_head.sgl, sg, umem->nmap, i)
 314                 n += sg_dma_len(sg) >> umem->page_shift;
 315
 316         return n;
 317 }
 318 EXPORT_SYMBOL(ib_umem_page_count);
 319
 320 /*
 321  * Copy from the given ib_umem's pages to the given buffer.
 322  *
 323  * umem - the umem to copy from
 324  * offset - offset to start copying from
 325  * dst - destination buffer
 326  * length - buffer length
 327  *
 328  * Returns 0 on success, or an error code.
 329  */
 330 int ib_umem_copy_from(void *dst, struct ib_umem *umem, size_t offset,
 331                       size_t length)
 332 {
 333         size_t end = offset + length;
 334         int ret;
 335
 336         if (offset > umem->length || length > umem->length - offset) {
 337                 pr_err("ib_umem_copy_from not in range. offset: %zd umem length: %zd end: %zd\n",
 338                        offset, umem->length, end);
 339                 return -EINVAL;
 340         }
 341
 342         ret = sg_pcopy_to_buffer(umem->sg_head.sgl, umem->npages, dst, length,
 343                                  offset + ib_umem_offset(umem));
 344
 345         if (ret < 0)
 346                 return ret;
 347         else if (ret != length)
 348                 return -EINVAL;
 349         else
 350                 return 0;
 351 }
 352 EXPORT_SYMBOL(ib_umem_copy_from);