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