Linux Audio

Check our new training course

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