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