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>
9 /* ========================================================================
10 * Netlink Messages and Attributes Interface (As Seen On TV)
11 * ------------------------------------------------------------------------
13 * ------------------------------------------------------------------------
16 * <--- nlmsg_total_size(payload) --->
17 * <-- nlmsg_msg_size(payload) ->
18 * +----------+- - -+-------------+- - -+-------- - -
19 * | nlmsghdr | Pad | Payload | Pad | nlmsghdr
20 * +----------+- - -+-------------+- - -+-------- - -
21 * nlmsg_data(nlh)---^ ^
22 * nlmsg_next(nlh)-----------------------+
25 * <---------------------- nlmsg_len(nlh) --------------------->
26 * <------ hdrlen ------> <- nlmsg_attrlen(nlh, hdrlen) ->
27 * +----------------------+- - -+--------------------------------+
28 * | Family Header | Pad | Attributes |
29 * +----------------------+- - -+--------------------------------+
30 * nlmsg_attrdata(nlh, hdrlen)---^
33 * struct nlmsghdr netlink message header
35 * Message Construction:
36 * nlmsg_new() create a new netlink message
37 * nlmsg_put() add a netlink message to an skb
38 * nlmsg_put_answer() callback based nlmsg_put()
39 * nlmsg_end() finalize netlink message
40 * nlmsg_get_pos() return current position in message
41 * nlmsg_trim() trim part of message
42 * nlmsg_cancel() cancel message construction
43 * nlmsg_free() free a netlink message
46 * nlmsg_multicast() multicast message to several groups
47 * nlmsg_unicast() unicast a message to a single socket
48 * nlmsg_notify() send notification message
50 * Message Length Calculations:
51 * nlmsg_msg_size(payload) length of message w/o padding
52 * nlmsg_total_size(payload) length of message w/ padding
53 * nlmsg_padlen(payload) length of padding at tail
55 * Message Payload Access:
56 * nlmsg_data(nlh) head of message payload
57 * nlmsg_len(nlh) length of message payload
58 * nlmsg_attrdata(nlh, hdrlen) head of attributes data
59 * nlmsg_attrlen(nlh, hdrlen) length of attributes data
62 * nlmsg_ok(nlh, remaining) does nlh fit into remaining bytes?
63 * nlmsg_next(nlh, remaining) get next netlink message
64 * nlmsg_parse() parse attributes of a message
65 * nlmsg_find_attr() find an attribute in a message
66 * nlmsg_for_each_msg() loop over all messages
67 * nlmsg_validate() validate netlink message incl. attrs
68 * nlmsg_for_each_attr() loop over all attributes
71 * nlmsg_report() report back to application?
73 * ------------------------------------------------------------------------
74 * Attributes Interface
75 * ------------------------------------------------------------------------
78 * <------- nla_total_size(payload) ------->
79 * <---- nla_attr_size(payload) ----->
80 * +----------+- - -+- - - - - - - - - +- - -+-------- - -
81 * | Header | Pad | Payload | Pad | Header
82 * +----------+- - -+- - - - - - - - - +- - -+-------- - -
83 * <- nla_len(nla) -> ^
84 * nla_data(nla)----^ |
85 * nla_next(nla)-----------------------------'
88 * struct nlattr netlink attribute header
90 * Attribute Construction:
91 * nla_reserve(skb, type, len) reserve room for an attribute
92 * nla_reserve_nohdr(skb, len) reserve room for an attribute w/o hdr
93 * nla_put(skb, type, len, data) add attribute to skb
94 * nla_put_nohdr(skb, len, data) add attribute w/o hdr
95 * nla_append(skb, len, data) append data to skb
97 * Attribute Construction for Basic Types:
98 * nla_put_u8(skb, type, value) add u8 attribute to skb
99 * nla_put_u16(skb, type, value) add u16 attribute to skb
100 * nla_put_u32(skb, type, value) add u32 attribute to skb
101 * nla_put_u64_64bits(skb, type,
102 * value, padattr) add u64 attribute to skb
103 * nla_put_s8(skb, type, value) add s8 attribute to skb
104 * nla_put_s16(skb, type, value) add s16 attribute to skb
105 * nla_put_s32(skb, type, value) add s32 attribute to skb
106 * nla_put_s64(skb, type, value,
107 * padattr) add s64 attribute to skb
108 * nla_put_string(skb, type, str) add string attribute to skb
109 * nla_put_flag(skb, type) add flag attribute to skb
110 * nla_put_msecs(skb, type, jiffies,
111 * padattr) add msecs attribute to skb
112 * nla_put_in_addr(skb, type, addr) add IPv4 address attribute to skb
113 * nla_put_in6_addr(skb, type, addr) add IPv6 address attribute to skb
115 * Nested Attributes Construction:
116 * nla_nest_start(skb, type) start a nested attribute
117 * nla_nest_end(skb, nla) finalize a nested attribute
118 * nla_nest_cancel(skb, nla) cancel nested attribute construction
120 * Attribute Length Calculations:
121 * nla_attr_size(payload) length of attribute w/o padding
122 * nla_total_size(payload) length of attribute w/ padding
123 * nla_padlen(payload) length of padding
125 * Attribute Payload Access:
126 * nla_data(nla) head of attribute payload
127 * nla_len(nla) length of attribute payload
129 * Attribute Payload Access for Basic Types:
130 * nla_get_u8(nla) get payload for a u8 attribute
131 * nla_get_u16(nla) get payload for a u16 attribute
132 * nla_get_u32(nla) get payload for a u32 attribute
133 * nla_get_u64(nla) get payload for a u64 attribute
134 * nla_get_s8(nla) get payload for a s8 attribute
135 * nla_get_s16(nla) get payload for a s16 attribute
136 * nla_get_s32(nla) get payload for a s32 attribute
137 * nla_get_s64(nla) get payload for a s64 attribute
138 * nla_get_flag(nla) return 1 if flag is true
139 * nla_get_msecs(nla) get payload for a msecs attribute
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
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
184 #define NLA_TYPE_MAX (__NLA_TYPE_MAX - 1)
187 * struct nla_policy - attribute validation policy
188 * @type: Type of attribute or NLA_UNSPEC
189 * @len: Type specific length of payload
191 * Policies are defined as arrays of this struct, the array must be
192 * accessible by attribute type up to the highest identifier to be expected.
194 * Meaning of `len' field:
195 * NLA_STRING Maximum length of string
196 * NLA_NUL_STRING Maximum length of string (excluding NUL)
198 * NLA_BINARY Maximum length of attribute payload
199 * NLA_NESTED Don't use `len' field -- length verification is
200 * done by checking len of nested header (or empty)
201 * NLA_NESTED_COMPAT Minimum length of structure payload
206 * NLA_MSECS Leaving the length field zero will verify the
207 * given type fits, using it verifies minimum length
208 * just like "All other"
209 * All other Minimum length of attribute payload
212 * static const struct nla_policy my_policy[ATTR_MAX+1] = {
213 * [ATTR_FOO] = { .type = NLA_U16 },
214 * [ATTR_BAR] = { .type = NLA_STRING, .len = BARSIZ },
215 * [ATTR_BAZ] = { .len = sizeof(struct mystruct) },
224 * struct nl_info - netlink source information
225 * @nlh: Netlink message header of original request
226 * @portid: Netlink PORTID of requesting application
229 struct nlmsghdr *nlh;
235 int netlink_rcv_skb(struct sk_buff *skb,
236 int (*cb)(struct sk_buff *, struct nlmsghdr *));
237 int nlmsg_notify(struct sock *sk, struct sk_buff *skb, u32 portid,
238 unsigned int group, int report, gfp_t flags);
240 int nla_validate(const struct nlattr *head, int len, int maxtype,
241 const struct nla_policy *policy);
242 int nla_parse(struct nlattr **tb, int maxtype, const struct nlattr *head,
243 int len, const struct nla_policy *policy);
244 int nla_policy_len(const struct nla_policy *, int);
245 struct nlattr *nla_find(const struct nlattr *head, int len, int attrtype);
246 size_t nla_strlcpy(char *dst, const struct nlattr *nla, size_t dstsize);
247 int nla_memcpy(void *dest, const struct nlattr *src, int count);
248 int nla_memcmp(const struct nlattr *nla, const void *data, size_t size);
249 int nla_strcmp(const struct nlattr *nla, const char *str);
250 struct nlattr *__nla_reserve(struct sk_buff *skb, int attrtype, int attrlen);
251 struct nlattr *__nla_reserve_64bit(struct sk_buff *skb, int attrtype,
252 int attrlen, int padattr);
253 void *__nla_reserve_nohdr(struct sk_buff *skb, int attrlen);
254 struct nlattr *nla_reserve(struct sk_buff *skb, int attrtype, int attrlen);
255 struct nlattr *nla_reserve_64bit(struct sk_buff *skb, int attrtype,
256 int attrlen, int padattr);
257 void *nla_reserve_nohdr(struct sk_buff *skb, int attrlen);
258 void __nla_put(struct sk_buff *skb, int attrtype, int attrlen,
260 void __nla_put_64bit(struct sk_buff *skb, int attrtype, int attrlen,
261 const void *data, int padattr);
262 void __nla_put_nohdr(struct sk_buff *skb, int attrlen, const void *data);
263 int nla_put(struct sk_buff *skb, int attrtype, int attrlen, const void *data);
264 int nla_put_64bit(struct sk_buff *skb, int attrtype, int attrlen,
265 const void *data, int padattr);
266 int nla_put_nohdr(struct sk_buff *skb, int attrlen, const void *data);
267 int nla_append(struct sk_buff *skb, int attrlen, const void *data);
269 /**************************************************************************
271 **************************************************************************/
274 * nlmsg_msg_size - length of netlink message not including padding
275 * @payload: length of message payload
277 static inline int nlmsg_msg_size(int payload)
279 return NLMSG_HDRLEN + payload;
283 * nlmsg_total_size - length of netlink message including padding
284 * @payload: length of message payload
286 static inline int nlmsg_total_size(int payload)
288 return NLMSG_ALIGN(nlmsg_msg_size(payload));
292 * nlmsg_padlen - length of padding at the message's tail
293 * @payload: length of message payload
295 static inline int nlmsg_padlen(int payload)
297 return nlmsg_total_size(payload) - nlmsg_msg_size(payload);
301 * nlmsg_data - head of message payload
302 * @nlh: netlink message header
304 static inline void *nlmsg_data(const struct nlmsghdr *nlh)
306 return (unsigned char *) nlh + NLMSG_HDRLEN;
310 * nlmsg_len - length of message payload
311 * @nlh: netlink message header
313 static inline int nlmsg_len(const struct nlmsghdr *nlh)
315 return nlh->nlmsg_len - NLMSG_HDRLEN;
319 * nlmsg_attrdata - head of attributes data
320 * @nlh: netlink message header
321 * @hdrlen: length of family specific header
323 static inline struct nlattr *nlmsg_attrdata(const struct nlmsghdr *nlh,
326 unsigned char *data = nlmsg_data(nlh);
327 return (struct nlattr *) (data + NLMSG_ALIGN(hdrlen));
331 * nlmsg_attrlen - length of attributes data
332 * @nlh: netlink message header
333 * @hdrlen: length of family specific header
335 static inline int nlmsg_attrlen(const struct nlmsghdr *nlh, int hdrlen)
337 return nlmsg_len(nlh) - NLMSG_ALIGN(hdrlen);
341 * nlmsg_ok - check if the netlink message fits into the remaining bytes
342 * @nlh: netlink message header
343 * @remaining: number of bytes remaining in message stream
345 static inline int nlmsg_ok(const struct nlmsghdr *nlh, int remaining)
347 return (remaining >= (int) sizeof(struct nlmsghdr) &&
348 nlh->nlmsg_len >= sizeof(struct nlmsghdr) &&
349 nlh->nlmsg_len <= remaining);
353 * nlmsg_next - next netlink message in message stream
354 * @nlh: netlink message header
355 * @remaining: number of bytes remaining in message stream
357 * Returns the next netlink message in the message stream and
358 * decrements remaining by the size of the current message.
360 static inline struct nlmsghdr *
361 nlmsg_next(const struct nlmsghdr *nlh, int *remaining)
363 int totlen = NLMSG_ALIGN(nlh->nlmsg_len);
365 *remaining -= totlen;
367 return (struct nlmsghdr *) ((unsigned char *) nlh + totlen);
371 * nlmsg_parse - parse attributes of a netlink message
372 * @nlh: netlink message header
373 * @hdrlen: length of family specific header
374 * @tb: destination array with maxtype+1 elements
375 * @maxtype: maximum attribute type to be expected
376 * @policy: validation policy
380 static inline int nlmsg_parse(const struct nlmsghdr *nlh, int hdrlen,
381 struct nlattr *tb[], int maxtype,
382 const struct nla_policy *policy)
384 if (nlh->nlmsg_len < nlmsg_msg_size(hdrlen))
387 return nla_parse(tb, maxtype, nlmsg_attrdata(nlh, hdrlen),
388 nlmsg_attrlen(nlh, hdrlen), policy);
392 * nlmsg_find_attr - find a specific attribute in a netlink message
393 * @nlh: netlink message header
394 * @hdrlen: length of familiy specific header
395 * @attrtype: type of attribute to look for
397 * Returns the first attribute which matches the specified type.
399 static inline struct nlattr *nlmsg_find_attr(const struct nlmsghdr *nlh,
400 int hdrlen, int attrtype)
402 return nla_find(nlmsg_attrdata(nlh, hdrlen),
403 nlmsg_attrlen(nlh, hdrlen), attrtype);
407 * nlmsg_validate - validate a netlink message including attributes
408 * @nlh: netlinket message header
409 * @hdrlen: length of familiy specific header
410 * @maxtype: maximum attribute type to be expected
411 * @policy: validation policy
413 static inline int nlmsg_validate(const struct nlmsghdr *nlh,
414 int hdrlen, int maxtype,
415 const struct nla_policy *policy)
417 if (nlh->nlmsg_len < nlmsg_msg_size(hdrlen))
420 return nla_validate(nlmsg_attrdata(nlh, hdrlen),
421 nlmsg_attrlen(nlh, hdrlen), maxtype, policy);
425 * nlmsg_report - need to report back to application?
426 * @nlh: netlink message header
428 * Returns 1 if a report back to the application is requested.
430 static inline int nlmsg_report(const struct nlmsghdr *nlh)
432 return !!(nlh->nlmsg_flags & NLM_F_ECHO);
436 * nlmsg_for_each_attr - iterate over a stream of attributes
437 * @pos: loop counter, set to current attribute
438 * @nlh: netlink message header
439 * @hdrlen: length of familiy specific header
440 * @rem: initialized to len, holds bytes currently remaining in stream
442 #define nlmsg_for_each_attr(pos, nlh, hdrlen, rem) \
443 nla_for_each_attr(pos, nlmsg_attrdata(nlh, hdrlen), \
444 nlmsg_attrlen(nlh, hdrlen), rem)
447 * nlmsg_put - Add a new netlink message to an skb
448 * @skb: socket buffer to store message in
449 * @portid: netlink PORTID of requesting application
450 * @seq: sequence number of message
451 * @type: message type
452 * @payload: length of message payload
453 * @flags: message flags
455 * Returns NULL if the tailroom of the skb is insufficient to store
456 * the message header and payload.
458 static inline struct nlmsghdr *nlmsg_put(struct sk_buff *skb, u32 portid, u32 seq,
459 int type, int payload, int flags)
461 if (unlikely(skb_tailroom(skb) < nlmsg_total_size(payload)))
464 return __nlmsg_put(skb, portid, seq, type, payload, flags);
468 * nlmsg_put_answer - Add a new callback based netlink message to an skb
469 * @skb: socket buffer to store message in
470 * @cb: netlink callback
471 * @type: message type
472 * @payload: length of message payload
473 * @flags: message flags
475 * Returns NULL if the tailroom of the skb is insufficient to store
476 * the message header and payload.
478 static inline struct nlmsghdr *nlmsg_put_answer(struct sk_buff *skb,
479 struct netlink_callback *cb,
480 int type, int payload,
483 return nlmsg_put(skb, NETLINK_CB(cb->skb).portid, cb->nlh->nlmsg_seq,
484 type, payload, flags);
488 * nlmsg_new - Allocate a new netlink message
489 * @payload: size of the message payload
490 * @flags: the type of memory to allocate.
492 * Use NLMSG_DEFAULT_SIZE if the size of the payload isn't known
493 * and a good default is needed.
495 static inline struct sk_buff *nlmsg_new(size_t payload, gfp_t flags)
497 return alloc_skb(nlmsg_total_size(payload), flags);
501 * nlmsg_end - Finalize a netlink message
502 * @skb: socket buffer the message is stored in
503 * @nlh: netlink message header
505 * Corrects the netlink message header to include the appeneded
506 * attributes. Only necessary if attributes have been added to
509 static inline void nlmsg_end(struct sk_buff *skb, struct nlmsghdr *nlh)
511 nlh->nlmsg_len = skb_tail_pointer(skb) - (unsigned char *)nlh;
515 * nlmsg_get_pos - return current position in netlink message
516 * @skb: socket buffer the message is stored in
518 * Returns a pointer to the current tail of the message.
520 static inline void *nlmsg_get_pos(struct sk_buff *skb)
522 return skb_tail_pointer(skb);
526 * nlmsg_trim - Trim message to a mark
527 * @skb: socket buffer the message is stored in
528 * @mark: mark to trim to
530 * Trims the message to the provided mark.
532 static inline void nlmsg_trim(struct sk_buff *skb, const void *mark)
535 WARN_ON((unsigned char *) mark < skb->data);
536 skb_trim(skb, (unsigned char *) mark - skb->data);
541 * nlmsg_cancel - Cancel construction of a netlink message
542 * @skb: socket buffer the message is stored in
543 * @nlh: netlink message header
545 * Removes the complete netlink message including all
546 * attributes from the socket buffer again.
548 static inline void nlmsg_cancel(struct sk_buff *skb, struct nlmsghdr *nlh)
550 nlmsg_trim(skb, nlh);
554 * nlmsg_free - free a netlink message
555 * @skb: socket buffer of netlink message
557 static inline void nlmsg_free(struct sk_buff *skb)
563 * nlmsg_multicast - multicast a netlink message
564 * @sk: netlink socket to spread messages to
565 * @skb: netlink message as socket buffer
566 * @portid: own netlink portid to avoid sending to yourself
567 * @group: multicast group id
568 * @flags: allocation flags
570 static inline int nlmsg_multicast(struct sock *sk, struct sk_buff *skb,
571 u32 portid, unsigned int group, gfp_t flags)
575 NETLINK_CB(skb).dst_group = group;
577 err = netlink_broadcast(sk, skb, portid, group, flags);
585 * nlmsg_unicast - unicast a netlink message
586 * @sk: netlink socket to spread message to
587 * @skb: netlink message as socket buffer
588 * @portid: netlink portid of the destination socket
590 static inline int nlmsg_unicast(struct sock *sk, struct sk_buff *skb, u32 portid)
594 err = netlink_unicast(sk, skb, portid, MSG_DONTWAIT);
602 * nlmsg_for_each_msg - iterate over a stream of messages
603 * @pos: loop counter, set to current message
604 * @head: head of message stream
605 * @len: length of message stream
606 * @rem: initialized to len, holds bytes currently remaining in stream
608 #define nlmsg_for_each_msg(pos, head, len, rem) \
609 for (pos = head, rem = len; \
610 nlmsg_ok(pos, rem); \
611 pos = nlmsg_next(pos, &(rem)))
614 * nl_dump_check_consistent - check if sequence is consistent and advertise if not
615 * @cb: netlink callback structure that stores the sequence number
616 * @nlh: netlink message header to write the flag to
618 * This function checks if the sequence (generation) number changed during dump
619 * and if it did, advertises it in the netlink message header.
621 * The correct way to use it is to set cb->seq to the generation counter when
622 * all locks for dumping have been acquired, and then call this function for
623 * each message that is generated.
625 * Note that due to initialisation concerns, 0 is an invalid sequence number
626 * and must not be used by code that uses this functionality.
629 nl_dump_check_consistent(struct netlink_callback *cb,
630 struct nlmsghdr *nlh)
632 if (cb->prev_seq && cb->seq != cb->prev_seq)
633 nlh->nlmsg_flags |= NLM_F_DUMP_INTR;
634 cb->prev_seq = cb->seq;
637 /**************************************************************************
639 **************************************************************************/
642 * nla_attr_size - length of attribute not including padding
643 * @payload: length of payload
645 static inline int nla_attr_size(int payload)
647 return NLA_HDRLEN + payload;
651 * nla_total_size - total length of attribute including padding
652 * @payload: length of payload
654 static inline int nla_total_size(int payload)
656 return NLA_ALIGN(nla_attr_size(payload));
660 * nla_padlen - length of padding at the tail of attribute
661 * @payload: length of payload
663 static inline int nla_padlen(int payload)
665 return nla_total_size(payload) - nla_attr_size(payload);
669 * nla_type - attribute type
670 * @nla: netlink attribute
672 static inline int nla_type(const struct nlattr *nla)
674 return nla->nla_type & NLA_TYPE_MASK;
678 * nla_data - head of payload
679 * @nla: netlink attribute
681 static inline void *nla_data(const struct nlattr *nla)
683 return (char *) nla + NLA_HDRLEN;
687 * nla_len - length of payload
688 * @nla: netlink attribute
690 static inline int nla_len(const struct nlattr *nla)
692 return nla->nla_len - NLA_HDRLEN;
696 * nla_ok - check if the netlink attribute fits into the remaining bytes
697 * @nla: netlink attribute
698 * @remaining: number of bytes remaining in attribute stream
700 static inline int nla_ok(const struct nlattr *nla, int remaining)
702 return remaining >= (int) sizeof(*nla) &&
703 nla->nla_len >= sizeof(*nla) &&
704 nla->nla_len <= remaining;
708 * nla_next - next netlink attribute in attribute stream
709 * @nla: netlink attribute
710 * @remaining: number of bytes remaining in attribute stream
712 * Returns the next netlink attribute in the attribute stream and
713 * decrements remaining by the size of the current attribute.
715 static inline struct nlattr *nla_next(const struct nlattr *nla, int *remaining)
717 unsigned int totlen = NLA_ALIGN(nla->nla_len);
719 *remaining -= totlen;
720 return (struct nlattr *) ((char *) nla + totlen);
724 * nla_find_nested - find attribute in a set of nested attributes
725 * @nla: attribute containing the nested attributes
726 * @attrtype: type of attribute to look for
728 * Returns the first attribute which matches the specified type.
730 static inline struct nlattr *
731 nla_find_nested(const struct nlattr *nla, int attrtype)
733 return nla_find(nla_data(nla), nla_len(nla), attrtype);
737 * nla_parse_nested - parse nested attributes
738 * @tb: destination array with maxtype+1 elements
739 * @maxtype: maximum attribute type to be expected
740 * @nla: attribute containing the nested attributes
741 * @policy: validation policy
745 static inline int nla_parse_nested(struct nlattr *tb[], int maxtype,
746 const struct nlattr *nla,
747 const struct nla_policy *policy)
749 return nla_parse(tb, maxtype, nla_data(nla), nla_len(nla), policy);
753 * nla_put_u8 - Add a u8 netlink attribute to a socket buffer
754 * @skb: socket buffer to add attribute to
755 * @attrtype: attribute type
756 * @value: numeric value
758 static inline int nla_put_u8(struct sk_buff *skb, int attrtype, u8 value)
760 return nla_put(skb, attrtype, sizeof(u8), &value);
764 * nla_put_u16 - Add a u16 netlink attribute to a socket buffer
765 * @skb: socket buffer to add attribute to
766 * @attrtype: attribute type
767 * @value: numeric value
769 static inline int nla_put_u16(struct sk_buff *skb, int attrtype, u16 value)
771 return nla_put(skb, attrtype, sizeof(u16), &value);
775 * nla_put_be16 - Add a __be16 netlink attribute to a socket buffer
776 * @skb: socket buffer to add attribute to
777 * @attrtype: attribute type
778 * @value: numeric value
780 static inline int nla_put_be16(struct sk_buff *skb, int attrtype, __be16 value)
782 return nla_put(skb, attrtype, sizeof(__be16), &value);
786 * nla_put_net16 - Add 16-bit network byte order netlink attribute to a socket buffer
787 * @skb: socket buffer to add attribute to
788 * @attrtype: attribute type
789 * @value: numeric value
791 static inline int nla_put_net16(struct sk_buff *skb, int attrtype, __be16 value)
793 return nla_put_be16(skb, attrtype | NLA_F_NET_BYTEORDER, value);
797 * nla_put_le16 - Add a __le16 netlink attribute to a socket buffer
798 * @skb: socket buffer to add attribute to
799 * @attrtype: attribute type
800 * @value: numeric value
802 static inline int nla_put_le16(struct sk_buff *skb, int attrtype, __le16 value)
804 return nla_put(skb, attrtype, sizeof(__le16), &value);
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
813 static inline int nla_put_u32(struct sk_buff *skb, int attrtype, u32 value)
815 return nla_put(skb, attrtype, sizeof(u32), &value);
819 * nla_put_be32 - Add a __be32 netlink attribute to a socket buffer
820 * @skb: socket buffer to add attribute to
821 * @attrtype: attribute type
822 * @value: numeric value
824 static inline int nla_put_be32(struct sk_buff *skb, int attrtype, __be32 value)
826 return nla_put(skb, attrtype, sizeof(__be32), &value);
830 * nla_put_net32 - Add 32-bit network byte order netlink attribute to a socket buffer
831 * @skb: socket buffer to add attribute to
832 * @attrtype: attribute type
833 * @value: numeric value
835 static inline int nla_put_net32(struct sk_buff *skb, int attrtype, __be32 value)
837 return nla_put_be32(skb, attrtype | NLA_F_NET_BYTEORDER, value);
841 * nla_put_le32 - Add a __le32 netlink attribute to a socket buffer
842 * @skb: socket buffer to add attribute to
843 * @attrtype: attribute type
844 * @value: numeric value
846 static inline int nla_put_le32(struct sk_buff *skb, int attrtype, __le32 value)
848 return nla_put(skb, attrtype, sizeof(__le32), &value);
852 * nla_put_u64_64bit - Add a u64 netlink attribute to a skb and align it
853 * @skb: socket buffer to add attribute to
854 * @attrtype: attribute type
855 * @value: numeric value
856 * @padattr: attribute type for the padding
858 static inline int nla_put_u64_64bit(struct sk_buff *skb, int attrtype,
859 u64 value, int padattr)
861 return nla_put_64bit(skb, attrtype, sizeof(u64), &value, padattr);
865 * nla_put_be64 - Add a __be64 netlink attribute to a socket buffer and align it
866 * @skb: socket buffer to add attribute to
867 * @attrtype: attribute type
868 * @value: numeric value
869 * @padattr: attribute type for the padding
871 static inline int nla_put_be64(struct sk_buff *skb, int attrtype, __be64 value,
874 return nla_put_64bit(skb, attrtype, sizeof(__be64), &value, padattr);
878 * nla_put_net64 - Add 64-bit network byte order nlattr to a skb and align it
879 * @skb: socket buffer to add attribute to
880 * @attrtype: attribute type
881 * @value: numeric value
882 * @padattr: attribute type for the padding
884 static inline int nla_put_net64(struct sk_buff *skb, int attrtype, __be64 value,
887 return nla_put_be64(skb, attrtype | NLA_F_NET_BYTEORDER, value,
892 * nla_put_le64 - Add a __le64 netlink attribute to a socket buffer and align it
893 * @skb: socket buffer to add attribute to
894 * @attrtype: attribute type
895 * @value: numeric value
896 * @padattr: attribute type for the padding
898 static inline int nla_put_le64(struct sk_buff *skb, int attrtype, __le64 value,
901 return nla_put_64bit(skb, attrtype, sizeof(__le64), &value, padattr);
905 * nla_put_s8 - Add a s8 netlink attribute to a socket buffer
906 * @skb: socket buffer to add attribute to
907 * @attrtype: attribute type
908 * @value: numeric value
910 static inline int nla_put_s8(struct sk_buff *skb, int attrtype, s8 value)
912 return nla_put(skb, attrtype, sizeof(s8), &value);
916 * nla_put_s16 - Add a s16 netlink attribute to a socket buffer
917 * @skb: socket buffer to add attribute to
918 * @attrtype: attribute type
919 * @value: numeric value
921 static inline int nla_put_s16(struct sk_buff *skb, int attrtype, s16 value)
923 return nla_put(skb, attrtype, sizeof(s16), &value);
927 * nla_put_s32 - Add a s32 netlink attribute to a socket buffer
928 * @skb: socket buffer to add attribute to
929 * @attrtype: attribute type
930 * @value: numeric value
932 static inline int nla_put_s32(struct sk_buff *skb, int attrtype, s32 value)
934 return nla_put(skb, attrtype, sizeof(s32), &value);
938 * nla_put_s64 - Add a s64 netlink attribute to a socket buffer and align it
939 * @skb: socket buffer to add attribute to
940 * @attrtype: attribute type
941 * @value: numeric value
942 * @padattr: attribute type for the padding
944 static inline int nla_put_s64(struct sk_buff *skb, int attrtype, s64 value,
947 return nla_put_64bit(skb, attrtype, sizeof(s64), &value, padattr);
951 * nla_put_string - Add a string netlink attribute to a socket buffer
952 * @skb: socket buffer to add attribute to
953 * @attrtype: attribute type
954 * @str: NUL terminated string
956 static inline int nla_put_string(struct sk_buff *skb, int attrtype,
959 return nla_put(skb, attrtype, strlen(str) + 1, str);
963 * nla_put_flag - Add a flag netlink attribute to a socket buffer
964 * @skb: socket buffer to add attribute to
965 * @attrtype: attribute type
967 static inline int nla_put_flag(struct sk_buff *skb, int attrtype)
969 return nla_put(skb, attrtype, 0, NULL);
973 * nla_put_msecs - Add a msecs netlink attribute to a skb and align it
974 * @skb: socket buffer to add attribute to
975 * @attrtype: attribute type
976 * @njiffies: number of jiffies to convert to msecs
977 * @padattr: attribute type for the padding
979 static inline int nla_put_msecs(struct sk_buff *skb, int attrtype,
980 unsigned long njiffies, int padattr)
982 u64 tmp = jiffies_to_msecs(njiffies);
984 return nla_put_64bit(skb, attrtype, sizeof(u64), &tmp, padattr);
988 * nla_put_in_addr - Add an IPv4 address netlink attribute to a socket
990 * @skb: socket buffer to add attribute to
991 * @attrtype: attribute type
992 * @addr: IPv4 address
994 static inline int nla_put_in_addr(struct sk_buff *skb, int attrtype,
997 return nla_put_be32(skb, attrtype, addr);
1001 * nla_put_in6_addr - Add an IPv6 address netlink attribute to a socket
1003 * @skb: socket buffer to add attribute to
1004 * @attrtype: attribute type
1005 * @addr: IPv6 address
1007 static inline int nla_put_in6_addr(struct sk_buff *skb, int attrtype,
1008 const struct in6_addr *addr)
1010 return nla_put(skb, attrtype, sizeof(*addr), addr);
1014 * nla_get_u32 - return payload of u32 attribute
1015 * @nla: u32 netlink attribute
1017 static inline u32 nla_get_u32(const struct nlattr *nla)
1019 return *(u32 *) nla_data(nla);
1023 * nla_get_be32 - return payload of __be32 attribute
1024 * @nla: __be32 netlink attribute
1026 static inline __be32 nla_get_be32(const struct nlattr *nla)
1028 return *(__be32 *) nla_data(nla);
1032 * nla_get_le32 - return payload of __le32 attribute
1033 * @nla: __le32 netlink attribute
1035 static inline __le32 nla_get_le32(const struct nlattr *nla)
1037 return *(__le32 *) nla_data(nla);
1041 * nla_get_u16 - return payload of u16 attribute
1042 * @nla: u16 netlink attribute
1044 static inline u16 nla_get_u16(const struct nlattr *nla)
1046 return *(u16 *) nla_data(nla);
1050 * nla_get_be16 - return payload of __be16 attribute
1051 * @nla: __be16 netlink attribute
1053 static inline __be16 nla_get_be16(const struct nlattr *nla)
1055 return *(__be16 *) nla_data(nla);
1059 * nla_get_le16 - return payload of __le16 attribute
1060 * @nla: __le16 netlink attribute
1062 static inline __le16 nla_get_le16(const struct nlattr *nla)
1064 return *(__le16 *) nla_data(nla);
1068 * nla_get_u8 - return payload of u8 attribute
1069 * @nla: u8 netlink attribute
1071 static inline u8 nla_get_u8(const struct nlattr *nla)
1073 return *(u8 *) nla_data(nla);
1077 * nla_get_u64 - return payload of u64 attribute
1078 * @nla: u64 netlink attribute
1080 static inline u64 nla_get_u64(const struct nlattr *nla)
1084 nla_memcpy(&tmp, nla, sizeof(tmp));
1090 * nla_get_be64 - return payload of __be64 attribute
1091 * @nla: __be64 netlink attribute
1093 static inline __be64 nla_get_be64(const struct nlattr *nla)
1097 nla_memcpy(&tmp, nla, sizeof(tmp));
1103 * nla_get_le64 - return payload of __le64 attribute
1104 * @nla: __le64 netlink attribute
1106 static inline __le64 nla_get_le64(const struct nlattr *nla)
1108 return *(__le64 *) nla_data(nla);
1112 * nla_get_s32 - return payload of s32 attribute
1113 * @nla: s32 netlink attribute
1115 static inline s32 nla_get_s32(const struct nlattr *nla)
1117 return *(s32 *) nla_data(nla);
1121 * nla_get_s16 - return payload of s16 attribute
1122 * @nla: s16 netlink attribute
1124 static inline s16 nla_get_s16(const struct nlattr *nla)
1126 return *(s16 *) nla_data(nla);
1130 * nla_get_s8 - return payload of s8 attribute
1131 * @nla: s8 netlink attribute
1133 static inline s8 nla_get_s8(const struct nlattr *nla)
1135 return *(s8 *) nla_data(nla);
1139 * nla_get_s64 - return payload of s64 attribute
1140 * @nla: s64 netlink attribute
1142 static inline s64 nla_get_s64(const struct nlattr *nla)
1146 nla_memcpy(&tmp, nla, sizeof(tmp));
1152 * nla_get_flag - return payload of flag attribute
1153 * @nla: flag netlink attribute
1155 static inline int nla_get_flag(const struct nlattr *nla)
1161 * nla_get_msecs - return payload of msecs attribute
1162 * @nla: msecs netlink attribute
1164 * Returns the number of milliseconds in jiffies.
1166 static inline unsigned long nla_get_msecs(const struct nlattr *nla)
1168 u64 msecs = nla_get_u64(nla);
1170 return msecs_to_jiffies((unsigned long) msecs);
1174 * nla_get_in_addr - return payload of IPv4 address attribute
1175 * @nla: IPv4 address netlink attribute
1177 static inline __be32 nla_get_in_addr(const struct nlattr *nla)
1179 return *(__be32 *) nla_data(nla);
1183 * nla_get_in6_addr - return payload of IPv6 address attribute
1184 * @nla: IPv6 address netlink attribute
1186 static inline struct in6_addr nla_get_in6_addr(const struct nlattr *nla)
1188 struct in6_addr tmp;
1190 nla_memcpy(&tmp, nla, sizeof(tmp));
1195 * nla_memdup - duplicate attribute memory (kmemdup)
1196 * @src: netlink attribute to duplicate from
1199 static inline void *nla_memdup(const struct nlattr *src, gfp_t gfp)
1201 return kmemdup(nla_data(src), nla_len(src), gfp);
1205 * nla_nest_start - Start a new level of nested attributes
1206 * @skb: socket buffer to add attributes to
1207 * @attrtype: attribute type of container
1209 * Returns the container attribute
1211 static inline struct nlattr *nla_nest_start(struct sk_buff *skb, int attrtype)
1213 struct nlattr *start = (struct nlattr *)skb_tail_pointer(skb);
1215 if (nla_put(skb, attrtype, 0, NULL) < 0)
1222 * nla_nest_end - Finalize nesting of attributes
1223 * @skb: socket buffer the attributes are stored in
1224 * @start: container attribute
1226 * Corrects the container attribute header to include the all
1227 * appeneded attributes.
1229 * Returns the total data length of the skb.
1231 static inline int nla_nest_end(struct sk_buff *skb, struct nlattr *start)
1233 start->nla_len = skb_tail_pointer(skb) - (unsigned char *)start;
1238 * nla_nest_cancel - Cancel nesting of attributes
1239 * @skb: socket buffer the message is stored in
1240 * @start: container attribute
1242 * Removes the container attribute and including all nested
1243 * attributes. Returns -EMSGSIZE
1245 static inline void nla_nest_cancel(struct sk_buff *skb, struct nlattr *start)
1247 nlmsg_trim(skb, start);
1251 * nla_validate_nested - Validate a stream of nested attributes
1252 * @start: container attribute
1253 * @maxtype: maximum attribute type to be expected
1254 * @policy: validation policy
1256 * Validates all attributes in the nested attribute stream against the
1257 * specified policy. Attributes with a type exceeding maxtype will be
1258 * ignored. See documenation of struct nla_policy for more details.
1260 * Returns 0 on success or a negative error code.
1262 static inline int nla_validate_nested(const struct nlattr *start, int maxtype,
1263 const struct nla_policy *policy)
1265 return nla_validate(nla_data(start), nla_len(start), maxtype, policy);
1269 * nla_need_padding_for_64bit - test 64-bit alignment of the next attribute
1270 * @skb: socket buffer the message is stored in
1272 * Return true if padding is needed to align the next attribute (nla_data()) to
1273 * a 64-bit aligned area.
1275 static inline bool nla_need_padding_for_64bit(struct sk_buff *skb)
1277 #ifndef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS
1278 /* The nlattr header is 4 bytes in size, that's why we test
1279 * if the skb->data _is_ aligned. A NOP attribute, plus
1280 * nlattr header for next attribute, will make nla_data()
1283 if (IS_ALIGNED((unsigned long)skb_tail_pointer(skb), 8))
1290 * nla_align_64bit - 64-bit align the nla_data() of next attribute
1291 * @skb: socket buffer the message is stored in
1292 * @padattr: attribute type for the padding
1294 * Conditionally emit a padding netlink attribute in order to make
1295 * the next attribute we emit have a 64-bit aligned nla_data() area.
1296 * This will only be done in architectures which do not have
1297 * CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS defined.
1299 * Returns zero on success or a negative error code.
1301 static inline int nla_align_64bit(struct sk_buff *skb, int padattr)
1303 if (nla_need_padding_for_64bit(skb) &&
1304 !nla_reserve(skb, padattr, 0))
1311 * nla_total_size_64bit - total length of attribute including padding
1312 * @payload: length of payload
1314 static inline int nla_total_size_64bit(int payload)
1316 return NLA_ALIGN(nla_attr_size(payload))
1317 #ifndef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS
1318 + NLA_ALIGN(nla_attr_size(0))
1324 * nla_for_each_attr - iterate over a stream of attributes
1325 * @pos: loop counter, set to current attribute
1326 * @head: head of attribute stream
1327 * @len: length of attribute stream
1328 * @rem: initialized to len, holds bytes currently remaining in stream
1330 #define nla_for_each_attr(pos, head, len, rem) \
1331 for (pos = head, rem = len; \
1333 pos = nla_next(pos, &(rem)))
1336 * nla_for_each_nested - iterate over nested attributes
1337 * @pos: loop counter, set to current attribute
1338 * @nla: attribute containing the nested attributes
1339 * @rem: initialized to len, holds bytes currently remaining in stream
1341 #define nla_for_each_nested(pos, nla, rem) \
1342 nla_for_each_attr(pos, nla_data(nla), nla_len(nla), rem)
1345 * nla_is_last - Test if attribute is last in stream
1346 * @nla: attribute to test
1347 * @rem: bytes remaining in stream
1349 static inline bool nla_is_last(const struct nlattr *nla, int rem)
1351 return nla->nla_len == rem;