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