1 /*
2  * Copyright (c) 2017, Mellanox Technologies inc.  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 _UVERBS_STD_TYPES__
34 #define _UVERBS_STD_TYPES__
35 
36 #include <rdma/uverbs_types.h>
37 #include <rdma/uverbs_ioctl.h>
38 #include <rdma/ib_user_ioctl_verbs.h>
39 
40 #if IS_ENABLED(CONFIG_INFINIBAND_USER_ACCESS)
41 extern const struct uverbs_object_def uverbs_object_comp_channel;
42 extern const struct uverbs_object_def uverbs_object_cq;
43 extern const struct uverbs_object_def uverbs_object_qp;
44 extern const struct uverbs_object_def uverbs_object_rwq_ind_table;
45 extern const struct uverbs_object_def uverbs_object_wq;
46 extern const struct uverbs_object_def uverbs_object_srq;
47 extern const struct uverbs_object_def uverbs_object_ah;
48 extern const struct uverbs_object_def uverbs_object_flow;
49 extern const struct uverbs_object_def uverbs_object_mr;
50 extern const struct uverbs_object_def uverbs_object_mw;
51 extern const struct uverbs_object_def uverbs_object_pd;
52 extern const struct uverbs_object_def uverbs_object_xrcd;
53 extern const struct uverbs_object_def uverbs_object_device;
54 
55 extern const struct uverbs_object_tree_def uverbs_default_objects;
56 static inline const struct uverbs_object_tree_def *uverbs_default_get_objects(void)
57 {
58 	return &uverbs_default_objects;
59 }
60 #else
61 static inline const struct uverbs_object_tree_def *uverbs_default_get_objects(void)
62 {
63 	return NULL;
64 }
65 #endif
66 
67 static inline struct ib_uobject *__uobj_get(const struct uverbs_obj_type *type,
68 					    bool write,
69 					    struct ib_ucontext *ucontext,
70 					    int id)
71 {
72 	return rdma_lookup_get_uobject(type, ucontext, id, write);
73 }
74 
75 #define uobj_get_type(_object) uverbs_object_##_object.type_attrs
76 
77 #define uobj_get_read(_type, _id, _ucontext)				\
78 	 __uobj_get(_type, false, _ucontext, _id)
79 
80 #define uobj_get_obj_read(_object, _id, _ucontext)			\
81 ({									\
82 	struct ib_uobject *__uobj =					\
83 		__uobj_get(uverbs_object_##_object.type_attrs,		\
84 			   false, _ucontext, _id);			\
85 									\
86 	(struct ib_##_object *)(IS_ERR(__uobj) ? NULL : __uobj->object);\
87 })
88 
89 #define uobj_get_write(_type, _id, _ucontext)				\
90 	 __uobj_get(_type, true, _ucontext, _id)
91 
92 static inline void uobj_put_read(struct ib_uobject *uobj)
93 {
94 	rdma_lookup_put_uobject(uobj, false);
95 }
96 
97 #define uobj_put_obj_read(_obj)					\
98 	uobj_put_read((_obj)->uobject)
99 
100 static inline void uobj_put_write(struct ib_uobject *uobj)
101 {
102 	rdma_lookup_put_uobject(uobj, true);
103 }
104 
105 static inline int __must_check uobj_remove_commit(struct ib_uobject *uobj)
106 {
107 	return rdma_remove_commit_uobject(uobj);
108 }
109 
110 static inline void uobj_alloc_commit(struct ib_uobject *uobj)
111 {
112 	rdma_alloc_commit_uobject(uobj);
113 }
114 
115 static inline void uobj_alloc_abort(struct ib_uobject *uobj)
116 {
117 	rdma_alloc_abort_uobject(uobj);
118 }
119 
120 static inline struct ib_uobject *__uobj_alloc(const struct uverbs_obj_type *type,
121 					      struct ib_ucontext *ucontext)
122 {
123 	return rdma_alloc_begin_uobject(type, ucontext);
124 }
125 
126 #define uobj_alloc(_type, ucontext)	\
127 	__uobj_alloc(_type, ucontext)
128 
129 #endif
130 
131