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