blob: a8b09f6c87dc40e7f6d2c50aaf9a8e718a14a987 [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 Russell907b29e2010-08-11 23:04:19 -060028/* Protects all parameters, and incidentally kmalloced_param list. */
29static DEFINE_MUTEX(param_lock);
30
Rusty Russella1054322010-08-11 23:04:18 -060031/* This just allows us to keep track of which parameters are kmalloced. */
32struct kmalloced_param {
33 struct list_head list;
34 char val[];
35};
Rusty Russella1054322010-08-11 23:04:18 -060036static LIST_HEAD(kmalloced_params);
37
38static void *kmalloc_parameter(unsigned int size)
39{
40 struct kmalloced_param *p;
41
42 p = kmalloc(sizeof(*p) + size, GFP_KERNEL);
43 if (!p)
44 return NULL;
45
Rusty Russella1054322010-08-11 23:04:18 -060046 list_add(&p->list, &kmalloced_params);
Rusty Russella1054322010-08-11 23:04:18 -060047 return p->val;
48}
49
50/* Does nothing if parameter wasn't kmalloced above. */
51static void maybe_kfree_parameter(void *param)
52{
53 struct kmalloced_param *p;
54
Rusty Russella1054322010-08-11 23:04:18 -060055 list_for_each_entry(p, &kmalloced_params, list) {
56 if (p->val == param) {
57 list_del(&p->list);
58 kfree(p);
59 break;
60 }
61 }
Rusty Russella1054322010-08-11 23:04:18 -060062}
63
Michal Schmidtb1e4d202011-10-10 00:03:37 +020064static char dash2underscore(char c)
Linus Torvalds1da177e2005-04-16 15:20:36 -070065{
66 if (c == '-')
67 return '_';
68 return c;
69}
70
Michal Schmidtb1e4d202011-10-10 00:03:37 +020071bool parameqn(const char *a, const char *b, size_t n)
Linus Torvalds1da177e2005-04-16 15:20:36 -070072{
Michal Schmidtb1e4d202011-10-10 00:03:37 +020073 size_t i;
74
75 for (i = 0; i < n; i++) {
76 if (dash2underscore(a[i]) != dash2underscore(b[i]))
77 return false;
78 }
79 return true;
80}
81
82bool parameq(const char *a, const char *b)
83{
84 return parameqn(a, b, strlen(a)+1);
Linus Torvalds1da177e2005-04-16 15:20:36 -070085}
86
Rusty Russell7a486d372014-08-27 06:25:23 +093087static void param_check_unsafe(const struct kernel_param *kp)
88{
89 if (kp->flags & KERNEL_PARAM_FL_UNSAFE) {
90 pr_warn("Setting dangerous option %s - tainting kernel\n",
91 kp->name);
92 add_taint(TAINT_USER, LOCKDEP_STILL_OK);
93 }
94}
95
Linus Torvalds1da177e2005-04-16 15:20:36 -070096static int parse_one(char *param,
97 char *val,
Jim Cromie9fb48c72012-04-27 14:30:34 -060098 const char *doing,
Rusty Russell914dcaa2010-08-11 23:04:18 -060099 const struct kernel_param *params,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700100 unsigned num_params,
Pawel Moll026cee02012-03-26 12:50:51 +1030101 s16 min_level,
102 s16 max_level,
Jim Cromie9fb48c72012-04-27 14:30:34 -0600103 int (*handle_unknown)(char *param, char *val,
104 const char *doing))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105{
106 unsigned int i;
Rusty Russell907b29e2010-08-11 23:04:19 -0600107 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700108
109 /* Find parameter */
110 for (i = 0; i < num_params; i++) {
111 if (parameq(param, params[i].name)) {
Pawel Moll026cee02012-03-26 12:50:51 +1030112 if (params[i].level < min_level
113 || params[i].level > max_level)
114 return 0;
Lucas De Marchi25985ed2011-03-30 22:57:33 -0300115 /* No one handled NULL, so do it here. */
Steven Rostedtab013c52013-08-20 15:33:19 +0930116 if (!val &&
Jani Nikula6a4c2642014-08-27 06:21:23 +0930117 !(params[i].ops->flags & KERNEL_PARAM_OPS_FL_NOARG))
Rusty Russell2e9fb992010-08-11 23:04:10 -0600118 return -EINVAL;
Jim Cromie9fb48c72012-04-27 14:30:34 -0600119 pr_debug("handling %s with %p\n", param,
120 params[i].ops->set);
Rusty Russell907b29e2010-08-11 23:04:19 -0600121 mutex_lock(&param_lock);
Rusty Russell7a486d372014-08-27 06:25:23 +0930122 param_check_unsafe(&params[i]);
Rusty Russell907b29e2010-08-11 23:04:19 -0600123 err = params[i].ops->set(val, &params[i]);
124 mutex_unlock(&param_lock);
125 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700126 }
127 }
128
129 if (handle_unknown) {
Jim Cromie9fb48c72012-04-27 14:30:34 -0600130 pr_debug("doing %s: %s='%s'\n", doing, param, val);
131 return handle_unknown(param, val, doing);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700132 }
133
Jim Cromie9fb48c72012-04-27 14:30:34 -0600134 pr_debug("Unknown argument '%s'\n", param);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700135 return -ENOENT;
136}
137
138/* You can use " around spaces, but can't escape ". */
139/* Hyphens and underscores equivalent in parameter names. */
140static char *next_arg(char *args, char **param, char **val)
141{
142 unsigned int i, equals = 0;
143 int in_quote = 0, quoted = 0;
144 char *next;
145
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146 if (*args == '"') {
147 args++;
148 in_quote = 1;
149 quoted = 1;
150 }
151
152 for (i = 0; args[i]; i++) {
Peter Oberparleiter26d052b2009-07-06 17:11:22 +0200153 if (isspace(args[i]) && !in_quote)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700154 break;
155 if (equals == 0) {
156 if (args[i] == '=')
157 equals = i;
158 }
159 if (args[i] == '"')
160 in_quote = !in_quote;
161 }
162
163 *param = args;
164 if (!equals)
165 *val = NULL;
166 else {
167 args[equals] = '\0';
168 *val = args + equals + 1;
169
170 /* Don't include quotes in value. */
171 if (**val == '"') {
172 (*val)++;
173 if (args[i-1] == '"')
174 args[i-1] = '\0';
175 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700176 }
Rusty Russellb9cc4482015-04-15 13:23:48 +0930177 if (quoted && args[i-1] == '"')
178 args[i-1] = '\0';
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179
180 if (args[i]) {
181 args[i] = '\0';
182 next = args + i + 1;
183 } else
184 next = args + i;
Rusty Russellf36462f2005-09-27 21:45:34 -0700185
186 /* Chew up trailing spaces. */
André Goddard Rosae7d28602009-12-14 18:01:06 -0800187 return skip_spaces(next);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700188}
189
190/* Args looks like "foo=bar,bar2 baz=fuz wiz". */
Rusty Russell51e158c2014-04-28 11:34:33 +0930191char *parse_args(const char *doing,
192 char *args,
193 const struct kernel_param *params,
194 unsigned num,
195 s16 min_level,
196 s16 max_level,
197 int (*unknown)(char *param, char *val, const char *doing))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198{
199 char *param, *val;
200
Rusty Russellf36462f2005-09-27 21:45:34 -0700201 /* Chew leading spaces */
André Goddard Rosae7d28602009-12-14 18:01:06 -0800202 args = skip_spaces(args);
Rusty Russellf36462f2005-09-27 21:45:34 -0700203
Jim Cromie1ef9eaf2012-05-03 11:57:37 -0600204 if (*args)
Jim Cromie9fb48c72012-04-27 14:30:34 -0600205 pr_debug("doing %s, parsing ARGS: '%s'\n", doing, args);
206
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207 while (*args) {
208 int ret;
Ard van Breemena416aba2007-01-05 16:36:20 -0800209 int irq_was_disabled;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700210
211 args = next_arg(args, &param, &val);
Rusty Russell51e158c2014-04-28 11:34:33 +0930212 /* Stop at -- */
213 if (!val && strcmp(param, "--") == 0)
214 return args;
Ard van Breemena416aba2007-01-05 16:36:20 -0800215 irq_was_disabled = irqs_disabled();
Jim Cromie9fb48c72012-04-27 14:30:34 -0600216 ret = parse_one(param, val, doing, params, num,
Pawel Moll026cee02012-03-26 12:50:51 +1030217 min_level, max_level, unknown);
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600218 if (irq_was_disabled && !irqs_disabled())
219 pr_warn("%s: option '%s' enabled irq's!\n",
220 doing, param);
221
Linus Torvalds1da177e2005-04-16 15:20:36 -0700222 switch (ret) {
223 case -ENOENT:
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600224 pr_err("%s: Unknown parameter `%s'\n", doing, param);
Rusty Russell51e158c2014-04-28 11:34:33 +0930225 return ERR_PTR(ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700226 case -ENOSPC:
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600227 pr_err("%s: `%s' too large for parameter `%s'\n",
Jim Cromie9fb48c72012-04-27 14:30:34 -0600228 doing, val ?: "", param);
Rusty Russell51e158c2014-04-28 11:34:33 +0930229 return ERR_PTR(ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700230 case 0:
231 break;
232 default:
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600233 pr_err("%s: `%s' invalid for parameter `%s'\n",
Jim Cromie9fb48c72012-04-27 14:30:34 -0600234 doing, val ?: "", param);
Rusty Russell51e158c2014-04-28 11:34:33 +0930235 return ERR_PTR(ret);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700236 }
237 }
238
239 /* All parsed OK. */
Rusty Russell51e158c2014-04-28 11:34:33 +0930240 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700241}
242
243/* Lazy bastard, eh? */
Felipe Contreras88a88b322013-12-04 14:09:38 +1030244#define STANDARD_PARAM_DEF(name, type, format, strtolfn) \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600245 int param_set_##name(const char *val, const struct kernel_param *kp) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700246 { \
Felipe Contreras88a88b322013-12-04 14:09:38 +1030247 return strtolfn(val, 0, (type *)kp->arg); \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700248 } \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600249 int param_get_##name(char *buffer, const struct kernel_param *kp) \
Linus Torvalds1da177e2005-04-16 15:20:36 -0700250 { \
Chen Gangf4940ab2013-08-20 15:35:04 +0930251 return scnprintf(buffer, PAGE_SIZE, format, \
252 *((type *)kp->arg)); \
Rusty Russella14fe242010-08-11 23:04:11 -0600253 } \
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930254 const struct kernel_param_ops param_ops_##name = { \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600255 .set = param_set_##name, \
256 .get = param_get_##name, \
257 }; \
Rusty Russella14fe242010-08-11 23:04:11 -0600258 EXPORT_SYMBOL(param_set_##name); \
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600259 EXPORT_SYMBOL(param_get_##name); \
260 EXPORT_SYMBOL(param_ops_##name)
261
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262
Felipe Contreras88a88b322013-12-04 14:09:38 +1030263STANDARD_PARAM_DEF(byte, unsigned char, "%hhu", kstrtou8);
264STANDARD_PARAM_DEF(short, short, "%hi", kstrtos16);
265STANDARD_PARAM_DEF(ushort, unsigned short, "%hu", kstrtou16);
266STANDARD_PARAM_DEF(int, int, "%i", kstrtoint);
267STANDARD_PARAM_DEF(uint, unsigned int, "%u", kstrtouint);
268STANDARD_PARAM_DEF(long, long, "%li", kstrtol);
269STANDARD_PARAM_DEF(ulong, unsigned long, "%lu", kstrtoul);
Hannes Reineckeb4210b82014-06-25 15:27:37 +0200270STANDARD_PARAM_DEF(ullong, unsigned long long, "%llu", kstrtoull);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700271
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600272int param_set_charp(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273{
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274 if (strlen(val) > 1024) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600275 pr_err("%s: string parameter too long\n", kp->name);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700276 return -ENOSPC;
277 }
278
Rusty Russella1054322010-08-11 23:04:18 -0600279 maybe_kfree_parameter(*(char **)kp->arg);
280
281 /* This is a hack. We can't kmalloc in early boot, and we
Rusty Russelle180a6b2009-03-31 13:05:29 -0600282 * don't need to; this mangled commandline is preserved. */
283 if (slab_is_available()) {
Rusty Russella1054322010-08-11 23:04:18 -0600284 *(char **)kp->arg = kmalloc_parameter(strlen(val)+1);
Rusty Russelld553ad82009-10-29 08:56:17 -0600285 if (!*(char **)kp->arg)
Rusty Russelle180a6b2009-03-31 13:05:29 -0600286 return -ENOMEM;
Rusty Russella1054322010-08-11 23:04:18 -0600287 strcpy(*(char **)kp->arg, val);
Rusty Russelle180a6b2009-03-31 13:05:29 -0600288 } else
289 *(const char **)kp->arg = val;
290
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291 return 0;
292}
Rusty Russella14fe242010-08-11 23:04:11 -0600293EXPORT_SYMBOL(param_set_charp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600295int param_get_charp(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296{
Chen Gangf4940ab2013-08-20 15:35:04 +0930297 return scnprintf(buffer, PAGE_SIZE, "%s", *((char **)kp->arg));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298}
Rusty Russella14fe242010-08-11 23:04:11 -0600299EXPORT_SYMBOL(param_get_charp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300
Rusty Russella1054322010-08-11 23:04:18 -0600301static void param_free_charp(void *arg)
302{
303 maybe_kfree_parameter(*((char **)arg));
304}
305
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930306const struct kernel_param_ops param_ops_charp = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600307 .set = param_set_charp,
308 .get = param_get_charp,
Rusty Russella1054322010-08-11 23:04:18 -0600309 .free = param_free_charp,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600310};
311EXPORT_SYMBOL(param_ops_charp);
312
Rusty Russellfddd5202009-06-12 21:46:57 -0600313/* Actually could be a bool or an int, for historical reasons. */
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600314int param_set_bool(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315{
316 /* No equals means "set"... */
317 if (!val) val = "1";
318
319 /* One of =[yYnN01] */
Rusty Russell8b825282012-03-26 12:50:51 +1030320 return strtobool(val, kp->arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321}
Rusty Russella14fe242010-08-11 23:04:11 -0600322EXPORT_SYMBOL(param_set_bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600324int param_get_bool(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700325{
326 /* Y and N chosen as being relatively non-coder friendly */
Rusty Russell8b825282012-03-26 12:50:51 +1030327 return sprintf(buffer, "%c", *(bool *)kp->arg ? 'Y' : 'N');
Linus Torvalds1da177e2005-04-16 15:20:36 -0700328}
Rusty Russella14fe242010-08-11 23:04:11 -0600329EXPORT_SYMBOL(param_get_bool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700330
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930331const struct kernel_param_ops param_ops_bool = {
Jani Nikula6a4c2642014-08-27 06:21:23 +0930332 .flags = KERNEL_PARAM_OPS_FL_NOARG,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600333 .set = param_set_bool,
334 .get = param_get_bool,
335};
336EXPORT_SYMBOL(param_ops_bool);
337
Luis R. Rodriguezd19f05d2015-05-27 11:09:38 +0930338int param_set_bool_enable_only(const char *val, const struct kernel_param *kp)
339{
340 int err = 0;
341 bool new_value;
342 bool orig_value = *(bool *)kp->arg;
343 struct kernel_param dummy_kp = *kp;
344
345 dummy_kp.arg = &new_value;
346
347 err = param_set_bool(val, &dummy_kp);
348 if (err)
349 return err;
350
351 /* Don't let them unset it once it's set! */
352 if (!new_value && orig_value)
353 return -EROFS;
354
355 if (new_value)
356 err = param_set_bool(val, kp);
357
358 return err;
359}
360EXPORT_SYMBOL_GPL(param_set_bool_enable_only);
361
362const struct kernel_param_ops param_ops_bool_enable_only = {
363 .flags = KERNEL_PARAM_OPS_FL_NOARG,
364 .set = param_set_bool_enable_only,
365 .get = param_get_bool,
366};
Luis R. Rodriguez154be212015-05-27 11:09:39 +0930367EXPORT_SYMBOL_GPL(param_ops_bool_enable_only);
Luis R. Rodriguezd19f05d2015-05-27 11:09:38 +0930368
Rusty Russellfddd5202009-06-12 21:46:57 -0600369/* This one must be bool. */
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600370int param_set_invbool(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371{
Rusty Russellfddd5202009-06-12 21:46:57 -0600372 int ret;
373 bool boolval;
Jan Beulich22e48ea2007-10-16 23:29:34 -0700374 struct kernel_param dummy;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700375
Jan Beulich22e48ea2007-10-16 23:29:34 -0700376 dummy.arg = &boolval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700377 ret = param_set_bool(val, &dummy);
378 if (ret == 0)
Rusty Russell9a71af22009-06-12 21:46:53 -0600379 *(bool *)kp->arg = !boolval;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700380 return ret;
381}
Rusty Russella14fe242010-08-11 23:04:11 -0600382EXPORT_SYMBOL(param_set_invbool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600384int param_get_invbool(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700385{
Rusty Russell9a71af22009-06-12 21:46:53 -0600386 return sprintf(buffer, "%c", (*(bool *)kp->arg) ? 'N' : 'Y');
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387}
Rusty Russella14fe242010-08-11 23:04:11 -0600388EXPORT_SYMBOL(param_get_invbool);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700389
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930390const struct kernel_param_ops param_ops_invbool = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600391 .set = param_set_invbool,
392 .get = param_get_invbool,
393};
394EXPORT_SYMBOL(param_ops_invbool);
395
Rusty Russell69116f22012-01-13 09:32:17 +1030396int param_set_bint(const char *val, const struct kernel_param *kp)
397{
Dan Streetman5104b7d2015-06-17 06:17:52 +0930398 /* Match bool exactly, by re-using it. */
399 struct kernel_param boolkp = *kp;
Rusty Russell69116f22012-01-13 09:32:17 +1030400 bool v;
401 int ret;
402
Rusty Russell69116f22012-01-13 09:32:17 +1030403 boolkp.arg = &v;
Rusty Russell69116f22012-01-13 09:32:17 +1030404
405 ret = param_set_bool(val, &boolkp);
406 if (ret == 0)
407 *(int *)kp->arg = v;
408 return ret;
409}
410EXPORT_SYMBOL(param_set_bint);
411
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930412const struct kernel_param_ops param_ops_bint = {
Jani Nikula6a4c2642014-08-27 06:21:23 +0930413 .flags = KERNEL_PARAM_OPS_FL_NOARG,
Rusty Russell69116f22012-01-13 09:32:17 +1030414 .set = param_set_bint,
415 .get = param_get_int,
416};
417EXPORT_SYMBOL(param_ops_bint);
418
Bert Wesarg9730b5b2007-05-08 00:28:50 -0700419/* We break the rule and mangle the string. */
Adrian Bunk98717282006-03-25 03:07:06 -0800420static int param_array(const char *name,
421 const char *val,
422 unsigned int min, unsigned int max,
423 void *elem, int elemsize,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600424 int (*set)(const char *, const struct kernel_param *kp),
Pawel Moll026cee02012-03-26 12:50:51 +1030425 s16 level,
Richard Knutssoneb38a992008-02-06 01:37:50 -0800426 unsigned int *num)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700427{
428 int ret;
429 struct kernel_param kp;
430 char save;
431
432 /* Get the name right for errors. */
433 kp.name = name;
434 kp.arg = elem;
Pawel Moll026cee02012-03-26 12:50:51 +1030435 kp.level = level;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700436
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 *num = 0;
438 /* We expect a comma-separated list of values. */
439 do {
440 int len;
441
442 if (*num == max) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600443 pr_err("%s: can only take %i arguments\n", name, max);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700444 return -EINVAL;
445 }
446 len = strcspn(val, ",");
447
448 /* nul-terminate and parse */
449 save = val[len];
450 ((char *)val)[len] = '\0';
Rusty Russell907b29e2010-08-11 23:04:19 -0600451 BUG_ON(!mutex_is_locked(&param_lock));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452 ret = set(val, &kp);
453
454 if (ret != 0)
455 return ret;
456 kp.arg += elemsize;
457 val += len+1;
458 (*num)++;
459 } while (save == ',');
460
461 if (*num < min) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600462 pr_err("%s: needs at least %i arguments\n", name, min);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700463 return -EINVAL;
464 }
465 return 0;
466}
467
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600468static int param_array_set(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700469{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700470 const struct kparam_array *arr = kp->arr;
Bert Wesarg31143a12005-04-16 15:25:42 -0700471 unsigned int temp_num;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472
473 return param_array(kp->name, val, 1, arr->max, arr->elem,
Pawel Moll026cee02012-03-26 12:50:51 +1030474 arr->elemsize, arr->ops->set, kp->level,
Rusty Russell3c7d76e2009-10-29 08:56:19 -0600475 arr->num ?: &temp_num);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700476}
477
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600478static int param_array_get(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479{
480 int i, off, ret;
Jan Beulich22e48ea2007-10-16 23:29:34 -0700481 const struct kparam_array *arr = kp->arr;
Dan Streetman5104b7d2015-06-17 06:17:52 +0930482 struct kernel_param p = *kp;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700483
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484 for (i = off = 0; i < (arr->num ? *arr->num : arr->max); i++) {
485 if (i)
486 buffer[off++] = ',';
487 p.arg = arr->elem + arr->elemsize * i;
Rusty Russell907b29e2010-08-11 23:04:19 -0600488 BUG_ON(!mutex_is_locked(&param_lock));
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600489 ret = arr->ops->get(buffer + off, &p);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490 if (ret < 0)
491 return ret;
492 off += ret;
493 }
494 buffer[off] = '\0';
495 return off;
496}
497
Rusty Russelle6df34a2010-08-11 23:04:17 -0600498static void param_array_free(void *arg)
499{
500 unsigned int i;
501 const struct kparam_array *arr = arg;
502
503 if (arr->ops->free)
504 for (i = 0; i < (arr->num ? *arr->num : arr->max); i++)
505 arr->ops->free(arr->elem + arr->elemsize * i);
506}
507
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930508const struct kernel_param_ops param_array_ops = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600509 .set = param_array_set,
510 .get = param_array_get,
Rusty Russelle6df34a2010-08-11 23:04:17 -0600511 .free = param_array_free,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600512};
513EXPORT_SYMBOL(param_array_ops);
514
515int param_set_copystring(const char *val, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700516{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700517 const struct kparam_string *kps = kp->str;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700518
519 if (strlen(val)+1 > kps->maxlen) {
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600520 pr_err("%s: string doesn't fit in %u chars.\n",
Linus Torvalds1da177e2005-04-16 15:20:36 -0700521 kp->name, kps->maxlen-1);
522 return -ENOSPC;
523 }
524 strcpy(kps->string, val);
525 return 0;
526}
Rusty Russella14fe242010-08-11 23:04:11 -0600527EXPORT_SYMBOL(param_set_copystring);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600529int param_get_string(char *buffer, const struct kernel_param *kp)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700530{
Jan Beulich22e48ea2007-10-16 23:29:34 -0700531 const struct kparam_string *kps = kp->str;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532 return strlcpy(buffer, kps->string, kps->maxlen);
533}
Rusty Russella14fe242010-08-11 23:04:11 -0600534EXPORT_SYMBOL(param_get_string);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535
Luis R. Rodriguez9c278472015-05-27 11:09:38 +0930536const struct kernel_param_ops param_ops_string = {
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600537 .set = param_set_copystring,
538 .get = param_get_string,
539};
540EXPORT_SYMBOL(param_ops_string);
541
Linus Torvalds1da177e2005-04-16 15:20:36 -0700542/* sysfs output in /sys/modules/XYZ/parameters/ */
Edward Z. Yang350f8252010-02-01 18:26:59 -0500543#define to_module_attr(n) container_of(n, struct module_attribute, attr)
544#define to_module_kobject(n) container_of(n, struct module_kobject, kobj)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700545
Linus Torvalds1da177e2005-04-16 15:20:36 -0700546struct param_attribute
547{
548 struct module_attribute mattr;
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600549 const struct kernel_param *param;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550};
551
552struct module_param_attrs
553{
Rusty Russell9b473de2008-10-22 10:00:22 -0500554 unsigned int num;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 struct attribute_group grp;
556 struct param_attribute attrs[0];
557};
558
Randy Dunlapef665c12007-02-13 15:19:06 -0800559#ifdef CONFIG_SYSFS
Edward Z. Yang350f8252010-02-01 18:26:59 -0500560#define to_param_attr(n) container_of(n, struct param_attribute, mattr)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561
562static ssize_t param_attr_show(struct module_attribute *mattr,
Kay Sievers4befb022011-07-24 22:06:04 +0930563 struct module_kobject *mk, char *buf)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564{
565 int count;
566 struct param_attribute *attribute = to_param_attr(mattr);
567
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600568 if (!attribute->param->ops->get)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569 return -EPERM;
570
Rusty Russell907b29e2010-08-11 23:04:19 -0600571 mutex_lock(&param_lock);
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600572 count = attribute->param->ops->get(buf, attribute->param);
Rusty Russell907b29e2010-08-11 23:04:19 -0600573 mutex_unlock(&param_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 if (count > 0) {
575 strcat(buf, "\n");
576 ++count;
577 }
578 return count;
579}
580
581/* sysfs always hands a nul-terminated string in buf. We rely on that. */
582static ssize_t param_attr_store(struct module_attribute *mattr,
Kay Sievers4befb022011-07-24 22:06:04 +0930583 struct module_kobject *km,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 const char *buf, size_t len)
585{
586 int err;
587 struct param_attribute *attribute = to_param_attr(mattr);
588
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600589 if (!attribute->param->ops->set)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700590 return -EPERM;
591
Rusty Russell907b29e2010-08-11 23:04:19 -0600592 mutex_lock(&param_lock);
Rusty Russell7a486d372014-08-27 06:25:23 +0930593 param_check_unsafe(attribute->param);
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600594 err = attribute->param->ops->set(buf, attribute->param);
Rusty Russell907b29e2010-08-11 23:04:19 -0600595 mutex_unlock(&param_lock);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596 if (!err)
597 return len;
598 return err;
599}
Randy Dunlapef665c12007-02-13 15:19:06 -0800600#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -0700601
602#ifdef CONFIG_MODULES
603#define __modinit
604#else
605#define __modinit __init
606#endif
607
Randy Dunlapef665c12007-02-13 15:19:06 -0800608#ifdef CONFIG_SYSFS
Rusty Russell907b29e2010-08-11 23:04:19 -0600609void __kernel_param_lock(void)
610{
611 mutex_lock(&param_lock);
612}
613EXPORT_SYMBOL(__kernel_param_lock);
614
615void __kernel_param_unlock(void)
616{
617 mutex_unlock(&param_lock);
618}
619EXPORT_SYMBOL(__kernel_param_unlock);
620
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621/*
Rusty Russell9b473de2008-10-22 10:00:22 -0500622 * add_sysfs_param - add a parameter to sysfs
623 * @mk: struct module_kobject
624 * @kparam: the actual parameter definition to add to sysfs
625 * @name: name of parameter
Linus Torvalds1da177e2005-04-16 15:20:36 -0700626 *
Rusty Russell9b473de2008-10-22 10:00:22 -0500627 * Create a kobject if for a (per-module) parameter if mp NULL, and
628 * create file in sysfs. Returns an error on out of memory. Always cleans up
629 * if there's an error.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700630 */
Rusty Russell9b473de2008-10-22 10:00:22 -0500631static __modinit int add_sysfs_param(struct module_kobject *mk,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600632 const struct kernel_param *kp,
Rusty Russell9b473de2008-10-22 10:00:22 -0500633 const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634{
Rusty Russell18eb74f2014-11-10 09:32:29 +1030635 struct module_param_attrs *new_mp;
636 struct attribute **new_attrs;
637 unsigned int i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638
Rusty Russell9b473de2008-10-22 10:00:22 -0500639 /* We don't bother calling this with invisible parameters. */
640 BUG_ON(!kp->perm);
641
642 if (!mk->mp) {
Rusty Russell18eb74f2014-11-10 09:32:29 +1030643 /* First allocation. */
644 mk->mp = kzalloc(sizeof(*mk->mp), GFP_KERNEL);
645 if (!mk->mp)
646 return -ENOMEM;
647 mk->mp->grp.name = "parameters";
648 /* NULL-terminated attribute array. */
649 mk->mp->grp.attrs = kzalloc(sizeof(mk->mp->grp.attrs[0]),
650 GFP_KERNEL);
651 /* Caller will cleanup via free_module_param_attrs */
652 if (!mk->mp->grp.attrs)
653 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700654 }
655
Rusty Russell18eb74f2014-11-10 09:32:29 +1030656 /* Enlarge allocations. */
657 new_mp = krealloc(mk->mp,
658 sizeof(*mk->mp) +
659 sizeof(mk->mp->attrs[0]) * (mk->mp->num + 1),
660 GFP_KERNEL);
661 if (!new_mp)
662 return -ENOMEM;
663 mk->mp = new_mp;
Rusty Russell9b473de2008-10-22 10:00:22 -0500664
Rusty Russell18eb74f2014-11-10 09:32:29 +1030665 /* Extra pointer for NULL terminator */
666 new_attrs = krealloc(mk->mp->grp.attrs,
667 sizeof(mk->mp->grp.attrs[0]) * (mk->mp->num + 2),
668 GFP_KERNEL);
669 if (!new_attrs)
670 return -ENOMEM;
671 mk->mp->grp.attrs = new_attrs;
Rusty Russell9b473de2008-10-22 10:00:22 -0500672
673 /* Tack new one on the end. */
Rusty Russellc772be52015-01-20 09:07:04 +1030674 memset(&mk->mp->attrs[mk->mp->num], 0, sizeof(mk->mp->attrs[0]));
Rusty Russell18eb74f2014-11-10 09:32:29 +1030675 sysfs_attr_init(&mk->mp->attrs[mk->mp->num].mattr.attr);
676 mk->mp->attrs[mk->mp->num].param = kp;
677 mk->mp->attrs[mk->mp->num].mattr.show = param_attr_show;
Kees Cookb0a65b02014-12-12 13:36:49 +1030678 /* Do not allow runtime DAC changes to make param writable. */
679 if ((kp->perm & (S_IWUSR | S_IWGRP | S_IWOTH)) != 0)
680 mk->mp->attrs[mk->mp->num].mattr.store = param_attr_store;
Rusty Russell574732c2014-12-23 15:05:36 +1030681 else
682 mk->mp->attrs[mk->mp->num].mattr.store = NULL;
Rusty Russell18eb74f2014-11-10 09:32:29 +1030683 mk->mp->attrs[mk->mp->num].mattr.attr.name = (char *)name;
684 mk->mp->attrs[mk->mp->num].mattr.attr.mode = kp->perm;
685 mk->mp->num++;
Rusty Russell9b473de2008-10-22 10:00:22 -0500686
687 /* Fix up all the pointers, since krealloc can move us */
Rusty Russell18eb74f2014-11-10 09:32:29 +1030688 for (i = 0; i < mk->mp->num; i++)
689 mk->mp->grp.attrs[i] = &mk->mp->attrs[i].mattr.attr;
690 mk->mp->grp.attrs[mk->mp->num] = NULL;
Rusty Russell9b473de2008-10-22 10:00:22 -0500691 return 0;
Rusty Russell9b473de2008-10-22 10:00:22 -0500692}
693
Linus Torvaldsd2441182008-10-23 12:07:17 -0700694#ifdef CONFIG_MODULES
Rusty Russell9b473de2008-10-22 10:00:22 -0500695static void free_module_param_attrs(struct module_kobject *mk)
696{
Rusty Russell18eb74f2014-11-10 09:32:29 +1030697 if (mk->mp)
698 kfree(mk->mp->grp.attrs);
Rusty Russell9b473de2008-10-22 10:00:22 -0500699 kfree(mk->mp);
700 mk->mp = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700701}
702
Linus Torvalds1da177e2005-04-16 15:20:36 -0700703/*
704 * module_param_sysfs_setup - setup sysfs support for one module
705 * @mod: module
706 * @kparam: module parameters (array)
707 * @num_params: number of module parameters
708 *
Rusty Russell9b473de2008-10-22 10:00:22 -0500709 * Adds sysfs entries for module parameters under
710 * /sys/module/[mod->name]/parameters/
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711 */
712int module_param_sysfs_setup(struct module *mod,
Rusty Russell9bbb9e52010-08-11 23:04:12 -0600713 const struct kernel_param *kparam,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700714 unsigned int num_params)
715{
Rusty Russell9b473de2008-10-22 10:00:22 -0500716 int i, err;
717 bool params = false;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700718
Rusty Russell9b473de2008-10-22 10:00:22 -0500719 for (i = 0; i < num_params; i++) {
720 if (kparam[i].perm == 0)
721 continue;
722 err = add_sysfs_param(&mod->mkobj, &kparam[i], kparam[i].name);
Rusty Russell18eb74f2014-11-10 09:32:29 +1030723 if (err) {
724 free_module_param_attrs(&mod->mkobj);
Rusty Russell9b473de2008-10-22 10:00:22 -0500725 return err;
Rusty Russell18eb74f2014-11-10 09:32:29 +1030726 }
Rusty Russell9b473de2008-10-22 10:00:22 -0500727 params = true;
728 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700729
Rusty Russell9b473de2008-10-22 10:00:22 -0500730 if (!params)
731 return 0;
732
733 /* Create the param group. */
734 err = sysfs_create_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp);
735 if (err)
736 free_module_param_attrs(&mod->mkobj);
737 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738}
739
740/*
741 * module_param_sysfs_remove - remove sysfs support for one module
742 * @mod: module
743 *
744 * Remove sysfs entries for module parameters and the corresponding
745 * kobject.
746 */
747void module_param_sysfs_remove(struct module *mod)
748{
Rusty Russell9b473de2008-10-22 10:00:22 -0500749 if (mod->mkobj.mp) {
750 sysfs_remove_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 /* We are positive that no one is using any param
752 * attrs at this point. Deallocate immediately. */
Rusty Russell9b473de2008-10-22 10:00:22 -0500753 free_module_param_attrs(&mod->mkobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700754 }
755}
756#endif
757
Rusty Russelle180a6b2009-03-31 13:05:29 -0600758void destroy_params(const struct kernel_param *params, unsigned num)
759{
Rusty Russelle6df34a2010-08-11 23:04:17 -0600760 unsigned int i;
761
762 for (i = 0; i < num; i++)
763 if (params[i].ops->free)
764 params[i].ops->free(params[i].arg);
Rusty Russelle180a6b2009-03-31 13:05:29 -0600765}
766
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800767static struct module_kobject * __init locate_module_kobject(const char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768{
769 struct module_kobject *mk;
Rusty Russell9b473de2008-10-22 10:00:22 -0500770 struct kobject *kobj;
771 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700772
Rusty Russell9b473de2008-10-22 10:00:22 -0500773 kobj = kset_find_obj(module_kset, name);
774 if (kobj) {
Rusty Russell9b473de2008-10-22 10:00:22 -0500775 mk = to_module_kobject(kobj);
Rusty Russell9b473de2008-10-22 10:00:22 -0500776 } else {
777 mk = kzalloc(sizeof(struct module_kobject), GFP_KERNEL);
778 BUG_ON(!mk);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779
Rusty Russell9b473de2008-10-22 10:00:22 -0500780 mk->mod = THIS_MODULE;
781 mk->kobj.kset = module_kset;
782 err = kobject_init_and_add(&mk->kobj, &module_ktype, NULL,
783 "%s", name);
Kay Sievers88bfa322011-07-24 22:06:04 +0930784#ifdef CONFIG_MODULES
785 if (!err)
786 err = sysfs_create_file(&mk->kobj, &module_uevent.attr);
787#endif
Rusty Russell9b473de2008-10-22 10:00:22 -0500788 if (err) {
789 kobject_put(&mk->kobj);
Jim Cromieb5f3abf2012-05-03 18:22:44 -0600790 pr_crit("Adding module '%s' to sysfs failed (%d), the system may be unstable.\n",
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800791 name, err);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800792 return NULL;
Rusty Russell9b473de2008-10-22 10:00:22 -0500793 }
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800794
795 /* So that we hold reference in both cases. */
Rusty Russell9b473de2008-10-22 10:00:22 -0500796 kobject_get(&mk->kobj);
Greg Kroah-Hartman74c5b592007-07-30 11:26:38 -0700797 }
Rusty Russell9b473de2008-10-22 10:00:22 -0500798
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800799 return mk;
800}
801
802static void __init kernel_add_sysfs_param(const char *name,
Geert Uytterhoeven63a12d92014-10-13 15:55:44 -0700803 const struct kernel_param *kparam,
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800804 unsigned int name_skip)
805{
806 struct module_kobject *mk;
807 int err;
808
809 mk = locate_module_kobject(name);
810 if (!mk)
811 return;
812
813 /* We need to remove old parameters before adding more. */
814 if (mk->mp)
815 sysfs_remove_group(&mk->kobj, &mk->mp->grp);
816
Rusty Russell9b473de2008-10-22 10:00:22 -0500817 /* These should not fail at boot. */
818 err = add_sysfs_param(mk, kparam, kparam->name + name_skip);
819 BUG_ON(err);
820 err = sysfs_create_group(&mk->kobj, &mk->mp->grp);
821 BUG_ON(err);
Kay Sieversf30c53a2007-01-15 20:22:02 +0100822 kobject_uevent(&mk->kobj, KOBJ_ADD);
Rusty Russell9b473de2008-10-22 10:00:22 -0500823 kobject_put(&mk->kobj);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700824}
825
826/*
Jean Delvareb634d132013-07-02 15:35:11 +0930827 * param_sysfs_builtin - add sysfs parameters for built-in modules
Linus Torvalds1da177e2005-04-16 15:20:36 -0700828 *
829 * Add module_parameters to sysfs for "modules" built into the kernel.
830 *
831 * The "module" name (KBUILD_MODNAME) is stored before a dot, the
832 * "parameter" name is stored behind a dot in kernel_param->name. So,
833 * extract the "module" name for all built-in kernel_param-eters,
Rusty Russell9b473de2008-10-22 10:00:22 -0500834 * and for all who have the same, call kernel_add_sysfs_param.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 */
836static void __init param_sysfs_builtin(void)
837{
Geert Uytterhoeven63a12d92014-10-13 15:55:44 -0700838 const struct kernel_param *kp;
Rusty Russell9b473de2008-10-22 10:00:22 -0500839 unsigned int name_len;
840 char modname[MODULE_NAME_LEN];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700841
Rusty Russell9b473de2008-10-22 10:00:22 -0500842 for (kp = __start___param; kp < __stop___param; kp++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700843 char *dot;
844
Rusty Russell9b473de2008-10-22 10:00:22 -0500845 if (kp->perm == 0)
846 continue;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700847
Rusty Russell730b69d2008-10-22 10:00:22 -0500848 dot = strchr(kp->name, '.');
Linus Torvalds1da177e2005-04-16 15:20:36 -0700849 if (!dot) {
Rusty Russell67e67ce2008-10-22 10:00:23 -0500850 /* This happens for core_param() */
851 strcpy(modname, "kernel");
852 name_len = 0;
853 } else {
854 name_len = dot - kp->name + 1;
855 strlcpy(modname, kp->name, name_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700856 }
Rusty Russell67e67ce2008-10-22 10:00:23 -0500857 kernel_add_sysfs_param(modname, kp, name_len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700858 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700859}
860
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800861ssize_t __modver_version_show(struct module_attribute *mattr,
Kay Sievers4befb022011-07-24 22:06:04 +0930862 struct module_kobject *mk, char *buf)
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800863{
864 struct module_version_attribute *vattr =
865 container_of(mattr, struct module_version_attribute, mattr);
866
Chen Gangf4940ab2013-08-20 15:35:04 +0930867 return scnprintf(buf, PAGE_SIZE, "%s\n", vattr->version);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800868}
869
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800870extern const struct module_version_attribute *__start___modver[];
871extern const struct module_version_attribute *__stop___modver[];
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800872
873static void __init version_sysfs_builtin(void)
874{
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800875 const struct module_version_attribute **p;
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800876 struct module_kobject *mk;
877 int err;
878
Dmitry Torokhovb4bc84282011-02-07 16:02:25 -0800879 for (p = __start___modver; p < __stop___modver; p++) {
880 const struct module_version_attribute *vattr = *p;
881
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800882 mk = locate_module_kobject(vattr->module_name);
883 if (mk) {
884 err = sysfs_create_file(&mk->kobj, &vattr->mattr.attr);
Rusty Russell74c3dea32015-06-17 06:16:52 +0930885 WARN_ON_ONCE(err);
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800886 kobject_uevent(&mk->kobj, KOBJ_ADD);
887 kobject_put(&mk->kobj);
888 }
889 }
890}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891
892/* module-related sysfs stuff */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700893
Linus Torvalds1da177e2005-04-16 15:20:36 -0700894static ssize_t module_attr_show(struct kobject *kobj,
895 struct attribute *attr,
896 char *buf)
897{
898 struct module_attribute *attribute;
899 struct module_kobject *mk;
900 int ret;
901
902 attribute = to_module_attr(attr);
903 mk = to_module_kobject(kobj);
904
905 if (!attribute->show)
Dmitry Torokhov70f28172005-04-29 01:27:34 -0500906 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907
Kay Sievers4befb022011-07-24 22:06:04 +0930908 ret = attribute->show(attribute, mk, buf);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700909
Linus Torvalds1da177e2005-04-16 15:20:36 -0700910 return ret;
911}
912
913static ssize_t module_attr_store(struct kobject *kobj,
914 struct attribute *attr,
915 const char *buf, size_t len)
916{
917 struct module_attribute *attribute;
918 struct module_kobject *mk;
919 int ret;
920
921 attribute = to_module_attr(attr);
922 mk = to_module_kobject(kobj);
923
924 if (!attribute->store)
Dmitry Torokhov70f28172005-04-29 01:27:34 -0500925 return -EIO;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700926
Kay Sievers4befb022011-07-24 22:06:04 +0930927 ret = attribute->store(attribute, mk, buf, len);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700928
Linus Torvalds1da177e2005-04-16 15:20:36 -0700929 return ret;
930}
931
Emese Revfy52cf25d2010-01-19 02:58:23 +0100932static const struct sysfs_ops module_sysfs_ops = {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700933 .show = module_attr_show,
934 .store = module_attr_store,
935};
936
Kay Sievers270a6c42007-01-18 13:26:15 +0100937static int uevent_filter(struct kset *kset, struct kobject *kobj)
938{
939 struct kobj_type *ktype = get_ktype(kobj);
940
941 if (ktype == &module_ktype)
942 return 1;
943 return 0;
944}
945
Emese Revfy9cd43612009-12-31 14:52:51 +0100946static const struct kset_uevent_ops module_uevent_ops = {
Kay Sievers270a6c42007-01-18 13:26:15 +0100947 .filter = uevent_filter,
948};
949
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700950struct kset *module_kset;
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700951int module_sysfs_initialized;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952
Li Zhong942e4432013-09-03 16:33:57 +0930953static void module_kobj_release(struct kobject *kobj)
954{
955 struct module_kobject *mk = to_module_kobject(kobj);
956 complete(mk->kobj_completion);
957}
958
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700959struct kobj_type module_ktype = {
Li Zhong942e4432013-09-03 16:33:57 +0930960 .release = module_kobj_release,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700961 .sysfs_ops = &module_sysfs_ops,
962};
963
Linus Torvalds1da177e2005-04-16 15:20:36 -0700964/*
965 * param_sysfs_init - wrapper for built-in params support
966 */
967static int __init param_sysfs_init(void)
968{
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700969 module_kset = kset_create_and_add("module", &module_uevent_ops, NULL);
970 if (!module_kset) {
971 printk(KERN_WARNING "%s (%d): error creating kset\n",
972 __FILE__, __LINE__);
973 return -ENOMEM;
Randy Dunlapd8c76492006-09-29 01:58:55 -0700974 }
Greg Kroah-Hartman823bccf2007-04-13 13:15:19 -0700975 module_sysfs_initialized = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700976
Dmitry Torokhove94965e2010-12-15 14:00:19 -0800977 version_sysfs_builtin();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978 param_sysfs_builtin();
979
980 return 0;
981}
Mark Huangd10be6d2006-09-29 01:59:34 -0700982subsys_initcall(param_sysfs_init);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983
Greg Kroah-Hartman7405c1e2007-11-01 10:39:50 -0700984#endif /* CONFIG_SYSFS */