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