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