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.
69 static unsigned long mc_group_start = 0x1;
70 static unsigned long *mc_groups = &mc_group_start;
71 static unsigned long mc_groups_longs = 1;
73 static int genl_ctrl_event(int event, void *data);
75 static inline unsigned int genl_family_hash(unsigned int id)
77 return id & GENL_FAM_TAB_MASK;
80 static inline struct list_head *genl_family_chain(unsigned int id)
82 return &family_ht[genl_family_hash(id)];
85 static struct genl_family *genl_family_find_byid(unsigned int id)
87 struct genl_family *f;
89 list_for_each_entry(f, genl_family_chain(id), family_list)
96 static struct genl_family *genl_family_find_byname(char *name)
98 struct genl_family *f;
101 for (i = 0; i < GENL_FAM_TAB_SIZE; i++)
102 list_for_each_entry(f, genl_family_chain(i), family_list)
103 if (strcmp(f->name, name) == 0)
109 static const struct genl_ops *genl_get_cmd(u8 cmd, struct genl_family *family)
113 for (i = 0; i < family->n_ops; i++)
114 if (family->ops[i].cmd == cmd)
115 return &family->ops[i];
120 /* Of course we are going to have problems once we hit
121 * 2^16 alive types, but that can only happen by year 2K
123 static u16 genl_generate_id(void)
125 static u16 id_gen_idx = GENL_MIN_ID;
128 for (i = 0; i <= GENL_MAX_ID - GENL_MIN_ID; i++) {
129 if (!genl_family_find_byid(id_gen_idx))
131 if (++id_gen_idx > GENL_MAX_ID)
132 id_gen_idx = GENL_MIN_ID;
138 static struct genl_multicast_group notify_grp;
141 * genl_register_mc_group - register a multicast group
143 * Registers the specified multicast group and notifies userspace
144 * about the new group.
146 * Returns 0 on success or a negative error code.
148 * @family: The generic netlink family the group shall be registered for.
149 * @grp: The group to register, must have a name.
151 int genl_register_mc_group(struct genl_family *family,
152 struct genl_multicast_group *grp)
155 unsigned long *new_groups;
158 BUG_ON(grp->name[0] == '\0');
159 BUG_ON(memchr(grp->name, '\0', GENL_NAMSIZ) == NULL);
163 /* special-case our own group */
164 if (grp == ¬ify_grp)
167 id = find_first_zero_bit(mc_groups,
168 mc_groups_longs * BITS_PER_LONG);
171 if (id >= mc_groups_longs * BITS_PER_LONG) {
172 size_t nlen = (mc_groups_longs + 1) * sizeof(unsigned long);
174 if (mc_groups == &mc_group_start) {
175 new_groups = kzalloc(nlen, GFP_KERNEL);
180 mc_groups = new_groups;
181 *mc_groups = mc_group_start;
183 new_groups = krealloc(mc_groups, nlen, GFP_KERNEL);
188 mc_groups = new_groups;
189 mc_groups[mc_groups_longs] = 0;
194 if (family->netnsok) {
197 netlink_table_grab();
199 for_each_net_rcu(net) {
200 err = __netlink_change_ngroups(net->genl_sock,
201 mc_groups_longs * BITS_PER_LONG);
204 * No need to roll back, can only fail if
205 * memory allocation fails and then the
206 * number of _possible_ groups has been
207 * increased on some sockets which is ok.
210 netlink_table_ungrab();
215 netlink_table_ungrab();
217 err = netlink_change_ngroups(init_net.genl_sock,
218 mc_groups_longs * BITS_PER_LONG);
224 set_bit(id, mc_groups);
225 list_add_tail(&grp->list, &family->mcast_groups);
226 grp->family = family;
228 genl_ctrl_event(CTRL_CMD_NEWMCAST_GRP, grp);
233 EXPORT_SYMBOL(genl_register_mc_group);
235 static void __genl_unregister_mc_group(struct genl_family *family,
236 struct genl_multicast_group *grp)
239 BUG_ON(grp->family != family);
241 netlink_table_grab();
243 for_each_net_rcu(net)
244 __netlink_clear_multicast_users(net->genl_sock, grp->id);
246 netlink_table_ungrab();
248 clear_bit(grp->id, mc_groups);
249 list_del(&grp->list);
250 genl_ctrl_event(CTRL_CMD_DELMCAST_GRP, grp);
256 * genl_unregister_mc_group - unregister a multicast group
258 * Unregisters the specified multicast group and notifies userspace
259 * about it. All current listeners on the group are removed.
261 * Note: It is not necessary to unregister all multicast groups before
262 * unregistering the family, unregistering the family will cause
263 * all assigned multicast groups to be unregistered automatically.
265 * @family: Generic netlink family the group belongs to.
266 * @grp: The group to unregister, must have been registered successfully
269 void genl_unregister_mc_group(struct genl_family *family,
270 struct genl_multicast_group *grp)
273 __genl_unregister_mc_group(family, grp);
276 EXPORT_SYMBOL(genl_unregister_mc_group);
278 static void genl_unregister_mc_groups(struct genl_family *family)
280 struct genl_multicast_group *grp, *tmp;
282 list_for_each_entry_safe(grp, tmp, &family->mcast_groups, list)
283 __genl_unregister_mc_group(family, grp);
286 static int genl_validate_add_ops(struct genl_family *family,
287 const struct genl_ops *ops,
292 for (i = 0; i < n_ops; i++) {
293 if (ops[i].dumpit == NULL && ops[i].doit == NULL)
295 for (j = i + 1; j < n_ops; j++)
296 if (ops[i].cmd == ops[j].cmd)
300 /* family is not registered yet, so no locking needed */
302 family->n_ops = n_ops;
308 * __genl_register_family - register a generic netlink family
309 * @family: generic netlink family
311 * Registers the specified family after validating it first. Only one
312 * family may be registered with the same family name or identifier.
313 * The family id may equal GENL_ID_GENERATE causing an unique id to
314 * be automatically generated and assigned.
316 * Return 0 on success or a negative error code.
318 int __genl_register_family(struct genl_family *family)
322 if (family->id && family->id < GENL_MIN_ID)
325 if (family->id > GENL_MAX_ID)
328 INIT_LIST_HEAD(&family->mcast_groups);
332 if (genl_family_find_byname(family->name)) {
337 if (family->id == GENL_ID_GENERATE) {
338 u16 newid = genl_generate_id();
346 } else if (genl_family_find_byid(family->id)) {
351 if (family->maxattr && !family->parallel_ops) {
352 family->attrbuf = kmalloc((family->maxattr+1) *
353 sizeof(struct nlattr *), GFP_KERNEL);
354 if (family->attrbuf == NULL) {
359 family->attrbuf = NULL;
361 list_add_tail(&family->family_list, genl_family_chain(family->id));
364 genl_ctrl_event(CTRL_CMD_NEWFAMILY, family);
373 EXPORT_SYMBOL(__genl_register_family);
376 * __genl_register_family_with_ops - register a generic netlink family
377 * @family: generic netlink family
378 * @ops: operations to be registered
379 * @n_ops: number of elements to register
381 * Registers the specified family and operations from the specified table.
382 * Only one family may be registered with the same family name or identifier.
384 * The family id may equal GENL_ID_GENERATE causing an unique id to
385 * be automatically generated and assigned.
387 * Either a doit or dumpit callback must be specified for every registered
388 * operation or the function will fail. Only one operation structure per
389 * command identifier may be registered.
391 * See include/net/genetlink.h for more documenation on the operations
394 * Return 0 on success or a negative error code.
396 int __genl_register_family_with_ops(struct genl_family *family,
397 const struct genl_ops *ops, size_t n_ops)
401 err = genl_validate_add_ops(family, ops, n_ops);
405 return __genl_register_family(family);
407 EXPORT_SYMBOL(__genl_register_family_with_ops);
410 * genl_unregister_family - unregister generic netlink family
411 * @family: generic netlink family
413 * Unregisters the specified family.
415 * Returns 0 on success or a negative error code.
417 int genl_unregister_family(struct genl_family *family)
419 struct genl_family *rc;
423 genl_unregister_mc_groups(family);
425 list_for_each_entry(rc, genl_family_chain(family->id), family_list) {
426 if (family->id != rc->id || strcmp(rc->name, family->name))
429 list_del(&rc->family_list);
433 kfree(family->attrbuf);
434 genl_ctrl_event(CTRL_CMD_DELFAMILY, family);
442 EXPORT_SYMBOL(genl_unregister_family);
445 * genlmsg_put - Add generic netlink header to netlink message
446 * @skb: socket buffer holding the message
447 * @portid: netlink portid the message is addressed to
448 * @seq: sequence number (usually the one of the sender)
449 * @family: generic netlink family
450 * @flags: netlink message flags
451 * @cmd: generic netlink command
453 * Returns pointer to user specific header
455 void *genlmsg_put(struct sk_buff *skb, u32 portid, u32 seq,
456 struct genl_family *family, int flags, u8 cmd)
458 struct nlmsghdr *nlh;
459 struct genlmsghdr *hdr;
461 nlh = nlmsg_put(skb, portid, seq, family->id, GENL_HDRLEN +
462 family->hdrsize, flags);
466 hdr = nlmsg_data(nlh);
468 hdr->version = family->version;
471 return (char *) hdr + GENL_HDRLEN;
473 EXPORT_SYMBOL(genlmsg_put);
475 static int genl_lock_dumpit(struct sk_buff *skb, struct netlink_callback *cb)
477 /* our ops are always const - netlink API doesn't propagate that */
478 const struct genl_ops *ops = cb->data;
482 rc = ops->dumpit(skb, cb);
487 static int genl_lock_done(struct netlink_callback *cb)
489 /* our ops are always const - netlink API doesn't propagate that */
490 const struct genl_ops *ops = cb->data;
501 static int genl_family_rcv_msg(struct genl_family *family,
503 struct nlmsghdr *nlh)
505 const struct genl_ops *ops;
506 struct net *net = sock_net(skb->sk);
507 struct genl_info info;
508 struct genlmsghdr *hdr = nlmsg_data(nlh);
509 struct nlattr **attrbuf;
512 /* this family doesn't exist in this netns */
513 if (!family->netnsok && !net_eq(net, &init_net))
516 hdrlen = GENL_HDRLEN + family->hdrsize;
517 if (nlh->nlmsg_len < nlmsg_msg_size(hdrlen))
520 ops = genl_get_cmd(hdr->cmd, family);
524 if ((ops->flags & GENL_ADMIN_PERM) &&
525 !capable(CAP_NET_ADMIN))
528 if ((nlh->nlmsg_flags & NLM_F_DUMP) == NLM_F_DUMP) {
531 if (ops->dumpit == NULL)
534 if (!family->parallel_ops) {
535 struct netlink_dump_control c = {
536 .module = family->module,
537 /* we have const, but the netlink API doesn't */
539 .dump = genl_lock_dumpit,
540 .done = genl_lock_done,
544 rc = __netlink_dump_start(net->genl_sock, skb, nlh, &c);
548 struct netlink_dump_control c = {
549 .module = family->module,
554 rc = __netlink_dump_start(net->genl_sock, skb, nlh, &c);
560 if (ops->doit == NULL)
563 if (family->maxattr && family->parallel_ops) {
564 attrbuf = kmalloc((family->maxattr+1) *
565 sizeof(struct nlattr *), GFP_KERNEL);
569 attrbuf = family->attrbuf;
572 err = nlmsg_parse(nlh, hdrlen, attrbuf, family->maxattr,
578 info.snd_seq = nlh->nlmsg_seq;
579 info.snd_portid = NETLINK_CB(skb).portid;
581 info.genlhdr = nlmsg_data(nlh);
582 info.userhdr = nlmsg_data(nlh) + GENL_HDRLEN;
583 info.attrs = attrbuf;
584 genl_info_net_set(&info, net);
585 memset(&info.user_ptr, 0, sizeof(info.user_ptr));
587 if (family->pre_doit) {
588 err = family->pre_doit(ops, skb, &info);
593 err = ops->doit(skb, &info);
595 if (family->post_doit)
596 family->post_doit(ops, skb, &info);
599 if (family->parallel_ops)
605 static int genl_rcv_msg(struct sk_buff *skb, struct nlmsghdr *nlh)
607 struct genl_family *family;
610 family = genl_family_find_byid(nlh->nlmsg_type);
614 if (!family->parallel_ops)
617 err = genl_family_rcv_msg(family, skb, nlh);
619 if (!family->parallel_ops)
625 static void genl_rcv(struct sk_buff *skb)
628 netlink_rcv_skb(skb, &genl_rcv_msg);
632 /**************************************************************************
634 **************************************************************************/
636 static struct genl_family genl_ctrl = {
640 .maxattr = CTRL_ATTR_MAX,
644 static int ctrl_fill_info(struct genl_family *family, u32 portid, u32 seq,
645 u32 flags, struct sk_buff *skb, u8 cmd)
649 hdr = genlmsg_put(skb, portid, seq, &genl_ctrl, flags, cmd);
653 if (nla_put_string(skb, CTRL_ATTR_FAMILY_NAME, family->name) ||
654 nla_put_u16(skb, CTRL_ATTR_FAMILY_ID, family->id) ||
655 nla_put_u32(skb, CTRL_ATTR_VERSION, family->version) ||
656 nla_put_u32(skb, CTRL_ATTR_HDRSIZE, family->hdrsize) ||
657 nla_put_u32(skb, CTRL_ATTR_MAXATTR, family->maxattr))
658 goto nla_put_failure;
661 struct nlattr *nla_ops;
664 nla_ops = nla_nest_start(skb, CTRL_ATTR_OPS);
666 goto nla_put_failure;
668 for (i = 0; i < family->n_ops; i++) {
670 const struct genl_ops *ops = &family->ops[i];
671 u32 flags = ops->flags;
674 flags |= GENL_CMD_CAP_DUMP;
676 flags |= GENL_CMD_CAP_DO;
678 flags |= GENL_CMD_CAP_HASPOL;
680 nest = nla_nest_start(skb, i + 1);
682 goto nla_put_failure;
684 if (nla_put_u32(skb, CTRL_ATTR_OP_ID, ops->cmd) ||
685 nla_put_u32(skb, CTRL_ATTR_OP_FLAGS, flags))
686 goto nla_put_failure;
688 nla_nest_end(skb, nest);
691 nla_nest_end(skb, nla_ops);
694 if (!list_empty(&family->mcast_groups)) {
695 struct genl_multicast_group *grp;
696 struct nlattr *nla_grps;
699 nla_grps = nla_nest_start(skb, CTRL_ATTR_MCAST_GROUPS);
700 if (nla_grps == NULL)
701 goto nla_put_failure;
703 list_for_each_entry(grp, &family->mcast_groups, list) {
706 nest = nla_nest_start(skb, idx++);
708 goto nla_put_failure;
710 if (nla_put_u32(skb, CTRL_ATTR_MCAST_GRP_ID, grp->id) ||
711 nla_put_string(skb, CTRL_ATTR_MCAST_GRP_NAME,
713 goto nla_put_failure;
715 nla_nest_end(skb, nest);
717 nla_nest_end(skb, nla_grps);
720 return genlmsg_end(skb, hdr);
723 genlmsg_cancel(skb, hdr);
727 static int ctrl_fill_mcgrp_info(struct genl_multicast_group *grp, u32 portid,
728 u32 seq, u32 flags, struct sk_buff *skb,
732 struct nlattr *nla_grps;
735 hdr = genlmsg_put(skb, portid, seq, &genl_ctrl, flags, cmd);
739 if (nla_put_string(skb, CTRL_ATTR_FAMILY_NAME, grp->family->name) ||
740 nla_put_u16(skb, CTRL_ATTR_FAMILY_ID, grp->family->id))
741 goto nla_put_failure;
743 nla_grps = nla_nest_start(skb, CTRL_ATTR_MCAST_GROUPS);
744 if (nla_grps == NULL)
745 goto nla_put_failure;
747 nest = nla_nest_start(skb, 1);
749 goto nla_put_failure;
751 if (nla_put_u32(skb, CTRL_ATTR_MCAST_GRP_ID, grp->id) ||
752 nla_put_string(skb, CTRL_ATTR_MCAST_GRP_NAME,
754 goto nla_put_failure;
756 nla_nest_end(skb, nest);
757 nla_nest_end(skb, nla_grps);
759 return genlmsg_end(skb, hdr);
762 genlmsg_cancel(skb, hdr);
766 static int ctrl_dumpfamily(struct sk_buff *skb, struct netlink_callback *cb)
770 struct genl_family *rt;
771 struct net *net = sock_net(skb->sk);
772 int chains_to_skip = cb->args[0];
773 int fams_to_skip = cb->args[1];
775 for (i = chains_to_skip; i < GENL_FAM_TAB_SIZE; i++) {
777 list_for_each_entry(rt, genl_family_chain(i), family_list) {
778 if (!rt->netnsok && !net_eq(net, &init_net))
780 if (++n < fams_to_skip)
782 if (ctrl_fill_info(rt, NETLINK_CB(cb->skb).portid,
783 cb->nlh->nlmsg_seq, NLM_F_MULTI,
784 skb, CTRL_CMD_NEWFAMILY) < 0)
798 static struct sk_buff *ctrl_build_family_msg(struct genl_family *family,
799 u32 portid, int seq, u8 cmd)
804 skb = nlmsg_new(NLMSG_DEFAULT_SIZE, GFP_KERNEL);
806 return ERR_PTR(-ENOBUFS);
808 err = ctrl_fill_info(family, portid, seq, 0, skb, cmd);
817 static struct sk_buff *ctrl_build_mcgrp_msg(struct genl_multicast_group *grp,
818 u32 portid, int seq, u8 cmd)
823 skb = nlmsg_new(NLMSG_DEFAULT_SIZE, GFP_KERNEL);
825 return ERR_PTR(-ENOBUFS);
827 err = ctrl_fill_mcgrp_info(grp, portid, seq, 0, skb, cmd);
836 static const struct nla_policy ctrl_policy[CTRL_ATTR_MAX+1] = {
837 [CTRL_ATTR_FAMILY_ID] = { .type = NLA_U16 },
838 [CTRL_ATTR_FAMILY_NAME] = { .type = NLA_NUL_STRING,
839 .len = GENL_NAMSIZ - 1 },
842 static int ctrl_getfamily(struct sk_buff *skb, struct genl_info *info)
845 struct genl_family *res = NULL;
848 if (info->attrs[CTRL_ATTR_FAMILY_ID]) {
849 u16 id = nla_get_u16(info->attrs[CTRL_ATTR_FAMILY_ID]);
850 res = genl_family_find_byid(id);
854 if (info->attrs[CTRL_ATTR_FAMILY_NAME]) {
857 name = nla_data(info->attrs[CTRL_ATTR_FAMILY_NAME]);
858 res = genl_family_find_byname(name);
859 #ifdef CONFIG_MODULES
863 request_module("net-pf-%d-proto-%d-family-%s",
864 PF_NETLINK, NETLINK_GENERIC, name);
867 res = genl_family_find_byname(name);
876 if (!res->netnsok && !net_eq(genl_info_net(info), &init_net)) {
877 /* family doesn't exist here */
881 msg = ctrl_build_family_msg(res, info->snd_portid, info->snd_seq,
886 return genlmsg_reply(msg, info);
889 static int genl_ctrl_event(int event, void *data)
892 struct genl_family *family;
893 struct genl_multicast_group *grp;
895 /* genl is still initialising */
896 if (!init_net.genl_sock)
900 case CTRL_CMD_NEWFAMILY:
901 case CTRL_CMD_DELFAMILY:
903 msg = ctrl_build_family_msg(family, 0, 0, event);
905 case CTRL_CMD_NEWMCAST_GRP:
906 case CTRL_CMD_DELMCAST_GRP:
908 family = grp->family;
909 msg = ctrl_build_mcgrp_msg(data, 0, 0, event);
918 if (!family->netnsok) {
919 genlmsg_multicast_netns(&init_net, msg, 0,
920 GENL_ID_CTRL, GFP_KERNEL);
923 genlmsg_multicast_allns(msg, 0, GENL_ID_CTRL, GFP_ATOMIC);
930 static struct genl_ops genl_ctrl_ops = {
931 .cmd = CTRL_CMD_GETFAMILY,
932 .doit = ctrl_getfamily,
933 .dumpit = ctrl_dumpfamily,
934 .policy = ctrl_policy,
937 static struct genl_multicast_group notify_grp = {
941 static int __net_init genl_pernet_init(struct net *net)
943 struct netlink_kernel_cfg cfg = {
945 .flags = NL_CFG_F_NONROOT_RECV,
948 /* we'll bump the group number right afterwards */
949 net->genl_sock = netlink_kernel_create(net, NETLINK_GENERIC, &cfg);
951 if (!net->genl_sock && net_eq(net, &init_net))
952 panic("GENL: Cannot initialize generic netlink\n");
960 static void __net_exit genl_pernet_exit(struct net *net)
962 netlink_kernel_release(net->genl_sock);
963 net->genl_sock = NULL;
966 static struct pernet_operations genl_pernet_ops = {
967 .init = genl_pernet_init,
968 .exit = genl_pernet_exit,
971 static int __init genl_init(void)
975 for (i = 0; i < GENL_FAM_TAB_SIZE; i++)
976 INIT_LIST_HEAD(&family_ht[i]);
978 err = genl_register_family_with_ops(&genl_ctrl, &genl_ctrl_ops, 1);
982 err = register_pernet_subsys(&genl_pernet_ops);
986 err = genl_register_mc_group(&genl_ctrl, ¬ify_grp);
993 panic("GENL: Cannot register controller: %d\n", err);
996 subsys_initcall(genl_init);
998 static int genlmsg_mcast(struct sk_buff *skb, u32 portid, unsigned long group,
1001 struct sk_buff *tmp;
1002 struct net *net, *prev = NULL;
1005 for_each_net_rcu(net) {
1007 tmp = skb_clone(skb, flags);
1012 err = nlmsg_multicast(prev->genl_sock, tmp,
1013 portid, group, flags);
1021 return nlmsg_multicast(prev->genl_sock, skb, portid, group, flags);
1027 int genlmsg_multicast_allns(struct sk_buff *skb, u32 portid, unsigned int group,
1030 return genlmsg_mcast(skb, portid, group, flags);
1032 EXPORT_SYMBOL(genlmsg_multicast_allns);
1034 void genl_notify(struct sk_buff *skb, struct net *net, u32 portid, u32 group,
1035 struct nlmsghdr *nlh, gfp_t flags)
1037 struct sock *sk = net->genl_sock;
1041 report = nlmsg_report(nlh);
1043 nlmsg_notify(sk, skb, portid, group, report, flags);
1045 EXPORT_SYMBOL(genl_notify);