1#ifndef __NET_NETLINK_H 2#define __NET_NETLINK_H 3 4#include <linux/types.h> 5#include <linux/netlink.h> 6#include <linux/jiffies.h> 7#include <linux/in6.h> 8 9/* ======================================================================== 10 * Netlink Messages and Attributes Interface (As Seen On TV) 11 * ------------------------------------------------------------------------ 12 * Messages Interface 13 * ------------------------------------------------------------------------ 14 * 15 * Message Format: 16 * <--- nlmsg_total_size(payload) ---> 17 * <-- nlmsg_msg_size(payload) -> 18 * +----------+- - -+-------------+- - -+-------- - - 19 * | nlmsghdr | Pad | Payload | Pad | nlmsghdr 20 * +----------+- - -+-------------+- - -+-------- - - 21 * nlmsg_data(nlh)---^ ^ 22 * nlmsg_next(nlh)-----------------------+ 23 * 24 * Payload Format: 25 * <---------------------- nlmsg_len(nlh) ---------------------> 26 * <------ hdrlen ------> <- nlmsg_attrlen(nlh, hdrlen) -> 27 * +----------------------+- - -+--------------------------------+ 28 * | Family Header | Pad | Attributes | 29 * +----------------------+- - -+--------------------------------+ 30 * nlmsg_attrdata(nlh, hdrlen)---^ 31 * 32 * Data Structures: 33 * struct nlmsghdr netlink message header 34 * 35 * Message Construction: 36 * nlmsg_new() create a new netlink message 37 * nlmsg_put() add a netlink message to an skb 38 * nlmsg_put_answer() callback based nlmsg_put() 39 * nlmsg_end() finalize netlink message 40 * nlmsg_get_pos() return current position in message 41 * nlmsg_trim() trim part of message 42 * nlmsg_cancel() cancel message construction 43 * nlmsg_free() free a netlink message 44 * 45 * Message Sending: 46 * nlmsg_multicast() multicast message to several groups 47 * nlmsg_unicast() unicast a message to a single socket 48 * nlmsg_notify() send notification message 49 * 50 * Message Length Calculations: 51 * nlmsg_msg_size(payload) length of message w/o padding 52 * nlmsg_total_size(payload) length of message w/ padding 53 * nlmsg_padlen(payload) length of padding at tail 54 * 55 * Message Payload Access: 56 * nlmsg_data(nlh) head of message payload 57 * nlmsg_len(nlh) length of message payload 58 * nlmsg_attrdata(nlh, hdrlen) head of attributes data 59 * nlmsg_attrlen(nlh, hdrlen) length of attributes data 60 * 61 * Message Parsing: 62 * nlmsg_ok(nlh, remaining) does nlh fit into remaining bytes? 63 * nlmsg_next(nlh, remaining) get next netlink message 64 * nlmsg_parse() parse attributes of a message 65 * nlmsg_find_attr() find an attribute in a message 66 * nlmsg_for_each_msg() loop over all messages 67 * nlmsg_validate() validate netlink message incl. attrs 68 * nlmsg_for_each_attr() loop over all attributes 69 * 70 * Misc: 71 * nlmsg_report() report back to application? 72 * 73 * ------------------------------------------------------------------------ 74 * Attributes Interface 75 * ------------------------------------------------------------------------ 76 * 77 * Attribute Format: 78 * <------- nla_total_size(payload) -------> 79 * <---- nla_attr_size(payload) -----> 80 * +----------+- - -+- - - - - - - - - +- - -+-------- - - 81 * | Header | Pad | Payload | Pad | Header 82 * +----------+- - -+- - - - - - - - - +- - -+-------- - - 83 * <- nla_len(nla) -> ^ 84 * nla_data(nla)----^ | 85 * nla_next(nla)-----------------------------' 86 * 87 * Data Structures: 88 * struct nlattr netlink attribute header 89 * 90 * Attribute Construction: 91 * nla_reserve(skb, type, len) reserve room for an attribute 92 * nla_reserve_nohdr(skb, len) reserve room for an attribute w/o hdr 93 * nla_put(skb, type, len, data) add attribute to skb 94 * nla_put_nohdr(skb, len, data) add attribute w/o hdr 95 * nla_append(skb, len, data) append data to skb 96 * 97 * Attribute Construction for Basic Types: 98 * nla_put_u8(skb, type, value) add u8 attribute to skb 99 * nla_put_u16(skb, type, value) add u16 attribute to skb 100 * nla_put_u32(skb, type, value) add u32 attribute to skb 101 * nla_put_u64_64bits(skb, type, 102 * value, padattr) add u64 attribute to skb 103 * nla_put_s8(skb, type, value) add s8 attribute to skb 104 * nla_put_s16(skb, type, value) add s16 attribute to skb 105 * nla_put_s32(skb, type, value) add s32 attribute to skb 106 * nla_put_s64(skb, type, value, 107 * padattr) add s64 attribute to skb 108 * nla_put_string(skb, type, str) add string attribute to skb 109 * nla_put_flag(skb, type) add flag attribute to skb 110 * nla_put_msecs(skb, type, jiffies, 111 * padattr) add msecs attribute to skb 112 * nla_put_in_addr(skb, type, addr) add IPv4 address attribute to skb 113 * nla_put_in6_addr(skb, type, addr) add IPv6 address attribute to skb 114 * 115 * Nested Attributes Construction: 116 * nla_nest_start(skb, type) start a nested attribute 117 * nla_nest_end(skb, nla) finalize a nested attribute 118 * nla_nest_cancel(skb, nla) cancel nested attribute construction 119 * 120 * Attribute Length Calculations: 121 * nla_attr_size(payload) length of attribute w/o padding 122 * nla_total_size(payload) length of attribute w/ padding 123 * nla_padlen(payload) length of padding 124 * 125 * Attribute Payload Access: 126 * nla_data(nla) head of attribute payload 127 * nla_len(nla) length of attribute payload 128 * 129 * Attribute Payload Access for Basic Types: 130 * nla_get_u8(nla) get payload for a u8 attribute 131 * nla_get_u16(nla) get payload for a u16 attribute 132 * nla_get_u32(nla) get payload for a u32 attribute 133 * nla_get_u64(nla) get payload for a u64 attribute 134 * nla_get_s8(nla) get payload for a s8 attribute 135 * nla_get_s16(nla) get payload for a s16 attribute 136 * nla_get_s32(nla) get payload for a s32 attribute 137 * nla_get_s64(nla) get payload for a s64 attribute 138 * nla_get_flag(nla) return 1 if flag is true 139 * nla_get_msecs(nla) get payload for a msecs attribute 140 * 141 * Attribute Misc: 142 * nla_memcpy(dest, nla, count) copy attribute into memory 143 * nla_memcmp(nla, data, size) compare attribute with memory area 144 * nla_strlcpy(dst, nla, size) copy attribute to a sized string 145 * nla_strcmp(nla, str) compare attribute with string 146 * 147 * Attribute Parsing: 148 * nla_ok(nla, remaining) does nla fit into remaining bytes? 149 * nla_next(nla, remaining) get next netlink attribute 150 * nla_validate() validate a stream of attributes 151 * nla_validate_nested() validate a stream of nested attributes 152 * nla_find() find attribute in stream of attributes 153 * nla_find_nested() find attribute in nested attributes 154 * nla_parse() parse and validate stream of attrs 155 * nla_parse_nested() parse nested attribuets 156 * nla_for_each_attr() loop over all attributes 157 * nla_for_each_nested() loop over the nested attributes 158 *========================================================================= 159 */ 160 161 /** 162 * Standard attribute types to specify validation policy 163 */ 164enum { 165 NLA_UNSPEC, 166 NLA_U8, 167 NLA_U16, 168 NLA_U32, 169 NLA_U64, 170 NLA_STRING, 171 NLA_FLAG, 172 NLA_MSECS, 173 NLA_NESTED, 174 NLA_NESTED_COMPAT, 175 NLA_NUL_STRING, 176 NLA_BINARY, 177 NLA_S8, 178 NLA_S16, 179 NLA_S32, 180 NLA_S64, 181 __NLA_TYPE_MAX, 182}; 183 184#define NLA_TYPE_MAX (__NLA_TYPE_MAX - 1) 185 186/** 187 * struct nla_policy - attribute validation policy 188 * @type: Type of attribute or NLA_UNSPEC 189 * @len: Type specific length of payload 190 * 191 * Policies are defined as arrays of this struct, the array must be 192 * accessible by attribute type up to the highest identifier to be expected. 193 * 194 * Meaning of `len' field: 195 * NLA_STRING Maximum length of string 196 * NLA_NUL_STRING Maximum length of string (excluding NUL) 197 * NLA_FLAG Unused 198 * NLA_BINARY Maximum length of attribute payload 199 * NLA_NESTED Don't use `len' field -- length verification is 200 * done by checking len of nested header (or empty) 201 * NLA_NESTED_COMPAT Minimum length of structure payload 202 * NLA_U8, NLA_U16, 203 * NLA_U32, NLA_U64, 204 * NLA_S8, NLA_S16, 205 * NLA_S32, NLA_S64, 206 * NLA_MSECS Leaving the length field zero will verify the 207 * given type fits, using it verifies minimum length 208 * just like "All other" 209 * All other Minimum length of attribute payload 210 * 211 * Example: 212 * static const struct nla_policy my_policy[ATTR_MAX+1] = { 213 * [ATTR_FOO] = { .type = NLA_U16 }, 214 * [ATTR_BAR] = { .type = NLA_STRING, .len = BARSIZ }, 215 * [ATTR_BAZ] = { .len = sizeof(struct mystruct) }, 216 * }; 217 */ 218struct nla_policy { 219 u16 type; 220 u16 len; 221}; 222 223/** 224 * struct nl_info - netlink source information 225 * @nlh: Netlink message header of original request 226 * @portid: Netlink PORTID of requesting application 227 */ 228struct nl_info { 229 struct nlmsghdr *nlh; 230 struct net *nl_net; 231 u32 portid; 232 bool skip_notify; 233}; 234 235int netlink_rcv_skb(struct sk_buff *skb, 236 int (*cb)(struct sk_buff *, struct nlmsghdr *)); 237int nlmsg_notify(struct sock *sk, struct sk_buff *skb, u32 portid, 238 unsigned int group, int report, gfp_t flags); 239 240int nla_validate(const struct nlattr *head, int len, int maxtype, 241 const struct nla_policy *policy); 242int nla_parse(struct nlattr **tb, int maxtype, const struct nlattr *head, 243 int len, const struct nla_policy *policy); 244int nla_policy_len(const struct nla_policy *, int); 245struct nlattr *nla_find(const struct nlattr *head, int len, int attrtype); 246size_t nla_strlcpy(char *dst, const struct nlattr *nla, size_t dstsize); 247int nla_memcpy(void *dest, const struct nlattr *src, int count); 248int nla_memcmp(const struct nlattr *nla, const void *data, size_t size); 249int nla_strcmp(const struct nlattr *nla, const char *str); 250struct nlattr *__nla_reserve(struct sk_buff *skb, int attrtype, int attrlen); 251struct nlattr *__nla_reserve_64bit(struct sk_buff *skb, int attrtype, 252 int attrlen, int padattr); 253void *__nla_reserve_nohdr(struct sk_buff *skb, int attrlen); 254struct nlattr *nla_reserve(struct sk_buff *skb, int attrtype, int attrlen); 255struct nlattr *nla_reserve_64bit(struct sk_buff *skb, int attrtype, 256 int attrlen, int padattr); 257void *nla_reserve_nohdr(struct sk_buff *skb, int attrlen); 258void __nla_put(struct sk_buff *skb, int attrtype, int attrlen, 259 const void *data); 260void __nla_put_64bit(struct sk_buff *skb, int attrtype, int attrlen, 261 const void *data, int padattr); 262void __nla_put_nohdr(struct sk_buff *skb, int attrlen, const void *data); 263int nla_put(struct sk_buff *skb, int attrtype, int attrlen, const void *data); 264int nla_put_64bit(struct sk_buff *skb, int attrtype, int attrlen, 265 const void *data, int padattr); 266int nla_put_nohdr(struct sk_buff *skb, int attrlen, const void *data); 267int nla_append(struct sk_buff *skb, int attrlen, const void *data); 268 269/************************************************************************** 270 * Netlink Messages 271 **************************************************************************/ 272 273/** 274 * nlmsg_msg_size - length of netlink message not including padding 275 * @payload: length of message payload 276 */ 277static inline int nlmsg_msg_size(int payload) 278{ 279 return NLMSG_HDRLEN + payload; 280} 281 282/** 283 * nlmsg_total_size - length of netlink message including padding 284 * @payload: length of message payload 285 */ 286static inline int nlmsg_total_size(int payload) 287{ 288 return NLMSG_ALIGN(nlmsg_msg_size(payload)); 289} 290 291/** 292 * nlmsg_padlen - length of padding at the message's tail 293 * @payload: length of message payload 294 */ 295static inline int nlmsg_padlen(int payload) 296{ 297 return nlmsg_total_size(payload) - nlmsg_msg_size(payload); 298} 299 300/** 301 * nlmsg_data - head of message payload 302 * @nlh: netlink message header 303 */ 304static inline void *nlmsg_data(const struct nlmsghdr *nlh) 305{ 306 return (unsigned char *) nlh + NLMSG_HDRLEN; 307} 308 309/** 310 * nlmsg_len - length of message payload 311 * @nlh: netlink message header 312 */ 313static inline int nlmsg_len(const struct nlmsghdr *nlh) 314{ 315 return nlh->nlmsg_len - NLMSG_HDRLEN; 316} 317 318/** 319 * nlmsg_attrdata - head of attributes data 320 * @nlh: netlink message header 321 * @hdrlen: length of family specific header 322 */ 323static inline struct nlattr *nlmsg_attrdata(const struct nlmsghdr *nlh, 324 int hdrlen) 325{ 326 unsigned char *data = nlmsg_data(nlh); 327 return (struct nlattr *) (data + NLMSG_ALIGN(hdrlen)); 328} 329 330/** 331 * nlmsg_attrlen - length of attributes data 332 * @nlh: netlink message header 333 * @hdrlen: length of family specific header 334 */ 335static inline int nlmsg_attrlen(const struct nlmsghdr *nlh, int hdrlen) 336{ 337 return nlmsg_len(nlh) - NLMSG_ALIGN(hdrlen); 338} 339 340/** 341 * nlmsg_ok - check if the netlink message fits into the remaining bytes 342 * @nlh: netlink message header 343 * @remaining: number of bytes remaining in message stream 344 */ 345static inline int nlmsg_ok(const struct nlmsghdr *nlh, int remaining) 346{ 347 return (remaining >= (int) sizeof(struct nlmsghdr) && 348 nlh->nlmsg_len >= sizeof(struct nlmsghdr) && 349 nlh->nlmsg_len <= remaining); 350} 351 352/** 353 * nlmsg_next - next netlink message in message stream 354 * @nlh: netlink message header 355 * @remaining: number of bytes remaining in message stream 356 * 357 * Returns the next netlink message in the message stream and 358 * decrements remaining by the size of the current message. 359 */ 360static inline struct nlmsghdr * 361nlmsg_next(const struct nlmsghdr *nlh, int *remaining) 362{ 363 int totlen = NLMSG_ALIGN(nlh->nlmsg_len); 364 365 *remaining -= totlen; 366 367 return (struct nlmsghdr *) ((unsigned char *) nlh + totlen); 368} 369 370/** 371 * nlmsg_parse - parse attributes of a netlink message 372 * @nlh: netlink message header 373 * @hdrlen: length of family specific header 374 * @tb: destination array with maxtype+1 elements 375 * @maxtype: maximum attribute type to be expected 376 * @policy: validation policy 377 * 378 * See nla_parse() 379 */ 380static inline int nlmsg_parse(const struct nlmsghdr *nlh, int hdrlen, 381 struct nlattr *tb[], int maxtype, 382 const struct nla_policy *policy) 383{ 384 if (nlh->nlmsg_len < nlmsg_msg_size(hdrlen)) 385 return -EINVAL; 386 387 return nla_parse(tb, maxtype, nlmsg_attrdata(nlh, hdrlen), 388 nlmsg_attrlen(nlh, hdrlen), policy); 389} 390 391/** 392 * nlmsg_find_attr - find a specific attribute in a netlink message 393 * @nlh: netlink message header 394 * @hdrlen: length of familiy specific header 395 * @attrtype: type of attribute to look for 396 * 397 * Returns the first attribute which matches the specified type. 398 */ 399static inline struct nlattr *nlmsg_find_attr(const struct nlmsghdr *nlh, 400 int hdrlen, int attrtype) 401{ 402 return nla_find(nlmsg_attrdata(nlh, hdrlen), 403 nlmsg_attrlen(nlh, hdrlen), attrtype); 404} 405 406/** 407 * nlmsg_validate - validate a netlink message including attributes 408 * @nlh: netlinket message header 409 * @hdrlen: length of familiy specific header 410 * @maxtype: maximum attribute type to be expected 411 * @policy: validation policy 412 */ 413static inline int nlmsg_validate(const struct nlmsghdr *nlh, 414 int hdrlen, int maxtype, 415 const struct nla_policy *policy) 416{ 417 if (nlh->nlmsg_len < nlmsg_msg_size(hdrlen)) 418 return -EINVAL; 419 420 return nla_validate(nlmsg_attrdata(nlh, hdrlen), 421 nlmsg_attrlen(nlh, hdrlen), maxtype, policy); 422} 423 424/** 425 * nlmsg_report - need to report back to application? 426 * @nlh: netlink message header 427 * 428 * Returns 1 if a report back to the application is requested. 429 */ 430static inline int nlmsg_report(const struct nlmsghdr *nlh) 431{ 432 return !!(nlh->nlmsg_flags & NLM_F_ECHO); 433} 434 435/** 436 * nlmsg_for_each_attr - iterate over a stream of attributes 437 * @pos: loop counter, set to current attribute 438 * @nlh: netlink message header 439 * @hdrlen: length of familiy specific header 440 * @rem: initialized to len, holds bytes currently remaining in stream 441 */ 442#define nlmsg_for_each_attr(pos, nlh, hdrlen, rem) \ 443 nla_for_each_attr(pos, nlmsg_attrdata(nlh, hdrlen), \ 444 nlmsg_attrlen(nlh, hdrlen), rem) 445 446/** 447 * nlmsg_put - Add a new netlink message to an skb 448 * @skb: socket buffer to store message in 449 * @portid: netlink PORTID of requesting application 450 * @seq: sequence number of message 451 * @type: message type 452 * @payload: length of message payload 453 * @flags: message flags 454 * 455 * Returns NULL if the tailroom of the skb is insufficient to store 456 * the message header and payload. 457 */ 458static inline struct nlmsghdr *nlmsg_put(struct sk_buff *skb, u32 portid, u32 seq, 459 int type, int payload, int flags) 460{ 461 if (unlikely(skb_tailroom(skb) < nlmsg_total_size(payload))) 462 return NULL; 463 464 return __nlmsg_put(skb, portid, seq, type, payload, flags); 465} 466 467/** 468 * nlmsg_put_answer - Add a new callback based netlink message to an skb 469 * @skb: socket buffer to store message in 470 * @cb: netlink callback 471 * @type: message type 472 * @payload: length of message payload 473 * @flags: message flags 474 * 475 * Returns NULL if the tailroom of the skb is insufficient to store 476 * the message header and payload. 477 */ 478static inline struct nlmsghdr *nlmsg_put_answer(struct sk_buff *skb, 479 struct netlink_callback *cb, 480 int type, int payload, 481 int flags) 482{ 483 return nlmsg_put(skb, NETLINK_CB(cb->skb).portid, cb->nlh->nlmsg_seq, 484 type, payload, flags); 485} 486 487/** 488 * nlmsg_new - Allocate a new netlink message 489 * @payload: size of the message payload 490 * @flags: the type of memory to allocate. 491 * 492 * Use NLMSG_DEFAULT_SIZE if the size of the payload isn't known 493 * and a good default is needed. 494 */ 495static inline struct sk_buff *nlmsg_new(size_t payload, gfp_t flags) 496{ 497 return alloc_skb(nlmsg_total_size(payload), flags); 498} 499 500/** 501 * nlmsg_end - Finalize a netlink message 502 * @skb: socket buffer the message is stored in 503 * @nlh: netlink message header 504 * 505 * Corrects the netlink message header to include the appeneded 506 * attributes. Only necessary if attributes have been added to 507 * the message. 508 */ 509static inline void nlmsg_end(struct sk_buff *skb, struct nlmsghdr *nlh) 510{ 511 nlh->nlmsg_len = skb_tail_pointer(skb) - (unsigned char *)nlh; 512} 513 514/** 515 * nlmsg_get_pos - return current position in netlink message 516 * @skb: socket buffer the message is stored in 517 * 518 * Returns a pointer to the current tail of the message. 519 */ 520static inline void *nlmsg_get_pos(struct sk_buff *skb) 521{ 522 return skb_tail_pointer(skb); 523} 524 525/** 526 * nlmsg_trim - Trim message to a mark 527 * @skb: socket buffer the message is stored in 528 * @mark: mark to trim to 529 * 530 * Trims the message to the provided mark. 531 */ 532static inline void nlmsg_trim(struct sk_buff *skb, const void *mark) 533{ 534 if (mark) { 535 WARN_ON((unsigned char *) mark < skb->data); 536 skb_trim(skb, (unsigned char *) mark - skb->data); 537 } 538} 539 540/** 541 * nlmsg_cancel - Cancel construction of a netlink message 542 * @skb: socket buffer the message is stored in 543 * @nlh: netlink message header 544 * 545 * Removes the complete netlink message including all 546 * attributes from the socket buffer again. 547 */ 548static inline void nlmsg_cancel(struct sk_buff *skb, struct nlmsghdr *nlh) 549{ 550 nlmsg_trim(skb, nlh); 551} 552 553/** 554 * nlmsg_free - free a netlink message 555 * @skb: socket buffer of netlink message 556 */ 557static inline void nlmsg_free(struct sk_buff *skb) 558{ 559 kfree_skb(skb); 560} 561 562/** 563 * nlmsg_multicast - multicast a netlink message 564 * @sk: netlink socket to spread messages to 565 * @skb: netlink message as socket buffer 566 * @portid: own netlink portid to avoid sending to yourself 567 * @group: multicast group id 568 * @flags: allocation flags 569 */ 570static inline int nlmsg_multicast(struct sock *sk, struct sk_buff *skb, 571 u32 portid, unsigned int group, gfp_t flags) 572{ 573 int err; 574 575 NETLINK_CB(skb).dst_group = group; 576 577 err = netlink_broadcast(sk, skb, portid, group, flags); 578 if (err > 0) 579 err = 0; 580 581 return err; 582} 583 584/** 585 * nlmsg_unicast - unicast a netlink message 586 * @sk: netlink socket to spread message to 587 * @skb: netlink message as socket buffer 588 * @portid: netlink portid of the destination socket 589 */ 590static inline int nlmsg_unicast(struct sock *sk, struct sk_buff *skb, u32 portid) 591{ 592 int err; 593 594 err = netlink_unicast(sk, skb, portid, MSG_DONTWAIT); 595 if (err > 0) 596 err = 0; 597 598 return err; 599} 600 601/** 602 * nlmsg_for_each_msg - iterate over a stream of messages 603 * @pos: loop counter, set to current message 604 * @head: head of message stream 605 * @len: length of message stream 606 * @rem: initialized to len, holds bytes currently remaining in stream 607 */ 608#define nlmsg_for_each_msg(pos, head, len, rem) \ 609 for (pos = head, rem = len; \ 610 nlmsg_ok(pos, rem); \ 611 pos = nlmsg_next(pos, &(rem))) 612 613/** 614 * nl_dump_check_consistent - check if sequence is consistent and advertise if not 615 * @cb: netlink callback structure that stores the sequence number 616 * @nlh: netlink message header to write the flag to 617 * 618 * This function checks if the sequence (generation) number changed during dump 619 * and if it did, advertises it in the netlink message header. 620 * 621 * The correct way to use it is to set cb->seq to the generation counter when 622 * all locks for dumping have been acquired, and then call this function for 623 * each message that is generated. 624 * 625 * Note that due to initialisation concerns, 0 is an invalid sequence number 626 * and must not be used by code that uses this functionality. 627 */ 628static inline void 629nl_dump_check_consistent(struct netlink_callback *cb, 630 struct nlmsghdr *nlh) 631{ 632 if (cb->prev_seq && cb->seq != cb->prev_seq) 633 nlh->nlmsg_flags |= NLM_F_DUMP_INTR; 634 cb->prev_seq = cb->seq; 635} 636 637/************************************************************************** 638 * Netlink Attributes 639 **************************************************************************/ 640 641/** 642 * nla_attr_size - length of attribute not including padding 643 * @payload: length of payload 644 */ 645static inline int nla_attr_size(int payload) 646{ 647 return NLA_HDRLEN + payload; 648} 649 650/** 651 * nla_total_size - total length of attribute including padding 652 * @payload: length of payload 653 */ 654static inline int nla_total_size(int payload) 655{ 656 return NLA_ALIGN(nla_attr_size(payload)); 657} 658 659/** 660 * nla_padlen - length of padding at the tail of attribute 661 * @payload: length of payload 662 */ 663static inline int nla_padlen(int payload) 664{ 665 return nla_total_size(payload) - nla_attr_size(payload); 666} 667 668/** 669 * nla_type - attribute type 670 * @nla: netlink attribute 671 */ 672static inline int nla_type(const struct nlattr *nla) 673{ 674 return nla->nla_type & NLA_TYPE_MASK; 675} 676 677/** 678 * nla_data - head of payload 679 * @nla: netlink attribute 680 */ 681static inline void *nla_data(const struct nlattr *nla) 682{ 683 return (char *) nla + NLA_HDRLEN; 684} 685 686/** 687 * nla_len - length of payload 688 * @nla: netlink attribute 689 */ 690static inline int nla_len(const struct nlattr *nla) 691{ 692 return nla->nla_len - NLA_HDRLEN; 693} 694 695/** 696 * nla_ok - check if the netlink attribute fits into the remaining bytes 697 * @nla: netlink attribute 698 * @remaining: number of bytes remaining in attribute stream 699 */ 700static inline int nla_ok(const struct nlattr *nla, int remaining) 701{ 702 return remaining >= (int) sizeof(*nla) && 703 nla->nla_len >= sizeof(*nla) && 704 nla->nla_len <= remaining; 705} 706 707/** 708 * nla_next - next netlink attribute in attribute stream 709 * @nla: netlink attribute 710 * @remaining: number of bytes remaining in attribute stream 711 * 712 * Returns the next netlink attribute in the attribute stream and 713 * decrements remaining by the size of the current attribute. 714 */ 715static inline struct nlattr *nla_next(const struct nlattr *nla, int *remaining) 716{ 717 unsigned int totlen = NLA_ALIGN(nla->nla_len); 718 719 *remaining -= totlen; 720 return (struct nlattr *) ((char *) nla + totlen); 721} 722 723/** 724 * nla_find_nested - find attribute in a set of nested attributes 725 * @nla: attribute containing the nested attributes 726 * @attrtype: type of attribute to look for 727 * 728 * Returns the first attribute which matches the specified type. 729 */ 730static inline struct nlattr * 731nla_find_nested(const struct nlattr *nla, int attrtype) 732{ 733 return nla_find(nla_data(nla), nla_len(nla), attrtype); 734} 735 736/** 737 * nla_parse_nested - parse nested attributes 738 * @tb: destination array with maxtype+1 elements 739 * @maxtype: maximum attribute type to be expected 740 * @nla: attribute containing the nested attributes 741 * @policy: validation policy 742 * 743 * See nla_parse() 744 */ 745static inline int nla_parse_nested(struct nlattr *tb[], int maxtype, 746 const struct nlattr *nla, 747 const struct nla_policy *policy) 748{ 749 return nla_parse(tb, maxtype, nla_data(nla), nla_len(nla), policy); 750} 751 752/** 753 * nla_put_u8 - Add a u8 netlink attribute to a socket buffer 754 * @skb: socket buffer to add attribute to 755 * @attrtype: attribute type 756 * @value: numeric value 757 */ 758static inline int nla_put_u8(struct sk_buff *skb, int attrtype, u8 value) 759{ 760 return nla_put(skb, attrtype, sizeof(u8), &value); 761} 762 763/** 764 * nla_put_u16 - Add a u16 netlink attribute to a socket buffer 765 * @skb: socket buffer to add attribute to 766 * @attrtype: attribute type 767 * @value: numeric value 768 */ 769static inline int nla_put_u16(struct sk_buff *skb, int attrtype, u16 value) 770{ 771 return nla_put(skb, attrtype, sizeof(u16), &value); 772} 773 774/** 775 * nla_put_be16 - Add a __be16 netlink attribute to a socket buffer 776 * @skb: socket buffer to add attribute to 777 * @attrtype: attribute type 778 * @value: numeric value 779 */ 780static inline int nla_put_be16(struct sk_buff *skb, int attrtype, __be16 value) 781{ 782 return nla_put(skb, attrtype, sizeof(__be16), &value); 783} 784 785/** 786 * nla_put_net16 - Add 16-bit network byte order netlink attribute to a socket buffer 787 * @skb: socket buffer to add attribute to 788 * @attrtype: attribute type 789 * @value: numeric value 790 */ 791static inline int nla_put_net16(struct sk_buff *skb, int attrtype, __be16 value) 792{ 793 return nla_put_be16(skb, attrtype | NLA_F_NET_BYTEORDER, value); 794} 795 796/** 797 * nla_put_le16 - Add a __le16 netlink attribute to a socket buffer 798 * @skb: socket buffer to add attribute to 799 * @attrtype: attribute type 800 * @value: numeric value 801 */ 802static inline int nla_put_le16(struct sk_buff *skb, int attrtype, __le16 value) 803{ 804 return nla_put(skb, attrtype, sizeof(__le16), &value); 805} 806 807/** 808 * nla_put_u32 - Add a u32 netlink attribute to a socket buffer 809 * @skb: socket buffer to add attribute to 810 * @attrtype: attribute type 811 * @value: numeric value 812 */ 813static inline int nla_put_u32(struct sk_buff *skb, int attrtype, u32 value) 814{ 815 return nla_put(skb, attrtype, sizeof(u32), &value); 816} 817 818/** 819 * nla_put_be32 - Add a __be32 netlink attribute to a socket buffer 820 * @skb: socket buffer to add attribute to 821 * @attrtype: attribute type 822 * @value: numeric value 823 */ 824static inline int nla_put_be32(struct sk_buff *skb, int attrtype, __be32 value) 825{ 826 return nla_put(skb, attrtype, sizeof(__be32), &value); 827} 828 829/** 830 * nla_put_net32 - Add 32-bit network byte order netlink attribute to a socket buffer 831 * @skb: socket buffer to add attribute to 832 * @attrtype: attribute type 833 * @value: numeric value 834 */ 835static inline int nla_put_net32(struct sk_buff *skb, int attrtype, __be32 value) 836{ 837 return nla_put_be32(skb, attrtype | NLA_F_NET_BYTEORDER, value); 838} 839 840/** 841 * nla_put_le32 - Add a __le32 netlink attribute to a socket buffer 842 * @skb: socket buffer to add attribute to 843 * @attrtype: attribute type 844 * @value: numeric value 845 */ 846static inline int nla_put_le32(struct sk_buff *skb, int attrtype, __le32 value) 847{ 848 return nla_put(skb, attrtype, sizeof(__le32), &value); 849} 850 851/** 852 * nla_put_u64_64bit - Add a u64 netlink attribute to a skb and align it 853 * @skb: socket buffer to add attribute to 854 * @attrtype: attribute type 855 * @value: numeric value 856 * @padattr: attribute type for the padding 857 */ 858static inline int nla_put_u64_64bit(struct sk_buff *skb, int attrtype, 859 u64 value, int padattr) 860{ 861 return nla_put_64bit(skb, attrtype, sizeof(u64), &value, padattr); 862} 863 864/** 865 * nla_put_be64 - Add a __be64 netlink attribute to a socket buffer and align it 866 * @skb: socket buffer to add attribute to 867 * @attrtype: attribute type 868 * @value: numeric value 869 * @padattr: attribute type for the padding 870 */ 871static inline int nla_put_be64(struct sk_buff *skb, int attrtype, __be64 value, 872 int padattr) 873{ 874 return nla_put_64bit(skb, attrtype, sizeof(__be64), &value, padattr); 875} 876 877/** 878 * nla_put_net64 - Add 64-bit network byte order nlattr to a skb and align it 879 * @skb: socket buffer to add attribute to 880 * @attrtype: attribute type 881 * @value: numeric value 882 * @padattr: attribute type for the padding 883 */ 884static inline int nla_put_net64(struct sk_buff *skb, int attrtype, __be64 value, 885 int padattr) 886{ 887 return nla_put_be64(skb, attrtype | NLA_F_NET_BYTEORDER, value, 888 padattr); 889} 890 891/** 892 * nla_put_le64 - Add a __le64 netlink attribute to a socket buffer and align it 893 * @skb: socket buffer to add attribute to 894 * @attrtype: attribute type 895 * @value: numeric value 896 * @padattr: attribute type for the padding 897 */ 898static inline int nla_put_le64(struct sk_buff *skb, int attrtype, __le64 value, 899 int padattr) 900{ 901 return nla_put_64bit(skb, attrtype, sizeof(__le64), &value, padattr); 902} 903 904/** 905 * nla_put_s8 - Add a s8 netlink attribute to a socket buffer 906 * @skb: socket buffer to add attribute to 907 * @attrtype: attribute type 908 * @value: numeric value 909 */ 910static inline int nla_put_s8(struct sk_buff *skb, int attrtype, s8 value) 911{ 912 return nla_put(skb, attrtype, sizeof(s8), &value); 913} 914 915/** 916 * nla_put_s16 - Add a s16 netlink attribute to a socket buffer 917 * @skb: socket buffer to add attribute to 918 * @attrtype: attribute type 919 * @value: numeric value 920 */ 921static inline int nla_put_s16(struct sk_buff *skb, int attrtype, s16 value) 922{ 923 return nla_put(skb, attrtype, sizeof(s16), &value); 924} 925 926/** 927 * nla_put_s32 - Add a s32 netlink attribute to a socket buffer 928 * @skb: socket buffer to add attribute to 929 * @attrtype: attribute type 930 * @value: numeric value 931 */ 932static inline int nla_put_s32(struct sk_buff *skb, int attrtype, s32 value) 933{ 934 return nla_put(skb, attrtype, sizeof(s32), &value); 935} 936 937/** 938 * nla_put_s64 - Add a s64 netlink attribute to a socket buffer and align it 939 * @skb: socket buffer to add attribute to 940 * @attrtype: attribute type 941 * @value: numeric value 942 * @padattr: attribute type for the padding 943 */ 944static inline int nla_put_s64(struct sk_buff *skb, int attrtype, s64 value, 945 int padattr) 946{ 947 return nla_put_64bit(skb, attrtype, sizeof(s64), &value, padattr); 948} 949 950/** 951 * nla_put_string - Add a string netlink attribute to a socket buffer 952 * @skb: socket buffer to add attribute to 953 * @attrtype: attribute type 954 * @str: NUL terminated string 955 */ 956static inline int nla_put_string(struct sk_buff *skb, int attrtype, 957 const char *str) 958{ 959 return nla_put(skb, attrtype, strlen(str) + 1, str); 960} 961 962/** 963 * nla_put_flag - Add a flag netlink attribute to a socket buffer 964 * @skb: socket buffer to add attribute to 965 * @attrtype: attribute type 966 */ 967static inline int nla_put_flag(struct sk_buff *skb, int attrtype) 968{ 969 return nla_put(skb, attrtype, 0, NULL); 970} 971 972/** 973 * nla_put_msecs - Add a msecs netlink attribute to a skb and align it 974 * @skb: socket buffer to add attribute to 975 * @attrtype: attribute type 976 * @njiffies: number of jiffies to convert to msecs 977 * @padattr: attribute type for the padding 978 */ 979static inline int nla_put_msecs(struct sk_buff *skb, int attrtype, 980 unsigned long njiffies, int padattr) 981{ 982 u64 tmp = jiffies_to_msecs(njiffies); 983 984 return nla_put_64bit(skb, attrtype, sizeof(u64), &tmp, padattr); 985} 986 987/** 988 * nla_put_in_addr - Add an IPv4 address netlink attribute to a socket 989 * buffer 990 * @skb: socket buffer to add attribute to 991 * @attrtype: attribute type 992 * @addr: IPv4 address 993 */ 994static inline int nla_put_in_addr(struct sk_buff *skb, int attrtype, 995 __be32 addr) 996{ 997 return nla_put_be32(skb, attrtype, addr); 998} 999 1000/**
1001 * nla_put_in6_addr - Add an IPv6 address netlink attribute to a socket 1002 * buffer 1003 * @skb: socket buffer to add attribute to 1004 * @attrtype: attribute type 1005 * @addr: IPv6 address 1006 */ 1007static inline int nla_put_in6_addr(struct sk_buff *skb, int attrtype, 1008 const struct in6_addr *addr) 1009{ 1010 return nla_put(skb, attrtype, sizeof(*addr), addr); 1011} 1012 1013/** 1014 * nla_get_u32 - return payload of u32 attribute 1015 * @nla: u32 netlink attribute 1016 */ 1017static inline u32 nla_get_u32(const struct nlattr *nla) 1018{ 1019 return *(u32 *) nla_data(nla); 1020} 1021 1022/** 1023 * nla_get_be32 - return payload of __be32 attribute 1024 * @nla: __be32 netlink attribute 1025 */ 1026static inline __be32 nla_get_be32(const struct nlattr *nla) 1027{ 1028 return *(__be32 *) nla_data(nla); 1029} 1030 1031/** 1032 * nla_get_le32 - return payload of __le32 attribute 1033 * @nla: __le32 netlink attribute 1034 */ 1035static inline __le32 nla_get_le32(const struct nlattr *nla) 1036{ 1037 return *(__le32 *) nla_data(nla); 1038} 1039 1040/** 1041 * nla_get_u16 - return payload of u16 attribute 1042 * @nla: u16 netlink attribute 1043 */ 1044static inline u16 nla_get_u16(const struct nlattr *nla) 1045{ 1046 return *(u16 *) nla_data(nla); 1047} 1048 1049/** 1050 * nla_get_be16 - return payload of __be16 attribute 1051 * @nla: __be16 netlink attribute 1052 */ 1053static inline __be16 nla_get_be16(const struct nlattr *nla) 1054{ 1055 return *(__be16 *) nla_data(nla); 1056} 1057 1058/** 1059 * nla_get_le16 - return payload of __le16 attribute 1060 * @nla: __le16 netlink attribute 1061 */ 1062static inline __le16 nla_get_le16(const struct nlattr *nla) 1063{ 1064 return *(__le16 *) nla_data(nla); 1065} 1066 1067/** 1068 * nla_get_u8 - return payload of u8 attribute 1069 * @nla: u8 netlink attribute 1070 */ 1071static inline u8 nla_get_u8(const struct nlattr *nla) 1072{ 1073 return *(u8 *) nla_data(nla); 1074} 1075 1076/** 1077 * nla_get_u64 - return payload of u64 attribute 1078 * @nla: u64 netlink attribute 1079 */ 1080static inline u64 nla_get_u64(const struct nlattr *nla) 1081{ 1082 u64 tmp; 1083 1084 nla_memcpy(&tmp, nla, sizeof(tmp)); 1085 1086 return tmp; 1087} 1088 1089/** 1090 * nla_get_be64 - return payload of __be64 attribute 1091 * @nla: __be64 netlink attribute 1092 */ 1093static inline __be64 nla_get_be64(const struct nlattr *nla) 1094{ 1095 __be64 tmp; 1096 1097 nla_memcpy(&tmp, nla, sizeof(tmp)); 1098 1099 return tmp; 1100} 1101 1102/** 1103 * nla_get_le64 - return payload of __le64 attribute 1104 * @nla: __le64 netlink attribute 1105 */ 1106static inline __le64 nla_get_le64(const struct nlattr *nla) 1107{ 1108 return *(__le64 *) nla_data(nla); 1109} 1110 1111/** 1112 * nla_get_s32 - return payload of s32 attribute 1113 * @nla: s32 netlink attribute 1114 */ 1115static inline s32 nla_get_s32(const struct nlattr *nla) 1116{ 1117 return *(s32 *) nla_data(nla); 1118} 1119 1120/** 1121 * nla_get_s16 - return payload of s16 attribute 1122 * @nla: s16 netlink attribute 1123 */ 1124static inline s16 nla_get_s16(const struct nlattr *nla) 1125{ 1126 return *(s16 *) nla_data(nla); 1127} 1128 1129/** 1130 * nla_get_s8 - return payload of s8 attribute 1131 * @nla: s8 netlink attribute 1132 */ 1133static inline s8 nla_get_s8(const struct nlattr *nla) 1134{ 1135 return *(s8 *) nla_data(nla); 1136} 1137 1138/** 1139 * nla_get_s64 - return payload of s64 attribute 1140 * @nla: s64 netlink attribute 1141 */ 1142static inline s64 nla_get_s64(const struct nlattr *nla) 1143{ 1144 s64 tmp; 1145 1146 nla_memcpy(&tmp, nla, sizeof(tmp)); 1147 1148 return tmp; 1149} 1150 1151/** 1152 * nla_get_flag - return payload of flag attribute 1153 * @nla: flag netlink attribute 1154 */ 1155static inline int nla_get_flag(const struct nlattr *nla) 1156{ 1157 return !!nla; 1158} 1159 1160/** 1161 * nla_get_msecs - return payload of msecs attribute 1162 * @nla: msecs netlink attribute 1163 * 1164 * Returns the number of milliseconds in jiffies. 1165 */ 1166static inline unsigned long nla_get_msecs(const struct nlattr *nla) 1167{ 1168 u64 msecs = nla_get_u64(nla); 1169 1170 return msecs_to_jiffies((unsigned long) msecs); 1171} 1172 1173/** 1174 * nla_get_in_addr - return payload of IPv4 address attribute 1175 * @nla: IPv4 address netlink attribute 1176 */ 1177static inline __be32 nla_get_in_addr(const struct nlattr *nla) 1178{ 1179 return *(__be32 *) nla_data(nla); 1180} 1181 1182/** 1183 * nla_get_in6_addr - return payload of IPv6 address attribute 1184 * @nla: IPv6 address netlink attribute 1185 */ 1186static inline struct in6_addr nla_get_in6_addr(const struct nlattr *nla) 1187{ 1188 struct in6_addr tmp; 1189 1190 nla_memcpy(&tmp, nla, sizeof(tmp)); 1191 return tmp; 1192} 1193 1194/** 1195 * nla_memdup - duplicate attribute memory (kmemdup) 1196 * @src: netlink attribute to duplicate from 1197 * @gfp: GFP mask 1198 */ 1199static inline void *nla_memdup(const struct nlattr *src, gfp_t gfp) 1200{ 1201 return kmemdup(nla_data(src), nla_len(src), gfp); 1202} 1203 1204/** 1205 * nla_nest_start - Start a new level of nested attributes 1206 * @skb: socket buffer to add attributes to 1207 * @attrtype: attribute type of container 1208 * 1209 * Returns the container attribute 1210 */ 1211static inline struct nlattr *nla_nest_start(struct sk_buff *skb, int attrtype) 1212{ 1213 struct nlattr *start = (struct nlattr *)skb_tail_pointer(skb); 1214 1215 if (nla_put(skb, attrtype, 0, NULL) < 0) 1216 return NULL; 1217 1218 return start; 1219} 1220 1221/** 1222 * nla_nest_end - Finalize nesting of attributes 1223 * @skb: socket buffer the attributes are stored in 1224 * @start: container attribute 1225 * 1226 * Corrects the container attribute header to include the all 1227 * appeneded attributes. 1228 * 1229 * Returns the total data length of the skb. 1230 */ 1231static inline int nla_nest_end(struct sk_buff *skb, struct nlattr *start) 1232{ 1233 start->nla_len = skb_tail_pointer(skb) - (unsigned char *)start; 1234 return skb->len; 1235} 1236 1237/** 1238 * nla_nest_cancel - Cancel nesting of attributes 1239 * @skb: socket buffer the message is stored in 1240 * @start: container attribute 1241 * 1242 * Removes the container attribute and including all nested 1243 * attributes. Returns -EMSGSIZE 1244 */ 1245static inline void nla_nest_cancel(struct sk_buff *skb, struct nlattr *start) 1246{ 1247 nlmsg_trim(skb, start); 1248} 1249 1250/** 1251 * nla_validate_nested - Validate a stream of nested attributes 1252 * @start: container attribute 1253 * @maxtype: maximum attribute type to be expected 1254 * @policy: validation policy 1255 * 1256 * Validates all attributes in the nested attribute stream against the 1257 * specified policy. Attributes with a type exceeding maxtype will be 1258 * ignored. See documenation of struct nla_policy for more details. 1259 * 1260 * Returns 0 on success or a negative error code. 1261 */ 1262static inline int nla_validate_nested(const struct nlattr *start, int maxtype, 1263 const struct nla_policy *policy) 1264{ 1265 return nla_validate(nla_data(start), nla_len(start), maxtype, policy); 1266} 1267 1268/** 1269 * nla_need_padding_for_64bit - test 64-bit alignment of the next attribute 1270 * @skb: socket buffer the message is stored in 1271 * 1272 * Return true if padding is needed to align the next attribute (nla_data()) to 1273 * a 64-bit aligned area. 1274 */ 1275static inline bool nla_need_padding_for_64bit(struct sk_buff *skb) 1276{ 1277#ifndef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS 1278 /* The nlattr header is 4 bytes in size, that's why we test 1279 * if the skb->data _is_ aligned. A NOP attribute, plus 1280 * nlattr header for next attribute, will make nla_data() 1281 * 8-byte aligned. 1282 */ 1283 if (IS_ALIGNED((unsigned long)skb_tail_pointer(skb), 8)) 1284 return true; 1285#endif 1286 return false; 1287} 1288 1289/** 1290 * nla_align_64bit - 64-bit align the nla_data() of next attribute 1291 * @skb: socket buffer the message is stored in 1292 * @padattr: attribute type for the padding 1293 * 1294 * Conditionally emit a padding netlink attribute in order to make 1295 * the next attribute we emit have a 64-bit aligned nla_data() area. 1296 * This will only be done in architectures which do not have 1297 * CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS defined. 1298 * 1299 * Returns zero on success or a negative error code. 1300 */ 1301static inline int nla_align_64bit(struct sk_buff *skb, int padattr) 1302{ 1303 if (nla_need_padding_for_64bit(skb) && 1304 !nla_reserve(skb, padattr, 0)) 1305 return -EMSGSIZE; 1306 1307 return 0; 1308} 1309 1310/** 1311 * nla_total_size_64bit - total length of attribute including padding 1312 * @payload: length of payload 1313 */ 1314static inline int nla_total_size_64bit(int payload) 1315{ 1316 return NLA_ALIGN(nla_attr_size(payload)) 1317#ifndef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS 1318 + NLA_ALIGN(nla_attr_size(0)) 1319#endif 1320 ; 1321} 1322 1323/** 1324 * nla_for_each_attr - iterate over a stream of attributes 1325 * @pos: loop counter, set to current attribute 1326 * @head: head of attribute stream 1327 * @len: length of attribute stream 1328 * @rem: initialized to len, holds bytes currently remaining in stream 1329 */ 1330#define nla_for_each_attr(pos, head, len, rem) \ 1331 for (pos = head, rem = len; \ 1332 nla_ok(pos, rem); \ 1333 pos = nla_next(pos, &(rem))) 1334 1335/** 1336 * nla_for_each_nested - iterate over nested attributes 1337 * @pos: loop counter, set to current attribute 1338 * @nla: attribute containing the nested attributes 1339 * @rem: initialized to len, holds bytes currently remaining in stream 1340 */ 1341#define nla_for_each_nested(pos, nla, rem) \ 1342 nla_for_each_attr(pos, nla_data(nla), nla_len(nla), rem) 1343 1344/** 1345 * nla_is_last - Test if attribute is last in stream 1346 * @nla: attribute to test 1347 * @rem: bytes remaining in stream 1348 */ 1349static inline bool nla_is_last(const struct nlattr *nla, int rem) 1350{ 1351 return nla->nla_len == rem; 1352} 1353 1354#endif 1355