eta: fix bugs withe fill_device and exitall_on_terminate
[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 "parse.h"
15 #include "lib/fls.h"
16
17 #define td_var_offset(var)      ((size_t) &((struct thread_options *)0)->var)
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 bs_cmp(const void *p1, const void *p2)
36 {
37         const struct bssplit *bsp1 = p1;
38         const struct bssplit *bsp2 = p2;
39
40         return bsp1->perc < bsp2->perc;
41 }
42
43 static int str_bssplit_cb(void *data, const char *input)
44 {
45         struct thread_data *td = data;
46         char *fname, *str, *p;
47         unsigned int i, perc, perc_missing;
48         unsigned int max_bs, min_bs;
49         long long val;
50
51         p = str = strdup(input);
52
53         strip_blank_front(&str);
54         strip_blank_end(str);
55
56         td->o.bssplit_nr = 4;
57         td->o.bssplit = malloc(4 * sizeof(struct bssplit));
58
59         i = 0;
60         max_bs = 0;
61         min_bs = -1;
62         while ((fname = strsep(&str, ":")) != NULL) {
63                 char *perc_str;
64
65                 if (!strlen(fname))
66                         break;
67
68                 /*
69                  * grow struct buffer, if needed
70                  */
71                 if (i == td->o.bssplit_nr) {
72                         td->o.bssplit_nr <<= 1;
73                         td->o.bssplit = realloc(td->o.bssplit,
74                                                 td->o.bssplit_nr
75                                                   * sizeof(struct bssplit));
76                 }
77
78                 perc_str = strstr(fname, "/");
79                 if (perc_str) {
80                         *perc_str = '\0';
81                         perc_str++;
82                         perc = atoi(perc_str);
83                         if (perc > 100)
84                                 perc = 100;
85                         else if (!perc)
86                                 perc = -1;
87                 } else
88                         perc = -1;
89
90                 if (str_to_decimal(fname, &val, 1)) {
91                         log_err("fio: bssplit conversion failed\n");
92                         free(td->o.bssplit);
93                         return 1;
94                 }
95
96                 if (val > max_bs)
97                         max_bs = val;
98                 if (val < min_bs)
99                         min_bs = val;
100
101                 td->o.bssplit[i].bs = val;
102                 td->o.bssplit[i].perc = perc;
103                 i++;
104         }
105
106         td->o.bssplit_nr = i;
107
108         /*
109          * Now check if the percentages add up, and how much is missing
110          */
111         perc = perc_missing = 0;
112         for (i = 0; i < td->o.bssplit_nr; i++) {
113                 struct bssplit *bsp = &td->o.bssplit[i];
114
115                 if (bsp->perc == (unsigned char) -1)
116                         perc_missing++;
117                 else
118                         perc += bsp->perc;
119         }
120
121         if (perc > 100) {
122                 log_err("fio: bssplit percentages add to more than 100%%\n");
123                 free(td->o.bssplit);
124                 return 1;
125         }
126         /*
127          * If values didn't have a percentage set, divide the remains between
128          * them.
129          */
130         if (perc_missing) {
131                 for (i = 0; i < td->o.bssplit_nr; i++) {
132                         struct bssplit *bsp = &td->o.bssplit[i];
133
134                         if (bsp->perc == (unsigned char) -1)
135                                 bsp->perc = (100 - perc) / perc_missing;
136                 }
137         }
138
139         td->o.min_bs[DDIR_READ] = td->o.min_bs[DDIR_WRITE] = min_bs;
140         td->o.max_bs[DDIR_READ] = td->o.max_bs[DDIR_WRITE] = max_bs;
141
142         /*
143          * now sort based on percentages, for ease of lookup
144          */
145         qsort(td->o.bssplit, td->o.bssplit_nr, sizeof(struct bssplit), bs_cmp);
146
147         free(p);
148         return 0;
149 }
150
151 static int str_rw_cb(void *data, const char *str)
152 {
153         struct thread_data *td = data;
154         char *nr = get_opt_postfix(str);
155
156         td->o.ddir_nr = 1;
157         if (nr)
158                 td->o.ddir_nr = atoi(nr);
159
160         return 0;
161 }
162
163 static int str_mem_cb(void *data, const char *mem)
164 {
165         struct thread_data *td = data;
166
167         if (td->o.mem_type == MEM_MMAPHUGE || td->o.mem_type == MEM_MMAP) {
168                 td->mmapfile = get_opt_postfix(mem);
169                 if (td->o.mem_type == MEM_MMAPHUGE && !td->mmapfile) {
170                         log_err("fio: mmaphuge:/path/to/file\n");
171                         return 1;
172                 }
173         }
174
175         return 0;
176 }
177
178 static int str_lockmem_cb(void fio_unused *data, unsigned long *val)
179 {
180         mlock_size = *val;
181         return 0;
182 }
183
184 static int str_rwmix_read_cb(void *data, unsigned int *val)
185 {
186         struct thread_data *td = data;
187
188         td->o.rwmix[DDIR_READ] = *val;
189         td->o.rwmix[DDIR_WRITE] = 100 - *val;
190         return 0;
191 }
192
193 static int str_rwmix_write_cb(void *data, unsigned int *val)
194 {
195         struct thread_data *td = data;
196
197         td->o.rwmix[DDIR_WRITE] = *val;
198         td->o.rwmix[DDIR_READ] = 100 - *val;
199         return 0;
200 }
201
202 #ifdef FIO_HAVE_IOPRIO
203 static int str_prioclass_cb(void *data, unsigned int *val)
204 {
205         struct thread_data *td = data;
206         unsigned short mask;
207
208         /*
209          * mask off old class bits, str_prio_cb() may have set a default class
210          */
211         mask = (1 << IOPRIO_CLASS_SHIFT) - 1;
212         td->ioprio &= mask;
213
214         td->ioprio |= *val << IOPRIO_CLASS_SHIFT;
215         td->ioprio_set = 1;
216         return 0;
217 }
218
219 static int str_prio_cb(void *data, unsigned int *val)
220 {
221         struct thread_data *td = data;
222
223         td->ioprio |= *val;
224
225         /*
226          * If no class is set, assume BE
227          */
228         if ((td->ioprio >> IOPRIO_CLASS_SHIFT) == 0)
229                 td->ioprio |= IOPRIO_CLASS_BE << IOPRIO_CLASS_SHIFT;
230
231         td->ioprio_set = 1;
232         return 0;
233 }
234 #endif
235
236 static int str_exitall_cb(void)
237 {
238         exitall_on_terminate = 1;
239         return 0;
240 }
241
242 #ifdef FIO_HAVE_CPU_AFFINITY
243 static int str_cpumask_cb(void *data, unsigned int *val)
244 {
245         struct thread_data *td = data;
246         unsigned int i;
247
248         CPU_ZERO(&td->o.cpumask);
249
250         for (i = 0; i < sizeof(int) * 8; i++)
251                 if ((1 << i) & *val)
252                         CPU_SET(*val, &td->o.cpumask);
253
254         td->o.cpumask_set = 1;
255         return 0;
256 }
257
258 static int str_cpus_allowed_cb(void *data, const char *input)
259 {
260         struct thread_data *td = data;
261         char *cpu, *str, *p;
262
263         CPU_ZERO(&td->o.cpumask);
264
265         p = str = strdup(input);
266
267         strip_blank_front(&str);
268         strip_blank_end(str);
269
270         while ((cpu = strsep(&str, ",")) != NULL) {
271                 if (!strlen(cpu))
272                         break;
273                 CPU_SET(atoi(cpu), &td->o.cpumask);
274         }
275
276         free(p);
277         td->o.cpumask_set = 1;
278         return 0;
279 }
280 #endif
281
282 static int str_fst_cb(void *data, const char *str)
283 {
284         struct thread_data *td = data;
285         char *nr = get_opt_postfix(str);
286
287         td->file_service_nr = 1;
288         if (nr)
289                 td->file_service_nr = atoi(nr);
290
291         return 0;
292 }
293
294 static int check_dir(struct thread_data *td, char *fname)
295 {
296         char file[PATH_MAX], *dir;
297         int elen = 0;
298
299         if (td->o.directory) {
300                 strcpy(file, td->o.directory);
301                 strcat(file, "/");
302                 elen = strlen(file);
303         }
304
305         sprintf(file + elen, "%s", fname);
306         dir = dirname(file);
307
308 #if 0
309         {
310         struct stat sb;
311         /*
312          * We can't do this on FIO_DISKLESSIO engines. The engine isn't loaded
313          * yet, so we can't do this check right here...
314          */
315         if (lstat(dir, &sb) < 0) {
316                 int ret = errno;
317
318                 log_err("fio: %s is not a directory\n", dir);
319                 td_verror(td, ret, "lstat");
320                 return 1;
321         }
322
323         if (!S_ISDIR(sb.st_mode)) {
324                 log_err("fio: %s is not a directory\n", dir);
325                 return 1;
326         }
327         }
328 #endif
329
330         return 0;
331 }
332
333 static int str_filename_cb(void *data, const char *input)
334 {
335         struct thread_data *td = data;
336         char *fname, *str, *p;
337
338         p = str = strdup(input);
339
340         strip_blank_front(&str);
341         strip_blank_end(str);
342
343         if (!td->files_index)
344                 td->o.nr_files = 0;
345
346         while ((fname = strsep(&str, ":")) != NULL) {
347                 if (!strlen(fname))
348                         break;
349                 if (check_dir(td, fname)) {
350                         free(p);
351                         return 1;
352                 }
353                 add_file(td, fname);
354                 td->o.nr_files++;
355         }
356
357         free(p);
358         return 0;
359 }
360
361 static int str_directory_cb(void *data, const char fio_unused *str)
362 {
363         struct thread_data *td = data;
364         struct stat sb;
365
366         if (lstat(td->o.directory, &sb) < 0) {
367                 int ret = errno;
368
369                 log_err("fio: %s is not a directory\n", td->o.directory);
370                 td_verror(td, ret, "lstat");
371                 return 1;
372         }
373         if (!S_ISDIR(sb.st_mode)) {
374                 log_err("fio: %s is not a directory\n", td->o.directory);
375                 return 1;
376         }
377
378         return 0;
379 }
380
381 static int str_opendir_cb(void *data, const char fio_unused *str)
382 {
383         struct thread_data *td = data;
384
385         if (!td->files_index)
386                 td->o.nr_files = 0;
387
388         return add_dir_files(td, td->o.opendir);
389 }
390
391 static int str_verify_offset_cb(void *data, unsigned int *off)
392 {
393         struct thread_data *td = data;
394
395         if (*off && *off < sizeof(struct verify_header)) {
396                 log_err("fio: verify_offset too small\n");
397                 return 1;
398         }
399
400         td->o.verify_offset = *off;
401         return 0;
402 }
403
404 static int str_verify_pattern_cb(void *data, unsigned int *off)
405 {
406         struct thread_data *td = data;
407         unsigned int msb;
408
409         msb = __fls(*off);
410         if (msb <= 8)
411                 td->o.verify_pattern_bytes = 1;
412         else if (msb <= 16)
413                 td->o.verify_pattern_bytes = 2;
414         else if (msb <= 24)
415                 td->o.verify_pattern_bytes = 3;
416         else
417                 td->o.verify_pattern_bytes = 4;
418
419         td->o.verify_pattern = *off;
420         return 0;
421 }
422
423 static int str_lockfile_cb(void *data, const char *str)
424 {
425         struct thread_data *td = data;
426         char *nr = get_opt_postfix(str);
427
428         td->o.lockfile_batch = 1;
429         if (nr)
430                 td->o.lockfile_batch = atoi(nr);
431
432         return 0;
433 }
434
435 #define __stringify_1(x)        #x
436 #define __stringify(x)          __stringify_1(x)
437
438 /*
439  * Map of job/command line options
440  */
441 static struct fio_option options[] = {
442         {
443                 .name   = "description",
444                 .type   = FIO_OPT_STR_STORE,
445                 .off1   = td_var_offset(description),
446                 .help   = "Text job description",
447         },
448         {
449                 .name   = "name",
450                 .type   = FIO_OPT_STR_STORE,
451                 .off1   = td_var_offset(name),
452                 .help   = "Name of this job",
453         },
454         {
455                 .name   = "directory",
456                 .type   = FIO_OPT_STR_STORE,
457                 .off1   = td_var_offset(directory),
458                 .cb     = str_directory_cb,
459                 .help   = "Directory to store files in",
460         },
461         {
462                 .name   = "filename",
463                 .type   = FIO_OPT_STR_STORE,
464                 .off1   = td_var_offset(filename),
465                 .cb     = str_filename_cb,
466                 .prio   = 1, /* must come before "directory" */
467                 .help   = "File(s) to use for the workload",
468         },
469         {
470                 .name   = "lockfile",
471                 .type   = FIO_OPT_STR,
472                 .cb     = str_lockfile_cb,
473                 .off1   = td_var_offset(file_lock_mode),
474                 .help   = "Lock file when doing IO to it",
475                 .parent = "filename",
476                 .def    = "none",
477                 .posval = {
478                           { .ival = "none",
479                             .oval = FILE_LOCK_NONE,
480                             .help = "No file locking",
481                           },
482                           { .ival = "exclusive",
483                             .oval = FILE_LOCK_EXCLUSIVE,
484                             .help = "Exclusive file lock",
485                           },
486                           {
487                             .ival = "readwrite",
488                             .oval = FILE_LOCK_READWRITE,
489                             .help = "Read vs write lock",
490                           },
491                 },
492         },
493         {
494                 .name   = "opendir",
495                 .type   = FIO_OPT_STR_STORE,
496                 .off1   = td_var_offset(opendir),
497                 .cb     = str_opendir_cb,
498                 .help   = "Recursively add files from this directory and down",
499         },
500         {
501                 .name   = "rw",
502                 .alias  = "readwrite",
503                 .type   = FIO_OPT_STR,
504                 .cb     = str_rw_cb,
505                 .off1   = td_var_offset(td_ddir),
506                 .help   = "IO direction",
507                 .def    = "read",
508                 .posval = {
509                           { .ival = "read",
510                             .oval = TD_DDIR_READ,
511                             .help = "Sequential read",
512                           },
513                           { .ival = "write",
514                             .oval = TD_DDIR_WRITE,
515                             .help = "Sequential write",
516                           },
517                           { .ival = "randread",
518                             .oval = TD_DDIR_RANDREAD,
519                             .help = "Random read",
520                           },
521                           { .ival = "randwrite",
522                             .oval = TD_DDIR_RANDWRITE,
523                             .help = "Random write",
524                           },
525                           { .ival = "rw",
526                             .oval = TD_DDIR_RW,
527                             .help = "Sequential read and write mix",
528                           },
529                           { .ival = "randrw",
530                             .oval = TD_DDIR_RANDRW,
531                             .help = "Random read and write mix"
532                           },
533                 },
534         },
535         {
536                 .name   = "ioengine",
537                 .type   = FIO_OPT_STR_STORE,
538                 .off1   = td_var_offset(ioengine),
539                 .help   = "IO engine to use",
540                 .def    = "sync",
541                 .posval = {
542                           { .ival = "sync",
543                             .help = "Use read/write",
544                           },
545                           { .ival = "psync",
546                             .help = "Use pread/pwrite",
547                           },
548                           { .ival = "vsync",
549                              .help = "Use readv/writev",
550                           },
551 #ifdef FIO_HAVE_LIBAIO
552                           { .ival = "libaio",
553                             .help = "Linux native asynchronous IO",
554                           },
555 #endif
556 #ifdef FIO_HAVE_POSIXAIO
557                           { .ival = "posixaio",
558                             .help = "POSIX asynchronous IO",
559                           },
560 #endif
561 #ifdef FIO_HAVE_SOLARISAIO
562                           { .ival = "solarisaio",
563                             .help = "Solaris native asynchronous IO",
564                           },
565 #endif
566                           { .ival = "mmap",
567                             .help = "Memory mapped IO",
568                           },
569 #ifdef FIO_HAVE_SPLICE
570                           { .ival = "splice",
571                             .help = "splice/vmsplice based IO",
572                           },
573                           { .ival = "netsplice",
574                             .help = "splice/vmsplice to/from the network",
575                           },
576 #endif
577 #ifdef FIO_HAVE_SGIO
578                           { .ival = "sg",
579                             .help = "SCSI generic v3 IO",
580                           },
581 #endif
582                           { .ival = "null",
583                             .help = "Testing engine (no data transfer)",
584                           },
585                           { .ival = "net",
586                             .help = "Network IO",
587                           },
588 #ifdef FIO_HAVE_SYSLET
589                           { .ival = "syslet-rw",
590                             .help = "syslet enabled async pread/pwrite IO",
591                           },
592 #endif
593                           { .ival = "cpuio",
594                             .help = "CPU cycler burner engine",
595                           },
596 #ifdef FIO_HAVE_GUASI
597                           { .ival = "guasi",
598                             .help = "GUASI IO engine",
599                           },
600 #endif
601                           { .ival = "external",
602                             .help = "Load external engine (append name)",
603                           },
604                 },
605         },
606         {
607                 .name   = "iodepth",
608                 .type   = FIO_OPT_INT,
609                 .off1   = td_var_offset(iodepth),
610                 .help   = "Amount of IO buffers to keep in flight",
611                 .minval = 1,
612                 .def    = "1",
613         },
614         {
615                 .name   = "iodepth_batch",
616                 .alias  = "iodepth_batch_submit",
617                 .type   = FIO_OPT_INT,
618                 .off1   = td_var_offset(iodepth_batch),
619                 .help   = "Number of IO to submit in one go",
620                 .parent = "iodepth",
621                 .minval = 1,
622                 .def    = "1",
623         },
624         {
625                 .name   = "iodepth_batch_complete",
626                 .type   = FIO_OPT_INT,
627                 .off1   = td_var_offset(iodepth_batch_complete),
628                 .help   = "Number of IO to retrieve in one go",
629                 .parent = "iodepth",
630                 .minval = 0,
631                 .def    = "1",
632         },
633         {
634                 .name   = "iodepth_low",
635                 .type   = FIO_OPT_INT,
636                 .off1   = td_var_offset(iodepth_low),
637                 .help   = "Low water mark for queuing depth",
638                 .parent = "iodepth",
639         },
640         {
641                 .name   = "size",
642                 .type   = FIO_OPT_STR_VAL,
643                 .off1   = td_var_offset(size),
644                 .minval = 1,
645                 .help   = "Total size of device or files",
646         },
647         {
648                 .name   = "fill_device",
649                 .type   = FIO_OPT_BOOL,
650                 .off1   = td_var_offset(fill_device),
651                 .help   = "Write until an ENOSPC error occurs",
652                 .def    = "0",
653         },
654         {
655                 .name   = "filesize",
656                 .type   = FIO_OPT_STR_VAL,
657                 .off1   = td_var_offset(file_size_low),
658                 .off2   = td_var_offset(file_size_high),
659                 .minval = 1,
660                 .help   = "Size of individual files",
661         },
662         {
663                 .name   = "offset",
664                 .alias  = "fileoffset",
665                 .type   = FIO_OPT_STR_VAL,
666                 .off1   = td_var_offset(start_offset),
667                 .help   = "Start IO from this offset",
668                 .def    = "0",
669         },
670         {
671                 .name   = "bs",
672                 .alias  = "blocksize",
673                 .type   = FIO_OPT_STR_VAL_INT,
674                 .off1   = td_var_offset(bs[DDIR_READ]),
675                 .off2   = td_var_offset(bs[DDIR_WRITE]),
676                 .minval = 1,
677                 .help   = "Block size unit",
678                 .def    = "4k",
679                 .parent = "rw",
680         },
681         {
682                 .name   = "bsrange",
683                 .alias  = "blocksize_range",
684                 .type   = FIO_OPT_RANGE,
685                 .off1   = td_var_offset(min_bs[DDIR_READ]),
686                 .off2   = td_var_offset(max_bs[DDIR_READ]),
687                 .off3   = td_var_offset(min_bs[DDIR_WRITE]),
688                 .off4   = td_var_offset(max_bs[DDIR_WRITE]),
689                 .minval = 1,
690                 .help   = "Set block size range (in more detail than bs)",
691                 .parent = "rw",
692         },
693         {
694                 .name   = "bssplit",
695                 .type   = FIO_OPT_STR,
696                 .cb     = str_bssplit_cb,
697                 .help   = "Set a specific mix of block sizes",
698                 .parent = "rw",
699         },
700         {
701                 .name   = "bs_unaligned",
702                 .alias  = "blocksize_unaligned",
703                 .type   = FIO_OPT_STR_SET,
704                 .off1   = td_var_offset(bs_unaligned),
705                 .help   = "Don't sector align IO buffer sizes",
706                 .parent = "rw",
707         },
708         {
709                 .name   = "randrepeat",
710                 .type   = FIO_OPT_BOOL,
711                 .off1   = td_var_offset(rand_repeatable),
712                 .help   = "Use repeatable random IO pattern",
713                 .def    = "1",
714                 .parent = "rw",
715         },
716         {
717                 .name   = "norandommap",
718                 .type   = FIO_OPT_STR_SET,
719                 .off1   = td_var_offset(norandommap),
720                 .help   = "Accept potential duplicate random blocks",
721                 .parent = "rw",
722         },
723         {
724                 .name   = "softrandommap",
725                 .type   = FIO_OPT_BOOL,
726                 .off1   = td_var_offset(softrandommap),
727                 .help   = "Set norandommap if randommap allocation fails",
728                 .parent = "norandommap",
729                 .def    = "0",
730         },
731         {
732                 .name   = "nrfiles",
733                 .type   = FIO_OPT_INT,
734                 .off1   = td_var_offset(nr_files),
735                 .help   = "Split job workload between this number of files",
736                 .def    = "1",
737         },
738         {
739                 .name   = "openfiles",
740                 .type   = FIO_OPT_INT,
741                 .off1   = td_var_offset(open_files),
742                 .help   = "Number of files to keep open at the same time",
743         },
744         {
745                 .name   = "file_service_type",
746                 .type   = FIO_OPT_STR,
747                 .cb     = str_fst_cb,
748                 .off1   = td_var_offset(file_service_type),
749                 .help   = "How to select which file to service next",
750                 .def    = "roundrobin",
751                 .posval = {
752                           { .ival = "random",
753                             .oval = FIO_FSERVICE_RANDOM,
754                             .help = "Choose a file at random",
755                           },
756                           { .ival = "roundrobin",
757                             .oval = FIO_FSERVICE_RR,
758                             .help = "Round robin select files",
759                           },
760                 },
761                 .parent = "nrfiles",
762         },
763         {
764                 .name   = "fadvise_hint",
765                 .type   = FIO_OPT_BOOL,
766                 .off1   = td_var_offset(fadvise_hint),
767                 .help   = "Use fadvise() to advise the kernel on IO pattern",
768                 .def    = "1",
769         },
770         {
771                 .name   = "fsync",
772                 .type   = FIO_OPT_INT,
773                 .off1   = td_var_offset(fsync_blocks),
774                 .help   = "Issue fsync for writes every given number of blocks",
775                 .def    = "0",
776         },
777         {
778                 .name   = "direct",
779                 .type   = FIO_OPT_BOOL,
780                 .off1   = td_var_offset(odirect),
781                 .help   = "Use O_DIRECT IO (negates buffered)",
782                 .def    = "0",
783         },
784         {
785                 .name   = "buffered",
786                 .type   = FIO_OPT_BOOL,
787                 .off1   = td_var_offset(odirect),
788                 .neg    = 1,
789                 .help   = "Use buffered IO (negates direct)",
790                 .def    = "1",
791         },
792         {
793                 .name   = "overwrite",
794                 .type   = FIO_OPT_BOOL,
795                 .off1   = td_var_offset(overwrite),
796                 .help   = "When writing, set whether to overwrite current data",
797                 .def    = "0",
798         },
799         {
800                 .name   = "loops",
801                 .type   = FIO_OPT_INT,
802                 .off1   = td_var_offset(loops),
803                 .help   = "Number of times to run the job",
804                 .def    = "1",
805         },
806         {
807                 .name   = "numjobs",
808                 .type   = FIO_OPT_INT,
809                 .off1   = td_var_offset(numjobs),
810                 .help   = "Duplicate this job this many times",
811                 .def    = "1",
812         },
813         {
814                 .name   = "startdelay",
815                 .type   = FIO_OPT_INT,
816                 .off1   = td_var_offset(start_delay),
817                 .help   = "Only start job when this period has passed",
818                 .def    = "0",
819         },
820         {
821                 .name   = "runtime",
822                 .alias  = "timeout",
823                 .type   = FIO_OPT_STR_VAL_TIME,
824                 .off1   = td_var_offset(timeout),
825                 .help   = "Stop workload when this amount of time has passed",
826                 .def    = "0",
827         },
828         {
829                 .name   = "time_based",
830                 .type   = FIO_OPT_STR_SET,
831                 .off1   = td_var_offset(time_based),
832                 .help   = "Keep running until runtime/timeout is met",
833         },
834         {
835                 .name   = "mem",
836                 .alias  = "iomem",
837                 .type   = FIO_OPT_STR,
838                 .cb     = str_mem_cb,
839                 .off1   = td_var_offset(mem_type),
840                 .help   = "Backing type for IO buffers",
841                 .def    = "malloc",
842                 .posval = {
843                           { .ival = "malloc",
844                             .oval = MEM_MALLOC,
845                             .help = "Use malloc(3) for IO buffers",
846                           },
847                           { .ival = "shm",
848                             .oval = MEM_SHM,
849                             .help = "Use shared memory segments for IO buffers",
850                           },
851 #ifdef FIO_HAVE_HUGETLB
852                           { .ival = "shmhuge",
853                             .oval = MEM_SHMHUGE,
854                             .help = "Like shm, but use huge pages",
855                           },
856 #endif
857                           { .ival = "mmap",
858                             .oval = MEM_MMAP,
859                             .help = "Use mmap(2) (file or anon) for IO buffers",
860                           },
861 #ifdef FIO_HAVE_HUGETLB
862                           { .ival = "mmaphuge",
863                             .oval = MEM_MMAPHUGE,
864                             .help = "Like mmap, but use huge pages",
865                           },
866 #endif
867                   },
868         },
869         {
870                 .name   = "verify",
871                 .type   = FIO_OPT_STR,
872                 .off1   = td_var_offset(verify),
873                 .help   = "Verify data written",
874                 .def    = "0",
875                 .posval = {
876                           { .ival = "0",
877                             .oval = VERIFY_NONE,
878                             .help = "Don't do IO verification",
879                           },
880                           { .ival = "md5",
881                             .oval = VERIFY_MD5,
882                             .help = "Use md5 checksums for verification",
883                           },
884                           { .ival = "crc64",
885                             .oval = VERIFY_CRC64,
886                             .help = "Use crc64 checksums for verification",
887                           },
888                           { .ival = "crc32",
889                             .oval = VERIFY_CRC32,
890                             .help = "Use crc32 checksums for verification",
891                           },
892                           { .ival = "crc32c-intel",
893                             .oval = VERIFY_CRC32C_INTEL,
894                             .help = "Use hw crc32c checksums for verification",
895                           },
896                           { .ival = "crc32c",
897                             .oval = VERIFY_CRC32C,
898                             .help = "Use crc32c checksums for verification",
899                           },
900                           { .ival = "crc16",
901                             .oval = VERIFY_CRC16,
902                             .help = "Use crc16 checksums for verification",
903                           },
904                           { .ival = "crc7",
905                             .oval = VERIFY_CRC7,
906                             .help = "Use crc7 checksums for verification",
907                           },
908                           { .ival = "sha256",
909                             .oval = VERIFY_SHA256,
910                             .help = "Use sha256 checksums for verification",
911                           },
912                           { .ival = "sha512",
913                             .oval = VERIFY_SHA512,
914                             .help = "Use sha512 checksums for verification",
915                           },
916                           { .ival = "meta",
917                             .oval = VERIFY_META,
918                             .help = "Use io information",
919                           },
920                           {
921                             .ival = "null",
922                             .oval = VERIFY_NULL,
923                             .help = "Pretend to verify",
924                           },
925                 },
926         },
927         {
928                 .name   = "do_verify",
929                 .type   = FIO_OPT_BOOL,
930                 .off1   = td_var_offset(do_verify),
931                 .help   = "Run verification stage after write",
932                 .def    = "1",
933                 .parent = "verify",
934         },
935         {
936                 .name   = "verifysort",
937                 .type   = FIO_OPT_BOOL,
938                 .off1   = td_var_offset(verifysort),
939                 .help   = "Sort written verify blocks for read back",
940                 .def    = "1",
941                 .parent = "verify",
942         },
943         {
944                 .name   = "verify_interval",
945                 .type   = FIO_OPT_STR_VAL_INT,
946                 .off1   = td_var_offset(verify_interval),
947                 .minval = 2 * sizeof(struct verify_header),
948                 .help   = "Store verify buffer header every N bytes",
949                 .parent = "verify",
950         },
951         {
952                 .name   = "verify_offset",
953                 .type   = FIO_OPT_STR_VAL_INT,
954                 .help   = "Offset verify header location by N bytes",
955                 .def    = "0",
956                 .cb     = str_verify_offset_cb,
957                 .parent = "verify",
958         },
959         {
960                 .name   = "verify_pattern",
961                 .type   = FIO_OPT_INT,
962                 .cb     = str_verify_pattern_cb,
963                 .help   = "Fill pattern for IO buffers",
964                 .parent = "verify",
965         },
966         {
967                 .name   = "verify_fatal",
968                 .type   = FIO_OPT_BOOL,
969                 .off1   = td_var_offset(verify_fatal),
970                 .def    = "0",
971                 .help   = "Exit on a single verify failure, don't continue",
972                 .parent = "verify",
973         },
974         {
975                 .name   = "write_iolog",
976                 .type   = FIO_OPT_STR_STORE,
977                 .off1   = td_var_offset(write_iolog_file),
978                 .help   = "Store IO pattern to file",
979         },
980         {
981                 .name   = "read_iolog",
982                 .type   = FIO_OPT_STR_STORE,
983                 .off1   = td_var_offset(read_iolog_file),
984                 .help   = "Playback IO pattern from file",
985         },
986         {
987                 .name   = "exec_prerun",
988                 .type   = FIO_OPT_STR_STORE,
989                 .off1   = td_var_offset(exec_prerun),
990                 .help   = "Execute this file prior to running job",
991         },
992         {
993                 .name   = "exec_postrun",
994                 .type   = FIO_OPT_STR_STORE,
995                 .off1   = td_var_offset(exec_postrun),
996                 .help   = "Execute this file after running job",
997         },
998 #ifdef FIO_HAVE_IOSCHED_SWITCH
999         {
1000                 .name   = "ioscheduler",
1001                 .type   = FIO_OPT_STR_STORE,
1002                 .off1   = td_var_offset(ioscheduler),
1003                 .help   = "Use this IO scheduler on the backing device",
1004         },
1005 #endif
1006         {
1007                 .name   = "zonesize",
1008                 .type   = FIO_OPT_STR_VAL,
1009                 .off1   = td_var_offset(zone_size),
1010                 .help   = "Give size of an IO zone",
1011                 .def    = "0",
1012         },
1013         {
1014                 .name   = "zoneskip",
1015                 .type   = FIO_OPT_STR_VAL,
1016                 .off1   = td_var_offset(zone_skip),
1017                 .help   = "Space between IO zones",
1018                 .def    = "0",
1019         },
1020         {
1021                 .name   = "lockmem",
1022                 .type   = FIO_OPT_STR_VAL,
1023                 .cb     = str_lockmem_cb,
1024                 .help   = "Lock down this amount of memory",
1025                 .def    = "0",
1026         },
1027         {
1028                 .name   = "rwmixread",
1029                 .type   = FIO_OPT_INT,
1030                 .cb     = str_rwmix_read_cb,
1031                 .maxval = 100,
1032                 .help   = "Percentage of mixed workload that is reads",
1033                 .def    = "50",
1034         },
1035         {
1036                 .name   = "rwmixwrite",
1037                 .type   = FIO_OPT_INT,
1038                 .cb     = str_rwmix_write_cb,
1039                 .maxval = 100,
1040                 .help   = "Percentage of mixed workload that is writes",
1041                 .def    = "50",
1042         },
1043         {
1044                 .name   = "rwmixcycle",
1045                 .type   = FIO_OPT_DEPRECATED,
1046         },
1047         {
1048                 .name   = "nice",
1049                 .type   = FIO_OPT_INT,
1050                 .off1   = td_var_offset(nice),
1051                 .help   = "Set job CPU nice value",
1052                 .minval = -19,
1053                 .maxval = 20,
1054                 .def    = "0",
1055         },
1056 #ifdef FIO_HAVE_IOPRIO
1057         {
1058                 .name   = "prio",
1059                 .type   = FIO_OPT_INT,
1060                 .cb     = str_prio_cb,
1061                 .help   = "Set job IO priority value",
1062                 .minval = 0,
1063                 .maxval = 7,
1064         },
1065         {
1066                 .name   = "prioclass",
1067                 .type   = FIO_OPT_INT,
1068                 .cb     = str_prioclass_cb,
1069                 .help   = "Set job IO priority class",
1070                 .minval = 0,
1071                 .maxval = 3,
1072         },
1073 #endif
1074         {
1075                 .name   = "thinktime",
1076                 .type   = FIO_OPT_INT,
1077                 .off1   = td_var_offset(thinktime),
1078                 .help   = "Idle time between IO buffers (usec)",
1079                 .def    = "0",
1080         },
1081         {
1082                 .name   = "thinktime_spin",
1083                 .type   = FIO_OPT_INT,
1084                 .off1   = td_var_offset(thinktime_spin),
1085                 .help   = "Start think time by spinning this amount (usec)",
1086                 .def    = "0",
1087                 .parent = "thinktime",
1088         },
1089         {
1090                 .name   = "thinktime_blocks",
1091                 .type   = FIO_OPT_INT,
1092                 .off1   = td_var_offset(thinktime_blocks),
1093                 .help   = "IO buffer period between 'thinktime'",
1094                 .def    = "1",
1095                 .parent = "thinktime",
1096         },
1097         {
1098                 .name   = "rate",
1099                 .type   = FIO_OPT_INT,
1100                 .off1   = td_var_offset(rate),
1101                 .help   = "Set bandwidth rate",
1102         },
1103         {
1104                 .name   = "ratemin",
1105                 .type   = FIO_OPT_INT,
1106                 .off1   = td_var_offset(ratemin),
1107                 .help   = "Job must meet this rate or it will be shutdown",
1108                 .parent = "rate",
1109         },
1110         {
1111                 .name   = "rate_iops",
1112                 .type   = FIO_OPT_INT,
1113                 .off1   = td_var_offset(rate_iops),
1114                 .help   = "Limit IO used to this number of IO operations/sec",
1115         },
1116         {
1117                 .name   = "rate_iops_min",
1118                 .type   = FIO_OPT_INT,
1119                 .off1   = td_var_offset(rate_iops_min),
1120                 .help   = "Job must meet this rate or it will be shutdown",
1121                 .parent = "rate_iops",
1122         },
1123         {
1124                 .name   = "ratecycle",
1125                 .type   = FIO_OPT_INT,
1126                 .off1   = td_var_offset(ratecycle),
1127                 .help   = "Window average for rate limits (msec)",
1128                 .def    = "1000",
1129                 .parent = "rate",
1130         },
1131         {
1132                 .name   = "invalidate",
1133                 .type   = FIO_OPT_BOOL,
1134                 .off1   = td_var_offset(invalidate_cache),
1135                 .help   = "Invalidate buffer/page cache prior to running job",
1136                 .def    = "1",
1137         },
1138         {
1139                 .name   = "sync",
1140                 .type   = FIO_OPT_BOOL,
1141                 .off1   = td_var_offset(sync_io),
1142                 .help   = "Use O_SYNC for buffered writes",
1143                 .def    = "0",
1144                 .parent = "buffered",
1145         },
1146         {
1147                 .name   = "bwavgtime",
1148                 .type   = FIO_OPT_INT,
1149                 .off1   = td_var_offset(bw_avg_time),
1150                 .help   = "Time window over which to calculate bandwidth"
1151                           " (msec)",
1152                 .def    = "500",
1153         },
1154         {
1155                 .name   = "create_serialize",
1156                 .type   = FIO_OPT_BOOL,
1157                 .off1   = td_var_offset(create_serialize),
1158                 .help   = "Serialize creating of job files",
1159                 .def    = "1",
1160         },
1161         {
1162                 .name   = "create_fsync",
1163                 .type   = FIO_OPT_BOOL,
1164                 .off1   = td_var_offset(create_fsync),
1165                 .help   = "Fsync file after creation",
1166                 .def    = "1",
1167         },
1168         {
1169                 .name   = "cpuload",
1170                 .type   = FIO_OPT_INT,
1171                 .off1   = td_var_offset(cpuload),
1172                 .help   = "Use this percentage of CPU",
1173         },
1174         {
1175                 .name   = "cpuchunks",
1176                 .type   = FIO_OPT_INT,
1177                 .off1   = td_var_offset(cpucycle),
1178                 .help   = "Length of the CPU burn cycles (usecs)",
1179                 .def    = "50000",
1180                 .parent = "cpuload",
1181         },
1182 #ifdef FIO_HAVE_CPU_AFFINITY
1183         {
1184                 .name   = "cpumask",
1185                 .type   = FIO_OPT_INT,
1186                 .cb     = str_cpumask_cb,
1187                 .help   = "CPU affinity mask",
1188         },
1189         {
1190                 .name   = "cpus_allowed",
1191                 .type   = FIO_OPT_STR,
1192                 .cb     = str_cpus_allowed_cb,
1193                 .help   = "Set CPUs allowed",
1194         },
1195 #endif
1196         {
1197                 .name   = "end_fsync",
1198                 .type   = FIO_OPT_BOOL,
1199                 .off1   = td_var_offset(end_fsync),
1200                 .help   = "Include fsync at the end of job",
1201                 .def    = "0",
1202         },
1203         {
1204                 .name   = "fsync_on_close",
1205                 .type   = FIO_OPT_BOOL,
1206                 .off1   = td_var_offset(fsync_on_close),
1207                 .help   = "fsync files on close",
1208                 .def    = "0",
1209         },
1210         {
1211                 .name   = "unlink",
1212                 .type   = FIO_OPT_BOOL,
1213                 .off1   = td_var_offset(unlink),
1214                 .help   = "Unlink created files after job has completed",
1215                 .def    = "0",
1216         },
1217         {
1218                 .name   = "exitall",
1219                 .type   = FIO_OPT_STR_SET,
1220                 .cb     = str_exitall_cb,
1221                 .help   = "Terminate all jobs when one exits",
1222         },
1223         {
1224                 .name   = "stonewall",
1225                 .type   = FIO_OPT_STR_SET,
1226                 .off1   = td_var_offset(stonewall),
1227                 .help   = "Insert a hard barrier between this job and previous",
1228         },
1229         {
1230                 .name   = "new_group",
1231                 .type   = FIO_OPT_STR_SET,
1232                 .off1   = td_var_offset(new_group),
1233                 .help   = "Mark the start of a new group (for reporting)",
1234         },
1235         {
1236                 .name   = "thread",
1237                 .type   = FIO_OPT_STR_SET,
1238                 .off1   = td_var_offset(use_thread),
1239                 .help   = "Use threads instead of forks",
1240         },
1241         {
1242                 .name   = "write_bw_log",
1243                 .type   = FIO_OPT_STR_SET,
1244                 .off1   = td_var_offset(write_bw_log),
1245                 .help   = "Write log of bandwidth during run",
1246         },
1247         {
1248                 .name   = "write_lat_log",
1249                 .type   = FIO_OPT_STR_SET,
1250                 .off1   = td_var_offset(write_lat_log),
1251                 .help   = "Write log of latency during run",
1252         },
1253         {
1254                 .name   = "hugepage-size",
1255                 .type   = FIO_OPT_STR_VAL_INT,
1256                 .off1   = td_var_offset(hugepage_size),
1257                 .help   = "When using hugepages, specify size of each page",
1258                 .def    = __stringify(FIO_HUGE_PAGE),
1259         },
1260         {
1261                 .name   = "group_reporting",
1262                 .type   = FIO_OPT_STR_SET,
1263                 .off1   = td_var_offset(group_reporting),
1264                 .help   = "Do reporting on a per-group basis",
1265         },
1266         {
1267                 .name   = "zero_buffers",
1268                 .type   = FIO_OPT_STR_SET,
1269                 .off1   = td_var_offset(zero_buffers),
1270                 .help   = "Init IO buffers to all zeroes",
1271         },
1272         {
1273                 .name   = "refill_buffers",
1274                 .type   = FIO_OPT_STR_SET,
1275                 .off1   = td_var_offset(refill_buffers),
1276                 .help   = "Refill IO buffers on every IO submit",
1277         },
1278 #ifdef FIO_HAVE_DISK_UTIL
1279         {
1280                 .name   = "disk_util",
1281                 .type   = FIO_OPT_BOOL,
1282                 .off1   = td_var_offset(do_disk_util),
1283                 .help   = "Log disk utilization statistics",
1284                 .def    = "1",
1285         },
1286 #endif
1287         {
1288                 .name = NULL,
1289         },
1290 };
1291
1292 void fio_options_dup_and_init(struct option *long_options)
1293 {
1294         struct fio_option *o;
1295         unsigned int i;
1296
1297         options_init(options);
1298
1299         i = 0;
1300         while (long_options[i].name)
1301                 i++;
1302
1303         o = &options[0];
1304         while (o->name) {
1305                 long_options[i].name = (char *) o->name;
1306                 long_options[i].val = FIO_GETOPT_JOB;
1307                 if (o->type == FIO_OPT_STR_SET)
1308                         long_options[i].has_arg = no_argument;
1309                 else
1310                         long_options[i].has_arg = required_argument;
1311
1312                 i++;
1313                 o++;
1314                 assert(i < FIO_NR_OPTIONS);
1315         }
1316 }
1317
1318 int fio_options_parse(struct thread_data *td, char **opts, int num_opts)
1319 {
1320         int i, ret;
1321
1322         sort_options(opts, options, num_opts);
1323
1324         for (ret = 0, i = 0; i < num_opts; i++)
1325                 ret |= parse_option(opts[i], options, td);
1326
1327         return ret;
1328 }
1329
1330 int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
1331 {
1332         return parse_cmd_option(opt, val, options, td);
1333 }
1334
1335 void fio_fill_default_options(struct thread_data *td)
1336 {
1337         fill_default_options(td, options);
1338 }
1339
1340 int fio_show_option_help(const char *opt)
1341 {
1342         return show_cmd_help(options, opt);
1343 }
1344
1345 static void __options_mem(struct thread_data *td, int alloc)
1346 {
1347         struct thread_options *o = &td->o;
1348         struct fio_option *opt;
1349         char **ptr;
1350         int i;
1351
1352         for (i = 0, opt = &options[0]; opt->name; i++, opt = &options[i]) {
1353                 if (opt->type != FIO_OPT_STR_STORE)
1354                         continue;
1355
1356                 ptr = (void *) o + opt->off1;
1357                 if (*ptr) {
1358                         if (alloc)
1359                                 *ptr = strdup(*ptr);
1360                         else {
1361                                 free(*ptr);
1362                                 *ptr = NULL;
1363                         }
1364                 }
1365         }
1366 }
1367
1368 /*
1369  * dupe FIO_OPT_STR_STORE options
1370  */
1371 void options_mem_dupe(struct thread_data *td)
1372 {
1373         __options_mem(td, 1);
1374 }
1375
1376 void options_mem_free(struct thread_data fio_unused *td)
1377 {
1378 #if 0
1379         __options_mem(td, 0);
1380 #endif
1381 }