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