xref: /openbmc/linux/include/net/netlink.h (revision 33188bd6)
1b2441318SGreg Kroah-Hartman /* SPDX-License-Identifier: GPL-2.0 */
2bfa83a9eSThomas Graf #ifndef __NET_NETLINK_H
3bfa83a9eSThomas Graf #define __NET_NETLINK_H
4bfa83a9eSThomas Graf 
5bfa83a9eSThomas Graf #include <linux/types.h>
6bfa83a9eSThomas Graf #include <linux/netlink.h>
7d7fe0f24SAl Viro #include <linux/jiffies.h>
8930345eaSJiri Benc #include <linux/in6.h>
9bfa83a9eSThomas Graf 
10bfa83a9eSThomas Graf /* ========================================================================
11bfa83a9eSThomas Graf  *         Netlink Messages and Attributes Interface (As Seen On TV)
12bfa83a9eSThomas Graf  * ------------------------------------------------------------------------
13bfa83a9eSThomas Graf  *                          Messages Interface
14bfa83a9eSThomas Graf  * ------------------------------------------------------------------------
15bfa83a9eSThomas Graf  *
16bfa83a9eSThomas Graf  * Message Format:
17bfa83a9eSThomas Graf  *    <--- nlmsg_total_size(payload)  --->
18bfa83a9eSThomas Graf  *    <-- nlmsg_msg_size(payload) ->
19bfa83a9eSThomas Graf  *   +----------+- - -+-------------+- - -+-------- - -
20bfa83a9eSThomas Graf  *   | nlmsghdr | Pad |   Payload   | Pad | nlmsghdr
21bfa83a9eSThomas Graf  *   +----------+- - -+-------------+- - -+-------- - -
22bfa83a9eSThomas Graf  *   nlmsg_data(nlh)---^                   ^
23bfa83a9eSThomas Graf  *   nlmsg_next(nlh)-----------------------+
24bfa83a9eSThomas Graf  *
25bfa83a9eSThomas Graf  * Payload Format:
26bfa83a9eSThomas Graf  *    <---------------------- nlmsg_len(nlh) --------------------->
27bfa83a9eSThomas Graf  *    <------ hdrlen ------>       <- nlmsg_attrlen(nlh, hdrlen) ->
28bfa83a9eSThomas Graf  *   +----------------------+- - -+--------------------------------+
29bfa83a9eSThomas Graf  *   |     Family Header    | Pad |           Attributes           |
30bfa83a9eSThomas Graf  *   +----------------------+- - -+--------------------------------+
31bfa83a9eSThomas Graf  *   nlmsg_attrdata(nlh, hdrlen)---^
32bfa83a9eSThomas Graf  *
33bfa83a9eSThomas Graf  * Data Structures:
34bfa83a9eSThomas Graf  *   struct nlmsghdr			netlink message header
35bfa83a9eSThomas Graf  *
36bfa83a9eSThomas Graf  * Message Construction:
37bfa83a9eSThomas Graf  *   nlmsg_new()			create a new netlink message
38bfa83a9eSThomas Graf  *   nlmsg_put()			add a netlink message to an skb
39bfa83a9eSThomas Graf  *   nlmsg_put_answer()			callback based nlmsg_put()
401dc8d8c0SJustin P. Mattock  *   nlmsg_end()			finalize netlink message
41fe4944e5SThomas Graf  *   nlmsg_get_pos()			return current position in message
42fe4944e5SThomas Graf  *   nlmsg_trim()			trim part of message
43bfa83a9eSThomas Graf  *   nlmsg_cancel()			cancel message construction
44bfa83a9eSThomas Graf  *   nlmsg_free()			free a netlink message
45bfa83a9eSThomas Graf  *
46bfa83a9eSThomas Graf  * Message Sending:
47bfa83a9eSThomas Graf  *   nlmsg_multicast()			multicast message to several groups
48bfa83a9eSThomas Graf  *   nlmsg_unicast()			unicast a message to a single socket
49d387f6adSThomas Graf  *   nlmsg_notify()			send notification message
50bfa83a9eSThomas Graf  *
51bfa83a9eSThomas Graf  * Message Length Calculations:
52bfa83a9eSThomas Graf  *   nlmsg_msg_size(payload)		length of message w/o padding
53bfa83a9eSThomas Graf  *   nlmsg_total_size(payload)		length of message w/ padding
54bfa83a9eSThomas Graf  *   nlmsg_padlen(payload)		length of padding at tail
55bfa83a9eSThomas Graf  *
56bfa83a9eSThomas Graf  * Message Payload Access:
57bfa83a9eSThomas Graf  *   nlmsg_data(nlh)			head of message payload
58bfa83a9eSThomas Graf  *   nlmsg_len(nlh)			length of message payload
59bfa83a9eSThomas Graf  *   nlmsg_attrdata(nlh, hdrlen)	head of attributes data
60bfa83a9eSThomas Graf  *   nlmsg_attrlen(nlh, hdrlen)		length of attributes data
61bfa83a9eSThomas Graf  *
62bfa83a9eSThomas Graf  * Message Parsing:
63bfa83a9eSThomas Graf  *   nlmsg_ok(nlh, remaining)		does nlh fit into remaining bytes?
64bfa83a9eSThomas Graf  *   nlmsg_next(nlh, remaining)		get next netlink message
65bfa83a9eSThomas Graf  *   nlmsg_parse()			parse attributes of a message
66bfa83a9eSThomas Graf  *   nlmsg_find_attr()			find an attribute in a message
67bfa83a9eSThomas Graf  *   nlmsg_for_each_msg()		loop over all messages
68bfa83a9eSThomas Graf  *   nlmsg_validate()			validate netlink message incl. attrs
69bfa83a9eSThomas Graf  *   nlmsg_for_each_attr()		loop over all attributes
70bfa83a9eSThomas Graf  *
7197676b6bSThomas Graf  * Misc:
7297676b6bSThomas Graf  *   nlmsg_report()			report back to application?
7397676b6bSThomas Graf  *
74bfa83a9eSThomas Graf  * ------------------------------------------------------------------------
75bfa83a9eSThomas Graf  *                          Attributes Interface
76bfa83a9eSThomas Graf  * ------------------------------------------------------------------------
77bfa83a9eSThomas Graf  *
78bfa83a9eSThomas Graf  * Attribute Format:
79bfa83a9eSThomas Graf  *    <------- nla_total_size(payload) ------->
80bfa83a9eSThomas Graf  *    <---- nla_attr_size(payload) ----->
81bfa83a9eSThomas Graf  *   +----------+- - -+- - - - - - - - - +- - -+-------- - -
82bfa83a9eSThomas Graf  *   |  Header  | Pad |     Payload      | Pad |  Header
83bfa83a9eSThomas Graf  *   +----------+- - -+- - - - - - - - - +- - -+-------- - -
84bfa83a9eSThomas Graf  *                     <- nla_len(nla) ->      ^
85bfa83a9eSThomas Graf  *   nla_data(nla)----^                        |
86bfa83a9eSThomas Graf  *   nla_next(nla)-----------------------------'
87bfa83a9eSThomas Graf  *
88bfa83a9eSThomas Graf  * Data Structures:
89d1ec3b77SPierre Ynard  *   struct nlattr			netlink attribute header
90bfa83a9eSThomas Graf  *
91bfa83a9eSThomas Graf  * Attribute Construction:
92fe4944e5SThomas Graf  *   nla_reserve(skb, type, len)	reserve room for an attribute
93fe4944e5SThomas Graf  *   nla_reserve_nohdr(skb, len)	reserve room for an attribute w/o hdr
94bfa83a9eSThomas Graf  *   nla_put(skb, type, len, data)	add attribute to skb
95fe4944e5SThomas Graf  *   nla_put_nohdr(skb, len, data)	add attribute w/o hdr
9601480e1cSPatrick McHardy  *   nla_append(skb, len, data)		append data to skb
97bfa83a9eSThomas Graf  *
98bfa83a9eSThomas Graf  * Attribute Construction for Basic Types:
99bfa83a9eSThomas Graf  *   nla_put_u8(skb, type, value)	add u8 attribute to skb
100bfa83a9eSThomas Graf  *   nla_put_u16(skb, type, value)	add u16 attribute to skb
101bfa83a9eSThomas Graf  *   nla_put_u32(skb, type, value)	add u32 attribute to skb
10226837012SRolf Eike Beer  *   nla_put_u64_64bit(skb, type,
10350225243SNicolas Dichtel  *                     value, padattr)	add u64 attribute to skb
1044778e0beSJiri Pirko  *   nla_put_s8(skb, type, value)	add s8 attribute to skb
1054778e0beSJiri Pirko  *   nla_put_s16(skb, type, value)	add s16 attribute to skb
1064778e0beSJiri Pirko  *   nla_put_s32(skb, type, value)	add s32 attribute to skb
107756a2f59SNicolas Dichtel  *   nla_put_s64(skb, type, value,
108756a2f59SNicolas Dichtel  *               padattr)		add s64 attribute to skb
109bfa83a9eSThomas Graf  *   nla_put_string(skb, type, str)	add string attribute to skb
110bfa83a9eSThomas Graf  *   nla_put_flag(skb, type)		add flag attribute to skb
1112175d87cSNicolas Dichtel  *   nla_put_msecs(skb, type, jiffies,
1122175d87cSNicolas Dichtel  *                 padattr)		add msecs attribute to skb
113930345eaSJiri Benc  *   nla_put_in_addr(skb, type, addr)	add IPv4 address attribute to skb
114930345eaSJiri Benc  *   nla_put_in6_addr(skb, type, addr)	add IPv6 address attribute to skb
115bfa83a9eSThomas Graf  *
116bfa83a9eSThomas Graf  * Nested Attributes Construction:
117bfa83a9eSThomas Graf  *   nla_nest_start(skb, type)		start a nested attribute
118bfa83a9eSThomas Graf  *   nla_nest_end(skb, nla)		finalize a nested attribute
119bfa83a9eSThomas Graf  *   nla_nest_cancel(skb, nla)		cancel nested attribute construction
120bfa83a9eSThomas Graf  *
121bfa83a9eSThomas Graf  * Attribute Length Calculations:
122bfa83a9eSThomas Graf  *   nla_attr_size(payload)		length of attribute w/o padding
123bfa83a9eSThomas Graf  *   nla_total_size(payload)		length of attribute w/ padding
124bfa83a9eSThomas Graf  *   nla_padlen(payload)		length of padding
125bfa83a9eSThomas Graf  *
126bfa83a9eSThomas Graf  * Attribute Payload Access:
127bfa83a9eSThomas Graf  *   nla_data(nla)			head of attribute payload
128bfa83a9eSThomas Graf  *   nla_len(nla)			length of attribute payload
129bfa83a9eSThomas Graf  *
130bfa83a9eSThomas Graf  * Attribute Payload Access for Basic Types:
131bfa83a9eSThomas Graf  *   nla_get_u8(nla)			get payload for a u8 attribute
132bfa83a9eSThomas Graf  *   nla_get_u16(nla)			get payload for a u16 attribute
133bfa83a9eSThomas Graf  *   nla_get_u32(nla)			get payload for a u32 attribute
134bfa83a9eSThomas Graf  *   nla_get_u64(nla)			get payload for a u64 attribute
1354778e0beSJiri Pirko  *   nla_get_s8(nla)			get payload for a s8 attribute
1364778e0beSJiri Pirko  *   nla_get_s16(nla)			get payload for a s16 attribute
1374778e0beSJiri Pirko  *   nla_get_s32(nla)			get payload for a s32 attribute
1384778e0beSJiri Pirko  *   nla_get_s64(nla)			get payload for a s64 attribute
139bfa83a9eSThomas Graf  *   nla_get_flag(nla)			return 1 if flag is true
140bfa83a9eSThomas Graf  *   nla_get_msecs(nla)			get payload for a msecs attribute
141bfa83a9eSThomas Graf  *
142bfa83a9eSThomas Graf  * Attribute Misc:
143bfa83a9eSThomas Graf  *   nla_memcpy(dest, nla, count)	copy attribute into memory
144bfa83a9eSThomas Graf  *   nla_memcmp(nla, data, size)	compare attribute with memory area
145bfa83a9eSThomas Graf  *   nla_strlcpy(dst, nla, size)	copy attribute to a sized string
146bfa83a9eSThomas Graf  *   nla_strcmp(nla, str)		compare attribute with string
147bfa83a9eSThomas Graf  *
148bfa83a9eSThomas Graf  * Attribute Parsing:
149bfa83a9eSThomas Graf  *   nla_ok(nla, remaining)		does nla fit into remaining bytes?
150bfa83a9eSThomas Graf  *   nla_next(nla, remaining)		get next netlink attribute
151bfa83a9eSThomas Graf  *   nla_validate()			validate a stream of attributes
1524fe5d5c0SPaul Moore  *   nla_validate_nested()		validate a stream of nested attributes
153bfa83a9eSThomas Graf  *   nla_find()				find attribute in stream of attributes
154fe4944e5SThomas Graf  *   nla_find_nested()			find attribute in nested attributes
155bfa83a9eSThomas Graf  *   nla_parse()			parse and validate stream of attrs
156bfa83a9eSThomas Graf  *   nla_parse_nested()			parse nested attribuets
157bfa83a9eSThomas Graf  *   nla_for_each_attr()		loop over all attributes
15822acb19aSPaul Moore  *   nla_for_each_nested()		loop over the nested attributes
159bfa83a9eSThomas Graf  *=========================================================================
160bfa83a9eSThomas Graf  */
161bfa83a9eSThomas Graf 
162bfa83a9eSThomas Graf  /**
163bfa83a9eSThomas Graf   * Standard attribute types to specify validation policy
164bfa83a9eSThomas Graf   */
165bfa83a9eSThomas Graf enum {
166bfa83a9eSThomas Graf 	NLA_UNSPEC,
167bfa83a9eSThomas Graf 	NLA_U8,
168bfa83a9eSThomas Graf 	NLA_U16,
169bfa83a9eSThomas Graf 	NLA_U32,
170bfa83a9eSThomas Graf 	NLA_U64,
171bfa83a9eSThomas Graf 	NLA_STRING,
172bfa83a9eSThomas Graf 	NLA_FLAG,
173bfa83a9eSThomas Graf 	NLA_MSECS,
174bfa83a9eSThomas Graf 	NLA_NESTED,
1751501d135SJohannes Berg 	NLA_NESTED_ARRAY,
176a5531a5dSThomas Graf 	NLA_NUL_STRING,
177d30045a0SJohannes Berg 	NLA_BINARY,
1784778e0beSJiri Pirko 	NLA_S8,
1794778e0beSJiri Pirko 	NLA_S16,
1804778e0beSJiri Pirko 	NLA_S32,
1814778e0beSJiri Pirko 	NLA_S64,
18264c83d83SJamal Hadi Salim 	NLA_BITFIELD32,
183568b742aSJohannes Berg 	NLA_REJECT,
184b60b87fcSJohannes Berg 	NLA_EXACT_LEN,
185b60b87fcSJohannes Berg 	NLA_EXACT_LEN_WARN,
186bfa83a9eSThomas Graf 	__NLA_TYPE_MAX,
187bfa83a9eSThomas Graf };
188bfa83a9eSThomas Graf 
189bfa83a9eSThomas Graf #define NLA_TYPE_MAX (__NLA_TYPE_MAX - 1)
190bfa83a9eSThomas Graf 
1913e48be05SJohannes Berg enum nla_policy_validation {
1923e48be05SJohannes Berg 	NLA_VALIDATE_NONE,
1933e48be05SJohannes Berg 	NLA_VALIDATE_RANGE,
1943e48be05SJohannes Berg 	NLA_VALIDATE_MIN,
1953e48be05SJohannes Berg 	NLA_VALIDATE_MAX,
19633188bd6SJohannes Berg 	NLA_VALIDATE_FUNCTION,
1973e48be05SJohannes Berg };
1983e48be05SJohannes Berg 
199bfa83a9eSThomas Graf /**
200bfa83a9eSThomas Graf  * struct nla_policy - attribute validation policy
201bfa83a9eSThomas Graf  * @type: Type of attribute or NLA_UNSPEC
2023e48be05SJohannes Berg  * @validation_type: type of attribute validation done in addition to
20333188bd6SJohannes Berg  *	type-specific validation (e.g. range, function call), see
2043e48be05SJohannes Berg  *	&enum nla_policy_validation
205a5531a5dSThomas Graf  * @len: Type specific length of payload
206bfa83a9eSThomas Graf  *
207bfa83a9eSThomas Graf  * Policies are defined as arrays of this struct, the array must be
208bfa83a9eSThomas Graf  * accessible by attribute type up to the highest identifier to be expected.
209bfa83a9eSThomas Graf  *
210a5531a5dSThomas Graf  * Meaning of `len' field:
211a5531a5dSThomas Graf  *    NLA_STRING           Maximum length of string
212a5531a5dSThomas Graf  *    NLA_NUL_STRING       Maximum length of string (excluding NUL)
213a5531a5dSThomas Graf  *    NLA_FLAG             Unused
214d30045a0SJohannes Berg  *    NLA_BINARY           Maximum length of attribute payload
2151501d135SJohannes Berg  *    NLA_NESTED,
2161501d135SJohannes Berg  *    NLA_NESTED_ARRAY     Length verification is done by checking len of
2179a659a35SJohannes Berg  *                         nested header (or empty); len field is used if
2189a659a35SJohannes Berg  *                         validation_data is also used, for the max attr
2199a659a35SJohannes Berg  *                         number in the nested policy.
2204b6cc728SJohannes Berg  *    NLA_U8, NLA_U16,
2214b6cc728SJohannes Berg  *    NLA_U32, NLA_U64,
2224778e0beSJiri Pirko  *    NLA_S8, NLA_S16,
2234778e0beSJiri Pirko  *    NLA_S32, NLA_S64,
2244b6cc728SJohannes Berg  *    NLA_MSECS            Leaving the length field zero will verify the
2254b6cc728SJohannes Berg  *                         given type fits, using it verifies minimum length
2264b6cc728SJohannes Berg  *                         just like "All other"
227568b742aSJohannes Berg  *    NLA_BITFIELD32       Unused
228568b742aSJohannes Berg  *    NLA_REJECT           Unused
229b60b87fcSJohannes Berg  *    NLA_EXACT_LEN        Attribute must have exactly this length, otherwise
230b60b87fcSJohannes Berg  *                         it is rejected.
231b60b87fcSJohannes Berg  *    NLA_EXACT_LEN_WARN   Attribute should have exactly this length, a warning
232b60b87fcSJohannes Berg  *                         is logged if it is longer, shorter is rejected.
2334b6cc728SJohannes Berg  *    All other            Minimum length of attribute payload
234a5531a5dSThomas Graf  *
235568b742aSJohannes Berg  * Meaning of `validation_data' field:
236568b742aSJohannes Berg  *    NLA_BITFIELD32       This is a 32-bit bitmap/bitselector attribute and
237568b742aSJohannes Berg  *                         validation data must point to a u32 value of valid
238568b742aSJohannes Berg  *                         flags
239568b742aSJohannes Berg  *    NLA_REJECT           This attribute is always rejected and validation data
240568b742aSJohannes Berg  *                         may point to a string to report as the error instead
241568b742aSJohannes Berg  *                         of the generic one in extended ACK.
2429a659a35SJohannes Berg  *    NLA_NESTED           Points to a nested policy to validate, must also set
2439a659a35SJohannes Berg  *                         `len' to the max attribute number.
2449a659a35SJohannes Berg  *                         Note that nla_parse() will validate, but of course not
2459a659a35SJohannes Berg  *                         parse, the nested sub-policies.
2461501d135SJohannes Berg  *    NLA_NESTED_ARRAY     Points to a nested policy to validate, must also set
2471501d135SJohannes Berg  *                         `len' to the max attribute number. The difference to
2481501d135SJohannes Berg  *                         NLA_NESTED is the structure - NLA_NESTED has the
2491501d135SJohannes Berg  *                         nested attributes directly inside, while an array has
2501501d135SJohannes Berg  *                         the nested attributes at another level down and the
2511501d135SJohannes Berg  *                         attributes directly in the nesting don't matter.
2523e48be05SJohannes Berg  *    All other            Unused - but note that it's a union
2533e48be05SJohannes Berg  *
2543e48be05SJohannes Berg  * Meaning of `min' and `max' fields, use via NLA_POLICY_MIN, NLA_POLICY_MAX
2553e48be05SJohannes Berg  * and NLA_POLICY_RANGE:
2563e48be05SJohannes Berg  *    NLA_U8,
2573e48be05SJohannes Berg  *    NLA_U16,
2583e48be05SJohannes Berg  *    NLA_U32,
2593e48be05SJohannes Berg  *    NLA_U64,
2603e48be05SJohannes Berg  *    NLA_S8,
2613e48be05SJohannes Berg  *    NLA_S16,
2623e48be05SJohannes Berg  *    NLA_S32,
2633e48be05SJohannes Berg  *    NLA_S64              These are used depending on the validation_type
2643e48be05SJohannes Berg  *                         field, if that is min/max/range then the minimum,
2653e48be05SJohannes Berg  *                         maximum and both are used (respectively) to check
2663e48be05SJohannes Berg  *                         the value of the integer attribute.
2673e48be05SJohannes Berg  *                         Note that in the interest of code simplicity and
2683e48be05SJohannes Berg  *                         struct size both limits are s16, so you cannot
2693e48be05SJohannes Berg  *                         enforce a range that doesn't fall within the range
2703e48be05SJohannes Berg  *                         of s16 - do that as usual in the code instead.
2713e48be05SJohannes Berg  *    All other            Unused - but note that it's a union
272568b742aSJohannes Berg  *
27333188bd6SJohannes Berg  * Meaning of `validate' field, use via NLA_POLICY_VALIDATE_FN:
27433188bd6SJohannes Berg  *    NLA_BINARY           Validation function called for the attribute,
27533188bd6SJohannes Berg  *                         not compatible with use of the validation_data
27633188bd6SJohannes Berg  *                         as in NLA_BITFIELD32, NLA_REJECT, NLA_NESTED and
27733188bd6SJohannes Berg  *                         NLA_NESTED_ARRAY.
27833188bd6SJohannes Berg  *    All other            Unused - but note that it's a union
27933188bd6SJohannes Berg  *
280bfa83a9eSThomas Graf  * Example:
281b54452b0SAlexey Dobriyan  * static const struct nla_policy my_policy[ATTR_MAX+1] = {
282bfa83a9eSThomas Graf  * 	[ATTR_FOO] = { .type = NLA_U16 },
283d30045a0SJohannes Berg  *	[ATTR_BAR] = { .type = NLA_STRING, .len = BARSIZ },
284a5531a5dSThomas Graf  *	[ATTR_BAZ] = { .len = sizeof(struct mystruct) },
28564c83d83SJamal Hadi Salim  *	[ATTR_GOO] = { .type = NLA_BITFIELD32, .validation_data = &myvalidflags },
286bfa83a9eSThomas Graf  * };
287bfa83a9eSThomas Graf  */
288bfa83a9eSThomas Graf struct nla_policy {
2893e48be05SJohannes Berg 	u8		type;
2903e48be05SJohannes Berg 	u8		validation_type;
291a5531a5dSThomas Graf 	u16		len;
2923e48be05SJohannes Berg 	union {
29348fde90aSJohannes Berg 		const void *validation_data;
2943e48be05SJohannes Berg 		struct {
2953e48be05SJohannes Berg 			s16 min, max;
2963e48be05SJohannes Berg 		};
29733188bd6SJohannes Berg 		int (*validate)(const struct nlattr *attr,
29833188bd6SJohannes Berg 				struct netlink_ext_ack *extack);
2993e48be05SJohannes Berg 	};
300bfa83a9eSThomas Graf };
301bfa83a9eSThomas Graf 
302b60b87fcSJohannes Berg #define NLA_POLICY_EXACT_LEN(_len)	{ .type = NLA_EXACT_LEN, .len = _len }
303b60b87fcSJohannes Berg #define NLA_POLICY_EXACT_LEN_WARN(_len)	{ .type = NLA_EXACT_LEN_WARN, \
304b60b87fcSJohannes Berg 					  .len = _len }
305b60b87fcSJohannes Berg 
306b60b87fcSJohannes Berg #define NLA_POLICY_ETH_ADDR		NLA_POLICY_EXACT_LEN(ETH_ALEN)
307b60b87fcSJohannes Berg #define NLA_POLICY_ETH_ADDR_COMPAT	NLA_POLICY_EXACT_LEN_WARN(ETH_ALEN)
308b60b87fcSJohannes Berg 
3099a659a35SJohannes Berg #define NLA_POLICY_NESTED(maxattr, policy) \
3109a659a35SJohannes Berg 	{ .type = NLA_NESTED, .validation_data = policy, .len = maxattr }
3111501d135SJohannes Berg #define NLA_POLICY_NESTED_ARRAY(maxattr, policy) \
3121501d135SJohannes Berg 	{ .type = NLA_NESTED_ARRAY, .validation_data = policy, .len = maxattr }
3139a659a35SJohannes Berg 
3143e48be05SJohannes Berg #define __NLA_ENSURE(condition) (sizeof(char[1 - 2*!(condition)]) - 1)
3153e48be05SJohannes Berg #define NLA_ENSURE_INT_TYPE(tp)				\
3163e48be05SJohannes Berg 	(__NLA_ENSURE(tp == NLA_S8 || tp == NLA_U8 ||	\
3173e48be05SJohannes Berg 		      tp == NLA_S16 || tp == NLA_U16 ||	\
3183e48be05SJohannes Berg 		      tp == NLA_S32 || tp == NLA_U32 ||	\
3193e48be05SJohannes Berg 		      tp == NLA_S64 || tp == NLA_U64) + tp)
32033188bd6SJohannes Berg #define NLA_ENSURE_NO_VALIDATION_PTR(tp)		\
32133188bd6SJohannes Berg 	(__NLA_ENSURE(tp != NLA_BITFIELD32 &&		\
32233188bd6SJohannes Berg 		      tp != NLA_REJECT &&		\
32333188bd6SJohannes Berg 		      tp != NLA_NESTED &&		\
32433188bd6SJohannes Berg 		      tp != NLA_NESTED_ARRAY) + tp)
3253e48be05SJohannes Berg 
3263e48be05SJohannes Berg #define NLA_POLICY_RANGE(tp, _min, _max) {		\
3273e48be05SJohannes Berg 	.type = NLA_ENSURE_INT_TYPE(tp),		\
3283e48be05SJohannes Berg 	.validation_type = NLA_VALIDATE_RANGE,		\
3293e48be05SJohannes Berg 	.min = _min,					\
3303e48be05SJohannes Berg 	.max = _max					\
3313e48be05SJohannes Berg }
3323e48be05SJohannes Berg 
3333e48be05SJohannes Berg #define NLA_POLICY_MIN(tp, _min) {			\
3343e48be05SJohannes Berg 	.type = NLA_ENSURE_INT_TYPE(tp),		\
3353e48be05SJohannes Berg 	.validation_type = NLA_VALIDATE_MIN,		\
3363e48be05SJohannes Berg 	.min = _min,					\
3373e48be05SJohannes Berg }
3383e48be05SJohannes Berg 
3393e48be05SJohannes Berg #define NLA_POLICY_MAX(tp, _max) {			\
3403e48be05SJohannes Berg 	.type = NLA_ENSURE_INT_TYPE(tp),		\
3413e48be05SJohannes Berg 	.validation_type = NLA_VALIDATE_MAX,		\
3423e48be05SJohannes Berg 	.max = _max,					\
3433e48be05SJohannes Berg }
3443e48be05SJohannes Berg 
34533188bd6SJohannes Berg #define NLA_POLICY_VALIDATE_FN(tp, fn, ...) {		\
34633188bd6SJohannes Berg 	.type = NLA_ENSURE_NO_VALIDATION_PTR(tp),	\
34733188bd6SJohannes Berg 	.validation_type = NLA_VALIDATE_FUNCTION,	\
34833188bd6SJohannes Berg 	.validate = fn,					\
34933188bd6SJohannes Berg 	.len = __VA_ARGS__ + 0,				\
35033188bd6SJohannes Berg }
35133188bd6SJohannes Berg 
3524e902c57SThomas Graf /**
3534e902c57SThomas Graf  * struct nl_info - netlink source information
3544e902c57SThomas Graf  * @nlh: Netlink message header of original request
35515e47304SEric W. Biederman  * @portid: Netlink PORTID of requesting application
3564e902c57SThomas Graf  */
3574e902c57SThomas Graf struct nl_info {
3584e902c57SThomas Graf 	struct nlmsghdr		*nlh;
3594d1169c1SDenis V. Lunev 	struct net		*nl_net;
36015e47304SEric W. Biederman 	u32			portid;
3613b1137feSDavid Ahern 	bool			skip_notify;
3624e902c57SThomas Graf };
3634e902c57SThomas Graf 
3644f69053bSJoe Perches int netlink_rcv_skb(struct sk_buff *skb,
3652d4bc933SJohannes Berg 		    int (*cb)(struct sk_buff *, struct nlmsghdr *,
3662d4bc933SJohannes Berg 			      struct netlink_ext_ack *));
3674f69053bSJoe Perches int nlmsg_notify(struct sock *sk, struct sk_buff *skb, u32 portid,
3684f69053bSJoe Perches 		 unsigned int group, int report, gfp_t flags);
36982ace47aSThomas Graf 
3704f69053bSJoe Perches int nla_validate(const struct nlattr *head, int len, int maxtype,
371fceb6435SJohannes Berg 		 const struct nla_policy *policy,
372fceb6435SJohannes Berg 		 struct netlink_ext_ack *extack);
3734f69053bSJoe Perches int nla_parse(struct nlattr **tb, int maxtype, const struct nlattr *head,
374fceb6435SJohannes Berg 	      int len, const struct nla_policy *policy,
375fceb6435SJohannes Berg 	      struct netlink_ext_ack *extack);
3764f69053bSJoe Perches int nla_policy_len(const struct nla_policy *, int);
3774f69053bSJoe Perches struct nlattr *nla_find(const struct nlattr *head, int len, int attrtype);
3784f69053bSJoe Perches size_t nla_strlcpy(char *dst, const struct nlattr *nla, size_t dstsize);
3792cf0c8b3SPhil Sutter char *nla_strdup(const struct nlattr *nla, gfp_t flags);
3804f69053bSJoe Perches int nla_memcpy(void *dest, const struct nlattr *src, int count);
3814f69053bSJoe Perches int nla_memcmp(const struct nlattr *nla, const void *data, size_t size);
3824f69053bSJoe Perches int nla_strcmp(const struct nlattr *nla, const char *str);
3834f69053bSJoe Perches struct nlattr *__nla_reserve(struct sk_buff *skb, int attrtype, int attrlen);
384089bf1a6SNicolas Dichtel struct nlattr *__nla_reserve_64bit(struct sk_buff *skb, int attrtype,
385089bf1a6SNicolas Dichtel 				   int attrlen, int padattr);
3864f69053bSJoe Perches void *__nla_reserve_nohdr(struct sk_buff *skb, int attrlen);
3874f69053bSJoe Perches struct nlattr *nla_reserve(struct sk_buff *skb, int attrtype, int attrlen);
388089bf1a6SNicolas Dichtel struct nlattr *nla_reserve_64bit(struct sk_buff *skb, int attrtype,
389089bf1a6SNicolas Dichtel 				 int attrlen, int padattr);
3904f69053bSJoe Perches void *nla_reserve_nohdr(struct sk_buff *skb, int attrlen);
3914f69053bSJoe Perches void __nla_put(struct sk_buff *skb, int attrtype, int attrlen,
392fe4944e5SThomas Graf 	       const void *data);
393089bf1a6SNicolas Dichtel void __nla_put_64bit(struct sk_buff *skb, int attrtype, int attrlen,
394089bf1a6SNicolas Dichtel 		     const void *data, int padattr);
3954f69053bSJoe Perches void __nla_put_nohdr(struct sk_buff *skb, int attrlen, const void *data);
3964f69053bSJoe Perches int nla_put(struct sk_buff *skb, int attrtype, int attrlen, const void *data);
397089bf1a6SNicolas Dichtel int nla_put_64bit(struct sk_buff *skb, int attrtype, int attrlen,
398089bf1a6SNicolas Dichtel 		  const void *data, int padattr);
3994f69053bSJoe Perches int nla_put_nohdr(struct sk_buff *skb, int attrlen, const void *data);
4004f69053bSJoe Perches int nla_append(struct sk_buff *skb, int attrlen, const void *data);
401bfa83a9eSThomas Graf 
402bfa83a9eSThomas Graf /**************************************************************************
403bfa83a9eSThomas Graf  * Netlink Messages
404bfa83a9eSThomas Graf  **************************************************************************/
405bfa83a9eSThomas Graf 
406bfa83a9eSThomas Graf /**
407bfa83a9eSThomas Graf  * nlmsg_msg_size - length of netlink message not including padding
408bfa83a9eSThomas Graf  * @payload: length of message payload
409bfa83a9eSThomas Graf  */
410bfa83a9eSThomas Graf static inline int nlmsg_msg_size(int payload)
411bfa83a9eSThomas Graf {
412bfa83a9eSThomas Graf 	return NLMSG_HDRLEN + payload;
413bfa83a9eSThomas Graf }
414bfa83a9eSThomas Graf 
415bfa83a9eSThomas Graf /**
416bfa83a9eSThomas Graf  * nlmsg_total_size - length of netlink message including padding
417bfa83a9eSThomas Graf  * @payload: length of message payload
418bfa83a9eSThomas Graf  */
419bfa83a9eSThomas Graf static inline int nlmsg_total_size(int payload)
420bfa83a9eSThomas Graf {
421bfa83a9eSThomas Graf 	return NLMSG_ALIGN(nlmsg_msg_size(payload));
422bfa83a9eSThomas Graf }
423bfa83a9eSThomas Graf 
424bfa83a9eSThomas Graf /**
425bfa83a9eSThomas Graf  * nlmsg_padlen - length of padding at the message's tail
426bfa83a9eSThomas Graf  * @payload: length of message payload
427bfa83a9eSThomas Graf  */
428bfa83a9eSThomas Graf static inline int nlmsg_padlen(int payload)
429bfa83a9eSThomas Graf {
430bfa83a9eSThomas Graf 	return nlmsg_total_size(payload) - nlmsg_msg_size(payload);
431bfa83a9eSThomas Graf }
432bfa83a9eSThomas Graf 
433bfa83a9eSThomas Graf /**
434bfa83a9eSThomas Graf  * nlmsg_data - head of message payload
43570f23fd6SJustin P. Mattock  * @nlh: netlink message header
436bfa83a9eSThomas Graf  */
437bfa83a9eSThomas Graf static inline void *nlmsg_data(const struct nlmsghdr *nlh)
438bfa83a9eSThomas Graf {
439bfa83a9eSThomas Graf 	return (unsigned char *) nlh + NLMSG_HDRLEN;
440bfa83a9eSThomas Graf }
441bfa83a9eSThomas Graf 
442bfa83a9eSThomas Graf /**
443bfa83a9eSThomas Graf  * nlmsg_len - length of message payload
444bfa83a9eSThomas Graf  * @nlh: netlink message header
445bfa83a9eSThomas Graf  */
446bfa83a9eSThomas Graf static inline int nlmsg_len(const struct nlmsghdr *nlh)
447bfa83a9eSThomas Graf {
448bfa83a9eSThomas Graf 	return nlh->nlmsg_len - NLMSG_HDRLEN;
449bfa83a9eSThomas Graf }
450bfa83a9eSThomas Graf 
451bfa83a9eSThomas Graf /**
452bfa83a9eSThomas Graf  * nlmsg_attrdata - head of attributes data
453bfa83a9eSThomas Graf  * @nlh: netlink message header
454bfa83a9eSThomas Graf  * @hdrlen: length of family specific header
455bfa83a9eSThomas Graf  */
456bfa83a9eSThomas Graf static inline struct nlattr *nlmsg_attrdata(const struct nlmsghdr *nlh,
457bfa83a9eSThomas Graf 					    int hdrlen)
458bfa83a9eSThomas Graf {
459bfa83a9eSThomas Graf 	unsigned char *data = nlmsg_data(nlh);
460bfa83a9eSThomas Graf 	return (struct nlattr *) (data + NLMSG_ALIGN(hdrlen));
461bfa83a9eSThomas Graf }
462bfa83a9eSThomas Graf 
463bfa83a9eSThomas Graf /**
464bfa83a9eSThomas Graf  * nlmsg_attrlen - length of attributes data
465bfa83a9eSThomas Graf  * @nlh: netlink message header
466bfa83a9eSThomas Graf  * @hdrlen: length of family specific header
467bfa83a9eSThomas Graf  */
468bfa83a9eSThomas Graf static inline int nlmsg_attrlen(const struct nlmsghdr *nlh, int hdrlen)
469bfa83a9eSThomas Graf {
470bfa83a9eSThomas Graf 	return nlmsg_len(nlh) - NLMSG_ALIGN(hdrlen);
471bfa83a9eSThomas Graf }
472bfa83a9eSThomas Graf 
473bfa83a9eSThomas Graf /**
474bfa83a9eSThomas Graf  * nlmsg_ok - check if the netlink message fits into the remaining bytes
475bfa83a9eSThomas Graf  * @nlh: netlink message header
476bfa83a9eSThomas Graf  * @remaining: number of bytes remaining in message stream
477bfa83a9eSThomas Graf  */
478bfa83a9eSThomas Graf static inline int nlmsg_ok(const struct nlmsghdr *nlh, int remaining)
479bfa83a9eSThomas Graf {
480619e803dSVegard Nossum 	return (remaining >= (int) sizeof(struct nlmsghdr) &&
481bfa83a9eSThomas Graf 		nlh->nlmsg_len >= sizeof(struct nlmsghdr) &&
482bfa83a9eSThomas Graf 		nlh->nlmsg_len <= remaining);
483bfa83a9eSThomas Graf }
484bfa83a9eSThomas Graf 
485bfa83a9eSThomas Graf /**
486bfa83a9eSThomas Graf  * nlmsg_next - next netlink message in message stream
487bfa83a9eSThomas Graf  * @nlh: netlink message header
488bfa83a9eSThomas Graf  * @remaining: number of bytes remaining in message stream
489bfa83a9eSThomas Graf  *
490bfa83a9eSThomas Graf  * Returns the next netlink message in the message stream and
491bfa83a9eSThomas Graf  * decrements remaining by the size of the current message.
492bfa83a9eSThomas Graf  */
4933654654fSJan Engelhardt static inline struct nlmsghdr *
4943654654fSJan Engelhardt nlmsg_next(const struct nlmsghdr *nlh, int *remaining)
495bfa83a9eSThomas Graf {
496bfa83a9eSThomas Graf 	int totlen = NLMSG_ALIGN(nlh->nlmsg_len);
497bfa83a9eSThomas Graf 
498bfa83a9eSThomas Graf 	*remaining -= totlen;
499bfa83a9eSThomas Graf 
500bfa83a9eSThomas Graf 	return (struct nlmsghdr *) ((unsigned char *) nlh + totlen);
501bfa83a9eSThomas Graf }
502bfa83a9eSThomas Graf 
503bfa83a9eSThomas Graf /**
504bfa83a9eSThomas Graf  * nlmsg_parse - parse attributes of a netlink message
505bfa83a9eSThomas Graf  * @nlh: netlink message header
506bfa83a9eSThomas Graf  * @hdrlen: length of family specific header
507bfa83a9eSThomas Graf  * @tb: destination array with maxtype+1 elements
508bfa83a9eSThomas Graf  * @maxtype: maximum attribute type to be expected
509bfa83a9eSThomas Graf  * @policy: validation policy
510fceb6435SJohannes Berg  * @extack: extended ACK report struct
511bfa83a9eSThomas Graf  *
512bfa83a9eSThomas Graf  * See nla_parse()
513bfa83a9eSThomas Graf  */
5143a6c2b41SPatrick McHardy static inline int nlmsg_parse(const struct nlmsghdr *nlh, int hdrlen,
515bfa83a9eSThomas Graf 			      struct nlattr *tb[], int maxtype,
516fceb6435SJohannes Berg 			      const struct nla_policy *policy,
517fceb6435SJohannes Berg 			      struct netlink_ext_ack *extack)
518bfa83a9eSThomas Graf {
519bfa83a9eSThomas Graf 	if (nlh->nlmsg_len < nlmsg_msg_size(hdrlen))
520bfa83a9eSThomas Graf 		return -EINVAL;
521bfa83a9eSThomas Graf 
522bfa83a9eSThomas Graf 	return nla_parse(tb, maxtype, nlmsg_attrdata(nlh, hdrlen),
523fceb6435SJohannes Berg 			 nlmsg_attrlen(nlh, hdrlen), policy, extack);
524bfa83a9eSThomas Graf }
525bfa83a9eSThomas Graf 
526bfa83a9eSThomas Graf /**
527bfa83a9eSThomas Graf  * nlmsg_find_attr - find a specific attribute in a netlink message
528bfa83a9eSThomas Graf  * @nlh: netlink message header
529bfa83a9eSThomas Graf  * @hdrlen: length of familiy specific header
530bfa83a9eSThomas Graf  * @attrtype: type of attribute to look for
531bfa83a9eSThomas Graf  *
532bfa83a9eSThomas Graf  * Returns the first attribute which matches the specified type.
533bfa83a9eSThomas Graf  */
5346b8c92baSNelson Elhage static inline struct nlattr *nlmsg_find_attr(const struct nlmsghdr *nlh,
535bfa83a9eSThomas Graf 					     int hdrlen, int attrtype)
536bfa83a9eSThomas Graf {
537bfa83a9eSThomas Graf 	return nla_find(nlmsg_attrdata(nlh, hdrlen),
538bfa83a9eSThomas Graf 			nlmsg_attrlen(nlh, hdrlen), attrtype);
539bfa83a9eSThomas Graf }
540bfa83a9eSThomas Graf 
541bfa83a9eSThomas Graf /**
542bfa83a9eSThomas Graf  * nlmsg_validate - validate a netlink message including attributes
543bfa83a9eSThomas Graf  * @nlh: netlinket message header
544bfa83a9eSThomas Graf  * @hdrlen: length of familiy specific header
545bfa83a9eSThomas Graf  * @maxtype: maximum attribute type to be expected
546bfa83a9eSThomas Graf  * @policy: validation policy
547fceb6435SJohannes Berg  * @extack: extended ACK report struct
548bfa83a9eSThomas Graf  */
5493654654fSJan Engelhardt static inline int nlmsg_validate(const struct nlmsghdr *nlh,
5503654654fSJan Engelhardt 				 int hdrlen, int maxtype,
551fceb6435SJohannes Berg 				 const struct nla_policy *policy,
552fceb6435SJohannes Berg 				 struct netlink_ext_ack *extack)
553bfa83a9eSThomas Graf {
554bfa83a9eSThomas Graf 	if (nlh->nlmsg_len < nlmsg_msg_size(hdrlen))
555bfa83a9eSThomas Graf 		return -EINVAL;
556bfa83a9eSThomas Graf 
557bfa83a9eSThomas Graf 	return nla_validate(nlmsg_attrdata(nlh, hdrlen),
558fceb6435SJohannes Berg 			    nlmsg_attrlen(nlh, hdrlen), maxtype, policy,
559fceb6435SJohannes Berg 			    extack);
560bfa83a9eSThomas Graf }
561bfa83a9eSThomas Graf 
562bfa83a9eSThomas Graf /**
56397676b6bSThomas Graf  * nlmsg_report - need to report back to application?
56497676b6bSThomas Graf  * @nlh: netlink message header
56597676b6bSThomas Graf  *
56697676b6bSThomas Graf  * Returns 1 if a report back to the application is requested.
56797676b6bSThomas Graf  */
5683a6c2b41SPatrick McHardy static inline int nlmsg_report(const struct nlmsghdr *nlh)
56997676b6bSThomas Graf {
57097676b6bSThomas Graf 	return !!(nlh->nlmsg_flags & NLM_F_ECHO);
57197676b6bSThomas Graf }
57297676b6bSThomas Graf 
57397676b6bSThomas Graf /**
574bfa83a9eSThomas Graf  * nlmsg_for_each_attr - iterate over a stream of attributes
575bfa83a9eSThomas Graf  * @pos: loop counter, set to current attribute
576bfa83a9eSThomas Graf  * @nlh: netlink message header
577bfa83a9eSThomas Graf  * @hdrlen: length of familiy specific header
578bfa83a9eSThomas Graf  * @rem: initialized to len, holds bytes currently remaining in stream
579bfa83a9eSThomas Graf  */
580bfa83a9eSThomas Graf #define nlmsg_for_each_attr(pos, nlh, hdrlen, rem) \
581bfa83a9eSThomas Graf 	nla_for_each_attr(pos, nlmsg_attrdata(nlh, hdrlen), \
582bfa83a9eSThomas Graf 			  nlmsg_attrlen(nlh, hdrlen), rem)
583bfa83a9eSThomas Graf 
584bfa83a9eSThomas Graf /**
585bfa83a9eSThomas Graf  * nlmsg_put - Add a new netlink message to an skb
586bfa83a9eSThomas Graf  * @skb: socket buffer to store message in
5872c6ba4b1SNicolas Dichtel  * @portid: netlink PORTID of requesting application
588bfa83a9eSThomas Graf  * @seq: sequence number of message
589bfa83a9eSThomas Graf  * @type: message type
590bfa83a9eSThomas Graf  * @payload: length of message payload
591bfa83a9eSThomas Graf  * @flags: message flags
592bfa83a9eSThomas Graf  *
593bfa83a9eSThomas Graf  * Returns NULL if the tailroom of the skb is insufficient to store
594bfa83a9eSThomas Graf  * the message header and payload.
595bfa83a9eSThomas Graf  */
59615e47304SEric W. Biederman static inline struct nlmsghdr *nlmsg_put(struct sk_buff *skb, u32 portid, u32 seq,
597bfa83a9eSThomas Graf 					 int type, int payload, int flags)
598bfa83a9eSThomas Graf {
599bfa83a9eSThomas Graf 	if (unlikely(skb_tailroom(skb) < nlmsg_total_size(payload)))
600bfa83a9eSThomas Graf 		return NULL;
601bfa83a9eSThomas Graf 
60215e47304SEric W. Biederman 	return __nlmsg_put(skb, portid, seq, type, payload, flags);
603bfa83a9eSThomas Graf }
604bfa83a9eSThomas Graf 
605bfa83a9eSThomas Graf /**
606bfa83a9eSThomas Graf  * nlmsg_put_answer - Add a new callback based netlink message to an skb
607bfa83a9eSThomas Graf  * @skb: socket buffer to store message in
608bfa83a9eSThomas Graf  * @cb: netlink callback
609bfa83a9eSThomas Graf  * @type: message type
610bfa83a9eSThomas Graf  * @payload: length of message payload
611bfa83a9eSThomas Graf  * @flags: message flags
612bfa83a9eSThomas Graf  *
613bfa83a9eSThomas Graf  * Returns NULL if the tailroom of the skb is insufficient to store
614bfa83a9eSThomas Graf  * the message header and payload.
615bfa83a9eSThomas Graf  */
616bfa83a9eSThomas Graf static inline struct nlmsghdr *nlmsg_put_answer(struct sk_buff *skb,
617bfa83a9eSThomas Graf 						struct netlink_callback *cb,
618bfa83a9eSThomas Graf 						int type, int payload,
619bfa83a9eSThomas Graf 						int flags)
620bfa83a9eSThomas Graf {
62115e47304SEric W. Biederman 	return nlmsg_put(skb, NETLINK_CB(cb->skb).portid, cb->nlh->nlmsg_seq,
622bfa83a9eSThomas Graf 			 type, payload, flags);
623bfa83a9eSThomas Graf }
624bfa83a9eSThomas Graf 
625bfa83a9eSThomas Graf /**
626bfa83a9eSThomas Graf  * nlmsg_new - Allocate a new netlink message
627339bf98fSThomas Graf  * @payload: size of the message payload
628fe4944e5SThomas Graf  * @flags: the type of memory to allocate.
629bfa83a9eSThomas Graf  *
630339bf98fSThomas Graf  * Use NLMSG_DEFAULT_SIZE if the size of the payload isn't known
631339bf98fSThomas Graf  * and a good default is needed.
632bfa83a9eSThomas Graf  */
633339bf98fSThomas Graf static inline struct sk_buff *nlmsg_new(size_t payload, gfp_t flags)
634bfa83a9eSThomas Graf {
635339bf98fSThomas Graf 	return alloc_skb(nlmsg_total_size(payload), flags);
636bfa83a9eSThomas Graf }
637bfa83a9eSThomas Graf 
638bfa83a9eSThomas Graf /**
639bfa83a9eSThomas Graf  * nlmsg_end - Finalize a netlink message
640bfa83a9eSThomas Graf  * @skb: socket buffer the message is stored in
641bfa83a9eSThomas Graf  * @nlh: netlink message header
642bfa83a9eSThomas Graf  *
643bfa83a9eSThomas Graf  * Corrects the netlink message header to include the appeneded
644bfa83a9eSThomas Graf  * attributes. Only necessary if attributes have been added to
645bfa83a9eSThomas Graf  * the message.
646bfa83a9eSThomas Graf  */
647053c095aSJohannes Berg static inline void nlmsg_end(struct sk_buff *skb, struct nlmsghdr *nlh)
648bfa83a9eSThomas Graf {
64927a884dcSArnaldo Carvalho de Melo 	nlh->nlmsg_len = skb_tail_pointer(skb) - (unsigned char *)nlh;
650bfa83a9eSThomas Graf }
651bfa83a9eSThomas Graf 
652bfa83a9eSThomas Graf /**
653fe4944e5SThomas Graf  * nlmsg_get_pos - return current position in netlink message
654fe4944e5SThomas Graf  * @skb: socket buffer the message is stored in
655fe4944e5SThomas Graf  *
656fe4944e5SThomas Graf  * Returns a pointer to the current tail of the message.
657fe4944e5SThomas Graf  */
658fe4944e5SThomas Graf static inline void *nlmsg_get_pos(struct sk_buff *skb)
659fe4944e5SThomas Graf {
66027a884dcSArnaldo Carvalho de Melo 	return skb_tail_pointer(skb);
661fe4944e5SThomas Graf }
662fe4944e5SThomas Graf 
663fe4944e5SThomas Graf /**
664fe4944e5SThomas Graf  * nlmsg_trim - Trim message to a mark
665fe4944e5SThomas Graf  * @skb: socket buffer the message is stored in
666fe4944e5SThomas Graf  * @mark: mark to trim to
667fe4944e5SThomas Graf  *
668bc3ed28cSThomas Graf  * Trims the message to the provided mark.
669fe4944e5SThomas Graf  */
670bc3ed28cSThomas Graf static inline void nlmsg_trim(struct sk_buff *skb, const void *mark)
671fe4944e5SThomas Graf {
672149118d8SThomas Graf 	if (mark) {
673149118d8SThomas Graf 		WARN_ON((unsigned char *) mark < skb->data);
674fe4944e5SThomas Graf 		skb_trim(skb, (unsigned char *) mark - skb->data);
675fe4944e5SThomas Graf 	}
676149118d8SThomas Graf }
677fe4944e5SThomas Graf 
678fe4944e5SThomas Graf /**
679bfa83a9eSThomas Graf  * nlmsg_cancel - Cancel construction of a netlink message
680bfa83a9eSThomas Graf  * @skb: socket buffer the message is stored in
681bfa83a9eSThomas Graf  * @nlh: netlink message header
682bfa83a9eSThomas Graf  *
683bfa83a9eSThomas Graf  * Removes the complete netlink message including all
684bc3ed28cSThomas Graf  * attributes from the socket buffer again.
685bfa83a9eSThomas Graf  */
686bc3ed28cSThomas Graf static inline void nlmsg_cancel(struct sk_buff *skb, struct nlmsghdr *nlh)
687bfa83a9eSThomas Graf {
688bc3ed28cSThomas Graf 	nlmsg_trim(skb, nlh);
689bfa83a9eSThomas Graf }
690bfa83a9eSThomas Graf 
691bfa83a9eSThomas Graf /**
692bfa83a9eSThomas Graf  * nlmsg_free - free a netlink message
693bfa83a9eSThomas Graf  * @skb: socket buffer of netlink message
694bfa83a9eSThomas Graf  */
695bfa83a9eSThomas Graf static inline void nlmsg_free(struct sk_buff *skb)
696bfa83a9eSThomas Graf {
697bfa83a9eSThomas Graf 	kfree_skb(skb);
698bfa83a9eSThomas Graf }
699bfa83a9eSThomas Graf 
700bfa83a9eSThomas Graf /**
701bfa83a9eSThomas Graf  * nlmsg_multicast - multicast a netlink message
702bfa83a9eSThomas Graf  * @sk: netlink socket to spread messages to
703bfa83a9eSThomas Graf  * @skb: netlink message as socket buffer
70415e47304SEric W. Biederman  * @portid: own netlink portid to avoid sending to yourself
705bfa83a9eSThomas Graf  * @group: multicast group id
706d387f6adSThomas Graf  * @flags: allocation flags
707bfa83a9eSThomas Graf  */
708bfa83a9eSThomas Graf static inline int nlmsg_multicast(struct sock *sk, struct sk_buff *skb,
70915e47304SEric W. Biederman 				  u32 portid, unsigned int group, gfp_t flags)
710bfa83a9eSThomas Graf {
711bfa83a9eSThomas Graf 	int err;
712bfa83a9eSThomas Graf 
713bfa83a9eSThomas Graf 	NETLINK_CB(skb).dst_group = group;
714bfa83a9eSThomas Graf 
71515e47304SEric W. Biederman 	err = netlink_broadcast(sk, skb, portid, group, flags);
716bfa83a9eSThomas Graf 	if (err > 0)
717bfa83a9eSThomas Graf 		err = 0;
718bfa83a9eSThomas Graf 
719bfa83a9eSThomas Graf 	return err;
720bfa83a9eSThomas Graf }
721bfa83a9eSThomas Graf 
722bfa83a9eSThomas Graf /**
723bfa83a9eSThomas Graf  * nlmsg_unicast - unicast a netlink message
724bfa83a9eSThomas Graf  * @sk: netlink socket to spread message to
725bfa83a9eSThomas Graf  * @skb: netlink message as socket buffer
72615e47304SEric W. Biederman  * @portid: netlink portid of the destination socket
727bfa83a9eSThomas Graf  */
72815e47304SEric W. Biederman static inline int nlmsg_unicast(struct sock *sk, struct sk_buff *skb, u32 portid)
729bfa83a9eSThomas Graf {
730bfa83a9eSThomas Graf 	int err;
731bfa83a9eSThomas Graf 
73215e47304SEric W. Biederman 	err = netlink_unicast(sk, skb, portid, MSG_DONTWAIT);
733bfa83a9eSThomas Graf 	if (err > 0)
734bfa83a9eSThomas Graf 		err = 0;
735bfa83a9eSThomas Graf 
736bfa83a9eSThomas Graf 	return err;
737bfa83a9eSThomas Graf }
738bfa83a9eSThomas Graf 
739bfa83a9eSThomas Graf /**
740bfa83a9eSThomas Graf  * nlmsg_for_each_msg - iterate over a stream of messages
741bfa83a9eSThomas Graf  * @pos: loop counter, set to current message
742bfa83a9eSThomas Graf  * @head: head of message stream
743bfa83a9eSThomas Graf  * @len: length of message stream
744bfa83a9eSThomas Graf  * @rem: initialized to len, holds bytes currently remaining in stream
745bfa83a9eSThomas Graf  */
746bfa83a9eSThomas Graf #define nlmsg_for_each_msg(pos, head, len, rem) \
747bfa83a9eSThomas Graf 	for (pos = head, rem = len; \
748bfa83a9eSThomas Graf 	     nlmsg_ok(pos, rem); \
749bfa83a9eSThomas Graf 	     pos = nlmsg_next(pos, &(rem)))
750bfa83a9eSThomas Graf 
751670dc283SJohannes Berg /**
752670dc283SJohannes Berg  * nl_dump_check_consistent - check if sequence is consistent and advertise if not
753670dc283SJohannes Berg  * @cb: netlink callback structure that stores the sequence number
754670dc283SJohannes Berg  * @nlh: netlink message header to write the flag to
755670dc283SJohannes Berg  *
756670dc283SJohannes Berg  * This function checks if the sequence (generation) number changed during dump
757670dc283SJohannes Berg  * and if it did, advertises it in the netlink message header.
758670dc283SJohannes Berg  *
759670dc283SJohannes Berg  * The correct way to use it is to set cb->seq to the generation counter when
760670dc283SJohannes Berg  * all locks for dumping have been acquired, and then call this function for
761670dc283SJohannes Berg  * each message that is generated.
762670dc283SJohannes Berg  *
763670dc283SJohannes Berg  * Note that due to initialisation concerns, 0 is an invalid sequence number
764670dc283SJohannes Berg  * and must not be used by code that uses this functionality.
765670dc283SJohannes Berg  */
766670dc283SJohannes Berg static inline void
767670dc283SJohannes Berg nl_dump_check_consistent(struct netlink_callback *cb,
768670dc283SJohannes Berg 			 struct nlmsghdr *nlh)
769670dc283SJohannes Berg {
770670dc283SJohannes Berg 	if (cb->prev_seq && cb->seq != cb->prev_seq)
771670dc283SJohannes Berg 		nlh->nlmsg_flags |= NLM_F_DUMP_INTR;
772670dc283SJohannes Berg 	cb->prev_seq = cb->seq;
773670dc283SJohannes Berg }
774670dc283SJohannes Berg 
775bfa83a9eSThomas Graf /**************************************************************************
776bfa83a9eSThomas Graf  * Netlink Attributes
777bfa83a9eSThomas Graf  **************************************************************************/
778bfa83a9eSThomas Graf 
779bfa83a9eSThomas Graf /**
780bfa83a9eSThomas Graf  * nla_attr_size - length of attribute not including padding
781bfa83a9eSThomas Graf  * @payload: length of payload
782bfa83a9eSThomas Graf  */
783bfa83a9eSThomas Graf static inline int nla_attr_size(int payload)
784bfa83a9eSThomas Graf {
785bfa83a9eSThomas Graf 	return NLA_HDRLEN + payload;
786bfa83a9eSThomas Graf }
787bfa83a9eSThomas Graf 
788bfa83a9eSThomas Graf /**
789bfa83a9eSThomas Graf  * nla_total_size - total length of attribute including padding
790bfa83a9eSThomas Graf  * @payload: length of payload
791bfa83a9eSThomas Graf  */
792bfa83a9eSThomas Graf static inline int nla_total_size(int payload)
793bfa83a9eSThomas Graf {
794bfa83a9eSThomas Graf 	return NLA_ALIGN(nla_attr_size(payload));
795bfa83a9eSThomas Graf }
796bfa83a9eSThomas Graf 
797bfa83a9eSThomas Graf /**
798bfa83a9eSThomas Graf  * nla_padlen - length of padding at the tail of attribute
799bfa83a9eSThomas Graf  * @payload: length of payload
800bfa83a9eSThomas Graf  */
801bfa83a9eSThomas Graf static inline int nla_padlen(int payload)
802bfa83a9eSThomas Graf {
803bfa83a9eSThomas Graf 	return nla_total_size(payload) - nla_attr_size(payload);
804bfa83a9eSThomas Graf }
805bfa83a9eSThomas Graf 
806bfa83a9eSThomas Graf /**
8078f4c1f9bSThomas Graf  * nla_type - attribute type
8088f4c1f9bSThomas Graf  * @nla: netlink attribute
8098f4c1f9bSThomas Graf  */
8108f4c1f9bSThomas Graf static inline int nla_type(const struct nlattr *nla)
8118f4c1f9bSThomas Graf {
8128f4c1f9bSThomas Graf 	return nla->nla_type & NLA_TYPE_MASK;
8138f4c1f9bSThomas Graf }
8148f4c1f9bSThomas Graf 
8158f4c1f9bSThomas Graf /**
816bfa83a9eSThomas Graf  * nla_data - head of payload
817bfa83a9eSThomas Graf  * @nla: netlink attribute
818bfa83a9eSThomas Graf  */
819bfa83a9eSThomas Graf static inline void *nla_data(const struct nlattr *nla)
820bfa83a9eSThomas Graf {
821bfa83a9eSThomas Graf 	return (char *) nla + NLA_HDRLEN;
822bfa83a9eSThomas Graf }
823bfa83a9eSThomas Graf 
824bfa83a9eSThomas Graf /**
825bfa83a9eSThomas Graf  * nla_len - length of payload
826bfa83a9eSThomas Graf  * @nla: netlink attribute
827bfa83a9eSThomas Graf  */
828bfa83a9eSThomas Graf static inline int nla_len(const struct nlattr *nla)
829bfa83a9eSThomas Graf {
830bfa83a9eSThomas Graf 	return nla->nla_len - NLA_HDRLEN;
831bfa83a9eSThomas Graf }
832bfa83a9eSThomas Graf 
833bfa83a9eSThomas Graf /**
834bfa83a9eSThomas Graf  * nla_ok - check if the netlink attribute fits into the remaining bytes
835bfa83a9eSThomas Graf  * @nla: netlink attribute
836bfa83a9eSThomas Graf  * @remaining: number of bytes remaining in attribute stream
837bfa83a9eSThomas Graf  */
838bfa83a9eSThomas Graf static inline int nla_ok(const struct nlattr *nla, int remaining)
839bfa83a9eSThomas Graf {
8403e1ed981SAlexey Dobriyan 	return remaining >= (int) sizeof(*nla) &&
8413e1ed981SAlexey Dobriyan 	       nla->nla_len >= sizeof(*nla) &&
842bfa83a9eSThomas Graf 	       nla->nla_len <= remaining;
843bfa83a9eSThomas Graf }
844bfa83a9eSThomas Graf 
845bfa83a9eSThomas Graf /**
846d1ec3b77SPierre Ynard  * nla_next - next netlink attribute in attribute stream
847bfa83a9eSThomas Graf  * @nla: netlink attribute
848bfa83a9eSThomas Graf  * @remaining: number of bytes remaining in attribute stream
849bfa83a9eSThomas Graf  *
850bfa83a9eSThomas Graf  * Returns the next netlink attribute in the attribute stream and
851bfa83a9eSThomas Graf  * decrements remaining by the size of the current attribute.
852bfa83a9eSThomas Graf  */
853bfa83a9eSThomas Graf static inline struct nlattr *nla_next(const struct nlattr *nla, int *remaining)
854bfa83a9eSThomas Graf {
8553b2c75d3SAlexey Dobriyan 	unsigned int totlen = NLA_ALIGN(nla->nla_len);
856bfa83a9eSThomas Graf 
857bfa83a9eSThomas Graf 	*remaining -= totlen;
858bfa83a9eSThomas Graf 	return (struct nlattr *) ((char *) nla + totlen);
859bfa83a9eSThomas Graf }
860bfa83a9eSThomas Graf 
861bfa83a9eSThomas Graf /**
862fe4944e5SThomas Graf  * nla_find_nested - find attribute in a set of nested attributes
863fe4944e5SThomas Graf  * @nla: attribute containing the nested attributes
864fe4944e5SThomas Graf  * @attrtype: type of attribute to look for
865fe4944e5SThomas Graf  *
866fe4944e5SThomas Graf  * Returns the first attribute which matches the specified type.
867fe4944e5SThomas Graf  */
8683654654fSJan Engelhardt static inline struct nlattr *
8693654654fSJan Engelhardt nla_find_nested(const struct nlattr *nla, int attrtype)
870fe4944e5SThomas Graf {
871fe4944e5SThomas Graf 	return nla_find(nla_data(nla), nla_len(nla), attrtype);
872fe4944e5SThomas Graf }
873fe4944e5SThomas Graf 
874fe4944e5SThomas Graf /**
875bfa83a9eSThomas Graf  * nla_parse_nested - parse nested attributes
876bfa83a9eSThomas Graf  * @tb: destination array with maxtype+1 elements
877bfa83a9eSThomas Graf  * @maxtype: maximum attribute type to be expected
878bfa83a9eSThomas Graf  * @nla: attribute containing the nested attributes
879bfa83a9eSThomas Graf  * @policy: validation policy
880fceb6435SJohannes Berg  * @extack: extended ACK report struct
881bfa83a9eSThomas Graf  *
882bfa83a9eSThomas Graf  * See nla_parse()
883bfa83a9eSThomas Graf  */
884bfa83a9eSThomas Graf static inline int nla_parse_nested(struct nlattr *tb[], int maxtype,
885b057efd4SPatrick McHardy 				   const struct nlattr *nla,
886fceb6435SJohannes Berg 				   const struct nla_policy *policy,
887fceb6435SJohannes Berg 				   struct netlink_ext_ack *extack)
888bfa83a9eSThomas Graf {
889fceb6435SJohannes Berg 	return nla_parse(tb, maxtype, nla_data(nla), nla_len(nla), policy,
890fceb6435SJohannes Berg 			 extack);
891bfa83a9eSThomas Graf }
8921092cb21SPatrick McHardy 
8931092cb21SPatrick McHardy /**
894d1ec3b77SPierre Ynard  * nla_put_u8 - Add a u8 netlink attribute to a socket buffer
895bfa83a9eSThomas Graf  * @skb: socket buffer to add attribute to
896bfa83a9eSThomas Graf  * @attrtype: attribute type
897bfa83a9eSThomas Graf  * @value: numeric value
898bfa83a9eSThomas Graf  */
899bfa83a9eSThomas Graf static inline int nla_put_u8(struct sk_buff *skb, int attrtype, u8 value)
900bfa83a9eSThomas Graf {
901b4391db4SArnd Bergmann 	/* temporary variables to work around GCC PR81715 with asan-stack=1 */
902b4391db4SArnd Bergmann 	u8 tmp = value;
903b4391db4SArnd Bergmann 
904b4391db4SArnd Bergmann 	return nla_put(skb, attrtype, sizeof(u8), &tmp);
905bfa83a9eSThomas Graf }
906bfa83a9eSThomas Graf 
907bfa83a9eSThomas Graf /**
908bfa83a9eSThomas Graf  * nla_put_u16 - Add a u16 netlink attribute to a socket buffer
909bfa83a9eSThomas Graf  * @skb: socket buffer to add attribute to
910bfa83a9eSThomas Graf  * @attrtype: attribute type
911bfa83a9eSThomas Graf  * @value: numeric value
912bfa83a9eSThomas Graf  */
913bfa83a9eSThomas Graf static inline int nla_put_u16(struct sk_buff *skb, int attrtype, u16 value)
914bfa83a9eSThomas Graf {
915b4391db4SArnd Bergmann 	u16 tmp = value;
916b4391db4SArnd Bergmann 
917b4391db4SArnd Bergmann 	return nla_put(skb, attrtype, sizeof(u16), &tmp);
918bfa83a9eSThomas Graf }
919bfa83a9eSThomas Graf 
920bfa83a9eSThomas Graf /**
921569a8fc3SDavid S. Miller  * nla_put_be16 - Add a __be16 netlink attribute to a socket buffer
922569a8fc3SDavid S. Miller  * @skb: socket buffer to add attribute to
923569a8fc3SDavid S. Miller  * @attrtype: attribute type
924569a8fc3SDavid S. Miller  * @value: numeric value
925569a8fc3SDavid S. Miller  */
926569a8fc3SDavid S. Miller static inline int nla_put_be16(struct sk_buff *skb, int attrtype, __be16 value)
927569a8fc3SDavid S. Miller {
928b4391db4SArnd Bergmann 	__be16 tmp = value;
929b4391db4SArnd Bergmann 
930b4391db4SArnd Bergmann 	return nla_put(skb, attrtype, sizeof(__be16), &tmp);
931569a8fc3SDavid S. Miller }
932569a8fc3SDavid S. Miller 
933569a8fc3SDavid S. Miller /**
9346c1dd3b6SDavid S. Miller  * nla_put_net16 - Add 16-bit network byte order netlink attribute to a socket buffer
9356c1dd3b6SDavid S. Miller  * @skb: socket buffer to add attribute to
9366c1dd3b6SDavid S. Miller  * @attrtype: attribute type
9376c1dd3b6SDavid S. Miller  * @value: numeric value
9386c1dd3b6SDavid S. Miller  */
9396c1dd3b6SDavid S. Miller static inline int nla_put_net16(struct sk_buff *skb, int attrtype, __be16 value)
9406c1dd3b6SDavid S. Miller {
941b4391db4SArnd Bergmann 	__be16 tmp = value;
942b4391db4SArnd Bergmann 
943b4391db4SArnd Bergmann 	return nla_put_be16(skb, attrtype | NLA_F_NET_BYTEORDER, tmp);
9446c1dd3b6SDavid S. Miller }
9456c1dd3b6SDavid S. Miller 
9466c1dd3b6SDavid S. Miller /**
94724c410dcSDavid S. Miller  * nla_put_le16 - Add a __le16 netlink attribute to a socket buffer
94824c410dcSDavid S. Miller  * @skb: socket buffer to add attribute to
94924c410dcSDavid S. Miller  * @attrtype: attribute type
95024c410dcSDavid S. Miller  * @value: numeric value
95124c410dcSDavid S. Miller  */
95224c410dcSDavid S. Miller static inline int nla_put_le16(struct sk_buff *skb, int attrtype, __le16 value)
95324c410dcSDavid S. Miller {
954b4391db4SArnd Bergmann 	__le16 tmp = value;
955b4391db4SArnd Bergmann 
956b4391db4SArnd Bergmann 	return nla_put(skb, attrtype, sizeof(__le16), &tmp);
95724c410dcSDavid S. Miller }
95824c410dcSDavid S. Miller 
95924c410dcSDavid S. Miller /**
960bfa83a9eSThomas Graf  * nla_put_u32 - Add a u32 netlink attribute to a socket buffer
961bfa83a9eSThomas Graf  * @skb: socket buffer to add attribute to
962bfa83a9eSThomas Graf  * @attrtype: attribute type
963bfa83a9eSThomas Graf  * @value: numeric value
964bfa83a9eSThomas Graf  */
965bfa83a9eSThomas Graf static inline int nla_put_u32(struct sk_buff *skb, int attrtype, u32 value)
966bfa83a9eSThomas Graf {
967b4391db4SArnd Bergmann 	u32 tmp = value;
968b4391db4SArnd Bergmann 
969b4391db4SArnd Bergmann 	return nla_put(skb, attrtype, sizeof(u32), &tmp);
970bfa83a9eSThomas Graf }
971bfa83a9eSThomas Graf 
972bfa83a9eSThomas Graf /**
973569a8fc3SDavid S. Miller  * nla_put_be32 - Add a __be32 netlink attribute to a socket buffer
974569a8fc3SDavid S. Miller  * @skb: socket buffer to add attribute to
975569a8fc3SDavid S. Miller  * @attrtype: attribute type
976569a8fc3SDavid S. Miller  * @value: numeric value
977569a8fc3SDavid S. Miller  */
978569a8fc3SDavid S. Miller static inline int nla_put_be32(struct sk_buff *skb, int attrtype, __be32 value)
979569a8fc3SDavid S. Miller {
980b4391db4SArnd Bergmann 	__be32 tmp = value;
981b4391db4SArnd Bergmann 
982b4391db4SArnd Bergmann 	return nla_put(skb, attrtype, sizeof(__be32), &tmp);
983569a8fc3SDavid S. Miller }
984569a8fc3SDavid S. Miller 
985569a8fc3SDavid S. Miller /**
9866c1dd3b6SDavid S. Miller  * nla_put_net32 - Add 32-bit network byte order netlink attribute to a socket buffer
9876c1dd3b6SDavid S. Miller  * @skb: socket buffer to add attribute to
9886c1dd3b6SDavid S. Miller  * @attrtype: attribute type
9896c1dd3b6SDavid S. Miller  * @value: numeric value
9906c1dd3b6SDavid S. Miller  */
9916c1dd3b6SDavid S. Miller static inline int nla_put_net32(struct sk_buff *skb, int attrtype, __be32 value)
9926c1dd3b6SDavid S. Miller {
993b4391db4SArnd Bergmann 	__be32 tmp = value;
994b4391db4SArnd Bergmann 
995b4391db4SArnd Bergmann 	return nla_put_be32(skb, attrtype | NLA_F_NET_BYTEORDER, tmp);
9966c1dd3b6SDavid S. Miller }
9976c1dd3b6SDavid S. Miller 
9986c1dd3b6SDavid S. Miller /**
99924c410dcSDavid S. Miller  * nla_put_le32 - Add a __le32 netlink attribute to a socket buffer
100024c410dcSDavid S. Miller  * @skb: socket buffer to add attribute to
100124c410dcSDavid S. Miller  * @attrtype: attribute type
100224c410dcSDavid S. Miller  * @value: numeric value
100324c410dcSDavid S. Miller  */
100424c410dcSDavid S. Miller static inline int nla_put_le32(struct sk_buff *skb, int attrtype, __le32 value)
100524c410dcSDavid S. Miller {
1006b4391db4SArnd Bergmann 	__le32 tmp = value;
1007b4391db4SArnd Bergmann 
1008b4391db4SArnd Bergmann 	return nla_put(skb, attrtype, sizeof(__le32), &tmp);
100924c410dcSDavid S. Miller }
101024c410dcSDavid S. Miller 
101124c410dcSDavid S. Miller /**
101273520786SNicolas Dichtel  * nla_put_u64_64bit - Add a u64 netlink attribute to a skb and align it
101373520786SNicolas Dichtel  * @skb: socket buffer to add attribute to
101473520786SNicolas Dichtel  * @attrtype: attribute type
101573520786SNicolas Dichtel  * @value: numeric value
101673520786SNicolas Dichtel  * @padattr: attribute type for the padding
101773520786SNicolas Dichtel  */
101873520786SNicolas Dichtel static inline int nla_put_u64_64bit(struct sk_buff *skb, int attrtype,
101973520786SNicolas Dichtel 				    u64 value, int padattr)
102073520786SNicolas Dichtel {
1021b4391db4SArnd Bergmann 	u64 tmp = value;
1022b4391db4SArnd Bergmann 
1023b4391db4SArnd Bergmann 	return nla_put_64bit(skb, attrtype, sizeof(u64), &tmp, padattr);
102473520786SNicolas Dichtel }
102573520786SNicolas Dichtel 
102673520786SNicolas Dichtel /**
1027b46f6dedSNicolas Dichtel  * nla_put_be64 - Add a __be64 netlink attribute to a socket buffer and align it
1028569a8fc3SDavid S. Miller  * @skb: socket buffer to add attribute to
1029569a8fc3SDavid S. Miller  * @attrtype: attribute type
1030569a8fc3SDavid S. Miller  * @value: numeric value
1031b46f6dedSNicolas Dichtel  * @padattr: attribute type for the padding
1032569a8fc3SDavid S. Miller  */
1033b46f6dedSNicolas Dichtel static inline int nla_put_be64(struct sk_buff *skb, int attrtype, __be64 value,
1034b46f6dedSNicolas Dichtel 			       int padattr)
1035b46f6dedSNicolas Dichtel {
1036b4391db4SArnd Bergmann 	__be64 tmp = value;
1037b4391db4SArnd Bergmann 
1038b4391db4SArnd Bergmann 	return nla_put_64bit(skb, attrtype, sizeof(__be64), &tmp, padattr);
1039b46f6dedSNicolas Dichtel }
1040b46f6dedSNicolas Dichtel 
1041569a8fc3SDavid S. Miller /**
1042e9bbe898SNicolas Dichtel  * nla_put_net64 - Add 64-bit network byte order nlattr to a skb and align it
10436c1dd3b6SDavid S. Miller  * @skb: socket buffer to add attribute to
10446c1dd3b6SDavid S. Miller  * @attrtype: attribute type
10456c1dd3b6SDavid S. Miller  * @value: numeric value
1046e9bbe898SNicolas Dichtel  * @padattr: attribute type for the padding
10476c1dd3b6SDavid S. Miller  */
1048e9bbe898SNicolas Dichtel static inline int nla_put_net64(struct sk_buff *skb, int attrtype, __be64 value,
1049e9bbe898SNicolas Dichtel 				int padattr)
10506c1dd3b6SDavid S. Miller {
1051b4391db4SArnd Bergmann 	__be64 tmp = value;
1052b4391db4SArnd Bergmann 
1053b4391db4SArnd Bergmann 	return nla_put_be64(skb, attrtype | NLA_F_NET_BYTEORDER, tmp,
1054e9bbe898SNicolas Dichtel 			    padattr);
10556c1dd3b6SDavid S. Miller }
10566c1dd3b6SDavid S. Miller 
10576c1dd3b6SDavid S. Miller /**
1058e7479122SNicolas Dichtel  * nla_put_le64 - Add a __le64 netlink attribute to a socket buffer and align it
105924c410dcSDavid S. Miller  * @skb: socket buffer to add attribute to
106024c410dcSDavid S. Miller  * @attrtype: attribute type
106124c410dcSDavid S. Miller  * @value: numeric value
1062e7479122SNicolas Dichtel  * @padattr: attribute type for the padding
106324c410dcSDavid S. Miller  */
1064e7479122SNicolas Dichtel static inline int nla_put_le64(struct sk_buff *skb, int attrtype, __le64 value,
1065e7479122SNicolas Dichtel 			       int padattr)
106624c410dcSDavid S. Miller {
1067b4391db4SArnd Bergmann 	__le64 tmp = value;
1068b4391db4SArnd Bergmann 
1069b4391db4SArnd Bergmann 	return nla_put_64bit(skb, attrtype, sizeof(__le64), &tmp, padattr);
107024c410dcSDavid S. Miller }
107124c410dcSDavid S. Miller 
107224c410dcSDavid S. Miller /**
10734778e0beSJiri Pirko  * nla_put_s8 - Add a s8 netlink attribute to a socket buffer
10744778e0beSJiri Pirko  * @skb: socket buffer to add attribute to
10754778e0beSJiri Pirko  * @attrtype: attribute type
10764778e0beSJiri Pirko  * @value: numeric value
10774778e0beSJiri Pirko  */
10784778e0beSJiri Pirko static inline int nla_put_s8(struct sk_buff *skb, int attrtype, s8 value)
10794778e0beSJiri Pirko {
1080b4391db4SArnd Bergmann 	s8 tmp = value;
1081b4391db4SArnd Bergmann 
1082b4391db4SArnd Bergmann 	return nla_put(skb, attrtype, sizeof(s8), &tmp);
10834778e0beSJiri Pirko }
10844778e0beSJiri Pirko 
10854778e0beSJiri Pirko /**
10864778e0beSJiri Pirko  * nla_put_s16 - Add a s16 netlink attribute to a socket buffer
10874778e0beSJiri Pirko  * @skb: socket buffer to add attribute to
10884778e0beSJiri Pirko  * @attrtype: attribute type
10894778e0beSJiri Pirko  * @value: numeric value
10904778e0beSJiri Pirko  */
10914778e0beSJiri Pirko static inline int nla_put_s16(struct sk_buff *skb, int attrtype, s16 value)
10924778e0beSJiri Pirko {
1093b4391db4SArnd Bergmann 	s16 tmp = value;
1094b4391db4SArnd Bergmann 
1095b4391db4SArnd Bergmann 	return nla_put(skb, attrtype, sizeof(s16), &tmp);
10964778e0beSJiri Pirko }
10974778e0beSJiri Pirko 
10984778e0beSJiri Pirko /**
10994778e0beSJiri Pirko  * nla_put_s32 - Add a s32 netlink attribute to a socket buffer
11004778e0beSJiri Pirko  * @skb: socket buffer to add attribute to
11014778e0beSJiri Pirko  * @attrtype: attribute type
11024778e0beSJiri Pirko  * @value: numeric value
11034778e0beSJiri Pirko  */
11044778e0beSJiri Pirko static inline int nla_put_s32(struct sk_buff *skb, int attrtype, s32 value)
11054778e0beSJiri Pirko {
1106b4391db4SArnd Bergmann 	s32 tmp = value;
1107b4391db4SArnd Bergmann 
1108b4391db4SArnd Bergmann 	return nla_put(skb, attrtype, sizeof(s32), &tmp);
11094778e0beSJiri Pirko }
11104778e0beSJiri Pirko 
11114778e0beSJiri Pirko /**
1112756a2f59SNicolas Dichtel  * nla_put_s64 - Add a s64 netlink attribute to a socket buffer and align it
11134778e0beSJiri Pirko  * @skb: socket buffer to add attribute to
11144778e0beSJiri Pirko  * @attrtype: attribute type
11154778e0beSJiri Pirko  * @value: numeric value
1116756a2f59SNicolas Dichtel  * @padattr: attribute type for the padding
11174778e0beSJiri Pirko  */
1118756a2f59SNicolas Dichtel static inline int nla_put_s64(struct sk_buff *skb, int attrtype, s64 value,
1119756a2f59SNicolas Dichtel 			      int padattr)
11204778e0beSJiri Pirko {
1121b4391db4SArnd Bergmann 	s64 tmp = value;
1122b4391db4SArnd Bergmann 
1123b4391db4SArnd Bergmann 	return nla_put_64bit(skb, attrtype, sizeof(s64), &tmp, padattr);
11244778e0beSJiri Pirko }
11254778e0beSJiri Pirko 
11264778e0beSJiri Pirko /**
1127bfa83a9eSThomas Graf  * nla_put_string - Add a string netlink attribute to a socket buffer
1128bfa83a9eSThomas Graf  * @skb: socket buffer to add attribute to
1129bfa83a9eSThomas Graf  * @attrtype: attribute type
1130bfa83a9eSThomas Graf  * @str: NUL terminated string
1131bfa83a9eSThomas Graf  */
1132bfa83a9eSThomas Graf static inline int nla_put_string(struct sk_buff *skb, int attrtype,
1133bfa83a9eSThomas Graf 				 const char *str)
1134bfa83a9eSThomas Graf {
1135bfa83a9eSThomas Graf 	return nla_put(skb, attrtype, strlen(str) + 1, str);
1136bfa83a9eSThomas Graf }
1137bfa83a9eSThomas Graf 
1138bfa83a9eSThomas Graf /**
1139bfa83a9eSThomas Graf  * nla_put_flag - Add a flag netlink attribute to a socket buffer
1140bfa83a9eSThomas Graf  * @skb: socket buffer to add attribute to
1141bfa83a9eSThomas Graf  * @attrtype: attribute type
1142bfa83a9eSThomas Graf  */
1143bfa83a9eSThomas Graf static inline int nla_put_flag(struct sk_buff *skb, int attrtype)
1144bfa83a9eSThomas Graf {
1145bfa83a9eSThomas Graf 	return nla_put(skb, attrtype, 0, NULL);
1146bfa83a9eSThomas Graf }
1147bfa83a9eSThomas Graf 
1148bfa83a9eSThomas Graf /**
11492175d87cSNicolas Dichtel  * nla_put_msecs - Add a msecs netlink attribute to a skb and align it
1150bfa83a9eSThomas Graf  * @skb: socket buffer to add attribute to
1151bfa83a9eSThomas Graf  * @attrtype: attribute type
1152d87de1f3SMark Rustad  * @njiffies: number of jiffies to convert to msecs
11532175d87cSNicolas Dichtel  * @padattr: attribute type for the padding
1154bfa83a9eSThomas Graf  */
1155bfa83a9eSThomas Graf static inline int nla_put_msecs(struct sk_buff *skb, int attrtype,
11562175d87cSNicolas Dichtel 				unsigned long njiffies, int padattr)
1157bfa83a9eSThomas Graf {
1158d87de1f3SMark Rustad 	u64 tmp = jiffies_to_msecs(njiffies);
11592175d87cSNicolas Dichtel 
11602175d87cSNicolas Dichtel 	return nla_put_64bit(skb, attrtype, sizeof(u64), &tmp, padattr);
1161bfa83a9eSThomas Graf }
1162bfa83a9eSThomas Graf 
1163bfa83a9eSThomas Graf /**
1164930345eaSJiri Benc  * nla_put_in_addr - Add an IPv4 address netlink attribute to a socket
1165930345eaSJiri Benc  * buffer
1166930345eaSJiri Benc  * @skb: socket buffer to add attribute to
1167930345eaSJiri Benc  * @attrtype: attribute type
1168930345eaSJiri Benc  * @addr: IPv4 address
1169930345eaSJiri Benc  */
1170930345eaSJiri Benc static inline int nla_put_in_addr(struct sk_buff *skb, int attrtype,
1171930345eaSJiri Benc 				  __be32 addr)
1172930345eaSJiri Benc {
1173b4391db4SArnd Bergmann 	__be32 tmp = addr;
1174b4391db4SArnd Bergmann 
1175b4391db4SArnd Bergmann 	return nla_put_be32(skb, attrtype, tmp);
1176930345eaSJiri Benc }
1177930345eaSJiri Benc 
1178930345eaSJiri Benc /**
1179930345eaSJiri Benc  * nla_put_in6_addr - Add an IPv6 address netlink attribute to a socket
1180930345eaSJiri Benc  * buffer
1181930345eaSJiri Benc  * @skb: socket buffer to add attribute to
1182930345eaSJiri Benc  * @attrtype: attribute type
1183930345eaSJiri Benc  * @addr: IPv6 address
1184930345eaSJiri Benc  */
1185930345eaSJiri Benc static inline int nla_put_in6_addr(struct sk_buff *skb, int attrtype,
1186930345eaSJiri Benc 				   const struct in6_addr *addr)
1187930345eaSJiri Benc {
1188930345eaSJiri Benc 	return nla_put(skb, attrtype, sizeof(*addr), addr);
1189930345eaSJiri Benc }
1190930345eaSJiri Benc 
1191930345eaSJiri Benc /**
1192bfa83a9eSThomas Graf  * nla_get_u32 - return payload of u32 attribute
1193bfa83a9eSThomas Graf  * @nla: u32 netlink attribute
1194bfa83a9eSThomas Graf  */
1195b057efd4SPatrick McHardy static inline u32 nla_get_u32(const struct nlattr *nla)
1196bfa83a9eSThomas Graf {
1197bfa83a9eSThomas Graf 	return *(u32 *) nla_data(nla);
1198bfa83a9eSThomas Graf }
1199bfa83a9eSThomas Graf 
1200bfa83a9eSThomas Graf /**
120100012e5bSAl Viro  * nla_get_be32 - return payload of __be32 attribute
120200012e5bSAl Viro  * @nla: __be32 netlink attribute
120300012e5bSAl Viro  */
1204b057efd4SPatrick McHardy static inline __be32 nla_get_be32(const struct nlattr *nla)
120500012e5bSAl Viro {
120600012e5bSAl Viro 	return *(__be32 *) nla_data(nla);
120700012e5bSAl Viro }
120800012e5bSAl Viro 
120900012e5bSAl Viro /**
1210c648a013SAlexander Aring  * nla_get_le32 - return payload of __le32 attribute
1211c648a013SAlexander Aring  * @nla: __le32 netlink attribute
1212c648a013SAlexander Aring  */
1213c648a013SAlexander Aring static inline __le32 nla_get_le32(const struct nlattr *nla)
1214c648a013SAlexander Aring {
1215c648a013SAlexander Aring 	return *(__le32 *) nla_data(nla);
1216c648a013SAlexander Aring }
1217c648a013SAlexander Aring 
1218c648a013SAlexander Aring /**
1219bfa83a9eSThomas Graf  * nla_get_u16 - return payload of u16 attribute
1220bfa83a9eSThomas Graf  * @nla: u16 netlink attribute
1221bfa83a9eSThomas Graf  */
1222b057efd4SPatrick McHardy static inline u16 nla_get_u16(const struct nlattr *nla)
1223bfa83a9eSThomas Graf {
1224bfa83a9eSThomas Graf 	return *(u16 *) nla_data(nla);
1225bfa83a9eSThomas Graf }
1226bfa83a9eSThomas Graf 
1227bfa83a9eSThomas Graf /**
1228838965baSPatrick McHardy  * nla_get_be16 - return payload of __be16 attribute
1229838965baSPatrick McHardy  * @nla: __be16 netlink attribute
1230838965baSPatrick McHardy  */
1231b057efd4SPatrick McHardy static inline __be16 nla_get_be16(const struct nlattr *nla)
1232838965baSPatrick McHardy {
1233838965baSPatrick McHardy 	return *(__be16 *) nla_data(nla);
1234838965baSPatrick McHardy }
1235838965baSPatrick McHardy 
1236838965baSPatrick McHardy /**
12374a89c256SThomas Graf  * nla_get_le16 - return payload of __le16 attribute
12384a89c256SThomas Graf  * @nla: __le16 netlink attribute
12394a89c256SThomas Graf  */
1240b057efd4SPatrick McHardy static inline __le16 nla_get_le16(const struct nlattr *nla)
12414a89c256SThomas Graf {
12424a89c256SThomas Graf 	return *(__le16 *) nla_data(nla);
12434a89c256SThomas Graf }
12444a89c256SThomas Graf 
12454a89c256SThomas Graf /**
1246bfa83a9eSThomas Graf  * nla_get_u8 - return payload of u8 attribute
1247bfa83a9eSThomas Graf  * @nla: u8 netlink attribute
1248bfa83a9eSThomas Graf  */
1249b057efd4SPatrick McHardy static inline u8 nla_get_u8(const struct nlattr *nla)
1250bfa83a9eSThomas Graf {
1251bfa83a9eSThomas Graf 	return *(u8 *) nla_data(nla);
1252bfa83a9eSThomas Graf }
1253bfa83a9eSThomas Graf 
1254bfa83a9eSThomas Graf /**
1255bfa83a9eSThomas Graf  * nla_get_u64 - return payload of u64 attribute
1256bfa83a9eSThomas Graf  * @nla: u64 netlink attribute
1257bfa83a9eSThomas Graf  */
1258b057efd4SPatrick McHardy static inline u64 nla_get_u64(const struct nlattr *nla)
1259bfa83a9eSThomas Graf {
1260bfa83a9eSThomas Graf 	u64 tmp;
1261bfa83a9eSThomas Graf 
1262bfa83a9eSThomas Graf 	nla_memcpy(&tmp, nla, sizeof(tmp));
1263bfa83a9eSThomas Graf 
1264bfa83a9eSThomas Graf 	return tmp;
1265bfa83a9eSThomas Graf }
1266bfa83a9eSThomas Graf 
1267bfa83a9eSThomas Graf /**
1268a17c8598SPablo Neira Ayuso  * nla_get_be64 - return payload of __be64 attribute
1269a17c8598SPablo Neira Ayuso  * @nla: __be64 netlink attribute
1270a17c8598SPablo Neira Ayuso  */
1271a17c8598SPablo Neira Ayuso static inline __be64 nla_get_be64(const struct nlattr *nla)
1272a17c8598SPablo Neira Ayuso {
1273f5d410f2SPablo Neira Ayuso 	__be64 tmp;
1274f5d410f2SPablo Neira Ayuso 
1275f5d410f2SPablo Neira Ayuso 	nla_memcpy(&tmp, nla, sizeof(tmp));
1276f5d410f2SPablo Neira Ayuso 
1277f5d410f2SPablo Neira Ayuso 	return tmp;
1278a17c8598SPablo Neira Ayuso }
1279a17c8598SPablo Neira Ayuso 
1280a17c8598SPablo Neira Ayuso /**
1281c648a013SAlexander Aring  * nla_get_le64 - return payload of __le64 attribute
1282c648a013SAlexander Aring  * @nla: __le64 netlink attribute
1283c648a013SAlexander Aring  */
1284c648a013SAlexander Aring static inline __le64 nla_get_le64(const struct nlattr *nla)
1285c648a013SAlexander Aring {
1286c648a013SAlexander Aring 	return *(__le64 *) nla_data(nla);
1287c648a013SAlexander Aring }
1288c648a013SAlexander Aring 
1289c648a013SAlexander Aring /**
12904778e0beSJiri Pirko  * nla_get_s32 - return payload of s32 attribute
12914778e0beSJiri Pirko  * @nla: s32 netlink attribute
12924778e0beSJiri Pirko  */
12934778e0beSJiri Pirko static inline s32 nla_get_s32(const struct nlattr *nla)
12944778e0beSJiri Pirko {
12954778e0beSJiri Pirko 	return *(s32 *) nla_data(nla);
12964778e0beSJiri Pirko }
12974778e0beSJiri Pirko 
12984778e0beSJiri Pirko /**
12994778e0beSJiri Pirko  * nla_get_s16 - return payload of s16 attribute
13004778e0beSJiri Pirko  * @nla: s16 netlink attribute
13014778e0beSJiri Pirko  */
13024778e0beSJiri Pirko static inline s16 nla_get_s16(const struct nlattr *nla)
13034778e0beSJiri Pirko {
13044778e0beSJiri Pirko 	return *(s16 *) nla_data(nla);
13054778e0beSJiri Pirko }
13064778e0beSJiri Pirko 
13074778e0beSJiri Pirko /**
13084778e0beSJiri Pirko  * nla_get_s8 - return payload of s8 attribute
13094778e0beSJiri Pirko  * @nla: s8 netlink attribute
13104778e0beSJiri Pirko  */
13114778e0beSJiri Pirko static inline s8 nla_get_s8(const struct nlattr *nla)
13124778e0beSJiri Pirko {
13134778e0beSJiri Pirko 	return *(s8 *) nla_data(nla);
13144778e0beSJiri Pirko }
13154778e0beSJiri Pirko 
13164778e0beSJiri Pirko /**
13174778e0beSJiri Pirko  * nla_get_s64 - return payload of s64 attribute
13184778e0beSJiri Pirko  * @nla: s64 netlink attribute
13194778e0beSJiri Pirko  */
13204778e0beSJiri Pirko static inline s64 nla_get_s64(const struct nlattr *nla)
13214778e0beSJiri Pirko {
13224778e0beSJiri Pirko 	s64 tmp;
13234778e0beSJiri Pirko 
13244778e0beSJiri Pirko 	nla_memcpy(&tmp, nla, sizeof(tmp));
13254778e0beSJiri Pirko 
13264778e0beSJiri Pirko 	return tmp;
13274778e0beSJiri Pirko }
13284778e0beSJiri Pirko 
13294778e0beSJiri Pirko /**
1330bfa83a9eSThomas Graf  * nla_get_flag - return payload of flag attribute
1331bfa83a9eSThomas Graf  * @nla: flag netlink attribute
1332bfa83a9eSThomas Graf  */
1333b057efd4SPatrick McHardy static inline int nla_get_flag(const struct nlattr *nla)
1334bfa83a9eSThomas Graf {
1335bfa83a9eSThomas Graf 	return !!nla;
1336bfa83a9eSThomas Graf }
1337bfa83a9eSThomas Graf 
1338bfa83a9eSThomas Graf /**
1339bfa83a9eSThomas Graf  * nla_get_msecs - return payload of msecs attribute
1340bfa83a9eSThomas Graf  * @nla: msecs netlink attribute
1341bfa83a9eSThomas Graf  *
1342bfa83a9eSThomas Graf  * Returns the number of milliseconds in jiffies.
1343bfa83a9eSThomas Graf  */
1344b057efd4SPatrick McHardy static inline unsigned long nla_get_msecs(const struct nlattr *nla)
1345bfa83a9eSThomas Graf {
1346bfa83a9eSThomas Graf 	u64 msecs = nla_get_u64(nla);
1347bfa83a9eSThomas Graf 
1348bfa83a9eSThomas Graf 	return msecs_to_jiffies((unsigned long) msecs);
1349bfa83a9eSThomas Graf }
1350bfa83a9eSThomas Graf 
1351bfa83a9eSThomas Graf /**
135267b61f6cSJiri Benc  * nla_get_in_addr - return payload of IPv4 address attribute
135367b61f6cSJiri Benc  * @nla: IPv4 address netlink attribute
135467b61f6cSJiri Benc  */
135567b61f6cSJiri Benc static inline __be32 nla_get_in_addr(const struct nlattr *nla)
135667b61f6cSJiri Benc {
135767b61f6cSJiri Benc 	return *(__be32 *) nla_data(nla);
135867b61f6cSJiri Benc }
135967b61f6cSJiri Benc 
136067b61f6cSJiri Benc /**
136167b61f6cSJiri Benc  * nla_get_in6_addr - return payload of IPv6 address attribute
136267b61f6cSJiri Benc  * @nla: IPv6 address netlink attribute
136367b61f6cSJiri Benc  */
136467b61f6cSJiri Benc static inline struct in6_addr nla_get_in6_addr(const struct nlattr *nla)
136567b61f6cSJiri Benc {
136667b61f6cSJiri Benc 	struct in6_addr tmp;
136767b61f6cSJiri Benc 
136867b61f6cSJiri Benc 	nla_memcpy(&tmp, nla, sizeof(tmp));
136967b61f6cSJiri Benc 	return tmp;
137067b61f6cSJiri Benc }
137167b61f6cSJiri Benc 
137267b61f6cSJiri Benc /**
137364c83d83SJamal Hadi Salim  * nla_get_bitfield32 - return payload of 32 bitfield attribute
137464c83d83SJamal Hadi Salim  * @nla: nla_bitfield32 attribute
137564c83d83SJamal Hadi Salim  */
137664c83d83SJamal Hadi Salim static inline struct nla_bitfield32 nla_get_bitfield32(const struct nlattr *nla)
137764c83d83SJamal Hadi Salim {
137864c83d83SJamal Hadi Salim 	struct nla_bitfield32 tmp;
137964c83d83SJamal Hadi Salim 
138064c83d83SJamal Hadi Salim 	nla_memcpy(&tmp, nla, sizeof(tmp));
138164c83d83SJamal Hadi Salim 	return tmp;
138264c83d83SJamal Hadi Salim }
138364c83d83SJamal Hadi Salim 
138464c83d83SJamal Hadi Salim /**
1385b15ca182SThomas Graf  * nla_memdup - duplicate attribute memory (kmemdup)
1386b15ca182SThomas Graf  * @src: netlink attribute to duplicate from
1387b15ca182SThomas Graf  * @gfp: GFP mask
1388b15ca182SThomas Graf  */
1389b15ca182SThomas Graf static inline void *nla_memdup(const struct nlattr *src, gfp_t gfp)
1390b15ca182SThomas Graf {
1391b15ca182SThomas Graf 	return kmemdup(nla_data(src), nla_len(src), gfp);
1392b15ca182SThomas Graf }
1393b15ca182SThomas Graf 
1394b15ca182SThomas Graf /**
1395bfa83a9eSThomas Graf  * nla_nest_start - Start a new level of nested attributes
1396bfa83a9eSThomas Graf  * @skb: socket buffer to add attributes to
1397bfa83a9eSThomas Graf  * @attrtype: attribute type of container
1398bfa83a9eSThomas Graf  *
1399bfa83a9eSThomas Graf  * Returns the container attribute
1400bfa83a9eSThomas Graf  */
1401bfa83a9eSThomas Graf static inline struct nlattr *nla_nest_start(struct sk_buff *skb, int attrtype)
1402bfa83a9eSThomas Graf {
140327a884dcSArnaldo Carvalho de Melo 	struct nlattr *start = (struct nlattr *)skb_tail_pointer(skb);
1404bfa83a9eSThomas Graf 
1405bfa83a9eSThomas Graf 	if (nla_put(skb, attrtype, 0, NULL) < 0)
1406bfa83a9eSThomas Graf 		return NULL;
1407bfa83a9eSThomas Graf 
1408bfa83a9eSThomas Graf 	return start;
1409bfa83a9eSThomas Graf }
1410bfa83a9eSThomas Graf 
1411bfa83a9eSThomas Graf /**
1412bfa83a9eSThomas Graf  * nla_nest_end - Finalize nesting of attributes
1413d1ec3b77SPierre Ynard  * @skb: socket buffer the attributes are stored in
1414bfa83a9eSThomas Graf  * @start: container attribute
1415bfa83a9eSThomas Graf  *
1416bfa83a9eSThomas Graf  * Corrects the container attribute header to include the all
1417bfa83a9eSThomas Graf  * appeneded attributes.
1418bfa83a9eSThomas Graf  *
1419bfa83a9eSThomas Graf  * Returns the total data length of the skb.
1420bfa83a9eSThomas Graf  */
1421bfa83a9eSThomas Graf static inline int nla_nest_end(struct sk_buff *skb, struct nlattr *start)
1422bfa83a9eSThomas Graf {
142327a884dcSArnaldo Carvalho de Melo 	start->nla_len = skb_tail_pointer(skb) - (unsigned char *)start;
1424bfa83a9eSThomas Graf 	return skb->len;
1425bfa83a9eSThomas Graf }
1426bfa83a9eSThomas Graf 
1427bfa83a9eSThomas Graf /**
1428bfa83a9eSThomas Graf  * nla_nest_cancel - Cancel nesting of attributes
1429bfa83a9eSThomas Graf  * @skb: socket buffer the message is stored in
1430bfa83a9eSThomas Graf  * @start: container attribute
1431bfa83a9eSThomas Graf  *
1432bfa83a9eSThomas Graf  * Removes the container attribute and including all nested
1433bc3ed28cSThomas Graf  * attributes. Returns -EMSGSIZE
1434bfa83a9eSThomas Graf  */
1435bc3ed28cSThomas Graf static inline void nla_nest_cancel(struct sk_buff *skb, struct nlattr *start)
1436bfa83a9eSThomas Graf {
1437bc3ed28cSThomas Graf 	nlmsg_trim(skb, start);
1438bfa83a9eSThomas Graf }
1439bfa83a9eSThomas Graf 
1440bfa83a9eSThomas Graf /**
14414fe5d5c0SPaul Moore  * nla_validate_nested - Validate a stream of nested attributes
14424fe5d5c0SPaul Moore  * @start: container attribute
14434fe5d5c0SPaul Moore  * @maxtype: maximum attribute type to be expected
14444fe5d5c0SPaul Moore  * @policy: validation policy
1445fceb6435SJohannes Berg  * @extack: extended ACK report struct
14464fe5d5c0SPaul Moore  *
14474fe5d5c0SPaul Moore  * Validates all attributes in the nested attribute stream against the
14484fe5d5c0SPaul Moore  * specified policy. Attributes with a type exceeding maxtype will be
14494fe5d5c0SPaul Moore  * ignored. See documenation of struct nla_policy for more details.
14504fe5d5c0SPaul Moore  *
14514fe5d5c0SPaul Moore  * Returns 0 on success or a negative error code.
14524fe5d5c0SPaul Moore  */
14533654654fSJan Engelhardt static inline int nla_validate_nested(const struct nlattr *start, int maxtype,
1454fceb6435SJohannes Berg 				      const struct nla_policy *policy,
1455fceb6435SJohannes Berg 				      struct netlink_ext_ack *extack)
14564fe5d5c0SPaul Moore {
1457fceb6435SJohannes Berg 	return nla_validate(nla_data(start), nla_len(start), maxtype, policy,
1458fceb6435SJohannes Berg 			    extack);
14594fe5d5c0SPaul Moore }
14604fe5d5c0SPaul Moore 
14614fe5d5c0SPaul Moore /**
1462089bf1a6SNicolas Dichtel  * nla_need_padding_for_64bit - test 64-bit alignment of the next attribute
1463089bf1a6SNicolas Dichtel  * @skb: socket buffer the message is stored in
1464089bf1a6SNicolas Dichtel  *
1465089bf1a6SNicolas Dichtel  * Return true if padding is needed to align the next attribute (nla_data()) to
1466089bf1a6SNicolas Dichtel  * a 64-bit aligned area.
1467089bf1a6SNicolas Dichtel  */
1468089bf1a6SNicolas Dichtel static inline bool nla_need_padding_for_64bit(struct sk_buff *skb)
1469089bf1a6SNicolas Dichtel {
1470089bf1a6SNicolas Dichtel #ifndef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS
1471089bf1a6SNicolas Dichtel 	/* The nlattr header is 4 bytes in size, that's why we test
1472089bf1a6SNicolas Dichtel 	 * if the skb->data _is_ aligned.  A NOP attribute, plus
1473089bf1a6SNicolas Dichtel 	 * nlattr header for next attribute, will make nla_data()
1474089bf1a6SNicolas Dichtel 	 * 8-byte aligned.
1475089bf1a6SNicolas Dichtel 	 */
1476089bf1a6SNicolas Dichtel 	if (IS_ALIGNED((unsigned long)skb_tail_pointer(skb), 8))
1477089bf1a6SNicolas Dichtel 		return true;
1478089bf1a6SNicolas Dichtel #endif
1479089bf1a6SNicolas Dichtel 	return false;
1480089bf1a6SNicolas Dichtel }
1481089bf1a6SNicolas Dichtel 
1482089bf1a6SNicolas Dichtel /**
148335c58459SDavid S. Miller  * nla_align_64bit - 64-bit align the nla_data() of next attribute
148435c58459SDavid S. Miller  * @skb: socket buffer the message is stored in
148535c58459SDavid S. Miller  * @padattr: attribute type for the padding
148635c58459SDavid S. Miller  *
148735c58459SDavid S. Miller  * Conditionally emit a padding netlink attribute in order to make
148835c58459SDavid S. Miller  * the next attribute we emit have a 64-bit aligned nla_data() area.
148935c58459SDavid S. Miller  * This will only be done in architectures which do not have
1490cca1d815SEric Dumazet  * CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS defined.
149135c58459SDavid S. Miller  *
149235c58459SDavid S. Miller  * Returns zero on success or a negative error code.
149335c58459SDavid S. Miller  */
149435c58459SDavid S. Miller static inline int nla_align_64bit(struct sk_buff *skb, int padattr)
149535c58459SDavid S. Miller {
1496089bf1a6SNicolas Dichtel 	if (nla_need_padding_for_64bit(skb) &&
1497cca1d815SEric Dumazet 	    !nla_reserve(skb, padattr, 0))
149835c58459SDavid S. Miller 		return -EMSGSIZE;
1499089bf1a6SNicolas Dichtel 
150035c58459SDavid S. Miller 	return 0;
150135c58459SDavid S. Miller }
150235c58459SDavid S. Miller 
150335c58459SDavid S. Miller /**
150435c58459SDavid S. Miller  * nla_total_size_64bit - total length of attribute including padding
150535c58459SDavid S. Miller  * @payload: length of payload
150635c58459SDavid S. Miller  */
150735c58459SDavid S. Miller static inline int nla_total_size_64bit(int payload)
150835c58459SDavid S. Miller {
150935c58459SDavid S. Miller 	return NLA_ALIGN(nla_attr_size(payload))
1510cca1d815SEric Dumazet #ifndef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS
151135c58459SDavid S. Miller 		+ NLA_ALIGN(nla_attr_size(0))
151235c58459SDavid S. Miller #endif
151335c58459SDavid S. Miller 		;
151435c58459SDavid S. Miller }
151535c58459SDavid S. Miller 
151635c58459SDavid S. Miller /**
1517bfa83a9eSThomas Graf  * nla_for_each_attr - iterate over a stream of attributes
1518bfa83a9eSThomas Graf  * @pos: loop counter, set to current attribute
1519bfa83a9eSThomas Graf  * @head: head of attribute stream
1520bfa83a9eSThomas Graf  * @len: length of attribute stream
1521bfa83a9eSThomas Graf  * @rem: initialized to len, holds bytes currently remaining in stream
1522bfa83a9eSThomas Graf  */
1523bfa83a9eSThomas Graf #define nla_for_each_attr(pos, head, len, rem) \
1524bfa83a9eSThomas Graf 	for (pos = head, rem = len; \
1525bfa83a9eSThomas Graf 	     nla_ok(pos, rem); \
1526bfa83a9eSThomas Graf 	     pos = nla_next(pos, &(rem)))
1527bfa83a9eSThomas Graf 
1528fe4944e5SThomas Graf /**
1529fe4944e5SThomas Graf  * nla_for_each_nested - iterate over nested attributes
1530fe4944e5SThomas Graf  * @pos: loop counter, set to current attribute
1531fe4944e5SThomas Graf  * @nla: attribute containing the nested attributes
1532fe4944e5SThomas Graf  * @rem: initialized to len, holds bytes currently remaining in stream
1533fe4944e5SThomas Graf  */
1534fe4944e5SThomas Graf #define nla_for_each_nested(pos, nla, rem) \
1535fe4944e5SThomas Graf 	nla_for_each_attr(pos, nla_data(nla), nla_len(nla), rem)
1536fe4944e5SThomas Graf 
1537941d8ebcSSimon Horman /**
1538941d8ebcSSimon Horman  * nla_is_last - Test if attribute is last in stream
1539941d8ebcSSimon Horman  * @nla: attribute to test
1540941d8ebcSSimon Horman  * @rem: bytes remaining in stream
1541941d8ebcSSimon Horman  */
1542941d8ebcSSimon Horman static inline bool nla_is_last(const struct nlattr *nla, int rem)
1543941d8ebcSSimon Horman {
1544941d8ebcSSimon Horman 	return nla->nla_len == rem;
1545941d8ebcSSimon Horman }
1546941d8ebcSSimon Horman 
1547bfa83a9eSThomas Graf #endif
1548