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.h>
  38 #include <linux/export.h>
  39 #include <linux/hugetlb.h>
  40 #include <linux/dma-attrs.h>
  41 #include <linux/slab.h>
  42
  43 #include "uverbs.h"
  44
  45 #define IB_UMEM_MAX_PAGE_CHUNK                                          \
  46         ((PAGE_SIZE - offsetof(struct ib_umem_chunk, page_list)) /      \
  47          ((void *) &((struct ib_umem_chunk *) 0)->page_list[1] -        \
  48           (void *) &((struct ib_umem_chunk *) 0)->page_list[0]))
  49
  50 static void __ib_umem_release(struct ib_device *dev, struct ib_umem *umem, int dirty)
  51 {
  52         struct ib_umem_chunk *chunk, *tmp;
  53         int i;
  54
  55         list_for_each_entry_safe(chunk, tmp, &umem->chunk_list, list) {
  56                 ib_dma_unmap_sg(dev, chunk->page_list,
  57                                 chunk->nents, DMA_BIDIRECTIONAL);
  58                 for (i = 0; i < chunk->nents; ++i) {
  59                         struct page *page = sg_page(&chunk->page_list[i]);
  60
  61                         if (umem->writable && dirty)
  62                                 set_page_dirty_lock(page);
  63                         put_page(page);
  64                 }
  65
  66                 kfree(chunk);
  67         }
  68 }
  69
  70 /**
  71  * ib_umem_get - Pin and DMA map userspace memory.
  72  * @context: userspace context to pin memory for
  73  * @addr: userspace virtual address to start at
  74  * @size: length of region to pin
  75  * @access: IB_ACCESS_xxx flags for memory being pinned
  76  * @dmasync: flush in-flight DMA when the memory region is written
  77  */
  78 struct ib_umem *ib_umem_get(struct ib_ucontext *context, unsigned long addr,
  79                             size_t size, int access, int dmasync)
  80 {
  81         struct ib_umem *umem;
  82         struct page **page_list;
  83         struct vm_area_struct **vma_list;
  84         struct ib_umem_chunk *chunk;
  85         unsigned long locked;
  86         unsigned long lock_limit;
  87         unsigned long cur_base;
  88         unsigned long npages;
  89         int ret;
  90         int off;
  91         int i;
  92         DEFINE_DMA_ATTRS(attrs);
  93
  94         if (dmasync)
  95                 dma_set_attr(DMA_ATTR_WRITE_BARRIER, &attrs);
  96
  97         /*
  98          * If the combination of the addr and size requested for this memory
  99          * region causes an integer overflow, return error.
 100          */
 101         if ((PAGE_ALIGN(addr + size) <= size) ||
 102             (PAGE_ALIGN(addr + size) <= addr))
 103                 return ERR_PTR(-EINVAL);
 104
 105         if (!can_do_mlock())
 106                 return ERR_PTR(-EPERM);
 107
 108         umem = kmalloc(sizeof *umem, GFP_KERNEL);
 109         if (!umem)
 110                 return ERR_PTR(-ENOMEM);
 111
 112         umem->context   = context;
 113         umem->length    = size;
 114         umem->offset    = addr & ~PAGE_MASK;
 115         umem->page_size = PAGE_SIZE;
 116         /*
 117          * We ask for writable memory if any access flags other than
 118          * "remote read" are set.  "Local write" and "remote write"
 119          * obviously require write access.  "Remote atomic" can do
 120          * things like fetch and add, which will modify memory, and
 121          * "MW bind" can change permissions by binding a window.
 122          */
 123         umem->writable  = !!(access & ~IB_ACCESS_REMOTE_READ);
 124
 125         /* We assume the memory is from hugetlb until proved otherwise */
 126         umem->hugetlb   = 1;
 127
 128         INIT_LIST_HEAD(&umem->chunk_list);
 129
 130         page_list = (struct page **) __get_free_page(GFP_KERNEL);
 131         if (!page_list) {
 132                 kfree(umem);
 133                 return ERR_PTR(-ENOMEM);
 134         }
 135
 136         /*
 137          * if we can't alloc the vma_list, it's not so bad;
 138          * just assume the memory is not hugetlb memory
 139          */
 140         vma_list = (struct vm_area_struct **) __get_free_page(GFP_KERNEL);
 141         if (!vma_list)
 142                 umem->hugetlb = 0;
 143
 144         npages = PAGE_ALIGN(size + umem->offset) >> PAGE_SHIFT;
 145
 146         down_write(&current->mm->mmap_sem);
 147
 148         locked     = npages + current->mm->pinned_vm;
 149         lock_limit = rlimit(RLIMIT_MEMLOCK) >> PAGE_SHIFT;
 150
 151         if ((locked > lock_limit) && !capable(CAP_IPC_LOCK)) {
 152                 ret = -ENOMEM;
 153                 goto out;
 154         }
 155
 156         cur_base = addr & PAGE_MASK;
 157
 158         ret = 0;
 159         while (npages) {
 160                 ret = get_user_pages(current, current->mm, cur_base,
 161                                      min_t(unsigned long, npages,
 162                                            PAGE_SIZE / sizeof (struct page *)),
 163                                      1, !umem->writable, page_list, vma_list);
 164
 165                 if (ret < 0)
 166                         goto out;
 167
 168                 cur_base += ret * PAGE_SIZE;
 169                 npages   -= ret;
 170
 171                 off = 0;
 172
 173                 while (ret) {
 174                         chunk = kmalloc(sizeof *chunk + sizeof (struct scatterlist) *
 175                                         min_t(int, ret, IB_UMEM_MAX_PAGE_CHUNK),
 176                                         GFP_KERNEL);
 177                         if (!chunk) {
 178                                 ret = -ENOMEM;
 179                                 goto out;
 180                         }
 181
 182                         chunk->nents = min_t(int, ret, IB_UMEM_MAX_PAGE_CHUNK);
 183                         sg_init_table(chunk->page_list, chunk->nents);
 184                         for (i = 0; i < chunk->nents; ++i) {
 185                                 if (vma_list &&
 186                                     !is_vm_hugetlb_page(vma_list[i + off]))
 187                                         umem->hugetlb = 0;
 188                                 sg_set_page(&chunk->page_list[i], page_list[i + off], PAGE_SIZE, 0);
 189                         }
 190
 191                         chunk->nmap = ib_dma_map_sg_attrs(context->device,
 192                                                           &chunk->page_list[0],
 193                                                           chunk->nents,
 194                                                           DMA_BIDIRECTIONAL,
 195                                                           &attrs);
 196                         if (chunk->nmap <= 0) {
 197                                 for (i = 0; i < chunk->nents; ++i)
 198                                         put_page(sg_page(&chunk->page_list[i]));
 199                                 kfree(chunk);
 200
 201                                 ret = -ENOMEM;
 202                                 goto out;
 203                         }
 204
 205                         ret -= chunk->nents;
 206                         off += chunk->nents;
 207                         list_add_tail(&chunk->list, &umem->chunk_list);
 208                 }
 209
 210                 ret = 0;
 211         }
 212
 213 out:
 214         if (ret < 0) {
 215                 __ib_umem_release(context->device, umem, 0);
 216                 kfree(umem);
 217         } else
 218                 current->mm->pinned_vm = locked;
 219
 220         up_write(&current->mm->mmap_sem);
 221         if (vma_list)
 222                 free_page((unsigned long) vma_list);
 223         free_page((unsigned long) page_list);
 224
 225         return ret < 0 ? ERR_PTR(ret) : umem;
 226 }
 227 EXPORT_SYMBOL(ib_umem_get);
 228
 229 static void ib_umem_account(struct work_struct *work)
 230 {
 231         struct ib_umem *umem = container_of(work, struct ib_umem, work);
 232
 233         down_write(&umem->mm->mmap_sem);
 234         umem->mm->pinned_vm -= umem->diff;
 235         up_write(&umem->mm->mmap_sem);
 236         mmput(umem->mm);
 237         kfree(umem);
 238 }
 239
 240 /**
 241  * ib_umem_release - release memory pinned with ib_umem_get
 242  * @umem: umem struct to release
 243  */
 244 void ib_umem_release(struct ib_umem *umem)
 245 {
 246         struct ib_ucontext *context = umem->context;
 247         struct mm_struct *mm;
 248         unsigned long diff;
 249
 250         __ib_umem_release(umem->context->device, umem, 1);
 251
 252         mm = get_task_mm(current);
 253         if (!mm) {
 254                 kfree(umem);
 255                 return;
 256         }
 257
 258         diff = PAGE_ALIGN(umem->length + umem->offset) >> PAGE_SHIFT;
 259
 260         /*
 261          * We may be called with the mm's mmap_sem already held.  This
 262          * can happen when a userspace munmap() is the call that drops
 263          * the last reference to our file and calls our release
 264          * method.  If there are memory regions to destroy, we'll end
 265          * up here and not be able to take the mmap_sem.  In that case
 266          * we defer the vm_locked accounting to the system workqueue.
 267          */
 268         if (context->closing) {
 269                 if (!down_write_trylock(&mm->mmap_sem)) {
 270                         INIT_WORK(&umem->work, ib_umem_account);
 271                         umem->mm   = mm;
 272                         umem->diff = diff;
 273
 274                         queue_work(ib_wq, &umem->work);
 275                         return;
 276                 }
 277         } else
 278                 down_write(&mm->mmap_sem);
 279
 280         current->mm->pinned_vm -= diff;
 281         up_write(&mm->mmap_sem);
 282         mmput(mm);
 283         kfree(umem);
 284 }
 285 EXPORT_SYMBOL(ib_umem_release);
 286
 287 int ib_umem_page_count(struct ib_umem *umem)
 288 {
 289         struct ib_umem_chunk *chunk;
 290         int shift;
 291         int i;
 292         int n;
 293
 294         shift = ilog2(umem->page_size);
 295
 296         n = 0;
 297         list_for_each_entry(chunk, &umem->chunk_list, list)
 298                 for (i = 0; i < chunk->nmap; ++i)
 299                         n += sg_dma_len(&chunk->page_list[i]) >> shift;
 300
 301         return n;
 302 }
 303 EXPORT_SYMBOL(ib_umem_page_count);