Merge branch 'master' of https://github.com/bvanassche/fio
[fio.git] / parse.c
CommitLineData
cb2c86fd
JA
1/*
2 * This file contains the ini and command liner parser main.
3 */
4#include <stdio.h>
5#include <stdlib.h>
cb2c86fd
JA
6#include <ctype.h>
7#include <string.h>
8#include <errno.h>
9#include <limits.h>
ab9461ea 10#include <float.h>
cb2c86fd 11
c26438ad 12#include "compiler/compiler.h"
cb2c86fd 13#include "parse.h"
a3d741fa 14#include "debug.h"
3d2d14bc 15#include "log.h"
9f988e2e 16#include "options.h"
d220c761 17#include "optgroup.h"
e25839d4 18#include "minmax.h"
fd112d34 19#include "lib/ieee754.h"
0f38bbef 20#include "lib/pow2.h"
cb2c86fd 21
b470a02c
SC
22#ifdef CONFIG_ARITHMETIC
23#include "y.tab.h"
24#endif
25
c26438ad
JA
26static const char *opt_type_names[] = {
27 "OPT_INVALID",
28 "OPT_STR",
5fff9543 29 "OPT_STR_ULL",
c26438ad
JA
30 "OPT_STR_MULTI",
31 "OPT_STR_VAL",
32 "OPT_STR_VAL_TIME",
33 "OPT_STR_STORE",
34 "OPT_RANGE",
35 "OPT_INT",
5fff9543 36 "OPT_ULL",
c26438ad
JA
37 "OPT_BOOL",
38 "OPT_FLOAT_LIST",
39 "OPT_STR_SET",
8f39afa7 40 "OPT_STR_VAL_ZONE",
c26438ad 41 "OPT_DEPRECATED",
c47537ee 42 "OPT_SOFT_DEPRECATED",
c26438ad
JA
43 "OPT_UNSUPPORTED",
44};
45
9109883a 46static const struct fio_option *__fio_options;
3b8b7135 47
f085737f
JA
48static int vp_cmp(const void *p1, const void *p2)
49{
50 const struct value_pair *vp1 = p1;
51 const struct value_pair *vp2 = p2;
52
53 return strlen(vp2->ival) - strlen(vp1->ival);
54}
55
9109883a 56static void posval_sort(const struct fio_option *o, struct value_pair *vpmap)
f085737f
JA
57{
58 const struct value_pair *vp;
59 int entries;
60
61 memset(vpmap, 0, PARSE_MAX_VP * sizeof(struct value_pair));
62
63 for (entries = 0; entries < PARSE_MAX_VP; entries++) {
64 vp = &o->posval[entries];
65 if (!vp->ival || vp->ival[0] == '\0')
66 break;
67
68 memcpy(&vpmap[entries], vp, sizeof(*vp));
69 }
70
71 qsort(vpmap, entries, sizeof(struct value_pair), vp_cmp);
72}
73
9109883a 74static void show_option_range(const struct fio_option *o,
34a3a855 75 ssize_t (*logger)(const char *format, ...))
b1ec1da6 76{
3c037bcf 77 if (o->type == FIO_OPT_FLOAT_LIST) {
a1e070c8 78 const char *sep = "";
45b3e8d7 79 if (!o->minfp && !o->maxfp)
83349190
YH
80 return;
81
a1e070c8
BVA
82 logger("%20s: ", "range");
83 if (o->minfp != DBL_MIN) {
84 logger("min=%f", o->minfp);
85 sep = ", ";
86 }
ab9461ea 87 if (o->maxfp != DBL_MAX)
a1e070c8 88 logger("%smax=%f", sep, o->maxfp);
06b0be6e 89 logger("\n");
3c037bcf 90 } else if (!o->posval[0].ival) {
83349190
YH
91 if (!o->minval && !o->maxval)
92 return;
b1ec1da6 93
06b0be6e 94 logger("%20s: min=%d", "range", o->minval);
83349190 95 if (o->maxval)
06b0be6e
JA
96 logger(", max=%d", o->maxval);
97 logger("\n");
83349190 98 }
b1ec1da6
JA
99}
100
9109883a 101static void show_option_values(const struct fio_option *o)
b1ec1da6 102{
a3073f4a 103 int i;
b1ec1da6 104
a3073f4a 105 for (i = 0; i < PARSE_MAX_VP; i++) {
7837213b 106 const struct value_pair *vp = &o->posval[i];
b1ec1da6 107
7837213b 108 if (!vp->ival)
a3073f4a 109 continue;
b1ec1da6 110
06b0be6e 111 log_info("%20s: %-10s", i == 0 ? "valid values" : "", vp->ival);
7837213b 112 if (vp->help)
06b0be6e
JA
113 log_info(" %s", vp->help);
114 log_info("\n");
a3073f4a 115 }
b1ec1da6
JA
116
117 if (i)
06b0be6e 118 log_info("\n");
b1ec1da6
JA
119}
120
9109883a 121static void show_option_help(const struct fio_option *o, int is_err)
d447a8c2
JA
122{
123 const char *typehelp[] = {
cbd6ce9c
BVA
124 [FIO_OPT_INVALID] = "invalid",
125 [FIO_OPT_STR] = "string (opt=bla)",
126 [FIO_OPT_STR_ULL] = "string (opt=bla)",
127 [FIO_OPT_STR_MULTI] = "string with possible k/m/g postfix (opt=4k)",
128 [FIO_OPT_STR_VAL] = "string (opt=bla)",
129 [FIO_OPT_STR_VAL_TIME] = "string with time postfix (opt=10s)",
130 [FIO_OPT_STR_STORE] = "string (opt=bla)",
131 [FIO_OPT_RANGE] = "one to three ranges (opt=1k-4k[,4k-8k[,1k-8k]])",
132 [FIO_OPT_INT] = "integer value (opt=100)",
133 [FIO_OPT_ULL] = "integer value (opt=100)",
134 [FIO_OPT_BOOL] = "boolean value (opt=1)",
135 [FIO_OPT_FLOAT_LIST] = "list of floating point values separated by ':' (opt=5.9:7.8)",
136 [FIO_OPT_STR_SET] = "empty or boolean value ([0|1])",
137 [FIO_OPT_DEPRECATED] = "deprecated",
138 [FIO_OPT_SOFT_DEPRECATED] = "deprecated",
139 [FIO_OPT_UNSUPPORTED] = "unsupported",
d447a8c2 140 };
34a3a855 141 ssize_t (*logger)(const char *format, ...);
06b0be6e
JA
142
143 if (is_err)
144 logger = log_err;
145 else
146 logger = log_info;
d447a8c2
JA
147
148 if (o->alias)
06b0be6e 149 logger("%20s: %s\n", "alias", o->alias);
d447a8c2 150
06b0be6e
JA
151 logger("%20s: %s\n", "type", typehelp[o->type]);
152 logger("%20s: %s\n", "default", o->def ? o->def : "no default");
07b3232d 153 if (o->prof_name)
06b0be6e
JA
154 logger("%20s: only for profile '%s'\n", "valid", o->prof_name);
155 show_option_range(o, logger);
d447a8c2
JA
156 show_option_values(o);
157}
158
0de5b26f
JA
159static unsigned long long get_mult_time(const char *str, int len,
160 int is_seconds)
cb2c86fd 161{
74454ce4
CE
162 const char *p = str;
163 char *c;
e4668264 164 unsigned long long mult = 1;
1c9f0761 165 int i;
74454ce4
CE
166
167 /*
168 * Go forward until we hit a non-digit, or +/- sign
169 */
170 while ((p - str) <= len) {
171 if (!isdigit((int) *p) && (*p != '+') && (*p != '-'))
172 break;
173 p++;
cb2c86fd 174 }
74454ce4 175
0de5b26f
JA
176 if (!isalpha((int) *p)) {
177 if (is_seconds)
178 return 1000000UL;
179 else
180 return 1;
181 }
74454ce4
CE
182
183 c = strdup(p);
1c9f0761 184 for (i = 0; i < strlen(c); i++)
e99161b4 185 c[i] = tolower((unsigned char)c[i]);
74454ce4 186
e4668264 187 if (!strncmp("us", c, 2) || !strncmp("usec", c, 4))
74454ce4 188 mult = 1;
e4668264 189 else if (!strncmp("ms", c, 2) || !strncmp("msec", c, 4))
74454ce4 190 mult = 1000;
e4668264
JA
191 else if (!strcmp("s", c))
192 mult = 1000000;
74454ce4 193 else if (!strcmp("m", c))
e4668264 194 mult = 60 * 1000000UL;
74454ce4 195 else if (!strcmp("h", c))
e4668264 196 mult = 60 * 60 * 1000000UL;
74454ce4 197 else if (!strcmp("d", c))
4ed22fe5 198 mult = 24 * 60 * 60 * 1000000ULL;
74454ce4
CE
199
200 free(c);
201 return mult;
cb2c86fd
JA
202}
203
a03fb65f
JA
204static int is_separator(char c)
205{
206 switch (c) {
207 case ':':
208 case '-':
209 case ',':
210 case '/':
211 return 1;
212 default:
213 return 0;
214 }
215}
216
7bb59102
JA
217static unsigned long long __get_mult_bytes(const char *p, void *data,
218 int *percent)
cb2c86fd 219{
d6978a32 220 unsigned int kb_base = fio_get_kb_base(data);
a639f0bb 221 unsigned long long ret = 1;
57fc29fa
JA
222 unsigned int i, pow = 0, mult = kb_base;
223 char *c;
a639f0bb 224
57fc29fa
JA
225 if (!p)
226 return 1;
a639f0bb 227
57fc29fa
JA
228 c = strdup(p);
229
a03fb65f 230 for (i = 0; i < strlen(c); i++) {
e99161b4 231 c[i] = tolower((unsigned char)c[i]);
a03fb65f
JA
232 if (is_separator(c[i])) {
233 c[i] = '\0';
234 break;
235 }
236 }
57fc29fa 237
d694a6a7
RE
238 /* If kb_base is 1000, use true units.
239 * If kb_base is 1024, use opposite units.
240 */
a04f158d 241 if (!strncmp("pib", c, 3)) {
57fc29fa 242 pow = 5;
d694a6a7
RE
243 if (kb_base == 1000)
244 mult = 1024;
245 else if (kb_base == 1024)
246 mult = 1000;
a04f158d 247 } else if (!strncmp("tib", c, 3)) {
57fc29fa 248 pow = 4;
d694a6a7
RE
249 if (kb_base == 1000)
250 mult = 1024;
251 else if (kb_base == 1024)
252 mult = 1000;
a04f158d 253 } else if (!strncmp("gib", c, 3)) {
57fc29fa 254 pow = 3;
d694a6a7
RE
255 if (kb_base == 1000)
256 mult = 1024;
257 else if (kb_base == 1024)
258 mult = 1000;
a04f158d 259 } else if (!strncmp("mib", c, 3)) {
57fc29fa 260 pow = 2;
d694a6a7
RE
261 if (kb_base == 1000)
262 mult = 1024;
263 else if (kb_base == 1024)
264 mult = 1000;
a04f158d 265 } else if (!strncmp("kib", c, 3)) {
57fc29fa 266 pow = 1;
d694a6a7
RE
267 if (kb_base == 1000)
268 mult = 1024;
269 else if (kb_base == 1024)
270 mult = 1000;
271 } else if (!strncmp("p", c, 1) || !strncmp("pb", c, 2)) {
57fc29fa 272 pow = 5;
d694a6a7 273 } else if (!strncmp("t", c, 1) || !strncmp("tb", c, 2)) {
57fc29fa 274 pow = 4;
d694a6a7 275 } else if (!strncmp("g", c, 1) || !strncmp("gb", c, 2)) {
57fc29fa 276 pow = 3;
d694a6a7 277 } else if (!strncmp("m", c, 1) || !strncmp("mb", c, 2)) {
57fc29fa 278 pow = 2;
d694a6a7 279 } else if (!strncmp("k", c, 1) || !strncmp("kb", c, 2)) {
57fc29fa 280 pow = 1;
d694a6a7 281 } else if (!strncmp("%", c, 1)) {
7bb59102 282 *percent = 1;
e721c57f 283 free(c);
7bb59102
JA
284 return ret;
285 }
57fc29fa
JA
286
287 while (pow--)
288 ret *= (unsigned long long) mult;
289
290 free(c);
a639f0bb 291 return ret;
cb2c86fd
JA
292}
293
7bb59102 294static unsigned long long get_mult_bytes(const char *str, int len, void *data,
6925dd35 295 int *percent)
57fc29fa 296{
55ed9636 297 const char *p = str;
ba4ddd69 298 int digit_seen = 0;
57fc29fa 299
1d1c187b 300 if (len < 2)
7bb59102 301 return __get_mult_bytes(str, data, percent);
1d1c187b 302
d0c814ec
SL
303 /*
304 * Go forward until we hit a non-digit, or +/- sign
305 */
55ed9636 306 while ((p - str) <= len) {
ba4ddd69
JA
307 if (!isdigit((int) *p) &&
308 (((*p != '+') && (*p != '-')) || digit_seen))
55ed9636 309 break;
3c703d13 310 digit_seen |= isdigit((int) *p);
55ed9636
JA
311 p++;
312 }
313
7bb59102 314 if (!isalpha((int) *p) && (*p != '%'))
57fc29fa
JA
315 p = NULL;
316
7bb59102 317 return __get_mult_bytes(p, data, percent);
57fc29fa
JA
318}
319
b470a02c 320extern int evaluate_arithmetic_expression(const char *buffer, long long *ival,
88038bc7
SC
321 double *dval, double implied_units,
322 int is_time);
b470a02c 323
83349190
YH
324/*
325 * Convert string into a floating number. Return 1 for success and 0 otherwise.
326 */
88038bc7 327int str_to_float(const char *str, double *val, int is_time)
83349190 328{
b470a02c
SC
329#ifdef CONFIG_ARITHMETIC
330 int rc;
331 long long ival;
332 double dval;
333
334 if (str[0] == '(') {
88038bc7 335 rc = evaluate_arithmetic_expression(str, &ival, &dval, 1.0, is_time);
b470a02c
SC
336 if (!rc) {
337 *val = dval;
338 return 1;
339 }
340 }
341#endif
342 return 1 == sscanf(str, "%lf", val);
83349190
YH
343}
344
cb2c86fd 345/*
e1f36503 346 * convert string into decimal value, noting any size suffix
cb2c86fd 347 */
0de5b26f 348int str_to_decimal(const char *str, long long *val, int kilo, void *data,
88038bc7 349 int is_seconds, int is_time)
cb2c86fd 350{
b347f9da 351 int len, base;
b470a02c
SC
352 int rc = 1;
353#ifdef CONFIG_ARITHMETIC
354 long long ival;
355 double dval;
8e2c678f 356 double implied_units = 1.0;
b470a02c 357#endif
cb2c86fd 358
cb2c86fd 359 len = strlen(str);
f90eff5a
JA
360 if (!len)
361 return 1;
cb2c86fd 362
b470a02c 363#ifdef CONFIG_ARITHMETIC
8e2c678f
SC
364 if (is_seconds)
365 implied_units = 1000000.0;
b470a02c 366 if (str[0] == '(')
88038bc7 367 rc = evaluate_arithmetic_expression(str, &ival, &dval, implied_units, is_time);
18722a18
SC
368 if (str[0] == '(' && !rc) {
369 if (!kilo && is_seconds)
370 *val = ival / 1000000LL;
371 else
372 *val = ival;
373 }
b470a02c 374#endif
b347f9da 375
b470a02c 376 if (rc == 1) {
5cd4efe9
JA
377 char *endptr;
378
b470a02c
SC
379 if (strstr(str, "0x") || strstr(str, "0X"))
380 base = 16;
381 else
382 base = 10;
383
5cd4efe9
JA
384 *val = strtoll(str, &endptr, base);
385 if (*val == 0 && endptr == str)
386 return 1;
b470a02c
SC
387 if (*val == LONG_MAX && errno == ERANGE)
388 return 1;
389 }
cb2c86fd 390
7bb59102
JA
391 if (kilo) {
392 unsigned long long mult;
393 int perc = 0;
394
6925dd35 395 mult = get_mult_bytes(str, len, data, &perc);
7bb59102
JA
396 if (perc)
397 *val = -1ULL - *val;
398 else
399 *val *= mult;
400 } else
0de5b26f 401 *val *= get_mult_time(str, len, is_seconds);
1d31d1bc 402
cb2c86fd
JA
403 return 0;
404}
405
9af4a244 406int check_str_bytes(const char *p, long long *val, void *data)
cb2c86fd 407{
88038bc7 408 return str_to_decimal(p, val, 1, data, 0, 0);
cb2c86fd
JA
409}
410
0de5b26f 411int check_str_time(const char *p, long long *val, int is_seconds)
cb2c86fd 412{
88038bc7 413 return str_to_decimal(p, val, 0, NULL, is_seconds, 1);
cb2c86fd
JA
414}
415
416void strip_blank_front(char **p)
417{
418 char *s = *p;
419
4c8e9640
JA
420 if (!strlen(s))
421 return;
76cd9378 422 while (isspace((int) *s))
cb2c86fd 423 s++;
4d651dad
JA
424
425 *p = s;
cb2c86fd
JA
426}
427
428void strip_blank_end(char *p)
429{
853ee7fc 430 char *start = p, *s;
523bfadb 431
4c8e9640
JA
432 if (!strlen(p))
433 return;
434
523bfadb
JA
435 s = strchr(p, ';');
436 if (s)
437 *s = '\0';
438 s = strchr(p, '#');
439 if (s)
440 *s = '\0';
441 if (s)
442 p = s;
443
7f7e6e59 444 s = p + strlen(p);
76cd9378 445 while ((isspace((int) *s) || iscntrl((int) *s)) && (s > start))
cb2c86fd
JA
446 s--;
447
448 *(s + 1) = '\0';
449}
450
5fff9543 451static int check_range_bytes(const char *str, long long *val, void *data)
cb2c86fd 452{
57fc29fa 453 long long __val;
cb2c86fd 454
88038bc7 455 if (!str_to_decimal(str, &__val, 1, data, 0, 0)) {
57fc29fa 456 *val = __val;
cb2c86fd
JA
457 return 0;
458 }
459
cb2c86fd
JA
460 return 1;
461}
462
63f29372 463static int check_int(const char *p, int *val)
cb2c86fd 464{
787f7e95
JA
465 if (!strlen(p))
466 return 1;
d78ee463 467 if (strstr(p, "0x") || strstr(p, "0X")) {
a61bdfd8
JA
468 if (sscanf(p, "%x", val) == 1)
469 return 0;
470 } else {
471 if (sscanf(p, "%u", val) == 1)
472 return 0;
473 }
cb2c86fd 474
e1f36503
JA
475 return 1;
476}
cb2c86fd 477
e6f735f0 478static size_t opt_len(const char *str)
808def70
JA
479{
480 char *postfix;
481
482 postfix = strchr(str, ':');
483 if (!postfix)
484 return strlen(str);
485
486 return (int)(postfix - str);
487}
488
119cd939
JA
489static int str_match_len(const struct value_pair *vp, const char *str)
490{
491 return max(strlen(vp->ival), opt_len(str));
492}
493
f0fdbcaf
JA
494#define val_store(ptr, val, off, or, data, o) \
495 do { \
496 ptr = td_var((data), (o), (off)); \
497 if ((or)) \
498 *ptr |= (val); \
499 else \
500 *ptr = (val); \
17abbe89
JA
501 } while (0)
502
9109883a 503static const char *opt_type_name(const struct fio_option *o)
c26438ad 504{
59f94d26 505 compiletime_assert(FIO_ARRAY_SIZE(opt_type_names) - 1 == FIO_OPT_UNSUPPORTED,
c26438ad
JA
506 "opt_type_names[] index");
507
47844764 508 if (o->type <= FIO_OPT_UNSUPPORTED)
c26438ad
JA
509 return opt_type_names[o->type];
510
511 return "OPT_UNKNOWN?";
512}
513
5d2788d5
JA
514static bool val_too_large(const struct fio_option *o, unsigned long long val,
515 bool is_uint)
516{
517 if (!o->maxval)
518 return false;
519
7676a1c2
JA
520 if (is_uint) {
521 if ((int) val < 0)
522 return (int) val > (int) o->maxval;
b6c01983 523 return (unsigned int) val > o->maxval;
7676a1c2 524 }
5d2788d5
JA
525
526 return val > o->maxval;
527}
528
529static bool val_too_small(const struct fio_option *o, unsigned long long val,
530 bool is_uint)
531{
532 if (!o->minval)
533 return false;
534
b6c01983
JA
535 if (is_uint)
536 return (int) val < o->minval;
5d2788d5
JA
537
538 return val < o->minval;
539}
540
9109883a
BVA
541static int __handle_option(const struct fio_option *o, const char *ptr,
542 void *data, int first, int more, int curr)
cb2c86fd 543{
2fdbefdd 544 int il=0, *ilp;
fd112d34 545 fio_fp64_t *flp;
63f29372 546 long long ull, *ullp;
5fff9543
JF
547 long ul2;
548 long long ull1, ull2;
83349190 549 double uf;
bfe1d592 550 char **cp = NULL;
e42b01eb 551 int ret = 0, is_time = 0;
c44b1ff5
JA
552 const struct value_pair *vp;
553 struct value_pair posval[PARSE_MAX_VP];
554 int i, all_skipped = 1;
cb2c86fd 555
c26438ad
JA
556 dprint(FD_PARSE, "__handle_option=%s, type=%s, ptr=%s\n", o->name,
557 opt_type_name(o), ptr);
a3d741fa 558
e3cedca7 559 if (!ptr && o->type != FIO_OPT_STR_SET && o->type != FIO_OPT_STR) {
28d7c363 560 log_err("Option %s requires an argument\n", o->name);
08e26e35
JA
561 return 1;
562 }
563
e1f36503 564 switch (o->type) {
5f6ddf1e 565 case FIO_OPT_STR:
5fff9543 566 case FIO_OPT_STR_ULL:
5f6ddf1e 567 case FIO_OPT_STR_MULTI: {
e1f36503 568 fio_opt_str_fn *fn = o->cb;
b1ec1da6 569
f085737f
JA
570 posval_sort(o, posval);
571
5f6ddf1e 572 ret = 1;
b1ec1da6 573 for (i = 0; i < PARSE_MAX_VP; i++) {
f085737f 574 vp = &posval[i];
b1ec1da6 575 if (!vp->ival || vp->ival[0] == '\0')
a3073f4a 576 continue;
ae2ddba4 577 all_skipped = 0;
078b46d1
JA
578 if (!ptr)
579 break;
119cd939 580 if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
b1ec1da6 581 ret = 0;
5fff9543
JF
582 if (!o->off1)
583 continue;
584 if (o->type == FIO_OPT_STR_ULL)
585 val_store(ullp, vp->oval, o->off1, vp->orval, data, o);
586 else
ebadc0ce 587 val_store(ilp, vp->oval, o->off1, vp->orval, data, o);
5f6ddf1e 588 continue;
b1ec1da6
JA
589 }
590 }
cb2c86fd 591
ae2ddba4 592 if (ret && !all_skipped)
b1ec1da6
JA
593 show_option_values(o);
594 else if (fn)
595 ret = fn(data, ptr);
e1f36503
JA
596 break;
597 }
e42b01eb
JA
598 case FIO_OPT_STR_VAL_TIME:
599 is_time = 1;
db83b0ab 600 fallthrough;
5fff9543 601 case FIO_OPT_ULL:
1a1137d9 602 case FIO_OPT_INT:
8f39afa7
AD
603 case FIO_OPT_STR_VAL:
604 case FIO_OPT_STR_VAL_ZONE:
605 {
e42b01eb 606 fio_opt_str_val_fn *fn = o->cb;
6eaf09d6 607 char tmp[128], *p;
8f39afa7
AD
608 size_t len = strlen(ptr);
609
610 if (len > 0 && ptr[len - 1] == 'z') {
611 if (o->type == FIO_OPT_STR_VAL_ZONE) {
612 char *ep;
613 unsigned long long val;
614
615 errno = 0;
616 val = strtoul(ptr, &ep, 10);
617 if (errno == 0 && ep != ptr && *ep == 'z') {
618 ull = ZONE_BASE_VAL + (uint32_t)val;
619 ret = 0;
620 goto store_option_value;
621 } else {
622 log_err("%s: unexpected zone value '%s'\n",
623 o->name, ptr);
624 return 1;
625 }
626 } else {
627 log_err("%s: 'z' suffix isn't applicable\n",
628 o->name);
629 return 1;
630 }
631 }
6eaf09d6 632
88038bc7
SC
633 if (!is_time && o->is_time)
634 is_time = o->is_time;
635
36833fb0 636 snprintf(tmp, sizeof(tmp), "%s", ptr);
6eaf09d6
SL
637 p = strchr(tmp, ',');
638 if (p)
639 *p = '\0';
e42b01eb
JA
640
641 if (is_time)
0de5b26f 642 ret = check_str_time(tmp, &ull, o->is_seconds);
e42b01eb 643 else
6eaf09d6 644 ret = check_str_bytes(tmp, &ull, data);
e1f36503 645
ae3fcb5a
JA
646 dprint(FD_PARSE, " ret=%d, out=%llu\n", ret, ull);
647
e1f36503
JA
648 if (ret)
649 break;
0f38bbef
JA
650 if (o->pow2 && !is_power_of_2(ull)) {
651 log_err("%s: must be a power-of-2\n", o->name);
652 return 1;
653 }
e1f36503 654
5d2788d5 655 if (val_too_large(o, ull, o->type == FIO_OPT_INT)) {
a69c9b57
JA
656 log_err("%s: max value out of range: %llu"
657 " (%llu max)\n", o->name, ull, o->maxval);
db8e0165
JA
658 return 1;
659 }
5d2788d5 660 if (val_too_small(o, ull, o->type == FIO_OPT_INT)) {
a69c9b57
JA
661 log_err("%s: min value out of range: %lld"
662 " (%d min)\n", o->name, ull, o->minval);
db8e0165
JA
663 return 1;
664 }
d926d535
JA
665 if (o->posval[0].ival) {
666 posval_sort(o, posval);
667
668 ret = 1;
669 for (i = 0; i < PARSE_MAX_VP; i++) {
670 vp = &posval[i];
671 if (!vp->ival || vp->ival[0] == '\0')
672 continue;
673 if (vp->oval == ull) {
674 ret = 0;
675 break;
676 }
677 }
678 if (ret) {
128e4caf
JA
679 log_err("fio: value %llu not allowed:\n", ull);
680 show_option_values(o);
d926d535
JA
681 return 1;
682 }
683 }
e1f36503 684
8f39afa7 685store_option_value:
e1f36503
JA
686 if (fn)
687 ret = fn(data, &ull);
688 else {
e01b22b8 689 if (o->type == FIO_OPT_INT) {
7b504edd
JA
690 if (first)
691 val_store(ilp, ull, o->off1, 0, data, o);
6eaf09d6 692 if (curr == 1) {
7b504edd
JA
693 if (o->off2)
694 val_store(ilp, ull, o->off2, 0, data, o);
02c6aad5 695 }
6eaf09d6 696 if (curr == 2) {
7b504edd
JA
697 if (o->off3)
698 val_store(ilp, ull, o->off3, 0, data, o);
6eaf09d6
SL
699 }
700 if (!more) {
701 if (curr < 1) {
7b504edd
JA
702 if (o->off2)
703 val_store(ilp, ull, o->off2, 0, data, o);
6eaf09d6
SL
704 }
705 if (curr < 2) {
7b504edd
JA
706 if (o->off3)
707 val_store(ilp, ull, o->off3, 0, data, o);
6eaf09d6
SL
708 }
709 }
5fff9543
JF
710 } else if (o->type == FIO_OPT_ULL) {
711 if (first)
712 val_store(ullp, ull, o->off1, 0, data, o);
713 if (curr == 1) {
714 if (o->off2)
715 val_store(ullp, ull, o->off2, 0, data, o);
716 }
717 if (curr == 2) {
718 if (o->off3)
719 val_store(ullp, ull, o->off3, 0, data, o);
720 }
721 if (!more) {
722 if (curr < 1) {
723 if (o->off2)
724 val_store(ullp, ull, o->off2, 0, data, o);
725 }
726 if (curr < 2) {
727 if (o->off3)
728 val_store(ullp, ull, o->off3, 0, data, o);
729 }
730 }
75e6f36f 731 } else {
7b504edd
JA
732 if (first)
733 val_store(ullp, ull, o->off1, 0, data, o);
02c6aad5 734 if (!more) {
7b504edd
JA
735 if (o->off2)
736 val_store(ullp, ull, o->off2, 0, data, o);
02c6aad5 737 }
75e6f36f 738 }
e1f36503
JA
739 }
740 break;
741 }
83349190 742 case FIO_OPT_FLOAT_LIST: {
eef02441
JA
743 char *cp2;
744
435d195a
VKF
745 if (first) {
746 /*
747 ** Initialize precision to 0 and zero out list
748 ** in case specified list is shorter than default
749 */
3e260a46
JA
750 if (o->off2) {
751 ul2 = 0;
f0fdbcaf 752 ilp = td_var(data, o, o->off2);
3e260a46
JA
753 *ilp = ul2;
754 }
435d195a 755
f0fdbcaf 756 flp = td_var(data, o, o->off1);
435d195a
VKF
757 for(i = 0; i < o->maxlen; i++)
758 flp[i].u.f = 0.0;
759 }
83349190 760 if (curr >= o->maxlen) {
28d7c363 761 log_err("the list exceeding max length %d\n",
83349190
YH
762 o->maxlen);
763 return 1;
764 }
88038bc7 765 if (!str_to_float(ptr, &uf, 0)) { /* this breaks if we ever have lists of times */
28d7c363 766 log_err("not a floating point value: %s\n", ptr);
83349190
YH
767 return 1;
768 }
45b3e8d7
BVA
769 if (o->minfp || o->maxfp) {
770 if (uf > o->maxfp) {
771 log_err("value out of range: %f"
772 " (range max: %f)\n", uf, o->maxfp);
773 return 1;
774 }
775 if (uf < o->minfp) {
776 log_err("value out of range: %f"
777 " (range min: %f)\n", uf, o->minfp);
778 return 1;
779 }
83349190
YH
780 }
781
f0fdbcaf 782 flp = td_var(data, o, o->off1);
fd112d34 783 flp[curr].u.f = uf;
83349190 784
ae3fcb5a
JA
785 dprint(FD_PARSE, " out=%f\n", uf);
786
435d195a
VKF
787 /*
788 ** Calculate precision for output by counting
789 ** number of digits after period. Find first
790 ** period in entire remaining list each time
791 */
792 cp2 = strchr(ptr, '.');
793 if (cp2 != NULL) {
eef02441 794 int len = 0;
435d195a
VKF
795
796 while (*++cp2 != '\0' && *cp2 >= '0' && *cp2 <= '9')
797 len++;
798
3e260a46 799 if (o->off2) {
f0fdbcaf 800 ilp = td_var(data, o, o->off2);
3e260a46
JA
801 if (len > *ilp)
802 *ilp = len;
803 }
435d195a
VKF
804 }
805
83349190
YH
806 break;
807 }
af52b345
JA
808 case FIO_OPT_STR_STORE: {
809 fio_opt_str_fn *fn = o->cb;
810
f75c69a1
JA
811 if (!strlen(ptr))
812 return 1;
813
7b504edd 814 if (o->off1) {
f0fdbcaf 815 cp = td_var(data, o, o->off1);
184b4098 816 *cp = strdup(ptr);
46576743
SW
817 if (strlen(ptr) > o->maxlen - 1) {
818 log_err("value exceeds max length of %d\n",
819 o->maxlen);
820 return 1;
821 }
1c964ce5 822 }
02c6aad5 823
184b4098
SL
824 if (fn)
825 ret = fn(data, ptr);
826 else if (o->posval[0].ival) {
827 posval_sort(o, posval);
828
829 ret = 1;
830 for (i = 0; i < PARSE_MAX_VP; i++) {
831 vp = &posval[i];
ab50817f 832 if (!vp->ival || vp->ival[0] == '\0' || !cp)
184b4098
SL
833 continue;
834 all_skipped = 0;
119cd939 835 if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
184b4098
SL
836 char *rest;
837
838 ret = 0;
839 if (vp->cb)
840 fn = vp->cb;
841 rest = strstr(*cp ?: ptr, ":");
842 if (rest) {
843 if (*cp)
844 *rest = '\0';
845 ptr = rest + 1;
846 } else
847 ptr = NULL;
848 break;
849 }
af52b345
JA
850 }
851 }
c44b1ff5 852
184b4098
SL
853 if (!all_skipped) {
854 if (ret && !*cp)
855 show_option_values(o);
856 else if (ret && *cp)
857 ret = 0;
858 else if (fn && ptr)
859 ret = fn(data, ptr);
860 }
c44b1ff5 861
e1f36503 862 break;
af52b345 863 }
e1f36503 864 case FIO_OPT_RANGE: {
b765a372 865 char tmp[128];
e1f36503
JA
866 char *p1, *p2;
867
36833fb0 868 snprintf(tmp, sizeof(tmp), "%s", ptr);
b765a372 869
31d23f47
DE
870 /* Handle bsrange with separate read,write values: */
871 p1 = strchr(tmp, ',');
872 if (p1)
873 *p1 = '\0';
874
b765a372 875 p1 = strchr(tmp, '-');
e1f36503 876 if (!p1) {
0c9baf91
JA
877 p1 = strchr(tmp, ':');
878 if (!p1) {
879 ret = 1;
880 break;
881 }
e1f36503
JA
882 }
883
884 p2 = p1 + 1;
885 *p1 = '\0';
b765a372 886 p1 = tmp;
e1f36503
JA
887
888 ret = 1;
5fff9543
JF
889 if (!check_range_bytes(p1, &ull1, data) &&
890 !check_range_bytes(p2, &ull2, data)) {
e1f36503 891 ret = 0;
5fff9543
JF
892 if (ull1 > ull2) {
893 unsigned long long foo = ull1;
f90eff5a 894
5fff9543
JF
895 ull1 = ull2;
896 ull2 = foo;
f90eff5a
JA
897 }
898
899 if (first) {
5fff9543
JF
900 val_store(ullp, ull1, o->off1, 0, data, o);
901 val_store(ullp, ull2, o->off2, 0, data, o);
17abbe89 902 }
6eaf09d6 903 if (curr == 1) {
7b504edd 904 if (o->off3 && o->off4) {
5fff9543
JF
905 val_store(ullp, ull1, o->off3, 0, data, o);
906 val_store(ullp, ull2, o->off4, 0, data, o);
6eaf09d6
SL
907 }
908 }
909 if (curr == 2) {
7b504edd 910 if (o->off5 && o->off6) {
5fff9543
JF
911 val_store(ullp, ull1, o->off5, 0, data, o);
912 val_store(ullp, ull2, o->off6, 0, data, o);
6eaf09d6
SL
913 }
914 }
915 if (!more) {
916 if (curr < 1) {
7b504edd 917 if (o->off3 && o->off4) {
5fff9543
JF
918 val_store(ullp, ull1, o->off3, 0, data, o);
919 val_store(ullp, ull2, o->off4, 0, data, o);
6eaf09d6
SL
920 }
921 }
922 if (curr < 2) {
7b504edd 923 if (o->off5 && o->off6) {
5fff9543
JF
924 val_store(ullp, ull1, o->off5, 0, data, o);
925 val_store(ullp, ull2, o->off6, 0, data, o);
6eaf09d6
SL
926 }
927 }
e1f36503 928 }
17abbe89
JA
929 }
930
e1f36503
JA
931 break;
932 }
74ba1808
JA
933 case FIO_OPT_BOOL:
934 case FIO_OPT_STR_SET: {
e1f36503
JA
935 fio_opt_int_fn *fn = o->cb;
936
74ba1808
JA
937 if (ptr)
938 ret = check_int(ptr, &il);
939 else if (o->type == FIO_OPT_BOOL)
940 ret = 1;
941 else
942 il = 1;
943
ae3fcb5a
JA
944 dprint(FD_PARSE, " ret=%d, out=%d\n", ret, il);
945
e1f36503
JA
946 if (ret)
947 break;
948
db8e0165 949 if (o->maxval && il > (int) o->maxval) {
5fff9543 950 log_err("max value out of range: %d (%llu max)\n",
5ec10eaa 951 il, o->maxval);
db8e0165
JA
952 return 1;
953 }
954 if (o->minval && il < o->minval) {
28d7c363 955 log_err("min value out of range: %d (%d min)\n",
5ec10eaa 956 il, o->minval);
db8e0165
JA
957 return 1;
958 }
e1f36503 959
76a43db4
JA
960 if (o->neg)
961 il = !il;
962
e1f36503
JA
963 if (fn)
964 ret = fn(data, &il);
965 else {
7b504edd
JA
966 if (first)
967 val_store(ilp, il, o->off1, 0, data, o);
02c6aad5 968 if (!more) {
7b504edd
JA
969 if (o->off2)
970 val_store(ilp, il, o->off2, 0, data, o);
02c6aad5 971 }
e1f36503
JA
972 }
973 break;
974 }
15ca150e 975 case FIO_OPT_DEPRECATED:
d9472271 976 ret = 1;
db83b0ab 977 fallthrough;
c47537ee
JA
978 case FIO_OPT_SOFT_DEPRECATED:
979 log_info("Option %s is deprecated\n", o->name);
15ca150e 980 break;
e1f36503 981 default:
06b0be6e 982 log_err("Bad option type %u\n", o->type);
e1f36503
JA
983 ret = 1;
984 }
cb2c86fd 985
70a4c0c8
JA
986 if (ret)
987 return ret;
988
d447a8c2 989 if (o->verify) {
70a4c0c8 990 ret = o->verify(o, data);
d447a8c2 991 if (ret) {
28d7c363
JA
992 log_err("Correct format for offending option\n");
993 log_err("%20s: %s\n", o->name, o->help);
06b0be6e 994 show_option_help(o, 1);
d447a8c2
JA
995 }
996 }
70a4c0c8 997
e1f36503 998 return ret;
cb2c86fd
JA
999}
1000
9109883a
BVA
1001static int handle_option(const struct fio_option *o, const char *__ptr,
1002 void *data)
f90eff5a 1003{
b62bdf2c
JA
1004 char *o_ptr, *ptr, *ptr2;
1005 int ret, done;
f90eff5a 1006
7c8f1a5c
JA
1007 dprint(FD_PARSE, "handle_option=%s, ptr=%s\n", o->name, __ptr);
1008
b62bdf2c 1009 o_ptr = ptr = NULL;
7c8f1a5c 1010 if (__ptr)
b62bdf2c 1011 o_ptr = ptr = strdup(__ptr);
a3d741fa 1012
f90eff5a 1013 /*
b62bdf2c
JA
1014 * See if we have another set of parameters, hidden after a comma.
1015 * Do this before parsing this round, to check if we should
787f7e95 1016 * copy set 1 options to set 2.
f90eff5a 1017 */
b62bdf2c
JA
1018 done = 0;
1019 ret = 1;
1020 do {
1021 int __ret;
1022
1023 ptr2 = NULL;
1024 if (ptr &&
1025 (o->type != FIO_OPT_STR_STORE) &&
83349190 1026 (o->type != FIO_OPT_STR) &&
e97163ad 1027 (o->type != FIO_OPT_STR_ULL) &&
83349190 1028 (o->type != FIO_OPT_FLOAT_LIST)) {
b62bdf2c
JA
1029 ptr2 = strchr(ptr, ',');
1030 if (ptr2 && *(ptr2 + 1) == '\0')
1031 *ptr2 = '\0';
6eaf09d6 1032 if (o->type != FIO_OPT_STR_MULTI && o->type != FIO_OPT_RANGE) {
b62bdf2c
JA
1033 if (!ptr2)
1034 ptr2 = strchr(ptr, ':');
1035 if (!ptr2)
1036 ptr2 = strchr(ptr, '-');
1037 }
83349190
YH
1038 } else if (ptr && o->type == FIO_OPT_FLOAT_LIST) {
1039 ptr2 = strchr(ptr, ':');
b62bdf2c 1040 }
787f7e95 1041
b62bdf2c
JA
1042 /*
1043 * Don't return early if parsing the first option fails - if
1044 * we are doing multiple arguments, we can allow the first one
1045 * being empty.
1046 */
83349190 1047 __ret = __handle_option(o, ptr, data, !done, !!ptr2, done);
b62bdf2c
JA
1048 if (ret)
1049 ret = __ret;
787f7e95 1050
b62bdf2c
JA
1051 if (!ptr2)
1052 break;
f90eff5a 1053
b62bdf2c
JA
1054 ptr = ptr2 + 1;
1055 done++;
1056 } while (1);
787f7e95 1057
b62bdf2c
JA
1058 if (o_ptr)
1059 free(o_ptr);
1060 return ret;
f90eff5a
JA
1061}
1062
75e6bcba
JA
1063struct fio_option *find_option(struct fio_option *options, const char *opt)
1064{
1065 struct fio_option *o;
1066
1067 for (o = &options[0]; o->name; o++) {
1068 if (!o_match(o, opt))
1069 continue;
1070 if (o->type == FIO_OPT_UNSUPPORTED) {
1071 log_err("Option <%s>: %s\n", o->name, o->help);
1072 continue;
1073 }
1074
1075 return o;
1076 }
1077
1078 return NULL;
1079}
1080
9109883a
BVA
1081const struct fio_option *
1082find_option_c(const struct fio_option *options, const char *opt)
1083{
40938cde
TK
1084 const struct fio_option *o;
1085
1086 for (o = &options[0]; o->name; o++) {
1087 if (!o_match(o, opt))
1088 continue;
1089 if (o->type == FIO_OPT_UNSUPPORTED) {
1090 log_err("Option <%s>: %s\n", o->name, o->help);
1091 continue;
1092 }
1093
1094 return o;
1095 }
1096
1097 return NULL;
9109883a 1098}
75e6bcba 1099
9109883a
BVA
1100static const struct fio_option *
1101get_option(char *opt, const struct fio_option *options, char **post)
3b8b7135 1102{
9109883a 1103 const struct fio_option *o;
3b8b7135
JA
1104 char *ret;
1105
1106 ret = strchr(opt, '=');
1107 if (ret) {
1108 *post = ret;
1109 *ret = '\0';
de890a1e 1110 ret = opt;
3b8b7135 1111 (*post)++;
43c129b4 1112 strip_blank_end(ret);
9109883a 1113 o = find_option_c(options, ret);
3b8b7135 1114 } else {
9109883a 1115 o = find_option_c(options, opt);
3b8b7135
JA
1116 *post = NULL;
1117 }
1118
1119 return o;
1120}
1121
1122static int opt_cmp(const void *p1, const void *p2)
1123{
9109883a 1124 const struct fio_option *o;
de890a1e 1125 char *s, *foo;
8cdabc1d 1126 int prio1, prio2;
3b8b7135 1127
8cdabc1d 1128 prio1 = prio2 = 0;
3b8b7135 1129
de890a1e
SL
1130 if (*(char **)p1) {
1131 s = strdup(*((char **) p1));
9af4a244 1132 o = get_option(s, __fio_options, &foo);
de890a1e
SL
1133 if (o)
1134 prio1 = o->prio;
1135 free(s);
1136 }
1137 if (*(char **)p2) {
1138 s = strdup(*((char **) p2));
9af4a244 1139 o = get_option(s, __fio_options, &foo);
de890a1e
SL
1140 if (o)
1141 prio2 = o->prio;
1142 free(s);
1143 }
1144
8cdabc1d 1145 return prio2 - prio1;
3b8b7135
JA
1146}
1147
9109883a 1148void sort_options(char **opts, const struct fio_option *options, int num_opts)
3b8b7135 1149{
9af4a244 1150 __fio_options = options;
3b8b7135 1151 qsort(opts, num_opts, sizeof(char *), opt_cmp);
9af4a244 1152 __fio_options = NULL;
3b8b7135
JA
1153}
1154
9109883a
BVA
1155static void add_to_dump_list(const struct fio_option *o,
1156 struct flist_head *dump_list, const char *post)
d8b4f395
JA
1157{
1158 struct print_option *p;
1159
1160 if (!dump_list)
1161 return;
1162
1163 p = malloc(sizeof(*p));
1164 p->name = strdup(o->name);
1165 if (post)
1166 p->value = strdup(post);
1167 else
1168 p->value = NULL;
1169
1170 flist_add_tail(&p->list, dump_list);
1171}
1172
b4692828 1173int parse_cmd_option(const char *opt, const char *val,
9109883a 1174 const struct fio_option *options, void *data,
d8b4f395 1175 struct flist_head *dump_list)
b4692828 1176{
9109883a 1177 const struct fio_option *o;
b4692828 1178
9109883a 1179 o = find_option_c(options, opt);
b4692828 1180 if (!o) {
06b0be6e 1181 log_err("Bad option <%s>\n", opt);
b4692828
JA
1182 return 1;
1183 }
1184
d8b4f395
JA
1185 if (handle_option(o, val, data)) {
1186 log_err("fio: failed parsing %s=%s\n", opt, val);
1187 return 1;
1188 }
b1508cf9 1189
d8b4f395
JA
1190 add_to_dump_list(o, dump_list, val);
1191 return 0;
b4692828
JA
1192}
1193
9109883a
BVA
1194int parse_option(char *opt, const char *input, const struct fio_option *options,
1195 const struct fio_option **o, void *data,
c2292325 1196 struct flist_head *dump_list)
cb2c86fd 1197{
d0c814ec 1198 char *post;
e1f36503 1199
d0c814ec
SL
1200 if (!opt) {
1201 log_err("fio: failed parsing %s\n", input);
de890a1e 1202 *o = NULL;
38789b58 1203 return 1;
d0c814ec 1204 }
e1f36503 1205
de890a1e
SL
1206 *o = get_option(opt, options, &post);
1207 if (!*o) {
1208 if (post) {
1209 int len = strlen(opt);
1210 if (opt + len + 1 != post)
1211 memmove(opt + len + 1, post, strlen(post));
1212 opt[len] = '=';
1213 }
e1f36503
JA
1214 return 1;
1215 }
1216
292cc475
JA
1217 if (handle_option(*o, post, data)) {
1218 log_err("fio: failed parsing %s\n", input);
1219 return 1;
1220 }
b1508cf9 1221
d8b4f395 1222 add_to_dump_list(*o, dump_list, post);
292cc475 1223 return 0;
e1f36503 1224}
fd28ca49 1225
0e9f7fac
JA
1226/*
1227 * Option match, levenshtein distance. Handy for not quite remembering what
1228 * the option name is.
1229 */
a893c261 1230int string_distance(const char *s1, const char *s2)
0e9f7fac
JA
1231{
1232 unsigned int s1_len = strlen(s1);
1233 unsigned int s2_len = strlen(s2);
1234 unsigned int *p, *q, *r;
1235 unsigned int i, j;
1236
1237 p = malloc(sizeof(unsigned int) * (s2_len + 1));
1238 q = malloc(sizeof(unsigned int) * (s2_len + 1));
1239
1240 p[0] = 0;
1241 for (i = 1; i <= s2_len; i++)
1242 p[i] = p[i - 1] + 1;
1243
1244 for (i = 1; i <= s1_len; i++) {
1245 q[0] = p[0] + 1;
1246 for (j = 1; j <= s2_len; j++) {
1247 unsigned int sub = p[j - 1];
8a1db9a1 1248 unsigned int pmin;
0e9f7fac
JA
1249
1250 if (s1[i - 1] != s2[j - 1])
1251 sub++;
1252
8a1db9a1
JA
1253 pmin = min(q[j - 1] + 1, sub);
1254 q[j] = min(p[j] + 1, pmin);
0e9f7fac
JA
1255 }
1256 r = p;
1257 p = q;
1258 q = r;
1259 }
1260
1261 i = p[s2_len];
1262 free(p);
1263 free(q);
1264 return i;
1265}
1266
3701636d
JA
1267/*
1268 * Make a guess of whether the distance from 's1' is significant enough
1269 * to warrant printing the guess. We set this to a 1/2 match.
1270 */
1271int string_distance_ok(const char *opt, int distance)
1272{
1273 size_t len;
1274
1275 len = strlen(opt);
1276 len = (len + 1) / 2;
1277 return distance <= len;
1278}
1279
9109883a
BVA
1280static const struct fio_option *find_child(const struct fio_option *options,
1281 const struct fio_option *o)
afdf9352 1282{
9109883a 1283 const struct fio_option *__o;
afdf9352 1284
fdf28744
JA
1285 for (__o = options + 1; __o->name; __o++)
1286 if (__o->parent && !strcmp(__o->parent, o->name))
afdf9352
JA
1287 return __o;
1288
1289 return NULL;
1290}
1291
9109883a
BVA
1292static void __print_option(const struct fio_option *o,
1293 const struct fio_option *org,
323d9113 1294 int level)
afdf9352
JA
1295{
1296 char name[256], *p;
323d9113 1297 int depth;
afdf9352
JA
1298
1299 if (!o)
1300 return;
5ec10eaa 1301
afdf9352 1302 p = name;
323d9113
JA
1303 depth = level;
1304 while (depth--)
1305 p += sprintf(p, "%s", " ");
afdf9352
JA
1306
1307 sprintf(p, "%s", o->name);
1308
28d7c363 1309 log_info("%-24s: %s\n", name, o->help);
323d9113
JA
1310}
1311
9109883a 1312static void print_option(const struct fio_option *o)
323d9113 1313{
9109883a
BVA
1314 const struct fio_option *parent;
1315 const struct fio_option *__o;
323d9113
JA
1316 unsigned int printed;
1317 unsigned int level;
1318
1319 __print_option(o, NULL, 0);
1320 parent = o;
1321 level = 0;
1322 do {
1323 level++;
1324 printed = 0;
1325
1326 while ((__o = find_child(o, parent)) != NULL) {
1327 __print_option(__o, o, level);
1328 o = __o;
1329 printed++;
1330 }
1331
1332 parent = o;
1333 } while (printed);
afdf9352
JA
1334}
1335
9109883a 1336int show_cmd_help(const struct fio_option *options, const char *name)
0e9f7fac 1337{
9109883a 1338 const struct fio_option *o, *closest;
d091d099 1339 unsigned int best_dist = -1U;
29fc6afe 1340 int found = 0;
320beefe
JA
1341 int show_all = 0;
1342
1343 if (!name || !strcmp(name, "all"))
1344 show_all = 1;
fd28ca49 1345
0e9f7fac
JA
1346 closest = NULL;
1347 best_dist = -1;
4945ba12 1348 for (o = &options[0]; o->name; o++) {
320beefe
JA
1349 int match = 0;
1350
c47537ee
JA
1351 if (o->type == FIO_OPT_DEPRECATED ||
1352 o->type == FIO_OPT_SOFT_DEPRECATED)
15ca150e 1353 continue;
07b3232d
JA
1354 if (!exec_profile && o->prof_name)
1355 continue;
4ac23d27
JA
1356 if (exec_profile && !(o->prof_name && !strcmp(exec_profile, o->prof_name)))
1357 continue;
15ca150e 1358
0e9f7fac 1359 if (name) {
7f9348f8
JA
1360 if (!strcmp(name, o->name) ||
1361 (o->alias && !strcmp(name, o->alias)))
0e9f7fac
JA
1362 match = 1;
1363 else {
1364 unsigned int dist;
1365
1366 dist = string_distance(name, o->name);
1367 if (dist < best_dist) {
1368 best_dist = dist;
1369 closest = o;
1370 }
1371 }
1372 }
fd28ca49
JA
1373
1374 if (show_all || match) {
29fc6afe 1375 found = 1;
c167dedc 1376 if (match)
28d7c363 1377 log_info("%20s: %s\n", o->name, o->help);
c167dedc 1378 if (show_all) {
afdf9352 1379 if (!o->parent)
323d9113 1380 print_option(o);
4945ba12 1381 continue;
c167dedc 1382 }
fd28ca49
JA
1383 }
1384
70df2f19
JA
1385 if (!match)
1386 continue;
1387
06b0be6e 1388 show_option_help(o, 0);
fd28ca49
JA
1389 }
1390
29fc6afe
JA
1391 if (found)
1392 return 0;
fd28ca49 1393
28d7c363 1394 log_err("No such command: %s", name);
d091d099
JA
1395
1396 /*
1397 * Only print an appropriately close option, one where the edit
1398 * distance isn't too big. Otherwise we get crazy matches.
1399 */
1400 if (closest && best_dist < 3) {
28d7c363
JA
1401 log_info(" - showing closest match\n");
1402 log_info("%20s: %s\n", closest->name, closest->help);
06b0be6e 1403 show_option_help(closest, 0);
0e9f7fac 1404 } else
28d7c363 1405 log_info("\n");
0e9f7fac 1406
29fc6afe 1407 return 1;
fd28ca49 1408}
ee738499 1409
13335ddb
JA
1410/*
1411 * Handle parsing of default parameters.
1412 */
9109883a 1413void fill_default_options(void *data, const struct fio_option *options)
ee738499 1414{
9109883a 1415 const struct fio_option *o;
ee738499 1416
a3d741fa
JA
1417 dprint(FD_PARSE, "filling default options\n");
1418
4945ba12 1419 for (o = &options[0]; o->name; o++)
ee738499
JA
1420 if (o->def)
1421 handle_option(o, o->def, data);
ee738499 1422}
13335ddb 1423
8aa89d70 1424static void option_init(struct fio_option *o)
9f988e2e 1425{
c47537ee
JA
1426 if (o->type == FIO_OPT_DEPRECATED || o->type == FIO_OPT_UNSUPPORTED ||
1427 o->type == FIO_OPT_SOFT_DEPRECATED)
9f988e2e 1428 return;
bbcacb72
JA
1429 if (o->name && !o->lname)
1430 log_err("Option %s: missing long option name\n", o->name);
9f988e2e
JA
1431 if (o->type == FIO_OPT_BOOL) {
1432 o->minval = 0;
1433 o->maxval = 1;
1434 }
d4fc2f04
JA
1435 if (o->type == FIO_OPT_INT) {
1436 if (!o->maxval)
1437 o->maxval = UINT_MAX;
1438 }
5fff9543
JF
1439 if (o->type == FIO_OPT_ULL) {
1440 if (!o->maxval)
1441 o->maxval = ULLONG_MAX;
1442 }
c8931876 1443 if (o->type == FIO_OPT_STR_SET && o->def && !o->no_warn_def) {
06b0be6e 1444 log_err("Option %s: string set option with"
9f988e2e
JA
1445 " default will always be true\n", o->name);
1446 }
7b504edd 1447 if (!o->cb && !o->off1)
06b0be6e 1448 log_err("Option %s: neither cb nor offset given\n", o->name);
22754746 1449 if (!o->category) {
cca5b5bc 1450 log_info("Option %s: no category defined. Setting to misc\n", o->name);
22754746 1451 o->category = FIO_OPT_C_GENERAL;
ffd7821f 1452 o->group = FIO_OPT_G_INVALID;
22754746 1453 }
9f988e2e
JA
1454}
1455
13335ddb
JA
1456/*
1457 * Sanitize the options structure. For now it just sets min/max for bool
5b0a8880 1458 * values and whether both callback and offsets are given.
13335ddb
JA
1459 */
1460void options_init(struct fio_option *options)
1461{
4945ba12 1462 struct fio_option *o;
13335ddb 1463
a3d741fa
JA
1464 dprint(FD_PARSE, "init options\n");
1465
90265353 1466 for (o = &options[0]; o->name; o++) {
9f988e2e 1467 option_init(o);
90265353
JA
1468 if (o->inverse)
1469 o->inv_opt = find_option(options, o->inverse);
1470 }
13335ddb 1471}
7e356b2d 1472
9109883a 1473void options_mem_dupe(const struct fio_option *options, void *data)
53b5693d 1474{
9109883a 1475 const struct fio_option *o;
53b5693d
TK
1476 char **ptr;
1477
1478 dprint(FD_PARSE, "dup options\n");
1479
1480 for (o = &options[0]; o->name; o++) {
1481 if (o->type != FIO_OPT_STR_STORE)
1482 continue;
1483
1484 ptr = td_var(data, o, o->off1);
1485 if (*ptr)
1486 *ptr = strdup(*ptr);
1487 }
1488}
1489
9109883a 1490void options_free(const struct fio_option *options, void *data)
7e356b2d 1491{
9109883a 1492 const struct fio_option *o;
7e356b2d
JA
1493 char **ptr;
1494
1495 dprint(FD_PARSE, "free options\n");
1496
1497 for (o = &options[0]; o->name; o++) {
43f466e6 1498 if (o->type != FIO_OPT_STR_STORE || !o->off1 || o->no_free)
7e356b2d
JA
1499 continue;
1500
f0fdbcaf 1501 ptr = td_var(data, o, o->off1);
7e356b2d
JA
1502 if (*ptr) {
1503 free(*ptr);
1504 *ptr = NULL;
1505 }
1506 }
1507}