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