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>
30 #define DEBUGP(fmt, a...)
33 static inline char dash2underscore(char c
)
40 static inline int parameq(const char *input
, const char *paramname
)
43 for (i
= 0; dash2underscore(input
[i
]) == paramname
[i
]; i
++)
49 static int parse_one(char *param
,
51 struct kernel_param
*params
,
53 int (*handle_unknown
)(char *param
, char *val
))
58 for (i
= 0; i
< num_params
; i
++) {
59 if (parameq(param
, params
[i
].name
)) {
60 DEBUGP("They are equal! Calling %p\n",
62 return params
[i
].set(val
, ¶ms
[i
]);
67 DEBUGP("Unknown argument: calling %p\n", handle_unknown
);
68 return handle_unknown(param
, val
);
71 DEBUGP("Unknown argument `%s'\n", param
);
75 /* You can use " around spaces, but can't escape ". */
76 /* Hyphens and underscores equivalent in parameter names. */
77 static char *next_arg(char *args
, char **param
, char **val
)
79 unsigned int i
, equals
= 0;
80 int in_quote
= 0, quoted
= 0;
89 for (i
= 0; args
[i
]; i
++) {
90 if (args
[i
] == ' ' && !in_quote
)
105 *val
= args
+ equals
+ 1;
107 /* Don't include quotes in value. */
110 if (args
[i
-1] == '"')
113 if (quoted
&& args
[i
-1] == '"')
123 /* Chew up trailing spaces. */
129 /* Args looks like "foo=bar,bar2 baz=fuz wiz". */
130 int parse_args(const char *name
,
132 struct kernel_param
*params
,
134 int (*unknown
)(char *param
, char *val
))
138 DEBUGP("Parsing ARGS: %s\n", args
);
140 /* Chew leading spaces */
146 int irq_was_disabled
;
148 args
= next_arg(args
, ¶m
, &val
);
149 irq_was_disabled
= irqs_disabled();
150 ret
= parse_one(param
, val
, params
, num
, unknown
);
151 if (irq_was_disabled
&& !irqs_disabled()) {
152 printk(KERN_WARNING
"parse_args(): option '%s' enabled "
157 printk(KERN_ERR
"%s: Unknown parameter `%s'\n",
162 "%s: `%s' too large for parameter `%s'\n",
163 name
, val
?: "", param
);
169 "%s: `%s' invalid for parameter `%s'\n",
170 name
, val
?: "", param
);
179 /* Lazy bastard, eh? */
180 #define STANDARD_PARAM_DEF(name, type, format, tmptype, strtolfn) \
181 int param_set_##name(const char *val, struct kernel_param *kp) \
186 if (!val) return -EINVAL; \
187 ret = strtolfn(val, 0, &l); \
188 if (ret == -EINVAL || ((type)l != l)) \
190 *((type *)kp->arg) = l; \
193 int param_get_##name(char *buffer, struct kernel_param *kp) \
195 return sprintf(buffer, format, *((type *)kp->arg)); \
198 STANDARD_PARAM_DEF(byte
, unsigned char, "%c", unsigned long, strict_strtoul
);
199 STANDARD_PARAM_DEF(short, short, "%hi", long, strict_strtol
);
200 STANDARD_PARAM_DEF(ushort
, unsigned short, "%hu", unsigned long, strict_strtoul
);
201 STANDARD_PARAM_DEF(int, int, "%i", long, strict_strtol
);
202 STANDARD_PARAM_DEF(uint
, unsigned int, "%u", unsigned long, strict_strtoul
);
203 STANDARD_PARAM_DEF(long, long, "%li", long, strict_strtol
);
204 STANDARD_PARAM_DEF(ulong
, unsigned long, "%lu", unsigned long, strict_strtoul
);
206 int param_set_charp(const char *val
, struct kernel_param
*kp
)
209 printk(KERN_ERR
"%s: string parameter expected\n",
214 if (strlen(val
) > 1024) {
215 printk(KERN_ERR
"%s: string parameter too long\n",
220 /* This is a hack. We can't need to strdup in early boot, and we
221 * don't need to; this mangled commandline is preserved. */
222 if (slab_is_available()) {
223 *(char **)kp
->arg
= kstrdup(val
, GFP_KERNEL
);
224 if (!*(char **)kp
->arg
)
227 *(const char **)kp
->arg
= val
;
232 int param_get_charp(char *buffer
, struct kernel_param
*kp
)
234 return sprintf(buffer
, "%s", *((char **)kp
->arg
));
237 /* Actually could be a bool or an int, for historical reasons. */
238 int param_set_bool(const char *val
, struct kernel_param
*kp
)
242 /* No equals means "set"... */
245 /* One of =[yYnN01] */
247 case 'y': case 'Y': case '1':
250 case 'n': case 'N': case '0':
257 if (kp
->flags
& KPARAM_ISBOOL
)
258 *(bool *)kp
->arg
= v
;
264 int param_get_bool(char *buffer
, struct kernel_param
*kp
)
267 if (kp
->flags
& KPARAM_ISBOOL
)
268 val
= *(bool *)kp
->arg
;
270 val
= *(int *)kp
->arg
;
272 /* Y and N chosen as being relatively non-coder friendly */
273 return sprintf(buffer
, "%c", val
? 'Y' : 'N');
276 /* This one must be bool. */
277 int param_set_invbool(const char *val
, struct kernel_param
*kp
)
281 struct kernel_param dummy
;
283 dummy
.arg
= &boolval
;
284 dummy
.flags
= KPARAM_ISBOOL
;
285 ret
= param_set_bool(val
, &dummy
);
287 *(bool *)kp
->arg
= !boolval
;
291 int param_get_invbool(char *buffer
, struct kernel_param
*kp
)
293 return sprintf(buffer
, "%c", (*(bool *)kp
->arg
) ? 'N' : 'Y');
296 /* We break the rule and mangle the string. */
297 static int param_array(const char *name
,
299 unsigned int min
, unsigned int max
,
300 void *elem
, int elemsize
,
301 int (*set
)(const char *, struct kernel_param
*kp
),
306 struct kernel_param kp
;
309 /* Get the name right for errors. */
314 /* No equals sign? */
316 printk(KERN_ERR
"%s: expects arguments\n", name
);
321 /* We expect a comma-separated list of values. */
326 printk(KERN_ERR
"%s: can only take %i arguments\n",
330 len
= strcspn(val
, ",");
332 /* nul-terminate and parse */
334 ((char *)val
)[len
] = '\0';
342 } while (save
== ',');
345 printk(KERN_ERR
"%s: needs at least %i arguments\n",
352 int param_array_set(const char *val
, struct kernel_param
*kp
)
354 const struct kparam_array
*arr
= kp
->arr
;
355 unsigned int temp_num
;
357 return param_array(kp
->name
, val
, 1, arr
->max
, arr
->elem
,
358 arr
->elemsize
, arr
->set
, kp
->flags
,
359 arr
->num
?: &temp_num
);
362 int param_array_get(char *buffer
, struct kernel_param
*kp
)
365 const struct kparam_array
*arr
= kp
->arr
;
366 struct kernel_param p
;
369 for (i
= off
= 0; i
< (arr
->num
? *arr
->num
: arr
->max
); i
++) {
372 p
.arg
= arr
->elem
+ arr
->elemsize
* i
;
373 ret
= arr
->get(buffer
+ off
, &p
);
382 int param_set_copystring(const char *val
, struct kernel_param
*kp
)
384 const struct kparam_string
*kps
= kp
->str
;
387 printk(KERN_ERR
"%s: missing param set value\n", kp
->name
);
390 if (strlen(val
)+1 > kps
->maxlen
) {
391 printk(KERN_ERR
"%s: string doesn't fit in %u chars.\n",
392 kp
->name
, kps
->maxlen
-1);
395 strcpy(kps
->string
, val
);
399 int param_get_string(char *buffer
, struct kernel_param
*kp
)
401 const struct kparam_string
*kps
= kp
->str
;
402 return strlcpy(buffer
, kps
->string
, kps
->maxlen
);
405 /* sysfs output in /sys/modules/XYZ/parameters/ */
406 #define to_module_attr(n) container_of(n, struct module_attribute, attr);
407 #define to_module_kobject(n) container_of(n, struct module_kobject, kobj);
409 extern struct kernel_param __start___param
[], __stop___param
[];
411 struct param_attribute
413 struct module_attribute mattr
;
414 struct kernel_param
*param
;
417 struct module_param_attrs
420 struct attribute_group grp
;
421 struct param_attribute attrs
[0];
425 #define to_param_attr(n) container_of(n, struct param_attribute, mattr);
427 static ssize_t
param_attr_show(struct module_attribute
*mattr
,
428 struct module
*mod
, char *buf
)
431 struct param_attribute
*attribute
= to_param_attr(mattr
);
433 if (!attribute
->param
->get
)
436 count
= attribute
->param
->get(buf
, attribute
->param
);
444 /* sysfs always hands a nul-terminated string in buf. We rely on that. */
445 static ssize_t
param_attr_store(struct module_attribute
*mattr
,
446 struct module
*owner
,
447 const char *buf
, size_t len
)
450 struct param_attribute
*attribute
= to_param_attr(mattr
);
452 if (!attribute
->param
->set
)
455 err
= attribute
->param
->set(buf
, attribute
->param
);
462 #ifdef CONFIG_MODULES
465 #define __modinit __init
470 * add_sysfs_param - add a parameter to sysfs
471 * @mk: struct module_kobject
472 * @kparam: the actual parameter definition to add to sysfs
473 * @name: name of parameter
475 * Create a kobject if for a (per-module) parameter if mp NULL, and
476 * create file in sysfs. Returns an error on out of memory. Always cleans up
477 * if there's an error.
479 static __modinit
int add_sysfs_param(struct module_kobject
*mk
,
480 struct kernel_param
*kp
,
483 struct module_param_attrs
*new;
484 struct attribute
**attrs
;
487 /* We don't bother calling this with invisible parameters. */
495 attrs
= mk
->mp
->grp
.attrs
;
499 new = krealloc(mk
->mp
,
500 sizeof(*mk
->mp
) + sizeof(mk
->mp
->attrs
[0]) * (num
+1),
507 attrs
= krealloc(attrs
, sizeof(new->grp
.attrs
[0])*(num
+2), GFP_KERNEL
);
513 /* Sysfs wants everything zeroed. */
514 memset(new, 0, sizeof(*new));
515 memset(&new->attrs
[num
], 0, sizeof(new->attrs
[num
]));
516 memset(&attrs
[num
], 0, sizeof(attrs
[num
]));
517 new->grp
.name
= "parameters";
518 new->grp
.attrs
= attrs
;
520 /* Tack new one on the end. */
521 new->attrs
[num
].param
= kp
;
522 new->attrs
[num
].mattr
.show
= param_attr_show
;
523 new->attrs
[num
].mattr
.store
= param_attr_store
;
524 new->attrs
[num
].mattr
.attr
.name
= (char *)name
;
525 new->attrs
[num
].mattr
.attr
.mode
= kp
->perm
;
528 /* Fix up all the pointers, since krealloc can move us */
529 for (num
= 0; num
< new->num
; num
++)
530 new->grp
.attrs
[num
] = &new->attrs
[num
].mattr
.attr
;
531 new->grp
.attrs
[num
] = NULL
;
543 #ifdef CONFIG_MODULES
544 static void free_module_param_attrs(struct module_kobject
*mk
)
546 kfree(mk
->mp
->grp
.attrs
);
552 * module_param_sysfs_setup - setup sysfs support for one module
554 * @kparam: module parameters (array)
555 * @num_params: number of module parameters
557 * Adds sysfs entries for module parameters under
558 * /sys/module/[mod->name]/parameters/
560 int module_param_sysfs_setup(struct module
*mod
,
561 struct kernel_param
*kparam
,
562 unsigned int num_params
)
567 for (i
= 0; i
< num_params
; i
++) {
568 if (kparam
[i
].perm
== 0)
570 err
= add_sysfs_param(&mod
->mkobj
, &kparam
[i
], kparam
[i
].name
);
579 /* Create the param group. */
580 err
= sysfs_create_group(&mod
->mkobj
.kobj
, &mod
->mkobj
.mp
->grp
);
582 free_module_param_attrs(&mod
->mkobj
);
587 * module_param_sysfs_remove - remove sysfs support for one module
590 * Remove sysfs entries for module parameters and the corresponding
593 void module_param_sysfs_remove(struct module
*mod
)
596 sysfs_remove_group(&mod
->mkobj
.kobj
, &mod
->mkobj
.mp
->grp
);
597 /* We are positive that no one is using any param
598 * attrs at this point. Deallocate immediately. */
599 free_module_param_attrs(&mod
->mkobj
);
604 void destroy_params(const struct kernel_param
*params
, unsigned num
)
606 /* FIXME: This should free kmalloced charp parameters. It doesn't. */
609 static void __init
kernel_add_sysfs_param(const char *name
,
610 struct kernel_param
*kparam
,
611 unsigned int name_skip
)
613 struct module_kobject
*mk
;
614 struct kobject
*kobj
;
617 kobj
= kset_find_obj(module_kset
, name
);
619 /* We already have one. Remove params so we can add more. */
620 mk
= to_module_kobject(kobj
);
621 /* We need to remove it before adding parameters. */
622 sysfs_remove_group(&mk
->kobj
, &mk
->mp
->grp
);
624 mk
= kzalloc(sizeof(struct module_kobject
), GFP_KERNEL
);
627 mk
->mod
= THIS_MODULE
;
628 mk
->kobj
.kset
= module_kset
;
629 err
= kobject_init_and_add(&mk
->kobj
, &module_ktype
, NULL
,
632 kobject_put(&mk
->kobj
);
633 printk(KERN_ERR
"Module '%s' failed add to sysfs, "
634 "error number %d\n", name
, err
);
635 printk(KERN_ERR
"The system will be unstable now.\n");
638 /* So that exit path is even. */
639 kobject_get(&mk
->kobj
);
642 /* These should not fail at boot. */
643 err
= add_sysfs_param(mk
, kparam
, kparam
->name
+ name_skip
);
645 err
= sysfs_create_group(&mk
->kobj
, &mk
->mp
->grp
);
647 kobject_uevent(&mk
->kobj
, KOBJ_ADD
);
648 kobject_put(&mk
->kobj
);
652 * param_sysfs_builtin - add contents in /sys/parameters for built-in modules
654 * Add module_parameters to sysfs for "modules" built into the kernel.
656 * The "module" name (KBUILD_MODNAME) is stored before a dot, the
657 * "parameter" name is stored behind a dot in kernel_param->name. So,
658 * extract the "module" name for all built-in kernel_param-eters,
659 * and for all who have the same, call kernel_add_sysfs_param.
661 static void __init
param_sysfs_builtin(void)
663 struct kernel_param
*kp
;
664 unsigned int name_len
;
665 char modname
[MODULE_NAME_LEN
];
667 for (kp
= __start___param
; kp
< __stop___param
; kp
++) {
673 dot
= strchr(kp
->name
, '.');
675 /* This happens for core_param() */
676 strcpy(modname
, "kernel");
679 name_len
= dot
- kp
->name
+ 1;
680 strlcpy(modname
, kp
->name
, name_len
);
682 kernel_add_sysfs_param(modname
, kp
, name_len
);
687 /* module-related sysfs stuff */
689 static ssize_t
module_attr_show(struct kobject
*kobj
,
690 struct attribute
*attr
,
693 struct module_attribute
*attribute
;
694 struct module_kobject
*mk
;
697 attribute
= to_module_attr(attr
);
698 mk
= to_module_kobject(kobj
);
700 if (!attribute
->show
)
703 ret
= attribute
->show(attribute
, mk
->mod
, buf
);
708 static ssize_t
module_attr_store(struct kobject
*kobj
,
709 struct attribute
*attr
,
710 const char *buf
, size_t len
)
712 struct module_attribute
*attribute
;
713 struct module_kobject
*mk
;
716 attribute
= to_module_attr(attr
);
717 mk
= to_module_kobject(kobj
);
719 if (!attribute
->store
)
722 ret
= attribute
->store(attribute
, mk
->mod
, buf
, len
);
727 static struct sysfs_ops module_sysfs_ops
= {
728 .show
= module_attr_show
,
729 .store
= module_attr_store
,
732 static int uevent_filter(struct kset
*kset
, struct kobject
*kobj
)
734 struct kobj_type
*ktype
= get_ktype(kobj
);
736 if (ktype
== &module_ktype
)
741 static struct kset_uevent_ops module_uevent_ops
= {
742 .filter
= uevent_filter
,
745 struct kset
*module_kset
;
746 int module_sysfs_initialized
;
748 struct kobj_type module_ktype
= {
749 .sysfs_ops
= &module_sysfs_ops
,
753 * param_sysfs_init - wrapper for built-in params support
755 static int __init
param_sysfs_init(void)
757 module_kset
= kset_create_and_add("module", &module_uevent_ops
, NULL
);
759 printk(KERN_WARNING
"%s (%d): error creating kset\n",
763 module_sysfs_initialized
= 1;
765 param_sysfs_builtin();
769 subsys_initcall(param_sysfs_init
);
771 #endif /* CONFIG_SYSFS */
773 EXPORT_SYMBOL(param_set_byte
);
774 EXPORT_SYMBOL(param_get_byte
);
775 EXPORT_SYMBOL(param_set_short
);
776 EXPORT_SYMBOL(param_get_short
);
777 EXPORT_SYMBOL(param_set_ushort
);
778 EXPORT_SYMBOL(param_get_ushort
);
779 EXPORT_SYMBOL(param_set_int
);
780 EXPORT_SYMBOL(param_get_int
);
781 EXPORT_SYMBOL(param_set_uint
);
782 EXPORT_SYMBOL(param_get_uint
);
783 EXPORT_SYMBOL(param_set_long
);
784 EXPORT_SYMBOL(param_get_long
);
785 EXPORT_SYMBOL(param_set_ulong
);
786 EXPORT_SYMBOL(param_get_ulong
);
787 EXPORT_SYMBOL(param_set_charp
);
788 EXPORT_SYMBOL(param_get_charp
);
789 EXPORT_SYMBOL(param_set_bool
);
790 EXPORT_SYMBOL(param_get_bool
);
791 EXPORT_SYMBOL(param_set_invbool
);
792 EXPORT_SYMBOL(param_get_invbool
);
793 EXPORT_SYMBOL(param_array_set
);
794 EXPORT_SYMBOL(param_array_get
);
795 EXPORT_SYMBOL(param_set_copystring
);
796 EXPORT_SYMBOL(param_get_string
);