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
 484         for (i = 0; i < FIO_ARRAY_SIZE(delimiter); i++) {
 485                 postfix = strchr(str, delimiter[i]);
 486                 if (postfix)
 487                         return (int)(postfix - str);
 488         }
 489
 490         return strlen(str);
 491 }
 492
 493 static int str_match_len(const struct value_pair *vp, const char *str)
 494 {
 495         return max(strlen(vp->ival), opt_len(str));
 496 }
 497
 498 #define val_store(ptr, val, off, or, data, o)           \
 499         do {                                            \
 500                 ptr = td_var((data), (o), (off));       \
 501                 if ((or))                               \
 502                         *ptr |= (val);                  \
 503                 else                                    \
 504                         *ptr = (val);                   \
 505         } while (0)
 506
 507 static const char *opt_type_name(const struct fio_option *o)
 508 {
 509         compiletime_assert(FIO_ARRAY_SIZE(opt_type_names) - 1 == FIO_OPT_UNSUPPORTED,
 510                                 "opt_type_names[] index");
 511
 512         if (o->type <= FIO_OPT_UNSUPPORTED)
 513                 return opt_type_names[o->type];
 514
 515         return "OPT_UNKNOWN?";
 516 }
 517
 518 static bool val_too_large(const struct fio_option *o, unsigned long long val,
 519                           bool is_uint)
 520 {
 521         if (!o->maxval)
 522                 return false;
 523
 524         if (is_uint) {
 525                 if ((int) val < 0)
 526                         return (int) val > (int) o->maxval;
 527                 return (unsigned int) val > o->maxval;
 528         }
 529
 530         return val > o->maxval;
 531 }
 532
 533 static bool val_too_small(const struct fio_option *o, unsigned long long val,
 534                           bool is_uint)
 535 {
 536         if (!o->minval)
 537                 return false;
 538
 539         if (is_uint)
 540                 return (int) val < o->minval;
 541
 542         return val < o->minval;
 543 }
 544
 545 static int __handle_option(const struct fio_option *o, const char *ptr,
 546                            void *data, int first, int more, int curr)
 547 {
 548         int il=0, *ilp;
 549         fio_fp64_t *flp;
 550         long long ull, *ullp;
 551         long ul2;
 552         long long ull1, ull2;
 553         double uf;
 554         char **cp = NULL;
 555         int ret = 0, is_time = 0;
 556         const struct value_pair *vp;
 557         struct value_pair posval[PARSE_MAX_VP];
 558         int i, all_skipped = 1;
 559
 560         dprint(FD_PARSE, "__handle_option=%s, type=%s, ptr=%s\n", o->name,
 561                                                         opt_type_name(o), ptr);
 562
 563         if (!ptr && o->type != FIO_OPT_STR_SET && o->type != FIO_OPT_STR) {
 564                 log_err("Option %s requires an argument\n", o->name);
 565                 return 1;
 566         }
 567
 568         switch (o->type) {
 569         case FIO_OPT_STR:
 570         case FIO_OPT_STR_ULL:
 571         case FIO_OPT_STR_MULTI: {
 572                 fio_opt_str_fn *fn = o->cb;
 573
 574                 posval_sort(o, posval);
 575
 576                 ret = 1;
 577                 for (i = 0; i < PARSE_MAX_VP; i++) {
 578                         vp = &posval[i];
 579                         if (!vp->ival || vp->ival[0] == '\0')
 580                                 continue;
 581                         all_skipped = 0;
 582                         if (!ptr)
 583                                 break;
 584                         if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
 585                                 ret = 0;
 586                                 if (!o->off1)
 587                                         continue;
 588                                 if (o->type == FIO_OPT_STR_ULL)
 589                                         val_store(ullp, vp->oval, o->off1, vp->orval, data, o);
 590                                 else
 591                                         val_store(ilp, vp->oval, o->off1, vp->orval, data, o);
 592                                 continue;
 593                         }
 594                 }
 595
 596                 if (ret && !all_skipped)
 597                         show_option_values(o);
 598                 else if (fn)
 599                         ret = fn(data, ptr);
 600                 break;
 601         }
 602         case FIO_OPT_STR_VAL_TIME:
 603                 is_time = 1;
 604                 fallthrough;
 605         case FIO_OPT_ULL:
 606         case FIO_OPT_INT:
 607         case FIO_OPT_STR_VAL:
 608         case FIO_OPT_STR_VAL_ZONE:
 609         {
 610                 fio_opt_str_val_fn *fn = o->cb;
 611                 char tmp[128], *p;
 612                 size_t len = strlen(ptr);
 613
 614                 if (len > 0 && ptr[len - 1] == 'z') {
 615                         if (o->type == FIO_OPT_STR_VAL_ZONE) {
 616                                 char *ep;
 617                                 unsigned long long val;
 618
 619                                 errno = 0;
 620                                 val = strtoul(ptr, &ep, 10);
 621                                 if (errno == 0 && ep != ptr && *ep == 'z') {
 622                                         ull = ZONE_BASE_VAL + (uint32_t)val;
 623                                         ret = 0;
 624                                         goto store_option_value;
 625                                 } else {
 626                                         log_err("%s: unexpected zone value '%s'\n",
 627                                                 o->name, ptr);
 628                                         return 1;
 629                                 }
 630                         } else {
 631                                 log_err("%s: 'z' suffix isn't applicable\n",
 632                                         o->name);
 633                                 return 1;
 634                         }
 635                 }
 636
 637                 if (!is_time && o->is_time)
 638                         is_time = o->is_time;
 639
 640                 snprintf(tmp, sizeof(tmp), "%s", ptr);
 641                 p = strchr(tmp, ',');
 642                 if (p)
 643                         *p = '\0';
 644
 645                 if (is_time)
 646                         ret = check_str_time(tmp, &ull, o->is_seconds);
 647                 else
 648                         ret = check_str_bytes(tmp, &ull, data);
 649
 650                 dprint(FD_PARSE, "  ret=%d, out=%llu\n", ret, ull);
 651
 652                 if (ret)
 653                         break;
 654                 if (o->pow2 && !is_power_of_2(ull)) {
 655                         log_err("%s: must be a power-of-2\n", o->name);
 656                         return 1;
 657                 }
 658
 659                 if (val_too_large(o, ull, o->type == FIO_OPT_INT)) {
 660                         log_err("%s: max value out of range: %llu"
 661                                 " (%llu max)\n", o->name, ull, o->maxval);
 662                         return 1;
 663                 }
 664                 if (val_too_small(o, ull, o->type == FIO_OPT_INT)) {
 665                         log_err("%s: min value out of range: %lld"
 666                                 " (%d min)\n", o->name, ull, o->minval);
 667                         return 1;
 668                 }
 669                 if (o->posval[0].ival) {
 670                         posval_sort(o, posval);
 671
 672                         ret = 1;
 673                         for (i = 0; i < PARSE_MAX_VP; i++) {
 674                                 vp = &posval[i];
 675                                 if (!vp->ival || vp->ival[0] == '\0')
 676                                         continue;
 677                                 if (vp->oval == ull) {
 678                                         ret = 0;
 679                                         break;
 680                                 }
 681                         }
 682                         if (ret) {
 683                                 log_err("fio: value %llu not allowed:\n", ull);
 684                                 show_option_values(o);
 685                                 return 1;
 686                         }
 687                 }
 688
 689 store_option_value:
 690                 if (fn)
 691                         ret = fn(data, &ull);
 692                 else {
 693                         if (o->type == FIO_OPT_INT) {
 694                                 if (first)
 695                                         val_store(ilp, ull, o->off1, 0, data, o);
 696                                 if (curr == 1) {
 697                                         if (o->off2)
 698                                                 val_store(ilp, ull, o->off2, 0, data, o);
 699                                 }
 700                                 if (curr == 2) {
 701                                         if (o->off3)
 702                                                 val_store(ilp, ull, o->off3, 0, data, o);
 703                                 }
 704                                 if (!more) {
 705                                         if (curr < 1) {
 706                                                 if (o->off2)
 707                                                         val_store(ilp, ull, o->off2, 0, data, o);
 708                                         }
 709                                         if (curr < 2) {
 710                                                 if (o->off3)
 711                                                         val_store(ilp, ull, o->off3, 0, data, o);
 712                                         }
 713                                 }
 714                         } else if (o->type == FIO_OPT_ULL) {
 715                                 if (first)
 716                                         val_store(ullp, ull, o->off1, 0, data, o);
 717                                 if (curr == 1) {
 718                                         if (o->off2)
 719                                                 val_store(ullp, ull, o->off2, 0, data, o);
 720                                 }
 721                                 if (curr == 2) {
 722                                         if (o->off3)
 723                                                 val_store(ullp, ull, o->off3, 0, data, o);
 724                                 }
 725                                 if (!more) {
 726                                         if (curr < 1) {
 727                                                 if (o->off2)
 728                                                         val_store(ullp, ull, o->off2, 0, data, o);
 729                                         }
 730                                         if (curr < 2) {
 731                                                 if (o->off3)
 732                                                         val_store(ullp, ull, o->off3, 0, data, o);
 733                                         }
 734                                 }
 735                         } else {
 736                                 if (first)
 737                                         val_store(ullp, ull, o->off1, 0, data, o);
 738                                 if (!more) {
 739                                         if (o->off2)
 740                                                 val_store(ullp, ull, o->off2, 0, data, o);
 741                                 }
 742                         }
 743                 }
 744                 break;
 745         }
 746         case FIO_OPT_FLOAT_LIST: {
 747                 char *cp2;
 748
 749                 if (first) {
 750                         /*
 751                         ** Initialize precision to 0 and zero out list
 752                         ** in case specified list is shorter than default
 753                         */
 754                         if (o->off2) {
 755                                 ul2 = 0;
 756                                 ilp = td_var(data, o, o->off2);
 757                                 *ilp = ul2;
 758                         }
 759
 760                         flp = td_var(data, o, o->off1);
 761                         for(i = 0; i < o->maxlen; i++)
 762                                 flp[i].u.f = 0.0;
 763                 }
 764                 if (curr >= o->maxlen) {
 765                         log_err("the list exceeding max length %d\n",
 766                                         o->maxlen);
 767                         return 1;
 768                 }
 769                 if (!str_to_float(ptr, &uf, 0)) { /* this breaks if we ever have lists of times */
 770                         log_err("not a floating point value: %s\n", ptr);
 771                         return 1;
 772                 }
 773                 if (o->minfp || o->maxfp) {
 774                         if (uf > o->maxfp) {
 775                                 log_err("value out of range: %f"
 776                                         " (range max: %f)\n", uf, o->maxfp);
 777                                 return 1;
 778                         }
 779                         if (uf < o->minfp) {
 780                                 log_err("value out of range: %f"
 781                                         " (range min: %f)\n", uf, o->minfp);
 782                                 return 1;
 783                         }
 784                 }
 785
 786                 flp = td_var(data, o, o->off1);
 787                 flp[curr].u.f = uf;
 788
 789                 dprint(FD_PARSE, "  out=%f\n", uf);
 790
 791                 /*
 792                 ** Calculate precision for output by counting
 793                 ** number of digits after period. Find first
 794                 ** period in entire remaining list each time
 795                 */
 796                 cp2 = strchr(ptr, '.');
 797                 if (cp2 != NULL) {
 798                         int len = 0;
 799
 800                         while (*++cp2 != '\0' && *cp2 >= '0' && *cp2 <= '9')
 801                                 len++;
 802
 803                         if (o->off2) {
 804                                 ilp = td_var(data, o, o->off2);
 805                                 if (len > *ilp)
 806                                         *ilp = len;
 807                         }
 808                 }
 809
 810                 break;
 811         }
 812         case FIO_OPT_STR_STORE: {
 813                 fio_opt_str_fn *fn = o->cb;
 814
 815                 if (!strlen(ptr))
 816                         return 1;
 817
 818                 if (o->off1) {
 819                         cp = td_var(data, o, o->off1);
 820                         *cp = strdup(ptr);
 821                         if (strlen(ptr) > o->maxlen - 1) {
 822                                 log_err("value exceeds max length of %d\n",
 823                                         o->maxlen);
 824                                 return 1;
 825                         }
 826                 }
 827
 828                 if (fn)
 829                         ret = fn(data, ptr);
 830                 else if (o->posval[0].ival) {
 831                         posval_sort(o, posval);
 832
 833                         ret = 1;
 834                         for (i = 0; i < PARSE_MAX_VP; i++) {
 835                                 vp = &posval[i];
 836                                 if (!vp->ival || vp->ival[0] == '\0' || !cp)
 837                                         continue;
 838                                 all_skipped = 0;
 839                                 if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
 840                                         char *rest;
 841
 842                                         ret = 0;
 843                                         if (vp->cb)
 844                                                 fn = vp->cb;
 845                                         rest = strstr(*cp ?: ptr, ":");
 846                                         if (rest) {
 847                                                 if (*cp)
 848                                                         *rest = '\0';
 849                                                 ptr = rest + 1;
 850                                         } else
 851                                                 ptr = NULL;
 852                                         break;
 853                                 }
 854                         }
 855                 }
 856
 857                 if (!all_skipped) {
 858                         if (ret && !*cp)
 859                                 show_option_values(o);
 860                         else if (ret && *cp)
 861                                 ret = 0;
 862                         else if (fn && ptr)
 863                                 ret = fn(data, ptr);
 864                 }
 865
 866                 break;
 867         }
 868         case FIO_OPT_RANGE: {
 869                 char tmp[128];
 870                 char *p1, *p2;
 871
 872                 snprintf(tmp, sizeof(tmp), "%s", ptr);
 873
 874                 /* Handle bsrange with separate read,write values: */
 875                 p1 = strchr(tmp, ',');
 876                 if (p1)
 877                         *p1 = '\0';
 878
 879                 p1 = strchr(tmp, '-');
 880                 if (!p1) {
 881                         p1 = strchr(tmp, ':');
 882                         if (!p1) {
 883                                 ret = 1;
 884                                 break;
 885                         }
 886                 }
 887
 888                 p2 = p1 + 1;
 889                 *p1 = '\0';
 890                 p1 = tmp;
 891
 892                 ret = 1;
 893                 if (!check_range_bytes(p1, &ull1, data) &&
 894                         !check_range_bytes(p2, &ull2, data)) {
 895                         ret = 0;
 896                         if (ull1 > ull2) {
 897                                 unsigned long long foo = ull1;
 898
 899                                 ull1 = ull2;
 900                                 ull2 = foo;
 901                         }
 902
 903                         if (first) {
 904                                 val_store(ullp, ull1, o->off1, 0, data, o);
 905                                 val_store(ullp, ull2, o->off2, 0, data, o);
 906                         }
 907                         if (curr == 1) {
 908                                 if (o->off3 && o->off4) {
 909                                         val_store(ullp, ull1, o->off3, 0, data, o);
 910                                         val_store(ullp, ull2, o->off4, 0, data, o);
 911                                 }
 912                         }
 913                         if (curr == 2) {
 914                                 if (o->off5 && o->off6) {
 915                                         val_store(ullp, ull1, o->off5, 0, data, o);
 916                                         val_store(ullp, ull2, o->off6, 0, data, o);
 917                                 }
 918                         }
 919                         if (!more) {
 920                                 if (curr < 1) {
 921                                         if (o->off3 && o->off4) {
 922                                                 val_store(ullp, ull1, o->off3, 0, data, o);
 923                                                 val_store(ullp, ull2, o->off4, 0, data, o);
 924                                         }
 925                                 }
 926                                 if (curr < 2) {
 927                                         if (o->off5 && o->off6) {
 928                                                 val_store(ullp, ull1, o->off5, 0, data, o);
 929                                                 val_store(ullp, ull2, o->off6, 0, data, o);
 930                                         }
 931                                 }
 932                         }
 933                 }
 934
 935                 break;
 936         }
 937         case FIO_OPT_BOOL:
 938         case FIO_OPT_STR_SET: {
 939                 fio_opt_int_fn *fn = o->cb;
 940
 941                 if (ptr)
 942                         ret = check_int(ptr, &il);
 943                 else if (o->type == FIO_OPT_BOOL)
 944                         ret = 1;
 945                 else
 946                         il = 1;
 947
 948                 dprint(FD_PARSE, "  ret=%d, out=%d\n", ret, il);
 949
 950                 if (ret)
 951                         break;
 952
 953                 if (o->maxval && il > (int) o->maxval) {
 954                         log_err("max value out of range: %d (%llu max)\n",
 955                                                                 il, o->maxval);
 956                         return 1;
 957                 }
 958                 if (o->minval && il < o->minval) {
 959                         log_err("min value out of range: %d (%d min)\n",
 960                                                                 il, o->minval);
 961                         return 1;
 962                 }
 963
 964                 if (o->neg)
 965                         il = !il;
 966
 967                 if (fn)
 968                         ret = fn(data, &il);
 969                 else {
 970                         if (first)
 971                                 val_store(ilp, il, o->off1, 0, data, o);
 972                         if (!more) {
 973                                 if (o->off2)
 974                                         val_store(ilp, il, o->off2, 0, data, o);
 975                         }
 976                 }
 977                 break;
 978         }
 979         case FIO_OPT_DEPRECATED:
 980                 ret = 1;
 981                 fallthrough;
 982         case FIO_OPT_SOFT_DEPRECATED:
 983                 log_info("Option %s is deprecated\n", o->name);
 984                 break;
 985         default:
 986                 log_err("Bad option type %u\n", o->type);
 987                 ret = 1;
 988         }
 989
 990         if (ret)
 991                 return ret;
 992
 993         if (o->verify) {
 994                 ret = o->verify(o, data);
 995                 if (ret) {
 996                         log_err("Correct format for offending option\n");
 997                         log_err("%20s: %s\n", o->name, o->help);
 998                         show_option_help(o, 1);
 999                 }
1000         }
1001
1002         return ret;
1003 }
1004
1005 static int handle_option(const struct fio_option *o, const char *__ptr,
1006                          void *data)
1007 {
1008         char *o_ptr, *ptr, *ptr2;
1009         int ret, done;
1010
1011         dprint(FD_PARSE, "handle_option=%s, ptr=%s\n", o->name, __ptr);
1012
1013         o_ptr = ptr = NULL;
1014         if (__ptr)
1015                 o_ptr = ptr = strdup(__ptr);
1016
1017         /*
1018          * See if we have another set of parameters, hidden after a comma.
1019          * Do this before parsing this round, to check if we should
1020          * copy set 1 options to set 2.
1021          */
1022         done = 0;
1023         ret = 1;
1024         do {
1025                 int __ret;
1026
1027                 ptr2 = NULL;
1028                 if (ptr &&
1029                     (o->type != FIO_OPT_STR_STORE) &&
1030                     (o->type != FIO_OPT_STR) &&
1031                     (o->type != FIO_OPT_STR_ULL) &&
1032                     (o->type != FIO_OPT_FLOAT_LIST)) {
1033                         ptr2 = strchr(ptr, ',');
1034                         if (ptr2 && *(ptr2 + 1) == '\0')
1035                                 *ptr2 = '\0';
1036                         if (o->type != FIO_OPT_STR_MULTI && o->type != FIO_OPT_RANGE) {
1037                                 if (!ptr2)
1038                                         ptr2 = strchr(ptr, ':');
1039                                 if (!ptr2)
1040                                         ptr2 = strchr(ptr, '-');
1041                         }
1042                 } else if (ptr && o->type == FIO_OPT_FLOAT_LIST) {
1043                         ptr2 = strchr(ptr, ':');
1044                 }
1045
1046                 /*
1047                  * Don't return early if parsing the first option fails - if
1048                  * we are doing multiple arguments, we can allow the first one
1049                  * being empty.
1050                  */
1051                 __ret = __handle_option(o, ptr, data, !done, !!ptr2, done);
1052                 if (ret)
1053                         ret = __ret;
1054
1055                 if (!ptr2)
1056                         break;
1057
1058                 ptr = ptr2 + 1;
1059                 done++;
1060         } while (1);
1061
1062         if (o_ptr)
1063                 free(o_ptr);
1064         return ret;
1065 }
1066
1067 struct fio_option *find_option(struct fio_option *options, const char *opt)
1068 {
1069         struct fio_option *o;
1070
1071         for (o = &options[0]; o->name; o++) {
1072                 if (!o_match(o, opt))
1073                         continue;
1074                 if (o->type == FIO_OPT_UNSUPPORTED) {
1075                         log_err("Option <%s>: %s\n", o->name, o->help);
1076                         continue;
1077                 }
1078
1079                 return o;
1080         }
1081
1082         return NULL;
1083 }
1084
1085 const struct fio_option *
1086 find_option_c(const struct fio_option *options, const char *opt)
1087 {
1088         const struct fio_option *o;
1089
1090         for (o = &options[0]; o->name; o++) {
1091                 if (!o_match(o, opt))
1092                         continue;
1093                 if (o->type == FIO_OPT_UNSUPPORTED) {
1094                         log_err("Option <%s>: %s\n", o->name, o->help);
1095                         continue;
1096                 }
1097
1098                 return o;
1099         }
1100
1101         return NULL;
1102 }
1103
1104 static const struct fio_option *
1105 get_option(char *opt, const struct fio_option *options, char **post)
1106 {
1107         const struct fio_option *o;
1108         char *ret;
1109
1110         ret = strchr(opt, '=');
1111         if (ret) {
1112                 *post = ret;
1113                 *ret = '\0';
1114                 ret = opt;
1115                 (*post)++;
1116                 strip_blank_end(ret);
1117                 o = find_option_c(options, ret);
1118         } else {
1119                 o = find_option_c(options, opt);
1120                 *post = NULL;
1121         }
1122
1123         return o;
1124 }
1125
1126 static int opt_cmp(const void *p1, const void *p2)
1127 {
1128         const struct fio_option *o;
1129         char *s, *foo;
1130         int prio1, prio2;
1131
1132         prio1 = prio2 = 0;
1133
1134         if (*(char **)p1) {
1135                 s = strdup(*((char **) p1));
1136                 o = get_option(s, __fio_options, &foo);
1137                 if (o)
1138                         prio1 = o->prio;
1139                 free(s);
1140         }
1141         if (*(char **)p2) {
1142                 s = strdup(*((char **) p2));
1143                 o = get_option(s, __fio_options, &foo);
1144                 if (o)
1145                         prio2 = o->prio;
1146                 free(s);
1147         }
1148
1149         return prio2 - prio1;
1150 }
1151
1152 void sort_options(char **opts, const struct fio_option *options, int num_opts)
1153 {
1154         __fio_options = options;
1155         qsort(opts, num_opts, sizeof(char *), opt_cmp);
1156         __fio_options = NULL;
1157 }
1158
1159 static void add_to_dump_list(const struct fio_option *o,
1160                              struct flist_head *dump_list, const char *post)
1161 {
1162         struct print_option *p;
1163
1164         if (!dump_list)
1165                 return;
1166
1167         p = malloc(sizeof(*p));
1168         p->name = strdup(o->name);
1169         if (post)
1170                 p->value = strdup(post);
1171         else
1172                 p->value = NULL;
1173
1174         flist_add_tail(&p->list, dump_list);
1175 }
1176
1177 int parse_cmd_option(const char *opt, const char *val,
1178                      const struct fio_option *options, void *data,
1179                      struct flist_head *dump_list)
1180 {
1181         const struct fio_option *o;
1182
1183         o = find_option_c(options, opt);
1184         if (!o) {
1185                 log_err("Bad option <%s>\n", opt);
1186                 return 1;
1187         }
1188
1189         if (handle_option(o, val, data)) {
1190                 log_err("fio: failed parsing %s=%s\n", opt, val);
1191                 return 1;
1192         }
1193
1194         add_to_dump_list(o, dump_list, val);
1195         return 0;
1196 }
1197
1198 int parse_option(char *opt, const char *input, const struct fio_option *options,
1199                  const struct fio_option **o, void *data,
1200                  struct flist_head *dump_list)
1201 {
1202         char *post;
1203
1204         if (!opt) {
1205                 log_err("fio: failed parsing %s\n", input);
1206                 *o = NULL;
1207                 return 1;
1208         }
1209
1210         *o = get_option(opt, options, &post);
1211         if (!*o) {
1212                 if (post) {
1213                         int len = strlen(opt);
1214                         if (opt + len + 1 != post)
1215                                 memmove(opt + len + 1, post, strlen(post));
1216                         opt[len] = '=';
1217                 }
1218                 return 1;
1219         }
1220
1221         if (handle_option(*o, post, data)) {
1222                 log_err("fio: failed parsing %s\n", input);
1223                 return 1;
1224         }
1225
1226         add_to_dump_list(*o, dump_list, post);
1227         return 0;
1228 }
1229
1230 /*
1231  * Option match, levenshtein distance. Handy for not quite remembering what
1232  * the option name is.
1233  */
1234 int string_distance(const char *s1, const char *s2)
1235 {
1236         unsigned int s1_len = strlen(s1);
1237         unsigned int s2_len = strlen(s2);
1238         unsigned int *p, *q, *r;
1239         unsigned int i, j;
1240
1241         p = malloc(sizeof(unsigned int) * (s2_len + 1));
1242         q = malloc(sizeof(unsigned int) * (s2_len + 1));
1243
1244         p[0] = 0;
1245         for (i = 1; i <= s2_len; i++)
1246                 p[i] = p[i - 1] + 1;
1247
1248         for (i = 1; i <= s1_len; i++) {
1249                 q[0] = p[0] + 1;
1250                 for (j = 1; j <= s2_len; j++) {
1251                         unsigned int sub = p[j - 1];
1252                         unsigned int pmin;
1253
1254                         if (s1[i - 1] != s2[j - 1])
1255                                 sub++;
1256
1257                         pmin = min(q[j - 1] + 1, sub);
1258                         q[j] = min(p[j] + 1, pmin);
1259                 }
1260                 r = p;
1261                 p = q;
1262                 q = r;
1263         }
1264
1265         i = p[s2_len];
1266         free(p);
1267         free(q);
1268         return i;
1269 }
1270
1271 /*
1272  * Make a guess of whether the distance from 's1' is significant enough
1273  * to warrant printing the guess. We set this to a 1/2 match.
1274  */
1275 int string_distance_ok(const char *opt, int distance)
1276 {
1277         size_t len;
1278
1279         len = strlen(opt);
1280         len = (len + 1) / 2;
1281         return distance <= len;
1282 }
1283
1284 static const struct fio_option *find_child(const struct fio_option *options,
1285                                            const struct fio_option *o)
1286 {
1287         const struct fio_option *__o;
1288
1289         for (__o = options + 1; __o->name; __o++)
1290                 if (__o->parent && !strcmp(__o->parent, o->name))
1291                         return __o;
1292
1293         return NULL;
1294 }
1295
1296 static void __print_option(const struct fio_option *o,
1297                            const struct fio_option *org,
1298                            int level)
1299 {
1300         char name[256], *p;
1301         int depth;
1302
1303         if (!o)
1304                 return;
1305
1306         p = name;
1307         depth = level;
1308         while (depth--)
1309                 p += sprintf(p, "%s", "  ");
1310
1311         sprintf(p, "%s", o->name);
1312
1313         log_info("%-24s: %s\n", name, o->help);
1314 }
1315
1316 static void print_option(const struct fio_option *o)
1317 {
1318         const struct fio_option *parent;
1319         const struct fio_option *__o;
1320         unsigned int printed;
1321         unsigned int level;
1322
1323         __print_option(o, NULL, 0);
1324         parent = o;
1325         level = 0;
1326         do {
1327                 level++;
1328                 printed = 0;
1329
1330                 while ((__o = find_child(o, parent)) != NULL) {
1331                         __print_option(__o, o, level);
1332                         o = __o;
1333                         printed++;
1334                 }
1335
1336                 parent = o;
1337         } while (printed);
1338 }
1339
1340 int show_cmd_help(const struct fio_option *options, const char *name)
1341 {
1342         const struct fio_option *o, *closest;
1343         unsigned int best_dist = -1U;
1344         int found = 0;
1345         int show_all = 0;
1346
1347         if (!name || !strcmp(name, "all"))
1348                 show_all = 1;
1349
1350         closest = NULL;
1351         best_dist = -1;
1352         for (o = &options[0]; o->name; o++) {
1353                 int match = 0;
1354
1355                 if (o->type == FIO_OPT_DEPRECATED ||
1356                     o->type == FIO_OPT_SOFT_DEPRECATED)
1357                         continue;
1358                 if (!exec_profile && o->prof_name)
1359                         continue;
1360                 if (exec_profile && !(o->prof_name && !strcmp(exec_profile, o->prof_name)))
1361                         continue;
1362
1363                 if (name) {
1364                         if (!strcmp(name, o->name) ||
1365                             (o->alias && !strcmp(name, o->alias)))
1366                                 match = 1;
1367                         else {
1368                                 unsigned int dist;
1369
1370                                 dist = string_distance(name, o->name);
1371                                 if (dist < best_dist) {
1372                                         best_dist = dist;
1373                                         closest = o;
1374                                 }
1375                         }
1376                 }
1377
1378                 if (show_all || match) {
1379                         found = 1;
1380                         if (match)
1381                                 log_info("%20s: %s\n", o->name, o->help);
1382                         if (show_all) {
1383                                 if (!o->parent)
1384                                         print_option(o);
1385                                 continue;
1386                         }
1387                 }
1388
1389                 if (!match)
1390                         continue;
1391
1392                 show_option_help(o, 0);
1393         }
1394
1395         if (found)
1396                 return 0;
1397
1398         log_err("No such command: %s", name);
1399
1400         /*
1401          * Only print an appropriately close option, one where the edit
1402          * distance isn't too big. Otherwise we get crazy matches.
1403          */
1404         if (closest && best_dist < 3) {
1405                 log_info(" - showing closest match\n");
1406                 log_info("%20s: %s\n", closest->name, closest->help);
1407                 show_option_help(closest, 0);
1408         } else
1409                 log_info("\n");
1410
1411         return 1;
1412 }
1413
1414 /*
1415  * Handle parsing of default parameters.
1416  */
1417 void fill_default_options(void *data, const struct fio_option *options)
1418 {
1419         const struct fio_option *o;
1420
1421         dprint(FD_PARSE, "filling default options\n");
1422
1423         for (o = &options[0]; o->name; o++)
1424                 if (o->def)
1425                         handle_option(o, o->def, data);
1426 }
1427
1428 static void option_init(struct fio_option *o)
1429 {
1430         if (o->type == FIO_OPT_DEPRECATED || o->type == FIO_OPT_UNSUPPORTED ||
1431             o->type == FIO_OPT_SOFT_DEPRECATED)
1432                 return;
1433         if (o->name && !o->lname)
1434                 log_err("Option %s: missing long option name\n", o->name);
1435         if (o->type == FIO_OPT_BOOL) {
1436                 o->minval = 0;
1437                 o->maxval = 1;
1438         }
1439         if (o->type == FIO_OPT_INT) {
1440                 if (!o->maxval)
1441                         o->maxval = UINT_MAX;
1442         }
1443         if (o->type == FIO_OPT_ULL) {
1444                 if (!o->maxval)
1445                         o->maxval = ULLONG_MAX;
1446         }
1447         if (o->type == FIO_OPT_STR_SET && o->def && !o->no_warn_def) {
1448                 log_err("Option %s: string set option with"
1449                                 " default will always be true\n", o->name);
1450         }
1451         if (!o->cb && !o->off1)
1452                 log_err("Option %s: neither cb nor offset given\n", o->name);
1453         if (!o->category) {
1454                 log_info("Option %s: no category defined. Setting to misc\n", o->name);
1455                 o->category = FIO_OPT_C_GENERAL;
1456                 o->group = FIO_OPT_G_INVALID;
1457         }
1458 }
1459
1460 /*
1461  * Sanitize the options structure. For now it just sets min/max for bool
1462  * values and whether both callback and offsets are given.
1463  */
1464 void options_init(struct fio_option *options)
1465 {
1466         struct fio_option *o;
1467
1468         dprint(FD_PARSE, "init options\n");
1469
1470         for (o = &options[0]; o->name; o++) {
1471                 option_init(o);
1472                 if (o->inverse)
1473                         o->inv_opt = find_option(options, o->inverse);
1474         }
1475 }
1476
1477 void options_mem_dupe(const struct fio_option *options, void *data)
1478 {
1479         const struct fio_option *o;
1480         char **ptr;
1481
1482         dprint(FD_PARSE, "dup options\n");
1483
1484         for (o = &options[0]; o->name; o++) {
1485                 if (o->type != FIO_OPT_STR_STORE)
1486                         continue;
1487
1488                 ptr = td_var(data, o, o->off1);
1489                 if (*ptr)
1490                         *ptr = strdup(*ptr);
1491         }
1492 }
1493
1494 void options_free(const struct fio_option *options, void *data)
1495 {
1496         const struct fio_option *o;
1497         char **ptr;
1498
1499         dprint(FD_PARSE, "free options\n");
1500
1501         for (o = &options[0]; o->name; o++) {
1502                 if (o->type != FIO_OPT_STR_STORE || !o->off1 || o->no_free)
1503                         continue;
1504
1505                 ptr = td_var(data, o, o->off1);
1506                 if (*ptr) {
1507                         free(*ptr);
1508                         *ptr = NULL;
1509                 }
1510         }
1511 }