blob: 9f357aa22b9452d17f5c391a159d263c4f3df552 [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) {
Kees Cook6da2ec52018-06-12 13:55:00 -0700355 family->attrbuf = kmalloc_array(family->maxattr + 1,
356 sizeof(struct nlattr *),
357 GFP_KERNEL);
Thomas Graf482a8522005-11-10 02:25:56 +0100358 if (family->attrbuf == NULL) {
359 err = -ENOMEM;
Jamal Hadi Salime200bd82006-02-13 15:51:24 -0800360 goto errout_locked;
Thomas Graf482a8522005-11-10 02:25:56 +0100361 }
362 } else
363 family->attrbuf = NULL;
364
Marcel Holtmann4e43df32019-04-24 22:18:53 +0200365 family->id = idr_alloc_cyclic(&genl_fam_idr, family,
366 start, end + 1, GFP_KERNEL);
Wei Yongjun22ca9042016-11-01 14:45:52 +0000367 if (family->id < 0) {
368 err = family->id;
YueHaibingceabee62019-03-21 15:02:50 +0800369 goto errout_free;
Wei Yongjun22ca9042016-11-01 14:45:52 +0000370 }
Johannes Berg2a94fe42013-11-19 15:19:39 +0100371
Johannes Berg2ae0f172016-10-24 14:40:04 +0200372 err = genl_validate_assign_mc_groups(family);
373 if (err)
374 goto errout_remove;
375
Pravin B Shelardef31172013-04-23 07:48:30 +0000376 genl_unlock_all();
Thomas Graf482a8522005-11-10 02:25:56 +0100377
Johannes Berg2a94fe42013-11-19 15:19:39 +0100378 /* send all events */
379 genl_ctrl_event(CTRL_CMD_NEWFAMILY, family, NULL, 0);
380 for (i = 0; i < family->n_mcgrps; i++)
381 genl_ctrl_event(CTRL_CMD_NEWMCAST_GRP, family,
382 &family->mcgrps[i], family->mcgrp_offset + i);
Thomas Graf482a8522005-11-10 02:25:56 +0100383
384 return 0;
385
Johannes Berg2ae0f172016-10-24 14:40:04 +0200386errout_remove:
387 idr_remove(&genl_fam_idr, family->id);
YueHaibingceabee62019-03-21 15:02:50 +0800388errout_free:
WANG Cong00ffc1b2016-11-03 09:42:35 -0700389 kfree(family->attrbuf);
Thomas Graf482a8522005-11-10 02:25:56 +0100390errout_locked:
Pravin B Shelardef31172013-04-23 07:48:30 +0000391 genl_unlock_all();
Thomas Graf482a8522005-11-10 02:25:56 +0100392 return err;
393}
Johannes Berg489111e2016-10-24 14:40:03 +0200394EXPORT_SYMBOL(genl_register_family);
Thomas Graf482a8522005-11-10 02:25:56 +0100395
396/**
397 * genl_unregister_family - unregister generic netlink family
398 * @family: generic netlink family
399 *
400 * Unregisters the specified family.
401 *
402 * Returns 0 on success or a negative error code.
403 */
Johannes Berg2ae0f172016-10-24 14:40:04 +0200404int genl_unregister_family(const struct genl_family *family)
Thomas Graf482a8522005-11-10 02:25:56 +0100405{
Pravin B Shelardef31172013-04-23 07:48:30 +0000406 genl_lock_all();
Thomas Graf482a8522005-11-10 02:25:56 +0100407
pravin shelar0e82c762016-10-28 16:01:41 -0700408 if (!genl_family_find_byid(family->id)) {
Johannes Berg2ae0f172016-10-24 14:40:04 +0200409 genl_unlock_all();
410 return -ENOENT;
Thomas Graf482a8522005-11-10 02:25:56 +0100411 }
412
Johannes Berg2ae0f172016-10-24 14:40:04 +0200413 genl_unregister_mc_groups(family);
Thomas Graf482a8522005-11-10 02:25:56 +0100414
Johannes Berg2ae0f172016-10-24 14:40:04 +0200415 idr_remove(&genl_fam_idr, family->id);
416
417 up_write(&cb_lock);
418 wait_event(genl_sk_destructing_waitq,
419 atomic_read(&genl_sk_destructing_cnt) == 0);
420 genl_unlock();
421
422 kfree(family->attrbuf);
423
424 genl_ctrl_event(CTRL_CMD_DELFAMILY, family, NULL, 0);
425
426 return 0;
Thomas Graf482a8522005-11-10 02:25:56 +0100427}
Changli Gao416c2f92010-07-25 20:46:01 +0000428EXPORT_SYMBOL(genl_unregister_family);
Thomas Graf482a8522005-11-10 02:25:56 +0100429
Denys Vlasenkoa46621a2012-01-30 15:22:06 -0500430/**
431 * genlmsg_put - Add generic netlink header to netlink message
432 * @skb: socket buffer holding the message
Eric W. Biederman15e47302012-09-07 20:12:54 +0000433 * @portid: netlink portid the message is addressed to
Denys Vlasenkoa46621a2012-01-30 15:22:06 -0500434 * @seq: sequence number (usually the one of the sender)
435 * @family: generic netlink family
Ben Hutchings2c530402012-07-10 10:55:09 +0000436 * @flags: netlink message flags
Denys Vlasenkoa46621a2012-01-30 15:22:06 -0500437 * @cmd: generic netlink command
438 *
439 * Returns pointer to user specific header
440 */
Eric W. Biederman15e47302012-09-07 20:12:54 +0000441void *genlmsg_put(struct sk_buff *skb, u32 portid, u32 seq,
Johannes Berg2ae0f172016-10-24 14:40:04 +0200442 const struct genl_family *family, int flags, u8 cmd)
Denys Vlasenkoa46621a2012-01-30 15:22:06 -0500443{
444 struct nlmsghdr *nlh;
445 struct genlmsghdr *hdr;
446
Eric W. Biederman15e47302012-09-07 20:12:54 +0000447 nlh = nlmsg_put(skb, portid, seq, family->id, GENL_HDRLEN +
Denys Vlasenkoa46621a2012-01-30 15:22:06 -0500448 family->hdrsize, flags);
449 if (nlh == NULL)
450 return NULL;
451
452 hdr = nlmsg_data(nlh);
453 hdr->cmd = cmd;
454 hdr->version = family->version;
455 hdr->reserved = 0;
456
457 return (char *) hdr + GENL_HDRLEN;
458}
459EXPORT_SYMBOL(genlmsg_put);
460
Jiri Pirko1927f412019-10-05 20:04:34 +0200461static struct genl_dumpit_info *genl_dumpit_info_alloc(void)
462{
463 return kmalloc(sizeof(struct genl_dumpit_info), GFP_KERNEL);
464}
465
466static void genl_dumpit_info_free(const struct genl_dumpit_info *info)
467{
468 kfree(info);
469}
470
Jiri Pirkoc10e6cf2019-10-05 20:04:35 +0200471static struct nlattr **
472genl_family_rcv_msg_attrs_parse(const struct genl_family *family,
473 struct nlmsghdr *nlh,
474 struct netlink_ext_ack *extack,
475 const struct genl_ops *ops,
476 int hdrlen,
Jiri Pirkoab5b5262019-10-08 12:31:43 +0200477 enum genl_validate_flags no_strict_flag,
478 bool parallel)
Jiri Pirkoc10e6cf2019-10-05 20:04:35 +0200479{
480 enum netlink_validation validate = ops->validate & no_strict_flag ?
481 NL_VALIDATE_LIBERAL :
482 NL_VALIDATE_STRICT;
483 struct nlattr **attrbuf;
484 int err;
485
Michal Kubecekcb0ce182019-10-11 09:40:09 +0200486 if (!family->maxattr)
487 return NULL;
488
Jiri Pirkoab5b5262019-10-08 12:31:43 +0200489 if (parallel) {
Jiri Pirkoc10e6cf2019-10-05 20:04:35 +0200490 attrbuf = kmalloc_array(family->maxattr + 1,
491 sizeof(struct nlattr *), GFP_KERNEL);
492 if (!attrbuf)
493 return ERR_PTR(-ENOMEM);
494 } else {
495 attrbuf = family->attrbuf;
496 }
497
498 err = __nlmsg_parse(nlh, hdrlen, attrbuf, family->maxattr,
499 family->policy, validate, extack);
Paolo Abeni39f3b412020-02-21 19:42:13 +0100500 if (err) {
501 if (parallel)
502 kfree(attrbuf);
Jiri Pirkoc10e6cf2019-10-05 20:04:35 +0200503 return ERR_PTR(err);
504 }
505 return attrbuf;
506}
507
508static void genl_family_rcv_msg_attrs_free(const struct genl_family *family,
Jiri Pirkoab5b5262019-10-08 12:31:43 +0200509 struct nlattr **attrbuf,
510 bool parallel)
Jiri Pirkoc10e6cf2019-10-05 20:04:35 +0200511{
Jiri Pirkoab5b5262019-10-08 12:31:43 +0200512 if (parallel)
Jiri Pirkoc10e6cf2019-10-05 20:04:35 +0200513 kfree(attrbuf);
514}
515
Tom Herbertfc9e50f2015-12-15 15:41:37 -0800516static int genl_lock_start(struct netlink_callback *cb)
517{
Jiri Pirko1927f412019-10-05 20:04:34 +0200518 const struct genl_ops *ops = genl_dumpit_info(cb)->ops;
Tom Herbertfc9e50f2015-12-15 15:41:37 -0800519 int rc = 0;
520
521 if (ops->start) {
522 genl_lock();
523 rc = ops->start(cb);
524 genl_unlock();
525 }
526 return rc;
527}
528
Pravin B Shelar9b963092013-08-23 12:44:55 -0700529static int genl_lock_dumpit(struct sk_buff *skb, struct netlink_callback *cb)
530{
Jiri Pirko1927f412019-10-05 20:04:34 +0200531 const struct genl_ops *ops = genl_dumpit_info(cb)->ops;
Pravin B Shelar9b963092013-08-23 12:44:55 -0700532 int rc;
533
534 genl_lock();
535 rc = ops->dumpit(skb, cb);
536 genl_unlock();
537 return rc;
538}
539
540static int genl_lock_done(struct netlink_callback *cb)
541{
Jiri Pirko1927f412019-10-05 20:04:34 +0200542 const struct genl_dumpit_info *info = genl_dumpit_info(cb);
543 const struct genl_ops *ops = info->ops;
Pravin B Shelar9b963092013-08-23 12:44:55 -0700544 int rc = 0;
545
546 if (ops->done) {
547 genl_lock();
548 rc = ops->done(cb);
549 genl_unlock();
550 }
Jiri Pirkoab5b5262019-10-08 12:31:43 +0200551 genl_family_rcv_msg_attrs_free(info->family, info->attrs, true);
Jiri Pirko1927f412019-10-05 20:04:34 +0200552 genl_dumpit_info_free(info);
553 return rc;
554}
555
556static int genl_parallel_done(struct netlink_callback *cb)
557{
558 const struct genl_dumpit_info *info = genl_dumpit_info(cb);
559 const struct genl_ops *ops = info->ops;
560 int rc = 0;
561
562 if (ops->done)
563 rc = ops->done(cb);
Jiri Pirkoab5b5262019-10-08 12:31:43 +0200564 genl_family_rcv_msg_attrs_free(info->family, info->attrs, true);
Jiri Pirko1927f412019-10-05 20:04:34 +0200565 genl_dumpit_info_free(info);
Pravin B Shelar9b963092013-08-23 12:44:55 -0700566 return rc;
567}
568
Jiri Pirkobe064de2019-10-05 20:04:33 +0200569static int genl_family_rcv_msg_dumpit(const struct genl_family *family,
570 struct sk_buff *skb,
571 struct nlmsghdr *nlh,
572 struct netlink_ext_ack *extack,
573 const struct genl_ops *ops,
574 int hdrlen, struct net *net)
Thomas Graf482a8522005-11-10 02:25:56 +0100575{
Jiri Pirko1927f412019-10-05 20:04:34 +0200576 struct genl_dumpit_info *info;
Jiri Pirkobf813b02019-10-05 20:04:36 +0200577 struct nlattr **attrs = NULL;
Jiri Pirkobe064de2019-10-05 20:04:33 +0200578 int err;
Thomas Graf482a8522005-11-10 02:25:56 +0100579
Jiri Pirkobe064de2019-10-05 20:04:33 +0200580 if (!ops->dumpit)
Thomas Graf1d00a4e2007-03-22 23:30:12 -0700581 return -EOPNOTSUPP;
Thomas Graf482a8522005-11-10 02:25:56 +0100582
Jiri Pirkobf813b02019-10-05 20:04:36 +0200583 if (ops->validate & GENL_DONT_VALIDATE_DUMP)
584 goto no_attrs;
Thomas Graf482a8522005-11-10 02:25:56 +0100585
Jiri Pirkobf813b02019-10-05 20:04:36 +0200586 if (nlh->nlmsg_len < nlmsg_msg_size(hdrlen))
587 return -EINVAL;
Tycho Andersen4a926022016-02-05 09:20:52 -0700588
Jiri Pirkobf813b02019-10-05 20:04:36 +0200589 attrs = genl_family_rcv_msg_attrs_parse(family, nlh, extack,
590 ops, hdrlen,
Jiri Pirkoab5b5262019-10-08 12:31:43 +0200591 GENL_DONT_VALIDATE_DUMP_STRICT,
592 true);
Jiri Pirkobf813b02019-10-05 20:04:36 +0200593 if (IS_ERR(attrs))
594 return PTR_ERR(attrs);
595
596no_attrs:
Jiri Pirko1927f412019-10-05 20:04:34 +0200597 /* Allocate dumpit info. It is going to be freed by done() callback. */
598 info = genl_dumpit_info_alloc();
Jiri Pirkobf813b02019-10-05 20:04:36 +0200599 if (!info) {
Jiri Pirkoab5b5262019-10-08 12:31:43 +0200600 genl_family_rcv_msg_attrs_free(family, attrs, true);
Jiri Pirko1927f412019-10-05 20:04:34 +0200601 return -ENOMEM;
Jiri Pirkobf813b02019-10-05 20:04:36 +0200602 }
Jiri Pirko1927f412019-10-05 20:04:34 +0200603
Jiri Pirkobf813b02019-10-05 20:04:36 +0200604 info->family = family;
Jiri Pirko1927f412019-10-05 20:04:34 +0200605 info->ops = ops;
Jiri Pirkobf813b02019-10-05 20:04:36 +0200606 info->attrs = attrs;
Jiri Pirko1927f412019-10-05 20:04:34 +0200607
Jiri Pirkobe064de2019-10-05 20:04:33 +0200608 if (!family->parallel_ops) {
609 struct netlink_dump_control c = {
610 .module = family->module,
Jiri Pirko1927f412019-10-05 20:04:34 +0200611 .data = info,
Jiri Pirkobe064de2019-10-05 20:04:33 +0200612 .start = genl_lock_start,
613 .dump = genl_lock_dumpit,
614 .done = genl_lock_done,
615 };
616
617 genl_unlock();
618 err = __netlink_dump_start(net->genl_sock, skb, nlh, &c);
619 genl_lock();
620
621 } else {
622 struct netlink_dump_control c = {
623 .module = family->module,
Jiri Pirko1927f412019-10-05 20:04:34 +0200624 .data = info,
Jiri Pirkobe064de2019-10-05 20:04:33 +0200625 .start = ops->start,
626 .dump = ops->dumpit,
Jiri Pirko1927f412019-10-05 20:04:34 +0200627 .done = genl_parallel_done,
Jiri Pirkobe064de2019-10-05 20:04:33 +0200628 };
629
630 err = __netlink_dump_start(net->genl_sock, skb, nlh, &c);
631 }
632
633 return err;
634}
635
636static int genl_family_rcv_msg_doit(const struct genl_family *family,
637 struct sk_buff *skb,
638 struct nlmsghdr *nlh,
639 struct netlink_ext_ack *extack,
640 const struct genl_ops *ops,
641 int hdrlen, struct net *net)
642{
643 struct nlattr **attrbuf;
644 struct genl_info info;
645 int err;
646
647 if (!ops->doit)
Thomas Graf1d00a4e2007-03-22 23:30:12 -0700648 return -EOPNOTSUPP;
Thomas Graf482a8522005-11-10 02:25:56 +0100649
Jiri Pirkoc10e6cf2019-10-05 20:04:35 +0200650 attrbuf = genl_family_rcv_msg_attrs_parse(family, nlh, extack,
651 ops, hdrlen,
Jiri Pirkoab5b5262019-10-08 12:31:43 +0200652 GENL_DONT_VALIDATE_STRICT,
Jiri Pirkoab5b5262019-10-08 12:31:43 +0200653 family->parallel_ops);
Jiri Pirkoc10e6cf2019-10-05 20:04:35 +0200654 if (IS_ERR(attrbuf))
655 return PTR_ERR(attrbuf);
Thomas Graf482a8522005-11-10 02:25:56 +0100656
657 info.snd_seq = nlh->nlmsg_seq;
Eric W. Biederman15e47302012-09-07 20:12:54 +0000658 info.snd_portid = NETLINK_CB(skb).portid;
Thomas Graf482a8522005-11-10 02:25:56 +0100659 info.nlhdr = nlh;
660 info.genlhdr = nlmsg_data(nlh);
661 info.userhdr = nlmsg_data(nlh) + GENL_HDRLEN;
Pravin B Shelardef31172013-04-23 07:48:30 +0000662 info.attrs = attrbuf;
Johannes Berg7ab606d2017-04-12 14:34:05 +0200663 info.extack = extack;
Johannes Berg134e6372009-07-10 09:51:34 +0000664 genl_info_net_set(&info, net);
Johannes Bergff4c92d2010-10-04 21:14:03 +0200665 memset(&info.user_ptr, 0, sizeof(info.user_ptr));
Thomas Graf482a8522005-11-10 02:25:56 +0100666
Johannes Bergff4c92d2010-10-04 21:14:03 +0200667 if (family->pre_doit) {
668 err = family->pre_doit(ops, skb, &info);
669 if (err)
Wei Yongjun50754d212013-04-26 15:34:16 +0000670 goto out;
Johannes Bergff4c92d2010-10-04 21:14:03 +0200671 }
672
673 err = ops->doit(skb, &info);
674
675 if (family->post_doit)
676 family->post_doit(ops, skb, &info);
677
Wei Yongjun50754d212013-04-26 15:34:16 +0000678out:
Michal Kubecekcb0ce182019-10-11 09:40:09 +0200679 genl_family_rcv_msg_attrs_free(family, attrbuf, family->parallel_ops);
Pravin B Shelardef31172013-04-23 07:48:30 +0000680
681 return err;
682}
683
Jiri Pirkobe064de2019-10-05 20:04:33 +0200684static int genl_family_rcv_msg(const struct genl_family *family,
685 struct sk_buff *skb,
686 struct nlmsghdr *nlh,
687 struct netlink_ext_ack *extack)
688{
689 const struct genl_ops *ops;
690 struct net *net = sock_net(skb->sk);
691 struct genlmsghdr *hdr = nlmsg_data(nlh);
692 int hdrlen;
693
694 /* this family doesn't exist in this netns */
695 if (!family->netnsok && !net_eq(net, &init_net))
696 return -ENOENT;
697
698 hdrlen = GENL_HDRLEN + family->hdrsize;
699 if (nlh->nlmsg_len < nlmsg_msg_size(hdrlen))
700 return -EINVAL;
701
702 ops = genl_get_cmd(hdr->cmd, family);
703 if (ops == NULL)
704 return -EOPNOTSUPP;
705
706 if ((ops->flags & GENL_ADMIN_PERM) &&
707 !netlink_capable(skb, CAP_NET_ADMIN))
708 return -EPERM;
709
710 if ((ops->flags & GENL_UNS_ADMIN_PERM) &&
711 !netlink_ns_capable(skb, net->user_ns, CAP_NET_ADMIN))
712 return -EPERM;
713
714 if ((nlh->nlmsg_flags & NLM_F_DUMP) == NLM_F_DUMP)
715 return genl_family_rcv_msg_dumpit(family, skb, nlh, extack,
716 ops, hdrlen, net);
717 else
718 return genl_family_rcv_msg_doit(family, skb, nlh, extack,
719 ops, hdrlen, net);
720}
721
Johannes Berg2d4bc932017-04-12 14:34:04 +0200722static int genl_rcv_msg(struct sk_buff *skb, struct nlmsghdr *nlh,
723 struct netlink_ext_ack *extack)
Pravin B Shelardef31172013-04-23 07:48:30 +0000724{
Johannes Berg2ae0f172016-10-24 14:40:04 +0200725 const struct genl_family *family;
Pravin B Shelardef31172013-04-23 07:48:30 +0000726 int err;
727
728 family = genl_family_find_byid(nlh->nlmsg_type);
729 if (family == NULL)
730 return -ENOENT;
731
732 if (!family->parallel_ops)
733 genl_lock();
734
Johannes Berg7ab606d2017-04-12 14:34:05 +0200735 err = genl_family_rcv_msg(family, skb, nlh, extack);
Pravin B Shelardef31172013-04-23 07:48:30 +0000736
737 if (!family->parallel_ops)
738 genl_unlock();
739
Johannes Bergff4c92d2010-10-04 21:14:03 +0200740 return err;
Thomas Graf482a8522005-11-10 02:25:56 +0100741}
742
Denis V. Lunevcd40b7d2007-10-10 21:15:29 -0700743static void genl_rcv(struct sk_buff *skb)
Thomas Graf482a8522005-11-10 02:25:56 +0100744{
Pravin B Shelardef31172013-04-23 07:48:30 +0000745 down_read(&cb_lock);
Denis V. Lunevcd40b7d2007-10-10 21:15:29 -0700746 netlink_rcv_skb(skb, &genl_rcv_msg);
Pravin B Shelardef31172013-04-23 07:48:30 +0000747 up_read(&cb_lock);
Thomas Graf482a8522005-11-10 02:25:56 +0100748}
749
750/**************************************************************************
751 * Controller
752 **************************************************************************/
753
Johannes Berg489111e2016-10-24 14:40:03 +0200754static struct genl_family genl_ctrl;
Thomas Graf17c157c2006-11-14 19:46:02 -0800755
Johannes Berg2ae0f172016-10-24 14:40:04 +0200756static int ctrl_fill_info(const struct genl_family *family, u32 portid, u32 seq,
Thomas Graf482a8522005-11-10 02:25:56 +0100757 u32 flags, struct sk_buff *skb, u8 cmd)
758{
759 void *hdr;
760
Eric W. Biederman15e47302012-09-07 20:12:54 +0000761 hdr = genlmsg_put(skb, portid, seq, &genl_ctrl, flags, cmd);
Thomas Graf482a8522005-11-10 02:25:56 +0100762 if (hdr == NULL)
763 return -1;
764
David S. Miller444653f2012-03-29 23:25:11 -0400765 if (nla_put_string(skb, CTRL_ATTR_FAMILY_NAME, family->name) ||
766 nla_put_u16(skb, CTRL_ATTR_FAMILY_ID, family->id) ||
767 nla_put_u32(skb, CTRL_ATTR_VERSION, family->version) ||
768 nla_put_u32(skb, CTRL_ATTR_HDRSIZE, family->hdrsize) ||
769 nla_put_u32(skb, CTRL_ATTR_MAXATTR, family->maxattr))
770 goto nla_put_failure;
Thomas Grafeb328112006-09-18 00:01:59 -0700771
Johannes Bergd91824c2013-11-14 17:14:44 +0100772 if (family->n_ops) {
Thomas Grafe94ef682006-11-23 11:44:37 -0800773 struct nlattr *nla_ops;
Johannes Bergd91824c2013-11-14 17:14:44 +0100774 int i;
Thomas Grafeb328112006-09-18 00:01:59 -0700775
Michal Kubecekae0be8d2019-04-26 11:13:06 +0200776 nla_ops = nla_nest_start_noflag(skb, CTRL_ATTR_OPS);
Thomas Grafe94ef682006-11-23 11:44:37 -0800777 if (nla_ops == NULL)
Thomas Grafeb328112006-09-18 00:01:59 -0700778 goto nla_put_failure;
779
Johannes Bergd91824c2013-11-14 17:14:44 +0100780 for (i = 0; i < family->n_ops; i++) {
Thomas Grafe94ef682006-11-23 11:44:37 -0800781 struct nlattr *nest;
Johannes Bergf84f7712013-11-14 17:14:45 +0100782 const struct genl_ops *ops = &family->ops[i];
Johannes Berg029b2342013-11-18 20:54:58 +0100783 u32 op_flags = ops->flags;
Johannes Bergf84f7712013-11-14 17:14:45 +0100784
785 if (ops->dumpit)
Johannes Berg029b2342013-11-18 20:54:58 +0100786 op_flags |= GENL_CMD_CAP_DUMP;
Johannes Bergf84f7712013-11-14 17:14:45 +0100787 if (ops->doit)
Johannes Berg029b2342013-11-18 20:54:58 +0100788 op_flags |= GENL_CMD_CAP_DO;
Johannes Berg3b0f31f2019-03-21 22:51:02 +0100789 if (family->policy)
Johannes Berg029b2342013-11-18 20:54:58 +0100790 op_flags |= GENL_CMD_CAP_HASPOL;
Thomas Grafeb328112006-09-18 00:01:59 -0700791
Michal Kubecekae0be8d2019-04-26 11:13:06 +0200792 nest = nla_nest_start_noflag(skb, i + 1);
Thomas Grafe94ef682006-11-23 11:44:37 -0800793 if (nest == NULL)
794 goto nla_put_failure;
Thomas Grafeb328112006-09-18 00:01:59 -0700795
David S. Miller444653f2012-03-29 23:25:11 -0400796 if (nla_put_u32(skb, CTRL_ATTR_OP_ID, ops->cmd) ||
Johannes Berg029b2342013-11-18 20:54:58 +0100797 nla_put_u32(skb, CTRL_ATTR_OP_FLAGS, op_flags))
David S. Miller444653f2012-03-29 23:25:11 -0400798 goto nla_put_failure;
Thomas Grafeb328112006-09-18 00:01:59 -0700799
Thomas Grafe94ef682006-11-23 11:44:37 -0800800 nla_nest_end(skb, nest);
801 }
802
803 nla_nest_end(skb, nla_ops);
Thomas Grafeb328112006-09-18 00:01:59 -0700804 }
805
Johannes Berg2a94fe42013-11-19 15:19:39 +0100806 if (family->n_mcgrps) {
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700807 struct nlattr *nla_grps;
Johannes Berg2a94fe42013-11-19 15:19:39 +0100808 int i;
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700809
Michal Kubecekae0be8d2019-04-26 11:13:06 +0200810 nla_grps = nla_nest_start_noflag(skb, CTRL_ATTR_MCAST_GROUPS);
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700811 if (nla_grps == NULL)
812 goto nla_put_failure;
813
Johannes Berg2a94fe42013-11-19 15:19:39 +0100814 for (i = 0; i < family->n_mcgrps; i++) {
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700815 struct nlattr *nest;
Johannes Berg2a94fe42013-11-19 15:19:39 +0100816 const struct genl_multicast_group *grp;
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700817
Johannes Berg2a94fe42013-11-19 15:19:39 +0100818 grp = &family->mcgrps[i];
819
Michal Kubecekae0be8d2019-04-26 11:13:06 +0200820 nest = nla_nest_start_noflag(skb, i + 1);
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700821 if (nest == NULL)
822 goto nla_put_failure;
823
Johannes Berg2a94fe42013-11-19 15:19:39 +0100824 if (nla_put_u32(skb, CTRL_ATTR_MCAST_GRP_ID,
825 family->mcgrp_offset + i) ||
David S. Miller444653f2012-03-29 23:25:11 -0400826 nla_put_string(skb, CTRL_ATTR_MCAST_GRP_NAME,
827 grp->name))
828 goto nla_put_failure;
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700829
830 nla_nest_end(skb, nest);
831 }
832 nla_nest_end(skb, nla_grps);
833 }
834
Johannes Berg053c0952015-01-16 22:09:00 +0100835 genlmsg_end(skb, hdr);
836 return 0;
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700837
838nla_put_failure:
Thomas Grafbc3ed282008-06-03 16:36:54 -0700839 genlmsg_cancel(skb, hdr);
840 return -EMSGSIZE;
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700841}
842
Johannes Berg2ae0f172016-10-24 14:40:04 +0200843static int ctrl_fill_mcgrp_info(const struct genl_family *family,
Johannes Berg2a94fe42013-11-19 15:19:39 +0100844 const struct genl_multicast_group *grp,
845 int grp_id, u32 portid, u32 seq, u32 flags,
846 struct sk_buff *skb, u8 cmd)
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700847{
848 void *hdr;
849 struct nlattr *nla_grps;
850 struct nlattr *nest;
851
Eric W. Biederman15e47302012-09-07 20:12:54 +0000852 hdr = genlmsg_put(skb, portid, seq, &genl_ctrl, flags, cmd);
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700853 if (hdr == NULL)
854 return -1;
855
Johannes Bergc2ebb902013-11-19 15:19:36 +0100856 if (nla_put_string(skb, CTRL_ATTR_FAMILY_NAME, family->name) ||
857 nla_put_u16(skb, CTRL_ATTR_FAMILY_ID, family->id))
David S. Miller444653f2012-03-29 23:25:11 -0400858 goto nla_put_failure;
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700859
Michal Kubecekae0be8d2019-04-26 11:13:06 +0200860 nla_grps = nla_nest_start_noflag(skb, CTRL_ATTR_MCAST_GROUPS);
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700861 if (nla_grps == NULL)
862 goto nla_put_failure;
863
Michal Kubecekae0be8d2019-04-26 11:13:06 +0200864 nest = nla_nest_start_noflag(skb, 1);
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700865 if (nest == NULL)
866 goto nla_put_failure;
867
Johannes Berg2a94fe42013-11-19 15:19:39 +0100868 if (nla_put_u32(skb, CTRL_ATTR_MCAST_GRP_ID, grp_id) ||
David S. Miller444653f2012-03-29 23:25:11 -0400869 nla_put_string(skb, CTRL_ATTR_MCAST_GRP_NAME,
870 grp->name))
871 goto nla_put_failure;
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700872
873 nla_nest_end(skb, nest);
874 nla_nest_end(skb, nla_grps);
875
Johannes Berg053c0952015-01-16 22:09:00 +0100876 genlmsg_end(skb, hdr);
877 return 0;
Thomas Graf482a8522005-11-10 02:25:56 +0100878
879nla_put_failure:
Thomas Grafbc3ed282008-06-03 16:36:54 -0700880 genlmsg_cancel(skb, hdr);
881 return -EMSGSIZE;
Thomas Graf482a8522005-11-10 02:25:56 +0100882}
883
884static int ctrl_dumpfamily(struct sk_buff *skb, struct netlink_callback *cb)
885{
Johannes Berg2ae0f172016-10-24 14:40:04 +0200886 int n = 0;
Thomas Graf482a8522005-11-10 02:25:56 +0100887 struct genl_family *rt;
Johannes Berg134e6372009-07-10 09:51:34 +0000888 struct net *net = sock_net(skb->sk);
Johannes Berg2ae0f172016-10-24 14:40:04 +0200889 int fams_to_skip = cb->args[0];
890 unsigned int id;
Thomas Graf482a8522005-11-10 02:25:56 +0100891
Johannes Berg2ae0f172016-10-24 14:40:04 +0200892 idr_for_each_entry(&genl_fam_idr, rt, id) {
893 if (!rt->netnsok && !net_eq(net, &init_net))
894 continue;
Thomas Graf482a8522005-11-10 02:25:56 +0100895
Johannes Berg2ae0f172016-10-24 14:40:04 +0200896 if (n++ < fams_to_skip)
897 continue;
898
899 if (ctrl_fill_info(rt, NETLINK_CB(cb->skb).portid,
900 cb->nlh->nlmsg_seq, NLM_F_MULTI,
Stanislaw Gruszka1d2a6a52017-03-22 16:08:33 +0100901 skb, CTRL_CMD_NEWFAMILY) < 0) {
902 n--;
Johannes Berg2ae0f172016-10-24 14:40:04 +0200903 break;
Stanislaw Gruszka1d2a6a52017-03-22 16:08:33 +0100904 }
Thomas Graf482a8522005-11-10 02:25:56 +0100905 }
906
Johannes Berg2ae0f172016-10-24 14:40:04 +0200907 cb->args[0] = n;
Thomas Graf482a8522005-11-10 02:25:56 +0100908 return skb->len;
909}
910
Johannes Berg2ae0f172016-10-24 14:40:04 +0200911static struct sk_buff *ctrl_build_family_msg(const struct genl_family *family,
Eric W. Biederman15e47302012-09-07 20:12:54 +0000912 u32 portid, int seq, u8 cmd)
Thomas Graf482a8522005-11-10 02:25:56 +0100913{
914 struct sk_buff *skb;
915 int err;
916
Thomas Graf339bf982006-11-10 14:10:15 -0800917 skb = nlmsg_new(NLMSG_DEFAULT_SIZE, GFP_KERNEL);
Thomas Graf482a8522005-11-10 02:25:56 +0100918 if (skb == NULL)
919 return ERR_PTR(-ENOBUFS);
920
Eric W. Biederman15e47302012-09-07 20:12:54 +0000921 err = ctrl_fill_info(family, portid, seq, 0, skb, cmd);
Thomas Graf482a8522005-11-10 02:25:56 +0100922 if (err < 0) {
923 nlmsg_free(skb);
924 return ERR_PTR(err);
925 }
926
927 return skb;
928}
929
Johannes Berg2a94fe42013-11-19 15:19:39 +0100930static struct sk_buff *
Johannes Berg2ae0f172016-10-24 14:40:04 +0200931ctrl_build_mcgrp_msg(const struct genl_family *family,
Johannes Berg2a94fe42013-11-19 15:19:39 +0100932 const struct genl_multicast_group *grp,
933 int grp_id, u32 portid, int seq, u8 cmd)
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700934{
935 struct sk_buff *skb;
936 int err;
937
938 skb = nlmsg_new(NLMSG_DEFAULT_SIZE, GFP_KERNEL);
939 if (skb == NULL)
940 return ERR_PTR(-ENOBUFS);
941
Johannes Berg2a94fe42013-11-19 15:19:39 +0100942 err = ctrl_fill_mcgrp_info(family, grp, grp_id, portid,
943 seq, 0, skb, cmd);
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700944 if (err < 0) {
945 nlmsg_free(skb);
946 return ERR_PTR(err);
947 }
948
949 return skb;
950}
951
Patrick McHardyef7c79e2007-06-05 12:38:30 -0700952static const struct nla_policy ctrl_policy[CTRL_ATTR_MAX+1] = {
Thomas Graf482a8522005-11-10 02:25:56 +0100953 [CTRL_ATTR_FAMILY_ID] = { .type = NLA_U16 },
Thomas Graf5176f912006-08-26 20:13:18 -0700954 [CTRL_ATTR_FAMILY_NAME] = { .type = NLA_NUL_STRING,
955 .len = GENL_NAMSIZ - 1 },
Thomas Graf482a8522005-11-10 02:25:56 +0100956};
957
958static int ctrl_getfamily(struct sk_buff *skb, struct genl_info *info)
959{
960 struct sk_buff *msg;
Johannes Berg2ae0f172016-10-24 14:40:04 +0200961 const struct genl_family *res = NULL;
Thomas Graf482a8522005-11-10 02:25:56 +0100962 int err = -EINVAL;
963
964 if (info->attrs[CTRL_ATTR_FAMILY_ID]) {
965 u16 id = nla_get_u16(info->attrs[CTRL_ATTR_FAMILY_ID]);
966 res = genl_family_find_byid(id);
Johannes Berg134e6372009-07-10 09:51:34 +0000967 err = -ENOENT;
Thomas Graf482a8522005-11-10 02:25:56 +0100968 }
969
970 if (info->attrs[CTRL_ATTR_FAMILY_NAME]) {
Thomas Graf5176f912006-08-26 20:13:18 -0700971 char *name;
Thomas Graf482a8522005-11-10 02:25:56 +0100972
Thomas Graf5176f912006-08-26 20:13:18 -0700973 name = nla_data(info->attrs[CTRL_ATTR_FAMILY_NAME]);
Thomas Graf482a8522005-11-10 02:25:56 +0100974 res = genl_family_find_byname(name);
Stephen Hemmingerfa843092011-12-28 13:48:55 -0500975#ifdef CONFIG_MODULES
976 if (res == NULL) {
977 genl_unlock();
Stanislaw Gruszkac74f2b22013-07-26 11:00:10 +0200978 up_read(&cb_lock);
Neil Hormane9412c32012-05-29 09:30:41 +0000979 request_module("net-pf-%d-proto-%d-family-%s",
Stephen Hemmingerfa843092011-12-28 13:48:55 -0500980 PF_NETLINK, NETLINK_GENERIC, name);
Stanislaw Gruszkac74f2b22013-07-26 11:00:10 +0200981 down_read(&cb_lock);
Stephen Hemmingerfa843092011-12-28 13:48:55 -0500982 genl_lock();
983 res = genl_family_find_byname(name);
984 }
985#endif
Johannes Berg134e6372009-07-10 09:51:34 +0000986 err = -ENOENT;
Thomas Graf482a8522005-11-10 02:25:56 +0100987 }
988
Johannes Berg134e6372009-07-10 09:51:34 +0000989 if (res == NULL)
990 return err;
991
992 if (!res->netnsok && !net_eq(genl_info_net(info), &init_net)) {
993 /* family doesn't exist here */
994 return -ENOENT;
Thomas Graf482a8522005-11-10 02:25:56 +0100995 }
996
Eric W. Biederman15e47302012-09-07 20:12:54 +0000997 msg = ctrl_build_family_msg(res, info->snd_portid, info->snd_seq,
Johannes Berg2dbba6f2007-07-18 15:47:52 -0700998 CTRL_CMD_NEWFAMILY);
Johannes Berg134e6372009-07-10 09:51:34 +0000999 if (IS_ERR(msg))
1000 return PTR_ERR(msg);
Thomas Graf482a8522005-11-10 02:25:56 +01001001
Johannes Berg134e6372009-07-10 09:51:34 +00001002 return genlmsg_reply(msg, info);
Thomas Graf482a8522005-11-10 02:25:56 +01001003}
1004
Johannes Berg2ae0f172016-10-24 14:40:04 +02001005static int genl_ctrl_event(int event, const struct genl_family *family,
Johannes Berg2a94fe42013-11-19 15:19:39 +01001006 const struct genl_multicast_group *grp,
1007 int grp_id)
Thomas Graf482a8522005-11-10 02:25:56 +01001008{
1009 struct sk_buff *msg;
1010
Johannes Berg134e6372009-07-10 09:51:34 +00001011 /* genl is still initialising */
1012 if (!init_net.genl_sock)
Thomas Graf482a8522005-11-10 02:25:56 +01001013 return 0;
1014
1015 switch (event) {
1016 case CTRL_CMD_NEWFAMILY:
1017 case CTRL_CMD_DELFAMILY:
Johannes Bergc2ebb902013-11-19 15:19:36 +01001018 WARN_ON(grp);
Johannes Berg134e6372009-07-10 09:51:34 +00001019 msg = ctrl_build_family_msg(family, 0, 0, event);
Johannes Berg2dbba6f2007-07-18 15:47:52 -07001020 break;
1021 case CTRL_CMD_NEWMCAST_GRP:
1022 case CTRL_CMD_DELMCAST_GRP:
Johannes Bergc2ebb902013-11-19 15:19:36 +01001023 BUG_ON(!grp);
Johannes Berg2a94fe42013-11-19 15:19:39 +01001024 msg = ctrl_build_mcgrp_msg(family, grp, grp_id, 0, 0, event);
Thomas Graf482a8522005-11-10 02:25:56 +01001025 break;
Johannes Berg134e6372009-07-10 09:51:34 +00001026 default:
1027 return -EINVAL;
1028 }
1029
1030 if (IS_ERR(msg))
1031 return PTR_ERR(msg);
1032
1033 if (!family->netnsok) {
Johannes Berg68eb5502013-11-19 15:19:38 +01001034 genlmsg_multicast_netns(&genl_ctrl, &init_net, msg, 0,
Johannes Berg2a94fe42013-11-19 15:19:39 +01001035 0, GFP_KERNEL);
Johannes Berg134e6372009-07-10 09:51:34 +00001036 } else {
1037 rcu_read_lock();
Johannes Berg68eb5502013-11-19 15:19:38 +01001038 genlmsg_multicast_allns(&genl_ctrl, msg, 0,
Johannes Berg2a94fe42013-11-19 15:19:39 +01001039 0, GFP_ATOMIC);
Johannes Berg134e6372009-07-10 09:51:34 +00001040 rcu_read_unlock();
Thomas Graf482a8522005-11-10 02:25:56 +01001041 }
1042
1043 return 0;
1044}
1045
stephen hemminger12d8de62016-08-31 15:22:00 -07001046static const struct genl_ops genl_ctrl_ops[] = {
Johannes Bergc53ed742013-11-19 15:19:31 +01001047 {
1048 .cmd = CTRL_CMD_GETFAMILY,
Johannes Bergef6243a2019-04-26 14:07:31 +02001049 .validate = GENL_DONT_VALIDATE_STRICT | GENL_DONT_VALIDATE_DUMP,
Johannes Bergc53ed742013-11-19 15:19:31 +01001050 .doit = ctrl_getfamily,
1051 .dumpit = ctrl_dumpfamily,
Johannes Bergc53ed742013-11-19 15:19:31 +01001052 },
Thomas Graf482a8522005-11-10 02:25:56 +01001053};
1054
stephen hemminger12d8de62016-08-31 15:22:00 -07001055static const struct genl_multicast_group genl_ctrl_groups[] = {
Johannes Berg2a94fe42013-11-19 15:19:39 +01001056 { .name = "notify", },
Johannes Berg2dbba6f2007-07-18 15:47:52 -07001057};
1058
Johannes Berg56989f62016-10-24 14:40:05 +02001059static struct genl_family genl_ctrl __ro_after_init = {
Johannes Berg489111e2016-10-24 14:40:03 +02001060 .module = THIS_MODULE,
1061 .ops = genl_ctrl_ops,
1062 .n_ops = ARRAY_SIZE(genl_ctrl_ops),
1063 .mcgrps = genl_ctrl_groups,
1064 .n_mcgrps = ARRAY_SIZE(genl_ctrl_groups),
1065 .id = GENL_ID_CTRL,
1066 .name = "nlctrl",
1067 .version = 0x2,
1068 .maxattr = CTRL_ATTR_MAX,
Johannes Berg3b0f31f2019-03-21 22:51:02 +01001069 .policy = ctrl_policy,
Johannes Berg489111e2016-10-24 14:40:03 +02001070 .netnsok = true,
1071};
1072
Johannes Berg023e2cf2014-12-23 21:00:06 +01001073static int genl_bind(struct net *net, int group)
Johannes Bergc380d9a2014-12-23 20:54:40 +01001074{
Johannes Berg2ae0f172016-10-24 14:40:04 +02001075 struct genl_family *f;
1076 int err = -ENOENT;
1077 unsigned int id;
Johannes Bergc380d9a2014-12-23 20:54:40 +01001078
1079 down_read(&cb_lock);
Johannes Bergc380d9a2014-12-23 20:54:40 +01001080
Johannes Berg2ae0f172016-10-24 14:40:04 +02001081 idr_for_each_entry(&genl_fam_idr, f, id) {
1082 if (group >= f->mcgrp_offset &&
1083 group < f->mcgrp_offset + f->n_mcgrps) {
1084 int fam_grp = group - f->mcgrp_offset;
Johannes Bergc380d9a2014-12-23 20:54:40 +01001085
Johannes Berg2ae0f172016-10-24 14:40:04 +02001086 if (!f->netnsok && net != &init_net)
1087 err = -ENOENT;
1088 else if (f->mcast_bind)
1089 err = f->mcast_bind(net, fam_grp);
1090 else
1091 err = 0;
1092 break;
Johannes Bergc380d9a2014-12-23 20:54:40 +01001093 }
1094 }
1095 up_read(&cb_lock);
1096
Johannes Bergc380d9a2014-12-23 20:54:40 +01001097 return err;
1098}
1099
Johannes Berg023e2cf2014-12-23 21:00:06 +01001100static void genl_unbind(struct net *net, int group)
Johannes Bergc380d9a2014-12-23 20:54:40 +01001101{
Johannes Berg2ae0f172016-10-24 14:40:04 +02001102 struct genl_family *f;
1103 unsigned int id;
Johannes Bergc380d9a2014-12-23 20:54:40 +01001104
1105 down_read(&cb_lock);
Johannes Bergc380d9a2014-12-23 20:54:40 +01001106
Johannes Berg2ae0f172016-10-24 14:40:04 +02001107 idr_for_each_entry(&genl_fam_idr, f, id) {
1108 if (group >= f->mcgrp_offset &&
1109 group < f->mcgrp_offset + f->n_mcgrps) {
1110 int fam_grp = group - f->mcgrp_offset;
Johannes Bergc380d9a2014-12-23 20:54:40 +01001111
Johannes Berg2ae0f172016-10-24 14:40:04 +02001112 if (f->mcast_unbind)
1113 f->mcast_unbind(net, fam_grp);
1114 break;
Johannes Bergc380d9a2014-12-23 20:54:40 +01001115 }
1116 }
1117 up_read(&cb_lock);
Johannes Bergc380d9a2014-12-23 20:54:40 +01001118}
1119
Johannes Berg134e6372009-07-10 09:51:34 +00001120static int __net_init genl_pernet_init(struct net *net)
1121{
Pablo Neira Ayusoa31f2d12012-06-29 06:15:21 +00001122 struct netlink_kernel_cfg cfg = {
1123 .input = genl_rcv,
Pablo Neira Ayuso9785e102012-09-08 02:53:53 +00001124 .flags = NL_CFG_F_NONROOT_RECV,
Johannes Bergc380d9a2014-12-23 20:54:40 +01001125 .bind = genl_bind,
1126 .unbind = genl_unbind,
Pablo Neira Ayusoa31f2d12012-06-29 06:15:21 +00001127 };
1128
Johannes Berg134e6372009-07-10 09:51:34 +00001129 /* we'll bump the group number right afterwards */
Pablo Neira Ayuso9f00d972012-09-08 02:53:54 +00001130 net->genl_sock = netlink_kernel_create(net, NETLINK_GENERIC, &cfg);
Johannes Berg134e6372009-07-10 09:51:34 +00001131
1132 if (!net->genl_sock && net_eq(net, &init_net))
1133 panic("GENL: Cannot initialize generic netlink\n");
1134
1135 if (!net->genl_sock)
1136 return -ENOMEM;
1137
1138 return 0;
1139}
1140
1141static void __net_exit genl_pernet_exit(struct net *net)
1142{
1143 netlink_kernel_release(net->genl_sock);
1144 net->genl_sock = NULL;
1145}
1146
1147static struct pernet_operations genl_pernet_ops = {
1148 .init = genl_pernet_init,
1149 .exit = genl_pernet_exit,
1150};
1151
Thomas Graf482a8522005-11-10 02:25:56 +01001152static int __init genl_init(void)
1153{
Johannes Berg2ae0f172016-10-24 14:40:04 +02001154 int err;
Thomas Graf482a8522005-11-10 02:25:56 +01001155
Johannes Berg489111e2016-10-24 14:40:03 +02001156 err = genl_register_family(&genl_ctrl);
Thomas Graf482a8522005-11-10 02:25:56 +01001157 if (err < 0)
Johannes Berg134e6372009-07-10 09:51:34 +00001158 goto problem;
Thomas Graf482a8522005-11-10 02:25:56 +01001159
Johannes Berg134e6372009-07-10 09:51:34 +00001160 err = register_pernet_subsys(&genl_pernet_ops);
1161 if (err)
1162 goto problem;
Thomas Graf482a8522005-11-10 02:25:56 +01001163
1164 return 0;
1165
Johannes Berg134e6372009-07-10 09:51:34 +00001166problem:
Thomas Graf482a8522005-11-10 02:25:56 +01001167 panic("GENL: Cannot register controller: %d\n", err);
Thomas Graf482a8522005-11-10 02:25:56 +01001168}
1169
1170subsys_initcall(genl_init);
1171
Eric W. Biederman15e47302012-09-07 20:12:54 +00001172static int genlmsg_mcast(struct sk_buff *skb, u32 portid, unsigned long group,
Johannes Berg134e6372009-07-10 09:51:34 +00001173 gfp_t flags)
1174{
1175 struct sk_buff *tmp;
1176 struct net *net, *prev = NULL;
Nicolas Dichtelcb9f7a92018-02-06 14:48:32 +01001177 bool delivered = false;
Johannes Berg134e6372009-07-10 09:51:34 +00001178 int err;
1179
1180 for_each_net_rcu(net) {
1181 if (prev) {
1182 tmp = skb_clone(skb, flags);
1183 if (!tmp) {
1184 err = -ENOMEM;
1185 goto error;
1186 }
1187 err = nlmsg_multicast(prev->genl_sock, tmp,
Eric W. Biederman15e47302012-09-07 20:12:54 +00001188 portid, group, flags);
Nicolas Dichtelcb9f7a92018-02-06 14:48:32 +01001189 if (!err)
1190 delivered = true;
1191 else if (err != -ESRCH)
Johannes Berg134e6372009-07-10 09:51:34 +00001192 goto error;
1193 }
1194
1195 prev = net;
1196 }
1197
Nicolas Dichtelcb9f7a92018-02-06 14:48:32 +01001198 err = nlmsg_multicast(prev->genl_sock, skb, portid, group, flags);
1199 if (!err)
1200 delivered = true;
1201 else if (err != -ESRCH)
Nicolas Dichtel02a23852018-03-14 21:10:23 +01001202 return err;
Nicolas Dichtelcb9f7a92018-02-06 14:48:32 +01001203 return delivered ? 0 : -ESRCH;
Johannes Berg134e6372009-07-10 09:51:34 +00001204 error:
1205 kfree_skb(skb);
1206 return err;
1207}
1208
Johannes Berg2ae0f172016-10-24 14:40:04 +02001209int genlmsg_multicast_allns(const struct genl_family *family,
1210 struct sk_buff *skb, u32 portid,
1211 unsigned int group, gfp_t flags)
Johannes Berg134e6372009-07-10 09:51:34 +00001212{
Johannes Berg220815a2013-11-21 18:17:04 +01001213 if (WARN_ON_ONCE(group >= family->n_mcgrps))
Johannes Berg2a94fe42013-11-19 15:19:39 +01001214 return -EINVAL;
1215 group = family->mcgrp_offset + group;
Eric W. Biederman15e47302012-09-07 20:12:54 +00001216 return genlmsg_mcast(skb, portid, group, flags);
Johannes Berg134e6372009-07-10 09:51:34 +00001217}
1218EXPORT_SYMBOL(genlmsg_multicast_allns);
Pravin B Shelar263ba612011-11-10 19:14:37 -08001219
Johannes Berg2ae0f172016-10-24 14:40:04 +02001220void genl_notify(const struct genl_family *family, struct sk_buff *skb,
Jiri Benc92c14d92015-09-22 18:56:43 +02001221 struct genl_info *info, u32 group, gfp_t flags)
Pravin B Shelar263ba612011-11-10 19:14:37 -08001222{
Jiri Benc92c14d92015-09-22 18:56:43 +02001223 struct net *net = genl_info_net(info);
Pravin B Shelar263ba612011-11-10 19:14:37 -08001224 struct sock *sk = net->genl_sock;
1225 int report = 0;
1226
Jiri Benc92c14d92015-09-22 18:56:43 +02001227 if (info->nlhdr)
1228 report = nlmsg_report(info->nlhdr);
Pravin B Shelar263ba612011-11-10 19:14:37 -08001229
Johannes Berg220815a2013-11-21 18:17:04 +01001230 if (WARN_ON_ONCE(group >= family->n_mcgrps))
Johannes Berg2a94fe42013-11-19 15:19:39 +01001231 return;
1232 group = family->mcgrp_offset + group;
Jiri Benc92c14d92015-09-22 18:56:43 +02001233 nlmsg_notify(sk, skb, info->snd_portid, group, report, flags);
Pravin B Shelar263ba612011-11-10 19:14:37 -08001234}
1235EXPORT_SYMBOL(genl_notify);