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         case FIO_OPT_DEPRECATED:
 414                 fprintf(stdout, "Option %s is deprecated\n", o->name);
 415                 break;
 416         default:
 417                 fprintf(stderr, "Bad option type %u\n", o->type);
 418                 ret = 1;
 419         }
 420
 421         return ret;
 422 }
 423
 424 static int handle_option(struct fio_option *o, const char *ptr, void *data)
 425 {
 426         const char *ptr2 = NULL;
 427         int r1, r2;
 428
 429         dprint(FD_PARSE, "handle_option=%s, ptr=%s\n", o->name, ptr);
 430
 431         /*
 432          * See if we have a second set of parameters, hidden after a comma.
 433          * Do this before parsing the first round, to check if we should
 434          * copy set 1 options to set 2.
 435          */
 436         if (ptr &&
 437             (o->type != FIO_OPT_STR_STORE) &&
 438             (o->type != FIO_OPT_STR)) {
 439                 ptr2 = strchr(ptr, ',');
 440                 if (!ptr2)
 441                         ptr2 = strchr(ptr, ':');
 442                 if (!ptr2)
 443                         ptr2 = strchr(ptr, '-');
 444         }
 445
 446         /*
 447          * Don't return early if parsing the first option fails - if
 448          * we are doing multiple arguments, we can allow the first one
 449          * being empty.
 450          */
 451         r1 = __handle_option(o, ptr, data, 1, !!ptr2);
 452
 453         if (!ptr2)
 454                 return r1;
 455
 456         ptr2++;
 457         r2 = __handle_option(o, ptr2, data, 0, 0);
 458
 459         return r1 && r2;
 460 }
 461
 462 int parse_cmd_option(const char *opt, const char *val,
 463                      struct fio_option *options, void *data)
 464 {
 465         struct fio_option *o;
 466
 467         o = find_option(options, opt);
 468         if (!o) {
 469                 fprintf(stderr, "Bad option %s\n", opt);
 470                 return 1;
 471         }
 472
 473         if (!handle_option(o, val, data))
 474                 return 0;
 475
 476         fprintf(stderr, "fio: failed parsing %s=%s\n", opt, val);
 477         return 1;
 478 }
 479
 480 int parse_option(const char *opt, struct fio_option *options, void *data)
 481 {
 482         struct fio_option *o;
 483         char *pre, *post;
 484         char *tmp;
 485
 486         tmp = strdup(opt);
 487
 488         pre = strchr(tmp, '=');
 489         if (pre) {
 490                 post = pre;
 491                 *pre = '\0';
 492                 pre = tmp;
 493                 post++;
 494                 o = find_option(options, pre);
 495         } else {
 496                 o = find_option(options, tmp);
 497                 post = NULL;
 498         }
 499
 500         if (!o) {
 501                 fprintf(stderr, "Bad option %s\n", tmp);
 502                 free(tmp);
 503                 return 1;
 504         }
 505
 506         if (!handle_option(o, post, data)) {
 507                 free(tmp);
 508                 return 0;
 509         }
 510
 511         fprintf(stderr, "fio: failed parsing %s\n", opt);
 512         free(tmp);
 513         return 1;
 514 }
 515
 516 /*
 517  * Option match, levenshtein distance. Handy for not quite remembering what
 518  * the option name is.
 519  */
 520 static int string_distance(const char *s1, const char *s2)
 521 {
 522         unsigned int s1_len = strlen(s1);
 523         unsigned int s2_len = strlen(s2);
 524         unsigned int *p, *q, *r;
 525         unsigned int i, j;
 526
 527         p = malloc(sizeof(unsigned int) * (s2_len + 1));
 528         q = malloc(sizeof(unsigned int) * (s2_len + 1));
 529
 530         p[0] = 0;
 531         for (i = 1; i <= s2_len; i++)
 532                 p[i] = p[i - 1] + 1;
 533
 534         for (i = 1; i <= s1_len; i++) {
 535                 q[0] = p[0] + 1;
 536                 for (j = 1; j <= s2_len; j++) {
 537                         unsigned int sub = p[j - 1];
 538
 539                         if (s1[i - 1] != s2[j - 1])
 540                                 sub++;
 541
 542                         q[j] = min(p[j] + 1, min(q[j - 1] + 1, sub));
 543                 }
 544                 r = p;
 545                 p = q;
 546                 q = r;
 547         }
 548
 549         i = p[s2_len];
 550         free(p);
 551         free(q);
 552         return i;
 553 }
 554
 555 static void show_option_help(struct fio_option *o)
 556 {
 557         const char *typehelp[] = {
 558                 "string (opt=bla)",
 559                 "string with possible k/m/g postfix (opt=4k)",
 560                 "string with range and postfix (opt=1k-4k)",
 561                 "string with time postfix (opt=10s)",
 562                 "string (opt=bla)",
 563                 "string with dual range (opt=1k-4k,4k-8k)",
 564                 "integer value (opt=100)",
 565                 "boolean value (opt=1)",
 566                 "no argument (opt)",
 567         };
 568
 569         if (o->alias)
 570                 printf("%20s: %s\n", "alias", o->alias);
 571
 572         printf("%20s: %s\n", "type", typehelp[o->type]);
 573         printf("%20s: %s\n", "default", o->def ? o->def : "no default");
 574         show_option_range(o);
 575         show_option_values(o);
 576 }
 577
 578 static struct fio_option *find_child(struct fio_option *options,
 579                                      struct fio_option *o)
 580 {
 581         struct fio_option *__o;
 582
 583         for (__o = options + 1; __o->name; __o++)
 584                 if (__o->parent && !strcmp(__o->parent, o->name))
 585                         return __o;
 586
 587         return NULL;
 588 }
 589
 590 static void __print_option(struct fio_option *o, struct fio_option *org,
 591                            int level)
 592 {
 593         char name[256], *p;
 594         int depth;
 595
 596         if (!o)
 597                 return;
 598         if (!org)
 599                 org = o;
 600
 601         p = name;
 602         depth = level;
 603         while (depth--)
 604                 p += sprintf(p, "%s", "  ");
 605
 606         sprintf(p, "%s", o->name);
 607
 608         printf("%-24s: %s\n", name, o->help);
 609 }
 610
 611 static void print_option(struct fio_option *o)
 612 {
 613         struct fio_option *parent;
 614         struct fio_option *__o;
 615         unsigned int printed;
 616         unsigned int level;
 617
 618         __print_option(o, NULL, 0);
 619         parent = o;
 620         level = 0;
 621         do {
 622                 level++;
 623                 printed = 0;
 624
 625                 while ((__o = find_child(o, parent)) != NULL) {
 626                         __print_option(__o, o, level);
 627                         o = __o;
 628                         printed++;
 629                 }
 630
 631                 parent = o;
 632         } while (printed);
 633 }
 634
 635 int show_cmd_help(struct fio_option *options, const char *name)
 636 {
 637         struct fio_option *o, *closest;
 638         unsigned int best_dist;
 639         int found = 0;
 640         int show_all = 0;
 641
 642         if (!name || !strcmp(name, "all"))
 643                 show_all = 1;
 644
 645         closest = NULL;
 646         best_dist = -1;
 647         for (o = &options[0]; o->name; o++) {
 648                 int match = 0;
 649
 650                 if (o->type == FIO_OPT_DEPRECATED)
 651                         continue;
 652
 653                 if (name) {
 654                         if (!strcmp(name, o->name) ||
 655                             (o->alias && !strcmp(name, o->alias)))
 656                                 match = 1;
 657                         else {
 658                                 unsigned int dist;
 659
 660                                 dist = string_distance(name, o->name);
 661                                 if (dist < best_dist) {
 662                                         best_dist = dist;
 663                                         closest = o;
 664                                 }
 665                         }
 666                 }
 667
 668                 if (show_all || match) {
 669                         found = 1;
 670                         if (match)
 671                                 printf("%24s: %s\n", o->name, o->help);
 672                         if (show_all) {
 673                                 if (!o->parent)
 674                                         print_option(o);
 675                                 continue;
 676                         }
 677                 }
 678
 679                 if (!match)
 680                         continue;
 681
 682                 show_option_help(o);
 683         }
 684
 685         if (found)
 686                 return 0;
 687
 688         printf("No such command: %s", name);
 689         if (closest) {
 690                 printf(" - showing closest match\n");
 691                 printf("%20s: %s\n", closest->name, closest->help);
 692                 show_option_help(closest);
 693         } else
 694                 printf("\n");
 695
 696         return 1;
 697 }
 698
 699 /*
 700  * Handle parsing of default parameters.
 701  */
 702 void fill_default_options(void *data, struct fio_option *options)
 703 {
 704         struct fio_option *o;
 705
 706         dprint(FD_PARSE, "filling default options\n");
 707
 708         for (o = &options[0]; o->name; o++)
 709                 if (o->def)
 710                         handle_option(o, o->def, data);
 711 }
 712
 713 /*
 714  * Sanitize the options structure. For now it just sets min/max for bool
 715  * values and whether both callback and offsets are given.
 716  */
 717 void options_init(struct fio_option *options)
 718 {
 719         struct fio_option *o;
 720
 721         dprint(FD_PARSE, "init options\n");
 722
 723         for (o = &options[0]; o->name; o++) {
 724                 if (o->type == FIO_OPT_DEPRECATED)
 725                         continue;
 726                 if (o->type == FIO_OPT_BOOL) {
 727                         o->minval = 0;
 728                         o->maxval = 1;
 729                 }
 730                 if (o->type == FIO_OPT_STR_SET && o->def) {
 731                         fprintf(stderr, "Option %s: string set option with"
 732                                         " default will always be true\n",
 733                                                 o->name);
 734                 }
 735                 if (!o->cb && !o->off1) {
 736                         fprintf(stderr, "Option %s: neither cb nor offset"
 737                                         " given\n", o->name);
 738                 }
 739                 if (o->type == FIO_OPT_STR || o->type == FIO_OPT_STR_STORE)
 740                         continue;
 741                 if (o->cb && (o->off1 || o->off2 || o->off3 || o->off4)) {
 742                         fprintf(stderr, "Option %s: both cb and offset given\n",
 743                                                                  o->name);
 744                 }
 745         }
 746 }