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