blob: b6554aa71094473094a97010ec4e3f739f92b5c8 [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,
Luis R. Rodriguezecc86172015-03-30 16:20:03 -0700127 void *arg,
Jim Cromie9fb48c72012-04-27 14:30:34 -0600128 int (*handle_unknown)(char *param, char *val,
Luis R. Rodriguezecc86172015-03-30 16:20:03 -0700129 const char *doing, void *arg))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130{
131 unsigned int i;
Rusty Russell907b29e2010-08-11 23:04:19 -0600132 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133
134 /* Find parameter */
135 for (i = 0; i < num_params; i++) {
136 if (parameq(param, params[i].name)) {
Pawel Moll026cee02012-03-26 12:50:51 +1030137 if (params[i].level < min_level
138 || params[i].level > max_level)
139 return 0;
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300140 /* No one handled NULL, so do it here. */
Steven Rostedtab013c52013-08-20 15:33:19 +0930141 if (!val &&
Jani Nikula6a4c2642014-08-27 06:21:23 +0930142 !(params[i].ops->flags & KERNEL_PARAM_OPS_FL_NOARG))
Rusty Russell2e9fb992010-08-11 23:04:10 -0600143 return -EINVAL;
Jim Cromie9fb48c72012-04-27 14:30:34 -0600144 pr_debug("handling %s with %p\n", param,
145 params[i].ops->set);
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930146 kernel_param_lock(params[i].mod);
Rusty Russell7a486d32014-08-27 06:25:23 +0930147 param_check_unsafe(&params[i]);
Rusty Russell907b29e2010-08-11 23:04:19 -0600148 err = params[i].ops->set(val, &params[i]);
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930149 kernel_param_unlock(params[i].mod);
Rusty Russell907b29e2010-08-11 23:04:19 -0600150 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 }
152 }
153
154 if (handle_unknown) {
Jim Cromie9fb48c72012-04-27 14:30:34 -0600155 pr_debug("doing %s: %s='%s'\n", doing, param, val);
Luis R. Rodriguezecc86172015-03-30 16:20:03 -0700156 return handle_unknown(param, val, doing, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157 }
158
Jim Cromie9fb48c72012-04-27 14:30:34 -0600159 pr_debug("Unknown argument '%s'\n", param);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 return -ENOENT;
161}
162
163/* You can use " around spaces, but can't escape ". */
164/* Hyphens and underscores equivalent in parameter names. */
165static char *next_arg(char *args, char **param, char **val)
166{
167 unsigned int i, equals = 0;
168 int in_quote = 0, quoted = 0;
169 char *next;
170
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 if (*args == '"') {
172 args++;
173 in_quote = 1;
174 quoted = 1;
175 }
176
177 for (i = 0; args[i]; i++) {
Peter Oberparleiter26d052b2009-07-06 17:11:22 +0200178 if (isspace(args[i]) && !in_quote)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179 break;
180 if (equals == 0) {
181 if (args[i] == '=')
182 equals = i;
183 }
184 if (args[i] == '"')
185 in_quote = !in_quote;
186 }
187
188 *param = args;
189 if (!equals)
190 *val = NULL;
191 else {
192 args[equals] = '\0';
193 *val = args + equals + 1;
194
195 /* Don't include quotes in value. */
196 if (**val == '"') {
197 (*val)++;
198 if (args[i-1] == '"')
199 args[i-1] = '\0';
200 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 }
Rusty Russellb9cc4482015-04-15 13:23:48 +0930202 if (quoted && args[i-1] == '"')
203 args[i-1] = '\0';
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204
205 if (args[i]) {
206 args[i] = '\0';
207 next = args + i + 1;
208 } else
209 next = args + i;
Rusty Russellf36462f2005-09-27 21:45:34 -0700210
211 /* Chew up trailing spaces. */
André Goddard Rosae7d28602009-12-14 18:01:06 -0800212 return skip_spaces(next);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213}
214
215/* Args looks like "foo=bar,bar2 baz=fuz wiz". */
Rusty Russell51e158c2014-04-28 11:34:33 +0930216char *parse_args(const char *doing,
217 char *args,
218 const struct kernel_param *params,
219 unsigned num,
220 s16 min_level,
221 s16 max_level,
Luis R. Rodriguezecc86172015-03-30 16:20:03 -0700222 void *arg,
223 int (*unknown)(char *param, char *val,
224 const char *doing, void *arg))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225{
226 char *param, *val;
227
Rusty Russellf36462f2005-09-27 21:45:34 -0700228 /* Chew leading spaces */
André Goddard Rosae7d28602009-12-14 18:01:06 -0800229 args = skip_spaces(args);
Rusty Russellf36462f2005-09-27 21:45:34 -0700230
Jim Cromie1ef9eaf2012-05-03 11:57:37 -0600231 if (*args)
Jim Cromie9fb48c72012-04-27 14:30:34 -0600232 pr_debug("doing %s, parsing ARGS: '%s'\n", doing, args);
233
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 while (*args) {
235 int ret;
Ard van Breemena416aba2007-01-05 16:36:20 -0800236 int irq_was_disabled;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237
238 args = next_arg(args, &param, &val);
Rusty Russell51e158c2014-04-28 11:34:33 +0930239 /* Stop at -- */
240 if (!val && strcmp(param, "--") == 0)
241 return args;
Ard van Breemena416aba2007-01-05 16:36:20 -0800242 irq_was_disabled = irqs_disabled();
Jim Cromie9fb48c72012-04-27 14:30:34 -0600243 ret = parse_one(param, val, doing, params, num,
Luis R. Rodriguezecc86172015-03-30 16:20:03 -0700244 min_level, max_level, arg, unknown);
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600245 if (irq_was_disabled && !irqs_disabled())
246 pr_warn("%s: option '%s' enabled irq's!\n",
247 doing, param);
248
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 switch (ret) {
250 case -ENOENT:
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600251 pr_err("%s: Unknown parameter `%s'\n", doing, param);
Rusty Russell51e158c2014-04-28 11:34:33 +0930252 return ERR_PTR(ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700253 case -ENOSPC:
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600254 pr_err("%s: `%s' too large for parameter `%s'\n",
Jim Cromie9fb48c72012-04-27 14:30:34 -0600255 doing, val ?: "", param);
Rusty Russell51e158c2014-04-28 11:34:33 +0930256 return ERR_PTR(ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700257 case 0:
258 break;
259 default:
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600260 pr_err("%s: `%s' invalid for parameter `%s'\n",
Jim Cromie9fb48c72012-04-27 14:30:34 -0600261 doing, val ?: "", param);
Rusty Russell51e158c2014-04-28 11:34:33 +0930262 return ERR_PTR(ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 }
264 }
265
266 /* All parsed OK. */
Rusty Russell51e158c2014-04-28 11:34:33 +0930267 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268}
269
270/* Lazy bastard, eh? */
Felipe Contreras88a88b322013-12-04 14:09:38 +1030271#define STANDARD_PARAM_DEF(name, type, format, strtolfn) \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600272 int param_set_##name(const char *val, const struct kernel_param *kp) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273 { \
Felipe Contreras88a88b322013-12-04 14:09:38 +1030274 return strtolfn(val, 0, (type *)kp->arg); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700275 } \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600276 int param_get_##name(char *buffer, const struct kernel_param *kp) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277 { \
Chen Gangf4940ab72013-08-20 15:35:04 +0930278 return scnprintf(buffer, PAGE_SIZE, format, \
279 *((type *)kp->arg)); \
Rusty Russella14fe242010-08-11 23:04:11 -0600280 } \
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930281 const struct kernel_param_ops param_ops_##name = { \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600282 .set = param_set_##name, \
283 .get = param_get_##name, \
284 }; \
Rusty Russella14fe242010-08-11 23:04:11 -0600285 EXPORT_SYMBOL(param_set_##name); \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600286 EXPORT_SYMBOL(param_get_##name); \
287 EXPORT_SYMBOL(param_ops_##name)
288
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289
Felipe Contreras88a88b322013-12-04 14:09:38 +1030290STANDARD_PARAM_DEF(byte, unsigned char, "%hhu", kstrtou8);
291STANDARD_PARAM_DEF(short, short, "%hi", kstrtos16);
292STANDARD_PARAM_DEF(ushort, unsigned short, "%hu", kstrtou16);
293STANDARD_PARAM_DEF(int, int, "%i", kstrtoint);
294STANDARD_PARAM_DEF(uint, unsigned int, "%u", kstrtouint);
295STANDARD_PARAM_DEF(long, long, "%li", kstrtol);
296STANDARD_PARAM_DEF(ulong, unsigned long, "%lu", kstrtoul);
Hannes Reineckeb4210b82014-06-25 15:27:37 +0200297STANDARD_PARAM_DEF(ullong, unsigned long long, "%llu", kstrtoull);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600299int param_set_charp(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 if (strlen(val) > 1024) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600302 pr_err("%s: string parameter too long\n", kp->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 return -ENOSPC;
304 }
305
Rusty Russella1054322010-08-11 23:04:18 -0600306 maybe_kfree_parameter(*(char **)kp->arg);
307
308 /* This is a hack. We can't kmalloc in early boot, and we
Rusty Russelle180a6b2009-03-31 13:05:29 -0600309 * don't need to; this mangled commandline is preserved. */
310 if (slab_is_available()) {
Rusty Russella1054322010-08-11 23:04:18 -0600311 *(char **)kp->arg = kmalloc_parameter(strlen(val)+1);
Rusty Russelld553ad82009-10-29 08:56:17 -0600312 if (!*(char **)kp->arg)
Rusty Russelle180a6b2009-03-31 13:05:29 -0600313 return -ENOMEM;
Rusty Russella1054322010-08-11 23:04:18 -0600314 strcpy(*(char **)kp->arg, val);
Rusty Russelle180a6b2009-03-31 13:05:29 -0600315 } else
316 *(const char **)kp->arg = val;
317
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318 return 0;
319}
Rusty Russella14fe242010-08-11 23:04:11 -0600320EXPORT_SYMBOL(param_set_charp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600322int param_get_charp(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323{
Chen Gangf4940ab72013-08-20 15:35:04 +0930324 return scnprintf(buffer, PAGE_SIZE, "%s", *((char **)kp->arg));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325}
Rusty Russella14fe242010-08-11 23:04:11 -0600326EXPORT_SYMBOL(param_get_charp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327
Rusty Russella1054322010-08-11 23:04:18 -0600328static void param_free_charp(void *arg)
329{
330 maybe_kfree_parameter(*((char **)arg));
331}
332
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930333const struct kernel_param_ops param_ops_charp = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600334 .set = param_set_charp,
335 .get = param_get_charp,
Rusty Russella1054322010-08-11 23:04:18 -0600336 .free = param_free_charp,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600337};
338EXPORT_SYMBOL(param_ops_charp);
339
Rusty Russellfddd5202009-06-12 21:46:57 -0600340/* Actually could be a bool or an int, for historical reasons. */
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600341int param_set_bool(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342{
343 /* No equals means "set"... */
344 if (!val) val = "1";
345
346 /* One of =[yYnN01] */
Rusty Russell8b825282012-03-26 12:50:51 +1030347 return strtobool(val, kp->arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348}
Rusty Russella14fe242010-08-11 23:04:11 -0600349EXPORT_SYMBOL(param_set_bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600351int param_get_bool(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352{
353 /* Y and N chosen as being relatively non-coder friendly */
Rusty Russell8b825282012-03-26 12:50:51 +1030354 return sprintf(buffer, "%c", *(bool *)kp->arg ? 'Y' : 'N');
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355}
Rusty Russella14fe242010-08-11 23:04:11 -0600356EXPORT_SYMBOL(param_get_bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930358const struct kernel_param_ops param_ops_bool = {
Jani Nikula6a4c2642014-08-27 06:21:23 +0930359 .flags = KERNEL_PARAM_OPS_FL_NOARG,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600360 .set = param_set_bool,
361 .get = param_get_bool,
362};
363EXPORT_SYMBOL(param_ops_bool);
364
Luis R. Rodriguezd19f05d2015-05-27 11:09:38 +0930365int param_set_bool_enable_only(const char *val, const struct kernel_param *kp)
366{
367 int err = 0;
368 bool new_value;
369 bool orig_value = *(bool *)kp->arg;
370 struct kernel_param dummy_kp = *kp;
371
372 dummy_kp.arg = &new_value;
373
374 err = param_set_bool(val, &dummy_kp);
375 if (err)
376 return err;
377
378 /* Don't let them unset it once it's set! */
379 if (!new_value && orig_value)
380 return -EROFS;
381
382 if (new_value)
383 err = param_set_bool(val, kp);
384
385 return err;
386}
387EXPORT_SYMBOL_GPL(param_set_bool_enable_only);
388
389const struct kernel_param_ops param_ops_bool_enable_only = {
390 .flags = KERNEL_PARAM_OPS_FL_NOARG,
391 .set = param_set_bool_enable_only,
392 .get = param_get_bool,
393};
Luis R. Rodriguez154be212015-05-27 11:09:39 +0930394EXPORT_SYMBOL_GPL(param_ops_bool_enable_only);
Luis R. Rodriguezd19f05d2015-05-27 11:09:38 +0930395
Rusty Russellfddd5202009-06-12 21:46:57 -0600396/* This one must be bool. */
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600397int param_set_invbool(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700398{
Rusty Russellfddd5202009-06-12 21:46:57 -0600399 int ret;
400 bool boolval;
Jan Beulich22e48ea2007-10-16 23:29:34 -0700401 struct kernel_param dummy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402
Jan Beulich22e48ea2007-10-16 23:29:34 -0700403 dummy.arg = &boolval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404 ret = param_set_bool(val, &dummy);
405 if (ret == 0)
Rusty Russell9a71af22009-06-12 21:46:53 -0600406 *(bool *)kp->arg = !boolval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700407 return ret;
408}
Rusty Russella14fe242010-08-11 23:04:11 -0600409EXPORT_SYMBOL(param_set_invbool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600411int param_get_invbool(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412{
Rusty Russell9a71af22009-06-12 21:46:53 -0600413 return sprintf(buffer, "%c", (*(bool *)kp->arg) ? 'N' : 'Y');
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414}
Rusty Russella14fe242010-08-11 23:04:11 -0600415EXPORT_SYMBOL(param_get_invbool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930417const struct kernel_param_ops param_ops_invbool = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600418 .set = param_set_invbool,
419 .get = param_get_invbool,
420};
421EXPORT_SYMBOL(param_ops_invbool);
422
Rusty Russell69116f22012-01-13 09:32:17 +1030423int param_set_bint(const char *val, const struct kernel_param *kp)
424{
Dan Streetman5104b7d2015-06-17 06:17:52 +0930425 /* Match bool exactly, by re-using it. */
426 struct kernel_param boolkp = *kp;
Rusty Russell69116f22012-01-13 09:32:17 +1030427 bool v;
428 int ret;
429
Rusty Russell69116f22012-01-13 09:32:17 +1030430 boolkp.arg = &v;
Rusty Russell69116f22012-01-13 09:32:17 +1030431
432 ret = param_set_bool(val, &boolkp);
433 if (ret == 0)
434 *(int *)kp->arg = v;
435 return ret;
436}
437EXPORT_SYMBOL(param_set_bint);
438
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930439const struct kernel_param_ops param_ops_bint = {
Jani Nikula6a4c2642014-08-27 06:21:23 +0930440 .flags = KERNEL_PARAM_OPS_FL_NOARG,
Rusty Russell69116f22012-01-13 09:32:17 +1030441 .set = param_set_bint,
442 .get = param_get_int,
443};
444EXPORT_SYMBOL(param_ops_bint);
445
Bert Wesarg9730b5b2007-05-08 00:28:50 -0700446/* We break the rule and mangle the string. */
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930447static int param_array(struct module *mod,
448 const char *name,
Adrian Bunk98717282006-03-25 03:07:06 -0800449 const char *val,
450 unsigned int min, unsigned int max,
451 void *elem, int elemsize,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600452 int (*set)(const char *, const struct kernel_param *kp),
Pawel Moll026cee02012-03-26 12:50:51 +1030453 s16 level,
Richard Knutssoneb38a992008-02-06 01:37:50 -0800454 unsigned int *num)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455{
456 int ret;
457 struct kernel_param kp;
458 char save;
459
460 /* Get the name right for errors. */
461 kp.name = name;
462 kp.arg = elem;
Pawel Moll026cee02012-03-26 12:50:51 +1030463 kp.level = level;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465 *num = 0;
466 /* We expect a comma-separated list of values. */
467 do {
468 int len;
469
470 if (*num == max) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600471 pr_err("%s: can only take %i arguments\n", name, max);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472 return -EINVAL;
473 }
474 len = strcspn(val, ",");
475
476 /* nul-terminate and parse */
477 save = val[len];
478 ((char *)val)[len] = '\0';
Rusty Russellcf2fde72015-06-26 06:44:38 +0930479 check_kparam_locked(mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480 ret = set(val, &kp);
481
482 if (ret != 0)
483 return ret;
484 kp.arg += elemsize;
485 val += len+1;
486 (*num)++;
487 } while (save == ',');
488
489 if (*num < min) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600490 pr_err("%s: needs at least %i arguments\n", name, min);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 return -EINVAL;
492 }
493 return 0;
494}
495
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600496static int param_array_set(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700498 const struct kparam_array *arr = kp->arr;
Bert Wesarg31143a12005-04-16 15:25:42 -0700499 unsigned int temp_num;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930501 return param_array(kp->mod, kp->name, val, 1, arr->max, arr->elem,
Pawel Moll026cee02012-03-26 12:50:51 +1030502 arr->elemsize, arr->ops->set, kp->level,
Rusty Russell3c7d76e2009-10-29 08:56:19 -0600503 arr->num ?: &temp_num);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504}
505
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600506static int param_array_get(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507{
508 int i, off, ret;
Jan Beulich22e48ea2007-10-16 23:29:34 -0700509 const struct kparam_array *arr = kp->arr;
Dan Streetman5104b7d2015-06-17 06:17:52 +0930510 struct kernel_param p = *kp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512 for (i = off = 0; i < (arr->num ? *arr->num : arr->max); i++) {
513 if (i)
514 buffer[off++] = ',';
515 p.arg = arr->elem + arr->elemsize * i;
Rusty Russellcf2fde72015-06-26 06:44:38 +0930516 check_kparam_locked(p.mod);
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600517 ret = arr->ops->get(buffer + off, &p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518 if (ret < 0)
519 return ret;
520 off += ret;
521 }
522 buffer[off] = '\0';
523 return off;
524}
525
Rusty Russelle6df34a2010-08-11 23:04:17 -0600526static void param_array_free(void *arg)
527{
528 unsigned int i;
529 const struct kparam_array *arr = arg;
530
531 if (arr->ops->free)
532 for (i = 0; i < (arr->num ? *arr->num : arr->max); i++)
533 arr->ops->free(arr->elem + arr->elemsize * i);
534}
535
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930536const struct kernel_param_ops param_array_ops = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600537 .set = param_array_set,
538 .get = param_array_get,
Rusty Russelle6df34a2010-08-11 23:04:17 -0600539 .free = param_array_free,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600540};
541EXPORT_SYMBOL(param_array_ops);
542
543int param_set_copystring(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700544{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700545 const struct kparam_string *kps = kp->str;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546
547 if (strlen(val)+1 > kps->maxlen) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600548 pr_err("%s: string doesn't fit in %u chars.\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549 kp->name, kps->maxlen-1);
550 return -ENOSPC;
551 }
552 strcpy(kps->string, val);
553 return 0;
554}
Rusty Russella14fe242010-08-11 23:04:11 -0600555EXPORT_SYMBOL(param_set_copystring);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600557int param_get_string(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700559 const struct kparam_string *kps = kp->str;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560 return strlcpy(buffer, kps->string, kps->maxlen);
561}
Rusty Russella14fe242010-08-11 23:04:11 -0600562EXPORT_SYMBOL(param_get_string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930564const struct kernel_param_ops param_ops_string = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600565 .set = param_set_copystring,
566 .get = param_get_string,
567};
568EXPORT_SYMBOL(param_ops_string);
569
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570/* sysfs output in /sys/modules/XYZ/parameters/ */
Edward Z. Yang350f8252010-02-01 18:26:59 -0500571#define to_module_attr(n) container_of(n, struct module_attribute, attr)
572#define to_module_kobject(n) container_of(n, struct module_kobject, kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700573
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574struct param_attribute
575{
576 struct module_attribute mattr;
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600577 const struct kernel_param *param;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578};
579
580struct module_param_attrs
581{
Rusty Russell9b473de2008-10-22 10:00:22 -0500582 unsigned int num;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 struct attribute_group grp;
584 struct param_attribute attrs[0];
585};
586
Randy Dunlapef665c12007-02-13 15:19:06 -0800587#ifdef CONFIG_SYSFS
Edward Z. Yang350f8252010-02-01 18:26:59 -0500588#define to_param_attr(n) container_of(n, struct param_attribute, mattr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589
590static ssize_t param_attr_show(struct module_attribute *mattr,
Kay Sievers4befb022011-07-24 22:06:04 +0930591 struct module_kobject *mk, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592{
593 int count;
594 struct param_attribute *attribute = to_param_attr(mattr);
595
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600596 if (!attribute->param->ops->get)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597 return -EPERM;
598
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930599 kernel_param_lock(mk->mod);
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600600 count = attribute->param->ops->get(buf, attribute->param);
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930601 kernel_param_unlock(mk->mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602 if (count > 0) {
603 strcat(buf, "\n");
604 ++count;
605 }
606 return count;
607}
608
609/* sysfs always hands a nul-terminated string in buf. We rely on that. */
610static ssize_t param_attr_store(struct module_attribute *mattr,
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930611 struct module_kobject *mk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612 const char *buf, size_t len)
613{
614 int err;
615 struct param_attribute *attribute = to_param_attr(mattr);
616
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600617 if (!attribute->param->ops->set)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618 return -EPERM;
619
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930620 kernel_param_lock(mk->mod);
Rusty Russell7a486d32014-08-27 06:25:23 +0930621 param_check_unsafe(attribute->param);
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600622 err = attribute->param->ops->set(buf, attribute->param);
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930623 kernel_param_unlock(mk->mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700624 if (!err)
625 return len;
626 return err;
627}
Randy Dunlapef665c12007-02-13 15:19:06 -0800628#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700629
630#ifdef CONFIG_MODULES
631#define __modinit
632#else
633#define __modinit __init
634#endif
635
Randy Dunlapef665c12007-02-13 15:19:06 -0800636#ifdef CONFIG_SYSFS
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930637void kernel_param_lock(struct module *mod)
Rusty Russell907b29e2010-08-11 23:04:19 -0600638{
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930639 mutex_lock(KPARAM_MUTEX(mod));
Rusty Russell907b29e2010-08-11 23:04:19 -0600640}
Rusty Russell907b29e2010-08-11 23:04:19 -0600641
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930642void kernel_param_unlock(struct module *mod)
Rusty Russell907b29e2010-08-11 23:04:19 -0600643{
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930644 mutex_unlock(KPARAM_MUTEX(mod));
Rusty Russell907b29e2010-08-11 23:04:19 -0600645}
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930646
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930647EXPORT_SYMBOL(kernel_param_lock);
648EXPORT_SYMBOL(kernel_param_unlock);
Rusty Russell907b29e2010-08-11 23:04:19 -0600649
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650/*
Rusty Russell9b473de2008-10-22 10:00:22 -0500651 * add_sysfs_param - add a parameter to sysfs
652 * @mk: struct module_kobject
653 * @kparam: the actual parameter definition to add to sysfs
654 * @name: name of parameter
Linus Torvalds1da177e2005-04-16 15:20:36 -0700655 *
Rusty Russell9b473de2008-10-22 10:00:22 -0500656 * Create a kobject if for a (per-module) parameter if mp NULL, and
657 * create file in sysfs. Returns an error on out of memory. Always cleans up
658 * if there's an error.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700659 */
Rusty Russell9b473de2008-10-22 10:00:22 -0500660static __modinit int add_sysfs_param(struct module_kobject *mk,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600661 const struct kernel_param *kp,
Rusty Russell9b473de2008-10-22 10:00:22 -0500662 const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663{
Rusty Russell18eb74f2014-11-10 09:32:29 +1030664 struct module_param_attrs *new_mp;
665 struct attribute **new_attrs;
666 unsigned int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667
Rusty Russell9b473de2008-10-22 10:00:22 -0500668 /* We don't bother calling this with invisible parameters. */
669 BUG_ON(!kp->perm);
670
671 if (!mk->mp) {
Rusty Russell18eb74f2014-11-10 09:32:29 +1030672 /* First allocation. */
673 mk->mp = kzalloc(sizeof(*mk->mp), GFP_KERNEL);
674 if (!mk->mp)
675 return -ENOMEM;
676 mk->mp->grp.name = "parameters";
677 /* NULL-terminated attribute array. */
678 mk->mp->grp.attrs = kzalloc(sizeof(mk->mp->grp.attrs[0]),
679 GFP_KERNEL);
680 /* Caller will cleanup via free_module_param_attrs */
681 if (!mk->mp->grp.attrs)
682 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 }
684
Rusty Russell18eb74f2014-11-10 09:32:29 +1030685 /* Enlarge allocations. */
686 new_mp = krealloc(mk->mp,
687 sizeof(*mk->mp) +
688 sizeof(mk->mp->attrs[0]) * (mk->mp->num + 1),
689 GFP_KERNEL);
690 if (!new_mp)
691 return -ENOMEM;
692 mk->mp = new_mp;
Rusty Russell9b473de2008-10-22 10:00:22 -0500693
Rusty Russell18eb74f2014-11-10 09:32:29 +1030694 /* Extra pointer for NULL terminator */
695 new_attrs = krealloc(mk->mp->grp.attrs,
696 sizeof(mk->mp->grp.attrs[0]) * (mk->mp->num + 2),
697 GFP_KERNEL);
698 if (!new_attrs)
699 return -ENOMEM;
700 mk->mp->grp.attrs = new_attrs;
Rusty Russell9b473de2008-10-22 10:00:22 -0500701
702 /* Tack new one on the end. */
Rusty Russellc772be52015-01-20 09:07:04 +1030703 memset(&mk->mp->attrs[mk->mp->num], 0, sizeof(mk->mp->attrs[0]));
Rusty Russell18eb74f2014-11-10 09:32:29 +1030704 sysfs_attr_init(&mk->mp->attrs[mk->mp->num].mattr.attr);
705 mk->mp->attrs[mk->mp->num].param = kp;
706 mk->mp->attrs[mk->mp->num].mattr.show = param_attr_show;
Kees Cookb0a65b02014-12-12 13:36:49 +1030707 /* Do not allow runtime DAC changes to make param writable. */
708 if ((kp->perm & (S_IWUSR | S_IWGRP | S_IWOTH)) != 0)
709 mk->mp->attrs[mk->mp->num].mattr.store = param_attr_store;
Rusty Russell574732c2014-12-23 15:05:36 +1030710 else
711 mk->mp->attrs[mk->mp->num].mattr.store = NULL;
Rusty Russell18eb74f2014-11-10 09:32:29 +1030712 mk->mp->attrs[mk->mp->num].mattr.attr.name = (char *)name;
713 mk->mp->attrs[mk->mp->num].mattr.attr.mode = kp->perm;
714 mk->mp->num++;
Rusty Russell9b473de2008-10-22 10:00:22 -0500715
716 /* Fix up all the pointers, since krealloc can move us */
Rusty Russell18eb74f2014-11-10 09:32:29 +1030717 for (i = 0; i < mk->mp->num; i++)
718 mk->mp->grp.attrs[i] = &mk->mp->attrs[i].mattr.attr;
719 mk->mp->grp.attrs[mk->mp->num] = NULL;
Rusty Russell9b473de2008-10-22 10:00:22 -0500720 return 0;
Rusty Russell9b473de2008-10-22 10:00:22 -0500721}
722
Linus Torvaldsd2441182008-10-23 12:07:17 -0700723#ifdef CONFIG_MODULES
Rusty Russell9b473de2008-10-22 10:00:22 -0500724static void free_module_param_attrs(struct module_kobject *mk)
725{
Rusty Russell18eb74f2014-11-10 09:32:29 +1030726 if (mk->mp)
727 kfree(mk->mp->grp.attrs);
Rusty Russell9b473de2008-10-22 10:00:22 -0500728 kfree(mk->mp);
729 mk->mp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730}
731
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732/*
733 * module_param_sysfs_setup - setup sysfs support for one module
734 * @mod: module
735 * @kparam: module parameters (array)
736 * @num_params: number of module parameters
737 *
Rusty Russell9b473de2008-10-22 10:00:22 -0500738 * Adds sysfs entries for module parameters under
739 * /sys/module/[mod->name]/parameters/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700740 */
741int module_param_sysfs_setup(struct module *mod,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600742 const struct kernel_param *kparam,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 unsigned int num_params)
744{
Rusty Russell9b473de2008-10-22 10:00:22 -0500745 int i, err;
746 bool params = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747
Rusty Russell9b473de2008-10-22 10:00:22 -0500748 for (i = 0; i < num_params; i++) {
749 if (kparam[i].perm == 0)
750 continue;
751 err = add_sysfs_param(&mod->mkobj, &kparam[i], kparam[i].name);
Rusty Russell18eb74f2014-11-10 09:32:29 +1030752 if (err) {
753 free_module_param_attrs(&mod->mkobj);
Rusty Russell9b473de2008-10-22 10:00:22 -0500754 return err;
Rusty Russell18eb74f2014-11-10 09:32:29 +1030755 }
Rusty Russell9b473de2008-10-22 10:00:22 -0500756 params = true;
757 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758
Rusty Russell9b473de2008-10-22 10:00:22 -0500759 if (!params)
760 return 0;
761
762 /* Create the param group. */
763 err = sysfs_create_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp);
764 if (err)
765 free_module_param_attrs(&mod->mkobj);
766 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700767}
768
769/*
770 * module_param_sysfs_remove - remove sysfs support for one module
771 * @mod: module
772 *
773 * Remove sysfs entries for module parameters and the corresponding
774 * kobject.
775 */
776void module_param_sysfs_remove(struct module *mod)
777{
Rusty Russell9b473de2008-10-22 10:00:22 -0500778 if (mod->mkobj.mp) {
779 sysfs_remove_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780 /* We are positive that no one is using any param
781 * attrs at this point. Deallocate immediately. */
Rusty Russell9b473de2008-10-22 10:00:22 -0500782 free_module_param_attrs(&mod->mkobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783 }
784}
785#endif
786
Rusty Russelle180a6b2009-03-31 13:05:29 -0600787void destroy_params(const struct kernel_param *params, unsigned num)
788{
Rusty Russelle6df34a2010-08-11 23:04:17 -0600789 unsigned int i;
790
791 for (i = 0; i < num; i++)
792 if (params[i].ops->free)
793 params[i].ops->free(params[i].arg);
Rusty Russelle180a6b2009-03-31 13:05:29 -0600794}
795
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800796static struct module_kobject * __init locate_module_kobject(const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797{
798 struct module_kobject *mk;
Rusty Russell9b473de2008-10-22 10:00:22 -0500799 struct kobject *kobj;
800 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700801
Rusty Russell9b473de2008-10-22 10:00:22 -0500802 kobj = kset_find_obj(module_kset, name);
803 if (kobj) {
Rusty Russell9b473de2008-10-22 10:00:22 -0500804 mk = to_module_kobject(kobj);
Rusty Russell9b473de2008-10-22 10:00:22 -0500805 } else {
806 mk = kzalloc(sizeof(struct module_kobject), GFP_KERNEL);
807 BUG_ON(!mk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700808
Rusty Russell9b473de2008-10-22 10:00:22 -0500809 mk->mod = THIS_MODULE;
810 mk->kobj.kset = module_kset;
811 err = kobject_init_and_add(&mk->kobj, &module_ktype, NULL,
812 "%s", name);
Kay Sievers88bfa322011-07-24 22:06:04 +0930813#ifdef CONFIG_MODULES
814 if (!err)
815 err = sysfs_create_file(&mk->kobj, &module_uevent.attr);
816#endif
Rusty Russell9b473de2008-10-22 10:00:22 -0500817 if (err) {
818 kobject_put(&mk->kobj);
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600819 pr_crit("Adding module '%s' to sysfs failed (%d), the system may be unstable.\n",
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800820 name, err);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800821 return NULL;
Rusty Russell9b473de2008-10-22 10:00:22 -0500822 }
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800823
824 /* So that we hold reference in both cases. */
Rusty Russell9b473de2008-10-22 10:00:22 -0500825 kobject_get(&mk->kobj);
Greg Kroah-Hartman74c5b592007-07-30 11:26:38 -0700826 }
Rusty Russell9b473de2008-10-22 10:00:22 -0500827
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800828 return mk;
829}
830
831static void __init kernel_add_sysfs_param(const char *name,
Geert Uytterhoeven63a12d92014-10-13 15:55:44 -0700832 const struct kernel_param *kparam,
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800833 unsigned int name_skip)
834{
835 struct module_kobject *mk;
836 int err;
837
838 mk = locate_module_kobject(name);
839 if (!mk)
840 return;
841
842 /* We need to remove old parameters before adding more. */
843 if (mk->mp)
844 sysfs_remove_group(&mk->kobj, &mk->mp->grp);
845
Rusty Russell9b473de2008-10-22 10:00:22 -0500846 /* These should not fail at boot. */
847 err = add_sysfs_param(mk, kparam, kparam->name + name_skip);
848 BUG_ON(err);
849 err = sysfs_create_group(&mk->kobj, &mk->mp->grp);
850 BUG_ON(err);
Kay Sieversf30c53a2007-01-15 20:22:02 +0100851 kobject_uevent(&mk->kobj, KOBJ_ADD);
Rusty Russell9b473de2008-10-22 10:00:22 -0500852 kobject_put(&mk->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853}
854
855/*
Jean Delvareb634d132013-07-02 15:35:11 +0930856 * param_sysfs_builtin - add sysfs parameters for built-in modules
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857 *
858 * Add module_parameters to sysfs for "modules" built into the kernel.
859 *
860 * The "module" name (KBUILD_MODNAME) is stored before a dot, the
861 * "parameter" name is stored behind a dot in kernel_param->name. So,
862 * extract the "module" name for all built-in kernel_param-eters,
Rusty Russell9b473de2008-10-22 10:00:22 -0500863 * and for all who have the same, call kernel_add_sysfs_param.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700864 */
865static void __init param_sysfs_builtin(void)
866{
Geert Uytterhoeven63a12d92014-10-13 15:55:44 -0700867 const struct kernel_param *kp;
Rusty Russell9b473de2008-10-22 10:00:22 -0500868 unsigned int name_len;
869 char modname[MODULE_NAME_LEN];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870
Rusty Russell9b473de2008-10-22 10:00:22 -0500871 for (kp = __start___param; kp < __stop___param; kp++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872 char *dot;
873
Rusty Russell9b473de2008-10-22 10:00:22 -0500874 if (kp->perm == 0)
875 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700876
Rusty Russell730b69d2008-10-22 10:00:22 -0500877 dot = strchr(kp->name, '.');
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878 if (!dot) {
Rusty Russell67e67ce2008-10-22 10:00:23 -0500879 /* This happens for core_param() */
880 strcpy(modname, "kernel");
881 name_len = 0;
882 } else {
883 name_len = dot - kp->name + 1;
884 strlcpy(modname, kp->name, name_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885 }
Rusty Russell67e67ce2008-10-22 10:00:23 -0500886 kernel_add_sysfs_param(modname, kp, name_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888}
889
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800890ssize_t __modver_version_show(struct module_attribute *mattr,
Kay Sievers4befb022011-07-24 22:06:04 +0930891 struct module_kobject *mk, char *buf)
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800892{
893 struct module_version_attribute *vattr =
894 container_of(mattr, struct module_version_attribute, mattr);
895
Chen Gangf4940ab72013-08-20 15:35:04 +0930896 return scnprintf(buf, PAGE_SIZE, "%s\n", vattr->version);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800897}
898
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800899extern const struct module_version_attribute *__start___modver[];
900extern const struct module_version_attribute *__stop___modver[];
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800901
902static void __init version_sysfs_builtin(void)
903{
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800904 const struct module_version_attribute **p;
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800905 struct module_kobject *mk;
906 int err;
907
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800908 for (p = __start___modver; p < __stop___modver; p++) {
909 const struct module_version_attribute *vattr = *p;
910
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800911 mk = locate_module_kobject(vattr->module_name);
912 if (mk) {
913 err = sysfs_create_file(&mk->kobj, &vattr->mattr.attr);
Rusty Russell74c3dea32015-06-17 06:16:52 +0930914 WARN_ON_ONCE(err);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800915 kobject_uevent(&mk->kobj, KOBJ_ADD);
916 kobject_put(&mk->kobj);
917 }
918 }
919}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700920
921/* module-related sysfs stuff */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923static ssize_t module_attr_show(struct kobject *kobj,
924 struct attribute *attr,
925 char *buf)
926{
927 struct module_attribute *attribute;
928 struct module_kobject *mk;
929 int ret;
930
931 attribute = to_module_attr(attr);
932 mk = to_module_kobject(kobj);
933
934 if (!attribute->show)
Dmitry Torokhov70f28172005-04-29 01:27:34 -0500935 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936
Kay Sievers4befb022011-07-24 22:06:04 +0930937 ret = attribute->show(attribute, mk, buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 return ret;
940}
941
942static ssize_t module_attr_store(struct kobject *kobj,
943 struct attribute *attr,
944 const char *buf, size_t len)
945{
946 struct module_attribute *attribute;
947 struct module_kobject *mk;
948 int ret;
949
950 attribute = to_module_attr(attr);
951 mk = to_module_kobject(kobj);
952
953 if (!attribute->store)
Dmitry Torokhov70f28172005-04-29 01:27:34 -0500954 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955
Kay Sievers4befb022011-07-24 22:06:04 +0930956 ret = attribute->store(attribute, mk, buf, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958 return ret;
959}
960
Emese Revfy52cf25d2010-01-19 02:58:23 +0100961static const struct sysfs_ops module_sysfs_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962 .show = module_attr_show,
963 .store = module_attr_store,
964};
965
Kay Sievers270a6c42007-01-18 13:26:15 +0100966static int uevent_filter(struct kset *kset, struct kobject *kobj)
967{
968 struct kobj_type *ktype = get_ktype(kobj);
969
970 if (ktype == &module_ktype)
971 return 1;
972 return 0;
973}
974
Emese Revfy9cd43612009-12-31 14:52:51 +0100975static const struct kset_uevent_ops module_uevent_ops = {
Kay Sievers270a6c42007-01-18 13:26:15 +0100976 .filter = uevent_filter,
977};
978
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700979struct kset *module_kset;
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700980int module_sysfs_initialized;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700981
Li Zhong942e4432013-09-03 16:33:57 +0930982static void module_kobj_release(struct kobject *kobj)
983{
984 struct module_kobject *mk = to_module_kobject(kobj);
985 complete(mk->kobj_completion);
986}
987
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700988struct kobj_type module_ktype = {
Li Zhong942e4432013-09-03 16:33:57 +0930989 .release = module_kobj_release,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990 .sysfs_ops = &module_sysfs_ops,
991};
992
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993/*
994 * param_sysfs_init - wrapper for built-in params support
995 */
996static int __init param_sysfs_init(void)
997{
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700998 module_kset = kset_create_and_add("module", &module_uevent_ops, NULL);
999 if (!module_kset) {
1000 printk(KERN_WARNING "%s (%d): error creating kset\n",
1001 __FILE__, __LINE__);
1002 return -ENOMEM;
Randy Dunlapd8c76492006-09-29 01:58:55 -07001003 }
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -07001004 module_sysfs_initialized = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001005
Dmitry Torokhove94965e2010-12-15 14:00:19 -08001006 version_sysfs_builtin();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007 param_sysfs_builtin();
1008
1009 return 0;
1010}
Mark Huangd10be6d2006-09-29 01:59:34 -07001011subsys_initcall(param_sysfs_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001012
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -07001013#endif /* CONFIG_SYSFS */