blob: a9dd89552f9c61e804249e5b21d2504251925f2f [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef __LINUX_NETLINK_H
2#define __LINUX_NETLINK_H
3
4#include <linux/socket.h> /* for sa_family_t */
5#include <linux/types.h>
6
7#define NETLINK_ROUTE 0 /* Routing/device hook */
Evgeniy Polyakovbb5427b2006-03-23 19:11:58 +03008#define NETLINK_UNUSED 1 /* Unused number */
Linus Torvalds1da177e2005-04-16 15:20:36 -07009#define NETLINK_USERSOCK 2 /* Reserved for user mode socket protocols */
10#define NETLINK_FIREWALL 3 /* Firewalling hook */
Arnaldo Carvalho de Melo73c1f4a2005-08-12 12:51:49 -030011#define NETLINK_INET_DIAG 4 /* INET socket monitoring */
Linus Torvalds1da177e2005-04-16 15:20:36 -070012#define NETLINK_NFLOG 5 /* netfilter/iptables ULOG */
13#define NETLINK_XFRM 6 /* ipsec */
14#define NETLINK_SELINUX 7 /* SELinux event notifications */
David S. Miller4d479e42005-08-08 13:48:02 -070015#define NETLINK_ISCSI 8 /* Open-iSCSI */
Linus Torvalds1da177e2005-04-16 15:20:36 -070016#define NETLINK_AUDIT 9 /* auditing */
Robert Olsson246955f2005-06-20 13:36:39 -070017#define NETLINK_FIB_LOOKUP 10
Evgeniy Polyakov7672d0b2005-09-11 19:15:07 -070018#define NETLINK_CONNECTOR 11
David S. Miller63522f72005-07-11 14:29:11 -070019#define NETLINK_NETFILTER 12 /* netfilter subsystem */
Linus Torvalds1da177e2005-04-16 15:20:36 -070020#define NETLINK_IP6_FW 13
21#define NETLINK_DNRTMSG 14 /* DECnet routing messages */
22#define NETLINK_KOBJECT_UEVENT 15 /* Kernel messages to userspace */
David S. Miller20ae9752005-09-14 20:52:37 -070023#define NETLINK_GENERIC 16
James Smart84314fd2006-08-18 17:30:09 -040024/* leave room for NETLINK_DM (DM Events) */
25#define NETLINK_SCSITRANSPORT 18 /* SCSI Transports */
Michael Halcrow88b4a072007-02-12 00:53:43 -080026#define NETLINK_ECRYPTFS 19
Roland Dreierb2cbae22011-05-20 11:46:11 -070027#define NETLINK_RDMA 20
Linus Torvalds1da177e2005-04-16 15:20:36 -070028
29#define MAX_LINKS 32
30
Eric Dumazetd94d9fe2009-11-04 09:50:58 -080031struct sockaddr_nl {
Linus Torvalds1da177e2005-04-16 15:20:36 -070032 sa_family_t nl_family; /* AF_NETLINK */
33 unsigned short nl_pad; /* zero */
Herbert Xucf130cb2007-05-05 11:42:03 -070034 __u32 nl_pid; /* port ID */
Linus Torvalds1da177e2005-04-16 15:20:36 -070035 __u32 nl_groups; /* multicast groups mask */
36};
37
Eric Dumazetd94d9fe2009-11-04 09:50:58 -080038struct nlmsghdr {
Linus Torvalds1da177e2005-04-16 15:20:36 -070039 __u32 nlmsg_len; /* Length of message including header */
40 __u16 nlmsg_type; /* Message content */
41 __u16 nlmsg_flags; /* Additional flags */
42 __u32 nlmsg_seq; /* Sequence number */
Herbert Xucf130cb2007-05-05 11:42:03 -070043 __u32 nlmsg_pid; /* Sending process port ID */
Linus Torvalds1da177e2005-04-16 15:20:36 -070044};
45
46/* Flags values */
47
48#define NLM_F_REQUEST 1 /* It is request message. */
49#define NLM_F_MULTI 2 /* Multipart message, terminated by NLMSG_DONE */
50#define NLM_F_ACK 4 /* Reply with ack, with zero or error code */
51#define NLM_F_ECHO 8 /* Echo this request */
52
53/* Modifiers to GET request */
54#define NLM_F_ROOT 0x100 /* specify tree root */
55#define NLM_F_MATCH 0x200 /* return all matching */
56#define NLM_F_ATOMIC 0x400 /* atomic GET */
57#define NLM_F_DUMP (NLM_F_ROOT|NLM_F_MATCH)
58
59/* Modifiers to NEW request */
60#define NLM_F_REPLACE 0x100 /* Override existing */
61#define NLM_F_EXCL 0x200 /* Do not touch, if it exists */
62#define NLM_F_CREATE 0x400 /* Create, if it does not exist */
63#define NLM_F_APPEND 0x800 /* Add to end of list */
64
65/*
66 4.4BSD ADD NLM_F_CREATE|NLM_F_EXCL
67 4.4BSD CHANGE NLM_F_REPLACE
68
69 True CHANGE NLM_F_CREATE|NLM_F_REPLACE
70 Append NLM_F_CREATE
71 Check NLM_F_EXCL
72 */
73
Dmitry V. Levin4b8fe662010-12-17 12:03:14 -080074#define NLMSG_ALIGNTO 4U
Linus Torvalds1da177e2005-04-16 15:20:36 -070075#define NLMSG_ALIGN(len) ( ((len)+NLMSG_ALIGNTO-1) & ~(NLMSG_ALIGNTO-1) )
Thomas Grafbfa83a92005-11-10 02:25:51 +010076#define NLMSG_HDRLEN ((int) NLMSG_ALIGN(sizeof(struct nlmsghdr)))
77#define NLMSG_LENGTH(len) ((len)+NLMSG_ALIGN(NLMSG_HDRLEN))
Linus Torvalds1da177e2005-04-16 15:20:36 -070078#define NLMSG_SPACE(len) NLMSG_ALIGN(NLMSG_LENGTH(len))
79#define NLMSG_DATA(nlh) ((void*)(((char*)nlh) + NLMSG_LENGTH(0)))
80#define NLMSG_NEXT(nlh,len) ((len) -= NLMSG_ALIGN((nlh)->nlmsg_len), \
81 (struct nlmsghdr*)(((char*)(nlh)) + NLMSG_ALIGN((nlh)->nlmsg_len)))
82#define NLMSG_OK(nlh,len) ((len) >= (int)sizeof(struct nlmsghdr) && \
83 (nlh)->nlmsg_len >= sizeof(struct nlmsghdr) && \
84 (nlh)->nlmsg_len <= (len))
85#define NLMSG_PAYLOAD(nlh,len) ((nlh)->nlmsg_len - NLMSG_SPACE((len)))
86
87#define NLMSG_NOOP 0x1 /* Nothing. */
88#define NLMSG_ERROR 0x2 /* Error */
89#define NLMSG_DONE 0x3 /* End of a dump */
90#define NLMSG_OVERRUN 0x4 /* Data lost */
91
Thomas Grafbfa83a92005-11-10 02:25:51 +010092#define NLMSG_MIN_TYPE 0x10 /* < 0x10: reserved control messages */
93
Eric Dumazetd94d9fe2009-11-04 09:50:58 -080094struct nlmsgerr {
Linus Torvalds1da177e2005-04-16 15:20:36 -070095 int error;
96 struct nlmsghdr msg;
97};
98
Patrick McHardy9a4595b2005-08-15 12:32:15 -070099#define NETLINK_ADD_MEMBERSHIP 1
100#define NETLINK_DROP_MEMBERSHIP 2
101#define NETLINK_PKTINFO 3
Pablo Neira Ayusobe0c22a2009-02-18 01:40:43 +0000102#define NETLINK_BROADCAST_ERROR 4
Pablo Neira Ayuso38938bf2009-03-24 16:37:55 -0700103#define NETLINK_NO_ENOBUFS 5
Patrick McHardy9a4595b2005-08-15 12:32:15 -0700104
Eric Dumazetd94d9fe2009-11-04 09:50:58 -0800105struct nl_pktinfo {
Patrick McHardy9a4595b2005-08-15 12:32:15 -0700106 __u32 group;
107};
108
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109#define NET_MAJOR 36 /* Major 36 is reserved for networking */
110
111enum {
112 NETLINK_UNCONNECTED = 0,
113 NETLINK_CONNECTED,
114};
115
Thomas Grafbfa83a92005-11-10 02:25:51 +0100116/*
117 * <------- NLA_HDRLEN ------> <-- NLA_ALIGN(payload)-->
118 * +---------------------+- - -+- - - - - - - - - -+- - -+
119 * | Header | Pad | Payload | Pad |
120 * | (struct nlattr) | ing | | ing |
121 * +---------------------+- - -+- - - - - - - - - -+- - -+
122 * <-------------- nlattr->nla_len -------------->
123 */
124
Eric Dumazetd94d9fe2009-11-04 09:50:58 -0800125struct nlattr {
Thomas Grafbfa83a92005-11-10 02:25:51 +0100126 __u16 nla_len;
127 __u16 nla_type;
128};
129
Thomas Graf8f4c1f92007-09-12 14:44:36 +0200130/*
131 * nla_type (16 bits)
132 * +---+---+-------------------------------+
133 * | N | O | Attribute Type |
134 * +---+---+-------------------------------+
135 * N := Carries nested attributes
136 * O := Payload stored in network byte order
137 *
138 * Note: The N and O flag are mutually exclusive.
139 */
140#define NLA_F_NESTED (1 << 15)
141#define NLA_F_NET_BYTEORDER (1 << 14)
142#define NLA_TYPE_MASK ~(NLA_F_NESTED | NLA_F_NET_BYTEORDER)
143
Thomas Grafbfa83a92005-11-10 02:25:51 +0100144#define NLA_ALIGNTO 4
145#define NLA_ALIGN(len) (((len) + NLA_ALIGNTO - 1) & ~(NLA_ALIGNTO - 1))
146#define NLA_HDRLEN ((int) NLA_ALIGN(sizeof(struct nlattr)))
147
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148#ifdef __KERNEL__
149
150#include <linux/capability.h>
151#include <linux/skbuff.h>
152
Ollie Wild56b49f42010-09-22 05:54:54 +0000153struct net;
154
Arnaldo Carvalho de Melob529ccf2007-04-25 19:08:35 -0700155static inline struct nlmsghdr *nlmsg_hdr(const struct sk_buff *skb)
156{
157 return (struct nlmsghdr *)skb->data;
158}
159
Eric Dumazetd94d9fe2009-11-04 09:50:58 -0800160struct netlink_skb_parms {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 struct ucred creds; /* Skb credentials */
162 __u32 pid;
Patrick McHardyd629b832005-08-14 19:27:50 -0700163 __u32 dst_group;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164};
165
166#define NETLINK_CB(skb) (*(struct netlink_skb_parms*)&((skb)->cb))
167#define NETLINK_CREDS(skb) (&NETLINK_CB((skb)).creds)
168
169
Johannes Bergd136f1b2009-09-12 03:03:15 +0000170extern void netlink_table_grab(void);
171extern void netlink_table_ungrab(void);
172
Eric W. Biedermanb4b51022007-09-12 13:05:38 +0200173extern struct sock *netlink_kernel_create(struct net *net,
174 int unit,unsigned int groups,
Denis V. Lunevcd40b7d2007-10-10 21:15:29 -0700175 void (*input)(struct sk_buff *skb),
Patrick McHardyaf65bdf2007-04-20 14:14:21 -0700176 struct mutex *cb_mutex,
177 struct module *module);
Denis V. Lunevb7c6ba62008-01-28 14:41:19 -0800178extern void netlink_kernel_release(struct sock *sk);
Johannes Bergd136f1b2009-09-12 03:03:15 +0000179extern int __netlink_change_ngroups(struct sock *sk, unsigned int groups);
Johannes Bergb4ff4f02007-07-18 15:46:06 -0700180extern int netlink_change_ngroups(struct sock *sk, unsigned int groups);
Johannes Bergb8273572009-09-24 15:44:05 -0700181extern void __netlink_clear_multicast_users(struct sock *sk, unsigned int group);
Johannes Berg84659eb2007-07-18 15:47:05 -0700182extern void netlink_clear_multicast_users(struct sock *sk, unsigned int group);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183extern void netlink_ack(struct sk_buff *in_skb, struct nlmsghdr *nlh, int err);
Patrick McHardy4277a082006-03-20 18:52:01 -0800184extern int netlink_has_listeners(struct sock *sk, unsigned int group);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185extern int netlink_unicast(struct sock *ssk, struct sk_buff *skb, __u32 pid, int nonblock);
186extern int netlink_broadcast(struct sock *ssk, struct sk_buff *skb, __u32 pid,
Al Virodd0fc662005-10-07 07:46:04 +0100187 __u32 group, gfp_t allocation);
Eric W. Biederman910a7e92010-05-04 17:36:46 -0700188extern int netlink_broadcast_filtered(struct sock *ssk, struct sk_buff *skb,
189 __u32 pid, __u32 group, gfp_t allocation,
190 int (*filter)(struct sock *dsk, struct sk_buff *skb, void *data),
191 void *filter_data);
Pablo Neira Ayuso1a503072010-03-18 14:24:42 +0000192extern int netlink_set_err(struct sock *ssk, __u32 pid, __u32 group, int code);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193extern int netlink_register_notifier(struct notifier_block *nb);
194extern int netlink_unregister_notifier(struct notifier_block *nb);
195
196/* finegrained unicast helpers: */
197struct sock *netlink_getsockbyfilp(struct file *filp);
Denis V. Lunev9457afe2008-06-05 11:23:39 -0700198int netlink_attachskb(struct sock *sk, struct sk_buff *skb,
Patrick McHardyc3d8d1e2007-11-07 02:42:09 -0800199 long *timeo, struct sock *ssk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200void netlink_detachskb(struct sock *sk, struct sk_buff *skb);
Denis V. Lunev7ee015e2007-10-10 21:14:03 -0700201int netlink_sendskb(struct sock *sk, struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202
203/*
204 * skb should fit one page. This choice is good for headerless malloc.
David S. Millerfc910a22007-03-25 20:27:59 -0700205 * But we should limit to 8K so that userspace does not have to
206 * use enormous buffer sizes on recvmsg() calls just to avoid
207 * MSG_TRUNC when PAGE_SIZE is very large.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208 */
David S. Millerfc910a22007-03-25 20:27:59 -0700209#if PAGE_SIZE < 8192UL
210#define NLMSG_GOODSIZE SKB_WITH_OVERHEAD(PAGE_SIZE)
211#else
212#define NLMSG_GOODSIZE SKB_WITH_OVERHEAD(8192UL)
213#endif
214
Thomas Graf339bf982006-11-10 14:10:15 -0800215#define NLMSG_DEFAULT_SIZE (NLMSG_GOODSIZE - NLMSG_HDRLEN)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700216
217
Eric Dumazetd94d9fe2009-11-04 09:50:58 -0800218struct netlink_callback {
Patrick McHardy3a6c2b42009-08-25 16:07:40 +0200219 struct sk_buff *skb;
220 const struct nlmsghdr *nlh;
221 int (*dump)(struct sk_buff * skb,
222 struct netlink_callback *cb);
223 int (*done)(struct netlink_callback *cb);
224 int family;
225 long args[6];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226};
227
Eric Dumazetd94d9fe2009-11-04 09:50:58 -0800228struct netlink_notify {
Eric W. Biedermanb4b51022007-09-12 13:05:38 +0200229 struct net *net;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 int pid;
231 int protocol;
232};
233
234static __inline__ struct nlmsghdr *
Thomas Graf17977542005-06-18 22:53:48 -0700235__nlmsg_put(struct sk_buff *skb, u32 pid, u32 seq, int type, int len, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236{
237 struct nlmsghdr *nlh;
238 int size = NLMSG_LENGTH(len);
239
240 nlh = (struct nlmsghdr*)skb_put(skb, NLMSG_ALIGN(size));
241 nlh->nlmsg_type = type;
242 nlh->nlmsg_len = size;
Thomas Graf17977542005-06-18 22:53:48 -0700243 nlh->nlmsg_flags = flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244 nlh->nlmsg_pid = pid;
245 nlh->nlmsg_seq = seq;
Patrick McHardy0c19b0a2008-11-20 04:08:29 -0800246 if (!__builtin_constant_p(size) || NLMSG_ALIGN(size) - size != 0)
247 memset(NLMSG_DATA(nlh) + len, 0, NLMSG_ALIGN(size) - size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248 return nlh;
249}
250
Thomas Graf17977542005-06-18 22:53:48 -0700251#define NLMSG_NEW(skb, pid, seq, type, len, flags) \
Patrick McHardyf4d900a2007-12-05 03:31:53 -0800252({ if (unlikely(skb_tailroom(skb) < (int)NLMSG_SPACE(len))) \
Thomas Graff88a10d2005-06-18 22:50:12 -0700253 goto nlmsg_failure; \
Thomas Graf17977542005-06-18 22:53:48 -0700254 __nlmsg_put(skb, pid, seq, type, len, flags); })
Thomas Graff88a10d2005-06-18 22:50:12 -0700255
Thomas Graf17977542005-06-18 22:53:48 -0700256#define NLMSG_PUT(skb, pid, seq, type, len) \
257 NLMSG_NEW(skb, pid, seq, type, len, 0)
258
Linus Torvalds1da177e2005-04-16 15:20:36 -0700259extern int netlink_dump_start(struct sock *ssk, struct sk_buff *skb,
Patrick McHardy3a6c2b42009-08-25 16:07:40 +0200260 const struct nlmsghdr *nlh,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261 int (*dump)(struct sk_buff *skb, struct netlink_callback*),
262 int (*done)(struct netlink_callback*));
263
264
265#define NL_NONROOT_RECV 0x1
266#define NL_NONROOT_SEND 0x2
267extern void netlink_set_nonroot(int protocol, unsigned flag);
268
269#endif /* __KERNEL__ */
270
271#endif /* __LINUX_NETLINK_H */