Initial support for explicit write barriers
[fio.git] / options.c
index 6cfd80d14fac4c8abeff89bd49eab731fdfd1b8f..d111018820603fe0e3a578524872343929411ce8 100644 (file)
--- a/options.c
+++ b/options.c
@@ -3,7 +3,6 @@
 #include <unistd.h>
 #include <ctype.h>
 #include <string.h>
-#include <getopt.h>
 #include <assert.h>
 #include <libgen.h>
 #include <fcntl.h>
@@ -16,7 +15,7 @@
 #include "lib/fls.h"
 #include "options.h"
 
-static FLIST_HEAD(ext_opt_list);
+#include "crc/crc32c.h"
 
 /*
  * Check if mmap/mmaphuge has a :/foo/bar/file at the end. If so, return that.
@@ -203,9 +202,9 @@ 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;
+       td->o.ddir_seq_nr = 1;
        if (nr) {
-               td->o.ddir_nr = atoi(nr);
+               td->o.ddir_seq_nr = atoi(nr);
                free(nr);
        }
 
@@ -227,13 +226,37 @@ static int str_mem_cb(void *data, const char *mem)
        return 0;
 }
 
-static int str_lockmem_cb(void fio_unused *data, unsigned long *val)
+static int str_verify_cb(void *data, const char *mem)
+{
+       struct thread_data *td = data;
+
+       if (td->o.verify != VERIFY_CRC32C_INTEL)
+               return 0;
+
+       if (!crc32c_intel_works()) {
+               log_info("fio: System does not support hw accelerated crc32c. Falling back to sw crc32c.\n");
+               td->o.verify = VERIFY_CRC32C;
+       }
+
+       return 0;
+}
+
+static int fio_clock_source_cb(void *data, const char *str)
+{
+       struct thread_data *td = data;
+
+       fio_clock_source = td->o.clocksource;
+       fio_time_init();
+       return 0;
+}
+
+static int str_lockmem_cb(void fio_unused *data, unsigned long long *val)
 {
        mlock_size = *val;
        return 0;
 }
 
-static int str_rwmix_read_cb(void *data, unsigned int *val)
+static int str_rwmix_read_cb(void *data, unsigned long long *val)
 {
        struct thread_data *td = data;
 
@@ -242,7 +265,7 @@ static int str_rwmix_read_cb(void *data, unsigned int *val)
        return 0;
 }
 
-static int str_rwmix_write_cb(void *data, unsigned int *val)
+static int str_rwmix_write_cb(void *data, unsigned long long *val)
 {
        struct thread_data *td = data;
 
@@ -252,7 +275,7 @@ static int str_rwmix_write_cb(void *data, unsigned int *val)
 }
 
 #ifdef FIO_HAVE_IOPRIO
-static int str_prioclass_cb(void *data, unsigned int *val)
+static int str_prioclass_cb(void *data, unsigned long long *val)
 {
        struct thread_data *td = data;
        unsigned short mask;
@@ -268,7 +291,7 @@ static int str_prioclass_cb(void *data, unsigned int *val)
        return 0;
 }
 
-static int str_prio_cb(void *data, unsigned int *val)
+static int str_prio_cb(void *data, unsigned long long *val)
 {
        struct thread_data *td = data;
 
@@ -292,7 +315,7 @@ static int str_exitall_cb(void)
 }
 
 #ifdef FIO_HAVE_CPU_AFFINITY
-static int str_cpumask_cb(void *data, unsigned int *val)
+static int str_cpumask_cb(void *data, unsigned long long *val)
 {
        struct thread_data *td = data;
        unsigned int i;
@@ -417,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;
@@ -431,6 +464,22 @@ static int str_fst_cb(void *data, const char *str)
        return 0;
 }
 
+#ifdef FIO_HAVE_SYNC_FILE_RANGE
+static int str_sfr_cb(void *data, const char *str)
+{
+       struct thread_data *td = data;
+       char *nr = get_opt_postfix(str);
+
+       td->sync_file_range_nr = 1;
+       if (nr) {
+               td->sync_file_range_nr = atoi(nr);
+               free(nr);
+       }
+
+       return 0;
+}
+#endif
+
 static int check_dir(struct thread_data *td, char *fname)
 {
        char file[PATH_MAX], *dir;
@@ -574,7 +623,7 @@ static int str_opendir_cb(void *data, const char fio_unused *str)
        return add_dir_files(td, td->o.opendir);
 }
 
-static int str_verify_offset_cb(void *data, unsigned int *off)
+static int str_verify_offset_cb(void *data, unsigned long long *off)
 {
        struct thread_data *td = data;
 
@@ -670,6 +719,7 @@ static int str_gtod_reduce_cb(void *data, int *il)
        struct thread_data *td = data;
        int val = *il;
 
+       td->o.disable_lat = !!val;
        td->o.disable_clat = !!val;
        td->o.disable_slat = !!val;
        td->o.disable_bw = !!val;
@@ -679,7 +729,7 @@ static int str_gtod_reduce_cb(void *data, int *il)
        return 0;
 }
 
-static int str_gtod_cpu_cb(void *data, int *il)
+static int str_gtod_cpu_cb(void *data, long long *il)
 {
        struct thread_data *td = data;
        int val = *il;
@@ -736,7 +786,7 @@ static int kb_base_verify(struct fio_option *o, void *data)
 /*
  * Map of job/command line options
  */
-static struct fio_option options[] = {
+static struct fio_option options[FIO_MAX_OPTS] = {
        {
                .name   = "description",
                .type   = FIO_OPT_STR_STORE,
@@ -840,6 +890,24 @@ static struct fio_option options[] = {
                          },
                },
        },
+       {
+               .name   = "rw_sequencer",
+               .type   = FIO_OPT_STR,
+               .off1   = td_var_offset(rw_seq),
+               .help   = "IO offset generator modifier",
+               .def    = "sequential",
+               .posval = {
+                         { .ival = "sequential",
+                           .oval = RW_SEQ_SEQ,
+                           .help = "Generate sequential offsets",
+                         },
+                         { .ival = "identical",
+                           .oval = RW_SEQ_IDENT,
+                           .help = "Generate identical offsets",
+                         },
+               },
+       },
+
        {
                .name   = "ioengine",
                .type   = FIO_OPT_STR_STORE,
@@ -905,6 +973,11 @@ static struct fio_option options[] = {
                          { .ival = "guasi",
                            .help = "GUASI IO engine",
                          },
+#endif
+#ifdef FIO_HAVE_BINJECT
+                         { .ival = "binject",
+                           .help = "binject direct inject block engine",
+                         },
 #endif
                          { .ival = "external",
                            .help = "Load external engine (append name)",
@@ -1112,6 +1185,40 @@ static struct fio_option options[] = {
                .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",
+               .posval = {
+                         { .ival = "wait_before",
+                           .oval = SYNC_FILE_RANGE_WAIT_BEFORE,
+                           .help = "SYNC_FILE_RANGE_WAIT_BEFORE",
+                           .or   = 1,
+                         },
+                         { .ival = "write",
+                           .oval = SYNC_FILE_RANGE_WRITE,
+                           .help = "SYNC_FILE_RANGE_WRITE",
+                           .or   = 1,
+                         },
+                         {
+                           .ival = "wait_after",
+                           .oval = SYNC_FILE_RANGE_WAIT_AFTER,
+                           .help = "SYNC_FILE_RANGE_WAIT_AFTER",
+                           .or   = 1,
+                         },
+               },
+               .type   = FIO_OPT_STR_MULTI,
+               .cb     = str_sfr_cb,
+               .off1   = td_var_offset(sync_file_range),
+               .help   = "Use sync_file_range()",
+       },
+#endif
        {
                .name   = "direct",
                .type   = FIO_OPT_BOOL,
@@ -1150,7 +1257,7 @@ static struct fio_option options[] = {
        },
        {
                .name   = "startdelay",
-               .type   = FIO_OPT_INT,
+               .type   = FIO_OPT_STR_VAL_TIME,
                .off1   = td_var_offset(start_delay),
                .help   = "Only start job when this period has passed",
                .def    = "0",
@@ -1175,6 +1282,29 @@ static struct fio_option options[] = {
                .off1   = td_var_offset(ramp_time),
                .help   = "Ramp up time before measuring performance",
        },
+       {
+               .name   = "clocksource",
+               .type   = FIO_OPT_STR,
+               .cb     = fio_clock_source_cb,
+               .off1   = td_var_offset(clocksource),
+               .help   = "What type of timing source to use",
+               .posval = {
+                         { .ival = "gettimeofday",
+                           .oval = CS_GTOD,
+                           .help = "Use gettimeofday(2) for timing",
+                         },
+                         { .ival = "clock_gettime",
+                           .oval = CS_CGETTIME,
+                           .help = "Use clock_gettime(2) for timing",
+                         },
+#ifdef ARCH_HAVE_CPU_CLOCK
+                         { .ival = "cpu",
+                           .oval = CS_CPUCLOCK,
+                           .help = "Use CPU private clock",
+                         },
+#endif
+               },
+       },
        {
                .name   = "mem",
                .alias  = "iomem",
@@ -1225,6 +1355,7 @@ static struct fio_option options[] = {
                .type   = FIO_OPT_STR,
                .off1   = td_var_offset(verify),
                .help   = "Verify data written",
+               .cb     = str_verify_cb,
                .def    = "0",
                .posval = {
                          { .ival = "0",
@@ -1337,6 +1468,20 @@ static struct fio_option options[] = {
                .help   = "Number of async verifier threads to use",
                .parent = "verify",
        },
+       {
+               .name   = "verify_backlog",
+               .type   = FIO_OPT_STR_VAL,
+               .off1   = td_var_offset(verify_backlog),
+               .help   = "Verify after this number of blocks are written",
+               .parent = "verify",
+       },
+       {
+               .name   = "verify_backlog_batch",
+               .type   = FIO_OPT_INT,
+               .off1   = td_var_offset(verify_batch),
+               .help   = "Verify this number of IO blocks",
+               .parent = "verify",
+       },
 #ifdef FIO_HAVE_CPU_AFFINITY
        {
                .name   = "verify_async_cpus",
@@ -1345,6 +1490,39 @@ static struct fio_option options[] = {
                .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",
@@ -1358,6 +1536,21 @@ static struct fio_option options[] = {
                .off1   = td_var_offset(read_iolog_file),
                .help   = "Playback IO pattern from file",
        },
+       {
+               .name   = "replay_no_stall",
+               .type   = FIO_OPT_INT,
+               .off1   = td_var_offset(no_stall),
+               .def    = "0",
+               .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,
@@ -1686,6 +1879,14 @@ static struct fio_option options[] = {
                .cb     = str_gtod_reduce_cb,
                .def    = "0",
        },
+       {
+               .name   = "disable_lat",
+               .type   = FIO_OPT_BOOL,
+               .off1   = td_var_offset(disable_lat),
+               .help   = "Disable latency numbers",
+               .parent = "gtod_reduce",
+               .def    = "0",
+       },
        {
                .name   = "disable_clat",
                .type   = FIO_OPT_BOOL,
@@ -1744,6 +1945,13 @@ static struct fio_option options[] = {
                .minval = 100,
                .maxval = 1000,
        },
+       {
+               .name   = "cgroup_nodelete",
+               .type   = FIO_OPT_BOOL,
+               .off1   = td_var_offset(cgroup_nodelete),
+               .help   = "Do not delete cgroups after job completion",
+               .def    = "0",
+       },
        {
                .name   = "uid",
                .type   = FIO_OPT_INT,
@@ -1761,9 +1969,10 @@ static struct fio_option options[] = {
        },
 };
 
-static void add_to_lopt(struct option *lopt, struct fio_option *o)
+static void add_to_lopt(struct option *lopt, struct fio_option *o,
+                       const char *name)
 {
-       lopt->name = (char *) o->name;
+       lopt->name = (char *) name;
        lopt->val = FIO_GETOPT_JOB;
        if (o->type == FIO_OPT_STR_SET)
                lopt->has_arg = no_argument;
@@ -1774,8 +1983,6 @@ static void add_to_lopt(struct option *lopt, struct fio_option *o)
 void fio_options_dup_and_init(struct option *long_options)
 {
        struct fio_option *o;
-       struct ext_option *eo;
-       struct flist_head *n;
        unsigned int i;
 
        options_init(options);
@@ -1786,19 +1993,16 @@ void fio_options_dup_and_init(struct option *long_options)
 
        o = &options[0];
        while (o->name) {
-               add_to_lopt(&long_options[i], o);
+               add_to_lopt(&long_options[i], o, o->name);
+               if (o->alias) {
+                       i++;
+                       add_to_lopt(&long_options[i], o, o->alias);
+               }
 
                i++;
                o++;
                assert(i < FIO_NR_OPTIONS);
        }
-
-       flist_for_each(n, &ext_opt_list) {
-               eo = flist_entry(n, struct ext_option, list);
-               add_to_lopt(&long_options[i], &eo->o);
-               i++;
-               assert(i < FIO_NR_OPTIONS);
-       }
 }
 
 struct fio_keyword {
@@ -1955,7 +2159,7 @@ int fio_options_parse(struct thread_data *td, char **opts, int num_opts)
 
        for (ret = 0, i = 0; i < num_opts; i++) {
                opts[i] = fio_keyword_replace(opts[i]);
-               ret |= parse_option(opts[i], options, &ext_opt_list, td);
+               ret |= parse_option(opts[i], options, td);
        }
 
        return ret;
@@ -1963,7 +2167,7 @@ int fio_options_parse(struct thread_data *td, char **opts, int num_opts)
 
 int fio_cmd_option_parse(struct thread_data *td, const char *opt, char *val)
 {
-       return parse_cmd_option(opt, val, options, &ext_opt_list, td);
+       return parse_cmd_option(opt, val, options, td);
 }
 
 void fio_fill_default_options(struct thread_data *td)
@@ -1973,7 +2177,7 @@ void fio_fill_default_options(struct thread_data *td)
 
 int fio_show_option_help(const char *opt)
 {
-       return show_cmd_help(options, &ext_opt_list, opt);
+       return show_cmd_help(options, opt);
 }
 
 static void __options_mem(struct thread_data *td, int alloc)
@@ -2027,23 +2231,70 @@ unsigned int fio_get_kb_base(void *data)
        return kb_base;
 }
 
-void register_ext_option(struct ext_option *eopt)
+int add_option(struct fio_option *o)
+{
+       struct fio_option *__o;
+       int opt_index = 0;
+
+       __o = options;
+       while (__o->name) {
+               opt_index++;
+               __o++;
+       }
+
+       memcpy(&options[opt_index], o, sizeof(*o));
+       return 0;
+}
+
+void invalidate_profile_options(const char *prof_name)
+{
+       struct fio_option *o;
+
+       o = options;
+       while (o->name) {
+               if (o->prof_name && !strcmp(o->prof_name, prof_name)) {
+                       o->type = FIO_OPT_INVALID;
+                       o->prof_name = NULL;
+               }
+               o++;
+       }
+}
+
+void add_opt_posval(const char *optname, const char *ival, const char *help)
 {
-       dprint(FD_PARSE, "register option '%s'\n", eopt->o.name);
-       option_init(&eopt->o);
-       flist_add_tail(&eopt->list, &ext_opt_list);
+       struct fio_option *o;
+       unsigned int i;
+
+       o = find_option(options, optname);
+       if (!o)
+               return;
+
+       for (i = 0; i < PARSE_MAX_VP; i++) {
+               if (o->posval[i].ival)
+                       continue;
+
+               o->posval[i].ival = ival;
+               o->posval[i].help = help;
+               break;
+       }
 }
 
-void prune_profile_options(const char *prof_name)
+void del_opt_posval(const char *optname, const char *ival)
 {
-       struct ext_option *eo;
-       struct flist_head *n, *tmp;
+       struct fio_option *o;
+       unsigned int i;
+
+       o = find_option(options, optname);
+       if (!o)
+               return;
 
-       flist_for_each_safe(n, tmp, &ext_opt_list) {
-               eo = flist_entry(n, struct ext_option, list);
-               if (strcmp(eo->prof_name, prof_name))
+       for (i = 0; i < PARSE_MAX_VP; i++) {
+               if (!o->posval[i].ival)
                        continue;
-               flist_del(&eo->list);
-               free(eo);
+               if (strcmp(o->posval[i].ival, ival))
+                       continue;
+
+               o->posval[i].ival = NULL;
+               o->posval[i].help = NULL;
        }
 }