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 const struct uverbs_object_tree_def *uverbs_default_get_objects(void);
42 #else
uverbs_default_get_objects(void)43 static inline const struct uverbs_object_tree_def *uverbs_default_get_objects(void)
44 {
45 	return NULL;
46 }
47 #endif
48 
49 /* Returns _id, or causes a compile error if _id is not a u32.
50  *
51  * The uobj APIs should only be used with the write based uAPI to access
52  * object IDs. The write API must use a u32 for the object handle, which is
53  * checked by this macro.
54  */
55 #define _uobj_check_id(_id) ((_id) * typecheck(u32, _id))
56 
57 #define uobj_get_type(_ufile, _object)                                         \
58 	uapi_get_object((_ufile)->device->uapi, _object)
59 
60 #define uobj_get_read(_type, _id, _ufile)                                      \
61 	rdma_lookup_get_uobject(uobj_get_type(_ufile, _type), _ufile,          \
62 				_uobj_check_id(_id), UVERBS_LOOKUP_READ)
63 
64 #define ufd_get_read(_type, _fdnum, _ufile)                                    \
65 	rdma_lookup_get_uobject(uobj_get_type(_ufile, _type), _ufile,          \
66 				(_fdnum)*typecheck(s32, _fdnum),               \
67 				UVERBS_LOOKUP_READ)
68 
_uobj_get_obj_read(struct ib_uobject * uobj)69 static inline void *_uobj_get_obj_read(struct ib_uobject *uobj)
70 {
71 	if (IS_ERR(uobj))
72 		return NULL;
73 	return uobj->object;
74 }
75 #define uobj_get_obj_read(_object, _type, _id, _ufile)                         \
76 	((struct ib_##_object *)_uobj_get_obj_read(                            \
77 		uobj_get_read(_type, _id, _ufile)))
78 
79 #define uobj_get_write(_type, _id, _ufile)                                     \
80 	rdma_lookup_get_uobject(uobj_get_type(_ufile, _type), _ufile,          \
81 				_uobj_check_id(_id), UVERBS_LOOKUP_WRITE)
82 
83 int __uobj_perform_destroy(const struct uverbs_api_object *obj, u32 id,
84 			   struct ib_uverbs_file *ufile, int success_res);
85 #define uobj_perform_destroy(_type, _id, _ufile, _success_res)                 \
86 	__uobj_perform_destroy(uobj_get_type(_ufile, _type),                   \
87 			       _uobj_check_id(_id), _ufile, _success_res)
88 
89 struct ib_uobject *__uobj_get_destroy(const struct uverbs_api_object *obj,
90 				      u32 id, struct ib_uverbs_file *ufile);
91 
92 #define uobj_get_destroy(_type, _id, _ufile)                                   \
93 	__uobj_get_destroy(uobj_get_type(_ufile, _type), _uobj_check_id(_id),  \
94 			   _ufile)
95 
uobj_put_destroy(struct ib_uobject * uobj)96 static inline void uobj_put_destroy(struct ib_uobject *uobj)
97 {
98 	rdma_lookup_put_uobject(uobj, UVERBS_LOOKUP_DESTROY);
99 }
100 
uobj_put_read(struct ib_uobject * uobj)101 static inline void uobj_put_read(struct ib_uobject *uobj)
102 {
103 	rdma_lookup_put_uobject(uobj, UVERBS_LOOKUP_READ);
104 }
105 
106 #define uobj_put_obj_read(_obj)					\
107 	uobj_put_read((_obj)->uobject)
108 
uobj_put_write(struct ib_uobject * uobj)109 static inline void uobj_put_write(struct ib_uobject *uobj)
110 {
111 	rdma_lookup_put_uobject(uobj, UVERBS_LOOKUP_WRITE);
112 }
113 
uobj_alloc_commit(struct ib_uobject * uobj,int success_res)114 static inline int __must_check uobj_alloc_commit(struct ib_uobject *uobj,
115 						 int success_res)
116 {
117 	int ret = rdma_alloc_commit_uobject(uobj);
118 
119 	if (ret)
120 		return ret;
121 	return success_res;
122 }
123 
uobj_alloc_abort(struct ib_uobject * uobj)124 static inline void uobj_alloc_abort(struct ib_uobject *uobj)
125 {
126 	rdma_alloc_abort_uobject(uobj);
127 }
128 
129 static inline struct ib_uobject *
__uobj_alloc(const struct uverbs_api_object * obj,struct ib_uverbs_file * ufile,struct ib_device ** ib_dev)130 __uobj_alloc(const struct uverbs_api_object *obj, struct ib_uverbs_file *ufile,
131 	     struct ib_device **ib_dev)
132 {
133 	struct ib_uobject *uobj = rdma_alloc_begin_uobject(obj, ufile);
134 
135 	if (!IS_ERR(uobj))
136 		*ib_dev = uobj->context->device;
137 	return uobj;
138 }
139 
140 #define uobj_alloc(_type, _ufile, _ib_dev)                                     \
141 	__uobj_alloc(uobj_get_type(_ufile, _type), _ufile, _ib_dev)
142 
143 #endif
144 
145