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>
26 #include <linux/ctype.h>
31 #define DEBUGP(fmt, a...)
34 static inline char dash2underscore(char c)
41 static inline int parameq(const char *input, const char *paramname)
44 for (i = 0; dash2underscore(input[i]) == paramname[i]; i++)
50 static int parse_one(char *param,
52 struct kernel_param *params,
54 int (*handle_unknown)(char *param, char *val))
59 for (i = 0; i < num_params; i++) {
60 if (parameq(param, params[i].name)) {
61 DEBUGP("They are equal! Calling %p\n",
63 return params[i].set(val, ¶ms[i]);
68 DEBUGP("Unknown argument: calling %p\n", handle_unknown);
69 return handle_unknown(param, val);
72 DEBUGP("Unknown argument `%s'\n", param);
76 /* You can use " around spaces, but can't escape ". */
77 /* Hyphens and underscores equivalent in parameter names. */
78 static char *next_arg(char *args, char **param, char **val)
80 unsigned int i, equals = 0;
81 int in_quote = 0, quoted = 0;
90 for (i = 0; args[i]; i++) {
91 if (isspace(args[i]) && !in_quote)
106 *val = args + equals + 1;
108 /* Don't include quotes in value. */
111 if (args[i-1] == '"')
114 if (quoted && args[i-1] == '"')
124 /* Chew up trailing spaces. */
125 return skip_spaces(next);
128 /* Args looks like "foo=bar,bar2 baz=fuz wiz". */
129 int parse_args(const char *name,
131 struct kernel_param *params,
133 int (*unknown)(char *param, char *val))
137 DEBUGP("Parsing ARGS: %s\n", args);
139 /* Chew leading spaces */
140 args = skip_spaces(args);
144 int irq_was_disabled;
146 args = next_arg(args, ¶m, &val);
147 irq_was_disabled = irqs_disabled();
148 ret = parse_one(param, val, params, num, unknown);
149 if (irq_was_disabled && !irqs_disabled()) {
150 printk(KERN_WARNING "parse_args(): option '%s' enabled "
155 printk(KERN_ERR "%s: Unknown parameter `%s'\n",
160 "%s: `%s' too large for parameter `%s'\n",
161 name, val ?: "", param);
167 "%s: `%s' invalid for parameter `%s'\n",
168 name, val ?: "", param);
177 /* Lazy bastard, eh? */
178 #define STANDARD_PARAM_DEF(name, type, format, tmptype, strtolfn) \
179 int param_set_##name(const char *val, struct kernel_param *kp) \
184 if (!val) return -EINVAL; \
185 ret = strtolfn(val, 0, &l); \
186 if (ret == -EINVAL || ((type)l != l)) \
188 *((type *)kp->arg) = l; \
191 int param_get_##name(char *buffer, struct kernel_param *kp) \
193 return sprintf(buffer, format, *((type *)kp->arg)); \
196 STANDARD_PARAM_DEF(byte, unsigned char, "%c", unsigned long, strict_strtoul);
197 STANDARD_PARAM_DEF(short, short, "%hi", long, strict_strtol);
198 STANDARD_PARAM_DEF(ushort, unsigned short, "%hu", unsigned long, strict_strtoul);
199 STANDARD_PARAM_DEF(int, int, "%i", long, strict_strtol);
200 STANDARD_PARAM_DEF(uint, unsigned int, "%u", unsigned long, strict_strtoul);
201 STANDARD_PARAM_DEF(long, long, "%li", long, strict_strtol);
202 STANDARD_PARAM_DEF(ulong, unsigned long, "%lu", unsigned long, strict_strtoul);
204 int param_set_charp(const char *val, struct kernel_param *kp)
207 printk(KERN_ERR "%s: string parameter expected\n",
212 if (strlen(val) > 1024) {
213 printk(KERN_ERR "%s: string parameter too long\n",
218 /* This is a hack. We can't need to strdup in early boot, and we
219 * don't need to; this mangled commandline is preserved. */
220 if (slab_is_available()) {
221 *(char **)kp->arg = kstrdup(val, GFP_KERNEL);
222 if (!*(char **)kp->arg)
225 *(const char **)kp->arg = val;
230 int param_get_charp(char *buffer, struct kernel_param *kp)
232 return sprintf(buffer, "%s", *((char **)kp->arg));
235 /* Actually could be a bool or an int, for historical reasons. */
236 int param_set_bool(const char *val, struct kernel_param *kp)
240 /* No equals means "set"... */
243 /* One of =[yYnN01] */
245 case 'y': case 'Y': case '1':
248 case 'n': case 'N': case '0':
255 if (kp->flags & KPARAM_ISBOOL)
256 *(bool *)kp->arg = v;
262 int param_get_bool(char *buffer, struct kernel_param *kp)
265 if (kp->flags & KPARAM_ISBOOL)
266 val = *(bool *)kp->arg;
268 val = *(int *)kp->arg;
270 /* Y and N chosen as being relatively non-coder friendly */
271 return sprintf(buffer, "%c", val ? 'Y' : 'N');
274 /* This one must be bool. */
275 int param_set_invbool(const char *val, struct kernel_param *kp)
279 struct kernel_param dummy;
281 dummy.arg = &boolval;
282 dummy.flags = KPARAM_ISBOOL;
283 ret = param_set_bool(val, &dummy);
285 *(bool *)kp->arg = !boolval;
289 int param_get_invbool(char *buffer, struct kernel_param *kp)
291 return sprintf(buffer, "%c", (*(bool *)kp->arg) ? 'N' : 'Y');
294 /* We break the rule and mangle the string. */
295 static int param_array(const char *name,
297 unsigned int min, unsigned int max,
298 void *elem, int elemsize,
299 int (*set)(const char *, struct kernel_param *kp),
304 struct kernel_param kp;
307 /* Get the name right for errors. */
312 /* No equals sign? */
314 printk(KERN_ERR "%s: expects arguments\n", name);
319 /* We expect a comma-separated list of values. */
324 printk(KERN_ERR "%s: can only take %i arguments\n",
328 len = strcspn(val, ",");
330 /* nul-terminate and parse */
332 ((char *)val)[len] = '\0';
340 } while (save == ',');
343 printk(KERN_ERR "%s: needs at least %i arguments\n",
350 int param_array_set(const char *val, struct kernel_param *kp)
352 const struct kparam_array *arr = kp->arr;
353 unsigned int temp_num;
355 return param_array(kp->name, val, 1, arr->max, arr->elem,
356 arr->elemsize, arr->set, kp->flags,
357 arr->num ?: &temp_num);
360 int param_array_get(char *buffer, struct kernel_param *kp)
363 const struct kparam_array *arr = kp->arr;
364 struct kernel_param p;
367 for (i = off = 0; i < (arr->num ? *arr->num : arr->max); i++) {
370 p.arg = arr->elem + arr->elemsize * i;
371 ret = arr->get(buffer + off, &p);
380 int param_set_copystring(const char *val, struct kernel_param *kp)
382 const struct kparam_string *kps = kp->str;
385 printk(KERN_ERR "%s: missing param set value\n", kp->name);
388 if (strlen(val)+1 > kps->maxlen) {
389 printk(KERN_ERR "%s: string doesn't fit in %u chars.\n",
390 kp->name, kps->maxlen-1);
393 strcpy(kps->string, val);
397 int param_get_string(char *buffer, struct kernel_param *kp)
399 const struct kparam_string *kps = kp->str;
400 return strlcpy(buffer, kps->string, kps->maxlen);
403 /* sysfs output in /sys/modules/XYZ/parameters/ */
404 #define to_module_attr(n) container_of(n, struct module_attribute, attr)
405 #define to_module_kobject(n) container_of(n, struct module_kobject, kobj)
407 extern struct kernel_param __start___param[], __stop___param[];
409 struct param_attribute
411 struct module_attribute mattr;
412 struct kernel_param *param;
415 struct module_param_attrs
418 struct attribute_group grp;
419 struct param_attribute attrs[0];
423 #define to_param_attr(n) container_of(n, struct param_attribute, mattr)
425 static ssize_t param_attr_show(struct module_attribute *mattr,
426 struct module *mod, char *buf)
429 struct param_attribute *attribute = to_param_attr(mattr);
431 if (!attribute->param->get)
434 count = attribute->param->get(buf, attribute->param);
442 /* sysfs always hands a nul-terminated string in buf. We rely on that. */
443 static ssize_t param_attr_store(struct module_attribute *mattr,
444 struct module *owner,
445 const char *buf, size_t len)
448 struct param_attribute *attribute = to_param_attr(mattr);
450 if (!attribute->param->set)
453 err = attribute->param->set(buf, attribute->param);
460 #ifdef CONFIG_MODULES
463 #define __modinit __init
468 * add_sysfs_param - add a parameter to sysfs
469 * @mk: struct module_kobject
470 * @kparam: the actual parameter definition to add to sysfs
471 * @name: name of parameter
473 * Create a kobject if for a (per-module) parameter if mp NULL, and
474 * create file in sysfs. Returns an error on out of memory. Always cleans up
475 * if there's an error.
477 static __modinit int add_sysfs_param(struct module_kobject *mk,
478 struct kernel_param *kp,
481 struct module_param_attrs *new;
482 struct attribute **attrs;
485 /* We don't bother calling this with invisible parameters. */
493 attrs = mk->mp->grp.attrs;
497 new = krealloc(mk->mp,
498 sizeof(*mk->mp) + sizeof(mk->mp->attrs[0]) * (num+1),
505 attrs = krealloc(attrs, sizeof(new->grp.attrs[0])*(num+2), GFP_KERNEL);
511 /* Sysfs wants everything zeroed. */
512 memset(new, 0, sizeof(*new));
513 memset(&new->attrs[num], 0, sizeof(new->attrs[num]));
514 memset(&attrs[num], 0, sizeof(attrs[num]));
515 new->grp.name = "parameters";
516 new->grp.attrs = attrs;
518 /* Tack new one on the end. */
519 sysfs_attr_init(&new->attrs[num].mattr.attr);
520 new->attrs[num].param = kp;
521 new->attrs[num].mattr.show = param_attr_show;
522 new->attrs[num].mattr.store = param_attr_store;
523 new->attrs[num].mattr.attr.name = (char *)name;
524 new->attrs[num].mattr.attr.mode = kp->perm;
527 /* Fix up all the pointers, since krealloc can move us */
528 for (num = 0; num < new->num; num++)
529 new->grp.attrs[num] = &new->attrs[num].mattr.attr;
530 new->grp.attrs[num] = NULL;
542 #ifdef CONFIG_MODULES
543 static void free_module_param_attrs(struct module_kobject *mk)
545 kfree(mk->mp->grp.attrs);
551 * module_param_sysfs_setup - setup sysfs support for one module
553 * @kparam: module parameters (array)
554 * @num_params: number of module parameters
556 * Adds sysfs entries for module parameters under
557 * /sys/module/[mod->name]/parameters/
559 int module_param_sysfs_setup(struct module *mod,
560 struct kernel_param *kparam,
561 unsigned int num_params)
566 for (i = 0; i < num_params; i++) {
567 if (kparam[i].perm == 0)
569 err = add_sysfs_param(&mod->mkobj, &kparam[i], kparam[i].name);
578 /* Create the param group. */
579 err = sysfs_create_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp);
581 free_module_param_attrs(&mod->mkobj);
586 * module_param_sysfs_remove - remove sysfs support for one module
589 * Remove sysfs entries for module parameters and the corresponding
592 void module_param_sysfs_remove(struct module *mod)
595 sysfs_remove_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp);
596 /* We are positive that no one is using any param
597 * attrs at this point. Deallocate immediately. */
598 free_module_param_attrs(&mod->mkobj);
603 void destroy_params(const struct kernel_param *params, unsigned num)
605 /* FIXME: This should free kmalloced charp parameters. It doesn't. */
608 static void __init kernel_add_sysfs_param(const char *name,
609 struct kernel_param *kparam,
610 unsigned int name_skip)
612 struct module_kobject *mk;
613 struct kobject *kobj;
616 kobj = kset_find_obj(module_kset, name);
618 /* We already have one. Remove params so we can add more. */
619 mk = to_module_kobject(kobj);
620 /* We need to remove it before adding parameters. */
621 sysfs_remove_group(&mk->kobj, &mk->mp->grp);
623 mk = kzalloc(sizeof(struct module_kobject), GFP_KERNEL);
626 mk->mod = THIS_MODULE;
627 mk->kobj.kset = module_kset;
628 err = kobject_init_and_add(&mk->kobj, &module_ktype, NULL,
631 kobject_put(&mk->kobj);
632 printk(KERN_ERR "Module '%s' failed add to sysfs, "
633 "error number %d\n", name, err);
634 printk(KERN_ERR "The system will be unstable now.\n");
637 /* So that exit path is even. */
638 kobject_get(&mk->kobj);
641 /* These should not fail at boot. */
642 err = add_sysfs_param(mk, kparam, kparam->name + name_skip);
644 err = sysfs_create_group(&mk->kobj, &mk->mp->grp);
646 kobject_uevent(&mk->kobj, KOBJ_ADD);
647 kobject_put(&mk->kobj);
651 * param_sysfs_builtin - add contents in /sys/parameters for built-in modules
653 * Add module_parameters to sysfs for "modules" built into the kernel.
655 * The "module" name (KBUILD_MODNAME) is stored before a dot, the
656 * "parameter" name is stored behind a dot in kernel_param->name. So,
657 * extract the "module" name for all built-in kernel_param-eters,
658 * and for all who have the same, call kernel_add_sysfs_param.
660 static void __init param_sysfs_builtin(void)
662 struct kernel_param *kp;
663 unsigned int name_len;
664 char modname[MODULE_NAME_LEN];
666 for (kp = __start___param; kp < __stop___param; kp++) {
672 dot = strchr(kp->name, '.');
674 /* This happens for core_param() */
675 strcpy(modname, "kernel");
678 name_len = dot - kp->name + 1;
679 strlcpy(modname, kp->name, name_len);
681 kernel_add_sysfs_param(modname, kp, name_len);
686 /* module-related sysfs stuff */
688 static ssize_t module_attr_show(struct kobject *kobj,
689 struct attribute *attr,
692 struct module_attribute *attribute;
693 struct module_kobject *mk;
696 attribute = to_module_attr(attr);
697 mk = to_module_kobject(kobj);
699 if (!attribute->show)
702 ret = attribute->show(attribute, mk->mod, buf);
707 static ssize_t module_attr_store(struct kobject *kobj,
708 struct attribute *attr,
709 const char *buf, size_t len)
711 struct module_attribute *attribute;
712 struct module_kobject *mk;
715 attribute = to_module_attr(attr);
716 mk = to_module_kobject(kobj);
718 if (!attribute->store)
721 ret = attribute->store(attribute, mk->mod, buf, len);
726 static const struct sysfs_ops module_sysfs_ops = {
727 .show = module_attr_show,
728 .store = module_attr_store,
731 static int uevent_filter(struct kset *kset, struct kobject *kobj)
733 struct kobj_type *ktype = get_ktype(kobj);
735 if (ktype == &module_ktype)
740 static const struct kset_uevent_ops module_uevent_ops = {
741 .filter = uevent_filter,
744 struct kset *module_kset;
745 int module_sysfs_initialized;
747 struct kobj_type module_ktype = {
748 .sysfs_ops = &module_sysfs_ops,
752 * param_sysfs_init - wrapper for built-in params support
754 static int __init param_sysfs_init(void)
756 module_kset = kset_create_and_add("module", &module_uevent_ops, NULL);
758 printk(KERN_WARNING "%s (%d): error creating kset\n",
762 module_sysfs_initialized = 1;
764 param_sysfs_builtin();
768 subsys_initcall(param_sysfs_init);
770 #endif /* CONFIG_SYSFS */
772 EXPORT_SYMBOL(param_set_byte);
773 EXPORT_SYMBOL(param_get_byte);
774 EXPORT_SYMBOL(param_set_short);
775 EXPORT_SYMBOL(param_get_short);
776 EXPORT_SYMBOL(param_set_ushort);
777 EXPORT_SYMBOL(param_get_ushort);
778 EXPORT_SYMBOL(param_set_int);
779 EXPORT_SYMBOL(param_get_int);
780 EXPORT_SYMBOL(param_set_uint);
781 EXPORT_SYMBOL(param_get_uint);
782 EXPORT_SYMBOL(param_set_long);
783 EXPORT_SYMBOL(param_get_long);
784 EXPORT_SYMBOL(param_set_ulong);
785 EXPORT_SYMBOL(param_get_ulong);
786 EXPORT_SYMBOL(param_set_charp);
787 EXPORT_SYMBOL(param_get_charp);
788 EXPORT_SYMBOL(param_set_bool);
789 EXPORT_SYMBOL(param_get_bool);
790 EXPORT_SYMBOL(param_set_invbool);
791 EXPORT_SYMBOL(param_get_invbool);
792 EXPORT_SYMBOL(param_array_set);
793 EXPORT_SYMBOL(param_array_get);
794 EXPORT_SYMBOL(param_set_copystring);
795 EXPORT_SYMBOL(param_get_string);