1bfa83a9eSThomas Graf #ifndef __NET_NETLINK_H 2bfa83a9eSThomas Graf #define __NET_NETLINK_H 3bfa83a9eSThomas Graf 4bfa83a9eSThomas Graf #include <linux/types.h> 5bfa83a9eSThomas Graf #include <linux/netlink.h> 6d7fe0f24SAl Viro #include <linux/jiffies.h> 7bfa83a9eSThomas Graf 8bfa83a9eSThomas Graf /* ======================================================================== 9bfa83a9eSThomas Graf * Netlink Messages and Attributes Interface (As Seen On TV) 10bfa83a9eSThomas Graf * ------------------------------------------------------------------------ 11bfa83a9eSThomas Graf * Messages Interface 12bfa83a9eSThomas Graf * ------------------------------------------------------------------------ 13bfa83a9eSThomas Graf * 14bfa83a9eSThomas Graf * Message Format: 15bfa83a9eSThomas Graf * <--- nlmsg_total_size(payload) ---> 16bfa83a9eSThomas Graf * <-- nlmsg_msg_size(payload) -> 17bfa83a9eSThomas Graf * +----------+- - -+-------------+- - -+-------- - - 18bfa83a9eSThomas Graf * | nlmsghdr | Pad | Payload | Pad | nlmsghdr 19bfa83a9eSThomas Graf * +----------+- - -+-------------+- - -+-------- - - 20bfa83a9eSThomas Graf * nlmsg_data(nlh)---^ ^ 21bfa83a9eSThomas Graf * nlmsg_next(nlh)-----------------------+ 22bfa83a9eSThomas Graf * 23bfa83a9eSThomas Graf * Payload Format: 24bfa83a9eSThomas Graf * <---------------------- nlmsg_len(nlh) ---------------------> 25bfa83a9eSThomas Graf * <------ hdrlen ------> <- nlmsg_attrlen(nlh, hdrlen) -> 26bfa83a9eSThomas Graf * +----------------------+- - -+--------------------------------+ 27bfa83a9eSThomas Graf * | Family Header | Pad | Attributes | 28bfa83a9eSThomas Graf * +----------------------+- - -+--------------------------------+ 29bfa83a9eSThomas Graf * nlmsg_attrdata(nlh, hdrlen)---^ 30bfa83a9eSThomas Graf * 31bfa83a9eSThomas Graf * Data Structures: 32bfa83a9eSThomas Graf * struct nlmsghdr netlink message header 33bfa83a9eSThomas Graf * 34bfa83a9eSThomas Graf * Message Construction: 35bfa83a9eSThomas Graf * nlmsg_new() create a new netlink message 36bfa83a9eSThomas Graf * nlmsg_put() add a netlink message to an skb 37bfa83a9eSThomas Graf * nlmsg_put_answer() callback based nlmsg_put() 38bfa83a9eSThomas Graf * nlmsg_end() finanlize netlink message 39fe4944e5SThomas Graf * nlmsg_get_pos() return current position in message 40fe4944e5SThomas Graf * nlmsg_trim() trim part of message 41bfa83a9eSThomas Graf * nlmsg_cancel() cancel message construction 42bfa83a9eSThomas Graf * nlmsg_free() free a netlink message 43bfa83a9eSThomas Graf * 44bfa83a9eSThomas Graf * Message Sending: 45bfa83a9eSThomas Graf * nlmsg_multicast() multicast message to several groups 46bfa83a9eSThomas Graf * nlmsg_unicast() unicast a message to a single socket 47d387f6adSThomas Graf * nlmsg_notify() send notification message 48bfa83a9eSThomas Graf * 49bfa83a9eSThomas Graf * Message Length Calculations: 50bfa83a9eSThomas Graf * nlmsg_msg_size(payload) length of message w/o padding 51bfa83a9eSThomas Graf * nlmsg_total_size(payload) length of message w/ padding 52bfa83a9eSThomas Graf * nlmsg_padlen(payload) length of padding at tail 53bfa83a9eSThomas Graf * 54bfa83a9eSThomas Graf * Message Payload Access: 55bfa83a9eSThomas Graf * nlmsg_data(nlh) head of message payload 56bfa83a9eSThomas Graf * nlmsg_len(nlh) length of message payload 57bfa83a9eSThomas Graf * nlmsg_attrdata(nlh, hdrlen) head of attributes data 58bfa83a9eSThomas Graf * nlmsg_attrlen(nlh, hdrlen) length of attributes data 59bfa83a9eSThomas Graf * 60bfa83a9eSThomas Graf * Message Parsing: 61bfa83a9eSThomas Graf * nlmsg_ok(nlh, remaining) does nlh fit into remaining bytes? 62bfa83a9eSThomas Graf * nlmsg_next(nlh, remaining) get next netlink message 63bfa83a9eSThomas Graf * nlmsg_parse() parse attributes of a message 64bfa83a9eSThomas Graf * nlmsg_find_attr() find an attribute in a message 65bfa83a9eSThomas Graf * nlmsg_for_each_msg() loop over all messages 66bfa83a9eSThomas Graf * nlmsg_validate() validate netlink message incl. attrs 67bfa83a9eSThomas Graf * nlmsg_for_each_attr() loop over all attributes 68bfa83a9eSThomas Graf * 6997676b6bSThomas Graf * Misc: 7097676b6bSThomas Graf * nlmsg_report() report back to application? 7197676b6bSThomas Graf * 72bfa83a9eSThomas Graf * ------------------------------------------------------------------------ 73bfa83a9eSThomas Graf * Attributes Interface 74bfa83a9eSThomas Graf * ------------------------------------------------------------------------ 75bfa83a9eSThomas Graf * 76bfa83a9eSThomas Graf * Attribute Format: 77bfa83a9eSThomas Graf * <------- nla_total_size(payload) -------> 78bfa83a9eSThomas Graf * <---- nla_attr_size(payload) -----> 79bfa83a9eSThomas Graf * +----------+- - -+- - - - - - - - - +- - -+-------- - - 80bfa83a9eSThomas Graf * | Header | Pad | Payload | Pad | Header 81bfa83a9eSThomas Graf * +----------+- - -+- - - - - - - - - +- - -+-------- - - 82bfa83a9eSThomas Graf * <- nla_len(nla) -> ^ 83bfa83a9eSThomas Graf * nla_data(nla)----^ | 84bfa83a9eSThomas Graf * nla_next(nla)-----------------------------' 85bfa83a9eSThomas Graf * 86bfa83a9eSThomas Graf * Data Structures: 87bfa83a9eSThomas Graf * struct nlattr netlink attribtue header 88bfa83a9eSThomas Graf * 89bfa83a9eSThomas Graf * Attribute Construction: 90fe4944e5SThomas Graf * nla_reserve(skb, type, len) reserve room for an attribute 91fe4944e5SThomas Graf * nla_reserve_nohdr(skb, len) reserve room for an attribute w/o hdr 92bfa83a9eSThomas Graf * nla_put(skb, type, len, data) add attribute to skb 93fe4944e5SThomas Graf * nla_put_nohdr(skb, len, data) add attribute w/o hdr 94bfa83a9eSThomas Graf * 95bfa83a9eSThomas Graf * Attribute Construction for Basic Types: 96bfa83a9eSThomas Graf * nla_put_u8(skb, type, value) add u8 attribute to skb 97bfa83a9eSThomas Graf * nla_put_u16(skb, type, value) add u16 attribute to skb 98bfa83a9eSThomas Graf * nla_put_u32(skb, type, value) add u32 attribute to skb 99bfa83a9eSThomas Graf * nla_put_u64(skb, type, value) add u64 attribute to skb 100bfa83a9eSThomas Graf * nla_put_string(skb, type, str) add string attribute to skb 101bfa83a9eSThomas Graf * nla_put_flag(skb, type) add flag attribute to skb 102bfa83a9eSThomas Graf * nla_put_msecs(skb, type, jiffies) add msecs attribute to skb 103bfa83a9eSThomas Graf * 104bfa83a9eSThomas Graf * Exceptions Based Attribute Construction: 105bfa83a9eSThomas Graf * NLA_PUT(skb, type, len, data) add attribute to skb 106bfa83a9eSThomas Graf * NLA_PUT_U8(skb, type, value) add u8 attribute to skb 107bfa83a9eSThomas Graf * NLA_PUT_U16(skb, type, value) add u16 attribute to skb 108bfa83a9eSThomas Graf * NLA_PUT_U32(skb, type, value) add u32 attribute to skb 109bfa83a9eSThomas Graf * NLA_PUT_U64(skb, type, value) add u64 attribute to skb 110bfa83a9eSThomas Graf * NLA_PUT_STRING(skb, type, str) add string attribute to skb 111bfa83a9eSThomas Graf * NLA_PUT_FLAG(skb, type) add flag attribute to skb 112bfa83a9eSThomas Graf * NLA_PUT_MSECS(skb, type, jiffies) add msecs attribute to skb 113bfa83a9eSThomas Graf * 114bfa83a9eSThomas Graf * The meaning of these functions is equal to their lower case 115bfa83a9eSThomas Graf * variants but they jump to the label nla_put_failure in case 116bfa83a9eSThomas Graf * of a failure. 117bfa83a9eSThomas Graf * 118bfa83a9eSThomas Graf * Nested Attributes Construction: 119bfa83a9eSThomas Graf * nla_nest_start(skb, type) start a nested attribute 120bfa83a9eSThomas Graf * nla_nest_end(skb, nla) finalize a nested attribute 121bfa83a9eSThomas Graf * nla_nest_cancel(skb, nla) cancel nested attribute construction 122bfa83a9eSThomas Graf * 123bfa83a9eSThomas Graf * Attribute Length Calculations: 124bfa83a9eSThomas Graf * nla_attr_size(payload) length of attribute w/o padding 125bfa83a9eSThomas Graf * nla_total_size(payload) length of attribute w/ padding 126bfa83a9eSThomas Graf * nla_padlen(payload) length of padding 127bfa83a9eSThomas Graf * 128bfa83a9eSThomas Graf * Attribute Payload Access: 129bfa83a9eSThomas Graf * nla_data(nla) head of attribute payload 130bfa83a9eSThomas Graf * nla_len(nla) length of attribute payload 131bfa83a9eSThomas Graf * 132bfa83a9eSThomas Graf * Attribute Payload Access for Basic Types: 133bfa83a9eSThomas Graf * nla_get_u8(nla) get payload for a u8 attribute 134bfa83a9eSThomas Graf * nla_get_u16(nla) get payload for a u16 attribute 135bfa83a9eSThomas Graf * nla_get_u32(nla) get payload for a u32 attribute 136bfa83a9eSThomas Graf * nla_get_u64(nla) get payload for a u64 attribute 137bfa83a9eSThomas Graf * nla_get_flag(nla) return 1 if flag is true 138bfa83a9eSThomas Graf * nla_get_msecs(nla) get payload for a msecs attribute 139bfa83a9eSThomas Graf * 140bfa83a9eSThomas Graf * Attribute Misc: 141bfa83a9eSThomas Graf * nla_memcpy(dest, nla, count) copy attribute into memory 142bfa83a9eSThomas Graf * nla_memcmp(nla, data, size) compare attribute with memory area 143bfa83a9eSThomas Graf * nla_strlcpy(dst, nla, size) copy attribute to a sized string 144bfa83a9eSThomas Graf * nla_strcmp(nla, str) compare attribute with string 145bfa83a9eSThomas Graf * 146bfa83a9eSThomas Graf * Attribute Parsing: 147bfa83a9eSThomas Graf * nla_ok(nla, remaining) does nla fit into remaining bytes? 148bfa83a9eSThomas Graf * nla_next(nla, remaining) get next netlink attribute 149bfa83a9eSThomas Graf * nla_validate() validate a stream of attributes 1504fe5d5c0SPaul Moore * nla_validate_nested() validate a stream of nested attributes 151bfa83a9eSThomas Graf * nla_find() find attribute in stream of attributes 152fe4944e5SThomas Graf * nla_find_nested() find attribute in nested attributes 153bfa83a9eSThomas Graf * nla_parse() parse and validate stream of attrs 154bfa83a9eSThomas Graf * nla_parse_nested() parse nested attribuets 155bfa83a9eSThomas Graf * nla_for_each_attr() loop over all attributes 15622acb19aSPaul Moore * nla_for_each_nested() loop over the nested attributes 157bfa83a9eSThomas Graf *========================================================================= 158bfa83a9eSThomas Graf */ 159bfa83a9eSThomas Graf 160bfa83a9eSThomas Graf /** 161bfa83a9eSThomas Graf * Standard attribute types to specify validation policy 162bfa83a9eSThomas Graf */ 163bfa83a9eSThomas Graf enum { 164bfa83a9eSThomas Graf NLA_UNSPEC, 165bfa83a9eSThomas Graf NLA_U8, 166bfa83a9eSThomas Graf NLA_U16, 167bfa83a9eSThomas Graf NLA_U32, 168bfa83a9eSThomas Graf NLA_U64, 169bfa83a9eSThomas Graf NLA_STRING, 170bfa83a9eSThomas Graf NLA_FLAG, 171bfa83a9eSThomas Graf NLA_MSECS, 172bfa83a9eSThomas Graf NLA_NESTED, 173a5531a5dSThomas Graf NLA_NUL_STRING, 174bfa83a9eSThomas Graf __NLA_TYPE_MAX, 175bfa83a9eSThomas Graf }; 176bfa83a9eSThomas Graf 177bfa83a9eSThomas Graf #define NLA_TYPE_MAX (__NLA_TYPE_MAX - 1) 178bfa83a9eSThomas Graf 179bfa83a9eSThomas Graf /** 180bfa83a9eSThomas Graf * struct nla_policy - attribute validation policy 181bfa83a9eSThomas Graf * @type: Type of attribute or NLA_UNSPEC 182a5531a5dSThomas Graf * @len: Type specific length of payload 183bfa83a9eSThomas Graf * 184bfa83a9eSThomas Graf * Policies are defined as arrays of this struct, the array must be 185bfa83a9eSThomas Graf * accessible by attribute type up to the highest identifier to be expected. 186bfa83a9eSThomas Graf * 187a5531a5dSThomas Graf * Meaning of `len' field: 188a5531a5dSThomas Graf * NLA_STRING Maximum length of string 189a5531a5dSThomas Graf * NLA_NUL_STRING Maximum length of string (excluding NUL) 190a5531a5dSThomas Graf * NLA_FLAG Unused 191a5531a5dSThomas Graf * All other Exact length of attribute payload 192a5531a5dSThomas Graf * 193bfa83a9eSThomas Graf * Example: 194bfa83a9eSThomas Graf * static struct nla_policy my_policy[ATTR_MAX+1] __read_mostly = { 195bfa83a9eSThomas Graf * [ATTR_FOO] = { .type = NLA_U16 }, 196a5531a5dSThomas Graf * [ATTR_BAR] = { .type = NLA_STRING, len = BARSIZ }, 197a5531a5dSThomas Graf * [ATTR_BAZ] = { .len = sizeof(struct mystruct) }, 198bfa83a9eSThomas Graf * }; 199bfa83a9eSThomas Graf */ 200bfa83a9eSThomas Graf struct nla_policy { 201bfa83a9eSThomas Graf u16 type; 202a5531a5dSThomas Graf u16 len; 203bfa83a9eSThomas Graf }; 204bfa83a9eSThomas Graf 2054e902c57SThomas Graf /** 2064e902c57SThomas Graf * struct nl_info - netlink source information 2074e902c57SThomas Graf * @nlh: Netlink message header of original request 2084e902c57SThomas Graf * @pid: Netlink PID of requesting application 2094e902c57SThomas Graf */ 2104e902c57SThomas Graf struct nl_info { 2114e902c57SThomas Graf struct nlmsghdr *nlh; 2124e902c57SThomas Graf u32 pid; 2134e902c57SThomas Graf }; 2144e902c57SThomas Graf 21582ace47aSThomas Graf extern void netlink_run_queue(struct sock *sk, unsigned int *qlen, 21682ace47aSThomas Graf int (*cb)(struct sk_buff *, 21782ace47aSThomas Graf struct nlmsghdr *, int *)); 21882ace47aSThomas Graf extern void netlink_queue_skip(struct nlmsghdr *nlh, 21982ace47aSThomas Graf struct sk_buff *skb); 22097676b6bSThomas Graf extern int nlmsg_notify(struct sock *sk, struct sk_buff *skb, 22197676b6bSThomas Graf u32 pid, unsigned int group, int report, 22297676b6bSThomas Graf gfp_t flags); 22382ace47aSThomas Graf 224bfa83a9eSThomas Graf extern int nla_validate(struct nlattr *head, int len, int maxtype, 225bfa83a9eSThomas Graf struct nla_policy *policy); 226bfa83a9eSThomas Graf extern int nla_parse(struct nlattr *tb[], int maxtype, 227bfa83a9eSThomas Graf struct nlattr *head, int len, 228bfa83a9eSThomas Graf struct nla_policy *policy); 229bfa83a9eSThomas Graf extern struct nlattr * nla_find(struct nlattr *head, int len, int attrtype); 230bfa83a9eSThomas Graf extern size_t nla_strlcpy(char *dst, const struct nlattr *nla, 231bfa83a9eSThomas Graf size_t dstsize); 232bfa83a9eSThomas Graf extern int nla_memcpy(void *dest, struct nlattr *src, int count); 233bfa83a9eSThomas Graf extern int nla_memcmp(const struct nlattr *nla, const void *data, 234bfa83a9eSThomas Graf size_t size); 235bfa83a9eSThomas Graf extern int nla_strcmp(const struct nlattr *nla, const char *str); 236bfa83a9eSThomas Graf extern struct nlattr * __nla_reserve(struct sk_buff *skb, int attrtype, 237bfa83a9eSThomas Graf int attrlen); 238fe4944e5SThomas Graf extern void * __nla_reserve_nohdr(struct sk_buff *skb, int attrlen); 239bfa83a9eSThomas Graf extern struct nlattr * nla_reserve(struct sk_buff *skb, int attrtype, 240bfa83a9eSThomas Graf int attrlen); 241fe4944e5SThomas Graf extern void * nla_reserve_nohdr(struct sk_buff *skb, int attrlen); 242bfa83a9eSThomas Graf extern void __nla_put(struct sk_buff *skb, int attrtype, 243bfa83a9eSThomas Graf int attrlen, const void *data); 244fe4944e5SThomas Graf extern void __nla_put_nohdr(struct sk_buff *skb, int attrlen, 245fe4944e5SThomas Graf const void *data); 246bfa83a9eSThomas Graf extern int nla_put(struct sk_buff *skb, int attrtype, 247bfa83a9eSThomas Graf int attrlen, const void *data); 248fe4944e5SThomas Graf extern int nla_put_nohdr(struct sk_buff *skb, int attrlen, 249fe4944e5SThomas Graf const void *data); 250bfa83a9eSThomas Graf 251bfa83a9eSThomas Graf /************************************************************************** 252bfa83a9eSThomas Graf * Netlink Messages 253bfa83a9eSThomas Graf **************************************************************************/ 254bfa83a9eSThomas Graf 255bfa83a9eSThomas Graf /** 256bfa83a9eSThomas Graf * nlmsg_msg_size - length of netlink message not including padding 257bfa83a9eSThomas Graf * @payload: length of message payload 258bfa83a9eSThomas Graf */ 259bfa83a9eSThomas Graf static inline int nlmsg_msg_size(int payload) 260bfa83a9eSThomas Graf { 261bfa83a9eSThomas Graf return NLMSG_HDRLEN + payload; 262bfa83a9eSThomas Graf } 263bfa83a9eSThomas Graf 264bfa83a9eSThomas Graf /** 265bfa83a9eSThomas Graf * nlmsg_total_size - length of netlink message including padding 266bfa83a9eSThomas Graf * @payload: length of message payload 267bfa83a9eSThomas Graf */ 268bfa83a9eSThomas Graf static inline int nlmsg_total_size(int payload) 269bfa83a9eSThomas Graf { 270bfa83a9eSThomas Graf return NLMSG_ALIGN(nlmsg_msg_size(payload)); 271bfa83a9eSThomas Graf } 272bfa83a9eSThomas Graf 273bfa83a9eSThomas Graf /** 274bfa83a9eSThomas Graf * nlmsg_padlen - length of padding at the message's tail 275bfa83a9eSThomas Graf * @payload: length of message payload 276bfa83a9eSThomas Graf */ 277bfa83a9eSThomas Graf static inline int nlmsg_padlen(int payload) 278bfa83a9eSThomas Graf { 279bfa83a9eSThomas Graf return nlmsg_total_size(payload) - nlmsg_msg_size(payload); 280bfa83a9eSThomas Graf } 281bfa83a9eSThomas Graf 282bfa83a9eSThomas Graf /** 283bfa83a9eSThomas Graf * nlmsg_data - head of message payload 284bfa83a9eSThomas Graf * @nlh: netlink messsage header 285bfa83a9eSThomas Graf */ 286bfa83a9eSThomas Graf static inline void *nlmsg_data(const struct nlmsghdr *nlh) 287bfa83a9eSThomas Graf { 288bfa83a9eSThomas Graf return (unsigned char *) nlh + NLMSG_HDRLEN; 289bfa83a9eSThomas Graf } 290bfa83a9eSThomas Graf 291bfa83a9eSThomas Graf /** 292bfa83a9eSThomas Graf * nlmsg_len - length of message payload 293bfa83a9eSThomas Graf * @nlh: netlink message header 294bfa83a9eSThomas Graf */ 295bfa83a9eSThomas Graf static inline int nlmsg_len(const struct nlmsghdr *nlh) 296bfa83a9eSThomas Graf { 297bfa83a9eSThomas Graf return nlh->nlmsg_len - NLMSG_HDRLEN; 298bfa83a9eSThomas Graf } 299bfa83a9eSThomas Graf 300bfa83a9eSThomas Graf /** 301bfa83a9eSThomas Graf * nlmsg_attrdata - head of attributes data 302bfa83a9eSThomas Graf * @nlh: netlink message header 303bfa83a9eSThomas Graf * @hdrlen: length of family specific header 304bfa83a9eSThomas Graf */ 305bfa83a9eSThomas Graf static inline struct nlattr *nlmsg_attrdata(const struct nlmsghdr *nlh, 306bfa83a9eSThomas Graf int hdrlen) 307bfa83a9eSThomas Graf { 308bfa83a9eSThomas Graf unsigned char *data = nlmsg_data(nlh); 309bfa83a9eSThomas Graf return (struct nlattr *) (data + NLMSG_ALIGN(hdrlen)); 310bfa83a9eSThomas Graf } 311bfa83a9eSThomas Graf 312bfa83a9eSThomas Graf /** 313bfa83a9eSThomas Graf * nlmsg_attrlen - length of attributes data 314bfa83a9eSThomas Graf * @nlh: netlink message header 315bfa83a9eSThomas Graf * @hdrlen: length of family specific header 316bfa83a9eSThomas Graf */ 317bfa83a9eSThomas Graf static inline int nlmsg_attrlen(const struct nlmsghdr *nlh, int hdrlen) 318bfa83a9eSThomas Graf { 319bfa83a9eSThomas Graf return nlmsg_len(nlh) - NLMSG_ALIGN(hdrlen); 320bfa83a9eSThomas Graf } 321bfa83a9eSThomas Graf 322bfa83a9eSThomas Graf /** 323bfa83a9eSThomas Graf * nlmsg_ok - check if the netlink message fits into the remaining bytes 324bfa83a9eSThomas Graf * @nlh: netlink message header 325bfa83a9eSThomas Graf * @remaining: number of bytes remaining in message stream 326bfa83a9eSThomas Graf */ 327bfa83a9eSThomas Graf static inline int nlmsg_ok(const struct nlmsghdr *nlh, int remaining) 328bfa83a9eSThomas Graf { 329bfa83a9eSThomas Graf return (remaining >= sizeof(struct nlmsghdr) && 330bfa83a9eSThomas Graf nlh->nlmsg_len >= sizeof(struct nlmsghdr) && 331bfa83a9eSThomas Graf nlh->nlmsg_len <= remaining); 332bfa83a9eSThomas Graf } 333bfa83a9eSThomas Graf 334bfa83a9eSThomas Graf /** 335bfa83a9eSThomas Graf * nlmsg_next - next netlink message in message stream 336bfa83a9eSThomas Graf * @nlh: netlink message header 337bfa83a9eSThomas Graf * @remaining: number of bytes remaining in message stream 338bfa83a9eSThomas Graf * 339bfa83a9eSThomas Graf * Returns the next netlink message in the message stream and 340bfa83a9eSThomas Graf * decrements remaining by the size of the current message. 341bfa83a9eSThomas Graf */ 342bfa83a9eSThomas Graf static inline struct nlmsghdr *nlmsg_next(struct nlmsghdr *nlh, int *remaining) 343bfa83a9eSThomas Graf { 344bfa83a9eSThomas Graf int totlen = NLMSG_ALIGN(nlh->nlmsg_len); 345bfa83a9eSThomas Graf 346bfa83a9eSThomas Graf *remaining -= totlen; 347bfa83a9eSThomas Graf 348bfa83a9eSThomas Graf return (struct nlmsghdr *) ((unsigned char *) nlh + totlen); 349bfa83a9eSThomas Graf } 350bfa83a9eSThomas Graf 351bfa83a9eSThomas Graf /** 352bfa83a9eSThomas Graf * nlmsg_parse - parse attributes of a netlink message 353bfa83a9eSThomas Graf * @nlh: netlink message header 354bfa83a9eSThomas Graf * @hdrlen: length of family specific header 355bfa83a9eSThomas Graf * @tb: destination array with maxtype+1 elements 356bfa83a9eSThomas Graf * @maxtype: maximum attribute type to be expected 357bfa83a9eSThomas Graf * @policy: validation policy 358bfa83a9eSThomas Graf * 359bfa83a9eSThomas Graf * See nla_parse() 360bfa83a9eSThomas Graf */ 361bfa83a9eSThomas Graf static inline int nlmsg_parse(struct nlmsghdr *nlh, int hdrlen, 362bfa83a9eSThomas Graf struct nlattr *tb[], int maxtype, 363bfa83a9eSThomas Graf struct nla_policy *policy) 364bfa83a9eSThomas Graf { 365bfa83a9eSThomas Graf if (nlh->nlmsg_len < nlmsg_msg_size(hdrlen)) 366bfa83a9eSThomas Graf return -EINVAL; 367bfa83a9eSThomas Graf 368bfa83a9eSThomas Graf return nla_parse(tb, maxtype, nlmsg_attrdata(nlh, hdrlen), 369bfa83a9eSThomas Graf nlmsg_attrlen(nlh, hdrlen), policy); 370bfa83a9eSThomas Graf } 371bfa83a9eSThomas Graf 372bfa83a9eSThomas Graf /** 373bfa83a9eSThomas Graf * nlmsg_find_attr - find a specific attribute in a netlink message 374bfa83a9eSThomas Graf * @nlh: netlink message header 375bfa83a9eSThomas Graf * @hdrlen: length of familiy specific header 376bfa83a9eSThomas Graf * @attrtype: type of attribute to look for 377bfa83a9eSThomas Graf * 378bfa83a9eSThomas Graf * Returns the first attribute which matches the specified type. 379bfa83a9eSThomas Graf */ 380bfa83a9eSThomas Graf static inline struct nlattr *nlmsg_find_attr(struct nlmsghdr *nlh, 381bfa83a9eSThomas Graf int hdrlen, int attrtype) 382bfa83a9eSThomas Graf { 383bfa83a9eSThomas Graf return nla_find(nlmsg_attrdata(nlh, hdrlen), 384bfa83a9eSThomas Graf nlmsg_attrlen(nlh, hdrlen), attrtype); 385bfa83a9eSThomas Graf } 386bfa83a9eSThomas Graf 387bfa83a9eSThomas Graf /** 388bfa83a9eSThomas Graf * nlmsg_validate - validate a netlink message including attributes 389bfa83a9eSThomas Graf * @nlh: netlinket message header 390bfa83a9eSThomas Graf * @hdrlen: length of familiy specific header 391bfa83a9eSThomas Graf * @maxtype: maximum attribute type to be expected 392bfa83a9eSThomas Graf * @policy: validation policy 393bfa83a9eSThomas Graf */ 394bfa83a9eSThomas Graf static inline int nlmsg_validate(struct nlmsghdr *nlh, int hdrlen, int maxtype, 395bfa83a9eSThomas Graf struct nla_policy *policy) 396bfa83a9eSThomas Graf { 397bfa83a9eSThomas Graf if (nlh->nlmsg_len < nlmsg_msg_size(hdrlen)) 398bfa83a9eSThomas Graf return -EINVAL; 399bfa83a9eSThomas Graf 400bfa83a9eSThomas Graf return nla_validate(nlmsg_attrdata(nlh, hdrlen), 401bfa83a9eSThomas Graf nlmsg_attrlen(nlh, hdrlen), maxtype, policy); 402bfa83a9eSThomas Graf } 403bfa83a9eSThomas Graf 404bfa83a9eSThomas Graf /** 40597676b6bSThomas Graf * nlmsg_report - need to report back to application? 40697676b6bSThomas Graf * @nlh: netlink message header 40797676b6bSThomas Graf * 40897676b6bSThomas Graf * Returns 1 if a report back to the application is requested. 40997676b6bSThomas Graf */ 41097676b6bSThomas Graf static inline int nlmsg_report(struct nlmsghdr *nlh) 41197676b6bSThomas Graf { 41297676b6bSThomas Graf return !!(nlh->nlmsg_flags & NLM_F_ECHO); 41397676b6bSThomas Graf } 41497676b6bSThomas Graf 41597676b6bSThomas Graf /** 416bfa83a9eSThomas Graf * nlmsg_for_each_attr - iterate over a stream of attributes 417bfa83a9eSThomas Graf * @pos: loop counter, set to current attribute 418bfa83a9eSThomas Graf * @nlh: netlink message header 419bfa83a9eSThomas Graf * @hdrlen: length of familiy specific header 420bfa83a9eSThomas Graf * @rem: initialized to len, holds bytes currently remaining in stream 421bfa83a9eSThomas Graf */ 422bfa83a9eSThomas Graf #define nlmsg_for_each_attr(pos, nlh, hdrlen, rem) \ 423bfa83a9eSThomas Graf nla_for_each_attr(pos, nlmsg_attrdata(nlh, hdrlen), \ 424bfa83a9eSThomas Graf nlmsg_attrlen(nlh, hdrlen), rem) 425bfa83a9eSThomas Graf 426bfa83a9eSThomas Graf #if 0 427bfa83a9eSThomas Graf /* FIXME: Enable once all users have been converted */ 428bfa83a9eSThomas Graf 429bfa83a9eSThomas Graf /** 430bfa83a9eSThomas Graf * __nlmsg_put - Add a new netlink message to an skb 431bfa83a9eSThomas Graf * @skb: socket buffer to store message in 432bfa83a9eSThomas Graf * @pid: netlink process id 433bfa83a9eSThomas Graf * @seq: sequence number of message 434bfa83a9eSThomas Graf * @type: message type 435bfa83a9eSThomas Graf * @payload: length of message payload 436bfa83a9eSThomas Graf * @flags: message flags 437bfa83a9eSThomas Graf * 438bfa83a9eSThomas Graf * The caller is responsible to ensure that the skb provides enough 439bfa83a9eSThomas Graf * tailroom for both the netlink header and payload. 440bfa83a9eSThomas Graf */ 441bfa83a9eSThomas Graf static inline struct nlmsghdr *__nlmsg_put(struct sk_buff *skb, u32 pid, 442bfa83a9eSThomas Graf u32 seq, int type, int payload, 443bfa83a9eSThomas Graf int flags) 444bfa83a9eSThomas Graf { 445bfa83a9eSThomas Graf struct nlmsghdr *nlh; 446bfa83a9eSThomas Graf 447bfa83a9eSThomas Graf nlh = (struct nlmsghdr *) skb_put(skb, nlmsg_total_size(payload)); 448bfa83a9eSThomas Graf nlh->nlmsg_type = type; 449bfa83a9eSThomas Graf nlh->nlmsg_len = nlmsg_msg_size(payload); 450bfa83a9eSThomas Graf nlh->nlmsg_flags = flags; 451bfa83a9eSThomas Graf nlh->nlmsg_pid = pid; 452bfa83a9eSThomas Graf nlh->nlmsg_seq = seq; 453bfa83a9eSThomas Graf 454bfa83a9eSThomas Graf memset((unsigned char *) nlmsg_data(nlh) + payload, 0, 455bfa83a9eSThomas Graf nlmsg_padlen(payload)); 456bfa83a9eSThomas Graf 457bfa83a9eSThomas Graf return nlh; 458bfa83a9eSThomas Graf } 459bfa83a9eSThomas Graf #endif 460bfa83a9eSThomas Graf 461bfa83a9eSThomas Graf /** 462bfa83a9eSThomas Graf * nlmsg_put - Add a new netlink message to an skb 463bfa83a9eSThomas Graf * @skb: socket buffer to store message in 464bfa83a9eSThomas Graf * @pid: netlink process id 465bfa83a9eSThomas Graf * @seq: sequence number of message 466bfa83a9eSThomas Graf * @type: message type 467bfa83a9eSThomas Graf * @payload: length of message payload 468bfa83a9eSThomas Graf * @flags: message flags 469bfa83a9eSThomas Graf * 470bfa83a9eSThomas Graf * Returns NULL if the tailroom of the skb is insufficient to store 471bfa83a9eSThomas Graf * the message header and payload. 472bfa83a9eSThomas Graf */ 473bfa83a9eSThomas Graf static inline struct nlmsghdr *nlmsg_put(struct sk_buff *skb, u32 pid, u32 seq, 474bfa83a9eSThomas Graf int type, int payload, int flags) 475bfa83a9eSThomas Graf { 476bfa83a9eSThomas Graf if (unlikely(skb_tailroom(skb) < nlmsg_total_size(payload))) 477bfa83a9eSThomas Graf return NULL; 478bfa83a9eSThomas Graf 479bfa83a9eSThomas Graf return __nlmsg_put(skb, pid, seq, type, payload, flags); 480bfa83a9eSThomas Graf } 481bfa83a9eSThomas Graf 482bfa83a9eSThomas Graf /** 483bfa83a9eSThomas Graf * nlmsg_put_answer - Add a new callback based netlink message to an skb 484bfa83a9eSThomas Graf * @skb: socket buffer to store message in 485bfa83a9eSThomas Graf * @cb: netlink callback 486bfa83a9eSThomas Graf * @type: message type 487bfa83a9eSThomas Graf * @payload: length of message payload 488bfa83a9eSThomas Graf * @flags: message flags 489bfa83a9eSThomas Graf * 490bfa83a9eSThomas Graf * Returns NULL if the tailroom of the skb is insufficient to store 491bfa83a9eSThomas Graf * the message header and payload. 492bfa83a9eSThomas Graf */ 493bfa83a9eSThomas Graf static inline struct nlmsghdr *nlmsg_put_answer(struct sk_buff *skb, 494bfa83a9eSThomas Graf struct netlink_callback *cb, 495bfa83a9eSThomas Graf int type, int payload, 496bfa83a9eSThomas Graf int flags) 497bfa83a9eSThomas Graf { 498bfa83a9eSThomas Graf return nlmsg_put(skb, NETLINK_CB(cb->skb).pid, cb->nlh->nlmsg_seq, 499bfa83a9eSThomas Graf type, payload, flags); 500bfa83a9eSThomas Graf } 501bfa83a9eSThomas Graf 502bfa83a9eSThomas Graf /** 503bfa83a9eSThomas Graf * nlmsg_new - Allocate a new netlink message 504339bf98fSThomas Graf * @payload: size of the message payload 505fe4944e5SThomas Graf * @flags: the type of memory to allocate. 506bfa83a9eSThomas Graf * 507339bf98fSThomas Graf * Use NLMSG_DEFAULT_SIZE if the size of the payload isn't known 508339bf98fSThomas Graf * and a good default is needed. 509bfa83a9eSThomas Graf */ 510339bf98fSThomas Graf static inline struct sk_buff *nlmsg_new(size_t payload, gfp_t flags) 511bfa83a9eSThomas Graf { 512339bf98fSThomas Graf return alloc_skb(nlmsg_total_size(payload), flags); 513bfa83a9eSThomas Graf } 514bfa83a9eSThomas Graf 515bfa83a9eSThomas Graf /** 516bfa83a9eSThomas Graf * nlmsg_end - Finalize a netlink message 517bfa83a9eSThomas Graf * @skb: socket buffer the message is stored in 518bfa83a9eSThomas Graf * @nlh: netlink message header 519bfa83a9eSThomas Graf * 520bfa83a9eSThomas Graf * Corrects the netlink message header to include the appeneded 521bfa83a9eSThomas Graf * attributes. Only necessary if attributes have been added to 522bfa83a9eSThomas Graf * the message. 523bfa83a9eSThomas Graf * 524bfa83a9eSThomas Graf * Returns the total data length of the skb. 525bfa83a9eSThomas Graf */ 526bfa83a9eSThomas Graf static inline int nlmsg_end(struct sk_buff *skb, struct nlmsghdr *nlh) 527bfa83a9eSThomas Graf { 52827a884dcSArnaldo Carvalho de Melo nlh->nlmsg_len = skb_tail_pointer(skb) - (unsigned char *)nlh; 529bfa83a9eSThomas Graf 530bfa83a9eSThomas Graf return skb->len; 531bfa83a9eSThomas Graf } 532bfa83a9eSThomas Graf 533bfa83a9eSThomas Graf /** 534fe4944e5SThomas Graf * nlmsg_get_pos - return current position in netlink message 535fe4944e5SThomas Graf * @skb: socket buffer the message is stored in 536fe4944e5SThomas Graf * 537fe4944e5SThomas Graf * Returns a pointer to the current tail of the message. 538fe4944e5SThomas Graf */ 539fe4944e5SThomas Graf static inline void *nlmsg_get_pos(struct sk_buff *skb) 540fe4944e5SThomas Graf { 54127a884dcSArnaldo Carvalho de Melo return skb_tail_pointer(skb); 542fe4944e5SThomas Graf } 543fe4944e5SThomas Graf 544fe4944e5SThomas Graf /** 545fe4944e5SThomas Graf * nlmsg_trim - Trim message to a mark 546fe4944e5SThomas Graf * @skb: socket buffer the message is stored in 547fe4944e5SThomas Graf * @mark: mark to trim to 548fe4944e5SThomas Graf * 549fe4944e5SThomas Graf * Trims the message to the provided mark. Returns -1. 550fe4944e5SThomas Graf */ 551dc5fc579SArnaldo Carvalho de Melo static inline int nlmsg_trim(struct sk_buff *skb, const void *mark) 552fe4944e5SThomas Graf { 553fe4944e5SThomas Graf if (mark) 554fe4944e5SThomas Graf skb_trim(skb, (unsigned char *) mark - skb->data); 555fe4944e5SThomas Graf 556fe4944e5SThomas Graf return -1; 557fe4944e5SThomas Graf } 558fe4944e5SThomas Graf 559fe4944e5SThomas Graf /** 560bfa83a9eSThomas Graf * nlmsg_cancel - Cancel construction of a netlink message 561bfa83a9eSThomas Graf * @skb: socket buffer the message is stored in 562bfa83a9eSThomas Graf * @nlh: netlink message header 563bfa83a9eSThomas Graf * 564bfa83a9eSThomas Graf * Removes the complete netlink message including all 565bfa83a9eSThomas Graf * attributes from the socket buffer again. Returns -1. 566bfa83a9eSThomas Graf */ 567bfa83a9eSThomas Graf static inline int nlmsg_cancel(struct sk_buff *skb, struct nlmsghdr *nlh) 568bfa83a9eSThomas Graf { 569fe4944e5SThomas Graf return nlmsg_trim(skb, nlh); 570bfa83a9eSThomas Graf } 571bfa83a9eSThomas Graf 572bfa83a9eSThomas Graf /** 573bfa83a9eSThomas Graf * nlmsg_free - free a netlink message 574bfa83a9eSThomas Graf * @skb: socket buffer of netlink message 575bfa83a9eSThomas Graf */ 576bfa83a9eSThomas Graf static inline void nlmsg_free(struct sk_buff *skb) 577bfa83a9eSThomas Graf { 578bfa83a9eSThomas Graf kfree_skb(skb); 579bfa83a9eSThomas Graf } 580bfa83a9eSThomas Graf 581bfa83a9eSThomas Graf /** 582bfa83a9eSThomas Graf * nlmsg_multicast - multicast a netlink message 583bfa83a9eSThomas Graf * @sk: netlink socket to spread messages to 584bfa83a9eSThomas Graf * @skb: netlink message as socket buffer 585bfa83a9eSThomas Graf * @pid: own netlink pid to avoid sending to yourself 586bfa83a9eSThomas Graf * @group: multicast group id 587d387f6adSThomas Graf * @flags: allocation flags 588bfa83a9eSThomas Graf */ 589bfa83a9eSThomas Graf static inline int nlmsg_multicast(struct sock *sk, struct sk_buff *skb, 590d387f6adSThomas Graf u32 pid, unsigned int group, gfp_t flags) 591bfa83a9eSThomas Graf { 592bfa83a9eSThomas Graf int err; 593bfa83a9eSThomas Graf 594bfa83a9eSThomas Graf NETLINK_CB(skb).dst_group = group; 595bfa83a9eSThomas Graf 596d387f6adSThomas Graf err = netlink_broadcast(sk, skb, pid, group, flags); 597bfa83a9eSThomas Graf if (err > 0) 598bfa83a9eSThomas Graf err = 0; 599bfa83a9eSThomas Graf 600bfa83a9eSThomas Graf return err; 601bfa83a9eSThomas Graf } 602bfa83a9eSThomas Graf 603bfa83a9eSThomas Graf /** 604bfa83a9eSThomas Graf * nlmsg_unicast - unicast a netlink message 605bfa83a9eSThomas Graf * @sk: netlink socket to spread message to 606bfa83a9eSThomas Graf * @skb: netlink message as socket buffer 607bfa83a9eSThomas Graf * @pid: netlink pid of the destination socket 608bfa83a9eSThomas Graf */ 609bfa83a9eSThomas Graf static inline int nlmsg_unicast(struct sock *sk, struct sk_buff *skb, u32 pid) 610bfa83a9eSThomas Graf { 611bfa83a9eSThomas Graf int err; 612bfa83a9eSThomas Graf 613bfa83a9eSThomas Graf err = netlink_unicast(sk, skb, pid, MSG_DONTWAIT); 614bfa83a9eSThomas Graf if (err > 0) 615bfa83a9eSThomas Graf err = 0; 616bfa83a9eSThomas Graf 617bfa83a9eSThomas Graf return err; 618bfa83a9eSThomas Graf } 619bfa83a9eSThomas Graf 620bfa83a9eSThomas Graf /** 621bfa83a9eSThomas Graf * nlmsg_for_each_msg - iterate over a stream of messages 622bfa83a9eSThomas Graf * @pos: loop counter, set to current message 623bfa83a9eSThomas Graf * @head: head of message stream 624bfa83a9eSThomas Graf * @len: length of message stream 625bfa83a9eSThomas Graf * @rem: initialized to len, holds bytes currently remaining in stream 626bfa83a9eSThomas Graf */ 627bfa83a9eSThomas Graf #define nlmsg_for_each_msg(pos, head, len, rem) \ 628bfa83a9eSThomas Graf for (pos = head, rem = len; \ 629bfa83a9eSThomas Graf nlmsg_ok(pos, rem); \ 630bfa83a9eSThomas Graf pos = nlmsg_next(pos, &(rem))) 631bfa83a9eSThomas Graf 632bfa83a9eSThomas Graf /************************************************************************** 633bfa83a9eSThomas Graf * Netlink Attributes 634bfa83a9eSThomas Graf **************************************************************************/ 635bfa83a9eSThomas Graf 636bfa83a9eSThomas Graf /** 637bfa83a9eSThomas Graf * nla_attr_size - length of attribute not including padding 638bfa83a9eSThomas Graf * @payload: length of payload 639bfa83a9eSThomas Graf */ 640bfa83a9eSThomas Graf static inline int nla_attr_size(int payload) 641bfa83a9eSThomas Graf { 642bfa83a9eSThomas Graf return NLA_HDRLEN + payload; 643bfa83a9eSThomas Graf } 644bfa83a9eSThomas Graf 645bfa83a9eSThomas Graf /** 646bfa83a9eSThomas Graf * nla_total_size - total length of attribute including padding 647bfa83a9eSThomas Graf * @payload: length of payload 648bfa83a9eSThomas Graf */ 649bfa83a9eSThomas Graf static inline int nla_total_size(int payload) 650bfa83a9eSThomas Graf { 651bfa83a9eSThomas Graf return NLA_ALIGN(nla_attr_size(payload)); 652bfa83a9eSThomas Graf } 653bfa83a9eSThomas Graf 654bfa83a9eSThomas Graf /** 655bfa83a9eSThomas Graf * nla_padlen - length of padding at the tail of attribute 656bfa83a9eSThomas Graf * @payload: length of payload 657bfa83a9eSThomas Graf */ 658bfa83a9eSThomas Graf static inline int nla_padlen(int payload) 659bfa83a9eSThomas Graf { 660bfa83a9eSThomas Graf return nla_total_size(payload) - nla_attr_size(payload); 661bfa83a9eSThomas Graf } 662bfa83a9eSThomas Graf 663bfa83a9eSThomas Graf /** 664bfa83a9eSThomas Graf * nla_data - head of payload 665bfa83a9eSThomas Graf * @nla: netlink attribute 666bfa83a9eSThomas Graf */ 667bfa83a9eSThomas Graf static inline void *nla_data(const struct nlattr *nla) 668bfa83a9eSThomas Graf { 669bfa83a9eSThomas Graf return (char *) nla + NLA_HDRLEN; 670bfa83a9eSThomas Graf } 671bfa83a9eSThomas Graf 672bfa83a9eSThomas Graf /** 673bfa83a9eSThomas Graf * nla_len - length of payload 674bfa83a9eSThomas Graf * @nla: netlink attribute 675bfa83a9eSThomas Graf */ 676bfa83a9eSThomas Graf static inline int nla_len(const struct nlattr *nla) 677bfa83a9eSThomas Graf { 678bfa83a9eSThomas Graf return nla->nla_len - NLA_HDRLEN; 679bfa83a9eSThomas Graf } 680bfa83a9eSThomas Graf 681bfa83a9eSThomas Graf /** 682bfa83a9eSThomas Graf * nla_ok - check if the netlink attribute fits into the remaining bytes 683bfa83a9eSThomas Graf * @nla: netlink attribute 684bfa83a9eSThomas Graf * @remaining: number of bytes remaining in attribute stream 685bfa83a9eSThomas Graf */ 686bfa83a9eSThomas Graf static inline int nla_ok(const struct nlattr *nla, int remaining) 687bfa83a9eSThomas Graf { 688bfa83a9eSThomas Graf return remaining >= sizeof(*nla) && 689bfa83a9eSThomas Graf nla->nla_len >= sizeof(*nla) && 690bfa83a9eSThomas Graf nla->nla_len <= remaining; 691bfa83a9eSThomas Graf } 692bfa83a9eSThomas Graf 693bfa83a9eSThomas Graf /** 694bfa83a9eSThomas Graf * nla_next - next netlink attribte in attribute stream 695bfa83a9eSThomas Graf * @nla: netlink attribute 696bfa83a9eSThomas Graf * @remaining: number of bytes remaining in attribute stream 697bfa83a9eSThomas Graf * 698bfa83a9eSThomas Graf * Returns the next netlink attribute in the attribute stream and 699bfa83a9eSThomas Graf * decrements remaining by the size of the current attribute. 700bfa83a9eSThomas Graf */ 701bfa83a9eSThomas Graf static inline struct nlattr *nla_next(const struct nlattr *nla, int *remaining) 702bfa83a9eSThomas Graf { 703bfa83a9eSThomas Graf int totlen = NLA_ALIGN(nla->nla_len); 704bfa83a9eSThomas Graf 705bfa83a9eSThomas Graf *remaining -= totlen; 706bfa83a9eSThomas Graf return (struct nlattr *) ((char *) nla + totlen); 707bfa83a9eSThomas Graf } 708bfa83a9eSThomas Graf 709bfa83a9eSThomas Graf /** 710fe4944e5SThomas Graf * nla_find_nested - find attribute in a set of nested attributes 711fe4944e5SThomas Graf * @nla: attribute containing the nested attributes 712fe4944e5SThomas Graf * @attrtype: type of attribute to look for 713fe4944e5SThomas Graf * 714fe4944e5SThomas Graf * Returns the first attribute which matches the specified type. 715fe4944e5SThomas Graf */ 716fe4944e5SThomas Graf static inline struct nlattr *nla_find_nested(struct nlattr *nla, int attrtype) 717fe4944e5SThomas Graf { 718fe4944e5SThomas Graf return nla_find(nla_data(nla), nla_len(nla), attrtype); 719fe4944e5SThomas Graf } 720fe4944e5SThomas Graf 721fe4944e5SThomas Graf /** 722bfa83a9eSThomas Graf * nla_parse_nested - parse nested attributes 723bfa83a9eSThomas Graf * @tb: destination array with maxtype+1 elements 724bfa83a9eSThomas Graf * @maxtype: maximum attribute type to be expected 725bfa83a9eSThomas Graf * @nla: attribute containing the nested attributes 726bfa83a9eSThomas Graf * @policy: validation policy 727bfa83a9eSThomas Graf * 728bfa83a9eSThomas Graf * See nla_parse() 729bfa83a9eSThomas Graf */ 730bfa83a9eSThomas Graf static inline int nla_parse_nested(struct nlattr *tb[], int maxtype, 731bfa83a9eSThomas Graf struct nlattr *nla, 732bfa83a9eSThomas Graf struct nla_policy *policy) 733bfa83a9eSThomas Graf { 734bfa83a9eSThomas Graf return nla_parse(tb, maxtype, nla_data(nla), nla_len(nla), policy); 735bfa83a9eSThomas Graf } 736bfa83a9eSThomas Graf /** 737bfa83a9eSThomas Graf * nla_put_u8 - Add a u16 netlink attribute to a socket buffer 738bfa83a9eSThomas Graf * @skb: socket buffer to add attribute to 739bfa83a9eSThomas Graf * @attrtype: attribute type 740bfa83a9eSThomas Graf * @value: numeric value 741bfa83a9eSThomas Graf */ 742bfa83a9eSThomas Graf static inline int nla_put_u8(struct sk_buff *skb, int attrtype, u8 value) 743bfa83a9eSThomas Graf { 744bfa83a9eSThomas Graf return nla_put(skb, attrtype, sizeof(u8), &value); 745bfa83a9eSThomas Graf } 746bfa83a9eSThomas Graf 747bfa83a9eSThomas Graf /** 748bfa83a9eSThomas Graf * nla_put_u16 - Add a u16 netlink attribute to a socket buffer 749bfa83a9eSThomas Graf * @skb: socket buffer to add attribute to 750bfa83a9eSThomas Graf * @attrtype: attribute type 751bfa83a9eSThomas Graf * @value: numeric value 752bfa83a9eSThomas Graf */ 753bfa83a9eSThomas Graf static inline int nla_put_u16(struct sk_buff *skb, int attrtype, u16 value) 754bfa83a9eSThomas Graf { 755bfa83a9eSThomas Graf return nla_put(skb, attrtype, sizeof(u16), &value); 756bfa83a9eSThomas Graf } 757bfa83a9eSThomas Graf 758bfa83a9eSThomas Graf /** 759bfa83a9eSThomas Graf * nla_put_u32 - Add a u32 netlink attribute to a socket buffer 760bfa83a9eSThomas Graf * @skb: socket buffer to add attribute to 761bfa83a9eSThomas Graf * @attrtype: attribute type 762bfa83a9eSThomas Graf * @value: numeric value 763bfa83a9eSThomas Graf */ 764bfa83a9eSThomas Graf static inline int nla_put_u32(struct sk_buff *skb, int attrtype, u32 value) 765bfa83a9eSThomas Graf { 766bfa83a9eSThomas Graf return nla_put(skb, attrtype, sizeof(u32), &value); 767bfa83a9eSThomas Graf } 768bfa83a9eSThomas Graf 769bfa83a9eSThomas Graf /** 770bfa83a9eSThomas Graf * nla_put_64 - Add a u64 netlink attribute to a socket buffer 771bfa83a9eSThomas Graf * @skb: socket buffer to add attribute to 772bfa83a9eSThomas Graf * @attrtype: attribute type 773bfa83a9eSThomas Graf * @value: numeric value 774bfa83a9eSThomas Graf */ 775bfa83a9eSThomas Graf static inline int nla_put_u64(struct sk_buff *skb, int attrtype, u64 value) 776bfa83a9eSThomas Graf { 777bfa83a9eSThomas Graf return nla_put(skb, attrtype, sizeof(u64), &value); 778bfa83a9eSThomas Graf } 779bfa83a9eSThomas Graf 780bfa83a9eSThomas Graf /** 781bfa83a9eSThomas Graf * nla_put_string - Add a string netlink attribute to a socket buffer 782bfa83a9eSThomas Graf * @skb: socket buffer to add attribute to 783bfa83a9eSThomas Graf * @attrtype: attribute type 784bfa83a9eSThomas Graf * @str: NUL terminated string 785bfa83a9eSThomas Graf */ 786bfa83a9eSThomas Graf static inline int nla_put_string(struct sk_buff *skb, int attrtype, 787bfa83a9eSThomas Graf const char *str) 788bfa83a9eSThomas Graf { 789bfa83a9eSThomas Graf return nla_put(skb, attrtype, strlen(str) + 1, str); 790bfa83a9eSThomas Graf } 791bfa83a9eSThomas Graf 792bfa83a9eSThomas Graf /** 793bfa83a9eSThomas Graf * nla_put_flag - Add a flag netlink attribute to a socket buffer 794bfa83a9eSThomas Graf * @skb: socket buffer to add attribute to 795bfa83a9eSThomas Graf * @attrtype: attribute type 796bfa83a9eSThomas Graf */ 797bfa83a9eSThomas Graf static inline int nla_put_flag(struct sk_buff *skb, int attrtype) 798bfa83a9eSThomas Graf { 799bfa83a9eSThomas Graf return nla_put(skb, attrtype, 0, NULL); 800bfa83a9eSThomas Graf } 801bfa83a9eSThomas Graf 802bfa83a9eSThomas Graf /** 803bfa83a9eSThomas Graf * nla_put_msecs - Add a msecs netlink attribute to a socket buffer 804bfa83a9eSThomas Graf * @skb: socket buffer to add attribute to 805bfa83a9eSThomas Graf * @attrtype: attribute type 806bfa83a9eSThomas Graf * @jiffies: number of msecs in jiffies 807bfa83a9eSThomas Graf */ 808bfa83a9eSThomas Graf static inline int nla_put_msecs(struct sk_buff *skb, int attrtype, 809bfa83a9eSThomas Graf unsigned long jiffies) 810bfa83a9eSThomas Graf { 811bfa83a9eSThomas Graf u64 tmp = jiffies_to_msecs(jiffies); 812bfa83a9eSThomas Graf return nla_put(skb, attrtype, sizeof(u64), &tmp); 813bfa83a9eSThomas Graf } 814bfa83a9eSThomas Graf 815bfa83a9eSThomas Graf #define NLA_PUT(skb, attrtype, attrlen, data) \ 816bfa83a9eSThomas Graf do { \ 817bfa83a9eSThomas Graf if (nla_put(skb, attrtype, attrlen, data) < 0) \ 818bfa83a9eSThomas Graf goto nla_put_failure; \ 819bfa83a9eSThomas Graf } while(0) 820bfa83a9eSThomas Graf 821bfa83a9eSThomas Graf #define NLA_PUT_TYPE(skb, type, attrtype, value) \ 822bfa83a9eSThomas Graf do { \ 823bfa83a9eSThomas Graf type __tmp = value; \ 824bfa83a9eSThomas Graf NLA_PUT(skb, attrtype, sizeof(type), &__tmp); \ 825bfa83a9eSThomas Graf } while(0) 826bfa83a9eSThomas Graf 827bfa83a9eSThomas Graf #define NLA_PUT_U8(skb, attrtype, value) \ 828bfa83a9eSThomas Graf NLA_PUT_TYPE(skb, u8, attrtype, value) 829bfa83a9eSThomas Graf 830bfa83a9eSThomas Graf #define NLA_PUT_U16(skb, attrtype, value) \ 831bfa83a9eSThomas Graf NLA_PUT_TYPE(skb, u16, attrtype, value) 832bfa83a9eSThomas Graf 8334a89c256SThomas Graf #define NLA_PUT_LE16(skb, attrtype, value) \ 8344a89c256SThomas Graf NLA_PUT_TYPE(skb, __le16, attrtype, value) 8354a89c256SThomas Graf 836bfa83a9eSThomas Graf #define NLA_PUT_U32(skb, attrtype, value) \ 837bfa83a9eSThomas Graf NLA_PUT_TYPE(skb, u32, attrtype, value) 838bfa83a9eSThomas Graf 83900012e5bSAl Viro #define NLA_PUT_BE32(skb, attrtype, value) \ 84000012e5bSAl Viro NLA_PUT_TYPE(skb, __be32, attrtype, value) 84100012e5bSAl Viro 842bfa83a9eSThomas Graf #define NLA_PUT_U64(skb, attrtype, value) \ 843bfa83a9eSThomas Graf NLA_PUT_TYPE(skb, u64, attrtype, value) 844bfa83a9eSThomas Graf 845bfa83a9eSThomas Graf #define NLA_PUT_STRING(skb, attrtype, value) \ 846bfa83a9eSThomas Graf NLA_PUT(skb, attrtype, strlen(value) + 1, value) 847bfa83a9eSThomas Graf 848ff5dfe73SJohannes Berg #define NLA_PUT_FLAG(skb, attrtype) \ 849bfa83a9eSThomas Graf NLA_PUT(skb, attrtype, 0, NULL) 850bfa83a9eSThomas Graf 851bfa83a9eSThomas Graf #define NLA_PUT_MSECS(skb, attrtype, jiffies) \ 852bfa83a9eSThomas Graf NLA_PUT_U64(skb, attrtype, jiffies_to_msecs(jiffies)) 853bfa83a9eSThomas Graf 854bfa83a9eSThomas Graf /** 855bfa83a9eSThomas Graf * nla_get_u32 - return payload of u32 attribute 856bfa83a9eSThomas Graf * @nla: u32 netlink attribute 857bfa83a9eSThomas Graf */ 858bfa83a9eSThomas Graf static inline u32 nla_get_u32(struct nlattr *nla) 859bfa83a9eSThomas Graf { 860bfa83a9eSThomas Graf return *(u32 *) nla_data(nla); 861bfa83a9eSThomas Graf } 862bfa83a9eSThomas Graf 863bfa83a9eSThomas Graf /** 86400012e5bSAl Viro * nla_get_be32 - return payload of __be32 attribute 86500012e5bSAl Viro * @nla: __be32 netlink attribute 86600012e5bSAl Viro */ 86700012e5bSAl Viro static inline __be32 nla_get_be32(struct nlattr *nla) 86800012e5bSAl Viro { 86900012e5bSAl Viro return *(__be32 *) nla_data(nla); 87000012e5bSAl Viro } 87100012e5bSAl Viro 87200012e5bSAl Viro /** 873bfa83a9eSThomas Graf * nla_get_u16 - return payload of u16 attribute 874bfa83a9eSThomas Graf * @nla: u16 netlink attribute 875bfa83a9eSThomas Graf */ 876bfa83a9eSThomas Graf static inline u16 nla_get_u16(struct nlattr *nla) 877bfa83a9eSThomas Graf { 878bfa83a9eSThomas Graf return *(u16 *) nla_data(nla); 879bfa83a9eSThomas Graf } 880bfa83a9eSThomas Graf 881bfa83a9eSThomas Graf /** 8824a89c256SThomas Graf * nla_get_le16 - return payload of __le16 attribute 8834a89c256SThomas Graf * @nla: __le16 netlink attribute 8844a89c256SThomas Graf */ 8854a89c256SThomas Graf static inline __le16 nla_get_le16(struct nlattr *nla) 8864a89c256SThomas Graf { 8874a89c256SThomas Graf return *(__le16 *) nla_data(nla); 8884a89c256SThomas Graf } 8894a89c256SThomas Graf 8904a89c256SThomas Graf /** 891bfa83a9eSThomas Graf * nla_get_u8 - return payload of u8 attribute 892bfa83a9eSThomas Graf * @nla: u8 netlink attribute 893bfa83a9eSThomas Graf */ 894bfa83a9eSThomas Graf static inline u8 nla_get_u8(struct nlattr *nla) 895bfa83a9eSThomas Graf { 896bfa83a9eSThomas Graf return *(u8 *) nla_data(nla); 897bfa83a9eSThomas Graf } 898bfa83a9eSThomas Graf 899bfa83a9eSThomas Graf /** 900bfa83a9eSThomas Graf * nla_get_u64 - return payload of u64 attribute 901bfa83a9eSThomas Graf * @nla: u64 netlink attribute 902bfa83a9eSThomas Graf */ 903bfa83a9eSThomas Graf static inline u64 nla_get_u64(struct nlattr *nla) 904bfa83a9eSThomas Graf { 905bfa83a9eSThomas Graf u64 tmp; 906bfa83a9eSThomas Graf 907bfa83a9eSThomas Graf nla_memcpy(&tmp, nla, sizeof(tmp)); 908bfa83a9eSThomas Graf 909bfa83a9eSThomas Graf return tmp; 910bfa83a9eSThomas Graf } 911bfa83a9eSThomas Graf 912bfa83a9eSThomas Graf /** 913bfa83a9eSThomas Graf * nla_get_flag - return payload of flag attribute 914bfa83a9eSThomas Graf * @nla: flag netlink attribute 915bfa83a9eSThomas Graf */ 916bfa83a9eSThomas Graf static inline int nla_get_flag(struct nlattr *nla) 917bfa83a9eSThomas Graf { 918bfa83a9eSThomas Graf return !!nla; 919bfa83a9eSThomas Graf } 920bfa83a9eSThomas Graf 921bfa83a9eSThomas Graf /** 922bfa83a9eSThomas Graf * nla_get_msecs - return payload of msecs attribute 923bfa83a9eSThomas Graf * @nla: msecs netlink attribute 924bfa83a9eSThomas Graf * 925bfa83a9eSThomas Graf * Returns the number of milliseconds in jiffies. 926bfa83a9eSThomas Graf */ 927bfa83a9eSThomas Graf static inline unsigned long nla_get_msecs(struct nlattr *nla) 928bfa83a9eSThomas Graf { 929bfa83a9eSThomas Graf u64 msecs = nla_get_u64(nla); 930bfa83a9eSThomas Graf 931bfa83a9eSThomas Graf return msecs_to_jiffies((unsigned long) msecs); 932bfa83a9eSThomas Graf } 933bfa83a9eSThomas Graf 934bfa83a9eSThomas Graf /** 935bfa83a9eSThomas Graf * nla_nest_start - Start a new level of nested attributes 936bfa83a9eSThomas Graf * @skb: socket buffer to add attributes to 937bfa83a9eSThomas Graf * @attrtype: attribute type of container 938bfa83a9eSThomas Graf * 939bfa83a9eSThomas Graf * Returns the container attribute 940bfa83a9eSThomas Graf */ 941bfa83a9eSThomas Graf static inline struct nlattr *nla_nest_start(struct sk_buff *skb, int attrtype) 942bfa83a9eSThomas Graf { 94327a884dcSArnaldo Carvalho de Melo struct nlattr *start = (struct nlattr *)skb_tail_pointer(skb); 944bfa83a9eSThomas Graf 945bfa83a9eSThomas Graf if (nla_put(skb, attrtype, 0, NULL) < 0) 946bfa83a9eSThomas Graf return NULL; 947bfa83a9eSThomas Graf 948bfa83a9eSThomas Graf return start; 949bfa83a9eSThomas Graf } 950bfa83a9eSThomas Graf 951bfa83a9eSThomas Graf /** 952bfa83a9eSThomas Graf * nla_nest_end - Finalize nesting of attributes 953bfa83a9eSThomas Graf * @skb: socket buffer the attribtues are stored in 954bfa83a9eSThomas Graf * @start: container attribute 955bfa83a9eSThomas Graf * 956bfa83a9eSThomas Graf * Corrects the container attribute header to include the all 957bfa83a9eSThomas Graf * appeneded attributes. 958bfa83a9eSThomas Graf * 959bfa83a9eSThomas Graf * Returns the total data length of the skb. 960bfa83a9eSThomas Graf */ 961bfa83a9eSThomas Graf static inline int nla_nest_end(struct sk_buff *skb, struct nlattr *start) 962bfa83a9eSThomas Graf { 96327a884dcSArnaldo Carvalho de Melo start->nla_len = skb_tail_pointer(skb) - (unsigned char *)start; 964bfa83a9eSThomas Graf return skb->len; 965bfa83a9eSThomas Graf } 966bfa83a9eSThomas Graf 967bfa83a9eSThomas Graf /** 968bfa83a9eSThomas Graf * nla_nest_cancel - Cancel nesting of attributes 969bfa83a9eSThomas Graf * @skb: socket buffer the message is stored in 970bfa83a9eSThomas Graf * @start: container attribute 971bfa83a9eSThomas Graf * 972bfa83a9eSThomas Graf * Removes the container attribute and including all nested 973bfa83a9eSThomas Graf * attributes. Returns -1. 974bfa83a9eSThomas Graf */ 975bfa83a9eSThomas Graf static inline int nla_nest_cancel(struct sk_buff *skb, struct nlattr *start) 976bfa83a9eSThomas Graf { 977fe4944e5SThomas Graf return nlmsg_trim(skb, start); 978bfa83a9eSThomas Graf } 979bfa83a9eSThomas Graf 980bfa83a9eSThomas Graf /** 9814fe5d5c0SPaul Moore * nla_validate_nested - Validate a stream of nested attributes 9824fe5d5c0SPaul Moore * @start: container attribute 9834fe5d5c0SPaul Moore * @maxtype: maximum attribute type to be expected 9844fe5d5c0SPaul Moore * @policy: validation policy 9854fe5d5c0SPaul Moore * 9864fe5d5c0SPaul Moore * Validates all attributes in the nested attribute stream against the 9874fe5d5c0SPaul Moore * specified policy. Attributes with a type exceeding maxtype will be 9884fe5d5c0SPaul Moore * ignored. See documenation of struct nla_policy for more details. 9894fe5d5c0SPaul Moore * 9904fe5d5c0SPaul Moore * Returns 0 on success or a negative error code. 9914fe5d5c0SPaul Moore */ 9924fe5d5c0SPaul Moore static inline int nla_validate_nested(struct nlattr *start, int maxtype, 9934fe5d5c0SPaul Moore struct nla_policy *policy) 9944fe5d5c0SPaul Moore { 9954fe5d5c0SPaul Moore return nla_validate(nla_data(start), nla_len(start), maxtype, policy); 9964fe5d5c0SPaul Moore } 9974fe5d5c0SPaul Moore 9984fe5d5c0SPaul Moore /** 999bfa83a9eSThomas Graf * nla_for_each_attr - iterate over a stream of attributes 1000bfa83a9eSThomas Graf * @pos: loop counter, set to current attribute 1001bfa83a9eSThomas Graf * @head: head of attribute stream 1002bfa83a9eSThomas Graf * @len: length of attribute stream 1003bfa83a9eSThomas Graf * @rem: initialized to len, holds bytes currently remaining in stream 1004bfa83a9eSThomas Graf */ 1005bfa83a9eSThomas Graf #define nla_for_each_attr(pos, head, len, rem) \ 1006bfa83a9eSThomas Graf for (pos = head, rem = len; \ 1007bfa83a9eSThomas Graf nla_ok(pos, rem); \ 1008bfa83a9eSThomas Graf pos = nla_next(pos, &(rem))) 1009bfa83a9eSThomas Graf 1010fe4944e5SThomas Graf /** 1011fe4944e5SThomas Graf * nla_for_each_nested - iterate over nested attributes 1012fe4944e5SThomas Graf * @pos: loop counter, set to current attribute 1013fe4944e5SThomas Graf * @nla: attribute containing the nested attributes 1014fe4944e5SThomas Graf * @rem: initialized to len, holds bytes currently remaining in stream 1015fe4944e5SThomas Graf */ 1016fe4944e5SThomas Graf #define nla_for_each_nested(pos, nla, rem) \ 1017fe4944e5SThomas Graf nla_for_each_attr(pos, nla_data(nla), nla_len(nla), rem) 1018fe4944e5SThomas Graf 1019bfa83a9eSThomas Graf #endif 1020