1 // SPDX-License-Identifier: GPL-2.0
3 * NETLINK Generic Netlink Family
5 * Authors: Jamal Hadi Salim
10 #include <linux/module.h>
11 #include <linux/kernel.h>
12 #include <linux/slab.h>
13 #include <linux/errno.h>
14 #include <linux/types.h>
15 #include <linux/socket.h>
16 #include <linux/string_helpers.h>
17 #include <linux/skbuff.h>
18 #include <linux/mutex.h>
19 #include <linux/bitmap.h>
20 #include <linux/rwsem.h>
21 #include <linux/idr.h>
23 #include <net/genetlink.h>
25 static DEFINE_MUTEX(genl_mutex); /* serialization of message processing */
26 static DECLARE_RWSEM(cb_lock);
28 atomic_t genl_sk_destructing_cnt = ATOMIC_INIT(0);
29 DECLARE_WAIT_QUEUE_HEAD(genl_sk_destructing_waitq);
33 mutex_lock(&genl_mutex);
35 EXPORT_SYMBOL(genl_lock);
37 void genl_unlock(void)
39 mutex_unlock(&genl_mutex);
41 EXPORT_SYMBOL(genl_unlock);
43 static void genl_lock_all(void)
49 static void genl_unlock_all(void)
55 static void genl_op_lock(const struct genl_family *family)
57 if (!family->parallel_ops)
61 static void genl_op_unlock(const struct genl_family *family)
63 if (!family->parallel_ops)
67 static DEFINE_IDR(genl_fam_idr);
70 * Bitmap of multicast groups that are currently in use.
72 * To avoid an allocation at boot of just one unsigned long,
73 * declare it global instead.
74 * Bit 0 is marked as already used since group 0 is invalid.
75 * Bit 1 is marked as already used since the drop-monitor code
76 * abuses the API and thinks it can statically use group 1.
77 * That group will typically conflict with other groups that
78 * any proper users use.
79 * Bit 16 is marked as used since it's used for generic netlink
80 * and the code no longer marks pre-reserved IDs as used.
81 * Bit 17 is marked as already used since the VFS quota code
82 * also abused this API and relied on family == group ID, we
83 * cater to that by giving it a static family and group ID.
84 * Bit 18 is marked as already used since the PMCRAID driver
85 * did the same thing as the VFS quota code (maybe copied?)
87 static unsigned long mc_group_start = 0x3 | BIT(GENL_ID_CTRL) |
88 BIT(GENL_ID_VFS_DQUOT) |
90 static unsigned long *mc_groups = &mc_group_start;
91 static unsigned long mc_groups_longs = 1;
93 /* We need the last attribute with non-zero ID therefore a 2-entry array */
94 static struct nla_policy genl_policy_reject_all[] = {
95 { .type = NLA_REJECT },
96 { .type = NLA_REJECT },
99 static int genl_ctrl_event(int event, const struct genl_family *family,
100 const struct genl_multicast_group *grp,
104 genl_op_fill_in_reject_policy(const struct genl_family *family,
107 BUILD_BUG_ON(ARRAY_SIZE(genl_policy_reject_all) - 1 != 1);
109 if (op->policy || op->cmd < family->resv_start_op)
112 op->policy = genl_policy_reject_all;
117 genl_op_fill_in_reject_policy_split(const struct genl_family *family,
118 struct genl_split_ops *op)
123 op->policy = genl_policy_reject_all;
127 static const struct genl_family *genl_family_find_byid(unsigned int id)
129 return idr_find(&genl_fam_idr, id);
132 static const struct genl_family *genl_family_find_byname(char *name)
134 const struct genl_family *family;
137 idr_for_each_entry(&genl_fam_idr, family, id)
138 if (strcmp(family->name, name) == 0)
144 struct genl_op_iter {
145 const struct genl_family *family;
146 struct genl_split_ops doit;
147 struct genl_split_ops dumpit;
154 static void genl_op_from_full(const struct genl_family *family,
155 unsigned int i, struct genl_ops *op)
157 *op = family->ops[i];
160 op->maxattr = family->maxattr;
162 op->policy = family->policy;
164 genl_op_fill_in_reject_policy(family, op);
167 static int genl_get_cmd_full(u32 cmd, const struct genl_family *family,
172 for (i = 0; i < family->n_ops; i++)
173 if (family->ops[i].cmd == cmd) {
174 genl_op_from_full(family, i, op);
181 static void genl_op_from_small(const struct genl_family *family,
182 unsigned int i, struct genl_ops *op)
184 memset(op, 0, sizeof(*op));
185 op->doit = family->small_ops[i].doit;
186 op->dumpit = family->small_ops[i].dumpit;
187 op->cmd = family->small_ops[i].cmd;
188 op->internal_flags = family->small_ops[i].internal_flags;
189 op->flags = family->small_ops[i].flags;
190 op->validate = family->small_ops[i].validate;
192 op->maxattr = family->maxattr;
193 op->policy = family->policy;
195 genl_op_fill_in_reject_policy(family, op);
198 static int genl_get_cmd_small(u32 cmd, const struct genl_family *family,
203 for (i = 0; i < family->n_small_ops; i++)
204 if (family->small_ops[i].cmd == cmd) {
205 genl_op_from_small(family, i, op);
212 static void genl_op_from_split(struct genl_op_iter *iter)
214 const struct genl_family *family = iter->family;
217 i = iter->entry_idx - family->n_ops - family->n_small_ops;
219 if (family->split_ops[i + cnt].flags & GENL_CMD_CAP_DO) {
220 iter->doit = family->split_ops[i + cnt];
221 genl_op_fill_in_reject_policy_split(family, &iter->doit);
224 memset(&iter->doit, 0, sizeof(iter->doit));
227 if (i + cnt < family->n_split_ops &&
228 family->split_ops[i + cnt].flags & GENL_CMD_CAP_DUMP &&
229 (!cnt || family->split_ops[i + cnt].cmd == iter->doit.cmd)) {
230 iter->dumpit = family->split_ops[i + cnt];
231 genl_op_fill_in_reject_policy_split(family, &iter->dumpit);
234 memset(&iter->dumpit, 0, sizeof(iter->dumpit));
238 iter->entry_idx += cnt;
242 genl_get_cmd_split(u32 cmd, u8 flag, const struct genl_family *family,
243 struct genl_split_ops *op)
247 for (i = 0; i < family->n_split_ops; i++)
248 if (family->split_ops[i].cmd == cmd &&
249 family->split_ops[i].flags & flag) {
250 *op = family->split_ops[i];
258 genl_cmd_full_to_split(struct genl_split_ops *op,
259 const struct genl_family *family,
260 const struct genl_ops *full, u8 flags)
262 if ((flags & GENL_CMD_CAP_DO && !full->doit) ||
263 (flags & GENL_CMD_CAP_DUMP && !full->dumpit)) {
264 memset(op, 0, sizeof(*op));
268 if (flags & GENL_CMD_CAP_DUMP) {
269 op->start = full->start;
270 op->dumpit = full->dumpit;
271 op->done = full->done;
273 op->pre_doit = family->pre_doit;
274 op->doit = full->doit;
275 op->post_doit = family->post_doit;
278 if (flags & GENL_CMD_CAP_DUMP &&
279 full->validate & GENL_DONT_VALIDATE_DUMP) {
283 op->policy = full->policy;
284 op->maxattr = full->maxattr;
288 op->internal_flags = full->internal_flags;
289 op->flags = full->flags;
290 op->validate = full->validate;
292 /* Make sure flags include the GENL_CMD_CAP_DO / GENL_CMD_CAP_DUMP */
298 /* Must make sure that op is initialized to 0 on failure */
300 genl_get_cmd(u32 cmd, u8 flags, const struct genl_family *family,
301 struct genl_split_ops *op)
303 struct genl_ops full;
306 err = genl_get_cmd_full(cmd, family, &full);
308 err = genl_get_cmd_small(cmd, family, &full);
309 /* Found one of legacy forms */
311 return genl_cmd_full_to_split(op, family, &full, flags);
313 err = genl_get_cmd_split(cmd, flags, family, op);
315 memset(op, 0, sizeof(*op));
319 /* For policy dumping only, get ops of both do and dump.
320 * Fail if both are missing, genl_get_cmd() will zero-init in case of failure.
323 genl_get_cmd_both(u32 cmd, const struct genl_family *family,
324 struct genl_split_ops *doit, struct genl_split_ops *dumpit)
328 err1 = genl_get_cmd(cmd, GENL_CMD_CAP_DO, family, doit);
329 err2 = genl_get_cmd(cmd, GENL_CMD_CAP_DUMP, family, dumpit);
331 return err1 && err2 ? -ENOENT : 0;
335 genl_op_iter_init(const struct genl_family *family, struct genl_op_iter *iter)
337 iter->family = family;
343 return iter->family->n_ops +
344 iter->family->n_small_ops +
345 iter->family->n_split_ops;
348 static bool genl_op_iter_next(struct genl_op_iter *iter)
350 const struct genl_family *family = iter->family;
351 bool legacy_op = true;
354 if (iter->entry_idx < family->n_ops) {
355 genl_op_from_full(family, iter->entry_idx, &op);
356 } else if (iter->entry_idx < family->n_ops + family->n_small_ops) {
357 genl_op_from_small(family, iter->entry_idx - family->n_ops,
359 } else if (iter->entry_idx <
360 family->n_ops + family->n_small_ops + family->n_split_ops) {
362 /* updates entry_idx */
363 genl_op_from_split(iter);
373 genl_cmd_full_to_split(&iter->doit, family,
374 &op, GENL_CMD_CAP_DO);
375 genl_cmd_full_to_split(&iter->dumpit, family,
376 &op, GENL_CMD_CAP_DUMP);
379 iter->cmd = iter->doit.cmd | iter->dumpit.cmd;
380 iter->flags = iter->doit.flags | iter->dumpit.flags;
386 genl_op_iter_copy(struct genl_op_iter *dst, struct genl_op_iter *src)
391 static unsigned int genl_op_iter_idx(struct genl_op_iter *iter)
393 return iter->cmd_idx;
396 static int genl_allocate_reserve_groups(int n_groups, int *first_id)
398 unsigned long *new_groups;
406 id = find_first_zero_bit(mc_groups,
410 id = find_next_zero_bit(mc_groups,
411 mc_groups_longs * BITS_PER_LONG,
416 i < min_t(int, id + n_groups,
417 mc_groups_longs * BITS_PER_LONG);
419 if (test_bit(i, mc_groups)) {
426 if (id + n_groups > mc_groups_longs * BITS_PER_LONG) {
427 unsigned long new_longs = mc_groups_longs +
428 BITS_TO_LONGS(n_groups);
429 size_t nlen = new_longs * sizeof(unsigned long);
431 if (mc_groups == &mc_group_start) {
432 new_groups = kzalloc(nlen, GFP_KERNEL);
435 mc_groups = new_groups;
436 *mc_groups = mc_group_start;
438 new_groups = krealloc(mc_groups, nlen,
442 mc_groups = new_groups;
443 for (i = 0; i < BITS_TO_LONGS(n_groups); i++)
444 mc_groups[mc_groups_longs + i] = 0;
446 mc_groups_longs = new_longs;
450 for (i = id; i < id + n_groups; i++)
451 set_bit(i, mc_groups);
456 static struct genl_family genl_ctrl;
458 static int genl_validate_assign_mc_groups(struct genl_family *family)
461 int n_groups = family->n_mcgrps;
463 bool groups_allocated = false;
468 for (i = 0; i < n_groups; i++) {
469 const struct genl_multicast_group *grp = &family->mcgrps[i];
471 if (WARN_ON(grp->name[0] == '\0'))
473 if (WARN_ON(!string_is_terminated(grp->name, GENL_NAMSIZ)))
477 /* special-case our own group and hacks */
478 if (family == &genl_ctrl) {
479 first_id = GENL_ID_CTRL;
480 BUG_ON(n_groups != 1);
481 } else if (strcmp(family->name, "NET_DM") == 0) {
483 BUG_ON(n_groups != 1);
484 } else if (family->id == GENL_ID_VFS_DQUOT) {
485 first_id = GENL_ID_VFS_DQUOT;
486 BUG_ON(n_groups != 1);
487 } else if (family->id == GENL_ID_PMCRAID) {
488 first_id = GENL_ID_PMCRAID;
489 BUG_ON(n_groups != 1);
491 groups_allocated = true;
492 err = genl_allocate_reserve_groups(n_groups, &first_id);
497 family->mcgrp_offset = first_id;
499 /* if still initializing, can't and don't need to realloc bitmaps */
500 if (!init_net.genl_sock)
503 if (family->netnsok) {
506 netlink_table_grab();
508 for_each_net_rcu(net) {
509 err = __netlink_change_ngroups(net->genl_sock,
510 mc_groups_longs * BITS_PER_LONG);
513 * No need to roll back, can only fail if
514 * memory allocation fails and then the
515 * number of _possible_ groups has been
516 * increased on some sockets which is ok.
522 netlink_table_ungrab();
524 err = netlink_change_ngroups(init_net.genl_sock,
525 mc_groups_longs * BITS_PER_LONG);
528 if (groups_allocated && err) {
529 for (i = 0; i < family->n_mcgrps; i++)
530 clear_bit(family->mcgrp_offset + i, mc_groups);
536 static void genl_unregister_mc_groups(const struct genl_family *family)
541 netlink_table_grab();
543 for_each_net_rcu(net) {
544 for (i = 0; i < family->n_mcgrps; i++)
545 __netlink_clear_multicast_users(
546 net->genl_sock, family->mcgrp_offset + i);
549 netlink_table_ungrab();
551 for (i = 0; i < family->n_mcgrps; i++) {
552 int grp_id = family->mcgrp_offset + i;
555 clear_bit(grp_id, mc_groups);
556 genl_ctrl_event(CTRL_CMD_DELMCAST_GRP, family,
557 &family->mcgrps[i], grp_id);
561 static bool genl_split_op_check(const struct genl_split_ops *op)
563 if (WARN_ON(hweight8(op->flags & (GENL_CMD_CAP_DO |
564 GENL_CMD_CAP_DUMP)) != 1))
569 static int genl_validate_ops(const struct genl_family *family)
571 struct genl_op_iter i, j;
574 if (WARN_ON(family->n_ops && !family->ops) ||
575 WARN_ON(family->n_small_ops && !family->small_ops) ||
576 WARN_ON(family->n_split_ops && !family->split_ops))
579 for (genl_op_iter_init(family, &i); genl_op_iter_next(&i); ) {
580 if (!(i.flags & (GENL_CMD_CAP_DO | GENL_CMD_CAP_DUMP)))
583 if (WARN_ON(i.cmd >= family->resv_start_op &&
584 (i.doit.validate || i.dumpit.validate)))
587 genl_op_iter_copy(&j, &i);
588 while (genl_op_iter_next(&j)) {
594 if (family->n_split_ops) {
595 if (genl_split_op_check(&family->split_ops[0]))
599 for (s = 1; s < family->n_split_ops; s++) {
600 const struct genl_split_ops *a, *b;
602 a = &family->split_ops[s - 1];
603 b = &family->split_ops[s];
605 if (genl_split_op_check(b))
608 /* Check sort order */
609 if (a->cmd < b->cmd) {
611 } else if (a->cmd > b->cmd) {
616 if (a->internal_flags != b->internal_flags ||
617 ((a->flags ^ b->flags) & ~(GENL_CMD_CAP_DO |
618 GENL_CMD_CAP_DUMP))) {
623 if ((a->flags & GENL_CMD_CAP_DO) &&
624 (b->flags & GENL_CMD_CAP_DUMP))
635 * genl_register_family - register a generic netlink family
636 * @family: generic netlink family
638 * Registers the specified family after validating it first. Only one
639 * family may be registered with the same family name or identifier.
641 * The family's ops, multicast groups and module pointer must already
644 * Return 0 on success or a negative error code.
646 int genl_register_family(struct genl_family *family)
649 int start = GENL_START_ALLOC, end = GENL_MAX_ID;
651 err = genl_validate_ops(family);
657 if (genl_family_find_byname(family->name)) {
663 * Sadly, a few cases need to be special-cased
664 * due to them having previously abused the API
665 * and having used their family ID also as their
666 * multicast group ID, so we use reserved IDs
667 * for both to be sure we can do that mapping.
669 if (family == &genl_ctrl) {
670 /* and this needs to be special for initial family lookups */
671 start = end = GENL_ID_CTRL;
672 } else if (strcmp(family->name, "pmcraid") == 0) {
673 start = end = GENL_ID_PMCRAID;
674 } else if (strcmp(family->name, "VFS_DQUOT") == 0) {
675 start = end = GENL_ID_VFS_DQUOT;
678 family->id = idr_alloc_cyclic(&genl_fam_idr, family,
679 start, end + 1, GFP_KERNEL);
680 if (family->id < 0) {
685 err = genl_validate_assign_mc_groups(family);
691 /* send all events */
692 genl_ctrl_event(CTRL_CMD_NEWFAMILY, family, NULL, 0);
693 for (i = 0; i < family->n_mcgrps; i++)
694 genl_ctrl_event(CTRL_CMD_NEWMCAST_GRP, family,
695 &family->mcgrps[i], family->mcgrp_offset + i);
700 idr_remove(&genl_fam_idr, family->id);
705 EXPORT_SYMBOL(genl_register_family);
708 * genl_unregister_family - unregister generic netlink family
709 * @family: generic netlink family
711 * Unregisters the specified family.
713 * Returns 0 on success or a negative error code.
715 int genl_unregister_family(const struct genl_family *family)
719 if (!genl_family_find_byid(family->id)) {
724 genl_unregister_mc_groups(family);
726 idr_remove(&genl_fam_idr, family->id);
729 wait_event(genl_sk_destructing_waitq,
730 atomic_read(&genl_sk_destructing_cnt) == 0);
733 genl_ctrl_event(CTRL_CMD_DELFAMILY, family, NULL, 0);
737 EXPORT_SYMBOL(genl_unregister_family);
740 * genlmsg_put - Add generic netlink header to netlink message
741 * @skb: socket buffer holding the message
742 * @portid: netlink portid the message is addressed to
743 * @seq: sequence number (usually the one of the sender)
744 * @family: generic netlink family
745 * @flags: netlink message flags
746 * @cmd: generic netlink command
748 * Returns pointer to user specific header
750 void *genlmsg_put(struct sk_buff *skb, u32 portid, u32 seq,
751 const struct genl_family *family, int flags, u8 cmd)
753 struct nlmsghdr *nlh;
754 struct genlmsghdr *hdr;
756 nlh = nlmsg_put(skb, portid, seq, family->id, GENL_HDRLEN +
757 family->hdrsize, flags);
761 hdr = nlmsg_data(nlh);
763 hdr->version = family->version;
766 return (char *) hdr + GENL_HDRLEN;
768 EXPORT_SYMBOL(genlmsg_put);
770 static struct genl_dumpit_info *genl_dumpit_info_alloc(void)
772 return kmalloc(sizeof(struct genl_dumpit_info), GFP_KERNEL);
775 static void genl_dumpit_info_free(const struct genl_dumpit_info *info)
780 static struct nlattr **
781 genl_family_rcv_msg_attrs_parse(const struct genl_family *family,
782 struct nlmsghdr *nlh,
783 struct netlink_ext_ack *extack,
784 const struct genl_split_ops *ops,
786 enum genl_validate_flags no_strict_flag)
788 enum netlink_validation validate = ops->validate & no_strict_flag ?
789 NL_VALIDATE_LIBERAL :
791 struct nlattr **attrbuf;
797 attrbuf = kmalloc_array(ops->maxattr + 1,
798 sizeof(struct nlattr *), GFP_KERNEL);
800 return ERR_PTR(-ENOMEM);
802 err = __nlmsg_parse(nlh, hdrlen, attrbuf, ops->maxattr, ops->policy,
811 static void genl_family_rcv_msg_attrs_free(struct nlattr **attrbuf)
816 struct genl_start_context {
817 const struct genl_family *family;
818 struct nlmsghdr *nlh;
819 struct netlink_ext_ack *extack;
820 const struct genl_split_ops *ops;
824 static int genl_start(struct netlink_callback *cb)
826 struct genl_start_context *ctx = cb->data;
827 const struct genl_split_ops *ops;
828 struct genl_dumpit_info *info;
829 struct nlattr **attrs = NULL;
833 if (!(ops->validate & GENL_DONT_VALIDATE_DUMP) &&
834 ctx->nlh->nlmsg_len < nlmsg_msg_size(ctx->hdrlen))
837 attrs = genl_family_rcv_msg_attrs_parse(ctx->family, ctx->nlh, ctx->extack,
839 GENL_DONT_VALIDATE_DUMP_STRICT);
841 return PTR_ERR(attrs);
843 info = genl_dumpit_info_alloc();
845 genl_family_rcv_msg_attrs_free(attrs);
849 info->info.family = ctx->family;
850 info->info.snd_seq = cb->nlh->nlmsg_seq;
851 info->info.snd_portid = NETLINK_CB(cb->skb).portid;
852 info->info.nlhdr = cb->nlh;
853 info->info.genlhdr = nlmsg_data(cb->nlh);
854 info->info.attrs = attrs;
855 genl_info_net_set(&info->info, sock_net(cb->skb->sk));
856 info->info.extack = cb->extack;
857 memset(&info->info.user_ptr, 0, sizeof(info->info.user_ptr));
861 genl_op_lock(ctx->family);
863 genl_op_unlock(ctx->family);
867 genl_family_rcv_msg_attrs_free(info->info.attrs);
868 genl_dumpit_info_free(info);
874 static int genl_dumpit(struct sk_buff *skb, struct netlink_callback *cb)
876 struct genl_dumpit_info *dump_info = cb->data;
877 const struct genl_split_ops *ops = &dump_info->op;
878 struct genl_info *info = &dump_info->info;
881 info->extack = cb->extack;
883 genl_op_lock(info->family);
884 rc = ops->dumpit(skb, cb);
885 genl_op_unlock(info->family);
889 static int genl_done(struct netlink_callback *cb)
891 struct genl_dumpit_info *dump_info = cb->data;
892 const struct genl_split_ops *ops = &dump_info->op;
893 struct genl_info *info = &dump_info->info;
896 info->extack = cb->extack;
899 genl_op_lock(info->family);
901 genl_op_unlock(info->family);
903 genl_family_rcv_msg_attrs_free(info->attrs);
904 genl_dumpit_info_free(dump_info);
908 static int genl_family_rcv_msg_dumpit(const struct genl_family *family,
910 struct nlmsghdr *nlh,
911 struct netlink_ext_ack *extack,
912 const struct genl_split_ops *ops,
913 int hdrlen, struct net *net)
915 struct genl_start_context ctx;
916 struct netlink_dump_control c = {
917 .module = family->module,
932 genl_op_unlock(family);
933 err = __netlink_dump_start(net->genl_sock, skb, nlh, &c);
934 genl_op_lock(family);
939 static int genl_family_rcv_msg_doit(const struct genl_family *family,
941 struct nlmsghdr *nlh,
942 struct netlink_ext_ack *extack,
943 const struct genl_split_ops *ops,
944 int hdrlen, struct net *net)
946 struct nlattr **attrbuf;
947 struct genl_info info;
950 attrbuf = genl_family_rcv_msg_attrs_parse(family, nlh, extack,
952 GENL_DONT_VALIDATE_STRICT);
954 return PTR_ERR(attrbuf);
956 info.snd_seq = nlh->nlmsg_seq;
957 info.snd_portid = NETLINK_CB(skb).portid;
958 info.family = family;
960 info.genlhdr = nlmsg_data(nlh);
961 info.attrs = attrbuf;
962 info.extack = extack;
963 genl_info_net_set(&info, net);
964 memset(&info.user_ptr, 0, sizeof(info.user_ptr));
967 err = ops->pre_doit(ops, skb, &info);
972 err = ops->doit(skb, &info);
975 ops->post_doit(ops, skb, &info);
978 genl_family_rcv_msg_attrs_free(attrbuf);
983 static int genl_header_check(const struct genl_family *family,
984 struct nlmsghdr *nlh, struct genlmsghdr *hdr,
985 struct netlink_ext_ack *extack)
989 /* Only for commands added after we started validating */
990 if (hdr->cmd < family->resv_start_op)
994 NL_SET_ERR_MSG(extack, "genlmsghdr.reserved field is not 0");
998 /* Old netlink flags have pretty loose semantics, allow only the flags
999 * consumed by the core where we can enforce the meaning.
1001 flags = nlh->nlmsg_flags;
1002 if ((flags & NLM_F_DUMP) == NLM_F_DUMP) /* DUMP is 2 bits */
1003 flags &= ~NLM_F_DUMP;
1004 if (flags & ~(NLM_F_REQUEST | NLM_F_ACK | NLM_F_ECHO)) {
1005 NL_SET_ERR_MSG(extack,
1006 "ambiguous or reserved bits set in nlmsg_flags");
1013 static int genl_family_rcv_msg(const struct genl_family *family,
1014 struct sk_buff *skb,
1015 struct nlmsghdr *nlh,
1016 struct netlink_ext_ack *extack)
1018 struct net *net = sock_net(skb->sk);
1019 struct genlmsghdr *hdr = nlmsg_data(nlh);
1020 struct genl_split_ops op;
1024 /* this family doesn't exist in this netns */
1025 if (!family->netnsok && !net_eq(net, &init_net))
1028 hdrlen = GENL_HDRLEN + family->hdrsize;
1029 if (nlh->nlmsg_len < nlmsg_msg_size(hdrlen))
1032 if (genl_header_check(family, nlh, hdr, extack))
1035 flags = (nlh->nlmsg_flags & NLM_F_DUMP) == NLM_F_DUMP ?
1036 GENL_CMD_CAP_DUMP : GENL_CMD_CAP_DO;
1037 if (genl_get_cmd(hdr->cmd, flags, family, &op))
1040 if ((op.flags & GENL_ADMIN_PERM) &&
1041 !netlink_capable(skb, CAP_NET_ADMIN))
1044 if ((op.flags & GENL_UNS_ADMIN_PERM) &&
1045 !netlink_ns_capable(skb, net->user_ns, CAP_NET_ADMIN))
1048 if (flags & GENL_CMD_CAP_DUMP)
1049 return genl_family_rcv_msg_dumpit(family, skb, nlh, extack,
1052 return genl_family_rcv_msg_doit(family, skb, nlh, extack,
1056 static int genl_rcv_msg(struct sk_buff *skb, struct nlmsghdr *nlh,
1057 struct netlink_ext_ack *extack)
1059 const struct genl_family *family;
1062 family = genl_family_find_byid(nlh->nlmsg_type);
1066 genl_op_lock(family);
1067 err = genl_family_rcv_msg(family, skb, nlh, extack);
1068 genl_op_unlock(family);
1073 static void genl_rcv(struct sk_buff *skb)
1075 down_read(&cb_lock);
1076 netlink_rcv_skb(skb, &genl_rcv_msg);
1080 /**************************************************************************
1082 **************************************************************************/
1084 static struct genl_family genl_ctrl;
1086 static int ctrl_fill_info(const struct genl_family *family, u32 portid, u32 seq,
1087 u32 flags, struct sk_buff *skb, u8 cmd)
1089 struct genl_op_iter i;
1092 hdr = genlmsg_put(skb, portid, seq, &genl_ctrl, flags, cmd);
1096 if (nla_put_string(skb, CTRL_ATTR_FAMILY_NAME, family->name) ||
1097 nla_put_u16(skb, CTRL_ATTR_FAMILY_ID, family->id) ||
1098 nla_put_u32(skb, CTRL_ATTR_VERSION, family->version) ||
1099 nla_put_u32(skb, CTRL_ATTR_HDRSIZE, family->hdrsize) ||
1100 nla_put_u32(skb, CTRL_ATTR_MAXATTR, family->maxattr))
1101 goto nla_put_failure;
1103 if (genl_op_iter_init(family, &i)) {
1104 struct nlattr *nla_ops;
1106 nla_ops = nla_nest_start_noflag(skb, CTRL_ATTR_OPS);
1107 if (nla_ops == NULL)
1108 goto nla_put_failure;
1110 while (genl_op_iter_next(&i)) {
1111 struct nlattr *nest;
1115 if (i.doit.policy || i.dumpit.policy)
1116 op_flags |= GENL_CMD_CAP_HASPOL;
1118 nest = nla_nest_start_noflag(skb, genl_op_iter_idx(&i));
1120 goto nla_put_failure;
1122 if (nla_put_u32(skb, CTRL_ATTR_OP_ID, i.cmd) ||
1123 nla_put_u32(skb, CTRL_ATTR_OP_FLAGS, op_flags))
1124 goto nla_put_failure;
1126 nla_nest_end(skb, nest);
1129 nla_nest_end(skb, nla_ops);
1132 if (family->n_mcgrps) {
1133 struct nlattr *nla_grps;
1136 nla_grps = nla_nest_start_noflag(skb, CTRL_ATTR_MCAST_GROUPS);
1137 if (nla_grps == NULL)
1138 goto nla_put_failure;
1140 for (i = 0; i < family->n_mcgrps; i++) {
1141 struct nlattr *nest;
1142 const struct genl_multicast_group *grp;
1144 grp = &family->mcgrps[i];
1146 nest = nla_nest_start_noflag(skb, i + 1);
1148 goto nla_put_failure;
1150 if (nla_put_u32(skb, CTRL_ATTR_MCAST_GRP_ID,
1151 family->mcgrp_offset + i) ||
1152 nla_put_string(skb, CTRL_ATTR_MCAST_GRP_NAME,
1154 goto nla_put_failure;
1156 nla_nest_end(skb, nest);
1158 nla_nest_end(skb, nla_grps);
1161 genlmsg_end(skb, hdr);
1165 genlmsg_cancel(skb, hdr);
1169 static int ctrl_fill_mcgrp_info(const struct genl_family *family,
1170 const struct genl_multicast_group *grp,
1171 int grp_id, u32 portid, u32 seq, u32 flags,
1172 struct sk_buff *skb, u8 cmd)
1175 struct nlattr *nla_grps;
1176 struct nlattr *nest;
1178 hdr = genlmsg_put(skb, portid, seq, &genl_ctrl, flags, cmd);
1182 if (nla_put_string(skb, CTRL_ATTR_FAMILY_NAME, family->name) ||
1183 nla_put_u16(skb, CTRL_ATTR_FAMILY_ID, family->id))
1184 goto nla_put_failure;
1186 nla_grps = nla_nest_start_noflag(skb, CTRL_ATTR_MCAST_GROUPS);
1187 if (nla_grps == NULL)
1188 goto nla_put_failure;
1190 nest = nla_nest_start_noflag(skb, 1);
1192 goto nla_put_failure;
1194 if (nla_put_u32(skb, CTRL_ATTR_MCAST_GRP_ID, grp_id) ||
1195 nla_put_string(skb, CTRL_ATTR_MCAST_GRP_NAME,
1197 goto nla_put_failure;
1199 nla_nest_end(skb, nest);
1200 nla_nest_end(skb, nla_grps);
1202 genlmsg_end(skb, hdr);
1206 genlmsg_cancel(skb, hdr);
1210 static int ctrl_dumpfamily(struct sk_buff *skb, struct netlink_callback *cb)
1213 struct genl_family *rt;
1214 struct net *net = sock_net(skb->sk);
1215 int fams_to_skip = cb->args[0];
1218 idr_for_each_entry(&genl_fam_idr, rt, id) {
1219 if (!rt->netnsok && !net_eq(net, &init_net))
1222 if (n++ < fams_to_skip)
1225 if (ctrl_fill_info(rt, NETLINK_CB(cb->skb).portid,
1226 cb->nlh->nlmsg_seq, NLM_F_MULTI,
1227 skb, CTRL_CMD_NEWFAMILY) < 0) {
1237 static struct sk_buff *ctrl_build_family_msg(const struct genl_family *family,
1238 u32 portid, int seq, u8 cmd)
1240 struct sk_buff *skb;
1243 skb = nlmsg_new(NLMSG_DEFAULT_SIZE, GFP_KERNEL);
1245 return ERR_PTR(-ENOBUFS);
1247 err = ctrl_fill_info(family, portid, seq, 0, skb, cmd);
1250 return ERR_PTR(err);
1256 static struct sk_buff *
1257 ctrl_build_mcgrp_msg(const struct genl_family *family,
1258 const struct genl_multicast_group *grp,
1259 int grp_id, u32 portid, int seq, u8 cmd)
1261 struct sk_buff *skb;
1264 skb = nlmsg_new(NLMSG_DEFAULT_SIZE, GFP_KERNEL);
1266 return ERR_PTR(-ENOBUFS);
1268 err = ctrl_fill_mcgrp_info(family, grp, grp_id, portid,
1272 return ERR_PTR(err);
1278 static const struct nla_policy ctrl_policy_family[] = {
1279 [CTRL_ATTR_FAMILY_ID] = { .type = NLA_U16 },
1280 [CTRL_ATTR_FAMILY_NAME] = { .type = NLA_NUL_STRING,
1281 .len = GENL_NAMSIZ - 1 },
1284 static int ctrl_getfamily(struct sk_buff *skb, struct genl_info *info)
1286 struct sk_buff *msg;
1287 const struct genl_family *res = NULL;
1290 if (info->attrs[CTRL_ATTR_FAMILY_ID]) {
1291 u16 id = nla_get_u16(info->attrs[CTRL_ATTR_FAMILY_ID]);
1292 res = genl_family_find_byid(id);
1296 if (info->attrs[CTRL_ATTR_FAMILY_NAME]) {
1299 name = nla_data(info->attrs[CTRL_ATTR_FAMILY_NAME]);
1300 res = genl_family_find_byname(name);
1301 #ifdef CONFIG_MODULES
1305 request_module("net-pf-%d-proto-%d-family-%s",
1306 PF_NETLINK, NETLINK_GENERIC, name);
1307 down_read(&cb_lock);
1309 res = genl_family_find_byname(name);
1318 if (!res->netnsok && !net_eq(genl_info_net(info), &init_net)) {
1319 /* family doesn't exist here */
1323 msg = ctrl_build_family_msg(res, info->snd_portid, info->snd_seq,
1324 CTRL_CMD_NEWFAMILY);
1326 return PTR_ERR(msg);
1328 return genlmsg_reply(msg, info);
1331 static int genl_ctrl_event(int event, const struct genl_family *family,
1332 const struct genl_multicast_group *grp,
1335 struct sk_buff *msg;
1337 /* genl is still initialising */
1338 if (!init_net.genl_sock)
1342 case CTRL_CMD_NEWFAMILY:
1343 case CTRL_CMD_DELFAMILY:
1345 msg = ctrl_build_family_msg(family, 0, 0, event);
1347 case CTRL_CMD_NEWMCAST_GRP:
1348 case CTRL_CMD_DELMCAST_GRP:
1350 msg = ctrl_build_mcgrp_msg(family, grp, grp_id, 0, 0, event);
1357 return PTR_ERR(msg);
1359 if (!family->netnsok) {
1360 genlmsg_multicast_netns(&genl_ctrl, &init_net, msg, 0,
1364 genlmsg_multicast_allns(&genl_ctrl, msg, 0,
1372 struct ctrl_dump_policy_ctx {
1373 struct netlink_policy_dump_state *state;
1374 const struct genl_family *rt;
1375 struct genl_op_iter *op_iter;
1382 static const struct nla_policy ctrl_policy_policy[] = {
1383 [CTRL_ATTR_FAMILY_ID] = { .type = NLA_U16 },
1384 [CTRL_ATTR_FAMILY_NAME] = { .type = NLA_NUL_STRING,
1385 .len = GENL_NAMSIZ - 1 },
1386 [CTRL_ATTR_OP] = { .type = NLA_U32 },
1389 static int ctrl_dumppolicy_start(struct netlink_callback *cb)
1391 const struct genl_dumpit_info *info = genl_dumpit_info(cb);
1392 struct ctrl_dump_policy_ctx *ctx = (void *)cb->ctx;
1393 struct nlattr **tb = info->info.attrs;
1394 const struct genl_family *rt;
1395 struct genl_op_iter i;
1398 BUILD_BUG_ON(sizeof(*ctx) > sizeof(cb->ctx));
1400 if (!tb[CTRL_ATTR_FAMILY_ID] && !tb[CTRL_ATTR_FAMILY_NAME])
1403 if (tb[CTRL_ATTR_FAMILY_ID]) {
1404 ctx->fam_id = nla_get_u16(tb[CTRL_ATTR_FAMILY_ID]);
1406 rt = genl_family_find_byname(
1407 nla_data(tb[CTRL_ATTR_FAMILY_NAME]));
1410 ctx->fam_id = rt->id;
1413 rt = genl_family_find_byid(ctx->fam_id);
1419 if (tb[CTRL_ATTR_OP]) {
1420 struct genl_split_ops doit, dump;
1422 ctx->single_op = true;
1423 ctx->op = nla_get_u32(tb[CTRL_ATTR_OP]);
1425 err = genl_get_cmd_both(ctx->op, rt, &doit, &dump);
1427 NL_SET_BAD_ATTR(cb->extack, tb[CTRL_ATTR_OP]);
1432 err = netlink_policy_dump_add_policy(&ctx->state,
1436 goto err_free_state;
1439 err = netlink_policy_dump_add_policy(&ctx->state,
1443 goto err_free_state;
1453 ctx->op_iter = kmalloc(sizeof(*ctx->op_iter), GFP_KERNEL);
1457 genl_op_iter_init(rt, ctx->op_iter);
1458 ctx->dump_map = genl_op_iter_next(ctx->op_iter);
1460 for (genl_op_iter_init(rt, &i); genl_op_iter_next(&i); ) {
1461 if (i.doit.policy) {
1462 err = netlink_policy_dump_add_policy(&ctx->state,
1466 goto err_free_state;
1468 if (i.dumpit.policy) {
1469 err = netlink_policy_dump_add_policy(&ctx->state,
1473 goto err_free_state;
1479 goto err_free_op_iter;
1484 netlink_policy_dump_free(ctx->state);
1486 kfree(ctx->op_iter);
1490 static void *ctrl_dumppolicy_prep(struct sk_buff *skb,
1491 struct netlink_callback *cb)
1493 struct ctrl_dump_policy_ctx *ctx = (void *)cb->ctx;
1496 hdr = genlmsg_put(skb, NETLINK_CB(cb->skb).portid,
1497 cb->nlh->nlmsg_seq, &genl_ctrl,
1498 NLM_F_MULTI, CTRL_CMD_GETPOLICY);
1502 if (nla_put_u16(skb, CTRL_ATTR_FAMILY_ID, ctx->fam_id))
1508 static int ctrl_dumppolicy_put_op(struct sk_buff *skb,
1509 struct netlink_callback *cb,
1510 struct genl_split_ops *doit,
1511 struct genl_split_ops *dumpit)
1513 struct ctrl_dump_policy_ctx *ctx = (void *)cb->ctx;
1514 struct nlattr *nest_pol, *nest_op;
1518 /* skip if we have nothing to show */
1519 if (!doit->policy && !dumpit->policy)
1522 hdr = ctrl_dumppolicy_prep(skb, cb);
1526 nest_pol = nla_nest_start(skb, CTRL_ATTR_OP_POLICY);
1530 nest_op = nla_nest_start(skb, doit->cmd);
1535 idx = netlink_policy_dump_get_policy_idx(ctx->state,
1539 if (nla_put_u32(skb, CTRL_ATTR_POLICY_DO, idx))
1542 if (dumpit->policy) {
1543 idx = netlink_policy_dump_get_policy_idx(ctx->state,
1547 if (nla_put_u32(skb, CTRL_ATTR_POLICY_DUMP, idx))
1551 nla_nest_end(skb, nest_op);
1552 nla_nest_end(skb, nest_pol);
1553 genlmsg_end(skb, hdr);
1557 genlmsg_cancel(skb, hdr);
1561 static int ctrl_dumppolicy(struct sk_buff *skb, struct netlink_callback *cb)
1563 struct ctrl_dump_policy_ctx *ctx = (void *)cb->ctx;
1566 if (ctx->dump_map) {
1567 if (ctx->single_op) {
1568 struct genl_split_ops doit, dumpit;
1570 if (WARN_ON(genl_get_cmd_both(ctx->op, ctx->rt,
1574 if (ctrl_dumppolicy_put_op(skb, cb, &doit, &dumpit))
1577 /* done with the per-op policy index list */
1581 while (ctx->dump_map) {
1582 if (ctrl_dumppolicy_put_op(skb, cb,
1583 &ctx->op_iter->doit,
1584 &ctx->op_iter->dumpit))
1587 ctx->dump_map = genl_op_iter_next(ctx->op_iter);
1591 while (netlink_policy_dump_loop(ctx->state)) {
1592 struct nlattr *nest;
1594 hdr = ctrl_dumppolicy_prep(skb, cb);
1596 goto nla_put_failure;
1598 nest = nla_nest_start(skb, CTRL_ATTR_POLICY);
1600 goto nla_put_failure;
1602 if (netlink_policy_dump_write(skb, ctx->state))
1603 goto nla_put_failure;
1605 nla_nest_end(skb, nest);
1607 genlmsg_end(skb, hdr);
1613 genlmsg_cancel(skb, hdr);
1617 static int ctrl_dumppolicy_done(struct netlink_callback *cb)
1619 struct ctrl_dump_policy_ctx *ctx = (void *)cb->ctx;
1621 kfree(ctx->op_iter);
1622 netlink_policy_dump_free(ctx->state);
1626 static const struct genl_split_ops genl_ctrl_ops[] = {
1628 .cmd = CTRL_CMD_GETFAMILY,
1629 .validate = GENL_DONT_VALIDATE_STRICT,
1630 .policy = ctrl_policy_family,
1631 .maxattr = ARRAY_SIZE(ctrl_policy_family) - 1,
1632 .doit = ctrl_getfamily,
1633 .flags = GENL_CMD_CAP_DO,
1636 .cmd = CTRL_CMD_GETFAMILY,
1637 .validate = GENL_DONT_VALIDATE_DUMP,
1638 .policy = ctrl_policy_family,
1639 .maxattr = ARRAY_SIZE(ctrl_policy_family) - 1,
1640 .dumpit = ctrl_dumpfamily,
1641 .flags = GENL_CMD_CAP_DUMP,
1644 .cmd = CTRL_CMD_GETPOLICY,
1645 .policy = ctrl_policy_policy,
1646 .maxattr = ARRAY_SIZE(ctrl_policy_policy) - 1,
1647 .start = ctrl_dumppolicy_start,
1648 .dumpit = ctrl_dumppolicy,
1649 .done = ctrl_dumppolicy_done,
1650 .flags = GENL_CMD_CAP_DUMP,
1654 static const struct genl_multicast_group genl_ctrl_groups[] = {
1655 { .name = "notify", },
1658 static struct genl_family genl_ctrl __ro_after_init = {
1659 .module = THIS_MODULE,
1660 .split_ops = genl_ctrl_ops,
1661 .n_split_ops = ARRAY_SIZE(genl_ctrl_ops),
1662 .resv_start_op = CTRL_CMD_GETPOLICY + 1,
1663 .mcgrps = genl_ctrl_groups,
1664 .n_mcgrps = ARRAY_SIZE(genl_ctrl_groups),
1671 static int genl_bind(struct net *net, int group)
1673 const struct genl_family *family;
1677 down_read(&cb_lock);
1679 idr_for_each_entry(&genl_fam_idr, family, id) {
1680 const struct genl_multicast_group *grp;
1683 if (family->n_mcgrps == 0)
1686 i = group - family->mcgrp_offset;
1687 if (i < 0 || i >= family->n_mcgrps)
1690 grp = &family->mcgrps[i];
1691 if ((grp->flags & GENL_UNS_ADMIN_PERM) &&
1692 !ns_capable(net->user_ns, CAP_NET_ADMIN))
1694 if (grp->cap_sys_admin &&
1695 !ns_capable(net->user_ns, CAP_SYS_ADMIN))
1705 static int __net_init genl_pernet_init(struct net *net)
1707 struct netlink_kernel_cfg cfg = {
1709 .flags = NL_CFG_F_NONROOT_RECV,
1713 /* we'll bump the group number right afterwards */
1714 net->genl_sock = netlink_kernel_create(net, NETLINK_GENERIC, &cfg);
1716 if (!net->genl_sock && net_eq(net, &init_net))
1717 panic("GENL: Cannot initialize generic netlink\n");
1719 if (!net->genl_sock)
1725 static void __net_exit genl_pernet_exit(struct net *net)
1727 netlink_kernel_release(net->genl_sock);
1728 net->genl_sock = NULL;
1731 static struct pernet_operations genl_pernet_ops = {
1732 .init = genl_pernet_init,
1733 .exit = genl_pernet_exit,
1736 static int __init genl_init(void)
1740 err = genl_register_family(&genl_ctrl);
1744 err = register_pernet_subsys(&genl_pernet_ops);
1751 panic("GENL: Cannot register controller: %d\n", err);
1754 core_initcall(genl_init);
1756 static int genlmsg_mcast(struct sk_buff *skb, u32 portid, unsigned long group,
1759 struct sk_buff *tmp;
1760 struct net *net, *prev = NULL;
1761 bool delivered = false;
1764 for_each_net_rcu(net) {
1766 tmp = skb_clone(skb, flags);
1771 err = nlmsg_multicast(prev->genl_sock, tmp,
1772 portid, group, flags);
1775 else if (err != -ESRCH)
1782 err = nlmsg_multicast(prev->genl_sock, skb, portid, group, flags);
1785 else if (err != -ESRCH)
1787 return delivered ? 0 : -ESRCH;
1793 int genlmsg_multicast_allns(const struct genl_family *family,
1794 struct sk_buff *skb, u32 portid,
1795 unsigned int group, gfp_t flags)
1797 if (WARN_ON_ONCE(group >= family->n_mcgrps))
1800 group = family->mcgrp_offset + group;
1801 return genlmsg_mcast(skb, portid, group, flags);
1803 EXPORT_SYMBOL(genlmsg_multicast_allns);
1805 void genl_notify(const struct genl_family *family, struct sk_buff *skb,
1806 struct genl_info *info, u32 group, gfp_t flags)
1808 struct net *net = genl_info_net(info);
1809 struct sock *sk = net->genl_sock;
1811 if (WARN_ON_ONCE(group >= family->n_mcgrps))
1814 group = family->mcgrp_offset + group;
1815 nlmsg_notify(sk, skb, info->snd_portid, group,
1816 nlmsg_report(info->nlhdr), flags);
1818 EXPORT_SYMBOL(genl_notify);