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
  12 #include "parse.h"
  13 #include "debug.h"
  14
  15 static int vp_cmp(const void *p1, const void *p2)
  16 {
  17         const struct value_pair *vp1 = p1;
  18         const struct value_pair *vp2 = p2;
  19
  20         return strlen(vp2->ival) - strlen(vp1->ival);
  21 }
  22
  23 static void posval_sort(struct fio_option *o, struct value_pair *vpmap)
  24 {
  25         const struct value_pair *vp;
  26         int entries;
  27
  28         memset(vpmap, 0, PARSE_MAX_VP * sizeof(struct value_pair));
  29
  30         for (entries = 0; entries < PARSE_MAX_VP; entries++) {
  31                 vp = &o->posval[entries];
  32                 if (!vp->ival || vp->ival[0] == '\0')
  33                         break;
  34
  35                 memcpy(&vpmap[entries], vp, sizeof(*vp));
  36         }
  37
  38         qsort(vpmap, entries, sizeof(struct value_pair), vp_cmp);
  39 }
  40
  41 static void show_option_range(struct fio_option *o)
  42 {
  43         if (!o->minval && !o->maxval)
  44                 return;
  45
  46         printf("%20s: min=%d, max=%d\n", "range", o->minval, o->maxval);
  47 }
  48
  49 static void show_option_values(struct fio_option *o)
  50 {
  51         int i = 0;
  52
  53         do {
  54                 const struct value_pair *vp = &o->posval[i];
  55
  56                 if (!vp->ival)
  57                         break;
  58
  59                 printf("%20s: %-10s", i == 0 ? "valid values" : "", vp->ival);
  60                 if (vp->help)
  61                         printf(" %s", vp->help);
  62                 printf("\n");
  63                 i++;
  64         } while (i < PARSE_MAX_VP);
  65
  66         if (i)
  67                 printf("\n");
  68 }
  69
  70 static unsigned long get_mult_time(char c)
  71 {
  72         switch (c) {
  73         case 'm':
  74         case 'M':
  75                 return 60;
  76         case 'h':
  77         case 'H':
  78                 return 60 * 60;
  79         case 'd':
  80         case 'D':
  81                 return 24 * 60 * 60;
  82         default:
  83                 return 1;
  84         }
  85 }
  86
  87 static unsigned long get_mult_bytes(char c)
  88 {
  89         switch (c) {
  90         case 'k':
  91         case 'K':
  92                 return 1024;
  93         case 'm':
  94         case 'M':
  95                 return 1024 * 1024;
  96         case 'g':
  97         case 'G':
  98                 return 1024 * 1024 * 1024;
  99         case 'e':
 100         case 'E':
 101                 return 1024 * 1024 * 1024 * 1024UL;
 102         default:
 103                 return 1;
 104         }
 105 }
 106
 107 /*
 108  * convert string into decimal value, noting any size suffix
 109  */
 110 int str_to_decimal(const char *str, long long *val, int kilo)
 111 {
 112         int len;
 113
 114         len = strlen(str);
 115         if (!len)
 116                 return 1;
 117
 118         *val = strtoll(str, NULL, 10);
 119         if (*val == LONG_MAX && errno == ERANGE)
 120                 return 1;
 121
 122         if (kilo)
 123                 *val *= get_mult_bytes(str[len - 1]);
 124         else
 125                 *val *= get_mult_time(str[len - 1]);
 126
 127         return 0;
 128 }
 129
 130 static int check_str_bytes(const char *p, long long *val)
 131 {
 132         return str_to_decimal(p, val, 1);
 133 }
 134
 135 static int check_str_time(const char *p, long long *val)
 136 {
 137         return str_to_decimal(p, val, 0);
 138 }
 139
 140 void strip_blank_front(char **p)
 141 {
 142         char *s = *p;
 143
 144         while (isspace(*s))
 145                 s++;
 146
 147         *p = s;
 148 }
 149
 150 void strip_blank_end(char *p)
 151 {
 152         char *s;
 153
 154         s = strchr(p, ';');
 155         if (s)
 156                 *s = '\0';
 157         s = strchr(p, '#');
 158         if (s)
 159                 *s = '\0';
 160         if (s)
 161                 p = s;
 162
 163         s = p + strlen(p);
 164         while ((isspace(*s) || iscntrl(*s)) && (s > p))
 165                 s--;
 166
 167         *(s + 1) = '\0';
 168 }
 169
 170 static int check_range_bytes(const char *str, long *val)
 171 {
 172         char suffix;
 173
 174         if (!strlen(str))
 175                 return 1;
 176
 177         if (sscanf(str, "%lu%c", val, &suffix) == 2) {
 178                 *val *= get_mult_bytes(suffix);
 179                 return 0;
 180         }
 181
 182         if (sscanf(str, "%lu", val) == 1)
 183                 return 0;
 184
 185         return 1;
 186 }
 187
 188 static int check_int(const char *p, int *val)
 189 {
 190         if (!strlen(p))
 191                 return 1;
 192         if (strstr(p, "0x") || strstr(p, "0X")) {
 193                 if (sscanf(p, "%x", val) == 1)
 194                         return 0;
 195         } else {
 196                 if (sscanf(p, "%u", val) == 1)
 197                         return 0;
 198         }
 199
 200         return 1;
 201 }
 202
 203 static struct fio_option *find_option(struct fio_option *options,
 204                                       const char *opt)
 205 {
 206         struct fio_option *o;
 207
 208         for (o = &options[0]; o->name; o++) {
 209                 if (!strcmp(o->name, opt))
 210                         return o;
 211                 else if (o->alias && !strcmp(o->alias, opt))
 212                         return o;
 213         }
 214
 215         return NULL;
 216 }
 217
 218 #define val_store(ptr, val, off, data)                  \
 219         do {                                            \
 220                 ptr = td_var((data), (off));            \
 221                 *ptr = (val);                           \
 222         } while (0)
 223
 224 static int __handle_option(struct fio_option *o, const char *ptr, void *data,
 225                            int first, int more)
 226 {
 227         int il, *ilp;
 228         long long ull, *ullp;
 229         long ul1, ul2;
 230         char **cp;
 231         int ret = 0, is_time = 0;
 232
 233         dprint(FD_PARSE, "__handle_option=%s, type=%d, ptr=%s\n", o->name,
 234                                                         o->type, ptr);
 235
 236         if (!ptr && o->type != FIO_OPT_STR_SET) {
 237                 fprintf(stderr, "Option %s requires an argument\n", o->name);
 238                 return 1;
 239         }
 240
 241         switch (o->type) {
 242         case FIO_OPT_STR: {
 243                 fio_opt_str_fn *fn = o->cb;
 244                 const struct value_pair *vp;
 245                 struct value_pair posval[PARSE_MAX_VP];
 246                 int i;
 247
 248                 posval_sort(o, posval);
 249
 250                 for (i = 0; i < PARSE_MAX_VP; i++) {
 251                         vp = &posval[i];
 252                         if (!vp->ival || vp->ival[0] == '\0')
 253                                 break;
 254                         ret = 1;
 255                         if (!strncmp(vp->ival, ptr, strlen(vp->ival))) {
 256                                 ret = 0;
 257                                 if (!o->off1)
 258                                         break;
 259                                 val_store(ilp, vp->oval, o->off1, data);
 260                                 break;
 261                         }
 262                 }
 263
 264                 if (ret)
 265                         show_option_values(o);
 266                 else if (fn)
 267                         ret = fn(data, ptr);
 268                 break;
 269         }
 270         case FIO_OPT_STR_VAL_TIME:
 271                 is_time = 1;
 272         case FIO_OPT_STR_VAL:
 273         case FIO_OPT_STR_VAL_INT: {
 274                 fio_opt_str_val_fn *fn = o->cb;
 275
 276                 if (is_time)
 277                         ret = check_str_time(ptr, &ull);
 278                 else
 279                         ret = check_str_bytes(ptr, &ull);
 280
 281                 if (ret)
 282                         break;
 283
 284                 if (o->maxval && ull > o->maxval) {
 285                         fprintf(stderr, "max value out of range: %lld"
 286                                         " (%d max)\n", ull, o->maxval);
 287                         return 1;
 288                 }
 289                 if (o->minval && ull < o->minval) {
 290                         fprintf(stderr, "min value out of range: %lld"
 291                                         " (%d min)\n", ull, o->minval);
 292                         return 1;
 293                 }
 294
 295                 if (fn)
 296                         ret = fn(data, &ull);
 297                 else {
 298                         if (o->type == FIO_OPT_STR_VAL_INT) {
 299                                 if (first)
 300                                         val_store(ilp, ull, o->off1, data);
 301                                 if (!more && o->off2)
 302                                         val_store(ilp, ull, o->off2, data);
 303                         } else {
 304                                 if (first)
 305                                         val_store(ullp, ull, o->off1, data);
 306                                 if (!more && o->off2)
 307                                         val_store(ullp, ull, o->off2, data);
 308                         }
 309                 }
 310                 break;
 311         }
 312         case FIO_OPT_STR_STORE: {
 313                 fio_opt_str_fn *fn = o->cb;
 314
 315                 cp = td_var(data, o->off1);
 316                 *cp = strdup(ptr);
 317                 if (fn) {
 318                         ret = fn(data, ptr);
 319                         if (ret) {
 320                                 free(*cp);
 321                                 *cp = NULL;
 322                         }
 323                 }
 324                 break;
 325         }
 326         case FIO_OPT_RANGE: {
 327                 char tmp[128];
 328                 char *p1, *p2;
 329
 330                 strncpy(tmp, ptr, sizeof(tmp) - 1);
 331
 332                 p1 = strchr(tmp, '-');
 333                 if (!p1) {
 334                         p1 = strchr(tmp, ':');
 335                         if (!p1) {
 336                                 ret = 1;
 337                                 break;
 338                         }
 339                 }
 340
 341                 p2 = p1 + 1;
 342                 *p1 = '\0';
 343                 p1 = tmp;
 344
 345                 ret = 1;
 346                 if (!check_range_bytes(p1, &ul1) &&
 347                     !check_range_bytes(p2, &ul2)) {
 348                         ret = 0;
 349                         if (ul1 > ul2) {
 350                                 unsigned long foo = ul1;
 351
 352                                 ul1 = ul2;
 353                                 ul2 = foo;
 354                         }
 355
 356                         if (first) {
 357                                 val_store(ilp, ul1, o->off1, data);
 358                                 val_store(ilp, ul2, o->off2, data);
 359                         }
 360                         if (o->off3 && o->off4) {
 361                                 val_store(ilp, ul1, o->off3, data);
 362                                 val_store(ilp, ul2, o->off4, data);
 363                         }
 364                 }
 365
 366                 break;
 367         }
 368         case FIO_OPT_INT:
 369         case FIO_OPT_BOOL: {
 370                 fio_opt_int_fn *fn = o->cb;
 371
 372                 ret = check_int(ptr, &il);
 373                 if (ret)
 374                         break;
 375
 376                 if (o->maxval && il > (int) o->maxval) {
 377                         fprintf(stderr, "max value out of range: %d (%d max)\n",
 378                                                                 il, o->maxval);
 379                         return 1;
 380                 }
 381                 if (o->minval && il < o->minval) {
 382                         fprintf(stderr, "min value out of range: %d (%d min)\n",
 383                                                                 il, o->minval);
 384                         return 1;
 385                 }
 386
 387                 if (o->neg)
 388                         il = !il;
 389
 390                 if (fn)
 391                         ret = fn(data, &il);
 392                 else {
 393                         if (first)
 394                                 val_store(ilp, il, o->off1, data);
 395                         if (!more && o->off2)
 396                                 val_store(ilp, il, o->off2, data);
 397                 }
 398                 break;
 399         }
 400         case FIO_OPT_STR_SET: {
 401                 fio_opt_str_set_fn *fn = o->cb;
 402
 403                 if (fn)
 404                         ret = fn(data);
 405                 else {
 406                         if (first)
 407                                 val_store(ilp, 1, o->off1, data);
 408                         if (!more && o->off2)
 409                                 val_store(ilp, 1, o->off2, data);
 410                 }
 411                 break;
 412         }
 413         default:
 414                 fprintf(stderr, "Bad option type %u\n", o->type);
 415                 ret = 1;
 416         }
 417
 418         return ret;
 419 }
 420
 421 static int handle_option(struct fio_option *o, const char *ptr, void *data)
 422 {
 423         const char *ptr2 = NULL;
 424         int r1, r2;
 425
 426         dprint(FD_PARSE, "handle_option=%s, ptr=%s\n", o->name, ptr);
 427
 428         /*
 429          * See if we have a second set of parameters, hidden after a comma.
 430          * Do this before parsing the first round, to check if we should
 431          * copy set 1 options to set 2.
 432          */
 433         if (ptr &&
 434             (o->type != FIO_OPT_STR_STORE) &&
 435             (o->type != FIO_OPT_STR)) {
 436                 ptr2 = strchr(ptr, ',');
 437                 if (!ptr2)
 438                         ptr2 = strchr(ptr, ':');
 439                 if (!ptr2)
 440                         ptr2 = strchr(ptr, '-');
 441         }
 442
 443         /*
 444          * Don't return early if parsing the first option fails - if
 445          * we are doing multiple arguments, we can allow the first one
 446          * being empty.
 447          */
 448         r1 = __handle_option(o, ptr, data, 1, !!ptr2);
 449
 450         if (!ptr2)
 451                 return r1;
 452
 453         ptr2++;
 454         r2 = __handle_option(o, ptr2, data, 0, 0);
 455
 456         return r1 && r2;
 457 }
 458
 459 int parse_cmd_option(const char *opt, const char *val,
 460                      struct fio_option *options, void *data)
 461 {
 462         struct fio_option *o;
 463
 464         o = find_option(options, opt);
 465         if (!o) {
 466                 fprintf(stderr, "Bad option %s\n", opt);
 467                 return 1;
 468         }
 469
 470         if (!handle_option(o, val, data))
 471                 return 0;
 472
 473         fprintf(stderr, "fio: failed parsing %s=%s\n", opt, val);
 474         return 1;
 475 }
 476
 477 int parse_option(const char *opt, struct fio_option *options, void *data)
 478 {
 479         struct fio_option *o;
 480         char *pre, *post;
 481         char *tmp;
 482
 483         tmp = strdup(opt);
 484
 485         pre = strchr(tmp, '=');
 486         if (pre) {
 487                 post = pre;
 488                 *pre = '\0';
 489                 pre = tmp;
 490                 post++;
 491                 o = find_option(options, pre);
 492         } else {
 493                 o = find_option(options, tmp);
 494                 post = NULL;
 495         }
 496
 497         if (!o) {
 498                 fprintf(stderr, "Bad option %s\n", tmp);
 499                 free(tmp);
 500                 return 1;
 501         }
 502
 503         if (!handle_option(o, post, data)) {
 504                 free(tmp);
 505                 return 0;
 506         }
 507
 508         fprintf(stderr, "fio: failed parsing %s\n", opt);
 509         free(tmp);
 510         return 1;
 511 }
 512
 513 /*
 514  * Option match, levenshtein distance. Handy for not quite remembering what
 515  * the option name is.
 516  */
 517 static int string_distance(const char *s1, const char *s2)
 518 {
 519         unsigned int s1_len = strlen(s1);
 520         unsigned int s2_len = strlen(s2);
 521         unsigned int *p, *q, *r;
 522         unsigned int i, j;
 523
 524         p = malloc(sizeof(unsigned int) * (s2_len + 1));
 525         q = malloc(sizeof(unsigned int) * (s2_len + 1));
 526
 527         p[0] = 0;
 528         for (i = 1; i <= s2_len; i++)
 529                 p[i] = p[i - 1] + 1;
 530
 531         for (i = 1; i <= s1_len; i++) {
 532                 q[0] = p[0] + 1;
 533                 for (j = 1; j <= s2_len; j++) {
 534                         unsigned int sub = p[j - 1];
 535
 536                         if (s1[i - 1] != s2[j - 1])
 537                                 sub++;
 538
 539                         q[j] = min(p[j] + 1, min(q[j - 1] + 1, sub));
 540                 }
 541                 r = p;
 542                 p = q;
 543                 q = r;
 544         }
 545
 546         i = p[s2_len];
 547         free(p);
 548         free(q);
 549         return i;
 550 }
 551
 552 static void show_option_help(struct fio_option *o)
 553 {
 554         const char *typehelp[] = {
 555                 "string (opt=bla)",
 556                 "string with possible k/m/g postfix (opt=4k)",
 557                 "string with range and postfix (opt=1k-4k)",
 558                 "string with time postfix (opt=10s)",
 559                 "string (opt=bla)",
 560                 "string with dual range (opt=1k-4k,4k-8k)",
 561                 "integer value (opt=100)",
 562                 "boolean value (opt=1)",
 563                 "no argument (opt)",
 564         };
 565
 566         if (o->alias)
 567                 printf("%20s: %s\n", "alias", o->alias);
 568
 569         printf("%20s: %s\n", "type", typehelp[o->type]);
 570         printf("%20s: %s\n", "default", o->def ? o->def : "no default");
 571         show_option_range(o);
 572         show_option_values(o);
 573 }
 574
 575 static struct fio_option *find_child(struct fio_option *options,
 576                                      struct fio_option *o)
 577 {
 578         struct fio_option *__o;
 579
 580         for (__o = options + 1; __o->name; __o++)
 581                 if (__o->parent && !strcmp(__o->parent, o->name))
 582                         return __o;
 583
 584         return NULL;
 585 }
 586
 587 static void __print_option(struct fio_option *o, struct fio_option *org,
 588                            int level)
 589 {
 590         char name[256], *p;
 591         int depth;
 592
 593         if (!o)
 594                 return;
 595         if (!org)
 596                 org = o;
 597
 598         p = name;
 599         depth = level;
 600         while (depth--)
 601                 p += sprintf(p, "%s", "  ");
 602
 603         sprintf(p, "%s", o->name);
 604
 605         printf("%-24s: %s\n", name, o->help);
 606 }
 607
 608 static void print_option(struct fio_option *o)
 609 {
 610         struct fio_option *parent;
 611         struct fio_option *__o;
 612         unsigned int printed;
 613         unsigned int level;
 614
 615         __print_option(o, NULL, 0);
 616         parent = o;
 617         level = 0;
 618         do {
 619                 level++;
 620                 printed = 0;
 621
 622                 while ((__o = find_child(o, parent)) != NULL) {
 623                         __print_option(__o, o, level);
 624                         o = __o;
 625                         printed++;
 626                 }
 627
 628                 parent = o;
 629         } while (printed);
 630 }
 631
 632 int show_cmd_help(struct fio_option *options, const char *name)
 633 {
 634         struct fio_option *o, *closest;
 635         unsigned int best_dist;
 636         int found = 0;
 637         int show_all = 0;
 638
 639         if (!name || !strcmp(name, "all"))
 640                 show_all = 1;
 641
 642         closest = NULL;
 643         best_dist = -1;
 644         for (o = &options[0]; o->name; o++) {
 645                 int match = 0;
 646
 647                 if (name) {
 648                         if (!strcmp(name, o->name) ||
 649                             (o->alias && !strcmp(name, o->alias)))
 650                                 match = 1;
 651                         else {
 652                                 unsigned int dist;
 653
 654                                 dist = string_distance(name, o->name);
 655                                 if (dist < best_dist) {
 656                                         best_dist = dist;
 657                                         closest = o;
 658                                 }
 659                         }
 660                 }
 661
 662                 if (show_all || match) {
 663                         found = 1;
 664                         if (match)
 665                                 printf("%24s: %s\n", o->name, o->help);
 666                         if (show_all) {
 667                                 if (!o->parent)
 668                                         print_option(o);
 669                                 continue;
 670                         }
 671                 }
 672
 673                 if (!match)
 674                         continue;
 675
 676                 show_option_help(o);
 677         }
 678
 679         if (found)
 680                 return 0;
 681
 682         printf("No such command: %s", name);
 683         if (closest) {
 684                 printf(" - showing closest match\n");
 685                 printf("%20s: %s\n", closest->name, closest->help);
 686                 show_option_help(closest);
 687         } else
 688                 printf("\n");
 689
 690         return 1;
 691 }
 692
 693 /*
 694  * Handle parsing of default parameters.
 695  */
 696 void fill_default_options(void *data, struct fio_option *options)
 697 {
 698         struct fio_option *o;
 699
 700         dprint(FD_PARSE, "filling default options\n");
 701
 702         for (o = &options[0]; o->name; o++)
 703                 if (o->def)
 704                         handle_option(o, o->def, data);
 705 }
 706
 707 /*
 708  * Sanitize the options structure. For now it just sets min/max for bool
 709  * values and whether both callback and offsets are given.
 710  */
 711 void options_init(struct fio_option *options)
 712 {
 713         struct fio_option *o;
 714
 715         dprint(FD_PARSE, "init options\n");
 716
 717         for (o = &options[0]; o->name; o++) {
 718                 if (o->type == FIO_OPT_BOOL) {
 719                         o->minval = 0;
 720                         o->maxval = 1;
 721                 }
 722                 if (o->type == FIO_OPT_STR_SET && o->def) {
 723                         fprintf(stderr, "Option %s: string set option with"
 724                                         " default will always be true\n",
 725                                                 o->name);
 726                 }
 727                 if (!o->cb && !o->off1) {
 728                         fprintf(stderr, "Option %s: neither cb nor offset"
 729                                         " given\n", o->name);
 730                 }
 731                 if (o->type == FIO_OPT_STR || o->type == FIO_OPT_STR_STORE)
 732                         continue;
 733                 if (o->cb && (o->off1 || o->off2 || o->off3 || o->off4)) {
 734                         fprintf(stderr, "Option %s: both cb and offset given\n",
 735                                                                  o->name);
 736                 }
 737         }
 738 }