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(skb, type, value) add u64 attribute to skb
102 * nla_put_s8(skb, type, value) add s8 attribute to skb
103 * nla_put_s16(skb, type, value) add s16 attribute to skb
104 * nla_put_s32(skb, type, value) add s32 attribute to skb
105 * nla_put_s64(skb, type, value,
106 * padattr) add s64 attribute to skb
107 * nla_put_string(skb, type, str) add string attribute to skb
108 * nla_put_flag(skb, type) add flag attribute to skb
109 * nla_put_msecs(skb, type, jiffies) add msecs attribute to skb
110 * nla_put_in_addr(skb, type, addr) add IPv4 address attribute to skb
111 * nla_put_in6_addr(skb, type, addr) add IPv6 address attribute to skb
113 * Nested Attributes Construction:
114 * nla_nest_start(skb, type) start a nested attribute
115 * nla_nest_end(skb, nla) finalize a nested attribute
116 * nla_nest_cancel(skb, nla) cancel nested attribute construction
118 * Attribute Length Calculations:
119 * nla_attr_size(payload) length of attribute w/o padding
120 * nla_total_size(payload) length of attribute w/ padding
121 * nla_padlen(payload) length of padding
123 * Attribute Payload Access:
124 * nla_data(nla) head of attribute payload
125 * nla_len(nla) length of attribute payload
127 * Attribute Payload Access for Basic Types:
128 * nla_get_u8(nla) get payload for a u8 attribute
129 * nla_get_u16(nla) get payload for a u16 attribute
130 * nla_get_u32(nla) get payload for a u32 attribute
131 * nla_get_u64(nla) get payload for a u64 attribute
132 * nla_get_s8(nla) get payload for a s8 attribute
133 * nla_get_s16(nla) get payload for a s16 attribute
134 * nla_get_s32(nla) get payload for a s32 attribute
135 * nla_get_s64(nla) get payload for a s64 attribute
136 * nla_get_flag(nla) return 1 if flag is true
137 * nla_get_msecs(nla) get payload for a msecs attribute
140 * nla_memcpy(dest, nla, count) copy attribute into memory
141 * nla_memcmp(nla, data, size) compare attribute with memory area
142 * nla_strlcpy(dst, nla, size) copy attribute to a sized string
143 * nla_strcmp(nla, str) compare attribute with string
146 * nla_ok(nla, remaining) does nla fit into remaining bytes?
147 * nla_next(nla, remaining) get next netlink attribute
148 * nla_validate() validate a stream of attributes
149 * nla_validate_nested() validate a stream of nested attributes
150 * nla_find() find attribute in stream of attributes
151 * nla_find_nested() find attribute in nested attributes
152 * nla_parse() parse and validate stream of attrs
153 * nla_parse_nested() parse nested attribuets
154 * nla_for_each_attr() loop over all attributes
155 * nla_for_each_nested() loop over the nested attributes
156 *=========================================================================
160 * Standard attribute types to specify validation policy
182 #define NLA_TYPE_MAX (__NLA_TYPE_MAX - 1)
185 * struct nla_policy - attribute validation policy
186 * @type: Type of attribute or NLA_UNSPEC
187 * @len: Type specific length of payload
189 * Policies are defined as arrays of this struct, the array must be
190 * accessible by attribute type up to the highest identifier to be expected.
192 * Meaning of `len' field:
193 * NLA_STRING Maximum length of string
194 * NLA_NUL_STRING Maximum length of string (excluding NUL)
196 * NLA_BINARY Maximum length of attribute payload
197 * NLA_NESTED Don't use `len' field -- length verification is
198 * done by checking len of nested header (or empty)
199 * NLA_NESTED_COMPAT Minimum length of structure payload
204 * NLA_MSECS Leaving the length field zero will verify the
205 * given type fits, using it verifies minimum length
206 * just like "All other"
207 * All other Minimum length of attribute payload
210 * static const struct nla_policy my_policy[ATTR_MAX+1] = {
211 * [ATTR_FOO] = { .type = NLA_U16 },
212 * [ATTR_BAR] = { .type = NLA_STRING, .len = BARSIZ },
213 * [ATTR_BAZ] = { .len = sizeof(struct mystruct) },
222 * struct nl_info - netlink source information
223 * @nlh: Netlink message header of original request
224 * @portid: Netlink PORTID of requesting application
227 struct nlmsghdr
*nlh
;
232 int netlink_rcv_skb(struct sk_buff
*skb
,
233 int (*cb
)(struct sk_buff
*, struct nlmsghdr
*));
234 int nlmsg_notify(struct sock
*sk
, struct sk_buff
*skb
, u32 portid
,
235 unsigned int group
, int report
, gfp_t flags
);
237 int nla_validate(const struct nlattr
*head
, int len
, int maxtype
,
238 const struct nla_policy
*policy
);
239 int nla_parse(struct nlattr
**tb
, int maxtype
, const struct nlattr
*head
,
240 int len
, const struct nla_policy
*policy
);
241 int nla_policy_len(const struct nla_policy
*, int);
242 struct nlattr
*nla_find(const struct nlattr
*head
, int len
, int attrtype
);
243 size_t nla_strlcpy(char *dst
, const struct nlattr
*nla
, size_t dstsize
);
244 int nla_memcpy(void *dest
, const struct nlattr
*src
, int count
);
245 int nla_memcmp(const struct nlattr
*nla
, const void *data
, size_t size
);
246 int nla_strcmp(const struct nlattr
*nla
, const char *str
);
247 struct nlattr
*__nla_reserve(struct sk_buff
*skb
, int attrtype
, int attrlen
);
248 struct nlattr
*__nla_reserve_64bit(struct sk_buff
*skb
, int attrtype
,
249 int attrlen
, int padattr
);
250 void *__nla_reserve_nohdr(struct sk_buff
*skb
, int attrlen
);
251 struct nlattr
*nla_reserve(struct sk_buff
*skb
, int attrtype
, int attrlen
);
252 struct nlattr
*nla_reserve_64bit(struct sk_buff
*skb
, int attrtype
,
253 int attrlen
, int padattr
);
254 void *nla_reserve_nohdr(struct sk_buff
*skb
, int attrlen
);
255 void __nla_put(struct sk_buff
*skb
, int attrtype
, int attrlen
,
257 void __nla_put_64bit(struct sk_buff
*skb
, int attrtype
, int attrlen
,
258 const void *data
, int padattr
);
259 void __nla_put_nohdr(struct sk_buff
*skb
, int attrlen
, const void *data
);
260 int nla_put(struct sk_buff
*skb
, int attrtype
, int attrlen
, const void *data
);
261 int nla_put_64bit(struct sk_buff
*skb
, int attrtype
, int attrlen
,
262 const void *data
, int padattr
);
263 int nla_put_nohdr(struct sk_buff
*skb
, int attrlen
, const void *data
);
264 int nla_append(struct sk_buff
*skb
, int attrlen
, const void *data
);
266 /**************************************************************************
268 **************************************************************************/
271 * nlmsg_msg_size - length of netlink message not including padding
272 * @payload: length of message payload
274 static inline int nlmsg_msg_size(int payload
)
276 return NLMSG_HDRLEN
+ payload
;
280 * nlmsg_total_size - length of netlink message including padding
281 * @payload: length of message payload
283 static inline int nlmsg_total_size(int payload
)
285 return NLMSG_ALIGN(nlmsg_msg_size(payload
));
289 * nlmsg_padlen - length of padding at the message's tail
290 * @payload: length of message payload
292 static inline int nlmsg_padlen(int payload
)
294 return nlmsg_total_size(payload
) - nlmsg_msg_size(payload
);
298 * nlmsg_data - head of message payload
299 * @nlh: netlink message header
301 static inline void *nlmsg_data(const struct nlmsghdr
*nlh
)
303 return (unsigned char *) nlh
+ NLMSG_HDRLEN
;
307 * nlmsg_len - length of message payload
308 * @nlh: netlink message header
310 static inline int nlmsg_len(const struct nlmsghdr
*nlh
)
312 return nlh
->nlmsg_len
- NLMSG_HDRLEN
;
316 * nlmsg_attrdata - head of attributes data
317 * @nlh: netlink message header
318 * @hdrlen: length of family specific header
320 static inline struct nlattr
*nlmsg_attrdata(const struct nlmsghdr
*nlh
,
323 unsigned char *data
= nlmsg_data(nlh
);
324 return (struct nlattr
*) (data
+ NLMSG_ALIGN(hdrlen
));
328 * nlmsg_attrlen - length of attributes data
329 * @nlh: netlink message header
330 * @hdrlen: length of family specific header
332 static inline int nlmsg_attrlen(const struct nlmsghdr
*nlh
, int hdrlen
)
334 return nlmsg_len(nlh
) - NLMSG_ALIGN(hdrlen
);
338 * nlmsg_ok - check if the netlink message fits into the remaining bytes
339 * @nlh: netlink message header
340 * @remaining: number of bytes remaining in message stream
342 static inline int nlmsg_ok(const struct nlmsghdr
*nlh
, int remaining
)
344 return (remaining
>= (int) sizeof(struct nlmsghdr
) &&
345 nlh
->nlmsg_len
>= sizeof(struct nlmsghdr
) &&
346 nlh
->nlmsg_len
<= remaining
);
350 * nlmsg_next - next netlink message in message stream
351 * @nlh: netlink message header
352 * @remaining: number of bytes remaining in message stream
354 * Returns the next netlink message in the message stream and
355 * decrements remaining by the size of the current message.
357 static inline struct nlmsghdr
*
358 nlmsg_next(const struct nlmsghdr
*nlh
, int *remaining
)
360 int totlen
= NLMSG_ALIGN(nlh
->nlmsg_len
);
362 *remaining
-= totlen
;
364 return (struct nlmsghdr
*) ((unsigned char *) nlh
+ totlen
);
368 * nlmsg_parse - parse attributes of a netlink message
369 * @nlh: netlink message header
370 * @hdrlen: length of family specific header
371 * @tb: destination array with maxtype+1 elements
372 * @maxtype: maximum attribute type to be expected
373 * @policy: validation policy
377 static inline int nlmsg_parse(const struct nlmsghdr
*nlh
, int hdrlen
,
378 struct nlattr
*tb
[], int maxtype
,
379 const struct nla_policy
*policy
)
381 if (nlh
->nlmsg_len
< nlmsg_msg_size(hdrlen
))
384 return nla_parse(tb
, maxtype
, nlmsg_attrdata(nlh
, hdrlen
),
385 nlmsg_attrlen(nlh
, hdrlen
), policy
);
389 * nlmsg_find_attr - find a specific attribute in a netlink message
390 * @nlh: netlink message header
391 * @hdrlen: length of familiy specific header
392 * @attrtype: type of attribute to look for
394 * Returns the first attribute which matches the specified type.
396 static inline struct nlattr
*nlmsg_find_attr(const struct nlmsghdr
*nlh
,
397 int hdrlen
, int attrtype
)
399 return nla_find(nlmsg_attrdata(nlh
, hdrlen
),
400 nlmsg_attrlen(nlh
, hdrlen
), attrtype
);
404 * nlmsg_validate - validate a netlink message including attributes
405 * @nlh: netlinket message header
406 * @hdrlen: length of familiy specific header
407 * @maxtype: maximum attribute type to be expected
408 * @policy: validation policy
410 static inline int nlmsg_validate(const struct nlmsghdr
*nlh
,
411 int hdrlen
, int maxtype
,
412 const struct nla_policy
*policy
)
414 if (nlh
->nlmsg_len
< nlmsg_msg_size(hdrlen
))
417 return nla_validate(nlmsg_attrdata(nlh
, hdrlen
),
418 nlmsg_attrlen(nlh
, hdrlen
), maxtype
, policy
);
422 * nlmsg_report - need to report back to application?
423 * @nlh: netlink message header
425 * Returns 1 if a report back to the application is requested.
427 static inline int nlmsg_report(const struct nlmsghdr
*nlh
)
429 return !!(nlh
->nlmsg_flags
& NLM_F_ECHO
);
433 * nlmsg_for_each_attr - iterate over a stream of attributes
434 * @pos: loop counter, set to current attribute
435 * @nlh: netlink message header
436 * @hdrlen: length of familiy specific header
437 * @rem: initialized to len, holds bytes currently remaining in stream
439 #define nlmsg_for_each_attr(pos, nlh, hdrlen, rem) \
440 nla_for_each_attr(pos, nlmsg_attrdata(nlh, hdrlen), \
441 nlmsg_attrlen(nlh, hdrlen), rem)
444 * nlmsg_put - Add a new netlink message to an skb
445 * @skb: socket buffer to store message in
446 * @portid: netlink PORTID of requesting application
447 * @seq: sequence number of message
448 * @type: message type
449 * @payload: length of message payload
450 * @flags: message flags
452 * Returns NULL if the tailroom of the skb is insufficient to store
453 * the message header and payload.
455 static inline struct nlmsghdr
*nlmsg_put(struct sk_buff
*skb
, u32 portid
, u32 seq
,
456 int type
, int payload
, int flags
)
458 if (unlikely(skb_tailroom(skb
) < nlmsg_total_size(payload
)))
461 return __nlmsg_put(skb
, portid
, seq
, type
, payload
, flags
);
465 * nlmsg_put_answer - Add a new callback based netlink message to an skb
466 * @skb: socket buffer to store message in
467 * @cb: netlink callback
468 * @type: message type
469 * @payload: length of message payload
470 * @flags: message flags
472 * Returns NULL if the tailroom of the skb is insufficient to store
473 * the message header and payload.
475 static inline struct nlmsghdr
*nlmsg_put_answer(struct sk_buff
*skb
,
476 struct netlink_callback
*cb
,
477 int type
, int payload
,
480 return nlmsg_put(skb
, NETLINK_CB(cb
->skb
).portid
, cb
->nlh
->nlmsg_seq
,
481 type
, payload
, flags
);
485 * nlmsg_new - Allocate a new netlink message
486 * @payload: size of the message payload
487 * @flags: the type of memory to allocate.
489 * Use NLMSG_DEFAULT_SIZE if the size of the payload isn't known
490 * and a good default is needed.
492 static inline struct sk_buff
*nlmsg_new(size_t payload
, gfp_t flags
)
494 return alloc_skb(nlmsg_total_size(payload
), flags
);
498 * nlmsg_end - Finalize a netlink message
499 * @skb: socket buffer the message is stored in
500 * @nlh: netlink message header
502 * Corrects the netlink message header to include the appeneded
503 * attributes. Only necessary if attributes have been added to
506 static inline void nlmsg_end(struct sk_buff
*skb
, struct nlmsghdr
*nlh
)
508 nlh
->nlmsg_len
= skb_tail_pointer(skb
) - (unsigned char *)nlh
;
512 * nlmsg_get_pos - return current position in netlink message
513 * @skb: socket buffer the message is stored in
515 * Returns a pointer to the current tail of the message.
517 static inline void *nlmsg_get_pos(struct sk_buff
*skb
)
519 return skb_tail_pointer(skb
);
523 * nlmsg_trim - Trim message to a mark
524 * @skb: socket buffer the message is stored in
525 * @mark: mark to trim to
527 * Trims the message to the provided mark.
529 static inline void nlmsg_trim(struct sk_buff
*skb
, const void *mark
)
532 WARN_ON((unsigned char *) mark
< skb
->data
);
533 skb_trim(skb
, (unsigned char *) mark
- skb
->data
);
538 * nlmsg_cancel - Cancel construction of a netlink message
539 * @skb: socket buffer the message is stored in
540 * @nlh: netlink message header
542 * Removes the complete netlink message including all
543 * attributes from the socket buffer again.
545 static inline void nlmsg_cancel(struct sk_buff
*skb
, struct nlmsghdr
*nlh
)
547 nlmsg_trim(skb
, nlh
);
551 * nlmsg_free - free a netlink message
552 * @skb: socket buffer of netlink message
554 static inline void nlmsg_free(struct sk_buff
*skb
)
560 * nlmsg_multicast - multicast a netlink message
561 * @sk: netlink socket to spread messages to
562 * @skb: netlink message as socket buffer
563 * @portid: own netlink portid to avoid sending to yourself
564 * @group: multicast group id
565 * @flags: allocation flags
567 static inline int nlmsg_multicast(struct sock
*sk
, struct sk_buff
*skb
,
568 u32 portid
, unsigned int group
, gfp_t flags
)
572 NETLINK_CB(skb
).dst_group
= group
;
574 err
= netlink_broadcast(sk
, skb
, portid
, group
, flags
);
582 * nlmsg_unicast - unicast a netlink message
583 * @sk: netlink socket to spread message to
584 * @skb: netlink message as socket buffer
585 * @portid: netlink portid of the destination socket
587 static inline int nlmsg_unicast(struct sock
*sk
, struct sk_buff
*skb
, u32 portid
)
591 err
= netlink_unicast(sk
, skb
, portid
, MSG_DONTWAIT
);
599 * nlmsg_for_each_msg - iterate over a stream of messages
600 * @pos: loop counter, set to current message
601 * @head: head of message stream
602 * @len: length of message stream
603 * @rem: initialized to len, holds bytes currently remaining in stream
605 #define nlmsg_for_each_msg(pos, head, len, rem) \
606 for (pos = head, rem = len; \
607 nlmsg_ok(pos, rem); \
608 pos = nlmsg_next(pos, &(rem)))
611 * nl_dump_check_consistent - check if sequence is consistent and advertise if not
612 * @cb: netlink callback structure that stores the sequence number
613 * @nlh: netlink message header to write the flag to
615 * This function checks if the sequence (generation) number changed during dump
616 * and if it did, advertises it in the netlink message header.
618 * The correct way to use it is to set cb->seq to the generation counter when
619 * all locks for dumping have been acquired, and then call this function for
620 * each message that is generated.
622 * Note that due to initialisation concerns, 0 is an invalid sequence number
623 * and must not be used by code that uses this functionality.
626 nl_dump_check_consistent(struct netlink_callback
*cb
,
627 struct nlmsghdr
*nlh
)
629 if (cb
->prev_seq
&& cb
->seq
!= cb
->prev_seq
)
630 nlh
->nlmsg_flags
|= NLM_F_DUMP_INTR
;
631 cb
->prev_seq
= cb
->seq
;
634 /**************************************************************************
636 **************************************************************************/
639 * nla_attr_size - length of attribute not including padding
640 * @payload: length of payload
642 static inline int nla_attr_size(int payload
)
644 return NLA_HDRLEN
+ payload
;
648 * nla_total_size - total length of attribute including padding
649 * @payload: length of payload
651 static inline int nla_total_size(int payload
)
653 return NLA_ALIGN(nla_attr_size(payload
));
657 * nla_padlen - length of padding at the tail of attribute
658 * @payload: length of payload
660 static inline int nla_padlen(int payload
)
662 return nla_total_size(payload
) - nla_attr_size(payload
);
666 * nla_type - attribute type
667 * @nla: netlink attribute
669 static inline int nla_type(const struct nlattr
*nla
)
671 return nla
->nla_type
& NLA_TYPE_MASK
;
675 * nla_data - head of payload
676 * @nla: netlink attribute
678 static inline void *nla_data(const struct nlattr
*nla
)
680 return (char *) nla
+ NLA_HDRLEN
;
684 * nla_len - length of payload
685 * @nla: netlink attribute
687 static inline int nla_len(const struct nlattr
*nla
)
689 return nla
->nla_len
- NLA_HDRLEN
;
693 * nla_ok - check if the netlink attribute fits into the remaining bytes
694 * @nla: netlink attribute
695 * @remaining: number of bytes remaining in attribute stream
697 static inline int nla_ok(const struct nlattr
*nla
, int remaining
)
699 return remaining
>= (int) sizeof(*nla
) &&
700 nla
->nla_len
>= sizeof(*nla
) &&
701 nla
->nla_len
<= remaining
;
705 * nla_next - next netlink attribute in attribute stream
706 * @nla: netlink attribute
707 * @remaining: number of bytes remaining in attribute stream
709 * Returns the next netlink attribute in the attribute stream and
710 * decrements remaining by the size of the current attribute.
712 static inline struct nlattr
*nla_next(const struct nlattr
*nla
, int *remaining
)
714 int totlen
= NLA_ALIGN(nla
->nla_len
);
716 *remaining
-= totlen
;
717 return (struct nlattr
*) ((char *) nla
+ totlen
);
721 * nla_find_nested - find attribute in a set of nested attributes
722 * @nla: attribute containing the nested attributes
723 * @attrtype: type of attribute to look for
725 * Returns the first attribute which matches the specified type.
727 static inline struct nlattr
*
728 nla_find_nested(const struct nlattr
*nla
, int attrtype
)
730 return nla_find(nla_data(nla
), nla_len(nla
), attrtype
);
734 * nla_parse_nested - parse nested attributes
735 * @tb: destination array with maxtype+1 elements
736 * @maxtype: maximum attribute type to be expected
737 * @nla: attribute containing the nested attributes
738 * @policy: validation policy
742 static inline int nla_parse_nested(struct nlattr
*tb
[], int maxtype
,
743 const struct nlattr
*nla
,
744 const struct nla_policy
*policy
)
746 return nla_parse(tb
, maxtype
, nla_data(nla
), nla_len(nla
), policy
);
750 * nla_put_u8 - Add a u8 netlink attribute to a socket buffer
751 * @skb: socket buffer to add attribute to
752 * @attrtype: attribute type
753 * @value: numeric value
755 static inline int nla_put_u8(struct sk_buff
*skb
, int attrtype
, u8 value
)
757 return nla_put(skb
, attrtype
, sizeof(u8
), &value
);
761 * nla_put_u16 - Add a u16 netlink attribute to a socket buffer
762 * @skb: socket buffer to add attribute to
763 * @attrtype: attribute type
764 * @value: numeric value
766 static inline int nla_put_u16(struct sk_buff
*skb
, int attrtype
, u16 value
)
768 return nla_put(skb
, attrtype
, sizeof(u16
), &value
);
772 * nla_put_be16 - Add a __be16 netlink attribute to a socket buffer
773 * @skb: socket buffer to add attribute to
774 * @attrtype: attribute type
775 * @value: numeric value
777 static inline int nla_put_be16(struct sk_buff
*skb
, int attrtype
, __be16 value
)
779 return nla_put(skb
, attrtype
, sizeof(__be16
), &value
);
783 * nla_put_net16 - Add 16-bit network byte order netlink attribute to a socket buffer
784 * @skb: socket buffer to add attribute to
785 * @attrtype: attribute type
786 * @value: numeric value
788 static inline int nla_put_net16(struct sk_buff
*skb
, int attrtype
, __be16 value
)
790 return nla_put_be16(skb
, attrtype
| NLA_F_NET_BYTEORDER
, value
);
794 * nla_put_le16 - Add a __le16 netlink attribute to a socket buffer
795 * @skb: socket buffer to add attribute to
796 * @attrtype: attribute type
797 * @value: numeric value
799 static inline int nla_put_le16(struct sk_buff
*skb
, int attrtype
, __le16 value
)
801 return nla_put(skb
, attrtype
, sizeof(__le16
), &value
);
805 * nla_put_u32 - Add a u32 netlink attribute to a socket buffer
806 * @skb: socket buffer to add attribute to
807 * @attrtype: attribute type
808 * @value: numeric value
810 static inline int nla_put_u32(struct sk_buff
*skb
, int attrtype
, u32 value
)
812 return nla_put(skb
, attrtype
, sizeof(u32
), &value
);
816 * nla_put_be32 - Add a __be32 netlink attribute to a socket buffer
817 * @skb: socket buffer to add attribute to
818 * @attrtype: attribute type
819 * @value: numeric value
821 static inline int nla_put_be32(struct sk_buff
*skb
, int attrtype
, __be32 value
)
823 return nla_put(skb
, attrtype
, sizeof(__be32
), &value
);
827 * nla_put_net32 - Add 32-bit network byte order netlink attribute to a socket buffer
828 * @skb: socket buffer to add attribute to
829 * @attrtype: attribute type
830 * @value: numeric value
832 static inline int nla_put_net32(struct sk_buff
*skb
, int attrtype
, __be32 value
)
834 return nla_put_be32(skb
, attrtype
| NLA_F_NET_BYTEORDER
, value
);
838 * nla_put_le32 - Add a __le32 netlink attribute to a socket buffer
839 * @skb: socket buffer to add attribute to
840 * @attrtype: attribute type
841 * @value: numeric value
843 static inline int nla_put_le32(struct sk_buff
*skb
, int attrtype
, __le32 value
)
845 return nla_put(skb
, attrtype
, sizeof(__le32
), &value
);
849 * nla_put_u64 - Add a u64 netlink attribute to a socket buffer
850 * @skb: socket buffer to add attribute to
851 * @attrtype: attribute type
852 * @value: numeric value
854 static inline int nla_put_u64(struct sk_buff
*skb
, int attrtype
, u64 value
)
856 return nla_put(skb
, attrtype
, sizeof(u64
), &value
);
860 * nla_put_be64 - Add a __be64 netlink attribute to a socket buffer and align it
861 * @skb: socket buffer to add attribute to
862 * @attrtype: attribute type
863 * @value: numeric value
864 * @padattr: attribute type for the padding
866 static inline int nla_put_be64(struct sk_buff
*skb
, int attrtype
, __be64 value
,
869 return nla_put_64bit(skb
, attrtype
, sizeof(__be64
), &value
, padattr
);
873 * nla_put_net64 - Add 64-bit network byte order nlattr to a skb and align it
874 * @skb: socket buffer to add attribute to
875 * @attrtype: attribute type
876 * @value: numeric value
877 * @padattr: attribute type for the padding
879 static inline int nla_put_net64(struct sk_buff
*skb
, int attrtype
, __be64 value
,
882 return nla_put_be64(skb
, attrtype
| NLA_F_NET_BYTEORDER
, value
,
887 * nla_put_le64 - Add a __le64 netlink attribute to a socket buffer and align it
888 * @skb: socket buffer to add attribute to
889 * @attrtype: attribute type
890 * @value: numeric value
891 * @padattr: attribute type for the padding
893 static inline int nla_put_le64(struct sk_buff
*skb
, int attrtype
, __le64 value
,
896 return nla_put_64bit(skb
, attrtype
, sizeof(__le64
), &value
, padattr
);
900 * nla_put_s8 - Add a s8 netlink attribute to a socket buffer
901 * @skb: socket buffer to add attribute to
902 * @attrtype: attribute type
903 * @value: numeric value
905 static inline int nla_put_s8(struct sk_buff
*skb
, int attrtype
, s8 value
)
907 return nla_put(skb
, attrtype
, sizeof(s8
), &value
);
911 * nla_put_s16 - Add a s16 netlink attribute to a socket buffer
912 * @skb: socket buffer to add attribute to
913 * @attrtype: attribute type
914 * @value: numeric value
916 static inline int nla_put_s16(struct sk_buff
*skb
, int attrtype
, s16 value
)
918 return nla_put(skb
, attrtype
, sizeof(s16
), &value
);
922 * nla_put_s32 - Add a s32 netlink attribute to a socket buffer
923 * @skb: socket buffer to add attribute to
924 * @attrtype: attribute type
925 * @value: numeric value
927 static inline int nla_put_s32(struct sk_buff
*skb
, int attrtype
, s32 value
)
929 return nla_put(skb
, attrtype
, sizeof(s32
), &value
);
933 * nla_put_s64 - Add a s64 netlink attribute to a socket buffer and align it
934 * @skb: socket buffer to add attribute to
935 * @attrtype: attribute type
936 * @value: numeric value
937 * @padattr: attribute type for the padding
939 static inline int nla_put_s64(struct sk_buff
*skb
, int attrtype
, s64 value
,
942 return nla_put_64bit(skb
, attrtype
, sizeof(s64
), &value
, padattr
);
946 * nla_put_string - Add a string netlink attribute to a socket buffer
947 * @skb: socket buffer to add attribute to
948 * @attrtype: attribute type
949 * @str: NUL terminated string
951 static inline int nla_put_string(struct sk_buff
*skb
, int attrtype
,
954 return nla_put(skb
, attrtype
, strlen(str
) + 1, str
);
958 * nla_put_flag - Add a flag netlink attribute to a socket buffer
959 * @skb: socket buffer to add attribute to
960 * @attrtype: attribute type
962 static inline int nla_put_flag(struct sk_buff
*skb
, int attrtype
)
964 return nla_put(skb
, attrtype
, 0, NULL
);
968 * nla_put_msecs - Add a msecs netlink attribute to a socket buffer
969 * @skb: socket buffer to add attribute to
970 * @attrtype: attribute type
971 * @njiffies: number of jiffies to convert to msecs
973 static inline int nla_put_msecs(struct sk_buff
*skb
, int attrtype
,
974 unsigned long njiffies
)
976 u64 tmp
= jiffies_to_msecs(njiffies
);
977 return nla_put(skb
, attrtype
, sizeof(u64
), &tmp
);
981 * nla_put_in_addr - Add an IPv4 address netlink attribute to a socket
983 * @skb: socket buffer to add attribute to
984 * @attrtype: attribute type
985 * @addr: IPv4 address
987 static inline int nla_put_in_addr(struct sk_buff
*skb
, int attrtype
,
990 return nla_put_be32(skb
, attrtype
, addr
);
994 * nla_put_in6_addr - Add an IPv6 address netlink attribute to a socket
996 * @skb: socket buffer to add attribute to
997 * @attrtype: attribute type
998 * @addr: IPv6 address
1000 static inline int nla_put_in6_addr(struct sk_buff
*skb
, int attrtype
,
1001 const struct in6_addr
*addr
)
1003 return nla_put(skb
, attrtype
, sizeof(*addr
), addr
);
1007 * nla_get_u32 - return payload of u32 attribute
1008 * @nla: u32 netlink attribute
1010 static inline u32
nla_get_u32(const struct nlattr
*nla
)
1012 return *(u32
*) nla_data(nla
);
1016 * nla_get_be32 - return payload of __be32 attribute
1017 * @nla: __be32 netlink attribute
1019 static inline __be32
nla_get_be32(const struct nlattr
*nla
)
1021 return *(__be32
*) nla_data(nla
);
1025 * nla_get_le32 - return payload of __le32 attribute
1026 * @nla: __le32 netlink attribute
1028 static inline __le32
nla_get_le32(const struct nlattr
*nla
)
1030 return *(__le32
*) nla_data(nla
);
1034 * nla_get_u16 - return payload of u16 attribute
1035 * @nla: u16 netlink attribute
1037 static inline u16
nla_get_u16(const struct nlattr
*nla
)
1039 return *(u16
*) nla_data(nla
);
1043 * nla_get_be16 - return payload of __be16 attribute
1044 * @nla: __be16 netlink attribute
1046 static inline __be16
nla_get_be16(const struct nlattr
*nla
)
1048 return *(__be16
*) nla_data(nla
);
1052 * nla_get_le16 - return payload of __le16 attribute
1053 * @nla: __le16 netlink attribute
1055 static inline __le16
nla_get_le16(const struct nlattr
*nla
)
1057 return *(__le16
*) nla_data(nla
);
1061 * nla_get_u8 - return payload of u8 attribute
1062 * @nla: u8 netlink attribute
1064 static inline u8
nla_get_u8(const struct nlattr
*nla
)
1066 return *(u8
*) nla_data(nla
);
1070 * nla_get_u64 - return payload of u64 attribute
1071 * @nla: u64 netlink attribute
1073 static inline u64
nla_get_u64(const struct nlattr
*nla
)
1077 nla_memcpy(&tmp
, nla
, sizeof(tmp
));
1083 * nla_get_be64 - return payload of __be64 attribute
1084 * @nla: __be64 netlink attribute
1086 static inline __be64
nla_get_be64(const struct nlattr
*nla
)
1090 nla_memcpy(&tmp
, nla
, sizeof(tmp
));
1096 * nla_get_le64 - return payload of __le64 attribute
1097 * @nla: __le64 netlink attribute
1099 static inline __le64
nla_get_le64(const struct nlattr
*nla
)
1101 return *(__le64
*) nla_data(nla
);
1105 * nla_get_s32 - return payload of s32 attribute
1106 * @nla: s32 netlink attribute
1108 static inline s32
nla_get_s32(const struct nlattr
*nla
)
1110 return *(s32
*) nla_data(nla
);
1114 * nla_get_s16 - return payload of s16 attribute
1115 * @nla: s16 netlink attribute
1117 static inline s16
nla_get_s16(const struct nlattr
*nla
)
1119 return *(s16
*) nla_data(nla
);
1123 * nla_get_s8 - return payload of s8 attribute
1124 * @nla: s8 netlink attribute
1126 static inline s8
nla_get_s8(const struct nlattr
*nla
)
1128 return *(s8
*) nla_data(nla
);
1132 * nla_get_s64 - return payload of s64 attribute
1133 * @nla: s64 netlink attribute
1135 static inline s64
nla_get_s64(const struct nlattr
*nla
)
1139 nla_memcpy(&tmp
, nla
, sizeof(tmp
));
1145 * nla_get_flag - return payload of flag attribute
1146 * @nla: flag netlink attribute
1148 static inline int nla_get_flag(const struct nlattr
*nla
)
1154 * nla_get_msecs - return payload of msecs attribute
1155 * @nla: msecs netlink attribute
1157 * Returns the number of milliseconds in jiffies.
1159 static inline unsigned long nla_get_msecs(const struct nlattr
*nla
)
1161 u64 msecs
= nla_get_u64(nla
);
1163 return msecs_to_jiffies((unsigned long) msecs
);
1167 * nla_get_in_addr - return payload of IPv4 address attribute
1168 * @nla: IPv4 address netlink attribute
1170 static inline __be32
nla_get_in_addr(const struct nlattr
*nla
)
1172 return *(__be32
*) nla_data(nla
);
1176 * nla_get_in6_addr - return payload of IPv6 address attribute
1177 * @nla: IPv6 address netlink attribute
1179 static inline struct in6_addr
nla_get_in6_addr(const struct nlattr
*nla
)
1181 struct in6_addr tmp
;
1183 nla_memcpy(&tmp
, nla
, sizeof(tmp
));
1188 * nla_nest_start - Start a new level of nested attributes
1189 * @skb: socket buffer to add attributes to
1190 * @attrtype: attribute type of container
1192 * Returns the container attribute
1194 static inline struct nlattr
*nla_nest_start(struct sk_buff
*skb
, int attrtype
)
1196 struct nlattr
*start
= (struct nlattr
*)skb_tail_pointer(skb
);
1198 if (nla_put(skb
, attrtype
, 0, NULL
) < 0)
1205 * nla_nest_end - Finalize nesting of attributes
1206 * @skb: socket buffer the attributes are stored in
1207 * @start: container attribute
1209 * Corrects the container attribute header to include the all
1210 * appeneded attributes.
1212 * Returns the total data length of the skb.
1214 static inline int nla_nest_end(struct sk_buff
*skb
, struct nlattr
*start
)
1216 start
->nla_len
= skb_tail_pointer(skb
) - (unsigned char *)start
;
1221 * nla_nest_cancel - Cancel nesting of attributes
1222 * @skb: socket buffer the message is stored in
1223 * @start: container attribute
1225 * Removes the container attribute and including all nested
1226 * attributes. Returns -EMSGSIZE
1228 static inline void nla_nest_cancel(struct sk_buff
*skb
, struct nlattr
*start
)
1230 nlmsg_trim(skb
, start
);
1234 * nla_validate_nested - Validate a stream of nested attributes
1235 * @start: container attribute
1236 * @maxtype: maximum attribute type to be expected
1237 * @policy: validation policy
1239 * Validates all attributes in the nested attribute stream against the
1240 * specified policy. Attributes with a type exceeding maxtype will be
1241 * ignored. See documenation of struct nla_policy for more details.
1243 * Returns 0 on success or a negative error code.
1245 static inline int nla_validate_nested(const struct nlattr
*start
, int maxtype
,
1246 const struct nla_policy
*policy
)
1248 return nla_validate(nla_data(start
), nla_len(start
), maxtype
, policy
);
1252 * nla_need_padding_for_64bit - test 64-bit alignment of the next attribute
1253 * @skb: socket buffer the message is stored in
1255 * Return true if padding is needed to align the next attribute (nla_data()) to
1256 * a 64-bit aligned area.
1258 static inline bool nla_need_padding_for_64bit(struct sk_buff
*skb
)
1260 #ifndef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS
1261 /* The nlattr header is 4 bytes in size, that's why we test
1262 * if the skb->data _is_ aligned. A NOP attribute, plus
1263 * nlattr header for next attribute, will make nla_data()
1266 if (IS_ALIGNED((unsigned long)skb_tail_pointer(skb
), 8))
1273 * nla_align_64bit - 64-bit align the nla_data() of next attribute
1274 * @skb: socket buffer the message is stored in
1275 * @padattr: attribute type for the padding
1277 * Conditionally emit a padding netlink attribute in order to make
1278 * the next attribute we emit have a 64-bit aligned nla_data() area.
1279 * This will only be done in architectures which do not have
1280 * CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS defined.
1282 * Returns zero on success or a negative error code.
1284 static inline int nla_align_64bit(struct sk_buff
*skb
, int padattr
)
1286 if (nla_need_padding_for_64bit(skb
) &&
1287 !nla_reserve(skb
, padattr
, 0))
1294 * nla_total_size_64bit - total length of attribute including padding
1295 * @payload: length of payload
1297 static inline int nla_total_size_64bit(int payload
)
1299 return NLA_ALIGN(nla_attr_size(payload
))
1300 #ifndef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS
1301 + NLA_ALIGN(nla_attr_size(0))
1307 * nla_for_each_attr - iterate over a stream of attributes
1308 * @pos: loop counter, set to current attribute
1309 * @head: head of attribute stream
1310 * @len: length of attribute stream
1311 * @rem: initialized to len, holds bytes currently remaining in stream
1313 #define nla_for_each_attr(pos, head, len, rem) \
1314 for (pos = head, rem = len; \
1316 pos = nla_next(pos, &(rem)))
1319 * nla_for_each_nested - iterate over nested attributes
1320 * @pos: loop counter, set to current attribute
1321 * @nla: attribute containing the nested attributes
1322 * @rem: initialized to len, holds bytes currently remaining in stream
1324 #define nla_for_each_nested(pos, nla, rem) \
1325 nla_for_each_attr(pos, nla_data(nla), nla_len(nla), rem)
1328 * nla_is_last - Test if attribute is last in stream
1329 * @nla: attribute to test
1330 * @rem: bytes remaining in stream
1332 static inline bool nla_is_last(const struct nlattr
*nla
, int rem
)
1334 return nla
->nla_len
== rem
;
This page took 0.06157 seconds and 5 git commands to generate.