blob: 4c1e99303b5a44ac453125569fba8cc6a9be74cb [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001/* SPDX-License-Identifier: GPL-2.0 */
Thomas Grafbfa83a92005-11-10 02:25:51 +01002#ifndef __NET_NETLINK_H
3#define __NET_NETLINK_H
4
5#include <linux/types.h>
6#include <linux/netlink.h>
Al Virod7fe0f22006-12-03 23:15:30 -05007#include <linux/jiffies.h>
Jiri Benc930345e2015-03-29 16:59:25 +02008#include <linux/in6.h>
Thomas Grafbfa83a92005-11-10 02:25:51 +01009
10/* ========================================================================
11 * Netlink Messages and Attributes Interface (As Seen On TV)
12 * ------------------------------------------------------------------------
13 * Messages Interface
14 * ------------------------------------------------------------------------
15 *
16 * Message Format:
17 * <--- nlmsg_total_size(payload) --->
18 * <-- nlmsg_msg_size(payload) ->
19 * +----------+- - -+-------------+- - -+-------- - -
20 * | nlmsghdr | Pad | Payload | Pad | nlmsghdr
21 * +----------+- - -+-------------+- - -+-------- - -
22 * nlmsg_data(nlh)---^ ^
23 * nlmsg_next(nlh)-----------------------+
24 *
25 * Payload Format:
26 * <---------------------- nlmsg_len(nlh) --------------------->
27 * <------ hdrlen ------> <- nlmsg_attrlen(nlh, hdrlen) ->
28 * +----------------------+- - -+--------------------------------+
29 * | Family Header | Pad | Attributes |
30 * +----------------------+- - -+--------------------------------+
31 * nlmsg_attrdata(nlh, hdrlen)---^
32 *
33 * Data Structures:
34 * struct nlmsghdr netlink message header
35 *
36 * Message Construction:
37 * nlmsg_new() create a new netlink message
38 * nlmsg_put() add a netlink message to an skb
39 * nlmsg_put_answer() callback based nlmsg_put()
Justin P. Mattock1dc8d8c2010-06-21 13:45:42 -070040 * nlmsg_end() finalize netlink message
Thomas Graffe4944e2006-08-04 23:03:05 -070041 * nlmsg_get_pos() return current position in message
42 * nlmsg_trim() trim part of message
Thomas Grafbfa83a92005-11-10 02:25:51 +010043 * nlmsg_cancel() cancel message construction
44 * nlmsg_free() free a netlink message
45 *
46 * Message Sending:
47 * nlmsg_multicast() multicast message to several groups
48 * nlmsg_unicast() unicast a message to a single socket
Thomas Grafd387f6a2006-08-15 00:31:06 -070049 * nlmsg_notify() send notification message
Thomas Grafbfa83a92005-11-10 02:25:51 +010050 *
51 * Message Length Calculations:
52 * nlmsg_msg_size(payload) length of message w/o padding
53 * nlmsg_total_size(payload) length of message w/ padding
54 * nlmsg_padlen(payload) length of padding at tail
55 *
56 * Message Payload Access:
57 * nlmsg_data(nlh) head of message payload
58 * nlmsg_len(nlh) length of message payload
59 * nlmsg_attrdata(nlh, hdrlen) head of attributes data
60 * nlmsg_attrlen(nlh, hdrlen) length of attributes data
61 *
62 * Message Parsing:
63 * nlmsg_ok(nlh, remaining) does nlh fit into remaining bytes?
64 * nlmsg_next(nlh, remaining) get next netlink message
65 * nlmsg_parse() parse attributes of a message
66 * nlmsg_find_attr() find an attribute in a message
67 * nlmsg_for_each_msg() loop over all messages
68 * nlmsg_validate() validate netlink message incl. attrs
69 * nlmsg_for_each_attr() loop over all attributes
70 *
Thomas Graf97676b62006-08-15 00:31:41 -070071 * Misc:
72 * nlmsg_report() report back to application?
73 *
Thomas Grafbfa83a92005-11-10 02:25:51 +010074 * ------------------------------------------------------------------------
75 * Attributes Interface
76 * ------------------------------------------------------------------------
77 *
78 * Attribute Format:
79 * <------- nla_total_size(payload) ------->
80 * <---- nla_attr_size(payload) ----->
81 * +----------+- - -+- - - - - - - - - +- - -+-------- - -
82 * | Header | Pad | Payload | Pad | Header
83 * +----------+- - -+- - - - - - - - - +- - -+-------- - -
84 * <- nla_len(nla) -> ^
85 * nla_data(nla)----^ |
86 * nla_next(nla)-----------------------------'
87 *
88 * Data Structures:
Pierre Ynardd1ec3b72007-10-10 21:09:48 -070089 * struct nlattr netlink attribute header
Thomas Grafbfa83a92005-11-10 02:25:51 +010090 *
91 * Attribute Construction:
Thomas Graffe4944e2006-08-04 23:03:05 -070092 * nla_reserve(skb, type, len) reserve room for an attribute
93 * nla_reserve_nohdr(skb, len) reserve room for an attribute w/o hdr
Thomas Grafbfa83a92005-11-10 02:25:51 +010094 * nla_put(skb, type, len, data) add attribute to skb
Thomas Graffe4944e2006-08-04 23:03:05 -070095 * nla_put_nohdr(skb, len, data) add attribute w/o hdr
Patrick McHardy01480e12008-01-22 22:10:59 -080096 * nla_append(skb, len, data) append data to skb
Thomas Grafbfa83a92005-11-10 02:25:51 +010097 *
98 * Attribute Construction for Basic Types:
99 * nla_put_u8(skb, type, value) add u8 attribute to skb
100 * nla_put_u16(skb, type, value) add u16 attribute to skb
101 * nla_put_u32(skb, type, value) add u32 attribute to skb
Rolf Eike Beer26837012017-07-13 16:46:43 +0200102 * nla_put_u64_64bit(skb, type,
103 * value, padattr) add u64 attribute to skb
Jiri Pirko4778e0b2012-07-27 06:28:52 +0000104 * nla_put_s8(skb, type, value) add s8 attribute to skb
105 * nla_put_s16(skb, type, value) add s16 attribute to skb
106 * nla_put_s32(skb, type, value) add s32 attribute to skb
Nicolas Dichtel756a2f52016-04-22 17:31:20 +0200107 * nla_put_s64(skb, type, value,
108 * padattr) add s64 attribute to skb
Thomas Grafbfa83a92005-11-10 02:25:51 +0100109 * nla_put_string(skb, type, str) add string attribute to skb
110 * nla_put_flag(skb, type) add flag attribute to skb
Nicolas Dichtel2175d872016-04-22 17:31:21 +0200111 * nla_put_msecs(skb, type, jiffies,
112 * padattr) add msecs attribute to skb
Jiri Benc930345e2015-03-29 16:59:25 +0200113 * nla_put_in_addr(skb, type, addr) add IPv4 address attribute to skb
114 * nla_put_in6_addr(skb, type, addr) add IPv6 address attribute to skb
Thomas Grafbfa83a92005-11-10 02:25:51 +0100115 *
Thomas Grafbfa83a92005-11-10 02:25:51 +0100116 * Nested Attributes Construction:
117 * nla_nest_start(skb, type) start a nested attribute
118 * nla_nest_end(skb, nla) finalize a nested attribute
119 * nla_nest_cancel(skb, nla) cancel nested attribute construction
120 *
121 * Attribute Length Calculations:
122 * nla_attr_size(payload) length of attribute w/o padding
123 * nla_total_size(payload) length of attribute w/ padding
124 * nla_padlen(payload) length of padding
125 *
126 * Attribute Payload Access:
127 * nla_data(nla) head of attribute payload
128 * nla_len(nla) length of attribute payload
129 *
130 * Attribute Payload Access for Basic Types:
131 * nla_get_u8(nla) get payload for a u8 attribute
132 * nla_get_u16(nla) get payload for a u16 attribute
133 * nla_get_u32(nla) get payload for a u32 attribute
134 * nla_get_u64(nla) get payload for a u64 attribute
Jiri Pirko4778e0b2012-07-27 06:28:52 +0000135 * nla_get_s8(nla) get payload for a s8 attribute
136 * nla_get_s16(nla) get payload for a s16 attribute
137 * nla_get_s32(nla) get payload for a s32 attribute
138 * nla_get_s64(nla) get payload for a s64 attribute
Thomas Grafbfa83a92005-11-10 02:25:51 +0100139 * nla_get_flag(nla) return 1 if flag is true
140 * nla_get_msecs(nla) get payload for a msecs attribute
141 *
142 * Attribute Misc:
143 * nla_memcpy(dest, nla, count) copy attribute into memory
144 * nla_memcmp(nla, data, size) compare attribute with memory area
145 * nla_strlcpy(dst, nla, size) copy attribute to a sized string
146 * nla_strcmp(nla, str) compare attribute with string
147 *
148 * Attribute Parsing:
149 * nla_ok(nla, remaining) does nla fit into remaining bytes?
150 * nla_next(nla, remaining) get next netlink attribute
151 * nla_validate() validate a stream of attributes
Paul Moore4fe5d5c2006-09-25 15:54:03 -0700152 * nla_validate_nested() validate a stream of nested attributes
Thomas Grafbfa83a92005-11-10 02:25:51 +0100153 * nla_find() find attribute in stream of attributes
Thomas Graffe4944e2006-08-04 23:03:05 -0700154 * nla_find_nested() find attribute in nested attributes
Thomas Grafbfa83a92005-11-10 02:25:51 +0100155 * nla_parse() parse and validate stream of attrs
Johannes Berg43955a42018-09-26 22:19:42 +0200156 * nla_parse_nested() parse nested attributes
Thomas Grafbfa83a92005-11-10 02:25:51 +0100157 * nla_for_each_attr() loop over all attributes
Paul Moore22acb192006-09-25 15:53:37 -0700158 * nla_for_each_nested() loop over the nested attributes
Thomas Grafbfa83a92005-11-10 02:25:51 +0100159 *=========================================================================
160 */
161
162 /**
163 * Standard attribute types to specify validation policy
164 */
165enum {
166 NLA_UNSPEC,
167 NLA_U8,
168 NLA_U16,
169 NLA_U32,
170 NLA_U64,
171 NLA_STRING,
172 NLA_FLAG,
173 NLA_MSECS,
174 NLA_NESTED,
Johannes Berg1501d132018-09-26 11:15:34 +0200175 NLA_NESTED_ARRAY,
Thomas Grafa5531a52006-08-26 20:11:47 -0700176 NLA_NUL_STRING,
Johannes Bergd30045a2007-03-23 11:37:48 -0700177 NLA_BINARY,
Jiri Pirko4778e0b2012-07-27 06:28:52 +0000178 NLA_S8,
179 NLA_S16,
180 NLA_S32,
181 NLA_S64,
Jamal Hadi Salim64c83d82017-07-30 13:24:49 -0400182 NLA_BITFIELD32,
Johannes Berg568b7422018-09-17 11:57:28 +0200183 NLA_REJECT,
Johannes Bergb60b87f2018-09-17 11:57:29 +0200184 NLA_EXACT_LEN,
185 NLA_EXACT_LEN_WARN,
Thomas Grafbfa83a92005-11-10 02:25:51 +0100186 __NLA_TYPE_MAX,
187};
188
189#define NLA_TYPE_MAX (__NLA_TYPE_MAX - 1)
190
Johannes Berg3e48be02018-09-27 11:28:35 +0200191enum nla_policy_validation {
192 NLA_VALIDATE_NONE,
193 NLA_VALIDATE_RANGE,
194 NLA_VALIDATE_MIN,
195 NLA_VALIDATE_MAX,
Johannes Berg33188bd2018-09-27 11:28:36 +0200196 NLA_VALIDATE_FUNCTION,
Johannes Berg3e48be02018-09-27 11:28:35 +0200197};
198
Thomas Grafbfa83a92005-11-10 02:25:51 +0100199/**
200 * struct nla_policy - attribute validation policy
201 * @type: Type of attribute or NLA_UNSPEC
Johannes Berg3e48be02018-09-27 11:28:35 +0200202 * @validation_type: type of attribute validation done in addition to
Johannes Berg33188bd2018-09-27 11:28:36 +0200203 * type-specific validation (e.g. range, function call), see
Johannes Berg3e48be02018-09-27 11:28:35 +0200204 * &enum nla_policy_validation
Thomas Grafa5531a52006-08-26 20:11:47 -0700205 * @len: Type specific length of payload
Thomas Grafbfa83a92005-11-10 02:25:51 +0100206 *
207 * Policies are defined as arrays of this struct, the array must be
208 * accessible by attribute type up to the highest identifier to be expected.
209 *
Thomas Grafa5531a52006-08-26 20:11:47 -0700210 * Meaning of `len' field:
211 * NLA_STRING Maximum length of string
212 * NLA_NUL_STRING Maximum length of string (excluding NUL)
213 * NLA_FLAG Unused
Johannes Bergd30045a2007-03-23 11:37:48 -0700214 * NLA_BINARY Maximum length of attribute payload
Johannes Berg1501d132018-09-26 11:15:34 +0200215 * NLA_NESTED,
216 * NLA_NESTED_ARRAY Length verification is done by checking len of
Johannes Berg9a659a32018-09-26 11:15:33 +0200217 * nested header (or empty); len field is used if
218 * validation_data is also used, for the max attr
219 * number in the nested policy.
Johannes Berg4b6cc722011-11-03 00:10:05 +0000220 * NLA_U8, NLA_U16,
221 * NLA_U32, NLA_U64,
Jiri Pirko4778e0b2012-07-27 06:28:52 +0000222 * NLA_S8, NLA_S16,
223 * NLA_S32, NLA_S64,
Johannes Berg4b6cc722011-11-03 00:10:05 +0000224 * NLA_MSECS Leaving the length field zero will verify the
225 * given type fits, using it verifies minimum length
226 * just like "All other"
Johannes Berg568b7422018-09-17 11:57:28 +0200227 * NLA_BITFIELD32 Unused
228 * NLA_REJECT Unused
Johannes Bergb60b87f2018-09-17 11:57:29 +0200229 * NLA_EXACT_LEN Attribute must have exactly this length, otherwise
230 * it is rejected.
231 * NLA_EXACT_LEN_WARN Attribute should have exactly this length, a warning
232 * is logged if it is longer, shorter is rejected.
Johannes Berg4b6cc722011-11-03 00:10:05 +0000233 * All other Minimum length of attribute payload
Thomas Grafa5531a52006-08-26 20:11:47 -0700234 *
Johannes Berg568b7422018-09-17 11:57:28 +0200235 * Meaning of `validation_data' field:
236 * NLA_BITFIELD32 This is a 32-bit bitmap/bitselector attribute and
237 * validation data must point to a u32 value of valid
238 * flags
239 * NLA_REJECT This attribute is always rejected and validation data
240 * may point to a string to report as the error instead
241 * of the generic one in extended ACK.
Johannes Berg9a659a32018-09-26 11:15:33 +0200242 * NLA_NESTED Points to a nested policy to validate, must also set
243 * `len' to the max attribute number.
244 * Note that nla_parse() will validate, but of course not
245 * parse, the nested sub-policies.
Johannes Berg1501d132018-09-26 11:15:34 +0200246 * NLA_NESTED_ARRAY Points to a nested policy to validate, must also set
247 * `len' to the max attribute number. The difference to
248 * NLA_NESTED is the structure - NLA_NESTED has the
249 * nested attributes directly inside, while an array has
250 * the nested attributes at another level down and the
251 * attributes directly in the nesting don't matter.
Johannes Berg3e48be02018-09-27 11:28:35 +0200252 * All other Unused - but note that it's a union
253 *
254 * Meaning of `min' and `max' fields, use via NLA_POLICY_MIN, NLA_POLICY_MAX
255 * and NLA_POLICY_RANGE:
256 * NLA_U8,
257 * NLA_U16,
258 * NLA_U32,
259 * NLA_U64,
260 * NLA_S8,
261 * NLA_S16,
262 * NLA_S32,
263 * NLA_S64 These are used depending on the validation_type
264 * field, if that is min/max/range then the minimum,
265 * maximum and both are used (respectively) to check
266 * the value of the integer attribute.
267 * Note that in the interest of code simplicity and
268 * struct size both limits are s16, so you cannot
269 * enforce a range that doesn't fall within the range
270 * of s16 - do that as usual in the code instead.
271 * All other Unused - but note that it's a union
Johannes Berg568b7422018-09-17 11:57:28 +0200272 *
Johannes Berg33188bd2018-09-27 11:28:36 +0200273 * Meaning of `validate' field, use via NLA_POLICY_VALIDATE_FN:
274 * NLA_BINARY Validation function called for the attribute,
275 * not compatible with use of the validation_data
276 * as in NLA_BITFIELD32, NLA_REJECT, NLA_NESTED and
277 * NLA_NESTED_ARRAY.
278 * All other Unused - but note that it's a union
279 *
Thomas Grafbfa83a92005-11-10 02:25:51 +0100280 * Example:
Alexey Dobriyanb54452b2010-02-18 08:14:31 +0000281 * static const struct nla_policy my_policy[ATTR_MAX+1] = {
Thomas Grafbfa83a92005-11-10 02:25:51 +0100282 * [ATTR_FOO] = { .type = NLA_U16 },
Johannes Bergd30045a2007-03-23 11:37:48 -0700283 * [ATTR_BAR] = { .type = NLA_STRING, .len = BARSIZ },
Thomas Grafa5531a52006-08-26 20:11:47 -0700284 * [ATTR_BAZ] = { .len = sizeof(struct mystruct) },
Jamal Hadi Salim64c83d82017-07-30 13:24:49 -0400285 * [ATTR_GOO] = { .type = NLA_BITFIELD32, .validation_data = &myvalidflags },
Thomas Grafbfa83a92005-11-10 02:25:51 +0100286 * };
287 */
288struct nla_policy {
Johannes Berg3e48be02018-09-27 11:28:35 +0200289 u8 type;
290 u8 validation_type;
Thomas Grafa5531a52006-08-26 20:11:47 -0700291 u16 len;
Johannes Berg3e48be02018-09-27 11:28:35 +0200292 union {
293 const void *validation_data;
294 struct {
295 s16 min, max;
296 };
Johannes Berg33188bd2018-09-27 11:28:36 +0200297 int (*validate)(const struct nlattr *attr,
298 struct netlink_ext_ack *extack);
Johannes Berg3e48be02018-09-27 11:28:35 +0200299 };
Thomas Grafbfa83a92005-11-10 02:25:51 +0100300};
301
Johannes Bergb60b87f2018-09-17 11:57:29 +0200302#define NLA_POLICY_EXACT_LEN(_len) { .type = NLA_EXACT_LEN, .len = _len }
303#define NLA_POLICY_EXACT_LEN_WARN(_len) { .type = NLA_EXACT_LEN_WARN, \
304 .len = _len }
305
306#define NLA_POLICY_ETH_ADDR NLA_POLICY_EXACT_LEN(ETH_ALEN)
307#define NLA_POLICY_ETH_ADDR_COMPAT NLA_POLICY_EXACT_LEN_WARN(ETH_ALEN)
308
Johannes Berg9a659a32018-09-26 11:15:33 +0200309#define NLA_POLICY_NESTED(maxattr, policy) \
310 { .type = NLA_NESTED, .validation_data = policy, .len = maxattr }
Johannes Berg1501d132018-09-26 11:15:34 +0200311#define NLA_POLICY_NESTED_ARRAY(maxattr, policy) \
312 { .type = NLA_NESTED_ARRAY, .validation_data = policy, .len = maxattr }
Johannes Berg9a659a32018-09-26 11:15:33 +0200313
Johannes Berg5886d932018-10-12 12:53:00 +0200314#define __NLA_ENSURE(condition) BUILD_BUG_ON_ZERO(!(condition))
Johannes Berg3e48be02018-09-27 11:28:35 +0200315#define NLA_ENSURE_INT_TYPE(tp) \
316 (__NLA_ENSURE(tp == NLA_S8 || tp == NLA_U8 || \
317 tp == NLA_S16 || tp == NLA_U16 || \
318 tp == NLA_S32 || tp == NLA_U32 || \
319 tp == NLA_S64 || tp == NLA_U64) + tp)
Johannes Berg33188bd2018-09-27 11:28:36 +0200320#define NLA_ENSURE_NO_VALIDATION_PTR(tp) \
321 (__NLA_ENSURE(tp != NLA_BITFIELD32 && \
322 tp != NLA_REJECT && \
323 tp != NLA_NESTED && \
324 tp != NLA_NESTED_ARRAY) + tp)
Johannes Berg3e48be02018-09-27 11:28:35 +0200325
326#define NLA_POLICY_RANGE(tp, _min, _max) { \
327 .type = NLA_ENSURE_INT_TYPE(tp), \
328 .validation_type = NLA_VALIDATE_RANGE, \
329 .min = _min, \
330 .max = _max \
331}
332
333#define NLA_POLICY_MIN(tp, _min) { \
334 .type = NLA_ENSURE_INT_TYPE(tp), \
335 .validation_type = NLA_VALIDATE_MIN, \
336 .min = _min, \
337}
338
339#define NLA_POLICY_MAX(tp, _max) { \
340 .type = NLA_ENSURE_INT_TYPE(tp), \
341 .validation_type = NLA_VALIDATE_MAX, \
342 .max = _max, \
343}
344
Johannes Berg33188bd2018-09-27 11:28:36 +0200345#define NLA_POLICY_VALIDATE_FN(tp, fn, ...) { \
346 .type = NLA_ENSURE_NO_VALIDATION_PTR(tp), \
347 .validation_type = NLA_VALIDATE_FUNCTION, \
348 .validate = fn, \
349 .len = __VA_ARGS__ + 0, \
350}
351
Thomas Graf4e902c52006-08-17 18:14:52 -0700352/**
353 * struct nl_info - netlink source information
354 * @nlh: Netlink message header of original request
Eric W. Biederman15e47302012-09-07 20:12:54 +0000355 * @portid: Netlink PORTID of requesting application
Thomas Graf4e902c52006-08-17 18:14:52 -0700356 */
357struct nl_info {
358 struct nlmsghdr *nlh;
Denis V. Lunev4d1169c2008-01-10 03:26:13 -0800359 struct net *nl_net;
Eric W. Biederman15e47302012-09-07 20:12:54 +0000360 u32 portid;
David Ahern3b1137f2017-02-02 12:37:10 -0800361 bool skip_notify;
Thomas Graf4e902c52006-08-17 18:14:52 -0700362};
363
Joe Perches4f690532013-09-21 10:22:50 -0700364int netlink_rcv_skb(struct sk_buff *skb,
Johannes Berg2d4bc932017-04-12 14:34:04 +0200365 int (*cb)(struct sk_buff *, struct nlmsghdr *,
366 struct netlink_ext_ack *));
Joe Perches4f690532013-09-21 10:22:50 -0700367int nlmsg_notify(struct sock *sk, struct sk_buff *skb, u32 portid,
368 unsigned int group, int report, gfp_t flags);
Thomas Graf82ace472005-11-10 02:25:53 +0100369
Joe Perches4f690532013-09-21 10:22:50 -0700370int nla_validate(const struct nlattr *head, int len, int maxtype,
Johannes Bergfceb6432017-04-12 14:34:07 +0200371 const struct nla_policy *policy,
372 struct netlink_ext_ack *extack);
Joe Perches4f690532013-09-21 10:22:50 -0700373int nla_parse(struct nlattr **tb, int maxtype, const struct nlattr *head,
Johannes Bergfceb6432017-04-12 14:34:07 +0200374 int len, const struct nla_policy *policy,
375 struct netlink_ext_ack *extack);
David Aherna5f6cba2018-10-07 20:16:25 -0700376int nla_parse_strict(struct nlattr **tb, int maxtype, const struct nlattr *head,
377 int len, const struct nla_policy *policy,
378 struct netlink_ext_ack *extack);
Joe Perches4f690532013-09-21 10:22:50 -0700379int nla_policy_len(const struct nla_policy *, int);
380struct nlattr *nla_find(const struct nlattr *head, int len, int attrtype);
381size_t nla_strlcpy(char *dst, const struct nlattr *nla, size_t dstsize);
Phil Sutter2cf0c8b2017-07-27 16:56:40 +0200382char *nla_strdup(const struct nlattr *nla, gfp_t flags);
Joe Perches4f690532013-09-21 10:22:50 -0700383int nla_memcpy(void *dest, const struct nlattr *src, int count);
384int nla_memcmp(const struct nlattr *nla, const void *data, size_t size);
385int nla_strcmp(const struct nlattr *nla, const char *str);
386struct nlattr *__nla_reserve(struct sk_buff *skb, int attrtype, int attrlen);
Nicolas Dichtel089bf1a2016-04-21 18:58:24 +0200387struct nlattr *__nla_reserve_64bit(struct sk_buff *skb, int attrtype,
388 int attrlen, int padattr);
Joe Perches4f690532013-09-21 10:22:50 -0700389void *__nla_reserve_nohdr(struct sk_buff *skb, int attrlen);
390struct nlattr *nla_reserve(struct sk_buff *skb, int attrtype, int attrlen);
Nicolas Dichtel089bf1a2016-04-21 18:58:24 +0200391struct nlattr *nla_reserve_64bit(struct sk_buff *skb, int attrtype,
392 int attrlen, int padattr);
Joe Perches4f690532013-09-21 10:22:50 -0700393void *nla_reserve_nohdr(struct sk_buff *skb, int attrlen);
394void __nla_put(struct sk_buff *skb, int attrtype, int attrlen,
395 const void *data);
Nicolas Dichtel089bf1a2016-04-21 18:58:24 +0200396void __nla_put_64bit(struct sk_buff *skb, int attrtype, int attrlen,
397 const void *data, int padattr);
Joe Perches4f690532013-09-21 10:22:50 -0700398void __nla_put_nohdr(struct sk_buff *skb, int attrlen, const void *data);
399int nla_put(struct sk_buff *skb, int attrtype, int attrlen, const void *data);
Nicolas Dichtel089bf1a2016-04-21 18:58:24 +0200400int nla_put_64bit(struct sk_buff *skb, int attrtype, int attrlen,
401 const void *data, int padattr);
Joe Perches4f690532013-09-21 10:22:50 -0700402int nla_put_nohdr(struct sk_buff *skb, int attrlen, const void *data);
403int nla_append(struct sk_buff *skb, int attrlen, const void *data);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100404
405/**************************************************************************
406 * Netlink Messages
407 **************************************************************************/
408
409/**
410 * nlmsg_msg_size - length of netlink message not including padding
411 * @payload: length of message payload
412 */
413static inline int nlmsg_msg_size(int payload)
414{
415 return NLMSG_HDRLEN + payload;
416}
417
418/**
419 * nlmsg_total_size - length of netlink message including padding
420 * @payload: length of message payload
421 */
422static inline int nlmsg_total_size(int payload)
423{
424 return NLMSG_ALIGN(nlmsg_msg_size(payload));
425}
426
427/**
428 * nlmsg_padlen - length of padding at the message's tail
429 * @payload: length of message payload
430 */
431static inline int nlmsg_padlen(int payload)
432{
433 return nlmsg_total_size(payload) - nlmsg_msg_size(payload);
434}
435
436/**
437 * nlmsg_data - head of message payload
Justin P. Mattock70f23fd2011-05-10 10:16:21 +0200438 * @nlh: netlink message header
Thomas Grafbfa83a92005-11-10 02:25:51 +0100439 */
440static inline void *nlmsg_data(const struct nlmsghdr *nlh)
441{
442 return (unsigned char *) nlh + NLMSG_HDRLEN;
443}
444
445/**
446 * nlmsg_len - length of message payload
447 * @nlh: netlink message header
448 */
449static inline int nlmsg_len(const struct nlmsghdr *nlh)
450{
451 return nlh->nlmsg_len - NLMSG_HDRLEN;
452}
453
454/**
455 * nlmsg_attrdata - head of attributes data
456 * @nlh: netlink message header
457 * @hdrlen: length of family specific header
458 */
459static inline struct nlattr *nlmsg_attrdata(const struct nlmsghdr *nlh,
460 int hdrlen)
461{
462 unsigned char *data = nlmsg_data(nlh);
463 return (struct nlattr *) (data + NLMSG_ALIGN(hdrlen));
464}
465
466/**
467 * nlmsg_attrlen - length of attributes data
468 * @nlh: netlink message header
469 * @hdrlen: length of family specific header
470 */
471static inline int nlmsg_attrlen(const struct nlmsghdr *nlh, int hdrlen)
472{
473 return nlmsg_len(nlh) - NLMSG_ALIGN(hdrlen);
474}
475
476/**
477 * nlmsg_ok - check if the netlink message fits into the remaining bytes
478 * @nlh: netlink message header
479 * @remaining: number of bytes remaining in message stream
480 */
481static inline int nlmsg_ok(const struct nlmsghdr *nlh, int remaining)
482{
Vegard Nossum619e8032008-12-25 17:21:17 -0800483 return (remaining >= (int) sizeof(struct nlmsghdr) &&
Thomas Grafbfa83a92005-11-10 02:25:51 +0100484 nlh->nlmsg_len >= sizeof(struct nlmsghdr) &&
485 nlh->nlmsg_len <= remaining);
486}
487
488/**
489 * nlmsg_next - next netlink message in message stream
490 * @nlh: netlink message header
491 * @remaining: number of bytes remaining in message stream
492 *
493 * Returns the next netlink message in the message stream and
494 * decrements remaining by the size of the current message.
495 */
Jan Engelhardt36546542010-11-16 09:52:32 -0800496static inline struct nlmsghdr *
497nlmsg_next(const struct nlmsghdr *nlh, int *remaining)
Thomas Grafbfa83a92005-11-10 02:25:51 +0100498{
499 int totlen = NLMSG_ALIGN(nlh->nlmsg_len);
500
501 *remaining -= totlen;
502
503 return (struct nlmsghdr *) ((unsigned char *) nlh + totlen);
504}
505
506/**
507 * nlmsg_parse - parse attributes of a netlink message
508 * @nlh: netlink message header
509 * @hdrlen: length of family specific header
510 * @tb: destination array with maxtype+1 elements
511 * @maxtype: maximum attribute type to be expected
512 * @policy: validation policy
Johannes Bergfceb6432017-04-12 14:34:07 +0200513 * @extack: extended ACK report struct
Thomas Grafbfa83a92005-11-10 02:25:51 +0100514 *
515 * See nla_parse()
516 */
Patrick McHardy3a6c2b42009-08-25 16:07:40 +0200517static inline int nlmsg_parse(const struct nlmsghdr *nlh, int hdrlen,
Thomas Grafbfa83a92005-11-10 02:25:51 +0100518 struct nlattr *tb[], int maxtype,
Johannes Bergfceb6432017-04-12 14:34:07 +0200519 const struct nla_policy *policy,
520 struct netlink_ext_ack *extack)
Thomas Grafbfa83a92005-11-10 02:25:51 +0100521{
David Ahern3d0d4332018-10-07 20:16:23 -0700522 if (nlh->nlmsg_len < nlmsg_msg_size(hdrlen)) {
523 NL_SET_ERR_MSG(extack, "Invalid header length");
Thomas Grafbfa83a92005-11-10 02:25:51 +0100524 return -EINVAL;
David Ahern3d0d4332018-10-07 20:16:23 -0700525 }
Thomas Grafbfa83a92005-11-10 02:25:51 +0100526
527 return nla_parse(tb, maxtype, nlmsg_attrdata(nlh, hdrlen),
Johannes Bergfceb6432017-04-12 14:34:07 +0200528 nlmsg_attrlen(nlh, hdrlen), policy, extack);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100529}
530
David Aherna5f6cba2018-10-07 20:16:25 -0700531static inline int nlmsg_parse_strict(const struct nlmsghdr *nlh, int hdrlen,
532 struct nlattr *tb[], int maxtype,
533 const struct nla_policy *policy,
534 struct netlink_ext_ack *extack)
535{
536 if (nlh->nlmsg_len < nlmsg_msg_size(hdrlen)) {
537 NL_SET_ERR_MSG(extack, "Invalid header length");
538 return -EINVAL;
539 }
540
541 return nla_parse_strict(tb, maxtype, nlmsg_attrdata(nlh, hdrlen),
542 nlmsg_attrlen(nlh, hdrlen), policy, extack);
543}
544
Thomas Grafbfa83a92005-11-10 02:25:51 +0100545/**
546 * nlmsg_find_attr - find a specific attribute in a netlink message
547 * @nlh: netlink message header
548 * @hdrlen: length of familiy specific header
549 * @attrtype: type of attribute to look for
550 *
551 * Returns the first attribute which matches the specified type.
552 */
Nelson Elhage6b8c92b2010-11-03 16:35:40 +0000553static inline struct nlattr *nlmsg_find_attr(const struct nlmsghdr *nlh,
Thomas Grafbfa83a92005-11-10 02:25:51 +0100554 int hdrlen, int attrtype)
555{
556 return nla_find(nlmsg_attrdata(nlh, hdrlen),
557 nlmsg_attrlen(nlh, hdrlen), attrtype);
558}
559
560/**
561 * nlmsg_validate - validate a netlink message including attributes
562 * @nlh: netlinket message header
563 * @hdrlen: length of familiy specific header
564 * @maxtype: maximum attribute type to be expected
565 * @policy: validation policy
Johannes Bergfceb6432017-04-12 14:34:07 +0200566 * @extack: extended ACK report struct
Thomas Grafbfa83a92005-11-10 02:25:51 +0100567 */
Jan Engelhardt36546542010-11-16 09:52:32 -0800568static inline int nlmsg_validate(const struct nlmsghdr *nlh,
569 int hdrlen, int maxtype,
Johannes Bergfceb6432017-04-12 14:34:07 +0200570 const struct nla_policy *policy,
571 struct netlink_ext_ack *extack)
Thomas Grafbfa83a92005-11-10 02:25:51 +0100572{
573 if (nlh->nlmsg_len < nlmsg_msg_size(hdrlen))
574 return -EINVAL;
575
576 return nla_validate(nlmsg_attrdata(nlh, hdrlen),
Johannes Bergfceb6432017-04-12 14:34:07 +0200577 nlmsg_attrlen(nlh, hdrlen), maxtype, policy,
578 extack);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100579}
580
581/**
Thomas Graf97676b62006-08-15 00:31:41 -0700582 * nlmsg_report - need to report back to application?
583 * @nlh: netlink message header
584 *
585 * Returns 1 if a report back to the application is requested.
586 */
Patrick McHardy3a6c2b42009-08-25 16:07:40 +0200587static inline int nlmsg_report(const struct nlmsghdr *nlh)
Thomas Graf97676b62006-08-15 00:31:41 -0700588{
589 return !!(nlh->nlmsg_flags & NLM_F_ECHO);
590}
591
592/**
Thomas Grafbfa83a92005-11-10 02:25:51 +0100593 * nlmsg_for_each_attr - iterate over a stream of attributes
594 * @pos: loop counter, set to current attribute
595 * @nlh: netlink message header
596 * @hdrlen: length of familiy specific header
597 * @rem: initialized to len, holds bytes currently remaining in stream
598 */
599#define nlmsg_for_each_attr(pos, nlh, hdrlen, rem) \
600 nla_for_each_attr(pos, nlmsg_attrdata(nlh, hdrlen), \
601 nlmsg_attrlen(nlh, hdrlen), rem)
602
Thomas Grafbfa83a92005-11-10 02:25:51 +0100603/**
604 * nlmsg_put - Add a new netlink message to an skb
605 * @skb: socket buffer to store message in
Nicolas Dichtel2c6ba4b2014-10-16 15:47:51 +0200606 * @portid: netlink PORTID of requesting application
Thomas Grafbfa83a92005-11-10 02:25:51 +0100607 * @seq: sequence number of message
608 * @type: message type
609 * @payload: length of message payload
610 * @flags: message flags
611 *
612 * Returns NULL if the tailroom of the skb is insufficient to store
613 * the message header and payload.
614 */
Eric W. Biederman15e47302012-09-07 20:12:54 +0000615static inline struct nlmsghdr *nlmsg_put(struct sk_buff *skb, u32 portid, u32 seq,
Thomas Grafbfa83a92005-11-10 02:25:51 +0100616 int type, int payload, int flags)
617{
618 if (unlikely(skb_tailroom(skb) < nlmsg_total_size(payload)))
619 return NULL;
620
Eric W. Biederman15e47302012-09-07 20:12:54 +0000621 return __nlmsg_put(skb, portid, seq, type, payload, flags);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100622}
623
624/**
625 * nlmsg_put_answer - Add a new callback based netlink message to an skb
626 * @skb: socket buffer to store message in
627 * @cb: netlink callback
628 * @type: message type
629 * @payload: length of message payload
630 * @flags: message flags
631 *
632 * Returns NULL if the tailroom of the skb is insufficient to store
633 * the message header and payload.
634 */
635static inline struct nlmsghdr *nlmsg_put_answer(struct sk_buff *skb,
636 struct netlink_callback *cb,
637 int type, int payload,
638 int flags)
639{
Eric W. Biederman15e47302012-09-07 20:12:54 +0000640 return nlmsg_put(skb, NETLINK_CB(cb->skb).portid, cb->nlh->nlmsg_seq,
Thomas Grafbfa83a92005-11-10 02:25:51 +0100641 type, payload, flags);
642}
643
644/**
645 * nlmsg_new - Allocate a new netlink message
Thomas Graf339bf982006-11-10 14:10:15 -0800646 * @payload: size of the message payload
Thomas Graffe4944e2006-08-04 23:03:05 -0700647 * @flags: the type of memory to allocate.
Thomas Grafbfa83a92005-11-10 02:25:51 +0100648 *
Thomas Graf339bf982006-11-10 14:10:15 -0800649 * Use NLMSG_DEFAULT_SIZE if the size of the payload isn't known
650 * and a good default is needed.
Thomas Grafbfa83a92005-11-10 02:25:51 +0100651 */
Thomas Graf339bf982006-11-10 14:10:15 -0800652static inline struct sk_buff *nlmsg_new(size_t payload, gfp_t flags)
Thomas Grafbfa83a92005-11-10 02:25:51 +0100653{
Thomas Graf339bf982006-11-10 14:10:15 -0800654 return alloc_skb(nlmsg_total_size(payload), flags);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100655}
656
657/**
658 * nlmsg_end - Finalize a netlink message
659 * @skb: socket buffer the message is stored in
660 * @nlh: netlink message header
661 *
662 * Corrects the netlink message header to include the appeneded
663 * attributes. Only necessary if attributes have been added to
664 * the message.
Thomas Grafbfa83a92005-11-10 02:25:51 +0100665 */
Johannes Berg053c0952015-01-16 22:09:00 +0100666static inline void nlmsg_end(struct sk_buff *skb, struct nlmsghdr *nlh)
Thomas Grafbfa83a92005-11-10 02:25:51 +0100667{
Arnaldo Carvalho de Melo27a884d2007-04-19 20:29:13 -0700668 nlh->nlmsg_len = skb_tail_pointer(skb) - (unsigned char *)nlh;
Thomas Grafbfa83a92005-11-10 02:25:51 +0100669}
670
671/**
Thomas Graffe4944e2006-08-04 23:03:05 -0700672 * nlmsg_get_pos - return current position in netlink message
673 * @skb: socket buffer the message is stored in
674 *
675 * Returns a pointer to the current tail of the message.
676 */
677static inline void *nlmsg_get_pos(struct sk_buff *skb)
678{
Arnaldo Carvalho de Melo27a884d2007-04-19 20:29:13 -0700679 return skb_tail_pointer(skb);
Thomas Graffe4944e2006-08-04 23:03:05 -0700680}
681
682/**
683 * nlmsg_trim - Trim message to a mark
684 * @skb: socket buffer the message is stored in
685 * @mark: mark to trim to
686 *
Thomas Grafbc3ed282008-06-03 16:36:54 -0700687 * Trims the message to the provided mark.
Thomas Graffe4944e2006-08-04 23:03:05 -0700688 */
Thomas Grafbc3ed282008-06-03 16:36:54 -0700689static inline void nlmsg_trim(struct sk_buff *skb, const void *mark)
Thomas Graffe4944e2006-08-04 23:03:05 -0700690{
Thomas Graf149118d2015-01-06 01:04:21 +0100691 if (mark) {
692 WARN_ON((unsigned char *) mark < skb->data);
Thomas Graffe4944e2006-08-04 23:03:05 -0700693 skb_trim(skb, (unsigned char *) mark - skb->data);
Thomas Graf149118d2015-01-06 01:04:21 +0100694 }
Thomas Graffe4944e2006-08-04 23:03:05 -0700695}
696
697/**
Thomas Grafbfa83a92005-11-10 02:25:51 +0100698 * nlmsg_cancel - Cancel construction of a netlink message
699 * @skb: socket buffer the message is stored in
700 * @nlh: netlink message header
701 *
702 * Removes the complete netlink message including all
Thomas Grafbc3ed282008-06-03 16:36:54 -0700703 * attributes from the socket buffer again.
Thomas Grafbfa83a92005-11-10 02:25:51 +0100704 */
Thomas Grafbc3ed282008-06-03 16:36:54 -0700705static inline void nlmsg_cancel(struct sk_buff *skb, struct nlmsghdr *nlh)
Thomas Grafbfa83a92005-11-10 02:25:51 +0100706{
Thomas Grafbc3ed282008-06-03 16:36:54 -0700707 nlmsg_trim(skb, nlh);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100708}
709
710/**
711 * nlmsg_free - free a netlink message
712 * @skb: socket buffer of netlink message
713 */
714static inline void nlmsg_free(struct sk_buff *skb)
715{
716 kfree_skb(skb);
717}
718
719/**
720 * nlmsg_multicast - multicast a netlink message
721 * @sk: netlink socket to spread messages to
722 * @skb: netlink message as socket buffer
Eric W. Biederman15e47302012-09-07 20:12:54 +0000723 * @portid: own netlink portid to avoid sending to yourself
Thomas Grafbfa83a92005-11-10 02:25:51 +0100724 * @group: multicast group id
Thomas Grafd387f6a2006-08-15 00:31:06 -0700725 * @flags: allocation flags
Thomas Grafbfa83a92005-11-10 02:25:51 +0100726 */
727static inline int nlmsg_multicast(struct sock *sk, struct sk_buff *skb,
Eric W. Biederman15e47302012-09-07 20:12:54 +0000728 u32 portid, unsigned int group, gfp_t flags)
Thomas Grafbfa83a92005-11-10 02:25:51 +0100729{
730 int err;
731
732 NETLINK_CB(skb).dst_group = group;
733
Eric W. Biederman15e47302012-09-07 20:12:54 +0000734 err = netlink_broadcast(sk, skb, portid, group, flags);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100735 if (err > 0)
736 err = 0;
737
738 return err;
739}
740
741/**
742 * nlmsg_unicast - unicast a netlink message
743 * @sk: netlink socket to spread message to
744 * @skb: netlink message as socket buffer
Eric W. Biederman15e47302012-09-07 20:12:54 +0000745 * @portid: netlink portid of the destination socket
Thomas Grafbfa83a92005-11-10 02:25:51 +0100746 */
Eric W. Biederman15e47302012-09-07 20:12:54 +0000747static inline int nlmsg_unicast(struct sock *sk, struct sk_buff *skb, u32 portid)
Thomas Grafbfa83a92005-11-10 02:25:51 +0100748{
749 int err;
750
Eric W. Biederman15e47302012-09-07 20:12:54 +0000751 err = netlink_unicast(sk, skb, portid, MSG_DONTWAIT);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100752 if (err > 0)
753 err = 0;
754
755 return err;
756}
757
758/**
759 * nlmsg_for_each_msg - iterate over a stream of messages
760 * @pos: loop counter, set to current message
761 * @head: head of message stream
762 * @len: length of message stream
763 * @rem: initialized to len, holds bytes currently remaining in stream
764 */
765#define nlmsg_for_each_msg(pos, head, len, rem) \
766 for (pos = head, rem = len; \
767 nlmsg_ok(pos, rem); \
768 pos = nlmsg_next(pos, &(rem)))
769
Johannes Berg670dc282011-06-20 13:40:46 +0200770/**
771 * nl_dump_check_consistent - check if sequence is consistent and advertise if not
772 * @cb: netlink callback structure that stores the sequence number
773 * @nlh: netlink message header to write the flag to
774 *
775 * This function checks if the sequence (generation) number changed during dump
776 * and if it did, advertises it in the netlink message header.
777 *
778 * The correct way to use it is to set cb->seq to the generation counter when
779 * all locks for dumping have been acquired, and then call this function for
780 * each message that is generated.
781 *
782 * Note that due to initialisation concerns, 0 is an invalid sequence number
783 * and must not be used by code that uses this functionality.
784 */
785static inline void
786nl_dump_check_consistent(struct netlink_callback *cb,
787 struct nlmsghdr *nlh)
788{
789 if (cb->prev_seq && cb->seq != cb->prev_seq)
790 nlh->nlmsg_flags |= NLM_F_DUMP_INTR;
791 cb->prev_seq = cb->seq;
792}
793
Thomas Grafbfa83a92005-11-10 02:25:51 +0100794/**************************************************************************
795 * Netlink Attributes
796 **************************************************************************/
797
798/**
799 * nla_attr_size - length of attribute not including padding
800 * @payload: length of payload
801 */
802static inline int nla_attr_size(int payload)
803{
804 return NLA_HDRLEN + payload;
805}
806
807/**
808 * nla_total_size - total length of attribute including padding
809 * @payload: length of payload
810 */
811static inline int nla_total_size(int payload)
812{
813 return NLA_ALIGN(nla_attr_size(payload));
814}
815
816/**
817 * nla_padlen - length of padding at the tail of attribute
818 * @payload: length of payload
819 */
820static inline int nla_padlen(int payload)
821{
822 return nla_total_size(payload) - nla_attr_size(payload);
823}
824
825/**
Thomas Graf8f4c1f92007-09-12 14:44:36 +0200826 * nla_type - attribute type
827 * @nla: netlink attribute
828 */
829static inline int nla_type(const struct nlattr *nla)
830{
831 return nla->nla_type & NLA_TYPE_MASK;
832}
833
834/**
Thomas Grafbfa83a92005-11-10 02:25:51 +0100835 * nla_data - head of payload
836 * @nla: netlink attribute
837 */
838static inline void *nla_data(const struct nlattr *nla)
839{
840 return (char *) nla + NLA_HDRLEN;
841}
842
843/**
844 * nla_len - length of payload
845 * @nla: netlink attribute
846 */
847static inline int nla_len(const struct nlattr *nla)
848{
849 return nla->nla_len - NLA_HDRLEN;
850}
851
852/**
853 * nla_ok - check if the netlink attribute fits into the remaining bytes
854 * @nla: netlink attribute
855 * @remaining: number of bytes remaining in attribute stream
856 */
857static inline int nla_ok(const struct nlattr *nla, int remaining)
858{
Alexey Dobriyan3e1ed982016-12-13 22:30:15 +0300859 return remaining >= (int) sizeof(*nla) &&
860 nla->nla_len >= sizeof(*nla) &&
Thomas Grafbfa83a92005-11-10 02:25:51 +0100861 nla->nla_len <= remaining;
862}
863
864/**
Pierre Ynardd1ec3b72007-10-10 21:09:48 -0700865 * nla_next - next netlink attribute in attribute stream
Thomas Grafbfa83a92005-11-10 02:25:51 +0100866 * @nla: netlink attribute
867 * @remaining: number of bytes remaining in attribute stream
868 *
869 * Returns the next netlink attribute in the attribute stream and
870 * decrements remaining by the size of the current attribute.
871 */
872static inline struct nlattr *nla_next(const struct nlattr *nla, int *remaining)
873{
Alexey Dobriyan3b2c75d32016-11-19 03:54:35 +0300874 unsigned int totlen = NLA_ALIGN(nla->nla_len);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100875
876 *remaining -= totlen;
877 return (struct nlattr *) ((char *) nla + totlen);
878}
879
880/**
Thomas Graffe4944e2006-08-04 23:03:05 -0700881 * nla_find_nested - find attribute in a set of nested attributes
882 * @nla: attribute containing the nested attributes
883 * @attrtype: type of attribute to look for
884 *
885 * Returns the first attribute which matches the specified type.
886 */
Jan Engelhardt36546542010-11-16 09:52:32 -0800887static inline struct nlattr *
888nla_find_nested(const struct nlattr *nla, int attrtype)
Thomas Graffe4944e2006-08-04 23:03:05 -0700889{
890 return nla_find(nla_data(nla), nla_len(nla), attrtype);
891}
892
893/**
Thomas Grafbfa83a92005-11-10 02:25:51 +0100894 * nla_parse_nested - parse nested attributes
895 * @tb: destination array with maxtype+1 elements
896 * @maxtype: maximum attribute type to be expected
897 * @nla: attribute containing the nested attributes
898 * @policy: validation policy
Johannes Bergfceb6432017-04-12 14:34:07 +0200899 * @extack: extended ACK report struct
Thomas Grafbfa83a92005-11-10 02:25:51 +0100900 *
901 * See nla_parse()
902 */
903static inline int nla_parse_nested(struct nlattr *tb[], int maxtype,
Patrick McHardyb057efd2008-10-28 11:59:11 -0700904 const struct nlattr *nla,
Johannes Bergfceb6432017-04-12 14:34:07 +0200905 const struct nla_policy *policy,
906 struct netlink_ext_ack *extack)
Thomas Grafbfa83a92005-11-10 02:25:51 +0100907{
Johannes Bergfceb6432017-04-12 14:34:07 +0200908 return nla_parse(tb, maxtype, nla_data(nla), nla_len(nla), policy,
909 extack);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100910}
Patrick McHardy1092cb22007-06-25 13:49:35 -0700911
912/**
Pierre Ynardd1ec3b72007-10-10 21:09:48 -0700913 * nla_put_u8 - Add a u8 netlink attribute to a socket buffer
Thomas Grafbfa83a92005-11-10 02:25:51 +0100914 * @skb: socket buffer to add attribute to
915 * @attrtype: attribute type
916 * @value: numeric value
917 */
918static inline int nla_put_u8(struct sk_buff *skb, int attrtype, u8 value)
919{
Arnd Bergmannb4391db2017-09-22 23:29:19 +0200920 /* temporary variables to work around GCC PR81715 with asan-stack=1 */
921 u8 tmp = value;
922
923 return nla_put(skb, attrtype, sizeof(u8), &tmp);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100924}
925
926/**
927 * nla_put_u16 - Add a u16 netlink attribute to a socket buffer
928 * @skb: socket buffer to add attribute to
929 * @attrtype: attribute type
930 * @value: numeric value
931 */
932static inline int nla_put_u16(struct sk_buff *skb, int attrtype, u16 value)
933{
Arnd Bergmannb4391db2017-09-22 23:29:19 +0200934 u16 tmp = value;
935
936 return nla_put(skb, attrtype, sizeof(u16), &tmp);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100937}
938
939/**
David S. Miller569a8fc2012-03-29 23:18:53 -0400940 * nla_put_be16 - Add a __be16 netlink attribute to a socket buffer
941 * @skb: socket buffer to add attribute to
942 * @attrtype: attribute type
943 * @value: numeric value
944 */
945static inline int nla_put_be16(struct sk_buff *skb, int attrtype, __be16 value)
946{
Arnd Bergmannb4391db2017-09-22 23:29:19 +0200947 __be16 tmp = value;
948
949 return nla_put(skb, attrtype, sizeof(__be16), &tmp);
David S. Miller569a8fc2012-03-29 23:18:53 -0400950}
951
952/**
David S. Miller6c1dd3b2012-04-01 19:11:31 -0400953 * nla_put_net16 - Add 16-bit network byte order netlink attribute to a socket buffer
954 * @skb: socket buffer to add attribute to
955 * @attrtype: attribute type
956 * @value: numeric value
957 */
958static inline int nla_put_net16(struct sk_buff *skb, int attrtype, __be16 value)
959{
Arnd Bergmannb4391db2017-09-22 23:29:19 +0200960 __be16 tmp = value;
961
962 return nla_put_be16(skb, attrtype | NLA_F_NET_BYTEORDER, tmp);
David S. Miller6c1dd3b2012-04-01 19:11:31 -0400963}
964
965/**
David S. Miller24c410d2012-04-01 20:14:27 -0400966 * nla_put_le16 - Add a __le16 netlink attribute to a socket buffer
967 * @skb: socket buffer to add attribute to
968 * @attrtype: attribute type
969 * @value: numeric value
970 */
971static inline int nla_put_le16(struct sk_buff *skb, int attrtype, __le16 value)
972{
Arnd Bergmannb4391db2017-09-22 23:29:19 +0200973 __le16 tmp = value;
974
975 return nla_put(skb, attrtype, sizeof(__le16), &tmp);
David S. Miller24c410d2012-04-01 20:14:27 -0400976}
977
978/**
Thomas Grafbfa83a92005-11-10 02:25:51 +0100979 * nla_put_u32 - Add a u32 netlink attribute to a socket buffer
980 * @skb: socket buffer to add attribute to
981 * @attrtype: attribute type
982 * @value: numeric value
983 */
984static inline int nla_put_u32(struct sk_buff *skb, int attrtype, u32 value)
985{
Arnd Bergmannb4391db2017-09-22 23:29:19 +0200986 u32 tmp = value;
987
988 return nla_put(skb, attrtype, sizeof(u32), &tmp);
Thomas Grafbfa83a92005-11-10 02:25:51 +0100989}
990
991/**
David S. Miller569a8fc2012-03-29 23:18:53 -0400992 * nla_put_be32 - Add a __be32 netlink attribute to a socket buffer
993 * @skb: socket buffer to add attribute to
994 * @attrtype: attribute type
995 * @value: numeric value
996 */
997static inline int nla_put_be32(struct sk_buff *skb, int attrtype, __be32 value)
998{
Arnd Bergmannb4391db2017-09-22 23:29:19 +0200999 __be32 tmp = value;
1000
1001 return nla_put(skb, attrtype, sizeof(__be32), &tmp);
David S. Miller569a8fc2012-03-29 23:18:53 -04001002}
1003
1004/**
David S. Miller6c1dd3b2012-04-01 19:11:31 -04001005 * nla_put_net32 - Add 32-bit network byte order netlink attribute to a socket buffer
1006 * @skb: socket buffer to add attribute to
1007 * @attrtype: attribute type
1008 * @value: numeric value
1009 */
1010static inline int nla_put_net32(struct sk_buff *skb, int attrtype, __be32 value)
1011{
Arnd Bergmannb4391db2017-09-22 23:29:19 +02001012 __be32 tmp = value;
1013
1014 return nla_put_be32(skb, attrtype | NLA_F_NET_BYTEORDER, tmp);
David S. Miller6c1dd3b2012-04-01 19:11:31 -04001015}
1016
1017/**
David S. Miller24c410d2012-04-01 20:14:27 -04001018 * nla_put_le32 - Add a __le32 netlink attribute to a socket buffer
1019 * @skb: socket buffer to add attribute to
1020 * @attrtype: attribute type
1021 * @value: numeric value
1022 */
1023static inline int nla_put_le32(struct sk_buff *skb, int attrtype, __le32 value)
1024{
Arnd Bergmannb4391db2017-09-22 23:29:19 +02001025 __le32 tmp = value;
1026
1027 return nla_put(skb, attrtype, sizeof(__le32), &tmp);
David S. Miller24c410d2012-04-01 20:14:27 -04001028}
1029
1030/**
Nicolas Dichtel73520782016-04-22 17:31:22 +02001031 * nla_put_u64_64bit - Add a u64 netlink attribute to a skb and align it
1032 * @skb: socket buffer to add attribute to
1033 * @attrtype: attribute type
1034 * @value: numeric value
1035 * @padattr: attribute type for the padding
1036 */
1037static inline int nla_put_u64_64bit(struct sk_buff *skb, int attrtype,
1038 u64 value, int padattr)
1039{
Arnd Bergmannb4391db2017-09-22 23:29:19 +02001040 u64 tmp = value;
1041
1042 return nla_put_64bit(skb, attrtype, sizeof(u64), &tmp, padattr);
Nicolas Dichtel73520782016-04-22 17:31:22 +02001043}
1044
1045/**
Nicolas Dichtelb46f6de2016-04-22 17:31:18 +02001046 * nla_put_be64 - Add a __be64 netlink attribute to a socket buffer and align it
David S. Miller569a8fc2012-03-29 23:18:53 -04001047 * @skb: socket buffer to add attribute to
1048 * @attrtype: attribute type
1049 * @value: numeric value
Nicolas Dichtelb46f6de2016-04-22 17:31:18 +02001050 * @padattr: attribute type for the padding
David S. Miller569a8fc2012-03-29 23:18:53 -04001051 */
Nicolas Dichtelb46f6de2016-04-22 17:31:18 +02001052static inline int nla_put_be64(struct sk_buff *skb, int attrtype, __be64 value,
1053 int padattr)
1054{
Arnd Bergmannb4391db2017-09-22 23:29:19 +02001055 __be64 tmp = value;
1056
1057 return nla_put_64bit(skb, attrtype, sizeof(__be64), &tmp, padattr);
Nicolas Dichtelb46f6de2016-04-22 17:31:18 +02001058}
1059
David S. Miller569a8fc2012-03-29 23:18:53 -04001060/**
Nicolas Dichtele9bbe892016-04-22 17:31:19 +02001061 * nla_put_net64 - Add 64-bit network byte order nlattr to a skb and align it
David S. Miller6c1dd3b2012-04-01 19:11:31 -04001062 * @skb: socket buffer to add attribute to
1063 * @attrtype: attribute type
1064 * @value: numeric value
Nicolas Dichtele9bbe892016-04-22 17:31:19 +02001065 * @padattr: attribute type for the padding
David S. Miller6c1dd3b2012-04-01 19:11:31 -04001066 */
Nicolas Dichtele9bbe892016-04-22 17:31:19 +02001067static inline int nla_put_net64(struct sk_buff *skb, int attrtype, __be64 value,
1068 int padattr)
David S. Miller6c1dd3b2012-04-01 19:11:31 -04001069{
Arnd Bergmannb4391db2017-09-22 23:29:19 +02001070 __be64 tmp = value;
1071
1072 return nla_put_be64(skb, attrtype | NLA_F_NET_BYTEORDER, tmp,
Nicolas Dichtele9bbe892016-04-22 17:31:19 +02001073 padattr);
David S. Miller6c1dd3b2012-04-01 19:11:31 -04001074}
1075
1076/**
Nicolas Dichtele74791222016-04-22 17:31:17 +02001077 * nla_put_le64 - Add a __le64 netlink attribute to a socket buffer and align it
David S. Miller24c410d2012-04-01 20:14:27 -04001078 * @skb: socket buffer to add attribute to
1079 * @attrtype: attribute type
1080 * @value: numeric value
Nicolas Dichtele74791222016-04-22 17:31:17 +02001081 * @padattr: attribute type for the padding
David S. Miller24c410d2012-04-01 20:14:27 -04001082 */
Nicolas Dichtele74791222016-04-22 17:31:17 +02001083static inline int nla_put_le64(struct sk_buff *skb, int attrtype, __le64 value,
1084 int padattr)
David S. Miller24c410d2012-04-01 20:14:27 -04001085{
Arnd Bergmannb4391db2017-09-22 23:29:19 +02001086 __le64 tmp = value;
1087
1088 return nla_put_64bit(skb, attrtype, sizeof(__le64), &tmp, padattr);
David S. Miller24c410d2012-04-01 20:14:27 -04001089}
1090
1091/**
Jiri Pirko4778e0b2012-07-27 06:28:52 +00001092 * nla_put_s8 - Add a s8 netlink attribute to a socket buffer
1093 * @skb: socket buffer to add attribute to
1094 * @attrtype: attribute type
1095 * @value: numeric value
1096 */
1097static inline int nla_put_s8(struct sk_buff *skb, int attrtype, s8 value)
1098{
Arnd Bergmannb4391db2017-09-22 23:29:19 +02001099 s8 tmp = value;
1100
1101 return nla_put(skb, attrtype, sizeof(s8), &tmp);
Jiri Pirko4778e0b2012-07-27 06:28:52 +00001102}
1103
1104/**
1105 * nla_put_s16 - Add a s16 netlink attribute to a socket buffer
1106 * @skb: socket buffer to add attribute to
1107 * @attrtype: attribute type
1108 * @value: numeric value
1109 */
1110static inline int nla_put_s16(struct sk_buff *skb, int attrtype, s16 value)
1111{
Arnd Bergmannb4391db2017-09-22 23:29:19 +02001112 s16 tmp = value;
1113
1114 return nla_put(skb, attrtype, sizeof(s16), &tmp);
Jiri Pirko4778e0b2012-07-27 06:28:52 +00001115}
1116
1117/**
1118 * nla_put_s32 - Add a s32 netlink attribute to a socket buffer
1119 * @skb: socket buffer to add attribute to
1120 * @attrtype: attribute type
1121 * @value: numeric value
1122 */
1123static inline int nla_put_s32(struct sk_buff *skb, int attrtype, s32 value)
1124{
Arnd Bergmannb4391db2017-09-22 23:29:19 +02001125 s32 tmp = value;
1126
1127 return nla_put(skb, attrtype, sizeof(s32), &tmp);
Jiri Pirko4778e0b2012-07-27 06:28:52 +00001128}
1129
1130/**
Nicolas Dichtel756a2f52016-04-22 17:31:20 +02001131 * nla_put_s64 - Add a s64 netlink attribute to a socket buffer and align it
Jiri Pirko4778e0b2012-07-27 06:28:52 +00001132 * @skb: socket buffer to add attribute to
1133 * @attrtype: attribute type
1134 * @value: numeric value
Nicolas Dichtel756a2f52016-04-22 17:31:20 +02001135 * @padattr: attribute type for the padding
Jiri Pirko4778e0b2012-07-27 06:28:52 +00001136 */
Nicolas Dichtel756a2f52016-04-22 17:31:20 +02001137static inline int nla_put_s64(struct sk_buff *skb, int attrtype, s64 value,
1138 int padattr)
Jiri Pirko4778e0b2012-07-27 06:28:52 +00001139{
Arnd Bergmannb4391db2017-09-22 23:29:19 +02001140 s64 tmp = value;
1141
1142 return nla_put_64bit(skb, attrtype, sizeof(s64), &tmp, padattr);
Jiri Pirko4778e0b2012-07-27 06:28:52 +00001143}
1144
1145/**
Thomas Grafbfa83a92005-11-10 02:25:51 +01001146 * nla_put_string - Add a string netlink attribute to a socket buffer
1147 * @skb: socket buffer to add attribute to
1148 * @attrtype: attribute type
1149 * @str: NUL terminated string
1150 */
1151static inline int nla_put_string(struct sk_buff *skb, int attrtype,
1152 const char *str)
1153{
1154 return nla_put(skb, attrtype, strlen(str) + 1, str);
1155}
1156
1157/**
1158 * nla_put_flag - Add a flag netlink attribute to a socket buffer
1159 * @skb: socket buffer to add attribute to
1160 * @attrtype: attribute type
1161 */
1162static inline int nla_put_flag(struct sk_buff *skb, int attrtype)
1163{
1164 return nla_put(skb, attrtype, 0, NULL);
1165}
1166
1167/**
Nicolas Dichtel2175d872016-04-22 17:31:21 +02001168 * nla_put_msecs - Add a msecs netlink attribute to a skb and align it
Thomas Grafbfa83a92005-11-10 02:25:51 +01001169 * @skb: socket buffer to add attribute to
1170 * @attrtype: attribute type
Mark Rustadd87de1f2014-07-25 02:18:17 -07001171 * @njiffies: number of jiffies to convert to msecs
Nicolas Dichtel2175d872016-04-22 17:31:21 +02001172 * @padattr: attribute type for the padding
Thomas Grafbfa83a92005-11-10 02:25:51 +01001173 */
1174static inline int nla_put_msecs(struct sk_buff *skb, int attrtype,
Nicolas Dichtel2175d872016-04-22 17:31:21 +02001175 unsigned long njiffies, int padattr)
Thomas Grafbfa83a92005-11-10 02:25:51 +01001176{
Mark Rustadd87de1f2014-07-25 02:18:17 -07001177 u64 tmp = jiffies_to_msecs(njiffies);
Nicolas Dichtel2175d872016-04-22 17:31:21 +02001178
1179 return nla_put_64bit(skb, attrtype, sizeof(u64), &tmp, padattr);
Thomas Grafbfa83a92005-11-10 02:25:51 +01001180}
1181
Thomas Grafbfa83a92005-11-10 02:25:51 +01001182/**
Jiri Benc930345e2015-03-29 16:59:25 +02001183 * nla_put_in_addr - Add an IPv4 address netlink attribute to a socket
1184 * buffer
1185 * @skb: socket buffer to add attribute to
1186 * @attrtype: attribute type
1187 * @addr: IPv4 address
1188 */
1189static inline int nla_put_in_addr(struct sk_buff *skb, int attrtype,
1190 __be32 addr)
1191{
Arnd Bergmannb4391db2017-09-22 23:29:19 +02001192 __be32 tmp = addr;
1193
1194 return nla_put_be32(skb, attrtype, tmp);
Jiri Benc930345e2015-03-29 16:59:25 +02001195}
1196
1197/**
1198 * nla_put_in6_addr - Add an IPv6 address netlink attribute to a socket
1199 * buffer
1200 * @skb: socket buffer to add attribute to
1201 * @attrtype: attribute type
1202 * @addr: IPv6 address
1203 */
1204static inline int nla_put_in6_addr(struct sk_buff *skb, int attrtype,
1205 const struct in6_addr *addr)
1206{
1207 return nla_put(skb, attrtype, sizeof(*addr), addr);
1208}
1209
1210/**
Thomas Grafbfa83a92005-11-10 02:25:51 +01001211 * nla_get_u32 - return payload of u32 attribute
1212 * @nla: u32 netlink attribute
1213 */
Patrick McHardyb057efd2008-10-28 11:59:11 -07001214static inline u32 nla_get_u32(const struct nlattr *nla)
Thomas Grafbfa83a92005-11-10 02:25:51 +01001215{
1216 return *(u32 *) nla_data(nla);
1217}
1218
1219/**
Al Viro00012e52006-09-26 22:14:41 -07001220 * nla_get_be32 - return payload of __be32 attribute
1221 * @nla: __be32 netlink attribute
1222 */
Patrick McHardyb057efd2008-10-28 11:59:11 -07001223static inline __be32 nla_get_be32(const struct nlattr *nla)
Al Viro00012e52006-09-26 22:14:41 -07001224{
1225 return *(__be32 *) nla_data(nla);
1226}
1227
1228/**
Alexander Aringc648a012015-09-28 09:00:23 +02001229 * nla_get_le32 - return payload of __le32 attribute
1230 * @nla: __le32 netlink attribute
1231 */
1232static inline __le32 nla_get_le32(const struct nlattr *nla)
1233{
1234 return *(__le32 *) nla_data(nla);
1235}
1236
1237/**
Thomas Grafbfa83a92005-11-10 02:25:51 +01001238 * nla_get_u16 - return payload of u16 attribute
1239 * @nla: u16 netlink attribute
1240 */
Patrick McHardyb057efd2008-10-28 11:59:11 -07001241static inline u16 nla_get_u16(const struct nlattr *nla)
Thomas Grafbfa83a92005-11-10 02:25:51 +01001242{
1243 return *(u16 *) nla_data(nla);
1244}
1245
1246/**
Patrick McHardy838965b2007-12-17 22:29:26 -08001247 * nla_get_be16 - return payload of __be16 attribute
1248 * @nla: __be16 netlink attribute
1249 */
Patrick McHardyb057efd2008-10-28 11:59:11 -07001250static inline __be16 nla_get_be16(const struct nlattr *nla)
Patrick McHardy838965b2007-12-17 22:29:26 -08001251{
1252 return *(__be16 *) nla_data(nla);
1253}
1254
1255/**
Thomas Graf4a89c252006-11-24 17:14:51 -08001256 * nla_get_le16 - return payload of __le16 attribute
1257 * @nla: __le16 netlink attribute
1258 */
Patrick McHardyb057efd2008-10-28 11:59:11 -07001259static inline __le16 nla_get_le16(const struct nlattr *nla)
Thomas Graf4a89c252006-11-24 17:14:51 -08001260{
1261 return *(__le16 *) nla_data(nla);
1262}
1263
1264/**
Thomas Grafbfa83a92005-11-10 02:25:51 +01001265 * nla_get_u8 - return payload of u8 attribute
1266 * @nla: u8 netlink attribute
1267 */
Patrick McHardyb057efd2008-10-28 11:59:11 -07001268static inline u8 nla_get_u8(const struct nlattr *nla)
Thomas Grafbfa83a92005-11-10 02:25:51 +01001269{
1270 return *(u8 *) nla_data(nla);
1271}
1272
1273/**
1274 * nla_get_u64 - return payload of u64 attribute
1275 * @nla: u64 netlink attribute
1276 */
Patrick McHardyb057efd2008-10-28 11:59:11 -07001277static inline u64 nla_get_u64(const struct nlattr *nla)
Thomas Grafbfa83a92005-11-10 02:25:51 +01001278{
1279 u64 tmp;
1280
1281 nla_memcpy(&tmp, nla, sizeof(tmp));
1282
1283 return tmp;
1284}
1285
1286/**
Pablo Neira Ayusoa17c8592009-05-27 17:50:35 +02001287 * nla_get_be64 - return payload of __be64 attribute
1288 * @nla: __be64 netlink attribute
1289 */
1290static inline __be64 nla_get_be64(const struct nlattr *nla)
1291{
Pablo Neira Ayusof5d410f2010-03-16 13:30:44 +00001292 __be64 tmp;
1293
1294 nla_memcpy(&tmp, nla, sizeof(tmp));
1295
1296 return tmp;
Pablo Neira Ayusoa17c8592009-05-27 17:50:35 +02001297}
1298
1299/**
Alexander Aringc648a012015-09-28 09:00:23 +02001300 * nla_get_le64 - return payload of __le64 attribute
1301 * @nla: __le64 netlink attribute
1302 */
1303static inline __le64 nla_get_le64(const struct nlattr *nla)
1304{
1305 return *(__le64 *) nla_data(nla);
1306}
1307
1308/**
Jiri Pirko4778e0b2012-07-27 06:28:52 +00001309 * nla_get_s32 - return payload of s32 attribute
1310 * @nla: s32 netlink attribute
1311 */
1312static inline s32 nla_get_s32(const struct nlattr *nla)
1313{
1314 return *(s32 *) nla_data(nla);
1315}
1316
1317/**
1318 * nla_get_s16 - return payload of s16 attribute
1319 * @nla: s16 netlink attribute
1320 */
1321static inline s16 nla_get_s16(const struct nlattr *nla)
1322{
1323 return *(s16 *) nla_data(nla);
1324}
1325
1326/**
1327 * nla_get_s8 - return payload of s8 attribute
1328 * @nla: s8 netlink attribute
1329 */
1330static inline s8 nla_get_s8(const struct nlattr *nla)
1331{
1332 return *(s8 *) nla_data(nla);
1333}
1334
1335/**
1336 * nla_get_s64 - return payload of s64 attribute
1337 * @nla: s64 netlink attribute
1338 */
1339static inline s64 nla_get_s64(const struct nlattr *nla)
1340{
1341 s64 tmp;
1342
1343 nla_memcpy(&tmp, nla, sizeof(tmp));
1344
1345 return tmp;
1346}
1347
1348/**
Thomas Grafbfa83a92005-11-10 02:25:51 +01001349 * nla_get_flag - return payload of flag attribute
1350 * @nla: flag netlink attribute
1351 */
Patrick McHardyb057efd2008-10-28 11:59:11 -07001352static inline int nla_get_flag(const struct nlattr *nla)
Thomas Grafbfa83a92005-11-10 02:25:51 +01001353{
1354 return !!nla;
1355}
1356
1357/**
1358 * nla_get_msecs - return payload of msecs attribute
1359 * @nla: msecs netlink attribute
1360 *
1361 * Returns the number of milliseconds in jiffies.
1362 */
Patrick McHardyb057efd2008-10-28 11:59:11 -07001363static inline unsigned long nla_get_msecs(const struct nlattr *nla)
Thomas Grafbfa83a92005-11-10 02:25:51 +01001364{
1365 u64 msecs = nla_get_u64(nla);
1366
1367 return msecs_to_jiffies((unsigned long) msecs);
1368}
1369
1370/**
Jiri Benc67b61f62015-03-29 16:59:26 +02001371 * nla_get_in_addr - return payload of IPv4 address attribute
1372 * @nla: IPv4 address netlink attribute
1373 */
1374static inline __be32 nla_get_in_addr(const struct nlattr *nla)
1375{
1376 return *(__be32 *) nla_data(nla);
1377}
1378
1379/**
1380 * nla_get_in6_addr - return payload of IPv6 address attribute
1381 * @nla: IPv6 address netlink attribute
1382 */
1383static inline struct in6_addr nla_get_in6_addr(const struct nlattr *nla)
1384{
1385 struct in6_addr tmp;
1386
1387 nla_memcpy(&tmp, nla, sizeof(tmp));
1388 return tmp;
1389}
1390
1391/**
Jamal Hadi Salim64c83d82017-07-30 13:24:49 -04001392 * nla_get_bitfield32 - return payload of 32 bitfield attribute
1393 * @nla: nla_bitfield32 attribute
1394 */
1395static inline struct nla_bitfield32 nla_get_bitfield32(const struct nlattr *nla)
1396{
1397 struct nla_bitfield32 tmp;
1398
1399 nla_memcpy(&tmp, nla, sizeof(tmp));
1400 return tmp;
1401}
1402
1403/**
Thomas Grafb15ca182016-10-26 10:53:16 +02001404 * nla_memdup - duplicate attribute memory (kmemdup)
1405 * @src: netlink attribute to duplicate from
1406 * @gfp: GFP mask
1407 */
1408static inline void *nla_memdup(const struct nlattr *src, gfp_t gfp)
1409{
1410 return kmemdup(nla_data(src), nla_len(src), gfp);
1411}
1412
1413/**
Thomas Grafbfa83a92005-11-10 02:25:51 +01001414 * nla_nest_start - Start a new level of nested attributes
1415 * @skb: socket buffer to add attributes to
1416 * @attrtype: attribute type of container
1417 *
1418 * Returns the container attribute
1419 */
1420static inline struct nlattr *nla_nest_start(struct sk_buff *skb, int attrtype)
1421{
Arnaldo Carvalho de Melo27a884d2007-04-19 20:29:13 -07001422 struct nlattr *start = (struct nlattr *)skb_tail_pointer(skb);
Thomas Grafbfa83a92005-11-10 02:25:51 +01001423
1424 if (nla_put(skb, attrtype, 0, NULL) < 0)
1425 return NULL;
1426
1427 return start;
1428}
1429
1430/**
1431 * nla_nest_end - Finalize nesting of attributes
Pierre Ynardd1ec3b72007-10-10 21:09:48 -07001432 * @skb: socket buffer the attributes are stored in
Thomas Grafbfa83a92005-11-10 02:25:51 +01001433 * @start: container attribute
1434 *
1435 * Corrects the container attribute header to include the all
1436 * appeneded attributes.
1437 *
1438 * Returns the total data length of the skb.
1439 */
1440static inline int nla_nest_end(struct sk_buff *skb, struct nlattr *start)
1441{
Arnaldo Carvalho de Melo27a884d2007-04-19 20:29:13 -07001442 start->nla_len = skb_tail_pointer(skb) - (unsigned char *)start;
Thomas Grafbfa83a92005-11-10 02:25:51 +01001443 return skb->len;
1444}
1445
1446/**
1447 * nla_nest_cancel - Cancel nesting of attributes
1448 * @skb: socket buffer the message is stored in
1449 * @start: container attribute
1450 *
1451 * Removes the container attribute and including all nested
Thomas Grafbc3ed282008-06-03 16:36:54 -07001452 * attributes. Returns -EMSGSIZE
Thomas Grafbfa83a92005-11-10 02:25:51 +01001453 */
Thomas Grafbc3ed282008-06-03 16:36:54 -07001454static inline void nla_nest_cancel(struct sk_buff *skb, struct nlattr *start)
Thomas Grafbfa83a92005-11-10 02:25:51 +01001455{
Thomas Grafbc3ed282008-06-03 16:36:54 -07001456 nlmsg_trim(skb, start);
Thomas Grafbfa83a92005-11-10 02:25:51 +01001457}
1458
1459/**
Paul Moore4fe5d5c2006-09-25 15:54:03 -07001460 * nla_validate_nested - Validate a stream of nested attributes
1461 * @start: container attribute
1462 * @maxtype: maximum attribute type to be expected
1463 * @policy: validation policy
Johannes Bergfceb6432017-04-12 14:34:07 +02001464 * @extack: extended ACK report struct
Paul Moore4fe5d5c2006-09-25 15:54:03 -07001465 *
1466 * Validates all attributes in the nested attribute stream against the
1467 * specified policy. Attributes with a type exceeding maxtype will be
1468 * ignored. See documenation of struct nla_policy for more details.
1469 *
1470 * Returns 0 on success or a negative error code.
1471 */
Jan Engelhardt36546542010-11-16 09:52:32 -08001472static inline int nla_validate_nested(const struct nlattr *start, int maxtype,
Johannes Bergfceb6432017-04-12 14:34:07 +02001473 const struct nla_policy *policy,
1474 struct netlink_ext_ack *extack)
Paul Moore4fe5d5c2006-09-25 15:54:03 -07001475{
Johannes Bergfceb6432017-04-12 14:34:07 +02001476 return nla_validate(nla_data(start), nla_len(start), maxtype, policy,
1477 extack);
Paul Moore4fe5d5c2006-09-25 15:54:03 -07001478}
1479
1480/**
Nicolas Dichtel089bf1a2016-04-21 18:58:24 +02001481 * nla_need_padding_for_64bit - test 64-bit alignment of the next attribute
1482 * @skb: socket buffer the message is stored in
1483 *
1484 * Return true if padding is needed to align the next attribute (nla_data()) to
1485 * a 64-bit aligned area.
1486 */
1487static inline bool nla_need_padding_for_64bit(struct sk_buff *skb)
1488{
1489#ifndef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS
1490 /* The nlattr header is 4 bytes in size, that's why we test
1491 * if the skb->data _is_ aligned. A NOP attribute, plus
1492 * nlattr header for next attribute, will make nla_data()
1493 * 8-byte aligned.
1494 */
1495 if (IS_ALIGNED((unsigned long)skb_tail_pointer(skb), 8))
1496 return true;
1497#endif
1498 return false;
1499}
1500
1501/**
David S. Miller35c58452016-04-19 19:49:29 -04001502 * nla_align_64bit - 64-bit align the nla_data() of next attribute
1503 * @skb: socket buffer the message is stored in
1504 * @padattr: attribute type for the padding
1505 *
1506 * Conditionally emit a padding netlink attribute in order to make
1507 * the next attribute we emit have a 64-bit aligned nla_data() area.
1508 * This will only be done in architectures which do not have
Eric Dumazetcca1d812016-04-20 07:31:31 -07001509 * CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS defined.
David S. Miller35c58452016-04-19 19:49:29 -04001510 *
1511 * Returns zero on success or a negative error code.
1512 */
1513static inline int nla_align_64bit(struct sk_buff *skb, int padattr)
1514{
Nicolas Dichtel089bf1a2016-04-21 18:58:24 +02001515 if (nla_need_padding_for_64bit(skb) &&
Eric Dumazetcca1d812016-04-20 07:31:31 -07001516 !nla_reserve(skb, padattr, 0))
1517 return -EMSGSIZE;
Nicolas Dichtel089bf1a2016-04-21 18:58:24 +02001518
David S. Miller35c58452016-04-19 19:49:29 -04001519 return 0;
1520}
1521
1522/**
1523 * nla_total_size_64bit - total length of attribute including padding
1524 * @payload: length of payload
1525 */
1526static inline int nla_total_size_64bit(int payload)
1527{
1528 return NLA_ALIGN(nla_attr_size(payload))
Eric Dumazetcca1d812016-04-20 07:31:31 -07001529#ifndef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS
David S. Miller35c58452016-04-19 19:49:29 -04001530 + NLA_ALIGN(nla_attr_size(0))
1531#endif
1532 ;
1533}
1534
1535/**
Thomas Grafbfa83a92005-11-10 02:25:51 +01001536 * nla_for_each_attr - iterate over a stream of attributes
1537 * @pos: loop counter, set to current attribute
1538 * @head: head of attribute stream
1539 * @len: length of attribute stream
1540 * @rem: initialized to len, holds bytes currently remaining in stream
1541 */
1542#define nla_for_each_attr(pos, head, len, rem) \
1543 for (pos = head, rem = len; \
1544 nla_ok(pos, rem); \
1545 pos = nla_next(pos, &(rem)))
1546
Thomas Graffe4944e2006-08-04 23:03:05 -07001547/**
1548 * nla_for_each_nested - iterate over nested attributes
1549 * @pos: loop counter, set to current attribute
1550 * @nla: attribute containing the nested attributes
1551 * @rem: initialized to len, holds bytes currently remaining in stream
1552 */
1553#define nla_for_each_nested(pos, nla, rem) \
1554 nla_for_each_attr(pos, nla_data(nla), nla_len(nla), rem)
1555
Simon Horman941d8eb2014-10-27 16:12:16 +09001556/**
1557 * nla_is_last - Test if attribute is last in stream
1558 * @nla: attribute to test
1559 * @rem: bytes remaining in stream
1560 */
1561static inline bool nla_is_last(const struct nlattr *nla, int rem)
1562{
1563 return nla->nla_len == rem;
1564}
1565
Thomas Grafbfa83a92005-11-10 02:25:51 +01001566#endif