[fio.git] / parse.c

/*
 * This file contains the ini and command liner parser main.
 */
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <ctype.h>
#include <string.h>
#include <errno.h>
#include <limits.h>

#include "parse.h"

static unsigned long get_mult_time(char c)
{
	switch (c) {
		case 'm':
		case 'M':
			return 60;
		case 'h':
		case 'H':
			return 60 * 60;
		case 'd':
		case 'D':
			return 24 * 60 * 60;
		default:
			return 1;
	}
}

static unsigned long get_mult_bytes(char c)
{
	switch (c) {
		case 'k':
		case 'K':
			return 1024;
		case 'm':
		case 'M':
			return 1024 * 1024;
		case 'g':
		case 'G':
			return 1024 * 1024 * 1024;
		default:
			return 1;
	}
}

/*
 * convert string into decimal value, noting any size suffix
 */
static int str_to_decimal(const char *str, unsigned long long *val, int kilo)
{
	int len;

	len = strlen(str);
	if (!len)
		return 1;

	*val = strtoul(str, NULL, 10);
	if (*val == ULONG_MAX && errno == ERANGE)
		return 1;

	if (kilo)
		*val *= get_mult_bytes(str[len - 1]);
	else
		*val *= get_mult_time(str[len - 1]);

	return 0;
}

static int check_str_bytes(const char *p, unsigned long long *val)
{
	return str_to_decimal(p, val, 1);
}

static int check_str_time(const char *p, unsigned long long *val)
{
	return str_to_decimal(p, val, 0);
}

void strip_blank_front(char **p)
{
	char *s = *p;

	while (isspace(*s))
		s++;
}

void strip_blank_end(char *p)
{
	char *s = p + strlen(p) - 1;

	while (isspace(*s) || iscntrl(*s))
		s--;

	*(s + 1) = '\0';
}

static int check_range_bytes(const char *str, unsigned long *val)
{
	char suffix;

	if (!strlen(str))
		return 1;

	if (sscanf(str, "%lu%c", val, &suffix) == 2) {
		*val *= get_mult_bytes(suffix);
		return 0;
	}

	if (sscanf(str, "%lu", val) == 1)
		return 0;

	return 1;
}

static int check_int(const char *p, unsigned int *val)
{
	if (!strlen(p))
		return 1;
	if (sscanf(p, "%u", val) == 1)
		return 0;

	return 1;
}

static struct fio_option *find_option(struct fio_option *options,
				      const char *opt)
{
	struct fio_option *o = &options[0];

	while (o->name) {
		if (!strcmp(o->name, opt))
			return o;

		o++;
	}

	return NULL;
}

#define val_store(ptr, val, off, data)			\
	do {						\
		ptr = td_var((data), (off));		\
		*ptr = (val);				\
	} while (0)

static int __handle_option(struct fio_option *o, const char *ptr, void *data,
			   int first, int more)
{
	unsigned int il, *ilp;
	unsigned long long ull, *ullp;
	unsigned long ul1, ul2;
	char **cp;
	int ret = 0, is_time = 0;

	if (!ptr && o->type != FIO_OPT_STR_SET) {
		fprintf(stderr, "Option %s requires an argument\n", o->name);
		return 1;
	}

	switch (o->type) {
	case FIO_OPT_STR: {
		fio_opt_str_fn *fn = o->cb;

		ret = fn(data, ptr);
		break;
	}
	case FIO_OPT_STR_VAL_TIME:
		is_time = 1;
	case FIO_OPT_STR_VAL:
	case FIO_OPT_STR_VAL_INT: {
		fio_opt_str_val_fn *fn = o->cb;

		if (is_time)
			ret = check_str_time(ptr, &ull);
		else
			ret = check_str_bytes(ptr, &ull);

		if (ret)
			break;

		if (o->maxval && ull > o->maxval)
			ull = o->maxval;
		if (o->minval && ull < o->minval)
			ull = o->minval;

		if (fn)
			ret = fn(data, &ull);
		else {
			if (o->type == FIO_OPT_STR_VAL_INT) {
				if (first)
					val_store(ilp, ull, o->off1, data);
				if (!more && o->off2)
					val_store(ilp, ull, o->off2, data);
			} else {
				if (first)
					val_store(ullp, ull, o->off1, data);
				if (!more && o->off2)
					val_store(ullp, ull, o->off2, data);
			}
		}
		break;
	}
	case FIO_OPT_STR_STORE:
		cp = td_var(data, o->off1);
		*cp = strdup(ptr);
		break;
	case FIO_OPT_RANGE: {
		char tmp[128];
		char *p1, *p2;

		strncpy(tmp, ptr, sizeof(tmp) - 1);

		p1 = strchr(tmp, '-');
		if (!p1) {
			ret = 1;
			break;
		}

		p2 = p1 + 1;
		*p1 = '\0';
		p1 = tmp;

		ret = 1;
		if (!check_range_bytes(p1, &ul1) && !check_range_bytes(p2, &ul2)) {
			ret = 0;
			if (ul1 > ul2) {
				unsigned long foo = ul1;

				ul1 = ul2;
				ul2 = foo;
			}

			if (first) {
				val_store(ilp, ul1, o->off1, data);
				val_store(ilp, ul2, o->off2, data);
			}
			if (!more && o->off3 && o->off4) {
				val_store(ilp, ul1, o->off3, data);
				val_store(ilp, ul2, o->off4, data);
			}
		}

		break;
	}
	case FIO_OPT_INT: {
		fio_opt_int_fn *fn = o->cb;

		ret = check_int(ptr, &il);
		if (ret)
			break;

		if (o->maxval && il > o->maxval)
			il = o->maxval;
		if (o->minval && il < o->minval)
			il = o->minval;

		if (fn)
			ret = fn(data, &il);
		else {
			if (first)
				val_store(ilp, il, o->off1, data);
			if (!more && o->off2)
				val_store(ilp, il, o->off2, data);
		}
		break;
	}
	case FIO_OPT_STR_SET: {
		fio_opt_str_set_fn *fn = o->cb;

		if (fn)
			ret = fn(data);
		else {
			if (first)
				val_store(ilp, 1, o->off1, data);
			if (!more && o->off2)
				val_store(ilp, 1, o->off2, data);
		}
		break;
	}
	default:
		fprintf(stderr, "Bad option type %u\n", o->type);
		ret = 1;
	}

	return ret;
}

static int handle_option(struct fio_option *o, const char *ptr, void *data)
{
	const char *ptr2 = NULL;
	int r1, r2;

	/*
	 * See if we have a second set of parameters, hidden after a comma.
	 * Do this before parsing the first round, to check if we should
	 * copy set 1 options to set 2.
	 */
	if (ptr)
		ptr2 = strchr(ptr, ',');

	/*
	 * Don't return early if parsing the first option fails - if
	 * we are doing multiple arguments, we can allow the first one
	 * being empty.
	 */
	r1 = __handle_option(o, ptr, data, 1, !!ptr2);

	if (!ptr2)
		return r1;

	ptr2++;
	r2 = __handle_option(o, ptr2, data, 0, 0);

	return r1 && r2;
}

int parse_cmd_option(const char *opt, const char *val,
		     struct fio_option *options, void *data)
{
	struct fio_option *o;

	o = find_option(options, opt);
	if (!o) {
		fprintf(stderr, "Bad option %s\n", opt);
		return 1;
	}

	if (!handle_option(o, val, data))
		return 0;

	fprintf(stderr, "fio: failed parsing %s=%s\n", opt, val);
	return 1;
}

int parse_option(const char *opt, struct fio_option *options, void *data)
{
	struct fio_option *o;
	char *pre, *post;
	char tmp[64];

	strncpy(tmp, opt, sizeof(tmp) - 1);

	pre = strchr(tmp, '=');
	if (pre) {
		post = pre;
		*pre = '\0';
		pre = tmp;
		post++;
		o = find_option(options, pre);
	} else {
		o = find_option(options, tmp);
		post = NULL;
	}

	if (!o) {
		fprintf(stderr, "Bad option %s\n", tmp);
		return 1;
	}

	if (!handle_option(o, post, data))
		return 0;

	fprintf(stderr, "fio: failed parsing %s\n", opt);
	return 1;
}

int show_cmd_help(struct fio_option *options, const char *name)
{
	int show_all = !strcmp(name, "all");
	struct fio_option *o = &options[0];
	const char *typehelp[] = {
		"string (opt=bla)",
		"string with possible k/m/g postfix (opt=4k)",
		"string with range and postfix (opt=1k-4k)",
		"string with time postfix (opt=10s)",
		"string (opt=bla)",
		"string with dual range (opt=1k-4k,4k-8k)",
		"integer value (opt=100)",
		"no argument (opt)",
	};
	int found = 0;

	while (o->name) {
		int match = !strcmp(name, o->name);

		if (show_all || match) {
			found = 1;
			printf("%s: %s\n", o->name, o->help);
			if (match) {
				printf("type: %s\n", typehelp[o->type]);
				if (o->def)
					printf("default: %s\n", o->def);
				else
					printf("defaults: no default\n");
			}
		}

		o++;
	}

	if (found)
		return 0;

	printf("No such command: %s\n", name);
	return 1;
}

void fill_default_options(void *data, struct fio_option *options)
{
	struct fio_option *o = &options[0];

	while (o->name) {
		if (o->def)
			handle_option(o, o->def, data);
		o++;
	}
}
Commit	Line	Data
cb2c86fd JA	1	/*
	2	* This file contains the ini and command liner parser main.
	3	*/
	4	#include <stdio.h>
	5	#include <stdlib.h>
	6	#include <unistd.h>
	7	#include <ctype.h>
	8	#include <string.h>
	9	#include <errno.h>
	10	#include <limits.h>
	11
	12	#include "parse.h"
	13
	14	static unsigned long get_mult_time(char c)
	15	{
	16	switch (c) {
	17	case 'm':
	18	case 'M':
	19	return 60;
	20	case 'h':
	21	case 'H':
	22	return 60 * 60;
	23	case 'd':
	24	case 'D':
	25	return 24 * 60 * 60;
	26	default:
	27	return 1;
	28	}
	29	}
	30
	31	static unsigned long get_mult_bytes(char c)
	32	{
	33	switch (c) {
	34	case 'k':
	35	case 'K':
	36	return 1024;
	37	case 'm':
	38	case 'M':
	39	return 1024 * 1024;
	40	case 'g':
	41	case 'G':
	42	return 1024 * 1024 * 1024;
	43	default:
	44	return 1;
	45	}
	46	}
	47
	48	/*
e1f36503	49	* convert string into decimal value, noting any size suffix
cb2c86fd	50	*/
b4692828	51	static int str_to_decimal(const char str, unsigned long long val, int kilo)
cb2c86fd	52	{
cb2c86fd JA	53	int len;
cb2c86fd JA	54
cb2c86fd	55	len = strlen(str);
f90eff5a JA	56	if (!len)
f90eff5a JA	57	return 1;
cb2c86fd JA	58
	59	*val = strtoul(str, NULL, 10);
	60	if (*val == ULONG_MAX && errno == ERANGE)
	61	return 1;
	62
	63	if (kilo)
	64	val = get_mult_bytes(str[len - 1]);
	65	else
	66	val = get_mult_time(str[len - 1]);
787f7e95	67
cb2c86fd JA	68	return 0;
	69	}
	70
b4692828	71	static int check_str_bytes(const char p, unsigned long long val)
cb2c86fd	72	{
cb2c86fd JA	73	return str_to_decimal(p, val, 1);
	74	}
	75
b4692828	76	static int check_str_time(const char p, unsigned long long val)
cb2c86fd	77	{
cb2c86fd JA	78	return str_to_decimal(p, val, 0);
	79	}
	80
	81	void strip_blank_front(char **p)
	82	{
	83	char s = p;
	84
	85	while (isspace(*s))
	86	s++;
	87	}
	88
	89	void strip_blank_end(char *p)
	90	{
	91	char *s = p + strlen(p) - 1;
	92
	93	while (isspace(s) \|\| iscntrl(s))
	94	s--;
	95
	96	*(s + 1) = '\0';
	97	}
	98
b765a372	99	static int check_range_bytes(const char str, unsigned long val)
cb2c86fd JA	100	{
	101	char suffix;
	102
787f7e95 JA	103	if (!strlen(str))
	104	return 1;
	105
cb2c86fd JA	106	if (sscanf(str, "%lu%c", val, &suffix) == 2) {
	107	val = get_mult_bytes(suffix);
	108	return 0;
	109	}
	110
	111	if (sscanf(str, "%lu", val) == 1)
	112	return 0;
	113
	114	return 1;
	115	}
	116
b4692828	117	static int check_int(const char p, unsigned int val)
cb2c86fd	118	{
787f7e95 JA	119	if (!strlen(p))
787f7e95 JA	120	return 1;
e1f36503 JA	121	if (sscanf(p, "%u", val) == 1)
e1f36503 JA	122	return 0;
cb2c86fd	123
e1f36503 JA	124	return 1;
e1f36503 JA	125	}
cb2c86fd	126
e1f36503 JA	127	static struct fio_option find_option(struct fio_option options,
	128	const char *opt)
	129	{
33963c6c	130	struct fio_option *o = &options[0];
cb2c86fd	131
33963c6c	132	while (o->name) {
e1f36503 JA	133	if (!strcmp(o->name, opt))
e1f36503 JA	134	return o;
cb2c86fd	135
33963c6c JA	136	o++;
33963c6c JA	137	}
cb2c86fd	138
e1f36503	139	return NULL;
cb2c86fd JA	140	}
cb2c86fd JA	141
17abbe89 JA	142	#define val_store(ptr, val, off, data) \
	143	do { \
	144	ptr = td_var((data), (off)); \
	145	*ptr = (val); \
	146	} while (0)
	147
f90eff5a	148	static int __handle_option(struct fio_option o, const char ptr, void *data,
787f7e95	149	int first, int more)
cb2c86fd	150	{
17abbe89	151	unsigned int il, *ilp;
e1f36503	152	unsigned long long ull, *ullp;
75e6f36f	153	unsigned long ul1, ul2;
b4692828	154	char **cp;
e1f36503	155	int ret = 0, is_time = 0;
cb2c86fd	156
08e26e35 JA	157	if (!ptr && o->type != FIO_OPT_STR_SET) {
	158	fprintf(stderr, "Option %s requires an argument\n", o->name);
	159	return 1;
	160	}
	161
e1f36503 JA	162	switch (o->type) {
	163	case FIO_OPT_STR: {
	164	fio_opt_str_fn *fn = o->cb;
cb2c86fd	165
e1f36503 JA	166	ret = fn(data, ptr);
	167	break;
	168	}
	169	case FIO_OPT_STR_VAL_TIME:
	170	is_time = 1;
75e6f36f JA	171	case FIO_OPT_STR_VAL:
75e6f36f JA	172	case FIO_OPT_STR_VAL_INT: {
e1f36503 JA	173	fio_opt_str_val_fn *fn = o->cb;
	174
	175	if (is_time)
	176	ret = check_str_time(ptr, &ull);
	177	else
	178	ret = check_str_bytes(ptr, &ull);
	179
	180	if (ret)
	181	break;
	182
ee738499 JA	183	if (o->maxval && ull > o->maxval)
	184	ull = o->maxval;
	185	if (o->minval && ull < o->minval)
	186	ull = o->minval;
e1f36503 JA	187
	188	if (fn)
	189	ret = fn(data, &ull);
	190	else {
75e6f36f	191	if (o->type == FIO_OPT_STR_VAL_INT) {
17abbe89 JA	192	if (first)
17abbe89 JA	193	val_store(ilp, ull, o->off1, data);
787f7e95	194	if (!more && o->off2)
17abbe89	195	val_store(ilp, ull, o->off2, data);
75e6f36f	196	} else {
17abbe89 JA	197	if (first)
17abbe89 JA	198	val_store(ullp, ull, o->off1, data);
787f7e95	199	if (!more && o->off2)
17abbe89	200	val_store(ullp, ull, o->off2, data);
75e6f36f	201	}
e1f36503 JA	202	}
	203	break;
	204	}
	205	case FIO_OPT_STR_STORE:
	206	cp = td_var(data, o->off1);
	207	*cp = strdup(ptr);
	208	break;
	209	case FIO_OPT_RANGE: {
b765a372	210	char tmp[128];
e1f36503 JA	211	char p1, p2;
e1f36503 JA	212
0bbab0e7	213	strncpy(tmp, ptr, sizeof(tmp) - 1);
b765a372 JA	214
b765a372 JA	215	p1 = strchr(tmp, '-');
e1f36503 JA	216	if (!p1) {
	217	ret = 1;
	218	break;
	219	}
	220
	221	p2 = p1 + 1;
	222	*p1 = '\0';
b765a372	223	p1 = tmp;
e1f36503 JA	224
	225	ret = 1;
	226	if (!check_range_bytes(p1, &ul1) && !check_range_bytes(p2, &ul2)) {
	227	ret = 0;
e1f36503	228	if (ul1 > ul2) {
f90eff5a JA	229	unsigned long foo = ul1;
	230
	231	ul1 = ul2;
	232	ul2 = foo;
	233	}
	234
	235	if (first) {
17abbe89 JA	236	val_store(ilp, ul1, o->off1, data);
	237	val_store(ilp, ul2, o->off2, data);
	238	}
787f7e95	239	if (!more && o->off3 && o->off4) {
17abbe89 JA	240	val_store(ilp, ul1, o->off3, data);
17abbe89 JA	241	val_store(ilp, ul2, o->off4, data);
e1f36503	242	}
17abbe89 JA	243	}
17abbe89 JA	244
e1f36503 JA	245	break;
	246	}
	247	case FIO_OPT_INT: {
	248	fio_opt_int_fn *fn = o->cb;
	249
	250	ret = check_int(ptr, &il);
	251	if (ret)
	252	break;
	253
ee738499 JA	254	if (o->maxval && il > o->maxval)
	255	il = o->maxval;
	256	if (o->minval && il < o->minval)
	257	il = o->minval;
e1f36503 JA	258
	259	if (fn)
	260	ret = fn(data, &il);
	261	else {
17abbe89 JA	262	if (first)
17abbe89 JA	263	val_store(ilp, il, o->off1, data);
787f7e95	264	if (!more && o->off2)
17abbe89	265	val_store(ilp, il, o->off2, data);
e1f36503 JA	266	}
	267	break;
	268	}
	269	case FIO_OPT_STR_SET: {
	270	fio_opt_str_set_fn *fn = o->cb;
	271
	272	if (fn)
	273	ret = fn(data);
	274	else {
17abbe89 JA	275	if (first)
17abbe89 JA	276	val_store(ilp, 1, o->off1, data);
787f7e95	277	if (!more && o->off2)
17abbe89	278	val_store(ilp, 1, o->off2, data);
e1f36503 JA	279	}
	280	break;
	281	}
	282	default:
1e97cce9	283	fprintf(stderr, "Bad option type %u\n", o->type);
e1f36503 JA	284	ret = 1;
e1f36503 JA	285	}
cb2c86fd	286
e1f36503	287	return ret;
cb2c86fd JA	288	}
cb2c86fd JA	289
f90eff5a JA	290	static int handle_option(struct fio_option o, const char ptr, void *data)
f90eff5a JA	291	{
92b586f8	292	const char *ptr2 = NULL;
787f7e95	293	int r1, r2;
f90eff5a JA	294
f90eff5a JA	295	/*
787f7e95 JA	296	* See if we have a second set of parameters, hidden after a comma.
	297	* Do this before parsing the first round, to check if we should
	298	* copy set 1 options to set 2.
f90eff5a	299	*/
92b586f8 JA	300	if (ptr)
92b586f8 JA	301	ptr2 = strchr(ptr, ',');
787f7e95 JA	302
	303	/*
	304	* Don't return early if parsing the first option fails - if
	305	* we are doing multiple arguments, we can allow the first one
	306	* being empty.
	307	*/
	308	r1 = __handle_option(o, ptr, data, 1, !!ptr2);
	309
f90eff5a	310	if (!ptr2)
787f7e95	311	return r1;
f90eff5a JA	312
f90eff5a JA	313	ptr2++;
787f7e95 JA	314	r2 = __handle_option(o, ptr2, data, 0, 0);
	315
	316	return r1 && r2;
f90eff5a JA	317	}
f90eff5a JA	318
b4692828 JA	319	int parse_cmd_option(const char opt, const char val,
	320	struct fio_option options, void data)
	321	{
	322	struct fio_option *o;
	323
	324	o = find_option(options, opt);
	325	if (!o) {
	326	fprintf(stderr, "Bad option %s\n", opt);
	327	return 1;
	328	}
	329
b1508cf9 JA	330	if (!handle_option(o, val, data))
	331	return 0;
	332
	333	fprintf(stderr, "fio: failed parsing %s=%s\n", opt, val);
	334	return 1;
b4692828 JA	335	}
b4692828 JA	336
e1f36503	337	int parse_option(const char opt, struct fio_option options, void *data)
cb2c86fd	338	{
b4692828	339	struct fio_option *o;
e1f36503 JA	340	char pre, post;
	341	char tmp[64];
	342
0bbab0e7	343	strncpy(tmp, opt, sizeof(tmp) - 1);
e1f36503 JA	344
	345	pre = strchr(tmp, '=');
	346	if (pre) {
	347	post = pre;
	348	*pre = '\0';
	349	pre = tmp;
	350	post++;
	351	o = find_option(options, pre);
	352	} else {
	353	o = find_option(options, tmp);
	354	post = NULL;
	355	}
cb2c86fd	356
e1f36503 JA	357	if (!o) {
	358	fprintf(stderr, "Bad option %s\n", tmp);
	359	return 1;
	360	}
	361
b1508cf9 JA	362	if (!handle_option(o, post, data))
	363	return 0;
	364
	365	fprintf(stderr, "fio: failed parsing %s\n", opt);
	366	return 1;
e1f36503	367	}
fd28ca49 JA	368
	369	int show_cmd_help(struct fio_option options, const char name)
	370	{
	371	int show_all = !strcmp(name, "all");
	372	struct fio_option *o = &options[0];
	373	const char *typehelp[] = {
	374	"string (opt=bla)",
	375	"string with possible k/m/g postfix (opt=4k)",
	376	"string with range and postfix (opt=1k-4k)",
	377	"string with time postfix (opt=10s)",
	378	"string (opt=bla)",
	379	"string with dual range (opt=1k-4k,4k-8k)",
	380	"integer value (opt=100)",
	381	"no argument (opt)",
	382	};
29fc6afe	383	int found = 0;
fd28ca49 JA	384
	385	while (o->name) {
	386	int match = !strcmp(name, o->name);
	387
	388	if (show_all \|\| match) {
29fc6afe	389	found = 1;
fd28ca49	390	printf("%s: %s\n", o->name, o->help);
ee738499	391	if (match) {
fd28ca49	392	printf("type: %s\n", typehelp[o->type]);
ee738499 JA	393	if (o->def)
	394	printf("default: %s\n", o->def);
	395	else
	396	printf("defaults: no default\n");
	397	}
fd28ca49 JA	398	}
	399
	400	o++;
	401	}
	402
29fc6afe JA	403	if (found)
29fc6afe JA	404	return 0;
fd28ca49	405
29fc6afe JA	406	printf("No such command: %s\n", name);
29fc6afe JA	407	return 1;
fd28ca49	408	}
ee738499 JA	409
	410	void fill_default_options(void data, struct fio_option options)
	411	{
	412	struct fio_option *o = &options[0];
	413
	414	while (o->name) {
	415	if (o->def)
	416	handle_option(o, o->def, data);
	417	o++;
	418	}
	419	}