[PATCH] Introduce bool option type
[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"
13
14static unsigned long get_mult_time(char c)
15{
16 switch (c) {
17 case 'm':
18 case 'M':
19 return 60;
20 case 'h':
21 case 'H':
22 return 60 * 60;
23 case 'd':
24 case 'D':
25 return 24 * 60 * 60;
26 default:
27 return 1;
28 }
29}
30
31static unsigned long get_mult_bytes(char c)
32{
33 switch (c) {
34 case 'k':
35 case 'K':
36 return 1024;
37 case 'm':
38 case 'M':
39 return 1024 * 1024;
40 case 'g':
41 case 'G':
42 return 1024 * 1024 * 1024;
43 default:
44 return 1;
45 }
46}
47
48/*
e1f36503 49 * convert string into decimal value, noting any size suffix
cb2c86fd 50 */
b4692828 51static int str_to_decimal(const char *str, unsigned long long *val, int kilo)
cb2c86fd 52{
cb2c86fd
JA
53 int len;
54
cb2c86fd 55 len = strlen(str);
f90eff5a
JA
56 if (!len)
57 return 1;
cb2c86fd
JA
58
59 *val = strtoul(str, NULL, 10);
60 if (*val == ULONG_MAX && errno == ERANGE)
61 return 1;
62
63 if (kilo)
64 *val *= get_mult_bytes(str[len - 1]);
65 else
66 *val *= get_mult_time(str[len - 1]);
787f7e95 67
cb2c86fd
JA
68 return 0;
69}
70
b4692828 71static int check_str_bytes(const char *p, unsigned long long *val)
cb2c86fd 72{
cb2c86fd
JA
73 return str_to_decimal(p, val, 1);
74}
75
b4692828 76static int check_str_time(const char *p, unsigned long long *val)
cb2c86fd 77{
cb2c86fd
JA
78 return str_to_decimal(p, val, 0);
79}
80
81void strip_blank_front(char **p)
82{
83 char *s = *p;
84
85 while (isspace(*s))
86 s++;
87}
88
89void strip_blank_end(char *p)
90{
91 char *s = p + strlen(p) - 1;
92
93 while (isspace(*s) || iscntrl(*s))
94 s--;
95
96 *(s + 1) = '\0';
97}
98
b765a372 99static int check_range_bytes(const char *str, unsigned long *val)
cb2c86fd
JA
100{
101 char suffix;
102
787f7e95
JA
103 if (!strlen(str))
104 return 1;
105
cb2c86fd
JA
106 if (sscanf(str, "%lu%c", val, &suffix) == 2) {
107 *val *= get_mult_bytes(suffix);
108 return 0;
109 }
110
111 if (sscanf(str, "%lu", val) == 1)
112 return 0;
113
114 return 1;
115}
116
b4692828 117static int check_int(const char *p, unsigned int *val)
cb2c86fd 118{
787f7e95
JA
119 if (!strlen(p))
120 return 1;
e1f36503
JA
121 if (sscanf(p, "%u", val) == 1)
122 return 0;
cb2c86fd 123
e1f36503
JA
124 return 1;
125}
cb2c86fd 126
e1f36503
JA
127static struct fio_option *find_option(struct fio_option *options,
128 const char *opt)
129{
33963c6c 130 struct fio_option *o = &options[0];
cb2c86fd 131
33963c6c 132 while (o->name) {
e1f36503
JA
133 if (!strcmp(o->name, opt))
134 return o;
cb2c86fd 135
33963c6c
JA
136 o++;
137 }
cb2c86fd 138
e1f36503 139 return NULL;
cb2c86fd
JA
140}
141
17abbe89
JA
142#define val_store(ptr, val, off, data) \
143 do { \
144 ptr = td_var((data), (off)); \
145 *ptr = (val); \
146 } while (0)
147
f90eff5a 148static int __handle_option(struct fio_option *o, const char *ptr, void *data,
787f7e95 149 int first, int more)
cb2c86fd 150{
17abbe89 151 unsigned int il, *ilp;
e1f36503 152 unsigned long long ull, *ullp;
75e6f36f 153 unsigned long ul1, ul2;
b4692828 154 char **cp;
e1f36503 155 int ret = 0, is_time = 0;
cb2c86fd 156
08e26e35
JA
157 if (!ptr && o->type != FIO_OPT_STR_SET) {
158 fprintf(stderr, "Option %s requires an argument\n", o->name);
159 return 1;
160 }
161
e1f36503
JA
162 switch (o->type) {
163 case FIO_OPT_STR: {
164 fio_opt_str_fn *fn = o->cb;
cb2c86fd 165
e1f36503
JA
166 ret = fn(data, ptr);
167 break;
168 }
169 case FIO_OPT_STR_VAL_TIME:
170 is_time = 1;
75e6f36f
JA
171 case FIO_OPT_STR_VAL:
172 case FIO_OPT_STR_VAL_INT: {
e1f36503
JA
173 fio_opt_str_val_fn *fn = o->cb;
174
175 if (is_time)
176 ret = check_str_time(ptr, &ull);
177 else
178 ret = check_str_bytes(ptr, &ull);
179
180 if (ret)
181 break;
182
ee738499
JA
183 if (o->maxval && ull > o->maxval)
184 ull = o->maxval;
185 if (o->minval && ull < o->minval)
186 ull = o->minval;
e1f36503
JA
187
188 if (fn)
189 ret = fn(data, &ull);
190 else {
75e6f36f 191 if (o->type == FIO_OPT_STR_VAL_INT) {
17abbe89
JA
192 if (first)
193 val_store(ilp, ull, o->off1, data);
787f7e95 194 if (!more && o->off2)
17abbe89 195 val_store(ilp, ull, o->off2, data);
75e6f36f 196 } else {
17abbe89
JA
197 if (first)
198 val_store(ullp, ull, o->off1, data);
787f7e95 199 if (!more && o->off2)
17abbe89 200 val_store(ullp, ull, o->off2, data);
75e6f36f 201 }
e1f36503
JA
202 }
203 break;
204 }
205 case FIO_OPT_STR_STORE:
206 cp = td_var(data, o->off1);
207 *cp = strdup(ptr);
208 break;
209 case FIO_OPT_RANGE: {
b765a372 210 char tmp[128];
e1f36503
JA
211 char *p1, *p2;
212
0bbab0e7 213 strncpy(tmp, ptr, sizeof(tmp) - 1);
b765a372
JA
214
215 p1 = strchr(tmp, '-');
e1f36503
JA
216 if (!p1) {
217 ret = 1;
218 break;
219 }
220
221 p2 = p1 + 1;
222 *p1 = '\0';
b765a372 223 p1 = tmp;
e1f36503
JA
224
225 ret = 1;
226 if (!check_range_bytes(p1, &ul1) && !check_range_bytes(p2, &ul2)) {
227 ret = 0;
e1f36503 228 if (ul1 > ul2) {
f90eff5a
JA
229 unsigned long foo = ul1;
230
231 ul1 = ul2;
232 ul2 = foo;
233 }
234
235 if (first) {
17abbe89
JA
236 val_store(ilp, ul1, o->off1, data);
237 val_store(ilp, ul2, o->off2, data);
238 }
787f7e95 239 if (!more && o->off3 && o->off4) {
17abbe89
JA
240 val_store(ilp, ul1, o->off3, data);
241 val_store(ilp, ul2, o->off4, data);
e1f36503 242 }
17abbe89
JA
243 }
244
e1f36503
JA
245 break;
246 }
13335ddb
JA
247 case FIO_OPT_INT:
248 case FIO_OPT_BOOL: {
e1f36503
JA
249 fio_opt_int_fn *fn = o->cb;
250
251 ret = check_int(ptr, &il);
252 if (ret)
253 break;
254
ee738499
JA
255 if (o->maxval && il > o->maxval)
256 il = o->maxval;
257 if (o->minval && il < o->minval)
258 il = o->minval;
e1f36503
JA
259
260 if (fn)
261 ret = fn(data, &il);
262 else {
17abbe89
JA
263 if (first)
264 val_store(ilp, il, o->off1, data);
787f7e95 265 if (!more && o->off2)
17abbe89 266 val_store(ilp, il, o->off2, data);
e1f36503
JA
267 }
268 break;
269 }
270 case FIO_OPT_STR_SET: {
271 fio_opt_str_set_fn *fn = o->cb;
272
273 if (fn)
274 ret = fn(data);
275 else {
17abbe89
JA
276 if (first)
277 val_store(ilp, 1, o->off1, data);
787f7e95 278 if (!more && o->off2)
17abbe89 279 val_store(ilp, 1, o->off2, data);
e1f36503
JA
280 }
281 break;
282 }
283 default:
1e97cce9 284 fprintf(stderr, "Bad option type %u\n", o->type);
e1f36503
JA
285 ret = 1;
286 }
cb2c86fd 287
e1f36503 288 return ret;
cb2c86fd
JA
289}
290
f90eff5a
JA
291static int handle_option(struct fio_option *o, const char *ptr, void *data)
292{
92b586f8 293 const char *ptr2 = NULL;
787f7e95 294 int r1, r2;
f90eff5a
JA
295
296 /*
787f7e95
JA
297 * See if we have a second set of parameters, hidden after a comma.
298 * Do this before parsing the first round, to check if we should
299 * copy set 1 options to set 2.
f90eff5a 300 */
92b586f8
JA
301 if (ptr)
302 ptr2 = strchr(ptr, ',');
787f7e95
JA
303
304 /*
305 * Don't return early if parsing the first option fails - if
306 * we are doing multiple arguments, we can allow the first one
307 * being empty.
308 */
309 r1 = __handle_option(o, ptr, data, 1, !!ptr2);
310
f90eff5a 311 if (!ptr2)
787f7e95 312 return r1;
f90eff5a
JA
313
314 ptr2++;
787f7e95
JA
315 r2 = __handle_option(o, ptr2, data, 0, 0);
316
317 return r1 && r2;
f90eff5a
JA
318}
319
b4692828
JA
320int parse_cmd_option(const char *opt, const char *val,
321 struct fio_option *options, void *data)
322{
323 struct fio_option *o;
324
325 o = find_option(options, opt);
326 if (!o) {
327 fprintf(stderr, "Bad option %s\n", opt);
328 return 1;
329 }
330
b1508cf9
JA
331 if (!handle_option(o, val, data))
332 return 0;
333
334 fprintf(stderr, "fio: failed parsing %s=%s\n", opt, val);
335 return 1;
b4692828
JA
336}
337
e1f36503 338int parse_option(const char *opt, struct fio_option *options, void *data)
cb2c86fd 339{
b4692828 340 struct fio_option *o;
e1f36503
JA
341 char *pre, *post;
342 char tmp[64];
343
0bbab0e7 344 strncpy(tmp, opt, sizeof(tmp) - 1);
e1f36503
JA
345
346 pre = strchr(tmp, '=');
347 if (pre) {
348 post = pre;
349 *pre = '\0';
350 pre = tmp;
351 post++;
352 o = find_option(options, pre);
353 } else {
354 o = find_option(options, tmp);
355 post = NULL;
356 }
cb2c86fd 357
e1f36503
JA
358 if (!o) {
359 fprintf(stderr, "Bad option %s\n", tmp);
360 return 1;
361 }
362
b1508cf9
JA
363 if (!handle_option(o, post, data))
364 return 0;
365
366 fprintf(stderr, "fio: failed parsing %s\n", opt);
367 return 1;
e1f36503 368}
fd28ca49 369
15f7918f
JA
370static void show_option_range(struct fio_option *o)
371{
372 if (!o->minval && !o->maxval)
373 return;
374
375 printf("%16s: min=%d, max=%d\n", "range", o->minval, o->maxval);
376}
377
378static void show_option_values(struct fio_option *o)
379{
380 const char *msg;
381 int i = 0;
382
383 if (!o->posval)
384 return;
385
386 do {
387 msg = o->posval[i];
388 if (!msg)
389 break;
390
391 if (!i)
392 printf("%16s: ", "valid values");
393
394 printf("%s,", msg);
395 i++;
396 } while (1);
397
398 if (i)
399 printf("\n");
400}
401
fd28ca49
JA
402int show_cmd_help(struct fio_option *options, const char *name)
403{
404 int show_all = !strcmp(name, "all");
405 struct fio_option *o = &options[0];
406 const char *typehelp[] = {
407 "string (opt=bla)",
408 "string with possible k/m/g postfix (opt=4k)",
409 "string with range and postfix (opt=1k-4k)",
410 "string with time postfix (opt=10s)",
411 "string (opt=bla)",
412 "string with dual range (opt=1k-4k,4k-8k)",
413 "integer value (opt=100)",
13335ddb 414 "boolean value (opt=1)",
fd28ca49
JA
415 "no argument (opt)",
416 };
29fc6afe 417 int found = 0;
fd28ca49
JA
418
419 while (o->name) {
420 int match = !strcmp(name, o->name);
421
422 if (show_all || match) {
29fc6afe 423 found = 1;
facba0e5 424 printf("%16s: %s\n", o->name, o->help);
ee738499 425 if (match) {
facba0e5
JA
426 printf("%16s: %s\n", "type", typehelp[o->type]);
427 printf("%16s: %s\n", "default", o->def ? o->def : "no default");
15f7918f
JA
428 show_option_range(o);
429 show_option_values(o);
ee738499 430 }
fd28ca49
JA
431 }
432
433 o++;
434 }
435
29fc6afe
JA
436 if (found)
437 return 0;
fd28ca49 438
29fc6afe
JA
439 printf("No such command: %s\n", name);
440 return 1;
fd28ca49 441}
ee738499 442
13335ddb
JA
443/*
444 * Handle parsing of default parameters.
445 */
ee738499
JA
446void fill_default_options(void *data, struct fio_option *options)
447{
448 struct fio_option *o = &options[0];
449
450 while (o->name) {
451 if (o->def)
452 handle_option(o, o->def, data);
453 o++;
454 }
455}
13335ddb
JA
456
457/*
458 * Sanitize the options structure. For now it just sets min/max for bool
459 * values.
460 */
461void options_init(struct fio_option *options)
462{
463 struct fio_option *o = &options[0];
464
465 while (o->name) {
466 if (o->type == FIO_OPT_BOOL) {
467 o->minval = 0;
468 o->maxval = 1;
469 }
470 o++;
471 }
472}