]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - net/netlink/genetlink.c
Merge remote-tracking branches 'asoc/topic/adsp', 'asoc/topic/ak4613', 'asoc/topic...
[mirror_ubuntu-bionic-kernel.git] / net / netlink / genetlink.c
CommitLineData
482a8524
TG
1/*
2 * NETLINK Generic Netlink Family
3 *
4 * Authors: Jamal Hadi Salim
5 * Thomas Graf <tgraf@suug.ch>
2dbba6f7 6 * Johannes Berg <johannes@sipsolutions.net>
482a8524
TG
7 */
8
482a8524
TG
9#include <linux/module.h>
10#include <linux/kernel.h>
5a0e3ad6 11#include <linux/slab.h>
482a8524
TG
12#include <linux/errno.h>
13#include <linux/types.h>
14#include <linux/socket.h>
15#include <linux/string.h>
16#include <linux/skbuff.h>
14cc3e2b 17#include <linux/mutex.h>
2dbba6f7 18#include <linux/bitmap.h>
def31174 19#include <linux/rwsem.h>
2ae0f17d 20#include <linux/idr.h>
482a8524
TG
21#include <net/sock.h>
22#include <net/genetlink.h>
23
14cc3e2b 24static DEFINE_MUTEX(genl_mutex); /* serialization of message processing */
def31174 25static DECLARE_RWSEM(cb_lock);
482a8524 26
ee1c2442
JB
27atomic_t genl_sk_destructing_cnt = ATOMIC_INIT(0);
28DECLARE_WAIT_QUEUE_HEAD(genl_sk_destructing_waitq);
29
f408e0ce 30void genl_lock(void)
482a8524 31{
14cc3e2b 32 mutex_lock(&genl_mutex);
482a8524 33}
f408e0ce 34EXPORT_SYMBOL(genl_lock);
482a8524 35
f408e0ce 36void genl_unlock(void)
482a8524 37{
14cc3e2b 38 mutex_unlock(&genl_mutex);
482a8524 39}
f408e0ce 40EXPORT_SYMBOL(genl_unlock);
482a8524 41
320f5ea0 42#ifdef CONFIG_LOCKDEP
61d03535 43bool lockdep_genl_is_held(void)
86b1309c
PS
44{
45 return lockdep_is_held(&genl_mutex);
46}
47EXPORT_SYMBOL(lockdep_genl_is_held);
48#endif
49
def31174
PS
50static void genl_lock_all(void)
51{
52 down_write(&cb_lock);
53 genl_lock();
54}
55
56static void genl_unlock_all(void)
57{
58 genl_unlock();
59 up_write(&cb_lock);
60}
61
2ae0f17d 62static DEFINE_IDR(genl_fam_idr);
482a8524 63
2dbba6f7
JB
64/*
65 * Bitmap of multicast groups that are currently in use.
66 *
67 * To avoid an allocation at boot of just one unsigned long,
68 * declare it global instead.
69 * Bit 0 is marked as already used since group 0 is invalid.
e5dcecba
JB
70 * Bit 1 is marked as already used since the drop-monitor code
71 * abuses the API and thinks it can statically use group 1.
72 * That group will typically conflict with other groups that
73 * any proper users use.
2a94fe48
JB
74 * Bit 16 is marked as used since it's used for generic netlink
75 * and the code no longer marks pre-reserved IDs as used.
2ecf7536
JB
76 * Bit 17 is marked as already used since the VFS quota code
77 * also abused this API and relied on family == group ID, we
78 * cater to that by giving it a static family and group ID.
5e53e689
JB
79 * Bit 18 is marked as already used since the PMCRAID driver
80 * did the same thing as the VFS quota code (maybe copied?)
2dbba6f7 81 */
2a94fe48 82static unsigned long mc_group_start = 0x3 | BIT(GENL_ID_CTRL) |
5e53e689
JB
83 BIT(GENL_ID_VFS_DQUOT) |
84 BIT(GENL_ID_PMCRAID);
2dbba6f7
JB
85static unsigned long *mc_groups = &mc_group_start;
86static unsigned long mc_groups_longs = 1;
482a8524 87
2ae0f17d 88static int genl_ctrl_event(int event, const struct genl_family *family,
2a94fe48
JB
89 const struct genl_multicast_group *grp,
90 int grp_id);
482a8524 91
2ae0f17d 92static const struct genl_family *genl_family_find_byid(unsigned int id)
482a8524 93{
2ae0f17d 94 return idr_find(&genl_fam_idr, id);
482a8524
TG
95}
96
2ae0f17d 97static const struct genl_family *genl_family_find_byname(char *name)
482a8524 98{
2ae0f17d
JB
99 const struct genl_family *family;
100 unsigned int id;
482a8524 101
2ae0f17d
JB
102 idr_for_each_entry(&genl_fam_idr, family, id)
103 if (strcmp(family->name, name) == 0)
104 return family;
482a8524
TG
105
106 return NULL;
107}
108
2ae0f17d
JB
109static const struct genl_ops *genl_get_cmd(u8 cmd,
110 const struct genl_family *family)
482a8524 111{
d91824c0 112 int i;
482a8524 113
d91824c0
JB
114 for (i = 0; i < family->n_ops; i++)
115 if (family->ops[i].cmd == cmd)
116 return &family->ops[i];
482a8524
TG
117
118 return NULL;
119}
120
2a94fe48 121static int genl_allocate_reserve_groups(int n_groups, int *first_id)
2dbba6f7 122{
2dbba6f7 123 unsigned long *new_groups;
2a94fe48
JB
124 int start = 0;
125 int i;
126 int id;
127 bool fits;
128
129 do {
130 if (start == 0)
131 id = find_first_zero_bit(mc_groups,
132 mc_groups_longs *
133 BITS_PER_LONG);
134 else
135 id = find_next_zero_bit(mc_groups,
136 mc_groups_longs * BITS_PER_LONG,
137 start);
138
139 fits = true;
140 for (i = id;
141 i < min_t(int, id + n_groups,
142 mc_groups_longs * BITS_PER_LONG);
143 i++) {
144 if (test_bit(i, mc_groups)) {
145 start = i;
146 fits = false;
147 break;
148 }
149 }
2dbba6f7 150
b8e429a2 151 if (id + n_groups > mc_groups_longs * BITS_PER_LONG) {
2a94fe48
JB
152 unsigned long new_longs = mc_groups_longs +
153 BITS_TO_LONGS(n_groups);
154 size_t nlen = new_longs * sizeof(unsigned long);
155
156 if (mc_groups == &mc_group_start) {
157 new_groups = kzalloc(nlen, GFP_KERNEL);
158 if (!new_groups)
159 return -ENOMEM;
160 mc_groups = new_groups;
161 *mc_groups = mc_group_start;
162 } else {
163 new_groups = krealloc(mc_groups, nlen,
164 GFP_KERNEL);
165 if (!new_groups)
166 return -ENOMEM;
167 mc_groups = new_groups;
168 for (i = 0; i < BITS_TO_LONGS(n_groups); i++)
169 mc_groups[mc_groups_longs + i] = 0;
170 }
171 mc_groups_longs = new_longs;
172 }
173 } while (!fits);
2dbba6f7 174
2a94fe48
JB
175 for (i = id; i < id + n_groups; i++)
176 set_bit(i, mc_groups);
177 *first_id = id;
178 return 0;
179}
180
181static struct genl_family genl_ctrl;
182
183static int genl_validate_assign_mc_groups(struct genl_family *family)
184{
185 int first_id;
186 int n_groups = family->n_mcgrps;
0f0e2159 187 int err = 0, i;
2a94fe48
JB
188 bool groups_allocated = false;
189
190 if (!n_groups)
191 return 0;
192
193 for (i = 0; i < n_groups; i++) {
194 const struct genl_multicast_group *grp = &family->mcgrps[i];
195
196 if (WARN_ON(grp->name[0] == '\0'))
197 return -EINVAL;
198 if (WARN_ON(memchr(grp->name, '\0', GENL_NAMSIZ) == NULL))
199 return -EINVAL;
200 }
2dbba6f7 201
e5dcecba 202 /* special-case our own group and hacks */
2a94fe48
JB
203 if (family == &genl_ctrl) {
204 first_id = GENL_ID_CTRL;
205 BUG_ON(n_groups != 1);
206 } else if (strcmp(family->name, "NET_DM") == 0) {
207 first_id = 1;
208 BUG_ON(n_groups != 1);
5e53e689 209 } else if (family->id == GENL_ID_VFS_DQUOT) {
2a94fe48
JB
210 first_id = GENL_ID_VFS_DQUOT;
211 BUG_ON(n_groups != 1);
5e53e689
JB
212 } else if (family->id == GENL_ID_PMCRAID) {
213 first_id = GENL_ID_PMCRAID;
214 BUG_ON(n_groups != 1);
2a94fe48
JB
215 } else {
216 groups_allocated = true;
217 err = genl_allocate_reserve_groups(n_groups, &first_id);
218 if (err)
219 return err;
2dbba6f7
JB
220 }
221
2a94fe48
JB
222 family->mcgrp_offset = first_id;
223
224 /* if still initializing, can't and don't need to to realloc bitmaps */
225 if (!init_net.genl_sock)
226 return 0;
227
134e6375
JB
228 if (family->netnsok) {
229 struct net *net;
230
d136f1bd 231 netlink_table_grab();
134e6375
JB
232 rcu_read_lock();
233 for_each_net_rcu(net) {
d136f1bd 234 err = __netlink_change_ngroups(net->genl_sock,
134e6375
JB
235 mc_groups_longs * BITS_PER_LONG);
236 if (err) {
237 /*
238 * No need to roll back, can only fail if
239 * memory allocation fails and then the
240 * number of _possible_ groups has been
241 * increased on some sockets which is ok.
242 */
2a94fe48 243 break;
134e6375
JB
244 }
245 }
246 rcu_read_unlock();
d136f1bd 247 netlink_table_ungrab();
134e6375
JB
248 } else {
249 err = netlink_change_ngroups(init_net.genl_sock,
250 mc_groups_longs * BITS_PER_LONG);
134e6375 251 }
2dbba6f7 252
2a94fe48
JB
253 if (groups_allocated && err) {
254 for (i = 0; i < family->n_mcgrps; i++)
255 clear_bit(family->mcgrp_offset + i, mc_groups);
256 }
2dbba6f7 257
79d310d0 258 return err;
2dbba6f7 259}
2dbba6f7 260
2ae0f17d 261static void genl_unregister_mc_groups(const struct genl_family *family)
79dc4386 262{
134e6375 263 struct net *net;
2a94fe48 264 int i;
134e6375 265
b8273570 266 netlink_table_grab();
134e6375 267 rcu_read_lock();
2a94fe48
JB
268 for_each_net_rcu(net) {
269 for (i = 0; i < family->n_mcgrps; i++)
270 __netlink_clear_multicast_users(
271 net->genl_sock, family->mcgrp_offset + i);
272 }
134e6375 273 rcu_read_unlock();
b8273570 274 netlink_table_ungrab();
134e6375 275
2a94fe48
JB
276 for (i = 0; i < family->n_mcgrps; i++) {
277 int grp_id = family->mcgrp_offset + i;
2dbba6f7 278
2a94fe48
JB
279 if (grp_id != 1)
280 clear_bit(grp_id, mc_groups);
281 genl_ctrl_event(CTRL_CMD_DELMCAST_GRP, family,
282 &family->mcgrps[i], grp_id);
283 }
2dbba6f7
JB
284}
285
2f91abd4 286static int genl_validate_ops(const struct genl_family *family)
482a8524 287{
568508aa
JB
288 const struct genl_ops *ops = family->ops;
289 unsigned int n_ops = family->n_ops;
d91824c0
JB
290 int i, j;
291
568508aa
JB
292 if (WARN_ON(n_ops && !ops))
293 return -EINVAL;
294
295 if (!n_ops)
296 return 0;
297
d91824c0
JB
298 for (i = 0; i < n_ops; i++) {
299 if (ops[i].dumpit == NULL && ops[i].doit == NULL)
300 return -EINVAL;
301 for (j = i + 1; j < n_ops; j++)
302 if (ops[i].cmd == ops[j].cmd)
303 return -EINVAL;
482a8524
TG
304 }
305
d91824c0 306 return 0;
482a8524 307}
482a8524
TG
308
309/**
489111e5 310 * genl_register_family - register a generic netlink family
482a8524
TG
311 * @family: generic netlink family
312 *
313 * Registers the specified family after validating it first. Only one
314 * family may be registered with the same family name or identifier.
482a8524 315 *
489111e5
JB
316 * The family's ops, multicast groups and module pointer must already
317 * be assigned.
568508aa 318 *
482a8524
TG
319 * Return 0 on success or a negative error code.
320 */
489111e5 321int genl_register_family(struct genl_family *family)
482a8524 322{
a07ea4d9 323 int err, i;
2ae0f17d 324 int start = GENL_START_ALLOC, end = GENL_MAX_ID;
482a8524 325
568508aa
JB
326 err = genl_validate_ops(family);
327 if (err)
328 return err;
329
def31174 330 genl_lock_all();
482a8524
TG
331
332 if (genl_family_find_byname(family->name)) {
333 err = -EEXIST;
334 goto errout_locked;
335 }
336
2ae0f17d
JB
337 /*
338 * Sadly, a few cases need to be special-cased
339 * due to them having previously abused the API
340 * and having used their family ID also as their
341 * multicast group ID, so we use reserved IDs
342 * for both to be sure we can do that mapping.
343 */
a07ea4d9 344 if (family == &genl_ctrl) {
2ae0f17d
JB
345 /* and this needs to be special for initial family lookups */
346 start = end = GENL_ID_CTRL;
347 } else if (strcmp(family->name, "pmcraid") == 0) {
348 start = end = GENL_ID_PMCRAID;
349 } else if (strcmp(family->name, "VFS_DQUOT") == 0) {
350 start = end = GENL_ID_VFS_DQUOT;
482a8524
TG
351 }
352
def31174 353 if (family->maxattr && !family->parallel_ops) {
482a8524
TG
354 family->attrbuf = kmalloc((family->maxattr+1) *
355 sizeof(struct nlattr *), GFP_KERNEL);
356 if (family->attrbuf == NULL) {
357 err = -ENOMEM;
e200bd80 358 goto errout_locked;
482a8524
TG
359 }
360 } else
361 family->attrbuf = NULL;
362
2ae0f17d
JB
363 family->id = idr_alloc(&genl_fam_idr, family,
364 start, end + 1, GFP_KERNEL);
22ca904a
WY
365 if (family->id < 0) {
366 err = family->id;
2ae0f17d 367 goto errout_locked;
22ca904a 368 }
2ae0f17d 369
2a94fe48
JB
370 err = genl_validate_assign_mc_groups(family);
371 if (err)
2ae0f17d 372 goto errout_remove;
2a94fe48 373
def31174 374 genl_unlock_all();
482a8524 375
2a94fe48
JB
376 /* send all events */
377 genl_ctrl_event(CTRL_CMD_NEWFAMILY, family, NULL, 0);
378 for (i = 0; i < family->n_mcgrps; i++)
379 genl_ctrl_event(CTRL_CMD_NEWMCAST_GRP, family,
380 &family->mcgrps[i], family->mcgrp_offset + i);
482a8524
TG
381
382 return 0;
383
2ae0f17d
JB
384errout_remove:
385 idr_remove(&genl_fam_idr, family->id);
00ffc1ba 386 kfree(family->attrbuf);
482a8524 387errout_locked:
def31174 388 genl_unlock_all();
482a8524
TG
389 return err;
390}
489111e5 391EXPORT_SYMBOL(genl_register_family);
482a8524
TG
392
393/**
394 * genl_unregister_family - unregister generic netlink family
395 * @family: generic netlink family
396 *
397 * Unregisters the specified family.
398 *
399 * Returns 0 on success or a negative error code.
400 */
2ae0f17d 401int genl_unregister_family(const struct genl_family *family)
482a8524 402{
def31174 403 genl_lock_all();
482a8524 404
0e82c763 405 if (!genl_family_find_byid(family->id)) {
2ae0f17d
JB
406 genl_unlock_all();
407 return -ENOENT;
408 }
482a8524 409
2ae0f17d 410 genl_unregister_mc_groups(family);
ee1c2442 411
2ae0f17d 412 idr_remove(&genl_fam_idr, family->id);
482a8524 413
2ae0f17d
JB
414 up_write(&cb_lock);
415 wait_event(genl_sk_destructing_waitq,
416 atomic_read(&genl_sk_destructing_cnt) == 0);
417 genl_unlock();
482a8524 418
2ae0f17d 419 kfree(family->attrbuf);
482a8524 420
2ae0f17d
JB
421 genl_ctrl_event(CTRL_CMD_DELFAMILY, family, NULL, 0);
422
423 return 0;
482a8524 424}
416c2f9c 425EXPORT_SYMBOL(genl_unregister_family);
482a8524 426
a46621a3
DV
427/**
428 * genlmsg_put - Add generic netlink header to netlink message
429 * @skb: socket buffer holding the message
15e47304 430 * @portid: netlink portid the message is addressed to
a46621a3
DV
431 * @seq: sequence number (usually the one of the sender)
432 * @family: generic netlink family
2c53040f 433 * @flags: netlink message flags
a46621a3
DV
434 * @cmd: generic netlink command
435 *
436 * Returns pointer to user specific header
437 */
15e47304 438void *genlmsg_put(struct sk_buff *skb, u32 portid, u32 seq,
2ae0f17d 439 const struct genl_family *family, int flags, u8 cmd)
a46621a3
DV
440{
441 struct nlmsghdr *nlh;
442 struct genlmsghdr *hdr;
443
15e47304 444 nlh = nlmsg_put(skb, portid, seq, family->id, GENL_HDRLEN +
a46621a3
DV
445 family->hdrsize, flags);
446 if (nlh == NULL)
447 return NULL;
448
449 hdr = nlmsg_data(nlh);
450 hdr->cmd = cmd;
451 hdr->version = family->version;
452 hdr->reserved = 0;
453
454 return (char *) hdr + GENL_HDRLEN;
455}
456EXPORT_SYMBOL(genlmsg_put);
457
fc9e50f5
TH
458static int genl_lock_start(struct netlink_callback *cb)
459{
460 /* our ops are always const - netlink API doesn't propagate that */
461 const struct genl_ops *ops = cb->data;
462 int rc = 0;
463
464 if (ops->start) {
465 genl_lock();
466 rc = ops->start(cb);
467 genl_unlock();
468 }
469 return rc;
470}
471
9b96309c
PS
472static int genl_lock_dumpit(struct sk_buff *skb, struct netlink_callback *cb)
473{
f84f771d
JB
474 /* our ops are always const - netlink API doesn't propagate that */
475 const struct genl_ops *ops = cb->data;
9b96309c
PS
476 int rc;
477
478 genl_lock();
479 rc = ops->dumpit(skb, cb);
480 genl_unlock();
481 return rc;
482}
483
484static int genl_lock_done(struct netlink_callback *cb)
485{
f84f771d
JB
486 /* our ops are always const - netlink API doesn't propagate that */
487 const struct genl_ops *ops = cb->data;
9b96309c
PS
488 int rc = 0;
489
490 if (ops->done) {
491 genl_lock();
492 rc = ops->done(cb);
493 genl_unlock();
494 }
495 return rc;
496}
497
2ae0f17d 498static int genl_family_rcv_msg(const struct genl_family *family,
def31174
PS
499 struct sk_buff *skb,
500 struct nlmsghdr *nlh)
482a8524 501{
f84f771d 502 const struct genl_ops *ops;
134e6375 503 struct net *net = sock_net(skb->sk);
482a8524
TG
504 struct genl_info info;
505 struct genlmsghdr *hdr = nlmsg_data(nlh);
def31174 506 struct nlattr **attrbuf;
1d00a4eb 507 int hdrlen, err;
482a8524 508
134e6375
JB
509 /* this family doesn't exist in this netns */
510 if (!family->netnsok && !net_eq(net, &init_net))
511 return -ENOENT;
512
482a8524
TG
513 hdrlen = GENL_HDRLEN + family->hdrsize;
514 if (nlh->nlmsg_len < nlmsg_msg_size(hdrlen))
1d00a4eb 515 return -EINVAL;
482a8524
TG
516
517 ops = genl_get_cmd(hdr->cmd, family);
1d00a4eb
TG
518 if (ops == NULL)
519 return -EOPNOTSUPP;
482a8524 520
1d00a4eb 521 if ((ops->flags & GENL_ADMIN_PERM) &&
90f62cf3 522 !netlink_capable(skb, CAP_NET_ADMIN))
1d00a4eb 523 return -EPERM;
482a8524 524
4a92602a
TA
525 if ((ops->flags & GENL_UNS_ADMIN_PERM) &&
526 !netlink_ns_capable(skb, net->user_ns, CAP_NET_ADMIN))
527 return -EPERM;
528
e1ee3673 529 if ((nlh->nlmsg_flags & NLM_F_DUMP) == NLM_F_DUMP) {
9b96309c 530 int rc;
def31174 531
1d00a4eb
TG
532 if (ops->dumpit == NULL)
533 return -EOPNOTSUPP;
482a8524 534
9b96309c
PS
535 if (!family->parallel_ops) {
536 struct netlink_dump_control c = {
33c6b1f6 537 .module = family->module,
f84f771d
JB
538 /* we have const, but the netlink API doesn't */
539 .data = (void *)ops,
fc9e50f5 540 .start = genl_lock_start,
9b96309c
PS
541 .dump = genl_lock_dumpit,
542 .done = genl_lock_done,
543 };
544
545 genl_unlock();
33c6b1f6 546 rc = __netlink_dump_start(net->genl_sock, skb, nlh, &c);
9b96309c
PS
547 genl_lock();
548
549 } else {
550 struct netlink_dump_control c = {
33c6b1f6 551 .module = family->module,
fc9e50f5 552 .start = ops->start,
9b96309c
PS
553 .dump = ops->dumpit,
554 .done = ops->done,
555 };
556
33c6b1f6 557 rc = __netlink_dump_start(net->genl_sock, skb, nlh, &c);
9b96309c
PS
558 }
559
560 return rc;
482a8524
TG
561 }
562
1d00a4eb
TG
563 if (ops->doit == NULL)
564 return -EOPNOTSUPP;
482a8524 565
def31174
PS
566 if (family->maxattr && family->parallel_ops) {
567 attrbuf = kmalloc((family->maxattr+1) *
568 sizeof(struct nlattr *), GFP_KERNEL);
569 if (attrbuf == NULL)
570 return -ENOMEM;
571 } else
572 attrbuf = family->attrbuf;
573
574 if (attrbuf) {
575 err = nlmsg_parse(nlh, hdrlen, attrbuf, family->maxattr,
482a8524
TG
576 ops->policy);
577 if (err < 0)
50754d21 578 goto out;
482a8524
TG
579 }
580
581 info.snd_seq = nlh->nlmsg_seq;
15e47304 582 info.snd_portid = NETLINK_CB(skb).portid;
482a8524
TG
583 info.nlhdr = nlh;
584 info.genlhdr = nlmsg_data(nlh);
585 info.userhdr = nlmsg_data(nlh) + GENL_HDRLEN;
def31174 586 info.attrs = attrbuf;
134e6375 587 genl_info_net_set(&info, net);
ff4c92d8 588 memset(&info.user_ptr, 0, sizeof(info.user_ptr));
482a8524 589
ff4c92d8
JB
590 if (family->pre_doit) {
591 err = family->pre_doit(ops, skb, &info);
592 if (err)
50754d21 593 goto out;
ff4c92d8
JB
594 }
595
596 err = ops->doit(skb, &info);
597
598 if (family->post_doit)
599 family->post_doit(ops, skb, &info);
600
50754d21 601out:
def31174
PS
602 if (family->parallel_ops)
603 kfree(attrbuf);
604
605 return err;
606}
607
608static int genl_rcv_msg(struct sk_buff *skb, struct nlmsghdr *nlh)
609{
2ae0f17d 610 const struct genl_family *family;
def31174
PS
611 int err;
612
613 family = genl_family_find_byid(nlh->nlmsg_type);
614 if (family == NULL)
615 return -ENOENT;
616
617 if (!family->parallel_ops)
618 genl_lock();
619
620 err = genl_family_rcv_msg(family, skb, nlh);
621
622 if (!family->parallel_ops)
623 genl_unlock();
624
ff4c92d8 625 return err;
482a8524
TG
626}
627
cd40b7d3 628static void genl_rcv(struct sk_buff *skb)
482a8524 629{
def31174 630 down_read(&cb_lock);
cd40b7d3 631 netlink_rcv_skb(skb, &genl_rcv_msg);
def31174 632 up_read(&cb_lock);
482a8524
TG
633}
634
635/**************************************************************************
636 * Controller
637 **************************************************************************/
638
489111e5 639static struct genl_family genl_ctrl;
17c157c8 640
2ae0f17d 641static int ctrl_fill_info(const struct genl_family *family, u32 portid, u32 seq,
482a8524
TG
642 u32 flags, struct sk_buff *skb, u8 cmd)
643{
644 void *hdr;
645
15e47304 646 hdr = genlmsg_put(skb, portid, seq, &genl_ctrl, flags, cmd);
482a8524
TG
647 if (hdr == NULL)
648 return -1;
649
444653f6
DM
650 if (nla_put_string(skb, CTRL_ATTR_FAMILY_NAME, family->name) ||
651 nla_put_u16(skb, CTRL_ATTR_FAMILY_ID, family->id) ||
652 nla_put_u32(skb, CTRL_ATTR_VERSION, family->version) ||
653 nla_put_u32(skb, CTRL_ATTR_HDRSIZE, family->hdrsize) ||
654 nla_put_u32(skb, CTRL_ATTR_MAXATTR, family->maxattr))
655 goto nla_put_failure;
eb328111 656
d91824c0 657 if (family->n_ops) {
e94ef682 658 struct nlattr *nla_ops;
d91824c0 659 int i;
eb328111 660
e94ef682
TG
661 nla_ops = nla_nest_start(skb, CTRL_ATTR_OPS);
662 if (nla_ops == NULL)
eb328111
TG
663 goto nla_put_failure;
664
d91824c0 665 for (i = 0; i < family->n_ops; i++) {
e94ef682 666 struct nlattr *nest;
f84f771d 667 const struct genl_ops *ops = &family->ops[i];
029b234f 668 u32 op_flags = ops->flags;
f84f771d
JB
669
670 if (ops->dumpit)
029b234f 671 op_flags |= GENL_CMD_CAP_DUMP;
f84f771d 672 if (ops->doit)
029b234f 673 op_flags |= GENL_CMD_CAP_DO;
f84f771d 674 if (ops->policy)
029b234f 675 op_flags |= GENL_CMD_CAP_HASPOL;
eb328111 676
d91824c0 677 nest = nla_nest_start(skb, i + 1);
e94ef682
TG
678 if (nest == NULL)
679 goto nla_put_failure;
eb328111 680
444653f6 681 if (nla_put_u32(skb, CTRL_ATTR_OP_ID, ops->cmd) ||
029b234f 682 nla_put_u32(skb, CTRL_ATTR_OP_FLAGS, op_flags))
444653f6 683 goto nla_put_failure;
eb328111 684
e94ef682
TG
685 nla_nest_end(skb, nest);
686 }
687
688 nla_nest_end(skb, nla_ops);
689 }
482a8524 690
2a94fe48 691 if (family->n_mcgrps) {
2dbba6f7 692 struct nlattr *nla_grps;
2a94fe48 693 int i;
2dbba6f7
JB
694
695 nla_grps = nla_nest_start(skb, CTRL_ATTR_MCAST_GROUPS);
696 if (nla_grps == NULL)
697 goto nla_put_failure;
698
2a94fe48 699 for (i = 0; i < family->n_mcgrps; i++) {
2dbba6f7 700 struct nlattr *nest;
2a94fe48 701 const struct genl_multicast_group *grp;
2dbba6f7 702
2a94fe48
JB
703 grp = &family->mcgrps[i];
704
705 nest = nla_nest_start(skb, i + 1);
2dbba6f7
JB
706 if (nest == NULL)
707 goto nla_put_failure;
708
2a94fe48
JB
709 if (nla_put_u32(skb, CTRL_ATTR_MCAST_GRP_ID,
710 family->mcgrp_offset + i) ||
444653f6
DM
711 nla_put_string(skb, CTRL_ATTR_MCAST_GRP_NAME,
712 grp->name))
713 goto nla_put_failure;
2dbba6f7
JB
714
715 nla_nest_end(skb, nest);
716 }
717 nla_nest_end(skb, nla_grps);
718 }
719
053c095a
JB
720 genlmsg_end(skb, hdr);
721 return 0;
2dbba6f7
JB
722
723nla_put_failure:
bc3ed28c
TG
724 genlmsg_cancel(skb, hdr);
725 return -EMSGSIZE;
2dbba6f7
JB
726}
727
2ae0f17d 728static int ctrl_fill_mcgrp_info(const struct genl_family *family,
2a94fe48
JB
729 const struct genl_multicast_group *grp,
730 int grp_id, u32 portid, u32 seq, u32 flags,
731 struct sk_buff *skb, u8 cmd)
2dbba6f7
JB
732{
733 void *hdr;
734 struct nlattr *nla_grps;
735 struct nlattr *nest;
736
15e47304 737 hdr = genlmsg_put(skb, portid, seq, &genl_ctrl, flags, cmd);
2dbba6f7
JB
738 if (hdr == NULL)
739 return -1;
740
c2ebb908
JB
741 if (nla_put_string(skb, CTRL_ATTR_FAMILY_NAME, family->name) ||
742 nla_put_u16(skb, CTRL_ATTR_FAMILY_ID, family->id))
444653f6 743 goto nla_put_failure;
2dbba6f7
JB
744
745 nla_grps = nla_nest_start(skb, CTRL_ATTR_MCAST_GROUPS);
746 if (nla_grps == NULL)
747 goto nla_put_failure;
748
749 nest = nla_nest_start(skb, 1);
750 if (nest == NULL)
751 goto nla_put_failure;
752
2a94fe48 753 if (nla_put_u32(skb, CTRL_ATTR_MCAST_GRP_ID, grp_id) ||
444653f6
DM
754 nla_put_string(skb, CTRL_ATTR_MCAST_GRP_NAME,
755 grp->name))
756 goto nla_put_failure;
2dbba6f7
JB
757
758 nla_nest_end(skb, nest);
759 nla_nest_end(skb, nla_grps);
760
053c095a
JB
761 genlmsg_end(skb, hdr);
762 return 0;
482a8524
TG
763
764nla_put_failure:
bc3ed28c
TG
765 genlmsg_cancel(skb, hdr);
766 return -EMSGSIZE;
482a8524
TG
767}
768
769static int ctrl_dumpfamily(struct sk_buff *skb, struct netlink_callback *cb)
770{
2ae0f17d 771 int n = 0;
482a8524 772 struct genl_family *rt;
134e6375 773 struct net *net = sock_net(skb->sk);
2ae0f17d
JB
774 int fams_to_skip = cb->args[0];
775 unsigned int id;
482a8524 776
2ae0f17d
JB
777 idr_for_each_entry(&genl_fam_idr, rt, id) {
778 if (!rt->netnsok && !net_eq(net, &init_net))
779 continue;
780
781 if (n++ < fams_to_skip)
782 continue;
482a8524 783
2ae0f17d
JB
784 if (ctrl_fill_info(rt, NETLINK_CB(cb->skb).portid,
785 cb->nlh->nlmsg_seq, NLM_F_MULTI,
1d2a6a5e
SG
786 skb, CTRL_CMD_NEWFAMILY) < 0) {
787 n--;
2ae0f17d 788 break;
1d2a6a5e 789 }
2ae0f17d 790 }
482a8524 791
2ae0f17d 792 cb->args[0] = n;
482a8524
TG
793 return skb->len;
794}
795
2ae0f17d 796static struct sk_buff *ctrl_build_family_msg(const struct genl_family *family,
15e47304 797 u32 portid, int seq, u8 cmd)
482a8524
TG
798{
799 struct sk_buff *skb;
800 int err;
801
339bf98f 802 skb = nlmsg_new(NLMSG_DEFAULT_SIZE, GFP_KERNEL);
482a8524
TG
803 if (skb == NULL)
804 return ERR_PTR(-ENOBUFS);
805
15e47304 806 err = ctrl_fill_info(family, portid, seq, 0, skb, cmd);
482a8524
TG
807 if (err < 0) {
808 nlmsg_free(skb);
809 return ERR_PTR(err);
810 }
811
812 return skb;
813}
814
2a94fe48 815static struct sk_buff *
2ae0f17d 816ctrl_build_mcgrp_msg(const struct genl_family *family,
2a94fe48
JB
817 const struct genl_multicast_group *grp,
818 int grp_id, u32 portid, int seq, u8 cmd)
2dbba6f7
JB
819{
820 struct sk_buff *skb;
821 int err;
822
823 skb = nlmsg_new(NLMSG_DEFAULT_SIZE, GFP_KERNEL);
824 if (skb == NULL)
825 return ERR_PTR(-ENOBUFS);
826
2a94fe48
JB
827 err = ctrl_fill_mcgrp_info(family, grp, grp_id, portid,
828 seq, 0, skb, cmd);
2dbba6f7
JB
829 if (err < 0) {
830 nlmsg_free(skb);
831 return ERR_PTR(err);
832 }
833
834 return skb;
835}
836
ef7c79ed 837static const struct nla_policy ctrl_policy[CTRL_ATTR_MAX+1] = {
482a8524 838 [CTRL_ATTR_FAMILY_ID] = { .type = NLA_U16 },
5176f91e
TG
839 [CTRL_ATTR_FAMILY_NAME] = { .type = NLA_NUL_STRING,
840 .len = GENL_NAMSIZ - 1 },
482a8524
TG
841};
842
843static int ctrl_getfamily(struct sk_buff *skb, struct genl_info *info)
844{
845 struct sk_buff *msg;
2ae0f17d 846 const struct genl_family *res = NULL;
482a8524
TG
847 int err = -EINVAL;
848
849 if (info->attrs[CTRL_ATTR_FAMILY_ID]) {
850 u16 id = nla_get_u16(info->attrs[CTRL_ATTR_FAMILY_ID]);
851 res = genl_family_find_byid(id);
134e6375 852 err = -ENOENT;
482a8524
TG
853 }
854
855 if (info->attrs[CTRL_ATTR_FAMILY_NAME]) {
5176f91e 856 char *name;
482a8524 857
5176f91e 858 name = nla_data(info->attrs[CTRL_ATTR_FAMILY_NAME]);
482a8524 859 res = genl_family_find_byname(name);
fa843095
SH
860#ifdef CONFIG_MODULES
861 if (res == NULL) {
862 genl_unlock();
c74f2b26 863 up_read(&cb_lock);
e9412c37 864 request_module("net-pf-%d-proto-%d-family-%s",
fa843095 865 PF_NETLINK, NETLINK_GENERIC, name);
c74f2b26 866 down_read(&cb_lock);
fa843095
SH
867 genl_lock();
868 res = genl_family_find_byname(name);
869 }
870#endif
134e6375 871 err = -ENOENT;
482a8524
TG
872 }
873
134e6375
JB
874 if (res == NULL)
875 return err;
876
877 if (!res->netnsok && !net_eq(genl_info_net(info), &init_net)) {
878 /* family doesn't exist here */
879 return -ENOENT;
482a8524
TG
880 }
881
15e47304 882 msg = ctrl_build_family_msg(res, info->snd_portid, info->snd_seq,
2dbba6f7 883 CTRL_CMD_NEWFAMILY);
134e6375
JB
884 if (IS_ERR(msg))
885 return PTR_ERR(msg);
482a8524 886
134e6375 887 return genlmsg_reply(msg, info);
482a8524
TG
888}
889
2ae0f17d 890static int genl_ctrl_event(int event, const struct genl_family *family,
2a94fe48
JB
891 const struct genl_multicast_group *grp,
892 int grp_id)
482a8524
TG
893{
894 struct sk_buff *msg;
895
134e6375
JB
896 /* genl is still initialising */
897 if (!init_net.genl_sock)
482a8524
TG
898 return 0;
899
900 switch (event) {
901 case CTRL_CMD_NEWFAMILY:
902 case CTRL_CMD_DELFAMILY:
c2ebb908 903 WARN_ON(grp);
134e6375 904 msg = ctrl_build_family_msg(family, 0, 0, event);
2dbba6f7
JB
905 break;
906 case CTRL_CMD_NEWMCAST_GRP:
907 case CTRL_CMD_DELMCAST_GRP:
c2ebb908 908 BUG_ON(!grp);
2a94fe48 909 msg = ctrl_build_mcgrp_msg(family, grp, grp_id, 0, 0, event);
482a8524 910 break;
134e6375
JB
911 default:
912 return -EINVAL;
913 }
914
915 if (IS_ERR(msg))
916 return PTR_ERR(msg);
917
918 if (!family->netnsok) {
68eb5503 919 genlmsg_multicast_netns(&genl_ctrl, &init_net, msg, 0,
2a94fe48 920 0, GFP_KERNEL);
134e6375
JB
921 } else {
922 rcu_read_lock();
68eb5503 923 genlmsg_multicast_allns(&genl_ctrl, msg, 0,
2a94fe48 924 0, GFP_ATOMIC);
134e6375 925 rcu_read_unlock();
482a8524
TG
926 }
927
928 return 0;
929}
930
12d8de6d 931static const struct genl_ops genl_ctrl_ops[] = {
c53ed742
JB
932 {
933 .cmd = CTRL_CMD_GETFAMILY,
934 .doit = ctrl_getfamily,
935 .dumpit = ctrl_dumpfamily,
936 .policy = ctrl_policy,
937 },
482a8524
TG
938};
939
12d8de6d 940static const struct genl_multicast_group genl_ctrl_groups[] = {
2a94fe48 941 { .name = "notify", },
2dbba6f7
JB
942};
943
56989f6d 944static struct genl_family genl_ctrl __ro_after_init = {
489111e5
JB
945 .module = THIS_MODULE,
946 .ops = genl_ctrl_ops,
947 .n_ops = ARRAY_SIZE(genl_ctrl_ops),
948 .mcgrps = genl_ctrl_groups,
949 .n_mcgrps = ARRAY_SIZE(genl_ctrl_groups),
950 .id = GENL_ID_CTRL,
951 .name = "nlctrl",
952 .version = 0x2,
953 .maxattr = CTRL_ATTR_MAX,
954 .netnsok = true,
955};
956
023e2cfa 957static int genl_bind(struct net *net, int group)
c380d9a7 958{
2ae0f17d
JB
959 struct genl_family *f;
960 int err = -ENOENT;
961 unsigned int id;
c380d9a7
JB
962
963 down_read(&cb_lock);
2ae0f17d
JB
964
965 idr_for_each_entry(&genl_fam_idr, f, id) {
966 if (group >= f->mcgrp_offset &&
967 group < f->mcgrp_offset + f->n_mcgrps) {
968 int fam_grp = group - f->mcgrp_offset;
969
970 if (!f->netnsok && net != &init_net)
971 err = -ENOENT;
972 else if (f->mcast_bind)
973 err = f->mcast_bind(net, fam_grp);
974 else
975 err = 0;
976 break;
c380d9a7
JB
977 }
978 }
979 up_read(&cb_lock);
980
c380d9a7
JB
981 return err;
982}
983
023e2cfa 984static void genl_unbind(struct net *net, int group)
c380d9a7 985{
2ae0f17d
JB
986 struct genl_family *f;
987 unsigned int id;
c380d9a7
JB
988
989 down_read(&cb_lock);
c380d9a7 990
2ae0f17d
JB
991 idr_for_each_entry(&genl_fam_idr, f, id) {
992 if (group >= f->mcgrp_offset &&
993 group < f->mcgrp_offset + f->n_mcgrps) {
994 int fam_grp = group - f->mcgrp_offset;
c380d9a7 995
2ae0f17d
JB
996 if (f->mcast_unbind)
997 f->mcast_unbind(net, fam_grp);
998 break;
c380d9a7
JB
999 }
1000 }
1001 up_read(&cb_lock);
c380d9a7
JB
1002}
1003
134e6375
JB
1004static int __net_init genl_pernet_init(struct net *net)
1005{
a31f2d17
PNA
1006 struct netlink_kernel_cfg cfg = {
1007 .input = genl_rcv,
9785e10a 1008 .flags = NL_CFG_F_NONROOT_RECV,
c380d9a7
JB
1009 .bind = genl_bind,
1010 .unbind = genl_unbind,
a31f2d17
PNA
1011 };
1012
134e6375 1013 /* we'll bump the group number right afterwards */
9f00d977 1014 net->genl_sock = netlink_kernel_create(net, NETLINK_GENERIC, &cfg);
134e6375
JB
1015
1016 if (!net->genl_sock && net_eq(net, &init_net))
1017 panic("GENL: Cannot initialize generic netlink\n");
1018
1019 if (!net->genl_sock)
1020 return -ENOMEM;
1021
1022 return 0;
1023}
1024
1025static void __net_exit genl_pernet_exit(struct net *net)
1026{
1027 netlink_kernel_release(net->genl_sock);
1028 net->genl_sock = NULL;
1029}
1030
1031static struct pernet_operations genl_pernet_ops = {
1032 .init = genl_pernet_init,
1033 .exit = genl_pernet_exit,
1034};
1035
482a8524
TG
1036static int __init genl_init(void)
1037{
2ae0f17d 1038 int err;
482a8524 1039
489111e5 1040 err = genl_register_family(&genl_ctrl);
482a8524 1041 if (err < 0)
134e6375 1042 goto problem;
482a8524 1043
134e6375
JB
1044 err = register_pernet_subsys(&genl_pernet_ops);
1045 if (err)
1046 goto problem;
482a8524
TG
1047
1048 return 0;
1049
134e6375 1050problem:
482a8524 1051 panic("GENL: Cannot register controller: %d\n", err);
482a8524
TG
1052}
1053
1054subsys_initcall(genl_init);
1055
c90c39da
JB
1056/**
1057 * genl_family_attrbuf - return family's attrbuf
1058 * @family: the family
1059 *
1060 * Return the family's attrbuf, while validating that it's
1061 * actually valid to access it.
1062 *
1063 * You cannot use this function with a family that has parallel_ops
1064 * and you can only use it within (pre/post) doit/dumpit callbacks.
1065 */
2ae0f17d 1066struct nlattr **genl_family_attrbuf(const struct genl_family *family)
c90c39da
JB
1067{
1068 if (!WARN_ON(family->parallel_ops))
1069 lockdep_assert_held(&genl_mutex);
1070
1071 return family->attrbuf;
1072}
1073EXPORT_SYMBOL(genl_family_attrbuf);
1074
15e47304 1075static int genlmsg_mcast(struct sk_buff *skb, u32 portid, unsigned long group,
134e6375
JB
1076 gfp_t flags)
1077{
1078 struct sk_buff *tmp;
1079 struct net *net, *prev = NULL;
1080 int err;
1081
1082 for_each_net_rcu(net) {
1083 if (prev) {
1084 tmp = skb_clone(skb, flags);
1085 if (!tmp) {
1086 err = -ENOMEM;
1087 goto error;
1088 }
1089 err = nlmsg_multicast(prev->genl_sock, tmp,
15e47304 1090 portid, group, flags);
134e6375
JB
1091 if (err)
1092 goto error;
1093 }
1094
1095 prev = net;
1096 }
1097
15e47304 1098 return nlmsg_multicast(prev->genl_sock, skb, portid, group, flags);
134e6375
JB
1099 error:
1100 kfree_skb(skb);
1101 return err;
1102}
1103
2ae0f17d
JB
1104int genlmsg_multicast_allns(const struct genl_family *family,
1105 struct sk_buff *skb, u32 portid,
1106 unsigned int group, gfp_t flags)
134e6375 1107{
220815a9 1108 if (WARN_ON_ONCE(group >= family->n_mcgrps))
2a94fe48
JB
1109 return -EINVAL;
1110 group = family->mcgrp_offset + group;
15e47304 1111 return genlmsg_mcast(skb, portid, group, flags);
134e6375
JB
1112}
1113EXPORT_SYMBOL(genlmsg_multicast_allns);
263ba61d 1114
2ae0f17d 1115void genl_notify(const struct genl_family *family, struct sk_buff *skb,
92c14d9b 1116 struct genl_info *info, u32 group, gfp_t flags)
263ba61d 1117{
92c14d9b 1118 struct net *net = genl_info_net(info);
263ba61d
PS
1119 struct sock *sk = net->genl_sock;
1120 int report = 0;
1121
92c14d9b
JB
1122 if (info->nlhdr)
1123 report = nlmsg_report(info->nlhdr);
263ba61d 1124
220815a9 1125 if (WARN_ON_ONCE(group >= family->n_mcgrps))
2a94fe48
JB
1126 return;
1127 group = family->mcgrp_offset + group;
92c14d9b 1128 nlmsg_notify(sk, skb, info->snd_portid, group, report, flags);
263ba61d
PS
1129}
1130EXPORT_SYMBOL(genl_notify);