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 /* Returns _id, or causes a compile error if _id is not a u32.
41 *
42 * The uobj APIs should only be used with the write based uAPI to access
43 * object IDs. The write API must use a u32 for the object handle, which is
44 * checked by this macro.
45 */
46 #define _uobj_check_id(_id) ({ CTASSERT(sizeof(_id) == sizeof(u32)); (_id); })
47
48 #define uobj_get_type(_attrs, _object) \
49 uapi_get_object((_attrs)->ufile->device->uapi, _object)
50
51 #define uobj_get_read(_type, _id, _attrs) \
52 rdma_lookup_get_uobject(uobj_get_type(_attrs, _type), (_attrs)->ufile, \
53 _uobj_check_id(_id), UVERBS_LOOKUP_READ, \
54 _attrs)
55
56 #define ufd_get_read(_type, _fdnum, _attrs) ({ \
57 CTASSERT(sizeof(_fdnum) == sizeof(s32)); \
58 rdma_lookup_get_uobject(uobj_get_type(_attrs, _type), (_attrs)->ufile, \
59 (_fdnum), \
60 UVERBS_LOOKUP_READ, _attrs); \
61 })
62
_uobj_get_obj_read(struct ib_uobject * uobj)63 static inline void *_uobj_get_obj_read(struct ib_uobject *uobj)
64 {
65 if (IS_ERR(uobj))
66 return NULL;
67 return uobj->object;
68 }
69 #define uobj_get_obj_read(_object, _type, _id, _attrs) \
70 ((struct ib_##_object *)_uobj_get_obj_read( \
71 uobj_get_read(_type, _id, _attrs)))
72
73 #define uobj_get_write(_type, _id, _attrs) \
74 rdma_lookup_get_uobject(uobj_get_type(_attrs, _type), (_attrs)->ufile, \
75 _uobj_check_id(_id), UVERBS_LOOKUP_WRITE, \
76 _attrs)
77
78 int __uobj_perform_destroy(const struct uverbs_api_object *obj, u32 id,
79 struct uverbs_attr_bundle *attrs);
80 #define uobj_perform_destroy(_type, _id, _attrs) \
81 __uobj_perform_destroy(uobj_get_type(_attrs, _type), \
82 _uobj_check_id(_id), _attrs)
83
84 struct ib_uobject *__uobj_get_destroy(const struct uverbs_api_object *obj,
85 u32 id, struct uverbs_attr_bundle *attrs);
86
87 #define uobj_get_destroy(_type, _id, _attrs) \
88 __uobj_get_destroy(uobj_get_type(_attrs, _type), _uobj_check_id(_id), \
89 _attrs)
90
uobj_put_destroy(struct ib_uobject * uobj)91 static inline void uobj_put_destroy(struct ib_uobject *uobj)
92 {
93 rdma_lookup_put_uobject(uobj, UVERBS_LOOKUP_WRITE);
94 }
95
uobj_put_read(struct ib_uobject * uobj)96 static inline void uobj_put_read(struct ib_uobject *uobj)
97 {
98 rdma_lookup_put_uobject(uobj, UVERBS_LOOKUP_READ);
99 }
100
101 #define uobj_put_obj_read(_obj) \
102 uobj_put_read((_obj)->uobject)
103
uobj_put_write(struct ib_uobject * uobj)104 static inline void uobj_put_write(struct ib_uobject *uobj)
105 {
106 rdma_lookup_put_uobject(uobj, UVERBS_LOOKUP_WRITE);
107 }
108
uobj_alloc_abort(struct ib_uobject * uobj,struct uverbs_attr_bundle * attrs)109 static inline void uobj_alloc_abort(struct ib_uobject *uobj,
110 struct uverbs_attr_bundle *attrs)
111 {
112 rdma_alloc_abort_uobject(uobj, attrs);
113 }
114
115 static inline struct ib_uobject *
__uobj_alloc(const struct uverbs_api_object * obj,struct uverbs_attr_bundle * attrs,struct ib_device ** ib_dev)116 __uobj_alloc(const struct uverbs_api_object *obj,
117 struct uverbs_attr_bundle *attrs, struct ib_device **ib_dev)
118 {
119 struct ib_uobject *uobj = rdma_alloc_begin_uobject(obj, attrs);
120
121 if (!IS_ERR(uobj))
122 *ib_dev = attrs->context->device;
123 return uobj;
124 }
125
126 #define uobj_alloc(_type, _attrs, _ib_dev) \
127 __uobj_alloc(uobj_get_type(_attrs, _type), _attrs, _ib_dev)
128
uverbs_flow_action_fill_action(struct ib_flow_action * action,struct ib_uobject * uobj,struct ib_device * ib_dev,enum ib_flow_action_type type)129 static inline void uverbs_flow_action_fill_action(struct ib_flow_action *action,
130 struct ib_uobject *uobj,
131 struct ib_device *ib_dev,
132 enum ib_flow_action_type type)
133 {
134 atomic_set(&action->usecnt, 0);
135 action->device = ib_dev;
136 action->type = type;
137 action->uobject = uobj;
138 uobj->object = action;
139 }
140
141 struct ib_uflow_resources {
142 size_t max;
143 size_t num;
144 size_t collection_num;
145 size_t counters_num;
146 struct ib_counters **counters;
147 struct ib_flow_action **collection;
148 };
149
150 struct ib_uflow_object {
151 struct ib_uobject uobject;
152 struct ib_uflow_resources *resources;
153 };
154
155 struct ib_uflow_resources *flow_resources_alloc(size_t num_specs);
156 void flow_resources_add(struct ib_uflow_resources *uflow_res,
157 enum ib_flow_spec_type type,
158 void *ibobj);
159 void ib_uverbs_flow_resources_free(struct ib_uflow_resources *uflow_res);
160
ib_set_flow(struct ib_uobject * uobj,struct ib_flow * ibflow,struct ib_qp * qp,struct ib_device * device,struct ib_uflow_resources * uflow_res)161 static inline void ib_set_flow(struct ib_uobject *uobj, struct ib_flow *ibflow,
162 struct ib_qp *qp, struct ib_device *device,
163 struct ib_uflow_resources *uflow_res)
164 {
165 struct ib_uflow_object *uflow;
166
167 uobj->object = ibflow;
168 ibflow->uobject = uobj;
169
170 if (qp) {
171 atomic_inc(&qp->usecnt);
172 ibflow->qp = qp;
173 }
174
175 ibflow->device = device;
176 uflow = container_of(uobj, typeof(*uflow), uobject);
177 uflow->resources = uflow_res;
178 }
179
180 struct uverbs_api_object {
181 const struct uverbs_obj_type *type_attrs;
182 const struct uverbs_obj_type_class *type_class;
183 u8 disabled:1;
184 u32 id;
185 };
186
uobj_get_object_id(struct ib_uobject * uobj)187 static inline u32 uobj_get_object_id(struct ib_uobject *uobj)
188 {
189 return uobj->uapi_object->id;
190 }
191
192 #endif
193
194