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