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/errno.h>
12 #include <linux/types.h>
13 #include <linux/socket.h>
14 #include <linux/string.h>
15 #include <linux/skbuff.h>
16 #include <linux/mutex.h>
17 #include <linux/bitmap.h>
19 #include <net/genetlink.h>
21 static DEFINE_MUTEX(genl_mutex
); /* serialization of message processing */
23 static inline void genl_lock(void)
25 mutex_lock(&genl_mutex
);
28 static inline void genl_unlock(void)
30 mutex_unlock(&genl_mutex
);
33 #define GENL_FAM_TAB_SIZE 16
34 #define GENL_FAM_TAB_MASK (GENL_FAM_TAB_SIZE - 1)
36 static struct list_head family_ht
[GENL_FAM_TAB_SIZE
];
38 * Bitmap of multicast groups that are currently in use.
40 * To avoid an allocation at boot of just one unsigned long,
41 * declare it global instead.
42 * Bit 0 is marked as already used since group 0 is invalid.
44 static unsigned long mc_group_start
= 0x1;
45 static unsigned long *mc_groups
= &mc_group_start
;
46 static unsigned long mc_groups_longs
= 1;
48 static int genl_ctrl_event(int event
, void *data
);
50 static inline unsigned int genl_family_hash(unsigned int id
)
52 return id
& GENL_FAM_TAB_MASK
;
55 static inline struct list_head
*genl_family_chain(unsigned int id
)
57 return &family_ht
[genl_family_hash(id
)];
60 static struct genl_family
*genl_family_find_byid(unsigned int id
)
62 struct genl_family
*f
;
64 list_for_each_entry(f
, genl_family_chain(id
), family_list
)
71 static struct genl_family
*genl_family_find_byname(char *name
)
73 struct genl_family
*f
;
76 for (i
= 0; i
< GENL_FAM_TAB_SIZE
; i
++)
77 list_for_each_entry(f
, genl_family_chain(i
), family_list
)
78 if (strcmp(f
->name
, name
) == 0)
84 static struct genl_ops
*genl_get_cmd(u8 cmd
, struct genl_family
*family
)
88 list_for_each_entry(ops
, &family
->ops_list
, ops_list
)
95 /* Of course we are going to have problems once we hit
96 * 2^16 alive types, but that can only happen by year 2K
98 static inline u16
genl_generate_id(void)
100 static u16 id_gen_idx
= GENL_MIN_ID
;
103 for (i
= 0; i
<= GENL_MAX_ID
- GENL_MIN_ID
; i
++) {
104 if (!genl_family_find_byid(id_gen_idx
))
106 if (++id_gen_idx
> GENL_MAX_ID
)
107 id_gen_idx
= GENL_MIN_ID
;
113 static struct genl_multicast_group notify_grp
;
116 * genl_register_mc_group - register a multicast group
118 * Registers the specified multicast group and notifies userspace
119 * about the new group.
121 * Returns 0 on success or a negative error code.
123 * @family: The generic netlink family the group shall be registered for.
124 * @grp: The group to register, must have a name.
126 int genl_register_mc_group(struct genl_family
*family
,
127 struct genl_multicast_group
*grp
)
130 unsigned long *new_groups
;
133 BUG_ON(grp
->name
[0] == '\0');
137 /* special-case our own group */
138 if (grp
== ¬ify_grp
)
141 id
= find_first_zero_bit(mc_groups
,
142 mc_groups_longs
* BITS_PER_LONG
);
145 if (id
>= mc_groups_longs
* BITS_PER_LONG
) {
146 size_t nlen
= (mc_groups_longs
+ 1) * sizeof(unsigned long);
148 if (mc_groups
== &mc_group_start
) {
149 new_groups
= kzalloc(nlen
, GFP_KERNEL
);
154 mc_groups
= new_groups
;
155 *mc_groups
= mc_group_start
;
157 new_groups
= krealloc(mc_groups
, nlen
, GFP_KERNEL
);
162 mc_groups
= new_groups
;
163 mc_groups
[mc_groups_longs
] = 0;
168 if (family
->netnsok
) {
171 netlink_table_grab();
173 for_each_net_rcu(net
) {
174 err
= __netlink_change_ngroups(net
->genl_sock
,
175 mc_groups_longs
* BITS_PER_LONG
);
178 * No need to roll back, can only fail if
179 * memory allocation fails and then the
180 * number of _possible_ groups has been
181 * increased on some sockets which is ok.
184 netlink_table_ungrab();
189 netlink_table_ungrab();
191 err
= netlink_change_ngroups(init_net
.genl_sock
,
192 mc_groups_longs
* BITS_PER_LONG
);
198 set_bit(id
, mc_groups
);
199 list_add_tail(&grp
->list
, &family
->mcast_groups
);
200 grp
->family
= family
;
202 genl_ctrl_event(CTRL_CMD_NEWMCAST_GRP
, grp
);
207 EXPORT_SYMBOL(genl_register_mc_group
);
209 static void __genl_unregister_mc_group(struct genl_family
*family
,
210 struct genl_multicast_group
*grp
)
213 BUG_ON(grp
->family
!= family
);
215 netlink_table_grab();
217 for_each_net_rcu(net
)
218 __netlink_clear_multicast_users(net
->genl_sock
, grp
->id
);
220 netlink_table_ungrab();
222 clear_bit(grp
->id
, mc_groups
);
223 list_del(&grp
->list
);
224 genl_ctrl_event(CTRL_CMD_DELMCAST_GRP
, grp
);
230 * genl_unregister_mc_group - unregister a multicast group
232 * Unregisters the specified multicast group and notifies userspace
233 * about it. All current listeners on the group are removed.
235 * Note: It is not necessary to unregister all multicast groups before
236 * unregistering the family, unregistering the family will cause
237 * all assigned multicast groups to be unregistered automatically.
239 * @family: Generic netlink family the group belongs to.
240 * @grp: The group to unregister, must have been registered successfully
243 void genl_unregister_mc_group(struct genl_family
*family
,
244 struct genl_multicast_group
*grp
)
247 __genl_unregister_mc_group(family
, grp
);
250 EXPORT_SYMBOL(genl_unregister_mc_group
);
252 static void genl_unregister_mc_groups(struct genl_family
*family
)
254 struct genl_multicast_group
*grp
, *tmp
;
256 list_for_each_entry_safe(grp
, tmp
, &family
->mcast_groups
, list
)
257 __genl_unregister_mc_group(family
, grp
);
261 * genl_register_ops - register generic netlink operations
262 * @family: generic netlink family
263 * @ops: operations to be registered
265 * Registers the specified operations and assigns them to the specified
266 * family. Either a doit or dumpit callback must be specified or the
267 * operation will fail. Only one operation structure per command
268 * identifier may be registered.
270 * See include/net/genetlink.h for more documenation on the operations
273 * Returns 0 on success or a negative error code.
275 int genl_register_ops(struct genl_family
*family
, struct genl_ops
*ops
)
279 if (ops
->dumpit
== NULL
&& ops
->doit
== NULL
)
282 if (genl_get_cmd(ops
->cmd
, family
)) {
288 ops
->flags
|= GENL_CMD_CAP_DUMP
;
290 ops
->flags
|= GENL_CMD_CAP_DO
;
292 ops
->flags
|= GENL_CMD_CAP_HASPOL
;
295 list_add_tail(&ops
->ops_list
, &family
->ops_list
);
298 genl_ctrl_event(CTRL_CMD_NEWOPS
, ops
);
305 * genl_unregister_ops - unregister generic netlink operations
306 * @family: generic netlink family
307 * @ops: operations to be unregistered
309 * Unregisters the specified operations and unassigns them from the
310 * specified family. The operation blocks until the current message
311 * processing has finished and doesn't start again until the
312 * unregister process has finished.
314 * Note: It is not necessary to unregister all operations before
315 * unregistering the family, unregistering the family will cause
316 * all assigned operations to be unregistered automatically.
318 * Returns 0 on success or a negative error code.
320 int genl_unregister_ops(struct genl_family
*family
, struct genl_ops
*ops
)
325 list_for_each_entry(rc
, &family
->ops_list
, ops_list
) {
327 list_del(&ops
->ops_list
);
329 genl_ctrl_event(CTRL_CMD_DELOPS
, ops
);
339 * genl_register_family - register a generic netlink family
340 * @family: generic netlink family
342 * Registers the specified family after validating it first. Only one
343 * family may be registered with the same family name or identifier.
344 * The family id may equal GENL_ID_GENERATE causing an unique id to
345 * be automatically generated and assigned.
347 * Return 0 on success or a negative error code.
349 int genl_register_family(struct genl_family
*family
)
353 if (family
->id
&& family
->id
< GENL_MIN_ID
)
356 if (family
->id
> GENL_MAX_ID
)
359 INIT_LIST_HEAD(&family
->ops_list
);
360 INIT_LIST_HEAD(&family
->mcast_groups
);
364 if (genl_family_find_byname(family
->name
)) {
369 if (family
->id
== GENL_ID_GENERATE
) {
370 u16 newid
= genl_generate_id();
378 } else if (genl_family_find_byid(family
->id
)) {
383 if (family
->maxattr
) {
384 family
->attrbuf
= kmalloc((family
->maxattr
+1) *
385 sizeof(struct nlattr
*), GFP_KERNEL
);
386 if (family
->attrbuf
== NULL
) {
391 family
->attrbuf
= NULL
;
393 list_add_tail(&family
->family_list
, genl_family_chain(family
->id
));
396 genl_ctrl_event(CTRL_CMD_NEWFAMILY
, family
);
407 * genl_register_family_with_ops - register a generic netlink family
408 * @family: generic netlink family
409 * @ops: operations to be registered
410 * @n_ops: number of elements to register
412 * Registers the specified family and operations from the specified table.
413 * Only one family may be registered with the same family name or identifier.
415 * The family id may equal GENL_ID_GENERATE causing an unique id to
416 * be automatically generated and assigned.
418 * Either a doit or dumpit callback must be specified for every registered
419 * operation or the function will fail. Only one operation structure per
420 * command identifier may be registered.
422 * See include/net/genetlink.h for more documenation on the operations
425 * This is equivalent to calling genl_register_family() followed by
426 * genl_register_ops() for every operation entry in the table taking
427 * care to unregister the family on error path.
429 * Return 0 on success or a negative error code.
431 int genl_register_family_with_ops(struct genl_family
*family
,
432 struct genl_ops
*ops
, size_t n_ops
)
436 err
= genl_register_family(family
);
440 for (i
= 0; i
< n_ops
; ++i
, ++ops
) {
441 err
= genl_register_ops(family
, ops
);
447 genl_unregister_family(family
);
450 EXPORT_SYMBOL(genl_register_family_with_ops
);
453 * genl_unregister_family - unregister generic netlink family
454 * @family: generic netlink family
456 * Unregisters the specified family.
458 * Returns 0 on success or a negative error code.
460 int genl_unregister_family(struct genl_family
*family
)
462 struct genl_family
*rc
;
466 genl_unregister_mc_groups(family
);
468 list_for_each_entry(rc
, genl_family_chain(family
->id
), family_list
) {
469 if (family
->id
!= rc
->id
|| strcmp(rc
->name
, family
->name
))
472 list_del(&rc
->family_list
);
473 INIT_LIST_HEAD(&family
->ops_list
);
476 kfree(family
->attrbuf
);
477 genl_ctrl_event(CTRL_CMD_DELFAMILY
, family
);
486 static int genl_rcv_msg(struct sk_buff
*skb
, struct nlmsghdr
*nlh
)
488 struct genl_ops
*ops
;
489 struct genl_family
*family
;
490 struct net
*net
= sock_net(skb
->sk
);
491 struct genl_info info
;
492 struct genlmsghdr
*hdr
= nlmsg_data(nlh
);
495 family
= genl_family_find_byid(nlh
->nlmsg_type
);
499 /* this family doesn't exist in this netns */
500 if (!family
->netnsok
&& !net_eq(net
, &init_net
))
503 hdrlen
= GENL_HDRLEN
+ family
->hdrsize
;
504 if (nlh
->nlmsg_len
< nlmsg_msg_size(hdrlen
))
507 ops
= genl_get_cmd(hdr
->cmd
, family
);
511 if ((ops
->flags
& GENL_ADMIN_PERM
) &&
512 security_netlink_recv(skb
, CAP_NET_ADMIN
))
515 if (nlh
->nlmsg_flags
& NLM_F_DUMP
) {
516 if (ops
->dumpit
== NULL
)
520 err
= netlink_dump_start(net
->genl_sock
, skb
, nlh
,
521 ops
->dumpit
, ops
->done
);
526 if (ops
->doit
== NULL
)
529 if (family
->attrbuf
) {
530 err
= nlmsg_parse(nlh
, hdrlen
, family
->attrbuf
, family
->maxattr
,
536 info
.snd_seq
= nlh
->nlmsg_seq
;
537 info
.snd_pid
= NETLINK_CB(skb
).pid
;
539 info
.genlhdr
= nlmsg_data(nlh
);
540 info
.userhdr
= nlmsg_data(nlh
) + GENL_HDRLEN
;
541 info
.attrs
= family
->attrbuf
;
542 genl_info_net_set(&info
, net
);
544 return ops
->doit(skb
, &info
);
547 static void genl_rcv(struct sk_buff
*skb
)
550 netlink_rcv_skb(skb
, &genl_rcv_msg
);
554 /**************************************************************************
556 **************************************************************************/
558 static struct genl_family genl_ctrl
= {
562 .maxattr
= CTRL_ATTR_MAX
,
566 static int ctrl_fill_info(struct genl_family
*family
, u32 pid
, u32 seq
,
567 u32 flags
, struct sk_buff
*skb
, u8 cmd
)
571 hdr
= genlmsg_put(skb
, pid
, seq
, &genl_ctrl
, flags
, cmd
);
575 NLA_PUT_STRING(skb
, CTRL_ATTR_FAMILY_NAME
, family
->name
);
576 NLA_PUT_U16(skb
, CTRL_ATTR_FAMILY_ID
, family
->id
);
577 NLA_PUT_U32(skb
, CTRL_ATTR_VERSION
, family
->version
);
578 NLA_PUT_U32(skb
, CTRL_ATTR_HDRSIZE
, family
->hdrsize
);
579 NLA_PUT_U32(skb
, CTRL_ATTR_MAXATTR
, family
->maxattr
);
581 if (!list_empty(&family
->ops_list
)) {
582 struct nlattr
*nla_ops
;
583 struct genl_ops
*ops
;
586 nla_ops
= nla_nest_start(skb
, CTRL_ATTR_OPS
);
588 goto nla_put_failure
;
590 list_for_each_entry(ops
, &family
->ops_list
, ops_list
) {
593 nest
= nla_nest_start(skb
, idx
++);
595 goto nla_put_failure
;
597 NLA_PUT_U32(skb
, CTRL_ATTR_OP_ID
, ops
->cmd
);
598 NLA_PUT_U32(skb
, CTRL_ATTR_OP_FLAGS
, ops
->flags
);
600 nla_nest_end(skb
, nest
);
603 nla_nest_end(skb
, nla_ops
);
606 if (!list_empty(&family
->mcast_groups
)) {
607 struct genl_multicast_group
*grp
;
608 struct nlattr
*nla_grps
;
611 nla_grps
= nla_nest_start(skb
, CTRL_ATTR_MCAST_GROUPS
);
612 if (nla_grps
== NULL
)
613 goto nla_put_failure
;
615 list_for_each_entry(grp
, &family
->mcast_groups
, list
) {
618 nest
= nla_nest_start(skb
, idx
++);
620 goto nla_put_failure
;
622 NLA_PUT_U32(skb
, CTRL_ATTR_MCAST_GRP_ID
, grp
->id
);
623 NLA_PUT_STRING(skb
, CTRL_ATTR_MCAST_GRP_NAME
,
626 nla_nest_end(skb
, nest
);
628 nla_nest_end(skb
, nla_grps
);
631 return genlmsg_end(skb
, hdr
);
634 genlmsg_cancel(skb
, hdr
);
638 static int ctrl_fill_mcgrp_info(struct genl_multicast_group
*grp
, u32 pid
,
639 u32 seq
, u32 flags
, struct sk_buff
*skb
,
643 struct nlattr
*nla_grps
;
646 hdr
= genlmsg_put(skb
, pid
, seq
, &genl_ctrl
, flags
, cmd
);
650 NLA_PUT_STRING(skb
, CTRL_ATTR_FAMILY_NAME
, grp
->family
->name
);
651 NLA_PUT_U16(skb
, CTRL_ATTR_FAMILY_ID
, grp
->family
->id
);
653 nla_grps
= nla_nest_start(skb
, CTRL_ATTR_MCAST_GROUPS
);
654 if (nla_grps
== NULL
)
655 goto nla_put_failure
;
657 nest
= nla_nest_start(skb
, 1);
659 goto nla_put_failure
;
661 NLA_PUT_U32(skb
, CTRL_ATTR_MCAST_GRP_ID
, grp
->id
);
662 NLA_PUT_STRING(skb
, CTRL_ATTR_MCAST_GRP_NAME
,
665 nla_nest_end(skb
, nest
);
666 nla_nest_end(skb
, nla_grps
);
668 return genlmsg_end(skb
, hdr
);
671 genlmsg_cancel(skb
, hdr
);
675 static int ctrl_dumpfamily(struct sk_buff
*skb
, struct netlink_callback
*cb
)
679 struct genl_family
*rt
;
680 struct net
*net
= sock_net(skb
->sk
);
681 int chains_to_skip
= cb
->args
[0];
682 int fams_to_skip
= cb
->args
[1];
684 for (i
= 0; i
< GENL_FAM_TAB_SIZE
; i
++) {
685 if (i
< chains_to_skip
)
688 list_for_each_entry(rt
, genl_family_chain(i
), family_list
) {
689 if (!rt
->netnsok
&& !net_eq(net
, &init_net
))
691 if (++n
< fams_to_skip
)
693 if (ctrl_fill_info(rt
, NETLINK_CB(cb
->skb
).pid
,
694 cb
->nlh
->nlmsg_seq
, NLM_F_MULTI
,
695 skb
, CTRL_CMD_NEWFAMILY
) < 0)
709 static struct sk_buff
*ctrl_build_family_msg(struct genl_family
*family
,
710 u32 pid
, int seq
, u8 cmd
)
715 skb
= nlmsg_new(NLMSG_DEFAULT_SIZE
, GFP_KERNEL
);
717 return ERR_PTR(-ENOBUFS
);
719 err
= ctrl_fill_info(family
, pid
, seq
, 0, skb
, cmd
);
728 static struct sk_buff
*ctrl_build_mcgrp_msg(struct genl_multicast_group
*grp
,
729 u32 pid
, int seq
, u8 cmd
)
734 skb
= nlmsg_new(NLMSG_DEFAULT_SIZE
, GFP_KERNEL
);
736 return ERR_PTR(-ENOBUFS
);
738 err
= ctrl_fill_mcgrp_info(grp
, pid
, seq
, 0, skb
, cmd
);
747 static const struct nla_policy ctrl_policy
[CTRL_ATTR_MAX
+1] = {
748 [CTRL_ATTR_FAMILY_ID
] = { .type
= NLA_U16
},
749 [CTRL_ATTR_FAMILY_NAME
] = { .type
= NLA_NUL_STRING
,
750 .len
= GENL_NAMSIZ
- 1 },
753 static int ctrl_getfamily(struct sk_buff
*skb
, struct genl_info
*info
)
756 struct genl_family
*res
= NULL
;
759 if (info
->attrs
[CTRL_ATTR_FAMILY_ID
]) {
760 u16 id
= nla_get_u16(info
->attrs
[CTRL_ATTR_FAMILY_ID
]);
761 res
= genl_family_find_byid(id
);
765 if (info
->attrs
[CTRL_ATTR_FAMILY_NAME
]) {
768 name
= nla_data(info
->attrs
[CTRL_ATTR_FAMILY_NAME
]);
769 res
= genl_family_find_byname(name
);
776 if (!res
->netnsok
&& !net_eq(genl_info_net(info
), &init_net
)) {
777 /* family doesn't exist here */
781 msg
= ctrl_build_family_msg(res
, info
->snd_pid
, info
->snd_seq
,
786 return genlmsg_reply(msg
, info
);
789 static int genl_ctrl_event(int event
, void *data
)
792 struct genl_family
*family
;
793 struct genl_multicast_group
*grp
;
795 /* genl is still initialising */
796 if (!init_net
.genl_sock
)
800 case CTRL_CMD_NEWFAMILY
:
801 case CTRL_CMD_DELFAMILY
:
803 msg
= ctrl_build_family_msg(family
, 0, 0, event
);
805 case CTRL_CMD_NEWMCAST_GRP
:
806 case CTRL_CMD_DELMCAST_GRP
:
808 family
= grp
->family
;
809 msg
= ctrl_build_mcgrp_msg(data
, 0, 0, event
);
818 if (!family
->netnsok
) {
819 genlmsg_multicast_netns(&init_net
, msg
, 0,
820 GENL_ID_CTRL
, GFP_KERNEL
);
823 genlmsg_multicast_allns(msg
, 0, GENL_ID_CTRL
, GFP_ATOMIC
);
830 static struct genl_ops genl_ctrl_ops
= {
831 .cmd
= CTRL_CMD_GETFAMILY
,
832 .doit
= ctrl_getfamily
,
833 .dumpit
= ctrl_dumpfamily
,
834 .policy
= ctrl_policy
,
837 static struct genl_multicast_group notify_grp
= {
841 static int __net_init
genl_pernet_init(struct net
*net
)
843 /* we'll bump the group number right afterwards */
844 net
->genl_sock
= netlink_kernel_create(net
, NETLINK_GENERIC
, 0,
845 genl_rcv
, &genl_mutex
,
848 if (!net
->genl_sock
&& net_eq(net
, &init_net
))
849 panic("GENL: Cannot initialize generic netlink\n");
857 static void __net_exit
genl_pernet_exit(struct net
*net
)
859 netlink_kernel_release(net
->genl_sock
);
860 net
->genl_sock
= NULL
;
863 static struct pernet_operations genl_pernet_ops
= {
864 .init
= genl_pernet_init
,
865 .exit
= genl_pernet_exit
,
868 static int __init
genl_init(void)
872 for (i
= 0; i
< GENL_FAM_TAB_SIZE
; i
++)
873 INIT_LIST_HEAD(&family_ht
[i
]);
875 err
= genl_register_family(&genl_ctrl
);
879 err
= genl_register_ops(&genl_ctrl
, &genl_ctrl_ops
);
883 netlink_set_nonroot(NETLINK_GENERIC
, NL_NONROOT_RECV
);
885 err
= register_pernet_subsys(&genl_pernet_ops
);
889 err
= genl_register_mc_group(&genl_ctrl
, ¬ify_grp
);
896 panic("GENL: Cannot register controller: %d\n", err
);
899 subsys_initcall(genl_init
);
901 EXPORT_SYMBOL(genl_register_ops
);
902 EXPORT_SYMBOL(genl_unregister_ops
);
903 EXPORT_SYMBOL(genl_register_family
);
904 EXPORT_SYMBOL(genl_unregister_family
);
906 static int genlmsg_mcast(struct sk_buff
*skb
, u32 pid
, unsigned long group
,
910 struct net
*net
, *prev
= NULL
;
913 for_each_net_rcu(net
) {
915 tmp
= skb_clone(skb
, flags
);
920 err
= nlmsg_multicast(prev
->genl_sock
, tmp
,
929 return nlmsg_multicast(prev
->genl_sock
, skb
, pid
, group
, flags
);
935 int genlmsg_multicast_allns(struct sk_buff
*skb
, u32 pid
, unsigned int group
,
938 return genlmsg_mcast(skb
, pid
, group
, flags
);
940 EXPORT_SYMBOL(genlmsg_multicast_allns
);