param: move the EXPORT_SYMBOL to after the definitions.
[linux-flexiantxendom0-3.2.10.git] / kernel / params.c
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 */
18 #include <linux/moduleparam.h>
19 #include <linux/kernel.h>
20 #include <linux/string.h>
21 #include <linux/errno.h>
22 #include <linux/module.h>
23 #include <linux/device.h>
24 #include <linux/err.h>
25 #include <linux/slab.h>
26 #include <linux/ctype.h>
27
28 #if 0
29 #define DEBUGP printk
30 #else
31 #define DEBUGP(fmt, a...)
32 #endif
33
34 static inline char dash2underscore(char c)
35 {
36         if (c == '-')
37                 return '_';
38         return c;
39 }
40
41 static inline int parameq(const char *input, const char *paramname)
42 {
43         unsigned int i;
44         for (i = 0; dash2underscore(input[i]) == paramname[i]; i++)
45                 if (input[i] == '\0')
46                         return 1;
47         return 0;
48 }
49
50 static int parse_one(char *param,
51                      char *val,
52                      struct kernel_param *params, 
53                      unsigned num_params,
54                      int (*handle_unknown)(char *param, char *val))
55 {
56         unsigned int i;
57
58         /* Find parameter */
59         for (i = 0; i < num_params; i++) {
60                 if (parameq(param, params[i].name)) {
61                         /* Noone handled NULL, so do it here. */
62                         if (!val && params[i].set != param_set_bool)
63                                 return -EINVAL;
64                         DEBUGP("They are equal!  Calling %p\n",
65                                params[i].set);
66                         return params[i].set(val, &params[i]);
67                 }
68         }
69
70         if (handle_unknown) {
71                 DEBUGP("Unknown argument: calling %p\n", handle_unknown);
72                 return handle_unknown(param, val);
73         }
74
75         DEBUGP("Unknown argument `%s'\n", param);
76         return -ENOENT;
77 }
78
79 /* You can use " around spaces, but can't escape ". */
80 /* Hyphens and underscores equivalent in parameter names. */
81 static char *next_arg(char *args, char **param, char **val)
82 {
83         unsigned int i, equals = 0;
84         int in_quote = 0, quoted = 0;
85         char *next;
86
87         if (*args == '"') {
88                 args++;
89                 in_quote = 1;
90                 quoted = 1;
91         }
92
93         for (i = 0; args[i]; i++) {
94                 if (isspace(args[i]) && !in_quote)
95                         break;
96                 if (equals == 0) {
97                         if (args[i] == '=')
98                                 equals = i;
99                 }
100                 if (args[i] == '"')
101                         in_quote = !in_quote;
102         }
103
104         *param = args;
105         if (!equals)
106                 *val = NULL;
107         else {
108                 args[equals] = '\0';
109                 *val = args + equals + 1;
110
111                 /* Don't include quotes in value. */
112                 if (**val == '"') {
113                         (*val)++;
114                         if (args[i-1] == '"')
115                                 args[i-1] = '\0';
116                 }
117                 if (quoted && args[i-1] == '"')
118                         args[i-1] = '\0';
119         }
120
121         if (args[i]) {
122                 args[i] = '\0';
123                 next = args + i + 1;
124         } else
125                 next = args + i;
126
127         /* Chew up trailing spaces. */
128         return skip_spaces(next);
129 }
130
131 /* Args looks like "foo=bar,bar2 baz=fuz wiz". */
132 int parse_args(const char *name,
133                char *args,
134                struct kernel_param *params,
135                unsigned num,
136                int (*unknown)(char *param, char *val))
137 {
138         char *param, *val;
139
140         DEBUGP("Parsing ARGS: %s\n", args);
141
142         /* Chew leading spaces */
143         args = skip_spaces(args);
144
145         while (*args) {
146                 int ret;
147                 int irq_was_disabled;
148
149                 args = next_arg(args, &param, &val);
150                 irq_was_disabled = irqs_disabled();
151                 ret = parse_one(param, val, params, num, unknown);
152                 if (irq_was_disabled && !irqs_disabled()) {
153                         printk(KERN_WARNING "parse_args(): option '%s' enabled "
154                                         "irq's!\n", param);
155                 }
156                 switch (ret) {
157                 case -ENOENT:
158                         printk(KERN_ERR "%s: Unknown parameter `%s'\n",
159                                name, param);
160                         return ret;
161                 case -ENOSPC:
162                         printk(KERN_ERR
163                                "%s: `%s' too large for parameter `%s'\n",
164                                name, val ?: "", param);
165                         return ret;
166                 case 0:
167                         break;
168                 default:
169                         printk(KERN_ERR
170                                "%s: `%s' invalid for parameter `%s'\n",
171                                name, val ?: "", param);
172                         return ret;
173                 }
174         }
175
176         /* All parsed OK. */
177         return 0;
178 }
179
180 /* Lazy bastard, eh? */
181 #define STANDARD_PARAM_DEF(name, type, format, tmptype, strtolfn)       \
182         int param_set_##name(const char *val, struct kernel_param *kp)  \
183         {                                                               \
184                 tmptype l;                                              \
185                 int ret;                                                \
186                                                                         \
187                 ret = strtolfn(val, 0, &l);                             \
188                 if (ret == -EINVAL || ((type)l != l))                   \
189                         return -EINVAL;                                 \
190                 *((type *)kp->arg) = l;                                 \
191                 return 0;                                               \
192         }                                                               \
193         int param_get_##name(char *buffer, struct kernel_param *kp)     \
194         {                                                               \
195                 return sprintf(buffer, format, *((type *)kp->arg));     \
196         }                                                               \
197         EXPORT_SYMBOL(param_set_##name);                                \
198         EXPORT_SYMBOL(param_get_##name)
199
200 STANDARD_PARAM_DEF(byte, unsigned char, "%c", unsigned long, strict_strtoul);
201 STANDARD_PARAM_DEF(short, short, "%hi", long, strict_strtol);
202 STANDARD_PARAM_DEF(ushort, unsigned short, "%hu", unsigned long, strict_strtoul);
203 STANDARD_PARAM_DEF(int, int, "%i", long, strict_strtol);
204 STANDARD_PARAM_DEF(uint, unsigned int, "%u", unsigned long, strict_strtoul);
205 STANDARD_PARAM_DEF(long, long, "%li", long, strict_strtol);
206 STANDARD_PARAM_DEF(ulong, unsigned long, "%lu", unsigned long, strict_strtoul);
207
208 int param_set_charp(const char *val, struct kernel_param *kp)
209 {
210         if (strlen(val) > 1024) {
211                 printk(KERN_ERR "%s: string parameter too long\n",
212                        kp->name);
213                 return -ENOSPC;
214         }
215
216         /* This is a hack.  We can't need to strdup in early boot, and we
217          * don't need to; this mangled commandline is preserved. */
218         if (slab_is_available()) {
219                 *(char **)kp->arg = kstrdup(val, GFP_KERNEL);
220                 if (!*(char **)kp->arg)
221                         return -ENOMEM;
222         } else
223                 *(const char **)kp->arg = val;
224
225         return 0;
226 }
227 EXPORT_SYMBOL(param_set_charp);
228
229 int param_get_charp(char *buffer, struct kernel_param *kp)
230 {
231         return sprintf(buffer, "%s", *((char **)kp->arg));
232 }
233 EXPORT_SYMBOL(param_get_charp);
234
235 /* Actually could be a bool or an int, for historical reasons. */
236 int param_set_bool(const char *val, struct kernel_param *kp)
237 {
238         bool v;
239
240         /* No equals means "set"... */
241         if (!val) val = "1";
242
243         /* One of =[yYnN01] */
244         switch (val[0]) {
245         case 'y': case 'Y': case '1':
246                 v = true;
247                 break;
248         case 'n': case 'N': case '0':
249                 v = false;
250                 break;
251         default:
252                 return -EINVAL;
253         }
254
255         if (kp->flags & KPARAM_ISBOOL)
256                 *(bool *)kp->arg = v;
257         else
258                 *(int *)kp->arg = v;
259         return 0;
260 }
261 EXPORT_SYMBOL(param_set_bool);
262
263 int param_get_bool(char *buffer, struct kernel_param *kp)
264 {
265         bool val;
266         if (kp->flags & KPARAM_ISBOOL)
267                 val = *(bool *)kp->arg;
268         else
269                 val = *(int *)kp->arg;
270
271         /* Y and N chosen as being relatively non-coder friendly */
272         return sprintf(buffer, "%c", val ? 'Y' : 'N');
273 }
274 EXPORT_SYMBOL(param_get_bool);
275
276 /* This one must be bool. */
277 int param_set_invbool(const char *val, struct kernel_param *kp)
278 {
279         int ret;
280         bool boolval;
281         struct kernel_param dummy;
282
283         dummy.arg = &boolval;
284         dummy.flags = KPARAM_ISBOOL;
285         ret = param_set_bool(val, &dummy);
286         if (ret == 0)
287                 *(bool *)kp->arg = !boolval;
288         return ret;
289 }
290 EXPORT_SYMBOL(param_set_invbool);
291
292 int param_get_invbool(char *buffer, struct kernel_param *kp)
293 {
294         return sprintf(buffer, "%c", (*(bool *)kp->arg) ? 'N' : 'Y');
295 }
296 EXPORT_SYMBOL(param_get_invbool);
297
298 /* We break the rule and mangle the string. */
299 static int param_array(const char *name,
300                        const char *val,
301                        unsigned int min, unsigned int max,
302                        void *elem, int elemsize,
303                        int (*set)(const char *, struct kernel_param *kp),
304                        u16 flags,
305                        unsigned int *num)
306 {
307         int ret;
308         struct kernel_param kp;
309         char save;
310
311         /* Get the name right for errors. */
312         kp.name = name;
313         kp.arg = elem;
314         kp.flags = flags;
315
316         *num = 0;
317         /* We expect a comma-separated list of values. */
318         do {
319                 int len;
320
321                 if (*num == max) {
322                         printk(KERN_ERR "%s: can only take %i arguments\n",
323                                name, max);
324                         return -EINVAL;
325                 }
326                 len = strcspn(val, ",");
327
328                 /* nul-terminate and parse */
329                 save = val[len];
330                 ((char *)val)[len] = '\0';
331                 ret = set(val, &kp);
332
333                 if (ret != 0)
334                         return ret;
335                 kp.arg += elemsize;
336                 val += len+1;
337                 (*num)++;
338         } while (save == ',');
339
340         if (*num < min) {
341                 printk(KERN_ERR "%s: needs at least %i arguments\n",
342                        name, min);
343                 return -EINVAL;
344         }
345         return 0;
346 }
347
348 int param_array_set(const char *val, struct kernel_param *kp)
349 {
350         const struct kparam_array *arr = kp->arr;
351         unsigned int temp_num;
352
353         return param_array(kp->name, val, 1, arr->max, arr->elem,
354                            arr->elemsize, arr->set, kp->flags,
355                            arr->num ?: &temp_num);
356 }
357 EXPORT_SYMBOL(param_array_set);
358
359 int param_array_get(char *buffer, struct kernel_param *kp)
360 {
361         int i, off, ret;
362         const struct kparam_array *arr = kp->arr;
363         struct kernel_param p;
364
365         p = *kp;
366         for (i = off = 0; i < (arr->num ? *arr->num : arr->max); i++) {
367                 if (i)
368                         buffer[off++] = ',';
369                 p.arg = arr->elem + arr->elemsize * i;
370                 ret = arr->get(buffer + off, &p);
371                 if (ret < 0)
372                         return ret;
373                 off += ret;
374         }
375         buffer[off] = '\0';
376         return off;
377 }
378 EXPORT_SYMBOL(param_array_get);
379
380 int param_set_copystring(const char *val, struct kernel_param *kp)
381 {
382         const struct kparam_string *kps = kp->str;
383
384         if (strlen(val)+1 > kps->maxlen) {
385                 printk(KERN_ERR "%s: string doesn't fit in %u chars.\n",
386                        kp->name, kps->maxlen-1);
387                 return -ENOSPC;
388         }
389         strcpy(kps->string, val);
390         return 0;
391 }
392 EXPORT_SYMBOL(param_set_copystring);
393
394 int param_get_string(char *buffer, struct kernel_param *kp)
395 {
396         const struct kparam_string *kps = kp->str;
397         return strlcpy(buffer, kps->string, kps->maxlen);
398 }
399 EXPORT_SYMBOL(param_get_string);
400
401 /* sysfs output in /sys/modules/XYZ/parameters/ */
402 #define to_module_attr(n) container_of(n, struct module_attribute, attr)
403 #define to_module_kobject(n) container_of(n, struct module_kobject, kobj)
404
405 extern struct kernel_param __start___param[], __stop___param[];
406
407 struct param_attribute
408 {
409         struct module_attribute mattr;
410         struct kernel_param *param;
411 };
412
413 struct module_param_attrs
414 {
415         unsigned int num;
416         struct attribute_group grp;
417         struct param_attribute attrs[0];
418 };
419
420 #ifdef CONFIG_SYSFS
421 #define to_param_attr(n) container_of(n, struct param_attribute, mattr)
422
423 static ssize_t param_attr_show(struct module_attribute *mattr,
424                                struct module *mod, char *buf)
425 {
426         int count;
427         struct param_attribute *attribute = to_param_attr(mattr);
428
429         if (!attribute->param->get)
430                 return -EPERM;
431
432         count = attribute->param->get(buf, attribute->param);
433         if (count > 0) {
434                 strcat(buf, "\n");
435                 ++count;
436         }
437         return count;
438 }
439
440 /* sysfs always hands a nul-terminated string in buf.  We rely on that. */
441 static ssize_t param_attr_store(struct module_attribute *mattr,
442                                 struct module *owner,
443                                 const char *buf, size_t len)
444 {
445         int err;
446         struct param_attribute *attribute = to_param_attr(mattr);
447
448         if (!attribute->param->set)
449                 return -EPERM;
450
451         err = attribute->param->set(buf, attribute->param);
452         if (!err)
453                 return len;
454         return err;
455 }
456 #endif
457
458 #ifdef CONFIG_MODULES
459 #define __modinit
460 #else
461 #define __modinit __init
462 #endif
463
464 #ifdef CONFIG_SYSFS
465 /*
466  * add_sysfs_param - add a parameter to sysfs
467  * @mk: struct module_kobject
468  * @kparam: the actual parameter definition to add to sysfs
469  * @name: name of parameter
470  *
471  * Create a kobject if for a (per-module) parameter if mp NULL, and
472  * create file in sysfs.  Returns an error on out of memory.  Always cleans up
473  * if there's an error.
474  */
475 static __modinit int add_sysfs_param(struct module_kobject *mk,
476                                      struct kernel_param *kp,
477                                      const char *name)
478 {
479         struct module_param_attrs *new;
480         struct attribute **attrs;
481         int err, num;
482
483         /* We don't bother calling this with invisible parameters. */
484         BUG_ON(!kp->perm);
485
486         if (!mk->mp) {
487                 num = 0;
488                 attrs = NULL;
489         } else {
490                 num = mk->mp->num;
491                 attrs = mk->mp->grp.attrs;
492         }
493
494         /* Enlarge. */
495         new = krealloc(mk->mp,
496                        sizeof(*mk->mp) + sizeof(mk->mp->attrs[0]) * (num+1),
497                        GFP_KERNEL);
498         if (!new) {
499                 kfree(mk->mp);
500                 err = -ENOMEM;
501                 goto fail;
502         }
503         attrs = krealloc(attrs, sizeof(new->grp.attrs[0])*(num+2), GFP_KERNEL);
504         if (!attrs) {
505                 err = -ENOMEM;
506                 goto fail_free_new;
507         }
508
509         /* Sysfs wants everything zeroed. */
510         memset(new, 0, sizeof(*new));
511         memset(&new->attrs[num], 0, sizeof(new->attrs[num]));
512         memset(&attrs[num], 0, sizeof(attrs[num]));
513         new->grp.name = "parameters";
514         new->grp.attrs = attrs;
515
516         /* Tack new one on the end. */
517         sysfs_attr_init(&new->attrs[num].mattr.attr);
518         new->attrs[num].param = kp;
519         new->attrs[num].mattr.show = param_attr_show;
520         new->attrs[num].mattr.store = param_attr_store;
521         new->attrs[num].mattr.attr.name = (char *)name;
522         new->attrs[num].mattr.attr.mode = kp->perm;
523         new->num = num+1;
524
525         /* Fix up all the pointers, since krealloc can move us */
526         for (num = 0; num < new->num; num++)
527                 new->grp.attrs[num] = &new->attrs[num].mattr.attr;
528         new->grp.attrs[num] = NULL;
529
530         mk->mp = new;
531         return 0;
532
533 fail_free_new:
534         kfree(new);
535 fail:
536         mk->mp = NULL;
537         return err;
538 }
539
540 #ifdef CONFIG_MODULES
541 static void free_module_param_attrs(struct module_kobject *mk)
542 {
543         kfree(mk->mp->grp.attrs);
544         kfree(mk->mp);
545         mk->mp = NULL;
546 }
547
548 /*
549  * module_param_sysfs_setup - setup sysfs support for one module
550  * @mod: module
551  * @kparam: module parameters (array)
552  * @num_params: number of module parameters
553  *
554  * Adds sysfs entries for module parameters under
555  * /sys/module/[mod->name]/parameters/
556  */
557 int module_param_sysfs_setup(struct module *mod,
558                              struct kernel_param *kparam,
559                              unsigned int num_params)
560 {
561         int i, err;
562         bool params = false;
563
564         for (i = 0; i < num_params; i++) {
565                 if (kparam[i].perm == 0)
566                         continue;
567                 err = add_sysfs_param(&mod->mkobj, &kparam[i], kparam[i].name);
568                 if (err)
569                         return err;
570                 params = true;
571         }
572
573         if (!params)
574                 return 0;
575
576         /* Create the param group. */
577         err = sysfs_create_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp);
578         if (err)
579                 free_module_param_attrs(&mod->mkobj);
580         return err;
581 }
582
583 /*
584  * module_param_sysfs_remove - remove sysfs support for one module
585  * @mod: module
586  *
587  * Remove sysfs entries for module parameters and the corresponding
588  * kobject.
589  */
590 void module_param_sysfs_remove(struct module *mod)
591 {
592         if (mod->mkobj.mp) {
593                 sysfs_remove_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp);
594                 /* We are positive that no one is using any param
595                  * attrs at this point.  Deallocate immediately. */
596                 free_module_param_attrs(&mod->mkobj);
597         }
598 }
599 #endif
600
601 void destroy_params(const struct kernel_param *params, unsigned num)
602 {
603         /* FIXME: This should free kmalloced charp parameters.  It doesn't. */
604 }
605
606 static void __init kernel_add_sysfs_param(const char *name,
607                                           struct kernel_param *kparam,
608                                           unsigned int name_skip)
609 {
610         struct module_kobject *mk;
611         struct kobject *kobj;
612         int err;
613
614         kobj = kset_find_obj(module_kset, name);
615         if (kobj) {
616                 /* We already have one.  Remove params so we can add more. */
617                 mk = to_module_kobject(kobj);
618                 /* We need to remove it before adding parameters. */
619                 sysfs_remove_group(&mk->kobj, &mk->mp->grp);
620         } else {
621                 mk = kzalloc(sizeof(struct module_kobject), GFP_KERNEL);
622                 BUG_ON(!mk);
623
624                 mk->mod = THIS_MODULE;
625                 mk->kobj.kset = module_kset;
626                 err = kobject_init_and_add(&mk->kobj, &module_ktype, NULL,
627                                            "%s", name);
628                 if (err) {
629                         kobject_put(&mk->kobj);
630                         printk(KERN_ERR "Module '%s' failed add to sysfs, "
631                                "error number %d\n", name, err);
632                         printk(KERN_ERR "The system will be unstable now.\n");
633                         return;
634                 }
635                 /* So that exit path is even. */
636                 kobject_get(&mk->kobj);
637         }
638
639         /* These should not fail at boot. */
640         err = add_sysfs_param(mk, kparam, kparam->name + name_skip);
641         BUG_ON(err);
642         err = sysfs_create_group(&mk->kobj, &mk->mp->grp);
643         BUG_ON(err);
644         kobject_uevent(&mk->kobj, KOBJ_ADD);
645         kobject_put(&mk->kobj);
646 }
647
648 /*
649  * param_sysfs_builtin - add contents in /sys/parameters for built-in modules
650  *
651  * Add module_parameters to sysfs for "modules" built into the kernel.
652  *
653  * The "module" name (KBUILD_MODNAME) is stored before a dot, the
654  * "parameter" name is stored behind a dot in kernel_param->name. So,
655  * extract the "module" name for all built-in kernel_param-eters,
656  * and for all who have the same, call kernel_add_sysfs_param.
657  */
658 static void __init param_sysfs_builtin(void)
659 {
660         struct kernel_param *kp;
661         unsigned int name_len;
662         char modname[MODULE_NAME_LEN];
663
664         for (kp = __start___param; kp < __stop___param; kp++) {
665                 char *dot;
666
667                 if (kp->perm == 0)
668                         continue;
669
670                 dot = strchr(kp->name, '.');
671                 if (!dot) {
672                         /* This happens for core_param() */
673                         strcpy(modname, "kernel");
674                         name_len = 0;
675                 } else {
676                         name_len = dot - kp->name + 1;
677                         strlcpy(modname, kp->name, name_len);
678                 }
679                 kernel_add_sysfs_param(modname, kp, name_len);
680         }
681 }
682
683
684 /* module-related sysfs stuff */
685
686 static ssize_t module_attr_show(struct kobject *kobj,
687                                 struct attribute *attr,
688                                 char *buf)
689 {
690         struct module_attribute *attribute;
691         struct module_kobject *mk;
692         int ret;
693
694         attribute = to_module_attr(attr);
695         mk = to_module_kobject(kobj);
696
697         if (!attribute->show)
698                 return -EIO;
699
700         ret = attribute->show(attribute, mk->mod, buf);
701
702         return ret;
703 }
704
705 static ssize_t module_attr_store(struct kobject *kobj,
706                                 struct attribute *attr,
707                                 const char *buf, size_t len)
708 {
709         struct module_attribute *attribute;
710         struct module_kobject *mk;
711         int ret;
712
713         attribute = to_module_attr(attr);
714         mk = to_module_kobject(kobj);
715
716         if (!attribute->store)
717                 return -EIO;
718
719         ret = attribute->store(attribute, mk->mod, buf, len);
720
721         return ret;
722 }
723
724 static const struct sysfs_ops module_sysfs_ops = {
725         .show = module_attr_show,
726         .store = module_attr_store,
727 };
728
729 static int uevent_filter(struct kset *kset, struct kobject *kobj)
730 {
731         struct kobj_type *ktype = get_ktype(kobj);
732
733         if (ktype == &module_ktype)
734                 return 1;
735         return 0;
736 }
737
738 static const struct kset_uevent_ops module_uevent_ops = {
739         .filter = uevent_filter,
740 };
741
742 struct kset *module_kset;
743 int module_sysfs_initialized;
744
745 struct kobj_type module_ktype = {
746         .sysfs_ops =    &module_sysfs_ops,
747 };
748
749 /*
750  * param_sysfs_init - wrapper for built-in params support
751  */
752 static int __init param_sysfs_init(void)
753 {
754         module_kset = kset_create_and_add("module", &module_uevent_ops, NULL);
755         if (!module_kset) {
756                 printk(KERN_WARNING "%s (%d): error creating kset\n",
757                         __FILE__, __LINE__);
758                 return -ENOMEM;
759         }
760         module_sysfs_initialized = 1;
761
762         param_sysfs_builtin();
763
764         return 0;
765 }
766 subsys_initcall(param_sysfs_init);
767
768 #endif /* CONFIG_SYSFS */