[linux.git] / kernel / params.c

/* Helpers for initial module or kernel cmdline parsing
   Copyright (C) 2001 Rusty Russell.

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU General Public License for more details.

    You should have received a copy of the GNU General Public License
    along with this program; if not, write to the Free Software
    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
*/
#include <linux/moduleparam.h>
#include <linux/kernel.h>
#include <linux/string.h>
#include <linux/errno.h>
#include <linux/module.h>
#include <linux/device.h>
#include <linux/err.h>
#include <linux/slab.h>

#if 0
#define DEBUGP printk
#else
#define DEBUGP(fmt, a...)
#endif

static inline char dash2underscore(char c)
{
	if (c == '-')
		return '_';
	return c;
}

static inline int parameq(const char *input, const char *paramname)
{
	unsigned int i;
	for (i = 0; dash2underscore(input[i]) == paramname[i]; i++)
		if (input[i] == '\0')
			return 1;
	return 0;
}

static int parse_one(char *param,
		     char *val,
		     struct kernel_param *params, 
		     unsigned num_params,
		     int (*handle_unknown)(char *param, char *val))
{
	unsigned int i;

	/* Find parameter */
	for (i = 0; i < num_params; i++) {
		if (parameq(param, params[i].name)) {
			DEBUGP("They are equal!  Calling %p\n",
			       params[i].set);
			return params[i].set(val, &params[i]);
		}
	}

	if (handle_unknown) {
		DEBUGP("Unknown argument: calling %p\n", handle_unknown);
		return handle_unknown(param, val);
	}

	DEBUGP("Unknown argument `%s'\n", param);
	return -ENOENT;
}

/* You can use " around spaces, but can't escape ". */
/* Hyphens and underscores equivalent in parameter names. */
static char *next_arg(char *args, char **param, char **val)
{
	unsigned int i, equals = 0;
	int in_quote = 0, quoted = 0;
	char *next;

	if (*args == '"') {
		args++;
		in_quote = 1;
		quoted = 1;
	}

	for (i = 0; args[i]; i++) {
		if (args[i] == ' ' && !in_quote)
			break;
		if (equals == 0) {
			if (args[i] == '=')
				equals = i;
		}
		if (args[i] == '"')
			in_quote = !in_quote;
	}

	*param = args;
	if (!equals)
		*val = NULL;
	else {
		args[equals] = '\0';
		*val = args + equals + 1;

		/* Don't include quotes in value. */
		if (**val == '"') {
			(*val)++;
			if (args[i-1] == '"')
				args[i-1] = '\0';
		}
		if (quoted && args[i-1] == '"')
			args[i-1] = '\0';
	}

	if (args[i]) {
		args[i] = '\0';
		next = args + i + 1;
	} else
		next = args + i;

	/* Chew up trailing spaces. */
	while (*next == ' ')
		next++;
	return next;
}

/* Args looks like "foo=bar,bar2 baz=fuz wiz". */
int parse_args(const char *name,
	       char *args,
	       struct kernel_param *params,
	       unsigned num,
	       int (*unknown)(char *param, char *val))
{
	char *param, *val;

	DEBUGP("Parsing ARGS: %s\n", args);

	/* Chew leading spaces */
	while (*args == ' ')
		args++;

	while (*args) {
		int ret;
		int irq_was_disabled;

		args = next_arg(args, &param, &val);
		irq_was_disabled = irqs_disabled();
		ret = parse_one(param, val, params, num, unknown);
		if (irq_was_disabled && !irqs_disabled()) {
			printk(KERN_WARNING "parse_args(): option '%s' enabled "
					"irq's!\n", param);
		}
		switch (ret) {
		case -ENOENT:
			printk(KERN_ERR "%s: Unknown parameter `%s'\n",
			       name, param);
			return ret;
		case -ENOSPC:
			printk(KERN_ERR
			       "%s: `%s' too large for parameter `%s'\n",
			       name, val ?: "", param);
			return ret;
		case 0:
			break;
		default:
			printk(KERN_ERR
			       "%s: `%s' invalid for parameter `%s'\n",
			       name, val ?: "", param);
			return ret;
		}
	}

	/* All parsed OK. */
	return 0;
}

/* Lazy bastard, eh? */
#define STANDARD_PARAM_DEF(name, type, format, tmptype, strtolfn)      	\
	int param_set_##name(const char *val, struct kernel_param *kp)	\
	{								\
		tmptype l;						\
		int ret;						\
									\
		if (!val) return -EINVAL;				\
		ret = strtolfn(val, 0, &l);				\
		if (ret == -EINVAL || ((type)l != l))			\
			return -EINVAL;					\
		*((type *)kp->arg) = l;					\
		return 0;						\
	}								\
	int param_get_##name(char *buffer, struct kernel_param *kp)	\
	{								\
		return sprintf(buffer, format, *((type *)kp->arg));	\
	}

STANDARD_PARAM_DEF(byte, unsigned char, "%c", unsigned long, strict_strtoul);
STANDARD_PARAM_DEF(short, short, "%hi", long, strict_strtol);
STANDARD_PARAM_DEF(ushort, unsigned short, "%hu", unsigned long, strict_strtoul);
STANDARD_PARAM_DEF(int, int, "%i", long, strict_strtol);
STANDARD_PARAM_DEF(uint, unsigned int, "%u", unsigned long, strict_strtoul);
STANDARD_PARAM_DEF(long, long, "%li", long, strict_strtol);
STANDARD_PARAM_DEF(ulong, unsigned long, "%lu", unsigned long, strict_strtoul);

int param_set_charp(const char *val, struct kernel_param *kp)
{
	if (!val) {
		printk(KERN_ERR "%s: string parameter expected\n",
		       kp->name);
		return -EINVAL;
	}

	if (strlen(val) > 1024) {
		printk(KERN_ERR "%s: string parameter too long\n",
		       kp->name);
		return -ENOSPC;
	}

	*(char **)kp->arg = (char *)val;
	return 0;
}

int param_get_charp(char *buffer, struct kernel_param *kp)
{
	return sprintf(buffer, "%s", *((char **)kp->arg));
}

int param_set_bool(const char *val, struct kernel_param *kp)
{
	/* No equals means "set"... */
	if (!val) val = "1";

	/* One of =[yYnN01] */
	switch (val[0]) {
	case 'y': case 'Y': case '1':
		*(int *)kp->arg = 1;
		return 0;
	case 'n': case 'N': case '0':
		*(int *)kp->arg = 0;
		return 0;
	}
	return -EINVAL;
}

int param_get_bool(char *buffer, struct kernel_param *kp)
{
	/* Y and N chosen as being relatively non-coder friendly */
	return sprintf(buffer, "%c", (*(int *)kp->arg) ? 'Y' : 'N');
}

int param_set_invbool(const char *val, struct kernel_param *kp)
{
	int boolval, ret;
	struct kernel_param dummy;

	dummy.arg = &boolval;
	ret = param_set_bool(val, &dummy);
	if (ret == 0)
		*(int *)kp->arg = !boolval;
	return ret;
}

int param_get_invbool(char *buffer, struct kernel_param *kp)
{
	return sprintf(buffer, "%c", (*(int *)kp->arg) ? 'N' : 'Y');
}

/* We break the rule and mangle the string. */
static int param_array(const char *name,
		       const char *val,
		       unsigned int min, unsigned int max,
		       void *elem, int elemsize,
		       int (*set)(const char *, struct kernel_param *kp),
		       unsigned int *num)
{
	int ret;
	struct kernel_param kp;
	char save;

	/* Get the name right for errors. */
	kp.name = name;
	kp.arg = elem;

	/* No equals sign? */
	if (!val) {
		printk(KERN_ERR "%s: expects arguments\n", name);
		return -EINVAL;
	}

	*num = 0;
	/* We expect a comma-separated list of values. */
	do {
		int len;

		if (*num == max) {
			printk(KERN_ERR "%s: can only take %i arguments\n",
			       name, max);
			return -EINVAL;
		}
		len = strcspn(val, ",");

		/* nul-terminate and parse */
		save = val[len];
		((char *)val)[len] = '\0';
		ret = set(val, &kp);

		if (ret != 0)
			return ret;
		kp.arg += elemsize;
		val += len+1;
		(*num)++;
	} while (save == ',');

	if (*num < min) {
		printk(KERN_ERR "%s: needs at least %i arguments\n",
		       name, min);
		return -EINVAL;
	}
	return 0;
}

int param_array_set(const char *val, struct kernel_param *kp)
{
	const struct kparam_array *arr = kp->arr;
	unsigned int temp_num;

	return param_array(kp->name, val, 1, arr->max, arr->elem,
			   arr->elemsize, arr->set, arr->num ?: &temp_num);
}

int param_array_get(char *buffer, struct kernel_param *kp)
{
	int i, off, ret;
	const struct kparam_array *arr = kp->arr;
	struct kernel_param p;

	p = *kp;
	for (i = off = 0; i < (arr->num ? *arr->num : arr->max); i++) {
		if (i)
			buffer[off++] = ',';
		p.arg = arr->elem + arr->elemsize * i;
		ret = arr->get(buffer + off, &p);
		if (ret < 0)
			return ret;
		off += ret;
	}
	buffer[off] = '\0';
	return off;
}

int param_set_copystring(const char *val, struct kernel_param *kp)
{
	const struct kparam_string *kps = kp->str;

	if (!val) {
		printk(KERN_ERR "%s: missing param set value\n", kp->name);
		return -EINVAL;
	}
	if (strlen(val)+1 > kps->maxlen) {
		printk(KERN_ERR "%s: string doesn't fit in %u chars.\n",
		       kp->name, kps->maxlen-1);
		return -ENOSPC;
	}
	strcpy(kps->string, val);
	return 0;
}

int param_get_string(char *buffer, struct kernel_param *kp)
{
	const struct kparam_string *kps = kp->str;
	return strlcpy(buffer, kps->string, kps->maxlen);
}

/* sysfs output in /sys/modules/XYZ/parameters/ */
#define to_module_attr(n) container_of(n, struct module_attribute, attr);
#define to_module_kobject(n) container_of(n, struct module_kobject, kobj);

extern struct kernel_param __start___param[], __stop___param[];

struct param_attribute
{
	struct module_attribute mattr;
	struct kernel_param *param;
};

struct module_param_attrs
{
	unsigned int num;
	struct attribute_group grp;
	struct param_attribute attrs[0];
};

#ifdef CONFIG_SYSFS
#define to_param_attr(n) container_of(n, struct param_attribute, mattr);

static ssize_t param_attr_show(struct module_attribute *mattr,
			       struct module *mod, char *buf)
{
	int count;
	struct param_attribute *attribute = to_param_attr(mattr);

	if (!attribute->param->get)
		return -EPERM;

	count = attribute->param->get(buf, attribute->param);
	if (count > 0) {
		strcat(buf, "\n");
		++count;
	}
	return count;
}

/* sysfs always hands a nul-terminated string in buf.  We rely on that. */
static ssize_t param_attr_store(struct module_attribute *mattr,
				struct module *owner,
				const char *buf, size_t len)
{
 	int err;
	struct param_attribute *attribute = to_param_attr(mattr);

	if (!attribute->param->set)
		return -EPERM;

	err = attribute->param->set(buf, attribute->param);
	if (!err)
		return len;
	return err;
}
#endif

#ifdef CONFIG_MODULES
#define __modinit
#else
#define __modinit __init
#endif

#ifdef CONFIG_SYSFS
/*
 * add_sysfs_param - add a parameter to sysfs
 * @mk: struct module_kobject
 * @kparam: the actual parameter definition to add to sysfs
 * @name: name of parameter
 *
 * Create a kobject if for a (per-module) parameter if mp NULL, and
 * create file in sysfs.  Returns an error on out of memory.  Always cleans up
 * if there's an error.
 */
static __modinit int add_sysfs_param(struct module_kobject *mk,
				     struct kernel_param *kp,
				     const char *name)
{
	struct module_param_attrs *new;
	struct attribute **attrs;
	int err, num;

	/* We don't bother calling this with invisible parameters. */
	BUG_ON(!kp->perm);

	if (!mk->mp) {
		num = 0;
		attrs = NULL;
	} else {
		num = mk->mp->num;
		attrs = mk->mp->grp.attrs;
	}

	/* Enlarge. */
	new = krealloc(mk->mp,
		       sizeof(*mk->mp) + sizeof(mk->mp->attrs[0]) * (num+1),
		       GFP_KERNEL);
	if (!new) {
		kfree(mk->mp);
		err = -ENOMEM;
		goto fail;
	}
	attrs = krealloc(attrs, sizeof(new->grp.attrs[0])*(num+2), GFP_KERNEL);
	if (!attrs) {
		err = -ENOMEM;
		goto fail_free_new;
	}

	/* Sysfs wants everything zeroed. */
	memset(new, 0, sizeof(*new));
	memset(&new->attrs[num], 0, sizeof(new->attrs[num]));
	memset(&attrs[num], 0, sizeof(attrs[num]));
	new->grp.name = "parameters";
	new->grp.attrs = attrs;

	/* Tack new one on the end. */
	new->attrs[num].param = kp;
	new->attrs[num].mattr.show = param_attr_show;
	new->attrs[num].mattr.store = param_attr_store;
	new->attrs[num].mattr.attr.name = (char *)name;
	new->attrs[num].mattr.attr.mode = kp->perm;
	new->num = num+1;

	/* Fix up all the pointers, since krealloc can move us */
	for (num = 0; num < new->num; num++)
		new->grp.attrs[num] = &new->attrs[num].mattr.attr;
	new->grp.attrs[num] = NULL;

	mk->mp = new;
	return 0;

fail_free_new:
	kfree(new);
fail:
	mk->mp = NULL;
	return err;
}

#ifdef CONFIG_MODULES
static void free_module_param_attrs(struct module_kobject *mk)
{
	kfree(mk->mp->grp.attrs);
	kfree(mk->mp);
	mk->mp = NULL;
}

/*
 * module_param_sysfs_setup - setup sysfs support for one module
 * @mod: module
 * @kparam: module parameters (array)
 * @num_params: number of module parameters
 *
 * Adds sysfs entries for module parameters under
 * /sys/module/[mod->name]/parameters/
 */
int module_param_sysfs_setup(struct module *mod,
			     struct kernel_param *kparam,
			     unsigned int num_params)
{
	int i, err;
	bool params = false;

	for (i = 0; i < num_params; i++) {
		if (kparam[i].perm == 0)
			continue;
		err = add_sysfs_param(&mod->mkobj, &kparam[i], kparam[i].name);
		if (err)
			return err;
		params = true;
	}

	if (!params)
		return 0;

	/* Create the param group. */
	err = sysfs_create_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp);
	if (err)
		free_module_param_attrs(&mod->mkobj);
	return err;
}

/*
 * module_param_sysfs_remove - remove sysfs support for one module
 * @mod: module
 *
 * Remove sysfs entries for module parameters and the corresponding
 * kobject.
 */
void module_param_sysfs_remove(struct module *mod)
{
	if (mod->mkobj.mp) {
		sysfs_remove_group(&mod->mkobj.kobj, &mod->mkobj.mp->grp);
		/* We are positive that no one is using any param
		 * attrs at this point.  Deallocate immediately. */
		free_module_param_attrs(&mod->mkobj);
	}
}
#endif

static void __init kernel_add_sysfs_param(const char *name,
					  struct kernel_param *kparam,
					  unsigned int name_skip)
{
	struct module_kobject *mk;
	struct kobject *kobj;
	int err;

	kobj = kset_find_obj(module_kset, name);
	if (kobj) {
		/* We already have one.  Remove params so we can add more. */
		mk = to_module_kobject(kobj);
		/* We need to remove it before adding parameters. */
		sysfs_remove_group(&mk->kobj, &mk->mp->grp);
	} else {
		mk = kzalloc(sizeof(struct module_kobject), GFP_KERNEL);
		BUG_ON(!mk);

		mk->mod = THIS_MODULE;
		mk->kobj.kset = module_kset;
		err = kobject_init_and_add(&mk->kobj, &module_ktype, NULL,
					   "%s", name);
		if (err) {
			kobject_put(&mk->kobj);
			printk(KERN_ERR "Module '%s' failed add to sysfs, "
			       "error number %d\n", name, err);
			printk(KERN_ERR	"The system will be unstable now.\n");
			return;
		}
		/* So that exit path is even. */
		kobject_get(&mk->kobj);
	}

	/* These should not fail at boot. */
	err = add_sysfs_param(mk, kparam, kparam->name + name_skip);
	BUG_ON(err);
	err = sysfs_create_group(&mk->kobj, &mk->mp->grp);
	BUG_ON(err);
	kobject_uevent(&mk->kobj, KOBJ_ADD);
	kobject_put(&mk->kobj);
}

/*
 * param_sysfs_builtin - add contents in /sys/parameters for built-in modules
 *
 * Add module_parameters to sysfs for "modules" built into the kernel.
 *
 * The "module" name (KBUILD_MODNAME) is stored before a dot, the
 * "parameter" name is stored behind a dot in kernel_param->name. So,
 * extract the "module" name for all built-in kernel_param-eters,
 * and for all who have the same, call kernel_add_sysfs_param.
 */
static void __init param_sysfs_builtin(void)
{
	struct kernel_param *kp;
	unsigned int name_len;
	char modname[MODULE_NAME_LEN];

	for (kp = __start___param; kp < __stop___param; kp++) {
		char *dot;

		if (kp->perm == 0)
			continue;

		dot = strchr(kp->name, '.');
		if (!dot) {
			/* This happens for core_param() */
			strcpy(modname, "kernel");
			name_len = 0;
		} else {
			name_len = dot - kp->name + 1;
			strlcpy(modname, kp->name, name_len);
		}
		kernel_add_sysfs_param(modname, kp, name_len);
	}
}


/* module-related sysfs stuff */

static ssize_t module_attr_show(struct kobject *kobj,
				struct attribute *attr,
				char *buf)
{
	struct module_attribute *attribute;
	struct module_kobject *mk;
	int ret;

	attribute = to_module_attr(attr);
	mk = to_module_kobject(kobj);

	if (!attribute->show)
		return -EIO;

	ret = attribute->show(attribute, mk->mod, buf);

	return ret;
}

static ssize_t module_attr_store(struct kobject *kobj,
				struct attribute *attr,
				const char *buf, size_t len)
{
	struct module_attribute *attribute;
	struct module_kobject *mk;
	int ret;

	attribute = to_module_attr(attr);
	mk = to_module_kobject(kobj);

	if (!attribute->store)
		return -EIO;

	ret = attribute->store(attribute, mk->mod, buf, len);

	return ret;
}

static struct sysfs_ops module_sysfs_ops = {
	.show = module_attr_show,
	.store = module_attr_store,
};

static int uevent_filter(struct kset *kset, struct kobject *kobj)
{
	struct kobj_type *ktype = get_ktype(kobj);

	if (ktype == &module_ktype)
		return 1;
	return 0;
}

static struct kset_uevent_ops module_uevent_ops = {
	.filter = uevent_filter,
};

struct kset *module_kset;
int module_sysfs_initialized;

struct kobj_type module_ktype = {
	.sysfs_ops =	&module_sysfs_ops,
};

/*
 * param_sysfs_init - wrapper for built-in params support
 */
static int __init param_sysfs_init(void)
{
	module_kset = kset_create_and_add("module", &module_uevent_ops, NULL);
	if (!module_kset) {
		printk(KERN_WARNING "%s (%d): error creating kset\n",
			__FILE__, __LINE__);
		return -ENOMEM;
	}
	module_sysfs_initialized = 1;

	param_sysfs_builtin();

	return 0;
}
subsys_initcall(param_sysfs_init);

#endif /* CONFIG_SYSFS */

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