blob: faa461c16f1216fbbe39542a1d9a64213f2eb2dd [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/* Helpers for initial module or kernel cmdline parsing
2 Copyright (C) 2001 Rusty Russell.
3
4 This program is free software; you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation; either version 2 of the License, or
7 (at your option) any later version.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
13
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
17*/
Linus Torvalds1da177e2005-04-16 15:20:36 -070018#include <linux/kernel.h>
19#include <linux/string.h>
20#include <linux/errno.h>
21#include <linux/module.h>
Geert Uytterhoeven63a12d92014-10-13 15:55:44 -070022#include <linux/moduleparam.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070023#include <linux/device.h>
24#include <linux/err.h>
Tim Schmielau4e57b682005-10-30 15:03:48 -080025#include <linux/slab.h>
Peter Oberparleiter26d052b2009-07-06 17:11:22 +020026#include <linux/ctype.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027
Rusty Russellcf2fde72015-06-26 06:44:38 +093028#ifdef CONFIG_SYSFS
Dan Streetmanb51d23e2015-06-17 06:18:52 +093029/* Protects all built-in parameters, modules use their own param_lock */
Rusty Russell907b29e2010-08-11 23:04:19 -060030static DEFINE_MUTEX(param_lock);
31
Dan Streetmanb51d23e2015-06-17 06:18:52 +093032/* Use the module's mutex, or if built-in use the built-in mutex */
33#define KPARAM_MUTEX(mod) ((mod) ? &(mod)->param_lock : &param_lock)
Rusty Russellcf2fde72015-06-26 06:44:38 +093034
35static inline void check_kparam_locked(struct module *mod)
36{
37 BUG_ON(!mutex_is_locked(KPARAM_MUTEX(mod)));
38}
39#else
40static inline void check_kparam_locked(struct module *mod)
41{
42}
43#endif /* !CONFIG_SYSFS */
Dan Streetmanb51d23e2015-06-17 06:18:52 +093044
Rusty Russella1054322010-08-11 23:04:18 -060045/* This just allows us to keep track of which parameters are kmalloced. */
46struct kmalloced_param {
47 struct list_head list;
48 char val[];
49};
Rusty Russella1054322010-08-11 23:04:18 -060050static LIST_HEAD(kmalloced_params);
Dan Streetmanb51d23e2015-06-17 06:18:52 +093051static DEFINE_SPINLOCK(kmalloced_params_lock);
Rusty Russella1054322010-08-11 23:04:18 -060052
53static void *kmalloc_parameter(unsigned int size)
54{
55 struct kmalloced_param *p;
56
57 p = kmalloc(sizeof(*p) + size, GFP_KERNEL);
58 if (!p)
59 return NULL;
60
Dan Streetmanb51d23e2015-06-17 06:18:52 +093061 spin_lock(&kmalloced_params_lock);
Rusty Russella1054322010-08-11 23:04:18 -060062 list_add(&p->list, &kmalloced_params);
Dan Streetmanb51d23e2015-06-17 06:18:52 +093063 spin_unlock(&kmalloced_params_lock);
64
Rusty Russella1054322010-08-11 23:04:18 -060065 return p->val;
66}
67
68/* Does nothing if parameter wasn't kmalloced above. */
69static void maybe_kfree_parameter(void *param)
70{
71 struct kmalloced_param *p;
72
Dan Streetmanb51d23e2015-06-17 06:18:52 +093073 spin_lock(&kmalloced_params_lock);
Rusty Russella1054322010-08-11 23:04:18 -060074 list_for_each_entry(p, &kmalloced_params, list) {
75 if (p->val == param) {
76 list_del(&p->list);
77 kfree(p);
78 break;
79 }
80 }
Dan Streetmanb51d23e2015-06-17 06:18:52 +093081 spin_unlock(&kmalloced_params_lock);
Rusty Russella1054322010-08-11 23:04:18 -060082}
83
Michal Schmidtb1e4d202011-10-10 00:03:37 +020084static char dash2underscore(char c)
Linus Torvalds1da177e2005-04-16 15:20:36 -070085{
86 if (c == '-')
87 return '_';
88 return c;
89}
90
Michal Schmidtb1e4d202011-10-10 00:03:37 +020091bool parameqn(const char *a, const char *b, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -070092{
Michal Schmidtb1e4d202011-10-10 00:03:37 +020093 size_t i;
94
95 for (i = 0; i < n; i++) {
96 if (dash2underscore(a[i]) != dash2underscore(b[i]))
97 return false;
98 }
99 return true;
100}
101
102bool parameq(const char *a, const char *b)
103{
104 return parameqn(a, b, strlen(a)+1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105}
106
Rusty Russell7a486d32014-08-27 06:25:23 +0930107static void param_check_unsafe(const struct kernel_param *kp)
108{
109 if (kp->flags & KERNEL_PARAM_FL_UNSAFE) {
110 pr_warn("Setting dangerous option %s - tainting kernel\n",
111 kp->name);
112 add_taint(TAINT_USER, LOCKDEP_STILL_OK);
113 }
114}
115
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116static int parse_one(char *param,
117 char *val,
Jim Cromie9fb48c72012-04-27 14:30:34 -0600118 const char *doing,
Rusty Russell914dcaa2010-08-11 23:04:18 -0600119 const struct kernel_param *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120 unsigned num_params,
Pawel Moll026cee02012-03-26 12:50:51 +1030121 s16 min_level,
122 s16 max_level,
Jim Cromie9fb48c72012-04-27 14:30:34 -0600123 int (*handle_unknown)(char *param, char *val,
124 const char *doing))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125{
126 unsigned int i;
Rusty Russell907b29e2010-08-11 23:04:19 -0600127 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700128
129 /* Find parameter */
130 for (i = 0; i < num_params; i++) {
131 if (parameq(param, params[i].name)) {
Pawel Moll026cee02012-03-26 12:50:51 +1030132 if (params[i].level < min_level
133 || params[i].level > max_level)
134 return 0;
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300135 /* No one handled NULL, so do it here. */
Steven Rostedtab013c52013-08-20 15:33:19 +0930136 if (!val &&
Jani Nikula6a4c2642014-08-27 06:21:23 +0930137 !(params[i].ops->flags & KERNEL_PARAM_OPS_FL_NOARG))
Rusty Russell2e9fb992010-08-11 23:04:10 -0600138 return -EINVAL;
Jim Cromie9fb48c72012-04-27 14:30:34 -0600139 pr_debug("handling %s with %p\n", param,
140 params[i].ops->set);
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930141 kernel_param_lock(params[i].mod);
Rusty Russell7a486d32014-08-27 06:25:23 +0930142 param_check_unsafe(&params[i]);
Rusty Russell907b29e2010-08-11 23:04:19 -0600143 err = params[i].ops->set(val, &params[i]);
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930144 kernel_param_unlock(params[i].mod);
Rusty Russell907b29e2010-08-11 23:04:19 -0600145 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 }
147 }
148
149 if (handle_unknown) {
Jim Cromie9fb48c72012-04-27 14:30:34 -0600150 pr_debug("doing %s: %s='%s'\n", doing, param, val);
151 return handle_unknown(param, val, doing);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700152 }
153
Jim Cromie9fb48c72012-04-27 14:30:34 -0600154 pr_debug("Unknown argument '%s'\n", param);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700155 return -ENOENT;
156}
157
158/* You can use " around spaces, but can't escape ". */
159/* Hyphens and underscores equivalent in parameter names. */
160static char *next_arg(char *args, char **param, char **val)
161{
162 unsigned int i, equals = 0;
163 int in_quote = 0, quoted = 0;
164 char *next;
165
Linus Torvalds1da177e2005-04-16 15:20:36 -0700166 if (*args == '"') {
167 args++;
168 in_quote = 1;
169 quoted = 1;
170 }
171
172 for (i = 0; args[i]; i++) {
Peter Oberparleiter26d052b2009-07-06 17:11:22 +0200173 if (isspace(args[i]) && !in_quote)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174 break;
175 if (equals == 0) {
176 if (args[i] == '=')
177 equals = i;
178 }
179 if (args[i] == '"')
180 in_quote = !in_quote;
181 }
182
183 *param = args;
184 if (!equals)
185 *val = NULL;
186 else {
187 args[equals] = '\0';
188 *val = args + equals + 1;
189
190 /* Don't include quotes in value. */
191 if (**val == '"') {
192 (*val)++;
193 if (args[i-1] == '"')
194 args[i-1] = '\0';
195 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196 }
Rusty Russellb9cc4482015-04-15 13:23:48 +0930197 if (quoted && args[i-1] == '"')
198 args[i-1] = '\0';
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199
200 if (args[i]) {
201 args[i] = '\0';
202 next = args + i + 1;
203 } else
204 next = args + i;
Rusty Russellf36462f2005-09-27 21:45:34 -0700205
206 /* Chew up trailing spaces. */
André Goddard Rosae7d28602009-12-14 18:01:06 -0800207 return skip_spaces(next);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208}
209
210/* Args looks like "foo=bar,bar2 baz=fuz wiz". */
Rusty Russell51e158c2014-04-28 11:34:33 +0930211char *parse_args(const char *doing,
212 char *args,
213 const struct kernel_param *params,
214 unsigned num,
215 s16 min_level,
216 s16 max_level,
217 int (*unknown)(char *param, char *val, const char *doing))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218{
219 char *param, *val;
220
Rusty Russellf36462f2005-09-27 21:45:34 -0700221 /* Chew leading spaces */
André Goddard Rosae7d28602009-12-14 18:01:06 -0800222 args = skip_spaces(args);
Rusty Russellf36462f2005-09-27 21:45:34 -0700223
Jim Cromie1ef9eaf2012-05-03 11:57:37 -0600224 if (*args)
Jim Cromie9fb48c72012-04-27 14:30:34 -0600225 pr_debug("doing %s, parsing ARGS: '%s'\n", doing, args);
226
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227 while (*args) {
228 int ret;
Ard van Breemena416aba2007-01-05 16:36:20 -0800229 int irq_was_disabled;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230
231 args = next_arg(args, &param, &val);
Rusty Russell51e158c2014-04-28 11:34:33 +0930232 /* Stop at -- */
233 if (!val && strcmp(param, "--") == 0)
234 return args;
Ard van Breemena416aba2007-01-05 16:36:20 -0800235 irq_was_disabled = irqs_disabled();
Jim Cromie9fb48c72012-04-27 14:30:34 -0600236 ret = parse_one(param, val, doing, params, num,
Pawel Moll026cee02012-03-26 12:50:51 +1030237 min_level, max_level, unknown);
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600238 if (irq_was_disabled && !irqs_disabled())
239 pr_warn("%s: option '%s' enabled irq's!\n",
240 doing, param);
241
Linus Torvalds1da177e2005-04-16 15:20:36 -0700242 switch (ret) {
243 case -ENOENT:
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600244 pr_err("%s: Unknown parameter `%s'\n", doing, param);
Rusty Russell51e158c2014-04-28 11:34:33 +0930245 return ERR_PTR(ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 case -ENOSPC:
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600247 pr_err("%s: `%s' too large for parameter `%s'\n",
Jim Cromie9fb48c72012-04-27 14:30:34 -0600248 doing, val ?: "", param);
Rusty Russell51e158c2014-04-28 11:34:33 +0930249 return ERR_PTR(ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250 case 0:
251 break;
252 default:
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600253 pr_err("%s: `%s' invalid for parameter `%s'\n",
Jim Cromie9fb48c72012-04-27 14:30:34 -0600254 doing, val ?: "", param);
Rusty Russell51e158c2014-04-28 11:34:33 +0930255 return ERR_PTR(ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 }
257 }
258
259 /* All parsed OK. */
Rusty Russell51e158c2014-04-28 11:34:33 +0930260 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261}
262
263/* Lazy bastard, eh? */
Felipe Contreras88a88b322013-12-04 14:09:38 +1030264#define STANDARD_PARAM_DEF(name, type, format, strtolfn) \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600265 int param_set_##name(const char *val, const struct kernel_param *kp) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 { \
Felipe Contreras88a88b322013-12-04 14:09:38 +1030267 return strtolfn(val, 0, (type *)kp->arg); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 } \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600269 int param_get_##name(char *buffer, const struct kernel_param *kp) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270 { \
Chen Gangf4940ab72013-08-20 15:35:04 +0930271 return scnprintf(buffer, PAGE_SIZE, format, \
272 *((type *)kp->arg)); \
Rusty Russella14fe242010-08-11 23:04:11 -0600273 } \
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930274 const struct kernel_param_ops param_ops_##name = { \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600275 .set = param_set_##name, \
276 .get = param_get_##name, \
277 }; \
Rusty Russella14fe242010-08-11 23:04:11 -0600278 EXPORT_SYMBOL(param_set_##name); \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600279 EXPORT_SYMBOL(param_get_##name); \
280 EXPORT_SYMBOL(param_ops_##name)
281
Linus Torvalds1da177e2005-04-16 15:20:36 -0700282
Felipe Contreras88a88b322013-12-04 14:09:38 +1030283STANDARD_PARAM_DEF(byte, unsigned char, "%hhu", kstrtou8);
284STANDARD_PARAM_DEF(short, short, "%hi", kstrtos16);
285STANDARD_PARAM_DEF(ushort, unsigned short, "%hu", kstrtou16);
286STANDARD_PARAM_DEF(int, int, "%i", kstrtoint);
287STANDARD_PARAM_DEF(uint, unsigned int, "%u", kstrtouint);
288STANDARD_PARAM_DEF(long, long, "%li", kstrtol);
289STANDARD_PARAM_DEF(ulong, unsigned long, "%lu", kstrtoul);
Hannes Reineckeb4210b82014-06-25 15:27:37 +0200290STANDARD_PARAM_DEF(ullong, unsigned long long, "%llu", kstrtoull);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600292int param_set_charp(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 if (strlen(val) > 1024) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600295 pr_err("%s: string parameter too long\n", kp->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 return -ENOSPC;
297 }
298
Rusty Russella1054322010-08-11 23:04:18 -0600299 maybe_kfree_parameter(*(char **)kp->arg);
300
301 /* This is a hack. We can't kmalloc in early boot, and we
Rusty Russelle180a6b2009-03-31 13:05:29 -0600302 * don't need to; this mangled commandline is preserved. */
303 if (slab_is_available()) {
Rusty Russella1054322010-08-11 23:04:18 -0600304 *(char **)kp->arg = kmalloc_parameter(strlen(val)+1);
Rusty Russelld553ad82009-10-29 08:56:17 -0600305 if (!*(char **)kp->arg)
Rusty Russelle180a6b2009-03-31 13:05:29 -0600306 return -ENOMEM;
Rusty Russella1054322010-08-11 23:04:18 -0600307 strcpy(*(char **)kp->arg, val);
Rusty Russelle180a6b2009-03-31 13:05:29 -0600308 } else
309 *(const char **)kp->arg = val;
310
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311 return 0;
312}
Rusty Russella14fe242010-08-11 23:04:11 -0600313EXPORT_SYMBOL(param_set_charp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600315int param_get_charp(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316{
Chen Gangf4940ab72013-08-20 15:35:04 +0930317 return scnprintf(buffer, PAGE_SIZE, "%s", *((char **)kp->arg));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318}
Rusty Russella14fe242010-08-11 23:04:11 -0600319EXPORT_SYMBOL(param_get_charp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320
Rusty Russella1054322010-08-11 23:04:18 -0600321static void param_free_charp(void *arg)
322{
323 maybe_kfree_parameter(*((char **)arg));
324}
325
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930326const struct kernel_param_ops param_ops_charp = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600327 .set = param_set_charp,
328 .get = param_get_charp,
Rusty Russella1054322010-08-11 23:04:18 -0600329 .free = param_free_charp,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600330};
331EXPORT_SYMBOL(param_ops_charp);
332
Rusty Russellfddd5202009-06-12 21:46:57 -0600333/* Actually could be a bool or an int, for historical reasons. */
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600334int param_set_bool(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335{
336 /* No equals means "set"... */
337 if (!val) val = "1";
338
339 /* One of =[yYnN01] */
Rusty Russell8b825282012-03-26 12:50:51 +1030340 return strtobool(val, kp->arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341}
Rusty Russella14fe242010-08-11 23:04:11 -0600342EXPORT_SYMBOL(param_set_bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600344int param_get_bool(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345{
346 /* Y and N chosen as being relatively non-coder friendly */
Rusty Russell8b825282012-03-26 12:50:51 +1030347 return sprintf(buffer, "%c", *(bool *)kp->arg ? 'Y' : 'N');
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348}
Rusty Russella14fe242010-08-11 23:04:11 -0600349EXPORT_SYMBOL(param_get_bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930351const struct kernel_param_ops param_ops_bool = {
Jani Nikula6a4c2642014-08-27 06:21:23 +0930352 .flags = KERNEL_PARAM_OPS_FL_NOARG,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600353 .set = param_set_bool,
354 .get = param_get_bool,
355};
356EXPORT_SYMBOL(param_ops_bool);
357
Luis R. Rodriguezd19f05d2015-05-27 11:09:38 +0930358int param_set_bool_enable_only(const char *val, const struct kernel_param *kp)
359{
360 int err = 0;
361 bool new_value;
362 bool orig_value = *(bool *)kp->arg;
363 struct kernel_param dummy_kp = *kp;
364
365 dummy_kp.arg = &new_value;
366
367 err = param_set_bool(val, &dummy_kp);
368 if (err)
369 return err;
370
371 /* Don't let them unset it once it's set! */
372 if (!new_value && orig_value)
373 return -EROFS;
374
375 if (new_value)
376 err = param_set_bool(val, kp);
377
378 return err;
379}
380EXPORT_SYMBOL_GPL(param_set_bool_enable_only);
381
382const struct kernel_param_ops param_ops_bool_enable_only = {
383 .flags = KERNEL_PARAM_OPS_FL_NOARG,
384 .set = param_set_bool_enable_only,
385 .get = param_get_bool,
386};
Luis R. Rodriguez154be212015-05-27 11:09:39 +0930387EXPORT_SYMBOL_GPL(param_ops_bool_enable_only);
Luis R. Rodriguezd19f05d2015-05-27 11:09:38 +0930388
Rusty Russellfddd5202009-06-12 21:46:57 -0600389/* This one must be bool. */
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600390int param_set_invbool(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700391{
Rusty Russellfddd5202009-06-12 21:46:57 -0600392 int ret;
393 bool boolval;
Jan Beulich22e48ea2007-10-16 23:29:34 -0700394 struct kernel_param dummy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395
Jan Beulich22e48ea2007-10-16 23:29:34 -0700396 dummy.arg = &boolval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397 ret = param_set_bool(val, &dummy);
398 if (ret == 0)
Rusty Russell9a71af22009-06-12 21:46:53 -0600399 *(bool *)kp->arg = !boolval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400 return ret;
401}
Rusty Russella14fe242010-08-11 23:04:11 -0600402EXPORT_SYMBOL(param_set_invbool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600404int param_get_invbool(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405{
Rusty Russell9a71af22009-06-12 21:46:53 -0600406 return sprintf(buffer, "%c", (*(bool *)kp->arg) ? 'N' : 'Y');
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407}
Rusty Russella14fe242010-08-11 23:04:11 -0600408EXPORT_SYMBOL(param_get_invbool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930410const struct kernel_param_ops param_ops_invbool = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600411 .set = param_set_invbool,
412 .get = param_get_invbool,
413};
414EXPORT_SYMBOL(param_ops_invbool);
415
Rusty Russell69116f22012-01-13 09:32:17 +1030416int param_set_bint(const char *val, const struct kernel_param *kp)
417{
Dan Streetman5104b7d2015-06-17 06:17:52 +0930418 /* Match bool exactly, by re-using it. */
419 struct kernel_param boolkp = *kp;
Rusty Russell69116f22012-01-13 09:32:17 +1030420 bool v;
421 int ret;
422
Rusty Russell69116f22012-01-13 09:32:17 +1030423 boolkp.arg = &v;
Rusty Russell69116f22012-01-13 09:32:17 +1030424
425 ret = param_set_bool(val, &boolkp);
426 if (ret == 0)
427 *(int *)kp->arg = v;
428 return ret;
429}
430EXPORT_SYMBOL(param_set_bint);
431
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930432const struct kernel_param_ops param_ops_bint = {
Jani Nikula6a4c2642014-08-27 06:21:23 +0930433 .flags = KERNEL_PARAM_OPS_FL_NOARG,
Rusty Russell69116f22012-01-13 09:32:17 +1030434 .set = param_set_bint,
435 .get = param_get_int,
436};
437EXPORT_SYMBOL(param_ops_bint);
438
Bert Wesarg9730b5b2007-05-08 00:28:50 -0700439/* We break the rule and mangle the string. */
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930440static int param_array(struct module *mod,
441 const char *name,
Adrian Bunk98717282006-03-25 03:07:06 -0800442 const char *val,
443 unsigned int min, unsigned int max,
444 void *elem, int elemsize,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600445 int (*set)(const char *, const struct kernel_param *kp),
Pawel Moll026cee02012-03-26 12:50:51 +1030446 s16 level,
Richard Knutssoneb38a992008-02-06 01:37:50 -0800447 unsigned int *num)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448{
449 int ret;
450 struct kernel_param kp;
451 char save;
452
453 /* Get the name right for errors. */
454 kp.name = name;
455 kp.arg = elem;
Pawel Moll026cee02012-03-26 12:50:51 +1030456 kp.level = level;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 *num = 0;
459 /* We expect a comma-separated list of values. */
460 do {
461 int len;
462
463 if (*num == max) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600464 pr_err("%s: can only take %i arguments\n", name, max);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 return -EINVAL;
466 }
467 len = strcspn(val, ",");
468
469 /* nul-terminate and parse */
470 save = val[len];
471 ((char *)val)[len] = '\0';
Rusty Russellcf2fde72015-06-26 06:44:38 +0930472 check_kparam_locked(mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 ret = set(val, &kp);
474
475 if (ret != 0)
476 return ret;
477 kp.arg += elemsize;
478 val += len+1;
479 (*num)++;
480 } while (save == ',');
481
482 if (*num < min) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600483 pr_err("%s: needs at least %i arguments\n", name, min);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484 return -EINVAL;
485 }
486 return 0;
487}
488
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600489static int param_array_set(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700491 const struct kparam_array *arr = kp->arr;
Bert Wesarg31143a12005-04-16 15:25:42 -0700492 unsigned int temp_num;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930494 return param_array(kp->mod, kp->name, val, 1, arr->max, arr->elem,
Pawel Moll026cee02012-03-26 12:50:51 +1030495 arr->elemsize, arr->ops->set, kp->level,
Rusty Russell3c7d76e2009-10-29 08:56:19 -0600496 arr->num ?: &temp_num);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497}
498
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600499static int param_array_get(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500{
501 int i, off, ret;
Jan Beulich22e48ea2007-10-16 23:29:34 -0700502 const struct kparam_array *arr = kp->arr;
Dan Streetman5104b7d2015-06-17 06:17:52 +0930503 struct kernel_param p = *kp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505 for (i = off = 0; i < (arr->num ? *arr->num : arr->max); i++) {
506 if (i)
507 buffer[off++] = ',';
508 p.arg = arr->elem + arr->elemsize * i;
Rusty Russellcf2fde72015-06-26 06:44:38 +0930509 check_kparam_locked(p.mod);
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600510 ret = arr->ops->get(buffer + off, &p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511 if (ret < 0)
512 return ret;
513 off += ret;
514 }
515 buffer[off] = '\0';
516 return off;
517}
518
Rusty Russelle6df34a2010-08-11 23:04:17 -0600519static void param_array_free(void *arg)
520{
521 unsigned int i;
522 const struct kparam_array *arr = arg;
523
524 if (arr->ops->free)
525 for (i = 0; i < (arr->num ? *arr->num : arr->max); i++)
526 arr->ops->free(arr->elem + arr->elemsize * i);
527}
528
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930529const struct kernel_param_ops param_array_ops = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600530 .set = param_array_set,
531 .get = param_array_get,
Rusty Russelle6df34a2010-08-11 23:04:17 -0600532 .free = param_array_free,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600533};
534EXPORT_SYMBOL(param_array_ops);
535
536int param_set_copystring(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700537{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700538 const struct kparam_string *kps = kp->str;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539
540 if (strlen(val)+1 > kps->maxlen) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600541 pr_err("%s: string doesn't fit in %u chars.\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542 kp->name, kps->maxlen-1);
543 return -ENOSPC;
544 }
545 strcpy(kps->string, val);
546 return 0;
547}
Rusty Russella14fe242010-08-11 23:04:11 -0600548EXPORT_SYMBOL(param_set_copystring);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600550int param_get_string(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700552 const struct kparam_string *kps = kp->str;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 return strlcpy(buffer, kps->string, kps->maxlen);
554}
Rusty Russella14fe242010-08-11 23:04:11 -0600555EXPORT_SYMBOL(param_get_string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930557const struct kernel_param_ops param_ops_string = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600558 .set = param_set_copystring,
559 .get = param_get_string,
560};
561EXPORT_SYMBOL(param_ops_string);
562
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563/* sysfs output in /sys/modules/XYZ/parameters/ */
Edward Z. Yang350f8252010-02-01 18:26:59 -0500564#define to_module_attr(n) container_of(n, struct module_attribute, attr)
565#define to_module_kobject(n) container_of(n, struct module_kobject, kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567struct param_attribute
568{
569 struct module_attribute mattr;
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600570 const struct kernel_param *param;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571};
572
573struct module_param_attrs
574{
Rusty Russell9b473de2008-10-22 10:00:22 -0500575 unsigned int num;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576 struct attribute_group grp;
577 struct param_attribute attrs[0];
578};
579
Randy Dunlapef665c12007-02-13 15:19:06 -0800580#ifdef CONFIG_SYSFS
Edward Z. Yang350f8252010-02-01 18:26:59 -0500581#define to_param_attr(n) container_of(n, struct param_attribute, mattr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582
583static ssize_t param_attr_show(struct module_attribute *mattr,
Kay Sievers4befb022011-07-24 22:06:04 +0930584 struct module_kobject *mk, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585{
586 int count;
587 struct param_attribute *attribute = to_param_attr(mattr);
588
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600589 if (!attribute->param->ops->get)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 return -EPERM;
591
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930592 kernel_param_lock(mk->mod);
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600593 count = attribute->param->ops->get(buf, attribute->param);
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930594 kernel_param_unlock(mk->mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 if (count > 0) {
596 strcat(buf, "\n");
597 ++count;
598 }
599 return count;
600}
601
602/* sysfs always hands a nul-terminated string in buf. We rely on that. */
603static ssize_t param_attr_store(struct module_attribute *mattr,
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930604 struct module_kobject *mk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 const char *buf, size_t len)
606{
607 int err;
608 struct param_attribute *attribute = to_param_attr(mattr);
609
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600610 if (!attribute->param->ops->set)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700611 return -EPERM;
612
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930613 kernel_param_lock(mk->mod);
Rusty Russell7a486d32014-08-27 06:25:23 +0930614 param_check_unsafe(attribute->param);
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600615 err = attribute->param->ops->set(buf, attribute->param);
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930616 kernel_param_unlock(mk->mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617 if (!err)
618 return len;
619 return err;
620}
Randy Dunlapef665c12007-02-13 15:19:06 -0800621#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622
623#ifdef CONFIG_MODULES
624#define __modinit
625#else
626#define __modinit __init
627#endif
628
Rusty Russellcf2fde72015-06-26 06:44:38 +0930629#ifdef CONFIG_SYSFS
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930630void kernel_param_lock(struct module *mod)
Rusty Russell907b29e2010-08-11 23:04:19 -0600631{
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930632 mutex_lock(KPARAM_MUTEX(mod));
Rusty Russell907b29e2010-08-11 23:04:19 -0600633}
Rusty Russell907b29e2010-08-11 23:04:19 -0600634
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930635void kernel_param_unlock(struct module *mod)
Rusty Russell907b29e2010-08-11 23:04:19 -0600636{
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930637 mutex_unlock(KPARAM_MUTEX(mod));
Rusty Russell907b29e2010-08-11 23:04:19 -0600638}
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930639
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930640EXPORT_SYMBOL(kernel_param_lock);
641EXPORT_SYMBOL(kernel_param_unlock);
Rusty Russell907b29e2010-08-11 23:04:19 -0600642
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643/*
Rusty Russell9b473de2008-10-22 10:00:22 -0500644 * add_sysfs_param - add a parameter to sysfs
645 * @mk: struct module_kobject
646 * @kparam: the actual parameter definition to add to sysfs
647 * @name: name of parameter
Linus Torvalds1da177e2005-04-16 15:20:36 -0700648 *
Rusty Russell9b473de2008-10-22 10:00:22 -0500649 * Create a kobject if for a (per-module) parameter if mp NULL, and
650 * create file in sysfs. Returns an error on out of memory. Always cleans up
651 * if there's an error.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 */
Rusty Russell9b473de2008-10-22 10:00:22 -0500653static __modinit int add_sysfs_param(struct module_kobject *mk,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600654 const struct kernel_param *kp,
Rusty Russell9b473de2008-10-22 10:00:22 -0500655 const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656{
Rusty Russell18eb74f2014-11-10 09:32:29 +1030657 struct module_param_attrs *new_mp;
658 struct attribute **new_attrs;
659 unsigned int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660
Rusty Russell9b473de2008-10-22 10:00:22 -0500661 /* We don't bother calling this with invisible parameters. */
662 BUG_ON(!kp->perm);
663
664 if (!mk->mp) {
Rusty Russell18eb74f2014-11-10 09:32:29 +1030665 /* First allocation. */
666 mk->mp = kzalloc(sizeof(*mk->mp), GFP_KERNEL);
667 if (!mk->mp)
668 return -ENOMEM;
669 mk->mp->grp.name = "parameters";
670 /* NULL-terminated attribute array. */
671 mk->mp->grp.attrs = kzalloc(sizeof(mk->mp->grp.attrs[0]),
672 GFP_KERNEL);
673 /* Caller will cleanup via free_module_param_attrs */
674 if (!mk->mp->grp.attrs)
675 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700676 }
677
Rusty Russell18eb74f2014-11-10 09:32:29 +1030678 /* Enlarge allocations. */
679 new_mp = krealloc(mk->mp,
680 sizeof(*mk->mp) +
681 sizeof(mk->mp->attrs[0]) * (mk->mp->num + 1),
682 GFP_KERNEL);
683 if (!new_mp)
684 return -ENOMEM;
685 mk->mp = new_mp;
Rusty Russell9b473de2008-10-22 10:00:22 -0500686
Rusty Russell18eb74f2014-11-10 09:32:29 +1030687 /* Extra pointer for NULL terminator */
688 new_attrs = krealloc(mk->mp->grp.attrs,
689 sizeof(mk->mp->grp.attrs[0]) * (mk->mp->num + 2),
690 GFP_KERNEL);
691 if (!new_attrs)
692 return -ENOMEM;
693 mk->mp->grp.attrs = new_attrs;
Rusty Russell9b473de2008-10-22 10:00:22 -0500694
695 /* Tack new one on the end. */
Rusty Russellc772be52015-01-20 09:07:04 +1030696 memset(&mk->mp->attrs[mk->mp->num], 0, sizeof(mk->mp->attrs[0]));
Rusty Russell18eb74f2014-11-10 09:32:29 +1030697 sysfs_attr_init(&mk->mp->attrs[mk->mp->num].mattr.attr);
698 mk->mp->attrs[mk->mp->num].param = kp;
699 mk->mp->attrs[mk->mp->num].mattr.show = param_attr_show;
Kees Cookb0a65b02014-12-12 13:36:49 +1030700 /* Do not allow runtime DAC changes to make param writable. */
701 if ((kp->perm & (S_IWUSR | S_IWGRP | S_IWOTH)) != 0)
702 mk->mp->attrs[mk->mp->num].mattr.store = param_attr_store;
Rusty Russell574732c2014-12-23 15:05:36 +1030703 else
704 mk->mp->attrs[mk->mp->num].mattr.store = NULL;
Rusty Russell18eb74f2014-11-10 09:32:29 +1030705 mk->mp->attrs[mk->mp->num].mattr.attr.name = (char *)name;
706 mk->mp->attrs[mk->mp->num].mattr.attr.mode = kp->perm;
707 mk->mp->num++;
Rusty Russell9b473de2008-10-22 10:00:22 -0500708
709 /* Fix up all the pointers, since krealloc can move us */
Rusty Russell18eb74f2014-11-10 09:32:29 +1030710 for (i = 0; i < mk->mp->num; i++)
711 mk->mp->grp.attrs[i] = &mk->mp->attrs[i].mattr.attr;
712 mk->mp->grp.attrs[mk->mp->num] = NULL;
Rusty Russell9b473de2008-10-22 10:00:22 -0500713 return 0;
Rusty Russell9b473de2008-10-22 10:00:22 -0500714}
715
Linus Torvaldsd2441182008-10-23 12:07:17 -0700716#ifdef CONFIG_MODULES
Rusty Russell9b473de2008-10-22 10:00:22 -0500717static void free_module_param_attrs(struct module_kobject *mk)
718{
Rusty Russell18eb74f2014-11-10 09:32:29 +1030719 if (mk->mp)
720 kfree(mk->mp->grp.attrs);
Rusty Russell9b473de2008-10-22 10:00:22 -0500721 kfree(mk->mp);
722 mk->mp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723}
724
Linus Torvalds1da177e2005-04-16 15:20:36 -0700725/*
726 * module_param_sysfs_setup - setup sysfs support for one module
727 * @mod: module
728 * @kparam: module parameters (array)
729 * @num_params: number of module parameters
730 *
Rusty Russell9b473de2008-10-22 10:00:22 -0500731 * Adds sysfs entries for module parameters under
732 * /sys/module/[mod->name]/parameters/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 */
734int module_param_sysfs_setup(struct module *mod,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600735 const struct kernel_param *kparam,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736 unsigned int num_params)
737{
Rusty Russell9b473de2008-10-22 10:00:22 -0500738 int i, err;
739 bool params = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740
Rusty Russell9b473de2008-10-22 10:00:22 -0500741 for (i = 0; i < num_params; i++) {
742 if (kparam[i].perm == 0)
743 continue;
744 err = add_sysfs_param(&mod->mkobj, &kparam[i], kparam[i].name);
Rusty Russell18eb74f2014-11-10 09:32:29 +1030745 if (err) {
746 free_module_param_attrs(&mod->mkobj);
Rusty Russell9b473de2008-10-22 10:00:22 -0500747 return err;
Rusty Russell18eb74f2014-11-10 09:32:29 +1030748 }
Rusty Russell9b473de2008-10-22 10:00:22 -0500749 params = true;
750 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751
Rusty Russell9b473de2008-10-22 10:00:22 -0500752 if (!params)
753 return 0;
754
755 /* Create the param group. */
756 err = sysfs_create_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp);
757 if (err)
758 free_module_param_attrs(&mod->mkobj);
759 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760}
761
762/*
763 * module_param_sysfs_remove - remove sysfs support for one module
764 * @mod: module
765 *
766 * Remove sysfs entries for module parameters and the corresponding
767 * kobject.
768 */
769void module_param_sysfs_remove(struct module *mod)
770{
Rusty Russell9b473de2008-10-22 10:00:22 -0500771 if (mod->mkobj.mp) {
772 sysfs_remove_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773 /* We are positive that no one is using any param
774 * attrs at this point. Deallocate immediately. */
Rusty Russell9b473de2008-10-22 10:00:22 -0500775 free_module_param_attrs(&mod->mkobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700776 }
777}
778#endif
779
Rusty Russelle180a6b2009-03-31 13:05:29 -0600780void destroy_params(const struct kernel_param *params, unsigned num)
781{
Rusty Russelle6df34a2010-08-11 23:04:17 -0600782 unsigned int i;
783
784 for (i = 0; i < num; i++)
785 if (params[i].ops->free)
786 params[i].ops->free(params[i].arg);
Rusty Russelle180a6b2009-03-31 13:05:29 -0600787}
788
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800789static struct module_kobject * __init locate_module_kobject(const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790{
791 struct module_kobject *mk;
Rusty Russell9b473de2008-10-22 10:00:22 -0500792 struct kobject *kobj;
793 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794
Rusty Russell9b473de2008-10-22 10:00:22 -0500795 kobj = kset_find_obj(module_kset, name);
796 if (kobj) {
Rusty Russell9b473de2008-10-22 10:00:22 -0500797 mk = to_module_kobject(kobj);
Rusty Russell9b473de2008-10-22 10:00:22 -0500798 } else {
799 mk = kzalloc(sizeof(struct module_kobject), GFP_KERNEL);
800 BUG_ON(!mk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801
Rusty Russell9b473de2008-10-22 10:00:22 -0500802 mk->mod = THIS_MODULE;
803 mk->kobj.kset = module_kset;
804 err = kobject_init_and_add(&mk->kobj, &module_ktype, NULL,
805 "%s", name);
Kay Sievers88bfa322011-07-24 22:06:04 +0930806#ifdef CONFIG_MODULES
807 if (!err)
808 err = sysfs_create_file(&mk->kobj, &module_uevent.attr);
809#endif
Rusty Russell9b473de2008-10-22 10:00:22 -0500810 if (err) {
811 kobject_put(&mk->kobj);
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600812 pr_crit("Adding module '%s' to sysfs failed (%d), the system may be unstable.\n",
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800813 name, err);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800814 return NULL;
Rusty Russell9b473de2008-10-22 10:00:22 -0500815 }
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800816
817 /* So that we hold reference in both cases. */
Rusty Russell9b473de2008-10-22 10:00:22 -0500818 kobject_get(&mk->kobj);
Greg Kroah-Hartman74c5b592007-07-30 11:26:38 -0700819 }
Rusty Russell9b473de2008-10-22 10:00:22 -0500820
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800821 return mk;
822}
823
824static void __init kernel_add_sysfs_param(const char *name,
Geert Uytterhoeven63a12d92014-10-13 15:55:44 -0700825 const struct kernel_param *kparam,
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800826 unsigned int name_skip)
827{
828 struct module_kobject *mk;
829 int err;
830
831 mk = locate_module_kobject(name);
832 if (!mk)
833 return;
834
835 /* We need to remove old parameters before adding more. */
836 if (mk->mp)
837 sysfs_remove_group(&mk->kobj, &mk->mp->grp);
838
Rusty Russell9b473de2008-10-22 10:00:22 -0500839 /* These should not fail at boot. */
840 err = add_sysfs_param(mk, kparam, kparam->name + name_skip);
841 BUG_ON(err);
842 err = sysfs_create_group(&mk->kobj, &mk->mp->grp);
843 BUG_ON(err);
Kay Sieversf30c53a2007-01-15 20:22:02 +0100844 kobject_uevent(&mk->kobj, KOBJ_ADD);
Rusty Russell9b473de2008-10-22 10:00:22 -0500845 kobject_put(&mk->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700846}
847
848/*
Jean Delvareb634d132013-07-02 15:35:11 +0930849 * param_sysfs_builtin - add sysfs parameters for built-in modules
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850 *
851 * Add module_parameters to sysfs for "modules" built into the kernel.
852 *
853 * The "module" name (KBUILD_MODNAME) is stored before a dot, the
854 * "parameter" name is stored behind a dot in kernel_param->name. So,
855 * extract the "module" name for all built-in kernel_param-eters,
Rusty Russell9b473de2008-10-22 10:00:22 -0500856 * and for all who have the same, call kernel_add_sysfs_param.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857 */
858static void __init param_sysfs_builtin(void)
859{
Geert Uytterhoeven63a12d92014-10-13 15:55:44 -0700860 const struct kernel_param *kp;
Rusty Russell9b473de2008-10-22 10:00:22 -0500861 unsigned int name_len;
862 char modname[MODULE_NAME_LEN];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863
Rusty Russell9b473de2008-10-22 10:00:22 -0500864 for (kp = __start___param; kp < __stop___param; kp++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865 char *dot;
866
Rusty Russell9b473de2008-10-22 10:00:22 -0500867 if (kp->perm == 0)
868 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869
Rusty Russell730b69d2008-10-22 10:00:22 -0500870 dot = strchr(kp->name, '.');
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871 if (!dot) {
Rusty Russell67e67ce2008-10-22 10:00:23 -0500872 /* This happens for core_param() */
873 strcpy(modname, "kernel");
874 name_len = 0;
875 } else {
876 name_len = dot - kp->name + 1;
877 strlcpy(modname, kp->name, name_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878 }
Rusty Russell67e67ce2008-10-22 10:00:23 -0500879 kernel_add_sysfs_param(modname, kp, name_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700881}
882
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800883ssize_t __modver_version_show(struct module_attribute *mattr,
Kay Sievers4befb022011-07-24 22:06:04 +0930884 struct module_kobject *mk, char *buf)
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800885{
886 struct module_version_attribute *vattr =
887 container_of(mattr, struct module_version_attribute, mattr);
888
Chen Gangf4940ab72013-08-20 15:35:04 +0930889 return scnprintf(buf, PAGE_SIZE, "%s\n", vattr->version);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800890}
891
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800892extern const struct module_version_attribute *__start___modver[];
893extern const struct module_version_attribute *__stop___modver[];
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800894
895static void __init version_sysfs_builtin(void)
896{
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800897 const struct module_version_attribute **p;
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800898 struct module_kobject *mk;
899 int err;
900
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800901 for (p = __start___modver; p < __stop___modver; p++) {
902 const struct module_version_attribute *vattr = *p;
903
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800904 mk = locate_module_kobject(vattr->module_name);
905 if (mk) {
906 err = sysfs_create_file(&mk->kobj, &vattr->mattr.attr);
Rusty Russell74c3dea32015-06-17 06:16:52 +0930907 WARN_ON_ONCE(err);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800908 kobject_uevent(&mk->kobj, KOBJ_ADD);
909 kobject_put(&mk->kobj);
910 }
911 }
912}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700913
914/* module-related sysfs stuff */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700915
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916static ssize_t module_attr_show(struct kobject *kobj,
917 struct attribute *attr,
918 char *buf)
919{
920 struct module_attribute *attribute;
921 struct module_kobject *mk;
922 int ret;
923
924 attribute = to_module_attr(attr);
925 mk = to_module_kobject(kobj);
926
927 if (!attribute->show)
Dmitry Torokhov70f28172005-04-29 01:27:34 -0500928 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929
Kay Sievers4befb022011-07-24 22:06:04 +0930930 ret = attribute->show(attribute, mk, buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931
Linus Torvalds1da177e2005-04-16 15:20:36 -0700932 return ret;
933}
934
935static ssize_t module_attr_store(struct kobject *kobj,
936 struct attribute *attr,
937 const char *buf, size_t len)
938{
939 struct module_attribute *attribute;
940 struct module_kobject *mk;
941 int ret;
942
943 attribute = to_module_attr(attr);
944 mk = to_module_kobject(kobj);
945
946 if (!attribute->store)
Dmitry Torokhov70f28172005-04-29 01:27:34 -0500947 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700948
Kay Sievers4befb022011-07-24 22:06:04 +0930949 ret = attribute->store(attribute, mk, buf, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950
Linus Torvalds1da177e2005-04-16 15:20:36 -0700951 return ret;
952}
953
Emese Revfy52cf25d2010-01-19 02:58:23 +0100954static const struct sysfs_ops module_sysfs_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955 .show = module_attr_show,
956 .store = module_attr_store,
957};
958
Kay Sievers270a6c42007-01-18 13:26:15 +0100959static int uevent_filter(struct kset *kset, struct kobject *kobj)
960{
961 struct kobj_type *ktype = get_ktype(kobj);
962
963 if (ktype == &module_ktype)
964 return 1;
965 return 0;
966}
967
Emese Revfy9cd43612009-12-31 14:52:51 +0100968static const struct kset_uevent_ops module_uevent_ops = {
Kay Sievers270a6c42007-01-18 13:26:15 +0100969 .filter = uevent_filter,
970};
971
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700972struct kset *module_kset;
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700973int module_sysfs_initialized;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700974
Li Zhong942e4432013-09-03 16:33:57 +0930975static void module_kobj_release(struct kobject *kobj)
976{
977 struct module_kobject *mk = to_module_kobject(kobj);
978 complete(mk->kobj_completion);
979}
980
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700981struct kobj_type module_ktype = {
Li Zhong942e4432013-09-03 16:33:57 +0930982 .release = module_kobj_release,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 .sysfs_ops = &module_sysfs_ops,
984};
985
Linus Torvalds1da177e2005-04-16 15:20:36 -0700986/*
987 * param_sysfs_init - wrapper for built-in params support
988 */
989static int __init param_sysfs_init(void)
990{
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700991 module_kset = kset_create_and_add("module", &module_uevent_ops, NULL);
992 if (!module_kset) {
993 printk(KERN_WARNING "%s (%d): error creating kset\n",
994 __FILE__, __LINE__);
995 return -ENOMEM;
Randy Dunlapd8c76492006-09-29 01:58:55 -0700996 }
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700997 module_sysfs_initialized = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800999 version_sysfs_builtin();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001000 param_sysfs_builtin();
1001
1002 return 0;
1003}
Mark Huangd10be6d2006-09-29 01:59:34 -07001004subsys_initcall(param_sysfs_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -07001006#endif /* CONFIG_SYSFS */