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 #define UVERBS_OBJECT(id)	uverbs_object_##id
41 
42 #if IS_ENABLED(CONFIG_INFINIBAND_USER_ACCESS)
43 const struct uverbs_object_tree_def *uverbs_default_get_objects(void);
44 #else
45 static inline const struct uverbs_object_tree_def *uverbs_default_get_objects(void)
46 {
47 	return NULL;
48 }
49 #endif
50 
51 static inline struct ib_uobject *__uobj_get(const struct uverbs_obj_type *type,
52 					    bool write,
53 					    struct ib_ucontext *ucontext,
54 					    int id)
55 {
56 	return rdma_lookup_get_uobject(type, ucontext, id, write);
57 }
58 
59 #define uobj_get_type(_object) UVERBS_OBJECT(_object).type_attrs
60 
61 #define uobj_get_read(_type, _id, _ucontext)				\
62 	 __uobj_get(uobj_get_type(_type), false, _ucontext, _id)
63 
64 #define uobj_get_obj_read(_object, _type, _id, _ucontext)		\
65 ({									\
66 	struct ib_uobject *__uobj =					\
67 		__uobj_get(uobj_get_type(_type),			\
68 			   false, _ucontext, _id);			\
69 									\
70 	(struct ib_##_object *)(IS_ERR(__uobj) ? NULL : __uobj->object);\
71 })
72 
73 #define uobj_get_write(_type, _id, _ucontext)				\
74 	 __uobj_get(uobj_get_type(_type), true, _ucontext, _id)
75 
76 static inline void uobj_put_read(struct ib_uobject *uobj)
77 {
78 	rdma_lookup_put_uobject(uobj, false);
79 }
80 
81 #define uobj_put_obj_read(_obj)					\
82 	uobj_put_read((_obj)->uobject)
83 
84 static inline void uobj_put_write(struct ib_uobject *uobj)
85 {
86 	rdma_lookup_put_uobject(uobj, true);
87 }
88 
89 static inline int __must_check uobj_remove_commit(struct ib_uobject *uobj)
90 {
91 	return rdma_remove_commit_uobject(uobj);
92 }
93 
94 static inline void uobj_alloc_commit(struct ib_uobject *uobj)
95 {
96 	rdma_alloc_commit_uobject(uobj);
97 }
98 
99 static inline void uobj_alloc_abort(struct ib_uobject *uobj)
100 {
101 	rdma_alloc_abort_uobject(uobj);
102 }
103 
104 static inline struct ib_uobject *__uobj_alloc(const struct uverbs_obj_type *type,
105 					      struct ib_ucontext *ucontext)
106 {
107 	return rdma_alloc_begin_uobject(type, ucontext);
108 }
109 
110 #define uobj_alloc(_type, ucontext)	\
111 	__uobj_alloc(uobj_get_type(_type), ucontext)
112 
113 #endif
114 
115