blob: 1cd8f1a895a8977d2231a00f921582eb7776111e [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/* Helpers for initial module or kernel cmdline parsing
2 Copyright (C) 2001 Rusty Russell.
3
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.
8
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.
13
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
17*/
Linus Torvalds1da177e2005-04-16 15:20:36 -070018#include <linux/kernel.h>
19#include <linux/string.h>
20#include <linux/errno.h>
21#include <linux/module.h>
Geert Uytterhoeven63a12d92014-10-13 15:55:44 -070022#include <linux/moduleparam.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070023#include <linux/device.h>
24#include <linux/err.h>
Tim Schmielau4e57b682005-10-30 15:03:48 -080025#include <linux/slab.h>
Peter Oberparleiter26d052b2009-07-06 17:11:22 +020026#include <linux/ctype.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070027
Rusty Russellcf2fde72015-06-26 06:44:38 +093028#ifdef CONFIG_SYSFS
Dan Streetmanb51d23e2015-06-17 06:18:52 +093029/* Protects all built-in parameters, modules use their own param_lock */
Rusty Russell907b29e2010-08-11 23:04:19 -060030static DEFINE_MUTEX(param_lock);
31
Dan Streetmanb51d23e2015-06-17 06:18:52 +093032/* Use the module's mutex, or if built-in use the built-in mutex */
Stephen Rothwell20bdc2c2015-06-26 13:19:19 +100033#ifdef CONFIG_MODULES
Dan Streetmanb51d23e2015-06-17 06:18:52 +093034#define KPARAM_MUTEX(mod) ((mod) ? &(mod)->param_lock : &param_lock)
Stephen Rothwell20bdc2c2015-06-26 13:19:19 +100035#else
36#define KPARAM_MUTEX(mod) (&param_lock)
37#endif
Rusty Russellcf2fde72015-06-26 06:44:38 +093038
39static inline void check_kparam_locked(struct module *mod)
40{
41 BUG_ON(!mutex_is_locked(KPARAM_MUTEX(mod)));
42}
43#else
44static inline void check_kparam_locked(struct module *mod)
45{
46}
47#endif /* !CONFIG_SYSFS */
Dan Streetmanb51d23e2015-06-17 06:18:52 +093048
Rusty Russella1054322010-08-11 23:04:18 -060049/* This just allows us to keep track of which parameters are kmalloced. */
50struct kmalloced_param {
51 struct list_head list;
52 char val[];
53};
Rusty Russella1054322010-08-11 23:04:18 -060054static LIST_HEAD(kmalloced_params);
Dan Streetmanb51d23e2015-06-17 06:18:52 +093055static DEFINE_SPINLOCK(kmalloced_params_lock);
Rusty Russella1054322010-08-11 23:04:18 -060056
57static void *kmalloc_parameter(unsigned int size)
58{
59 struct kmalloced_param *p;
60
61 p = kmalloc(sizeof(*p) + size, GFP_KERNEL);
62 if (!p)
63 return NULL;
64
Dan Streetmanb51d23e2015-06-17 06:18:52 +093065 spin_lock(&kmalloced_params_lock);
Rusty Russella1054322010-08-11 23:04:18 -060066 list_add(&p->list, &kmalloced_params);
Dan Streetmanb51d23e2015-06-17 06:18:52 +093067 spin_unlock(&kmalloced_params_lock);
68
Rusty Russella1054322010-08-11 23:04:18 -060069 return p->val;
70}
71
72/* Does nothing if parameter wasn't kmalloced above. */
73static void maybe_kfree_parameter(void *param)
74{
75 struct kmalloced_param *p;
76
Dan Streetmanb51d23e2015-06-17 06:18:52 +093077 spin_lock(&kmalloced_params_lock);
Rusty Russella1054322010-08-11 23:04:18 -060078 list_for_each_entry(p, &kmalloced_params, list) {
79 if (p->val == param) {
80 list_del(&p->list);
81 kfree(p);
82 break;
83 }
84 }
Dan Streetmanb51d23e2015-06-17 06:18:52 +093085 spin_unlock(&kmalloced_params_lock);
Rusty Russella1054322010-08-11 23:04:18 -060086}
87
Michal Schmidtb1e4d202011-10-10 00:03:37 +020088static char dash2underscore(char c)
Linus Torvalds1da177e2005-04-16 15:20:36 -070089{
90 if (c == '-')
91 return '_';
92 return c;
93}
94
Michal Schmidtb1e4d202011-10-10 00:03:37 +020095bool parameqn(const char *a, const char *b, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -070096{
Michal Schmidtb1e4d202011-10-10 00:03:37 +020097 size_t i;
98
99 for (i = 0; i < n; i++) {
100 if (dash2underscore(a[i]) != dash2underscore(b[i]))
101 return false;
102 }
103 return true;
104}
105
106bool parameq(const char *a, const char *b)
107{
108 return parameqn(a, b, strlen(a)+1);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700109}
110
Rusty Russell7a486d372014-08-27 06:25:23 +0930111static void param_check_unsafe(const struct kernel_param *kp)
112{
113 if (kp->flags & KERNEL_PARAM_FL_UNSAFE) {
114 pr_warn("Setting dangerous option %s - tainting kernel\n",
115 kp->name);
116 add_taint(TAINT_USER, LOCKDEP_STILL_OK);
117 }
118}
119
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120static int parse_one(char *param,
121 char *val,
Jim Cromie9fb48c72012-04-27 14:30:34 -0600122 const char *doing,
Rusty Russell914dcaa2010-08-11 23:04:18 -0600123 const struct kernel_param *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 unsigned num_params,
Pawel Moll026cee02012-03-26 12:50:51 +1030125 s16 min_level,
126 s16 max_level,
Luis R. Rodriguezecc86172015-03-30 16:20:03 -0700127 void *arg,
Jim Cromie9fb48c72012-04-27 14:30:34 -0600128 int (*handle_unknown)(char *param, char *val,
Luis R. Rodriguezecc86172015-03-30 16:20:03 -0700129 const char *doing, void *arg))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700130{
131 unsigned int i;
Rusty Russell907b29e2010-08-11 23:04:19 -0600132 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700133
134 /* Find parameter */
135 for (i = 0; i < num_params; i++) {
136 if (parameq(param, params[i].name)) {
Pawel Moll026cee02012-03-26 12:50:51 +1030137 if (params[i].level < min_level
138 || params[i].level > max_level)
139 return 0;
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300140 /* No one handled NULL, so do it here. */
Steven Rostedtab013c52013-08-20 15:33:19 +0930141 if (!val &&
Jani Nikula6a4c2642014-08-27 06:21:23 +0930142 !(params[i].ops->flags & KERNEL_PARAM_OPS_FL_NOARG))
Rusty Russell2e9fb992010-08-11 23:04:10 -0600143 return -EINVAL;
Jim Cromie9fb48c72012-04-27 14:30:34 -0600144 pr_debug("handling %s with %p\n", param,
145 params[i].ops->set);
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930146 kernel_param_lock(params[i].mod);
Rusty Russell7a486d372014-08-27 06:25:23 +0930147 param_check_unsafe(&params[i]);
Rusty Russell907b29e2010-08-11 23:04:19 -0600148 err = params[i].ops->set(val, &params[i]);
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930149 kernel_param_unlock(params[i].mod);
Rusty Russell907b29e2010-08-11 23:04:19 -0600150 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700151 }
152 }
153
154 if (handle_unknown) {
Jim Cromie9fb48c72012-04-27 14:30:34 -0600155 pr_debug("doing %s: %s='%s'\n", doing, param, val);
Luis R. Rodriguezecc86172015-03-30 16:20:03 -0700156 return handle_unknown(param, val, doing, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157 }
158
Jim Cromie9fb48c72012-04-27 14:30:34 -0600159 pr_debug("Unknown argument '%s'\n", param);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 return -ENOENT;
161}
162
Linus Torvalds1da177e2005-04-16 15:20:36 -0700163/* Args looks like "foo=bar,bar2 baz=fuz wiz". */
Rusty Russell51e158c2014-04-28 11:34:33 +0930164char *parse_args(const char *doing,
165 char *args,
166 const struct kernel_param *params,
167 unsigned num,
168 s16 min_level,
169 s16 max_level,
Luis R. Rodriguezecc86172015-03-30 16:20:03 -0700170 void *arg,
171 int (*unknown)(char *param, char *val,
172 const char *doing, void *arg))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700173{
Oleg Nesterov74b22c42015-08-26 09:42:34 +0930174 char *param, *val, *err = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700175
Rusty Russellf36462f2005-09-27 21:45:34 -0700176 /* Chew leading spaces */
André Goddard Rosae7d28602009-12-14 18:01:06 -0800177 args = skip_spaces(args);
Rusty Russellf36462f2005-09-27 21:45:34 -0700178
Jim Cromie1ef9eaf2012-05-03 11:57:37 -0600179 if (*args)
Jim Cromie9fb48c72012-04-27 14:30:34 -0600180 pr_debug("doing %s, parsing ARGS: '%s'\n", doing, args);
181
Linus Torvalds1da177e2005-04-16 15:20:36 -0700182 while (*args) {
183 int ret;
Ard van Breemena416aba2007-01-05 16:36:20 -0800184 int irq_was_disabled;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700185
186 args = next_arg(args, &param, &val);
Rusty Russell51e158c2014-04-28 11:34:33 +0930187 /* Stop at -- */
188 if (!val && strcmp(param, "--") == 0)
Oleg Nesterov74b22c42015-08-26 09:42:34 +0930189 return err ?: args;
Ard van Breemena416aba2007-01-05 16:36:20 -0800190 irq_was_disabled = irqs_disabled();
Jim Cromie9fb48c72012-04-27 14:30:34 -0600191 ret = parse_one(param, val, doing, params, num,
Luis R. Rodriguezecc86172015-03-30 16:20:03 -0700192 min_level, max_level, arg, unknown);
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600193 if (irq_was_disabled && !irqs_disabled())
194 pr_warn("%s: option '%s' enabled irq's!\n",
195 doing, param);
196
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 switch (ret) {
Oleg Nesterov74b22c42015-08-26 09:42:34 +0930198 case 0:
199 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200 case -ENOENT:
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600201 pr_err("%s: Unknown parameter `%s'\n", doing, param);
Oleg Nesterov74b22c42015-08-26 09:42:34 +0930202 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700203 case -ENOSPC:
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600204 pr_err("%s: `%s' too large for parameter `%s'\n",
Jim Cromie9fb48c72012-04-27 14:30:34 -0600205 doing, val ?: "", param);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700206 break;
207 default:
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600208 pr_err("%s: `%s' invalid for parameter `%s'\n",
Jim Cromie9fb48c72012-04-27 14:30:34 -0600209 doing, val ?: "", param);
Oleg Nesterov74b22c42015-08-26 09:42:34 +0930210 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700211 }
Oleg Nesterov74b22c42015-08-26 09:42:34 +0930212
213 err = ERR_PTR(ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214 }
215
Oleg Nesterov74b22c42015-08-26 09:42:34 +0930216 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217}
218
219/* Lazy bastard, eh? */
Felipe Contreras88a88b322013-12-04 14:09:38 +1030220#define STANDARD_PARAM_DEF(name, type, format, strtolfn) \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600221 int param_set_##name(const char *val, const struct kernel_param *kp) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 { \
Felipe Contreras88a88b322013-12-04 14:09:38 +1030223 return strtolfn(val, 0, (type *)kp->arg); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700224 } \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600225 int param_get_##name(char *buffer, const struct kernel_param *kp) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226 { \
Chen Gangf4940ab2013-08-20 15:35:04 +0930227 return scnprintf(buffer, PAGE_SIZE, format, \
228 *((type *)kp->arg)); \
Rusty Russella14fe242010-08-11 23:04:11 -0600229 } \
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930230 const struct kernel_param_ops param_ops_##name = { \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600231 .set = param_set_##name, \
232 .get = param_get_##name, \
233 }; \
Rusty Russella14fe242010-08-11 23:04:11 -0600234 EXPORT_SYMBOL(param_set_##name); \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600235 EXPORT_SYMBOL(param_get_##name); \
236 EXPORT_SYMBOL(param_ops_##name)
237
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238
Felipe Contreras88a88b322013-12-04 14:09:38 +1030239STANDARD_PARAM_DEF(byte, unsigned char, "%hhu", kstrtou8);
240STANDARD_PARAM_DEF(short, short, "%hi", kstrtos16);
241STANDARD_PARAM_DEF(ushort, unsigned short, "%hu", kstrtou16);
242STANDARD_PARAM_DEF(int, int, "%i", kstrtoint);
243STANDARD_PARAM_DEF(uint, unsigned int, "%u", kstrtouint);
244STANDARD_PARAM_DEF(long, long, "%li", kstrtol);
245STANDARD_PARAM_DEF(ulong, unsigned long, "%lu", kstrtoul);
Hannes Reineckeb4210b82014-06-25 15:27:37 +0200246STANDARD_PARAM_DEF(ullong, unsigned long long, "%llu", kstrtoull);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700247
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600248int param_set_charp(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250 if (strlen(val) > 1024) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600251 pr_err("%s: string parameter too long\n", kp->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 return -ENOSPC;
253 }
254
Rusty Russella1054322010-08-11 23:04:18 -0600255 maybe_kfree_parameter(*(char **)kp->arg);
256
257 /* This is a hack. We can't kmalloc in early boot, and we
Rusty Russelle180a6b2009-03-31 13:05:29 -0600258 * don't need to; this mangled commandline is preserved. */
259 if (slab_is_available()) {
Rusty Russella1054322010-08-11 23:04:18 -0600260 *(char **)kp->arg = kmalloc_parameter(strlen(val)+1);
Rusty Russelld553ad82009-10-29 08:56:17 -0600261 if (!*(char **)kp->arg)
Rusty Russelle180a6b2009-03-31 13:05:29 -0600262 return -ENOMEM;
Rusty Russella1054322010-08-11 23:04:18 -0600263 strcpy(*(char **)kp->arg, val);
Rusty Russelle180a6b2009-03-31 13:05:29 -0600264 } else
265 *(const char **)kp->arg = val;
266
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267 return 0;
268}
Rusty Russella14fe242010-08-11 23:04:11 -0600269EXPORT_SYMBOL(param_set_charp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700270
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600271int param_get_charp(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272{
Chen Gangf4940ab2013-08-20 15:35:04 +0930273 return scnprintf(buffer, PAGE_SIZE, "%s", *((char **)kp->arg));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274}
Rusty Russella14fe242010-08-11 23:04:11 -0600275EXPORT_SYMBOL(param_get_charp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276
Dan Streetman3d9c6372015-11-06 16:29:12 -0800277void param_free_charp(void *arg)
Rusty Russella1054322010-08-11 23:04:18 -0600278{
279 maybe_kfree_parameter(*((char **)arg));
280}
Dan Streetman3d9c6372015-11-06 16:29:12 -0800281EXPORT_SYMBOL(param_free_charp);
Rusty Russella1054322010-08-11 23:04:18 -0600282
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930283const struct kernel_param_ops param_ops_charp = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600284 .set = param_set_charp,
285 .get = param_get_charp,
Rusty Russella1054322010-08-11 23:04:18 -0600286 .free = param_free_charp,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600287};
288EXPORT_SYMBOL(param_ops_charp);
289
Rusty Russellfddd5202009-06-12 21:46:57 -0600290/* Actually could be a bool or an int, for historical reasons. */
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600291int param_set_bool(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700292{
293 /* No equals means "set"... */
294 if (!val) val = "1";
295
296 /* One of =[yYnN01] */
Rusty Russell8b825282012-03-26 12:50:51 +1030297 return strtobool(val, kp->arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298}
Rusty Russella14fe242010-08-11 23:04:11 -0600299EXPORT_SYMBOL(param_set_bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600301int param_get_bool(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302{
303 /* Y and N chosen as being relatively non-coder friendly */
Rusty Russell8b825282012-03-26 12:50:51 +1030304 return sprintf(buffer, "%c", *(bool *)kp->arg ? 'Y' : 'N');
Linus Torvalds1da177e2005-04-16 15:20:36 -0700305}
Rusty Russella14fe242010-08-11 23:04:11 -0600306EXPORT_SYMBOL(param_get_bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930308const struct kernel_param_ops param_ops_bool = {
Jani Nikula6a4c2642014-08-27 06:21:23 +0930309 .flags = KERNEL_PARAM_OPS_FL_NOARG,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600310 .set = param_set_bool,
311 .get = param_get_bool,
312};
313EXPORT_SYMBOL(param_ops_bool);
314
Luis R. Rodriguezd19f05d2015-05-27 11:09:38 +0930315int param_set_bool_enable_only(const char *val, const struct kernel_param *kp)
316{
317 int err = 0;
318 bool new_value;
319 bool orig_value = *(bool *)kp->arg;
320 struct kernel_param dummy_kp = *kp;
321
322 dummy_kp.arg = &new_value;
323
324 err = param_set_bool(val, &dummy_kp);
325 if (err)
326 return err;
327
328 /* Don't let them unset it once it's set! */
329 if (!new_value && orig_value)
330 return -EROFS;
331
332 if (new_value)
333 err = param_set_bool(val, kp);
334
335 return err;
336}
337EXPORT_SYMBOL_GPL(param_set_bool_enable_only);
338
339const struct kernel_param_ops param_ops_bool_enable_only = {
340 .flags = KERNEL_PARAM_OPS_FL_NOARG,
341 .set = param_set_bool_enable_only,
342 .get = param_get_bool,
343};
Luis R. Rodriguez154be212015-05-27 11:09:39 +0930344EXPORT_SYMBOL_GPL(param_ops_bool_enable_only);
Luis R. Rodriguezd19f05d2015-05-27 11:09:38 +0930345
Rusty Russellfddd5202009-06-12 21:46:57 -0600346/* This one must be bool. */
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600347int param_set_invbool(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348{
Rusty Russellfddd5202009-06-12 21:46:57 -0600349 int ret;
350 bool boolval;
Jan Beulich22e48ea2007-10-16 23:29:34 -0700351 struct kernel_param dummy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352
Jan Beulich22e48ea2007-10-16 23:29:34 -0700353 dummy.arg = &boolval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354 ret = param_set_bool(val, &dummy);
355 if (ret == 0)
Rusty Russell9a71af22009-06-12 21:46:53 -0600356 *(bool *)kp->arg = !boolval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357 return ret;
358}
Rusty Russella14fe242010-08-11 23:04:11 -0600359EXPORT_SYMBOL(param_set_invbool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600361int param_get_invbool(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700362{
Rusty Russell9a71af22009-06-12 21:46:53 -0600363 return sprintf(buffer, "%c", (*(bool *)kp->arg) ? 'N' : 'Y');
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364}
Rusty Russella14fe242010-08-11 23:04:11 -0600365EXPORT_SYMBOL(param_get_invbool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930367const struct kernel_param_ops param_ops_invbool = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600368 .set = param_set_invbool,
369 .get = param_get_invbool,
370};
371EXPORT_SYMBOL(param_ops_invbool);
372
Rusty Russell69116f22012-01-13 09:32:17 +1030373int param_set_bint(const char *val, const struct kernel_param *kp)
374{
Dan Streetman5104b7d2015-06-17 06:17:52 +0930375 /* Match bool exactly, by re-using it. */
376 struct kernel_param boolkp = *kp;
Rusty Russell69116f22012-01-13 09:32:17 +1030377 bool v;
378 int ret;
379
Rusty Russell69116f22012-01-13 09:32:17 +1030380 boolkp.arg = &v;
Rusty Russell69116f22012-01-13 09:32:17 +1030381
382 ret = param_set_bool(val, &boolkp);
383 if (ret == 0)
384 *(int *)kp->arg = v;
385 return ret;
386}
387EXPORT_SYMBOL(param_set_bint);
388
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930389const struct kernel_param_ops param_ops_bint = {
Jani Nikula6a4c2642014-08-27 06:21:23 +0930390 .flags = KERNEL_PARAM_OPS_FL_NOARG,
Rusty Russell69116f22012-01-13 09:32:17 +1030391 .set = param_set_bint,
392 .get = param_get_int,
393};
394EXPORT_SYMBOL(param_ops_bint);
395
Bert Wesarg9730b5b2007-05-08 00:28:50 -0700396/* We break the rule and mangle the string. */
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930397static int param_array(struct module *mod,
398 const char *name,
Adrian Bunk98717282006-03-25 03:07:06 -0800399 const char *val,
400 unsigned int min, unsigned int max,
401 void *elem, int elemsize,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600402 int (*set)(const char *, const struct kernel_param *kp),
Pawel Moll026cee02012-03-26 12:50:51 +1030403 s16 level,
Richard Knutssoneb38a992008-02-06 01:37:50 -0800404 unsigned int *num)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700405{
406 int ret;
407 struct kernel_param kp;
408 char save;
409
410 /* Get the name right for errors. */
411 kp.name = name;
412 kp.arg = elem;
Pawel Moll026cee02012-03-26 12:50:51 +1030413 kp.level = level;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414
Linus Torvalds1da177e2005-04-16 15:20:36 -0700415 *num = 0;
416 /* We expect a comma-separated list of values. */
417 do {
418 int len;
419
420 if (*num == max) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600421 pr_err("%s: can only take %i arguments\n", name, max);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422 return -EINVAL;
423 }
424 len = strcspn(val, ",");
425
426 /* nul-terminate and parse */
427 save = val[len];
428 ((char *)val)[len] = '\0';
Rusty Russellcf2fde72015-06-26 06:44:38 +0930429 check_kparam_locked(mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430 ret = set(val, &kp);
431
432 if (ret != 0)
433 return ret;
434 kp.arg += elemsize;
435 val += len+1;
436 (*num)++;
437 } while (save == ',');
438
439 if (*num < min) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600440 pr_err("%s: needs at least %i arguments\n", name, min);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700441 return -EINVAL;
442 }
443 return 0;
444}
445
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600446static int param_array_set(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700448 const struct kparam_array *arr = kp->arr;
Bert Wesarg31143a12005-04-16 15:25:42 -0700449 unsigned int temp_num;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930451 return param_array(kp->mod, kp->name, val, 1, arr->max, arr->elem,
Pawel Moll026cee02012-03-26 12:50:51 +1030452 arr->elemsize, arr->ops->set, kp->level,
Rusty Russell3c7d76e2009-10-29 08:56:19 -0600453 arr->num ?: &temp_num);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700454}
455
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600456static int param_array_get(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457{
458 int i, off, ret;
Jan Beulich22e48ea2007-10-16 23:29:34 -0700459 const struct kparam_array *arr = kp->arr;
Dan Streetman5104b7d2015-06-17 06:17:52 +0930460 struct kernel_param p = *kp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461
Linus Torvalds1da177e2005-04-16 15:20:36 -0700462 for (i = off = 0; i < (arr->num ? *arr->num : arr->max); i++) {
463 if (i)
464 buffer[off++] = ',';
465 p.arg = arr->elem + arr->elemsize * i;
Rusty Russellcf2fde72015-06-26 06:44:38 +0930466 check_kparam_locked(p.mod);
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600467 ret = arr->ops->get(buffer + off, &p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700468 if (ret < 0)
469 return ret;
470 off += ret;
471 }
472 buffer[off] = '\0';
473 return off;
474}
475
Rusty Russelle6df34a2010-08-11 23:04:17 -0600476static void param_array_free(void *arg)
477{
478 unsigned int i;
479 const struct kparam_array *arr = arg;
480
481 if (arr->ops->free)
482 for (i = 0; i < (arr->num ? *arr->num : arr->max); i++)
483 arr->ops->free(arr->elem + arr->elemsize * i);
484}
485
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930486const struct kernel_param_ops param_array_ops = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600487 .set = param_array_set,
488 .get = param_array_get,
Rusty Russelle6df34a2010-08-11 23:04:17 -0600489 .free = param_array_free,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600490};
491EXPORT_SYMBOL(param_array_ops);
492
493int param_set_copystring(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700495 const struct kparam_string *kps = kp->str;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700496
497 if (strlen(val)+1 > kps->maxlen) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600498 pr_err("%s: string doesn't fit in %u chars.\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499 kp->name, kps->maxlen-1);
500 return -ENOSPC;
501 }
502 strcpy(kps->string, val);
503 return 0;
504}
Rusty Russella14fe242010-08-11 23:04:11 -0600505EXPORT_SYMBOL(param_set_copystring);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600507int param_get_string(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700508{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700509 const struct kparam_string *kps = kp->str;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510 return strlcpy(buffer, kps->string, kps->maxlen);
511}
Rusty Russella14fe242010-08-11 23:04:11 -0600512EXPORT_SYMBOL(param_get_string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930514const struct kernel_param_ops param_ops_string = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600515 .set = param_set_copystring,
516 .get = param_get_string,
517};
518EXPORT_SYMBOL(param_ops_string);
519
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520/* sysfs output in /sys/modules/XYZ/parameters/ */
Edward Z. Yang350f8252010-02-01 18:26:59 -0500521#define to_module_attr(n) container_of(n, struct module_attribute, attr)
522#define to_module_kobject(n) container_of(n, struct module_kobject, kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700523
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524struct param_attribute
525{
526 struct module_attribute mattr;
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600527 const struct kernel_param *param;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528};
529
530struct module_param_attrs
531{
Rusty Russell9b473de2008-10-22 10:00:22 -0500532 unsigned int num;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700533 struct attribute_group grp;
534 struct param_attribute attrs[0];
535};
536
Randy Dunlapef665c12007-02-13 15:19:06 -0800537#ifdef CONFIG_SYSFS
Edward Z. Yang350f8252010-02-01 18:26:59 -0500538#define to_param_attr(n) container_of(n, struct param_attribute, mattr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539
540static ssize_t param_attr_show(struct module_attribute *mattr,
Kay Sievers4befb022011-07-24 22:06:04 +0930541 struct module_kobject *mk, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542{
543 int count;
544 struct param_attribute *attribute = to_param_attr(mattr);
545
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600546 if (!attribute->param->ops->get)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700547 return -EPERM;
548
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930549 kernel_param_lock(mk->mod);
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600550 count = attribute->param->ops->get(buf, attribute->param);
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930551 kernel_param_unlock(mk->mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700552 if (count > 0) {
553 strcat(buf, "\n");
554 ++count;
555 }
556 return count;
557}
558
559/* sysfs always hands a nul-terminated string in buf. We rely on that. */
560static ssize_t param_attr_store(struct module_attribute *mattr,
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930561 struct module_kobject *mk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 const char *buf, size_t len)
563{
564 int err;
565 struct param_attribute *attribute = to_param_attr(mattr);
566
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600567 if (!attribute->param->ops->set)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700568 return -EPERM;
569
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930570 kernel_param_lock(mk->mod);
Rusty Russell7a486d372014-08-27 06:25:23 +0930571 param_check_unsafe(attribute->param);
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600572 err = attribute->param->ops->set(buf, attribute->param);
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930573 kernel_param_unlock(mk->mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 if (!err)
575 return len;
576 return err;
577}
Randy Dunlapef665c12007-02-13 15:19:06 -0800578#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579
580#ifdef CONFIG_MODULES
581#define __modinit
582#else
583#define __modinit __init
584#endif
585
Randy Dunlapef665c12007-02-13 15:19:06 -0800586#ifdef CONFIG_SYSFS
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930587void kernel_param_lock(struct module *mod)
Rusty Russell907b29e2010-08-11 23:04:19 -0600588{
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930589 mutex_lock(KPARAM_MUTEX(mod));
Rusty Russell907b29e2010-08-11 23:04:19 -0600590}
Rusty Russell907b29e2010-08-11 23:04:19 -0600591
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930592void kernel_param_unlock(struct module *mod)
Rusty Russell907b29e2010-08-11 23:04:19 -0600593{
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930594 mutex_unlock(KPARAM_MUTEX(mod));
Rusty Russell907b29e2010-08-11 23:04:19 -0600595}
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930596
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930597EXPORT_SYMBOL(kernel_param_lock);
598EXPORT_SYMBOL(kernel_param_unlock);
Rusty Russell907b29e2010-08-11 23:04:19 -0600599
Linus Torvalds1da177e2005-04-16 15:20:36 -0700600/*
Rusty Russell9b473de2008-10-22 10:00:22 -0500601 * add_sysfs_param - add a parameter to sysfs
602 * @mk: struct module_kobject
Jean Delvare630cc2b2017-10-03 16:14:18 -0700603 * @kp: the actual parameter definition to add to sysfs
Rusty Russell9b473de2008-10-22 10:00:22 -0500604 * @name: name of parameter
Linus Torvalds1da177e2005-04-16 15:20:36 -0700605 *
Rusty Russell9b473de2008-10-22 10:00:22 -0500606 * Create a kobject if for a (per-module) parameter if mp NULL, and
607 * create file in sysfs. Returns an error on out of memory. Always cleans up
608 * if there's an error.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700609 */
Rusty Russell9b473de2008-10-22 10:00:22 -0500610static __modinit int add_sysfs_param(struct module_kobject *mk,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600611 const struct kernel_param *kp,
Rusty Russell9b473de2008-10-22 10:00:22 -0500612 const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700613{
Rusty Russell18eb74f2014-11-10 09:32:29 +1030614 struct module_param_attrs *new_mp;
615 struct attribute **new_attrs;
616 unsigned int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700617
Rusty Russell9b473de2008-10-22 10:00:22 -0500618 /* We don't bother calling this with invisible parameters. */
619 BUG_ON(!kp->perm);
620
621 if (!mk->mp) {
Rusty Russell18eb74f2014-11-10 09:32:29 +1030622 /* First allocation. */
623 mk->mp = kzalloc(sizeof(*mk->mp), GFP_KERNEL);
624 if (!mk->mp)
625 return -ENOMEM;
626 mk->mp->grp.name = "parameters";
627 /* NULL-terminated attribute array. */
628 mk->mp->grp.attrs = kzalloc(sizeof(mk->mp->grp.attrs[0]),
629 GFP_KERNEL);
630 /* Caller will cleanup via free_module_param_attrs */
631 if (!mk->mp->grp.attrs)
632 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633 }
634
Rusty Russell18eb74f2014-11-10 09:32:29 +1030635 /* Enlarge allocations. */
636 new_mp = krealloc(mk->mp,
637 sizeof(*mk->mp) +
638 sizeof(mk->mp->attrs[0]) * (mk->mp->num + 1),
639 GFP_KERNEL);
640 if (!new_mp)
641 return -ENOMEM;
642 mk->mp = new_mp;
Rusty Russell9b473de2008-10-22 10:00:22 -0500643
Rusty Russell18eb74f2014-11-10 09:32:29 +1030644 /* Extra pointer for NULL terminator */
645 new_attrs = krealloc(mk->mp->grp.attrs,
646 sizeof(mk->mp->grp.attrs[0]) * (mk->mp->num + 2),
647 GFP_KERNEL);
648 if (!new_attrs)
649 return -ENOMEM;
650 mk->mp->grp.attrs = new_attrs;
Rusty Russell9b473de2008-10-22 10:00:22 -0500651
652 /* Tack new one on the end. */
Rusty Russellc772be52015-01-20 09:07:04 +1030653 memset(&mk->mp->attrs[mk->mp->num], 0, sizeof(mk->mp->attrs[0]));
Rusty Russell18eb74f2014-11-10 09:32:29 +1030654 sysfs_attr_init(&mk->mp->attrs[mk->mp->num].mattr.attr);
655 mk->mp->attrs[mk->mp->num].param = kp;
656 mk->mp->attrs[mk->mp->num].mattr.show = param_attr_show;
Kees Cookb0a65b02014-12-12 13:36:49 +1030657 /* Do not allow runtime DAC changes to make param writable. */
658 if ((kp->perm & (S_IWUSR | S_IWGRP | S_IWOTH)) != 0)
659 mk->mp->attrs[mk->mp->num].mattr.store = param_attr_store;
Rusty Russell574732c2014-12-23 15:05:36 +1030660 else
661 mk->mp->attrs[mk->mp->num].mattr.store = NULL;
Rusty Russell18eb74f2014-11-10 09:32:29 +1030662 mk->mp->attrs[mk->mp->num].mattr.attr.name = (char *)name;
663 mk->mp->attrs[mk->mp->num].mattr.attr.mode = kp->perm;
664 mk->mp->num++;
Rusty Russell9b473de2008-10-22 10:00:22 -0500665
666 /* Fix up all the pointers, since krealloc can move us */
Rusty Russell18eb74f2014-11-10 09:32:29 +1030667 for (i = 0; i < mk->mp->num; i++)
668 mk->mp->grp.attrs[i] = &mk->mp->attrs[i].mattr.attr;
669 mk->mp->grp.attrs[mk->mp->num] = NULL;
Rusty Russell9b473de2008-10-22 10:00:22 -0500670 return 0;
Rusty Russell9b473de2008-10-22 10:00:22 -0500671}
672
Linus Torvaldsd2441182008-10-23 12:07:17 -0700673#ifdef CONFIG_MODULES
Rusty Russell9b473de2008-10-22 10:00:22 -0500674static void free_module_param_attrs(struct module_kobject *mk)
675{
Rusty Russell18eb74f2014-11-10 09:32:29 +1030676 if (mk->mp)
677 kfree(mk->mp->grp.attrs);
Rusty Russell9b473de2008-10-22 10:00:22 -0500678 kfree(mk->mp);
679 mk->mp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680}
681
Linus Torvalds1da177e2005-04-16 15:20:36 -0700682/*
683 * module_param_sysfs_setup - setup sysfs support for one module
684 * @mod: module
685 * @kparam: module parameters (array)
686 * @num_params: number of module parameters
687 *
Rusty Russell9b473de2008-10-22 10:00:22 -0500688 * Adds sysfs entries for module parameters under
689 * /sys/module/[mod->name]/parameters/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690 */
691int module_param_sysfs_setup(struct module *mod,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600692 const struct kernel_param *kparam,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700693 unsigned int num_params)
694{
Rusty Russell9b473de2008-10-22 10:00:22 -0500695 int i, err;
696 bool params = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700697
Rusty Russell9b473de2008-10-22 10:00:22 -0500698 for (i = 0; i < num_params; i++) {
699 if (kparam[i].perm == 0)
700 continue;
701 err = add_sysfs_param(&mod->mkobj, &kparam[i], kparam[i].name);
Rusty Russell18eb74f2014-11-10 09:32:29 +1030702 if (err) {
703 free_module_param_attrs(&mod->mkobj);
Rusty Russell9b473de2008-10-22 10:00:22 -0500704 return err;
Rusty Russell18eb74f2014-11-10 09:32:29 +1030705 }
Rusty Russell9b473de2008-10-22 10:00:22 -0500706 params = true;
707 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708
Rusty Russell9b473de2008-10-22 10:00:22 -0500709 if (!params)
710 return 0;
711
712 /* Create the param group. */
713 err = sysfs_create_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp);
714 if (err)
715 free_module_param_attrs(&mod->mkobj);
716 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717}
718
719/*
720 * module_param_sysfs_remove - remove sysfs support for one module
721 * @mod: module
722 *
723 * Remove sysfs entries for module parameters and the corresponding
724 * kobject.
725 */
726void module_param_sysfs_remove(struct module *mod)
727{
Rusty Russell9b473de2008-10-22 10:00:22 -0500728 if (mod->mkobj.mp) {
729 sysfs_remove_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 /* We are positive that no one is using any param
731 * attrs at this point. Deallocate immediately. */
Rusty Russell9b473de2008-10-22 10:00:22 -0500732 free_module_param_attrs(&mod->mkobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733 }
734}
735#endif
736
Rusty Russelle180a6b2009-03-31 13:05:29 -0600737void destroy_params(const struct kernel_param *params, unsigned num)
738{
Rusty Russelle6df34a2010-08-11 23:04:17 -0600739 unsigned int i;
740
741 for (i = 0; i < num; i++)
742 if (params[i].ops->free)
743 params[i].ops->free(params[i].arg);
Rusty Russelle180a6b2009-03-31 13:05:29 -0600744}
745
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800746static struct module_kobject * __init locate_module_kobject(const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700747{
748 struct module_kobject *mk;
Rusty Russell9b473de2008-10-22 10:00:22 -0500749 struct kobject *kobj;
750 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751
Rusty Russell9b473de2008-10-22 10:00:22 -0500752 kobj = kset_find_obj(module_kset, name);
753 if (kobj) {
Rusty Russell9b473de2008-10-22 10:00:22 -0500754 mk = to_module_kobject(kobj);
Rusty Russell9b473de2008-10-22 10:00:22 -0500755 } else {
756 mk = kzalloc(sizeof(struct module_kobject), GFP_KERNEL);
757 BUG_ON(!mk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758
Rusty Russell9b473de2008-10-22 10:00:22 -0500759 mk->mod = THIS_MODULE;
760 mk->kobj.kset = module_kset;
761 err = kobject_init_and_add(&mk->kobj, &module_ktype, NULL,
762 "%s", name);
Kay Sievers88bfa322011-07-24 22:06:04 +0930763#ifdef CONFIG_MODULES
764 if (!err)
765 err = sysfs_create_file(&mk->kobj, &module_uevent.attr);
766#endif
Rusty Russell9b473de2008-10-22 10:00:22 -0500767 if (err) {
768 kobject_put(&mk->kobj);
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600769 pr_crit("Adding module '%s' to sysfs failed (%d), the system may be unstable.\n",
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800770 name, err);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800771 return NULL;
Rusty Russell9b473de2008-10-22 10:00:22 -0500772 }
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800773
774 /* So that we hold reference in both cases. */
Rusty Russell9b473de2008-10-22 10:00:22 -0500775 kobject_get(&mk->kobj);
Greg Kroah-Hartman74c5b592007-07-30 11:26:38 -0700776 }
Rusty Russell9b473de2008-10-22 10:00:22 -0500777
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800778 return mk;
779}
780
781static void __init kernel_add_sysfs_param(const char *name,
Geert Uytterhoeven63a12d92014-10-13 15:55:44 -0700782 const struct kernel_param *kparam,
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800783 unsigned int name_skip)
784{
785 struct module_kobject *mk;
786 int err;
787
788 mk = locate_module_kobject(name);
789 if (!mk)
790 return;
791
792 /* We need to remove old parameters before adding more. */
793 if (mk->mp)
794 sysfs_remove_group(&mk->kobj, &mk->mp->grp);
795
Rusty Russell9b473de2008-10-22 10:00:22 -0500796 /* These should not fail at boot. */
797 err = add_sysfs_param(mk, kparam, kparam->name + name_skip);
798 BUG_ON(err);
799 err = sysfs_create_group(&mk->kobj, &mk->mp->grp);
800 BUG_ON(err);
Kay Sieversf30c53a2007-01-15 20:22:02 +0100801 kobject_uevent(&mk->kobj, KOBJ_ADD);
Rusty Russell9b473de2008-10-22 10:00:22 -0500802 kobject_put(&mk->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803}
804
805/*
Jean Delvareb634d132013-07-02 15:35:11 +0930806 * param_sysfs_builtin - add sysfs parameters for built-in modules
Linus Torvalds1da177e2005-04-16 15:20:36 -0700807 *
808 * Add module_parameters to sysfs for "modules" built into the kernel.
809 *
810 * The "module" name (KBUILD_MODNAME) is stored before a dot, the
811 * "parameter" name is stored behind a dot in kernel_param->name. So,
812 * extract the "module" name for all built-in kernel_param-eters,
Rusty Russell9b473de2008-10-22 10:00:22 -0500813 * and for all who have the same, call kernel_add_sysfs_param.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814 */
815static void __init param_sysfs_builtin(void)
816{
Geert Uytterhoeven63a12d92014-10-13 15:55:44 -0700817 const struct kernel_param *kp;
Rusty Russell9b473de2008-10-22 10:00:22 -0500818 unsigned int name_len;
819 char modname[MODULE_NAME_LEN];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700820
Rusty Russell9b473de2008-10-22 10:00:22 -0500821 for (kp = __start___param; kp < __stop___param; kp++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700822 char *dot;
823
Rusty Russell9b473de2008-10-22 10:00:22 -0500824 if (kp->perm == 0)
825 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700826
Rusty Russell730b69d2008-10-22 10:00:22 -0500827 dot = strchr(kp->name, '.');
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 if (!dot) {
Rusty Russell67e67ce2008-10-22 10:00:23 -0500829 /* This happens for core_param() */
830 strcpy(modname, "kernel");
831 name_len = 0;
832 } else {
833 name_len = dot - kp->name + 1;
834 strlcpy(modname, kp->name, name_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 }
Rusty Russell67e67ce2008-10-22 10:00:23 -0500836 kernel_add_sysfs_param(modname, kp, name_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838}
839
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800840ssize_t __modver_version_show(struct module_attribute *mattr,
Kay Sievers4befb022011-07-24 22:06:04 +0930841 struct module_kobject *mk, char *buf)
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800842{
843 struct module_version_attribute *vattr =
844 container_of(mattr, struct module_version_attribute, mattr);
845
Chen Gangf4940ab2013-08-20 15:35:04 +0930846 return scnprintf(buf, PAGE_SIZE, "%s\n", vattr->version);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800847}
848
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800849extern const struct module_version_attribute *__start___modver[];
850extern const struct module_version_attribute *__stop___modver[];
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800851
852static void __init version_sysfs_builtin(void)
853{
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800854 const struct module_version_attribute **p;
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800855 struct module_kobject *mk;
856 int err;
857
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800858 for (p = __start___modver; p < __stop___modver; p++) {
859 const struct module_version_attribute *vattr = *p;
860
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800861 mk = locate_module_kobject(vattr->module_name);
862 if (mk) {
863 err = sysfs_create_file(&mk->kobj, &vattr->mattr.attr);
Rusty Russell74c3dea32015-06-17 06:16:52 +0930864 WARN_ON_ONCE(err);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800865 kobject_uevent(&mk->kobj, KOBJ_ADD);
866 kobject_put(&mk->kobj);
867 }
868 }
869}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870
871/* module-related sysfs stuff */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872
Linus Torvalds1da177e2005-04-16 15:20:36 -0700873static ssize_t module_attr_show(struct kobject *kobj,
874 struct attribute *attr,
875 char *buf)
876{
877 struct module_attribute *attribute;
878 struct module_kobject *mk;
879 int ret;
880
881 attribute = to_module_attr(attr);
882 mk = to_module_kobject(kobj);
883
884 if (!attribute->show)
Dmitry Torokhov70f28172005-04-29 01:27:34 -0500885 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886
Kay Sievers4befb022011-07-24 22:06:04 +0930887 ret = attribute->show(attribute, mk, buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700888
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889 return ret;
890}
891
892static ssize_t module_attr_store(struct kobject *kobj,
893 struct attribute *attr,
894 const char *buf, size_t len)
895{
896 struct module_attribute *attribute;
897 struct module_kobject *mk;
898 int ret;
899
900 attribute = to_module_attr(attr);
901 mk = to_module_kobject(kobj);
902
903 if (!attribute->store)
Dmitry Torokhov70f28172005-04-29 01:27:34 -0500904 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905
Kay Sievers4befb022011-07-24 22:06:04 +0930906 ret = attribute->store(attribute, mk, buf, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907
Linus Torvalds1da177e2005-04-16 15:20:36 -0700908 return ret;
909}
910
Emese Revfy52cf25d2010-01-19 02:58:23 +0100911static const struct sysfs_ops module_sysfs_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912 .show = module_attr_show,
913 .store = module_attr_store,
914};
915
Kay Sievers270a6c42007-01-18 13:26:15 +0100916static int uevent_filter(struct kset *kset, struct kobject *kobj)
917{
918 struct kobj_type *ktype = get_ktype(kobj);
919
920 if (ktype == &module_ktype)
921 return 1;
922 return 0;
923}
924
Emese Revfy9cd43612009-12-31 14:52:51 +0100925static const struct kset_uevent_ops module_uevent_ops = {
Kay Sievers270a6c42007-01-18 13:26:15 +0100926 .filter = uevent_filter,
927};
928
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700929struct kset *module_kset;
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700930int module_sysfs_initialized;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700931
Li Zhong942e4432013-09-03 16:33:57 +0930932static void module_kobj_release(struct kobject *kobj)
933{
934 struct module_kobject *mk = to_module_kobject(kobj);
935 complete(mk->kobj_completion);
936}
937
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700938struct kobj_type module_ktype = {
Li Zhong942e4432013-09-03 16:33:57 +0930939 .release = module_kobj_release,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940 .sysfs_ops = &module_sysfs_ops,
941};
942
Linus Torvalds1da177e2005-04-16 15:20:36 -0700943/*
944 * param_sysfs_init - wrapper for built-in params support
945 */
946static int __init param_sysfs_init(void)
947{
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700948 module_kset = kset_create_and_add("module", &module_uevent_ops, NULL);
949 if (!module_kset) {
950 printk(KERN_WARNING "%s (%d): error creating kset\n",
951 __FILE__, __LINE__);
952 return -ENOMEM;
Randy Dunlapd8c76492006-09-29 01:58:55 -0700953 }
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700954 module_sysfs_initialized = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700955
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800956 version_sysfs_builtin();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957 param_sysfs_builtin();
958
959 return 0;
960}
Mark Huangd10be6d2006-09-29 01:59:34 -0700961subsys_initcall(param_sysfs_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700962
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700963#endif /* CONFIG_SYSFS */