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