Linux Audio

Check our new training course

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