parse.h revision a4ed77fe07de1ca78cd44a6378dc20a2cd1ce7ad
1e1f365035a952233463d85d659bd960ba78f012eJens Axboe#ifndef FIO_PARSE_H
2e1f365035a952233463d85d659bd960ba78f012eJens Axboe#define FIO_PARSE_H
3e1f365035a952233463d85d659bd960ba78f012eJens Axboe
49f988e2ebb3bff7087cc9681a54bd7f0d0e42140Jens Axboe#include "flist.h"
59f988e2ebb3bff7087cc9681a54bd7f0d0e42140Jens Axboe
6e1f365035a952233463d85d659bd960ba78f012eJens Axboe/*
7e1f365035a952233463d85d659bd960ba78f012eJens Axboe * Option types
8e1f365035a952233463d85d659bd960ba78f012eJens Axboe */
9e1f365035a952233463d85d659bd960ba78f012eJens Axboeenum fio_opt_type {
1007b3232de97ac32a873f0b5d17c8f49c18ed3ae7Jens Axboe	FIO_OPT_INVALID = 0,
1107b3232de97ac32a873f0b5d17c8f49c18ed3ae7Jens Axboe	FIO_OPT_STR,
125f6ddf1e568d5014925a98da316d92f9e6e03eb4Jens Axboe	FIO_OPT_STR_MULTI,
13e1f365035a952233463d85d659bd960ba78f012eJens Axboe	FIO_OPT_STR_VAL,
14e1f365035a952233463d85d659bd960ba78f012eJens Axboe	FIO_OPT_STR_VAL_TIME,
15e1f365035a952233463d85d659bd960ba78f012eJens Axboe	FIO_OPT_STR_STORE,
16e1f365035a952233463d85d659bd960ba78f012eJens Axboe	FIO_OPT_RANGE,
17e1f365035a952233463d85d659bd960ba78f012eJens Axboe	FIO_OPT_INT,
1813335ddb0e304efa0fc96593dd1fd995ec6f68d7Jens Axboe	FIO_OPT_BOOL,
19833491908a1afd67d27ce79257de3a4d80143d9fYu-ju Hong	FIO_OPT_FLOAT_LIST,
20e1f365035a952233463d85d659bd960ba78f012eJens Axboe	FIO_OPT_STR_SET,
2115ca150e8dbfd68aa5beb479fcb3f07447417a04Jens Axboe	FIO_OPT_DEPRECATED,
22e1f365035a952233463d85d659bd960ba78f012eJens Axboe};
23e1f365035a952233463d85d659bd960ba78f012eJens Axboe
24e1f365035a952233463d85d659bd960ba78f012eJens Axboe/*
25b1ec1da670aab645e32303ea5ffaa1e5ca336936Jens Axboe * Match a possible value string with the integer option.
26b1ec1da670aab645e32303ea5ffaa1e5ca336936Jens Axboe */
27b1ec1da670aab645e32303ea5ffaa1e5ca336936Jens Axboestruct value_pair {
28b1ec1da670aab645e32303ea5ffaa1e5ca336936Jens Axboe	const char *ival;		/* string option */
29b1ec1da670aab645e32303ea5ffaa1e5ca336936Jens Axboe	unsigned int oval;		/* output value */
307837213b66e20a8d91e7069f5823852f42c41440Jens Axboe	const char *help;		/* help text for sub option */
315f6ddf1e568d5014925a98da316d92f9e6e03eb4Jens Axboe	int or;				/* OR value */
32c44b1ff54402c589e8f07436ec56efb4f8b1ac23Jens Axboe	void *cb;			/* sub-option callback */
33b1ec1da670aab645e32303ea5ffaa1e5ca336936Jens Axboe};
34b1ec1da670aab645e32303ea5ffaa1e5ca336936Jens Axboe
35c06c78c04c415bcb33350e8e56b924b75b4e93aaZhang, Yanmin#define OPT_LEN_MAX 	4096
36b1ec1da670aab645e32303ea5ffaa1e5ca336936Jens Axboe#define PARSE_MAX_VP	16
37b1ec1da670aab645e32303ea5ffaa1e5ca336936Jens Axboe
38b1ec1da670aab645e32303ea5ffaa1e5ca336936Jens Axboe/*
39e1f365035a952233463d85d659bd960ba78f012eJens Axboe * Option define
40e1f365035a952233463d85d659bd960ba78f012eJens Axboe */
41e1f365035a952233463d85d659bd960ba78f012eJens Axboestruct fio_option {
42ee738499877bb1ee913e839cb4a8d4edad2d52adJens Axboe	const char *name;		/* option name */
43e8b0e958cd219cabb1154e2b06036863a7d6dbd7Jens Axboe	const char *lname;		/* long option name */
4403b74b3ec5268e731ed7fcaef31c8c0655acd530Jens Axboe	const char *alias;		/* possible old allowed name */
45ee738499877bb1ee913e839cb4a8d4edad2d52adJens Axboe	enum fio_opt_type type;		/* option type */
46ee738499877bb1ee913e839cb4a8d4edad2d52adJens Axboe	unsigned int off1;		/* potential parameters */
47e1f365035a952233463d85d659bd960ba78f012eJens Axboe	unsigned int off2;
48f90eff5a414f6e8c16a51c3a7d9b5e077ab49aacJens Axboe	unsigned int off3;
49f90eff5a414f6e8c16a51c3a7d9b5e077ab49aacJens Axboe	unsigned int off4;
5002c6aad501477833c7e017eec0bb14f8e6957b68Jens Axboe	void *roff1, *roff2, *roff3, *roff4;
51ee738499877bb1ee913e839cb4a8d4edad2d52adJens Axboe	unsigned int maxval;		/* max and min value */
5263f29372bc1bd69b66816c96d88b9c0bd8f3d8b9Jens Axboe	int minval;
53833491908a1afd67d27ce79257de3a4d80143d9fYu-ju Hong	double maxfp;			/* max and min floating value */
54833491908a1afd67d27ce79257de3a4d80143d9fYu-ju Hong	double minfp;
5520eb06bd2aef37fa8dd314a110bb81c733115e15Jens Axboe	unsigned int interval;		/* client hint for suitable interval */
56833491908a1afd67d27ce79257de3a4d80143d9fYu-ju Hong	unsigned int maxlen;		/* max length */
5776a43db448f9fd5e9f1397428a433466d98e0d5dJens Axboe	int neg;			/* negate value stored */
583b8b7135602a4d3a7132fee10da9c1203ab643adJens Axboe	int prio;
59ee738499877bb1ee913e839cb4a8d4edad2d52adJens Axboe	void *cb;			/* callback */
60ee738499877bb1ee913e839cb4a8d4edad2d52adJens Axboe	const char *help;		/* help text for option */
61ee738499877bb1ee913e839cb4a8d4edad2d52adJens Axboe	const char *def;		/* default setting */
62f5b6bb85364fcb8b2ac8d922ca65afd9dfabc9bbJens Axboe	struct value_pair posval[PARSE_MAX_VP];/* possible values */
63afdf935261b23cdf08214e708133318548ddf2c4Jens Axboe	const char *parent;		/* parent option */
64d71c154c8b20a7ddca645d9854e640563f1b79c7Jens Axboe	int hide;			/* hide if parent isn't set */
65a4ed77fe07de1ca78cd44a6378dc20a2cd1ce7adJens Axboe	int hide_on_set;		/* hide on set, not on unset */
6690265353af8dbf1c43804996909777d4c1a5998eJens Axboe	const char *inverse;		/* if set, apply opposite action to this option */
6790265353af8dbf1c43804996909777d4c1a5998eJens Axboe	struct fio_option *inv_opt;	/* cached lookup */
6870a4c0c8417bba7c2e1e9a384b9acf226f5b9782Jens Axboe	int (*verify)(struct fio_option *, void *);
6907b3232de97ac32a873f0b5d17c8f49c18ed3ae7Jens Axboe	const char *prof_name;		/* only valid for specific profile */
70e8b0e958cd219cabb1154e2b06036863a7d6dbd7Jens Axboe	unsigned int category;		/* what type of option */
71e8b0e958cd219cabb1154e2b06036863a7d6dbd7Jens Axboe	unsigned int group;		/* who to group with */
7290265353af8dbf1c43804996909777d4c1a5998eJens Axboe	void *gui_data;
73e1f365035a952233463d85d659bd960ba78f012eJens Axboe};
74e1f365035a952233463d85d659bd960ba78f012eJens Axboe
75e1f365035a952233463d85d659bd960ba78f012eJens Axboetypedef int (str_cb_fn)(void *, char *);
76e1f365035a952233463d85d659bd960ba78f012eJens Axboe
77de890a1e48d40238dac69f302708dde8719de240Steven Langextern int parse_option(char *, const char *, struct fio_option *, struct fio_option **, void *);
783b8b7135602a4d3a7132fee10da9c1203ab643adJens Axboeextern void sort_options(char **, struct fio_option *, int);
7907b3232de97ac32a873f0b5d17c8f49c18ed3ae7Jens Axboeextern int parse_cmd_option(const char *t, const char *l, struct fio_option *, void *);
8007b3232de97ac32a873f0b5d17c8f49c18ed3ae7Jens Axboeextern int show_cmd_help(struct fio_option *, const char *);
81ee738499877bb1ee913e839cb4a8d4edad2d52adJens Axboeextern void fill_default_options(void *, struct fio_option *);
829f988e2ebb3bff7087cc9681a54bd7f0d0e42140Jens Axboeextern void option_init(struct fio_option *);
8313335ddb0e304efa0fc96593dd1fd995ec6f68d7Jens Axboeextern void options_init(struct fio_option *);
847e356b2dee2e86f3684424fc6e903f1ef9f00ef4Jens Axboeextern void options_free(struct fio_option *, void *);
85e1f365035a952233463d85d659bd960ba78f012eJens Axboe
86e1f365035a952233463d85d659bd960ba78f012eJens Axboeextern void strip_blank_front(char **);
87e1f365035a952233463d85d659bd960ba78f012eJens Axboeextern void strip_blank_end(char *);
886925dd356191bc40e8a1ebc8fd92a40b476658c3Jens Axboeextern int str_to_decimal(const char *, long long *, int, void *);
899af4a24408ea7d4cea084a4fe214b81145cc36acJens Axboeextern int check_str_bytes(const char *p, long long *val, void *data);
90e1f365035a952233463d85d659bd960ba78f012eJens Axboe
91e1f365035a952233463d85d659bd960ba78f012eJens Axboe/*
92e1f365035a952233463d85d659bd960ba78f012eJens Axboe * Handlers for the options
93e1f365035a952233463d85d659bd960ba78f012eJens Axboe */
94b46928282e0a890f49250e79b81af773a2b7108fJens Axboetypedef int (fio_opt_str_fn)(void *, const char *);
9563f29372bc1bd69b66816c96d88b9c0bd8f3d8b9Jens Axboetypedef int (fio_opt_str_val_fn)(void *, long long *);
9663f29372bc1bd69b66816c96d88b9c0bd8f3d8b9Jens Axboetypedef int (fio_opt_int_fn)(void *, int *);
97e1f365035a952233463d85d659bd960ba78f012eJens Axboetypedef int (fio_opt_str_set_fn)(void *);
98e1f365035a952233463d85d659bd960ba78f012eJens Axboe
99e1f365035a952233463d85d659bd960ba78f012eJens Axboe#define td_var(start, offset)	((void *) start + (offset))
100e1f365035a952233463d85d659bd960ba78f012eJens Axboe
1010e9f7fac2a501f2baeedd11446e9fe102720c27dJens Axboe#ifndef min
1020e9f7fac2a501f2baeedd11446e9fe102720c27dJens Axboe#define min(a, b)	((a) < (b) ? (a) : (b))
1030e9f7fac2a501f2baeedd11446e9fe102720c27dJens Axboe#endif
1040e9f7fac2a501f2baeedd11446e9fe102720c27dJens Axboe#ifndef max
1050e9f7fac2a501f2baeedd11446e9fe102720c27dJens Axboe#define max(a, b)	((a) > (b) ? (a) : (b))
1060e9f7fac2a501f2baeedd11446e9fe102720c27dJens Axboe#endif
1070e9f7fac2a501f2baeedd11446e9fe102720c27dJens Axboe
1087bb591020669b7266c57108f2a68b48a03ae72eeJens Axboestatic inline int parse_is_percent(unsigned long long val)
1097bb591020669b7266c57108f2a68b48a03ae72eeJens Axboe{
1107bb591020669b7266c57108f2a68b48a03ae72eeJens Axboe	return val <= -1ULL && val >= (-1ULL - 100ULL);
1117bb591020669b7266c57108f2a68b48a03ae72eeJens Axboe}
1127bb591020669b7266c57108f2a68b48a03ae72eeJens Axboe
113e1f365035a952233463d85d659bd960ba78f012eJens Axboe#endif
114