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