blob: a6d6149c0fe60df1ca38d9a66acef281b78ee79d [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 Streetmanb51d23e42015-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 Streetmanb51d23e42015-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 Streetmanb51d23e42015-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 Streetmanb51d23e42015-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 Streetmanb51d23e42015-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 Streetmanb51d23e42015-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 Streetmanb51d23e42015-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 Streetmanb51d23e42015-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 Streetmanb51d23e42015-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 Streetmanb51d23e42015-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 Streetmanb51d23e42015-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
163/* You can use " around spaces, but can't escape ". */
164/* Hyphens and underscores equivalent in parameter names. */
165static char *next_arg(char *args, char **param, char **val)
166{
167 unsigned int i, equals = 0;
168 int in_quote = 0, quoted = 0;
169 char *next;
170
Linus Torvalds1da177e2005-04-16 15:20:36 -0700171 if (*args == '"') {
172 args++;
173 in_quote = 1;
174 quoted = 1;
175 }
176
177 for (i = 0; args[i]; i++) {
Peter Oberparleiter26d052b2009-07-06 17:11:22 +0200178 if (isspace(args[i]) && !in_quote)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179 break;
180 if (equals == 0) {
181 if (args[i] == '=')
182 equals = i;
183 }
184 if (args[i] == '"')
185 in_quote = !in_quote;
186 }
187
188 *param = args;
189 if (!equals)
190 *val = NULL;
191 else {
192 args[equals] = '\0';
193 *val = args + equals + 1;
194
195 /* Don't include quotes in value. */
196 if (**val == '"') {
197 (*val)++;
198 if (args[i-1] == '"')
199 args[i-1] = '\0';
200 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201 }
Rusty Russellb9cc4482015-04-15 13:23:48 +0930202 if (quoted && args[i-1] == '"')
203 args[i-1] = '\0';
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204
205 if (args[i]) {
206 args[i] = '\0';
207 next = args + i + 1;
208 } else
209 next = args + i;
Rusty Russellf36462f2005-09-27 21:45:34 -0700210
211 /* Chew up trailing spaces. */
André Goddard Rosae7d28602009-12-14 18:01:06 -0800212 return skip_spaces(next);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213}
214
215/* Args looks like "foo=bar,bar2 baz=fuz wiz". */
Rusty Russell51e158c2014-04-28 11:34:33 +0930216char *parse_args(const char *doing,
217 char *args,
218 const struct kernel_param *params,
219 unsigned num,
220 s16 min_level,
221 s16 max_level,
Luis R. Rodriguezecc86172015-03-30 16:20:03 -0700222 void *arg,
223 int (*unknown)(char *param, char *val,
224 const char *doing, void *arg))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225{
Oleg Nesterov74b22c42015-08-26 09:42:34 +0930226 char *param, *val, *err = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700227
Rusty Russellf36462f2005-09-27 21:45:34 -0700228 /* Chew leading spaces */
André Goddard Rosae7d28602009-12-14 18:01:06 -0800229 args = skip_spaces(args);
Rusty Russellf36462f2005-09-27 21:45:34 -0700230
Jim Cromie1ef9eaf2012-05-03 11:57:37 -0600231 if (*args)
Jim Cromie9fb48c72012-04-27 14:30:34 -0600232 pr_debug("doing %s, parsing ARGS: '%s'\n", doing, args);
233
Linus Torvalds1da177e2005-04-16 15:20:36 -0700234 while (*args) {
235 int ret;
Ard van Breemena416aba2007-01-05 16:36:20 -0800236 int irq_was_disabled;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237
238 args = next_arg(args, &param, &val);
Rusty Russell51e158c2014-04-28 11:34:33 +0930239 /* Stop at -- */
240 if (!val && strcmp(param, "--") == 0)
Oleg Nesterov74b22c42015-08-26 09:42:34 +0930241 return err ?: args;
Ard van Breemena416aba2007-01-05 16:36:20 -0800242 irq_was_disabled = irqs_disabled();
Jim Cromie9fb48c72012-04-27 14:30:34 -0600243 ret = parse_one(param, val, doing, params, num,
Luis R. Rodriguezecc86172015-03-30 16:20:03 -0700244 min_level, max_level, arg, unknown);
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600245 if (irq_was_disabled && !irqs_disabled())
246 pr_warn("%s: option '%s' enabled irq's!\n",
247 doing, param);
248
Linus Torvalds1da177e2005-04-16 15:20:36 -0700249 switch (ret) {
Oleg Nesterov74b22c42015-08-26 09:42:34 +0930250 case 0:
251 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700252 case -ENOENT:
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600253 pr_err("%s: Unknown parameter `%s'\n", doing, param);
Oleg Nesterov74b22c42015-08-26 09:42:34 +0930254 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255 case -ENOSPC:
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600256 pr_err("%s: `%s' too large for parameter `%s'\n",
Jim Cromie9fb48c72012-04-27 14:30:34 -0600257 doing, val ?: "", param);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 break;
259 default:
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600260 pr_err("%s: `%s' invalid for parameter `%s'\n",
Jim Cromie9fb48c72012-04-27 14:30:34 -0600261 doing, val ?: "", param);
Oleg Nesterov74b22c42015-08-26 09:42:34 +0930262 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 }
Oleg Nesterov74b22c42015-08-26 09:42:34 +0930264
265 err = ERR_PTR(ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700266 }
267
Oleg Nesterov74b22c42015-08-26 09:42:34 +0930268 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269}
270
271/* Lazy bastard, eh? */
Felipe Contreras88a88b322013-12-04 14:09:38 +1030272#define STANDARD_PARAM_DEF(name, type, format, strtolfn) \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600273 int param_set_##name(const char *val, const struct kernel_param *kp) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 { \
Felipe Contreras88a88b322013-12-04 14:09:38 +1030275 return strtolfn(val, 0, (type *)kp->arg); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 } \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600277 int param_get_##name(char *buffer, const struct kernel_param *kp) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278 { \
Chen Gangf4940ab2013-08-20 15:35:04 +0930279 return scnprintf(buffer, PAGE_SIZE, format, \
280 *((type *)kp->arg)); \
Rusty Russella14fe242010-08-11 23:04:11 -0600281 } \
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930282 const struct kernel_param_ops param_ops_##name = { \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600283 .set = param_set_##name, \
284 .get = param_get_##name, \
285 }; \
Rusty Russella14fe242010-08-11 23:04:11 -0600286 EXPORT_SYMBOL(param_set_##name); \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600287 EXPORT_SYMBOL(param_get_##name); \
288 EXPORT_SYMBOL(param_ops_##name)
289
Linus Torvalds1da177e2005-04-16 15:20:36 -0700290
Felipe Contreras88a88b322013-12-04 14:09:38 +1030291STANDARD_PARAM_DEF(byte, unsigned char, "%hhu", kstrtou8);
292STANDARD_PARAM_DEF(short, short, "%hi", kstrtos16);
293STANDARD_PARAM_DEF(ushort, unsigned short, "%hu", kstrtou16);
294STANDARD_PARAM_DEF(int, int, "%i", kstrtoint);
295STANDARD_PARAM_DEF(uint, unsigned int, "%u", kstrtouint);
296STANDARD_PARAM_DEF(long, long, "%li", kstrtol);
297STANDARD_PARAM_DEF(ulong, unsigned long, "%lu", kstrtoul);
Hannes Reineckeb4210b82014-06-25 15:27:37 +0200298STANDARD_PARAM_DEF(ullong, unsigned long long, "%llu", kstrtoull);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700299
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600300int param_set_charp(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302 if (strlen(val) > 1024) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600303 pr_err("%s: string parameter too long\n", kp->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 return -ENOSPC;
305 }
306
Rusty Russella1054322010-08-11 23:04:18 -0600307 maybe_kfree_parameter(*(char **)kp->arg);
308
309 /* This is a hack. We can't kmalloc in early boot, and we
Rusty Russelle180a6b2009-03-31 13:05:29 -0600310 * don't need to; this mangled commandline is preserved. */
311 if (slab_is_available()) {
Rusty Russella1054322010-08-11 23:04:18 -0600312 *(char **)kp->arg = kmalloc_parameter(strlen(val)+1);
Rusty Russelld553ad82009-10-29 08:56:17 -0600313 if (!*(char **)kp->arg)
Rusty Russelle180a6b2009-03-31 13:05:29 -0600314 return -ENOMEM;
Rusty Russella1054322010-08-11 23:04:18 -0600315 strcpy(*(char **)kp->arg, val);
Rusty Russelle180a6b2009-03-31 13:05:29 -0600316 } else
317 *(const char **)kp->arg = val;
318
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 return 0;
320}
Rusty Russella14fe242010-08-11 23:04:11 -0600321EXPORT_SYMBOL(param_set_charp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600323int param_get_charp(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324{
Chen Gangf4940ab2013-08-20 15:35:04 +0930325 return scnprintf(buffer, PAGE_SIZE, "%s", *((char **)kp->arg));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326}
Rusty Russella14fe242010-08-11 23:04:11 -0600327EXPORT_SYMBOL(param_get_charp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328
Dan Streetman3d9c6372015-11-06 16:29:12 -0800329void param_free_charp(void *arg)
Rusty Russella1054322010-08-11 23:04:18 -0600330{
331 maybe_kfree_parameter(*((char **)arg));
332}
Dan Streetman3d9c6372015-11-06 16:29:12 -0800333EXPORT_SYMBOL(param_free_charp);
Rusty Russella1054322010-08-11 23:04:18 -0600334
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930335const struct kernel_param_ops param_ops_charp = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600336 .set = param_set_charp,
337 .get = param_get_charp,
Rusty Russella1054322010-08-11 23:04:18 -0600338 .free = param_free_charp,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600339};
340EXPORT_SYMBOL(param_ops_charp);
341
Rusty Russellfddd5202009-06-12 21:46:57 -0600342/* Actually could be a bool or an int, for historical reasons. */
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600343int param_set_bool(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700344{
345 /* No equals means "set"... */
346 if (!val) val = "1";
347
348 /* One of =[yYnN01] */
Rusty Russell8b8252812012-03-26 12:50:51 +1030349 return strtobool(val, kp->arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700350}
Rusty Russella14fe242010-08-11 23:04:11 -0600351EXPORT_SYMBOL(param_set_bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600353int param_get_bool(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700354{
355 /* Y and N chosen as being relatively non-coder friendly */
Rusty Russell8b8252812012-03-26 12:50:51 +1030356 return sprintf(buffer, "%c", *(bool *)kp->arg ? 'Y' : 'N');
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357}
Rusty Russella14fe242010-08-11 23:04:11 -0600358EXPORT_SYMBOL(param_get_bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700359
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930360const struct kernel_param_ops param_ops_bool = {
Jani Nikula6a4c2642014-08-27 06:21:23 +0930361 .flags = KERNEL_PARAM_OPS_FL_NOARG,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600362 .set = param_set_bool,
363 .get = param_get_bool,
364};
365EXPORT_SYMBOL(param_ops_bool);
366
Luis R. Rodriguezd19f05d2015-05-27 11:09:38 +0930367int param_set_bool_enable_only(const char *val, const struct kernel_param *kp)
368{
369 int err = 0;
370 bool new_value;
371 bool orig_value = *(bool *)kp->arg;
372 struct kernel_param dummy_kp = *kp;
373
374 dummy_kp.arg = &new_value;
375
376 err = param_set_bool(val, &dummy_kp);
377 if (err)
378 return err;
379
380 /* Don't let them unset it once it's set! */
381 if (!new_value && orig_value)
382 return -EROFS;
383
384 if (new_value)
385 err = param_set_bool(val, kp);
386
387 return err;
388}
389EXPORT_SYMBOL_GPL(param_set_bool_enable_only);
390
391const struct kernel_param_ops param_ops_bool_enable_only = {
392 .flags = KERNEL_PARAM_OPS_FL_NOARG,
393 .set = param_set_bool_enable_only,
394 .get = param_get_bool,
395};
Luis R. Rodriguez154be212015-05-27 11:09:39 +0930396EXPORT_SYMBOL_GPL(param_ops_bool_enable_only);
Luis R. Rodriguezd19f05d2015-05-27 11:09:38 +0930397
Rusty Russellfddd5202009-06-12 21:46:57 -0600398/* This one must be bool. */
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600399int param_set_invbool(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400{
Rusty Russellfddd5202009-06-12 21:46:57 -0600401 int ret;
402 bool boolval;
Jan Beulich22e48ea2007-10-16 23:29:34 -0700403 struct kernel_param dummy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700404
Jan Beulich22e48ea2007-10-16 23:29:34 -0700405 dummy.arg = &boolval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700406 ret = param_set_bool(val, &dummy);
407 if (ret == 0)
Rusty Russell9a71af22009-06-12 21:46:53 -0600408 *(bool *)kp->arg = !boolval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700409 return ret;
410}
Rusty Russella14fe242010-08-11 23:04:11 -0600411EXPORT_SYMBOL(param_set_invbool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600413int param_get_invbool(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414{
Rusty Russell9a71af22009-06-12 21:46:53 -0600415 return sprintf(buffer, "%c", (*(bool *)kp->arg) ? 'N' : 'Y');
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416}
Rusty Russella14fe242010-08-11 23:04:11 -0600417EXPORT_SYMBOL(param_get_invbool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930419const struct kernel_param_ops param_ops_invbool = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600420 .set = param_set_invbool,
421 .get = param_get_invbool,
422};
423EXPORT_SYMBOL(param_ops_invbool);
424
Rusty Russell69116f22012-01-13 09:32:17 +1030425int param_set_bint(const char *val, const struct kernel_param *kp)
426{
Dan Streetman5104b7d2015-06-17 06:17:52 +0930427 /* Match bool exactly, by re-using it. */
428 struct kernel_param boolkp = *kp;
Rusty Russell69116f22012-01-13 09:32:17 +1030429 bool v;
430 int ret;
431
Rusty Russell69116f22012-01-13 09:32:17 +1030432 boolkp.arg = &v;
Rusty Russell69116f22012-01-13 09:32:17 +1030433
434 ret = param_set_bool(val, &boolkp);
435 if (ret == 0)
436 *(int *)kp->arg = v;
437 return ret;
438}
439EXPORT_SYMBOL(param_set_bint);
440
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930441const struct kernel_param_ops param_ops_bint = {
Jani Nikula6a4c2642014-08-27 06:21:23 +0930442 .flags = KERNEL_PARAM_OPS_FL_NOARG,
Rusty Russell69116f22012-01-13 09:32:17 +1030443 .set = param_set_bint,
444 .get = param_get_int,
445};
446EXPORT_SYMBOL(param_ops_bint);
447
Bert Wesarg9730b5b2007-05-08 00:28:50 -0700448/* We break the rule and mangle the string. */
Dan Streetmanb51d23e42015-06-17 06:18:52 +0930449static int param_array(struct module *mod,
450 const char *name,
Adrian Bunk98717282006-03-25 03:07:06 -0800451 const char *val,
452 unsigned int min, unsigned int max,
453 void *elem, int elemsize,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600454 int (*set)(const char *, const struct kernel_param *kp),
Pawel Moll026cee02012-03-26 12:50:51 +1030455 s16 level,
Richard Knutssoneb38a992008-02-06 01:37:50 -0800456 unsigned int *num)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700457{
458 int ret;
459 struct kernel_param kp;
460 char save;
461
462 /* Get the name right for errors. */
463 kp.name = name;
464 kp.arg = elem;
Pawel Moll026cee02012-03-26 12:50:51 +1030465 kp.level = level;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700466
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 *num = 0;
468 /* We expect a comma-separated list of values. */
469 do {
470 int len;
471
472 if (*num == max) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600473 pr_err("%s: can only take %i arguments\n", name, max);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 return -EINVAL;
475 }
476 len = strcspn(val, ",");
477
478 /* nul-terminate and parse */
479 save = val[len];
480 ((char *)val)[len] = '\0';
Rusty Russellcf2fde72015-06-26 06:44:38 +0930481 check_kparam_locked(mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700482 ret = set(val, &kp);
483
484 if (ret != 0)
485 return ret;
486 kp.arg += elemsize;
487 val += len+1;
488 (*num)++;
489 } while (save == ',');
490
491 if (*num < min) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600492 pr_err("%s: needs at least %i arguments\n", name, min);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493 return -EINVAL;
494 }
495 return 0;
496}
497
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600498static int param_array_set(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700499{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700500 const struct kparam_array *arr = kp->arr;
Bert Wesarg31143a12005-04-16 15:25:42 -0700501 unsigned int temp_num;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700502
Dan Streetmanb51d23e42015-06-17 06:18:52 +0930503 return param_array(kp->mod, kp->name, val, 1, arr->max, arr->elem,
Pawel Moll026cee02012-03-26 12:50:51 +1030504 arr->elemsize, arr->ops->set, kp->level,
Rusty Russell3c7d76e2009-10-29 08:56:19 -0600505 arr->num ?: &temp_num);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506}
507
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600508static int param_array_get(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509{
510 int i, off, ret;
Jan Beulich22e48ea2007-10-16 23:29:34 -0700511 const struct kparam_array *arr = kp->arr;
Dan Streetman5104b7d2015-06-17 06:17:52 +0930512 struct kernel_param p = *kp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700513
Linus Torvalds1da177e2005-04-16 15:20:36 -0700514 for (i = off = 0; i < (arr->num ? *arr->num : arr->max); i++) {
515 if (i)
516 buffer[off++] = ',';
517 p.arg = arr->elem + arr->elemsize * i;
Rusty Russellcf2fde72015-06-26 06:44:38 +0930518 check_kparam_locked(p.mod);
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600519 ret = arr->ops->get(buffer + off, &p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700520 if (ret < 0)
521 return ret;
522 off += ret;
523 }
524 buffer[off] = '\0';
525 return off;
526}
527
Rusty Russelle6df34a2010-08-11 23:04:17 -0600528static void param_array_free(void *arg)
529{
530 unsigned int i;
531 const struct kparam_array *arr = arg;
532
533 if (arr->ops->free)
534 for (i = 0; i < (arr->num ? *arr->num : arr->max); i++)
535 arr->ops->free(arr->elem + arr->elemsize * i);
536}
537
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930538const struct kernel_param_ops param_array_ops = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600539 .set = param_array_set,
540 .get = param_array_get,
Rusty Russelle6df34a2010-08-11 23:04:17 -0600541 .free = param_array_free,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600542};
543EXPORT_SYMBOL(param_array_ops);
544
545int param_set_copystring(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700547 const struct kparam_string *kps = kp->str;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700548
549 if (strlen(val)+1 > kps->maxlen) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600550 pr_err("%s: string doesn't fit in %u chars.\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551 kp->name, kps->maxlen-1);
552 return -ENOSPC;
553 }
554 strcpy(kps->string, val);
555 return 0;
556}
Rusty Russella14fe242010-08-11 23:04:11 -0600557EXPORT_SYMBOL(param_set_copystring);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600559int param_get_string(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700560{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700561 const struct kparam_string *kps = kp->str;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700562 return strlcpy(buffer, kps->string, kps->maxlen);
563}
Rusty Russella14fe242010-08-11 23:04:11 -0600564EXPORT_SYMBOL(param_get_string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930566const struct kernel_param_ops param_ops_string = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600567 .set = param_set_copystring,
568 .get = param_get_string,
569};
570EXPORT_SYMBOL(param_ops_string);
571
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572/* sysfs output in /sys/modules/XYZ/parameters/ */
Edward Z. Yang350f8252010-02-01 18:26:59 -0500573#define to_module_attr(n) container_of(n, struct module_attribute, attr)
574#define to_module_kobject(n) container_of(n, struct module_kobject, kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575
Linus Torvalds1da177e2005-04-16 15:20:36 -0700576struct param_attribute
577{
578 struct module_attribute mattr;
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600579 const struct kernel_param *param;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580};
581
582struct module_param_attrs
583{
Rusty Russell9b473de2008-10-22 10:00:22 -0500584 unsigned int num;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 struct attribute_group grp;
586 struct param_attribute attrs[0];
587};
588
Randy Dunlapef665c12007-02-13 15:19:06 -0800589#ifdef CONFIG_SYSFS
Edward Z. Yang350f8252010-02-01 18:26:59 -0500590#define to_param_attr(n) container_of(n, struct param_attribute, mattr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700591
592static ssize_t param_attr_show(struct module_attribute *mattr,
Kay Sievers4befb022011-07-24 22:06:04 +0930593 struct module_kobject *mk, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594{
595 int count;
596 struct param_attribute *attribute = to_param_attr(mattr);
597
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600598 if (!attribute->param->ops->get)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599 return -EPERM;
600
Dan Streetmanb51d23e42015-06-17 06:18:52 +0930601 kernel_param_lock(mk->mod);
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600602 count = attribute->param->ops->get(buf, attribute->param);
Dan Streetmanb51d23e42015-06-17 06:18:52 +0930603 kernel_param_unlock(mk->mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700604 if (count > 0) {
605 strcat(buf, "\n");
606 ++count;
607 }
608 return count;
609}
610
611/* sysfs always hands a nul-terminated string in buf. We rely on that. */
612static ssize_t param_attr_store(struct module_attribute *mattr,
Dan Streetmanb51d23e42015-06-17 06:18:52 +0930613 struct module_kobject *mk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700614 const char *buf, size_t len)
615{
616 int err;
617 struct param_attribute *attribute = to_param_attr(mattr);
618
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600619 if (!attribute->param->ops->set)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620 return -EPERM;
621
Dan Streetmanb51d23e42015-06-17 06:18:52 +0930622 kernel_param_lock(mk->mod);
Rusty Russell7a486d372014-08-27 06:25:23 +0930623 param_check_unsafe(attribute->param);
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600624 err = attribute->param->ops->set(buf, attribute->param);
Dan Streetmanb51d23e42015-06-17 06:18:52 +0930625 kernel_param_unlock(mk->mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 if (!err)
627 return len;
628 return err;
629}
Randy Dunlapef665c12007-02-13 15:19:06 -0800630#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700631
632#ifdef CONFIG_MODULES
633#define __modinit
634#else
635#define __modinit __init
636#endif
637
Randy Dunlapef665c12007-02-13 15:19:06 -0800638#ifdef CONFIG_SYSFS
Dan Streetmanb51d23e42015-06-17 06:18:52 +0930639void kernel_param_lock(struct module *mod)
Rusty Russell907b29e2010-08-11 23:04:19 -0600640{
Dan Streetmanb51d23e42015-06-17 06:18:52 +0930641 mutex_lock(KPARAM_MUTEX(mod));
Rusty Russell907b29e2010-08-11 23:04:19 -0600642}
Rusty Russell907b29e2010-08-11 23:04:19 -0600643
Dan Streetmanb51d23e42015-06-17 06:18:52 +0930644void kernel_param_unlock(struct module *mod)
Rusty Russell907b29e2010-08-11 23:04:19 -0600645{
Dan Streetmanb51d23e42015-06-17 06:18:52 +0930646 mutex_unlock(KPARAM_MUTEX(mod));
Rusty Russell907b29e2010-08-11 23:04:19 -0600647}
Dan Streetmanb51d23e42015-06-17 06:18:52 +0930648
Dan Streetmanb51d23e42015-06-17 06:18:52 +0930649EXPORT_SYMBOL(kernel_param_lock);
650EXPORT_SYMBOL(kernel_param_unlock);
Rusty Russell907b29e2010-08-11 23:04:19 -0600651
Linus Torvalds1da177e2005-04-16 15:20:36 -0700652/*
Rusty Russell9b473de2008-10-22 10:00:22 -0500653 * add_sysfs_param - add a parameter to sysfs
654 * @mk: struct module_kobject
655 * @kparam: the actual parameter definition to add to sysfs
656 * @name: name of parameter
Linus Torvalds1da177e2005-04-16 15:20:36 -0700657 *
Rusty Russell9b473de2008-10-22 10:00:22 -0500658 * Create a kobject if for a (per-module) parameter if mp NULL, and
659 * create file in sysfs. Returns an error on out of memory. Always cleans up
660 * if there's an error.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700661 */
Rusty Russell9b473de2008-10-22 10:00:22 -0500662static __modinit int add_sysfs_param(struct module_kobject *mk,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600663 const struct kernel_param *kp,
Rusty Russell9b473de2008-10-22 10:00:22 -0500664 const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700665{
Rusty Russell18eb74f2014-11-10 09:32:29 +1030666 struct module_param_attrs *new_mp;
667 struct attribute **new_attrs;
668 unsigned int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669
Rusty Russell9b473de2008-10-22 10:00:22 -0500670 /* We don't bother calling this with invisible parameters. */
671 BUG_ON(!kp->perm);
672
673 if (!mk->mp) {
Rusty Russell18eb74f2014-11-10 09:32:29 +1030674 /* First allocation. */
675 mk->mp = kzalloc(sizeof(*mk->mp), GFP_KERNEL);
676 if (!mk->mp)
677 return -ENOMEM;
678 mk->mp->grp.name = "parameters";
679 /* NULL-terminated attribute array. */
680 mk->mp->grp.attrs = kzalloc(sizeof(mk->mp->grp.attrs[0]),
681 GFP_KERNEL);
682 /* Caller will cleanup via free_module_param_attrs */
683 if (!mk->mp->grp.attrs)
684 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700685 }
686
Rusty Russell18eb74f2014-11-10 09:32:29 +1030687 /* Enlarge allocations. */
688 new_mp = krealloc(mk->mp,
689 sizeof(*mk->mp) +
690 sizeof(mk->mp->attrs[0]) * (mk->mp->num + 1),
691 GFP_KERNEL);
692 if (!new_mp)
693 return -ENOMEM;
694 mk->mp = new_mp;
Rusty Russell9b473de2008-10-22 10:00:22 -0500695
Rusty Russell18eb74f2014-11-10 09:32:29 +1030696 /* Extra pointer for NULL terminator */
697 new_attrs = krealloc(mk->mp->grp.attrs,
698 sizeof(mk->mp->grp.attrs[0]) * (mk->mp->num + 2),
699 GFP_KERNEL);
700 if (!new_attrs)
701 return -ENOMEM;
702 mk->mp->grp.attrs = new_attrs;
Rusty Russell9b473de2008-10-22 10:00:22 -0500703
704 /* Tack new one on the end. */
Rusty Russellc772be52015-01-20 09:07:04 +1030705 memset(&mk->mp->attrs[mk->mp->num], 0, sizeof(mk->mp->attrs[0]));
Rusty Russell18eb74f2014-11-10 09:32:29 +1030706 sysfs_attr_init(&mk->mp->attrs[mk->mp->num].mattr.attr);
707 mk->mp->attrs[mk->mp->num].param = kp;
708 mk->mp->attrs[mk->mp->num].mattr.show = param_attr_show;
Kees Cookb0a65b02014-12-12 13:36:49 +1030709 /* Do not allow runtime DAC changes to make param writable. */
710 if ((kp->perm & (S_IWUSR | S_IWGRP | S_IWOTH)) != 0)
711 mk->mp->attrs[mk->mp->num].mattr.store = param_attr_store;
Rusty Russell574732c2014-12-23 15:05:36 +1030712 else
713 mk->mp->attrs[mk->mp->num].mattr.store = NULL;
Rusty Russell18eb74f2014-11-10 09:32:29 +1030714 mk->mp->attrs[mk->mp->num].mattr.attr.name = (char *)name;
715 mk->mp->attrs[mk->mp->num].mattr.attr.mode = kp->perm;
716 mk->mp->num++;
Rusty Russell9b473de2008-10-22 10:00:22 -0500717
718 /* Fix up all the pointers, since krealloc can move us */
Rusty Russell18eb74f2014-11-10 09:32:29 +1030719 for (i = 0; i < mk->mp->num; i++)
720 mk->mp->grp.attrs[i] = &mk->mp->attrs[i].mattr.attr;
721 mk->mp->grp.attrs[mk->mp->num] = NULL;
Rusty Russell9b473de2008-10-22 10:00:22 -0500722 return 0;
Rusty Russell9b473de2008-10-22 10:00:22 -0500723}
724
Linus Torvaldsd2441182008-10-23 12:07:17 -0700725#ifdef CONFIG_MODULES
Rusty Russell9b473de2008-10-22 10:00:22 -0500726static void free_module_param_attrs(struct module_kobject *mk)
727{
Rusty Russell18eb74f2014-11-10 09:32:29 +1030728 if (mk->mp)
729 kfree(mk->mp->grp.attrs);
Rusty Russell9b473de2008-10-22 10:00:22 -0500730 kfree(mk->mp);
731 mk->mp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700732}
733
Linus Torvalds1da177e2005-04-16 15:20:36 -0700734/*
735 * module_param_sysfs_setup - setup sysfs support for one module
736 * @mod: module
737 * @kparam: module parameters (array)
738 * @num_params: number of module parameters
739 *
Rusty Russell9b473de2008-10-22 10:00:22 -0500740 * Adds sysfs entries for module parameters under
741 * /sys/module/[mod->name]/parameters/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 */
743int module_param_sysfs_setup(struct module *mod,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600744 const struct kernel_param *kparam,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700745 unsigned int num_params)
746{
Rusty Russell9b473de2008-10-22 10:00:22 -0500747 int i, err;
748 bool params = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749
Rusty Russell9b473de2008-10-22 10:00:22 -0500750 for (i = 0; i < num_params; i++) {
751 if (kparam[i].perm == 0)
752 continue;
753 err = add_sysfs_param(&mod->mkobj, &kparam[i], kparam[i].name);
Rusty Russell18eb74f2014-11-10 09:32:29 +1030754 if (err) {
755 free_module_param_attrs(&mod->mkobj);
Rusty Russell9b473de2008-10-22 10:00:22 -0500756 return err;
Rusty Russell18eb74f2014-11-10 09:32:29 +1030757 }
Rusty Russell9b473de2008-10-22 10:00:22 -0500758 params = true;
759 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700760
Rusty Russell9b473de2008-10-22 10:00:22 -0500761 if (!params)
762 return 0;
763
764 /* Create the param group. */
765 err = sysfs_create_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp);
766 if (err)
767 free_module_param_attrs(&mod->mkobj);
768 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700769}
770
771/*
772 * module_param_sysfs_remove - remove sysfs support for one module
773 * @mod: module
774 *
775 * Remove sysfs entries for module parameters and the corresponding
776 * kobject.
777 */
778void module_param_sysfs_remove(struct module *mod)
779{
Rusty Russell9b473de2008-10-22 10:00:22 -0500780 if (mod->mkobj.mp) {
781 sysfs_remove_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782 /* We are positive that no one is using any param
783 * attrs at this point. Deallocate immediately. */
Rusty Russell9b473de2008-10-22 10:00:22 -0500784 free_module_param_attrs(&mod->mkobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700785 }
786}
787#endif
788
Rusty Russelle180a6b2009-03-31 13:05:29 -0600789void destroy_params(const struct kernel_param *params, unsigned num)
790{
Rusty Russelle6df34a2010-08-11 23:04:17 -0600791 unsigned int i;
792
793 for (i = 0; i < num; i++)
794 if (params[i].ops->free)
795 params[i].ops->free(params[i].arg);
Rusty Russelle180a6b2009-03-31 13:05:29 -0600796}
797
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800798static struct module_kobject * __init locate_module_kobject(const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799{
800 struct module_kobject *mk;
Rusty Russell9b473de2008-10-22 10:00:22 -0500801 struct kobject *kobj;
802 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700803
Rusty Russell9b473de2008-10-22 10:00:22 -0500804 kobj = kset_find_obj(module_kset, name);
805 if (kobj) {
Rusty Russell9b473de2008-10-22 10:00:22 -0500806 mk = to_module_kobject(kobj);
Rusty Russell9b473de2008-10-22 10:00:22 -0500807 } else {
808 mk = kzalloc(sizeof(struct module_kobject), GFP_KERNEL);
809 BUG_ON(!mk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700810
Rusty Russell9b473de2008-10-22 10:00:22 -0500811 mk->mod = THIS_MODULE;
812 mk->kobj.kset = module_kset;
813 err = kobject_init_and_add(&mk->kobj, &module_ktype, NULL,
814 "%s", name);
Kay Sievers88bfa322011-07-24 22:06:04 +0930815#ifdef CONFIG_MODULES
816 if (!err)
817 err = sysfs_create_file(&mk->kobj, &module_uevent.attr);
818#endif
Rusty Russell9b473de2008-10-22 10:00:22 -0500819 if (err) {
820 kobject_put(&mk->kobj);
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600821 pr_crit("Adding module '%s' to sysfs failed (%d), the system may be unstable.\n",
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800822 name, err);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800823 return NULL;
Rusty Russell9b473de2008-10-22 10:00:22 -0500824 }
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800825
826 /* So that we hold reference in both cases. */
Rusty Russell9b473de2008-10-22 10:00:22 -0500827 kobject_get(&mk->kobj);
Greg Kroah-Hartman74c5b592007-07-30 11:26:38 -0700828 }
Rusty Russell9b473de2008-10-22 10:00:22 -0500829
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800830 return mk;
831}
832
833static void __init kernel_add_sysfs_param(const char *name,
Geert Uytterhoeven63a12d92014-10-13 15:55:44 -0700834 const struct kernel_param *kparam,
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800835 unsigned int name_skip)
836{
837 struct module_kobject *mk;
838 int err;
839
840 mk = locate_module_kobject(name);
841 if (!mk)
842 return;
843
844 /* We need to remove old parameters before adding more. */
845 if (mk->mp)
846 sysfs_remove_group(&mk->kobj, &mk->mp->grp);
847
Rusty Russell9b473de2008-10-22 10:00:22 -0500848 /* These should not fail at boot. */
849 err = add_sysfs_param(mk, kparam, kparam->name + name_skip);
850 BUG_ON(err);
851 err = sysfs_create_group(&mk->kobj, &mk->mp->grp);
852 BUG_ON(err);
Kay Sieversf30c53a2007-01-15 20:22:02 +0100853 kobject_uevent(&mk->kobj, KOBJ_ADD);
Rusty Russell9b473de2008-10-22 10:00:22 -0500854 kobject_put(&mk->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855}
856
857/*
Jean Delvareb634d132013-07-02 15:35:11 +0930858 * param_sysfs_builtin - add sysfs parameters for built-in modules
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859 *
860 * Add module_parameters to sysfs for "modules" built into the kernel.
861 *
862 * The "module" name (KBUILD_MODNAME) is stored before a dot, the
863 * "parameter" name is stored behind a dot in kernel_param->name. So,
864 * extract the "module" name for all built-in kernel_param-eters,
Rusty Russell9b473de2008-10-22 10:00:22 -0500865 * and for all who have the same, call kernel_add_sysfs_param.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700866 */
867static void __init param_sysfs_builtin(void)
868{
Geert Uytterhoeven63a12d92014-10-13 15:55:44 -0700869 const struct kernel_param *kp;
Rusty Russell9b473de2008-10-22 10:00:22 -0500870 unsigned int name_len;
871 char modname[MODULE_NAME_LEN];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700872
Rusty Russell9b473de2008-10-22 10:00:22 -0500873 for (kp = __start___param; kp < __stop___param; kp++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700874 char *dot;
875
Rusty Russell9b473de2008-10-22 10:00:22 -0500876 if (kp->perm == 0)
877 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700878
Rusty Russell730b69d2008-10-22 10:00:22 -0500879 dot = strchr(kp->name, '.');
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880 if (!dot) {
Rusty Russell67e67ce2008-10-22 10:00:23 -0500881 /* This happens for core_param() */
882 strcpy(modname, "kernel");
883 name_len = 0;
884 } else {
885 name_len = dot - kp->name + 1;
886 strlcpy(modname, kp->name, name_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700887 }
Rusty Russell67e67ce2008-10-22 10:00:23 -0500888 kernel_add_sysfs_param(modname, kp, name_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700890}
891
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800892ssize_t __modver_version_show(struct module_attribute *mattr,
Kay Sievers4befb022011-07-24 22:06:04 +0930893 struct module_kobject *mk, char *buf)
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800894{
895 struct module_version_attribute *vattr =
896 container_of(mattr, struct module_version_attribute, mattr);
897
Chen Gangf4940ab2013-08-20 15:35:04 +0930898 return scnprintf(buf, PAGE_SIZE, "%s\n", vattr->version);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800899}
900
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800901extern const struct module_version_attribute *__start___modver[];
902extern const struct module_version_attribute *__stop___modver[];
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800903
904static void __init version_sysfs_builtin(void)
905{
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800906 const struct module_version_attribute **p;
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800907 struct module_kobject *mk;
908 int err;
909
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800910 for (p = __start___modver; p < __stop___modver; p++) {
911 const struct module_version_attribute *vattr = *p;
912
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800913 mk = locate_module_kobject(vattr->module_name);
914 if (mk) {
915 err = sysfs_create_file(&mk->kobj, &vattr->mattr.attr);
Rusty Russell74c3dea32015-06-17 06:16:52 +0930916 WARN_ON_ONCE(err);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800917 kobject_uevent(&mk->kobj, KOBJ_ADD);
918 kobject_put(&mk->kobj);
919 }
920 }
921}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922
923/* module-related sysfs stuff */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700924
Linus Torvalds1da177e2005-04-16 15:20:36 -0700925static ssize_t module_attr_show(struct kobject *kobj,
926 struct attribute *attr,
927 char *buf)
928{
929 struct module_attribute *attribute;
930 struct module_kobject *mk;
931 int ret;
932
933 attribute = to_module_attr(attr);
934 mk = to_module_kobject(kobj);
935
936 if (!attribute->show)
Dmitry Torokhov70f28172005-04-29 01:27:34 -0500937 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700938
Kay Sievers4befb022011-07-24 22:06:04 +0930939 ret = attribute->show(attribute, mk, buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941 return ret;
942}
943
944static ssize_t module_attr_store(struct kobject *kobj,
945 struct attribute *attr,
946 const char *buf, size_t len)
947{
948 struct module_attribute *attribute;
949 struct module_kobject *mk;
950 int ret;
951
952 attribute = to_module_attr(attr);
953 mk = to_module_kobject(kobj);
954
955 if (!attribute->store)
Dmitry Torokhov70f28172005-04-29 01:27:34 -0500956 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700957
Kay Sievers4befb022011-07-24 22:06:04 +0930958 ret = attribute->store(attribute, mk, buf, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700959
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960 return ret;
961}
962
Emese Revfy52cf25d2010-01-19 02:58:23 +0100963static const struct sysfs_ops module_sysfs_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964 .show = module_attr_show,
965 .store = module_attr_store,
966};
967
Kay Sievers270a6c42007-01-18 13:26:15 +0100968static int uevent_filter(struct kset *kset, struct kobject *kobj)
969{
970 struct kobj_type *ktype = get_ktype(kobj);
971
972 if (ktype == &module_ktype)
973 return 1;
974 return 0;
975}
976
Emese Revfy9cd43612009-12-31 14:52:51 +0100977static const struct kset_uevent_ops module_uevent_ops = {
Kay Sievers270a6c42007-01-18 13:26:15 +0100978 .filter = uevent_filter,
979};
980
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700981struct kset *module_kset;
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700982int module_sysfs_initialized;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983
Li Zhong942e4432013-09-03 16:33:57 +0930984static void module_kobj_release(struct kobject *kobj)
985{
986 struct module_kobject *mk = to_module_kobject(kobj);
987 complete(mk->kobj_completion);
988}
989
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700990struct kobj_type module_ktype = {
Li Zhong942e4432013-09-03 16:33:57 +0930991 .release = module_kobj_release,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700992 .sysfs_ops = &module_sysfs_ops,
993};
994
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995/*
996 * param_sysfs_init - wrapper for built-in params support
997 */
998static int __init param_sysfs_init(void)
999{
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -07001000 module_kset = kset_create_and_add("module", &module_uevent_ops, NULL);
1001 if (!module_kset) {
1002 printk(KERN_WARNING "%s (%d): error creating kset\n",
1003 __FILE__, __LINE__);
1004 return -ENOMEM;
Randy Dunlapd8c76492006-09-29 01:58:55 -07001005 }
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -07001006 module_sysfs_initialized = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007
Dmitry Torokhove94965e2010-12-15 14:00:19 -08001008 version_sysfs_builtin();
Linus Torvalds1da177e2005-04-16 15:20:36 -07001009 param_sysfs_builtin();
1010
1011 return 0;
1012}
Mark Huangd10be6d2006-09-29 01:59:34 -07001013subsys_initcall(param_sysfs_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -07001015#endif /* CONFIG_SYSFS */