1b633e08cSHans Petter Selasky /*
2b633e08cSHans Petter Selasky * Copyright (c) 2017, Mellanox Technologies inc. All rights reserved.
3b633e08cSHans Petter Selasky *
4b633e08cSHans Petter Selasky * This software is available to you under a choice of one of two
5b633e08cSHans Petter Selasky * licenses. You may choose to be licensed under the terms of the GNU
6b633e08cSHans Petter Selasky * General Public License (GPL) Version 2, available from the file
7b633e08cSHans Petter Selasky * COPYING in the main directory of this source tree, or the
8b633e08cSHans Petter Selasky * OpenIB.org BSD license below:
9b633e08cSHans Petter Selasky *
10b633e08cSHans Petter Selasky * Redistribution and use in source and binary forms, with or
11b633e08cSHans Petter Selasky * without modification, are permitted provided that the following
12b633e08cSHans Petter Selasky * conditions are met:
13b633e08cSHans Petter Selasky *
14b633e08cSHans Petter Selasky * - Redistributions of source code must retain the above
15b633e08cSHans Petter Selasky * copyright notice, this list of conditions and the following
16b633e08cSHans Petter Selasky * disclaimer.
17b633e08cSHans Petter Selasky *
18b633e08cSHans Petter Selasky * - Redistributions in binary form must reproduce the above
19b633e08cSHans Petter Selasky * copyright notice, this list of conditions and the following
20b633e08cSHans Petter Selasky * disclaimer in the documentation and/or other materials
21b633e08cSHans Petter Selasky * provided with the distribution.
22b633e08cSHans Petter Selasky *
23b633e08cSHans Petter Selasky * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
24b633e08cSHans Petter Selasky * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
25b633e08cSHans Petter Selasky * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
26b633e08cSHans Petter Selasky * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
27b633e08cSHans Petter Selasky * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
28b633e08cSHans Petter Selasky * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
29b633e08cSHans Petter Selasky * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
30b633e08cSHans Petter Selasky * SOFTWARE.
31b633e08cSHans Petter Selasky */
32b633e08cSHans Petter Selasky
33b633e08cSHans Petter Selasky #ifndef _UVERBS_IOCTL_
34b633e08cSHans Petter Selasky #define _UVERBS_IOCTL_
35b633e08cSHans Petter Selasky
36b633e08cSHans Petter Selasky #include <rdma/uverbs_types.h>
37b633e08cSHans Petter Selasky #include <linux/uaccess.h>
38b633e08cSHans Petter Selasky #include <rdma/rdma_user_ioctl.h>
39b633e08cSHans Petter Selasky #include <rdma/ib_user_ioctl_verbs.h>
40b633e08cSHans Petter Selasky #include <rdma/ib_user_ioctl_cmds.h>
41b633e08cSHans Petter Selasky
42b633e08cSHans Petter Selasky /*
43b633e08cSHans Petter Selasky * =======================================
44b633e08cSHans Petter Selasky * Verbs action specifications
45b633e08cSHans Petter Selasky * =======================================
46b633e08cSHans Petter Selasky */
47b633e08cSHans Petter Selasky
48b633e08cSHans Petter Selasky enum uverbs_attr_type {
49b633e08cSHans Petter Selasky UVERBS_ATTR_TYPE_NA,
50b633e08cSHans Petter Selasky UVERBS_ATTR_TYPE_PTR_IN,
51b633e08cSHans Petter Selasky UVERBS_ATTR_TYPE_PTR_OUT,
52b633e08cSHans Petter Selasky UVERBS_ATTR_TYPE_IDR,
53b633e08cSHans Petter Selasky UVERBS_ATTR_TYPE_FD,
54b633e08cSHans Petter Selasky UVERBS_ATTR_TYPE_ENUM_IN,
55b633e08cSHans Petter Selasky UVERBS_ATTR_TYPE_IDRS_ARRAY,
56b633e08cSHans Petter Selasky };
57b633e08cSHans Petter Selasky
58b633e08cSHans Petter Selasky enum uverbs_obj_access {
59b633e08cSHans Petter Selasky UVERBS_ACCESS_READ,
60b633e08cSHans Petter Selasky UVERBS_ACCESS_WRITE,
61b633e08cSHans Petter Selasky UVERBS_ACCESS_NEW,
62b633e08cSHans Petter Selasky UVERBS_ACCESS_DESTROY
63b633e08cSHans Petter Selasky };
64b633e08cSHans Petter Selasky
65b633e08cSHans Petter Selasky /* Specification of a single attribute inside the ioctl message */
66b633e08cSHans Petter Selasky /* good size 16 */
67b633e08cSHans Petter Selasky struct uverbs_attr_spec {
68b633e08cSHans Petter Selasky u8 type;
69b633e08cSHans Petter Selasky
70b633e08cSHans Petter Selasky /*
71b633e08cSHans Petter Selasky * Support extending attributes by length. Allow the user to provide
72b633e08cSHans Petter Selasky * more bytes than ptr.len, but check that everything after is zero'd
73b633e08cSHans Petter Selasky * by the user.
74b633e08cSHans Petter Selasky */
75b633e08cSHans Petter Selasky u8 zero_trailing:1;
76b633e08cSHans Petter Selasky /*
77b633e08cSHans Petter Selasky * Valid only for PTR_IN. Allocate and copy the data inside
78b633e08cSHans Petter Selasky * the parser
79b633e08cSHans Petter Selasky */
80b633e08cSHans Petter Selasky u8 alloc_and_copy:1;
81b633e08cSHans Petter Selasky u8 mandatory:1;
82b633e08cSHans Petter Selasky /* True if this is from UVERBS_ATTR_UHW */
83b633e08cSHans Petter Selasky u8 is_udata:1;
84b633e08cSHans Petter Selasky
85b633e08cSHans Petter Selasky union {
86b633e08cSHans Petter Selasky struct {
87b633e08cSHans Petter Selasky /* Current known size to kernel */
88b633e08cSHans Petter Selasky u16 len;
89b633e08cSHans Petter Selasky /* User isn't allowed to provide something < min_len */
90b633e08cSHans Petter Selasky u16 min_len;
91b633e08cSHans Petter Selasky } ptr;
92b633e08cSHans Petter Selasky
93b633e08cSHans Petter Selasky struct {
94b633e08cSHans Petter Selasky /*
95b633e08cSHans Petter Selasky * higher bits mean the namespace and lower bits mean
96b633e08cSHans Petter Selasky * the type id within the namespace.
97b633e08cSHans Petter Selasky */
98b633e08cSHans Petter Selasky u16 obj_type;
99b633e08cSHans Petter Selasky u8 access;
100b633e08cSHans Petter Selasky } obj;
101b633e08cSHans Petter Selasky
102b633e08cSHans Petter Selasky struct {
103b633e08cSHans Petter Selasky u8 num_elems;
104b633e08cSHans Petter Selasky } enum_def;
105b633e08cSHans Petter Selasky } u;
106b633e08cSHans Petter Selasky
107b633e08cSHans Petter Selasky /* This weird split lets us remove some padding */
108b633e08cSHans Petter Selasky union {
109b633e08cSHans Petter Selasky struct {
110b633e08cSHans Petter Selasky /*
111b633e08cSHans Petter Selasky * The enum attribute can select one of the attributes
112b633e08cSHans Petter Selasky * contained in the ids array. Currently only PTR_IN
113b633e08cSHans Petter Selasky * attributes are supported in the ids array.
114b633e08cSHans Petter Selasky */
115b633e08cSHans Petter Selasky const struct uverbs_attr_spec *ids;
116b633e08cSHans Petter Selasky } enum_def;
117b633e08cSHans Petter Selasky
118b633e08cSHans Petter Selasky struct {
119b633e08cSHans Petter Selasky /*
120b633e08cSHans Petter Selasky * higher bits mean the namespace and lower bits mean
121b633e08cSHans Petter Selasky * the type id within the namespace.
122b633e08cSHans Petter Selasky */
123b633e08cSHans Petter Selasky u16 obj_type;
124b633e08cSHans Petter Selasky u16 min_len;
125b633e08cSHans Petter Selasky u16 max_len;
126b633e08cSHans Petter Selasky u8 access;
127b633e08cSHans Petter Selasky } objs_arr;
128b633e08cSHans Petter Selasky } u2;
129b633e08cSHans Petter Selasky };
130b633e08cSHans Petter Selasky
131b633e08cSHans Petter Selasky /*
132b633e08cSHans Petter Selasky * Information about the API is loaded into a radix tree. For IOCTL we start
133b633e08cSHans Petter Selasky * with a tuple of:
134b633e08cSHans Petter Selasky * object_id, attr_id, method_id
135b633e08cSHans Petter Selasky *
136b633e08cSHans Petter Selasky * Which is a 48 bit value, with most of the bits guaranteed to be zero. Based
137b633e08cSHans Petter Selasky * on the current kernel support this is compressed into 16 bit key for the
138b633e08cSHans Petter Selasky * radix tree. Since this compression is entirely internal to the kernel the
139b633e08cSHans Petter Selasky * below limits can be revised if the kernel gains additional data.
140b633e08cSHans Petter Selasky *
141b633e08cSHans Petter Selasky * With 64 leafs per node this is a 3 level radix tree.
142b633e08cSHans Petter Selasky *
143b633e08cSHans Petter Selasky * The tree encodes multiple types, and uses a scheme where OBJ_ID,0,0 returns
144b633e08cSHans Petter Selasky * the object slot, and OBJ_ID,METH_ID,0 and returns the method slot.
145b633e08cSHans Petter Selasky *
146b633e08cSHans Petter Selasky * This also encodes the tables for the write() and write() extended commands
147b633e08cSHans Petter Selasky * using the coding
148b633e08cSHans Petter Selasky * OBJ_ID,UVERBS_API_METHOD_IS_WRITE,command #
149b633e08cSHans Petter Selasky * OBJ_ID,UVERBS_API_METHOD_IS_WRITE_EX,command_ex #
150b633e08cSHans Petter Selasky * ie the WRITE path is treated as a special method type in the ioctl
151b633e08cSHans Petter Selasky * framework.
152b633e08cSHans Petter Selasky */
153b633e08cSHans Petter Selasky enum uapi_radix_data {
154b633e08cSHans Petter Selasky UVERBS_API_NS_FLAG = 1U << UVERBS_ID_NS_SHIFT,
155b633e08cSHans Petter Selasky
156b633e08cSHans Petter Selasky UVERBS_API_ATTR_KEY_BITS = 6,
157b633e08cSHans Petter Selasky UVERBS_API_ATTR_KEY_MASK = GENMASK(UVERBS_API_ATTR_KEY_BITS - 1, 0),
158b633e08cSHans Petter Selasky UVERBS_API_ATTR_BKEY_LEN = (1 << UVERBS_API_ATTR_KEY_BITS) - 1,
159b633e08cSHans Petter Selasky UVERBS_API_WRITE_KEY_NUM = 1 << UVERBS_API_ATTR_KEY_BITS,
160b633e08cSHans Petter Selasky
161b633e08cSHans Petter Selasky UVERBS_API_METHOD_KEY_BITS = 5,
162b633e08cSHans Petter Selasky UVERBS_API_METHOD_KEY_SHIFT = UVERBS_API_ATTR_KEY_BITS,
163b633e08cSHans Petter Selasky UVERBS_API_METHOD_KEY_NUM_CORE = 22,
164b633e08cSHans Petter Selasky UVERBS_API_METHOD_IS_WRITE = 30 << UVERBS_API_METHOD_KEY_SHIFT,
165b633e08cSHans Petter Selasky UVERBS_API_METHOD_IS_WRITE_EX = 31 << UVERBS_API_METHOD_KEY_SHIFT,
166b633e08cSHans Petter Selasky UVERBS_API_METHOD_KEY_NUM_DRIVER =
167b633e08cSHans Petter Selasky (UVERBS_API_METHOD_IS_WRITE >> UVERBS_API_METHOD_KEY_SHIFT) -
168b633e08cSHans Petter Selasky UVERBS_API_METHOD_KEY_NUM_CORE,
169b633e08cSHans Petter Selasky UVERBS_API_METHOD_KEY_MASK = GENMASK(
170b633e08cSHans Petter Selasky UVERBS_API_METHOD_KEY_BITS + UVERBS_API_METHOD_KEY_SHIFT - 1,
171b633e08cSHans Petter Selasky UVERBS_API_METHOD_KEY_SHIFT),
172b633e08cSHans Petter Selasky
173b633e08cSHans Petter Selasky UVERBS_API_OBJ_KEY_BITS = 5,
174b633e08cSHans Petter Selasky UVERBS_API_OBJ_KEY_SHIFT =
175b633e08cSHans Petter Selasky UVERBS_API_METHOD_KEY_BITS + UVERBS_API_METHOD_KEY_SHIFT,
176b633e08cSHans Petter Selasky UVERBS_API_OBJ_KEY_NUM_CORE = 20,
177b633e08cSHans Petter Selasky UVERBS_API_OBJ_KEY_NUM_DRIVER =
178b633e08cSHans Petter Selasky (1 << UVERBS_API_OBJ_KEY_BITS) - UVERBS_API_OBJ_KEY_NUM_CORE,
179b633e08cSHans Petter Selasky UVERBS_API_OBJ_KEY_MASK = GENMASK(31, UVERBS_API_OBJ_KEY_SHIFT),
180b633e08cSHans Petter Selasky
181b633e08cSHans Petter Selasky /* This id guaranteed to not exist in the radix tree */
182b633e08cSHans Petter Selasky UVERBS_API_KEY_ERR = 0xFFFFFFFF,
183b633e08cSHans Petter Selasky };
184b633e08cSHans Petter Selasky
uapi_key_obj(u32 id)185b633e08cSHans Petter Selasky static inline __attribute_const__ u32 uapi_key_obj(u32 id)
186b633e08cSHans Petter Selasky {
187b633e08cSHans Petter Selasky if (id & UVERBS_API_NS_FLAG) {
188b633e08cSHans Petter Selasky id &= ~UVERBS_API_NS_FLAG;
189b633e08cSHans Petter Selasky if (id >= UVERBS_API_OBJ_KEY_NUM_DRIVER)
190b633e08cSHans Petter Selasky return UVERBS_API_KEY_ERR;
191b633e08cSHans Petter Selasky id = id + UVERBS_API_OBJ_KEY_NUM_CORE;
192b633e08cSHans Petter Selasky } else {
193b633e08cSHans Petter Selasky if (id >= UVERBS_API_OBJ_KEY_NUM_CORE)
194b633e08cSHans Petter Selasky return UVERBS_API_KEY_ERR;
195b633e08cSHans Petter Selasky }
196b633e08cSHans Petter Selasky
197b633e08cSHans Petter Selasky return id << UVERBS_API_OBJ_KEY_SHIFT;
198b633e08cSHans Petter Selasky }
199b633e08cSHans Petter Selasky
uapi_key_is_object(u32 key)200b633e08cSHans Petter Selasky static inline __attribute_const__ bool uapi_key_is_object(u32 key)
201b633e08cSHans Petter Selasky {
202b633e08cSHans Petter Selasky return (key & ~UVERBS_API_OBJ_KEY_MASK) == 0;
203b633e08cSHans Petter Selasky }
204b633e08cSHans Petter Selasky
uapi_key_ioctl_method(u32 id)205b633e08cSHans Petter Selasky static inline __attribute_const__ u32 uapi_key_ioctl_method(u32 id)
206b633e08cSHans Petter Selasky {
207b633e08cSHans Petter Selasky if (id & UVERBS_API_NS_FLAG) {
208b633e08cSHans Petter Selasky id &= ~UVERBS_API_NS_FLAG;
209b633e08cSHans Petter Selasky if (id >= UVERBS_API_METHOD_KEY_NUM_DRIVER)
210b633e08cSHans Petter Selasky return UVERBS_API_KEY_ERR;
211b633e08cSHans Petter Selasky id = id + UVERBS_API_METHOD_KEY_NUM_CORE;
212b633e08cSHans Petter Selasky } else {
213b633e08cSHans Petter Selasky id++;
214b633e08cSHans Petter Selasky if (id >= UVERBS_API_METHOD_KEY_NUM_CORE)
215b633e08cSHans Petter Selasky return UVERBS_API_KEY_ERR;
216b633e08cSHans Petter Selasky }
217b633e08cSHans Petter Selasky
218b633e08cSHans Petter Selasky return id << UVERBS_API_METHOD_KEY_SHIFT;
219b633e08cSHans Petter Selasky }
220b633e08cSHans Petter Selasky
uapi_key_write_method(u32 id)221b633e08cSHans Petter Selasky static inline __attribute_const__ u32 uapi_key_write_method(u32 id)
222b633e08cSHans Petter Selasky {
223b633e08cSHans Petter Selasky if (id >= UVERBS_API_WRITE_KEY_NUM)
224b633e08cSHans Petter Selasky return UVERBS_API_KEY_ERR;
225b633e08cSHans Petter Selasky return UVERBS_API_METHOD_IS_WRITE | id;
226b633e08cSHans Petter Selasky }
227b633e08cSHans Petter Selasky
uapi_key_write_ex_method(u32 id)228b633e08cSHans Petter Selasky static inline __attribute_const__ u32 uapi_key_write_ex_method(u32 id)
229b633e08cSHans Petter Selasky {
230b633e08cSHans Petter Selasky if (id >= UVERBS_API_WRITE_KEY_NUM)
231b633e08cSHans Petter Selasky return UVERBS_API_KEY_ERR;
232b633e08cSHans Petter Selasky return UVERBS_API_METHOD_IS_WRITE_EX | id;
233b633e08cSHans Petter Selasky }
234b633e08cSHans Petter Selasky
235b633e08cSHans Petter Selasky static inline __attribute_const__ u32
uapi_key_attr_to_ioctl_method(u32 attr_key)236b633e08cSHans Petter Selasky uapi_key_attr_to_ioctl_method(u32 attr_key)
237b633e08cSHans Petter Selasky {
238b633e08cSHans Petter Selasky return attr_key &
239b633e08cSHans Petter Selasky (UVERBS_API_OBJ_KEY_MASK | UVERBS_API_METHOD_KEY_MASK);
240b633e08cSHans Petter Selasky }
241b633e08cSHans Petter Selasky
uapi_key_is_ioctl_method(u32 key)242b633e08cSHans Petter Selasky static inline __attribute_const__ bool uapi_key_is_ioctl_method(u32 key)
243b633e08cSHans Petter Selasky {
244b633e08cSHans Petter Selasky unsigned int method = key & UVERBS_API_METHOD_KEY_MASK;
245b633e08cSHans Petter Selasky
246b633e08cSHans Petter Selasky return method != 0 && method < UVERBS_API_METHOD_IS_WRITE &&
247b633e08cSHans Petter Selasky (key & UVERBS_API_ATTR_KEY_MASK) == 0;
248b633e08cSHans Petter Selasky }
249b633e08cSHans Petter Selasky
uapi_key_is_write_method(u32 key)250b633e08cSHans Petter Selasky static inline __attribute_const__ bool uapi_key_is_write_method(u32 key)
251b633e08cSHans Petter Selasky {
252b633e08cSHans Petter Selasky return (key & UVERBS_API_METHOD_KEY_MASK) == UVERBS_API_METHOD_IS_WRITE;
253b633e08cSHans Petter Selasky }
254b633e08cSHans Petter Selasky
uapi_key_is_write_ex_method(u32 key)255b633e08cSHans Petter Selasky static inline __attribute_const__ bool uapi_key_is_write_ex_method(u32 key)
256b633e08cSHans Petter Selasky {
257b633e08cSHans Petter Selasky return (key & UVERBS_API_METHOD_KEY_MASK) ==
258b633e08cSHans Petter Selasky UVERBS_API_METHOD_IS_WRITE_EX;
259b633e08cSHans Petter Selasky }
260b633e08cSHans Petter Selasky
uapi_key_attrs_start(u32 ioctl_method_key)261b633e08cSHans Petter Selasky static inline __attribute_const__ u32 uapi_key_attrs_start(u32 ioctl_method_key)
262b633e08cSHans Petter Selasky {
263b633e08cSHans Petter Selasky /* 0 is the method slot itself */
264b633e08cSHans Petter Selasky return ioctl_method_key + 1;
265b633e08cSHans Petter Selasky }
266b633e08cSHans Petter Selasky
uapi_key_attr(u32 id)267b633e08cSHans Petter Selasky static inline __attribute_const__ u32 uapi_key_attr(u32 id)
268b633e08cSHans Petter Selasky {
269b633e08cSHans Petter Selasky /*
270b633e08cSHans Petter Selasky * The attr is designed to fit in the typical single radix tree node
271b633e08cSHans Petter Selasky * of 64 entries. Since allmost all methods have driver attributes we
272b633e08cSHans Petter Selasky * organize things so that the driver and core attributes interleave to
273b633e08cSHans Petter Selasky * reduce the length of the attributes array in typical cases.
274b633e08cSHans Petter Selasky */
275b633e08cSHans Petter Selasky if (id & UVERBS_API_NS_FLAG) {
276b633e08cSHans Petter Selasky id &= ~UVERBS_API_NS_FLAG;
277b633e08cSHans Petter Selasky id++;
278b633e08cSHans Petter Selasky if (id >= 1 << (UVERBS_API_ATTR_KEY_BITS - 1))
279b633e08cSHans Petter Selasky return UVERBS_API_KEY_ERR;
280b633e08cSHans Petter Selasky id = (id << 1) | 0;
281b633e08cSHans Petter Selasky } else {
282b633e08cSHans Petter Selasky if (id >= 1 << (UVERBS_API_ATTR_KEY_BITS - 1))
283b633e08cSHans Petter Selasky return UVERBS_API_KEY_ERR;
284b633e08cSHans Petter Selasky id = (id << 1) | 1;
285b633e08cSHans Petter Selasky }
286b633e08cSHans Petter Selasky
287b633e08cSHans Petter Selasky return id;
288b633e08cSHans Petter Selasky }
289b633e08cSHans Petter Selasky
290b633e08cSHans Petter Selasky /* Only true for ioctl methods */
uapi_key_is_attr(u32 key)291b633e08cSHans Petter Selasky static inline __attribute_const__ bool uapi_key_is_attr(u32 key)
292b633e08cSHans Petter Selasky {
293b633e08cSHans Petter Selasky unsigned int method = key & UVERBS_API_METHOD_KEY_MASK;
294b633e08cSHans Petter Selasky
295b633e08cSHans Petter Selasky return method != 0 && method < UVERBS_API_METHOD_IS_WRITE &&
296b633e08cSHans Petter Selasky (key & UVERBS_API_ATTR_KEY_MASK) != 0;
297b633e08cSHans Petter Selasky }
298b633e08cSHans Petter Selasky
299b633e08cSHans Petter Selasky /*
300b633e08cSHans Petter Selasky * This returns a value in the range [0 to UVERBS_API_ATTR_BKEY_LEN),
301b633e08cSHans Petter Selasky * basically it undoes the reservation of 0 in the ID numbering. attr_key
302b633e08cSHans Petter Selasky * must already be masked with UVERBS_API_ATTR_KEY_MASK, or be the output of
303b633e08cSHans Petter Selasky * uapi_key_attr().
304b633e08cSHans Petter Selasky */
uapi_bkey_attr(u32 attr_key)305b633e08cSHans Petter Selasky static inline __attribute_const__ u32 uapi_bkey_attr(u32 attr_key)
306b633e08cSHans Petter Selasky {
307b633e08cSHans Petter Selasky return attr_key - 1;
308b633e08cSHans Petter Selasky }
309b633e08cSHans Petter Selasky
uapi_bkey_to_key_attr(u32 attr_bkey)310b633e08cSHans Petter Selasky static inline __attribute_const__ u32 uapi_bkey_to_key_attr(u32 attr_bkey)
311b633e08cSHans Petter Selasky {
312b633e08cSHans Petter Selasky return attr_bkey + 1;
313b633e08cSHans Petter Selasky }
314b633e08cSHans Petter Selasky
315b633e08cSHans Petter Selasky /*
316b633e08cSHans Petter Selasky * =======================================
317b633e08cSHans Petter Selasky * Verbs definitions
318b633e08cSHans Petter Selasky * =======================================
319b633e08cSHans Petter Selasky */
320b633e08cSHans Petter Selasky
321b633e08cSHans Petter Selasky struct uverbs_attr_def {
322b633e08cSHans Petter Selasky u16 id;
323b633e08cSHans Petter Selasky struct uverbs_attr_spec attr;
324b633e08cSHans Petter Selasky };
325b633e08cSHans Petter Selasky
326b633e08cSHans Petter Selasky struct uverbs_method_def {
327b633e08cSHans Petter Selasky u16 id;
328b633e08cSHans Petter Selasky /* Combination of bits from enum UVERBS_ACTION_FLAG_XXXX */
329b633e08cSHans Petter Selasky u32 flags;
330b633e08cSHans Petter Selasky size_t num_attrs;
331b633e08cSHans Petter Selasky const struct uverbs_attr_def * const (*attrs)[];
332b633e08cSHans Petter Selasky int (*handler)(struct uverbs_attr_bundle *attrs);
333b633e08cSHans Petter Selasky };
334b633e08cSHans Petter Selasky
335b633e08cSHans Petter Selasky struct uverbs_object_def {
336b633e08cSHans Petter Selasky u16 id;
337b633e08cSHans Petter Selasky const struct uverbs_obj_type *type_attrs;
338b633e08cSHans Petter Selasky size_t num_methods;
339b633e08cSHans Petter Selasky const struct uverbs_method_def * const (*methods)[];
340b633e08cSHans Petter Selasky };
341b633e08cSHans Petter Selasky
342b633e08cSHans Petter Selasky enum uapi_definition_kind {
343b633e08cSHans Petter Selasky UAPI_DEF_END = 0,
344b633e08cSHans Petter Selasky UAPI_DEF_OBJECT_START,
345b633e08cSHans Petter Selasky UAPI_DEF_WRITE,
346b633e08cSHans Petter Selasky UAPI_DEF_CHAIN_OBJ_TREE,
347b633e08cSHans Petter Selasky UAPI_DEF_CHAIN,
348b633e08cSHans Petter Selasky UAPI_DEF_IS_SUPPORTED_FUNC,
349b633e08cSHans Petter Selasky UAPI_DEF_IS_SUPPORTED_DEV_FN,
350b633e08cSHans Petter Selasky };
351b633e08cSHans Petter Selasky
352b633e08cSHans Petter Selasky enum uapi_definition_scope {
353b633e08cSHans Petter Selasky UAPI_SCOPE_OBJECT = 1,
354b633e08cSHans Petter Selasky UAPI_SCOPE_METHOD = 2,
355b633e08cSHans Petter Selasky };
356b633e08cSHans Petter Selasky
357b633e08cSHans Petter Selasky struct uapi_definition {
358b633e08cSHans Petter Selasky u8 kind;
359b633e08cSHans Petter Selasky u8 scope;
360b633e08cSHans Petter Selasky union {
361b633e08cSHans Petter Selasky struct {
362b633e08cSHans Petter Selasky u16 object_id;
363b633e08cSHans Petter Selasky } object_start;
364b633e08cSHans Petter Selasky struct {
365b633e08cSHans Petter Selasky u16 command_num;
366b633e08cSHans Petter Selasky u8 is_ex:1;
367b633e08cSHans Petter Selasky u8 has_udata:1;
368b633e08cSHans Petter Selasky u8 has_resp:1;
369b633e08cSHans Petter Selasky u8 req_size;
370b633e08cSHans Petter Selasky u8 resp_size;
371b633e08cSHans Petter Selasky } write;
372b633e08cSHans Petter Selasky };
373b633e08cSHans Petter Selasky
374b633e08cSHans Petter Selasky union {
375b633e08cSHans Petter Selasky bool (*func_is_supported)(struct ib_device *device);
376b633e08cSHans Petter Selasky int (*func_write)(struct uverbs_attr_bundle *attrs);
377b633e08cSHans Petter Selasky const struct uapi_definition *chain;
378b633e08cSHans Petter Selasky const struct uverbs_object_def *chain_obj_tree;
379b633e08cSHans Petter Selasky size_t needs_fn_offset;
380b633e08cSHans Petter Selasky };
381b633e08cSHans Petter Selasky };
382b633e08cSHans Petter Selasky
383b633e08cSHans Petter Selasky /* Define things connected to object_id */
384b633e08cSHans Petter Selasky #define DECLARE_UVERBS_OBJECT(_object_id, ...) \
385b633e08cSHans Petter Selasky { \
386b633e08cSHans Petter Selasky .kind = UAPI_DEF_OBJECT_START, \
387b633e08cSHans Petter Selasky .object_start = { .object_id = _object_id }, \
388b633e08cSHans Petter Selasky }, \
389b633e08cSHans Petter Selasky ##__VA_ARGS__
390b633e08cSHans Petter Selasky
391b633e08cSHans Petter Selasky /* Use in a var_args of DECLARE_UVERBS_OBJECT */
392b633e08cSHans Petter Selasky #define DECLARE_UVERBS_WRITE(_command_num, _func, _cmd_desc, ...) \
393b633e08cSHans Petter Selasky { \
394b633e08cSHans Petter Selasky .kind = UAPI_DEF_WRITE, \
395b633e08cSHans Petter Selasky .scope = UAPI_SCOPE_OBJECT, \
396b633e08cSHans Petter Selasky .write = { .is_ex = 0, .command_num = _command_num }, \
397b633e08cSHans Petter Selasky .func_write = _func, \
398b633e08cSHans Petter Selasky _cmd_desc, \
399b633e08cSHans Petter Selasky }, \
400b633e08cSHans Petter Selasky ##__VA_ARGS__
401b633e08cSHans Petter Selasky
402b633e08cSHans Petter Selasky /* Use in a var_args of DECLARE_UVERBS_OBJECT */
403b633e08cSHans Petter Selasky #define DECLARE_UVERBS_WRITE_EX(_command_num, _func, _cmd_desc, ...) \
404b633e08cSHans Petter Selasky { \
405b633e08cSHans Petter Selasky .kind = UAPI_DEF_WRITE, \
406b633e08cSHans Petter Selasky .scope = UAPI_SCOPE_OBJECT, \
407b633e08cSHans Petter Selasky .write = { .is_ex = 1, .command_num = _command_num }, \
408b633e08cSHans Petter Selasky .func_write = _func, \
409b633e08cSHans Petter Selasky _cmd_desc, \
410b633e08cSHans Petter Selasky }, \
411b633e08cSHans Petter Selasky ##__VA_ARGS__
412b633e08cSHans Petter Selasky
413b633e08cSHans Petter Selasky /*
414b633e08cSHans Petter Selasky * Object is only supported if the function pointer named ibdev_fn in struct
415b633e08cSHans Petter Selasky * ib_device is not NULL.
416b633e08cSHans Petter Selasky */
417b633e08cSHans Petter Selasky #define UAPI_DEF_OBJ_NEEDS_FN(ibdev_fn) \
418b633e08cSHans Petter Selasky { \
419b633e08cSHans Petter Selasky .kind = UAPI_DEF_IS_SUPPORTED_DEV_FN, \
420b633e08cSHans Petter Selasky .scope = UAPI_SCOPE_OBJECT, \
421b633e08cSHans Petter Selasky .needs_fn_offset = \
422b633e08cSHans Petter Selasky offsetof(struct ib_device, ibdev_fn) + \
423b633e08cSHans Petter Selasky BUILD_BUG_ON_ZERO( \
424b633e08cSHans Petter Selasky sizeof(((struct ib_device *)0)->ibdev_fn) != \
425b633e08cSHans Petter Selasky sizeof(void *)), \
426b633e08cSHans Petter Selasky }
427b633e08cSHans Petter Selasky
428b633e08cSHans Petter Selasky /*
429b633e08cSHans Petter Selasky * Method is only supported if the function pointer named ibdev_fn in struct
430b633e08cSHans Petter Selasky * ib_device is not NULL.
431b633e08cSHans Petter Selasky */
432b633e08cSHans Petter Selasky #define UAPI_DEF_METHOD_NEEDS_FN(ibdev_fn) \
433b633e08cSHans Petter Selasky { \
434b633e08cSHans Petter Selasky .kind = UAPI_DEF_IS_SUPPORTED_DEV_FN, \
435b633e08cSHans Petter Selasky .scope = UAPI_SCOPE_METHOD, \
436b633e08cSHans Petter Selasky .needs_fn_offset = \
437b633e08cSHans Petter Selasky offsetof(struct ib_device, ibdev_fn) + \
438b633e08cSHans Petter Selasky BUILD_BUG_ON_ZERO( \
439b633e08cSHans Petter Selasky sizeof(((struct ib_device *)0)->ibdev_fn) != \
440b633e08cSHans Petter Selasky sizeof(void *)), \
441b633e08cSHans Petter Selasky }
442b633e08cSHans Petter Selasky
443b633e08cSHans Petter Selasky /* Call a function to determine if the entire object is supported or not */
444b633e08cSHans Petter Selasky #define UAPI_DEF_IS_OBJ_SUPPORTED(_func) \
445b633e08cSHans Petter Selasky { \
446b633e08cSHans Petter Selasky .kind = UAPI_DEF_IS_SUPPORTED_FUNC, \
447b633e08cSHans Petter Selasky .scope = UAPI_SCOPE_OBJECT, .func_is_supported = _func, \
448b633e08cSHans Petter Selasky }
449b633e08cSHans Petter Selasky
450b633e08cSHans Petter Selasky /* Include another struct uapi_definition in this one */
451b633e08cSHans Petter Selasky #define UAPI_DEF_CHAIN(_def_var) \
452b633e08cSHans Petter Selasky { \
453b633e08cSHans Petter Selasky .kind = UAPI_DEF_CHAIN, .chain = _def_var, \
454b633e08cSHans Petter Selasky }
455b633e08cSHans Petter Selasky
456b633e08cSHans Petter Selasky /* Temporary until the tree base description is replaced */
457b633e08cSHans Petter Selasky #define UAPI_DEF_CHAIN_OBJ_TREE(_object_enum, _object_ptr, ...) \
458b633e08cSHans Petter Selasky { \
459b633e08cSHans Petter Selasky .kind = UAPI_DEF_CHAIN_OBJ_TREE, \
460b633e08cSHans Petter Selasky .object_start = { .object_id = _object_enum }, \
461b633e08cSHans Petter Selasky .chain_obj_tree = _object_ptr, \
462b633e08cSHans Petter Selasky }, \
463b633e08cSHans Petter Selasky ##__VA_ARGS__
464b633e08cSHans Petter Selasky #define UAPI_DEF_CHAIN_OBJ_TREE_NAMED(_object_enum, ...) \
465b633e08cSHans Petter Selasky UAPI_DEF_CHAIN_OBJ_TREE(_object_enum, &UVERBS_OBJECT(_object_enum), \
466b633e08cSHans Petter Selasky ##__VA_ARGS__)
467b633e08cSHans Petter Selasky
468b633e08cSHans Petter Selasky /*
469b633e08cSHans Petter Selasky * =======================================
470b633e08cSHans Petter Selasky * Attribute Specifications
471b633e08cSHans Petter Selasky * =======================================
472b633e08cSHans Petter Selasky */
473b633e08cSHans Petter Selasky
474b633e08cSHans Petter Selasky #define UVERBS_ATTR_SIZE(_min_len, _len) \
475b633e08cSHans Petter Selasky .u.ptr.min_len = _min_len, .u.ptr.len = _len
476b633e08cSHans Petter Selasky
477b633e08cSHans Petter Selasky #define UVERBS_ATTR_NO_DATA() UVERBS_ATTR_SIZE(0, 0)
478b633e08cSHans Petter Selasky
479b633e08cSHans Petter Selasky /*
480b633e08cSHans Petter Selasky * Specifies a uapi structure that cannot be extended. The user must always
481b633e08cSHans Petter Selasky * supply the whole structure and nothing more. The structure must be declared
482b633e08cSHans Petter Selasky * in a header under include/uapi/rdma.
483b633e08cSHans Petter Selasky */
484b633e08cSHans Petter Selasky #define UVERBS_ATTR_TYPE(_type) \
485b633e08cSHans Petter Selasky .u.ptr.min_len = sizeof(_type), .u.ptr.len = sizeof(_type)
486b633e08cSHans Petter Selasky /*
487b633e08cSHans Petter Selasky * Specifies a uapi structure where the user must provide at least up to
488b633e08cSHans Petter Selasky * member 'last'. Anything after last and up until the end of the structure
489b633e08cSHans Petter Selasky * can be non-zero, anything longer than the end of the structure must be
490b633e08cSHans Petter Selasky * zero. The structure must be declared in a header under include/uapi/rdma.
491b633e08cSHans Petter Selasky */
492b633e08cSHans Petter Selasky #define UVERBS_ATTR_STRUCT(_type, _last) \
493b633e08cSHans Petter Selasky .zero_trailing = 1, \
494b633e08cSHans Petter Selasky UVERBS_ATTR_SIZE(((uintptr_t)(&((_type *)0)->_last + 1)), \
495b633e08cSHans Petter Selasky sizeof(_type))
496b633e08cSHans Petter Selasky /*
497b633e08cSHans Petter Selasky * Specifies at least min_len bytes must be passed in, but the amount can be
498b633e08cSHans Petter Selasky * larger, up to the protocol maximum size. No check for zeroing is done.
499b633e08cSHans Petter Selasky */
500b633e08cSHans Petter Selasky #define UVERBS_ATTR_MIN_SIZE(_min_len) UVERBS_ATTR_SIZE(_min_len, USHRT_MAX)
501b633e08cSHans Petter Selasky
502b633e08cSHans Petter Selasky /* Must be used in the '...' of any UVERBS_ATTR */
503b633e08cSHans Petter Selasky #define UA_ALLOC_AND_COPY .alloc_and_copy = 1
504b633e08cSHans Petter Selasky #define UA_MANDATORY .mandatory = 1
505b633e08cSHans Petter Selasky #define UA_OPTIONAL .mandatory = 0
506b633e08cSHans Petter Selasky
507b633e08cSHans Petter Selasky /*
508b633e08cSHans Petter Selasky * min_len must be bigger than 0 and _max_len must be smaller than 4095. Only
509b633e08cSHans Petter Selasky * READ\WRITE accesses are supported.
510b633e08cSHans Petter Selasky */
511b633e08cSHans Petter Selasky #define UVERBS_ATTR_IDRS_ARR(_attr_id, _idr_type, _access, _min_len, _max_len, \
512b633e08cSHans Petter Selasky ...) \
513b633e08cSHans Petter Selasky (&(const struct uverbs_attr_def){ \
514b633e08cSHans Petter Selasky .id = (_attr_id) + \
515b633e08cSHans Petter Selasky BUILD_BUG_ON_ZERO((_min_len) == 0 || \
516b633e08cSHans Petter Selasky (_max_len) > \
517b633e08cSHans Petter Selasky PAGE_SIZE / sizeof(void *) || \
518b633e08cSHans Petter Selasky (_min_len) > (_max_len) || \
519b633e08cSHans Petter Selasky (_access) == UVERBS_ACCESS_NEW || \
520b633e08cSHans Petter Selasky (_access) == UVERBS_ACCESS_DESTROY), \
521b633e08cSHans Petter Selasky .attr = { .type = UVERBS_ATTR_TYPE_IDRS_ARRAY, \
522b633e08cSHans Petter Selasky .u2.objs_arr.obj_type = _idr_type, \
523b633e08cSHans Petter Selasky .u2.objs_arr.access = _access, \
524b633e08cSHans Petter Selasky .u2.objs_arr.min_len = _min_len, \
525b633e08cSHans Petter Selasky .u2.objs_arr.max_len = _max_len, \
526b633e08cSHans Petter Selasky __VA_ARGS__ } })
527b633e08cSHans Petter Selasky
528b633e08cSHans Petter Selasky /*
529b633e08cSHans Petter Selasky * Only for use with UVERBS_ATTR_IDR, allows any uobject type to be accepted,
530b633e08cSHans Petter Selasky * the user must validate the type of the uobject instead.
531b633e08cSHans Petter Selasky */
532b633e08cSHans Petter Selasky #define UVERBS_IDR_ANY_OBJECT 0xFFFF
533b633e08cSHans Petter Selasky
534b633e08cSHans Petter Selasky #define UVERBS_ATTR_IDR(_attr_id, _idr_type, _access, ...) \
535b633e08cSHans Petter Selasky (&(const struct uverbs_attr_def){ \
536b633e08cSHans Petter Selasky .id = _attr_id, \
537b633e08cSHans Petter Selasky .attr = { .type = UVERBS_ATTR_TYPE_IDR, \
538b633e08cSHans Petter Selasky .u.obj.obj_type = _idr_type, \
539b633e08cSHans Petter Selasky .u.obj.access = _access, \
540b633e08cSHans Petter Selasky __VA_ARGS__ } })
541b633e08cSHans Petter Selasky
542b633e08cSHans Petter Selasky #define UVERBS_ATTR_FD(_attr_id, _fd_type, _access, ...) \
543b633e08cSHans Petter Selasky (&(const struct uverbs_attr_def){ \
544b633e08cSHans Petter Selasky .id = (_attr_id) + \
545b633e08cSHans Petter Selasky BUILD_BUG_ON_ZERO((_access) != UVERBS_ACCESS_NEW && \
546b633e08cSHans Petter Selasky (_access) != UVERBS_ACCESS_READ), \
547b633e08cSHans Petter Selasky .attr = { .type = UVERBS_ATTR_TYPE_FD, \
548b633e08cSHans Petter Selasky .u.obj.obj_type = _fd_type, \
549b633e08cSHans Petter Selasky .u.obj.access = _access, \
550b633e08cSHans Petter Selasky __VA_ARGS__ } })
551b633e08cSHans Petter Selasky
552b633e08cSHans Petter Selasky #define UVERBS_ATTR_PTR_IN(_attr_id, _type, ...) \
553b633e08cSHans Petter Selasky (&(const struct uverbs_attr_def){ \
554b633e08cSHans Petter Selasky .id = _attr_id, \
555b633e08cSHans Petter Selasky .attr = { .type = UVERBS_ATTR_TYPE_PTR_IN, \
556b633e08cSHans Petter Selasky _type, \
557b633e08cSHans Petter Selasky __VA_ARGS__ } })
558b633e08cSHans Petter Selasky
559b633e08cSHans Petter Selasky #define UVERBS_ATTR_PTR_OUT(_attr_id, _type, ...) \
560b633e08cSHans Petter Selasky (&(const struct uverbs_attr_def){ \
561b633e08cSHans Petter Selasky .id = _attr_id, \
562b633e08cSHans Petter Selasky .attr = { .type = UVERBS_ATTR_TYPE_PTR_OUT, \
563b633e08cSHans Petter Selasky _type, \
564b633e08cSHans Petter Selasky __VA_ARGS__ } })
565b633e08cSHans Petter Selasky
566b633e08cSHans Petter Selasky /* _enum_arry should be a 'static const union uverbs_attr_spec[]' */
567b633e08cSHans Petter Selasky #define UVERBS_ATTR_ENUM_IN(_attr_id, _enum_arr, ...) \
568b633e08cSHans Petter Selasky (&(const struct uverbs_attr_def){ \
569b633e08cSHans Petter Selasky .id = _attr_id, \
570b633e08cSHans Petter Selasky .attr = { .type = UVERBS_ATTR_TYPE_ENUM_IN, \
571b633e08cSHans Petter Selasky .u2.enum_def.ids = _enum_arr, \
572b633e08cSHans Petter Selasky .u.enum_def.num_elems = ARRAY_SIZE(_enum_arr), \
573b633e08cSHans Petter Selasky __VA_ARGS__ }, \
574b633e08cSHans Petter Selasky })
575b633e08cSHans Petter Selasky
576b633e08cSHans Petter Selasky /* An input value that is a member in the enum _enum_type. */
577b633e08cSHans Petter Selasky #define UVERBS_ATTR_CONST_IN(_attr_id, _enum_type, ...) \
578b633e08cSHans Petter Selasky UVERBS_ATTR_PTR_IN( \
579b633e08cSHans Petter Selasky _attr_id, \
580b633e08cSHans Petter Selasky UVERBS_ATTR_SIZE( \
581b633e08cSHans Petter Selasky sizeof(u64) + BUILD_BUG_ON_ZERO(!sizeof(_enum_type)), \
582b633e08cSHans Petter Selasky sizeof(u64)), \
583b633e08cSHans Petter Selasky __VA_ARGS__)
584b633e08cSHans Petter Selasky
585b633e08cSHans Petter Selasky /*
586b633e08cSHans Petter Selasky * An input value that is a bitwise combination of values of _enum_type.
587b633e08cSHans Petter Selasky * This permits the flag value to be passed as either a u32 or u64, it must
588b633e08cSHans Petter Selasky * be retrieved via uverbs_get_flag().
589b633e08cSHans Petter Selasky */
590b633e08cSHans Petter Selasky #define UVERBS_ATTR_FLAGS_IN(_attr_id, _enum_type, ...) \
591b633e08cSHans Petter Selasky UVERBS_ATTR_PTR_IN( \
592b633e08cSHans Petter Selasky _attr_id, \
593b633e08cSHans Petter Selasky UVERBS_ATTR_SIZE(sizeof(u32) + BUILD_BUG_ON_ZERO( \
594b633e08cSHans Petter Selasky !sizeof(_enum_type *)), \
595b633e08cSHans Petter Selasky sizeof(u64)), \
596b633e08cSHans Petter Selasky __VA_ARGS__)
597b633e08cSHans Petter Selasky
598b633e08cSHans Petter Selasky /*
599b633e08cSHans Petter Selasky * This spec is used in order to pass information to the hardware driver in a
600b633e08cSHans Petter Selasky * legacy way. Every verb that could get driver specific data should get this
601b633e08cSHans Petter Selasky * spec.
602b633e08cSHans Petter Selasky */
603b633e08cSHans Petter Selasky #define UVERBS_ATTR_UHW() \
604b633e08cSHans Petter Selasky UVERBS_ATTR_PTR_IN(UVERBS_ATTR_UHW_IN, \
605b633e08cSHans Petter Selasky UVERBS_ATTR_MIN_SIZE(0), \
606b633e08cSHans Petter Selasky UA_OPTIONAL, \
607b633e08cSHans Petter Selasky .is_udata = 1), \
608b633e08cSHans Petter Selasky UVERBS_ATTR_PTR_OUT(UVERBS_ATTR_UHW_OUT, \
609b633e08cSHans Petter Selasky UVERBS_ATTR_MIN_SIZE(0), \
610b633e08cSHans Petter Selasky UA_OPTIONAL, \
611b633e08cSHans Petter Selasky .is_udata = 1)
612b633e08cSHans Petter Selasky
613b633e08cSHans Petter Selasky /* =================================================
614b633e08cSHans Petter Selasky * Parsing infrastructure
615b633e08cSHans Petter Selasky * =================================================
616b633e08cSHans Petter Selasky */
617b633e08cSHans Petter Selasky
618b633e08cSHans Petter Selasky
619b633e08cSHans Petter Selasky struct uverbs_ptr_attr {
620b633e08cSHans Petter Selasky /*
621b633e08cSHans Petter Selasky * If UVERBS_ATTR_SPEC_F_ALLOC_AND_COPY is set then the 'ptr' is
622b633e08cSHans Petter Selasky * used.
623b633e08cSHans Petter Selasky */
624b633e08cSHans Petter Selasky union {
625b633e08cSHans Petter Selasky void *ptr;
626b633e08cSHans Petter Selasky u64 data;
627b633e08cSHans Petter Selasky };
628b633e08cSHans Petter Selasky u16 len;
629b633e08cSHans Petter Selasky u16 uattr_idx;
630b633e08cSHans Petter Selasky u8 enum_id;
631b633e08cSHans Petter Selasky };
632b633e08cSHans Petter Selasky
633b633e08cSHans Petter Selasky struct uverbs_obj_attr {
634b633e08cSHans Petter Selasky struct ib_uobject *uobject;
635b633e08cSHans Petter Selasky const struct uverbs_api_attr *attr_elm;
636b633e08cSHans Petter Selasky };
637b633e08cSHans Petter Selasky
638b633e08cSHans Petter Selasky struct uverbs_objs_arr_attr {
639b633e08cSHans Petter Selasky struct ib_uobject **uobjects;
640b633e08cSHans Petter Selasky u16 len;
641b633e08cSHans Petter Selasky };
642b633e08cSHans Petter Selasky
643b633e08cSHans Petter Selasky struct uverbs_attr {
644b633e08cSHans Petter Selasky union {
645b633e08cSHans Petter Selasky struct uverbs_ptr_attr ptr_attr;
646b633e08cSHans Petter Selasky struct uverbs_obj_attr obj_attr;
647b633e08cSHans Petter Selasky struct uverbs_objs_arr_attr objs_arr_attr;
648b633e08cSHans Petter Selasky };
649b633e08cSHans Petter Selasky };
650b633e08cSHans Petter Selasky
651b633e08cSHans Petter Selasky struct uverbs_attr_bundle {
652b633e08cSHans Petter Selasky struct ib_udata driver_udata;
653b633e08cSHans Petter Selasky struct ib_udata ucore;
654b633e08cSHans Petter Selasky struct ib_uverbs_file *ufile;
655b633e08cSHans Petter Selasky struct ib_ucontext *context;
656b633e08cSHans Petter Selasky DECLARE_BITMAP(attr_present, UVERBS_API_ATTR_BKEY_LEN);
657b633e08cSHans Petter Selasky struct uverbs_attr attrs[0];
658b633e08cSHans Petter Selasky };
659b633e08cSHans Petter Selasky
uverbs_attr_is_valid(const struct uverbs_attr_bundle * attrs_bundle,unsigned int idx)660b633e08cSHans Petter Selasky static inline bool uverbs_attr_is_valid(const struct uverbs_attr_bundle *attrs_bundle,
661b633e08cSHans Petter Selasky unsigned int idx)
662b633e08cSHans Petter Selasky {
663b633e08cSHans Petter Selasky return test_bit(uapi_bkey_attr(uapi_key_attr(idx)),
664b633e08cSHans Petter Selasky attrs_bundle->attr_present);
665b633e08cSHans Petter Selasky }
666b633e08cSHans Petter Selasky
667b633e08cSHans Petter Selasky /**
668b633e08cSHans Petter Selasky * rdma_udata_to_drv_context - Helper macro to get the driver's context out of
669b633e08cSHans Petter Selasky * ib_udata which is embedded in uverbs_attr_bundle.
670b633e08cSHans Petter Selasky *
671b633e08cSHans Petter Selasky * If udata is not NULL this cannot fail. Otherwise a NULL udata will result
672b633e08cSHans Petter Selasky * in a NULL ucontext pointer, as a safety precaution. Callers should be using
673b633e08cSHans Petter Selasky * 'udata' to determine if the driver call is in user or kernel mode, not
674b633e08cSHans Petter Selasky * 'ucontext'.
675b633e08cSHans Petter Selasky *
676b633e08cSHans Petter Selasky */
677b633e08cSHans Petter Selasky #define rdma_udata_to_drv_context(udata, drv_dev_struct, member) \
678b633e08cSHans Petter Selasky (udata ? container_of(container_of(udata, struct uverbs_attr_bundle, \
679b633e08cSHans Petter Selasky driver_udata) \
680b633e08cSHans Petter Selasky ->context, \
681b633e08cSHans Petter Selasky drv_dev_struct, member) : \
682b633e08cSHans Petter Selasky (drv_dev_struct *)NULL)
683b633e08cSHans Petter Selasky
684b633e08cSHans Petter Selasky #define IS_UVERBS_COPY_ERR(_ret) ((_ret) && (_ret) != -ENOENT)
685b633e08cSHans Petter Selasky
uverbs_attr_get(const struct uverbs_attr_bundle * attrs_bundle,u16 idx)686b633e08cSHans Petter Selasky static inline const struct uverbs_attr *uverbs_attr_get(const struct uverbs_attr_bundle *attrs_bundle,
687b633e08cSHans Petter Selasky u16 idx)
688b633e08cSHans Petter Selasky {
689b633e08cSHans Petter Selasky if (!uverbs_attr_is_valid(attrs_bundle, idx))
690b633e08cSHans Petter Selasky return ERR_PTR(-ENOENT);
691b633e08cSHans Petter Selasky
692b633e08cSHans Petter Selasky return &attrs_bundle->attrs[uapi_bkey_attr(uapi_key_attr(idx))];
693b633e08cSHans Petter Selasky }
694b633e08cSHans Petter Selasky
uverbs_attr_get_enum_id(const struct uverbs_attr_bundle * attrs_bundle,u16 idx)695b633e08cSHans Petter Selasky static inline int uverbs_attr_get_enum_id(const struct uverbs_attr_bundle *attrs_bundle,
696b633e08cSHans Petter Selasky u16 idx)
697b633e08cSHans Petter Selasky {
698b633e08cSHans Petter Selasky const struct uverbs_attr *attr = uverbs_attr_get(attrs_bundle, idx);
699b633e08cSHans Petter Selasky
700b633e08cSHans Petter Selasky if (IS_ERR(attr))
701b633e08cSHans Petter Selasky return PTR_ERR(attr);
702b633e08cSHans Petter Selasky
703b633e08cSHans Petter Selasky return attr->ptr_attr.enum_id;
704b633e08cSHans Petter Selasky }
705b633e08cSHans Petter Selasky
uverbs_attr_get_obj(const struct uverbs_attr_bundle * attrs_bundle,u16 idx)706b633e08cSHans Petter Selasky static inline void *uverbs_attr_get_obj(const struct uverbs_attr_bundle *attrs_bundle,
707b633e08cSHans Petter Selasky u16 idx)
708b633e08cSHans Petter Selasky {
709b633e08cSHans Petter Selasky const struct uverbs_attr *attr;
710b633e08cSHans Petter Selasky
711b633e08cSHans Petter Selasky attr = uverbs_attr_get(attrs_bundle, idx);
712b633e08cSHans Petter Selasky if (IS_ERR(attr))
713b633e08cSHans Petter Selasky return ERR_CAST(attr);
714b633e08cSHans Petter Selasky
715b633e08cSHans Petter Selasky return attr->obj_attr.uobject->object;
716b633e08cSHans Petter Selasky }
717b633e08cSHans Petter Selasky
uverbs_attr_get_uobject(const struct uverbs_attr_bundle * attrs_bundle,u16 idx)718b633e08cSHans Petter Selasky static inline struct ib_uobject *uverbs_attr_get_uobject(const struct uverbs_attr_bundle *attrs_bundle,
719b633e08cSHans Petter Selasky u16 idx)
720b633e08cSHans Petter Selasky {
721b633e08cSHans Petter Selasky const struct uverbs_attr *attr = uverbs_attr_get(attrs_bundle, idx);
722b633e08cSHans Petter Selasky
723b633e08cSHans Petter Selasky if (IS_ERR(attr))
724b633e08cSHans Petter Selasky return ERR_CAST(attr);
725b633e08cSHans Petter Selasky
726b633e08cSHans Petter Selasky return attr->obj_attr.uobject;
727b633e08cSHans Petter Selasky }
728b633e08cSHans Petter Selasky
729b633e08cSHans Petter Selasky static inline int
uverbs_attr_get_len(const struct uverbs_attr_bundle * attrs_bundle,u16 idx)730b633e08cSHans Petter Selasky uverbs_attr_get_len(const struct uverbs_attr_bundle *attrs_bundle, u16 idx)
731b633e08cSHans Petter Selasky {
732b633e08cSHans Petter Selasky const struct uverbs_attr *attr = uverbs_attr_get(attrs_bundle, idx);
733b633e08cSHans Petter Selasky
734b633e08cSHans Petter Selasky if (IS_ERR(attr))
735b633e08cSHans Petter Selasky return PTR_ERR(attr);
736b633e08cSHans Petter Selasky
737b633e08cSHans Petter Selasky return attr->ptr_attr.len;
738b633e08cSHans Petter Selasky }
739b633e08cSHans Petter Selasky
740b633e08cSHans Petter Selasky /*
741b633e08cSHans Petter Selasky * uverbs_attr_ptr_get_array_size() - Get array size pointer by a ptr
742b633e08cSHans Petter Selasky * attribute.
743b633e08cSHans Petter Selasky * @attrs: The attribute bundle
744b633e08cSHans Petter Selasky * @idx: The ID of the attribute
745b633e08cSHans Petter Selasky * @elem_size: The size of the element in the array
746b633e08cSHans Petter Selasky */
747b633e08cSHans Petter Selasky static inline int
uverbs_attr_ptr_get_array_size(struct uverbs_attr_bundle * attrs,u16 idx,size_t elem_size)748b633e08cSHans Petter Selasky uverbs_attr_ptr_get_array_size(struct uverbs_attr_bundle *attrs, u16 idx,
749b633e08cSHans Petter Selasky size_t elem_size)
750b633e08cSHans Petter Selasky {
751b633e08cSHans Petter Selasky int size = uverbs_attr_get_len(attrs, idx);
752b633e08cSHans Petter Selasky
753b633e08cSHans Petter Selasky if (size < 0)
754b633e08cSHans Petter Selasky return size;
755b633e08cSHans Petter Selasky
756b633e08cSHans Petter Selasky if (size % elem_size)
757b633e08cSHans Petter Selasky return -EINVAL;
758b633e08cSHans Petter Selasky
759b633e08cSHans Petter Selasky return size / elem_size;
760b633e08cSHans Petter Selasky }
761b633e08cSHans Petter Selasky
762b633e08cSHans Petter Selasky /**
763b633e08cSHans Petter Selasky * uverbs_attr_get_uobjs_arr() - Provides array's properties for attribute for
764b633e08cSHans Petter Selasky * UVERBS_ATTR_TYPE_IDRS_ARRAY.
765b633e08cSHans Petter Selasky * @arr: Returned pointer to array of pointers for uobjects or NULL if
766b633e08cSHans Petter Selasky * the attribute isn't provided.
767b633e08cSHans Petter Selasky *
768b633e08cSHans Petter Selasky * Return: The array length or 0 if no attribute was provided.
769b633e08cSHans Petter Selasky */
uverbs_attr_get_uobjs_arr(const struct uverbs_attr_bundle * attrs_bundle,u16 attr_idx,struct ib_uobject *** arr)770b633e08cSHans Petter Selasky static inline int uverbs_attr_get_uobjs_arr(
771b633e08cSHans Petter Selasky const struct uverbs_attr_bundle *attrs_bundle, u16 attr_idx,
772b633e08cSHans Petter Selasky struct ib_uobject ***arr)
773b633e08cSHans Petter Selasky {
774b633e08cSHans Petter Selasky const struct uverbs_attr *attr =
775b633e08cSHans Petter Selasky uverbs_attr_get(attrs_bundle, attr_idx);
776b633e08cSHans Petter Selasky
777b633e08cSHans Petter Selasky if (IS_ERR(attr)) {
778b633e08cSHans Petter Selasky *arr = NULL;
779b633e08cSHans Petter Selasky return 0;
780b633e08cSHans Petter Selasky }
781b633e08cSHans Petter Selasky
782b633e08cSHans Petter Selasky *arr = attr->objs_arr_attr.uobjects;
783b633e08cSHans Petter Selasky
784b633e08cSHans Petter Selasky return attr->objs_arr_attr.len;
785b633e08cSHans Petter Selasky }
786b633e08cSHans Petter Selasky
uverbs_attr_ptr_is_inline(const struct uverbs_attr * attr)787b633e08cSHans Petter Selasky static inline bool uverbs_attr_ptr_is_inline(const struct uverbs_attr *attr)
788b633e08cSHans Petter Selasky {
789b633e08cSHans Petter Selasky return attr->ptr_attr.len <= sizeof(attr->ptr_attr.data);
790b633e08cSHans Petter Selasky }
791b633e08cSHans Petter Selasky
uverbs_attr_get_alloced_ptr(const struct uverbs_attr_bundle * attrs_bundle,u16 idx)792b633e08cSHans Petter Selasky static inline void *uverbs_attr_get_alloced_ptr(
793b633e08cSHans Petter Selasky const struct uverbs_attr_bundle *attrs_bundle, u16 idx)
794b633e08cSHans Petter Selasky {
795b633e08cSHans Petter Selasky struct uverbs_attr *attr = __DECONST(struct uverbs_attr *, uverbs_attr_get(attrs_bundle, idx));
796b633e08cSHans Petter Selasky
797b633e08cSHans Petter Selasky if (IS_ERR(attr))
798b633e08cSHans Petter Selasky return (void *)attr;
799b633e08cSHans Petter Selasky
800b633e08cSHans Petter Selasky return uverbs_attr_ptr_is_inline(attr) ?
801b633e08cSHans Petter Selasky (void *)&attr->ptr_attr.data : attr->ptr_attr.ptr;
802b633e08cSHans Petter Selasky }
803b633e08cSHans Petter Selasky
_uverbs_copy_from(void * to,const struct uverbs_attr_bundle * attrs_bundle,size_t idx,size_t size)804b633e08cSHans Petter Selasky static inline int _uverbs_copy_from(void *to,
805b633e08cSHans Petter Selasky const struct uverbs_attr_bundle *attrs_bundle,
806b633e08cSHans Petter Selasky size_t idx,
807b633e08cSHans Petter Selasky size_t size)
808b633e08cSHans Petter Selasky {
809b633e08cSHans Petter Selasky const struct uverbs_attr *attr = uverbs_attr_get(attrs_bundle, idx);
810b633e08cSHans Petter Selasky
811b633e08cSHans Petter Selasky if (IS_ERR(attr))
812b633e08cSHans Petter Selasky return PTR_ERR(attr);
813b633e08cSHans Petter Selasky
814b633e08cSHans Petter Selasky /*
815b633e08cSHans Petter Selasky * Validation ensures attr->ptr_attr.len >= size. If the caller is
816b633e08cSHans Petter Selasky * using UVERBS_ATTR_SPEC_F_MIN_SZ_OR_ZERO then it must call
817b633e08cSHans Petter Selasky * uverbs_copy_from_or_zero.
818b633e08cSHans Petter Selasky */
819b633e08cSHans Petter Selasky if (unlikely(size < attr->ptr_attr.len))
820b633e08cSHans Petter Selasky return -EINVAL;
821b633e08cSHans Petter Selasky
822b633e08cSHans Petter Selasky if (uverbs_attr_ptr_is_inline(attr))
823b633e08cSHans Petter Selasky memcpy(to, &attr->ptr_attr.data, attr->ptr_attr.len);
824b633e08cSHans Petter Selasky else if (copy_from_user(to, u64_to_user_ptr(attr->ptr_attr.data),
825b633e08cSHans Petter Selasky attr->ptr_attr.len))
826b633e08cSHans Petter Selasky return -EFAULT;
827b633e08cSHans Petter Selasky
828b633e08cSHans Petter Selasky return 0;
829b633e08cSHans Petter Selasky }
830b633e08cSHans Petter Selasky
_uverbs_copy_from_or_zero(void * to,const struct uverbs_attr_bundle * attrs_bundle,size_t idx,size_t size)831b633e08cSHans Petter Selasky static inline int _uverbs_copy_from_or_zero(void *to,
832b633e08cSHans Petter Selasky const struct uverbs_attr_bundle *attrs_bundle,
833b633e08cSHans Petter Selasky size_t idx,
834b633e08cSHans Petter Selasky size_t size)
835b633e08cSHans Petter Selasky {
836b633e08cSHans Petter Selasky const struct uverbs_attr *attr = uverbs_attr_get(attrs_bundle, idx);
837b633e08cSHans Petter Selasky size_t min_size;
838b633e08cSHans Petter Selasky
839b633e08cSHans Petter Selasky if (IS_ERR(attr))
840b633e08cSHans Petter Selasky return PTR_ERR(attr);
841b633e08cSHans Petter Selasky
842b633e08cSHans Petter Selasky min_size = min_t(size_t, size, attr->ptr_attr.len);
843b633e08cSHans Petter Selasky
844b633e08cSHans Petter Selasky if (uverbs_attr_ptr_is_inline(attr))
845b633e08cSHans Petter Selasky memcpy(to, &attr->ptr_attr.data, min_size);
846b633e08cSHans Petter Selasky else if (copy_from_user(to, u64_to_user_ptr(attr->ptr_attr.data),
847b633e08cSHans Petter Selasky min_size))
848b633e08cSHans Petter Selasky return -EFAULT;
849b633e08cSHans Petter Selasky
850b633e08cSHans Petter Selasky if (size > min_size)
851b633e08cSHans Petter Selasky memset((char *)to + min_size, 0, size - min_size);
852b633e08cSHans Petter Selasky
853b633e08cSHans Petter Selasky return 0;
854b633e08cSHans Petter Selasky }
855b633e08cSHans Petter Selasky
856b633e08cSHans Petter Selasky #define uverbs_copy_from(to, attrs_bundle, idx) \
857b633e08cSHans Petter Selasky _uverbs_copy_from(to, attrs_bundle, idx, sizeof(*to))
858b633e08cSHans Petter Selasky
859b633e08cSHans Petter Selasky #define uverbs_copy_from_or_zero(to, attrs_bundle, idx) \
860b633e08cSHans Petter Selasky _uverbs_copy_from_or_zero(to, attrs_bundle, idx, sizeof(*to))
861b633e08cSHans Petter Selasky
862b633e08cSHans Petter Selasky static inline struct ib_ucontext *
ib_uverbs_get_ucontext(const struct uverbs_attr_bundle * attrs)863b633e08cSHans Petter Selasky ib_uverbs_get_ucontext(const struct uverbs_attr_bundle *attrs)
864b633e08cSHans Petter Selasky {
865b633e08cSHans Petter Selasky return ib_uverbs_get_ucontext_file(attrs->ufile);
866b633e08cSHans Petter Selasky }
867b633e08cSHans Petter Selasky
868b633e08cSHans Petter Selasky #if 1 /* IS_ENABLED(CONFIG_INFINIBAND_USER_ACCESS) */
869b633e08cSHans Petter Selasky int uverbs_get_flags64(u64 *to, const struct uverbs_attr_bundle *attrs_bundle,
870b633e08cSHans Petter Selasky size_t idx, u64 allowed_bits);
871b633e08cSHans Petter Selasky int uverbs_get_flags32(u32 *to, const struct uverbs_attr_bundle *attrs_bundle,
872b633e08cSHans Petter Selasky size_t idx, u64 allowed_bits);
873b633e08cSHans Petter Selasky int uverbs_copy_to(const struct uverbs_attr_bundle *attrs_bundle, size_t idx,
874b633e08cSHans Petter Selasky const void *from, size_t size);
875b633e08cSHans Petter Selasky __malloc void *_uverbs_alloc(struct uverbs_attr_bundle *bundle, size_t size,
876b633e08cSHans Petter Selasky gfp_t flags);
877b633e08cSHans Petter Selasky
uverbs_alloc(struct uverbs_attr_bundle * bundle,size_t size)878b633e08cSHans Petter Selasky static inline __malloc void *uverbs_alloc(struct uverbs_attr_bundle *bundle,
879b633e08cSHans Petter Selasky size_t size)
880b633e08cSHans Petter Selasky {
881b633e08cSHans Petter Selasky return _uverbs_alloc(bundle, size, GFP_KERNEL);
882b633e08cSHans Petter Selasky }
883b633e08cSHans Petter Selasky
uverbs_zalloc(struct uverbs_attr_bundle * bundle,size_t size)884b633e08cSHans Petter Selasky static inline __malloc void *uverbs_zalloc(struct uverbs_attr_bundle *bundle,
885b633e08cSHans Petter Selasky size_t size)
886b633e08cSHans Petter Selasky {
887b633e08cSHans Petter Selasky return _uverbs_alloc(bundle, size, GFP_KERNEL | __GFP_ZERO);
888b633e08cSHans Petter Selasky }
889b633e08cSHans Petter Selasky int _uverbs_get_const(s64 *to, const struct uverbs_attr_bundle *attrs_bundle,
890b633e08cSHans Petter Selasky size_t idx, s64 lower_bound, u64 upper_bound,
891b633e08cSHans Petter Selasky s64 *def_val);
892b633e08cSHans Petter Selasky int uverbs_copy_to_struct_or_zero(const struct uverbs_attr_bundle *bundle,
893b633e08cSHans Petter Selasky size_t idx, const void *from, size_t size);
894b633e08cSHans Petter Selasky #else
895b633e08cSHans Petter Selasky static inline int
uverbs_get_flags64(u64 * to,const struct uverbs_attr_bundle * attrs_bundle,size_t idx,u64 allowed_bits)896b633e08cSHans Petter Selasky uverbs_get_flags64(u64 *to, const struct uverbs_attr_bundle *attrs_bundle,
897b633e08cSHans Petter Selasky size_t idx, u64 allowed_bits)
898b633e08cSHans Petter Selasky {
899b633e08cSHans Petter Selasky return -EINVAL;
900b633e08cSHans Petter Selasky }
901b633e08cSHans Petter Selasky static inline int
uverbs_get_flags32(u32 * to,const struct uverbs_attr_bundle * attrs_bundle,size_t idx,u64 allowed_bits)902b633e08cSHans Petter Selasky uverbs_get_flags32(u32 *to, const struct uverbs_attr_bundle *attrs_bundle,
903b633e08cSHans Petter Selasky size_t idx, u64 allowed_bits)
904b633e08cSHans Petter Selasky {
905b633e08cSHans Petter Selasky return -EINVAL;
906b633e08cSHans Petter Selasky }
uverbs_copy_to(const struct uverbs_attr_bundle * attrs_bundle,size_t idx,const void * from,size_t size)907b633e08cSHans Petter Selasky static inline int uverbs_copy_to(const struct uverbs_attr_bundle *attrs_bundle,
908b633e08cSHans Petter Selasky size_t idx, const void *from, size_t size)
909b633e08cSHans Petter Selasky {
910b633e08cSHans Petter Selasky return -EINVAL;
911b633e08cSHans Petter Selasky }
uverbs_alloc(struct uverbs_attr_bundle * bundle,size_t size)912b633e08cSHans Petter Selasky static inline __malloc void *uverbs_alloc(struct uverbs_attr_bundle *bundle,
913b633e08cSHans Petter Selasky size_t size)
914b633e08cSHans Petter Selasky {
915b633e08cSHans Petter Selasky return ERR_PTR(-EINVAL);
916b633e08cSHans Petter Selasky }
uverbs_zalloc(struct uverbs_attr_bundle * bundle,size_t size)917b633e08cSHans Petter Selasky static inline __malloc void *uverbs_zalloc(struct uverbs_attr_bundle *bundle,
918b633e08cSHans Petter Selasky size_t size)
919b633e08cSHans Petter Selasky {
920b633e08cSHans Petter Selasky return ERR_PTR(-EINVAL);
921b633e08cSHans Petter Selasky }
922b633e08cSHans Petter Selasky static inline int
_uverbs_get_const(s64 * to,const struct uverbs_attr_bundle * attrs_bundle,size_t idx,s64 lower_bound,u64 upper_bound,s64 * def_val)923b633e08cSHans Petter Selasky _uverbs_get_const(s64 *to, const struct uverbs_attr_bundle *attrs_bundle,
924b633e08cSHans Petter Selasky size_t idx, s64 lower_bound, u64 upper_bound,
925b633e08cSHans Petter Selasky s64 *def_val)
926b633e08cSHans Petter Selasky {
927b633e08cSHans Petter Selasky return -EINVAL;
928b633e08cSHans Petter Selasky }
929b633e08cSHans Petter Selasky static inline int
uverbs_copy_to_struct_or_zero(const struct uverbs_attr_bundle * bundle,size_t idx,const void * from,size_t size)930b633e08cSHans Petter Selasky uverbs_copy_to_struct_or_zero(const struct uverbs_attr_bundle *bundle,
931b633e08cSHans Petter Selasky size_t idx, const void *from, size_t size)
932b633e08cSHans Petter Selasky {
933b633e08cSHans Petter Selasky return -EINVAL;
934b633e08cSHans Petter Selasky }
935b633e08cSHans Petter Selasky #endif
936b633e08cSHans Petter Selasky
937b633e08cSHans Petter Selasky #define uverbs_get_const(_to, _attrs_bundle, _idx) \
938b633e08cSHans Petter Selasky ({ \
939b633e08cSHans Petter Selasky s64 _val; \
940b633e08cSHans Petter Selasky int _ret = _uverbs_get_const(&_val, _attrs_bundle, _idx, \
941b633e08cSHans Petter Selasky type_min(typeof(*_to)), \
942b633e08cSHans Petter Selasky type_max(typeof(*_to)), NULL); \
943b633e08cSHans Petter Selasky (*_to) = _val; \
944b633e08cSHans Petter Selasky _ret; \
945b633e08cSHans Petter Selasky })
946b633e08cSHans Petter Selasky
947b633e08cSHans Petter Selasky #define uverbs_get_const_default(_to, _attrs_bundle, _idx, _default) \
948b633e08cSHans Petter Selasky ({ \
949b633e08cSHans Petter Selasky s64 _val; \
950b633e08cSHans Petter Selasky s64 _def_val = _default; \
951b633e08cSHans Petter Selasky int _ret = \
952b633e08cSHans Petter Selasky _uverbs_get_const(&_val, _attrs_bundle, _idx, \
953b633e08cSHans Petter Selasky type_min(typeof(*_to)), \
954b633e08cSHans Petter Selasky type_max(typeof(*_to)), &_def_val); \
955b633e08cSHans Petter Selasky (*_to) = _val; \
956b633e08cSHans Petter Selasky _ret; \
957b633e08cSHans Petter Selasky })
958b633e08cSHans Petter Selasky #endif
959