GUI: Fix Tomato RAF theme for all builds. Compilation typo.
[tomato.git] / release / src-rt-6.x.4708 / linux / linux-2.6.36 / include / net / netlink.h
bloba1c5ac5e911144c5825d5f3b42ec55086ac32ed6
1 #ifndef __NET_NETLINK_H
2 #define __NET_NETLINK_H
4 #include <linux/types.h>
5 #include <linux/netlink.h>
6 #include <linux/jiffies.h>
8 /* ========================================================================
9 * Netlink Messages and Attributes Interface (As Seen On TV)
10 * ------------------------------------------------------------------------
11 * Messages Interface
12 * ------------------------------------------------------------------------
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)-----------------------+
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)---^
31 * Data Structures:
32 * struct nlmsghdr netlink message header
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() finalize netlink message
39 * nlmsg_get_pos() return current position in message
40 * nlmsg_trim() trim part of message
41 * nlmsg_cancel() cancel message construction
42 * nlmsg_free() free a netlink message
44 * Message Sending:
45 * nlmsg_multicast() multicast message to several groups
46 * nlmsg_unicast() unicast a message to a single socket
47 * nlmsg_notify() send notification message
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
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
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
69 * Misc:
70 * nlmsg_report() report back to application?
72 * ------------------------------------------------------------------------
73 * Attributes Interface
74 * ------------------------------------------------------------------------
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)-----------------------------'
86 * Data Structures:
87 * struct nlattr netlink attribute header
89 * Attribute Construction:
90 * nla_reserve(skb, type, len) reserve room for an attribute
91 * nla_reserve_nohdr(skb, len) reserve room for an attribute w/o hdr
92 * nla_put(skb, type, len, data) add attribute to skb
93 * nla_put_nohdr(skb, len, data) add attribute w/o hdr
94 * nla_append(skb, len, data) append data to skb
96 * Attribute Construction for Basic Types:
97 * nla_put_u8(skb, type, value) add u8 attribute to skb
98 * nla_put_u16(skb, type, value) add u16 attribute to skb
99 * nla_put_u32(skb, type, value) add u32 attribute to skb
100 * nla_put_u64(skb, type, value) add u64 attribute to skb
101 * nla_put_string(skb, type, str) add string attribute to skb
102 * nla_put_flag(skb, type) add flag attribute to skb
103 * nla_put_msecs(skb, type, jiffies) add msecs attribute to skb
105 * Exceptions Based Attribute Construction:
106 * NLA_PUT(skb, type, len, data) add attribute to skb
107 * NLA_PUT_U8(skb, type, value) add u8 attribute to skb
108 * NLA_PUT_U16(skb, type, value) add u16 attribute to skb
109 * NLA_PUT_U32(skb, type, value) add u32 attribute to skb
110 * NLA_PUT_U64(skb, type, value) add u64 attribute to skb
111 * NLA_PUT_STRING(skb, type, str) add string attribute to skb
112 * NLA_PUT_FLAG(skb, type) add flag attribute to skb
113 * NLA_PUT_MSECS(skb, type, jiffies) add msecs attribute to skb
115 * The meaning of these functions is equal to their lower case
116 * variants but they jump to the label nla_put_failure in case
117 * of a failure.
119 * Nested Attributes Construction:
120 * nla_nest_start(skb, type) start a nested attribute
121 * nla_nest_end(skb, nla) finalize a nested attribute
122 * nla_nest_cancel(skb, nla) cancel nested attribute construction
124 * Attribute Length Calculations:
125 * nla_attr_size(payload) length of attribute w/o padding
126 * nla_total_size(payload) length of attribute w/ padding
127 * nla_padlen(payload) length of padding
129 * Attribute Payload Access:
130 * nla_data(nla) head of attribute payload
131 * nla_len(nla) length of attribute payload
133 * Attribute Payload Access for Basic Types:
134 * nla_get_u8(nla) get payload for a u8 attribute
135 * nla_get_u16(nla) get payload for a u16 attribute
136 * nla_get_u32(nla) get payload for a u32 attribute
137 * nla_get_u64(nla) get payload for a u64 attribute
138 * nla_get_flag(nla) return 1 if flag is true
139 * nla_get_msecs(nla) get payload for a msecs attribute
141 * Attribute Misc:
142 * nla_memcpy(dest, nla, count) copy attribute into memory
143 * nla_memcmp(nla, data, size) compare attribute with memory area
144 * nla_strlcpy(dst, nla, size) copy attribute to a sized string
145 * nla_strcmp(nla, str) compare attribute with string
147 * Attribute Parsing:
148 * nla_ok(nla, remaining) does nla fit into remaining bytes?
149 * nla_next(nla, remaining) get next netlink attribute
150 * nla_validate() validate a stream of attributes
151 * nla_validate_nested() validate a stream of nested attributes
152 * nla_find() find attribute in stream of attributes
153 * nla_find_nested() find attribute in nested attributes
154 * nla_parse() parse and validate stream of attrs
155 * nla_parse_nested() parse nested attribuets
156 * nla_for_each_attr() loop over all attributes
157 * nla_for_each_nested() loop over the nested attributes
158 *=========================================================================
162 * Standard attribute types to specify validation policy
164 enum {
165 NLA_UNSPEC,
166 NLA_U8,
167 NLA_U16,
168 NLA_U32,
169 NLA_U64,
170 NLA_STRING,
171 NLA_FLAG,
172 NLA_MSECS,
173 NLA_NESTED,
174 NLA_NESTED_COMPAT,
175 NLA_NUL_STRING,
176 NLA_BINARY,
177 __NLA_TYPE_MAX,
180 #define NLA_TYPE_MAX (__NLA_TYPE_MAX - 1)
183 * struct nla_policy - attribute validation policy
184 * @type: Type of attribute or NLA_UNSPEC
185 * @len: Type specific length of payload
187 * Policies are defined as arrays of this struct, the array must be
188 * accessible by attribute type up to the highest identifier to be expected.
190 * Meaning of `len' field:
191 * NLA_STRING Maximum length of string
192 * NLA_NUL_STRING Maximum length of string (excluding NUL)
193 * NLA_FLAG Unused
194 * NLA_BINARY Maximum length of attribute payload
195 * NLA_NESTED_COMPAT Exact length of structure payload
196 * All other Exact length of attribute payload
198 * Example:
199 * static const struct nla_policy my_policy[ATTR_MAX+1] = {
200 * [ATTR_FOO] = { .type = NLA_U16 },
201 * [ATTR_BAR] = { .type = NLA_STRING, .len = BARSIZ },
202 * [ATTR_BAZ] = { .len = sizeof(struct mystruct) },
203 * };
205 struct nla_policy {
206 u16 type;
207 u16 len;
211 * struct nl_info - netlink source information
212 * @nlh: Netlink message header of original request
213 * @pid: Netlink PID of requesting application
215 struct nl_info {
216 struct nlmsghdr *nlh;
217 struct net *nl_net;
218 u32 pid;
221 extern int netlink_rcv_skb(struct sk_buff *skb,
222 int (*cb)(struct sk_buff *,
223 struct nlmsghdr *));
224 extern int nlmsg_notify(struct sock *sk, struct sk_buff *skb,
225 u32 pid, unsigned int group, int report,
226 gfp_t flags);
228 extern int nla_validate(struct nlattr *head, int len, int maxtype,
229 const struct nla_policy *policy);
230 extern int nla_parse(struct nlattr *tb[], int maxtype,
231 struct nlattr *head, int len,
232 const struct nla_policy *policy);
233 extern int nla_policy_len(const struct nla_policy *, int);
234 extern struct nlattr * nla_find(struct nlattr *head, int len, int attrtype);
235 extern size_t nla_strlcpy(char *dst, const struct nlattr *nla,
236 size_t dstsize);
237 extern int nla_memcpy(void *dest, const struct nlattr *src, int count);
238 extern int nla_memcmp(const struct nlattr *nla, const void *data,
239 size_t size);
240 extern int nla_strcmp(const struct nlattr *nla, const char *str);
241 extern struct nlattr * __nla_reserve(struct sk_buff *skb, int attrtype,
242 int attrlen);
243 extern void * __nla_reserve_nohdr(struct sk_buff *skb, int attrlen);
244 extern struct nlattr * nla_reserve(struct sk_buff *skb, int attrtype,
245 int attrlen);
246 extern void * nla_reserve_nohdr(struct sk_buff *skb, int attrlen);
247 extern void __nla_put(struct sk_buff *skb, int attrtype,
248 int attrlen, const void *data);
249 extern void __nla_put_nohdr(struct sk_buff *skb, int attrlen,
250 const void *data);
251 extern int nla_put(struct sk_buff *skb, int attrtype,
252 int attrlen, const void *data);
253 extern int nla_put_nohdr(struct sk_buff *skb, int attrlen,
254 const void *data);
255 extern int nla_append(struct sk_buff *skb, int attrlen,
256 const void *data);
258 /**************************************************************************
259 * Netlink Messages
260 **************************************************************************/
263 * nlmsg_msg_size - length of netlink message not including padding
264 * @payload: length of message payload
266 static inline int nlmsg_msg_size(int payload)
268 return NLMSG_HDRLEN + payload;
272 * nlmsg_total_size - length of netlink message including padding
273 * @payload: length of message payload
275 static inline int nlmsg_total_size(int payload)
277 return NLMSG_ALIGN(nlmsg_msg_size(payload));
281 * nlmsg_padlen - length of padding at the message's tail
282 * @payload: length of message payload
284 static inline int nlmsg_padlen(int payload)
286 return nlmsg_total_size(payload) - nlmsg_msg_size(payload);
290 * nlmsg_data - head of message payload
291 * @nlh: netlink messsage header
293 static inline void *nlmsg_data(const struct nlmsghdr *nlh)
295 return (unsigned char *) nlh + NLMSG_HDRLEN;
299 * nlmsg_len - length of message payload
300 * @nlh: netlink message header
302 static inline int nlmsg_len(const struct nlmsghdr *nlh)
304 return nlh->nlmsg_len - NLMSG_HDRLEN;
308 * nlmsg_attrdata - head of attributes data
309 * @nlh: netlink message header
310 * @hdrlen: length of family specific header
312 static inline struct nlattr *nlmsg_attrdata(const struct nlmsghdr *nlh,
313 int hdrlen)
315 unsigned char *data = nlmsg_data(nlh);
316 return (struct nlattr *) (data + NLMSG_ALIGN(hdrlen));
320 * nlmsg_attrlen - length of attributes data
321 * @nlh: netlink message header
322 * @hdrlen: length of family specific header
324 static inline int nlmsg_attrlen(const struct nlmsghdr *nlh, int hdrlen)
326 return nlmsg_len(nlh) - NLMSG_ALIGN(hdrlen);
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
334 static inline int nlmsg_ok(const struct nlmsghdr *nlh, int remaining)
336 return (remaining >= (int) sizeof(struct nlmsghdr) &&
337 nlh->nlmsg_len >= sizeof(struct nlmsghdr) &&
338 nlh->nlmsg_len <= remaining);
342 * nlmsg_next - next netlink message in message stream
343 * @nlh: netlink message header
344 * @remaining: number of bytes remaining in message stream
346 * Returns the next netlink message in the message stream and
347 * decrements remaining by the size of the current message.
349 static inline struct nlmsghdr *nlmsg_next(struct nlmsghdr *nlh, int *remaining)
351 int totlen = NLMSG_ALIGN(nlh->nlmsg_len);
353 *remaining -= totlen;
355 return (struct nlmsghdr *) ((unsigned char *) nlh + totlen);
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
366 * See nla_parse()
368 static inline int nlmsg_parse(const struct nlmsghdr *nlh, int hdrlen,
369 struct nlattr *tb[], int maxtype,
370 const struct nla_policy *policy)
372 if (nlh->nlmsg_len < nlmsg_msg_size(hdrlen))
373 return -EINVAL;
375 return nla_parse(tb, maxtype, nlmsg_attrdata(nlh, hdrlen),
376 nlmsg_attrlen(nlh, hdrlen), policy);
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
385 * Returns the first attribute which matches the specified type.
387 static inline struct nlattr *nlmsg_find_attr(struct nlmsghdr *nlh,
388 int hdrlen, int attrtype)
390 return nla_find(nlmsg_attrdata(nlh, hdrlen),
391 nlmsg_attrlen(nlh, hdrlen), attrtype);
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
401 static inline int nlmsg_validate(struct nlmsghdr *nlh, int hdrlen, int maxtype,
402 const struct nla_policy *policy)
404 if (nlh->nlmsg_len < nlmsg_msg_size(hdrlen))
405 return -EINVAL;
407 return nla_validate(nlmsg_attrdata(nlh, hdrlen),
408 nlmsg_attrlen(nlh, hdrlen), maxtype, policy);
412 * nlmsg_report - need to report back to application?
413 * @nlh: netlink message header
415 * Returns 1 if a report back to the application is requested.
417 static inline int nlmsg_report(const struct nlmsghdr *nlh)
419 return !!(nlh->nlmsg_flags & NLM_F_ECHO);
423 * 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
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)
435 * nlmsg_put - Add a new netlink message to an skb
436 * @skb: socket buffer to store message in
437 * @pid: netlink process id
438 * @seq: sequence number of message
439 * @type: message type
440 * @payload: length of message payload
441 * @flags: message flags
443 * Returns NULL if the tailroom of the skb is insufficient to store
444 * the message header and payload.
446 static inline struct nlmsghdr *nlmsg_put(struct sk_buff *skb, u32 pid, u32 seq,
447 int type, int payload, int flags)
449 if (unlikely(skb_tailroom(skb) < nlmsg_total_size(payload)))
450 return NULL;
452 return __nlmsg_put(skb, pid, seq, type, payload, flags);
456 * nlmsg_put_answer - Add a new callback based netlink message to an skb
457 * @skb: socket buffer to store message in
458 * @cb: netlink callback
459 * @type: message type
460 * @payload: length of message payload
461 * @flags: message flags
463 * Returns NULL if the tailroom of the skb is insufficient to store
464 * the message header and payload.
466 static inline struct nlmsghdr *nlmsg_put_answer(struct sk_buff *skb,
467 struct netlink_callback *cb,
468 int type, int payload,
469 int flags)
471 return nlmsg_put(skb, NETLINK_CB(cb->skb).pid, cb->nlh->nlmsg_seq,
472 type, payload, flags);
476 * nlmsg_new - Allocate a new netlink message
477 * @payload: size of the message payload
478 * @flags: the type of memory to allocate.
480 * Use NLMSG_DEFAULT_SIZE if the size of the payload isn't known
481 * and a good default is needed.
483 static inline struct sk_buff *nlmsg_new(size_t payload, gfp_t flags)
485 return alloc_skb(nlmsg_total_size(payload), flags);
489 * nlmsg_end - Finalize a netlink message
490 * @skb: socket buffer the message is stored in
491 * @nlh: netlink message header
493 * Corrects the netlink message header to include the appeneded
494 * attributes. Only necessary if attributes have been added to
495 * the message.
497 * Returns the total data length of the skb.
499 static inline int nlmsg_end(struct sk_buff *skb, struct nlmsghdr *nlh)
501 nlh->nlmsg_len = skb_tail_pointer(skb) - (unsigned char *)nlh;
503 return skb->len;
507 * nlmsg_get_pos - return current position in netlink message
508 * @skb: socket buffer the message is stored in
510 * Returns a pointer to the current tail of the message.
512 static inline void *nlmsg_get_pos(struct sk_buff *skb)
514 return skb_tail_pointer(skb);
518 * nlmsg_trim - Trim message to a mark
519 * @skb: socket buffer the message is stored in
520 * @mark: mark to trim to
522 * Trims the message to the provided mark.
524 static inline void nlmsg_trim(struct sk_buff *skb, const void *mark)
526 if (mark)
527 skb_trim(skb, (unsigned char *) mark - skb->data);
531 * nlmsg_cancel - Cancel construction of a netlink message
532 * @skb: socket buffer the message is stored in
533 * @nlh: netlink message header
535 * Removes the complete netlink message including all
536 * attributes from the socket buffer again.
538 static inline void nlmsg_cancel(struct sk_buff *skb, struct nlmsghdr *nlh)
540 nlmsg_trim(skb, nlh);
544 * nlmsg_free - free a netlink message
545 * @skb: socket buffer of netlink message
547 static inline void nlmsg_free(struct sk_buff *skb)
549 kfree_skb(skb);
553 * nlmsg_multicast - multicast a netlink message
554 * @sk: netlink socket to spread messages to
555 * @skb: netlink message as socket buffer
556 * @pid: own netlink pid to avoid sending to yourself
557 * @group: multicast group id
558 * @flags: allocation flags
560 static inline int nlmsg_multicast(struct sock *sk, struct sk_buff *skb,
561 u32 pid, unsigned int group, gfp_t flags)
563 int err;
565 NETLINK_CB(skb).dst_group = group;
567 err = netlink_broadcast(sk, skb, pid, group, flags);
568 if (err > 0)
569 err = 0;
571 return err;
575 * nlmsg_unicast - unicast a netlink message
576 * @sk: netlink socket to spread message to
577 * @skb: netlink message as socket buffer
578 * @pid: netlink pid of the destination socket
580 static inline int nlmsg_unicast(struct sock *sk, struct sk_buff *skb, u32 pid)
582 int err;
584 err = netlink_unicast(sk, skb, pid, MSG_DONTWAIT);
585 if (err > 0)
586 err = 0;
588 return err;
592 * nlmsg_for_each_msg - iterate over a stream of messages
593 * @pos: loop counter, set to current message
594 * @head: head of message stream
595 * @len: length of message stream
596 * @rem: initialized to len, holds bytes currently remaining in stream
598 #define nlmsg_for_each_msg(pos, head, len, rem) \
599 for (pos = head, rem = len; \
600 nlmsg_ok(pos, rem); \
601 pos = nlmsg_next(pos, &(rem)))
603 /**************************************************************************
604 * Netlink Attributes
605 **************************************************************************/
608 * nla_attr_size - length of attribute not including padding
609 * @payload: length of payload
611 static inline int nla_attr_size(int payload)
613 return NLA_HDRLEN + payload;
617 * nla_total_size - total length of attribute including padding
618 * @payload: length of payload
620 static inline int nla_total_size(int payload)
622 return NLA_ALIGN(nla_attr_size(payload));
626 * nla_padlen - length of padding at the tail of attribute
627 * @payload: length of payload
629 static inline int nla_padlen(int payload)
631 return nla_total_size(payload) - nla_attr_size(payload);
635 * nla_type - attribute type
636 * @nla: netlink attribute
638 static inline int nla_type(const struct nlattr *nla)
640 return nla->nla_type & NLA_TYPE_MASK;
644 * nla_data - head of payload
645 * @nla: netlink attribute
647 static inline void *nla_data(const struct nlattr *nla)
649 return (char *) nla + NLA_HDRLEN;
653 * nla_len - length of payload
654 * @nla: netlink attribute
656 static inline int nla_len(const struct nlattr *nla)
658 return nla->nla_len - NLA_HDRLEN;
662 * nla_ok - check if the netlink attribute fits into the remaining bytes
663 * @nla: netlink attribute
664 * @remaining: number of bytes remaining in attribute stream
666 static inline int nla_ok(const struct nlattr *nla, int remaining)
668 return remaining >= (int) sizeof(*nla) &&
669 nla->nla_len >= sizeof(*nla) &&
670 nla->nla_len <= remaining;
674 * nla_next - next netlink attribute in attribute stream
675 * @nla: netlink attribute
676 * @remaining: number of bytes remaining in attribute stream
678 * Returns the next netlink attribute in the attribute stream and
679 * decrements remaining by the size of the current attribute.
681 static inline struct nlattr *nla_next(const struct nlattr *nla, int *remaining)
683 int totlen = NLA_ALIGN(nla->nla_len);
685 *remaining -= totlen;
686 return (struct nlattr *) ((char *) nla + totlen);
690 * nla_find_nested - find attribute in a set of nested attributes
691 * @nla: attribute containing the nested attributes
692 * @attrtype: type of attribute to look for
694 * Returns the first attribute which matches the specified type.
696 static inline struct nlattr *nla_find_nested(struct nlattr *nla, int attrtype)
698 return nla_find(nla_data(nla), nla_len(nla), attrtype);
702 * nla_parse_nested - parse nested attributes
703 * @tb: destination array with maxtype+1 elements
704 * @maxtype: maximum attribute type to be expected
705 * @nla: attribute containing the nested attributes
706 * @policy: validation policy
708 * See nla_parse()
710 static inline int nla_parse_nested(struct nlattr *tb[], int maxtype,
711 const struct nlattr *nla,
712 const struct nla_policy *policy)
714 return nla_parse(tb, maxtype, nla_data(nla), nla_len(nla), policy);
718 * nla_put_u8 - Add a u8 netlink attribute to a socket buffer
719 * @skb: socket buffer to add attribute to
720 * @attrtype: attribute type
721 * @value: numeric value
723 static inline int nla_put_u8(struct sk_buff *skb, int attrtype, u8 value)
725 return nla_put(skb, attrtype, sizeof(u8), &value);
729 * nla_put_u16 - Add a u16 netlink attribute to a socket buffer
730 * @skb: socket buffer to add attribute to
731 * @attrtype: attribute type
732 * @value: numeric value
734 static inline int nla_put_u16(struct sk_buff *skb, int attrtype, u16 value)
736 return nla_put(skb, attrtype, sizeof(u16), &value);
740 * nla_put_u32 - Add a u32 netlink attribute to a socket buffer
741 * @skb: socket buffer to add attribute to
742 * @attrtype: attribute type
743 * @value: numeric value
745 static inline int nla_put_u32(struct sk_buff *skb, int attrtype, u32 value)
747 return nla_put(skb, attrtype, sizeof(u32), &value);
751 * nla_put_64 - Add a u64 netlink attribute to a socket buffer
752 * @skb: socket buffer to add attribute to
753 * @attrtype: attribute type
754 * @value: numeric value
756 static inline int nla_put_u64(struct sk_buff *skb, int attrtype, u64 value)
758 return nla_put(skb, attrtype, sizeof(u64), &value);
762 * nla_put_string - Add a string netlink attribute to a socket buffer
763 * @skb: socket buffer to add attribute to
764 * @attrtype: attribute type
765 * @str: NUL terminated string
767 static inline int nla_put_string(struct sk_buff *skb, int attrtype,
768 const char *str)
770 return nla_put(skb, attrtype, strlen(str) + 1, str);
774 * nla_put_flag - Add a flag netlink attribute to a socket buffer
775 * @skb: socket buffer to add attribute to
776 * @attrtype: attribute type
778 static inline int nla_put_flag(struct sk_buff *skb, int attrtype)
780 return nla_put(skb, attrtype, 0, NULL);
784 * nla_put_msecs - Add a msecs netlink attribute to a socket buffer
785 * @skb: socket buffer to add attribute to
786 * @attrtype: attribute type
787 * @jiffies: number of msecs in jiffies
789 static inline int nla_put_msecs(struct sk_buff *skb, int attrtype,
790 unsigned long jiffies)
792 u64 tmp = jiffies_to_msecs(jiffies);
793 return nla_put(skb, attrtype, sizeof(u64), &tmp);
796 #define NLA_PUT(skb, attrtype, attrlen, data) \
797 do { \
798 if (unlikely(nla_put(skb, attrtype, attrlen, data) < 0)) \
799 goto nla_put_failure; \
800 } while(0)
802 #define NLA_PUT_TYPE(skb, type, attrtype, value) \
803 do { \
804 type __tmp = value; \
805 NLA_PUT(skb, attrtype, sizeof(type), &__tmp); \
806 } while(0)
808 #define NLA_PUT_U8(skb, attrtype, value) \
809 NLA_PUT_TYPE(skb, u8, attrtype, value)
811 #define NLA_PUT_U16(skb, attrtype, value) \
812 NLA_PUT_TYPE(skb, u16, attrtype, value)
814 #define NLA_PUT_LE16(skb, attrtype, value) \
815 NLA_PUT_TYPE(skb, __le16, attrtype, value)
817 #define NLA_PUT_BE16(skb, attrtype, value) \
818 NLA_PUT_TYPE(skb, __be16, attrtype, value)
820 #define NLA_PUT_U32(skb, attrtype, value) \
821 NLA_PUT_TYPE(skb, u32, attrtype, value)
823 #define NLA_PUT_BE32(skb, attrtype, value) \
824 NLA_PUT_TYPE(skb, __be32, attrtype, value)
826 #define NLA_PUT_U64(skb, attrtype, value) \
827 NLA_PUT_TYPE(skb, u64, attrtype, value)
829 #define NLA_PUT_BE64(skb, attrtype, value) \
830 NLA_PUT_TYPE(skb, __be64, attrtype, value)
832 #define NLA_PUT_STRING(skb, attrtype, value) \
833 NLA_PUT(skb, attrtype, strlen(value) + 1, value)
835 #define NLA_PUT_FLAG(skb, attrtype) \
836 NLA_PUT(skb, attrtype, 0, NULL)
838 #define NLA_PUT_MSECS(skb, attrtype, jiffies) \
839 NLA_PUT_U64(skb, attrtype, jiffies_to_msecs(jiffies))
842 * nla_get_u32 - return payload of u32 attribute
843 * @nla: u32 netlink attribute
845 static inline u32 nla_get_u32(const struct nlattr *nla)
847 return *(u32 *) nla_data(nla);
851 * nla_get_be32 - return payload of __be32 attribute
852 * @nla: __be32 netlink attribute
854 static inline __be32 nla_get_be32(const struct nlattr *nla)
856 return *(__be32 *) nla_data(nla);
860 * nla_get_u16 - return payload of u16 attribute
861 * @nla: u16 netlink attribute
863 static inline u16 nla_get_u16(const struct nlattr *nla)
865 return *(u16 *) nla_data(nla);
869 * nla_get_be16 - return payload of __be16 attribute
870 * @nla: __be16 netlink attribute
872 static inline __be16 nla_get_be16(const struct nlattr *nla)
874 return *(__be16 *) nla_data(nla);
878 * nla_get_le16 - return payload of __le16 attribute
879 * @nla: __le16 netlink attribute
881 static inline __le16 nla_get_le16(const struct nlattr *nla)
883 return *(__le16 *) nla_data(nla);
887 * nla_get_u8 - return payload of u8 attribute
888 * @nla: u8 netlink attribute
890 static inline u8 nla_get_u8(const struct nlattr *nla)
892 return *(u8 *) nla_data(nla);
896 * nla_get_u64 - return payload of u64 attribute
897 * @nla: u64 netlink attribute
899 static inline u64 nla_get_u64(const struct nlattr *nla)
901 u64 tmp;
903 nla_memcpy(&tmp, nla, sizeof(tmp));
905 return tmp;
909 * nla_get_be64 - return payload of __be64 attribute
910 * @nla: __be64 netlink attribute
912 static inline __be64 nla_get_be64(const struct nlattr *nla)
914 __be64 tmp;
916 nla_memcpy(&tmp, nla, sizeof(tmp));
918 return tmp;
922 * nla_get_flag - return payload of flag attribute
923 * @nla: flag netlink attribute
925 static inline int nla_get_flag(const struct nlattr *nla)
927 return !!nla;
931 * nla_get_msecs - return payload of msecs attribute
932 * @nla: msecs netlink attribute
934 * Returns the number of milliseconds in jiffies.
936 static inline unsigned long nla_get_msecs(const struct nlattr *nla)
938 u64 msecs = nla_get_u64(nla);
940 return msecs_to_jiffies((unsigned long) msecs);
944 * nla_nest_start - Start a new level of nested attributes
945 * @skb: socket buffer to add attributes to
946 * @attrtype: attribute type of container
948 * Returns the container attribute
950 static inline struct nlattr *nla_nest_start(struct sk_buff *skb, int attrtype)
952 struct nlattr *start = (struct nlattr *)skb_tail_pointer(skb);
954 if (nla_put(skb, attrtype, 0, NULL) < 0)
955 return NULL;
957 return start;
961 * nla_nest_end - Finalize nesting of attributes
962 * @skb: socket buffer the attributes are stored in
963 * @start: container attribute
965 * Corrects the container attribute header to include the all
966 * appeneded attributes.
968 * Returns the total data length of the skb.
970 static inline int nla_nest_end(struct sk_buff *skb, struct nlattr *start)
972 start->nla_len = skb_tail_pointer(skb) - (unsigned char *)start;
973 return skb->len;
977 * nla_nest_cancel - Cancel nesting of attributes
978 * @skb: socket buffer the message is stored in
979 * @start: container attribute
981 * Removes the container attribute and including all nested
982 * attributes. Returns -EMSGSIZE
984 static inline void nla_nest_cancel(struct sk_buff *skb, struct nlattr *start)
986 nlmsg_trim(skb, start);
990 * nla_validate_nested - Validate a stream of nested attributes
991 * @start: container attribute
992 * @maxtype: maximum attribute type to be expected
993 * @policy: validation policy
995 * Validates all attributes in the nested attribute stream against the
996 * specified policy. Attributes with a type exceeding maxtype will be
997 * ignored. See documenation of struct nla_policy for more details.
999 * Returns 0 on success or a negative error code.
1001 static inline int nla_validate_nested(struct nlattr *start, int maxtype,
1002 const struct nla_policy *policy)
1004 return nla_validate(nla_data(start), nla_len(start), maxtype, policy);
1008 * nla_for_each_attr - iterate over a stream of attributes
1009 * @pos: loop counter, set to current attribute
1010 * @head: head of attribute stream
1011 * @len: length of attribute stream
1012 * @rem: initialized to len, holds bytes currently remaining in stream
1014 #define nla_for_each_attr(pos, head, len, rem) \
1015 for (pos = head, rem = len; \
1016 nla_ok(pos, rem); \
1017 pos = nla_next(pos, &(rem)))
1020 * nla_for_each_nested - iterate over nested attributes
1021 * @pos: loop counter, set to current attribute
1022 * @nla: attribute containing the nested attributes
1023 * @rem: initialized to len, holds bytes currently remaining in stream
1025 #define nla_for_each_nested(pos, nla, rem) \
1026 nla_for_each_attr(pos, nla_data(nla), nla_len(nla), rem)
1028 #endif