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/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>
24 #include <linux/slab.h>
25 #include <linux/ctype.h>
27 /* Protects all parameters, and incidentally kmalloced_param list. */
28 static DEFINE_MUTEX(param_lock
);
30 /* This just allows us to keep track of which parameters are kmalloced. */
31 struct kmalloced_param
{
32 struct list_head list
;
35 static LIST_HEAD(kmalloced_params
);
37 static void *kmalloc_parameter(unsigned int size
)
39 struct kmalloced_param
*p
;
41 p
= kmalloc(sizeof(*p
) + size
, GFP_KERNEL
);
45 list_add(&p
->list
, &kmalloced_params
);
49 /* Does nothing if parameter wasn't kmalloced above. */
50 static void maybe_kfree_parameter(void *param
)
52 struct kmalloced_param
*p
;
54 list_for_each_entry(p
, &kmalloced_params
, list
) {
55 if (p
->val
== param
) {
63 static char dash2underscore(char c
)
70 bool parameqn(const char *a
, const char *b
, size_t n
)
74 for (i
= 0; i
< n
; i
++) {
75 if (dash2underscore(a
[i
]) != dash2underscore(b
[i
]))
81 bool parameq(const char *a
, const char *b
)
83 return parameqn(a
, b
, strlen(a
)+1);
86 static int parse_one(char *param
,
89 const struct kernel_param
*params
,
93 int (*handle_unknown
)(char *param
, char *val
,
100 for (i
= 0; i
< num_params
; i
++) {
101 if (parameq(param
, params
[i
].name
)) {
102 if (params
[i
].level
< min_level
103 || params
[i
].level
> max_level
)
105 /* No one handled NULL, so do it here. */
107 !(params
[i
].ops
->flags
& KERNEL_PARAM_FL_NOARG
))
109 pr_debug("handling %s with %p\n", param
,
111 mutex_lock(¶m_lock
);
112 err
= params
[i
].ops
->set(val
, ¶ms
[i
]);
113 mutex_unlock(¶m_lock
);
118 if (handle_unknown
) {
119 pr_debug("doing %s: %s='%s'\n", doing
, param
, val
);
120 return handle_unknown(param
, val
, doing
);
123 pr_debug("Unknown argument '%s'\n", param
);
127 /* You can use " around spaces, but can't escape ". */
128 /* Hyphens and underscores equivalent in parameter names. */
129 static char *next_arg(char *args
, char **param
, char **val
)
131 unsigned int i
, equals
= 0;
132 int in_quote
= 0, quoted
= 0;
141 for (i
= 0; args
[i
]; i
++) {
142 if (isspace(args
[i
]) && !in_quote
)
149 in_quote
= !in_quote
;
157 *val
= args
+ equals
+ 1;
159 /* Don't include quotes in value. */
162 if (args
[i
-1] == '"')
165 if (quoted
&& args
[i
-1] == '"')
175 /* Chew up trailing spaces. */
176 return skip_spaces(next
);
179 /* Args looks like "foo=bar,bar2 baz=fuz wiz". */
180 int parse_args(const char *doing
,
182 const struct kernel_param
*params
,
186 int (*unknown
)(char *param
, char *val
, const char *doing
))
190 /* Chew leading spaces */
191 args
= skip_spaces(args
);
194 pr_debug("doing %s, parsing ARGS: '%s'\n", doing
, args
);
198 int irq_was_disabled
;
200 args
= next_arg(args
, ¶m
, &val
);
201 irq_was_disabled
= irqs_disabled();
202 ret
= parse_one(param
, val
, doing
, params
, num
,
203 min_level
, max_level
, unknown
);
204 if (irq_was_disabled
&& !irqs_disabled())
205 pr_warn("%s: option '%s' enabled irq's!\n",
210 pr_err("%s: Unknown parameter `%s'\n", doing
, param
);
213 pr_err("%s: `%s' too large for parameter `%s'\n",
214 doing
, val
?: "", param
);
219 pr_err("%s: `%s' invalid for parameter `%s'\n",
220 doing
, val
?: "", param
);
229 /* Lazy bastard, eh? */
230 #define STANDARD_PARAM_DEF(name, type, format, tmptype, strtolfn) \
231 int param_set_##name(const char *val, const struct kernel_param *kp) \
236 ret = strtolfn(val, 0, &l); \
237 if (ret < 0 || ((type)l != l)) \
238 return ret < 0 ? ret : -EINVAL; \
239 *((type *)kp->arg) = l; \
242 int param_get_##name(char *buffer, const struct kernel_param *kp) \
244 return scnprintf(buffer, PAGE_SIZE, format, \
245 *((type *)kp->arg)); \
247 struct kernel_param_ops param_ops_##name = { \
248 .set = param_set_##name, \
249 .get = param_get_##name, \
251 EXPORT_SYMBOL(param_set_##name); \
252 EXPORT_SYMBOL(param_get_##name); \
253 EXPORT_SYMBOL(param_ops_##name)
256 STANDARD_PARAM_DEF(byte
, unsigned char, "%hhu", unsigned long, kstrtoul
);
257 STANDARD_PARAM_DEF(short, short, "%hi", long, kstrtol
);
258 STANDARD_PARAM_DEF(ushort
, unsigned short, "%hu", unsigned long, kstrtoul
);
259 STANDARD_PARAM_DEF(int, int, "%i", long, kstrtol
);
260 STANDARD_PARAM_DEF(uint
, unsigned int, "%u", unsigned long, kstrtoul
);
261 STANDARD_PARAM_DEF(long, long, "%li", long, kstrtol
);
262 STANDARD_PARAM_DEF(ulong
, unsigned long, "%lu", unsigned long, kstrtoul
);
264 int param_set_charp(const char *val
, const struct kernel_param
*kp
)
266 if (strlen(val
) > 1024) {
267 pr_err("%s: string parameter too long\n", kp
->name
);
271 maybe_kfree_parameter(*(char **)kp
->arg
);
273 /* This is a hack. We can't kmalloc in early boot, and we
274 * don't need to; this mangled commandline is preserved. */
275 if (slab_is_available()) {
276 *(char **)kp
->arg
= kmalloc_parameter(strlen(val
)+1);
277 if (!*(char **)kp
->arg
)
279 strcpy(*(char **)kp
->arg
, val
);
281 *(const char **)kp
->arg
= val
;
285 EXPORT_SYMBOL(param_set_charp
);
287 int param_get_charp(char *buffer
, const struct kernel_param
*kp
)
289 return scnprintf(buffer
, PAGE_SIZE
, "%s", *((char **)kp
->arg
));
291 EXPORT_SYMBOL(param_get_charp
);
293 static void param_free_charp(void *arg
)
295 maybe_kfree_parameter(*((char **)arg
));
298 struct kernel_param_ops param_ops_charp
= {
299 .set
= param_set_charp
,
300 .get
= param_get_charp
,
301 .free
= param_free_charp
,
303 EXPORT_SYMBOL(param_ops_charp
);
305 /* Actually could be a bool or an int, for historical reasons. */
306 int param_set_bool(const char *val
, const struct kernel_param
*kp
)
308 /* No equals means "set"... */
311 /* One of =[yYnN01] */
312 return strtobool(val
, kp
->arg
);
314 EXPORT_SYMBOL(param_set_bool
);
316 int param_get_bool(char *buffer
, const struct kernel_param
*kp
)
318 /* Y and N chosen as being relatively non-coder friendly */
319 return sprintf(buffer
, "%c", *(bool *)kp
->arg
? 'Y' : 'N');
321 EXPORT_SYMBOL(param_get_bool
);
323 struct kernel_param_ops param_ops_bool
= {
324 .flags
= KERNEL_PARAM_FL_NOARG
,
325 .set
= param_set_bool
,
326 .get
= param_get_bool
,
328 EXPORT_SYMBOL(param_ops_bool
);
330 /* This one must be bool. */
331 int param_set_invbool(const char *val
, const struct kernel_param
*kp
)
335 struct kernel_param dummy
;
337 dummy
.arg
= &boolval
;
338 ret
= param_set_bool(val
, &dummy
);
340 *(bool *)kp
->arg
= !boolval
;
343 EXPORT_SYMBOL(param_set_invbool
);
345 int param_get_invbool(char *buffer
, const struct kernel_param
*kp
)
347 return sprintf(buffer
, "%c", (*(bool *)kp
->arg
) ? 'N' : 'Y');
349 EXPORT_SYMBOL(param_get_invbool
);
351 struct kernel_param_ops param_ops_invbool
= {
352 .set
= param_set_invbool
,
353 .get
= param_get_invbool
,
355 EXPORT_SYMBOL(param_ops_invbool
);
357 int param_set_bint(const char *val
, const struct kernel_param
*kp
)
359 struct kernel_param boolkp
;
363 /* Match bool exactly, by re-using it. */
367 ret
= param_set_bool(val
, &boolkp
);
372 EXPORT_SYMBOL(param_set_bint
);
374 struct kernel_param_ops param_ops_bint
= {
375 .flags
= KERNEL_PARAM_FL_NOARG
,
376 .set
= param_set_bint
,
377 .get
= param_get_int
,
379 EXPORT_SYMBOL(param_ops_bint
);
381 /* We break the rule and mangle the string. */
382 static int param_array(const char *name
,
384 unsigned int min
, unsigned int max
,
385 void *elem
, int elemsize
,
386 int (*set
)(const char *, const struct kernel_param
*kp
),
391 struct kernel_param kp
;
394 /* Get the name right for errors. */
400 /* We expect a comma-separated list of values. */
405 pr_err("%s: can only take %i arguments\n", name
, max
);
408 len
= strcspn(val
, ",");
410 /* nul-terminate and parse */
412 ((char *)val
)[len
] = '\0';
413 BUG_ON(!mutex_is_locked(¶m_lock
));
421 } while (save
== ',');
424 pr_err("%s: needs at least %i arguments\n", name
, min
);
430 static int param_array_set(const char *val
, const struct kernel_param
*kp
)
432 const struct kparam_array
*arr
= kp
->arr
;
433 unsigned int temp_num
;
435 return param_array(kp
->name
, val
, 1, arr
->max
, arr
->elem
,
436 arr
->elemsize
, arr
->ops
->set
, kp
->level
,
437 arr
->num
?: &temp_num
);
440 static int param_array_get(char *buffer
, const struct kernel_param
*kp
)
443 const struct kparam_array
*arr
= kp
->arr
;
444 struct kernel_param p
;
447 for (i
= off
= 0; i
< (arr
->num
? *arr
->num
: arr
->max
); i
++) {
450 p
.arg
= arr
->elem
+ arr
->elemsize
* i
;
451 BUG_ON(!mutex_is_locked(¶m_lock
));
452 ret
= arr
->ops
->get(buffer
+ off
, &p
);
461 static void param_array_free(void *arg
)
464 const struct kparam_array
*arr
= arg
;
467 for (i
= 0; i
< (arr
->num
? *arr
->num
: arr
->max
); i
++)
468 arr
->ops
->free(arr
->elem
+ arr
->elemsize
* i
);
471 struct kernel_param_ops param_array_ops
= {
472 .set
= param_array_set
,
473 .get
= param_array_get
,
474 .free
= param_array_free
,
476 EXPORT_SYMBOL(param_array_ops
);
478 int param_set_copystring(const char *val
, const struct kernel_param
*kp
)
480 const struct kparam_string
*kps
= kp
->str
;
482 if (strlen(val
)+1 > kps
->maxlen
) {
483 pr_err("%s: string doesn't fit in %u chars.\n",
484 kp
->name
, kps
->maxlen
-1);
487 strcpy(kps
->string
, val
);
490 EXPORT_SYMBOL(param_set_copystring
);
492 int param_get_string(char *buffer
, const struct kernel_param
*kp
)
494 const struct kparam_string
*kps
= kp
->str
;
495 return strlcpy(buffer
, kps
->string
, kps
->maxlen
);
497 EXPORT_SYMBOL(param_get_string
);
499 struct kernel_param_ops param_ops_string
= {
500 .set
= param_set_copystring
,
501 .get
= param_get_string
,
503 EXPORT_SYMBOL(param_ops_string
);
505 /* sysfs output in /sys/modules/XYZ/parameters/ */
506 #define to_module_attr(n) container_of(n, struct module_attribute, attr)
507 #define to_module_kobject(n) container_of(n, struct module_kobject, kobj)
509 extern struct kernel_param __start___param
[], __stop___param
[];
511 struct param_attribute
513 struct module_attribute mattr
;
514 const struct kernel_param
*param
;
517 struct module_param_attrs
520 struct attribute_group grp
;
521 struct param_attribute attrs
[0];
525 #define to_param_attr(n) container_of(n, struct param_attribute, mattr)
527 static ssize_t
param_attr_show(struct module_attribute
*mattr
,
528 struct module_kobject
*mk
, char *buf
)
531 struct param_attribute
*attribute
= to_param_attr(mattr
);
533 if (!attribute
->param
->ops
->get
)
536 mutex_lock(¶m_lock
);
537 count
= attribute
->param
->ops
->get(buf
, attribute
->param
);
538 mutex_unlock(¶m_lock
);
546 /* sysfs always hands a nul-terminated string in buf. We rely on that. */
547 static ssize_t
param_attr_store(struct module_attribute
*mattr
,
548 struct module_kobject
*km
,
549 const char *buf
, size_t len
)
552 struct param_attribute
*attribute
= to_param_attr(mattr
);
554 if (!attribute
->param
->ops
->set
)
557 mutex_lock(¶m_lock
);
558 err
= attribute
->param
->ops
->set(buf
, attribute
->param
);
559 mutex_unlock(¶m_lock
);
566 #ifdef CONFIG_MODULES
569 #define __modinit __init
573 void __kernel_param_lock(void)
575 mutex_lock(¶m_lock
);
577 EXPORT_SYMBOL(__kernel_param_lock
);
579 void __kernel_param_unlock(void)
581 mutex_unlock(¶m_lock
);
583 EXPORT_SYMBOL(__kernel_param_unlock
);
586 * add_sysfs_param - add a parameter to sysfs
587 * @mk: struct module_kobject
588 * @kparam: the actual parameter definition to add to sysfs
589 * @name: name of parameter
591 * Create a kobject if for a (per-module) parameter if mp NULL, and
592 * create file in sysfs. Returns an error on out of memory. Always cleans up
593 * if there's an error.
595 static __modinit
int add_sysfs_param(struct module_kobject
*mk
,
596 const struct kernel_param
*kp
,
599 struct module_param_attrs
*new;
600 struct attribute
**attrs
;
603 /* We don't bother calling this with invisible parameters. */
611 attrs
= mk
->mp
->grp
.attrs
;
615 new = krealloc(mk
->mp
,
616 sizeof(*mk
->mp
) + sizeof(mk
->mp
->attrs
[0]) * (num
+1),
623 /* Despite looking like the typical realloc() bug, this is safe.
624 * We *want* the old 'attrs' to be freed either way, and we'll store
625 * the new one in the success case. */
626 attrs
= krealloc(attrs
, sizeof(new->grp
.attrs
[0])*(num
+2), GFP_KERNEL
);
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
;
639 /* Tack new one on the end. */
640 sysfs_attr_init(&new->attrs
[num
].mattr
.attr
);
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
;
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
;
663 #ifdef CONFIG_MODULES
664 static void free_module_param_attrs(struct module_kobject
*mk
)
666 kfree(mk
->mp
->grp
.attrs
);
672 * module_param_sysfs_setup - setup sysfs support for one module
674 * @kparam: module parameters (array)
675 * @num_params: number of module parameters
677 * Adds sysfs entries for module parameters under
678 * /sys/module/[mod->name]/parameters/
680 int module_param_sysfs_setup(struct module
*mod
,
681 const struct kernel_param
*kparam
,
682 unsigned int num_params
)
687 for (i
= 0; i
< num_params
; i
++) {
688 if (kparam
[i
].perm
== 0)
690 err
= add_sysfs_param(&mod
->mkobj
, &kparam
[i
], kparam
[i
].name
);
699 /* Create the param group. */
700 err
= sysfs_create_group(&mod
->mkobj
.kobj
, &mod
->mkobj
.mp
->grp
);
702 free_module_param_attrs(&mod
->mkobj
);
707 * module_param_sysfs_remove - remove sysfs support for one module
710 * Remove sysfs entries for module parameters and the corresponding
713 void module_param_sysfs_remove(struct module
*mod
)
716 sysfs_remove_group(&mod
->mkobj
.kobj
, &mod
->mkobj
.mp
->grp
);
717 /* We are positive that no one is using any param
718 * attrs at this point. Deallocate immediately. */
719 free_module_param_attrs(&mod
->mkobj
);
724 void destroy_params(const struct kernel_param
*params
, unsigned num
)
728 for (i
= 0; i
< num
; i
++)
729 if (params
[i
].ops
->free
)
730 params
[i
].ops
->free(params
[i
].arg
);
733 static struct module_kobject
* __init
locate_module_kobject(const char *name
)
735 struct module_kobject
*mk
;
736 struct kobject
*kobj
;
739 kobj
= kset_find_obj(module_kset
, name
);
741 mk
= to_module_kobject(kobj
);
743 mk
= kzalloc(sizeof(struct module_kobject
), GFP_KERNEL
);
746 mk
->mod
= THIS_MODULE
;
747 mk
->kobj
.kset
= module_kset
;
748 err
= kobject_init_and_add(&mk
->kobj
, &module_ktype
, NULL
,
750 #ifdef CONFIG_MODULES
752 err
= sysfs_create_file(&mk
->kobj
, &module_uevent
.attr
);
755 kobject_put(&mk
->kobj
);
756 pr_crit("Adding module '%s' to sysfs failed (%d), the system may be unstable.\n",
761 /* So that we hold reference in both cases. */
762 kobject_get(&mk
->kobj
);
768 static void __init
kernel_add_sysfs_param(const char *name
,
769 struct kernel_param
*kparam
,
770 unsigned int name_skip
)
772 struct module_kobject
*mk
;
775 mk
= locate_module_kobject(name
);
779 /* We need to remove old parameters before adding more. */
781 sysfs_remove_group(&mk
->kobj
, &mk
->mp
->grp
);
783 /* These should not fail at boot. */
784 err
= add_sysfs_param(mk
, kparam
, kparam
->name
+ name_skip
);
786 err
= sysfs_create_group(&mk
->kobj
, &mk
->mp
->grp
);
788 kobject_uevent(&mk
->kobj
, KOBJ_ADD
);
789 kobject_put(&mk
->kobj
);
793 * param_sysfs_builtin - add sysfs parameters for built-in modules
795 * Add module_parameters to sysfs for "modules" built into the kernel.
797 * The "module" name (KBUILD_MODNAME) is stored before a dot, the
798 * "parameter" name is stored behind a dot in kernel_param->name. So,
799 * extract the "module" name for all built-in kernel_param-eters,
800 * and for all who have the same, call kernel_add_sysfs_param.
802 static void __init
param_sysfs_builtin(void)
804 struct kernel_param
*kp
;
805 unsigned int name_len
;
806 char modname
[MODULE_NAME_LEN
];
808 for (kp
= __start___param
; kp
< __stop___param
; kp
++) {
814 dot
= strchr(kp
->name
, '.');
816 /* This happens for core_param() */
817 strcpy(modname
, "kernel");
820 name_len
= dot
- kp
->name
+ 1;
821 strlcpy(modname
, kp
->name
, name_len
);
823 kernel_add_sysfs_param(modname
, kp
, name_len
);
827 ssize_t
__modver_version_show(struct module_attribute
*mattr
,
828 struct module_kobject
*mk
, char *buf
)
830 struct module_version_attribute
*vattr
=
831 container_of(mattr
, struct module_version_attribute
, mattr
);
833 return scnprintf(buf
, PAGE_SIZE
, "%s\n", vattr
->version
);
836 extern const struct module_version_attribute
*__start___modver
[];
837 extern const struct module_version_attribute
*__stop___modver
[];
839 static void __init
version_sysfs_builtin(void)
841 const struct module_version_attribute
**p
;
842 struct module_kobject
*mk
;
845 for (p
= __start___modver
; p
< __stop___modver
; p
++) {
846 const struct module_version_attribute
*vattr
= *p
;
848 mk
= locate_module_kobject(vattr
->module_name
);
850 err
= sysfs_create_file(&mk
->kobj
, &vattr
->mattr
.attr
);
851 kobject_uevent(&mk
->kobj
, KOBJ_ADD
);
852 kobject_put(&mk
->kobj
);
857 /* module-related sysfs stuff */
859 static ssize_t
module_attr_show(struct kobject
*kobj
,
860 struct attribute
*attr
,
863 struct module_attribute
*attribute
;
864 struct module_kobject
*mk
;
867 attribute
= to_module_attr(attr
);
868 mk
= to_module_kobject(kobj
);
870 if (!attribute
->show
)
873 ret
= attribute
->show(attribute
, mk
, buf
);
878 static ssize_t
module_attr_store(struct kobject
*kobj
,
879 struct attribute
*attr
,
880 const char *buf
, size_t len
)
882 struct module_attribute
*attribute
;
883 struct module_kobject
*mk
;
886 attribute
= to_module_attr(attr
);
887 mk
= to_module_kobject(kobj
);
889 if (!attribute
->store
)
892 ret
= attribute
->store(attribute
, mk
, buf
, len
);
897 static const struct sysfs_ops module_sysfs_ops
= {
898 .show
= module_attr_show
,
899 .store
= module_attr_store
,
902 static int uevent_filter(struct kset
*kset
, struct kobject
*kobj
)
904 struct kobj_type
*ktype
= get_ktype(kobj
);
906 if (ktype
== &module_ktype
)
911 static const struct kset_uevent_ops module_uevent_ops
= {
912 .filter
= uevent_filter
,
915 struct kset
*module_kset
;
916 int module_sysfs_initialized
;
918 static void module_kobj_release(struct kobject
*kobj
)
920 struct module_kobject
*mk
= to_module_kobject(kobj
);
921 complete(mk
->kobj_completion
);
924 struct kobj_type module_ktype
= {
925 .release
= module_kobj_release
,
926 .sysfs_ops
= &module_sysfs_ops
,
930 * param_sysfs_init - wrapper for built-in params support
932 static int __init
param_sysfs_init(void)
934 module_kset
= kset_create_and_add("module", &module_uevent_ops
, NULL
);
936 printk(KERN_WARNING
"%s (%d): error creating kset\n",
940 module_sysfs_initialized
= 1;
942 version_sysfs_builtin();
943 param_sysfs_builtin();
947 subsys_initcall(param_sysfs_init
);
949 #endif /* CONFIG_SYSFS */