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