2 * NETLINK Generic Netlink Family
4 * Authors: Jamal Hadi Salim
5 * Thomas Graf <tgraf@suug.ch>
6 * Johannes Berg <johannes@sipsolutions.net>
9 #include <linux/module.h>
10 #include <linux/kernel.h>
11 #include <linux/slab.h>
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>
17 #include <linux/mutex.h>
18 #include <linux/bitmap.h>
19 #include <linux/rwsem.h>
21 #include <net/genetlink.h>
23 static DEFINE_MUTEX(genl_mutex); /* serialization of message processing */
24 static DECLARE_RWSEM(cb_lock);
28 mutex_lock(&genl_mutex);
30 EXPORT_SYMBOL(genl_lock);
32 void genl_unlock(void)
34 mutex_unlock(&genl_mutex);
36 EXPORT_SYMBOL(genl_unlock);
39 int lockdep_genl_is_held(void)
41 return lockdep_is_held(&genl_mutex);
43 EXPORT_SYMBOL(lockdep_genl_is_held);
46 static void genl_lock_all(void)
52 static void genl_unlock_all(void)
58 #define GENL_FAM_TAB_SIZE 16
59 #define GENL_FAM_TAB_MASK (GENL_FAM_TAB_SIZE - 1)
61 static struct list_head family_ht[GENL_FAM_TAB_SIZE];
63 * Bitmap of multicast groups that are currently in use.
65 * To avoid an allocation at boot of just one unsigned long,
66 * declare it global instead.
67 * Bit 0 is marked as already used since group 0 is invalid.
68 * Bit 1 is marked as already used since the drop-monitor code
69 * abuses the API and thinks it can statically use group 1.
70 * That group will typically conflict with other groups that
71 * any proper users use.
72 * Bit 17 is marked as already used since the VFS quota code
73 * also abused this API and relied on family == group ID, we
74 * cater to that by giving it a static family and group ID.
76 static unsigned long mc_group_start = 0x3 | BIT(GENL_ID_VFS_DQUOT);
77 static unsigned long *mc_groups = &mc_group_start;
78 static unsigned long mc_groups_longs = 1;
80 static int genl_ctrl_event(int event, void *data);
82 static inline unsigned int genl_family_hash(unsigned int id)
84 return id & GENL_FAM_TAB_MASK;
87 static inline struct list_head *genl_family_chain(unsigned int id)
89 return &family_ht[genl_family_hash(id)];
92 static struct genl_family *genl_family_find_byid(unsigned int id)
94 struct genl_family *f;
96 list_for_each_entry(f, genl_family_chain(id), family_list)
103 static struct genl_family *genl_family_find_byname(char *name)
105 struct genl_family *f;
108 for (i = 0; i < GENL_FAM_TAB_SIZE; i++)
109 list_for_each_entry(f, genl_family_chain(i), family_list)
110 if (strcmp(f->name, name) == 0)
116 static const struct genl_ops *genl_get_cmd(u8 cmd, struct genl_family *family)
120 for (i = 0; i < family->n_ops; i++)
121 if (family->ops[i].cmd == cmd)
122 return &family->ops[i];
127 /* Of course we are going to have problems once we hit
128 * 2^16 alive types, but that can only happen by year 2K
130 static u16 genl_generate_id(void)
132 static u16 id_gen_idx = GENL_MIN_ID;
135 for (i = 0; i <= GENL_MAX_ID - GENL_MIN_ID; i++) {
136 if (id_gen_idx != GENL_ID_VFS_DQUOT &&
137 !genl_family_find_byid(id_gen_idx))
139 if (++id_gen_idx > GENL_MAX_ID)
140 id_gen_idx = GENL_MIN_ID;
146 static struct genl_multicast_group notify_grp;
149 * genl_register_mc_group - register a multicast group
151 * Registers the specified multicast group and notifies userspace
152 * about the new group.
154 * Returns 0 on success or a negative error code.
156 * @family: The generic netlink family the group shall be registered for.
157 * @grp: The group to register, must have a name.
159 int genl_register_mc_group(struct genl_family *family,
160 struct genl_multicast_group *grp)
163 unsigned long *new_groups;
166 BUG_ON(grp->name[0] == '\0');
167 BUG_ON(memchr(grp->name, '\0', GENL_NAMSIZ) == NULL);
171 /* special-case our own group and hacks */
172 if (grp == ¬ify_grp)
174 else if (strcmp(family->name, "NET_DM") == 0)
176 else if (strcmp(family->name, "VFS_DQUOT") == 0)
177 id = GENL_ID_VFS_DQUOT;
179 id = find_first_zero_bit(mc_groups,
180 mc_groups_longs * BITS_PER_LONG);
183 if (id >= mc_groups_longs * BITS_PER_LONG) {
184 size_t nlen = (mc_groups_longs + 1) * sizeof(unsigned long);
186 if (mc_groups == &mc_group_start) {
187 new_groups = kzalloc(nlen, GFP_KERNEL);
192 mc_groups = new_groups;
193 *mc_groups = mc_group_start;
195 new_groups = krealloc(mc_groups, nlen, GFP_KERNEL);
200 mc_groups = new_groups;
201 mc_groups[mc_groups_longs] = 0;
206 if (family->netnsok) {
209 netlink_table_grab();
211 for_each_net_rcu(net) {
212 err = __netlink_change_ngroups(net->genl_sock,
213 mc_groups_longs * BITS_PER_LONG);
216 * No need to roll back, can only fail if
217 * memory allocation fails and then the
218 * number of _possible_ groups has been
219 * increased on some sockets which is ok.
222 netlink_table_ungrab();
227 netlink_table_ungrab();
229 err = netlink_change_ngroups(init_net.genl_sock,
230 mc_groups_longs * BITS_PER_LONG);
236 set_bit(id, mc_groups);
237 list_add_tail(&grp->list, &family->mcast_groups);
238 grp->family = family;
240 genl_ctrl_event(CTRL_CMD_NEWMCAST_GRP, grp);
245 EXPORT_SYMBOL(genl_register_mc_group);
247 static void __genl_unregister_mc_group(struct genl_family *family,
248 struct genl_multicast_group *grp)
251 BUG_ON(grp->family != family);
253 netlink_table_grab();
255 for_each_net_rcu(net)
256 __netlink_clear_multicast_users(net->genl_sock, grp->id);
258 netlink_table_ungrab();
261 clear_bit(grp->id, mc_groups);
262 list_del(&grp->list);
263 genl_ctrl_event(CTRL_CMD_DELMCAST_GRP, grp);
268 static void genl_unregister_mc_groups(struct genl_family *family)
270 struct genl_multicast_group *grp, *tmp;
272 list_for_each_entry_safe(grp, tmp, &family->mcast_groups, list)
273 __genl_unregister_mc_group(family, grp);
276 static int genl_validate_ops(struct genl_family *family)
278 const struct genl_ops *ops = family->ops;
279 unsigned int n_ops = family->n_ops;
282 if (WARN_ON(n_ops && !ops))
288 for (i = 0; i < n_ops; i++) {
289 if (ops[i].dumpit == NULL && ops[i].doit == NULL)
291 for (j = i + 1; j < n_ops; j++)
292 if (ops[i].cmd == ops[j].cmd)
296 /* family is not registered yet, so no locking needed */
298 family->n_ops = n_ops;
304 * __genl_register_family - register a generic netlink family
305 * @family: generic netlink family
307 * Registers the specified family after validating it first. Only one
308 * family may be registered with the same family name or identifier.
309 * The family id may equal GENL_ID_GENERATE causing an unique id to
310 * be automatically generated and assigned.
312 * The family's ops array must already be assigned, you can use the
313 * genl_register_family_with_ops() helper function.
315 * Return 0 on success or a negative error code.
317 int __genl_register_family(struct genl_family *family)
321 if (family->id && family->id < GENL_MIN_ID)
324 if (family->id > GENL_MAX_ID)
327 err = genl_validate_ops(family);
331 INIT_LIST_HEAD(&family->mcast_groups);
335 if (genl_family_find_byname(family->name)) {
340 if (family->id == GENL_ID_GENERATE) {
341 u16 newid = genl_generate_id();
349 } else if (genl_family_find_byid(family->id)) {
354 if (family->maxattr && !family->parallel_ops) {
355 family->attrbuf = kmalloc((family->maxattr+1) *
356 sizeof(struct nlattr *), GFP_KERNEL);
357 if (family->attrbuf == NULL) {
362 family->attrbuf = NULL;
364 list_add_tail(&family->family_list, genl_family_chain(family->id));
367 genl_ctrl_event(CTRL_CMD_NEWFAMILY, family);
376 EXPORT_SYMBOL(__genl_register_family);
379 * genl_unregister_family - unregister generic netlink family
380 * @family: generic netlink family
382 * Unregisters the specified family.
384 * Returns 0 on success or a negative error code.
386 int genl_unregister_family(struct genl_family *family)
388 struct genl_family *rc;
392 genl_unregister_mc_groups(family);
394 list_for_each_entry(rc, genl_family_chain(family->id), family_list) {
395 if (family->id != rc->id || strcmp(rc->name, family->name))
398 list_del(&rc->family_list);
402 kfree(family->attrbuf);
403 genl_ctrl_event(CTRL_CMD_DELFAMILY, family);
411 EXPORT_SYMBOL(genl_unregister_family);
414 * genlmsg_put - Add generic netlink header to netlink message
415 * @skb: socket buffer holding the message
416 * @portid: netlink portid the message is addressed to
417 * @seq: sequence number (usually the one of the sender)
418 * @family: generic netlink family
419 * @flags: netlink message flags
420 * @cmd: generic netlink command
422 * Returns pointer to user specific header
424 void *genlmsg_put(struct sk_buff *skb, u32 portid, u32 seq,
425 struct genl_family *family, int flags, u8 cmd)
427 struct nlmsghdr *nlh;
428 struct genlmsghdr *hdr;
430 nlh = nlmsg_put(skb, portid, seq, family->id, GENL_HDRLEN +
431 family->hdrsize, flags);
435 hdr = nlmsg_data(nlh);
437 hdr->version = family->version;
440 return (char *) hdr + GENL_HDRLEN;
442 EXPORT_SYMBOL(genlmsg_put);
444 static int genl_lock_dumpit(struct sk_buff *skb, struct netlink_callback *cb)
446 /* our ops are always const - netlink API doesn't propagate that */
447 const struct genl_ops *ops = cb->data;
451 rc = ops->dumpit(skb, cb);
456 static int genl_lock_done(struct netlink_callback *cb)
458 /* our ops are always const - netlink API doesn't propagate that */
459 const struct genl_ops *ops = cb->data;
470 static int genl_family_rcv_msg(struct genl_family *family,
472 struct nlmsghdr *nlh)
474 const struct genl_ops *ops;
475 struct net *net = sock_net(skb->sk);
476 struct genl_info info;
477 struct genlmsghdr *hdr = nlmsg_data(nlh);
478 struct nlattr **attrbuf;
481 /* this family doesn't exist in this netns */
482 if (!family->netnsok && !net_eq(net, &init_net))
485 hdrlen = GENL_HDRLEN + family->hdrsize;
486 if (nlh->nlmsg_len < nlmsg_msg_size(hdrlen))
489 ops = genl_get_cmd(hdr->cmd, family);
493 if ((ops->flags & GENL_ADMIN_PERM) &&
494 !capable(CAP_NET_ADMIN))
497 if ((nlh->nlmsg_flags & NLM_F_DUMP) == NLM_F_DUMP) {
500 if (ops->dumpit == NULL)
503 if (!family->parallel_ops) {
504 struct netlink_dump_control c = {
505 .module = family->module,
506 /* we have const, but the netlink API doesn't */
508 .dump = genl_lock_dumpit,
509 .done = genl_lock_done,
513 rc = __netlink_dump_start(net->genl_sock, skb, nlh, &c);
517 struct netlink_dump_control c = {
518 .module = family->module,
523 rc = __netlink_dump_start(net->genl_sock, skb, nlh, &c);
529 if (ops->doit == NULL)
532 if (family->maxattr && family->parallel_ops) {
533 attrbuf = kmalloc((family->maxattr+1) *
534 sizeof(struct nlattr *), GFP_KERNEL);
538 attrbuf = family->attrbuf;
541 err = nlmsg_parse(nlh, hdrlen, attrbuf, family->maxattr,
547 info.snd_seq = nlh->nlmsg_seq;
548 info.snd_portid = NETLINK_CB(skb).portid;
550 info.genlhdr = nlmsg_data(nlh);
551 info.userhdr = nlmsg_data(nlh) + GENL_HDRLEN;
552 info.attrs = attrbuf;
553 genl_info_net_set(&info, net);
554 memset(&info.user_ptr, 0, sizeof(info.user_ptr));
556 if (family->pre_doit) {
557 err = family->pre_doit(ops, skb, &info);
562 err = ops->doit(skb, &info);
564 if (family->post_doit)
565 family->post_doit(ops, skb, &info);
568 if (family->parallel_ops)
574 static int genl_rcv_msg(struct sk_buff *skb, struct nlmsghdr *nlh)
576 struct genl_family *family;
579 family = genl_family_find_byid(nlh->nlmsg_type);
583 if (!family->parallel_ops)
586 err = genl_family_rcv_msg(family, skb, nlh);
588 if (!family->parallel_ops)
594 static void genl_rcv(struct sk_buff *skb)
597 netlink_rcv_skb(skb, &genl_rcv_msg);
601 /**************************************************************************
603 **************************************************************************/
605 static struct genl_family genl_ctrl = {
609 .maxattr = CTRL_ATTR_MAX,
613 static int ctrl_fill_info(struct genl_family *family, u32 portid, u32 seq,
614 u32 flags, struct sk_buff *skb, u8 cmd)
618 hdr = genlmsg_put(skb, portid, seq, &genl_ctrl, flags, cmd);
622 if (nla_put_string(skb, CTRL_ATTR_FAMILY_NAME, family->name) ||
623 nla_put_u16(skb, CTRL_ATTR_FAMILY_ID, family->id) ||
624 nla_put_u32(skb, CTRL_ATTR_VERSION, family->version) ||
625 nla_put_u32(skb, CTRL_ATTR_HDRSIZE, family->hdrsize) ||
626 nla_put_u32(skb, CTRL_ATTR_MAXATTR, family->maxattr))
627 goto nla_put_failure;
630 struct nlattr *nla_ops;
633 nla_ops = nla_nest_start(skb, CTRL_ATTR_OPS);
635 goto nla_put_failure;
637 for (i = 0; i < family->n_ops; i++) {
639 const struct genl_ops *ops = &family->ops[i];
640 u32 op_flags = ops->flags;
643 op_flags |= GENL_CMD_CAP_DUMP;
645 op_flags |= GENL_CMD_CAP_DO;
647 op_flags |= GENL_CMD_CAP_HASPOL;
649 nest = nla_nest_start(skb, i + 1);
651 goto nla_put_failure;
653 if (nla_put_u32(skb, CTRL_ATTR_OP_ID, ops->cmd) ||
654 nla_put_u32(skb, CTRL_ATTR_OP_FLAGS, op_flags))
655 goto nla_put_failure;
657 nla_nest_end(skb, nest);
660 nla_nest_end(skb, nla_ops);
663 if (!list_empty(&family->mcast_groups)) {
664 struct genl_multicast_group *grp;
665 struct nlattr *nla_grps;
668 nla_grps = nla_nest_start(skb, CTRL_ATTR_MCAST_GROUPS);
669 if (nla_grps == NULL)
670 goto nla_put_failure;
672 list_for_each_entry(grp, &family->mcast_groups, list) {
675 nest = nla_nest_start(skb, idx++);
677 goto nla_put_failure;
679 if (nla_put_u32(skb, CTRL_ATTR_MCAST_GRP_ID, grp->id) ||
680 nla_put_string(skb, CTRL_ATTR_MCAST_GRP_NAME,
682 goto nla_put_failure;
684 nla_nest_end(skb, nest);
686 nla_nest_end(skb, nla_grps);
689 return genlmsg_end(skb, hdr);
692 genlmsg_cancel(skb, hdr);
696 static int ctrl_fill_mcgrp_info(struct genl_multicast_group *grp, u32 portid,
697 u32 seq, u32 flags, struct sk_buff *skb,
701 struct nlattr *nla_grps;
704 hdr = genlmsg_put(skb, portid, seq, &genl_ctrl, flags, cmd);
708 if (nla_put_string(skb, CTRL_ATTR_FAMILY_NAME, grp->family->name) ||
709 nla_put_u16(skb, CTRL_ATTR_FAMILY_ID, grp->family->id))
710 goto nla_put_failure;
712 nla_grps = nla_nest_start(skb, CTRL_ATTR_MCAST_GROUPS);
713 if (nla_grps == NULL)
714 goto nla_put_failure;
716 nest = nla_nest_start(skb, 1);
718 goto nla_put_failure;
720 if (nla_put_u32(skb, CTRL_ATTR_MCAST_GRP_ID, grp->id) ||
721 nla_put_string(skb, CTRL_ATTR_MCAST_GRP_NAME,
723 goto nla_put_failure;
725 nla_nest_end(skb, nest);
726 nla_nest_end(skb, nla_grps);
728 return genlmsg_end(skb, hdr);
731 genlmsg_cancel(skb, hdr);
735 static int ctrl_dumpfamily(struct sk_buff *skb, struct netlink_callback *cb)
739 struct genl_family *rt;
740 struct net *net = sock_net(skb->sk);
741 int chains_to_skip = cb->args[0];
742 int fams_to_skip = cb->args[1];
744 for (i = chains_to_skip; i < GENL_FAM_TAB_SIZE; i++) {
746 list_for_each_entry(rt, genl_family_chain(i), family_list) {
747 if (!rt->netnsok && !net_eq(net, &init_net))
749 if (++n < fams_to_skip)
751 if (ctrl_fill_info(rt, NETLINK_CB(cb->skb).portid,
752 cb->nlh->nlmsg_seq, NLM_F_MULTI,
753 skb, CTRL_CMD_NEWFAMILY) < 0)
767 static struct sk_buff *ctrl_build_family_msg(struct genl_family *family,
768 u32 portid, int seq, u8 cmd)
773 skb = nlmsg_new(NLMSG_DEFAULT_SIZE, GFP_KERNEL);
775 return ERR_PTR(-ENOBUFS);
777 err = ctrl_fill_info(family, portid, seq, 0, skb, cmd);
786 static struct sk_buff *ctrl_build_mcgrp_msg(struct genl_multicast_group *grp,
787 u32 portid, int seq, u8 cmd)
792 skb = nlmsg_new(NLMSG_DEFAULT_SIZE, GFP_KERNEL);
794 return ERR_PTR(-ENOBUFS);
796 err = ctrl_fill_mcgrp_info(grp, portid, seq, 0, skb, cmd);
805 static const struct nla_policy ctrl_policy[CTRL_ATTR_MAX+1] = {
806 [CTRL_ATTR_FAMILY_ID] = { .type = NLA_U16 },
807 [CTRL_ATTR_FAMILY_NAME] = { .type = NLA_NUL_STRING,
808 .len = GENL_NAMSIZ - 1 },
811 static int ctrl_getfamily(struct sk_buff *skb, struct genl_info *info)
814 struct genl_family *res = NULL;
817 if (info->attrs[CTRL_ATTR_FAMILY_ID]) {
818 u16 id = nla_get_u16(info->attrs[CTRL_ATTR_FAMILY_ID]);
819 res = genl_family_find_byid(id);
823 if (info->attrs[CTRL_ATTR_FAMILY_NAME]) {
826 name = nla_data(info->attrs[CTRL_ATTR_FAMILY_NAME]);
827 res = genl_family_find_byname(name);
828 #ifdef CONFIG_MODULES
832 request_module("net-pf-%d-proto-%d-family-%s",
833 PF_NETLINK, NETLINK_GENERIC, name);
836 res = genl_family_find_byname(name);
845 if (!res->netnsok && !net_eq(genl_info_net(info), &init_net)) {
846 /* family doesn't exist here */
850 msg = ctrl_build_family_msg(res, info->snd_portid, info->snd_seq,
855 return genlmsg_reply(msg, info);
858 static int genl_ctrl_event(int event, void *data)
861 struct genl_family *family;
862 struct genl_multicast_group *grp;
864 /* genl is still initialising */
865 if (!init_net.genl_sock)
869 case CTRL_CMD_NEWFAMILY:
870 case CTRL_CMD_DELFAMILY:
872 msg = ctrl_build_family_msg(family, 0, 0, event);
874 case CTRL_CMD_NEWMCAST_GRP:
875 case CTRL_CMD_DELMCAST_GRP:
877 family = grp->family;
878 msg = ctrl_build_mcgrp_msg(data, 0, 0, event);
887 if (!family->netnsok) {
888 genlmsg_multicast_netns(&init_net, msg, 0,
889 GENL_ID_CTRL, GFP_KERNEL);
892 genlmsg_multicast_allns(msg, 0, GENL_ID_CTRL, GFP_ATOMIC);
899 static struct genl_ops genl_ctrl_ops[] = {
901 .cmd = CTRL_CMD_GETFAMILY,
902 .doit = ctrl_getfamily,
903 .dumpit = ctrl_dumpfamily,
904 .policy = ctrl_policy,
908 static struct genl_multicast_group notify_grp = {
912 static int __net_init genl_pernet_init(struct net *net)
914 struct netlink_kernel_cfg cfg = {
916 .flags = NL_CFG_F_NONROOT_RECV,
919 /* we'll bump the group number right afterwards */
920 net->genl_sock = netlink_kernel_create(net, NETLINK_GENERIC, &cfg);
922 if (!net->genl_sock && net_eq(net, &init_net))
923 panic("GENL: Cannot initialize generic netlink\n");
931 static void __net_exit genl_pernet_exit(struct net *net)
933 netlink_kernel_release(net->genl_sock);
934 net->genl_sock = NULL;
937 static struct pernet_operations genl_pernet_ops = {
938 .init = genl_pernet_init,
939 .exit = genl_pernet_exit,
942 static int __init genl_init(void)
946 for (i = 0; i < GENL_FAM_TAB_SIZE; i++)
947 INIT_LIST_HEAD(&family_ht[i]);
949 err = genl_register_family_with_ops(&genl_ctrl, genl_ctrl_ops);
953 err = register_pernet_subsys(&genl_pernet_ops);
957 err = genl_register_mc_group(&genl_ctrl, ¬ify_grp);
964 panic("GENL: Cannot register controller: %d\n", err);
967 subsys_initcall(genl_init);
969 static int genlmsg_mcast(struct sk_buff *skb, u32 portid, unsigned long group,
973 struct net *net, *prev = NULL;
976 for_each_net_rcu(net) {
978 tmp = skb_clone(skb, flags);
983 err = nlmsg_multicast(prev->genl_sock, tmp,
984 portid, group, flags);
992 return nlmsg_multicast(prev->genl_sock, skb, portid, group, flags);
998 int genlmsg_multicast_allns(struct sk_buff *skb, u32 portid, unsigned int group,
1001 return genlmsg_mcast(skb, portid, group, flags);
1003 EXPORT_SYMBOL(genlmsg_multicast_allns);
1005 void genl_notify(struct sk_buff *skb, struct net *net, u32 portid, u32 group,
1006 struct nlmsghdr *nlh, gfp_t flags)
1008 struct sock *sk = net->genl_sock;
1012 report = nlmsg_report(nlh);
1014 nlmsg_notify(sk, skb, portid, group, report, flags);
1016 EXPORT_SYMBOL(genl_notify);