blob: 8890d0b8dffceda61f667ce08195ef479fd04b36 [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
Dan Streetmanb51d23e2015-06-17 06:18:52 +093028/* Protects all built-in parameters, modules use their own param_lock */
Rusty Russell907b29e2010-08-11 23:04:19 -060029static DEFINE_MUTEX(param_lock);
30
Dan Streetmanb51d23e2015-06-17 06:18:52 +093031/* Use the module's mutex, or if built-in use the built-in mutex */
32#define KPARAM_MUTEX(mod) ((mod) ? &(mod)->param_lock : &param_lock)
33#define KPARAM_IS_LOCKED(mod) mutex_is_locked(KPARAM_MUTEX(mod))
34
Rusty Russella1054322010-08-11 23:04:18 -060035/* This just allows us to keep track of which parameters are kmalloced. */
36struct kmalloced_param {
37 struct list_head list;
38 char val[];
39};
Rusty Russella1054322010-08-11 23:04:18 -060040static LIST_HEAD(kmalloced_params);
Dan Streetmanb51d23e2015-06-17 06:18:52 +093041static DEFINE_SPINLOCK(kmalloced_params_lock);
Rusty Russella1054322010-08-11 23:04:18 -060042
43static void *kmalloc_parameter(unsigned int size)
44{
45 struct kmalloced_param *p;
46
47 p = kmalloc(sizeof(*p) + size, GFP_KERNEL);
48 if (!p)
49 return NULL;
50
Dan Streetmanb51d23e2015-06-17 06:18:52 +093051 spin_lock(&kmalloced_params_lock);
Rusty Russella1054322010-08-11 23:04:18 -060052 list_add(&p->list, &kmalloced_params);
Dan Streetmanb51d23e2015-06-17 06:18:52 +093053 spin_unlock(&kmalloced_params_lock);
54
Rusty Russella1054322010-08-11 23:04:18 -060055 return p->val;
56}
57
58/* Does nothing if parameter wasn't kmalloced above. */
59static void maybe_kfree_parameter(void *param)
60{
61 struct kmalloced_param *p;
62
Dan Streetmanb51d23e2015-06-17 06:18:52 +093063 spin_lock(&kmalloced_params_lock);
Rusty Russella1054322010-08-11 23:04:18 -060064 list_for_each_entry(p, &kmalloced_params, list) {
65 if (p->val == param) {
66 list_del(&p->list);
67 kfree(p);
68 break;
69 }
70 }
Dan Streetmanb51d23e2015-06-17 06:18:52 +093071 spin_unlock(&kmalloced_params_lock);
Rusty Russella1054322010-08-11 23:04:18 -060072}
73
Michal Schmidtb1e4d202011-10-10 00:03:37 +020074static char dash2underscore(char c)
Linus Torvalds1da177e2005-04-16 15:20:36 -070075{
76 if (c == '-')
77 return '_';
78 return c;
79}
80
Michal Schmidtb1e4d202011-10-10 00:03:37 +020081bool parameqn(const char *a, const char *b, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -070082{
Michal Schmidtb1e4d202011-10-10 00:03:37 +020083 size_t i;
84
85 for (i = 0; i < n; i++) {
86 if (dash2underscore(a[i]) != dash2underscore(b[i]))
87 return false;
88 }
89 return true;
90}
91
92bool parameq(const char *a, const char *b)
93{
94 return parameqn(a, b, strlen(a)+1);
Linus Torvalds1da177e2005-04-16 15:20:36 -070095}
96
Rusty Russell7a486d372014-08-27 06:25:23 +093097static void param_check_unsafe(const struct kernel_param *kp)
98{
99 if (kp->flags & KERNEL_PARAM_FL_UNSAFE) {
100 pr_warn("Setting dangerous option %s - tainting kernel\n",
101 kp->name);
102 add_taint(TAINT_USER, LOCKDEP_STILL_OK);
103 }
104}
105
Linus Torvalds1da177e2005-04-16 15:20:36 -0700106static int parse_one(char *param,
107 char *val,
Jim Cromie9fb48c72012-04-27 14:30:34 -0600108 const char *doing,
Rusty Russell914dcaa2010-08-11 23:04:18 -0600109 const struct kernel_param *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700110 unsigned num_params,
Pawel Moll026cee02012-03-26 12:50:51 +1030111 s16 min_level,
112 s16 max_level,
Jim Cromie9fb48c72012-04-27 14:30:34 -0600113 int (*handle_unknown)(char *param, char *val,
114 const char *doing))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115{
116 unsigned int i;
Rusty Russell907b29e2010-08-11 23:04:19 -0600117 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700118
119 /* Find parameter */
120 for (i = 0; i < num_params; i++) {
121 if (parameq(param, params[i].name)) {
Pawel Moll026cee02012-03-26 12:50:51 +1030122 if (params[i].level < min_level
123 || params[i].level > max_level)
124 return 0;
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300125 /* No one handled NULL, so do it here. */
Steven Rostedtab013c52013-08-20 15:33:19 +0930126 if (!val &&
Jani Nikula6a4c2642014-08-27 06:21:23 +0930127 !(params[i].ops->flags & KERNEL_PARAM_OPS_FL_NOARG))
Rusty Russell2e9fb992010-08-11 23:04:10 -0600128 return -EINVAL;
Jim Cromie9fb48c72012-04-27 14:30:34 -0600129 pr_debug("handling %s with %p\n", param,
130 params[i].ops->set);
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930131 kernel_param_lock(params[i].mod);
Rusty Russell7a486d372014-08-27 06:25:23 +0930132 param_check_unsafe(&params[i]);
Rusty Russell907b29e2010-08-11 23:04:19 -0600133 err = params[i].ops->set(val, &params[i]);
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930134 kernel_param_unlock(params[i].mod);
Rusty Russell907b29e2010-08-11 23:04:19 -0600135 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700136 }
137 }
138
139 if (handle_unknown) {
Jim Cromie9fb48c72012-04-27 14:30:34 -0600140 pr_debug("doing %s: %s='%s'\n", doing, param, val);
141 return handle_unknown(param, val, doing);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142 }
143
Jim Cromie9fb48c72012-04-27 14:30:34 -0600144 pr_debug("Unknown argument '%s'\n", param);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145 return -ENOENT;
146}
147
148/* You can use " around spaces, but can't escape ". */
149/* Hyphens and underscores equivalent in parameter names. */
150static char *next_arg(char *args, char **param, char **val)
151{
152 unsigned int i, equals = 0;
153 int in_quote = 0, quoted = 0;
154 char *next;
155
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 if (*args == '"') {
157 args++;
158 in_quote = 1;
159 quoted = 1;
160 }
161
162 for (i = 0; args[i]; i++) {
Peter Oberparleiter26d052b2009-07-06 17:11:22 +0200163 if (isspace(args[i]) && !in_quote)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700164 break;
165 if (equals == 0) {
166 if (args[i] == '=')
167 equals = i;
168 }
169 if (args[i] == '"')
170 in_quote = !in_quote;
171 }
172
173 *param = args;
174 if (!equals)
175 *val = NULL;
176 else {
177 args[equals] = '\0';
178 *val = args + equals + 1;
179
180 /* Don't include quotes in value. */
181 if (**val == '"') {
182 (*val)++;
183 if (args[i-1] == '"')
184 args[i-1] = '\0';
185 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186 }
Rusty Russellb9cc4482015-04-15 13:23:48 +0930187 if (quoted && args[i-1] == '"')
188 args[i-1] = '\0';
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189
190 if (args[i]) {
191 args[i] = '\0';
192 next = args + i + 1;
193 } else
194 next = args + i;
Rusty Russellf36462f2005-09-27 21:45:34 -0700195
196 /* Chew up trailing spaces. */
André Goddard Rosae7d28602009-12-14 18:01:06 -0800197 return skip_spaces(next);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198}
199
200/* Args looks like "foo=bar,bar2 baz=fuz wiz". */
Rusty Russell51e158c2014-04-28 11:34:33 +0930201char *parse_args(const char *doing,
202 char *args,
203 const struct kernel_param *params,
204 unsigned num,
205 s16 min_level,
206 s16 max_level,
207 int (*unknown)(char *param, char *val, const char *doing))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208{
209 char *param, *val;
210
Rusty Russellf36462f2005-09-27 21:45:34 -0700211 /* Chew leading spaces */
André Goddard Rosae7d28602009-12-14 18:01:06 -0800212 args = skip_spaces(args);
Rusty Russellf36462f2005-09-27 21:45:34 -0700213
Jim Cromie1ef9eaf2012-05-03 11:57:37 -0600214 if (*args)
Jim Cromie9fb48c72012-04-27 14:30:34 -0600215 pr_debug("doing %s, parsing ARGS: '%s'\n", doing, args);
216
Linus Torvalds1da177e2005-04-16 15:20:36 -0700217 while (*args) {
218 int ret;
Ard van Breemena416aba2007-01-05 16:36:20 -0800219 int irq_was_disabled;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700220
221 args = next_arg(args, &param, &val);
Rusty Russell51e158c2014-04-28 11:34:33 +0930222 /* Stop at -- */
223 if (!val && strcmp(param, "--") == 0)
224 return args;
Ard van Breemena416aba2007-01-05 16:36:20 -0800225 irq_was_disabled = irqs_disabled();
Jim Cromie9fb48c72012-04-27 14:30:34 -0600226 ret = parse_one(param, val, doing, params, num,
Pawel Moll026cee02012-03-26 12:50:51 +1030227 min_level, max_level, unknown);
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600228 if (irq_was_disabled && !irqs_disabled())
229 pr_warn("%s: option '%s' enabled irq's!\n",
230 doing, param);
231
Linus Torvalds1da177e2005-04-16 15:20:36 -0700232 switch (ret) {
233 case -ENOENT:
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600234 pr_err("%s: Unknown parameter `%s'\n", doing, param);
Rusty Russell51e158c2014-04-28 11:34:33 +0930235 return ERR_PTR(ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 case -ENOSPC:
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600237 pr_err("%s: `%s' too large for parameter `%s'\n",
Jim Cromie9fb48c72012-04-27 14:30:34 -0600238 doing, val ?: "", param);
Rusty Russell51e158c2014-04-28 11:34:33 +0930239 return ERR_PTR(ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700240 case 0:
241 break;
242 default:
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600243 pr_err("%s: `%s' invalid for parameter `%s'\n",
Jim Cromie9fb48c72012-04-27 14:30:34 -0600244 doing, val ?: "", param);
Rusty Russell51e158c2014-04-28 11:34:33 +0930245 return ERR_PTR(ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 }
247 }
248
249 /* All parsed OK. */
Rusty Russell51e158c2014-04-28 11:34:33 +0930250 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700251}
252
253/* Lazy bastard, eh? */
Felipe Contreras88a88b322013-12-04 14:09:38 +1030254#define STANDARD_PARAM_DEF(name, type, format, strtolfn) \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600255 int param_set_##name(const char *val, const struct kernel_param *kp) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700256 { \
Felipe Contreras88a88b322013-12-04 14:09:38 +1030257 return strtolfn(val, 0, (type *)kp->arg); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700258 } \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600259 int param_get_##name(char *buffer, const struct kernel_param *kp) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700260 { \
Chen Gangf4940ab2013-08-20 15:35:04 +0930261 return scnprintf(buffer, PAGE_SIZE, format, \
262 *((type *)kp->arg)); \
Rusty Russella14fe242010-08-11 23:04:11 -0600263 } \
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930264 const struct kernel_param_ops param_ops_##name = { \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600265 .set = param_set_##name, \
266 .get = param_get_##name, \
267 }; \
Rusty Russella14fe242010-08-11 23:04:11 -0600268 EXPORT_SYMBOL(param_set_##name); \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600269 EXPORT_SYMBOL(param_get_##name); \
270 EXPORT_SYMBOL(param_ops_##name)
271
Linus Torvalds1da177e2005-04-16 15:20:36 -0700272
Felipe Contreras88a88b322013-12-04 14:09:38 +1030273STANDARD_PARAM_DEF(byte, unsigned char, "%hhu", kstrtou8);
274STANDARD_PARAM_DEF(short, short, "%hi", kstrtos16);
275STANDARD_PARAM_DEF(ushort, unsigned short, "%hu", kstrtou16);
276STANDARD_PARAM_DEF(int, int, "%i", kstrtoint);
277STANDARD_PARAM_DEF(uint, unsigned int, "%u", kstrtouint);
278STANDARD_PARAM_DEF(long, long, "%li", kstrtol);
279STANDARD_PARAM_DEF(ulong, unsigned long, "%lu", kstrtoul);
Hannes Reineckeb4210b82014-06-25 15:27:37 +0200280STANDARD_PARAM_DEF(ullong, unsigned long long, "%llu", kstrtoull);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700281
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600282int param_set_charp(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700283{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700284 if (strlen(val) > 1024) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600285 pr_err("%s: string parameter too long\n", kp->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 return -ENOSPC;
287 }
288
Rusty Russella1054322010-08-11 23:04:18 -0600289 maybe_kfree_parameter(*(char **)kp->arg);
290
291 /* This is a hack. We can't kmalloc in early boot, and we
Rusty Russelle180a6b2009-03-31 13:05:29 -0600292 * don't need to; this mangled commandline is preserved. */
293 if (slab_is_available()) {
Rusty Russella1054322010-08-11 23:04:18 -0600294 *(char **)kp->arg = kmalloc_parameter(strlen(val)+1);
Rusty Russelld553ad82009-10-29 08:56:17 -0600295 if (!*(char **)kp->arg)
Rusty Russelle180a6b2009-03-31 13:05:29 -0600296 return -ENOMEM;
Rusty Russella1054322010-08-11 23:04:18 -0600297 strcpy(*(char **)kp->arg, val);
Rusty Russelle180a6b2009-03-31 13:05:29 -0600298 } else
299 *(const char **)kp->arg = val;
300
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 return 0;
302}
Rusty Russella14fe242010-08-11 23:04:11 -0600303EXPORT_SYMBOL(param_set_charp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600305int param_get_charp(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306{
Chen Gangf4940ab2013-08-20 15:35:04 +0930307 return scnprintf(buffer, PAGE_SIZE, "%s", *((char **)kp->arg));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308}
Rusty Russella14fe242010-08-11 23:04:11 -0600309EXPORT_SYMBOL(param_get_charp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310
Rusty Russella1054322010-08-11 23:04:18 -0600311static void param_free_charp(void *arg)
312{
313 maybe_kfree_parameter(*((char **)arg));
314}
315
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930316const struct kernel_param_ops param_ops_charp = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600317 .set = param_set_charp,
318 .get = param_get_charp,
Rusty Russella1054322010-08-11 23:04:18 -0600319 .free = param_free_charp,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600320};
321EXPORT_SYMBOL(param_ops_charp);
322
Rusty Russellfddd5202009-06-12 21:46:57 -0600323/* Actually could be a bool or an int, for historical reasons. */
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600324int param_set_bool(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325{
326 /* No equals means "set"... */
327 if (!val) val = "1";
328
329 /* One of =[yYnN01] */
Rusty Russell8b825282012-03-26 12:50:51 +1030330 return strtobool(val, kp->arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331}
Rusty Russella14fe242010-08-11 23:04:11 -0600332EXPORT_SYMBOL(param_set_bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700333
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600334int param_get_bool(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335{
336 /* Y and N chosen as being relatively non-coder friendly */
Rusty Russell8b825282012-03-26 12:50:51 +1030337 return sprintf(buffer, "%c", *(bool *)kp->arg ? 'Y' : 'N');
Linus Torvalds1da177e2005-04-16 15:20:36 -0700338}
Rusty Russella14fe242010-08-11 23:04:11 -0600339EXPORT_SYMBOL(param_get_bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700340
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930341const struct kernel_param_ops param_ops_bool = {
Jani Nikula6a4c2642014-08-27 06:21:23 +0930342 .flags = KERNEL_PARAM_OPS_FL_NOARG,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600343 .set = param_set_bool,
344 .get = param_get_bool,
345};
346EXPORT_SYMBOL(param_ops_bool);
347
Luis R. Rodriguezd19f05d2015-05-27 11:09:38 +0930348int param_set_bool_enable_only(const char *val, const struct kernel_param *kp)
349{
350 int err = 0;
351 bool new_value;
352 bool orig_value = *(bool *)kp->arg;
353 struct kernel_param dummy_kp = *kp;
354
355 dummy_kp.arg = &new_value;
356
357 err = param_set_bool(val, &dummy_kp);
358 if (err)
359 return err;
360
361 /* Don't let them unset it once it's set! */
362 if (!new_value && orig_value)
363 return -EROFS;
364
365 if (new_value)
366 err = param_set_bool(val, kp);
367
368 return err;
369}
370EXPORT_SYMBOL_GPL(param_set_bool_enable_only);
371
372const struct kernel_param_ops param_ops_bool_enable_only = {
373 .flags = KERNEL_PARAM_OPS_FL_NOARG,
374 .set = param_set_bool_enable_only,
375 .get = param_get_bool,
376};
Luis R. Rodriguez154be212015-05-27 11:09:39 +0930377EXPORT_SYMBOL_GPL(param_ops_bool_enable_only);
Luis R. Rodriguezd19f05d2015-05-27 11:09:38 +0930378
Rusty Russellfddd5202009-06-12 21:46:57 -0600379/* This one must be bool. */
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600380int param_set_invbool(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700381{
Rusty Russellfddd5202009-06-12 21:46:57 -0600382 int ret;
383 bool boolval;
Jan Beulich22e48ea2007-10-16 23:29:34 -0700384 struct kernel_param dummy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385
Jan Beulich22e48ea2007-10-16 23:29:34 -0700386 dummy.arg = &boolval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 ret = param_set_bool(val, &dummy);
388 if (ret == 0)
Rusty Russell9a71af22009-06-12 21:46:53 -0600389 *(bool *)kp->arg = !boolval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390 return ret;
391}
Rusty Russella14fe242010-08-11 23:04:11 -0600392EXPORT_SYMBOL(param_set_invbool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600394int param_get_invbool(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395{
Rusty Russell9a71af22009-06-12 21:46:53 -0600396 return sprintf(buffer, "%c", (*(bool *)kp->arg) ? 'N' : 'Y');
Linus Torvalds1da177e2005-04-16 15:20:36 -0700397}
Rusty Russella14fe242010-08-11 23:04:11 -0600398EXPORT_SYMBOL(param_get_invbool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700399
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930400const struct kernel_param_ops param_ops_invbool = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600401 .set = param_set_invbool,
402 .get = param_get_invbool,
403};
404EXPORT_SYMBOL(param_ops_invbool);
405
Rusty Russell69116f22012-01-13 09:32:17 +1030406int param_set_bint(const char *val, const struct kernel_param *kp)
407{
Dan Streetman5104b7d2015-06-17 06:17:52 +0930408 /* Match bool exactly, by re-using it. */
409 struct kernel_param boolkp = *kp;
Rusty Russell69116f22012-01-13 09:32:17 +1030410 bool v;
411 int ret;
412
Rusty Russell69116f22012-01-13 09:32:17 +1030413 boolkp.arg = &v;
Rusty Russell69116f22012-01-13 09:32:17 +1030414
415 ret = param_set_bool(val, &boolkp);
416 if (ret == 0)
417 *(int *)kp->arg = v;
418 return ret;
419}
420EXPORT_SYMBOL(param_set_bint);
421
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930422const struct kernel_param_ops param_ops_bint = {
Jani Nikula6a4c2642014-08-27 06:21:23 +0930423 .flags = KERNEL_PARAM_OPS_FL_NOARG,
Rusty Russell69116f22012-01-13 09:32:17 +1030424 .set = param_set_bint,
425 .get = param_get_int,
426};
427EXPORT_SYMBOL(param_ops_bint);
428
Bert Wesarg9730b5b2007-05-08 00:28:50 -0700429/* We break the rule and mangle the string. */
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930430static int param_array(struct module *mod,
431 const char *name,
Adrian Bunk98717282006-03-25 03:07:06 -0800432 const char *val,
433 unsigned int min, unsigned int max,
434 void *elem, int elemsize,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600435 int (*set)(const char *, const struct kernel_param *kp),
Pawel Moll026cee02012-03-26 12:50:51 +1030436 s16 level,
Richard Knutssoneb38a992008-02-06 01:37:50 -0800437 unsigned int *num)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700438{
439 int ret;
440 struct kernel_param kp;
441 char save;
442
443 /* Get the name right for errors. */
444 kp.name = name;
445 kp.arg = elem;
Pawel Moll026cee02012-03-26 12:50:51 +1030446 kp.level = level;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447
Linus Torvalds1da177e2005-04-16 15:20:36 -0700448 *num = 0;
449 /* We expect a comma-separated list of values. */
450 do {
451 int len;
452
453 if (*num == max) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600454 pr_err("%s: can only take %i arguments\n", name, max);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455 return -EINVAL;
456 }
457 len = strcspn(val, ",");
458
459 /* nul-terminate and parse */
460 save = val[len];
461 ((char *)val)[len] = '\0';
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930462 BUG_ON(!KPARAM_IS_LOCKED(mod));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 ret = set(val, &kp);
464
465 if (ret != 0)
466 return ret;
467 kp.arg += elemsize;
468 val += len+1;
469 (*num)++;
470 } while (save == ',');
471
472 if (*num < min) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600473 pr_err("%s: needs at least %i arguments\n", name, min);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700474 return -EINVAL;
475 }
476 return 0;
477}
478
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600479static int param_array_set(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700480{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700481 const struct kparam_array *arr = kp->arr;
Bert Wesarg31143a12005-04-16 15:25:42 -0700482 unsigned int temp_num;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930484 return param_array(kp->mod, kp->name, val, 1, arr->max, arr->elem,
Pawel Moll026cee02012-03-26 12:50:51 +1030485 arr->elemsize, arr->ops->set, kp->level,
Rusty Russell3c7d76e2009-10-29 08:56:19 -0600486 arr->num ?: &temp_num);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487}
488
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600489static int param_array_get(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490{
491 int i, off, ret;
Jan Beulich22e48ea2007-10-16 23:29:34 -0700492 const struct kparam_array *arr = kp->arr;
Dan Streetman5104b7d2015-06-17 06:17:52 +0930493 struct kernel_param p = *kp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495 for (i = off = 0; i < (arr->num ? *arr->num : arr->max); i++) {
496 if (i)
497 buffer[off++] = ',';
498 p.arg = arr->elem + arr->elemsize * i;
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930499 BUG_ON(!KPARAM_IS_LOCKED(p.mod));
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600500 ret = arr->ops->get(buffer + off, &p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501 if (ret < 0)
502 return ret;
503 off += ret;
504 }
505 buffer[off] = '\0';
506 return off;
507}
508
Rusty Russelle6df34a2010-08-11 23:04:17 -0600509static void param_array_free(void *arg)
510{
511 unsigned int i;
512 const struct kparam_array *arr = arg;
513
514 if (arr->ops->free)
515 for (i = 0; i < (arr->num ? *arr->num : arr->max); i++)
516 arr->ops->free(arr->elem + arr->elemsize * i);
517}
518
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930519const struct kernel_param_ops param_array_ops = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600520 .set = param_array_set,
521 .get = param_array_get,
Rusty Russelle6df34a2010-08-11 23:04:17 -0600522 .free = param_array_free,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600523};
524EXPORT_SYMBOL(param_array_ops);
525
526int param_set_copystring(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700527{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700528 const struct kparam_string *kps = kp->str;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700529
530 if (strlen(val)+1 > kps->maxlen) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600531 pr_err("%s: string doesn't fit in %u chars.\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 kp->name, kps->maxlen-1);
533 return -ENOSPC;
534 }
535 strcpy(kps->string, val);
536 return 0;
537}
Rusty Russella14fe242010-08-11 23:04:11 -0600538EXPORT_SYMBOL(param_set_copystring);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700539
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600540int param_get_string(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700541{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700542 const struct kparam_string *kps = kp->str;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700543 return strlcpy(buffer, kps->string, kps->maxlen);
544}
Rusty Russella14fe242010-08-11 23:04:11 -0600545EXPORT_SYMBOL(param_get_string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930547const struct kernel_param_ops param_ops_string = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600548 .set = param_set_copystring,
549 .get = param_get_string,
550};
551EXPORT_SYMBOL(param_ops_string);
552
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553/* sysfs output in /sys/modules/XYZ/parameters/ */
Edward Z. Yang350f8252010-02-01 18:26:59 -0500554#define to_module_attr(n) container_of(n, struct module_attribute, attr)
555#define to_module_kobject(n) container_of(n, struct module_kobject, kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557struct param_attribute
558{
559 struct module_attribute mattr;
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600560 const struct kernel_param *param;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561};
562
563struct module_param_attrs
564{
Rusty Russell9b473de2008-10-22 10:00:22 -0500565 unsigned int num;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700566 struct attribute_group grp;
567 struct param_attribute attrs[0];
568};
569
Randy Dunlapef665c12007-02-13 15:19:06 -0800570#ifdef CONFIG_SYSFS
Edward Z. Yang350f8252010-02-01 18:26:59 -0500571#define to_param_attr(n) container_of(n, struct param_attribute, mattr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700572
573static ssize_t param_attr_show(struct module_attribute *mattr,
Kay Sievers4befb022011-07-24 22:06:04 +0930574 struct module_kobject *mk, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700575{
576 int count;
577 struct param_attribute *attribute = to_param_attr(mattr);
578
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600579 if (!attribute->param->ops->get)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 return -EPERM;
581
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930582 kernel_param_lock(mk->mod);
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600583 count = attribute->param->ops->get(buf, attribute->param);
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930584 kernel_param_unlock(mk->mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585 if (count > 0) {
586 strcat(buf, "\n");
587 ++count;
588 }
589 return count;
590}
591
592/* sysfs always hands a nul-terminated string in buf. We rely on that. */
593static ssize_t param_attr_store(struct module_attribute *mattr,
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930594 struct module_kobject *mk,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595 const char *buf, size_t len)
596{
597 int err;
598 struct param_attribute *attribute = to_param_attr(mattr);
599
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600600 if (!attribute->param->ops->set)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601 return -EPERM;
602
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930603 kernel_param_lock(mk->mod);
Rusty Russell7a486d372014-08-27 06:25:23 +0930604 param_check_unsafe(attribute->param);
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600605 err = attribute->param->ops->set(buf, attribute->param);
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930606 kernel_param_unlock(mk->mod);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700607 if (!err)
608 return len;
609 return err;
610}
Randy Dunlapef665c12007-02-13 15:19:06 -0800611#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700612
613#ifdef CONFIG_MODULES
614#define __modinit
615#else
616#define __modinit __init
617#endif
618
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930619void kernel_param_lock(struct module *mod)
Rusty Russell907b29e2010-08-11 23:04:19 -0600620{
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930621 mutex_lock(KPARAM_MUTEX(mod));
Rusty Russell907b29e2010-08-11 23:04:19 -0600622}
Rusty Russell907b29e2010-08-11 23:04:19 -0600623
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930624void kernel_param_unlock(struct module *mod)
Rusty Russell907b29e2010-08-11 23:04:19 -0600625{
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930626 mutex_unlock(KPARAM_MUTEX(mod));
Rusty Russell907b29e2010-08-11 23:04:19 -0600627}
Dan Streetmanb51d23e2015-06-17 06:18:52 +0930628
629#ifdef CONFIG_SYSFS
630EXPORT_SYMBOL(kernel_param_lock);
631EXPORT_SYMBOL(kernel_param_unlock);
Rusty Russell907b29e2010-08-11 23:04:19 -0600632
Linus Torvalds1da177e2005-04-16 15:20:36 -0700633/*
Rusty Russell9b473de2008-10-22 10:00:22 -0500634 * add_sysfs_param - add a parameter to sysfs
635 * @mk: struct module_kobject
636 * @kparam: the actual parameter definition to add to sysfs
637 * @name: name of parameter
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 *
Rusty Russell9b473de2008-10-22 10:00:22 -0500639 * Create a kobject if for a (per-module) parameter if mp NULL, and
640 * create file in sysfs. Returns an error on out of memory. Always cleans up
641 * if there's an error.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700642 */
Rusty Russell9b473de2008-10-22 10:00:22 -0500643static __modinit int add_sysfs_param(struct module_kobject *mk,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600644 const struct kernel_param *kp,
Rusty Russell9b473de2008-10-22 10:00:22 -0500645 const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700646{
Rusty Russell18eb74f2014-11-10 09:32:29 +1030647 struct module_param_attrs *new_mp;
648 struct attribute **new_attrs;
649 unsigned int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650
Rusty Russell9b473de2008-10-22 10:00:22 -0500651 /* We don't bother calling this with invisible parameters. */
652 BUG_ON(!kp->perm);
653
654 if (!mk->mp) {
Rusty Russell18eb74f2014-11-10 09:32:29 +1030655 /* First allocation. */
656 mk->mp = kzalloc(sizeof(*mk->mp), GFP_KERNEL);
657 if (!mk->mp)
658 return -ENOMEM;
659 mk->mp->grp.name = "parameters";
660 /* NULL-terminated attribute array. */
661 mk->mp->grp.attrs = kzalloc(sizeof(mk->mp->grp.attrs[0]),
662 GFP_KERNEL);
663 /* Caller will cleanup via free_module_param_attrs */
664 if (!mk->mp->grp.attrs)
665 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700666 }
667
Rusty Russell18eb74f2014-11-10 09:32:29 +1030668 /* Enlarge allocations. */
669 new_mp = krealloc(mk->mp,
670 sizeof(*mk->mp) +
671 sizeof(mk->mp->attrs[0]) * (mk->mp->num + 1),
672 GFP_KERNEL);
673 if (!new_mp)
674 return -ENOMEM;
675 mk->mp = new_mp;
Rusty Russell9b473de2008-10-22 10:00:22 -0500676
Rusty Russell18eb74f2014-11-10 09:32:29 +1030677 /* Extra pointer for NULL terminator */
678 new_attrs = krealloc(mk->mp->grp.attrs,
679 sizeof(mk->mp->grp.attrs[0]) * (mk->mp->num + 2),
680 GFP_KERNEL);
681 if (!new_attrs)
682 return -ENOMEM;
683 mk->mp->grp.attrs = new_attrs;
Rusty Russell9b473de2008-10-22 10:00:22 -0500684
685 /* Tack new one on the end. */
Rusty Russellc772be52015-01-20 09:07:04 +1030686 memset(&mk->mp->attrs[mk->mp->num], 0, sizeof(mk->mp->attrs[0]));
Rusty Russell18eb74f2014-11-10 09:32:29 +1030687 sysfs_attr_init(&mk->mp->attrs[mk->mp->num].mattr.attr);
688 mk->mp->attrs[mk->mp->num].param = kp;
689 mk->mp->attrs[mk->mp->num].mattr.show = param_attr_show;
Kees Cookb0a65b02014-12-12 13:36:49 +1030690 /* Do not allow runtime DAC changes to make param writable. */
691 if ((kp->perm & (S_IWUSR | S_IWGRP | S_IWOTH)) != 0)
692 mk->mp->attrs[mk->mp->num].mattr.store = param_attr_store;
Rusty Russell574732c2014-12-23 15:05:36 +1030693 else
694 mk->mp->attrs[mk->mp->num].mattr.store = NULL;
Rusty Russell18eb74f2014-11-10 09:32:29 +1030695 mk->mp->attrs[mk->mp->num].mattr.attr.name = (char *)name;
696 mk->mp->attrs[mk->mp->num].mattr.attr.mode = kp->perm;
697 mk->mp->num++;
Rusty Russell9b473de2008-10-22 10:00:22 -0500698
699 /* Fix up all the pointers, since krealloc can move us */
Rusty Russell18eb74f2014-11-10 09:32:29 +1030700 for (i = 0; i < mk->mp->num; i++)
701 mk->mp->grp.attrs[i] = &mk->mp->attrs[i].mattr.attr;
702 mk->mp->grp.attrs[mk->mp->num] = NULL;
Rusty Russell9b473de2008-10-22 10:00:22 -0500703 return 0;
Rusty Russell9b473de2008-10-22 10:00:22 -0500704}
705
Linus Torvaldsd2441182008-10-23 12:07:17 -0700706#ifdef CONFIG_MODULES
Rusty Russell9b473de2008-10-22 10:00:22 -0500707static void free_module_param_attrs(struct module_kobject *mk)
708{
Rusty Russell18eb74f2014-11-10 09:32:29 +1030709 if (mk->mp)
710 kfree(mk->mp->grp.attrs);
Rusty Russell9b473de2008-10-22 10:00:22 -0500711 kfree(mk->mp);
712 mk->mp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700713}
714
Linus Torvalds1da177e2005-04-16 15:20:36 -0700715/*
716 * module_param_sysfs_setup - setup sysfs support for one module
717 * @mod: module
718 * @kparam: module parameters (array)
719 * @num_params: number of module parameters
720 *
Rusty Russell9b473de2008-10-22 10:00:22 -0500721 * Adds sysfs entries for module parameters under
722 * /sys/module/[mod->name]/parameters/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700723 */
724int module_param_sysfs_setup(struct module *mod,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600725 const struct kernel_param *kparam,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700726 unsigned int num_params)
727{
Rusty Russell9b473de2008-10-22 10:00:22 -0500728 int i, err;
729 bool params = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730
Rusty Russell9b473de2008-10-22 10:00:22 -0500731 for (i = 0; i < num_params; i++) {
732 if (kparam[i].perm == 0)
733 continue;
734 err = add_sysfs_param(&mod->mkobj, &kparam[i], kparam[i].name);
Rusty Russell18eb74f2014-11-10 09:32:29 +1030735 if (err) {
736 free_module_param_attrs(&mod->mkobj);
Rusty Russell9b473de2008-10-22 10:00:22 -0500737 return err;
Rusty Russell18eb74f2014-11-10 09:32:29 +1030738 }
Rusty Russell9b473de2008-10-22 10:00:22 -0500739 params = true;
740 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700741
Rusty Russell9b473de2008-10-22 10:00:22 -0500742 if (!params)
743 return 0;
744
745 /* Create the param group. */
746 err = sysfs_create_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp);
747 if (err)
748 free_module_param_attrs(&mod->mkobj);
749 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700750}
751
752/*
753 * module_param_sysfs_remove - remove sysfs support for one module
754 * @mod: module
755 *
756 * Remove sysfs entries for module parameters and the corresponding
757 * kobject.
758 */
759void module_param_sysfs_remove(struct module *mod)
760{
Rusty Russell9b473de2008-10-22 10:00:22 -0500761 if (mod->mkobj.mp) {
762 sysfs_remove_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 /* We are positive that no one is using any param
764 * attrs at this point. Deallocate immediately. */
Rusty Russell9b473de2008-10-22 10:00:22 -0500765 free_module_param_attrs(&mod->mkobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700766 }
767}
768#endif
769
Rusty Russelle180a6b2009-03-31 13:05:29 -0600770void destroy_params(const struct kernel_param *params, unsigned num)
771{
Rusty Russelle6df34a2010-08-11 23:04:17 -0600772 unsigned int i;
773
774 for (i = 0; i < num; i++)
775 if (params[i].ops->free)
776 params[i].ops->free(params[i].arg);
Rusty Russelle180a6b2009-03-31 13:05:29 -0600777}
778
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800779static struct module_kobject * __init locate_module_kobject(const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700780{
781 struct module_kobject *mk;
Rusty Russell9b473de2008-10-22 10:00:22 -0500782 struct kobject *kobj;
783 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700784
Rusty Russell9b473de2008-10-22 10:00:22 -0500785 kobj = kset_find_obj(module_kset, name);
786 if (kobj) {
Rusty Russell9b473de2008-10-22 10:00:22 -0500787 mk = to_module_kobject(kobj);
Rusty Russell9b473de2008-10-22 10:00:22 -0500788 } else {
789 mk = kzalloc(sizeof(struct module_kobject), GFP_KERNEL);
790 BUG_ON(!mk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791
Rusty Russell9b473de2008-10-22 10:00:22 -0500792 mk->mod = THIS_MODULE;
793 mk->kobj.kset = module_kset;
794 err = kobject_init_and_add(&mk->kobj, &module_ktype, NULL,
795 "%s", name);
Kay Sievers88bfa322011-07-24 22:06:04 +0930796#ifdef CONFIG_MODULES
797 if (!err)
798 err = sysfs_create_file(&mk->kobj, &module_uevent.attr);
799#endif
Rusty Russell9b473de2008-10-22 10:00:22 -0500800 if (err) {
801 kobject_put(&mk->kobj);
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600802 pr_crit("Adding module '%s' to sysfs failed (%d), the system may be unstable.\n",
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800803 name, err);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800804 return NULL;
Rusty Russell9b473de2008-10-22 10:00:22 -0500805 }
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800806
807 /* So that we hold reference in both cases. */
Rusty Russell9b473de2008-10-22 10:00:22 -0500808 kobject_get(&mk->kobj);
Greg Kroah-Hartman74c5b592007-07-30 11:26:38 -0700809 }
Rusty Russell9b473de2008-10-22 10:00:22 -0500810
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800811 return mk;
812}
813
814static void __init kernel_add_sysfs_param(const char *name,
Geert Uytterhoeven63a12d92014-10-13 15:55:44 -0700815 const struct kernel_param *kparam,
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800816 unsigned int name_skip)
817{
818 struct module_kobject *mk;
819 int err;
820
821 mk = locate_module_kobject(name);
822 if (!mk)
823 return;
824
825 /* We need to remove old parameters before adding more. */
826 if (mk->mp)
827 sysfs_remove_group(&mk->kobj, &mk->mp->grp);
828
Rusty Russell9b473de2008-10-22 10:00:22 -0500829 /* These should not fail at boot. */
830 err = add_sysfs_param(mk, kparam, kparam->name + name_skip);
831 BUG_ON(err);
832 err = sysfs_create_group(&mk->kobj, &mk->mp->grp);
833 BUG_ON(err);
Kay Sieversf30c53a2007-01-15 20:22:02 +0100834 kobject_uevent(&mk->kobj, KOBJ_ADD);
Rusty Russell9b473de2008-10-22 10:00:22 -0500835 kobject_put(&mk->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700836}
837
838/*
Jean Delvareb634d132013-07-02 15:35:11 +0930839 * param_sysfs_builtin - add sysfs parameters for built-in modules
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840 *
841 * Add module_parameters to sysfs for "modules" built into the kernel.
842 *
843 * The "module" name (KBUILD_MODNAME) is stored before a dot, the
844 * "parameter" name is stored behind a dot in kernel_param->name. So,
845 * extract the "module" name for all built-in kernel_param-eters,
Rusty Russell9b473de2008-10-22 10:00:22 -0500846 * and for all who have the same, call kernel_add_sysfs_param.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847 */
848static void __init param_sysfs_builtin(void)
849{
Geert Uytterhoeven63a12d92014-10-13 15:55:44 -0700850 const struct kernel_param *kp;
Rusty Russell9b473de2008-10-22 10:00:22 -0500851 unsigned int name_len;
852 char modname[MODULE_NAME_LEN];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700853
Rusty Russell9b473de2008-10-22 10:00:22 -0500854 for (kp = __start___param; kp < __stop___param; kp++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700855 char *dot;
856
Rusty Russell9b473de2008-10-22 10:00:22 -0500857 if (kp->perm == 0)
858 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859
Rusty Russell730b69d2008-10-22 10:00:22 -0500860 dot = strchr(kp->name, '.');
Linus Torvalds1da177e2005-04-16 15:20:36 -0700861 if (!dot) {
Rusty Russell67e67ce2008-10-22 10:00:23 -0500862 /* This happens for core_param() */
863 strcpy(modname, "kernel");
864 name_len = 0;
865 } else {
866 name_len = dot - kp->name + 1;
867 strlcpy(modname, kp->name, name_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700868 }
Rusty Russell67e67ce2008-10-22 10:00:23 -0500869 kernel_add_sysfs_param(modname, kp, name_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700871}
872
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800873ssize_t __modver_version_show(struct module_attribute *mattr,
Kay Sievers4befb022011-07-24 22:06:04 +0930874 struct module_kobject *mk, char *buf)
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800875{
876 struct module_version_attribute *vattr =
877 container_of(mattr, struct module_version_attribute, mattr);
878
Chen Gangf4940ab2013-08-20 15:35:04 +0930879 return scnprintf(buf, PAGE_SIZE, "%s\n", vattr->version);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800880}
881
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800882extern const struct module_version_attribute *__start___modver[];
883extern const struct module_version_attribute *__stop___modver[];
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800884
885static void __init version_sysfs_builtin(void)
886{
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800887 const struct module_version_attribute **p;
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800888 struct module_kobject *mk;
889 int err;
890
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800891 for (p = __start___modver; p < __stop___modver; p++) {
892 const struct module_version_attribute *vattr = *p;
893
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800894 mk = locate_module_kobject(vattr->module_name);
895 if (mk) {
896 err = sysfs_create_file(&mk->kobj, &vattr->mattr.attr);
Rusty Russell74c3dea32015-06-17 06:16:52 +0930897 WARN_ON_ONCE(err);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800898 kobject_uevent(&mk->kobj, KOBJ_ADD);
899 kobject_put(&mk->kobj);
900 }
901 }
902}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700903
904/* module-related sysfs stuff */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700905
Linus Torvalds1da177e2005-04-16 15:20:36 -0700906static ssize_t module_attr_show(struct kobject *kobj,
907 struct attribute *attr,
908 char *buf)
909{
910 struct module_attribute *attribute;
911 struct module_kobject *mk;
912 int ret;
913
914 attribute = to_module_attr(attr);
915 mk = to_module_kobject(kobj);
916
917 if (!attribute->show)
Dmitry Torokhov70f28172005-04-29 01:27:34 -0500918 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700919
Kay Sievers4befb022011-07-24 22:06:04 +0930920 ret = attribute->show(attribute, mk, buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700921
Linus Torvalds1da177e2005-04-16 15:20:36 -0700922 return ret;
923}
924
925static ssize_t module_attr_store(struct kobject *kobj,
926 struct attribute *attr,
927 const char *buf, size_t len)
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->store)
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->store(attribute, mk, buf, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700940
Linus Torvalds1da177e2005-04-16 15:20:36 -0700941 return ret;
942}
943
Emese Revfy52cf25d2010-01-19 02:58:23 +0100944static const struct sysfs_ops module_sysfs_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700945 .show = module_attr_show,
946 .store = module_attr_store,
947};
948
Kay Sievers270a6c42007-01-18 13:26:15 +0100949static int uevent_filter(struct kset *kset, struct kobject *kobj)
950{
951 struct kobj_type *ktype = get_ktype(kobj);
952
953 if (ktype == &module_ktype)
954 return 1;
955 return 0;
956}
957
Emese Revfy9cd43612009-12-31 14:52:51 +0100958static const struct kset_uevent_ops module_uevent_ops = {
Kay Sievers270a6c42007-01-18 13:26:15 +0100959 .filter = uevent_filter,
960};
961
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700962struct kset *module_kset;
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700963int module_sysfs_initialized;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964
Li Zhong942e4432013-09-03 16:33:57 +0930965static void module_kobj_release(struct kobject *kobj)
966{
967 struct module_kobject *mk = to_module_kobject(kobj);
968 complete(mk->kobj_completion);
969}
970
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700971struct kobj_type module_ktype = {
Li Zhong942e4432013-09-03 16:33:57 +0930972 .release = module_kobj_release,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700973 .sysfs_ops = &module_sysfs_ops,
974};
975
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976/*
977 * param_sysfs_init - wrapper for built-in params support
978 */
979static int __init param_sysfs_init(void)
980{
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700981 module_kset = kset_create_and_add("module", &module_uevent_ops, NULL);
982 if (!module_kset) {
983 printk(KERN_WARNING "%s (%d): error creating kset\n",
984 __FILE__, __LINE__);
985 return -ENOMEM;
Randy Dunlapd8c76492006-09-29 01:58:55 -0700986 }
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700987 module_sysfs_initialized = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700988
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800989 version_sysfs_builtin();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700990 param_sysfs_builtin();
991
992 return 0;
993}
Mark Huangd10be6d2006-09-29 01:59:34 -0700994subsys_initcall(param_sysfs_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700995
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700996#endif /* CONFIG_SYSFS */