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