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