blob: adc0bbc06cc5faee7334c7769c82a74eda3e1542 [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 */
Stephen Rothwell20bdc2c2015-06-26 13:19:19 +100033#ifdef CONFIG_MODULES
Dan Streetmanb51d23e2015-06-17 06:18:52 +093034#define KPARAM_MUTEX(mod) ((mod) ? &(mod)->param_lock : &param_lock)
Stephen Rothwell20bdc2c2015-06-26 13:19:19 +100035#else
36#define KPARAM_MUTEX(mod) (&param_lock)
37#endif
Rusty Russellcf2fde72015-06-26 06:44:38 +093038
39static inline void check_kparam_locked(struct module *mod)
40{
41 BUG_ON(!mutex_is_locked(KPARAM_MUTEX(mod)));
42}
43#else
44static inline void check_kparam_locked(struct module *mod)
45{
46}
47#endif /* !CONFIG_SYSFS */
Dan Streetmanb51d23e2015-06-17 06:18:52 +093048
Rusty Russella1054322010-08-11 23:04:18 -060049/* This just allows us to keep track of which parameters are kmalloced. */
50struct kmalloced_param {
51 struct list_head list;
52 char val[];
53};
Rusty Russella1054322010-08-11 23:04:18 -060054static LIST_HEAD(kmalloced_params);
Dan Streetmanb51d23e2015-06-17 06:18:52 +093055static DEFINE_SPINLOCK(kmalloced_params_lock);
Rusty Russella1054322010-08-11 23:04:18 -060056
57static void *kmalloc_parameter(unsigned int size)
58{
59 struct kmalloced_param *p;
60
61 p = kmalloc(sizeof(*p) + size, GFP_KERNEL);
62 if (!p)
63 return NULL;
64
Dan Streetmanb51d23e2015-06-17 06:18:52 +093065 spin_lock(&kmalloced_params_lock);
Rusty Russella1054322010-08-11 23:04:18 -060066 list_add(&p->list, &kmalloced_params);
Dan Streetmanb51d23e2015-06-17 06:18:52 +093067 spin_unlock(&kmalloced_params_lock);
68
Rusty Russella1054322010-08-11 23:04:18 -060069 return p->val;
70}
71
72/* Does nothing if parameter wasn't kmalloced above. */
73static void maybe_kfree_parameter(void *param)
74{
75 struct kmalloced_param *p;
76
Dan Streetmanb51d23e2015-06-17 06:18:52 +093077 spin_lock(&kmalloced_params_lock);
Rusty Russella1054322010-08-11 23:04:18 -060078 list_for_each_entry(p, &kmalloced_params, list) {
79 if (p->val == param) {
80 list_del(&p->list);
81 kfree(p);
82 break;
83 }
84 }
Dan Streetmanb51d23e2015-06-17 06:18:52 +093085 spin_unlock(&kmalloced_params_lock);
Rusty Russella1054322010-08-11 23:04:18 -060086}
87
Michal Schmidtb1e4d202011-10-10 00:03:37 +020088static char dash2underscore(char c)
Linus Torvalds1da177e2005-04-16 15:20:36 -070089{
90 if (c == '-')
91 return '_';
92 return c;
93}
94
Michal Schmidtb1e4d202011-10-10 00:03:37 +020095bool parameqn(const char *a, const char *b, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -070096{
Michal Schmidtb1e4d202011-10-10 00:03:37 +020097 size_t i;
98
99 for (i = 0; i < n; i++) {
100 if (dash2underscore(a[i]) != dash2underscore(b[i]))
101 return false;
102 }
103 return true;
104}
105
106bool parameq(const char *a, const char *b)
107{
108 return parameqn(a, b, strlen(a)+1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109}
110
Rusty Russell7a486d32014-08-27 06:25:23 +0930111static void param_check_unsafe(const struct kernel_param *kp)
112{
113 if (kp->flags & KERNEL_PARAM_FL_UNSAFE) {
114 pr_warn("Setting dangerous option %s - tainting kernel\n",
115 kp->name);
116 add_taint(TAINT_USER, LOCKDEP_STILL_OK);
117 }
118}
119
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120static int parse_one(char *param,
121 char *val,
Jim Cromie9fb48c72012-04-27 14:30:34 -0600122 const char *doing,
Rusty Russell914dcaa2010-08-11 23:04:18 -0600123 const struct kernel_param *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 unsigned num_params,
Pawel Moll026cee02012-03-26 12:50:51 +1030125 s16 min_level,
126 s16 max_level,
Jim Cromie9fb48c72012-04-27 14:30:34 -0600127 int (*handle_unknown)(char *param, char *val,
128 const char *doing))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700129{
130 unsigned int i;
Rusty Russell907b29e2010-08-11 23:04:19 -0600131 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132
133 /* Find parameter */
134 for (i = 0; i < num_params; i++) {
135 if (parameq(param, params[i].name)) {
Pawel Moll026cee02012-03-26 12:50:51 +1030136 if (params[i].level < min_level
137 || params[i].level > max_level)
138 return 0;
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300139 /* No one handled NULL, so do it here. */
Steven Rostedtab013c52013-08-20 15:33:19 +0930140 if (!val &&
Jani Nikula6a4c2642014-08-27 06:21:23 +0930141 !(params[i].ops->flags & KERNEL_PARAM_OPS_FL_NOARG))
Rusty Russell2e9fb992010-08-11 23:04:10 -0600142 return -EINVAL;
Jim Cromie9fb48c72012-04-27 14:30:34 -0600143 pr_debug("handling %s with %p\n", param,
144 params[i].ops->set);
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930145 kernel_param_lock(params[i].mod);
Rusty Russell7a486d32014-08-27 06:25:23 +0930146 param_check_unsafe(&params[i]);
Rusty Russell907b29e2010-08-11 23:04:19 -0600147 err = params[i].ops->set(val, &params[i]);
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930148 kernel_param_unlock(params[i].mod);
Rusty Russell907b29e2010-08-11 23:04:19 -0600149 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700150 }
151 }
152
153 if (handle_unknown) {
Jim Cromie9fb48c72012-04-27 14:30:34 -0600154 pr_debug("doing %s: %s='%s'\n", doing, param, val);
155 return handle_unknown(param, val, doing);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 }
157
Jim Cromie9fb48c72012-04-27 14:30:34 -0600158 pr_debug("Unknown argument '%s'\n", param);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700159 return -ENOENT;
160}
161
162/* You can use " around spaces, but can't escape ". */
163/* Hyphens and underscores equivalent in parameter names. */
164static char *next_arg(char *args, char **param, char **val)
165{
166 unsigned int i, equals = 0;
167 int in_quote = 0, quoted = 0;
168 char *next;
169
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170 if (*args == '"') {
171 args++;
172 in_quote = 1;
173 quoted = 1;
174 }
175
176 for (i = 0; args[i]; i++) {
Peter Oberparleiter26d052b2009-07-06 17:11:22 +0200177 if (isspace(args[i]) && !in_quote)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178 break;
179 if (equals == 0) {
180 if (args[i] == '=')
181 equals = i;
182 }
183 if (args[i] == '"')
184 in_quote = !in_quote;
185 }
186
187 *param = args;
188 if (!equals)
189 *val = NULL;
190 else {
191 args[equals] = '\0';
192 *val = args + equals + 1;
193
194 /* Don't include quotes in value. */
195 if (**val == '"') {
196 (*val)++;
197 if (args[i-1] == '"')
198 args[i-1] = '\0';
199 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 }
Rusty Russellb9cc4482015-04-15 13:23:48 +0930201 if (quoted && args[i-1] == '"')
202 args[i-1] = '\0';
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203
204 if (args[i]) {
205 args[i] = '\0';
206 next = args + i + 1;
207 } else
208 next = args + i;
Rusty Russellf36462f2005-09-27 21:45:34 -0700209
210 /* Chew up trailing spaces. */
André Goddard Rosae7d28602009-12-14 18:01:06 -0800211 return skip_spaces(next);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212}
213
214/* Args looks like "foo=bar,bar2 baz=fuz wiz". */
Rusty Russell51e158c2014-04-28 11:34:33 +0930215char *parse_args(const char *doing,
216 char *args,
217 const struct kernel_param *params,
218 unsigned num,
219 s16 min_level,
220 s16 max_level,
221 int (*unknown)(char *param, char *val, const char *doing))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222{
223 char *param, *val;
224
Rusty Russellf36462f2005-09-27 21:45:34 -0700225 /* Chew leading spaces */
André Goddard Rosae7d28602009-12-14 18:01:06 -0800226 args = skip_spaces(args);
Rusty Russellf36462f2005-09-27 21:45:34 -0700227
Jim Cromie1ef9eaf2012-05-03 11:57:37 -0600228 if (*args)
Jim Cromie9fb48c72012-04-27 14:30:34 -0600229 pr_debug("doing %s, parsing ARGS: '%s'\n", doing, args);
230
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231 while (*args) {
232 int ret;
Ard van Breemena416aba2007-01-05 16:36:20 -0800233 int irq_was_disabled;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234
235 args = next_arg(args, &param, &val);
Rusty Russell51e158c2014-04-28 11:34:33 +0930236 /* Stop at -- */
237 if (!val && strcmp(param, "--") == 0)
238 return args;
Ard van Breemena416aba2007-01-05 16:36:20 -0800239 irq_was_disabled = irqs_disabled();
Jim Cromie9fb48c72012-04-27 14:30:34 -0600240 ret = parse_one(param, val, doing, params, num,
Pawel Moll026cee02012-03-26 12:50:51 +1030241 min_level, max_level, unknown);
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600242 if (irq_was_disabled && !irqs_disabled())
243 pr_warn("%s: option '%s' enabled irq's!\n",
244 doing, param);
245
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 switch (ret) {
247 case -ENOENT:
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600248 pr_err("%s: Unknown parameter `%s'\n", doing, param);
Rusty Russell51e158c2014-04-28 11:34:33 +0930249 return ERR_PTR(ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250 case -ENOSPC:
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600251 pr_err("%s: `%s' too large for parameter `%s'\n",
Jim Cromie9fb48c72012-04-27 14:30:34 -0600252 doing, val ?: "", param);
Rusty Russell51e158c2014-04-28 11:34:33 +0930253 return ERR_PTR(ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700254 case 0:
255 break;
256 default:
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600257 pr_err("%s: `%s' invalid for parameter `%s'\n",
Jim Cromie9fb48c72012-04-27 14:30:34 -0600258 doing, val ?: "", param);
Rusty Russell51e158c2014-04-28 11:34:33 +0930259 return ERR_PTR(ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 }
261 }
262
263 /* All parsed OK. */
Rusty Russell51e158c2014-04-28 11:34:33 +0930264 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700265}
266
267/* Lazy bastard, eh? */
Felipe Contreras88a88b322013-12-04 14:09:38 +1030268#define STANDARD_PARAM_DEF(name, type, format, strtolfn) \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600269 int param_set_##name(const char *val, const struct kernel_param *kp) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270 { \
Felipe Contreras88a88b322013-12-04 14:09:38 +1030271 return strtolfn(val, 0, (type *)kp->arg); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272 } \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600273 int param_get_##name(char *buffer, const struct kernel_param *kp) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 { \
Chen Gangf4940ab72013-08-20 15:35:04 +0930275 return scnprintf(buffer, PAGE_SIZE, format, \
276 *((type *)kp->arg)); \
Rusty Russella14fe242010-08-11 23:04:11 -0600277 } \
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930278 const struct kernel_param_ops param_ops_##name = { \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600279 .set = param_set_##name, \
280 .get = param_get_##name, \
281 }; \
Rusty Russella14fe242010-08-11 23:04:11 -0600282 EXPORT_SYMBOL(param_set_##name); \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600283 EXPORT_SYMBOL(param_get_##name); \
284 EXPORT_SYMBOL(param_ops_##name)
285
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286
Felipe Contreras88a88b322013-12-04 14:09:38 +1030287STANDARD_PARAM_DEF(byte, unsigned char, "%hhu", kstrtou8);
288STANDARD_PARAM_DEF(short, short, "%hi", kstrtos16);
289STANDARD_PARAM_DEF(ushort, unsigned short, "%hu", kstrtou16);
290STANDARD_PARAM_DEF(int, int, "%i", kstrtoint);
291STANDARD_PARAM_DEF(uint, unsigned int, "%u", kstrtouint);
292STANDARD_PARAM_DEF(long, long, "%li", kstrtol);
293STANDARD_PARAM_DEF(ulong, unsigned long, "%lu", kstrtoul);
Hannes Reineckeb4210b82014-06-25 15:27:37 +0200294STANDARD_PARAM_DEF(ullong, unsigned long long, "%llu", kstrtoull);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600296int param_set_charp(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298 if (strlen(val) > 1024) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600299 pr_err("%s: string parameter too long\n", kp->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300 return -ENOSPC;
301 }
302
Rusty Russella1054322010-08-11 23:04:18 -0600303 maybe_kfree_parameter(*(char **)kp->arg);
304
305 /* This is a hack. We can't kmalloc in early boot, and we
Rusty Russelle180a6b2009-03-31 13:05:29 -0600306 * don't need to; this mangled commandline is preserved. */
307 if (slab_is_available()) {
Rusty Russella1054322010-08-11 23:04:18 -0600308 *(char **)kp->arg = kmalloc_parameter(strlen(val)+1);
Rusty Russelld553ad82009-10-29 08:56:17 -0600309 if (!*(char **)kp->arg)
Rusty Russelle180a6b2009-03-31 13:05:29 -0600310 return -ENOMEM;
Rusty Russella1054322010-08-11 23:04:18 -0600311 strcpy(*(char **)kp->arg, val);
Rusty Russelle180a6b2009-03-31 13:05:29 -0600312 } else
313 *(const char **)kp->arg = val;
314
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 return 0;
316}
Rusty Russella14fe242010-08-11 23:04:11 -0600317EXPORT_SYMBOL(param_set_charp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600319int param_get_charp(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700320{
Chen Gangf4940ab72013-08-20 15:35:04 +0930321 return scnprintf(buffer, PAGE_SIZE, "%s", *((char **)kp->arg));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322}
Rusty Russella14fe242010-08-11 23:04:11 -0600323EXPORT_SYMBOL(param_get_charp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324
Rusty Russella1054322010-08-11 23:04:18 -0600325static void param_free_charp(void *arg)
326{
327 maybe_kfree_parameter(*((char **)arg));
328}
329
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930330const struct kernel_param_ops param_ops_charp = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600331 .set = param_set_charp,
332 .get = param_get_charp,
Rusty Russella1054322010-08-11 23:04:18 -0600333 .free = param_free_charp,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600334};
335EXPORT_SYMBOL(param_ops_charp);
336
Rusty Russellfddd5202009-06-12 21:46:57 -0600337/* Actually could be a bool or an int, for historical reasons. */
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600338int param_set_bool(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700339{
340 /* No equals means "set"... */
341 if (!val) val = "1";
342
343 /* One of =[yYnN01] */
Rusty Russell8b825282012-03-26 12:50:51 +1030344 return strtobool(val, kp->arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345}
Rusty Russella14fe242010-08-11 23:04:11 -0600346EXPORT_SYMBOL(param_set_bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700347
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600348int param_get_bool(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349{
350 /* Y and N chosen as being relatively non-coder friendly */
Rusty Russell8b825282012-03-26 12:50:51 +1030351 return sprintf(buffer, "%c", *(bool *)kp->arg ? 'Y' : 'N');
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352}
Rusty Russella14fe242010-08-11 23:04:11 -0600353EXPORT_SYMBOL(param_get_bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930355const struct kernel_param_ops param_ops_bool = {
Jani Nikula6a4c2642014-08-27 06:21:23 +0930356 .flags = KERNEL_PARAM_OPS_FL_NOARG,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600357 .set = param_set_bool,
358 .get = param_get_bool,
359};
360EXPORT_SYMBOL(param_ops_bool);
361
Luis R. Rodriguezd19f05d2015-05-27 11:09:38 +0930362int param_set_bool_enable_only(const char *val, const struct kernel_param *kp)
363{
364 int err = 0;
365 bool new_value;
366 bool orig_value = *(bool *)kp->arg;
367 struct kernel_param dummy_kp = *kp;
368
369 dummy_kp.arg = &new_value;
370
371 err = param_set_bool(val, &dummy_kp);
372 if (err)
373 return err;
374
375 /* Don't let them unset it once it's set! */
376 if (!new_value && orig_value)
377 return -EROFS;
378
379 if (new_value)
380 err = param_set_bool(val, kp);
381
382 return err;
383}
384EXPORT_SYMBOL_GPL(param_set_bool_enable_only);
385
386const struct kernel_param_ops param_ops_bool_enable_only = {
387 .flags = KERNEL_PARAM_OPS_FL_NOARG,
388 .set = param_set_bool_enable_only,
389 .get = param_get_bool,
390};
Luis R. Rodriguez154be212015-05-27 11:09:39 +0930391EXPORT_SYMBOL_GPL(param_ops_bool_enable_only);
Luis R. Rodriguezd19f05d2015-05-27 11:09:38 +0930392
Rusty Russellfddd5202009-06-12 21:46:57 -0600393/* This one must be bool. */
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600394int param_set_invbool(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395{
Rusty Russellfddd5202009-06-12 21:46:57 -0600396 int ret;
397 bool boolval;
Jan Beulich22e48ea2007-10-16 23:29:34 -0700398 struct kernel_param dummy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399
Jan Beulich22e48ea2007-10-16 23:29:34 -0700400 dummy.arg = &boolval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401 ret = param_set_bool(val, &dummy);
402 if (ret == 0)
Rusty Russell9a71af22009-06-12 21:46:53 -0600403 *(bool *)kp->arg = !boolval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 return ret;
405}
Rusty Russella14fe242010-08-11 23:04:11 -0600406EXPORT_SYMBOL(param_set_invbool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600408int param_get_invbool(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409{
Rusty Russell9a71af22009-06-12 21:46:53 -0600410 return sprintf(buffer, "%c", (*(bool *)kp->arg) ? 'N' : 'Y');
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411}
Rusty Russella14fe242010-08-11 23:04:11 -0600412EXPORT_SYMBOL(param_get_invbool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930414const struct kernel_param_ops param_ops_invbool = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600415 .set = param_set_invbool,
416 .get = param_get_invbool,
417};
418EXPORT_SYMBOL(param_ops_invbool);
419
Rusty Russell69116f22012-01-13 09:32:17 +1030420int param_set_bint(const char *val, const struct kernel_param *kp)
421{
Dan Streetman5104b7d2015-06-17 06:17:52 +0930422 /* Match bool exactly, by re-using it. */
423 struct kernel_param boolkp = *kp;
Rusty Russell69116f22012-01-13 09:32:17 +1030424 bool v;
425 int ret;
426
Rusty Russell69116f22012-01-13 09:32:17 +1030427 boolkp.arg = &v;
Rusty Russell69116f22012-01-13 09:32:17 +1030428
429 ret = param_set_bool(val, &boolkp);
430 if (ret == 0)
431 *(int *)kp->arg = v;
432 return ret;
433}
434EXPORT_SYMBOL(param_set_bint);
435
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930436const struct kernel_param_ops param_ops_bint = {
Jani Nikula6a4c2642014-08-27 06:21:23 +0930437 .flags = KERNEL_PARAM_OPS_FL_NOARG,
Rusty Russell69116f22012-01-13 09:32:17 +1030438 .set = param_set_bint,
439 .get = param_get_int,
440};
441EXPORT_SYMBOL(param_ops_bint);
442
Bert Wesarg9730b5b2007-05-08 00:28:50 -0700443/* We break the rule and mangle the string. */
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930444static int param_array(struct module *mod,
445 const char *name,
Adrian Bunk98717282006-03-25 03:07:06 -0800446 const char *val,
447 unsigned int min, unsigned int max,
448 void *elem, int elemsize,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600449 int (*set)(const char *, const struct kernel_param *kp),
Pawel Moll026cee02012-03-26 12:50:51 +1030450 s16 level,
Richard Knutssoneb38a992008-02-06 01:37:50 -0800451 unsigned int *num)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452{
453 int ret;
454 struct kernel_param kp;
455 char save;
456
457 /* Get the name right for errors. */
458 kp.name = name;
459 kp.arg = elem;
Pawel Moll026cee02012-03-26 12:50:51 +1030460 kp.level = level;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 *num = 0;
463 /* We expect a comma-separated list of values. */
464 do {
465 int len;
466
467 if (*num == max) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600468 pr_err("%s: can only take %i arguments\n", name, max);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 return -EINVAL;
470 }
471 len = strcspn(val, ",");
472
473 /* nul-terminate and parse */
474 save = val[len];
475 ((char *)val)[len] = '\0';
Rusty Russellcf2fde72015-06-26 06:44:38 +0930476 check_kparam_locked(mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700477 ret = set(val, &kp);
478
479 if (ret != 0)
480 return ret;
481 kp.arg += elemsize;
482 val += len+1;
483 (*num)++;
484 } while (save == ',');
485
486 if (*num < min) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600487 pr_err("%s: needs at least %i arguments\n", name, min);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 return -EINVAL;
489 }
490 return 0;
491}
492
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600493static int param_array_set(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700495 const struct kparam_array *arr = kp->arr;
Bert Wesarg31143a12005-04-16 15:25:42 -0700496 unsigned int temp_num;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930498 return param_array(kp->mod, kp->name, val, 1, arr->max, arr->elem,
Pawel Moll026cee02012-03-26 12:50:51 +1030499 arr->elemsize, arr->ops->set, kp->level,
Rusty Russell3c7d76e2009-10-29 08:56:19 -0600500 arr->num ?: &temp_num);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501}
502
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600503static int param_array_get(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504{
505 int i, off, ret;
Jan Beulich22e48ea2007-10-16 23:29:34 -0700506 const struct kparam_array *arr = kp->arr;
Dan Streetman5104b7d2015-06-17 06:17:52 +0930507 struct kernel_param p = *kp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509 for (i = off = 0; i < (arr->num ? *arr->num : arr->max); i++) {
510 if (i)
511 buffer[off++] = ',';
512 p.arg = arr->elem + arr->elemsize * i;
Rusty Russellcf2fde72015-06-26 06:44:38 +0930513 check_kparam_locked(p.mod);
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600514 ret = arr->ops->get(buffer + off, &p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700515 if (ret < 0)
516 return ret;
517 off += ret;
518 }
519 buffer[off] = '\0';
520 return off;
521}
522
Rusty Russelle6df34a2010-08-11 23:04:17 -0600523static void param_array_free(void *arg)
524{
525 unsigned int i;
526 const struct kparam_array *arr = arg;
527
528 if (arr->ops->free)
529 for (i = 0; i < (arr->num ? *arr->num : arr->max); i++)
530 arr->ops->free(arr->elem + arr->elemsize * i);
531}
532
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930533const struct kernel_param_ops param_array_ops = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600534 .set = param_array_set,
535 .get = param_array_get,
Rusty Russelle6df34a2010-08-11 23:04:17 -0600536 .free = param_array_free,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600537};
538EXPORT_SYMBOL(param_array_ops);
539
540int param_set_copystring(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700542 const struct kparam_string *kps = kp->str;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543
544 if (strlen(val)+1 > kps->maxlen) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600545 pr_err("%s: string doesn't fit in %u chars.\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546 kp->name, kps->maxlen-1);
547 return -ENOSPC;
548 }
549 strcpy(kps->string, val);
550 return 0;
551}
Rusty Russella14fe242010-08-11 23:04:11 -0600552EXPORT_SYMBOL(param_set_copystring);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600554int param_get_string(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700556 const struct kparam_string *kps = kp->str;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 return strlcpy(buffer, kps->string, kps->maxlen);
558}
Rusty Russella14fe242010-08-11 23:04:11 -0600559EXPORT_SYMBOL(param_get_string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930561const struct kernel_param_ops param_ops_string = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600562 .set = param_set_copystring,
563 .get = param_get_string,
564};
565EXPORT_SYMBOL(param_ops_string);
566
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567/* sysfs output in /sys/modules/XYZ/parameters/ */
Edward Z. Yang350f8252010-02-01 18:26:59 -0500568#define to_module_attr(n) container_of(n, struct module_attribute, attr)
569#define to_module_kobject(n) container_of(n, struct module_kobject, kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571struct param_attribute
572{
573 struct module_attribute mattr;
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600574 const struct kernel_param *param;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575};
576
577struct module_param_attrs
578{
Rusty Russell9b473de2008-10-22 10:00:22 -0500579 unsigned int num;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 struct attribute_group grp;
581 struct param_attribute attrs[0];
582};
583
Randy Dunlapef665c12007-02-13 15:19:06 -0800584#ifdef CONFIG_SYSFS
Edward Z. Yang350f8252010-02-01 18:26:59 -0500585#define to_param_attr(n) container_of(n, struct param_attribute, mattr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700586
587static ssize_t param_attr_show(struct module_attribute *mattr,
Kay Sievers4befb022011-07-24 22:06:04 +0930588 struct module_kobject *mk, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589{
590 int count;
591 struct param_attribute *attribute = to_param_attr(mattr);
592
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600593 if (!attribute->param->ops->get)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 return -EPERM;
595
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930596 kernel_param_lock(mk->mod);
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600597 count = attribute->param->ops->get(buf, attribute->param);
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930598 kernel_param_unlock(mk->mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 if (count > 0) {
600 strcat(buf, "\n");
601 ++count;
602 }
603 return count;
604}
605
606/* sysfs always hands a nul-terminated string in buf. We rely on that. */
607static ssize_t param_attr_store(struct module_attribute *mattr,
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930608 struct module_kobject *mk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 const char *buf, size_t len)
610{
611 int err;
612 struct param_attribute *attribute = to_param_attr(mattr);
613
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600614 if (!attribute->param->ops->set)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700615 return -EPERM;
616
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930617 kernel_param_lock(mk->mod);
Rusty Russell7a486d32014-08-27 06:25:23 +0930618 param_check_unsafe(attribute->param);
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600619 err = attribute->param->ops->set(buf, attribute->param);
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930620 kernel_param_unlock(mk->mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 if (!err)
622 return len;
623 return err;
624}
Randy Dunlapef665c12007-02-13 15:19:06 -0800625#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626
627#ifdef CONFIG_MODULES
628#define __modinit
629#else
630#define __modinit __init
631#endif
632
Rusty Russellcf2fde72015-06-26 06:44:38 +0930633#ifdef CONFIG_SYSFS
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930634void kernel_param_lock(struct module *mod)
Rusty Russell907b29e2010-08-11 23:04:19 -0600635{
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930636 mutex_lock(KPARAM_MUTEX(mod));
Rusty Russell907b29e2010-08-11 23:04:19 -0600637}
Rusty Russell907b29e2010-08-11 23:04:19 -0600638
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930639void kernel_param_unlock(struct module *mod)
Rusty Russell907b29e2010-08-11 23:04:19 -0600640{
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930641 mutex_unlock(KPARAM_MUTEX(mod));
Rusty Russell907b29e2010-08-11 23:04:19 -0600642}
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930643
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930644EXPORT_SYMBOL(kernel_param_lock);
645EXPORT_SYMBOL(kernel_param_unlock);
Rusty Russell907b29e2010-08-11 23:04:19 -0600646
Linus Torvalds1da177e2005-04-16 15:20:36 -0700647/*
Rusty Russell9b473de2008-10-22 10:00:22 -0500648 * add_sysfs_param - add a parameter to sysfs
649 * @mk: struct module_kobject
650 * @kparam: the actual parameter definition to add to sysfs
651 * @name: name of parameter
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652 *
Rusty Russell9b473de2008-10-22 10:00:22 -0500653 * Create a kobject if for a (per-module) parameter if mp NULL, and
654 * create file in sysfs. Returns an error on out of memory. Always cleans up
655 * if there's an error.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656 */
Rusty Russell9b473de2008-10-22 10:00:22 -0500657static __modinit int add_sysfs_param(struct module_kobject *mk,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600658 const struct kernel_param *kp,
Rusty Russell9b473de2008-10-22 10:00:22 -0500659 const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660{
Rusty Russell18eb74f2014-11-10 09:32:29 +1030661 struct module_param_attrs *new_mp;
662 struct attribute **new_attrs;
663 unsigned int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664
Rusty Russell9b473de2008-10-22 10:00:22 -0500665 /* We don't bother calling this with invisible parameters. */
666 BUG_ON(!kp->perm);
667
668 if (!mk->mp) {
Rusty Russell18eb74f2014-11-10 09:32:29 +1030669 /* First allocation. */
670 mk->mp = kzalloc(sizeof(*mk->mp), GFP_KERNEL);
671 if (!mk->mp)
672 return -ENOMEM;
673 mk->mp->grp.name = "parameters";
674 /* NULL-terminated attribute array. */
675 mk->mp->grp.attrs = kzalloc(sizeof(mk->mp->grp.attrs[0]),
676 GFP_KERNEL);
677 /* Caller will cleanup via free_module_param_attrs */
678 if (!mk->mp->grp.attrs)
679 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680 }
681
Rusty Russell18eb74f2014-11-10 09:32:29 +1030682 /* Enlarge allocations. */
683 new_mp = krealloc(mk->mp,
684 sizeof(*mk->mp) +
685 sizeof(mk->mp->attrs[0]) * (mk->mp->num + 1),
686 GFP_KERNEL);
687 if (!new_mp)
688 return -ENOMEM;
689 mk->mp = new_mp;
Rusty Russell9b473de2008-10-22 10:00:22 -0500690
Rusty Russell18eb74f2014-11-10 09:32:29 +1030691 /* Extra pointer for NULL terminator */
692 new_attrs = krealloc(mk->mp->grp.attrs,
693 sizeof(mk->mp->grp.attrs[0]) * (mk->mp->num + 2),
694 GFP_KERNEL);
695 if (!new_attrs)
696 return -ENOMEM;
697 mk->mp->grp.attrs = new_attrs;
Rusty Russell9b473de2008-10-22 10:00:22 -0500698
699 /* Tack new one on the end. */
Rusty Russellc772be52015-01-20 09:07:04 +1030700 memset(&mk->mp->attrs[mk->mp->num], 0, sizeof(mk->mp->attrs[0]));
Rusty Russell18eb74f2014-11-10 09:32:29 +1030701 sysfs_attr_init(&mk->mp->attrs[mk->mp->num].mattr.attr);
702 mk->mp->attrs[mk->mp->num].param = kp;
703 mk->mp->attrs[mk->mp->num].mattr.show = param_attr_show;
Kees Cookb0a65b02014-12-12 13:36:49 +1030704 /* Do not allow runtime DAC changes to make param writable. */
705 if ((kp->perm & (S_IWUSR | S_IWGRP | S_IWOTH)) != 0)
706 mk->mp->attrs[mk->mp->num].mattr.store = param_attr_store;
Rusty Russell574732c2014-12-23 15:05:36 +1030707 else
708 mk->mp->attrs[mk->mp->num].mattr.store = NULL;
Rusty Russell18eb74f2014-11-10 09:32:29 +1030709 mk->mp->attrs[mk->mp->num].mattr.attr.name = (char *)name;
710 mk->mp->attrs[mk->mp->num].mattr.attr.mode = kp->perm;
711 mk->mp->num++;
Rusty Russell9b473de2008-10-22 10:00:22 -0500712
713 /* Fix up all the pointers, since krealloc can move us */
Rusty Russell18eb74f2014-11-10 09:32:29 +1030714 for (i = 0; i < mk->mp->num; i++)
715 mk->mp->grp.attrs[i] = &mk->mp->attrs[i].mattr.attr;
716 mk->mp->grp.attrs[mk->mp->num] = NULL;
Rusty Russell9b473de2008-10-22 10:00:22 -0500717 return 0;
Rusty Russell9b473de2008-10-22 10:00:22 -0500718}
719
Linus Torvaldsd2441182008-10-23 12:07:17 -0700720#ifdef CONFIG_MODULES
Rusty Russell9b473de2008-10-22 10:00:22 -0500721static void free_module_param_attrs(struct module_kobject *mk)
722{
Rusty Russell18eb74f2014-11-10 09:32:29 +1030723 if (mk->mp)
724 kfree(mk->mp->grp.attrs);
Rusty Russell9b473de2008-10-22 10:00:22 -0500725 kfree(mk->mp);
726 mk->mp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727}
728
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729/*
730 * module_param_sysfs_setup - setup sysfs support for one module
731 * @mod: module
732 * @kparam: module parameters (array)
733 * @num_params: number of module parameters
734 *
Rusty Russell9b473de2008-10-22 10:00:22 -0500735 * Adds sysfs entries for module parameters under
736 * /sys/module/[mod->name]/parameters/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700737 */
738int module_param_sysfs_setup(struct module *mod,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600739 const struct kernel_param *kparam,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740 unsigned int num_params)
741{
Rusty Russell9b473de2008-10-22 10:00:22 -0500742 int i, err;
743 bool params = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744
Rusty Russell9b473de2008-10-22 10:00:22 -0500745 for (i = 0; i < num_params; i++) {
746 if (kparam[i].perm == 0)
747 continue;
748 err = add_sysfs_param(&mod->mkobj, &kparam[i], kparam[i].name);
Rusty Russell18eb74f2014-11-10 09:32:29 +1030749 if (err) {
750 free_module_param_attrs(&mod->mkobj);
Rusty Russell9b473de2008-10-22 10:00:22 -0500751 return err;
Rusty Russell18eb74f2014-11-10 09:32:29 +1030752 }
Rusty Russell9b473de2008-10-22 10:00:22 -0500753 params = true;
754 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755
Rusty Russell9b473de2008-10-22 10:00:22 -0500756 if (!params)
757 return 0;
758
759 /* Create the param group. */
760 err = sysfs_create_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp);
761 if (err)
762 free_module_param_attrs(&mod->mkobj);
763 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764}
765
766/*
767 * module_param_sysfs_remove - remove sysfs support for one module
768 * @mod: module
769 *
770 * Remove sysfs entries for module parameters and the corresponding
771 * kobject.
772 */
773void module_param_sysfs_remove(struct module *mod)
774{
Rusty Russell9b473de2008-10-22 10:00:22 -0500775 if (mod->mkobj.mp) {
776 sysfs_remove_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700777 /* We are positive that no one is using any param
778 * attrs at this point. Deallocate immediately. */
Rusty Russell9b473de2008-10-22 10:00:22 -0500779 free_module_param_attrs(&mod->mkobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 }
781}
782#endif
783
Rusty Russelle180a6b2009-03-31 13:05:29 -0600784void destroy_params(const struct kernel_param *params, unsigned num)
785{
Rusty Russelle6df34a2010-08-11 23:04:17 -0600786 unsigned int i;
787
788 for (i = 0; i < num; i++)
789 if (params[i].ops->free)
790 params[i].ops->free(params[i].arg);
Rusty Russelle180a6b2009-03-31 13:05:29 -0600791}
792
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800793static struct module_kobject * __init locate_module_kobject(const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700794{
795 struct module_kobject *mk;
Rusty Russell9b473de2008-10-22 10:00:22 -0500796 struct kobject *kobj;
797 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798
Rusty Russell9b473de2008-10-22 10:00:22 -0500799 kobj = kset_find_obj(module_kset, name);
800 if (kobj) {
Rusty Russell9b473de2008-10-22 10:00:22 -0500801 mk = to_module_kobject(kobj);
Rusty Russell9b473de2008-10-22 10:00:22 -0500802 } else {
803 mk = kzalloc(sizeof(struct module_kobject), GFP_KERNEL);
804 BUG_ON(!mk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805
Rusty Russell9b473de2008-10-22 10:00:22 -0500806 mk->mod = THIS_MODULE;
807 mk->kobj.kset = module_kset;
808 err = kobject_init_and_add(&mk->kobj, &module_ktype, NULL,
809 "%s", name);
Kay Sievers88bfa322011-07-24 22:06:04 +0930810#ifdef CONFIG_MODULES
811 if (!err)
812 err = sysfs_create_file(&mk->kobj, &module_uevent.attr);
813#endif
Rusty Russell9b473de2008-10-22 10:00:22 -0500814 if (err) {
815 kobject_put(&mk->kobj);
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600816 pr_crit("Adding module '%s' to sysfs failed (%d), the system may be unstable.\n",
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800817 name, err);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800818 return NULL;
Rusty Russell9b473de2008-10-22 10:00:22 -0500819 }
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800820
821 /* So that we hold reference in both cases. */
Rusty Russell9b473de2008-10-22 10:00:22 -0500822 kobject_get(&mk->kobj);
Greg Kroah-Hartman74c5b592007-07-30 11:26:38 -0700823 }
Rusty Russell9b473de2008-10-22 10:00:22 -0500824
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800825 return mk;
826}
827
828static void __init kernel_add_sysfs_param(const char *name,
Geert Uytterhoeven63a12d92014-10-13 15:55:44 -0700829 const struct kernel_param *kparam,
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800830 unsigned int name_skip)
831{
832 struct module_kobject *mk;
833 int err;
834
835 mk = locate_module_kobject(name);
836 if (!mk)
837 return;
838
839 /* We need to remove old parameters before adding more. */
840 if (mk->mp)
841 sysfs_remove_group(&mk->kobj, &mk->mp->grp);
842
Rusty Russell9b473de2008-10-22 10:00:22 -0500843 /* These should not fail at boot. */
844 err = add_sysfs_param(mk, kparam, kparam->name + name_skip);
845 BUG_ON(err);
846 err = sysfs_create_group(&mk->kobj, &mk->mp->grp);
847 BUG_ON(err);
Kay Sieversf30c53a2007-01-15 20:22:02 +0100848 kobject_uevent(&mk->kobj, KOBJ_ADD);
Rusty Russell9b473de2008-10-22 10:00:22 -0500849 kobject_put(&mk->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700850}
851
852/*
Jean Delvareb634d132013-07-02 15:35:11 +0930853 * param_sysfs_builtin - add sysfs parameters for built-in modules
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854 *
855 * Add module_parameters to sysfs for "modules" built into the kernel.
856 *
857 * The "module" name (KBUILD_MODNAME) is stored before a dot, the
858 * "parameter" name is stored behind a dot in kernel_param->name. So,
859 * extract the "module" name for all built-in kernel_param-eters,
Rusty Russell9b473de2008-10-22 10:00:22 -0500860 * and for all who have the same, call kernel_add_sysfs_param.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861 */
862static void __init param_sysfs_builtin(void)
863{
Geert Uytterhoeven63a12d92014-10-13 15:55:44 -0700864 const struct kernel_param *kp;
Rusty Russell9b473de2008-10-22 10:00:22 -0500865 unsigned int name_len;
866 char modname[MODULE_NAME_LEN];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867
Rusty Russell9b473de2008-10-22 10:00:22 -0500868 for (kp = __start___param; kp < __stop___param; kp++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869 char *dot;
870
Rusty Russell9b473de2008-10-22 10:00:22 -0500871 if (kp->perm == 0)
872 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873
Rusty Russell730b69d2008-10-22 10:00:22 -0500874 dot = strchr(kp->name, '.');
Linus Torvalds1da177e2005-04-16 15:20:36 -0700875 if (!dot) {
Rusty Russell67e67ce2008-10-22 10:00:23 -0500876 /* This happens for core_param() */
877 strcpy(modname, "kernel");
878 name_len = 0;
879 } else {
880 name_len = dot - kp->name + 1;
881 strlcpy(modname, kp->name, name_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882 }
Rusty Russell67e67ce2008-10-22 10:00:23 -0500883 kernel_add_sysfs_param(modname, kp, name_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700884 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885}
886
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800887ssize_t __modver_version_show(struct module_attribute *mattr,
Kay Sievers4befb022011-07-24 22:06:04 +0930888 struct module_kobject *mk, char *buf)
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800889{
890 struct module_version_attribute *vattr =
891 container_of(mattr, struct module_version_attribute, mattr);
892
Chen Gangf4940ab72013-08-20 15:35:04 +0930893 return scnprintf(buf, PAGE_SIZE, "%s\n", vattr->version);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800894}
895
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800896extern const struct module_version_attribute *__start___modver[];
897extern const struct module_version_attribute *__stop___modver[];
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800898
899static void __init version_sysfs_builtin(void)
900{
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800901 const struct module_version_attribute **p;
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800902 struct module_kobject *mk;
903 int err;
904
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800905 for (p = __start___modver; p < __stop___modver; p++) {
906 const struct module_version_attribute *vattr = *p;
907
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800908 mk = locate_module_kobject(vattr->module_name);
909 if (mk) {
910 err = sysfs_create_file(&mk->kobj, &vattr->mattr.attr);
Rusty Russell74c3dea32015-06-17 06:16:52 +0930911 WARN_ON_ONCE(err);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800912 kobject_uevent(&mk->kobj, KOBJ_ADD);
913 kobject_put(&mk->kobj);
914 }
915 }
916}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700917
918/* module-related sysfs stuff */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920static ssize_t module_attr_show(struct kobject *kobj,
921 struct attribute *attr,
922 char *buf)
923{
924 struct module_attribute *attribute;
925 struct module_kobject *mk;
926 int ret;
927
928 attribute = to_module_attr(attr);
929 mk = to_module_kobject(kobj);
930
931 if (!attribute->show)
Dmitry Torokhov70f28172005-04-29 01:27:34 -0500932 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933
Kay Sievers4befb022011-07-24 22:06:04 +0930934 ret = attribute->show(attribute, mk, buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700935
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936 return ret;
937}
938
939static ssize_t module_attr_store(struct kobject *kobj,
940 struct attribute *attr,
941 const char *buf, size_t len)
942{
943 struct module_attribute *attribute;
944 struct module_kobject *mk;
945 int ret;
946
947 attribute = to_module_attr(attr);
948 mk = to_module_kobject(kobj);
949
950 if (!attribute->store)
Dmitry Torokhov70f28172005-04-29 01:27:34 -0500951 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952
Kay Sievers4befb022011-07-24 22:06:04 +0930953 ret = attribute->store(attribute, mk, buf, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955 return ret;
956}
957
Emese Revfy52cf25d2010-01-19 02:58:23 +0100958static const struct sysfs_ops module_sysfs_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959 .show = module_attr_show,
960 .store = module_attr_store,
961};
962
Kay Sievers270a6c42007-01-18 13:26:15 +0100963static int uevent_filter(struct kset *kset, struct kobject *kobj)
964{
965 struct kobj_type *ktype = get_ktype(kobj);
966
967 if (ktype == &module_ktype)
968 return 1;
969 return 0;
970}
971
Emese Revfy9cd43612009-12-31 14:52:51 +0100972static const struct kset_uevent_ops module_uevent_ops = {
Kay Sievers270a6c42007-01-18 13:26:15 +0100973 .filter = uevent_filter,
974};
975
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700976struct kset *module_kset;
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700977int module_sysfs_initialized;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978
Li Zhong942e4432013-09-03 16:33:57 +0930979static void module_kobj_release(struct kobject *kobj)
980{
981 struct module_kobject *mk = to_module_kobject(kobj);
982 complete(mk->kobj_completion);
983}
984
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700985struct kobj_type module_ktype = {
Li Zhong942e4432013-09-03 16:33:57 +0930986 .release = module_kobj_release,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700987 .sysfs_ops = &module_sysfs_ops,
988};
989
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990/*
991 * param_sysfs_init - wrapper for built-in params support
992 */
993static int __init param_sysfs_init(void)
994{
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700995 module_kset = kset_create_and_add("module", &module_uevent_ops, NULL);
996 if (!module_kset) {
997 printk(KERN_WARNING "%s (%d): error creating kset\n",
998 __FILE__, __LINE__);
999 return -ENOMEM;
Randy Dunlapd8c76492006-09-29 01:58:55 -07001000 }
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -07001001 module_sysfs_initialized = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001002
Dmitry Torokhove94965e2010-12-15 14:00:19 -08001003 version_sysfs_builtin();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001004 param_sysfs_builtin();
1005
1006 return 0;
1007}
Mark Huangd10be6d2006-09-29 01:59:34 -07001008subsys_initcall(param_sysfs_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -07001010#endif /* CONFIG_SYSFS */