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