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