blob: 6358da5eeee8f8d89b619557631613762d09c883 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef __LINUX_NETLINK_H
2#define __LINUX_NETLINK_H
3
Linus Torvalds1da177e2005-04-16 15:20:36 -07004
5#include <linux/capability.h>
6#include <linux/skbuff.h>
Pablo Neira Ayusoabb17e62012-09-21 09:35:38 +00007#include <linux/export.h>
Eric W. Biedermandbe9a412012-09-06 18:20:01 +00008#include <net/scm.h>
David Howells607ca462012-10-13 10:46:48 +01009#include <uapi/linux/netlink.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070010
Ollie Wild56b49f42010-09-22 05:54:54 +000011struct net;
12
Arnaldo Carvalho de Melob529ccf2007-04-25 19:08:35 -070013static inline struct nlmsghdr *nlmsg_hdr(const struct sk_buff *skb)
14{
15 return (struct nlmsghdr *)skb->data;
16}
17
Patrick McHardy9652e932013-04-17 06:47:02 +000018enum 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
Eric Dumazetd94d9fe2009-11-04 09:50:58 -080024struct netlink_skb_parms {
Eric W. Biedermandbe9a412012-09-06 18:20:01 +000025 struct scm_creds creds; /* Skb credentials */
Eric W. Biederman15e47302012-09-07 20:12:54 +000026 __u32 portid;
Patrick McHardyd629b832005-08-14 19:27:50 -070027 __u32 dst_group;
Patrick McHardy9652e932013-04-17 06:47:02 +000028 __u32 flags;
Patrick McHardye32123e2013-04-17 06:46:57 +000029 struct sock *sk;
Linus Torvalds1da177e2005-04-16 15:20:36 -070030};
31
32#define NETLINK_CB(skb) (*(struct netlink_skb_parms*)&((skb)->cb))
33#define NETLINK_CREDS(skb) (&NETLINK_CB((skb)).creds)
34
35
Johannes Bergd136f1b2009-09-12 03:03:15 +000036extern void netlink_table_grab(void);
37extern void netlink_table_ungrab(void);
38
Pablo Neira Ayuso9785e102012-09-08 02:53:53 +000039#define NL_CFG_F_NONROOT_RECV (1 << 0)
40#define NL_CFG_F_NONROOT_SEND (1 << 1)
41
Pablo Neira Ayusoa31f2d12012-06-29 06:15:21 +000042/* optional Netlink kernel configuration parameters */
43struct netlink_kernel_cfg {
44 unsigned int groups;
David S. Millerc9d2ea92012-09-23 02:09:23 -040045 unsigned int flags;
Pablo Neira Ayusoa31f2d12012-06-29 06:15:21 +000046 void (*input)(struct sk_buff *skb);
47 struct mutex *cb_mutex;
Pablo Neira Ayuso03292742012-06-29 06:15:22 +000048 void (*bind)(int group);
Pablo Neira Ayusoa31f2d12012-06-29 06:15:21 +000049};
50
Pablo Neira Ayuso9f00d972012-09-08 02:53:54 +000051extern struct sock *__netlink_kernel_create(struct net *net, int unit,
52 struct module *module,
53 struct netlink_kernel_cfg *cfg);
54static inline struct sock *
55netlink_kernel_create(struct net *net, int unit, struct netlink_kernel_cfg *cfg)
56{
57 return __netlink_kernel_create(net, unit, THIS_MODULE, cfg);
58}
59
Denis V. Lunevb7c6ba62008-01-28 14:41:19 -080060extern void netlink_kernel_release(struct sock *sk);
Johannes Bergd136f1b2009-09-12 03:03:15 +000061extern int __netlink_change_ngroups(struct sock *sk, unsigned int groups);
Johannes Bergb4ff4f02007-07-18 15:46:06 -070062extern int netlink_change_ngroups(struct sock *sk, unsigned int groups);
Johannes Bergb8273572009-09-24 15:44:05 -070063extern void __netlink_clear_multicast_users(struct sock *sk, unsigned int group);
Johannes Berg84659eb2007-07-18 15:47:05 -070064extern void netlink_clear_multicast_users(struct sock *sk, unsigned int group);
Linus Torvalds1da177e2005-04-16 15:20:36 -070065extern void netlink_ack(struct sk_buff *in_skb, struct nlmsghdr *nlh, int err);
Patrick McHardy4277a082006-03-20 18:52:01 -080066extern int netlink_has_listeners(struct sock *sk, unsigned int group);
Patrick McHardyf9c22882013-04-17 06:47:04 +000067extern struct sk_buff *netlink_alloc_skb(struct sock *ssk, unsigned int size,
68 u32 dst_portid, gfp_t gfp_mask);
Eric W. Biederman15e47302012-09-07 20:12:54 +000069extern int netlink_unicast(struct sock *ssk, struct sk_buff *skb, __u32 portid, int nonblock);
70extern int netlink_broadcast(struct sock *ssk, struct sk_buff *skb, __u32 portid,
Al Virodd0fc662005-10-07 07:46:04 +010071 __u32 group, gfp_t allocation);
Eric W. Biederman910a7e92010-05-04 17:36:46 -070072extern int netlink_broadcast_filtered(struct sock *ssk, struct sk_buff *skb,
Eric W. Biederman15e47302012-09-07 20:12:54 +000073 __u32 portid, __u32 group, gfp_t allocation,
Eric W. Biederman910a7e92010-05-04 17:36:46 -070074 int (*filter)(struct sock *dsk, struct sk_buff *skb, void *data),
75 void *filter_data);
Eric W. Biederman15e47302012-09-07 20:12:54 +000076extern int netlink_set_err(struct sock *ssk, __u32 portid, __u32 group, int code);
Linus Torvalds1da177e2005-04-16 15:20:36 -070077extern int netlink_register_notifier(struct notifier_block *nb);
78extern int netlink_unregister_notifier(struct notifier_block *nb);
79
80/* finegrained unicast helpers: */
81struct sock *netlink_getsockbyfilp(struct file *filp);
Denis V. Lunev9457afe2008-06-05 11:23:39 -070082int netlink_attachskb(struct sock *sk, struct sk_buff *skb,
Patrick McHardyc3d8d1e2007-11-07 02:42:09 -080083 long *timeo, struct sock *ssk);
Linus Torvalds1da177e2005-04-16 15:20:36 -070084void netlink_detachskb(struct sock *sk, struct sk_buff *skb);
Denis V. Lunev7ee015e2007-10-10 21:14:03 -070085int netlink_sendskb(struct sock *sk, struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -070086
87/*
88 * skb should fit one page. This choice is good for headerless malloc.
David S. Millerfc910a22007-03-25 20:27:59 -070089 * But we should limit to 8K so that userspace does not have to
90 * use enormous buffer sizes on recvmsg() calls just to avoid
91 * MSG_TRUNC when PAGE_SIZE is very large.
Linus Torvalds1da177e2005-04-16 15:20:36 -070092 */
David S. Millerfc910a22007-03-25 20:27:59 -070093#if PAGE_SIZE < 8192UL
94#define NLMSG_GOODSIZE SKB_WITH_OVERHEAD(PAGE_SIZE)
95#else
96#define NLMSG_GOODSIZE SKB_WITH_OVERHEAD(8192UL)
97#endif
98
Thomas Graf339bf982006-11-10 14:10:15 -080099#define NLMSG_DEFAULT_SIZE (NLMSG_GOODSIZE - NLMSG_HDRLEN)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100
101
Eric Dumazetd94d9fe2009-11-04 09:50:58 -0800102struct netlink_callback {
Patrick McHardy3a6c2b42009-08-25 16:07:40 +0200103 struct sk_buff *skb;
104 const struct nlmsghdr *nlh;
105 int (*dump)(struct sk_buff * skb,
106 struct netlink_callback *cb);
107 int (*done)(struct netlink_callback *cb);
Pablo Neira Ayuso7175c882012-02-24 14:30:16 +0000108 void *data;
Gao feng6dc878a2012-10-04 20:15:48 +0000109 /* the module that dump function belong to */
110 struct module *module;
Greg Rosec7ac8672011-06-10 01:27:09 +0000111 u16 family;
112 u16 min_dump_alloc;
Johannes Berg670dc282011-06-20 13:40:46 +0200113 unsigned int prev_seq, seq;
Patrick McHardy3a6c2b42009-08-25 16:07:40 +0200114 long args[6];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115};
116
Eric Dumazetd94d9fe2009-11-04 09:50:58 -0800117struct netlink_notify {
Eric W. Biedermanb4b51022007-09-12 13:05:38 +0200118 struct net *net;
Eric W. Biederman15e47302012-09-07 20:12:54 +0000119 int portid;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 int protocol;
121};
122
Denys Vlasenkoa46621a2012-01-30 15:22:06 -0500123struct nlmsghdr *
Eric W. Biederman15e47302012-09-07 20:12:54 +0000124__nlmsg_put(struct sk_buff *skb, u32 portid, u32 seq, int type, int len, int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125
Pablo Neira Ayuso80d326f2012-02-24 14:30:15 +0000126struct netlink_dump_control {
127 int (*dump)(struct sk_buff *skb, struct netlink_callback *);
Gao feng6dc878a2012-10-04 20:15:48 +0000128 int (*done)(struct netlink_callback *);
Pablo Neira Ayuso7175c882012-02-24 14:30:16 +0000129 void *data;
Gao feng6dc878a2012-10-04 20:15:48 +0000130 struct module *module;
Pablo Neira Ayuso80d326f2012-02-24 14:30:15 +0000131 u16 min_dump_alloc;
132};
133
Gao feng6dc878a2012-10-04 20:15:48 +0000134extern int __netlink_dump_start(struct sock *ssk, struct sk_buff *skb,
135 const struct nlmsghdr *nlh,
136 struct netlink_dump_control *control);
137static inline int netlink_dump_start(struct sock *ssk, struct sk_buff *skb,
138 const struct nlmsghdr *nlh,
139 struct netlink_dump_control *control)
140{
141 if (!control->module)
142 control->module = THIS_MODULE;
143
144 return __netlink_dump_start(ssk, skb, nlh, control);
145}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147#endif /* __LINUX_NETLINK_H */