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