Add section 9 to HOWTO table of contents.
[fio.git] / parse.h
CommitLineData
e1f36503
JA
1#ifndef FIO_PARSE_H
2#define FIO_PARSE_H
3
9f988e2e
JA
4#include "flist.h"
5
e1f36503
JA
6/*
7 * Option types
8 */
9enum fio_opt_type {
07b3232d
JA
10 FIO_OPT_INVALID = 0,
11 FIO_OPT_STR,
5f6ddf1e 12 FIO_OPT_STR_MULTI,
e1f36503
JA
13 FIO_OPT_STR_VAL,
14 FIO_OPT_STR_VAL_TIME,
15 FIO_OPT_STR_STORE,
16 FIO_OPT_RANGE,
17 FIO_OPT_INT,
13335ddb 18 FIO_OPT_BOOL,
83349190 19 FIO_OPT_FLOAT_LIST,
e1f36503 20 FIO_OPT_STR_SET,
15ca150e 21 FIO_OPT_DEPRECATED,
e1f36503
JA
22};
23
b1ec1da6
JA
24/*
25 * Match a possible value string with the integer option.
26 */
27struct value_pair {
28 const char *ival; /* string option */
29 unsigned int oval; /* output value */
7837213b 30 const char *help; /* help text for sub option */
5f6ddf1e 31 int or; /* OR value */
c44b1ff5 32 void *cb; /* sub-option callback */
b1ec1da6
JA
33};
34
c06c78c0 35#define OPT_LEN_MAX 4096
3ae4f4af 36#define PARSE_MAX_VP 24
b1ec1da6 37
e1f36503
JA
38/*
39 * Option define
40 */
41struct fio_option {
ee738499 42 const char *name; /* option name */
03b74b3e 43 const char *alias; /* possible old allowed name */
ee738499
JA
44 enum fio_opt_type type; /* option type */
45 unsigned int off1; /* potential parameters */
e1f36503 46 unsigned int off2;
f90eff5a
JA
47 unsigned int off3;
48 unsigned int off4;
6eaf09d6
SL
49 unsigned int off5;
50 unsigned int off6;
51 void *roff1, *roff2, *roff3, *roff4, *roff5, *roff6;
ee738499 52 unsigned int maxval; /* max and min value */
63f29372 53 int minval;
83349190
YH
54 double maxfp; /* max and min floating value */
55 double minfp;
56 unsigned int maxlen; /* max length */
76a43db4 57 int neg; /* negate value stored */
3b8b7135 58 int prio;
ee738499
JA
59 void *cb; /* callback */
60 const char *help; /* help text for option */
61 const char *def; /* default setting */
f5b6bb85 62 struct value_pair posval[PARSE_MAX_VP];/* possible values */
afdf9352 63 const char *parent; /* parent option */
70a4c0c8 64 int (*verify)(struct fio_option *, void *);
07b3232d 65 const char *prof_name; /* only valid for specific profile */
e1f36503
JA
66};
67
68typedef int (str_cb_fn)(void *, char *);
69
de890a1e 70extern int parse_option(char *, const char *, struct fio_option *, struct fio_option **, void *);
3b8b7135 71extern void sort_options(char **, struct fio_option *, int);
07b3232d
JA
72extern int parse_cmd_option(const char *t, const char *l, struct fio_option *, void *);
73extern int show_cmd_help(struct fio_option *, const char *);
ee738499 74extern void fill_default_options(void *, struct fio_option *);
9f988e2e 75extern void option_init(struct fio_option *);
13335ddb 76extern void options_init(struct fio_option *);
7e356b2d 77extern void options_free(struct fio_option *, void *);
e1f36503
JA
78
79extern void strip_blank_front(char **);
80extern void strip_blank_end(char *);
6925dd35 81extern int str_to_decimal(const char *, long long *, int, void *);
e25839d4 82extern int str_to_float(const char *str, double *val);
e1f36503
JA
83
84/*
85 * Handlers for the options
86 */
b4692828 87typedef int (fio_opt_str_fn)(void *, const char *);
63f29372
JA
88typedef int (fio_opt_str_val_fn)(void *, long long *);
89typedef int (fio_opt_int_fn)(void *, int *);
e1f36503
JA
90typedef int (fio_opt_str_set_fn)(void *);
91
92#define td_var(start, offset) ((void *) start + (offset))
93
7bb59102
JA
94static inline int parse_is_percent(unsigned long long val)
95{
96 return val <= -1ULL && val >= (-1ULL - 100ULL);
97}
98
e1f36503 99#endif