Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /* 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 | */ | |
1da177e4 LT |
18 | #include <linux/kernel.h> |
19 | #include <linux/string.h> | |
20 | #include <linux/errno.h> | |
21 | #include <linux/module.h> | |
63a12d9d | 22 | #include <linux/moduleparam.h> |
1da177e4 LT |
23 | #include <linux/device.h> |
24 | #include <linux/err.h> | |
4e57b681 | 25 | #include <linux/slab.h> |
26d052bf | 26 | #include <linux/ctype.h> |
1da177e4 | 27 | |
cf2fde7b | 28 | #ifdef CONFIG_SYSFS |
b51d23e4 | 29 | /* Protects all built-in parameters, modules use their own param_lock */ |
907b29eb RR |
30 | static DEFINE_MUTEX(param_lock); |
31 | ||
b51d23e4 | 32 | /* Use the module's mutex, or if built-in use the built-in mutex */ |
20bdc2cf | 33 | #ifdef CONFIG_MODULES |
b51d23e4 | 34 | #define KPARAM_MUTEX(mod) ((mod) ? &(mod)->param_lock : ¶m_lock) |
20bdc2cf SR |
35 | #else |
36 | #define KPARAM_MUTEX(mod) (¶m_lock) | |
37 | #endif | |
cf2fde7b RR |
38 | |
39 | static inline void check_kparam_locked(struct module *mod) | |
40 | { | |
41 | BUG_ON(!mutex_is_locked(KPARAM_MUTEX(mod))); | |
42 | } | |
43 | #else | |
44 | static inline void check_kparam_locked(struct module *mod) | |
45 | { | |
46 | } | |
47 | #endif /* !CONFIG_SYSFS */ | |
b51d23e4 | 48 | |
a1054322 RR |
49 | /* This just allows us to keep track of which parameters are kmalloced. */ |
50 | struct kmalloced_param { | |
51 | struct list_head list; | |
52 | char val[]; | |
53 | }; | |
a1054322 | 54 | static LIST_HEAD(kmalloced_params); |
b51d23e4 | 55 | static DEFINE_SPINLOCK(kmalloced_params_lock); |
a1054322 RR |
56 | |
57 | static 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 | ||
b51d23e4 | 65 | spin_lock(&kmalloced_params_lock); |
a1054322 | 66 | list_add(&p->list, &kmalloced_params); |
b51d23e4 DS |
67 | spin_unlock(&kmalloced_params_lock); |
68 | ||
a1054322 RR |
69 | return p->val; |
70 | } | |
71 | ||
72 | /* Does nothing if parameter wasn't kmalloced above. */ | |
73 | static void maybe_kfree_parameter(void *param) | |
74 | { | |
75 | struct kmalloced_param *p; | |
76 | ||
b51d23e4 | 77 | spin_lock(&kmalloced_params_lock); |
a1054322 RR |
78 | 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 | } | |
b51d23e4 | 85 | spin_unlock(&kmalloced_params_lock); |
a1054322 RR |
86 | } |
87 | ||
b1e4d20c | 88 | static char dash2underscore(char c) |
1da177e4 LT |
89 | { |
90 | if (c == '-') | |
91 | return '_'; | |
92 | return c; | |
93 | } | |
94 | ||
b1e4d20c | 95 | bool parameqn(const char *a, const char *b, size_t n) |
1da177e4 | 96 | { |
b1e4d20c MS |
97 | 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 | ||
106 | bool parameq(const char *a, const char *b) | |
107 | { | |
108 | return parameqn(a, b, strlen(a)+1); | |
1da177e4 LT |
109 | } |
110 | ||
7a486d37 RR |
111 | static 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 | ||
1da177e4 LT |
120 | static int parse_one(char *param, |
121 | char *val, | |
9fb48c74 | 122 | const char *doing, |
914dcaa8 | 123 | const struct kernel_param *params, |
1da177e4 | 124 | unsigned num_params, |
026cee00 PM |
125 | s16 min_level, |
126 | s16 max_level, | |
ecc86170 | 127 | void *arg, |
9fb48c74 | 128 | int (*handle_unknown)(char *param, char *val, |
ecc86170 | 129 | const char *doing, void *arg)) |
1da177e4 LT |
130 | { |
131 | unsigned int i; | |
907b29eb | 132 | int err; |
1da177e4 LT |
133 | |
134 | /* Find parameter */ | |
135 | for (i = 0; i < num_params; i++) { | |
136 | if (parameq(param, params[i].name)) { | |
026cee00 PM |
137 | if (params[i].level < min_level |
138 | || params[i].level > max_level) | |
139 | return 0; | |
25985edc | 140 | /* No one handled NULL, so do it here. */ |
ab013c5f | 141 | if (!val && |
6a4c2643 | 142 | !(params[i].ops->flags & KERNEL_PARAM_OPS_FL_NOARG)) |
2e9fb995 | 143 | return -EINVAL; |
9fb48c74 JC |
144 | pr_debug("handling %s with %p\n", param, |
145 | params[i].ops->set); | |
b51d23e4 | 146 | kernel_param_lock(params[i].mod); |
7a486d37 | 147 | param_check_unsafe(¶ms[i]); |
907b29eb | 148 | err = params[i].ops->set(val, ¶ms[i]); |
b51d23e4 | 149 | kernel_param_unlock(params[i].mod); |
907b29eb | 150 | return err; |
1da177e4 LT |
151 | } |
152 | } | |
153 | ||
154 | if (handle_unknown) { | |
9fb48c74 | 155 | pr_debug("doing %s: %s='%s'\n", doing, param, val); |
ecc86170 | 156 | return handle_unknown(param, val, doing, arg); |
1da177e4 LT |
157 | } |
158 | ||
9fb48c74 | 159 | pr_debug("Unknown argument '%s'\n", param); |
1da177e4 LT |
160 | return -ENOENT; |
161 | } | |
162 | ||
163 | /* You can use " around spaces, but can't escape ". */ | |
164 | /* Hyphens and underscores equivalent in parameter names. */ | |
165 | static 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 | ||
1da177e4 LT |
171 | if (*args == '"') { |
172 | args++; | |
173 | in_quote = 1; | |
174 | quoted = 1; | |
175 | } | |
176 | ||
177 | for (i = 0; args[i]; i++) { | |
26d052bf | 178 | if (isspace(args[i]) && !in_quote) |
1da177e4 LT |
179 | 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 | } | |
1da177e4 | 201 | } |
b9cc4489 RR |
202 | if (quoted && args[i-1] == '"') |
203 | args[i-1] = '\0'; | |
1da177e4 LT |
204 | |
205 | if (args[i]) { | |
206 | args[i] = '\0'; | |
207 | next = args + i + 1; | |
208 | } else | |
209 | next = args + i; | |
f36462f0 RR |
210 | |
211 | /* Chew up trailing spaces. */ | |
e7d2860b | 212 | return skip_spaces(next); |
1da177e4 LT |
213 | } |
214 | ||
215 | /* Args looks like "foo=bar,bar2 baz=fuz wiz". */ | |
51e158c1 RR |
216 | char *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, | |
ecc86170 LR |
222 | void *arg, |
223 | int (*unknown)(char *param, char *val, | |
224 | const char *doing, void *arg)) | |
1da177e4 LT |
225 | { |
226 | char *param, *val; | |
227 | ||
f36462f0 | 228 | /* Chew leading spaces */ |
e7d2860b | 229 | args = skip_spaces(args); |
f36462f0 | 230 | |
1ef9eaf2 | 231 | if (*args) |
9fb48c74 JC |
232 | pr_debug("doing %s, parsing ARGS: '%s'\n", doing, args); |
233 | ||
1da177e4 LT |
234 | while (*args) { |
235 | int ret; | |
a416aba6 | 236 | int irq_was_disabled; |
1da177e4 LT |
237 | |
238 | args = next_arg(args, ¶m, &val); | |
51e158c1 RR |
239 | /* Stop at -- */ |
240 | if (!val && strcmp(param, "--") == 0) | |
241 | return args; | |
a416aba6 | 242 | irq_was_disabled = irqs_disabled(); |
9fb48c74 | 243 | ret = parse_one(param, val, doing, params, num, |
ecc86170 | 244 | min_level, max_level, arg, unknown); |
b5f3abf9 JC |
245 | if (irq_was_disabled && !irqs_disabled()) |
246 | pr_warn("%s: option '%s' enabled irq's!\n", | |
247 | doing, param); | |
248 | ||
1da177e4 LT |
249 | switch (ret) { |
250 | case -ENOENT: | |
b5f3abf9 | 251 | pr_err("%s: Unknown parameter `%s'\n", doing, param); |
51e158c1 | 252 | return ERR_PTR(ret); |
1da177e4 | 253 | case -ENOSPC: |
b5f3abf9 | 254 | pr_err("%s: `%s' too large for parameter `%s'\n", |
9fb48c74 | 255 | doing, val ?: "", param); |
51e158c1 | 256 | return ERR_PTR(ret); |
1da177e4 LT |
257 | case 0: |
258 | break; | |
259 | default: | |
b5f3abf9 | 260 | pr_err("%s: `%s' invalid for parameter `%s'\n", |
9fb48c74 | 261 | doing, val ?: "", param); |
51e158c1 | 262 | return ERR_PTR(ret); |
1da177e4 LT |
263 | } |
264 | } | |
265 | ||
266 | /* All parsed OK. */ | |
51e158c1 | 267 | return NULL; |
1da177e4 LT |
268 | } |
269 | ||
270 | /* Lazy bastard, eh? */ | |
88a88b32 | 271 | #define STANDARD_PARAM_DEF(name, type, format, strtolfn) \ |
9bbb9e5a | 272 | int param_set_##name(const char *val, const struct kernel_param *kp) \ |
1da177e4 | 273 | { \ |
88a88b32 | 274 | return strtolfn(val, 0, (type *)kp->arg); \ |
1da177e4 | 275 | } \ |
9bbb9e5a | 276 | int param_get_##name(char *buffer, const struct kernel_param *kp) \ |
1da177e4 | 277 | { \ |
f4940ab7 CG |
278 | return scnprintf(buffer, PAGE_SIZE, format, \ |
279 | *((type *)kp->arg)); \ | |
a14fe249 | 280 | } \ |
9c27847d | 281 | const struct kernel_param_ops param_ops_##name = { \ |
9bbb9e5a RR |
282 | .set = param_set_##name, \ |
283 | .get = param_get_##name, \ | |
284 | }; \ | |
a14fe249 | 285 | EXPORT_SYMBOL(param_set_##name); \ |
9bbb9e5a RR |
286 | EXPORT_SYMBOL(param_get_##name); \ |
287 | EXPORT_SYMBOL(param_ops_##name) | |
288 | ||
1da177e4 | 289 | |
88a88b32 FC |
290 | STANDARD_PARAM_DEF(byte, unsigned char, "%hhu", kstrtou8); |
291 | STANDARD_PARAM_DEF(short, short, "%hi", kstrtos16); | |
292 | STANDARD_PARAM_DEF(ushort, unsigned short, "%hu", kstrtou16); | |
293 | STANDARD_PARAM_DEF(int, int, "%i", kstrtoint); | |
294 | STANDARD_PARAM_DEF(uint, unsigned int, "%u", kstrtouint); | |
295 | STANDARD_PARAM_DEF(long, long, "%li", kstrtol); | |
296 | STANDARD_PARAM_DEF(ulong, unsigned long, "%lu", kstrtoul); | |
b4210b81 | 297 | STANDARD_PARAM_DEF(ullong, unsigned long long, "%llu", kstrtoull); |
1da177e4 | 298 | |
9bbb9e5a | 299 | int param_set_charp(const char *val, const struct kernel_param *kp) |
1da177e4 | 300 | { |
1da177e4 | 301 | if (strlen(val) > 1024) { |
b5f3abf9 | 302 | pr_err("%s: string parameter too long\n", kp->name); |
1da177e4 LT |
303 | return -ENOSPC; |
304 | } | |
305 | ||
a1054322 RR |
306 | maybe_kfree_parameter(*(char **)kp->arg); |
307 | ||
308 | /* This is a hack. We can't kmalloc in early boot, and we | |
e180a6b7 RR |
309 | * don't need to; this mangled commandline is preserved. */ |
310 | if (slab_is_available()) { | |
a1054322 | 311 | *(char **)kp->arg = kmalloc_parameter(strlen(val)+1); |
d553ad86 | 312 | if (!*(char **)kp->arg) |
e180a6b7 | 313 | return -ENOMEM; |
a1054322 | 314 | strcpy(*(char **)kp->arg, val); |
e180a6b7 RR |
315 | } else |
316 | *(const char **)kp->arg = val; | |
317 | ||
1da177e4 LT |
318 | return 0; |
319 | } | |
a14fe249 | 320 | EXPORT_SYMBOL(param_set_charp); |
1da177e4 | 321 | |
9bbb9e5a | 322 | int param_get_charp(char *buffer, const struct kernel_param *kp) |
1da177e4 | 323 | { |
f4940ab7 | 324 | return scnprintf(buffer, PAGE_SIZE, "%s", *((char **)kp->arg)); |
1da177e4 | 325 | } |
a14fe249 | 326 | EXPORT_SYMBOL(param_get_charp); |
1da177e4 | 327 | |
3d9c637f | 328 | void param_free_charp(void *arg) |
a1054322 RR |
329 | { |
330 | maybe_kfree_parameter(*((char **)arg)); | |
331 | } | |
3d9c637f | 332 | EXPORT_SYMBOL(param_free_charp); |
a1054322 | 333 | |
9c27847d | 334 | const struct kernel_param_ops param_ops_charp = { |
9bbb9e5a RR |
335 | .set = param_set_charp, |
336 | .get = param_get_charp, | |
a1054322 | 337 | .free = param_free_charp, |
9bbb9e5a RR |
338 | }; |
339 | EXPORT_SYMBOL(param_ops_charp); | |
340 | ||
fddd5201 | 341 | /* Actually could be a bool or an int, for historical reasons. */ |
9bbb9e5a | 342 | int param_set_bool(const char *val, const struct kernel_param *kp) |
1da177e4 LT |
343 | { |
344 | /* No equals means "set"... */ | |
345 | if (!val) val = "1"; | |
346 | ||
347 | /* One of =[yYnN01] */ | |
8b825281 | 348 | return strtobool(val, kp->arg); |
1da177e4 | 349 | } |
a14fe249 | 350 | EXPORT_SYMBOL(param_set_bool); |
1da177e4 | 351 | |
9bbb9e5a | 352 | int param_get_bool(char *buffer, const struct kernel_param *kp) |
1da177e4 LT |
353 | { |
354 | /* Y and N chosen as being relatively non-coder friendly */ | |
8b825281 | 355 | return sprintf(buffer, "%c", *(bool *)kp->arg ? 'Y' : 'N'); |
1da177e4 | 356 | } |
a14fe249 | 357 | EXPORT_SYMBOL(param_get_bool); |
1da177e4 | 358 | |
9c27847d | 359 | const struct kernel_param_ops param_ops_bool = { |
6a4c2643 | 360 | .flags = KERNEL_PARAM_OPS_FL_NOARG, |
9bbb9e5a RR |
361 | .set = param_set_bool, |
362 | .get = param_get_bool, | |
363 | }; | |
364 | EXPORT_SYMBOL(param_ops_bool); | |
365 | ||
d19f05d8 LR |
366 | int param_set_bool_enable_only(const char *val, const struct kernel_param *kp) |
367 | { | |
368 | int err = 0; | |
369 | bool new_value; | |
370 | bool orig_value = *(bool *)kp->arg; | |
371 | struct kernel_param dummy_kp = *kp; | |
372 | ||
373 | dummy_kp.arg = &new_value; | |
374 | ||
375 | err = param_set_bool(val, &dummy_kp); | |
376 | if (err) | |
377 | return err; | |
378 | ||
379 | /* Don't let them unset it once it's set! */ | |
380 | if (!new_value && orig_value) | |
381 | return -EROFS; | |
382 | ||
383 | if (new_value) | |
384 | err = param_set_bool(val, kp); | |
385 | ||
386 | return err; | |
387 | } | |
388 | EXPORT_SYMBOL_GPL(param_set_bool_enable_only); | |
389 | ||
390 | const struct kernel_param_ops param_ops_bool_enable_only = { | |
391 | .flags = KERNEL_PARAM_OPS_FL_NOARG, | |
392 | .set = param_set_bool_enable_only, | |
393 | .get = param_get_bool, | |
394 | }; | |
154be21c | 395 | EXPORT_SYMBOL_GPL(param_ops_bool_enable_only); |
d19f05d8 | 396 | |
fddd5201 | 397 | /* This one must be bool. */ |
9bbb9e5a | 398 | int param_set_invbool(const char *val, const struct kernel_param *kp) |
1da177e4 | 399 | { |
fddd5201 RR |
400 | int ret; |
401 | bool boolval; | |
22e48eaf | 402 | struct kernel_param dummy; |
1da177e4 | 403 | |
22e48eaf | 404 | dummy.arg = &boolval; |
1da177e4 LT |
405 | ret = param_set_bool(val, &dummy); |
406 | if (ret == 0) | |
9a71af2c | 407 | *(bool *)kp->arg = !boolval; |
1da177e4 LT |
408 | return ret; |
409 | } | |
a14fe249 | 410 | EXPORT_SYMBOL(param_set_invbool); |
1da177e4 | 411 | |
9bbb9e5a | 412 | int param_get_invbool(char *buffer, const struct kernel_param *kp) |
1da177e4 | 413 | { |
9a71af2c | 414 | return sprintf(buffer, "%c", (*(bool *)kp->arg) ? 'N' : 'Y'); |
1da177e4 | 415 | } |
a14fe249 | 416 | EXPORT_SYMBOL(param_get_invbool); |
1da177e4 | 417 | |
9c27847d | 418 | const struct kernel_param_ops param_ops_invbool = { |
9bbb9e5a RR |
419 | .set = param_set_invbool, |
420 | .get = param_get_invbool, | |
421 | }; | |
422 | EXPORT_SYMBOL(param_ops_invbool); | |
423 | ||
69116f27 RR |
424 | int param_set_bint(const char *val, const struct kernel_param *kp) |
425 | { | |
5104b7d7 DS |
426 | /* Match bool exactly, by re-using it. */ |
427 | struct kernel_param boolkp = *kp; | |
69116f27 RR |
428 | bool v; |
429 | int ret; | |
430 | ||
69116f27 | 431 | boolkp.arg = &v; |
69116f27 RR |
432 | |
433 | ret = param_set_bool(val, &boolkp); | |
434 | if (ret == 0) | |
435 | *(int *)kp->arg = v; | |
436 | return ret; | |
437 | } | |
438 | EXPORT_SYMBOL(param_set_bint); | |
439 | ||
9c27847d | 440 | const struct kernel_param_ops param_ops_bint = { |
6a4c2643 | 441 | .flags = KERNEL_PARAM_OPS_FL_NOARG, |
69116f27 RR |
442 | .set = param_set_bint, |
443 | .get = param_get_int, | |
444 | }; | |
445 | EXPORT_SYMBOL(param_ops_bint); | |
446 | ||
9730b5b0 | 447 | /* We break the rule and mangle the string. */ |
b51d23e4 DS |
448 | static int param_array(struct module *mod, |
449 | const char *name, | |
9871728b AB |
450 | const char *val, |
451 | unsigned int min, unsigned int max, | |
452 | void *elem, int elemsize, | |
9bbb9e5a | 453 | int (*set)(const char *, const struct kernel_param *kp), |
026cee00 | 454 | s16 level, |
eb38a996 | 455 | unsigned int *num) |
1da177e4 LT |
456 | { |
457 | int ret; | |
458 | struct kernel_param kp; | |
459 | char save; | |
460 | ||
461 | /* Get the name right for errors. */ | |
462 | kp.name = name; | |
463 | kp.arg = elem; | |
026cee00 | 464 | kp.level = level; |
1da177e4 | 465 | |
1da177e4 LT |
466 | *num = 0; |
467 | /* We expect a comma-separated list of values. */ | |
468 | do { | |
469 | int len; | |
470 | ||
471 | if (*num == max) { | |
b5f3abf9 | 472 | pr_err("%s: can only take %i arguments\n", name, max); |
1da177e4 LT |
473 | return -EINVAL; |
474 | } | |
475 | len = strcspn(val, ","); | |
476 | ||
477 | /* nul-terminate and parse */ | |
478 | save = val[len]; | |
479 | ((char *)val)[len] = '\0'; | |
cf2fde7b | 480 | check_kparam_locked(mod); |
1da177e4 LT |
481 | ret = set(val, &kp); |
482 | ||
483 | if (ret != 0) | |
484 | return ret; | |
485 | kp.arg += elemsize; | |
486 | val += len+1; | |
487 | (*num)++; | |
488 | } while (save == ','); | |
489 | ||
490 | if (*num < min) { | |
b5f3abf9 | 491 | pr_err("%s: needs at least %i arguments\n", name, min); |
1da177e4 LT |
492 | return -EINVAL; |
493 | } | |
494 | return 0; | |
495 | } | |
496 | ||
9bbb9e5a | 497 | static int param_array_set(const char *val, const struct kernel_param *kp) |
1da177e4 | 498 | { |
22e48eaf | 499 | const struct kparam_array *arr = kp->arr; |
31143a12 | 500 | unsigned int temp_num; |
1da177e4 | 501 | |
b51d23e4 | 502 | return param_array(kp->mod, kp->name, val, 1, arr->max, arr->elem, |
026cee00 | 503 | arr->elemsize, arr->ops->set, kp->level, |
3c7d76e3 | 504 | arr->num ?: &temp_num); |
1da177e4 LT |
505 | } |
506 | ||
9bbb9e5a | 507 | static int param_array_get(char *buffer, const struct kernel_param *kp) |
1da177e4 LT |
508 | { |
509 | int i, off, ret; | |
22e48eaf | 510 | const struct kparam_array *arr = kp->arr; |
5104b7d7 | 511 | struct kernel_param p = *kp; |
1da177e4 | 512 | |
1da177e4 LT |
513 | for (i = off = 0; i < (arr->num ? *arr->num : arr->max); i++) { |
514 | if (i) | |
515 | buffer[off++] = ','; | |
516 | p.arg = arr->elem + arr->elemsize * i; | |
cf2fde7b | 517 | check_kparam_locked(p.mod); |
9bbb9e5a | 518 | ret = arr->ops->get(buffer + off, &p); |
1da177e4 LT |
519 | if (ret < 0) |
520 | return ret; | |
521 | off += ret; | |
522 | } | |
523 | buffer[off] = '\0'; | |
524 | return off; | |
525 | } | |
526 | ||
e6df34a4 RR |
527 | static void param_array_free(void *arg) |
528 | { | |
529 | unsigned int i; | |
530 | const struct kparam_array *arr = arg; | |
531 | ||
532 | if (arr->ops->free) | |
533 | for (i = 0; i < (arr->num ? *arr->num : arr->max); i++) | |
534 | arr->ops->free(arr->elem + arr->elemsize * i); | |
535 | } | |
536 | ||
9c27847d | 537 | const struct kernel_param_ops param_array_ops = { |
9bbb9e5a RR |
538 | .set = param_array_set, |
539 | .get = param_array_get, | |
e6df34a4 | 540 | .free = param_array_free, |
9bbb9e5a RR |
541 | }; |
542 | EXPORT_SYMBOL(param_array_ops); | |
543 | ||
544 | int param_set_copystring(const char *val, const struct kernel_param *kp) | |
1da177e4 | 545 | { |
22e48eaf | 546 | const struct kparam_string *kps = kp->str; |
1da177e4 LT |
547 | |
548 | if (strlen(val)+1 > kps->maxlen) { | |
b5f3abf9 | 549 | pr_err("%s: string doesn't fit in %u chars.\n", |
1da177e4 LT |
550 | kp->name, kps->maxlen-1); |
551 | return -ENOSPC; | |
552 | } | |
553 | strcpy(kps->string, val); | |
554 | return 0; | |
555 | } | |
a14fe249 | 556 | EXPORT_SYMBOL(param_set_copystring); |
1da177e4 | 557 | |
9bbb9e5a | 558 | int param_get_string(char *buffer, const struct kernel_param *kp) |
1da177e4 | 559 | { |
22e48eaf | 560 | const struct kparam_string *kps = kp->str; |
1da177e4 LT |
561 | return strlcpy(buffer, kps->string, kps->maxlen); |
562 | } | |
a14fe249 | 563 | EXPORT_SYMBOL(param_get_string); |
1da177e4 | 564 | |
9c27847d | 565 | const struct kernel_param_ops param_ops_string = { |
9bbb9e5a RR |
566 | .set = param_set_copystring, |
567 | .get = param_get_string, | |
568 | }; | |
569 | EXPORT_SYMBOL(param_ops_string); | |
570 | ||
1da177e4 | 571 | /* sysfs output in /sys/modules/XYZ/parameters/ */ |
350f8258 EY |
572 | #define to_module_attr(n) container_of(n, struct module_attribute, attr) |
573 | #define to_module_kobject(n) container_of(n, struct module_kobject, kobj) | |
1da177e4 | 574 | |
1da177e4 LT |
575 | struct param_attribute |
576 | { | |
577 | struct module_attribute mattr; | |
9bbb9e5a | 578 | const struct kernel_param *param; |
1da177e4 LT |
579 | }; |
580 | ||
581 | struct module_param_attrs | |
582 | { | |
9b473de8 | 583 | unsigned int num; |
1da177e4 LT |
584 | struct attribute_group grp; |
585 | struct param_attribute attrs[0]; | |
586 | }; | |
587 | ||
ef665c1a | 588 | #ifdef CONFIG_SYSFS |
350f8258 | 589 | #define to_param_attr(n) container_of(n, struct param_attribute, mattr) |
1da177e4 LT |
590 | |
591 | static ssize_t param_attr_show(struct module_attribute *mattr, | |
4befb026 | 592 | struct module_kobject *mk, char *buf) |
1da177e4 LT |
593 | { |
594 | int count; | |
595 | struct param_attribute *attribute = to_param_attr(mattr); | |
596 | ||
9bbb9e5a | 597 | if (!attribute->param->ops->get) |
1da177e4 LT |
598 | return -EPERM; |
599 | ||
b51d23e4 | 600 | kernel_param_lock(mk->mod); |
9bbb9e5a | 601 | count = attribute->param->ops->get(buf, attribute->param); |
b51d23e4 | 602 | kernel_param_unlock(mk->mod); |
1da177e4 LT |
603 | if (count > 0) { |
604 | strcat(buf, "\n"); | |
605 | ++count; | |
606 | } | |
607 | return count; | |
608 | } | |
609 | ||
610 | /* sysfs always hands a nul-terminated string in buf. We rely on that. */ | |
611 | static ssize_t param_attr_store(struct module_attribute *mattr, | |
b51d23e4 | 612 | struct module_kobject *mk, |
1da177e4 LT |
613 | const char *buf, size_t len) |
614 | { | |
615 | int err; | |
616 | struct param_attribute *attribute = to_param_attr(mattr); | |
617 | ||
9bbb9e5a | 618 | if (!attribute->param->ops->set) |
1da177e4 LT |
619 | return -EPERM; |
620 | ||
b51d23e4 | 621 | kernel_param_lock(mk->mod); |
7a486d37 | 622 | param_check_unsafe(attribute->param); |
9bbb9e5a | 623 | err = attribute->param->ops->set(buf, attribute->param); |
b51d23e4 | 624 | kernel_param_unlock(mk->mod); |
1da177e4 LT |
625 | if (!err) |
626 | return len; | |
627 | return err; | |
628 | } | |
ef665c1a | 629 | #endif |
1da177e4 LT |
630 | |
631 | #ifdef CONFIG_MODULES | |
632 | #define __modinit | |
633 | #else | |
634 | #define __modinit __init | |
635 | #endif | |
636 | ||
ef665c1a | 637 | #ifdef CONFIG_SYSFS |
b51d23e4 | 638 | void kernel_param_lock(struct module *mod) |
907b29eb | 639 | { |
b51d23e4 | 640 | mutex_lock(KPARAM_MUTEX(mod)); |
907b29eb | 641 | } |
907b29eb | 642 | |
b51d23e4 | 643 | void kernel_param_unlock(struct module *mod) |
907b29eb | 644 | { |
b51d23e4 | 645 | mutex_unlock(KPARAM_MUTEX(mod)); |
907b29eb | 646 | } |
b51d23e4 | 647 | |
b51d23e4 DS |
648 | EXPORT_SYMBOL(kernel_param_lock); |
649 | EXPORT_SYMBOL(kernel_param_unlock); | |
907b29eb | 650 | |
1da177e4 | 651 | /* |
9b473de8 RR |
652 | * add_sysfs_param - add a parameter to sysfs |
653 | * @mk: struct module_kobject | |
654 | * @kparam: the actual parameter definition to add to sysfs | |
655 | * @name: name of parameter | |
1da177e4 | 656 | * |
9b473de8 RR |
657 | * Create a kobject if for a (per-module) parameter if mp NULL, and |
658 | * create file in sysfs. Returns an error on out of memory. Always cleans up | |
659 | * if there's an error. | |
1da177e4 | 660 | */ |
9b473de8 | 661 | static __modinit int add_sysfs_param(struct module_kobject *mk, |
9bbb9e5a | 662 | const struct kernel_param *kp, |
9b473de8 | 663 | const char *name) |
1da177e4 | 664 | { |
18eb74fa RR |
665 | struct module_param_attrs *new_mp; |
666 | struct attribute **new_attrs; | |
667 | unsigned int i; | |
9b473de8 RR |
668 | |
669 | /* We don't bother calling this with invisible parameters. */ | |
670 | BUG_ON(!kp->perm); | |
671 | ||
672 | if (!mk->mp) { | |
18eb74fa RR |
673 | /* First allocation. */ |
674 | mk->mp = kzalloc(sizeof(*mk->mp), GFP_KERNEL); | |
675 | if (!mk->mp) | |
676 | return -ENOMEM; | |
677 | mk->mp->grp.name = "parameters"; | |
678 | /* NULL-terminated attribute array. */ | |
679 | mk->mp->grp.attrs = kzalloc(sizeof(mk->mp->grp.attrs[0]), | |
680 | GFP_KERNEL); | |
681 | /* Caller will cleanup via free_module_param_attrs */ | |
682 | if (!mk->mp->grp.attrs) | |
683 | return -ENOMEM; | |
9b473de8 | 684 | } |
1da177e4 | 685 | |
18eb74fa RR |
686 | /* Enlarge allocations. */ |
687 | new_mp = krealloc(mk->mp, | |
688 | sizeof(*mk->mp) + | |
689 | sizeof(mk->mp->attrs[0]) * (mk->mp->num + 1), | |
690 | GFP_KERNEL); | |
691 | if (!new_mp) | |
692 | return -ENOMEM; | |
693 | mk->mp = new_mp; | |
694 | ||
695 | /* Extra pointer for NULL terminator */ | |
696 | new_attrs = krealloc(mk->mp->grp.attrs, | |
697 | sizeof(mk->mp->grp.attrs[0]) * (mk->mp->num + 2), | |
698 | GFP_KERNEL); | |
699 | if (!new_attrs) | |
700 | return -ENOMEM; | |
701 | mk->mp->grp.attrs = new_attrs; | |
9b473de8 RR |
702 | |
703 | /* Tack new one on the end. */ | |
c772be52 | 704 | memset(&mk->mp->attrs[mk->mp->num], 0, sizeof(mk->mp->attrs[0])); |
18eb74fa RR |
705 | sysfs_attr_init(&mk->mp->attrs[mk->mp->num].mattr.attr); |
706 | mk->mp->attrs[mk->mp->num].param = kp; | |
707 | mk->mp->attrs[mk->mp->num].mattr.show = param_attr_show; | |
b0a65b0c KC |
708 | /* Do not allow runtime DAC changes to make param writable. */ |
709 | if ((kp->perm & (S_IWUSR | S_IWGRP | S_IWOTH)) != 0) | |
710 | mk->mp->attrs[mk->mp->num].mattr.store = param_attr_store; | |
574732c7 RR |
711 | else |
712 | mk->mp->attrs[mk->mp->num].mattr.store = NULL; | |
18eb74fa RR |
713 | mk->mp->attrs[mk->mp->num].mattr.attr.name = (char *)name; |
714 | mk->mp->attrs[mk->mp->num].mattr.attr.mode = kp->perm; | |
715 | mk->mp->num++; | |
9b473de8 RR |
716 | |
717 | /* Fix up all the pointers, since krealloc can move us */ | |
18eb74fa RR |
718 | for (i = 0; i < mk->mp->num; i++) |
719 | mk->mp->grp.attrs[i] = &mk->mp->attrs[i].mattr.attr; | |
720 | mk->mp->grp.attrs[mk->mp->num] = NULL; | |
9b473de8 | 721 | return 0; |
9b473de8 | 722 | } |
1da177e4 | 723 | |
d2441183 | 724 | #ifdef CONFIG_MODULES |
9b473de8 RR |
725 | static void free_module_param_attrs(struct module_kobject *mk) |
726 | { | |
18eb74fa RR |
727 | if (mk->mp) |
728 | kfree(mk->mp->grp.attrs); | |
9b473de8 RR |
729 | kfree(mk->mp); |
730 | mk->mp = NULL; | |
1da177e4 LT |
731 | } |
732 | ||
1da177e4 LT |
733 | /* |
734 | * module_param_sysfs_setup - setup sysfs support for one module | |
735 | * @mod: module | |
736 | * @kparam: module parameters (array) | |
737 | * @num_params: number of module parameters | |
738 | * | |
9b473de8 RR |
739 | * Adds sysfs entries for module parameters under |
740 | * /sys/module/[mod->name]/parameters/ | |
1da177e4 LT |
741 | */ |
742 | int module_param_sysfs_setup(struct module *mod, | |
9bbb9e5a | 743 | const struct kernel_param *kparam, |
1da177e4 LT |
744 | unsigned int num_params) |
745 | { | |
9b473de8 RR |
746 | int i, err; |
747 | bool params = false; | |
748 | ||
749 | for (i = 0; i < num_params; i++) { | |
750 | if (kparam[i].perm == 0) | |
751 | continue; | |
752 | err = add_sysfs_param(&mod->mkobj, &kparam[i], kparam[i].name); | |
18eb74fa RR |
753 | if (err) { |
754 | free_module_param_attrs(&mod->mkobj); | |
9b473de8 | 755 | return err; |
18eb74fa | 756 | } |
9b473de8 RR |
757 | params = true; |
758 | } | |
1da177e4 | 759 | |
9b473de8 RR |
760 | if (!params) |
761 | return 0; | |
1da177e4 | 762 | |
9b473de8 RR |
763 | /* Create the param group. */ |
764 | err = sysfs_create_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp); | |
765 | if (err) | |
766 | free_module_param_attrs(&mod->mkobj); | |
767 | return err; | |
1da177e4 LT |
768 | } |
769 | ||
770 | /* | |
771 | * module_param_sysfs_remove - remove sysfs support for one module | |
772 | * @mod: module | |
773 | * | |
774 | * Remove sysfs entries for module parameters and the corresponding | |
775 | * kobject. | |
776 | */ | |
777 | void module_param_sysfs_remove(struct module *mod) | |
778 | { | |
9b473de8 RR |
779 | if (mod->mkobj.mp) { |
780 | sysfs_remove_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp); | |
1da177e4 LT |
781 | /* We are positive that no one is using any param |
782 | * attrs at this point. Deallocate immediately. */ | |
9b473de8 | 783 | free_module_param_attrs(&mod->mkobj); |
1da177e4 LT |
784 | } |
785 | } | |
786 | #endif | |
787 | ||
e180a6b7 RR |
788 | void destroy_params(const struct kernel_param *params, unsigned num) |
789 | { | |
e6df34a4 RR |
790 | unsigned int i; |
791 | ||
792 | for (i = 0; i < num; i++) | |
793 | if (params[i].ops->free) | |
794 | params[i].ops->free(params[i].arg); | |
e180a6b7 RR |
795 | } |
796 | ||
e94965ed | 797 | static struct module_kobject * __init locate_module_kobject(const char *name) |
1da177e4 LT |
798 | { |
799 | struct module_kobject *mk; | |
9b473de8 RR |
800 | struct kobject *kobj; |
801 | int err; | |
1da177e4 | 802 | |
9b473de8 RR |
803 | kobj = kset_find_obj(module_kset, name); |
804 | if (kobj) { | |
9b473de8 | 805 | mk = to_module_kobject(kobj); |
9b473de8 RR |
806 | } else { |
807 | mk = kzalloc(sizeof(struct module_kobject), GFP_KERNEL); | |
808 | BUG_ON(!mk); | |
809 | ||
810 | mk->mod = THIS_MODULE; | |
811 | mk->kobj.kset = module_kset; | |
812 | err = kobject_init_and_add(&mk->kobj, &module_ktype, NULL, | |
813 | "%s", name); | |
88bfa324 KS |
814 | #ifdef CONFIG_MODULES |
815 | if (!err) | |
816 | err = sysfs_create_file(&mk->kobj, &module_uevent.attr); | |
817 | #endif | |
9b473de8 RR |
818 | if (err) { |
819 | kobject_put(&mk->kobj); | |
b5f3abf9 | 820 | pr_crit("Adding module '%s' to sysfs failed (%d), the system may be unstable.\n", |
e94965ed | 821 | name, err); |
e94965ed | 822 | return NULL; |
9b473de8 | 823 | } |
e94965ed DT |
824 | |
825 | /* So that we hold reference in both cases. */ | |
9b473de8 | 826 | kobject_get(&mk->kobj); |
74c5b597 | 827 | } |
9b473de8 | 828 | |
e94965ed DT |
829 | return mk; |
830 | } | |
831 | ||
832 | static void __init kernel_add_sysfs_param(const char *name, | |
63a12d9d | 833 | const struct kernel_param *kparam, |
e94965ed DT |
834 | unsigned int name_skip) |
835 | { | |
836 | struct module_kobject *mk; | |
837 | int err; | |
838 | ||
839 | mk = locate_module_kobject(name); | |
840 | if (!mk) | |
841 | return; | |
842 | ||
843 | /* We need to remove old parameters before adding more. */ | |
844 | if (mk->mp) | |
845 | sysfs_remove_group(&mk->kobj, &mk->mp->grp); | |
846 | ||
9b473de8 RR |
847 | /* These should not fail at boot. */ |
848 | err = add_sysfs_param(mk, kparam, kparam->name + name_skip); | |
849 | BUG_ON(err); | |
850 | err = sysfs_create_group(&mk->kobj, &mk->mp->grp); | |
851 | BUG_ON(err); | |
f30c53a8 | 852 | kobject_uevent(&mk->kobj, KOBJ_ADD); |
9b473de8 | 853 | kobject_put(&mk->kobj); |
1da177e4 LT |
854 | } |
855 | ||
856 | /* | |
b634d130 | 857 | * param_sysfs_builtin - add sysfs parameters for built-in modules |
1da177e4 LT |
858 | * |
859 | * Add module_parameters to sysfs for "modules" built into the kernel. | |
860 | * | |
861 | * The "module" name (KBUILD_MODNAME) is stored before a dot, the | |
862 | * "parameter" name is stored behind a dot in kernel_param->name. So, | |
863 | * extract the "module" name for all built-in kernel_param-eters, | |
9b473de8 | 864 | * and for all who have the same, call kernel_add_sysfs_param. |
1da177e4 LT |
865 | */ |
866 | static void __init param_sysfs_builtin(void) | |
867 | { | |
63a12d9d | 868 | const struct kernel_param *kp; |
9b473de8 RR |
869 | unsigned int name_len; |
870 | char modname[MODULE_NAME_LEN]; | |
1da177e4 | 871 | |
9b473de8 | 872 | for (kp = __start___param; kp < __stop___param; kp++) { |
1da177e4 LT |
873 | char *dot; |
874 | ||
9b473de8 RR |
875 | if (kp->perm == 0) |
876 | continue; | |
1da177e4 | 877 | |
730b69d2 | 878 | dot = strchr(kp->name, '.'); |
1da177e4 | 879 | if (!dot) { |
67e67cea RR |
880 | /* This happens for core_param() */ |
881 | strcpy(modname, "kernel"); | |
882 | name_len = 0; | |
883 | } else { | |
884 | name_len = dot - kp->name + 1; | |
885 | strlcpy(modname, kp->name, name_len); | |
1da177e4 | 886 | } |
67e67cea | 887 | kernel_add_sysfs_param(modname, kp, name_len); |
1da177e4 | 888 | } |
1da177e4 LT |
889 | } |
890 | ||
e94965ed | 891 | ssize_t __modver_version_show(struct module_attribute *mattr, |
4befb026 | 892 | struct module_kobject *mk, char *buf) |
e94965ed DT |
893 | { |
894 | struct module_version_attribute *vattr = | |
895 | container_of(mattr, struct module_version_attribute, mattr); | |
896 | ||
f4940ab7 | 897 | return scnprintf(buf, PAGE_SIZE, "%s\n", vattr->version); |
e94965ed DT |
898 | } |
899 | ||
b4bc8428 DT |
900 | extern const struct module_version_attribute *__start___modver[]; |
901 | extern const struct module_version_attribute *__stop___modver[]; | |
e94965ed DT |
902 | |
903 | static void __init version_sysfs_builtin(void) | |
904 | { | |
b4bc8428 | 905 | const struct module_version_attribute **p; |
e94965ed DT |
906 | struct module_kobject *mk; |
907 | int err; | |
908 | ||
b4bc8428 DT |
909 | for (p = __start___modver; p < __stop___modver; p++) { |
910 | const struct module_version_attribute *vattr = *p; | |
911 | ||
e94965ed DT |
912 | mk = locate_module_kobject(vattr->module_name); |
913 | if (mk) { | |
914 | err = sysfs_create_file(&mk->kobj, &vattr->mattr.attr); | |
74c3dea3 | 915 | WARN_ON_ONCE(err); |
e94965ed DT |
916 | kobject_uevent(&mk->kobj, KOBJ_ADD); |
917 | kobject_put(&mk->kobj); | |
918 | } | |
919 | } | |
920 | } | |
1da177e4 LT |
921 | |
922 | /* module-related sysfs stuff */ | |
1da177e4 | 923 | |
1da177e4 LT |
924 | static ssize_t module_attr_show(struct kobject *kobj, |
925 | struct attribute *attr, | |
926 | char *buf) | |
927 | { | |
928 | struct module_attribute *attribute; | |
929 | struct module_kobject *mk; | |
930 | int ret; | |
931 | ||
932 | attribute = to_module_attr(attr); | |
933 | mk = to_module_kobject(kobj); | |
934 | ||
935 | if (!attribute->show) | |
70f2817a | 936 | return -EIO; |
1da177e4 | 937 | |
4befb026 | 938 | ret = attribute->show(attribute, mk, buf); |
1da177e4 | 939 | |
1da177e4 LT |
940 | return ret; |
941 | } | |
942 | ||
943 | static ssize_t module_attr_store(struct kobject *kobj, | |
944 | struct attribute *attr, | |
945 | const char *buf, size_t len) | |
946 | { | |
947 | struct module_attribute *attribute; | |
948 | struct module_kobject *mk; | |
949 | int ret; | |
950 | ||
951 | attribute = to_module_attr(attr); | |
952 | mk = to_module_kobject(kobj); | |
953 | ||
954 | if (!attribute->store) | |
70f2817a | 955 | return -EIO; |
1da177e4 | 956 | |
4befb026 | 957 | ret = attribute->store(attribute, mk, buf, len); |
1da177e4 | 958 | |
1da177e4 LT |
959 | return ret; |
960 | } | |
961 | ||
52cf25d0 | 962 | static const struct sysfs_ops module_sysfs_ops = { |
1da177e4 LT |
963 | .show = module_attr_show, |
964 | .store = module_attr_store, | |
965 | }; | |
966 | ||
270a6c4c KS |
967 | static int uevent_filter(struct kset *kset, struct kobject *kobj) |
968 | { | |
969 | struct kobj_type *ktype = get_ktype(kobj); | |
970 | ||
971 | if (ktype == &module_ktype) | |
972 | return 1; | |
973 | return 0; | |
974 | } | |
975 | ||
9cd43611 | 976 | static const struct kset_uevent_ops module_uevent_ops = { |
270a6c4c KS |
977 | .filter = uevent_filter, |
978 | }; | |
979 | ||
7405c1e1 | 980 | struct kset *module_kset; |
823bccfc | 981 | int module_sysfs_initialized; |
1da177e4 | 982 | |
942e4431 LZ |
983 | static void module_kobj_release(struct kobject *kobj) |
984 | { | |
985 | struct module_kobject *mk = to_module_kobject(kobj); | |
986 | complete(mk->kobj_completion); | |
987 | } | |
988 | ||
7405c1e1 | 989 | struct kobj_type module_ktype = { |
942e4431 | 990 | .release = module_kobj_release, |
1da177e4 LT |
991 | .sysfs_ops = &module_sysfs_ops, |
992 | }; | |
993 | ||
1da177e4 LT |
994 | /* |
995 | * param_sysfs_init - wrapper for built-in params support | |
996 | */ | |
997 | static int __init param_sysfs_init(void) | |
998 | { | |
7405c1e1 GKH |
999 | module_kset = kset_create_and_add("module", &module_uevent_ops, NULL); |
1000 | if (!module_kset) { | |
1001 | printk(KERN_WARNING "%s (%d): error creating kset\n", | |
1002 | __FILE__, __LINE__); | |
1003 | return -ENOMEM; | |
d8c7649e | 1004 | } |
823bccfc | 1005 | module_sysfs_initialized = 1; |
1da177e4 | 1006 | |
e94965ed | 1007 | version_sysfs_builtin(); |
1da177e4 LT |
1008 | param_sysfs_builtin(); |
1009 | ||
1010 | return 0; | |
1011 | } | |
d10be6d1 | 1012 | subsys_initcall(param_sysfs_init); |
1da177e4 | 1013 | |
7405c1e1 | 1014 | #endif /* CONFIG_SYSFS */ |