[mirror_ubuntu-bionic-kernel.git] / include / rdma / uverbs_ioctl.h

/*
 * Copyright (c) 2017, Mellanox Technologies inc.  All rights reserved.
 *
 * This software is available to you under a choice of one of two
 * licenses.  You may choose to be licensed under the terms of the GNU
 * General Public License (GPL) Version 2, available from the file
 * COPYING in the main directory of this source tree, or the
 * OpenIB.org BSD license below:
 *
 *     Redistribution and use in source and binary forms, with or
 *     without modification, are permitted provided that the following
 *     conditions are met:
 *
 *      - Redistributions of source code must retain the above
 *        copyright notice, this list of conditions and the following
 *        disclaimer.
 *
 *      - Redistributions in binary form must reproduce the above
 *        copyright notice, this list of conditions and the following
 *        disclaimer in the documentation and/or other materials
 *        provided with the distribution.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

#ifndef _UVERBS_IOCTL_
#define _UVERBS_IOCTL_

#include <rdma/uverbs_types.h>
#include <linux/uaccess.h>
#include <rdma/rdma_user_ioctl.h>

/*
 * =======================================
 *	Verbs action specifications
 * =======================================
 */

enum uverbs_attr_type {
	UVERBS_ATTR_TYPE_NA,
	UVERBS_ATTR_TYPE_PTR_IN,
	UVERBS_ATTR_TYPE_PTR_OUT,
	UVERBS_ATTR_TYPE_IDR,
	UVERBS_ATTR_TYPE_FD,
};

enum uverbs_obj_access {
	UVERBS_ACCESS_READ,
	UVERBS_ACCESS_WRITE,
	UVERBS_ACCESS_NEW,
	UVERBS_ACCESS_DESTROY
};

enum {
	UVERBS_ATTR_SPEC_F_MANDATORY	= 1U << 0,
	/* Support extending attributes by length */
	UVERBS_ATTR_SPEC_F_MIN_SZ	= 1U << 1,
};

struct uverbs_attr_spec {
	enum uverbs_attr_type		type;
	union {
		u16				len;
		struct {
			/*
			 * higher bits mean the namespace and lower bits mean
			 * the type id within the namespace.
			 */
			u16			obj_type;
			u8			access;
		} obj;
	};
	/* Combination of bits from enum UVERBS_ATTR_SPEC_F_XXXX */
	u8				flags;
};

struct uverbs_attr_spec_hash {
	size_t				num_attrs;
	unsigned long			*mandatory_attrs_bitmask;
	struct uverbs_attr_spec		attrs[0];
};

struct uverbs_attr_bundle;
struct ib_uverbs_file;

enum {
	/*
	 * Action marked with this flag creates a context (or root for all
	 * objects).
	 */
	UVERBS_ACTION_FLAG_CREATE_ROOT = 1U << 0,
};

struct uverbs_method_spec {
	/* Combination of bits from enum UVERBS_ACTION_FLAG_XXXX */
	u32						flags;
	size_t						num_buckets;
	size_t						num_child_attrs;
	int (*handler)(struct ib_device *ib_dev, struct ib_uverbs_file *ufile,
		       struct uverbs_attr_bundle *ctx);
	struct uverbs_attr_spec_hash		*attr_buckets[0];
};

struct uverbs_method_spec_hash {
	size_t					num_methods;
	struct uverbs_method_spec		*methods[0];
};

struct uverbs_object_spec {
	const struct uverbs_obj_type		*type_attrs;
	size_t					num_buckets;
	struct uverbs_method_spec_hash		*method_buckets[0];
};

struct uverbs_object_spec_hash {
	size_t					num_objects;
	struct uverbs_object_spec		*objects[0];
};

struct uverbs_root_spec {
	size_t					num_buckets;
	struct uverbs_object_spec_hash		*object_buckets[0];
};

/*
 * =======================================
 *	Verbs definitions
 * =======================================
 */

struct uverbs_attr_def {
	u16                           id;
	struct uverbs_attr_spec       attr;
};

struct uverbs_method_def {
	u16                                  id;
	/* Combination of bits from enum UVERBS_ACTION_FLAG_XXXX */
	u32				     flags;
	size_t				     num_attrs;
	const struct uverbs_attr_def * const (*attrs)[];
	int (*handler)(struct ib_device *ib_dev, struct ib_uverbs_file *ufile,
		       struct uverbs_attr_bundle *ctx);
};

struct uverbs_object_def {
	u16					 id;
	const struct uverbs_obj_type	        *type_attrs;
	size_t				         num_methods;
	const struct uverbs_method_def * const (*methods)[];
};

struct uverbs_object_tree_def {
	size_t					 num_objects;
	const struct uverbs_object_def * const (*objects)[];
};

#define UA_FLAGS(_flags)  .flags = _flags
#define __UVERBS_ATTR0(_id, _len, _type, ...)                           \
	((const struct uverbs_attr_def)				  \
	 {.id = _id, .attr = {.type = _type, {.len = _len}, .flags = 0, } })
#define __UVERBS_ATTR1(_id, _len, _type, _flags)                        \
	((const struct uverbs_attr_def)				  \
	 {.id = _id, .attr = {.type = _type, {.len = _len}, _flags, } })
#define __UVERBS_ATTR(_id, _len, _type, _flags, _n, ...)		\
	__UVERBS_ATTR##_n(_id, _len, _type, _flags)
/*
 * In new compiler, UVERBS_ATTR could be simplified by declaring it as
 * [_id] = {.type = _type, .len = _len, ##__VA_ARGS__}
 * But since we support older compilers too, we need the more complex code.
 */
#define UVERBS_ATTR(_id, _len, _type, ...)				\
	__UVERBS_ATTR(_id, _len, _type, ##__VA_ARGS__, 1, 0)
#define UVERBS_ATTR_PTR_IN_SZ(_id, _len, ...)				\
	UVERBS_ATTR(_id, _len, UVERBS_ATTR_TYPE_PTR_IN, ##__VA_ARGS__)
/* If sizeof(_type) <= sizeof(u64), this will be inlined rather than a pointer */
#define UVERBS_ATTR_PTR_IN(_id, _type, ...)				\
	UVERBS_ATTR_PTR_IN_SZ(_id, sizeof(_type), ##__VA_ARGS__)
#define UVERBS_ATTR_PTR_OUT_SZ(_id, _len, ...)				\
	UVERBS_ATTR(_id, _len, UVERBS_ATTR_TYPE_PTR_OUT, ##__VA_ARGS__)
#define UVERBS_ATTR_PTR_OUT(_id, _type, ...)				\
	UVERBS_ATTR_PTR_OUT_SZ(_id, sizeof(_type), ##__VA_ARGS__)

/*
 * In new compiler, UVERBS_ATTR_IDR (and FD) could be simplified by declaring
 * it as
 * {.id = _id,								\
 *  .attr {.type = __obj_class,						\
 *         .obj = {.obj_type = _idr_type,				\
 *                       .access = _access                              \
 *                }, ##__VA_ARGS__ } }
 * But since we support older compilers too, we need the more complex code.
 */
#define ___UVERBS_ATTR_OBJ0(_id, _obj_class, _obj_type, _access, ...)\
	((const struct uverbs_attr_def)					\
	{.id = _id,							\
	 .attr = {.type = _obj_class,					\
		  {.obj = {.obj_type = _obj_type, .access = _access } },\
		  .flags = 0} })
#define ___UVERBS_ATTR_OBJ1(_id, _obj_class, _obj_type, _access, _flags)\
	((const struct uverbs_attr_def)					\
	{.id = _id,							\
	.attr = {.type = _obj_class,					\
		 {.obj = {.obj_type = _obj_type, .access = _access} },	\
		  _flags} })
#define ___UVERBS_ATTR_OBJ(_id, _obj_class, _obj_type, _access, _flags, \
			   _n, ...)					\
	___UVERBS_ATTR_OBJ##_n(_id, _obj_class, _obj_type, _access, _flags)
#define __UVERBS_ATTR_OBJ(_id, _obj_class, _obj_type, _access, ...)	\
	___UVERBS_ATTR_OBJ(_id, _obj_class, _obj_type, _access,		\
			   ##__VA_ARGS__, 1, 0)
#define UVERBS_ATTR_IDR(_id, _idr_type, _access, ...)			 \
	__UVERBS_ATTR_OBJ(_id, UVERBS_ATTR_TYPE_IDR, _idr_type, _access,\
			  ##__VA_ARGS__)
#define UVERBS_ATTR_FD(_id, _fd_type, _access, ...)			\
	__UVERBS_ATTR_OBJ(_id, UVERBS_ATTR_TYPE_FD, _fd_type,		\
			  (_access) + BUILD_BUG_ON_ZERO(		\
				(_access) != UVERBS_ACCESS_NEW &&	\
				(_access) != UVERBS_ACCESS_READ),	\
			  ##__VA_ARGS__)
#define DECLARE_UVERBS_ATTR_SPEC(_name, ...)				\
	const struct uverbs_attr_def _name = __VA_ARGS__

#define _UVERBS_METHOD_ATTRS_SZ(...)					\
	(sizeof((const struct uverbs_attr_def * const []){__VA_ARGS__}) /\
	 sizeof(const struct uverbs_attr_def *))
#define _UVERBS_METHOD(_id, _handler, _flags, ...)			\
	((const struct uverbs_method_def) {				\
	 .id = _id,							\
	 .flags = _flags,						\
	 .handler = _handler,						\
	 .num_attrs = _UVERBS_METHOD_ATTRS_SZ(__VA_ARGS__),		\
	 .attrs = &(const struct uverbs_attr_def * const []){__VA_ARGS__} })
#define DECLARE_UVERBS_METHOD(_name, _id, _handler, ...)		\
	const struct uverbs_method_def _name =				\
		_UVERBS_METHOD(_id, _handler, 0, ##__VA_ARGS__)
#define DECLARE_UVERBS_CTX_METHOD(_name, _id, _handler, _flags, ...)	\
	const struct uverbs_method_def _name =				\
		_UVERBS_METHOD(_id, _handler,				\
			       UVERBS_ACTION_FLAG_CREATE_ROOT,		\
			       ##__VA_ARGS__)
#define _UVERBS_OBJECT_METHODS_SZ(...)					\
	(sizeof((const struct uverbs_method_def * const []){__VA_ARGS__}) / \
	 sizeof(const struct uverbs_method_def *))
#define _UVERBS_OBJECT(_id, _type_attrs, ...)				\
	((const struct uverbs_object_def) {				\
	 .id = _id,							\
	 .type_attrs = _type_attrs,					\
	 .num_methods = _UVERBS_OBJECT_METHODS_SZ(__VA_ARGS__),		\
	 .methods = &(const struct uverbs_method_def * const []){__VA_ARGS__} })
#define DECLARE_UVERBS_OBJECT(_name, _id, _type_attrs, ...)		\
	const struct uverbs_object_def _name =				\
		_UVERBS_OBJECT(_id, _type_attrs, ##__VA_ARGS__)
#define _UVERBS_TREE_OBJECTS_SZ(...)					\
	(sizeof((const struct uverbs_object_def * const []){__VA_ARGS__}) / \
	 sizeof(const struct uverbs_object_def *))
#define _UVERBS_OBJECT_TREE(...)					\
	((const struct uverbs_object_tree_def) {			\
	 .num_objects = _UVERBS_TREE_OBJECTS_SZ(__VA_ARGS__),		\
	 .objects = &(const struct uverbs_object_def * const []){__VA_ARGS__} })
#define DECLARE_UVERBS_OBJECT_TREE(_name, ...)				\
	const struct uverbs_object_tree_def _name =			\
		_UVERBS_OBJECT_TREE(__VA_ARGS__)

/* =================================================
 *              Parsing infrastructure
 * =================================================
 */

struct uverbs_ptr_attr {
	union {
		u64		data;
		void	__user *ptr;
	};
	u16		len;
	/* Combination of bits from enum UVERBS_ATTR_F_XXXX */
	u16		flags;
};

struct uverbs_obj_attr {
	/* pointer to the kernel descriptor -> type, access, etc */
	const struct uverbs_obj_type	*type;
	struct ib_uobject		*uobject;
	/* fd or id in idr of this object */
	int				id;
};

struct uverbs_attr {
	/*
	 * pointer to the user-space given attribute, in order to write the
	 * new uobject's id or update flags.
	 */
	struct ib_uverbs_attr __user	*uattr;
	union {
		struct uverbs_ptr_attr	ptr_attr;
		struct uverbs_obj_attr	obj_attr;
	};
};

struct uverbs_attr_bundle_hash {
	/* if bit i is set, it means attrs[i] contains valid information */
	unsigned long *valid_bitmap;
	size_t num_attrs;
	/*
	 * arrays of attributes, each element corresponds to the specification
	 * of the attribute in the same index.
	 */
	struct uverbs_attr *attrs;
};

struct uverbs_attr_bundle {
	size_t				num_buckets;
	struct uverbs_attr_bundle_hash  hash[];
};

static inline bool uverbs_attr_is_valid_in_hash(const struct uverbs_attr_bundle_hash *attrs_hash,
						unsigned int idx)
{
	return test_bit(idx, attrs_hash->valid_bitmap);
}

static inline bool uverbs_attr_is_valid(const struct uverbs_attr_bundle *attrs_bundle,
					unsigned int idx)
{
	u16 idx_bucket = idx >>	UVERBS_ID_NS_SHIFT;

	if (attrs_bundle->num_buckets <= idx_bucket)
		return false;

	return uverbs_attr_is_valid_in_hash(&attrs_bundle->hash[idx_bucket],
					    idx & ~UVERBS_ID_NS_MASK);
}

/* =================================================
 *	 Definitions -> Specs infrastructure
 * =================================================
 */

/*
 * uverbs_alloc_spec_tree - Merges different common and driver specific feature
 *	into one parsing tree that every uverbs command will be parsed upon.
 *
 * @num_trees: Number of trees in the array @trees.
 * @trees: Array of pointers to tree root definitions to merge. Each such tree
 *	   possibly contains objects, methods and attributes definitions.
 *
 * Returns:
 *	uverbs_root_spec *: The root of the merged parsing tree.
 *	On error, we return an error code. Error is checked via IS_ERR.
 *
 * The following merges could take place:
 * a. Two trees representing the same method with different handler
 *	-> We take the handler of the tree that its handler != NULL
 *	   and its index in the trees array is greater. The incentive for that
 *	   is that developers are expected to first merge common trees and then
 *	   merge trees that gives specialized the behaviour.
 * b. Two trees representing the same object with different
 *    type_attrs (struct uverbs_obj_type):
 *	-> We take the type_attrs of the tree that its type_attr != NULL
 *	   and its index in the trees array is greater. This could be used
 *	   in order to override the free function, allocation size, etc.
 * c. Two trees representing the same method attribute (same id but possibly
 *    different attributes):
 *	-> ERROR (-ENOENT), we believe that's not the programmer's intent.
 *
 * An object without any methods is considered invalid and will abort the
 * function with -ENOENT error.
 */
struct uverbs_root_spec *uverbs_alloc_spec_tree(unsigned int num_trees,
						const struct uverbs_object_tree_def **trees);
void uverbs_free_spec_tree(struct uverbs_root_spec *root);

#endif
Commit	Line	Data
a0aa309c MB	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_IOCTL_
	34	#define _UVERBS_IOCTL_
	35
	36	#include <rdma/uverbs_types.h>
35410306 MB	37	#include <linux/uaccess.h>
35410306 MB	38	#include <rdma/rdma_user_ioctl.h>
a0aa309c MB	39
	40	/*
	41	* =======================================
	42	* Verbs action specifications
	43	* =======================================
	44	*/
	45
f43dbebf MB	46	enum uverbs_attr_type {
f43dbebf MB	47	UVERBS_ATTR_TYPE_NA,
fac9658c MB	48	UVERBS_ATTR_TYPE_PTR_IN,
fac9658c MB	49	UVERBS_ATTR_TYPE_PTR_OUT,
f43dbebf MB	50	UVERBS_ATTR_TYPE_IDR,
	51	UVERBS_ATTR_TYPE_FD,
	52	};
	53
a0aa309c MB	54	enum uverbs_obj_access {
	55	UVERBS_ACCESS_READ,
	56	UVERBS_ACCESS_WRITE,
	57	UVERBS_ACCESS_NEW,
	58	UVERBS_ACCESS_DESTROY
	59	};
	60
fac9658c MB	61	enum {
	62	UVERBS_ATTR_SPEC_F_MANDATORY = 1U << 0,
	63	/* Support extending attributes by length */
	64	UVERBS_ATTR_SPEC_F_MIN_SZ = 1U << 1,
	65	};
	66
f43dbebf MB	67	struct uverbs_attr_spec {
f43dbebf MB	68	enum uverbs_attr_type type;
fac9658c MB	69	union {
	70	u16 len;
	71	struct {
	72	/*
	73	* higher bits mean the namespace and lower bits mean
	74	* the type id within the namespace.
	75	*/
	76	u16 obj_type;
	77	u8 access;
	78	} obj;
	79	};
	80	/* Combination of bits from enum UVERBS_ATTR_SPEC_F_XXXX */
	81	u8 flags;
f43dbebf MB	82	};
	83
	84	struct uverbs_attr_spec_hash {
	85	size_t num_attrs;
fac9658c	86	unsigned long *mandatory_attrs_bitmask;
f43dbebf MB	87	struct uverbs_attr_spec attrs[0];
	88	};
	89
fac9658c MB	90	struct uverbs_attr_bundle;
	91	struct ib_uverbs_file;
	92
	93	enum {
	94	/*
	95	* Action marked with this flag creates a context (or root for all
	96	* objects).
	97	*/
	98	UVERBS_ACTION_FLAG_CREATE_ROOT = 1U << 0,
	99	};
	100
	101	struct uverbs_method_spec {
	102	/* Combination of bits from enum UVERBS_ACTION_FLAG_XXXX */
	103	u32 flags;
	104	size_t num_buckets;
	105	size_t num_child_attrs;
	106	int (handler)(struct ib_device ib_dev, struct ib_uverbs_file *ufile,
	107	struct uverbs_attr_bundle *ctx);
	108	struct uverbs_attr_spec_hash *attr_buckets[0];
	109	};
	110
	111	struct uverbs_method_spec_hash {
	112	size_t num_methods;
	113	struct uverbs_method_spec *methods[0];
	114	};
	115
	116	struct uverbs_object_spec {
	117	const struct uverbs_obj_type *type_attrs;
	118	size_t num_buckets;
	119	struct uverbs_method_spec_hash *method_buckets[0];
	120	};
	121
	122	struct uverbs_object_spec_hash {
	123	size_t num_objects;
	124	struct uverbs_object_spec *objects[0];
	125	};
	126
	127	struct uverbs_root_spec {
	128	size_t num_buckets;
	129	struct uverbs_object_spec_hash *object_buckets[0];
	130	};
	131
5009010f MB	132	/*
	133	* =======================================
	134	* Verbs definitions
	135	* =======================================
	136	*/
	137
09e3ebf8 MB	138	struct uverbs_attr_def {
	139	u16 id;
	140	struct uverbs_attr_spec attr;
	141	};
	142
	143	struct uverbs_method_def {
	144	u16 id;
	145	/* Combination of bits from enum UVERBS_ACTION_FLAG_XXXX */
	146	u32 flags;
	147	size_t num_attrs;
	148	const struct uverbs_attr_def * const (*attrs)[];
	149	int (handler)(struct ib_device ib_dev, struct ib_uverbs_file *ufile,
	150	struct uverbs_attr_bundle *ctx);
	151	};
	152
5009010f	153	struct uverbs_object_def {
09e3ebf8	154	u16 id;
5009010f	155	const struct uverbs_obj_type *type_attrs;
09e3ebf8 MB	156	size_t num_methods;
	157	const struct uverbs_method_def * const (*methods)[];
	158	};
	159
	160	struct uverbs_object_tree_def {
	161	size_t num_objects;
	162	const struct uverbs_object_def * const (*objects)[];
5009010f MB	163	};
5009010f MB	164
35410306 MB	165	#define UA_FLAGS(_flags) .flags = _flags
	166	#define __UVERBS_ATTR0(_id, _len, _type, ...) \
	167	((const struct uverbs_attr_def) \
	168	{.id = _id, .attr = {.type = _type, {.len = _len}, .flags = 0, } })
	169	#define __UVERBS_ATTR1(_id, _len, _type, _flags) \
	170	((const struct uverbs_attr_def) \
	171	{.id = _id, .attr = {.type = _type, {.len = _len}, _flags, } })
	172	#define __UVERBS_ATTR(_id, _len, _type, _flags, _n, ...) \
	173	__UVERBS_ATTR##_n(_id, _len, _type, _flags)
	174	/*
	175	* In new compiler, UVERBS_ATTR could be simplified by declaring it as
	176	* [_id] = {.type = _type, .len = _len, ##__VA_ARGS__}
	177	* But since we support older compilers too, we need the more complex code.
	178	*/
	179	#define UVERBS_ATTR(_id, _len, _type, ...) \
	180	__UVERBS_ATTR(_id, _len, _type, ##__VA_ARGS__, 1, 0)
	181	#define UVERBS_ATTR_PTR_IN_SZ(_id, _len, ...) \
	182	UVERBS_ATTR(_id, _len, UVERBS_ATTR_TYPE_PTR_IN, ##__VA_ARGS__)
	183	/* If sizeof(_type) <= sizeof(u64), this will be inlined rather than a pointer */
	184	#define UVERBS_ATTR_PTR_IN(_id, _type, ...) \
	185	UVERBS_ATTR_PTR_IN_SZ(_id, sizeof(_type), ##__VA_ARGS__)
	186	#define UVERBS_ATTR_PTR_OUT_SZ(_id, _len, ...) \
	187	UVERBS_ATTR(_id, _len, UVERBS_ATTR_TYPE_PTR_OUT, ##__VA_ARGS__)
	188	#define UVERBS_ATTR_PTR_OUT(_id, _type, ...) \
	189	UVERBS_ATTR_PTR_OUT_SZ(_id, sizeof(_type), ##__VA_ARGS__)
	190
	191	/*
	192	* In new compiler, UVERBS_ATTR_IDR (and FD) could be simplified by declaring
	193	* it as
	194	* {.id = _id, \
	195	* .attr {.type = __obj_class, \
	196	* .obj = {.obj_type = _idr_type, \
	197	* .access = _access \
	198	* }, ##__VA_ARGS__ } }
	199	* But since we support older compilers too, we need the more complex code.
	200	*/
	201	#define ___UVERBS_ATTR_OBJ0(_id, _obj_class, _obj_type, _access, ...)\
	202	((const struct uverbs_attr_def) \
	203	{.id = _id, \
	204	.attr = {.type = _obj_class, \
	205	{.obj = {.obj_type = _obj_type, .access = _access } },\
	206	.flags = 0} })
	207	#define ___UVERBS_ATTR_OBJ1(_id, _obj_class, _obj_type, _access, _flags)\
	208	((const struct uverbs_attr_def) \
	209	{.id = _id, \
	210	.attr = {.type = _obj_class, \
	211	{.obj = {.obj_type = _obj_type, .access = _access} }, \
	212	_flags} })
	213	#define ___UVERBS_ATTR_OBJ(_id, _obj_class, _obj_type, _access, _flags, \
	214	_n, ...) \
	215	___UVERBS_ATTR_OBJ##_n(_id, _obj_class, _obj_type, _access, _flags)
	216	#define __UVERBS_ATTR_OBJ(_id, _obj_class, _obj_type, _access, ...) \
	217	___UVERBS_ATTR_OBJ(_id, _obj_class, _obj_type, _access, \
	218	##__VA_ARGS__, 1, 0)
	219	#define UVERBS_ATTR_IDR(_id, _idr_type, _access, ...) \
	220	__UVERBS_ATTR_OBJ(_id, UVERBS_ATTR_TYPE_IDR, _idr_type, _access,\
	221	##__VA_ARGS__)
	222	#define UVERBS_ATTR_FD(_id, _fd_type, _access, ...) \
	223	__UVERBS_ATTR_OBJ(_id, UVERBS_ATTR_TYPE_FD, _fd_type, \
	224	(_access) + BUILD_BUG_ON_ZERO( \
	225	(_access) != UVERBS_ACCESS_NEW && \
	226	(_access) != UVERBS_ACCESS_READ), \
	227	##__VA_ARGS__)
	228	#define DECLARE_UVERBS_ATTR_SPEC(_name, ...) \
229	const struct uverbs_attr_def _name = __VA_ARGS__
230
231	#define _UVERBS_METHOD_ATTRS_SZ(...) \
232	(sizeof((const struct uverbs_attr_def * const []){__VA_ARGS__}) /\
233	sizeof(const struct uverbs_attr_def *))
234	#define _UVERBS_METHOD(_id, _handler, _flags, ...) \
235	((const struct uverbs_method_def) { \
236	.id = _id, \
237	.flags = _flags, \
238	.handler = _handler, \
239	.num_attrs = _UVERBS_METHOD_ATTRS_SZ(__VA_ARGS__), \
240	.attrs = &(const struct uverbs_attr_def * const []){__VA_ARGS__} })
241	#define DECLARE_UVERBS_METHOD(_name, _id, _handler, ...) \
242	const struct uverbs_method_def _name = \
243	_UVERBS_METHOD(_id, _handler, 0, ##__VA_ARGS__)
244	#define DECLARE_UVERBS_CTX_METHOD(_name, _id, _handler, _flags, ...) \
245	const struct uverbs_method_def _name = \
246	_UVERBS_METHOD(_id, _handler, \
247	UVERBS_ACTION_FLAG_CREATE_ROOT, \
248	##__VA_ARGS__)
249	#define _UVERBS_OBJECT_METHODS_SZ(...) \
250	(sizeof((const struct uverbs_method_def * const []){__VA_ARGS__}) / \
251	sizeof(const struct uverbs_method_def *))
5009010f MB	252	#define _UVERBS_OBJECT(_id, _type_attrs, ...) \
5009010f MB	253	((const struct uverbs_object_def) { \
09e3ebf8	254	.id = _id, \
35410306 MB	255	.type_attrs = _type_attrs, \
	256	.num_methods = _UVERBS_OBJECT_METHODS_SZ(__VA_ARGS__), \
	257	.methods = &(const struct uverbs_method_def * const []){__VA_ARGS__} })
5009010f MB	258	#define DECLARE_UVERBS_OBJECT(_name, _id, _type_attrs, ...) \
	259	const struct uverbs_object_def _name = \
	260	_UVERBS_OBJECT(_id, _type_attrs, ##__VA_ARGS__)
09e3ebf8 MB	261	#define _UVERBS_TREE_OBJECTS_SZ(...) \
	262	(sizeof((const struct uverbs_object_def * const []){__VA_ARGS__}) / \
	263	sizeof(const struct uverbs_object_def *))
	264	#define _UVERBS_OBJECT_TREE(...) \
	265	((const struct uverbs_object_tree_def) { \
	266	.num_objects = _UVERBS_TREE_OBJECTS_SZ(__VA_ARGS__), \
	267	.objects = &(const struct uverbs_object_def * const []){__VA_ARGS__} })
	268	#define DECLARE_UVERBS_OBJECT_TREE(_name, ...) \
	269	const struct uverbs_object_tree_def _name = \
	270	_UVERBS_OBJECT_TREE(__VA_ARGS__)
	271
fac9658c MB	272	/* =================================================
	273	* Parsing infrastructure
	274	* =================================================
	275	*/
	276
	277	struct uverbs_ptr_attr {
	278	union {
	279	u64 data;
	280	void __user *ptr;
	281	};
	282	u16 len;
	283	/* Combination of bits from enum UVERBS_ATTR_F_XXXX */
	284	u16 flags;
	285	};
	286
f43dbebf	287	struct uverbs_obj_attr {
fac9658c MB	288	/* pointer to the kernel descriptor -> type, access, etc */
fac9658c MB	289	const struct uverbs_obj_type *type;
f43dbebf	290	struct ib_uobject *uobject;
fac9658c MB	291	/* fd or id in idr of this object */
fac9658c MB	292	int id;
f43dbebf MB	293	};
	294
	295	struct uverbs_attr {
fac9658c MB	296	/*
	297	* pointer to the user-space given attribute, in order to write the
	298	* new uobject's id or update flags.
	299	*/
	300	struct ib_uverbs_attr __user *uattr;
	301	union {
	302	struct uverbs_ptr_attr ptr_attr;
	303	struct uverbs_obj_attr obj_attr;
	304	};
f43dbebf MB	305	};
	306
	307	struct uverbs_attr_bundle_hash {
	308	/* if bit i is set, it means attrs[i] contains valid information */
	309	unsigned long *valid_bitmap;
	310	size_t num_attrs;
	311	/*
	312	* arrays of attributes, each element corresponds to the specification
	313	* of the attribute in the same index.
	314	*/
	315	struct uverbs_attr *attrs;
	316	};
	317
	318	struct uverbs_attr_bundle {
	319	size_t num_buckets;
	320	struct uverbs_attr_bundle_hash hash[];
	321	};
	322
	323	static inline bool uverbs_attr_is_valid_in_hash(const struct uverbs_attr_bundle_hash *attrs_hash,
	324	unsigned int idx)
	325	{
	326	return test_bit(idx, attrs_hash->valid_bitmap);
	327	}
	328
35410306 MB	329	static inline bool uverbs_attr_is_valid(const struct uverbs_attr_bundle *attrs_bundle,
	330	unsigned int idx)
	331	{
	332	u16 idx_bucket = idx >> UVERBS_ID_NS_SHIFT;
	333
	334	if (attrs_bundle->num_buckets <= idx_bucket)
	335	return false;
	336
	337	return uverbs_attr_is_valid_in_hash(&attrs_bundle->hash[idx_bucket],
	338	idx & ~UVERBS_ID_NS_MASK);
	339	}
	340
118620d3 MB	341	/* =================================================
	342	* Definitions -> Specs infrastructure
	343	* =================================================
	344	*/
	345
	346	/*
	347	* uverbs_alloc_spec_tree - Merges different common and driver specific feature
	348	* into one parsing tree that every uverbs command will be parsed upon.
	349	*
	350	* @num_trees: Number of trees in the array @trees.
	351	* @trees: Array of pointers to tree root definitions to merge. Each such tree
	352	* possibly contains objects, methods and attributes definitions.
	353	*
	354	* Returns:
	355	* uverbs_root_spec *: The root of the merged parsing tree.
	356	* On error, we return an error code. Error is checked via IS_ERR.
	357	*
	358	* The following merges could take place:
	359	* a. Two trees representing the same method with different handler
	360	* -> We take the handler of the tree that its handler != NULL
	361	* and its index in the trees array is greater. The incentive for that
	362	* is that developers are expected to first merge common trees and then
	363	* merge trees that gives specialized the behaviour.
	364	* b. Two trees representing the same object with different
	365	* type_attrs (struct uverbs_obj_type):
	366	* -> We take the type_attrs of the tree that its type_attr != NULL
	367	* and its index in the trees array is greater. This could be used
	368	* in order to override the free function, allocation size, etc.
	369	* c. Two trees representing the same method attribute (same id but possibly
	370	* different attributes):
	371	* -> ERROR (-ENOENT), we believe that's not the programmer's intent.
	372	*
	373	* An object without any methods is considered invalid and will abort the
	374	* function with -ENOENT error.
	375	*/
	376	struct uverbs_root_spec *uverbs_alloc_spec_tree(unsigned int num_trees,
	377	const struct uverbs_object_tree_def **trees);
	378	void uverbs_free_spec_tree(struct uverbs_root_spec *root);
a0aa309c	379
118620d3	380	#endif