Merge branch 'master' into gfio
[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
3c3ed070 40 switch (a) {
0e92f873
RR
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 }
3c3ed070 53 return a - base;
0e92f873
RR
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
83ea422a 64static int bssplit_ddir(struct thread_options *o, 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
83ea422a 72 o->bssplit_nr[ddir] = 4;
720e84ad 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 */
83ea422a
JA
87 if (i == o->bssplit_nr[ddir]) {
88 o->bssplit_nr[ddir] <<= 1;
89 bssplit = realloc(bssplit, 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
83ea422a 105 if (str_to_decimal(fname, &val, 1, o)) {
564ca972 106 log_err("fio: bssplit conversion failed\n");
83ea422a 107 free(o->bssplit);
564ca972
JA
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
83ea422a 121 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;
83ea422a 127 for (i = 0; i < o->bssplit_nr[ddir]; i++) {
720e84ad 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) {
83ea422a 146 for (i = 0; i < o->bssplit_nr[ddir]; i++) {
720e84ad 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
83ea422a
JA
154 o->min_bs[ddir] = min_bs;
155 o->max_bs[ddir] = max_bs;
564ca972
JA
156
157 /*
158 * now sort based on percentages, for ease of lookup
159 */
83ea422a
JA
160 qsort(bssplit, o->bssplit_nr[ddir], sizeof(struct bssplit), bs_cmp);
161 o->bssplit[ddir] = bssplit;
720e84ad 162 return 0;
720e84ad
JA
163}
164
165static int str_bssplit_cb(void *data, const char *input)
166{
167 struct thread_data *td = data;
6eaf09d6 168 char *str, *p, *odir, *ddir;
720e84ad
JA
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) {
6eaf09d6
SL
178 ddir = strchr(odir + 1, ',');
179 if (ddir) {
d79db122 180 ret = bssplit_ddir(&td->o, DDIR_TRIM, ddir + 1);
6eaf09d6
SL
181 if (!ret)
182 *ddir = '\0';
183 } else {
184 char *op;
185
186 op = strdup(odir + 1);
d79db122 187 ret = bssplit_ddir(&td->o, DDIR_TRIM, op);
6eaf09d6
SL
188
189 free(op);
190 }
d79db122
JA
191 if (!ret)
192 ret = bssplit_ddir(&td->o, DDIR_WRITE, odir + 1);
720e84ad
JA
193 if (!ret) {
194 *odir = '\0';
83ea422a 195 ret = bssplit_ddir(&td->o, DDIR_READ, str);
720e84ad
JA
196 }
197 } else {
198 char *op;
199
200 op = strdup(str);
d79db122 201 ret = bssplit_ddir(&td->o, DDIR_WRITE, op);
6eaf09d6 202 free(op);
720e84ad 203
6eaf09d6
SL
204 if (!ret) {
205 op = strdup(str);
d79db122 206 ret = bssplit_ddir(&td->o, DDIR_TRIM, op);
6eaf09d6
SL
207 free(op);
208 }
83ea422a 209 ret = bssplit_ddir(&td->o, DDIR_READ, str);
720e84ad 210 }
564ca972
JA
211
212 free(p);
720e84ad 213 return ret;
564ca972
JA
214}
215
8b28bd41
DM
216static int str2error(char *str)
217{
a94eb99a 218 const char *err[] = { "EPERM", "ENOENT", "ESRCH", "EINTR", "EIO",
8b28bd41
DM
219 "ENXIO", "E2BIG", "ENOEXEC", "EBADF",
220 "ECHILD", "EAGAIN", "ENOMEM", "EACCES",
221 "EFAULT", "ENOTBLK", "EBUSY", "EEXIST",
222 "EXDEV", "ENODEV", "ENOTDIR", "EISDIR",
223 "EINVAL", "ENFILE", "EMFILE", "ENOTTY",
224 "ETXTBSY","EFBIG", "ENOSPC", "ESPIPE",
a94eb99a 225 "EROFS","EMLINK", "EPIPE", "EDOM", "ERANGE" };
8b28bd41
DM
226 int i = 0, num = sizeof(err) / sizeof(void *);
227
a94eb99a 228 while (i < num) {
8b28bd41
DM
229 if (!strcmp(err[i], str))
230 return i + 1;
231 i++;
232 }
233 return 0;
234}
235
236static int ignore_error_type(struct thread_data *td, int etype, char *str)
237{
238 unsigned int i;
239 int *error;
240 char *fname;
241
242 if (etype >= ERROR_TYPE_CNT) {
243 log_err("Illegal error type\n");
244 return 1;
245 }
246
247 td->o.ignore_error_nr[etype] = 4;
248 error = malloc(4 * sizeof(struct bssplit));
249
250 i = 0;
251 while ((fname = strsep(&str, ":")) != NULL) {
252
253 if (!strlen(fname))
254 break;
255
256 /*
257 * grow struct buffer, if needed
258 */
259 if (i == td->o.ignore_error_nr[etype]) {
260 td->o.ignore_error_nr[etype] <<= 1;
261 error = realloc(error, td->o.ignore_error_nr[etype]
262 * sizeof(int));
263 }
264 if (fname[0] == 'E') {
265 error[i] = str2error(fname);
266 } else {
267 error[i] = atoi(fname);
268 if (error[i] < 0)
269 error[i] = error[i];
270 }
271 if (!error[i]) {
272 log_err("Unknown error %s, please use number value \n",
273 fname);
274 return 1;
275 }
276 i++;
277 }
278 if (i) {
279 td->o.continue_on_error |= 1 << etype;
280 td->o.ignore_error_nr[etype] = i;
281 td->o.ignore_error[etype] = error;
282 }
283 return 0;
284
285}
286
287static int str_ignore_error_cb(void *data, const char *input)
288{
289 struct thread_data *td = data;
290 char *str, *p, *n;
291 int type = 0, ret = 1;
292 p = str = strdup(input);
293
294 strip_blank_front(&str);
295 strip_blank_end(str);
296
297 while (p) {
298 n = strchr(p, ',');
299 if (n)
300 *n++ = '\0';
301 ret = ignore_error_type(td, type, p);
302 if (ret)
303 break;
304 p = n;
305 type++;
306 }
307 free(str);
308 return ret;
309}
310
211097b2
JA
311static int str_rw_cb(void *data, const char *str)
312{
313 struct thread_data *td = data;
83ea422a 314 struct thread_options *o = &td->o;
211097b2
JA
315 char *nr = get_opt_postfix(str);
316
83ea422a
JA
317 o->ddir_seq_nr = 1;
318 o->ddir_seq_add = 0;
059b0802
JA
319
320 if (!nr)
321 return 0;
322
323 if (td_random(td))
83ea422a 324 o->ddir_seq_nr = atoi(nr);
059b0802
JA
325 else {
326 long long val;
327
83ea422a 328 if (str_to_decimal(nr, &val, 1, o)) {
059b0802
JA
329 log_err("fio: rw postfix parsing failed\n");
330 free(nr);
331 return 1;
332 }
333
83ea422a 334 o->ddir_seq_add = val;
182ec6ee 335 }
211097b2 336
059b0802 337 free(nr);
211097b2
JA
338 return 0;
339}
340
214e1eca
JA
341static int str_mem_cb(void *data, const char *mem)
342{
343 struct thread_data *td = data;
83ea422a 344 struct thread_options *o = &td->o;
214e1eca 345
83ea422a
JA
346 if (o->mem_type == MEM_MMAPHUGE || o->mem_type == MEM_MMAP) {
347 o->mmapfile = get_opt_postfix(mem);
348 if (o->mem_type == MEM_MMAPHUGE && !o->mmapfile) {
214e1eca
JA
349 log_err("fio: mmaphuge:/path/to/file\n");
350 return 1;
351 }
352 }
353
354 return 0;
355}
356
c223da83
JA
357static int fio_clock_source_cb(void *data, const char *str)
358{
359 struct thread_data *td = data;
360
361 fio_clock_source = td->o.clocksource;
362 fio_time_init();
363 return 0;
364}
365
85bc833b 366static int str_rwmix_read_cb(void *data, unsigned long long *val)
cb499fc4
JA
367{
368 struct thread_data *td = data;
369
370 td->o.rwmix[DDIR_READ] = *val;
371 td->o.rwmix[DDIR_WRITE] = 100 - *val;
372 return 0;
373}
374
85bc833b 375static int str_rwmix_write_cb(void *data, unsigned long long *val)
cb499fc4
JA
376{
377 struct thread_data *td = data;
378
379 td->o.rwmix[DDIR_WRITE] = *val;
380 td->o.rwmix[DDIR_READ] = 100 - *val;
381 return 0;
382}
383
214e1eca
JA
384static int str_exitall_cb(void)
385{
386 exitall_on_terminate = 1;
387 return 0;
388}
389
214e1eca 390#ifdef FIO_HAVE_CPU_AFFINITY
85bc833b 391static int str_cpumask_cb(void *data, unsigned long long *val)
d2e268b0
JA
392{
393 struct thread_data *td = data;
214e1eca 394 unsigned int i;
b03daafb 395 long max_cpu;
d2ce18b5
JA
396 int ret;
397
398 ret = fio_cpuset_init(&td->o.cpumask);
399 if (ret < 0) {
400 log_err("fio: cpuset_init failed\n");
401 td_verror(td, ret, "fio_cpuset_init");
402 return 1;
403 }
214e1eca 404
c00a2289 405 max_cpu = cpus_online();
214e1eca 406
62a7273d
JA
407 for (i = 0; i < sizeof(int) * 8; i++) {
408 if ((1 << i) & *val) {
b03daafb
JA
409 if (i > max_cpu) {
410 log_err("fio: CPU %d too large (max=%ld)\n", i,
411 max_cpu);
412 return 1;
413 }
62a7273d 414 dprint(FD_PARSE, "set cpu allowed %d\n", i);
6d459ee7 415 fio_cpu_set(&td->o.cpumask, i);
62a7273d
JA
416 }
417 }
d2e268b0
JA
418
419 td->o.cpumask_set = 1;
420 return 0;
214e1eca
JA
421}
422
e8462bd8
JA
423static int set_cpus_allowed(struct thread_data *td, os_cpu_mask_t *mask,
424 const char *input)
214e1eca 425{
d2e268b0 426 char *cpu, *str, *p;
b03daafb 427 long max_cpu;
19608d6c 428 int ret = 0;
d2e268b0 429
e8462bd8 430 ret = fio_cpuset_init(mask);
d2ce18b5
JA
431 if (ret < 0) {
432 log_err("fio: cpuset_init failed\n");
433 td_verror(td, ret, "fio_cpuset_init");
434 return 1;
435 }
d2e268b0
JA
436
437 p = str = strdup(input);
214e1eca 438
d2e268b0
JA
439 strip_blank_front(&str);
440 strip_blank_end(str);
441
c00a2289 442 max_cpu = cpus_online();
b03daafb 443
d2e268b0 444 while ((cpu = strsep(&str, ",")) != NULL) {
62a7273d
JA
445 char *str2, *cpu2;
446 int icpu, icpu2;
447
d2e268b0
JA
448 if (!strlen(cpu))
449 break;
62a7273d
JA
450
451 str2 = cpu;
452 icpu2 = -1;
453 while ((cpu2 = strsep(&str2, "-")) != NULL) {
454 if (!strlen(cpu2))
455 break;
456
457 icpu2 = atoi(cpu2);
458 }
459
460 icpu = atoi(cpu);
461 if (icpu2 == -1)
462 icpu2 = icpu;
463 while (icpu <= icpu2) {
6d459ee7 464 if (icpu >= FIO_MAX_CPUS) {
19608d6c 465 log_err("fio: your OS only supports up to"
6d459ee7 466 " %d CPUs\n", (int) FIO_MAX_CPUS);
19608d6c
JA
467 ret = 1;
468 break;
469 }
b03daafb
JA
470 if (icpu > max_cpu) {
471 log_err("fio: CPU %d too large (max=%ld)\n",
472 icpu, max_cpu);
473 ret = 1;
474 break;
475 }
0b9d69ec 476
62a7273d 477 dprint(FD_PARSE, "set cpu allowed %d\n", icpu);
e8462bd8 478 fio_cpu_set(mask, icpu);
62a7273d
JA
479 icpu++;
480 }
19608d6c
JA
481 if (ret)
482 break;
d2e268b0
JA
483 }
484
485 free(p);
19608d6c
JA
486 if (!ret)
487 td->o.cpumask_set = 1;
488 return ret;
214e1eca 489}
e8462bd8
JA
490
491static int str_cpus_allowed_cb(void *data, const char *input)
492{
493 struct thread_data *td = data;
494 int ret;
495
496 ret = set_cpus_allowed(td, &td->o.cpumask, input);
497 if (!ret)
498 td->o.cpumask_set = 1;
499
500 return ret;
501}
502
503static int str_verify_cpus_allowed_cb(void *data, const char *input)
504{
505 struct thread_data *td = data;
506 int ret;
507
508 ret = set_cpus_allowed(td, &td->o.verify_cpumask, input);
509 if (!ret)
510 td->o.verify_cpumask_set = 1;
511
512 return ret;
513}
d2e268b0 514#endif
214e1eca 515
d0b937ed
YR
516#ifdef FIO_HAVE_LIBNUMA
517static int str_numa_cpunodes_cb(void *data, char *input)
518{
519 struct thread_data *td = data;
520
521 /* numa_parse_nodestring() parses a character string list
522 * of nodes into a bit mask. The bit mask is allocated by
523 * numa_allocate_nodemask(), so it should be freed by
524 * numa_free_nodemask().
525 */
526 td->o.numa_cpunodesmask = numa_parse_nodestring(input);
527 if (td->o.numa_cpunodesmask == NULL) {
528 log_err("fio: numa_parse_nodestring failed\n");
529 td_verror(td, 1, "str_numa_cpunodes_cb");
530 return 1;
531 }
532
533 td->o.numa_cpumask_set = 1;
534 return 0;
535}
536
537static int str_numa_mpol_cb(void *data, char *input)
538{
539 struct thread_data *td = data;
540 const char * const policy_types[] =
541 { "default", "prefer", "bind", "interleave", "local" };
542 int i;
543
544 char *nodelist = strchr(input, ':');
545 if (nodelist) {
546 /* NUL-terminate mode */
547 *nodelist++ = '\0';
548 }
549
550 for (i = 0; i <= MPOL_LOCAL; i++) {
551 if (!strcmp(input, policy_types[i])) {
552 td->o.numa_mem_mode = i;
553 break;
554 }
555 }
556 if (i > MPOL_LOCAL) {
557 log_err("fio: memory policy should be: default, prefer, bind, interleave, local\n");
558 goto out;
559 }
560
561 switch (td->o.numa_mem_mode) {
562 case MPOL_PREFERRED:
563 /*
564 * Insist on a nodelist of one node only
565 */
566 if (nodelist) {
567 char *rest = nodelist;
568 while (isdigit(*rest))
569 rest++;
570 if (*rest) {
571 log_err("fio: one node only for \'prefer\'\n");
572 goto out;
573 }
574 } else {
575 log_err("fio: one node is needed for \'prefer\'\n");
576 goto out;
577 }
578 break;
579 case MPOL_INTERLEAVE:
580 /*
581 * Default to online nodes with memory if no nodelist
582 */
583 if (!nodelist)
584 nodelist = strdup("all");
585 break;
586 case MPOL_LOCAL:
587 case MPOL_DEFAULT:
588 /*
589 * Don't allow a nodelist
590 */
591 if (nodelist) {
592 log_err("fio: NO nodelist for \'local\'\n");
593 goto out;
594 }
595 break;
596 case MPOL_BIND:
597 /*
598 * Insist on a nodelist
599 */
600 if (!nodelist) {
601 log_err("fio: a nodelist is needed for \'bind\'\n");
602 goto out;
603 }
604 break;
605 }
606
607
608 /* numa_parse_nodestring() parses a character string list
609 * of nodes into a bit mask. The bit mask is allocated by
610 * numa_allocate_nodemask(), so it should be freed by
611 * numa_free_nodemask().
612 */
613 switch (td->o.numa_mem_mode) {
614 case MPOL_PREFERRED:
615 td->o.numa_mem_prefer_node = atoi(nodelist);
616 break;
617 case MPOL_INTERLEAVE:
618 case MPOL_BIND:
619 td->o.numa_memnodesmask = numa_parse_nodestring(nodelist);
620 if (td->o.numa_memnodesmask == NULL) {
621 log_err("fio: numa_parse_nodestring failed\n");
622 td_verror(td, 1, "str_numa_memnodes_cb");
623 return 1;
624 }
625 break;
626 case MPOL_LOCAL:
627 case MPOL_DEFAULT:
628 default:
629 break;
630 }
631
632 td->o.numa_memmask_set = 1;
633 return 0;
634
635out:
636 return 1;
637}
638#endif
639
214e1eca
JA
640static int str_fst_cb(void *data, const char *str)
641{
642 struct thread_data *td = data;
643 char *nr = get_opt_postfix(str);
644
645 td->file_service_nr = 1;
182ec6ee 646 if (nr) {
214e1eca 647 td->file_service_nr = atoi(nr);
182ec6ee
JA
648 free(nr);
649 }
214e1eca
JA
650
651 return 0;
652}
653
3ae06371 654#ifdef FIO_HAVE_SYNC_FILE_RANGE
44f29692
JA
655static int str_sfr_cb(void *data, const char *str)
656{
657 struct thread_data *td = data;
658 char *nr = get_opt_postfix(str);
659
660 td->sync_file_range_nr = 1;
661 if (nr) {
662 td->sync_file_range_nr = atoi(nr);
663 free(nr);
664 }
665
666 return 0;
667}
3ae06371 668#endif
44f29692 669
e25839d4
JA
670static int str_random_distribution_cb(void *data, const char *str)
671{
672 struct thread_data *td = data;
673 double val;
674 char *nr;
675
925fee33
JA
676 if (td->o.random_distribution == FIO_RAND_DIST_ZIPF)
677 val = 1.1;
678 else if (td->o.random_distribution == FIO_RAND_DIST_PARETO)
679 val = 0.2;
680 else
e25839d4
JA
681 return 0;
682
683 nr = get_opt_postfix(str);
925fee33 684 if (nr && !str_to_float(nr, &val)) {
e25839d4
JA
685 log_err("fio: random postfix parsing failed\n");
686 free(nr);
687 return 1;
688 }
689
078189c1
JA
690 free(nr);
691
18ded917
JA
692 if (td->o.random_distribution == FIO_RAND_DIST_ZIPF) {
693 if (val == 1.00) {
694 log_err("fio: zipf theta must different than 1.0\n");
695 return 1;
696 }
1e5324e7 697 td->o.zipf_theta.u.f = val;
18ded917 698 } else {
078189c1
JA
699 if (val <= 0.00 || val >= 1.00) {
700 log_err("fio: pareto input out of range (0 < input < 1.0)\n");
701 return 1;
702 }
1e5324e7 703 td->o.pareto_h.u.f = val;
fcef0b35 704 }
921c766f
JA
705
706 return 0;
707}
708
8e827d35
JA
709/*
710 * Return next file in the string. Files are separated with ':'. If the ':'
711 * is escaped with a '\', then that ':' is part of the filename and does not
712 * indicate a new file.
713 */
714static char *get_next_file_name(char **ptr)
715{
716 char *str = *ptr;
717 char *p, *start;
718
719 if (!str || !strlen(str))
720 return NULL;
721
722 start = str;
723 do {
724 /*
725 * No colon, we are done
726 */
727 p = strchr(str, ':');
728 if (!p) {
729 *ptr = NULL;
730 break;
731 }
732
733 /*
734 * We got a colon, but it's the first character. Skip and
735 * continue
736 */
737 if (p == start) {
738 str = ++start;
739 continue;
740 }
741
742 if (*(p - 1) != '\\') {
743 *p = '\0';
744 *ptr = p + 1;
745 break;
746 }
747
748 memmove(p - 1, p, strlen(p) + 1);
749 str = p;
750 } while (1);
751
752 return start;
753}
754
214e1eca
JA
755static int str_filename_cb(void *data, const char *input)
756{
757 struct thread_data *td = data;
758 char *fname, *str, *p;
759
760 p = str = strdup(input);
761
762 strip_blank_front(&str);
763 strip_blank_end(str);
764
765 if (!td->files_index)
2dc1bbeb 766 td->o.nr_files = 0;
214e1eca 767
8e827d35 768 while ((fname = get_next_file_name(&str)) != NULL) {
214e1eca
JA
769 if (!strlen(fname))
770 break;
771 add_file(td, fname);
2dc1bbeb 772 td->o.nr_files++;
214e1eca
JA
773 }
774
775 free(p);
776 return 0;
777}
778
779static int str_directory_cb(void *data, const char fio_unused *str)
780{
781 struct thread_data *td = data;
782 struct stat sb;
783
2dc1bbeb 784 if (lstat(td->o.directory, &sb) < 0) {
921c766f
JA
785 int ret = errno;
786
2dc1bbeb 787 log_err("fio: %s is not a directory\n", td->o.directory);
921c766f 788 td_verror(td, ret, "lstat");
214e1eca
JA
789 return 1;
790 }
791 if (!S_ISDIR(sb.st_mode)) {
2dc1bbeb 792 log_err("fio: %s is not a directory\n", td->o.directory);
214e1eca
JA
793 return 1;
794 }
795
796 return 0;
797}
798
799static int str_opendir_cb(void *data, const char fio_unused *str)
800{
801 struct thread_data *td = data;
802
803 if (!td->files_index)
2dc1bbeb 804 td->o.nr_files = 0;
214e1eca 805
2dc1bbeb 806 return add_dir_files(td, td->o.opendir);
214e1eca
JA
807}
808
0e92f873 809static int str_verify_pattern_cb(void *data, const char *input)
90059d65
JA
810{
811 struct thread_data *td = data;
0e92f873
RR
812 long off;
813 int i = 0, j = 0, len, k, base = 10;
3c3ed070 814 char *loc1, *loc2;
0e92f873
RR
815
816 loc1 = strstr(input, "0x");
817 loc2 = strstr(input, "0X");
818 if (loc1 || loc2)
819 base = 16;
820 off = strtol(input, NULL, base);
821 if (off != LONG_MAX || errno != ERANGE) {
822 while (off) {
823 td->o.verify_pattern[i] = off & 0xff;
824 off >>= 8;
825 i++;
826 }
827 } else {
828 len = strlen(input);
829 k = len - 1;
830 if (base == 16) {
831 if (loc1)
832 j = loc1 - input + 2;
833 else
834 j = loc2 - input + 2;
835 } else
836 return 1;
837 if (len - j < MAX_PATTERN_SIZE * 2) {
838 while (k >= j) {
839 off = converthexchartoint(input[k--]);
840 if (k >= j)
841 off += (converthexchartoint(input[k--])
842 * 16);
843 td->o.verify_pattern[i++] = (char) off;
844 }
845 }
846 }
efcd9dcc
SL
847
848 /*
849 * Fill the pattern all the way to the end. This greatly reduces
850 * the number of memcpy's we have to do when verifying the IO.
851 */
852 while (i > 1 && i * 2 <= MAX_PATTERN_SIZE) {
853 memcpy(&td->o.verify_pattern[i], &td->o.verify_pattern[0], i);
854 i *= 2;
855 }
9a2a86d0
SL
856 if (i == 1) {
857 /*
858 * The code in verify_io_u_pattern assumes a single byte pattern
859 * fills the whole verify pattern buffer.
860 */
861 memset(td->o.verify_pattern, td->o.verify_pattern[0],
862 MAX_PATTERN_SIZE);
863 }
efcd9dcc 864
0e92f873 865 td->o.verify_pattern_bytes = i;
efcd9dcc 866
92bf48d5
JA
867 /*
868 * VERIFY_META could already be set
869 */
870 if (td->o.verify == VERIFY_NONE)
871 td->o.verify = VERIFY_PATTERN;
efcd9dcc 872
90059d65
JA
873 return 0;
874}
214e1eca 875
4d4e80f2
JA
876static int str_lockfile_cb(void *data, const char *str)
877{
878 struct thread_data *td = data;
879 char *nr = get_opt_postfix(str);
880
881 td->o.lockfile_batch = 1;
182ec6ee 882 if (nr) {
4d4e80f2 883 td->o.lockfile_batch = atoi(nr);
182ec6ee
JA
884 free(nr);
885 }
4d4e80f2
JA
886
887 return 0;
888}
889
993bf48b
JA
890static int str_gtod_reduce_cb(void *data, int *il)
891{
892 struct thread_data *td = data;
893 int val = *il;
894
02af0988 895 td->o.disable_lat = !!val;
993bf48b
JA
896 td->o.disable_clat = !!val;
897 td->o.disable_slat = !!val;
898 td->o.disable_bw = !!val;
0dc1bc03 899 td->o.clat_percentiles = !val;
993bf48b
JA
900 if (val)
901 td->tv_cache_mask = 63;
902
903 return 0;
904}
905
85bc833b 906static int str_gtod_cpu_cb(void *data, long long *il)
be4ecfdf
JA
907{
908 struct thread_data *td = data;
909 int val = *il;
910
911 td->o.gtod_cpu = val;
912 td->o.gtod_offload = 1;
913 return 0;
914}
915
7bb59102
JA
916static int str_size_cb(void *data, unsigned long long *__val)
917{
918 struct thread_data *td = data;
919 unsigned long long v = *__val;
920
921 if (parse_is_percent(v)) {
922 td->o.size = 0;
923 td->o.size_percent = -1ULL - v;
924 } else
925 td->o.size = v;
926
927 return 0;
928}
929
896cac2a
JA
930static int rw_verify(struct fio_option *o, void *data)
931{
932 struct thread_data *td = data;
933
934 if (read_only && td_write(td)) {
935 log_err("fio: job <%s> has write bit set, but fio is in"
936 " read-only mode\n", td->o.name);
937 return 1;
938 }
939
940 return 0;
941}
942
276ca4f7 943static int gtod_cpu_verify(struct fio_option *o, void *data)
29d43ff9 944{
276ca4f7 945#ifndef FIO_HAVE_CPU_AFFINITY
29d43ff9
JA
946 struct thread_data *td = data;
947
29d43ff9
JA
948 if (td->o.gtod_cpu) {
949 log_err("fio: platform must support CPU affinity for"
950 "gettimeofday() offloading\n");
951 return 1;
952 }
953#endif
954
955 return 0;
956}
957
90fef2d1
JA
958static int kb_base_verify(struct fio_option *o, void *data)
959{
960 struct thread_data *td = data;
961
962 if (td->o.kb_base != 1024 && td->o.kb_base != 1000) {
963 log_err("fio: kb_base set to nonsensical value: %u\n",
964 td->o.kb_base);
965 return 1;
966 }
967
968 return 0;
969}
970
9af4a244
JA
971/*
972 * Option grouping
973 */
974static struct opt_group fio_opt_groups[] = {
975 {
e8b0e958
JA
976 .name = "General",
977 .mask = FIO_OPT_C_GENERAL,
9af4a244
JA
978 },
979 {
e8b0e958
JA
980 .name = "I/O",
981 .mask = FIO_OPT_C_IO,
9af4a244
JA
982 },
983 {
e8b0e958
JA
984 .name = "File",
985 .mask = FIO_OPT_C_FILE,
9af4a244
JA
986 },
987 {
e8b0e958
JA
988 .name = "Statistics",
989 .mask = FIO_OPT_C_STAT,
9af4a244
JA
990 },
991 {
e8b0e958
JA
992 .name = "Logging",
993 .mask = FIO_OPT_C_LOG,
9af4a244 994 },
13fca827
JA
995 {
996 .name = "Profiles",
997 .mask = FIO_OPT_C_PROFILE,
998 },
e231bbe6 999 {
e8b0e958 1000 .name = NULL,
e231bbe6 1001 },
e8b0e958
JA
1002};
1003
1004static struct opt_group *__opt_group_from_mask(struct opt_group *ogs, unsigned int *mask,
1005 unsigned int inv_mask)
1006{
1007 struct opt_group *og;
1008 int i;
1009
1010 if (*mask == inv_mask || !*mask)
1011 return NULL;
1012
1013 for (i = 0; ogs[i].name; i++) {
1014 og = &ogs[i];
1015
1016 if (*mask & og->mask) {
1017 *mask &= ~(og->mask);
1018 return og;
1019 }
1020 }
1021
1022 return NULL;
1023}
1024
1025struct opt_group *opt_group_from_mask(unsigned int *mask)
1026{
1027 return __opt_group_from_mask(fio_opt_groups, mask, FIO_OPT_C_INVALID);
1028}
1029
1030static struct opt_group fio_opt_cat_groups[] = {
9af4a244 1031 {
e8b0e958
JA
1032 .name = "Rate",
1033 .mask = FIO_OPT_G_RATE,
9af4a244
JA
1034 },
1035 {
e8b0e958
JA
1036 .name = "Zone",
1037 .mask = FIO_OPT_G_ZONE,
9af4a244
JA
1038 },
1039 {
e8b0e958
JA
1040 .name = "Read/write mix",
1041 .mask = FIO_OPT_G_RWMIX,
9af4a244
JA
1042 },
1043 {
1044 .name = "Verify",
1045 .mask = FIO_OPT_G_VERIFY,
1046 },
1047 {
e8b0e958
JA
1048 .name = "Trim",
1049 .mask = FIO_OPT_G_TRIM,
9af4a244
JA
1050 },
1051 {
e8b0e958
JA
1052 .name = "I/O Logging",
1053 .mask = FIO_OPT_G_IOLOG,
9af4a244
JA
1054 },
1055 {
e8b0e958
JA
1056 .name = "I/O Depth",
1057 .mask = FIO_OPT_G_IO_DEPTH,
9af4a244
JA
1058 },
1059 {
e8b0e958
JA
1060 .name = "I/O Flow",
1061 .mask = FIO_OPT_G_IO_FLOW,
9af4a244 1062 },
0626037e
JA
1063 {
1064 .name = "Description",
1065 .mask = FIO_OPT_G_DESC,
1066 },
1067 {
1068 .name = "Filename",
1069 .mask = FIO_OPT_G_FILENAME,
1070 },
1071 {
1072 .name = "General I/O",
1073 .mask = FIO_OPT_G_IO_BASIC,
1074 },
a1f6afec
JA
1075 {
1076 .name = "Cgroups",
1077 .mask = FIO_OPT_G_CGROUP,
1078 },
1079 {
1080 .name = "Runtime",
1081 .mask = FIO_OPT_G_RUNTIME,
1082 },
10860056
JA
1083 {
1084 .name = "Process",
1085 .mask = FIO_OPT_G_PROCESS,
1086 },
1087 {
1088 .name = "Job credentials / priority",
1089 .mask = FIO_OPT_G_CRED,
1090 },
1091 {
1092 .name = "Clock settings",
1093 .mask = FIO_OPT_G_CLOCK,
1094 },
3ceb458f
JA
1095 {
1096 .name = "I/O Type",
1097 .mask = FIO_OPT_G_IO_TYPE,
1098 },
1099 {
1100 .name = "I/O Thinktime",
1101 .mask = FIO_OPT_G_THINKTIME,
1102 },
1103 {
1104 .name = "Randomizations",
1105 .mask = FIO_OPT_G_RANDOM,
1106 },
1107 {
1108 .name = "I/O buffers",
1109 .mask = FIO_OPT_G_IO_BUF,
1110 },
13fca827
JA
1111 {
1112 .name = "Tiobench profile",
1113 .mask = FIO_OPT_G_TIOBENCH,
1114 },
1115
9af4a244
JA
1116 {
1117 .name = NULL,
e8b0e958 1118 }
9af4a244
JA
1119};
1120
e8b0e958 1121struct opt_group *opt_group_cat_from_mask(unsigned int *mask)
9af4a244 1122{
e8b0e958 1123 return __opt_group_from_mask(fio_opt_cat_groups, mask, FIO_OPT_G_INVALID);
9af4a244
JA
1124}
1125
214e1eca
JA
1126/*
1127 * Map of job/command line options
1128 */
9af4a244 1129struct fio_option fio_options[FIO_MAX_OPTS] = {
214e1eca
JA
1130 {
1131 .name = "description",
e8b0e958 1132 .lname = "Description of job",
214e1eca
JA
1133 .type = FIO_OPT_STR_STORE,
1134 .off1 = td_var_offset(description),
1135 .help = "Text job description",
e8b0e958 1136 .category = FIO_OPT_C_GENERAL,
0626037e 1137 .group = FIO_OPT_G_DESC,
214e1eca
JA
1138 },
1139 {
1140 .name = "name",
e8b0e958 1141 .lname = "Job name",
214e1eca
JA
1142 .type = FIO_OPT_STR_STORE,
1143 .off1 = td_var_offset(name),
1144 .help = "Name of this job",
e8b0e958 1145 .category = FIO_OPT_C_GENERAL,
0626037e 1146 .group = FIO_OPT_G_DESC,
214e1eca 1147 },
214e1eca
JA
1148 {
1149 .name = "filename",
e8b0e958 1150 .lname = "Filename(s)",
214e1eca
JA
1151 .type = FIO_OPT_STR_STORE,
1152 .off1 = td_var_offset(filename),
1153 .cb = str_filename_cb,
f0d524b0 1154 .prio = -1, /* must come after "directory" */
214e1eca 1155 .help = "File(s) to use for the workload",
e8b0e958 1156 .category = FIO_OPT_C_FILE,
0626037e 1157 .group = FIO_OPT_G_FILENAME,
214e1eca 1158 },
90fef2d1 1159 {
e8b0e958
JA
1160 .name = "directory",
1161 .lname = "Directory",
1162 .type = FIO_OPT_STR_STORE,
1163 .off1 = td_var_offset(directory),
1164 .cb = str_directory_cb,
1165 .help = "Directory to store files in",
1166 .category = FIO_OPT_C_FILE,
0626037e 1167 .group = FIO_OPT_G_FILENAME,
90fef2d1 1168 },
29c1349f
JA
1169 {
1170 .name = "lockfile",
e8b0e958 1171 .lname = "Lockfile",
4d4e80f2
JA
1172 .type = FIO_OPT_STR,
1173 .cb = str_lockfile_cb,
1174 .off1 = td_var_offset(file_lock_mode),
29c1349f
JA
1175 .help = "Lock file when doing IO to it",
1176 .parent = "filename",
d71c154c 1177 .hide = 0,
4d4e80f2 1178 .def = "none",
e8b0e958 1179 .category = FIO_OPT_C_FILE,
0626037e 1180 .group = FIO_OPT_G_FILENAME,
4d4e80f2
JA
1181 .posval = {
1182 { .ival = "none",
1183 .oval = FILE_LOCK_NONE,
1184 .help = "No file locking",
1185 },
1186 { .ival = "exclusive",
1187 .oval = FILE_LOCK_EXCLUSIVE,
1188 .help = "Exclusive file lock",
1189 },
1190 {
1191 .ival = "readwrite",
1192 .oval = FILE_LOCK_READWRITE,
1193 .help = "Read vs write lock",
1194 },
1195 },
29c1349f 1196 },
214e1eca
JA
1197 {
1198 .name = "opendir",
e8b0e958 1199 .lname = "Open directory",
214e1eca
JA
1200 .type = FIO_OPT_STR_STORE,
1201 .off1 = td_var_offset(opendir),
1202 .cb = str_opendir_cb,
1203 .help = "Recursively add files from this directory and down",
e8b0e958 1204 .category = FIO_OPT_C_FILE,
0626037e 1205 .group = FIO_OPT_G_FILENAME,
214e1eca
JA
1206 },
1207 {
1208 .name = "rw",
e8b0e958 1209 .lname = "Read/write",
d3aad8f2 1210 .alias = "readwrite",
214e1eca 1211 .type = FIO_OPT_STR,
211097b2 1212 .cb = str_rw_cb,
214e1eca
JA
1213 .off1 = td_var_offset(td_ddir),
1214 .help = "IO direction",
1215 .def = "read",
896cac2a 1216 .verify = rw_verify,
e8b0e958 1217 .category = FIO_OPT_C_IO,
0626037e 1218 .group = FIO_OPT_G_IO_BASIC,
214e1eca
JA
1219 .posval = {
1220 { .ival = "read",
1221 .oval = TD_DDIR_READ,
1222 .help = "Sequential read",
1223 },
1224 { .ival = "write",
1225 .oval = TD_DDIR_WRITE,
1226 .help = "Sequential write",
1227 },
6eaf09d6
SL
1228 { .ival = "trim",
1229 .oval = TD_DDIR_TRIM,
1230 .help = "Sequential trim",
1231 },
214e1eca
JA
1232 { .ival = "randread",
1233 .oval = TD_DDIR_RANDREAD,
1234 .help = "Random read",
1235 },
1236 { .ival = "randwrite",
1237 .oval = TD_DDIR_RANDWRITE,
1238 .help = "Random write",
1239 },
6eaf09d6
SL
1240 { .ival = "randtrim",
1241 .oval = TD_DDIR_RANDTRIM,
1242 .help = "Random trim",
1243 },
214e1eca
JA
1244 { .ival = "rw",
1245 .oval = TD_DDIR_RW,
1246 .help = "Sequential read and write mix",
1247 },
10b023db
JA
1248 { .ival = "readwrite",
1249 .oval = TD_DDIR_RW,
1250 .help = "Sequential read and write mix",
1251 },
214e1eca
JA
1252 { .ival = "randrw",
1253 .oval = TD_DDIR_RANDRW,
1254 .help = "Random read and write mix"
1255 },
1256 },
1257 },
38dad62d
JA
1258 {
1259 .name = "rw_sequencer",
e8b0e958 1260 .lname = "RW Sequencer",
38dad62d
JA
1261 .type = FIO_OPT_STR,
1262 .off1 = td_var_offset(rw_seq),
1263 .help = "IO offset generator modifier",
1264 .def = "sequential",
e8b0e958 1265 .category = FIO_OPT_C_IO,
0626037e 1266 .group = FIO_OPT_G_IO_BASIC,
38dad62d
JA
1267 .posval = {
1268 { .ival = "sequential",
1269 .oval = RW_SEQ_SEQ,
1270 .help = "Generate sequential offsets",
1271 },
1272 { .ival = "identical",
1273 .oval = RW_SEQ_IDENT,
1274 .help = "Generate identical offsets",
1275 },
1276 },
1277 },
1278
214e1eca
JA
1279 {
1280 .name = "ioengine",
e8b0e958 1281 .lname = "IO Engine",
214e1eca
JA
1282 .type = FIO_OPT_STR_STORE,
1283 .off1 = td_var_offset(ioengine),
1284 .help = "IO engine to use",
58483fa4 1285 .def = FIO_PREFERRED_ENGINE,
e8b0e958 1286 .category = FIO_OPT_C_IO,
0626037e 1287 .group = FIO_OPT_G_IO_BASIC,
214e1eca
JA
1288 .posval = {
1289 { .ival = "sync",
1290 .help = "Use read/write",
1291 },
a31041ea 1292 { .ival = "psync",
1293 .help = "Use pread/pwrite",
1294 },
1d2af02a 1295 { .ival = "vsync",
03e20d68 1296 .help = "Use readv/writev",
1d2af02a 1297 },
214e1eca
JA
1298#ifdef FIO_HAVE_LIBAIO
1299 { .ival = "libaio",
1300 .help = "Linux native asynchronous IO",
1301 },
1302#endif
1303#ifdef FIO_HAVE_POSIXAIO
1304 { .ival = "posixaio",
1305 .help = "POSIX asynchronous IO",
1306 },
417f0068
JA
1307#endif
1308#ifdef FIO_HAVE_SOLARISAIO
1309 { .ival = "solarisaio",
1310 .help = "Solaris native asynchronous IO",
1311 },
214e1eca 1312#endif
03e20d68
BC
1313#ifdef FIO_HAVE_WINDOWSAIO
1314 { .ival = "windowsaio",
3be80071 1315 .help = "Windows native asynchronous IO"
de890a1e 1316 },
3be80071 1317#endif
214e1eca 1318 { .ival = "mmap",
03e20d68 1319 .help = "Memory mapped IO"
214e1eca
JA
1320 },
1321#ifdef FIO_HAVE_SPLICE
1322 { .ival = "splice",
1323 .help = "splice/vmsplice based IO",
1324 },
9cce02e8
JA
1325 { .ival = "netsplice",
1326 .help = "splice/vmsplice to/from the network",
1327 },
214e1eca
JA
1328#endif
1329#ifdef FIO_HAVE_SGIO
1330 { .ival = "sg",
1331 .help = "SCSI generic v3 IO",
1332 },
1333#endif
1334 { .ival = "null",
1335 .help = "Testing engine (no data transfer)",
1336 },
1337 { .ival = "net",
1338 .help = "Network IO",
1339 },
1340#ifdef FIO_HAVE_SYSLET
1341 { .ival = "syslet-rw",
1342 .help = "syslet enabled async pread/pwrite IO",
1343 },
1344#endif
1345 { .ival = "cpuio",
03e20d68 1346 .help = "CPU cycle burner engine",
214e1eca 1347 },
b8c82a46
JA
1348#ifdef FIO_HAVE_GUASI
1349 { .ival = "guasi",
1350 .help = "GUASI IO engine",
1351 },
79a43187
JA
1352#endif
1353#ifdef FIO_HAVE_BINJECT
1354 { .ival = "binject",
1355 .help = "binject direct inject block engine",
1356 },
21b8aee8 1357#endif
1358#ifdef FIO_HAVE_RDMA
1359 { .ival = "rdma",
1360 .help = "RDMA IO engine",
1361 },
8200b8c7
JA
1362#endif
1363#ifdef FIO_HAVE_FUSION_AW
1364 { .ival = "fusion-aw-sync",
1365 .help = "Fusion-io atomic write engine",
1366 },
1ecc95ca
JA
1367#endif
1368#ifdef FIO_HAVE_E4_ENG
1369 { .ival = "e4defrag",
1370 .help = "ext4 defrag engine",
1371 },
1372#endif
1373#ifdef FIO_HAVE_FALLOC_ENG
1374 { .ival = "falloc",
1375 .help = "fallocate() file based engine",
1376 },
b8c82a46 1377#endif
214e1eca
JA
1378 { .ival = "external",
1379 .help = "Load external engine (append name)",
1380 },
1381 },
1382 },
1383 {
1384 .name = "iodepth",
e8b0e958 1385 .lname = "IO Depth",
214e1eca
JA
1386 .type = FIO_OPT_INT,
1387 .off1 = td_var_offset(iodepth),
03e20d68 1388 .help = "Number of IO buffers to keep in flight",
757aff4f 1389 .minval = 1,
20eb06bd 1390 .interval = 1,
214e1eca 1391 .def = "1",
e8b0e958 1392 .category = FIO_OPT_C_IO,
0626037e 1393 .group = FIO_OPT_G_IO_BASIC,
214e1eca
JA
1394 },
1395 {
1396 .name = "iodepth_batch",
e8b0e958 1397 .lname = "IO Depth batch",
4950421a 1398 .alias = "iodepth_batch_submit",
214e1eca
JA
1399 .type = FIO_OPT_INT,
1400 .off1 = td_var_offset(iodepth_batch),
d65db441 1401 .help = "Number of IO buffers to submit in one go",
afdf9352 1402 .parent = "iodepth",
d71c154c 1403 .hide = 1,
a2e6f8ac 1404 .minval = 1,
20eb06bd 1405 .interval = 1,
a2e6f8ac 1406 .def = "1",
e8b0e958 1407 .category = FIO_OPT_C_IO,
0626037e 1408 .group = FIO_OPT_G_IO_BASIC,
4950421a
JA
1409 },
1410 {
1411 .name = "iodepth_batch_complete",
e8b0e958 1412 .lname = "IO Depth batch complete",
4950421a
JA
1413 .type = FIO_OPT_INT,
1414 .off1 = td_var_offset(iodepth_batch_complete),
d65db441 1415 .help = "Number of IO buffers to retrieve in one go",
4950421a 1416 .parent = "iodepth",
d71c154c 1417 .hide = 1,
4950421a 1418 .minval = 0,
20eb06bd 1419 .interval = 1,
4950421a 1420 .def = "1",
e8b0e958 1421 .category = FIO_OPT_C_IO,
0626037e 1422 .group = FIO_OPT_G_IO_BASIC,
214e1eca
JA
1423 },
1424 {
1425 .name = "iodepth_low",
e8b0e958 1426 .lname = "IO Depth batch low",
214e1eca
JA
1427 .type = FIO_OPT_INT,
1428 .off1 = td_var_offset(iodepth_low),
1429 .help = "Low water mark for queuing depth",
afdf9352 1430 .parent = "iodepth",
d71c154c 1431 .hide = 1,
20eb06bd 1432 .interval = 1,
e8b0e958 1433 .category = FIO_OPT_C_IO,
0626037e 1434 .group = FIO_OPT_G_IO_BASIC,
214e1eca
JA
1435 },
1436 {
1437 .name = "size",
e8b0e958 1438 .lname = "Size",
214e1eca 1439 .type = FIO_OPT_STR_VAL,
7bb59102 1440 .cb = str_size_cb,
214e1eca 1441 .help = "Total size of device or files",
20eb06bd 1442 .interval = 1024 * 1024,
e8b0e958
JA
1443 .category = FIO_OPT_C_IO,
1444 .group = FIO_OPT_G_INVALID,
214e1eca 1445 },
aa31f1f1
SL
1446 {
1447 .name = "fill_device",
e8b0e958 1448 .lname = "Fill device",
74586c1e 1449 .alias = "fill_fs",
aa31f1f1
SL
1450 .type = FIO_OPT_BOOL,
1451 .off1 = td_var_offset(fill_device),
1452 .help = "Write until an ENOSPC error occurs",
1453 .def = "0",
e8b0e958
JA
1454 .category = FIO_OPT_C_FILE,
1455 .group = FIO_OPT_G_INVALID,
aa31f1f1 1456 },
214e1eca
JA
1457 {
1458 .name = "filesize",
e8b0e958 1459 .lname = "File size",
214e1eca
JA
1460 .type = FIO_OPT_STR_VAL,
1461 .off1 = td_var_offset(file_size_low),
1462 .off2 = td_var_offset(file_size_high),
c3edbdba 1463 .minval = 1,
214e1eca 1464 .help = "Size of individual files",
20eb06bd 1465 .interval = 1024 * 1024,
e8b0e958
JA
1466 .category = FIO_OPT_C_FILE,
1467 .group = FIO_OPT_G_INVALID,
214e1eca 1468 },
67a1000f
JA
1469 {
1470 .name = "offset",
e8b0e958 1471 .lname = "IO offset",
67a1000f
JA
1472 .alias = "fileoffset",
1473 .type = FIO_OPT_STR_VAL,
1474 .off1 = td_var_offset(start_offset),
1475 .help = "Start IO from this offset",
1476 .def = "0",
20eb06bd 1477 .interval = 1024 * 1024,
e8b0e958
JA
1478 .category = FIO_OPT_C_IO,
1479 .group = FIO_OPT_G_INVALID,
67a1000f 1480 },
2d7cd868
JA
1481 {
1482 .name = "offset_increment",
e8b0e958 1483 .lname = "IO offset increment",
2d7cd868
JA
1484 .type = FIO_OPT_STR_VAL,
1485 .off1 = td_var_offset(offset_increment),
1486 .help = "What is the increment from one offset to the next",
1487 .parent = "offset",
d71c154c 1488 .hide = 1,
2d7cd868 1489 .def = "0",
20eb06bd 1490 .interval = 1024 * 1024,
e8b0e958
JA
1491 .category = FIO_OPT_C_IO,
1492 .group = FIO_OPT_G_INVALID,
2d7cd868 1493 },
214e1eca
JA
1494 {
1495 .name = "bs",
e8b0e958 1496 .lname = "Block size",
d3aad8f2 1497 .alias = "blocksize",
e01b22b8 1498 .type = FIO_OPT_INT,
214e1eca
JA
1499 .off1 = td_var_offset(bs[DDIR_READ]),
1500 .off2 = td_var_offset(bs[DDIR_WRITE]),
6eaf09d6 1501 .off3 = td_var_offset(bs[DDIR_TRIM]),
c3edbdba 1502 .minval = 1,
214e1eca
JA
1503 .help = "Block size unit",
1504 .def = "4k",
67a1000f 1505 .parent = "rw",
d71c154c 1506 .hide = 1,
20eb06bd 1507 .interval = 512,
e8b0e958
JA
1508 .category = FIO_OPT_C_IO,
1509 .group = FIO_OPT_G_INVALID,
214e1eca 1510 },
2b7a01d0
JA
1511 {
1512 .name = "ba",
e8b0e958 1513 .lname = "Block size align",
2b7a01d0 1514 .alias = "blockalign",
e01b22b8 1515 .type = FIO_OPT_INT,
2b7a01d0
JA
1516 .off1 = td_var_offset(ba[DDIR_READ]),
1517 .off2 = td_var_offset(ba[DDIR_WRITE]),
6eaf09d6 1518 .off3 = td_var_offset(ba[DDIR_TRIM]),
2b7a01d0
JA
1519 .minval = 1,
1520 .help = "IO block offset alignment",
1521 .parent = "rw",
d71c154c 1522 .hide = 1,
20eb06bd 1523 .interval = 512,
e8b0e958
JA
1524 .category = FIO_OPT_C_IO,
1525 .group = FIO_OPT_G_INVALID,
2b7a01d0 1526 },
214e1eca
JA
1527 {
1528 .name = "bsrange",
e8b0e958 1529 .lname = "Block size range",
d3aad8f2 1530 .alias = "blocksize_range",
214e1eca
JA
1531 .type = FIO_OPT_RANGE,
1532 .off1 = td_var_offset(min_bs[DDIR_READ]),
1533 .off2 = td_var_offset(max_bs[DDIR_READ]),
1534 .off3 = td_var_offset(min_bs[DDIR_WRITE]),
1535 .off4 = td_var_offset(max_bs[DDIR_WRITE]),
6eaf09d6
SL
1536 .off5 = td_var_offset(min_bs[DDIR_TRIM]),
1537 .off6 = td_var_offset(max_bs[DDIR_TRIM]),
c3edbdba 1538 .minval = 1,
214e1eca 1539 .help = "Set block size range (in more detail than bs)",
67a1000f 1540 .parent = "rw",
d71c154c 1541 .hide = 1,
20eb06bd 1542 .interval = 4096,
e8b0e958
JA
1543 .category = FIO_OPT_C_IO,
1544 .group = FIO_OPT_G_INVALID,
214e1eca 1545 },
564ca972
JA
1546 {
1547 .name = "bssplit",
e8b0e958 1548 .lname = "Block size split",
564ca972
JA
1549 .type = FIO_OPT_STR,
1550 .cb = str_bssplit_cb,
1551 .help = "Set a specific mix of block sizes",
1552 .parent = "rw",
d71c154c 1553 .hide = 1,
e8b0e958
JA
1554 .category = FIO_OPT_C_IO,
1555 .group = FIO_OPT_G_INVALID,
564ca972 1556 },
214e1eca
JA
1557 {
1558 .name = "bs_unaligned",
e8b0e958 1559 .lname = "Block size unaligned",
d3aad8f2 1560 .alias = "blocksize_unaligned",
214e1eca
JA
1561 .type = FIO_OPT_STR_SET,
1562 .off1 = td_var_offset(bs_unaligned),
1563 .help = "Don't sector align IO buffer sizes",
67a1000f 1564 .parent = "rw",
d71c154c 1565 .hide = 1,
e8b0e958
JA
1566 .category = FIO_OPT_C_IO,
1567 .group = FIO_OPT_G_INVALID,
214e1eca
JA
1568 },
1569 {
1570 .name = "randrepeat",
e8b0e958 1571 .lname = "Random repeatable",
214e1eca
JA
1572 .type = FIO_OPT_BOOL,
1573 .off1 = td_var_offset(rand_repeatable),
1574 .help = "Use repeatable random IO pattern",
1575 .def = "1",
67a1000f 1576 .parent = "rw",
d71c154c 1577 .hide = 1,
e8b0e958 1578 .category = FIO_OPT_C_IO,
3ceb458f 1579 .group = FIO_OPT_G_RANDOM,
214e1eca 1580 },
2615cc4b
JA
1581 {
1582 .name = "use_os_rand",
e8b0e958 1583 .lname = "Use OS random",
2615cc4b
JA
1584 .type = FIO_OPT_BOOL,
1585 .off1 = td_var_offset(use_os_rand),
1586 .help = "Set to use OS random generator",
1587 .def = "0",
1588 .parent = "rw",
d71c154c 1589 .hide = 1,
e8b0e958 1590 .category = FIO_OPT_C_IO,
3ceb458f 1591 .group = FIO_OPT_G_RANDOM,
2615cc4b 1592 },
214e1eca
JA
1593 {
1594 .name = "norandommap",
e8b0e958 1595 .lname = "No randommap",
214e1eca
JA
1596 .type = FIO_OPT_STR_SET,
1597 .off1 = td_var_offset(norandommap),
1598 .help = "Accept potential duplicate random blocks",
67a1000f 1599 .parent = "rw",
d71c154c 1600 .hide = 1,
b2452a43 1601 .hide_on_set = 1,
e8b0e958 1602 .category = FIO_OPT_C_IO,
3ceb458f 1603 .group = FIO_OPT_G_RANDOM,
214e1eca 1604 },
2b386d25
JA
1605 {
1606 .name = "softrandommap",
e8b0e958 1607 .lname = "Soft randommap",
2b386d25
JA
1608 .type = FIO_OPT_BOOL,
1609 .off1 = td_var_offset(softrandommap),
f66ab3c8 1610 .help = "Set norandommap if randommap allocation fails",
2b386d25 1611 .parent = "norandommap",
d71c154c 1612 .hide = 1,
2b386d25 1613 .def = "0",
e8b0e958 1614 .category = FIO_OPT_C_IO,
3ceb458f 1615 .group = FIO_OPT_G_RANDOM,
2b386d25 1616 },
e25839d4
JA
1617 {
1618 .name = "random_distribution",
1619 .type = FIO_OPT_STR,
1620 .off1 = td_var_offset(random_distribution),
1621 .cb = str_random_distribution_cb,
1622 .help = "Random offset distribution generator",
1623 .def = "random",
1624 .posval = {
1625 { .ival = "random",
1626 .oval = FIO_RAND_DIST_RANDOM,
1627 .help = "Completely random",
1628 },
1629 { .ival = "zipf",
1630 .oval = FIO_RAND_DIST_ZIPF,
1631 .help = "Zipf distribution",
1632 },
925fee33
JA
1633 { .ival = "pareto",
1634 .oval = FIO_RAND_DIST_PARETO,
1635 .help = "Pareto distribution",
1636 },
e25839d4
JA
1637 },
1638 },
214e1eca
JA
1639 {
1640 .name = "nrfiles",
e8b0e958 1641 .lname = "Number of files",
d7c8be03 1642 .alias = "nr_files",
214e1eca
JA
1643 .type = FIO_OPT_INT,
1644 .off1 = td_var_offset(nr_files),
1645 .help = "Split job workload between this number of files",
1646 .def = "1",
20eb06bd 1647 .interval = 1,
e8b0e958
JA
1648 .category = FIO_OPT_C_FILE,
1649 .group = FIO_OPT_G_INVALID,
214e1eca
JA
1650 },
1651 {
1652 .name = "openfiles",
e8b0e958 1653 .lname = "Number of open files",
214e1eca
JA
1654 .type = FIO_OPT_INT,
1655 .off1 = td_var_offset(open_files),
1656 .help = "Number of files to keep open at the same time",
e8b0e958
JA
1657 .category = FIO_OPT_C_FILE,
1658 .group = FIO_OPT_G_INVALID,
214e1eca
JA
1659 },
1660 {
1661 .name = "file_service_type",
e8b0e958 1662 .lname = "File service type",
214e1eca
JA
1663 .type = FIO_OPT_STR,
1664 .cb = str_fst_cb,
1665 .off1 = td_var_offset(file_service_type),
1666 .help = "How to select which file to service next",
1667 .def = "roundrobin",
e8b0e958
JA
1668 .category = FIO_OPT_C_FILE,
1669 .group = FIO_OPT_G_INVALID,
214e1eca
JA
1670 .posval = {
1671 { .ival = "random",
1672 .oval = FIO_FSERVICE_RANDOM,
1673 .help = "Choose a file at random",
1674 },
1675 { .ival = "roundrobin",
1676 .oval = FIO_FSERVICE_RR,
1677 .help = "Round robin select files",
1678 },
a086c257
JA
1679 { .ival = "sequential",
1680 .oval = FIO_FSERVICE_SEQ,
1681 .help = "Finish one file before moving to the next",
1682 },
214e1eca 1683 },
67a1000f 1684 .parent = "nrfiles",
d71c154c 1685 .hide = 1,
67a1000f 1686 },
7bc8c2cf
JA
1687#ifdef FIO_HAVE_FALLOCATE
1688 {
1689 .name = "fallocate",
e8b0e958 1690 .lname = "Fallocate",
a596f047
EG
1691 .type = FIO_OPT_STR,
1692 .off1 = td_var_offset(fallocate_mode),
1693 .help = "Whether pre-allocation is performed when laying out files",
1694 .def = "posix",
e8b0e958
JA
1695 .category = FIO_OPT_C_FILE,
1696 .group = FIO_OPT_G_INVALID,
a596f047
EG
1697 .posval = {
1698 { .ival = "none",
1699 .oval = FIO_FALLOCATE_NONE,
1700 .help = "Do not pre-allocate space",
1701 },
1702 { .ival = "posix",
1703 .oval = FIO_FALLOCATE_POSIX,
1704 .help = "Use posix_fallocate()",
1705 },
1706#ifdef FIO_HAVE_LINUX_FALLOCATE
1707 { .ival = "keep",
1708 .oval = FIO_FALLOCATE_KEEP_SIZE,
1709 .help = "Use fallocate(..., FALLOC_FL_KEEP_SIZE, ...)",
1710 },
7bc8c2cf 1711#endif
a596f047
EG
1712 /* Compatibility with former boolean values */
1713 { .ival = "0",
1714 .oval = FIO_FALLOCATE_NONE,
1715 .help = "Alias for 'none'",
1716 },
1717 { .ival = "1",
1718 .oval = FIO_FALLOCATE_POSIX,
1719 .help = "Alias for 'posix'",
1720 },
1721 },
1722 },
1723#endif /* FIO_HAVE_FALLOCATE */
67a1000f
JA
1724 {
1725 .name = "fadvise_hint",
e8b0e958 1726 .lname = "Fadvise hint",
67a1000f
JA
1727 .type = FIO_OPT_BOOL,
1728 .off1 = td_var_offset(fadvise_hint),
1729 .help = "Use fadvise() to advise the kernel on IO pattern",
1730 .def = "1",
e8b0e958
JA
1731 .category = FIO_OPT_C_FILE,
1732 .group = FIO_OPT_G_INVALID,
214e1eca
JA
1733 },
1734 {
1735 .name = "fsync",
e8b0e958 1736 .lname = "Fsync",
214e1eca
JA
1737 .type = FIO_OPT_INT,
1738 .off1 = td_var_offset(fsync_blocks),
1739 .help = "Issue fsync for writes every given number of blocks",
1740 .def = "0",
20eb06bd 1741 .interval = 1,
e8b0e958
JA
1742 .category = FIO_OPT_C_FILE,
1743 .group = FIO_OPT_G_INVALID,
214e1eca 1744 },
5f9099ea
JA
1745 {
1746 .name = "fdatasync",
e8b0e958 1747 .lname = "Fdatasync",
5f9099ea
JA
1748 .type = FIO_OPT_INT,
1749 .off1 = td_var_offset(fdatasync_blocks),
1750 .help = "Issue fdatasync for writes every given number of blocks",
1751 .def = "0",
20eb06bd 1752 .interval = 1,
e8b0e958
JA
1753 .category = FIO_OPT_C_FILE,
1754 .group = FIO_OPT_G_INVALID,
5f9099ea 1755 },
1ef2b6be
JA
1756 {
1757 .name = "write_barrier",
e8b0e958 1758 .lname = "Write barrier",
1ef2b6be
JA
1759 .type = FIO_OPT_INT,
1760 .off1 = td_var_offset(barrier_blocks),
1761 .help = "Make every Nth write a barrier write",
1762 .def = "0",
20eb06bd 1763 .interval = 1,
e8b0e958
JA
1764 .category = FIO_OPT_C_IO,
1765 .group = FIO_OPT_G_INVALID,
1ef2b6be 1766 },
44f29692
JA
1767#ifdef FIO_HAVE_SYNC_FILE_RANGE
1768 {
1769 .name = "sync_file_range",
e8b0e958 1770 .lname = "Sync file range",
44f29692
JA
1771 .posval = {
1772 { .ival = "wait_before",
1773 .oval = SYNC_FILE_RANGE_WAIT_BEFORE,
1774 .help = "SYNC_FILE_RANGE_WAIT_BEFORE",
3843deb3 1775 .or = 1,
44f29692
JA
1776 },
1777 { .ival = "write",
1778 .oval = SYNC_FILE_RANGE_WRITE,
1779 .help = "SYNC_FILE_RANGE_WRITE",
3843deb3 1780 .or = 1,
44f29692
JA
1781 },
1782 {
1783 .ival = "wait_after",
1784 .oval = SYNC_FILE_RANGE_WAIT_AFTER,
1785 .help = "SYNC_FILE_RANGE_WAIT_AFTER",
3843deb3 1786 .or = 1,
44f29692
JA
1787 },
1788 },
3843deb3 1789 .type = FIO_OPT_STR_MULTI,
44f29692
JA
1790 .cb = str_sfr_cb,
1791 .off1 = td_var_offset(sync_file_range),
1792 .help = "Use sync_file_range()",
e8b0e958
JA
1793 .category = FIO_OPT_C_FILE,
1794 .group = FIO_OPT_G_INVALID,
44f29692
JA
1795 },
1796#endif
214e1eca
JA
1797 {
1798 .name = "direct",
e8b0e958 1799 .lname = "Direct I/O",
214e1eca
JA
1800 .type = FIO_OPT_BOOL,
1801 .off1 = td_var_offset(odirect),
1802 .help = "Use O_DIRECT IO (negates buffered)",
1803 .def = "0",
a01a1bc5 1804 .inverse = "buffered",
e8b0e958 1805 .category = FIO_OPT_C_IO,
3ceb458f 1806 .group = FIO_OPT_G_IO_TYPE,
214e1eca
JA
1807 },
1808 {
1809 .name = "buffered",
e8b0e958 1810 .lname = "Buffered I/O",
214e1eca
JA
1811 .type = FIO_OPT_BOOL,
1812 .off1 = td_var_offset(odirect),
1813 .neg = 1,
1814 .help = "Use buffered IO (negates direct)",
1815 .def = "1",
a01a1bc5 1816 .inverse = "direct",
e8b0e958 1817 .category = FIO_OPT_C_IO,
3ceb458f 1818 .group = FIO_OPT_G_IO_TYPE,
214e1eca
JA
1819 },
1820 {
1821 .name = "overwrite",
e8b0e958 1822 .lname = "Overwrite",
214e1eca
JA
1823 .type = FIO_OPT_BOOL,
1824 .off1 = td_var_offset(overwrite),
1825 .help = "When writing, set whether to overwrite current data",
1826 .def = "0",
e8b0e958
JA
1827 .category = FIO_OPT_C_FILE,
1828 .group = FIO_OPT_G_INVALID,
214e1eca
JA
1829 },
1830 {
1831 .name = "loops",
e8b0e958 1832 .lname = "Loops",
214e1eca
JA
1833 .type = FIO_OPT_INT,
1834 .off1 = td_var_offset(loops),
1835 .help = "Number of times to run the job",
1836 .def = "1",
20eb06bd 1837 .interval = 1,
e8b0e958 1838 .category = FIO_OPT_C_GENERAL,
a1f6afec 1839 .group = FIO_OPT_G_RUNTIME,
214e1eca
JA
1840 },
1841 {
1842 .name = "numjobs",
e8b0e958 1843 .lname = "Number of jobs",
214e1eca
JA
1844 .type = FIO_OPT_INT,
1845 .off1 = td_var_offset(numjobs),
1846 .help = "Duplicate this job this many times",
1847 .def = "1",
20eb06bd 1848 .interval = 1,
e8b0e958 1849 .category = FIO_OPT_C_GENERAL,
a1f6afec 1850 .group = FIO_OPT_G_RUNTIME,
214e1eca
JA
1851 },
1852 {
1853 .name = "startdelay",
e8b0e958 1854 .lname = "Start delay",
a5737c93 1855 .type = FIO_OPT_STR_VAL_TIME,
214e1eca
JA
1856 .off1 = td_var_offset(start_delay),
1857 .help = "Only start job when this period has passed",
1858 .def = "0",
e8b0e958 1859 .category = FIO_OPT_C_GENERAL,
a1f6afec 1860 .group = FIO_OPT_G_RUNTIME,
214e1eca
JA
1861 },
1862 {
1863 .name = "runtime",
e8b0e958 1864 .lname = "Runtime",
214e1eca
JA
1865 .alias = "timeout",
1866 .type = FIO_OPT_STR_VAL_TIME,
1867 .off1 = td_var_offset(timeout),
1868 .help = "Stop workload when this amount of time has passed",
1869 .def = "0",
e8b0e958 1870 .category = FIO_OPT_C_GENERAL,
a1f6afec 1871 .group = FIO_OPT_G_RUNTIME,
214e1eca 1872 },
cf4464ca
JA
1873 {
1874 .name = "time_based",
e8b0e958 1875 .lname = "Time based",
cf4464ca
JA
1876 .type = FIO_OPT_STR_SET,
1877 .off1 = td_var_offset(time_based),
1878 .help = "Keep running until runtime/timeout is met",
e8b0e958 1879 .category = FIO_OPT_C_GENERAL,
a1f6afec 1880 .group = FIO_OPT_G_RUNTIME,
cf4464ca 1881 },
721938ae
JA
1882 {
1883 .name = "ramp_time",
e8b0e958 1884 .lname = "Ramp time",
721938ae
JA
1885 .type = FIO_OPT_STR_VAL_TIME,
1886 .off1 = td_var_offset(ramp_time),
1887 .help = "Ramp up time before measuring performance",
e8b0e958 1888 .category = FIO_OPT_C_GENERAL,
a1f6afec 1889 .group = FIO_OPT_G_RUNTIME,
721938ae 1890 },
c223da83
JA
1891 {
1892 .name = "clocksource",
e8b0e958 1893 .lname = "Clock source",
c223da83
JA
1894 .type = FIO_OPT_STR,
1895 .cb = fio_clock_source_cb,
1896 .off1 = td_var_offset(clocksource),
1897 .help = "What type of timing source to use",
e8b0e958 1898 .category = FIO_OPT_C_GENERAL,
10860056 1899 .group = FIO_OPT_G_CLOCK,
c223da83
JA
1900 .posval = {
1901 { .ival = "gettimeofday",
1902 .oval = CS_GTOD,
1903 .help = "Use gettimeofday(2) for timing",
1904 },
1905 { .ival = "clock_gettime",
1906 .oval = CS_CGETTIME,
1907 .help = "Use clock_gettime(2) for timing",
1908 },
1909#ifdef ARCH_HAVE_CPU_CLOCK
1910 { .ival = "cpu",
1911 .oval = CS_CPUCLOCK,
1912 .help = "Use CPU private clock",
1913 },
1914#endif
1915 },
1916 },
214e1eca
JA
1917 {
1918 .name = "mem",
d3aad8f2 1919 .alias = "iomem",
e8b0e958 1920 .lname = "I/O Memory",
214e1eca
JA
1921 .type = FIO_OPT_STR,
1922 .cb = str_mem_cb,
1923 .off1 = td_var_offset(mem_type),
1924 .help = "Backing type for IO buffers",
1925 .def = "malloc",
e8b0e958
JA
1926 .category = FIO_OPT_C_IO,
1927 .group = FIO_OPT_G_INVALID,
214e1eca
JA
1928 .posval = {
1929 { .ival = "malloc",
1930 .oval = MEM_MALLOC,
1931 .help = "Use malloc(3) for IO buffers",
1932 },
37c8cdfe
JA
1933 { .ival = "shm",
1934 .oval = MEM_SHM,
1935 .help = "Use shared memory segments for IO buffers",
1936 },
214e1eca
JA
1937#ifdef FIO_HAVE_HUGETLB
1938 { .ival = "shmhuge",
1939 .oval = MEM_SHMHUGE,
1940 .help = "Like shm, but use huge pages",
1941 },
b370e46a 1942#endif
37c8cdfe
JA
1943 { .ival = "mmap",
1944 .oval = MEM_MMAP,
1945 .help = "Use mmap(2) (file or anon) for IO buffers",
1946 },
214e1eca
JA
1947#ifdef FIO_HAVE_HUGETLB
1948 { .ival = "mmaphuge",
1949 .oval = MEM_MMAPHUGE,
1950 .help = "Like mmap, but use huge pages",
1951 },
1952#endif
1953 },
1954 },
d529ee19
JA
1955 {
1956 .name = "iomem_align",
1957 .alias = "mem_align",
e8b0e958 1958 .lname = "I/O memory alignment",
d529ee19
JA
1959 .type = FIO_OPT_INT,
1960 .off1 = td_var_offset(mem_align),
1961 .minval = 0,
1962 .help = "IO memory buffer offset alignment",
1963 .def = "0",
1964 .parent = "iomem",
d71c154c 1965 .hide = 1,
e8b0e958
JA
1966 .category = FIO_OPT_C_IO,
1967 .group = FIO_OPT_G_INVALID,
d529ee19 1968 },
214e1eca
JA
1969 {
1970 .name = "verify",
e8b0e958 1971 .lname = "Verify",
214e1eca
JA
1972 .type = FIO_OPT_STR,
1973 .off1 = td_var_offset(verify),
1974 .help = "Verify data written",
1975 .def = "0",
e8b0e958 1976 .category = FIO_OPT_C_IO,
3ceb458f 1977 .group = FIO_OPT_G_VERIFY,
214e1eca
JA
1978 .posval = {
1979 { .ival = "0",
1980 .oval = VERIFY_NONE,
1981 .help = "Don't do IO verification",
1982 },
fcca4b58
JA
1983 { .ival = "md5",
1984 .oval = VERIFY_MD5,
1985 .help = "Use md5 checksums for verification",
1986 },
d77a7af3
JA
1987 { .ival = "crc64",
1988 .oval = VERIFY_CRC64,
1989 .help = "Use crc64 checksums for verification",
1990 },
214e1eca
JA
1991 { .ival = "crc32",
1992 .oval = VERIFY_CRC32,
1993 .help = "Use crc32 checksums for verification",
1994 },
af497e6a 1995 { .ival = "crc32c-intel",
e3aaafc4
JA
1996 .oval = VERIFY_CRC32C,
1997 .help = "Use crc32c checksums for verification (hw assisted, if available)",
af497e6a 1998 },
bac39e0e
JA
1999 { .ival = "crc32c",
2000 .oval = VERIFY_CRC32C,
e3aaafc4 2001 .help = "Use crc32c checksums for verification (hw assisted, if available)",
bac39e0e 2002 },
969f7ed3
JA
2003 { .ival = "crc16",
2004 .oval = VERIFY_CRC16,
2005 .help = "Use crc16 checksums for verification",
2006 },
1e154bdb
JA
2007 { .ival = "crc7",
2008 .oval = VERIFY_CRC7,
2009 .help = "Use crc7 checksums for verification",
2010 },
7c353ceb
JA
2011 { .ival = "sha1",
2012 .oval = VERIFY_SHA1,
2013 .help = "Use sha1 checksums for verification",
2014 },
cd14cc10
JA
2015 { .ival = "sha256",
2016 .oval = VERIFY_SHA256,
2017 .help = "Use sha256 checksums for verification",
2018 },
2019 { .ival = "sha512",
2020 .oval = VERIFY_SHA512,
2021 .help = "Use sha512 checksums for verification",
2022 },
7437ee87
SL
2023 { .ival = "meta",
2024 .oval = VERIFY_META,
2025 .help = "Use io information",
2026 },
36690c9b
JA
2027 {
2028 .ival = "null",
2029 .oval = VERIFY_NULL,
2030 .help = "Pretend to verify",
2031 },
214e1eca
JA
2032 },
2033 },
005c565a
JA
2034 {
2035 .name = "do_verify",
e8b0e958 2036 .lname = "Perform verify step",
68e1f29a 2037 .type = FIO_OPT_BOOL,
005c565a
JA
2038 .off1 = td_var_offset(do_verify),
2039 .help = "Run verification stage after write",
2040 .def = "1",
2041 .parent = "verify",
d71c154c 2042 .hide = 1,
e8b0e958
JA
2043 .category = FIO_OPT_C_IO,
2044 .group = FIO_OPT_G_VERIFY,
005c565a 2045 },
160b966d
JA
2046 {
2047 .name = "verifysort",
e8b0e958 2048 .lname = "Verify sort",
160b966d
JA
2049 .type = FIO_OPT_BOOL,
2050 .off1 = td_var_offset(verifysort),
2051 .help = "Sort written verify blocks for read back",
2052 .def = "1",
c83f2df1 2053 .parent = "verify",
d71c154c 2054 .hide = 1,
e8b0e958
JA
2055 .category = FIO_OPT_C_IO,
2056 .group = FIO_OPT_G_VERIFY,
160b966d 2057 },
3f9f4e26 2058 {
a59e170d 2059 .name = "verify_interval",
e8b0e958 2060 .lname = "Verify interval",
e01b22b8 2061 .type = FIO_OPT_INT,
a59e170d 2062 .off1 = td_var_offset(verify_interval),
819a9680 2063 .minval = 2 * sizeof(struct verify_header),
a59e170d 2064 .help = "Store verify buffer header every N bytes",
afdf9352 2065 .parent = "verify",
d71c154c 2066 .hide = 1,
20eb06bd 2067 .interval = 2 * sizeof(struct verify_header),
e8b0e958
JA
2068 .category = FIO_OPT_C_IO,
2069 .group = FIO_OPT_G_VERIFY,
3f9f4e26 2070 },
546a9142 2071 {
a59e170d 2072 .name = "verify_offset",
e8b0e958 2073 .lname = "Verify offset",
e01b22b8 2074 .type = FIO_OPT_INT,
a59e170d 2075 .help = "Offset verify header location by N bytes",
203160d5
JA
2076 .off1 = td_var_offset(verify_offset),
2077 .minval = sizeof(struct verify_header),
afdf9352 2078 .parent = "verify",
d71c154c 2079 .hide = 1,
e8b0e958
JA
2080 .category = FIO_OPT_C_IO,
2081 .group = FIO_OPT_G_VERIFY,
546a9142 2082 },
e28218f3
SL
2083 {
2084 .name = "verify_pattern",
e8b0e958 2085 .lname = "Verify pattern",
0e92f873 2086 .type = FIO_OPT_STR,
e28218f3
SL
2087 .cb = str_verify_pattern_cb,
2088 .help = "Fill pattern for IO buffers",
2089 .parent = "verify",
d71c154c 2090 .hide = 1,
e8b0e958
JA
2091 .category = FIO_OPT_C_IO,
2092 .group = FIO_OPT_G_VERIFY,
e28218f3 2093 },
a12a3b4d
JA
2094 {
2095 .name = "verify_fatal",
e8b0e958 2096 .lname = "Verify fatal",
68e1f29a 2097 .type = FIO_OPT_BOOL,
a12a3b4d
JA
2098 .off1 = td_var_offset(verify_fatal),
2099 .def = "0",
2100 .help = "Exit on a single verify failure, don't continue",
2101 .parent = "verify",
d71c154c 2102 .hide = 1,
e8b0e958
JA
2103 .category = FIO_OPT_C_IO,
2104 .group = FIO_OPT_G_VERIFY,
a12a3b4d 2105 },
b463e936
JA
2106 {
2107 .name = "verify_dump",
e8b0e958 2108 .lname = "Verify dump",
b463e936
JA
2109 .type = FIO_OPT_BOOL,
2110 .off1 = td_var_offset(verify_dump),
ef71e317 2111 .def = "0",
b463e936
JA
2112 .help = "Dump contents of good and bad blocks on failure",
2113 .parent = "verify",
d71c154c 2114 .hide = 1,
e8b0e958
JA
2115 .category = FIO_OPT_C_IO,
2116 .group = FIO_OPT_G_VERIFY,
b463e936 2117 },
e8462bd8
JA
2118 {
2119 .name = "verify_async",
e8b0e958 2120 .lname = "Verify asynchronously",
e8462bd8
JA
2121 .type = FIO_OPT_INT,
2122 .off1 = td_var_offset(verify_async),
2123 .def = "0",
2124 .help = "Number of async verifier threads to use",
2125 .parent = "verify",
d71c154c 2126 .hide = 1,
e8b0e958
JA
2127 .category = FIO_OPT_C_IO,
2128 .group = FIO_OPT_G_VERIFY,
e8462bd8 2129 },
9e144189
JA
2130 {
2131 .name = "verify_backlog",
e8b0e958 2132 .lname = "Verify backlog",
9e144189
JA
2133 .type = FIO_OPT_STR_VAL,
2134 .off1 = td_var_offset(verify_backlog),
2135 .help = "Verify after this number of blocks are written",
2136 .parent = "verify",
d71c154c 2137 .hide = 1,
e8b0e958
JA
2138 .category = FIO_OPT_C_IO,
2139 .group = FIO_OPT_G_VERIFY,
9e144189
JA
2140 },
2141 {
2142 .name = "verify_backlog_batch",
e8b0e958 2143 .lname = "Verify backlog batch",
9e144189
JA
2144 .type = FIO_OPT_INT,
2145 .off1 = td_var_offset(verify_batch),
2146 .help = "Verify this number of IO blocks",
0d29de83 2147 .parent = "verify",
d71c154c 2148 .hide = 1,
e8b0e958
JA
2149 .category = FIO_OPT_C_IO,
2150 .group = FIO_OPT_G_VERIFY,
9e144189 2151 },
e8462bd8
JA
2152#ifdef FIO_HAVE_CPU_AFFINITY
2153 {
2154 .name = "verify_async_cpus",
e8b0e958 2155 .lname = "Async verify CPUs",
e8462bd8
JA
2156 .type = FIO_OPT_STR,
2157 .cb = str_verify_cpus_allowed_cb,
2158 .help = "Set CPUs allowed for async verify threads",
2159 .parent = "verify_async",
d71c154c 2160 .hide = 1,
e8b0e958
JA
2161 .category = FIO_OPT_C_IO,
2162 .group = FIO_OPT_G_VERIFY,
e8462bd8 2163 },
0d29de83
JA
2164#endif
2165#ifdef FIO_HAVE_TRIM
2166 {
2167 .name = "trim_percentage",
e8b0e958 2168 .lname = "Trim percentage",
0d29de83 2169 .type = FIO_OPT_INT,
203160d5 2170 .off1 = td_var_offset(trim_percentage),
20eb06bd 2171 .minval = 0,
0d29de83
JA
2172 .maxval = 100,
2173 .help = "Number of verify blocks to discard/trim",
2174 .parent = "verify",
2175 .def = "0",
20eb06bd 2176 .interval = 1,
d71c154c 2177 .hide = 1,
e8b0e958
JA
2178 .category = FIO_OPT_C_IO,
2179 .group = FIO_OPT_G_TRIM,
0d29de83
JA
2180 },
2181 {
2182 .name = "trim_verify_zero",
e8b0e958 2183 .lname = "Verify trim zero",
20eb06bd 2184 .type = FIO_OPT_BOOL,
0d29de83
JA
2185 .help = "Verify that trim/discarded blocks are returned as zeroes",
2186 .off1 = td_var_offset(trim_zero),
2187 .parent = "trim_percentage",
d71c154c 2188 .hide = 1,
0d29de83 2189 .def = "1",
e8b0e958
JA
2190 .category = FIO_OPT_C_IO,
2191 .group = FIO_OPT_G_TRIM,
0d29de83
JA
2192 },
2193 {
2194 .name = "trim_backlog",
e8b0e958 2195 .lname = "Trim backlog",
0d29de83
JA
2196 .type = FIO_OPT_STR_VAL,
2197 .off1 = td_var_offset(trim_backlog),
2198 .help = "Trim after this number of blocks are written",
2199 .parent = "trim_percentage",
d71c154c 2200 .hide = 1,
20eb06bd 2201 .interval = 1,
e8b0e958
JA
2202 .category = FIO_OPT_C_IO,
2203 .group = FIO_OPT_G_TRIM,
0d29de83
JA
2204 },
2205 {
2206 .name = "trim_backlog_batch",
e8b0e958 2207 .lname = "Trim backlog batch",
0d29de83
JA
2208 .type = FIO_OPT_INT,
2209 .off1 = td_var_offset(trim_batch),
2210 .help = "Trim this number of IO blocks",
2211 .parent = "trim_percentage",
d71c154c 2212 .hide = 1,
20eb06bd 2213 .interval = 1,
e8b0e958
JA
2214 .category = FIO_OPT_C_IO,
2215 .group = FIO_OPT_G_TRIM,
0d29de83 2216 },
e8462bd8 2217#endif
214e1eca
JA
2218 {
2219 .name = "write_iolog",
e8b0e958 2220 .lname = "Write I/O log",
214e1eca
JA
2221 .type = FIO_OPT_STR_STORE,
2222 .off1 = td_var_offset(write_iolog_file),
2223 .help = "Store IO pattern to file",
e8b0e958
JA
2224 .category = FIO_OPT_C_IO,
2225 .group = FIO_OPT_G_IOLOG,
214e1eca
JA
2226 },
2227 {
2228 .name = "read_iolog",
e8b0e958 2229 .lname = "Read I/O log",
214e1eca
JA
2230 .type = FIO_OPT_STR_STORE,
2231 .off1 = td_var_offset(read_iolog_file),
2232 .help = "Playback IO pattern from file",
e8b0e958
JA
2233 .category = FIO_OPT_C_IO,
2234 .group = FIO_OPT_G_IOLOG,
214e1eca 2235 },
64bbb865
DN
2236 {
2237 .name = "replay_no_stall",
e8b0e958 2238 .lname = "Don't stall on replay",
20eb06bd 2239 .type = FIO_OPT_BOOL,
64bbb865
DN
2240 .off1 = td_var_offset(no_stall),
2241 .def = "0",
87e7a972 2242 .parent = "read_iolog",
d71c154c 2243 .hide = 1,
64bbb865 2244 .help = "Playback IO pattern file as fast as possible without stalls",
e8b0e958
JA
2245 .category = FIO_OPT_C_IO,
2246 .group = FIO_OPT_G_IOLOG,
64bbb865 2247 },
d1c46c04
DN
2248 {
2249 .name = "replay_redirect",
e8b0e958 2250 .lname = "Redirect device for replay",
d1c46c04
DN
2251 .type = FIO_OPT_STR_STORE,
2252 .off1 = td_var_offset(replay_redirect),
2253 .parent = "read_iolog",
d71c154c 2254 .hide = 1,
d1c46c04 2255 .help = "Replay all I/O onto this device, regardless of trace device",
e8b0e958
JA
2256 .category = FIO_OPT_C_IO,
2257 .group = FIO_OPT_G_IOLOG,
d1c46c04 2258 },
214e1eca
JA
2259 {
2260 .name = "exec_prerun",
e8b0e958 2261 .lname = "Pre-execute runnable",
214e1eca
JA
2262 .type = FIO_OPT_STR_STORE,
2263 .off1 = td_var_offset(exec_prerun),
2264 .help = "Execute this file prior to running job",
e8b0e958
JA
2265 .category = FIO_OPT_C_GENERAL,
2266 .group = FIO_OPT_G_INVALID,
214e1eca
JA
2267 },
2268 {
2269 .name = "exec_postrun",
e8b0e958 2270 .lname = "Post-execute runnable",
214e1eca
JA
2271 .type = FIO_OPT_STR_STORE,
2272 .off1 = td_var_offset(exec_postrun),
2273 .help = "Execute this file after running job",
e8b0e958
JA
2274 .category = FIO_OPT_C_GENERAL,
2275 .group = FIO_OPT_G_INVALID,
214e1eca
JA
2276 },
2277#ifdef FIO_HAVE_IOSCHED_SWITCH
2278 {
2279 .name = "ioscheduler",
e8b0e958 2280 .lname = "I/O scheduler",
214e1eca
JA
2281 .type = FIO_OPT_STR_STORE,
2282 .off1 = td_var_offset(ioscheduler),
2283 .help = "Use this IO scheduler on the backing device",
e8b0e958
JA
2284 .category = FIO_OPT_C_FILE,
2285 .group = FIO_OPT_G_INVALID,
214e1eca
JA
2286 },
2287#endif
2288 {
2289 .name = "zonesize",
e8b0e958 2290 .lname = "Zone size",
214e1eca
JA
2291 .type = FIO_OPT_STR_VAL,
2292 .off1 = td_var_offset(zone_size),
ed335855
SN
2293 .help = "Amount of data to read per zone",
2294 .def = "0",
20eb06bd 2295 .interval = 1024 * 1024,
e8b0e958
JA
2296 .category = FIO_OPT_C_IO,
2297 .group = FIO_OPT_G_ZONE,
ed335855
SN
2298 },
2299 {
2300 .name = "zonerange",
e8b0e958 2301 .lname = "Zone range",
ed335855
SN
2302 .type = FIO_OPT_STR_VAL,
2303 .off1 = td_var_offset(zone_range),
214e1eca
JA
2304 .help = "Give size of an IO zone",
2305 .def = "0",
20eb06bd 2306 .interval = 1024 * 1024,
e8b0e958
JA
2307 .category = FIO_OPT_C_IO,
2308 .group = FIO_OPT_G_ZONE,
214e1eca
JA
2309 },
2310 {
2311 .name = "zoneskip",
e8b0e958 2312 .lname = "Zone skip",
214e1eca
JA
2313 .type = FIO_OPT_STR_VAL,
2314 .off1 = td_var_offset(zone_skip),
2315 .help = "Space between IO zones",
2316 .def = "0",
20eb06bd 2317 .interval = 1024 * 1024,
e8b0e958
JA
2318 .category = FIO_OPT_C_IO,
2319 .group = FIO_OPT_G_ZONE,
214e1eca
JA
2320 },
2321 {
2322 .name = "lockmem",
e8b0e958 2323 .lname = "Lock memory",
214e1eca 2324 .type = FIO_OPT_STR_VAL,
1b79a070 2325 .off1 = td_var_offset(lockmem),
214e1eca
JA
2326 .help = "Lock down this amount of memory",
2327 .def = "0",
20eb06bd 2328 .interval = 1024 * 1024,
e8b0e958
JA
2329 .category = FIO_OPT_C_GENERAL,
2330 .group = FIO_OPT_G_INVALID,
214e1eca 2331 },
214e1eca
JA
2332 {
2333 .name = "rwmixread",
e8b0e958 2334 .lname = "Read/write mix read",
214e1eca 2335 .type = FIO_OPT_INT,
cb499fc4 2336 .cb = str_rwmix_read_cb,
214e1eca
JA
2337 .maxval = 100,
2338 .help = "Percentage of mixed workload that is reads",
2339 .def = "50",
20eb06bd 2340 .interval = 5,
90265353 2341 .inverse = "rwmixwrite",
e8b0e958
JA
2342 .category = FIO_OPT_C_IO,
2343 .group = FIO_OPT_G_RWMIX,
214e1eca
JA
2344 },
2345 {
2346 .name = "rwmixwrite",
e8b0e958 2347 .lname = "Read/write mix write",
214e1eca 2348 .type = FIO_OPT_INT,
cb499fc4 2349 .cb = str_rwmix_write_cb,
214e1eca
JA
2350 .maxval = 100,
2351 .help = "Percentage of mixed workload that is writes",
2352 .def = "50",
20eb06bd 2353 .interval = 5,
90265353 2354 .inverse = "rwmixread",
e8b0e958
JA
2355 .category = FIO_OPT_C_IO,
2356 .group = FIO_OPT_G_RWMIX,
214e1eca 2357 },
afdf9352
JA
2358 {
2359 .name = "rwmixcycle",
e8b0e958 2360 .lname = "Read/write mix cycle",
15ca150e 2361 .type = FIO_OPT_DEPRECATED,
e8b0e958
JA
2362 .category = FIO_OPT_C_IO,
2363 .group = FIO_OPT_G_RWMIX,
afdf9352 2364 },
214e1eca
JA
2365 {
2366 .name = "nice",
e8b0e958 2367 .lname = "Nice",
214e1eca
JA
2368 .type = FIO_OPT_INT,
2369 .off1 = td_var_offset(nice),
2370 .help = "Set job CPU nice value",
2371 .minval = -19,
2372 .maxval = 20,
2373 .def = "0",
20eb06bd 2374 .interval = 1,
e8b0e958 2375 .category = FIO_OPT_C_GENERAL,
10860056 2376 .group = FIO_OPT_G_CRED,
214e1eca
JA
2377 },
2378#ifdef FIO_HAVE_IOPRIO
2379 {
2380 .name = "prio",
e8b0e958 2381 .lname = "I/O nice priority",
214e1eca 2382 .type = FIO_OPT_INT,
28727df7 2383 .off1 = td_var_offset(ioprio),
214e1eca
JA
2384 .help = "Set job IO priority value",
2385 .minval = 0,
2386 .maxval = 7,
20eb06bd 2387 .interval = 1,
e8b0e958 2388 .category = FIO_OPT_C_GENERAL,
10860056 2389 .group = FIO_OPT_G_CRED,
214e1eca
JA
2390 },
2391 {
2392 .name = "prioclass",
e8b0e958 2393 .lname = "I/O nice priority class",
214e1eca 2394 .type = FIO_OPT_INT,
28727df7 2395 .off1 = td_var_offset(ioprio_class),
214e1eca
JA
2396 .help = "Set job IO priority class",
2397 .minval = 0,
2398 .maxval = 3,
20eb06bd 2399 .interval = 1,
e8b0e958 2400 .category = FIO_OPT_C_GENERAL,
10860056 2401 .group = FIO_OPT_G_CRED,
214e1eca
JA
2402 },
2403#endif
2404 {
2405 .name = "thinktime",
e8b0e958 2406 .lname = "Thinktime",
214e1eca
JA
2407 .type = FIO_OPT_INT,
2408 .off1 = td_var_offset(thinktime),
2409 .help = "Idle time between IO buffers (usec)",
2410 .def = "0",
e8b0e958 2411 .category = FIO_OPT_C_IO,
3ceb458f 2412 .group = FIO_OPT_G_THINKTIME,
214e1eca
JA
2413 },
2414 {
2415 .name = "thinktime_spin",
e8b0e958 2416 .lname = "Thinktime spin",
214e1eca
JA
2417 .type = FIO_OPT_INT,
2418 .off1 = td_var_offset(thinktime_spin),
2419 .help = "Start think time by spinning this amount (usec)",
2420 .def = "0",
afdf9352 2421 .parent = "thinktime",
d71c154c 2422 .hide = 1,
e8b0e958 2423 .category = FIO_OPT_C_IO,
3ceb458f 2424 .group = FIO_OPT_G_THINKTIME,
214e1eca
JA
2425 },
2426 {
2427 .name = "thinktime_blocks",
e8b0e958 2428 .lname = "Thinktime blocks",
214e1eca
JA
2429 .type = FIO_OPT_INT,
2430 .off1 = td_var_offset(thinktime_blocks),
2431 .help = "IO buffer period between 'thinktime'",
2432 .def = "1",
afdf9352 2433 .parent = "thinktime",
d71c154c 2434 .hide = 1,
e8b0e958 2435 .category = FIO_OPT_C_IO,
3ceb458f 2436 .group = FIO_OPT_G_THINKTIME,
214e1eca
JA
2437 },
2438 {
2439 .name = "rate",
e8b0e958 2440 .lname = "I/O rate",
e01b22b8 2441 .type = FIO_OPT_INT,
6eaf09d6
SL
2442 .off1 = td_var_offset(rate[DDIR_READ]),
2443 .off2 = td_var_offset(rate[DDIR_WRITE]),
2444 .off3 = td_var_offset(rate[DDIR_TRIM]),
214e1eca 2445 .help = "Set bandwidth rate",
e8b0e958
JA
2446 .category = FIO_OPT_C_IO,
2447 .group = FIO_OPT_G_RATE,
214e1eca
JA
2448 },
2449 {
2450 .name = "ratemin",
e8b0e958 2451 .lname = "I/O min rate",
e01b22b8 2452 .type = FIO_OPT_INT,
6eaf09d6
SL
2453 .off1 = td_var_offset(ratemin[DDIR_READ]),
2454 .off2 = td_var_offset(ratemin[DDIR_WRITE]),
2455 .off3 = td_var_offset(ratemin[DDIR_TRIM]),
4e991c23 2456 .help = "Job must meet this rate or it will be shutdown",
afdf9352 2457 .parent = "rate",
d71c154c 2458 .hide = 1,
e8b0e958
JA
2459 .category = FIO_OPT_C_IO,
2460 .group = FIO_OPT_G_RATE,
4e991c23
JA
2461 },
2462 {
2463 .name = "rate_iops",
e8b0e958 2464 .lname = "I/O rate IOPS",
e01b22b8 2465 .type = FIO_OPT_INT,
6eaf09d6
SL
2466 .off1 = td_var_offset(rate_iops[DDIR_READ]),
2467 .off2 = td_var_offset(rate_iops[DDIR_WRITE]),
2468 .off3 = td_var_offset(rate_iops[DDIR_TRIM]),
4e991c23 2469 .help = "Limit IO used to this number of IO operations/sec",
d71c154c 2470 .hide = 1,
e8b0e958
JA
2471 .category = FIO_OPT_C_IO,
2472 .group = FIO_OPT_G_RATE,
4e991c23
JA
2473 },
2474 {
2475 .name = "rate_iops_min",
e8b0e958 2476 .lname = "I/O min rate IOPS",
e01b22b8 2477 .type = FIO_OPT_INT,
6eaf09d6
SL
2478 .off1 = td_var_offset(rate_iops_min[DDIR_READ]),
2479 .off2 = td_var_offset(rate_iops_min[DDIR_WRITE]),
2480 .off3 = td_var_offset(rate_iops_min[DDIR_TRIM]),
03e20d68 2481 .help = "Job must meet this rate or it will be shut down",
afdf9352 2482 .parent = "rate_iops",
d71c154c 2483 .hide = 1,
e8b0e958
JA
2484 .category = FIO_OPT_C_IO,
2485 .group = FIO_OPT_G_RATE,
214e1eca
JA
2486 },
2487 {
2488 .name = "ratecycle",
e8b0e958 2489 .lname = "I/O rate cycle",
214e1eca
JA
2490 .type = FIO_OPT_INT,
2491 .off1 = td_var_offset(ratecycle),
2492 .help = "Window average for rate limits (msec)",
2493 .def = "1000",
afdf9352 2494 .parent = "rate",
d71c154c 2495 .hide = 1,
e8b0e958
JA
2496 .category = FIO_OPT_C_IO,
2497 .group = FIO_OPT_G_RATE,
214e1eca 2498 },
15501535
JA
2499 {
2500 .name = "max_latency",
2501 .type = FIO_OPT_INT,
2502 .off1 = td_var_offset(max_latency),
2503 .help = "Maximum tolerated IO latency (usec)",
1e5324e7
JA
2504 .category = FIO_OPT_C_IO,
2505 .group = FIO_OPT_G_RATE,
15501535 2506 },
214e1eca
JA
2507 {
2508 .name = "invalidate",
e8b0e958 2509 .lname = "Cache invalidate",
214e1eca
JA
2510 .type = FIO_OPT_BOOL,
2511 .off1 = td_var_offset(invalidate_cache),
2512 .help = "Invalidate buffer/page cache prior to running job",
2513 .def = "1",
e8b0e958 2514 .category = FIO_OPT_C_IO,
3ceb458f 2515 .group = FIO_OPT_G_IO_TYPE,
214e1eca
JA
2516 },
2517 {
2518 .name = "sync",
e8b0e958 2519 .lname = "Synchronous I/O",
214e1eca
JA
2520 .type = FIO_OPT_BOOL,
2521 .off1 = td_var_offset(sync_io),
2522 .help = "Use O_SYNC for buffered writes",
2523 .def = "0",
67a1000f 2524 .parent = "buffered",
d71c154c 2525 .hide = 1,
e8b0e958 2526 .category = FIO_OPT_C_IO,
3ceb458f 2527 .group = FIO_OPT_G_IO_TYPE,
214e1eca 2528 },
214e1eca
JA
2529 {
2530 .name = "create_serialize",
e8b0e958 2531 .lname = "Create serialize",
214e1eca
JA
2532 .type = FIO_OPT_BOOL,
2533 .off1 = td_var_offset(create_serialize),
2534 .help = "Serialize creating of job files",
2535 .def = "1",
e8b0e958
JA
2536 .category = FIO_OPT_C_FILE,
2537 .group = FIO_OPT_G_INVALID,
214e1eca
JA
2538 },
2539 {
2540 .name = "create_fsync",
e8b0e958 2541 .lname = "Create fsync",
214e1eca
JA
2542 .type = FIO_OPT_BOOL,
2543 .off1 = td_var_offset(create_fsync),
03e20d68 2544 .help = "fsync file after creation",
214e1eca 2545 .def = "1",
e8b0e958
JA
2546 .category = FIO_OPT_C_FILE,
2547 .group = FIO_OPT_G_INVALID,
214e1eca 2548 },
814452bd
JA
2549 {
2550 .name = "create_on_open",
e8b0e958 2551 .lname = "Create on open",
814452bd
JA
2552 .type = FIO_OPT_BOOL,
2553 .off1 = td_var_offset(create_on_open),
2554 .help = "Create files when they are opened for IO",
2555 .def = "0",
e8b0e958
JA
2556 .category = FIO_OPT_C_FILE,
2557 .group = FIO_OPT_G_INVALID,
814452bd 2558 },
25460cf6
JA
2559 {
2560 .name = "create_only",
2561 .type = FIO_OPT_BOOL,
2562 .off1 = td_var_offset(create_only),
2563 .help = "Only perform file creation phase",
d17fda71 2564 .category = FIO_OPT_C_FILE,
25460cf6
JA
2565 .def = "0",
2566 },
0b9d69ec 2567 {
afad68f7 2568 .name = "pre_read",
e8b0e958 2569 .lname = "Pre-read files",
afad68f7
ZY
2570 .type = FIO_OPT_BOOL,
2571 .off1 = td_var_offset(pre_read),
03e20d68 2572 .help = "Pre-read files before starting official testing",
afad68f7 2573 .def = "0",
e8b0e958
JA
2574 .category = FIO_OPT_C_FILE,
2575 .group = FIO_OPT_G_INVALID,
afad68f7 2576 },
214e1eca
JA
2577#ifdef FIO_HAVE_CPU_AFFINITY
2578 {
2579 .name = "cpumask",
e8b0e958 2580 .lname = "CPU mask",
214e1eca
JA
2581 .type = FIO_OPT_INT,
2582 .cb = str_cpumask_cb,
2583 .help = "CPU affinity mask",
e8b0e958 2584 .category = FIO_OPT_C_GENERAL,
10860056 2585 .group = FIO_OPT_G_CRED,
214e1eca 2586 },
d2e268b0
JA
2587 {
2588 .name = "cpus_allowed",
e8b0e958 2589 .lname = "CPUs allowed",
d2e268b0
JA
2590 .type = FIO_OPT_STR,
2591 .cb = str_cpus_allowed_cb,
2592 .help = "Set CPUs allowed",
e8b0e958 2593 .category = FIO_OPT_C_GENERAL,
10860056 2594 .group = FIO_OPT_G_CRED,
d2e268b0 2595 },
d0b937ed
YR
2596#endif
2597#ifdef FIO_HAVE_LIBNUMA
2598 {
2599 .name = "numa_cpu_nodes",
2600 .type = FIO_OPT_STR,
2601 .cb = str_numa_cpunodes_cb,
2602 .help = "NUMA CPU nodes bind",
2603 },
2604 {
2605 .name = "numa_mem_policy",
2606 .type = FIO_OPT_STR,
2607 .cb = str_numa_mpol_cb,
2608 .help = "NUMA memory policy setup",
2609 },
214e1eca
JA
2610#endif
2611 {
2612 .name = "end_fsync",
e8b0e958 2613 .lname = "End fsync",
214e1eca
JA
2614 .type = FIO_OPT_BOOL,
2615 .off1 = td_var_offset(end_fsync),
2616 .help = "Include fsync at the end of job",
2617 .def = "0",
e8b0e958
JA
2618 .category = FIO_OPT_C_FILE,
2619 .group = FIO_OPT_G_INVALID,
214e1eca
JA
2620 },
2621 {
2622 .name = "fsync_on_close",
e8b0e958 2623 .lname = "Fsync on close",
214e1eca
JA
2624 .type = FIO_OPT_BOOL,
2625 .off1 = td_var_offset(fsync_on_close),
2626 .help = "fsync files on close",
2627 .def = "0",
e8b0e958
JA
2628 .category = FIO_OPT_C_FILE,
2629 .group = FIO_OPT_G_INVALID,
214e1eca
JA
2630 },
2631 {
2632 .name = "unlink",
e8b0e958 2633 .lname = "Unlink file",
214e1eca
JA
2634 .type = FIO_OPT_BOOL,
2635 .off1 = td_var_offset(unlink),
2636 .help = "Unlink created files after job has completed",
2637 .def = "0",
e8b0e958
JA
2638 .category = FIO_OPT_C_FILE,
2639 .group = FIO_OPT_G_INVALID,
214e1eca
JA
2640 },
2641 {
2642 .name = "exitall",
e8b0e958 2643 .lname = "Exit-all on terminate",
214e1eca
JA
2644 .type = FIO_OPT_STR_SET,
2645 .cb = str_exitall_cb,
2646 .help = "Terminate all jobs when one exits",
e8b0e958 2647 .category = FIO_OPT_C_GENERAL,
a1f6afec 2648 .group = FIO_OPT_G_PROCESS,
214e1eca
JA
2649 },
2650 {
2651 .name = "stonewall",
e8b0e958 2652 .lname = "Wait for previous",
d392365e 2653 .alias = "wait_for_previous",
214e1eca
JA
2654 .type = FIO_OPT_STR_SET,
2655 .off1 = td_var_offset(stonewall),
2656 .help = "Insert a hard barrier between this job and previous",
e8b0e958 2657 .category = FIO_OPT_C_GENERAL,
a1f6afec 2658 .group = FIO_OPT_G_PROCESS,
214e1eca 2659 },
b3d62a75
JA
2660 {
2661 .name = "new_group",
e8b0e958 2662 .lname = "New group",
b3d62a75
JA
2663 .type = FIO_OPT_STR_SET,
2664 .off1 = td_var_offset(new_group),
2665 .help = "Mark the start of a new group (for reporting)",
e8b0e958 2666 .category = FIO_OPT_C_GENERAL,
a1f6afec 2667 .group = FIO_OPT_G_PROCESS,
b3d62a75 2668 },
214e1eca
JA
2669 {
2670 .name = "thread",
e8b0e958 2671 .lname = "Thread",
214e1eca
JA
2672 .type = FIO_OPT_STR_SET,
2673 .off1 = td_var_offset(use_thread),
20eb06bd 2674 .help = "Use threads instead of processes",
e8b0e958 2675 .category = FIO_OPT_C_GENERAL,
a1f6afec 2676 .group = FIO_OPT_G_PROCESS,
214e1eca
JA
2677 },
2678 {
2679 .name = "write_bw_log",
e8b0e958 2680 .lname = "Write bandwidth log",
203160d5
JA
2681 .type = FIO_OPT_STR_STORE,
2682 .off1 = td_var_offset(bw_log_file),
214e1eca 2683 .help = "Write log of bandwidth during run",
e8b0e958
JA
2684 .category = FIO_OPT_C_LOG,
2685 .group = FIO_OPT_G_INVALID,
214e1eca
JA
2686 },
2687 {
2688 .name = "write_lat_log",
e8b0e958 2689 .lname = "Write latency log",
203160d5
JA
2690 .type = FIO_OPT_STR_STORE,
2691 .off1 = td_var_offset(lat_log_file),
214e1eca 2692 .help = "Write log of latency during run",
e8b0e958
JA
2693 .category = FIO_OPT_C_LOG,
2694 .group = FIO_OPT_G_INVALID,
214e1eca 2695 },
c8eeb9df
JA
2696 {
2697 .name = "write_iops_log",
e8b0e958 2698 .lname = "Write IOPS log",
c8eeb9df 2699 .type = FIO_OPT_STR,
203160d5 2700 .off1 = td_var_offset(iops_log_file),
c8eeb9df 2701 .help = "Write log of IOPS during run",
e8b0e958
JA
2702 .category = FIO_OPT_C_LOG,
2703 .group = FIO_OPT_G_INVALID,
c8eeb9df 2704 },
b8bc8cba
JA
2705 {
2706 .name = "log_avg_msec",
e8b0e958 2707 .lname = "Log averaging (msec)",
b8bc8cba
JA
2708 .type = FIO_OPT_INT,
2709 .off1 = td_var_offset(log_avg_msec),
2710 .help = "Average bw/iops/lat logs over this period of time",
2711 .def = "0",
e8b0e958
JA
2712 .category = FIO_OPT_C_LOG,
2713 .group = FIO_OPT_G_INVALID,
b8bc8cba 2714 },
c504ee55
JA
2715 {
2716 .name = "bwavgtime",
2717 .lname = "Bandwidth average time",
2718 .type = FIO_OPT_INT,
2719 .off1 = td_var_offset(bw_avg_time),
2720 .help = "Time window over which to calculate bandwidth"
2721 " (msec)",
2722 .def = "500",
2723 .parent = "write_bw_log",
2724 .hide = 1,
2725 .interval = 100,
2726 .category = FIO_OPT_C_LOG,
2727 .group = FIO_OPT_G_INVALID,
2728 },
2729 {
2730 .name = "iopsavgtime",
2731 .lname = "IOPS average time",
2732 .type = FIO_OPT_INT,
2733 .off1 = td_var_offset(iops_avg_time),
2734 .help = "Time window over which to calculate IOPS (msec)",
2735 .def = "500",
2736 .parent = "write_iops_log",
2737 .hide = 1,
2738 .interval = 100,
2739 .category = FIO_OPT_C_LOG,
2740 .group = FIO_OPT_G_INVALID,
2741 },
214e1eca
JA
2742 {
2743 .name = "group_reporting",
e8b0e958
JA
2744 .lname = "Group reporting",
2745 .type = FIO_OPT_BOOL,
214e1eca
JA
2746 .off1 = td_var_offset(group_reporting),
2747 .help = "Do reporting on a per-group basis",
e8b0e958 2748 .def = "1",
10860056 2749 .category = FIO_OPT_C_STAT,
e8b0e958 2750 .group = FIO_OPT_G_INVALID,
214e1eca 2751 },
e9459e5a
JA
2752 {
2753 .name = "zero_buffers",
e8b0e958 2754 .lname = "Zero I/O buffers",
e9459e5a
JA
2755 .type = FIO_OPT_STR_SET,
2756 .off1 = td_var_offset(zero_buffers),
2757 .help = "Init IO buffers to all zeroes",
e8b0e958 2758 .category = FIO_OPT_C_IO,
3ceb458f 2759 .group = FIO_OPT_G_IO_BUF,
e9459e5a 2760 },
5973cafb
JA
2761 {
2762 .name = "refill_buffers",
e8b0e958 2763 .lname = "Refill I/O buffers",
5973cafb
JA
2764 .type = FIO_OPT_STR_SET,
2765 .off1 = td_var_offset(refill_buffers),
2766 .help = "Refill IO buffers on every IO submit",
e8b0e958 2767 .category = FIO_OPT_C_IO,
3ceb458f 2768 .group = FIO_OPT_G_IO_BUF,
5973cafb 2769 },
fd68418e
JA
2770 {
2771 .name = "scramble_buffers",
e8b0e958 2772 .lname = "Scramble I/O buffers",
fd68418e
JA
2773 .type = FIO_OPT_BOOL,
2774 .off1 = td_var_offset(scramble_buffers),
2775 .help = "Slightly scramble buffers on every IO submit",
2776 .def = "1",
e8b0e958 2777 .category = FIO_OPT_C_IO,
3ceb458f 2778 .group = FIO_OPT_G_IO_BUF,
fd68418e 2779 },
9c42684e
JA
2780 {
2781 .name = "buffer_compress_percentage",
e8b0e958 2782 .lname = "Buffer compression percentage",
9c42684e
JA
2783 .type = FIO_OPT_INT,
2784 .off1 = td_var_offset(compress_percentage),
2785 .maxval = 100,
2786 .minval = 1,
2787 .help = "How compressible the buffer is (approximately)",
20eb06bd 2788 .interval = 5,
e8b0e958 2789 .category = FIO_OPT_C_IO,
3ceb458f 2790 .group = FIO_OPT_G_IO_BUF,
9c42684e 2791 },
f97a43a1
JA
2792 {
2793 .name = "buffer_compress_chunk",
e8b0e958 2794 .lname = "Buffer compression chunk size",
f97a43a1
JA
2795 .type = FIO_OPT_INT,
2796 .off1 = td_var_offset(compress_chunk),
207b18e4 2797 .parent = "buffer_compress_percentage",
d71c154c 2798 .hide = 1,
f97a43a1 2799 .help = "Size of compressible region in buffer",
20eb06bd 2800 .interval = 256,
e8b0e958 2801 .category = FIO_OPT_C_IO,
3ceb458f 2802 .group = FIO_OPT_G_IO_BUF,
f97a43a1 2803 },
83349190
YH
2804 {
2805 .name = "clat_percentiles",
e8b0e958 2806 .lname = "Completion latency percentiles",
83349190
YH
2807 .type = FIO_OPT_BOOL,
2808 .off1 = td_var_offset(clat_percentiles),
2809 .help = "Enable the reporting of completion latency percentiles",
467b35ed 2810 .def = "1",
e8b0e958
JA
2811 .category = FIO_OPT_C_STAT,
2812 .group = FIO_OPT_G_INVALID,
83349190
YH
2813 },
2814 {
2815 .name = "percentile_list",
e8b0e958 2816 .lname = "Completion latency percentile list",
83349190
YH
2817 .type = FIO_OPT_FLOAT_LIST,
2818 .off1 = td_var_offset(percentile_list),
2819 .off2 = td_var_offset(overwrite_plist),
2820 .help = "Specify a custom list of percentiles to report",
2821 .maxlen = FIO_IO_U_LIST_MAX_LEN,
2822 .minfp = 0.0,
2823 .maxfp = 100.0,
e8b0e958
JA
2824 .category = FIO_OPT_C_STAT,
2825 .group = FIO_OPT_G_INVALID,
83349190
YH
2826 },
2827
0a839f30
JA
2828#ifdef FIO_HAVE_DISK_UTIL
2829 {
2830 .name = "disk_util",
e8b0e958 2831 .lname = "Disk utilization",
0a839f30
JA
2832 .type = FIO_OPT_BOOL,
2833 .off1 = td_var_offset(do_disk_util),
f66ab3c8 2834 .help = "Log disk utilization statistics",
0a839f30 2835 .def = "1",
e8b0e958
JA
2836 .category = FIO_OPT_C_STAT,
2837 .group = FIO_OPT_G_INVALID,
0a839f30
JA
2838 },
2839#endif
993bf48b
JA
2840 {
2841 .name = "gtod_reduce",
e8b0e958 2842 .lname = "Reduce gettimeofday() calls",
993bf48b
JA
2843 .type = FIO_OPT_BOOL,
2844 .help = "Greatly reduce number of gettimeofday() calls",
2845 .cb = str_gtod_reduce_cb,
2846 .def = "0",
a4ed77fe 2847 .hide_on_set = 1,
e8b0e958
JA
2848 .category = FIO_OPT_C_STAT,
2849 .group = FIO_OPT_G_INVALID,
993bf48b 2850 },
02af0988
JA
2851 {
2852 .name = "disable_lat",
e8b0e958 2853 .lname = "Disable all latency stats",
02af0988
JA
2854 .type = FIO_OPT_BOOL,
2855 .off1 = td_var_offset(disable_lat),
2856 .help = "Disable latency numbers",
2857 .parent = "gtod_reduce",
d71c154c 2858 .hide = 1,
02af0988 2859 .def = "0",
e8b0e958
JA
2860 .category = FIO_OPT_C_STAT,
2861 .group = FIO_OPT_G_INVALID,
02af0988 2862 },
9520ebb9
JA
2863 {
2864 .name = "disable_clat",
e8b0e958 2865 .lname = "Disable completion latency stats",
9520ebb9
JA
2866 .type = FIO_OPT_BOOL,
2867 .off1 = td_var_offset(disable_clat),
2868 .help = "Disable completion latency numbers",
993bf48b 2869 .parent = "gtod_reduce",
d71c154c 2870 .hide = 1,
9520ebb9 2871 .def = "0",
e8b0e958
JA
2872 .category = FIO_OPT_C_STAT,
2873 .group = FIO_OPT_G_INVALID,
9520ebb9
JA
2874 },
2875 {
2876 .name = "disable_slat",
e8b0e958 2877 .lname = "Disable submission latency stats",
9520ebb9
JA
2878 .type = FIO_OPT_BOOL,
2879 .off1 = td_var_offset(disable_slat),
03e20d68 2880 .help = "Disable submission latency numbers",
993bf48b 2881 .parent = "gtod_reduce",
d71c154c 2882 .hide = 1,
9520ebb9 2883 .def = "0",
e8b0e958
JA
2884 .category = FIO_OPT_C_STAT,
2885 .group = FIO_OPT_G_INVALID,
9520ebb9
JA
2886 },
2887 {
2888 .name = "disable_bw_measurement",
e8b0e958 2889 .lname = "Disable bandwidth stats",
9520ebb9
JA
2890 .type = FIO_OPT_BOOL,
2891 .off1 = td_var_offset(disable_bw),
2892 .help = "Disable bandwidth logging",
993bf48b 2893 .parent = "gtod_reduce",
d71c154c 2894 .hide = 1,
9520ebb9 2895 .def = "0",
e8b0e958
JA
2896 .category = FIO_OPT_C_STAT,
2897 .group = FIO_OPT_G_INVALID,
9520ebb9 2898 },
be4ecfdf
JA
2899 {
2900 .name = "gtod_cpu",
e8b0e958 2901 .lname = "Dedicated gettimeofday() CPU",
be4ecfdf
JA
2902 .type = FIO_OPT_INT,
2903 .cb = str_gtod_cpu_cb,
03e20d68 2904 .help = "Set up dedicated gettimeofday() thread on this CPU",
29d43ff9 2905 .verify = gtod_cpu_verify,
e8b0e958 2906 .category = FIO_OPT_C_GENERAL,
10860056 2907 .group = FIO_OPT_G_CLOCK,
be4ecfdf 2908 },
f2bba182
RR
2909 {
2910 .name = "continue_on_error",
e8b0e958 2911 .lname = "Continue on error",
06842027 2912 .type = FIO_OPT_STR,
f2bba182 2913 .off1 = td_var_offset(continue_on_error),
03e20d68 2914 .help = "Continue on non-fatal errors during IO",
06842027 2915 .def = "none",
e8b0e958 2916 .category = FIO_OPT_C_GENERAL,
bc3f552f 2917 .group = FIO_OPT_G_ERR,
06842027
SL
2918 .posval = {
2919 { .ival = "none",
2920 .oval = ERROR_TYPE_NONE,
2921 .help = "Exit when an error is encountered",
2922 },
2923 { .ival = "read",
2924 .oval = ERROR_TYPE_READ,
2925 .help = "Continue on read errors only",
2926 },
2927 { .ival = "write",
2928 .oval = ERROR_TYPE_WRITE,
2929 .help = "Continue on write errors only",
2930 },
2931 { .ival = "io",
2932 .oval = ERROR_TYPE_READ | ERROR_TYPE_WRITE,
2933 .help = "Continue on any IO errors",
2934 },
2935 { .ival = "verify",
2936 .oval = ERROR_TYPE_VERIFY,
2937 .help = "Continue on verify errors only",
2938 },
2939 { .ival = "all",
2940 .oval = ERROR_TYPE_ANY,
2941 .help = "Continue on all io and verify errors",
2942 },
2943 { .ival = "0",
2944 .oval = ERROR_TYPE_NONE,
2945 .help = "Alias for 'none'",
2946 },
2947 { .ival = "1",
2948 .oval = ERROR_TYPE_ANY,
2949 .help = "Alias for 'all'",
2950 },
2951 },
f2bba182 2952 },
8b28bd41
DM
2953 {
2954 .name = "ignore_error",
2955 .type = FIO_OPT_STR,
2956 .cb = str_ignore_error_cb,
2957 .help = "Set a specific list of errors to ignore",
2958 .parent = "rw",
a94eb99a 2959 .category = FIO_OPT_C_GENERAL,
bc3f552f 2960 .group = FIO_OPT_G_ERR,
8b28bd41
DM
2961 },
2962 {
2963 .name = "error_dump",
2964 .type = FIO_OPT_BOOL,
2965 .off1 = td_var_offset(error_dump),
2966 .def = "0",
2967 .help = "Dump info on each error",
a94eb99a 2968 .category = FIO_OPT_C_GENERAL,
bc3f552f 2969 .group = FIO_OPT_G_ERR,
8b28bd41 2970 },
9ac8a797
JA
2971 {
2972 .name = "profile",
e8b0e958 2973 .lname = "Profile",
79d16311 2974 .type = FIO_OPT_STR_STORE,
9ac8a797 2975 .off1 = td_var_offset(profile),
9ac8a797 2976 .help = "Select a specific builtin performance test",
13fca827 2977 .category = FIO_OPT_C_PROFILE,
e8b0e958 2978 .group = FIO_OPT_G_INVALID,
9ac8a797 2979 },
a696fa2a
JA
2980 {
2981 .name = "cgroup",
e8b0e958 2982 .lname = "Cgroup",
a696fa2a
JA
2983 .type = FIO_OPT_STR_STORE,
2984 .off1 = td_var_offset(cgroup),
2985 .help = "Add job to cgroup of this name",
e8b0e958 2986 .category = FIO_OPT_C_GENERAL,
a1f6afec
JA
2987 .group = FIO_OPT_G_CGROUP,
2988 },
2989 {
2990 .name = "cgroup_nodelete",
2991 .lname = "Cgroup no-delete",
2992 .type = FIO_OPT_BOOL,
2993 .off1 = td_var_offset(cgroup_nodelete),
2994 .help = "Do not delete cgroups after job completion",
2995 .def = "0",
2996 .parent = "cgroup",
2997 .category = FIO_OPT_C_GENERAL,
2998 .group = FIO_OPT_G_CGROUP,
a696fa2a
JA
2999 },
3000 {
3001 .name = "cgroup_weight",
e8b0e958 3002 .lname = "Cgroup weight",
a696fa2a
JA
3003 .type = FIO_OPT_INT,
3004 .off1 = td_var_offset(cgroup_weight),
3005 .help = "Use given weight for cgroup",
3006 .minval = 100,
3007 .maxval = 1000,
a1f6afec 3008 .parent = "cgroup",
e8b0e958 3009 .category = FIO_OPT_C_GENERAL,
a1f6afec 3010 .group = FIO_OPT_G_CGROUP,
7de87099 3011 },
e0b0d892
JA
3012 {
3013 .name = "uid",
e8b0e958 3014 .lname = "User ID",
e0b0d892
JA
3015 .type = FIO_OPT_INT,
3016 .off1 = td_var_offset(uid),
3017 .help = "Run job with this user ID",
e8b0e958 3018 .category = FIO_OPT_C_GENERAL,
10860056 3019 .group = FIO_OPT_G_CRED,
e0b0d892
JA
3020 },
3021 {
3022 .name = "gid",
e8b0e958 3023 .lname = "Group ID",
e0b0d892
JA
3024 .type = FIO_OPT_INT,
3025 .off1 = td_var_offset(gid),
3026 .help = "Run job with this group ID",
e8b0e958 3027 .category = FIO_OPT_C_GENERAL,
10860056 3028 .group = FIO_OPT_G_CRED,
e0b0d892 3029 },
a1f6afec
JA
3030 {
3031 .name = "kb_base",
3032 .lname = "KB Base",
3033 .type = FIO_OPT_INT,
3034 .off1 = td_var_offset(kb_base),
3035 .verify = kb_base_verify,
3036 .prio = 1,
3037 .def = "1024",
3038 .help = "How many bytes per KB for reporting (1000 or 1024)",
3039 .category = FIO_OPT_C_GENERAL,
3040 .group = FIO_OPT_G_INVALID,
3041 },
3ceb458f
JA
3042 {
3043 .name = "hugepage-size",
3044 .lname = "Hugepage size",
3045 .type = FIO_OPT_INT,
3046 .off1 = td_var_offset(hugepage_size),
3047 .help = "When using hugepages, specify size of each page",
3048 .def = __fio_stringify(FIO_HUGE_PAGE),
3049 .interval = 1024 * 1024,
3050 .category = FIO_OPT_C_GENERAL,
3051 .group = FIO_OPT_G_INVALID,
3052 },
9e684a49
DE
3053 {
3054 .name = "flow_id",
e8b0e958 3055 .lname = "I/O flow ID",
9e684a49
DE
3056 .type = FIO_OPT_INT,
3057 .off1 = td_var_offset(flow_id),
3058 .help = "The flow index ID to use",
3059 .def = "0",
e8b0e958
JA
3060 .category = FIO_OPT_C_IO,
3061 .group = FIO_OPT_G_IO_FLOW,
9e684a49
DE
3062 },
3063 {
3064 .name = "flow",
e8b0e958 3065 .lname = "I/O flow weight",
9e684a49
DE
3066 .type = FIO_OPT_INT,
3067 .off1 = td_var_offset(flow),
3068 .help = "Weight for flow control of this job",
3069 .parent = "flow_id",
d71c154c 3070 .hide = 1,
9e684a49 3071 .def = "0",
e8b0e958
JA
3072 .category = FIO_OPT_C_IO,
3073 .group = FIO_OPT_G_IO_FLOW,
9e684a49
DE
3074 },
3075 {
3076 .name = "flow_watermark",
e8b0e958 3077 .lname = "I/O flow watermark",
9e684a49
DE
3078 .type = FIO_OPT_INT,
3079 .off1 = td_var_offset(flow_watermark),
3080 .help = "High watermark for flow control. This option"
3081 " should be set to the same value for all threads"
3082 " with non-zero flow.",
3083 .parent = "flow_id",
d71c154c 3084 .hide = 1,
9e684a49 3085 .def = "1024",
e8b0e958
JA
3086 .category = FIO_OPT_C_IO,
3087 .group = FIO_OPT_G_IO_FLOW,
9e684a49
DE
3088 },
3089 {
3090 .name = "flow_sleep",
e8b0e958 3091 .lname = "I/O flow sleep",
9e684a49
DE
3092 .type = FIO_OPT_INT,
3093 .off1 = td_var_offset(flow_sleep),
3094 .help = "How many microseconds to sleep after being held"
3095 " back by the flow control mechanism",
3096 .parent = "flow_id",
d71c154c 3097 .hide = 1,
9e684a49 3098 .def = "0",
e8b0e958
JA
3099 .category = FIO_OPT_C_IO,
3100 .group = FIO_OPT_G_IO_FLOW,
9e684a49 3101 },
214e1eca
JA
3102 {
3103 .name = NULL,
3104 },
3105};
3106
17af15d4 3107static void add_to_lopt(struct option *lopt, struct fio_option *o,
de890a1e 3108 const char *name, int val)
9f81736c 3109{
17af15d4 3110 lopt->name = (char *) name;
de890a1e 3111 lopt->val = val;
9f81736c
JA
3112 if (o->type == FIO_OPT_STR_SET)
3113 lopt->has_arg = no_argument;
3114 else
3115 lopt->has_arg = required_argument;
3116}
3117
de890a1e
SL
3118static void options_to_lopts(struct fio_option *opts,
3119 struct option *long_options,
3120 int i, int option_type)
214e1eca 3121{
de890a1e 3122 struct fio_option *o = &opts[0];
214e1eca 3123 while (o->name) {
de890a1e 3124 add_to_lopt(&long_options[i], o, o->name, option_type);
17af15d4
JA
3125 if (o->alias) {
3126 i++;
de890a1e 3127 add_to_lopt(&long_options[i], o, o->alias, option_type);
17af15d4 3128 }
214e1eca
JA
3129
3130 i++;
3131 o++;
3132 assert(i < FIO_NR_OPTIONS);
3133 }
3134}
3135
de890a1e
SL
3136void fio_options_set_ioengine_opts(struct option *long_options,
3137 struct thread_data *td)
3138{
3139 unsigned int i;
3140
3141 i = 0;
3142 while (long_options[i].name) {
3143 if (long_options[i].val == FIO_GETOPT_IOENGINE) {
3144 memset(&long_options[i], 0, sizeof(*long_options));
3145 break;
3146 }
3147 i++;
3148 }
3149
3150 /*
3151 * Just clear out the prior ioengine options.
3152 */
3153 if (!td || !td->eo)
3154 return;
3155
3156 options_to_lopts(td->io_ops->options, long_options, i,
3157 FIO_GETOPT_IOENGINE);
3158}
3159
3160void fio_options_dup_and_init(struct option *long_options)
3161{
3162 unsigned int i;
3163
9af4a244 3164 options_init(fio_options);
de890a1e
SL
3165
3166 i = 0;
3167 while (long_options[i].name)
3168 i++;
3169
9af4a244 3170 options_to_lopts(fio_options, long_options, i, FIO_GETOPT_JOB);
de890a1e
SL
3171}
3172
74929ac2
JA
3173struct fio_keyword {
3174 const char *word;
3175 const char *desc;
3176 char *replace;
3177};
3178
3179static struct fio_keyword fio_keywords[] = {
3180 {
3181 .word = "$pagesize",
3182 .desc = "Page size in the system",
3183 },
3184 {
3185 .word = "$mb_memory",
3186 .desc = "Megabytes of memory online",
3187 },
3188 {
3189 .word = "$ncpus",
3190 .desc = "Number of CPUs online in the system",
3191 },
3192 {
3193 .word = NULL,
3194 },
3195};
3196
3197void fio_keywords_init(void)
3198{
3b2e1464 3199 unsigned long long mb_memory;
74929ac2
JA
3200 char buf[128];
3201 long l;
3202
a4cfc477 3203 sprintf(buf, "%lu", (unsigned long) page_size);
74929ac2
JA
3204 fio_keywords[0].replace = strdup(buf);
3205
8eb016d3 3206 mb_memory = os_phys_mem() / (1024 * 1024);
3b2e1464 3207 sprintf(buf, "%llu", mb_memory);
74929ac2
JA
3208 fio_keywords[1].replace = strdup(buf);
3209
c00a2289 3210 l = cpus_online();
74929ac2
JA
3211 sprintf(buf, "%lu", l);
3212 fio_keywords[2].replace = strdup(buf);
3213}
3214
892a6ffc
JA
3215#define BC_APP "bc"
3216
3217static char *bc_calc(char *str)
3218{
d0c814ec 3219 char buf[128], *tmp;
892a6ffc
JA
3220 FILE *f;
3221 int ret;
3222
3223 /*
3224 * No math, just return string
3225 */
d0c814ec
SL
3226 if ((!strchr(str, '+') && !strchr(str, '-') && !strchr(str, '*') &&
3227 !strchr(str, '/')) || strchr(str, '\''))
892a6ffc
JA
3228 return str;
3229
3230 /*
3231 * Split option from value, we only need to calculate the value
3232 */
3233 tmp = strchr(str, '=');
3234 if (!tmp)
3235 return str;
3236
3237 tmp++;
892a6ffc 3238
d0c814ec
SL
3239 /*
3240 * Prevent buffer overflows; such a case isn't reasonable anyway
3241 */
3242 if (strlen(str) >= 128 || strlen(tmp) > 100)
3243 return str;
892a6ffc
JA
3244
3245 sprintf(buf, "which %s > /dev/null", BC_APP);
3246 if (system(buf)) {
3247 log_err("fio: bc is needed for performing math\n");
892a6ffc
JA
3248 return NULL;
3249 }
3250
d0c814ec 3251 sprintf(buf, "echo '%s' | %s", tmp, BC_APP);
892a6ffc 3252 f = popen(buf, "r");
3c3ed070 3253 if (!f)
892a6ffc 3254 return NULL;
892a6ffc 3255
d0c814ec 3256 ret = fread(&buf[tmp - str], 1, 128 - (tmp - str), f);
3c3ed070 3257 if (ret <= 0)
892a6ffc 3258 return NULL;
892a6ffc 3259
892a6ffc 3260 pclose(f);
d0c814ec
SL
3261 buf[(tmp - str) + ret - 1] = '\0';
3262 memcpy(buf, str, tmp - str);
892a6ffc 3263 free(str);
d0c814ec
SL
3264 return strdup(buf);
3265}
3266
3267/*
3268 * Return a copy of the input string with substrings of the form ${VARNAME}
3269 * substituted with the value of the environment variable VARNAME. The
3270 * substitution always occurs, even if VARNAME is empty or the corresponding
3271 * environment variable undefined.
3272 */
3273static char *option_dup_subs(const char *opt)
3274{
3275 char out[OPT_LEN_MAX+1];
3276 char in[OPT_LEN_MAX+1];
3277 char *outptr = out;
3278 char *inptr = in;
3279 char *ch1, *ch2, *env;
3280 ssize_t nchr = OPT_LEN_MAX;
3281 size_t envlen;
3282
3283 if (strlen(opt) + 1 > OPT_LEN_MAX) {
3284 log_err("OPT_LEN_MAX (%d) is too small\n", OPT_LEN_MAX);
3285 return NULL;
3286 }
3287
3288 in[OPT_LEN_MAX] = '\0';
3289 strncpy(in, opt, OPT_LEN_MAX);
3290
3291 while (*inptr && nchr > 0) {
3292 if (inptr[0] == '$' && inptr[1] == '{') {
3293 ch2 = strchr(inptr, '}');
3294 if (ch2 && inptr+1 < ch2) {
3295 ch1 = inptr+2;
3296 inptr = ch2+1;
3297 *ch2 = '\0';
3298
3299 env = getenv(ch1);
3300 if (env) {
3301 envlen = strlen(env);
3302 if (envlen <= nchr) {
3303 memcpy(outptr, env, envlen);
3304 outptr += envlen;
3305 nchr -= envlen;
3306 }
3307 }
3308
3309 continue;
3310 }
3311 }
3312
3313 *outptr++ = *inptr++;
3314 --nchr;
3315 }
3316
3317 *outptr = '\0';
3318 return strdup(out);
892a6ffc
JA
3319}
3320
74929ac2
JA
3321/*
3322 * Look for reserved variable names and replace them with real values
3323 */
3324static char *fio_keyword_replace(char *opt)
3325{
3326 char *s;
3327 int i;
d0c814ec 3328 int docalc = 0;
74929ac2
JA
3329
3330 for (i = 0; fio_keywords[i].word != NULL; i++) {
3331 struct fio_keyword *kw = &fio_keywords[i];
3332
3333 while ((s = strstr(opt, kw->word)) != NULL) {
3334 char *new = malloc(strlen(opt) + 1);
3335 char *o_org = opt;
3336 int olen = s - opt;
3337 int len;
3338
3339 /*
3340 * Copy part of the string before the keyword and
3341 * sprintf() the replacement after it.
3342 */
3343 memcpy(new, opt, olen);
3344 len = sprintf(new + olen, "%s", kw->replace);
3345
3346 /*
3347 * If there's more in the original string, copy that
3348 * in too
3349 */
3350 opt += strlen(kw->word) + olen;
3351 if (strlen(opt))
3352 memcpy(new + olen + len, opt, opt - o_org - 1);
3353
3354 /*
3355 * replace opt and free the old opt
3356 */
3357 opt = new;
d0c814ec 3358 free(o_org);
7a958bd5 3359
d0c814ec 3360 docalc = 1;
74929ac2
JA
3361 }
3362 }
3363
d0c814ec
SL
3364 /*
3365 * Check for potential math and invoke bc, if possible
3366 */
3367 if (docalc)
3368 opt = bc_calc(opt);
3369
7a958bd5 3370 return opt;
74929ac2
JA
3371}
3372
d0c814ec
SL
3373static char **dup_and_sub_options(char **opts, int num_opts)
3374{
3375 int i;
3376 char **opts_copy = malloc(num_opts * sizeof(*opts));
3377 for (i = 0; i < num_opts; i++) {
3378 opts_copy[i] = option_dup_subs(opts[i]);
3379 if (!opts_copy[i])
3380 continue;
3381 opts_copy[i] = fio_keyword_replace(opts_copy[i]);
3382 }
3383 return opts_copy;
3384}
3385
3b8b7135 3386int fio_options_parse(struct thread_data *td, char **opts, int num_opts)
214e1eca 3387{
de890a1e 3388 int i, ret, unknown;
d0c814ec 3389 char **opts_copy;
3b8b7135 3390
9af4a244 3391 sort_options(opts, fio_options, num_opts);
d0c814ec 3392 opts_copy = dup_and_sub_options(opts, num_opts);
3b8b7135 3393
de890a1e
SL
3394 for (ret = 0, i = 0, unknown = 0; i < num_opts; i++) {
3395 struct fio_option *o;
9af4a244
JA
3396 int newret = parse_option(opts_copy[i], opts[i], fio_options,
3397 &o, td);
d0c814ec 3398
de890a1e
SL
3399 if (opts_copy[i]) {
3400 if (newret && !o) {
3401 unknown++;
3402 continue;
3403 }
d0c814ec 3404 free(opts_copy[i]);
de890a1e
SL
3405 opts_copy[i] = NULL;
3406 }
3407
3408 ret |= newret;
3409 }
3410
3411 if (unknown) {
3412 ret |= ioengine_load(td);
3413 if (td->eo) {
3414 sort_options(opts_copy, td->io_ops->options, num_opts);
3415 opts = opts_copy;
3416 }
3417 for (i = 0; i < num_opts; i++) {
3418 struct fio_option *o = NULL;
3419 int newret = 1;
3420 if (!opts_copy[i])
3421 continue;
3422
3423 if (td->eo)
3424 newret = parse_option(opts_copy[i], opts[i],
3425 td->io_ops->options, &o,
3426 td->eo);
3427
3428 ret |= newret;
3429 if (!o)
3430 log_err("Bad option <%s>\n", opts[i]);
3431
3432 free(opts_copy[i]);
3433 opts_copy[i] = NULL;
3434 }
74929ac2 3435 }
3b8b7135 3436
d0c814ec 3437 free(opts_copy);
3b8b7135 3438 return ret;
214e1eca
JA
3439}
3440
3441int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
3442{
9af4a244 3443 return parse_cmd_option(opt, val, fio_options, td);
214e1eca
JA
3444}
3445
de890a1e
SL
3446int fio_cmd_ioengine_option_parse(struct thread_data *td, const char *opt,
3447 char *val)
3448{
3449 return parse_cmd_option(opt, val, td->io_ops->options, td);
3450}
3451
214e1eca
JA
3452void fio_fill_default_options(struct thread_data *td)
3453{
9af4a244 3454 fill_default_options(td, fio_options);
214e1eca
JA
3455}
3456
3457int fio_show_option_help(const char *opt)
3458{
9af4a244 3459 return show_cmd_help(fio_options, opt);
214e1eca 3460}
d23bb327 3461
de890a1e 3462void options_mem_dupe(void *data, struct fio_option *options)
d23bb327 3463{
de890a1e 3464 struct fio_option *o;
d23bb327 3465 char **ptr;
d23bb327 3466
de890a1e
SL
3467 for (o = &options[0]; o->name; o++) {
3468 if (o->type != FIO_OPT_STR_STORE)
d23bb327
JA
3469 continue;
3470
de890a1e 3471 ptr = td_var(data, o->off1);
7e356b2d
JA
3472 if (*ptr)
3473 *ptr = strdup(*ptr);
d23bb327
JA
3474 }
3475}
3476
de890a1e
SL
3477/*
3478 * dupe FIO_OPT_STR_STORE options
3479 */
3480void fio_options_mem_dupe(struct thread_data *td)
3481{
9af4a244 3482 options_mem_dupe(&td->o, fio_options);
1647f592
JA
3483
3484 if (td->eo && td->io_ops) {
de890a1e 3485 void *oldeo = td->eo;
1647f592 3486
de890a1e
SL
3487 td->eo = malloc(td->io_ops->option_struct_size);
3488 memcpy(td->eo, oldeo, td->io_ops->option_struct_size);
3489 options_mem_dupe(td->eo, td->io_ops->options);
3490 }
3491}
3492
d6978a32
JA
3493unsigned int fio_get_kb_base(void *data)
3494{
83ea422a 3495 struct thread_options *o = data;
d6978a32
JA
3496 unsigned int kb_base = 0;
3497
83ea422a
JA
3498 if (o)
3499 kb_base = o->kb_base;
d6978a32
JA
3500 if (!kb_base)
3501 kb_base = 1024;
3502
3503 return kb_base;
3504}
9f988e2e 3505
07b3232d 3506int add_option(struct fio_option *o)
9f988e2e 3507{
07b3232d
JA
3508 struct fio_option *__o;
3509 int opt_index = 0;
3510
9af4a244 3511 __o = fio_options;
07b3232d
JA
3512 while (__o->name) {
3513 opt_index++;
3514 __o++;
3515 }
3516
9af4a244 3517 memcpy(&fio_options[opt_index], o, sizeof(*o));
07b3232d 3518 return 0;
9f988e2e 3519}
e2de69da 3520
07b3232d 3521void invalidate_profile_options(const char *prof_name)
e2de69da 3522{
07b3232d 3523 struct fio_option *o;
e2de69da 3524
9af4a244 3525 o = fio_options;
07b3232d
JA
3526 while (o->name) {
3527 if (o->prof_name && !strcmp(o->prof_name, prof_name)) {
3528 o->type = FIO_OPT_INVALID;
3529 o->prof_name = NULL;
3530 }
3531 o++;
e2de69da
JA
3532 }
3533}
f5b6bb85
JA
3534
3535void add_opt_posval(const char *optname, const char *ival, const char *help)
3536{
3537 struct fio_option *o;
3538 unsigned int i;
3539
9af4a244 3540 o = find_option(fio_options, optname);
f5b6bb85
JA
3541 if (!o)
3542 return;
3543
3544 for (i = 0; i < PARSE_MAX_VP; i++) {
3545 if (o->posval[i].ival)
3546 continue;
3547
3548 o->posval[i].ival = ival;
3549 o->posval[i].help = help;
3550 break;
3551 }
3552}
3553
3554void del_opt_posval(const char *optname, const char *ival)
3555{
3556 struct fio_option *o;
3557 unsigned int i;
3558
9af4a244 3559 o = find_option(fio_options, optname);
f5b6bb85
JA
3560 if (!o)
3561 return;
3562
3563 for (i = 0; i < PARSE_MAX_VP; i++) {
3564 if (!o->posval[i].ival)
3565 continue;
3566 if (strcmp(o->posval[i].ival, ival))
3567 continue;
3568
3569 o->posval[i].ival = NULL;
3570 o->posval[i].help = NULL;
3571 }
3572}
7e356b2d
JA
3573
3574void fio_options_free(struct thread_data *td)
3575{
9af4a244 3576 options_free(fio_options, td);
de890a1e
SL
3577 if (td->eo && td->io_ops && td->io_ops->options) {
3578 options_free(td->io_ops->options, td->eo);
3579 free(td->eo);
3580 td->eo = NULL;
3581 }
7e356b2d 3582}
c504ee55
JA
3583
3584struct fio_option *fio_option_find(const char *name)
3585{
3586 return find_option(fio_options, name);
3587}
3588