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