include/net/netlink.h

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