More option help updates
[fio.git] / options.c
index 3112d65e5297f5fb66902c2c237abf7adf832ed6..81ddd2390ca5459b85714c74d014716109e1005d 100644 (file)
--- a/options.c
+++ b/options.c
@@ -311,13 +311,6 @@ static struct fio_option options[] = {
                          },
                },
        },
-       {
-               .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   = "ioengine",
                .type   = FIO_OPT_STR_STORE,
@@ -390,12 +383,14 @@ 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",
@@ -412,6 +407,14 @@ static struct fio_option options[] = {
                .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",
@@ -421,6 +424,7 @@ static struct fio_option options[] = {
                .minval = 1,
                .help   = "Block size unit",
                .def    = "4k",
+               .parent = "rw",
        },
        {
                .name   = "bsrange",
@@ -432,6 +436,7 @@ static struct fio_option options[] = {
                .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",
@@ -439,13 +444,7 @@ static struct fio_option options[] = {
                .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",
@@ -453,12 +452,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",
@@ -490,6 +491,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",
@@ -621,6 +630,14 @@ static struct fio_option options[] = {
                            .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 = "null",
                            .oval = VERIFY_NULL,
@@ -634,6 +651,7 @@ static struct fio_option options[] = {
                .off1   = td_var_offset(verifysort),
                .help   = "Sort written verify blocks for read back",
                .def    = "1",
+               .parent = "verify",
        },
        {
                .name   = "verify_interval",
@@ -641,6 +659,7 @@ static struct fio_option options[] = {
                .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",
@@ -648,13 +667,14 @@ static struct fio_option options[] = {
                .help   = "Offset verify header location by N bytes",
                .def    = "0",
                .cb     = str_verify_offset_cb, 
+               .parent = "verify",
        },
        {
                .name   = "verify_pattern",
                .type   = FIO_OPT_INT,
                .cb     = str_verify_pattern_cb,
-               .maxval = UINT_MAX,
                .help   = "Fill pattern for IO buffers",
+               .parent = "verify",
        },
        {
                .name   = "write_iolog",
@@ -709,13 +729,6 @@ 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,
@@ -732,6 +745,14 @@ static struct fio_option options[] = {
                .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,
@@ -772,6 +793,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",
@@ -779,6 +801,7 @@ static struct fio_option options[] = {
                .off1   = td_var_offset(thinktime_blocks),
                .help   = "IO buffer period between 'thinktime'",
                .def    = "1",
+               .parent = "thinktime",
        },
        {
                .name   = "rate",
@@ -791,6 +814,7 @@ static struct fio_option options[] = {
                .type   = FIO_OPT_INT,
                .off1   = td_var_offset(ratemin),
                .help   = "Job must meet this rate or it will be shutdown",
+               .parent = "rate",
        },
        {
                .name   = "rate_iops",
@@ -803,6 +827,7 @@ static struct fio_option options[] = {
                .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",
@@ -810,6 +835,7 @@ static struct fio_option options[] = {
                .off1   = td_var_offset(ratecycle),
                .help   = "Window average for rate limits (msec)",
                .def    = "1000",
+               .parent = "rate",
        },
        {
                .name   = "invalidate",
@@ -824,6 +850,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",
@@ -858,6 +885,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
        {