1 /* SPDX-License-Identifier: GPL-2.0 */ 2 #ifndef __NET_NETLINK_H 3 #define __NET_NETLINK_H 4 5 #include <linux/types.h> 6 #include <linux/netlink.h> 7 #include <linux/jiffies.h> 8 #include <linux/in6.h> 9 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() 40 * nlmsg_end() finalize netlink message 41 * nlmsg_get_pos() return current position in message 42 * nlmsg_trim() trim part of message 43 * 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 49 * nlmsg_notify() send notification message 50 * 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 * 71 * Misc: 72 * nlmsg_report() report back to application? 73 * 74 * ------------------------------------------------------------------------ 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: 89 * struct nlattr netlink attribute header 90 * 91 * Attribute Construction: 92 * nla_reserve(skb, type, len) reserve room for an attribute 93 * nla_reserve_nohdr(skb, len) reserve room for an attribute w/o hdr 94 * nla_put(skb, type, len, data) add attribute to skb 95 * nla_put_nohdr(skb, len, data) add attribute w/o hdr 96 * nla_append(skb, len, data) append data to skb 97 * 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 102 * nla_put_u64_64bit(skb, type, 103 * value, padattr) add u64 attribute to skb 104 * 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 107 * nla_put_s64(skb, type, value, 108 * padattr) add s64 attribute to skb 109 * nla_put_string(skb, type, str) add string attribute to skb 110 * nla_put_flag(skb, type) add flag attribute to skb 111 * nla_put_msecs(skb, type, jiffies, 112 * padattr) add msecs attribute to skb 113 * 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 115 * 116 * 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 135 * 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 139 * 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 152 * nla_validate_nested() validate a stream of nested attributes 153 * nla_find() find attribute in stream of attributes 154 * nla_find_nested() find attribute in nested attributes 155 * nla_parse() parse and validate stream of attrs 156 * nla_parse_nested() parse nested attributes 157 * nla_for_each_attr() loop over all attributes 158 * nla_for_each_nested() loop over the nested attributes 159 *========================================================================= 160 */ 161 162 /** 163 * Standard attribute types to specify validation policy 164 */ 165 enum { 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, 175 NLA_NESTED_ARRAY, 176 NLA_NUL_STRING, 177 NLA_BINARY, 178 NLA_S8, 179 NLA_S16, 180 NLA_S32, 181 NLA_S64, 182 NLA_BITFIELD32, 183 NLA_REJECT, 184 NLA_EXACT_LEN, 185 NLA_EXACT_LEN_WARN, 186 __NLA_TYPE_MAX, 187 }; 188 189 #define NLA_TYPE_MAX (__NLA_TYPE_MAX - 1) 190 191 enum nla_policy_validation { 192 NLA_VALIDATE_NONE, 193 NLA_VALIDATE_RANGE, 194 NLA_VALIDATE_MIN, 195 NLA_VALIDATE_MAX, 196 NLA_VALIDATE_FUNCTION, 197 }; 198 199 /** 200 * struct nla_policy - attribute validation policy 201 * @type: Type of attribute or NLA_UNSPEC 202 * @validation_type: type of attribute validation done in addition to 203 * type-specific validation (e.g. range, function call), see 204 * &enum nla_policy_validation 205 * @len: Type specific length of payload 206 * 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 * 210 * 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 214 * NLA_BINARY Maximum length of attribute payload 215 * NLA_NESTED, 216 * NLA_NESTED_ARRAY Length verification is done by checking len of 217 * 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. 220 * NLA_U8, NLA_U16, 221 * NLA_U32, NLA_U64, 222 * NLA_S8, NLA_S16, 223 * NLA_S32, NLA_S64, 224 * NLA_MSECS Leaving the length field zero will verify the 225 * given type fits, using it verifies minimum length 226 * just like "All other" 227 * NLA_BITFIELD32 Unused 228 * NLA_REJECT Unused 229 * 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. 233 * All other Minimum length of attribute payload 234 * 235 * 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. 242 * 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. 246 * 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. 252 * 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 272 * 273 * 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 * 280 * Example: 281 * static const struct nla_policy my_policy[ATTR_MAX+1] = { 282 * [ATTR_FOO] = { .type = NLA_U16 }, 283 * [ATTR_BAR] = { .type = NLA_STRING, .len = BARSIZ }, 284 * [ATTR_BAZ] = { .len = sizeof(struct mystruct) }, 285 * [ATTR_GOO] = { .type = NLA_BITFIELD32, .validation_data = &myvalidflags }, 286 * }; 287 */ 288 struct nla_policy { 289 u8 type; 290 u8 validation_type; 291 u16 len; 292 union { 293 const void *validation_data; 294 struct { 295 s16 min, max; 296 }; 297 int (*validate)(const struct nlattr *attr, 298 struct netlink_ext_ack *extack); 299 }; 300 }; 301 302 #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 309 #define NLA_POLICY_NESTED(maxattr, policy) \ 310 { .type = NLA_NESTED, .validation_data = policy, .len = maxattr } 311 #define NLA_POLICY_NESTED_ARRAY(maxattr, policy) \ 312 { .type = NLA_NESTED_ARRAY, .validation_data = policy, .len = maxattr } 313 314 #define __NLA_ENSURE(condition) (sizeof(char[1 - 2*!(condition)]) - 1) 315 #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) 320 #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) 325 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 345 #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 352 /** 353 * struct nl_info - netlink source information 354 * @nlh: Netlink message header of original request 355 * @portid: Netlink PORTID of requesting application 356 */ 357 struct nl_info { 358 struct nlmsghdr *nlh; 359 struct net *nl_net; 360 u32 portid; 361 bool skip_notify; 362 }; 363 364 int netlink_rcv_skb(struct sk_buff *skb, 365 int (*cb)(struct sk_buff *, struct nlmsghdr *, 366 struct netlink_ext_ack *)); 367 int nlmsg_notify(struct sock *sk, struct sk_buff *skb, u32 portid, 368 unsigned int group, int report, gfp_t flags); 369 370 int nla_validate(const struct nlattr *head, int len, int maxtype, 371 const struct nla_policy *policy, 372 struct netlink_ext_ack *extack); 373 int nla_parse(struct nlattr **tb, int maxtype, const struct nlattr *head, 374 int len, const struct nla_policy *policy, 375 struct netlink_ext_ack *extack); 376 int nla_policy_len(const struct nla_policy *, int); 377 struct nlattr *nla_find(const struct nlattr *head, int len, int attrtype); 378 size_t nla_strlcpy(char *dst, const struct nlattr *nla, size_t dstsize); 379 char *nla_strdup(const struct nlattr *nla, gfp_t flags); 380 int nla_memcpy(void *dest, const struct nlattr *src, int count); 381 int nla_memcmp(const struct nlattr *nla, const void *data, size_t size); 382 int nla_strcmp(const struct nlattr *nla, const char *str); 383 struct nlattr *__nla_reserve(struct sk_buff *skb, int attrtype, int attrlen); 384 struct nlattr *__nla_reserve_64bit(struct sk_buff *skb, int attrtype, 385 int attrlen, int padattr); 386 void *__nla_reserve_nohdr(struct sk_buff *skb, int attrlen); 387 struct nlattr *nla_reserve(struct sk_buff *skb, int attrtype, int attrlen); 388 struct nlattr *nla_reserve_64bit(struct sk_buff *skb, int attrtype, 389 int attrlen, int padattr); 390 void *nla_reserve_nohdr(struct sk_buff *skb, int attrlen); 391 void __nla_put(struct sk_buff *skb, int attrtype, int attrlen, 392 const void *data); 393 void __nla_put_64bit(struct sk_buff *skb, int attrtype, int attrlen, 394 const void *data, int padattr); 395 void __nla_put_nohdr(struct sk_buff *skb, int attrlen, const void *data); 396 int nla_put(struct sk_buff *skb, int attrtype, int attrlen, const void *data); 397 int nla_put_64bit(struct sk_buff *skb, int attrtype, int attrlen, 398 const void *data, int padattr); 399 int nla_put_nohdr(struct sk_buff *skb, int attrlen, const void *data); 400 int nla_append(struct sk_buff *skb, int attrlen, const void *data); 401 402 /************************************************************************** 403 * Netlink Messages 404 **************************************************************************/ 405 406 /** 407 * nlmsg_msg_size - length of netlink message not including padding 408 * @payload: length of message payload 409 */ 410 static inline int nlmsg_msg_size(int payload) 411 { 412 return NLMSG_HDRLEN + payload; 413 } 414 415 /** 416 * nlmsg_total_size - length of netlink message including padding 417 * @payload: length of message payload 418 */ 419 static inline int nlmsg_total_size(int payload) 420 { 421 return NLMSG_ALIGN(nlmsg_msg_size(payload)); 422 } 423 424 /** 425 * nlmsg_padlen - length of padding at the message's tail 426 * @payload: length of message payload 427 */ 428 static inline int nlmsg_padlen(int payload) 429 { 430 return nlmsg_total_size(payload) - nlmsg_msg_size(payload); 431 } 432 433 /** 434 * nlmsg_data - head of message payload 435 * @nlh: netlink message header 436 */ 437 static inline void *nlmsg_data(const struct nlmsghdr *nlh) 438 { 439 return (unsigned char *) nlh + NLMSG_HDRLEN; 440 } 441 442 /** 443 * nlmsg_len - length of message payload 444 * @nlh: netlink message header 445 */ 446 static inline int nlmsg_len(const struct nlmsghdr *nlh) 447 { 448 return nlh->nlmsg_len - NLMSG_HDRLEN; 449 } 450 451 /** 452 * nlmsg_attrdata - head of attributes data 453 * @nlh: netlink message header 454 * @hdrlen: length of family specific header 455 */ 456 static inline struct nlattr *nlmsg_attrdata(const struct nlmsghdr *nlh, 457 int hdrlen) 458 { 459 unsigned char *data = nlmsg_data(nlh); 460 return (struct nlattr *) (data + NLMSG_ALIGN(hdrlen)); 461 } 462 463 /** 464 * nlmsg_attrlen - length of attributes data 465 * @nlh: netlink message header 466 * @hdrlen: length of family specific header 467 */ 468 static inline int nlmsg_attrlen(const struct nlmsghdr *nlh, int hdrlen) 469 { 470 return nlmsg_len(nlh) - NLMSG_ALIGN(hdrlen); 471 } 472 473 /** 474 * nlmsg_ok - check if the netlink message fits into the remaining bytes 475 * @nlh: netlink message header 476 * @remaining: number of bytes remaining in message stream 477 */ 478 static inline int nlmsg_ok(const struct nlmsghdr *nlh, int remaining) 479 { 480 return (remaining >= (int) sizeof(struct nlmsghdr) && 481 nlh->nlmsg_len >= sizeof(struct nlmsghdr) && 482 nlh->nlmsg_len <= remaining); 483 } 484 485 /** 486 * nlmsg_next - next netlink message in message stream 487 * @nlh: netlink message header 488 * @remaining: number of bytes remaining in message stream 489 * 490 * Returns the next netlink message in the message stream and 491 * decrements remaining by the size of the current message. 492 */ 493 static inline struct nlmsghdr * 494 nlmsg_next(const struct nlmsghdr *nlh, int *remaining) 495 { 496 int totlen = NLMSG_ALIGN(nlh->nlmsg_len); 497 498 *remaining -= totlen; 499 500 return (struct nlmsghdr *) ((unsigned char *) nlh + totlen); 501 } 502 503 /** 504 * nlmsg_parse - parse attributes of a netlink message 505 * @nlh: netlink message header 506 * @hdrlen: length of family specific header 507 * @tb: destination array with maxtype+1 elements 508 * @maxtype: maximum attribute type to be expected 509 * @policy: validation policy 510 * @extack: extended ACK report struct 511 * 512 * See nla_parse() 513 */ 514 static inline int nlmsg_parse(const struct nlmsghdr *nlh, int hdrlen, 515 struct nlattr *tb[], int maxtype, 516 const struct nla_policy *policy, 517 struct netlink_ext_ack *extack) 518 { 519 if (nlh->nlmsg_len < nlmsg_msg_size(hdrlen)) 520 return -EINVAL; 521 522 return nla_parse(tb, maxtype, nlmsg_attrdata(nlh, hdrlen), 523 nlmsg_attrlen(nlh, hdrlen), policy, extack); 524 } 525 526 /** 527 * nlmsg_find_attr - find a specific attribute in a netlink message 528 * @nlh: netlink message header 529 * @hdrlen: length of familiy specific header 530 * @attrtype: type of attribute to look for 531 * 532 * Returns the first attribute which matches the specified type. 533 */ 534 static inline struct nlattr *nlmsg_find_attr(const struct nlmsghdr *nlh, 535 int hdrlen, int attrtype) 536 { 537 return nla_find(nlmsg_attrdata(nlh, hdrlen), 538 nlmsg_attrlen(nlh, hdrlen), attrtype); 539 } 540 541 /** 542 * nlmsg_validate - validate a netlink message including attributes 543 * @nlh: netlinket message header 544 * @hdrlen: length of familiy specific header 545 * @maxtype: maximum attribute type to be expected 546 * @policy: validation policy 547 * @extack: extended ACK report struct 548 */ 549 static inline int nlmsg_validate(const struct nlmsghdr *nlh, 550 int hdrlen, int maxtype, 551 const struct nla_policy *policy, 552 struct netlink_ext_ack *extack) 553 { 554 if (nlh->nlmsg_len < nlmsg_msg_size(hdrlen)) 555 return -EINVAL; 556 557 return nla_validate(nlmsg_attrdata(nlh, hdrlen), 558 nlmsg_attrlen(nlh, hdrlen), maxtype, policy, 559 extack); 560 } 561 562 /** 563 * nlmsg_report - need to report back to application? 564 * @nlh: netlink message header 565 * 566 * Returns 1 if a report back to the application is requested. 567 */ 568 static inline int nlmsg_report(const struct nlmsghdr *nlh) 569 { 570 return !!(nlh->nlmsg_flags & NLM_F_ECHO); 571 } 572 573 /** 574 * nlmsg_for_each_attr - iterate over a stream of attributes 575 * @pos: loop counter, set to current attribute 576 * @nlh: netlink message header 577 * @hdrlen: length of familiy specific header 578 * @rem: initialized to len, holds bytes currently remaining in stream 579 */ 580 #define nlmsg_for_each_attr(pos, nlh, hdrlen, rem) \ 581 nla_for_each_attr(pos, nlmsg_attrdata(nlh, hdrlen), \ 582 nlmsg_attrlen(nlh, hdrlen), rem) 583 584 /** 585 * nlmsg_put - Add a new netlink message to an skb 586 * @skb: socket buffer to store message in 587 * @portid: netlink PORTID of requesting application 588 * @seq: sequence number of message 589 * @type: message type 590 * @payload: length of message payload 591 * @flags: message flags 592 * 593 * Returns NULL if the tailroom of the skb is insufficient to store 594 * the message header and payload. 595 */ 596 static inline struct nlmsghdr *nlmsg_put(struct sk_buff *skb, u32 portid, u32 seq, 597 int type, int payload, int flags) 598 { 599 if (unlikely(skb_tailroom(skb) < nlmsg_total_size(payload))) 600 return NULL; 601 602 return __nlmsg_put(skb, portid, seq, type, payload, flags); 603 } 604 605 /** 606 * nlmsg_put_answer - Add a new callback based netlink message to an skb 607 * @skb: socket buffer to store message in 608 * @cb: netlink callback 609 * @type: message type 610 * @payload: length of message payload 611 * @flags: message flags 612 * 613 * Returns NULL if the tailroom of the skb is insufficient to store 614 * the message header and payload. 615 */ 616 static inline struct nlmsghdr *nlmsg_put_answer(struct sk_buff *skb, 617 struct netlink_callback *cb, 618 int type, int payload, 619 int flags) 620 { 621 return nlmsg_put(skb, NETLINK_CB(cb->skb).portid, cb->nlh->nlmsg_seq, 622 type, payload, flags); 623 } 624 625 /** 626 * nlmsg_new - Allocate a new netlink message 627 * @payload: size of the message payload 628 * @flags: the type of memory to allocate. 629 * 630 * Use NLMSG_DEFAULT_SIZE if the size of the payload isn't known 631 * and a good default is needed. 632 */ 633 static inline struct sk_buff *nlmsg_new(size_t payload, gfp_t flags) 634 { 635 return alloc_skb(nlmsg_total_size(payload), flags); 636 } 637 638 /** 639 * nlmsg_end - Finalize a netlink message 640 * @skb: socket buffer the message is stored in 641 * @nlh: netlink message header 642 * 643 * Corrects the netlink message header to include the appeneded 644 * attributes. Only necessary if attributes have been added to 645 * the message. 646 */ 647 static inline void nlmsg_end(struct sk_buff *skb, struct nlmsghdr *nlh) 648 { 649 nlh->nlmsg_len = skb_tail_pointer(skb) - (unsigned char *)nlh; 650 } 651 652 /** 653 * nlmsg_get_pos - return current position in netlink message 654 * @skb: socket buffer the message is stored in 655 * 656 * Returns a pointer to the current tail of the message. 657 */ 658 static inline void *nlmsg_get_pos(struct sk_buff *skb) 659 { 660 return skb_tail_pointer(skb); 661 } 662 663 /** 664 * nlmsg_trim - Trim message to a mark 665 * @skb: socket buffer the message is stored in 666 * @mark: mark to trim to 667 * 668 * Trims the message to the provided mark. 669 */ 670 static inline void nlmsg_trim(struct sk_buff *skb, const void *mark) 671 { 672 if (mark) { 673 WARN_ON((unsigned char *) mark < skb->data); 674 skb_trim(skb, (unsigned char *) mark - skb->data); 675 } 676 } 677 678 /** 679 * nlmsg_cancel - Cancel construction of a netlink message 680 * @skb: socket buffer the message is stored in 681 * @nlh: netlink message header 682 * 683 * Removes the complete netlink message including all 684 * attributes from the socket buffer again. 685 */ 686 static inline void nlmsg_cancel(struct sk_buff *skb, struct nlmsghdr *nlh) 687 { 688 nlmsg_trim(skb, nlh); 689 } 690 691 /** 692 * nlmsg_free - free a netlink message 693 * @skb: socket buffer of netlink message 694 */ 695 static inline void nlmsg_free(struct sk_buff *skb) 696 { 697 kfree_skb(skb); 698 } 699 700 /** 701 * nlmsg_multicast - multicast a netlink message 702 * @sk: netlink socket to spread messages to 703 * @skb: netlink message as socket buffer 704 * @portid: own netlink portid to avoid sending to yourself 705 * @group: multicast group id 706 * @flags: allocation flags 707 */ 708 static inline int nlmsg_multicast(struct sock *sk, struct sk_buff *skb, 709 u32 portid, unsigned int group, gfp_t flags) 710 { 711 int err; 712 713 NETLINK_CB(skb).dst_group = group; 714 715 err = netlink_broadcast(sk, skb, portid, group, flags); 716 if (err > 0) 717 err = 0; 718 719 return err; 720 } 721 722 /** 723 * nlmsg_unicast - unicast a netlink message 724 * @sk: netlink socket to spread message to 725 * @skb: netlink message as socket buffer 726 * @portid: netlink portid of the destination socket 727 */ 728 static inline int nlmsg_unicast(struct sock *sk, struct sk_buff *skb, u32 portid) 729 { 730 int err; 731 732 err = netlink_unicast(sk, skb, portid, MSG_DONTWAIT); 733 if (err > 0) 734 err = 0; 735 736 return err; 737 } 738 739 /** 740 * nlmsg_for_each_msg - iterate over a stream of messages 741 * @pos: loop counter, set to current message 742 * @head: head of message stream 743 * @len: length of message stream 744 * @rem: initialized to len, holds bytes currently remaining in stream 745 */ 746 #define nlmsg_for_each_msg(pos, head, len, rem) \ 747 for (pos = head, rem = len; \ 748 nlmsg_ok(pos, rem); \ 749 pos = nlmsg_next(pos, &(rem))) 750 751 /** 752 * nl_dump_check_consistent - check if sequence is consistent and advertise if not 753 * @cb: netlink callback structure that stores the sequence number 754 * @nlh: netlink message header to write the flag to 755 * 756 * This function checks if the sequence (generation) number changed during dump 757 * and if it did, advertises it in the netlink message header. 758 * 759 * The correct way to use it is to set cb->seq to the generation counter when 760 * all locks for dumping have been acquired, and then call this function for 761 * each message that is generated. 762 * 763 * Note that due to initialisation concerns, 0 is an invalid sequence number 764 * and must not be used by code that uses this functionality. 765 */ 766 static inline void 767 nl_dump_check_consistent(struct netlink_callback *cb, 768 struct nlmsghdr *nlh) 769 { 770 if (cb->prev_seq && cb->seq != cb->prev_seq) 771 nlh->nlmsg_flags |= NLM_F_DUMP_INTR; 772 cb->prev_seq = cb->seq; 773 } 774 775 /************************************************************************** 776 * Netlink Attributes 777 **************************************************************************/ 778 779 /** 780 * nla_attr_size - length of attribute not including padding 781 * @payload: length of payload 782 */ 783 static inline int nla_attr_size(int payload) 784 { 785 return NLA_HDRLEN + payload; 786 } 787 788 /** 789 * nla_total_size - total length of attribute including padding 790 * @payload: length of payload 791 */ 792 static inline int nla_total_size(int payload) 793 { 794 return NLA_ALIGN(nla_attr_size(payload)); 795 } 796 797 /** 798 * nla_padlen - length of padding at the tail of attribute 799 * @payload: length of payload 800 */ 801 static inline int nla_padlen(int payload) 802 { 803 return nla_total_size(payload) - nla_attr_size(payload); 804 } 805 806 /** 807 * nla_type - attribute type 808 * @nla: netlink attribute 809 */ 810 static inline int nla_type(const struct nlattr *nla) 811 { 812 return nla->nla_type & NLA_TYPE_MASK; 813 } 814 815 /** 816 * nla_data - head of payload 817 * @nla: netlink attribute 818 */ 819 static inline void *nla_data(const struct nlattr *nla) 820 { 821 return (char *) nla + NLA_HDRLEN; 822 } 823 824 /** 825 * nla_len - length of payload 826 * @nla: netlink attribute 827 */ 828 static inline int nla_len(const struct nlattr *nla) 829 { 830 return nla->nla_len - NLA_HDRLEN; 831 } 832 833 /** 834 * nla_ok - check if the netlink attribute fits into the remaining bytes 835 * @nla: netlink attribute 836 * @remaining: number of bytes remaining in attribute stream 837 */ 838 static inline int nla_ok(const struct nlattr *nla, int remaining) 839 { 840 return remaining >= (int) sizeof(*nla) && 841 nla->nla_len >= sizeof(*nla) && 842 nla->nla_len <= remaining; 843 } 844 845 /** 846 * nla_next - next netlink attribute in attribute stream 847 * @nla: netlink attribute 848 * @remaining: number of bytes remaining in attribute stream 849 * 850 * Returns the next netlink attribute in the attribute stream and 851 * decrements remaining by the size of the current attribute. 852 */ 853 static inline struct nlattr *nla_next(const struct nlattr *nla, int *remaining) 854 { 855 unsigned int totlen = NLA_ALIGN(nla->nla_len); 856 857 *remaining -= totlen; 858 return (struct nlattr *) ((char *) nla + totlen); 859 } 860 861 /** 862 * nla_find_nested - find attribute in a set of nested attributes 863 * @nla: attribute containing the nested attributes 864 * @attrtype: type of attribute to look for 865 * 866 * Returns the first attribute which matches the specified type. 867 */ 868 static inline struct nlattr * 869 nla_find_nested(const struct nlattr *nla, int attrtype) 870 { 871 return nla_find(nla_data(nla), nla_len(nla), attrtype); 872 } 873 874 /** 875 * nla_parse_nested - parse nested attributes 876 * @tb: destination array with maxtype+1 elements 877 * @maxtype: maximum attribute type to be expected 878 * @nla: attribute containing the nested attributes 879 * @policy: validation policy 880 * @extack: extended ACK report struct 881 * 882 * See nla_parse() 883 */ 884 static inline int nla_parse_nested(struct nlattr *tb[], int maxtype, 885 const struct nlattr *nla, 886 const struct nla_policy *policy, 887 struct netlink_ext_ack *extack) 888 { 889 return nla_parse(tb, maxtype, nla_data(nla), nla_len(nla), policy, 890 extack); 891 } 892 893 /** 894 * nla_put_u8 - Add a u8 netlink attribute to a socket buffer 895 * @skb: socket buffer to add attribute to 896 * @attrtype: attribute type 897 * @value: numeric value 898 */ 899 static inline int nla_put_u8(struct sk_buff *skb, int attrtype, u8 value) 900 { 901 /* temporary variables to work around GCC PR81715 with asan-stack=1 */ 902 u8 tmp = value; 903 904 return nla_put(skb, attrtype, sizeof(u8), &tmp); 905 } 906 907 /** 908 * nla_put_u16 - Add a u16 netlink attribute to a socket buffer 909 * @skb: socket buffer to add attribute to 910 * @attrtype: attribute type 911 * @value: numeric value 912 */ 913 static inline int nla_put_u16(struct sk_buff *skb, int attrtype, u16 value) 914 { 915 u16 tmp = value; 916 917 return nla_put(skb, attrtype, sizeof(u16), &tmp); 918 } 919 920 /** 921 * nla_put_be16 - Add a __be16 netlink attribute to a socket buffer 922 * @skb: socket buffer to add attribute to 923 * @attrtype: attribute type 924 * @value: numeric value 925 */ 926 static inline int nla_put_be16(struct sk_buff *skb, int attrtype, __be16 value) 927 { 928 __be16 tmp = value; 929 930 return nla_put(skb, attrtype, sizeof(__be16), &tmp); 931 } 932 933 /** 934 * nla_put_net16 - Add 16-bit network byte order netlink attribute to a socket buffer 935 * @skb: socket buffer to add attribute to 936 * @attrtype: attribute type 937 * @value: numeric value 938 */ 939 static inline int nla_put_net16(struct sk_buff *skb, int attrtype, __be16 value) 940 { 941 __be16 tmp = value; 942 943 return nla_put_be16(skb, attrtype | NLA_F_NET_BYTEORDER, tmp); 944 } 945 946 /** 947 * nla_put_le16 - Add a __le16 netlink attribute to a socket buffer 948 * @skb: socket buffer to add attribute to 949 * @attrtype: attribute type 950 * @value: numeric value 951 */ 952 static inline int nla_put_le16(struct sk_buff *skb, int attrtype, __le16 value) 953 { 954 __le16 tmp = value; 955 956 return nla_put(skb, attrtype, sizeof(__le16), &tmp); 957 } 958 959 /** 960 * nla_put_u32 - Add a u32 netlink attribute to a socket buffer 961 * @skb: socket buffer to add attribute to 962 * @attrtype: attribute type 963 * @value: numeric value 964 */ 965 static inline int nla_put_u32(struct sk_buff *skb, int attrtype, u32 value) 966 { 967 u32 tmp = value; 968 969 return nla_put(skb, attrtype, sizeof(u32), &tmp); 970 } 971 972 /** 973 * nla_put_be32 - Add a __be32 netlink attribute to a socket buffer 974 * @skb: socket buffer to add attribute to 975 * @attrtype: attribute type 976 * @value: numeric value 977 */ 978 static inline int nla_put_be32(struct sk_buff *skb, int attrtype, __be32 value) 979 { 980 __be32 tmp = value; 981 982 return nla_put(skb, attrtype, sizeof(__be32), &tmp); 983 } 984 985 /** 986 * nla_put_net32 - Add 32-bit network byte order netlink attribute to a socket buffer 987 * @skb: socket buffer to add attribute to 988 * @attrtype: attribute type 989 * @value: numeric value 990 */ 991 static inline int nla_put_net32(struct sk_buff *skb, int attrtype, __be32 value) 992 { 993 __be32 tmp = value; 994 995 return nla_put_be32(skb, attrtype | NLA_F_NET_BYTEORDER, tmp); 996 } 997 998 /** 999 * nla_put_le32 - Add a __le32 netlink attribute to a socket buffer 1000 * @skb: socket buffer to add attribute to 1001 * @attrtype: attribute type 1002 * @value: numeric value 1003 */ 1004 static inline int nla_put_le32(struct sk_buff *skb, int attrtype, __le32 value) 1005 { 1006 __le32 tmp = value; 1007 1008 return nla_put(skb, attrtype, sizeof(__le32), &tmp); 1009 } 1010 1011 /** 1012 * nla_put_u64_64bit - Add a u64 netlink attribute to a skb and align it 1013 * @skb: socket buffer to add attribute to 1014 * @attrtype: attribute type 1015 * @value: numeric value 1016 * @padattr: attribute type for the padding 1017 */ 1018 static inline int nla_put_u64_64bit(struct sk_buff *skb, int attrtype, 1019 u64 value, int padattr) 1020 { 1021 u64 tmp = value; 1022 1023 return nla_put_64bit(skb, attrtype, sizeof(u64), &tmp, padattr); 1024 } 1025 1026 /** 1027 * nla_put_be64 - Add a __be64 netlink attribute to a socket buffer and align it 1028 * @skb: socket buffer to add attribute to 1029 * @attrtype: attribute type 1030 * @value: numeric value 1031 * @padattr: attribute type for the padding 1032 */ 1033 static inline int nla_put_be64(struct sk_buff *skb, int attrtype, __be64 value, 1034 int padattr) 1035 { 1036 __be64 tmp = value; 1037 1038 return nla_put_64bit(skb, attrtype, sizeof(__be64), &tmp, padattr); 1039 } 1040 1041 /** 1042 * nla_put_net64 - Add 64-bit network byte order nlattr to a skb and align it 1043 * @skb: socket buffer to add attribute to 1044 * @attrtype: attribute type 1045 * @value: numeric value 1046 * @padattr: attribute type for the padding 1047 */ 1048 static inline int nla_put_net64(struct sk_buff *skb, int attrtype, __be64 value, 1049 int padattr) 1050 { 1051 __be64 tmp = value; 1052 1053 return nla_put_be64(skb, attrtype | NLA_F_NET_BYTEORDER, tmp, 1054 padattr); 1055 } 1056 1057 /** 1058 * nla_put_le64 - Add a __le64 netlink attribute to a socket buffer and align it 1059 * @skb: socket buffer to add attribute to 1060 * @attrtype: attribute type 1061 * @value: numeric value 1062 * @padattr: attribute type for the padding 1063 */ 1064 static inline int nla_put_le64(struct sk_buff *skb, int attrtype, __le64 value, 1065 int padattr) 1066 { 1067 __le64 tmp = value; 1068 1069 return nla_put_64bit(skb, attrtype, sizeof(__le64), &tmp, padattr); 1070 } 1071 1072 /** 1073 * nla_put_s8 - Add a s8 netlink attribute to a socket buffer 1074 * @skb: socket buffer to add attribute to 1075 * @attrtype: attribute type 1076 * @value: numeric value 1077 */ 1078 static inline int nla_put_s8(struct sk_buff *skb, int attrtype, s8 value) 1079 { 1080 s8 tmp = value; 1081 1082 return nla_put(skb, attrtype, sizeof(s8), &tmp); 1083 } 1084 1085 /** 1086 * nla_put_s16 - Add a s16 netlink attribute to a socket buffer 1087 * @skb: socket buffer to add attribute to 1088 * @attrtype: attribute type 1089 * @value: numeric value 1090 */ 1091 static inline int nla_put_s16(struct sk_buff *skb, int attrtype, s16 value) 1092 { 1093 s16 tmp = value; 1094 1095 return nla_put(skb, attrtype, sizeof(s16), &tmp); 1096 } 1097 1098 /** 1099 * nla_put_s32 - Add a s32 netlink attribute to a socket buffer 1100 * @skb: socket buffer to add attribute to 1101 * @attrtype: attribute type 1102 * @value: numeric value 1103 */ 1104 static inline int nla_put_s32(struct sk_buff *skb, int attrtype, s32 value) 1105 { 1106 s32 tmp = value; 1107 1108 return nla_put(skb, attrtype, sizeof(s32), &tmp); 1109 } 1110 1111 /** 1112 * nla_put_s64 - Add a s64 netlink attribute to a socket buffer and align it 1113 * @skb: socket buffer to add attribute to 1114 * @attrtype: attribute type 1115 * @value: numeric value 1116 * @padattr: attribute type for the padding 1117 */ 1118 static inline int nla_put_s64(struct sk_buff *skb, int attrtype, s64 value, 1119 int padattr) 1120 { 1121 s64 tmp = value; 1122 1123 return nla_put_64bit(skb, attrtype, sizeof(s64), &tmp, padattr); 1124 } 1125 1126 /** 1127 * nla_put_string - Add a string netlink attribute to a socket buffer 1128 * @skb: socket buffer to add attribute to 1129 * @attrtype: attribute type 1130 * @str: NUL terminated string 1131 */ 1132 static inline int nla_put_string(struct sk_buff *skb, int attrtype, 1133 const char *str) 1134 { 1135 return nla_put(skb, attrtype, strlen(str) + 1, str); 1136 } 1137 1138 /** 1139 * nla_put_flag - Add a flag netlink attribute to a socket buffer 1140 * @skb: socket buffer to add attribute to 1141 * @attrtype: attribute type 1142 */ 1143 static inline int nla_put_flag(struct sk_buff *skb, int attrtype) 1144 { 1145 return nla_put(skb, attrtype, 0, NULL); 1146 } 1147 1148 /** 1149 * nla_put_msecs - Add a msecs netlink attribute to a skb and align it 1150 * @skb: socket buffer to add attribute to 1151 * @attrtype: attribute type 1152 * @njiffies: number of jiffies to convert to msecs 1153 * @padattr: attribute type for the padding 1154 */ 1155 static inline int nla_put_msecs(struct sk_buff *skb, int attrtype, 1156 unsigned long njiffies, int padattr) 1157 { 1158 u64 tmp = jiffies_to_msecs(njiffies); 1159 1160 return nla_put_64bit(skb, attrtype, sizeof(u64), &tmp, padattr); 1161 } 1162 1163 /** 1164 * nla_put_in_addr - Add an IPv4 address netlink attribute to a socket 1165 * buffer 1166 * @skb: socket buffer to add attribute to 1167 * @attrtype: attribute type 1168 * @addr: IPv4 address 1169 */ 1170 static inline int nla_put_in_addr(struct sk_buff *skb, int attrtype, 1171 __be32 addr) 1172 { 1173 __be32 tmp = addr; 1174 1175 return nla_put_be32(skb, attrtype, tmp); 1176 } 1177 1178 /** 1179 * nla_put_in6_addr - Add an IPv6 address netlink attribute to a socket 1180 * buffer 1181 * @skb: socket buffer to add attribute to 1182 * @attrtype: attribute type 1183 * @addr: IPv6 address 1184 */ 1185 static inline int nla_put_in6_addr(struct sk_buff *skb, int attrtype, 1186 const struct in6_addr *addr) 1187 { 1188 return nla_put(skb, attrtype, sizeof(*addr), addr); 1189 } 1190 1191 /** 1192 * nla_get_u32 - return payload of u32 attribute 1193 * @nla: u32 netlink attribute 1194 */ 1195 static inline u32 nla_get_u32(const struct nlattr *nla) 1196 { 1197 return *(u32 *) nla_data(nla); 1198 } 1199 1200 /** 1201 * nla_get_be32 - return payload of __be32 attribute 1202 * @nla: __be32 netlink attribute 1203 */ 1204 static inline __be32 nla_get_be32(const struct nlattr *nla) 1205 { 1206 return *(__be32 *) nla_data(nla); 1207 } 1208 1209 /** 1210 * nla_get_le32 - return payload of __le32 attribute 1211 * @nla: __le32 netlink attribute 1212 */ 1213 static inline __le32 nla_get_le32(const struct nlattr *nla) 1214 { 1215 return *(__le32 *) nla_data(nla); 1216 } 1217 1218 /** 1219 * nla_get_u16 - return payload of u16 attribute 1220 * @nla: u16 netlink attribute 1221 */ 1222 static inline u16 nla_get_u16(const struct nlattr *nla) 1223 { 1224 return *(u16 *) nla_data(nla); 1225 } 1226 1227 /** 1228 * nla_get_be16 - return payload of __be16 attribute 1229 * @nla: __be16 netlink attribute 1230 */ 1231 static inline __be16 nla_get_be16(const struct nlattr *nla) 1232 { 1233 return *(__be16 *) nla_data(nla); 1234 } 1235 1236 /** 1237 * nla_get_le16 - return payload of __le16 attribute 1238 * @nla: __le16 netlink attribute 1239 */ 1240 static inline __le16 nla_get_le16(const struct nlattr *nla) 1241 { 1242 return *(__le16 *) nla_data(nla); 1243 } 1244 1245 /** 1246 * nla_get_u8 - return payload of u8 attribute 1247 * @nla: u8 netlink attribute 1248 */ 1249 static inline u8 nla_get_u8(const struct nlattr *nla) 1250 { 1251 return *(u8 *) nla_data(nla); 1252 } 1253 1254 /** 1255 * nla_get_u64 - return payload of u64 attribute 1256 * @nla: u64 netlink attribute 1257 */ 1258 static inline u64 nla_get_u64(const struct nlattr *nla) 1259 { 1260 u64 tmp; 1261 1262 nla_memcpy(&tmp, nla, sizeof(tmp)); 1263 1264 return tmp; 1265 } 1266 1267 /** 1268 * nla_get_be64 - return payload of __be64 attribute 1269 * @nla: __be64 netlink attribute 1270 */ 1271 static inline __be64 nla_get_be64(const struct nlattr *nla) 1272 { 1273 __be64 tmp; 1274 1275 nla_memcpy(&tmp, nla, sizeof(tmp)); 1276 1277 return tmp; 1278 } 1279 1280 /** 1281 * nla_get_le64 - return payload of __le64 attribute 1282 * @nla: __le64 netlink attribute 1283 */ 1284 static inline __le64 nla_get_le64(const struct nlattr *nla) 1285 { 1286 return *(__le64 *) nla_data(nla); 1287 } 1288 1289 /** 1290 * nla_get_s32 - return payload of s32 attribute 1291 * @nla: s32 netlink attribute 1292 */ 1293 static inline s32 nla_get_s32(const struct nlattr *nla) 1294 { 1295 return *(s32 *) nla_data(nla); 1296 } 1297 1298 /** 1299 * nla_get_s16 - return payload of s16 attribute 1300 * @nla: s16 netlink attribute 1301 */ 1302 static inline s16 nla_get_s16(const struct nlattr *nla) 1303 { 1304 return *(s16 *) nla_data(nla); 1305 } 1306 1307 /** 1308 * nla_get_s8 - return payload of s8 attribute 1309 * @nla: s8 netlink attribute 1310 */ 1311 static inline s8 nla_get_s8(const struct nlattr *nla) 1312 { 1313 return *(s8 *) nla_data(nla); 1314 } 1315 1316 /** 1317 * nla_get_s64 - return payload of s64 attribute 1318 * @nla: s64 netlink attribute 1319 */ 1320 static inline s64 nla_get_s64(const struct nlattr *nla) 1321 { 1322 s64 tmp; 1323 1324 nla_memcpy(&tmp, nla, sizeof(tmp)); 1325 1326 return tmp; 1327 } 1328 1329 /** 1330 * nla_get_flag - return payload of flag attribute 1331 * @nla: flag netlink attribute 1332 */ 1333 static inline int nla_get_flag(const struct nlattr *nla) 1334 { 1335 return !!nla; 1336 } 1337 1338 /** 1339 * nla_get_msecs - return payload of msecs attribute 1340 * @nla: msecs netlink attribute 1341 * 1342 * Returns the number of milliseconds in jiffies. 1343 */ 1344 static inline unsigned long nla_get_msecs(const struct nlattr *nla) 1345 { 1346 u64 msecs = nla_get_u64(nla); 1347 1348 return msecs_to_jiffies((unsigned long) msecs); 1349 } 1350 1351 /** 1352 * nla_get_in_addr - return payload of IPv4 address attribute 1353 * @nla: IPv4 address netlink attribute 1354 */ 1355 static inline __be32 nla_get_in_addr(const struct nlattr *nla) 1356 { 1357 return *(__be32 *) nla_data(nla); 1358 } 1359 1360 /** 1361 * nla_get_in6_addr - return payload of IPv6 address attribute 1362 * @nla: IPv6 address netlink attribute 1363 */ 1364 static inline struct in6_addr nla_get_in6_addr(const struct nlattr *nla) 1365 { 1366 struct in6_addr tmp; 1367 1368 nla_memcpy(&tmp, nla, sizeof(tmp)); 1369 return tmp; 1370 } 1371 1372 /** 1373 * nla_get_bitfield32 - return payload of 32 bitfield attribute 1374 * @nla: nla_bitfield32 attribute 1375 */ 1376 static inline struct nla_bitfield32 nla_get_bitfield32(const struct nlattr *nla) 1377 { 1378 struct nla_bitfield32 tmp; 1379 1380 nla_memcpy(&tmp, nla, sizeof(tmp)); 1381 return tmp; 1382 } 1383 1384 /** 1385 * nla_memdup - duplicate attribute memory (kmemdup) 1386 * @src: netlink attribute to duplicate from 1387 * @gfp: GFP mask 1388 */ 1389 static inline void *nla_memdup(const struct nlattr *src, gfp_t gfp) 1390 { 1391 return kmemdup(nla_data(src), nla_len(src), gfp); 1392 } 1393 1394 /** 1395 * nla_nest_start - Start a new level of nested attributes 1396 * @skb: socket buffer to add attributes to 1397 * @attrtype: attribute type of container 1398 * 1399 * Returns the container attribute 1400 */ 1401 static inline struct nlattr *nla_nest_start(struct sk_buff *skb, int attrtype) 1402 { 1403 struct nlattr *start = (struct nlattr *)skb_tail_pointer(skb); 1404 1405 if (nla_put(skb, attrtype, 0, NULL) < 0) 1406 return NULL; 1407 1408 return start; 1409 } 1410 1411 /** 1412 * nla_nest_end - Finalize nesting of attributes 1413 * @skb: socket buffer the attributes are stored in 1414 * @start: container attribute 1415 * 1416 * Corrects the container attribute header to include the all 1417 * appeneded attributes. 1418 * 1419 * Returns the total data length of the skb. 1420 */ 1421 static inline int nla_nest_end(struct sk_buff *skb, struct nlattr *start) 1422 { 1423 start->nla_len = skb_tail_pointer(skb) - (unsigned char *)start; 1424 return skb->len; 1425 } 1426 1427 /** 1428 * nla_nest_cancel - Cancel nesting of attributes 1429 * @skb: socket buffer the message is stored in 1430 * @start: container attribute 1431 * 1432 * Removes the container attribute and including all nested 1433 * attributes. Returns -EMSGSIZE 1434 */ 1435 static inline void nla_nest_cancel(struct sk_buff *skb, struct nlattr *start) 1436 { 1437 nlmsg_trim(skb, start); 1438 } 1439 1440 /** 1441 * nla_validate_nested - Validate a stream of nested attributes 1442 * @start: container attribute 1443 * @maxtype: maximum attribute type to be expected 1444 * @policy: validation policy 1445 * @extack: extended ACK report struct 1446 * 1447 * Validates all attributes in the nested attribute stream against the 1448 * specified policy. Attributes with a type exceeding maxtype will be 1449 * ignored. See documenation of struct nla_policy for more details. 1450 * 1451 * Returns 0 on success or a negative error code. 1452 */ 1453 static inline int nla_validate_nested(const struct nlattr *start, int maxtype, 1454 const struct nla_policy *policy, 1455 struct netlink_ext_ack *extack) 1456 { 1457 return nla_validate(nla_data(start), nla_len(start), maxtype, policy, 1458 extack); 1459 } 1460 1461 /** 1462 * nla_need_padding_for_64bit - test 64-bit alignment of the next attribute 1463 * @skb: socket buffer the message is stored in 1464 * 1465 * Return true if padding is needed to align the next attribute (nla_data()) to 1466 * a 64-bit aligned area. 1467 */ 1468 static inline bool nla_need_padding_for_64bit(struct sk_buff *skb) 1469 { 1470 #ifndef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS 1471 /* The nlattr header is 4 bytes in size, that's why we test 1472 * if the skb->data _is_ aligned. A NOP attribute, plus 1473 * nlattr header for next attribute, will make nla_data() 1474 * 8-byte aligned. 1475 */ 1476 if (IS_ALIGNED((unsigned long)skb_tail_pointer(skb), 8)) 1477 return true; 1478 #endif 1479 return false; 1480 } 1481 1482 /** 1483 * nla_align_64bit - 64-bit align the nla_data() of next attribute 1484 * @skb: socket buffer the message is stored in 1485 * @padattr: attribute type for the padding 1486 * 1487 * Conditionally emit a padding netlink attribute in order to make 1488 * the next attribute we emit have a 64-bit aligned nla_data() area. 1489 * This will only be done in architectures which do not have 1490 * CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS defined. 1491 * 1492 * Returns zero on success or a negative error code. 1493 */ 1494 static inline int nla_align_64bit(struct sk_buff *skb, int padattr) 1495 { 1496 if (nla_need_padding_for_64bit(skb) && 1497 !nla_reserve(skb, padattr, 0)) 1498 return -EMSGSIZE; 1499 1500 return 0; 1501 } 1502 1503 /** 1504 * nla_total_size_64bit - total length of attribute including padding 1505 * @payload: length of payload 1506 */ 1507 static inline int nla_total_size_64bit(int payload) 1508 { 1509 return NLA_ALIGN(nla_attr_size(payload)) 1510 #ifndef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS 1511 + NLA_ALIGN(nla_attr_size(0)) 1512 #endif 1513 ; 1514 } 1515 1516 /** 1517 * nla_for_each_attr - iterate over a stream of attributes 1518 * @pos: loop counter, set to current attribute 1519 * @head: head of attribute stream 1520 * @len: length of attribute stream 1521 * @rem: initialized to len, holds bytes currently remaining in stream 1522 */ 1523 #define nla_for_each_attr(pos, head, len, rem) \ 1524 for (pos = head, rem = len; \ 1525 nla_ok(pos, rem); \ 1526 pos = nla_next(pos, &(rem))) 1527 1528 /** 1529 * nla_for_each_nested - iterate over nested attributes 1530 * @pos: loop counter, set to current attribute 1531 * @nla: attribute containing the nested attributes 1532 * @rem: initialized to len, holds bytes currently remaining in stream 1533 */ 1534 #define nla_for_each_nested(pos, nla, rem) \ 1535 nla_for_each_attr(pos, nla_data(nla), nla_len(nla), rem) 1536 1537 /** 1538 * nla_is_last - Test if attribute is last in stream 1539 * @nla: attribute to test 1540 * @rem: bytes remaining in stream 1541 */ 1542 static inline bool nla_is_last(const struct nlattr *nla, int rem) 1543 { 1544 return nla->nla_len == rem; 1545 } 1546 1547 #endif 1548