blob: 93a380a2345d71ae8c884a56006977eec959cbf8 [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
Dan Streetman3d9c6372015-11-06 16:29:12 -0800328void param_free_charp(void *arg)
Rusty Russella1054322010-08-11 23:04:18 -0600329{
330 maybe_kfree_parameter(*((char **)arg));
331}
Dan Streetman3d9c6372015-11-06 16:29:12 -0800332EXPORT_SYMBOL(param_free_charp);
Rusty Russella1054322010-08-11 23:04:18 -0600333
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930334const struct kernel_param_ops param_ops_charp = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600335 .set = param_set_charp,
336 .get = param_get_charp,
Rusty Russella1054322010-08-11 23:04:18 -0600337 .free = param_free_charp,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600338};
339EXPORT_SYMBOL(param_ops_charp);
340
Rusty Russellfddd5202009-06-12 21:46:57 -0600341/* Actually could be a bool or an int, for historical reasons. */
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600342int param_set_bool(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700343{
344 /* No equals means "set"... */
345 if (!val) val = "1";
346
347 /* One of =[yYnN01] */
Rusty Russell8b825282012-03-26 12:50:51 +1030348 return strtobool(val, kp->arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700349}
Rusty Russella14fe242010-08-11 23:04:11 -0600350EXPORT_SYMBOL(param_set_bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700351
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600352int param_get_bool(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700353{
354 /* Y and N chosen as being relatively non-coder friendly */
Rusty Russell8b825282012-03-26 12:50:51 +1030355 return sprintf(buffer, "%c", *(bool *)kp->arg ? 'Y' : 'N');
Linus Torvalds1da177e2005-04-16 15:20:36 -0700356}
Rusty Russella14fe242010-08-11 23:04:11 -0600357EXPORT_SYMBOL(param_get_bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700358
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930359const struct kernel_param_ops param_ops_bool = {
Jani Nikula6a4c2642014-08-27 06:21:23 +0930360 .flags = KERNEL_PARAM_OPS_FL_NOARG,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600361 .set = param_set_bool,
362 .get = param_get_bool,
363};
364EXPORT_SYMBOL(param_ops_bool);
365
Luis R. Rodriguezd19f05d2015-05-27 11:09:38 +0930366int param_set_bool_enable_only(const char *val, const struct kernel_param *kp)
367{
368 int err = 0;
369 bool new_value;
370 bool orig_value = *(bool *)kp->arg;
371 struct kernel_param dummy_kp = *kp;
372
373 dummy_kp.arg = &new_value;
374
375 err = param_set_bool(val, &dummy_kp);
376 if (err)
377 return err;
378
379 /* Don't let them unset it once it's set! */
380 if (!new_value && orig_value)
381 return -EROFS;
382
383 if (new_value)
384 err = param_set_bool(val, kp);
385
386 return err;
387}
388EXPORT_SYMBOL_GPL(param_set_bool_enable_only);
389
390const struct kernel_param_ops param_ops_bool_enable_only = {
391 .flags = KERNEL_PARAM_OPS_FL_NOARG,
392 .set = param_set_bool_enable_only,
393 .get = param_get_bool,
394};
Luis R. Rodriguez154be212015-05-27 11:09:39 +0930395EXPORT_SYMBOL_GPL(param_ops_bool_enable_only);
Luis R. Rodriguezd19f05d2015-05-27 11:09:38 +0930396
Rusty Russellfddd5202009-06-12 21:46:57 -0600397/* This one must be bool. */
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600398int param_set_invbool(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399{
Rusty Russellfddd5202009-06-12 21:46:57 -0600400 int ret;
401 bool boolval;
Jan Beulich22e48ea2007-10-16 23:29:34 -0700402 struct kernel_param dummy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403
Jan Beulich22e48ea2007-10-16 23:29:34 -0700404 dummy.arg = &boolval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405 ret = param_set_bool(val, &dummy);
406 if (ret == 0)
Rusty Russell9a71af22009-06-12 21:46:53 -0600407 *(bool *)kp->arg = !boolval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700408 return ret;
409}
Rusty Russella14fe242010-08-11 23:04:11 -0600410EXPORT_SYMBOL(param_set_invbool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600412int param_get_invbool(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413{
Rusty Russell9a71af22009-06-12 21:46:53 -0600414 return sprintf(buffer, "%c", (*(bool *)kp->arg) ? 'N' : 'Y');
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415}
Rusty Russella14fe242010-08-11 23:04:11 -0600416EXPORT_SYMBOL(param_get_invbool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930418const struct kernel_param_ops param_ops_invbool = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600419 .set = param_set_invbool,
420 .get = param_get_invbool,
421};
422EXPORT_SYMBOL(param_ops_invbool);
423
Rusty Russell69116f22012-01-13 09:32:17 +1030424int param_set_bint(const char *val, const struct kernel_param *kp)
425{
Dan Streetman5104b7d2015-06-17 06:17:52 +0930426 /* Match bool exactly, by re-using it. */
427 struct kernel_param boolkp = *kp;
Rusty Russell69116f22012-01-13 09:32:17 +1030428 bool v;
429 int ret;
430
Rusty Russell69116f22012-01-13 09:32:17 +1030431 boolkp.arg = &v;
Rusty Russell69116f22012-01-13 09:32:17 +1030432
433 ret = param_set_bool(val, &boolkp);
434 if (ret == 0)
435 *(int *)kp->arg = v;
436 return ret;
437}
438EXPORT_SYMBOL(param_set_bint);
439
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930440const struct kernel_param_ops param_ops_bint = {
Jani Nikula6a4c2642014-08-27 06:21:23 +0930441 .flags = KERNEL_PARAM_OPS_FL_NOARG,
Rusty Russell69116f22012-01-13 09:32:17 +1030442 .set = param_set_bint,
443 .get = param_get_int,
444};
445EXPORT_SYMBOL(param_ops_bint);
446
Bert Wesarg9730b5b2007-05-08 00:28:50 -0700447/* We break the rule and mangle the string. */
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930448static int param_array(struct module *mod,
449 const char *name,
Adrian Bunk98717282006-03-25 03:07:06 -0800450 const char *val,
451 unsigned int min, unsigned int max,
452 void *elem, int elemsize,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600453 int (*set)(const char *, const struct kernel_param *kp),
Pawel Moll026cee02012-03-26 12:50:51 +1030454 s16 level,
Richard Knutssoneb38a992008-02-06 01:37:50 -0800455 unsigned int *num)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700456{
457 int ret;
458 struct kernel_param kp;
459 char save;
460
461 /* Get the name right for errors. */
462 kp.name = name;
463 kp.arg = elem;
Pawel Moll026cee02012-03-26 12:50:51 +1030464 kp.level = level;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700465
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 *num = 0;
467 /* We expect a comma-separated list of values. */
468 do {
469 int len;
470
471 if (*num == max) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600472 pr_err("%s: can only take %i arguments\n", name, max);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473 return -EINVAL;
474 }
475 len = strcspn(val, ",");
476
477 /* nul-terminate and parse */
478 save = val[len];
479 ((char *)val)[len] = '\0';
Rusty Russellcf2fde72015-06-26 06:44:38 +0930480 check_kparam_locked(mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481 ret = set(val, &kp);
482
483 if (ret != 0)
484 return ret;
485 kp.arg += elemsize;
486 val += len+1;
487 (*num)++;
488 } while (save == ',');
489
490 if (*num < min) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600491 pr_err("%s: needs at least %i arguments\n", name, min);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700492 return -EINVAL;
493 }
494 return 0;
495}
496
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600497static int param_array_set(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700499 const struct kparam_array *arr = kp->arr;
Bert Wesarg31143a12005-04-16 15:25:42 -0700500 unsigned int temp_num;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930502 return param_array(kp->mod, kp->name, val, 1, arr->max, arr->elem,
Pawel Moll026cee02012-03-26 12:50:51 +1030503 arr->elemsize, arr->ops->set, kp->level,
Rusty Russell3c7d76e2009-10-29 08:56:19 -0600504 arr->num ?: &temp_num);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505}
506
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600507static int param_array_get(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508{
509 int i, off, ret;
Jan Beulich22e48ea2007-10-16 23:29:34 -0700510 const struct kparam_array *arr = kp->arr;
Dan Streetman5104b7d2015-06-17 06:17:52 +0930511 struct kernel_param p = *kp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513 for (i = off = 0; i < (arr->num ? *arr->num : arr->max); i++) {
514 if (i)
515 buffer[off++] = ',';
516 p.arg = arr->elem + arr->elemsize * i;
Rusty Russellcf2fde72015-06-26 06:44:38 +0930517 check_kparam_locked(p.mod);
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600518 ret = arr->ops->get(buffer + off, &p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700519 if (ret < 0)
520 return ret;
521 off += ret;
522 }
523 buffer[off] = '\0';
524 return off;
525}
526
Rusty Russelle6df34a2010-08-11 23:04:17 -0600527static void param_array_free(void *arg)
528{
529 unsigned int i;
530 const struct kparam_array *arr = arg;
531
532 if (arr->ops->free)
533 for (i = 0; i < (arr->num ? *arr->num : arr->max); i++)
534 arr->ops->free(arr->elem + arr->elemsize * i);
535}
536
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930537const struct kernel_param_ops param_array_ops = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600538 .set = param_array_set,
539 .get = param_array_get,
Rusty Russelle6df34a2010-08-11 23:04:17 -0600540 .free = param_array_free,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600541};
542EXPORT_SYMBOL(param_array_ops);
543
544int param_set_copystring(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700546 const struct kparam_string *kps = kp->str;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547
548 if (strlen(val)+1 > kps->maxlen) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600549 pr_err("%s: string doesn't fit in %u chars.\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550 kp->name, kps->maxlen-1);
551 return -ENOSPC;
552 }
553 strcpy(kps->string, val);
554 return 0;
555}
Rusty Russella14fe242010-08-11 23:04:11 -0600556EXPORT_SYMBOL(param_set_copystring);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600558int param_get_string(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700560 const struct kparam_string *kps = kp->str;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 return strlcpy(buffer, kps->string, kps->maxlen);
562}
Rusty Russella14fe242010-08-11 23:04:11 -0600563EXPORT_SYMBOL(param_get_string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930565const struct kernel_param_ops param_ops_string = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600566 .set = param_set_copystring,
567 .get = param_get_string,
568};
569EXPORT_SYMBOL(param_ops_string);
570
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571/* sysfs output in /sys/modules/XYZ/parameters/ */
Edward Z. Yang350f8252010-02-01 18:26:59 -0500572#define to_module_attr(n) container_of(n, struct module_attribute, attr)
573#define to_module_kobject(n) container_of(n, struct module_kobject, kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575struct param_attribute
576{
577 struct module_attribute mattr;
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600578 const struct kernel_param *param;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579};
580
581struct module_param_attrs
582{
Rusty Russell9b473de2008-10-22 10:00:22 -0500583 unsigned int num;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 struct attribute_group grp;
585 struct param_attribute attrs[0];
586};
587
Randy Dunlapef665c12007-02-13 15:19:06 -0800588#ifdef CONFIG_SYSFS
Edward Z. Yang350f8252010-02-01 18:26:59 -0500589#define to_param_attr(n) container_of(n, struct param_attribute, mattr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590
591static ssize_t param_attr_show(struct module_attribute *mattr,
Kay Sievers4befb022011-07-24 22:06:04 +0930592 struct module_kobject *mk, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593{
594 int count;
595 struct param_attribute *attribute = to_param_attr(mattr);
596
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600597 if (!attribute->param->ops->get)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598 return -EPERM;
599
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930600 kernel_param_lock(mk->mod);
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600601 count = attribute->param->ops->get(buf, attribute->param);
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930602 kernel_param_unlock(mk->mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700603 if (count > 0) {
604 strcat(buf, "\n");
605 ++count;
606 }
607 return count;
608}
609
610/* sysfs always hands a nul-terminated string in buf. We rely on that. */
611static ssize_t param_attr_store(struct module_attribute *mattr,
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930612 struct module_kobject *mk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613 const char *buf, size_t len)
614{
615 int err;
616 struct param_attribute *attribute = to_param_attr(mattr);
617
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600618 if (!attribute->param->ops->set)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700619 return -EPERM;
620
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930621 kernel_param_lock(mk->mod);
Rusty Russell7a486d32014-08-27 06:25:23 +0930622 param_check_unsafe(attribute->param);
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600623 err = attribute->param->ops->set(buf, attribute->param);
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930624 kernel_param_unlock(mk->mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700625 if (!err)
626 return len;
627 return err;
628}
Randy Dunlapef665c12007-02-13 15:19:06 -0800629#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630
631#ifdef CONFIG_MODULES
632#define __modinit
633#else
634#define __modinit __init
635#endif
636
Randy Dunlapef665c12007-02-13 15:19:06 -0800637#ifdef CONFIG_SYSFS
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930638void kernel_param_lock(struct module *mod)
Rusty Russell907b29e2010-08-11 23:04:19 -0600639{
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930640 mutex_lock(KPARAM_MUTEX(mod));
Rusty Russell907b29e2010-08-11 23:04:19 -0600641}
Rusty Russell907b29e2010-08-11 23:04:19 -0600642
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930643void kernel_param_unlock(struct module *mod)
Rusty Russell907b29e2010-08-11 23:04:19 -0600644{
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930645 mutex_unlock(KPARAM_MUTEX(mod));
Rusty Russell907b29e2010-08-11 23:04:19 -0600646}
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930647
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930648EXPORT_SYMBOL(kernel_param_lock);
649EXPORT_SYMBOL(kernel_param_unlock);
Rusty Russell907b29e2010-08-11 23:04:19 -0600650
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651/*
Rusty Russell9b473de2008-10-22 10:00:22 -0500652 * add_sysfs_param - add a parameter to sysfs
653 * @mk: struct module_kobject
654 * @kparam: the actual parameter definition to add to sysfs
655 * @name: name of parameter
Linus Torvalds1da177e2005-04-16 15:20:36 -0700656 *
Rusty Russell9b473de2008-10-22 10:00:22 -0500657 * Create a kobject if for a (per-module) parameter if mp NULL, and
658 * create file in sysfs. Returns an error on out of memory. Always cleans up
659 * if there's an error.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700660 */
Rusty Russell9b473de2008-10-22 10:00:22 -0500661static __modinit int add_sysfs_param(struct module_kobject *mk,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600662 const struct kernel_param *kp,
Rusty Russell9b473de2008-10-22 10:00:22 -0500663 const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664{
Rusty Russell18eb74f2014-11-10 09:32:29 +1030665 struct module_param_attrs *new_mp;
666 struct attribute **new_attrs;
667 unsigned int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668
Rusty Russell9b473de2008-10-22 10:00:22 -0500669 /* We don't bother calling this with invisible parameters. */
670 BUG_ON(!kp->perm);
671
672 if (!mk->mp) {
Rusty Russell18eb74f2014-11-10 09:32:29 +1030673 /* First allocation. */
674 mk->mp = kzalloc(sizeof(*mk->mp), GFP_KERNEL);
675 if (!mk->mp)
676 return -ENOMEM;
677 mk->mp->grp.name = "parameters";
678 /* NULL-terminated attribute array. */
679 mk->mp->grp.attrs = kzalloc(sizeof(mk->mp->grp.attrs[0]),
680 GFP_KERNEL);
681 /* Caller will cleanup via free_module_param_attrs */
682 if (!mk->mp->grp.attrs)
683 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 }
685
Rusty Russell18eb74f2014-11-10 09:32:29 +1030686 /* Enlarge allocations. */
687 new_mp = krealloc(mk->mp,
688 sizeof(*mk->mp) +
689 sizeof(mk->mp->attrs[0]) * (mk->mp->num + 1),
690 GFP_KERNEL);
691 if (!new_mp)
692 return -ENOMEM;
693 mk->mp = new_mp;
Rusty Russell9b473de2008-10-22 10:00:22 -0500694
Rusty Russell18eb74f2014-11-10 09:32:29 +1030695 /* Extra pointer for NULL terminator */
696 new_attrs = krealloc(mk->mp->grp.attrs,
697 sizeof(mk->mp->grp.attrs[0]) * (mk->mp->num + 2),
698 GFP_KERNEL);
699 if (!new_attrs)
700 return -ENOMEM;
701 mk->mp->grp.attrs = new_attrs;
Rusty Russell9b473de2008-10-22 10:00:22 -0500702
703 /* Tack new one on the end. */
Rusty Russellc772be52015-01-20 09:07:04 +1030704 memset(&mk->mp->attrs[mk->mp->num], 0, sizeof(mk->mp->attrs[0]));
Rusty Russell18eb74f2014-11-10 09:32:29 +1030705 sysfs_attr_init(&mk->mp->attrs[mk->mp->num].mattr.attr);
706 mk->mp->attrs[mk->mp->num].param = kp;
707 mk->mp->attrs[mk->mp->num].mattr.show = param_attr_show;
Kees Cookb0a65b02014-12-12 13:36:49 +1030708 /* Do not allow runtime DAC changes to make param writable. */
709 if ((kp->perm & (S_IWUSR | S_IWGRP | S_IWOTH)) != 0)
710 mk->mp->attrs[mk->mp->num].mattr.store = param_attr_store;
Rusty Russell574732c2014-12-23 15:05:36 +1030711 else
712 mk->mp->attrs[mk->mp->num].mattr.store = NULL;
Rusty Russell18eb74f2014-11-10 09:32:29 +1030713 mk->mp->attrs[mk->mp->num].mattr.attr.name = (char *)name;
714 mk->mp->attrs[mk->mp->num].mattr.attr.mode = kp->perm;
715 mk->mp->num++;
Rusty Russell9b473de2008-10-22 10:00:22 -0500716
717 /* Fix up all the pointers, since krealloc can move us */
Rusty Russell18eb74f2014-11-10 09:32:29 +1030718 for (i = 0; i < mk->mp->num; i++)
719 mk->mp->grp.attrs[i] = &mk->mp->attrs[i].mattr.attr;
720 mk->mp->grp.attrs[mk->mp->num] = NULL;
Rusty Russell9b473de2008-10-22 10:00:22 -0500721 return 0;
Rusty Russell9b473de2008-10-22 10:00:22 -0500722}
723
Linus Torvaldsd2441182008-10-23 12:07:17 -0700724#ifdef CONFIG_MODULES
Rusty Russell9b473de2008-10-22 10:00:22 -0500725static void free_module_param_attrs(struct module_kobject *mk)
726{
Rusty Russell18eb74f2014-11-10 09:32:29 +1030727 if (mk->mp)
728 kfree(mk->mp->grp.attrs);
Rusty Russell9b473de2008-10-22 10:00:22 -0500729 kfree(mk->mp);
730 mk->mp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700731}
732
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733/*
734 * module_param_sysfs_setup - setup sysfs support for one module
735 * @mod: module
736 * @kparam: module parameters (array)
737 * @num_params: number of module parameters
738 *
Rusty Russell9b473de2008-10-22 10:00:22 -0500739 * Adds sysfs entries for module parameters under
740 * /sys/module/[mod->name]/parameters/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741 */
742int module_param_sysfs_setup(struct module *mod,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600743 const struct kernel_param *kparam,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744 unsigned int num_params)
745{
Rusty Russell9b473de2008-10-22 10:00:22 -0500746 int i, err;
747 bool params = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748
Rusty Russell9b473de2008-10-22 10:00:22 -0500749 for (i = 0; i < num_params; i++) {
750 if (kparam[i].perm == 0)
751 continue;
752 err = add_sysfs_param(&mod->mkobj, &kparam[i], kparam[i].name);
Rusty Russell18eb74f2014-11-10 09:32:29 +1030753 if (err) {
754 free_module_param_attrs(&mod->mkobj);
Rusty Russell9b473de2008-10-22 10:00:22 -0500755 return err;
Rusty Russell18eb74f2014-11-10 09:32:29 +1030756 }
Rusty Russell9b473de2008-10-22 10:00:22 -0500757 params = true;
758 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700759
Rusty Russell9b473de2008-10-22 10:00:22 -0500760 if (!params)
761 return 0;
762
763 /* Create the param group. */
764 err = sysfs_create_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp);
765 if (err)
766 free_module_param_attrs(&mod->mkobj);
767 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768}
769
770/*
771 * module_param_sysfs_remove - remove sysfs support for one module
772 * @mod: module
773 *
774 * Remove sysfs entries for module parameters and the corresponding
775 * kobject.
776 */
777void module_param_sysfs_remove(struct module *mod)
778{
Rusty Russell9b473de2008-10-22 10:00:22 -0500779 if (mod->mkobj.mp) {
780 sysfs_remove_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700781 /* We are positive that no one is using any param
782 * attrs at this point. Deallocate immediately. */
Rusty Russell9b473de2008-10-22 10:00:22 -0500783 free_module_param_attrs(&mod->mkobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784 }
785}
786#endif
787
Rusty Russelle180a6b2009-03-31 13:05:29 -0600788void destroy_params(const struct kernel_param *params, unsigned num)
789{
Rusty Russelle6df34a2010-08-11 23:04:17 -0600790 unsigned int i;
791
792 for (i = 0; i < num; i++)
793 if (params[i].ops->free)
794 params[i].ops->free(params[i].arg);
Rusty Russelle180a6b2009-03-31 13:05:29 -0600795}
796
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800797static struct module_kobject * __init locate_module_kobject(const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798{
799 struct module_kobject *mk;
Rusty Russell9b473de2008-10-22 10:00:22 -0500800 struct kobject *kobj;
801 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802
Rusty Russell9b473de2008-10-22 10:00:22 -0500803 kobj = kset_find_obj(module_kset, name);
804 if (kobj) {
Rusty Russell9b473de2008-10-22 10:00:22 -0500805 mk = to_module_kobject(kobj);
Rusty Russell9b473de2008-10-22 10:00:22 -0500806 } else {
807 mk = kzalloc(sizeof(struct module_kobject), GFP_KERNEL);
808 BUG_ON(!mk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809
Rusty Russell9b473de2008-10-22 10:00:22 -0500810 mk->mod = THIS_MODULE;
811 mk->kobj.kset = module_kset;
812 err = kobject_init_and_add(&mk->kobj, &module_ktype, NULL,
813 "%s", name);
Kay Sievers88bfa322011-07-24 22:06:04 +0930814#ifdef CONFIG_MODULES
815 if (!err)
816 err = sysfs_create_file(&mk->kobj, &module_uevent.attr);
817#endif
Rusty Russell9b473de2008-10-22 10:00:22 -0500818 if (err) {
819 kobject_put(&mk->kobj);
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600820 pr_crit("Adding module '%s' to sysfs failed (%d), the system may be unstable.\n",
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800821 name, err);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800822 return NULL;
Rusty Russell9b473de2008-10-22 10:00:22 -0500823 }
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800824
825 /* So that we hold reference in both cases. */
Rusty Russell9b473de2008-10-22 10:00:22 -0500826 kobject_get(&mk->kobj);
Greg Kroah-Hartman74c5b592007-07-30 11:26:38 -0700827 }
Rusty Russell9b473de2008-10-22 10:00:22 -0500828
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800829 return mk;
830}
831
832static void __init kernel_add_sysfs_param(const char *name,
Geert Uytterhoeven63a12d92014-10-13 15:55:44 -0700833 const struct kernel_param *kparam,
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800834 unsigned int name_skip)
835{
836 struct module_kobject *mk;
837 int err;
838
839 mk = locate_module_kobject(name);
840 if (!mk)
841 return;
842
843 /* We need to remove old parameters before adding more. */
844 if (mk->mp)
845 sysfs_remove_group(&mk->kobj, &mk->mp->grp);
846
Rusty Russell9b473de2008-10-22 10:00:22 -0500847 /* These should not fail at boot. */
848 err = add_sysfs_param(mk, kparam, kparam->name + name_skip);
849 BUG_ON(err);
850 err = sysfs_create_group(&mk->kobj, &mk->mp->grp);
851 BUG_ON(err);
Kay Sieversf30c53a2007-01-15 20:22:02 +0100852 kobject_uevent(&mk->kobj, KOBJ_ADD);
Rusty Russell9b473de2008-10-22 10:00:22 -0500853 kobject_put(&mk->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854}
855
856/*
Jean Delvareb634d132013-07-02 15:35:11 +0930857 * param_sysfs_builtin - add sysfs parameters for built-in modules
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858 *
859 * Add module_parameters to sysfs for "modules" built into the kernel.
860 *
861 * The "module" name (KBUILD_MODNAME) is stored before a dot, the
862 * "parameter" name is stored behind a dot in kernel_param->name. So,
863 * extract the "module" name for all built-in kernel_param-eters,
Rusty Russell9b473de2008-10-22 10:00:22 -0500864 * and for all who have the same, call kernel_add_sysfs_param.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700865 */
866static void __init param_sysfs_builtin(void)
867{
Geert Uytterhoeven63a12d92014-10-13 15:55:44 -0700868 const struct kernel_param *kp;
Rusty Russell9b473de2008-10-22 10:00:22 -0500869 unsigned int name_len;
870 char modname[MODULE_NAME_LEN];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871
Rusty Russell9b473de2008-10-22 10:00:22 -0500872 for (kp = __start___param; kp < __stop___param; kp++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873 char *dot;
874
Rusty Russell9b473de2008-10-22 10:00:22 -0500875 if (kp->perm == 0)
876 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700877
Rusty Russell730b69d2008-10-22 10:00:22 -0500878 dot = strchr(kp->name, '.');
Linus Torvalds1da177e2005-04-16 15:20:36 -0700879 if (!dot) {
Rusty Russell67e67ce2008-10-22 10:00:23 -0500880 /* This happens for core_param() */
881 strcpy(modname, "kernel");
882 name_len = 0;
883 } else {
884 name_len = dot - kp->name + 1;
885 strlcpy(modname, kp->name, name_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886 }
Rusty Russell67e67ce2008-10-22 10:00:23 -0500887 kernel_add_sysfs_param(modname, kp, name_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889}
890
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800891ssize_t __modver_version_show(struct module_attribute *mattr,
Kay Sievers4befb022011-07-24 22:06:04 +0930892 struct module_kobject *mk, char *buf)
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800893{
894 struct module_version_attribute *vattr =
895 container_of(mattr, struct module_version_attribute, mattr);
896
Chen Gangf4940ab72013-08-20 15:35:04 +0930897 return scnprintf(buf, PAGE_SIZE, "%s\n", vattr->version);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800898}
899
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800900extern const struct module_version_attribute *__start___modver[];
901extern const struct module_version_attribute *__stop___modver[];
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800902
903static void __init version_sysfs_builtin(void)
904{
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800905 const struct module_version_attribute **p;
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800906 struct module_kobject *mk;
907 int err;
908
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800909 for (p = __start___modver; p < __stop___modver; p++) {
910 const struct module_version_attribute *vattr = *p;
911
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800912 mk = locate_module_kobject(vattr->module_name);
913 if (mk) {
914 err = sysfs_create_file(&mk->kobj, &vattr->mattr.attr);
Rusty Russell74c3dea32015-06-17 06:16:52 +0930915 WARN_ON_ONCE(err);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800916 kobject_uevent(&mk->kobj, KOBJ_ADD);
917 kobject_put(&mk->kobj);
918 }
919 }
920}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921
922/* module-related sysfs stuff */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700923
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924static ssize_t module_attr_show(struct kobject *kobj,
925 struct attribute *attr,
926 char *buf)
927{
928 struct module_attribute *attribute;
929 struct module_kobject *mk;
930 int ret;
931
932 attribute = to_module_attr(attr);
933 mk = to_module_kobject(kobj);
934
935 if (!attribute->show)
Dmitry Torokhov70f28172005-04-29 01:27:34 -0500936 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937
Kay Sievers4befb022011-07-24 22:06:04 +0930938 ret = attribute->show(attribute, mk, buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940 return ret;
941}
942
943static ssize_t module_attr_store(struct kobject *kobj,
944 struct attribute *attr,
945 const char *buf, size_t len)
946{
947 struct module_attribute *attribute;
948 struct module_kobject *mk;
949 int ret;
950
951 attribute = to_module_attr(attr);
952 mk = to_module_kobject(kobj);
953
954 if (!attribute->store)
Dmitry Torokhov70f28172005-04-29 01:27:34 -0500955 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700956
Kay Sievers4befb022011-07-24 22:06:04 +0930957 ret = attribute->store(attribute, mk, buf, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959 return ret;
960}
961
Emese Revfy52cf25d2010-01-19 02:58:23 +0100962static const struct sysfs_ops module_sysfs_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700963 .show = module_attr_show,
964 .store = module_attr_store,
965};
966
Kay Sievers270a6c42007-01-18 13:26:15 +0100967static int uevent_filter(struct kset *kset, struct kobject *kobj)
968{
969 struct kobj_type *ktype = get_ktype(kobj);
970
971 if (ktype == &module_ktype)
972 return 1;
973 return 0;
974}
975
Emese Revfy9cd43612009-12-31 14:52:51 +0100976static const struct kset_uevent_ops module_uevent_ops = {
Kay Sievers270a6c42007-01-18 13:26:15 +0100977 .filter = uevent_filter,
978};
979
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700980struct kset *module_kset;
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700981int module_sysfs_initialized;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700982
Li Zhong942e4432013-09-03 16:33:57 +0930983static void module_kobj_release(struct kobject *kobj)
984{
985 struct module_kobject *mk = to_module_kobject(kobj);
986 complete(mk->kobj_completion);
987}
988
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700989struct kobj_type module_ktype = {
Li Zhong942e4432013-09-03 16:33:57 +0930990 .release = module_kobj_release,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991 .sysfs_ops = &module_sysfs_ops,
992};
993
Linus Torvalds1da177e2005-04-16 15:20:36 -0700994/*
995 * param_sysfs_init - wrapper for built-in params support
996 */
997static int __init param_sysfs_init(void)
998{
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700999 module_kset = kset_create_and_add("module", &module_uevent_ops, NULL);
1000 if (!module_kset) {
1001 printk(KERN_WARNING "%s (%d): error creating kset\n",
1002 __FILE__, __LINE__);
1003 return -ENOMEM;
Randy Dunlapd8c76492006-09-29 01:58:55 -07001004 }
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -07001005 module_sysfs_initialized = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001006
Dmitry Torokhove94965e2010-12-15 14:00:19 -08001007 version_sysfs_builtin();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001008 param_sysfs_builtin();
1009
1010 return 0;
1011}
Mark Huangd10be6d2006-09-29 01:59:34 -07001012subsys_initcall(param_sysfs_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001013
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -07001014#endif /* CONFIG_SYSFS */