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