Add generic arch include header
[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>
921c766f 8#include <libgen.h>
5921e80c
JA
9#include <fcntl.h>
10#include <sys/types.h>
11#include <sys/stat.h>
214e1eca
JA
12
13#include "fio.h"
4f5af7b2 14#include "verify.h"
214e1eca 15#include "parse.h"
eef32359 16#include "lib/fls.h"
214e1eca 17
2dc1bbeb 18#define td_var_offset(var) ((size_t) &((struct thread_options *)0)->var)
214e1eca
JA
19
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
df9cf928 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;
163
164}
165
166static int str_bssplit_cb(void *data, const char *input)
167{
168 struct thread_data *td = data;
169 char *str, *p, *odir;
170 int ret = 0;
171
172 p = str = strdup(input);
173
174 strip_blank_front(&str);
175 strip_blank_end(str);
176
177 odir = strchr(str, ',');
178 if (odir) {
179 ret = bssplit_ddir(td, DDIR_WRITE, odir + 1);
180 if (!ret) {
181 *odir = '\0';
182 ret = bssplit_ddir(td, DDIR_READ, str);
183 }
184 } else {
185 char *op;
186
187 op = strdup(str);
188
189 ret = bssplit_ddir(td, DDIR_READ, str);
190 if (!ret)
191 ret = bssplit_ddir(td, DDIR_WRITE, op);
192
193 free(op);
194 }
564ca972
JA
195
196 free(p);
720e84ad 197 return ret;
564ca972
JA
198}
199
211097b2
JA
200static int str_rw_cb(void *data, const char *str)
201{
202 struct thread_data *td = data;
203 char *nr = get_opt_postfix(str);
204
fafdba3c 205 td->o.ddir_nr = 1;
182ec6ee 206 if (nr) {
211097b2 207 td->o.ddir_nr = atoi(nr);
182ec6ee
JA
208 free(nr);
209 }
211097b2 210
211097b2
JA
211 return 0;
212}
213
214e1eca
JA
214static int str_mem_cb(void *data, const char *mem)
215{
216 struct thread_data *td = data;
217
2dc1bbeb 218 if (td->o.mem_type == MEM_MMAPHUGE || td->o.mem_type == MEM_MMAP) {
214e1eca 219 td->mmapfile = get_opt_postfix(mem);
2dc1bbeb 220 if (td->o.mem_type == MEM_MMAPHUGE && !td->mmapfile) {
214e1eca
JA
221 log_err("fio: mmaphuge:/path/to/file\n");
222 return 1;
223 }
224 }
225
226 return 0;
227}
228
229static int str_lockmem_cb(void fio_unused *data, unsigned long *val)
230{
231 mlock_size = *val;
232 return 0;
233}
234
cb499fc4
JA
235static int str_rwmix_read_cb(void *data, unsigned int *val)
236{
237 struct thread_data *td = data;
238
239 td->o.rwmix[DDIR_READ] = *val;
240 td->o.rwmix[DDIR_WRITE] = 100 - *val;
241 return 0;
242}
243
244static int str_rwmix_write_cb(void *data, unsigned int *val)
245{
246 struct thread_data *td = data;
247
248 td->o.rwmix[DDIR_WRITE] = *val;
249 td->o.rwmix[DDIR_READ] = 100 - *val;
250 return 0;
251}
252
214e1eca
JA
253#ifdef FIO_HAVE_IOPRIO
254static int str_prioclass_cb(void *data, unsigned int *val)
255{
256 struct thread_data *td = data;
6cefbe33
JA
257 unsigned short mask;
258
259 /*
260 * mask off old class bits, str_prio_cb() may have set a default class
261 */
262 mask = (1 << IOPRIO_CLASS_SHIFT) - 1;
263 td->ioprio &= mask;
214e1eca
JA
264
265 td->ioprio |= *val << IOPRIO_CLASS_SHIFT;
ac684785 266 td->ioprio_set = 1;
214e1eca
JA
267 return 0;
268}
269
270static int str_prio_cb(void *data, unsigned int *val)
271{
272 struct thread_data *td = data;
273
274 td->ioprio |= *val;
6cefbe33
JA
275
276 /*
277 * If no class is set, assume BE
278 */
279 if ((td->ioprio >> IOPRIO_CLASS_SHIFT) == 0)
280 td->ioprio |= IOPRIO_CLASS_BE << IOPRIO_CLASS_SHIFT;
281
ac684785 282 td->ioprio_set = 1;
214e1eca
JA
283 return 0;
284}
285#endif
286
287static int str_exitall_cb(void)
288{
289 exitall_on_terminate = 1;
290 return 0;
291}
292
214e1eca 293#ifdef FIO_HAVE_CPU_AFFINITY
d2e268b0
JA
294static int str_cpumask_cb(void *data, unsigned int *val)
295{
296 struct thread_data *td = data;
214e1eca 297 unsigned int i;
b03daafb 298 long max_cpu;
d2ce18b5
JA
299 int ret;
300
301 ret = fio_cpuset_init(&td->o.cpumask);
302 if (ret < 0) {
303 log_err("fio: cpuset_init failed\n");
304 td_verror(td, ret, "fio_cpuset_init");
305 return 1;
306 }
214e1eca 307
b03daafb 308 max_cpu = sysconf(_SC_NPROCESSORS_ONLN);
214e1eca 309
62a7273d
JA
310 for (i = 0; i < sizeof(int) * 8; i++) {
311 if ((1 << i) & *val) {
b03daafb
JA
312 if (i > max_cpu) {
313 log_err("fio: CPU %d too large (max=%ld)\n", i,
314 max_cpu);
315 return 1;
316 }
62a7273d 317 dprint(FD_PARSE, "set cpu allowed %d\n", i);
6d459ee7 318 fio_cpu_set(&td->o.cpumask, i);
62a7273d
JA
319 }
320 }
d2e268b0
JA
321
322 td->o.cpumask_set = 1;
323 return 0;
214e1eca
JA
324}
325
e8462bd8
JA
326static int set_cpus_allowed(struct thread_data *td, os_cpu_mask_t *mask,
327 const char *input)
214e1eca 328{
d2e268b0 329 char *cpu, *str, *p;
b03daafb 330 long max_cpu;
19608d6c 331 int ret = 0;
d2e268b0 332
e8462bd8 333 ret = fio_cpuset_init(mask);
d2ce18b5
JA
334 if (ret < 0) {
335 log_err("fio: cpuset_init failed\n");
336 td_verror(td, ret, "fio_cpuset_init");
337 return 1;
338 }
d2e268b0
JA
339
340 p = str = strdup(input);
214e1eca 341
d2e268b0
JA
342 strip_blank_front(&str);
343 strip_blank_end(str);
344
b03daafb
JA
345 max_cpu = sysconf(_SC_NPROCESSORS_ONLN);
346
d2e268b0 347 while ((cpu = strsep(&str, ",")) != NULL) {
62a7273d
JA
348 char *str2, *cpu2;
349 int icpu, icpu2;
350
d2e268b0
JA
351 if (!strlen(cpu))
352 break;
62a7273d
JA
353
354 str2 = cpu;
355 icpu2 = -1;
356 while ((cpu2 = strsep(&str2, "-")) != NULL) {
357 if (!strlen(cpu2))
358 break;
359
360 icpu2 = atoi(cpu2);
361 }
362
363 icpu = atoi(cpu);
364 if (icpu2 == -1)
365 icpu2 = icpu;
366 while (icpu <= icpu2) {
6d459ee7 367 if (icpu >= FIO_MAX_CPUS) {
19608d6c 368 log_err("fio: your OS only supports up to"
6d459ee7 369 " %d CPUs\n", (int) FIO_MAX_CPUS);
19608d6c
JA
370 ret = 1;
371 break;
372 }
b03daafb
JA
373 if (icpu > max_cpu) {
374 log_err("fio: CPU %d too large (max=%ld)\n",
375 icpu, max_cpu);
376 ret = 1;
377 break;
378 }
0b9d69ec 379
62a7273d 380 dprint(FD_PARSE, "set cpu allowed %d\n", icpu);
e8462bd8 381 fio_cpu_set(mask, icpu);
62a7273d
JA
382 icpu++;
383 }
19608d6c
JA
384 if (ret)
385 break;
d2e268b0
JA
386 }
387
388 free(p);
19608d6c
JA
389 if (!ret)
390 td->o.cpumask_set = 1;
391 return ret;
214e1eca 392}
e8462bd8
JA
393
394static int str_cpus_allowed_cb(void *data, const char *input)
395{
396 struct thread_data *td = data;
397 int ret;
398
399 ret = set_cpus_allowed(td, &td->o.cpumask, input);
400 if (!ret)
401 td->o.cpumask_set = 1;
402
403 return ret;
404}
405
406static int str_verify_cpus_allowed_cb(void *data, const char *input)
407{
408 struct thread_data *td = data;
409 int ret;
410
411 ret = set_cpus_allowed(td, &td->o.verify_cpumask, input);
412 if (!ret)
413 td->o.verify_cpumask_set = 1;
414
415 return ret;
416}
d2e268b0 417#endif
214e1eca
JA
418
419static int str_fst_cb(void *data, const char *str)
420{
421 struct thread_data *td = data;
422 char *nr = get_opt_postfix(str);
423
424 td->file_service_nr = 1;
182ec6ee 425 if (nr) {
214e1eca 426 td->file_service_nr = atoi(nr);
182ec6ee
JA
427 free(nr);
428 }
214e1eca
JA
429
430 return 0;
431}
432
921c766f
JA
433static int check_dir(struct thread_data *td, char *fname)
434{
435 char file[PATH_MAX], *dir;
bc838919 436 int elen = 0;
921c766f 437
bc838919
JA
438 if (td->o.directory) {
439 strcpy(file, td->o.directory);
fcef0b35 440 strcat(file, "/");
bc838919
JA
441 elen = strlen(file);
442 }
443
fcef0b35 444 sprintf(file + elen, "%s", fname);
921c766f
JA
445 dir = dirname(file);
446
fcef0b35
JA
447#if 0
448 {
449 struct stat sb;
450 /*
451 * We can't do this on FIO_DISKLESSIO engines. The engine isn't loaded
452 * yet, so we can't do this check right here...
453 */
921c766f
JA
454 if (lstat(dir, &sb) < 0) {
455 int ret = errno;
456
457 log_err("fio: %s is not a directory\n", dir);
458 td_verror(td, ret, "lstat");
459 return 1;
460 }
461
462 if (!S_ISDIR(sb.st_mode)) {
463 log_err("fio: %s is not a directory\n", dir);
464 return 1;
465 }
fcef0b35
JA
466 }
467#endif
921c766f
JA
468
469 return 0;
470}
471
8e827d35
JA
472/*
473 * Return next file in the string. Files are separated with ':'. If the ':'
474 * is escaped with a '\', then that ':' is part of the filename and does not
475 * indicate a new file.
476 */
477static char *get_next_file_name(char **ptr)
478{
479 char *str = *ptr;
480 char *p, *start;
481
482 if (!str || !strlen(str))
483 return NULL;
484
485 start = str;
486 do {
487 /*
488 * No colon, we are done
489 */
490 p = strchr(str, ':');
491 if (!p) {
492 *ptr = NULL;
493 break;
494 }
495
496 /*
497 * We got a colon, but it's the first character. Skip and
498 * continue
499 */
500 if (p == start) {
501 str = ++start;
502 continue;
503 }
504
505 if (*(p - 1) != '\\') {
506 *p = '\0';
507 *ptr = p + 1;
508 break;
509 }
510
511 memmove(p - 1, p, strlen(p) + 1);
512 str = p;
513 } while (1);
514
515 return start;
516}
517
214e1eca
JA
518static int str_filename_cb(void *data, const char *input)
519{
520 struct thread_data *td = data;
521 char *fname, *str, *p;
522
523 p = str = strdup(input);
524
525 strip_blank_front(&str);
526 strip_blank_end(str);
527
528 if (!td->files_index)
2dc1bbeb 529 td->o.nr_files = 0;
214e1eca 530
8e827d35 531 while ((fname = get_next_file_name(&str)) != NULL) {
214e1eca
JA
532 if (!strlen(fname))
533 break;
921c766f
JA
534 if (check_dir(td, fname)) {
535 free(p);
536 return 1;
537 }
214e1eca 538 add_file(td, fname);
2dc1bbeb 539 td->o.nr_files++;
214e1eca
JA
540 }
541
542 free(p);
543 return 0;
544}
545
546static int str_directory_cb(void *data, const char fio_unused *str)
547{
548 struct thread_data *td = data;
549 struct stat sb;
550
2dc1bbeb 551 if (lstat(td->o.directory, &sb) < 0) {
921c766f
JA
552 int ret = errno;
553
2dc1bbeb 554 log_err("fio: %s is not a directory\n", td->o.directory);
921c766f 555 td_verror(td, ret, "lstat");
214e1eca
JA
556 return 1;
557 }
558 if (!S_ISDIR(sb.st_mode)) {
2dc1bbeb 559 log_err("fio: %s is not a directory\n", td->o.directory);
214e1eca
JA
560 return 1;
561 }
562
563 return 0;
564}
565
566static int str_opendir_cb(void *data, const char fio_unused *str)
567{
568 struct thread_data *td = data;
569
570 if (!td->files_index)
2dc1bbeb 571 td->o.nr_files = 0;
214e1eca 572
2dc1bbeb 573 return add_dir_files(td, td->o.opendir);
214e1eca
JA
574}
575
a59e170d 576static int str_verify_offset_cb(void *data, unsigned int *off)
546a9142
SL
577{
578 struct thread_data *td = data;
a59e170d 579
546a9142 580 if (*off && *off < sizeof(struct verify_header)) {
a59e170d 581 log_err("fio: verify_offset too small\n");
546a9142
SL
582 return 1;
583 }
a59e170d
JA
584
585 td->o.verify_offset = *off;
546a9142
SL
586 return 0;
587}
588
0e92f873 589static int str_verify_pattern_cb(void *data, const char *input)
90059d65
JA
590{
591 struct thread_data *td = data;
0e92f873
RR
592 long off;
593 int i = 0, j = 0, len, k, base = 10;
594 char* loc1, * loc2;
595
596 loc1 = strstr(input, "0x");
597 loc2 = strstr(input, "0X");
598 if (loc1 || loc2)
599 base = 16;
600 off = strtol(input, NULL, base);
601 if (off != LONG_MAX || errno != ERANGE) {
602 while (off) {
603 td->o.verify_pattern[i] = off & 0xff;
604 off >>= 8;
605 i++;
606 }
607 } else {
608 len = strlen(input);
609 k = len - 1;
610 if (base == 16) {
611 if (loc1)
612 j = loc1 - input + 2;
613 else
614 j = loc2 - input + 2;
615 } else
616 return 1;
617 if (len - j < MAX_PATTERN_SIZE * 2) {
618 while (k >= j) {
619 off = converthexchartoint(input[k--]);
620 if (k >= j)
621 off += (converthexchartoint(input[k--])
622 * 16);
623 td->o.verify_pattern[i++] = (char) off;
624 }
625 }
626 }
627 td->o.verify_pattern_bytes = i;
90059d65
JA
628 return 0;
629}
214e1eca 630
4d4e80f2
JA
631static int str_lockfile_cb(void *data, const char *str)
632{
633 struct thread_data *td = data;
634 char *nr = get_opt_postfix(str);
635
636 td->o.lockfile_batch = 1;
182ec6ee 637 if (nr) {
4d4e80f2 638 td->o.lockfile_batch = atoi(nr);
182ec6ee
JA
639 free(nr);
640 }
4d4e80f2
JA
641
642 return 0;
643}
644
e3cedca7
JA
645static int str_write_bw_log_cb(void *data, const char *str)
646{
647 struct thread_data *td = data;
648
649 if (str)
650 td->o.bw_log_file = strdup(str);
651
652 td->o.write_bw_log = 1;
653 return 0;
654}
655
656static int str_write_lat_log_cb(void *data, const char *str)
657{
658 struct thread_data *td = data;
659
660 if (str)
661 td->o.lat_log_file = strdup(str);
662
663 td->o.write_lat_log = 1;
664 return 0;
665}
666
993bf48b
JA
667static int str_gtod_reduce_cb(void *data, int *il)
668{
669 struct thread_data *td = data;
670 int val = *il;
671
672 td->o.disable_clat = !!val;
673 td->o.disable_slat = !!val;
674 td->o.disable_bw = !!val;
675 if (val)
676 td->tv_cache_mask = 63;
677
678 return 0;
679}
680
be4ecfdf
JA
681static int str_gtod_cpu_cb(void *data, int *il)
682{
683 struct thread_data *td = data;
684 int val = *il;
685
686 td->o.gtod_cpu = val;
687 td->o.gtod_offload = 1;
688 return 0;
689}
690
896cac2a
JA
691static int rw_verify(struct fio_option *o, void *data)
692{
693 struct thread_data *td = data;
694
695 if (read_only && td_write(td)) {
696 log_err("fio: job <%s> has write bit set, but fio is in"
697 " read-only mode\n", td->o.name);
698 return 1;
699 }
700
701 return 0;
702}
703
276ca4f7 704static int gtod_cpu_verify(struct fio_option *o, void *data)
29d43ff9 705{
276ca4f7 706#ifndef FIO_HAVE_CPU_AFFINITY
29d43ff9
JA
707 struct thread_data *td = data;
708
29d43ff9
JA
709 if (td->o.gtod_cpu) {
710 log_err("fio: platform must support CPU affinity for"
711 "gettimeofday() offloading\n");
712 return 1;
713 }
714#endif
715
716 return 0;
717}
718
90fef2d1
JA
719static int kb_base_verify(struct fio_option *o, void *data)
720{
721 struct thread_data *td = data;
722
723 if (td->o.kb_base != 1024 && td->o.kb_base != 1000) {
724 log_err("fio: kb_base set to nonsensical value: %u\n",
725 td->o.kb_base);
726 return 1;
727 }
728
729 return 0;
730}
731
214e1eca
JA
732#define __stringify_1(x) #x
733#define __stringify(x) __stringify_1(x)
734
735/*
736 * Map of job/command line options
737 */
738static struct fio_option options[] = {
739 {
740 .name = "description",
741 .type = FIO_OPT_STR_STORE,
742 .off1 = td_var_offset(description),
743 .help = "Text job description",
744 },
745 {
746 .name = "name",
747 .type = FIO_OPT_STR_STORE,
748 .off1 = td_var_offset(name),
749 .help = "Name of this job",
750 },
751 {
752 .name = "directory",
753 .type = FIO_OPT_STR_STORE,
754 .off1 = td_var_offset(directory),
755 .cb = str_directory_cb,
756 .help = "Directory to store files in",
757 },
758 {
759 .name = "filename",
760 .type = FIO_OPT_STR_STORE,
761 .off1 = td_var_offset(filename),
762 .cb = str_filename_cb,
f0d524b0 763 .prio = -1, /* must come after "directory" */
214e1eca
JA
764 .help = "File(s) to use for the workload",
765 },
90fef2d1
JA
766 {
767 .name = "kb_base",
768 .type = FIO_OPT_INT,
769 .off1 = td_var_offset(kb_base),
90fef2d1 770 .verify = kb_base_verify,
a639f0bb 771 .prio = 1,
90fef2d1 772 .def = "1024",
a639f0bb 773 .help = "How many bytes per KB for reporting (1000 or 1024)",
90fef2d1 774 },
29c1349f
JA
775 {
776 .name = "lockfile",
4d4e80f2
JA
777 .type = FIO_OPT_STR,
778 .cb = str_lockfile_cb,
779 .off1 = td_var_offset(file_lock_mode),
29c1349f
JA
780 .help = "Lock file when doing IO to it",
781 .parent = "filename",
4d4e80f2
JA
782 .def = "none",
783 .posval = {
784 { .ival = "none",
785 .oval = FILE_LOCK_NONE,
786 .help = "No file locking",
787 },
788 { .ival = "exclusive",
789 .oval = FILE_LOCK_EXCLUSIVE,
790 .help = "Exclusive file lock",
791 },
792 {
793 .ival = "readwrite",
794 .oval = FILE_LOCK_READWRITE,
795 .help = "Read vs write lock",
796 },
797 },
29c1349f 798 },
214e1eca
JA
799 {
800 .name = "opendir",
801 .type = FIO_OPT_STR_STORE,
802 .off1 = td_var_offset(opendir),
803 .cb = str_opendir_cb,
804 .help = "Recursively add files from this directory and down",
805 },
806 {
807 .name = "rw",
d3aad8f2 808 .alias = "readwrite",
214e1eca 809 .type = FIO_OPT_STR,
211097b2 810 .cb = str_rw_cb,
214e1eca
JA
811 .off1 = td_var_offset(td_ddir),
812 .help = "IO direction",
813 .def = "read",
896cac2a 814 .verify = rw_verify,
214e1eca
JA
815 .posval = {
816 { .ival = "read",
817 .oval = TD_DDIR_READ,
818 .help = "Sequential read",
819 },
820 { .ival = "write",
821 .oval = TD_DDIR_WRITE,
822 .help = "Sequential write",
823 },
824 { .ival = "randread",
825 .oval = TD_DDIR_RANDREAD,
826 .help = "Random read",
827 },
828 { .ival = "randwrite",
829 .oval = TD_DDIR_RANDWRITE,
830 .help = "Random write",
831 },
832 { .ival = "rw",
833 .oval = TD_DDIR_RW,
834 .help = "Sequential read and write mix",
835 },
836 { .ival = "randrw",
837 .oval = TD_DDIR_RANDRW,
838 .help = "Random read and write mix"
839 },
840 },
841 },
842 {
843 .name = "ioengine",
844 .type = FIO_OPT_STR_STORE,
845 .off1 = td_var_offset(ioengine),
846 .help = "IO engine to use",
847 .def = "sync",
848 .posval = {
849 { .ival = "sync",
850 .help = "Use read/write",
851 },
a31041ea 852 { .ival = "psync",
853 .help = "Use pread/pwrite",
854 },
1d2af02a
JA
855 { .ival = "vsync",
856 .help = "Use readv/writev",
857 },
214e1eca
JA
858#ifdef FIO_HAVE_LIBAIO
859 { .ival = "libaio",
860 .help = "Linux native asynchronous IO",
861 },
862#endif
863#ifdef FIO_HAVE_POSIXAIO
864 { .ival = "posixaio",
865 .help = "POSIX asynchronous IO",
866 },
417f0068
JA
867#endif
868#ifdef FIO_HAVE_SOLARISAIO
869 { .ival = "solarisaio",
870 .help = "Solaris native asynchronous IO",
871 },
214e1eca
JA
872#endif
873 { .ival = "mmap",
874 .help = "Memory mapped IO",
875 },
876#ifdef FIO_HAVE_SPLICE
877 { .ival = "splice",
878 .help = "splice/vmsplice based IO",
879 },
9cce02e8
JA
880 { .ival = "netsplice",
881 .help = "splice/vmsplice to/from the network",
882 },
214e1eca
JA
883#endif
884#ifdef FIO_HAVE_SGIO
885 { .ival = "sg",
886 .help = "SCSI generic v3 IO",
887 },
888#endif
889 { .ival = "null",
890 .help = "Testing engine (no data transfer)",
891 },
892 { .ival = "net",
893 .help = "Network IO",
894 },
895#ifdef FIO_HAVE_SYSLET
896 { .ival = "syslet-rw",
897 .help = "syslet enabled async pread/pwrite IO",
898 },
899#endif
900 { .ival = "cpuio",
901 .help = "CPU cycler burner engine",
902 },
b8c82a46
JA
903#ifdef FIO_HAVE_GUASI
904 { .ival = "guasi",
905 .help = "GUASI IO engine",
906 },
907#endif
214e1eca
JA
908 { .ival = "external",
909 .help = "Load external engine (append name)",
910 },
911 },
912 },
913 {
914 .name = "iodepth",
915 .type = FIO_OPT_INT,
916 .off1 = td_var_offset(iodepth),
917 .help = "Amount of IO buffers to keep in flight",
757aff4f 918 .minval = 1,
214e1eca
JA
919 .def = "1",
920 },
921 {
922 .name = "iodepth_batch",
4950421a 923 .alias = "iodepth_batch_submit",
214e1eca
JA
924 .type = FIO_OPT_INT,
925 .off1 = td_var_offset(iodepth_batch),
d65db441 926 .help = "Number of IO buffers to submit in one go",
afdf9352 927 .parent = "iodepth",
a2e6f8ac
JA
928 .minval = 1,
929 .def = "1",
4950421a
JA
930 },
931 {
932 .name = "iodepth_batch_complete",
933 .type = FIO_OPT_INT,
934 .off1 = td_var_offset(iodepth_batch_complete),
d65db441 935 .help = "Number of IO buffers to retrieve in one go",
4950421a
JA
936 .parent = "iodepth",
937 .minval = 0,
938 .def = "1",
214e1eca
JA
939 },
940 {
941 .name = "iodepth_low",
942 .type = FIO_OPT_INT,
943 .off1 = td_var_offset(iodepth_low),
944 .help = "Low water mark for queuing depth",
afdf9352 945 .parent = "iodepth",
214e1eca
JA
946 },
947 {
948 .name = "size",
949 .type = FIO_OPT_STR_VAL,
2dc1bbeb 950 .off1 = td_var_offset(size),
c3edbdba 951 .minval = 1,
214e1eca
JA
952 .help = "Total size of device or files",
953 },
aa31f1f1
SL
954 {
955 .name = "fill_device",
956 .type = FIO_OPT_BOOL,
957 .off1 = td_var_offset(fill_device),
958 .help = "Write until an ENOSPC error occurs",
959 .def = "0",
960 },
214e1eca
JA
961 {
962 .name = "filesize",
963 .type = FIO_OPT_STR_VAL,
964 .off1 = td_var_offset(file_size_low),
965 .off2 = td_var_offset(file_size_high),
c3edbdba 966 .minval = 1,
214e1eca
JA
967 .help = "Size of individual files",
968 },
67a1000f
JA
969 {
970 .name = "offset",
971 .alias = "fileoffset",
972 .type = FIO_OPT_STR_VAL,
973 .off1 = td_var_offset(start_offset),
974 .help = "Start IO from this offset",
975 .def = "0",
976 },
214e1eca
JA
977 {
978 .name = "bs",
d3aad8f2 979 .alias = "blocksize",
e01b22b8 980 .type = FIO_OPT_INT,
214e1eca
JA
981 .off1 = td_var_offset(bs[DDIR_READ]),
982 .off2 = td_var_offset(bs[DDIR_WRITE]),
c3edbdba 983 .minval = 1,
214e1eca
JA
984 .help = "Block size unit",
985 .def = "4k",
67a1000f 986 .parent = "rw",
214e1eca 987 },
2b7a01d0
JA
988 {
989 .name = "ba",
990 .alias = "blockalign",
e01b22b8 991 .type = FIO_OPT_INT,
2b7a01d0
JA
992 .off1 = td_var_offset(ba[DDIR_READ]),
993 .off2 = td_var_offset(ba[DDIR_WRITE]),
994 .minval = 1,
995 .help = "IO block offset alignment",
996 .parent = "rw",
997 },
214e1eca
JA
998 {
999 .name = "bsrange",
d3aad8f2 1000 .alias = "blocksize_range",
214e1eca
JA
1001 .type = FIO_OPT_RANGE,
1002 .off1 = td_var_offset(min_bs[DDIR_READ]),
1003 .off2 = td_var_offset(max_bs[DDIR_READ]),
1004 .off3 = td_var_offset(min_bs[DDIR_WRITE]),
1005 .off4 = td_var_offset(max_bs[DDIR_WRITE]),
c3edbdba 1006 .minval = 1,
214e1eca 1007 .help = "Set block size range (in more detail than bs)",
67a1000f 1008 .parent = "rw",
214e1eca 1009 },
564ca972
JA
1010 {
1011 .name = "bssplit",
1012 .type = FIO_OPT_STR,
1013 .cb = str_bssplit_cb,
1014 .help = "Set a specific mix of block sizes",
1015 .parent = "rw",
1016 },
214e1eca
JA
1017 {
1018 .name = "bs_unaligned",
d3aad8f2 1019 .alias = "blocksize_unaligned",
214e1eca
JA
1020 .type = FIO_OPT_STR_SET,
1021 .off1 = td_var_offset(bs_unaligned),
1022 .help = "Don't sector align IO buffer sizes",
67a1000f 1023 .parent = "rw",
214e1eca
JA
1024 },
1025 {
1026 .name = "randrepeat",
1027 .type = FIO_OPT_BOOL,
1028 .off1 = td_var_offset(rand_repeatable),
1029 .help = "Use repeatable random IO pattern",
1030 .def = "1",
67a1000f 1031 .parent = "rw",
214e1eca
JA
1032 },
1033 {
1034 .name = "norandommap",
1035 .type = FIO_OPT_STR_SET,
1036 .off1 = td_var_offset(norandommap),
1037 .help = "Accept potential duplicate random blocks",
67a1000f 1038 .parent = "rw",
214e1eca 1039 },
2b386d25
JA
1040 {
1041 .name = "softrandommap",
1042 .type = FIO_OPT_BOOL,
1043 .off1 = td_var_offset(softrandommap),
f66ab3c8 1044 .help = "Set norandommap if randommap allocation fails",
2b386d25
JA
1045 .parent = "norandommap",
1046 .def = "0",
1047 },
214e1eca
JA
1048 {
1049 .name = "nrfiles",
1050 .type = FIO_OPT_INT,
1051 .off1 = td_var_offset(nr_files),
1052 .help = "Split job workload between this number of files",
1053 .def = "1",
1054 },
1055 {
1056 .name = "openfiles",
1057 .type = FIO_OPT_INT,
1058 .off1 = td_var_offset(open_files),
1059 .help = "Number of files to keep open at the same time",
1060 },
1061 {
1062 .name = "file_service_type",
1063 .type = FIO_OPT_STR,
1064 .cb = str_fst_cb,
1065 .off1 = td_var_offset(file_service_type),
1066 .help = "How to select which file to service next",
1067 .def = "roundrobin",
1068 .posval = {
1069 { .ival = "random",
1070 .oval = FIO_FSERVICE_RANDOM,
1071 .help = "Choose a file at random",
1072 },
1073 { .ival = "roundrobin",
1074 .oval = FIO_FSERVICE_RR,
1075 .help = "Round robin select files",
1076 },
a086c257
JA
1077 { .ival = "sequential",
1078 .oval = FIO_FSERVICE_SEQ,
1079 .help = "Finish one file before moving to the next",
1080 },
214e1eca 1081 },
67a1000f
JA
1082 .parent = "nrfiles",
1083 },
1084 {
1085 .name = "fadvise_hint",
1086 .type = FIO_OPT_BOOL,
1087 .off1 = td_var_offset(fadvise_hint),
1088 .help = "Use fadvise() to advise the kernel on IO pattern",
1089 .def = "1",
214e1eca
JA
1090 },
1091 {
1092 .name = "fsync",
1093 .type = FIO_OPT_INT,
1094 .off1 = td_var_offset(fsync_blocks),
1095 .help = "Issue fsync for writes every given number of blocks",
1096 .def = "0",
1097 },
5f9099ea
JA
1098 {
1099 .name = "fdatasync",
1100 .type = FIO_OPT_INT,
1101 .off1 = td_var_offset(fdatasync_blocks),
1102 .help = "Issue fdatasync for writes every given number of blocks",
1103 .def = "0",
1104 },
214e1eca
JA
1105 {
1106 .name = "direct",
1107 .type = FIO_OPT_BOOL,
1108 .off1 = td_var_offset(odirect),
1109 .help = "Use O_DIRECT IO (negates buffered)",
1110 .def = "0",
1111 },
1112 {
1113 .name = "buffered",
1114 .type = FIO_OPT_BOOL,
1115 .off1 = td_var_offset(odirect),
1116 .neg = 1,
1117 .help = "Use buffered IO (negates direct)",
1118 .def = "1",
1119 },
1120 {
1121 .name = "overwrite",
1122 .type = FIO_OPT_BOOL,
1123 .off1 = td_var_offset(overwrite),
1124 .help = "When writing, set whether to overwrite current data",
1125 .def = "0",
1126 },
1127 {
1128 .name = "loops",
1129 .type = FIO_OPT_INT,
1130 .off1 = td_var_offset(loops),
1131 .help = "Number of times to run the job",
1132 .def = "1",
1133 },
1134 {
1135 .name = "numjobs",
1136 .type = FIO_OPT_INT,
1137 .off1 = td_var_offset(numjobs),
1138 .help = "Duplicate this job this many times",
1139 .def = "1",
1140 },
1141 {
1142 .name = "startdelay",
1143 .type = FIO_OPT_INT,
1144 .off1 = td_var_offset(start_delay),
1145 .help = "Only start job when this period has passed",
1146 .def = "0",
1147 },
1148 {
1149 .name = "runtime",
1150 .alias = "timeout",
1151 .type = FIO_OPT_STR_VAL_TIME,
1152 .off1 = td_var_offset(timeout),
1153 .help = "Stop workload when this amount of time has passed",
1154 .def = "0",
1155 },
cf4464ca
JA
1156 {
1157 .name = "time_based",
1158 .type = FIO_OPT_STR_SET,
1159 .off1 = td_var_offset(time_based),
1160 .help = "Keep running until runtime/timeout is met",
1161 },
721938ae
JA
1162 {
1163 .name = "ramp_time",
1164 .type = FIO_OPT_STR_VAL_TIME,
1165 .off1 = td_var_offset(ramp_time),
1166 .help = "Ramp up time before measuring performance",
1167 },
214e1eca
JA
1168 {
1169 .name = "mem",
d3aad8f2 1170 .alias = "iomem",
214e1eca
JA
1171 .type = FIO_OPT_STR,
1172 .cb = str_mem_cb,
1173 .off1 = td_var_offset(mem_type),
1174 .help = "Backing type for IO buffers",
1175 .def = "malloc",
1176 .posval = {
1177 { .ival = "malloc",
1178 .oval = MEM_MALLOC,
1179 .help = "Use malloc(3) for IO buffers",
1180 },
37c8cdfe
JA
1181 { .ival = "shm",
1182 .oval = MEM_SHM,
1183 .help = "Use shared memory segments for IO buffers",
1184 },
214e1eca
JA
1185#ifdef FIO_HAVE_HUGETLB
1186 { .ival = "shmhuge",
1187 .oval = MEM_SHMHUGE,
1188 .help = "Like shm, but use huge pages",
1189 },
b370e46a 1190#endif
37c8cdfe
JA
1191 { .ival = "mmap",
1192 .oval = MEM_MMAP,
1193 .help = "Use mmap(2) (file or anon) for IO buffers",
1194 },
214e1eca
JA
1195#ifdef FIO_HAVE_HUGETLB
1196 { .ival = "mmaphuge",
1197 .oval = MEM_MMAPHUGE,
1198 .help = "Like mmap, but use huge pages",
1199 },
1200#endif
1201 },
1202 },
d529ee19
JA
1203 {
1204 .name = "iomem_align",
1205 .alias = "mem_align",
1206 .type = FIO_OPT_INT,
1207 .off1 = td_var_offset(mem_align),
1208 .minval = 0,
1209 .help = "IO memory buffer offset alignment",
1210 .def = "0",
1211 .parent = "iomem",
1212 },
214e1eca
JA
1213 {
1214 .name = "verify",
1215 .type = FIO_OPT_STR,
1216 .off1 = td_var_offset(verify),
1217 .help = "Verify data written",
1218 .def = "0",
1219 .posval = {
1220 { .ival = "0",
1221 .oval = VERIFY_NONE,
1222 .help = "Don't do IO verification",
1223 },
fcca4b58
JA
1224 { .ival = "md5",
1225 .oval = VERIFY_MD5,
1226 .help = "Use md5 checksums for verification",
1227 },
d77a7af3
JA
1228 { .ival = "crc64",
1229 .oval = VERIFY_CRC64,
1230 .help = "Use crc64 checksums for verification",
1231 },
214e1eca
JA
1232 { .ival = "crc32",
1233 .oval = VERIFY_CRC32,
1234 .help = "Use crc32 checksums for verification",
1235 },
af497e6a
JA
1236 { .ival = "crc32c-intel",
1237 .oval = VERIFY_CRC32C_INTEL,
1238 .help = "Use hw crc32c checksums for verification",
1239 },
bac39e0e
JA
1240 { .ival = "crc32c",
1241 .oval = VERIFY_CRC32C,
1242 .help = "Use crc32c checksums for verification",
1243 },
969f7ed3
JA
1244 { .ival = "crc16",
1245 .oval = VERIFY_CRC16,
1246 .help = "Use crc16 checksums for verification",
1247 },
1e154bdb
JA
1248 { .ival = "crc7",
1249 .oval = VERIFY_CRC7,
1250 .help = "Use crc7 checksums for verification",
1251 },
7c353ceb
JA
1252 { .ival = "sha1",
1253 .oval = VERIFY_SHA1,
1254 .help = "Use sha1 checksums for verification",
1255 },
cd14cc10
JA
1256 { .ival = "sha256",
1257 .oval = VERIFY_SHA256,
1258 .help = "Use sha256 checksums for verification",
1259 },
1260 { .ival = "sha512",
1261 .oval = VERIFY_SHA512,
1262 .help = "Use sha512 checksums for verification",
1263 },
7437ee87
SL
1264 { .ival = "meta",
1265 .oval = VERIFY_META,
1266 .help = "Use io information",
1267 },
36690c9b
JA
1268 {
1269 .ival = "null",
1270 .oval = VERIFY_NULL,
1271 .help = "Pretend to verify",
1272 },
214e1eca
JA
1273 },
1274 },
005c565a
JA
1275 {
1276 .name = "do_verify",
68e1f29a 1277 .type = FIO_OPT_BOOL,
005c565a
JA
1278 .off1 = td_var_offset(do_verify),
1279 .help = "Run verification stage after write",
1280 .def = "1",
1281 .parent = "verify",
1282 },
160b966d
JA
1283 {
1284 .name = "verifysort",
1285 .type = FIO_OPT_BOOL,
1286 .off1 = td_var_offset(verifysort),
1287 .help = "Sort written verify blocks for read back",
1288 .def = "1",
c83f2df1 1289 .parent = "verify",
160b966d 1290 },
3f9f4e26 1291 {
a59e170d 1292 .name = "verify_interval",
e01b22b8 1293 .type = FIO_OPT_INT,
a59e170d 1294 .off1 = td_var_offset(verify_interval),
819a9680 1295 .minval = 2 * sizeof(struct verify_header),
a59e170d 1296 .help = "Store verify buffer header every N bytes",
afdf9352 1297 .parent = "verify",
3f9f4e26 1298 },
546a9142 1299 {
a59e170d 1300 .name = "verify_offset",
e01b22b8 1301 .type = FIO_OPT_INT,
a59e170d 1302 .help = "Offset verify header location by N bytes",
546a9142 1303 .def = "0",
5ec10eaa 1304 .cb = str_verify_offset_cb,
afdf9352 1305 .parent = "verify",
546a9142 1306 },
e28218f3
SL
1307 {
1308 .name = "verify_pattern",
0e92f873 1309 .type = FIO_OPT_STR,
e28218f3
SL
1310 .cb = str_verify_pattern_cb,
1311 .help = "Fill pattern for IO buffers",
1312 .parent = "verify",
1313 },
a12a3b4d
JA
1314 {
1315 .name = "verify_fatal",
68e1f29a 1316 .type = FIO_OPT_BOOL,
a12a3b4d
JA
1317 .off1 = td_var_offset(verify_fatal),
1318 .def = "0",
1319 .help = "Exit on a single verify failure, don't continue",
1320 .parent = "verify",
1321 },
e8462bd8
JA
1322 {
1323 .name = "verify_async",
1324 .type = FIO_OPT_INT,
1325 .off1 = td_var_offset(verify_async),
1326 .def = "0",
1327 .help = "Number of async verifier threads to use",
1328 .parent = "verify",
1329 },
1330#ifdef FIO_HAVE_CPU_AFFINITY
1331 {
1332 .name = "verify_async_cpus",
1333 .type = FIO_OPT_STR,
1334 .cb = str_verify_cpus_allowed_cb,
1335 .help = "Set CPUs allowed for async verify threads",
1336 .parent = "verify_async",
1337 },
1338#endif
214e1eca
JA
1339 {
1340 .name = "write_iolog",
1341 .type = FIO_OPT_STR_STORE,
1342 .off1 = td_var_offset(write_iolog_file),
1343 .help = "Store IO pattern to file",
1344 },
1345 {
1346 .name = "read_iolog",
1347 .type = FIO_OPT_STR_STORE,
1348 .off1 = td_var_offset(read_iolog_file),
1349 .help = "Playback IO pattern from file",
1350 },
1351 {
1352 .name = "exec_prerun",
1353 .type = FIO_OPT_STR_STORE,
1354 .off1 = td_var_offset(exec_prerun),
1355 .help = "Execute this file prior to running job",
1356 },
1357 {
1358 .name = "exec_postrun",
1359 .type = FIO_OPT_STR_STORE,
1360 .off1 = td_var_offset(exec_postrun),
1361 .help = "Execute this file after running job",
1362 },
1363#ifdef FIO_HAVE_IOSCHED_SWITCH
1364 {
1365 .name = "ioscheduler",
1366 .type = FIO_OPT_STR_STORE,
1367 .off1 = td_var_offset(ioscheduler),
1368 .help = "Use this IO scheduler on the backing device",
1369 },
1370#endif
1371 {
1372 .name = "zonesize",
1373 .type = FIO_OPT_STR_VAL,
1374 .off1 = td_var_offset(zone_size),
1375 .help = "Give size of an IO zone",
1376 .def = "0",
1377 },
1378 {
1379 .name = "zoneskip",
1380 .type = FIO_OPT_STR_VAL,
1381 .off1 = td_var_offset(zone_skip),
1382 .help = "Space between IO zones",
1383 .def = "0",
1384 },
1385 {
1386 .name = "lockmem",
1387 .type = FIO_OPT_STR_VAL,
1388 .cb = str_lockmem_cb,
1389 .help = "Lock down this amount of memory",
1390 .def = "0",
1391 },
214e1eca
JA
1392 {
1393 .name = "rwmixread",
1394 .type = FIO_OPT_INT,
cb499fc4 1395 .cb = str_rwmix_read_cb,
214e1eca
JA
1396 .maxval = 100,
1397 .help = "Percentage of mixed workload that is reads",
1398 .def = "50",
1399 },
1400 {
1401 .name = "rwmixwrite",
1402 .type = FIO_OPT_INT,
cb499fc4 1403 .cb = str_rwmix_write_cb,
214e1eca
JA
1404 .maxval = 100,
1405 .help = "Percentage of mixed workload that is writes",
1406 .def = "50",
1407 },
afdf9352
JA
1408 {
1409 .name = "rwmixcycle",
15ca150e 1410 .type = FIO_OPT_DEPRECATED,
afdf9352 1411 },
214e1eca
JA
1412 {
1413 .name = "nice",
1414 .type = FIO_OPT_INT,
1415 .off1 = td_var_offset(nice),
1416 .help = "Set job CPU nice value",
1417 .minval = -19,
1418 .maxval = 20,
1419 .def = "0",
1420 },
1421#ifdef FIO_HAVE_IOPRIO
1422 {
1423 .name = "prio",
1424 .type = FIO_OPT_INT,
1425 .cb = str_prio_cb,
1426 .help = "Set job IO priority value",
1427 .minval = 0,
1428 .maxval = 7,
1429 },
1430 {
1431 .name = "prioclass",
1432 .type = FIO_OPT_INT,
1433 .cb = str_prioclass_cb,
1434 .help = "Set job IO priority class",
1435 .minval = 0,
1436 .maxval = 3,
1437 },
1438#endif
1439 {
1440 .name = "thinktime",
1441 .type = FIO_OPT_INT,
1442 .off1 = td_var_offset(thinktime),
1443 .help = "Idle time between IO buffers (usec)",
1444 .def = "0",
1445 },
1446 {
1447 .name = "thinktime_spin",
1448 .type = FIO_OPT_INT,
1449 .off1 = td_var_offset(thinktime_spin),
1450 .help = "Start think time by spinning this amount (usec)",
1451 .def = "0",
afdf9352 1452 .parent = "thinktime",
214e1eca
JA
1453 },
1454 {
1455 .name = "thinktime_blocks",
1456 .type = FIO_OPT_INT,
1457 .off1 = td_var_offset(thinktime_blocks),
1458 .help = "IO buffer period between 'thinktime'",
1459 .def = "1",
afdf9352 1460 .parent = "thinktime",
214e1eca
JA
1461 },
1462 {
1463 .name = "rate",
e01b22b8 1464 .type = FIO_OPT_INT,
581e7141
JA
1465 .off1 = td_var_offset(rate[0]),
1466 .off2 = td_var_offset(rate[1]),
214e1eca
JA
1467 .help = "Set bandwidth rate",
1468 },
1469 {
1470 .name = "ratemin",
e01b22b8 1471 .type = FIO_OPT_INT,
581e7141
JA
1472 .off1 = td_var_offset(ratemin[0]),
1473 .off2 = td_var_offset(ratemin[1]),
4e991c23 1474 .help = "Job must meet this rate or it will be shutdown",
afdf9352 1475 .parent = "rate",
4e991c23
JA
1476 },
1477 {
1478 .name = "rate_iops",
e01b22b8 1479 .type = FIO_OPT_INT,
581e7141
JA
1480 .off1 = td_var_offset(rate_iops[0]),
1481 .off2 = td_var_offset(rate_iops[1]),
4e991c23
JA
1482 .help = "Limit IO used to this number of IO operations/sec",
1483 },
1484 {
1485 .name = "rate_iops_min",
e01b22b8 1486 .type = FIO_OPT_INT,
581e7141
JA
1487 .off1 = td_var_offset(rate_iops_min[0]),
1488 .off2 = td_var_offset(rate_iops_min[1]),
4e991c23 1489 .help = "Job must meet this rate or it will be shutdown",
afdf9352 1490 .parent = "rate_iops",
214e1eca
JA
1491 },
1492 {
1493 .name = "ratecycle",
1494 .type = FIO_OPT_INT,
1495 .off1 = td_var_offset(ratecycle),
1496 .help = "Window average for rate limits (msec)",
1497 .def = "1000",
afdf9352 1498 .parent = "rate",
214e1eca
JA
1499 },
1500 {
1501 .name = "invalidate",
1502 .type = FIO_OPT_BOOL,
1503 .off1 = td_var_offset(invalidate_cache),
1504 .help = "Invalidate buffer/page cache prior to running job",
1505 .def = "1",
1506 },
1507 {
1508 .name = "sync",
1509 .type = FIO_OPT_BOOL,
1510 .off1 = td_var_offset(sync_io),
1511 .help = "Use O_SYNC for buffered writes",
1512 .def = "0",
67a1000f 1513 .parent = "buffered",
214e1eca
JA
1514 },
1515 {
1516 .name = "bwavgtime",
1517 .type = FIO_OPT_INT,
1518 .off1 = td_var_offset(bw_avg_time),
5ec10eaa
JA
1519 .help = "Time window over which to calculate bandwidth"
1520 " (msec)",
214e1eca
JA
1521 .def = "500",
1522 },
1523 {
1524 .name = "create_serialize",
1525 .type = FIO_OPT_BOOL,
1526 .off1 = td_var_offset(create_serialize),
1527 .help = "Serialize creating of job files",
1528 .def = "1",
1529 },
1530 {
1531 .name = "create_fsync",
1532 .type = FIO_OPT_BOOL,
1533 .off1 = td_var_offset(create_fsync),
1534 .help = "Fsync file after creation",
1535 .def = "1",
1536 },
814452bd
JA
1537 {
1538 .name = "create_on_open",
1539 .type = FIO_OPT_BOOL,
1540 .off1 = td_var_offset(create_on_open),
1541 .help = "Create files when they are opened for IO",
1542 .def = "0",
1543 },
0b9d69ec 1544 {
afad68f7
ZY
1545 .name = "pre_read",
1546 .type = FIO_OPT_BOOL,
1547 .off1 = td_var_offset(pre_read),
1548 .help = "Preread files before starting official testing",
1549 .def = "0",
1550 },
214e1eca
JA
1551 {
1552 .name = "cpuload",
1553 .type = FIO_OPT_INT,
1554 .off1 = td_var_offset(cpuload),
1555 .help = "Use this percentage of CPU",
1556 },
1557 {
1558 .name = "cpuchunks",
1559 .type = FIO_OPT_INT,
1560 .off1 = td_var_offset(cpucycle),
1561 .help = "Length of the CPU burn cycles (usecs)",
1562 .def = "50000",
67a1000f 1563 .parent = "cpuload",
214e1eca
JA
1564 },
1565#ifdef FIO_HAVE_CPU_AFFINITY
1566 {
1567 .name = "cpumask",
1568 .type = FIO_OPT_INT,
1569 .cb = str_cpumask_cb,
1570 .help = "CPU affinity mask",
1571 },
d2e268b0
JA
1572 {
1573 .name = "cpus_allowed",
1574 .type = FIO_OPT_STR,
1575 .cb = str_cpus_allowed_cb,
1576 .help = "Set CPUs allowed",
1577 },
214e1eca
JA
1578#endif
1579 {
1580 .name = "end_fsync",
1581 .type = FIO_OPT_BOOL,
1582 .off1 = td_var_offset(end_fsync),
1583 .help = "Include fsync at the end of job",
1584 .def = "0",
1585 },
1586 {
1587 .name = "fsync_on_close",
1588 .type = FIO_OPT_BOOL,
1589 .off1 = td_var_offset(fsync_on_close),
1590 .help = "fsync files on close",
1591 .def = "0",
1592 },
1593 {
1594 .name = "unlink",
1595 .type = FIO_OPT_BOOL,
1596 .off1 = td_var_offset(unlink),
1597 .help = "Unlink created files after job has completed",
1598 .def = "0",
1599 },
1600 {
1601 .name = "exitall",
1602 .type = FIO_OPT_STR_SET,
1603 .cb = str_exitall_cb,
1604 .help = "Terminate all jobs when one exits",
1605 },
1606 {
1607 .name = "stonewall",
1608 .type = FIO_OPT_STR_SET,
1609 .off1 = td_var_offset(stonewall),
1610 .help = "Insert a hard barrier between this job and previous",
1611 },
b3d62a75
JA
1612 {
1613 .name = "new_group",
1614 .type = FIO_OPT_STR_SET,
1615 .off1 = td_var_offset(new_group),
1616 .help = "Mark the start of a new group (for reporting)",
1617 },
214e1eca
JA
1618 {
1619 .name = "thread",
1620 .type = FIO_OPT_STR_SET,
1621 .off1 = td_var_offset(use_thread),
1622 .help = "Use threads instead of forks",
1623 },
1624 {
1625 .name = "write_bw_log",
e3cedca7 1626 .type = FIO_OPT_STR,
214e1eca 1627 .off1 = td_var_offset(write_bw_log),
e3cedca7 1628 .cb = str_write_bw_log_cb,
214e1eca
JA
1629 .help = "Write log of bandwidth during run",
1630 },
1631 {
1632 .name = "write_lat_log",
e3cedca7 1633 .type = FIO_OPT_STR,
214e1eca 1634 .off1 = td_var_offset(write_lat_log),
e3cedca7 1635 .cb = str_write_lat_log_cb,
214e1eca
JA
1636 .help = "Write log of latency during run",
1637 },
1638 {
1639 .name = "hugepage-size",
e01b22b8 1640 .type = FIO_OPT_INT,
214e1eca
JA
1641 .off1 = td_var_offset(hugepage_size),
1642 .help = "When using hugepages, specify size of each page",
1643 .def = __stringify(FIO_HUGE_PAGE),
1644 },
1645 {
1646 .name = "group_reporting",
1647 .type = FIO_OPT_STR_SET,
1648 .off1 = td_var_offset(group_reporting),
1649 .help = "Do reporting on a per-group basis",
1650 },
e9459e5a
JA
1651 {
1652 .name = "zero_buffers",
1653 .type = FIO_OPT_STR_SET,
1654 .off1 = td_var_offset(zero_buffers),
1655 .help = "Init IO buffers to all zeroes",
1656 },
5973cafb
JA
1657 {
1658 .name = "refill_buffers",
1659 .type = FIO_OPT_STR_SET,
1660 .off1 = td_var_offset(refill_buffers),
1661 .help = "Refill IO buffers on every IO submit",
1662 },
0a839f30
JA
1663#ifdef FIO_HAVE_DISK_UTIL
1664 {
1665 .name = "disk_util",
1666 .type = FIO_OPT_BOOL,
1667 .off1 = td_var_offset(do_disk_util),
f66ab3c8 1668 .help = "Log disk utilization statistics",
0a839f30
JA
1669 .def = "1",
1670 },
1671#endif
993bf48b
JA
1672 {
1673 .name = "gtod_reduce",
1674 .type = FIO_OPT_BOOL,
1675 .help = "Greatly reduce number of gettimeofday() calls",
1676 .cb = str_gtod_reduce_cb,
1677 .def = "0",
1678 },
9520ebb9
JA
1679 {
1680 .name = "disable_clat",
1681 .type = FIO_OPT_BOOL,
1682 .off1 = td_var_offset(disable_clat),
1683 .help = "Disable completion latency numbers",
993bf48b 1684 .parent = "gtod_reduce",
9520ebb9
JA
1685 .def = "0",
1686 },
1687 {
1688 .name = "disable_slat",
1689 .type = FIO_OPT_BOOL,
1690 .off1 = td_var_offset(disable_slat),
1691 .help = "Disable submissionn latency numbers",
993bf48b 1692 .parent = "gtod_reduce",
9520ebb9
JA
1693 .def = "0",
1694 },
1695 {
1696 .name = "disable_bw_measurement",
1697 .type = FIO_OPT_BOOL,
1698 .off1 = td_var_offset(disable_bw),
1699 .help = "Disable bandwidth logging",
993bf48b 1700 .parent = "gtod_reduce",
9520ebb9
JA
1701 .def = "0",
1702 },
be4ecfdf
JA
1703 {
1704 .name = "gtod_cpu",
1705 .type = FIO_OPT_INT,
1706 .cb = str_gtod_cpu_cb,
1707 .help = "Setup dedicated gettimeofday() thread on this CPU",
29d43ff9 1708 .verify = gtod_cpu_verify,
be4ecfdf 1709 },
f2bba182
RR
1710 {
1711 .name = "continue_on_error",
1712 .type = FIO_OPT_BOOL,
1713 .off1 = td_var_offset(continue_on_error),
1714 .help = "Continue on non-fatal errors during I/O",
1715 .def = "0",
1716 },
9ac8a797
JA
1717 {
1718 .name = "profile",
1719 .type = FIO_OPT_STR,
1720 .off1 = td_var_offset(profile),
1721 .posval = {
1722 { .ival = "tiobench",
1723 .oval = PROFILE_TIOBENCH,
1724 .help = "Perform tiobench like test",
1725 },
1726 },
1727 .help = "Select a specific builtin performance test",
1728 },
a696fa2a
JA
1729 {
1730 .name = "cgroup",
1731 .type = FIO_OPT_STR_STORE,
1732 .off1 = td_var_offset(cgroup),
1733 .help = "Add job to cgroup of this name",
1734 },
1735 {
1736 .name = "cgroup_weight",
1737 .type = FIO_OPT_INT,
1738 .off1 = td_var_offset(cgroup_weight),
1739 .help = "Use given weight for cgroup",
1740 .minval = 100,
1741 .maxval = 1000,
a696fa2a 1742 },
e0b0d892
JA
1743 {
1744 .name = "uid",
1745 .type = FIO_OPT_INT,
1746 .off1 = td_var_offset(uid),
1747 .help = "Run job with this user ID",
1748 },
1749 {
1750 .name = "gid",
1751 .type = FIO_OPT_INT,
1752 .off1 = td_var_offset(gid),
1753 .help = "Run job with this group ID",
1754 },
214e1eca
JA
1755 {
1756 .name = NULL,
1757 },
1758};
1759
1760void fio_options_dup_and_init(struct option *long_options)
1761{
1762 struct fio_option *o;
1763 unsigned int i;
1764
1765 options_init(options);
1766
1767 i = 0;
1768 while (long_options[i].name)
1769 i++;
1770
1771 o = &options[0];
1772 while (o->name) {
5921e80c 1773 long_options[i].name = (char *) o->name;
214e1eca
JA
1774 long_options[i].val = FIO_GETOPT_JOB;
1775 if (o->type == FIO_OPT_STR_SET)
1776 long_options[i].has_arg = no_argument;
1777 else
1778 long_options[i].has_arg = required_argument;
1779
1780 i++;
1781 o++;
1782 assert(i < FIO_NR_OPTIONS);
1783 }
1784}
1785
74929ac2
JA
1786struct fio_keyword {
1787 const char *word;
1788 const char *desc;
1789 char *replace;
1790};
1791
1792static struct fio_keyword fio_keywords[] = {
1793 {
1794 .word = "$pagesize",
1795 .desc = "Page size in the system",
1796 },
1797 {
1798 .word = "$mb_memory",
1799 .desc = "Megabytes of memory online",
1800 },
1801 {
1802 .word = "$ncpus",
1803 .desc = "Number of CPUs online in the system",
1804 },
1805 {
1806 .word = NULL,
1807 },
1808};
1809
1810void fio_keywords_init(void)
1811{
3b2e1464 1812 unsigned long long mb_memory;
74929ac2
JA
1813 char buf[128];
1814 long l;
1815
1816 sprintf(buf, "%lu", page_size);
1817 fio_keywords[0].replace = strdup(buf);
1818
3b2e1464
JA
1819 mb_memory = os_phys_mem() / page_size;
1820 sprintf(buf, "%llu", mb_memory);
74929ac2
JA
1821 fio_keywords[1].replace = strdup(buf);
1822
1823 l = sysconf(_SC_NPROCESSORS_ONLN);
1824 sprintf(buf, "%lu", l);
1825 fio_keywords[2].replace = strdup(buf);
1826}
1827
892a6ffc
JA
1828#define BC_APP "bc"
1829
1830static char *bc_calc(char *str)
1831{
1832 char *buf, *tmp, opt[80];
1833 FILE *f;
1834 int ret;
1835
1836 /*
1837 * No math, just return string
1838 */
1839 if (!strchr(str, '+') && !strchr(str, '-') && !strchr(str, '*') &&
1840 !strchr(str, '/'))
1841 return str;
1842
1843 /*
1844 * Split option from value, we only need to calculate the value
1845 */
1846 tmp = strchr(str, '=');
1847 if (!tmp)
1848 return str;
1849
1850 tmp++;
9ac8a797 1851 memset(opt, 0, sizeof(opt));
892a6ffc
JA
1852 strncpy(opt, str, tmp - str);
1853
1854 buf = malloc(128);
1855
1856 sprintf(buf, "which %s > /dev/null", BC_APP);
1857 if (system(buf)) {
1858 log_err("fio: bc is needed for performing math\n");
1859 free(buf);
1860 return NULL;
1861 }
1862
1863 sprintf(buf, "echo %s | %s", tmp, BC_APP);
1864 f = popen(buf, "r");
1865 if (!f) {
1866 free(buf);
1867 return NULL;
1868 }
1869
1870 ret = fread(buf, 1, 128, f);
1871 if (ret <= 0) {
1872 free(buf);
1873 return NULL;
1874 }
1875
1876 buf[ret - 1] = '\0';
1877 strcat(opt, buf);
1878 strcpy(buf, opt);
1879 pclose(f);
1880 free(str);
1881 return buf;
1882}
1883
74929ac2
JA
1884/*
1885 * Look for reserved variable names and replace them with real values
1886 */
1887static char *fio_keyword_replace(char *opt)
1888{
1889 char *s;
1890 int i;
1891
1892 for (i = 0; fio_keywords[i].word != NULL; i++) {
1893 struct fio_keyword *kw = &fio_keywords[i];
1894
1895 while ((s = strstr(opt, kw->word)) != NULL) {
1896 char *new = malloc(strlen(opt) + 1);
1897 char *o_org = opt;
1898 int olen = s - opt;
1899 int len;
1900
1901 /*
1902 * Copy part of the string before the keyword and
1903 * sprintf() the replacement after it.
1904 */
1905 memcpy(new, opt, olen);
1906 len = sprintf(new + olen, "%s", kw->replace);
1907
1908 /*
1909 * If there's more in the original string, copy that
1910 * in too
1911 */
1912 opt += strlen(kw->word) + olen;
1913 if (strlen(opt))
1914 memcpy(new + olen + len, opt, opt - o_org - 1);
1915
1916 /*
1917 * replace opt and free the old opt
1918 */
1919 opt = new;
9ac8a797 1920 //free(o_org);
7a958bd5
JA
1921
1922 /*
1923 * Check for potential math and invoke bc, if possible
1924 */
1925 opt = bc_calc(opt);
74929ac2
JA
1926 }
1927 }
1928
7a958bd5 1929 return opt;
74929ac2
JA
1930}
1931
3b8b7135 1932int fio_options_parse(struct thread_data *td, char **opts, int num_opts)
214e1eca 1933{
3b8b7135
JA
1934 int i, ret;
1935
1936 sort_options(opts, options, num_opts);
1937
74929ac2
JA
1938 for (ret = 0, i = 0; i < num_opts; i++) {
1939 opts[i] = fio_keyword_replace(opts[i]);
3b8b7135 1940 ret |= parse_option(opts[i], options, td);
74929ac2 1941 }
3b8b7135
JA
1942
1943 return ret;
214e1eca
JA
1944}
1945
1946int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
1947{
1948 return parse_cmd_option(opt, val, options, td);
1949}
1950
1951void fio_fill_default_options(struct thread_data *td)
1952{
1953 fill_default_options(td, options);
1954}
1955
1956int fio_show_option_help(const char *opt)
1957{
1958 return show_cmd_help(options, opt);
1959}
d23bb327
JA
1960
1961static void __options_mem(struct thread_data *td, int alloc)
1962{
1963 struct thread_options *o = &td->o;
1964 struct fio_option *opt;
1965 char **ptr;
1966 int i;
1967
1968 for (i = 0, opt = &options[0]; opt->name; i++, opt = &options[i]) {
1969 if (opt->type != FIO_OPT_STR_STORE)
1970 continue;
1971
1972 ptr = (void *) o + opt->off1;
1973 if (*ptr) {
1974 if (alloc)
1975 *ptr = strdup(*ptr);
1976 else {
1977 free(*ptr);
1978 *ptr = NULL;
1979 }
1980 }
1981 }
1982}
1983
1984/*
1985 * dupe FIO_OPT_STR_STORE options
1986 */
1987void options_mem_dupe(struct thread_data *td)
1988{
1989 __options_mem(td, 1);
1990}
1991
22d66213 1992void options_mem_free(struct thread_data fio_unused *td)
d23bb327 1993{
22d66213 1994#if 0
d23bb327 1995 __options_mem(td, 0);
22d66213 1996#endif
d23bb327 1997}
d6978a32
JA
1998
1999unsigned int fio_get_kb_base(void *data)
2000{
2001 struct thread_data *td = data;
2002 unsigned int kb_base = 0;
2003
2004 if (td)
2005 kb_base = td->o.kb_base;
2006 if (!kb_base)
2007 kb_base = 1024;
2008
2009 return kb_base;
2010}