[linux-block.git] / include / linux / netlink.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef __LINUX_NETLINK_H
#define __LINUX_NETLINK_H


#include <linux/capability.h>
#include <linux/skbuff.h>
#include <linux/export.h>
#include <net/scm.h>
#include <uapi/linux/netlink.h>

struct net;

static inline struct nlmsghdr *nlmsg_hdr(const struct sk_buff *skb)
{
	return (struct nlmsghdr *)skb->data;
}

enum netlink_skb_flags {
	NETLINK_SKB_DST		= 0x8,	/* Dst set in sendto or sendmsg */
};

struct netlink_skb_parms {
	struct scm_creds	creds;		/* Skb credentials	*/
	__u32			portid;
	__u32			dst_group;
	__u32			flags;
	struct sock		*sk;
	bool			nsid_is_set;
	int			nsid;
};

#define NETLINK_CB(skb)		(*(struct netlink_skb_parms*)&((skb)->cb))
#define NETLINK_CREDS(skb)	(&NETLINK_CB((skb)).creds)


void netlink_table_grab(void);
void netlink_table_ungrab(void);

#define NL_CFG_F_NONROOT_RECV	(1 << 0)
#define NL_CFG_F_NONROOT_SEND	(1 << 1)

/* optional Netlink kernel configuration parameters */
struct netlink_kernel_cfg {
	unsigned int	groups;
	unsigned int	flags;
	void		(*input)(struct sk_buff *skb);
	struct mutex	*cb_mutex;
	int		(*bind)(struct net *net, int group);
	void		(*unbind)(struct net *net, int group);
	bool		(*compare)(struct net *net, struct sock *sk);
};

struct sock *__netlink_kernel_create(struct net *net, int unit,
					    struct module *module,
					    struct netlink_kernel_cfg *cfg);
static inline struct sock *
netlink_kernel_create(struct net *net, int unit, struct netlink_kernel_cfg *cfg)
{
	return __netlink_kernel_create(net, unit, THIS_MODULE, cfg);
}

/* this can be increased when necessary - don't expose to userland */
#define NETLINK_MAX_COOKIE_LEN	20

/**
 * struct netlink_ext_ack - netlink extended ACK report struct
 * @_msg: message string to report - don't access directly, use
 *	%NL_SET_ERR_MSG
 * @bad_attr: attribute with error
 * @cookie: cookie data to return to userspace (for success)
 * @cookie_len: actual cookie data length
 */
struct netlink_ext_ack {
	const char *_msg;
	const struct nlattr *bad_attr;
	u8 cookie[NETLINK_MAX_COOKIE_LEN];
	u8 cookie_len;
};

/* Always use this macro, this allows later putting the
 * message into a separate section or such for things
 * like translation or listing all possible messages.
 * Currently string formatting is not supported (due
 * to the lack of an output buffer.)
 */
#define NL_SET_ERR_MSG(extack, msg) do {		\
	static const char __msg[] = msg;		\
	struct netlink_ext_ack *__extack = (extack);	\
							\
	if (__extack)					\
		__extack->_msg = __msg;			\
} while (0)

#define NL_SET_ERR_MSG_MOD(extack, msg)			\
	NL_SET_ERR_MSG((extack), KBUILD_MODNAME ": " msg)

#define NL_SET_BAD_ATTR(extack, attr) do {		\
	if ((extack))					\
		(extack)->bad_attr = (attr);		\
} while (0)

#define NL_SET_ERR_MSG_ATTR(extack, attr, msg) do {	\
	static const char __msg[] = msg;		\
	struct netlink_ext_ack *__extack = (extack);	\
							\
	if (__extack) {					\
		__extack->_msg = __msg;			\
		__extack->bad_attr = (attr);		\
	}						\
} while (0)

static inline void nl_set_extack_cookie_u64(struct netlink_ext_ack *extack,
					    u64 cookie)
{
	u64 __cookie = cookie;

	if (!extack)
		return;
	memcpy(extack->cookie, &__cookie, sizeof(__cookie));
	extack->cookie_len = sizeof(__cookie);
}

static inline void nl_set_extack_cookie_u32(struct netlink_ext_ack *extack,
					    u32 cookie)
{
	u32 __cookie = cookie;

	if (!extack)
		return;
	memcpy(extack->cookie, &__cookie, sizeof(__cookie));
	extack->cookie_len = sizeof(__cookie);
}

void netlink_kernel_release(struct sock *sk);
int __netlink_change_ngroups(struct sock *sk, unsigned int groups);
int netlink_change_ngroups(struct sock *sk, unsigned int groups);
void __netlink_clear_multicast_users(struct sock *sk, unsigned int group);
void netlink_ack(struct sk_buff *in_skb, struct nlmsghdr *nlh, int err,
		 const struct netlink_ext_ack *extack);
int netlink_has_listeners(struct sock *sk, unsigned int group);
bool netlink_strict_get_check(struct sk_buff *skb);

int netlink_unicast(struct sock *ssk, struct sk_buff *skb, __u32 portid, int nonblock);
int netlink_broadcast(struct sock *ssk, struct sk_buff *skb, __u32 portid,
		      __u32 group, gfp_t allocation);
int netlink_broadcast_filtered(struct sock *ssk, struct sk_buff *skb,
			       __u32 portid, __u32 group, gfp_t allocation,
			       int (*filter)(struct sock *dsk, struct sk_buff *skb, void *data),
			       void *filter_data);
int netlink_set_err(struct sock *ssk, __u32 portid, __u32 group, int code);
int netlink_register_notifier(struct notifier_block *nb);
int netlink_unregister_notifier(struct notifier_block *nb);

/* finegrained unicast helpers: */
struct sock *netlink_getsockbyfilp(struct file *filp);
int netlink_attachskb(struct sock *sk, struct sk_buff *skb,
		      long *timeo, struct sock *ssk);
void netlink_detachskb(struct sock *sk, struct sk_buff *skb);
int netlink_sendskb(struct sock *sk, struct sk_buff *skb);

static inline struct sk_buff *
netlink_skb_clone(struct sk_buff *skb, gfp_t gfp_mask)
{
	struct sk_buff *nskb;

	nskb = skb_clone(skb, gfp_mask);
	if (!nskb)
		return NULL;

	/* This is a large skb, set destructor callback to release head */
	if (is_vmalloc_addr(skb->head))
		nskb->destructor = skb->destructor;

	return nskb;
}

/*
 *	skb should fit one page. This choice is good for headerless malloc.
 *	But we should limit to 8K so that userspace does not have to
 *	use enormous buffer sizes on recvmsg() calls just to avoid
 *	MSG_TRUNC when PAGE_SIZE is very large.
 */
#if PAGE_SIZE < 8192UL
#define NLMSG_GOODSIZE	SKB_WITH_OVERHEAD(PAGE_SIZE)
#else
#define NLMSG_GOODSIZE	SKB_WITH_OVERHEAD(8192UL)
#endif

#define NLMSG_DEFAULT_SIZE (NLMSG_GOODSIZE - NLMSG_HDRLEN)


struct netlink_callback {
	struct sk_buff		*skb;
	const struct nlmsghdr	*nlh;
	int			(*dump)(struct sk_buff * skb,
					struct netlink_callback *cb);
	int			(*done)(struct netlink_callback *cb);
	void			*data;
	/* the module that dump function belong to */
	struct module		*module;
	struct netlink_ext_ack	*extack;
	u16			family;
	u16			min_dump_alloc;
	bool			strict_check;
	u16			answer_flags;
	unsigned int		prev_seq, seq;
	union {
		u8		ctx[48];

		/* args is deprecated. Cast a struct over ctx instead
		 * for proper type safety.
		 */
		long		args[6];
	};
};

struct netlink_notify {
	struct net *net;
	u32 portid;
	int protocol;
};

struct nlmsghdr *
__nlmsg_put(struct sk_buff *skb, u32 portid, u32 seq, int type, int len, int flags);

struct netlink_dump_control {
	int (*start)(struct netlink_callback *);
	int (*dump)(struct sk_buff *skb, struct netlink_callback *);
	int (*done)(struct netlink_callback *);
	void *data;
	struct module *module;
	u16 min_dump_alloc;
};

int __netlink_dump_start(struct sock *ssk, struct sk_buff *skb,
				const struct nlmsghdr *nlh,
				struct netlink_dump_control *control);
static inline int netlink_dump_start(struct sock *ssk, struct sk_buff *skb,
				     const struct nlmsghdr *nlh,
				     struct netlink_dump_control *control)
{
	if (!control->module)
		control->module = THIS_MODULE;

	return __netlink_dump_start(ssk, skb, nlh, control);
}

struct netlink_tap {
	struct net_device *dev;
	struct module *module;
	struct list_head list;
};

int netlink_add_tap(struct netlink_tap *nt);
int netlink_remove_tap(struct netlink_tap *nt);

bool __netlink_ns_capable(const struct netlink_skb_parms *nsp,
			  struct user_namespace *ns, int cap);
bool netlink_ns_capable(const struct sk_buff *skb,
			struct user_namespace *ns, int cap);
bool netlink_capable(const struct sk_buff *skb, int cap);
bool netlink_net_capable(const struct sk_buff *skb, int cap);

#endif	/* __LINUX_NETLINK_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
1da177e4 LT	2	#ifndef __LINUX_NETLINK_H
	3	#define __LINUX_NETLINK_H
	4
1da177e4 LT	5
	6	#include <linux/capability.h>
	7	#include <linux/skbuff.h>
abb17e6c	8	#include <linux/export.h>
dbe9a417	9	#include <net/scm.h>
607ca46e	10	#include <uapi/linux/netlink.h>
1da177e4	11
56b49f4b OW	12	struct net;
56b49f4b OW	13
b529ccf2 ACM	14	static inline struct nlmsghdr nlmsg_hdr(const struct sk_buff skb)
	15	{
	16	return (struct nlmsghdr *)skb->data;
	17	}
	18
9652e931	19	enum netlink_skb_flags {
2d7a85f4	20	NETLINK_SKB_DST = 0x8, /* Dst set in sendto or sendmsg */
9652e931 PM	21	};
9652e931 PM	22
d94d9fee	23	struct netlink_skb_parms {
dbe9a417	24	struct scm_creds creds; /* Skb credentials */
15e47304	25	__u32 portid;
d629b836	26	__u32 dst_group;
9652e931	27	__u32 flags;
e32123e5	28	struct sock *sk;
59324cf3 ND	29	bool nsid_is_set;
59324cf3 ND	30	int nsid;
1da177e4 LT	31	};
	32
	33	#define NETLINK_CB(skb) ((struct netlink_skb_parms)&((skb)->cb))
	34	#define NETLINK_CREDS(skb) (&NETLINK_CB((skb)).creds)
	35
	36
aa9d6e0f SH	37	void netlink_table_grab(void);
aa9d6e0f SH	38	void netlink_table_ungrab(void);
d136f1bd	39
9785e10a PNA	40	#define NL_CFG_F_NONROOT_RECV (1 << 0)
	41	#define NL_CFG_F_NONROOT_SEND (1 << 1)
	42
a31f2d17 PNA	43	/* optional Netlink kernel configuration parameters */
	44	struct netlink_kernel_cfg {
	45	unsigned int groups;
c9d2ea96	46	unsigned int flags;
a31f2d17 PNA	47	void (input)(struct sk_buff skb);
a31f2d17 PNA	48	struct mutex *cb_mutex;
023e2cfa JB	49	int (bind)(struct net net, int group);
023e2cfa JB	50	void (unbind)(struct net net, int group);
da12c90e	51	bool (compare)(struct net net, struct sock *sk);
a31f2d17 PNA	52	};
a31f2d17 PNA	53
aa9d6e0f	54	struct sock __netlink_kernel_create(struct net net, int unit,
9f00d977 PNA	55	struct module *module,
	56	struct netlink_kernel_cfg *cfg);
	57	static inline struct sock *
	58	netlink_kernel_create(struct net net, int unit, struct netlink_kernel_cfg cfg)
	59	{
	60	return __netlink_kernel_create(net, unit, THIS_MODULE, cfg);
	61	}
	62
ba0dc5f6 JB	63	/* this can be increased when necessary - don't expose to userland */
	64	#define NETLINK_MAX_COOKIE_LEN 20
	65
2d4bc933 JB	66	/**
	67	* struct netlink_ext_ack - netlink extended ACK report struct
	68	* @_msg: message string to report - don't access directly, use
	69	* %NL_SET_ERR_MSG
	70	* @bad_attr: attribute with error
ba0dc5f6 JB	71	* @cookie: cookie data to return to userspace (for success)
ba0dc5f6 JB	72	* @cookie_len: actual cookie data length
2d4bc933 JB	73	*/
	74	struct netlink_ext_ack {
	75	const char *_msg;
	76	const struct nlattr *bad_attr;
ba0dc5f6 JB	77	u8 cookie[NETLINK_MAX_COOKIE_LEN];
ba0dc5f6 JB	78	u8 cookie_len;
2d4bc933 JB	79	};
	80
	81	/* Always use this macro, this allows later putting the
	82	* message into a separate section or such for things
	83	* like translation or listing all possible messages.
	84	* Currently string formatting is not supported (due
	85	* to the lack of an output buffer.)
	86	*/
4d463c4d	87	#define NL_SET_ERR_MSG(extack, msg) do { \
6311b7ce	88	static const char __msg[] = msg; \
4d463c4d DB	89	struct netlink_ext_ack *__extack = (extack); \
	90	\
	91	if (__extack) \
	92	__extack->_msg = __msg; \
2d4bc933 JB	93	} while (0)
2d4bc933 JB	94
4d463c4d DB	95	#define NL_SET_ERR_MSG_MOD(extack, msg) \
4d463c4d DB	96	NL_SET_ERR_MSG((extack), KBUILD_MODNAME ": " msg)
45d9b378	97
c3ab2b4e DA	98	#define NL_SET_BAD_ATTR(extack, attr) do { \
	99	if ((extack)) \
	100	(extack)->bad_attr = (attr); \
	101	} while (0)
	102
9ae28727	103	#define NL_SET_ERR_MSG_ATTR(extack, attr, msg) do { \
6311b7ce	104	static const char __msg[] = msg; \
9ae28727 DA	105	struct netlink_ext_ack *__extack = (extack); \
	106	\
	107	if (__extack) { \
	108	__extack->_msg = __msg; \
	109	__extack->bad_attr = (attr); \
	110	} \
	111	} while (0)
	112
801f8746 JB	113	static inline void nl_set_extack_cookie_u64(struct netlink_ext_ack *extack,
	114	u64 cookie)
	115	{
	116	u64 __cookie = cookie;
	117
55b474c4 MK	118	if (!extack)
55b474c4 MK	119	return;
801f8746 JB	120	memcpy(extack->cookie, &__cookie, sizeof(__cookie));
	121	extack->cookie_len = sizeof(__cookie);
	122	}
	123
f1388ec4 MK	124	static inline void nl_set_extack_cookie_u32(struct netlink_ext_ack *extack,
	125	u32 cookie)
	126	{
	127	u32 __cookie = cookie;
	128
55b474c4 MK	129	if (!extack)
55b474c4 MK	130	return;
f1388ec4 MK	131	memcpy(extack->cookie, &__cookie, sizeof(__cookie));
	132	extack->cookie_len = sizeof(__cookie);
	133	}
	134
aa9d6e0f SH	135	void netlink_kernel_release(struct sock *sk);
	136	int __netlink_change_ngroups(struct sock *sk, unsigned int groups);
	137	int netlink_change_ngroups(struct sock *sk, unsigned int groups);
	138	void __netlink_clear_multicast_users(struct sock *sk, unsigned int group);
	139	void netlink_ack(struct sk_buff in_skb, struct nlmsghdr nlh, int err,
	140	const struct netlink_ext_ack *extack);
	141	int netlink_has_listeners(struct sock *sk, unsigned int group);
59c28058	142	bool netlink_strict_get_check(struct sk_buff *skb);
aa9d6e0f SH	143
	144	int netlink_unicast(struct sock ssk, struct sk_buff skb, __u32 portid, int nonblock);
	145	int netlink_broadcast(struct sock ssk, struct sk_buff skb, __u32 portid,
	146	__u32 group, gfp_t allocation);
	147	int netlink_broadcast_filtered(struct sock ssk, struct sk_buff skb,
	148	__u32 portid, __u32 group, gfp_t allocation,
	149	int (filter)(struct sock dsk, struct sk_buff skb, void data),
	150	void *filter_data);
	151	int netlink_set_err(struct sock *ssk, __u32 portid, __u32 group, int code);
	152	int netlink_register_notifier(struct notifier_block *nb);
	153	int netlink_unregister_notifier(struct notifier_block *nb);
1da177e4 LT	154
	155	/* finegrained unicast helpers: */
	156	struct sock netlink_getsockbyfilp(struct file filp);
9457afee	157	int netlink_attachskb(struct sock sk, struct sk_buff skb,
c3d8d1e3	158	long timeo, struct sock ssk);
1da177e4	159	void netlink_detachskb(struct sock sk, struct sk_buff skb);
7ee015e0	160	int netlink_sendskb(struct sock sk, struct sk_buff skb);
1da177e4	161
3a36515f PN	162	static inline struct sk_buff *
	163	netlink_skb_clone(struct sk_buff *skb, gfp_t gfp_mask)
	164	{
	165	struct sk_buff *nskb;
	166
	167	nskb = skb_clone(skb, gfp_mask);
	168	if (!nskb)
	169	return NULL;
	170
	171	/* This is a large skb, set destructor callback to release head */
	172	if (is_vmalloc_addr(skb->head))
	173	nskb->destructor = skb->destructor;
	174
	175	return nskb;
	176	}
	177
1da177e4 LT	178	/*
1da177e4 LT	179	* skb should fit one page. This choice is good for headerless malloc.
fc910a27 DM	180	* But we should limit to 8K so that userspace does not have to
	181	* use enormous buffer sizes on recvmsg() calls just to avoid
	182	* MSG_TRUNC when PAGE_SIZE is very large.
1da177e4	183	*/
fc910a27 DM	184	#if PAGE_SIZE < 8192UL
	185	#define NLMSG_GOODSIZE SKB_WITH_OVERHEAD(PAGE_SIZE)
	186	#else
	187	#define NLMSG_GOODSIZE SKB_WITH_OVERHEAD(8192UL)
	188	#endif
	189
339bf98f	190	#define NLMSG_DEFAULT_SIZE (NLMSG_GOODSIZE - NLMSG_HDRLEN)
1da177e4 LT	191
1da177e4 LT	192
d94d9fee	193	struct netlink_callback {
3a6c2b41 PM	194	struct sk_buff *skb;
	195	const struct nlmsghdr *nlh;
	196	int (dump)(struct sk_buff skb,
	197	struct netlink_callback *cb);
	198	int (done)(struct netlink_callback cb);
7175c883	199	void *data;
6dc878a8 G	200	/* the module that dump function belong to */
6dc878a8 G	201	struct module *module;
4a19edb6	202	struct netlink_ext_ack *extack;
c7ac8679 GR	203	u16 family;
c7ac8679 GR	204	u16 min_dump_alloc;
89d35528	205	bool strict_check;
22e6c58b	206	u16 answer_flags;
670dc283	207	unsigned int prev_seq, seq;
362b87f5 JD	208	union {
	209	u8 ctx[48];
	210
	211	/* args is deprecated. Cast a struct over ctx instead
	212	* for proper type safety.
	213	*/
	214	long args[6];
	215	};
1da177e4 LT	216	};
1da177e4 LT	217
d94d9fee	218	struct netlink_notify {
b4b51029	219	struct net *net;
0392d099	220	u32 portid;
1da177e4 LT	221	int protocol;
	222	};
	223
a46621a3	224	struct nlmsghdr *
15e47304	225	__nlmsg_put(struct sk_buff *skb, u32 portid, u32 seq, int type, int len, int flags);
1da177e4	226
80d326fa	227	struct netlink_dump_control {
fc9e50f5	228	int (start)(struct netlink_callback );
80d326fa	229	int (dump)(struct sk_buff skb, struct netlink_callback *);
6dc878a8	230	int (done)(struct netlink_callback );
7175c883	231	void *data;
6dc878a8	232	struct module *module;
80d326fa PNA	233	u16 min_dump_alloc;
	234	};
	235
aa9d6e0f	236	int __netlink_dump_start(struct sock ssk, struct sk_buff skb,
6dc878a8 G	237	const struct nlmsghdr *nlh,
	238	struct netlink_dump_control *control);
	239	static inline int netlink_dump_start(struct sock ssk, struct sk_buff skb,
	240	const struct nlmsghdr *nlh,
	241	struct netlink_dump_control *control)
	242	{
	243	if (!control->module)
	244	control->module = THIS_MODULE;
	245
	246	return __netlink_dump_start(ssk, skb, nlh, control);
	247	}
1da177e4	248
bcbde0d4 DB	249	struct netlink_tap {
	250	struct net_device *dev;
	251	struct module *module;
	252	struct list_head list;
	253	};
	254
aa9d6e0f SH	255	int netlink_add_tap(struct netlink_tap *nt);
aa9d6e0f SH	256	int netlink_remove_tap(struct netlink_tap *nt);
bcbde0d4	257
aa4cf945 EB	258	bool __netlink_ns_capable(const struct netlink_skb_parms *nsp,
	259	struct user_namespace *ns, int cap);
	260	bool netlink_ns_capable(const struct sk_buff *skb,
	261	struct user_namespace *ns, int cap);
	262	bool netlink_capable(const struct sk_buff *skb, int cap);
	263	bool netlink_net_capable(const struct sk_buff *skb, int cap);
	264
1da177e4	265	#endif /* __LINUX_NETLINK_H */