Lines Matching +full:attribute +full:- +full:set
1 /* SPDX-License-Identifier: GPL-2.0 */
12 * ------------------------------------------------------------------------
14 * ------------------------------------------------------------------------
17 * <--- nlmsg_total_size(payload) --->
18 * <-- nlmsg_msg_size(payload) ->
19 * +----------+- - -+-------------+- - -+-------- - -
21 * +----------+- - -+-------------+- - -+-------- - -
22 * nlmsg_data(nlh)---^ ^
23 * nlmsg_next(nlh)-----------------------+
26 * <---------------------- nlmsg_len(nlh) --------------------->
27 * <------ hdrlen ------> <- nlmsg_attrlen(nlh, hdrlen) ->
28 * +----------------------+- - -+--------------------------------+
30 * +----------------------+- - -+--------------------------------+
31 * nlmsg_attrdata(nlh, hdrlen)---^
66 * nlmsg_find_attr() find an attribute in a message
74 * ------------------------------------------------------------------------
76 * ------------------------------------------------------------------------
78 * Attribute Format:
79 * <------- nla_total_size(payload) ------->
80 * <---- nla_attr_size(payload) ----->
81 * +----------+- - -+- - - - - - - - - +- - -+-------- - -
83 * +----------+- - -+- - - - - - - - - +- - -+-------- - -
84 * <- nla_len(nla) -> ^
85 * nla_data(nla)----^ |
86 * nla_next(nla)-----------------------------'
89 * struct nlattr netlink attribute header
91 * Attribute Construction:
92 * nla_reserve(skb, type, len) reserve room for an attribute
93 * nla_reserve_nohdr(skb, len) reserve room for an attribute w/o hdr
94 * nla_put(skb, type, len, data) add attribute to skb
95 * nla_put_nohdr(skb, len, data) add attribute w/o hdr
98 * Attribute Construction for Basic Types:
99 * nla_put_u8(skb, type, value) add u8 attribute to skb
100 * nla_put_u16(skb, type, value) add u16 attribute to skb
101 * nla_put_u32(skb, type, value) add u32 attribute to skb
103 * value, padattr) add u64 attribute to skb
104 * nla_put_s8(skb, type, value) add s8 attribute to skb
105 * nla_put_s16(skb, type, value) add s16 attribute to skb
106 * nla_put_s32(skb, type, value) add s32 attribute to skb
108 * padattr) add s64 attribute to skb
109 * nla_put_string(skb, type, str) add string attribute to skb
110 * nla_put_flag(skb, type) add flag attribute to skb
112 * padattr) add msecs attribute to skb
113 * nla_put_in_addr(skb, type, addr) add IPv4 address attribute to skb
114 * nla_put_in6_addr(skb, type, addr) add IPv6 address attribute to skb
117 * nla_nest_start(skb, type) start a nested attribute
118 * nla_nest_end(skb, nla) finalize a nested attribute
119 * nla_nest_cancel(skb, nla) cancel nested attribute construction
121 * Attribute Length Calculations:
122 * nla_attr_size(payload) length of attribute w/o padding
123 * nla_total_size(payload) length of attribute w/ padding
126 * Attribute Payload Access:
127 * nla_data(nla) head of attribute payload
128 * nla_len(nla) length of attribute payload
130 * Attribute Payload Access for Basic Types:
131 * nla_get_u8(nla) get payload for a u8 attribute
132 * nla_get_u16(nla) get payload for a u16 attribute
133 * nla_get_u32(nla) get payload for a u32 attribute
134 * nla_get_u64(nla) get payload for a u64 attribute
135 * nla_get_s8(nla) get payload for a s8 attribute
136 * nla_get_s16(nla) get payload for a s16 attribute
137 * nla_get_s32(nla) get payload for a s32 attribute
138 * nla_get_s64(nla) get payload for a s64 attribute
140 * nla_get_msecs(nla) get payload for a msecs attribute
142 * Attribute Misc:
143 * nla_memcpy(dest, nla, count) copy attribute into memory
144 * nla_memcmp(nla, data, size) compare attribute with memory area
145 * nla_strscpy(dst, nla, size) copy attribute to a sized string
146 * nla_strcmp(nla, str) compare attribute with string
148 * Attribute Parsing:
150 * nla_next(nla, remaining) get next netlink attribute
153 * nla_find() find attribute in stream of attributes
154 * nla_find_nested() find attribute in nested attributes
163 * Standard attribute types to specify validation policy
189 #define NLA_TYPE_MAX (__NLA_TYPE_MAX - 1)
211 * struct nla_policy - attribute validation policy
212 * @type: Type of attribute or NLA_UNSPEC
213 * @validation_type: type of attribute validation done in addition to
214 * type-specific validation (e.g. range, function call), see
219 * accessible by attribute type up to the highest identifier to be expected.
225 * NLA_BINARY Maximum length of attribute payload
242 * All other Minimum length of attribute payload
245 * NLA_BITFIELD32 This is a 32-bit bitmap/bitselector attribute and
247 * NLA_REJECT This attribute is always rejected and `reject_message'
251 * also set `len' to the max attribute number. Use the
254 * parse, the nested sub-policies.
256 * must also set `len' to the max attribute number. Use
261 * level down and the attribute types directly in the
275 * the value of the integer attribute.
279 * of s16 - do that using the NLA_POLICY_FULL_RANGE()
286 * NLA_U64 If the validation_type field instead is set to
294 * NLA_S64 If the validation_type field instead is set to
302 * integers) of the attribute is enforced.
304 * All other Unused - but note that it's a union
307 * NLA_BINARY Validation function called for the attribute.
308 * All other Unused - but note that it's a union
327 * @strict_start_type: first attribute to validate strictly
329 * This entry is special, and used for the attribute at index 0
332 * starts for any attribute types >= this value, also, strict
341 * For completely new families it should be set to 1 so that the
343 * it should be set at least when new attributes are added to
344 * the enum used by the policy, and be set to the new value that
349 /* private: use NLA_POLICY_*() to set */
372 _NLA_POLICY_NESTED(ARRAY_SIZE(policy) - 1, policy)
374 _NLA_POLICY_NESTED_ARRAY(ARRAY_SIZE(policy) - 1, policy)
458 * struct nl_info - netlink source information
463 * @skip_notify_kernel: Skip selected in-kernel notifications
474 * enum netlink_validation - netlink message/attribute validation levels
475 * @NL_VALIDATE_LIBERAL: Old-style "be liberal" validation, not caring about
478 * @NL_VALIDATE_TRAILING: Reject junk data encountered after attribute parsing.
482 * This can safely be set by the kernel when the given policy has no
485 * @NL_VALIDATE_STRICT_ATTRS: strict attribute policy parsing (e.g.
487 * @NL_VALIDATE_NESTED: Check that NLA_F_NESTED is set for NLA_NESTED(_ARRAY)
550 * nlmsg_msg_size - length of netlink message not including padding
559 * nlmsg_total_size - length of netlink message including padding
568 * nlmsg_padlen - length of padding at the message's tail
573 return nlmsg_total_size(payload) - nlmsg_msg_size(payload); in nlmsg_padlen()
577 * nlmsg_data - head of message payload
586 * nlmsg_len - length of message payload
591 return nlh->nlmsg_len - NLMSG_HDRLEN; in nlmsg_len()
595 * nlmsg_attrdata - head of attributes data
607 * nlmsg_attrlen - length of attributes data
613 return nlmsg_len(nlh) - NLMSG_ALIGN(hdrlen); in nlmsg_attrlen()
617 * nlmsg_ok - check if the netlink message fits into the remaining bytes
624 nlh->nlmsg_len >= sizeof(struct nlmsghdr) && in nlmsg_ok()
625 nlh->nlmsg_len <= remaining); in nlmsg_ok()
629 * nlmsg_next - next netlink message in message stream
639 int totlen = NLMSG_ALIGN(nlh->nlmsg_len); in nlmsg_next()
641 *remaining -= totlen; in nlmsg_next()
647 * nla_parse - Parse a stream of attributes into a tb buffer
649 * @maxtype: maximum attribute type to be expected
650 * @head: head of attribute stream
651 * @len: length of attribute stream
655 * Parses a stream of attributes and stores a pointer to each attribute in
656 * the tb array accessible via the attribute type. Attributes with a type
672 * nla_parse_deprecated - Parse a stream of attributes into a tb buffer
674 * @maxtype: maximum attribute type to be expected
675 * @head: head of attribute stream
676 * @len: length of attribute stream
680 * Parses a stream of attributes and stores a pointer to each attribute in
681 * the tb array accessible via the attribute type. Attributes with a type
697 * nla_parse_deprecated_strict - Parse a stream of attributes into a tb buffer
699 * @maxtype: maximum attribute type to be expected
700 * @head: head of attribute stream
701 * @len: length of attribute stream
705 * Parses a stream of attributes and stores a pointer to each attribute in
706 * the tb array accessible via the attribute type. Attributes with a type
723 * __nlmsg_parse - parse attributes of a netlink message
727 * @maxtype: maximum attribute type to be expected
740 if (nlh->nlmsg_len < nlmsg_msg_size(hdrlen)) { in __nlmsg_parse()
742 return -EINVAL; in __nlmsg_parse()
751 * nlmsg_parse - parse attributes of a netlink message
755 * @maxtype: maximum attribute type to be expected
771 * nlmsg_parse_deprecated - parse attributes of a netlink message
775 * @maxtype: maximum attribute type to be expected
791 * nlmsg_parse_deprecated_strict - parse attributes of a netlink message
795 * @maxtype: maximum attribute type to be expected
812 * nlmsg_find_attr - find a specific attribute in a netlink message
815 * @attrtype: type of attribute to look for
817 * Returns the first attribute which matches the specified type.
827 * nla_validate_deprecated - Validate a stream of attributes
828 * @head: head of attribute stream
829 * @len: length of attribute stream
830 * @maxtype: maximum attribute type to be expected
834 * Validates all attributes in the specified attribute stream against the
850 * nla_validate - Validate a stream of attributes
851 * @head: head of attribute stream
852 * @len: length of attribute stream
853 * @maxtype: maximum attribute type to be expected
857 * Validates all attributes in the specified attribute stream against the
872 * nlmsg_validate_deprecated - validate a netlink message including attributes
875 * @maxtype: maximum attribute type to be expected
884 if (nlh->nlmsg_len < nlmsg_msg_size(hdrlen)) in nlmsg_validate_deprecated()
885 return -EINVAL; in nlmsg_validate_deprecated()
895 * nlmsg_report - need to report back to application?
902 return nlh ? !!(nlh->nlmsg_flags & NLM_F_ECHO) : 0; in nlmsg_report()
906 * nlmsg_seq - return the seq number of netlink message
913 return nlh ? nlh->nlmsg_seq : 0; in nlmsg_seq()
917 * nlmsg_for_each_attr - iterate over a stream of attributes
918 * @pos: loop counter, set to current attribute
928 * nlmsg_put - Add a new netlink message to an skb
949 * nlmsg_append - Add more data to a nlmsg in a skb
954 * with multiple fixed-format headers (which is rare).
963 if (NLMSG_ALIGN(size) - size) in nlmsg_append()
965 NLMSG_ALIGN(size) - size); in nlmsg_append()
970 * nlmsg_put_answer - Add a new callback based netlink message to an skb
985 return nlmsg_put(skb, NETLINK_CB(cb->skb).portid, cb->nlh->nlmsg_seq, in nlmsg_put_answer()
990 * nlmsg_new - Allocate a new netlink message
1003 * nlmsg_end - Finalize a netlink message
1013 nlh->nlmsg_len = skb_tail_pointer(skb) - (unsigned char *)nlh; in nlmsg_end()
1017 * nlmsg_get_pos - return current position in netlink message
1028 * nlmsg_trim - Trim message to a mark
1037 WARN_ON((unsigned char *) mark < skb->data); in nlmsg_trim()
1038 skb_trim(skb, (unsigned char *) mark - skb->data); in nlmsg_trim()
1043 * nlmsg_cancel - Cancel construction of a netlink message
1056 * nlmsg_free - free a netlink message
1065 * nlmsg_multicast - multicast a netlink message
1087 * nlmsg_unicast - unicast a netlink message
1104 * nlmsg_for_each_msg - iterate over a stream of messages
1105 * @pos: loop counter, set to current message
1116 * nl_dump_check_consistent - check if sequence is consistent and advertise if not
1123 * The correct way to use it is to set cb->seq to the generation counter when
1134 if (cb->prev_seq && cb->seq != cb->prev_seq) in nl_dump_check_consistent()
1135 nlh->nlmsg_flags |= NLM_F_DUMP_INTR; in nl_dump_check_consistent()
1136 cb->prev_seq = cb->seq; in nl_dump_check_consistent()
1144 * nla_attr_size - length of attribute not including padding
1153 * nla_total_size - total length of attribute including padding
1162 * nla_padlen - length of padding at the tail of attribute
1167 return nla_total_size(payload) - nla_attr_size(payload); in nla_padlen()
1171 * nla_type - attribute type
1172 * @nla: netlink attribute
1176 return nla->nla_type & NLA_TYPE_MASK; in nla_type()
1180 * nla_data - head of payload
1181 * @nla: netlink attribute
1189 * nla_len - length of payload
1190 * @nla: netlink attribute
1194 return nla->nla_len - NLA_HDRLEN; in nla_len()
1198 * nla_ok - check if the netlink attribute fits into the remaining bytes
1199 * @nla: netlink attribute
1200 * @remaining: number of bytes remaining in attribute stream
1205 nla->nla_len >= sizeof(*nla) && in nla_ok()
1206 nla->nla_len <= remaining; in nla_ok()
1210 * nla_next - next netlink attribute in attribute stream
1211 * @nla: netlink attribute
1212 * @remaining: number of bytes remaining in attribute stream
1214 * Returns the next netlink attribute in the attribute stream and
1215 * decrements remaining by the size of the current attribute.
1219 unsigned int totlen = NLA_ALIGN(nla->nla_len); in nla_next()
1221 *remaining -= totlen; in nla_next()
1226 * nla_find_nested - find attribute in a set of nested attributes
1227 * @nla: attribute containing the nested attributes
1228 * @attrtype: type of attribute to look for
1230 * Returns the first attribute which matches the specified type.
1239 * nla_parse_nested - parse nested attributes
1241 * @maxtype: maximum attribute type to be expected
1242 * @nla: attribute containing the nested attributes
1253 if (!(nla->nla_type & NLA_F_NESTED)) { in nla_parse_nested()
1255 return -EINVAL; in nla_parse_nested()
1263 * nla_parse_nested_deprecated - parse nested attributes
1265 * @maxtype: maximum attribute type to be expected
1266 * @nla: attribute containing the nested attributes
1282 * nla_put_u8 - Add a u8 netlink attribute to a socket buffer
1283 * @skb: socket buffer to add attribute to
1284 * @attrtype: attribute type
1289 /* temporary variables to work around GCC PR81715 with asan-stack=1 */ in nla_put_u8()
1296 * nla_put_u16 - Add a u16 netlink attribute to a socket buffer
1297 * @skb: socket buffer to add attribute to
1298 * @attrtype: attribute type
1309 * nla_put_be16 - Add a __be16 netlink attribute to a socket buffer
1310 * @skb: socket buffer to add attribute to
1311 * @attrtype: attribute type
1322 * nla_put_net16 - Add 16-bit network byte order netlink attribute to a socket buffer
1323 * @skb: socket buffer to add attribute to
1324 * @attrtype: attribute type
1335 * nla_put_le16 - Add a __le16 netlink attribute to a socket buffer
1336 * @skb: socket buffer to add attribute to
1337 * @attrtype: attribute type
1348 * nla_put_u32 - Add a u32 netlink attribute to a socket buffer
1349 * @skb: socket buffer to add attribute to
1350 * @attrtype: attribute type
1361 * nla_put_be32 - Add a __be32 netlink attribute to a socket buffer
1362 * @skb: socket buffer to add attribute to
1363 * @attrtype: attribute type
1374 * nla_put_net32 - Add 32-bit network byte order netlink attribute to a socket buffer
1375 * @skb: socket buffer to add attribute to
1376 * @attrtype: attribute type
1387 * nla_put_le32 - Add a __le32 netlink attribute to a socket buffer
1388 * @skb: socket buffer to add attribute to
1389 * @attrtype: attribute type
1400 * nla_put_u64_64bit - Add a u64 netlink attribute to a skb and align it
1401 * @skb: socket buffer to add attribute to
1402 * @attrtype: attribute type
1404 * @padattr: attribute type for the padding
1415 * nla_put_be64 - Add a __be64 netlink attribute to a socket buffer and align it
1416 * @skb: socket buffer to add attribute to
1417 * @attrtype: attribute type
1419 * @padattr: attribute type for the padding
1430 * nla_put_net64 - Add 64-bit network byte order nlattr to a skb and align it
1431 * @skb: socket buffer to add attribute to
1432 * @attrtype: attribute type
1434 * @padattr: attribute type for the padding
1446 * nla_put_le64 - Add a __le64 netlink attribute to a socket buffer and align it
1447 * @skb: socket buffer to add attribute to
1448 * @attrtype: attribute type
1450 * @padattr: attribute type for the padding
1461 * nla_put_s8 - Add a s8 netlink attribute to a socket buffer
1462 * @skb: socket buffer to add attribute to
1463 * @attrtype: attribute type
1474 * nla_put_s16 - Add a s16 netlink attribute to a socket buffer
1475 * @skb: socket buffer to add attribute to
1476 * @attrtype: attribute type
1487 * nla_put_s32 - Add a s32 netlink attribute to a socket buffer
1488 * @skb: socket buffer to add attribute to
1489 * @attrtype: attribute type
1500 * nla_put_s64 - Add a s64 netlink attribute to a socket buffer and align it
1501 * @skb: socket buffer to add attribute to
1502 * @attrtype: attribute type
1504 * @padattr: attribute type for the padding
1515 * nla_put_string - Add a string netlink attribute to a socket buffer
1516 * @skb: socket buffer to add attribute to
1517 * @attrtype: attribute type
1527 * nla_put_flag - Add a flag netlink attribute to a socket buffer
1528 * @skb: socket buffer to add attribute to
1529 * @attrtype: attribute type
1537 * nla_put_msecs - Add a msecs netlink attribute to a skb and align it
1538 * @skb: socket buffer to add attribute to
1539 * @attrtype: attribute type
1541 * @padattr: attribute type for the padding
1552 * nla_put_in_addr - Add an IPv4 address netlink attribute to a socket
1554 * @skb: socket buffer to add attribute to
1555 * @attrtype: attribute type
1567 * nla_put_in6_addr - Add an IPv6 address netlink attribute to a socket
1569 * @skb: socket buffer to add attribute to
1570 * @attrtype: attribute type
1580 * nla_put_bitfield32 - Add a bitfield32 netlink attribute to a socket buffer
1581 * @skb: socket buffer to add attribute to
1582 * @attrtype: attribute type
1595 * nla_get_u32 - return payload of u32 attribute
1596 * @nla: u32 netlink attribute
1604 * nla_get_be32 - return payload of __be32 attribute
1605 * @nla: __be32 netlink attribute
1613 * nla_get_le32 - return payload of __le32 attribute
1614 * @nla: __le32 netlink attribute
1622 * nla_get_u16 - return payload of u16 attribute
1623 * @nla: u16 netlink attribute
1631 * nla_get_be16 - return payload of __be16 attribute
1632 * @nla: __be16 netlink attribute
1640 * nla_get_le16 - return payload of __le16 attribute
1641 * @nla: __le16 netlink attribute
1649 * nla_get_u8 - return payload of u8 attribute
1650 * @nla: u8 netlink attribute
1658 * nla_get_u64 - return payload of u64 attribute
1659 * @nla: u64 netlink attribute
1671 * nla_get_be64 - return payload of __be64 attribute
1672 * @nla: __be64 netlink attribute
1684 * nla_get_le64 - return payload of __le64 attribute
1685 * @nla: __le64 netlink attribute
1693 * nla_get_s32 - return payload of s32 attribute
1694 * @nla: s32 netlink attribute
1702 * nla_get_s16 - return payload of s16 attribute
1703 * @nla: s16 netlink attribute
1711 * nla_get_s8 - return payload of s8 attribute
1712 * @nla: s8 netlink attribute
1720 * nla_get_s64 - return payload of s64 attribute
1721 * @nla: s64 netlink attribute
1733 * nla_get_flag - return payload of flag attribute
1734 * @nla: flag netlink attribute
1742 * nla_get_msecs - return payload of msecs attribute
1743 * @nla: msecs netlink attribute
1755 * nla_get_in_addr - return payload of IPv4 address attribute
1756 * @nla: IPv4 address netlink attribute
1764 * nla_get_in6_addr - return payload of IPv6 address attribute
1765 * @nla: IPv6 address netlink attribute
1776 * nla_get_bitfield32 - return payload of 32 bitfield attribute
1777 * @nla: nla_bitfield32 attribute
1788 * nla_memdup - duplicate attribute memory (kmemdup)
1789 * @src: netlink attribute to duplicate from
1798 * nla_nest_start_noflag - Start a new level of nested attributes
1800 * @attrtype: attribute type of container
1806 * Returns the container attribute or NULL on error
1820 * nla_nest_start - Start a new level of nested attributes, with NLA_F_NESTED
1822 * @attrtype: attribute type of container
1824 * Unlike nla_nest_start_noflag(), mark the nest attribute with NLA_F_NESTED
1827 * Returns the container attribute or NULL on error
1835 * nla_nest_end - Finalize nesting of attributes
1837 * @start: container attribute
1839 * Corrects the container attribute header to include the all
1846 start->nla_len = skb_tail_pointer(skb) - (unsigned char *)start; in nla_nest_end()
1847 return skb->len; in nla_nest_end()
1851 * nla_nest_cancel - Cancel nesting of attributes
1853 * @start: container attribute
1855 * Removes the container attribute and including all nested
1856 * attributes. Returns -EMSGSIZE
1864 * __nla_validate_nested - Validate a stream of nested attributes
1865 * @start: container attribute
1866 * @maxtype: maximum attribute type to be expected
1871 * Validates all attributes in the nested attribute stream against the
1905 * nla_need_padding_for_64bit - test 64-bit alignment of the next attribute
1908 * Return true if padding is needed to align the next attribute (nla_data()) to
1909 * a 64-bit aligned area.
1915 * if the skb->data _is_ aligned. A NOP attribute, plus in nla_need_padding_for_64bit()
1916 * nlattr header for next attribute, will make nla_data() in nla_need_padding_for_64bit()
1917 * 8-byte aligned. in nla_need_padding_for_64bit()
1926 * nla_align_64bit - 64-bit align the nla_data() of next attribute
1928 * @padattr: attribute type for the padding
1930 * Conditionally emit a padding netlink attribute in order to make
1931 * the next attribute we emit have a 64-bit aligned nla_data() area.
1941 return -EMSGSIZE; in nla_align_64bit()
1947 * nla_total_size_64bit - total length of attribute including padding
1960 * nla_for_each_attr - iterate over a stream of attributes
1961 * @pos: loop counter, set to current attribute
1962 * @head: head of attribute stream
1963 * @len: length of attribute stream
1972 * nla_for_each_nested - iterate over nested attributes
1973 * @pos: loop counter, set to current attribute
1974 * @nla: attribute containing the nested attributes
1981 * nla_is_last - Test if attribute is last in stream
1982 * @nla: attribute to test
1987 return nla->nla_len == rem; in nla_is_last()