blob: ce89f757e6da04ab0f8ee97c66e4dbce1033dc94 [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) {
Chris Wilsonedc41b32018-04-10 16:35:18 -0700114 pr_notice("Setting dangerous option %s - tainting kernel\n",
115 kp->name);
Rusty Russell7a486d372014-08-27 06:25:23 +0930116 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 { \
Jean Delvare96802e62017-10-03 16:16:38 -0700227 return scnprintf(buffer, PAGE_SIZE, format "\n", \
Chen Gangf4940ab2013-08-20 15:35:04 +0930228 *((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
Jean Delvaree0596c82017-10-03 16:16:41 -0700239STANDARD_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);
246STANDARD_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{
Jean Delvare96802e62017-10-03 16:16:38 -0700273 return scnprintf(buffer, PAGE_SIZE, "%s\n", *((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 */
Jean Delvare96802e62017-10-03 16:16:38 -0700304 return sprintf(buffer, "%c\n", *(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{
Jean Delvare96802e62017-10-03 16:16:38 -0700363 return sprintf(buffer, "%c\n", (*(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++) {
Jean Delvare96802e62017-10-03 16:16:38 -0700463 /* Replace \n with comma */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700464 if (i)
Jean Delvare96802e62017-10-03 16:16:38 -0700465 buffer[off - 1] = ',';
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466 p.arg = arr->elem + arr->elemsize * i;
Rusty Russellcf2fde72015-06-26 06:44:38 +0930467 check_kparam_locked(p.mod);
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600468 ret = arr->ops->get(buffer + off, &p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469 if (ret < 0)
470 return ret;
471 off += ret;
472 }
473 buffer[off] = '\0';
474 return off;
475}
476
Rusty Russelle6df34a2010-08-11 23:04:17 -0600477static void param_array_free(void *arg)
478{
479 unsigned int i;
480 const struct kparam_array *arr = arg;
481
482 if (arr->ops->free)
483 for (i = 0; i < (arr->num ? *arr->num : arr->max); i++)
484 arr->ops->free(arr->elem + arr->elemsize * i);
485}
486
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930487const struct kernel_param_ops param_array_ops = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600488 .set = param_array_set,
489 .get = param_array_get,
Rusty Russelle6df34a2010-08-11 23:04:17 -0600490 .free = param_array_free,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600491};
492EXPORT_SYMBOL(param_array_ops);
493
494int param_set_copystring(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700496 const struct kparam_string *kps = kp->str;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700497
498 if (strlen(val)+1 > kps->maxlen) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600499 pr_err("%s: string doesn't fit in %u chars.\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500 kp->name, kps->maxlen-1);
501 return -ENOSPC;
502 }
503 strcpy(kps->string, val);
504 return 0;
505}
Rusty Russella14fe242010-08-11 23:04:11 -0600506EXPORT_SYMBOL(param_set_copystring);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600508int param_get_string(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700510 const struct kparam_string *kps = kp->str;
Jean Delvare96802e62017-10-03 16:16:38 -0700511 return scnprintf(buffer, PAGE_SIZE, "%s\n", kps->string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700512}
Rusty Russella14fe242010-08-11 23:04:11 -0600513EXPORT_SYMBOL(param_get_string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930515const struct kernel_param_ops param_ops_string = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600516 .set = param_set_copystring,
517 .get = param_get_string,
518};
519EXPORT_SYMBOL(param_ops_string);
520
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521/* sysfs output in /sys/modules/XYZ/parameters/ */
Edward Z. Yang350f8252010-02-01 18:26:59 -0500522#define to_module_attr(n) container_of(n, struct module_attribute, attr)
523#define to_module_kobject(n) container_of(n, struct module_kobject, kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700524
Linus Torvalds1da177e2005-04-16 15:20:36 -0700525struct param_attribute
526{
527 struct module_attribute mattr;
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600528 const struct kernel_param *param;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529};
530
531struct module_param_attrs
532{
Rusty Russell9b473de2008-10-22 10:00:22 -0500533 unsigned int num;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534 struct attribute_group grp;
535 struct param_attribute attrs[0];
536};
537
Randy Dunlapef665c12007-02-13 15:19:06 -0800538#ifdef CONFIG_SYSFS
Edward Z. Yang350f8252010-02-01 18:26:59 -0500539#define to_param_attr(n) container_of(n, struct param_attribute, mattr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540
541static ssize_t param_attr_show(struct module_attribute *mattr,
Kay Sievers4befb022011-07-24 22:06:04 +0930542 struct module_kobject *mk, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543{
544 int count;
545 struct param_attribute *attribute = to_param_attr(mattr);
546
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600547 if (!attribute->param->ops->get)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548 return -EPERM;
549
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930550 kernel_param_lock(mk->mod);
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600551 count = attribute->param->ops->get(buf, attribute->param);
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930552 kernel_param_unlock(mk->mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553 return count;
554}
555
556/* sysfs always hands a nul-terminated string in buf. We rely on that. */
557static ssize_t param_attr_store(struct module_attribute *mattr,
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930558 struct module_kobject *mk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700559 const char *buf, size_t len)
560{
561 int err;
562 struct param_attribute *attribute = to_param_attr(mattr);
563
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600564 if (!attribute->param->ops->set)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 return -EPERM;
566
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930567 kernel_param_lock(mk->mod);
Rusty Russell7a486d372014-08-27 06:25:23 +0930568 param_check_unsafe(attribute->param);
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600569 err = attribute->param->ops->set(buf, attribute->param);
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930570 kernel_param_unlock(mk->mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 if (!err)
572 return len;
573 return err;
574}
Randy Dunlapef665c12007-02-13 15:19:06 -0800575#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576
577#ifdef CONFIG_MODULES
578#define __modinit
579#else
580#define __modinit __init
581#endif
582
Randy Dunlapef665c12007-02-13 15:19:06 -0800583#ifdef CONFIG_SYSFS
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930584void kernel_param_lock(struct module *mod)
Rusty Russell907b29e2010-08-11 23:04:19 -0600585{
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930586 mutex_lock(KPARAM_MUTEX(mod));
Rusty Russell907b29e2010-08-11 23:04:19 -0600587}
Rusty Russell907b29e2010-08-11 23:04:19 -0600588
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930589void kernel_param_unlock(struct module *mod)
Rusty Russell907b29e2010-08-11 23:04:19 -0600590{
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930591 mutex_unlock(KPARAM_MUTEX(mod));
Rusty Russell907b29e2010-08-11 23:04:19 -0600592}
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930593
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930594EXPORT_SYMBOL(kernel_param_lock);
595EXPORT_SYMBOL(kernel_param_unlock);
Rusty Russell907b29e2010-08-11 23:04:19 -0600596
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597/*
Rusty Russell9b473de2008-10-22 10:00:22 -0500598 * add_sysfs_param - add a parameter to sysfs
599 * @mk: struct module_kobject
Jean Delvare630cc2b2017-10-03 16:14:18 -0700600 * @kp: the actual parameter definition to add to sysfs
Rusty Russell9b473de2008-10-22 10:00:22 -0500601 * @name: name of parameter
Linus Torvalds1da177e2005-04-16 15:20:36 -0700602 *
Rusty Russell9b473de2008-10-22 10:00:22 -0500603 * 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.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700606 */
Rusty Russell9b473de2008-10-22 10:00:22 -0500607static __modinit int add_sysfs_param(struct module_kobject *mk,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600608 const struct kernel_param *kp,
Rusty Russell9b473de2008-10-22 10:00:22 -0500609 const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700610{
Rusty Russell18eb74f2014-11-10 09:32:29 +1030611 struct module_param_attrs *new_mp;
612 struct attribute **new_attrs;
613 unsigned int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614
Rusty Russell9b473de2008-10-22 10:00:22 -0500615 /* We don't bother calling this with invisible parameters. */
616 BUG_ON(!kp->perm);
617
618 if (!mk->mp) {
Rusty Russell18eb74f2014-11-10 09:32:29 +1030619 /* First allocation. */
620 mk->mp = kzalloc(sizeof(*mk->mp), GFP_KERNEL);
621 if (!mk->mp)
622 return -ENOMEM;
623 mk->mp->grp.name = "parameters";
624 /* NULL-terminated attribute array. */
625 mk->mp->grp.attrs = kzalloc(sizeof(mk->mp->grp.attrs[0]),
626 GFP_KERNEL);
627 /* Caller will cleanup via free_module_param_attrs */
628 if (!mk->mp->grp.attrs)
629 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 }
631
Rusty Russell18eb74f2014-11-10 09:32:29 +1030632 /* Enlarge allocations. */
633 new_mp = krealloc(mk->mp,
634 sizeof(*mk->mp) +
635 sizeof(mk->mp->attrs[0]) * (mk->mp->num + 1),
636 GFP_KERNEL);
637 if (!new_mp)
638 return -ENOMEM;
639 mk->mp = new_mp;
Rusty Russell9b473de2008-10-22 10:00:22 -0500640
Rusty Russell18eb74f2014-11-10 09:32:29 +1030641 /* Extra pointer for NULL terminator */
642 new_attrs = krealloc(mk->mp->grp.attrs,
643 sizeof(mk->mp->grp.attrs[0]) * (mk->mp->num + 2),
644 GFP_KERNEL);
645 if (!new_attrs)
646 return -ENOMEM;
647 mk->mp->grp.attrs = new_attrs;
Rusty Russell9b473de2008-10-22 10:00:22 -0500648
649 /* Tack new one on the end. */
Rusty Russellc772be52015-01-20 09:07:04 +1030650 memset(&mk->mp->attrs[mk->mp->num], 0, sizeof(mk->mp->attrs[0]));
Rusty Russell18eb74f2014-11-10 09:32:29 +1030651 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;
Kees Cookb0a65b02014-12-12 13:36:49 +1030654 /* 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;
Rusty Russell574732c2014-12-23 15:05:36 +1030657 else
658 mk->mp->attrs[mk->mp->num].mattr.store = NULL;
Rusty Russell18eb74f2014-11-10 09:32:29 +1030659 mk->mp->attrs[mk->mp->num].mattr.attr.name = (char *)name;
660 mk->mp->attrs[mk->mp->num].mattr.attr.mode = kp->perm;
661 mk->mp->num++;
Rusty Russell9b473de2008-10-22 10:00:22 -0500662
663 /* Fix up all the pointers, since krealloc can move us */
Rusty Russell18eb74f2014-11-10 09:32:29 +1030664 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;
Rusty Russell9b473de2008-10-22 10:00:22 -0500667 return 0;
Rusty Russell9b473de2008-10-22 10:00:22 -0500668}
669
Linus Torvaldsd2441182008-10-23 12:07:17 -0700670#ifdef CONFIG_MODULES
Rusty Russell9b473de2008-10-22 10:00:22 -0500671static void free_module_param_attrs(struct module_kobject *mk)
672{
Rusty Russell18eb74f2014-11-10 09:32:29 +1030673 if (mk->mp)
674 kfree(mk->mp->grp.attrs);
Rusty Russell9b473de2008-10-22 10:00:22 -0500675 kfree(mk->mp);
676 mk->mp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677}
678
Linus Torvalds1da177e2005-04-16 15:20:36 -0700679/*
680 * module_param_sysfs_setup - setup sysfs support for one module
681 * @mod: module
682 * @kparam: module parameters (array)
683 * @num_params: number of module parameters
684 *
Rusty Russell9b473de2008-10-22 10:00:22 -0500685 * Adds sysfs entries for module parameters under
686 * /sys/module/[mod->name]/parameters/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 */
688int module_param_sysfs_setup(struct module *mod,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600689 const struct kernel_param *kparam,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690 unsigned int num_params)
691{
Rusty Russell9b473de2008-10-22 10:00:22 -0500692 int i, err;
693 bool params = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700694
Rusty Russell9b473de2008-10-22 10:00:22 -0500695 for (i = 0; i < num_params; i++) {
696 if (kparam[i].perm == 0)
697 continue;
698 err = add_sysfs_param(&mod->mkobj, &kparam[i], kparam[i].name);
Rusty Russell18eb74f2014-11-10 09:32:29 +1030699 if (err) {
700 free_module_param_attrs(&mod->mkobj);
Rusty Russell9b473de2008-10-22 10:00:22 -0500701 return err;
Rusty Russell18eb74f2014-11-10 09:32:29 +1030702 }
Rusty Russell9b473de2008-10-22 10:00:22 -0500703 params = true;
704 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705
Rusty Russell9b473de2008-10-22 10:00:22 -0500706 if (!params)
707 return 0;
708
709 /* Create the param group. */
710 err = sysfs_create_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp);
711 if (err)
712 free_module_param_attrs(&mod->mkobj);
713 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714}
715
716/*
717 * module_param_sysfs_remove - remove sysfs support for one module
718 * @mod: module
719 *
720 * Remove sysfs entries for module parameters and the corresponding
721 * kobject.
722 */
723void module_param_sysfs_remove(struct module *mod)
724{
Rusty Russell9b473de2008-10-22 10:00:22 -0500725 if (mod->mkobj.mp) {
726 sysfs_remove_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700727 /* We are positive that no one is using any param
728 * attrs at this point. Deallocate immediately. */
Rusty Russell9b473de2008-10-22 10:00:22 -0500729 free_module_param_attrs(&mod->mkobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 }
731}
732#endif
733
Rusty Russelle180a6b2009-03-31 13:05:29 -0600734void destroy_params(const struct kernel_param *params, unsigned num)
735{
Rusty Russelle6df34a2010-08-11 23:04:17 -0600736 unsigned int i;
737
738 for (i = 0; i < num; i++)
739 if (params[i].ops->free)
740 params[i].ops->free(params[i].arg);
Rusty Russelle180a6b2009-03-31 13:05:29 -0600741}
742
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800743static struct module_kobject * __init locate_module_kobject(const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744{
745 struct module_kobject *mk;
Rusty Russell9b473de2008-10-22 10:00:22 -0500746 struct kobject *kobj;
747 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700748
Rusty Russell9b473de2008-10-22 10:00:22 -0500749 kobj = kset_find_obj(module_kset, name);
750 if (kobj) {
Rusty Russell9b473de2008-10-22 10:00:22 -0500751 mk = to_module_kobject(kobj);
Rusty Russell9b473de2008-10-22 10:00:22 -0500752 } else {
753 mk = kzalloc(sizeof(struct module_kobject), GFP_KERNEL);
754 BUG_ON(!mk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755
Rusty Russell9b473de2008-10-22 10:00:22 -0500756 mk->mod = THIS_MODULE;
757 mk->kobj.kset = module_kset;
758 err = kobject_init_and_add(&mk->kobj, &module_ktype, NULL,
759 "%s", name);
Kay Sievers88bfa322011-07-24 22:06:04 +0930760#ifdef CONFIG_MODULES
761 if (!err)
762 err = sysfs_create_file(&mk->kobj, &module_uevent.attr);
763#endif
Rusty Russell9b473de2008-10-22 10:00:22 -0500764 if (err) {
765 kobject_put(&mk->kobj);
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600766 pr_crit("Adding module '%s' to sysfs failed (%d), the system may be unstable.\n",
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800767 name, err);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800768 return NULL;
Rusty Russell9b473de2008-10-22 10:00:22 -0500769 }
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800770
771 /* So that we hold reference in both cases. */
Rusty Russell9b473de2008-10-22 10:00:22 -0500772 kobject_get(&mk->kobj);
Greg Kroah-Hartman74c5b592007-07-30 11:26:38 -0700773 }
Rusty Russell9b473de2008-10-22 10:00:22 -0500774
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800775 return mk;
776}
777
778static void __init kernel_add_sysfs_param(const char *name,
Geert Uytterhoeven63a12d92014-10-13 15:55:44 -0700779 const struct kernel_param *kparam,
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800780 unsigned int name_skip)
781{
782 struct module_kobject *mk;
783 int err;
784
785 mk = locate_module_kobject(name);
786 if (!mk)
787 return;
788
789 /* We need to remove old parameters before adding more. */
790 if (mk->mp)
791 sysfs_remove_group(&mk->kobj, &mk->mp->grp);
792
Rusty Russell9b473de2008-10-22 10:00:22 -0500793 /* These should not fail at boot. */
794 err = add_sysfs_param(mk, kparam, kparam->name + name_skip);
795 BUG_ON(err);
796 err = sysfs_create_group(&mk->kobj, &mk->mp->grp);
797 BUG_ON(err);
Kay Sieversf30c53a2007-01-15 20:22:02 +0100798 kobject_uevent(&mk->kobj, KOBJ_ADD);
Rusty Russell9b473de2008-10-22 10:00:22 -0500799 kobject_put(&mk->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800}
801
802/*
Jean Delvareb634d132013-07-02 15:35:11 +0930803 * param_sysfs_builtin - add sysfs parameters for built-in modules
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804 *
805 * Add module_parameters to sysfs for "modules" built into the kernel.
806 *
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,
Rusty Russell9b473de2008-10-22 10:00:22 -0500810 * and for all who have the same, call kernel_add_sysfs_param.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811 */
812static void __init param_sysfs_builtin(void)
813{
Geert Uytterhoeven63a12d92014-10-13 15:55:44 -0700814 const struct kernel_param *kp;
Rusty Russell9b473de2008-10-22 10:00:22 -0500815 unsigned int name_len;
816 char modname[MODULE_NAME_LEN];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700817
Rusty Russell9b473de2008-10-22 10:00:22 -0500818 for (kp = __start___param; kp < __stop___param; kp++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700819 char *dot;
820
Rusty Russell9b473de2008-10-22 10:00:22 -0500821 if (kp->perm == 0)
822 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700823
Rusty Russell730b69d2008-10-22 10:00:22 -0500824 dot = strchr(kp->name, '.');
Linus Torvalds1da177e2005-04-16 15:20:36 -0700825 if (!dot) {
Rusty Russell67e67ce2008-10-22 10:00:23 -0500826 /* This happens for core_param() */
827 strcpy(modname, "kernel");
828 name_len = 0;
829 } else {
830 name_len = dot - kp->name + 1;
831 strlcpy(modname, kp->name, name_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832 }
Rusty Russell67e67ce2008-10-22 10:00:23 -0500833 kernel_add_sysfs_param(modname, kp, name_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835}
836
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800837ssize_t __modver_version_show(struct module_attribute *mattr,
Kay Sievers4befb022011-07-24 22:06:04 +0930838 struct module_kobject *mk, char *buf)
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800839{
840 struct module_version_attribute *vattr =
841 container_of(mattr, struct module_version_attribute, mattr);
842
Chen Gangf4940ab2013-08-20 15:35:04 +0930843 return scnprintf(buf, PAGE_SIZE, "%s\n", vattr->version);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800844}
845
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800846extern const struct module_version_attribute *__start___modver[];
847extern const struct module_version_attribute *__stop___modver[];
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800848
849static void __init version_sysfs_builtin(void)
850{
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800851 const struct module_version_attribute **p;
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800852 struct module_kobject *mk;
853 int err;
854
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800855 for (p = __start___modver; p < __stop___modver; p++) {
856 const struct module_version_attribute *vattr = *p;
857
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800858 mk = locate_module_kobject(vattr->module_name);
859 if (mk) {
860 err = sysfs_create_file(&mk->kobj, &vattr->mattr.attr);
Rusty Russell74c3dea32015-06-17 06:16:52 +0930861 WARN_ON_ONCE(err);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800862 kobject_uevent(&mk->kobj, KOBJ_ADD);
863 kobject_put(&mk->kobj);
864 }
865 }
866}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700867
868/* module-related sysfs stuff */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700869
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870static ssize_t module_attr_show(struct kobject *kobj,
871 struct attribute *attr,
872 char *buf)
873{
874 struct module_attribute *attribute;
875 struct module_kobject *mk;
876 int ret;
877
878 attribute = to_module_attr(attr);
879 mk = to_module_kobject(kobj);
880
881 if (!attribute->show)
Dmitry Torokhov70f28172005-04-29 01:27:34 -0500882 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700883
Kay Sievers4befb022011-07-24 22:06:04 +0930884 ret = attribute->show(attribute, mk, buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700885
Linus Torvalds1da177e2005-04-16 15:20:36 -0700886 return ret;
887}
888
889static ssize_t module_attr_store(struct kobject *kobj,
890 struct attribute *attr,
891 const char *buf, size_t len)
892{
893 struct module_attribute *attribute;
894 struct module_kobject *mk;
895 int ret;
896
897 attribute = to_module_attr(attr);
898 mk = to_module_kobject(kobj);
899
900 if (!attribute->store)
Dmitry Torokhov70f28172005-04-29 01:27:34 -0500901 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700902
Kay Sievers4befb022011-07-24 22:06:04 +0930903 ret = attribute->store(attribute, mk, buf, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700904
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905 return ret;
906}
907
Emese Revfy52cf25d2010-01-19 02:58:23 +0100908static const struct sysfs_ops module_sysfs_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909 .show = module_attr_show,
910 .store = module_attr_store,
911};
912
Kay Sievers270a6c42007-01-18 13:26:15 +0100913static int uevent_filter(struct kset *kset, struct kobject *kobj)
914{
915 struct kobj_type *ktype = get_ktype(kobj);
916
917 if (ktype == &module_ktype)
918 return 1;
919 return 0;
920}
921
Emese Revfy9cd43612009-12-31 14:52:51 +0100922static const struct kset_uevent_ops module_uevent_ops = {
Kay Sievers270a6c42007-01-18 13:26:15 +0100923 .filter = uevent_filter,
924};
925
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700926struct kset *module_kset;
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700927int module_sysfs_initialized;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928
Li Zhong942e4432013-09-03 16:33:57 +0930929static void module_kobj_release(struct kobject *kobj)
930{
931 struct module_kobject *mk = to_module_kobject(kobj);
932 complete(mk->kobj_completion);
933}
934
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700935struct kobj_type module_ktype = {
Li Zhong942e4432013-09-03 16:33:57 +0930936 .release = module_kobj_release,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700937 .sysfs_ops = &module_sysfs_ops,
938};
939
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940/*
941 * param_sysfs_init - wrapper for built-in params support
942 */
943static int __init param_sysfs_init(void)
944{
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700945 module_kset = kset_create_and_add("module", &module_uevent_ops, NULL);
946 if (!module_kset) {
947 printk(KERN_WARNING "%s (%d): error creating kset\n",
948 __FILE__, __LINE__);
949 return -ENOMEM;
Randy Dunlapd8c76492006-09-29 01:58:55 -0700950 }
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700951 module_sysfs_initialized = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800953 version_sysfs_builtin();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954 param_sysfs_builtin();
955
956 return 0;
957}
Mark Huangd10be6d2006-09-29 01:59:34 -0700958subsys_initcall(param_sysfs_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700960#endif /* CONFIG_SYSFS */