Fix printf() being used instead of log_info()
[fio.git] / options.c
CommitLineData
214e1eca
JA
1#include <stdio.h>
2#include <stdlib.h>
3#include <unistd.h>
4#include <ctype.h>
5#include <string.h>
214e1eca 6#include <assert.h>
921c766f 7#include <libgen.h>
5921e80c
JA
8#include <fcntl.h>
9#include <sys/types.h>
10#include <sys/stat.h>
214e1eca
JA
11
12#include "fio.h"
4f5af7b2 13#include "verify.h"
214e1eca 14#include "parse.h"
eef32359 15#include "lib/fls.h"
9f988e2e 16#include "options.h"
214e1eca 17
5d7c5d34
JA
18#include "crc/crc32c.h"
19
214e1eca
JA
20/*
21 * Check if mmap/mmaphuge has a :/foo/bar/file at the end. If so, return that.
22 */
23static char *get_opt_postfix(const char *str)
24{
25 char *p = strstr(str, ":");
26
27 if (!p)
28 return NULL;
29
30 p++;
31 strip_blank_front(&p);
32 strip_blank_end(p);
33 return strdup(p);
34}
35
0e92f873
RR
36static int converthexchartoint(char a)
37{
38 int base;
39
40 switch(a) {
41 case '0'...'9':
42 base = '0';
43 break;
44 case 'A'...'F':
45 base = 'A' - 10;
46 break;
47 case 'a'...'f':
48 base = 'a' - 10;
49 break;
50 default:
51 base = 0;
52 }
53 return (a - base);
54}
55
564ca972
JA
56static int bs_cmp(const void *p1, const void *p2)
57{
58 const struct bssplit *bsp1 = p1;
59 const struct bssplit *bsp2 = p2;
60
61 return bsp1->perc < bsp2->perc;
62}
63
720e84ad 64static int bssplit_ddir(struct thread_data *td, int ddir, char *str)
564ca972 65{
720e84ad 66 struct bssplit *bssplit;
564ca972
JA
67 unsigned int i, perc, perc_missing;
68 unsigned int max_bs, min_bs;
69 long long val;
720e84ad 70 char *fname;
564ca972 71
720e84ad
JA
72 td->o.bssplit_nr[ddir] = 4;
73 bssplit = malloc(4 * sizeof(struct bssplit));
564ca972
JA
74
75 i = 0;
76 max_bs = 0;
77 min_bs = -1;
78 while ((fname = strsep(&str, ":")) != NULL) {
79 char *perc_str;
80
81 if (!strlen(fname))
82 break;
83
84 /*
85 * grow struct buffer, if needed
86 */
720e84ad
JA
87 if (i == td->o.bssplit_nr[ddir]) {
88 td->o.bssplit_nr[ddir] <<= 1;
89 bssplit = realloc(bssplit, td->o.bssplit_nr[ddir]
5ec10eaa 90 * sizeof(struct bssplit));
564ca972
JA
91 }
92
93 perc_str = strstr(fname, "/");
94 if (perc_str) {
95 *perc_str = '\0';
96 perc_str++;
97 perc = atoi(perc_str);
98 if (perc > 100)
99 perc = 100;
100 else if (!perc)
101 perc = -1;
102 } else
103 perc = -1;
104
6925dd35 105 if (str_to_decimal(fname, &val, 1, td)) {
564ca972
JA
106 log_err("fio: bssplit conversion failed\n");
107 free(td->o.bssplit);
108 return 1;
109 }
110
111 if (val > max_bs)
112 max_bs = val;
113 if (val < min_bs)
114 min_bs = val;
115
720e84ad
JA
116 bssplit[i].bs = val;
117 bssplit[i].perc = perc;
564ca972
JA
118 i++;
119 }
120
720e84ad 121 td->o.bssplit_nr[ddir] = i;
564ca972
JA
122
123 /*
124 * Now check if the percentages add up, and how much is missing
125 */
126 perc = perc_missing = 0;
720e84ad
JA
127 for (i = 0; i < td->o.bssplit_nr[ddir]; i++) {
128 struct bssplit *bsp = &bssplit[i];
564ca972
JA
129
130 if (bsp->perc == (unsigned char) -1)
131 perc_missing++;
132 else
133 perc += bsp->perc;
134 }
135
136 if (perc > 100) {
137 log_err("fio: bssplit percentages add to more than 100%%\n");
720e84ad 138 free(bssplit);
564ca972
JA
139 return 1;
140 }
141 /*
142 * If values didn't have a percentage set, divide the remains between
143 * them.
144 */
145 if (perc_missing) {
720e84ad
JA
146 for (i = 0; i < td->o.bssplit_nr[ddir]; i++) {
147 struct bssplit *bsp = &bssplit[i];
564ca972
JA
148
149 if (bsp->perc == (unsigned char) -1)
150 bsp->perc = (100 - perc) / perc_missing;
151 }
152 }
153
720e84ad
JA
154 td->o.min_bs[ddir] = min_bs;
155 td->o.max_bs[ddir] = max_bs;
564ca972
JA
156
157 /*
158 * now sort based on percentages, for ease of lookup
159 */
720e84ad
JA
160 qsort(bssplit, td->o.bssplit_nr[ddir], sizeof(struct bssplit), bs_cmp);
161 td->o.bssplit[ddir] = bssplit;
162 return 0;
163
164}
165
166static int str_bssplit_cb(void *data, const char *input)
167{
168 struct thread_data *td = data;
169 char *str, *p, *odir;
170 int ret = 0;
171
172 p = str = strdup(input);
173
174 strip_blank_front(&str);
175 strip_blank_end(str);
176
177 odir = strchr(str, ',');
178 if (odir) {
179 ret = bssplit_ddir(td, DDIR_WRITE, odir + 1);
180 if (!ret) {
181 *odir = '\0';
182 ret = bssplit_ddir(td, DDIR_READ, str);
183 }
184 } else {
185 char *op;
186
187 op = strdup(str);
188
189 ret = bssplit_ddir(td, DDIR_READ, str);
190 if (!ret)
191 ret = bssplit_ddir(td, DDIR_WRITE, op);
192
193 free(op);
194 }
564ca972
JA
195
196 free(p);
720e84ad 197 return ret;
564ca972
JA
198}
199
211097b2
JA
200static int str_rw_cb(void *data, const char *str)
201{
202 struct thread_data *td = data;
203 char *nr = get_opt_postfix(str);
204
5736c10d 205 td->o.ddir_seq_nr = 1;
059b0802
JA
206 td->o.ddir_seq_add = 0;
207
208 if (!nr)
209 return 0;
210
211 if (td_random(td))
5736c10d 212 td->o.ddir_seq_nr = atoi(nr);
059b0802
JA
213 else {
214 long long val;
215
6925dd35 216 if (str_to_decimal(nr, &val, 1, td)) {
059b0802
JA
217 log_err("fio: rw postfix parsing failed\n");
218 free(nr);
219 return 1;
220 }
221
222 td->o.ddir_seq_add = val;
182ec6ee 223 }
211097b2 224
059b0802 225 free(nr);
211097b2
JA
226 return 0;
227}
228
c44b1ff5
JA
229#ifdef FIO_HAVE_LIBAIO
230static int str_libaio_cb(void *data, const char *str)
231{
232 struct thread_data *td = data;
233
234 if (!strcmp(str, "userspace_reap")) {
235 td->o.userspace_libaio_reap = 1;
236 return 0;
237 }
238
239 log_err("fio: bad libaio sub-option: %s\n", str);
240 return 1;
241}
242#endif
243
214e1eca
JA
244static int str_mem_cb(void *data, const char *mem)
245{
246 struct thread_data *td = data;
247
2dc1bbeb 248 if (td->o.mem_type == MEM_MMAPHUGE || td->o.mem_type == MEM_MMAP) {
214e1eca 249 td->mmapfile = get_opt_postfix(mem);
2dc1bbeb 250 if (td->o.mem_type == MEM_MMAPHUGE && !td->mmapfile) {
214e1eca
JA
251 log_err("fio: mmaphuge:/path/to/file\n");
252 return 1;
253 }
254 }
255
256 return 0;
257}
258
5d7c5d34
JA
259static int str_verify_cb(void *data, const char *mem)
260{
261 struct thread_data *td = data;
262
263 if (td->o.verify != VERIFY_CRC32C_INTEL)
264 return 0;
265
266 if (!crc32c_intel_works()) {
267 log_info("fio: System does not support hw accelerated crc32c. Falling back to sw crc32c.\n");
268 td->o.verify = VERIFY_CRC32C;
269 }
270
271 return 0;
272}
273
c223da83
JA
274static int fio_clock_source_cb(void *data, const char *str)
275{
276 struct thread_data *td = data;
277
278 fio_clock_source = td->o.clocksource;
279 fio_time_init();
280 return 0;
281}
282
85bc833b 283static int str_lockmem_cb(void fio_unused *data, unsigned long long *val)
214e1eca
JA
284{
285 mlock_size = *val;
286 return 0;
287}
288
85bc833b 289static int str_rwmix_read_cb(void *data, unsigned long long *val)
cb499fc4
JA
290{
291 struct thread_data *td = data;
292
293 td->o.rwmix[DDIR_READ] = *val;
294 td->o.rwmix[DDIR_WRITE] = 100 - *val;
295 return 0;
296}
297
85bc833b 298static int str_rwmix_write_cb(void *data, unsigned long long *val)
cb499fc4
JA
299{
300 struct thread_data *td = data;
301
302 td->o.rwmix[DDIR_WRITE] = *val;
303 td->o.rwmix[DDIR_READ] = 100 - *val;
304 return 0;
305}
306
214e1eca 307#ifdef FIO_HAVE_IOPRIO
85bc833b 308static int str_prioclass_cb(void *data, unsigned long long *val)
214e1eca
JA
309{
310 struct thread_data *td = data;
6cefbe33
JA
311 unsigned short mask;
312
313 /*
314 * mask off old class bits, str_prio_cb() may have set a default class
315 */
316 mask = (1 << IOPRIO_CLASS_SHIFT) - 1;
317 td->ioprio &= mask;
214e1eca
JA
318
319 td->ioprio |= *val << IOPRIO_CLASS_SHIFT;
ac684785 320 td->ioprio_set = 1;
214e1eca
JA
321 return 0;
322}
323
85bc833b 324static int str_prio_cb(void *data, unsigned long long *val)
214e1eca
JA
325{
326 struct thread_data *td = data;
327
328 td->ioprio |= *val;
6cefbe33
JA
329
330 /*
331 * If no class is set, assume BE
332 */
333 if ((td->ioprio >> IOPRIO_CLASS_SHIFT) == 0)
334 td->ioprio |= IOPRIO_CLASS_BE << IOPRIO_CLASS_SHIFT;
335
ac684785 336 td->ioprio_set = 1;
214e1eca
JA
337 return 0;
338}
339#endif
340
341static int str_exitall_cb(void)
342{
343 exitall_on_terminate = 1;
344 return 0;
345}
346
214e1eca 347#ifdef FIO_HAVE_CPU_AFFINITY
85bc833b 348static int str_cpumask_cb(void *data, unsigned long long *val)
d2e268b0
JA
349{
350 struct thread_data *td = data;
214e1eca 351 unsigned int i;
b03daafb 352 long max_cpu;
d2ce18b5
JA
353 int ret;
354
355 ret = fio_cpuset_init(&td->o.cpumask);
356 if (ret < 0) {
357 log_err("fio: cpuset_init failed\n");
358 td_verror(td, ret, "fio_cpuset_init");
359 return 1;
360 }
214e1eca 361
c00a2289 362 max_cpu = cpus_online();
214e1eca 363
62a7273d
JA
364 for (i = 0; i < sizeof(int) * 8; i++) {
365 if ((1 << i) & *val) {
b03daafb
JA
366 if (i > max_cpu) {
367 log_err("fio: CPU %d too large (max=%ld)\n", i,
368 max_cpu);
369 return 1;
370 }
62a7273d 371 dprint(FD_PARSE, "set cpu allowed %d\n", i);
6d459ee7 372 fio_cpu_set(&td->o.cpumask, i);
62a7273d
JA
373 }
374 }
d2e268b0
JA
375
376 td->o.cpumask_set = 1;
377 return 0;
214e1eca
JA
378}
379
e8462bd8
JA
380static int set_cpus_allowed(struct thread_data *td, os_cpu_mask_t *mask,
381 const char *input)
214e1eca 382{
d2e268b0 383 char *cpu, *str, *p;
b03daafb 384 long max_cpu;
19608d6c 385 int ret = 0;
d2e268b0 386
e8462bd8 387 ret = fio_cpuset_init(mask);
d2ce18b5
JA
388 if (ret < 0) {
389 log_err("fio: cpuset_init failed\n");
390 td_verror(td, ret, "fio_cpuset_init");
391 return 1;
392 }
d2e268b0
JA
393
394 p = str = strdup(input);
214e1eca 395
d2e268b0
JA
396 strip_blank_front(&str);
397 strip_blank_end(str);
398
c00a2289 399 max_cpu = cpus_online();
b03daafb 400
d2e268b0 401 while ((cpu = strsep(&str, ",")) != NULL) {
62a7273d
JA
402 char *str2, *cpu2;
403 int icpu, icpu2;
404
d2e268b0
JA
405 if (!strlen(cpu))
406 break;
62a7273d
JA
407
408 str2 = cpu;
409 icpu2 = -1;
410 while ((cpu2 = strsep(&str2, "-")) != NULL) {
411 if (!strlen(cpu2))
412 break;
413
414 icpu2 = atoi(cpu2);
415 }
416
417 icpu = atoi(cpu);
418 if (icpu2 == -1)
419 icpu2 = icpu;
420 while (icpu <= icpu2) {
6d459ee7 421 if (icpu >= FIO_MAX_CPUS) {
19608d6c 422 log_err("fio: your OS only supports up to"
6d459ee7 423 " %d CPUs\n", (int) FIO_MAX_CPUS);
19608d6c
JA
424 ret = 1;
425 break;
426 }
b03daafb
JA
427 if (icpu > max_cpu) {
428 log_err("fio: CPU %d too large (max=%ld)\n",
429 icpu, max_cpu);
430 ret = 1;
431 break;
432 }
0b9d69ec 433
62a7273d 434 dprint(FD_PARSE, "set cpu allowed %d\n", icpu);
e8462bd8 435 fio_cpu_set(mask, icpu);
62a7273d
JA
436 icpu++;
437 }
19608d6c
JA
438 if (ret)
439 break;
d2e268b0
JA
440 }
441
442 free(p);
19608d6c
JA
443 if (!ret)
444 td->o.cpumask_set = 1;
445 return ret;
214e1eca 446}
e8462bd8
JA
447
448static int str_cpus_allowed_cb(void *data, const char *input)
449{
450 struct thread_data *td = data;
451 int ret;
452
453 ret = set_cpus_allowed(td, &td->o.cpumask, input);
454 if (!ret)
455 td->o.cpumask_set = 1;
456
457 return ret;
458}
459
460static int str_verify_cpus_allowed_cb(void *data, const char *input)
461{
462 struct thread_data *td = data;
463 int ret;
464
465 ret = set_cpus_allowed(td, &td->o.verify_cpumask, input);
466 if (!ret)
467 td->o.verify_cpumask_set = 1;
468
469 return ret;
470}
d2e268b0 471#endif
214e1eca 472
0d29de83
JA
473#ifdef FIO_HAVE_TRIM
474static int str_verify_trim_cb(void *data, unsigned long long *val)
475{
476 struct thread_data *td = data;
477
478 td->o.trim_percentage = *val;
479 return 0;
480}
481#endif
482
214e1eca
JA
483static int str_fst_cb(void *data, const char *str)
484{
485 struct thread_data *td = data;
486 char *nr = get_opt_postfix(str);
487
488 td->file_service_nr = 1;
182ec6ee 489 if (nr) {
214e1eca 490 td->file_service_nr = atoi(nr);
182ec6ee
JA
491 free(nr);
492 }
214e1eca
JA
493
494 return 0;
495}
496
3ae06371 497#ifdef FIO_HAVE_SYNC_FILE_RANGE
44f29692
JA
498static int str_sfr_cb(void *data, const char *str)
499{
500 struct thread_data *td = data;
501 char *nr = get_opt_postfix(str);
502
503 td->sync_file_range_nr = 1;
504 if (nr) {
505 td->sync_file_range_nr = atoi(nr);
506 free(nr);
507 }
508
509 return 0;
510}
3ae06371 511#endif
44f29692 512
921c766f
JA
513static int check_dir(struct thread_data *td, char *fname)
514{
3f0ca9b9 515#if 0
921c766f 516 char file[PATH_MAX], *dir;
bc838919 517 int elen = 0;
921c766f 518
bc838919
JA
519 if (td->o.directory) {
520 strcpy(file, td->o.directory);
fcef0b35 521 strcat(file, "/");
bc838919
JA
522 elen = strlen(file);
523 }
524
fcef0b35 525 sprintf(file + elen, "%s", fname);
921c766f
JA
526 dir = dirname(file);
527
fcef0b35
JA
528 {
529 struct stat sb;
530 /*
531 * We can't do this on FIO_DISKLESSIO engines. The engine isn't loaded
532 * yet, so we can't do this check right here...
533 */
921c766f
JA
534 if (lstat(dir, &sb) < 0) {
535 int ret = errno;
536
537 log_err("fio: %s is not a directory\n", dir);
538 td_verror(td, ret, "lstat");
539 return 1;
540 }
541
542 if (!S_ISDIR(sb.st_mode)) {
543 log_err("fio: %s is not a directory\n", dir);
544 return 1;
545 }
fcef0b35
JA
546 }
547#endif
921c766f
JA
548
549 return 0;
550}
551
8e827d35
JA
552/*
553 * Return next file in the string. Files are separated with ':'. If the ':'
554 * is escaped with a '\', then that ':' is part of the filename and does not
555 * indicate a new file.
556 */
557static char *get_next_file_name(char **ptr)
558{
559 char *str = *ptr;
560 char *p, *start;
561
562 if (!str || !strlen(str))
563 return NULL;
564
565 start = str;
566 do {
567 /*
568 * No colon, we are done
569 */
570 p = strchr(str, ':');
571 if (!p) {
572 *ptr = NULL;
573 break;
574 }
575
576 /*
577 * We got a colon, but it's the first character. Skip and
578 * continue
579 */
580 if (p == start) {
581 str = ++start;
582 continue;
583 }
584
585 if (*(p - 1) != '\\') {
586 *p = '\0';
587 *ptr = p + 1;
588 break;
589 }
590
591 memmove(p - 1, p, strlen(p) + 1);
592 str = p;
593 } while (1);
594
595 return start;
596}
597
0fd666bf
JA
598static int str_hostname_cb(void *data, const char *input)
599{
600 struct thread_data *td = data;
601
602 td->o.filename = strdup(input);
603 return 0;
604}
605
214e1eca
JA
606static int str_filename_cb(void *data, const char *input)
607{
608 struct thread_data *td = data;
609 char *fname, *str, *p;
610
611 p = str = strdup(input);
612
613 strip_blank_front(&str);
614 strip_blank_end(str);
615
616 if (!td->files_index)
2dc1bbeb 617 td->o.nr_files = 0;
214e1eca 618
8e827d35 619 while ((fname = get_next_file_name(&str)) != NULL) {
214e1eca
JA
620 if (!strlen(fname))
621 break;
921c766f
JA
622 if (check_dir(td, fname)) {
623 free(p);
624 return 1;
625 }
214e1eca 626 add_file(td, fname);
2dc1bbeb 627 td->o.nr_files++;
214e1eca
JA
628 }
629
630 free(p);
631 return 0;
632}
633
634static int str_directory_cb(void *data, const char fio_unused *str)
635{
636 struct thread_data *td = data;
637 struct stat sb;
638
2dc1bbeb 639 if (lstat(td->o.directory, &sb) < 0) {
921c766f
JA
640 int ret = errno;
641
2dc1bbeb 642 log_err("fio: %s is not a directory\n", td->o.directory);
921c766f 643 td_verror(td, ret, "lstat");
214e1eca
JA
644 return 1;
645 }
646 if (!S_ISDIR(sb.st_mode)) {
2dc1bbeb 647 log_err("fio: %s is not a directory\n", td->o.directory);
214e1eca
JA
648 return 1;
649 }
650
651 return 0;
652}
653
654static int str_opendir_cb(void *data, const char fio_unused *str)
655{
656 struct thread_data *td = data;
657
658 if (!td->files_index)
2dc1bbeb 659 td->o.nr_files = 0;
214e1eca 660
2dc1bbeb 661 return add_dir_files(td, td->o.opendir);
214e1eca
JA
662}
663
85bc833b 664static int str_verify_offset_cb(void *data, unsigned long long *off)
546a9142
SL
665{
666 struct thread_data *td = data;
a59e170d 667
546a9142 668 if (*off && *off < sizeof(struct verify_header)) {
a59e170d 669 log_err("fio: verify_offset too small\n");
546a9142
SL
670 return 1;
671 }
a59e170d
JA
672
673 td->o.verify_offset = *off;
546a9142
SL
674 return 0;
675}
676
0e92f873 677static int str_verify_pattern_cb(void *data, const char *input)
90059d65
JA
678{
679 struct thread_data *td = data;
0e92f873
RR
680 long off;
681 int i = 0, j = 0, len, k, base = 10;
682 char* loc1, * loc2;
683
684 loc1 = strstr(input, "0x");
685 loc2 = strstr(input, "0X");
686 if (loc1 || loc2)
687 base = 16;
688 off = strtol(input, NULL, base);
689 if (off != LONG_MAX || errno != ERANGE) {
690 while (off) {
691 td->o.verify_pattern[i] = off & 0xff;
692 off >>= 8;
693 i++;
694 }
695 } else {
696 len = strlen(input);
697 k = len - 1;
698 if (base == 16) {
699 if (loc1)
700 j = loc1 - input + 2;
701 else
702 j = loc2 - input + 2;
703 } else
704 return 1;
705 if (len - j < MAX_PATTERN_SIZE * 2) {
706 while (k >= j) {
707 off = converthexchartoint(input[k--]);
708 if (k >= j)
709 off += (converthexchartoint(input[k--])
710 * 16);
711 td->o.verify_pattern[i++] = (char) off;
712 }
713 }
714 }
715 td->o.verify_pattern_bytes = i;
92bf48d5
JA
716 /*
717 * VERIFY_META could already be set
718 */
719 if (td->o.verify == VERIFY_NONE)
720 td->o.verify = VERIFY_PATTERN;
90059d65
JA
721 return 0;
722}
214e1eca 723
4d4e80f2
JA
724static int str_lockfile_cb(void *data, const char *str)
725{
726 struct thread_data *td = data;
727 char *nr = get_opt_postfix(str);
728
729 td->o.lockfile_batch = 1;
182ec6ee 730 if (nr) {
4d4e80f2 731 td->o.lockfile_batch = atoi(nr);
182ec6ee
JA
732 free(nr);
733 }
4d4e80f2
JA
734
735 return 0;
736}
737
e3cedca7
JA
738static int str_write_bw_log_cb(void *data, const char *str)
739{
740 struct thread_data *td = data;
741
742 if (str)
743 td->o.bw_log_file = strdup(str);
744
745 td->o.write_bw_log = 1;
746 return 0;
747}
748
749static int str_write_lat_log_cb(void *data, const char *str)
750{
751 struct thread_data *td = data;
752
753 if (str)
754 td->o.lat_log_file = strdup(str);
755
756 td->o.write_lat_log = 1;
757 return 0;
758}
759
c8eeb9df
JA
760static int str_write_iops_log_cb(void *data, const char *str)
761{
762 struct thread_data *td = data;
763
764 if (str)
765 td->o.iops_log_file = strdup(str);
766
767 td->o.write_iops_log = 1;
768 return 0;
769}
770
993bf48b
JA
771static int str_gtod_reduce_cb(void *data, int *il)
772{
773 struct thread_data *td = data;
774 int val = *il;
775
02af0988 776 td->o.disable_lat = !!val;
993bf48b
JA
777 td->o.disable_clat = !!val;
778 td->o.disable_slat = !!val;
779 td->o.disable_bw = !!val;
0dc1bc03 780 td->o.clat_percentiles = !val;
993bf48b
JA
781 if (val)
782 td->tv_cache_mask = 63;
783
784 return 0;
785}
786
85bc833b 787static int str_gtod_cpu_cb(void *data, long long *il)
be4ecfdf
JA
788{
789 struct thread_data *td = data;
790 int val = *il;
791
792 td->o.gtod_cpu = val;
793 td->o.gtod_offload = 1;
794 return 0;
795}
796
7bb59102
JA
797static int str_size_cb(void *data, unsigned long long *__val)
798{
799 struct thread_data *td = data;
800 unsigned long long v = *__val;
801
802 if (parse_is_percent(v)) {
803 td->o.size = 0;
804 td->o.size_percent = -1ULL - v;
805 } else
806 td->o.size = v;
807
808 return 0;
809}
810
896cac2a
JA
811static int rw_verify(struct fio_option *o, void *data)
812{
813 struct thread_data *td = data;
814
815 if (read_only && td_write(td)) {
816 log_err("fio: job <%s> has write bit set, but fio is in"
817 " read-only mode\n", td->o.name);
818 return 1;
819 }
820
821 return 0;
822}
823
276ca4f7 824static int gtod_cpu_verify(struct fio_option *o, void *data)
29d43ff9 825{
276ca4f7 826#ifndef FIO_HAVE_CPU_AFFINITY
29d43ff9
JA
827 struct thread_data *td = data;
828
29d43ff9
JA
829 if (td->o.gtod_cpu) {
830 log_err("fio: platform must support CPU affinity for"
831 "gettimeofday() offloading\n");
832 return 1;
833 }
834#endif
835
836 return 0;
837}
838
90fef2d1
JA
839static int kb_base_verify(struct fio_option *o, void *data)
840{
841 struct thread_data *td = data;
842
843 if (td->o.kb_base != 1024 && td->o.kb_base != 1000) {
844 log_err("fio: kb_base set to nonsensical value: %u\n",
845 td->o.kb_base);
846 return 1;
847 }
848
849 return 0;
850}
851
214e1eca
JA
852/*
853 * Map of job/command line options
854 */
07b3232d 855static struct fio_option options[FIO_MAX_OPTS] = {
214e1eca
JA
856 {
857 .name = "description",
858 .type = FIO_OPT_STR_STORE,
859 .off1 = td_var_offset(description),
860 .help = "Text job description",
861 },
862 {
863 .name = "name",
864 .type = FIO_OPT_STR_STORE,
865 .off1 = td_var_offset(name),
866 .help = "Name of this job",
867 },
868 {
869 .name = "directory",
870 .type = FIO_OPT_STR_STORE,
871 .off1 = td_var_offset(directory),
872 .cb = str_directory_cb,
873 .help = "Directory to store files in",
874 },
875 {
876 .name = "filename",
877 .type = FIO_OPT_STR_STORE,
878 .off1 = td_var_offset(filename),
879 .cb = str_filename_cb,
f0d524b0 880 .prio = -1, /* must come after "directory" */
214e1eca
JA
881 .help = "File(s) to use for the workload",
882 },
0fd666bf
JA
883 {
884 .name = "hostname",
885 .type = FIO_OPT_STR_STORE,
886 .cb = str_hostname_cb,
887 .help = "Hostname for net IO engine",
888 },
90fef2d1
JA
889 {
890 .name = "kb_base",
891 .type = FIO_OPT_INT,
892 .off1 = td_var_offset(kb_base),
90fef2d1 893 .verify = kb_base_verify,
a639f0bb 894 .prio = 1,
90fef2d1 895 .def = "1024",
a639f0bb 896 .help = "How many bytes per KB for reporting (1000 or 1024)",
90fef2d1 897 },
29c1349f
JA
898 {
899 .name = "lockfile",
4d4e80f2
JA
900 .type = FIO_OPT_STR,
901 .cb = str_lockfile_cb,
902 .off1 = td_var_offset(file_lock_mode),
29c1349f
JA
903 .help = "Lock file when doing IO to it",
904 .parent = "filename",
4d4e80f2
JA
905 .def = "none",
906 .posval = {
907 { .ival = "none",
908 .oval = FILE_LOCK_NONE,
909 .help = "No file locking",
910 },
911 { .ival = "exclusive",
912 .oval = FILE_LOCK_EXCLUSIVE,
913 .help = "Exclusive file lock",
914 },
915 {
916 .ival = "readwrite",
917 .oval = FILE_LOCK_READWRITE,
918 .help = "Read vs write lock",
919 },
920 },
29c1349f 921 },
214e1eca
JA
922 {
923 .name = "opendir",
924 .type = FIO_OPT_STR_STORE,
925 .off1 = td_var_offset(opendir),
926 .cb = str_opendir_cb,
927 .help = "Recursively add files from this directory and down",
928 },
929 {
930 .name = "rw",
d3aad8f2 931 .alias = "readwrite",
214e1eca 932 .type = FIO_OPT_STR,
211097b2 933 .cb = str_rw_cb,
214e1eca
JA
934 .off1 = td_var_offset(td_ddir),
935 .help = "IO direction",
936 .def = "read",
896cac2a 937 .verify = rw_verify,
214e1eca
JA
938 .posval = {
939 { .ival = "read",
940 .oval = TD_DDIR_READ,
941 .help = "Sequential read",
942 },
943 { .ival = "write",
944 .oval = TD_DDIR_WRITE,
945 .help = "Sequential write",
946 },
947 { .ival = "randread",
948 .oval = TD_DDIR_RANDREAD,
949 .help = "Random read",
950 },
951 { .ival = "randwrite",
952 .oval = TD_DDIR_RANDWRITE,
953 .help = "Random write",
954 },
955 { .ival = "rw",
956 .oval = TD_DDIR_RW,
957 .help = "Sequential read and write mix",
958 },
959 { .ival = "randrw",
960 .oval = TD_DDIR_RANDRW,
961 .help = "Random read and write mix"
962 },
963 },
964 },
38dad62d
JA
965 {
966 .name = "rw_sequencer",
967 .type = FIO_OPT_STR,
968 .off1 = td_var_offset(rw_seq),
969 .help = "IO offset generator modifier",
970 .def = "sequential",
971 .posval = {
972 { .ival = "sequential",
973 .oval = RW_SEQ_SEQ,
974 .help = "Generate sequential offsets",
975 },
976 { .ival = "identical",
977 .oval = RW_SEQ_IDENT,
978 .help = "Generate identical offsets",
979 },
980 },
981 },
982
214e1eca
JA
983 {
984 .name = "ioengine",
985 .type = FIO_OPT_STR_STORE,
986 .off1 = td_var_offset(ioengine),
987 .help = "IO engine to use",
58483fa4 988 .def = FIO_PREFERRED_ENGINE,
214e1eca
JA
989 .posval = {
990 { .ival = "sync",
991 .help = "Use read/write",
992 },
a31041ea 993 { .ival = "psync",
994 .help = "Use pread/pwrite",
995 },
1d2af02a 996 { .ival = "vsync",
03e20d68 997 .help = "Use readv/writev",
1d2af02a 998 },
214e1eca
JA
999#ifdef FIO_HAVE_LIBAIO
1000 { .ival = "libaio",
1001 .help = "Linux native asynchronous IO",
c44b1ff5 1002 .cb = str_libaio_cb,
214e1eca
JA
1003 },
1004#endif
1005#ifdef FIO_HAVE_POSIXAIO
1006 { .ival = "posixaio",
1007 .help = "POSIX asynchronous IO",
1008 },
417f0068
JA
1009#endif
1010#ifdef FIO_HAVE_SOLARISAIO
1011 { .ival = "solarisaio",
1012 .help = "Solaris native asynchronous IO",
1013 },
214e1eca 1014#endif
03e20d68
BC
1015#ifdef FIO_HAVE_WINDOWSAIO
1016 { .ival = "windowsaio",
3be80071 1017 .help = "Windows native asynchronous IO"
03e20d68 1018 },
3be80071 1019#endif
214e1eca 1020 { .ival = "mmap",
03e20d68 1021 .help = "Memory mapped IO"
214e1eca
JA
1022 },
1023#ifdef FIO_HAVE_SPLICE
1024 { .ival = "splice",
1025 .help = "splice/vmsplice based IO",
1026 },
9cce02e8
JA
1027 { .ival = "netsplice",
1028 .help = "splice/vmsplice to/from the network",
1029 },
214e1eca
JA
1030#endif
1031#ifdef FIO_HAVE_SGIO
1032 { .ival = "sg",
1033 .help = "SCSI generic v3 IO",
1034 },
1035#endif
1036 { .ival = "null",
1037 .help = "Testing engine (no data transfer)",
1038 },
1039 { .ival = "net",
1040 .help = "Network IO",
1041 },
1042#ifdef FIO_HAVE_SYSLET
1043 { .ival = "syslet-rw",
1044 .help = "syslet enabled async pread/pwrite IO",
1045 },
1046#endif
1047 { .ival = "cpuio",
03e20d68 1048 .help = "CPU cycle burner engine",
214e1eca 1049 },
b8c82a46
JA
1050#ifdef FIO_HAVE_GUASI
1051 { .ival = "guasi",
1052 .help = "GUASI IO engine",
1053 },
79a43187
JA
1054#endif
1055#ifdef FIO_HAVE_BINJECT
1056 { .ival = "binject",
1057 .help = "binject direct inject block engine",
1058 },
21b8aee8 1059#endif
1060#ifdef FIO_HAVE_RDMA
1061 { .ival = "rdma",
1062 .help = "RDMA IO engine",
1063 },
b8c82a46 1064#endif
214e1eca
JA
1065 { .ival = "external",
1066 .help = "Load external engine (append name)",
1067 },
1068 },
1069 },
1070 {
1071 .name = "iodepth",
1072 .type = FIO_OPT_INT,
1073 .off1 = td_var_offset(iodepth),
03e20d68 1074 .help = "Number of IO buffers to keep in flight",
757aff4f 1075 .minval = 1,
214e1eca
JA
1076 .def = "1",
1077 },
1078 {
1079 .name = "iodepth_batch",
4950421a 1080 .alias = "iodepth_batch_submit",
214e1eca
JA
1081 .type = FIO_OPT_INT,
1082 .off1 = td_var_offset(iodepth_batch),
d65db441 1083 .help = "Number of IO buffers to submit in one go",
afdf9352 1084 .parent = "iodepth",
a2e6f8ac
JA
1085 .minval = 1,
1086 .def = "1",
4950421a
JA
1087 },
1088 {
1089 .name = "iodepth_batch_complete",
1090 .type = FIO_OPT_INT,
1091 .off1 = td_var_offset(iodepth_batch_complete),
d65db441 1092 .help = "Number of IO buffers to retrieve in one go",
4950421a
JA
1093 .parent = "iodepth",
1094 .minval = 0,
1095 .def = "1",
214e1eca
JA
1096 },
1097 {
1098 .name = "iodepth_low",
1099 .type = FIO_OPT_INT,
1100 .off1 = td_var_offset(iodepth_low),
1101 .help = "Low water mark for queuing depth",
afdf9352 1102 .parent = "iodepth",
214e1eca
JA
1103 },
1104 {
1105 .name = "size",
1106 .type = FIO_OPT_STR_VAL,
7bb59102 1107 .cb = str_size_cb,
214e1eca
JA
1108 .help = "Total size of device or files",
1109 },
aa31f1f1
SL
1110 {
1111 .name = "fill_device",
74586c1e 1112 .alias = "fill_fs",
aa31f1f1
SL
1113 .type = FIO_OPT_BOOL,
1114 .off1 = td_var_offset(fill_device),
1115 .help = "Write until an ENOSPC error occurs",
1116 .def = "0",
1117 },
214e1eca
JA
1118 {
1119 .name = "filesize",
1120 .type = FIO_OPT_STR_VAL,
1121 .off1 = td_var_offset(file_size_low),
1122 .off2 = td_var_offset(file_size_high),
c3edbdba 1123 .minval = 1,
214e1eca
JA
1124 .help = "Size of individual files",
1125 },
67a1000f
JA
1126 {
1127 .name = "offset",
1128 .alias = "fileoffset",
1129 .type = FIO_OPT_STR_VAL,
1130 .off1 = td_var_offset(start_offset),
1131 .help = "Start IO from this offset",
1132 .def = "0",
1133 },
214e1eca
JA
1134 {
1135 .name = "bs",
d3aad8f2 1136 .alias = "blocksize",
e01b22b8 1137 .type = FIO_OPT_INT,
214e1eca
JA
1138 .off1 = td_var_offset(bs[DDIR_READ]),
1139 .off2 = td_var_offset(bs[DDIR_WRITE]),
c3edbdba 1140 .minval = 1,
214e1eca
JA
1141 .help = "Block size unit",
1142 .def = "4k",
67a1000f 1143 .parent = "rw",
214e1eca 1144 },
2b7a01d0
JA
1145 {
1146 .name = "ba",
1147 .alias = "blockalign",
e01b22b8 1148 .type = FIO_OPT_INT,
2b7a01d0
JA
1149 .off1 = td_var_offset(ba[DDIR_READ]),
1150 .off2 = td_var_offset(ba[DDIR_WRITE]),
1151 .minval = 1,
1152 .help = "IO block offset alignment",
1153 .parent = "rw",
1154 },
214e1eca
JA
1155 {
1156 .name = "bsrange",
d3aad8f2 1157 .alias = "blocksize_range",
214e1eca
JA
1158 .type = FIO_OPT_RANGE,
1159 .off1 = td_var_offset(min_bs[DDIR_READ]),
1160 .off2 = td_var_offset(max_bs[DDIR_READ]),
1161 .off3 = td_var_offset(min_bs[DDIR_WRITE]),
1162 .off4 = td_var_offset(max_bs[DDIR_WRITE]),
c3edbdba 1163 .minval = 1,
214e1eca 1164 .help = "Set block size range (in more detail than bs)",
67a1000f 1165 .parent = "rw",
214e1eca 1166 },
564ca972
JA
1167 {
1168 .name = "bssplit",
1169 .type = FIO_OPT_STR,
1170 .cb = str_bssplit_cb,
1171 .help = "Set a specific mix of block sizes",
1172 .parent = "rw",
1173 },
214e1eca
JA
1174 {
1175 .name = "bs_unaligned",
d3aad8f2 1176 .alias = "blocksize_unaligned",
214e1eca
JA
1177 .type = FIO_OPT_STR_SET,
1178 .off1 = td_var_offset(bs_unaligned),
1179 .help = "Don't sector align IO buffer sizes",
67a1000f 1180 .parent = "rw",
214e1eca
JA
1181 },
1182 {
1183 .name = "randrepeat",
1184 .type = FIO_OPT_BOOL,
1185 .off1 = td_var_offset(rand_repeatable),
1186 .help = "Use repeatable random IO pattern",
1187 .def = "1",
67a1000f 1188 .parent = "rw",
214e1eca 1189 },
2615cc4b
JA
1190 {
1191 .name = "use_os_rand",
1192 .type = FIO_OPT_BOOL,
1193 .off1 = td_var_offset(use_os_rand),
1194 .help = "Set to use OS random generator",
1195 .def = "0",
1196 .parent = "rw",
1197 },
214e1eca
JA
1198 {
1199 .name = "norandommap",
1200 .type = FIO_OPT_STR_SET,
1201 .off1 = td_var_offset(norandommap),
1202 .help = "Accept potential duplicate random blocks",
67a1000f 1203 .parent = "rw",
214e1eca 1204 },
2b386d25
JA
1205 {
1206 .name = "softrandommap",
1207 .type = FIO_OPT_BOOL,
1208 .off1 = td_var_offset(softrandommap),
f66ab3c8 1209 .help = "Set norandommap if randommap allocation fails",
2b386d25
JA
1210 .parent = "norandommap",
1211 .def = "0",
1212 },
214e1eca
JA
1213 {
1214 .name = "nrfiles",
d7c8be03 1215 .alias = "nr_files",
214e1eca
JA
1216 .type = FIO_OPT_INT,
1217 .off1 = td_var_offset(nr_files),
1218 .help = "Split job workload between this number of files",
1219 .def = "1",
1220 },
1221 {
1222 .name = "openfiles",
1223 .type = FIO_OPT_INT,
1224 .off1 = td_var_offset(open_files),
1225 .help = "Number of files to keep open at the same time",
1226 },
1227 {
1228 .name = "file_service_type",
1229 .type = FIO_OPT_STR,
1230 .cb = str_fst_cb,
1231 .off1 = td_var_offset(file_service_type),
1232 .help = "How to select which file to service next",
1233 .def = "roundrobin",
1234 .posval = {
1235 { .ival = "random",
1236 .oval = FIO_FSERVICE_RANDOM,
1237 .help = "Choose a file at random",
1238 },
1239 { .ival = "roundrobin",
1240 .oval = FIO_FSERVICE_RR,
1241 .help = "Round robin select files",
1242 },
a086c257
JA
1243 { .ival = "sequential",
1244 .oval = FIO_FSERVICE_SEQ,
1245 .help = "Finish one file before moving to the next",
1246 },
214e1eca 1247 },
67a1000f
JA
1248 .parent = "nrfiles",
1249 },
7bc8c2cf
JA
1250#ifdef FIO_HAVE_FALLOCATE
1251 {
1252 .name = "fallocate",
a596f047
EG
1253 .type = FIO_OPT_STR,
1254 .off1 = td_var_offset(fallocate_mode),
1255 .help = "Whether pre-allocation is performed when laying out files",
1256 .def = "posix",
1257 .posval = {
1258 { .ival = "none",
1259 .oval = FIO_FALLOCATE_NONE,
1260 .help = "Do not pre-allocate space",
1261 },
1262 { .ival = "posix",
1263 .oval = FIO_FALLOCATE_POSIX,
1264 .help = "Use posix_fallocate()",
1265 },
1266#ifdef FIO_HAVE_LINUX_FALLOCATE
1267 { .ival = "keep",
1268 .oval = FIO_FALLOCATE_KEEP_SIZE,
1269 .help = "Use fallocate(..., FALLOC_FL_KEEP_SIZE, ...)",
1270 },
7bc8c2cf 1271#endif
a596f047
EG
1272 /* Compatibility with former boolean values */
1273 { .ival = "0",
1274 .oval = FIO_FALLOCATE_NONE,
1275 .help = "Alias for 'none'",
1276 },
1277 { .ival = "1",
1278 .oval = FIO_FALLOCATE_POSIX,
1279 .help = "Alias for 'posix'",
1280 },
1281 },
1282 },
1283#endif /* FIO_HAVE_FALLOCATE */
67a1000f
JA
1284 {
1285 .name = "fadvise_hint",
1286 .type = FIO_OPT_BOOL,
1287 .off1 = td_var_offset(fadvise_hint),
1288 .help = "Use fadvise() to advise the kernel on IO pattern",
1289 .def = "1",
214e1eca
JA
1290 },
1291 {
1292 .name = "fsync",
1293 .type = FIO_OPT_INT,
1294 .off1 = td_var_offset(fsync_blocks),
1295 .help = "Issue fsync for writes every given number of blocks",
1296 .def = "0",
1297 },
5f9099ea
JA
1298 {
1299 .name = "fdatasync",
1300 .type = FIO_OPT_INT,
1301 .off1 = td_var_offset(fdatasync_blocks),
1302 .help = "Issue fdatasync for writes every given number of blocks",
1303 .def = "0",
1304 },
1ef2b6be
JA
1305 {
1306 .name = "write_barrier",
1307 .type = FIO_OPT_INT,
1308 .off1 = td_var_offset(barrier_blocks),
1309 .help = "Make every Nth write a barrier write",
1310 .def = "0",
1311 },
44f29692
JA
1312#ifdef FIO_HAVE_SYNC_FILE_RANGE
1313 {
1314 .name = "sync_file_range",
1315 .posval = {
1316 { .ival = "wait_before",
1317 .oval = SYNC_FILE_RANGE_WAIT_BEFORE,
1318 .help = "SYNC_FILE_RANGE_WAIT_BEFORE",
3843deb3 1319 .or = 1,
44f29692
JA
1320 },
1321 { .ival = "write",
1322 .oval = SYNC_FILE_RANGE_WRITE,
1323 .help = "SYNC_FILE_RANGE_WRITE",
3843deb3 1324 .or = 1,
44f29692
JA
1325 },
1326 {
1327 .ival = "wait_after",
1328 .oval = SYNC_FILE_RANGE_WAIT_AFTER,
1329 .help = "SYNC_FILE_RANGE_WAIT_AFTER",
3843deb3 1330 .or = 1,
44f29692
JA
1331 },
1332 },
3843deb3 1333 .type = FIO_OPT_STR_MULTI,
44f29692
JA
1334 .cb = str_sfr_cb,
1335 .off1 = td_var_offset(sync_file_range),
1336 .help = "Use sync_file_range()",
1337 },
1338#endif
214e1eca
JA
1339 {
1340 .name = "direct",
1341 .type = FIO_OPT_BOOL,
1342 .off1 = td_var_offset(odirect),
1343 .help = "Use O_DIRECT IO (negates buffered)",
1344 .def = "0",
1345 },
1346 {
1347 .name = "buffered",
1348 .type = FIO_OPT_BOOL,
1349 .off1 = td_var_offset(odirect),
1350 .neg = 1,
1351 .help = "Use buffered IO (negates direct)",
1352 .def = "1",
1353 },
1354 {
1355 .name = "overwrite",
1356 .type = FIO_OPT_BOOL,
1357 .off1 = td_var_offset(overwrite),
1358 .help = "When writing, set whether to overwrite current data",
1359 .def = "0",
1360 },
1361 {
1362 .name = "loops",
1363 .type = FIO_OPT_INT,
1364 .off1 = td_var_offset(loops),
1365 .help = "Number of times to run the job",
1366 .def = "1",
1367 },
1368 {
1369 .name = "numjobs",
1370 .type = FIO_OPT_INT,
1371 .off1 = td_var_offset(numjobs),
1372 .help = "Duplicate this job this many times",
1373 .def = "1",
1374 },
1375 {
1376 .name = "startdelay",
a5737c93 1377 .type = FIO_OPT_STR_VAL_TIME,
214e1eca
JA
1378 .off1 = td_var_offset(start_delay),
1379 .help = "Only start job when this period has passed",
1380 .def = "0",
1381 },
1382 {
1383 .name = "runtime",
1384 .alias = "timeout",
1385 .type = FIO_OPT_STR_VAL_TIME,
1386 .off1 = td_var_offset(timeout),
1387 .help = "Stop workload when this amount of time has passed",
1388 .def = "0",
1389 },
cf4464ca
JA
1390 {
1391 .name = "time_based",
1392 .type = FIO_OPT_STR_SET,
1393 .off1 = td_var_offset(time_based),
1394 .help = "Keep running until runtime/timeout is met",
1395 },
721938ae
JA
1396 {
1397 .name = "ramp_time",
1398 .type = FIO_OPT_STR_VAL_TIME,
1399 .off1 = td_var_offset(ramp_time),
1400 .help = "Ramp up time before measuring performance",
1401 },
c223da83
JA
1402 {
1403 .name = "clocksource",
1404 .type = FIO_OPT_STR,
1405 .cb = fio_clock_source_cb,
1406 .off1 = td_var_offset(clocksource),
1407 .help = "What type of timing source to use",
c223da83
JA
1408 .posval = {
1409 { .ival = "gettimeofday",
1410 .oval = CS_GTOD,
1411 .help = "Use gettimeofday(2) for timing",
1412 },
1413 { .ival = "clock_gettime",
1414 .oval = CS_CGETTIME,
1415 .help = "Use clock_gettime(2) for timing",
1416 },
1417#ifdef ARCH_HAVE_CPU_CLOCK
1418 { .ival = "cpu",
1419 .oval = CS_CPUCLOCK,
1420 .help = "Use CPU private clock",
1421 },
1422#endif
1423 },
1424 },
214e1eca
JA
1425 {
1426 .name = "mem",
d3aad8f2 1427 .alias = "iomem",
214e1eca
JA
1428 .type = FIO_OPT_STR,
1429 .cb = str_mem_cb,
1430 .off1 = td_var_offset(mem_type),
1431 .help = "Backing type for IO buffers",
1432 .def = "malloc",
1433 .posval = {
1434 { .ival = "malloc",
1435 .oval = MEM_MALLOC,
1436 .help = "Use malloc(3) for IO buffers",
1437 },
37c8cdfe
JA
1438 { .ival = "shm",
1439 .oval = MEM_SHM,
1440 .help = "Use shared memory segments for IO buffers",
1441 },
214e1eca
JA
1442#ifdef FIO_HAVE_HUGETLB
1443 { .ival = "shmhuge",
1444 .oval = MEM_SHMHUGE,
1445 .help = "Like shm, but use huge pages",
1446 },
b370e46a 1447#endif
37c8cdfe
JA
1448 { .ival = "mmap",
1449 .oval = MEM_MMAP,
1450 .help = "Use mmap(2) (file or anon) for IO buffers",
1451 },
214e1eca
JA
1452#ifdef FIO_HAVE_HUGETLB
1453 { .ival = "mmaphuge",
1454 .oval = MEM_MMAPHUGE,
1455 .help = "Like mmap, but use huge pages",
1456 },
1457#endif
1458 },
1459 },
d529ee19
JA
1460 {
1461 .name = "iomem_align",
1462 .alias = "mem_align",
1463 .type = FIO_OPT_INT,
1464 .off1 = td_var_offset(mem_align),
1465 .minval = 0,
1466 .help = "IO memory buffer offset alignment",
1467 .def = "0",
1468 .parent = "iomem",
1469 },
214e1eca
JA
1470 {
1471 .name = "verify",
1472 .type = FIO_OPT_STR,
1473 .off1 = td_var_offset(verify),
1474 .help = "Verify data written",
5d7c5d34 1475 .cb = str_verify_cb,
214e1eca
JA
1476 .def = "0",
1477 .posval = {
1478 { .ival = "0",
1479 .oval = VERIFY_NONE,
1480 .help = "Don't do IO verification",
1481 },
fcca4b58
JA
1482 { .ival = "md5",
1483 .oval = VERIFY_MD5,
1484 .help = "Use md5 checksums for verification",
1485 },
d77a7af3
JA
1486 { .ival = "crc64",
1487 .oval = VERIFY_CRC64,
1488 .help = "Use crc64 checksums for verification",
1489 },
214e1eca
JA
1490 { .ival = "crc32",
1491 .oval = VERIFY_CRC32,
1492 .help = "Use crc32 checksums for verification",
1493 },
af497e6a
JA
1494 { .ival = "crc32c-intel",
1495 .oval = VERIFY_CRC32C_INTEL,
1496 .help = "Use hw crc32c checksums for verification",
1497 },
bac39e0e
JA
1498 { .ival = "crc32c",
1499 .oval = VERIFY_CRC32C,
1500 .help = "Use crc32c checksums for verification",
1501 },
969f7ed3
JA
1502 { .ival = "crc16",
1503 .oval = VERIFY_CRC16,
1504 .help = "Use crc16 checksums for verification",
1505 },
1e154bdb
JA
1506 { .ival = "crc7",
1507 .oval = VERIFY_CRC7,
1508 .help = "Use crc7 checksums for verification",
1509 },
7c353ceb
JA
1510 { .ival = "sha1",
1511 .oval = VERIFY_SHA1,
1512 .help = "Use sha1 checksums for verification",
1513 },
cd14cc10
JA
1514 { .ival = "sha256",
1515 .oval = VERIFY_SHA256,
1516 .help = "Use sha256 checksums for verification",
1517 },
1518 { .ival = "sha512",
1519 .oval = VERIFY_SHA512,
1520 .help = "Use sha512 checksums for verification",
1521 },
7437ee87
SL
1522 { .ival = "meta",
1523 .oval = VERIFY_META,
1524 .help = "Use io information",
1525 },
36690c9b
JA
1526 {
1527 .ival = "null",
1528 .oval = VERIFY_NULL,
1529 .help = "Pretend to verify",
1530 },
214e1eca
JA
1531 },
1532 },
005c565a
JA
1533 {
1534 .name = "do_verify",
68e1f29a 1535 .type = FIO_OPT_BOOL,
005c565a
JA
1536 .off1 = td_var_offset(do_verify),
1537 .help = "Run verification stage after write",
1538 .def = "1",
1539 .parent = "verify",
1540 },
160b966d
JA
1541 {
1542 .name = "verifysort",
1543 .type = FIO_OPT_BOOL,
1544 .off1 = td_var_offset(verifysort),
1545 .help = "Sort written verify blocks for read back",
1546 .def = "1",
c83f2df1 1547 .parent = "verify",
160b966d 1548 },
3f9f4e26 1549 {
a59e170d 1550 .name = "verify_interval",
e01b22b8 1551 .type = FIO_OPT_INT,
a59e170d 1552 .off1 = td_var_offset(verify_interval),
819a9680 1553 .minval = 2 * sizeof(struct verify_header),
a59e170d 1554 .help = "Store verify buffer header every N bytes",
afdf9352 1555 .parent = "verify",
3f9f4e26 1556 },
546a9142 1557 {
a59e170d 1558 .name = "verify_offset",
e01b22b8 1559 .type = FIO_OPT_INT,
a59e170d 1560 .help = "Offset verify header location by N bytes",
546a9142 1561 .def = "0",
5ec10eaa 1562 .cb = str_verify_offset_cb,
afdf9352 1563 .parent = "verify",
546a9142 1564 },
e28218f3
SL
1565 {
1566 .name = "verify_pattern",
0e92f873 1567 .type = FIO_OPT_STR,
e28218f3
SL
1568 .cb = str_verify_pattern_cb,
1569 .help = "Fill pattern for IO buffers",
1570 .parent = "verify",
1571 },
a12a3b4d
JA
1572 {
1573 .name = "verify_fatal",
68e1f29a 1574 .type = FIO_OPT_BOOL,
a12a3b4d
JA
1575 .off1 = td_var_offset(verify_fatal),
1576 .def = "0",
1577 .help = "Exit on a single verify failure, don't continue",
1578 .parent = "verify",
1579 },
b463e936
JA
1580 {
1581 .name = "verify_dump",
1582 .type = FIO_OPT_BOOL,
1583 .off1 = td_var_offset(verify_dump),
1584 .def = "1",
1585 .help = "Dump contents of good and bad blocks on failure",
1586 .parent = "verify",
1587 },
e8462bd8
JA
1588 {
1589 .name = "verify_async",
1590 .type = FIO_OPT_INT,
1591 .off1 = td_var_offset(verify_async),
1592 .def = "0",
1593 .help = "Number of async verifier threads to use",
1594 .parent = "verify",
1595 },
9e144189
JA
1596 {
1597 .name = "verify_backlog",
1598 .type = FIO_OPT_STR_VAL,
1599 .off1 = td_var_offset(verify_backlog),
1600 .help = "Verify after this number of blocks are written",
1601 .parent = "verify",
1602 },
1603 {
1604 .name = "verify_backlog_batch",
1605 .type = FIO_OPT_INT,
1606 .off1 = td_var_offset(verify_batch),
1607 .help = "Verify this number of IO blocks",
0d29de83 1608 .parent = "verify",
9e144189 1609 },
e8462bd8
JA
1610#ifdef FIO_HAVE_CPU_AFFINITY
1611 {
1612 .name = "verify_async_cpus",
1613 .type = FIO_OPT_STR,
1614 .cb = str_verify_cpus_allowed_cb,
1615 .help = "Set CPUs allowed for async verify threads",
1616 .parent = "verify_async",
1617 },
0d29de83
JA
1618#endif
1619#ifdef FIO_HAVE_TRIM
1620 {
1621 .name = "trim_percentage",
1622 .type = FIO_OPT_INT,
1623 .cb = str_verify_trim_cb,
1624 .maxval = 100,
1625 .help = "Number of verify blocks to discard/trim",
1626 .parent = "verify",
1627 .def = "0",
1628 },
1629 {
1630 .name = "trim_verify_zero",
1631 .type = FIO_OPT_INT,
1632 .help = "Verify that trim/discarded blocks are returned as zeroes",
1633 .off1 = td_var_offset(trim_zero),
1634 .parent = "trim_percentage",
1635 .def = "1",
1636 },
1637 {
1638 .name = "trim_backlog",
1639 .type = FIO_OPT_STR_VAL,
1640 .off1 = td_var_offset(trim_backlog),
1641 .help = "Trim after this number of blocks are written",
1642 .parent = "trim_percentage",
1643 },
1644 {
1645 .name = "trim_backlog_batch",
1646 .type = FIO_OPT_INT,
1647 .off1 = td_var_offset(trim_batch),
1648 .help = "Trim this number of IO blocks",
1649 .parent = "trim_percentage",
1650 },
e8462bd8 1651#endif
214e1eca
JA
1652 {
1653 .name = "write_iolog",
1654 .type = FIO_OPT_STR_STORE,
1655 .off1 = td_var_offset(write_iolog_file),
1656 .help = "Store IO pattern to file",
1657 },
1658 {
1659 .name = "read_iolog",
1660 .type = FIO_OPT_STR_STORE,
1661 .off1 = td_var_offset(read_iolog_file),
1662 .help = "Playback IO pattern from file",
1663 },
64bbb865
DN
1664 {
1665 .name = "replay_no_stall",
1666 .type = FIO_OPT_INT,
1667 .off1 = td_var_offset(no_stall),
1668 .def = "0",
87e7a972 1669 .parent = "read_iolog",
64bbb865
DN
1670 .help = "Playback IO pattern file as fast as possible without stalls",
1671 },
d1c46c04
DN
1672 {
1673 .name = "replay_redirect",
1674 .type = FIO_OPT_STR_STORE,
1675 .off1 = td_var_offset(replay_redirect),
1676 .parent = "read_iolog",
1677 .help = "Replay all I/O onto this device, regardless of trace device",
1678 },
214e1eca
JA
1679 {
1680 .name = "exec_prerun",
1681 .type = FIO_OPT_STR_STORE,
1682 .off1 = td_var_offset(exec_prerun),
1683 .help = "Execute this file prior to running job",
1684 },
1685 {
1686 .name = "exec_postrun",
1687 .type = FIO_OPT_STR_STORE,
1688 .off1 = td_var_offset(exec_postrun),
1689 .help = "Execute this file after running job",
1690 },
1691#ifdef FIO_HAVE_IOSCHED_SWITCH
1692 {
1693 .name = "ioscheduler",
1694 .type = FIO_OPT_STR_STORE,
1695 .off1 = td_var_offset(ioscheduler),
1696 .help = "Use this IO scheduler on the backing device",
1697 },
1698#endif
1699 {
1700 .name = "zonesize",
1701 .type = FIO_OPT_STR_VAL,
1702 .off1 = td_var_offset(zone_size),
1703 .help = "Give size of an IO zone",
1704 .def = "0",
1705 },
1706 {
1707 .name = "zoneskip",
1708 .type = FIO_OPT_STR_VAL,
1709 .off1 = td_var_offset(zone_skip),
1710 .help = "Space between IO zones",
1711 .def = "0",
1712 },
1713 {
1714 .name = "lockmem",
1715 .type = FIO_OPT_STR_VAL,
1716 .cb = str_lockmem_cb,
1717 .help = "Lock down this amount of memory",
1718 .def = "0",
1719 },
214e1eca
JA
1720 {
1721 .name = "rwmixread",
1722 .type = FIO_OPT_INT,
cb499fc4 1723 .cb = str_rwmix_read_cb,
214e1eca
JA
1724 .maxval = 100,
1725 .help = "Percentage of mixed workload that is reads",
1726 .def = "50",
1727 },
1728 {
1729 .name = "rwmixwrite",
1730 .type = FIO_OPT_INT,
cb499fc4 1731 .cb = str_rwmix_write_cb,
214e1eca
JA
1732 .maxval = 100,
1733 .help = "Percentage of mixed workload that is writes",
1734 .def = "50",
1735 },
afdf9352
JA
1736 {
1737 .name = "rwmixcycle",
15ca150e 1738 .type = FIO_OPT_DEPRECATED,
afdf9352 1739 },
214e1eca
JA
1740 {
1741 .name = "nice",
1742 .type = FIO_OPT_INT,
1743 .off1 = td_var_offset(nice),
1744 .help = "Set job CPU nice value",
1745 .minval = -19,
1746 .maxval = 20,
1747 .def = "0",
1748 },
1749#ifdef FIO_HAVE_IOPRIO
1750 {
1751 .name = "prio",
1752 .type = FIO_OPT_INT,
1753 .cb = str_prio_cb,
1754 .help = "Set job IO priority value",
1755 .minval = 0,
1756 .maxval = 7,
1757 },
1758 {
1759 .name = "prioclass",
1760 .type = FIO_OPT_INT,
1761 .cb = str_prioclass_cb,
1762 .help = "Set job IO priority class",
1763 .minval = 0,
1764 .maxval = 3,
1765 },
1766#endif
1767 {
1768 .name = "thinktime",
1769 .type = FIO_OPT_INT,
1770 .off1 = td_var_offset(thinktime),
1771 .help = "Idle time between IO buffers (usec)",
1772 .def = "0",
1773 },
1774 {
1775 .name = "thinktime_spin",
1776 .type = FIO_OPT_INT,
1777 .off1 = td_var_offset(thinktime_spin),
1778 .help = "Start think time by spinning this amount (usec)",
1779 .def = "0",
afdf9352 1780 .parent = "thinktime",
214e1eca
JA
1781 },
1782 {
1783 .name = "thinktime_blocks",
1784 .type = FIO_OPT_INT,
1785 .off1 = td_var_offset(thinktime_blocks),
1786 .help = "IO buffer period between 'thinktime'",
1787 .def = "1",
afdf9352 1788 .parent = "thinktime",
214e1eca
JA
1789 },
1790 {
1791 .name = "rate",
e01b22b8 1792 .type = FIO_OPT_INT,
581e7141
JA
1793 .off1 = td_var_offset(rate[0]),
1794 .off2 = td_var_offset(rate[1]),
214e1eca
JA
1795 .help = "Set bandwidth rate",
1796 },
1797 {
1798 .name = "ratemin",
e01b22b8 1799 .type = FIO_OPT_INT,
581e7141
JA
1800 .off1 = td_var_offset(ratemin[0]),
1801 .off2 = td_var_offset(ratemin[1]),
4e991c23 1802 .help = "Job must meet this rate or it will be shutdown",
afdf9352 1803 .parent = "rate",
4e991c23
JA
1804 },
1805 {
1806 .name = "rate_iops",
e01b22b8 1807 .type = FIO_OPT_INT,
581e7141
JA
1808 .off1 = td_var_offset(rate_iops[0]),
1809 .off2 = td_var_offset(rate_iops[1]),
4e991c23
JA
1810 .help = "Limit IO used to this number of IO operations/sec",
1811 },
1812 {
1813 .name = "rate_iops_min",
e01b22b8 1814 .type = FIO_OPT_INT,
581e7141
JA
1815 .off1 = td_var_offset(rate_iops_min[0]),
1816 .off2 = td_var_offset(rate_iops_min[1]),
03e20d68 1817 .help = "Job must meet this rate or it will be shut down",
afdf9352 1818 .parent = "rate_iops",
214e1eca
JA
1819 },
1820 {
1821 .name = "ratecycle",
1822 .type = FIO_OPT_INT,
1823 .off1 = td_var_offset(ratecycle),
1824 .help = "Window average for rate limits (msec)",
1825 .def = "1000",
afdf9352 1826 .parent = "rate",
214e1eca
JA
1827 },
1828 {
1829 .name = "invalidate",
1830 .type = FIO_OPT_BOOL,
1831 .off1 = td_var_offset(invalidate_cache),
1832 .help = "Invalidate buffer/page cache prior to running job",
1833 .def = "1",
1834 },
1835 {
1836 .name = "sync",
1837 .type = FIO_OPT_BOOL,
1838 .off1 = td_var_offset(sync_io),
1839 .help = "Use O_SYNC for buffered writes",
1840 .def = "0",
67a1000f 1841 .parent = "buffered",
214e1eca
JA
1842 },
1843 {
1844 .name = "bwavgtime",
1845 .type = FIO_OPT_INT,
1846 .off1 = td_var_offset(bw_avg_time),
5ec10eaa
JA
1847 .help = "Time window over which to calculate bandwidth"
1848 " (msec)",
214e1eca 1849 .def = "500",
c8eeb9df
JA
1850 .parent = "write_bw_log",
1851 },
1852 {
1853 .name = "iopsavgtime",
1854 .type = FIO_OPT_INT,
1855 .off1 = td_var_offset(iops_avg_time),
1856 .help = "Time window over which to calculate IOPS (msec)",
1857 .def = "500",
1858 .parent = "write_iops_log",
214e1eca
JA
1859 },
1860 {
1861 .name = "create_serialize",
1862 .type = FIO_OPT_BOOL,
1863 .off1 = td_var_offset(create_serialize),
1864 .help = "Serialize creating of job files",
1865 .def = "1",
1866 },
1867 {
1868 .name = "create_fsync",
1869 .type = FIO_OPT_BOOL,
1870 .off1 = td_var_offset(create_fsync),
03e20d68 1871 .help = "fsync file after creation",
214e1eca
JA
1872 .def = "1",
1873 },
814452bd
JA
1874 {
1875 .name = "create_on_open",
1876 .type = FIO_OPT_BOOL,
1877 .off1 = td_var_offset(create_on_open),
1878 .help = "Create files when they are opened for IO",
1879 .def = "0",
1880 },
0b9d69ec 1881 {
afad68f7
ZY
1882 .name = "pre_read",
1883 .type = FIO_OPT_BOOL,
1884 .off1 = td_var_offset(pre_read),
03e20d68 1885 .help = "Pre-read files before starting official testing",
afad68f7
ZY
1886 .def = "0",
1887 },
214e1eca
JA
1888 {
1889 .name = "cpuload",
1890 .type = FIO_OPT_INT,
1891 .off1 = td_var_offset(cpuload),
1892 .help = "Use this percentage of CPU",
1893 },
1894 {
1895 .name = "cpuchunks",
1896 .type = FIO_OPT_INT,
1897 .off1 = td_var_offset(cpucycle),
1898 .help = "Length of the CPU burn cycles (usecs)",
1899 .def = "50000",
67a1000f 1900 .parent = "cpuload",
214e1eca
JA
1901 },
1902#ifdef FIO_HAVE_CPU_AFFINITY
1903 {
1904 .name = "cpumask",
1905 .type = FIO_OPT_INT,
1906 .cb = str_cpumask_cb,
1907 .help = "CPU affinity mask",
1908 },
d2e268b0
JA
1909 {
1910 .name = "cpus_allowed",
1911 .type = FIO_OPT_STR,
1912 .cb = str_cpus_allowed_cb,
1913 .help = "Set CPUs allowed",
1914 },
214e1eca
JA
1915#endif
1916 {
1917 .name = "end_fsync",
1918 .type = FIO_OPT_BOOL,
1919 .off1 = td_var_offset(end_fsync),
1920 .help = "Include fsync at the end of job",
1921 .def = "0",
1922 },
1923 {
1924 .name = "fsync_on_close",
1925 .type = FIO_OPT_BOOL,
1926 .off1 = td_var_offset(fsync_on_close),
1927 .help = "fsync files on close",
1928 .def = "0",
1929 },
1930 {
1931 .name = "unlink",
1932 .type = FIO_OPT_BOOL,
1933 .off1 = td_var_offset(unlink),
1934 .help = "Unlink created files after job has completed",
1935 .def = "0",
1936 },
1937 {
1938 .name = "exitall",
1939 .type = FIO_OPT_STR_SET,
1940 .cb = str_exitall_cb,
1941 .help = "Terminate all jobs when one exits",
1942 },
1943 {
1944 .name = "stonewall",
d392365e 1945 .alias = "wait_for_previous",
214e1eca
JA
1946 .type = FIO_OPT_STR_SET,
1947 .off1 = td_var_offset(stonewall),
1948 .help = "Insert a hard barrier between this job and previous",
1949 },
b3d62a75
JA
1950 {
1951 .name = "new_group",
1952 .type = FIO_OPT_STR_SET,
1953 .off1 = td_var_offset(new_group),
1954 .help = "Mark the start of a new group (for reporting)",
1955 },
214e1eca
JA
1956 {
1957 .name = "thread",
1958 .type = FIO_OPT_STR_SET,
1959 .off1 = td_var_offset(use_thread),
1960 .help = "Use threads instead of forks",
1961 },
1962 {
1963 .name = "write_bw_log",
e3cedca7 1964 .type = FIO_OPT_STR,
214e1eca 1965 .off1 = td_var_offset(write_bw_log),
e3cedca7 1966 .cb = str_write_bw_log_cb,
214e1eca
JA
1967 .help = "Write log of bandwidth during run",
1968 },
1969 {
1970 .name = "write_lat_log",
e3cedca7 1971 .type = FIO_OPT_STR,
214e1eca 1972 .off1 = td_var_offset(write_lat_log),
e3cedca7 1973 .cb = str_write_lat_log_cb,
214e1eca
JA
1974 .help = "Write log of latency during run",
1975 },
c8eeb9df
JA
1976 {
1977 .name = "write_iops_log",
1978 .type = FIO_OPT_STR,
1979 .off1 = td_var_offset(write_iops_log),
1980 .cb = str_write_iops_log_cb,
1981 .help = "Write log of IOPS during run",
1982 },
214e1eca
JA
1983 {
1984 .name = "hugepage-size",
e01b22b8 1985 .type = FIO_OPT_INT,
214e1eca
JA
1986 .off1 = td_var_offset(hugepage_size),
1987 .help = "When using hugepages, specify size of each page",
81179eec 1988 .def = __fio_stringify(FIO_HUGE_PAGE),
214e1eca
JA
1989 },
1990 {
1991 .name = "group_reporting",
1992 .type = FIO_OPT_STR_SET,
1993 .off1 = td_var_offset(group_reporting),
1994 .help = "Do reporting on a per-group basis",
1995 },
e9459e5a
JA
1996 {
1997 .name = "zero_buffers",
1998 .type = FIO_OPT_STR_SET,
1999 .off1 = td_var_offset(zero_buffers),
2000 .help = "Init IO buffers to all zeroes",
2001 },
5973cafb
JA
2002 {
2003 .name = "refill_buffers",
2004 .type = FIO_OPT_STR_SET,
2005 .off1 = td_var_offset(refill_buffers),
2006 .help = "Refill IO buffers on every IO submit",
2007 },
fd68418e
JA
2008 {
2009 .name = "scramble_buffers",
2010 .type = FIO_OPT_BOOL,
2011 .off1 = td_var_offset(scramble_buffers),
2012 .help = "Slightly scramble buffers on every IO submit",
2013 .def = "1",
2014 },
83349190
YH
2015 {
2016 .name = "clat_percentiles",
2017 .type = FIO_OPT_BOOL,
2018 .off1 = td_var_offset(clat_percentiles),
2019 .help = "Enable the reporting of completion latency percentiles",
467b35ed 2020 .def = "1",
83349190
YH
2021 },
2022 {
2023 .name = "percentile_list",
2024 .type = FIO_OPT_FLOAT_LIST,
2025 .off1 = td_var_offset(percentile_list),
2026 .off2 = td_var_offset(overwrite_plist),
2027 .help = "Specify a custom list of percentiles to report",
2028 .maxlen = FIO_IO_U_LIST_MAX_LEN,
2029 .minfp = 0.0,
2030 .maxfp = 100.0,
2031 },
2032
0a839f30
JA
2033#ifdef FIO_HAVE_DISK_UTIL
2034 {
2035 .name = "disk_util",
2036 .type = FIO_OPT_BOOL,
2037 .off1 = td_var_offset(do_disk_util),
f66ab3c8 2038 .help = "Log disk utilization statistics",
0a839f30
JA
2039 .def = "1",
2040 },
2041#endif
993bf48b
JA
2042 {
2043 .name = "gtod_reduce",
2044 .type = FIO_OPT_BOOL,
2045 .help = "Greatly reduce number of gettimeofday() calls",
2046 .cb = str_gtod_reduce_cb,
2047 .def = "0",
2048 },
02af0988
JA
2049 {
2050 .name = "disable_lat",
2051 .type = FIO_OPT_BOOL,
2052 .off1 = td_var_offset(disable_lat),
2053 .help = "Disable latency numbers",
2054 .parent = "gtod_reduce",
2055 .def = "0",
2056 },
9520ebb9
JA
2057 {
2058 .name = "disable_clat",
2059 .type = FIO_OPT_BOOL,
2060 .off1 = td_var_offset(disable_clat),
2061 .help = "Disable completion latency numbers",
993bf48b 2062 .parent = "gtod_reduce",
9520ebb9
JA
2063 .def = "0",
2064 },
2065 {
2066 .name = "disable_slat",
2067 .type = FIO_OPT_BOOL,
2068 .off1 = td_var_offset(disable_slat),
03e20d68 2069 .help = "Disable submission latency numbers",
993bf48b 2070 .parent = "gtod_reduce",
9520ebb9
JA
2071 .def = "0",
2072 },
2073 {
2074 .name = "disable_bw_measurement",
2075 .type = FIO_OPT_BOOL,
2076 .off1 = td_var_offset(disable_bw),
2077 .help = "Disable bandwidth logging",
993bf48b 2078 .parent = "gtod_reduce",
9520ebb9
JA
2079 .def = "0",
2080 },
be4ecfdf
JA
2081 {
2082 .name = "gtod_cpu",
2083 .type = FIO_OPT_INT,
2084 .cb = str_gtod_cpu_cb,
03e20d68 2085 .help = "Set up dedicated gettimeofday() thread on this CPU",
29d43ff9 2086 .verify = gtod_cpu_verify,
be4ecfdf 2087 },
f2bba182
RR
2088 {
2089 .name = "continue_on_error",
2090 .type = FIO_OPT_BOOL,
2091 .off1 = td_var_offset(continue_on_error),
03e20d68 2092 .help = "Continue on non-fatal errors during IO",
f2bba182
RR
2093 .def = "0",
2094 },
9ac8a797
JA
2095 {
2096 .name = "profile",
79d16311 2097 .type = FIO_OPT_STR_STORE,
9ac8a797 2098 .off1 = td_var_offset(profile),
9ac8a797
JA
2099 .help = "Select a specific builtin performance test",
2100 },
a696fa2a
JA
2101 {
2102 .name = "cgroup",
2103 .type = FIO_OPT_STR_STORE,
2104 .off1 = td_var_offset(cgroup),
2105 .help = "Add job to cgroup of this name",
2106 },
2107 {
2108 .name = "cgroup_weight",
2109 .type = FIO_OPT_INT,
2110 .off1 = td_var_offset(cgroup_weight),
2111 .help = "Use given weight for cgroup",
2112 .minval = 100,
2113 .maxval = 1000,
a696fa2a 2114 },
7de87099
VG
2115 {
2116 .name = "cgroup_nodelete",
2117 .type = FIO_OPT_BOOL,
2118 .off1 = td_var_offset(cgroup_nodelete),
2119 .help = "Do not delete cgroups after job completion",
2120 .def = "0",
2121 },
e0b0d892
JA
2122 {
2123 .name = "uid",
2124 .type = FIO_OPT_INT,
2125 .off1 = td_var_offset(uid),
2126 .help = "Run job with this user ID",
2127 },
2128 {
2129 .name = "gid",
2130 .type = FIO_OPT_INT,
2131 .off1 = td_var_offset(gid),
2132 .help = "Run job with this group ID",
2133 },
214e1eca
JA
2134 {
2135 .name = NULL,
2136 },
2137};
2138
17af15d4
JA
2139static void add_to_lopt(struct option *lopt, struct fio_option *o,
2140 const char *name)
9f81736c 2141{
17af15d4 2142 lopt->name = (char *) name;
9f81736c
JA
2143 lopt->val = FIO_GETOPT_JOB;
2144 if (o->type == FIO_OPT_STR_SET)
2145 lopt->has_arg = no_argument;
2146 else
2147 lopt->has_arg = required_argument;
2148}
2149
214e1eca
JA
2150void fio_options_dup_and_init(struct option *long_options)
2151{
2152 struct fio_option *o;
2153 unsigned int i;
2154
2155 options_init(options);
2156
2157 i = 0;
2158 while (long_options[i].name)
2159 i++;
2160
2161 o = &options[0];
2162 while (o->name) {
17af15d4
JA
2163 add_to_lopt(&long_options[i], o, o->name);
2164 if (o->alias) {
2165 i++;
2166 add_to_lopt(&long_options[i], o, o->alias);
2167 }
214e1eca
JA
2168
2169 i++;
2170 o++;
2171 assert(i < FIO_NR_OPTIONS);
2172 }
2173}
2174
74929ac2
JA
2175struct fio_keyword {
2176 const char *word;
2177 const char *desc;
2178 char *replace;
2179};
2180
2181static struct fio_keyword fio_keywords[] = {
2182 {
2183 .word = "$pagesize",
2184 .desc = "Page size in the system",
2185 },
2186 {
2187 .word = "$mb_memory",
2188 .desc = "Megabytes of memory online",
2189 },
2190 {
2191 .word = "$ncpus",
2192 .desc = "Number of CPUs online in the system",
2193 },
2194 {
2195 .word = NULL,
2196 },
2197};
2198
2199void fio_keywords_init(void)
2200{
3b2e1464 2201 unsigned long long mb_memory;
74929ac2
JA
2202 char buf[128];
2203 long l;
2204
2205 sprintf(buf, "%lu", page_size);
2206 fio_keywords[0].replace = strdup(buf);
2207
8eb016d3 2208 mb_memory = os_phys_mem() / (1024 * 1024);
3b2e1464 2209 sprintf(buf, "%llu", mb_memory);
74929ac2
JA
2210 fio_keywords[1].replace = strdup(buf);
2211
c00a2289 2212 l = cpus_online();
74929ac2
JA
2213 sprintf(buf, "%lu", l);
2214 fio_keywords[2].replace = strdup(buf);
2215}
2216
892a6ffc
JA
2217#define BC_APP "bc"
2218
2219static char *bc_calc(char *str)
2220{
2221 char *buf, *tmp, opt[80];
2222 FILE *f;
2223 int ret;
2224
2225 /*
2226 * No math, just return string
2227 */
2228 if (!strchr(str, '+') && !strchr(str, '-') && !strchr(str, '*') &&
2229 !strchr(str, '/'))
2230 return str;
2231
2232 /*
2233 * Split option from value, we only need to calculate the value
2234 */
2235 tmp = strchr(str, '=');
2236 if (!tmp)
2237 return str;
2238
2239 tmp++;
9ac8a797 2240 memset(opt, 0, sizeof(opt));
892a6ffc
JA
2241 strncpy(opt, str, tmp - str);
2242
2243 buf = malloc(128);
2244
2245 sprintf(buf, "which %s > /dev/null", BC_APP);
2246 if (system(buf)) {
2247 log_err("fio: bc is needed for performing math\n");
2248 free(buf);
2249 return NULL;
2250 }
2251
2252 sprintf(buf, "echo %s | %s", tmp, BC_APP);
2253 f = popen(buf, "r");
2254 if (!f) {
2255 free(buf);
2256 return NULL;
2257 }
2258
2259 ret = fread(buf, 1, 128, f);
2260 if (ret <= 0) {
2261 free(buf);
2262 return NULL;
2263 }
2264
2265 buf[ret - 1] = '\0';
2266 strcat(opt, buf);
2267 strcpy(buf, opt);
2268 pclose(f);
2269 free(str);
2270 return buf;
2271}
2272
74929ac2
JA
2273/*
2274 * Look for reserved variable names and replace them with real values
2275 */
2276static char *fio_keyword_replace(char *opt)
2277{
2278 char *s;
2279 int i;
2280
2281 for (i = 0; fio_keywords[i].word != NULL; i++) {
2282 struct fio_keyword *kw = &fio_keywords[i];
2283
2284 while ((s = strstr(opt, kw->word)) != NULL) {
2285 char *new = malloc(strlen(opt) + 1);
2286 char *o_org = opt;
2287 int olen = s - opt;
2288 int len;
2289
2290 /*
2291 * Copy part of the string before the keyword and
2292 * sprintf() the replacement after it.
2293 */
2294 memcpy(new, opt, olen);
2295 len = sprintf(new + olen, "%s", kw->replace);
2296
2297 /*
2298 * If there's more in the original string, copy that
2299 * in too
2300 */
2301 opt += strlen(kw->word) + olen;
2302 if (strlen(opt))
2303 memcpy(new + olen + len, opt, opt - o_org - 1);
2304
2305 /*
2306 * replace opt and free the old opt
2307 */
2308 opt = new;
9ac8a797 2309 //free(o_org);
7a958bd5
JA
2310
2311 /*
2312 * Check for potential math and invoke bc, if possible
2313 */
2314 opt = bc_calc(opt);
74929ac2
JA
2315 }
2316 }
2317
7a958bd5 2318 return opt;
74929ac2
JA
2319}
2320
3b8b7135 2321int fio_options_parse(struct thread_data *td, char **opts, int num_opts)
214e1eca 2322{
3b8b7135
JA
2323 int i, ret;
2324
2325 sort_options(opts, options, num_opts);
2326
74929ac2
JA
2327 for (ret = 0, i = 0; i < num_opts; i++) {
2328 opts[i] = fio_keyword_replace(opts[i]);
07b3232d 2329 ret |= parse_option(opts[i], options, td);
74929ac2 2330 }
3b8b7135
JA
2331
2332 return ret;
214e1eca
JA
2333}
2334
2335int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
2336{
07b3232d 2337 return parse_cmd_option(opt, val, options, td);
214e1eca
JA
2338}
2339
2340void fio_fill_default_options(struct thread_data *td)
2341{
2342 fill_default_options(td, options);
2343}
2344
2345int fio_show_option_help(const char *opt)
2346{
07b3232d 2347 return show_cmd_help(options, opt);
214e1eca 2348}
d23bb327 2349
7e356b2d
JA
2350/*
2351 * dupe FIO_OPT_STR_STORE options
2352 */
2353void options_mem_dupe(struct thread_data *td)
d23bb327
JA
2354{
2355 struct thread_options *o = &td->o;
2356 struct fio_option *opt;
2357 char **ptr;
2358 int i;
2359
2360 for (i = 0, opt = &options[0]; opt->name; i++, opt = &options[i]) {
2361 if (opt->type != FIO_OPT_STR_STORE)
2362 continue;
2363
2364 ptr = (void *) o + opt->off1;
7e356b2d
JA
2365 if (!*ptr)
2366 ptr = td_var(o, opt->off1);
2367 if (*ptr)
2368 *ptr = strdup(*ptr);
d23bb327
JA
2369 }
2370}
2371
d6978a32
JA
2372unsigned int fio_get_kb_base(void *data)
2373{
2374 struct thread_data *td = data;
2375 unsigned int kb_base = 0;
2376
2377 if (td)
2378 kb_base = td->o.kb_base;
2379 if (!kb_base)
2380 kb_base = 1024;
2381
2382 return kb_base;
2383}
9f988e2e 2384
07b3232d 2385int add_option(struct fio_option *o)
9f988e2e 2386{
07b3232d
JA
2387 struct fio_option *__o;
2388 int opt_index = 0;
2389
2390 __o = options;
2391 while (__o->name) {
2392 opt_index++;
2393 __o++;
2394 }
2395
2396 memcpy(&options[opt_index], o, sizeof(*o));
2397 return 0;
9f988e2e 2398}
e2de69da 2399
07b3232d 2400void invalidate_profile_options(const char *prof_name)
e2de69da 2401{
07b3232d 2402 struct fio_option *o;
e2de69da 2403
07b3232d
JA
2404 o = options;
2405 while (o->name) {
2406 if (o->prof_name && !strcmp(o->prof_name, prof_name)) {
2407 o->type = FIO_OPT_INVALID;
2408 o->prof_name = NULL;
2409 }
2410 o++;
e2de69da
JA
2411 }
2412}
f5b6bb85
JA
2413
2414void add_opt_posval(const char *optname, const char *ival, const char *help)
2415{
2416 struct fio_option *o;
2417 unsigned int i;
2418
2419 o = find_option(options, optname);
2420 if (!o)
2421 return;
2422
2423 for (i = 0; i < PARSE_MAX_VP; i++) {
2424 if (o->posval[i].ival)
2425 continue;
2426
2427 o->posval[i].ival = ival;
2428 o->posval[i].help = help;
2429 break;
2430 }
2431}
2432
2433void del_opt_posval(const char *optname, const char *ival)
2434{
2435 struct fio_option *o;
2436 unsigned int i;
2437
2438 o = find_option(options, optname);
2439 if (!o)
2440 return;
2441
2442 for (i = 0; i < PARSE_MAX_VP; i++) {
2443 if (!o->posval[i].ival)
2444 continue;
2445 if (strcmp(o->posval[i].ival, ival))
2446 continue;
2447
2448 o->posval[i].ival = NULL;
2449 o->posval[i].help = NULL;
2450 }
2451}
7e356b2d
JA
2452
2453void fio_options_free(struct thread_data *td)
2454{
2455 options_free(options, td);
2456}