blob: cf448785d0586d72b34366de83362342de4d9838 [file] [log] [blame]
Thomas Gleixner1a59d1b82019-05-27 08:55:05 +02001// SPDX-License-Identifier: GPL-2.0-or-later
Linus Torvalds1da177e2005-04-16 15:20:36 -07002/* Helpers for initial module or kernel cmdline parsing
3 Copyright (C) 2001 Rusty Russell.
4
Linus Torvalds1da177e2005-04-16 15:20:36 -07005*/
Linus Torvalds1da177e2005-04-16 15:20:36 -07006#include <linux/kernel.h>
7#include <linux/string.h>
8#include <linux/errno.h>
9#include <linux/module.h>
Geert Uytterhoeven63a12d92014-10-13 15:55:44 -070010#include <linux/moduleparam.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070011#include <linux/device.h>
12#include <linux/err.h>
Tim Schmielau4e57b682005-10-30 15:03:48 -080013#include <linux/slab.h>
Peter Oberparleiter26d052b2009-07-06 17:11:22 +020014#include <linux/ctype.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070015
Rusty Russellcf2fde72015-06-26 06:44:38 +093016#ifdef CONFIG_SYSFS
Dan Streetmanb51d23e2015-06-17 06:18:52 +093017/* Protects all built-in parameters, modules use their own param_lock */
Rusty Russell907b29e2010-08-11 23:04:19 -060018static DEFINE_MUTEX(param_lock);
19
Dan Streetmanb51d23e2015-06-17 06:18:52 +093020/* Use the module's mutex, or if built-in use the built-in mutex */
Stephen Rothwell20bdc2c2015-06-26 13:19:19 +100021#ifdef CONFIG_MODULES
Dan Streetmanb51d23e2015-06-17 06:18:52 +093022#define KPARAM_MUTEX(mod) ((mod) ? &(mod)->param_lock : &param_lock)
Stephen Rothwell20bdc2c2015-06-26 13:19:19 +100023#else
24#define KPARAM_MUTEX(mod) (&param_lock)
25#endif
Rusty Russellcf2fde72015-06-26 06:44:38 +093026
27static inline void check_kparam_locked(struct module *mod)
28{
29 BUG_ON(!mutex_is_locked(KPARAM_MUTEX(mod)));
30}
31#else
32static inline void check_kparam_locked(struct module *mod)
33{
34}
35#endif /* !CONFIG_SYSFS */
Dan Streetmanb51d23e2015-06-17 06:18:52 +093036
Rusty Russella1054322010-08-11 23:04:18 -060037/* This just allows us to keep track of which parameters are kmalloced. */
38struct kmalloced_param {
39 struct list_head list;
40 char val[];
41};
Rusty Russella1054322010-08-11 23:04:18 -060042static LIST_HEAD(kmalloced_params);
Dan Streetmanb51d23e2015-06-17 06:18:52 +093043static DEFINE_SPINLOCK(kmalloced_params_lock);
Rusty Russella1054322010-08-11 23:04:18 -060044
45static void *kmalloc_parameter(unsigned int size)
46{
47 struct kmalloced_param *p;
48
49 p = kmalloc(sizeof(*p) + size, GFP_KERNEL);
50 if (!p)
51 return NULL;
52
Dan Streetmanb51d23e2015-06-17 06:18:52 +093053 spin_lock(&kmalloced_params_lock);
Rusty Russella1054322010-08-11 23:04:18 -060054 list_add(&p->list, &kmalloced_params);
Dan Streetmanb51d23e2015-06-17 06:18:52 +093055 spin_unlock(&kmalloced_params_lock);
56
Rusty Russella1054322010-08-11 23:04:18 -060057 return p->val;
58}
59
60/* Does nothing if parameter wasn't kmalloced above. */
61static void maybe_kfree_parameter(void *param)
62{
63 struct kmalloced_param *p;
64
Dan Streetmanb51d23e2015-06-17 06:18:52 +093065 spin_lock(&kmalloced_params_lock);
Rusty Russella1054322010-08-11 23:04:18 -060066 list_for_each_entry(p, &kmalloced_params, list) {
67 if (p->val == param) {
68 list_del(&p->list);
69 kfree(p);
70 break;
71 }
72 }
Dan Streetmanb51d23e2015-06-17 06:18:52 +093073 spin_unlock(&kmalloced_params_lock);
Rusty Russella1054322010-08-11 23:04:18 -060074}
75
Michal Schmidtb1e4d202011-10-10 00:03:37 +020076static char dash2underscore(char c)
Linus Torvalds1da177e2005-04-16 15:20:36 -070077{
78 if (c == '-')
79 return '_';
80 return c;
81}
82
Michal Schmidtb1e4d202011-10-10 00:03:37 +020083bool parameqn(const char *a, const char *b, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -070084{
Michal Schmidtb1e4d202011-10-10 00:03:37 +020085 size_t i;
86
87 for (i = 0; i < n; i++) {
88 if (dash2underscore(a[i]) != dash2underscore(b[i]))
89 return false;
90 }
91 return true;
92}
93
94bool parameq(const char *a, const char *b)
95{
96 return parameqn(a, b, strlen(a)+1);
Linus Torvalds1da177e2005-04-16 15:20:36 -070097}
98
Rusty Russell7a486d372014-08-27 06:25:23 +093099static void param_check_unsafe(const struct kernel_param *kp)
100{
101 if (kp->flags & KERNEL_PARAM_FL_UNSAFE) {
Chris Wilsonedc41b32018-04-10 16:35:18 -0700102 pr_notice("Setting dangerous option %s - tainting kernel\n",
103 kp->name);
Rusty Russell7a486d372014-08-27 06:25:23 +0930104 add_taint(TAINT_USER, LOCKDEP_STILL_OK);
105 }
106}
107
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108static int parse_one(char *param,
109 char *val,
Jim Cromie9fb48c72012-04-27 14:30:34 -0600110 const char *doing,
Rusty Russell914dcaa2010-08-11 23:04:18 -0600111 const struct kernel_param *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112 unsigned num_params,
Pawel Moll026cee02012-03-26 12:50:51 +1030113 s16 min_level,
114 s16 max_level,
Luis R. Rodriguezecc86172015-03-30 16:20:03 -0700115 void *arg,
Jim Cromie9fb48c72012-04-27 14:30:34 -0600116 int (*handle_unknown)(char *param, char *val,
Luis R. Rodriguezecc86172015-03-30 16:20:03 -0700117 const char *doing, void *arg))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118{
119 unsigned int i;
Rusty Russell907b29e2010-08-11 23:04:19 -0600120 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700121
122 /* Find parameter */
123 for (i = 0; i < num_params; i++) {
124 if (parameq(param, params[i].name)) {
Pawel Moll026cee02012-03-26 12:50:51 +1030125 if (params[i].level < min_level
126 || params[i].level > max_level)
127 return 0;
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300128 /* No one handled NULL, so do it here. */
Steven Rostedtab013c52013-08-20 15:33:19 +0930129 if (!val &&
Jani Nikula6a4c2642014-08-27 06:21:23 +0930130 !(params[i].ops->flags & KERNEL_PARAM_OPS_FL_NOARG))
Rusty Russell2e9fb992010-08-11 23:04:10 -0600131 return -EINVAL;
Jim Cromie9fb48c72012-04-27 14:30:34 -0600132 pr_debug("handling %s with %p\n", param,
133 params[i].ops->set);
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930134 kernel_param_lock(params[i].mod);
Rusty Russell7a486d372014-08-27 06:25:23 +0930135 param_check_unsafe(&params[i]);
Rusty Russell907b29e2010-08-11 23:04:19 -0600136 err = params[i].ops->set(val, &params[i]);
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930137 kernel_param_unlock(params[i].mod);
Rusty Russell907b29e2010-08-11 23:04:19 -0600138 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700139 }
140 }
141
142 if (handle_unknown) {
Jim Cromie9fb48c72012-04-27 14:30:34 -0600143 pr_debug("doing %s: %s='%s'\n", doing, param, val);
Luis R. Rodriguezecc86172015-03-30 16:20:03 -0700144 return handle_unknown(param, val, doing, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 }
146
Jim Cromie9fb48c72012-04-27 14:30:34 -0600147 pr_debug("Unknown argument '%s'\n", param);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 return -ENOENT;
149}
150
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151/* Args looks like "foo=bar,bar2 baz=fuz wiz". */
Rusty Russell51e158c2014-04-28 11:34:33 +0930152char *parse_args(const char *doing,
153 char *args,
154 const struct kernel_param *params,
155 unsigned num,
156 s16 min_level,
157 s16 max_level,
Luis R. Rodriguezecc86172015-03-30 16:20:03 -0700158 void *arg,
159 int (*unknown)(char *param, char *val,
160 const char *doing, void *arg))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161{
Oleg Nesterov74b22c42015-08-26 09:42:34 +0930162 char *param, *val, *err = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163
Rusty Russellf36462f2005-09-27 21:45:34 -0700164 /* Chew leading spaces */
André Goddard Rosae7d28602009-12-14 18:01:06 -0800165 args = skip_spaces(args);
Rusty Russellf36462f2005-09-27 21:45:34 -0700166
Jim Cromie1ef9eaf2012-05-03 11:57:37 -0600167 if (*args)
Jim Cromie9fb48c72012-04-27 14:30:34 -0600168 pr_debug("doing %s, parsing ARGS: '%s'\n", doing, args);
169
Linus Torvalds1da177e2005-04-16 15:20:36 -0700170 while (*args) {
171 int ret;
Ard van Breemena416aba2007-01-05 16:36:20 -0800172 int irq_was_disabled;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173
174 args = next_arg(args, &param, &val);
Rusty Russell51e158c2014-04-28 11:34:33 +0930175 /* Stop at -- */
176 if (!val && strcmp(param, "--") == 0)
Oleg Nesterov74b22c42015-08-26 09:42:34 +0930177 return err ?: args;
Ard van Breemena416aba2007-01-05 16:36:20 -0800178 irq_was_disabled = irqs_disabled();
Jim Cromie9fb48c72012-04-27 14:30:34 -0600179 ret = parse_one(param, val, doing, params, num,
Luis R. Rodriguezecc86172015-03-30 16:20:03 -0700180 min_level, max_level, arg, unknown);
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600181 if (irq_was_disabled && !irqs_disabled())
182 pr_warn("%s: option '%s' enabled irq's!\n",
183 doing, param);
184
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185 switch (ret) {
Oleg Nesterov74b22c42015-08-26 09:42:34 +0930186 case 0:
187 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188 case -ENOENT:
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600189 pr_err("%s: Unknown parameter `%s'\n", doing, param);
Oleg Nesterov74b22c42015-08-26 09:42:34 +0930190 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 case -ENOSPC:
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600192 pr_err("%s: `%s' too large for parameter `%s'\n",
Jim Cromie9fb48c72012-04-27 14:30:34 -0600193 doing, val ?: "", param);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 break;
195 default:
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600196 pr_err("%s: `%s' invalid for parameter `%s'\n",
Jim Cromie9fb48c72012-04-27 14:30:34 -0600197 doing, val ?: "", param);
Oleg Nesterov74b22c42015-08-26 09:42:34 +0930198 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199 }
Oleg Nesterov74b22c42015-08-26 09:42:34 +0930200
201 err = ERR_PTR(ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700202 }
203
Oleg Nesterov74b22c42015-08-26 09:42:34 +0930204 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205}
206
207/* Lazy bastard, eh? */
Felipe Contreras88a88b322013-12-04 14:09:38 +1030208#define STANDARD_PARAM_DEF(name, type, format, strtolfn) \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600209 int param_set_##name(const char *val, const struct kernel_param *kp) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210 { \
Felipe Contreras88a88b322013-12-04 14:09:38 +1030211 return strtolfn(val, 0, (type *)kp->arg); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700212 } \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600213 int param_get_##name(char *buffer, const struct kernel_param *kp) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 { \
Jean Delvare96802e62017-10-03 16:16:38 -0700215 return scnprintf(buffer, PAGE_SIZE, format "\n", \
Chen Gangf4940ab2013-08-20 15:35:04 +0930216 *((type *)kp->arg)); \
Rusty Russella14fe242010-08-11 23:04:11 -0600217 } \
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930218 const struct kernel_param_ops param_ops_##name = { \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600219 .set = param_set_##name, \
220 .get = param_get_##name, \
221 }; \
Rusty Russella14fe242010-08-11 23:04:11 -0600222 EXPORT_SYMBOL(param_set_##name); \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600223 EXPORT_SYMBOL(param_get_##name); \
224 EXPORT_SYMBOL(param_ops_##name)
225
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226
Jean Delvaree0596c82017-10-03 16:16:41 -0700227STANDARD_PARAM_DEF(byte, unsigned char, "%hhu", kstrtou8);
228STANDARD_PARAM_DEF(short, short, "%hi", kstrtos16);
229STANDARD_PARAM_DEF(ushort, unsigned short, "%hu", kstrtou16);
230STANDARD_PARAM_DEF(int, int, "%i", kstrtoint);
231STANDARD_PARAM_DEF(uint, unsigned int, "%u", kstrtouint);
232STANDARD_PARAM_DEF(long, long, "%li", kstrtol);
233STANDARD_PARAM_DEF(ulong, unsigned long, "%lu", kstrtoul);
234STANDARD_PARAM_DEF(ullong, unsigned long long, "%llu", kstrtoull);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600236int param_set_charp(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238 if (strlen(val) > 1024) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600239 pr_err("%s: string parameter too long\n", kp->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 return -ENOSPC;
241 }
242
Rusty Russella1054322010-08-11 23:04:18 -0600243 maybe_kfree_parameter(*(char **)kp->arg);
244
245 /* This is a hack. We can't kmalloc in early boot, and we
Rusty Russelle180a6b2009-03-31 13:05:29 -0600246 * don't need to; this mangled commandline is preserved. */
247 if (slab_is_available()) {
Rusty Russella1054322010-08-11 23:04:18 -0600248 *(char **)kp->arg = kmalloc_parameter(strlen(val)+1);
Rusty Russelld553ad82009-10-29 08:56:17 -0600249 if (!*(char **)kp->arg)
Rusty Russelle180a6b2009-03-31 13:05:29 -0600250 return -ENOMEM;
Rusty Russella1054322010-08-11 23:04:18 -0600251 strcpy(*(char **)kp->arg, val);
Rusty Russelle180a6b2009-03-31 13:05:29 -0600252 } else
253 *(const char **)kp->arg = val;
254
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 return 0;
256}
Rusty Russella14fe242010-08-11 23:04:11 -0600257EXPORT_SYMBOL(param_set_charp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600259int param_get_charp(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260{
Jean Delvare96802e62017-10-03 16:16:38 -0700261 return scnprintf(buffer, PAGE_SIZE, "%s\n", *((char **)kp->arg));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262}
Rusty Russella14fe242010-08-11 23:04:11 -0600263EXPORT_SYMBOL(param_get_charp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264
Dan Streetman3d9c6372015-11-06 16:29:12 -0800265void param_free_charp(void *arg)
Rusty Russella1054322010-08-11 23:04:18 -0600266{
267 maybe_kfree_parameter(*((char **)arg));
268}
Dan Streetman3d9c6372015-11-06 16:29:12 -0800269EXPORT_SYMBOL(param_free_charp);
Rusty Russella1054322010-08-11 23:04:18 -0600270
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930271const struct kernel_param_ops param_ops_charp = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600272 .set = param_set_charp,
273 .get = param_get_charp,
Rusty Russella1054322010-08-11 23:04:18 -0600274 .free = param_free_charp,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600275};
276EXPORT_SYMBOL(param_ops_charp);
277
Rusty Russellfddd5202009-06-12 21:46:57 -0600278/* Actually could be a bool or an int, for historical reasons. */
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600279int param_set_bool(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280{
281 /* No equals means "set"... */
282 if (!val) val = "1";
283
284 /* One of =[yYnN01] */
Rusty Russell8b825282012-03-26 12:50:51 +1030285 return strtobool(val, kp->arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286}
Rusty Russella14fe242010-08-11 23:04:11 -0600287EXPORT_SYMBOL(param_set_bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600289int param_get_bool(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290{
291 /* Y and N chosen as being relatively non-coder friendly */
Jean Delvare96802e62017-10-03 16:16:38 -0700292 return sprintf(buffer, "%c\n", *(bool *)kp->arg ? 'Y' : 'N');
Linus Torvalds1da177e2005-04-16 15:20:36 -0700293}
Rusty Russella14fe242010-08-11 23:04:11 -0600294EXPORT_SYMBOL(param_get_bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930296const struct kernel_param_ops param_ops_bool = {
Jani Nikula6a4c2642014-08-27 06:21:23 +0930297 .flags = KERNEL_PARAM_OPS_FL_NOARG,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600298 .set = param_set_bool,
299 .get = param_get_bool,
300};
301EXPORT_SYMBOL(param_ops_bool);
302
Luis R. Rodriguezd19f05d2015-05-27 11:09:38 +0930303int param_set_bool_enable_only(const char *val, const struct kernel_param *kp)
304{
305 int err = 0;
306 bool new_value;
307 bool orig_value = *(bool *)kp->arg;
308 struct kernel_param dummy_kp = *kp;
309
310 dummy_kp.arg = &new_value;
311
312 err = param_set_bool(val, &dummy_kp);
313 if (err)
314 return err;
315
316 /* Don't let them unset it once it's set! */
317 if (!new_value && orig_value)
318 return -EROFS;
319
320 if (new_value)
321 err = param_set_bool(val, kp);
322
323 return err;
324}
325EXPORT_SYMBOL_GPL(param_set_bool_enable_only);
326
327const struct kernel_param_ops param_ops_bool_enable_only = {
328 .flags = KERNEL_PARAM_OPS_FL_NOARG,
329 .set = param_set_bool_enable_only,
330 .get = param_get_bool,
331};
Luis R. Rodriguez154be212015-05-27 11:09:39 +0930332EXPORT_SYMBOL_GPL(param_ops_bool_enable_only);
Luis R. Rodriguezd19f05d2015-05-27 11:09:38 +0930333
Rusty Russellfddd5202009-06-12 21:46:57 -0600334/* This one must be bool. */
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600335int param_set_invbool(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336{
Rusty Russellfddd5202009-06-12 21:46:57 -0600337 int ret;
338 bool boolval;
Jan Beulich22e48ea2007-10-16 23:29:34 -0700339 struct kernel_param dummy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340
Jan Beulich22e48ea2007-10-16 23:29:34 -0700341 dummy.arg = &boolval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700342 ret = param_set_bool(val, &dummy);
343 if (ret == 0)
Rusty Russell9a71af22009-06-12 21:46:53 -0600344 *(bool *)kp->arg = !boolval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700345 return ret;
346}
Rusty Russella14fe242010-08-11 23:04:11 -0600347EXPORT_SYMBOL(param_set_invbool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600349int param_get_invbool(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350{
Jean Delvare96802e62017-10-03 16:16:38 -0700351 return sprintf(buffer, "%c\n", (*(bool *)kp->arg) ? 'N' : 'Y');
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352}
Rusty Russella14fe242010-08-11 23:04:11 -0600353EXPORT_SYMBOL(param_get_invbool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930355const struct kernel_param_ops param_ops_invbool = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600356 .set = param_set_invbool,
357 .get = param_get_invbool,
358};
359EXPORT_SYMBOL(param_ops_invbool);
360
Rusty Russell69116f22012-01-13 09:32:17 +1030361int param_set_bint(const char *val, const struct kernel_param *kp)
362{
Dan Streetman5104b7d2015-06-17 06:17:52 +0930363 /* Match bool exactly, by re-using it. */
364 struct kernel_param boolkp = *kp;
Rusty Russell69116f22012-01-13 09:32:17 +1030365 bool v;
366 int ret;
367
Rusty Russell69116f22012-01-13 09:32:17 +1030368 boolkp.arg = &v;
Rusty Russell69116f22012-01-13 09:32:17 +1030369
370 ret = param_set_bool(val, &boolkp);
371 if (ret == 0)
372 *(int *)kp->arg = v;
373 return ret;
374}
375EXPORT_SYMBOL(param_set_bint);
376
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930377const struct kernel_param_ops param_ops_bint = {
Jani Nikula6a4c2642014-08-27 06:21:23 +0930378 .flags = KERNEL_PARAM_OPS_FL_NOARG,
Rusty Russell69116f22012-01-13 09:32:17 +1030379 .set = param_set_bint,
380 .get = param_get_int,
381};
382EXPORT_SYMBOL(param_ops_bint);
383
Bert Wesarg9730b5b2007-05-08 00:28:50 -0700384/* We break the rule and mangle the string. */
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930385static int param_array(struct module *mod,
386 const char *name,
Adrian Bunk98717282006-03-25 03:07:06 -0800387 const char *val,
388 unsigned int min, unsigned int max,
389 void *elem, int elemsize,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600390 int (*set)(const char *, const struct kernel_param *kp),
Pawel Moll026cee02012-03-26 12:50:51 +1030391 s16 level,
Richard Knutssoneb38a992008-02-06 01:37:50 -0800392 unsigned int *num)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393{
394 int ret;
395 struct kernel_param kp;
396 char save;
397
398 /* Get the name right for errors. */
399 kp.name = name;
400 kp.arg = elem;
Pawel Moll026cee02012-03-26 12:50:51 +1030401 kp.level = level;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402
Linus Torvalds1da177e2005-04-16 15:20:36 -0700403 *num = 0;
404 /* We expect a comma-separated list of values. */
405 do {
406 int len;
407
408 if (*num == max) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600409 pr_err("%s: can only take %i arguments\n", name, max);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700410 return -EINVAL;
411 }
412 len = strcspn(val, ",");
413
414 /* nul-terminate and parse */
415 save = val[len];
416 ((char *)val)[len] = '\0';
Rusty Russellcf2fde72015-06-26 06:44:38 +0930417 check_kparam_locked(mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418 ret = set(val, &kp);
419
420 if (ret != 0)
421 return ret;
422 kp.arg += elemsize;
423 val += len+1;
424 (*num)++;
425 } while (save == ',');
426
427 if (*num < min) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600428 pr_err("%s: needs at least %i arguments\n", name, min);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700429 return -EINVAL;
430 }
431 return 0;
432}
433
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600434static int param_array_set(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700435{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700436 const struct kparam_array *arr = kp->arr;
Bert Wesarg31143a12005-04-16 15:25:42 -0700437 unsigned int temp_num;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930439 return param_array(kp->mod, kp->name, val, 1, arr->max, arr->elem,
Pawel Moll026cee02012-03-26 12:50:51 +1030440 arr->elemsize, arr->ops->set, kp->level,
Rusty Russell3c7d76e2009-10-29 08:56:19 -0600441 arr->num ?: &temp_num);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700442}
443
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600444static int param_array_get(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700445{
446 int i, off, ret;
Jan Beulich22e48ea2007-10-16 23:29:34 -0700447 const struct kparam_array *arr = kp->arr;
Dan Streetman5104b7d2015-06-17 06:17:52 +0930448 struct kernel_param p = *kp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700449
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450 for (i = off = 0; i < (arr->num ? *arr->num : arr->max); i++) {
Jean Delvare96802e62017-10-03 16:16:38 -0700451 /* Replace \n with comma */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 if (i)
Jean Delvare96802e62017-10-03 16:16:38 -0700453 buffer[off - 1] = ',';
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454 p.arg = arr->elem + arr->elemsize * i;
Rusty Russellcf2fde72015-06-26 06:44:38 +0930455 check_kparam_locked(p.mod);
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600456 ret = arr->ops->get(buffer + off, &p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457 if (ret < 0)
458 return ret;
459 off += ret;
460 }
461 buffer[off] = '\0';
462 return off;
463}
464
Rusty Russelle6df34a2010-08-11 23:04:17 -0600465static void param_array_free(void *arg)
466{
467 unsigned int i;
468 const struct kparam_array *arr = arg;
469
470 if (arr->ops->free)
471 for (i = 0; i < (arr->num ? *arr->num : arr->max); i++)
472 arr->ops->free(arr->elem + arr->elemsize * i);
473}
474
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930475const struct kernel_param_ops param_array_ops = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600476 .set = param_array_set,
477 .get = param_array_get,
Rusty Russelle6df34a2010-08-11 23:04:17 -0600478 .free = param_array_free,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600479};
480EXPORT_SYMBOL(param_array_ops);
481
482int param_set_copystring(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700484 const struct kparam_string *kps = kp->str;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700485
486 if (strlen(val)+1 > kps->maxlen) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600487 pr_err("%s: string doesn't fit in %u chars.\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 kp->name, kps->maxlen-1);
489 return -ENOSPC;
490 }
491 strcpy(kps->string, val);
492 return 0;
493}
Rusty Russella14fe242010-08-11 23:04:11 -0600494EXPORT_SYMBOL(param_set_copystring);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600496int param_get_string(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700498 const struct kparam_string *kps = kp->str;
Jean Delvare96802e62017-10-03 16:16:38 -0700499 return scnprintf(buffer, PAGE_SIZE, "%s\n", kps->string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500}
Rusty Russella14fe242010-08-11 23:04:11 -0600501EXPORT_SYMBOL(param_get_string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930503const struct kernel_param_ops param_ops_string = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600504 .set = param_set_copystring,
505 .get = param_get_string,
506};
507EXPORT_SYMBOL(param_ops_string);
508
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509/* sysfs output in /sys/modules/XYZ/parameters/ */
Edward Z. Yang350f8252010-02-01 18:26:59 -0500510#define to_module_attr(n) container_of(n, struct module_attribute, attr)
511#define to_module_kobject(n) container_of(n, struct module_kobject, kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513struct param_attribute
514{
515 struct module_attribute mattr;
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600516 const struct kernel_param *param;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700517};
518
519struct module_param_attrs
520{
Rusty Russell9b473de2008-10-22 10:00:22 -0500521 unsigned int num;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700522 struct attribute_group grp;
523 struct param_attribute attrs[0];
524};
525
Randy Dunlapef665c12007-02-13 15:19:06 -0800526#ifdef CONFIG_SYSFS
Edward Z. Yang350f8252010-02-01 18:26:59 -0500527#define to_param_attr(n) container_of(n, struct param_attribute, mattr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528
529static ssize_t param_attr_show(struct module_attribute *mattr,
Kay Sievers4befb022011-07-24 22:06:04 +0930530 struct module_kobject *mk, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531{
532 int count;
533 struct param_attribute *attribute = to_param_attr(mattr);
534
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600535 if (!attribute->param->ops->get)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700536 return -EPERM;
537
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930538 kernel_param_lock(mk->mod);
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600539 count = attribute->param->ops->get(buf, attribute->param);
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930540 kernel_param_unlock(mk->mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541 return count;
542}
543
544/* sysfs always hands a nul-terminated string in buf. We rely on that. */
545static ssize_t param_attr_store(struct module_attribute *mattr,
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930546 struct module_kobject *mk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547 const char *buf, size_t len)
548{
549 int err;
550 struct param_attribute *attribute = to_param_attr(mattr);
551
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600552 if (!attribute->param->ops->set)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 return -EPERM;
554
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930555 kernel_param_lock(mk->mod);
Rusty Russell7a486d372014-08-27 06:25:23 +0930556 param_check_unsafe(attribute->param);
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600557 err = attribute->param->ops->set(buf, attribute->param);
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930558 kernel_param_unlock(mk->mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559 if (!err)
560 return len;
561 return err;
562}
Randy Dunlapef665c12007-02-13 15:19:06 -0800563#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564
565#ifdef CONFIG_MODULES
566#define __modinit
567#else
568#define __modinit __init
569#endif
570
Randy Dunlapef665c12007-02-13 15:19:06 -0800571#ifdef CONFIG_SYSFS
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930572void kernel_param_lock(struct module *mod)
Rusty Russell907b29e2010-08-11 23:04:19 -0600573{
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930574 mutex_lock(KPARAM_MUTEX(mod));
Rusty Russell907b29e2010-08-11 23:04:19 -0600575}
Rusty Russell907b29e2010-08-11 23:04:19 -0600576
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930577void kernel_param_unlock(struct module *mod)
Rusty Russell907b29e2010-08-11 23:04:19 -0600578{
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930579 mutex_unlock(KPARAM_MUTEX(mod));
Rusty Russell907b29e2010-08-11 23:04:19 -0600580}
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930581
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930582EXPORT_SYMBOL(kernel_param_lock);
583EXPORT_SYMBOL(kernel_param_unlock);
Rusty Russell907b29e2010-08-11 23:04:19 -0600584
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585/*
Rusty Russell9b473de2008-10-22 10:00:22 -0500586 * add_sysfs_param - add a parameter to sysfs
587 * @mk: struct module_kobject
Jean Delvare630cc2b2017-10-03 16:14:18 -0700588 * @kp: the actual parameter definition to add to sysfs
Rusty Russell9b473de2008-10-22 10:00:22 -0500589 * @name: name of parameter
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 *
Rusty Russell9b473de2008-10-22 10:00:22 -0500591 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594 */
Rusty Russell9b473de2008-10-22 10:00:22 -0500595static __modinit int add_sysfs_param(struct module_kobject *mk,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600596 const struct kernel_param *kp,
Rusty Russell9b473de2008-10-22 10:00:22 -0500597 const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700598{
Rusty Russell18eb74f2014-11-10 09:32:29 +1030599 struct module_param_attrs *new_mp;
600 struct attribute **new_attrs;
601 unsigned int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602
Rusty Russell9b473de2008-10-22 10:00:22 -0500603 /* We don't bother calling this with invisible parameters. */
604 BUG_ON(!kp->perm);
605
606 if (!mk->mp) {
Rusty Russell18eb74f2014-11-10 09:32:29 +1030607 /* First allocation. */
608 mk->mp = kzalloc(sizeof(*mk->mp), GFP_KERNEL);
609 if (!mk->mp)
610 return -ENOMEM;
611 mk->mp->grp.name = "parameters";
612 /* NULL-terminated attribute array. */
613 mk->mp->grp.attrs = kzalloc(sizeof(mk->mp->grp.attrs[0]),
614 GFP_KERNEL);
615 /* Caller will cleanup via free_module_param_attrs */
616 if (!mk->mp->grp.attrs)
617 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700618 }
619
Rusty Russell18eb74f2014-11-10 09:32:29 +1030620 /* Enlarge allocations. */
621 new_mp = krealloc(mk->mp,
622 sizeof(*mk->mp) +
623 sizeof(mk->mp->attrs[0]) * (mk->mp->num + 1),
624 GFP_KERNEL);
625 if (!new_mp)
626 return -ENOMEM;
627 mk->mp = new_mp;
Rusty Russell9b473de2008-10-22 10:00:22 -0500628
Rusty Russell18eb74f2014-11-10 09:32:29 +1030629 /* Extra pointer for NULL terminator */
630 new_attrs = krealloc(mk->mp->grp.attrs,
631 sizeof(mk->mp->grp.attrs[0]) * (mk->mp->num + 2),
632 GFP_KERNEL);
633 if (!new_attrs)
634 return -ENOMEM;
635 mk->mp->grp.attrs = new_attrs;
Rusty Russell9b473de2008-10-22 10:00:22 -0500636
637 /* Tack new one on the end. */
Rusty Russellc772be52015-01-20 09:07:04 +1030638 memset(&mk->mp->attrs[mk->mp->num], 0, sizeof(mk->mp->attrs[0]));
Rusty Russell18eb74f2014-11-10 09:32:29 +1030639 sysfs_attr_init(&mk->mp->attrs[mk->mp->num].mattr.attr);
640 mk->mp->attrs[mk->mp->num].param = kp;
641 mk->mp->attrs[mk->mp->num].mattr.show = param_attr_show;
Kees Cookb0a65b02014-12-12 13:36:49 +1030642 /* Do not allow runtime DAC changes to make param writable. */
643 if ((kp->perm & (S_IWUSR | S_IWGRP | S_IWOTH)) != 0)
644 mk->mp->attrs[mk->mp->num].mattr.store = param_attr_store;
Rusty Russell574732c2014-12-23 15:05:36 +1030645 else
646 mk->mp->attrs[mk->mp->num].mattr.store = NULL;
Rusty Russell18eb74f2014-11-10 09:32:29 +1030647 mk->mp->attrs[mk->mp->num].mattr.attr.name = (char *)name;
648 mk->mp->attrs[mk->mp->num].mattr.attr.mode = kp->perm;
649 mk->mp->num++;
Rusty Russell9b473de2008-10-22 10:00:22 -0500650
651 /* Fix up all the pointers, since krealloc can move us */
Rusty Russell18eb74f2014-11-10 09:32:29 +1030652 for (i = 0; i < mk->mp->num; i++)
653 mk->mp->grp.attrs[i] = &mk->mp->attrs[i].mattr.attr;
654 mk->mp->grp.attrs[mk->mp->num] = NULL;
Rusty Russell9b473de2008-10-22 10:00:22 -0500655 return 0;
Rusty Russell9b473de2008-10-22 10:00:22 -0500656}
657
Linus Torvaldsd2441182008-10-23 12:07:17 -0700658#ifdef CONFIG_MODULES
Rusty Russell9b473de2008-10-22 10:00:22 -0500659static void free_module_param_attrs(struct module_kobject *mk)
660{
Rusty Russell18eb74f2014-11-10 09:32:29 +1030661 if (mk->mp)
662 kfree(mk->mp->grp.attrs);
Rusty Russell9b473de2008-10-22 10:00:22 -0500663 kfree(mk->mp);
664 mk->mp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665}
666
Linus Torvalds1da177e2005-04-16 15:20:36 -0700667/*
668 * module_param_sysfs_setup - setup sysfs support for one module
669 * @mod: module
670 * @kparam: module parameters (array)
671 * @num_params: number of module parameters
672 *
Rusty Russell9b473de2008-10-22 10:00:22 -0500673 * Adds sysfs entries for module parameters under
674 * /sys/module/[mod->name]/parameters/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700675 */
676int module_param_sysfs_setup(struct module *mod,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600677 const struct kernel_param *kparam,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678 unsigned int num_params)
679{
Rusty Russell9b473de2008-10-22 10:00:22 -0500680 int i, err;
681 bool params = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682
Rusty Russell9b473de2008-10-22 10:00:22 -0500683 for (i = 0; i < num_params; i++) {
684 if (kparam[i].perm == 0)
685 continue;
686 err = add_sysfs_param(&mod->mkobj, &kparam[i], kparam[i].name);
Rusty Russell18eb74f2014-11-10 09:32:29 +1030687 if (err) {
688 free_module_param_attrs(&mod->mkobj);
Rusty Russell9b473de2008-10-22 10:00:22 -0500689 return err;
Rusty Russell18eb74f2014-11-10 09:32:29 +1030690 }
Rusty Russell9b473de2008-10-22 10:00:22 -0500691 params = true;
692 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693
Rusty Russell9b473de2008-10-22 10:00:22 -0500694 if (!params)
695 return 0;
696
697 /* Create the param group. */
698 err = sysfs_create_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp);
699 if (err)
700 free_module_param_attrs(&mod->mkobj);
701 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700702}
703
704/*
705 * module_param_sysfs_remove - remove sysfs support for one module
706 * @mod: module
707 *
708 * Remove sysfs entries for module parameters and the corresponding
709 * kobject.
710 */
711void module_param_sysfs_remove(struct module *mod)
712{
Rusty Russell9b473de2008-10-22 10:00:22 -0500713 if (mod->mkobj.mp) {
714 sysfs_remove_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715 /* We are positive that no one is using any param
716 * attrs at this point. Deallocate immediately. */
Rusty Russell9b473de2008-10-22 10:00:22 -0500717 free_module_param_attrs(&mod->mkobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718 }
719}
720#endif
721
Rusty Russelle180a6b2009-03-31 13:05:29 -0600722void destroy_params(const struct kernel_param *params, unsigned num)
723{
Rusty Russelle6df34a2010-08-11 23:04:17 -0600724 unsigned int i;
725
726 for (i = 0; i < num; i++)
727 if (params[i].ops->free)
728 params[i].ops->free(params[i].arg);
Rusty Russelle180a6b2009-03-31 13:05:29 -0600729}
730
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800731static struct module_kobject * __init locate_module_kobject(const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732{
733 struct module_kobject *mk;
Rusty Russell9b473de2008-10-22 10:00:22 -0500734 struct kobject *kobj;
735 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700736
Rusty Russell9b473de2008-10-22 10:00:22 -0500737 kobj = kset_find_obj(module_kset, name);
738 if (kobj) {
Rusty Russell9b473de2008-10-22 10:00:22 -0500739 mk = to_module_kobject(kobj);
Rusty Russell9b473de2008-10-22 10:00:22 -0500740 } else {
741 mk = kzalloc(sizeof(struct module_kobject), GFP_KERNEL);
742 BUG_ON(!mk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743
Rusty Russell9b473de2008-10-22 10:00:22 -0500744 mk->mod = THIS_MODULE;
745 mk->kobj.kset = module_kset;
746 err = kobject_init_and_add(&mk->kobj, &module_ktype, NULL,
747 "%s", name);
Kay Sievers88bfa322011-07-24 22:06:04 +0930748#ifdef CONFIG_MODULES
749 if (!err)
750 err = sysfs_create_file(&mk->kobj, &module_uevent.attr);
751#endif
Rusty Russell9b473de2008-10-22 10:00:22 -0500752 if (err) {
753 kobject_put(&mk->kobj);
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600754 pr_crit("Adding module '%s' to sysfs failed (%d), the system may be unstable.\n",
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800755 name, err);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800756 return NULL;
Rusty Russell9b473de2008-10-22 10:00:22 -0500757 }
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800758
759 /* So that we hold reference in both cases. */
Rusty Russell9b473de2008-10-22 10:00:22 -0500760 kobject_get(&mk->kobj);
Greg Kroah-Hartman74c5b592007-07-30 11:26:38 -0700761 }
Rusty Russell9b473de2008-10-22 10:00:22 -0500762
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800763 return mk;
764}
765
766static void __init kernel_add_sysfs_param(const char *name,
Geert Uytterhoeven63a12d92014-10-13 15:55:44 -0700767 const struct kernel_param *kparam,
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800768 unsigned int name_skip)
769{
770 struct module_kobject *mk;
771 int err;
772
773 mk = locate_module_kobject(name);
774 if (!mk)
775 return;
776
777 /* We need to remove old parameters before adding more. */
778 if (mk->mp)
779 sysfs_remove_group(&mk->kobj, &mk->mp->grp);
780
Rusty Russell9b473de2008-10-22 10:00:22 -0500781 /* These should not fail at boot. */
782 err = add_sysfs_param(mk, kparam, kparam->name + name_skip);
783 BUG_ON(err);
784 err = sysfs_create_group(&mk->kobj, &mk->mp->grp);
785 BUG_ON(err);
Kay Sieversf30c53a2007-01-15 20:22:02 +0100786 kobject_uevent(&mk->kobj, KOBJ_ADD);
Rusty Russell9b473de2008-10-22 10:00:22 -0500787 kobject_put(&mk->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788}
789
790/*
Jean Delvareb634d132013-07-02 15:35:11 +0930791 * param_sysfs_builtin - add sysfs parameters for built-in modules
Linus Torvalds1da177e2005-04-16 15:20:36 -0700792 *
793 * Add module_parameters to sysfs for "modules" built into the kernel.
794 *
795 * The "module" name (KBUILD_MODNAME) is stored before a dot, the
796 * "parameter" name is stored behind a dot in kernel_param->name. So,
797 * extract the "module" name for all built-in kernel_param-eters,
Rusty Russell9b473de2008-10-22 10:00:22 -0500798 * and for all who have the same, call kernel_add_sysfs_param.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799 */
800static void __init param_sysfs_builtin(void)
801{
Geert Uytterhoeven63a12d92014-10-13 15:55:44 -0700802 const struct kernel_param *kp;
Rusty Russell9b473de2008-10-22 10:00:22 -0500803 unsigned int name_len;
804 char modname[MODULE_NAME_LEN];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805
Rusty Russell9b473de2008-10-22 10:00:22 -0500806 for (kp = __start___param; kp < __stop___param; kp++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807 char *dot;
808
Rusty Russell9b473de2008-10-22 10:00:22 -0500809 if (kp->perm == 0)
810 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811
Rusty Russell730b69d2008-10-22 10:00:22 -0500812 dot = strchr(kp->name, '.');
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813 if (!dot) {
Rusty Russell67e67ce2008-10-22 10:00:23 -0500814 /* This happens for core_param() */
815 strcpy(modname, "kernel");
816 name_len = 0;
817 } else {
818 name_len = dot - kp->name + 1;
819 strlcpy(modname, kp->name, name_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820 }
Rusty Russell67e67ce2008-10-22 10:00:23 -0500821 kernel_add_sysfs_param(modname, kp, name_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823}
824
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800825ssize_t __modver_version_show(struct module_attribute *mattr,
Kay Sievers4befb022011-07-24 22:06:04 +0930826 struct module_kobject *mk, char *buf)
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800827{
828 struct module_version_attribute *vattr =
829 container_of(mattr, struct module_version_attribute, mattr);
830
Chen Gangf4940ab2013-08-20 15:35:04 +0930831 return scnprintf(buf, PAGE_SIZE, "%s\n", vattr->version);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800832}
833
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800834extern const struct module_version_attribute *__start___modver[];
835extern const struct module_version_attribute *__stop___modver[];
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800836
837static void __init version_sysfs_builtin(void)
838{
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800839 const struct module_version_attribute **p;
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800840 struct module_kobject *mk;
841 int err;
842
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800843 for (p = __start___modver; p < __stop___modver; p++) {
844 const struct module_version_attribute *vattr = *p;
845
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800846 mk = locate_module_kobject(vattr->module_name);
847 if (mk) {
848 err = sysfs_create_file(&mk->kobj, &vattr->mattr.attr);
Rusty Russell74c3dea32015-06-17 06:16:52 +0930849 WARN_ON_ONCE(err);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800850 kobject_uevent(&mk->kobj, KOBJ_ADD);
851 kobject_put(&mk->kobj);
852 }
853 }
854}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855
856/* module-related sysfs stuff */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700857
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858static ssize_t module_attr_show(struct kobject *kobj,
859 struct attribute *attr,
860 char *buf)
861{
862 struct module_attribute *attribute;
863 struct module_kobject *mk;
864 int ret;
865
866 attribute = to_module_attr(attr);
867 mk = to_module_kobject(kobj);
868
869 if (!attribute->show)
Dmitry Torokhov70f28172005-04-29 01:27:34 -0500870 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871
Kay Sievers4befb022011-07-24 22:06:04 +0930872 ret = attribute->show(attribute, mk, buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874 return ret;
875}
876
877static ssize_t module_attr_store(struct kobject *kobj,
878 struct attribute *attr,
879 const char *buf, size_t len)
880{
881 struct module_attribute *attribute;
882 struct module_kobject *mk;
883 int ret;
884
885 attribute = to_module_attr(attr);
886 mk = to_module_kobject(kobj);
887
888 if (!attribute->store)
Dmitry Torokhov70f28172005-04-29 01:27:34 -0500889 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890
Kay Sievers4befb022011-07-24 22:06:04 +0930891 ret = attribute->store(attribute, mk, buf, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700892
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893 return ret;
894}
895
Emese Revfy52cf25d2010-01-19 02:58:23 +0100896static const struct sysfs_ops module_sysfs_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700897 .show = module_attr_show,
898 .store = module_attr_store,
899};
900
Kay Sievers270a6c42007-01-18 13:26:15 +0100901static int uevent_filter(struct kset *kset, struct kobject *kobj)
902{
903 struct kobj_type *ktype = get_ktype(kobj);
904
905 if (ktype == &module_ktype)
906 return 1;
907 return 0;
908}
909
Emese Revfy9cd43612009-12-31 14:52:51 +0100910static const struct kset_uevent_ops module_uevent_ops = {
Kay Sievers270a6c42007-01-18 13:26:15 +0100911 .filter = uevent_filter,
912};
913
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700914struct kset *module_kset;
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700915int module_sysfs_initialized;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700916
Li Zhong942e4432013-09-03 16:33:57 +0930917static void module_kobj_release(struct kobject *kobj)
918{
919 struct module_kobject *mk = to_module_kobject(kobj);
920 complete(mk->kobj_completion);
921}
922
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700923struct kobj_type module_ktype = {
Li Zhong942e4432013-09-03 16:33:57 +0930924 .release = module_kobj_release,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925 .sysfs_ops = &module_sysfs_ops,
926};
927
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928/*
929 * param_sysfs_init - wrapper for built-in params support
930 */
931static int __init param_sysfs_init(void)
932{
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700933 module_kset = kset_create_and_add("module", &module_uevent_ops, NULL);
934 if (!module_kset) {
935 printk(KERN_WARNING "%s (%d): error creating kset\n",
936 __FILE__, __LINE__);
937 return -ENOMEM;
Randy Dunlapd8c76492006-09-29 01:58:55 -0700938 }
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700939 module_sysfs_initialized = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800941 version_sysfs_builtin();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700942 param_sysfs_builtin();
943
944 return 0;
945}
Mark Huangd10be6d2006-09-29 01:59:34 -0700946subsys_initcall(param_sysfs_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700948#endif /* CONFIG_SYSFS */