1 /* Helpers for initial module or kernel cmdline parsing
2 Copyright (C) 2001 Rusty Russell.
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.
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.
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
18 #include <linux/moduleparam.h>
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>
25 #include <linux/slab.h>
26 #include <linux/ctype.h>
31 #define DEBUGP(fmt, a...)
34 static inline char dash2underscore(char c
)
41 static inline int parameq(const char *input
, const char *paramname
)
44 for (i
= 0; dash2underscore(input
[i
]) == paramname
[i
]; i
++)
50 static int parse_one(char *param
,
52 struct kernel_param
*params
,
54 int (*handle_unknown
)(char *param
, char *val
))
59 for (i
= 0; i
< num_params
; i
++) {
60 if (parameq(param
, params
[i
].name
)) {
61 DEBUGP("They are equal! Calling %p\n",
63 return params
[i
].set(val
, ¶ms
[i
]);
68 DEBUGP("Unknown argument: calling %p\n", handle_unknown
);
69 return handle_unknown(param
, val
);
72 DEBUGP("Unknown argument `%s'\n", param
);
76 /* You can use " around spaces, but can't escape ". */
77 /* Hyphens and underscores equivalent in parameter names. */
78 static char *next_arg(char *args
, char **param
, char **val
)
80 unsigned int i
, equals
= 0;
81 int in_quote
= 0, quoted
= 0;
90 for (i
= 0; args
[i
]; i
++) {
91 if (isspace(args
[i
]) && !in_quote
)
106 *val
= args
+ equals
+ 1;
108 /* Don't include quotes in value. */
111 if (args
[i
-1] == '"')
114 if (quoted
&& args
[i
-1] == '"')
124 /* Chew up trailing spaces. */
125 while (isspace(*next
))
130 /* Args looks like "foo=bar,bar2 baz=fuz wiz". */
131 int parse_args(const char *name
,
133 struct kernel_param
*params
,
135 int (*unknown
)(char *param
, char *val
))
139 DEBUGP("Parsing ARGS: %s\n", args
);
141 /* Chew leading spaces */
142 while (isspace(*args
))
147 int irq_was_disabled
;
149 args
= next_arg(args
, ¶m
, &val
);
150 irq_was_disabled
= irqs_disabled();
151 ret
= parse_one(param
, val
, params
, num
, unknown
);
152 if (irq_was_disabled
&& !irqs_disabled()) {
153 printk(KERN_WARNING
"parse_args(): option '%s' enabled "
158 printk(KERN_ERR
"%s: Unknown parameter `%s'\n",
163 "%s: `%s' too large for parameter `%s'\n",
164 name
, val
?: "", param
);
170 "%s: `%s' invalid for parameter `%s'\n",
171 name
, val
?: "", param
);
180 /* Lazy bastard, eh? */
181 #define STANDARD_PARAM_DEF(name, type, format, tmptype, strtolfn) \
182 int param_set_##name(const char *val, struct kernel_param *kp) \
187 if (!val) return -EINVAL; \
188 ret = strtolfn(val, 0, &l); \
189 if (ret == -EINVAL || ((type)l != l)) \
191 *((type *)kp->arg) = l; \
194 int param_get_##name(char *buffer, struct kernel_param *kp) \
196 return sprintf(buffer, format, *((type *)kp->arg)); \
199 STANDARD_PARAM_DEF(byte
, unsigned char, "%c", unsigned long, strict_strtoul
);
200 STANDARD_PARAM_DEF(short, short, "%hi", long, strict_strtol
);
201 STANDARD_PARAM_DEF(ushort
, unsigned short, "%hu", unsigned long, strict_strtoul
);
202 STANDARD_PARAM_DEF(int, int, "%i", long, strict_strtol
);
203 STANDARD_PARAM_DEF(uint
, unsigned int, "%u", unsigned long, strict_strtoul
);
204 STANDARD_PARAM_DEF(long, long, "%li", long, strict_strtol
);
205 STANDARD_PARAM_DEF(ulong
, unsigned long, "%lu", unsigned long, strict_strtoul
);
207 int param_set_charp(const char *val
, struct kernel_param
*kp
)
210 printk(KERN_ERR
"%s: string parameter expected\n",
215 if (strlen(val
) > 1024) {
216 printk(KERN_ERR
"%s: string parameter too long\n",
221 /* This is a hack. We can't need to strdup in early boot, and we
222 * don't need to; this mangled commandline is preserved. */
223 if (slab_is_available()) {
224 *(char **)kp
->arg
= kstrdup(val
, GFP_KERNEL
);
225 if (!*(char **)kp
->arg
)
228 *(const char **)kp
->arg
= val
;
233 int param_get_charp(char *buffer
, struct kernel_param
*kp
)
235 return sprintf(buffer
, "%s", *((char **)kp
->arg
));
238 /* Actually could be a bool or an int, for historical reasons. */
239 int param_set_bool(const char *val
, struct kernel_param
*kp
)
243 /* No equals means "set"... */
246 /* One of =[yYnN01] */
248 case 'y': case 'Y': case '1':
251 case 'n': case 'N': case '0':
258 if (kp
->flags
& KPARAM_ISBOOL
)
259 *(bool *)kp
->arg
= v
;
265 int param_get_bool(char *buffer
, struct kernel_param
*kp
)
268 if (kp
->flags
& KPARAM_ISBOOL
)
269 val
= *(bool *)kp
->arg
;
271 val
= *(int *)kp
->arg
;
273 /* Y and N chosen as being relatively non-coder friendly */
274 return sprintf(buffer
, "%c", val
? 'Y' : 'N');
277 /* This one must be bool. */
278 int param_set_invbool(const char *val
, struct kernel_param
*kp
)
282 struct kernel_param dummy
;
284 dummy
.arg
= &boolval
;
285 dummy
.flags
= KPARAM_ISBOOL
;
286 ret
= param_set_bool(val
, &dummy
);
288 *(bool *)kp
->arg
= !boolval
;
292 int param_get_invbool(char *buffer
, struct kernel_param
*kp
)
294 return sprintf(buffer
, "%c", (*(bool *)kp
->arg
) ? 'N' : 'Y');
297 /* We break the rule and mangle the string. */
298 static int param_array(const char *name
,
300 unsigned int min
, unsigned int max
,
301 void *elem
, int elemsize
,
302 int (*set
)(const char *, struct kernel_param
*kp
),
307 struct kernel_param kp
;
310 /* Get the name right for errors. */
315 /* No equals sign? */
317 printk(KERN_ERR
"%s: expects arguments\n", name
);
322 /* We expect a comma-separated list of values. */
327 printk(KERN_ERR
"%s: can only take %i arguments\n",
331 len
= strcspn(val
, ",");
333 /* nul-terminate and parse */
335 ((char *)val
)[len
] = '\0';
343 } while (save
== ',');
346 printk(KERN_ERR
"%s: needs at least %i arguments\n",
353 int param_array_set(const char *val
, struct kernel_param
*kp
)
355 const struct kparam_array
*arr
= kp
->arr
;
356 unsigned int temp_num
;
358 return param_array(kp
->name
, val
, 1, arr
->max
, arr
->elem
,
359 arr
->elemsize
, arr
->set
, kp
->flags
,
360 arr
->num
?: &temp_num
);
363 int param_array_get(char *buffer
, struct kernel_param
*kp
)
366 const struct kparam_array
*arr
= kp
->arr
;
367 struct kernel_param p
;
370 for (i
= off
= 0; i
< (arr
->num
? *arr
->num
: arr
->max
); i
++) {
373 p
.arg
= arr
->elem
+ arr
->elemsize
* i
;
374 ret
= arr
->get(buffer
+ off
, &p
);
383 int param_set_copystring(const char *val
, struct kernel_param
*kp
)
385 const struct kparam_string
*kps
= kp
->str
;
388 printk(KERN_ERR
"%s: missing param set value\n", kp
->name
);
391 if (strlen(val
)+1 > kps
->maxlen
) {
392 printk(KERN_ERR
"%s: string doesn't fit in %u chars.\n",
393 kp
->name
, kps
->maxlen
-1);
396 strcpy(kps
->string
, val
);
400 int param_get_string(char *buffer
, struct kernel_param
*kp
)
402 const struct kparam_string
*kps
= kp
->str
;
403 return strlcpy(buffer
, kps
->string
, kps
->maxlen
);
406 /* sysfs output in /sys/modules/XYZ/parameters/ */
407 #define to_module_attr(n) container_of(n, struct module_attribute, attr);
408 #define to_module_kobject(n) container_of(n, struct module_kobject, kobj);
410 extern struct kernel_param __start___param
[], __stop___param
[];
412 struct param_attribute
414 struct module_attribute mattr
;
415 struct kernel_param
*param
;
418 struct module_param_attrs
421 struct attribute_group grp
;
422 struct param_attribute attrs
[0];
426 #define to_param_attr(n) container_of(n, struct param_attribute, mattr);
428 static ssize_t
param_attr_show(struct module_attribute
*mattr
,
429 struct module
*mod
, char *buf
)
432 struct param_attribute
*attribute
= to_param_attr(mattr
);
434 if (!attribute
->param
->get
)
437 count
= attribute
->param
->get(buf
, attribute
->param
);
445 /* sysfs always hands a nul-terminated string in buf. We rely on that. */
446 static ssize_t
param_attr_store(struct module_attribute
*mattr
,
447 struct module
*owner
,
448 const char *buf
, size_t len
)
451 struct param_attribute
*attribute
= to_param_attr(mattr
);
453 if (!attribute
->param
->set
)
456 err
= attribute
->param
->set(buf
, attribute
->param
);
463 #ifdef CONFIG_MODULES
466 #define __modinit __init
471 * add_sysfs_param - add a parameter to sysfs
472 * @mk: struct module_kobject
473 * @kparam: the actual parameter definition to add to sysfs
474 * @name: name of parameter
476 * Create a kobject if for a (per-module) parameter if mp NULL, and
477 * create file in sysfs. Returns an error on out of memory. Always cleans up
478 * if there's an error.
480 static __modinit
int add_sysfs_param(struct module_kobject
*mk
,
481 struct kernel_param
*kp
,
484 struct module_param_attrs
*new;
485 struct attribute
**attrs
;
488 /* We don't bother calling this with invisible parameters. */
496 attrs
= mk
->mp
->grp
.attrs
;
500 new = krealloc(mk
->mp
,
501 sizeof(*mk
->mp
) + sizeof(mk
->mp
->attrs
[0]) * (num
+1),
508 attrs
= krealloc(attrs
, sizeof(new->grp
.attrs
[0])*(num
+2), GFP_KERNEL
);
514 /* Sysfs wants everything zeroed. */
515 memset(new, 0, sizeof(*new));
516 memset(&new->attrs
[num
], 0, sizeof(new->attrs
[num
]));
517 memset(&attrs
[num
], 0, sizeof(attrs
[num
]));
518 new->grp
.name
= "parameters";
519 new->grp
.attrs
= attrs
;
521 /* Tack new one on the end. */
522 new->attrs
[num
].param
= kp
;
523 new->attrs
[num
].mattr
.show
= param_attr_show
;
524 new->attrs
[num
].mattr
.store
= param_attr_store
;
525 new->attrs
[num
].mattr
.attr
.name
= (char *)name
;
526 new->attrs
[num
].mattr
.attr
.mode
= kp
->perm
;
529 /* Fix up all the pointers, since krealloc can move us */
530 for (num
= 0; num
< new->num
; num
++)
531 new->grp
.attrs
[num
] = &new->attrs
[num
].mattr
.attr
;
532 new->grp
.attrs
[num
] = NULL
;
544 #ifdef CONFIG_MODULES
545 static void free_module_param_attrs(struct module_kobject
*mk
)
547 kfree(mk
->mp
->grp
.attrs
);
553 * module_param_sysfs_setup - setup sysfs support for one module
555 * @kparam: module parameters (array)
556 * @num_params: number of module parameters
558 * Adds sysfs entries for module parameters under
559 * /sys/module/[mod->name]/parameters/
561 int module_param_sysfs_setup(struct module
*mod
,
562 struct kernel_param
*kparam
,
563 unsigned int num_params
)
568 for (i
= 0; i
< num_params
; i
++) {
569 if (kparam
[i
].perm
== 0)
571 err
= add_sysfs_param(&mod
->mkobj
, &kparam
[i
], kparam
[i
].name
);
580 /* Create the param group. */
581 err
= sysfs_create_group(&mod
->mkobj
.kobj
, &mod
->mkobj
.mp
->grp
);
583 free_module_param_attrs(&mod
->mkobj
);
588 * module_param_sysfs_remove - remove sysfs support for one module
591 * Remove sysfs entries for module parameters and the corresponding
594 void module_param_sysfs_remove(struct module
*mod
)
597 sysfs_remove_group(&mod
->mkobj
.kobj
, &mod
->mkobj
.mp
->grp
);
598 /* We are positive that no one is using any param
599 * attrs at this point. Deallocate immediately. */
600 free_module_param_attrs(&mod
->mkobj
);
605 void destroy_params(const struct kernel_param
*params
, unsigned num
)
607 /* FIXME: This should free kmalloced charp parameters. It doesn't. */
610 static void __init
kernel_add_sysfs_param(const char *name
,
611 struct kernel_param
*kparam
,
612 unsigned int name_skip
)
614 struct module_kobject
*mk
;
615 struct kobject
*kobj
;
618 kobj
= kset_find_obj(module_kset
, name
);
620 /* We already have one. Remove params so we can add more. */
621 mk
= to_module_kobject(kobj
);
622 /* We need to remove it before adding parameters. */
623 sysfs_remove_group(&mk
->kobj
, &mk
->mp
->grp
);
625 mk
= kzalloc(sizeof(struct module_kobject
), GFP_KERNEL
);
628 mk
->mod
= THIS_MODULE
;
629 mk
->kobj
.kset
= module_kset
;
630 err
= kobject_init_and_add(&mk
->kobj
, &module_ktype
, NULL
,
633 kobject_put(&mk
->kobj
);
634 printk(KERN_ERR
"Module '%s' failed add to sysfs, "
635 "error number %d\n", name
, err
);
636 printk(KERN_ERR
"The system will be unstable now.\n");
639 /* So that exit path is even. */
640 kobject_get(&mk
->kobj
);
643 /* These should not fail at boot. */
644 err
= add_sysfs_param(mk
, kparam
, kparam
->name
+ name_skip
);
646 err
= sysfs_create_group(&mk
->kobj
, &mk
->mp
->grp
);
648 kobject_uevent(&mk
->kobj
, KOBJ_ADD
);
649 kobject_put(&mk
->kobj
);
653 * param_sysfs_builtin - add contents in /sys/parameters for built-in modules
655 * Add module_parameters to sysfs for "modules" built into the kernel.
657 * The "module" name (KBUILD_MODNAME) is stored before a dot, the
658 * "parameter" name is stored behind a dot in kernel_param->name. So,
659 * extract the "module" name for all built-in kernel_param-eters,
660 * and for all who have the same, call kernel_add_sysfs_param.
662 static void __init
param_sysfs_builtin(void)
664 struct kernel_param
*kp
;
665 unsigned int name_len
;
666 char modname
[MODULE_NAME_LEN
];
668 for (kp
= __start___param
; kp
< __stop___param
; kp
++) {
674 dot
= strchr(kp
->name
, '.');
676 /* This happens for core_param() */
677 strcpy(modname
, "kernel");
680 name_len
= dot
- kp
->name
+ 1;
681 strlcpy(modname
, kp
->name
, name_len
);
683 kernel_add_sysfs_param(modname
, kp
, name_len
);
688 /* module-related sysfs stuff */
690 static ssize_t
module_attr_show(struct kobject
*kobj
,
691 struct attribute
*attr
,
694 struct module_attribute
*attribute
;
695 struct module_kobject
*mk
;
698 attribute
= to_module_attr(attr
);
699 mk
= to_module_kobject(kobj
);
701 if (!attribute
->show
)
704 ret
= attribute
->show(attribute
, mk
->mod
, buf
);
709 static ssize_t
module_attr_store(struct kobject
*kobj
,
710 struct attribute
*attr
,
711 const char *buf
, size_t len
)
713 struct module_attribute
*attribute
;
714 struct module_kobject
*mk
;
717 attribute
= to_module_attr(attr
);
718 mk
= to_module_kobject(kobj
);
720 if (!attribute
->store
)
723 ret
= attribute
->store(attribute
, mk
->mod
, buf
, len
);
728 static struct sysfs_ops module_sysfs_ops
= {
729 .show
= module_attr_show
,
730 .store
= module_attr_store
,
733 static int uevent_filter(struct kset
*kset
, struct kobject
*kobj
)
735 struct kobj_type
*ktype
= get_ktype(kobj
);
737 if (ktype
== &module_ktype
)
742 static struct kset_uevent_ops module_uevent_ops
= {
743 .filter
= uevent_filter
,
746 struct kset
*module_kset
;
747 int module_sysfs_initialized
;
749 struct kobj_type module_ktype
= {
750 .sysfs_ops
= &module_sysfs_ops
,
754 * param_sysfs_init - wrapper for built-in params support
756 static int __init
param_sysfs_init(void)
758 module_kset
= kset_create_and_add("module", &module_uevent_ops
, NULL
);
760 printk(KERN_WARNING
"%s (%d): error creating kset\n",
764 module_sysfs_initialized
= 1;
766 param_sysfs_builtin();
770 subsys_initcall(param_sysfs_init
);
772 #endif /* CONFIG_SYSFS */
774 EXPORT_SYMBOL(param_set_byte
);
775 EXPORT_SYMBOL(param_get_byte
);
776 EXPORT_SYMBOL(param_set_short
);
777 EXPORT_SYMBOL(param_get_short
);
778 EXPORT_SYMBOL(param_set_ushort
);
779 EXPORT_SYMBOL(param_get_ushort
);
780 EXPORT_SYMBOL(param_set_int
);
781 EXPORT_SYMBOL(param_get_int
);
782 EXPORT_SYMBOL(param_set_uint
);
783 EXPORT_SYMBOL(param_get_uint
);
784 EXPORT_SYMBOL(param_set_long
);
785 EXPORT_SYMBOL(param_get_long
);
786 EXPORT_SYMBOL(param_set_ulong
);
787 EXPORT_SYMBOL(param_get_ulong
);
788 EXPORT_SYMBOL(param_set_charp
);
789 EXPORT_SYMBOL(param_get_charp
);
790 EXPORT_SYMBOL(param_set_bool
);
791 EXPORT_SYMBOL(param_get_bool
);
792 EXPORT_SYMBOL(param_set_invbool
);
793 EXPORT_SYMBOL(param_get_invbool
);
794 EXPORT_SYMBOL(param_array_set
);
795 EXPORT_SYMBOL(param_array_get
);
796 EXPORT_SYMBOL(param_set_copystring
);
797 EXPORT_SYMBOL(param_get_string
);