[PATCH] Add support for writing aggregate bandwidth log
[fio.git] / init.c
diff --git a/init.c b/init.c
index 37b84e68bb1ded485f828e4843bfeacbd3863e0c..365a8b2cc0a97651eaf5cad0fd6e7f5db089d43f 100644 (file)
--- a/init.c
+++ b/init.c
@@ -63,29 +63,156 @@ static struct fio_option options[] = {
                .name   = "rw",
                .type   = FIO_OPT_STR,
                .cb     = str_rw_cb,
-               .help   = "IO direction (read, write, rw, etc)",
+               .help   = "IO direction",
                .def    = "read",
+               .posval = { "read", "write", "randwrite", "randread", "rw",
+                               "randrw", },
        },
        {
                .name   = "ioengine",
                .type   = FIO_OPT_STR,
                .cb     = str_ioengine_cb,
-               .help   = "IO engine to use (sync, aio, etc)",
+               .help   = "IO engine to use",
                .def    = "sync",
+               .posval = { "sync", "libaio", "posixaio", "mmap", "splice",
+                               "sg", "null", },
+       },
+       {
+               .name   = "iodepth",
+               .type   = FIO_OPT_INT,
+               .off1   = td_var_offset(iodepth),
+               .help   = "Amount of IO buffers to keep in flight",
+               .def    = "1",
+       },
+       {
+               .name   = "size",
+               .type   = FIO_OPT_STR_VAL,
+               .off1   = td_var_offset(total_file_size),
+               .help   = "Size of device or file",
+       },
+       {
+               .name   = "bs",
+               .type   = FIO_OPT_STR_VAL_INT,
+               .off1   = td_var_offset(bs[DDIR_READ]),
+               .off2   = td_var_offset(bs[DDIR_WRITE]),
+               .help   = "Block size unit",
+               .def    = "4k",
+       },
+       {
+               .name   = "bsrange",
+               .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]),
+               .help   = "Set block size range (in more detail than bs)",
+       },
+       {
+               .name   = "bs_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",
+       },
+       {
+               .name   = "randrepeat",
+               .type   = FIO_OPT_BOOL,
+               .off1   = td_var_offset(rand_repeatable),
+               .help   = "Use repeatable random IO pattern",
+               .def    = "1",
+       },
+       {
+               .name   = "norandommap",
+               .type   = FIO_OPT_STR_SET,
+               .off1   = td_var_offset(norandommap),
+               .help   = "Accept potential duplicate random blocks",
+       },
+       {
+               .name   = "nrfiles",
+               .type   = FIO_OPT_INT,
+               .off1   = td_var_offset(nr_files),
+               .help   = "Split job workload between this number of files",
+               .def    = "1",
+       },
+       {
+               .name   = "fsync",
+               .type   = FIO_OPT_INT,
+               .off1   = td_var_offset(fsync_blocks),
+               .help   = "Issue fsync for writes every given number of blocks",
+               .def    = "0",
+       },
+       {
+               .name   = "direct",
+               .type   = FIO_OPT_BOOL,
+               .off1   = td_var_offset(odirect),
+               .help   = "Use O_DIRECT IO (negates buffered)",
+               .def    = "0",
+       },
+       {
+               .name   = "buffered",
+               .type   = FIO_OPT_BOOL,
+               .off1   = td_var_offset(odirect),
+               .neg    = 1,
+               .help   = "Use buffered IO (negates direct)",
+               .def    = "1",
+       },
+       {
+               .name   = "overwrite",
+               .type   = FIO_OPT_BOOL,
+               .off1   = td_var_offset(overwrite),
+               .help   = "When writing, set whether to overwrite current data",
+               .def    = "0",
+       },
+       {
+               .name   = "loops",
+               .type   = FIO_OPT_INT,
+               .off1   = td_var_offset(loops),
+               .help   = "Number of times to run the job",
+               .def    = "1",
+       },
+       {
+               .name   = "numjobs",
+               .type   = FIO_OPT_INT,
+               .off1   = td_var_offset(numjobs),
+               .help   = "Duplicate this job this many times",
+               .def    = "1",
+       },
+       {
+               .name   = "startdelay",
+               .type   = FIO_OPT_INT,
+               .off1   = td_var_offset(start_delay),
+               .help   = "Only start job when this period has passed",
+               .def    = "0",
+       },
+       {
+               .name   = "runtime",
+               .alias  = "timeout",
+               .type   = FIO_OPT_STR_VAL_TIME,
+               .off1   = td_var_offset(timeout),
+               .help   = "Stop workload when this amount of time has passed",
+               .def    = "0",
        },
        {
                .name   = "mem",
                .type   = FIO_OPT_STR,
                .cb     = str_mem_cb,
-               .help   = "Backing type for IO buffers (malloc, shm, etc)",
+               .help   = "Backing type for IO buffers",
                .def    = "malloc",
+               .posval =  { "malloc", "shm", "shmhuge", "mmap", "mmaphuge", },
        },
        {
                .name   = "verify",
                .type   = FIO_OPT_STR,
                .cb     = str_verify_cb,
-               .help   = "Verify sum function (md5 or crc32)",
+               .help   = "Verify sum function",
                .def    = "0",
+               .posval = { "crc32", "md5", },
        },
        {
                .name   = "write_iolog",
@@ -119,27 +246,6 @@ static struct fio_option options[] = {
                .help   = "Use this IO scheduler on the backing device",
        },
 #endif
-       {
-               .name   = "size",
-               .type   = FIO_OPT_STR_VAL,
-               .off1   = td_var_offset(total_file_size),
-               .help   = "Size of device or file",
-       },
-       {
-               .name   = "bs",
-               .type   = FIO_OPT_STR_VAL_INT,
-               .off1   = td_var_offset(bs[DDIR_READ]),
-               .off2   = td_var_offset(bs[DDIR_WRITE]),
-               .help   = "Block size unit",
-               .def    = "4k",
-       },
-       {
-               .name   = "offset",
-               .type   = FIO_OPT_STR_VAL,
-               .off1   = td_var_offset(start_offset),
-               .help   = "Start IO from this offset",
-               .def    = "0",
-       },
        {
                .name   = "zonesize",
                .type   = FIO_OPT_STR_VAL,
@@ -161,43 +267,6 @@ static struct fio_option options[] = {
                .help   = "Lock down this amount of memory",
                .def    = "0",
        },
-       {
-               .name   = "bsrange",
-               .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]),
-               .help   = "Set block size range",
-       },
-       {
-               .name   = "randrepeat",
-               .type   = FIO_OPT_INT,
-               .off1   = td_var_offset(rand_repeatable),
-               .help   = "Use repeatable random IO pattern",
-               .def    = "1",
-       },
-       {
-               .name   = "nrfiles",
-               .type   = FIO_OPT_INT,
-               .off1   = td_var_offset(nr_files),
-               .help   = "Split job workload between this number of files",
-               .def    = "1",
-       },
-       {
-               .name   = "iodepth",
-               .type   = FIO_OPT_INT,
-               .off1   = td_var_offset(iodepth),
-               .help   = "Amount of IO buffers to keep in flight",
-               .def    = "1",
-       },
-       {
-               .name   = "fsync",
-               .type   = FIO_OPT_INT,
-               .off1   = td_var_offset(fsync_blocks),
-               .help   = "Issue fsync for writes every given number of blocks",
-               .def    = "0",
-       },
        {
                .name   = "rwmixcycle",
                .type   = FIO_OPT_INT,
@@ -226,6 +295,7 @@ static struct fio_option options[] = {
                .type   = FIO_OPT_INT,
                .off1   = td_var_offset(nice),
                .help   = "Set job CPU nice value",
+               .minval = -19,
                .maxval = 20,
                .def    = "0",
        },
@@ -235,19 +305,23 @@ static struct fio_option options[] = {
                .type   = FIO_OPT_INT,
                .cb     = str_prio_cb,
                .help   = "Set job IO priority value",
+               .minval = 0,
+               .maxval = 7,
        },
        {
                .name   = "prioclass",
                .type   = FIO_OPT_INT,
                .cb     = str_prioclass_cb,
                .help   = "Set job IO priority class",
+               .minval = 0,
+               .maxval = 3,
        },
 #endif
        {
                .name   = "thinktime",
                .type   = FIO_OPT_INT,
                .off1   = td_var_offset(thinktime),
-               .help   = "Idle time between IO buffers",
+               .help   = "Idle time between IO buffers (usec)",
                .def    = "0",
        },
        {
@@ -276,30 +350,16 @@ static struct fio_option options[] = {
                .help   = "Window average for rate limits (msec)",
                .def    = "1000",
        },
-       {
-               .name   = "startdelay",
-               .type   = FIO_OPT_INT,
-               .off1   = td_var_offset(start_delay),
-               .help   = "Only start job when this period has passed",
-               .def    = "0",
-       },
-       {
-               .name   = "timeout",
-               .type   = FIO_OPT_STR_VAL_TIME,
-               .off1   = td_var_offset(timeout),
-               .help   = "Stop workload when this amount of time has passed",
-               .def    = "0",
-       },
        {
                .name   = "invalidate",
-               .type   = FIO_OPT_INT,
+               .type   = FIO_OPT_BOOL,
                .off1   = td_var_offset(invalidate_cache),
                .help   = "Invalidate buffer/page cache prior to running job",
                .def    = "1",
        },
        {
                .name   = "sync",
-               .type   = FIO_OPT_INT,
+               .type   = FIO_OPT_BOOL,
                .off1   = td_var_offset(sync_io),
                .help   = "Use O_SYNC for buffered writes",
                .def    = "0",
@@ -313,32 +373,18 @@ static struct fio_option options[] = {
        },
        {
                .name   = "create_serialize",
-               .type   = FIO_OPT_INT,
+               .type   = FIO_OPT_BOOL,
                .off1   = td_var_offset(create_serialize),
                .help   = "Serialize creating of job files",
                .def    = "1",
        },
        {
                .name   = "create_fsync",
-               .type   = FIO_OPT_INT,
+               .type   = FIO_OPT_BOOL,
                .off1   = td_var_offset(create_fsync),
                .help   = "Fsync file after creation",
                .def    = "1",
        },
-       {
-               .name   = "loops",
-               .type   = FIO_OPT_INT,
-               .off1   = td_var_offset(loops),
-               .help   = "Number of times to run the job",
-               .def    = "1",
-       },
-       {
-               .name   = "numjobs",
-               .type   = FIO_OPT_INT,
-               .off1   = td_var_offset(numjobs),
-               .help   = "Duplicate this job this many times",
-               .def    = "1",
-       },
        {
                .name   = "cpuload",
                .type   = FIO_OPT_INT,
@@ -351,20 +397,6 @@ static struct fio_option options[] = {
                .off1   = td_var_offset(cpucycle),
                .help   = "Length of the CPU burn cycles",
        },
-       {
-               .name   = "direct",
-               .type   = FIO_OPT_INT,
-               .off1   = td_var_offset(odirect),
-               .help   = "Use O_DIRECT IO",
-               .def    = "1",
-       },
-       {
-               .name   = "overwrite",
-               .type   = FIO_OPT_INT,
-               .off1   = td_var_offset(overwrite),
-               .help   = "When writing, set whether to overwrite current data",
-               .def    = "0",
-       },
 #ifdef FIO_HAVE_CPU_AFFINITY
        {
                .name   = "cpumask",
@@ -375,17 +407,17 @@ static struct fio_option options[] = {
 #endif
        {
                .name   = "end_fsync",
-               .type   = FIO_OPT_INT,
+               .type   = FIO_OPT_BOOL,
                .off1   = td_var_offset(end_fsync),
                .help   = "Include fsync at the end of job",
                .def    = "0",
        },
        {
                .name   = "unlink",
-               .type   = FIO_OPT_INT,
+               .type   = FIO_OPT_BOOL,
                .off1   = td_var_offset(unlink),
                .help   = "Unlink created files after job has completed",
-               .def    = "1",
+               .def    = "0",
        },
        {
                .name   = "exitall",
@@ -402,7 +434,7 @@ static struct fio_option options[] = {
        {
                .name   = "thread",
                .type   = FIO_OPT_STR_SET,
-               .off1   = td_var_offset(thread),
+               .off1   = td_var_offset(use_thread),
                .help   = "Use threads instead of forks",
        },
        {
@@ -417,18 +449,6 @@ static struct fio_option options[] = {
                .off1   = td_var_offset(write_lat_log),
                .help   = "Write log of latency during run",
        },
-       {
-               .name   = "norandommap",
-               .type   = FIO_OPT_STR_SET,
-               .off1   = td_var_offset(norandommap),
-               .help   = "Accept potential duplicate random blocks",
-       },
-       {
-               .name   = "bs_unaligned",
-               .type   = FIO_OPT_STR_SET,
-               .off1   = td_var_offset(bs_unaligned),
-               .help   = "Don't sector align IO buffer sizes",
-       },
        {
                .name   = "hugepage-size",
                .type   = FIO_OPT_STR_VAL,
@@ -512,7 +532,7 @@ FILE *f_out = NULL;
 FILE *f_err = NULL;
 
 static int write_lat_log = 0;
-static int write_bw_log = 0;
+int write_bw_log = 0;
 
 /*
  * Return a free job structure.
@@ -736,7 +756,7 @@ static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
                                c3 = to_kmg(td->min_bs[DDIR_WRITE]);
                                c4 = to_kmg(td->max_bs[DDIR_WRITE]);
 
-                               fprintf(f_out, "%s: (g=%d): rw=%s, odir=%u, bs=%s-%s/%s-%s, rate=%u, ioengine=%s, iodepth=%u\n", td->name, td->groupid, ddir_str[ddir], td->odirect, c1, c2, c3, c4, td->rate, td->io_ops->name, td->iodepth);
+                               fprintf(f_out, "%s: (g=%d): rw=%s, bs=%s-%s/%s-%s, ioengine=%s, iodepth=%u\n", td->name, td->groupid, ddir_str[ddir], c1, c2, c3, c4, td->io_ops->name, td->iodepth);
 
                                free(c1);
                                free(c2);
@@ -1316,6 +1336,8 @@ int parse_options(int argc, char *argv[])
        f_out = stdout;
        f_err = stderr;
 
+       options_init(options);
+
        dupe_job_options();
 
        if (setup_thread_area())