fio: ioengine flag cleanup
[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 479{
ff236b51 480 char delimiter[] = {',', ':'};
808def70 481 char *postfix;
ff236b51 482 unsigned int i;
808def70 483
ff236b51
OL
484 for (i = 0; i < FIO_ARRAY_SIZE(delimiter); i++) {
485 postfix = strchr(str, delimiter[i]);
486 if (postfix)
487 return (int)(postfix - str);
488 }
808def70 489
ff236b51 490 return strlen(str);
808def70
JA
491}
492
119cd939
JA
493static int str_match_len(const struct value_pair *vp, const char *str)
494{
495 return max(strlen(vp->ival), opt_len(str));
496}
497
f0fdbcaf
JA
498#define val_store(ptr, val, off, or, data, o) \
499 do { \
500 ptr = td_var((data), (o), (off)); \
501 if ((or)) \
502 *ptr |= (val); \
503 else \
504 *ptr = (val); \
17abbe89
JA
505 } while (0)
506
9109883a 507static const char *opt_type_name(const struct fio_option *o)
c26438ad 508{
59f94d26 509 compiletime_assert(FIO_ARRAY_SIZE(opt_type_names) - 1 == FIO_OPT_UNSUPPORTED,
c26438ad
JA
510 "opt_type_names[] index");
511
47844764 512 if (o->type <= FIO_OPT_UNSUPPORTED)
c26438ad
JA
513 return opt_type_names[o->type];
514
515 return "OPT_UNKNOWN?";
516}
517
5d2788d5
JA
518static bool val_too_large(const struct fio_option *o, unsigned long long val,
519 bool is_uint)
520{
521 if (!o->maxval)
522 return false;
523
7676a1c2
JA
524 if (is_uint) {
525 if ((int) val < 0)
526 return (int) val > (int) o->maxval;
b6c01983 527 return (unsigned int) val > o->maxval;
7676a1c2 528 }
5d2788d5
JA
529
530 return val > o->maxval;
531}
532
533static bool val_too_small(const struct fio_option *o, unsigned long long val,
534 bool is_uint)
535{
536 if (!o->minval)
537 return false;
538
b6c01983
JA
539 if (is_uint)
540 return (int) val < o->minval;
5d2788d5
JA
541
542 return val < o->minval;
543}
544
9109883a
BVA
545static int __handle_option(const struct fio_option *o, const char *ptr,
546 void *data, int first, int more, int curr)
cb2c86fd 547{
2fdbefdd 548 int il=0, *ilp;
fd112d34 549 fio_fp64_t *flp;
63f29372 550 long long ull, *ullp;
5fff9543
JF
551 long ul2;
552 long long ull1, ull2;
83349190 553 double uf;
bfe1d592 554 char **cp = NULL;
e42b01eb 555 int ret = 0, is_time = 0;
c44b1ff5
JA
556 const struct value_pair *vp;
557 struct value_pair posval[PARSE_MAX_VP];
558 int i, all_skipped = 1;
cb2c86fd 559
c26438ad
JA
560 dprint(FD_PARSE, "__handle_option=%s, type=%s, ptr=%s\n", o->name,
561 opt_type_name(o), ptr);
a3d741fa 562
e3cedca7 563 if (!ptr && o->type != FIO_OPT_STR_SET && o->type != FIO_OPT_STR) {
28d7c363 564 log_err("Option %s requires an argument\n", o->name);
08e26e35
JA
565 return 1;
566 }
567
e1f36503 568 switch (o->type) {
5f6ddf1e 569 case FIO_OPT_STR:
5fff9543 570 case FIO_OPT_STR_ULL:
5f6ddf1e 571 case FIO_OPT_STR_MULTI: {
e1f36503 572 fio_opt_str_fn *fn = o->cb;
b1ec1da6 573
f085737f
JA
574 posval_sort(o, posval);
575
5f6ddf1e 576 ret = 1;
b1ec1da6 577 for (i = 0; i < PARSE_MAX_VP; i++) {
f085737f 578 vp = &posval[i];
b1ec1da6 579 if (!vp->ival || vp->ival[0] == '\0')
a3073f4a 580 continue;
ae2ddba4 581 all_skipped = 0;
078b46d1
JA
582 if (!ptr)
583 break;
119cd939 584 if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
b1ec1da6 585 ret = 0;
5fff9543
JF
586 if (!o->off1)
587 continue;
588 if (o->type == FIO_OPT_STR_ULL)
589 val_store(ullp, vp->oval, o->off1, vp->orval, data, o);
590 else
ebadc0ce 591 val_store(ilp, vp->oval, o->off1, vp->orval, data, o);
5f6ddf1e 592 continue;
b1ec1da6
JA
593 }
594 }
cb2c86fd 595
ae2ddba4 596 if (ret && !all_skipped)
b1ec1da6
JA
597 show_option_values(o);
598 else if (fn)
599 ret = fn(data, ptr);
e1f36503
JA
600 break;
601 }
e42b01eb
JA
602 case FIO_OPT_STR_VAL_TIME:
603 is_time = 1;
87933e32 604 fio_fallthrough;
5fff9543 605 case FIO_OPT_ULL:
1a1137d9 606 case FIO_OPT_INT:
8f39afa7
AD
607 case FIO_OPT_STR_VAL:
608 case FIO_OPT_STR_VAL_ZONE:
609 {
e42b01eb 610 fio_opt_str_val_fn *fn = o->cb;
6eaf09d6 611 char tmp[128], *p;
8f39afa7
AD
612 size_t len = strlen(ptr);
613
614 if (len > 0 && ptr[len - 1] == 'z') {
615 if (o->type == FIO_OPT_STR_VAL_ZONE) {
616 char *ep;
617 unsigned long long val;
618
619 errno = 0;
620 val = strtoul(ptr, &ep, 10);
621 if (errno == 0 && ep != ptr && *ep == 'z') {
622 ull = ZONE_BASE_VAL + (uint32_t)val;
623 ret = 0;
624 goto store_option_value;
625 } else {
626 log_err("%s: unexpected zone value '%s'\n",
627 o->name, ptr);
628 return 1;
629 }
630 } else {
631 log_err("%s: 'z' suffix isn't applicable\n",
632 o->name);
633 return 1;
634 }
635 }
6eaf09d6 636
88038bc7
SC
637 if (!is_time && o->is_time)
638 is_time = o->is_time;
639
36833fb0 640 snprintf(tmp, sizeof(tmp), "%s", ptr);
6eaf09d6
SL
641 p = strchr(tmp, ',');
642 if (p)
643 *p = '\0';
e42b01eb
JA
644
645 if (is_time)
0de5b26f 646 ret = check_str_time(tmp, &ull, o->is_seconds);
e42b01eb 647 else
6eaf09d6 648 ret = check_str_bytes(tmp, &ull, data);
e1f36503 649
ae3fcb5a
JA
650 dprint(FD_PARSE, " ret=%d, out=%llu\n", ret, ull);
651
e1f36503
JA
652 if (ret)
653 break;
0f38bbef
JA
654 if (o->pow2 && !is_power_of_2(ull)) {
655 log_err("%s: must be a power-of-2\n", o->name);
656 return 1;
657 }
e1f36503 658
5d2788d5 659 if (val_too_large(o, ull, o->type == FIO_OPT_INT)) {
a69c9b57
JA
660 log_err("%s: max value out of range: %llu"
661 " (%llu max)\n", o->name, ull, o->maxval);
db8e0165
JA
662 return 1;
663 }
5d2788d5 664 if (val_too_small(o, ull, o->type == FIO_OPT_INT)) {
a69c9b57
JA
665 log_err("%s: min value out of range: %lld"
666 " (%d min)\n", o->name, ull, o->minval);
db8e0165
JA
667 return 1;
668 }
d926d535
JA
669 if (o->posval[0].ival) {
670 posval_sort(o, posval);
671
672 ret = 1;
673 for (i = 0; i < PARSE_MAX_VP; i++) {
674 vp = &posval[i];
675 if (!vp->ival || vp->ival[0] == '\0')
676 continue;
677 if (vp->oval == ull) {
678 ret = 0;
679 break;
680 }
681 }
682 if (ret) {
128e4caf
JA
683 log_err("fio: value %llu not allowed:\n", ull);
684 show_option_values(o);
d926d535
JA
685 return 1;
686 }
687 }
e1f36503 688
8f39afa7 689store_option_value:
e1f36503
JA
690 if (fn)
691 ret = fn(data, &ull);
692 else {
e01b22b8 693 if (o->type == FIO_OPT_INT) {
7b504edd
JA
694 if (first)
695 val_store(ilp, ull, o->off1, 0, data, o);
6eaf09d6 696 if (curr == 1) {
7b504edd
JA
697 if (o->off2)
698 val_store(ilp, ull, o->off2, 0, data, o);
02c6aad5 699 }
6eaf09d6 700 if (curr == 2) {
7b504edd
JA
701 if (o->off3)
702 val_store(ilp, ull, o->off3, 0, data, o);
6eaf09d6
SL
703 }
704 if (!more) {
705 if (curr < 1) {
7b504edd
JA
706 if (o->off2)
707 val_store(ilp, ull, o->off2, 0, data, o);
6eaf09d6
SL
708 }
709 if (curr < 2) {
7b504edd
JA
710 if (o->off3)
711 val_store(ilp, ull, o->off3, 0, data, o);
6eaf09d6
SL
712 }
713 }
5fff9543
JF
714 } else if (o->type == FIO_OPT_ULL) {
715 if (first)
716 val_store(ullp, ull, o->off1, 0, data, o);
717 if (curr == 1) {
718 if (o->off2)
719 val_store(ullp, ull, o->off2, 0, data, o);
720 }
721 if (curr == 2) {
722 if (o->off3)
723 val_store(ullp, ull, o->off3, 0, data, o);
724 }
725 if (!more) {
726 if (curr < 1) {
727 if (o->off2)
728 val_store(ullp, ull, o->off2, 0, data, o);
729 }
730 if (curr < 2) {
731 if (o->off3)
732 val_store(ullp, ull, o->off3, 0, data, o);
733 }
734 }
75e6f36f 735 } else {
7b504edd
JA
736 if (first)
737 val_store(ullp, ull, o->off1, 0, data, o);
02c6aad5 738 if (!more) {
7b504edd
JA
739 if (o->off2)
740 val_store(ullp, ull, o->off2, 0, data, o);
02c6aad5 741 }
75e6f36f 742 }
e1f36503
JA
743 }
744 break;
745 }
83349190 746 case FIO_OPT_FLOAT_LIST: {
eef02441
JA
747 char *cp2;
748
435d195a
VKF
749 if (first) {
750 /*
751 ** Initialize precision to 0 and zero out list
752 ** in case specified list is shorter than default
753 */
3e260a46
JA
754 if (o->off2) {
755 ul2 = 0;
f0fdbcaf 756 ilp = td_var(data, o, o->off2);
3e260a46
JA
757 *ilp = ul2;
758 }
435d195a 759
f0fdbcaf 760 flp = td_var(data, o, o->off1);
435d195a
VKF
761 for(i = 0; i < o->maxlen; i++)
762 flp[i].u.f = 0.0;
763 }
83349190 764 if (curr >= o->maxlen) {
28d7c363 765 log_err("the list exceeding max length %d\n",
83349190
YH
766 o->maxlen);
767 return 1;
768 }
88038bc7 769 if (!str_to_float(ptr, &uf, 0)) { /* this breaks if we ever have lists of times */
28d7c363 770 log_err("not a floating point value: %s\n", ptr);
83349190
YH
771 return 1;
772 }
45b3e8d7
BVA
773 if (o->minfp || o->maxfp) {
774 if (uf > o->maxfp) {
775 log_err("value out of range: %f"
776 " (range max: %f)\n", uf, o->maxfp);
777 return 1;
778 }
779 if (uf < o->minfp) {
780 log_err("value out of range: %f"
781 " (range min: %f)\n", uf, o->minfp);
782 return 1;
783 }
83349190
YH
784 }
785
f0fdbcaf 786 flp = td_var(data, o, o->off1);
fd112d34 787 flp[curr].u.f = uf;
83349190 788
ae3fcb5a
JA
789 dprint(FD_PARSE, " out=%f\n", uf);
790
435d195a
VKF
791 /*
792 ** Calculate precision for output by counting
793 ** number of digits after period. Find first
794 ** period in entire remaining list each time
795 */
796 cp2 = strchr(ptr, '.');
797 if (cp2 != NULL) {
eef02441 798 int len = 0;
435d195a
VKF
799
800 while (*++cp2 != '\0' && *cp2 >= '0' && *cp2 <= '9')
801 len++;
802
3e260a46 803 if (o->off2) {
f0fdbcaf 804 ilp = td_var(data, o, o->off2);
3e260a46
JA
805 if (len > *ilp)
806 *ilp = len;
807 }
435d195a
VKF
808 }
809
83349190
YH
810 break;
811 }
af52b345
JA
812 case FIO_OPT_STR_STORE: {
813 fio_opt_str_fn *fn = o->cb;
814
f75c69a1
JA
815 if (!strlen(ptr))
816 return 1;
817
7b504edd 818 if (o->off1) {
f0fdbcaf 819 cp = td_var(data, o, o->off1);
ce27f93c
DP
820 if (*cp)
821 free(*cp);
184b4098 822 *cp = strdup(ptr);
46576743
SW
823 if (strlen(ptr) > o->maxlen - 1) {
824 log_err("value exceeds max length of %d\n",
825 o->maxlen);
826 return 1;
827 }
1c964ce5 828 }
02c6aad5 829
184b4098
SL
830 if (fn)
831 ret = fn(data, ptr);
832 else if (o->posval[0].ival) {
833 posval_sort(o, posval);
834
835 ret = 1;
836 for (i = 0; i < PARSE_MAX_VP; i++) {
837 vp = &posval[i];
ab50817f 838 if (!vp->ival || vp->ival[0] == '\0' || !cp)
184b4098
SL
839 continue;
840 all_skipped = 0;
119cd939 841 if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
184b4098
SL
842 char *rest;
843
844 ret = 0;
845 if (vp->cb)
846 fn = vp->cb;
847 rest = strstr(*cp ?: ptr, ":");
848 if (rest) {
849 if (*cp)
850 *rest = '\0';
851 ptr = rest + 1;
852 } else
853 ptr = NULL;
854 break;
855 }
af52b345
JA
856 }
857 }
c44b1ff5 858
184b4098
SL
859 if (!all_skipped) {
860 if (ret && !*cp)
861 show_option_values(o);
862 else if (ret && *cp)
863 ret = 0;
864 else if (fn && ptr)
865 ret = fn(data, ptr);
866 }
c44b1ff5 867
e1f36503 868 break;
af52b345 869 }
e1f36503 870 case FIO_OPT_RANGE: {
b765a372 871 char tmp[128];
e1f36503
JA
872 char *p1, *p2;
873
36833fb0 874 snprintf(tmp, sizeof(tmp), "%s", ptr);
b765a372 875
31d23f47
DE
876 /* Handle bsrange with separate read,write values: */
877 p1 = strchr(tmp, ',');
878 if (p1)
879 *p1 = '\0';
880
b765a372 881 p1 = strchr(tmp, '-');
e1f36503 882 if (!p1) {
0c9baf91
JA
883 p1 = strchr(tmp, ':');
884 if (!p1) {
885 ret = 1;
886 break;
887 }
e1f36503
JA
888 }
889
890 p2 = p1 + 1;
891 *p1 = '\0';
b765a372 892 p1 = tmp;
e1f36503
JA
893
894 ret = 1;
5fff9543
JF
895 if (!check_range_bytes(p1, &ull1, data) &&
896 !check_range_bytes(p2, &ull2, data)) {
e1f36503 897 ret = 0;
5fff9543
JF
898 if (ull1 > ull2) {
899 unsigned long long foo = ull1;
f90eff5a 900
5fff9543
JF
901 ull1 = ull2;
902 ull2 = foo;
f90eff5a
JA
903 }
904
905 if (first) {
5fff9543
JF
906 val_store(ullp, ull1, o->off1, 0, data, o);
907 val_store(ullp, ull2, o->off2, 0, data, o);
17abbe89 908 }
6eaf09d6 909 if (curr == 1) {
7b504edd 910 if (o->off3 && o->off4) {
5fff9543
JF
911 val_store(ullp, ull1, o->off3, 0, data, o);
912 val_store(ullp, ull2, o->off4, 0, data, o);
6eaf09d6
SL
913 }
914 }
915 if (curr == 2) {
7b504edd 916 if (o->off5 && o->off6) {
5fff9543
JF
917 val_store(ullp, ull1, o->off5, 0, data, o);
918 val_store(ullp, ull2, o->off6, 0, data, o);
6eaf09d6
SL
919 }
920 }
921 if (!more) {
922 if (curr < 1) {
7b504edd 923 if (o->off3 && o->off4) {
5fff9543
JF
924 val_store(ullp, ull1, o->off3, 0, data, o);
925 val_store(ullp, ull2, o->off4, 0, data, o);
6eaf09d6
SL
926 }
927 }
928 if (curr < 2) {
7b504edd 929 if (o->off5 && o->off6) {
5fff9543
JF
930 val_store(ullp, ull1, o->off5, 0, data, o);
931 val_store(ullp, ull2, o->off6, 0, data, o);
6eaf09d6
SL
932 }
933 }
e1f36503 934 }
17abbe89
JA
935 }
936
e1f36503
JA
937 break;
938 }
74ba1808
JA
939 case FIO_OPT_BOOL:
940 case FIO_OPT_STR_SET: {
e1f36503
JA
941 fio_opt_int_fn *fn = o->cb;
942
74ba1808
JA
943 if (ptr)
944 ret = check_int(ptr, &il);
945 else if (o->type == FIO_OPT_BOOL)
946 ret = 1;
947 else
948 il = 1;
949
ae3fcb5a
JA
950 dprint(FD_PARSE, " ret=%d, out=%d\n", ret, il);
951
e1f36503
JA
952 if (ret)
953 break;
954
db8e0165 955 if (o->maxval && il > (int) o->maxval) {
5fff9543 956 log_err("max value out of range: %d (%llu max)\n",
5ec10eaa 957 il, o->maxval);
db8e0165
JA
958 return 1;
959 }
960 if (o->minval && il < o->minval) {
28d7c363 961 log_err("min value out of range: %d (%d min)\n",
5ec10eaa 962 il, o->minval);
db8e0165
JA
963 return 1;
964 }
e1f36503 965
76a43db4
JA
966 if (o->neg)
967 il = !il;
968
e1f36503
JA
969 if (fn)
970 ret = fn(data, &il);
971 else {
7b504edd
JA
972 if (first)
973 val_store(ilp, il, o->off1, 0, data, o);
02c6aad5 974 if (!more) {
7b504edd
JA
975 if (o->off2)
976 val_store(ilp, il, o->off2, 0, data, o);
02c6aad5 977 }
e1f36503
JA
978 }
979 break;
980 }
15ca150e 981 case FIO_OPT_DEPRECATED:
d9472271 982 ret = 1;
87933e32 983 fio_fallthrough;
c47537ee
JA
984 case FIO_OPT_SOFT_DEPRECATED:
985 log_info("Option %s is deprecated\n", o->name);
15ca150e 986 break;
e1f36503 987 default:
06b0be6e 988 log_err("Bad option type %u\n", o->type);
e1f36503
JA
989 ret = 1;
990 }
cb2c86fd 991
70a4c0c8
JA
992 if (ret)
993 return ret;
994
d447a8c2 995 if (o->verify) {
70a4c0c8 996 ret = o->verify(o, data);
d447a8c2 997 if (ret) {
28d7c363
JA
998 log_err("Correct format for offending option\n");
999 log_err("%20s: %s\n", o->name, o->help);
06b0be6e 1000 show_option_help(o, 1);
d447a8c2
JA
1001 }
1002 }
70a4c0c8 1003
e1f36503 1004 return ret;
cb2c86fd
JA
1005}
1006
9109883a
BVA
1007static int handle_option(const struct fio_option *o, const char *__ptr,
1008 void *data)
f90eff5a 1009{
b62bdf2c
JA
1010 char *o_ptr, *ptr, *ptr2;
1011 int ret, done;
f90eff5a 1012
7c8f1a5c
JA
1013 dprint(FD_PARSE, "handle_option=%s, ptr=%s\n", o->name, __ptr);
1014
b62bdf2c 1015 o_ptr = ptr = NULL;
7c8f1a5c 1016 if (__ptr)
b62bdf2c 1017 o_ptr = ptr = strdup(__ptr);
a3d741fa 1018
f90eff5a 1019 /*
b62bdf2c
JA
1020 * See if we have another set of parameters, hidden after a comma.
1021 * Do this before parsing this round, to check if we should
787f7e95 1022 * copy set 1 options to set 2.
f90eff5a 1023 */
b62bdf2c
JA
1024 done = 0;
1025 ret = 1;
1026 do {
1027 int __ret;
1028
1029 ptr2 = NULL;
1030 if (ptr &&
1031 (o->type != FIO_OPT_STR_STORE) &&
83349190 1032 (o->type != FIO_OPT_STR) &&
e97163ad 1033 (o->type != FIO_OPT_STR_ULL) &&
83349190 1034 (o->type != FIO_OPT_FLOAT_LIST)) {
b62bdf2c
JA
1035 ptr2 = strchr(ptr, ',');
1036 if (ptr2 && *(ptr2 + 1) == '\0')
1037 *ptr2 = '\0';
6eaf09d6 1038 if (o->type != FIO_OPT_STR_MULTI && o->type != FIO_OPT_RANGE) {
b62bdf2c
JA
1039 if (!ptr2)
1040 ptr2 = strchr(ptr, ':');
1041 if (!ptr2)
1042 ptr2 = strchr(ptr, '-');
1043 }
83349190
YH
1044 } else if (ptr && o->type == FIO_OPT_FLOAT_LIST) {
1045 ptr2 = strchr(ptr, ':');
b62bdf2c 1046 }
787f7e95 1047
b62bdf2c
JA
1048 /*
1049 * Don't return early if parsing the first option fails - if
1050 * we are doing multiple arguments, we can allow the first one
1051 * being empty.
1052 */
83349190 1053 __ret = __handle_option(o, ptr, data, !done, !!ptr2, done);
b62bdf2c
JA
1054 if (ret)
1055 ret = __ret;
787f7e95 1056
b62bdf2c
JA
1057 if (!ptr2)
1058 break;
f90eff5a 1059
b62bdf2c
JA
1060 ptr = ptr2 + 1;
1061 done++;
1062 } while (1);
787f7e95 1063
b62bdf2c
JA
1064 if (o_ptr)
1065 free(o_ptr);
1066 return ret;
f90eff5a
JA
1067}
1068
75e6bcba
JA
1069struct fio_option *find_option(struct fio_option *options, const char *opt)
1070{
1071 struct fio_option *o;
1072
1073 for (o = &options[0]; o->name; o++) {
1074 if (!o_match(o, opt))
1075 continue;
1076 if (o->type == FIO_OPT_UNSUPPORTED) {
1077 log_err("Option <%s>: %s\n", o->name, o->help);
1078 continue;
1079 }
1080
1081 return o;
1082 }
1083
1084 return NULL;
1085}
1086
9109883a
BVA
1087const struct fio_option *
1088find_option_c(const struct fio_option *options, const char *opt)
1089{
40938cde
TK
1090 const struct fio_option *o;
1091
1092 for (o = &options[0]; o->name; o++) {
1093 if (!o_match(o, opt))
1094 continue;
1095 if (o->type == FIO_OPT_UNSUPPORTED) {
1096 log_err("Option <%s>: %s\n", o->name, o->help);
1097 continue;
1098 }
1099
1100 return o;
1101 }
1102
1103 return NULL;
9109883a 1104}
75e6bcba 1105
9109883a
BVA
1106static const struct fio_option *
1107get_option(char *opt, const struct fio_option *options, char **post)
3b8b7135 1108{
9109883a 1109 const struct fio_option *o;
3b8b7135
JA
1110 char *ret;
1111
1112 ret = strchr(opt, '=');
1113 if (ret) {
1114 *post = ret;
1115 *ret = '\0';
de890a1e 1116 ret = opt;
3b8b7135 1117 (*post)++;
43c129b4 1118 strip_blank_end(ret);
9109883a 1119 o = find_option_c(options, ret);
3b8b7135 1120 } else {
9109883a 1121 o = find_option_c(options, opt);
3b8b7135
JA
1122 *post = NULL;
1123 }
1124
1125 return o;
1126}
1127
1128static int opt_cmp(const void *p1, const void *p2)
1129{
9109883a 1130 const struct fio_option *o;
de890a1e 1131 char *s, *foo;
8cdabc1d 1132 int prio1, prio2;
3b8b7135 1133
8cdabc1d 1134 prio1 = prio2 = 0;
3b8b7135 1135
de890a1e
SL
1136 if (*(char **)p1) {
1137 s = strdup(*((char **) p1));
9af4a244 1138 o = get_option(s, __fio_options, &foo);
de890a1e
SL
1139 if (o)
1140 prio1 = o->prio;
1141 free(s);
1142 }
1143 if (*(char **)p2) {
1144 s = strdup(*((char **) p2));
9af4a244 1145 o = get_option(s, __fio_options, &foo);
de890a1e
SL
1146 if (o)
1147 prio2 = o->prio;
1148 free(s);
1149 }
1150
8cdabc1d 1151 return prio2 - prio1;
3b8b7135
JA
1152}
1153
9109883a 1154void sort_options(char **opts, const struct fio_option *options, int num_opts)
3b8b7135 1155{
9af4a244 1156 __fio_options = options;
3b8b7135 1157 qsort(opts, num_opts, sizeof(char *), opt_cmp);
9af4a244 1158 __fio_options = NULL;
3b8b7135
JA
1159}
1160
9109883a
BVA
1161static void add_to_dump_list(const struct fio_option *o,
1162 struct flist_head *dump_list, const char *post)
d8b4f395
JA
1163{
1164 struct print_option *p;
1165
1166 if (!dump_list)
1167 return;
1168
1169 p = malloc(sizeof(*p));
1170 p->name = strdup(o->name);
1171 if (post)
1172 p->value = strdup(post);
1173 else
1174 p->value = NULL;
1175
1176 flist_add_tail(&p->list, dump_list);
1177}
1178
b4692828 1179int parse_cmd_option(const char *opt, const char *val,
9109883a 1180 const struct fio_option *options, void *data,
d8b4f395 1181 struct flist_head *dump_list)
b4692828 1182{
9109883a 1183 const struct fio_option *o;
b4692828 1184
9109883a 1185 o = find_option_c(options, opt);
b4692828 1186 if (!o) {
06b0be6e 1187 log_err("Bad option <%s>\n", opt);
b4692828
JA
1188 return 1;
1189 }
1190
d8b4f395
JA
1191 if (handle_option(o, val, data)) {
1192 log_err("fio: failed parsing %s=%s\n", opt, val);
1193 return 1;
1194 }
b1508cf9 1195
d8b4f395
JA
1196 add_to_dump_list(o, dump_list, val);
1197 return 0;
b4692828
JA
1198}
1199
9109883a
BVA
1200int parse_option(char *opt, const char *input, const struct fio_option *options,
1201 const struct fio_option **o, void *data,
c2292325 1202 struct flist_head *dump_list)
cb2c86fd 1203{
d0c814ec 1204 char *post;
e1f36503 1205
d0c814ec
SL
1206 if (!opt) {
1207 log_err("fio: failed parsing %s\n", input);
de890a1e 1208 *o = NULL;
38789b58 1209 return 1;
d0c814ec 1210 }
e1f36503 1211
de890a1e
SL
1212 *o = get_option(opt, options, &post);
1213 if (!*o) {
1214 if (post) {
1215 int len = strlen(opt);
1216 if (opt + len + 1 != post)
1217 memmove(opt + len + 1, post, strlen(post));
1218 opt[len] = '=';
1219 }
e1f36503
JA
1220 return 1;
1221 }
1222
292cc475
JA
1223 if (handle_option(*o, post, data)) {
1224 log_err("fio: failed parsing %s\n", input);
1225 return 1;
1226 }
b1508cf9 1227
d8b4f395 1228 add_to_dump_list(*o, dump_list, post);
292cc475 1229 return 0;
e1f36503 1230}
fd28ca49 1231
0e9f7fac
JA
1232/*
1233 * Option match, levenshtein distance. Handy for not quite remembering what
1234 * the option name is.
1235 */
a893c261 1236int string_distance(const char *s1, const char *s2)
0e9f7fac
JA
1237{
1238 unsigned int s1_len = strlen(s1);
1239 unsigned int s2_len = strlen(s2);
1240 unsigned int *p, *q, *r;
1241 unsigned int i, j;
1242
1243 p = malloc(sizeof(unsigned int) * (s2_len + 1));
1244 q = malloc(sizeof(unsigned int) * (s2_len + 1));
1245
1246 p[0] = 0;
1247 for (i = 1; i <= s2_len; i++)
1248 p[i] = p[i - 1] + 1;
1249
1250 for (i = 1; i <= s1_len; i++) {
1251 q[0] = p[0] + 1;
1252 for (j = 1; j <= s2_len; j++) {
1253 unsigned int sub = p[j - 1];
8a1db9a1 1254 unsigned int pmin;
0e9f7fac
JA
1255
1256 if (s1[i - 1] != s2[j - 1])
1257 sub++;
1258
8a1db9a1
JA
1259 pmin = min(q[j - 1] + 1, sub);
1260 q[j] = min(p[j] + 1, pmin);
0e9f7fac
JA
1261 }
1262 r = p;
1263 p = q;
1264 q = r;
1265 }
1266
1267 i = p[s2_len];
1268 free(p);
1269 free(q);
1270 return i;
1271}
1272
3701636d
JA
1273/*
1274 * Make a guess of whether the distance from 's1' is significant enough
1275 * to warrant printing the guess. We set this to a 1/2 match.
1276 */
1277int string_distance_ok(const char *opt, int distance)
1278{
1279 size_t len;
1280
1281 len = strlen(opt);
1282 len = (len + 1) / 2;
1283 return distance <= len;
1284}
1285
9109883a
BVA
1286static const struct fio_option *find_child(const struct fio_option *options,
1287 const struct fio_option *o)
afdf9352 1288{
9109883a 1289 const struct fio_option *__o;
afdf9352 1290
fdf28744
JA
1291 for (__o = options + 1; __o->name; __o++)
1292 if (__o->parent && !strcmp(__o->parent, o->name))
afdf9352
JA
1293 return __o;
1294
1295 return NULL;
1296}
1297
9109883a
BVA
1298static void __print_option(const struct fio_option *o,
1299 const struct fio_option *org,
323d9113 1300 int level)
afdf9352
JA
1301{
1302 char name[256], *p;
323d9113 1303 int depth;
afdf9352
JA
1304
1305 if (!o)
1306 return;
5ec10eaa 1307
afdf9352 1308 p = name;
323d9113
JA
1309 depth = level;
1310 while (depth--)
1311 p += sprintf(p, "%s", " ");
afdf9352
JA
1312
1313 sprintf(p, "%s", o->name);
1314
28d7c363 1315 log_info("%-24s: %s\n", name, o->help);
323d9113
JA
1316}
1317
9109883a 1318static void print_option(const struct fio_option *o)
323d9113 1319{
9109883a
BVA
1320 const struct fio_option *parent;
1321 const struct fio_option *__o;
323d9113
JA
1322 unsigned int printed;
1323 unsigned int level;
1324
1325 __print_option(o, NULL, 0);
1326 parent = o;
1327 level = 0;
1328 do {
1329 level++;
1330 printed = 0;
1331
1332 while ((__o = find_child(o, parent)) != NULL) {
1333 __print_option(__o, o, level);
1334 o = __o;
1335 printed++;
1336 }
1337
1338 parent = o;
1339 } while (printed);
afdf9352
JA
1340}
1341
9109883a 1342int show_cmd_help(const struct fio_option *options, const char *name)
0e9f7fac 1343{
9109883a 1344 const struct fio_option *o, *closest;
d091d099 1345 unsigned int best_dist = -1U;
29fc6afe 1346 int found = 0;
320beefe
JA
1347 int show_all = 0;
1348
1349 if (!name || !strcmp(name, "all"))
1350 show_all = 1;
fd28ca49 1351
0e9f7fac
JA
1352 closest = NULL;
1353 best_dist = -1;
4945ba12 1354 for (o = &options[0]; o->name; o++) {
320beefe
JA
1355 int match = 0;
1356
c47537ee
JA
1357 if (o->type == FIO_OPT_DEPRECATED ||
1358 o->type == FIO_OPT_SOFT_DEPRECATED)
15ca150e 1359 continue;
07b3232d
JA
1360 if (!exec_profile && o->prof_name)
1361 continue;
4ac23d27
JA
1362 if (exec_profile && !(o->prof_name && !strcmp(exec_profile, o->prof_name)))
1363 continue;
15ca150e 1364
0e9f7fac 1365 if (name) {
7f9348f8
JA
1366 if (!strcmp(name, o->name) ||
1367 (o->alias && !strcmp(name, o->alias)))
0e9f7fac
JA
1368 match = 1;
1369 else {
1370 unsigned int dist;
1371
1372 dist = string_distance(name, o->name);
1373 if (dist < best_dist) {
1374 best_dist = dist;
1375 closest = o;
1376 }
1377 }
1378 }
fd28ca49
JA
1379
1380 if (show_all || match) {
29fc6afe 1381 found = 1;
c167dedc 1382 if (match)
28d7c363 1383 log_info("%20s: %s\n", o->name, o->help);
c167dedc 1384 if (show_all) {
afdf9352 1385 if (!o->parent)
323d9113 1386 print_option(o);
4945ba12 1387 continue;
c167dedc 1388 }
fd28ca49
JA
1389 }
1390
70df2f19
JA
1391 if (!match)
1392 continue;
1393
06b0be6e 1394 show_option_help(o, 0);
fd28ca49
JA
1395 }
1396
29fc6afe
JA
1397 if (found)
1398 return 0;
fd28ca49 1399
28d7c363 1400 log_err("No such command: %s", name);
d091d099
JA
1401
1402 /*
1403 * Only print an appropriately close option, one where the edit
1404 * distance isn't too big. Otherwise we get crazy matches.
1405 */
1406 if (closest && best_dist < 3) {
28d7c363
JA
1407 log_info(" - showing closest match\n");
1408 log_info("%20s: %s\n", closest->name, closest->help);
06b0be6e 1409 show_option_help(closest, 0);
0e9f7fac 1410 } else
28d7c363 1411 log_info("\n");
0e9f7fac 1412
29fc6afe 1413 return 1;
fd28ca49 1414}
ee738499 1415
13335ddb
JA
1416/*
1417 * Handle parsing of default parameters.
1418 */
9109883a 1419void fill_default_options(void *data, const struct fio_option *options)
ee738499 1420{
9109883a 1421 const struct fio_option *o;
ee738499 1422
a3d741fa
JA
1423 dprint(FD_PARSE, "filling default options\n");
1424
4945ba12 1425 for (o = &options[0]; o->name; o++)
ee738499
JA
1426 if (o->def)
1427 handle_option(o, o->def, data);
ee738499 1428}
13335ddb 1429
8aa89d70 1430static void option_init(struct fio_option *o)
9f988e2e 1431{
c47537ee
JA
1432 if (o->type == FIO_OPT_DEPRECATED || o->type == FIO_OPT_UNSUPPORTED ||
1433 o->type == FIO_OPT_SOFT_DEPRECATED)
9f988e2e 1434 return;
bbcacb72
JA
1435 if (o->name && !o->lname)
1436 log_err("Option %s: missing long option name\n", o->name);
9f988e2e
JA
1437 if (o->type == FIO_OPT_BOOL) {
1438 o->minval = 0;
1439 o->maxval = 1;
1440 }
d4fc2f04
JA
1441 if (o->type == FIO_OPT_INT) {
1442 if (!o->maxval)
1443 o->maxval = UINT_MAX;
1444 }
5fff9543
JF
1445 if (o->type == FIO_OPT_ULL) {
1446 if (!o->maxval)
1447 o->maxval = ULLONG_MAX;
1448 }
c8931876 1449 if (o->type == FIO_OPT_STR_SET && o->def && !o->no_warn_def) {
06b0be6e 1450 log_err("Option %s: string set option with"
9f988e2e
JA
1451 " default will always be true\n", o->name);
1452 }
7b504edd 1453 if (!o->cb && !o->off1)
06b0be6e 1454 log_err("Option %s: neither cb nor offset given\n", o->name);
22754746 1455 if (!o->category) {
cca5b5bc 1456 log_info("Option %s: no category defined. Setting to misc\n", o->name);
22754746 1457 o->category = FIO_OPT_C_GENERAL;
ffd7821f 1458 o->group = FIO_OPT_G_INVALID;
22754746 1459 }
9f988e2e
JA
1460}
1461
13335ddb
JA
1462/*
1463 * Sanitize the options structure. For now it just sets min/max for bool
5b0a8880 1464 * values and whether both callback and offsets are given.
13335ddb
JA
1465 */
1466void options_init(struct fio_option *options)
1467{
4945ba12 1468 struct fio_option *o;
13335ddb 1469
a3d741fa
JA
1470 dprint(FD_PARSE, "init options\n");
1471
90265353 1472 for (o = &options[0]; o->name; o++) {
9f988e2e 1473 option_init(o);
90265353
JA
1474 if (o->inverse)
1475 o->inv_opt = find_option(options, o->inverse);
1476 }
13335ddb 1477}
7e356b2d 1478
9109883a 1479void options_mem_dupe(const struct fio_option *options, void *data)
53b5693d 1480{
9109883a 1481 const struct fio_option *o;
53b5693d
TK
1482 char **ptr;
1483
1484 dprint(FD_PARSE, "dup options\n");
1485
1486 for (o = &options[0]; o->name; o++) {
1487 if (o->type != FIO_OPT_STR_STORE)
1488 continue;
1489
1490 ptr = td_var(data, o, o->off1);
1491 if (*ptr)
1492 *ptr = strdup(*ptr);
1493 }
1494}
1495
9109883a 1496void options_free(const struct fio_option *options, void *data)
7e356b2d 1497{
9109883a 1498 const struct fio_option *o;
7e356b2d
JA
1499 char **ptr;
1500
1501 dprint(FD_PARSE, "free options\n");
1502
1503 for (o = &options[0]; o->name; o++) {
43f466e6 1504 if (o->type != FIO_OPT_STR_STORE || !o->off1 || o->no_free)
7e356b2d
JA
1505 continue;
1506
f0fdbcaf 1507 ptr = td_var(data, o, o->off1);
7e356b2d
JA
1508 if (*ptr) {
1509 free(*ptr);
1510 *ptr = NULL;
1511 }
1512 }
1513}