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