sys/ofed/include/rdma/ib_umem.h

   1 /*
   2  * Copyright (c) 2007 Cisco Systems.  All rights reserved.
   3  *
   4  * This software is available to you under a choice of one of two
   5  * licenses.  You may choose to be licensed under the terms of the GNU
   6  * General Public License (GPL) Version 2, available from the file
   7  * COPYING in the main directory of this source tree, or the
   8  * OpenIB.org BSD license below:
   9  *
  10  *     Redistribution and use in source and binary forms, with or
  11  *     without modification, are permitted provided that the following
  12  *     conditions are met:
  13  *
  14  *      - Redistributions of source code must retain the above
  15  *        copyright notice, this list of conditions and the following
  16  *        disclaimer.
  17  *
  18  *      - Redistributions in binary form must reproduce the above
  19  *        copyright notice, this list of conditions and the following
  20  *        disclaimer in the documentation and/or other materials
  21  *        provided with the distribution.
  22  *
  23  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
  24  * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
  25  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
  26  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
  27  * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
  28  * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
  29  * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
  30  * SOFTWARE.
  31  */
  32
  33 #ifndef IB_UMEM_H
  34 #define IB_UMEM_H
  35
  36 #include <linux/list.h>
  37 #include <linux/scatterlist.h>
  38 #include <linux/workqueue.h>
  39 #include <linux/dma-attrs.h>
  40
  41 struct ib_ucontext;
  42 struct vm_area_struct;
  43
  44 struct ib_umem {
  45         struct ib_ucontext     *context;
  46         size_t                  length;
  47         int                     offset;
  48         int                     page_size;
  49         int                     writable;
  50         int                     hugetlb;
  51         struct list_head        chunk_list;
  52 #ifdef __linux__
  53         struct work_struct      work;
  54         struct mm_struct       *mm;
  55 #else
  56         unsigned long           start;
  57 #endif
  58         unsigned long           diff;
  59 };
  60
  61 struct ib_cmem {
  62
  63         struct ib_ucontext     *context;
  64         size_t                  length;
  65         /* Link list of contiguous blocks being part of that cmem  */
  66         struct list_head ib_cmem_block;
  67
  68         /* Order of cmem block,  2^ block_order will equal number
  69              of physical pages per block
  70         */
  71         unsigned long    block_order;
  72         /* Refernce counter for that memory area
  73           - When value became 0 pages will be returned to the kernel.
  74         */
  75         struct kref refcount;
  76 };
  77
  78
  79 struct ib_umem_chunk {
  80         struct list_head        list;
  81         int                     nents;
  82         int                     nmap;
  83         struct dma_attrs        attrs;
  84         struct scatterlist      page_list[0];
  85 };
  86
  87 struct ib_umem *ib_umem_get(struct ib_ucontext *context, unsigned long addr,
  88                             size_t size, int access, int dmasync);
  89 void ib_umem_release(struct ib_umem *umem);
  90 int ib_umem_page_count(struct ib_umem *umem);
  91
  92 int ib_cmem_map_contiguous_pages_to_vma(struct ib_cmem *ib_cmem,
  93         struct vm_area_struct *vma);
  94 struct ib_cmem *ib_cmem_alloc_contiguous_pages(struct ib_ucontext *context,
  95                                 unsigned long total_size,
  96                                 unsigned long page_size_order);
  97 void ib_cmem_release_contiguous_pages(struct ib_cmem *cmem);
  98 int ib_umem_map_to_vma(struct ib_umem *umem,
  99                                 struct vm_area_struct *vma);
 100
 101
 102 #endif /* IB_UMEM_H */