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