options: add ->hide_on_set
[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 {
e8b0e958
JA
850 .name = "General",
851 .mask = FIO_OPT_C_GENERAL,
9af4a244
JA
852 },
853 {
e8b0e958
JA
854 .name = "I/O",
855 .mask = FIO_OPT_C_IO,
9af4a244
JA
856 },
857 {
e8b0e958
JA
858 .name = "File",
859 .mask = FIO_OPT_C_FILE,
9af4a244
JA
860 },
861 {
e8b0e958
JA
862 .name = "Statistics",
863 .mask = FIO_OPT_C_STAT,
9af4a244
JA
864 },
865 {
e8b0e958
JA
866 .name = "Logging",
867 .mask = FIO_OPT_C_LOG,
9af4a244 868 },
e231bbe6 869 {
e8b0e958 870 .name = NULL,
e231bbe6 871 },
e8b0e958
JA
872};
873
874static struct opt_group *__opt_group_from_mask(struct opt_group *ogs, unsigned int *mask,
875 unsigned int inv_mask)
876{
877 struct opt_group *og;
878 int i;
879
880 if (*mask == inv_mask || !*mask)
881 return NULL;
882
883 for (i = 0; ogs[i].name; i++) {
884 og = &ogs[i];
885
886 if (*mask & og->mask) {
887 *mask &= ~(og->mask);
888 return og;
889 }
890 }
891
892 return NULL;
893}
894
895struct opt_group *opt_group_from_mask(unsigned int *mask)
896{
897 return __opt_group_from_mask(fio_opt_groups, mask, FIO_OPT_C_INVALID);
898}
899
900static struct opt_group fio_opt_cat_groups[] = {
9af4a244 901 {
e8b0e958
JA
902 .name = "Rate",
903 .mask = FIO_OPT_G_RATE,
9af4a244
JA
904 },
905 {
e8b0e958
JA
906 .name = "Zone",
907 .mask = FIO_OPT_G_ZONE,
9af4a244
JA
908 },
909 {
e8b0e958
JA
910 .name = "Read/write mix",
911 .mask = FIO_OPT_G_RWMIX,
9af4a244
JA
912 },
913 {
914 .name = "Verify",
915 .mask = FIO_OPT_G_VERIFY,
916 },
917 {
e8b0e958
JA
918 .name = "Trim",
919 .mask = FIO_OPT_G_TRIM,
9af4a244
JA
920 },
921 {
e8b0e958
JA
922 .name = "I/O Logging",
923 .mask = FIO_OPT_G_IOLOG,
9af4a244
JA
924 },
925 {
e8b0e958
JA
926 .name = "I/O Depth",
927 .mask = FIO_OPT_G_IO_DEPTH,
9af4a244
JA
928 },
929 {
e8b0e958
JA
930 .name = "I/O Flow",
931 .mask = FIO_OPT_G_IO_FLOW,
9af4a244 932 },
0626037e
JA
933 {
934 .name = "Description",
935 .mask = FIO_OPT_G_DESC,
936 },
937 {
938 .name = "Filename",
939 .mask = FIO_OPT_G_FILENAME,
940 },
941 {
942 .name = "General I/O",
943 .mask = FIO_OPT_G_IO_BASIC,
944 },
a1f6afec
JA
945 {
946 .name = "Cgroups",
947 .mask = FIO_OPT_G_CGROUP,
948 },
949 {
950 .name = "Runtime",
951 .mask = FIO_OPT_G_RUNTIME,
952 },
10860056
JA
953 {
954 .name = "Process",
955 .mask = FIO_OPT_G_PROCESS,
956 },
957 {
958 .name = "Job credentials / priority",
959 .mask = FIO_OPT_G_CRED,
960 },
961 {
962 .name = "Clock settings",
963 .mask = FIO_OPT_G_CLOCK,
964 },
3ceb458f
JA
965 {
966 .name = "I/O Type",
967 .mask = FIO_OPT_G_IO_TYPE,
968 },
969 {
970 .name = "I/O Thinktime",
971 .mask = FIO_OPT_G_THINKTIME,
972 },
973 {
974 .name = "Randomizations",
975 .mask = FIO_OPT_G_RANDOM,
976 },
977 {
978 .name = "I/O buffers",
979 .mask = FIO_OPT_G_IO_BUF,
980 },
9af4a244
JA
981 {
982 .name = NULL,
e8b0e958 983 }
9af4a244
JA
984};
985
e8b0e958 986struct opt_group *opt_group_cat_from_mask(unsigned int *mask)
9af4a244 987{
e8b0e958 988 return __opt_group_from_mask(fio_opt_cat_groups, mask, FIO_OPT_G_INVALID);
9af4a244
JA
989}
990
214e1eca
JA
991/*
992 * Map of job/command line options
993 */
9af4a244 994struct fio_option fio_options[FIO_MAX_OPTS] = {
214e1eca
JA
995 {
996 .name = "description",
e8b0e958 997 .lname = "Description of job",
214e1eca
JA
998 .type = FIO_OPT_STR_STORE,
999 .off1 = td_var_offset(description),
1000 .help = "Text job description",
e8b0e958 1001 .category = FIO_OPT_C_GENERAL,
0626037e 1002 .group = FIO_OPT_G_DESC,
214e1eca
JA
1003 },
1004 {
1005 .name = "name",
e8b0e958 1006 .lname = "Job name",
214e1eca
JA
1007 .type = FIO_OPT_STR_STORE,
1008 .off1 = td_var_offset(name),
1009 .help = "Name of this job",
e8b0e958 1010 .category = FIO_OPT_C_GENERAL,
0626037e 1011 .group = FIO_OPT_G_DESC,
214e1eca 1012 },
214e1eca
JA
1013 {
1014 .name = "filename",
e8b0e958 1015 .lname = "Filename(s)",
214e1eca
JA
1016 .type = FIO_OPT_STR_STORE,
1017 .off1 = td_var_offset(filename),
1018 .cb = str_filename_cb,
f0d524b0 1019 .prio = -1, /* must come after "directory" */
214e1eca 1020 .help = "File(s) to use for the workload",
e8b0e958 1021 .category = FIO_OPT_C_FILE,
0626037e 1022 .group = FIO_OPT_G_FILENAME,
214e1eca 1023 },
90fef2d1 1024 {
e8b0e958
JA
1025 .name = "directory",
1026 .lname = "Directory",
1027 .type = FIO_OPT_STR_STORE,
1028 .off1 = td_var_offset(directory),
1029 .cb = str_directory_cb,
1030 .help = "Directory to store files in",
1031 .category = FIO_OPT_C_FILE,
0626037e 1032 .group = FIO_OPT_G_FILENAME,
90fef2d1 1033 },
29c1349f
JA
1034 {
1035 .name = "lockfile",
e8b0e958 1036 .lname = "Lockfile",
4d4e80f2
JA
1037 .type = FIO_OPT_STR,
1038 .cb = str_lockfile_cb,
1039 .off1 = td_var_offset(file_lock_mode),
29c1349f
JA
1040 .help = "Lock file when doing IO to it",
1041 .parent = "filename",
d71c154c 1042 .hide = 0,
4d4e80f2 1043 .def = "none",
e8b0e958 1044 .category = FIO_OPT_C_FILE,
0626037e 1045 .group = FIO_OPT_G_FILENAME,
4d4e80f2
JA
1046 .posval = {
1047 { .ival = "none",
1048 .oval = FILE_LOCK_NONE,
1049 .help = "No file locking",
1050 },
1051 { .ival = "exclusive",
1052 .oval = FILE_LOCK_EXCLUSIVE,
1053 .help = "Exclusive file lock",
1054 },
1055 {
1056 .ival = "readwrite",
1057 .oval = FILE_LOCK_READWRITE,
1058 .help = "Read vs write lock",
1059 },
1060 },
29c1349f 1061 },
214e1eca
JA
1062 {
1063 .name = "opendir",
e8b0e958 1064 .lname = "Open directory",
214e1eca
JA
1065 .type = FIO_OPT_STR_STORE,
1066 .off1 = td_var_offset(opendir),
1067 .cb = str_opendir_cb,
1068 .help = "Recursively add files from this directory and down",
e8b0e958 1069 .category = FIO_OPT_C_FILE,
0626037e 1070 .group = FIO_OPT_G_FILENAME,
214e1eca
JA
1071 },
1072 {
1073 .name = "rw",
e8b0e958 1074 .lname = "Read/write",
d3aad8f2 1075 .alias = "readwrite",
214e1eca 1076 .type = FIO_OPT_STR,
211097b2 1077 .cb = str_rw_cb,
214e1eca
JA
1078 .off1 = td_var_offset(td_ddir),
1079 .help = "IO direction",
1080 .def = "read",
896cac2a 1081 .verify = rw_verify,
e8b0e958 1082 .category = FIO_OPT_C_IO,
0626037e 1083 .group = FIO_OPT_G_IO_BASIC,
214e1eca
JA
1084 .posval = {
1085 { .ival = "read",
1086 .oval = TD_DDIR_READ,
1087 .help = "Sequential read",
1088 },
1089 { .ival = "write",
1090 .oval = TD_DDIR_WRITE,
1091 .help = "Sequential write",
1092 },
1093 { .ival = "randread",
1094 .oval = TD_DDIR_RANDREAD,
1095 .help = "Random read",
1096 },
1097 { .ival = "randwrite",
1098 .oval = TD_DDIR_RANDWRITE,
1099 .help = "Random write",
1100 },
1101 { .ival = "rw",
1102 .oval = TD_DDIR_RW,
1103 .help = "Sequential read and write mix",
1104 },
1105 { .ival = "randrw",
1106 .oval = TD_DDIR_RANDRW,
1107 .help = "Random read and write mix"
1108 },
1109 },
1110 },
38dad62d
JA
1111 {
1112 .name = "rw_sequencer",
e8b0e958 1113 .lname = "RW Sequencer",
38dad62d
JA
1114 .type = FIO_OPT_STR,
1115 .off1 = td_var_offset(rw_seq),
1116 .help = "IO offset generator modifier",
1117 .def = "sequential",
e8b0e958 1118 .category = FIO_OPT_C_IO,
0626037e 1119 .group = FIO_OPT_G_IO_BASIC,
38dad62d
JA
1120 .posval = {
1121 { .ival = "sequential",
1122 .oval = RW_SEQ_SEQ,
1123 .help = "Generate sequential offsets",
1124 },
1125 { .ival = "identical",
1126 .oval = RW_SEQ_IDENT,
1127 .help = "Generate identical offsets",
1128 },
1129 },
1130 },
1131
214e1eca
JA
1132 {
1133 .name = "ioengine",
e8b0e958 1134 .lname = "IO Engine",
214e1eca
JA
1135 .type = FIO_OPT_STR_STORE,
1136 .off1 = td_var_offset(ioengine),
1137 .help = "IO engine to use",
58483fa4 1138 .def = FIO_PREFERRED_ENGINE,
e8b0e958 1139 .category = FIO_OPT_C_IO,
0626037e 1140 .group = FIO_OPT_G_IO_BASIC,
214e1eca
JA
1141 .posval = {
1142 { .ival = "sync",
1143 .help = "Use read/write",
1144 },
a31041ea 1145 { .ival = "psync",
1146 .help = "Use pread/pwrite",
1147 },
1d2af02a 1148 { .ival = "vsync",
03e20d68 1149 .help = "Use readv/writev",
1d2af02a 1150 },
214e1eca
JA
1151#ifdef FIO_HAVE_LIBAIO
1152 { .ival = "libaio",
1153 .help = "Linux native asynchronous IO",
1154 },
1155#endif
1156#ifdef FIO_HAVE_POSIXAIO
1157 { .ival = "posixaio",
1158 .help = "POSIX asynchronous IO",
1159 },
417f0068
JA
1160#endif
1161#ifdef FIO_HAVE_SOLARISAIO
1162 { .ival = "solarisaio",
1163 .help = "Solaris native asynchronous IO",
1164 },
214e1eca 1165#endif
03e20d68
BC
1166#ifdef FIO_HAVE_WINDOWSAIO
1167 { .ival = "windowsaio",
3be80071 1168 .help = "Windows native asynchronous IO"
de890a1e 1169 },
3be80071 1170#endif
214e1eca 1171 { .ival = "mmap",
03e20d68 1172 .help = "Memory mapped IO"
214e1eca
JA
1173 },
1174#ifdef FIO_HAVE_SPLICE
1175 { .ival = "splice",
1176 .help = "splice/vmsplice based IO",
1177 },
9cce02e8
JA
1178 { .ival = "netsplice",
1179 .help = "splice/vmsplice to/from the network",
1180 },
214e1eca
JA
1181#endif
1182#ifdef FIO_HAVE_SGIO
1183 { .ival = "sg",
1184 .help = "SCSI generic v3 IO",
1185 },
1186#endif
1187 { .ival = "null",
1188 .help = "Testing engine (no data transfer)",
1189 },
1190 { .ival = "net",
1191 .help = "Network IO",
1192 },
1193#ifdef FIO_HAVE_SYSLET
1194 { .ival = "syslet-rw",
1195 .help = "syslet enabled async pread/pwrite IO",
1196 },
1197#endif
1198 { .ival = "cpuio",
03e20d68 1199 .help = "CPU cycle burner engine",
214e1eca 1200 },
b8c82a46
JA
1201#ifdef FIO_HAVE_GUASI
1202 { .ival = "guasi",
1203 .help = "GUASI IO engine",
1204 },
79a43187
JA
1205#endif
1206#ifdef FIO_HAVE_BINJECT
1207 { .ival = "binject",
1208 .help = "binject direct inject block engine",
1209 },
21b8aee8 1210#endif
1211#ifdef FIO_HAVE_RDMA
1212 { .ival = "rdma",
1213 .help = "RDMA IO engine",
1214 },
b8c82a46 1215#endif
214e1eca
JA
1216 { .ival = "external",
1217 .help = "Load external engine (append name)",
1218 },
1219 },
1220 },
1221 {
1222 .name = "iodepth",
e8b0e958 1223 .lname = "IO Depth",
214e1eca
JA
1224 .type = FIO_OPT_INT,
1225 .off1 = td_var_offset(iodepth),
03e20d68 1226 .help = "Number of IO buffers to keep in flight",
757aff4f 1227 .minval = 1,
20eb06bd 1228 .interval = 1,
214e1eca 1229 .def = "1",
e8b0e958 1230 .category = FIO_OPT_C_IO,
0626037e 1231 .group = FIO_OPT_G_IO_BASIC,
214e1eca
JA
1232 },
1233 {
1234 .name = "iodepth_batch",
e8b0e958 1235 .lname = "IO Depth batch",
4950421a 1236 .alias = "iodepth_batch_submit",
214e1eca
JA
1237 .type = FIO_OPT_INT,
1238 .off1 = td_var_offset(iodepth_batch),
d65db441 1239 .help = "Number of IO buffers to submit in one go",
afdf9352 1240 .parent = "iodepth",
d71c154c 1241 .hide = 1,
a2e6f8ac 1242 .minval = 1,
20eb06bd 1243 .interval = 1,
a2e6f8ac 1244 .def = "1",
e8b0e958 1245 .category = FIO_OPT_C_IO,
0626037e 1246 .group = FIO_OPT_G_IO_BASIC,
4950421a
JA
1247 },
1248 {
1249 .name = "iodepth_batch_complete",
e8b0e958 1250 .lname = "IO Depth batch complete",
4950421a
JA
1251 .type = FIO_OPT_INT,
1252 .off1 = td_var_offset(iodepth_batch_complete),
d65db441 1253 .help = "Number of IO buffers to retrieve in one go",
4950421a 1254 .parent = "iodepth",
d71c154c 1255 .hide = 1,
4950421a 1256 .minval = 0,
20eb06bd 1257 .interval = 1,
4950421a 1258 .def = "1",
e8b0e958 1259 .category = FIO_OPT_C_IO,
0626037e 1260 .group = FIO_OPT_G_IO_BASIC,
214e1eca
JA
1261 },
1262 {
1263 .name = "iodepth_low",
e8b0e958 1264 .lname = "IO Depth batch low",
214e1eca
JA
1265 .type = FIO_OPT_INT,
1266 .off1 = td_var_offset(iodepth_low),
1267 .help = "Low water mark for queuing depth",
afdf9352 1268 .parent = "iodepth",
d71c154c 1269 .hide = 1,
20eb06bd 1270 .interval = 1,
e8b0e958 1271 .category = FIO_OPT_C_IO,
0626037e 1272 .group = FIO_OPT_G_IO_BASIC,
214e1eca
JA
1273 },
1274 {
1275 .name = "size",
e8b0e958 1276 .lname = "Size",
214e1eca 1277 .type = FIO_OPT_STR_VAL,
7bb59102 1278 .cb = str_size_cb,
214e1eca 1279 .help = "Total size of device or files",
20eb06bd 1280 .interval = 1024 * 1024,
e8b0e958
JA
1281 .category = FIO_OPT_C_IO,
1282 .group = FIO_OPT_G_INVALID,
214e1eca 1283 },
aa31f1f1
SL
1284 {
1285 .name = "fill_device",
e8b0e958 1286 .lname = "Fill device",
74586c1e 1287 .alias = "fill_fs",
aa31f1f1
SL
1288 .type = FIO_OPT_BOOL,
1289 .off1 = td_var_offset(fill_device),
1290 .help = "Write until an ENOSPC error occurs",
1291 .def = "0",
e8b0e958
JA
1292 .category = FIO_OPT_C_FILE,
1293 .group = FIO_OPT_G_INVALID,
aa31f1f1 1294 },
214e1eca
JA
1295 {
1296 .name = "filesize",
e8b0e958 1297 .lname = "File size",
214e1eca
JA
1298 .type = FIO_OPT_STR_VAL,
1299 .off1 = td_var_offset(file_size_low),
1300 .off2 = td_var_offset(file_size_high),
c3edbdba 1301 .minval = 1,
214e1eca 1302 .help = "Size of individual files",
20eb06bd 1303 .interval = 1024 * 1024,
e8b0e958
JA
1304 .category = FIO_OPT_C_FILE,
1305 .group = FIO_OPT_G_INVALID,
214e1eca 1306 },
67a1000f
JA
1307 {
1308 .name = "offset",
e8b0e958 1309 .lname = "IO offset",
67a1000f
JA
1310 .alias = "fileoffset",
1311 .type = FIO_OPT_STR_VAL,
1312 .off1 = td_var_offset(start_offset),
1313 .help = "Start IO from this offset",
1314 .def = "0",
20eb06bd 1315 .interval = 1024 * 1024,
e8b0e958
JA
1316 .category = FIO_OPT_C_IO,
1317 .group = FIO_OPT_G_INVALID,
67a1000f 1318 },
2d7cd868
JA
1319 {
1320 .name = "offset_increment",
e8b0e958 1321 .lname = "IO offset increment",
2d7cd868
JA
1322 .type = FIO_OPT_STR_VAL,
1323 .off1 = td_var_offset(offset_increment),
1324 .help = "What is the increment from one offset to the next",
1325 .parent = "offset",
d71c154c 1326 .hide = 1,
2d7cd868 1327 .def = "0",
20eb06bd 1328 .interval = 1024 * 1024,
e8b0e958
JA
1329 .category = FIO_OPT_C_IO,
1330 .group = FIO_OPT_G_INVALID,
2d7cd868 1331 },
214e1eca
JA
1332 {
1333 .name = "bs",
e8b0e958 1334 .lname = "Block size",
d3aad8f2 1335 .alias = "blocksize",
e01b22b8 1336 .type = FIO_OPT_INT,
214e1eca
JA
1337 .off1 = td_var_offset(bs[DDIR_READ]),
1338 .off2 = td_var_offset(bs[DDIR_WRITE]),
c3edbdba 1339 .minval = 1,
214e1eca
JA
1340 .help = "Block size unit",
1341 .def = "4k",
67a1000f 1342 .parent = "rw",
d71c154c 1343 .hide = 1,
20eb06bd 1344 .interval = 512,
e8b0e958
JA
1345 .category = FIO_OPT_C_IO,
1346 .group = FIO_OPT_G_INVALID,
214e1eca 1347 },
2b7a01d0
JA
1348 {
1349 .name = "ba",
e8b0e958 1350 .lname = "Block size align",
2b7a01d0 1351 .alias = "blockalign",
e01b22b8 1352 .type = FIO_OPT_INT,
2b7a01d0
JA
1353 .off1 = td_var_offset(ba[DDIR_READ]),
1354 .off2 = td_var_offset(ba[DDIR_WRITE]),
1355 .minval = 1,
1356 .help = "IO block offset alignment",
1357 .parent = "rw",
d71c154c 1358 .hide = 1,
20eb06bd 1359 .interval = 512,
e8b0e958
JA
1360 .category = FIO_OPT_C_IO,
1361 .group = FIO_OPT_G_INVALID,
2b7a01d0 1362 },
214e1eca
JA
1363 {
1364 .name = "bsrange",
e8b0e958 1365 .lname = "Block size range",
d3aad8f2 1366 .alias = "blocksize_range",
214e1eca
JA
1367 .type = FIO_OPT_RANGE,
1368 .off1 = td_var_offset(min_bs[DDIR_READ]),
1369 .off2 = td_var_offset(max_bs[DDIR_READ]),
1370 .off3 = td_var_offset(min_bs[DDIR_WRITE]),
1371 .off4 = td_var_offset(max_bs[DDIR_WRITE]),
c3edbdba 1372 .minval = 1,
214e1eca 1373 .help = "Set block size range (in more detail than bs)",
67a1000f 1374 .parent = "rw",
d71c154c 1375 .hide = 1,
20eb06bd 1376 .interval = 4096,
e8b0e958
JA
1377 .category = FIO_OPT_C_IO,
1378 .group = FIO_OPT_G_INVALID,
214e1eca 1379 },
564ca972
JA
1380 {
1381 .name = "bssplit",
e8b0e958 1382 .lname = "Block size split",
564ca972
JA
1383 .type = FIO_OPT_STR,
1384 .cb = str_bssplit_cb,
1385 .help = "Set a specific mix of block sizes",
1386 .parent = "rw",
d71c154c 1387 .hide = 1,
e8b0e958
JA
1388 .category = FIO_OPT_C_IO,
1389 .group = FIO_OPT_G_INVALID,
564ca972 1390 },
214e1eca
JA
1391 {
1392 .name = "bs_unaligned",
e8b0e958 1393 .lname = "Block size unaligned",
d3aad8f2 1394 .alias = "blocksize_unaligned",
214e1eca
JA
1395 .type = FIO_OPT_STR_SET,
1396 .off1 = td_var_offset(bs_unaligned),
1397 .help = "Don't sector align IO buffer sizes",
67a1000f 1398 .parent = "rw",
d71c154c 1399 .hide = 1,
e8b0e958
JA
1400 .category = FIO_OPT_C_IO,
1401 .group = FIO_OPT_G_INVALID,
214e1eca
JA
1402 },
1403 {
1404 .name = "randrepeat",
e8b0e958 1405 .lname = "Random repeatable",
214e1eca
JA
1406 .type = FIO_OPT_BOOL,
1407 .off1 = td_var_offset(rand_repeatable),
1408 .help = "Use repeatable random IO pattern",
1409 .def = "1",
67a1000f 1410 .parent = "rw",
d71c154c 1411 .hide = 1,
e8b0e958 1412 .category = FIO_OPT_C_IO,
3ceb458f 1413 .group = FIO_OPT_G_RANDOM,
214e1eca 1414 },
2615cc4b
JA
1415 {
1416 .name = "use_os_rand",
e8b0e958 1417 .lname = "Use OS random",
2615cc4b
JA
1418 .type = FIO_OPT_BOOL,
1419 .off1 = td_var_offset(use_os_rand),
1420 .help = "Set to use OS random generator",
1421 .def = "0",
1422 .parent = "rw",
d71c154c 1423 .hide = 1,
e8b0e958 1424 .category = FIO_OPT_C_IO,
3ceb458f 1425 .group = FIO_OPT_G_RANDOM,
2615cc4b 1426 },
214e1eca
JA
1427 {
1428 .name = "norandommap",
e8b0e958 1429 .lname = "No randommap",
214e1eca
JA
1430 .type = FIO_OPT_STR_SET,
1431 .off1 = td_var_offset(norandommap),
1432 .help = "Accept potential duplicate random blocks",
67a1000f 1433 .parent = "rw",
d71c154c 1434 .hide = 1,
e8b0e958 1435 .category = FIO_OPT_C_IO,
3ceb458f 1436 .group = FIO_OPT_G_RANDOM,
214e1eca 1437 },
2b386d25
JA
1438 {
1439 .name = "softrandommap",
e8b0e958 1440 .lname = "Soft randommap",
2b386d25
JA
1441 .type = FIO_OPT_BOOL,
1442 .off1 = td_var_offset(softrandommap),
f66ab3c8 1443 .help = "Set norandommap if randommap allocation fails",
2b386d25 1444 .parent = "norandommap",
d71c154c 1445 .hide = 1,
2b386d25 1446 .def = "0",
e8b0e958 1447 .category = FIO_OPT_C_IO,
3ceb458f 1448 .group = FIO_OPT_G_RANDOM,
2b386d25 1449 },
214e1eca
JA
1450 {
1451 .name = "nrfiles",
e8b0e958 1452 .lname = "Number of files",
d7c8be03 1453 .alias = "nr_files",
214e1eca
JA
1454 .type = FIO_OPT_INT,
1455 .off1 = td_var_offset(nr_files),
1456 .help = "Split job workload between this number of files",
1457 .def = "1",
20eb06bd 1458 .interval = 1,
e8b0e958
JA
1459 .category = FIO_OPT_C_FILE,
1460 .group = FIO_OPT_G_INVALID,
214e1eca
JA
1461 },
1462 {
1463 .name = "openfiles",
e8b0e958 1464 .lname = "Number of open files",
214e1eca
JA
1465 .type = FIO_OPT_INT,
1466 .off1 = td_var_offset(open_files),
1467 .help = "Number of files to keep open at the same time",
e8b0e958
JA
1468 .category = FIO_OPT_C_FILE,
1469 .group = FIO_OPT_G_INVALID,
214e1eca
JA
1470 },
1471 {
1472 .name = "file_service_type",
e8b0e958 1473 .lname = "File service type",
214e1eca
JA
1474 .type = FIO_OPT_STR,
1475 .cb = str_fst_cb,
1476 .off1 = td_var_offset(file_service_type),
1477 .help = "How to select which file to service next",
1478 .def = "roundrobin",
e8b0e958
JA
1479 .category = FIO_OPT_C_FILE,
1480 .group = FIO_OPT_G_INVALID,
214e1eca
JA
1481 .posval = {
1482 { .ival = "random",
1483 .oval = FIO_FSERVICE_RANDOM,
1484 .help = "Choose a file at random",
1485 },
1486 { .ival = "roundrobin",
1487 .oval = FIO_FSERVICE_RR,
1488 .help = "Round robin select files",
1489 },
a086c257
JA
1490 { .ival = "sequential",
1491 .oval = FIO_FSERVICE_SEQ,
1492 .help = "Finish one file before moving to the next",
1493 },
214e1eca 1494 },
67a1000f 1495 .parent = "nrfiles",
d71c154c 1496 .hide = 1,
67a1000f 1497 },
7bc8c2cf
JA
1498#ifdef FIO_HAVE_FALLOCATE
1499 {
1500 .name = "fallocate",
e8b0e958 1501 .lname = "Fallocate",
a596f047
EG
1502 .type = FIO_OPT_STR,
1503 .off1 = td_var_offset(fallocate_mode),
1504 .help = "Whether pre-allocation is performed when laying out files",
1505 .def = "posix",
e8b0e958
JA
1506 .category = FIO_OPT_C_FILE,
1507 .group = FIO_OPT_G_INVALID,
a596f047
EG
1508 .posval = {
1509 { .ival = "none",
1510 .oval = FIO_FALLOCATE_NONE,
1511 .help = "Do not pre-allocate space",
1512 },
1513 { .ival = "posix",
1514 .oval = FIO_FALLOCATE_POSIX,
1515 .help = "Use posix_fallocate()",
1516 },
1517#ifdef FIO_HAVE_LINUX_FALLOCATE
1518 { .ival = "keep",
1519 .oval = FIO_FALLOCATE_KEEP_SIZE,
1520 .help = "Use fallocate(..., FALLOC_FL_KEEP_SIZE, ...)",
1521 },
7bc8c2cf 1522#endif
a596f047
EG
1523 /* Compatibility with former boolean values */
1524 { .ival = "0",
1525 .oval = FIO_FALLOCATE_NONE,
1526 .help = "Alias for 'none'",
1527 },
1528 { .ival = "1",
1529 .oval = FIO_FALLOCATE_POSIX,
1530 .help = "Alias for 'posix'",
1531 },
1532 },
1533 },
1534#endif /* FIO_HAVE_FALLOCATE */
67a1000f
JA
1535 {
1536 .name = "fadvise_hint",
e8b0e958 1537 .lname = "Fadvise hint",
67a1000f
JA
1538 .type = FIO_OPT_BOOL,
1539 .off1 = td_var_offset(fadvise_hint),
1540 .help = "Use fadvise() to advise the kernel on IO pattern",
1541 .def = "1",
e8b0e958
JA
1542 .category = FIO_OPT_C_FILE,
1543 .group = FIO_OPT_G_INVALID,
214e1eca
JA
1544 },
1545 {
1546 .name = "fsync",
e8b0e958 1547 .lname = "Fsync",
214e1eca
JA
1548 .type = FIO_OPT_INT,
1549 .off1 = td_var_offset(fsync_blocks),
1550 .help = "Issue fsync for writes every given number of blocks",
1551 .def = "0",
20eb06bd 1552 .interval = 1,
e8b0e958
JA
1553 .category = FIO_OPT_C_FILE,
1554 .group = FIO_OPT_G_INVALID,
214e1eca 1555 },
5f9099ea
JA
1556 {
1557 .name = "fdatasync",
e8b0e958 1558 .lname = "Fdatasync",
5f9099ea
JA
1559 .type = FIO_OPT_INT,
1560 .off1 = td_var_offset(fdatasync_blocks),
1561 .help = "Issue fdatasync for writes every given number of blocks",
1562 .def = "0",
20eb06bd 1563 .interval = 1,
e8b0e958
JA
1564 .category = FIO_OPT_C_FILE,
1565 .group = FIO_OPT_G_INVALID,
5f9099ea 1566 },
1ef2b6be
JA
1567 {
1568 .name = "write_barrier",
e8b0e958 1569 .lname = "Write barrier",
1ef2b6be
JA
1570 .type = FIO_OPT_INT,
1571 .off1 = td_var_offset(barrier_blocks),
1572 .help = "Make every Nth write a barrier write",
1573 .def = "0",
20eb06bd 1574 .interval = 1,
e8b0e958
JA
1575 .category = FIO_OPT_C_IO,
1576 .group = FIO_OPT_G_INVALID,
1ef2b6be 1577 },
44f29692
JA
1578#ifdef FIO_HAVE_SYNC_FILE_RANGE
1579 {
1580 .name = "sync_file_range",
e8b0e958 1581 .lname = "Sync file range",
44f29692
JA
1582 .posval = {
1583 { .ival = "wait_before",
1584 .oval = SYNC_FILE_RANGE_WAIT_BEFORE,
1585 .help = "SYNC_FILE_RANGE_WAIT_BEFORE",
3843deb3 1586 .or = 1,
44f29692
JA
1587 },
1588 { .ival = "write",
1589 .oval = SYNC_FILE_RANGE_WRITE,
1590 .help = "SYNC_FILE_RANGE_WRITE",
3843deb3 1591 .or = 1,
44f29692
JA
1592 },
1593 {
1594 .ival = "wait_after",
1595 .oval = SYNC_FILE_RANGE_WAIT_AFTER,
1596 .help = "SYNC_FILE_RANGE_WAIT_AFTER",
3843deb3 1597 .or = 1,
44f29692
JA
1598 },
1599 },
3843deb3 1600 .type = FIO_OPT_STR_MULTI,
44f29692
JA
1601 .cb = str_sfr_cb,
1602 .off1 = td_var_offset(sync_file_range),
1603 .help = "Use sync_file_range()",
e8b0e958
JA
1604 .category = FIO_OPT_C_FILE,
1605 .group = FIO_OPT_G_INVALID,
44f29692
JA
1606 },
1607#endif
214e1eca
JA
1608 {
1609 .name = "direct",
e8b0e958 1610 .lname = "Direct I/O",
214e1eca
JA
1611 .type = FIO_OPT_BOOL,
1612 .off1 = td_var_offset(odirect),
1613 .help = "Use O_DIRECT IO (negates buffered)",
1614 .def = "0",
a01a1bc5 1615 .inverse = "buffered",
e8b0e958 1616 .category = FIO_OPT_C_IO,
3ceb458f 1617 .group = FIO_OPT_G_IO_TYPE,
214e1eca
JA
1618 },
1619 {
1620 .name = "buffered",
e8b0e958 1621 .lname = "Buffered I/O",
214e1eca
JA
1622 .type = FIO_OPT_BOOL,
1623 .off1 = td_var_offset(odirect),
1624 .neg = 1,
1625 .help = "Use buffered IO (negates direct)",
1626 .def = "1",
a01a1bc5 1627 .inverse = "direct",
e8b0e958 1628 .category = FIO_OPT_C_IO,
3ceb458f 1629 .group = FIO_OPT_G_IO_TYPE,
214e1eca
JA
1630 },
1631 {
1632 .name = "overwrite",
e8b0e958 1633 .lname = "Overwrite",
214e1eca
JA
1634 .type = FIO_OPT_BOOL,
1635 .off1 = td_var_offset(overwrite),
1636 .help = "When writing, set whether to overwrite current data",
1637 .def = "0",
e8b0e958
JA
1638 .category = FIO_OPT_C_FILE,
1639 .group = FIO_OPT_G_INVALID,
214e1eca
JA
1640 },
1641 {
1642 .name = "loops",
e8b0e958 1643 .lname = "Loops",
214e1eca
JA
1644 .type = FIO_OPT_INT,
1645 .off1 = td_var_offset(loops),
1646 .help = "Number of times to run the job",
1647 .def = "1",
20eb06bd 1648 .interval = 1,
e8b0e958 1649 .category = FIO_OPT_C_GENERAL,
a1f6afec 1650 .group = FIO_OPT_G_RUNTIME,
214e1eca
JA
1651 },
1652 {
1653 .name = "numjobs",
e8b0e958 1654 .lname = "Number of jobs",
214e1eca
JA
1655 .type = FIO_OPT_INT,
1656 .off1 = td_var_offset(numjobs),
1657 .help = "Duplicate this job this many times",
1658 .def = "1",
20eb06bd 1659 .interval = 1,
e8b0e958 1660 .category = FIO_OPT_C_GENERAL,
a1f6afec 1661 .group = FIO_OPT_G_RUNTIME,
214e1eca
JA
1662 },
1663 {
1664 .name = "startdelay",
e8b0e958 1665 .lname = "Start delay",
a5737c93 1666 .type = FIO_OPT_STR_VAL_TIME,
214e1eca
JA
1667 .off1 = td_var_offset(start_delay),
1668 .help = "Only start job when this period has passed",
1669 .def = "0",
e8b0e958 1670 .category = FIO_OPT_C_GENERAL,
a1f6afec 1671 .group = FIO_OPT_G_RUNTIME,
214e1eca
JA
1672 },
1673 {
1674 .name = "runtime",
e8b0e958 1675 .lname = "Runtime",
214e1eca
JA
1676 .alias = "timeout",
1677 .type = FIO_OPT_STR_VAL_TIME,
1678 .off1 = td_var_offset(timeout),
1679 .help = "Stop workload when this amount of time has passed",
1680 .def = "0",
e8b0e958 1681 .category = FIO_OPT_C_GENERAL,
a1f6afec 1682 .group = FIO_OPT_G_RUNTIME,
214e1eca 1683 },
cf4464ca
JA
1684 {
1685 .name = "time_based",
e8b0e958 1686 .lname = "Time based",
cf4464ca
JA
1687 .type = FIO_OPT_STR_SET,
1688 .off1 = td_var_offset(time_based),
1689 .help = "Keep running until runtime/timeout is met",
e8b0e958 1690 .category = FIO_OPT_C_GENERAL,
a1f6afec 1691 .group = FIO_OPT_G_RUNTIME,
cf4464ca 1692 },
721938ae
JA
1693 {
1694 .name = "ramp_time",
e8b0e958 1695 .lname = "Ramp time",
721938ae
JA
1696 .type = FIO_OPT_STR_VAL_TIME,
1697 .off1 = td_var_offset(ramp_time),
1698 .help = "Ramp up time before measuring performance",
e8b0e958 1699 .category = FIO_OPT_C_GENERAL,
a1f6afec 1700 .group = FIO_OPT_G_RUNTIME,
721938ae 1701 },
c223da83
JA
1702 {
1703 .name = "clocksource",
e8b0e958 1704 .lname = "Clock source",
c223da83
JA
1705 .type = FIO_OPT_STR,
1706 .cb = fio_clock_source_cb,
1707 .off1 = td_var_offset(clocksource),
1708 .help = "What type of timing source to use",
e8b0e958 1709 .category = FIO_OPT_C_GENERAL,
10860056 1710 .group = FIO_OPT_G_CLOCK,
c223da83
JA
1711 .posval = {
1712 { .ival = "gettimeofday",
1713 .oval = CS_GTOD,
1714 .help = "Use gettimeofday(2) for timing",
1715 },
1716 { .ival = "clock_gettime",
1717 .oval = CS_CGETTIME,
1718 .help = "Use clock_gettime(2) for timing",
1719 },
1720#ifdef ARCH_HAVE_CPU_CLOCK
1721 { .ival = "cpu",
1722 .oval = CS_CPUCLOCK,
1723 .help = "Use CPU private clock",
1724 },
1725#endif
1726 },
1727 },
214e1eca
JA
1728 {
1729 .name = "mem",
d3aad8f2 1730 .alias = "iomem",
e8b0e958 1731 .lname = "I/O Memory",
214e1eca
JA
1732 .type = FIO_OPT_STR,
1733 .cb = str_mem_cb,
1734 .off1 = td_var_offset(mem_type),
1735 .help = "Backing type for IO buffers",
1736 .def = "malloc",
e8b0e958
JA
1737 .category = FIO_OPT_C_IO,
1738 .group = FIO_OPT_G_INVALID,
214e1eca
JA
1739 .posval = {
1740 { .ival = "malloc",
1741 .oval = MEM_MALLOC,
1742 .help = "Use malloc(3) for IO buffers",
1743 },
37c8cdfe
JA
1744 { .ival = "shm",
1745 .oval = MEM_SHM,
1746 .help = "Use shared memory segments for IO buffers",
1747 },
214e1eca
JA
1748#ifdef FIO_HAVE_HUGETLB
1749 { .ival = "shmhuge",
1750 .oval = MEM_SHMHUGE,
1751 .help = "Like shm, but use huge pages",
1752 },
b370e46a 1753#endif
37c8cdfe
JA
1754 { .ival = "mmap",
1755 .oval = MEM_MMAP,
1756 .help = "Use mmap(2) (file or anon) for IO buffers",
1757 },
214e1eca
JA
1758#ifdef FIO_HAVE_HUGETLB
1759 { .ival = "mmaphuge",
1760 .oval = MEM_MMAPHUGE,
1761 .help = "Like mmap, but use huge pages",
1762 },
1763#endif
1764 },
1765 },
d529ee19
JA
1766 {
1767 .name = "iomem_align",
1768 .alias = "mem_align",
e8b0e958 1769 .lname = "I/O memory alignment",
d529ee19
JA
1770 .type = FIO_OPT_INT,
1771 .off1 = td_var_offset(mem_align),
1772 .minval = 0,
1773 .help = "IO memory buffer offset alignment",
1774 .def = "0",
1775 .parent = "iomem",
d71c154c 1776 .hide = 1,
e8b0e958
JA
1777 .category = FIO_OPT_C_IO,
1778 .group = FIO_OPT_G_INVALID,
d529ee19 1779 },
214e1eca
JA
1780 {
1781 .name = "verify",
e8b0e958 1782 .lname = "Verify",
214e1eca
JA
1783 .type = FIO_OPT_STR,
1784 .off1 = td_var_offset(verify),
1785 .help = "Verify data written",
5d7c5d34 1786 .cb = str_verify_cb,
214e1eca 1787 .def = "0",
e8b0e958 1788 .category = FIO_OPT_C_IO,
3ceb458f 1789 .group = FIO_OPT_G_VERIFY,
214e1eca
JA
1790 .posval = {
1791 { .ival = "0",
1792 .oval = VERIFY_NONE,
1793 .help = "Don't do IO verification",
1794 },
fcca4b58
JA
1795 { .ival = "md5",
1796 .oval = VERIFY_MD5,
1797 .help = "Use md5 checksums for verification",
1798 },
d77a7af3
JA
1799 { .ival = "crc64",
1800 .oval = VERIFY_CRC64,
1801 .help = "Use crc64 checksums for verification",
1802 },
214e1eca
JA
1803 { .ival = "crc32",
1804 .oval = VERIFY_CRC32,
1805 .help = "Use crc32 checksums for verification",
1806 },
af497e6a 1807 { .ival = "crc32c-intel",
e3aaafc4
JA
1808 .oval = VERIFY_CRC32C,
1809 .help = "Use crc32c checksums for verification (hw assisted, if available)",
af497e6a 1810 },
bac39e0e
JA
1811 { .ival = "crc32c",
1812 .oval = VERIFY_CRC32C,
e3aaafc4 1813 .help = "Use crc32c checksums for verification (hw assisted, if available)",
bac39e0e 1814 },
969f7ed3
JA
1815 { .ival = "crc16",
1816 .oval = VERIFY_CRC16,
1817 .help = "Use crc16 checksums for verification",
1818 },
1e154bdb
JA
1819 { .ival = "crc7",
1820 .oval = VERIFY_CRC7,
1821 .help = "Use crc7 checksums for verification",
1822 },
7c353ceb
JA
1823 { .ival = "sha1",
1824 .oval = VERIFY_SHA1,
1825 .help = "Use sha1 checksums for verification",
1826 },
cd14cc10
JA
1827 { .ival = "sha256",
1828 .oval = VERIFY_SHA256,
1829 .help = "Use sha256 checksums for verification",
1830 },
1831 { .ival = "sha512",
1832 .oval = VERIFY_SHA512,
1833 .help = "Use sha512 checksums for verification",
1834 },
7437ee87
SL
1835 { .ival = "meta",
1836 .oval = VERIFY_META,
1837 .help = "Use io information",
1838 },
36690c9b
JA
1839 {
1840 .ival = "null",
1841 .oval = VERIFY_NULL,
1842 .help = "Pretend to verify",
1843 },
214e1eca
JA
1844 },
1845 },
005c565a
JA
1846 {
1847 .name = "do_verify",
e8b0e958 1848 .lname = "Perform verify step",
68e1f29a 1849 .type = FIO_OPT_BOOL,
005c565a
JA
1850 .off1 = td_var_offset(do_verify),
1851 .help = "Run verification stage after write",
1852 .def = "1",
1853 .parent = "verify",
d71c154c 1854 .hide = 1,
e8b0e958
JA
1855 .category = FIO_OPT_C_IO,
1856 .group = FIO_OPT_G_VERIFY,
005c565a 1857 },
160b966d
JA
1858 {
1859 .name = "verifysort",
e8b0e958 1860 .lname = "Verify sort",
160b966d
JA
1861 .type = FIO_OPT_BOOL,
1862 .off1 = td_var_offset(verifysort),
1863 .help = "Sort written verify blocks for read back",
1864 .def = "1",
c83f2df1 1865 .parent = "verify",
d71c154c 1866 .hide = 1,
e8b0e958
JA
1867 .category = FIO_OPT_C_IO,
1868 .group = FIO_OPT_G_VERIFY,
160b966d 1869 },
3f9f4e26 1870 {
a59e170d 1871 .name = "verify_interval",
e8b0e958 1872 .lname = "Verify interval",
e01b22b8 1873 .type = FIO_OPT_INT,
a59e170d 1874 .off1 = td_var_offset(verify_interval),
819a9680 1875 .minval = 2 * sizeof(struct verify_header),
a59e170d 1876 .help = "Store verify buffer header every N bytes",
afdf9352 1877 .parent = "verify",
d71c154c 1878 .hide = 1,
20eb06bd 1879 .interval = 2 * sizeof(struct verify_header),
e8b0e958
JA
1880 .category = FIO_OPT_C_IO,
1881 .group = FIO_OPT_G_VERIFY,
3f9f4e26 1882 },
546a9142 1883 {
a59e170d 1884 .name = "verify_offset",
e8b0e958 1885 .lname = "Verify offset",
e01b22b8 1886 .type = FIO_OPT_INT,
a59e170d 1887 .help = "Offset verify header location by N bytes",
546a9142 1888 .def = "0",
5ec10eaa 1889 .cb = str_verify_offset_cb,
afdf9352 1890 .parent = "verify",
d71c154c 1891 .hide = 1,
e8b0e958
JA
1892 .category = FIO_OPT_C_IO,
1893 .group = FIO_OPT_G_VERIFY,
546a9142 1894 },
e28218f3
SL
1895 {
1896 .name = "verify_pattern",
e8b0e958 1897 .lname = "Verify pattern",
0e92f873 1898 .type = FIO_OPT_STR,
e28218f3
SL
1899 .cb = str_verify_pattern_cb,
1900 .help = "Fill pattern for IO buffers",
1901 .parent = "verify",
d71c154c 1902 .hide = 1,
e8b0e958
JA
1903 .category = FIO_OPT_C_IO,
1904 .group = FIO_OPT_G_VERIFY,
e28218f3 1905 },
a12a3b4d
JA
1906 {
1907 .name = "verify_fatal",
e8b0e958 1908 .lname = "Verify fatal",
68e1f29a 1909 .type = FIO_OPT_BOOL,
a12a3b4d
JA
1910 .off1 = td_var_offset(verify_fatal),
1911 .def = "0",
1912 .help = "Exit on a single verify failure, don't continue",
1913 .parent = "verify",
d71c154c 1914 .hide = 1,
e8b0e958
JA
1915 .category = FIO_OPT_C_IO,
1916 .group = FIO_OPT_G_VERIFY,
a12a3b4d 1917 },
b463e936
JA
1918 {
1919 .name = "verify_dump",
e8b0e958 1920 .lname = "Verify dump",
b463e936
JA
1921 .type = FIO_OPT_BOOL,
1922 .off1 = td_var_offset(verify_dump),
ef71e317 1923 .def = "0",
b463e936
JA
1924 .help = "Dump contents of good and bad blocks on failure",
1925 .parent = "verify",
d71c154c 1926 .hide = 1,
e8b0e958
JA
1927 .category = FIO_OPT_C_IO,
1928 .group = FIO_OPT_G_VERIFY,
b463e936 1929 },
e8462bd8
JA
1930 {
1931 .name = "verify_async",
e8b0e958 1932 .lname = "Verify asynchronously",
e8462bd8
JA
1933 .type = FIO_OPT_INT,
1934 .off1 = td_var_offset(verify_async),
1935 .def = "0",
1936 .help = "Number of async verifier threads to use",
1937 .parent = "verify",
d71c154c 1938 .hide = 1,
e8b0e958
JA
1939 .category = FIO_OPT_C_IO,
1940 .group = FIO_OPT_G_VERIFY,
e8462bd8 1941 },
9e144189
JA
1942 {
1943 .name = "verify_backlog",
e8b0e958 1944 .lname = "Verify backlog",
9e144189
JA
1945 .type = FIO_OPT_STR_VAL,
1946 .off1 = td_var_offset(verify_backlog),
1947 .help = "Verify after this number of blocks are written",
1948 .parent = "verify",
d71c154c 1949 .hide = 1,
e8b0e958
JA
1950 .category = FIO_OPT_C_IO,
1951 .group = FIO_OPT_G_VERIFY,
9e144189
JA
1952 },
1953 {
1954 .name = "verify_backlog_batch",
e8b0e958 1955 .lname = "Verify backlog batch",
9e144189
JA
1956 .type = FIO_OPT_INT,
1957 .off1 = td_var_offset(verify_batch),
1958 .help = "Verify this number of IO blocks",
0d29de83 1959 .parent = "verify",
d71c154c 1960 .hide = 1,
e8b0e958
JA
1961 .category = FIO_OPT_C_IO,
1962 .group = FIO_OPT_G_VERIFY,
9e144189 1963 },
e8462bd8
JA
1964#ifdef FIO_HAVE_CPU_AFFINITY
1965 {
1966 .name = "verify_async_cpus",
e8b0e958 1967 .lname = "Async verify CPUs",
e8462bd8
JA
1968 .type = FIO_OPT_STR,
1969 .cb = str_verify_cpus_allowed_cb,
1970 .help = "Set CPUs allowed for async verify threads",
1971 .parent = "verify_async",
d71c154c 1972 .hide = 1,
e8b0e958
JA
1973 .category = FIO_OPT_C_IO,
1974 .group = FIO_OPT_G_VERIFY,
e8462bd8 1975 },
0d29de83
JA
1976#endif
1977#ifdef FIO_HAVE_TRIM
1978 {
1979 .name = "trim_percentage",
e8b0e958 1980 .lname = "Trim percentage",
0d29de83
JA
1981 .type = FIO_OPT_INT,
1982 .cb = str_verify_trim_cb,
20eb06bd 1983 .minval = 0,
0d29de83
JA
1984 .maxval = 100,
1985 .help = "Number of verify blocks to discard/trim",
1986 .parent = "verify",
1987 .def = "0",
20eb06bd 1988 .interval = 1,
d71c154c 1989 .hide = 1,
e8b0e958
JA
1990 .category = FIO_OPT_C_IO,
1991 .group = FIO_OPT_G_TRIM,
0d29de83
JA
1992 },
1993 {
1994 .name = "trim_verify_zero",
e8b0e958 1995 .lname = "Verify trim zero",
20eb06bd 1996 .type = FIO_OPT_BOOL,
0d29de83
JA
1997 .help = "Verify that trim/discarded blocks are returned as zeroes",
1998 .off1 = td_var_offset(trim_zero),
1999 .parent = "trim_percentage",
d71c154c 2000 .hide = 1,
0d29de83 2001 .def = "1",
e8b0e958
JA
2002 .category = FIO_OPT_C_IO,
2003 .group = FIO_OPT_G_TRIM,
0d29de83
JA
2004 },
2005 {
2006 .name = "trim_backlog",
e8b0e958 2007 .lname = "Trim backlog",
0d29de83
JA
2008 .type = FIO_OPT_STR_VAL,
2009 .off1 = td_var_offset(trim_backlog),
2010 .help = "Trim after this number of blocks are written",
2011 .parent = "trim_percentage",
d71c154c 2012 .hide = 1,
20eb06bd 2013 .interval = 1,
e8b0e958
JA
2014 .category = FIO_OPT_C_IO,
2015 .group = FIO_OPT_G_TRIM,
0d29de83
JA
2016 },
2017 {
2018 .name = "trim_backlog_batch",
e8b0e958 2019 .lname = "Trim backlog batch",
0d29de83
JA
2020 .type = FIO_OPT_INT,
2021 .off1 = td_var_offset(trim_batch),
2022 .help = "Trim this number of IO blocks",
2023 .parent = "trim_percentage",
d71c154c 2024 .hide = 1,
20eb06bd 2025 .interval = 1,
e8b0e958
JA
2026 .category = FIO_OPT_C_IO,
2027 .group = FIO_OPT_G_TRIM,
0d29de83 2028 },
e8462bd8 2029#endif
214e1eca
JA
2030 {
2031 .name = "write_iolog",
e8b0e958 2032 .lname = "Write I/O log",
214e1eca
JA
2033 .type = FIO_OPT_STR_STORE,
2034 .off1 = td_var_offset(write_iolog_file),
2035 .help = "Store IO pattern to file",
e8b0e958
JA
2036 .category = FIO_OPT_C_IO,
2037 .group = FIO_OPT_G_IOLOG,
214e1eca
JA
2038 },
2039 {
2040 .name = "read_iolog",
e8b0e958 2041 .lname = "Read I/O log",
214e1eca
JA
2042 .type = FIO_OPT_STR_STORE,
2043 .off1 = td_var_offset(read_iolog_file),
2044 .help = "Playback IO pattern from file",
e8b0e958
JA
2045 .category = FIO_OPT_C_IO,
2046 .group = FIO_OPT_G_IOLOG,
214e1eca 2047 },
64bbb865
DN
2048 {
2049 .name = "replay_no_stall",
e8b0e958 2050 .lname = "Don't stall on replay",
20eb06bd 2051 .type = FIO_OPT_BOOL,
64bbb865
DN
2052 .off1 = td_var_offset(no_stall),
2053 .def = "0",
87e7a972 2054 .parent = "read_iolog",
d71c154c 2055 .hide = 1,
64bbb865 2056 .help = "Playback IO pattern file as fast as possible without stalls",
e8b0e958
JA
2057 .category = FIO_OPT_C_IO,
2058 .group = FIO_OPT_G_IOLOG,
64bbb865 2059 },
d1c46c04
DN
2060 {
2061 .name = "replay_redirect",
e8b0e958 2062 .lname = "Redirect device for replay",
d1c46c04
DN
2063 .type = FIO_OPT_STR_STORE,
2064 .off1 = td_var_offset(replay_redirect),
2065 .parent = "read_iolog",
d71c154c 2066 .hide = 1,
d1c46c04 2067 .help = "Replay all I/O onto this device, regardless of trace device",
e8b0e958
JA
2068 .category = FIO_OPT_C_IO,
2069 .group = FIO_OPT_G_IOLOG,
d1c46c04 2070 },
214e1eca
JA
2071 {
2072 .name = "exec_prerun",
e8b0e958 2073 .lname = "Pre-execute runnable",
214e1eca
JA
2074 .type = FIO_OPT_STR_STORE,
2075 .off1 = td_var_offset(exec_prerun),
2076 .help = "Execute this file prior to running job",
e8b0e958
JA
2077 .category = FIO_OPT_C_GENERAL,
2078 .group = FIO_OPT_G_INVALID,
214e1eca
JA
2079 },
2080 {
2081 .name = "exec_postrun",
e8b0e958 2082 .lname = "Post-execute runnable",
214e1eca
JA
2083 .type = FIO_OPT_STR_STORE,
2084 .off1 = td_var_offset(exec_postrun),
2085 .help = "Execute this file after running job",
e8b0e958
JA
2086 .category = FIO_OPT_C_GENERAL,
2087 .group = FIO_OPT_G_INVALID,
214e1eca
JA
2088 },
2089#ifdef FIO_HAVE_IOSCHED_SWITCH
2090 {
2091 .name = "ioscheduler",
e8b0e958 2092 .lname = "I/O scheduler",
214e1eca
JA
2093 .type = FIO_OPT_STR_STORE,
2094 .off1 = td_var_offset(ioscheduler),
2095 .help = "Use this IO scheduler on the backing device",
e8b0e958
JA
2096 .category = FIO_OPT_C_FILE,
2097 .group = FIO_OPT_G_INVALID,
214e1eca
JA
2098 },
2099#endif
2100 {
2101 .name = "zonesize",
e8b0e958 2102 .lname = "Zone size",
214e1eca
JA
2103 .type = FIO_OPT_STR_VAL,
2104 .off1 = td_var_offset(zone_size),
ed335855
SN
2105 .help = "Amount of data to read per zone",
2106 .def = "0",
20eb06bd 2107 .interval = 1024 * 1024,
e8b0e958
JA
2108 .category = FIO_OPT_C_IO,
2109 .group = FIO_OPT_G_ZONE,
ed335855
SN
2110 },
2111 {
2112 .name = "zonerange",
e8b0e958 2113 .lname = "Zone range",
ed335855
SN
2114 .type = FIO_OPT_STR_VAL,
2115 .off1 = td_var_offset(zone_range),
214e1eca
JA
2116 .help = "Give size of an IO zone",
2117 .def = "0",
20eb06bd 2118 .interval = 1024 * 1024,
e8b0e958
JA
2119 .category = FIO_OPT_C_IO,
2120 .group = FIO_OPT_G_ZONE,
214e1eca
JA
2121 },
2122 {
2123 .name = "zoneskip",
e8b0e958 2124 .lname = "Zone skip",
214e1eca
JA
2125 .type = FIO_OPT_STR_VAL,
2126 .off1 = td_var_offset(zone_skip),
2127 .help = "Space between IO zones",
2128 .def = "0",
20eb06bd 2129 .interval = 1024 * 1024,
e8b0e958
JA
2130 .category = FIO_OPT_C_IO,
2131 .group = FIO_OPT_G_ZONE,
214e1eca
JA
2132 },
2133 {
2134 .name = "lockmem",
e8b0e958 2135 .lname = "Lock memory",
214e1eca
JA
2136 .type = FIO_OPT_STR_VAL,
2137 .cb = str_lockmem_cb,
2138 .help = "Lock down this amount of memory",
2139 .def = "0",
20eb06bd 2140 .interval = 1024 * 1024,
e8b0e958
JA
2141 .category = FIO_OPT_C_GENERAL,
2142 .group = FIO_OPT_G_INVALID,
214e1eca 2143 },
214e1eca
JA
2144 {
2145 .name = "rwmixread",
e8b0e958 2146 .lname = "Read/write mix read",
214e1eca 2147 .type = FIO_OPT_INT,
cb499fc4 2148 .cb = str_rwmix_read_cb,
214e1eca
JA
2149 .maxval = 100,
2150 .help = "Percentage of mixed workload that is reads",
2151 .def = "50",
20eb06bd 2152 .interval = 5,
90265353 2153 .inverse = "rwmixwrite",
e8b0e958
JA
2154 .category = FIO_OPT_C_IO,
2155 .group = FIO_OPT_G_RWMIX,
214e1eca
JA
2156 },
2157 {
2158 .name = "rwmixwrite",
e8b0e958 2159 .lname = "Read/write mix write",
214e1eca 2160 .type = FIO_OPT_INT,
cb499fc4 2161 .cb = str_rwmix_write_cb,
214e1eca
JA
2162 .maxval = 100,
2163 .help = "Percentage of mixed workload that is writes",
2164 .def = "50",
20eb06bd 2165 .interval = 5,
90265353 2166 .inverse = "rwmixread",
e8b0e958
JA
2167 .category = FIO_OPT_C_IO,
2168 .group = FIO_OPT_G_RWMIX,
214e1eca 2169 },
afdf9352
JA
2170 {
2171 .name = "rwmixcycle",
e8b0e958 2172 .lname = "Read/write mix cycle",
15ca150e 2173 .type = FIO_OPT_DEPRECATED,
e8b0e958
JA
2174 .category = FIO_OPT_C_IO,
2175 .group = FIO_OPT_G_RWMIX,
afdf9352 2176 },
214e1eca
JA
2177 {
2178 .name = "nice",
e8b0e958 2179 .lname = "Nice",
214e1eca
JA
2180 .type = FIO_OPT_INT,
2181 .off1 = td_var_offset(nice),
2182 .help = "Set job CPU nice value",
2183 .minval = -19,
2184 .maxval = 20,
2185 .def = "0",
20eb06bd 2186 .interval = 1,
e8b0e958 2187 .category = FIO_OPT_C_GENERAL,
10860056 2188 .group = FIO_OPT_G_CRED,
214e1eca
JA
2189 },
2190#ifdef FIO_HAVE_IOPRIO
2191 {
2192 .name = "prio",
e8b0e958 2193 .lname = "I/O nice priority",
214e1eca
JA
2194 .type = FIO_OPT_INT,
2195 .cb = str_prio_cb,
2196 .help = "Set job IO priority value",
2197 .minval = 0,
2198 .maxval = 7,
20eb06bd 2199 .interval = 1,
e8b0e958 2200 .category = FIO_OPT_C_GENERAL,
10860056 2201 .group = FIO_OPT_G_CRED,
214e1eca
JA
2202 },
2203 {
2204 .name = "prioclass",
e8b0e958 2205 .lname = "I/O nice priority class",
214e1eca
JA
2206 .type = FIO_OPT_INT,
2207 .cb = str_prioclass_cb,
2208 .help = "Set job IO priority class",
2209 .minval = 0,
2210 .maxval = 3,
20eb06bd 2211 .interval = 1,
e8b0e958 2212 .category = FIO_OPT_C_GENERAL,
10860056 2213 .group = FIO_OPT_G_CRED,
214e1eca
JA
2214 },
2215#endif
2216 {
2217 .name = "thinktime",
e8b0e958 2218 .lname = "Thinktime",
214e1eca
JA
2219 .type = FIO_OPT_INT,
2220 .off1 = td_var_offset(thinktime),
2221 .help = "Idle time between IO buffers (usec)",
2222 .def = "0",
e8b0e958 2223 .category = FIO_OPT_C_IO,
3ceb458f 2224 .group = FIO_OPT_G_THINKTIME,
214e1eca
JA
2225 },
2226 {
2227 .name = "thinktime_spin",
e8b0e958 2228 .lname = "Thinktime spin",
214e1eca
JA
2229 .type = FIO_OPT_INT,
2230 .off1 = td_var_offset(thinktime_spin),
2231 .help = "Start think time by spinning this amount (usec)",
2232 .def = "0",
afdf9352 2233 .parent = "thinktime",
d71c154c 2234 .hide = 1,
e8b0e958 2235 .category = FIO_OPT_C_IO,
3ceb458f 2236 .group = FIO_OPT_G_THINKTIME,
214e1eca
JA
2237 },
2238 {
2239 .name = "thinktime_blocks",
e8b0e958 2240 .lname = "Thinktime blocks",
214e1eca
JA
2241 .type = FIO_OPT_INT,
2242 .off1 = td_var_offset(thinktime_blocks),
2243 .help = "IO buffer period between 'thinktime'",
2244 .def = "1",
afdf9352 2245 .parent = "thinktime",
d71c154c 2246 .hide = 1,
e8b0e958 2247 .category = FIO_OPT_C_IO,
3ceb458f 2248 .group = FIO_OPT_G_THINKTIME,
214e1eca
JA
2249 },
2250 {
2251 .name = "rate",
e8b0e958 2252 .lname = "I/O rate",
e01b22b8 2253 .type = FIO_OPT_INT,
581e7141
JA
2254 .off1 = td_var_offset(rate[0]),
2255 .off2 = td_var_offset(rate[1]),
214e1eca 2256 .help = "Set bandwidth rate",
e8b0e958
JA
2257 .category = FIO_OPT_C_IO,
2258 .group = FIO_OPT_G_RATE,
214e1eca
JA
2259 },
2260 {
2261 .name = "ratemin",
e8b0e958 2262 .lname = "I/O min rate",
e01b22b8 2263 .type = FIO_OPT_INT,
581e7141
JA
2264 .off1 = td_var_offset(ratemin[0]),
2265 .off2 = td_var_offset(ratemin[1]),
4e991c23 2266 .help = "Job must meet this rate or it will be shutdown",
afdf9352 2267 .parent = "rate",
d71c154c 2268 .hide = 1,
e8b0e958
JA
2269 .category = FIO_OPT_C_IO,
2270 .group = FIO_OPT_G_RATE,
4e991c23
JA
2271 },
2272 {
2273 .name = "rate_iops",
e8b0e958 2274 .lname = "I/O rate IOPS",
e01b22b8 2275 .type = FIO_OPT_INT,
581e7141
JA
2276 .off1 = td_var_offset(rate_iops[0]),
2277 .off2 = td_var_offset(rate_iops[1]),
4e991c23 2278 .help = "Limit IO used to this number of IO operations/sec",
d71c154c 2279 .hide = 1,
e8b0e958
JA
2280 .category = FIO_OPT_C_IO,
2281 .group = FIO_OPT_G_RATE,
4e991c23
JA
2282 },
2283 {
2284 .name = "rate_iops_min",
e8b0e958 2285 .lname = "I/O min rate IOPS",
e01b22b8 2286 .type = FIO_OPT_INT,
581e7141
JA
2287 .off1 = td_var_offset(rate_iops_min[0]),
2288 .off2 = td_var_offset(rate_iops_min[1]),
03e20d68 2289 .help = "Job must meet this rate or it will be shut down",
afdf9352 2290 .parent = "rate_iops",
d71c154c 2291 .hide = 1,
e8b0e958
JA
2292 .category = FIO_OPT_C_IO,
2293 .group = FIO_OPT_G_RATE,
214e1eca
JA
2294 },
2295 {
2296 .name = "ratecycle",
e8b0e958 2297 .lname = "I/O rate cycle",
214e1eca
JA
2298 .type = FIO_OPT_INT,
2299 .off1 = td_var_offset(ratecycle),
2300 .help = "Window average for rate limits (msec)",
2301 .def = "1000",
afdf9352 2302 .parent = "rate",
d71c154c 2303 .hide = 1,
e8b0e958
JA
2304 .category = FIO_OPT_C_IO,
2305 .group = FIO_OPT_G_RATE,
214e1eca
JA
2306 },
2307 {
2308 .name = "invalidate",
e8b0e958 2309 .lname = "Cache invalidate",
214e1eca
JA
2310 .type = FIO_OPT_BOOL,
2311 .off1 = td_var_offset(invalidate_cache),
2312 .help = "Invalidate buffer/page cache prior to running job",
2313 .def = "1",
e8b0e958 2314 .category = FIO_OPT_C_IO,
3ceb458f 2315 .group = FIO_OPT_G_IO_TYPE,
214e1eca
JA
2316 },
2317 {
2318 .name = "sync",
e8b0e958 2319 .lname = "Synchronous I/O",
214e1eca
JA
2320 .type = FIO_OPT_BOOL,
2321 .off1 = td_var_offset(sync_io),
2322 .help = "Use O_SYNC for buffered writes",
2323 .def = "0",
67a1000f 2324 .parent = "buffered",
d71c154c 2325 .hide = 1,
e8b0e958 2326 .category = FIO_OPT_C_IO,
3ceb458f 2327 .group = FIO_OPT_G_IO_TYPE,
214e1eca
JA
2328 },
2329 {
2330 .name = "bwavgtime",
e8b0e958 2331 .lname = "Bandwidth average time",
214e1eca
JA
2332 .type = FIO_OPT_INT,
2333 .off1 = td_var_offset(bw_avg_time),
5ec10eaa
JA
2334 .help = "Time window over which to calculate bandwidth"
2335 " (msec)",
214e1eca 2336 .def = "500",
c8eeb9df 2337 .parent = "write_bw_log",
d71c154c 2338 .hide = 1,
20eb06bd 2339 .interval = 100,
e8b0e958
JA
2340 .category = FIO_OPT_C_LOG,
2341 .group = FIO_OPT_G_INVALID,
c8eeb9df
JA
2342 },
2343 {
2344 .name = "iopsavgtime",
e8b0e958 2345 .lname = "IOPS average time",
c8eeb9df
JA
2346 .type = FIO_OPT_INT,
2347 .off1 = td_var_offset(iops_avg_time),
2348 .help = "Time window over which to calculate IOPS (msec)",
2349 .def = "500",
2350 .parent = "write_iops_log",
d71c154c 2351 .hide = 1,
20eb06bd 2352 .interval = 100,
e8b0e958
JA
2353 .category = FIO_OPT_C_LOG,
2354 .group = FIO_OPT_G_INVALID,
214e1eca
JA
2355 },
2356 {
2357 .name = "create_serialize",
e8b0e958 2358 .lname = "Create serialize",
214e1eca
JA
2359 .type = FIO_OPT_BOOL,
2360 .off1 = td_var_offset(create_serialize),
2361 .help = "Serialize creating of job files",
2362 .def = "1",
e8b0e958
JA
2363 .category = FIO_OPT_C_FILE,
2364 .group = FIO_OPT_G_INVALID,
214e1eca
JA
2365 },
2366 {
2367 .name = "create_fsync",
e8b0e958 2368 .lname = "Create fsync",
214e1eca
JA
2369 .type = FIO_OPT_BOOL,
2370 .off1 = td_var_offset(create_fsync),
03e20d68 2371 .help = "fsync file after creation",
214e1eca 2372 .def = "1",
e8b0e958
JA
2373 .category = FIO_OPT_C_FILE,
2374 .group = FIO_OPT_G_INVALID,
214e1eca 2375 },
814452bd
JA
2376 {
2377 .name = "create_on_open",
e8b0e958 2378 .lname = "Create on open",
814452bd
JA
2379 .type = FIO_OPT_BOOL,
2380 .off1 = td_var_offset(create_on_open),
2381 .help = "Create files when they are opened for IO",
2382 .def = "0",
e8b0e958
JA
2383 .category = FIO_OPT_C_FILE,
2384 .group = FIO_OPT_G_INVALID,
814452bd 2385 },
0b9d69ec 2386 {
afad68f7 2387 .name = "pre_read",
e8b0e958 2388 .lname = "Pre-read files",
afad68f7
ZY
2389 .type = FIO_OPT_BOOL,
2390 .off1 = td_var_offset(pre_read),
03e20d68 2391 .help = "Pre-read files before starting official testing",
afad68f7 2392 .def = "0",
e8b0e958
JA
2393 .category = FIO_OPT_C_FILE,
2394 .group = FIO_OPT_G_INVALID,
afad68f7 2395 },
214e1eca
JA
2396#ifdef FIO_HAVE_CPU_AFFINITY
2397 {
2398 .name = "cpumask",
e8b0e958 2399 .lname = "CPU mask",
214e1eca
JA
2400 .type = FIO_OPT_INT,
2401 .cb = str_cpumask_cb,
2402 .help = "CPU affinity mask",
e8b0e958 2403 .category = FIO_OPT_C_GENERAL,
10860056 2404 .group = FIO_OPT_G_CRED,
214e1eca 2405 },
d2e268b0
JA
2406 {
2407 .name = "cpus_allowed",
e8b0e958 2408 .lname = "CPUs allowed",
d2e268b0
JA
2409 .type = FIO_OPT_STR,
2410 .cb = str_cpus_allowed_cb,
2411 .help = "Set CPUs allowed",
e8b0e958 2412 .category = FIO_OPT_C_GENERAL,
10860056 2413 .group = FIO_OPT_G_CRED,
d2e268b0 2414 },
214e1eca
JA
2415#endif
2416 {
2417 .name = "end_fsync",
e8b0e958 2418 .lname = "End fsync",
214e1eca
JA
2419 .type = FIO_OPT_BOOL,
2420 .off1 = td_var_offset(end_fsync),
2421 .help = "Include fsync at the end of job",
2422 .def = "0",
e8b0e958
JA
2423 .category = FIO_OPT_C_FILE,
2424 .group = FIO_OPT_G_INVALID,
214e1eca
JA
2425 },
2426 {
2427 .name = "fsync_on_close",
e8b0e958 2428 .lname = "Fsync on close",
214e1eca
JA
2429 .type = FIO_OPT_BOOL,
2430 .off1 = td_var_offset(fsync_on_close),
2431 .help = "fsync files on close",
2432 .def = "0",
e8b0e958
JA
2433 .category = FIO_OPT_C_FILE,
2434 .group = FIO_OPT_G_INVALID,
214e1eca
JA
2435 },
2436 {
2437 .name = "unlink",
e8b0e958 2438 .lname = "Unlink file",
214e1eca
JA
2439 .type = FIO_OPT_BOOL,
2440 .off1 = td_var_offset(unlink),
2441 .help = "Unlink created files after job has completed",
2442 .def = "0",
e8b0e958
JA
2443 .category = FIO_OPT_C_FILE,
2444 .group = FIO_OPT_G_INVALID,
214e1eca
JA
2445 },
2446 {
2447 .name = "exitall",
e8b0e958 2448 .lname = "Exit-all on terminate",
214e1eca
JA
2449 .type = FIO_OPT_STR_SET,
2450 .cb = str_exitall_cb,
2451 .help = "Terminate all jobs when one exits",
e8b0e958 2452 .category = FIO_OPT_C_GENERAL,
a1f6afec 2453 .group = FIO_OPT_G_PROCESS,
214e1eca
JA
2454 },
2455 {
2456 .name = "stonewall",
e8b0e958 2457 .lname = "Wait for previous",
d392365e 2458 .alias = "wait_for_previous",
214e1eca
JA
2459 .type = FIO_OPT_STR_SET,
2460 .off1 = td_var_offset(stonewall),
2461 .help = "Insert a hard barrier between this job and previous",
e8b0e958 2462 .category = FIO_OPT_C_GENERAL,
a1f6afec 2463 .group = FIO_OPT_G_PROCESS,
214e1eca 2464 },
b3d62a75
JA
2465 {
2466 .name = "new_group",
e8b0e958 2467 .lname = "New group",
b3d62a75
JA
2468 .type = FIO_OPT_STR_SET,
2469 .off1 = td_var_offset(new_group),
2470 .help = "Mark the start of a new group (for reporting)",
e8b0e958 2471 .category = FIO_OPT_C_GENERAL,
a1f6afec 2472 .group = FIO_OPT_G_PROCESS,
b3d62a75 2473 },
214e1eca
JA
2474 {
2475 .name = "thread",
e8b0e958 2476 .lname = "Thread",
214e1eca
JA
2477 .type = FIO_OPT_STR_SET,
2478 .off1 = td_var_offset(use_thread),
20eb06bd 2479 .help = "Use threads instead of processes",
e8b0e958 2480 .category = FIO_OPT_C_GENERAL,
a1f6afec 2481 .group = FIO_OPT_G_PROCESS,
214e1eca
JA
2482 },
2483 {
2484 .name = "write_bw_log",
e8b0e958 2485 .lname = "Write bandwidth log",
e3cedca7 2486 .type = FIO_OPT_STR,
214e1eca 2487 .off1 = td_var_offset(write_bw_log),
e3cedca7 2488 .cb = str_write_bw_log_cb,
214e1eca 2489 .help = "Write log of bandwidth during run",
e8b0e958
JA
2490 .category = FIO_OPT_C_LOG,
2491 .group = FIO_OPT_G_INVALID,
214e1eca
JA
2492 },
2493 {
2494 .name = "write_lat_log",
e8b0e958 2495 .lname = "Write latency log",
e3cedca7 2496 .type = FIO_OPT_STR,
214e1eca 2497 .off1 = td_var_offset(write_lat_log),
e3cedca7 2498 .cb = str_write_lat_log_cb,
214e1eca 2499 .help = "Write log of latency during run",
e8b0e958
JA
2500 .category = FIO_OPT_C_LOG,
2501 .group = FIO_OPT_G_INVALID,
214e1eca 2502 },
c8eeb9df
JA
2503 {
2504 .name = "write_iops_log",
e8b0e958 2505 .lname = "Write IOPS log",
c8eeb9df
JA
2506 .type = FIO_OPT_STR,
2507 .off1 = td_var_offset(write_iops_log),
2508 .cb = str_write_iops_log_cb,
2509 .help = "Write log of IOPS during run",
e8b0e958
JA
2510 .category = FIO_OPT_C_LOG,
2511 .group = FIO_OPT_G_INVALID,
c8eeb9df 2512 },
b8bc8cba
JA
2513 {
2514 .name = "log_avg_msec",
e8b0e958 2515 .lname = "Log averaging (msec)",
b8bc8cba
JA
2516 .type = FIO_OPT_INT,
2517 .off1 = td_var_offset(log_avg_msec),
2518 .help = "Average bw/iops/lat logs over this period of time",
2519 .def = "0",
e8b0e958
JA
2520 .category = FIO_OPT_C_LOG,
2521 .group = FIO_OPT_G_INVALID,
b8bc8cba 2522 },
214e1eca
JA
2523 {
2524 .name = "group_reporting",
e8b0e958
JA
2525 .lname = "Group reporting",
2526 .type = FIO_OPT_BOOL,
214e1eca
JA
2527 .off1 = td_var_offset(group_reporting),
2528 .help = "Do reporting on a per-group basis",
e8b0e958 2529 .def = "1",
10860056 2530 .category = FIO_OPT_C_STAT,
e8b0e958 2531 .group = FIO_OPT_G_INVALID,
214e1eca 2532 },
e9459e5a
JA
2533 {
2534 .name = "zero_buffers",
e8b0e958 2535 .lname = "Zero I/O buffers",
e9459e5a
JA
2536 .type = FIO_OPT_STR_SET,
2537 .off1 = td_var_offset(zero_buffers),
2538 .help = "Init IO buffers to all zeroes",
e8b0e958 2539 .category = FIO_OPT_C_IO,
3ceb458f 2540 .group = FIO_OPT_G_IO_BUF,
e9459e5a 2541 },
5973cafb
JA
2542 {
2543 .name = "refill_buffers",
e8b0e958 2544 .lname = "Refill I/O buffers",
5973cafb
JA
2545 .type = FIO_OPT_STR_SET,
2546 .off1 = td_var_offset(refill_buffers),
2547 .help = "Refill IO buffers on every IO submit",
e8b0e958 2548 .category = FIO_OPT_C_IO,
3ceb458f 2549 .group = FIO_OPT_G_IO_BUF,
5973cafb 2550 },
fd68418e
JA
2551 {
2552 .name = "scramble_buffers",
e8b0e958 2553 .lname = "Scramble I/O buffers",
fd68418e
JA
2554 .type = FIO_OPT_BOOL,
2555 .off1 = td_var_offset(scramble_buffers),
2556 .help = "Slightly scramble buffers on every IO submit",
2557 .def = "1",
e8b0e958 2558 .category = FIO_OPT_C_IO,
3ceb458f 2559 .group = FIO_OPT_G_IO_BUF,
fd68418e 2560 },
9c42684e
JA
2561 {
2562 .name = "buffer_compress_percentage",
e8b0e958 2563 .lname = "Buffer compression percentage",
9c42684e
JA
2564 .type = FIO_OPT_INT,
2565 .off1 = td_var_offset(compress_percentage),
2566 .maxval = 100,
2567 .minval = 1,
2568 .help = "How compressible the buffer is (approximately)",
20eb06bd 2569 .interval = 5,
e8b0e958 2570 .category = FIO_OPT_C_IO,
3ceb458f 2571 .group = FIO_OPT_G_IO_BUF,
9c42684e 2572 },
f97a43a1
JA
2573 {
2574 .name = "buffer_compress_chunk",
e8b0e958 2575 .lname = "Buffer compression chunk size",
f97a43a1
JA
2576 .type = FIO_OPT_INT,
2577 .off1 = td_var_offset(compress_chunk),
207b18e4 2578 .parent = "buffer_compress_percentage",
d71c154c 2579 .hide = 1,
f97a43a1 2580 .help = "Size of compressible region in buffer",
20eb06bd 2581 .interval = 256,
e8b0e958 2582 .category = FIO_OPT_C_IO,
3ceb458f 2583 .group = FIO_OPT_G_IO_BUF,
f97a43a1 2584 },
83349190
YH
2585 {
2586 .name = "clat_percentiles",
e8b0e958 2587 .lname = "Completion latency percentiles",
83349190
YH
2588 .type = FIO_OPT_BOOL,
2589 .off1 = td_var_offset(clat_percentiles),
2590 .help = "Enable the reporting of completion latency percentiles",
467b35ed 2591 .def = "1",
e8b0e958
JA
2592 .category = FIO_OPT_C_STAT,
2593 .group = FIO_OPT_G_INVALID,
83349190
YH
2594 },
2595 {
2596 .name = "percentile_list",
e8b0e958 2597 .lname = "Completion latency percentile list",
83349190
YH
2598 .type = FIO_OPT_FLOAT_LIST,
2599 .off1 = td_var_offset(percentile_list),
2600 .off2 = td_var_offset(overwrite_plist),
2601 .help = "Specify a custom list of percentiles to report",
2602 .maxlen = FIO_IO_U_LIST_MAX_LEN,
2603 .minfp = 0.0,
2604 .maxfp = 100.0,
e8b0e958
JA
2605 .category = FIO_OPT_C_STAT,
2606 .group = FIO_OPT_G_INVALID,
83349190
YH
2607 },
2608
0a839f30
JA
2609#ifdef FIO_HAVE_DISK_UTIL
2610 {
2611 .name = "disk_util",
e8b0e958 2612 .lname = "Disk utilization",
0a839f30
JA
2613 .type = FIO_OPT_BOOL,
2614 .off1 = td_var_offset(do_disk_util),
f66ab3c8 2615 .help = "Log disk utilization statistics",
0a839f30 2616 .def = "1",
e8b0e958
JA
2617 .category = FIO_OPT_C_STAT,
2618 .group = FIO_OPT_G_INVALID,
0a839f30
JA
2619 },
2620#endif
993bf48b
JA
2621 {
2622 .name = "gtod_reduce",
e8b0e958 2623 .lname = "Reduce gettimeofday() calls",
993bf48b
JA
2624 .type = FIO_OPT_BOOL,
2625 .help = "Greatly reduce number of gettimeofday() calls",
2626 .cb = str_gtod_reduce_cb,
2627 .def = "0",
a4ed77fe 2628 .hide_on_set = 1,
e8b0e958
JA
2629 .category = FIO_OPT_C_STAT,
2630 .group = FIO_OPT_G_INVALID,
993bf48b 2631 },
02af0988
JA
2632 {
2633 .name = "disable_lat",
e8b0e958 2634 .lname = "Disable all latency stats",
02af0988
JA
2635 .type = FIO_OPT_BOOL,
2636 .off1 = td_var_offset(disable_lat),
2637 .help = "Disable latency numbers",
2638 .parent = "gtod_reduce",
d71c154c 2639 .hide = 1,
02af0988 2640 .def = "0",
e8b0e958
JA
2641 .category = FIO_OPT_C_STAT,
2642 .group = FIO_OPT_G_INVALID,
02af0988 2643 },
9520ebb9
JA
2644 {
2645 .name = "disable_clat",
e8b0e958 2646 .lname = "Disable completion latency stats",
9520ebb9
JA
2647 .type = FIO_OPT_BOOL,
2648 .off1 = td_var_offset(disable_clat),
2649 .help = "Disable completion latency numbers",
993bf48b 2650 .parent = "gtod_reduce",
d71c154c 2651 .hide = 1,
9520ebb9 2652 .def = "0",
e8b0e958
JA
2653 .category = FIO_OPT_C_STAT,
2654 .group = FIO_OPT_G_INVALID,
9520ebb9
JA
2655 },
2656 {
2657 .name = "disable_slat",
e8b0e958 2658 .lname = "Disable submission latency stats",
9520ebb9
JA
2659 .type = FIO_OPT_BOOL,
2660 .off1 = td_var_offset(disable_slat),
03e20d68 2661 .help = "Disable submission latency numbers",
993bf48b 2662 .parent = "gtod_reduce",
d71c154c 2663 .hide = 1,
9520ebb9 2664 .def = "0",
e8b0e958
JA
2665 .category = FIO_OPT_C_STAT,
2666 .group = FIO_OPT_G_INVALID,
9520ebb9
JA
2667 },
2668 {
2669 .name = "disable_bw_measurement",
e8b0e958 2670 .lname = "Disable bandwidth stats",
9520ebb9
JA
2671 .type = FIO_OPT_BOOL,
2672 .off1 = td_var_offset(disable_bw),
2673 .help = "Disable bandwidth logging",
993bf48b 2674 .parent = "gtod_reduce",
d71c154c 2675 .hide = 1,
9520ebb9 2676 .def = "0",
e8b0e958
JA
2677 .category = FIO_OPT_C_STAT,
2678 .group = FIO_OPT_G_INVALID,
9520ebb9 2679 },
be4ecfdf
JA
2680 {
2681 .name = "gtod_cpu",
e8b0e958 2682 .lname = "Dedicated gettimeofday() CPU",
be4ecfdf
JA
2683 .type = FIO_OPT_INT,
2684 .cb = str_gtod_cpu_cb,
03e20d68 2685 .help = "Set up dedicated gettimeofday() thread on this CPU",
29d43ff9 2686 .verify = gtod_cpu_verify,
e8b0e958 2687 .category = FIO_OPT_C_GENERAL,
10860056 2688 .group = FIO_OPT_G_CLOCK,
be4ecfdf 2689 },
f2bba182
RR
2690 {
2691 .name = "continue_on_error",
e8b0e958 2692 .lname = "Continue on error",
06842027 2693 .type = FIO_OPT_STR,
f2bba182 2694 .off1 = td_var_offset(continue_on_error),
03e20d68 2695 .help = "Continue on non-fatal errors during IO",
06842027 2696 .def = "none",
e8b0e958
JA
2697 .category = FIO_OPT_C_GENERAL,
2698 .group = FIO_OPT_G_INVALID,
06842027
SL
2699 .posval = {
2700 { .ival = "none",
2701 .oval = ERROR_TYPE_NONE,
2702 .help = "Exit when an error is encountered",
2703 },
2704 { .ival = "read",
2705 .oval = ERROR_TYPE_READ,
2706 .help = "Continue on read errors only",
2707 },
2708 { .ival = "write",
2709 .oval = ERROR_TYPE_WRITE,
2710 .help = "Continue on write errors only",
2711 },
2712 { .ival = "io",
2713 .oval = ERROR_TYPE_READ | ERROR_TYPE_WRITE,
2714 .help = "Continue on any IO errors",
2715 },
2716 { .ival = "verify",
2717 .oval = ERROR_TYPE_VERIFY,
2718 .help = "Continue on verify errors only",
2719 },
2720 { .ival = "all",
2721 .oval = ERROR_TYPE_ANY,
2722 .help = "Continue on all io and verify errors",
2723 },
2724 { .ival = "0",
2725 .oval = ERROR_TYPE_NONE,
2726 .help = "Alias for 'none'",
2727 },
2728 { .ival = "1",
2729 .oval = ERROR_TYPE_ANY,
2730 .help = "Alias for 'all'",
2731 },
2732 },
f2bba182 2733 },
9ac8a797
JA
2734 {
2735 .name = "profile",
e8b0e958 2736 .lname = "Profile",
79d16311 2737 .type = FIO_OPT_STR_STORE,
9ac8a797 2738 .off1 = td_var_offset(profile),
9ac8a797 2739 .help = "Select a specific builtin performance test",
e8b0e958
JA
2740 .category = FIO_OPT_C_GENERAL,
2741 .group = FIO_OPT_G_INVALID,
9ac8a797 2742 },
a696fa2a
JA
2743 {
2744 .name = "cgroup",
e8b0e958 2745 .lname = "Cgroup",
a696fa2a
JA
2746 .type = FIO_OPT_STR_STORE,
2747 .off1 = td_var_offset(cgroup),
2748 .help = "Add job to cgroup of this name",
e8b0e958 2749 .category = FIO_OPT_C_GENERAL,
a1f6afec
JA
2750 .group = FIO_OPT_G_CGROUP,
2751 },
2752 {
2753 .name = "cgroup_nodelete",
2754 .lname = "Cgroup no-delete",
2755 .type = FIO_OPT_BOOL,
2756 .off1 = td_var_offset(cgroup_nodelete),
2757 .help = "Do not delete cgroups after job completion",
2758 .def = "0",
2759 .parent = "cgroup",
2760 .category = FIO_OPT_C_GENERAL,
2761 .group = FIO_OPT_G_CGROUP,
a696fa2a
JA
2762 },
2763 {
2764 .name = "cgroup_weight",
e8b0e958 2765 .lname = "Cgroup weight",
a696fa2a
JA
2766 .type = FIO_OPT_INT,
2767 .off1 = td_var_offset(cgroup_weight),
2768 .help = "Use given weight for cgroup",
2769 .minval = 100,
2770 .maxval = 1000,
a1f6afec 2771 .parent = "cgroup",
e8b0e958 2772 .category = FIO_OPT_C_GENERAL,
a1f6afec 2773 .group = FIO_OPT_G_CGROUP,
7de87099 2774 },
e0b0d892
JA
2775 {
2776 .name = "uid",
e8b0e958 2777 .lname = "User ID",
e0b0d892
JA
2778 .type = FIO_OPT_INT,
2779 .off1 = td_var_offset(uid),
2780 .help = "Run job with this user ID",
e8b0e958 2781 .category = FIO_OPT_C_GENERAL,
10860056 2782 .group = FIO_OPT_G_CRED,
e0b0d892
JA
2783 },
2784 {
2785 .name = "gid",
e8b0e958 2786 .lname = "Group ID",
e0b0d892
JA
2787 .type = FIO_OPT_INT,
2788 .off1 = td_var_offset(gid),
2789 .help = "Run job with this group ID",
e8b0e958 2790 .category = FIO_OPT_C_GENERAL,
10860056 2791 .group = FIO_OPT_G_CRED,
e0b0d892 2792 },
a1f6afec
JA
2793 {
2794 .name = "kb_base",
2795 .lname = "KB Base",
2796 .type = FIO_OPT_INT,
2797 .off1 = td_var_offset(kb_base),
2798 .verify = kb_base_verify,
2799 .prio = 1,
2800 .def = "1024",
2801 .help = "How many bytes per KB for reporting (1000 or 1024)",
2802 .category = FIO_OPT_C_GENERAL,
2803 .group = FIO_OPT_G_INVALID,
2804 },
3ceb458f
JA
2805 {
2806 .name = "hugepage-size",
2807 .lname = "Hugepage size",
2808 .type = FIO_OPT_INT,
2809 .off1 = td_var_offset(hugepage_size),
2810 .help = "When using hugepages, specify size of each page",
2811 .def = __fio_stringify(FIO_HUGE_PAGE),
2812 .interval = 1024 * 1024,
2813 .category = FIO_OPT_C_GENERAL,
2814 .group = FIO_OPT_G_INVALID,
2815 },
9e684a49
DE
2816 {
2817 .name = "flow_id",
e8b0e958 2818 .lname = "I/O flow ID",
9e684a49
DE
2819 .type = FIO_OPT_INT,
2820 .off1 = td_var_offset(flow_id),
2821 .help = "The flow index ID to use",
2822 .def = "0",
e8b0e958
JA
2823 .category = FIO_OPT_C_IO,
2824 .group = FIO_OPT_G_IO_FLOW,
9e684a49
DE
2825 },
2826 {
2827 .name = "flow",
e8b0e958 2828 .lname = "I/O flow weight",
9e684a49
DE
2829 .type = FIO_OPT_INT,
2830 .off1 = td_var_offset(flow),
2831 .help = "Weight for flow control of this job",
2832 .parent = "flow_id",
d71c154c 2833 .hide = 1,
9e684a49 2834 .def = "0",
e8b0e958
JA
2835 .category = FIO_OPT_C_IO,
2836 .group = FIO_OPT_G_IO_FLOW,
9e684a49
DE
2837 },
2838 {
2839 .name = "flow_watermark",
e8b0e958 2840 .lname = "I/O flow watermark",
9e684a49
DE
2841 .type = FIO_OPT_INT,
2842 .off1 = td_var_offset(flow_watermark),
2843 .help = "High watermark for flow control. This option"
2844 " should be set to the same value for all threads"
2845 " with non-zero flow.",
2846 .parent = "flow_id",
d71c154c 2847 .hide = 1,
9e684a49 2848 .def = "1024",
e8b0e958
JA
2849 .category = FIO_OPT_C_IO,
2850 .group = FIO_OPT_G_IO_FLOW,
9e684a49
DE
2851 },
2852 {
2853 .name = "flow_sleep",
e8b0e958 2854 .lname = "I/O flow sleep",
9e684a49
DE
2855 .type = FIO_OPT_INT,
2856 .off1 = td_var_offset(flow_sleep),
2857 .help = "How many microseconds to sleep after being held"
2858 " back by the flow control mechanism",
2859 .parent = "flow_id",
d71c154c 2860 .hide = 1,
9e684a49 2861 .def = "0",
e8b0e958
JA
2862 .category = FIO_OPT_C_IO,
2863 .group = FIO_OPT_G_IO_FLOW,
9e684a49 2864 },
214e1eca
JA
2865 {
2866 .name = NULL,
2867 },
2868};
2869
17af15d4 2870static void add_to_lopt(struct option *lopt, struct fio_option *o,
de890a1e 2871 const char *name, int val)
9f81736c 2872{
17af15d4 2873 lopt->name = (char *) name;
de890a1e 2874 lopt->val = val;
9f81736c
JA
2875 if (o->type == FIO_OPT_STR_SET)
2876 lopt->has_arg = no_argument;
2877 else
2878 lopt->has_arg = required_argument;
2879}
2880
de890a1e
SL
2881static void options_to_lopts(struct fio_option *opts,
2882 struct option *long_options,
2883 int i, int option_type)
214e1eca 2884{
de890a1e 2885 struct fio_option *o = &opts[0];
214e1eca 2886 while (o->name) {
de890a1e 2887 add_to_lopt(&long_options[i], o, o->name, option_type);
17af15d4
JA
2888 if (o->alias) {
2889 i++;
de890a1e 2890 add_to_lopt(&long_options[i], o, o->alias, option_type);
17af15d4 2891 }
214e1eca
JA
2892
2893 i++;
2894 o++;
2895 assert(i < FIO_NR_OPTIONS);
2896 }
2897}
2898
de890a1e
SL
2899void fio_options_set_ioengine_opts(struct option *long_options,
2900 struct thread_data *td)
2901{
2902 unsigned int i;
2903
2904 i = 0;
2905 while (long_options[i].name) {
2906 if (long_options[i].val == FIO_GETOPT_IOENGINE) {
2907 memset(&long_options[i], 0, sizeof(*long_options));
2908 break;
2909 }
2910 i++;
2911 }
2912
2913 /*
2914 * Just clear out the prior ioengine options.
2915 */
2916 if (!td || !td->eo)
2917 return;
2918
2919 options_to_lopts(td->io_ops->options, long_options, i,
2920 FIO_GETOPT_IOENGINE);
2921}
2922
2923void fio_options_dup_and_init(struct option *long_options)
2924{
2925 unsigned int i;
2926
9af4a244 2927 options_init(fio_options);
de890a1e
SL
2928
2929 i = 0;
2930 while (long_options[i].name)
2931 i++;
2932
9af4a244 2933 options_to_lopts(fio_options, long_options, i, FIO_GETOPT_JOB);
de890a1e
SL
2934}
2935
74929ac2
JA
2936struct fio_keyword {
2937 const char *word;
2938 const char *desc;
2939 char *replace;
2940};
2941
2942static struct fio_keyword fio_keywords[] = {
2943 {
2944 .word = "$pagesize",
2945 .desc = "Page size in the system",
2946 },
2947 {
2948 .word = "$mb_memory",
2949 .desc = "Megabytes of memory online",
2950 },
2951 {
2952 .word = "$ncpus",
2953 .desc = "Number of CPUs online in the system",
2954 },
2955 {
2956 .word = NULL,
2957 },
2958};
2959
2960void fio_keywords_init(void)
2961{
3b2e1464 2962 unsigned long long mb_memory;
74929ac2
JA
2963 char buf[128];
2964 long l;
2965
2966 sprintf(buf, "%lu", page_size);
2967 fio_keywords[0].replace = strdup(buf);
2968
8eb016d3 2969 mb_memory = os_phys_mem() / (1024 * 1024);
3b2e1464 2970 sprintf(buf, "%llu", mb_memory);
74929ac2
JA
2971 fio_keywords[1].replace = strdup(buf);
2972
c00a2289 2973 l = cpus_online();
74929ac2
JA
2974 sprintf(buf, "%lu", l);
2975 fio_keywords[2].replace = strdup(buf);
2976}
2977
892a6ffc
JA
2978#define BC_APP "bc"
2979
2980static char *bc_calc(char *str)
2981{
d0c814ec 2982 char buf[128], *tmp;
892a6ffc
JA
2983 FILE *f;
2984 int ret;
2985
2986 /*
2987 * No math, just return string
2988 */
d0c814ec
SL
2989 if ((!strchr(str, '+') && !strchr(str, '-') && !strchr(str, '*') &&
2990 !strchr(str, '/')) || strchr(str, '\''))
892a6ffc
JA
2991 return str;
2992
2993 /*
2994 * Split option from value, we only need to calculate the value
2995 */
2996 tmp = strchr(str, '=');
2997 if (!tmp)
2998 return str;
2999
3000 tmp++;
892a6ffc 3001
d0c814ec
SL
3002 /*
3003 * Prevent buffer overflows; such a case isn't reasonable anyway
3004 */
3005 if (strlen(str) >= 128 || strlen(tmp) > 100)
3006 return str;
892a6ffc
JA
3007
3008 sprintf(buf, "which %s > /dev/null", BC_APP);
3009 if (system(buf)) {
3010 log_err("fio: bc is needed for performing math\n");
892a6ffc
JA
3011 return NULL;
3012 }
3013
d0c814ec 3014 sprintf(buf, "echo '%s' | %s", tmp, BC_APP);
892a6ffc
JA
3015 f = popen(buf, "r");
3016 if (!f) {
892a6ffc
JA
3017 return NULL;
3018 }
3019
d0c814ec 3020 ret = fread(&buf[tmp - str], 1, 128 - (tmp - str), f);
892a6ffc 3021 if (ret <= 0) {
892a6ffc
JA
3022 return NULL;
3023 }
3024
892a6ffc 3025 pclose(f);
d0c814ec
SL
3026 buf[(tmp - str) + ret - 1] = '\0';
3027 memcpy(buf, str, tmp - str);
892a6ffc 3028 free(str);
d0c814ec
SL
3029 return strdup(buf);
3030}
3031
3032/*
3033 * Return a copy of the input string with substrings of the form ${VARNAME}
3034 * substituted with the value of the environment variable VARNAME. The
3035 * substitution always occurs, even if VARNAME is empty or the corresponding
3036 * environment variable undefined.
3037 */
3038static char *option_dup_subs(const char *opt)
3039{
3040 char out[OPT_LEN_MAX+1];
3041 char in[OPT_LEN_MAX+1];
3042 char *outptr = out;
3043 char *inptr = in;
3044 char *ch1, *ch2, *env;
3045 ssize_t nchr = OPT_LEN_MAX;
3046 size_t envlen;
3047
3048 if (strlen(opt) + 1 > OPT_LEN_MAX) {
3049 log_err("OPT_LEN_MAX (%d) is too small\n", OPT_LEN_MAX);
3050 return NULL;
3051 }
3052
3053 in[OPT_LEN_MAX] = '\0';
3054 strncpy(in, opt, OPT_LEN_MAX);
3055
3056 while (*inptr && nchr > 0) {
3057 if (inptr[0] == '$' && inptr[1] == '{') {
3058 ch2 = strchr(inptr, '}');
3059 if (ch2 && inptr+1 < ch2) {
3060 ch1 = inptr+2;
3061 inptr = ch2+1;
3062 *ch2 = '\0';
3063
3064 env = getenv(ch1);
3065 if (env) {
3066 envlen = strlen(env);
3067 if (envlen <= nchr) {
3068 memcpy(outptr, env, envlen);
3069 outptr += envlen;
3070 nchr -= envlen;
3071 }
3072 }
3073
3074 continue;
3075 }
3076 }
3077
3078 *outptr++ = *inptr++;
3079 --nchr;
3080 }
3081
3082 *outptr = '\0';
3083 return strdup(out);
892a6ffc
JA
3084}
3085
74929ac2
JA
3086/*
3087 * Look for reserved variable names and replace them with real values
3088 */
3089static char *fio_keyword_replace(char *opt)
3090{
3091 char *s;
3092 int i;
d0c814ec 3093 int docalc = 0;
74929ac2
JA
3094
3095 for (i = 0; fio_keywords[i].word != NULL; i++) {
3096 struct fio_keyword *kw = &fio_keywords[i];
3097
3098 while ((s = strstr(opt, kw->word)) != NULL) {
3099 char *new = malloc(strlen(opt) + 1);
3100 char *o_org = opt;
3101 int olen = s - opt;
3102 int len;
3103
3104 /*
3105 * Copy part of the string before the keyword and
3106 * sprintf() the replacement after it.
3107 */
3108 memcpy(new, opt, olen);
3109 len = sprintf(new + olen, "%s", kw->replace);
3110
3111 /*
3112 * If there's more in the original string, copy that
3113 * in too
3114 */
3115 opt += strlen(kw->word) + olen;
3116 if (strlen(opt))
3117 memcpy(new + olen + len, opt, opt - o_org - 1);
3118
3119 /*
3120 * replace opt and free the old opt
3121 */
3122 opt = new;
d0c814ec 3123 free(o_org);
7a958bd5 3124
d0c814ec 3125 docalc = 1;
74929ac2
JA
3126 }
3127 }
3128
d0c814ec
SL
3129 /*
3130 * Check for potential math and invoke bc, if possible
3131 */
3132 if (docalc)
3133 opt = bc_calc(opt);
3134
7a958bd5 3135 return opt;
74929ac2
JA
3136}
3137
d0c814ec
SL
3138static char **dup_and_sub_options(char **opts, int num_opts)
3139{
3140 int i;
3141 char **opts_copy = malloc(num_opts * sizeof(*opts));
3142 for (i = 0; i < num_opts; i++) {
3143 opts_copy[i] = option_dup_subs(opts[i]);
3144 if (!opts_copy[i])
3145 continue;
3146 opts_copy[i] = fio_keyword_replace(opts_copy[i]);
3147 }
3148 return opts_copy;
3149}
3150
3b8b7135 3151int fio_options_parse(struct thread_data *td, char **opts, int num_opts)
214e1eca 3152{
de890a1e 3153 int i, ret, unknown;
d0c814ec 3154 char **opts_copy;
3b8b7135 3155
9af4a244 3156 sort_options(opts, fio_options, num_opts);
d0c814ec 3157 opts_copy = dup_and_sub_options(opts, num_opts);
3b8b7135 3158
de890a1e
SL
3159 for (ret = 0, i = 0, unknown = 0; i < num_opts; i++) {
3160 struct fio_option *o;
9af4a244
JA
3161 int newret = parse_option(opts_copy[i], opts[i], fio_options,
3162 &o, td);
d0c814ec 3163
de890a1e
SL
3164 if (opts_copy[i]) {
3165 if (newret && !o) {
3166 unknown++;
3167 continue;
3168 }
d0c814ec 3169 free(opts_copy[i]);
de890a1e
SL
3170 opts_copy[i] = NULL;
3171 }
3172
3173 ret |= newret;
3174 }
3175
3176 if (unknown) {
3177 ret |= ioengine_load(td);
3178 if (td->eo) {
3179 sort_options(opts_copy, td->io_ops->options, num_opts);
3180 opts = opts_copy;
3181 }
3182 for (i = 0; i < num_opts; i++) {
3183 struct fio_option *o = NULL;
3184 int newret = 1;
3185 if (!opts_copy[i])
3186 continue;
3187
3188 if (td->eo)
3189 newret = parse_option(opts_copy[i], opts[i],
3190 td->io_ops->options, &o,
3191 td->eo);
3192
3193 ret |= newret;
3194 if (!o)
3195 log_err("Bad option <%s>\n", opts[i]);
3196
3197 free(opts_copy[i]);
3198 opts_copy[i] = NULL;
3199 }
74929ac2 3200 }
3b8b7135 3201
d0c814ec 3202 free(opts_copy);
3b8b7135 3203 return ret;
214e1eca
JA
3204}
3205
3206int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
3207{
9af4a244 3208 return parse_cmd_option(opt, val, fio_options, td);
214e1eca
JA
3209}
3210
de890a1e
SL
3211int fio_cmd_ioengine_option_parse(struct thread_data *td, const char *opt,
3212 char *val)
3213{
3214 return parse_cmd_option(opt, val, td->io_ops->options, td);
3215}
3216
214e1eca
JA
3217void fio_fill_default_options(struct thread_data *td)
3218{
9af4a244 3219 fill_default_options(td, fio_options);
214e1eca
JA
3220}
3221
3222int fio_show_option_help(const char *opt)
3223{
9af4a244 3224 return show_cmd_help(fio_options, opt);
214e1eca 3225}
d23bb327 3226
de890a1e 3227void options_mem_dupe(void *data, struct fio_option *options)
d23bb327 3228{
de890a1e 3229 struct fio_option *o;
d23bb327 3230 char **ptr;
d23bb327 3231
de890a1e
SL
3232 for (o = &options[0]; o->name; o++) {
3233 if (o->type != FIO_OPT_STR_STORE)
d23bb327
JA
3234 continue;
3235
de890a1e 3236 ptr = td_var(data, o->off1);
7e356b2d
JA
3237 if (*ptr)
3238 *ptr = strdup(*ptr);
d23bb327
JA
3239 }
3240}
3241
de890a1e
SL
3242/*
3243 * dupe FIO_OPT_STR_STORE options
3244 */
3245void fio_options_mem_dupe(struct thread_data *td)
3246{
9af4a244 3247 options_mem_dupe(&td->o, fio_options);
1647f592
JA
3248
3249 if (td->eo && td->io_ops) {
de890a1e 3250 void *oldeo = td->eo;
1647f592 3251
de890a1e
SL
3252 td->eo = malloc(td->io_ops->option_struct_size);
3253 memcpy(td->eo, oldeo, td->io_ops->option_struct_size);
3254 options_mem_dupe(td->eo, td->io_ops->options);
3255 }
3256}
3257
d6978a32
JA
3258unsigned int fio_get_kb_base(void *data)
3259{
3260 struct thread_data *td = data;
3261 unsigned int kb_base = 0;
3262
3263 if (td)
3264 kb_base = td->o.kb_base;
3265 if (!kb_base)
3266 kb_base = 1024;
3267
3268 return kb_base;
3269}
9f988e2e 3270
07b3232d 3271int add_option(struct fio_option *o)
9f988e2e 3272{
07b3232d
JA
3273 struct fio_option *__o;
3274 int opt_index = 0;
3275
9af4a244 3276 __o = fio_options;
07b3232d
JA
3277 while (__o->name) {
3278 opt_index++;
3279 __o++;
3280 }
3281
9af4a244 3282 memcpy(&fio_options[opt_index], o, sizeof(*o));
07b3232d 3283 return 0;
9f988e2e 3284}
e2de69da 3285
07b3232d 3286void invalidate_profile_options(const char *prof_name)
e2de69da 3287{
07b3232d 3288 struct fio_option *o;
e2de69da 3289
9af4a244 3290 o = fio_options;
07b3232d
JA
3291 while (o->name) {
3292 if (o->prof_name && !strcmp(o->prof_name, prof_name)) {
3293 o->type = FIO_OPT_INVALID;
3294 o->prof_name = NULL;
3295 }
3296 o++;
e2de69da
JA
3297 }
3298}
f5b6bb85
JA
3299
3300void add_opt_posval(const char *optname, const char *ival, const char *help)
3301{
3302 struct fio_option *o;
3303 unsigned int i;
3304
9af4a244 3305 o = find_option(fio_options, optname);
f5b6bb85
JA
3306 if (!o)
3307 return;
3308
3309 for (i = 0; i < PARSE_MAX_VP; i++) {
3310 if (o->posval[i].ival)
3311 continue;
3312
3313 o->posval[i].ival = ival;
3314 o->posval[i].help = help;
3315 break;
3316 }
3317}
3318
3319void del_opt_posval(const char *optname, const char *ival)
3320{
3321 struct fio_option *o;
3322 unsigned int i;
3323
9af4a244 3324 o = find_option(fio_options, optname);
f5b6bb85
JA
3325 if (!o)
3326 return;
3327
3328 for (i = 0; i < PARSE_MAX_VP; i++) {
3329 if (!o->posval[i].ival)
3330 continue;
3331 if (strcmp(o->posval[i].ival, ival))
3332 continue;
3333
3334 o->posval[i].ival = NULL;
3335 o->posval[i].help = NULL;
3336 }
3337}
7e356b2d
JA
3338
3339void fio_options_free(struct thread_data *td)
3340{
9af4a244 3341 options_free(fio_options, td);
de890a1e
SL
3342 if (td->eo && td->io_ops && td->io_ops->options) {
3343 options_free(td->io_ops->options, td->eo);
3344 free(td->eo);
3345 td->eo = NULL;
3346 }
7e356b2d 3347}