blob: f74dd133788f7c45bbd60175a321d0c26560630c [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 */
Pablo Neira Ayusod16cf202012-05-08 19:45:28 +020010#define NETLINK_FIREWALL 3 /* Unused number, formerly ip_queue */
Pavel Emelyanov7f1fb602011-12-06 07:56:43 +000011#define NETLINK_SOCK_DIAG 4 /* 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
Pavel Emelyanov7f1fb602011-12-06 07:56:43 +000030#define NETLINK_INET_DIAG NETLINK_SOCK_DIAG
31
Linus Torvalds1da177e2005-04-16 15:20:36 -070032#define MAX_LINKS 32
33
Eric Dumazetd94d9fe2009-11-04 09:50:58 -080034struct sockaddr_nl {
David S. Miller6602a4b2011-08-07 22:48:07 -070035 __kernel_sa_family_t nl_family; /* AF_NETLINK */
Linus Torvalds1da177e2005-04-16 15:20:36 -070036 unsigned short nl_pad; /* zero */
Herbert Xucf130cb2007-05-05 11:42:03 -070037 __u32 nl_pid; /* port ID */
Linus Torvalds1da177e2005-04-16 15:20:36 -070038 __u32 nl_groups; /* multicast groups mask */
39};
40
Eric Dumazetd94d9fe2009-11-04 09:50:58 -080041struct nlmsghdr {
Linus Torvalds1da177e2005-04-16 15:20:36 -070042 __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 */
Johannes Berg670dc282011-06-20 13:40:46 +020055#define NLM_F_DUMP_INTR 16 /* Dump was inconsistent due to sequence change */
Linus Torvalds1da177e2005-04-16 15:20:36 -070056
57/* Modifiers to GET request */
58#define NLM_F_ROOT 0x100 /* specify tree root */
59#define NLM_F_MATCH 0x200 /* return all matching */
60#define NLM_F_ATOMIC 0x400 /* atomic GET */
61#define NLM_F_DUMP (NLM_F_ROOT|NLM_F_MATCH)
62
63/* Modifiers to NEW request */
64#define NLM_F_REPLACE 0x100 /* Override existing */
65#define NLM_F_EXCL 0x200 /* Do not touch, if it exists */
66#define NLM_F_CREATE 0x400 /* Create, if it does not exist */
67#define NLM_F_APPEND 0x800 /* Add to end of list */
68
69/*
70 4.4BSD ADD NLM_F_CREATE|NLM_F_EXCL
71 4.4BSD CHANGE NLM_F_REPLACE
72
73 True CHANGE NLM_F_CREATE|NLM_F_REPLACE
74 Append NLM_F_CREATE
75 Check NLM_F_EXCL
76 */
77
Dmitry V. Levin4b8fe662010-12-17 12:03:14 -080078#define NLMSG_ALIGNTO 4U
Linus Torvalds1da177e2005-04-16 15:20:36 -070079#define NLMSG_ALIGN(len) ( ((len)+NLMSG_ALIGNTO-1) & ~(NLMSG_ALIGNTO-1) )
Thomas Grafbfa83a92005-11-10 02:25:51 +010080#define NLMSG_HDRLEN ((int) NLMSG_ALIGN(sizeof(struct nlmsghdr)))
81#define NLMSG_LENGTH(len) ((len)+NLMSG_ALIGN(NLMSG_HDRLEN))
Linus Torvalds1da177e2005-04-16 15:20:36 -070082#define NLMSG_SPACE(len) NLMSG_ALIGN(NLMSG_LENGTH(len))
83#define NLMSG_DATA(nlh) ((void*)(((char*)nlh) + NLMSG_LENGTH(0)))
84#define NLMSG_NEXT(nlh,len) ((len) -= NLMSG_ALIGN((nlh)->nlmsg_len), \
85 (struct nlmsghdr*)(((char*)(nlh)) + NLMSG_ALIGN((nlh)->nlmsg_len)))
86#define NLMSG_OK(nlh,len) ((len) >= (int)sizeof(struct nlmsghdr) && \
87 (nlh)->nlmsg_len >= sizeof(struct nlmsghdr) && \
88 (nlh)->nlmsg_len <= (len))
89#define NLMSG_PAYLOAD(nlh,len) ((nlh)->nlmsg_len - NLMSG_SPACE((len)))
90
91#define NLMSG_NOOP 0x1 /* Nothing. */
92#define NLMSG_ERROR 0x2 /* Error */
93#define NLMSG_DONE 0x3 /* End of a dump */
94#define NLMSG_OVERRUN 0x4 /* Data lost */
95
Thomas Grafbfa83a92005-11-10 02:25:51 +010096#define NLMSG_MIN_TYPE 0x10 /* < 0x10: reserved control messages */
97
Eric Dumazetd94d9fe2009-11-04 09:50:58 -080098struct nlmsgerr {
Linus Torvalds1da177e2005-04-16 15:20:36 -070099 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
Eric Dumazetd94d9fe2009-11-04 09:50:58 -0800109struct nl_pktinfo {
Patrick McHardy9a4595b2005-08-15 12:32:15 -0700110 __u32 group;
111};
112
Linus Torvalds1da177e2005-04-16 15:20:36 -0700113#define NET_MAJOR 36 /* Major 36 is reserved for networking */
114
115enum {
116 NETLINK_UNCONNECTED = 0,
117 NETLINK_CONNECTED,
118};
119
Thomas Grafbfa83a92005-11-10 02:25:51 +0100120/*
121 * <------- NLA_HDRLEN ------> <-- NLA_ALIGN(payload)-->
122 * +---------------------+- - -+- - - - - - - - - -+- - -+
123 * | Header | Pad | Payload | Pad |
124 * | (struct nlattr) | ing | | ing |
125 * +---------------------+- - -+- - - - - - - - - -+- - -+
126 * <-------------- nlattr->nla_len -------------->
127 */
128
Eric Dumazetd94d9fe2009-11-04 09:50:58 -0800129struct nlattr {
Thomas Grafbfa83a92005-11-10 02:25:51 +0100130 __u16 nla_len;
131 __u16 nla_type;
132};
133
Thomas Graf8f4c1f92007-09-12 14:44:36 +0200134/*
135 * nla_type (16 bits)
136 * +---+---+-------------------------------+
137 * | N | O | Attribute Type |
138 * +---+---+-------------------------------+
139 * N := Carries nested attributes
140 * O := Payload stored in network byte order
141 *
142 * Note: The N and O flag are mutually exclusive.
143 */
144#define NLA_F_NESTED (1 << 15)
145#define NLA_F_NET_BYTEORDER (1 << 14)
146#define NLA_TYPE_MASK ~(NLA_F_NESTED | NLA_F_NET_BYTEORDER)
147
Thomas Grafbfa83a92005-11-10 02:25:51 +0100148#define NLA_ALIGNTO 4
149#define NLA_ALIGN(len) (((len) + NLA_ALIGNTO - 1) & ~(NLA_ALIGNTO - 1))
150#define NLA_HDRLEN ((int) NLA_ALIGN(sizeof(struct nlattr)))
151
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152#ifdef __KERNEL__
153
154#include <linux/capability.h>
155#include <linux/skbuff.h>
156
Ollie Wild56b49f42010-09-22 05:54:54 +0000157struct net;
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
Eric Dumazetd94d9fe2009-11-04 09:50:58 -0800164struct netlink_skb_parms {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700165 struct ucred creds; /* Skb credentials */
166 __u32 pid;
Patrick McHardyd629b832005-08-14 19:27:50 -0700167 __u32 dst_group;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168};
169
170#define NETLINK_CB(skb) (*(struct netlink_skb_parms*)&((skb)->cb))
171#define NETLINK_CREDS(skb) (&NETLINK_CB((skb)).creds)
172
173
Johannes Bergd136f1b2009-09-12 03:03:15 +0000174extern void netlink_table_grab(void);
175extern void netlink_table_ungrab(void);
176
Pablo Neira Ayusoa31f2d12012-06-29 06:15:21 +0000177/* optional Netlink kernel configuration parameters */
178struct netlink_kernel_cfg {
179 unsigned int groups;
180 void (*input)(struct sk_buff *skb);
181 struct mutex *cb_mutex;
Pablo Neira Ayuso03292742012-06-29 06:15:22 +0000182 void (*bind)(int group);
Pablo Neira Ayusoa31f2d12012-06-29 06:15:21 +0000183};
184
185extern struct sock *netlink_kernel_create(struct net *net, int unit,
186 struct module *module,
187 struct netlink_kernel_cfg *cfg);
Denis V. Lunevb7c6ba62008-01-28 14:41:19 -0800188extern void netlink_kernel_release(struct sock *sk);
Johannes Bergd136f1b2009-09-12 03:03:15 +0000189extern int __netlink_change_ngroups(struct sock *sk, unsigned int groups);
Johannes Bergb4ff4f02007-07-18 15:46:06 -0700190extern int netlink_change_ngroups(struct sock *sk, unsigned int groups);
Johannes Bergb8273572009-09-24 15:44:05 -0700191extern void __netlink_clear_multicast_users(struct sock *sk, unsigned int group);
Johannes Berg84659eb2007-07-18 15:47:05 -0700192extern void netlink_clear_multicast_users(struct sock *sk, unsigned int group);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193extern void netlink_ack(struct sk_buff *in_skb, struct nlmsghdr *nlh, int err);
Patrick McHardy4277a082006-03-20 18:52:01 -0800194extern int netlink_has_listeners(struct sock *sk, unsigned int group);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195extern int netlink_unicast(struct sock *ssk, struct sk_buff *skb, __u32 pid, int nonblock);
196extern int netlink_broadcast(struct sock *ssk, struct sk_buff *skb, __u32 pid,
Al Virodd0fc662005-10-07 07:46:04 +0100197 __u32 group, gfp_t allocation);
Eric W. Biederman910a7e92010-05-04 17:36:46 -0700198extern int netlink_broadcast_filtered(struct sock *ssk, struct sk_buff *skb,
199 __u32 pid, __u32 group, gfp_t allocation,
200 int (*filter)(struct sock *dsk, struct sk_buff *skb, void *data),
201 void *filter_data);
Pablo Neira Ayuso1a503072010-03-18 14:24:42 +0000202extern int netlink_set_err(struct sock *ssk, __u32 pid, __u32 group, int code);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203extern int netlink_register_notifier(struct notifier_block *nb);
204extern int netlink_unregister_notifier(struct notifier_block *nb);
205
206/* finegrained unicast helpers: */
207struct sock *netlink_getsockbyfilp(struct file *filp);
Denis V. Lunev9457afe2008-06-05 11:23:39 -0700208int netlink_attachskb(struct sock *sk, struct sk_buff *skb,
Patrick McHardyc3d8d1e2007-11-07 02:42:09 -0800209 long *timeo, struct sock *ssk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210void netlink_detachskb(struct sock *sk, struct sk_buff *skb);
Denis V. Lunev7ee015e2007-10-10 21:14:03 -0700211int netlink_sendskb(struct sock *sk, struct sk_buff *skb);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212
213/*
214 * skb should fit one page. This choice is good for headerless malloc.
David S. Millerfc910a22007-03-25 20:27:59 -0700215 * But we should limit to 8K so that userspace does not have to
216 * use enormous buffer sizes on recvmsg() calls just to avoid
217 * MSG_TRUNC when PAGE_SIZE is very large.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218 */
David S. Millerfc910a22007-03-25 20:27:59 -0700219#if PAGE_SIZE < 8192UL
220#define NLMSG_GOODSIZE SKB_WITH_OVERHEAD(PAGE_SIZE)
221#else
222#define NLMSG_GOODSIZE SKB_WITH_OVERHEAD(8192UL)
223#endif
224
Thomas Graf339bf982006-11-10 14:10:15 -0800225#define NLMSG_DEFAULT_SIZE (NLMSG_GOODSIZE - NLMSG_HDRLEN)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226
227
Eric Dumazetd94d9fe2009-11-04 09:50:58 -0800228struct netlink_callback {
Patrick McHardy3a6c2b42009-08-25 16:07:40 +0200229 struct sk_buff *skb;
230 const struct nlmsghdr *nlh;
231 int (*dump)(struct sk_buff * skb,
232 struct netlink_callback *cb);
233 int (*done)(struct netlink_callback *cb);
Pablo Neira Ayuso7175c882012-02-24 14:30:16 +0000234 void *data;
Greg Rosec7ac8672011-06-10 01:27:09 +0000235 u16 family;
236 u16 min_dump_alloc;
Johannes Berg670dc282011-06-20 13:40:46 +0200237 unsigned int prev_seq, seq;
Patrick McHardy3a6c2b42009-08-25 16:07:40 +0200238 long args[6];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700239};
240
Eric Dumazetd94d9fe2009-11-04 09:50:58 -0800241struct netlink_notify {
Eric W. Biedermanb4b51022007-09-12 13:05:38 +0200242 struct net *net;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700243 int pid;
244 int protocol;
245};
246
Denys Vlasenkoa46621a2012-01-30 15:22:06 -0500247struct nlmsghdr *
248__nlmsg_put(struct sk_buff *skb, u32 pid, u32 seq, int type, int len, int flags);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249
Pablo Neira Ayuso80d326f2012-02-24 14:30:15 +0000250struct netlink_dump_control {
251 int (*dump)(struct sk_buff *skb, struct netlink_callback *);
252 int (*done)(struct netlink_callback*);
Pablo Neira Ayuso7175c882012-02-24 14:30:16 +0000253 void *data;
Pablo Neira Ayuso80d326f2012-02-24 14:30:15 +0000254 u16 min_dump_alloc;
255};
256
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257extern int netlink_dump_start(struct sock *ssk, struct sk_buff *skb,
Patrick McHardy3a6c2b42009-08-25 16:07:40 +0200258 const struct nlmsghdr *nlh,
Pablo Neira Ayuso80d326f2012-02-24 14:30:15 +0000259 struct netlink_dump_control *control);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260
261
262#define NL_NONROOT_RECV 0x1
263#define NL_NONROOT_SEND 0x2
264extern void netlink_set_nonroot(int protocol, unsigned flag);
265
266#endif /* __KERNEL__ */
267
268#endif /* __LINUX_NETLINK_H */