xref: /freebsd/sys/ofed/include/rdma/ib_umem.h (revision bb15ca603fa442c72dde3f3cb8b46db6970e3950)
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 
43 struct ib_umem {
44 	struct ib_ucontext     *context;
45 	size_t			length;
46 	int			offset;
47 	int			page_size;
48 	int                     writable;
49 	int                     hugetlb;
50 	struct list_head	chunk_list;
51 #ifdef __linux__
52 	struct work_struct	work;
53 	struct mm_struct       *mm;
54 #else
55 	unsigned long		start;
56 #endif
57 	unsigned long		diff;
58 };
59 
60 struct ib_umem_chunk {
61 	struct list_head	list;
62 	int                     nents;
63 	int                     nmap;
64 	struct dma_attrs	attrs;
65 	struct scatterlist      page_list[0];
66 };
67 
68 struct ib_umem *ib_umem_get(struct ib_ucontext *context, unsigned long addr,
69 			    size_t size, int access, int dmasync);
70 void ib_umem_release(struct ib_umem *umem);
71 int ib_umem_page_count(struct ib_umem *umem);
72 
73 #endif /* IB_UMEM_H */
74