gfio: move more code to ghelpers.c
[fio.git] / options.c
CommitLineData
214e1eca
JA
1#include <stdio.h>
2#include <stdlib.h>
3#include <unistd.h>
4#include <ctype.h>
5#include <string.h>
214e1eca 6#include <assert.h>
921c766f 7#include <libgen.h>
5921e80c
JA
8#include <fcntl.h>
9#include <sys/types.h>
10#include <sys/stat.h>
214e1eca
JA
11
12#include "fio.h"
4f5af7b2 13#include "verify.h"
214e1eca 14#include "parse.h"
eef32359 15#include "lib/fls.h"
9f988e2e 16#include "options.h"
214e1eca 17
5d7c5d34
JA
18#include "crc/crc32c.h"
19
214e1eca
JA
20/*
21 * Check if mmap/mmaphuge has a :/foo/bar/file at the end. If so, return that.
22 */
23static char *get_opt_postfix(const char *str)
24{
25 char *p = strstr(str, ":");
26
27 if (!p)
28 return NULL;
29
30 p++;
31 strip_blank_front(&p);
32 strip_blank_end(p);
33 return strdup(p);
34}
35
0e92f873
RR
36static int converthexchartoint(char a)
37{
38 int base;
39
40 switch(a) {
41 case '0'...'9':
42 base = '0';
43 break;
44 case 'A'...'F':
45 base = 'A' - 10;
46 break;
47 case 'a'...'f':
48 base = 'a' - 10;
49 break;
50 default:
51 base = 0;
52 }
53 return (a - base);
54}
55
564ca972
JA
56static int bs_cmp(const void *p1, const void *p2)
57{
58 const struct bssplit *bsp1 = p1;
59 const struct bssplit *bsp2 = p2;
60
61 return bsp1->perc < bsp2->perc;
62}
63
720e84ad 64static int bssplit_ddir(struct thread_data *td, int ddir, char *str)
564ca972 65{
720e84ad 66 struct bssplit *bssplit;
564ca972
JA
67 unsigned int i, perc, perc_missing;
68 unsigned int max_bs, min_bs;
69 long long val;
720e84ad 70 char *fname;
564ca972 71
720e84ad
JA
72 td->o.bssplit_nr[ddir] = 4;
73 bssplit = malloc(4 * sizeof(struct bssplit));
564ca972
JA
74
75 i = 0;
76 max_bs = 0;
77 min_bs = -1;
78 while ((fname = strsep(&str, ":")) != NULL) {
79 char *perc_str;
80
81 if (!strlen(fname))
82 break;
83
84 /*
85 * grow struct buffer, if needed
86 */
720e84ad
JA
87 if (i == td->o.bssplit_nr[ddir]) {
88 td->o.bssplit_nr[ddir] <<= 1;
89 bssplit = realloc(bssplit, td->o.bssplit_nr[ddir]
5ec10eaa 90 * sizeof(struct bssplit));
564ca972
JA
91 }
92
93 perc_str = strstr(fname, "/");
94 if (perc_str) {
95 *perc_str = '\0';
96 perc_str++;
97 perc = atoi(perc_str);
98 if (perc > 100)
99 perc = 100;
100 else if (!perc)
101 perc = -1;
102 } else
103 perc = -1;
104
6925dd35 105 if (str_to_decimal(fname, &val, 1, td)) {
564ca972
JA
106 log_err("fio: bssplit conversion failed\n");
107 free(td->o.bssplit);
108 return 1;
109 }
110
111 if (val > max_bs)
112 max_bs = val;
113 if (val < min_bs)
114 min_bs = val;
115
720e84ad
JA
116 bssplit[i].bs = val;
117 bssplit[i].perc = perc;
564ca972
JA
118 i++;
119 }
120
720e84ad 121 td->o.bssplit_nr[ddir] = i;
564ca972
JA
122
123 /*
124 * Now check if the percentages add up, and how much is missing
125 */
126 perc = perc_missing = 0;
720e84ad
JA
127 for (i = 0; i < td->o.bssplit_nr[ddir]; i++) {
128 struct bssplit *bsp = &bssplit[i];
564ca972
JA
129
130 if (bsp->perc == (unsigned char) -1)
131 perc_missing++;
132 else
133 perc += bsp->perc;
134 }
135
136 if (perc > 100) {
137 log_err("fio: bssplit percentages add to more than 100%%\n");
720e84ad 138 free(bssplit);
564ca972
JA
139 return 1;
140 }
141 /*
142 * If values didn't have a percentage set, divide the remains between
143 * them.
144 */
145 if (perc_missing) {
720e84ad
JA
146 for (i = 0; i < td->o.bssplit_nr[ddir]; i++) {
147 struct bssplit *bsp = &bssplit[i];
564ca972
JA
148
149 if (bsp->perc == (unsigned char) -1)
150 bsp->perc = (100 - perc) / perc_missing;
151 }
152 }
153
720e84ad
JA
154 td->o.min_bs[ddir] = min_bs;
155 td->o.max_bs[ddir] = max_bs;
564ca972
JA
156
157 /*
158 * now sort based on percentages, for ease of lookup
159 */
720e84ad
JA
160 qsort(bssplit, td->o.bssplit_nr[ddir], sizeof(struct bssplit), bs_cmp);
161 td->o.bssplit[ddir] = bssplit;
162 return 0;
720e84ad
JA
163}
164
165static int str_bssplit_cb(void *data, const char *input)
166{
167 struct thread_data *td = data;
168 char *str, *p, *odir;
169 int ret = 0;
170
171 p = str = strdup(input);
172
173 strip_blank_front(&str);
174 strip_blank_end(str);
175
176 odir = strchr(str, ',');
177 if (odir) {
178 ret = bssplit_ddir(td, DDIR_WRITE, odir + 1);
179 if (!ret) {
180 *odir = '\0';
181 ret = bssplit_ddir(td, DDIR_READ, str);
182 }
183 } else {
184 char *op;
185
186 op = strdup(str);
187
188 ret = bssplit_ddir(td, DDIR_READ, str);
189 if (!ret)
190 ret = bssplit_ddir(td, DDIR_WRITE, op);
191
192 free(op);
193 }
564ca972
JA
194
195 free(p);
720e84ad 196 return ret;
564ca972
JA
197}
198
211097b2
JA
199static int str_rw_cb(void *data, const char *str)
200{
201 struct thread_data *td = data;
202 char *nr = get_opt_postfix(str);
203
5736c10d 204 td->o.ddir_seq_nr = 1;
059b0802
JA
205 td->o.ddir_seq_add = 0;
206
207 if (!nr)
208 return 0;
209
210 if (td_random(td))
5736c10d 211 td->o.ddir_seq_nr = atoi(nr);
059b0802
JA
212 else {
213 long long val;
214
6925dd35 215 if (str_to_decimal(nr, &val, 1, td)) {
059b0802
JA
216 log_err("fio: rw postfix parsing failed\n");
217 free(nr);
218 return 1;
219 }
220
221 td->o.ddir_seq_add = val;
182ec6ee 222 }
211097b2 223
059b0802 224 free(nr);
211097b2
JA
225 return 0;
226}
227
214e1eca
JA
228static int str_mem_cb(void *data, const char *mem)
229{
230 struct thread_data *td = data;
231
2dc1bbeb 232 if (td->o.mem_type == MEM_MMAPHUGE || td->o.mem_type == MEM_MMAP) {
214e1eca 233 td->mmapfile = get_opt_postfix(mem);
2dc1bbeb 234 if (td->o.mem_type == MEM_MMAPHUGE && !td->mmapfile) {
214e1eca
JA
235 log_err("fio: mmaphuge:/path/to/file\n");
236 return 1;
237 }
238 }
239
240 return 0;
241}
242
5d7c5d34
JA
243static int str_verify_cb(void *data, const char *mem)
244{
245 struct thread_data *td = data;
246
e3aaafc4
JA
247 if (td->o.verify == VERIFY_CRC32C_INTEL ||
248 td->o.verify == VERIFY_CRC32C) {
249 crc32c_intel_probe();
5d7c5d34
JA
250 }
251
252 return 0;
253}
254
c223da83
JA
255static int fio_clock_source_cb(void *data, const char *str)
256{
257 struct thread_data *td = data;
258
259 fio_clock_source = td->o.clocksource;
260 fio_time_init();
261 return 0;
262}
263
85bc833b 264static int str_lockmem_cb(void fio_unused *data, unsigned long long *val)
214e1eca
JA
265{
266 mlock_size = *val;
267 return 0;
268}
269
85bc833b 270static int str_rwmix_read_cb(void *data, unsigned long long *val)
cb499fc4
JA
271{
272 struct thread_data *td = data;
273
274 td->o.rwmix[DDIR_READ] = *val;
275 td->o.rwmix[DDIR_WRITE] = 100 - *val;
276 return 0;
277}
278
85bc833b 279static int str_rwmix_write_cb(void *data, unsigned long long *val)
cb499fc4
JA
280{
281 struct thread_data *td = data;
282
283 td->o.rwmix[DDIR_WRITE] = *val;
284 td->o.rwmix[DDIR_READ] = 100 - *val;
285 return 0;
286}
287
214e1eca 288#ifdef FIO_HAVE_IOPRIO
85bc833b 289static int str_prioclass_cb(void *data, unsigned long long *val)
214e1eca
JA
290{
291 struct thread_data *td = data;
6cefbe33
JA
292 unsigned short mask;
293
294 /*
295 * mask off old class bits, str_prio_cb() may have set a default class
296 */
297 mask = (1 << IOPRIO_CLASS_SHIFT) - 1;
298 td->ioprio &= mask;
214e1eca
JA
299
300 td->ioprio |= *val << IOPRIO_CLASS_SHIFT;
ac684785 301 td->ioprio_set = 1;
214e1eca
JA
302 return 0;
303}
304
85bc833b 305static int str_prio_cb(void *data, unsigned long long *val)
214e1eca
JA
306{
307 struct thread_data *td = data;
308
309 td->ioprio |= *val;
6cefbe33
JA
310
311 /*
312 * If no class is set, assume BE
313 */
314 if ((td->ioprio >> IOPRIO_CLASS_SHIFT) == 0)
315 td->ioprio |= IOPRIO_CLASS_BE << IOPRIO_CLASS_SHIFT;
316
ac684785 317 td->ioprio_set = 1;
214e1eca
JA
318 return 0;
319}
320#endif
321
322static int str_exitall_cb(void)
323{
324 exitall_on_terminate = 1;
325 return 0;
326}
327
214e1eca 328#ifdef FIO_HAVE_CPU_AFFINITY
85bc833b 329static int str_cpumask_cb(void *data, unsigned long long *val)
d2e268b0
JA
330{
331 struct thread_data *td = data;
214e1eca 332 unsigned int i;
b03daafb 333 long max_cpu;
d2ce18b5
JA
334 int ret;
335
336 ret = fio_cpuset_init(&td->o.cpumask);
337 if (ret < 0) {
338 log_err("fio: cpuset_init failed\n");
339 td_verror(td, ret, "fio_cpuset_init");
340 return 1;
341 }
214e1eca 342
c00a2289 343 max_cpu = cpus_online();
214e1eca 344
62a7273d
JA
345 for (i = 0; i < sizeof(int) * 8; i++) {
346 if ((1 << i) & *val) {
b03daafb
JA
347 if (i > max_cpu) {
348 log_err("fio: CPU %d too large (max=%ld)\n", i,
349 max_cpu);
350 return 1;
351 }
62a7273d 352 dprint(FD_PARSE, "set cpu allowed %d\n", i);
6d459ee7 353 fio_cpu_set(&td->o.cpumask, i);
62a7273d
JA
354 }
355 }
d2e268b0
JA
356
357 td->o.cpumask_set = 1;
358 return 0;
214e1eca
JA
359}
360
e8462bd8
JA
361static int set_cpus_allowed(struct thread_data *td, os_cpu_mask_t *mask,
362 const char *input)
214e1eca 363{
d2e268b0 364 char *cpu, *str, *p;
b03daafb 365 long max_cpu;
19608d6c 366 int ret = 0;
d2e268b0 367
e8462bd8 368 ret = fio_cpuset_init(mask);
d2ce18b5
JA
369 if (ret < 0) {
370 log_err("fio: cpuset_init failed\n");
371 td_verror(td, ret, "fio_cpuset_init");
372 return 1;
373 }
d2e268b0
JA
374
375 p = str = strdup(input);
214e1eca 376
d2e268b0
JA
377 strip_blank_front(&str);
378 strip_blank_end(str);
379
c00a2289 380 max_cpu = cpus_online();
b03daafb 381
d2e268b0 382 while ((cpu = strsep(&str, ",")) != NULL) {
62a7273d
JA
383 char *str2, *cpu2;
384 int icpu, icpu2;
385
d2e268b0
JA
386 if (!strlen(cpu))
387 break;
62a7273d
JA
388
389 str2 = cpu;
390 icpu2 = -1;
391 while ((cpu2 = strsep(&str2, "-")) != NULL) {
392 if (!strlen(cpu2))
393 break;
394
395 icpu2 = atoi(cpu2);
396 }
397
398 icpu = atoi(cpu);
399 if (icpu2 == -1)
400 icpu2 = icpu;
401 while (icpu <= icpu2) {
6d459ee7 402 if (icpu >= FIO_MAX_CPUS) {
19608d6c 403 log_err("fio: your OS only supports up to"
6d459ee7 404 " %d CPUs\n", (int) FIO_MAX_CPUS);
19608d6c
JA
405 ret = 1;
406 break;
407 }
b03daafb
JA
408 if (icpu > max_cpu) {
409 log_err("fio: CPU %d too large (max=%ld)\n",
410 icpu, max_cpu);
411 ret = 1;
412 break;
413 }
0b9d69ec 414
62a7273d 415 dprint(FD_PARSE, "set cpu allowed %d\n", icpu);
e8462bd8 416 fio_cpu_set(mask, icpu);
62a7273d
JA
417 icpu++;
418 }
19608d6c
JA
419 if (ret)
420 break;
d2e268b0
JA
421 }
422
423 free(p);
19608d6c
JA
424 if (!ret)
425 td->o.cpumask_set = 1;
426 return ret;
214e1eca 427}
e8462bd8
JA
428
429static int str_cpus_allowed_cb(void *data, const char *input)
430{
431 struct thread_data *td = data;
432 int ret;
433
434 ret = set_cpus_allowed(td, &td->o.cpumask, input);
435 if (!ret)
436 td->o.cpumask_set = 1;
437
438 return ret;
439}
440
441static int str_verify_cpus_allowed_cb(void *data, const char *input)
442{
443 struct thread_data *td = data;
444 int ret;
445
446 ret = set_cpus_allowed(td, &td->o.verify_cpumask, input);
447 if (!ret)
448 td->o.verify_cpumask_set = 1;
449
450 return ret;
451}
d2e268b0 452#endif
214e1eca 453
0d29de83
JA
454#ifdef FIO_HAVE_TRIM
455static int str_verify_trim_cb(void *data, unsigned long long *val)
456{
457 struct thread_data *td = data;
458
459 td->o.trim_percentage = *val;
460 return 0;
461}
462#endif
463
214e1eca
JA
464static int str_fst_cb(void *data, const char *str)
465{
466 struct thread_data *td = data;
467 char *nr = get_opt_postfix(str);
468
469 td->file_service_nr = 1;
182ec6ee 470 if (nr) {
214e1eca 471 td->file_service_nr = atoi(nr);
182ec6ee
JA
472 free(nr);
473 }
214e1eca
JA
474
475 return 0;
476}
477
3ae06371 478#ifdef FIO_HAVE_SYNC_FILE_RANGE
44f29692
JA
479static int str_sfr_cb(void *data, const char *str)
480{
481 struct thread_data *td = data;
482 char *nr = get_opt_postfix(str);
483
484 td->sync_file_range_nr = 1;
485 if (nr) {
486 td->sync_file_range_nr = atoi(nr);
487 free(nr);
488 }
489
490 return 0;
491}
3ae06371 492#endif
44f29692 493
921c766f
JA
494static int check_dir(struct thread_data *td, char *fname)
495{
3f0ca9b9 496#if 0
921c766f 497 char file[PATH_MAX], *dir;
bc838919 498 int elen = 0;
921c766f 499
bc838919
JA
500 if (td->o.directory) {
501 strcpy(file, td->o.directory);
fcef0b35 502 strcat(file, "/");
bc838919
JA
503 elen = strlen(file);
504 }
505
fcef0b35 506 sprintf(file + elen, "%s", fname);
921c766f
JA
507 dir = dirname(file);
508
fcef0b35
JA
509 {
510 struct stat sb;
511 /*
512 * We can't do this on FIO_DISKLESSIO engines. The engine isn't loaded
513 * yet, so we can't do this check right here...
514 */
921c766f
JA
515 if (lstat(dir, &sb) < 0) {
516 int ret = errno;
517
518 log_err("fio: %s is not a directory\n", dir);
519 td_verror(td, ret, "lstat");
520 return 1;
521 }
522
523 if (!S_ISDIR(sb.st_mode)) {
524 log_err("fio: %s is not a directory\n", dir);
525 return 1;
526 }
fcef0b35
JA
527 }
528#endif
921c766f
JA
529
530 return 0;
531}
532
8e827d35
JA
533/*
534 * Return next file in the string. Files are separated with ':'. If the ':'
535 * is escaped with a '\', then that ':' is part of the filename and does not
536 * indicate a new file.
537 */
538static char *get_next_file_name(char **ptr)
539{
540 char *str = *ptr;
541 char *p, *start;
542
543 if (!str || !strlen(str))
544 return NULL;
545
546 start = str;
547 do {
548 /*
549 * No colon, we are done
550 */
551 p = strchr(str, ':');
552 if (!p) {
553 *ptr = NULL;
554 break;
555 }
556
557 /*
558 * We got a colon, but it's the first character. Skip and
559 * continue
560 */
561 if (p == start) {
562 str = ++start;
563 continue;
564 }
565
566 if (*(p - 1) != '\\') {
567 *p = '\0';
568 *ptr = p + 1;
569 break;
570 }
571
572 memmove(p - 1, p, strlen(p) + 1);
573 str = p;
574 } while (1);
575
576 return start;
577}
578
214e1eca
JA
579static int str_filename_cb(void *data, const char *input)
580{
581 struct thread_data *td = data;
582 char *fname, *str, *p;
583
584 p = str = strdup(input);
585
586 strip_blank_front(&str);
587 strip_blank_end(str);
588
589 if (!td->files_index)
2dc1bbeb 590 td->o.nr_files = 0;
214e1eca 591
8e827d35 592 while ((fname = get_next_file_name(&str)) != NULL) {
214e1eca
JA
593 if (!strlen(fname))
594 break;
921c766f
JA
595 if (check_dir(td, fname)) {
596 free(p);
597 return 1;
598 }
214e1eca 599 add_file(td, fname);
2dc1bbeb 600 td->o.nr_files++;
214e1eca
JA
601 }
602
603 free(p);
604 return 0;
605}
606
607static int str_directory_cb(void *data, const char fio_unused *str)
608{
609 struct thread_data *td = data;
610 struct stat sb;
611
2dc1bbeb 612 if (lstat(td->o.directory, &sb) < 0) {
921c766f
JA
613 int ret = errno;
614
2dc1bbeb 615 log_err("fio: %s is not a directory\n", td->o.directory);
921c766f 616 td_verror(td, ret, "lstat");
214e1eca
JA
617 return 1;
618 }
619 if (!S_ISDIR(sb.st_mode)) {
2dc1bbeb 620 log_err("fio: %s is not a directory\n", td->o.directory);
214e1eca
JA
621 return 1;
622 }
623
624 return 0;
625}
626
627static int str_opendir_cb(void *data, const char fio_unused *str)
628{
629 struct thread_data *td = data;
630
631 if (!td->files_index)
2dc1bbeb 632 td->o.nr_files = 0;
214e1eca 633
2dc1bbeb 634 return add_dir_files(td, td->o.opendir);
214e1eca
JA
635}
636
85bc833b 637static int str_verify_offset_cb(void *data, unsigned long long *off)
546a9142
SL
638{
639 struct thread_data *td = data;
a59e170d 640
546a9142 641 if (*off && *off < sizeof(struct verify_header)) {
a59e170d 642 log_err("fio: verify_offset too small\n");
546a9142
SL
643 return 1;
644 }
a59e170d
JA
645
646 td->o.verify_offset = *off;
546a9142
SL
647 return 0;
648}
649
0e92f873 650static int str_verify_pattern_cb(void *data, const char *input)
90059d65
JA
651{
652 struct thread_data *td = data;
0e92f873
RR
653 long off;
654 int i = 0, j = 0, len, k, base = 10;
655 char* loc1, * loc2;
656
657 loc1 = strstr(input, "0x");
658 loc2 = strstr(input, "0X");
659 if (loc1 || loc2)
660 base = 16;
661 off = strtol(input, NULL, base);
662 if (off != LONG_MAX || errno != ERANGE) {
663 while (off) {
664 td->o.verify_pattern[i] = off & 0xff;
665 off >>= 8;
666 i++;
667 }
668 } else {
669 len = strlen(input);
670 k = len - 1;
671 if (base == 16) {
672 if (loc1)
673 j = loc1 - input + 2;
674 else
675 j = loc2 - input + 2;
676 } else
677 return 1;
678 if (len - j < MAX_PATTERN_SIZE * 2) {
679 while (k >= j) {
680 off = converthexchartoint(input[k--]);
681 if (k >= j)
682 off += (converthexchartoint(input[k--])
683 * 16);
684 td->o.verify_pattern[i++] = (char) off;
685 }
686 }
687 }
efcd9dcc
SL
688
689 /*
690 * Fill the pattern all the way to the end. This greatly reduces
691 * the number of memcpy's we have to do when verifying the IO.
692 */
693 while (i > 1 && i * 2 <= MAX_PATTERN_SIZE) {
694 memcpy(&td->o.verify_pattern[i], &td->o.verify_pattern[0], i);
695 i *= 2;
696 }
9a2a86d0
SL
697 if (i == 1) {
698 /*
699 * The code in verify_io_u_pattern assumes a single byte pattern
700 * fills the whole verify pattern buffer.
701 */
702 memset(td->o.verify_pattern, td->o.verify_pattern[0],
703 MAX_PATTERN_SIZE);
704 }
efcd9dcc 705
0e92f873 706 td->o.verify_pattern_bytes = i;
efcd9dcc 707
92bf48d5
JA
708 /*
709 * VERIFY_META could already be set
710 */
711 if (td->o.verify == VERIFY_NONE)
712 td->o.verify = VERIFY_PATTERN;
efcd9dcc 713
90059d65
JA
714 return 0;
715}
214e1eca 716
4d4e80f2
JA
717static int str_lockfile_cb(void *data, const char *str)
718{
719 struct thread_data *td = data;
720 char *nr = get_opt_postfix(str);
721
722 td->o.lockfile_batch = 1;
182ec6ee 723 if (nr) {
4d4e80f2 724 td->o.lockfile_batch = atoi(nr);
182ec6ee
JA
725 free(nr);
726 }
4d4e80f2
JA
727
728 return 0;
729}
730
e3cedca7
JA
731static int str_write_bw_log_cb(void *data, const char *str)
732{
733 struct thread_data *td = data;
734
735 if (str)
736 td->o.bw_log_file = strdup(str);
737
738 td->o.write_bw_log = 1;
739 return 0;
740}
741
742static int str_write_lat_log_cb(void *data, const char *str)
743{
744 struct thread_data *td = data;
745
746 if (str)
747 td->o.lat_log_file = strdup(str);
748
749 td->o.write_lat_log = 1;
750 return 0;
751}
752
c8eeb9df
JA
753static int str_write_iops_log_cb(void *data, const char *str)
754{
755 struct thread_data *td = data;
756
757 if (str)
758 td->o.iops_log_file = strdup(str);
759
760 td->o.write_iops_log = 1;
761 return 0;
762}
763
993bf48b
JA
764static int str_gtod_reduce_cb(void *data, int *il)
765{
766 struct thread_data *td = data;
767 int val = *il;
768
02af0988 769 td->o.disable_lat = !!val;
993bf48b
JA
770 td->o.disable_clat = !!val;
771 td->o.disable_slat = !!val;
772 td->o.disable_bw = !!val;
0dc1bc03 773 td->o.clat_percentiles = !val;
993bf48b
JA
774 if (val)
775 td->tv_cache_mask = 63;
776
777 return 0;
778}
779
85bc833b 780static int str_gtod_cpu_cb(void *data, long long *il)
be4ecfdf
JA
781{
782 struct thread_data *td = data;
783 int val = *il;
784
785 td->o.gtod_cpu = val;
786 td->o.gtod_offload = 1;
787 return 0;
788}
789
7bb59102
JA
790static int str_size_cb(void *data, unsigned long long *__val)
791{
792 struct thread_data *td = data;
793 unsigned long long v = *__val;
794
795 if (parse_is_percent(v)) {
796 td->o.size = 0;
797 td->o.size_percent = -1ULL - v;
798 } else
799 td->o.size = v;
800
801 return 0;
802}
803
896cac2a
JA
804static int rw_verify(struct fio_option *o, void *data)
805{
806 struct thread_data *td = data;
807
808 if (read_only && td_write(td)) {
809 log_err("fio: job <%s> has write bit set, but fio is in"
810 " read-only mode\n", td->o.name);
811 return 1;
812 }
813
814 return 0;
815}
816
276ca4f7 817static int gtod_cpu_verify(struct fio_option *o, void *data)
29d43ff9 818{
276ca4f7 819#ifndef FIO_HAVE_CPU_AFFINITY
29d43ff9
JA
820 struct thread_data *td = data;
821
29d43ff9
JA
822 if (td->o.gtod_cpu) {
823 log_err("fio: platform must support CPU affinity for"
824 "gettimeofday() offloading\n");
825 return 1;
826 }
827#endif
828
829 return 0;
830}
831
90fef2d1
JA
832static int kb_base_verify(struct fio_option *o, void *data)
833{
834 struct thread_data *td = data;
835
836 if (td->o.kb_base != 1024 && td->o.kb_base != 1000) {
837 log_err("fio: kb_base set to nonsensical value: %u\n",
838 td->o.kb_base);
839 return 1;
840 }
841
842 return 0;
843}
844
9af4a244
JA
845/*
846 * Option grouping
847 */
848static struct opt_group fio_opt_groups[] = {
849 {
850 .name = "Description",
851 .mask = FIO_OPT_G_DESC,
852 },
853 {
854 .name = "File",
855 .mask = FIO_OPT_G_FILE,
856 },
857 {
858 .name = "Misc",
859 .mask = FIO_OPT_G_MISC,
860 },
861 {
862 .name = "IO (main)",
863 .mask = FIO_OPT_G_IO,
864 },
865 {
866 .name = "IO direction",
867 .mask = FIO_OPT_G_IO_DDIR,
868 },
869 {
870 .name = "IO buffer",
871 .mask = FIO_OPT_G_IO_BUF,
872 },
873 {
874 .name = "Random",
875 .mask = FIO_OPT_G_RAND,
876 },
877 {
878 .name = "OS",
879 .mask = FIO_OPT_G_OS,
880 },
881 {
882 .name = "Memory",
883 .mask = FIO_OPT_G_MEM,
884 },
885 {
886 .name = "Verify",
887 .mask = FIO_OPT_G_VERIFY,
888 },
889 {
890 .name = "CPU",
891 .mask = FIO_OPT_G_CPU,
892 },
893 {
894 .name = "Log",
895 .mask = FIO_OPT_G_LOG,
896 },
897 {
898 .name = "Zone",
899 .mask = FIO_OPT_G_ZONE,
900 },
901 {
902 .name = "Cache",
903 .mask = FIO_OPT_G_CACHE,
904 },
905 {
906 .name = "Stat",
907 .mask = FIO_OPT_G_STAT,
908 },
909 {
910 .name = "Error",
911 .mask = FIO_OPT_G_ERR,
912 },
913 {
914 .name = "Job",
915 .mask = FIO_OPT_G_JOB,
916 },
917 {
918 .name = NULL,
919 },
920};
921
922struct opt_group *opt_group_from_mask(unsigned int *mask)
923{
924 struct opt_group *og;
925 int i;
926
927 if (*mask == FIO_OPT_G_INVALID)
928 return NULL;
929
930 for (i = 0; fio_opt_groups[i].name; i++) {
931 og = &fio_opt_groups[i];
932
933 if (*mask & og->mask) {
934 *mask &= ~(og->mask);
935 return og;
936 }
937 }
938
939 return NULL;
940}
941
214e1eca
JA
942/*
943 * Map of job/command line options
944 */
9af4a244 945struct fio_option fio_options[FIO_MAX_OPTS] = {
214e1eca
JA
946 {
947 .name = "description",
948 .type = FIO_OPT_STR_STORE,
949 .off1 = td_var_offset(description),
950 .help = "Text job description",
c9c63318 951 .category = FIO_OPT_G_DESC,
214e1eca
JA
952 },
953 {
954 .name = "name",
955 .type = FIO_OPT_STR_STORE,
956 .off1 = td_var_offset(name),
957 .help = "Name of this job",
c9c63318 958 .category = FIO_OPT_G_DESC,
214e1eca
JA
959 },
960 {
961 .name = "directory",
962 .type = FIO_OPT_STR_STORE,
963 .off1 = td_var_offset(directory),
964 .cb = str_directory_cb,
965 .help = "Directory to store files in",
c9c63318 966 .category = FIO_OPT_G_FILE,
214e1eca
JA
967 },
968 {
969 .name = "filename",
970 .type = FIO_OPT_STR_STORE,
971 .off1 = td_var_offset(filename),
972 .cb = str_filename_cb,
f0d524b0 973 .prio = -1, /* must come after "directory" */
214e1eca 974 .help = "File(s) to use for the workload",
c9c63318 975 .category = FIO_OPT_G_FILE,
214e1eca 976 },
90fef2d1
JA
977 {
978 .name = "kb_base",
979 .type = FIO_OPT_INT,
980 .off1 = td_var_offset(kb_base),
90fef2d1 981 .verify = kb_base_verify,
a639f0bb 982 .prio = 1,
90fef2d1 983 .def = "1024",
a639f0bb 984 .help = "How many bytes per KB for reporting (1000 or 1024)",
c9c63318 985 .category = FIO_OPT_G_MISC,
90fef2d1 986 },
29c1349f
JA
987 {
988 .name = "lockfile",
4d4e80f2
JA
989 .type = FIO_OPT_STR,
990 .cb = str_lockfile_cb,
991 .off1 = td_var_offset(file_lock_mode),
29c1349f
JA
992 .help = "Lock file when doing IO to it",
993 .parent = "filename",
4d4e80f2 994 .def = "none",
c9c63318 995 .category = FIO_OPT_G_FILE,
4d4e80f2
JA
996 .posval = {
997 { .ival = "none",
998 .oval = FILE_LOCK_NONE,
999 .help = "No file locking",
1000 },
1001 { .ival = "exclusive",
1002 .oval = FILE_LOCK_EXCLUSIVE,
1003 .help = "Exclusive file lock",
1004 },
1005 {
1006 .ival = "readwrite",
1007 .oval = FILE_LOCK_READWRITE,
1008 .help = "Read vs write lock",
1009 },
1010 },
29c1349f 1011 },
214e1eca
JA
1012 {
1013 .name = "opendir",
1014 .type = FIO_OPT_STR_STORE,
1015 .off1 = td_var_offset(opendir),
1016 .cb = str_opendir_cb,
1017 .help = "Recursively add files from this directory and down",
c9c63318 1018 .category = FIO_OPT_G_FILE,
214e1eca
JA
1019 },
1020 {
1021 .name = "rw",
d3aad8f2 1022 .alias = "readwrite",
214e1eca 1023 .type = FIO_OPT_STR,
211097b2 1024 .cb = str_rw_cb,
214e1eca
JA
1025 .off1 = td_var_offset(td_ddir),
1026 .help = "IO direction",
1027 .def = "read",
896cac2a 1028 .verify = rw_verify,
c9c63318 1029 .category = FIO_OPT_G_IO_DDIR,
214e1eca
JA
1030 .posval = {
1031 { .ival = "read",
1032 .oval = TD_DDIR_READ,
1033 .help = "Sequential read",
1034 },
1035 { .ival = "write",
1036 .oval = TD_DDIR_WRITE,
1037 .help = "Sequential write",
1038 },
1039 { .ival = "randread",
1040 .oval = TD_DDIR_RANDREAD,
1041 .help = "Random read",
1042 },
1043 { .ival = "randwrite",
1044 .oval = TD_DDIR_RANDWRITE,
1045 .help = "Random write",
1046 },
1047 { .ival = "rw",
1048 .oval = TD_DDIR_RW,
1049 .help = "Sequential read and write mix",
1050 },
1051 { .ival = "randrw",
1052 .oval = TD_DDIR_RANDRW,
1053 .help = "Random read and write mix"
1054 },
1055 },
1056 },
38dad62d
JA
1057 {
1058 .name = "rw_sequencer",
1059 .type = FIO_OPT_STR,
1060 .off1 = td_var_offset(rw_seq),
1061 .help = "IO offset generator modifier",
1062 .def = "sequential",
c9c63318 1063 .category = FIO_OPT_G_IO_DDIR,
38dad62d
JA
1064 .posval = {
1065 { .ival = "sequential",
1066 .oval = RW_SEQ_SEQ,
1067 .help = "Generate sequential offsets",
1068 },
1069 { .ival = "identical",
1070 .oval = RW_SEQ_IDENT,
1071 .help = "Generate identical offsets",
1072 },
1073 },
1074 },
1075
214e1eca
JA
1076 {
1077 .name = "ioengine",
1078 .type = FIO_OPT_STR_STORE,
1079 .off1 = td_var_offset(ioengine),
1080 .help = "IO engine to use",
58483fa4 1081 .def = FIO_PREFERRED_ENGINE,
c9c63318 1082 .category = FIO_OPT_G_IO,
214e1eca
JA
1083 .posval = {
1084 { .ival = "sync",
1085 .help = "Use read/write",
1086 },
a31041ea 1087 { .ival = "psync",
1088 .help = "Use pread/pwrite",
1089 },
1d2af02a 1090 { .ival = "vsync",
03e20d68 1091 .help = "Use readv/writev",
1d2af02a 1092 },
214e1eca
JA
1093#ifdef FIO_HAVE_LIBAIO
1094 { .ival = "libaio",
1095 .help = "Linux native asynchronous IO",
1096 },
1097#endif
1098#ifdef FIO_HAVE_POSIXAIO
1099 { .ival = "posixaio",
1100 .help = "POSIX asynchronous IO",
1101 },
417f0068
JA
1102#endif
1103#ifdef FIO_HAVE_SOLARISAIO
1104 { .ival = "solarisaio",
1105 .help = "Solaris native asynchronous IO",
1106 },
214e1eca 1107#endif
03e20d68
BC
1108#ifdef FIO_HAVE_WINDOWSAIO
1109 { .ival = "windowsaio",
3be80071 1110 .help = "Windows native asynchronous IO"
de890a1e 1111 },
3be80071 1112#endif
214e1eca 1113 { .ival = "mmap",
03e20d68 1114 .help = "Memory mapped IO"
214e1eca
JA
1115 },
1116#ifdef FIO_HAVE_SPLICE
1117 { .ival = "splice",
1118 .help = "splice/vmsplice based IO",
1119 },
9cce02e8
JA
1120 { .ival = "netsplice",
1121 .help = "splice/vmsplice to/from the network",
1122 },
214e1eca
JA
1123#endif
1124#ifdef FIO_HAVE_SGIO
1125 { .ival = "sg",
1126 .help = "SCSI generic v3 IO",
1127 },
1128#endif
1129 { .ival = "null",
1130 .help = "Testing engine (no data transfer)",
1131 },
1132 { .ival = "net",
1133 .help = "Network IO",
1134 },
1135#ifdef FIO_HAVE_SYSLET
1136 { .ival = "syslet-rw",
1137 .help = "syslet enabled async pread/pwrite IO",
1138 },
1139#endif
1140 { .ival = "cpuio",
03e20d68 1141 .help = "CPU cycle burner engine",
214e1eca 1142 },
b8c82a46
JA
1143#ifdef FIO_HAVE_GUASI
1144 { .ival = "guasi",
1145 .help = "GUASI IO engine",
1146 },
79a43187
JA
1147#endif
1148#ifdef FIO_HAVE_BINJECT
1149 { .ival = "binject",
1150 .help = "binject direct inject block engine",
1151 },
21b8aee8 1152#endif
1153#ifdef FIO_HAVE_RDMA
1154 { .ival = "rdma",
1155 .help = "RDMA IO engine",
1156 },
b8c82a46 1157#endif
214e1eca
JA
1158 { .ival = "external",
1159 .help = "Load external engine (append name)",
1160 },
1161 },
1162 },
1163 {
1164 .name = "iodepth",
1165 .type = FIO_OPT_INT,
1166 .off1 = td_var_offset(iodepth),
03e20d68 1167 .help = "Number of IO buffers to keep in flight",
757aff4f 1168 .minval = 1,
214e1eca 1169 .def = "1",
c9c63318 1170 .category = FIO_OPT_G_IO,
214e1eca
JA
1171 },
1172 {
1173 .name = "iodepth_batch",
4950421a 1174 .alias = "iodepth_batch_submit",
214e1eca
JA
1175 .type = FIO_OPT_INT,
1176 .off1 = td_var_offset(iodepth_batch),
d65db441 1177 .help = "Number of IO buffers to submit in one go",
afdf9352 1178 .parent = "iodepth",
a2e6f8ac
JA
1179 .minval = 1,
1180 .def = "1",
c9c63318 1181 .category = FIO_OPT_G_IO,
4950421a
JA
1182 },
1183 {
1184 .name = "iodepth_batch_complete",
1185 .type = FIO_OPT_INT,
1186 .off1 = td_var_offset(iodepth_batch_complete),
d65db441 1187 .help = "Number of IO buffers to retrieve in one go",
4950421a
JA
1188 .parent = "iodepth",
1189 .minval = 0,
1190 .def = "1",
c9c63318 1191 .category = FIO_OPT_G_IO,
214e1eca
JA
1192 },
1193 {
1194 .name = "iodepth_low",
1195 .type = FIO_OPT_INT,
1196 .off1 = td_var_offset(iodepth_low),
1197 .help = "Low water mark for queuing depth",
afdf9352 1198 .parent = "iodepth",
c9c63318 1199 .category = FIO_OPT_G_IO,
214e1eca
JA
1200 },
1201 {
1202 .name = "size",
1203 .type = FIO_OPT_STR_VAL,
7bb59102 1204 .cb = str_size_cb,
214e1eca 1205 .help = "Total size of device or files",
c9c63318 1206 .category = FIO_OPT_G_IO,
214e1eca 1207 },
aa31f1f1
SL
1208 {
1209 .name = "fill_device",
74586c1e 1210 .alias = "fill_fs",
aa31f1f1
SL
1211 .type = FIO_OPT_BOOL,
1212 .off1 = td_var_offset(fill_device),
1213 .help = "Write until an ENOSPC error occurs",
1214 .def = "0",
c9c63318 1215 .category = FIO_OPT_G_IO,
aa31f1f1 1216 },
214e1eca
JA
1217 {
1218 .name = "filesize",
1219 .type = FIO_OPT_STR_VAL,
1220 .off1 = td_var_offset(file_size_low),
1221 .off2 = td_var_offset(file_size_high),
c3edbdba 1222 .minval = 1,
214e1eca 1223 .help = "Size of individual files",
c9c63318 1224 .category = FIO_OPT_G_IO | FIO_OPT_G_FILE,
214e1eca 1225 },
67a1000f
JA
1226 {
1227 .name = "offset",
1228 .alias = "fileoffset",
1229 .type = FIO_OPT_STR_VAL,
1230 .off1 = td_var_offset(start_offset),
1231 .help = "Start IO from this offset",
1232 .def = "0",
c9c63318 1233 .category = FIO_OPT_G_IO,
67a1000f 1234 },
214e1eca
JA
1235 {
1236 .name = "bs",
d3aad8f2 1237 .alias = "blocksize",
e01b22b8 1238 .type = FIO_OPT_INT,
214e1eca
JA
1239 .off1 = td_var_offset(bs[DDIR_READ]),
1240 .off2 = td_var_offset(bs[DDIR_WRITE]),
c3edbdba 1241 .minval = 1,
214e1eca
JA
1242 .help = "Block size unit",
1243 .def = "4k",
67a1000f 1244 .parent = "rw",
c9c63318 1245 .category = FIO_OPT_G_IO,
214e1eca 1246 },
2b7a01d0
JA
1247 {
1248 .name = "ba",
1249 .alias = "blockalign",
e01b22b8 1250 .type = FIO_OPT_INT,
2b7a01d0
JA
1251 .off1 = td_var_offset(ba[DDIR_READ]),
1252 .off2 = td_var_offset(ba[DDIR_WRITE]),
1253 .minval = 1,
1254 .help = "IO block offset alignment",
1255 .parent = "rw",
c9c63318 1256 .category = FIO_OPT_G_IO | FIO_OPT_G_IO_BUF,
2b7a01d0 1257 },
214e1eca
JA
1258 {
1259 .name = "bsrange",
d3aad8f2 1260 .alias = "blocksize_range",
214e1eca
JA
1261 .type = FIO_OPT_RANGE,
1262 .off1 = td_var_offset(min_bs[DDIR_READ]),
1263 .off2 = td_var_offset(max_bs[DDIR_READ]),
1264 .off3 = td_var_offset(min_bs[DDIR_WRITE]),
1265 .off4 = td_var_offset(max_bs[DDIR_WRITE]),
c3edbdba 1266 .minval = 1,
214e1eca 1267 .help = "Set block size range (in more detail than bs)",
67a1000f 1268 .parent = "rw",
c9c63318 1269 .category = FIO_OPT_G_IO,
214e1eca 1270 },
564ca972
JA
1271 {
1272 .name = "bssplit",
1273 .type = FIO_OPT_STR,
1274 .cb = str_bssplit_cb,
1275 .help = "Set a specific mix of block sizes",
1276 .parent = "rw",
c9c63318 1277 .category = FIO_OPT_G_IO,
564ca972 1278 },
214e1eca
JA
1279 {
1280 .name = "bs_unaligned",
d3aad8f2 1281 .alias = "blocksize_unaligned",
214e1eca
JA
1282 .type = FIO_OPT_STR_SET,
1283 .off1 = td_var_offset(bs_unaligned),
1284 .help = "Don't sector align IO buffer sizes",
67a1000f 1285 .parent = "rw",
c9c63318 1286 .category = FIO_OPT_G_IO,
214e1eca
JA
1287 },
1288 {
1289 .name = "randrepeat",
1290 .type = FIO_OPT_BOOL,
1291 .off1 = td_var_offset(rand_repeatable),
1292 .help = "Use repeatable random IO pattern",
1293 .def = "1",
67a1000f 1294 .parent = "rw",
c9c63318 1295 .category = FIO_OPT_G_IO | FIO_OPT_G_RAND,
214e1eca 1296 },
2615cc4b
JA
1297 {
1298 .name = "use_os_rand",
1299 .type = FIO_OPT_BOOL,
1300 .off1 = td_var_offset(use_os_rand),
1301 .help = "Set to use OS random generator",
1302 .def = "0",
1303 .parent = "rw",
c9c63318 1304 .category = FIO_OPT_G_RAND,
2615cc4b 1305 },
214e1eca
JA
1306 {
1307 .name = "norandommap",
1308 .type = FIO_OPT_STR_SET,
1309 .off1 = td_var_offset(norandommap),
1310 .help = "Accept potential duplicate random blocks",
67a1000f 1311 .parent = "rw",
c9c63318 1312 .category = FIO_OPT_G_RAND,
214e1eca 1313 },
2b386d25
JA
1314 {
1315 .name = "softrandommap",
1316 .type = FIO_OPT_BOOL,
1317 .off1 = td_var_offset(softrandommap),
f66ab3c8 1318 .help = "Set norandommap if randommap allocation fails",
2b386d25
JA
1319 .parent = "norandommap",
1320 .def = "0",
c9c63318 1321 .category = FIO_OPT_G_RAND,
2b386d25 1322 },
214e1eca
JA
1323 {
1324 .name = "nrfiles",
d7c8be03 1325 .alias = "nr_files",
214e1eca
JA
1326 .type = FIO_OPT_INT,
1327 .off1 = td_var_offset(nr_files),
1328 .help = "Split job workload between this number of files",
1329 .def = "1",
c9c63318 1330 .category = FIO_OPT_G_FILE,
214e1eca
JA
1331 },
1332 {
1333 .name = "openfiles",
1334 .type = FIO_OPT_INT,
1335 .off1 = td_var_offset(open_files),
1336 .help = "Number of files to keep open at the same time",
c9c63318 1337 .category = FIO_OPT_G_FILE,
214e1eca
JA
1338 },
1339 {
1340 .name = "file_service_type",
1341 .type = FIO_OPT_STR,
1342 .cb = str_fst_cb,
1343 .off1 = td_var_offset(file_service_type),
1344 .help = "How to select which file to service next",
1345 .def = "roundrobin",
c9c63318 1346 .category = FIO_OPT_G_FILE,
214e1eca
JA
1347 .posval = {
1348 { .ival = "random",
1349 .oval = FIO_FSERVICE_RANDOM,
1350 .help = "Choose a file at random",
1351 },
1352 { .ival = "roundrobin",
1353 .oval = FIO_FSERVICE_RR,
1354 .help = "Round robin select files",
1355 },
a086c257
JA
1356 { .ival = "sequential",
1357 .oval = FIO_FSERVICE_SEQ,
1358 .help = "Finish one file before moving to the next",
1359 },
214e1eca 1360 },
67a1000f
JA
1361 .parent = "nrfiles",
1362 },
7bc8c2cf
JA
1363#ifdef FIO_HAVE_FALLOCATE
1364 {
1365 .name = "fallocate",
a596f047
EG
1366 .type = FIO_OPT_STR,
1367 .off1 = td_var_offset(fallocate_mode),
1368 .help = "Whether pre-allocation is performed when laying out files",
1369 .def = "posix",
c9c63318 1370 .category = FIO_OPT_G_FILE,
a596f047
EG
1371 .posval = {
1372 { .ival = "none",
1373 .oval = FIO_FALLOCATE_NONE,
1374 .help = "Do not pre-allocate space",
1375 },
1376 { .ival = "posix",
1377 .oval = FIO_FALLOCATE_POSIX,
1378 .help = "Use posix_fallocate()",
1379 },
1380#ifdef FIO_HAVE_LINUX_FALLOCATE
1381 { .ival = "keep",
1382 .oval = FIO_FALLOCATE_KEEP_SIZE,
1383 .help = "Use fallocate(..., FALLOC_FL_KEEP_SIZE, ...)",
1384 },
7bc8c2cf 1385#endif
a596f047
EG
1386 /* Compatibility with former boolean values */
1387 { .ival = "0",
1388 .oval = FIO_FALLOCATE_NONE,
1389 .help = "Alias for 'none'",
1390 },
1391 { .ival = "1",
1392 .oval = FIO_FALLOCATE_POSIX,
1393 .help = "Alias for 'posix'",
1394 },
1395 },
1396 },
1397#endif /* FIO_HAVE_FALLOCATE */
67a1000f
JA
1398 {
1399 .name = "fadvise_hint",
1400 .type = FIO_OPT_BOOL,
1401 .off1 = td_var_offset(fadvise_hint),
1402 .help = "Use fadvise() to advise the kernel on IO pattern",
1403 .def = "1",
c9c63318 1404 .category = FIO_OPT_G_FILE,
214e1eca
JA
1405 },
1406 {
1407 .name = "fsync",
1408 .type = FIO_OPT_INT,
1409 .off1 = td_var_offset(fsync_blocks),
1410 .help = "Issue fsync for writes every given number of blocks",
1411 .def = "0",
c9c63318 1412 .category = FIO_OPT_G_FILE,
214e1eca 1413 },
5f9099ea
JA
1414 {
1415 .name = "fdatasync",
1416 .type = FIO_OPT_INT,
1417 .off1 = td_var_offset(fdatasync_blocks),
1418 .help = "Issue fdatasync for writes every given number of blocks",
1419 .def = "0",
c9c63318 1420 .category = FIO_OPT_G_FILE,
5f9099ea 1421 },
1ef2b6be
JA
1422 {
1423 .name = "write_barrier",
1424 .type = FIO_OPT_INT,
1425 .off1 = td_var_offset(barrier_blocks),
1426 .help = "Make every Nth write a barrier write",
1427 .def = "0",
c9c63318 1428 .category = FIO_OPT_G_IO,
1ef2b6be 1429 },
44f29692
JA
1430#ifdef FIO_HAVE_SYNC_FILE_RANGE
1431 {
1432 .name = "sync_file_range",
1433 .posval = {
1434 { .ival = "wait_before",
1435 .oval = SYNC_FILE_RANGE_WAIT_BEFORE,
1436 .help = "SYNC_FILE_RANGE_WAIT_BEFORE",
3843deb3 1437 .or = 1,
44f29692
JA
1438 },
1439 { .ival = "write",
1440 .oval = SYNC_FILE_RANGE_WRITE,
1441 .help = "SYNC_FILE_RANGE_WRITE",
3843deb3 1442 .or = 1,
44f29692
JA
1443 },
1444 {
1445 .ival = "wait_after",
1446 .oval = SYNC_FILE_RANGE_WAIT_AFTER,
1447 .help = "SYNC_FILE_RANGE_WAIT_AFTER",
3843deb3 1448 .or = 1,
44f29692
JA
1449 },
1450 },
3843deb3 1451 .type = FIO_OPT_STR_MULTI,
44f29692
JA
1452 .cb = str_sfr_cb,
1453 .off1 = td_var_offset(sync_file_range),
1454 .help = "Use sync_file_range()",
c9c63318 1455 .category = FIO_OPT_G_FILE,
44f29692
JA
1456 },
1457#endif
214e1eca
JA
1458 {
1459 .name = "direct",
1460 .type = FIO_OPT_BOOL,
1461 .off1 = td_var_offset(odirect),
1462 .help = "Use O_DIRECT IO (negates buffered)",
1463 .def = "0",
c9c63318 1464 .category = FIO_OPT_G_IO,
214e1eca
JA
1465 },
1466 {
1467 .name = "buffered",
1468 .type = FIO_OPT_BOOL,
1469 .off1 = td_var_offset(odirect),
1470 .neg = 1,
1471 .help = "Use buffered IO (negates direct)",
1472 .def = "1",
c9c63318 1473 .category = FIO_OPT_G_IO,
214e1eca
JA
1474 },
1475 {
1476 .name = "overwrite",
1477 .type = FIO_OPT_BOOL,
1478 .off1 = td_var_offset(overwrite),
1479 .help = "When writing, set whether to overwrite current data",
1480 .def = "0",
c9c63318 1481 .category = FIO_OPT_G_IO | FIO_OPT_G_FILE,
214e1eca
JA
1482 },
1483 {
1484 .name = "loops",
1485 .type = FIO_OPT_INT,
1486 .off1 = td_var_offset(loops),
1487 .help = "Number of times to run the job",
1488 .def = "1",
c9c63318 1489 .category = FIO_OPT_G_MISC,
214e1eca
JA
1490 },
1491 {
1492 .name = "numjobs",
1493 .type = FIO_OPT_INT,
1494 .off1 = td_var_offset(numjobs),
1495 .help = "Duplicate this job this many times",
1496 .def = "1",
c9c63318 1497 .category = FIO_OPT_G_MISC,
214e1eca
JA
1498 },
1499 {
1500 .name = "startdelay",
a5737c93 1501 .type = FIO_OPT_STR_VAL_TIME,
214e1eca
JA
1502 .off1 = td_var_offset(start_delay),
1503 .help = "Only start job when this period has passed",
1504 .def = "0",
c9c63318 1505 .category = FIO_OPT_G_MISC,
214e1eca
JA
1506 },
1507 {
1508 .name = "runtime",
1509 .alias = "timeout",
1510 .type = FIO_OPT_STR_VAL_TIME,
1511 .off1 = td_var_offset(timeout),
1512 .help = "Stop workload when this amount of time has passed",
1513 .def = "0",
c9c63318 1514 .category = FIO_OPT_G_MISC,
214e1eca 1515 },
cf4464ca
JA
1516 {
1517 .name = "time_based",
1518 .type = FIO_OPT_STR_SET,
1519 .off1 = td_var_offset(time_based),
1520 .help = "Keep running until runtime/timeout is met",
c9c63318 1521 .category = FIO_OPT_G_MISC,
cf4464ca 1522 },
721938ae
JA
1523 {
1524 .name = "ramp_time",
1525 .type = FIO_OPT_STR_VAL_TIME,
1526 .off1 = td_var_offset(ramp_time),
1527 .help = "Ramp up time before measuring performance",
c9c63318 1528 .category = FIO_OPT_G_MISC,
721938ae 1529 },
c223da83
JA
1530 {
1531 .name = "clocksource",
1532 .type = FIO_OPT_STR,
1533 .cb = fio_clock_source_cb,
1534 .off1 = td_var_offset(clocksource),
1535 .help = "What type of timing source to use",
c9c63318 1536 .category = FIO_OPT_G_OS,
c223da83
JA
1537 .posval = {
1538 { .ival = "gettimeofday",
1539 .oval = CS_GTOD,
1540 .help = "Use gettimeofday(2) for timing",
1541 },
1542 { .ival = "clock_gettime",
1543 .oval = CS_CGETTIME,
1544 .help = "Use clock_gettime(2) for timing",
1545 },
1546#ifdef ARCH_HAVE_CPU_CLOCK
1547 { .ival = "cpu",
1548 .oval = CS_CPUCLOCK,
1549 .help = "Use CPU private clock",
1550 },
1551#endif
1552 },
1553 },
214e1eca
JA
1554 {
1555 .name = "mem",
d3aad8f2 1556 .alias = "iomem",
214e1eca
JA
1557 .type = FIO_OPT_STR,
1558 .cb = str_mem_cb,
1559 .off1 = td_var_offset(mem_type),
1560 .help = "Backing type for IO buffers",
1561 .def = "malloc",
c9c63318 1562 .category = FIO_OPT_G_IO_BUF | FIO_OPT_G_MEM,
214e1eca
JA
1563 .posval = {
1564 { .ival = "malloc",
1565 .oval = MEM_MALLOC,
1566 .help = "Use malloc(3) for IO buffers",
1567 },
37c8cdfe
JA
1568 { .ival = "shm",
1569 .oval = MEM_SHM,
1570 .help = "Use shared memory segments for IO buffers",
1571 },
214e1eca
JA
1572#ifdef FIO_HAVE_HUGETLB
1573 { .ival = "shmhuge",
1574 .oval = MEM_SHMHUGE,
1575 .help = "Like shm, but use huge pages",
1576 },
b370e46a 1577#endif
37c8cdfe
JA
1578 { .ival = "mmap",
1579 .oval = MEM_MMAP,
1580 .help = "Use mmap(2) (file or anon) for IO buffers",
1581 },
214e1eca
JA
1582#ifdef FIO_HAVE_HUGETLB
1583 { .ival = "mmaphuge",
1584 .oval = MEM_MMAPHUGE,
1585 .help = "Like mmap, but use huge pages",
1586 },
1587#endif
1588 },
1589 },
d529ee19
JA
1590 {
1591 .name = "iomem_align",
1592 .alias = "mem_align",
1593 .type = FIO_OPT_INT,
1594 .off1 = td_var_offset(mem_align),
1595 .minval = 0,
1596 .help = "IO memory buffer offset alignment",
1597 .def = "0",
1598 .parent = "iomem",
c9c63318 1599 .category = FIO_OPT_G_IO_BUF | FIO_OPT_G_MEM,
d529ee19 1600 },
214e1eca
JA
1601 {
1602 .name = "verify",
1603 .type = FIO_OPT_STR,
1604 .off1 = td_var_offset(verify),
1605 .help = "Verify data written",
5d7c5d34 1606 .cb = str_verify_cb,
214e1eca 1607 .def = "0",
c9c63318 1608 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
214e1eca
JA
1609 .posval = {
1610 { .ival = "0",
1611 .oval = VERIFY_NONE,
1612 .help = "Don't do IO verification",
1613 },
fcca4b58
JA
1614 { .ival = "md5",
1615 .oval = VERIFY_MD5,
1616 .help = "Use md5 checksums for verification",
1617 },
d77a7af3
JA
1618 { .ival = "crc64",
1619 .oval = VERIFY_CRC64,
1620 .help = "Use crc64 checksums for verification",
1621 },
214e1eca
JA
1622 { .ival = "crc32",
1623 .oval = VERIFY_CRC32,
1624 .help = "Use crc32 checksums for verification",
1625 },
af497e6a 1626 { .ival = "crc32c-intel",
e3aaafc4
JA
1627 .oval = VERIFY_CRC32C,
1628 .help = "Use crc32c checksums for verification (hw assisted, if available)",
af497e6a 1629 },
bac39e0e
JA
1630 { .ival = "crc32c",
1631 .oval = VERIFY_CRC32C,
e3aaafc4 1632 .help = "Use crc32c checksums for verification (hw assisted, if available)",
bac39e0e 1633 },
969f7ed3
JA
1634 { .ival = "crc16",
1635 .oval = VERIFY_CRC16,
1636 .help = "Use crc16 checksums for verification",
1637 },
1e154bdb
JA
1638 { .ival = "crc7",
1639 .oval = VERIFY_CRC7,
1640 .help = "Use crc7 checksums for verification",
1641 },
7c353ceb
JA
1642 { .ival = "sha1",
1643 .oval = VERIFY_SHA1,
1644 .help = "Use sha1 checksums for verification",
1645 },
cd14cc10
JA
1646 { .ival = "sha256",
1647 .oval = VERIFY_SHA256,
1648 .help = "Use sha256 checksums for verification",
1649 },
1650 { .ival = "sha512",
1651 .oval = VERIFY_SHA512,
1652 .help = "Use sha512 checksums for verification",
1653 },
7437ee87
SL
1654 { .ival = "meta",
1655 .oval = VERIFY_META,
1656 .help = "Use io information",
1657 },
36690c9b
JA
1658 {
1659 .ival = "null",
1660 .oval = VERIFY_NULL,
1661 .help = "Pretend to verify",
1662 },
214e1eca
JA
1663 },
1664 },
005c565a
JA
1665 {
1666 .name = "do_verify",
68e1f29a 1667 .type = FIO_OPT_BOOL,
005c565a
JA
1668 .off1 = td_var_offset(do_verify),
1669 .help = "Run verification stage after write",
1670 .def = "1",
1671 .parent = "verify",
c9c63318 1672 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
005c565a 1673 },
160b966d
JA
1674 {
1675 .name = "verifysort",
1676 .type = FIO_OPT_BOOL,
1677 .off1 = td_var_offset(verifysort),
1678 .help = "Sort written verify blocks for read back",
1679 .def = "1",
c83f2df1 1680 .parent = "verify",
c9c63318 1681 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
160b966d 1682 },
3f9f4e26 1683 {
a59e170d 1684 .name = "verify_interval",
e01b22b8 1685 .type = FIO_OPT_INT,
a59e170d 1686 .off1 = td_var_offset(verify_interval),
819a9680 1687 .minval = 2 * sizeof(struct verify_header),
a59e170d 1688 .help = "Store verify buffer header every N bytes",
afdf9352 1689 .parent = "verify",
c9c63318 1690 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
3f9f4e26 1691 },
546a9142 1692 {
a59e170d 1693 .name = "verify_offset",
e01b22b8 1694 .type = FIO_OPT_INT,
a59e170d 1695 .help = "Offset verify header location by N bytes",
546a9142 1696 .def = "0",
5ec10eaa 1697 .cb = str_verify_offset_cb,
afdf9352 1698 .parent = "verify",
c9c63318 1699 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
546a9142 1700 },
e28218f3
SL
1701 {
1702 .name = "verify_pattern",
0e92f873 1703 .type = FIO_OPT_STR,
e28218f3
SL
1704 .cb = str_verify_pattern_cb,
1705 .help = "Fill pattern for IO buffers",
1706 .parent = "verify",
c9c63318 1707 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
e28218f3 1708 },
a12a3b4d
JA
1709 {
1710 .name = "verify_fatal",
68e1f29a 1711 .type = FIO_OPT_BOOL,
a12a3b4d
JA
1712 .off1 = td_var_offset(verify_fatal),
1713 .def = "0",
1714 .help = "Exit on a single verify failure, don't continue",
1715 .parent = "verify",
c9c63318 1716 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY | FIO_OPT_G_ERR,
a12a3b4d 1717 },
b463e936
JA
1718 {
1719 .name = "verify_dump",
1720 .type = FIO_OPT_BOOL,
1721 .off1 = td_var_offset(verify_dump),
ef71e317 1722 .def = "0",
b463e936
JA
1723 .help = "Dump contents of good and bad blocks on failure",
1724 .parent = "verify",
c9c63318 1725 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY | FIO_OPT_G_ERR,
b463e936 1726 },
e8462bd8
JA
1727 {
1728 .name = "verify_async",
1729 .type = FIO_OPT_INT,
1730 .off1 = td_var_offset(verify_async),
1731 .def = "0",
1732 .help = "Number of async verifier threads to use",
1733 .parent = "verify",
c9c63318 1734 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
e8462bd8 1735 },
9e144189
JA
1736 {
1737 .name = "verify_backlog",
1738 .type = FIO_OPT_STR_VAL,
1739 .off1 = td_var_offset(verify_backlog),
1740 .help = "Verify after this number of blocks are written",
1741 .parent = "verify",
c9c63318 1742 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
9e144189
JA
1743 },
1744 {
1745 .name = "verify_backlog_batch",
1746 .type = FIO_OPT_INT,
1747 .off1 = td_var_offset(verify_batch),
1748 .help = "Verify this number of IO blocks",
0d29de83 1749 .parent = "verify",
c9c63318 1750 .category = FIO_OPT_G_IO | FIO_OPT_G_VERIFY,
9e144189 1751 },
e8462bd8
JA
1752#ifdef FIO_HAVE_CPU_AFFINITY
1753 {
1754 .name = "verify_async_cpus",
1755 .type = FIO_OPT_STR,
1756 .cb = str_verify_cpus_allowed_cb,
1757 .help = "Set CPUs allowed for async verify threads",
1758 .parent = "verify_async",
c9c63318 1759 .category = FIO_OPT_G_OS | FIO_OPT_G_CPU | FIO_OPT_G_VERIFY,
e8462bd8 1760 },
0d29de83
JA
1761#endif
1762#ifdef FIO_HAVE_TRIM
1763 {
1764 .name = "trim_percentage",
1765 .type = FIO_OPT_INT,
1766 .cb = str_verify_trim_cb,
1767 .maxval = 100,
1768 .help = "Number of verify blocks to discard/trim",
1769 .parent = "verify",
1770 .def = "0",
c9c63318 1771 .category = FIO_OPT_G_IO,
0d29de83
JA
1772 },
1773 {
1774 .name = "trim_verify_zero",
1775 .type = FIO_OPT_INT,
1776 .help = "Verify that trim/discarded blocks are returned as zeroes",
1777 .off1 = td_var_offset(trim_zero),
1778 .parent = "trim_percentage",
1779 .def = "1",
c9c63318 1780 .category = FIO_OPT_G_IO,
0d29de83
JA
1781 },
1782 {
1783 .name = "trim_backlog",
1784 .type = FIO_OPT_STR_VAL,
1785 .off1 = td_var_offset(trim_backlog),
1786 .help = "Trim after this number of blocks are written",
1787 .parent = "trim_percentage",
c9c63318 1788 .category = FIO_OPT_G_IO,
0d29de83
JA
1789 },
1790 {
1791 .name = "trim_backlog_batch",
1792 .type = FIO_OPT_INT,
1793 .off1 = td_var_offset(trim_batch),
1794 .help = "Trim this number of IO blocks",
1795 .parent = "trim_percentage",
c9c63318 1796 .category = FIO_OPT_G_IO,
0d29de83 1797 },
e8462bd8 1798#endif
214e1eca
JA
1799 {
1800 .name = "write_iolog",
1801 .type = FIO_OPT_STR_STORE,
1802 .off1 = td_var_offset(write_iolog_file),
1803 .help = "Store IO pattern to file",
c9c63318 1804 .category = FIO_OPT_G_IO | FIO_OPT_G_LOG,
214e1eca
JA
1805 },
1806 {
1807 .name = "read_iolog",
1808 .type = FIO_OPT_STR_STORE,
1809 .off1 = td_var_offset(read_iolog_file),
1810 .help = "Playback IO pattern from file",
c9c63318 1811 .category = FIO_OPT_G_IO | FIO_OPT_G_LOG,
214e1eca 1812 },
64bbb865
DN
1813 {
1814 .name = "replay_no_stall",
1815 .type = FIO_OPT_INT,
1816 .off1 = td_var_offset(no_stall),
1817 .def = "0",
87e7a972 1818 .parent = "read_iolog",
64bbb865 1819 .help = "Playback IO pattern file as fast as possible without stalls",
c9c63318 1820 .category = FIO_OPT_G_IO | FIO_OPT_G_LOG,
64bbb865 1821 },
d1c46c04
DN
1822 {
1823 .name = "replay_redirect",
1824 .type = FIO_OPT_STR_STORE,
1825 .off1 = td_var_offset(replay_redirect),
1826 .parent = "read_iolog",
1827 .help = "Replay all I/O onto this device, regardless of trace device",
c9c63318 1828 .category = FIO_OPT_G_IO | FIO_OPT_G_LOG,
d1c46c04 1829 },
214e1eca
JA
1830 {
1831 .name = "exec_prerun",
1832 .type = FIO_OPT_STR_STORE,
1833 .off1 = td_var_offset(exec_prerun),
1834 .help = "Execute this file prior to running job",
c9c63318 1835 .category = FIO_OPT_G_MISC | FIO_OPT_G_OS,
214e1eca
JA
1836 },
1837 {
1838 .name = "exec_postrun",
1839 .type = FIO_OPT_STR_STORE,
1840 .off1 = td_var_offset(exec_postrun),
1841 .help = "Execute this file after running job",
c9c63318 1842 .category = FIO_OPT_G_MISC | FIO_OPT_G_OS,
214e1eca
JA
1843 },
1844#ifdef FIO_HAVE_IOSCHED_SWITCH
1845 {
1846 .name = "ioscheduler",
1847 .type = FIO_OPT_STR_STORE,
1848 .off1 = td_var_offset(ioscheduler),
1849 .help = "Use this IO scheduler on the backing device",
c9c63318 1850 .category = FIO_OPT_G_OS | FIO_OPT_G_IO,
214e1eca
JA
1851 },
1852#endif
1853 {
1854 .name = "zonesize",
1855 .type = FIO_OPT_STR_VAL,
1856 .off1 = td_var_offset(zone_size),
ed335855
SN
1857 .help = "Amount of data to read per zone",
1858 .def = "0",
c9c63318 1859 .category = FIO_OPT_G_IO | FIO_OPT_G_ZONE,
ed335855
SN
1860 },
1861 {
1862 .name = "zonerange",
1863 .type = FIO_OPT_STR_VAL,
1864 .off1 = td_var_offset(zone_range),
214e1eca
JA
1865 .help = "Give size of an IO zone",
1866 .def = "0",
c9c63318 1867 .category = FIO_OPT_G_IO | FIO_OPT_G_ZONE,
214e1eca
JA
1868 },
1869 {
1870 .name = "zoneskip",
1871 .type = FIO_OPT_STR_VAL,
1872 .off1 = td_var_offset(zone_skip),
1873 .help = "Space between IO zones",
1874 .def = "0",
c9c63318 1875 .category = FIO_OPT_G_IO | FIO_OPT_G_ZONE,
214e1eca
JA
1876 },
1877 {
1878 .name = "lockmem",
1879 .type = FIO_OPT_STR_VAL,
1880 .cb = str_lockmem_cb,
1881 .help = "Lock down this amount of memory",
1882 .def = "0",
c9c63318 1883 .category = FIO_OPT_G_OS | FIO_OPT_G_MEM,
214e1eca 1884 },
214e1eca
JA
1885 {
1886 .name = "rwmixread",
1887 .type = FIO_OPT_INT,
cb499fc4 1888 .cb = str_rwmix_read_cb,
214e1eca
JA
1889 .maxval = 100,
1890 .help = "Percentage of mixed workload that is reads",
1891 .def = "50",
c9c63318 1892 .category = FIO_OPT_G_IO,
214e1eca
JA
1893 },
1894 {
1895 .name = "rwmixwrite",
1896 .type = FIO_OPT_INT,
cb499fc4 1897 .cb = str_rwmix_write_cb,
214e1eca
JA
1898 .maxval = 100,
1899 .help = "Percentage of mixed workload that is writes",
1900 .def = "50",
c9c63318 1901 .category = FIO_OPT_G_IO,
214e1eca 1902 },
afdf9352
JA
1903 {
1904 .name = "rwmixcycle",
15ca150e 1905 .type = FIO_OPT_DEPRECATED,
c9c63318 1906 .category = FIO_OPT_G_IO,
afdf9352 1907 },
214e1eca
JA
1908 {
1909 .name = "nice",
1910 .type = FIO_OPT_INT,
1911 .off1 = td_var_offset(nice),
1912 .help = "Set job CPU nice value",
1913 .minval = -19,
1914 .maxval = 20,
1915 .def = "0",
c9c63318 1916 .category = FIO_OPT_G_OS | FIO_OPT_G_CPU,
214e1eca
JA
1917 },
1918#ifdef FIO_HAVE_IOPRIO
1919 {
1920 .name = "prio",
1921 .type = FIO_OPT_INT,
1922 .cb = str_prio_cb,
1923 .help = "Set job IO priority value",
1924 .minval = 0,
1925 .maxval = 7,
c9c63318 1926 .category = FIO_OPT_G_OS | FIO_OPT_G_CPU,
214e1eca
JA
1927 },
1928 {
1929 .name = "prioclass",
1930 .type = FIO_OPT_INT,
1931 .cb = str_prioclass_cb,
1932 .help = "Set job IO priority class",
1933 .minval = 0,
1934 .maxval = 3,
c9c63318 1935 .category = FIO_OPT_G_OS | FIO_OPT_G_CPU,
214e1eca
JA
1936 },
1937#endif
1938 {
1939 .name = "thinktime",
1940 .type = FIO_OPT_INT,
1941 .off1 = td_var_offset(thinktime),
1942 .help = "Idle time between IO buffers (usec)",
1943 .def = "0",
c9c63318 1944 .category = FIO_OPT_G_MISC,
214e1eca
JA
1945 },
1946 {
1947 .name = "thinktime_spin",
1948 .type = FIO_OPT_INT,
1949 .off1 = td_var_offset(thinktime_spin),
1950 .help = "Start think time by spinning this amount (usec)",
1951 .def = "0",
afdf9352 1952 .parent = "thinktime",
c9c63318 1953 .category = FIO_OPT_G_MISC,
214e1eca
JA
1954 },
1955 {
1956 .name = "thinktime_blocks",
1957 .type = FIO_OPT_INT,
1958 .off1 = td_var_offset(thinktime_blocks),
1959 .help = "IO buffer period between 'thinktime'",
1960 .def = "1",
afdf9352 1961 .parent = "thinktime",
c9c63318 1962 .category = FIO_OPT_G_MISC,
214e1eca
JA
1963 },
1964 {
1965 .name = "rate",
e01b22b8 1966 .type = FIO_OPT_INT,
581e7141
JA
1967 .off1 = td_var_offset(rate[0]),
1968 .off2 = td_var_offset(rate[1]),
214e1eca 1969 .help = "Set bandwidth rate",
c9c63318 1970 .category = FIO_OPT_G_IO,
214e1eca
JA
1971 },
1972 {
1973 .name = "ratemin",
e01b22b8 1974 .type = FIO_OPT_INT,
581e7141
JA
1975 .off1 = td_var_offset(ratemin[0]),
1976 .off2 = td_var_offset(ratemin[1]),
4e991c23 1977 .help = "Job must meet this rate or it will be shutdown",
afdf9352 1978 .parent = "rate",
c9c63318 1979 .category = FIO_OPT_G_IO,
4e991c23
JA
1980 },
1981 {
1982 .name = "rate_iops",
e01b22b8 1983 .type = FIO_OPT_INT,
581e7141
JA
1984 .off1 = td_var_offset(rate_iops[0]),
1985 .off2 = td_var_offset(rate_iops[1]),
4e991c23 1986 .help = "Limit IO used to this number of IO operations/sec",
c9c63318 1987 .category = FIO_OPT_G_IO,
4e991c23
JA
1988 },
1989 {
1990 .name = "rate_iops_min",
e01b22b8 1991 .type = FIO_OPT_INT,
581e7141
JA
1992 .off1 = td_var_offset(rate_iops_min[0]),
1993 .off2 = td_var_offset(rate_iops_min[1]),
03e20d68 1994 .help = "Job must meet this rate or it will be shut down",
afdf9352 1995 .parent = "rate_iops",
c9c63318 1996 .category = FIO_OPT_G_IO,
214e1eca
JA
1997 },
1998 {
1999 .name = "ratecycle",
2000 .type = FIO_OPT_INT,
2001 .off1 = td_var_offset(ratecycle),
2002 .help = "Window average for rate limits (msec)",
2003 .def = "1000",
afdf9352 2004 .parent = "rate",
c9c63318 2005 .category = FIO_OPT_G_IO,
214e1eca
JA
2006 },
2007 {
2008 .name = "invalidate",
2009 .type = FIO_OPT_BOOL,
2010 .off1 = td_var_offset(invalidate_cache),
2011 .help = "Invalidate buffer/page cache prior to running job",
2012 .def = "1",
c9c63318 2013 .category = FIO_OPT_G_IO | FIO_OPT_G_CACHE,
214e1eca
JA
2014 },
2015 {
2016 .name = "sync",
2017 .type = FIO_OPT_BOOL,
2018 .off1 = td_var_offset(sync_io),
2019 .help = "Use O_SYNC for buffered writes",
2020 .def = "0",
67a1000f 2021 .parent = "buffered",
c9c63318 2022 .category = FIO_OPT_G_IO | FIO_OPT_G_FILE,
214e1eca
JA
2023 },
2024 {
2025 .name = "bwavgtime",
2026 .type = FIO_OPT_INT,
2027 .off1 = td_var_offset(bw_avg_time),
5ec10eaa
JA
2028 .help = "Time window over which to calculate bandwidth"
2029 " (msec)",
214e1eca 2030 .def = "500",
c8eeb9df 2031 .parent = "write_bw_log",
c9c63318 2032 .category = FIO_OPT_G_LOG | FIO_OPT_G_STAT,
c8eeb9df
JA
2033 },
2034 {
2035 .name = "iopsavgtime",
2036 .type = FIO_OPT_INT,
2037 .off1 = td_var_offset(iops_avg_time),
2038 .help = "Time window over which to calculate IOPS (msec)",
2039 .def = "500",
2040 .parent = "write_iops_log",
c9c63318 2041 .category = FIO_OPT_G_LOG | FIO_OPT_G_STAT,
214e1eca
JA
2042 },
2043 {
2044 .name = "create_serialize",
2045 .type = FIO_OPT_BOOL,
2046 .off1 = td_var_offset(create_serialize),
2047 .help = "Serialize creating of job files",
2048 .def = "1",
c9c63318 2049 .category = FIO_OPT_G_FILE,
214e1eca
JA
2050 },
2051 {
2052 .name = "create_fsync",
2053 .type = FIO_OPT_BOOL,
2054 .off1 = td_var_offset(create_fsync),
03e20d68 2055 .help = "fsync file after creation",
214e1eca 2056 .def = "1",
c9c63318 2057 .category = FIO_OPT_G_FILE,
214e1eca 2058 },
814452bd
JA
2059 {
2060 .name = "create_on_open",
2061 .type = FIO_OPT_BOOL,
2062 .off1 = td_var_offset(create_on_open),
2063 .help = "Create files when they are opened for IO",
2064 .def = "0",
c9c63318 2065 .category = FIO_OPT_G_FILE,
814452bd 2066 },
0b9d69ec 2067 {
afad68f7
ZY
2068 .name = "pre_read",
2069 .type = FIO_OPT_BOOL,
2070 .off1 = td_var_offset(pre_read),
03e20d68 2071 .help = "Pre-read files before starting official testing",
afad68f7 2072 .def = "0",
c9c63318 2073 .category = FIO_OPT_G_FILE | FIO_OPT_G_CACHE,
afad68f7 2074 },
214e1eca
JA
2075 {
2076 .name = "cpuload",
2077 .type = FIO_OPT_INT,
2078 .off1 = td_var_offset(cpuload),
2079 .help = "Use this percentage of CPU",
c9c63318 2080 .category = FIO_OPT_G_CPU,
214e1eca
JA
2081 },
2082 {
2083 .name = "cpuchunks",
2084 .type = FIO_OPT_INT,
2085 .off1 = td_var_offset(cpucycle),
2086 .help = "Length of the CPU burn cycles (usecs)",
2087 .def = "50000",
67a1000f 2088 .parent = "cpuload",
c9c63318 2089 .category = FIO_OPT_G_CPU,
214e1eca
JA
2090 },
2091#ifdef FIO_HAVE_CPU_AFFINITY
2092 {
2093 .name = "cpumask",
2094 .type = FIO_OPT_INT,
2095 .cb = str_cpumask_cb,
2096 .help = "CPU affinity mask",
c9c63318 2097 .category = FIO_OPT_G_CPU | FIO_OPT_G_OS,
214e1eca 2098 },
d2e268b0
JA
2099 {
2100 .name = "cpus_allowed",
2101 .type = FIO_OPT_STR,
2102 .cb = str_cpus_allowed_cb,
2103 .help = "Set CPUs allowed",
c9c63318 2104 .category = FIO_OPT_G_CPU | FIO_OPT_G_OS,
d2e268b0 2105 },
214e1eca
JA
2106#endif
2107 {
2108 .name = "end_fsync",
2109 .type = FIO_OPT_BOOL,
2110 .off1 = td_var_offset(end_fsync),
2111 .help = "Include fsync at the end of job",
2112 .def = "0",
c9c63318 2113 .category = FIO_OPT_G_FILE,
214e1eca
JA
2114 },
2115 {
2116 .name = "fsync_on_close",
2117 .type = FIO_OPT_BOOL,
2118 .off1 = td_var_offset(fsync_on_close),
2119 .help = "fsync files on close",
2120 .def = "0",
c9c63318 2121 .category = FIO_OPT_G_FILE,
214e1eca
JA
2122 },
2123 {
2124 .name = "unlink",
2125 .type = FIO_OPT_BOOL,
2126 .off1 = td_var_offset(unlink),
2127 .help = "Unlink created files after job has completed",
2128 .def = "0",
c9c63318 2129 .category = FIO_OPT_G_FILE,
214e1eca
JA
2130 },
2131 {
2132 .name = "exitall",
2133 .type = FIO_OPT_STR_SET,
2134 .cb = str_exitall_cb,
2135 .help = "Terminate all jobs when one exits",
c9c63318 2136 .category = FIO_OPT_G_MISC | FIO_OPT_G_JOB,
214e1eca
JA
2137 },
2138 {
2139 .name = "stonewall",
d392365e 2140 .alias = "wait_for_previous",
214e1eca
JA
2141 .type = FIO_OPT_STR_SET,
2142 .off1 = td_var_offset(stonewall),
2143 .help = "Insert a hard barrier between this job and previous",
c9c63318 2144 .category = FIO_OPT_G_MISC | FIO_OPT_G_JOB,
214e1eca 2145 },
b3d62a75
JA
2146 {
2147 .name = "new_group",
2148 .type = FIO_OPT_STR_SET,
2149 .off1 = td_var_offset(new_group),
2150 .help = "Mark the start of a new group (for reporting)",
c9c63318 2151 .category = FIO_OPT_G_MISC | FIO_OPT_G_JOB,
b3d62a75 2152 },
214e1eca
JA
2153 {
2154 .name = "thread",
2155 .type = FIO_OPT_STR_SET,
2156 .off1 = td_var_offset(use_thread),
2157 .help = "Use threads instead of forks",
c9c63318 2158 .category = FIO_OPT_G_MISC | FIO_OPT_G_OS | FIO_OPT_G_JOB,
214e1eca
JA
2159 },
2160 {
2161 .name = "write_bw_log",
e3cedca7 2162 .type = FIO_OPT_STR,
214e1eca 2163 .off1 = td_var_offset(write_bw_log),
e3cedca7 2164 .cb = str_write_bw_log_cb,
214e1eca 2165 .help = "Write log of bandwidth during run",
c9c63318 2166 .category = FIO_OPT_G_LOG,
214e1eca
JA
2167 },
2168 {
2169 .name = "write_lat_log",
e3cedca7 2170 .type = FIO_OPT_STR,
214e1eca 2171 .off1 = td_var_offset(write_lat_log),
e3cedca7 2172 .cb = str_write_lat_log_cb,
214e1eca 2173 .help = "Write log of latency during run",
c9c63318 2174 .category = FIO_OPT_G_LOG,
214e1eca 2175 },
c8eeb9df
JA
2176 {
2177 .name = "write_iops_log",
2178 .type = FIO_OPT_STR,
2179 .off1 = td_var_offset(write_iops_log),
2180 .cb = str_write_iops_log_cb,
2181 .help = "Write log of IOPS during run",
c9c63318 2182 .category = FIO_OPT_G_LOG,
c8eeb9df 2183 },
b8bc8cba
JA
2184 {
2185 .name = "log_avg_msec",
2186 .type = FIO_OPT_INT,
2187 .off1 = td_var_offset(log_avg_msec),
2188 .help = "Average bw/iops/lat logs over this period of time",
2189 .def = "0",
c9c63318 2190 .category = FIO_OPT_G_LOG,
b8bc8cba 2191 },
214e1eca
JA
2192 {
2193 .name = "hugepage-size",
e01b22b8 2194 .type = FIO_OPT_INT,
214e1eca
JA
2195 .off1 = td_var_offset(hugepage_size),
2196 .help = "When using hugepages, specify size of each page",
81179eec 2197 .def = __fio_stringify(FIO_HUGE_PAGE),
c9c63318 2198 .category = FIO_OPT_G_OS | FIO_OPT_G_MEM,
214e1eca
JA
2199 },
2200 {
2201 .name = "group_reporting",
2202 .type = FIO_OPT_STR_SET,
2203 .off1 = td_var_offset(group_reporting),
2204 .help = "Do reporting on a per-group basis",
c9c63318 2205 .category = FIO_OPT_G_MISC,
214e1eca 2206 },
e9459e5a
JA
2207 {
2208 .name = "zero_buffers",
2209 .type = FIO_OPT_STR_SET,
2210 .off1 = td_var_offset(zero_buffers),
2211 .help = "Init IO buffers to all zeroes",
c9c63318 2212 .category = FIO_OPT_G_IO_BUF,
e9459e5a 2213 },
5973cafb
JA
2214 {
2215 .name = "refill_buffers",
2216 .type = FIO_OPT_STR_SET,
2217 .off1 = td_var_offset(refill_buffers),
2218 .help = "Refill IO buffers on every IO submit",
c9c63318 2219 .category = FIO_OPT_G_IO_BUF,
5973cafb 2220 },
fd68418e
JA
2221 {
2222 .name = "scramble_buffers",
2223 .type = FIO_OPT_BOOL,
2224 .off1 = td_var_offset(scramble_buffers),
2225 .help = "Slightly scramble buffers on every IO submit",
2226 .def = "1",
c9c63318 2227 .category = FIO_OPT_G_IO_BUF,
fd68418e 2228 },
9c42684e
JA
2229 {
2230 .name = "buffer_compress_percentage",
2231 .type = FIO_OPT_INT,
2232 .off1 = td_var_offset(compress_percentage),
2233 .maxval = 100,
2234 .minval = 1,
2235 .help = "How compressible the buffer is (approximately)",
2236 },
f97a43a1
JA
2237 {
2238 .name = "buffer_compress_chunk",
2239 .type = FIO_OPT_INT,
2240 .off1 = td_var_offset(compress_chunk),
207b18e4 2241 .parent = "buffer_compress_percentage",
f97a43a1
JA
2242 .help = "Size of compressible region in buffer",
2243 },
83349190
YH
2244 {
2245 .name = "clat_percentiles",
2246 .type = FIO_OPT_BOOL,
2247 .off1 = td_var_offset(clat_percentiles),
2248 .help = "Enable the reporting of completion latency percentiles",
467b35ed 2249 .def = "1",
c9c63318 2250 .category = FIO_OPT_G_STAT,
83349190
YH
2251 },
2252 {
2253 .name = "percentile_list",
2254 .type = FIO_OPT_FLOAT_LIST,
2255 .off1 = td_var_offset(percentile_list),
2256 .off2 = td_var_offset(overwrite_plist),
2257 .help = "Specify a custom list of percentiles to report",
2258 .maxlen = FIO_IO_U_LIST_MAX_LEN,
2259 .minfp = 0.0,
2260 .maxfp = 100.0,
c9c63318 2261 .category = FIO_OPT_G_STAT,
83349190
YH
2262 },
2263
0a839f30
JA
2264#ifdef FIO_HAVE_DISK_UTIL
2265 {
2266 .name = "disk_util",
2267 .type = FIO_OPT_BOOL,
2268 .off1 = td_var_offset(do_disk_util),
f66ab3c8 2269 .help = "Log disk utilization statistics",
0a839f30 2270 .def = "1",
c9c63318 2271 .category = FIO_OPT_G_OS | FIO_OPT_G_STAT,
0a839f30
JA
2272 },
2273#endif
993bf48b
JA
2274 {
2275 .name = "gtod_reduce",
2276 .type = FIO_OPT_BOOL,
2277 .help = "Greatly reduce number of gettimeofday() calls",
2278 .cb = str_gtod_reduce_cb,
2279 .def = "0",
c9c63318 2280 .category = FIO_OPT_G_OS | FIO_OPT_G_MISC | FIO_OPT_G_STAT,
993bf48b 2281 },
02af0988
JA
2282 {
2283 .name = "disable_lat",
2284 .type = FIO_OPT_BOOL,
2285 .off1 = td_var_offset(disable_lat),
2286 .help = "Disable latency numbers",
2287 .parent = "gtod_reduce",
2288 .def = "0",
c9c63318 2289 .category = FIO_OPT_G_OS | FIO_OPT_G_MISC | FIO_OPT_G_STAT,
02af0988 2290 },
9520ebb9
JA
2291 {
2292 .name = "disable_clat",
2293 .type = FIO_OPT_BOOL,
2294 .off1 = td_var_offset(disable_clat),
2295 .help = "Disable completion latency numbers",
993bf48b 2296 .parent = "gtod_reduce",
9520ebb9 2297 .def = "0",
c9c63318 2298 .category = FIO_OPT_G_OS | FIO_OPT_G_MISC | FIO_OPT_G_STAT,
9520ebb9
JA
2299 },
2300 {
2301 .name = "disable_slat",
2302 .type = FIO_OPT_BOOL,
2303 .off1 = td_var_offset(disable_slat),
03e20d68 2304 .help = "Disable submission latency numbers",
993bf48b 2305 .parent = "gtod_reduce",
9520ebb9 2306 .def = "0",
c9c63318 2307 .category = FIO_OPT_G_OS | FIO_OPT_G_MISC | FIO_OPT_G_STAT,
9520ebb9
JA
2308 },
2309 {
2310 .name = "disable_bw_measurement",
2311 .type = FIO_OPT_BOOL,
2312 .off1 = td_var_offset(disable_bw),
2313 .help = "Disable bandwidth logging",
993bf48b 2314 .parent = "gtod_reduce",
9520ebb9 2315 .def = "0",
c9c63318 2316 .category = FIO_OPT_G_OS | FIO_OPT_G_MISC | FIO_OPT_G_STAT,
9520ebb9 2317 },
be4ecfdf
JA
2318 {
2319 .name = "gtod_cpu",
2320 .type = FIO_OPT_INT,
2321 .cb = str_gtod_cpu_cb,
03e20d68 2322 .help = "Set up dedicated gettimeofday() thread on this CPU",
29d43ff9 2323 .verify = gtod_cpu_verify,
c9c63318 2324 .category = FIO_OPT_G_OS | FIO_OPT_G_MISC | FIO_OPT_G_STAT,
be4ecfdf 2325 },
f2bba182
RR
2326 {
2327 .name = "continue_on_error",
06842027 2328 .type = FIO_OPT_STR,
f2bba182 2329 .off1 = td_var_offset(continue_on_error),
03e20d68 2330 .help = "Continue on non-fatal errors during IO",
06842027 2331 .def = "none",
c9c63318 2332 .category = FIO_OPT_G_MISC | FIO_OPT_G_ERR,
06842027
SL
2333 .posval = {
2334 { .ival = "none",
2335 .oval = ERROR_TYPE_NONE,
2336 .help = "Exit when an error is encountered",
2337 },
2338 { .ival = "read",
2339 .oval = ERROR_TYPE_READ,
2340 .help = "Continue on read errors only",
2341 },
2342 { .ival = "write",
2343 .oval = ERROR_TYPE_WRITE,
2344 .help = "Continue on write errors only",
2345 },
2346 { .ival = "io",
2347 .oval = ERROR_TYPE_READ | ERROR_TYPE_WRITE,
2348 .help = "Continue on any IO errors",
2349 },
2350 { .ival = "verify",
2351 .oval = ERROR_TYPE_VERIFY,
2352 .help = "Continue on verify errors only",
2353 },
2354 { .ival = "all",
2355 .oval = ERROR_TYPE_ANY,
2356 .help = "Continue on all io and verify errors",
2357 },
2358 { .ival = "0",
2359 .oval = ERROR_TYPE_NONE,
2360 .help = "Alias for 'none'",
2361 },
2362 { .ival = "1",
2363 .oval = ERROR_TYPE_ANY,
2364 .help = "Alias for 'all'",
2365 },
2366 },
f2bba182 2367 },
9ac8a797
JA
2368 {
2369 .name = "profile",
79d16311 2370 .type = FIO_OPT_STR_STORE,
9ac8a797 2371 .off1 = td_var_offset(profile),
9ac8a797 2372 .help = "Select a specific builtin performance test",
c9c63318 2373 .category = FIO_OPT_G_MISC | FIO_OPT_G_JOB,
9ac8a797 2374 },
a696fa2a
JA
2375 {
2376 .name = "cgroup",
2377 .type = FIO_OPT_STR_STORE,
2378 .off1 = td_var_offset(cgroup),
2379 .help = "Add job to cgroup of this name",
c9c63318 2380 .category = FIO_OPT_G_MISC | FIO_OPT_G_OS,
a696fa2a
JA
2381 },
2382 {
2383 .name = "cgroup_weight",
2384 .type = FIO_OPT_INT,
2385 .off1 = td_var_offset(cgroup_weight),
2386 .help = "Use given weight for cgroup",
2387 .minval = 100,
2388 .maxval = 1000,
c9c63318 2389 .category = FIO_OPT_G_MISC | FIO_OPT_G_OS,
a696fa2a 2390 },
7de87099
VG
2391 {
2392 .name = "cgroup_nodelete",
2393 .type = FIO_OPT_BOOL,
2394 .off1 = td_var_offset(cgroup_nodelete),
2395 .help = "Do not delete cgroups after job completion",
2396 .def = "0",
c9c63318 2397 .category = FIO_OPT_G_MISC | FIO_OPT_G_OS,
7de87099 2398 },
e0b0d892
JA
2399 {
2400 .name = "uid",
2401 .type = FIO_OPT_INT,
2402 .off1 = td_var_offset(uid),
2403 .help = "Run job with this user ID",
c9c63318 2404 .category = FIO_OPT_G_OS | FIO_OPT_G_JOB,
e0b0d892
JA
2405 },
2406 {
2407 .name = "gid",
2408 .type = FIO_OPT_INT,
2409 .off1 = td_var_offset(gid),
2410 .help = "Run job with this group ID",
c9c63318 2411 .category = FIO_OPT_G_OS | FIO_OPT_G_JOB,
e0b0d892 2412 },
9e684a49
DE
2413 {
2414 .name = "flow_id",
2415 .type = FIO_OPT_INT,
2416 .off1 = td_var_offset(flow_id),
2417 .help = "The flow index ID to use",
2418 .def = "0",
c9c63318 2419 .category = FIO_OPT_G_IO,
9e684a49
DE
2420 },
2421 {
2422 .name = "flow",
2423 .type = FIO_OPT_INT,
2424 .off1 = td_var_offset(flow),
2425 .help = "Weight for flow control of this job",
2426 .parent = "flow_id",
2427 .def = "0",
c9c63318 2428 .category = FIO_OPT_G_IO,
9e684a49
DE
2429 },
2430 {
2431 .name = "flow_watermark",
2432 .type = FIO_OPT_INT,
2433 .off1 = td_var_offset(flow_watermark),
2434 .help = "High watermark for flow control. This option"
2435 " should be set to the same value for all threads"
2436 " with non-zero flow.",
2437 .parent = "flow_id",
2438 .def = "1024",
c9c63318 2439 .category = FIO_OPT_G_IO,
9e684a49
DE
2440 },
2441 {
2442 .name = "flow_sleep",
2443 .type = FIO_OPT_INT,
2444 .off1 = td_var_offset(flow_sleep),
2445 .help = "How many microseconds to sleep after being held"
2446 " back by the flow control mechanism",
2447 .parent = "flow_id",
2448 .def = "0",
c9c63318 2449 .category = FIO_OPT_G_IO,
9e684a49 2450 },
214e1eca
JA
2451 {
2452 .name = NULL,
2453 },
2454};
2455
17af15d4 2456static void add_to_lopt(struct option *lopt, struct fio_option *o,
de890a1e 2457 const char *name, int val)
9f81736c 2458{
17af15d4 2459 lopt->name = (char *) name;
de890a1e 2460 lopt->val = val;
9f81736c
JA
2461 if (o->type == FIO_OPT_STR_SET)
2462 lopt->has_arg = no_argument;
2463 else
2464 lopt->has_arg = required_argument;
2465}
2466
de890a1e
SL
2467static void options_to_lopts(struct fio_option *opts,
2468 struct option *long_options,
2469 int i, int option_type)
214e1eca 2470{
de890a1e 2471 struct fio_option *o = &opts[0];
214e1eca 2472 while (o->name) {
de890a1e 2473 add_to_lopt(&long_options[i], o, o->name, option_type);
17af15d4
JA
2474 if (o->alias) {
2475 i++;
de890a1e 2476 add_to_lopt(&long_options[i], o, o->alias, option_type);
17af15d4 2477 }
214e1eca
JA
2478
2479 i++;
2480 o++;
2481 assert(i < FIO_NR_OPTIONS);
2482 }
2483}
2484
de890a1e
SL
2485void fio_options_set_ioengine_opts(struct option *long_options,
2486 struct thread_data *td)
2487{
2488 unsigned int i;
2489
2490 i = 0;
2491 while (long_options[i].name) {
2492 if (long_options[i].val == FIO_GETOPT_IOENGINE) {
2493 memset(&long_options[i], 0, sizeof(*long_options));
2494 break;
2495 }
2496 i++;
2497 }
2498
2499 /*
2500 * Just clear out the prior ioengine options.
2501 */
2502 if (!td || !td->eo)
2503 return;
2504
2505 options_to_lopts(td->io_ops->options, long_options, i,
2506 FIO_GETOPT_IOENGINE);
2507}
2508
2509void fio_options_dup_and_init(struct option *long_options)
2510{
2511 unsigned int i;
2512
9af4a244 2513 options_init(fio_options);
de890a1e
SL
2514
2515 i = 0;
2516 while (long_options[i].name)
2517 i++;
2518
9af4a244 2519 options_to_lopts(fio_options, long_options, i, FIO_GETOPT_JOB);
de890a1e
SL
2520}
2521
74929ac2
JA
2522struct fio_keyword {
2523 const char *word;
2524 const char *desc;
2525 char *replace;
2526};
2527
2528static struct fio_keyword fio_keywords[] = {
2529 {
2530 .word = "$pagesize",
2531 .desc = "Page size in the system",
2532 },
2533 {
2534 .word = "$mb_memory",
2535 .desc = "Megabytes of memory online",
2536 },
2537 {
2538 .word = "$ncpus",
2539 .desc = "Number of CPUs online in the system",
2540 },
2541 {
2542 .word = NULL,
2543 },
2544};
2545
2546void fio_keywords_init(void)
2547{
3b2e1464 2548 unsigned long long mb_memory;
74929ac2
JA
2549 char buf[128];
2550 long l;
2551
2552 sprintf(buf, "%lu", page_size);
2553 fio_keywords[0].replace = strdup(buf);
2554
8eb016d3 2555 mb_memory = os_phys_mem() / (1024 * 1024);
3b2e1464 2556 sprintf(buf, "%llu", mb_memory);
74929ac2
JA
2557 fio_keywords[1].replace = strdup(buf);
2558
c00a2289 2559 l = cpus_online();
74929ac2
JA
2560 sprintf(buf, "%lu", l);
2561 fio_keywords[2].replace = strdup(buf);
2562}
2563
892a6ffc
JA
2564#define BC_APP "bc"
2565
2566static char *bc_calc(char *str)
2567{
d0c814ec 2568 char buf[128], *tmp;
892a6ffc
JA
2569 FILE *f;
2570 int ret;
2571
2572 /*
2573 * No math, just return string
2574 */
d0c814ec
SL
2575 if ((!strchr(str, '+') && !strchr(str, '-') && !strchr(str, '*') &&
2576 !strchr(str, '/')) || strchr(str, '\''))
892a6ffc
JA
2577 return str;
2578
2579 /*
2580 * Split option from value, we only need to calculate the value
2581 */
2582 tmp = strchr(str, '=');
2583 if (!tmp)
2584 return str;
2585
2586 tmp++;
892a6ffc 2587
d0c814ec
SL
2588 /*
2589 * Prevent buffer overflows; such a case isn't reasonable anyway
2590 */
2591 if (strlen(str) >= 128 || strlen(tmp) > 100)
2592 return str;
892a6ffc
JA
2593
2594 sprintf(buf, "which %s > /dev/null", BC_APP);
2595 if (system(buf)) {
2596 log_err("fio: bc is needed for performing math\n");
892a6ffc
JA
2597 return NULL;
2598 }
2599
d0c814ec 2600 sprintf(buf, "echo '%s' | %s", tmp, BC_APP);
892a6ffc
JA
2601 f = popen(buf, "r");
2602 if (!f) {
892a6ffc
JA
2603 return NULL;
2604 }
2605
d0c814ec 2606 ret = fread(&buf[tmp - str], 1, 128 - (tmp - str), f);
892a6ffc 2607 if (ret <= 0) {
892a6ffc
JA
2608 return NULL;
2609 }
2610
892a6ffc 2611 pclose(f);
d0c814ec
SL
2612 buf[(tmp - str) + ret - 1] = '\0';
2613 memcpy(buf, str, tmp - str);
892a6ffc 2614 free(str);
d0c814ec
SL
2615 return strdup(buf);
2616}
2617
2618/*
2619 * Return a copy of the input string with substrings of the form ${VARNAME}
2620 * substituted with the value of the environment variable VARNAME. The
2621 * substitution always occurs, even if VARNAME is empty or the corresponding
2622 * environment variable undefined.
2623 */
2624static char *option_dup_subs(const char *opt)
2625{
2626 char out[OPT_LEN_MAX+1];
2627 char in[OPT_LEN_MAX+1];
2628 char *outptr = out;
2629 char *inptr = in;
2630 char *ch1, *ch2, *env;
2631 ssize_t nchr = OPT_LEN_MAX;
2632 size_t envlen;
2633
2634 if (strlen(opt) + 1 > OPT_LEN_MAX) {
2635 log_err("OPT_LEN_MAX (%d) is too small\n", OPT_LEN_MAX);
2636 return NULL;
2637 }
2638
2639 in[OPT_LEN_MAX] = '\0';
2640 strncpy(in, opt, OPT_LEN_MAX);
2641
2642 while (*inptr && nchr > 0) {
2643 if (inptr[0] == '$' && inptr[1] == '{') {
2644 ch2 = strchr(inptr, '}');
2645 if (ch2 && inptr+1 < ch2) {
2646 ch1 = inptr+2;
2647 inptr = ch2+1;
2648 *ch2 = '\0';
2649
2650 env = getenv(ch1);
2651 if (env) {
2652 envlen = strlen(env);
2653 if (envlen <= nchr) {
2654 memcpy(outptr, env, envlen);
2655 outptr += envlen;
2656 nchr -= envlen;
2657 }
2658 }
2659
2660 continue;
2661 }
2662 }
2663
2664 *outptr++ = *inptr++;
2665 --nchr;
2666 }
2667
2668 *outptr = '\0';
2669 return strdup(out);
892a6ffc
JA
2670}
2671
74929ac2
JA
2672/*
2673 * Look for reserved variable names and replace them with real values
2674 */
2675static char *fio_keyword_replace(char *opt)
2676{
2677 char *s;
2678 int i;
d0c814ec 2679 int docalc = 0;
74929ac2
JA
2680
2681 for (i = 0; fio_keywords[i].word != NULL; i++) {
2682 struct fio_keyword *kw = &fio_keywords[i];
2683
2684 while ((s = strstr(opt, kw->word)) != NULL) {
2685 char *new = malloc(strlen(opt) + 1);
2686 char *o_org = opt;
2687 int olen = s - opt;
2688 int len;
2689
2690 /*
2691 * Copy part of the string before the keyword and
2692 * sprintf() the replacement after it.
2693 */
2694 memcpy(new, opt, olen);
2695 len = sprintf(new + olen, "%s", kw->replace);
2696
2697 /*
2698 * If there's more in the original string, copy that
2699 * in too
2700 */
2701 opt += strlen(kw->word) + olen;
2702 if (strlen(opt))
2703 memcpy(new + olen + len, opt, opt - o_org - 1);
2704
2705 /*
2706 * replace opt and free the old opt
2707 */
2708 opt = new;
d0c814ec 2709 free(o_org);
7a958bd5 2710
d0c814ec 2711 docalc = 1;
74929ac2
JA
2712 }
2713 }
2714
d0c814ec
SL
2715 /*
2716 * Check for potential math and invoke bc, if possible
2717 */
2718 if (docalc)
2719 opt = bc_calc(opt);
2720
7a958bd5 2721 return opt;
74929ac2
JA
2722}
2723
d0c814ec
SL
2724static char **dup_and_sub_options(char **opts, int num_opts)
2725{
2726 int i;
2727 char **opts_copy = malloc(num_opts * sizeof(*opts));
2728 for (i = 0; i < num_opts; i++) {
2729 opts_copy[i] = option_dup_subs(opts[i]);
2730 if (!opts_copy[i])
2731 continue;
2732 opts_copy[i] = fio_keyword_replace(opts_copy[i]);
2733 }
2734 return opts_copy;
2735}
2736
3b8b7135 2737int fio_options_parse(struct thread_data *td, char **opts, int num_opts)
214e1eca 2738{
de890a1e 2739 int i, ret, unknown;
d0c814ec 2740 char **opts_copy;
3b8b7135 2741
9af4a244 2742 sort_options(opts, fio_options, num_opts);
d0c814ec 2743 opts_copy = dup_and_sub_options(opts, num_opts);
3b8b7135 2744
de890a1e
SL
2745 for (ret = 0, i = 0, unknown = 0; i < num_opts; i++) {
2746 struct fio_option *o;
9af4a244
JA
2747 int newret = parse_option(opts_copy[i], opts[i], fio_options,
2748 &o, td);
d0c814ec 2749
de890a1e
SL
2750 if (opts_copy[i]) {
2751 if (newret && !o) {
2752 unknown++;
2753 continue;
2754 }
d0c814ec 2755 free(opts_copy[i]);
de890a1e
SL
2756 opts_copy[i] = NULL;
2757 }
2758
2759 ret |= newret;
2760 }
2761
2762 if (unknown) {
2763 ret |= ioengine_load(td);
2764 if (td->eo) {
2765 sort_options(opts_copy, td->io_ops->options, num_opts);
2766 opts = opts_copy;
2767 }
2768 for (i = 0; i < num_opts; i++) {
2769 struct fio_option *o = NULL;
2770 int newret = 1;
2771 if (!opts_copy[i])
2772 continue;
2773
2774 if (td->eo)
2775 newret = parse_option(opts_copy[i], opts[i],
2776 td->io_ops->options, &o,
2777 td->eo);
2778
2779 ret |= newret;
2780 if (!o)
2781 log_err("Bad option <%s>\n", opts[i]);
2782
2783 free(opts_copy[i]);
2784 opts_copy[i] = NULL;
2785 }
74929ac2 2786 }
3b8b7135 2787
d0c814ec 2788 free(opts_copy);
3b8b7135 2789 return ret;
214e1eca
JA
2790}
2791
2792int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
2793{
9af4a244 2794 return parse_cmd_option(opt, val, fio_options, td);
214e1eca
JA
2795}
2796
de890a1e
SL
2797int fio_cmd_ioengine_option_parse(struct thread_data *td, const char *opt,
2798 char *val)
2799{
2800 return parse_cmd_option(opt, val, td->io_ops->options, td);
2801}
2802
214e1eca
JA
2803void fio_fill_default_options(struct thread_data *td)
2804{
9af4a244 2805 fill_default_options(td, fio_options);
214e1eca
JA
2806}
2807
2808int fio_show_option_help(const char *opt)
2809{
9af4a244 2810 return show_cmd_help(fio_options, opt);
214e1eca 2811}
d23bb327 2812
de890a1e 2813void options_mem_dupe(void *data, struct fio_option *options)
d23bb327 2814{
de890a1e 2815 struct fio_option *o;
d23bb327 2816 char **ptr;
d23bb327 2817
de890a1e
SL
2818 for (o = &options[0]; o->name; o++) {
2819 if (o->type != FIO_OPT_STR_STORE)
d23bb327
JA
2820 continue;
2821
de890a1e 2822 ptr = td_var(data, o->off1);
7e356b2d
JA
2823 if (*ptr)
2824 *ptr = strdup(*ptr);
d23bb327
JA
2825 }
2826}
2827
de890a1e
SL
2828/*
2829 * dupe FIO_OPT_STR_STORE options
2830 */
2831void fio_options_mem_dupe(struct thread_data *td)
2832{
9af4a244 2833 options_mem_dupe(&td->o, fio_options);
1647f592
JA
2834
2835 if (td->eo && td->io_ops) {
de890a1e 2836 void *oldeo = td->eo;
1647f592 2837
de890a1e
SL
2838 td->eo = malloc(td->io_ops->option_struct_size);
2839 memcpy(td->eo, oldeo, td->io_ops->option_struct_size);
2840 options_mem_dupe(td->eo, td->io_ops->options);
2841 }
2842}
2843
d6978a32
JA
2844unsigned int fio_get_kb_base(void *data)
2845{
2846 struct thread_data *td = data;
2847 unsigned int kb_base = 0;
2848
2849 if (td)
2850 kb_base = td->o.kb_base;
2851 if (!kb_base)
2852 kb_base = 1024;
2853
2854 return kb_base;
2855}
9f988e2e 2856
07b3232d 2857int add_option(struct fio_option *o)
9f988e2e 2858{
07b3232d
JA
2859 struct fio_option *__o;
2860 int opt_index = 0;
2861
9af4a244 2862 __o = fio_options;
07b3232d
JA
2863 while (__o->name) {
2864 opt_index++;
2865 __o++;
2866 }
2867
9af4a244 2868 memcpy(&fio_options[opt_index], o, sizeof(*o));
07b3232d 2869 return 0;
9f988e2e 2870}
e2de69da 2871
07b3232d 2872void invalidate_profile_options(const char *prof_name)
e2de69da 2873{
07b3232d 2874 struct fio_option *o;
e2de69da 2875
9af4a244 2876 o = fio_options;
07b3232d
JA
2877 while (o->name) {
2878 if (o->prof_name && !strcmp(o->prof_name, prof_name)) {
2879 o->type = FIO_OPT_INVALID;
2880 o->prof_name = NULL;
2881 }
2882 o++;
e2de69da
JA
2883 }
2884}
f5b6bb85
JA
2885
2886void add_opt_posval(const char *optname, const char *ival, const char *help)
2887{
2888 struct fio_option *o;
2889 unsigned int i;
2890
9af4a244 2891 o = find_option(fio_options, optname);
f5b6bb85
JA
2892 if (!o)
2893 return;
2894
2895 for (i = 0; i < PARSE_MAX_VP; i++) {
2896 if (o->posval[i].ival)
2897 continue;
2898
2899 o->posval[i].ival = ival;
2900 o->posval[i].help = help;
2901 break;
2902 }
2903}
2904
2905void del_opt_posval(const char *optname, const char *ival)
2906{
2907 struct fio_option *o;
2908 unsigned int i;
2909
9af4a244 2910 o = find_option(fio_options, optname);
f5b6bb85
JA
2911 if (!o)
2912 return;
2913
2914 for (i = 0; i < PARSE_MAX_VP; i++) {
2915 if (!o->posval[i].ival)
2916 continue;
2917 if (strcmp(o->posval[i].ival, ival))
2918 continue;
2919
2920 o->posval[i].ival = NULL;
2921 o->posval[i].help = NULL;
2922 }
2923}
7e356b2d
JA
2924
2925void fio_options_free(struct thread_data *td)
2926{
9af4a244 2927 options_free(fio_options, td);
de890a1e
SL
2928 if (td->eo && td->io_ops && td->io_ops->options) {
2929 options_free(td->io_ops->options, td->eo);
2930 free(td->eo);
2931 td->eo = NULL;
2932 }
7e356b2d 2933}