blob: 9cda559550c9f836f5b17aaf51641b8e87736b69 [file] [log] [blame]
Jens Axboee1f36502006-10-27 10:54:08 +02001#ifndef FIO_PARSE_H
2#define FIO_PARSE_H
3
Jens Axboe9f988e22010-03-04 10:42:38 +01004#include "flist.h"
5
Jens Axboee1f36502006-10-27 10:54:08 +02006/*
7 * Option types
8 */
9enum fio_opt_type {
Jens Axboe07b32322010-03-05 09:48:44 +010010 FIO_OPT_INVALID = 0,
11 FIO_OPT_STR,
Jens Axboee1f36502006-10-27 10:54:08 +020012 FIO_OPT_STR_VAL,
13 FIO_OPT_STR_VAL_TIME,
14 FIO_OPT_STR_STORE,
15 FIO_OPT_RANGE,
16 FIO_OPT_INT,
Jens Axboe13335dd2007-01-10 13:14:02 +010017 FIO_OPT_BOOL,
Jens Axboee1f36502006-10-27 10:54:08 +020018 FIO_OPT_STR_SET,
Jens Axboe15ca1502008-04-07 09:26:02 +020019 FIO_OPT_DEPRECATED,
Jens Axboee1f36502006-10-27 10:54:08 +020020};
21
22/*
Jens Axboeb1ec1da2007-02-23 10:29:16 +010023 * Match a possible value string with the integer option.
24 */
25struct value_pair {
26 const char *ival; /* string option */
27 unsigned int oval; /* output value */
Jens Axboe78372132007-03-14 13:24:07 +010028 const char *help; /* help text for sub option */
Jens Axboeb1ec1da2007-02-23 10:29:16 +010029};
30
Zhang, Yanminc06c78c2010-03-03 08:26:30 +010031#define OPT_LEN_MAX 4096
Jens Axboeb1ec1da2007-02-23 10:29:16 +010032#define PARSE_MAX_VP 16
33
34/*
Jens Axboee1f36502006-10-27 10:54:08 +020035 * Option define
36 */
37struct fio_option {
Jens Axboeee738492007-01-10 11:23:16 +010038 const char *name; /* option name */
Jens Axboe03b74b32007-01-11 11:04:31 +010039 const char *alias; /* possible old allowed name */
Jens Axboeee738492007-01-10 11:23:16 +010040 enum fio_opt_type type; /* option type */
41 unsigned int off1; /* potential parameters */
Jens Axboee1f36502006-10-27 10:54:08 +020042 unsigned int off2;
Jens Axboef90eff52006-11-06 11:08:21 +010043 unsigned int off3;
44 unsigned int off4;
Jens Axboe02c6aad2010-03-04 13:49:11 +010045 void *roff1, *roff2, *roff3, *roff4;
Jens Axboeee738492007-01-10 11:23:16 +010046 unsigned int maxval; /* max and min value */
Jens Axboe63f29372007-01-10 13:20:09 +010047 int minval;
Jens Axboe76a43db2007-01-11 13:24:44 +010048 int neg; /* negate value stored */
Jens Axboe3b8b7132008-06-10 19:46:23 +020049 int prio;
Jens Axboeee738492007-01-10 11:23:16 +010050 void *cb; /* callback */
51 const char *help; /* help text for option */
52 const char *def; /* default setting */
Jens Axboef5b6bb82010-03-05 10:09:59 +010053 struct value_pair posval[PARSE_MAX_VP];/* possible values */
Jens Axboeafdf9352007-07-31 16:14:34 +020054 const char *parent; /* parent option */
Jens Axboe70a4c0c2009-07-01 09:24:05 +020055 int (*verify)(struct fio_option *, void *);
Jens Axboe07b32322010-03-05 09:48:44 +010056 const char *prof_name; /* only valid for specific profile */
Jens Axboee1f36502006-10-27 10:54:08 +020057};
58
59typedef int (str_cb_fn)(void *, char *);
60
Jens Axboe07b32322010-03-05 09:48:44 +010061extern int parse_option(const char *, struct fio_option *, void *);
Jens Axboe3b8b7132008-06-10 19:46:23 +020062extern void sort_options(char **, struct fio_option *, int);
Jens Axboe07b32322010-03-05 09:48:44 +010063extern int parse_cmd_option(const char *t, const char *l, struct fio_option *, void *);
64extern int show_cmd_help(struct fio_option *, const char *);
Jens Axboeee738492007-01-10 11:23:16 +010065extern void fill_default_options(void *, struct fio_option *);
Jens Axboe9f988e22010-03-04 10:42:38 +010066extern void option_init(struct fio_option *);
Jens Axboe13335dd2007-01-10 13:14:02 +010067extern void options_init(struct fio_option *);
Jens Axboee1f36502006-10-27 10:54:08 +020068
69extern void strip_blank_front(char **);
70extern void strip_blank_end(char *);
Jens Axboed6978a32009-07-18 21:04:09 +020071extern int str_to_decimal(const char *, long long *, int, void *);
Jens Axboee1f36502006-10-27 10:54:08 +020072
73/*
74 * Handlers for the options
75 */
Jens Axboeb4692822006-10-27 13:43:22 +020076typedef int (fio_opt_str_fn)(void *, const char *);
Jens Axboe63f29372007-01-10 13:20:09 +010077typedef int (fio_opt_str_val_fn)(void *, long long *);
78typedef int (fio_opt_int_fn)(void *, int *);
Jens Axboee1f36502006-10-27 10:54:08 +020079typedef int (fio_opt_str_set_fn)(void *);
80
81#define td_var(start, offset) ((void *) start + (offset))
82
Jens Axboe0e9f7fa2007-03-01 14:05:30 +010083#ifndef min
84#define min(a, b) ((a) < (b) ? (a) : (b))
85#endif
86#ifndef max
87#define max(a, b) ((a) > (b) ? (a) : (b))
88#endif
89
Jens Axboee1f36502006-10-27 10:54:08 +020090#endif