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