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