stats: Add a function to report completion latency percentiles
[fio.git] / options.c
index 9718dc56cb0d42871be7c3cc1a52b4b73ff0af27..3d8a720469655d82520bfe6e70d83bf5a0fde914 100644 (file)
--- a/options.c
+++ b/options.c
@@ -329,7 +329,7 @@ static int str_cpumask_cb(void *data, unsigned long long *val)
                return 1;
        }
 
-       max_cpu = sysconf(_SC_NPROCESSORS_ONLN);
+       max_cpu = cpus_online();
 
        for (i = 0; i < sizeof(int) * 8; i++) {
                if ((1 << i) & *val) {
@@ -366,7 +366,7 @@ static int set_cpus_allowed(struct thread_data *td, os_cpu_mask_t *mask,
        strip_blank_front(&str);
        strip_blank_end(str);
 
-       max_cpu = sysconf(_SC_NPROCESSORS_ONLN);
+       max_cpu = cpus_online();
 
        while ((cpu = strsep(&str, ",")) != NULL) {
                char *str2, *cpu2;
@@ -440,6 +440,16 @@ static int str_verify_cpus_allowed_cb(void *data, const char *input)
 }
 #endif
 
+#ifdef FIO_HAVE_TRIM
+static int str_verify_trim_cb(void *data, unsigned long long *val)
+{
+       struct thread_data *td = data;
+
+       td->o.trim_percentage = *val;
+       return 0;
+}
+#endif
+
 static int str_fst_cb(void *data, const char *str)
 {
        struct thread_data *td = data;
@@ -472,6 +482,7 @@ static int str_sfr_cb(void *data, const char *str)
 
 static int check_dir(struct thread_data *td, char *fname)
 {
+#if 0
        char file[PATH_MAX], *dir;
        int elen = 0;
 
@@ -484,7 +495,6 @@ static int check_dir(struct thread_data *td, char *fname)
        sprintf(file + elen, "%s", fname);
        dir = dirname(file);
 
-#if 0
        {
        struct stat sb;
        /*
@@ -665,6 +675,11 @@ static int str_verify_pattern_cb(void *data, const char *input)
                }
        }
        td->o.verify_pattern_bytes = i;
+       /*
+        * VERIFY_META could already be set
+        */
+       if (td->o.verify == VERIFY_NONE)
+               td->o.verify = VERIFY_PATTERN;
        return 0;
 }
 
@@ -729,6 +744,20 @@ static int str_gtod_cpu_cb(void *data, long long *il)
        return 0;
 }
 
+static int str_size_cb(void *data, unsigned long long *__val)
+{
+       struct thread_data *td = data;
+       unsigned long long v = *__val;
+
+       if (parse_is_percent(v)) {
+               td->o.size = 0;
+               td->o.size_percent = -1ULL - v;
+       } else
+               td->o.size = v;
+
+       return 0;
+}
+
 static int rw_verify(struct fio_option *o, void *data)
 {
        struct thread_data *td = data;
@@ -903,7 +932,7 @@ static struct fio_option options[FIO_MAX_OPTS] = {
                .type   = FIO_OPT_STR_STORE,
                .off1   = td_var_offset(ioengine),
                .help   = "IO engine to use",
-               .def    = "sync",
+               .def    = FIO_PREFERRED_ENGINE,
                .posval = {
                          { .ival = "sync",
                            .help = "Use read/write",
@@ -912,7 +941,7 @@ static struct fio_option options[FIO_MAX_OPTS] = {
                            .help = "Use pread/pwrite",
                          },
                          { .ival = "vsync",
-                            .help = "Use readv/writev",
+                           .help = "Use readv/writev",
                          },
 #ifdef FIO_HAVE_LIBAIO
                          { .ival = "libaio",
@@ -928,9 +957,14 @@ static struct fio_option options[FIO_MAX_OPTS] = {
                          { .ival = "solarisaio",
                            .help = "Solaris native asynchronous IO",
                          },
+#endif
+#ifdef FIO_HAVE_WINDOWSAIO
+                         { .ival = "windowsaio",
+                           .help = "Windows native asynchronous IO"
+                         },
 #endif
                          { .ival = "mmap",
-                           .help = "Memory mapped IO",
+                           .help = "Memory mapped IO"
                          },
 #ifdef FIO_HAVE_SPLICE
                          { .ival = "splice",
@@ -957,12 +991,22 @@ static struct fio_option options[FIO_MAX_OPTS] = {
                          },
 #endif
                          { .ival = "cpuio",
-                           .help = "CPU cycler burner engine",
+                           .help = "CPU cycle burner engine",
                          },
 #ifdef FIO_HAVE_GUASI
                          { .ival = "guasi",
                            .help = "GUASI IO engine",
                          },
+#endif
+#ifdef FIO_HAVE_BINJECT
+                         { .ival = "binject",
+                           .help = "binject direct inject block engine",
+                         },
+#endif
+#ifdef FIO_HAVE_RDMA
+                         { .ival = "rdma",
+                           .help = "RDMA IO engine",
+                         },
 #endif
                          { .ival = "external",
                            .help = "Load external engine (append name)",
@@ -973,7 +1017,7 @@ static struct fio_option options[FIO_MAX_OPTS] = {
                .name   = "iodepth",
                .type   = FIO_OPT_INT,
                .off1   = td_var_offset(iodepth),
-               .help   = "Amount of IO buffers to keep in flight",
+               .help   = "Number of IO buffers to keep in flight",
                .minval = 1,
                .def    = "1",
        },
@@ -1006,12 +1050,12 @@ static struct fio_option options[FIO_MAX_OPTS] = {
        {
                .name   = "size",
                .type   = FIO_OPT_STR_VAL,
-               .off1   = td_var_offset(size),
-               .minval = 1,
+               .cb     = str_size_cb,
                .help   = "Total size of device or files",
        },
        {
                .name   = "fill_device",
+               .alias  = "fill_fs",
                .type   = FIO_OPT_BOOL,
                .off1   = td_var_offset(fill_device),
                .help   = "Write until an ENOSPC error occurs",
@@ -1089,6 +1133,14 @@ static struct fio_option options[FIO_MAX_OPTS] = {
                .def    = "1",
                .parent = "rw",
        },
+       {
+               .name   = "use_os_rand",
+               .type   = FIO_OPT_BOOL,
+               .off1   = td_var_offset(use_os_rand),
+               .help   = "Set to use OS random generator",
+               .def    = "0",
+               .parent = "rw",
+       },
        {
                .name   = "norandommap",
                .type   = FIO_OPT_STR_SET,
@@ -1106,6 +1158,7 @@ static struct fio_option options[FIO_MAX_OPTS] = {
        },
        {
                .name   = "nrfiles",
+               .alias  = "nr_files",
                .type   = FIO_OPT_INT,
                .off1   = td_var_offset(nr_files),
                .help   = "Split job workload between this number of files",
@@ -1143,12 +1196,37 @@ static struct fio_option options[FIO_MAX_OPTS] = {
 #ifdef FIO_HAVE_FALLOCATE
        {
                .name   = "fallocate",
-               .type   = FIO_OPT_BOOL,
-               .off1   = td_var_offset(fallocate),
-               .help   = "Use fallocate() when laying out files",
-               .def    = "1",
-       },
+               .type   = FIO_OPT_STR,
+               .off1   = td_var_offset(fallocate_mode),
+               .help   = "Whether pre-allocation is performed when laying out files",
+               .def    = "posix",
+               .posval = {
+                         { .ival = "none",
+                           .oval = FIO_FALLOCATE_NONE,
+                           .help = "Do not pre-allocate space",
+                         },
+                         { .ival = "posix",
+                           .oval = FIO_FALLOCATE_POSIX,
+                           .help = "Use posix_fallocate()",
+                         },
+#ifdef FIO_HAVE_LINUX_FALLOCATE
+                         { .ival = "keep",
+                           .oval = FIO_FALLOCATE_KEEP_SIZE,
+                           .help = "Use fallocate(..., FALLOC_FL_KEEP_SIZE, ...)",
+                         },
 #endif
+                         /* Compatibility with former boolean values */
+                         { .ival = "0",
+                           .oval = FIO_FALLOCATE_NONE,
+                           .help = "Alias for 'none'",
+                         },
+                         { .ival = "1",
+                           .oval = FIO_FALLOCATE_POSIX,
+                           .help = "Alias for 'posix'",
+                         },
+               },
+       },
+#endif /* FIO_HAVE_FALLOCATE */
        {
                .name   = "fadvise_hint",
                .type   = FIO_OPT_BOOL,
@@ -1170,6 +1248,13 @@ static struct fio_option options[FIO_MAX_OPTS] = {
                .help   = "Issue fdatasync for writes every given number of blocks",
                .def    = "0",
        },
+       {
+               .name   = "write_barrier",
+               .type   = FIO_OPT_INT,
+               .off1   = td_var_offset(barrier_blocks),
+               .help   = "Make every Nth write a barrier write",
+               .def    = "0",
+       },
 #ifdef FIO_HAVE_SYNC_FILE_RANGE
        {
                .name   = "sync_file_range",
@@ -1438,6 +1523,14 @@ static struct fio_option options[FIO_MAX_OPTS] = {
                .help   = "Exit on a single verify failure, don't continue",
                .parent = "verify",
        },
+       {
+               .name   = "verify_dump",
+               .type   = FIO_OPT_BOOL,
+               .off1   = td_var_offset(verify_dump),
+               .def    = "1",
+               .help   = "Dump contents of good and bad blocks on failure",
+               .parent = "verify",
+       },
        {
                .name   = "verify_async",
                .type   = FIO_OPT_INT,
@@ -1458,7 +1551,7 @@ static struct fio_option options[FIO_MAX_OPTS] = {
                .type   = FIO_OPT_INT,
                .off1   = td_var_offset(verify_batch),
                .help   = "Verify this number of IO blocks",
-               .parent = "verify_backlog",
+               .parent = "verify",
        },
 #ifdef FIO_HAVE_CPU_AFFINITY
        {
@@ -1468,6 +1561,39 @@ static struct fio_option options[FIO_MAX_OPTS] = {
                .help   = "Set CPUs allowed for async verify threads",
                .parent = "verify_async",
        },
+#endif
+#ifdef FIO_HAVE_TRIM
+       {
+               .name   = "trim_percentage",
+               .type   = FIO_OPT_INT,
+               .cb     = str_verify_trim_cb,
+               .maxval = 100,
+               .help   = "Number of verify blocks to discard/trim",
+               .parent = "verify",
+               .def    = "0",
+       },
+       {
+               .name   = "trim_verify_zero",
+               .type   = FIO_OPT_INT,
+               .help   = "Verify that trim/discarded blocks are returned as zeroes",
+               .off1   = td_var_offset(trim_zero),
+               .parent = "trim_percentage",
+               .def    = "1",
+       },
+       {
+               .name   = "trim_backlog",
+               .type   = FIO_OPT_STR_VAL,
+               .off1   = td_var_offset(trim_backlog),
+               .help   = "Trim after this number of blocks are written",
+               .parent = "trim_percentage",
+       },
+       {
+               .name   = "trim_backlog_batch",
+               .type   = FIO_OPT_INT,
+               .off1   = td_var_offset(trim_batch),
+               .help   = "Trim this number of IO blocks",
+               .parent = "trim_percentage",
+       },
 #endif
        {
                .name   = "write_iolog",
@@ -1489,6 +1615,13 @@ static struct fio_option options[FIO_MAX_OPTS] = {
                .parent = "read_iolog",
                .help   = "Playback IO pattern file as fast as possible without stalls",
        },
+       {
+               .name   = "replay_redirect",
+               .type   = FIO_OPT_STR_STORE,
+               .off1   = td_var_offset(replay_redirect),
+               .parent = "read_iolog",
+               .help   = "Replay all I/O onto this device, regardless of trace device",
+       },
        {
                .name   = "exec_prerun",
                .type   = FIO_OPT_STR_STORE,
@@ -1627,7 +1760,7 @@ static struct fio_option options[FIO_MAX_OPTS] = {
                .type   = FIO_OPT_INT,
                .off1   = td_var_offset(rate_iops_min[0]),
                .off2   = td_var_offset(rate_iops_min[1]),
-               .help   = "Job must meet this rate or it will be shutdown",
+               .help   = "Job must meet this rate or it will be shut down",
                .parent = "rate_iops",
        },
        {
@@ -1672,7 +1805,7 @@ static struct fio_option options[FIO_MAX_OPTS] = {
                .name   = "create_fsync",
                .type   = FIO_OPT_BOOL,
                .off1   = td_var_offset(create_fsync),
-               .help   = "Fsync file after creation",
+               .help   = "fsync file after creation",
                .def    = "1",
        },
        {
@@ -1686,7 +1819,7 @@ static struct fio_option options[FIO_MAX_OPTS] = {
                .name   = "pre_read",
                .type   = FIO_OPT_BOOL,
                .off1   = td_var_offset(pre_read),
-               .help   = "Preread files before starting official testing",
+               .help   = "Pre-read files before starting official testing",
                .def    = "0",
        },
        {
@@ -1746,6 +1879,7 @@ static struct fio_option options[FIO_MAX_OPTS] = {
        },
        {
                .name   = "stonewall",
+               .alias  = "wait_for_previous",
                .type   = FIO_OPT_STR_SET,
                .off1   = td_var_offset(stonewall),
                .help   = "Insert a hard barrier between this job and previous",
@@ -1801,6 +1935,24 @@ static struct fio_option options[FIO_MAX_OPTS] = {
                .off1   = td_var_offset(refill_buffers),
                .help   = "Refill IO buffers on every IO submit",
        },
+       {
+               .name   = "clat_percentiles",
+               .type   = FIO_OPT_BOOL,
+               .off1   = td_var_offset(clat_percentiles),
+               .help   = "Enable the reporting of completion latency percentiles",
+               .def    = "0",
+       },
+       {
+               .name   = "percentile_list",
+               .type   = FIO_OPT_FLOAT_LIST,
+               .off1   = td_var_offset(percentile_list),
+               .off2   = td_var_offset(overwrite_plist),
+               .help   = "Specify a custom list of percentiles to report",
+               .maxlen = FIO_IO_U_LIST_MAX_LEN,
+               .minfp  = 0.0,
+               .maxfp  = 100.0,
+       },
+
 #ifdef FIO_HAVE_DISK_UTIL
        {
                .name   = "disk_util",
@@ -1837,7 +1989,7 @@ static struct fio_option options[FIO_MAX_OPTS] = {
                .name   = "disable_slat",
                .type   = FIO_OPT_BOOL,
                .off1   = td_var_offset(disable_slat),
-               .help   = "Disable submissionn latency numbers",
+               .help   = "Disable submission latency numbers",
                .parent = "gtod_reduce",
                .def    = "0",
        },
@@ -1853,14 +2005,14 @@ static struct fio_option options[FIO_MAX_OPTS] = {
                .name   = "gtod_cpu",
                .type   = FIO_OPT_INT,
                .cb     = str_gtod_cpu_cb,
-               .help   = "Setup dedicated gettimeofday() thread on this CPU",
+               .help   = "Set up dedicated gettimeofday() thread on this CPU",
                .verify = gtod_cpu_verify,
        },
        {
                .name   = "continue_on_error",
                .type   = FIO_OPT_BOOL,
                .off1   = td_var_offset(continue_on_error),
-               .help   = "Continue on non-fatal errors during I/O",
+               .help   = "Continue on non-fatal errors during IO",
                .def    = "0",
        },
        {
@@ -1976,11 +2128,11 @@ void fio_keywords_init(void)
        sprintf(buf, "%lu", page_size);
        fio_keywords[0].replace = strdup(buf);
 
-       mb_memory = os_phys_mem() / page_size;
+       mb_memory = os_phys_mem() / (1024 * 1024);
        sprintf(buf, "%llu", mb_memory);
        fio_keywords[1].replace = strdup(buf);
 
-       l = sysconf(_SC_NPROCESSORS_ONLN);
+       l = cpus_online();
        sprintf(buf, "%lu", l);
        fio_keywords[2].replace = strdup(buf);
 }