1b2441318SGreg Kroah-Hartman /* SPDX-License-Identifier: GPL-2.0 */ 2bfa83a9eSThomas Graf #ifndef __NET_NETLINK_H 3bfa83a9eSThomas Graf #define __NET_NETLINK_H 4bfa83a9eSThomas Graf 5bfa83a9eSThomas Graf #include <linux/types.h> 6bfa83a9eSThomas Graf #include <linux/netlink.h> 7d7fe0f24SAl Viro #include <linux/jiffies.h> 8930345eaSJiri Benc #include <linux/in6.h> 9bfa83a9eSThomas Graf 10bfa83a9eSThomas Graf /* ======================================================================== 11bfa83a9eSThomas Graf * Netlink Messages and Attributes Interface (As Seen On TV) 12bfa83a9eSThomas Graf * ------------------------------------------------------------------------ 13bfa83a9eSThomas Graf * Messages Interface 14bfa83a9eSThomas Graf * ------------------------------------------------------------------------ 15bfa83a9eSThomas Graf * 16bfa83a9eSThomas Graf * Message Format: 17bfa83a9eSThomas Graf * <--- nlmsg_total_size(payload) ---> 18bfa83a9eSThomas Graf * <-- nlmsg_msg_size(payload) -> 19bfa83a9eSThomas Graf * +----------+- - -+-------------+- - -+-------- - - 20bfa83a9eSThomas Graf * | nlmsghdr | Pad | Payload | Pad | nlmsghdr 21bfa83a9eSThomas Graf * +----------+- - -+-------------+- - -+-------- - - 22bfa83a9eSThomas Graf * nlmsg_data(nlh)---^ ^ 23bfa83a9eSThomas Graf * nlmsg_next(nlh)-----------------------+ 24bfa83a9eSThomas Graf * 25bfa83a9eSThomas Graf * Payload Format: 26bfa83a9eSThomas Graf * <---------------------- nlmsg_len(nlh) ---------------------> 27bfa83a9eSThomas Graf * <------ hdrlen ------> <- nlmsg_attrlen(nlh, hdrlen) -> 28bfa83a9eSThomas Graf * +----------------------+- - -+--------------------------------+ 29bfa83a9eSThomas Graf * | Family Header | Pad | Attributes | 30bfa83a9eSThomas Graf * +----------------------+- - -+--------------------------------+ 31bfa83a9eSThomas Graf * nlmsg_attrdata(nlh, hdrlen)---^ 32bfa83a9eSThomas Graf * 33bfa83a9eSThomas Graf * Data Structures: 34bfa83a9eSThomas Graf * struct nlmsghdr netlink message header 35bfa83a9eSThomas Graf * 36bfa83a9eSThomas Graf * Message Construction: 37bfa83a9eSThomas Graf * nlmsg_new() create a new netlink message 38bfa83a9eSThomas Graf * nlmsg_put() add a netlink message to an skb 39bfa83a9eSThomas Graf * nlmsg_put_answer() callback based nlmsg_put() 401dc8d8c0SJustin P. Mattock * nlmsg_end() finalize netlink message 41fe4944e5SThomas Graf * nlmsg_get_pos() return current position in message 42fe4944e5SThomas Graf * nlmsg_trim() trim part of message 43bfa83a9eSThomas Graf * nlmsg_cancel() cancel message construction 44bfa83a9eSThomas Graf * nlmsg_free() free a netlink message 45bfa83a9eSThomas Graf * 46bfa83a9eSThomas Graf * Message Sending: 47bfa83a9eSThomas Graf * nlmsg_multicast() multicast message to several groups 48bfa83a9eSThomas Graf * nlmsg_unicast() unicast a message to a single socket 49d387f6adSThomas Graf * nlmsg_notify() send notification message 50bfa83a9eSThomas Graf * 51bfa83a9eSThomas Graf * Message Length Calculations: 52bfa83a9eSThomas Graf * nlmsg_msg_size(payload) length of message w/o padding 53bfa83a9eSThomas Graf * nlmsg_total_size(payload) length of message w/ padding 54bfa83a9eSThomas Graf * nlmsg_padlen(payload) length of padding at tail 55bfa83a9eSThomas Graf * 56bfa83a9eSThomas Graf * Message Payload Access: 57bfa83a9eSThomas Graf * nlmsg_data(nlh) head of message payload 58bfa83a9eSThomas Graf * nlmsg_len(nlh) length of message payload 59bfa83a9eSThomas Graf * nlmsg_attrdata(nlh, hdrlen) head of attributes data 60bfa83a9eSThomas Graf * nlmsg_attrlen(nlh, hdrlen) length of attributes data 61bfa83a9eSThomas Graf * 62bfa83a9eSThomas Graf * Message Parsing: 63bfa83a9eSThomas Graf * nlmsg_ok(nlh, remaining) does nlh fit into remaining bytes? 64bfa83a9eSThomas Graf * nlmsg_next(nlh, remaining) get next netlink message 65bfa83a9eSThomas Graf * nlmsg_parse() parse attributes of a message 66bfa83a9eSThomas Graf * nlmsg_find_attr() find an attribute in a message 67bfa83a9eSThomas Graf * nlmsg_for_each_msg() loop over all messages 68bfa83a9eSThomas Graf * nlmsg_validate() validate netlink message incl. attrs 69bfa83a9eSThomas Graf * nlmsg_for_each_attr() loop over all attributes 70bfa83a9eSThomas Graf * 7197676b6bSThomas Graf * Misc: 7297676b6bSThomas Graf * nlmsg_report() report back to application? 7397676b6bSThomas Graf * 74bfa83a9eSThomas Graf * ------------------------------------------------------------------------ 75bfa83a9eSThomas Graf * Attributes Interface 76bfa83a9eSThomas Graf * ------------------------------------------------------------------------ 77bfa83a9eSThomas Graf * 78bfa83a9eSThomas Graf * Attribute Format: 79bfa83a9eSThomas Graf * <------- nla_total_size(payload) -------> 80bfa83a9eSThomas Graf * <---- nla_attr_size(payload) -----> 81bfa83a9eSThomas Graf * +----------+- - -+- - - - - - - - - +- - -+-------- - - 82bfa83a9eSThomas Graf * | Header | Pad | Payload | Pad | Header 83bfa83a9eSThomas Graf * +----------+- - -+- - - - - - - - - +- - -+-------- - - 84bfa83a9eSThomas Graf * <- nla_len(nla) -> ^ 85bfa83a9eSThomas Graf * nla_data(nla)----^ | 86bfa83a9eSThomas Graf * nla_next(nla)-----------------------------' 87bfa83a9eSThomas Graf * 88bfa83a9eSThomas Graf * Data Structures: 89d1ec3b77SPierre Ynard * struct nlattr netlink attribute header 90bfa83a9eSThomas Graf * 91bfa83a9eSThomas Graf * Attribute Construction: 92fe4944e5SThomas Graf * nla_reserve(skb, type, len) reserve room for an attribute 93fe4944e5SThomas Graf * nla_reserve_nohdr(skb, len) reserve room for an attribute w/o hdr 94bfa83a9eSThomas Graf * nla_put(skb, type, len, data) add attribute to skb 95fe4944e5SThomas Graf * nla_put_nohdr(skb, len, data) add attribute w/o hdr 9601480e1cSPatrick McHardy * nla_append(skb, len, data) append data to skb 97bfa83a9eSThomas Graf * 98bfa83a9eSThomas Graf * Attribute Construction for Basic Types: 99bfa83a9eSThomas Graf * nla_put_u8(skb, type, value) add u8 attribute to skb 100bfa83a9eSThomas Graf * nla_put_u16(skb, type, value) add u16 attribute to skb 101bfa83a9eSThomas Graf * nla_put_u32(skb, type, value) add u32 attribute to skb 10226837012SRolf Eike Beer * nla_put_u64_64bit(skb, type, 10350225243SNicolas Dichtel * value, padattr) add u64 attribute to skb 1044778e0beSJiri Pirko * nla_put_s8(skb, type, value) add s8 attribute to skb 1054778e0beSJiri Pirko * nla_put_s16(skb, type, value) add s16 attribute to skb 1064778e0beSJiri Pirko * nla_put_s32(skb, type, value) add s32 attribute to skb 107756a2f59SNicolas Dichtel * nla_put_s64(skb, type, value, 108756a2f59SNicolas Dichtel * padattr) add s64 attribute to skb 109bfa83a9eSThomas Graf * nla_put_string(skb, type, str) add string attribute to skb 110bfa83a9eSThomas Graf * nla_put_flag(skb, type) add flag attribute to skb 1112175d87cSNicolas Dichtel * nla_put_msecs(skb, type, jiffies, 1122175d87cSNicolas Dichtel * padattr) add msecs attribute to skb 113930345eaSJiri Benc * nla_put_in_addr(skb, type, addr) add IPv4 address attribute to skb 114930345eaSJiri Benc * nla_put_in6_addr(skb, type, addr) add IPv6 address attribute to skb 115bfa83a9eSThomas Graf * 116bfa83a9eSThomas Graf * Nested Attributes Construction: 117bfa83a9eSThomas Graf * nla_nest_start(skb, type) start a nested attribute 118bfa83a9eSThomas Graf * nla_nest_end(skb, nla) finalize a nested attribute 119bfa83a9eSThomas Graf * nla_nest_cancel(skb, nla) cancel nested attribute construction 120bfa83a9eSThomas Graf * 121bfa83a9eSThomas Graf * Attribute Length Calculations: 122bfa83a9eSThomas Graf * nla_attr_size(payload) length of attribute w/o padding 123bfa83a9eSThomas Graf * nla_total_size(payload) length of attribute w/ padding 124bfa83a9eSThomas Graf * nla_padlen(payload) length of padding 125bfa83a9eSThomas Graf * 126bfa83a9eSThomas Graf * Attribute Payload Access: 127bfa83a9eSThomas Graf * nla_data(nla) head of attribute payload 128bfa83a9eSThomas Graf * nla_len(nla) length of attribute payload 129bfa83a9eSThomas Graf * 130bfa83a9eSThomas Graf * Attribute Payload Access for Basic Types: 131bfa83a9eSThomas Graf * nla_get_u8(nla) get payload for a u8 attribute 132bfa83a9eSThomas Graf * nla_get_u16(nla) get payload for a u16 attribute 133bfa83a9eSThomas Graf * nla_get_u32(nla) get payload for a u32 attribute 134bfa83a9eSThomas Graf * nla_get_u64(nla) get payload for a u64 attribute 1354778e0beSJiri Pirko * nla_get_s8(nla) get payload for a s8 attribute 1364778e0beSJiri Pirko * nla_get_s16(nla) get payload for a s16 attribute 1374778e0beSJiri Pirko * nla_get_s32(nla) get payload for a s32 attribute 1384778e0beSJiri Pirko * nla_get_s64(nla) get payload for a s64 attribute 139bfa83a9eSThomas Graf * nla_get_flag(nla) return 1 if flag is true 140bfa83a9eSThomas Graf * nla_get_msecs(nla) get payload for a msecs attribute 141bfa83a9eSThomas Graf * 142bfa83a9eSThomas Graf * Attribute Misc: 143bfa83a9eSThomas Graf * nla_memcpy(dest, nla, count) copy attribute into memory 144bfa83a9eSThomas Graf * nla_memcmp(nla, data, size) compare attribute with memory area 145bfa83a9eSThomas Graf * nla_strlcpy(dst, nla, size) copy attribute to a sized string 146bfa83a9eSThomas Graf * nla_strcmp(nla, str) compare attribute with string 147bfa83a9eSThomas Graf * 148bfa83a9eSThomas Graf * Attribute Parsing: 149bfa83a9eSThomas Graf * nla_ok(nla, remaining) does nla fit into remaining bytes? 150bfa83a9eSThomas Graf * nla_next(nla, remaining) get next netlink attribute 151bfa83a9eSThomas Graf * nla_validate() validate a stream of attributes 1524fe5d5c0SPaul Moore * nla_validate_nested() validate a stream of nested attributes 153bfa83a9eSThomas Graf * nla_find() find attribute in stream of attributes 154fe4944e5SThomas Graf * nla_find_nested() find attribute in nested attributes 155bfa83a9eSThomas Graf * nla_parse() parse and validate stream of attrs 156bfa83a9eSThomas Graf * nla_parse_nested() parse nested attribuets 157bfa83a9eSThomas Graf * nla_for_each_attr() loop over all attributes 15822acb19aSPaul Moore * nla_for_each_nested() loop over the nested attributes 159bfa83a9eSThomas Graf *========================================================================= 160bfa83a9eSThomas Graf */ 161bfa83a9eSThomas Graf 162bfa83a9eSThomas Graf /** 163bfa83a9eSThomas Graf * Standard attribute types to specify validation policy 164bfa83a9eSThomas Graf */ 165bfa83a9eSThomas Graf enum { 166bfa83a9eSThomas Graf NLA_UNSPEC, 167bfa83a9eSThomas Graf NLA_U8, 168bfa83a9eSThomas Graf NLA_U16, 169bfa83a9eSThomas Graf NLA_U32, 170bfa83a9eSThomas Graf NLA_U64, 171bfa83a9eSThomas Graf NLA_STRING, 172bfa83a9eSThomas Graf NLA_FLAG, 173bfa83a9eSThomas Graf NLA_MSECS, 174bfa83a9eSThomas Graf NLA_NESTED, 1751092cb21SPatrick McHardy NLA_NESTED_COMPAT, 176a5531a5dSThomas Graf NLA_NUL_STRING, 177d30045a0SJohannes Berg NLA_BINARY, 1784778e0beSJiri Pirko NLA_S8, 1794778e0beSJiri Pirko NLA_S16, 1804778e0beSJiri Pirko NLA_S32, 1814778e0beSJiri Pirko NLA_S64, 18264c83d83SJamal Hadi Salim NLA_BITFIELD32, 183568b742aSJohannes Berg NLA_REJECT, 184bfa83a9eSThomas Graf __NLA_TYPE_MAX, 185bfa83a9eSThomas Graf }; 186bfa83a9eSThomas Graf 187bfa83a9eSThomas Graf #define NLA_TYPE_MAX (__NLA_TYPE_MAX - 1) 188bfa83a9eSThomas Graf 189bfa83a9eSThomas Graf /** 190bfa83a9eSThomas Graf * struct nla_policy - attribute validation policy 191bfa83a9eSThomas Graf * @type: Type of attribute or NLA_UNSPEC 192a5531a5dSThomas Graf * @len: Type specific length of payload 193bfa83a9eSThomas Graf * 194bfa83a9eSThomas Graf * Policies are defined as arrays of this struct, the array must be 195bfa83a9eSThomas Graf * accessible by attribute type up to the highest identifier to be expected. 196bfa83a9eSThomas Graf * 197a5531a5dSThomas Graf * Meaning of `len' field: 198a5531a5dSThomas Graf * NLA_STRING Maximum length of string 199a5531a5dSThomas Graf * NLA_NUL_STRING Maximum length of string (excluding NUL) 200a5531a5dSThomas Graf * NLA_FLAG Unused 201d30045a0SJohannes Berg * NLA_BINARY Maximum length of attribute payload 2024b6cc728SJohannes Berg * NLA_NESTED Don't use `len' field -- length verification is 2034b6cc728SJohannes Berg * done by checking len of nested header (or empty) 2044b6cc728SJohannes Berg * NLA_NESTED_COMPAT Minimum length of structure payload 2054b6cc728SJohannes Berg * NLA_U8, NLA_U16, 2064b6cc728SJohannes Berg * NLA_U32, NLA_U64, 2074778e0beSJiri Pirko * NLA_S8, NLA_S16, 2084778e0beSJiri Pirko * NLA_S32, NLA_S64, 2094b6cc728SJohannes Berg * NLA_MSECS Leaving the length field zero will verify the 2104b6cc728SJohannes Berg * given type fits, using it verifies minimum length 2114b6cc728SJohannes Berg * just like "All other" 212568b742aSJohannes Berg * NLA_BITFIELD32 Unused 213568b742aSJohannes Berg * NLA_REJECT Unused 2144b6cc728SJohannes Berg * All other Minimum length of attribute payload 215a5531a5dSThomas Graf * 216568b742aSJohannes Berg * Meaning of `validation_data' field: 217568b742aSJohannes Berg * NLA_BITFIELD32 This is a 32-bit bitmap/bitselector attribute and 218568b742aSJohannes Berg * validation data must point to a u32 value of valid 219568b742aSJohannes Berg * flags 220568b742aSJohannes Berg * NLA_REJECT This attribute is always rejected and validation data 221568b742aSJohannes Berg * may point to a string to report as the error instead 222568b742aSJohannes Berg * of the generic one in extended ACK. 223568b742aSJohannes Berg * All other Unused 224568b742aSJohannes Berg * 225bfa83a9eSThomas Graf * Example: 226b54452b0SAlexey Dobriyan * static const struct nla_policy my_policy[ATTR_MAX+1] = { 227bfa83a9eSThomas Graf * [ATTR_FOO] = { .type = NLA_U16 }, 228d30045a0SJohannes Berg * [ATTR_BAR] = { .type = NLA_STRING, .len = BARSIZ }, 229a5531a5dSThomas Graf * [ATTR_BAZ] = { .len = sizeof(struct mystruct) }, 23064c83d83SJamal Hadi Salim * [ATTR_GOO] = { .type = NLA_BITFIELD32, .validation_data = &myvalidflags }, 231bfa83a9eSThomas Graf * }; 232bfa83a9eSThomas Graf */ 233bfa83a9eSThomas Graf struct nla_policy { 234bfa83a9eSThomas Graf u16 type; 235a5531a5dSThomas Graf u16 len; 23664c83d83SJamal Hadi Salim void *validation_data; 237bfa83a9eSThomas Graf }; 238bfa83a9eSThomas Graf 2394e902c57SThomas Graf /** 2404e902c57SThomas Graf * struct nl_info - netlink source information 2414e902c57SThomas Graf * @nlh: Netlink message header of original request 24215e47304SEric W. Biederman * @portid: Netlink PORTID of requesting application 2434e902c57SThomas Graf */ 2444e902c57SThomas Graf struct nl_info { 2454e902c57SThomas Graf struct nlmsghdr *nlh; 2464d1169c1SDenis V. Lunev struct net *nl_net; 24715e47304SEric W. Biederman u32 portid; 2483b1137feSDavid Ahern bool skip_notify; 2494e902c57SThomas Graf }; 2504e902c57SThomas Graf 2514f69053bSJoe Perches int netlink_rcv_skb(struct sk_buff *skb, 2522d4bc933SJohannes Berg int (*cb)(struct sk_buff *, struct nlmsghdr *, 2532d4bc933SJohannes Berg struct netlink_ext_ack *)); 2544f69053bSJoe Perches int nlmsg_notify(struct sock *sk, struct sk_buff *skb, u32 portid, 2554f69053bSJoe Perches unsigned int group, int report, gfp_t flags); 25682ace47aSThomas Graf 2574f69053bSJoe Perches int nla_validate(const struct nlattr *head, int len, int maxtype, 258fceb6435SJohannes Berg const struct nla_policy *policy, 259fceb6435SJohannes Berg struct netlink_ext_ack *extack); 2604f69053bSJoe Perches int nla_parse(struct nlattr **tb, int maxtype, const struct nlattr *head, 261fceb6435SJohannes Berg int len, const struct nla_policy *policy, 262fceb6435SJohannes Berg struct netlink_ext_ack *extack); 2634f69053bSJoe Perches int nla_policy_len(const struct nla_policy *, int); 2644f69053bSJoe Perches struct nlattr *nla_find(const struct nlattr *head, int len, int attrtype); 2654f69053bSJoe Perches size_t nla_strlcpy(char *dst, const struct nlattr *nla, size_t dstsize); 2662cf0c8b3SPhil Sutter char *nla_strdup(const struct nlattr *nla, gfp_t flags); 2674f69053bSJoe Perches int nla_memcpy(void *dest, const struct nlattr *src, int count); 2684f69053bSJoe Perches int nla_memcmp(const struct nlattr *nla, const void *data, size_t size); 2694f69053bSJoe Perches int nla_strcmp(const struct nlattr *nla, const char *str); 2704f69053bSJoe Perches struct nlattr *__nla_reserve(struct sk_buff *skb, int attrtype, int attrlen); 271089bf1a6SNicolas Dichtel struct nlattr *__nla_reserve_64bit(struct sk_buff *skb, int attrtype, 272089bf1a6SNicolas Dichtel int attrlen, int padattr); 2734f69053bSJoe Perches void *__nla_reserve_nohdr(struct sk_buff *skb, int attrlen); 2744f69053bSJoe Perches struct nlattr *nla_reserve(struct sk_buff *skb, int attrtype, int attrlen); 275089bf1a6SNicolas Dichtel struct nlattr *nla_reserve_64bit(struct sk_buff *skb, int attrtype, 276089bf1a6SNicolas Dichtel int attrlen, int padattr); 2774f69053bSJoe Perches void *nla_reserve_nohdr(struct sk_buff *skb, int attrlen); 2784f69053bSJoe Perches void __nla_put(struct sk_buff *skb, int attrtype, int attrlen, 279fe4944e5SThomas Graf const void *data); 280089bf1a6SNicolas Dichtel void __nla_put_64bit(struct sk_buff *skb, int attrtype, int attrlen, 281089bf1a6SNicolas Dichtel const void *data, int padattr); 2824f69053bSJoe Perches void __nla_put_nohdr(struct sk_buff *skb, int attrlen, const void *data); 2834f69053bSJoe Perches int nla_put(struct sk_buff *skb, int attrtype, int attrlen, const void *data); 284089bf1a6SNicolas Dichtel int nla_put_64bit(struct sk_buff *skb, int attrtype, int attrlen, 285089bf1a6SNicolas Dichtel const void *data, int padattr); 2864f69053bSJoe Perches int nla_put_nohdr(struct sk_buff *skb, int attrlen, const void *data); 2874f69053bSJoe Perches int nla_append(struct sk_buff *skb, int attrlen, const void *data); 288bfa83a9eSThomas Graf 289bfa83a9eSThomas Graf /************************************************************************** 290bfa83a9eSThomas Graf * Netlink Messages 291bfa83a9eSThomas Graf **************************************************************************/ 292bfa83a9eSThomas Graf 293bfa83a9eSThomas Graf /** 294bfa83a9eSThomas Graf * nlmsg_msg_size - length of netlink message not including padding 295bfa83a9eSThomas Graf * @payload: length of message payload 296bfa83a9eSThomas Graf */ 297bfa83a9eSThomas Graf static inline int nlmsg_msg_size(int payload) 298bfa83a9eSThomas Graf { 299bfa83a9eSThomas Graf return NLMSG_HDRLEN + payload; 300bfa83a9eSThomas Graf } 301bfa83a9eSThomas Graf 302bfa83a9eSThomas Graf /** 303bfa83a9eSThomas Graf * nlmsg_total_size - length of netlink message including padding 304bfa83a9eSThomas Graf * @payload: length of message payload 305bfa83a9eSThomas Graf */ 306bfa83a9eSThomas Graf static inline int nlmsg_total_size(int payload) 307bfa83a9eSThomas Graf { 308bfa83a9eSThomas Graf return NLMSG_ALIGN(nlmsg_msg_size(payload)); 309bfa83a9eSThomas Graf } 310bfa83a9eSThomas Graf 311bfa83a9eSThomas Graf /** 312bfa83a9eSThomas Graf * nlmsg_padlen - length of padding at the message's tail 313bfa83a9eSThomas Graf * @payload: length of message payload 314bfa83a9eSThomas Graf */ 315bfa83a9eSThomas Graf static inline int nlmsg_padlen(int payload) 316bfa83a9eSThomas Graf { 317bfa83a9eSThomas Graf return nlmsg_total_size(payload) - nlmsg_msg_size(payload); 318bfa83a9eSThomas Graf } 319bfa83a9eSThomas Graf 320bfa83a9eSThomas Graf /** 321bfa83a9eSThomas Graf * nlmsg_data - head of message payload 32270f23fd6SJustin P. Mattock * @nlh: netlink message header 323bfa83a9eSThomas Graf */ 324bfa83a9eSThomas Graf static inline void *nlmsg_data(const struct nlmsghdr *nlh) 325bfa83a9eSThomas Graf { 326bfa83a9eSThomas Graf return (unsigned char *) nlh + NLMSG_HDRLEN; 327bfa83a9eSThomas Graf } 328bfa83a9eSThomas Graf 329bfa83a9eSThomas Graf /** 330bfa83a9eSThomas Graf * nlmsg_len - length of message payload 331bfa83a9eSThomas Graf * @nlh: netlink message header 332bfa83a9eSThomas Graf */ 333bfa83a9eSThomas Graf static inline int nlmsg_len(const struct nlmsghdr *nlh) 334bfa83a9eSThomas Graf { 335bfa83a9eSThomas Graf return nlh->nlmsg_len - NLMSG_HDRLEN; 336bfa83a9eSThomas Graf } 337bfa83a9eSThomas Graf 338bfa83a9eSThomas Graf /** 339bfa83a9eSThomas Graf * nlmsg_attrdata - head of attributes data 340bfa83a9eSThomas Graf * @nlh: netlink message header 341bfa83a9eSThomas Graf * @hdrlen: length of family specific header 342bfa83a9eSThomas Graf */ 343bfa83a9eSThomas Graf static inline struct nlattr *nlmsg_attrdata(const struct nlmsghdr *nlh, 344bfa83a9eSThomas Graf int hdrlen) 345bfa83a9eSThomas Graf { 346bfa83a9eSThomas Graf unsigned char *data = nlmsg_data(nlh); 347bfa83a9eSThomas Graf return (struct nlattr *) (data + NLMSG_ALIGN(hdrlen)); 348bfa83a9eSThomas Graf } 349bfa83a9eSThomas Graf 350bfa83a9eSThomas Graf /** 351bfa83a9eSThomas Graf * nlmsg_attrlen - length of attributes data 352bfa83a9eSThomas Graf * @nlh: netlink message header 353bfa83a9eSThomas Graf * @hdrlen: length of family specific header 354bfa83a9eSThomas Graf */ 355bfa83a9eSThomas Graf static inline int nlmsg_attrlen(const struct nlmsghdr *nlh, int hdrlen) 356bfa83a9eSThomas Graf { 357bfa83a9eSThomas Graf return nlmsg_len(nlh) - NLMSG_ALIGN(hdrlen); 358bfa83a9eSThomas Graf } 359bfa83a9eSThomas Graf 360bfa83a9eSThomas Graf /** 361bfa83a9eSThomas Graf * nlmsg_ok - check if the netlink message fits into the remaining bytes 362bfa83a9eSThomas Graf * @nlh: netlink message header 363bfa83a9eSThomas Graf * @remaining: number of bytes remaining in message stream 364bfa83a9eSThomas Graf */ 365bfa83a9eSThomas Graf static inline int nlmsg_ok(const struct nlmsghdr *nlh, int remaining) 366bfa83a9eSThomas Graf { 367619e803dSVegard Nossum return (remaining >= (int) sizeof(struct nlmsghdr) && 368bfa83a9eSThomas Graf nlh->nlmsg_len >= sizeof(struct nlmsghdr) && 369bfa83a9eSThomas Graf nlh->nlmsg_len <= remaining); 370bfa83a9eSThomas Graf } 371bfa83a9eSThomas Graf 372bfa83a9eSThomas Graf /** 373bfa83a9eSThomas Graf * nlmsg_next - next netlink message in message stream 374bfa83a9eSThomas Graf * @nlh: netlink message header 375bfa83a9eSThomas Graf * @remaining: number of bytes remaining in message stream 376bfa83a9eSThomas Graf * 377bfa83a9eSThomas Graf * Returns the next netlink message in the message stream and 378bfa83a9eSThomas Graf * decrements remaining by the size of the current message. 379bfa83a9eSThomas Graf */ 3803654654fSJan Engelhardt static inline struct nlmsghdr * 3813654654fSJan Engelhardt nlmsg_next(const struct nlmsghdr *nlh, int *remaining) 382bfa83a9eSThomas Graf { 383bfa83a9eSThomas Graf int totlen = NLMSG_ALIGN(nlh->nlmsg_len); 384bfa83a9eSThomas Graf 385bfa83a9eSThomas Graf *remaining -= totlen; 386bfa83a9eSThomas Graf 387bfa83a9eSThomas Graf return (struct nlmsghdr *) ((unsigned char *) nlh + totlen); 388bfa83a9eSThomas Graf } 389bfa83a9eSThomas Graf 390bfa83a9eSThomas Graf /** 391bfa83a9eSThomas Graf * nlmsg_parse - parse attributes of a netlink message 392bfa83a9eSThomas Graf * @nlh: netlink message header 393bfa83a9eSThomas Graf * @hdrlen: length of family specific header 394bfa83a9eSThomas Graf * @tb: destination array with maxtype+1 elements 395bfa83a9eSThomas Graf * @maxtype: maximum attribute type to be expected 396bfa83a9eSThomas Graf * @policy: validation policy 397fceb6435SJohannes Berg * @extack: extended ACK report struct 398bfa83a9eSThomas Graf * 399bfa83a9eSThomas Graf * See nla_parse() 400bfa83a9eSThomas Graf */ 4013a6c2b41SPatrick McHardy static inline int nlmsg_parse(const struct nlmsghdr *nlh, int hdrlen, 402bfa83a9eSThomas Graf struct nlattr *tb[], int maxtype, 403fceb6435SJohannes Berg const struct nla_policy *policy, 404fceb6435SJohannes Berg struct netlink_ext_ack *extack) 405bfa83a9eSThomas Graf { 406bfa83a9eSThomas Graf if (nlh->nlmsg_len < nlmsg_msg_size(hdrlen)) 407bfa83a9eSThomas Graf return -EINVAL; 408bfa83a9eSThomas Graf 409bfa83a9eSThomas Graf return nla_parse(tb, maxtype, nlmsg_attrdata(nlh, hdrlen), 410fceb6435SJohannes Berg nlmsg_attrlen(nlh, hdrlen), policy, extack); 411bfa83a9eSThomas Graf } 412bfa83a9eSThomas Graf 413bfa83a9eSThomas Graf /** 414bfa83a9eSThomas Graf * nlmsg_find_attr - find a specific attribute in a netlink message 415bfa83a9eSThomas Graf * @nlh: netlink message header 416bfa83a9eSThomas Graf * @hdrlen: length of familiy specific header 417bfa83a9eSThomas Graf * @attrtype: type of attribute to look for 418bfa83a9eSThomas Graf * 419bfa83a9eSThomas Graf * Returns the first attribute which matches the specified type. 420bfa83a9eSThomas Graf */ 4216b8c92baSNelson Elhage static inline struct nlattr *nlmsg_find_attr(const struct nlmsghdr *nlh, 422bfa83a9eSThomas Graf int hdrlen, int attrtype) 423bfa83a9eSThomas Graf { 424bfa83a9eSThomas Graf return nla_find(nlmsg_attrdata(nlh, hdrlen), 425bfa83a9eSThomas Graf nlmsg_attrlen(nlh, hdrlen), attrtype); 426bfa83a9eSThomas Graf } 427bfa83a9eSThomas Graf 428bfa83a9eSThomas Graf /** 429bfa83a9eSThomas Graf * nlmsg_validate - validate a netlink message including attributes 430bfa83a9eSThomas Graf * @nlh: netlinket message header 431bfa83a9eSThomas Graf * @hdrlen: length of familiy specific header 432bfa83a9eSThomas Graf * @maxtype: maximum attribute type to be expected 433bfa83a9eSThomas Graf * @policy: validation policy 434fceb6435SJohannes Berg * @extack: extended ACK report struct 435bfa83a9eSThomas Graf */ 4363654654fSJan Engelhardt static inline int nlmsg_validate(const struct nlmsghdr *nlh, 4373654654fSJan Engelhardt int hdrlen, int maxtype, 438fceb6435SJohannes Berg const struct nla_policy *policy, 439fceb6435SJohannes Berg struct netlink_ext_ack *extack) 440bfa83a9eSThomas Graf { 441bfa83a9eSThomas Graf if (nlh->nlmsg_len < nlmsg_msg_size(hdrlen)) 442bfa83a9eSThomas Graf return -EINVAL; 443bfa83a9eSThomas Graf 444bfa83a9eSThomas Graf return nla_validate(nlmsg_attrdata(nlh, hdrlen), 445fceb6435SJohannes Berg nlmsg_attrlen(nlh, hdrlen), maxtype, policy, 446fceb6435SJohannes Berg extack); 447bfa83a9eSThomas Graf } 448bfa83a9eSThomas Graf 449bfa83a9eSThomas Graf /** 45097676b6bSThomas Graf * nlmsg_report - need to report back to application? 45197676b6bSThomas Graf * @nlh: netlink message header 45297676b6bSThomas Graf * 45397676b6bSThomas Graf * Returns 1 if a report back to the application is requested. 45497676b6bSThomas Graf */ 4553a6c2b41SPatrick McHardy static inline int nlmsg_report(const struct nlmsghdr *nlh) 45697676b6bSThomas Graf { 45797676b6bSThomas Graf return !!(nlh->nlmsg_flags & NLM_F_ECHO); 45897676b6bSThomas Graf } 45997676b6bSThomas Graf 46097676b6bSThomas Graf /** 461bfa83a9eSThomas Graf * nlmsg_for_each_attr - iterate over a stream of attributes 462bfa83a9eSThomas Graf * @pos: loop counter, set to current attribute 463bfa83a9eSThomas Graf * @nlh: netlink message header 464bfa83a9eSThomas Graf * @hdrlen: length of familiy specific header 465bfa83a9eSThomas Graf * @rem: initialized to len, holds bytes currently remaining in stream 466bfa83a9eSThomas Graf */ 467bfa83a9eSThomas Graf #define nlmsg_for_each_attr(pos, nlh, hdrlen, rem) \ 468bfa83a9eSThomas Graf nla_for_each_attr(pos, nlmsg_attrdata(nlh, hdrlen), \ 469bfa83a9eSThomas Graf nlmsg_attrlen(nlh, hdrlen), rem) 470bfa83a9eSThomas Graf 471bfa83a9eSThomas Graf /** 472bfa83a9eSThomas Graf * nlmsg_put - Add a new netlink message to an skb 473bfa83a9eSThomas Graf * @skb: socket buffer to store message in 4742c6ba4b1SNicolas Dichtel * @portid: netlink PORTID of requesting application 475bfa83a9eSThomas Graf * @seq: sequence number of message 476bfa83a9eSThomas Graf * @type: message type 477bfa83a9eSThomas Graf * @payload: length of message payload 478bfa83a9eSThomas Graf * @flags: message flags 479bfa83a9eSThomas Graf * 480bfa83a9eSThomas Graf * Returns NULL if the tailroom of the skb is insufficient to store 481bfa83a9eSThomas Graf * the message header and payload. 482bfa83a9eSThomas Graf */ 48315e47304SEric W. Biederman static inline struct nlmsghdr *nlmsg_put(struct sk_buff *skb, u32 portid, u32 seq, 484bfa83a9eSThomas Graf int type, int payload, int flags) 485bfa83a9eSThomas Graf { 486bfa83a9eSThomas Graf if (unlikely(skb_tailroom(skb) < nlmsg_total_size(payload))) 487bfa83a9eSThomas Graf return NULL; 488bfa83a9eSThomas Graf 48915e47304SEric W. Biederman return __nlmsg_put(skb, portid, seq, type, payload, flags); 490bfa83a9eSThomas Graf } 491bfa83a9eSThomas Graf 492bfa83a9eSThomas Graf /** 493bfa83a9eSThomas Graf * nlmsg_put_answer - Add a new callback based netlink message to an skb 494bfa83a9eSThomas Graf * @skb: socket buffer to store message in 495bfa83a9eSThomas Graf * @cb: netlink callback 496bfa83a9eSThomas Graf * @type: message type 497bfa83a9eSThomas Graf * @payload: length of message payload 498bfa83a9eSThomas Graf * @flags: message flags 499bfa83a9eSThomas Graf * 500bfa83a9eSThomas Graf * Returns NULL if the tailroom of the skb is insufficient to store 501bfa83a9eSThomas Graf * the message header and payload. 502bfa83a9eSThomas Graf */ 503bfa83a9eSThomas Graf static inline struct nlmsghdr *nlmsg_put_answer(struct sk_buff *skb, 504bfa83a9eSThomas Graf struct netlink_callback *cb, 505bfa83a9eSThomas Graf int type, int payload, 506bfa83a9eSThomas Graf int flags) 507bfa83a9eSThomas Graf { 50815e47304SEric W. Biederman return nlmsg_put(skb, NETLINK_CB(cb->skb).portid, cb->nlh->nlmsg_seq, 509bfa83a9eSThomas Graf type, payload, flags); 510bfa83a9eSThomas Graf } 511bfa83a9eSThomas Graf 512bfa83a9eSThomas Graf /** 513bfa83a9eSThomas Graf * nlmsg_new - Allocate a new netlink message 514339bf98fSThomas Graf * @payload: size of the message payload 515fe4944e5SThomas Graf * @flags: the type of memory to allocate. 516bfa83a9eSThomas Graf * 517339bf98fSThomas Graf * Use NLMSG_DEFAULT_SIZE if the size of the payload isn't known 518339bf98fSThomas Graf * and a good default is needed. 519bfa83a9eSThomas Graf */ 520339bf98fSThomas Graf static inline struct sk_buff *nlmsg_new(size_t payload, gfp_t flags) 521bfa83a9eSThomas Graf { 522339bf98fSThomas Graf return alloc_skb(nlmsg_total_size(payload), flags); 523bfa83a9eSThomas Graf } 524bfa83a9eSThomas Graf 525bfa83a9eSThomas Graf /** 526bfa83a9eSThomas Graf * nlmsg_end - Finalize a netlink message 527bfa83a9eSThomas Graf * @skb: socket buffer the message is stored in 528bfa83a9eSThomas Graf * @nlh: netlink message header 529bfa83a9eSThomas Graf * 530bfa83a9eSThomas Graf * Corrects the netlink message header to include the appeneded 531bfa83a9eSThomas Graf * attributes. Only necessary if attributes have been added to 532bfa83a9eSThomas Graf * the message. 533bfa83a9eSThomas Graf */ 534053c095aSJohannes Berg static inline void nlmsg_end(struct sk_buff *skb, struct nlmsghdr *nlh) 535bfa83a9eSThomas Graf { 53627a884dcSArnaldo Carvalho de Melo nlh->nlmsg_len = skb_tail_pointer(skb) - (unsigned char *)nlh; 537bfa83a9eSThomas Graf } 538bfa83a9eSThomas Graf 539bfa83a9eSThomas Graf /** 540fe4944e5SThomas Graf * nlmsg_get_pos - return current position in netlink message 541fe4944e5SThomas Graf * @skb: socket buffer the message is stored in 542fe4944e5SThomas Graf * 543fe4944e5SThomas Graf * Returns a pointer to the current tail of the message. 544fe4944e5SThomas Graf */ 545fe4944e5SThomas Graf static inline void *nlmsg_get_pos(struct sk_buff *skb) 546fe4944e5SThomas Graf { 54727a884dcSArnaldo Carvalho de Melo return skb_tail_pointer(skb); 548fe4944e5SThomas Graf } 549fe4944e5SThomas Graf 550fe4944e5SThomas Graf /** 551fe4944e5SThomas Graf * nlmsg_trim - Trim message to a mark 552fe4944e5SThomas Graf * @skb: socket buffer the message is stored in 553fe4944e5SThomas Graf * @mark: mark to trim to 554fe4944e5SThomas Graf * 555bc3ed28cSThomas Graf * Trims the message to the provided mark. 556fe4944e5SThomas Graf */ 557bc3ed28cSThomas Graf static inline void nlmsg_trim(struct sk_buff *skb, const void *mark) 558fe4944e5SThomas Graf { 559149118d8SThomas Graf if (mark) { 560149118d8SThomas Graf WARN_ON((unsigned char *) mark < skb->data); 561fe4944e5SThomas Graf skb_trim(skb, (unsigned char *) mark - skb->data); 562fe4944e5SThomas Graf } 563149118d8SThomas Graf } 564fe4944e5SThomas Graf 565fe4944e5SThomas Graf /** 566bfa83a9eSThomas Graf * nlmsg_cancel - Cancel construction of a netlink message 567bfa83a9eSThomas Graf * @skb: socket buffer the message is stored in 568bfa83a9eSThomas Graf * @nlh: netlink message header 569bfa83a9eSThomas Graf * 570bfa83a9eSThomas Graf * Removes the complete netlink message including all 571bc3ed28cSThomas Graf * attributes from the socket buffer again. 572bfa83a9eSThomas Graf */ 573bc3ed28cSThomas Graf static inline void nlmsg_cancel(struct sk_buff *skb, struct nlmsghdr *nlh) 574bfa83a9eSThomas Graf { 575bc3ed28cSThomas Graf nlmsg_trim(skb, nlh); 576bfa83a9eSThomas Graf } 577bfa83a9eSThomas Graf 578bfa83a9eSThomas Graf /** 579bfa83a9eSThomas Graf * nlmsg_free - free a netlink message 580bfa83a9eSThomas Graf * @skb: socket buffer of netlink message 581bfa83a9eSThomas Graf */ 582bfa83a9eSThomas Graf static inline void nlmsg_free(struct sk_buff *skb) 583bfa83a9eSThomas Graf { 584bfa83a9eSThomas Graf kfree_skb(skb); 585bfa83a9eSThomas Graf } 586bfa83a9eSThomas Graf 587bfa83a9eSThomas Graf /** 588bfa83a9eSThomas Graf * nlmsg_multicast - multicast a netlink message 589bfa83a9eSThomas Graf * @sk: netlink socket to spread messages to 590bfa83a9eSThomas Graf * @skb: netlink message as socket buffer 59115e47304SEric W. Biederman * @portid: own netlink portid to avoid sending to yourself 592bfa83a9eSThomas Graf * @group: multicast group id 593d387f6adSThomas Graf * @flags: allocation flags 594bfa83a9eSThomas Graf */ 595bfa83a9eSThomas Graf static inline int nlmsg_multicast(struct sock *sk, struct sk_buff *skb, 59615e47304SEric W. Biederman u32 portid, unsigned int group, gfp_t flags) 597bfa83a9eSThomas Graf { 598bfa83a9eSThomas Graf int err; 599bfa83a9eSThomas Graf 600bfa83a9eSThomas Graf NETLINK_CB(skb).dst_group = group; 601bfa83a9eSThomas Graf 60215e47304SEric W. Biederman err = netlink_broadcast(sk, skb, portid, group, flags); 603bfa83a9eSThomas Graf if (err > 0) 604bfa83a9eSThomas Graf err = 0; 605bfa83a9eSThomas Graf 606bfa83a9eSThomas Graf return err; 607bfa83a9eSThomas Graf } 608bfa83a9eSThomas Graf 609bfa83a9eSThomas Graf /** 610bfa83a9eSThomas Graf * nlmsg_unicast - unicast a netlink message 611bfa83a9eSThomas Graf * @sk: netlink socket to spread message to 612bfa83a9eSThomas Graf * @skb: netlink message as socket buffer 61315e47304SEric W. Biederman * @portid: netlink portid of the destination socket 614bfa83a9eSThomas Graf */ 61515e47304SEric W. Biederman static inline int nlmsg_unicast(struct sock *sk, struct sk_buff *skb, u32 portid) 616bfa83a9eSThomas Graf { 617bfa83a9eSThomas Graf int err; 618bfa83a9eSThomas Graf 61915e47304SEric W. Biederman err = netlink_unicast(sk, skb, portid, MSG_DONTWAIT); 620bfa83a9eSThomas Graf if (err > 0) 621bfa83a9eSThomas Graf err = 0; 622bfa83a9eSThomas Graf 623bfa83a9eSThomas Graf return err; 624bfa83a9eSThomas Graf } 625bfa83a9eSThomas Graf 626bfa83a9eSThomas Graf /** 627bfa83a9eSThomas Graf * nlmsg_for_each_msg - iterate over a stream of messages 628bfa83a9eSThomas Graf * @pos: loop counter, set to current message 629bfa83a9eSThomas Graf * @head: head of message stream 630bfa83a9eSThomas Graf * @len: length of message stream 631bfa83a9eSThomas Graf * @rem: initialized to len, holds bytes currently remaining in stream 632bfa83a9eSThomas Graf */ 633bfa83a9eSThomas Graf #define nlmsg_for_each_msg(pos, head, len, rem) \ 634bfa83a9eSThomas Graf for (pos = head, rem = len; \ 635bfa83a9eSThomas Graf nlmsg_ok(pos, rem); \ 636bfa83a9eSThomas Graf pos = nlmsg_next(pos, &(rem))) 637bfa83a9eSThomas Graf 638670dc283SJohannes Berg /** 639670dc283SJohannes Berg * nl_dump_check_consistent - check if sequence is consistent and advertise if not 640670dc283SJohannes Berg * @cb: netlink callback structure that stores the sequence number 641670dc283SJohannes Berg * @nlh: netlink message header to write the flag to 642670dc283SJohannes Berg * 643670dc283SJohannes Berg * This function checks if the sequence (generation) number changed during dump 644670dc283SJohannes Berg * and if it did, advertises it in the netlink message header. 645670dc283SJohannes Berg * 646670dc283SJohannes Berg * The correct way to use it is to set cb->seq to the generation counter when 647670dc283SJohannes Berg * all locks for dumping have been acquired, and then call this function for 648670dc283SJohannes Berg * each message that is generated. 649670dc283SJohannes Berg * 650670dc283SJohannes Berg * Note that due to initialisation concerns, 0 is an invalid sequence number 651670dc283SJohannes Berg * and must not be used by code that uses this functionality. 652670dc283SJohannes Berg */ 653670dc283SJohannes Berg static inline void 654670dc283SJohannes Berg nl_dump_check_consistent(struct netlink_callback *cb, 655670dc283SJohannes Berg struct nlmsghdr *nlh) 656670dc283SJohannes Berg { 657670dc283SJohannes Berg if (cb->prev_seq && cb->seq != cb->prev_seq) 658670dc283SJohannes Berg nlh->nlmsg_flags |= NLM_F_DUMP_INTR; 659670dc283SJohannes Berg cb->prev_seq = cb->seq; 660670dc283SJohannes Berg } 661670dc283SJohannes Berg 662bfa83a9eSThomas Graf /************************************************************************** 663bfa83a9eSThomas Graf * Netlink Attributes 664bfa83a9eSThomas Graf **************************************************************************/ 665bfa83a9eSThomas Graf 666bfa83a9eSThomas Graf /** 667bfa83a9eSThomas Graf * nla_attr_size - length of attribute not including padding 668bfa83a9eSThomas Graf * @payload: length of payload 669bfa83a9eSThomas Graf */ 670bfa83a9eSThomas Graf static inline int nla_attr_size(int payload) 671bfa83a9eSThomas Graf { 672bfa83a9eSThomas Graf return NLA_HDRLEN + payload; 673bfa83a9eSThomas Graf } 674bfa83a9eSThomas Graf 675bfa83a9eSThomas Graf /** 676bfa83a9eSThomas Graf * nla_total_size - total length of attribute including padding 677bfa83a9eSThomas Graf * @payload: length of payload 678bfa83a9eSThomas Graf */ 679bfa83a9eSThomas Graf static inline int nla_total_size(int payload) 680bfa83a9eSThomas Graf { 681bfa83a9eSThomas Graf return NLA_ALIGN(nla_attr_size(payload)); 682bfa83a9eSThomas Graf } 683bfa83a9eSThomas Graf 684bfa83a9eSThomas Graf /** 685bfa83a9eSThomas Graf * nla_padlen - length of padding at the tail of attribute 686bfa83a9eSThomas Graf * @payload: length of payload 687bfa83a9eSThomas Graf */ 688bfa83a9eSThomas Graf static inline int nla_padlen(int payload) 689bfa83a9eSThomas Graf { 690bfa83a9eSThomas Graf return nla_total_size(payload) - nla_attr_size(payload); 691bfa83a9eSThomas Graf } 692bfa83a9eSThomas Graf 693bfa83a9eSThomas Graf /** 6948f4c1f9bSThomas Graf * nla_type - attribute type 6958f4c1f9bSThomas Graf * @nla: netlink attribute 6968f4c1f9bSThomas Graf */ 6978f4c1f9bSThomas Graf static inline int nla_type(const struct nlattr *nla) 6988f4c1f9bSThomas Graf { 6998f4c1f9bSThomas Graf return nla->nla_type & NLA_TYPE_MASK; 7008f4c1f9bSThomas Graf } 7018f4c1f9bSThomas Graf 7028f4c1f9bSThomas Graf /** 703bfa83a9eSThomas Graf * nla_data - head of payload 704bfa83a9eSThomas Graf * @nla: netlink attribute 705bfa83a9eSThomas Graf */ 706bfa83a9eSThomas Graf static inline void *nla_data(const struct nlattr *nla) 707bfa83a9eSThomas Graf { 708bfa83a9eSThomas Graf return (char *) nla + NLA_HDRLEN; 709bfa83a9eSThomas Graf } 710bfa83a9eSThomas Graf 711bfa83a9eSThomas Graf /** 712bfa83a9eSThomas Graf * nla_len - length of payload 713bfa83a9eSThomas Graf * @nla: netlink attribute 714bfa83a9eSThomas Graf */ 715bfa83a9eSThomas Graf static inline int nla_len(const struct nlattr *nla) 716bfa83a9eSThomas Graf { 717bfa83a9eSThomas Graf return nla->nla_len - NLA_HDRLEN; 718bfa83a9eSThomas Graf } 719bfa83a9eSThomas Graf 720bfa83a9eSThomas Graf /** 721bfa83a9eSThomas Graf * nla_ok - check if the netlink attribute fits into the remaining bytes 722bfa83a9eSThomas Graf * @nla: netlink attribute 723bfa83a9eSThomas Graf * @remaining: number of bytes remaining in attribute stream 724bfa83a9eSThomas Graf */ 725bfa83a9eSThomas Graf static inline int nla_ok(const struct nlattr *nla, int remaining) 726bfa83a9eSThomas Graf { 7273e1ed981SAlexey Dobriyan return remaining >= (int) sizeof(*nla) && 7283e1ed981SAlexey Dobriyan nla->nla_len >= sizeof(*nla) && 729bfa83a9eSThomas Graf nla->nla_len <= remaining; 730bfa83a9eSThomas Graf } 731bfa83a9eSThomas Graf 732bfa83a9eSThomas Graf /** 733d1ec3b77SPierre Ynard * nla_next - next netlink attribute in attribute stream 734bfa83a9eSThomas Graf * @nla: netlink attribute 735bfa83a9eSThomas Graf * @remaining: number of bytes remaining in attribute stream 736bfa83a9eSThomas Graf * 737bfa83a9eSThomas Graf * Returns the next netlink attribute in the attribute stream and 738bfa83a9eSThomas Graf * decrements remaining by the size of the current attribute. 739bfa83a9eSThomas Graf */ 740bfa83a9eSThomas Graf static inline struct nlattr *nla_next(const struct nlattr *nla, int *remaining) 741bfa83a9eSThomas Graf { 7423b2c75d3SAlexey Dobriyan unsigned int totlen = NLA_ALIGN(nla->nla_len); 743bfa83a9eSThomas Graf 744bfa83a9eSThomas Graf *remaining -= totlen; 745bfa83a9eSThomas Graf return (struct nlattr *) ((char *) nla + totlen); 746bfa83a9eSThomas Graf } 747bfa83a9eSThomas Graf 748bfa83a9eSThomas Graf /** 749fe4944e5SThomas Graf * nla_find_nested - find attribute in a set of nested attributes 750fe4944e5SThomas Graf * @nla: attribute containing the nested attributes 751fe4944e5SThomas Graf * @attrtype: type of attribute to look for 752fe4944e5SThomas Graf * 753fe4944e5SThomas Graf * Returns the first attribute which matches the specified type. 754fe4944e5SThomas Graf */ 7553654654fSJan Engelhardt static inline struct nlattr * 7563654654fSJan Engelhardt nla_find_nested(const struct nlattr *nla, int attrtype) 757fe4944e5SThomas Graf { 758fe4944e5SThomas Graf return nla_find(nla_data(nla), nla_len(nla), attrtype); 759fe4944e5SThomas Graf } 760fe4944e5SThomas Graf 761fe4944e5SThomas Graf /** 762bfa83a9eSThomas Graf * nla_parse_nested - parse nested attributes 763bfa83a9eSThomas Graf * @tb: destination array with maxtype+1 elements 764bfa83a9eSThomas Graf * @maxtype: maximum attribute type to be expected 765bfa83a9eSThomas Graf * @nla: attribute containing the nested attributes 766bfa83a9eSThomas Graf * @policy: validation policy 767fceb6435SJohannes Berg * @extack: extended ACK report struct 768bfa83a9eSThomas Graf * 769bfa83a9eSThomas Graf * See nla_parse() 770bfa83a9eSThomas Graf */ 771bfa83a9eSThomas Graf static inline int nla_parse_nested(struct nlattr *tb[], int maxtype, 772b057efd4SPatrick McHardy const struct nlattr *nla, 773fceb6435SJohannes Berg const struct nla_policy *policy, 774fceb6435SJohannes Berg struct netlink_ext_ack *extack) 775bfa83a9eSThomas Graf { 776fceb6435SJohannes Berg return nla_parse(tb, maxtype, nla_data(nla), nla_len(nla), policy, 777fceb6435SJohannes Berg extack); 778bfa83a9eSThomas Graf } 7791092cb21SPatrick McHardy 7801092cb21SPatrick McHardy /** 781d1ec3b77SPierre Ynard * nla_put_u8 - Add a u8 netlink attribute to a socket buffer 782bfa83a9eSThomas Graf * @skb: socket buffer to add attribute to 783bfa83a9eSThomas Graf * @attrtype: attribute type 784bfa83a9eSThomas Graf * @value: numeric value 785bfa83a9eSThomas Graf */ 786bfa83a9eSThomas Graf static inline int nla_put_u8(struct sk_buff *skb, int attrtype, u8 value) 787bfa83a9eSThomas Graf { 788b4391db4SArnd Bergmann /* temporary variables to work around GCC PR81715 with asan-stack=1 */ 789b4391db4SArnd Bergmann u8 tmp = value; 790b4391db4SArnd Bergmann 791b4391db4SArnd Bergmann return nla_put(skb, attrtype, sizeof(u8), &tmp); 792bfa83a9eSThomas Graf } 793bfa83a9eSThomas Graf 794bfa83a9eSThomas Graf /** 795bfa83a9eSThomas Graf * nla_put_u16 - Add a u16 netlink attribute to a socket buffer 796bfa83a9eSThomas Graf * @skb: socket buffer to add attribute to 797bfa83a9eSThomas Graf * @attrtype: attribute type 798bfa83a9eSThomas Graf * @value: numeric value 799bfa83a9eSThomas Graf */ 800bfa83a9eSThomas Graf static inline int nla_put_u16(struct sk_buff *skb, int attrtype, u16 value) 801bfa83a9eSThomas Graf { 802b4391db4SArnd Bergmann u16 tmp = value; 803b4391db4SArnd Bergmann 804b4391db4SArnd Bergmann return nla_put(skb, attrtype, sizeof(u16), &tmp); 805bfa83a9eSThomas Graf } 806bfa83a9eSThomas Graf 807bfa83a9eSThomas Graf /** 808569a8fc3SDavid S. Miller * nla_put_be16 - Add a __be16 netlink attribute to a socket buffer 809569a8fc3SDavid S. Miller * @skb: socket buffer to add attribute to 810569a8fc3SDavid S. Miller * @attrtype: attribute type 811569a8fc3SDavid S. Miller * @value: numeric value 812569a8fc3SDavid S. Miller */ 813569a8fc3SDavid S. Miller static inline int nla_put_be16(struct sk_buff *skb, int attrtype, __be16 value) 814569a8fc3SDavid S. Miller { 815b4391db4SArnd Bergmann __be16 tmp = value; 816b4391db4SArnd Bergmann 817b4391db4SArnd Bergmann return nla_put(skb, attrtype, sizeof(__be16), &tmp); 818569a8fc3SDavid S. Miller } 819569a8fc3SDavid S. Miller 820569a8fc3SDavid S. Miller /** 8216c1dd3b6SDavid S. Miller * nla_put_net16 - Add 16-bit network byte order netlink attribute to a socket buffer 8226c1dd3b6SDavid S. Miller * @skb: socket buffer to add attribute to 8236c1dd3b6SDavid S. Miller * @attrtype: attribute type 8246c1dd3b6SDavid S. Miller * @value: numeric value 8256c1dd3b6SDavid S. Miller */ 8266c1dd3b6SDavid S. Miller static inline int nla_put_net16(struct sk_buff *skb, int attrtype, __be16 value) 8276c1dd3b6SDavid S. Miller { 828b4391db4SArnd Bergmann __be16 tmp = value; 829b4391db4SArnd Bergmann 830b4391db4SArnd Bergmann return nla_put_be16(skb, attrtype | NLA_F_NET_BYTEORDER, tmp); 8316c1dd3b6SDavid S. Miller } 8326c1dd3b6SDavid S. Miller 8336c1dd3b6SDavid S. Miller /** 83424c410dcSDavid S. Miller * nla_put_le16 - Add a __le16 netlink attribute to a socket buffer 83524c410dcSDavid S. Miller * @skb: socket buffer to add attribute to 83624c410dcSDavid S. Miller * @attrtype: attribute type 83724c410dcSDavid S. Miller * @value: numeric value 83824c410dcSDavid S. Miller */ 83924c410dcSDavid S. Miller static inline int nla_put_le16(struct sk_buff *skb, int attrtype, __le16 value) 84024c410dcSDavid S. Miller { 841b4391db4SArnd Bergmann __le16 tmp = value; 842b4391db4SArnd Bergmann 843b4391db4SArnd Bergmann return nla_put(skb, attrtype, sizeof(__le16), &tmp); 84424c410dcSDavid S. Miller } 84524c410dcSDavid S. Miller 84624c410dcSDavid S. Miller /** 847bfa83a9eSThomas Graf * nla_put_u32 - Add a u32 netlink attribute to a socket buffer 848bfa83a9eSThomas Graf * @skb: socket buffer to add attribute to 849bfa83a9eSThomas Graf * @attrtype: attribute type 850bfa83a9eSThomas Graf * @value: numeric value 851bfa83a9eSThomas Graf */ 852bfa83a9eSThomas Graf static inline int nla_put_u32(struct sk_buff *skb, int attrtype, u32 value) 853bfa83a9eSThomas Graf { 854b4391db4SArnd Bergmann u32 tmp = value; 855b4391db4SArnd Bergmann 856b4391db4SArnd Bergmann return nla_put(skb, attrtype, sizeof(u32), &tmp); 857bfa83a9eSThomas Graf } 858bfa83a9eSThomas Graf 859bfa83a9eSThomas Graf /** 860569a8fc3SDavid S. Miller * nla_put_be32 - Add a __be32 netlink attribute to a socket buffer 861569a8fc3SDavid S. Miller * @skb: socket buffer to add attribute to 862569a8fc3SDavid S. Miller * @attrtype: attribute type 863569a8fc3SDavid S. Miller * @value: numeric value 864569a8fc3SDavid S. Miller */ 865569a8fc3SDavid S. Miller static inline int nla_put_be32(struct sk_buff *skb, int attrtype, __be32 value) 866569a8fc3SDavid S. Miller { 867b4391db4SArnd Bergmann __be32 tmp = value; 868b4391db4SArnd Bergmann 869b4391db4SArnd Bergmann return nla_put(skb, attrtype, sizeof(__be32), &tmp); 870569a8fc3SDavid S. Miller } 871569a8fc3SDavid S. Miller 872569a8fc3SDavid S. Miller /** 8736c1dd3b6SDavid S. Miller * nla_put_net32 - Add 32-bit network byte order netlink attribute to a socket buffer 8746c1dd3b6SDavid S. Miller * @skb: socket buffer to add attribute to 8756c1dd3b6SDavid S. Miller * @attrtype: attribute type 8766c1dd3b6SDavid S. Miller * @value: numeric value 8776c1dd3b6SDavid S. Miller */ 8786c1dd3b6SDavid S. Miller static inline int nla_put_net32(struct sk_buff *skb, int attrtype, __be32 value) 8796c1dd3b6SDavid S. Miller { 880b4391db4SArnd Bergmann __be32 tmp = value; 881b4391db4SArnd Bergmann 882b4391db4SArnd Bergmann return nla_put_be32(skb, attrtype | NLA_F_NET_BYTEORDER, tmp); 8836c1dd3b6SDavid S. Miller } 8846c1dd3b6SDavid S. Miller 8856c1dd3b6SDavid S. Miller /** 88624c410dcSDavid S. Miller * nla_put_le32 - Add a __le32 netlink attribute to a socket buffer 88724c410dcSDavid S. Miller * @skb: socket buffer to add attribute to 88824c410dcSDavid S. Miller * @attrtype: attribute type 88924c410dcSDavid S. Miller * @value: numeric value 89024c410dcSDavid S. Miller */ 89124c410dcSDavid S. Miller static inline int nla_put_le32(struct sk_buff *skb, int attrtype, __le32 value) 89224c410dcSDavid S. Miller { 893b4391db4SArnd Bergmann __le32 tmp = value; 894b4391db4SArnd Bergmann 895b4391db4SArnd Bergmann return nla_put(skb, attrtype, sizeof(__le32), &tmp); 89624c410dcSDavid S. Miller } 89724c410dcSDavid S. Miller 89824c410dcSDavid S. Miller /** 89973520786SNicolas Dichtel * nla_put_u64_64bit - Add a u64 netlink attribute to a skb and align it 90073520786SNicolas Dichtel * @skb: socket buffer to add attribute to 90173520786SNicolas Dichtel * @attrtype: attribute type 90273520786SNicolas Dichtel * @value: numeric value 90373520786SNicolas Dichtel * @padattr: attribute type for the padding 90473520786SNicolas Dichtel */ 90573520786SNicolas Dichtel static inline int nla_put_u64_64bit(struct sk_buff *skb, int attrtype, 90673520786SNicolas Dichtel u64 value, int padattr) 90773520786SNicolas Dichtel { 908b4391db4SArnd Bergmann u64 tmp = value; 909b4391db4SArnd Bergmann 910b4391db4SArnd Bergmann return nla_put_64bit(skb, attrtype, sizeof(u64), &tmp, padattr); 91173520786SNicolas Dichtel } 91273520786SNicolas Dichtel 91373520786SNicolas Dichtel /** 914b46f6dedSNicolas Dichtel * nla_put_be64 - Add a __be64 netlink attribute to a socket buffer and align it 915569a8fc3SDavid S. Miller * @skb: socket buffer to add attribute to 916569a8fc3SDavid S. Miller * @attrtype: attribute type 917569a8fc3SDavid S. Miller * @value: numeric value 918b46f6dedSNicolas Dichtel * @padattr: attribute type for the padding 919569a8fc3SDavid S. Miller */ 920b46f6dedSNicolas Dichtel static inline int nla_put_be64(struct sk_buff *skb, int attrtype, __be64 value, 921b46f6dedSNicolas Dichtel int padattr) 922b46f6dedSNicolas Dichtel { 923b4391db4SArnd Bergmann __be64 tmp = value; 924b4391db4SArnd Bergmann 925b4391db4SArnd Bergmann return nla_put_64bit(skb, attrtype, sizeof(__be64), &tmp, padattr); 926b46f6dedSNicolas Dichtel } 927b46f6dedSNicolas Dichtel 928569a8fc3SDavid S. Miller /** 929e9bbe898SNicolas Dichtel * nla_put_net64 - Add 64-bit network byte order nlattr to a skb and align it 9306c1dd3b6SDavid S. Miller * @skb: socket buffer to add attribute to 9316c1dd3b6SDavid S. Miller * @attrtype: attribute type 9326c1dd3b6SDavid S. Miller * @value: numeric value 933e9bbe898SNicolas Dichtel * @padattr: attribute type for the padding 9346c1dd3b6SDavid S. Miller */ 935e9bbe898SNicolas Dichtel static inline int nla_put_net64(struct sk_buff *skb, int attrtype, __be64 value, 936e9bbe898SNicolas Dichtel int padattr) 9376c1dd3b6SDavid S. Miller { 938b4391db4SArnd Bergmann __be64 tmp = value; 939b4391db4SArnd Bergmann 940b4391db4SArnd Bergmann return nla_put_be64(skb, attrtype | NLA_F_NET_BYTEORDER, tmp, 941e9bbe898SNicolas Dichtel padattr); 9426c1dd3b6SDavid S. Miller } 9436c1dd3b6SDavid S. Miller 9446c1dd3b6SDavid S. Miller /** 945e7479122SNicolas Dichtel * nla_put_le64 - Add a __le64 netlink attribute to a socket buffer and align it 94624c410dcSDavid S. Miller * @skb: socket buffer to add attribute to 94724c410dcSDavid S. Miller * @attrtype: attribute type 94824c410dcSDavid S. Miller * @value: numeric value 949e7479122SNicolas Dichtel * @padattr: attribute type for the padding 95024c410dcSDavid S. Miller */ 951e7479122SNicolas Dichtel static inline int nla_put_le64(struct sk_buff *skb, int attrtype, __le64 value, 952e7479122SNicolas Dichtel int padattr) 95324c410dcSDavid S. Miller { 954b4391db4SArnd Bergmann __le64 tmp = value; 955b4391db4SArnd Bergmann 956b4391db4SArnd Bergmann return nla_put_64bit(skb, attrtype, sizeof(__le64), &tmp, padattr); 95724c410dcSDavid S. Miller } 95824c410dcSDavid S. Miller 95924c410dcSDavid S. Miller /** 9604778e0beSJiri Pirko * nla_put_s8 - Add a s8 netlink attribute to a socket buffer 9614778e0beSJiri Pirko * @skb: socket buffer to add attribute to 9624778e0beSJiri Pirko * @attrtype: attribute type 9634778e0beSJiri Pirko * @value: numeric value 9644778e0beSJiri Pirko */ 9654778e0beSJiri Pirko static inline int nla_put_s8(struct sk_buff *skb, int attrtype, s8 value) 9664778e0beSJiri Pirko { 967b4391db4SArnd Bergmann s8 tmp = value; 968b4391db4SArnd Bergmann 969b4391db4SArnd Bergmann return nla_put(skb, attrtype, sizeof(s8), &tmp); 9704778e0beSJiri Pirko } 9714778e0beSJiri Pirko 9724778e0beSJiri Pirko /** 9734778e0beSJiri Pirko * nla_put_s16 - Add a s16 netlink attribute to a socket buffer 9744778e0beSJiri Pirko * @skb: socket buffer to add attribute to 9754778e0beSJiri Pirko * @attrtype: attribute type 9764778e0beSJiri Pirko * @value: numeric value 9774778e0beSJiri Pirko */ 9784778e0beSJiri Pirko static inline int nla_put_s16(struct sk_buff *skb, int attrtype, s16 value) 9794778e0beSJiri Pirko { 980b4391db4SArnd Bergmann s16 tmp = value; 981b4391db4SArnd Bergmann 982b4391db4SArnd Bergmann return nla_put(skb, attrtype, sizeof(s16), &tmp); 9834778e0beSJiri Pirko } 9844778e0beSJiri Pirko 9854778e0beSJiri Pirko /** 9864778e0beSJiri Pirko * nla_put_s32 - Add a s32 netlink attribute to a socket buffer 9874778e0beSJiri Pirko * @skb: socket buffer to add attribute to 9884778e0beSJiri Pirko * @attrtype: attribute type 9894778e0beSJiri Pirko * @value: numeric value 9904778e0beSJiri Pirko */ 9914778e0beSJiri Pirko static inline int nla_put_s32(struct sk_buff *skb, int attrtype, s32 value) 9924778e0beSJiri Pirko { 993b4391db4SArnd Bergmann s32 tmp = value; 994b4391db4SArnd Bergmann 995b4391db4SArnd Bergmann return nla_put(skb, attrtype, sizeof(s32), &tmp); 9964778e0beSJiri Pirko } 9974778e0beSJiri Pirko 9984778e0beSJiri Pirko /** 999756a2f59SNicolas Dichtel * nla_put_s64 - Add a s64 netlink attribute to a socket buffer and align it 10004778e0beSJiri Pirko * @skb: socket buffer to add attribute to 10014778e0beSJiri Pirko * @attrtype: attribute type 10024778e0beSJiri Pirko * @value: numeric value 1003756a2f59SNicolas Dichtel * @padattr: attribute type for the padding 10044778e0beSJiri Pirko */ 1005756a2f59SNicolas Dichtel static inline int nla_put_s64(struct sk_buff *skb, int attrtype, s64 value, 1006756a2f59SNicolas Dichtel int padattr) 10074778e0beSJiri Pirko { 1008b4391db4SArnd Bergmann s64 tmp = value; 1009b4391db4SArnd Bergmann 1010b4391db4SArnd Bergmann return nla_put_64bit(skb, attrtype, sizeof(s64), &tmp, padattr); 10114778e0beSJiri Pirko } 10124778e0beSJiri Pirko 10134778e0beSJiri Pirko /** 1014bfa83a9eSThomas Graf * nla_put_string - Add a string netlink attribute to a socket buffer 1015bfa83a9eSThomas Graf * @skb: socket buffer to add attribute to 1016bfa83a9eSThomas Graf * @attrtype: attribute type 1017bfa83a9eSThomas Graf * @str: NUL terminated string 1018bfa83a9eSThomas Graf */ 1019bfa83a9eSThomas Graf static inline int nla_put_string(struct sk_buff *skb, int attrtype, 1020bfa83a9eSThomas Graf const char *str) 1021bfa83a9eSThomas Graf { 1022bfa83a9eSThomas Graf return nla_put(skb, attrtype, strlen(str) + 1, str); 1023bfa83a9eSThomas Graf } 1024bfa83a9eSThomas Graf 1025bfa83a9eSThomas Graf /** 1026bfa83a9eSThomas Graf * nla_put_flag - Add a flag netlink attribute to a socket buffer 1027bfa83a9eSThomas Graf * @skb: socket buffer to add attribute to 1028bfa83a9eSThomas Graf * @attrtype: attribute type 1029bfa83a9eSThomas Graf */ 1030bfa83a9eSThomas Graf static inline int nla_put_flag(struct sk_buff *skb, int attrtype) 1031bfa83a9eSThomas Graf { 1032bfa83a9eSThomas Graf return nla_put(skb, attrtype, 0, NULL); 1033bfa83a9eSThomas Graf } 1034bfa83a9eSThomas Graf 1035bfa83a9eSThomas Graf /** 10362175d87cSNicolas Dichtel * nla_put_msecs - Add a msecs netlink attribute to a skb and align it 1037bfa83a9eSThomas Graf * @skb: socket buffer to add attribute to 1038bfa83a9eSThomas Graf * @attrtype: attribute type 1039d87de1f3SMark Rustad * @njiffies: number of jiffies to convert to msecs 10402175d87cSNicolas Dichtel * @padattr: attribute type for the padding 1041bfa83a9eSThomas Graf */ 1042bfa83a9eSThomas Graf static inline int nla_put_msecs(struct sk_buff *skb, int attrtype, 10432175d87cSNicolas Dichtel unsigned long njiffies, int padattr) 1044bfa83a9eSThomas Graf { 1045d87de1f3SMark Rustad u64 tmp = jiffies_to_msecs(njiffies); 10462175d87cSNicolas Dichtel 10472175d87cSNicolas Dichtel return nla_put_64bit(skb, attrtype, sizeof(u64), &tmp, padattr); 1048bfa83a9eSThomas Graf } 1049bfa83a9eSThomas Graf 1050bfa83a9eSThomas Graf /** 1051930345eaSJiri Benc * nla_put_in_addr - Add an IPv4 address netlink attribute to a socket 1052930345eaSJiri Benc * buffer 1053930345eaSJiri Benc * @skb: socket buffer to add attribute to 1054930345eaSJiri Benc * @attrtype: attribute type 1055930345eaSJiri Benc * @addr: IPv4 address 1056930345eaSJiri Benc */ 1057930345eaSJiri Benc static inline int nla_put_in_addr(struct sk_buff *skb, int attrtype, 1058930345eaSJiri Benc __be32 addr) 1059930345eaSJiri Benc { 1060b4391db4SArnd Bergmann __be32 tmp = addr; 1061b4391db4SArnd Bergmann 1062b4391db4SArnd Bergmann return nla_put_be32(skb, attrtype, tmp); 1063930345eaSJiri Benc } 1064930345eaSJiri Benc 1065930345eaSJiri Benc /** 1066930345eaSJiri Benc * nla_put_in6_addr - Add an IPv6 address netlink attribute to a socket 1067930345eaSJiri Benc * buffer 1068930345eaSJiri Benc * @skb: socket buffer to add attribute to 1069930345eaSJiri Benc * @attrtype: attribute type 1070930345eaSJiri Benc * @addr: IPv6 address 1071930345eaSJiri Benc */ 1072930345eaSJiri Benc static inline int nla_put_in6_addr(struct sk_buff *skb, int attrtype, 1073930345eaSJiri Benc const struct in6_addr *addr) 1074930345eaSJiri Benc { 1075930345eaSJiri Benc return nla_put(skb, attrtype, sizeof(*addr), addr); 1076930345eaSJiri Benc } 1077930345eaSJiri Benc 1078930345eaSJiri Benc /** 1079bfa83a9eSThomas Graf * nla_get_u32 - return payload of u32 attribute 1080bfa83a9eSThomas Graf * @nla: u32 netlink attribute 1081bfa83a9eSThomas Graf */ 1082b057efd4SPatrick McHardy static inline u32 nla_get_u32(const struct nlattr *nla) 1083bfa83a9eSThomas Graf { 1084bfa83a9eSThomas Graf return *(u32 *) nla_data(nla); 1085bfa83a9eSThomas Graf } 1086bfa83a9eSThomas Graf 1087bfa83a9eSThomas Graf /** 108800012e5bSAl Viro * nla_get_be32 - return payload of __be32 attribute 108900012e5bSAl Viro * @nla: __be32 netlink attribute 109000012e5bSAl Viro */ 1091b057efd4SPatrick McHardy static inline __be32 nla_get_be32(const struct nlattr *nla) 109200012e5bSAl Viro { 109300012e5bSAl Viro return *(__be32 *) nla_data(nla); 109400012e5bSAl Viro } 109500012e5bSAl Viro 109600012e5bSAl Viro /** 1097c648a013SAlexander Aring * nla_get_le32 - return payload of __le32 attribute 1098c648a013SAlexander Aring * @nla: __le32 netlink attribute 1099c648a013SAlexander Aring */ 1100c648a013SAlexander Aring static inline __le32 nla_get_le32(const struct nlattr *nla) 1101c648a013SAlexander Aring { 1102c648a013SAlexander Aring return *(__le32 *) nla_data(nla); 1103c648a013SAlexander Aring } 1104c648a013SAlexander Aring 1105c648a013SAlexander Aring /** 1106bfa83a9eSThomas Graf * nla_get_u16 - return payload of u16 attribute 1107bfa83a9eSThomas Graf * @nla: u16 netlink attribute 1108bfa83a9eSThomas Graf */ 1109b057efd4SPatrick McHardy static inline u16 nla_get_u16(const struct nlattr *nla) 1110bfa83a9eSThomas Graf { 1111bfa83a9eSThomas Graf return *(u16 *) nla_data(nla); 1112bfa83a9eSThomas Graf } 1113bfa83a9eSThomas Graf 1114bfa83a9eSThomas Graf /** 1115838965baSPatrick McHardy * nla_get_be16 - return payload of __be16 attribute 1116838965baSPatrick McHardy * @nla: __be16 netlink attribute 1117838965baSPatrick McHardy */ 1118b057efd4SPatrick McHardy static inline __be16 nla_get_be16(const struct nlattr *nla) 1119838965baSPatrick McHardy { 1120838965baSPatrick McHardy return *(__be16 *) nla_data(nla); 1121838965baSPatrick McHardy } 1122838965baSPatrick McHardy 1123838965baSPatrick McHardy /** 11244a89c256SThomas Graf * nla_get_le16 - return payload of __le16 attribute 11254a89c256SThomas Graf * @nla: __le16 netlink attribute 11264a89c256SThomas Graf */ 1127b057efd4SPatrick McHardy static inline __le16 nla_get_le16(const struct nlattr *nla) 11284a89c256SThomas Graf { 11294a89c256SThomas Graf return *(__le16 *) nla_data(nla); 11304a89c256SThomas Graf } 11314a89c256SThomas Graf 11324a89c256SThomas Graf /** 1133bfa83a9eSThomas Graf * nla_get_u8 - return payload of u8 attribute 1134bfa83a9eSThomas Graf * @nla: u8 netlink attribute 1135bfa83a9eSThomas Graf */ 1136b057efd4SPatrick McHardy static inline u8 nla_get_u8(const struct nlattr *nla) 1137bfa83a9eSThomas Graf { 1138bfa83a9eSThomas Graf return *(u8 *) nla_data(nla); 1139bfa83a9eSThomas Graf } 1140bfa83a9eSThomas Graf 1141bfa83a9eSThomas Graf /** 1142bfa83a9eSThomas Graf * nla_get_u64 - return payload of u64 attribute 1143bfa83a9eSThomas Graf * @nla: u64 netlink attribute 1144bfa83a9eSThomas Graf */ 1145b057efd4SPatrick McHardy static inline u64 nla_get_u64(const struct nlattr *nla) 1146bfa83a9eSThomas Graf { 1147bfa83a9eSThomas Graf u64 tmp; 1148bfa83a9eSThomas Graf 1149bfa83a9eSThomas Graf nla_memcpy(&tmp, nla, sizeof(tmp)); 1150bfa83a9eSThomas Graf 1151bfa83a9eSThomas Graf return tmp; 1152bfa83a9eSThomas Graf } 1153bfa83a9eSThomas Graf 1154bfa83a9eSThomas Graf /** 1155a17c8598SPablo Neira Ayuso * nla_get_be64 - return payload of __be64 attribute 1156a17c8598SPablo Neira Ayuso * @nla: __be64 netlink attribute 1157a17c8598SPablo Neira Ayuso */ 1158a17c8598SPablo Neira Ayuso static inline __be64 nla_get_be64(const struct nlattr *nla) 1159a17c8598SPablo Neira Ayuso { 1160f5d410f2SPablo Neira Ayuso __be64 tmp; 1161f5d410f2SPablo Neira Ayuso 1162f5d410f2SPablo Neira Ayuso nla_memcpy(&tmp, nla, sizeof(tmp)); 1163f5d410f2SPablo Neira Ayuso 1164f5d410f2SPablo Neira Ayuso return tmp; 1165a17c8598SPablo Neira Ayuso } 1166a17c8598SPablo Neira Ayuso 1167a17c8598SPablo Neira Ayuso /** 1168c648a013SAlexander Aring * nla_get_le64 - return payload of __le64 attribute 1169c648a013SAlexander Aring * @nla: __le64 netlink attribute 1170c648a013SAlexander Aring */ 1171c648a013SAlexander Aring static inline __le64 nla_get_le64(const struct nlattr *nla) 1172c648a013SAlexander Aring { 1173c648a013SAlexander Aring return *(__le64 *) nla_data(nla); 1174c648a013SAlexander Aring } 1175c648a013SAlexander Aring 1176c648a013SAlexander Aring /** 11774778e0beSJiri Pirko * nla_get_s32 - return payload of s32 attribute 11784778e0beSJiri Pirko * @nla: s32 netlink attribute 11794778e0beSJiri Pirko */ 11804778e0beSJiri Pirko static inline s32 nla_get_s32(const struct nlattr *nla) 11814778e0beSJiri Pirko { 11824778e0beSJiri Pirko return *(s32 *) nla_data(nla); 11834778e0beSJiri Pirko } 11844778e0beSJiri Pirko 11854778e0beSJiri Pirko /** 11864778e0beSJiri Pirko * nla_get_s16 - return payload of s16 attribute 11874778e0beSJiri Pirko * @nla: s16 netlink attribute 11884778e0beSJiri Pirko */ 11894778e0beSJiri Pirko static inline s16 nla_get_s16(const struct nlattr *nla) 11904778e0beSJiri Pirko { 11914778e0beSJiri Pirko return *(s16 *) nla_data(nla); 11924778e0beSJiri Pirko } 11934778e0beSJiri Pirko 11944778e0beSJiri Pirko /** 11954778e0beSJiri Pirko * nla_get_s8 - return payload of s8 attribute 11964778e0beSJiri Pirko * @nla: s8 netlink attribute 11974778e0beSJiri Pirko */ 11984778e0beSJiri Pirko static inline s8 nla_get_s8(const struct nlattr *nla) 11994778e0beSJiri Pirko { 12004778e0beSJiri Pirko return *(s8 *) nla_data(nla); 12014778e0beSJiri Pirko } 12024778e0beSJiri Pirko 12034778e0beSJiri Pirko /** 12044778e0beSJiri Pirko * nla_get_s64 - return payload of s64 attribute 12054778e0beSJiri Pirko * @nla: s64 netlink attribute 12064778e0beSJiri Pirko */ 12074778e0beSJiri Pirko static inline s64 nla_get_s64(const struct nlattr *nla) 12084778e0beSJiri Pirko { 12094778e0beSJiri Pirko s64 tmp; 12104778e0beSJiri Pirko 12114778e0beSJiri Pirko nla_memcpy(&tmp, nla, sizeof(tmp)); 12124778e0beSJiri Pirko 12134778e0beSJiri Pirko return tmp; 12144778e0beSJiri Pirko } 12154778e0beSJiri Pirko 12164778e0beSJiri Pirko /** 1217bfa83a9eSThomas Graf * nla_get_flag - return payload of flag attribute 1218bfa83a9eSThomas Graf * @nla: flag netlink attribute 1219bfa83a9eSThomas Graf */ 1220b057efd4SPatrick McHardy static inline int nla_get_flag(const struct nlattr *nla) 1221bfa83a9eSThomas Graf { 1222bfa83a9eSThomas Graf return !!nla; 1223bfa83a9eSThomas Graf } 1224bfa83a9eSThomas Graf 1225bfa83a9eSThomas Graf /** 1226bfa83a9eSThomas Graf * nla_get_msecs - return payload of msecs attribute 1227bfa83a9eSThomas Graf * @nla: msecs netlink attribute 1228bfa83a9eSThomas Graf * 1229bfa83a9eSThomas Graf * Returns the number of milliseconds in jiffies. 1230bfa83a9eSThomas Graf */ 1231b057efd4SPatrick McHardy static inline unsigned long nla_get_msecs(const struct nlattr *nla) 1232bfa83a9eSThomas Graf { 1233bfa83a9eSThomas Graf u64 msecs = nla_get_u64(nla); 1234bfa83a9eSThomas Graf 1235bfa83a9eSThomas Graf return msecs_to_jiffies((unsigned long) msecs); 1236bfa83a9eSThomas Graf } 1237bfa83a9eSThomas Graf 1238bfa83a9eSThomas Graf /** 123967b61f6cSJiri Benc * nla_get_in_addr - return payload of IPv4 address attribute 124067b61f6cSJiri Benc * @nla: IPv4 address netlink attribute 124167b61f6cSJiri Benc */ 124267b61f6cSJiri Benc static inline __be32 nla_get_in_addr(const struct nlattr *nla) 124367b61f6cSJiri Benc { 124467b61f6cSJiri Benc return *(__be32 *) nla_data(nla); 124567b61f6cSJiri Benc } 124667b61f6cSJiri Benc 124767b61f6cSJiri Benc /** 124867b61f6cSJiri Benc * nla_get_in6_addr - return payload of IPv6 address attribute 124967b61f6cSJiri Benc * @nla: IPv6 address netlink attribute 125067b61f6cSJiri Benc */ 125167b61f6cSJiri Benc static inline struct in6_addr nla_get_in6_addr(const struct nlattr *nla) 125267b61f6cSJiri Benc { 125367b61f6cSJiri Benc struct in6_addr tmp; 125467b61f6cSJiri Benc 125567b61f6cSJiri Benc nla_memcpy(&tmp, nla, sizeof(tmp)); 125667b61f6cSJiri Benc return tmp; 125767b61f6cSJiri Benc } 125867b61f6cSJiri Benc 125967b61f6cSJiri Benc /** 126064c83d83SJamal Hadi Salim * nla_get_bitfield32 - return payload of 32 bitfield attribute 126164c83d83SJamal Hadi Salim * @nla: nla_bitfield32 attribute 126264c83d83SJamal Hadi Salim */ 126364c83d83SJamal Hadi Salim static inline struct nla_bitfield32 nla_get_bitfield32(const struct nlattr *nla) 126464c83d83SJamal Hadi Salim { 126564c83d83SJamal Hadi Salim struct nla_bitfield32 tmp; 126664c83d83SJamal Hadi Salim 126764c83d83SJamal Hadi Salim nla_memcpy(&tmp, nla, sizeof(tmp)); 126864c83d83SJamal Hadi Salim return tmp; 126964c83d83SJamal Hadi Salim } 127064c83d83SJamal Hadi Salim 127164c83d83SJamal Hadi Salim /** 1272b15ca182SThomas Graf * nla_memdup - duplicate attribute memory (kmemdup) 1273b15ca182SThomas Graf * @src: netlink attribute to duplicate from 1274b15ca182SThomas Graf * @gfp: GFP mask 1275b15ca182SThomas Graf */ 1276b15ca182SThomas Graf static inline void *nla_memdup(const struct nlattr *src, gfp_t gfp) 1277b15ca182SThomas Graf { 1278b15ca182SThomas Graf return kmemdup(nla_data(src), nla_len(src), gfp); 1279b15ca182SThomas Graf } 1280b15ca182SThomas Graf 1281b15ca182SThomas Graf /** 1282bfa83a9eSThomas Graf * nla_nest_start - Start a new level of nested attributes 1283bfa83a9eSThomas Graf * @skb: socket buffer to add attributes to 1284bfa83a9eSThomas Graf * @attrtype: attribute type of container 1285bfa83a9eSThomas Graf * 1286bfa83a9eSThomas Graf * Returns the container attribute 1287bfa83a9eSThomas Graf */ 1288bfa83a9eSThomas Graf static inline struct nlattr *nla_nest_start(struct sk_buff *skb, int attrtype) 1289bfa83a9eSThomas Graf { 129027a884dcSArnaldo Carvalho de Melo struct nlattr *start = (struct nlattr *)skb_tail_pointer(skb); 1291bfa83a9eSThomas Graf 1292bfa83a9eSThomas Graf if (nla_put(skb, attrtype, 0, NULL) < 0) 1293bfa83a9eSThomas Graf return NULL; 1294bfa83a9eSThomas Graf 1295bfa83a9eSThomas Graf return start; 1296bfa83a9eSThomas Graf } 1297bfa83a9eSThomas Graf 1298bfa83a9eSThomas Graf /** 1299bfa83a9eSThomas Graf * nla_nest_end - Finalize nesting of attributes 1300d1ec3b77SPierre Ynard * @skb: socket buffer the attributes are stored in 1301bfa83a9eSThomas Graf * @start: container attribute 1302bfa83a9eSThomas Graf * 1303bfa83a9eSThomas Graf * Corrects the container attribute header to include the all 1304bfa83a9eSThomas Graf * appeneded attributes. 1305bfa83a9eSThomas Graf * 1306bfa83a9eSThomas Graf * Returns the total data length of the skb. 1307bfa83a9eSThomas Graf */ 1308bfa83a9eSThomas Graf static inline int nla_nest_end(struct sk_buff *skb, struct nlattr *start) 1309bfa83a9eSThomas Graf { 131027a884dcSArnaldo Carvalho de Melo start->nla_len = skb_tail_pointer(skb) - (unsigned char *)start; 1311bfa83a9eSThomas Graf return skb->len; 1312bfa83a9eSThomas Graf } 1313bfa83a9eSThomas Graf 1314bfa83a9eSThomas Graf /** 1315bfa83a9eSThomas Graf * nla_nest_cancel - Cancel nesting of attributes 1316bfa83a9eSThomas Graf * @skb: socket buffer the message is stored in 1317bfa83a9eSThomas Graf * @start: container attribute 1318bfa83a9eSThomas Graf * 1319bfa83a9eSThomas Graf * Removes the container attribute and including all nested 1320bc3ed28cSThomas Graf * attributes. Returns -EMSGSIZE 1321bfa83a9eSThomas Graf */ 1322bc3ed28cSThomas Graf static inline void nla_nest_cancel(struct sk_buff *skb, struct nlattr *start) 1323bfa83a9eSThomas Graf { 1324bc3ed28cSThomas Graf nlmsg_trim(skb, start); 1325bfa83a9eSThomas Graf } 1326bfa83a9eSThomas Graf 1327bfa83a9eSThomas Graf /** 13284fe5d5c0SPaul Moore * nla_validate_nested - Validate a stream of nested attributes 13294fe5d5c0SPaul Moore * @start: container attribute 13304fe5d5c0SPaul Moore * @maxtype: maximum attribute type to be expected 13314fe5d5c0SPaul Moore * @policy: validation policy 1332fceb6435SJohannes Berg * @extack: extended ACK report struct 13334fe5d5c0SPaul Moore * 13344fe5d5c0SPaul Moore * Validates all attributes in the nested attribute stream against the 13354fe5d5c0SPaul Moore * specified policy. Attributes with a type exceeding maxtype will be 13364fe5d5c0SPaul Moore * ignored. See documenation of struct nla_policy for more details. 13374fe5d5c0SPaul Moore * 13384fe5d5c0SPaul Moore * Returns 0 on success or a negative error code. 13394fe5d5c0SPaul Moore */ 13403654654fSJan Engelhardt static inline int nla_validate_nested(const struct nlattr *start, int maxtype, 1341fceb6435SJohannes Berg const struct nla_policy *policy, 1342fceb6435SJohannes Berg struct netlink_ext_ack *extack) 13434fe5d5c0SPaul Moore { 1344fceb6435SJohannes Berg return nla_validate(nla_data(start), nla_len(start), maxtype, policy, 1345fceb6435SJohannes Berg extack); 13464fe5d5c0SPaul Moore } 13474fe5d5c0SPaul Moore 13484fe5d5c0SPaul Moore /** 1349089bf1a6SNicolas Dichtel * nla_need_padding_for_64bit - test 64-bit alignment of the next attribute 1350089bf1a6SNicolas Dichtel * @skb: socket buffer the message is stored in 1351089bf1a6SNicolas Dichtel * 1352089bf1a6SNicolas Dichtel * Return true if padding is needed to align the next attribute (nla_data()) to 1353089bf1a6SNicolas Dichtel * a 64-bit aligned area. 1354089bf1a6SNicolas Dichtel */ 1355089bf1a6SNicolas Dichtel static inline bool nla_need_padding_for_64bit(struct sk_buff *skb) 1356089bf1a6SNicolas Dichtel { 1357089bf1a6SNicolas Dichtel #ifndef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS 1358089bf1a6SNicolas Dichtel /* The nlattr header is 4 bytes in size, that's why we test 1359089bf1a6SNicolas Dichtel * if the skb->data _is_ aligned. A NOP attribute, plus 1360089bf1a6SNicolas Dichtel * nlattr header for next attribute, will make nla_data() 1361089bf1a6SNicolas Dichtel * 8-byte aligned. 1362089bf1a6SNicolas Dichtel */ 1363089bf1a6SNicolas Dichtel if (IS_ALIGNED((unsigned long)skb_tail_pointer(skb), 8)) 1364089bf1a6SNicolas Dichtel return true; 1365089bf1a6SNicolas Dichtel #endif 1366089bf1a6SNicolas Dichtel return false; 1367089bf1a6SNicolas Dichtel } 1368089bf1a6SNicolas Dichtel 1369089bf1a6SNicolas Dichtel /** 137035c58459SDavid S. Miller * nla_align_64bit - 64-bit align the nla_data() of next attribute 137135c58459SDavid S. Miller * @skb: socket buffer the message is stored in 137235c58459SDavid S. Miller * @padattr: attribute type for the padding 137335c58459SDavid S. Miller * 137435c58459SDavid S. Miller * Conditionally emit a padding netlink attribute in order to make 137535c58459SDavid S. Miller * the next attribute we emit have a 64-bit aligned nla_data() area. 137635c58459SDavid S. Miller * This will only be done in architectures which do not have 1377cca1d815SEric Dumazet * CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS defined. 137835c58459SDavid S. Miller * 137935c58459SDavid S. Miller * Returns zero on success or a negative error code. 138035c58459SDavid S. Miller */ 138135c58459SDavid S. Miller static inline int nla_align_64bit(struct sk_buff *skb, int padattr) 138235c58459SDavid S. Miller { 1383089bf1a6SNicolas Dichtel if (nla_need_padding_for_64bit(skb) && 1384cca1d815SEric Dumazet !nla_reserve(skb, padattr, 0)) 138535c58459SDavid S. Miller return -EMSGSIZE; 1386089bf1a6SNicolas Dichtel 138735c58459SDavid S. Miller return 0; 138835c58459SDavid S. Miller } 138935c58459SDavid S. Miller 139035c58459SDavid S. Miller /** 139135c58459SDavid S. Miller * nla_total_size_64bit - total length of attribute including padding 139235c58459SDavid S. Miller * @payload: length of payload 139335c58459SDavid S. Miller */ 139435c58459SDavid S. Miller static inline int nla_total_size_64bit(int payload) 139535c58459SDavid S. Miller { 139635c58459SDavid S. Miller return NLA_ALIGN(nla_attr_size(payload)) 1397cca1d815SEric Dumazet #ifndef CONFIG_HAVE_EFFICIENT_UNALIGNED_ACCESS 139835c58459SDavid S. Miller + NLA_ALIGN(nla_attr_size(0)) 139935c58459SDavid S. Miller #endif 140035c58459SDavid S. Miller ; 140135c58459SDavid S. Miller } 140235c58459SDavid S. Miller 140335c58459SDavid S. Miller /** 1404bfa83a9eSThomas Graf * nla_for_each_attr - iterate over a stream of attributes 1405bfa83a9eSThomas Graf * @pos: loop counter, set to current attribute 1406bfa83a9eSThomas Graf * @head: head of attribute stream 1407bfa83a9eSThomas Graf * @len: length of attribute stream 1408bfa83a9eSThomas Graf * @rem: initialized to len, holds bytes currently remaining in stream 1409bfa83a9eSThomas Graf */ 1410bfa83a9eSThomas Graf #define nla_for_each_attr(pos, head, len, rem) \ 1411bfa83a9eSThomas Graf for (pos = head, rem = len; \ 1412bfa83a9eSThomas Graf nla_ok(pos, rem); \ 1413bfa83a9eSThomas Graf pos = nla_next(pos, &(rem))) 1414bfa83a9eSThomas Graf 1415fe4944e5SThomas Graf /** 1416fe4944e5SThomas Graf * nla_for_each_nested - iterate over nested attributes 1417fe4944e5SThomas Graf * @pos: loop counter, set to current attribute 1418fe4944e5SThomas Graf * @nla: attribute containing the nested attributes 1419fe4944e5SThomas Graf * @rem: initialized to len, holds bytes currently remaining in stream 1420fe4944e5SThomas Graf */ 1421fe4944e5SThomas Graf #define nla_for_each_nested(pos, nla, rem) \ 1422fe4944e5SThomas Graf nla_for_each_attr(pos, nla_data(nla), nla_len(nla), rem) 1423fe4944e5SThomas Graf 1424941d8ebcSSimon Horman /** 1425941d8ebcSSimon Horman * nla_is_last - Test if attribute is last in stream 1426941d8ebcSSimon Horman * @nla: attribute to test 1427941d8ebcSSimon Horman * @rem: bytes remaining in stream 1428941d8ebcSSimon Horman */ 1429941d8ebcSSimon Horman static inline bool nla_is_last(const struct nlattr *nla, int rem) 1430941d8ebcSSimon Horman { 1431941d8ebcSSimon Horman return nla->nla_len == rem; 1432941d8ebcSSimon Horman } 1433941d8ebcSSimon Horman 1434bfa83a9eSThomas Graf #endif 1435