blob: 8374d29673625db129e01ba4a13b29761d769688 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001#ifndef __LINUX_NETLINK_H
2#define __LINUX_NETLINK_H
3
Ben Hutchingsbcb949b2011-08-24 18:43:55 +00004#include <linux/socket.h> /* for __kernel_sa_family_t */
Linus Torvalds1da177e2005-04-16 15:20:36 -07005#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
Steffen Klasserta38f7902011-09-27 07:23:50 +020028#define NETLINK_CRYPTO 21 /* Crypto layer */
Linus Torvalds1da177e2005-04-16 15:20:36 -070029
30#define MAX_LINKS 32
31
Eric Dumazetd94d9fe2009-11-04 09:50:58 -080032struct sockaddr_nl {
David S. Miller6602a4b2011-08-07 22:48:07 -070033 __kernel_sa_family_t nl_family; /* AF_NETLINK */
Linus Torvalds1da177e2005-04-16 15:20:36 -070034 unsigned short nl_pad; /* zero */
Herbert Xucf130cb2007-05-05 11:42:03 -070035 __u32 nl_pid; /* port ID */
Linus Torvalds1da177e2005-04-16 15:20:36 -070036 __u32 nl_groups; /* multicast groups mask */
37};
38
Eric Dumazetd94d9fe2009-11-04 09:50:58 -080039struct nlmsghdr {
Linus Torvalds1da177e2005-04-16 15:20:36 -070040 __u32 nlmsg_len; /* Length of message including header */
41 __u16 nlmsg_type; /* Message content */
42 __u16 nlmsg_flags; /* Additional flags */
43 __u32 nlmsg_seq; /* Sequence number */
Herbert Xucf130cb2007-05-05 11:42:03 -070044 __u32 nlmsg_pid; /* Sending process port ID */
Linus Torvalds1da177e2005-04-16 15:20:36 -070045};
46
47/* Flags values */
48
49#define NLM_F_REQUEST 1 /* It is request message. */
50#define NLM_F_MULTI 2 /* Multipart message, terminated by NLMSG_DONE */
51#define NLM_F_ACK 4 /* Reply with ack, with zero or error code */
52#define NLM_F_ECHO 8 /* Echo this request */
Johannes Berg670dc282011-06-20 13:40:46 +020053#define NLM_F_DUMP_INTR 16 /* Dump was inconsistent due to sequence change */
Linus Torvalds1da177e2005-04-16 15:20:36 -070054
55/* Modifiers to GET request */
56#define NLM_F_ROOT 0x100 /* specify tree root */
57#define NLM_F_MATCH 0x200 /* return all matching */
58#define NLM_F_ATOMIC 0x400 /* atomic GET */
59#define NLM_F_DUMP (NLM_F_ROOT|NLM_F_MATCH)
60
61/* Modifiers to NEW request */
62#define NLM_F_REPLACE 0x100 /* Override existing */
63#define NLM_F_EXCL 0x200 /* Do not touch, if it exists */
64#define NLM_F_CREATE 0x400 /* Create, if it does not exist */
65#define NLM_F_APPEND 0x800 /* Add to end of list */
66
67/*
68 4.4BSD ADD NLM_F_CREATE|NLM_F_EXCL
69 4.4BSD CHANGE NLM_F_REPLACE
70
71 True CHANGE NLM_F_CREATE|NLM_F_REPLACE
72 Append NLM_F_CREATE
73 Check NLM_F_EXCL
74 */
75
Dmitry V. Levin4b8fe662010-12-17 12:03:14 -080076#define NLMSG_ALIGNTO 4U
Linus Torvalds1da177e2005-04-16 15:20:36 -070077#define NLMSG_ALIGN(len) ( ((len)+NLMSG_ALIGNTO-1) & ~(NLMSG_ALIGNTO-1) )
Thomas Grafbfa83a92005-11-10 02:25:51 +010078#define NLMSG_HDRLEN ((int) NLMSG_ALIGN(sizeof(struct nlmsghdr)))
79#define NLMSG_LENGTH(len) ((len)+NLMSG_ALIGN(NLMSG_HDRLEN))
Linus Torvalds1da177e2005-04-16 15:20:36 -070080#define NLMSG_SPACE(len) NLMSG_ALIGN(NLMSG_LENGTH(len))
81#define NLMSG_DATA(nlh) ((void*)(((char*)nlh) + NLMSG_LENGTH(0)))
82#define NLMSG_NEXT(nlh,len) ((len) -= NLMSG_ALIGN((nlh)->nlmsg_len), \
83 (struct nlmsghdr*)(((char*)(nlh)) + NLMSG_ALIGN((nlh)->nlmsg_len)))
84#define NLMSG_OK(nlh,len) ((len) >= (int)sizeof(struct nlmsghdr) && \
85 (nlh)->nlmsg_len >= sizeof(struct nlmsghdr) && \
86 (nlh)->nlmsg_len <= (len))
87#define NLMSG_PAYLOAD(nlh,len) ((nlh)->nlmsg_len - NLMSG_SPACE((len)))
88
89#define NLMSG_NOOP 0x1 /* Nothing. */
90#define NLMSG_ERROR 0x2 /* Error */
91#define NLMSG_DONE 0x3 /* End of a dump */
92#define NLMSG_OVERRUN 0x4 /* Data lost */
93
Thomas Grafbfa83a92005-11-10 02:25:51 +010094#define NLMSG_MIN_TYPE 0x10 /* < 0x10: reserved control messages */
95
Eric Dumazetd94d9fe2009-11-04 09:50:58 -080096struct nlmsgerr {
Linus Torvalds1da177e2005-04-16 15:20:36 -070097 int error;
98 struct nlmsghdr msg;
99};
100
Patrick McHardy9a4595b2005-08-15 12:32:15 -0700101#define NETLINK_ADD_MEMBERSHIP 1
102#define NETLINK_DROP_MEMBERSHIP 2
103#define NETLINK_PKTINFO 3
Pablo Neira Ayusobe0c22a2009-02-18 01:40:43 +0000104#define NETLINK_BROADCAST_ERROR 4
Pablo Neira Ayuso38938bf2009-03-24 16:37:55 -0700105#define NETLINK_NO_ENOBUFS 5
Patrick McHardy9a4595b2005-08-15 12:32:15 -0700106
Eric Dumazetd94d9fe2009-11-04 09:50:58 -0800107struct nl_pktinfo {
Patrick McHardy9a4595b2005-08-15 12:32:15 -0700108 __u32 group;
109};
110
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111#define NET_MAJOR 36 /* Major 36 is reserved for networking */
112
113enum {
114 NETLINK_UNCONNECTED = 0,
115 NETLINK_CONNECTED,
116};
117
Thomas Grafbfa83a92005-11-10 02:25:51 +0100118/*
119 * <------- NLA_HDRLEN ------> <-- NLA_ALIGN(payload)-->
120 * +---------------------+- - -+- - - - - - - - - -+- - -+
121 * | Header | Pad | Payload | Pad |
122 * | (struct nlattr) | ing | | ing |
123 * +---------------------+- - -+- - - - - - - - - -+- - -+
124 * <-------------- nlattr->nla_len -------------->
125 */
126
Eric Dumazetd94d9fe2009-11-04 09:50:58 -0800127struct nlattr {
Thomas Grafbfa83a92005-11-10 02:25:51 +0100128 __u16 nla_len;
129 __u16 nla_type;
130};
131
Thomas Graf8f4c1f92007-09-12 14:44:36 +0200132/*
133 * nla_type (16 bits)
134 * +---+---+-------------------------------+
135 * | N | O | Attribute Type |
136 * +---+---+-------------------------------+
137 * N := Carries nested attributes
138 * O := Payload stored in network byte order
139 *
140 * Note: The N and O flag are mutually exclusive.
141 */
142#define NLA_F_NESTED (1 << 15)
143#define NLA_F_NET_BYTEORDER (1 << 14)
144#define NLA_TYPE_MASK ~(NLA_F_NESTED | NLA_F_NET_BYTEORDER)
145
Thomas Grafbfa83a92005-11-10 02:25:51 +0100146#define NLA_ALIGNTO 4
147#define NLA_ALIGN(len) (((len) + NLA_ALIGNTO - 1) & ~(NLA_ALIGNTO - 1))
148#define NLA_HDRLEN ((int) NLA_ALIGN(sizeof(struct nlattr)))
149
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150#ifdef __KERNEL__
151
152#include <linux/capability.h>
153#include <linux/skbuff.h>
154
Ollie Wild56b49f42010-09-22 05:54:54 +0000155struct net;
156
Arnaldo Carvalho de Melob529ccf2007-04-25 19:08:35 -0700157static inline struct nlmsghdr *nlmsg_hdr(const struct sk_buff *skb)
158{
159 return (struct nlmsghdr *)skb->data;
160}
161
Eric Dumazetd94d9fe2009-11-04 09:50:58 -0800162struct netlink_skb_parms {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163 struct ucred creds; /* Skb credentials */
164 __u32 pid;
Patrick McHardyd629b832005-08-14 19:27:50 -0700165 __u32 dst_group;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166};
167
168#define NETLINK_CB(skb) (*(struct netlink_skb_parms*)&((skb)->cb))
169#define NETLINK_CREDS(skb) (&NETLINK_CB((skb)).creds)
170
171
Johannes Bergd136f1b2009-09-12 03:03:15 +0000172extern void netlink_table_grab(void);
173extern void netlink_table_ungrab(void);
174
Eric W. Biedermanb4b51022007-09-12 13:05:38 +0200175extern struct sock *netlink_kernel_create(struct net *net,
176 int unit,unsigned int groups,
Denis V. Lunevcd40b7d2007-10-10 21:15:29 -0700177 void (*input)(struct sk_buff *skb),
Patrick McHardyaf65bdf2007-04-20 14:14:21 -0700178 struct mutex *cb_mutex,
179 struct module *module);
Denis V. Lunevb7c6ba62008-01-28 14:41:19 -0800180extern void netlink_kernel_release(struct sock *sk);
Johannes Bergd136f1b2009-09-12 03:03:15 +0000181extern int __netlink_change_ngroups(struct sock *sk, unsigned int groups);
Johannes Bergb4ff4f02007-07-18 15:46:06 -0700182extern int netlink_change_ngroups(struct sock *sk, unsigned int groups);
Johannes Bergb8273572009-09-24 15:44:05 -0700183extern void __netlink_clear_multicast_users(struct sock *sk, unsigned int group);
Johannes Berg84659eb2007-07-18 15:47:05 -0700184extern void netlink_clear_multicast_users(struct sock *sk, unsigned int group);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185extern void netlink_ack(struct sk_buff *in_skb, struct nlmsghdr *nlh, int err);
Patrick McHardy4277a082006-03-20 18:52:01 -0800186extern int netlink_has_listeners(struct sock *sk, unsigned int group);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187extern int netlink_unicast(struct sock *ssk, struct sk_buff *skb, __u32 pid, int nonblock);
188extern int netlink_broadcast(struct sock *ssk, struct sk_buff *skb, __u32 pid,
Al Virodd0fc662005-10-07 07:46:04 +0100189 __u32 group, gfp_t allocation);
Eric W. Biederman910a7e92010-05-04 17:36:46 -0700190extern int netlink_broadcast_filtered(struct sock *ssk, struct sk_buff *skb,
191 __u32 pid, __u32 group, gfp_t allocation,
192 int (*filter)(struct sock *dsk, struct sk_buff *skb, void *data),
193 void *filter_data);
Pablo Neira Ayuso1a503072010-03-18 14:24:42 +0000194extern int netlink_set_err(struct sock *ssk, __u32 pid, __u32 group, int code);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195extern int netlink_register_notifier(struct notifier_block *nb);
196extern int netlink_unregister_notifier(struct notifier_block *nb);
197
198/* finegrained unicast helpers: */
199struct sock *netlink_getsockbyfilp(struct file *filp);
Denis V. Lunev9457afe2008-06-05 11:23:39 -0700200int netlink_attachskb(struct sock *sk, struct sk_buff *skb,
Patrick McHardyc3d8d1e2007-11-07 02:42:09 -0800201 long *timeo, struct sock *ssk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202void netlink_detachskb(struct sock *sk, struct sk_buff *skb);
Denis V. Lunev7ee015e2007-10-10 21:14:03 -0700203int netlink_sendskb(struct sock *sk, struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204
205/*
206 * skb should fit one page. This choice is good for headerless malloc.
David S. Millerfc910a22007-03-25 20:27:59 -0700207 * But we should limit to 8K so that userspace does not have to
208 * use enormous buffer sizes on recvmsg() calls just to avoid
209 * MSG_TRUNC when PAGE_SIZE is very large.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 */
David S. Millerfc910a22007-03-25 20:27:59 -0700211#if PAGE_SIZE < 8192UL
212#define NLMSG_GOODSIZE SKB_WITH_OVERHEAD(PAGE_SIZE)
213#else
214#define NLMSG_GOODSIZE SKB_WITH_OVERHEAD(8192UL)
215#endif
216
Thomas Graf339bf982006-11-10 14:10:15 -0800217#define NLMSG_DEFAULT_SIZE (NLMSG_GOODSIZE - NLMSG_HDRLEN)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218
219
Eric Dumazetd94d9fe2009-11-04 09:50:58 -0800220struct netlink_callback {
Patrick McHardy3a6c2b42009-08-25 16:07:40 +0200221 struct sk_buff *skb;
222 const struct nlmsghdr *nlh;
223 int (*dump)(struct sk_buff * skb,
224 struct netlink_callback *cb);
225 int (*done)(struct netlink_callback *cb);
Greg Rosec7ac8672011-06-10 01:27:09 +0000226 u16 family;
227 u16 min_dump_alloc;
Johannes Berg670dc282011-06-20 13:40:46 +0200228 unsigned int prev_seq, seq;
Patrick McHardy3a6c2b42009-08-25 16:07:40 +0200229 long args[6];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230};
231
Eric Dumazetd94d9fe2009-11-04 09:50:58 -0800232struct netlink_notify {
Eric W. Biedermanb4b51022007-09-12 13:05:38 +0200233 struct net *net;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 int pid;
235 int protocol;
236};
237
238static __inline__ struct nlmsghdr *
Thomas Graf17977542005-06-18 22:53:48 -0700239__nlmsg_put(struct sk_buff *skb, u32 pid, u32 seq, int type, int len, int flags)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240{
241 struct nlmsghdr *nlh;
242 int size = NLMSG_LENGTH(len);
243
244 nlh = (struct nlmsghdr*)skb_put(skb, NLMSG_ALIGN(size));
245 nlh->nlmsg_type = type;
246 nlh->nlmsg_len = size;
Thomas Graf17977542005-06-18 22:53:48 -0700247 nlh->nlmsg_flags = flags;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248 nlh->nlmsg_pid = pid;
249 nlh->nlmsg_seq = seq;
Patrick McHardy0c19b0a2008-11-20 04:08:29 -0800250 if (!__builtin_constant_p(size) || NLMSG_ALIGN(size) - size != 0)
251 memset(NLMSG_DATA(nlh) + len, 0, NLMSG_ALIGN(size) - size);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 return nlh;
253}
254
Thomas Graf17977542005-06-18 22:53:48 -0700255#define NLMSG_NEW(skb, pid, seq, type, len, flags) \
Patrick McHardyf4d900a2007-12-05 03:31:53 -0800256({ if (unlikely(skb_tailroom(skb) < (int)NLMSG_SPACE(len))) \
Thomas Graff88a10d2005-06-18 22:50:12 -0700257 goto nlmsg_failure; \
Thomas Graf17977542005-06-18 22:53:48 -0700258 __nlmsg_put(skb, pid, seq, type, len, flags); })
Thomas Graff88a10d2005-06-18 22:50:12 -0700259
Thomas Graf17977542005-06-18 22:53:48 -0700260#define NLMSG_PUT(skb, pid, seq, type, len) \
261 NLMSG_NEW(skb, pid, seq, type, len, 0)
262
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263extern int netlink_dump_start(struct sock *ssk, struct sk_buff *skb,
Patrick McHardy3a6c2b42009-08-25 16:07:40 +0200264 const struct nlmsghdr *nlh,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265 int (*dump)(struct sk_buff *skb, struct netlink_callback*),
Greg Rosec7ac8672011-06-10 01:27:09 +0000266 int (*done)(struct netlink_callback*),
267 u16 min_dump_alloc);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268
269
270#define NL_NONROOT_RECV 0x1
271#define NL_NONROOT_SEND 0x2
272extern void netlink_set_nonroot(int protocol, unsigned flag);
273
274#endif /* __KERNEL__ */
275
276#endif /* __LINUX_NETLINK_H */