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