netlink.h 31 KB

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