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