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