[deliverable/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;
}

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

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

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

/*
 *	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);
}

#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
d94d9fee	18	struct netlink_skb_parms {
dbe9a417	19	struct scm_creds creds; /* Skb credentials */
15e47304	20	__u32 portid;
d629b836	21	__u32 dst_group;
3fbc2905	22	struct sock *ssk;
1da177e4 LT	23	};
	24
	25	#define NETLINK_CB(skb) ((struct netlink_skb_parms)&((skb)->cb))
	26	#define NETLINK_CREDS(skb) (&NETLINK_CB((skb)).creds)
	27
	28
d136f1bd JB	29	extern void netlink_table_grab(void);
	30	extern void netlink_table_ungrab(void);
	31
9785e10a PNA	32	#define NL_CFG_F_NONROOT_RECV (1 << 0)
	33	#define NL_CFG_F_NONROOT_SEND (1 << 1)
	34
a31f2d17 PNA	35	/* optional Netlink kernel configuration parameters */
	36	struct netlink_kernel_cfg {
	37	unsigned int groups;
c9d2ea96	38	unsigned int flags;
a31f2d17 PNA	39	void (input)(struct sk_buff skb);
a31f2d17 PNA	40	struct mutex *cb_mutex;
03292745	41	void (*bind)(int group);
a31f2d17 PNA	42	};
a31f2d17 PNA	43
9f00d977 PNA	44	extern struct sock __netlink_kernel_create(struct net net, int unit,
	45	struct module *module,
	46	struct netlink_kernel_cfg *cfg);
	47	static inline struct sock *
	48	netlink_kernel_create(struct net net, int unit, struct netlink_kernel_cfg cfg)
	49	{
	50	return __netlink_kernel_create(net, unit, THIS_MODULE, cfg);
	51	}
	52
b7c6ba6e	53	extern void netlink_kernel_release(struct sock *sk);
d136f1bd	54	extern int __netlink_change_ngroups(struct sock *sk, unsigned int groups);
b4ff4f04	55	extern int netlink_change_ngroups(struct sock *sk, unsigned int groups);
b8273570	56	extern void __netlink_clear_multicast_users(struct sock *sk, unsigned int group);
84659eb5	57	extern void netlink_clear_multicast_users(struct sock *sk, unsigned int group);
1da177e4	58	extern void netlink_ack(struct sk_buff in_skb, struct nlmsghdr nlh, int err);
4277a083	59	extern int netlink_has_listeners(struct sock *sk, unsigned int group);
15e47304 EB	60	extern int netlink_unicast(struct sock ssk, struct sk_buff skb, __u32 portid, int nonblock);
15e47304 EB	61	extern int netlink_broadcast(struct sock ssk, struct sk_buff skb, __u32 portid,
dd0fc66f	62	__u32 group, gfp_t allocation);
910a7e90	63	extern int netlink_broadcast_filtered(struct sock ssk, struct sk_buff skb,
15e47304	64	__u32 portid, __u32 group, gfp_t allocation,
910a7e90 EB	65	int (filter)(struct sock dsk, struct sk_buff skb, void data),
910a7e90 EB	66	void *filter_data);
15e47304	67	extern int netlink_set_err(struct sock *ssk, __u32 portid, __u32 group, int code);
1da177e4 LT	68	extern int netlink_register_notifier(struct notifier_block *nb);
	69	extern int netlink_unregister_notifier(struct notifier_block *nb);
	70
	71	/* finegrained unicast helpers: */
	72	struct sock netlink_getsockbyfilp(struct file filp);
9457afee	73	int netlink_attachskb(struct sock sk, struct sk_buff skb,
c3d8d1e3	74	long timeo, struct sock ssk);
1da177e4	75	void netlink_detachskb(struct sock sk, struct sk_buff skb);
7ee015e0	76	int netlink_sendskb(struct sock sk, struct sk_buff skb);
1da177e4 LT	77
	78	/*
	79	* skb should fit one page. This choice is good for headerless malloc.
fc910a27 DM	80	* But we should limit to 8K so that userspace does not have to
	81	* use enormous buffer sizes on recvmsg() calls just to avoid
	82	* MSG_TRUNC when PAGE_SIZE is very large.
1da177e4	83	*/
fc910a27 DM	84	#if PAGE_SIZE < 8192UL
	85	#define NLMSG_GOODSIZE SKB_WITH_OVERHEAD(PAGE_SIZE)
	86	#else
	87	#define NLMSG_GOODSIZE SKB_WITH_OVERHEAD(8192UL)
	88	#endif
	89
339bf98f	90	#define NLMSG_DEFAULT_SIZE (NLMSG_GOODSIZE - NLMSG_HDRLEN)
1da177e4 LT	91
1da177e4 LT	92
d94d9fee	93	struct netlink_callback {
3a6c2b41 PM	94	struct sk_buff *skb;
	95	const struct nlmsghdr *nlh;
	96	int (dump)(struct sk_buff skb,
	97	struct netlink_callback *cb);
	98	int (done)(struct netlink_callback cb);
7175c883	99	void *data;
6dc878a8 G	100	/* the module that dump function belong to */
6dc878a8 G	101	struct module *module;
c7ac8679 GR	102	u16 family;
c7ac8679 GR	103	u16 min_dump_alloc;
670dc283	104	unsigned int prev_seq, seq;
3a6c2b41	105	long args[6];
1da177e4 LT	106	};
1da177e4 LT	107
d94d9fee	108	struct netlink_notify {
b4b51029	109	struct net *net;
15e47304	110	int portid;
1da177e4 LT	111	int protocol;
	112	};
	113
a46621a3	114	struct nlmsghdr *
15e47304	115	__nlmsg_put(struct sk_buff *skb, u32 portid, u32 seq, int type, int len, int flags);
1da177e4	116
80d326fa PNA	117	struct netlink_dump_control {
80d326fa PNA	118	int (dump)(struct sk_buff skb, struct netlink_callback *);
6dc878a8	119	int (done)(struct netlink_callback );
7175c883	120	void *data;
6dc878a8	121	struct module *module;
80d326fa PNA	122	u16 min_dump_alloc;
	123	};
	124
6dc878a8 G	125	extern int __netlink_dump_start(struct sock ssk, struct sk_buff skb,
	126	const struct nlmsghdr *nlh,
	127	struct netlink_dump_control *control);
	128	static inline int netlink_dump_start(struct sock ssk, struct sk_buff skb,
	129	const struct nlmsghdr *nlh,
	130	struct netlink_dump_control *control)
	131	{
	132	if (!control->module)
	133	control->module = THIS_MODULE;
	134
	135	return __netlink_dump_start(ssk, skb, nlh, control);
	136	}
1da177e4	137
1da177e4	138	#endif /* __LINUX_NETLINK_H */