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/module.h>
19 #include <linux/kernel.h>
20 #include <linux/string.h>
21 #include <linux/errno.h>
22 #include <linux/export.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 /* Protects all parameters, and incidentally kmalloced_param list. */
35 static DEFINE_MUTEX(param_lock
);
37 /* This just allows us to keep track of which parameters are kmalloced. */
38 struct kmalloced_param
{
39 struct list_head list
;
42 static LIST_HEAD(kmalloced_params
);
44 static void *kmalloc_parameter(unsigned int size
)
46 struct kmalloced_param
*p
;
48 p
= kmalloc(sizeof(*p
) + size
, GFP_KERNEL
);
52 list_add(&p
->list
, &kmalloced_params
);
56 /* Does nothing if parameter wasn't kmalloced above. */
57 static void maybe_kfree_parameter(void *param
)
59 struct kmalloced_param
*p
;
61 list_for_each_entry(p
, &kmalloced_params
, list
) {
62 if (p
->val
== param
) {
70 static inline char dash2underscore(char c
)
77 static inline int parameq(const char *input
, const char *paramname
)
80 for (i
= 0; dash2underscore(input
[i
]) == paramname
[i
]; i
++)
86 static int parse_one(char *param
,
88 const struct kernel_param
*params
,
90 int (*handle_unknown
)(char *param
, char *val
))
96 for (i
= 0; i
< num_params
; i
++) {
97 if (parameq(param
, params
[i
].name
)) {
98 /* No one handled NULL, so do it here. */
99 if (!val
&& params
[i
].ops
->set
!= param_set_bool
)
101 DEBUGP("They are equal! Calling %p\n",
103 mutex_lock(¶m_lock
);
104 err
= params
[i
].ops
->set(val
, ¶ms
[i
]);
105 mutex_unlock(¶m_lock
);
110 if (handle_unknown
) {
111 DEBUGP("Unknown argument: calling %p\n", handle_unknown
);
112 return handle_unknown(param
, val
);
115 DEBUGP("Unknown argument `%s'\n", param
);
119 /* You can use " around spaces, but can't escape ". */
120 /* Hyphens and underscores equivalent in parameter names. */
121 static char *next_arg(char *args
, char **param
, char **val
)
123 unsigned int i
, equals
= 0;
124 int in_quote
= 0, quoted
= 0;
133 for (i
= 0; args
[i
]; i
++) {
134 if (isspace(args
[i
]) && !in_quote
)
141 in_quote
= !in_quote
;
149 *val
= args
+ equals
+ 1;
151 /* Don't include quotes in value. */
154 if (args
[i
-1] == '"')
157 if (quoted
&& args
[i
-1] == '"')
167 /* Chew up trailing spaces. */
168 return skip_spaces(next
);
171 /* Args looks like "foo=bar,bar2 baz=fuz wiz". */
172 int parse_args(const char *name
,
174 const struct kernel_param
*params
,
176 int (*unknown
)(char *param
, char *val
))
180 DEBUGP("Parsing ARGS: %s\n", args
);
182 /* Chew leading spaces */
183 args
= skip_spaces(args
);
187 int irq_was_disabled
;
189 args
= next_arg(args
, ¶m
, &val
);
190 irq_was_disabled
= irqs_disabled();
191 ret
= parse_one(param
, val
, params
, num
, unknown
);
192 if (irq_was_disabled
&& !irqs_disabled()) {
193 printk(KERN_WARNING
"parse_args(): option '%s' enabled "
198 printk(KERN_ERR
"%s: Unknown parameter `%s'\n",
203 "%s: `%s' too large for parameter `%s'\n",
204 name
, val
?: "", param
);
210 "%s: `%s' invalid for parameter `%s'\n",
211 name
, val
?: "", param
);
220 /* Lazy bastard, eh? */
221 #define STANDARD_PARAM_DEF(name, type, format, tmptype, strtolfn) \
222 int param_set_##name(const char *val, const struct kernel_param *kp) \
227 ret = strtolfn(val, 0, &l); \
228 if (ret < 0 || ((type)l != l)) \
229 return ret < 0 ? ret : -EINVAL; \
230 *((type *)kp->arg) = l; \
233 int param_get_##name(char *buffer, const struct kernel_param *kp) \
235 return sprintf(buffer, format, *((type *)kp->arg)); \
237 struct kernel_param_ops param_ops_##name = { \
238 .set = param_set_##name, \
239 .get = param_get_##name, \
241 EXPORT_SYMBOL(param_set_##name); \
242 EXPORT_SYMBOL(param_get_##name); \
243 EXPORT_SYMBOL(param_ops_##name)
246 STANDARD_PARAM_DEF(byte
, unsigned char, "%c", unsigned long, strict_strtoul
);
247 STANDARD_PARAM_DEF(short, short, "%hi", long, strict_strtol
);
248 STANDARD_PARAM_DEF(ushort
, unsigned short, "%hu", unsigned long, strict_strtoul
);
249 STANDARD_PARAM_DEF(int, int, "%i", long, strict_strtol
);
250 STANDARD_PARAM_DEF(uint
, unsigned int, "%u", unsigned long, strict_strtoul
);
251 STANDARD_PARAM_DEF(long, long, "%li", long, strict_strtol
);
252 STANDARD_PARAM_DEF(ulong
, unsigned long, "%lu", unsigned long, strict_strtoul
);
254 int param_set_charp(const char *val
, const struct kernel_param
*kp
)
256 if (strlen(val
) > 1024) {
257 printk(KERN_ERR
"%s: string parameter too long\n",
262 maybe_kfree_parameter(*(char **)kp
->arg
);
264 /* This is a hack. We can't kmalloc in early boot, and we
265 * don't need to; this mangled commandline is preserved. */
266 if (slab_is_available()) {
267 *(char **)kp
->arg
= kmalloc_parameter(strlen(val
)+1);
268 if (!*(char **)kp
->arg
)
270 strcpy(*(char **)kp
->arg
, val
);
272 *(const char **)kp
->arg
= val
;
276 EXPORT_SYMBOL(param_set_charp
);
278 int param_get_charp(char *buffer
, const struct kernel_param
*kp
)
280 return sprintf(buffer
, "%s", *((char **)kp
->arg
));
282 EXPORT_SYMBOL(param_get_charp
);
284 static void param_free_charp(void *arg
)
286 maybe_kfree_parameter(*((char **)arg
));
289 struct kernel_param_ops param_ops_charp
= {
290 .set
= param_set_charp
,
291 .get
= param_get_charp
,
292 .free
= param_free_charp
,
294 EXPORT_SYMBOL(param_ops_charp
);
296 /* Actually could be a bool or an int, for historical reasons. */
297 int param_set_bool(const char *val
, const struct kernel_param
*kp
)
302 /* No equals means "set"... */
305 /* One of =[yYnN01] */
306 ret
= strtobool(val
, &v
);
310 if (kp
->flags
& KPARAM_ISBOOL
)
311 *(bool *)kp
->arg
= v
;
316 EXPORT_SYMBOL(param_set_bool
);
318 int param_get_bool(char *buffer
, const struct kernel_param
*kp
)
321 if (kp
->flags
& KPARAM_ISBOOL
)
322 val
= *(bool *)kp
->arg
;
324 val
= *(int *)kp
->arg
;
326 /* Y and N chosen as being relatively non-coder friendly */
327 return sprintf(buffer
, "%c", val
? 'Y' : 'N');
329 EXPORT_SYMBOL(param_get_bool
);
331 struct kernel_param_ops param_ops_bool
= {
332 .set
= param_set_bool
,
333 .get
= param_get_bool
,
335 EXPORT_SYMBOL(param_ops_bool
);
337 /* This one must be bool. */
338 int param_set_invbool(const char *val
, const struct kernel_param
*kp
)
342 struct kernel_param dummy
;
344 dummy
.arg
= &boolval
;
345 dummy
.flags
= KPARAM_ISBOOL
;
346 ret
= param_set_bool(val
, &dummy
);
348 *(bool *)kp
->arg
= !boolval
;
351 EXPORT_SYMBOL(param_set_invbool
);
353 int param_get_invbool(char *buffer
, const struct kernel_param
*kp
)
355 return sprintf(buffer
, "%c", (*(bool *)kp
->arg
) ? 'N' : 'Y');
357 EXPORT_SYMBOL(param_get_invbool
);
359 struct kernel_param_ops param_ops_invbool
= {
360 .set
= param_set_invbool
,
361 .get
= param_get_invbool
,
363 EXPORT_SYMBOL(param_ops_invbool
);
365 /* We break the rule and mangle the string. */
366 static int param_array(const char *name
,
368 unsigned int min
, unsigned int max
,
369 void *elem
, int elemsize
,
370 int (*set
)(const char *, const struct kernel_param
*kp
),
375 struct kernel_param kp
;
378 /* Get the name right for errors. */
384 /* We expect a comma-separated list of values. */
389 printk(KERN_ERR
"%s: can only take %i arguments\n",
393 len
= strcspn(val
, ",");
395 /* nul-terminate and parse */
397 ((char *)val
)[len
] = '\0';
398 BUG_ON(!mutex_is_locked(¶m_lock
));
406 } while (save
== ',');
409 printk(KERN_ERR
"%s: needs at least %i arguments\n",
416 static int param_array_set(const char *val
, const struct kernel_param
*kp
)
418 const struct kparam_array
*arr
= kp
->arr
;
419 unsigned int temp_num
;
421 return param_array(kp
->name
, val
, 1, arr
->max
, arr
->elem
,
422 arr
->elemsize
, arr
->ops
->set
, kp
->flags
,
423 arr
->num
?: &temp_num
);
426 static int param_array_get(char *buffer
, const struct kernel_param
*kp
)
429 const struct kparam_array
*arr
= kp
->arr
;
430 struct kernel_param p
;
433 for (i
= off
= 0; i
< (arr
->num
? *arr
->num
: arr
->max
); i
++) {
436 p
.arg
= arr
->elem
+ arr
->elemsize
* i
;
437 BUG_ON(!mutex_is_locked(¶m_lock
));
438 ret
= arr
->ops
->get(buffer
+ off
, &p
);
447 static void param_array_free(void *arg
)
450 const struct kparam_array
*arr
= arg
;
453 for (i
= 0; i
< (arr
->num
? *arr
->num
: arr
->max
); i
++)
454 arr
->ops
->free(arr
->elem
+ arr
->elemsize
* i
);
457 struct kernel_param_ops param_array_ops
= {
458 .set
= param_array_set
,
459 .get
= param_array_get
,
460 .free
= param_array_free
,
462 EXPORT_SYMBOL(param_array_ops
);
464 int param_set_copystring(const char *val
, const struct kernel_param
*kp
)
466 const struct kparam_string
*kps
= kp
->str
;
468 if (strlen(val
)+1 > kps
->maxlen
) {
469 printk(KERN_ERR
"%s: string doesn't fit in %u chars.\n",
470 kp
->name
, kps
->maxlen
-1);
473 strcpy(kps
->string
, val
);
476 EXPORT_SYMBOL(param_set_copystring
);
478 int param_get_string(char *buffer
, const struct kernel_param
*kp
)
480 const struct kparam_string
*kps
= kp
->str
;
481 return strlcpy(buffer
, kps
->string
, kps
->maxlen
);
483 EXPORT_SYMBOL(param_get_string
);
485 struct kernel_param_ops param_ops_string
= {
486 .set
= param_set_copystring
,
487 .get
= param_get_string
,
489 EXPORT_SYMBOL(param_ops_string
);
491 /* sysfs output in /sys/modules/XYZ/parameters/ */
492 #define to_module_attr(n) container_of(n, struct module_attribute, attr)
493 #define to_module_kobject(n) container_of(n, struct module_kobject, kobj)
495 extern struct kernel_param __start___param
[], __stop___param
[];
497 struct param_attribute
499 struct module_attribute mattr
;
500 const struct kernel_param
*param
;
503 struct module_param_attrs
506 struct attribute_group grp
;
507 struct param_attribute attrs
[0];
511 #define to_param_attr(n) container_of(n, struct param_attribute, mattr)
513 static ssize_t
param_attr_show(struct module_attribute
*mattr
,
514 struct module_kobject
*mk
, char *buf
)
517 struct param_attribute
*attribute
= to_param_attr(mattr
);
519 if (!attribute
->param
->ops
->get
)
522 mutex_lock(¶m_lock
);
523 count
= attribute
->param
->ops
->get(buf
, attribute
->param
);
524 mutex_unlock(¶m_lock
);
532 /* sysfs always hands a nul-terminated string in buf. We rely on that. */
533 static ssize_t
param_attr_store(struct module_attribute
*mattr
,
534 struct module_kobject
*km
,
535 const char *buf
, size_t len
)
538 struct param_attribute
*attribute
= to_param_attr(mattr
);
540 if (!attribute
->param
->ops
->set
)
543 mutex_lock(¶m_lock
);
544 err
= attribute
->param
->ops
->set(buf
, attribute
->param
);
545 mutex_unlock(¶m_lock
);
552 #ifdef CONFIG_MODULES
555 #define __modinit __init
559 void __kernel_param_lock(void)
561 mutex_lock(¶m_lock
);
563 EXPORT_SYMBOL(__kernel_param_lock
);
565 void __kernel_param_unlock(void)
567 mutex_unlock(¶m_lock
);
569 EXPORT_SYMBOL(__kernel_param_unlock
);
572 * add_sysfs_param - add a parameter to sysfs
573 * @mk: struct module_kobject
574 * @kparam: the actual parameter definition to add to sysfs
575 * @name: name of parameter
577 * Create a kobject if for a (per-module) parameter if mp NULL, and
578 * create file in sysfs. Returns an error on out of memory. Always cleans up
579 * if there's an error.
581 static __modinit
int add_sysfs_param(struct module_kobject
*mk
,
582 const struct kernel_param
*kp
,
585 struct module_param_attrs
*new;
586 struct attribute
**attrs
;
589 /* We don't bother calling this with invisible parameters. */
597 attrs
= mk
->mp
->grp
.attrs
;
601 new = krealloc(mk
->mp
,
602 sizeof(*mk
->mp
) + sizeof(mk
->mp
->attrs
[0]) * (num
+1),
609 attrs
= krealloc(attrs
, sizeof(new->grp
.attrs
[0])*(num
+2), GFP_KERNEL
);
615 /* Sysfs wants everything zeroed. */
616 memset(new, 0, sizeof(*new));
617 memset(&new->attrs
[num
], 0, sizeof(new->attrs
[num
]));
618 memset(&attrs
[num
], 0, sizeof(attrs
[num
]));
619 new->grp
.name
= "parameters";
620 new->grp
.attrs
= attrs
;
622 /* Tack new one on the end. */
623 sysfs_attr_init(&new->attrs
[num
].mattr
.attr
);
624 new->attrs
[num
].param
= kp
;
625 new->attrs
[num
].mattr
.show
= param_attr_show
;
626 new->attrs
[num
].mattr
.store
= param_attr_store
;
627 new->attrs
[num
].mattr
.attr
.name
= (char *)name
;
628 new->attrs
[num
].mattr
.attr
.mode
= kp
->perm
;
631 /* Fix up all the pointers, since krealloc can move us */
632 for (num
= 0; num
< new->num
; num
++)
633 new->grp
.attrs
[num
] = &new->attrs
[num
].mattr
.attr
;
634 new->grp
.attrs
[num
] = NULL
;
646 #ifdef CONFIG_MODULES
647 static void free_module_param_attrs(struct module_kobject
*mk
)
649 kfree(mk
->mp
->grp
.attrs
);
655 * module_param_sysfs_setup - setup sysfs support for one module
657 * @kparam: module parameters (array)
658 * @num_params: number of module parameters
660 * Adds sysfs entries for module parameters under
661 * /sys/module/[mod->name]/parameters/
663 int module_param_sysfs_setup(struct module
*mod
,
664 const struct kernel_param
*kparam
,
665 unsigned int num_params
)
670 for (i
= 0; i
< num_params
; i
++) {
671 if (kparam
[i
].perm
== 0)
673 err
= add_sysfs_param(&mod
->mkobj
, &kparam
[i
], kparam
[i
].name
);
682 /* Create the param group. */
683 err
= sysfs_create_group(&mod
->mkobj
.kobj
, &mod
->mkobj
.mp
->grp
);
685 free_module_param_attrs(&mod
->mkobj
);
690 * module_param_sysfs_remove - remove sysfs support for one module
693 * Remove sysfs entries for module parameters and the corresponding
696 void module_param_sysfs_remove(struct module
*mod
)
699 sysfs_remove_group(&mod
->mkobj
.kobj
, &mod
->mkobj
.mp
->grp
);
700 /* We are positive that no one is using any param
701 * attrs at this point. Deallocate immediately. */
702 free_module_param_attrs(&mod
->mkobj
);
707 void destroy_params(const struct kernel_param
*params
, unsigned num
)
711 for (i
= 0; i
< num
; i
++)
712 if (params
[i
].ops
->free
)
713 params
[i
].ops
->free(params
[i
].arg
);
716 static struct module_kobject
* __init
locate_module_kobject(const char *name
)
718 struct module_kobject
*mk
;
719 struct kobject
*kobj
;
722 kobj
= kset_find_obj(module_kset
, name
);
724 mk
= to_module_kobject(kobj
);
726 mk
= kzalloc(sizeof(struct module_kobject
), GFP_KERNEL
);
729 mk
->mod
= THIS_MODULE
;
730 mk
->kobj
.kset
= module_kset
;
731 err
= kobject_init_and_add(&mk
->kobj
, &module_ktype
, NULL
,
733 #ifdef CONFIG_MODULES
735 err
= sysfs_create_file(&mk
->kobj
, &module_uevent
.attr
);
738 kobject_put(&mk
->kobj
);
740 "Module '%s' failed add to sysfs, error number %d\n",
743 "The system will be unstable now.\n");
747 /* So that we hold reference in both cases. */
748 kobject_get(&mk
->kobj
);
754 static void __init
kernel_add_sysfs_param(const char *name
,
755 struct kernel_param
*kparam
,
756 unsigned int name_skip
)
758 struct module_kobject
*mk
;
761 mk
= locate_module_kobject(name
);
765 /* We need to remove old parameters before adding more. */
767 sysfs_remove_group(&mk
->kobj
, &mk
->mp
->grp
);
769 /* These should not fail at boot. */
770 err
= add_sysfs_param(mk
, kparam
, kparam
->name
+ name_skip
);
772 err
= sysfs_create_group(&mk
->kobj
, &mk
->mp
->grp
);
774 kobject_uevent(&mk
->kobj
, KOBJ_ADD
);
775 kobject_put(&mk
->kobj
);
779 * param_sysfs_builtin - add contents in /sys/parameters for built-in modules
781 * Add module_parameters to sysfs for "modules" built into the kernel.
783 * The "module" name (KBUILD_MODNAME) is stored before a dot, the
784 * "parameter" name is stored behind a dot in kernel_param->name. So,
785 * extract the "module" name for all built-in kernel_param-eters,
786 * and for all who have the same, call kernel_add_sysfs_param.
788 static void __init
param_sysfs_builtin(void)
790 struct kernel_param
*kp
;
791 unsigned int name_len
;
792 char modname
[MODULE_NAME_LEN
];
794 for (kp
= __start___param
; kp
< __stop___param
; kp
++) {
800 dot
= strchr(kp
->name
, '.');
802 /* This happens for core_param() */
803 strcpy(modname
, "kernel");
806 name_len
= dot
- kp
->name
+ 1;
807 strlcpy(modname
, kp
->name
, name_len
);
809 kernel_add_sysfs_param(modname
, kp
, name_len
);
813 ssize_t
__modver_version_show(struct module_attribute
*mattr
,
814 struct module_kobject
*mk
, char *buf
)
816 struct module_version_attribute
*vattr
=
817 container_of(mattr
, struct module_version_attribute
, mattr
);
819 return sprintf(buf
, "%s\n", vattr
->version
);
822 extern const struct module_version_attribute
*__start___modver
[];
823 extern const struct module_version_attribute
*__stop___modver
[];
825 static void __init
version_sysfs_builtin(void)
827 const struct module_version_attribute
**p
;
828 struct module_kobject
*mk
;
831 for (p
= __start___modver
; p
< __stop___modver
; p
++) {
832 const struct module_version_attribute
*vattr
= *p
;
834 mk
= locate_module_kobject(vattr
->module_name
);
836 err
= sysfs_create_file(&mk
->kobj
, &vattr
->mattr
.attr
);
837 kobject_uevent(&mk
->kobj
, KOBJ_ADD
);
838 kobject_put(&mk
->kobj
);
843 /* module-related sysfs stuff */
845 static ssize_t
module_attr_show(struct kobject
*kobj
,
846 struct attribute
*attr
,
849 struct module_attribute
*attribute
;
850 struct module_kobject
*mk
;
853 attribute
= to_module_attr(attr
);
854 mk
= to_module_kobject(kobj
);
856 if (!attribute
->show
)
859 ret
= attribute
->show(attribute
, mk
, buf
);
864 static ssize_t
module_attr_store(struct kobject
*kobj
,
865 struct attribute
*attr
,
866 const char *buf
, size_t len
)
868 struct module_attribute
*attribute
;
869 struct module_kobject
*mk
;
872 attribute
= to_module_attr(attr
);
873 mk
= to_module_kobject(kobj
);
875 if (!attribute
->store
)
878 ret
= attribute
->store(attribute
, mk
, buf
, len
);
883 static const struct sysfs_ops module_sysfs_ops
= {
884 .show
= module_attr_show
,
885 .store
= module_attr_store
,
888 static int uevent_filter(struct kset
*kset
, struct kobject
*kobj
)
890 struct kobj_type
*ktype
= get_ktype(kobj
);
892 if (ktype
== &module_ktype
)
897 static const struct kset_uevent_ops module_uevent_ops
= {
898 .filter
= uevent_filter
,
901 struct kset
*module_kset
;
902 int module_sysfs_initialized
;
904 struct kobj_type module_ktype
= {
905 .sysfs_ops
= &module_sysfs_ops
,
909 * param_sysfs_init - wrapper for built-in params support
911 static int __init
param_sysfs_init(void)
913 module_kset
= kset_create_and_add("module", &module_uevent_ops
, NULL
);
915 printk(KERN_WARNING
"%s (%d): error creating kset\n",
919 module_sysfs_initialized
= 1;
921 version_sysfs_builtin();
922 param_sysfs_builtin();
926 subsys_initcall(param_sysfs_init
);
928 #endif /* CONFIG_SYSFS */