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
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;
3c3ed070 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;
6eaf09d6
SL
417 char tmp[128], *p;
418
419 strncpy(tmp, ptr, sizeof(tmp) - 1);
420 p = strchr(tmp, ',');
421 if (p)
422 *p = '\0';
e42b01eb
JA
423
424 if (is_time)
6eaf09d6 425 ret = check_str_time(tmp, &ull);
e42b01eb 426 else
6eaf09d6 427 ret = check_str_bytes(tmp, &ull, data);
e1f36503
JA
428
429 if (ret)
430 break;
431
db8e0165 432 if (o->maxval && ull > o->maxval) {
d4fc2f04
JA
433 log_err("max value out of range: %llu"
434 " (%u max)\n", ull, o->maxval);
db8e0165
JA
435 return 1;
436 }
437 if (o->minval && ull < o->minval) {
d4fc2f04
JA
438 log_err("min value out of range: %llu"
439 " (%u min)\n", ull, o->minval);
db8e0165
JA
440 return 1;
441 }
e1f36503
JA
442
443 if (fn)
444 ret = fn(data, &ull);
445 else {
e01b22b8 446 if (o->type == FIO_OPT_INT) {
02c6aad5
JA
447 if (first) {
448 if (o->roff1)
7758d4f0 449 *(unsigned int *) o->roff1 = ull;
02c6aad5 450 else
5f6ddf1e 451 val_store(ilp, ull, o->off1, 0, data);
02c6aad5 452 }
6eaf09d6 453 if (curr == 1) {
02c6aad5 454 if (o->roff2)
7758d4f0 455 *(unsigned int *) o->roff2 = ull;
02c6aad5 456 else if (o->off2)
5f6ddf1e 457 val_store(ilp, ull, o->off2, 0, data);
02c6aad5 458 }
6eaf09d6
SL
459 if (curr == 2) {
460 if (o->roff3)
461 *(unsigned int *) o->roff3 = ull;
462 else if (o->off3)
463 val_store(ilp, ull, o->off3, 0, data);
464 }
465 if (!more) {
466 if (curr < 1) {
467 if (o->roff2)
468 *(unsigned int *) o->roff2 = ull;
469 else if (o->off2)
470 val_store(ilp, ull, o->off2, 0, data);
471 }
472 if (curr < 2) {
473 if (o->roff3)
474 *(unsigned int *) o->roff3 = ull;
475 else if (o->off3)
476 val_store(ilp, ull, o->off3, 0, data);
477 }
478 }
75e6f36f 479 } else {
02c6aad5
JA
480 if (first) {
481 if (o->roff1)
482 *(unsigned long long *) o->roff1 = ull;
483 else
5f6ddf1e 484 val_store(ullp, ull, o->off1, 0, data);
02c6aad5
JA
485 }
486 if (!more) {
487 if (o->roff2)
488 *(unsigned long long *) o->roff2 = ull;
489 else if (o->off2)
5f6ddf1e 490 val_store(ullp, ull, o->off2, 0, data);
02c6aad5 491 }
75e6f36f 492 }
e1f36503
JA
493 }
494 break;
495 }
83349190
YH
496 case FIO_OPT_FLOAT_LIST: {
497
498 if (first) {
499 ul2 = 1;
500 ilp = td_var(data, o->off2);
501 *ilp = ul2;
502 }
503 if (curr >= o->maxlen) {
28d7c363 504 log_err("the list exceeding max length %d\n",
83349190
YH
505 o->maxlen);
506 return 1;
507 }
3c3ed070 508 if (!str_to_float(ptr, &uf)) {
28d7c363 509 log_err("not a floating point value: %s\n", ptr);
83349190
YH
510 return 1;
511 }
512 if (!isnan(o->maxfp) && uf > o->maxfp) {
28d7c363 513 log_err("value out of range: %f"
83349190
YH
514 " (range max: %f)\n", uf, o->maxfp);
515 return 1;
516 }
517 if (!isnan(o->minfp) && uf < o->minfp) {
28d7c363 518 log_err("value out of range: %f"
83349190
YH
519 " (range min: %f)\n", uf, o->minfp);
520 return 1;
521 }
522
523 flp = td_var(data, o->off1);
524 flp[curr] = uf;
525
526 break;
527 }
af52b345
JA
528 case FIO_OPT_STR_STORE: {
529 fio_opt_str_fn *fn = o->cb;
530
184b4098
SL
531 if (o->roff1 || o->off1) {
532 if (o->roff1)
533 cp = (char **) o->roff1;
534 else if (o->off1)
535 cp = td_var(data, o->off1);
536
537 *cp = strdup(ptr);
538 } else {
539 cp = NULL;
1c964ce5 540 }
02c6aad5 541
184b4098
SL
542 if (fn)
543 ret = fn(data, ptr);
544 else if (o->posval[0].ival) {
545 posval_sort(o, posval);
546
547 ret = 1;
548 for (i = 0; i < PARSE_MAX_VP; i++) {
549 vp = &posval[i];
550 if (!vp->ival || vp->ival[0] == '\0')
551 continue;
552 all_skipped = 0;
553 if (!strncmp(vp->ival, ptr, opt_len(ptr))) {
554 char *rest;
555
556 ret = 0;
557 if (vp->cb)
558 fn = vp->cb;
559 rest = strstr(*cp ?: ptr, ":");
560 if (rest) {
561 if (*cp)
562 *rest = '\0';
563 ptr = rest + 1;
564 } else
565 ptr = NULL;
566 break;
567 }
af52b345
JA
568 }
569 }
c44b1ff5 570
184b4098
SL
571 if (!all_skipped) {
572 if (ret && !*cp)
573 show_option_values(o);
574 else if (ret && *cp)
575 ret = 0;
576 else if (fn && ptr)
577 ret = fn(data, ptr);
578 }
c44b1ff5 579
e1f36503 580 break;
af52b345 581 }
e1f36503 582 case FIO_OPT_RANGE: {
b765a372 583 char tmp[128];
e1f36503
JA
584 char *p1, *p2;
585
0bbab0e7 586 strncpy(tmp, ptr, sizeof(tmp) - 1);
b765a372 587
31d23f47
DE
588 /* Handle bsrange with separate read,write values: */
589 p1 = strchr(tmp, ',');
590 if (p1)
591 *p1 = '\0';
592
b765a372 593 p1 = strchr(tmp, '-');
e1f36503 594 if (!p1) {
0c9baf91
JA
595 p1 = strchr(tmp, ':');
596 if (!p1) {
597 ret = 1;
598 break;
599 }
e1f36503
JA
600 }
601
602 p2 = p1 + 1;
603 *p1 = '\0';
b765a372 604 p1 = tmp;
e1f36503
JA
605
606 ret = 1;
d6978a32
JA
607 if (!check_range_bytes(p1, &ul1, data) &&
608 !check_range_bytes(p2, &ul2, data)) {
e1f36503 609 ret = 0;
e1f36503 610 if (ul1 > ul2) {
f90eff5a
JA
611 unsigned long foo = ul1;
612
613 ul1 = ul2;
614 ul2 = foo;
615 }
616
617 if (first) {
02c6aad5 618 if (o->roff1)
7758d4f0 619 *(unsigned int *) o->roff1 = ul1;
02c6aad5 620 else
5f6ddf1e 621 val_store(ilp, ul1, o->off1, 0, data);
02c6aad5 622 if (o->roff2)
7758d4f0 623 *(unsigned int *) o->roff2 = ul2;
02c6aad5 624 else
5f6ddf1e 625 val_store(ilp, ul2, o->off2, 0, data);
17abbe89 626 }
6eaf09d6
SL
627 if (curr == 1) {
628 if (o->roff3 && o->roff4) {
629 *(unsigned int *) o->roff3 = ul1;
630 *(unsigned int *) o->roff4 = ul2;
631 } else if (o->off3 && o->off4) {
632 val_store(ilp, ul1, o->off3, 0, data);
633 val_store(ilp, ul2, o->off4, 0, data);
634 }
635 }
636 if (curr == 2) {
637 if (o->roff5 && o->roff6) {
638 *(unsigned int *) o->roff5 = ul1;
639 *(unsigned int *) o->roff6 = ul2;
640 } else if (o->off5 && o->off6) {
641 val_store(ilp, ul1, o->off5, 0, data);
642 val_store(ilp, ul2, o->off6, 0, data);
643 }
644 }
645 if (!more) {
646 if (curr < 1) {
647 if (o->roff3 && o->roff4) {
648 *(unsigned int *) o->roff3 = ul1;
649 *(unsigned int *) o->roff4 = ul2;
650 } else if (o->off3 && o->off4) {
651 val_store(ilp, ul1, o->off3, 0, data);
652 val_store(ilp, ul2, o->off4, 0, data);
653 }
654 }
655 if (curr < 2) {
656 if (o->roff5 && o->roff6) {
657 *(unsigned int *) o->roff5 = ul1;
658 *(unsigned int *) o->roff6 = ul2;
659 } else if (o->off5 && o->off6) {
660 val_store(ilp, ul1, o->off5, 0, data);
661 val_store(ilp, ul2, o->off6, 0, data);
662 }
663 }
e1f36503 664 }
17abbe89
JA
665 }
666
e1f36503
JA
667 break;
668 }
74ba1808
JA
669 case FIO_OPT_BOOL:
670 case FIO_OPT_STR_SET: {
e1f36503
JA
671 fio_opt_int_fn *fn = o->cb;
672
74ba1808
JA
673 if (ptr)
674 ret = check_int(ptr, &il);
675 else if (o->type == FIO_OPT_BOOL)
676 ret = 1;
677 else
678 il = 1;
679
e1f36503
JA
680 if (ret)
681 break;
682
db8e0165 683 if (o->maxval && il > (int) o->maxval) {
28d7c363 684 log_err("max value out of range: %d (%d max)\n",
5ec10eaa 685 il, o->maxval);
db8e0165
JA
686 return 1;
687 }
688 if (o->minval && il < o->minval) {
28d7c363 689 log_err("min value out of range: %d (%d min)\n",
5ec10eaa 690 il, o->minval);
db8e0165
JA
691 return 1;
692 }
e1f36503 693
76a43db4
JA
694 if (o->neg)
695 il = !il;
696
e1f36503
JA
697 if (fn)
698 ret = fn(data, &il);
699 else {
02c6aad5
JA
700 if (first) {
701 if (o->roff1)
702 *(unsigned int *)o->roff1 = il;
703 else
5f6ddf1e 704 val_store(ilp, il, o->off1, 0, data);
02c6aad5
JA
705 }
706 if (!more) {
707 if (o->roff2)
708 *(unsigned int *) o->roff2 = il;
709 else if (o->off2)
5f6ddf1e 710 val_store(ilp, il, o->off2, 0, data);
02c6aad5 711 }
e1f36503
JA
712 }
713 break;
714 }
15ca150e 715 case FIO_OPT_DEPRECATED:
06b0be6e 716 log_info("Option %s is deprecated\n", o->name);
15ca150e 717 break;
e1f36503 718 default:
06b0be6e 719 log_err("Bad option type %u\n", o->type);
e1f36503
JA
720 ret = 1;
721 }
cb2c86fd 722
70a4c0c8
JA
723 if (ret)
724 return ret;
725
d447a8c2 726 if (o->verify) {
70a4c0c8 727 ret = o->verify(o, data);
d447a8c2 728 if (ret) {
28d7c363
JA
729 log_err("Correct format for offending option\n");
730 log_err("%20s: %s\n", o->name, o->help);
06b0be6e 731 show_option_help(o, 1);
d447a8c2
JA
732 }
733 }
70a4c0c8 734
e1f36503 735 return ret;
cb2c86fd
JA
736}
737
7c8f1a5c 738static int handle_option(struct fio_option *o, const char *__ptr, void *data)
f90eff5a 739{
b62bdf2c
JA
740 char *o_ptr, *ptr, *ptr2;
741 int ret, done;
f90eff5a 742
7c8f1a5c
JA
743 dprint(FD_PARSE, "handle_option=%s, ptr=%s\n", o->name, __ptr);
744
b62bdf2c 745 o_ptr = ptr = NULL;
7c8f1a5c 746 if (__ptr)
b62bdf2c 747 o_ptr = ptr = strdup(__ptr);
a3d741fa 748
f90eff5a 749 /*
b62bdf2c
JA
750 * See if we have another set of parameters, hidden after a comma.
751 * Do this before parsing this round, to check if we should
787f7e95 752 * copy set 1 options to set 2.
f90eff5a 753 */
b62bdf2c
JA
754 done = 0;
755 ret = 1;
756 do {
757 int __ret;
758
759 ptr2 = NULL;
760 if (ptr &&
761 (o->type != FIO_OPT_STR_STORE) &&
83349190
YH
762 (o->type != FIO_OPT_STR) &&
763 (o->type != FIO_OPT_FLOAT_LIST)) {
b62bdf2c
JA
764 ptr2 = strchr(ptr, ',');
765 if (ptr2 && *(ptr2 + 1) == '\0')
766 *ptr2 = '\0';
6eaf09d6 767 if (o->type != FIO_OPT_STR_MULTI && o->type != FIO_OPT_RANGE) {
b62bdf2c
JA
768 if (!ptr2)
769 ptr2 = strchr(ptr, ':');
770 if (!ptr2)
771 ptr2 = strchr(ptr, '-');
772 }
83349190
YH
773 } else if (ptr && o->type == FIO_OPT_FLOAT_LIST) {
774 ptr2 = strchr(ptr, ':');
b62bdf2c 775 }
787f7e95 776
b62bdf2c
JA
777 /*
778 * Don't return early if parsing the first option fails - if
779 * we are doing multiple arguments, we can allow the first one
780 * being empty.
781 */
83349190 782 __ret = __handle_option(o, ptr, data, !done, !!ptr2, done);
b62bdf2c
JA
783 if (ret)
784 ret = __ret;
787f7e95 785
b62bdf2c
JA
786 if (!ptr2)
787 break;
f90eff5a 788
b62bdf2c
JA
789 ptr = ptr2 + 1;
790 done++;
791 } while (1);
787f7e95 792
b62bdf2c
JA
793 if (o_ptr)
794 free(o_ptr);
795 return ret;
f90eff5a
JA
796}
797
de890a1e 798static struct fio_option *get_option(char *opt,
07b3232d 799 struct fio_option *options, char **post)
3b8b7135
JA
800{
801 struct fio_option *o;
802 char *ret;
803
804 ret = strchr(opt, '=');
805 if (ret) {
806 *post = ret;
807 *ret = '\0';
de890a1e 808 ret = opt;
3b8b7135 809 (*post)++;
43c129b4 810 strip_blank_end(ret);
07b3232d 811 o = find_option(options, ret);
3b8b7135 812 } else {
07b3232d 813 o = find_option(options, opt);
3b8b7135
JA
814 *post = NULL;
815 }
816
817 return o;
818}
819
820static int opt_cmp(const void *p1, const void *p2)
821{
de890a1e
SL
822 struct fio_option *o;
823 char *s, *foo;
8cdabc1d 824 int prio1, prio2;
3b8b7135 825
8cdabc1d 826 prio1 = prio2 = 0;
3b8b7135 827
de890a1e
SL
828 if (*(char **)p1) {
829 s = strdup(*((char **) p1));
9af4a244 830 o = get_option(s, __fio_options, &foo);
de890a1e
SL
831 if (o)
832 prio1 = o->prio;
833 free(s);
834 }
835 if (*(char **)p2) {
836 s = strdup(*((char **) p2));
9af4a244 837 o = get_option(s, __fio_options, &foo);
de890a1e
SL
838 if (o)
839 prio2 = o->prio;
840 free(s);
841 }
842
8cdabc1d 843 return prio2 - prio1;
3b8b7135
JA
844}
845
846void sort_options(char **opts, struct fio_option *options, int num_opts)
847{
9af4a244 848 __fio_options = options;
3b8b7135 849 qsort(opts, num_opts, sizeof(char *), opt_cmp);
9af4a244 850 __fio_options = NULL;
3b8b7135
JA
851}
852
b4692828 853int parse_cmd_option(const char *opt, const char *val,
07b3232d 854 struct fio_option *options, void *data)
b4692828
JA
855{
856 struct fio_option *o;
857
07b3232d 858 o = find_option(options, opt);
b4692828 859 if (!o) {
06b0be6e 860 log_err("Bad option <%s>\n", opt);
b4692828
JA
861 return 1;
862 }
863
b1508cf9
JA
864 if (!handle_option(o, val, data))
865 return 0;
866
06b0be6e 867 log_err("fio: failed parsing %s=%s\n", opt, val);
b1508cf9 868 return 1;
b4692828
JA
869}
870
de890a1e
SL
871int parse_option(char *opt, const char *input,
872 struct fio_option *options, struct fio_option **o, void *data)
cb2c86fd 873{
d0c814ec 874 char *post;
e1f36503 875
d0c814ec
SL
876 if (!opt) {
877 log_err("fio: failed parsing %s\n", input);
de890a1e 878 *o = NULL;
38789b58 879 return 1;
d0c814ec 880 }
e1f36503 881
de890a1e
SL
882 *o = get_option(opt, options, &post);
883 if (!*o) {
884 if (post) {
885 int len = strlen(opt);
886 if (opt + len + 1 != post)
887 memmove(opt + len + 1, post, strlen(post));
888 opt[len] = '=';
889 }
e1f36503
JA
890 return 1;
891 }
892
90265353 893 if (!handle_option(*o, post, data))
b1508cf9
JA
894 return 0;
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 1109 }
0a074fe4
JA
1110 if (!o->category) {
1111 log_info("Options %s: no category defined. Setting to misc\n", o->name);
e8b0e958 1112 o->category = FIO_OPT_C_GENERAL;
0a074fe4 1113 }
9f988e2e
JA
1114}
1115
13335ddb
JA
1116/*
1117 * Sanitize the options structure. For now it just sets min/max for bool
5b0a8880 1118 * values and whether both callback and offsets are given.
13335ddb
JA
1119 */
1120void options_init(struct fio_option *options)
1121{
4945ba12 1122 struct fio_option *o;
13335ddb 1123
a3d741fa
JA
1124 dprint(FD_PARSE, "init options\n");
1125
90265353 1126 for (o = &options[0]; o->name; o++) {
9f988e2e 1127 option_init(o);
90265353
JA
1128 if (o->inverse)
1129 o->inv_opt = find_option(options, o->inverse);
1130 }
13335ddb 1131}
7e356b2d
JA
1132
1133void options_free(struct fio_option *options, void *data)
1134{
1135 struct fio_option *o;
1136 char **ptr;
1137
1138 dprint(FD_PARSE, "free options\n");
1139
1140 for (o = &options[0]; o->name; o++) {
de890a1e 1141 if (o->type != FIO_OPT_STR_STORE || !o->off1)
7e356b2d
JA
1142 continue;
1143
1144 ptr = td_var(data, o->off1);
1145 if (*ptr) {
1146 free(*ptr);
1147 *ptr = NULL;
1148 }
1149 }
1150}