parse.c

   1 /*
   2  * This file contains the ini and command liner parser main.
   3  */
   4 #include <stdio.h>
   5 #include <stdlib.h>
   6 #include <ctype.h>
   7 #include <string.h>
   8 #include <errno.h>
   9 #include <limits.h>
  10 #include <float.h>
  11
  12 #include "compiler/compiler.h"
  13 #include "parse.h"
  14 #include "debug.h"
  15 #include "log.h"
  16 #include "options.h"
  17 #include "optgroup.h"
  18 #include "minmax.h"
  19 #include "lib/ieee754.h"
  20 #include "lib/pow2.h"
  21
  22 #ifdef CONFIG_ARITHMETIC
  23 #include "y.tab.h"
  24 #endif
  25
  26 static const char *opt_type_names[] = {
  27         "OPT_INVALID",
  28         "OPT_STR",
  29         "OPT_STR_ULL",
  30         "OPT_STR_MULTI",
  31         "OPT_STR_VAL",
  32         "OPT_STR_VAL_TIME",
  33         "OPT_STR_STORE",
  34         "OPT_RANGE",
  35         "OPT_INT",
  36         "OPT_ULL",
  37         "OPT_BOOL",
  38         "OPT_FLOAT_LIST",
  39         "OPT_STR_SET",
  40         "OPT_STR_VAL_ZONE",
  41         "OPT_DEPRECATED",
  42         "OPT_SOFT_DEPRECATED",
  43         "OPT_UNSUPPORTED",
  44 };
  45
  46 static const struct fio_option *__fio_options;
  47
  48 static int vp_cmp(const void *p1, const void *p2)
  49 {
  50         const struct value_pair *vp1 = p1;
  51         const struct value_pair *vp2 = p2;
  52
  53         return strlen(vp2->ival) - strlen(vp1->ival);
  54 }
  55
  56 static void posval_sort(const struct fio_option *o, struct value_pair *vpmap)
  57 {
  58         const struct value_pair *vp;
  59         int entries;
  60
  61         memset(vpmap, 0, PARSE_MAX_VP * sizeof(struct value_pair));
  62
  63         for (entries = 0; entries < PARSE_MAX_VP; entries++) {
  64                 vp = &o->posval[entries];
  65                 if (!vp->ival || vp->ival[0] == '\0')
  66                         break;
  67
  68                 memcpy(&vpmap[entries], vp, sizeof(*vp));
  69         }
  70
  71         qsort(vpmap, entries, sizeof(struct value_pair), vp_cmp);
  72 }
  73
  74 static void show_option_range(const struct fio_option *o,
  75                               ssize_t (*logger)(const char *format, ...))
  76 {
  77         if (o->type == FIO_OPT_FLOAT_LIST) {
  78                 const char *sep = "";
  79                 if (!o->minfp && !o->maxfp)
  80                         return;
  81
  82                 logger("%20s: ", "range");
  83                 if (o->minfp != DBL_MIN) {
  84                         logger("min=%f", o->minfp);
  85                         sep = ", ";
  86                 }
  87                 if (o->maxfp != DBL_MAX)
  88                         logger("%smax=%f", sep, o->maxfp);
  89                 logger("\n");
  90         } else if (!o->posval[0].ival) {
  91                 if (!o->minval && !o->maxval)
  92                         return;
  93
  94                 logger("%20s: min=%d", "range", o->minval);
  95                 if (o->maxval)
  96                         logger(", max=%d", o->maxval);
  97                 logger("\n");
  98         }
  99 }
 100
 101 static void show_option_values(const struct fio_option *o)
 102 {
 103         int i;
 104
 105         for (i = 0; i < PARSE_MAX_VP; i++) {
 106                 const struct value_pair *vp = &o->posval[i];
 107
 108                 if (!vp->ival)
 109                         continue;
 110
 111                 log_info("%20s: %-10s", i == 0 ? "valid values" : "", vp->ival);
 112                 if (vp->help)
 113                         log_info(" %s", vp->help);
 114                 log_info("\n");
 115         }
 116
 117         if (i)
 118                 log_info("\n");
 119 }
 120
 121 static void show_option_help(const struct fio_option *o, int is_err)
 122 {
 123         const char *typehelp[] = {
 124                 [FIO_OPT_INVALID]         = "invalid",
 125                 [FIO_OPT_STR]             = "string (opt=bla)",
 126                 [FIO_OPT_STR_ULL]         = "string (opt=bla)",
 127                 [FIO_OPT_STR_MULTI]       = "string with possible k/m/g postfix (opt=4k)",
 128                 [FIO_OPT_STR_VAL]         = "string (opt=bla)",
 129                 [FIO_OPT_STR_VAL_TIME]    = "string with time postfix (opt=10s)",
 130                 [FIO_OPT_STR_STORE]       = "string (opt=bla)",
 131                 [FIO_OPT_RANGE]           = "one to three ranges (opt=1k-4k[,4k-8k[,1k-8k]])",
 132                 [FIO_OPT_INT]             = "integer value (opt=100)",
 133                 [FIO_OPT_ULL]             = "integer value (opt=100)",
 134                 [FIO_OPT_BOOL]            = "boolean value (opt=1)",
 135                 [FIO_OPT_FLOAT_LIST]      = "list of floating point values separated by ':' (opt=5.9:7.8)",
 136                 [FIO_OPT_STR_SET]         = "empty or boolean value ([0|1])",
 137                 [FIO_OPT_DEPRECATED]      = "deprecated",
 138                 [FIO_OPT_SOFT_DEPRECATED] = "deprecated",
 139                 [FIO_OPT_UNSUPPORTED]     = "unsupported",
 140         };
 141         ssize_t (*logger)(const char *format, ...);
 142
 143         if (is_err)
 144                 logger = log_err;
 145         else
 146                 logger = log_info;
 147
 148         if (o->alias)
 149                 logger("%20s: %s\n", "alias", o->alias);
 150
 151         logger("%20s: %s\n", "type", typehelp[o->type]);
 152         logger("%20s: %s\n", "default", o->def ? o->def : "no default");
 153         if (o->prof_name)
 154                 logger("%20s: only for profile '%s'\n", "valid", o->prof_name);
 155         show_option_range(o, logger);
 156         show_option_values(o);
 157 }
 158
 159 static unsigned long long get_mult_time(const char *str, int len,
 160                                         int is_seconds)
 161 {
 162         const char *p = str;
 163         char *c;
 164         unsigned long long mult = 1;
 165         int i;
 166
 167         /*
 168          * Go forward until we hit a non-digit, or +/- sign
 169          */
 170         while ((p - str) <= len) {
 171                 if (!isdigit((int) *p) && (*p != '+') && (*p != '-'))
 172                         break;
 173                 p++;
 174         }
 175
 176         if (!isalpha((int) *p)) {
 177                 if (is_seconds)
 178                         return 1000000UL;
 179                 else
 180                         return 1;
 181         }
 182
 183         c = strdup(p);
 184         for (i = 0; i < strlen(c); i++)
 185                 c[i] = tolower((unsigned char)c[i]);
 186
 187         if (!strncmp("us", c, 2) || !strncmp("usec", c, 4))
 188                 mult = 1;
 189         else if (!strncmp("ms", c, 2) || !strncmp("msec", c, 4))
 190                 mult = 1000;
 191         else if (!strcmp("s", c))
 192                 mult = 1000000;
 193         else if (!strcmp("m", c))
 194                 mult = 60 * 1000000UL;
 195         else if (!strcmp("h", c))
 196                 mult = 60 * 60 * 1000000UL;
 197         else if (!strcmp("d", c))
 198                 mult = 24 * 60 * 60 * 1000000ULL;
 199
 200         free(c);
 201         return mult;
 202 }
 203
 204 static int is_separator(char c)
 205 {
 206         switch (c) {
 207         case ':':
 208         case '-':
 209         case ',':
 210         case '/':
 211                 return 1;
 212         default:
 213                 return 0;
 214         }
 215 }
 216
 217 static unsigned long long __get_mult_bytes(const char *p, void *data,
 218                                            int *percent)
 219 {
 220         unsigned int kb_base = fio_get_kb_base(data);
 221         unsigned long long ret = 1;
 222         unsigned int i, pow = 0, mult = kb_base;
 223         char *c;
 224
 225         if (!p)
 226                 return 1;
 227
 228         c = strdup(p);
 229
 230         for (i = 0; i < strlen(c); i++) {
 231                 c[i] = tolower((unsigned char)c[i]);
 232                 if (is_separator(c[i])) {
 233                         c[i] = '\0';
 234                         break;
 235                 }
 236         }
 237
 238         /* If kb_base is 1000, use true units.
 239          * If kb_base is 1024, use opposite units.
 240          */
 241         if (!strncmp("pib", c, 3)) {
 242                 pow = 5;
 243                 if (kb_base == 1000)
 244                         mult = 1024;
 245                 else if (kb_base == 1024)
 246                         mult = 1000;
 247         } else if (!strncmp("tib", c, 3)) {
 248                 pow = 4;
 249                 if (kb_base == 1000)
 250                         mult = 1024;
 251                 else if (kb_base == 1024)
 252                         mult = 1000;
 253         } else if (!strncmp("gib", c, 3)) {
 254                 pow = 3;
 255                 if (kb_base == 1000)
 256                         mult = 1024;
 257                 else if (kb_base == 1024)
 258                         mult = 1000;
 259         } else if (!strncmp("mib", c, 3)) {
 260                 pow = 2;
 261                 if (kb_base == 1000)
 262                         mult = 1024;
 263                 else if (kb_base == 1024)
 264                         mult = 1000;
 265         } else if (!strncmp("kib", c, 3)) {
 266                 pow = 1;
 267                 if (kb_base == 1000)
 268                         mult = 1024;
 269                 else if (kb_base == 1024)
 270                         mult = 1000;
 271         } else if (!strncmp("p", c, 1) || !strncmp("pb", c, 2)) {
 272                 pow = 5;
 273         } else if (!strncmp("t", c, 1) || !strncmp("tb", c, 2)) {
 274                 pow = 4;
 275         } else if (!strncmp("g", c, 1) || !strncmp("gb", c, 2)) {
 276                 pow = 3;
 277         } else if (!strncmp("m", c, 1) || !strncmp("mb", c, 2)) {
 278                 pow = 2;
 279         } else if (!strncmp("k", c, 1) || !strncmp("kb", c, 2)) {
 280                 pow = 1;
 281         } else if (!strncmp("%", c, 1)) {
 282                 *percent = 1;
 283                 free(c);
 284                 return ret;
 285         }
 286
 287         while (pow--)
 288                 ret *= (unsigned long long) mult;
 289
 290         free(c);
 291         return ret;
 292 }
 293
 294 static unsigned long long get_mult_bytes(const char *str, int len, void *data,
 295                                          int *percent)
 296 {
 297         const char *p = str;
 298         int digit_seen = 0;
 299
 300         if (len < 2)
 301                 return __get_mult_bytes(str, data, percent);
 302
 303         /*
 304          * Go forward until we hit a non-digit, or +/- sign
 305          */
 306         while ((p - str) <= len) {
 307                 if (!isdigit((int) *p) &&
 308                     (((*p != '+') && (*p != '-')) || digit_seen))
 309                         break;
 310                 digit_seen |= isdigit((int) *p);
 311                 p++;
 312         }
 313
 314         if (!isalpha((int) *p) && (*p != '%'))
 315                 p = NULL;
 316
 317         return __get_mult_bytes(p, data, percent);
 318 }
 319
 320 extern int evaluate_arithmetic_expression(const char *buffer, long long *ival,
 321                                           double *dval, double implied_units,
 322                                           int is_time);
 323
 324 /*
 325  * Convert string into a floating number. Return 1 for success and 0 otherwise.
 326  */
 327 int str_to_float(const char *str, double *val, int is_time)
 328 {
 329 #ifdef CONFIG_ARITHMETIC
 330         int rc;
 331         long long ival;
 332         double dval;
 333
 334         if (str[0] == '(') {
 335                 rc = evaluate_arithmetic_expression(str, &ival, &dval, 1.0, is_time);
 336                 if (!rc) {
 337                         *val = dval;
 338                         return 1;
 339                 }
 340         }
 341 #endif
 342         return 1 == sscanf(str, "%lf", val);
 343 }
 344
 345 /*
 346  * convert string into decimal value, noting any size suffix
 347  */
 348 int str_to_decimal(const char *str, long long *val, int kilo, void *data,
 349                    int is_seconds, int is_time)
 350 {
 351         int len, base;
 352         int rc = 1;
 353 #ifdef CONFIG_ARITHMETIC
 354         long long ival;
 355         double dval;
 356         double implied_units = 1.0;
 357 #endif
 358
 359         len = strlen(str);
 360         if (!len)
 361                 return 1;
 362
 363 #ifdef CONFIG_ARITHMETIC
 364         if (is_seconds)
 365                 implied_units = 1000000.0;
 366         if (str[0] == '(')
 367                 rc = evaluate_arithmetic_expression(str, &ival, &dval, implied_units, is_time);
 368         if (str[0] == '(' && !rc) {
 369                 if (!kilo && is_seconds)
 370                         *val = ival / 1000000LL;
 371                 else
 372                         *val = ival;
 373         }
 374 #endif
 375
 376         if (rc == 1) {
 377                 char *endptr;
 378
 379                 if (strstr(str, "0x") || strstr(str, "0X"))
 380                         base = 16;
 381                 else
 382                         base = 10;
 383
 384                 *val = strtoll(str, &endptr, base);
 385                 if (*val == 0 && endptr == str)
 386                         return 1;
 387                 if (*val == LONG_MAX && errno == ERANGE)
 388                         return 1;
 389         }
 390
 391         if (kilo) {
 392                 unsigned long long mult;
 393                 int perc = 0;
 394
 395                 mult = get_mult_bytes(str, len, data, &perc);
 396                 if (perc)
 397                         *val = -1ULL - *val;
 398                 else
 399                         *val *= mult;
 400         } else
 401                 *val *= get_mult_time(str, len, is_seconds);
 402
 403         return 0;
 404 }
 405
 406 int check_str_bytes(const char *p, long long *val, void *data)
 407 {
 408         return str_to_decimal(p, val, 1, data, 0, 0);
 409 }
 410
 411 int check_str_time(const char *p, long long *val, int is_seconds)
 412 {
 413         return str_to_decimal(p, val, 0, NULL, is_seconds, 1);
 414 }
 415
 416 void strip_blank_front(char **p)
 417 {
 418         char *s = *p;
 419
 420         if (!strlen(s))
 421                 return;
 422         while (isspace((int) *s))
 423                 s++;
 424
 425         *p = s;
 426 }
 427
 428 void strip_blank_end(char *p)
 429 {
 430         char *start = p, *s;
 431
 432         if (!strlen(p))
 433                 return;
 434
 435         s = strchr(p, ';');
 436         if (s)
 437                 *s = '\0';
 438         s = strchr(p, '#');
 439         if (s)
 440                 *s = '\0';
 441         if (s)
 442                 p = s;
 443
 444         s = p + strlen(p);
 445         while ((isspace((int) *s) || iscntrl((int) *s)) && (s > start))
 446                 s--;
 447
 448         *(s + 1) = '\0';
 449 }
 450
 451 static int check_range_bytes(const char *str, long long *val, void *data)
 452 {
 453         long long __val;
 454
 455         if (!str_to_decimal(str, &__val, 1, data, 0, 0)) {
 456                 *val = __val;
 457                 return 0;
 458         }
 459
 460         return 1;
 461 }
 462
 463 static int check_int(const char *p, int *val)
 464 {
 465         if (!strlen(p))
 466                 return 1;
 467         if (strstr(p, "0x") || strstr(p, "0X")) {
 468                 if (sscanf(p, "%x", val) == 1)
 469                         return 0;
 470         } else {
 471                 if (sscanf(p, "%u", val) == 1)
 472                         return 0;
 473         }
 474
 475         return 1;
 476 }
 477
 478 static size_t opt_len(const char *str)
 479 {
 480         char delimiter[] = {',', ':'};
 481         char *postfix;
 482         unsigned int i;
 483         size_t candidate_len;
 484
 485         size_t prefix_len = strlen(str);
 486         for (i = 0; i < FIO_ARRAY_SIZE(delimiter); i++) {
 487                 postfix = strchr(str, delimiter[i]);
 488                 candidate_len = (size_t)(postfix - str);
 489                 if (postfix && candidate_len < prefix_len)
 490                         prefix_len = candidate_len;
 491         }
 492
 493         return prefix_len;
 494 }
 495
 496 static int str_match_len(const struct value_pair *vp, const char *str)
 497 {
 498         return max(strlen(vp->ival), opt_len(str));
 499 }
 500
 501 #define val_store(ptr, val, off, or, data, o)           \
 502         do {                                            \
 503                 ptr = td_var((data), (o), (off));       \
 504                 if ((or))                               \
 505                         *ptr |= (val);                  \
 506                 else                                    \
 507                         *ptr = (val);                   \
 508         } while (0)
 509
 510 static const char *opt_type_name(const struct fio_option *o)
 511 {
 512         compiletime_assert(FIO_ARRAY_SIZE(opt_type_names) - 1 == FIO_OPT_UNSUPPORTED,
 513                                 "opt_type_names[] index");
 514
 515         if (o->type <= FIO_OPT_UNSUPPORTED)
 516                 return opt_type_names[o->type];
 517
 518         return "OPT_UNKNOWN?";
 519 }
 520
 521 static bool val_too_large(const struct fio_option *o, unsigned long long val,
 522                           bool is_uint)
 523 {
 524         if (!o->maxval)
 525                 return false;
 526
 527         if (is_uint) {
 528                 if ((int) val < 0)
 529                         return (int) val > (int) o->maxval;
 530                 return (unsigned int) val > o->maxval;
 531         }
 532
 533         return val > o->maxval;
 534 }
 535
 536 static bool val_too_small(const struct fio_option *o, unsigned long long val,
 537                           bool is_uint)
 538 {
 539         if (!o->minval)
 540                 return false;
 541
 542         if (is_uint)
 543                 return (int) val < o->minval;
 544
 545         return val < o->minval;
 546 }
 547
 548 static int __handle_option(const struct fio_option *o, const char *ptr,
 549                            void *data, int first, int more, int curr)
 550 {
 551         int il=0, *ilp;
 552         fio_fp64_t *flp;
 553         long long ull, *ullp;
 554         long ul2;
 555         long long ull1, ull2;
 556         double uf;
 557         char **cp = NULL;
 558         int ret = 0, is_time = 0;
 559         const struct value_pair *vp;
 560         struct value_pair posval[PARSE_MAX_VP];
 561         int i, all_skipped = 1;
 562
 563         dprint(FD_PARSE, "__handle_option=%s, type=%s, ptr=%s\n", o->name,
 564                                                         opt_type_name(o), ptr);
 565
 566         if (!ptr && o->type != FIO_OPT_STR_SET && o->type != FIO_OPT_STR) {
 567                 log_err("Option %s requires an argument\n", o->name);
 568                 return 1;
 569         }
 570
 571         switch (o->type) {
 572         case FIO_OPT_STR:
 573         case FIO_OPT_STR_ULL:
 574         case FIO_OPT_STR_MULTI: {
 575                 fio_opt_str_fn *fn = o->cb;
 576
 577                 posval_sort(o, posval);
 578
 579                 ret = 1;
 580                 for (i = 0; i < PARSE_MAX_VP; i++) {
 581                         vp = &posval[i];
 582                         if (!vp->ival || vp->ival[0] == '\0')
 583                                 continue;
 584                         all_skipped = 0;
 585                         if (!ptr)
 586                                 break;
 587                         if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
 588                                 ret = 0;
 589                                 if (!o->off1)
 590                                         continue;
 591                                 if (o->type == FIO_OPT_STR_ULL)
 592                                         val_store(ullp, vp->oval, o->off1, vp->orval, data, o);
 593                                 else
 594                                         val_store(ilp, vp->oval, o->off1, vp->orval, data, o);
 595                                 continue;
 596                         }
 597                 }
 598
 599                 if (ret && !all_skipped)
 600                         show_option_values(o);
 601                 else if (fn)
 602                         ret = fn(data, ptr);
 603                 break;
 604         }
 605         case FIO_OPT_STR_VAL_TIME:
 606                 is_time = 1;
 607                 fio_fallthrough;
 608         case FIO_OPT_ULL:
 609         case FIO_OPT_INT:
 610         case FIO_OPT_STR_VAL:
 611         case FIO_OPT_STR_VAL_ZONE:
 612         {
 613                 fio_opt_str_val_fn *fn = o->cb;
 614                 char tmp[128], *p;
 615                 size_t len = strlen(ptr);
 616
 617                 if (len > 0 && ptr[len - 1] == 'z') {
 618                         if (o->type == FIO_OPT_STR_VAL_ZONE) {
 619                                 char *ep;
 620                                 unsigned long long val;
 621
 622                                 errno = 0;
 623                                 val = strtoul(ptr, &ep, 10);
 624                                 if (errno == 0 && ep != ptr && *ep == 'z') {
 625                                         ull = ZONE_BASE_VAL + (uint32_t)val;
 626                                         ret = 0;
 627                                         goto store_option_value;
 628                                 } else {
 629                                         log_err("%s: unexpected zone value '%s'\n",
 630                                                 o->name, ptr);
 631                                         return 1;
 632                                 }
 633                         } else {
 634                                 log_err("%s: 'z' suffix isn't applicable\n",
 635                                         o->name);
 636                                 return 1;
 637                         }
 638                 }
 639
 640                 if (!is_time && o->is_time)
 641                         is_time = o->is_time;
 642
 643                 snprintf(tmp, sizeof(tmp), "%s", ptr);
 644                 p = strchr(tmp, ',');
 645                 if (p)
 646                         *p = '\0';
 647
 648                 if (is_time)
 649                         ret = check_str_time(tmp, &ull, o->is_seconds);
 650                 else
 651                         ret = check_str_bytes(tmp, &ull, data);
 652
 653                 dprint(FD_PARSE, "  ret=%d, out=%llu\n", ret, ull);
 654
 655                 if (ret)
 656                         break;
 657                 if (o->pow2 && !is_power_of_2(ull)) {
 658                         log_err("%s: must be a power-of-2\n", o->name);
 659                         return 1;
 660                 }
 661
 662                 if (val_too_large(o, ull, o->type == FIO_OPT_INT)) {
 663                         log_err("%s: max value out of range: %llu"
 664                                 " (%llu max)\n", o->name, ull, o->maxval);
 665                         return 1;
 666                 }
 667                 if (val_too_small(o, ull, o->type == FIO_OPT_INT)) {
 668                         log_err("%s: min value out of range: %lld"
 669                                 " (%d min)\n", o->name, ull, o->minval);
 670                         return 1;
 671                 }
 672                 if (o->posval[0].ival) {
 673                         posval_sort(o, posval);
 674
 675                         ret = 1;
 676                         for (i = 0; i < PARSE_MAX_VP; i++) {
 677                                 vp = &posval[i];
 678                                 if (!vp->ival || vp->ival[0] == '\0')
 679                                         continue;
 680                                 if (vp->oval == ull) {
 681                                         ret = 0;
 682                                         break;
 683                                 }
 684                         }
 685                         if (ret) {
 686                                 log_err("fio: value %llu not allowed:\n", ull);
 687                                 show_option_values(o);
 688                                 return 1;
 689                         }
 690                 }
 691
 692 store_option_value:
 693                 if (fn)
 694                         ret = fn(data, &ull);
 695                 else {
 696                         if (o->type == FIO_OPT_INT) {
 697                                 if (first)
 698                                         val_store(ilp, ull, o->off1, 0, data, o);
 699                                 if (curr == 1) {
 700                                         if (o->off2)
 701                                                 val_store(ilp, ull, o->off2, 0, data, o);
 702                                 }
 703                                 if (curr == 2) {
 704                                         if (o->off3)
 705                                                 val_store(ilp, ull, o->off3, 0, data, o);
 706                                 }
 707                                 if (!more) {
 708                                         if (curr < 1) {
 709                                                 if (o->off2)
 710                                                         val_store(ilp, ull, o->off2, 0, data, o);
 711                                         }
 712                                         if (curr < 2) {
 713                                                 if (o->off3)
 714                                                         val_store(ilp, ull, o->off3, 0, data, o);
 715                                         }
 716                                 }
 717                         } else if (o->type == FIO_OPT_ULL) {
 718                                 if (first)
 719                                         val_store(ullp, ull, o->off1, 0, data, o);
 720                                 if (curr == 1) {
 721                                         if (o->off2)
 722                                                 val_store(ullp, ull, o->off2, 0, data, o);
 723                                 }
 724                                 if (curr == 2) {
 725                                         if (o->off3)
 726                                                 val_store(ullp, ull, o->off3, 0, data, o);
 727                                 }
 728                                 if (!more) {
 729                                         if (curr < 1) {
 730                                                 if (o->off2)
 731                                                         val_store(ullp, ull, o->off2, 0, data, o);
 732                                         }
 733                                         if (curr < 2) {
 734                                                 if (o->off3)
 735                                                         val_store(ullp, ull, o->off3, 0, data, o);
 736                                         }
 737                                 }
 738                         } else {
 739                                 if (first)
 740                                         val_store(ullp, ull, o->off1, 0, data, o);
 741                                 if (!more) {
 742                                         if (o->off2)
 743                                                 val_store(ullp, ull, o->off2, 0, data, o);
 744                                 }
 745                         }
 746                 }
 747                 break;
 748         }
 749         case FIO_OPT_FLOAT_LIST: {
 750                 char *cp2;
 751
 752                 if (first) {
 753                         /*
 754                         ** Initialize precision to 0 and zero out list
 755                         ** in case specified list is shorter than default
 756                         */
 757                         if (o->off2) {
 758                                 ul2 = 0;
 759                                 ilp = td_var(data, o, o->off2);
 760                                 *ilp = ul2;
 761                         }
 762
 763                         flp = td_var(data, o, o->off1);
 764                         for(i = 0; i < o->maxlen; i++)
 765                                 flp[i].u.f = 0.0;
 766                 }
 767                 if (curr >= o->maxlen) {
 768                         log_err("the list exceeding max length %d\n",
 769                                         o->maxlen);
 770                         return 1;
 771                 }
 772                 if (!str_to_float(ptr, &uf, 0)) { /* this breaks if we ever have lists of times */
 773                         log_err("not a floating point value: %s\n", ptr);
 774                         return 1;
 775                 }
 776                 if (o->minfp || o->maxfp) {
 777                         if (uf > o->maxfp) {
 778                                 log_err("value out of range: %f"
 779                                         " (range max: %f)\n", uf, o->maxfp);
 780                                 return 1;
 781                         }
 782                         if (uf < o->minfp) {
 783                                 log_err("value out of range: %f"
 784                                         " (range min: %f)\n", uf, o->minfp);
 785                                 return 1;
 786                         }
 787                 }
 788
 789                 flp = td_var(data, o, o->off1);
 790                 flp[curr].u.f = uf;
 791
 792                 dprint(FD_PARSE, "  out=%f\n", uf);
 793
 794                 /*
 795                 ** Calculate precision for output by counting
 796                 ** number of digits after period. Find first
 797                 ** period in entire remaining list each time
 798                 */
 799                 cp2 = strchr(ptr, '.');
 800                 if (cp2 != NULL) {
 801                         int len = 0;
 802
 803                         while (*++cp2 != '\0' && *cp2 >= '0' && *cp2 <= '9')
 804                                 len++;
 805
 806                         if (o->off2) {
 807                                 ilp = td_var(data, o, o->off2);
 808                                 if (len > *ilp)
 809                                         *ilp = len;
 810                         }
 811                 }
 812
 813                 break;
 814         }
 815         case FIO_OPT_STR_STORE: {
 816                 fio_opt_str_fn *fn = o->cb;
 817
 818                 if (!strlen(ptr))
 819                         return 1;
 820
 821                 if (o->off1) {
 822                         cp = td_var(data, o, o->off1);
 823                         if (*cp)
 824                                 free(*cp);
 825                         *cp = strdup(ptr);
 826                         if (strlen(ptr) > o->maxlen - 1) {
 827                                 log_err("value exceeds max length of %d\n",
 828                                         o->maxlen);
 829                                 return 1;
 830                         }
 831                 }
 832
 833                 if (fn)
 834                         ret = fn(data, ptr);
 835                 else if (o->posval[0].ival) {
 836                         posval_sort(o, posval);
 837
 838                         ret = 1;
 839                         for (i = 0; i < PARSE_MAX_VP; i++) {
 840                                 vp = &posval[i];
 841                                 if (!vp->ival || vp->ival[0] == '\0' || !cp)
 842                                         continue;
 843                                 all_skipped = 0;
 844                                 if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
 845                                         char *rest;
 846
 847                                         ret = 0;
 848                                         if (vp->cb)
 849                                                 fn = vp->cb;
 850                                         rest = strstr(*cp ?: ptr, ":");
 851                                         if (rest) {
 852                                                 if (*cp)
 853                                                         *rest = '\0';
 854                                                 ptr = rest + 1;
 855                                         } else
 856                                                 ptr = NULL;
 857                                         break;
 858                                 }
 859                         }
 860                 }
 861
 862                 if (!all_skipped) {
 863                         if (ret && !*cp)
 864                                 show_option_values(o);
 865                         else if (ret && *cp)
 866                                 ret = 0;
 867                         else if (fn && ptr)
 868                                 ret = fn(data, ptr);
 869                 }
 870
 871                 break;
 872         }
 873         case FIO_OPT_RANGE: {
 874                 char tmp[128];
 875                 char *p1, *p2;
 876
 877                 snprintf(tmp, sizeof(tmp), "%s", ptr);
 878
 879                 /* Handle bsrange with separate read,write values: */
 880                 p1 = strchr(tmp, ',');
 881                 if (p1)
 882                         *p1 = '\0';
 883
 884                 p1 = strchr(tmp, '-');
 885                 if (!p1) {
 886                         p1 = strchr(tmp, ':');
 887                         if (!p1) {
 888                                 ret = 1;
 889                                 break;
 890                         }
 891                 }
 892
 893                 p2 = p1 + 1;
 894                 *p1 = '\0';
 895                 p1 = tmp;
 896
 897                 ret = 1;
 898                 if (!check_range_bytes(p1, &ull1, data) &&
 899                         !check_range_bytes(p2, &ull2, data)) {
 900                         ret = 0;
 901                         if (ull1 > ull2) {
 902                                 unsigned long long foo = ull1;
 903
 904                                 ull1 = ull2;
 905                                 ull2 = foo;
 906                         }
 907
 908                         if (first) {
 909                                 val_store(ullp, ull1, o->off1, 0, data, o);
 910                                 val_store(ullp, ull2, o->off2, 0, data, o);
 911                         }
 912                         if (curr == 1) {
 913                                 if (o->off3 && o->off4) {
 914                                         val_store(ullp, ull1, o->off3, 0, data, o);
 915                                         val_store(ullp, ull2, o->off4, 0, data, o);
 916                                 }
 917                         }
 918                         if (curr == 2) {
 919                                 if (o->off5 && o->off6) {
 920                                         val_store(ullp, ull1, o->off5, 0, data, o);
 921                                         val_store(ullp, ull2, o->off6, 0, data, o);
 922                                 }
 923                         }
 924                         if (!more) {
 925                                 if (curr < 1) {
 926                                         if (o->off3 && o->off4) {
 927                                                 val_store(ullp, ull1, o->off3, 0, data, o);
 928                                                 val_store(ullp, ull2, o->off4, 0, data, o);
 929                                         }
 930                                 }
 931                                 if (curr < 2) {
 932                                         if (o->off5 && o->off6) {
 933                                                 val_store(ullp, ull1, o->off5, 0, data, o);
 934                                                 val_store(ullp, ull2, o->off6, 0, data, o);
 935                                         }
 936                                 }
 937                         }
 938                 }
 939
 940                 break;
 941         }
 942         case FIO_OPT_BOOL:
 943         case FIO_OPT_STR_SET: {
 944                 fio_opt_int_fn *fn = o->cb;
 945
 946                 if (ptr)
 947                         ret = check_int(ptr, &il);
 948                 else if (o->type == FIO_OPT_BOOL)
 949                         ret = 1;
 950                 else
 951                         il = 1;
 952
 953                 dprint(FD_PARSE, "  ret=%d, out=%d\n", ret, il);
 954
 955                 if (ret)
 956                         break;
 957
 958                 if (o->maxval && il > (int) o->maxval) {
 959                         log_err("max value out of range: %d (%llu max)\n",
 960                                                                 il, o->maxval);
 961                         return 1;
 962                 }
 963                 if (o->minval && il < o->minval) {
 964                         log_err("min value out of range: %d (%d min)\n",
 965                                                                 il, o->minval);
 966                         return 1;
 967                 }
 968
 969                 if (o->neg)
 970                         il = !il;
 971
 972                 if (fn)
 973                         ret = fn(data, &il);
 974                 else {
 975                         if (first)
 976                                 val_store(ilp, il, o->off1, 0, data, o);
 977                         if (!more) {
 978                                 if (o->off2)
 979                                         val_store(ilp, il, o->off2, 0, data, o);
 980                         }
 981                 }
 982                 break;
 983         }
 984         case FIO_OPT_DEPRECATED:
 985                 ret = 1;
 986                 fio_fallthrough;
 987         case FIO_OPT_SOFT_DEPRECATED:
 988                 log_info("Option %s is deprecated\n", o->name);
 989                 break;
 990         default:
 991                 log_err("Bad option type %u\n", o->type);
 992                 ret = 1;
 993         }
 994
 995         if (ret)
 996                 return ret;
 997
 998         if (o->verify) {
 999                 ret = o->verify(o, data);
1000                 if (ret) {
1001                         log_err("Correct format for offending option\n");
1002                         log_err("%20s: %s\n", o->name, o->help);
1003                         show_option_help(o, 1);
1004                 }
1005         }
1006
1007         return ret;
1008 }
1009
1010 static int handle_option(const struct fio_option *o, const char *__ptr,
1011                          void *data)
1012 {
1013         char *o_ptr, *ptr, *ptr2;
1014         int ret, done;
1015
1016         dprint(FD_PARSE, "handle_option=%s, ptr=%s\n", o->name, __ptr);
1017
1018         o_ptr = ptr = NULL;
1019         if (__ptr)
1020                 o_ptr = ptr = strdup(__ptr);
1021
1022         /*
1023          * See if we have another set of parameters, hidden after a comma.
1024          * Do this before parsing this round, to check if we should
1025          * copy set 1 options to set 2.
1026          */
1027         done = 0;
1028         ret = 1;
1029         do {
1030                 int __ret;
1031
1032                 ptr2 = NULL;
1033                 if (ptr &&
1034                     (o->type != FIO_OPT_STR_STORE) &&
1035                     (o->type != FIO_OPT_STR) &&
1036                     (o->type != FIO_OPT_STR_ULL) &&
1037                     (o->type != FIO_OPT_FLOAT_LIST)) {
1038                         ptr2 = strchr(ptr, ',');
1039                         if (ptr2 && *(ptr2 + 1) == '\0')
1040                                 *ptr2 = '\0';
1041                         if (o->type != FIO_OPT_STR_MULTI && o->type != FIO_OPT_RANGE) {
1042                                 if (!ptr2)
1043                                         ptr2 = strchr(ptr, ':');
1044                                 if (!ptr2)
1045                                         ptr2 = strchr(ptr, '-');
1046                         }
1047                 } else if (ptr && o->type == FIO_OPT_FLOAT_LIST) {
1048                         ptr2 = strchr(ptr, ':');
1049                 }
1050
1051                 /*
1052                  * Don't return early if parsing the first option fails - if
1053                  * we are doing multiple arguments, we can allow the first one
1054                  * being empty.
1055                  */
1056                 __ret = __handle_option(o, ptr, data, !done, !!ptr2, done);
1057                 if (ret)
1058                         ret = __ret;
1059
1060                 if (!ptr2)
1061                         break;
1062
1063                 ptr = ptr2 + 1;
1064                 done++;
1065         } while (1);
1066
1067         if (o_ptr)
1068                 free(o_ptr);
1069         return ret;
1070 }
1071
1072 struct fio_option *find_option(struct fio_option *options, const char *opt)
1073 {
1074         struct fio_option *o;
1075
1076         for (o = &options[0]; o->name; o++) {
1077                 if (!o_match(o, opt))
1078                         continue;
1079                 if (o->type == FIO_OPT_UNSUPPORTED) {
1080                         log_err("Option <%s>: %s\n", o->name, o->help);
1081                         continue;
1082                 }
1083
1084                 return o;
1085         }
1086
1087         return NULL;
1088 }
1089
1090 const struct fio_option *
1091 find_option_c(const struct fio_option *options, const char *opt)
1092 {
1093         const struct fio_option *o;
1094
1095         for (o = &options[0]; o->name; o++) {
1096                 if (!o_match(o, opt))
1097                         continue;
1098                 if (o->type == FIO_OPT_UNSUPPORTED) {
1099                         log_err("Option <%s>: %s\n", o->name, o->help);
1100                         continue;
1101                 }
1102
1103                 return o;
1104         }
1105
1106         return NULL;
1107 }
1108
1109 static const struct fio_option *
1110 get_option(char *opt, const struct fio_option *options, char **post)
1111 {
1112         const struct fio_option *o;
1113         char *ret;
1114
1115         ret = strchr(opt, '=');
1116         if (ret) {
1117                 *post = ret;
1118                 *ret = '\0';
1119                 ret = opt;
1120                 (*post)++;
1121                 strip_blank_end(ret);
1122                 o = find_option_c(options, ret);
1123         } else {
1124                 o = find_option_c(options, opt);
1125                 *post = NULL;
1126         }
1127
1128         return o;
1129 }
1130
1131 static int opt_cmp(const void *p1, const void *p2)
1132 {
1133         const struct fio_option *o;
1134         char *s, *foo;
1135         int prio1, prio2;
1136
1137         prio1 = prio2 = 0;
1138
1139         if (*(char **)p1) {
1140                 s = strdup(*((char **) p1));
1141                 o = get_option(s, __fio_options, &foo);
1142                 if (o)
1143                         prio1 = o->prio;
1144                 free(s);
1145         }
1146         if (*(char **)p2) {
1147                 s = strdup(*((char **) p2));
1148                 o = get_option(s, __fio_options, &foo);
1149                 if (o)
1150                         prio2 = o->prio;
1151                 free(s);
1152         }
1153
1154         return prio2 - prio1;
1155 }
1156
1157 void sort_options(char **opts, const struct fio_option *options, int num_opts)
1158 {
1159         __fio_options = options;
1160         qsort(opts, num_opts, sizeof(char *), opt_cmp);
1161         __fio_options = NULL;
1162 }
1163
1164 static void add_to_dump_list(const struct fio_option *o,
1165                              struct flist_head *dump_list, const char *post)
1166 {
1167         struct print_option *p;
1168
1169         if (!dump_list)
1170                 return;
1171
1172         p = malloc(sizeof(*p));
1173         p->name = strdup(o->name);
1174         if (post)
1175                 p->value = strdup(post);
1176         else
1177                 p->value = NULL;
1178
1179         flist_add_tail(&p->list, dump_list);
1180 }
1181
1182 int parse_cmd_option(const char *opt, const char *val,
1183                      const struct fio_option *options, void *data,
1184                      struct flist_head *dump_list)
1185 {
1186         const struct fio_option *o;
1187
1188         o = find_option_c(options, opt);
1189         if (!o) {
1190                 log_err("Bad option <%s>\n", opt);
1191                 return 1;
1192         }
1193
1194         if (handle_option(o, val, data)) {
1195                 log_err("fio: failed parsing %s=%s\n", opt, val);
1196                 return 1;
1197         }
1198
1199         add_to_dump_list(o, dump_list, val);
1200         return 0;
1201 }
1202
1203 int parse_option(char *opt, const char *input, const struct fio_option *options,
1204                  const struct fio_option **o, void *data,
1205                  struct flist_head *dump_list)
1206 {
1207         char *post;
1208
1209         if (!opt) {
1210                 log_err("fio: failed parsing %s\n", input);
1211                 *o = NULL;
1212                 return 1;
1213         }
1214
1215         *o = get_option(opt, options, &post);
1216         if (!*o) {
1217                 if (post) {
1218                         int len = strlen(opt);
1219                         if (opt + len + 1 != post)
1220                                 memmove(opt + len + 1, post, strlen(post));
1221                         opt[len] = '=';
1222                 }
1223                 return 1;
1224         }
1225
1226         if (handle_option(*o, post, data)) {
1227                 log_err("fio: failed parsing %s\n", input);
1228                 return 1;
1229         }
1230
1231         add_to_dump_list(*o, dump_list, post);
1232         return 0;
1233 }
1234
1235 /*
1236  * Option match, levenshtein distance. Handy for not quite remembering what
1237  * the option name is.
1238  */
1239 int string_distance(const char *s1, const char *s2)
1240 {
1241         unsigned int s1_len = strlen(s1);
1242         unsigned int s2_len = strlen(s2);
1243         unsigned int *p, *q, *r;
1244         unsigned int i, j;
1245
1246         p = malloc(sizeof(unsigned int) * (s2_len + 1));
1247         q = malloc(sizeof(unsigned int) * (s2_len + 1));
1248
1249         p[0] = 0;
1250         for (i = 1; i <= s2_len; i++)
1251                 p[i] = p[i - 1] + 1;
1252
1253         for (i = 1; i <= s1_len; i++) {
1254                 q[0] = p[0] + 1;
1255                 for (j = 1; j <= s2_len; j++) {
1256                         unsigned int sub = p[j - 1];
1257                         unsigned int pmin;
1258
1259                         if (s1[i - 1] != s2[j - 1])
1260                                 sub++;
1261
1262                         pmin = min(q[j - 1] + 1, sub);
1263                         q[j] = min(p[j] + 1, pmin);
1264                 }
1265                 r = p;
1266                 p = q;
1267                 q = r;
1268         }
1269
1270         i = p[s2_len];
1271         free(p);
1272         free(q);
1273         return i;
1274 }
1275
1276 /*
1277  * Make a guess of whether the distance from 's1' is significant enough
1278  * to warrant printing the guess. We set this to a 1/2 match.
1279  */
1280 int string_distance_ok(const char *opt, int distance)
1281 {
1282         size_t len;
1283
1284         len = strlen(opt);
1285         len = (len + 1) / 2;
1286         return distance <= len;
1287 }
1288
1289 static const struct fio_option *find_child(const struct fio_option *options,
1290                                            const struct fio_option *o)
1291 {
1292         const struct fio_option *__o;
1293
1294         for (__o = options + 1; __o->name; __o++)
1295                 if (__o->parent && !strcmp(__o->parent, o->name))
1296                         return __o;
1297
1298         return NULL;
1299 }
1300
1301 static void __print_option(const struct fio_option *o,
1302                            const struct fio_option *org,
1303                            int level)
1304 {
1305         char name[256], *p;
1306         int depth;
1307
1308         if (!o)
1309                 return;
1310
1311         p = name;
1312         depth = level;
1313         while (depth--)
1314                 p += sprintf(p, "%s", "  ");
1315
1316         sprintf(p, "%s", o->name);
1317
1318         log_info("%-24s: %s\n", name, o->help);
1319 }
1320
1321 static void print_option(const struct fio_option *o)
1322 {
1323         const struct fio_option *parent;
1324         const struct fio_option *__o;
1325         unsigned int printed;
1326         unsigned int level;
1327
1328         __print_option(o, NULL, 0);
1329         parent = o;
1330         level = 0;
1331         do {
1332                 level++;
1333                 printed = 0;
1334
1335                 while ((__o = find_child(o, parent)) != NULL) {
1336                         __print_option(__o, o, level);
1337                         o = __o;
1338                         printed++;
1339                 }
1340
1341                 parent = o;
1342         } while (printed);
1343 }
1344
1345 int show_cmd_help(const struct fio_option *options, const char *name)
1346 {
1347         const struct fio_option *o, *closest;
1348         unsigned int best_dist = -1U;
1349         int found = 0;
1350         int show_all = 0;
1351
1352         if (!name || !strcmp(name, "all"))
1353                 show_all = 1;
1354
1355         closest = NULL;
1356         best_dist = -1;
1357         for (o = &options[0]; o->name; o++) {
1358                 int match = 0;
1359
1360                 if (o->type == FIO_OPT_DEPRECATED ||
1361                     o->type == FIO_OPT_SOFT_DEPRECATED)
1362                         continue;
1363                 if (!exec_profile && o->prof_name)
1364                         continue;
1365                 if (exec_profile && !(o->prof_name && !strcmp(exec_profile, o->prof_name)))
1366                         continue;
1367
1368                 if (name) {
1369                         if (!strcmp(name, o->name) ||
1370                             (o->alias && !strcmp(name, o->alias)))
1371                                 match = 1;
1372                         else {
1373                                 unsigned int dist;
1374
1375                                 dist = string_distance(name, o->name);
1376                                 if (dist < best_dist) {
1377                                         best_dist = dist;
1378                                         closest = o;
1379                                 }
1380                         }
1381                 }
1382
1383                 if (show_all || match) {
1384                         found = 1;
1385                         if (match)
1386                                 log_info("%20s: %s\n", o->name, o->help);
1387                         if (show_all) {
1388                                 if (!o->parent)
1389                                         print_option(o);
1390                                 continue;
1391                         }
1392                 }
1393
1394                 if (!match)
1395                         continue;
1396
1397                 show_option_help(o, 0);
1398         }
1399
1400         if (found)
1401                 return 0;
1402
1403         log_err("No such command: %s", name);
1404
1405         /*
1406          * Only print an appropriately close option, one where the edit
1407          * distance isn't too big. Otherwise we get crazy matches.
1408          */
1409         if (closest && best_dist < 3) {
1410                 log_info(" - showing closest match\n");
1411                 log_info("%20s: %s\n", closest->name, closest->help);
1412                 show_option_help(closest, 0);
1413         } else
1414                 log_info("\n");
1415
1416         return 1;
1417 }
1418
1419 /*
1420  * Handle parsing of default parameters.
1421  */
1422 void fill_default_options(void *data, const struct fio_option *options)
1423 {
1424         const struct fio_option *o;
1425
1426         dprint(FD_PARSE, "filling default options\n");
1427
1428         for (o = &options[0]; o->name; o++)
1429                 if (o->def)
1430                         handle_option(o, o->def, data);
1431 }
1432
1433 static void option_init(struct fio_option *o)
1434 {
1435         if (o->type == FIO_OPT_DEPRECATED || o->type == FIO_OPT_UNSUPPORTED ||
1436             o->type == FIO_OPT_SOFT_DEPRECATED)
1437                 return;
1438         if (o->name && !o->lname)
1439                 log_err("Option %s: missing long option name\n", o->name);
1440         if (o->type == FIO_OPT_BOOL) {
1441                 o->minval = 0;
1442                 o->maxval = 1;
1443         }
1444         if (o->type == FIO_OPT_INT) {
1445                 if (!o->maxval)
1446                         o->maxval = UINT_MAX;
1447         }
1448         if (o->type == FIO_OPT_ULL) {
1449                 if (!o->maxval)
1450                         o->maxval = ULLONG_MAX;
1451         }
1452         if (o->type == FIO_OPT_STR_SET && o->def && !o->no_warn_def) {
1453                 log_err("Option %s: string set option with"
1454                                 " default will always be true\n", o->name);
1455         }
1456         if (!o->cb && !o->off1)
1457                 log_err("Option %s: neither cb nor offset given\n", o->name);
1458         if (!o->category) {
1459                 log_info("Option %s: no category defined. Setting to misc\n", o->name);
1460                 o->category = FIO_OPT_C_GENERAL;
1461                 o->group = FIO_OPT_G_INVALID;
1462         }
1463 }
1464
1465 /*
1466  * Sanitize the options structure. For now it just sets min/max for bool
1467  * values and whether both callback and offsets are given.
1468  */
1469 void options_init(struct fio_option *options)
1470 {
1471         struct fio_option *o;
1472
1473         dprint(FD_PARSE, "init options\n");
1474
1475         for (o = &options[0]; o->name; o++) {
1476                 option_init(o);
1477                 if (o->inverse)
1478                         o->inv_opt = find_option(options, o->inverse);
1479         }
1480 }
1481
1482 void options_mem_dupe(const struct fio_option *options, void *data)
1483 {
1484         const struct fio_option *o;
1485         char **ptr;
1486
1487         dprint(FD_PARSE, "dup options\n");
1488
1489         for (o = &options[0]; o->name; o++) {
1490                 if (o->type != FIO_OPT_STR_STORE)
1491                         continue;
1492
1493                 ptr = td_var(data, o, o->off1);
1494                 if (*ptr)
1495                         *ptr = strdup(*ptr);
1496         }
1497 }
1498
1499 void options_free(const struct fio_option *options, void *data)
1500 {
1501         const struct fio_option *o;
1502         char **ptr;
1503
1504         dprint(FD_PARSE, "free options\n");
1505
1506         for (o = &options[0]; o->name; o++) {
1507                 if (o->type != FIO_OPT_STR_STORE || !o->off1 || o->no_free)
1508                         continue;
1509
1510                 ptr = td_var(data, o, o->off1);
1511                 if (*ptr) {
1512                         free(*ptr);
1513                         *ptr = NULL;
1514                 }
1515         }
1516 }