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