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