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