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