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