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 #include <linux/completion.h>
  41 #include <rdma/ib_peer_mem.h>
  42
  43 struct ib_ucontext;
  44 struct ib_umem;
  45
  46 typedef void (*umem_invalidate_func_t)(void *invalidation_cookie,
  47                                             struct ib_umem *umem,
  48                                             unsigned long addr, size_t size);
  49
  50 struct invalidation_ctx {
  51         struct ib_umem *umem;
  52         umem_invalidate_func_t func;
  53         void *cookie;
  54         unsigned long context_ticket;
  55         int peer_callback;
  56         int inflight_invalidation;
  57         int peer_invalidated;
  58         struct completion comp;
  59 };
  60
  61 struct ib_umem {
  62         struct ib_ucontext     *context;
  63         size_t                  length;
  64         int                     offset;
  65         int                     page_size;
  66         int                     writable;
  67         int                     hugetlb;
  68         struct work_struct      work;
  69         unsigned long           diff;
  70         unsigned long           start;
  71         struct sg_table sg_head;
  72         int                     nmap;
  73         int             npages;
  74         /* peer memory that manages this umem*/
  75         struct ib_peer_memory_client *ib_peer_mem;
  76         struct invalidation_ctx *invalidation_ctx;
  77         int peer_mem_srcu_key;
  78         /* peer memory private context */
  79         void *peer_mem_client_context;
  80 };
  81
  82 struct ib_umem *ib_umem_get(struct ib_ucontext *context, unsigned long addr,
  83                             size_t size, int access, int dmasync);
  84 struct ib_umem *ib_umem_get_ex(struct ib_ucontext *context, unsigned long addr,
  85                             size_t size, int access, int dmasync,
  86                             int invalidation_supported);
  87 void  ib_umem_activate_invalidation_notifier(struct ib_umem *umem,
  88                                                umem_invalidate_func_t func,
  89                                                void *cookie);
  90 void ib_umem_release(struct ib_umem *umem);
  91 int ib_umem_page_count(struct ib_umem *umem);
  92
  93 #endif /* IB_UMEM_H */