[PATCH] Add 'description' option
[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 */
63f29372 51static int str_to_decimal(const char *str, 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 58
cda866ca
JA
59 *val = strtol(str, NULL, 10);
60 if (*val == LONG_MAX && errno == ERANGE)
cb2c86fd
JA
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
63f29372 71static int check_str_bytes(const char *p, long long *val)
cb2c86fd 72{
cb2c86fd
JA
73 return str_to_decimal(p, val, 1);
74}
75
63f29372 76static int check_str_time(const char *p, 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
63f29372 99static int check_range_bytes(const char *str, 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
63f29372 117static int check_int(const char *p, 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{
4945ba12 130 struct fio_option *o;
cb2c86fd 131
4945ba12 132 for (o = &options[0]; o->name; o++) {
e1f36503
JA
133 if (!strcmp(o->name, opt))
134 return o;
03b74b3e
JA
135 else if (o->alias && !strcmp(o->alias, opt))
136 return o;
33963c6c 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{
63f29372
JA
151 int il, *ilp;
152 long long ull, *ullp;
153 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
db8e0165
JA
183 if (o->maxval && ull > o->maxval) {
184 fprintf(stderr, "max value out of range: %lld (%d max)\n", ull, o->maxval);
185 return 1;
186 }
187 if (o->minval && ull < o->minval) {
188 fprintf(stderr, "min value out of range: %lld (%d min)\n", ull, o->minval);
189 return 1;
190 }
e1f36503
JA
191
192 if (fn)
193 ret = fn(data, &ull);
194 else {
75e6f36f 195 if (o->type == FIO_OPT_STR_VAL_INT) {
17abbe89
JA
196 if (first)
197 val_store(ilp, ull, o->off1, data);
787f7e95 198 if (!more && o->off2)
17abbe89 199 val_store(ilp, ull, o->off2, data);
75e6f36f 200 } else {
17abbe89
JA
201 if (first)
202 val_store(ullp, ull, o->off1, data);
787f7e95 203 if (!more && o->off2)
17abbe89 204 val_store(ullp, ull, o->off2, data);
75e6f36f 205 }
e1f36503
JA
206 }
207 break;
208 }
209 case FIO_OPT_STR_STORE:
210 cp = td_var(data, o->off1);
211 *cp = strdup(ptr);
212 break;
213 case FIO_OPT_RANGE: {
b765a372 214 char tmp[128];
e1f36503
JA
215 char *p1, *p2;
216
0bbab0e7 217 strncpy(tmp, ptr, sizeof(tmp) - 1);
b765a372
JA
218
219 p1 = strchr(tmp, '-');
e1f36503 220 if (!p1) {
0c9baf91
JA
221 p1 = strchr(tmp, ':');
222 if (!p1) {
223 ret = 1;
224 break;
225 }
e1f36503
JA
226 }
227
228 p2 = p1 + 1;
229 *p1 = '\0';
b765a372 230 p1 = tmp;
e1f36503
JA
231
232 ret = 1;
233 if (!check_range_bytes(p1, &ul1) && !check_range_bytes(p2, &ul2)) {
234 ret = 0;
e1f36503 235 if (ul1 > ul2) {
f90eff5a
JA
236 unsigned long foo = ul1;
237
238 ul1 = ul2;
239 ul2 = foo;
240 }
241
242 if (first) {
17abbe89
JA
243 val_store(ilp, ul1, o->off1, data);
244 val_store(ilp, ul2, o->off2, data);
245 }
787f7e95 246 if (!more && o->off3 && o->off4) {
17abbe89
JA
247 val_store(ilp, ul1, o->off3, data);
248 val_store(ilp, ul2, o->off4, data);
e1f36503 249 }
17abbe89
JA
250 }
251
e1f36503
JA
252 break;
253 }
13335ddb
JA
254 case FIO_OPT_INT:
255 case FIO_OPT_BOOL: {
e1f36503
JA
256 fio_opt_int_fn *fn = o->cb;
257
258 ret = check_int(ptr, &il);
259 if (ret)
260 break;
261
db8e0165
JA
262 if (o->maxval && il > (int) o->maxval) {
263 fprintf(stderr, "max value out of range: %d (%d max)\n", il, o->maxval);
264 return 1;
265 }
266 if (o->minval && il < o->minval) {
267 fprintf(stderr, "min value out of range: %d (%d min)\n", il, o->minval);
268 return 1;
269 }
e1f36503 270
76a43db4
JA
271 if (o->neg)
272 il = !il;
273
e1f36503
JA
274 if (fn)
275 ret = fn(data, &il);
276 else {
17abbe89
JA
277 if (first)
278 val_store(ilp, il, o->off1, data);
787f7e95 279 if (!more && o->off2)
17abbe89 280 val_store(ilp, il, o->off2, data);
e1f36503
JA
281 }
282 break;
283 }
284 case FIO_OPT_STR_SET: {
285 fio_opt_str_set_fn *fn = o->cb;
286
287 if (fn)
288 ret = fn(data);
289 else {
17abbe89
JA
290 if (first)
291 val_store(ilp, 1, o->off1, data);
787f7e95 292 if (!more && o->off2)
17abbe89 293 val_store(ilp, 1, o->off2, data);
e1f36503
JA
294 }
295 break;
296 }
297 default:
1e97cce9 298 fprintf(stderr, "Bad option type %u\n", o->type);
e1f36503
JA
299 ret = 1;
300 }
cb2c86fd 301
e1f36503 302 return ret;
cb2c86fd
JA
303}
304
f90eff5a
JA
305static int handle_option(struct fio_option *o, const char *ptr, void *data)
306{
92b586f8 307 const char *ptr2 = NULL;
787f7e95 308 int r1, r2;
f90eff5a
JA
309
310 /*
787f7e95
JA
311 * See if we have a second set of parameters, hidden after a comma.
312 * Do this before parsing the first round, to check if we should
313 * copy set 1 options to set 2.
f90eff5a 314 */
0c9baf91 315 if (ptr) {
92b586f8 316 ptr2 = strchr(ptr, ',');
0c9baf91
JA
317 if (!ptr2)
318 ptr2 = strchr(ptr, ':');
319 }
787f7e95
JA
320
321 /*
322 * Don't return early if parsing the first option fails - if
323 * we are doing multiple arguments, we can allow the first one
324 * being empty.
325 */
326 r1 = __handle_option(o, ptr, data, 1, !!ptr2);
327
f90eff5a 328 if (!ptr2)
787f7e95 329 return r1;
f90eff5a
JA
330
331 ptr2++;
787f7e95
JA
332 r2 = __handle_option(o, ptr2, data, 0, 0);
333
334 return r1 && r2;
f90eff5a
JA
335}
336
b4692828
JA
337int parse_cmd_option(const char *opt, const char *val,
338 struct fio_option *options, void *data)
339{
340 struct fio_option *o;
341
342 o = find_option(options, opt);
343 if (!o) {
344 fprintf(stderr, "Bad option %s\n", opt);
345 return 1;
346 }
347
b1508cf9
JA
348 if (!handle_option(o, val, data))
349 return 0;
350
351 fprintf(stderr, "fio: failed parsing %s=%s\n", opt, val);
352 return 1;
b4692828
JA
353}
354
e1f36503 355int parse_option(const char *opt, struct fio_option *options, void *data)
cb2c86fd 356{
b4692828 357 struct fio_option *o;
e1f36503
JA
358 char *pre, *post;
359 char tmp[64];
360
0bbab0e7 361 strncpy(tmp, opt, sizeof(tmp) - 1);
e1f36503
JA
362
363 pre = strchr(tmp, '=');
364 if (pre) {
365 post = pre;
366 *pre = '\0';
367 pre = tmp;
368 post++;
369 o = find_option(options, pre);
370 } else {
371 o = find_option(options, tmp);
372 post = NULL;
373 }
cb2c86fd 374
e1f36503
JA
375 if (!o) {
376 fprintf(stderr, "Bad option %s\n", tmp);
377 return 1;
378 }
379
b1508cf9
JA
380 if (!handle_option(o, post, data))
381 return 0;
382
383 fprintf(stderr, "fio: failed parsing %s\n", opt);
384 return 1;
e1f36503 385}
fd28ca49 386
15f7918f
JA
387static void show_option_range(struct fio_option *o)
388{
389 if (!o->minval && !o->maxval)
390 return;
391
392 printf("%16s: min=%d, max=%d\n", "range", o->minval, o->maxval);
393}
394
395static void show_option_values(struct fio_option *o)
396{
397 const char *msg;
398 int i = 0;
399
400 if (!o->posval)
401 return;
402
403 do {
404 msg = o->posval[i];
405 if (!msg)
406 break;
407
408 if (!i)
409 printf("%16s: ", "valid values");
410
411 printf("%s,", msg);
412 i++;
413 } while (1);
414
415 if (i)
416 printf("\n");
417}
418
fd28ca49
JA
419int show_cmd_help(struct fio_option *options, const char *name)
420{
421 int show_all = !strcmp(name, "all");
fd28ca49
JA
422 const char *typehelp[] = {
423 "string (opt=bla)",
424 "string with possible k/m/g postfix (opt=4k)",
425 "string with range and postfix (opt=1k-4k)",
426 "string with time postfix (opt=10s)",
427 "string (opt=bla)",
428 "string with dual range (opt=1k-4k,4k-8k)",
429 "integer value (opt=100)",
13335ddb 430 "boolean value (opt=1)",
fd28ca49
JA
431 "no argument (opt)",
432 };
4945ba12 433 struct fio_option *o;
29fc6afe 434 int found = 0;
fd28ca49 435
4945ba12 436 for (o = &options[0]; o->name; o++) {
fd28ca49
JA
437 int match = !strcmp(name, o->name);
438
439 if (show_all || match) {
29fc6afe 440 found = 1;
facba0e5 441 printf("%16s: %s\n", o->name, o->help);
4945ba12
JA
442 if (show_all)
443 continue;
fd28ca49
JA
444 }
445
70df2f19
JA
446 if (!match)
447 continue;
448
4945ba12
JA
449 printf("%16s: %s\n", "type", typehelp[o->type]);
450 printf("%16s: %s\n", "default", o->def ? o->def : "no default");
451 show_option_range(o);
452 show_option_values(o);
fd28ca49
JA
453 }
454
29fc6afe
JA
455 if (found)
456 return 0;
fd28ca49 457
29fc6afe
JA
458 printf("No such command: %s\n", name);
459 return 1;
fd28ca49 460}
ee738499 461
13335ddb
JA
462/*
463 * Handle parsing of default parameters.
464 */
ee738499
JA
465void fill_default_options(void *data, struct fio_option *options)
466{
4945ba12 467 struct fio_option *o;
ee738499 468
4945ba12 469 for (o = &options[0]; o->name; o++)
ee738499
JA
470 if (o->def)
471 handle_option(o, o->def, data);
ee738499 472}
13335ddb
JA
473
474/*
475 * Sanitize the options structure. For now it just sets min/max for bool
5b0a8880 476 * values and whether both callback and offsets are given.
13335ddb
JA
477 */
478void options_init(struct fio_option *options)
479{
4945ba12 480 struct fio_option *o;
13335ddb 481
4945ba12 482 for (o = &options[0]; o->name; o++) {
13335ddb
JA
483 if (o->type == FIO_OPT_BOOL) {
484 o->minval = 0;
485 o->maxval = 1;
486 }
5b0a8880
JA
487 if (o->cb && (o->off1 || o->off2 || o->off3 || o->off4))
488 fprintf(stderr, "Option %s: both cb and offset given\n", o->name);
13335ddb
JA
489 }
490}