kthread: rename probe_kthread_data() to kthread_probe_data()
[linux-2.6-block.git] / kernel / params.c
CommitLineData
1da177e4
LT
1/* 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*/
1da177e4
LT
18#include <linux/kernel.h>
19#include <linux/string.h>
20#include <linux/errno.h>
21#include <linux/module.h>
63a12d9d 22#include <linux/moduleparam.h>
1da177e4
LT
23#include <linux/device.h>
24#include <linux/err.h>
4e57b681 25#include <linux/slab.h>
26d052bf 26#include <linux/ctype.h>
1da177e4 27
cf2fde7b 28#ifdef CONFIG_SYSFS
b51d23e4 29/* Protects all built-in parameters, modules use their own param_lock */
907b29eb
RR
30static DEFINE_MUTEX(param_lock);
31
b51d23e4 32/* Use the module's mutex, or if built-in use the built-in mutex */
20bdc2cf 33#ifdef CONFIG_MODULES
b51d23e4 34#define KPARAM_MUTEX(mod) ((mod) ? &(mod)->param_lock : &param_lock)
20bdc2cf
SR
35#else
36#define KPARAM_MUTEX(mod) (&param_lock)
37#endif
cf2fde7b
RR
38
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 */
b51d23e4 48
a1054322
RR
49/* This just allows us to keep track of which parameters are kmalloced. */
50struct kmalloced_param {
51 struct list_head list;
52 char val[];
53};
a1054322 54static LIST_HEAD(kmalloced_params);
b51d23e4 55static DEFINE_SPINLOCK(kmalloced_params_lock);
a1054322
RR
56
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
b51d23e4 65 spin_lock(&kmalloced_params_lock);
a1054322 66 list_add(&p->list, &kmalloced_params);
b51d23e4
DS
67 spin_unlock(&kmalloced_params_lock);
68
a1054322
RR
69 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
b51d23e4 77 spin_lock(&kmalloced_params_lock);
a1054322
RR
78 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 }
b51d23e4 85 spin_unlock(&kmalloced_params_lock);
a1054322
RR
86}
87
b1e4d20c 88static char dash2underscore(char c)
1da177e4
LT
89{
90 if (c == '-')
91 return '_';
92 return c;
93}
94
b1e4d20c 95bool parameqn(const char *a, const char *b, size_t n)
1da177e4 96{
b1e4d20c
MS
97 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);
1da177e4
LT
109}
110
7a486d37
RR
111static 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
1da177e4
LT
120static int parse_one(char *param,
121 char *val,
9fb48c74 122 const char *doing,
914dcaa8 123 const struct kernel_param *params,
1da177e4 124 unsigned num_params,
026cee00
PM
125 s16 min_level,
126 s16 max_level,
ecc86170 127 void *arg,
9fb48c74 128 int (*handle_unknown)(char *param, char *val,
ecc86170 129 const char *doing, void *arg))
1da177e4
LT
130{
131 unsigned int i;
907b29eb 132 int err;
1da177e4
LT
133
134 /* Find parameter */
135 for (i = 0; i < num_params; i++) {
136 if (parameq(param, params[i].name)) {
026cee00
PM
137 if (params[i].level < min_level
138 || params[i].level > max_level)
139 return 0;
25985edc 140 /* No one handled NULL, so do it here. */
ab013c5f 141 if (!val &&
6a4c2643 142 !(params[i].ops->flags & KERNEL_PARAM_OPS_FL_NOARG))
2e9fb995 143 return -EINVAL;
9fb48c74
JC
144 pr_debug("handling %s with %p\n", param,
145 params[i].ops->set);
b51d23e4 146 kernel_param_lock(params[i].mod);
7a486d37 147 param_check_unsafe(&params[i]);
907b29eb 148 err = params[i].ops->set(val, &params[i]);
b51d23e4 149 kernel_param_unlock(params[i].mod);
907b29eb 150 return err;
1da177e4
LT
151 }
152 }
153
154 if (handle_unknown) {
9fb48c74 155 pr_debug("doing %s: %s='%s'\n", doing, param, val);
ecc86170 156 return handle_unknown(param, val, doing, arg);
1da177e4
LT
157 }
158
9fb48c74 159 pr_debug("Unknown argument '%s'\n", param);
1da177e4
LT
160 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
1da177e4
LT
171 if (*args == '"') {
172 args++;
173 in_quote = 1;
174 quoted = 1;
175 }
176
177 for (i = 0; args[i]; i++) {
26d052bf 178 if (isspace(args[i]) && !in_quote)
1da177e4
LT
179 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 }
1da177e4 201 }
b9cc4489
RR
202 if (quoted && args[i-1] == '"')
203 args[i-1] = '\0';
1da177e4
LT
204
205 if (args[i]) {
206 args[i] = '\0';
207 next = args + i + 1;
208 } else
209 next = args + i;
f36462f0
RR
210
211 /* Chew up trailing spaces. */
e7d2860b 212 return skip_spaces(next);
1da177e4
LT
213}
214
215/* Args looks like "foo=bar,bar2 baz=fuz wiz". */
51e158c1
RR
216char *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,
ecc86170
LR
222 void *arg,
223 int (*unknown)(char *param, char *val,
224 const char *doing, void *arg))
1da177e4 225{
74b22c46 226 char *param, *val, *err = NULL;
1da177e4 227
f36462f0 228 /* Chew leading spaces */
e7d2860b 229 args = skip_spaces(args);
f36462f0 230
1ef9eaf2 231 if (*args)
9fb48c74
JC
232 pr_debug("doing %s, parsing ARGS: '%s'\n", doing, args);
233
1da177e4
LT
234 while (*args) {
235 int ret;
a416aba6 236 int irq_was_disabled;
1da177e4
LT
237
238 args = next_arg(args, &param, &val);
51e158c1
RR
239 /* Stop at -- */
240 if (!val && strcmp(param, "--") == 0)
74b22c46 241 return err ?: args;
a416aba6 242 irq_was_disabled = irqs_disabled();
9fb48c74 243 ret = parse_one(param, val, doing, params, num,
ecc86170 244 min_level, max_level, arg, unknown);
b5f3abf9
JC
245 if (irq_was_disabled && !irqs_disabled())
246 pr_warn("%s: option '%s' enabled irq's!\n",
247 doing, param);
248
1da177e4 249 switch (ret) {
74b22c46
ON
250 case 0:
251 continue;
1da177e4 252 case -ENOENT:
b5f3abf9 253 pr_err("%s: Unknown parameter `%s'\n", doing, param);
74b22c46 254 break;
1da177e4 255 case -ENOSPC:
b5f3abf9 256 pr_err("%s: `%s' too large for parameter `%s'\n",
9fb48c74 257 doing, val ?: "", param);
1da177e4
LT
258 break;
259 default:
b5f3abf9 260 pr_err("%s: `%s' invalid for parameter `%s'\n",
9fb48c74 261 doing, val ?: "", param);
74b22c46 262 break;
1da177e4 263 }
74b22c46
ON
264
265 err = ERR_PTR(ret);
1da177e4
LT
266 }
267
74b22c46 268 return err;
1da177e4
LT
269}
270
271/* Lazy bastard, eh? */
88a88b32 272#define STANDARD_PARAM_DEF(name, type, format, strtolfn) \
9bbb9e5a 273 int param_set_##name(const char *val, const struct kernel_param *kp) \
1da177e4 274 { \
88a88b32 275 return strtolfn(val, 0, (type *)kp->arg); \
1da177e4 276 } \
9bbb9e5a 277 int param_get_##name(char *buffer, const struct kernel_param *kp) \
1da177e4 278 { \
f4940ab7
CG
279 return scnprintf(buffer, PAGE_SIZE, format, \
280 *((type *)kp->arg)); \
a14fe249 281 } \
9c27847d 282 const struct kernel_param_ops param_ops_##name = { \
9bbb9e5a
RR
283 .set = param_set_##name, \
284 .get = param_get_##name, \
285 }; \
a14fe249 286 EXPORT_SYMBOL(param_set_##name); \
9bbb9e5a
RR
287 EXPORT_SYMBOL(param_get_##name); \
288 EXPORT_SYMBOL(param_ops_##name)
289
1da177e4 290
88a88b32
FC
291STANDARD_PARAM_DEF(byte, unsigned char, "%hhu", kstrtou8);
292STANDARD_PARAM_DEF(short, short, "%hi", kstrtos16);
293STANDARD_PARAM_DEF(ushort, unsigned short, "%hu", kstrtou16);
294STANDARD_PARAM_DEF(int, int, "%i", kstrtoint);
295STANDARD_PARAM_DEF(uint, unsigned int, "%u", kstrtouint);
296STANDARD_PARAM_DEF(long, long, "%li", kstrtol);
297STANDARD_PARAM_DEF(ulong, unsigned long, "%lu", kstrtoul);
b4210b81 298STANDARD_PARAM_DEF(ullong, unsigned long long, "%llu", kstrtoull);
1da177e4 299
9bbb9e5a 300int param_set_charp(const char *val, const struct kernel_param *kp)
1da177e4 301{
1da177e4 302 if (strlen(val) > 1024) {
b5f3abf9 303 pr_err("%s: string parameter too long\n", kp->name);
1da177e4
LT
304 return -ENOSPC;
305 }
306
a1054322
RR
307 maybe_kfree_parameter(*(char **)kp->arg);
308
309 /* This is a hack. We can't kmalloc in early boot, and we
e180a6b7
RR
310 * don't need to; this mangled commandline is preserved. */
311 if (slab_is_available()) {
a1054322 312 *(char **)kp->arg = kmalloc_parameter(strlen(val)+1);
d553ad86 313 if (!*(char **)kp->arg)
e180a6b7 314 return -ENOMEM;
a1054322 315 strcpy(*(char **)kp->arg, val);
e180a6b7
RR
316 } else
317 *(const char **)kp->arg = val;
318
1da177e4
LT
319 return 0;
320}
a14fe249 321EXPORT_SYMBOL(param_set_charp);
1da177e4 322
9bbb9e5a 323int param_get_charp(char *buffer, const struct kernel_param *kp)
1da177e4 324{
f4940ab7 325 return scnprintf(buffer, PAGE_SIZE, "%s", *((char **)kp->arg));
1da177e4 326}
a14fe249 327EXPORT_SYMBOL(param_get_charp);
1da177e4 328
3d9c637f 329void param_free_charp(void *arg)
a1054322
RR
330{
331 maybe_kfree_parameter(*((char **)arg));
332}
3d9c637f 333EXPORT_SYMBOL(param_free_charp);
a1054322 334
9c27847d 335const struct kernel_param_ops param_ops_charp = {
9bbb9e5a
RR
336 .set = param_set_charp,
337 .get = param_get_charp,
a1054322 338 .free = param_free_charp,
9bbb9e5a
RR
339};
340EXPORT_SYMBOL(param_ops_charp);
341
fddd5201 342/* Actually could be a bool or an int, for historical reasons. */
9bbb9e5a 343int param_set_bool(const char *val, const struct kernel_param *kp)
1da177e4
LT
344{
345 /* No equals means "set"... */
346 if (!val) val = "1";
347
348 /* One of =[yYnN01] */
8b825281 349 return strtobool(val, kp->arg);
1da177e4 350}
a14fe249 351EXPORT_SYMBOL(param_set_bool);
1da177e4 352
9bbb9e5a 353int param_get_bool(char *buffer, const struct kernel_param *kp)
1da177e4
LT
354{
355 /* Y and N chosen as being relatively non-coder friendly */
8b825281 356 return sprintf(buffer, "%c", *(bool *)kp->arg ? 'Y' : 'N');
1da177e4 357}
a14fe249 358EXPORT_SYMBOL(param_get_bool);
1da177e4 359
9c27847d 360const struct kernel_param_ops param_ops_bool = {
6a4c2643 361 .flags = KERNEL_PARAM_OPS_FL_NOARG,
9bbb9e5a
RR
362 .set = param_set_bool,
363 .get = param_get_bool,
364};
365EXPORT_SYMBOL(param_ops_bool);
366
d19f05d8
LR
367int param_set_bool_enable_only(const char *val, const struct kernel_param *kp)
368{
369 int err = 0;
370 bool new_value;
371 bool orig_value = *(bool *)kp->arg;
372 struct kernel_param dummy_kp = *kp;
373
374 dummy_kp.arg = &new_value;
375
376 err = param_set_bool(val, &dummy_kp);
377 if (err)
378 return err;
379
380 /* Don't let them unset it once it's set! */
381 if (!new_value && orig_value)
382 return -EROFS;
383
384 if (new_value)
385 err = param_set_bool(val, kp);
386
387 return err;
388}
389EXPORT_SYMBOL_GPL(param_set_bool_enable_only);
390
391const struct kernel_param_ops param_ops_bool_enable_only = {
392 .flags = KERNEL_PARAM_OPS_FL_NOARG,
393 .set = param_set_bool_enable_only,
394 .get = param_get_bool,
395};
154be21c 396EXPORT_SYMBOL_GPL(param_ops_bool_enable_only);
d19f05d8 397
fddd5201 398/* This one must be bool. */
9bbb9e5a 399int param_set_invbool(const char *val, const struct kernel_param *kp)
1da177e4 400{
fddd5201
RR
401 int ret;
402 bool boolval;
22e48eaf 403 struct kernel_param dummy;
1da177e4 404
22e48eaf 405 dummy.arg = &boolval;
1da177e4
LT
406 ret = param_set_bool(val, &dummy);
407 if (ret == 0)
9a71af2c 408 *(bool *)kp->arg = !boolval;
1da177e4
LT
409 return ret;
410}
a14fe249 411EXPORT_SYMBOL(param_set_invbool);
1da177e4 412
9bbb9e5a 413int param_get_invbool(char *buffer, const struct kernel_param *kp)
1da177e4 414{
9a71af2c 415 return sprintf(buffer, "%c", (*(bool *)kp->arg) ? 'N' : 'Y');
1da177e4 416}
a14fe249 417EXPORT_SYMBOL(param_get_invbool);
1da177e4 418
9c27847d 419const struct kernel_param_ops param_ops_invbool = {
9bbb9e5a
RR
420 .set = param_set_invbool,
421 .get = param_get_invbool,
422};
423EXPORT_SYMBOL(param_ops_invbool);
424
69116f27
RR
425int param_set_bint(const char *val, const struct kernel_param *kp)
426{
5104b7d7
DS
427 /* Match bool exactly, by re-using it. */
428 struct kernel_param boolkp = *kp;
69116f27
RR
429 bool v;
430 int ret;
431
69116f27 432 boolkp.arg = &v;
69116f27
RR
433
434 ret = param_set_bool(val, &boolkp);
435 if (ret == 0)
436 *(int *)kp->arg = v;
437 return ret;
438}
439EXPORT_SYMBOL(param_set_bint);
440
9c27847d 441const struct kernel_param_ops param_ops_bint = {
6a4c2643 442 .flags = KERNEL_PARAM_OPS_FL_NOARG,
69116f27
RR
443 .set = param_set_bint,
444 .get = param_get_int,
445};
446EXPORT_SYMBOL(param_ops_bint);
447
9730b5b0 448/* We break the rule and mangle the string. */
b51d23e4
DS
449static int param_array(struct module *mod,
450 const char *name,
9871728b
AB
451 const char *val,
452 unsigned int min, unsigned int max,
453 void *elem, int elemsize,
9bbb9e5a 454 int (*set)(const char *, const struct kernel_param *kp),
026cee00 455 s16 level,
eb38a996 456 unsigned int *num)
1da177e4
LT
457{
458 int ret;
459 struct kernel_param kp;
460 char save;
461
462 /* Get the name right for errors. */
463 kp.name = name;
464 kp.arg = elem;
026cee00 465 kp.level = level;
1da177e4 466
1da177e4
LT
467 *num = 0;
468 /* We expect a comma-separated list of values. */
469 do {
470 int len;
471
472 if (*num == max) {
b5f3abf9 473 pr_err("%s: can only take %i arguments\n", name, max);
1da177e4
LT
474 return -EINVAL;
475 }
476 len = strcspn(val, ",");
477
478 /* nul-terminate and parse */
479 save = val[len];
480 ((char *)val)[len] = '\0';
cf2fde7b 481 check_kparam_locked(mod);
1da177e4
LT
482 ret = set(val, &kp);
483
484 if (ret != 0)
485 return ret;
486 kp.arg += elemsize;
487 val += len+1;
488 (*num)++;
489 } while (save == ',');
490
491 if (*num < min) {
b5f3abf9 492 pr_err("%s: needs at least %i arguments\n", name, min);
1da177e4
LT
493 return -EINVAL;
494 }
495 return 0;
496}
497
9bbb9e5a 498static int param_array_set(const char *val, const struct kernel_param *kp)
1da177e4 499{
22e48eaf 500 const struct kparam_array *arr = kp->arr;
31143a12 501 unsigned int temp_num;
1da177e4 502
b51d23e4 503 return param_array(kp->mod, kp->name, val, 1, arr->max, arr->elem,
026cee00 504 arr->elemsize, arr->ops->set, kp->level,
3c7d76e3 505 arr->num ?: &temp_num);
1da177e4
LT
506}
507
9bbb9e5a 508static int param_array_get(char *buffer, const struct kernel_param *kp)
1da177e4
LT
509{
510 int i, off, ret;
22e48eaf 511 const struct kparam_array *arr = kp->arr;
5104b7d7 512 struct kernel_param p = *kp;
1da177e4 513
1da177e4
LT
514 for (i = off = 0; i < (arr->num ? *arr->num : arr->max); i++) {
515 if (i)
516 buffer[off++] = ',';
517 p.arg = arr->elem + arr->elemsize * i;
cf2fde7b 518 check_kparam_locked(p.mod);
9bbb9e5a 519 ret = arr->ops->get(buffer + off, &p);
1da177e4
LT
520 if (ret < 0)
521 return ret;
522 off += ret;
523 }
524 buffer[off] = '\0';
525 return off;
526}
527
e6df34a4
RR
528static void param_array_free(void *arg)
529{
530 unsigned int i;
531 const struct kparam_array *arr = arg;
532
533 if (arr->ops->free)
534 for (i = 0; i < (arr->num ? *arr->num : arr->max); i++)
535 arr->ops->free(arr->elem + arr->elemsize * i);
536}
537
9c27847d 538const struct kernel_param_ops param_array_ops = {
9bbb9e5a
RR
539 .set = param_array_set,
540 .get = param_array_get,
e6df34a4 541 .free = param_array_free,
9bbb9e5a
RR
542};
543EXPORT_SYMBOL(param_array_ops);
544
545int param_set_copystring(const char *val, const struct kernel_param *kp)
1da177e4 546{
22e48eaf 547 const struct kparam_string *kps = kp->str;
1da177e4
LT
548
549 if (strlen(val)+1 > kps->maxlen) {
b5f3abf9 550 pr_err("%s: string doesn't fit in %u chars.\n",
1da177e4
LT
551 kp->name, kps->maxlen-1);
552 return -ENOSPC;
553 }
554 strcpy(kps->string, val);
555 return 0;
556}
a14fe249 557EXPORT_SYMBOL(param_set_copystring);
1da177e4 558
9bbb9e5a 559int param_get_string(char *buffer, const struct kernel_param *kp)
1da177e4 560{
22e48eaf 561 const struct kparam_string *kps = kp->str;
1da177e4
LT
562 return strlcpy(buffer, kps->string, kps->maxlen);
563}
a14fe249 564EXPORT_SYMBOL(param_get_string);
1da177e4 565
9c27847d 566const struct kernel_param_ops param_ops_string = {
9bbb9e5a
RR
567 .set = param_set_copystring,
568 .get = param_get_string,
569};
570EXPORT_SYMBOL(param_ops_string);
571
1da177e4 572/* sysfs output in /sys/modules/XYZ/parameters/ */
350f8258
EY
573#define to_module_attr(n) container_of(n, struct module_attribute, attr)
574#define to_module_kobject(n) container_of(n, struct module_kobject, kobj)
1da177e4 575
1da177e4
LT
576struct param_attribute
577{
578 struct module_attribute mattr;
9bbb9e5a 579 const struct kernel_param *param;
1da177e4
LT
580};
581
582struct module_param_attrs
583{
9b473de8 584 unsigned int num;
1da177e4
LT
585 struct attribute_group grp;
586 struct param_attribute attrs[0];
587};
588
ef665c1a 589#ifdef CONFIG_SYSFS
350f8258 590#define to_param_attr(n) container_of(n, struct param_attribute, mattr)
1da177e4
LT
591
592static ssize_t param_attr_show(struct module_attribute *mattr,
4befb026 593 struct module_kobject *mk, char *buf)
1da177e4
LT
594{
595 int count;
596 struct param_attribute *attribute = to_param_attr(mattr);
597
9bbb9e5a 598 if (!attribute->param->ops->get)
1da177e4
LT
599 return -EPERM;
600
b51d23e4 601 kernel_param_lock(mk->mod);
9bbb9e5a 602 count = attribute->param->ops->get(buf, attribute->param);
b51d23e4 603 kernel_param_unlock(mk->mod);
1da177e4
LT
604 if (count > 0) {
605 strcat(buf, "\n");
606 ++count;
607 }
608 return count;
609}
610
611/* sysfs always hands a nul-terminated string in buf. We rely on that. */
612static ssize_t param_attr_store(struct module_attribute *mattr,
b51d23e4 613 struct module_kobject *mk,
1da177e4
LT
614 const char *buf, size_t len)
615{
616 int err;
617 struct param_attribute *attribute = to_param_attr(mattr);
618
9bbb9e5a 619 if (!attribute->param->ops->set)
1da177e4
LT
620 return -EPERM;
621
b51d23e4 622 kernel_param_lock(mk->mod);
7a486d37 623 param_check_unsafe(attribute->param);
9bbb9e5a 624 err = attribute->param->ops->set(buf, attribute->param);
b51d23e4 625 kernel_param_unlock(mk->mod);
1da177e4
LT
626 if (!err)
627 return len;
628 return err;
629}
ef665c1a 630#endif
1da177e4
LT
631
632#ifdef CONFIG_MODULES
633#define __modinit
634#else
635#define __modinit __init
636#endif
637
ef665c1a 638#ifdef CONFIG_SYSFS
b51d23e4 639void kernel_param_lock(struct module *mod)
907b29eb 640{
b51d23e4 641 mutex_lock(KPARAM_MUTEX(mod));
907b29eb 642}
907b29eb 643
b51d23e4 644void kernel_param_unlock(struct module *mod)
907b29eb 645{
b51d23e4 646 mutex_unlock(KPARAM_MUTEX(mod));
907b29eb 647}
b51d23e4 648
b51d23e4
DS
649EXPORT_SYMBOL(kernel_param_lock);
650EXPORT_SYMBOL(kernel_param_unlock);
907b29eb 651
1da177e4 652/*
9b473de8
RR
653 * add_sysfs_param - add a parameter to sysfs
654 * @mk: struct module_kobject
655 * @kparam: the actual parameter definition to add to sysfs
656 * @name: name of parameter
1da177e4 657 *
9b473de8
RR
658 * Create a kobject if for a (per-module) parameter if mp NULL, and
659 * create file in sysfs. Returns an error on out of memory. Always cleans up
660 * if there's an error.
1da177e4 661 */
9b473de8 662static __modinit int add_sysfs_param(struct module_kobject *mk,
9bbb9e5a 663 const struct kernel_param *kp,
9b473de8 664 const char *name)
1da177e4 665{
18eb74fa
RR
666 struct module_param_attrs *new_mp;
667 struct attribute **new_attrs;
668 unsigned int i;
9b473de8
RR
669
670 /* We don't bother calling this with invisible parameters. */
671 BUG_ON(!kp->perm);
672
673 if (!mk->mp) {
18eb74fa
RR
674 /* First allocation. */
675 mk->mp = kzalloc(sizeof(*mk->mp), GFP_KERNEL);
676 if (!mk->mp)
677 return -ENOMEM;
678 mk->mp->grp.name = "parameters";
679 /* NULL-terminated attribute array. */
680 mk->mp->grp.attrs = kzalloc(sizeof(mk->mp->grp.attrs[0]),
681 GFP_KERNEL);
682 /* Caller will cleanup via free_module_param_attrs */
683 if (!mk->mp->grp.attrs)
684 return -ENOMEM;
9b473de8 685 }
1da177e4 686
18eb74fa
RR
687 /* Enlarge allocations. */
688 new_mp = krealloc(mk->mp,
689 sizeof(*mk->mp) +
690 sizeof(mk->mp->attrs[0]) * (mk->mp->num + 1),
691 GFP_KERNEL);
692 if (!new_mp)
693 return -ENOMEM;
694 mk->mp = new_mp;
695
696 /* Extra pointer for NULL terminator */
697 new_attrs = krealloc(mk->mp->grp.attrs,
698 sizeof(mk->mp->grp.attrs[0]) * (mk->mp->num + 2),
699 GFP_KERNEL);
700 if (!new_attrs)
701 return -ENOMEM;
702 mk->mp->grp.attrs = new_attrs;
9b473de8
RR
703
704 /* Tack new one on the end. */
c772be52 705 memset(&mk->mp->attrs[mk->mp->num], 0, sizeof(mk->mp->attrs[0]));
18eb74fa
RR
706 sysfs_attr_init(&mk->mp->attrs[mk->mp->num].mattr.attr);
707 mk->mp->attrs[mk->mp->num].param = kp;
708 mk->mp->attrs[mk->mp->num].mattr.show = param_attr_show;
b0a65b0c
KC
709 /* Do not allow runtime DAC changes to make param writable. */
710 if ((kp->perm & (S_IWUSR | S_IWGRP | S_IWOTH)) != 0)
711 mk->mp->attrs[mk->mp->num].mattr.store = param_attr_store;
574732c7
RR
712 else
713 mk->mp->attrs[mk->mp->num].mattr.store = NULL;
18eb74fa
RR
714 mk->mp->attrs[mk->mp->num].mattr.attr.name = (char *)name;
715 mk->mp->attrs[mk->mp->num].mattr.attr.mode = kp->perm;
716 mk->mp->num++;
9b473de8
RR
717
718 /* Fix up all the pointers, since krealloc can move us */
18eb74fa
RR
719 for (i = 0; i < mk->mp->num; i++)
720 mk->mp->grp.attrs[i] = &mk->mp->attrs[i].mattr.attr;
721 mk->mp->grp.attrs[mk->mp->num] = NULL;
9b473de8 722 return 0;
9b473de8 723}
1da177e4 724
d2441183 725#ifdef CONFIG_MODULES
9b473de8
RR
726static void free_module_param_attrs(struct module_kobject *mk)
727{
18eb74fa
RR
728 if (mk->mp)
729 kfree(mk->mp->grp.attrs);
9b473de8
RR
730 kfree(mk->mp);
731 mk->mp = NULL;
1da177e4
LT
732}
733
1da177e4
LT
734/*
735 * module_param_sysfs_setup - setup sysfs support for one module
736 * @mod: module
737 * @kparam: module parameters (array)
738 * @num_params: number of module parameters
739 *
9b473de8
RR
740 * Adds sysfs entries for module parameters under
741 * /sys/module/[mod->name]/parameters/
1da177e4
LT
742 */
743int module_param_sysfs_setup(struct module *mod,
9bbb9e5a 744 const struct kernel_param *kparam,
1da177e4
LT
745 unsigned int num_params)
746{
9b473de8
RR
747 int i, err;
748 bool params = false;
749
750 for (i = 0; i < num_params; i++) {
751 if (kparam[i].perm == 0)
752 continue;
753 err = add_sysfs_param(&mod->mkobj, &kparam[i], kparam[i].name);
18eb74fa
RR
754 if (err) {
755 free_module_param_attrs(&mod->mkobj);
9b473de8 756 return err;
18eb74fa 757 }
9b473de8
RR
758 params = true;
759 }
1da177e4 760
9b473de8
RR
761 if (!params)
762 return 0;
1da177e4 763
9b473de8
RR
764 /* Create the param group. */
765 err = sysfs_create_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp);
766 if (err)
767 free_module_param_attrs(&mod->mkobj);
768 return err;
1da177e4
LT
769}
770
771/*
772 * module_param_sysfs_remove - remove sysfs support for one module
773 * @mod: module
774 *
775 * Remove sysfs entries for module parameters and the corresponding
776 * kobject.
777 */
778void module_param_sysfs_remove(struct module *mod)
779{
9b473de8
RR
780 if (mod->mkobj.mp) {
781 sysfs_remove_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp);
1da177e4
LT
782 /* We are positive that no one is using any param
783 * attrs at this point. Deallocate immediately. */
9b473de8 784 free_module_param_attrs(&mod->mkobj);
1da177e4
LT
785 }
786}
787#endif
788
e180a6b7
RR
789void destroy_params(const struct kernel_param *params, unsigned num)
790{
e6df34a4
RR
791 unsigned int i;
792
793 for (i = 0; i < num; i++)
794 if (params[i].ops->free)
795 params[i].ops->free(params[i].arg);
e180a6b7
RR
796}
797
e94965ed 798static struct module_kobject * __init locate_module_kobject(const char *name)
1da177e4
LT
799{
800 struct module_kobject *mk;
9b473de8
RR
801 struct kobject *kobj;
802 int err;
1da177e4 803
9b473de8
RR
804 kobj = kset_find_obj(module_kset, name);
805 if (kobj) {
9b473de8 806 mk = to_module_kobject(kobj);
9b473de8
RR
807 } else {
808 mk = kzalloc(sizeof(struct module_kobject), GFP_KERNEL);
809 BUG_ON(!mk);
810
811 mk->mod = THIS_MODULE;
812 mk->kobj.kset = module_kset;
813 err = kobject_init_and_add(&mk->kobj, &module_ktype, NULL,
814 "%s", name);
88bfa324
KS
815#ifdef CONFIG_MODULES
816 if (!err)
817 err = sysfs_create_file(&mk->kobj, &module_uevent.attr);
818#endif
9b473de8
RR
819 if (err) {
820 kobject_put(&mk->kobj);
b5f3abf9 821 pr_crit("Adding module '%s' to sysfs failed (%d), the system may be unstable.\n",
e94965ed 822 name, err);
e94965ed 823 return NULL;
9b473de8 824 }
e94965ed
DT
825
826 /* So that we hold reference in both cases. */
9b473de8 827 kobject_get(&mk->kobj);
74c5b597 828 }
9b473de8 829
e94965ed
DT
830 return mk;
831}
832
833static void __init kernel_add_sysfs_param(const char *name,
63a12d9d 834 const struct kernel_param *kparam,
e94965ed
DT
835 unsigned int name_skip)
836{
837 struct module_kobject *mk;
838 int err;
839
840 mk = locate_module_kobject(name);
841 if (!mk)
842 return;
843
844 /* We need to remove old parameters before adding more. */
845 if (mk->mp)
846 sysfs_remove_group(&mk->kobj, &mk->mp->grp);
847
9b473de8
RR
848 /* These should not fail at boot. */
849 err = add_sysfs_param(mk, kparam, kparam->name + name_skip);
850 BUG_ON(err);
851 err = sysfs_create_group(&mk->kobj, &mk->mp->grp);
852 BUG_ON(err);
f30c53a8 853 kobject_uevent(&mk->kobj, KOBJ_ADD);
9b473de8 854 kobject_put(&mk->kobj);
1da177e4
LT
855}
856
857/*
b634d130 858 * param_sysfs_builtin - add sysfs parameters for built-in modules
1da177e4
LT
859 *
860 * Add module_parameters to sysfs for "modules" built into the kernel.
861 *
862 * The "module" name (KBUILD_MODNAME) is stored before a dot, the
863 * "parameter" name is stored behind a dot in kernel_param->name. So,
864 * extract the "module" name for all built-in kernel_param-eters,
9b473de8 865 * and for all who have the same, call kernel_add_sysfs_param.
1da177e4
LT
866 */
867static void __init param_sysfs_builtin(void)
868{
63a12d9d 869 const struct kernel_param *kp;
9b473de8
RR
870 unsigned int name_len;
871 char modname[MODULE_NAME_LEN];
1da177e4 872
9b473de8 873 for (kp = __start___param; kp < __stop___param; kp++) {
1da177e4
LT
874 char *dot;
875
9b473de8
RR
876 if (kp->perm == 0)
877 continue;
1da177e4 878
730b69d2 879 dot = strchr(kp->name, '.');
1da177e4 880 if (!dot) {
67e67cea
RR
881 /* This happens for core_param() */
882 strcpy(modname, "kernel");
883 name_len = 0;
884 } else {
885 name_len = dot - kp->name + 1;
886 strlcpy(modname, kp->name, name_len);
1da177e4 887 }
67e67cea 888 kernel_add_sysfs_param(modname, kp, name_len);
1da177e4 889 }
1da177e4
LT
890}
891
e94965ed 892ssize_t __modver_version_show(struct module_attribute *mattr,
4befb026 893 struct module_kobject *mk, char *buf)
e94965ed
DT
894{
895 struct module_version_attribute *vattr =
896 container_of(mattr, struct module_version_attribute, mattr);
897
f4940ab7 898 return scnprintf(buf, PAGE_SIZE, "%s\n", vattr->version);
e94965ed
DT
899}
900
b4bc8428
DT
901extern const struct module_version_attribute *__start___modver[];
902extern const struct module_version_attribute *__stop___modver[];
e94965ed
DT
903
904static void __init version_sysfs_builtin(void)
905{
b4bc8428 906 const struct module_version_attribute **p;
e94965ed
DT
907 struct module_kobject *mk;
908 int err;
909
b4bc8428
DT
910 for (p = __start___modver; p < __stop___modver; p++) {
911 const struct module_version_attribute *vattr = *p;
912
e94965ed
DT
913 mk = locate_module_kobject(vattr->module_name);
914 if (mk) {
915 err = sysfs_create_file(&mk->kobj, &vattr->mattr.attr);
74c3dea3 916 WARN_ON_ONCE(err);
e94965ed
DT
917 kobject_uevent(&mk->kobj, KOBJ_ADD);
918 kobject_put(&mk->kobj);
919 }
920 }
921}
1da177e4
LT
922
923/* module-related sysfs stuff */
1da177e4 924
1da177e4
LT
925static ssize_t module_attr_show(struct kobject *kobj,
926 struct attribute *attr,
927 char *buf)
928{
929 struct module_attribute *attribute;
930 struct module_kobject *mk;
931 int ret;
932
933 attribute = to_module_attr(attr);
934 mk = to_module_kobject(kobj);
935
936 if (!attribute->show)
70f2817a 937 return -EIO;
1da177e4 938
4befb026 939 ret = attribute->show(attribute, mk, buf);
1da177e4 940
1da177e4
LT
941 return ret;
942}
943
944static ssize_t module_attr_store(struct kobject *kobj,
945 struct attribute *attr,
946 const char *buf, size_t len)
947{
948 struct module_attribute *attribute;
949 struct module_kobject *mk;
950 int ret;
951
952 attribute = to_module_attr(attr);
953 mk = to_module_kobject(kobj);
954
955 if (!attribute->store)
70f2817a 956 return -EIO;
1da177e4 957
4befb026 958 ret = attribute->store(attribute, mk, buf, len);
1da177e4 959
1da177e4
LT
960 return ret;
961}
962
52cf25d0 963static const struct sysfs_ops module_sysfs_ops = {
1da177e4
LT
964 .show = module_attr_show,
965 .store = module_attr_store,
966};
967
270a6c4c
KS
968static int uevent_filter(struct kset *kset, struct kobject *kobj)
969{
970 struct kobj_type *ktype = get_ktype(kobj);
971
972 if (ktype == &module_ktype)
973 return 1;
974 return 0;
975}
976
9cd43611 977static const struct kset_uevent_ops module_uevent_ops = {
270a6c4c
KS
978 .filter = uevent_filter,
979};
980
7405c1e1 981struct kset *module_kset;
823bccfc 982int module_sysfs_initialized;
1da177e4 983
942e4431
LZ
984static void module_kobj_release(struct kobject *kobj)
985{
986 struct module_kobject *mk = to_module_kobject(kobj);
987 complete(mk->kobj_completion);
988}
989
7405c1e1 990struct kobj_type module_ktype = {
942e4431 991 .release = module_kobj_release,
1da177e4
LT
992 .sysfs_ops = &module_sysfs_ops,
993};
994
1da177e4
LT
995/*
996 * param_sysfs_init - wrapper for built-in params support
997 */
998static int __init param_sysfs_init(void)
999{
7405c1e1
GKH
1000 module_kset = kset_create_and_add("module", &module_uevent_ops, NULL);
1001 if (!module_kset) {
1002 printk(KERN_WARNING "%s (%d): error creating kset\n",
1003 __FILE__, __LINE__);
1004 return -ENOMEM;
d8c7649e 1005 }
823bccfc 1006 module_sysfs_initialized = 1;
1da177e4 1007
e94965ed 1008 version_sysfs_builtin();
1da177e4
LT
1009 param_sysfs_builtin();
1010
1011 return 0;
1012}
d10be6d1 1013subsys_initcall(param_sysfs_init);
1da177e4 1014
7405c1e1 1015#endif /* CONFIG_SYSFS */