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