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