Don't truncate files if we don't need to extend them
[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>
6#include <getopt.h>
7#include <assert.h>
8
9#include "fio.h"
10#include "parse.h"
90059d65 11#include "fls.h"
214e1eca 12
2dc1bbeb 13#define td_var_offset(var) ((size_t) &((struct thread_options *)0)->var)
214e1eca
JA
14
15/*
16 * Check if mmap/mmaphuge has a :/foo/bar/file at the end. If so, return that.
17 */
18static char *get_opt_postfix(const char *str)
19{
20 char *p = strstr(str, ":");
21
22 if (!p)
23 return NULL;
24
25 p++;
26 strip_blank_front(&p);
27 strip_blank_end(p);
28 return strdup(p);
29}
30
564ca972
JA
31static int bs_cmp(const void *p1, const void *p2)
32{
33 const struct bssplit *bsp1 = p1;
34 const struct bssplit *bsp2 = p2;
35
36 return bsp1->perc < bsp2->perc;
37}
38
39static int str_bssplit_cb(void *data, const char *input)
40{
41 struct thread_data *td = data;
42 char *fname, *str, *p;
43 unsigned int i, perc, perc_missing;
44 unsigned int max_bs, min_bs;
45 long long val;
46
47 p = str = strdup(input);
48
49 strip_blank_front(&str);
50 strip_blank_end(str);
51
52 td->o.bssplit_nr = 4;
53 td->o.bssplit = malloc(4 * sizeof(struct bssplit));
54
55 i = 0;
56 max_bs = 0;
57 min_bs = -1;
58 while ((fname = strsep(&str, ":")) != NULL) {
59 char *perc_str;
60
61 if (!strlen(fname))
62 break;
63
64 /*
65 * grow struct buffer, if needed
66 */
67 if (i == td->o.bssplit_nr) {
68 td->o.bssplit_nr <<= 1;
69 td->o.bssplit = realloc(td->o.bssplit, td->o.bssplit_nr * sizeof(struct bssplit));
70 }
71
72 perc_str = strstr(fname, "/");
73 if (perc_str) {
74 *perc_str = '\0';
75 perc_str++;
76 perc = atoi(perc_str);
77 if (perc > 100)
78 perc = 100;
79 else if (!perc)
80 perc = -1;
81 } else
82 perc = -1;
83
84 if (str_to_decimal(fname, &val, 1)) {
85 log_err("fio: bssplit conversion failed\n");
86 free(td->o.bssplit);
87 return 1;
88 }
89
90 if (val > max_bs)
91 max_bs = val;
92 if (val < min_bs)
93 min_bs = val;
94
95 td->o.bssplit[i].bs = val;
96 td->o.bssplit[i].perc = perc;
97 i++;
98 }
99
100 td->o.bssplit_nr = i;
101
102 /*
103 * Now check if the percentages add up, and how much is missing
104 */
105 perc = perc_missing = 0;
106 for (i = 0; i < td->o.bssplit_nr; i++) {
107 struct bssplit *bsp = &td->o.bssplit[i];
108
109 if (bsp->perc == (unsigned char) -1)
110 perc_missing++;
111 else
112 perc += bsp->perc;
113 }
114
115 if (perc > 100) {
116 log_err("fio: bssplit percentages add to more than 100%%\n");
117 free(td->o.bssplit);
118 return 1;
119 }
120 /*
121 * If values didn't have a percentage set, divide the remains between
122 * them.
123 */
124 if (perc_missing) {
125 for (i = 0; i < td->o.bssplit_nr; i++) {
126 struct bssplit *bsp = &td->o.bssplit[i];
127
128 if (bsp->perc == (unsigned char) -1)
129 bsp->perc = (100 - perc) / perc_missing;
130 }
131 }
132
133 td->o.min_bs[DDIR_READ] = td->o.min_bs[DDIR_WRITE] = min_bs;
134 td->o.max_bs[DDIR_READ] = td->o.max_bs[DDIR_WRITE] = max_bs;
135
136 /*
137 * now sort based on percentages, for ease of lookup
138 */
139 qsort(td->o.bssplit, td->o.bssplit_nr, sizeof(struct bssplit), bs_cmp);
140
141 free(p);
142 return 0;
143}
144
211097b2
JA
145static int str_rw_cb(void *data, const char *str)
146{
147 struct thread_data *td = data;
148 char *nr = get_opt_postfix(str);
149
fafdba3c 150 td->o.ddir_nr = 1;
211097b2
JA
151 if (nr)
152 td->o.ddir_nr = atoi(nr);
153
211097b2
JA
154 return 0;
155}
156
214e1eca
JA
157static int str_mem_cb(void *data, const char *mem)
158{
159 struct thread_data *td = data;
160
2dc1bbeb 161 if (td->o.mem_type == MEM_MMAPHUGE || td->o.mem_type == MEM_MMAP) {
214e1eca 162 td->mmapfile = get_opt_postfix(mem);
2dc1bbeb 163 if (td->o.mem_type == MEM_MMAPHUGE && !td->mmapfile) {
214e1eca
JA
164 log_err("fio: mmaphuge:/path/to/file\n");
165 return 1;
166 }
167 }
168
169 return 0;
170}
171
172static int str_lockmem_cb(void fio_unused *data, unsigned long *val)
173{
174 mlock_size = *val;
175 return 0;
176}
177
178#ifdef FIO_HAVE_IOPRIO
179static int str_prioclass_cb(void *data, unsigned int *val)
180{
181 struct thread_data *td = data;
6cefbe33
JA
182 unsigned short mask;
183
184 /*
185 * mask off old class bits, str_prio_cb() may have set a default class
186 */
187 mask = (1 << IOPRIO_CLASS_SHIFT) - 1;
188 td->ioprio &= mask;
214e1eca
JA
189
190 td->ioprio |= *val << IOPRIO_CLASS_SHIFT;
ac684785 191 td->ioprio_set = 1;
214e1eca
JA
192 return 0;
193}
194
195static int str_prio_cb(void *data, unsigned int *val)
196{
197 struct thread_data *td = data;
198
199 td->ioprio |= *val;
6cefbe33
JA
200
201 /*
202 * If no class is set, assume BE
203 */
204 if ((td->ioprio >> IOPRIO_CLASS_SHIFT) == 0)
205 td->ioprio |= IOPRIO_CLASS_BE << IOPRIO_CLASS_SHIFT;
206
ac684785 207 td->ioprio_set = 1;
214e1eca
JA
208 return 0;
209}
210#endif
211
212static int str_exitall_cb(void)
213{
214 exitall_on_terminate = 1;
215 return 0;
216}
217
214e1eca 218#ifdef FIO_HAVE_CPU_AFFINITY
d2e268b0
JA
219static int str_cpumask_cb(void *data, unsigned int *val)
220{
221 struct thread_data *td = data;
214e1eca
JA
222 unsigned int i;
223
d2e268b0 224 CPU_ZERO(&td->o.cpumask);
214e1eca 225
e600f7f1 226 for (i = 0; i < sizeof(int) * 8; i++)
d2e268b0
JA
227 if ((1 << i) & *val)
228 CPU_SET(*val, &td->o.cpumask);
229
230 td->o.cpumask_set = 1;
231 return 0;
214e1eca
JA
232}
233
d2e268b0 234static int str_cpus_allowed_cb(void *data, const char *input)
214e1eca
JA
235{
236 struct thread_data *td = data;
d2e268b0
JA
237 char *cpu, *str, *p;
238
239 CPU_ZERO(&td->o.cpumask);
240
241 p = str = strdup(input);
214e1eca 242
d2e268b0
JA
243 strip_blank_front(&str);
244 strip_blank_end(str);
245
246 while ((cpu = strsep(&str, ",")) != NULL) {
247 if (!strlen(cpu))
248 break;
249 CPU_SET(atoi(cpu), &td->o.cpumask);
250 }
251
252 free(p);
375b2695 253 td->o.cpumask_set = 1;
d2e268b0 254 exit(0);
214e1eca
JA
255 return 0;
256}
d2e268b0 257#endif
214e1eca
JA
258
259static int str_fst_cb(void *data, const char *str)
260{
261 struct thread_data *td = data;
262 char *nr = get_opt_postfix(str);
263
264 td->file_service_nr = 1;
265 if (nr)
266 td->file_service_nr = atoi(nr);
267
268 return 0;
269}
270
271static int str_filename_cb(void *data, const char *input)
272{
273 struct thread_data *td = data;
274 char *fname, *str, *p;
275
276 p = str = strdup(input);
277
278 strip_blank_front(&str);
279 strip_blank_end(str);
280
281 if (!td->files_index)
2dc1bbeb 282 td->o.nr_files = 0;
214e1eca
JA
283
284 while ((fname = strsep(&str, ":")) != NULL) {
285 if (!strlen(fname))
286 break;
287 add_file(td, fname);
2dc1bbeb 288 td->o.nr_files++;
214e1eca
JA
289 }
290
291 free(p);
292 return 0;
293}
294
295static int str_directory_cb(void *data, const char fio_unused *str)
296{
297 struct thread_data *td = data;
298 struct stat sb;
299
2dc1bbeb
JA
300 if (lstat(td->o.directory, &sb) < 0) {
301 log_err("fio: %s is not a directory\n", td->o.directory);
214e1eca
JA
302 td_verror(td, errno, "lstat");
303 return 1;
304 }
305 if (!S_ISDIR(sb.st_mode)) {
2dc1bbeb 306 log_err("fio: %s is not a directory\n", td->o.directory);
214e1eca
JA
307 return 1;
308 }
309
310 return 0;
311}
312
313static int str_opendir_cb(void *data, const char fio_unused *str)
314{
315 struct thread_data *td = data;
316
317 if (!td->files_index)
2dc1bbeb 318 td->o.nr_files = 0;
214e1eca 319
2dc1bbeb 320 return add_dir_files(td, td->o.opendir);
214e1eca
JA
321}
322
a59e170d 323static int str_verify_offset_cb(void *data, unsigned int *off)
546a9142
SL
324{
325 struct thread_data *td = data;
a59e170d 326
546a9142 327 if (*off && *off < sizeof(struct verify_header)) {
a59e170d 328 log_err("fio: verify_offset too small\n");
546a9142
SL
329 return 1;
330 }
a59e170d
JA
331
332 td->o.verify_offset = *off;
546a9142
SL
333 return 0;
334}
335
bfb41d98 336static int str_verify_cb(void *data, const char *mem)
90059d65
JA
337{
338 struct thread_data *td = data;
bfb41d98
JA
339 unsigned int nr, msb;
340 char *pat;
90059d65 341
bfb41d98
JA
342 if (td->o.verify != VERIFY_PATTERN)
343 return 0;
344
345 pat = get_opt_postfix(mem);
346 if (!pat) {
347 log_err("fio: missing pattern\n");
348 return 1;
349 }
350
351 if (strstr(pat, "0x") || strstr(pat, "0X"))
352 nr = strtol(pat, NULL, 16);
353 else
354 nr = strtol(pat, NULL, 16);
355
356 msb = fls(nr);
90059d65
JA
357 if (msb <= 8)
358 td->o.verify_pattern_bytes = 1;
359 else if (msb <= 16)
360 td->o.verify_pattern_bytes = 2;
361 else if (msb <= 24)
362 td->o.verify_pattern_bytes = 3;
363 else
364 td->o.verify_pattern_bytes = 4;
365
bfb41d98 366 td->o.verify_pattern = nr;
90059d65
JA
367 return 0;
368}
214e1eca
JA
369
370#define __stringify_1(x) #x
371#define __stringify(x) __stringify_1(x)
372
373/*
374 * Map of job/command line options
375 */
376static struct fio_option options[] = {
377 {
378 .name = "description",
379 .type = FIO_OPT_STR_STORE,
380 .off1 = td_var_offset(description),
381 .help = "Text job description",
382 },
383 {
384 .name = "name",
385 .type = FIO_OPT_STR_STORE,
386 .off1 = td_var_offset(name),
387 .help = "Name of this job",
388 },
389 {
390 .name = "directory",
391 .type = FIO_OPT_STR_STORE,
392 .off1 = td_var_offset(directory),
393 .cb = str_directory_cb,
394 .help = "Directory to store files in",
395 },
396 {
397 .name = "filename",
398 .type = FIO_OPT_STR_STORE,
399 .off1 = td_var_offset(filename),
400 .cb = str_filename_cb,
401 .help = "File(s) to use for the workload",
402 },
403 {
404 .name = "opendir",
405 .type = FIO_OPT_STR_STORE,
406 .off1 = td_var_offset(opendir),
407 .cb = str_opendir_cb,
408 .help = "Recursively add files from this directory and down",
409 },
410 {
411 .name = "rw",
d3aad8f2 412 .alias = "readwrite",
214e1eca 413 .type = FIO_OPT_STR,
211097b2 414 .cb = str_rw_cb,
214e1eca
JA
415 .off1 = td_var_offset(td_ddir),
416 .help = "IO direction",
417 .def = "read",
418 .posval = {
419 { .ival = "read",
420 .oval = TD_DDIR_READ,
421 .help = "Sequential read",
422 },
423 { .ival = "write",
424 .oval = TD_DDIR_WRITE,
425 .help = "Sequential write",
426 },
427 { .ival = "randread",
428 .oval = TD_DDIR_RANDREAD,
429 .help = "Random read",
430 },
431 { .ival = "randwrite",
432 .oval = TD_DDIR_RANDWRITE,
433 .help = "Random write",
434 },
435 { .ival = "rw",
436 .oval = TD_DDIR_RW,
437 .help = "Sequential read and write mix",
438 },
439 { .ival = "randrw",
440 .oval = TD_DDIR_RANDRW,
441 .help = "Random read and write mix"
442 },
443 },
444 },
445 {
446 .name = "ioengine",
447 .type = FIO_OPT_STR_STORE,
448 .off1 = td_var_offset(ioengine),
449 .help = "IO engine to use",
450 .def = "sync",
451 .posval = {
452 { .ival = "sync",
453 .help = "Use read/write",
454 },
a31041ea 455 { .ival = "psync",
456 .help = "Use pread/pwrite",
457 },
214e1eca
JA
458#ifdef FIO_HAVE_LIBAIO
459 { .ival = "libaio",
460 .help = "Linux native asynchronous IO",
461 },
462#endif
463#ifdef FIO_HAVE_POSIXAIO
464 { .ival = "posixaio",
465 .help = "POSIX asynchronous IO",
466 },
467#endif
468 { .ival = "mmap",
469 .help = "Memory mapped IO",
470 },
471#ifdef FIO_HAVE_SPLICE
472 { .ival = "splice",
473 .help = "splice/vmsplice based IO",
474 },
9cce02e8
JA
475 { .ival = "netsplice",
476 .help = "splice/vmsplice to/from the network",
477 },
214e1eca
JA
478#endif
479#ifdef FIO_HAVE_SGIO
480 { .ival = "sg",
481 .help = "SCSI generic v3 IO",
482 },
483#endif
484 { .ival = "null",
485 .help = "Testing engine (no data transfer)",
486 },
487 { .ival = "net",
488 .help = "Network IO",
489 },
490#ifdef FIO_HAVE_SYSLET
491 { .ival = "syslet-rw",
492 .help = "syslet enabled async pread/pwrite IO",
493 },
494#endif
495 { .ival = "cpuio",
496 .help = "CPU cycler burner engine",
497 },
b8c82a46
JA
498#ifdef FIO_HAVE_GUASI
499 { .ival = "guasi",
500 .help = "GUASI IO engine",
501 },
502#endif
214e1eca
JA
503 { .ival = "external",
504 .help = "Load external engine (append name)",
505 },
506 },
507 },
508 {
509 .name = "iodepth",
510 .type = FIO_OPT_INT,
511 .off1 = td_var_offset(iodepth),
512 .help = "Amount of IO buffers to keep in flight",
757aff4f 513 .minval = 1,
214e1eca
JA
514 .def = "1",
515 },
516 {
517 .name = "iodepth_batch",
518 .type = FIO_OPT_INT,
519 .off1 = td_var_offset(iodepth_batch),
520 .help = "Number of IO to submit in one go",
afdf9352 521 .parent = "iodepth",
214e1eca
JA
522 },
523 {
524 .name = "iodepth_low",
525 .type = FIO_OPT_INT,
526 .off1 = td_var_offset(iodepth_low),
527 .help = "Low water mark for queuing depth",
afdf9352 528 .parent = "iodepth",
214e1eca
JA
529 },
530 {
531 .name = "size",
532 .type = FIO_OPT_STR_VAL,
2dc1bbeb 533 .off1 = td_var_offset(size),
c3edbdba 534 .minval = 1,
214e1eca
JA
535 .help = "Total size of device or files",
536 },
aa31f1f1
SL
537 {
538 .name = "fill_device",
539 .type = FIO_OPT_BOOL,
540 .off1 = td_var_offset(fill_device),
541 .help = "Write until an ENOSPC error occurs",
542 .def = "0",
543 },
214e1eca
JA
544 {
545 .name = "filesize",
546 .type = FIO_OPT_STR_VAL,
547 .off1 = td_var_offset(file_size_low),
548 .off2 = td_var_offset(file_size_high),
c3edbdba 549 .minval = 1,
214e1eca
JA
550 .help = "Size of individual files",
551 },
67a1000f
JA
552 {
553 .name = "offset",
554 .alias = "fileoffset",
555 .type = FIO_OPT_STR_VAL,
556 .off1 = td_var_offset(start_offset),
557 .help = "Start IO from this offset",
558 .def = "0",
559 },
214e1eca
JA
560 {
561 .name = "bs",
d3aad8f2 562 .alias = "blocksize",
214e1eca
JA
563 .type = FIO_OPT_STR_VAL_INT,
564 .off1 = td_var_offset(bs[DDIR_READ]),
565 .off2 = td_var_offset(bs[DDIR_WRITE]),
c3edbdba 566 .minval = 1,
214e1eca
JA
567 .help = "Block size unit",
568 .def = "4k",
67a1000f 569 .parent = "rw",
214e1eca
JA
570 },
571 {
572 .name = "bsrange",
d3aad8f2 573 .alias = "blocksize_range",
214e1eca
JA
574 .type = FIO_OPT_RANGE,
575 .off1 = td_var_offset(min_bs[DDIR_READ]),
576 .off2 = td_var_offset(max_bs[DDIR_READ]),
577 .off3 = td_var_offset(min_bs[DDIR_WRITE]),
578 .off4 = td_var_offset(max_bs[DDIR_WRITE]),
c3edbdba 579 .minval = 1,
214e1eca 580 .help = "Set block size range (in more detail than bs)",
67a1000f 581 .parent = "rw",
214e1eca 582 },
564ca972
JA
583 {
584 .name = "bssplit",
585 .type = FIO_OPT_STR,
586 .cb = str_bssplit_cb,
587 .help = "Set a specific mix of block sizes",
588 .parent = "rw",
589 },
214e1eca
JA
590 {
591 .name = "bs_unaligned",
d3aad8f2 592 .alias = "blocksize_unaligned",
214e1eca
JA
593 .type = FIO_OPT_STR_SET,
594 .off1 = td_var_offset(bs_unaligned),
595 .help = "Don't sector align IO buffer sizes",
67a1000f 596 .parent = "rw",
214e1eca
JA
597 },
598 {
599 .name = "randrepeat",
600 .type = FIO_OPT_BOOL,
601 .off1 = td_var_offset(rand_repeatable),
602 .help = "Use repeatable random IO pattern",
603 .def = "1",
67a1000f 604 .parent = "rw",
214e1eca
JA
605 },
606 {
607 .name = "norandommap",
608 .type = FIO_OPT_STR_SET,
609 .off1 = td_var_offset(norandommap),
610 .help = "Accept potential duplicate random blocks",
67a1000f 611 .parent = "rw",
214e1eca
JA
612 },
613 {
614 .name = "nrfiles",
615 .type = FIO_OPT_INT,
616 .off1 = td_var_offset(nr_files),
617 .help = "Split job workload between this number of files",
618 .def = "1",
619 },
620 {
621 .name = "openfiles",
622 .type = FIO_OPT_INT,
623 .off1 = td_var_offset(open_files),
624 .help = "Number of files to keep open at the same time",
625 },
626 {
627 .name = "file_service_type",
628 .type = FIO_OPT_STR,
629 .cb = str_fst_cb,
630 .off1 = td_var_offset(file_service_type),
631 .help = "How to select which file to service next",
632 .def = "roundrobin",
633 .posval = {
634 { .ival = "random",
635 .oval = FIO_FSERVICE_RANDOM,
636 .help = "Choose a file at random",
637 },
638 { .ival = "roundrobin",
639 .oval = FIO_FSERVICE_RR,
640 .help = "Round robin select files",
641 },
642 },
67a1000f
JA
643 .parent = "nrfiles",
644 },
645 {
646 .name = "fadvise_hint",
647 .type = FIO_OPT_BOOL,
648 .off1 = td_var_offset(fadvise_hint),
649 .help = "Use fadvise() to advise the kernel on IO pattern",
650 .def = "1",
214e1eca
JA
651 },
652 {
653 .name = "fsync",
654 .type = FIO_OPT_INT,
655 .off1 = td_var_offset(fsync_blocks),
656 .help = "Issue fsync for writes every given number of blocks",
657 .def = "0",
658 },
659 {
660 .name = "direct",
661 .type = FIO_OPT_BOOL,
662 .off1 = td_var_offset(odirect),
663 .help = "Use O_DIRECT IO (negates buffered)",
664 .def = "0",
665 },
666 {
667 .name = "buffered",
668 .type = FIO_OPT_BOOL,
669 .off1 = td_var_offset(odirect),
670 .neg = 1,
671 .help = "Use buffered IO (negates direct)",
672 .def = "1",
673 },
674 {
675 .name = "overwrite",
676 .type = FIO_OPT_BOOL,
677 .off1 = td_var_offset(overwrite),
678 .help = "When writing, set whether to overwrite current data",
679 .def = "0",
680 },
681 {
682 .name = "loops",
683 .type = FIO_OPT_INT,
684 .off1 = td_var_offset(loops),
685 .help = "Number of times to run the job",
686 .def = "1",
687 },
688 {
689 .name = "numjobs",
690 .type = FIO_OPT_INT,
691 .off1 = td_var_offset(numjobs),
692 .help = "Duplicate this job this many times",
693 .def = "1",
694 },
695 {
696 .name = "startdelay",
697 .type = FIO_OPT_INT,
698 .off1 = td_var_offset(start_delay),
699 .help = "Only start job when this period has passed",
700 .def = "0",
701 },
702 {
703 .name = "runtime",
704 .alias = "timeout",
705 .type = FIO_OPT_STR_VAL_TIME,
706 .off1 = td_var_offset(timeout),
707 .help = "Stop workload when this amount of time has passed",
708 .def = "0",
709 },
cf4464ca
JA
710 {
711 .name = "time_based",
712 .type = FIO_OPT_STR_SET,
713 .off1 = td_var_offset(time_based),
714 .help = "Keep running until runtime/timeout is met",
715 },
214e1eca
JA
716 {
717 .name = "mem",
d3aad8f2 718 .alias = "iomem",
214e1eca
JA
719 .type = FIO_OPT_STR,
720 .cb = str_mem_cb,
721 .off1 = td_var_offset(mem_type),
722 .help = "Backing type for IO buffers",
723 .def = "malloc",
724 .posval = {
725 { .ival = "malloc",
726 .oval = MEM_MALLOC,
727 .help = "Use malloc(3) for IO buffers",
728 },
37c8cdfe
JA
729 { .ival = "shm",
730 .oval = MEM_SHM,
731 .help = "Use shared memory segments for IO buffers",
732 },
214e1eca
JA
733#ifdef FIO_HAVE_HUGETLB
734 { .ival = "shmhuge",
735 .oval = MEM_SHMHUGE,
736 .help = "Like shm, but use huge pages",
737 },
b370e46a 738#endif
37c8cdfe
JA
739 { .ival = "mmap",
740 .oval = MEM_MMAP,
741 .help = "Use mmap(2) (file or anon) for IO buffers",
742 },
214e1eca
JA
743#ifdef FIO_HAVE_HUGETLB
744 { .ival = "mmaphuge",
745 .oval = MEM_MMAPHUGE,
746 .help = "Like mmap, but use huge pages",
747 },
748#endif
749 },
750 },
751 {
752 .name = "verify",
753 .type = FIO_OPT_STR,
754 .off1 = td_var_offset(verify),
bfb41d98 755 .cb = str_verify_cb,
214e1eca
JA
756 .help = "Verify data written",
757 .def = "0",
758 .posval = {
759 { .ival = "0",
760 .oval = VERIFY_NONE,
761 .help = "Don't do IO verification",
762 },
fcca4b58
JA
763 { .ival = "md5",
764 .oval = VERIFY_MD5,
765 .help = "Use md5 checksums for verification",
766 },
d77a7af3
JA
767 { .ival = "crc64",
768 .oval = VERIFY_CRC64,
769 .help = "Use crc64 checksums for verification",
770 },
214e1eca
JA
771 { .ival = "crc32",
772 .oval = VERIFY_CRC32,
773 .help = "Use crc32 checksums for verification",
774 },
969f7ed3
JA
775 { .ival = "crc16",
776 .oval = VERIFY_CRC16,
777 .help = "Use crc16 checksums for verification",
778 },
1e154bdb
JA
779 { .ival = "crc7",
780 .oval = VERIFY_CRC7,
781 .help = "Use crc7 checksums for verification",
782 },
cd14cc10
JA
783 { .ival = "sha256",
784 .oval = VERIFY_SHA256,
785 .help = "Use sha256 checksums for verification",
786 },
787 { .ival = "sha512",
788 .oval = VERIFY_SHA512,
789 .help = "Use sha512 checksums for verification",
790 },
7437ee87
SL
791 { .ival = "meta",
792 .oval = VERIFY_META,
793 .help = "Use io information",
794 },
bfb41d98
JA
795 { .ival = "pattern",
796 .oval = VERIFY_PATTERN,
797 .help = "Verify a specific buffer pattern",
798 },
36690c9b
JA
799 {
800 .ival = "null",
801 .oval = VERIFY_NULL,
802 .help = "Pretend to verify",
803 },
214e1eca
JA
804 },
805 },
005c565a
JA
806 {
807 .name = "do_verify",
68e1f29a 808 .type = FIO_OPT_BOOL,
005c565a
JA
809 .off1 = td_var_offset(do_verify),
810 .help = "Run verification stage after write",
811 .def = "1",
812 .parent = "verify",
813 },
160b966d
JA
814 {
815 .name = "verifysort",
816 .type = FIO_OPT_BOOL,
817 .off1 = td_var_offset(verifysort),
818 .help = "Sort written verify blocks for read back",
819 .def = "1",
c83f2df1 820 .parent = "verify",
160b966d 821 },
3f9f4e26 822 {
a59e170d 823 .name = "verify_interval",
3f9f4e26 824 .type = FIO_OPT_STR_VAL_INT,
a59e170d 825 .off1 = td_var_offset(verify_interval),
819a9680 826 .minval = 2 * sizeof(struct verify_header),
a59e170d 827 .help = "Store verify buffer header every N bytes",
afdf9352 828 .parent = "verify",
3f9f4e26 829 },
546a9142 830 {
a59e170d 831 .name = "verify_offset",
546a9142 832 .type = FIO_OPT_STR_VAL_INT,
a59e170d 833 .help = "Offset verify header location by N bytes",
546a9142 834 .def = "0",
a59e170d 835 .cb = str_verify_offset_cb,
afdf9352 836 .parent = "verify",
546a9142 837 },
a12a3b4d
JA
838 {
839 .name = "verify_fatal",
68e1f29a 840 .type = FIO_OPT_BOOL,
a12a3b4d
JA
841 .off1 = td_var_offset(verify_fatal),
842 .def = "0",
843 .help = "Exit on a single verify failure, don't continue",
844 .parent = "verify",
845 },
214e1eca
JA
846 {
847 .name = "write_iolog",
848 .type = FIO_OPT_STR_STORE,
849 .off1 = td_var_offset(write_iolog_file),
850 .help = "Store IO pattern to file",
851 },
852 {
853 .name = "read_iolog",
854 .type = FIO_OPT_STR_STORE,
855 .off1 = td_var_offset(read_iolog_file),
856 .help = "Playback IO pattern from file",
857 },
858 {
859 .name = "exec_prerun",
860 .type = FIO_OPT_STR_STORE,
861 .off1 = td_var_offset(exec_prerun),
862 .help = "Execute this file prior to running job",
863 },
864 {
865 .name = "exec_postrun",
866 .type = FIO_OPT_STR_STORE,
867 .off1 = td_var_offset(exec_postrun),
868 .help = "Execute this file after running job",
869 },
870#ifdef FIO_HAVE_IOSCHED_SWITCH
871 {
872 .name = "ioscheduler",
873 .type = FIO_OPT_STR_STORE,
874 .off1 = td_var_offset(ioscheduler),
875 .help = "Use this IO scheduler on the backing device",
876 },
877#endif
878 {
879 .name = "zonesize",
880 .type = FIO_OPT_STR_VAL,
881 .off1 = td_var_offset(zone_size),
882 .help = "Give size of an IO zone",
883 .def = "0",
884 },
885 {
886 .name = "zoneskip",
887 .type = FIO_OPT_STR_VAL,
888 .off1 = td_var_offset(zone_skip),
889 .help = "Space between IO zones",
890 .def = "0",
891 },
892 {
893 .name = "lockmem",
894 .type = FIO_OPT_STR_VAL,
895 .cb = str_lockmem_cb,
896 .help = "Lock down this amount of memory",
897 .def = "0",
898 },
214e1eca
JA
899 {
900 .name = "rwmixread",
901 .type = FIO_OPT_INT,
e47f799f 902 .off1 = td_var_offset(rwmix[DDIR_READ]),
214e1eca
JA
903 .maxval = 100,
904 .help = "Percentage of mixed workload that is reads",
905 .def = "50",
906 },
907 {
908 .name = "rwmixwrite",
909 .type = FIO_OPT_INT,
e47f799f 910 .off1 = td_var_offset(rwmix[DDIR_WRITE]),
214e1eca
JA
911 .maxval = 100,
912 .help = "Percentage of mixed workload that is writes",
913 .def = "50",
914 },
afdf9352
JA
915 {
916 .name = "rwmixcycle",
917 .type = FIO_OPT_INT,
918 .off1 = td_var_offset(rwmixcycle),
919 .help = "Cycle period for mixed read/write workloads (msec)",
920 .def = "500",
921 .parent = "rwmixread",
922 },
214e1eca
JA
923 {
924 .name = "nice",
925 .type = FIO_OPT_INT,
926 .off1 = td_var_offset(nice),
927 .help = "Set job CPU nice value",
928 .minval = -19,
929 .maxval = 20,
930 .def = "0",
931 },
932#ifdef FIO_HAVE_IOPRIO
933 {
934 .name = "prio",
935 .type = FIO_OPT_INT,
936 .cb = str_prio_cb,
937 .help = "Set job IO priority value",
938 .minval = 0,
939 .maxval = 7,
940 },
941 {
942 .name = "prioclass",
943 .type = FIO_OPT_INT,
944 .cb = str_prioclass_cb,
945 .help = "Set job IO priority class",
946 .minval = 0,
947 .maxval = 3,
948 },
949#endif
950 {
951 .name = "thinktime",
952 .type = FIO_OPT_INT,
953 .off1 = td_var_offset(thinktime),
954 .help = "Idle time between IO buffers (usec)",
955 .def = "0",
956 },
957 {
958 .name = "thinktime_spin",
959 .type = FIO_OPT_INT,
960 .off1 = td_var_offset(thinktime_spin),
961 .help = "Start think time by spinning this amount (usec)",
962 .def = "0",
afdf9352 963 .parent = "thinktime",
214e1eca
JA
964 },
965 {
966 .name = "thinktime_blocks",
967 .type = FIO_OPT_INT,
968 .off1 = td_var_offset(thinktime_blocks),
969 .help = "IO buffer period between 'thinktime'",
970 .def = "1",
afdf9352 971 .parent = "thinktime",
214e1eca
JA
972 },
973 {
974 .name = "rate",
975 .type = FIO_OPT_INT,
976 .off1 = td_var_offset(rate),
977 .help = "Set bandwidth rate",
978 },
979 {
980 .name = "ratemin",
981 .type = FIO_OPT_INT,
982 .off1 = td_var_offset(ratemin),
4e991c23 983 .help = "Job must meet this rate or it will be shutdown",
afdf9352 984 .parent = "rate",
4e991c23
JA
985 },
986 {
987 .name = "rate_iops",
988 .type = FIO_OPT_INT,
989 .off1 = td_var_offset(rate_iops),
990 .help = "Limit IO used to this number of IO operations/sec",
991 },
992 {
993 .name = "rate_iops_min",
994 .type = FIO_OPT_INT,
995 .off1 = td_var_offset(rate_iops_min),
996 .help = "Job must meet this rate or it will be shutdown",
afdf9352 997 .parent = "rate_iops",
214e1eca
JA
998 },
999 {
1000 .name = "ratecycle",
1001 .type = FIO_OPT_INT,
1002 .off1 = td_var_offset(ratecycle),
1003 .help = "Window average for rate limits (msec)",
1004 .def = "1000",
afdf9352 1005 .parent = "rate",
214e1eca
JA
1006 },
1007 {
1008 .name = "invalidate",
1009 .type = FIO_OPT_BOOL,
1010 .off1 = td_var_offset(invalidate_cache),
1011 .help = "Invalidate buffer/page cache prior to running job",
1012 .def = "1",
1013 },
1014 {
1015 .name = "sync",
1016 .type = FIO_OPT_BOOL,
1017 .off1 = td_var_offset(sync_io),
1018 .help = "Use O_SYNC for buffered writes",
1019 .def = "0",
67a1000f 1020 .parent = "buffered",
214e1eca
JA
1021 },
1022 {
1023 .name = "bwavgtime",
1024 .type = FIO_OPT_INT,
1025 .off1 = td_var_offset(bw_avg_time),
1026 .help = "Time window over which to calculate bandwidth (msec)",
1027 .def = "500",
1028 },
1029 {
1030 .name = "create_serialize",
1031 .type = FIO_OPT_BOOL,
1032 .off1 = td_var_offset(create_serialize),
1033 .help = "Serialize creating of job files",
1034 .def = "1",
1035 },
1036 {
1037 .name = "create_fsync",
1038 .type = FIO_OPT_BOOL,
1039 .off1 = td_var_offset(create_fsync),
1040 .help = "Fsync file after creation",
1041 .def = "1",
1042 },
1043 {
1044 .name = "cpuload",
1045 .type = FIO_OPT_INT,
1046 .off1 = td_var_offset(cpuload),
1047 .help = "Use this percentage of CPU",
1048 },
1049 {
1050 .name = "cpuchunks",
1051 .type = FIO_OPT_INT,
1052 .off1 = td_var_offset(cpucycle),
1053 .help = "Length of the CPU burn cycles (usecs)",
1054 .def = "50000",
67a1000f 1055 .parent = "cpuload",
214e1eca
JA
1056 },
1057#ifdef FIO_HAVE_CPU_AFFINITY
1058 {
1059 .name = "cpumask",
1060 .type = FIO_OPT_INT,
1061 .cb = str_cpumask_cb,
1062 .help = "CPU affinity mask",
1063 },
d2e268b0
JA
1064 {
1065 .name = "cpus_allowed",
1066 .type = FIO_OPT_STR,
1067 .cb = str_cpus_allowed_cb,
1068 .help = "Set CPUs allowed",
1069 },
214e1eca
JA
1070#endif
1071 {
1072 .name = "end_fsync",
1073 .type = FIO_OPT_BOOL,
1074 .off1 = td_var_offset(end_fsync),
1075 .help = "Include fsync at the end of job",
1076 .def = "0",
1077 },
1078 {
1079 .name = "fsync_on_close",
1080 .type = FIO_OPT_BOOL,
1081 .off1 = td_var_offset(fsync_on_close),
1082 .help = "fsync files on close",
1083 .def = "0",
1084 },
1085 {
1086 .name = "unlink",
1087 .type = FIO_OPT_BOOL,
1088 .off1 = td_var_offset(unlink),
1089 .help = "Unlink created files after job has completed",
1090 .def = "0",
1091 },
1092 {
1093 .name = "exitall",
1094 .type = FIO_OPT_STR_SET,
1095 .cb = str_exitall_cb,
1096 .help = "Terminate all jobs when one exits",
1097 },
1098 {
1099 .name = "stonewall",
1100 .type = FIO_OPT_STR_SET,
1101 .off1 = td_var_offset(stonewall),
1102 .help = "Insert a hard barrier between this job and previous",
1103 },
b3d62a75
JA
1104 {
1105 .name = "new_group",
1106 .type = FIO_OPT_STR_SET,
1107 .off1 = td_var_offset(new_group),
1108 .help = "Mark the start of a new group (for reporting)",
1109 },
214e1eca
JA
1110 {
1111 .name = "thread",
1112 .type = FIO_OPT_STR_SET,
1113 .off1 = td_var_offset(use_thread),
1114 .help = "Use threads instead of forks",
1115 },
1116 {
1117 .name = "write_bw_log",
1118 .type = FIO_OPT_STR_SET,
1119 .off1 = td_var_offset(write_bw_log),
1120 .help = "Write log of bandwidth during run",
1121 },
1122 {
1123 .name = "write_lat_log",
1124 .type = FIO_OPT_STR_SET,
1125 .off1 = td_var_offset(write_lat_log),
1126 .help = "Write log of latency during run",
1127 },
1128 {
1129 .name = "hugepage-size",
1130 .type = FIO_OPT_STR_VAL,
1131 .off1 = td_var_offset(hugepage_size),
1132 .help = "When using hugepages, specify size of each page",
1133 .def = __stringify(FIO_HUGE_PAGE),
1134 },
1135 {
1136 .name = "group_reporting",
1137 .type = FIO_OPT_STR_SET,
1138 .off1 = td_var_offset(group_reporting),
1139 .help = "Do reporting on a per-group basis",
1140 },
e9459e5a
JA
1141 {
1142 .name = "zero_buffers",
1143 .type = FIO_OPT_STR_SET,
1144 .off1 = td_var_offset(zero_buffers),
1145 .help = "Init IO buffers to all zeroes",
1146 },
0a839f30
JA
1147#ifdef FIO_HAVE_DISK_UTIL
1148 {
1149 .name = "disk_util",
1150 .type = FIO_OPT_BOOL,
1151 .off1 = td_var_offset(do_disk_util),
1152 .help = "Log disk utilization stats",
1153 .def = "1",
1154 },
1155#endif
214e1eca
JA
1156 {
1157 .name = NULL,
1158 },
1159};
1160
1161void fio_options_dup_and_init(struct option *long_options)
1162{
1163 struct fio_option *o;
1164 unsigned int i;
1165
1166 options_init(options);
1167
1168 i = 0;
1169 while (long_options[i].name)
1170 i++;
1171
1172 o = &options[0];
1173 while (o->name) {
1174 long_options[i].name = o->name;
1175 long_options[i].val = FIO_GETOPT_JOB;
1176 if (o->type == FIO_OPT_STR_SET)
1177 long_options[i].has_arg = no_argument;
1178 else
1179 long_options[i].has_arg = required_argument;
1180
1181 i++;
1182 o++;
1183 assert(i < FIO_NR_OPTIONS);
1184 }
1185}
1186
1187int fio_option_parse(struct thread_data *td, const char *opt)
1188{
1189 return parse_option(opt, options, td);
1190}
1191
1192int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
1193{
1194 return parse_cmd_option(opt, val, options, td);
1195}
1196
1197void fio_fill_default_options(struct thread_data *td)
1198{
1199 fill_default_options(td, options);
1200}
1201
1202int fio_show_option_help(const char *opt)
1203{
1204 return show_cmd_help(options, opt);
1205}
d23bb327
JA
1206
1207static void __options_mem(struct thread_data *td, int alloc)
1208{
1209 struct thread_options *o = &td->o;
1210 struct fio_option *opt;
1211 char **ptr;
1212 int i;
1213
1214 for (i = 0, opt = &options[0]; opt->name; i++, opt = &options[i]) {
1215 if (opt->type != FIO_OPT_STR_STORE)
1216 continue;
1217
1218 ptr = (void *) o + opt->off1;
1219 if (*ptr) {
1220 if (alloc)
1221 *ptr = strdup(*ptr);
1222 else {
1223 free(*ptr);
1224 *ptr = NULL;
1225 }
1226 }
1227 }
1228}
1229
1230/*
1231 * dupe FIO_OPT_STR_STORE options
1232 */
1233void options_mem_dupe(struct thread_data *td)
1234{
1235 __options_mem(td, 1);
1236}
1237
22d66213 1238void options_mem_free(struct thread_data fio_unused *td)
d23bb327 1239{
22d66213 1240#if 0
d23bb327 1241 __options_mem(td, 0);
22d66213 1242#endif
d23bb327 1243}