blob: d444daf1ac0458885cf714523f6b11b7f4ec7287 [file] [log] [blame]
Greg Kroah-Hartmanb2441312017-11-01 15:07:57 +01001// SPDX-License-Identifier: GPL-2.0
Thomas Graf482a8522005-11-10 02:25:56 +01002/*
3 * NETLINK Generic Netlink Family
4 *
5 * Authors: Jamal Hadi Salim
6 * Thomas Graf <tgraf@suug.ch>
Johannes Berg2dbba6f2007-07-18 15:47:52 -07007 * Johannes Berg <johannes@sipsolutions.net>
Thomas Graf482a8522005-11-10 02:25:56 +01008 */
9
Thomas Graf482a8522005-11-10 02:25:56 +010010#include <linux/module.h>
11#include <linux/kernel.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090012#include <linux/slab.h>
Thomas Graf482a8522005-11-10 02:25:56 +010013#include <linux/errno.h>
14#include <linux/types.h>
15#include <linux/socket.h>
16#include <linux/string.h>
17#include <linux/skbuff.h>
Ingo Molnar14cc3e22006-03-26 01:37:14 -080018#include <linux/mutex.h>
Johannes Berg2dbba6f2007-07-18 15:47:52 -070019#include <linux/bitmap.h>
Pravin B Shelardef31172013-04-23 07:48:30 +000020#include <linux/rwsem.h>
Johannes Berg2ae0f172016-10-24 14:40:04 +020021#include <linux/idr.h>
Thomas Graf482a8522005-11-10 02:25:56 +010022#include <net/sock.h>
23#include <net/genetlink.h>
24
Ingo Molnar14cc3e22006-03-26 01:37:14 -080025static DEFINE_MUTEX(genl_mutex); /* serialization of message processing */
Pravin B Shelardef31172013-04-23 07:48:30 +000026static DECLARE_RWSEM(cb_lock);
Thomas Graf482a8522005-11-10 02:25:56 +010027
Johannes Bergee1c24422015-01-16 11:37:14 +010028atomic_t genl_sk_destructing_cnt = ATOMIC_INIT(0);
29DECLARE_WAIT_QUEUE_HEAD(genl_sk_destructing_waitq);
30
James Chapmanf408e0c2010-04-02 06:19:05 +000031void genl_lock(void)
Thomas Graf482a8522005-11-10 02:25:56 +010032{
Ingo Molnar14cc3e22006-03-26 01:37:14 -080033 mutex_lock(&genl_mutex);
Thomas Graf482a8522005-11-10 02:25:56 +010034}
James Chapmanf408e0c2010-04-02 06:19:05 +000035EXPORT_SYMBOL(genl_lock);
Thomas Graf482a8522005-11-10 02:25:56 +010036
James Chapmanf408e0c2010-04-02 06:19:05 +000037void genl_unlock(void)
Thomas Graf482a8522005-11-10 02:25:56 +010038{
Ingo Molnar14cc3e22006-03-26 01:37:14 -080039 mutex_unlock(&genl_mutex);
Thomas Graf482a8522005-11-10 02:25:56 +010040}
James Chapmanf408e0c2010-04-02 06:19:05 +000041EXPORT_SYMBOL(genl_unlock);
Thomas Graf482a8522005-11-10 02:25:56 +010042
WANG Cong320f5ea2012-07-24 13:44:01 +080043#ifdef CONFIG_LOCKDEP
Yaowei Bai61d03532015-10-08 21:28:54 +080044bool lockdep_genl_is_held(void)
Pravin B Shelar86b13092011-11-10 19:14:51 -080045{
46 return lockdep_is_held(&genl_mutex);
47}
48EXPORT_SYMBOL(lockdep_genl_is_held);
49#endif
50
Pravin B Shelardef31172013-04-23 07:48:30 +000051static void genl_lock_all(void)
52{
53 down_write(&cb_lock);
54 genl_lock();
55}
56
57static void genl_unlock_all(void)
58{
59 genl_unlock();
60 up_write(&cb_lock);
61}
62
Johannes Berg2ae0f172016-10-24 14:40:04 +020063static DEFINE_IDR(genl_fam_idr);
Thomas Graf482a8522005-11-10 02:25:56 +010064
Johannes Berg2dbba6f2007-07-18 15:47:52 -070065/*
66 * Bitmap of multicast groups that are currently in use.
67 *
68 * To avoid an allocation at boot of just one unsigned long,
69 * declare it global instead.
70 * Bit 0 is marked as already used since group 0 is invalid.
Johannes Berge5dcecb2013-11-19 15:19:32 +010071 * Bit 1 is marked as already used since the drop-monitor code
72 * abuses the API and thinks it can statically use group 1.
73 * That group will typically conflict with other groups that
74 * any proper users use.
Johannes Berg2a94fe42013-11-19 15:19:39 +010075 * Bit 16 is marked as used since it's used for generic netlink
76 * and the code no longer marks pre-reserved IDs as used.
Johannes Berg2ecf7532013-11-19 15:19:33 +010077 * Bit 17 is marked as already used since the VFS quota code
78 * also abused this API and relied on family == group ID, we
79 * cater to that by giving it a static family and group ID.
Johannes Berg5e53e682013-11-24 21:09:26 +010080 * Bit 18 is marked as already used since the PMCRAID driver
81 * did the same thing as the VFS quota code (maybe copied?)
Johannes Berg2dbba6f2007-07-18 15:47:52 -070082 */
Johannes Berg2a94fe42013-11-19 15:19:39 +010083static unsigned long mc_group_start = 0x3 | BIT(GENL_ID_CTRL) |
Johannes Berg5e53e682013-11-24 21:09:26 +010084 BIT(GENL_ID_VFS_DQUOT) |
85 BIT(GENL_ID_PMCRAID);
Johannes Berg2dbba6f2007-07-18 15:47:52 -070086static unsigned long *mc_groups = &mc_group_start;
87static unsigned long mc_groups_longs = 1;
Thomas Graf482a8522005-11-10 02:25:56 +010088
Johannes Berg2ae0f172016-10-24 14:40:04 +020089static int genl_ctrl_event(int event, const struct genl_family *family,
Johannes Berg2a94fe42013-11-19 15:19:39 +010090 const struct genl_multicast_group *grp,
91 int grp_id);
Thomas Graf482a8522005-11-10 02:25:56 +010092
Johannes Berg2ae0f172016-10-24 14:40:04 +020093static const struct genl_family *genl_family_find_byid(unsigned int id)
Thomas Graf482a8522005-11-10 02:25:56 +010094{
Johannes Berg2ae0f172016-10-24 14:40:04 +020095 return idr_find(&genl_fam_idr, id);
Thomas Graf482a8522005-11-10 02:25:56 +010096}
97
Johannes Berg2ae0f172016-10-24 14:40:04 +020098static const struct genl_family *genl_family_find_byname(char *name)
Thomas Graf482a8522005-11-10 02:25:56 +010099{
Johannes Berg2ae0f172016-10-24 14:40:04 +0200100 const struct genl_family *family;
101 unsigned int id;
Thomas Graf482a8522005-11-10 02:25:56 +0100102
Johannes Berg2ae0f172016-10-24 14:40:04 +0200103 idr_for_each_entry(&genl_fam_idr, family, id)
104 if (strcmp(family->name, name) == 0)
105 return family;
Thomas Graf482a8522005-11-10 02:25:56 +0100106
107 return NULL;
108}
109
Johannes Berg2ae0f172016-10-24 14:40:04 +0200110static const struct genl_ops *genl_get_cmd(u8 cmd,
111 const struct genl_family *family)
Thomas Graf482a8522005-11-10 02:25:56 +0100112{
Johannes Bergd91824c2013-11-14 17:14:44 +0100113 int i;
Thomas Graf482a8522005-11-10 02:25:56 +0100114
Johannes Bergd91824c2013-11-14 17:14:44 +0100115 for (i = 0; i < family->n_ops; i++)
116 if (family->ops[i].cmd == cmd)
117 return &family->ops[i];
Thomas Graf482a8522005-11-10 02:25:56 +0100118
119 return NULL;
120}
121
Johannes Berg2a94fe42013-11-19 15:19:39 +0100122static int genl_allocate_reserve_groups(int n_groups, int *first_id)
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700123{
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700124 unsigned long *new_groups;
Johannes Berg2a94fe42013-11-19 15:19:39 +0100125 int start = 0;
126 int i;
127 int id;
128 bool fits;
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700129
Johannes Berg2a94fe42013-11-19 15:19:39 +0100130 do {
131 if (start == 0)
132 id = find_first_zero_bit(mc_groups,
133 mc_groups_longs *
134 BITS_PER_LONG);
135 else
136 id = find_next_zero_bit(mc_groups,
137 mc_groups_longs * BITS_PER_LONG,
138 start);
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700139
Johannes Berg2a94fe42013-11-19 15:19:39 +0100140 fits = true;
141 for (i = id;
142 i < min_t(int, id + n_groups,
143 mc_groups_longs * BITS_PER_LONG);
144 i++) {
145 if (test_bit(i, mc_groups)) {
146 start = i;
147 fits = false;
148 break;
149 }
150 }
151
David S. Millerb8e429a2016-01-13 10:28:06 -0500152 if (id + n_groups > mc_groups_longs * BITS_PER_LONG) {
Johannes Berg2a94fe42013-11-19 15:19:39 +0100153 unsigned long new_longs = mc_groups_longs +
154 BITS_TO_LONGS(n_groups);
155 size_t nlen = new_longs * sizeof(unsigned long);
156
157 if (mc_groups == &mc_group_start) {
158 new_groups = kzalloc(nlen, GFP_KERNEL);
159 if (!new_groups)
160 return -ENOMEM;
161 mc_groups = new_groups;
162 *mc_groups = mc_group_start;
163 } else {
164 new_groups = krealloc(mc_groups, nlen,
165 GFP_KERNEL);
166 if (!new_groups)
167 return -ENOMEM;
168 mc_groups = new_groups;
169 for (i = 0; i < BITS_TO_LONGS(n_groups); i++)
170 mc_groups[mc_groups_longs + i] = 0;
171 }
172 mc_groups_longs = new_longs;
173 }
174 } while (!fits);
175
176 for (i = id; i < id + n_groups; i++)
177 set_bit(i, mc_groups);
178 *first_id = id;
179 return 0;
180}
181
182static struct genl_family genl_ctrl;
183
184static int genl_validate_assign_mc_groups(struct genl_family *family)
185{
186 int first_id;
187 int n_groups = family->n_mcgrps;
Geert Uytterhoeven0f0e2152013-11-23 13:01:50 +0100188 int err = 0, i;
Johannes Berg2a94fe42013-11-19 15:19:39 +0100189 bool groups_allocated = false;
190
191 if (!n_groups)
192 return 0;
193
194 for (i = 0; i < n_groups; i++) {
195 const struct genl_multicast_group *grp = &family->mcgrps[i];
196
197 if (WARN_ON(grp->name[0] == '\0'))
198 return -EINVAL;
199 if (WARN_ON(memchr(grp->name, '\0', GENL_NAMSIZ) == NULL))
200 return -EINVAL;
201 }
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700202
Johannes Berge5dcecb2013-11-19 15:19:32 +0100203 /* special-case our own group and hacks */
Johannes Berg2a94fe42013-11-19 15:19:39 +0100204 if (family == &genl_ctrl) {
205 first_id = GENL_ID_CTRL;
206 BUG_ON(n_groups != 1);
207 } else if (strcmp(family->name, "NET_DM") == 0) {
208 first_id = 1;
209 BUG_ON(n_groups != 1);
Johannes Berg5e53e682013-11-24 21:09:26 +0100210 } else if (family->id == GENL_ID_VFS_DQUOT) {
Johannes Berg2a94fe42013-11-19 15:19:39 +0100211 first_id = GENL_ID_VFS_DQUOT;
212 BUG_ON(n_groups != 1);
Johannes Berg5e53e682013-11-24 21:09:26 +0100213 } else if (family->id == GENL_ID_PMCRAID) {
214 first_id = GENL_ID_PMCRAID;
215 BUG_ON(n_groups != 1);
Johannes Berg2a94fe42013-11-19 15:19:39 +0100216 } else {
217 groups_allocated = true;
218 err = genl_allocate_reserve_groups(n_groups, &first_id);
219 if (err)
220 return err;
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700221 }
222
Johannes Berg2a94fe42013-11-19 15:19:39 +0100223 family->mcgrp_offset = first_id;
224
225 /* if still initializing, can't and don't need to to realloc bitmaps */
226 if (!init_net.genl_sock)
227 return 0;
228
Johannes Berg134e6372009-07-10 09:51:34 +0000229 if (family->netnsok) {
230 struct net *net;
231
Johannes Bergd136f1b2009-09-12 03:03:15 +0000232 netlink_table_grab();
Johannes Berg134e6372009-07-10 09:51:34 +0000233 rcu_read_lock();
234 for_each_net_rcu(net) {
Johannes Bergd136f1b2009-09-12 03:03:15 +0000235 err = __netlink_change_ngroups(net->genl_sock,
Johannes Berg134e6372009-07-10 09:51:34 +0000236 mc_groups_longs * BITS_PER_LONG);
237 if (err) {
238 /*
239 * No need to roll back, can only fail if
240 * memory allocation fails and then the
241 * number of _possible_ groups has been
242 * increased on some sockets which is ok.
243 */
Johannes Berg2a94fe42013-11-19 15:19:39 +0100244 break;
Johannes Berg134e6372009-07-10 09:51:34 +0000245 }
246 }
247 rcu_read_unlock();
Johannes Bergd136f1b2009-09-12 03:03:15 +0000248 netlink_table_ungrab();
Johannes Berg134e6372009-07-10 09:51:34 +0000249 } else {
250 err = netlink_change_ngroups(init_net.genl_sock,
251 mc_groups_longs * BITS_PER_LONG);
Johannes Berg134e6372009-07-10 09:51:34 +0000252 }
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700253
Johannes Berg2a94fe42013-11-19 15:19:39 +0100254 if (groups_allocated && err) {
255 for (i = 0; i < family->n_mcgrps; i++)
256 clear_bit(family->mcgrp_offset + i, mc_groups);
257 }
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700258
Thomas Graf79d310d2007-07-24 15:34:53 -0700259 return err;
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700260}
Thomas Graf79dc43862007-07-24 15:32:46 -0700261
Johannes Berg2ae0f172016-10-24 14:40:04 +0200262static void genl_unregister_mc_groups(const struct genl_family *family)
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700263{
Johannes Berg2a94fe42013-11-19 15:19:39 +0100264 struct net *net;
265 int i;
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700266
Johannes Berg2a94fe42013-11-19 15:19:39 +0100267 netlink_table_grab();
268 rcu_read_lock();
269 for_each_net_rcu(net) {
270 for (i = 0; i < family->n_mcgrps; i++)
271 __netlink_clear_multicast_users(
272 net->genl_sock, family->mcgrp_offset + i);
273 }
274 rcu_read_unlock();
275 netlink_table_ungrab();
276
277 for (i = 0; i < family->n_mcgrps; i++) {
278 int grp_id = family->mcgrp_offset + i;
279
280 if (grp_id != 1)
281 clear_bit(grp_id, mc_groups);
282 genl_ctrl_event(CTRL_CMD_DELMCAST_GRP, family,
283 &family->mcgrps[i], grp_id);
284 }
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700285}
286
Denis ChengRq2f91abd2014-06-02 01:18:01 -0700287static int genl_validate_ops(const struct genl_family *family)
Thomas Graf482a8522005-11-10 02:25:56 +0100288{
Johannes Berg568508a2013-11-15 14:19:08 +0100289 const struct genl_ops *ops = family->ops;
290 unsigned int n_ops = family->n_ops;
Johannes Bergd91824c2013-11-14 17:14:44 +0100291 int i, j;
Thomas Graf482a8522005-11-10 02:25:56 +0100292
Johannes Berg568508a2013-11-15 14:19:08 +0100293 if (WARN_ON(n_ops && !ops))
294 return -EINVAL;
295
296 if (!n_ops)
297 return 0;
298
Johannes Bergd91824c2013-11-14 17:14:44 +0100299 for (i = 0; i < n_ops; i++) {
300 if (ops[i].dumpit == NULL && ops[i].doit == NULL)
301 return -EINVAL;
302 for (j = i + 1; j < n_ops; j++)
303 if (ops[i].cmd == ops[j].cmd)
304 return -EINVAL;
Thomas Graf482a8522005-11-10 02:25:56 +0100305 }
306
Johannes Bergd91824c2013-11-14 17:14:44 +0100307 return 0;
Thomas Graf482a8522005-11-10 02:25:56 +0100308}
Thomas Graf482a8522005-11-10 02:25:56 +0100309
310/**
Johannes Berg489111e2016-10-24 14:40:03 +0200311 * genl_register_family - register a generic netlink family
Thomas Graf482a8522005-11-10 02:25:56 +0100312 * @family: generic netlink family
313 *
314 * Registers the specified family after validating it first. Only one
315 * family may be registered with the same family name or identifier.
Thomas Graf482a8522005-11-10 02:25:56 +0100316 *
Johannes Berg489111e2016-10-24 14:40:03 +0200317 * The family's ops, multicast groups and module pointer must already
318 * be assigned.
Johannes Berg568508a2013-11-15 14:19:08 +0100319 *
Thomas Graf482a8522005-11-10 02:25:56 +0100320 * Return 0 on success or a negative error code.
321 */
Johannes Berg489111e2016-10-24 14:40:03 +0200322int genl_register_family(struct genl_family *family)
Thomas Graf482a8522005-11-10 02:25:56 +0100323{
Johannes Berga07ea4d2016-10-24 14:40:02 +0200324 int err, i;
Johannes Berg2ae0f172016-10-24 14:40:04 +0200325 int start = GENL_START_ALLOC, end = GENL_MAX_ID;
Thomas Graf482a8522005-11-10 02:25:56 +0100326
Johannes Berg568508a2013-11-15 14:19:08 +0100327 err = genl_validate_ops(family);
328 if (err)
329 return err;
330
Pravin B Shelardef31172013-04-23 07:48:30 +0000331 genl_lock_all();
Thomas Graf482a8522005-11-10 02:25:56 +0100332
333 if (genl_family_find_byname(family->name)) {
334 err = -EEXIST;
335 goto errout_locked;
336 }
337
Johannes Berg2ae0f172016-10-24 14:40:04 +0200338 /*
339 * Sadly, a few cases need to be special-cased
340 * due to them having previously abused the API
341 * and having used their family ID also as their
342 * multicast group ID, so we use reserved IDs
343 * for both to be sure we can do that mapping.
344 */
Johannes Berga07ea4d2016-10-24 14:40:02 +0200345 if (family == &genl_ctrl) {
Johannes Berg2ae0f172016-10-24 14:40:04 +0200346 /* and this needs to be special for initial family lookups */
347 start = end = GENL_ID_CTRL;
348 } else if (strcmp(family->name, "pmcraid") == 0) {
349 start = end = GENL_ID_PMCRAID;
350 } else if (strcmp(family->name, "VFS_DQUOT") == 0) {
351 start = end = GENL_ID_VFS_DQUOT;
Thomas Graf482a8522005-11-10 02:25:56 +0100352 }
353
Pravin B Shelardef31172013-04-23 07:48:30 +0000354 if (family->maxattr && !family->parallel_ops) {
Thomas Graf482a8522005-11-10 02:25:56 +0100355 family->attrbuf = kmalloc((family->maxattr+1) *
356 sizeof(struct nlattr *), GFP_KERNEL);
357 if (family->attrbuf == NULL) {
358 err = -ENOMEM;
Jamal Hadi Salime200bd82006-02-13 15:51:24 -0800359 goto errout_locked;
Thomas Graf482a8522005-11-10 02:25:56 +0100360 }
361 } else
362 family->attrbuf = NULL;
363
Johannes Berg2ae0f172016-10-24 14:40:04 +0200364 family->id = idr_alloc(&genl_fam_idr, family,
365 start, end + 1, GFP_KERNEL);
Wei Yongjun22ca9042016-11-01 14:45:52 +0000366 if (family->id < 0) {
367 err = family->id;
Johannes Berg2a94fe42013-11-19 15:19:39 +0100368 goto errout_locked;
Wei Yongjun22ca9042016-11-01 14:45:52 +0000369 }
Johannes Berg2a94fe42013-11-19 15:19:39 +0100370
Johannes Berg2ae0f172016-10-24 14:40:04 +0200371 err = genl_validate_assign_mc_groups(family);
372 if (err)
373 goto errout_remove;
374
Pravin B Shelardef31172013-04-23 07:48:30 +0000375 genl_unlock_all();
Thomas Graf482a8522005-11-10 02:25:56 +0100376
Johannes Berg2a94fe42013-11-19 15:19:39 +0100377 /* send all events */
378 genl_ctrl_event(CTRL_CMD_NEWFAMILY, family, NULL, 0);
379 for (i = 0; i < family->n_mcgrps; i++)
380 genl_ctrl_event(CTRL_CMD_NEWMCAST_GRP, family,
381 &family->mcgrps[i], family->mcgrp_offset + i);
Thomas Graf482a8522005-11-10 02:25:56 +0100382
383 return 0;
384
Johannes Berg2ae0f172016-10-24 14:40:04 +0200385errout_remove:
386 idr_remove(&genl_fam_idr, family->id);
WANG Cong00ffc1b2016-11-03 09:42:35 -0700387 kfree(family->attrbuf);
Thomas Graf482a8522005-11-10 02:25:56 +0100388errout_locked:
Pravin B Shelardef31172013-04-23 07:48:30 +0000389 genl_unlock_all();
Thomas Graf482a8522005-11-10 02:25:56 +0100390 return err;
391}
Johannes Berg489111e2016-10-24 14:40:03 +0200392EXPORT_SYMBOL(genl_register_family);
Thomas Graf482a8522005-11-10 02:25:56 +0100393
394/**
395 * genl_unregister_family - unregister generic netlink family
396 * @family: generic netlink family
397 *
398 * Unregisters the specified family.
399 *
400 * Returns 0 on success or a negative error code.
401 */
Johannes Berg2ae0f172016-10-24 14:40:04 +0200402int genl_unregister_family(const struct genl_family *family)
Thomas Graf482a8522005-11-10 02:25:56 +0100403{
Pravin B Shelardef31172013-04-23 07:48:30 +0000404 genl_lock_all();
Thomas Graf482a8522005-11-10 02:25:56 +0100405
pravin shelar0e82c762016-10-28 16:01:41 -0700406 if (!genl_family_find_byid(family->id)) {
Johannes Berg2ae0f172016-10-24 14:40:04 +0200407 genl_unlock_all();
408 return -ENOENT;
Thomas Graf482a8522005-11-10 02:25:56 +0100409 }
410
Johannes Berg2ae0f172016-10-24 14:40:04 +0200411 genl_unregister_mc_groups(family);
Thomas Graf482a8522005-11-10 02:25:56 +0100412
Johannes Berg2ae0f172016-10-24 14:40:04 +0200413 idr_remove(&genl_fam_idr, family->id);
414
415 up_write(&cb_lock);
416 wait_event(genl_sk_destructing_waitq,
417 atomic_read(&genl_sk_destructing_cnt) == 0);
418 genl_unlock();
419
420 kfree(family->attrbuf);
421
422 genl_ctrl_event(CTRL_CMD_DELFAMILY, family, NULL, 0);
423
424 return 0;
Thomas Graf482a8522005-11-10 02:25:56 +0100425}
Changli Gao416c2f92010-07-25 20:46:01 +0000426EXPORT_SYMBOL(genl_unregister_family);
Thomas Graf482a8522005-11-10 02:25:56 +0100427
Denys Vlasenkoa46621a2012-01-30 15:22:06 -0500428/**
429 * genlmsg_put - Add generic netlink header to netlink message
430 * @skb: socket buffer holding the message
Eric W. Biederman15e47302012-09-07 20:12:54 +0000431 * @portid: netlink portid the message is addressed to
Denys Vlasenkoa46621a2012-01-30 15:22:06 -0500432 * @seq: sequence number (usually the one of the sender)
433 * @family: generic netlink family
Ben Hutchings2c530402012-07-10 10:55:09 +0000434 * @flags: netlink message flags
Denys Vlasenkoa46621a2012-01-30 15:22:06 -0500435 * @cmd: generic netlink command
436 *
437 * Returns pointer to user specific header
438 */
Eric W. Biederman15e47302012-09-07 20:12:54 +0000439void *genlmsg_put(struct sk_buff *skb, u32 portid, u32 seq,
Johannes Berg2ae0f172016-10-24 14:40:04 +0200440 const struct genl_family *family, int flags, u8 cmd)
Denys Vlasenkoa46621a2012-01-30 15:22:06 -0500441{
442 struct nlmsghdr *nlh;
443 struct genlmsghdr *hdr;
444
Eric W. Biederman15e47302012-09-07 20:12:54 +0000445 nlh = nlmsg_put(skb, portid, seq, family->id, GENL_HDRLEN +
Denys Vlasenkoa46621a2012-01-30 15:22:06 -0500446 family->hdrsize, flags);
447 if (nlh == NULL)
448 return NULL;
449
450 hdr = nlmsg_data(nlh);
451 hdr->cmd = cmd;
452 hdr->version = family->version;
453 hdr->reserved = 0;
454
455 return (char *) hdr + GENL_HDRLEN;
456}
457EXPORT_SYMBOL(genlmsg_put);
458
Tom Herbertfc9e50f2015-12-15 15:41:37 -0800459static int genl_lock_start(struct netlink_callback *cb)
460{
461 /* our ops are always const - netlink API doesn't propagate that */
462 const struct genl_ops *ops = cb->data;
463 int rc = 0;
464
465 if (ops->start) {
466 genl_lock();
467 rc = ops->start(cb);
468 genl_unlock();
469 }
470 return rc;
471}
472
Pravin B Shelar9b963092013-08-23 12:44:55 -0700473static int genl_lock_dumpit(struct sk_buff *skb, struct netlink_callback *cb)
474{
Johannes Bergf84f7712013-11-14 17:14:45 +0100475 /* our ops are always const - netlink API doesn't propagate that */
476 const struct genl_ops *ops = cb->data;
Pravin B Shelar9b963092013-08-23 12:44:55 -0700477 int rc;
478
479 genl_lock();
480 rc = ops->dumpit(skb, cb);
481 genl_unlock();
482 return rc;
483}
484
485static int genl_lock_done(struct netlink_callback *cb)
486{
Johannes Bergf84f7712013-11-14 17:14:45 +0100487 /* our ops are always const - netlink API doesn't propagate that */
488 const struct genl_ops *ops = cb->data;
Pravin B Shelar9b963092013-08-23 12:44:55 -0700489 int rc = 0;
490
491 if (ops->done) {
492 genl_lock();
493 rc = ops->done(cb);
494 genl_unlock();
495 }
496 return rc;
497}
498
Johannes Berg2ae0f172016-10-24 14:40:04 +0200499static int genl_family_rcv_msg(const struct genl_family *family,
Pravin B Shelardef31172013-04-23 07:48:30 +0000500 struct sk_buff *skb,
Johannes Berg7ab606d2017-04-12 14:34:05 +0200501 struct nlmsghdr *nlh,
502 struct netlink_ext_ack *extack)
Thomas Graf482a8522005-11-10 02:25:56 +0100503{
Johannes Bergf84f7712013-11-14 17:14:45 +0100504 const struct genl_ops *ops;
Johannes Berg134e6372009-07-10 09:51:34 +0000505 struct net *net = sock_net(skb->sk);
Thomas Graf482a8522005-11-10 02:25:56 +0100506 struct genl_info info;
507 struct genlmsghdr *hdr = nlmsg_data(nlh);
Pravin B Shelardef31172013-04-23 07:48:30 +0000508 struct nlattr **attrbuf;
Thomas Graf1d00a4e2007-03-22 23:30:12 -0700509 int hdrlen, err;
Thomas Graf482a8522005-11-10 02:25:56 +0100510
Johannes Berg134e6372009-07-10 09:51:34 +0000511 /* this family doesn't exist in this netns */
512 if (!family->netnsok && !net_eq(net, &init_net))
513 return -ENOENT;
514
Thomas Graf482a8522005-11-10 02:25:56 +0100515 hdrlen = GENL_HDRLEN + family->hdrsize;
516 if (nlh->nlmsg_len < nlmsg_msg_size(hdrlen))
Thomas Graf1d00a4e2007-03-22 23:30:12 -0700517 return -EINVAL;
Thomas Graf482a8522005-11-10 02:25:56 +0100518
519 ops = genl_get_cmd(hdr->cmd, family);
Thomas Graf1d00a4e2007-03-22 23:30:12 -0700520 if (ops == NULL)
521 return -EOPNOTSUPP;
Thomas Graf482a8522005-11-10 02:25:56 +0100522
Thomas Graf1d00a4e2007-03-22 23:30:12 -0700523 if ((ops->flags & GENL_ADMIN_PERM) &&
Eric W. Biederman90f62cf2014-04-23 14:29:27 -0700524 !netlink_capable(skb, CAP_NET_ADMIN))
Thomas Graf1d00a4e2007-03-22 23:30:12 -0700525 return -EPERM;
Thomas Graf482a8522005-11-10 02:25:56 +0100526
Tycho Andersen4a926022016-02-05 09:20:52 -0700527 if ((ops->flags & GENL_UNS_ADMIN_PERM) &&
528 !netlink_ns_capable(skb, net->user_ns, CAP_NET_ADMIN))
529 return -EPERM;
530
Pablo Neirae1ee3672013-07-29 12:30:04 +0200531 if ((nlh->nlmsg_flags & NLM_F_DUMP) == NLM_F_DUMP) {
Pravin B Shelar9b963092013-08-23 12:44:55 -0700532 int rc;
Pravin B Shelardef31172013-04-23 07:48:30 +0000533
Thomas Graf1d00a4e2007-03-22 23:30:12 -0700534 if (ops->dumpit == NULL)
535 return -EOPNOTSUPP;
Thomas Graf482a8522005-11-10 02:25:56 +0100536
Pravin B Shelar9b963092013-08-23 12:44:55 -0700537 if (!family->parallel_ops) {
538 struct netlink_dump_control c = {
Pravin B Shelar33c6b1f2013-08-23 12:45:04 -0700539 .module = family->module,
Johannes Bergf84f7712013-11-14 17:14:45 +0100540 /* we have const, but the netlink API doesn't */
541 .data = (void *)ops,
Tom Herbertfc9e50f2015-12-15 15:41:37 -0800542 .start = genl_lock_start,
Pravin B Shelar9b963092013-08-23 12:44:55 -0700543 .dump = genl_lock_dumpit,
544 .done = genl_lock_done,
545 };
546
547 genl_unlock();
Pravin B Shelar33c6b1f2013-08-23 12:45:04 -0700548 rc = __netlink_dump_start(net->genl_sock, skb, nlh, &c);
Pravin B Shelar9b963092013-08-23 12:44:55 -0700549 genl_lock();
550
551 } else {
552 struct netlink_dump_control c = {
Pravin B Shelar33c6b1f2013-08-23 12:45:04 -0700553 .module = family->module,
Tom Herbertfc9e50f2015-12-15 15:41:37 -0800554 .start = ops->start,
Pravin B Shelar9b963092013-08-23 12:44:55 -0700555 .dump = ops->dumpit,
556 .done = ops->done,
557 };
558
Pravin B Shelar33c6b1f2013-08-23 12:45:04 -0700559 rc = __netlink_dump_start(net->genl_sock, skb, nlh, &c);
Pravin B Shelar9b963092013-08-23 12:44:55 -0700560 }
561
562 return rc;
Thomas Graf482a8522005-11-10 02:25:56 +0100563 }
564
Thomas Graf1d00a4e2007-03-22 23:30:12 -0700565 if (ops->doit == NULL)
566 return -EOPNOTSUPP;
Thomas Graf482a8522005-11-10 02:25:56 +0100567
Pravin B Shelardef31172013-04-23 07:48:30 +0000568 if (family->maxattr && family->parallel_ops) {
569 attrbuf = kmalloc((family->maxattr+1) *
570 sizeof(struct nlattr *), GFP_KERNEL);
571 if (attrbuf == NULL)
572 return -ENOMEM;
573 } else
574 attrbuf = family->attrbuf;
575
576 if (attrbuf) {
577 err = nlmsg_parse(nlh, hdrlen, attrbuf, family->maxattr,
Johannes Bergfe521452017-04-12 14:34:08 +0200578 ops->policy, extack);
Thomas Graf482a8522005-11-10 02:25:56 +0100579 if (err < 0)
Wei Yongjun50754d212013-04-26 15:34:16 +0000580 goto out;
Thomas Graf482a8522005-11-10 02:25:56 +0100581 }
582
583 info.snd_seq = nlh->nlmsg_seq;
Eric W. Biederman15e47302012-09-07 20:12:54 +0000584 info.snd_portid = NETLINK_CB(skb).portid;
Thomas Graf482a8522005-11-10 02:25:56 +0100585 info.nlhdr = nlh;
586 info.genlhdr = nlmsg_data(nlh);
587 info.userhdr = nlmsg_data(nlh) + GENL_HDRLEN;
Pravin B Shelardef31172013-04-23 07:48:30 +0000588 info.attrs = attrbuf;
Johannes Berg7ab606d2017-04-12 14:34:05 +0200589 info.extack = extack;
Johannes Berg134e6372009-07-10 09:51:34 +0000590 genl_info_net_set(&info, net);
Johannes Bergff4c92d2010-10-04 21:14:03 +0200591 memset(&info.user_ptr, 0, sizeof(info.user_ptr));
Thomas Graf482a8522005-11-10 02:25:56 +0100592
Johannes Bergff4c92d2010-10-04 21:14:03 +0200593 if (family->pre_doit) {
594 err = family->pre_doit(ops, skb, &info);
595 if (err)
Wei Yongjun50754d212013-04-26 15:34:16 +0000596 goto out;
Johannes Bergff4c92d2010-10-04 21:14:03 +0200597 }
598
599 err = ops->doit(skb, &info);
600
601 if (family->post_doit)
602 family->post_doit(ops, skb, &info);
603
Wei Yongjun50754d212013-04-26 15:34:16 +0000604out:
Pravin B Shelardef31172013-04-23 07:48:30 +0000605 if (family->parallel_ops)
606 kfree(attrbuf);
607
608 return err;
609}
610
Johannes Berg2d4bc932017-04-12 14:34:04 +0200611static int genl_rcv_msg(struct sk_buff *skb, struct nlmsghdr *nlh,
612 struct netlink_ext_ack *extack)
Pravin B Shelardef31172013-04-23 07:48:30 +0000613{
Johannes Berg2ae0f172016-10-24 14:40:04 +0200614 const struct genl_family *family;
Pravin B Shelardef31172013-04-23 07:48:30 +0000615 int err;
616
617 family = genl_family_find_byid(nlh->nlmsg_type);
618 if (family == NULL)
619 return -ENOENT;
620
621 if (!family->parallel_ops)
622 genl_lock();
623
Johannes Berg7ab606d2017-04-12 14:34:05 +0200624 err = genl_family_rcv_msg(family, skb, nlh, extack);
Pravin B Shelardef31172013-04-23 07:48:30 +0000625
626 if (!family->parallel_ops)
627 genl_unlock();
628
Johannes Bergff4c92d2010-10-04 21:14:03 +0200629 return err;
Thomas Graf482a8522005-11-10 02:25:56 +0100630}
631
Denis V. Lunevcd40b7d2007-10-10 21:15:29 -0700632static void genl_rcv(struct sk_buff *skb)
Thomas Graf482a8522005-11-10 02:25:56 +0100633{
Pravin B Shelardef31172013-04-23 07:48:30 +0000634 down_read(&cb_lock);
Denis V. Lunevcd40b7d2007-10-10 21:15:29 -0700635 netlink_rcv_skb(skb, &genl_rcv_msg);
Pravin B Shelardef31172013-04-23 07:48:30 +0000636 up_read(&cb_lock);
Thomas Graf482a8522005-11-10 02:25:56 +0100637}
638
639/**************************************************************************
640 * Controller
641 **************************************************************************/
642
Johannes Berg489111e2016-10-24 14:40:03 +0200643static struct genl_family genl_ctrl;
Thomas Graf17c157c2006-11-14 19:46:02 -0800644
Johannes Berg2ae0f172016-10-24 14:40:04 +0200645static int ctrl_fill_info(const struct genl_family *family, u32 portid, u32 seq,
Thomas Graf482a8522005-11-10 02:25:56 +0100646 u32 flags, struct sk_buff *skb, u8 cmd)
647{
648 void *hdr;
649
Eric W. Biederman15e47302012-09-07 20:12:54 +0000650 hdr = genlmsg_put(skb, portid, seq, &genl_ctrl, flags, cmd);
Thomas Graf482a8522005-11-10 02:25:56 +0100651 if (hdr == NULL)
652 return -1;
653
David S. Miller444653f2012-03-29 23:25:11 -0400654 if (nla_put_string(skb, CTRL_ATTR_FAMILY_NAME, family->name) ||
655 nla_put_u16(skb, CTRL_ATTR_FAMILY_ID, family->id) ||
656 nla_put_u32(skb, CTRL_ATTR_VERSION, family->version) ||
657 nla_put_u32(skb, CTRL_ATTR_HDRSIZE, family->hdrsize) ||
658 nla_put_u32(skb, CTRL_ATTR_MAXATTR, family->maxattr))
659 goto nla_put_failure;
Thomas Grafeb328112006-09-18 00:01:59 -0700660
Johannes Bergd91824c2013-11-14 17:14:44 +0100661 if (family->n_ops) {
Thomas Grafe94ef682006-11-23 11:44:37 -0800662 struct nlattr *nla_ops;
Johannes Bergd91824c2013-11-14 17:14:44 +0100663 int i;
Thomas Grafeb328112006-09-18 00:01:59 -0700664
Thomas Grafe94ef682006-11-23 11:44:37 -0800665 nla_ops = nla_nest_start(skb, CTRL_ATTR_OPS);
666 if (nla_ops == NULL)
Thomas Grafeb328112006-09-18 00:01:59 -0700667 goto nla_put_failure;
668
Johannes Bergd91824c2013-11-14 17:14:44 +0100669 for (i = 0; i < family->n_ops; i++) {
Thomas Grafe94ef682006-11-23 11:44:37 -0800670 struct nlattr *nest;
Johannes Bergf84f7712013-11-14 17:14:45 +0100671 const struct genl_ops *ops = &family->ops[i];
Johannes Berg029b2342013-11-18 20:54:58 +0100672 u32 op_flags = ops->flags;
Johannes Bergf84f7712013-11-14 17:14:45 +0100673
674 if (ops->dumpit)
Johannes Berg029b2342013-11-18 20:54:58 +0100675 op_flags |= GENL_CMD_CAP_DUMP;
Johannes Bergf84f7712013-11-14 17:14:45 +0100676 if (ops->doit)
Johannes Berg029b2342013-11-18 20:54:58 +0100677 op_flags |= GENL_CMD_CAP_DO;
Johannes Bergf84f7712013-11-14 17:14:45 +0100678 if (ops->policy)
Johannes Berg029b2342013-11-18 20:54:58 +0100679 op_flags |= GENL_CMD_CAP_HASPOL;
Thomas Grafeb328112006-09-18 00:01:59 -0700680
Johannes Bergd91824c2013-11-14 17:14:44 +0100681 nest = nla_nest_start(skb, i + 1);
Thomas Grafe94ef682006-11-23 11:44:37 -0800682 if (nest == NULL)
683 goto nla_put_failure;
Thomas Grafeb328112006-09-18 00:01:59 -0700684
David S. Miller444653f2012-03-29 23:25:11 -0400685 if (nla_put_u32(skb, CTRL_ATTR_OP_ID, ops->cmd) ||
Johannes Berg029b2342013-11-18 20:54:58 +0100686 nla_put_u32(skb, CTRL_ATTR_OP_FLAGS, op_flags))
David S. Miller444653f2012-03-29 23:25:11 -0400687 goto nla_put_failure;
Thomas Grafeb328112006-09-18 00:01:59 -0700688
Thomas Grafe94ef682006-11-23 11:44:37 -0800689 nla_nest_end(skb, nest);
690 }
691
692 nla_nest_end(skb, nla_ops);
Thomas Grafeb328112006-09-18 00:01:59 -0700693 }
694
Johannes Berg2a94fe42013-11-19 15:19:39 +0100695 if (family->n_mcgrps) {
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700696 struct nlattr *nla_grps;
Johannes Berg2a94fe42013-11-19 15:19:39 +0100697 int i;
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700698
699 nla_grps = nla_nest_start(skb, CTRL_ATTR_MCAST_GROUPS);
700 if (nla_grps == NULL)
701 goto nla_put_failure;
702
Johannes Berg2a94fe42013-11-19 15:19:39 +0100703 for (i = 0; i < family->n_mcgrps; i++) {
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700704 struct nlattr *nest;
Johannes Berg2a94fe42013-11-19 15:19:39 +0100705 const struct genl_multicast_group *grp;
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700706
Johannes Berg2a94fe42013-11-19 15:19:39 +0100707 grp = &family->mcgrps[i];
708
709 nest = nla_nest_start(skb, i + 1);
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700710 if (nest == NULL)
711 goto nla_put_failure;
712
Johannes Berg2a94fe42013-11-19 15:19:39 +0100713 if (nla_put_u32(skb, CTRL_ATTR_MCAST_GRP_ID,
714 family->mcgrp_offset + i) ||
David S. Miller444653f2012-03-29 23:25:11 -0400715 nla_put_string(skb, CTRL_ATTR_MCAST_GRP_NAME,
716 grp->name))
717 goto nla_put_failure;
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700718
719 nla_nest_end(skb, nest);
720 }
721 nla_nest_end(skb, nla_grps);
722 }
723
Johannes Berg053c0952015-01-16 22:09:00 +0100724 genlmsg_end(skb, hdr);
725 return 0;
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700726
727nla_put_failure:
Thomas Grafbc3ed282008-06-03 16:36:54 -0700728 genlmsg_cancel(skb, hdr);
729 return -EMSGSIZE;
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700730}
731
Johannes Berg2ae0f172016-10-24 14:40:04 +0200732static int ctrl_fill_mcgrp_info(const struct genl_family *family,
Johannes Berg2a94fe42013-11-19 15:19:39 +0100733 const struct genl_multicast_group *grp,
734 int grp_id, u32 portid, u32 seq, u32 flags,
735 struct sk_buff *skb, u8 cmd)
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700736{
737 void *hdr;
738 struct nlattr *nla_grps;
739 struct nlattr *nest;
740
Eric W. Biederman15e47302012-09-07 20:12:54 +0000741 hdr = genlmsg_put(skb, portid, seq, &genl_ctrl, flags, cmd);
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700742 if (hdr == NULL)
743 return -1;
744
Johannes Bergc2ebb902013-11-19 15:19:36 +0100745 if (nla_put_string(skb, CTRL_ATTR_FAMILY_NAME, family->name) ||
746 nla_put_u16(skb, CTRL_ATTR_FAMILY_ID, family->id))
David S. Miller444653f2012-03-29 23:25:11 -0400747 goto nla_put_failure;
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700748
749 nla_grps = nla_nest_start(skb, CTRL_ATTR_MCAST_GROUPS);
750 if (nla_grps == NULL)
751 goto nla_put_failure;
752
753 nest = nla_nest_start(skb, 1);
754 if (nest == NULL)
755 goto nla_put_failure;
756
Johannes Berg2a94fe42013-11-19 15:19:39 +0100757 if (nla_put_u32(skb, CTRL_ATTR_MCAST_GRP_ID, grp_id) ||
David S. Miller444653f2012-03-29 23:25:11 -0400758 nla_put_string(skb, CTRL_ATTR_MCAST_GRP_NAME,
759 grp->name))
760 goto nla_put_failure;
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700761
762 nla_nest_end(skb, nest);
763 nla_nest_end(skb, nla_grps);
764
Johannes Berg053c0952015-01-16 22:09:00 +0100765 genlmsg_end(skb, hdr);
766 return 0;
Thomas Graf482a8522005-11-10 02:25:56 +0100767
768nla_put_failure:
Thomas Grafbc3ed282008-06-03 16:36:54 -0700769 genlmsg_cancel(skb, hdr);
770 return -EMSGSIZE;
Thomas Graf482a8522005-11-10 02:25:56 +0100771}
772
773static int ctrl_dumpfamily(struct sk_buff *skb, struct netlink_callback *cb)
774{
Johannes Berg2ae0f172016-10-24 14:40:04 +0200775 int n = 0;
Thomas Graf482a8522005-11-10 02:25:56 +0100776 struct genl_family *rt;
Johannes Berg134e6372009-07-10 09:51:34 +0000777 struct net *net = sock_net(skb->sk);
Johannes Berg2ae0f172016-10-24 14:40:04 +0200778 int fams_to_skip = cb->args[0];
779 unsigned int id;
Thomas Graf482a8522005-11-10 02:25:56 +0100780
Johannes Berg2ae0f172016-10-24 14:40:04 +0200781 idr_for_each_entry(&genl_fam_idr, rt, id) {
782 if (!rt->netnsok && !net_eq(net, &init_net))
783 continue;
Thomas Graf482a8522005-11-10 02:25:56 +0100784
Johannes Berg2ae0f172016-10-24 14:40:04 +0200785 if (n++ < fams_to_skip)
786 continue;
787
788 if (ctrl_fill_info(rt, NETLINK_CB(cb->skb).portid,
789 cb->nlh->nlmsg_seq, NLM_F_MULTI,
Stanislaw Gruszka1d2a6a52017-03-22 16:08:33 +0100790 skb, CTRL_CMD_NEWFAMILY) < 0) {
791 n--;
Johannes Berg2ae0f172016-10-24 14:40:04 +0200792 break;
Stanislaw Gruszka1d2a6a52017-03-22 16:08:33 +0100793 }
Thomas Graf482a8522005-11-10 02:25:56 +0100794 }
795
Johannes Berg2ae0f172016-10-24 14:40:04 +0200796 cb->args[0] = n;
Thomas Graf482a8522005-11-10 02:25:56 +0100797 return skb->len;
798}
799
Johannes Berg2ae0f172016-10-24 14:40:04 +0200800static struct sk_buff *ctrl_build_family_msg(const struct genl_family *family,
Eric W. Biederman15e47302012-09-07 20:12:54 +0000801 u32 portid, int seq, u8 cmd)
Thomas Graf482a8522005-11-10 02:25:56 +0100802{
803 struct sk_buff *skb;
804 int err;
805
Thomas Graf339bf982006-11-10 14:10:15 -0800806 skb = nlmsg_new(NLMSG_DEFAULT_SIZE, GFP_KERNEL);
Thomas Graf482a8522005-11-10 02:25:56 +0100807 if (skb == NULL)
808 return ERR_PTR(-ENOBUFS);
809
Eric W. Biederman15e47302012-09-07 20:12:54 +0000810 err = ctrl_fill_info(family, portid, seq, 0, skb, cmd);
Thomas Graf482a8522005-11-10 02:25:56 +0100811 if (err < 0) {
812 nlmsg_free(skb);
813 return ERR_PTR(err);
814 }
815
816 return skb;
817}
818
Johannes Berg2a94fe42013-11-19 15:19:39 +0100819static struct sk_buff *
Johannes Berg2ae0f172016-10-24 14:40:04 +0200820ctrl_build_mcgrp_msg(const struct genl_family *family,
Johannes Berg2a94fe42013-11-19 15:19:39 +0100821 const struct genl_multicast_group *grp,
822 int grp_id, u32 portid, int seq, u8 cmd)
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700823{
824 struct sk_buff *skb;
825 int err;
826
827 skb = nlmsg_new(NLMSG_DEFAULT_SIZE, GFP_KERNEL);
828 if (skb == NULL)
829 return ERR_PTR(-ENOBUFS);
830
Johannes Berg2a94fe42013-11-19 15:19:39 +0100831 err = ctrl_fill_mcgrp_info(family, grp, grp_id, portid,
832 seq, 0, skb, cmd);
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700833 if (err < 0) {
834 nlmsg_free(skb);
835 return ERR_PTR(err);
836 }
837
838 return skb;
839}
840
Patrick McHardyef7c79e2007-06-05 12:38:30 -0700841static const struct nla_policy ctrl_policy[CTRL_ATTR_MAX+1] = {
Thomas Graf482a8522005-11-10 02:25:56 +0100842 [CTRL_ATTR_FAMILY_ID] = { .type = NLA_U16 },
Thomas Graf5176f912006-08-26 20:13:18 -0700843 [CTRL_ATTR_FAMILY_NAME] = { .type = NLA_NUL_STRING,
844 .len = GENL_NAMSIZ - 1 },
Thomas Graf482a8522005-11-10 02:25:56 +0100845};
846
847static int ctrl_getfamily(struct sk_buff *skb, struct genl_info *info)
848{
849 struct sk_buff *msg;
Johannes Berg2ae0f172016-10-24 14:40:04 +0200850 const struct genl_family *res = NULL;
Thomas Graf482a8522005-11-10 02:25:56 +0100851 int err = -EINVAL;
852
853 if (info->attrs[CTRL_ATTR_FAMILY_ID]) {
854 u16 id = nla_get_u16(info->attrs[CTRL_ATTR_FAMILY_ID]);
855 res = genl_family_find_byid(id);
Johannes Berg134e6372009-07-10 09:51:34 +0000856 err = -ENOENT;
Thomas Graf482a8522005-11-10 02:25:56 +0100857 }
858
859 if (info->attrs[CTRL_ATTR_FAMILY_NAME]) {
Thomas Graf5176f912006-08-26 20:13:18 -0700860 char *name;
Thomas Graf482a8522005-11-10 02:25:56 +0100861
Thomas Graf5176f912006-08-26 20:13:18 -0700862 name = nla_data(info->attrs[CTRL_ATTR_FAMILY_NAME]);
Thomas Graf482a8522005-11-10 02:25:56 +0100863 res = genl_family_find_byname(name);
Stephen Hemmingerfa843092011-12-28 13:48:55 -0500864#ifdef CONFIG_MODULES
865 if (res == NULL) {
866 genl_unlock();
Stanislaw Gruszkac74f2b22013-07-26 11:00:10 +0200867 up_read(&cb_lock);
Neil Hormane9412c32012-05-29 09:30:41 +0000868 request_module("net-pf-%d-proto-%d-family-%s",
Stephen Hemmingerfa843092011-12-28 13:48:55 -0500869 PF_NETLINK, NETLINK_GENERIC, name);
Stanislaw Gruszkac74f2b22013-07-26 11:00:10 +0200870 down_read(&cb_lock);
Stephen Hemmingerfa843092011-12-28 13:48:55 -0500871 genl_lock();
872 res = genl_family_find_byname(name);
873 }
874#endif
Johannes Berg134e6372009-07-10 09:51:34 +0000875 err = -ENOENT;
Thomas Graf482a8522005-11-10 02:25:56 +0100876 }
877
Johannes Berg134e6372009-07-10 09:51:34 +0000878 if (res == NULL)
879 return err;
880
881 if (!res->netnsok && !net_eq(genl_info_net(info), &init_net)) {
882 /* family doesn't exist here */
883 return -ENOENT;
Thomas Graf482a8522005-11-10 02:25:56 +0100884 }
885
Eric W. Biederman15e47302012-09-07 20:12:54 +0000886 msg = ctrl_build_family_msg(res, info->snd_portid, info->snd_seq,
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700887 CTRL_CMD_NEWFAMILY);
Johannes Berg134e6372009-07-10 09:51:34 +0000888 if (IS_ERR(msg))
889 return PTR_ERR(msg);
Thomas Graf482a8522005-11-10 02:25:56 +0100890
Johannes Berg134e6372009-07-10 09:51:34 +0000891 return genlmsg_reply(msg, info);
Thomas Graf482a8522005-11-10 02:25:56 +0100892}
893
Johannes Berg2ae0f172016-10-24 14:40:04 +0200894static int genl_ctrl_event(int event, const struct genl_family *family,
Johannes Berg2a94fe42013-11-19 15:19:39 +0100895 const struct genl_multicast_group *grp,
896 int grp_id)
Thomas Graf482a8522005-11-10 02:25:56 +0100897{
898 struct sk_buff *msg;
899
Johannes Berg134e6372009-07-10 09:51:34 +0000900 /* genl is still initialising */
901 if (!init_net.genl_sock)
Thomas Graf482a8522005-11-10 02:25:56 +0100902 return 0;
903
904 switch (event) {
905 case CTRL_CMD_NEWFAMILY:
906 case CTRL_CMD_DELFAMILY:
Johannes Bergc2ebb902013-11-19 15:19:36 +0100907 WARN_ON(grp);
Johannes Berg134e6372009-07-10 09:51:34 +0000908 msg = ctrl_build_family_msg(family, 0, 0, event);
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700909 break;
910 case CTRL_CMD_NEWMCAST_GRP:
911 case CTRL_CMD_DELMCAST_GRP:
Johannes Bergc2ebb902013-11-19 15:19:36 +0100912 BUG_ON(!grp);
Johannes Berg2a94fe42013-11-19 15:19:39 +0100913 msg = ctrl_build_mcgrp_msg(family, grp, grp_id, 0, 0, event);
Thomas Graf482a8522005-11-10 02:25:56 +0100914 break;
Johannes Berg134e6372009-07-10 09:51:34 +0000915 default:
916 return -EINVAL;
917 }
918
919 if (IS_ERR(msg))
920 return PTR_ERR(msg);
921
922 if (!family->netnsok) {
Johannes Berg68eb5502013-11-19 15:19:38 +0100923 genlmsg_multicast_netns(&genl_ctrl, &init_net, msg, 0,
Johannes Berg2a94fe42013-11-19 15:19:39 +0100924 0, GFP_KERNEL);
Johannes Berg134e6372009-07-10 09:51:34 +0000925 } else {
926 rcu_read_lock();
Johannes Berg68eb5502013-11-19 15:19:38 +0100927 genlmsg_multicast_allns(&genl_ctrl, msg, 0,
Johannes Berg2a94fe42013-11-19 15:19:39 +0100928 0, GFP_ATOMIC);
Johannes Berg134e6372009-07-10 09:51:34 +0000929 rcu_read_unlock();
Thomas Graf482a8522005-11-10 02:25:56 +0100930 }
931
932 return 0;
933}
934
stephen hemminger12d8de62016-08-31 15:22:00 -0700935static const struct genl_ops genl_ctrl_ops[] = {
Johannes Bergc53ed742013-11-19 15:19:31 +0100936 {
937 .cmd = CTRL_CMD_GETFAMILY,
938 .doit = ctrl_getfamily,
939 .dumpit = ctrl_dumpfamily,
940 .policy = ctrl_policy,
941 },
Thomas Graf482a8522005-11-10 02:25:56 +0100942};
943
stephen hemminger12d8de62016-08-31 15:22:00 -0700944static const struct genl_multicast_group genl_ctrl_groups[] = {
Johannes Berg2a94fe42013-11-19 15:19:39 +0100945 { .name = "notify", },
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700946};
947
Johannes Berg56989f62016-10-24 14:40:05 +0200948static struct genl_family genl_ctrl __ro_after_init = {
Johannes Berg489111e2016-10-24 14:40:03 +0200949 .module = THIS_MODULE,
950 .ops = genl_ctrl_ops,
951 .n_ops = ARRAY_SIZE(genl_ctrl_ops),
952 .mcgrps = genl_ctrl_groups,
953 .n_mcgrps = ARRAY_SIZE(genl_ctrl_groups),
954 .id = GENL_ID_CTRL,
955 .name = "nlctrl",
956 .version = 0x2,
957 .maxattr = CTRL_ATTR_MAX,
958 .netnsok = true,
959};
960
Johannes Berg023e2cf2014-12-23 21:00:06 +0100961static int genl_bind(struct net *net, int group)
Johannes Bergc380d9a2014-12-23 20:54:40 +0100962{
Johannes Berg2ae0f172016-10-24 14:40:04 +0200963 struct genl_family *f;
964 int err = -ENOENT;
965 unsigned int id;
Johannes Bergc380d9a2014-12-23 20:54:40 +0100966
967 down_read(&cb_lock);
Johannes Bergc380d9a2014-12-23 20:54:40 +0100968
Johannes Berg2ae0f172016-10-24 14:40:04 +0200969 idr_for_each_entry(&genl_fam_idr, f, id) {
970 if (group >= f->mcgrp_offset &&
971 group < f->mcgrp_offset + f->n_mcgrps) {
972 int fam_grp = group - f->mcgrp_offset;
Johannes Bergc380d9a2014-12-23 20:54:40 +0100973
Johannes Berg2ae0f172016-10-24 14:40:04 +0200974 if (!f->netnsok && net != &init_net)
975 err = -ENOENT;
976 else if (f->mcast_bind)
977 err = f->mcast_bind(net, fam_grp);
978 else
979 err = 0;
980 break;
Johannes Bergc380d9a2014-12-23 20:54:40 +0100981 }
982 }
983 up_read(&cb_lock);
984
Johannes Bergc380d9a2014-12-23 20:54:40 +0100985 return err;
986}
987
Johannes Berg023e2cf2014-12-23 21:00:06 +0100988static void genl_unbind(struct net *net, int group)
Johannes Bergc380d9a2014-12-23 20:54:40 +0100989{
Johannes Berg2ae0f172016-10-24 14:40:04 +0200990 struct genl_family *f;
991 unsigned int id;
Johannes Bergc380d9a2014-12-23 20:54:40 +0100992
993 down_read(&cb_lock);
Johannes Bergc380d9a2014-12-23 20:54:40 +0100994
Johannes Berg2ae0f172016-10-24 14:40:04 +0200995 idr_for_each_entry(&genl_fam_idr, f, id) {
996 if (group >= f->mcgrp_offset &&
997 group < f->mcgrp_offset + f->n_mcgrps) {
998 int fam_grp = group - f->mcgrp_offset;
Johannes Bergc380d9a2014-12-23 20:54:40 +0100999
Johannes Berg2ae0f172016-10-24 14:40:04 +02001000 if (f->mcast_unbind)
1001 f->mcast_unbind(net, fam_grp);
1002 break;
Johannes Bergc380d9a2014-12-23 20:54:40 +01001003 }
1004 }
1005 up_read(&cb_lock);
Johannes Bergc380d9a2014-12-23 20:54:40 +01001006}
1007
Johannes Berg134e6372009-07-10 09:51:34 +00001008static int __net_init genl_pernet_init(struct net *net)
1009{
Pablo Neira Ayusoa31f2d12012-06-29 06:15:21 +00001010 struct netlink_kernel_cfg cfg = {
1011 .input = genl_rcv,
Pablo Neira Ayuso9785e102012-09-08 02:53:53 +00001012 .flags = NL_CFG_F_NONROOT_RECV,
Johannes Bergc380d9a2014-12-23 20:54:40 +01001013 .bind = genl_bind,
1014 .unbind = genl_unbind,
Pablo Neira Ayusoa31f2d12012-06-29 06:15:21 +00001015 };
1016
Johannes Berg134e6372009-07-10 09:51:34 +00001017 /* we'll bump the group number right afterwards */
Pablo Neira Ayuso9f00d972012-09-08 02:53:54 +00001018 net->genl_sock = netlink_kernel_create(net, NETLINK_GENERIC, &cfg);
Johannes Berg134e6372009-07-10 09:51:34 +00001019
1020 if (!net->genl_sock && net_eq(net, &init_net))
1021 panic("GENL: Cannot initialize generic netlink\n");
1022
1023 if (!net->genl_sock)
1024 return -ENOMEM;
1025
1026 return 0;
1027}
1028
1029static void __net_exit genl_pernet_exit(struct net *net)
1030{
1031 netlink_kernel_release(net->genl_sock);
1032 net->genl_sock = NULL;
1033}
1034
1035static struct pernet_operations genl_pernet_ops = {
1036 .init = genl_pernet_init,
1037 .exit = genl_pernet_exit,
1038};
1039
Thomas Graf482a8522005-11-10 02:25:56 +01001040static int __init genl_init(void)
1041{
Johannes Berg2ae0f172016-10-24 14:40:04 +02001042 int err;
Thomas Graf482a8522005-11-10 02:25:56 +01001043
Johannes Berg489111e2016-10-24 14:40:03 +02001044 err = genl_register_family(&genl_ctrl);
Thomas Graf482a8522005-11-10 02:25:56 +01001045 if (err < 0)
Johannes Berg134e6372009-07-10 09:51:34 +00001046 goto problem;
Thomas Graf482a8522005-11-10 02:25:56 +01001047
Johannes Berg134e6372009-07-10 09:51:34 +00001048 err = register_pernet_subsys(&genl_pernet_ops);
1049 if (err)
1050 goto problem;
Thomas Graf482a8522005-11-10 02:25:56 +01001051
1052 return 0;
1053
Johannes Berg134e6372009-07-10 09:51:34 +00001054problem:
Thomas Graf482a8522005-11-10 02:25:56 +01001055 panic("GENL: Cannot register controller: %d\n", err);
Thomas Graf482a8522005-11-10 02:25:56 +01001056}
1057
1058subsys_initcall(genl_init);
1059
Johannes Bergc90c39d2016-10-24 14:40:01 +02001060/**
1061 * genl_family_attrbuf - return family's attrbuf
1062 * @family: the family
1063 *
1064 * Return the family's attrbuf, while validating that it's
1065 * actually valid to access it.
1066 *
1067 * You cannot use this function with a family that has parallel_ops
1068 * and you can only use it within (pre/post) doit/dumpit callbacks.
1069 */
Johannes Berg2ae0f172016-10-24 14:40:04 +02001070struct nlattr **genl_family_attrbuf(const struct genl_family *family)
Johannes Bergc90c39d2016-10-24 14:40:01 +02001071{
1072 if (!WARN_ON(family->parallel_ops))
1073 lockdep_assert_held(&genl_mutex);
1074
1075 return family->attrbuf;
1076}
1077EXPORT_SYMBOL(genl_family_attrbuf);
1078
Eric W. Biederman15e47302012-09-07 20:12:54 +00001079static int genlmsg_mcast(struct sk_buff *skb, u32 portid, unsigned long group,
Johannes Berg134e6372009-07-10 09:51:34 +00001080 gfp_t flags)
1081{
1082 struct sk_buff *tmp;
1083 struct net *net, *prev = NULL;
1084 int err;
1085
1086 for_each_net_rcu(net) {
1087 if (prev) {
1088 tmp = skb_clone(skb, flags);
1089 if (!tmp) {
1090 err = -ENOMEM;
1091 goto error;
1092 }
1093 err = nlmsg_multicast(prev->genl_sock, tmp,
Eric W. Biederman15e47302012-09-07 20:12:54 +00001094 portid, group, flags);
Johannes Berg134e6372009-07-10 09:51:34 +00001095 if (err)
1096 goto error;
1097 }
1098
1099 prev = net;
1100 }
1101
Eric W. Biederman15e47302012-09-07 20:12:54 +00001102 return nlmsg_multicast(prev->genl_sock, skb, portid, group, flags);
Johannes Berg134e6372009-07-10 09:51:34 +00001103 error:
1104 kfree_skb(skb);
1105 return err;
1106}
1107
Johannes Berg2ae0f172016-10-24 14:40:04 +02001108int genlmsg_multicast_allns(const struct genl_family *family,
1109 struct sk_buff *skb, u32 portid,
1110 unsigned int group, gfp_t flags)
Johannes Berg134e6372009-07-10 09:51:34 +00001111{
Johannes Berg220815a2013-11-21 18:17:04 +01001112 if (WARN_ON_ONCE(group >= family->n_mcgrps))
Johannes Berg2a94fe42013-11-19 15:19:39 +01001113 return -EINVAL;
1114 group = family->mcgrp_offset + group;
Eric W. Biederman15e47302012-09-07 20:12:54 +00001115 return genlmsg_mcast(skb, portid, group, flags);
Johannes Berg134e6372009-07-10 09:51:34 +00001116}
1117EXPORT_SYMBOL(genlmsg_multicast_allns);
Pravin B Shelar263ba612011-11-10 19:14:37 -08001118
Johannes Berg2ae0f172016-10-24 14:40:04 +02001119void genl_notify(const struct genl_family *family, struct sk_buff *skb,
Jiri Benc92c14d92015-09-22 18:56:43 +02001120 struct genl_info *info, u32 group, gfp_t flags)
Pravin B Shelar263ba612011-11-10 19:14:37 -08001121{
Jiri Benc92c14d92015-09-22 18:56:43 +02001122 struct net *net = genl_info_net(info);
Pravin B Shelar263ba612011-11-10 19:14:37 -08001123 struct sock *sk = net->genl_sock;
1124 int report = 0;
1125
Jiri Benc92c14d92015-09-22 18:56:43 +02001126 if (info->nlhdr)
1127 report = nlmsg_report(info->nlhdr);
Pravin B Shelar263ba612011-11-10 19:14:37 -08001128
Johannes Berg220815a2013-11-21 18:17:04 +01001129 if (WARN_ON_ONCE(group >= family->n_mcgrps))
Johannes Berg2a94fe42013-11-19 15:19:39 +01001130 return;
1131 group = family->mcgrp_offset + group;
Jiri Benc92c14d92015-09-22 18:56:43 +02001132 nlmsg_notify(sk, skb, info->snd_portid, group, report, flags);
Pravin B Shelar263ba612011-11-10 19:14:37 -08001133}
1134EXPORT_SYMBOL(genl_notify);