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