Don't do rate checks, if no ratemin has been specified.
[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 if (!first)
201 break;
202
203 ret = 1;
204 for (i = 0; i < PARSE_MAX_VP; i++) {
205 vp = &o->posval[i];
206 if (!vp->ival || vp->ival[0] == '\0')
207 break;
208 if (!strncmp(vp->ival, ptr, strlen(vp->ival))) {
209 ret = 0;
210 if (!o->off1)
211 break;
212 val_store(ilp, vp->oval, o->off1, data);
213 break;
214 }
215 }
216
217 if (ret)
218 show_option_values(o);
219 else if (fn)
220 ret = fn(data, ptr);
221 break;
222 }
223 case FIO_OPT_STR_VAL_TIME:
224 is_time = 1;
225 case FIO_OPT_STR_VAL:
226 case FIO_OPT_STR_VAL_INT: {
227 fio_opt_str_val_fn *fn = o->cb;
228
229 if (is_time)
230 ret = check_str_time(ptr, &ull);
231 else
232 ret = check_str_bytes(ptr, &ull);
233
234 if (ret)
235 break;
236
237 if (o->maxval && ull > o->maxval) {
238 fprintf(stderr, "max value out of range: %lld (%d max)\n", ull, o->maxval);
239 return 1;
240 }
241 if (o->minval && ull < o->minval) {
242 fprintf(stderr, "min value out of range: %lld (%d min)\n", ull, o->minval);
243 return 1;
244 }
245
246 if (fn)
247 ret = fn(data, &ull);
248 else {
249 if (o->type == FIO_OPT_STR_VAL_INT) {
250 if (first)
251 val_store(ilp, ull, o->off1, data);
252 if (!more && o->off2)
253 val_store(ilp, ull, o->off2, data);
254 } else {
255 if (first)
256 val_store(ullp, ull, o->off1, data);
257 if (!more && o->off2)
258 val_store(ullp, ull, o->off2, data);
259 }
260 }
261 break;
262 }
263 case FIO_OPT_STR_STORE:
264 cp = td_var(data, o->off1);
265 *cp = strdup(ptr);
266 break;
267 case FIO_OPT_RANGE: {
268 char tmp[128];
269 char *p1, *p2;
270
271 strncpy(tmp, ptr, sizeof(tmp) - 1);
272
273 p1 = strchr(tmp, '-');
274 if (!p1) {
275 p1 = strchr(tmp, ':');
276 if (!p1) {
277 ret = 1;
278 break;
279 }
280 }
281
282 p2 = p1 + 1;
283 *p1 = '\0';
284 p1 = tmp;
285
286 ret = 1;
287 if (!check_range_bytes(p1, &ul1) && !check_range_bytes(p2, &ul2)) {
288 ret = 0;
289 if (ul1 > ul2) {
290 unsigned long foo = ul1;
291
292 ul1 = ul2;
293 ul2 = foo;
294 }
295
296 if (first) {
297 val_store(ilp, ul1, o->off1, data);
298 val_store(ilp, ul2, o->off2, data);
299 }
300 if (!more && o->off3 && o->off4) {
301 val_store(ilp, ul1, o->off3, data);
302 val_store(ilp, ul2, o->off4, data);
303 }
304 }
305
306 break;
307 }
308 case FIO_OPT_INT:
309 case FIO_OPT_BOOL: {
310 fio_opt_int_fn *fn = o->cb;
311
312 ret = check_int(ptr, &il);
313 if (ret)
314 break;
315
316 if (o->maxval && il > (int) o->maxval) {
317 fprintf(stderr, "max value out of range: %d (%d max)\n", il, o->maxval);
318 return 1;
319 }
320 if (o->minval && il < o->minval) {
321 fprintf(stderr, "min value out of range: %d (%d min)\n", il, o->minval);
322 return 1;
323 }
324
325 if (o->neg)
326 il = !il;
327
328 if (fn)
329 ret = fn(data, &il);
330 else {
331 if (first)
332 val_store(ilp, il, o->off1, data);
333 if (!more && o->off2)
334 val_store(ilp, il, o->off2, data);
335 }
336 break;
337 }
338 case FIO_OPT_STR_SET: {
339 fio_opt_str_set_fn *fn = o->cb;
340
341 if (fn)
342 ret = fn(data);
343 else {
344 if (first)
345 val_store(ilp, 1, o->off1, data);
346 if (!more && o->off2)
347 val_store(ilp, 1, o->off2, data);
348 }
349 break;
350 }
351 default:
352 fprintf(stderr, "Bad option type %u\n", o->type);
353 ret = 1;
354 }
355
356 return ret;
357}
358
359static int handle_option(struct fio_option *o, const char *ptr, void *data)
360{
361 const char *ptr2 = NULL;
362 int r1, r2;
363
364 /*
365 * See if we have a second set of parameters, hidden after a comma.
366 * Do this before parsing the first round, to check if we should
367 * copy set 1 options to set 2.
368 */
369 if (ptr && (o->type != FIO_OPT_STR_STORE)) {
370 ptr2 = strchr(ptr, ',');
371 if (!ptr2)
372 ptr2 = strchr(ptr, ':');
373 }
374
375 /*
376 * Don't return early if parsing the first option fails - if
377 * we are doing multiple arguments, we can allow the first one
378 * being empty.
379 */
380 r1 = __handle_option(o, ptr, data, 1, !!ptr2);
381
382 if (!ptr2)
383 return r1;
384
385 ptr2++;
386 r2 = __handle_option(o, ptr2, data, 0, 0);
387
388 return r1 && r2;
389}
390
391int parse_cmd_option(const char *opt, const char *val,
392 struct fio_option *options, void *data)
393{
394 struct fio_option *o;
395
396 o = find_option(options, opt);
397 if (!o) {
398 fprintf(stderr, "Bad option %s\n", opt);
399 return 1;
400 }
401
402 if (!handle_option(o, val, data))
403 return 0;
404
405 fprintf(stderr, "fio: failed parsing %s=%s\n", opt, val);
406 return 1;
407}
408
409int parse_option(const char *opt, struct fio_option *options, void *data)
410{
411 struct fio_option *o;
412 char *pre, *post;
413 char tmp[64];
414
415 strncpy(tmp, opt, sizeof(tmp) - 1);
416
417 pre = strchr(tmp, '=');
418 if (pre) {
419 post = pre;
420 *pre = '\0';
421 pre = tmp;
422 post++;
423 o = find_option(options, pre);
424 } else {
425 o = find_option(options, tmp);
426 post = NULL;
427 }
428
429 if (!o) {
430 fprintf(stderr, "Bad option %s\n", tmp);
431 return 1;
432 }
433
434 if (!handle_option(o, post, data))
435 return 0;
436
437 fprintf(stderr, "fio: failed parsing %s\n", opt);
438 return 1;
439}
440
441int show_cmd_help(struct fio_option *options, const char *name)
442{
443 int show_all = !strcmp(name, "all");
444 const char *typehelp[] = {
445 "string (opt=bla)",
446 "string with possible k/m/g postfix (opt=4k)",
447 "string with range and postfix (opt=1k-4k)",
448 "string with time postfix (opt=10s)",
449 "string (opt=bla)",
450 "string with dual range (opt=1k-4k,4k-8k)",
451 "integer value (opt=100)",
452 "boolean value (opt=1)",
453 "no argument (opt)",
454 };
455 struct fio_option *o;
456 int found = 0;
457
458 for (o = &options[0]; o->name; o++) {
459 int match = !strcmp(name, o->name);
460
461 if (show_all || match) {
462 found = 1;
463 printf("%20s: %s\n", o->name, o->help);
464 if (show_all)
465 continue;
466 }
467
468 if (!match)
469 continue;
470
471 printf("%20s: %s\n", "type", typehelp[o->type]);
472 printf("%20s: %s\n", "default", o->def ? o->def : "no default");
473 show_option_range(o);
474 show_option_values(o);
475 }
476
477 if (found)
478 return 0;
479
480 printf("No such command: %s\n", name);
481 return 1;
482}
483
484/*
485 * Handle parsing of default parameters.
486 */
487void fill_default_options(void *data, struct fio_option *options)
488{
489 struct fio_option *o;
490
491 for (o = &options[0]; o->name; o++)
492 if (o->def)
493 handle_option(o, o->def, data);
494}
495
496/*
497 * Sanitize the options structure. For now it just sets min/max for bool
498 * values and whether both callback and offsets are given.
499 */
500void options_init(struct fio_option *options)
501{
502 struct fio_option *o;
503
504 for (o = &options[0]; o->name; o++) {
505 if (o->type == FIO_OPT_BOOL) {
506 o->minval = 0;
507 o->maxval = 1;
508 }
509 if (!o->cb && !o->off1)
510 fprintf(stderr, "Option %s: neither cb nor offset given\n", o->name);
511 if (o->type == FIO_OPT_STR)
512 continue;
513 if (o->cb && (o->off1 || o->off2 || o->off3 || o->off4))
514 fprintf(stderr, "Option %s: both cb and offset given\n", o->name);
515 }
516}