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