[deliverable/linux.git] / include / linux / genl_magic_struct.h

#ifndef GENL_MAGIC_STRUCT_H
#define GENL_MAGIC_STRUCT_H

#ifndef GENL_MAGIC_FAMILY
# error "you need to define GENL_MAGIC_FAMILY before inclusion"
#endif

#ifndef GENL_MAGIC_VERSION
# error "you need to define GENL_MAGIC_VERSION before inclusion"
#endif

#ifndef GENL_MAGIC_INCLUDE_FILE
# error "you need to define GENL_MAGIC_INCLUDE_FILE before inclusion"
#endif

#include <linux/genetlink.h>
#include <linux/types.h>

#define CONCAT__(a,b)	a ## b
#define CONCAT_(a,b)	CONCAT__(a,b)

extern int CONCAT_(GENL_MAGIC_FAMILY, _genl_register)(void);
extern void CONCAT_(GENL_MAGIC_FAMILY, _genl_unregister)(void);

/*
 * Extension of genl attribute validation policies			{{{2
 */

/*
 * @DRBD_GENLA_F_MANDATORY: By default, netlink ignores attributes it does not
 * know about.  This flag can be set in nlattr->nla_type to indicate that this
 * attribute must not be ignored.
 *
 * We check and remove this flag in drbd_nla_check_mandatory() before
 * validating the attribute types and lengths via nla_parse_nested().
 */
#define DRBD_GENLA_F_MANDATORY (1 << 14)

/*
 * Flags specific to drbd and not visible at the netlink layer, used in
 * <struct>_from_attrs and <struct>_to_skb:
 *
 * @DRBD_F_REQUIRED: Attribute is required; a request without this attribute is
 * invalid.
 *
 * @DRBD_F_SENSITIVE: Attribute includes sensitive information and must not be
 * included in unpriviledged get requests or broadcasts.
 *
 * @DRBD_F_INVARIANT: Attribute is set when an object is initially created, but
 * cannot subsequently be changed.
 */
#define DRBD_F_REQUIRED (1 << 0)
#define DRBD_F_SENSITIVE (1 << 1)
#define DRBD_F_INVARIANT (1 << 2)

#define __nla_type(x)	((__u16)((x) & NLA_TYPE_MASK & ~DRBD_GENLA_F_MANDATORY))

/*									}}}1
 * MAGIC
 * multi-include macro expansion magic starts here
 */

/* MAGIC helpers							{{{2 */

/* possible field types */
#define __flg_field(attr_nr, attr_flag, name) \
	__field(attr_nr, attr_flag, name, NLA_U8, char, \
			nla_get_u8, nla_put_u8, false)
#define __u8_field(attr_nr, attr_flag, name)	\
	__field(attr_nr, attr_flag, name, NLA_U8, unsigned char, \
			nla_get_u8, nla_put_u8, false)
#define __u16_field(attr_nr, attr_flag, name)	\
	__field(attr_nr, attr_flag, name, NLA_U16, __u16, \
			nla_get_u16, nla_put_u16, false)
#define __u32_field(attr_nr, attr_flag, name)	\
	__field(attr_nr, attr_flag, name, NLA_U32, __u32, \
			nla_get_u32, nla_put_u32, false)
#define __s32_field(attr_nr, attr_flag, name)	\
	__field(attr_nr, attr_flag, name, NLA_U32, __s32, \
			nla_get_u32, nla_put_u32, true)
#define __u64_field(attr_nr, attr_flag, name)	\
	__field(attr_nr, attr_flag, name, NLA_U64, __u64, \
			nla_get_u64, nla_put_u64, false)
#define __str_field(attr_nr, attr_flag, name, maxlen) \
	__array(attr_nr, attr_flag, name, NLA_NUL_STRING, char, maxlen, \
			nla_strlcpy, nla_put, false)
#define __bin_field(attr_nr, attr_flag, name, maxlen) \
	__array(attr_nr, attr_flag, name, NLA_BINARY, char, maxlen, \
			nla_memcpy, nla_put, false)

/* fields with default values */
#define __flg_field_def(attr_nr, attr_flag, name, default) \
	__flg_field(attr_nr, attr_flag, name)
#define __u32_field_def(attr_nr, attr_flag, name, default) \
	__u32_field(attr_nr, attr_flag, name)
#define __s32_field_def(attr_nr, attr_flag, name, default) \
	__s32_field(attr_nr, attr_flag, name)
#define __str_field_def(attr_nr, attr_flag, name, maxlen) \
	__str_field(attr_nr, attr_flag, name, maxlen)

#define GENL_op_init(args...)	args
#define GENL_doit(handler)		\
	.doit = handler,		\
	.flags = GENL_ADMIN_PERM,
#define GENL_dumpit(handler)		\
	.dumpit = handler,		\
	.flags = GENL_ADMIN_PERM,

/*									}}}1
 * Magic: define the enum symbols for genl_ops
 * Magic: define the enum symbols for top level attributes
 * Magic: define the enum symbols for nested attributes
 *									{{{2
 */

#undef GENL_struct
#define GENL_struct(tag_name, tag_number, s_name, s_fields)

#undef GENL_mc_group
#define GENL_mc_group(group)

#undef GENL_notification
#define GENL_notification(op_name, op_num, mcast_group, tla_list)	\
	op_name = op_num,

#undef GENL_op
#define GENL_op(op_name, op_num, handler, tla_list)			\
	op_name = op_num,

enum {
#include GENL_MAGIC_INCLUDE_FILE
};

#undef GENL_notification
#define GENL_notification(op_name, op_num, mcast_group, tla_list)

#undef GENL_op
#define GENL_op(op_name, op_num, handler, attr_list)

#undef GENL_struct
#define GENL_struct(tag_name, tag_number, s_name, s_fields) \
		tag_name = tag_number,

enum {
#include GENL_MAGIC_INCLUDE_FILE
};

#undef GENL_struct
#define GENL_struct(tag_name, tag_number, s_name, s_fields)	\
enum {								\
	s_fields						\
};

#undef __field
#define __field(attr_nr, attr_flag, name, nla_type, type,	\
		__get, __put, __is_signed)			\
	T_ ## name = (__u16)(attr_nr | ((attr_flag) & DRBD_GENLA_F_MANDATORY)),

#undef __array
#define __array(attr_nr, attr_flag, name, nla_type, type,	\
		maxlen, __get, __put, __is_signed)		\
	T_ ## name = (__u16)(attr_nr | ((attr_flag) & DRBD_GENLA_F_MANDATORY)),

#include GENL_MAGIC_INCLUDE_FILE

/*									}}}1
 * Magic: compile time assert unique numbers for operations
 * Magic: -"- unique numbers for top level attributes
 * Magic: -"- unique numbers for nested attributes
 *									{{{2
 */

#undef GENL_struct
#define GENL_struct(tag_name, tag_number, s_name, s_fields)

#undef GENL_op
#define GENL_op(op_name, op_num, handler, attr_list)	\
	case op_name:

#undef GENL_notification
#define GENL_notification(op_name, op_num, mcast_group, tla_list)	\
	case op_name:

static inline void ct_assert_unique_operations(void)
{
	switch (0) {
#include GENL_MAGIC_INCLUDE_FILE
		;
	}
}

#undef GENL_op
#define GENL_op(op_name, op_num, handler, attr_list)

#undef GENL_notification
#define GENL_notification(op_name, op_num, mcast_group, tla_list)

#undef GENL_struct
#define GENL_struct(tag_name, tag_number, s_name, s_fields)		\
		case tag_number:

static inline void ct_assert_unique_top_level_attributes(void)
{
	switch (0) {
#include GENL_MAGIC_INCLUDE_FILE
		;
	}
}

#undef GENL_struct
#define GENL_struct(tag_name, tag_number, s_name, s_fields)		\
static inline void ct_assert_unique_ ## s_name ## _attributes(void)	\
{									\
	switch (0) {							\
		s_fields						\
			;						\
	}								\
}

#undef __field
#define __field(attr_nr, attr_flag, name, nla_type, type, __get, __put,	\
		__is_signed)						\
	case attr_nr:

#undef __array
#define __array(attr_nr, attr_flag, name, nla_type, type, maxlen,	\
		__get, __put, __is_signed)				\
	case attr_nr:

#include GENL_MAGIC_INCLUDE_FILE

/*									}}}1
 * Magic: declare structs
 * struct <name> {
 *	fields
 * };
 *									{{{2
 */

#undef GENL_struct
#define GENL_struct(tag_name, tag_number, s_name, s_fields)		\
struct s_name { s_fields };

#undef __field
#define __field(attr_nr, attr_flag, name, nla_type, type, __get, __put,	\
		__is_signed)						\
	type name;

#undef __array
#define __array(attr_nr, attr_flag, name, nla_type, type, maxlen,	\
		__get, __put, __is_signed)				\
	type name[maxlen];	\
	__u32 name ## _len;

#include GENL_MAGIC_INCLUDE_FILE

#undef GENL_struct
#define GENL_struct(tag_name, tag_number, s_name, s_fields)		\
enum {									\
	s_fields							\
};

#undef __field
#define __field(attr_nr, attr_flag, name, nla_type, type, __get, __put,	\
		is_signed)						\
	F_ ## name ## _IS_SIGNED = is_signed,

#undef __array
#define __array(attr_nr, attr_flag, name, nla_type, type, maxlen,	\
		__get, __put, is_signed)				\
	F_ ## name ## _IS_SIGNED = is_signed,

#include GENL_MAGIC_INCLUDE_FILE

/* }}}1 */
#endif /* GENL_MAGIC_STRUCT_H */
/* vim: set foldmethod=marker nofoldenable : */
Commit	Line	Data
ec2c35ac LE	1	#ifndef GENL_MAGIC_STRUCT_H
	2	#define GENL_MAGIC_STRUCT_H
	3
	4	#ifndef GENL_MAGIC_FAMILY
	5	# error "you need to define GENL_MAGIC_FAMILY before inclusion"
	6	#endif
	7
	8	#ifndef GENL_MAGIC_VERSION
	9	# error "you need to define GENL_MAGIC_VERSION before inclusion"
	10	#endif
	11
	12	#ifndef GENL_MAGIC_INCLUDE_FILE
	13	# error "you need to define GENL_MAGIC_INCLUDE_FILE before inclusion"
	14	#endif
	15
	16	#include <linux/genetlink.h>
	17	#include <linux/types.h>
	18
	19	#define CONCAT__(a,b) a ## b
	20	#define CONCAT_(a,b) CONCAT__(a,b)
	21
	22	extern int CONCAT_(GENL_MAGIC_FAMILY, _genl_register)(void);
	23	extern void CONCAT_(GENL_MAGIC_FAMILY, _genl_unregister)(void);
	24
	25	/*
	26	* Extension of genl attribute validation policies {{{2
	27	*/
	28
5f935920 AG	29	/*
	30	* @DRBD_GENLA_F_MANDATORY: By default, netlink ignores attributes it does not
	31	* know about. This flag can be set in nlattr->nla_type to indicate that this
	32	* attribute must not be ignored.
ec2c35ac	33	*
5f935920 AG	34	* We check and remove this flag in drbd_nla_check_mandatory() before
	35	* validating the attribute types and lengths via nla_parse_nested().
	36	*/
	37	#define DRBD_GENLA_F_MANDATORY (1 << 14)
	38
	39	/*
	40	* Flags specific to drbd and not visible at the netlink layer, used in
	41	* <struct>_from_attrs and <struct>_to_skb:
ec2c35ac	42	*
5f935920 AG	43	* @DRBD_F_REQUIRED: Attribute is required; a request without this attribute is
5f935920 AG	44	* invalid.
ec2c35ac	45	*
5f935920 AG	46	* @DRBD_F_SENSITIVE: Attribute includes sensitive information and must not be
5f935920 AG	47	* included in unpriviledged get requests or broadcasts.
ec2c35ac	48	*
5f935920 AG	49	* @DRBD_F_INVARIANT: Attribute is set when an object is initially created, but
5f935920 AG	50	* cannot subsequently be changed.
ec2c35ac	51	*/
5f935920 AG	52	#define DRBD_F_REQUIRED (1 << 0)
	53	#define DRBD_F_SENSITIVE (1 << 1)
	54	#define DRBD_F_INVARIANT (1 << 2)
ec2c35ac	55
5f935920	56	#define __nla_type(x) ((__u16)((x) & NLA_TYPE_MASK & ~DRBD_GENLA_F_MANDATORY))
ec2c35ac LE	57
	58	/* }}}1
	59	* MAGIC
	60	* multi-include macro expansion magic starts here
	61	*/
	62
	63	/* MAGIC helpers {{{2 */
	64
	65	/* possible field types */
	66	#define __flg_field(attr_nr, attr_flag, name) \
a5d8e1fb	67	__field(attr_nr, attr_flag, name, NLA_U8, char, \
26ec9287	68	nla_get_u8, nla_put_u8, false)
ec2c35ac LE	69	#define __u8_field(attr_nr, attr_flag, name) \
ec2c35ac LE	70	__field(attr_nr, attr_flag, name, NLA_U8, unsigned char, \
26ec9287	71	nla_get_u8, nla_put_u8, false)
ec2c35ac LE	72	#define __u16_field(attr_nr, attr_flag, name) \
ec2c35ac LE	73	__field(attr_nr, attr_flag, name, NLA_U16, __u16, \
26ec9287	74	nla_get_u16, nla_put_u16, false)
ec2c35ac LE	75	#define __u32_field(attr_nr, attr_flag, name) \
ec2c35ac LE	76	__field(attr_nr, attr_flag, name, NLA_U32, __u32, \
26ec9287	77	nla_get_u32, nla_put_u32, false)
563e4cf2 LE	78	#define __s32_field(attr_nr, attr_flag, name) \
563e4cf2 LE	79	__field(attr_nr, attr_flag, name, NLA_U32, __s32, \
26ec9287	80	nla_get_u32, nla_put_u32, true)
ec2c35ac LE	81	#define __u64_field(attr_nr, attr_flag, name) \
ec2c35ac LE	82	__field(attr_nr, attr_flag, name, NLA_U64, __u64, \
26ec9287	83	nla_get_u64, nla_put_u64, false)
ec2c35ac LE	84	#define __str_field(attr_nr, attr_flag, name, maxlen) \
ec2c35ac LE	85	__array(attr_nr, attr_flag, name, NLA_NUL_STRING, char, maxlen, \
26ec9287	86	nla_strlcpy, nla_put, false)
ec2c35ac LE	87	#define __bin_field(attr_nr, attr_flag, name, maxlen) \
ec2c35ac LE	88	__array(attr_nr, attr_flag, name, NLA_BINARY, char, maxlen, \
26ec9287	89	nla_memcpy, nla_put, false)
ec2c35ac	90
b966b5dd AG	91	/* fields with default values */
	92	#define __flg_field_def(attr_nr, attr_flag, name, default) \
	93	__flg_field(attr_nr, attr_flag, name)
	94	#define __u32_field_def(attr_nr, attr_flag, name, default) \
	95	__u32_field(attr_nr, attr_flag, name)
3a45abd5 AG	96	#define __s32_field_def(attr_nr, attr_flag, name, default) \
3a45abd5 AG	97	__s32_field(attr_nr, attr_flag, name)
b966b5dd AG	98	#define __str_field_def(attr_nr, attr_flag, name, maxlen) \
	99	__str_field(attr_nr, attr_flag, name, maxlen)
	100
ec2c35ac LE	101	#define GENL_op_init(args...) args
	102	#define GENL_doit(handler) \
	103	.doit = handler, \
	104	.flags = GENL_ADMIN_PERM,
	105	#define GENL_dumpit(handler) \
	106	.dumpit = handler, \
	107	.flags = GENL_ADMIN_PERM,
	108
	109	/* }}}1
	110	* Magic: define the enum symbols for genl_ops
	111	* Magic: define the enum symbols for top level attributes
	112	* Magic: define the enum symbols for nested attributes
	113	* {{{2
	114	*/
	115
	116	#undef GENL_struct
	117	#define GENL_struct(tag_name, tag_number, s_name, s_fields)
	118
	119	#undef GENL_mc_group
	120	#define GENL_mc_group(group)
	121
	122	#undef GENL_notification
	123	#define GENL_notification(op_name, op_num, mcast_group, tla_list) \
	124	op_name = op_num,
	125
	126	#undef GENL_op
	127	#define GENL_op(op_name, op_num, handler, tla_list) \
	128	op_name = op_num,
	129
	130	enum {
	131	#include GENL_MAGIC_INCLUDE_FILE
	132	};
	133
	134	#undef GENL_notification
	135	#define GENL_notification(op_name, op_num, mcast_group, tla_list)
	136
	137	#undef GENL_op
	138	#define GENL_op(op_name, op_num, handler, attr_list)
	139
	140	#undef GENL_struct
	141	#define GENL_struct(tag_name, tag_number, s_name, s_fields) \
	142	tag_name = tag_number,
	143
	144	enum {
	145	#include GENL_MAGIC_INCLUDE_FILE
	146	};
	147
	148	#undef GENL_struct
	149	#define GENL_struct(tag_name, tag_number, s_name, s_fields) \
	150	enum { \
	151	s_fields \
	152	};
	153
	154	#undef __field
509100e6 AG	155	#define __field(attr_nr, attr_flag, name, nla_type, type, \
509100e6 AG	156	__get, __put, __is_signed) \
5f935920	157	T_ ## name = (__u16)(attr_nr \| ((attr_flag) & DRBD_GENLA_F_MANDATORY)),
ec2c35ac LE	158
ec2c35ac LE	159	#undef __array
509100e6 AG	160	#define __array(attr_nr, attr_flag, name, nla_type, type, \
509100e6 AG	161	maxlen, __get, __put, __is_signed) \
5f935920	162	T_ ## name = (__u16)(attr_nr \| ((attr_flag) & DRBD_GENLA_F_MANDATORY)),
ec2c35ac LE	163
	164	#include GENL_MAGIC_INCLUDE_FILE
	165
	166	/* }}}1
	167	* Magic: compile time assert unique numbers for operations
	168	* Magic: -"- unique numbers for top level attributes
	169	* Magic: -"- unique numbers for nested attributes
	170	* {{{2
	171	*/
	172
	173	#undef GENL_struct
	174	#define GENL_struct(tag_name, tag_number, s_name, s_fields)
	175
	176	#undef GENL_op
	177	#define GENL_op(op_name, op_num, handler, attr_list) \
	178	case op_name:
	179
	180	#undef GENL_notification
	181	#define GENL_notification(op_name, op_num, mcast_group, tla_list) \
	182	case op_name:
	183
	184	static inline void ct_assert_unique_operations(void)
	185	{
	186	switch (0) {
	187	#include GENL_MAGIC_INCLUDE_FILE
	188	;
	189	}
	190	}
	191
	192	#undef GENL_op
	193	#define GENL_op(op_name, op_num, handler, attr_list)
	194
	195	#undef GENL_notification
	196	#define GENL_notification(op_name, op_num, mcast_group, tla_list)
	197
	198	#undef GENL_struct
	199	#define GENL_struct(tag_name, tag_number, s_name, s_fields) \
	200	case tag_number:
	201
	202	static inline void ct_assert_unique_top_level_attributes(void)
	203	{
	204	switch (0) {
	205	#include GENL_MAGIC_INCLUDE_FILE
	206	;
	207	}
	208	}
	209
	210	#undef GENL_struct
	211	#define GENL_struct(tag_name, tag_number, s_name, s_fields) \
	212	static inline void ct_assert_unique_ ## s_name ## _attributes(void) \
	213	{ \
	214	switch (0) { \
	215	s_fields \
	216	; \
	217	} \
	218	}
	219
	220	#undef __field
509100e6 AG	221	#define __field(attr_nr, attr_flag, name, nla_type, type, __get, __put, \
509100e6 AG	222	__is_signed) \
ec2c35ac LE	223	case attr_nr:
	224
	225	#undef __array
509100e6 AG	226	#define __array(attr_nr, attr_flag, name, nla_type, type, maxlen, \
509100e6 AG	227	__get, __put, __is_signed) \
ec2c35ac LE	228	case attr_nr:
	229
	230	#include GENL_MAGIC_INCLUDE_FILE
	231
	232	/* }}}1
	233	* Magic: declare structs
	234	* struct <name> {
	235	* fields
	236	* };
	237	* {{{2
	238	*/
	239
	240	#undef GENL_struct
	241	#define GENL_struct(tag_name, tag_number, s_name, s_fields) \
	242	struct s_name { s_fields };
	243
	244	#undef __field
509100e6 AG	245	#define __field(attr_nr, attr_flag, name, nla_type, type, __get, __put, \
509100e6 AG	246	__is_signed) \
ec2c35ac LE	247	type name;
	248
	249	#undef __array
509100e6 AG	250	#define __array(attr_nr, attr_flag, name, nla_type, type, maxlen, \
509100e6 AG	251	__get, __put, __is_signed) \
ec2c35ac LE	252	type name[maxlen]; \
	253	__u32 name ## _len;
	254
	255	#include GENL_MAGIC_INCLUDE_FILE
	256
509100e6 AG	257	#undef GENL_struct
	258	#define GENL_struct(tag_name, tag_number, s_name, s_fields) \
	259	enum { \
	260	s_fields \
	261	};
	262
	263	#undef __field
	264	#define __field(attr_nr, attr_flag, name, nla_type, type, __get, __put, \
	265	is_signed) \
	266	F_ ## name ## _IS_SIGNED = is_signed,
	267
	268	#undef __array
	269	#define __array(attr_nr, attr_flag, name, nla_type, type, maxlen, \
	270	__get, __put, is_signed) \
	271	F_ ## name ## _IS_SIGNED = is_signed,
	272
	273	#include GENL_MAGIC_INCLUDE_FILE
	274
ec2c35ac LE	275	/* }}}1 */
	276	#endif /* GENL_MAGIC_STRUCT_H */
	277	/* vim: set foldmethod=marker nofoldenable : */