libnl  3.2.28
attr.c
1 /*
2  * lib/attr.c Netlink Attributes
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation version 2.1
7  * of the License.
8  *
9  * Copyright (c) 2003-2013 Thomas Graf <tgraf@suug.ch>
10  */
11 
12 #include <netlink-private/netlink.h>
13 #include <netlink/netlink.h>
14 #include <netlink/utils.h>
15 #include <netlink/addr.h>
16 #include <netlink/attr.h>
17 #include <netlink/msg.h>
18 #include <linux/socket.h>
19 
20 /**
21  * @ingroup msg
22  * @defgroup attr Attributes
23  * Netlink Attributes Construction/Parsing Interface
24  *
25  * Related sections in the development guide:
26  * - @core_doc{core_attr,Netlink Attributes}
27  *
28  * @{
29  *
30  * Header
31  * ------
32  * ~~~~{.c}
33  * #include <netlink/attr.h>
34  * ~~~~
35  */
36 
37 /**
38  * @name Attribute Size Calculation
39  * @{
40  */
41 
42 /**
43  * Return size of attribute whithout padding.
44  * @arg payload Payload length of attribute.
45  *
46  * @code
47  * <-------- nla_attr_size(payload) --------->
48  * +------------------+- - -+- - - - - - - - - +- - -+
49  * | Attribute Header | Pad | Payload | Pad |
50  * +------------------+- - -+- - - - - - - - - +- - -+
51  * @endcode
52  *
53  * @return Size of attribute in bytes without padding.
54  */
55 int nla_attr_size(int payload)
56 {
57  return NLA_HDRLEN + payload;
58 }
59 
60 /**
61  * Return size of attribute including padding.
62  * @arg payload Payload length of attribute.
63  *
64  * @code
65  * <----------- nla_total_size(payload) ----------->
66  * +------------------+- - -+- - - - - - - - - +- - -+
67  * | Attribute Header | Pad | Payload | Pad |
68  * +------------------+- - -+- - - - - - - - - +- - -+
69  * @endcode
70  *
71  * @return Size of attribute in bytes.
72  */
73 int nla_total_size(int payload)
74 {
75  return NLA_ALIGN(nla_attr_size(payload));
76 }
77 
78 /**
79  * Return length of padding at the tail of the attribute.
80  * @arg payload Payload length of attribute.
81  *
82  * @code
83  * +------------------+- - -+- - - - - - - - - +- - -+
84  * | Attribute Header | Pad | Payload | Pad |
85  * +------------------+- - -+- - - - - - - - - +- - -+
86  * <--->
87  * @endcode
88  *
89  * @return Length of padding in bytes.
90  */
91 int nla_padlen(int payload)
92 {
93  return nla_total_size(payload) - nla_attr_size(payload);
94 }
95 
96 /** @} */
97 
98 /**
99  * @name Parsing Attributes
100  * @{
101  */
102 
103 /**
104  * Return type of the attribute.
105  * @arg nla Attribute.
106  *
107  * @return Type of attribute.
108  */
109 int nla_type(const struct nlattr *nla)
110 {
111  return nla->nla_type & NLA_TYPE_MASK;
112 }
113 
114 /**
115  * Return pointer to the payload section.
116  * @arg nla Attribute.
117  *
118  * @return Pointer to start of payload section.
119  */
120 void *nla_data(const struct nlattr *nla)
121 {
122  return (char *) nla + NLA_HDRLEN;
123 }
124 
125 /**
126  * Return length of the payload .
127  * @arg nla Attribute
128  *
129  * @return Length of payload in bytes.
130  */
131 int nla_len(const struct nlattr *nla)
132 {
133  return nla->nla_len - NLA_HDRLEN;
134 }
135 
136 /**
137  * Check if the attribute header and payload can be accessed safely.
138  * @arg nla Attribute of any kind.
139  * @arg remaining Number of bytes remaining in attribute stream.
140  *
141  * Verifies that the header and payload do not exceed the number of
142  * bytes left in the attribute stream. This function must be called
143  * before access the attribute header or payload when iterating over
144  * the attribute stream using nla_next().
145  *
146  * @return True if the attribute can be accessed safely, false otherwise.
147  */
148 int nla_ok(const struct nlattr *nla, int remaining)
149 {
150  return remaining >= sizeof(*nla) &&
151  nla->nla_len >= sizeof(*nla) &&
152  nla->nla_len <= remaining;
153 }
154 
155 /**
156  * Return next attribute in a stream of attributes.
157  * @arg nla Attribute of any kind.
158  * @arg remaining Variable to count remaining bytes in stream.
159  *
160  * Calculates the offset to the next attribute based on the attribute
161  * given. The attribute provided is assumed to be accessible, the
162  * caller is responsible to use nla_ok() beforehand. The offset (length
163  * of specified attribute including padding) is then subtracted from
164  * the remaining bytes variable and a pointer to the next attribute is
165  * returned.
166  *
167  * nla_next() can be called as long as remainig is >0.
168  *
169  * @return Pointer to next attribute.
170  */
171 struct nlattr *nla_next(const struct nlattr *nla, int *remaining)
172 {
173  int totlen = NLA_ALIGN(nla->nla_len);
174 
175  *remaining -= totlen;
176  return (struct nlattr *) ((char *) nla + totlen);
177 }
178 
179 static uint16_t nla_attr_minlen[NLA_TYPE_MAX+1] = {
180  [NLA_U8] = sizeof(uint8_t),
181  [NLA_U16] = sizeof(uint16_t),
182  [NLA_U32] = sizeof(uint32_t),
183  [NLA_U64] = sizeof(uint64_t),
184  [NLA_STRING] = 1,
185  [NLA_FLAG] = 0,
186 };
187 
188 static int validate_nla(const struct nlattr *nla, int maxtype,
189  const struct nla_policy *policy)
190 {
191  const struct nla_policy *pt;
192  unsigned int minlen = 0;
193  int type = nla_type(nla);
194 
195  if (type < 0 || type > maxtype)
196  return 0;
197 
198  pt = &policy[type];
199 
200  if (pt->type > NLA_TYPE_MAX)
201  BUG();
202 
203  if (pt->minlen)
204  minlen = pt->minlen;
205  else if (pt->type != NLA_UNSPEC)
206  minlen = nla_attr_minlen[pt->type];
207 
208  if (nla_len(nla) < minlen)
209  return -NLE_RANGE;
210 
211  if (pt->maxlen && nla_len(nla) > pt->maxlen)
212  return -NLE_RANGE;
213 
214  if (pt->type == NLA_STRING) {
215  const char *data = nla_data(nla);
216  if (data[nla_len(nla) - 1] != '\0')
217  return -NLE_INVAL;
218  }
219 
220  return 0;
221 }
222 
223 
224 /**
225  * Create attribute index based on a stream of attributes.
226  * @arg tb Index array to be filled (maxtype+1 elements).
227  * @arg maxtype Maximum attribute type expected and accepted.
228  * @arg head Head of attribute stream.
229  * @arg len Length of attribute stream.
230  * @arg policy Attribute validation policy.
231  *
232  * Iterates over the stream of attributes and stores a pointer to each
233  * attribute in the index array using the attribute type as index to
234  * the array. Attribute with a type greater than the maximum type
235  * specified will be silently ignored in order to maintain backwards
236  * compatibility. If \a policy is not NULL, the attribute will be
237  * validated using the specified policy.
238  *
239  * @see nla_validate
240  * @return 0 on success or a negative error code.
241  */
242 int nla_parse(struct nlattr *tb[], int maxtype, struct nlattr *head, int len,
243  struct nla_policy *policy)
244 {
245  struct nlattr *nla;
246  int rem, err;
247 
248  memset(tb, 0, sizeof(struct nlattr *) * (maxtype + 1));
249 
250  nla_for_each_attr(nla, head, len, rem) {
251  int type = nla_type(nla);
252 
253  if (type > maxtype)
254  continue;
255 
256  if (policy) {
257  err = validate_nla(nla, maxtype, policy);
258  if (err < 0)
259  goto errout;
260  }
261 
262  if (tb[type])
263  NL_DBG(1, "Attribute of type %#x found multiple times in message, "
264  "previous attribute is being ignored.\n", type);
265 
266  tb[type] = nla;
267  }
268 
269  if (rem > 0)
270  NL_DBG(1, "netlink: %d bytes leftover after parsing "
271  "attributes.\n", rem);
272 
273  err = 0;
274 errout:
275  return err;
276 }
277 
278 /**
279  * Validate a stream of attributes.
280  * @arg head Head of attributes stream.
281  * @arg len Length of attributes stream.
282  * @arg maxtype Maximum attribute type expected and accepted.
283  * @arg policy Validation policy.
284  *
285  * Iterates over the stream of attributes and validates each attribute
286  * one by one using the specified policy. Attributes with a type greater
287  * than the maximum type specified will be silently ignored in order to
288  * maintain backwards compatibility.
289  *
290  * See section @core_doc{core_attr_parse,Attribute Parsing} for more details.
291  *
292  * @return 0 on success or a negative error code.
293  */
294 int nla_validate(const struct nlattr *head, int len, int maxtype,
295  const struct nla_policy *policy)
296 {
297  const struct nlattr *nla;
298  int rem, err;
299 
300  nla_for_each_attr(nla, head, len, rem) {
301  err = validate_nla(nla, maxtype, policy);
302  if (err < 0)
303  goto errout;
304  }
305 
306  err = 0;
307 errout:
308  return err;
309 }
310 
311 /**
312  * Find a single attribute in a stream of attributes.
313  * @arg head Head of attributes stream.
314  * @arg len Length of attributes stream.
315  * @arg attrtype Attribute type to look for.
316  *
317  * Iterates over the stream of attributes and compares each type with
318  * the type specified. Returns the first attribute which matches the
319  * type.
320  *
321  * @return Pointer to attribute found or NULL.
322  */
323 struct nlattr *nla_find(const struct nlattr *head, int len, int attrtype)
324 {
325  const struct nlattr *nla;
326  int rem;
327 
328  nla_for_each_attr(nla, head, len, rem)
329  if (nla_type(nla) == attrtype)
330  return (struct nlattr*)nla;
331 
332  return NULL;
333 }
334 
335 /** @} */
336 
337 /**
338  * @name Helper Functions
339  * @{
340  */
341 
342 /**
343  * Copy attribute payload to another memory area.
344  * @arg dest Pointer to destination memory area.
345  * @arg src Attribute
346  * @arg count Number of bytes to copy at most.
347  *
348  * Note: The number of bytes copied is limited by the length of
349  * the attribute payload.
350  *
351  * @return The number of bytes copied to dest.
352  */
353 int nla_memcpy(void *dest, const struct nlattr *src, int count)
354 {
355  int minlen;
356 
357  if (!src)
358  return 0;
359 
360  minlen = min_t(int, count, nla_len(src));
361  memcpy(dest, nla_data(src), minlen);
362 
363  return minlen;
364 }
365 
366 /**
367  * Copy string attribute payload to a buffer.
368  * @arg dst Pointer to destination buffer.
369  * @arg nla Attribute of type NLA_STRING.
370  * @arg dstsize Size of destination buffer in bytes.
371  *
372  * Copies at most dstsize - 1 bytes to the destination buffer.
373  * The result is always a valid NUL terminated string. Unlike
374  * strlcpy the destination buffer is always padded out.
375  *
376  * @return The length of string attribute without the terminating NUL.
377  */
378 size_t nla_strlcpy(char *dst, const struct nlattr *nla, size_t dstsize)
379 {
380  size_t srclen = nla_len(nla);
381  const char *src = nla_data(nla);
382 
383  if (srclen > 0 && src[srclen - 1] == '\0')
384  srclen--;
385 
386  if (dstsize > 0) {
387  size_t len = (srclen >= dstsize) ? dstsize - 1 : srclen;
388 
389  memset(dst, 0, dstsize);
390  memcpy(dst, src, len);
391  }
392 
393  return srclen;
394 }
395 
396 /**
397  * Compare attribute payload with memory area.
398  * @arg nla Attribute.
399  * @arg data Memory area to compare to.
400  * @arg size Number of bytes to compare.
401  *
402  * @see memcmp(3)
403  * @return An integer less than, equal to, or greater than zero.
404  */
405 int nla_memcmp(const struct nlattr *nla, const void *data, size_t size)
406 {
407  int d = nla_len(nla) - size;
408 
409  if (d == 0)
410  d = memcmp(nla_data(nla), data, size);
411 
412  return d;
413 }
414 
415 /**
416  * Compare string attribute payload with string
417  * @arg nla Attribute of type NLA_STRING.
418  * @arg str NUL terminated string.
419  *
420  * @see strcmp(3)
421  * @return An integer less than, equal to, or greater than zero.
422  */
423 int nla_strcmp(const struct nlattr *nla, const char *str)
424 {
425  int len = strlen(str) + 1;
426  int d = nla_len(nla) - len;
427 
428  if (d == 0)
429  d = memcmp(nla_data(nla), str, len);
430 
431  return d;
432 }
433 
434 /** @} */
435 
436 /**
437  * @name Unspecific Attribute
438  * @{
439  */
440 
441 /**
442  * Reserve space for a attribute.
443  * @arg msg Netlink Message.
444  * @arg attrtype Attribute Type.
445  * @arg attrlen Length of payload.
446  *
447  * Reserves room for a attribute in the specified netlink message and
448  * fills in the attribute header (type, length). Returns NULL if there
449  * is unsuficient space for the attribute.
450  *
451  * Any padding between payload and the start of the next attribute is
452  * zeroed out.
453  *
454  * @return Pointer to start of attribute or NULL on failure.
455  */
456 struct nlattr *nla_reserve(struct nl_msg *msg, int attrtype, int attrlen)
457 {
458  struct nlattr *nla;
459  int tlen;
460 
461  tlen = NLMSG_ALIGN(msg->nm_nlh->nlmsg_len) + nla_total_size(attrlen);
462 
463  if (tlen > msg->nm_size)
464  return NULL;
465 
466  nla = (struct nlattr *) nlmsg_tail(msg->nm_nlh);
467  nla->nla_type = attrtype;
468  nla->nla_len = nla_attr_size(attrlen);
469 
470  if (attrlen)
471  memset((unsigned char *) nla + nla->nla_len, 0, nla_padlen(attrlen));
472  msg->nm_nlh->nlmsg_len = tlen;
473 
474  NL_DBG(2, "msg %p: attr <%p> %d: Reserved %d (%d) bytes at offset +%td "
475  "nlmsg_len=%d\n", msg, nla, nla->nla_type,
476  nla_total_size(attrlen), attrlen,
477  (void *) nla - nlmsg_data(msg->nm_nlh),
478  msg->nm_nlh->nlmsg_len);
479 
480  return nla;
481 }
482 
483 /**
484  * Add a unspecific attribute to netlink message.
485  * @arg msg Netlink message.
486  * @arg attrtype Attribute type.
487  * @arg datalen Length of data to be used as payload.
488  * @arg data Pointer to data to be used as attribute payload.
489  *
490  * Reserves room for a unspecific attribute and copies the provided data
491  * into the message as payload of the attribute. Returns an error if there
492  * is insufficient space for the attribute.
493  *
494  * @see nla_reserve
495  * @return 0 on success or a negative error code.
496  */
497 int nla_put(struct nl_msg *msg, int attrtype, int datalen, const void *data)
498 {
499  struct nlattr *nla;
500 
501  nla = nla_reserve(msg, attrtype, datalen);
502  if (!nla)
503  return -NLE_NOMEM;
504 
505  if (datalen > 0) {
506  memcpy(nla_data(nla), data, datalen);
507  NL_DBG(2, "msg %p: attr <%p> %d: Wrote %d bytes at offset +%td\n",
508  msg, nla, nla->nla_type, datalen,
509  (void *) nla - nlmsg_data(msg->nm_nlh));
510  }
511 
512  return 0;
513 }
514 
515 /**
516  * Add abstract data as unspecific attribute to netlink message.
517  * @arg msg Netlink message.
518  * @arg attrtype Attribute type.
519  * @arg data Abstract data object.
520  *
521  * Equivalent to nla_put() except that the length of the payload is
522  * derived from the abstract data object.
523  *
524  * @see nla_put
525  * @return 0 on success or a negative error code.
526  */
527 int nla_put_data(struct nl_msg *msg, int attrtype, const struct nl_data *data)
528 {
529  return nla_put(msg, attrtype, nl_data_get_size(data),
530  nl_data_get(data));
531 }
532 
533 /**
534  * Add abstract address as unspecific attribute to netlink message.
535  * @arg msg Netlink message.
536  * @arg attrtype Attribute type.
537  * @arg addr Abstract address object.
538  *
539  * @see nla_put
540  * @return 0 on success or a negative error code.
541  */
542 int nla_put_addr(struct nl_msg *msg, int attrtype, struct nl_addr *addr)
543 {
544  return nla_put(msg, attrtype, nl_addr_get_len(addr),
546 }
547 
548 /** @} */
549 
550 /**
551  * @name Integer Attributes
552  */
553 
554 /**
555  * Add 8 bit signed integer attribute to netlink message.
556  * @arg msg Netlink message.
557  * @arg attrtype Attribute type.
558  * @arg value Numeric value to store as payload.
559  *
560  * @see nla_put
561  * @return 0 on success or a negative error code.
562  */
563 int nla_put_s8(struct nl_msg *msg, int attrtype, int8_t value)
564 {
565  return nla_put(msg, attrtype, sizeof(int8_t), &value);
566 }
567 
568 /**
569  * Return value of 8 bit signed integer attribute.
570  * @arg nla 8 bit integer attribute
571  *
572  * @return Payload as 8 bit integer.
573  */
574 int8_t nla_get_s8(const struct nlattr *nla)
575 {
576  return *(const int8_t *) nla_data(nla);
577 }
578 
579 /**
580  * Add 8 bit integer attribute to netlink message.
581  * @arg msg Netlink message.
582  * @arg attrtype Attribute type.
583  * @arg value Numeric value to store as payload.
584  *
585  * @see nla_put
586  * @return 0 on success or a negative error code.
587  */
588 int nla_put_u8(struct nl_msg *msg, int attrtype, uint8_t value)
589 {
590  return nla_put(msg, attrtype, sizeof(uint8_t), &value);
591 }
592 
593 /**
594  * Return value of 8 bit integer attribute.
595  * @arg nla 8 bit integer attribute
596  *
597  * @return Payload as 8 bit integer.
598  */
599 uint8_t nla_get_u8(const struct nlattr *nla)
600 {
601  return *(const uint8_t *) nla_data(nla);
602 }
603 
604 /**
605  * Add 16 bit signed integer attribute to netlink message.
606  * @arg msg Netlink message.
607  * @arg attrtype Attribute type.
608  * @arg value Numeric value to store as payload.
609  *
610  * @see nla_put
611  * @return 0 on success or a negative error code.
612  */
613 int nla_put_s16(struct nl_msg *msg, int attrtype, int16_t value)
614 {
615  return nla_put(msg, attrtype, sizeof(int16_t), &value);
616 }
617 
618 /**
619  * Return payload of 16 bit signed integer attribute.
620  * @arg nla 16 bit integer attribute
621  *
622  * @return Payload as 16 bit integer.
623  */
624 int16_t nla_get_s16(const struct nlattr *nla)
625 {
626  return *(const int16_t *) nla_data(nla);
627 }
628 
629 /**
630  * Add 16 bit integer attribute to netlink message.
631  * @arg msg Netlink message.
632  * @arg attrtype Attribute type.
633  * @arg value Numeric value to store as payload.
634  *
635  * @see nla_put
636  * @return 0 on success or a negative error code.
637  */
638 int nla_put_u16(struct nl_msg *msg, int attrtype, uint16_t value)
639 {
640  return nla_put(msg, attrtype, sizeof(uint16_t), &value);
641 }
642 
643 /**
644  * Return payload of 16 bit integer attribute.
645  * @arg nla 16 bit integer attribute
646  *
647  * @return Payload as 16 bit integer.
648  */
649 uint16_t nla_get_u16(const struct nlattr *nla)
650 {
651  return *(const uint16_t *) nla_data(nla);
652 }
653 
654 /**
655  * Add 32 bit signed integer attribute to netlink message.
656  * @arg msg Netlink message.
657  * @arg attrtype Attribute type.
658  * @arg value Numeric value to store as payload.
659  *
660  * @see nla_put
661  * @return 0 on success or a negative error code.
662  */
663 int nla_put_s32(struct nl_msg *msg, int attrtype, int32_t value)
664 {
665  return nla_put(msg, attrtype, sizeof(int32_t), &value);
666 }
667 
668 /**
669  * Return payload of 32 bit signed integer attribute.
670  * @arg nla 32 bit integer attribute.
671  *
672  * @return Payload as 32 bit integer.
673  */
674 int32_t nla_get_s32(const struct nlattr *nla)
675 {
676  return *(const int32_t *) nla_data(nla);
677 }
678 
679 /**
680  * Add 32 bit integer attribute to netlink message.
681  * @arg msg Netlink message.
682  * @arg attrtype Attribute type.
683  * @arg value Numeric value to store as payload.
684  *
685  * @see nla_put
686  * @return 0 on success or a negative error code.
687  */
688 int nla_put_u32(struct nl_msg *msg, int attrtype, uint32_t value)
689 {
690  return nla_put(msg, attrtype, sizeof(uint32_t), &value);
691 }
692 
693 /**
694  * Return payload of 32 bit integer attribute.
695  * @arg nla 32 bit integer attribute.
696  *
697  * @return Payload as 32 bit integer.
698  */
699 uint32_t nla_get_u32(const struct nlattr *nla)
700 {
701  return *(const uint32_t *) nla_data(nla);
702 }
703 
704 /**
705  * Add 64 bit signed integer attribute to netlink message.
706  * @arg msg Netlink message.
707  * @arg attrtype Attribute type.
708  * @arg value Numeric value to store as payload.
709  *
710  * @see nla_put
711  * @return 0 on success or a negative error code.
712  */
713 int nla_put_s64(struct nl_msg *msg, int attrtype, int64_t value)
714 {
715  return nla_put(msg, attrtype, sizeof(int64_t), &value);
716 }
717 
718 /**
719  * Return payload of s64 attribute
720  * @arg nla s64 netlink attribute
721  *
722  * @return Payload as 64 bit integer.
723  */
724 int64_t nla_get_s64(const struct nlattr *nla)
725 {
726  int64_t tmp = 0;
727 
728  if (nla && nla_len(nla) >= sizeof(tmp))
729  memcpy(&tmp, nla_data(nla), sizeof(tmp));
730 
731  return tmp;
732 }
733 
734 /**
735  * Add 64 bit integer attribute to netlink message.
736  * @arg msg Netlink message.
737  * @arg attrtype Attribute type.
738  * @arg value Numeric value to store as payload.
739  *
740  * @see nla_put
741  * @return 0 on success or a negative error code.
742  */
743 int nla_put_u64(struct nl_msg *msg, int attrtype, uint64_t value)
744 {
745  return nla_put(msg, attrtype, sizeof(uint64_t), &value);
746 }
747 
748 /**
749  * Return payload of u64 attribute
750  * @arg nla u64 netlink attribute
751  *
752  * @return Payload as 64 bit integer.
753  */
754 uint64_t nla_get_u64(const struct nlattr *nla)
755 {
756  uint64_t tmp = 0;
757 
758  if (nla && nla_len(nla) >= sizeof(tmp))
759  memcpy(&tmp, nla_data(nla), sizeof(tmp));
760 
761  return tmp;
762 }
763 
764 /** @} */
765 
766 /**
767  * @name String Attribute
768  */
769 
770 /**
771  * Add string attribute to netlink message.
772  * @arg msg Netlink message.
773  * @arg attrtype Attribute type.
774  * @arg str NUL terminated string.
775  *
776  * @see nla_put
777  * @return 0 on success or a negative error code.
778  */
779 int nla_put_string(struct nl_msg *msg, int attrtype, const char *str)
780 {
781  return nla_put(msg, attrtype, strlen(str) + 1, str);
782 }
783 
784 /**
785  * Return payload of string attribute.
786  * @arg nla String attribute.
787  *
788  * @return Pointer to attribute payload.
789  */
790 char *nla_get_string(const struct nlattr *nla)
791 {
792  return (char *) nla_data(nla);
793 }
794 
795 char *nla_strdup(const struct nlattr *nla)
796 {
797  return strdup(nla_get_string(nla));
798 }
799 
800 /** @} */
801 
802 /**
803  * @name Flag Attribute
804  */
805 
806 /**
807  * Add flag netlink attribute to netlink message.
808  * @arg msg Netlink message.
809  * @arg attrtype Attribute type.
810  *
811  * @see nla_put
812  * @return 0 on success or a negative error code.
813  */
814 int nla_put_flag(struct nl_msg *msg, int attrtype)
815 {
816  return nla_put(msg, attrtype, 0, NULL);
817 }
818 
819 /**
820  * Return true if flag attribute is set.
821  * @arg nla Flag netlink attribute.
822  *
823  * @return True if flag is set, otherwise false.
824  */
825 int nla_get_flag(const struct nlattr *nla)
826 {
827  return !!nla;
828 }
829 
830 /** @} */
831 
832 /**
833  * @name Microseconds Attribute
834  */
835 
836 /**
837  * Add a msecs netlink attribute to a netlink message
838  * @arg n netlink message
839  * @arg attrtype attribute type
840  * @arg msecs number of msecs
841  */
842 int nla_put_msecs(struct nl_msg *n, int attrtype, unsigned long msecs)
843 {
844  return nla_put_u64(n, attrtype, msecs);
845 }
846 
847 /**
848  * Return payload of msecs attribute
849  * @arg nla msecs netlink attribute
850  *
851  * @return the number of milliseconds.
852  */
853 unsigned long nla_get_msecs(const struct nlattr *nla)
854 {
855  return nla_get_u64(nla);
856 }
857 
858 /** @} */
859 
860 /**
861  * @name Nested Attribute
862  */
863 
864 /**
865  * Add nested attributes to netlink message.
866  * @arg msg Netlink message.
867  * @arg attrtype Attribute type.
868  * @arg nested Message containing attributes to be nested.
869  *
870  * Takes the attributes found in the \a nested message and appends them
871  * to the message \a msg nested in a container of the type \a attrtype.
872  * The \a nested message may not have a family specific header.
873  *
874  * @see nla_put
875  * @return 0 on success or a negative error code.
876  */
877 int nla_put_nested(struct nl_msg *msg, int attrtype,
878  const struct nl_msg *nested)
879 {
880  NL_DBG(2, "msg %p: attr <> %d: adding msg %p as nested attribute\n",
881  msg, attrtype, nested);
882 
883  return nla_put(msg, attrtype, nlmsg_datalen(nested->nm_nlh),
884  nlmsg_data(nested->nm_nlh));
885 }
886 
887 
888 /**
889  * Start a new level of nested attributes.
890  * @arg msg Netlink message.
891  * @arg attrtype Attribute type of container.
892  *
893  * @return Pointer to container attribute.
894  */
895 struct nlattr *nla_nest_start(struct nl_msg *msg, int attrtype)
896 {
897  struct nlattr *start = (struct nlattr *) nlmsg_tail(msg->nm_nlh);
898 
899  if (nla_put(msg, attrtype, 0, NULL) < 0)
900  return NULL;
901 
902  NL_DBG(2, "msg %p: attr <%p> %d: starting nesting\n",
903  msg, start, start->nla_type);
904 
905  return start;
906 }
907 
908 /**
909  * Finalize nesting of attributes.
910  * @arg msg Netlink message.
911  * @arg start Container attribute as returned from nla_nest_start().
912  *
913  * Corrects the container attribute header to include the appeneded attributes.
914  *
915  * @return 0 on success or a negative error code.
916  */
917 int nla_nest_end(struct nl_msg *msg, struct nlattr *start)
918 {
919  size_t pad, len;
920 
921  len = (void *) nlmsg_tail(msg->nm_nlh) - (void *) start;
922 
923  if (len == NLA_HDRLEN || len > USHRT_MAX) {
924  /*
925  * Max nlattr size exceeded or empty nested attribute, trim the
926  * attribute header again
927  */
928  nla_nest_cancel(msg, start);
929 
930  /* Return error only if nlattr size was exceeded */
931  return (len == NLA_HDRLEN) ? 0 : -NLE_ATTRSIZE;
932  }
933 
934  start->nla_len = len;
935 
936  pad = NLMSG_ALIGN(msg->nm_nlh->nlmsg_len) - msg->nm_nlh->nlmsg_len;
937  if (pad > 0) {
938  /*
939  * Data inside attribute does not end at a alignment boundry.
940  * Pad accordingly and accoun for the additional space in
941  * the message. nlmsg_reserve() may never fail in this situation,
942  * the allocate message buffer must be a multiple of NLMSG_ALIGNTO.
943  */
944  if (!nlmsg_reserve(msg, pad, 0))
945  BUG();
946 
947  NL_DBG(2, "msg %p: attr <%p> %d: added %zu bytes of padding\n",
948  msg, start, start->nla_type, pad);
949  }
950 
951  NL_DBG(2, "msg %p: attr <%p> %d: closing nesting, len=%u\n",
952  msg, start, start->nla_type, start->nla_len);
953 
954  return 0;
955 }
956 
957 /**
958  * Cancel the addition of a nested attribute
959  * @arg msg Netlink message
960  * @arg attr Nested netlink attribute
961  *
962  * Removes any partially added nested Netlink attribute from the message
963  * by resetting the message to the size before the call to nla_nest_start()
964  * and by overwriting any potentially touched message segments with 0.
965  */
966 void nla_nest_cancel(struct nl_msg *msg, const struct nlattr *attr)
967 {
968  ssize_t len;
969 
970  len = (void *) nlmsg_tail(msg->nm_nlh) - (void *) attr;
971  if (len < 0)
972  BUG();
973  else if (len > 0) {
974  msg->nm_nlh->nlmsg_len -= len;
975  memset(nlmsg_tail(msg->nm_nlh), 0, len);
976  }
977 }
978 
979 /**
980  * Create attribute index based on nested attribute
981  * @arg tb Index array to be filled (maxtype+1 elements).
982  * @arg maxtype Maximum attribute type expected and accepted.
983  * @arg nla Nested Attribute.
984  * @arg policy Attribute validation policy.
985  *
986  * Feeds the stream of attributes nested into the specified attribute
987  * to nla_parse().
988  *
989  * @see nla_parse
990  * @return 0 on success or a negative error code.
991  */
992 int nla_parse_nested(struct nlattr *tb[], int maxtype, struct nlattr *nla,
993  struct nla_policy *policy)
994 {
995  return nla_parse(tb, maxtype, nla_data(nla), nla_len(nla), policy);
996 }
997 
998 /**
999  * Return true if attribute has NLA_F_NESTED flag set
1000  * @arg attr Netlink attribute
1001  *
1002  * @return True if attribute has NLA_F_NESTED flag set, oterhwise False.
1003  */
1004 int nla_is_nested(const struct nlattr *attr)
1005 {
1006  return !!(attr->nla_type & NLA_F_NESTED);
1007 }
1008 
1009 /** @} */
1010 
1011 /** @} */
8 bit integer
Definition: attr.h:39
int nla_ok(const struct nlattr *nla, int remaining)
Check if the attribute header and payload can be accessed safely.
Definition: attr.c:148
int32_t nla_get_s32(const struct nlattr *nla)
Return payload of 32 bit signed integer attribute.
Definition: attr.c:674
int nla_padlen(int payload)
Return length of padding at the tail of the attribute.
Definition: attr.c:91
int nla_put_u16(struct nl_msg *msg, int attrtype, uint16_t value)
Add 16 bit integer attribute to netlink message.
Definition: attr.c:638
struct nlattr * nla_find(const struct nlattr *head, int len, int attrtype)
Find a single attribute in a stream of attributes.
Definition: attr.c:323
void * nlmsg_data(const struct nlmsghdr *nlh)
Return pointer to message payload.
Definition: msg.c:105
int nla_get_flag(const struct nlattr *nla)
Return true if flag attribute is set.
Definition: attr.c:825
void * nl_data_get(const struct nl_data *data)
Get data buffer of abstract data object.
Definition: data.c:153
int16_t nla_get_s16(const struct nlattr *nla)
Return payload of 16 bit signed integer attribute.
Definition: attr.c:624
int nla_put_addr(struct nl_msg *msg, int attrtype, struct nl_addr *addr)
Add abstract address as unspecific attribute to netlink message.
Definition: attr.c:542
int nla_put_s8(struct nl_msg *msg, int attrtype, int8_t value)
Add 8 bit signed integer attribute to netlink message.
Definition: attr.c:563
void * nlmsg_reserve(struct nl_msg *n, size_t len, int pad)
Reserve room for additional data in a netlink message.
Definition: msg.c:407
Attribute validation policy.
Definition: attr.h:67
uint8_t nla_get_u8(const struct nlattr *nla)
Return value of 8 bit integer attribute.
Definition: attr.c:599
Unspecified type, binary data chunk.
Definition: attr.h:38
int nla_strcmp(const struct nlattr *nla, const char *str)
Compare string attribute payload with string.
Definition: attr.c:423
char * nla_get_string(const struct nlattr *nla)
Return payload of string attribute.
Definition: attr.c:790
uint32_t nla_get_u32(const struct nlattr *nla)
Return payload of 32 bit integer attribute.
Definition: attr.c:699
size_t nl_data_get_size(const struct nl_data *data)
Get size of data buffer of abstract data object.
Definition: data.c:165
struct nlattr * nla_reserve(struct nl_msg *msg, int attrtype, int attrlen)
Reserve space for a attribute.
Definition: attr.c:456
int8_t nla_get_s8(const struct nlattr *nla)
Return value of 8 bit signed integer attribute.
Definition: attr.c:574
int nla_put_s32(struct nl_msg *msg, int attrtype, int32_t value)
Add 32 bit signed integer attribute to netlink message.
Definition: attr.c:663
NUL terminated character string.
Definition: attr.h:43
int nla_is_nested(const struct nlattr *attr)
Return true if attribute has NLA_F_NESTED flag set.
Definition: attr.c:1004
int nla_total_size(int payload)
Return size of attribute including padding.
Definition: attr.c:73
int nla_nest_end(struct nl_msg *msg, struct nlattr *start)
Finalize nesting of attributes.
Definition: attr.c:917
int nla_put_flag(struct nl_msg *msg, int attrtype)
Add flag netlink attribute to netlink message.
Definition: attr.c:814
int64_t nla_get_s64(const struct nlattr *nla)
Return payload of s64 attribute.
Definition: attr.c:724
struct nlattr * nla_next(const struct nlattr *nla, int *remaining)
Return next attribute in a stream of attributes.
Definition: attr.c:171
int nlmsg_datalen(const struct nlmsghdr *nlh)
Return length of message payload.
Definition: msg.c:121
int nla_put_data(struct nl_msg *msg, int attrtype, const struct nl_data *data)
Add abstract data as unspecific attribute to netlink message.
Definition: attr.c:527
int nla_memcpy(void *dest, const struct nlattr *src, int count)
Copy attribute payload to another memory area.
Definition: attr.c:353
int nla_parse_nested(struct nlattr *tb[], int maxtype, struct nlattr *nla, struct nla_policy *policy)
Create attribute index based on nested attribute.
Definition: attr.c:992
int nla_type(const struct nlattr *nla)
Return type of the attribute.
Definition: attr.c:109
16 bit integer
Definition: attr.h:40
int nla_put_msecs(struct nl_msg *n, int attrtype, unsigned long msecs)
Add a msecs netlink attribute to a netlink message.
Definition: attr.c:842
int nla_attr_size(int payload)
Return size of attribute whithout padding.
Definition: attr.c:55
int nla_put_u64(struct nl_msg *msg, int attrtype, uint64_t value)
Add 64 bit integer attribute to netlink message.
Definition: attr.c:743
int nla_put_nested(struct nl_msg *msg, int attrtype, const struct nl_msg *nested)
Add nested attributes to netlink message.
Definition: attr.c:877
void * nla_data(const struct nlattr *nla)
Return pointer to the payload section.
Definition: attr.c:120
uint16_t maxlen
Maximal length of payload allowed.
Definition: attr.h:75
int nla_len(const struct nlattr *nla)
Return length of the payload .
Definition: attr.c:131
int nla_parse(struct nlattr *tb[], int maxtype, struct nlattr *head, int len, struct nla_policy *policy)
Create attribute index based on a stream of attributes.
Definition: attr.c:242
unsigned long nla_get_msecs(const struct nlattr *nla)
Return payload of msecs attribute.
Definition: attr.c:853
uint16_t minlen
Minimal length of payload required.
Definition: attr.h:72
64 bit integer
Definition: attr.h:42
int nla_put_s16(struct nl_msg *msg, int attrtype, int16_t value)
Add 16 bit signed integer attribute to netlink message.
Definition: attr.c:613
void nla_nest_cancel(struct nl_msg *msg, const struct nlattr *attr)
Cancel the addition of a nested attribute.
Definition: attr.c:966
uint16_t type
Type of attribute or NLA_UNSPEC.
Definition: attr.h:69
int nla_memcmp(const struct nlattr *nla, const void *data, size_t size)
Compare attribute payload with memory area.
Definition: attr.c:405
uint16_t nla_get_u16(const struct nlattr *nla)
Return payload of 16 bit integer attribute.
Definition: attr.c:649
int nla_put_u32(struct nl_msg *msg, int attrtype, uint32_t value)
Add 32 bit integer attribute to netlink message.
Definition: attr.c:688
32 bit integer
Definition: attr.h:41
Flag.
Definition: attr.h:44
int nla_put_u8(struct nl_msg *msg, int attrtype, uint8_t value)
Add 8 bit integer attribute to netlink message.
Definition: attr.c:588
uint64_t nla_get_u64(const struct nlattr *nla)
Return payload of u64 attribute.
Definition: attr.c:754
int nla_put_string(struct nl_msg *msg, int attrtype, const char *str)
Add string attribute to netlink message.
Definition: attr.c:779
int nla_put(struct nl_msg *msg, int attrtype, int datalen, const void *data)
Add a unspecific attribute to netlink message.
Definition: attr.c:497
unsigned int nl_addr_get_len(const struct nl_addr *addr)
Get length of binary address of abstract address object.
Definition: addr.c:905
int nla_put_s64(struct nl_msg *msg, int attrtype, int64_t value)
Add 64 bit signed integer attribute to netlink message.
Definition: attr.c:713
void * nl_addr_get_binary_addr(const struct nl_addr *addr)
Get binary address of abstract address object.
Definition: addr.c:893
size_t nla_strlcpy(char *dst, const struct nlattr *nla, size_t dstsize)
Copy string attribute payload to a buffer.
Definition: attr.c:378
struct nlattr * nla_nest_start(struct nl_msg *msg, int attrtype)
Start a new level of nested attributes.
Definition: attr.c:895
#define nla_for_each_attr(pos, head, len, rem)
Iterate over a stream of attributes.
Definition: attr.h:315
int nla_validate(const struct nlattr *head, int len, int maxtype, const struct nla_policy *policy)
Validate a stream of attributes.
Definition: attr.c:294