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