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