splice engine: add unmapping for vmsplice-to-user
[fio.git] / options.c
index abd02c8c3b55055e4b73865182b0e5efa009e6f6..82d5ff51b47f684be065d848f1493aac63f6dbad 100644 (file)
--- a/options.c
+++ b/options.c
@@ -8,8 +8,9 @@
 
 #include "fio.h"
 #include "parse.h"
+#include "fls.h"
 
-#define td_var_offset(var)     ((size_t) &((struct thread_data *)0)->var)
+#define td_var_offset(var)     ((size_t) &((struct thread_options *)0)->var)
 
 /*
  * Check if mmap/mmaphuge has a :/foo/bar/file at the end. If so, return that.
@@ -27,13 +28,25 @@ static char *get_opt_postfix(const char *str)
        return strdup(p);
 }
 
+static int str_rw_cb(void *data, const char *str)
+{
+       struct thread_data *td = data;
+       char *nr = get_opt_postfix(str);
+
+       td->o.ddir_nr = 1;
+       if (nr)
+               td->o.ddir_nr = atoi(nr);
+
+       return 0;
+}
+
 static int str_mem_cb(void *data, const char *mem)
 {
        struct thread_data *td = data;
 
-       if (td->mem_type == MEM_MMAPHUGE || td->mem_type == MEM_MMAP) {
+       if (td->o.mem_type == MEM_MMAPHUGE || td->o.mem_type == MEM_MMAP) {
                td->mmapfile = get_opt_postfix(mem);
-               if (td->mem_type == MEM_MMAPHUGE && !td->mmapfile) {
+               if (td->o.mem_type == MEM_MMAPHUGE && !td->mmapfile) {
                        log_err("fio: mmaphuge:/path/to/file\n");
                        return 1;
                }
@@ -52,6 +65,13 @@ static int str_lockmem_cb(void fio_unused *data, unsigned long *val)
 static int str_prioclass_cb(void *data, unsigned int *val)
 {
        struct thread_data *td = data;
+       unsigned short mask;
+
+       /*
+        * mask off old class bits, str_prio_cb() may have set a default class
+        */
+       mask = (1 << IOPRIO_CLASS_SHIFT) - 1;
+       td->ioprio &= mask;
 
        td->ioprio |= *val << IOPRIO_CLASS_SHIFT;
        return 0;
@@ -62,6 +82,13 @@ static int str_prio_cb(void *data, unsigned int *val)
        struct thread_data *td = data;
 
        td->ioprio |= *val;
+
+       /*
+        * If no class is set, assume BE
+        */
+       if ((td->ioprio >> IOPRIO_CLASS_SHIFT) == 0)
+               td->ioprio |= IOPRIO_CLASS_BE << IOPRIO_CLASS_SHIFT;
+
        return 0;
 }
 #endif
@@ -72,27 +99,46 @@ static int str_exitall_cb(void)
        return 0;
 }
 
-static void fill_cpu_mask(os_cpu_mask_t cpumask, int cpu)
-{
 #ifdef FIO_HAVE_CPU_AFFINITY
+static int str_cpumask_cb(void *data, unsigned int *val)
+{
+       struct thread_data *td = data;
        unsigned int i;
 
-       CPU_ZERO(&cpumask);
+       CPU_ZERO(&td->o.cpumask);
 
-       for (i = 0; i < sizeof(int) * 8; i++) {
-               if ((1 << i) & cpu)
-                       CPU_SET(i, &cpumask);
-       }
-#endif
+       for (i = 0; i < sizeof(int) * 8; i++)
+               if ((1 << i) & *val)
+                       CPU_SET(*val, &td->o.cpumask);
+
+       td->o.cpumask_set = 1;
+       return 0;
 }
 
-static int str_cpumask_cb(void *data, unsigned int *val)
+static int str_cpus_allowed_cb(void *data, const char *input)
 {
        struct thread_data *td = data;
+       char *cpu, *str, *p;
+
+       CPU_ZERO(&td->o.cpumask);
+
+       p = str = strdup(input);
+
+       strip_blank_front(&str);
+       strip_blank_end(str);
+
+       while ((cpu = strsep(&str, ",")) != NULL) {
+               if (!strlen(cpu))
+                       break;
+               CPU_SET(atoi(cpu), &td->o.cpumask);
+       }
 
-       fill_cpu_mask(td->cpumask, *val);
+       free(p);
+       td->o.cpumask_set = 1;
+       exit(0);
        return 0;
 }
+#endif
 
 static int str_fst_cb(void *data, const char *str)
 {
@@ -117,13 +163,13 @@ static int str_filename_cb(void *data, const char *input)
        strip_blank_end(str);
 
        if (!td->files_index)
-               td->nr_files = 0;
+               td->o.nr_files = 0;
 
        while ((fname = strsep(&str, ":")) != NULL) {
                if (!strlen(fname))
                        break;
                add_file(td, fname);
-               td->nr_files++;
+               td->o.nr_files++;
        }
 
        free(p);
@@ -135,13 +181,13 @@ static int str_directory_cb(void *data, const char fio_unused *str)
        struct thread_data *td = data;
        struct stat sb;
 
-       if (lstat(td->directory, &sb) < 0) {
-               log_err("fio: %s is not a directory\n", td->directory);
+       if (lstat(td->o.directory, &sb) < 0) {
+               log_err("fio: %s is not a directory\n", td->o.directory);
                td_verror(td, errno, "lstat");
                return 1;
        }
        if (!S_ISDIR(sb.st_mode)) {
-               log_err("fio: %s is not a directory\n", td->directory);
+               log_err("fio: %s is not a directory\n", td->o.directory);
                return 1;
        }
 
@@ -153,11 +199,57 @@ static int str_opendir_cb(void *data, const char fio_unused *str)
        struct thread_data *td = data;
 
        if (!td->files_index)
-               td->nr_files = 0;
+               td->o.nr_files = 0;
 
-       return add_dir_files(td, td->opendir);
+       return add_dir_files(td, td->o.opendir);
 }
 
+static int str_verify_offset_cb(void *data, unsigned int *off)
+{
+       struct thread_data *td = data;
+
+       if (*off && *off < sizeof(struct verify_header)) {
+               log_err("fio: verify_offset too small\n");
+               return 1;
+       }
+
+       td->o.verify_offset = *off;
+       return 0;
+}
+
+static int str_verify_cb(void *data, const char *mem)
+{
+       struct thread_data *td = data;
+       unsigned int nr, msb;
+       char *pat;
+
+       if (td->o.verify != VERIFY_PATTERN)
+               return 0;
+
+       pat = get_opt_postfix(mem);
+       if (!pat) {
+               log_err("fio: missing pattern\n");
+               return 1;
+       }
+
+       if (strstr(pat, "0x") || strstr(pat, "0X"))
+               nr = strtol(pat, NULL, 16);
+       else
+               nr = strtol(pat, NULL, 16);
+
+       msb = fls(nr);
+       if (msb <= 8)
+               td->o.verify_pattern_bytes = 1;
+       else if (msb <= 16)
+               td->o.verify_pattern_bytes = 2;
+       else if (msb <= 24)
+               td->o.verify_pattern_bytes = 3;
+       else
+               td->o.verify_pattern_bytes = 4;
+
+       td->o.verify_pattern = nr;
+       return 0;
+}
 
 #define __stringify_1(x)       #x
 #define __stringify(x)         __stringify_1(x)
@@ -201,7 +293,9 @@ static struct fio_option options[] = {
        },
        {
                .name   = "rw",
+               .alias  = "readwrite",
                .type   = FIO_OPT_STR,
+               .cb     = str_rw_cb,
                .off1   = td_var_offset(td_ddir),
                .help   = "IO direction",
                .def    = "read",
@@ -259,6 +353,9 @@ static struct fio_option options[] = {
                          { .ival = "splice",
                            .help = "splice/vmsplice based IO",
                          },
+                         { .ival = "netsplice",
+                           .help = "splice/vmsplice to/from the network",
+                         },
 #endif
 #ifdef FIO_HAVE_SGIO
                          { .ival = "sg",
@@ -279,6 +376,11 @@ static struct fio_option options[] = {
                          { .ival = "cpuio",
                            .help = "CPU cycler burner engine",
                          },
+#ifdef FIO_HAVE_GUASI
+                         { .ival = "guasi",
+                           .help = "GUASI IO engine",
+                         },
+#endif
                          { .ival = "external",
                            .help = "Load external engine (append name)",
                          },
@@ -296,17 +398,20 @@ static struct fio_option options[] = {
                .type   = FIO_OPT_INT,
                .off1   = td_var_offset(iodepth_batch),
                .help   = "Number of IO to submit in one go",
+               .parent = "iodepth",
        },
        {
                .name   = "iodepth_low",
                .type   = FIO_OPT_INT,
                .off1   = td_var_offset(iodepth_low),
                .help   = "Low water mark for queuing depth",
+               .parent = "iodepth",
        },
        {
                .name   = "size",
                .type   = FIO_OPT_STR_VAL,
-               .off1   = td_var_offset(total_file_size),
+               .off1   = td_var_offset(size),
+               .minval = 1,
                .help   = "Total size of device or files",
        },
        {
@@ -314,37 +419,47 @@ static struct fio_option options[] = {
                .type   = FIO_OPT_STR_VAL,
                .off1   = td_var_offset(file_size_low),
                .off2   = td_var_offset(file_size_high),
+               .minval = 1,
                .help   = "Size of individual files",
        },
+       {
+               .name   = "offset",
+               .alias  = "fileoffset",
+               .type   = FIO_OPT_STR_VAL,
+               .off1   = td_var_offset(start_offset),
+               .help   = "Start IO from this offset",
+               .def    = "0",
+       },
        {
                .name   = "bs",
+               .alias  = "blocksize",
                .type   = FIO_OPT_STR_VAL_INT,
                .off1   = td_var_offset(bs[DDIR_READ]),
                .off2   = td_var_offset(bs[DDIR_WRITE]),
+               .minval = 1,
                .help   = "Block size unit",
                .def    = "4k",
+               .parent = "rw",
        },
        {
                .name   = "bsrange",
+               .alias  = "blocksize_range",
                .type   = FIO_OPT_RANGE,
                .off1   = td_var_offset(min_bs[DDIR_READ]),
                .off2   = td_var_offset(max_bs[DDIR_READ]),
                .off3   = td_var_offset(min_bs[DDIR_WRITE]),
                .off4   = td_var_offset(max_bs[DDIR_WRITE]),
+               .minval = 1,
                .help   = "Set block size range (in more detail than bs)",
+               .parent = "rw",
        },
        {
                .name   = "bs_unaligned",
+               .alias  = "blocksize_unaligned",
                .type   = FIO_OPT_STR_SET,
                .off1   = td_var_offset(bs_unaligned),
                .help   = "Don't sector align IO buffer sizes",
-       },
-       {
-               .name   = "offset",
-               .type   = FIO_OPT_STR_VAL,
-               .off1   = td_var_offset(start_offset),
-               .help   = "Start IO from this offset",
-               .def    = "0",
+               .parent = "rw",
        },
        {
                .name   = "randrepeat",
@@ -352,12 +467,14 @@ static struct fio_option options[] = {
                .off1   = td_var_offset(rand_repeatable),
                .help   = "Use repeatable random IO pattern",
                .def    = "1",
+               .parent = "rw",
        },
        {
                .name   = "norandommap",
                .type   = FIO_OPT_STR_SET,
                .off1   = td_var_offset(norandommap),
                .help   = "Accept potential duplicate random blocks",
+               .parent = "rw",
        },
        {
                .name   = "nrfiles",
@@ -389,6 +506,14 @@ static struct fio_option options[] = {
                            .help = "Round robin select files",
                          },
                },
+               .parent = "nrfiles",
+       },
+       {
+               .name   = "fadvise_hint",
+               .type   = FIO_OPT_BOOL,
+               .off1   = td_var_offset(fadvise_hint),
+               .help   = "Use fadvise() to advise the kernel on IO pattern",
+               .def    = "1",
        },
        {
                .name   = "fsync",
@@ -448,8 +573,15 @@ static struct fio_option options[] = {
                .help   = "Stop workload when this amount of time has passed",
                .def    = "0",
        },
+       {
+               .name   = "time_based",
+               .type   = FIO_OPT_STR_SET,
+               .off1   = td_var_offset(time_based),
+               .help   = "Keep running until runtime/timeout is met",
+       },
        {
                .name   = "mem",
+               .alias  = "iomem",
                .type   = FIO_OPT_STR,
                .cb     = str_mem_cb,
                .off1   = td_var_offset(mem_type),
@@ -486,6 +618,7 @@ static struct fio_option options[] = {
                .name   = "verify",
                .type   = FIO_OPT_STR,
                .off1   = td_var_offset(verify),
+               .cb     = str_verify_cb,
                .help   = "Verify data written",
                .def    = "0",
                .posval = {
@@ -493,16 +626,89 @@ static struct fio_option options[] = {
                            .oval = VERIFY_NONE,
                            .help = "Don't do IO verification",
                          },
+                         { .ival = "md5",
+                           .oval = VERIFY_MD5,
+                           .help = "Use md5 checksums for verification",
+                         },
+                         { .ival = "crc64",
+                           .oval = VERIFY_CRC64,
+                           .help = "Use crc64 checksums for verification",
+                         },
                          { .ival = "crc32",
                            .oval = VERIFY_CRC32,
                            .help = "Use crc32 checksums for verification",
                          },
-                         { .ival = "md5",
-                           .oval = VERIFY_MD5,
-                           .help = "Use md5 checksums for verification",
+                         { .ival = "crc16",
+                           .oval = VERIFY_CRC16,
+                           .help = "Use crc16 checksums for verification",
+                         },
+                         { .ival = "crc7",
+                           .oval = VERIFY_CRC7,
+                           .help = "Use crc7 checksums for verification",
+                         },
+                         { .ival = "sha256",
+                           .oval = VERIFY_SHA256,
+                           .help = "Use sha256 checksums for verification",
+                         },
+                         { .ival = "sha512",
+                           .oval = VERIFY_SHA512,
+                           .help = "Use sha512 checksums for verification",
+                         },
+                         { .ival = "meta",
+                           .oval = VERIFY_META,
+                           .help = "Use io information",
+                         },
+                         { .ival = "pattern",
+                           .oval = VERIFY_PATTERN,
+                           .help = "Verify a specific buffer pattern",
+                         },
+                         {
+                           .ival = "null",
+                           .oval = VERIFY_NULL,
+                           .help = "Pretend to verify",
                          },
                },
        },
+       {
+               .name   = "do_verify",
+               .type   = FIO_OPT_BOOL,
+               .off1   = td_var_offset(do_verify),
+               .help   = "Run verification stage after write",
+               .def    = "1",
+               .parent = "verify",
+       },
+       {
+               .name   = "verifysort",
+               .type   = FIO_OPT_BOOL,
+               .off1   = td_var_offset(verifysort),
+               .help   = "Sort written verify blocks for read back",
+               .def    = "1",
+               .parent = "verify",
+       },
+       {
+               .name   = "verify_interval",
+               .type   = FIO_OPT_STR_VAL_INT,
+               .off1   = td_var_offset(verify_interval),
+               .minval = 2 * sizeof(struct verify_header),
+               .help   = "Store verify buffer header every N bytes",
+               .parent = "verify",
+       },
+       {
+               .name   = "verify_offset",
+               .type   = FIO_OPT_STR_VAL_INT,
+               .help   = "Offset verify header location by N bytes",
+               .def    = "0",
+               .cb     = str_verify_offset_cb, 
+               .parent = "verify",
+       },
+       {
+               .name   = "verify_fatal",
+               .type   = FIO_OPT_BOOL,
+               .off1   = td_var_offset(verify_fatal),
+               .def    = "0",
+               .help   = "Exit on a single verify failure, don't continue",
+               .parent = "verify",
+       },
        {
                .name   = "write_iolog",
                .type   = FIO_OPT_STR_STORE,
@@ -556,17 +762,10 @@ static struct fio_option options[] = {
                .help   = "Lock down this amount of memory",
                .def    = "0",
        },
-       {
-               .name   = "rwmixcycle",
-               .type   = FIO_OPT_INT,
-               .off1   = td_var_offset(rwmixcycle),
-               .help   = "Cycle period for mixed read/write workloads (msec)",
-               .def    = "500",
-       },
        {
                .name   = "rwmixread",
                .type   = FIO_OPT_INT,
-               .off1   = td_var_offset(rwmixread),
+               .off1   = td_var_offset(rwmix[DDIR_READ]),
                .maxval = 100,
                .help   = "Percentage of mixed workload that is reads",
                .def    = "50",
@@ -574,11 +773,19 @@ static struct fio_option options[] = {
        {
                .name   = "rwmixwrite",
                .type   = FIO_OPT_INT,
-               .off1   = td_var_offset(rwmixwrite),
+               .off1   = td_var_offset(rwmix[DDIR_WRITE]),
                .maxval = 100,
                .help   = "Percentage of mixed workload that is writes",
                .def    = "50",
        },
+       {
+               .name   = "rwmixcycle",
+               .type   = FIO_OPT_INT,
+               .off1   = td_var_offset(rwmixcycle),
+               .help   = "Cycle period for mixed read/write workloads (msec)",
+               .def    = "500",
+               .parent = "rwmixread",
+       },
        {
                .name   = "nice",
                .type   = FIO_OPT_INT,
@@ -619,6 +826,7 @@ static struct fio_option options[] = {
                .off1   = td_var_offset(thinktime_spin),
                .help   = "Start think time by spinning this amount (usec)",
                .def    = "0",
+               .parent = "thinktime",
        },
        {
                .name   = "thinktime_blocks",
@@ -626,6 +834,7 @@ static struct fio_option options[] = {
                .off1   = td_var_offset(thinktime_blocks),
                .help   = "IO buffer period between 'thinktime'",
                .def    = "1",
+               .parent = "thinktime",
        },
        {
                .name   = "rate",
@@ -637,7 +846,21 @@ static struct fio_option options[] = {
                .name   = "ratemin",
                .type   = FIO_OPT_INT,
                .off1   = td_var_offset(ratemin),
-               .help   = "The bottom limit accepted",
+               .help   = "Job must meet this rate or it will be shutdown",
+               .parent = "rate",
+       },
+       {
+               .name   = "rate_iops",
+               .type   = FIO_OPT_INT,
+               .off1   = td_var_offset(rate_iops),
+               .help   = "Limit IO used to this number of IO operations/sec",
+       },
+       {
+               .name   = "rate_iops_min",
+               .type   = FIO_OPT_INT,
+               .off1   = td_var_offset(rate_iops_min),
+               .help   = "Job must meet this rate or it will be shutdown",
+               .parent = "rate_iops",
        },
        {
                .name   = "ratecycle",
@@ -645,6 +868,7 @@ static struct fio_option options[] = {
                .off1   = td_var_offset(ratecycle),
                .help   = "Window average for rate limits (msec)",
                .def    = "1000",
+               .parent = "rate",
        },
        {
                .name   = "invalidate",
@@ -659,6 +883,7 @@ static struct fio_option options[] = {
                .off1   = td_var_offset(sync_io),
                .help   = "Use O_SYNC for buffered writes",
                .def    = "0",
+               .parent = "buffered",
        },
        {
                .name   = "bwavgtime",
@@ -693,6 +918,7 @@ static struct fio_option options[] = {
                .off1   = td_var_offset(cpucycle),
                .help   = "Length of the CPU burn cycles (usecs)",
                .def    = "50000",
+               .parent = "cpuload",
        },
 #ifdef FIO_HAVE_CPU_AFFINITY
        {
@@ -701,6 +927,12 @@ static struct fio_option options[] = {
                .cb     = str_cpumask_cb,
                .help   = "CPU affinity mask",
        },
+       {
+               .name   = "cpus_allowed",
+               .type   = FIO_OPT_STR,
+               .cb     = str_cpus_allowed_cb,
+               .help   = "Set CPUs allowed",
+       },
 #endif
        {
                .name   = "end_fsync",
@@ -735,6 +967,12 @@ static struct fio_option options[] = {
                .off1   = td_var_offset(stonewall),
                .help   = "Insert a hard barrier between this job and previous",
        },
+       {
+               .name   = "new_group",
+               .type   = FIO_OPT_STR_SET,
+               .off1   = td_var_offset(new_group),
+               .help   = "Mark the start of a new group (for reporting)",
+       },
        {
                .name   = "thread",
                .type   = FIO_OPT_STR_SET,
@@ -766,6 +1004,21 @@ static struct fio_option options[] = {
                .off1   = td_var_offset(group_reporting),
                .help   = "Do reporting on a per-group basis",
        },
+       {
+               .name   = "zero_buffers",
+               .type   = FIO_OPT_STR_SET,
+               .off1   = td_var_offset(zero_buffers),
+               .help   = "Init IO buffers to all zeroes",
+       },
+#ifdef FIO_HAVE_DISK_UTIL
+       {
+               .name   = "disk_util",
+               .type   = FIO_OPT_BOOL,
+               .off1   = td_var_offset(do_disk_util),
+               .help   = "Log disk utilization stats",
+               .def    = "1",
+       },
+#endif
        {
                .name = NULL,
        },
@@ -816,3 +1069,41 @@ int fio_show_option_help(const char *opt)
 {
        return show_cmd_help(options, opt);
 }
+
+static void __options_mem(struct thread_data *td, int alloc)
+{
+       struct thread_options *o = &td->o;
+       struct fio_option *opt;
+       char **ptr;
+       int i;
+
+       for (i = 0, opt = &options[0]; opt->name; i++, opt = &options[i]) {
+               if (opt->type != FIO_OPT_STR_STORE)
+                       continue;
+
+               ptr = (void *) o + opt->off1;
+               if (*ptr) {
+                       if (alloc)
+                               *ptr = strdup(*ptr);
+                       else {
+                               free(*ptr);
+                               *ptr = NULL;
+                       }
+               }
+       }
+}
+
+/*
+ * dupe FIO_OPT_STR_STORE options
+ */
+void options_mem_dupe(struct thread_data *td)
+{
+       __options_mem(td, 1);
+}
+
+void options_mem_free(struct thread_data fio_unused *td)
+{
+#if 0
+       __options_mem(td, 0);
+#endif
+}