gfio: remove stale comment, hiding menu items DOES work now
[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"
cb2c86fd 17
3b8b7135 18static struct fio_option *fio_options;
d6978a32 19extern unsigned int fio_get_kb_base(void *);
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{
83349190
YH
50 if (o->type == FIO_OPT_FLOAT_LIST){
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 */
cc62ea70 223static int 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
6925dd35 263static int 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
5f6ddf1e 346#define val_store(ptr, val, off, or, data) \
17abbe89
JA
347 do { \
348 ptr = td_var((data), (off)); \
5f6ddf1e
JA
349 if ((or)) \
350 *ptr |= (val); \
351 else \
352 *ptr = (val); \
17abbe89
JA
353 } while (0)
354
f90eff5a 355static int __handle_option(struct fio_option *o, const char *ptr, void *data,
83349190 356 int first, int more, int curr)
cb2c86fd 357{
63f29372 358 int il, *ilp;
83349190 359 double* flp;
63f29372
JA
360 long long ull, *ullp;
361 long ul1, ul2;
83349190 362 double uf;
b4692828 363 char **cp;
e42b01eb 364 int ret = 0, is_time = 0;
c44b1ff5
JA
365 const struct value_pair *vp;
366 struct value_pair posval[PARSE_MAX_VP];
367 int i, all_skipped = 1;
cb2c86fd 368
a3d741fa
JA
369 dprint(FD_PARSE, "__handle_option=%s, type=%d, ptr=%s\n", o->name,
370 o->type, ptr);
371
e3cedca7 372 if (!ptr && o->type != FIO_OPT_STR_SET && o->type != FIO_OPT_STR) {
28d7c363 373 log_err("Option %s requires an argument\n", o->name);
08e26e35
JA
374 return 1;
375 }
376
e1f36503 377 switch (o->type) {
5f6ddf1e
JA
378 case FIO_OPT_STR:
379 case FIO_OPT_STR_MULTI: {
e1f36503 380 fio_opt_str_fn *fn = o->cb;
b1ec1da6 381
f085737f
JA
382 posval_sort(o, posval);
383
5f6ddf1e 384 ret = 1;
b1ec1da6 385 for (i = 0; i < PARSE_MAX_VP; i++) {
f085737f 386 vp = &posval[i];
b1ec1da6 387 if (!vp->ival || vp->ival[0] == '\0')
a3073f4a 388 continue;
ae2ddba4 389 all_skipped = 0;
808def70 390 if (!strncmp(vp->ival, ptr, opt_len(ptr))) {
b1ec1da6 391 ret = 0;
5f6ddf1e
JA
392 if (o->roff1) {
393 if (vp->or)
394 *(unsigned int *) o->roff1 |= vp->oval;
395 else
396 *(unsigned int *) o->roff1 = vp->oval;
397 } else {
02c6aad5 398 if (!o->off1)
5f6ddf1e
JA
399 continue;
400 val_store(ilp, vp->oval, o->off1, vp->or, data);
02c6aad5 401 }
5f6ddf1e 402 continue;
b1ec1da6
JA
403 }
404 }
cb2c86fd 405
ae2ddba4 406 if (ret && !all_skipped)
b1ec1da6
JA
407 show_option_values(o);
408 else if (fn)
409 ret = fn(data, ptr);
e1f36503
JA
410 break;
411 }
e42b01eb
JA
412 case FIO_OPT_STR_VAL_TIME:
413 is_time = 1;
1a1137d9 414 case FIO_OPT_INT:
e42b01eb
JA
415 case FIO_OPT_STR_VAL: {
416 fio_opt_str_val_fn *fn = o->cb;
417
418 if (is_time)
419 ret = check_str_time(ptr, &ull);
420 else
6925dd35 421 ret = check_str_bytes(ptr, &ull, data);
e1f36503
JA
422
423 if (ret)
424 break;
425
db8e0165 426 if (o->maxval && ull > o->maxval) {
28d7c363 427 log_err("max value out of range: %lld"
5ec10eaa 428 " (%d max)\n", ull, o->maxval);
db8e0165
JA
429 return 1;
430 }
431 if (o->minval && ull < o->minval) {
28d7c363 432 log_err("min value out of range: %lld"
5ec10eaa 433 " (%d min)\n", ull, o->minval);
db8e0165
JA
434 return 1;
435 }
e1f36503
JA
436
437 if (fn)
438 ret = fn(data, &ull);
439 else {
e01b22b8 440 if (o->type == FIO_OPT_INT) {
02c6aad5
JA
441 if (first) {
442 if (o->roff1)
7758d4f0 443 *(unsigned int *) o->roff1 = ull;
02c6aad5 444 else
5f6ddf1e 445 val_store(ilp, ull, o->off1, 0, data);
02c6aad5
JA
446 }
447 if (!more) {
448 if (o->roff2)
7758d4f0 449 *(unsigned int *) o->roff2 = ull;
02c6aad5 450 else if (o->off2)
5f6ddf1e 451 val_store(ilp, ull, o->off2, 0, data);
02c6aad5 452 }
75e6f36f 453 } else {
02c6aad5
JA
454 if (first) {
455 if (o->roff1)
456 *(unsigned long long *) o->roff1 = ull;
457 else
5f6ddf1e 458 val_store(ullp, ull, o->off1, 0, data);
02c6aad5
JA
459 }
460 if (!more) {
461 if (o->roff2)
462 *(unsigned long long *) o->roff2 = ull;
463 else if (o->off2)
5f6ddf1e 464 val_store(ullp, ull, o->off2, 0, data);
02c6aad5 465 }
75e6f36f 466 }
e1f36503
JA
467 }
468 break;
469 }
83349190
YH
470 case FIO_OPT_FLOAT_LIST: {
471
472 if (first) {
473 ul2 = 1;
474 ilp = td_var(data, o->off2);
475 *ilp = ul2;
476 }
477 if (curr >= o->maxlen) {
28d7c363 478 log_err("the list exceeding max length %d\n",
83349190
YH
479 o->maxlen);
480 return 1;
481 }
482 if(!str_to_float(ptr, &uf)){
28d7c363 483 log_err("not a floating point value: %s\n", ptr);
83349190
YH
484 return 1;
485 }
486 if (!isnan(o->maxfp) && uf > o->maxfp) {
28d7c363 487 log_err("value out of range: %f"
83349190
YH
488 " (range max: %f)\n", uf, o->maxfp);
489 return 1;
490 }
491 if (!isnan(o->minfp) && uf < o->minfp) {
28d7c363 492 log_err("value out of range: %f"
83349190
YH
493 " (range min: %f)\n", uf, o->minfp);
494 return 1;
495 }
496
497 flp = td_var(data, o->off1);
498 flp[curr] = uf;
499
500 break;
501 }
af52b345
JA
502 case FIO_OPT_STR_STORE: {
503 fio_opt_str_fn *fn = o->cb;
504
184b4098
SL
505 if (o->roff1 || o->off1) {
506 if (o->roff1)
507 cp = (char **) o->roff1;
508 else if (o->off1)
509 cp = td_var(data, o->off1);
510
511 *cp = strdup(ptr);
512 } else {
513 cp = NULL;
1c964ce5 514 }
02c6aad5 515
184b4098
SL
516 if (fn)
517 ret = fn(data, ptr);
518 else if (o->posval[0].ival) {
519 posval_sort(o, posval);
520
521 ret = 1;
522 for (i = 0; i < PARSE_MAX_VP; i++) {
523 vp = &posval[i];
524 if (!vp->ival || vp->ival[0] == '\0')
525 continue;
526 all_skipped = 0;
527 if (!strncmp(vp->ival, ptr, opt_len(ptr))) {
528 char *rest;
529
530 ret = 0;
531 if (vp->cb)
532 fn = vp->cb;
533 rest = strstr(*cp ?: ptr, ":");
534 if (rest) {
535 if (*cp)
536 *rest = '\0';
537 ptr = rest + 1;
538 } else
539 ptr = NULL;
540 break;
541 }
af52b345
JA
542 }
543 }
c44b1ff5 544
184b4098
SL
545 if (!all_skipped) {
546 if (ret && !*cp)
547 show_option_values(o);
548 else if (ret && *cp)
549 ret = 0;
550 else if (fn && ptr)
551 ret = fn(data, ptr);
552 }
c44b1ff5 553
e1f36503 554 break;
af52b345 555 }
e1f36503 556 case FIO_OPT_RANGE: {
b765a372 557 char tmp[128];
e1f36503
JA
558 char *p1, *p2;
559
0bbab0e7 560 strncpy(tmp, ptr, sizeof(tmp) - 1);
b765a372 561
31d23f47
DE
562 /* Handle bsrange with separate read,write values: */
563 p1 = strchr(tmp, ',');
564 if (p1)
565 *p1 = '\0';
566
b765a372 567 p1 = strchr(tmp, '-');
e1f36503 568 if (!p1) {
0c9baf91
JA
569 p1 = strchr(tmp, ':');
570 if (!p1) {
571 ret = 1;
572 break;
573 }
e1f36503
JA
574 }
575
576 p2 = p1 + 1;
577 *p1 = '\0';
b765a372 578 p1 = tmp;
e1f36503
JA
579
580 ret = 1;
d6978a32
JA
581 if (!check_range_bytes(p1, &ul1, data) &&
582 !check_range_bytes(p2, &ul2, data)) {
e1f36503 583 ret = 0;
e1f36503 584 if (ul1 > ul2) {
f90eff5a
JA
585 unsigned long foo = ul1;
586
587 ul1 = ul2;
588 ul2 = foo;
589 }
590
591 if (first) {
02c6aad5 592 if (o->roff1)
7758d4f0 593 *(unsigned int *) o->roff1 = ul1;
02c6aad5 594 else
5f6ddf1e 595 val_store(ilp, ul1, o->off1, 0, data);
02c6aad5 596 if (o->roff2)
7758d4f0 597 *(unsigned int *) o->roff2 = ul2;
02c6aad5 598 else
5f6ddf1e 599 val_store(ilp, ul2, o->off2, 0, data);
17abbe89 600 }
02c6aad5 601 if (o->roff3 && o->roff4) {
7758d4f0
JA
602 *(unsigned int *) o->roff3 = ul1;
603 *(unsigned int *) o->roff4 = ul2;
02c6aad5 604 } else if (o->off3 && o->off4) {
5f6ddf1e
JA
605 val_store(ilp, ul1, o->off3, 0, data);
606 val_store(ilp, ul2, o->off4, 0, data);
e1f36503 607 }
17abbe89
JA
608 }
609
e1f36503
JA
610 break;
611 }
74ba1808
JA
612 case FIO_OPT_BOOL:
613 case FIO_OPT_STR_SET: {
e1f36503
JA
614 fio_opt_int_fn *fn = o->cb;
615
74ba1808
JA
616 if (ptr)
617 ret = check_int(ptr, &il);
618 else if (o->type == FIO_OPT_BOOL)
619 ret = 1;
620 else
621 il = 1;
622
e1f36503
JA
623 if (ret)
624 break;
625
db8e0165 626 if (o->maxval && il > (int) o->maxval) {
28d7c363 627 log_err("max value out of range: %d (%d max)\n",
5ec10eaa 628 il, o->maxval);
db8e0165
JA
629 return 1;
630 }
631 if (o->minval && il < o->minval) {
28d7c363 632 log_err("min value out of range: %d (%d min)\n",
5ec10eaa 633 il, o->minval);
db8e0165
JA
634 return 1;
635 }
e1f36503 636
76a43db4
JA
637 if (o->neg)
638 il = !il;
639
e1f36503
JA
640 if (fn)
641 ret = fn(data, &il);
642 else {
02c6aad5
JA
643 if (first) {
644 if (o->roff1)
645 *(unsigned int *)o->roff1 = il;
646 else
5f6ddf1e 647 val_store(ilp, il, o->off1, 0, data);
02c6aad5
JA
648 }
649 if (!more) {
650 if (o->roff2)
651 *(unsigned int *) o->roff2 = il;
652 else if (o->off2)
5f6ddf1e 653 val_store(ilp, il, o->off2, 0, data);
02c6aad5 654 }
e1f36503
JA
655 }
656 break;
657 }
15ca150e 658 case FIO_OPT_DEPRECATED:
06b0be6e 659 log_info("Option %s is deprecated\n", o->name);
15ca150e 660 break;
e1f36503 661 default:
06b0be6e 662 log_err("Bad option type %u\n", o->type);
e1f36503
JA
663 ret = 1;
664 }
cb2c86fd 665
70a4c0c8
JA
666 if (ret)
667 return ret;
668
d447a8c2 669 if (o->verify) {
70a4c0c8 670 ret = o->verify(o, data);
d447a8c2 671 if (ret) {
28d7c363
JA
672 log_err("Correct format for offending option\n");
673 log_err("%20s: %s\n", o->name, o->help);
06b0be6e 674 show_option_help(o, 1);
d447a8c2
JA
675 }
676 }
70a4c0c8 677
e1f36503 678 return ret;
cb2c86fd
JA
679}
680
7c8f1a5c 681static int handle_option(struct fio_option *o, const char *__ptr, void *data)
f90eff5a 682{
b62bdf2c
JA
683 char *o_ptr, *ptr, *ptr2;
684 int ret, done;
f90eff5a 685
7c8f1a5c
JA
686 dprint(FD_PARSE, "handle_option=%s, ptr=%s\n", o->name, __ptr);
687
b62bdf2c 688 o_ptr = ptr = NULL;
7c8f1a5c 689 if (__ptr)
b62bdf2c 690 o_ptr = ptr = strdup(__ptr);
a3d741fa 691
f90eff5a 692 /*
b62bdf2c
JA
693 * See if we have another set of parameters, hidden after a comma.
694 * Do this before parsing this round, to check if we should
787f7e95 695 * copy set 1 options to set 2.
f90eff5a 696 */
b62bdf2c
JA
697 done = 0;
698 ret = 1;
699 do {
700 int __ret;
701
702 ptr2 = NULL;
703 if (ptr &&
704 (o->type != FIO_OPT_STR_STORE) &&
83349190
YH
705 (o->type != FIO_OPT_STR) &&
706 (o->type != FIO_OPT_FLOAT_LIST)) {
b62bdf2c
JA
707 ptr2 = strchr(ptr, ',');
708 if (ptr2 && *(ptr2 + 1) == '\0')
709 *ptr2 = '\0';
710 if (o->type != FIO_OPT_STR_MULTI) {
711 if (!ptr2)
712 ptr2 = strchr(ptr, ':');
713 if (!ptr2)
714 ptr2 = strchr(ptr, '-');
715 }
83349190
YH
716 } else if (ptr && o->type == FIO_OPT_FLOAT_LIST) {
717 ptr2 = strchr(ptr, ':');
b62bdf2c 718 }
787f7e95 719
b62bdf2c
JA
720 /*
721 * Don't return early if parsing the first option fails - if
722 * we are doing multiple arguments, we can allow the first one
723 * being empty.
724 */
83349190 725 __ret = __handle_option(o, ptr, data, !done, !!ptr2, done);
b62bdf2c
JA
726 if (ret)
727 ret = __ret;
787f7e95 728
b62bdf2c
JA
729 if (!ptr2)
730 break;
f90eff5a 731
b62bdf2c
JA
732 ptr = ptr2 + 1;
733 done++;
734 } while (1);
787f7e95 735
b62bdf2c
JA
736 if (o_ptr)
737 free(o_ptr);
738 return ret;
f90eff5a
JA
739}
740
de890a1e 741static struct fio_option *get_option(char *opt,
07b3232d 742 struct fio_option *options, char **post)
3b8b7135
JA
743{
744 struct fio_option *o;
745 char *ret;
746
747 ret = strchr(opt, '=');
748 if (ret) {
749 *post = ret;
750 *ret = '\0';
de890a1e 751 ret = opt;
3b8b7135 752 (*post)++;
43c129b4 753 strip_blank_end(ret);
07b3232d 754 o = find_option(options, ret);
3b8b7135 755 } else {
07b3232d 756 o = find_option(options, opt);
3b8b7135
JA
757 *post = NULL;
758 }
759
760 return o;
761}
762
763static int opt_cmp(const void *p1, const void *p2)
764{
de890a1e
SL
765 struct fio_option *o;
766 char *s, *foo;
8cdabc1d 767 int prio1, prio2;
3b8b7135 768
8cdabc1d 769 prio1 = prio2 = 0;
3b8b7135 770
de890a1e
SL
771 if (*(char **)p1) {
772 s = strdup(*((char **) p1));
773 o = get_option(s, fio_options, &foo);
774 if (o)
775 prio1 = o->prio;
776 free(s);
777 }
778 if (*(char **)p2) {
779 s = strdup(*((char **) p2));
780 o = get_option(s, fio_options, &foo);
781 if (o)
782 prio2 = o->prio;
783 free(s);
784 }
785
8cdabc1d 786 return prio2 - prio1;
3b8b7135
JA
787}
788
789void sort_options(char **opts, struct fio_option *options, int num_opts)
790{
791 fio_options = options;
792 qsort(opts, num_opts, sizeof(char *), opt_cmp);
793 fio_options = NULL;
794}
795
b4692828 796int parse_cmd_option(const char *opt, const char *val,
07b3232d 797 struct fio_option *options, void *data)
b4692828
JA
798{
799 struct fio_option *o;
800
07b3232d 801 o = find_option(options, opt);
b4692828 802 if (!o) {
06b0be6e 803 log_err("Bad option <%s>\n", opt);
b4692828
JA
804 return 1;
805 }
806
b1508cf9
JA
807 if (!handle_option(o, val, data))
808 return 0;
809
06b0be6e 810 log_err("fio: failed parsing %s=%s\n", opt, val);
b1508cf9 811 return 1;
b4692828
JA
812}
813
de890a1e
SL
814int parse_option(char *opt, const char *input,
815 struct fio_option *options, struct fio_option **o, void *data)
cb2c86fd 816{
d0c814ec 817 char *post;
e1f36503 818
d0c814ec
SL
819 if (!opt) {
820 log_err("fio: failed parsing %s\n", input);
de890a1e 821 *o = NULL;
38789b58 822 return 1;
d0c814ec 823 }
e1f36503 824
de890a1e
SL
825 *o = get_option(opt, options, &post);
826 if (!*o) {
827 if (post) {
828 int len = strlen(opt);
829 if (opt + len + 1 != post)
830 memmove(opt + len + 1, post, strlen(post));
831 opt[len] = '=';
832 }
e1f36503
JA
833 return 1;
834 }
835
de890a1e 836 if (!handle_option(*o, post, data)) {
b1508cf9 837 return 0;
0401bca6 838 }
b1508cf9 839
d0c814ec 840 log_err("fio: failed parsing %s\n", input);
b1508cf9 841 return 1;
e1f36503 842}
fd28ca49 843
0e9f7fac
JA
844/*
845 * Option match, levenshtein distance. Handy for not quite remembering what
846 * the option name is.
847 */
848static int string_distance(const char *s1, const char *s2)
849{
850 unsigned int s1_len = strlen(s1);
851 unsigned int s2_len = strlen(s2);
852 unsigned int *p, *q, *r;
853 unsigned int i, j;
854
855 p = malloc(sizeof(unsigned int) * (s2_len + 1));
856 q = malloc(sizeof(unsigned int) * (s2_len + 1));
857
858 p[0] = 0;
859 for (i = 1; i <= s2_len; i++)
860 p[i] = p[i - 1] + 1;
861
862 for (i = 1; i <= s1_len; i++) {
863 q[0] = p[0] + 1;
864 for (j = 1; j <= s2_len; j++) {
865 unsigned int sub = p[j - 1];
866
867 if (s1[i - 1] != s2[j - 1])
868 sub++;
869
870 q[j] = min(p[j] + 1, min(q[j - 1] + 1, sub));
871 }
872 r = p;
873 p = q;
874 q = r;
875 }
876
877 i = p[s2_len];
878 free(p);
879 free(q);
880 return i;
881}
882
afdf9352
JA
883static struct fio_option *find_child(struct fio_option *options,
884 struct fio_option *o)
885{
886 struct fio_option *__o;
887
fdf28744
JA
888 for (__o = options + 1; __o->name; __o++)
889 if (__o->parent && !strcmp(__o->parent, o->name))
afdf9352
JA
890 return __o;
891
892 return NULL;
893}
894
323d9113
JA
895static void __print_option(struct fio_option *o, struct fio_option *org,
896 int level)
afdf9352
JA
897{
898 char name[256], *p;
323d9113 899 int depth;
afdf9352
JA
900
901 if (!o)
902 return;
ef9aff52
JA
903 if (!org)
904 org = o;
5ec10eaa 905
afdf9352 906 p = name;
323d9113
JA
907 depth = level;
908 while (depth--)
909 p += sprintf(p, "%s", " ");
afdf9352
JA
910
911 sprintf(p, "%s", o->name);
912
28d7c363 913 log_info("%-24s: %s\n", name, o->help);
323d9113
JA
914}
915
916static void print_option(struct fio_option *o)
917{
918 struct fio_option *parent;
919 struct fio_option *__o;
920 unsigned int printed;
921 unsigned int level;
922
923 __print_option(o, NULL, 0);
924 parent = o;
925 level = 0;
926 do {
927 level++;
928 printed = 0;
929
930 while ((__o = find_child(o, parent)) != NULL) {
931 __print_option(__o, o, level);
932 o = __o;
933 printed++;
934 }
935
936 parent = o;
937 } while (printed);
afdf9352
JA
938}
939
07b3232d 940int show_cmd_help(struct fio_option *options, const char *name)
0e9f7fac
JA
941{
942 struct fio_option *o, *closest;
d091d099 943 unsigned int best_dist = -1U;
29fc6afe 944 int found = 0;
320beefe
JA
945 int show_all = 0;
946
947 if (!name || !strcmp(name, "all"))
948 show_all = 1;
fd28ca49 949
0e9f7fac
JA
950 closest = NULL;
951 best_dist = -1;
4945ba12 952 for (o = &options[0]; o->name; o++) {
320beefe
JA
953 int match = 0;
954
15ca150e
JA
955 if (o->type == FIO_OPT_DEPRECATED)
956 continue;
07b3232d
JA
957 if (!exec_profile && o->prof_name)
958 continue;
15ca150e 959
0e9f7fac 960 if (name) {
7f9348f8
JA
961 if (!strcmp(name, o->name) ||
962 (o->alias && !strcmp(name, o->alias)))
0e9f7fac
JA
963 match = 1;
964 else {
965 unsigned int dist;
966
967 dist = string_distance(name, o->name);
968 if (dist < best_dist) {
969 best_dist = dist;
970 closest = o;
971 }
972 }
973 }
fd28ca49
JA
974
975 if (show_all || match) {
29fc6afe 976 found = 1;
c167dedc 977 if (match)
28d7c363 978 log_info("%20s: %s\n", o->name, o->help);
c167dedc 979 if (show_all) {
afdf9352 980 if (!o->parent)
323d9113 981 print_option(o);
4945ba12 982 continue;
c167dedc 983 }
fd28ca49
JA
984 }
985
70df2f19
JA
986 if (!match)
987 continue;
988
06b0be6e 989 show_option_help(o, 0);
fd28ca49
JA
990 }
991
29fc6afe
JA
992 if (found)
993 return 0;
fd28ca49 994
28d7c363 995 log_err("No such command: %s", name);
d091d099
JA
996
997 /*
998 * Only print an appropriately close option, one where the edit
999 * distance isn't too big. Otherwise we get crazy matches.
1000 */
1001 if (closest && best_dist < 3) {
28d7c363
JA
1002 log_info(" - showing closest match\n");
1003 log_info("%20s: %s\n", closest->name, closest->help);
06b0be6e 1004 show_option_help(closest, 0);
0e9f7fac 1005 } else
28d7c363 1006 log_info("\n");
0e9f7fac 1007
29fc6afe 1008 return 1;
fd28ca49 1009}
ee738499 1010
13335ddb
JA
1011/*
1012 * Handle parsing of default parameters.
1013 */
ee738499
JA
1014void fill_default_options(void *data, struct fio_option *options)
1015{
4945ba12 1016 struct fio_option *o;
ee738499 1017
a3d741fa
JA
1018 dprint(FD_PARSE, "filling default options\n");
1019
4945ba12 1020 for (o = &options[0]; o->name; o++)
ee738499
JA
1021 if (o->def)
1022 handle_option(o, o->def, data);
ee738499 1023}
13335ddb 1024
9f988e2e
JA
1025void option_init(struct fio_option *o)
1026{
1027 if (o->type == FIO_OPT_DEPRECATED)
1028 return;
1029 if (o->type == FIO_OPT_BOOL) {
1030 o->minval = 0;
1031 o->maxval = 1;
1032 }
83349190
YH
1033 if (o->type == FIO_OPT_FLOAT_LIST) {
1034 o->minfp = NAN;
1035 o->maxfp = NAN;
1036 }
9f988e2e 1037 if (o->type == FIO_OPT_STR_SET && o->def) {
06b0be6e 1038 log_err("Option %s: string set option with"
9f988e2e
JA
1039 " default will always be true\n", o->name);
1040 }
06b0be6e
JA
1041 if (!o->cb && (!o->off1 && !o->roff1))
1042 log_err("Option %s: neither cb nor offset given\n", o->name);
5f6ddf1e
JA
1043 if (o->type == FIO_OPT_STR || o->type == FIO_OPT_STR_STORE ||
1044 o->type == FIO_OPT_STR_MULTI)
9f988e2e 1045 return;
e2de69da
JA
1046 if (o->cb && ((o->off1 || o->off2 || o->off3 || o->off4) ||
1047 (o->roff1 || o->roff2 || o->roff3 || o->roff4))) {
06b0be6e 1048 log_err("Option %s: both cb and offset given\n", o->name);
9f988e2e
JA
1049 }
1050}
1051
13335ddb
JA
1052/*
1053 * Sanitize the options structure. For now it just sets min/max for bool
5b0a8880 1054 * values and whether both callback and offsets are given.
13335ddb
JA
1055 */
1056void options_init(struct fio_option *options)
1057{
4945ba12 1058 struct fio_option *o;
13335ddb 1059
a3d741fa
JA
1060 dprint(FD_PARSE, "init options\n");
1061
9f988e2e
JA
1062 for (o = &options[0]; o->name; o++)
1063 option_init(o);
13335ddb 1064}
7e356b2d
JA
1065
1066void options_free(struct fio_option *options, void *data)
1067{
1068 struct fio_option *o;
1069 char **ptr;
1070
1071 dprint(FD_PARSE, "free options\n");
1072
1073 for (o = &options[0]; o->name; o++) {
de890a1e 1074 if (o->type != FIO_OPT_STR_STORE || !o->off1)
7e356b2d
JA
1075 continue;
1076
1077 ptr = td_var(data, o->off1);
1078 if (*ptr) {
1079 free(*ptr);
1080 *ptr = NULL;
1081 }
1082 }
1083}