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

#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_MMAPED	= 0x1,		/* Packet data is mmaped */
	NETLINK_SKB_TX		= 0x2,		/* Packet was sent by userspace */
	NETLINK_SKB_DELIVERED	= 0x4,		/* Packet was delivered */
};

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

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


extern void netlink_table_grab(void);
extern 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;
	void		(*bind)(int group);
	bool		(*compare)(struct net *net, struct sock *sk);
};

extern 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);
}

extern void netlink_kernel_release(struct sock *sk);
extern int __netlink_change_ngroups(struct sock *sk, unsigned int groups);
extern int netlink_change_ngroups(struct sock *sk, unsigned int groups);
extern void __netlink_clear_multicast_users(struct sock *sk, unsigned int group);
extern void netlink_clear_multicast_users(struct sock *sk, unsigned int group);
extern void netlink_ack(struct sk_buff *in_skb, struct nlmsghdr *nlh, int err);
extern int netlink_has_listeners(struct sock *sk, unsigned int group);
extern struct sk_buff *netlink_alloc_skb(struct sock *ssk, unsigned int size,
					 u32 dst_portid, gfp_t gfp_mask);
extern int netlink_unicast(struct sock *ssk, struct sk_buff *skb, __u32 portid, int nonblock);
extern int netlink_broadcast(struct sock *ssk, struct sk_buff *skb, __u32 portid,
			     __u32 group, gfp_t allocation);
extern 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);
extern int netlink_set_err(struct sock *ssk, __u32 portid, __u32 group, int code);
extern int netlink_register_notifier(struct notifier_block *nb);
extern 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;
	u16			family;
	u16			min_dump_alloc;
	unsigned int		prev_seq, seq;
	long			args[6];
};

struct netlink_notify {
	struct net *net;
	int 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 (*dump)(struct sk_buff *skb, struct netlink_callback *);
	int (*done)(struct netlink_callback *);
	void *data;
	struct module *module;
	u16 min_dump_alloc;
};

extern 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;
};

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

#endif	/* __LINUX_NETLINK_H */
Commit	Line	Data
1da177e4 LT	1	#ifndef __LINUX_NETLINK_H
	2	#define __LINUX_NETLINK_H
	3
1da177e4 LT	4
	5	#include <linux/capability.h>
	6	#include <linux/skbuff.h>
abb17e6c	7	#include <linux/export.h>
dbe9a417	8	#include <net/scm.h>
607ca46e	9	#include <uapi/linux/netlink.h>
1da177e4	10
56b49f4b OW	11	struct net;
56b49f4b OW	12
b529ccf2 ACM	13	static inline struct nlmsghdr nlmsg_hdr(const struct sk_buff skb)
	14	{
	15	return (struct nlmsghdr *)skb->data;
	16	}
	17
9652e931 PM	18	enum netlink_skb_flags {
	19	NETLINK_SKB_MMAPED = 0x1, /* Packet data is mmaped */
	20	NETLINK_SKB_TX = 0x2, /* Packet was sent by userspace */
	21	NETLINK_SKB_DELIVERED = 0x4, /* Packet was delivered */
	22	};
	23
d94d9fee	24	struct netlink_skb_parms {
dbe9a417	25	struct scm_creds creds; /* Skb credentials */
15e47304	26	__u32 portid;
d629b836	27	__u32 dst_group;
9652e931	28	__u32 flags;
e32123e5	29	struct sock *sk;
1da177e4 LT	30	};
	31
	32	#define NETLINK_CB(skb) ((struct netlink_skb_parms)&((skb)->cb))
	33	#define NETLINK_CREDS(skb) (&NETLINK_CB((skb)).creds)
	34
	35
d136f1bd JB	36	extern void netlink_table_grab(void);
	37	extern void netlink_table_ungrab(void);
	38
9785e10a PNA	39	#define NL_CFG_F_NONROOT_RECV (1 << 0)
	40	#define NL_CFG_F_NONROOT_SEND (1 << 1)
	41
a31f2d17 PNA	42	/* optional Netlink kernel configuration parameters */
	43	struct netlink_kernel_cfg {
	44	unsigned int groups;
c9d2ea96	45	unsigned int flags;
a31f2d17 PNA	46	void (input)(struct sk_buff skb);
a31f2d17 PNA	47	struct mutex *cb_mutex;
03292745	48	void (*bind)(int group);
da12c90e	49	bool (compare)(struct net net, struct sock *sk);
a31f2d17 PNA	50	};
a31f2d17 PNA	51
9f00d977 PNA	52	extern struct sock __netlink_kernel_create(struct net net, int unit,
	53	struct module *module,
	54	struct netlink_kernel_cfg *cfg);
	55	static inline struct sock *
	56	netlink_kernel_create(struct net net, int unit, struct netlink_kernel_cfg cfg)
	57	{
	58	return __netlink_kernel_create(net, unit, THIS_MODULE, cfg);
	59	}
	60
b7c6ba6e	61	extern void netlink_kernel_release(struct sock *sk);
d136f1bd	62	extern int __netlink_change_ngroups(struct sock *sk, unsigned int groups);
b4ff4f04	63	extern int netlink_change_ngroups(struct sock *sk, unsigned int groups);
b8273570	64	extern void __netlink_clear_multicast_users(struct sock *sk, unsigned int group);
84659eb5	65	extern void netlink_clear_multicast_users(struct sock *sk, unsigned int group);
1da177e4	66	extern void netlink_ack(struct sk_buff in_skb, struct nlmsghdr nlh, int err);
4277a083	67	extern int netlink_has_listeners(struct sock *sk, unsigned int group);
f9c22888 PM	68	extern struct sk_buff netlink_alloc_skb(struct sock ssk, unsigned int size,
f9c22888 PM	69	u32 dst_portid, gfp_t gfp_mask);
15e47304 EB	70	extern int netlink_unicast(struct sock ssk, struct sk_buff skb, __u32 portid, int nonblock);
15e47304 EB	71	extern int netlink_broadcast(struct sock ssk, struct sk_buff skb, __u32 portid,
dd0fc66f	72	__u32 group, gfp_t allocation);
910a7e90	73	extern int netlink_broadcast_filtered(struct sock ssk, struct sk_buff skb,
15e47304	74	__u32 portid, __u32 group, gfp_t allocation,
910a7e90 EB	75	int (filter)(struct sock dsk, struct sk_buff skb, void data),
910a7e90 EB	76	void *filter_data);
15e47304	77	extern int netlink_set_err(struct sock *ssk, __u32 portid, __u32 group, int code);
1da177e4 LT	78	extern int netlink_register_notifier(struct notifier_block *nb);
	79	extern int netlink_unregister_notifier(struct notifier_block *nb);
	80
	81	/* finegrained unicast helpers: */
	82	struct sock netlink_getsockbyfilp(struct file filp);
9457afee	83	int netlink_attachskb(struct sock sk, struct sk_buff skb,
c3d8d1e3	84	long timeo, struct sock ssk);
1da177e4	85	void netlink_detachskb(struct sock sk, struct sk_buff skb);
7ee015e0	86	int netlink_sendskb(struct sock sk, struct sk_buff skb);
1da177e4	87
3a36515f PN	88	static inline struct sk_buff *
	89	netlink_skb_clone(struct sk_buff *skb, gfp_t gfp_mask)
	90	{
	91	struct sk_buff *nskb;
	92
	93	nskb = skb_clone(skb, gfp_mask);
	94	if (!nskb)
	95	return NULL;
	96
	97	/* This is a large skb, set destructor callback to release head */
	98	if (is_vmalloc_addr(skb->head))
	99	nskb->destructor = skb->destructor;
	100
	101	return nskb;
	102	}
	103
1da177e4 LT	104	/*
1da177e4 LT	105	* skb should fit one page. This choice is good for headerless malloc.
fc910a27 DM	106	* But we should limit to 8K so that userspace does not have to
	107	* use enormous buffer sizes on recvmsg() calls just to avoid
	108	* MSG_TRUNC when PAGE_SIZE is very large.
1da177e4	109	*/
fc910a27 DM	110	#if PAGE_SIZE < 8192UL
	111	#define NLMSG_GOODSIZE SKB_WITH_OVERHEAD(PAGE_SIZE)
	112	#else
	113	#define NLMSG_GOODSIZE SKB_WITH_OVERHEAD(8192UL)
	114	#endif
	115
339bf98f	116	#define NLMSG_DEFAULT_SIZE (NLMSG_GOODSIZE - NLMSG_HDRLEN)
1da177e4 LT	117
1da177e4 LT	118
d94d9fee	119	struct netlink_callback {
3a6c2b41 PM	120	struct sk_buff *skb;
	121	const struct nlmsghdr *nlh;
	122	int (dump)(struct sk_buff skb,
	123	struct netlink_callback *cb);
	124	int (done)(struct netlink_callback cb);
7175c883	125	void *data;
6dc878a8 G	126	/* the module that dump function belong to */
6dc878a8 G	127	struct module *module;
c7ac8679 GR	128	u16 family;
c7ac8679 GR	129	u16 min_dump_alloc;
670dc283	130	unsigned int prev_seq, seq;
3a6c2b41	131	long args[6];
1da177e4 LT	132	};
1da177e4 LT	133
d94d9fee	134	struct netlink_notify {
b4b51029	135	struct net *net;
15e47304	136	int portid;
1da177e4 LT	137	int protocol;
	138	};
	139
a46621a3	140	struct nlmsghdr *
15e47304	141	__nlmsg_put(struct sk_buff *skb, u32 portid, u32 seq, int type, int len, int flags);
1da177e4	142
80d326fa PNA	143	struct netlink_dump_control {
80d326fa PNA	144	int (dump)(struct sk_buff skb, struct netlink_callback *);
6dc878a8	145	int (done)(struct netlink_callback );
7175c883	146	void *data;
6dc878a8	147	struct module *module;
80d326fa PNA	148	u16 min_dump_alloc;
	149	};
	150
6dc878a8 G	151	extern int __netlink_dump_start(struct sock ssk, struct sk_buff skb,
	152	const struct nlmsghdr *nlh,
	153	struct netlink_dump_control *control);
	154	static inline int netlink_dump_start(struct sock ssk, struct sk_buff skb,
	155	const struct nlmsghdr *nlh,
	156	struct netlink_dump_control *control)
	157	{
	158	if (!control->module)
	159	control->module = THIS_MODULE;
	160
	161	return __netlink_dump_start(ssk, skb, nlh, control);
	162	}
1da177e4	163
bcbde0d4 DB	164	struct netlink_tap {
	165	struct net_device *dev;
	166	struct module *module;
	167	struct list_head list;
	168	};
	169
	170	extern int netlink_add_tap(struct netlink_tap *nt);
	171	extern int __netlink_remove_tap(struct netlink_tap *nt);
	172	extern int netlink_remove_tap(struct netlink_tap *nt);
	173
1da177e4	174	#endif /* __LINUX_NETLINK_H */