[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, long long *val, int kilo)
{
	int len;

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

	*val = strtol(str, NULL, 10);
	if (*val == LONG_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, long long *val)
{
	return str_to_decimal(p, val, 1);
}

static int check_str_time(const char *p, 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, 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, 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)
{
	int il, *ilp;
	long long ull, *ullp;
	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) {
			fprintf(stderr, "max value out of range: %lld (%d max)\n", ull, o->maxval);
			return 1;
		}
		if (o->minval && ull < o->minval) {
			fprintf(stderr, "min value out of range: %lld (%d min)\n", ull, o->minval);
			return 1;
		}

		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:
	case FIO_OPT_BOOL: {
		fio_opt_int_fn *fn = o->cb;

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

		if (o->maxval && il > (int) o->maxval) {
			fprintf(stderr, "max value out of range: %d (%d max)\n", il, o->maxval);
			return 1;
		}
		if (o->minval && il < o->minval) {
			fprintf(stderr, "min value out of range: %d (%d min)\n", il, o->minval);
			return 1;
		}

		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;
}

static void show_option_range(struct fio_option *o)
{
	if (!o->minval && !o->maxval)
		return;

	printf("%16s: min=%d, max=%d\n", "range", o->minval, o->maxval);
}

static void show_option_values(struct fio_option *o)
{
	const char *msg;
	int i = 0;

	if (!o->posval)
		return;

	do {
		msg = o->posval[i];
		if (!msg)
			break;

		if (!i)
			printf("%16s: ", "valid values");

		printf("%s,", msg);
		i++;
	} while (1);

	if (i)
		printf("\n");
}

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)",
		"boolean value (opt=1)",
		"no argument (opt)",
	};
	int found = 0;

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

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

		o++;
	}

	if (found)
		return 0;

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

/*
 * Handle parsing of default parameters.
 */
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++;
	}
}

/*
 * Sanitize the options structure. For now it just sets min/max for bool
 * values.
 */
void options_init(struct fio_option *options)
{
	struct fio_option *o = &options[0];

	while (o->name) {
		if (o->type == FIO_OPT_BOOL) {
			o->minval = 0;
			o->maxval = 1;
		}
		o++;
	}
}
Commit	Line	Data
	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	/*
	49	* convert string into decimal value, noting any size suffix
	50	*/
	51	static int str_to_decimal(const char str, long long val, int kilo)
	52	{
	53	int len;
	54
	55	len = strlen(str);
	56	if (!len)
	57	return 1;
	58
	59	*val = strtol(str, NULL, 10);
	60	if (*val == LONG_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]);
	67
	68	return 0;
	69	}
	70
	71	static int check_str_bytes(const char p, long long val)
	72	{
	73	return str_to_decimal(p, val, 1);
	74	}
	75
	76	static int check_str_time(const char p, long long val)
	77	{
	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
	99	static int check_range_bytes(const char str, long val)
	100	{
	101	char suffix;
	102
	103	if (!strlen(str))
	104	return 1;
	105
	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
	117	static int check_int(const char p, int val)
	118	{
	119	if (!strlen(p))
	120	return 1;
	121	if (sscanf(p, "%u", val) == 1)
	122	return 0;
	123
	124	return 1;
	125	}
	126
	127	static struct fio_option find_option(struct fio_option options,
	128	const char *opt)
	129	{
	130	struct fio_option *o = &options[0];
	131
	132	while (o->name) {
	133	if (!strcmp(o->name, opt))
	134	return o;
	135
	136	o++;
	137	}
	138
	139	return NULL;
	140	}
	141
	142	#define val_store(ptr, val, off, data) \
	143	do { \
	144	ptr = td_var((data), (off)); \
	145	*ptr = (val); \
	146	} while (0)
	147
	148	static int __handle_option(struct fio_option o, const char ptr, void *data,
	149	int first, int more)
	150	{
	151	int il, *ilp;
	152	long long ull, *ullp;
	153	long ul1, ul2;
	154	char **cp;
	155	int ret = 0, is_time = 0;
	156
	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
	162	switch (o->type) {
	163	case FIO_OPT_STR: {
	164	fio_opt_str_fn *fn = o->cb;
	165
	166	ret = fn(data, ptr);
	167	break;
	168	}
	169	case FIO_OPT_STR_VAL_TIME:
	170	is_time = 1;
	171	case FIO_OPT_STR_VAL:
	172	case FIO_OPT_STR_VAL_INT: {
	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
	183	if (o->maxval && ull > o->maxval) {
	184	fprintf(stderr, "max value out of range: %lld (%d max)\n", ull, o->maxval);
	185	return 1;
	186	}
	187	if (o->minval && ull < o->minval) {
	188	fprintf(stderr, "min value out of range: %lld (%d min)\n", ull, o->minval);
	189	return 1;
	190	}
	191
	192	if (fn)
	193	ret = fn(data, &ull);
	194	else {
	195	if (o->type == FIO_OPT_STR_VAL_INT) {
	196	if (first)
	197	val_store(ilp, ull, o->off1, data);
	198	if (!more && o->off2)
	199	val_store(ilp, ull, o->off2, data);
	200	} else {
	201	if (first)
	202	val_store(ullp, ull, o->off1, data);
	203	if (!more && o->off2)
	204	val_store(ullp, ull, o->off2, data);
	205	}
	206	}
	207	break;
	208	}
	209	case FIO_OPT_STR_STORE:
	210	cp = td_var(data, o->off1);
	211	*cp = strdup(ptr);
	212	break;
	213	case FIO_OPT_RANGE: {
	214	char tmp[128];
	215	char p1, p2;
	216
	217	strncpy(tmp, ptr, sizeof(tmp) - 1);
	218
	219	p1 = strchr(tmp, '-');
	220	if (!p1) {
	221	ret = 1;
	222	break;
	223	}
	224
	225	p2 = p1 + 1;
	226	*p1 = '\0';
	227	p1 = tmp;
	228
	229	ret = 1;
	230	if (!check_range_bytes(p1, &ul1) && !check_range_bytes(p2, &ul2)) {
	231	ret = 0;
	232	if (ul1 > ul2) {
	233	unsigned long foo = ul1;
	234
	235	ul1 = ul2;
	236	ul2 = foo;
	237	}
	238
	239	if (first) {
	240	val_store(ilp, ul1, o->off1, data);
	241	val_store(ilp, ul2, o->off2, data);
	242	}
	243	if (!more && o->off3 && o->off4) {
	244	val_store(ilp, ul1, o->off3, data);
	245	val_store(ilp, ul2, o->off4, data);
	246	}
	247	}
	248
	249	break;
	250	}
	251	case FIO_OPT_INT:
	252	case FIO_OPT_BOOL: {
	253	fio_opt_int_fn *fn = o->cb;
	254
	255	ret = check_int(ptr, &il);
	256	if (ret)
	257	break;
	258
	259	if (o->maxval && il > (int) o->maxval) {
	260	fprintf(stderr, "max value out of range: %d (%d max)\n", il, o->maxval);
	261	return 1;
	262	}
	263	if (o->minval && il < o->minval) {
	264	fprintf(stderr, "min value out of range: %d (%d min)\n", il, o->minval);
	265	return 1;
	266	}
	267
	268	if (fn)
	269	ret = fn(data, &il);
	270	else {
	271	if (first)
	272	val_store(ilp, il, o->off1, data);
	273	if (!more && o->off2)
	274	val_store(ilp, il, o->off2, data);
	275	}
	276	break;
	277	}
	278	case FIO_OPT_STR_SET: {
	279	fio_opt_str_set_fn *fn = o->cb;
	280
	281	if (fn)
	282	ret = fn(data);
	283	else {
	284	if (first)
	285	val_store(ilp, 1, o->off1, data);
	286	if (!more && o->off2)
	287	val_store(ilp, 1, o->off2, data);
	288	}
	289	break;
	290	}
	291	default:
	292	fprintf(stderr, "Bad option type %u\n", o->type);
	293	ret = 1;
	294	}
	295
	296	return ret;
	297	}
	298
	299	static int handle_option(struct fio_option o, const char ptr, void *data)
	300	{
	301	const char *ptr2 = NULL;
	302	int r1, r2;
	303
	304	/*
	305	* See if we have a second set of parameters, hidden after a comma.
	306	* Do this before parsing the first round, to check if we should
	307	* copy set 1 options to set 2.
	308	*/
	309	if (ptr)
	310	ptr2 = strchr(ptr, ',');
	311
	312	/*
	313	* Don't return early if parsing the first option fails - if
	314	* we are doing multiple arguments, we can allow the first one
	315	* being empty.
	316	*/
	317	r1 = __handle_option(o, ptr, data, 1, !!ptr2);
	318
	319	if (!ptr2)
	320	return r1;
	321
	322	ptr2++;
	323	r2 = __handle_option(o, ptr2, data, 0, 0);
	324
	325	return r1 && r2;
	326	}
	327
	328	int parse_cmd_option(const char opt, const char val,
	329	struct fio_option options, void data)
	330	{
	331	struct fio_option *o;
	332
	333	o = find_option(options, opt);
	334	if (!o) {
	335	fprintf(stderr, "Bad option %s\n", opt);
	336	return 1;
	337	}
	338
	339	if (!handle_option(o, val, data))
	340	return 0;
	341
	342	fprintf(stderr, "fio: failed parsing %s=%s\n", opt, val);
	343	return 1;
	344	}
	345
	346	int parse_option(const char opt, struct fio_option options, void *data)
	347	{
	348	struct fio_option *o;
	349	char pre, post;
	350	char tmp[64];
	351
	352	strncpy(tmp, opt, sizeof(tmp) - 1);
	353
	354	pre = strchr(tmp, '=');
	355	if (pre) {
	356	post = pre;
	357	*pre = '\0';
	358	pre = tmp;
	359	post++;
	360	o = find_option(options, pre);
	361	} else {
	362	o = find_option(options, tmp);
	363	post = NULL;
	364	}
	365
	366	if (!o) {
	367	fprintf(stderr, "Bad option %s\n", tmp);
	368	return 1;
	369	}
	370
	371	if (!handle_option(o, post, data))
	372	return 0;
	373
	374	fprintf(stderr, "fio: failed parsing %s\n", opt);
	375	return 1;
	376	}
	377
	378	static void show_option_range(struct fio_option *o)
	379	{
	380	if (!o->minval && !o->maxval)
	381	return;
	382
	383	printf("%16s: min=%d, max=%d\n", "range", o->minval, o->maxval);
	384	}
	385
	386	static void show_option_values(struct fio_option *o)
	387	{
	388	const char *msg;
	389	int i = 0;
	390
	391	if (!o->posval)
	392	return;
	393
	394	do {
	395	msg = o->posval[i];
	396	if (!msg)
	397	break;
	398
	399	if (!i)
	400	printf("%16s: ", "valid values");
	401
	402	printf("%s,", msg);
	403	i++;
	404	} while (1);
	405
	406	if (i)
	407	printf("\n");
	408	}
	409
	410	int show_cmd_help(struct fio_option options, const char name)
	411	{
	412	int show_all = !strcmp(name, "all");
	413	struct fio_option *o = &options[0];
	414	const char *typehelp[] = {
	415	"string (opt=bla)",
	416	"string with possible k/m/g postfix (opt=4k)",
	417	"string with range and postfix (opt=1k-4k)",
	418	"string with time postfix (opt=10s)",
	419	"string (opt=bla)",
	420	"string with dual range (opt=1k-4k,4k-8k)",
	421	"integer value (opt=100)",
	422	"boolean value (opt=1)",
	423	"no argument (opt)",
	424	};
	425	int found = 0;
	426
	427	while (o->name) {
	428	int match = !strcmp(name, o->name);
	429
	430	if (show_all \|\| match) {
	431	found = 1;
	432	printf("%16s: %s\n", o->name, o->help);
	433	if (match) {
	434	printf("%16s: %s\n", "type", typehelp[o->type]);
	435	printf("%16s: %s\n", "default", o->def ? o->def : "no default");
	436	show_option_range(o);
	437	show_option_values(o);
	438	}
	439	}
	440
	441	o++;
	442	}
	443
	444	if (found)
	445	return 0;
	446
	447	printf("No such command: %s\n", name);
	448	return 1;
	449	}
	450
	451	/*
	452	* Handle parsing of default parameters.
	453	*/
	454	void fill_default_options(void data, struct fio_option options)
	455	{
	456	struct fio_option *o = &options[0];
	457
	458	while (o->name) {
	459	if (o->def)
	460	handle_option(o, o->def, data);
	461	o++;
	462	}
	463	}
	464
	465	/*
	466	* Sanitize the options structure. For now it just sets min/max for bool
	467	* values.
	468	*/
	469	void options_init(struct fio_option *options)
	470	{
	471	struct fio_option *o = &options[0];
	472
	473	while (o->name) {
	474	if (o->type == FIO_OPT_BOOL) {
	475	o->minval = 0;
	476	o->maxval = 1;
	477	}
	478	o++;
	479	}
	480	}