[linux.git] / include / rdma / uverbs_named_ioctl.h

/* SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB */
/*
 * Copyright (c) 2018, Mellanox Technologies inc.  All rights reserved.
 */

#ifndef _UVERBS_NAMED_IOCTL_
#define _UVERBS_NAMED_IOCTL_

#include <rdma/uverbs_ioctl.h>

#ifndef UVERBS_MODULE_NAME
#error "Please #define UVERBS_MODULE_NAME before including rdma/uverbs_named_ioctl.h"
#endif

#define _UVERBS_PASTE(x, y)	x ## y
#define _UVERBS_NAME(x, y)	_UVERBS_PASTE(x, y)
#define UVERBS_METHOD(id)	_UVERBS_NAME(UVERBS_MODULE_NAME, _method_##id)
#define UVERBS_HANDLER(id)	_UVERBS_NAME(UVERBS_MODULE_NAME, _handler_##id)
#define UVERBS_OBJECT(id)	_UVERBS_NAME(UVERBS_MODULE_NAME, _object_##id)

/* These are static so they do not need to be qualified */
#define UVERBS_METHOD_ATTRS(method_id) _method_attrs_##method_id
#define UVERBS_OBJECT_METHODS(object_id) _UVERBS_NAME(_object_methods_##object_id, __LINE__)

#define DECLARE_UVERBS_NAMED_METHOD(_method_id, ...)                           \
	static const struct uverbs_attr_def *const UVERBS_METHOD_ATTRS(        \
		_method_id)[] = { __VA_ARGS__ };                               \
	static const struct uverbs_method_def UVERBS_METHOD(_method_id) = {    \
		.id = _method_id,                                              \
		.handler = UVERBS_HANDLER(_method_id),                         \
		.num_attrs = ARRAY_SIZE(UVERBS_METHOD_ATTRS(_method_id)),      \
		.attrs = &UVERBS_METHOD_ATTRS(_method_id),                     \
	}

/* Create a standard destroy method using the default handler. The handle_attr
 * argument must be the attribute specifying the handle to destroy, the
 * default handler does not support any other attributes.
 */
#define DECLARE_UVERBS_NAMED_METHOD_DESTROY(_method_id, _handle_attr)          \
	static const struct uverbs_attr_def *const UVERBS_METHOD_ATTRS(        \
		_method_id)[] = { _handle_attr };                              \
	static const struct uverbs_method_def UVERBS_METHOD(_method_id) = {    \
		.id = _method_id,                                              \
		.handler = uverbs_destroy_def_handler,                         \
		.num_attrs = ARRAY_SIZE(UVERBS_METHOD_ATTRS(_method_id)),      \
		.attrs = &UVERBS_METHOD_ATTRS(_method_id),                     \
	}

#define DECLARE_UVERBS_NAMED_OBJECT(_object_id, _type_attrs, ...)              \
	static const struct uverbs_method_def *const UVERBS_OBJECT_METHODS(    \
		_object_id)[] = { __VA_ARGS__ };                               \
	static const struct uverbs_object_def UVERBS_OBJECT(_object_id) = {    \
		.id = _object_id,                                              \
		.type_attrs = &_type_attrs,                                    \
		.num_methods = ARRAY_SIZE(UVERBS_OBJECT_METHODS(_object_id)),  \
		.methods = &UVERBS_OBJECT_METHODS(_object_id)                  \
	}

/*
 * Declare global methods. These still have a unique object_id because we
 * identify all uapi methods with a (object,method) tuple. However, they have
 * no type pointer.
 */
#define DECLARE_UVERBS_GLOBAL_METHODS(_object_id, ...)                         \
	static const struct uverbs_method_def *const UVERBS_OBJECT_METHODS(    \
		_object_id)[] = { __VA_ARGS__ };                               \
	static const struct uverbs_object_def UVERBS_OBJECT(_object_id) = {    \
		.id = _object_id,                                              \
		.num_methods = ARRAY_SIZE(UVERBS_OBJECT_METHODS(_object_id)),  \
		.methods = &UVERBS_OBJECT_METHODS(_object_id)                  \
	}

/* Used by drivers to declare a complete parsing tree for new methods
 */
#define ADD_UVERBS_METHODS(_name, _object_id, ...)                             \
	static const struct uverbs_method_def *const UVERBS_OBJECT_METHODS(    \
		_object_id)[] = { __VA_ARGS__ };                               \
	static const struct uverbs_object_def _name = {                        \
		.id = _object_id,                                              \
		.num_methods = ARRAY_SIZE(UVERBS_OBJECT_METHODS(_object_id)),  \
		.methods = &UVERBS_OBJECT_METHODS(_object_id)                  \
	};

/* Used by drivers to declare a complete parsing tree for a single method that
 * differs only in having additional driver specific attributes.
 */
#define ADD_UVERBS_ATTRIBUTES_SIMPLE(_name, _object_id, _method_id, ...)       \
	static const struct uverbs_attr_def *const UVERBS_METHOD_ATTRS(        \
		_method_id)[] = { __VA_ARGS__ };                               \
	static const struct uverbs_method_def UVERBS_METHOD(_method_id) = {    \
		.id = _method_id,                                              \
		.num_attrs = ARRAY_SIZE(UVERBS_METHOD_ATTRS(_method_id)),      \
		.attrs = &UVERBS_METHOD_ATTRS(_method_id),                     \
	};                                                                     \
	ADD_UVERBS_METHODS(_name, _object_id, &UVERBS_METHOD(_method_id))

#endif
Commit	Line	Data
6bf9d8f6	1	/* SPDX-License-Identifier: GPL-2.0 OR Linux-OpenIB */
1f7ff9d5 MB	2	/*
1f7ff9d5 MB	3	* Copyright (c) 2018, Mellanox Technologies inc. All rights reserved.
1f7ff9d5 MB	4	*/
	5
	6	#ifndef _UVERBS_NAMED_IOCTL_
	7	#define _UVERBS_NAMED_IOCTL_
	8
	9	#include <rdma/uverbs_ioctl.h>
	10
	11	#ifndef UVERBS_MODULE_NAME
	12	#error "Please #define UVERBS_MODULE_NAME before including rdma/uverbs_named_ioctl.h"
	13	#endif
	14
	15	#define _UVERBS_PASTE(x, y) x ## y
	16	#define _UVERBS_NAME(x, y) _UVERBS_PASTE(x, y)
	17	#define UVERBS_METHOD(id) _UVERBS_NAME(UVERBS_MODULE_NAME, _method_##id)
	18	#define UVERBS_HANDLER(id) _UVERBS_NAME(UVERBS_MODULE_NAME, _handler_##id)
c471de14	19	#define UVERBS_OBJECT(id) _UVERBS_NAME(UVERBS_MODULE_NAME, _object_##id)
1f7ff9d5	20
6c61d2a5 JG	21	/* These are static so they do not need to be qualified */
6c61d2a5 JG	22	#define UVERBS_METHOD_ATTRS(method_id) _method_attrs_##method_id
7ca2b8a3	23	#define UVERBS_OBJECT_METHODS(object_id) _UVERBS_NAME(_object_methods_##object_id, __LINE__)
1f7ff9d5	24
595c7736 JG	25	#define DECLARE_UVERBS_NAMED_METHOD(_method_id, ...) \
	26	static const struct uverbs_attr_def *const UVERBS_METHOD_ATTRS( \
	27	_method_id)[] = { __VA_ARGS__ }; \
	28	static const struct uverbs_method_def UVERBS_METHOD(_method_id) = { \
	29	.id = _method_id, \
	30	.handler = UVERBS_HANDLER(_method_id), \
	31	.num_attrs = ARRAY_SIZE(UVERBS_METHOD_ATTRS(_method_id)), \
	32	.attrs = &UVERBS_METHOD_ATTRS(_method_id), \
	33	}
1f7ff9d5	34
595c7736 JG	35	/* Create a standard destroy method using the default handler. The handle_attr
	36	* argument must be the attribute specifying the handle to destroy, the
	37	* default handler does not support any other attributes.
	38	*/
	39	#define DECLARE_UVERBS_NAMED_METHOD_DESTROY(_method_id, _handle_attr) \
	40	static const struct uverbs_attr_def *const UVERBS_METHOD_ATTRS( \
	41	_method_id)[] = { _handle_attr }; \
	42	static const struct uverbs_method_def UVERBS_METHOD(_method_id) = { \
	43	.id = _method_id, \
	44	.handler = uverbs_destroy_def_handler, \
	45	.num_attrs = ARRAY_SIZE(UVERBS_METHOD_ATTRS(_method_id)), \
	46	.attrs = &UVERBS_METHOD_ATTRS(_method_id), \
	47	}
1f7ff9d5	48
6c61d2a5 JG	49	#define DECLARE_UVERBS_NAMED_OBJECT(_object_id, _type_attrs, ...) \
	50	static const struct uverbs_method_def *const UVERBS_OBJECT_METHODS( \
	51	_object_id)[] = { __VA_ARGS__ }; \
8889f6fa	52	static const struct uverbs_object_def UVERBS_OBJECT(_object_id) = { \
6c61d2a5	53	.id = _object_id, \
9a119cd5	54	.type_attrs = &_type_attrs, \
6c61d2a5 JG	55	.num_methods = ARRAY_SIZE(UVERBS_OBJECT_METHODS(_object_id)), \
	56	.methods = &UVERBS_OBJECT_METHODS(_object_id) \
	57	}
1f7ff9d5	58
9a119cd5 JG	59	/*
	60	* Declare global methods. These still have a unique object_id because we
	61	* identify all uapi methods with a (object,method) tuple. However, they have
	62	* no type pointer.
	63	*/
8889f6fa	64	#define DECLARE_UVERBS_GLOBAL_METHODS(_object_id, ...) \
9a119cd5 JG	65	static const struct uverbs_method_def *const UVERBS_OBJECT_METHODS( \
9a119cd5 JG	66	_object_id)[] = { __VA_ARGS__ }; \
8889f6fa	67	static const struct uverbs_object_def UVERBS_OBJECT(_object_id) = { \
9a119cd5 JG	68	.id = _object_id, \
	69	.num_methods = ARRAY_SIZE(UVERBS_OBJECT_METHODS(_object_id)), \
	70	.methods = &UVERBS_OBJECT_METHODS(_object_id) \
	71	}
e502a864	72
32269441	73	/* Used by drivers to declare a complete parsing tree for new methods
3d64addd	74	*/
32269441	75	#define ADD_UVERBS_METHODS(_name, _object_id, ...) \
6c61d2a5	76	static const struct uverbs_method_def *const UVERBS_OBJECT_METHODS( \
32269441	77	_object_id)[] = { __VA_ARGS__ }; \
0cbf432d	78	static const struct uverbs_object_def _name = { \
6c61d2a5	79	.id = _object_id, \
32269441	80	.num_methods = ARRAY_SIZE(UVERBS_OBJECT_METHODS(_object_id)), \
6c61d2a5	81	.methods = &UVERBS_OBJECT_METHODS(_object_id) \
0cbf432d	82	};
3d64addd	83
32269441 YH	84	/* Used by drivers to declare a complete parsing tree for a single method that
	85	* differs only in having additional driver specific attributes.
	86	*/
	87	#define ADD_UVERBS_ATTRIBUTES_SIMPLE(_name, _object_id, _method_id, ...) \
	88	static const struct uverbs_attr_def *const UVERBS_METHOD_ATTRS( \
	89	_method_id)[] = { __VA_ARGS__ }; \
	90	static const struct uverbs_method_def UVERBS_METHOD(_method_id) = { \
	91	.id = _method_id, \
	92	.num_attrs = ARRAY_SIZE(UVERBS_METHOD_ATTRS(_method_id)), \
	93	.attrs = &UVERBS_METHOD_ATTRS(_method_id), \
	94	}; \
	95	ADD_UVERBS_METHODS(_name, _object_id, &UVERBS_METHOD(_method_id))
	96
1f7ff9d5	97	#endif