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