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
,
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
100 && params
[i
].ops
->set
!= param_set_bint
)
102 pr_debug("They are equal! Calling %p\n",
104 mutex_lock(¶m_lock
);
105 err
= params
[i
].ops
->set(val
, ¶ms
[i
]);
106 mutex_unlock(¶m_lock
);
111 if (handle_unknown
) {
112 pr_debug("Unknown argument: calling %p\n", handle_unknown
);
113 return handle_unknown(param
, val
);
116 pr_debug("Unknown argument `%s'\n", param
);
120 /* You can use " around spaces, but can't escape ". */
121 /* Hyphens and underscores equivalent in parameter names. */
122 static char *next_arg(char *args
, char **param
, char **val
)
124 unsigned int i
, equals
= 0;
125 int in_quote
= 0, quoted
= 0;
134 for (i
= 0; args
[i
]; i
++) {
135 if (isspace(args
[i
]) && !in_quote
)
142 in_quote
= !in_quote
;
150 *val
= args
+ equals
+ 1;
152 /* Don't include quotes in value. */
155 if (args
[i
-1] == '"')
158 if (quoted
&& args
[i
-1] == '"')
168 /* Chew up trailing spaces. */
169 return skip_spaces(next
);
172 /* Args looks like "foo=bar,bar2 baz=fuz wiz". */
173 int parse_args(const char *name
,
175 const struct kernel_param
*params
,
177 int (*unknown
)(char *param
, char *val
))
181 pr_debug("Parsing ARGS: %s\n", args
);
183 /* Chew leading spaces */
184 args
= skip_spaces(args
);
188 int irq_was_disabled
;
190 args
= next_arg(args
, ¶m
, &val
);
191 irq_was_disabled
= irqs_disabled();
192 ret
= parse_one(param
, val
, params
, num
, unknown
);
193 if (irq_was_disabled
&& !irqs_disabled()) {
194 printk(KERN_WARNING
"parse_args(): option '%s' enabled "
199 printk(KERN_ERR
"%s: Unknown parameter `%s'\n",
204 "%s: `%s' too large for parameter `%s'\n",
205 name
, val
?: "", param
);
211 "%s: `%s' invalid for parameter `%s'\n",
212 name
, val
?: "", param
);
221 /* Lazy bastard, eh? */
222 #define STANDARD_PARAM_DEF(name, type, format, tmptype, strtolfn) \
223 int param_set_##name(const char *val, const struct kernel_param *kp) \
228 ret = strtolfn(val, 0, &l); \
229 if (ret < 0 || ((type)l != l)) \
230 return ret < 0 ? ret : -EINVAL; \
231 *((type *)kp->arg) = l; \
234 int param_get_##name(char *buffer, const struct kernel_param *kp) \
236 return sprintf(buffer, format, *((type *)kp->arg)); \
238 struct kernel_param_ops param_ops_##name = { \
239 .set = param_set_##name, \
240 .get = param_get_##name, \
242 EXPORT_SYMBOL(param_set_##name); \
243 EXPORT_SYMBOL(param_get_##name); \
244 EXPORT_SYMBOL(param_ops_##name)
247 STANDARD_PARAM_DEF(byte
, unsigned char, "%c", unsigned long, strict_strtoul
);
248 STANDARD_PARAM_DEF(short, short, "%hi", long, strict_strtol
);
249 STANDARD_PARAM_DEF(ushort
, unsigned short, "%hu", unsigned long, strict_strtoul
);
250 STANDARD_PARAM_DEF(int, int, "%i", long, strict_strtol
);
251 STANDARD_PARAM_DEF(uint
, unsigned int, "%u", unsigned long, strict_strtoul
);
252 STANDARD_PARAM_DEF(long, long, "%li", long, strict_strtol
);
253 STANDARD_PARAM_DEF(ulong
, unsigned long, "%lu", unsigned long, strict_strtoul
);
255 int param_set_charp(const char *val
, const struct kernel_param
*kp
)
257 if (strlen(val
) > 1024) {
258 printk(KERN_ERR
"%s: string parameter too long\n",
263 maybe_kfree_parameter(*(char **)kp
->arg
);
265 /* This is a hack. We can't kmalloc in early boot, and we
266 * don't need to; this mangled commandline is preserved. */
267 if (slab_is_available()) {
268 *(char **)kp
->arg
= kmalloc_parameter(strlen(val
)+1);
269 if (!*(char **)kp
->arg
)
271 strcpy(*(char **)kp
->arg
, val
);
273 *(const char **)kp
->arg
= val
;
277 EXPORT_SYMBOL(param_set_charp
);
279 int param_get_charp(char *buffer
, const struct kernel_param
*kp
)
281 return sprintf(buffer
, "%s", *((char **)kp
->arg
));
283 EXPORT_SYMBOL(param_get_charp
);
285 static void param_free_charp(void *arg
)
287 maybe_kfree_parameter(*((char **)arg
));
290 struct kernel_param_ops param_ops_charp
= {
291 .set
= param_set_charp
,
292 .get
= param_get_charp
,
293 .free
= param_free_charp
,
295 EXPORT_SYMBOL(param_ops_charp
);
297 /* Actually could be a bool or an int, for historical reasons. */
298 int param_set_bool(const char *val
, const struct kernel_param
*kp
)
303 /* No equals means "set"... */
306 /* One of =[yYnN01] */
307 ret
= strtobool(val
, &v
);
311 if (kp
->flags
& KPARAM_ISBOOL
)
312 *(bool *)kp
->arg
= v
;
317 EXPORT_SYMBOL(param_set_bool
);
319 int param_get_bool(char *buffer
, const struct kernel_param
*kp
)
322 if (kp
->flags
& KPARAM_ISBOOL
)
323 val
= *(bool *)kp
->arg
;
325 val
= *(int *)kp
->arg
;
327 /* Y and N chosen as being relatively non-coder friendly */
328 return sprintf(buffer
, "%c", val
? 'Y' : 'N');
330 EXPORT_SYMBOL(param_get_bool
);
332 struct kernel_param_ops param_ops_bool
= {
333 .set
= param_set_bool
,
334 .get
= param_get_bool
,
336 EXPORT_SYMBOL(param_ops_bool
);
338 /* This one must be bool. */
339 int param_set_invbool(const char *val
, const struct kernel_param
*kp
)
343 struct kernel_param dummy
;
345 dummy
.arg
= &boolval
;
346 dummy
.flags
= KPARAM_ISBOOL
;
347 ret
= param_set_bool(val
, &dummy
);
349 *(bool *)kp
->arg
= !boolval
;
352 EXPORT_SYMBOL(param_set_invbool
);
354 int param_get_invbool(char *buffer
, const struct kernel_param
*kp
)
356 return sprintf(buffer
, "%c", (*(bool *)kp
->arg
) ? 'N' : 'Y');
358 EXPORT_SYMBOL(param_get_invbool
);
360 struct kernel_param_ops param_ops_invbool
= {
361 .set
= param_set_invbool
,
362 .get
= param_get_invbool
,
364 EXPORT_SYMBOL(param_ops_invbool
);
366 int param_set_bint(const char *val
, const struct kernel_param
*kp
)
368 struct kernel_param boolkp
;
372 /* Match bool exactly, by re-using it. */
375 boolkp
.flags
|= KPARAM_ISBOOL
;
377 ret
= param_set_bool(val
, &boolkp
);
382 EXPORT_SYMBOL(param_set_bint
);
384 struct kernel_param_ops param_ops_bint
= {
385 .set
= param_set_bint
,
386 .get
= param_get_int
,
388 EXPORT_SYMBOL(param_ops_bint
);
390 /* We break the rule and mangle the string. */
391 static int param_array(const char *name
,
393 unsigned int min
, unsigned int max
,
394 void *elem
, int elemsize
,
395 int (*set
)(const char *, const struct kernel_param
*kp
),
400 struct kernel_param kp
;
403 /* Get the name right for errors. */
409 /* We expect a comma-separated list of values. */
414 printk(KERN_ERR
"%s: can only take %i arguments\n",
418 len
= strcspn(val
, ",");
420 /* nul-terminate and parse */
422 ((char *)val
)[len
] = '\0';
423 BUG_ON(!mutex_is_locked(¶m_lock
));
431 } while (save
== ',');
434 printk(KERN_ERR
"%s: needs at least %i arguments\n",
441 static int param_array_set(const char *val
, const struct kernel_param
*kp
)
443 const struct kparam_array
*arr
= kp
->arr
;
444 unsigned int temp_num
;
446 return param_array(kp
->name
, val
, 1, arr
->max
, arr
->elem
,
447 arr
->elemsize
, arr
->ops
->set
, kp
->flags
,
448 arr
->num
?: &temp_num
);
451 static int param_array_get(char *buffer
, const struct kernel_param
*kp
)
454 const struct kparam_array
*arr
= kp
->arr
;
455 struct kernel_param p
;
458 for (i
= off
= 0; i
< (arr
->num
? *arr
->num
: arr
->max
); i
++) {
461 p
.arg
= arr
->elem
+ arr
->elemsize
* i
;
462 BUG_ON(!mutex_is_locked(¶m_lock
));
463 ret
= arr
->ops
->get(buffer
+ off
, &p
);
472 static void param_array_free(void *arg
)
475 const struct kparam_array
*arr
= arg
;
478 for (i
= 0; i
< (arr
->num
? *arr
->num
: arr
->max
); i
++)
479 arr
->ops
->free(arr
->elem
+ arr
->elemsize
* i
);
482 struct kernel_param_ops param_array_ops
= {
483 .set
= param_array_set
,
484 .get
= param_array_get
,
485 .free
= param_array_free
,
487 EXPORT_SYMBOL(param_array_ops
);
489 int param_set_copystring(const char *val
, const struct kernel_param
*kp
)
491 const struct kparam_string
*kps
= kp
->str
;
493 if (strlen(val
)+1 > kps
->maxlen
) {
494 printk(KERN_ERR
"%s: string doesn't fit in %u chars.\n",
495 kp
->name
, kps
->maxlen
-1);
498 strcpy(kps
->string
, val
);
501 EXPORT_SYMBOL(param_set_copystring
);
503 int param_get_string(char *buffer
, const struct kernel_param
*kp
)
505 const struct kparam_string
*kps
= kp
->str
;
506 return strlcpy(buffer
, kps
->string
, kps
->maxlen
);
508 EXPORT_SYMBOL(param_get_string
);
510 struct kernel_param_ops param_ops_string
= {
511 .set
= param_set_copystring
,
512 .get
= param_get_string
,
514 EXPORT_SYMBOL(param_ops_string
);
516 /* sysfs output in /sys/modules/XYZ/parameters/ */
517 #define to_module_attr(n) container_of(n, struct module_attribute, attr)
518 #define to_module_kobject(n) container_of(n, struct module_kobject, kobj)
520 extern struct kernel_param __start___param
[], __stop___param
[];
522 struct param_attribute
524 struct module_attribute mattr
;
525 const struct kernel_param
*param
;
528 struct module_param_attrs
531 struct attribute_group grp
;
532 struct param_attribute attrs
[0];
536 #define to_param_attr(n) container_of(n, struct param_attribute, mattr)
538 static ssize_t
param_attr_show(struct module_attribute
*mattr
,
539 struct module_kobject
*mk
, char *buf
)
542 struct param_attribute
*attribute
= to_param_attr(mattr
);
544 if (!attribute
->param
->ops
->get
)
547 mutex_lock(¶m_lock
);
548 count
= attribute
->param
->ops
->get(buf
, attribute
->param
);
549 mutex_unlock(¶m_lock
);
557 /* sysfs always hands a nul-terminated string in buf. We rely on that. */
558 static ssize_t
param_attr_store(struct module_attribute
*mattr
,
559 struct module_kobject
*km
,
560 const char *buf
, size_t len
)
563 struct param_attribute
*attribute
= to_param_attr(mattr
);
565 if (!attribute
->param
->ops
->set
)
568 mutex_lock(¶m_lock
);
569 err
= attribute
->param
->ops
->set(buf
, attribute
->param
);
570 mutex_unlock(¶m_lock
);
577 #ifdef CONFIG_MODULES
580 #define __modinit __init
584 void __kernel_param_lock(void)
586 mutex_lock(¶m_lock
);
588 EXPORT_SYMBOL(__kernel_param_lock
);
590 void __kernel_param_unlock(void)
592 mutex_unlock(¶m_lock
);
594 EXPORT_SYMBOL(__kernel_param_unlock
);
597 * add_sysfs_param - add a parameter to sysfs
598 * @mk: struct module_kobject
599 * @kparam: the actual parameter definition to add to sysfs
600 * @name: name of parameter
602 * Create a kobject if for a (per-module) parameter if mp NULL, and
603 * create file in sysfs. Returns an error on out of memory. Always cleans up
604 * if there's an error.
606 static __modinit
int add_sysfs_param(struct module_kobject
*mk
,
607 const struct kernel_param
*kp
,
610 struct module_param_attrs
*new;
611 struct attribute
**attrs
;
614 /* We don't bother calling this with invisible parameters. */
622 attrs
= mk
->mp
->grp
.attrs
;
626 new = krealloc(mk
->mp
,
627 sizeof(*mk
->mp
) + sizeof(mk
->mp
->attrs
[0]) * (num
+1),
634 attrs
= krealloc(attrs
, sizeof(new->grp
.attrs
[0])*(num
+2), GFP_KERNEL
);
640 /* Sysfs wants everything zeroed. */
641 memset(new, 0, sizeof(*new));
642 memset(&new->attrs
[num
], 0, sizeof(new->attrs
[num
]));
643 memset(&attrs
[num
], 0, sizeof(attrs
[num
]));
644 new->grp
.name
= "parameters";
645 new->grp
.attrs
= attrs
;
647 /* Tack new one on the end. */
648 sysfs_attr_init(&new->attrs
[num
].mattr
.attr
);
649 new->attrs
[num
].param
= kp
;
650 new->attrs
[num
].mattr
.show
= param_attr_show
;
651 new->attrs
[num
].mattr
.store
= param_attr_store
;
652 new->attrs
[num
].mattr
.attr
.name
= (char *)name
;
653 new->attrs
[num
].mattr
.attr
.mode
= kp
->perm
;
656 /* Fix up all the pointers, since krealloc can move us */
657 for (num
= 0; num
< new->num
; num
++)
658 new->grp
.attrs
[num
] = &new->attrs
[num
].mattr
.attr
;
659 new->grp
.attrs
[num
] = NULL
;
671 #ifdef CONFIG_MODULES
672 static void free_module_param_attrs(struct module_kobject
*mk
)
674 kfree(mk
->mp
->grp
.attrs
);
680 * module_param_sysfs_setup - setup sysfs support for one module
682 * @kparam: module parameters (array)
683 * @num_params: number of module parameters
685 * Adds sysfs entries for module parameters under
686 * /sys/module/[mod->name]/parameters/
688 int module_param_sysfs_setup(struct module
*mod
,
689 const struct kernel_param
*kparam
,
690 unsigned int num_params
)
695 for (i
= 0; i
< num_params
; i
++) {
696 if (kparam
[i
].perm
== 0)
698 err
= add_sysfs_param(&mod
->mkobj
, &kparam
[i
], kparam
[i
].name
);
707 /* Create the param group. */
708 err
= sysfs_create_group(&mod
->mkobj
.kobj
, &mod
->mkobj
.mp
->grp
);
710 free_module_param_attrs(&mod
->mkobj
);
715 * module_param_sysfs_remove - remove sysfs support for one module
718 * Remove sysfs entries for module parameters and the corresponding
721 void module_param_sysfs_remove(struct module
*mod
)
724 sysfs_remove_group(&mod
->mkobj
.kobj
, &mod
->mkobj
.mp
->grp
);
725 /* We are positive that no one is using any param
726 * attrs at this point. Deallocate immediately. */
727 free_module_param_attrs(&mod
->mkobj
);
732 void destroy_params(const struct kernel_param
*params
, unsigned num
)
736 for (i
= 0; i
< num
; i
++)
737 if (params
[i
].ops
->free
)
738 params
[i
].ops
->free(params
[i
].arg
);
741 static struct module_kobject
* __init
locate_module_kobject(const char *name
)
743 struct module_kobject
*mk
;
744 struct kobject
*kobj
;
747 kobj
= kset_find_obj(module_kset
, name
);
749 mk
= to_module_kobject(kobj
);
751 mk
= kzalloc(sizeof(struct module_kobject
), GFP_KERNEL
);
754 mk
->mod
= THIS_MODULE
;
755 mk
->kobj
.kset
= module_kset
;
756 err
= kobject_init_and_add(&mk
->kobj
, &module_ktype
, NULL
,
758 #ifdef CONFIG_MODULES
760 err
= sysfs_create_file(&mk
->kobj
, &module_uevent
.attr
);
763 kobject_put(&mk
->kobj
);
765 "Module '%s' failed add to sysfs, error number %d\n",
768 "The system will be unstable now.\n");
772 /* So that we hold reference in both cases. */
773 kobject_get(&mk
->kobj
);
779 static void __init
kernel_add_sysfs_param(const char *name
,
780 struct kernel_param
*kparam
,
781 unsigned int name_skip
)
783 struct module_kobject
*mk
;
786 mk
= locate_module_kobject(name
);
790 /* We need to remove old parameters before adding more. */
792 sysfs_remove_group(&mk
->kobj
, &mk
->mp
->grp
);
794 /* These should not fail at boot. */
795 err
= add_sysfs_param(mk
, kparam
, kparam
->name
+ name_skip
);
797 err
= sysfs_create_group(&mk
->kobj
, &mk
->mp
->grp
);
799 kobject_uevent(&mk
->kobj
, KOBJ_ADD
);
800 kobject_put(&mk
->kobj
);
804 * param_sysfs_builtin - add contents in /sys/parameters for built-in modules
806 * Add module_parameters to sysfs for "modules" built into the kernel.
808 * The "module" name (KBUILD_MODNAME) is stored before a dot, the
809 * "parameter" name is stored behind a dot in kernel_param->name. So,
810 * extract the "module" name for all built-in kernel_param-eters,
811 * and for all who have the same, call kernel_add_sysfs_param.
813 static void __init
param_sysfs_builtin(void)
815 struct kernel_param
*kp
;
816 unsigned int name_len
;
817 char modname
[MODULE_NAME_LEN
];
819 for (kp
= __start___param
; kp
< __stop___param
; kp
++) {
825 dot
= strchr(kp
->name
, '.');
827 /* This happens for core_param() */
828 strcpy(modname
, "kernel");
831 name_len
= dot
- kp
->name
+ 1;
832 strlcpy(modname
, kp
->name
, name_len
);
834 kernel_add_sysfs_param(modname
, kp
, name_len
);
838 ssize_t
__modver_version_show(struct module_attribute
*mattr
,
839 struct module_kobject
*mk
, char *buf
)
841 struct module_version_attribute
*vattr
=
842 container_of(mattr
, struct module_version_attribute
, mattr
);
844 return sprintf(buf
, "%s\n", vattr
->version
);
847 extern const struct module_version_attribute
*__start___modver
[];
848 extern const struct module_version_attribute
*__stop___modver
[];
850 static void __init
version_sysfs_builtin(void)
852 const struct module_version_attribute
**p
;
853 struct module_kobject
*mk
;
856 for (p
= __start___modver
; p
< __stop___modver
; p
++) {
857 const struct module_version_attribute
*vattr
= *p
;
859 mk
= locate_module_kobject(vattr
->module_name
);
861 err
= sysfs_create_file(&mk
->kobj
, &vattr
->mattr
.attr
);
862 kobject_uevent(&mk
->kobj
, KOBJ_ADD
);
863 kobject_put(&mk
->kobj
);
868 /* module-related sysfs stuff */
870 static ssize_t
module_attr_show(struct kobject
*kobj
,
871 struct attribute
*attr
,
874 struct module_attribute
*attribute
;
875 struct module_kobject
*mk
;
878 attribute
= to_module_attr(attr
);
879 mk
= to_module_kobject(kobj
);
881 if (!attribute
->show
)
884 ret
= attribute
->show(attribute
, mk
, buf
);
889 static ssize_t
module_attr_store(struct kobject
*kobj
,
890 struct attribute
*attr
,
891 const char *buf
, size_t len
)
893 struct module_attribute
*attribute
;
894 struct module_kobject
*mk
;
897 attribute
= to_module_attr(attr
);
898 mk
= to_module_kobject(kobj
);
900 if (!attribute
->store
)
903 ret
= attribute
->store(attribute
, mk
, buf
, len
);
908 static const struct sysfs_ops module_sysfs_ops
= {
909 .show
= module_attr_show
,
910 .store
= module_attr_store
,
913 static int uevent_filter(struct kset
*kset
, struct kobject
*kobj
)
915 struct kobj_type
*ktype
= get_ktype(kobj
);
917 if (ktype
== &module_ktype
)
922 static const struct kset_uevent_ops module_uevent_ops
= {
923 .filter
= uevent_filter
,
926 struct kset
*module_kset
;
927 int module_sysfs_initialized
;
929 struct kobj_type module_ktype
= {
930 .sysfs_ops
= &module_sysfs_ops
,
934 * param_sysfs_init - wrapper for built-in params support
936 static int __init
param_sysfs_init(void)
938 module_kset
= kset_create_and_add("module", &module_uevent_ops
, NULL
);
940 printk(KERN_WARNING
"%s (%d): error creating kset\n",
944 module_sysfs_initialized
= 1;
946 version_sysfs_builtin();
947 param_sysfs_builtin();
951 subsys_initcall(param_sysfs_init
);
953 #endif /* CONFIG_SYSFS */