RDMA: Add netlink infrastructure
[deliverable/linux.git] / include / linux / netlink.h
CommitLineData
1da177e4
LT
1#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 */
bb5427b5 8#define NETLINK_UNUSED 1 /* Unused number */
1da177e4
LT
9#define NETLINK_USERSOCK 2 /* Reserved for user mode socket protocols */
10#define NETLINK_FIREWALL 3 /* Firewalling hook */
73c1f4a0 11#define NETLINK_INET_DIAG 4 /* INET socket monitoring */
1da177e4
LT
12#define NETLINK_NFLOG 5 /* netfilter/iptables ULOG */
13#define NETLINK_XFRM 6 /* ipsec */
14#define NETLINK_SELINUX 7 /* SELinux event notifications */
4d479e40 15#define NETLINK_ISCSI 8 /* Open-iSCSI */
1da177e4 16#define NETLINK_AUDIT 9 /* auditing */
246955fe 17#define NETLINK_FIB_LOOKUP 10
7672d0b5 18#define NETLINK_CONNECTOR 11
63522f7f 19#define NETLINK_NETFILTER 12 /* netfilter subsystem */
1da177e4
LT
20#define NETLINK_IP6_FW 13
21#define NETLINK_DNRTMSG 14 /* DECnet routing messages */
22#define NETLINK_KOBJECT_UEVENT 15 /* Kernel messages to userspace */
20ae975d 23#define NETLINK_GENERIC 16
84314fd4
JS
24/* leave room for NETLINK_DM (DM Events) */
25#define NETLINK_SCSITRANSPORT 18 /* SCSI Transports */
88b4a07e 26#define NETLINK_ECRYPTFS 19
b2cbae2c 27#define NETLINK_RDMA 20
1da177e4
LT
28
29#define MAX_LINKS 32
30
d94d9fee 31struct sockaddr_nl {
1da177e4
LT
32 sa_family_t nl_family; /* AF_NETLINK */
33 unsigned short nl_pad; /* zero */
cf130cb1 34 __u32 nl_pid; /* port ID */
1da177e4
LT
35 __u32 nl_groups; /* multicast groups mask */
36};
37
d94d9fee 38struct nlmsghdr {
1da177e4
LT
39 __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 */
cf130cb1 43 __u32 nlmsg_pid; /* Sending process port ID */
1da177e4
LT
44};
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
4b8fe663 74#define NLMSG_ALIGNTO 4U
1da177e4 75#define NLMSG_ALIGN(len) ( ((len)+NLMSG_ALIGNTO-1) & ~(NLMSG_ALIGNTO-1) )
bfa83a9e
TG
76#define NLMSG_HDRLEN ((int) NLMSG_ALIGN(sizeof(struct nlmsghdr)))
77#define NLMSG_LENGTH(len) ((len)+NLMSG_ALIGN(NLMSG_HDRLEN))
1da177e4
LT
78#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
bfa83a9e
TG
92#define NLMSG_MIN_TYPE 0x10 /* < 0x10: reserved control messages */
93
d94d9fee 94struct nlmsgerr {
1da177e4
LT
95 int error;
96 struct nlmsghdr msg;
97};
98
9a4595bc
PM
99#define NETLINK_ADD_MEMBERSHIP 1
100#define NETLINK_DROP_MEMBERSHIP 2
101#define NETLINK_PKTINFO 3
be0c22a4 102#define NETLINK_BROADCAST_ERROR 4
38938bfe 103#define NETLINK_NO_ENOBUFS 5
9a4595bc 104
d94d9fee 105struct nl_pktinfo {
9a4595bc
PM
106 __u32 group;
107};
108
1da177e4
LT
109#define NET_MAJOR 36 /* Major 36 is reserved for networking */
110
111enum {
112 NETLINK_UNCONNECTED = 0,
113 NETLINK_CONNECTED,
114};
115
bfa83a9e
TG
116/*
117 * <------- NLA_HDRLEN ------> <-- NLA_ALIGN(payload)-->
118 * +---------------------+- - -+- - - - - - - - - -+- - -+
119 * | Header | Pad | Payload | Pad |
120 * | (struct nlattr) | ing | | ing |
121 * +---------------------+- - -+- - - - - - - - - -+- - -+
122 * <-------------- nlattr->nla_len -------------->
123 */
124
d94d9fee 125struct nlattr {
bfa83a9e
TG
126 __u16 nla_len;
127 __u16 nla_type;
128};
129
8f4c1f9b
TG
130/*
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
bfa83a9e
TG
144#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
1da177e4
LT
148#ifdef __KERNEL__
149
150#include <linux/capability.h>
151#include <linux/skbuff.h>
152
56b49f4b
OW
153struct net;
154
b529ccf2
ACM
155static inline struct nlmsghdr *nlmsg_hdr(const struct sk_buff *skb)
156{
157 return (struct nlmsghdr *)skb->data;
158}
159
d94d9fee 160struct netlink_skb_parms {
1da177e4
LT
161 struct ucred creds; /* Skb credentials */
162 __u32 pid;
d629b836 163 __u32 dst_group;
1da177e4
LT
164};
165
166#define NETLINK_CB(skb) (*(struct netlink_skb_parms*)&((skb)->cb))
167#define NETLINK_CREDS(skb) (&NETLINK_CB((skb)).creds)
168
169
d136f1bd
JB
170extern void netlink_table_grab(void);
171extern void netlink_table_ungrab(void);
172
b4b51029
EB
173extern struct sock *netlink_kernel_create(struct net *net,
174 int unit,unsigned int groups,
cd40b7d3 175 void (*input)(struct sk_buff *skb),
af65bdfc
PM
176 struct mutex *cb_mutex,
177 struct module *module);
b7c6ba6e 178extern void netlink_kernel_release(struct sock *sk);
d136f1bd 179extern int __netlink_change_ngroups(struct sock *sk, unsigned int groups);
b4ff4f04 180extern int netlink_change_ngroups(struct sock *sk, unsigned int groups);
b8273570 181extern void __netlink_clear_multicast_users(struct sock *sk, unsigned int group);
84659eb5 182extern void netlink_clear_multicast_users(struct sock *sk, unsigned int group);
1da177e4 183extern void netlink_ack(struct sk_buff *in_skb, struct nlmsghdr *nlh, int err);
4277a083 184extern int netlink_has_listeners(struct sock *sk, unsigned int group);
1da177e4
LT
185extern 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,
dd0fc66f 187 __u32 group, gfp_t allocation);
910a7e90
EB
188extern 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);
1a50307b 192extern int netlink_set_err(struct sock *ssk, __u32 pid, __u32 group, int code);
1da177e4
LT
193extern 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);
9457afee 198int netlink_attachskb(struct sock *sk, struct sk_buff *skb,
c3d8d1e3 199 long *timeo, struct sock *ssk);
1da177e4 200void netlink_detachskb(struct sock *sk, struct sk_buff *skb);
7ee015e0 201int netlink_sendskb(struct sock *sk, struct sk_buff *skb);
1da177e4
LT
202
203/*
204 * skb should fit one page. This choice is good for headerless malloc.
fc910a27
DM
205 * 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.
1da177e4 208 */
fc910a27
DM
209#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
339bf98f 215#define NLMSG_DEFAULT_SIZE (NLMSG_GOODSIZE - NLMSG_HDRLEN)
1da177e4
LT
216
217
d94d9fee 218struct netlink_callback {
3a6c2b41
PM
219 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];
1da177e4
LT
226};
227
d94d9fee 228struct netlink_notify {
b4b51029 229 struct net *net;
1da177e4
LT
230 int pid;
231 int protocol;
232};
233
234static __inline__ struct nlmsghdr *
1797754e 235__nlmsg_put(struct sk_buff *skb, u32 pid, u32 seq, int type, int len, int flags)
1da177e4
LT
236{
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;
1797754e 243 nlh->nlmsg_flags = flags;
1da177e4
LT
244 nlh->nlmsg_pid = pid;
245 nlh->nlmsg_seq = seq;
0c19b0ad
PM
246 if (!__builtin_constant_p(size) || NLMSG_ALIGN(size) - size != 0)
247 memset(NLMSG_DATA(nlh) + len, 0, NLMSG_ALIGN(size) - size);
1da177e4
LT
248 return nlh;
249}
250
1797754e 251#define NLMSG_NEW(skb, pid, seq, type, len, flags) \
f4d900a2 252({ if (unlikely(skb_tailroom(skb) < (int)NLMSG_SPACE(len))) \
f88a10d6 253 goto nlmsg_failure; \
1797754e
TG
254 __nlmsg_put(skb, pid, seq, type, len, flags); })
255
256#define NLMSG_PUT(skb, pid, seq, type, len) \
257 NLMSG_NEW(skb, pid, seq, type, len, 0)
f88a10d6 258
1da177e4 259extern int netlink_dump_start(struct sock *ssk, struct sk_buff *skb,
3a6c2b41 260 const struct nlmsghdr *nlh,
1da177e4
LT
261 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 */
This page took 0.840576 seconds and 5 git commands to generate.