1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /* Helpers for initial module or kernel cmdline parsing
3 Copyright (C) 2001 Rusty Russell.
6 #include <linux/kernel.h>
7 #include <linux/string.h>
8 #include <linux/errno.h>
9 #include <linux/module.h>
10 #include <linux/moduleparam.h>
11 #include <linux/device.h>
12 #include <linux/err.h>
13 #include <linux/slab.h>
14 #include <linux/ctype.h>
15 #include <linux/security.h>
18 /* Protects all built-in parameters, modules use their own param_lock */
19 static DEFINE_MUTEX(param_lock);
21 /* Use the module's mutex, or if built-in use the built-in mutex */
23 #define KPARAM_MUTEX(mod) ((mod) ? &(mod)->param_lock : ¶m_lock)
25 #define KPARAM_MUTEX(mod) (¶m_lock)
28 static inline void check_kparam_locked(struct module *mod)
30 BUG_ON(!mutex_is_locked(KPARAM_MUTEX(mod)));
33 static inline void check_kparam_locked(struct module *mod)
36 #endif /* !CONFIG_SYSFS */
38 /* This just allows us to keep track of which parameters are kmalloced. */
39 struct kmalloced_param {
40 struct list_head list;
43 static LIST_HEAD(kmalloced_params);
44 static DEFINE_SPINLOCK(kmalloced_params_lock);
46 static void *kmalloc_parameter(unsigned int size)
48 struct kmalloced_param *p;
50 p = kmalloc(sizeof(*p) + size, GFP_KERNEL);
54 spin_lock(&kmalloced_params_lock);
55 list_add(&p->list, &kmalloced_params);
56 spin_unlock(&kmalloced_params_lock);
61 /* Does nothing if parameter wasn't kmalloced above. */
62 static void maybe_kfree_parameter(void *param)
64 struct kmalloced_param *p;
66 spin_lock(&kmalloced_params_lock);
67 list_for_each_entry(p, &kmalloced_params, list) {
68 if (p->val == param) {
74 spin_unlock(&kmalloced_params_lock);
77 static char dash2underscore(char c)
84 bool parameqn(const char *a, const char *b, size_t n)
88 for (i = 0; i < n; i++) {
89 if (dash2underscore(a[i]) != dash2underscore(b[i]))
95 bool parameq(const char *a, const char *b)
97 return parameqn(a, b, strlen(a)+1);
100 static bool param_check_unsafe(const struct kernel_param *kp)
102 if (kp->flags & KERNEL_PARAM_FL_HWPARAM &&
103 security_locked_down(LOCKDOWN_MODULE_PARAMETERS))
106 if (kp->flags & KERNEL_PARAM_FL_UNSAFE) {
107 pr_notice("Setting dangerous option %s - tainting kernel\n",
109 add_taint(TAINT_USER, LOCKDEP_STILL_OK);
115 static int parse_one(char *param,
118 const struct kernel_param *params,
123 int (*handle_unknown)(char *param, char *val,
124 const char *doing, void *arg))
130 for (i = 0; i < num_params; i++) {
131 if (parameq(param, params[i].name)) {
132 if (params[i].level < min_level
133 || params[i].level > max_level)
135 /* No one handled NULL, so do it here. */
137 !(params[i].ops->flags & KERNEL_PARAM_OPS_FL_NOARG))
139 pr_debug("handling %s with %p\n", param,
141 kernel_param_lock(params[i].mod);
142 if (param_check_unsafe(¶ms[i]))
143 err = params[i].ops->set(val, ¶ms[i]);
146 kernel_param_unlock(params[i].mod);
151 if (handle_unknown) {
152 pr_debug("doing %s: %s='%s'\n", doing, param, val);
153 return handle_unknown(param, val, doing, arg);
156 pr_debug("Unknown argument '%s'\n", param);
160 /* Args looks like "foo=bar,bar2 baz=fuz wiz". */
161 char *parse_args(const char *doing,
163 const struct kernel_param *params,
168 int (*unknown)(char *param, char *val,
169 const char *doing, void *arg))
171 char *param, *val, *err = NULL;
173 /* Chew leading spaces */
174 args = skip_spaces(args);
177 pr_debug("doing %s, parsing ARGS: '%s'\n", doing, args);
181 int irq_was_disabled;
183 args = next_arg(args, ¶m, &val);
185 if (!val && strcmp(param, "--") == 0)
187 irq_was_disabled = irqs_disabled();
188 ret = parse_one(param, val, doing, params, num,
189 min_level, max_level, arg, unknown);
190 if (irq_was_disabled && !irqs_disabled())
191 pr_warn("%s: option '%s' enabled irq's!\n",
198 pr_err("%s: Unknown parameter `%s'\n", doing, param);
201 pr_err("%s: `%s' too large for parameter `%s'\n",
202 doing, val ?: "", param);
205 pr_err("%s: `%s' invalid for parameter `%s'\n",
206 doing, val ?: "", param);
216 /* Lazy bastard, eh? */
217 #define STANDARD_PARAM_DEF(name, type, format, strtolfn) \
218 int param_set_##name(const char *val, const struct kernel_param *kp) \
220 return strtolfn(val, 0, (type *)kp->arg); \
222 int param_get_##name(char *buffer, const struct kernel_param *kp) \
224 return scnprintf(buffer, PAGE_SIZE, format "\n", \
225 *((type *)kp->arg)); \
227 const struct kernel_param_ops param_ops_##name = { \
228 .set = param_set_##name, \
229 .get = param_get_##name, \
231 EXPORT_SYMBOL(param_set_##name); \
232 EXPORT_SYMBOL(param_get_##name); \
233 EXPORT_SYMBOL(param_ops_##name)
236 STANDARD_PARAM_DEF(byte, unsigned char, "%hhu", kstrtou8);
237 STANDARD_PARAM_DEF(short, short, "%hi", kstrtos16);
238 STANDARD_PARAM_DEF(ushort, unsigned short, "%hu", kstrtou16);
239 STANDARD_PARAM_DEF(int, int, "%i", kstrtoint);
240 STANDARD_PARAM_DEF(uint, unsigned int, "%u", kstrtouint);
241 STANDARD_PARAM_DEF(long, long, "%li", kstrtol);
242 STANDARD_PARAM_DEF(ulong, unsigned long, "%lu", kstrtoul);
243 STANDARD_PARAM_DEF(ullong, unsigned long long, "%llu", kstrtoull);
244 STANDARD_PARAM_DEF(hexint, unsigned int, "%#08x", kstrtouint);
246 int param_set_charp(const char *val, const struct kernel_param *kp)
248 if (strlen(val) > 1024) {
249 pr_err("%s: string parameter too long\n", kp->name);
253 maybe_kfree_parameter(*(char **)kp->arg);
255 /* This is a hack. We can't kmalloc in early boot, and we
256 * don't need to; this mangled commandline is preserved. */
257 if (slab_is_available()) {
258 *(char **)kp->arg = kmalloc_parameter(strlen(val)+1);
259 if (!*(char **)kp->arg)
261 strcpy(*(char **)kp->arg, val);
263 *(const char **)kp->arg = val;
267 EXPORT_SYMBOL(param_set_charp);
269 int param_get_charp(char *buffer, const struct kernel_param *kp)
271 return scnprintf(buffer, PAGE_SIZE, "%s\n", *((char **)kp->arg));
273 EXPORT_SYMBOL(param_get_charp);
275 void param_free_charp(void *arg)
277 maybe_kfree_parameter(*((char **)arg));
279 EXPORT_SYMBOL(param_free_charp);
281 const struct kernel_param_ops param_ops_charp = {
282 .set = param_set_charp,
283 .get = param_get_charp,
284 .free = param_free_charp,
286 EXPORT_SYMBOL(param_ops_charp);
288 /* Actually could be a bool or an int, for historical reasons. */
289 int param_set_bool(const char *val, const struct kernel_param *kp)
291 /* No equals means "set"... */
294 /* One of =[yYnN01] */
295 return strtobool(val, kp->arg);
297 EXPORT_SYMBOL(param_set_bool);
299 int param_get_bool(char *buffer, const struct kernel_param *kp)
301 /* Y and N chosen as being relatively non-coder friendly */
302 return sprintf(buffer, "%c\n", *(bool *)kp->arg ? 'Y' : 'N');
304 EXPORT_SYMBOL(param_get_bool);
306 const struct kernel_param_ops param_ops_bool = {
307 .flags = KERNEL_PARAM_OPS_FL_NOARG,
308 .set = param_set_bool,
309 .get = param_get_bool,
311 EXPORT_SYMBOL(param_ops_bool);
313 int param_set_bool_enable_only(const char *val, const struct kernel_param *kp)
317 bool orig_value = *(bool *)kp->arg;
318 struct kernel_param dummy_kp = *kp;
320 dummy_kp.arg = &new_value;
322 err = param_set_bool(val, &dummy_kp);
326 /* Don't let them unset it once it's set! */
327 if (!new_value && orig_value)
331 err = param_set_bool(val, kp);
335 EXPORT_SYMBOL_GPL(param_set_bool_enable_only);
337 const struct kernel_param_ops param_ops_bool_enable_only = {
338 .flags = KERNEL_PARAM_OPS_FL_NOARG,
339 .set = param_set_bool_enable_only,
340 .get = param_get_bool,
342 EXPORT_SYMBOL_GPL(param_ops_bool_enable_only);
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 ret = param_set_bool(val, &dummy);
354 *(bool *)kp->arg = !boolval;
357 EXPORT_SYMBOL(param_set_invbool);
359 int param_get_invbool(char *buffer, const struct kernel_param *kp)
361 return sprintf(buffer, "%c\n", (*(bool *)kp->arg) ? 'N' : 'Y');
363 EXPORT_SYMBOL(param_get_invbool);
365 const struct kernel_param_ops param_ops_invbool = {
366 .set = param_set_invbool,
367 .get = param_get_invbool,
369 EXPORT_SYMBOL(param_ops_invbool);
371 int param_set_bint(const char *val, const struct kernel_param *kp)
373 /* Match bool exactly, by re-using it. */
374 struct kernel_param boolkp = *kp;
380 ret = param_set_bool(val, &boolkp);
385 EXPORT_SYMBOL(param_set_bint);
387 const struct kernel_param_ops param_ops_bint = {
388 .flags = KERNEL_PARAM_OPS_FL_NOARG,
389 .set = param_set_bint,
390 .get = param_get_int,
392 EXPORT_SYMBOL(param_ops_bint);
394 /* We break the rule and mangle the string. */
395 static int param_array(struct module *mod,
398 unsigned int min, unsigned int max,
399 void *elem, int elemsize,
400 int (*set)(const char *, const struct kernel_param *kp),
405 struct kernel_param kp;
408 /* Get the name right for errors. */
414 /* We expect a comma-separated list of values. */
419 pr_err("%s: can only take %i arguments\n", name, max);
422 len = strcspn(val, ",");
424 /* nul-terminate and parse */
426 ((char *)val)[len] = '\0';
427 check_kparam_locked(mod);
435 } while (save == ',');
438 pr_err("%s: needs at least %i arguments\n", name, min);
444 static int param_array_set(const char *val, const struct kernel_param *kp)
446 const struct kparam_array *arr = kp->arr;
447 unsigned int temp_num;
449 return param_array(kp->mod, kp->name, val, 1, arr->max, arr->elem,
450 arr->elemsize, arr->ops->set, kp->level,
451 arr->num ?: &temp_num);
454 static int param_array_get(char *buffer, const struct kernel_param *kp)
457 const struct kparam_array *arr = kp->arr;
458 struct kernel_param p = *kp;
460 for (i = off = 0; i < (arr->num ? *arr->num : arr->max); i++) {
461 /* Replace \n with comma */
463 buffer[off - 1] = ',';
464 p.arg = arr->elem + arr->elemsize * i;
465 check_kparam_locked(p.mod);
466 ret = arr->ops->get(buffer + off, &p);
475 static void param_array_free(void *arg)
478 const struct kparam_array *arr = arg;
481 for (i = 0; i < (arr->num ? *arr->num : arr->max); i++)
482 arr->ops->free(arr->elem + arr->elemsize * i);
485 const struct kernel_param_ops param_array_ops = {
486 .set = param_array_set,
487 .get = param_array_get,
488 .free = param_array_free,
490 EXPORT_SYMBOL(param_array_ops);
492 int param_set_copystring(const char *val, const struct kernel_param *kp)
494 const struct kparam_string *kps = kp->str;
496 if (strlen(val)+1 > kps->maxlen) {
497 pr_err("%s: string doesn't fit in %u chars.\n",
498 kp->name, kps->maxlen-1);
501 strcpy(kps->string, val);
504 EXPORT_SYMBOL(param_set_copystring);
506 int param_get_string(char *buffer, const struct kernel_param *kp)
508 const struct kparam_string *kps = kp->str;
509 return scnprintf(buffer, PAGE_SIZE, "%s\n", kps->string);
511 EXPORT_SYMBOL(param_get_string);
513 const struct kernel_param_ops param_ops_string = {
514 .set = param_set_copystring,
515 .get = param_get_string,
517 EXPORT_SYMBOL(param_ops_string);
519 /* sysfs output in /sys/modules/XYZ/parameters/ */
520 #define to_module_attr(n) container_of(n, struct module_attribute, attr)
521 #define to_module_kobject(n) container_of(n, struct module_kobject, kobj)
523 struct param_attribute
525 struct module_attribute mattr;
526 const struct kernel_param *param;
529 struct module_param_attrs
532 struct attribute_group grp;
533 struct param_attribute attrs[];
537 #define to_param_attr(n) container_of(n, struct param_attribute, mattr)
539 static ssize_t param_attr_show(struct module_attribute *mattr,
540 struct module_kobject *mk, char *buf)
543 struct param_attribute *attribute = to_param_attr(mattr);
545 if (!attribute->param->ops->get)
548 kernel_param_lock(mk->mod);
549 count = attribute->param->ops->get(buf, attribute->param);
550 kernel_param_unlock(mk->mod);
554 /* sysfs always hands a nul-terminated string in buf. We rely on that. */
555 static ssize_t param_attr_store(struct module_attribute *mattr,
556 struct module_kobject *mk,
557 const char *buf, size_t len)
560 struct param_attribute *attribute = to_param_attr(mattr);
562 if (!attribute->param->ops->set)
565 kernel_param_lock(mk->mod);
566 if (param_check_unsafe(attribute->param))
567 err = attribute->param->ops->set(buf, attribute->param);
570 kernel_param_unlock(mk->mod);
577 #ifdef CONFIG_MODULES
580 #define __modinit __init
584 void kernel_param_lock(struct module *mod)
586 mutex_lock(KPARAM_MUTEX(mod));
589 void kernel_param_unlock(struct module *mod)
591 mutex_unlock(KPARAM_MUTEX(mod));
594 EXPORT_SYMBOL(kernel_param_lock);
595 EXPORT_SYMBOL(kernel_param_unlock);
598 * add_sysfs_param - add a parameter to sysfs
599 * @mk: struct module_kobject
600 * @kp: the actual parameter definition to add to sysfs
601 * @name: name of parameter
603 * Create a kobject if for a (per-module) parameter if mp NULL, and
604 * create file in sysfs. Returns an error on out of memory. Always cleans up
605 * if there's an error.
607 static __modinit int add_sysfs_param(struct module_kobject *mk,
608 const struct kernel_param *kp,
611 struct module_param_attrs *new_mp;
612 struct attribute **new_attrs;
615 /* We don't bother calling this with invisible parameters. */
619 /* First allocation. */
620 mk->mp = kzalloc(sizeof(*mk->mp), GFP_KERNEL);
623 mk->mp->grp.name = "parameters";
624 /* NULL-terminated attribute array. */
625 mk->mp->grp.attrs = kzalloc(sizeof(mk->mp->grp.attrs[0]),
627 /* Caller will cleanup via free_module_param_attrs */
628 if (!mk->mp->grp.attrs)
632 /* Enlarge allocations. */
633 new_mp = krealloc(mk->mp,
635 sizeof(mk->mp->attrs[0]) * (mk->mp->num + 1),
641 /* Extra pointer for NULL terminator */
642 new_attrs = krealloc(mk->mp->grp.attrs,
643 sizeof(mk->mp->grp.attrs[0]) * (mk->mp->num + 2),
647 mk->mp->grp.attrs = new_attrs;
649 /* Tack new one on the end. */
650 memset(&mk->mp->attrs[mk->mp->num], 0, sizeof(mk->mp->attrs[0]));
651 sysfs_attr_init(&mk->mp->attrs[mk->mp->num].mattr.attr);
652 mk->mp->attrs[mk->mp->num].param = kp;
653 mk->mp->attrs[mk->mp->num].mattr.show = param_attr_show;
654 /* Do not allow runtime DAC changes to make param writable. */
655 if ((kp->perm & (S_IWUSR | S_IWGRP | S_IWOTH)) != 0)
656 mk->mp->attrs[mk->mp->num].mattr.store = param_attr_store;
658 mk->mp->attrs[mk->mp->num].mattr.store = NULL;
659 mk->mp->attrs[mk->mp->num].mattr.attr.name = (char *)name;
660 mk->mp->attrs[mk->mp->num].mattr.attr.mode = kp->perm;
663 /* Fix up all the pointers, since krealloc can move us */
664 for (i = 0; i < mk->mp->num; i++)
665 mk->mp->grp.attrs[i] = &mk->mp->attrs[i].mattr.attr;
666 mk->mp->grp.attrs[mk->mp->num] = NULL;
670 #ifdef CONFIG_MODULES
671 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);
700 free_module_param_attrs(&mod->mkobj);
709 /* Create the param group. */
710 err = sysfs_create_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp);
712 free_module_param_attrs(&mod->mkobj);
717 * module_param_sysfs_remove - remove sysfs support for one module
720 * Remove sysfs entries for module parameters and the corresponding
723 void module_param_sysfs_remove(struct module *mod)
726 sysfs_remove_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp);
727 /* We are positive that no one is using any param
728 * attrs at this point. Deallocate immediately. */
729 free_module_param_attrs(&mod->mkobj);
734 void destroy_params(const struct kernel_param *params, unsigned num)
738 for (i = 0; i < num; i++)
739 if (params[i].ops->free)
740 params[i].ops->free(params[i].arg);
743 static struct module_kobject * __init locate_module_kobject(const char *name)
745 struct module_kobject *mk;
746 struct kobject *kobj;
749 kobj = kset_find_obj(module_kset, name);
751 mk = to_module_kobject(kobj);
753 mk = kzalloc(sizeof(struct module_kobject), GFP_KERNEL);
756 mk->mod = THIS_MODULE;
757 mk->kobj.kset = module_kset;
758 err = kobject_init_and_add(&mk->kobj, &module_ktype, NULL,
760 #ifdef CONFIG_MODULES
762 err = sysfs_create_file(&mk->kobj, &module_uevent.attr);
765 kobject_put(&mk->kobj);
766 pr_crit("Adding module '%s' to sysfs failed (%d), the system may be unstable.\n",
771 /* So that we hold reference in both cases. */
772 kobject_get(&mk->kobj);
778 static void __init kernel_add_sysfs_param(const char *name,
779 const struct kernel_param *kparam,
780 unsigned int name_skip)
782 struct module_kobject *mk;
785 mk = locate_module_kobject(name);
789 /* We need to remove old parameters before adding more. */
791 sysfs_remove_group(&mk->kobj, &mk->mp->grp);
793 /* These should not fail at boot. */
794 err = add_sysfs_param(mk, kparam, kparam->name + name_skip);
796 err = sysfs_create_group(&mk->kobj, &mk->mp->grp);
798 kobject_uevent(&mk->kobj, KOBJ_ADD);
799 kobject_put(&mk->kobj);
803 * param_sysfs_builtin - add sysfs parameters for built-in modules
805 * Add module_parameters to sysfs for "modules" built into the kernel.
807 * The "module" name (KBUILD_MODNAME) is stored before a dot, the
808 * "parameter" name is stored behind a dot in kernel_param->name. So,
809 * extract the "module" name for all built-in kernel_param-eters,
810 * and for all who have the same, call kernel_add_sysfs_param.
812 static void __init param_sysfs_builtin(void)
814 const struct kernel_param *kp;
815 unsigned int name_len;
816 char modname[MODULE_NAME_LEN];
818 for (kp = __start___param; kp < __stop___param; kp++) {
824 dot = strchr(kp->name, '.');
826 /* This happens for core_param() */
827 strcpy(modname, "kernel");
830 name_len = dot - kp->name + 1;
831 strlcpy(modname, kp->name, name_len);
833 kernel_add_sysfs_param(modname, kp, name_len);
837 ssize_t __modver_version_show(struct module_attribute *mattr,
838 struct module_kobject *mk, char *buf)
840 struct module_version_attribute *vattr =
841 container_of(mattr, struct module_version_attribute, mattr);
843 return scnprintf(buf, PAGE_SIZE, "%s\n", vattr->version);
846 extern const struct module_version_attribute __start___modver[];
847 extern const struct module_version_attribute __stop___modver[];
849 static void __init version_sysfs_builtin(void)
851 const struct module_version_attribute *vattr;
852 struct module_kobject *mk;
855 for (vattr = __start___modver; vattr < __stop___modver; vattr++) {
856 mk = locate_module_kobject(vattr->module_name);
858 err = sysfs_create_file(&mk->kobj, &vattr->mattr.attr);
860 kobject_uevent(&mk->kobj, KOBJ_ADD);
861 kobject_put(&mk->kobj);
866 /* module-related sysfs stuff */
868 static ssize_t module_attr_show(struct kobject *kobj,
869 struct attribute *attr,
872 struct module_attribute *attribute;
873 struct module_kobject *mk;
876 attribute = to_module_attr(attr);
877 mk = to_module_kobject(kobj);
879 if (!attribute->show)
882 ret = attribute->show(attribute, mk, buf);
887 static ssize_t module_attr_store(struct kobject *kobj,
888 struct attribute *attr,
889 const char *buf, size_t len)
891 struct module_attribute *attribute;
892 struct module_kobject *mk;
895 attribute = to_module_attr(attr);
896 mk = to_module_kobject(kobj);
898 if (!attribute->store)
901 ret = attribute->store(attribute, mk, buf, len);
906 static const struct sysfs_ops module_sysfs_ops = {
907 .show = module_attr_show,
908 .store = module_attr_store,
911 static int uevent_filter(struct kset *kset, struct kobject *kobj)
913 struct kobj_type *ktype = get_ktype(kobj);
915 if (ktype == &module_ktype)
920 static const struct kset_uevent_ops module_uevent_ops = {
921 .filter = uevent_filter,
924 struct kset *module_kset;
925 int module_sysfs_initialized;
927 static void module_kobj_release(struct kobject *kobj)
929 struct module_kobject *mk = to_module_kobject(kobj);
930 complete(mk->kobj_completion);
933 struct kobj_type module_ktype = {
934 .release = module_kobj_release,
935 .sysfs_ops = &module_sysfs_ops,
939 * param_sysfs_init - wrapper for built-in params support
941 static int __init param_sysfs_init(void)
943 module_kset = kset_create_and_add("module", &module_uevent_ops, NULL);
945 printk(KERN_WARNING "%s (%d): error creating kset\n",
949 module_sysfs_initialized = 1;
951 version_sysfs_builtin();
952 param_sysfs_builtin();
956 subsys_initcall(param_sysfs_init);
958 #endif /* CONFIG_SYSFS */