blob: ab5d3126831f106394632bdfdfc6ad1d531daa8f [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
Linus Torvalds1da177e2005-04-16 15:20:36 -070027
28#define MAX_LINKS 32
29
Eric W. Biedermanb4b51022007-09-12 13:05:38 +020030struct net;
31
Linus Torvalds1da177e2005-04-16 15:20:36 -070032struct sockaddr_nl
33{
34 sa_family_t nl_family; /* AF_NETLINK */
35 unsigned short nl_pad; /* zero */
Herbert Xucf130cb2007-05-05 11:42:03 -070036 __u32 nl_pid; /* port ID */
Linus Torvalds1da177e2005-04-16 15:20:36 -070037 __u32 nl_groups; /* multicast groups mask */
38};
39
40struct nlmsghdr
41{
42 __u32 nlmsg_len; /* Length of message including header */
43 __u16 nlmsg_type; /* Message content */
44 __u16 nlmsg_flags; /* Additional flags */
45 __u32 nlmsg_seq; /* Sequence number */
Herbert Xucf130cb2007-05-05 11:42:03 -070046 __u32 nlmsg_pid; /* Sending process port ID */
Linus Torvalds1da177e2005-04-16 15:20:36 -070047};
48
49/* Flags values */
50
51#define NLM_F_REQUEST 1 /* It is request message. */
52#define NLM_F_MULTI 2 /* Multipart message, terminated by NLMSG_DONE */
53#define NLM_F_ACK 4 /* Reply with ack, with zero or error code */
54#define NLM_F_ECHO 8 /* Echo this request */
55
56/* Modifiers to GET request */
57#define NLM_F_ROOT 0x100 /* specify tree root */
58#define NLM_F_MATCH 0x200 /* return all matching */
59#define NLM_F_ATOMIC 0x400 /* atomic GET */
60#define NLM_F_DUMP (NLM_F_ROOT|NLM_F_MATCH)
61
62/* Modifiers to NEW request */
63#define NLM_F_REPLACE 0x100 /* Override existing */
64#define NLM_F_EXCL 0x200 /* Do not touch, if it exists */
65#define NLM_F_CREATE 0x400 /* Create, if it does not exist */
66#define NLM_F_APPEND 0x800 /* Add to end of list */
67
68/*
69 4.4BSD ADD NLM_F_CREATE|NLM_F_EXCL
70 4.4BSD CHANGE NLM_F_REPLACE
71
72 True CHANGE NLM_F_CREATE|NLM_F_REPLACE
73 Append NLM_F_CREATE
74 Check NLM_F_EXCL
75 */
76
77#define NLMSG_ALIGNTO 4
78#define NLMSG_ALIGN(len) ( ((len)+NLMSG_ALIGNTO-1) & ~(NLMSG_ALIGNTO-1) )
Thomas Grafbfa83a92005-11-10 02:25:51 +010079#define NLMSG_HDRLEN ((int) NLMSG_ALIGN(sizeof(struct nlmsghdr)))
80#define NLMSG_LENGTH(len) ((len)+NLMSG_ALIGN(NLMSG_HDRLEN))
Linus Torvalds1da177e2005-04-16 15:20:36 -070081#define NLMSG_SPACE(len) NLMSG_ALIGN(NLMSG_LENGTH(len))
82#define NLMSG_DATA(nlh) ((void*)(((char*)nlh) + NLMSG_LENGTH(0)))
83#define NLMSG_NEXT(nlh,len) ((len) -= NLMSG_ALIGN((nlh)->nlmsg_len), \
84 (struct nlmsghdr*)(((char*)(nlh)) + NLMSG_ALIGN((nlh)->nlmsg_len)))
85#define NLMSG_OK(nlh,len) ((len) >= (int)sizeof(struct nlmsghdr) && \
86 (nlh)->nlmsg_len >= sizeof(struct nlmsghdr) && \
87 (nlh)->nlmsg_len <= (len))
88#define NLMSG_PAYLOAD(nlh,len) ((nlh)->nlmsg_len - NLMSG_SPACE((len)))
89
90#define NLMSG_NOOP 0x1 /* Nothing. */
91#define NLMSG_ERROR 0x2 /* Error */
92#define NLMSG_DONE 0x3 /* End of a dump */
93#define NLMSG_OVERRUN 0x4 /* Data lost */
94
Thomas Grafbfa83a92005-11-10 02:25:51 +010095#define NLMSG_MIN_TYPE 0x10 /* < 0x10: reserved control messages */
96
Linus Torvalds1da177e2005-04-16 15:20:36 -070097struct nlmsgerr
98{
99 int error;
100 struct nlmsghdr msg;
101};
102
Patrick McHardy9a4595b2005-08-15 12:32:15 -0700103#define NETLINK_ADD_MEMBERSHIP 1
104#define NETLINK_DROP_MEMBERSHIP 2
105#define NETLINK_PKTINFO 3
Pablo Neira Ayusobe0c22a2009-02-18 01:40:43 +0000106#define NETLINK_BROADCAST_ERROR 4
Pablo Neira Ayuso38938bf2009-03-24 16:37:55 -0700107#define NETLINK_NO_ENOBUFS 5
Patrick McHardy9a4595b2005-08-15 12:32:15 -0700108
109struct nl_pktinfo
110{
111 __u32 group;
112};
113
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114#define NET_MAJOR 36 /* Major 36 is reserved for networking */
115
116enum {
117 NETLINK_UNCONNECTED = 0,
118 NETLINK_CONNECTED,
119};
120
Thomas Grafbfa83a92005-11-10 02:25:51 +0100121/*
122 * <------- NLA_HDRLEN ------> <-- NLA_ALIGN(payload)-->
123 * +---------------------+- - -+- - - - - - - - - -+- - -+
124 * | Header | Pad | Payload | Pad |
125 * | (struct nlattr) | ing | | ing |
126 * +---------------------+- - -+- - - - - - - - - -+- - -+
127 * <-------------- nlattr->nla_len -------------->
128 */
129
130struct nlattr
131{
132 __u16 nla_len;
133 __u16 nla_type;
134};
135
Thomas Graf8f4c1f92007-09-12 14:44:36 +0200136/*
137 * nla_type (16 bits)
138 * +---+---+-------------------------------+
139 * | N | O | Attribute Type |
140 * +---+---+-------------------------------+
141 * N := Carries nested attributes
142 * O := Payload stored in network byte order
143 *
144 * Note: The N and O flag are mutually exclusive.
145 */
146#define NLA_F_NESTED (1 << 15)
147#define NLA_F_NET_BYTEORDER (1 << 14)
148#define NLA_TYPE_MASK ~(NLA_F_NESTED | NLA_F_NET_BYTEORDER)
149
Thomas Grafbfa83a92005-11-10 02:25:51 +0100150#define NLA_ALIGNTO 4
151#define NLA_ALIGN(len) (((len) + NLA_ALIGNTO - 1) & ~(NLA_ALIGNTO - 1))
152#define NLA_HDRLEN ((int) NLA_ALIGN(sizeof(struct nlattr)))
153
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154#ifdef __KERNEL__
155
156#include <linux/capability.h>
157#include <linux/skbuff.h>
158
Arnaldo Carvalho de Melob529ccf2007-04-25 19:08:35 -0700159static inline struct nlmsghdr *nlmsg_hdr(const struct sk_buff *skb)
160{
161 return (struct nlmsghdr *)skb->data;
162}
163
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164struct netlink_skb_parms
165{
166 struct ucred creds; /* Skb credentials */
167 __u32 pid;
Patrick McHardyd629b832005-08-14 19:27:50 -0700168 __u32 dst_group;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700169 kernel_cap_t eff_cap;
Serge Hallync94c2572005-04-29 16:27:17 +0100170 __u32 loginuid; /* Login (audit) uid */
Eric Paris25323862008-04-18 10:09:25 -0400171 __u32 sessionid; /* Session id (audit) */
Steve Grubbe7c34972006-04-03 09:08:13 -0400172 __u32 sid; /* SELinux security id */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173};
174
175#define NETLINK_CB(skb) (*(struct netlink_skb_parms*)&((skb)->cb))
176#define NETLINK_CREDS(skb) (&NETLINK_CB((skb)).creds)
177
178
Johannes Bergd136f1b2009-09-12 03:03:15 +0000179extern void netlink_table_grab(void);
180extern void netlink_table_ungrab(void);
181
Eric W. Biedermanb4b51022007-09-12 13:05:38 +0200182extern struct sock *netlink_kernel_create(struct net *net,
183 int unit,unsigned int groups,
Denis V. Lunevcd40b7d2007-10-10 21:15:29 -0700184 void (*input)(struct sk_buff *skb),
Patrick McHardyaf65bdf2007-04-20 14:14:21 -0700185 struct mutex *cb_mutex,
186 struct module *module);
Denis V. Lunevb7c6ba62008-01-28 14:41:19 -0800187extern void netlink_kernel_release(struct sock *sk);
Johannes Bergd136f1b2009-09-12 03:03:15 +0000188extern int __netlink_change_ngroups(struct sock *sk, unsigned int groups);
Johannes Bergb4ff4f02007-07-18 15:46:06 -0700189extern int netlink_change_ngroups(struct sock *sk, unsigned int groups);
Johannes Bergb8273572009-09-24 15:44:05 -0700190extern void __netlink_clear_multicast_users(struct sock *sk, unsigned int group);
Johannes Berg84659eb2007-07-18 15:47:05 -0700191extern void netlink_clear_multicast_users(struct sock *sk, unsigned int group);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700192extern void netlink_ack(struct sk_buff *in_skb, struct nlmsghdr *nlh, int err);
Patrick McHardy4277a082006-03-20 18:52:01 -0800193extern int netlink_has_listeners(struct sock *sk, unsigned int group);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194extern int netlink_unicast(struct sock *ssk, struct sk_buff *skb, __u32 pid, int nonblock);
195extern int netlink_broadcast(struct sock *ssk, struct sk_buff *skb, __u32 pid,
Al Virodd0fc662005-10-07 07:46:04 +0100196 __u32 group, gfp_t allocation);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197extern void netlink_set_err(struct sock *ssk, __u32 pid, __u32 group, int code);
198extern int netlink_register_notifier(struct notifier_block *nb);
199extern int netlink_unregister_notifier(struct notifier_block *nb);
200
201/* finegrained unicast helpers: */
202struct sock *netlink_getsockbyfilp(struct file *filp);
Denis V. Lunev9457afe2008-06-05 11:23:39 -0700203int netlink_attachskb(struct sock *sk, struct sk_buff *skb,
Patrick McHardyc3d8d1e2007-11-07 02:42:09 -0800204 long *timeo, struct sock *ssk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205void netlink_detachskb(struct sock *sk, struct sk_buff *skb);
Denis V. Lunev7ee015e2007-10-10 21:14:03 -0700206int netlink_sendskb(struct sock *sk, struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207
208/*
209 * skb should fit one page. This choice is good for headerless malloc.
David S. Millerfc910a22007-03-25 20:27:59 -0700210 * But we should limit to 8K so that userspace does not have to
211 * use enormous buffer sizes on recvmsg() calls just to avoid
212 * MSG_TRUNC when PAGE_SIZE is very large.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213 */
David S. Millerfc910a22007-03-25 20:27:59 -0700214#if PAGE_SIZE < 8192UL
215#define NLMSG_GOODSIZE SKB_WITH_OVERHEAD(PAGE_SIZE)
216#else
217#define NLMSG_GOODSIZE SKB_WITH_OVERHEAD(8192UL)
218#endif
219
Thomas Graf339bf982006-11-10 14:10:15 -0800220#define NLMSG_DEFAULT_SIZE (NLMSG_GOODSIZE - NLMSG_HDRLEN)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221
222
223struct netlink_callback
224{
Patrick McHardy3a6c2b42009-08-25 16:07:40 +0200225 struct sk_buff *skb;
226 const struct nlmsghdr *nlh;
227 int (*dump)(struct sk_buff * skb,
228 struct netlink_callback *cb);
229 int (*done)(struct netlink_callback *cb);
230 int family;
231 long args[6];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232};
233
234struct netlink_notify
235{
Eric W. Biedermanb4b51022007-09-12 13:05:38 +0200236 struct net *net;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237 int pid;
238 int protocol;
239};
240
241static __inline__ struct nlmsghdr *
Thomas Graf17977542005-06-18 22:53:48 -0700242__nlmsg_put(struct sk_buff *skb, u32 pid, u32 seq, int type, int len, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243{
244 struct nlmsghdr *nlh;
245 int size = NLMSG_LENGTH(len);
246
247 nlh = (struct nlmsghdr*)skb_put(skb, NLMSG_ALIGN(size));
248 nlh->nlmsg_type = type;
249 nlh->nlmsg_len = size;
Thomas Graf17977542005-06-18 22:53:48 -0700250 nlh->nlmsg_flags = flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251 nlh->nlmsg_pid = pid;
252 nlh->nlmsg_seq = seq;
Patrick McHardy0c19b0a2008-11-20 04:08:29 -0800253 if (!__builtin_constant_p(size) || NLMSG_ALIGN(size) - size != 0)
254 memset(NLMSG_DATA(nlh) + len, 0, NLMSG_ALIGN(size) - size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 return nlh;
256}
257
Thomas Graf17977542005-06-18 22:53:48 -0700258#define NLMSG_NEW(skb, pid, seq, type, len, flags) \
Patrick McHardyf4d900a2007-12-05 03:31:53 -0800259({ if (unlikely(skb_tailroom(skb) < (int)NLMSG_SPACE(len))) \
Thomas Graff88a10d2005-06-18 22:50:12 -0700260 goto nlmsg_failure; \
Thomas Graf17977542005-06-18 22:53:48 -0700261 __nlmsg_put(skb, pid, seq, type, len, flags); })
Thomas Graff88a10d2005-06-18 22:50:12 -0700262
Thomas Graf17977542005-06-18 22:53:48 -0700263#define NLMSG_PUT(skb, pid, seq, type, len) \
264 NLMSG_NEW(skb, pid, seq, type, len, 0)
265
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266extern int netlink_dump_start(struct sock *ssk, struct sk_buff *skb,
Patrick McHardy3a6c2b42009-08-25 16:07:40 +0200267 const struct nlmsghdr *nlh,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 int (*dump)(struct sk_buff *skb, struct netlink_callback*),
269 int (*done)(struct netlink_callback*));
270
271
272#define NL_NONROOT_RECV 0x1
273#define NL_NONROOT_SEND 0x2
274extern void netlink_set_nonroot(int protocol, unsigned flag);
275
276#endif /* __KERNEL__ */
277
278#endif /* __LINUX_NETLINK_H */