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