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/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 /* 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 char dash2underscore(char c
)
77 bool parameqn(const char *a
, const char *b
, size_t n
)
81 for (i
= 0; i
< n
; i
++) {
82 if (dash2underscore(a
[i
]) != dash2underscore(b
[i
]))
88 bool parameq(const char *a
, const char *b
)
90 return parameqn(a
, b
, strlen(a
)+1);
93 static int parse_one(char *param
,
95 const struct kernel_param
*params
,
97 int (*handle_unknown
)(char *param
, char *val
))
103 for (i
= 0; i
< num_params
; i
++) {
104 if (parameq(param
, params
[i
].name
)) {
105 /* No one handled NULL, so do it here. */
106 if (!val
&& params
[i
].ops
->set
!= param_set_bool
)
108 DEBUGP("They are equal! Calling %p\n",
110 mutex_lock(¶m_lock
);
111 err
= params
[i
].ops
->set(val
, ¶ms
[i
]);
112 mutex_unlock(¶m_lock
);
117 if (handle_unknown
) {
118 DEBUGP("Unknown argument: calling %p\n", handle_unknown
);
119 return handle_unknown(param
, val
);
122 DEBUGP("Unknown argument `%s'\n", param
);
126 /* You can use " around spaces, but can't escape ". */
127 /* Hyphens and underscores equivalent in parameter names. */
128 static char *next_arg(char *args
, char **param
, char **val
)
130 unsigned int i
, equals
= 0;
131 int in_quote
= 0, quoted
= 0;
140 for (i
= 0; args
[i
]; i
++) {
141 if (isspace(args
[i
]) && !in_quote
)
148 in_quote
= !in_quote
;
156 *val
= args
+ equals
+ 1;
158 /* Don't include quotes in value. */
161 if (args
[i
-1] == '"')
164 if (quoted
&& args
[i
-1] == '"')
174 /* Chew up trailing spaces. */
175 return skip_spaces(next
);
178 /* Args looks like "foo=bar,bar2 baz=fuz wiz". */
179 int parse_args(const char *name
,
181 const struct kernel_param
*params
,
183 int (*unknown
)(char *param
, char *val
))
187 DEBUGP("Parsing ARGS: %s\n", args
);
189 /* Chew leading spaces */
190 args
= skip_spaces(args
);
194 int irq_was_disabled
;
196 args
= next_arg(args
, ¶m
, &val
);
197 irq_was_disabled
= irqs_disabled();
198 ret
= parse_one(param
, val
, params
, num
, unknown
);
199 if (irq_was_disabled
&& !irqs_disabled()) {
200 printk(KERN_WARNING
"parse_args(): option '%s' enabled "
205 printk(KERN_ERR
"%s: Unknown parameter `%s'\n",
210 "%s: `%s' too large for parameter `%s'\n",
211 name
, val
?: "", param
);
217 "%s: `%s' invalid for parameter `%s'\n",
218 name
, val
?: "", param
);
227 /* Lazy bastard, eh? */
228 #define STANDARD_PARAM_DEF(name, type, format, tmptype, strtolfn) \
229 int param_set_##name(const char *val, const struct kernel_param *kp) \
234 ret = strtolfn(val, 0, &l); \
235 if (ret < 0 || ((type)l != l)) \
236 return ret < 0 ? ret : -EINVAL; \
237 *((type *)kp->arg) = l; \
240 int param_get_##name(char *buffer, const struct kernel_param *kp) \
242 return sprintf(buffer, format, *((type *)kp->arg)); \
244 struct kernel_param_ops param_ops_##name = { \
245 .set = param_set_##name, \
246 .get = param_get_##name, \
248 EXPORT_SYMBOL(param_set_##name); \
249 EXPORT_SYMBOL(param_get_##name); \
250 EXPORT_SYMBOL(param_ops_##name)
253 STANDARD_PARAM_DEF(byte
, unsigned char, "%c", unsigned long, strict_strtoul
);
254 STANDARD_PARAM_DEF(short, short, "%hi", long, strict_strtol
);
255 STANDARD_PARAM_DEF(ushort
, unsigned short, "%hu", unsigned long, strict_strtoul
);
256 STANDARD_PARAM_DEF(int, int, "%i", long, strict_strtol
);
257 STANDARD_PARAM_DEF(uint
, unsigned int, "%u", unsigned long, strict_strtoul
);
258 STANDARD_PARAM_DEF(long, long, "%li", long, strict_strtol
);
259 STANDARD_PARAM_DEF(ulong
, unsigned long, "%lu", unsigned long, strict_strtoul
);
261 int param_set_charp(const char *val
, const struct kernel_param
*kp
)
263 if (strlen(val
) > 1024) {
264 printk(KERN_ERR
"%s: string parameter too long\n",
269 maybe_kfree_parameter(*(char **)kp
->arg
);
271 /* This is a hack. We can't kmalloc in early boot, and we
272 * don't need to; this mangled commandline is preserved. */
273 if (slab_is_available()) {
274 *(char **)kp
->arg
= kmalloc_parameter(strlen(val
)+1);
275 if (!*(char **)kp
->arg
)
277 strcpy(*(char **)kp
->arg
, val
);
279 *(const char **)kp
->arg
= val
;
283 EXPORT_SYMBOL(param_set_charp
);
285 int param_get_charp(char *buffer
, const struct kernel_param
*kp
)
287 return sprintf(buffer
, "%s", *((char **)kp
->arg
));
289 EXPORT_SYMBOL(param_get_charp
);
291 static void param_free_charp(void *arg
)
293 maybe_kfree_parameter(*((char **)arg
));
296 struct kernel_param_ops param_ops_charp
= {
297 .set
= param_set_charp
,
298 .get
= param_get_charp
,
299 .free
= param_free_charp
,
301 EXPORT_SYMBOL(param_ops_charp
);
303 /* Actually could be a bool or an int, for historical reasons. */
304 int param_set_bool(const char *val
, const struct kernel_param
*kp
)
309 /* No equals means "set"... */
312 /* One of =[yYnN01] */
313 ret
= strtobool(val
, &v
);
317 if (kp
->flags
& KPARAM_ISBOOL
)
318 *(bool *)kp
->arg
= v
;
323 EXPORT_SYMBOL(param_set_bool
);
325 int param_get_bool(char *buffer
, const struct kernel_param
*kp
)
328 if (kp
->flags
& KPARAM_ISBOOL
)
329 val
= *(bool *)kp
->arg
;
331 val
= *(int *)kp
->arg
;
333 /* Y and N chosen as being relatively non-coder friendly */
334 return sprintf(buffer
, "%c", val
? 'Y' : 'N');
336 EXPORT_SYMBOL(param_get_bool
);
338 struct kernel_param_ops param_ops_bool
= {
339 .set
= param_set_bool
,
340 .get
= param_get_bool
,
342 EXPORT_SYMBOL(param_ops_bool
);
344 /* This one must be bool. */
345 int param_set_invbool(const char *val
, const struct kernel_param
*kp
)
349 struct kernel_param dummy
;
351 dummy
.arg
= &boolval
;
352 dummy
.flags
= KPARAM_ISBOOL
;
353 ret
= param_set_bool(val
, &dummy
);
355 *(bool *)kp
->arg
= !boolval
;
358 EXPORT_SYMBOL(param_set_invbool
);
360 int param_get_invbool(char *buffer
, const struct kernel_param
*kp
)
362 return sprintf(buffer
, "%c", (*(bool *)kp
->arg
) ? 'N' : 'Y');
364 EXPORT_SYMBOL(param_get_invbool
);
366 struct kernel_param_ops param_ops_invbool
= {
367 .set
= param_set_invbool
,
368 .get
= param_get_invbool
,
370 EXPORT_SYMBOL(param_ops_invbool
);
372 /* We break the rule and mangle the string. */
373 static int param_array(const char *name
,
375 unsigned int min
, unsigned int max
,
376 void *elem
, int elemsize
,
377 int (*set
)(const char *, const struct kernel_param
*kp
),
382 struct kernel_param kp
;
385 /* Get the name right for errors. */
391 /* We expect a comma-separated list of values. */
396 printk(KERN_ERR
"%s: can only take %i arguments\n",
400 len
= strcspn(val
, ",");
402 /* nul-terminate and parse */
404 ((char *)val
)[len
] = '\0';
405 BUG_ON(!mutex_is_locked(¶m_lock
));
413 } while (save
== ',');
416 printk(KERN_ERR
"%s: needs at least %i arguments\n",
423 static int param_array_set(const char *val
, const struct kernel_param
*kp
)
425 const struct kparam_array
*arr
= kp
->arr
;
426 unsigned int temp_num
;
428 return param_array(kp
->name
, val
, 1, arr
->max
, arr
->elem
,
429 arr
->elemsize
, arr
->ops
->set
, kp
->flags
,
430 arr
->num
?: &temp_num
);
433 static int param_array_get(char *buffer
, const struct kernel_param
*kp
)
436 const struct kparam_array
*arr
= kp
->arr
;
437 struct kernel_param p
;
440 for (i
= off
= 0; i
< (arr
->num
? *arr
->num
: arr
->max
); i
++) {
443 p
.arg
= arr
->elem
+ arr
->elemsize
* i
;
444 BUG_ON(!mutex_is_locked(¶m_lock
));
445 ret
= arr
->ops
->get(buffer
+ off
, &p
);
454 static void param_array_free(void *arg
)
457 const struct kparam_array
*arr
= arg
;
460 for (i
= 0; i
< (arr
->num
? *arr
->num
: arr
->max
); i
++)
461 arr
->ops
->free(arr
->elem
+ arr
->elemsize
* i
);
464 struct kernel_param_ops param_array_ops
= {
465 .set
= param_array_set
,
466 .get
= param_array_get
,
467 .free
= param_array_free
,
469 EXPORT_SYMBOL(param_array_ops
);
471 int param_set_copystring(const char *val
, const struct kernel_param
*kp
)
473 const struct kparam_string
*kps
= kp
->str
;
475 if (strlen(val
)+1 > kps
->maxlen
) {
476 printk(KERN_ERR
"%s: string doesn't fit in %u chars.\n",
477 kp
->name
, kps
->maxlen
-1);
480 strcpy(kps
->string
, val
);
483 EXPORT_SYMBOL(param_set_copystring
);
485 int param_get_string(char *buffer
, const struct kernel_param
*kp
)
487 const struct kparam_string
*kps
= kp
->str
;
488 return strlcpy(buffer
, kps
->string
, kps
->maxlen
);
490 EXPORT_SYMBOL(param_get_string
);
492 struct kernel_param_ops param_ops_string
= {
493 .set
= param_set_copystring
,
494 .get
= param_get_string
,
496 EXPORT_SYMBOL(param_ops_string
);
498 /* sysfs output in /sys/modules/XYZ/parameters/ */
499 #define to_module_attr(n) container_of(n, struct module_attribute, attr)
500 #define to_module_kobject(n) container_of(n, struct module_kobject, kobj)
502 extern struct kernel_param __start___param
[], __stop___param
[];
504 struct param_attribute
506 struct module_attribute mattr
;
507 const struct kernel_param
*param
;
510 struct module_param_attrs
513 struct attribute_group grp
;
514 struct param_attribute attrs
[0];
518 #define to_param_attr(n) container_of(n, struct param_attribute, mattr)
520 static ssize_t
param_attr_show(struct module_attribute
*mattr
,
521 struct module_kobject
*mk
, char *buf
)
524 struct param_attribute
*attribute
= to_param_attr(mattr
);
526 if (!attribute
->param
->ops
->get
)
529 mutex_lock(¶m_lock
);
530 count
= attribute
->param
->ops
->get(buf
, attribute
->param
);
531 mutex_unlock(¶m_lock
);
539 /* sysfs always hands a nul-terminated string in buf. We rely on that. */
540 static ssize_t
param_attr_store(struct module_attribute
*mattr
,
541 struct module_kobject
*km
,
542 const char *buf
, size_t len
)
545 struct param_attribute
*attribute
= to_param_attr(mattr
);
547 if (!attribute
->param
->ops
->set
)
550 mutex_lock(¶m_lock
);
551 err
= attribute
->param
->ops
->set(buf
, attribute
->param
);
552 mutex_unlock(¶m_lock
);
559 #ifdef CONFIG_MODULES
562 #define __modinit __init
566 void __kernel_param_lock(void)
568 mutex_lock(¶m_lock
);
570 EXPORT_SYMBOL(__kernel_param_lock
);
572 void __kernel_param_unlock(void)
574 mutex_unlock(¶m_lock
);
576 EXPORT_SYMBOL(__kernel_param_unlock
);
579 * add_sysfs_param - add a parameter to sysfs
580 * @mk: struct module_kobject
581 * @kparam: the actual parameter definition to add to sysfs
582 * @name: name of parameter
584 * Create a kobject if for a (per-module) parameter if mp NULL, and
585 * create file in sysfs. Returns an error on out of memory. Always cleans up
586 * if there's an error.
588 static __modinit
int add_sysfs_param(struct module_kobject
*mk
,
589 const struct kernel_param
*kp
,
592 struct module_param_attrs
*new;
593 struct attribute
**attrs
;
596 /* We don't bother calling this with invisible parameters. */
604 attrs
= mk
->mp
->grp
.attrs
;
608 new = krealloc(mk
->mp
,
609 sizeof(*mk
->mp
) + sizeof(mk
->mp
->attrs
[0]) * (num
+1),
616 attrs
= krealloc(attrs
, sizeof(new->grp
.attrs
[0])*(num
+2), GFP_KERNEL
);
622 /* Sysfs wants everything zeroed. */
623 memset(new, 0, sizeof(*new));
624 memset(&new->attrs
[num
], 0, sizeof(new->attrs
[num
]));
625 memset(&attrs
[num
], 0, sizeof(attrs
[num
]));
626 new->grp
.name
= "parameters";
627 new->grp
.attrs
= attrs
;
629 /* Tack new one on the end. */
630 sysfs_attr_init(&new->attrs
[num
].mattr
.attr
);
631 new->attrs
[num
].param
= kp
;
632 new->attrs
[num
].mattr
.show
= param_attr_show
;
633 new->attrs
[num
].mattr
.store
= param_attr_store
;
634 new->attrs
[num
].mattr
.attr
.name
= (char *)name
;
635 new->attrs
[num
].mattr
.attr
.mode
= kp
->perm
;
638 /* Fix up all the pointers, since krealloc can move us */
639 for (num
= 0; num
< new->num
; num
++)
640 new->grp
.attrs
[num
] = &new->attrs
[num
].mattr
.attr
;
641 new->grp
.attrs
[num
] = NULL
;
653 #ifdef CONFIG_MODULES
654 static void free_module_param_attrs(struct module_kobject
*mk
)
656 kfree(mk
->mp
->grp
.attrs
);
662 * module_param_sysfs_setup - setup sysfs support for one module
664 * @kparam: module parameters (array)
665 * @num_params: number of module parameters
667 * Adds sysfs entries for module parameters under
668 * /sys/module/[mod->name]/parameters/
670 int module_param_sysfs_setup(struct module
*mod
,
671 const struct kernel_param
*kparam
,
672 unsigned int num_params
)
677 for (i
= 0; i
< num_params
; i
++) {
678 if (kparam
[i
].perm
== 0)
680 err
= add_sysfs_param(&mod
->mkobj
, &kparam
[i
], kparam
[i
].name
);
689 /* Create the param group. */
690 err
= sysfs_create_group(&mod
->mkobj
.kobj
, &mod
->mkobj
.mp
->grp
);
692 free_module_param_attrs(&mod
->mkobj
);
697 * module_param_sysfs_remove - remove sysfs support for one module
700 * Remove sysfs entries for module parameters and the corresponding
703 void module_param_sysfs_remove(struct module
*mod
)
706 sysfs_remove_group(&mod
->mkobj
.kobj
, &mod
->mkobj
.mp
->grp
);
707 /* We are positive that no one is using any param
708 * attrs at this point. Deallocate immediately. */
709 free_module_param_attrs(&mod
->mkobj
);
714 void destroy_params(const struct kernel_param
*params
, unsigned num
)
718 for (i
= 0; i
< num
; i
++)
719 if (params
[i
].ops
->free
)
720 params
[i
].ops
->free(params
[i
].arg
);
723 static struct module_kobject
* __init
locate_module_kobject(const char *name
)
725 struct module_kobject
*mk
;
726 struct kobject
*kobj
;
729 kobj
= kset_find_obj(module_kset
, name
);
731 mk
= to_module_kobject(kobj
);
733 mk
= kzalloc(sizeof(struct module_kobject
), GFP_KERNEL
);
736 mk
->mod
= THIS_MODULE
;
737 mk
->kobj
.kset
= module_kset
;
738 err
= kobject_init_and_add(&mk
->kobj
, &module_ktype
, NULL
,
740 #ifdef CONFIG_MODULES
742 err
= sysfs_create_file(&mk
->kobj
, &module_uevent
.attr
);
745 kobject_put(&mk
->kobj
);
747 "Module '%s' failed add to sysfs, error number %d\n",
750 "The system will be unstable now.\n");
754 /* So that we hold reference in both cases. */
755 kobject_get(&mk
->kobj
);
761 static void __init
kernel_add_sysfs_param(const char *name
,
762 struct kernel_param
*kparam
,
763 unsigned int name_skip
)
765 struct module_kobject
*mk
;
768 mk
= locate_module_kobject(name
);
772 /* We need to remove old parameters before adding more. */
774 sysfs_remove_group(&mk
->kobj
, &mk
->mp
->grp
);
776 /* These should not fail at boot. */
777 err
= add_sysfs_param(mk
, kparam
, kparam
->name
+ name_skip
);
779 err
= sysfs_create_group(&mk
->kobj
, &mk
->mp
->grp
);
781 kobject_uevent(&mk
->kobj
, KOBJ_ADD
);
782 kobject_put(&mk
->kobj
);
786 * param_sysfs_builtin - add contents in /sys/parameters for built-in modules
788 * Add module_parameters to sysfs for "modules" built into the kernel.
790 * The "module" name (KBUILD_MODNAME) is stored before a dot, the
791 * "parameter" name is stored behind a dot in kernel_param->name. So,
792 * extract the "module" name for all built-in kernel_param-eters,
793 * and for all who have the same, call kernel_add_sysfs_param.
795 static void __init
param_sysfs_builtin(void)
797 struct kernel_param
*kp
;
798 unsigned int name_len
;
799 char modname
[MODULE_NAME_LEN
];
801 for (kp
= __start___param
; kp
< __stop___param
; kp
++) {
807 dot
= strchr(kp
->name
, '.');
809 /* This happens for core_param() */
810 strcpy(modname
, "kernel");
813 name_len
= dot
- kp
->name
+ 1;
814 strlcpy(modname
, kp
->name
, name_len
);
816 kernel_add_sysfs_param(modname
, kp
, name_len
);
820 ssize_t
__modver_version_show(struct module_attribute
*mattr
,
821 struct module_kobject
*mk
, char *buf
)
823 struct module_version_attribute
*vattr
=
824 container_of(mattr
, struct module_version_attribute
, mattr
);
826 return sprintf(buf
, "%s\n", vattr
->version
);
829 extern const struct module_version_attribute
*__start___modver
[];
830 extern const struct module_version_attribute
*__stop___modver
[];
832 static void __init
version_sysfs_builtin(void)
834 const struct module_version_attribute
**p
;
835 struct module_kobject
*mk
;
838 for (p
= __start___modver
; p
< __stop___modver
; p
++) {
839 const struct module_version_attribute
*vattr
= *p
;
841 mk
= locate_module_kobject(vattr
->module_name
);
843 err
= sysfs_create_file(&mk
->kobj
, &vattr
->mattr
.attr
);
844 kobject_uevent(&mk
->kobj
, KOBJ_ADD
);
845 kobject_put(&mk
->kobj
);
850 /* module-related sysfs stuff */
852 static ssize_t
module_attr_show(struct kobject
*kobj
,
853 struct attribute
*attr
,
856 struct module_attribute
*attribute
;
857 struct module_kobject
*mk
;
860 attribute
= to_module_attr(attr
);
861 mk
= to_module_kobject(kobj
);
863 if (!attribute
->show
)
866 ret
= attribute
->show(attribute
, mk
, buf
);
871 static ssize_t
module_attr_store(struct kobject
*kobj
,
872 struct attribute
*attr
,
873 const char *buf
, size_t len
)
875 struct module_attribute
*attribute
;
876 struct module_kobject
*mk
;
879 attribute
= to_module_attr(attr
);
880 mk
= to_module_kobject(kobj
);
882 if (!attribute
->store
)
885 ret
= attribute
->store(attribute
, mk
, buf
, len
);
890 static const struct sysfs_ops module_sysfs_ops
= {
891 .show
= module_attr_show
,
892 .store
= module_attr_store
,
895 static int uevent_filter(struct kset
*kset
, struct kobject
*kobj
)
897 struct kobj_type
*ktype
= get_ktype(kobj
);
899 if (ktype
== &module_ktype
)
904 static const struct kset_uevent_ops module_uevent_ops
= {
905 .filter
= uevent_filter
,
908 struct kset
*module_kset
;
909 int module_sysfs_initialized
;
911 struct kobj_type module_ktype
= {
912 .sysfs_ops
= &module_sysfs_ops
,
916 * param_sysfs_init - wrapper for built-in params support
918 static int __init
param_sysfs_init(void)
920 module_kset
= kset_create_and_add("module", &module_uevent_ops
, NULL
);
922 printk(KERN_WARNING
"%s (%d): error creating kset\n",
926 module_sysfs_initialized
= 1;
928 version_sysfs_builtin();
929 param_sysfs_builtin();
933 subsys_initcall(param_sysfs_init
);
935 #endif /* CONFIG_SYSFS */