blob: a5e6d0ef51ddd52c425d05897887e35554bc55b0 [file] [log] [blame]
Thomas Grafbfa83a92005-11-10 02:25:51 +01001#ifndef __NET_NETLINK_H
2#define __NET_NETLINK_H
3
4#include <linux/types.h>
5#include <linux/netlink.h>
Al Virod7fe0f22006-12-03 23:15:30 -05006#include <linux/jiffies.h>
Thomas Grafbfa83a92005-11-10 02:25:51 +01007
8/* ========================================================================
9 * Netlink Messages and Attributes Interface (As Seen On TV)
10 * ------------------------------------------------------------------------
11 * Messages Interface
12 * ------------------------------------------------------------------------
13 *
14 * Message Format:
15 * <--- nlmsg_total_size(payload) --->
16 * <-- nlmsg_msg_size(payload) ->
17 * +----------+- - -+-------------+- - -+-------- - -
18 * | nlmsghdr | Pad | Payload | Pad | nlmsghdr
19 * +----------+- - -+-------------+- - -+-------- - -
20 * nlmsg_data(nlh)---^ ^
21 * nlmsg_next(nlh)-----------------------+
22 *
23 * Payload Format:
24 * <---------------------- nlmsg_len(nlh) --------------------->
25 * <------ hdrlen ------> <- nlmsg_attrlen(nlh, hdrlen) ->
26 * +----------------------+- - -+--------------------------------+
27 * | Family Header | Pad | Attributes |
28 * +----------------------+- - -+--------------------------------+
29 * nlmsg_attrdata(nlh, hdrlen)---^
30 *
31 * Data Structures:
32 * struct nlmsghdr netlink message header
33 *
34 * Message Construction:
35 * nlmsg_new() create a new netlink message
36 * nlmsg_put() add a netlink message to an skb
37 * nlmsg_put_answer() callback based nlmsg_put()
38 * nlmsg_end() finanlize netlink message
Thomas Graffe4944e2006-08-04 23:03:05 -070039 * nlmsg_get_pos() return current position in message
40 * nlmsg_trim() trim part of message
Thomas Grafbfa83a92005-11-10 02:25:51 +010041 * nlmsg_cancel() cancel message construction
42 * nlmsg_free() free a netlink message
43 *
44 * Message Sending:
45 * nlmsg_multicast() multicast message to several groups
46 * nlmsg_unicast() unicast a message to a single socket
Thomas Grafd387f6a2006-08-15 00:31:06 -070047 * nlmsg_notify() send notification message
Thomas Grafbfa83a92005-11-10 02:25:51 +010048 *
49 * Message Length Calculations:
50 * nlmsg_msg_size(payload) length of message w/o padding
51 * nlmsg_total_size(payload) length of message w/ padding
52 * nlmsg_padlen(payload) length of padding at tail
53 *
54 * Message Payload Access:
55 * nlmsg_data(nlh) head of message payload
56 * nlmsg_len(nlh) length of message payload
57 * nlmsg_attrdata(nlh, hdrlen) head of attributes data
58 * nlmsg_attrlen(nlh, hdrlen) length of attributes data
59 *
60 * Message Parsing:
61 * nlmsg_ok(nlh, remaining) does nlh fit into remaining bytes?
62 * nlmsg_next(nlh, remaining) get next netlink message
63 * nlmsg_parse() parse attributes of a message
64 * nlmsg_find_attr() find an attribute in a message
65 * nlmsg_for_each_msg() loop over all messages
66 * nlmsg_validate() validate netlink message incl. attrs
67 * nlmsg_for_each_attr() loop over all attributes
68 *
Thomas Graf97676b62006-08-15 00:31:41 -070069 * Misc:
70 * nlmsg_report() report back to application?
71 *
Thomas Grafbfa83a92005-11-10 02:25:51 +010072 * ------------------------------------------------------------------------
73 * Attributes Interface
74 * ------------------------------------------------------------------------
75 *
76 * Attribute Format:
77 * <------- nla_total_size(payload) ------->
78 * <---- nla_attr_size(payload) ----->
79 * +----------+- - -+- - - - - - - - - +- - -+-------- - -
80 * | Header | Pad | Payload | Pad | Header
81 * +----------+- - -+- - - - - - - - - +- - -+-------- - -
82 * <- nla_len(nla) -> ^
83 * nla_data(nla)----^ |
84 * nla_next(nla)-----------------------------'
85 *
86 * Data Structures:
Pierre Ynardd1ec3b72007-10-10 21:09:48 -070087 * struct nlattr netlink attribute header
Thomas Grafbfa83a92005-11-10 02:25:51 +010088 *
89 * Attribute Construction:
Thomas Graffe4944e2006-08-04 23:03:05 -070090 * nla_reserve(skb, type, len) reserve room for an attribute
91 * nla_reserve_nohdr(skb, len) reserve room for an attribute w/o hdr
Thomas Grafbfa83a92005-11-10 02:25:51 +010092 * nla_put(skb, type, len, data) add attribute to skb
Thomas Graffe4944e2006-08-04 23:03:05 -070093 * nla_put_nohdr(skb, len, data) add attribute w/o hdr
Thomas Grafbfa83a92005-11-10 02:25:51 +010094 *
95 * Attribute Construction for Basic Types:
96 * nla_put_u8(skb, type, value) add u8 attribute to skb
97 * nla_put_u16(skb, type, value) add u16 attribute to skb
98 * nla_put_u32(skb, type, value) add u32 attribute to skb
99 * nla_put_u64(skb, type, value) add u64 attribute to skb
100 * nla_put_string(skb, type, str) add string attribute to skb
101 * nla_put_flag(skb, type) add flag attribute to skb
102 * nla_put_msecs(skb, type, jiffies) add msecs attribute to skb
103 *
104 * Exceptions Based Attribute Construction:
105 * NLA_PUT(skb, type, len, data) add attribute to skb
106 * NLA_PUT_U8(skb, type, value) add u8 attribute to skb
107 * NLA_PUT_U16(skb, type, value) add u16 attribute to skb
108 * NLA_PUT_U32(skb, type, value) add u32 attribute to skb
109 * NLA_PUT_U64(skb, type, value) add u64 attribute to skb
110 * NLA_PUT_STRING(skb, type, str) add string attribute to skb
111 * NLA_PUT_FLAG(skb, type) add flag attribute to skb
112 * NLA_PUT_MSECS(skb, type, jiffies) add msecs attribute to skb
113 *
114 * The meaning of these functions is equal to their lower case
115 * variants but they jump to the label nla_put_failure in case
116 * of a failure.
117 *
118 * Nested Attributes Construction:
119 * nla_nest_start(skb, type) start a nested attribute
120 * nla_nest_end(skb, nla) finalize a nested attribute
Patrick McHardy1092cb22007-06-25 13:49:35 -0700121 * nla_nest_compat_start(skb, type, start a nested compat attribute
122 * len, data)
123 * nla_nest_compat_end(skb, type) finalize a nested compat attribute
Thomas Grafbfa83a92005-11-10 02:25:51 +0100124 * nla_nest_cancel(skb, nla) cancel nested attribute construction
125 *
126 * Attribute Length Calculations:
127 * nla_attr_size(payload) length of attribute w/o padding
128 * nla_total_size(payload) length of attribute w/ padding
129 * nla_padlen(payload) length of padding
130 *
131 * Attribute Payload Access:
132 * nla_data(nla) head of attribute payload
133 * nla_len(nla) length of attribute payload
134 *
135 * Attribute Payload Access for Basic Types:
136 * nla_get_u8(nla) get payload for a u8 attribute
137 * nla_get_u16(nla) get payload for a u16 attribute
138 * nla_get_u32(nla) get payload for a u32 attribute
139 * nla_get_u64(nla) get payload for a u64 attribute
140 * nla_get_flag(nla) return 1 if flag is true
141 * nla_get_msecs(nla) get payload for a msecs attribute
142 *
143 * Attribute Misc:
144 * nla_memcpy(dest, nla, count) copy attribute into memory
145 * nla_memcmp(nla, data, size) compare attribute with memory area
146 * nla_strlcpy(dst, nla, size) copy attribute to a sized string
147 * nla_strcmp(nla, str) compare attribute with string
148 *
149 * Attribute Parsing:
150 * nla_ok(nla, remaining) does nla fit into remaining bytes?
151 * nla_next(nla, remaining) get next netlink attribute
152 * nla_validate() validate a stream of attributes
Paul Moore4fe5d5c2006-09-25 15:54:03 -0700153 * nla_validate_nested() validate a stream of nested attributes
Thomas Grafbfa83a92005-11-10 02:25:51 +0100154 * nla_find() find attribute in stream of attributes
Thomas Graffe4944e2006-08-04 23:03:05 -0700155 * nla_find_nested() find attribute in nested attributes
Thomas Grafbfa83a92005-11-10 02:25:51 +0100156 * nla_parse() parse and validate stream of attrs
157 * nla_parse_nested() parse nested attribuets
Patrick McHardy1092cb22007-06-25 13:49:35 -0700158 * nla_parse_nested_compat() parse nested compat attributes
Thomas Grafbfa83a92005-11-10 02:25:51 +0100159 * nla_for_each_attr() loop over all attributes
Paul Moore22acb192006-09-25 15:53:37 -0700160 * nla_for_each_nested() loop over the nested attributes
Thomas Grafbfa83a92005-11-10 02:25:51 +0100161 *=========================================================================
162 */
163
164 /**
165 * Standard attribute types to specify validation policy
166 */
167enum {
168 NLA_UNSPEC,
169 NLA_U8,
170 NLA_U16,
171 NLA_U32,
172 NLA_U64,
173 NLA_STRING,
174 NLA_FLAG,
175 NLA_MSECS,
176 NLA_NESTED,
Patrick McHardy1092cb22007-06-25 13:49:35 -0700177 NLA_NESTED_COMPAT,
Thomas Grafa5531a52006-08-26 20:11:47 -0700178 NLA_NUL_STRING,
Johannes Bergd30045a2007-03-23 11:37:48 -0700179 NLA_BINARY,
Thomas Grafbfa83a92005-11-10 02:25:51 +0100180 __NLA_TYPE_MAX,
181};
182
183#define NLA_TYPE_MAX (__NLA_TYPE_MAX - 1)
184
185/**
186 * struct nla_policy - attribute validation policy
187 * @type: Type of attribute or NLA_UNSPEC
Thomas Grafa5531a52006-08-26 20:11:47 -0700188 * @len: Type specific length of payload
Thomas Grafbfa83a92005-11-10 02:25:51 +0100189 *
190 * Policies are defined as arrays of this struct, the array must be
191 * accessible by attribute type up to the highest identifier to be expected.
192 *
Thomas Grafa5531a52006-08-26 20:11:47 -0700193 * Meaning of `len' field:
194 * NLA_STRING Maximum length of string
195 * NLA_NUL_STRING Maximum length of string (excluding NUL)
196 * NLA_FLAG Unused
Johannes Bergd30045a2007-03-23 11:37:48 -0700197 * NLA_BINARY Maximum length of attribute payload
Patrick McHardy1092cb22007-06-25 13:49:35 -0700198 * NLA_NESTED_COMPAT Exact length of structure payload
Thomas Grafa5531a52006-08-26 20:11:47 -0700199 * All other Exact length of attribute payload
200 *
Thomas Grafbfa83a92005-11-10 02:25:51 +0100201 * Example:
202 * static struct nla_policy my_policy[ATTR_MAX+1] __read_mostly = {
203 * [ATTR_FOO] = { .type = NLA_U16 },
Johannes Bergd30045a2007-03-23 11:37:48 -0700204 * [ATTR_BAR] = { .type = NLA_STRING, .len = BARSIZ },
Thomas Grafa5531a52006-08-26 20:11:47 -0700205 * [ATTR_BAZ] = { .len = sizeof(struct mystruct) },
Thomas Grafbfa83a92005-11-10 02:25:51 +0100206 * };
207 */
208struct nla_policy {
209 u16 type;
Thomas Grafa5531a52006-08-26 20:11:47 -0700210 u16 len;
Thomas Grafbfa83a92005-11-10 02:25:51 +0100211};
212
Thomas Graf4e902c52006-08-17 18:14:52 -0700213/**
214 * struct nl_info - netlink source information
215 * @nlh: Netlink message header of original request
216 * @pid: Netlink PID of requesting application
217 */
218struct nl_info {
219 struct nlmsghdr *nlh;
Denis V. Lunev4d1169c2008-01-10 03:26:13 -0800220 struct net *nl_net;
Thomas Graf4e902c52006-08-17 18:14:52 -0700221 u32 pid;
222};
223
Denis V. Lunevcd40b7d2007-10-10 21:15:29 -0700224extern int netlink_rcv_skb(struct sk_buff *skb,
225 int (*cb)(struct sk_buff *,
226 struct nlmsghdr *));
Thomas Graf97676b62006-08-15 00:31:41 -0700227extern int nlmsg_notify(struct sock *sk, struct sk_buff *skb,
228 u32 pid, unsigned int group, int report,
229 gfp_t flags);
Thomas Graf82ace472005-11-10 02:25:53 +0100230
Thomas Grafbfa83a92005-11-10 02:25:51 +0100231extern int nla_validate(struct nlattr *head, int len, int maxtype,
Patrick McHardyef7c79e2007-06-05 12:38:30 -0700232 const struct nla_policy *policy);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100233extern int nla_parse(struct nlattr *tb[], int maxtype,
234 struct nlattr *head, int len,
Patrick McHardyef7c79e2007-06-05 12:38:30 -0700235 const struct nla_policy *policy);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100236extern struct nlattr * nla_find(struct nlattr *head, int len, int attrtype);
237extern size_t nla_strlcpy(char *dst, const struct nlattr *nla,
238 size_t dstsize);
239extern int nla_memcpy(void *dest, struct nlattr *src, int count);
240extern int nla_memcmp(const struct nlattr *nla, const void *data,
241 size_t size);
242extern int nla_strcmp(const struct nlattr *nla, const char *str);
243extern struct nlattr * __nla_reserve(struct sk_buff *skb, int attrtype,
244 int attrlen);
Thomas Graffe4944e2006-08-04 23:03:05 -0700245extern void * __nla_reserve_nohdr(struct sk_buff *skb, int attrlen);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100246extern struct nlattr * nla_reserve(struct sk_buff *skb, int attrtype,
247 int attrlen);
Thomas Graffe4944e2006-08-04 23:03:05 -0700248extern void * nla_reserve_nohdr(struct sk_buff *skb, int attrlen);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100249extern void __nla_put(struct sk_buff *skb, int attrtype,
250 int attrlen, const void *data);
Thomas Graffe4944e2006-08-04 23:03:05 -0700251extern void __nla_put_nohdr(struct sk_buff *skb, int attrlen,
252 const void *data);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100253extern int nla_put(struct sk_buff *skb, int attrtype,
254 int attrlen, const void *data);
Thomas Graffe4944e2006-08-04 23:03:05 -0700255extern int nla_put_nohdr(struct sk_buff *skb, int attrlen,
256 const void *data);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100257
258/**************************************************************************
259 * Netlink Messages
260 **************************************************************************/
261
262/**
263 * nlmsg_msg_size - length of netlink message not including padding
264 * @payload: length of message payload
265 */
266static inline int nlmsg_msg_size(int payload)
267{
268 return NLMSG_HDRLEN + payload;
269}
270
271/**
272 * nlmsg_total_size - length of netlink message including padding
273 * @payload: length of message payload
274 */
275static inline int nlmsg_total_size(int payload)
276{
277 return NLMSG_ALIGN(nlmsg_msg_size(payload));
278}
279
280/**
281 * nlmsg_padlen - length of padding at the message's tail
282 * @payload: length of message payload
283 */
284static inline int nlmsg_padlen(int payload)
285{
286 return nlmsg_total_size(payload) - nlmsg_msg_size(payload);
287}
288
289/**
290 * nlmsg_data - head of message payload
291 * @nlh: netlink messsage header
292 */
293static inline void *nlmsg_data(const struct nlmsghdr *nlh)
294{
295 return (unsigned char *) nlh + NLMSG_HDRLEN;
296}
297
298/**
299 * nlmsg_len - length of message payload
300 * @nlh: netlink message header
301 */
302static inline int nlmsg_len(const struct nlmsghdr *nlh)
303{
304 return nlh->nlmsg_len - NLMSG_HDRLEN;
305}
306
307/**
308 * nlmsg_attrdata - head of attributes data
309 * @nlh: netlink message header
310 * @hdrlen: length of family specific header
311 */
312static inline struct nlattr *nlmsg_attrdata(const struct nlmsghdr *nlh,
313 int hdrlen)
314{
315 unsigned char *data = nlmsg_data(nlh);
316 return (struct nlattr *) (data + NLMSG_ALIGN(hdrlen));
317}
318
319/**
320 * nlmsg_attrlen - length of attributes data
321 * @nlh: netlink message header
322 * @hdrlen: length of family specific header
323 */
324static inline int nlmsg_attrlen(const struct nlmsghdr *nlh, int hdrlen)
325{
326 return nlmsg_len(nlh) - NLMSG_ALIGN(hdrlen);
327}
328
329/**
330 * nlmsg_ok - check if the netlink message fits into the remaining bytes
331 * @nlh: netlink message header
332 * @remaining: number of bytes remaining in message stream
333 */
334static inline int nlmsg_ok(const struct nlmsghdr *nlh, int remaining)
335{
336 return (remaining >= sizeof(struct nlmsghdr) &&
337 nlh->nlmsg_len >= sizeof(struct nlmsghdr) &&
338 nlh->nlmsg_len <= remaining);
339}
340
341/**
342 * nlmsg_next - next netlink message in message stream
343 * @nlh: netlink message header
344 * @remaining: number of bytes remaining in message stream
345 *
346 * Returns the next netlink message in the message stream and
347 * decrements remaining by the size of the current message.
348 */
349static inline struct nlmsghdr *nlmsg_next(struct nlmsghdr *nlh, int *remaining)
350{
351 int totlen = NLMSG_ALIGN(nlh->nlmsg_len);
352
353 *remaining -= totlen;
354
355 return (struct nlmsghdr *) ((unsigned char *) nlh + totlen);
356}
357
358/**
359 * nlmsg_parse - parse attributes of a netlink message
360 * @nlh: netlink message header
361 * @hdrlen: length of family specific header
362 * @tb: destination array with maxtype+1 elements
363 * @maxtype: maximum attribute type to be expected
364 * @policy: validation policy
365 *
366 * See nla_parse()
367 */
368static inline int nlmsg_parse(struct nlmsghdr *nlh, int hdrlen,
369 struct nlattr *tb[], int maxtype,
Patrick McHardyef7c79e2007-06-05 12:38:30 -0700370 const struct nla_policy *policy)
Thomas Grafbfa83a92005-11-10 02:25:51 +0100371{
372 if (nlh->nlmsg_len < nlmsg_msg_size(hdrlen))
373 return -EINVAL;
374
375 return nla_parse(tb, maxtype, nlmsg_attrdata(nlh, hdrlen),
376 nlmsg_attrlen(nlh, hdrlen), policy);
377}
378
379/**
380 * nlmsg_find_attr - find a specific attribute in a netlink message
381 * @nlh: netlink message header
382 * @hdrlen: length of familiy specific header
383 * @attrtype: type of attribute to look for
384 *
385 * Returns the first attribute which matches the specified type.
386 */
387static inline struct nlattr *nlmsg_find_attr(struct nlmsghdr *nlh,
388 int hdrlen, int attrtype)
389{
390 return nla_find(nlmsg_attrdata(nlh, hdrlen),
391 nlmsg_attrlen(nlh, hdrlen), attrtype);
392}
393
394/**
395 * nlmsg_validate - validate a netlink message including attributes
396 * @nlh: netlinket message header
397 * @hdrlen: length of familiy specific header
398 * @maxtype: maximum attribute type to be expected
399 * @policy: validation policy
400 */
401static inline int nlmsg_validate(struct nlmsghdr *nlh, int hdrlen, int maxtype,
Patrick McHardyef7c79e2007-06-05 12:38:30 -0700402 const struct nla_policy *policy)
Thomas Grafbfa83a92005-11-10 02:25:51 +0100403{
404 if (nlh->nlmsg_len < nlmsg_msg_size(hdrlen))
405 return -EINVAL;
406
407 return nla_validate(nlmsg_attrdata(nlh, hdrlen),
408 nlmsg_attrlen(nlh, hdrlen), maxtype, policy);
409}
410
411/**
Thomas Graf97676b62006-08-15 00:31:41 -0700412 * nlmsg_report - need to report back to application?
413 * @nlh: netlink message header
414 *
415 * Returns 1 if a report back to the application is requested.
416 */
417static inline int nlmsg_report(struct nlmsghdr *nlh)
418{
419 return !!(nlh->nlmsg_flags & NLM_F_ECHO);
420}
421
422/**
Thomas Grafbfa83a92005-11-10 02:25:51 +0100423 * nlmsg_for_each_attr - iterate over a stream of attributes
424 * @pos: loop counter, set to current attribute
425 * @nlh: netlink message header
426 * @hdrlen: length of familiy specific header
427 * @rem: initialized to len, holds bytes currently remaining in stream
428 */
429#define nlmsg_for_each_attr(pos, nlh, hdrlen, rem) \
430 nla_for_each_attr(pos, nlmsg_attrdata(nlh, hdrlen), \
431 nlmsg_attrlen(nlh, hdrlen), rem)
432
433#if 0
434/* FIXME: Enable once all users have been converted */
435
436/**
437 * __nlmsg_put - Add a new netlink message to an skb
438 * @skb: socket buffer to store message in
439 * @pid: netlink process id
440 * @seq: sequence number of message
441 * @type: message type
442 * @payload: length of message payload
443 * @flags: message flags
444 *
445 * The caller is responsible to ensure that the skb provides enough
446 * tailroom for both the netlink header and payload.
447 */
448static inline struct nlmsghdr *__nlmsg_put(struct sk_buff *skb, u32 pid,
449 u32 seq, int type, int payload,
450 int flags)
451{
452 struct nlmsghdr *nlh;
453
454 nlh = (struct nlmsghdr *) skb_put(skb, nlmsg_total_size(payload));
455 nlh->nlmsg_type = type;
456 nlh->nlmsg_len = nlmsg_msg_size(payload);
457 nlh->nlmsg_flags = flags;
458 nlh->nlmsg_pid = pid;
459 nlh->nlmsg_seq = seq;
460
461 memset((unsigned char *) nlmsg_data(nlh) + payload, 0,
462 nlmsg_padlen(payload));
463
464 return nlh;
465}
466#endif
467
468/**
469 * nlmsg_put - Add a new netlink message to an skb
470 * @skb: socket buffer to store message in
471 * @pid: netlink process id
472 * @seq: sequence number of message
473 * @type: message type
474 * @payload: length of message payload
475 * @flags: message flags
476 *
477 * Returns NULL if the tailroom of the skb is insufficient to store
478 * the message header and payload.
479 */
480static inline struct nlmsghdr *nlmsg_put(struct sk_buff *skb, u32 pid, u32 seq,
481 int type, int payload, int flags)
482{
483 if (unlikely(skb_tailroom(skb) < nlmsg_total_size(payload)))
484 return NULL;
485
486 return __nlmsg_put(skb, pid, seq, type, payload, flags);
487}
488
489/**
490 * nlmsg_put_answer - Add a new callback based netlink message to an skb
491 * @skb: socket buffer to store message in
492 * @cb: netlink callback
493 * @type: message type
494 * @payload: length of message payload
495 * @flags: message flags
496 *
497 * Returns NULL if the tailroom of the skb is insufficient to store
498 * the message header and payload.
499 */
500static inline struct nlmsghdr *nlmsg_put_answer(struct sk_buff *skb,
501 struct netlink_callback *cb,
502 int type, int payload,
503 int flags)
504{
505 return nlmsg_put(skb, NETLINK_CB(cb->skb).pid, cb->nlh->nlmsg_seq,
506 type, payload, flags);
507}
508
509/**
510 * nlmsg_new - Allocate a new netlink message
Thomas Graf339bf982006-11-10 14:10:15 -0800511 * @payload: size of the message payload
Thomas Graffe4944e2006-08-04 23:03:05 -0700512 * @flags: the type of memory to allocate.
Thomas Grafbfa83a92005-11-10 02:25:51 +0100513 *
Thomas Graf339bf982006-11-10 14:10:15 -0800514 * Use NLMSG_DEFAULT_SIZE if the size of the payload isn't known
515 * and a good default is needed.
Thomas Grafbfa83a92005-11-10 02:25:51 +0100516 */
Thomas Graf339bf982006-11-10 14:10:15 -0800517static inline struct sk_buff *nlmsg_new(size_t payload, gfp_t flags)
Thomas Grafbfa83a92005-11-10 02:25:51 +0100518{
Thomas Graf339bf982006-11-10 14:10:15 -0800519 return alloc_skb(nlmsg_total_size(payload), flags);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100520}
521
522/**
523 * nlmsg_end - Finalize a netlink message
524 * @skb: socket buffer the message is stored in
525 * @nlh: netlink message header
526 *
527 * Corrects the netlink message header to include the appeneded
528 * attributes. Only necessary if attributes have been added to
529 * the message.
530 *
531 * Returns the total data length of the skb.
532 */
533static inline int nlmsg_end(struct sk_buff *skb, struct nlmsghdr *nlh)
534{
Arnaldo Carvalho de Melo27a884d2007-04-19 20:29:13 -0700535 nlh->nlmsg_len = skb_tail_pointer(skb) - (unsigned char *)nlh;
Thomas Grafbfa83a92005-11-10 02:25:51 +0100536
537 return skb->len;
538}
539
540/**
Thomas Graffe4944e2006-08-04 23:03:05 -0700541 * nlmsg_get_pos - return current position in netlink message
542 * @skb: socket buffer the message is stored in
543 *
544 * Returns a pointer to the current tail of the message.
545 */
546static inline void *nlmsg_get_pos(struct sk_buff *skb)
547{
Arnaldo Carvalho de Melo27a884d2007-04-19 20:29:13 -0700548 return skb_tail_pointer(skb);
Thomas Graffe4944e2006-08-04 23:03:05 -0700549}
550
551/**
552 * nlmsg_trim - Trim message to a mark
553 * @skb: socket buffer the message is stored in
554 * @mark: mark to trim to
555 *
556 * Trims the message to the provided mark. Returns -1.
557 */
Arnaldo Carvalho de Melodc5fc572007-03-25 23:06:12 -0700558static inline int nlmsg_trim(struct sk_buff *skb, const void *mark)
Thomas Graffe4944e2006-08-04 23:03:05 -0700559{
560 if (mark)
561 skb_trim(skb, (unsigned char *) mark - skb->data);
562
563 return -1;
564}
565
566/**
Thomas Grafbfa83a92005-11-10 02:25:51 +0100567 * nlmsg_cancel - Cancel construction of a netlink message
568 * @skb: socket buffer the message is stored in
569 * @nlh: netlink message header
570 *
571 * Removes the complete netlink message including all
572 * attributes from the socket buffer again. Returns -1.
573 */
574static inline int nlmsg_cancel(struct sk_buff *skb, struct nlmsghdr *nlh)
575{
Thomas Graffe4944e2006-08-04 23:03:05 -0700576 return nlmsg_trim(skb, nlh);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100577}
578
579/**
580 * nlmsg_free - free a netlink message
581 * @skb: socket buffer of netlink message
582 */
583static inline void nlmsg_free(struct sk_buff *skb)
584{
585 kfree_skb(skb);
586}
587
588/**
589 * nlmsg_multicast - multicast a netlink message
590 * @sk: netlink socket to spread messages to
591 * @skb: netlink message as socket buffer
592 * @pid: own netlink pid to avoid sending to yourself
593 * @group: multicast group id
Thomas Grafd387f6a2006-08-15 00:31:06 -0700594 * @flags: allocation flags
Thomas Grafbfa83a92005-11-10 02:25:51 +0100595 */
596static inline int nlmsg_multicast(struct sock *sk, struct sk_buff *skb,
Thomas Grafd387f6a2006-08-15 00:31:06 -0700597 u32 pid, unsigned int group, gfp_t flags)
Thomas Grafbfa83a92005-11-10 02:25:51 +0100598{
599 int err;
600
601 NETLINK_CB(skb).dst_group = group;
602
Thomas Grafd387f6a2006-08-15 00:31:06 -0700603 err = netlink_broadcast(sk, skb, pid, group, flags);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100604 if (err > 0)
605 err = 0;
606
607 return err;
608}
609
610/**
611 * nlmsg_unicast - unicast a netlink message
612 * @sk: netlink socket to spread message to
613 * @skb: netlink message as socket buffer
614 * @pid: netlink pid of the destination socket
615 */
616static inline int nlmsg_unicast(struct sock *sk, struct sk_buff *skb, u32 pid)
617{
618 int err;
619
620 err = netlink_unicast(sk, skb, pid, MSG_DONTWAIT);
621 if (err > 0)
622 err = 0;
623
624 return err;
625}
626
627/**
628 * nlmsg_for_each_msg - iterate over a stream of messages
629 * @pos: loop counter, set to current message
630 * @head: head of message stream
631 * @len: length of message stream
632 * @rem: initialized to len, holds bytes currently remaining in stream
633 */
634#define nlmsg_for_each_msg(pos, head, len, rem) \
635 for (pos = head, rem = len; \
636 nlmsg_ok(pos, rem); \
637 pos = nlmsg_next(pos, &(rem)))
638
639/**************************************************************************
640 * Netlink Attributes
641 **************************************************************************/
642
643/**
644 * nla_attr_size - length of attribute not including padding
645 * @payload: length of payload
646 */
647static inline int nla_attr_size(int payload)
648{
649 return NLA_HDRLEN + payload;
650}
651
652/**
653 * nla_total_size - total length of attribute including padding
654 * @payload: length of payload
655 */
656static inline int nla_total_size(int payload)
657{
658 return NLA_ALIGN(nla_attr_size(payload));
659}
660
661/**
662 * nla_padlen - length of padding at the tail of attribute
663 * @payload: length of payload
664 */
665static inline int nla_padlen(int payload)
666{
667 return nla_total_size(payload) - nla_attr_size(payload);
668}
669
670/**
Thomas Graf8f4c1f92007-09-12 14:44:36 +0200671 * nla_type - attribute type
672 * @nla: netlink attribute
673 */
674static inline int nla_type(const struct nlattr *nla)
675{
676 return nla->nla_type & NLA_TYPE_MASK;
677}
678
679/**
Thomas Grafbfa83a92005-11-10 02:25:51 +0100680 * nla_data - head of payload
681 * @nla: netlink attribute
682 */
683static inline void *nla_data(const struct nlattr *nla)
684{
685 return (char *) nla + NLA_HDRLEN;
686}
687
688/**
689 * nla_len - length of payload
690 * @nla: netlink attribute
691 */
692static inline int nla_len(const struct nlattr *nla)
693{
694 return nla->nla_len - NLA_HDRLEN;
695}
696
697/**
698 * nla_ok - check if the netlink attribute fits into the remaining bytes
699 * @nla: netlink attribute
700 * @remaining: number of bytes remaining in attribute stream
701 */
702static inline int nla_ok(const struct nlattr *nla, int remaining)
703{
704 return remaining >= sizeof(*nla) &&
705 nla->nla_len >= sizeof(*nla) &&
706 nla->nla_len <= remaining;
707}
708
709/**
Pierre Ynardd1ec3b72007-10-10 21:09:48 -0700710 * nla_next - next netlink attribute in attribute stream
Thomas Grafbfa83a92005-11-10 02:25:51 +0100711 * @nla: netlink attribute
712 * @remaining: number of bytes remaining in attribute stream
713 *
714 * Returns the next netlink attribute in the attribute stream and
715 * decrements remaining by the size of the current attribute.
716 */
717static inline struct nlattr *nla_next(const struct nlattr *nla, int *remaining)
718{
719 int totlen = NLA_ALIGN(nla->nla_len);
720
721 *remaining -= totlen;
722 return (struct nlattr *) ((char *) nla + totlen);
723}
724
725/**
Thomas Graffe4944e2006-08-04 23:03:05 -0700726 * nla_find_nested - find attribute in a set of nested attributes
727 * @nla: attribute containing the nested attributes
728 * @attrtype: type of attribute to look for
729 *
730 * Returns the first attribute which matches the specified type.
731 */
732static inline struct nlattr *nla_find_nested(struct nlattr *nla, int attrtype)
733{
734 return nla_find(nla_data(nla), nla_len(nla), attrtype);
735}
736
737/**
Thomas Grafbfa83a92005-11-10 02:25:51 +0100738 * nla_parse_nested - parse nested attributes
739 * @tb: destination array with maxtype+1 elements
740 * @maxtype: maximum attribute type to be expected
741 * @nla: attribute containing the nested attributes
742 * @policy: validation policy
743 *
744 * See nla_parse()
745 */
746static inline int nla_parse_nested(struct nlattr *tb[], int maxtype,
747 struct nlattr *nla,
Patrick McHardyef7c79e2007-06-05 12:38:30 -0700748 const struct nla_policy *policy)
Thomas Grafbfa83a92005-11-10 02:25:51 +0100749{
750 return nla_parse(tb, maxtype, nla_data(nla), nla_len(nla), policy);
751}
Patrick McHardy1092cb22007-06-25 13:49:35 -0700752
753/**
754 * nla_parse_nested_compat - parse nested compat attributes
755 * @tb: destination array with maxtype+1 elements
756 * @maxtype: maximum attribute type to be expected
757 * @nla: attribute containing the nested attributes
758 * @data: pointer to point to contained structure
759 * @len: length of contained structure
760 * @policy: validation policy
761 *
762 * Parse a nested compat attribute. The compat attribute contains a structure
763 * and optionally a set of nested attributes. On success the data pointer
764 * points to the nested data and tb contains the parsed attributes
765 * (see nla_parse).
766 */
767static inline int __nla_parse_nested_compat(struct nlattr *tb[], int maxtype,
768 struct nlattr *nla,
769 const struct nla_policy *policy,
770 int len)
771{
772 if (nla_len(nla) < len)
773 return -1;
774 if (nla_len(nla) >= NLA_ALIGN(len) + sizeof(struct nlattr))
775 return nla_parse_nested(tb, maxtype,
776 nla_data(nla) + NLA_ALIGN(len),
777 policy);
778 memset(tb, 0, sizeof(struct nlattr *) * (maxtype + 1));
779 return 0;
780}
781
782#define nla_parse_nested_compat(tb, maxtype, nla, policy, data, len) \
783({ data = nla_len(nla) >= len ? nla_data(nla) : NULL; \
784 __nla_parse_nested_compat(tb, maxtype, nla, policy, len); })
Thomas Grafbfa83a92005-11-10 02:25:51 +0100785/**
Pierre Ynardd1ec3b72007-10-10 21:09:48 -0700786 * nla_put_u8 - Add a u8 netlink attribute to a socket buffer
Thomas Grafbfa83a92005-11-10 02:25:51 +0100787 * @skb: socket buffer to add attribute to
788 * @attrtype: attribute type
789 * @value: numeric value
790 */
791static inline int nla_put_u8(struct sk_buff *skb, int attrtype, u8 value)
792{
793 return nla_put(skb, attrtype, sizeof(u8), &value);
794}
795
796/**
797 * nla_put_u16 - Add a u16 netlink attribute to a socket buffer
798 * @skb: socket buffer to add attribute to
799 * @attrtype: attribute type
800 * @value: numeric value
801 */
802static inline int nla_put_u16(struct sk_buff *skb, int attrtype, u16 value)
803{
804 return nla_put(skb, attrtype, sizeof(u16), &value);
805}
806
807/**
808 * nla_put_u32 - Add a u32 netlink attribute to a socket buffer
809 * @skb: socket buffer to add attribute to
810 * @attrtype: attribute type
811 * @value: numeric value
812 */
813static inline int nla_put_u32(struct sk_buff *skb, int attrtype, u32 value)
814{
815 return nla_put(skb, attrtype, sizeof(u32), &value);
816}
817
818/**
819 * nla_put_64 - Add a u64 netlink attribute to a socket buffer
820 * @skb: socket buffer to add attribute to
821 * @attrtype: attribute type
822 * @value: numeric value
823 */
824static inline int nla_put_u64(struct sk_buff *skb, int attrtype, u64 value)
825{
826 return nla_put(skb, attrtype, sizeof(u64), &value);
827}
828
829/**
830 * nla_put_string - Add a string netlink attribute to a socket buffer
831 * @skb: socket buffer to add attribute to
832 * @attrtype: attribute type
833 * @str: NUL terminated string
834 */
835static inline int nla_put_string(struct sk_buff *skb, int attrtype,
836 const char *str)
837{
838 return nla_put(skb, attrtype, strlen(str) + 1, str);
839}
840
841/**
842 * nla_put_flag - Add a flag netlink attribute to a socket buffer
843 * @skb: socket buffer to add attribute to
844 * @attrtype: attribute type
845 */
846static inline int nla_put_flag(struct sk_buff *skb, int attrtype)
847{
848 return nla_put(skb, attrtype, 0, NULL);
849}
850
851/**
852 * nla_put_msecs - Add a msecs netlink attribute to a socket buffer
853 * @skb: socket buffer to add attribute to
854 * @attrtype: attribute type
855 * @jiffies: number of msecs in jiffies
856 */
857static inline int nla_put_msecs(struct sk_buff *skb, int attrtype,
858 unsigned long jiffies)
859{
860 u64 tmp = jiffies_to_msecs(jiffies);
861 return nla_put(skb, attrtype, sizeof(u64), &tmp);
862}
863
864#define NLA_PUT(skb, attrtype, attrlen, data) \
865 do { \
Patrick McHardyf4d900a2007-12-05 03:31:53 -0800866 if (unlikely(nla_put(skb, attrtype, attrlen, data) < 0)) \
Thomas Grafbfa83a92005-11-10 02:25:51 +0100867 goto nla_put_failure; \
868 } while(0)
869
870#define NLA_PUT_TYPE(skb, type, attrtype, value) \
871 do { \
872 type __tmp = value; \
873 NLA_PUT(skb, attrtype, sizeof(type), &__tmp); \
874 } while(0)
875
876#define NLA_PUT_U8(skb, attrtype, value) \
877 NLA_PUT_TYPE(skb, u8, attrtype, value)
878
879#define NLA_PUT_U16(skb, attrtype, value) \
880 NLA_PUT_TYPE(skb, u16, attrtype, value)
881
Thomas Graf4a89c252006-11-24 17:14:51 -0800882#define NLA_PUT_LE16(skb, attrtype, value) \
883 NLA_PUT_TYPE(skb, __le16, attrtype, value)
884
Patrick McHardy838965b2007-12-17 22:29:26 -0800885#define NLA_PUT_BE16(skb, attrtype, value) \
886 NLA_PUT_TYPE(skb, __be16, attrtype, value)
887
Thomas Grafbfa83a92005-11-10 02:25:51 +0100888#define NLA_PUT_U32(skb, attrtype, value) \
889 NLA_PUT_TYPE(skb, u32, attrtype, value)
890
Al Viro00012e52006-09-26 22:14:41 -0700891#define NLA_PUT_BE32(skb, attrtype, value) \
892 NLA_PUT_TYPE(skb, __be32, attrtype, value)
893
Thomas Grafbfa83a92005-11-10 02:25:51 +0100894#define NLA_PUT_U64(skb, attrtype, value) \
895 NLA_PUT_TYPE(skb, u64, attrtype, value)
896
897#define NLA_PUT_STRING(skb, attrtype, value) \
898 NLA_PUT(skb, attrtype, strlen(value) + 1, value)
899
Johannes Bergff5dfe72006-08-26 19:17:53 -0700900#define NLA_PUT_FLAG(skb, attrtype) \
Thomas Grafbfa83a92005-11-10 02:25:51 +0100901 NLA_PUT(skb, attrtype, 0, NULL)
902
903#define NLA_PUT_MSECS(skb, attrtype, jiffies) \
904 NLA_PUT_U64(skb, attrtype, jiffies_to_msecs(jiffies))
905
906/**
907 * nla_get_u32 - return payload of u32 attribute
908 * @nla: u32 netlink attribute
909 */
910static inline u32 nla_get_u32(struct nlattr *nla)
911{
912 return *(u32 *) nla_data(nla);
913}
914
915/**
Al Viro00012e52006-09-26 22:14:41 -0700916 * nla_get_be32 - return payload of __be32 attribute
917 * @nla: __be32 netlink attribute
918 */
919static inline __be32 nla_get_be32(struct nlattr *nla)
920{
921 return *(__be32 *) nla_data(nla);
922}
923
924/**
Thomas Grafbfa83a92005-11-10 02:25:51 +0100925 * nla_get_u16 - return payload of u16 attribute
926 * @nla: u16 netlink attribute
927 */
928static inline u16 nla_get_u16(struct nlattr *nla)
929{
930 return *(u16 *) nla_data(nla);
931}
932
933/**
Patrick McHardy838965b2007-12-17 22:29:26 -0800934 * nla_get_be16 - return payload of __be16 attribute
935 * @nla: __be16 netlink attribute
936 */
937static inline __be16 nla_get_be16(struct nlattr *nla)
938{
939 return *(__be16 *) nla_data(nla);
940}
941
942/**
Thomas Graf4a89c252006-11-24 17:14:51 -0800943 * nla_get_le16 - return payload of __le16 attribute
944 * @nla: __le16 netlink attribute
945 */
946static inline __le16 nla_get_le16(struct nlattr *nla)
947{
948 return *(__le16 *) nla_data(nla);
949}
950
951/**
Thomas Grafbfa83a92005-11-10 02:25:51 +0100952 * nla_get_u8 - return payload of u8 attribute
953 * @nla: u8 netlink attribute
954 */
955static inline u8 nla_get_u8(struct nlattr *nla)
956{
957 return *(u8 *) nla_data(nla);
958}
959
960/**
961 * nla_get_u64 - return payload of u64 attribute
962 * @nla: u64 netlink attribute
963 */
964static inline u64 nla_get_u64(struct nlattr *nla)
965{
966 u64 tmp;
967
968 nla_memcpy(&tmp, nla, sizeof(tmp));
969
970 return tmp;
971}
972
973/**
974 * nla_get_flag - return payload of flag attribute
975 * @nla: flag netlink attribute
976 */
977static inline int nla_get_flag(struct nlattr *nla)
978{
979 return !!nla;
980}
981
982/**
983 * nla_get_msecs - return payload of msecs attribute
984 * @nla: msecs netlink attribute
985 *
986 * Returns the number of milliseconds in jiffies.
987 */
988static inline unsigned long nla_get_msecs(struct nlattr *nla)
989{
990 u64 msecs = nla_get_u64(nla);
991
992 return msecs_to_jiffies((unsigned long) msecs);
993}
994
995/**
996 * nla_nest_start - Start a new level of nested attributes
997 * @skb: socket buffer to add attributes to
998 * @attrtype: attribute type of container
999 *
1000 * Returns the container attribute
1001 */
1002static inline struct nlattr *nla_nest_start(struct sk_buff *skb, int attrtype)
1003{
Arnaldo Carvalho de Melo27a884d2007-04-19 20:29:13 -07001004 struct nlattr *start = (struct nlattr *)skb_tail_pointer(skb);
Thomas Grafbfa83a92005-11-10 02:25:51 +01001005
1006 if (nla_put(skb, attrtype, 0, NULL) < 0)
1007 return NULL;
1008
1009 return start;
1010}
1011
1012/**
1013 * nla_nest_end - Finalize nesting of attributes
Pierre Ynardd1ec3b72007-10-10 21:09:48 -07001014 * @skb: socket buffer the attributes are stored in
Thomas Grafbfa83a92005-11-10 02:25:51 +01001015 * @start: container attribute
1016 *
1017 * Corrects the container attribute header to include the all
1018 * appeneded attributes.
1019 *
1020 * Returns the total data length of the skb.
1021 */
1022static inline int nla_nest_end(struct sk_buff *skb, struct nlattr *start)
1023{
Arnaldo Carvalho de Melo27a884d2007-04-19 20:29:13 -07001024 start->nla_len = skb_tail_pointer(skb) - (unsigned char *)start;
Thomas Grafbfa83a92005-11-10 02:25:51 +01001025 return skb->len;
1026}
1027
1028/**
Patrick McHardy1092cb22007-06-25 13:49:35 -07001029 * nla_nest_compat_start - Start a new level of nested compat attributes
1030 * @skb: socket buffer to add attributes to
1031 * @attrtype: attribute type of container
1032 * @attrlen: length of structure
1033 * @data: pointer to structure
1034 *
1035 * Start a nested compat attribute that contains both a structure and
1036 * a set of nested attributes.
1037 *
1038 * Returns the container attribute
1039 */
1040static inline struct nlattr *nla_nest_compat_start(struct sk_buff *skb,
1041 int attrtype, int attrlen,
1042 const void *data)
1043{
1044 struct nlattr *start = (struct nlattr *)skb_tail_pointer(skb);
1045
1046 if (nla_put(skb, attrtype, attrlen, data) < 0)
1047 return NULL;
1048 if (nla_nest_start(skb, attrtype) == NULL) {
1049 nlmsg_trim(skb, start);
1050 return NULL;
1051 }
1052 return start;
1053}
1054
1055/**
1056 * nla_nest_compat_end - Finalize nesting of compat attributes
Pierre Ynardd1ec3b72007-10-10 21:09:48 -07001057 * @skb: socket buffer the attributes are stored in
Patrick McHardy1092cb22007-06-25 13:49:35 -07001058 * @start: container attribute
1059 *
1060 * Corrects the container attribute header to include the all
1061 * appeneded attributes.
1062 *
1063 * Returns the total data length of the skb.
1064 */
1065static inline int nla_nest_compat_end(struct sk_buff *skb, struct nlattr *start)
1066{
1067 struct nlattr *nest = (void *)start + NLMSG_ALIGN(start->nla_len);
1068
1069 start->nla_len = skb_tail_pointer(skb) - (unsigned char *)start;
1070 return nla_nest_end(skb, nest);
1071}
1072
1073/**
Thomas Grafbfa83a92005-11-10 02:25:51 +01001074 * nla_nest_cancel - Cancel nesting of attributes
1075 * @skb: socket buffer the message is stored in
1076 * @start: container attribute
1077 *
1078 * Removes the container attribute and including all nested
1079 * attributes. Returns -1.
1080 */
1081static inline int nla_nest_cancel(struct sk_buff *skb, struct nlattr *start)
1082{
Thomas Graffe4944e2006-08-04 23:03:05 -07001083 return nlmsg_trim(skb, start);
Thomas Grafbfa83a92005-11-10 02:25:51 +01001084}
1085
1086/**
Paul Moore4fe5d5c2006-09-25 15:54:03 -07001087 * nla_validate_nested - Validate a stream of nested attributes
1088 * @start: container attribute
1089 * @maxtype: maximum attribute type to be expected
1090 * @policy: validation policy
1091 *
1092 * Validates all attributes in the nested attribute stream against the
1093 * specified policy. Attributes with a type exceeding maxtype will be
1094 * ignored. See documenation of struct nla_policy for more details.
1095 *
1096 * Returns 0 on success or a negative error code.
1097 */
1098static inline int nla_validate_nested(struct nlattr *start, int maxtype,
Patrick McHardyef7c79e2007-06-05 12:38:30 -07001099 const struct nla_policy *policy)
Paul Moore4fe5d5c2006-09-25 15:54:03 -07001100{
1101 return nla_validate(nla_data(start), nla_len(start), maxtype, policy);
1102}
1103
1104/**
Thomas Grafbfa83a92005-11-10 02:25:51 +01001105 * nla_for_each_attr - iterate over a stream of attributes
1106 * @pos: loop counter, set to current attribute
1107 * @head: head of attribute stream
1108 * @len: length of attribute stream
1109 * @rem: initialized to len, holds bytes currently remaining in stream
1110 */
1111#define nla_for_each_attr(pos, head, len, rem) \
1112 for (pos = head, rem = len; \
1113 nla_ok(pos, rem); \
1114 pos = nla_next(pos, &(rem)))
1115
Thomas Graffe4944e2006-08-04 23:03:05 -07001116/**
1117 * nla_for_each_nested - iterate over nested attributes
1118 * @pos: loop counter, set to current attribute
1119 * @nla: attribute containing the nested attributes
1120 * @rem: initialized to len, holds bytes currently remaining in stream
1121 */
1122#define nla_for_each_nested(pos, nla, rem) \
1123 nla_for_each_attr(pos, nla_data(nla), nla_len(nla), rem)
1124
Thomas Grafbfa83a92005-11-10 02:25:51 +01001125#endif