fio: allow general repeatability
[fio.git] / parse.c
... / ...
CommitLineData
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
21static struct fio_option *__fio_options;
22
23static 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
31static 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
49static 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
71static 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
91static 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
125static 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
142static 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
155static 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
214static 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 */
243int 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 */
251int 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
283int check_str_bytes(const char *p, long long *val, void *data)
284{
285 return str_to_decimal(p, val, 1, data);
286}
287
288int check_str_time(const char *p, long long *val)
289{
290 return str_to_decimal(p, val, 0, NULL);
291}
292
293void 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
305void 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
328static 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
340static 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
355static 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
366static 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, o) \
372 do { \
373 ptr = td_var((data), (o), (off)); \
374 if ((or)) \
375 *ptr |= (val); \
376 else \
377 *ptr = (val); \
378 } while (0)
379
380static 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->off1)
418 val_store(ilp, vp->oval, o->off1, vp->orval, data, o);
419 continue;
420 }
421 }
422
423 if (ret && !all_skipped)
424 show_option_values(o);
425 else if (fn)
426 ret = fn(data, ptr);
427 break;
428 }
429 case FIO_OPT_STR_VAL_TIME:
430 is_time = 1;
431 case FIO_OPT_INT:
432 case FIO_OPT_STR_VAL: {
433 fio_opt_str_val_fn *fn = o->cb;
434 char tmp[128], *p;
435
436 strncpy(tmp, ptr, sizeof(tmp) - 1);
437 p = strchr(tmp, ',');
438 if (p)
439 *p = '\0';
440
441 if (is_time)
442 ret = check_str_time(tmp, &ull);
443 else
444 ret = check_str_bytes(tmp, &ull, data);
445
446 dprint(FD_PARSE, " ret=%d, out=%llu\n", ret, ull);
447
448 if (ret)
449 break;
450
451 if (o->maxval && ull > o->maxval) {
452 log_err("max value out of range: %llu"
453 " (%u max)\n", ull, o->maxval);
454 return 1;
455 }
456 if (o->minval && ull < o->minval) {
457 log_err("min value out of range: %llu"
458 " (%u min)\n", ull, o->minval);
459 return 1;
460 }
461 if (o->posval[0].ival) {
462 posval_sort(o, posval);
463
464 ret = 1;
465 for (i = 0; i < PARSE_MAX_VP; i++) {
466 vp = &posval[i];
467 if (!vp->ival || vp->ival[0] == '\0')
468 continue;
469 if (vp->oval == ull) {
470 ret = 0;
471 break;
472 }
473 }
474 if (ret) {
475 log_err("fio: value %llu not allowed:\n", ull);
476 show_option_values(o);
477 return 1;
478 }
479 }
480
481 if (fn)
482 ret = fn(data, &ull);
483 else {
484 if (o->type == FIO_OPT_INT) {
485 if (first)
486 val_store(ilp, ull, o->off1, 0, data, o);
487 if (curr == 1) {
488 if (o->off2)
489 val_store(ilp, ull, o->off2, 0, data, o);
490 }
491 if (curr == 2) {
492 if (o->off3)
493 val_store(ilp, ull, o->off3, 0, data, o);
494 }
495 if (!more) {
496 if (curr < 1) {
497 if (o->off2)
498 val_store(ilp, ull, o->off2, 0, data, o);
499 }
500 if (curr < 2) {
501 if (o->off3)
502 val_store(ilp, ull, o->off3, 0, data, o);
503 }
504 }
505 } else {
506 if (first)
507 val_store(ullp, ull, o->off1, 0, data, o);
508 if (!more) {
509 if (o->off2)
510 val_store(ullp, ull, o->off2, 0, data, o);
511 }
512 }
513 }
514 break;
515 }
516 case FIO_OPT_FLOAT_LIST: {
517 char *cp2;
518
519 if (first) {
520 /*
521 ** Initialize precision to 0 and zero out list
522 ** in case specified list is shorter than default
523 */
524 if (o->off2) {
525 ul2 = 0;
526 ilp = td_var(data, o, o->off2);
527 *ilp = ul2;
528 }
529
530 flp = td_var(data, o, o->off1);
531 for(i = 0; i < o->maxlen; i++)
532 flp[i].u.f = 0.0;
533 }
534 if (curr >= o->maxlen) {
535 log_err("the list exceeding max length %d\n",
536 o->maxlen);
537 return 1;
538 }
539 if (!str_to_float(ptr, &uf)) {
540 log_err("not a floating point value: %s\n", ptr);
541 return 1;
542 }
543 if (uf > o->maxfp) {
544 log_err("value out of range: %f"
545 " (range max: %f)\n", uf, o->maxfp);
546 return 1;
547 }
548 if (uf < o->minfp) {
549 log_err("value out of range: %f"
550 " (range min: %f)\n", uf, o->minfp);
551 return 1;
552 }
553
554 flp = td_var(data, o, o->off1);
555 flp[curr].u.f = uf;
556
557 dprint(FD_PARSE, " out=%f\n", uf);
558
559 /*
560 ** Calculate precision for output by counting
561 ** number of digits after period. Find first
562 ** period in entire remaining list each time
563 */
564 cp2 = strchr(ptr, '.');
565 if (cp2 != NULL) {
566 int len = 0;
567
568 while (*++cp2 != '\0' && *cp2 >= '0' && *cp2 <= '9')
569 len++;
570
571 if (o->off2) {
572 ilp = td_var(data, o, o->off2);
573 if (len > *ilp)
574 *ilp = len;
575 }
576 }
577
578 break;
579 }
580 case FIO_OPT_STR_STORE: {
581 fio_opt_str_fn *fn = o->cb;
582
583 if (o->off1) {
584 cp = td_var(data, o, o->off1);
585 *cp = strdup(ptr);
586 }
587
588 if (fn)
589 ret = fn(data, ptr);
590 else if (o->posval[0].ival) {
591 posval_sort(o, posval);
592
593 ret = 1;
594 for (i = 0; i < PARSE_MAX_VP; i++) {
595 vp = &posval[i];
596 if (!vp->ival || vp->ival[0] == '\0')
597 continue;
598 all_skipped = 0;
599 if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
600 char *rest;
601
602 ret = 0;
603 if (vp->cb)
604 fn = vp->cb;
605 rest = strstr(*cp ?: ptr, ":");
606 if (rest) {
607 if (*cp)
608 *rest = '\0';
609 ptr = rest + 1;
610 } else
611 ptr = NULL;
612 break;
613 }
614 }
615 }
616
617 if (!all_skipped) {
618 if (ret && !*cp)
619 show_option_values(o);
620 else if (ret && *cp)
621 ret = 0;
622 else if (fn && ptr)
623 ret = fn(data, ptr);
624 }
625
626 break;
627 }
628 case FIO_OPT_RANGE: {
629 char tmp[128];
630 char *p1, *p2;
631
632 strncpy(tmp, ptr, sizeof(tmp) - 1);
633
634 /* Handle bsrange with separate read,write values: */
635 p1 = strchr(tmp, ',');
636 if (p1)
637 *p1 = '\0';
638
639 p1 = strchr(tmp, '-');
640 if (!p1) {
641 p1 = strchr(tmp, ':');
642 if (!p1) {
643 ret = 1;
644 break;
645 }
646 }
647
648 p2 = p1 + 1;
649 *p1 = '\0';
650 p1 = tmp;
651
652 ret = 1;
653 if (!check_range_bytes(p1, &ul1, data) &&
654 !check_range_bytes(p2, &ul2, data)) {
655 ret = 0;
656 if (ul1 > ul2) {
657 unsigned long foo = ul1;
658
659 ul1 = ul2;
660 ul2 = foo;
661 }
662
663 if (first) {
664 val_store(ilp, ul1, o->off1, 0, data, o);
665 val_store(ilp, ul2, o->off2, 0, data, o);
666 }
667 if (curr == 1) {
668 if (o->off3 && o->off4) {
669 val_store(ilp, ul1, o->off3, 0, data, o);
670 val_store(ilp, ul2, o->off4, 0, data, o);
671 }
672 }
673 if (curr == 2) {
674 if (o->off5 && o->off6) {
675 val_store(ilp, ul1, o->off5, 0, data, o);
676 val_store(ilp, ul2, o->off6, 0, data, o);
677 }
678 }
679 if (!more) {
680 if (curr < 1) {
681 if (o->off3 && o->off4) {
682 val_store(ilp, ul1, o->off3, 0, data, o);
683 val_store(ilp, ul2, o->off4, 0, data, o);
684 }
685 }
686 if (curr < 2) {
687 if (o->off5 && o->off6) {
688 val_store(ilp, ul1, o->off5, 0, data, o);
689 val_store(ilp, ul2, o->off6, 0, data, o);
690 }
691 }
692 }
693 }
694
695 break;
696 }
697 case FIO_OPT_BOOL:
698 case FIO_OPT_STR_SET: {
699 fio_opt_int_fn *fn = o->cb;
700
701 if (ptr)
702 ret = check_int(ptr, &il);
703 else if (o->type == FIO_OPT_BOOL)
704 ret = 1;
705 else
706 il = 1;
707
708 dprint(FD_PARSE, " ret=%d, out=%d\n", ret, il);
709
710 if (ret)
711 break;
712
713 if (o->maxval && il > (int) o->maxval) {
714 log_err("max value out of range: %d (%d max)\n",
715 il, o->maxval);
716 return 1;
717 }
718 if (o->minval && il < o->minval) {
719 log_err("min value out of range: %d (%d min)\n",
720 il, o->minval);
721 return 1;
722 }
723
724 if (o->neg)
725 il = !il;
726
727 if (fn)
728 ret = fn(data, &il);
729 else {
730 if (first)
731 val_store(ilp, il, o->off1, 0, data, o);
732 if (!more) {
733 if (o->off2)
734 val_store(ilp, il, o->off2, 0, data, o);
735 }
736 }
737 break;
738 }
739 case FIO_OPT_DEPRECATED:
740 log_info("Option %s is deprecated\n", o->name);
741 ret = 1;
742 break;
743 default:
744 log_err("Bad option type %u\n", o->type);
745 ret = 1;
746 }
747
748 if (ret)
749 return ret;
750
751 if (o->verify) {
752 ret = o->verify(o, data);
753 if (ret) {
754 log_err("Correct format for offending option\n");
755 log_err("%20s: %s\n", o->name, o->help);
756 show_option_help(o, 1);
757 }
758 }
759
760 return ret;
761}
762
763static int handle_option(struct fio_option *o, const char *__ptr, void *data)
764{
765 char *o_ptr, *ptr, *ptr2;
766 int ret, done;
767
768 dprint(FD_PARSE, "handle_option=%s, ptr=%s\n", o->name, __ptr);
769
770 o_ptr = ptr = NULL;
771 if (__ptr)
772 o_ptr = ptr = strdup(__ptr);
773
774 /*
775 * See if we have another set of parameters, hidden after a comma.
776 * Do this before parsing this round, to check if we should
777 * copy set 1 options to set 2.
778 */
779 done = 0;
780 ret = 1;
781 do {
782 int __ret;
783
784 ptr2 = NULL;
785 if (ptr &&
786 (o->type != FIO_OPT_STR_STORE) &&
787 (o->type != FIO_OPT_STR) &&
788 (o->type != FIO_OPT_FLOAT_LIST)) {
789 ptr2 = strchr(ptr, ',');
790 if (ptr2 && *(ptr2 + 1) == '\0')
791 *ptr2 = '\0';
792 if (o->type != FIO_OPT_STR_MULTI && o->type != FIO_OPT_RANGE) {
793 if (!ptr2)
794 ptr2 = strchr(ptr, ':');
795 if (!ptr2)
796 ptr2 = strchr(ptr, '-');
797 }
798 } else if (ptr && o->type == FIO_OPT_FLOAT_LIST) {
799 ptr2 = strchr(ptr, ':');
800 }
801
802 /*
803 * Don't return early if parsing the first option fails - if
804 * we are doing multiple arguments, we can allow the first one
805 * being empty.
806 */
807 __ret = __handle_option(o, ptr, data, !done, !!ptr2, done);
808 if (ret)
809 ret = __ret;
810
811 if (!ptr2)
812 break;
813
814 ptr = ptr2 + 1;
815 done++;
816 } while (1);
817
818 if (o_ptr)
819 free(o_ptr);
820 return ret;
821}
822
823static struct fio_option *get_option(char *opt,
824 struct fio_option *options, char **post)
825{
826 struct fio_option *o;
827 char *ret;
828
829 ret = strchr(opt, '=');
830 if (ret) {
831 *post = ret;
832 *ret = '\0';
833 ret = opt;
834 (*post)++;
835 strip_blank_end(ret);
836 o = find_option(options, ret);
837 } else {
838 o = find_option(options, opt);
839 *post = NULL;
840 }
841
842 return o;
843}
844
845static int opt_cmp(const void *p1, const void *p2)
846{
847 struct fio_option *o;
848 char *s, *foo;
849 int prio1, prio2;
850
851 prio1 = prio2 = 0;
852
853 if (*(char **)p1) {
854 s = strdup(*((char **) p1));
855 o = get_option(s, __fio_options, &foo);
856 if (o)
857 prio1 = o->prio;
858 free(s);
859 }
860 if (*(char **)p2) {
861 s = strdup(*((char **) p2));
862 o = get_option(s, __fio_options, &foo);
863 if (o)
864 prio2 = o->prio;
865 free(s);
866 }
867
868 return prio2 - prio1;
869}
870
871void sort_options(char **opts, struct fio_option *options, int num_opts)
872{
873 __fio_options = options;
874 qsort(opts, num_opts, sizeof(char *), opt_cmp);
875 __fio_options = NULL;
876}
877
878int parse_cmd_option(const char *opt, const char *val,
879 struct fio_option *options, void *data)
880{
881 struct fio_option *o;
882
883 o = find_option(options, opt);
884 if (!o) {
885 log_err("Bad option <%s>\n", opt);
886 return 1;
887 }
888
889 if (!handle_option(o, val, data))
890 return 0;
891
892 log_err("fio: failed parsing %s=%s\n", opt, val);
893 return 1;
894}
895
896int parse_option(char *opt, const char *input,
897 struct fio_option *options, struct fio_option **o, void *data,
898 int dump_cmdline)
899{
900 char *post;
901
902 if (!opt) {
903 log_err("fio: failed parsing %s\n", input);
904 *o = NULL;
905 return 1;
906 }
907
908 *o = get_option(opt, options, &post);
909 if (!*o) {
910 if (post) {
911 int len = strlen(opt);
912 if (opt + len + 1 != post)
913 memmove(opt + len + 1, post, strlen(post));
914 opt[len] = '=';
915 }
916 return 1;
917 }
918
919 if (handle_option(*o, post, data)) {
920 log_err("fio: failed parsing %s\n", input);
921 return 1;
922 }
923
924 if (dump_cmdline) {
925 const char *delim;
926
927 if (!strcmp("description", (*o)->name))
928 delim = "\"";
929 else
930 delim = "";
931
932 log_info("--%s%s", (*o)->name, post ? "" : " ");
933 if (post)
934 log_info("=%s%s%s ", delim, post, delim);
935 }
936
937 return 0;
938}
939
940/*
941 * Option match, levenshtein distance. Handy for not quite remembering what
942 * the option name is.
943 */
944static int string_distance(const char *s1, const char *s2)
945{
946 unsigned int s1_len = strlen(s1);
947 unsigned int s2_len = strlen(s2);
948 unsigned int *p, *q, *r;
949 unsigned int i, j;
950
951 p = malloc(sizeof(unsigned int) * (s2_len + 1));
952 q = malloc(sizeof(unsigned int) * (s2_len + 1));
953
954 p[0] = 0;
955 for (i = 1; i <= s2_len; i++)
956 p[i] = p[i - 1] + 1;
957
958 for (i = 1; i <= s1_len; i++) {
959 q[0] = p[0] + 1;
960 for (j = 1; j <= s2_len; j++) {
961 unsigned int sub = p[j - 1];
962
963 if (s1[i - 1] != s2[j - 1])
964 sub++;
965
966 q[j] = min(p[j] + 1, min(q[j - 1] + 1, sub));
967 }
968 r = p;
969 p = q;
970 q = r;
971 }
972
973 i = p[s2_len];
974 free(p);
975 free(q);
976 return i;
977}
978
979static struct fio_option *find_child(struct fio_option *options,
980 struct fio_option *o)
981{
982 struct fio_option *__o;
983
984 for (__o = options + 1; __o->name; __o++)
985 if (__o->parent && !strcmp(__o->parent, o->name))
986 return __o;
987
988 return NULL;
989}
990
991static void __print_option(struct fio_option *o, struct fio_option *org,
992 int level)
993{
994 char name[256], *p;
995 int depth;
996
997 if (!o)
998 return;
999 if (!org)
1000 org = o;
1001
1002 p = name;
1003 depth = level;
1004 while (depth--)
1005 p += sprintf(p, "%s", " ");
1006
1007 sprintf(p, "%s", o->name);
1008
1009 log_info("%-24s: %s\n", name, o->help);
1010}
1011
1012static void print_option(struct fio_option *o)
1013{
1014 struct fio_option *parent;
1015 struct fio_option *__o;
1016 unsigned int printed;
1017 unsigned int level;
1018
1019 __print_option(o, NULL, 0);
1020 parent = o;
1021 level = 0;
1022 do {
1023 level++;
1024 printed = 0;
1025
1026 while ((__o = find_child(o, parent)) != NULL) {
1027 __print_option(__o, o, level);
1028 o = __o;
1029 printed++;
1030 }
1031
1032 parent = o;
1033 } while (printed);
1034}
1035
1036int show_cmd_help(struct fio_option *options, const char *name)
1037{
1038 struct fio_option *o, *closest;
1039 unsigned int best_dist = -1U;
1040 int found = 0;
1041 int show_all = 0;
1042
1043 if (!name || !strcmp(name, "all"))
1044 show_all = 1;
1045
1046 closest = NULL;
1047 best_dist = -1;
1048 for (o = &options[0]; o->name; o++) {
1049 int match = 0;
1050
1051 if (o->type == FIO_OPT_DEPRECATED)
1052 continue;
1053 if (!exec_profile && o->prof_name)
1054 continue;
1055 if (exec_profile && !(o->prof_name && !strcmp(exec_profile, o->prof_name)))
1056 continue;
1057
1058 if (name) {
1059 if (!strcmp(name, o->name) ||
1060 (o->alias && !strcmp(name, o->alias)))
1061 match = 1;
1062 else {
1063 unsigned int dist;
1064
1065 dist = string_distance(name, o->name);
1066 if (dist < best_dist) {
1067 best_dist = dist;
1068 closest = o;
1069 }
1070 }
1071 }
1072
1073 if (show_all || match) {
1074 found = 1;
1075 if (match)
1076 log_info("%20s: %s\n", o->name, o->help);
1077 if (show_all) {
1078 if (!o->parent)
1079 print_option(o);
1080 continue;
1081 }
1082 }
1083
1084 if (!match)
1085 continue;
1086
1087 show_option_help(o, 0);
1088 }
1089
1090 if (found)
1091 return 0;
1092
1093 log_err("No such command: %s", name);
1094
1095 /*
1096 * Only print an appropriately close option, one where the edit
1097 * distance isn't too big. Otherwise we get crazy matches.
1098 */
1099 if (closest && best_dist < 3) {
1100 log_info(" - showing closest match\n");
1101 log_info("%20s: %s\n", closest->name, closest->help);
1102 show_option_help(closest, 0);
1103 } else
1104 log_info("\n");
1105
1106 return 1;
1107}
1108
1109/*
1110 * Handle parsing of default parameters.
1111 */
1112void fill_default_options(void *data, struct fio_option *options)
1113{
1114 struct fio_option *o;
1115
1116 dprint(FD_PARSE, "filling default options\n");
1117
1118 for (o = &options[0]; o->name; o++)
1119 if (o->def)
1120 handle_option(o, o->def, data);
1121}
1122
1123void option_init(struct fio_option *o)
1124{
1125 if (o->type == FIO_OPT_DEPRECATED)
1126 return;
1127 if (o->type == FIO_OPT_BOOL) {
1128 o->minval = 0;
1129 o->maxval = 1;
1130 }
1131 if (o->type == FIO_OPT_INT) {
1132 if (!o->maxval)
1133 o->maxval = UINT_MAX;
1134 }
1135 if (o->type == FIO_OPT_FLOAT_LIST) {
1136 o->minfp = DBL_MIN;
1137 o->maxfp = DBL_MAX;
1138 }
1139 if (o->type == FIO_OPT_STR_SET && o->def) {
1140 log_err("Option %s: string set option with"
1141 " default will always be true\n", o->name);
1142 }
1143 if (!o->cb && !o->off1)
1144 log_err("Option %s: neither cb nor offset given\n", o->name);
1145 if (!o->category) {
1146 log_info("Option %s: no category defined. Setting to misc\n", o->name);
1147 o->category = FIO_OPT_C_GENERAL;
1148 o->group = FIO_OPT_G_INVALID;
1149 }
1150 if (o->type == FIO_OPT_STR || o->type == FIO_OPT_STR_STORE ||
1151 o->type == FIO_OPT_STR_MULTI)
1152 return;
1153 if (o->cb && (o->off1 || o->off2 || o->off3 || o->off4))
1154 log_err("Option %s: both cb and offset given\n", o->name);
1155}
1156
1157/*
1158 * Sanitize the options structure. For now it just sets min/max for bool
1159 * values and whether both callback and offsets are given.
1160 */
1161void options_init(struct fio_option *options)
1162{
1163 struct fio_option *o;
1164
1165 dprint(FD_PARSE, "init options\n");
1166
1167 for (o = &options[0]; o->name; o++) {
1168 option_init(o);
1169 if (o->inverse)
1170 o->inv_opt = find_option(options, o->inverse);
1171 }
1172}
1173
1174void options_free(struct fio_option *options, void *data)
1175{
1176 struct fio_option *o;
1177 char **ptr;
1178
1179 dprint(FD_PARSE, "free options\n");
1180
1181 for (o = &options[0]; o->name; o++) {
1182 if (o->type != FIO_OPT_STR_STORE || !o->off1)
1183 continue;
1184
1185 ptr = td_var(data, o, o->off1);
1186 if (*ptr) {
1187 free(*ptr);
1188 *ptr = NULL;
1189 }
1190 }
1191}