Remove comment wrt sigaction() usage, it's deprecated
[fio.git] / parse.c
CommitLineData
cb2c86fd
JA
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
12#include "parse.h"
a3d741fa 13#include "debug.h"
cb2c86fd 14
f085737f
JA
15static int vp_cmp(const void *p1, const void *p2)
16{
17 const struct value_pair *vp1 = p1;
18 const struct value_pair *vp2 = p2;
19
20 return strlen(vp2->ival) - strlen(vp1->ival);
21}
22
23static void posval_sort(struct fio_option *o, struct value_pair *vpmap)
24{
25 const struct value_pair *vp;
26 int entries;
27
28 memset(vpmap, 0, PARSE_MAX_VP * sizeof(struct value_pair));
29
30 for (entries = 0; entries < PARSE_MAX_VP; entries++) {
31 vp = &o->posval[entries];
32 if (!vp->ival || vp->ival[0] == '\0')
33 break;
34
35 memcpy(&vpmap[entries], vp, sizeof(*vp));
36 }
37
38 qsort(vpmap, entries, sizeof(struct value_pair), vp_cmp);
39}
40
b1ec1da6
JA
41static void show_option_range(struct fio_option *o)
42{
43 if (!o->minval && !o->maxval)
44 return;
45
ec1aee01 46 printf("%20s: min=%d, max=%d\n", "range", o->minval, o->maxval);
b1ec1da6
JA
47}
48
49static void show_option_values(struct fio_option *o)
50{
b1ec1da6
JA
51 int i = 0;
52
53 do {
7837213b 54 const struct value_pair *vp = &o->posval[i];
b1ec1da6 55
7837213b
JA
56 if (!vp->ival)
57 break;
b1ec1da6 58
7837213b
JA
59 printf("%20s: %-10s", i == 0 ? "valid values" : "", vp->ival);
60 if (vp->help)
61 printf(" %s", vp->help);
62 printf("\n");
b1ec1da6
JA
63 i++;
64 } while (i < PARSE_MAX_VP);
65
66 if (i)
67 printf("\n");
68}
69
cb2c86fd
JA
70static unsigned long get_mult_time(char c)
71{
72 switch (c) {
5ec10eaa
JA
73 case 'm':
74 case 'M':
75 return 60;
76 case 'h':
77 case 'H':
78 return 60 * 60;
79 case 'd':
80 case 'D':
81 return 24 * 60 * 60;
82 default:
83 return 1;
cb2c86fd
JA
84 }
85}
86
87static unsigned long get_mult_bytes(char c)
88{
89 switch (c) {
5ec10eaa
JA
90 case 'k':
91 case 'K':
92 return 1024;
93 case 'm':
94 case 'M':
95 return 1024 * 1024;
96 case 'g':
97 case 'G':
98 return 1024 * 1024 * 1024;
99 case 'e':
100 case 'E':
101 return 1024 * 1024 * 1024 * 1024UL;
102 default:
103 return 1;
cb2c86fd
JA
104 }
105}
106
107/*
e1f36503 108 * convert string into decimal value, noting any size suffix
cb2c86fd 109 */
564ca972 110int str_to_decimal(const char *str, long long *val, int kilo)
cb2c86fd 111{
cb2c86fd
JA
112 int len;
113
cb2c86fd 114 len = strlen(str);
f90eff5a
JA
115 if (!len)
116 return 1;
cb2c86fd 117
675de85a 118 *val = strtoll(str, NULL, 10);
cda866ca 119 if (*val == LONG_MAX && errno == ERANGE)
cb2c86fd
JA
120 return 1;
121
122 if (kilo)
123 *val *= get_mult_bytes(str[len - 1]);
124 else
125 *val *= get_mult_time(str[len - 1]);
787f7e95 126
cb2c86fd
JA
127 return 0;
128}
129
63f29372 130static int check_str_bytes(const char *p, long long *val)
cb2c86fd 131{
cb2c86fd
JA
132 return str_to_decimal(p, val, 1);
133}
134
63f29372 135static int check_str_time(const char *p, long long *val)
cb2c86fd 136{
cb2c86fd
JA
137 return str_to_decimal(p, val, 0);
138}
139
140void strip_blank_front(char **p)
141{
142 char *s = *p;
143
144 while (isspace(*s))
145 s++;
4d651dad
JA
146
147 *p = s;
cb2c86fd
JA
148}
149
150void strip_blank_end(char *p)
151{
523bfadb
JA
152 char *s;
153
154 s = strchr(p, ';');
155 if (s)
156 *s = '\0';
157 s = strchr(p, '#');
158 if (s)
159 *s = '\0';
160 if (s)
161 p = s;
162
7f7e6e59
JA
163 s = p + strlen(p);
164 while ((isspace(*s) || iscntrl(*s)) && (s > p))
cb2c86fd
JA
165 s--;
166
167 *(s + 1) = '\0';
168}
169
63f29372 170static int check_range_bytes(const char *str, long *val)
cb2c86fd
JA
171{
172 char suffix;
173
787f7e95
JA
174 if (!strlen(str))
175 return 1;
176
cb2c86fd
JA
177 if (sscanf(str, "%lu%c", val, &suffix) == 2) {
178 *val *= get_mult_bytes(suffix);
179 return 0;
180 }
181
182 if (sscanf(str, "%lu", val) == 1)
183 return 0;
184
185 return 1;
186}
187
63f29372 188static int check_int(const char *p, int *val)
cb2c86fd 189{
787f7e95
JA
190 if (!strlen(p))
191 return 1;
d78ee463 192 if (strstr(p, "0x") || strstr(p, "0X")) {
a61bdfd8
JA
193 if (sscanf(p, "%x", val) == 1)
194 return 0;
195 } else {
196 if (sscanf(p, "%u", val) == 1)
197 return 0;
198 }
cb2c86fd 199
e1f36503
JA
200 return 1;
201}
cb2c86fd 202
e1f36503
JA
203static struct fio_option *find_option(struct fio_option *options,
204 const char *opt)
205{
4945ba12 206 struct fio_option *o;
cb2c86fd 207
4945ba12 208 for (o = &options[0]; o->name; o++) {
e1f36503
JA
209 if (!strcmp(o->name, opt))
210 return o;
03b74b3e
JA
211 else if (o->alias && !strcmp(o->alias, opt))
212 return o;
33963c6c 213 }
cb2c86fd 214
e1f36503 215 return NULL;
cb2c86fd
JA
216}
217
17abbe89
JA
218#define val_store(ptr, val, off, data) \
219 do { \
220 ptr = td_var((data), (off)); \
221 *ptr = (val); \
222 } while (0)
223
f90eff5a 224static int __handle_option(struct fio_option *o, const char *ptr, void *data,
787f7e95 225 int first, int more)
cb2c86fd 226{
63f29372
JA
227 int il, *ilp;
228 long long ull, *ullp;
229 long ul1, ul2;
b4692828 230 char **cp;
e1f36503 231 int ret = 0, is_time = 0;
cb2c86fd 232
a3d741fa
JA
233 dprint(FD_PARSE, "__handle_option=%s, type=%d, ptr=%s\n", o->name,
234 o->type, ptr);
235
08e26e35
JA
236 if (!ptr && o->type != FIO_OPT_STR_SET) {
237 fprintf(stderr, "Option %s requires an argument\n", o->name);
238 return 1;
239 }
240
e1f36503
JA
241 switch (o->type) {
242 case FIO_OPT_STR: {
243 fio_opt_str_fn *fn = o->cb;
b1ec1da6 244 const struct value_pair *vp;
f085737f 245 struct value_pair posval[PARSE_MAX_VP];
b1ec1da6
JA
246 int i;
247
f085737f
JA
248 posval_sort(o, posval);
249
b1ec1da6 250 for (i = 0; i < PARSE_MAX_VP; i++) {
f085737f 251 vp = &posval[i];
b1ec1da6
JA
252 if (!vp->ival || vp->ival[0] == '\0')
253 break;
6612a27b 254 ret = 1;
b1ec1da6
JA
255 if (!strncmp(vp->ival, ptr, strlen(vp->ival))) {
256 ret = 0;
257 if (!o->off1)
258 break;
259 val_store(ilp, vp->oval, o->off1, data);
260 break;
261 }
262 }
cb2c86fd 263
b1ec1da6
JA
264 if (ret)
265 show_option_values(o);
266 else if (fn)
267 ret = fn(data, ptr);
e1f36503
JA
268 break;
269 }
270 case FIO_OPT_STR_VAL_TIME:
271 is_time = 1;
75e6f36f
JA
272 case FIO_OPT_STR_VAL:
273 case FIO_OPT_STR_VAL_INT: {
e1f36503
JA
274 fio_opt_str_val_fn *fn = o->cb;
275
276 if (is_time)
277 ret = check_str_time(ptr, &ull);
278 else
279 ret = check_str_bytes(ptr, &ull);
280
281 if (ret)
282 break;
283
db8e0165 284 if (o->maxval && ull > o->maxval) {
5ec10eaa
JA
285 fprintf(stderr, "max value out of range: %lld"
286 " (%d max)\n", ull, o->maxval);
db8e0165
JA
287 return 1;
288 }
289 if (o->minval && ull < o->minval) {
5ec10eaa
JA
290 fprintf(stderr, "min value out of range: %lld"
291 " (%d min)\n", ull, o->minval);
db8e0165
JA
292 return 1;
293 }
e1f36503
JA
294
295 if (fn)
296 ret = fn(data, &ull);
297 else {
75e6f36f 298 if (o->type == FIO_OPT_STR_VAL_INT) {
17abbe89
JA
299 if (first)
300 val_store(ilp, ull, o->off1, data);
787f7e95 301 if (!more && o->off2)
17abbe89 302 val_store(ilp, ull, o->off2, data);
75e6f36f 303 } else {
17abbe89
JA
304 if (first)
305 val_store(ullp, ull, o->off1, data);
787f7e95 306 if (!more && o->off2)
17abbe89 307 val_store(ullp, ull, o->off2, data);
75e6f36f 308 }
e1f36503
JA
309 }
310 break;
311 }
af52b345
JA
312 case FIO_OPT_STR_STORE: {
313 fio_opt_str_fn *fn = o->cb;
314
e1f36503
JA
315 cp = td_var(data, o->off1);
316 *cp = strdup(ptr);
af52b345
JA
317 if (fn) {
318 ret = fn(data, ptr);
319 if (ret) {
320 free(*cp);
321 *cp = NULL;
322 }
323 }
e1f36503 324 break;
af52b345 325 }
e1f36503 326 case FIO_OPT_RANGE: {
b765a372 327 char tmp[128];
e1f36503
JA
328 char *p1, *p2;
329
0bbab0e7 330 strncpy(tmp, ptr, sizeof(tmp) - 1);
b765a372
JA
331
332 p1 = strchr(tmp, '-');
e1f36503 333 if (!p1) {
0c9baf91
JA
334 p1 = strchr(tmp, ':');
335 if (!p1) {
336 ret = 1;
337 break;
338 }
e1f36503
JA
339 }
340
341 p2 = p1 + 1;
342 *p1 = '\0';
b765a372 343 p1 = tmp;
e1f36503
JA
344
345 ret = 1;
5ec10eaa
JA
346 if (!check_range_bytes(p1, &ul1) &&
347 !check_range_bytes(p2, &ul2)) {
e1f36503 348 ret = 0;
e1f36503 349 if (ul1 > ul2) {
f90eff5a
JA
350 unsigned long foo = ul1;
351
352 ul1 = ul2;
353 ul2 = foo;
354 }
355
356 if (first) {
17abbe89
JA
357 val_store(ilp, ul1, o->off1, data);
358 val_store(ilp, ul2, o->off2, data);
359 }
97e8cd44 360 if (o->off3 && o->off4) {
17abbe89
JA
361 val_store(ilp, ul1, o->off3, data);
362 val_store(ilp, ul2, o->off4, data);
e1f36503 363 }
17abbe89
JA
364 }
365
e1f36503
JA
366 break;
367 }
13335ddb
JA
368 case FIO_OPT_INT:
369 case FIO_OPT_BOOL: {
e1f36503
JA
370 fio_opt_int_fn *fn = o->cb;
371
372 ret = check_int(ptr, &il);
373 if (ret)
374 break;
375
db8e0165 376 if (o->maxval && il > (int) o->maxval) {
5ec10eaa
JA
377 fprintf(stderr, "max value out of range: %d (%d max)\n",
378 il, o->maxval);
db8e0165
JA
379 return 1;
380 }
381 if (o->minval && il < o->minval) {
5ec10eaa
JA
382 fprintf(stderr, "min value out of range: %d (%d min)\n",
383 il, o->minval);
db8e0165
JA
384 return 1;
385 }
e1f36503 386
76a43db4
JA
387 if (o->neg)
388 il = !il;
389
e1f36503
JA
390 if (fn)
391 ret = fn(data, &il);
392 else {
17abbe89
JA
393 if (first)
394 val_store(ilp, il, o->off1, data);
787f7e95 395 if (!more && o->off2)
17abbe89 396 val_store(ilp, il, o->off2, data);
e1f36503
JA
397 }
398 break;
399 }
400 case FIO_OPT_STR_SET: {
401 fio_opt_str_set_fn *fn = o->cb;
402
403 if (fn)
404 ret = fn(data);
405 else {
17abbe89
JA
406 if (first)
407 val_store(ilp, 1, o->off1, data);
787f7e95 408 if (!more && o->off2)
17abbe89 409 val_store(ilp, 1, o->off2, data);
e1f36503
JA
410 }
411 break;
412 }
15ca150e
JA
413 case FIO_OPT_DEPRECATED:
414 fprintf(stdout, "Option %s is deprecated\n", o->name);
415 break;
e1f36503 416 default:
1e97cce9 417 fprintf(stderr, "Bad option type %u\n", o->type);
e1f36503
JA
418 ret = 1;
419 }
cb2c86fd 420
e1f36503 421 return ret;
cb2c86fd
JA
422}
423
f90eff5a
JA
424static int handle_option(struct fio_option *o, const char *ptr, void *data)
425{
92b586f8 426 const char *ptr2 = NULL;
787f7e95 427 int r1, r2;
f90eff5a 428
a3d741fa
JA
429 dprint(FD_PARSE, "handle_option=%s, ptr=%s\n", o->name, ptr);
430
f90eff5a 431 /*
787f7e95
JA
432 * See if we have a second set of parameters, hidden after a comma.
433 * Do this before parsing the first round, to check if we should
434 * copy set 1 options to set 2.
f90eff5a 435 */
ad231bc4
JB
436 if (ptr &&
437 (o->type != FIO_OPT_STR_STORE) &&
438 (o->type != FIO_OPT_STR)) {
92b586f8 439 ptr2 = strchr(ptr, ',');
0c9baf91
JA
440 if (!ptr2)
441 ptr2 = strchr(ptr, ':');
b486f76a
JA
442 if (!ptr2)
443 ptr2 = strchr(ptr, '-');
0c9baf91 444 }
787f7e95
JA
445
446 /*
447 * Don't return early if parsing the first option fails - if
448 * we are doing multiple arguments, we can allow the first one
449 * being empty.
450 */
451 r1 = __handle_option(o, ptr, data, 1, !!ptr2);
452
f90eff5a 453 if (!ptr2)
787f7e95 454 return r1;
f90eff5a
JA
455
456 ptr2++;
787f7e95
JA
457 r2 = __handle_option(o, ptr2, data, 0, 0);
458
459 return r1 && r2;
f90eff5a
JA
460}
461
b4692828
JA
462int parse_cmd_option(const char *opt, const char *val,
463 struct fio_option *options, void *data)
464{
465 struct fio_option *o;
466
467 o = find_option(options, opt);
468 if (!o) {
469 fprintf(stderr, "Bad option %s\n", opt);
470 return 1;
471 }
472
b1508cf9
JA
473 if (!handle_option(o, val, data))
474 return 0;
475
476 fprintf(stderr, "fio: failed parsing %s=%s\n", opt, val);
477 return 1;
b4692828
JA
478}
479
e1f36503 480int parse_option(const char *opt, struct fio_option *options, void *data)
cb2c86fd 481{
b4692828 482 struct fio_option *o;
e1f36503 483 char *pre, *post;
0401bca6 484 char *tmp;
e1f36503 485
0401bca6 486 tmp = strdup(opt);
e1f36503
JA
487
488 pre = strchr(tmp, '=');
489 if (pre) {
490 post = pre;
491 *pre = '\0';
492 pre = tmp;
493 post++;
494 o = find_option(options, pre);
495 } else {
496 o = find_option(options, tmp);
497 post = NULL;
498 }
cb2c86fd 499
e1f36503
JA
500 if (!o) {
501 fprintf(stderr, "Bad option %s\n", tmp);
0401bca6 502 free(tmp);
e1f36503
JA
503 return 1;
504 }
505
0401bca6
JA
506 if (!handle_option(o, post, data)) {
507 free(tmp);
b1508cf9 508 return 0;
0401bca6 509 }
b1508cf9
JA
510
511 fprintf(stderr, "fio: failed parsing %s\n", opt);
0401bca6 512 free(tmp);
b1508cf9 513 return 1;
e1f36503 514}
fd28ca49 515
0e9f7fac
JA
516/*
517 * Option match, levenshtein distance. Handy for not quite remembering what
518 * the option name is.
519 */
520static int string_distance(const char *s1, const char *s2)
521{
522 unsigned int s1_len = strlen(s1);
523 unsigned int s2_len = strlen(s2);
524 unsigned int *p, *q, *r;
525 unsigned int i, j;
526
527 p = malloc(sizeof(unsigned int) * (s2_len + 1));
528 q = malloc(sizeof(unsigned int) * (s2_len + 1));
529
530 p[0] = 0;
531 for (i = 1; i <= s2_len; i++)
532 p[i] = p[i - 1] + 1;
533
534 for (i = 1; i <= s1_len; i++) {
535 q[0] = p[0] + 1;
536 for (j = 1; j <= s2_len; j++) {
537 unsigned int sub = p[j - 1];
538
539 if (s1[i - 1] != s2[j - 1])
540 sub++;
541
542 q[j] = min(p[j] + 1, min(q[j - 1] + 1, sub));
543 }
544 r = p;
545 p = q;
546 q = r;
547 }
548
549 i = p[s2_len];
550 free(p);
551 free(q);
552 return i;
553}
554
555static void show_option_help(struct fio_option *o)
fd28ca49 556{
fd28ca49
JA
557 const char *typehelp[] = {
558 "string (opt=bla)",
559 "string with possible k/m/g postfix (opt=4k)",
560 "string with range and postfix (opt=1k-4k)",
561 "string with time postfix (opt=10s)",
562 "string (opt=bla)",
563 "string with dual range (opt=1k-4k,4k-8k)",
564 "integer value (opt=100)",
13335ddb 565 "boolean value (opt=1)",
fd28ca49
JA
566 "no argument (opt)",
567 };
0e9f7fac 568
d2bb7fea
JA
569 if (o->alias)
570 printf("%20s: %s\n", "alias", o->alias);
571
0e9f7fac
JA
572 printf("%20s: %s\n", "type", typehelp[o->type]);
573 printf("%20s: %s\n", "default", o->def ? o->def : "no default");
574 show_option_range(o);
575 show_option_values(o);
576}
577
afdf9352
JA
578static struct fio_option *find_child(struct fio_option *options,
579 struct fio_option *o)
580{
581 struct fio_option *__o;
582
fdf28744
JA
583 for (__o = options + 1; __o->name; __o++)
584 if (__o->parent && !strcmp(__o->parent, o->name))
afdf9352
JA
585 return __o;
586
587 return NULL;
588}
589
323d9113
JA
590static void __print_option(struct fio_option *o, struct fio_option *org,
591 int level)
afdf9352
JA
592{
593 char name[256], *p;
323d9113 594 int depth;
afdf9352
JA
595
596 if (!o)
597 return;
ef9aff52
JA
598 if (!org)
599 org = o;
5ec10eaa 600
afdf9352 601 p = name;
323d9113
JA
602 depth = level;
603 while (depth--)
604 p += sprintf(p, "%s", " ");
afdf9352
JA
605
606 sprintf(p, "%s", o->name);
607
608 printf("%-24s: %s\n", name, o->help);
323d9113
JA
609}
610
611static void print_option(struct fio_option *o)
612{
613 struct fio_option *parent;
614 struct fio_option *__o;
615 unsigned int printed;
616 unsigned int level;
617
618 __print_option(o, NULL, 0);
619 parent = o;
620 level = 0;
621 do {
622 level++;
623 printed = 0;
624
625 while ((__o = find_child(o, parent)) != NULL) {
626 __print_option(__o, o, level);
627 o = __o;
628 printed++;
629 }
630
631 parent = o;
632 } while (printed);
afdf9352
JA
633}
634
0e9f7fac
JA
635int show_cmd_help(struct fio_option *options, const char *name)
636{
637 struct fio_option *o, *closest;
638 unsigned int best_dist;
29fc6afe 639 int found = 0;
320beefe
JA
640 int show_all = 0;
641
642 if (!name || !strcmp(name, "all"))
643 show_all = 1;
fd28ca49 644
0e9f7fac
JA
645 closest = NULL;
646 best_dist = -1;
4945ba12 647 for (o = &options[0]; o->name; o++) {
320beefe
JA
648 int match = 0;
649
15ca150e
JA
650 if (o->type == FIO_OPT_DEPRECATED)
651 continue;
652
0e9f7fac 653 if (name) {
7f9348f8
JA
654 if (!strcmp(name, o->name) ||
655 (o->alias && !strcmp(name, o->alias)))
0e9f7fac
JA
656 match = 1;
657 else {
658 unsigned int dist;
659
660 dist = string_distance(name, o->name);
661 if (dist < best_dist) {
662 best_dist = dist;
663 closest = o;
664 }
665 }
666 }
fd28ca49
JA
667
668 if (show_all || match) {
29fc6afe 669 found = 1;
c167dedc 670 if (match)
afdf9352 671 printf("%24s: %s\n", o->name, o->help);
c167dedc 672 if (show_all) {
afdf9352 673 if (!o->parent)
323d9113 674 print_option(o);
4945ba12 675 continue;
c167dedc 676 }
fd28ca49
JA
677 }
678
70df2f19
JA
679 if (!match)
680 continue;
681
0e9f7fac 682 show_option_help(o);
fd28ca49
JA
683 }
684
29fc6afe
JA
685 if (found)
686 return 0;
fd28ca49 687
0e9f7fac
JA
688 printf("No such command: %s", name);
689 if (closest) {
690 printf(" - showing closest match\n");
691 printf("%20s: %s\n", closest->name, closest->help);
692 show_option_help(closest);
693 } else
694 printf("\n");
695
29fc6afe 696 return 1;
fd28ca49 697}
ee738499 698
13335ddb
JA
699/*
700 * Handle parsing of default parameters.
701 */
ee738499
JA
702void fill_default_options(void *data, struct fio_option *options)
703{
4945ba12 704 struct fio_option *o;
ee738499 705
a3d741fa
JA
706 dprint(FD_PARSE, "filling default options\n");
707
4945ba12 708 for (o = &options[0]; o->name; o++)
ee738499
JA
709 if (o->def)
710 handle_option(o, o->def, data);
ee738499 711}
13335ddb
JA
712
713/*
714 * Sanitize the options structure. For now it just sets min/max for bool
5b0a8880 715 * values and whether both callback and offsets are given.
13335ddb
JA
716 */
717void options_init(struct fio_option *options)
718{
4945ba12 719 struct fio_option *o;
13335ddb 720
a3d741fa
JA
721 dprint(FD_PARSE, "init options\n");
722
4945ba12 723 for (o = &options[0]; o->name; o++) {
15ca150e
JA
724 if (o->type == FIO_OPT_DEPRECATED)
725 continue;
13335ddb
JA
726 if (o->type == FIO_OPT_BOOL) {
727 o->minval = 0;
728 o->maxval = 1;
729 }
5ec10eaa
JA
730 if (o->type == FIO_OPT_STR_SET && o->def) {
731 fprintf(stderr, "Option %s: string set option with"
732 " default will always be true\n",
733 o->name);
734 }
735 if (!o->cb && !o->off1) {
736 fprintf(stderr, "Option %s: neither cb nor offset"
737 " given\n", o->name);
738 }
af52b345 739 if (o->type == FIO_OPT_STR || o->type == FIO_OPT_STR_STORE)
b1ec1da6 740 continue;
5ec10eaa
JA
741 if (o->cb && (o->off1 || o->off2 || o->off3 || o->off4)) {
742 fprintf(stderr, "Option %s: both cb and offset given\n",
743 o->name);
744 }
13335ddb
JA
745 }
746}