[linux-2.6-block.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>
#include <rdma/ib_user_ioctl_verbs.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 {
	u64		data;
	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);
}

static inline const struct uverbs_attr *uverbs_attr_get(const struct uverbs_attr_bundle *attrs_bundle,
							u16 idx)
{
	u16 idx_bucket = idx >>	UVERBS_ID_NS_SHIFT;

	if (!uverbs_attr_is_valid(attrs_bundle, idx))
		return ERR_PTR(-ENOENT);

	return &attrs_bundle->hash[idx_bucket].attrs[idx & ~UVERBS_ID_NS_MASK];
}

static inline int uverbs_copy_to(const struct uverbs_attr_bundle *attrs_bundle,
				 size_t idx, const void *from, size_t size)
{
	const struct uverbs_attr *attr = uverbs_attr_get(attrs_bundle, idx);
	u16 flags;
	size_t min_size;

	if (IS_ERR(attr))
		return PTR_ERR(attr);

	min_size = min_t(size_t, attr->ptr_attr.len, size);
	if (copy_to_user(u64_to_user_ptr(attr->ptr_attr.data), from, min_size))
		return -EFAULT;

	flags = attr->ptr_attr.flags | UVERBS_ATTR_F_VALID_OUTPUT;
	if (put_user(flags, &attr->uattr->flags))
		return -EFAULT;

	return 0;
}

static inline bool uverbs_attr_ptr_is_inline(const struct uverbs_attr *attr)
{
	return attr->ptr_attr.len <= sizeof(attr->ptr_attr.data);
}

static inline int _uverbs_copy_from(void *to,
				    const struct uverbs_attr_bundle *attrs_bundle,
				    size_t idx,
				    size_t size)
{
	const struct uverbs_attr *attr = uverbs_attr_get(attrs_bundle, idx);

	if (IS_ERR(attr))
		return PTR_ERR(attr);

	/*
	 * Validation ensures attr->ptr_attr.len >= size. If the caller is
	 * using UVERBS_ATTR_SPEC_F_MIN_SZ then it must call copy_from with
	 * the right size.
	 */
	if (unlikely(size < attr->ptr_attr.len))
		return -EINVAL;

	if (uverbs_attr_ptr_is_inline(attr))
		memcpy(to, &attr->ptr_attr.data, attr->ptr_attr.len);
	else if (copy_from_user(to, u64_to_user_ptr(attr->ptr_attr.data),
				attr->ptr_attr.len))
		return -EFAULT;

	return 0;
}

#define uverbs_copy_from(to, attrs_bundle, idx)				      \
	_uverbs_copy_from(to, attrs_bundle, idx, sizeof(*to))

/* =================================================
 *	 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.
 */
#if IS_ENABLED(CONFIG_INFINIBAND_USER_ACCESS)
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);
#else
static inline struct uverbs_root_spec *uverbs_alloc_spec_tree(unsigned int num_trees,
							      const struct uverbs_object_tree_def **trees)
{
	return NULL;
}

static inline void uverbs_free_spec_tree(struct uverbs_root_spec *root)
{
}
#endif

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