Commit | Line | Data |
---|---|---|
b2441318 | 1 | /* SPDX-License-Identifier: GPL-2.0 */ |
482a8524 TG |
2 | #ifndef __NET_GENERIC_NETLINK_H |
3 | #define __NET_GENERIC_NETLINK_H | |
4 | ||
5 | #include <linux/genetlink.h> | |
6 | #include <net/netlink.h> | |
134e6375 | 7 | #include <net/net_namespace.h> |
482a8524 | 8 | |
58050fce TG |
9 | #define GENLMSG_DEFAULT_SIZE (NLMSG_DEFAULT_SIZE - GENL_HDRLEN) |
10 | ||
cd4d7263 IS |
11 | /* Binding to multicast group requires %CAP_NET_ADMIN */ |
12 | #define GENL_MCAST_CAP_NET_ADMIN BIT(0) | |
13 | /* Binding to multicast group requires %CAP_SYS_ADMIN */ | |
14 | #define GENL_MCAST_CAP_SYS_ADMIN BIT(1) | |
15 | ||
2dbba6f7 JB |
16 | /** |
17 | * struct genl_multicast_group - generic netlink multicast group | |
18 | * @name: name of the multicast group, names are per-family | |
cd4d7263 | 19 | * @flags: GENL_MCAST_* flags |
2dbba6f7 | 20 | */ |
fd2c3ef7 | 21 | struct genl_multicast_group { |
2dbba6f7 | 22 | char name[GENL_NAMSIZ]; |
4d54cc32 | 23 | u8 flags; |
2dbba6f7 JB |
24 | }; |
25 | ||
20b0b53a | 26 | struct genl_split_ops; |
ff4c92d8 JB |
27 | struct genl_info; |
28 | ||
482a8524 TG |
29 | /** |
30 | * struct genl_family - generic netlink family | |
482a8524 TG |
31 | * @hdrsize: length of user specific header in bytes |
32 | * @name: name of family | |
33 | * @version: protocol version | |
34 | * @maxattr: maximum number of attributes supported | |
3b0f31f2 | 35 | * @policy: netlink policy |
134e6375 JB |
36 | * @netnsok: set to true if the family can handle network |
37 | * namespaces and should be presented in all of them | |
f555f3d7 JB |
38 | * @parallel_ops: operations can be called in parallel and aren't |
39 | * synchronized by the core genetlink code | |
ff4c92d8 JB |
40 | * @pre_doit: called before an operation's doit callback, it may |
41 | * do additional, common, filtering and return an error | |
42 | * @post_doit: called after an operation's doit callback, it may | |
43 | * undo operations done by pre_doit, for example release locks | |
3de21a89 SG |
44 | * @bind: called when family multicast group is added to a netlink socket |
45 | * @unbind: called when family multicast group is removed from a netlink socket | |
a1a824f4 | 46 | * @module: pointer to the owning module (set to THIS_MODULE) |
489111e5 JB |
47 | * @mcgrps: multicast groups used by this family |
48 | * @n_mcgrps: number of multicast groups | |
9c5d03d3 | 49 | * @resv_start_op: first operation for which reserved fields of the header |
4fa86555 JK |
50 | * can be validated and policies are required (see below); |
51 | * new families should leave this field at zero | |
489111e5 JB |
52 | * @ops: the operations supported by this family |
53 | * @n_ops: number of operations supported by this family | |
0b588afd JK |
54 | * @small_ops: the small-struct operations supported by this family |
55 | * @n_small_ops: number of small-struct operations supported by this family | |
b8fd60c3 JK |
56 | * @split_ops: the split do/dump form of operation definition |
57 | * @n_split_ops: number of entries in @split_ops, not that with split do/dump | |
58 | * ops the number of entries is not the same as number of commands | |
a7311324 JP |
59 | * @sock_priv_size: the size of per-socket private memory |
60 | * @sock_priv_init: the per-socket private memory initializer | |
61 | * @sock_priv_destroy: the per-socket private memory destructor | |
4fa86555 JK |
62 | * |
63 | * Attribute policies (the combination of @policy and @maxattr fields) | |
64 | * can be attached at the family level or at the operation level. | |
65 | * If both are present the per-operation policy takes precedence. | |
66 | * For operations before @resv_start_op lack of policy means that the core | |
67 | * will perform no attribute parsing or validation. For newer operations | |
68 | * if policy is not provided core will reject all TLV attributes. | |
482a8524 | 69 | */ |
fd2c3ef7 | 70 | struct genl_family { |
482a8524 TG |
71 | unsigned int hdrsize; |
72 | char name[GENL_NAMSIZ]; | |
73 | unsigned int version; | |
74 | unsigned int maxattr; | |
e5086736 JK |
75 | u8 netnsok:1; |
76 | u8 parallel_ops:1; | |
77 | u8 n_ops; | |
0b588afd | 78 | u8 n_small_ops; |
b8fd60c3 | 79 | u8 n_split_ops; |
e5086736 | 80 | u8 n_mcgrps; |
9c5d03d3 | 81 | u8 resv_start_op; |
3b0f31f2 | 82 | const struct nla_policy *policy; |
20b0b53a | 83 | int (*pre_doit)(const struct genl_split_ops *ops, |
ff4c92d8 JB |
84 | struct sk_buff *skb, |
85 | struct genl_info *info); | |
20b0b53a | 86 | void (*post_doit)(const struct genl_split_ops *ops, |
ff4c92d8 JB |
87 | struct sk_buff *skb, |
88 | struct genl_info *info); | |
3de21a89 SG |
89 | int (*bind)(int mcgrp); |
90 | void (*unbind)(int mcgrp); | |
489111e5 | 91 | const struct genl_ops * ops; |
0b588afd | 92 | const struct genl_small_ops *small_ops; |
b8fd60c3 | 93 | const struct genl_split_ops *split_ops; |
489111e5 | 94 | const struct genl_multicast_group *mcgrps; |
33c6b1f6 | 95 | struct module *module; |
7c3eaa02 | 96 | |
a7311324 JP |
97 | size_t sock_priv_size; |
98 | void (*sock_priv_init)(void *priv); | |
99 | void (*sock_priv_destroy)(void *priv); | |
100 | ||
7c3eaa02 JK |
101 | /* private: internal use only */ |
102 | /* protocol family identifier */ | |
103 | int id; | |
104 | /* starting number of multicast group IDs in this family */ | |
105 | unsigned int mcgrp_offset; | |
a7311324 JP |
106 | /* list of per-socket privs */ |
107 | struct xarray *sock_privs; | |
482a8524 TG |
108 | }; |
109 | ||
482a8524 TG |
110 | /** |
111 | * struct genl_info - receiving information | |
112 | * @snd_seq: sending sequence number | |
15e47304 | 113 | * @snd_portid: netlink portid of sender |
5c670a01 | 114 | * @family: generic netlink family |
482a8524 TG |
115 | * @nlhdr: netlink message header |
116 | * @genlhdr: generic netlink message header | |
482a8524 | 117 | * @attrs: netlink attributes |
ff4c92d8 JB |
118 | * @_net: network namespace |
119 | * @user_ptr: user pointers | |
7ab606d1 | 120 | * @extack: extended ACK report struct |
482a8524 | 121 | */ |
fd2c3ef7 | 122 | struct genl_info { |
482a8524 | 123 | u32 snd_seq; |
15e47304 | 124 | u32 snd_portid; |
5c670a01 | 125 | const struct genl_family *family; |
fde9bd4a | 126 | const struct nlmsghdr * nlhdr; |
482a8524 | 127 | struct genlmsghdr * genlhdr; |
482a8524 | 128 | struct nlattr ** attrs; |
0c5c9fb5 | 129 | possible_net_t _net; |
ff4c92d8 | 130 | void * user_ptr[2]; |
7ab606d1 | 131 | struct netlink_ext_ack *extack; |
482a8524 TG |
132 | }; |
133 | ||
5aa51d9f | 134 | static inline struct net *genl_info_net(const struct genl_info *info) |
134e6375 | 135 | { |
c2d9ba9b | 136 | return read_pnet(&info->_net); |
134e6375 JB |
137 | } |
138 | ||
139 | static inline void genl_info_net_set(struct genl_info *info, struct net *net) | |
140 | { | |
c2d9ba9b | 141 | write_pnet(&info->_net, net); |
134e6375 | 142 | } |
134e6375 | 143 | |
bffcc688 JK |
144 | static inline void *genl_info_userhdr(const struct genl_info *info) |
145 | { | |
146 | return (u8 *)info->genlhdr + GENL_HDRLEN; | |
147 | } | |
148 | ||
7ab606d1 JB |
149 | #define GENL_SET_ERR_MSG(info, msg) NL_SET_ERR_MSG((info)->extack, msg) |
150 | ||
a3400e87 PA |
151 | #define GENL_SET_ERR_MSG_FMT(info, msg, args...) \ |
152 | NL_SET_ERR_MSG_FMT((info)->extack, msg, ##args) | |
153 | ||
45dca157 JK |
154 | /* Report that a root attribute is missing */ |
155 | #define GENL_REQ_ATTR_CHECK(info, attr) ({ \ | |
5fd54039 | 156 | const struct genl_info *__info = (info); \ |
45dca157 JK |
157 | \ |
158 | NL_REQ_ATTR_CHECK(__info->extack, NULL, __info->attrs, (attr)); \ | |
159 | }) | |
160 | ||
ef6243ac JB |
161 | enum genl_validate_flags { |
162 | GENL_DONT_VALIDATE_STRICT = BIT(0), | |
163 | GENL_DONT_VALIDATE_DUMP = BIT(1), | |
164 | GENL_DONT_VALIDATE_DUMP_STRICT = BIT(2), | |
165 | }; | |
166 | ||
1927f41a | 167 | /** |
0b588afd JK |
168 | * struct genl_small_ops - generic netlink operations (small version) |
169 | * @cmd: command identifier | |
170 | * @internal_flags: flags used by the family | |
5c221f0a | 171 | * @flags: GENL_* flags (%GENL_ADMIN_PERM or %GENL_UNS_ADMIN_PERM) |
0b588afd JK |
172 | * @validate: validation flags from enum genl_validate_flags |
173 | * @doit: standard command callback | |
174 | * @dumpit: callback for dumpers | |
175 | * | |
176 | * This is a cut-down version of struct genl_ops for users who don't need | |
177 | * most of the ancillary infra and want to save space. | |
1927f41a | 178 | */ |
0b588afd JK |
179 | struct genl_small_ops { |
180 | int (*doit)(struct sk_buff *skb, struct genl_info *info); | |
181 | int (*dumpit)(struct sk_buff *skb, struct netlink_callback *cb); | |
182 | u8 cmd; | |
183 | u8 internal_flags; | |
184 | u8 flags; | |
185 | u8 validate; | |
1927f41a JP |
186 | }; |
187 | ||
482a8524 TG |
188 | /** |
189 | * struct genl_ops - generic netlink operations | |
190 | * @cmd: command identifier | |
ff4c92d8 | 191 | * @internal_flags: flags used by the family |
5c221f0a | 192 | * @flags: GENL_* flags (%GENL_ADMIN_PERM or %GENL_UNS_ADMIN_PERM) |
48526a0f JK |
193 | * @maxattr: maximum number of attributes supported |
194 | * @policy: netlink policy (takes precedence over family policy) | |
3ddf9b43 | 195 | * @validate: validation flags from enum genl_validate_flags |
482a8524 | 196 | * @doit: standard command callback |
fc9e50f5 | 197 | * @start: start callback for dumps |
482a8524 | 198 | * @dumpit: callback for dumpers |
a4d1366d | 199 | * @done: completion callback for dumps |
482a8524 | 200 | */ |
fd2c3ef7 | 201 | struct genl_ops { |
482a8524 TG |
202 | int (*doit)(struct sk_buff *skb, |
203 | struct genl_info *info); | |
fc9e50f5 | 204 | int (*start)(struct netlink_callback *cb); |
482a8524 TG |
205 | int (*dumpit)(struct sk_buff *skb, |
206 | struct netlink_callback *cb); | |
a4d1366d | 207 | int (*done)(struct netlink_callback *cb); |
48526a0f JK |
208 | const struct nla_policy *policy; |
209 | unsigned int maxattr; | |
3f5ccd06 JB |
210 | u8 cmd; |
211 | u8 internal_flags; | |
212 | u8 flags; | |
ef6243ac | 213 | u8 validate; |
482a8524 TG |
214 | }; |
215 | ||
20b0b53a JK |
216 | /** |
217 | * struct genl_split_ops - generic netlink operations (do/dump split version) | |
218 | * @cmd: command identifier | |
219 | * @internal_flags: flags used by the family | |
220 | * @flags: GENL_* flags (%GENL_ADMIN_PERM or %GENL_UNS_ADMIN_PERM) | |
221 | * @validate: validation flags from enum genl_validate_flags | |
222 | * @policy: netlink policy (takes precedence over family policy) | |
223 | * @maxattr: maximum number of attributes supported | |
224 | * | |
225 | * Do callbacks: | |
226 | * @pre_doit: called before an operation's @doit callback, it may | |
227 | * do additional, common, filtering and return an error | |
228 | * @doit: standard command callback | |
229 | * @post_doit: called after an operation's @doit callback, it may | |
230 | * undo operations done by pre_doit, for example release locks | |
231 | * | |
232 | * Dump callbacks: | |
233 | * @start: start callback for dumps | |
234 | * @dumpit: callback for dumpers | |
235 | * @done: completion callback for dumps | |
236 | * | |
237 | * Do callbacks can be used if %GENL_CMD_CAP_DO is set in @flags. | |
238 | * Dump callbacks can be used if %GENL_CMD_CAP_DUMP is set in @flags. | |
239 | * Exactly one of those flags must be set. | |
240 | */ | |
241 | struct genl_split_ops { | |
242 | union { | |
243 | struct { | |
244 | int (*pre_doit)(const struct genl_split_ops *ops, | |
245 | struct sk_buff *skb, | |
246 | struct genl_info *info); | |
247 | int (*doit)(struct sk_buff *skb, | |
248 | struct genl_info *info); | |
249 | void (*post_doit)(const struct genl_split_ops *ops, | |
250 | struct sk_buff *skb, | |
251 | struct genl_info *info); | |
252 | }; | |
253 | struct { | |
254 | int (*start)(struct netlink_callback *cb); | |
255 | int (*dumpit)(struct sk_buff *skb, | |
256 | struct netlink_callback *cb); | |
257 | int (*done)(struct netlink_callback *cb); | |
258 | }; | |
259 | }; | |
260 | const struct nla_policy *policy; | |
261 | unsigned int maxattr; | |
262 | u8 cmd; | |
263 | u8 internal_flags; | |
264 | u8 flags; | |
265 | u8 validate; | |
266 | }; | |
267 | ||
0b588afd | 268 | /** |
a1a824f4 | 269 | * struct genl_dumpit_info - info that is available during dumpit op call |
a1a824f4 | 270 | * @op: generic netlink ops - for internal genl code usage |
0b588afd | 271 | * @attrs: netlink attributes |
9272af10 | 272 | * @info: struct genl_info describing the request |
0b588afd JK |
273 | */ |
274 | struct genl_dumpit_info { | |
20b0b53a | 275 | struct genl_split_ops op; |
9272af10 | 276 | struct genl_info info; |
0b588afd JK |
277 | }; |
278 | ||
279 | static inline const struct genl_dumpit_info * | |
280 | genl_dumpit_info(struct netlink_callback *cb) | |
281 | { | |
282 | return cb->data; | |
283 | } | |
284 | ||
9272af10 JK |
285 | static inline const struct genl_info * |
286 | genl_info_dump(struct netlink_callback *cb) | |
287 | { | |
288 | return &genl_dumpit_info(cb)->info; | |
289 | } | |
290 | ||
5aa51d9f JK |
291 | /** |
292 | * genl_info_init_ntf() - initialize genl_info for notifications | |
293 | * @info: genl_info struct to set up | |
294 | * @family: pointer to the genetlink family | |
295 | * @cmd: command to be used in the notification | |
296 | * | |
297 | * Initialize a locally declared struct genl_info to pass to various APIs. | |
298 | * Intended to be used when creating notifications. | |
299 | */ | |
300 | static inline void | |
301 | genl_info_init_ntf(struct genl_info *info, const struct genl_family *family, | |
302 | u8 cmd) | |
303 | { | |
304 | struct genlmsghdr *hdr = (void *) &info->user_ptr[0]; | |
305 | ||
306 | memset(info, 0, sizeof(*info)); | |
307 | info->family = family; | |
308 | info->genlhdr = hdr; | |
309 | hdr->cmd = cmd; | |
310 | } | |
311 | ||
312 | static inline bool genl_info_is_ntf(const struct genl_info *info) | |
313 | { | |
314 | return !info->nlhdr; | |
315 | } | |
316 | ||
a7311324 JP |
317 | void *__genl_sk_priv_get(struct genl_family *family, struct sock *sk); |
318 | void *genl_sk_priv_get(struct genl_family *family, struct sock *sk); | |
489111e5 | 319 | int genl_register_family(struct genl_family *family); |
2ae0f17d JB |
320 | int genl_unregister_family(const struct genl_family *family); |
321 | void genl_notify(const struct genl_family *family, struct sk_buff *skb, | |
92c14d9b | 322 | struct genl_info *info, u32 group, gfp_t flags); |
482a8524 | 323 | |
15e47304 | 324 | void *genlmsg_put(struct sk_buff *skb, u32 portid, u32 seq, |
2ae0f17d | 325 | const struct genl_family *family, int flags, u8 cmd); |
482a8524 | 326 | |
5aa51d9f JK |
327 | static inline void * |
328 | __genlmsg_iput(struct sk_buff *skb, const struct genl_info *info, int flags) | |
329 | { | |
330 | return genlmsg_put(skb, info->snd_portid, info->snd_seq, info->family, | |
331 | flags, info->genlhdr->cmd); | |
332 | } | |
333 | ||
334 | /** | |
335 | * genlmsg_iput - start genetlink message based on genl_info | |
336 | * @skb: skb in which message header will be placed | |
337 | * @info: genl_info as provided to do/dump handlers | |
338 | * | |
339 | * Convenience wrapper which starts a genetlink message based on | |
340 | * information in user request. @info should be either the struct passed | |
341 | * by genetlink core to do/dump handlers (when constructing replies to | |
342 | * such requests) or a struct initialized by genl_info_init_ntf() | |
343 | * when constructing notifications. | |
344 | * | |
345 | * Returns pointer to new genetlink header. | |
346 | */ | |
347 | static inline void * | |
348 | genlmsg_iput(struct sk_buff *skb, const struct genl_info *info) | |
349 | { | |
350 | return __genlmsg_iput(skb, info, 0); | |
351 | } | |
352 | ||
670dc283 JB |
353 | /** |
354 | * genlmsg_nlhdr - Obtain netlink header from user specified header | |
355 | * @user_hdr: user header as returned from genlmsg_put() | |
670dc283 JB |
356 | * |
357 | * Returns pointer to netlink header. | |
358 | */ | |
0a833c29 | 359 | static inline struct nlmsghdr *genlmsg_nlhdr(void *user_hdr) |
670dc283 JB |
360 | { |
361 | return (struct nlmsghdr *)((char *)user_hdr - | |
670dc283 JB |
362 | GENL_HDRLEN - |
363 | NLMSG_HDRLEN); | |
364 | } | |
365 | ||
7b1883ce | 366 | /** |
8cb08174 | 367 | * genlmsg_parse_deprecated - parse attributes of a genetlink message |
7b1883ce JS |
368 | * @nlh: netlink message header |
369 | * @family: genetlink message family | |
370 | * @tb: destination array with maxtype+1 elements | |
371 | * @maxtype: maximum attribute type to be expected | |
372 | * @policy: validation policy | |
fceb6435 JB |
373 | * @extack: extended ACK report struct |
374 | */ | |
8cb08174 JB |
375 | static inline int genlmsg_parse_deprecated(const struct nlmsghdr *nlh, |
376 | const struct genl_family *family, | |
377 | struct nlattr *tb[], int maxtype, | |
378 | const struct nla_policy *policy, | |
379 | struct netlink_ext_ack *extack) | |
7b1883ce | 380 | { |
8cb08174 JB |
381 | return __nlmsg_parse(nlh, family->hdrsize + GENL_HDRLEN, tb, maxtype, |
382 | policy, NL_VALIDATE_LIBERAL, extack); | |
7b1883ce JS |
383 | } |
384 | ||
3de64403 JB |
385 | /** |
386 | * genlmsg_parse - parse attributes of a genetlink message | |
387 | * @nlh: netlink message header | |
388 | * @family: genetlink message family | |
389 | * @tb: destination array with maxtype+1 elements | |
390 | * @maxtype: maximum attribute type to be expected | |
391 | * @policy: validation policy | |
392 | * @extack: extended ACK report struct | |
393 | */ | |
394 | static inline int genlmsg_parse(const struct nlmsghdr *nlh, | |
395 | const struct genl_family *family, | |
396 | struct nlattr *tb[], int maxtype, | |
397 | const struct nla_policy *policy, | |
398 | struct netlink_ext_ack *extack) | |
399 | { | |
400 | return __nlmsg_parse(nlh, family->hdrsize + GENL_HDRLEN, tb, maxtype, | |
401 | policy, NL_VALIDATE_STRICT, extack); | |
402 | } | |
403 | ||
670dc283 JB |
404 | /** |
405 | * genl_dump_check_consistent - check if sequence is consistent and advertise if not | |
406 | * @cb: netlink callback structure that stores the sequence number | |
407 | * @user_hdr: user header as returned from genlmsg_put() | |
670dc283 JB |
408 | * |
409 | * Cf. nl_dump_check_consistent(), this just provides a wrapper to make it | |
410 | * simpler to use with generic netlink. | |
411 | */ | |
412 | static inline void genl_dump_check_consistent(struct netlink_callback *cb, | |
0a833c29 | 413 | void *user_hdr) |
670dc283 | 414 | { |
0a833c29 | 415 | nl_dump_check_consistent(cb, genlmsg_nlhdr(user_hdr)); |
670dc283 JB |
416 | } |
417 | ||
17c157c8 TG |
418 | /** |
419 | * genlmsg_put_reply - Add generic netlink header to a reply message | |
420 | * @skb: socket buffer holding the message | |
421 | * @info: receiver info | |
422 | * @family: generic netlink family | |
423 | * @flags: netlink message flags | |
424 | * @cmd: generic netlink command | |
425 | * | |
426 | * Returns pointer to user specific header | |
427 | */ | |
428 | static inline void *genlmsg_put_reply(struct sk_buff *skb, | |
429 | struct genl_info *info, | |
2ae0f17d | 430 | const struct genl_family *family, |
17c157c8 TG |
431 | int flags, u8 cmd) |
432 | { | |
15e47304 | 433 | return genlmsg_put(skb, info->snd_portid, info->snd_seq, family, |
17c157c8 TG |
434 | flags, cmd); |
435 | } | |
436 | ||
482a8524 TG |
437 | /** |
438 | * genlmsg_end - Finalize a generic netlink message | |
439 | * @skb: socket buffer the message is stored in | |
440 | * @hdr: user specific header | |
441 | */ | |
053c095a | 442 | static inline void genlmsg_end(struct sk_buff *skb, void *hdr) |
482a8524 | 443 | { |
053c095a | 444 | nlmsg_end(skb, hdr - GENL_HDRLEN - NLMSG_HDRLEN); |
482a8524 TG |
445 | } |
446 | ||
447 | /** | |
448 | * genlmsg_cancel - Cancel construction of a generic netlink message | |
449 | * @skb: socket buffer the message is stored in | |
450 | * @hdr: generic netlink message header | |
451 | */ | |
bc3ed28c | 452 | static inline void genlmsg_cancel(struct sk_buff *skb, void *hdr) |
482a8524 | 453 | { |
38db9e1d JL |
454 | if (hdr) |
455 | nlmsg_cancel(skb, hdr - GENL_HDRLEN - NLMSG_HDRLEN); | |
482a8524 TG |
456 | } |
457 | ||
971b4ad8 JP |
458 | /** |
459 | * genlmsg_multicast_netns_filtered - multicast a netlink message | |
460 | * to a specific netns with filter | |
461 | * function | |
462 | * @family: the generic netlink family | |
463 | * @net: the net namespace | |
464 | * @skb: netlink message as socket buffer | |
465 | * @portid: own netlink portid to avoid sending to yourself | |
466 | * @group: offset of multicast group in groups array | |
467 | * @flags: allocation flags | |
468 | * @filter: filter function | |
469 | * @filter_data: filter function private data | |
470 | * | |
471 | * Return: 0 on success, negative error code for failure. | |
472 | */ | |
473 | static inline int | |
474 | genlmsg_multicast_netns_filtered(const struct genl_family *family, | |
475 | struct net *net, struct sk_buff *skb, | |
476 | u32 portid, unsigned int group, gfp_t flags, | |
477 | netlink_filter_fn filter, | |
478 | void *filter_data) | |
479 | { | |
480 | if (WARN_ON_ONCE(group >= family->n_mcgrps)) | |
481 | return -EINVAL; | |
482 | group = family->mcgrp_offset + group; | |
483 | return nlmsg_multicast_filtered(net->genl_sock, skb, portid, group, | |
484 | flags, filter, filter_data); | |
485 | } | |
486 | ||
482a8524 | 487 | /** |
134e6375 | 488 | * genlmsg_multicast_netns - multicast a netlink message to a specific netns |
68eb5503 | 489 | * @family: the generic netlink family |
134e6375 JB |
490 | * @net: the net namespace |
491 | * @skb: netlink message as socket buffer | |
15e47304 | 492 | * @portid: own netlink portid to avoid sending to yourself |
2a94fe48 | 493 | * @group: offset of multicast group in groups array |
134e6375 JB |
494 | * @flags: allocation flags |
495 | */ | |
2ae0f17d | 496 | static inline int genlmsg_multicast_netns(const struct genl_family *family, |
68eb5503 | 497 | struct net *net, struct sk_buff *skb, |
15e47304 | 498 | u32 portid, unsigned int group, gfp_t flags) |
134e6375 | 499 | { |
971b4ad8 JP |
500 | return genlmsg_multicast_netns_filtered(family, net, skb, portid, |
501 | group, flags, NULL, NULL); | |
134e6375 JB |
502 | } |
503 | ||
504 | /** | |
505 | * genlmsg_multicast - multicast a netlink message to the default netns | |
68eb5503 | 506 | * @family: the generic netlink family |
482a8524 | 507 | * @skb: netlink message as socket buffer |
15e47304 | 508 | * @portid: own netlink portid to avoid sending to yourself |
2a94fe48 | 509 | * @group: offset of multicast group in groups array |
d387f6ad | 510 | * @flags: allocation flags |
482a8524 | 511 | */ |
2ae0f17d | 512 | static inline int genlmsg_multicast(const struct genl_family *family, |
68eb5503 | 513 | struct sk_buff *skb, u32 portid, |
d387f6ad | 514 | unsigned int group, gfp_t flags) |
482a8524 | 515 | { |
68eb5503 JB |
516 | return genlmsg_multicast_netns(family, &init_net, skb, |
517 | portid, group, flags); | |
482a8524 TG |
518 | } |
519 | ||
134e6375 JB |
520 | /** |
521 | * genlmsg_multicast_allns - multicast a netlink message to all net namespaces | |
68eb5503 | 522 | * @family: the generic netlink family |
134e6375 | 523 | * @skb: netlink message as socket buffer |
15e47304 | 524 | * @portid: own netlink portid to avoid sending to yourself |
2a94fe48 | 525 | * @group: offset of multicast group in groups array |
134e6375 JB |
526 | * @flags: allocation flags |
527 | * | |
528 | * This function must hold the RTNL or rcu_read_lock(). | |
529 | */ | |
2ae0f17d | 530 | int genlmsg_multicast_allns(const struct genl_family *family, |
68eb5503 | 531 | struct sk_buff *skb, u32 portid, |
134e6375 JB |
532 | unsigned int group, gfp_t flags); |
533 | ||
482a8524 TG |
534 | /** |
535 | * genlmsg_unicast - unicast a netlink message | |
a1a824f4 | 536 | * @net: network namespace to look up @portid in |
482a8524 | 537 | * @skb: netlink message as socket buffer |
15e47304 | 538 | * @portid: netlink portid of the destination socket |
482a8524 | 539 | */ |
15e47304 | 540 | static inline int genlmsg_unicast(struct net *net, struct sk_buff *skb, u32 portid) |
482a8524 | 541 | { |
15e47304 | 542 | return nlmsg_unicast(net->genl_sock, skb, portid); |
482a8524 TG |
543 | } |
544 | ||
81878d27 TG |
545 | /** |
546 | * genlmsg_reply - reply to a request | |
547 | * @skb: netlink message to be sent back | |
548 | * @info: receiver information | |
549 | */ | |
550 | static inline int genlmsg_reply(struct sk_buff *skb, struct genl_info *info) | |
551 | { | |
15e47304 | 552 | return genlmsg_unicast(genl_info_net(info), skb, info->snd_portid); |
81878d27 TG |
553 | } |
554 | ||
fb0ba6bd | 555 | /** |
a1a824f4 | 556 | * genlmsg_data - head of message payload |
70f23fd6 | 557 | * @gnlh: genetlink message header |
fb0ba6bd BS |
558 | */ |
559 | static inline void *genlmsg_data(const struct genlmsghdr *gnlh) | |
560 | { | |
561 | return ((unsigned char *) gnlh + GENL_HDRLEN); | |
562 | } | |
563 | ||
564 | /** | |
565 | * genlmsg_len - length of message payload | |
566 | * @gnlh: genetlink message header | |
567 | */ | |
568 | static inline int genlmsg_len(const struct genlmsghdr *gnlh) | |
569 | { | |
570 | struct nlmsghdr *nlh = (struct nlmsghdr *)((unsigned char *)gnlh - | |
571 | NLMSG_HDRLEN); | |
572 | return (nlh->nlmsg_len - GENL_HDRLEN - NLMSG_HDRLEN); | |
573 | } | |
574 | ||
17db952c BS |
575 | /** |
576 | * genlmsg_msg_size - length of genetlink message not including padding | |
577 | * @payload: length of message payload | |
578 | */ | |
579 | static inline int genlmsg_msg_size(int payload) | |
580 | { | |
581 | return GENL_HDRLEN + payload; | |
582 | } | |
583 | ||
584 | /** | |
585 | * genlmsg_total_size - length of genetlink message including padding | |
586 | * @payload: length of message payload | |
587 | */ | |
588 | static inline int genlmsg_total_size(int payload) | |
589 | { | |
590 | return NLMSG_ALIGN(genlmsg_msg_size(payload)); | |
591 | } | |
592 | ||
3dabc715 TG |
593 | /** |
594 | * genlmsg_new - Allocate a new generic netlink message | |
595 | * @payload: size of the message payload | |
596 | * @flags: the type of memory to allocate. | |
597 | */ | |
598 | static inline struct sk_buff *genlmsg_new(size_t payload, gfp_t flags) | |
599 | { | |
600 | return nlmsg_new(genlmsg_total_size(payload), flags); | |
601 | } | |
602 | ||
62b68e99 JB |
603 | /** |
604 | * genl_set_err - report error to genetlink broadcast listeners | |
68eb5503 | 605 | * @family: the generic netlink family |
62b68e99 JB |
606 | * @net: the network namespace to report the error to |
607 | * @portid: the PORTID of a process that we want to skip (if any) | |
608 | * @group: the broadcast group that will notice the error | |
2a94fe48 | 609 | * (this is the offset of the multicast group in the groups array) |
62b68e99 JB |
610 | * @code: error code, must be negative (as usual in kernelspace) |
611 | * | |
612 | * This function returns the number of broadcast listeners that have set the | |
613 | * NETLINK_RECV_NO_ENOBUFS socket option. | |
614 | */ | |
2ae0f17d JB |
615 | static inline int genl_set_err(const struct genl_family *family, |
616 | struct net *net, u32 portid, | |
617 | u32 group, int code) | |
62b68e99 | 618 | { |
91398a09 JB |
619 | if (WARN_ON_ONCE(group >= family->n_mcgrps)) |
620 | return -EINVAL; | |
621 | group = family->mcgrp_offset + group; | |
62b68e99 JB |
622 | return netlink_set_err(net->genl_sock, portid, group, code); |
623 | } | |
3dabc715 | 624 | |
2ae0f17d | 625 | static inline int genl_has_listeners(const struct genl_family *family, |
f8403a2e | 626 | struct net *net, unsigned int group) |
0d566379 ND |
627 | { |
628 | if (WARN_ON_ONCE(group >= family->n_mcgrps)) | |
629 | return -EINVAL; | |
630 | group = family->mcgrp_offset + group; | |
f8403a2e | 631 | return netlink_has_listeners(net->genl_sock, group); |
0d566379 | 632 | } |
482a8524 | 633 | #endif /* __NET_GENERIC_NETLINK_H */ |