Optimize the code that copies strings
[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 if ((int) val < 0)
517 return (int) val > (int) o->maxval;
518 return (unsigned int) 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 return (int) val < o->minval;
532
533 return val < o->minval;
534}
535
536static int __handle_option(const struct fio_option *o, const char *ptr,
537 void *data, int first, int more, int curr)
538{
539 int il=0, *ilp;
540 fio_fp64_t *flp;
541 long long ull, *ullp;
542 long ul2;
543 long long ull1, ull2;
544 double uf;
545 char **cp = NULL;
546 int ret = 0, is_time = 0;
547 const struct value_pair *vp;
548 struct value_pair posval[PARSE_MAX_VP];
549 int i, all_skipped = 1;
550
551 dprint(FD_PARSE, "__handle_option=%s, type=%s, ptr=%s\n", o->name,
552 opt_type_name(o), ptr);
553
554 if (!ptr && o->type != FIO_OPT_STR_SET && o->type != FIO_OPT_STR) {
555 log_err("Option %s requires an argument\n", o->name);
556 return 1;
557 }
558
559 switch (o->type) {
560 case FIO_OPT_STR:
561 case FIO_OPT_STR_ULL:
562 case FIO_OPT_STR_MULTI: {
563 fio_opt_str_fn *fn = o->cb;
564
565 posval_sort(o, posval);
566
567 ret = 1;
568 for (i = 0; i < PARSE_MAX_VP; i++) {
569 vp = &posval[i];
570 if (!vp->ival || vp->ival[0] == '\0')
571 continue;
572 all_skipped = 0;
573 if (!ptr)
574 break;
575 if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
576 ret = 0;
577 if (!o->off1)
578 continue;
579 if (o->type == FIO_OPT_STR_ULL)
580 val_store(ullp, vp->oval, o->off1, vp->orval, data, o);
581 else
582 val_store(ilp, vp->oval, o->off1, vp->orval, data, o);
583 continue;
584 }
585 }
586
587 if (ret && !all_skipped)
588 show_option_values(o);
589 else if (fn)
590 ret = fn(data, ptr);
591 break;
592 }
593 case FIO_OPT_STR_VAL_TIME:
594 is_time = 1;
595 /* fall through */
596 case FIO_OPT_ULL:
597 case FIO_OPT_INT:
598 case FIO_OPT_STR_VAL: {
599 fio_opt_str_val_fn *fn = o->cb;
600 char tmp[128], *p;
601
602 if (!is_time && o->is_time)
603 is_time = o->is_time;
604
605 snprintf(tmp, sizeof(tmp), "%s", ptr);
606 p = strchr(tmp, ',');
607 if (p)
608 *p = '\0';
609
610 if (is_time)
611 ret = check_str_time(tmp, &ull, o->is_seconds);
612 else
613 ret = check_str_bytes(tmp, &ull, data);
614
615 dprint(FD_PARSE, " ret=%d, out=%llu\n", ret, ull);
616
617 if (ret)
618 break;
619 if (o->pow2 && !is_power_of_2(ull)) {
620 log_err("%s: must be a power-of-2\n", o->name);
621 return 1;
622 }
623
624 if (val_too_large(o, ull, o->type == FIO_OPT_INT)) {
625 log_err("%s: max value out of range: %llu"
626 " (%llu max)\n", o->name, ull, o->maxval);
627 return 1;
628 }
629 if (val_too_small(o, ull, o->type == FIO_OPT_INT)) {
630 log_err("%s: min value out of range: %lld"
631 " (%d min)\n", o->name, ull, o->minval);
632 return 1;
633 }
634 if (o->posval[0].ival) {
635 posval_sort(o, posval);
636
637 ret = 1;
638 for (i = 0; i < PARSE_MAX_VP; i++) {
639 vp = &posval[i];
640 if (!vp->ival || vp->ival[0] == '\0')
641 continue;
642 if (vp->oval == ull) {
643 ret = 0;
644 break;
645 }
646 }
647 if (ret) {
648 log_err("fio: value %llu not allowed:\n", ull);
649 show_option_values(o);
650 return 1;
651 }
652 }
653
654 if (fn)
655 ret = fn(data, &ull);
656 else {
657 if (o->type == FIO_OPT_INT) {
658 if (first)
659 val_store(ilp, ull, o->off1, 0, data, o);
660 if (curr == 1) {
661 if (o->off2)
662 val_store(ilp, ull, o->off2, 0, data, o);
663 }
664 if (curr == 2) {
665 if (o->off3)
666 val_store(ilp, ull, o->off3, 0, data, o);
667 }
668 if (!more) {
669 if (curr < 1) {
670 if (o->off2)
671 val_store(ilp, ull, o->off2, 0, data, o);
672 }
673 if (curr < 2) {
674 if (o->off3)
675 val_store(ilp, ull, o->off3, 0, data, o);
676 }
677 }
678 } else if (o->type == FIO_OPT_ULL) {
679 if (first)
680 val_store(ullp, ull, o->off1, 0, data, o);
681 if (curr == 1) {
682 if (o->off2)
683 val_store(ullp, ull, o->off2, 0, data, o);
684 }
685 if (curr == 2) {
686 if (o->off3)
687 val_store(ullp, ull, o->off3, 0, data, o);
688 }
689 if (!more) {
690 if (curr < 1) {
691 if (o->off2)
692 val_store(ullp, ull, o->off2, 0, data, o);
693 }
694 if (curr < 2) {
695 if (o->off3)
696 val_store(ullp, ull, o->off3, 0, data, o);
697 }
698 }
699 } else {
700 if (first)
701 val_store(ullp, ull, o->off1, 0, data, o);
702 if (!more) {
703 if (o->off2)
704 val_store(ullp, ull, o->off2, 0, data, o);
705 }
706 }
707 }
708 break;
709 }
710 case FIO_OPT_FLOAT_LIST: {
711 char *cp2;
712
713 if (first) {
714 /*
715 ** Initialize precision to 0 and zero out list
716 ** in case specified list is shorter than default
717 */
718 if (o->off2) {
719 ul2 = 0;
720 ilp = td_var(data, o, o->off2);
721 *ilp = ul2;
722 }
723
724 flp = td_var(data, o, o->off1);
725 for(i = 0; i < o->maxlen; i++)
726 flp[i].u.f = 0.0;
727 }
728 if (curr >= o->maxlen) {
729 log_err("the list exceeding max length %d\n",
730 o->maxlen);
731 return 1;
732 }
733 if (!str_to_float(ptr, &uf, 0)) { /* this breaks if we ever have lists of times */
734 log_err("not a floating point value: %s\n", ptr);
735 return 1;
736 }
737 if (o->minfp || o->maxfp) {
738 if (uf > o->maxfp) {
739 log_err("value out of range: %f"
740 " (range max: %f)\n", uf, o->maxfp);
741 return 1;
742 }
743 if (uf < o->minfp) {
744 log_err("value out of range: %f"
745 " (range min: %f)\n", uf, o->minfp);
746 return 1;
747 }
748 }
749
750 flp = td_var(data, o, o->off1);
751 flp[curr].u.f = uf;
752
753 dprint(FD_PARSE, " out=%f\n", uf);
754
755 /*
756 ** Calculate precision for output by counting
757 ** number of digits after period. Find first
758 ** period in entire remaining list each time
759 */
760 cp2 = strchr(ptr, '.');
761 if (cp2 != NULL) {
762 int len = 0;
763
764 while (*++cp2 != '\0' && *cp2 >= '0' && *cp2 <= '9')
765 len++;
766
767 if (o->off2) {
768 ilp = td_var(data, o, o->off2);
769 if (len > *ilp)
770 *ilp = len;
771 }
772 }
773
774 break;
775 }
776 case FIO_OPT_STR_STORE: {
777 fio_opt_str_fn *fn = o->cb;
778
779 if (!strlen(ptr))
780 return 1;
781
782 if (o->off1) {
783 cp = td_var(data, o, o->off1);
784 *cp = strdup(ptr);
785 }
786
787 if (fn)
788 ret = fn(data, ptr);
789 else if (o->posval[0].ival) {
790 posval_sort(o, posval);
791
792 ret = 1;
793 for (i = 0; i < PARSE_MAX_VP; i++) {
794 vp = &posval[i];
795 if (!vp->ival || vp->ival[0] == '\0' || !cp)
796 continue;
797 all_skipped = 0;
798 if (!strncmp(vp->ival, ptr, str_match_len(vp, ptr))) {
799 char *rest;
800
801 ret = 0;
802 if (vp->cb)
803 fn = vp->cb;
804 rest = strstr(*cp ?: ptr, ":");
805 if (rest) {
806 if (*cp)
807 *rest = '\0';
808 ptr = rest + 1;
809 } else
810 ptr = NULL;
811 break;
812 }
813 }
814 }
815
816 if (!all_skipped) {
817 if (ret && !*cp)
818 show_option_values(o);
819 else if (ret && *cp)
820 ret = 0;
821 else if (fn && ptr)
822 ret = fn(data, ptr);
823 }
824
825 break;
826 }
827 case FIO_OPT_RANGE: {
828 char tmp[128];
829 char *p1, *p2;
830
831 snprintf(tmp, sizeof(tmp), "%s", ptr);
832
833 /* Handle bsrange with separate read,write values: */
834 p1 = strchr(tmp, ',');
835 if (p1)
836 *p1 = '\0';
837
838 p1 = strchr(tmp, '-');
839 if (!p1) {
840 p1 = strchr(tmp, ':');
841 if (!p1) {
842 ret = 1;
843 break;
844 }
845 }
846
847 p2 = p1 + 1;
848 *p1 = '\0';
849 p1 = tmp;
850
851 ret = 1;
852 if (!check_range_bytes(p1, &ull1, data) &&
853 !check_range_bytes(p2, &ull2, data)) {
854 ret = 0;
855 if (ull1 > ull2) {
856 unsigned long long foo = ull1;
857
858 ull1 = ull2;
859 ull2 = foo;
860 }
861
862 if (first) {
863 val_store(ullp, ull1, o->off1, 0, data, o);
864 val_store(ullp, ull2, o->off2, 0, data, o);
865 }
866 if (curr == 1) {
867 if (o->off3 && o->off4) {
868 val_store(ullp, ull1, o->off3, 0, data, o);
869 val_store(ullp, ull2, o->off4, 0, data, o);
870 }
871 }
872 if (curr == 2) {
873 if (o->off5 && o->off6) {
874 val_store(ullp, ull1, o->off5, 0, data, o);
875 val_store(ullp, ull2, o->off6, 0, data, o);
876 }
877 }
878 if (!more) {
879 if (curr < 1) {
880 if (o->off3 && o->off4) {
881 val_store(ullp, ull1, o->off3, 0, data, o);
882 val_store(ullp, ull2, o->off4, 0, data, o);
883 }
884 }
885 if (curr < 2) {
886 if (o->off5 && o->off6) {
887 val_store(ullp, ull1, o->off5, 0, data, o);
888 val_store(ullp, ull2, o->off6, 0, data, o);
889 }
890 }
891 }
892 }
893
894 break;
895 }
896 case FIO_OPT_BOOL:
897 case FIO_OPT_STR_SET: {
898 fio_opt_int_fn *fn = o->cb;
899
900 if (ptr)
901 ret = check_int(ptr, &il);
902 else if (o->type == FIO_OPT_BOOL)
903 ret = 1;
904 else
905 il = 1;
906
907 dprint(FD_PARSE, " ret=%d, out=%d\n", ret, il);
908
909 if (ret)
910 break;
911
912 if (o->maxval && il > (int) o->maxval) {
913 log_err("max value out of range: %d (%llu max)\n",
914 il, o->maxval);
915 return 1;
916 }
917 if (o->minval && il < o->minval) {
918 log_err("min value out of range: %d (%d min)\n",
919 il, o->minval);
920 return 1;
921 }
922
923 if (o->neg)
924 il = !il;
925
926 if (fn)
927 ret = fn(data, &il);
928 else {
929 if (first)
930 val_store(ilp, il, o->off1, 0, data, o);
931 if (!more) {
932 if (o->off2)
933 val_store(ilp, il, o->off2, 0, data, o);
934 }
935 }
936 break;
937 }
938 case FIO_OPT_DEPRECATED:
939 ret = 1;
940 /* fall through */
941 case FIO_OPT_SOFT_DEPRECATED:
942 log_info("Option %s is deprecated\n", o->name);
943 break;
944 default:
945 log_err("Bad option type %u\n", o->type);
946 ret = 1;
947 }
948
949 if (ret)
950 return ret;
951
952 if (o->verify) {
953 ret = o->verify(o, data);
954 if (ret) {
955 log_err("Correct format for offending option\n");
956 log_err("%20s: %s\n", o->name, o->help);
957 show_option_help(o, 1);
958 }
959 }
960
961 return ret;
962}
963
964static int handle_option(const struct fio_option *o, const char *__ptr,
965 void *data)
966{
967 char *o_ptr, *ptr, *ptr2;
968 int ret, done;
969
970 dprint(FD_PARSE, "handle_option=%s, ptr=%s\n", o->name, __ptr);
971
972 o_ptr = ptr = NULL;
973 if (__ptr)
974 o_ptr = ptr = strdup(__ptr);
975
976 /*
977 * See if we have another set of parameters, hidden after a comma.
978 * Do this before parsing this round, to check if we should
979 * copy set 1 options to set 2.
980 */
981 done = 0;
982 ret = 1;
983 do {
984 int __ret;
985
986 ptr2 = NULL;
987 if (ptr &&
988 (o->type != FIO_OPT_STR_STORE) &&
989 (o->type != FIO_OPT_STR) &&
990 (o->type != FIO_OPT_STR_ULL) &&
991 (o->type != FIO_OPT_FLOAT_LIST)) {
992 ptr2 = strchr(ptr, ',');
993 if (ptr2 && *(ptr2 + 1) == '\0')
994 *ptr2 = '\0';
995 if (o->type != FIO_OPT_STR_MULTI && o->type != FIO_OPT_RANGE) {
996 if (!ptr2)
997 ptr2 = strchr(ptr, ':');
998 if (!ptr2)
999 ptr2 = strchr(ptr, '-');
1000 }
1001 } else if (ptr && o->type == FIO_OPT_FLOAT_LIST) {
1002 ptr2 = strchr(ptr, ':');
1003 }
1004
1005 /*
1006 * Don't return early if parsing the first option fails - if
1007 * we are doing multiple arguments, we can allow the first one
1008 * being empty.
1009 */
1010 __ret = __handle_option(o, ptr, data, !done, !!ptr2, done);
1011 if (ret)
1012 ret = __ret;
1013
1014 if (!ptr2)
1015 break;
1016
1017 ptr = ptr2 + 1;
1018 done++;
1019 } while (1);
1020
1021 if (o_ptr)
1022 free(o_ptr);
1023 return ret;
1024}
1025
1026struct fio_option *find_option(struct fio_option *options, const char *opt)
1027{
1028 struct fio_option *o;
1029
1030 for (o = &options[0]; o->name; o++) {
1031 if (!o_match(o, opt))
1032 continue;
1033 if (o->type == FIO_OPT_UNSUPPORTED) {
1034 log_err("Option <%s>: %s\n", o->name, o->help);
1035 continue;
1036 }
1037
1038 return o;
1039 }
1040
1041 return NULL;
1042}
1043
1044const struct fio_option *
1045find_option_c(const struct fio_option *options, const char *opt)
1046{
1047 return find_option((struct fio_option *)options, opt);
1048}
1049
1050static const struct fio_option *
1051get_option(char *opt, const struct fio_option *options, char **post)
1052{
1053 const struct fio_option *o;
1054 char *ret;
1055
1056 ret = strchr(opt, '=');
1057 if (ret) {
1058 *post = ret;
1059 *ret = '\0';
1060 ret = opt;
1061 (*post)++;
1062 strip_blank_end(ret);
1063 o = find_option_c(options, ret);
1064 } else {
1065 o = find_option_c(options, opt);
1066 *post = NULL;
1067 }
1068
1069 return o;
1070}
1071
1072static int opt_cmp(const void *p1, const void *p2)
1073{
1074 const struct fio_option *o;
1075 char *s, *foo;
1076 int prio1, prio2;
1077
1078 prio1 = prio2 = 0;
1079
1080 if (*(char **)p1) {
1081 s = strdup(*((char **) p1));
1082 o = get_option(s, __fio_options, &foo);
1083 if (o)
1084 prio1 = o->prio;
1085 free(s);
1086 }
1087 if (*(char **)p2) {
1088 s = strdup(*((char **) p2));
1089 o = get_option(s, __fio_options, &foo);
1090 if (o)
1091 prio2 = o->prio;
1092 free(s);
1093 }
1094
1095 return prio2 - prio1;
1096}
1097
1098void sort_options(char **opts, const struct fio_option *options, int num_opts)
1099{
1100 __fio_options = options;
1101 qsort(opts, num_opts, sizeof(char *), opt_cmp);
1102 __fio_options = NULL;
1103}
1104
1105static void add_to_dump_list(const struct fio_option *o,
1106 struct flist_head *dump_list, const char *post)
1107{
1108 struct print_option *p;
1109
1110 if (!dump_list)
1111 return;
1112
1113 p = malloc(sizeof(*p));
1114 p->name = strdup(o->name);
1115 if (post)
1116 p->value = strdup(post);
1117 else
1118 p->value = NULL;
1119
1120 flist_add_tail(&p->list, dump_list);
1121}
1122
1123int parse_cmd_option(const char *opt, const char *val,
1124 const struct fio_option *options, void *data,
1125 struct flist_head *dump_list)
1126{
1127 const struct fio_option *o;
1128
1129 o = find_option_c(options, opt);
1130 if (!o) {
1131 log_err("Bad option <%s>\n", opt);
1132 return 1;
1133 }
1134
1135 if (handle_option(o, val, data)) {
1136 log_err("fio: failed parsing %s=%s\n", opt, val);
1137 return 1;
1138 }
1139
1140 add_to_dump_list(o, dump_list, val);
1141 return 0;
1142}
1143
1144int parse_option(char *opt, const char *input, const struct fio_option *options,
1145 const struct fio_option **o, void *data,
1146 struct flist_head *dump_list)
1147{
1148 char *post;
1149
1150 if (!opt) {
1151 log_err("fio: failed parsing %s\n", input);
1152 *o = NULL;
1153 return 1;
1154 }
1155
1156 *o = get_option(opt, options, &post);
1157 if (!*o) {
1158 if (post) {
1159 int len = strlen(opt);
1160 if (opt + len + 1 != post)
1161 memmove(opt + len + 1, post, strlen(post));
1162 opt[len] = '=';
1163 }
1164 return 1;
1165 }
1166
1167 if (handle_option(*o, post, data)) {
1168 log_err("fio: failed parsing %s\n", input);
1169 return 1;
1170 }
1171
1172 add_to_dump_list(*o, dump_list, post);
1173 return 0;
1174}
1175
1176/*
1177 * Option match, levenshtein distance. Handy for not quite remembering what
1178 * the option name is.
1179 */
1180int string_distance(const char *s1, const char *s2)
1181{
1182 unsigned int s1_len = strlen(s1);
1183 unsigned int s2_len = strlen(s2);
1184 unsigned int *p, *q, *r;
1185 unsigned int i, j;
1186
1187 p = malloc(sizeof(unsigned int) * (s2_len + 1));
1188 q = malloc(sizeof(unsigned int) * (s2_len + 1));
1189
1190 p[0] = 0;
1191 for (i = 1; i <= s2_len; i++)
1192 p[i] = p[i - 1] + 1;
1193
1194 for (i = 1; i <= s1_len; i++) {
1195 q[0] = p[0] + 1;
1196 for (j = 1; j <= s2_len; j++) {
1197 unsigned int sub = p[j - 1];
1198 unsigned int pmin;
1199
1200 if (s1[i - 1] != s2[j - 1])
1201 sub++;
1202
1203 pmin = min(q[j - 1] + 1, sub);
1204 q[j] = min(p[j] + 1, pmin);
1205 }
1206 r = p;
1207 p = q;
1208 q = r;
1209 }
1210
1211 i = p[s2_len];
1212 free(p);
1213 free(q);
1214 return i;
1215}
1216
1217/*
1218 * Make a guess of whether the distance from 's1' is significant enough
1219 * to warrant printing the guess. We set this to a 1/2 match.
1220 */
1221int string_distance_ok(const char *opt, int distance)
1222{
1223 size_t len;
1224
1225 len = strlen(opt);
1226 len = (len + 1) / 2;
1227 return distance <= len;
1228}
1229
1230static const struct fio_option *find_child(const struct fio_option *options,
1231 const struct fio_option *o)
1232{
1233 const struct fio_option *__o;
1234
1235 for (__o = options + 1; __o->name; __o++)
1236 if (__o->parent && !strcmp(__o->parent, o->name))
1237 return __o;
1238
1239 return NULL;
1240}
1241
1242static void __print_option(const struct fio_option *o,
1243 const struct fio_option *org,
1244 int level)
1245{
1246 char name[256], *p;
1247 int depth;
1248
1249 if (!o)
1250 return;
1251
1252 p = name;
1253 depth = level;
1254 while (depth--)
1255 p += sprintf(p, "%s", " ");
1256
1257 sprintf(p, "%s", o->name);
1258
1259 log_info("%-24s: %s\n", name, o->help);
1260}
1261
1262static void print_option(const struct fio_option *o)
1263{
1264 const struct fio_option *parent;
1265 const struct fio_option *__o;
1266 unsigned int printed;
1267 unsigned int level;
1268
1269 __print_option(o, NULL, 0);
1270 parent = o;
1271 level = 0;
1272 do {
1273 level++;
1274 printed = 0;
1275
1276 while ((__o = find_child(o, parent)) != NULL) {
1277 __print_option(__o, o, level);
1278 o = __o;
1279 printed++;
1280 }
1281
1282 parent = o;
1283 } while (printed);
1284}
1285
1286int show_cmd_help(const struct fio_option *options, const char *name)
1287{
1288 const struct fio_option *o, *closest;
1289 unsigned int best_dist = -1U;
1290 int found = 0;
1291 int show_all = 0;
1292
1293 if (!name || !strcmp(name, "all"))
1294 show_all = 1;
1295
1296 closest = NULL;
1297 best_dist = -1;
1298 for (o = &options[0]; o->name; o++) {
1299 int match = 0;
1300
1301 if (o->type == FIO_OPT_DEPRECATED ||
1302 o->type == FIO_OPT_SOFT_DEPRECATED)
1303 continue;
1304 if (!exec_profile && o->prof_name)
1305 continue;
1306 if (exec_profile && !(o->prof_name && !strcmp(exec_profile, o->prof_name)))
1307 continue;
1308
1309 if (name) {
1310 if (!strcmp(name, o->name) ||
1311 (o->alias && !strcmp(name, o->alias)))
1312 match = 1;
1313 else {
1314 unsigned int dist;
1315
1316 dist = string_distance(name, o->name);
1317 if (dist < best_dist) {
1318 best_dist = dist;
1319 closest = o;
1320 }
1321 }
1322 }
1323
1324 if (show_all || match) {
1325 found = 1;
1326 if (match)
1327 log_info("%20s: %s\n", o->name, o->help);
1328 if (show_all) {
1329 if (!o->parent)
1330 print_option(o);
1331 continue;
1332 }
1333 }
1334
1335 if (!match)
1336 continue;
1337
1338 show_option_help(o, 0);
1339 }
1340
1341 if (found)
1342 return 0;
1343
1344 log_err("No such command: %s", name);
1345
1346 /*
1347 * Only print an appropriately close option, one where the edit
1348 * distance isn't too big. Otherwise we get crazy matches.
1349 */
1350 if (closest && best_dist < 3) {
1351 log_info(" - showing closest match\n");
1352 log_info("%20s: %s\n", closest->name, closest->help);
1353 show_option_help(closest, 0);
1354 } else
1355 log_info("\n");
1356
1357 return 1;
1358}
1359
1360/*
1361 * Handle parsing of default parameters.
1362 */
1363void fill_default_options(void *data, const struct fio_option *options)
1364{
1365 const struct fio_option *o;
1366
1367 dprint(FD_PARSE, "filling default options\n");
1368
1369 for (o = &options[0]; o->name; o++)
1370 if (o->def)
1371 handle_option(o, o->def, data);
1372}
1373
1374static void option_init(struct fio_option *o)
1375{
1376 if (o->type == FIO_OPT_DEPRECATED || o->type == FIO_OPT_UNSUPPORTED ||
1377 o->type == FIO_OPT_SOFT_DEPRECATED)
1378 return;
1379 if (o->name && !o->lname)
1380 log_err("Option %s: missing long option name\n", o->name);
1381 if (o->type == FIO_OPT_BOOL) {
1382 o->minval = 0;
1383 o->maxval = 1;
1384 }
1385 if (o->type == FIO_OPT_INT) {
1386 if (!o->maxval)
1387 o->maxval = UINT_MAX;
1388 }
1389 if (o->type == FIO_OPT_ULL) {
1390 if (!o->maxval)
1391 o->maxval = ULLONG_MAX;
1392 }
1393 if (o->type == FIO_OPT_STR_SET && o->def && !o->no_warn_def) {
1394 log_err("Option %s: string set option with"
1395 " default will always be true\n", o->name);
1396 }
1397 if (!o->cb && !o->off1)
1398 log_err("Option %s: neither cb nor offset given\n", o->name);
1399 if (!o->category) {
1400 log_info("Option %s: no category defined. Setting to misc\n", o->name);
1401 o->category = FIO_OPT_C_GENERAL;
1402 o->group = FIO_OPT_G_INVALID;
1403 }
1404}
1405
1406/*
1407 * Sanitize the options structure. For now it just sets min/max for bool
1408 * values and whether both callback and offsets are given.
1409 */
1410void options_init(struct fio_option *options)
1411{
1412 struct fio_option *o;
1413
1414 dprint(FD_PARSE, "init options\n");
1415
1416 for (o = &options[0]; o->name; o++) {
1417 option_init(o);
1418 if (o->inverse)
1419 o->inv_opt = find_option(options, o->inverse);
1420 }
1421}
1422
1423void options_mem_dupe(const struct fio_option *options, void *data)
1424{
1425 const struct fio_option *o;
1426 char **ptr;
1427
1428 dprint(FD_PARSE, "dup options\n");
1429
1430 for (o = &options[0]; o->name; o++) {
1431 if (o->type != FIO_OPT_STR_STORE)
1432 continue;
1433
1434 ptr = td_var(data, o, o->off1);
1435 if (*ptr)
1436 *ptr = strdup(*ptr);
1437 }
1438}
1439
1440void options_free(const struct fio_option *options, void *data)
1441{
1442 const struct fio_option *o;
1443 char **ptr;
1444
1445 dprint(FD_PARSE, "free options\n");
1446
1447 for (o = &options[0]; o->name; o++) {
1448 if (o->type != FIO_OPT_STR_STORE || !o->off1 || o->no_free)
1449 continue;
1450
1451 ptr = td_var(data, o, o->off1);
1452 if (*ptr) {
1453 free(*ptr);
1454 *ptr = NULL;
1455 }
1456 }
1457}