blob: 4e8124f853b3fa9a36f1c884416d48a4a971b78a [file] [log] [blame]
Jens Axboee1f36502006-10-27 10:54:08 +02001#ifndef FIO_PARSE_H
2#define FIO_PARSE_H
3
4/*
5 * Option types
6 */
7enum fio_opt_type {
8 FIO_OPT_STR = 0,
9 FIO_OPT_STR_VAL,
Jens Axboe75e6f362006-11-03 08:17:09 +010010 FIO_OPT_STR_VAL_INT,
Jens Axboee1f36502006-10-27 10:54:08 +020011 FIO_OPT_STR_VAL_TIME,
12 FIO_OPT_STR_STORE,
13 FIO_OPT_RANGE,
14 FIO_OPT_INT,
Jens Axboe13335dd2007-01-10 13:14:02 +010015 FIO_OPT_BOOL,
Jens Axboee1f36502006-10-27 10:54:08 +020016 FIO_OPT_STR_SET,
Jens Axboe15ca1502008-04-07 09:26:02 +020017 FIO_OPT_DEPRECATED,
Jens Axboee1f36502006-10-27 10:54:08 +020018};
19
20/*
Jens Axboeb1ec1da2007-02-23 10:29:16 +010021 * Match a possible value string with the integer option.
22 */
23struct value_pair {
24 const char *ival; /* string option */
25 unsigned int oval; /* output value */
Jens Axboe78372132007-03-14 13:24:07 +010026 const char *help; /* help text for sub option */
Jens Axboeb1ec1da2007-02-23 10:29:16 +010027};
28
29#define PARSE_MAX_VP 16
30
31/*
Jens Axboee1f36502006-10-27 10:54:08 +020032 * Option define
33 */
34struct fio_option {
Jens Axboeee738492007-01-10 11:23:16 +010035 const char *name; /* option name */
Jens Axboe03b74b32007-01-11 11:04:31 +010036 const char *alias; /* possible old allowed name */
Jens Axboeee738492007-01-10 11:23:16 +010037 enum fio_opt_type type; /* option type */
38 unsigned int off1; /* potential parameters */
Jens Axboee1f36502006-10-27 10:54:08 +020039 unsigned int off2;
Jens Axboef90eff52006-11-06 11:08:21 +010040 unsigned int off3;
41 unsigned int off4;
Jens Axboeee738492007-01-10 11:23:16 +010042 unsigned int maxval; /* max and min value */
Jens Axboe63f29372007-01-10 13:20:09 +010043 int minval;
Jens Axboe76a43db2007-01-11 13:24:44 +010044 int neg; /* negate value stored */
Jens Axboeee738492007-01-10 11:23:16 +010045 void *cb; /* callback */
46 const char *help; /* help text for option */
47 const char *def; /* default setting */
Jens Axboeb1ec1da2007-02-23 10:29:16 +010048 const struct value_pair posval[PARSE_MAX_VP];/* possible values */
Jens Axboeafdf9352007-07-31 16:14:34 +020049 const char *parent; /* parent option */
Jens Axboee1f36502006-10-27 10:54:08 +020050};
51
52typedef int (str_cb_fn)(void *, char *);
53
54extern int parse_option(const char *, struct fio_option *, void *);
Jens Axboeb4692822006-10-27 13:43:22 +020055extern int parse_cmd_option(const char *t, const char *l, struct fio_option *, void *);
Jens Axboefd28ca42007-01-09 21:20:13 +010056extern int show_cmd_help(struct fio_option *, const char *);
Jens Axboeee738492007-01-10 11:23:16 +010057extern void fill_default_options(void *, struct fio_option *);
Jens Axboe13335dd2007-01-10 13:14:02 +010058extern void options_init(struct fio_option *);
Jens Axboee1f36502006-10-27 10:54:08 +020059
60extern void strip_blank_front(char **);
61extern void strip_blank_end(char *);
Jens Axboe564ca972007-12-14 12:21:19 +010062extern int str_to_decimal(const char *, long long *, int);
Jens Axboee1f36502006-10-27 10:54:08 +020063
64/*
65 * Handlers for the options
66 */
Jens Axboeb4692822006-10-27 13:43:22 +020067typedef int (fio_opt_str_fn)(void *, const char *);
Jens Axboe63f29372007-01-10 13:20:09 +010068typedef int (fio_opt_str_val_fn)(void *, long long *);
69typedef int (fio_opt_int_fn)(void *, int *);
Jens Axboee1f36502006-10-27 10:54:08 +020070typedef int (fio_opt_str_set_fn)(void *);
71
72#define td_var(start, offset) ((void *) start + (offset))
73
Jens Axboe0e9f7fa2007-03-01 14:05:30 +010074#ifndef min
75#define min(a, b) ((a) < (b) ? (a) : (b))
76#endif
77#ifndef max
78#define max(a, b) ((a) > (b) ? (a) : (b))
79#endif
80
Jens Axboee1f36502006-10-27 10:54:08 +020081#endif