#include "fio.h"
#include "parse.h"
-/*
- * The default options
- */
-#define DEF_BS (4096)
-#define DEF_TIMEOUT (0)
-#define DEF_RATE_CYCLE (1000)
-#define DEF_ODIRECT (1)
-#define DEF_IO_ENGINE (FIO_SYNCIO)
-#define DEF_IO_ENGINE_NAME "sync"
-#define DEF_SEQUENTIAL (1)
-#define DEF_RAND_REPEAT (1)
-#define DEF_OVERWRITE (0)
-#define DEF_INVALIDATE (1)
-#define DEF_SYNCIO (0)
-#define DEF_RANDSEED (0xb1899bedUL)
-#define DEF_BWAVGTIME (500)
-#define DEF_CREATE_SER (1)
-#define DEF_CREATE_FSYNC (1)
-#define DEF_LOOPS (1)
-#define DEF_VERIFY (0)
-#define DEF_STONEWALL (0)
-#define DEF_NUMJOBS (1)
-#define DEF_USE_THREAD (0)
-#define DEF_FILE_SIZE (1024 * 1024 * 1024UL)
-#define DEF_ZONE_SIZE (0)
-#define DEF_ZONE_SKIP (0)
-#define DEF_RWMIX_CYCLE (500)
-#define DEF_RWMIX_READ (50)
-#define DEF_NICE (0)
-#define DEF_NR_FILES (1)
-#define DEF_UNLINK (1)
-#define DEF_WRITE_BW_LOG (0)
-#define DEF_WRITE_LAT_LOG (0)
-#define DEF_NO_RAND_MAP (0)
-#define DEF_HUGEPAGE_SIZE FIO_HUGE_PAGE
+#define FIO_RANDSEED (0xb1899bedUL)
#define td_var_offset(var) ((size_t) &((struct thread_data *)0)->var)
static int str_exitall_cb(void);
static int str_cpumask_cb(void *, unsigned int *);
+#define __stringify_1(x) #x
+#define __stringify(x) __stringify_1(x)
+
/*
* Map of job/command line options
*/
static struct fio_option options[] = {
+ {
+ .name = "description",
+ .type = FIO_OPT_STR_STORE,
+ .off1 = td_var_offset(description),
+ .help = "Text job description",
+ },
{
.name = "name",
.type = FIO_OPT_STR_STORE,
.off1 = td_var_offset(name),
+ .help = "Name of this job",
},
{
.name = "directory",
.type = FIO_OPT_STR_STORE,
.off1 = td_var_offset(directory),
+ .help = "Directory to store files in",
},
{
.name = "filename",
.type = FIO_OPT_STR_STORE,
.off1 = td_var_offset(filename),
+ .help = "Force the use of a specific file",
},
{
.name = "rw",
.type = FIO_OPT_STR,
.cb = str_rw_cb,
+ .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",
+ .def = "sync",
+ .posval = { "sync", "libaio", "posixaio", "mmap", "splice",
+ "sg", "null", "net", },
+ },
+ {
+ .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",
+ .def = "malloc",
+ .posval = { "malloc", "shm", "shmhuge", "mmap", "mmaphuge", },
},
{
.name = "verify",
.type = FIO_OPT_STR,
.cb = str_verify_cb,
+ .help = "Verify sum function",
+ .def = "0",
+ .posval = { "crc32", "md5", },
},
{
.name = "write_iolog",
.type = FIO_OPT_STR_STORE,
.off1 = td_var_offset(write_iolog_file),
+ .help = "Store IO pattern to file",
},
{
.name = "read_iolog",
.type = FIO_OPT_STR_STORE,
.off1 = td_var_offset(read_iolog_file),
+ .help = "Playback IO pattern from file",
},
{
.name = "exec_prerun",
.type = FIO_OPT_STR_STORE,
.off1 = td_var_offset(exec_prerun),
+ .help = "Execute this file prior to running job",
},
{
.name = "exec_postrun",
.type = FIO_OPT_STR_STORE,
.off1 = td_var_offset(exec_postrun),
+ .help = "Execute this file after running job",
},
#ifdef FIO_HAVE_IOSCHED_SWITCH
{
.name = "ioscheduler",
.type = FIO_OPT_STR_STORE,
.off1 = td_var_offset(ioscheduler),
+ .help = "Use this IO scheduler on the backing device",
},
#endif
- {
- .name = "size",
- .type = FIO_OPT_STR_VAL,
- .off1 = td_var_offset(total_file_size),
- },
- {
- .name = "bs",
- .type = FIO_OPT_STR_VAL_INT,
- .off1 = td_var_offset(bs[DDIR_READ]),
- .off2 = td_var_offset(bs[DDIR_WRITE]),
- },
- {
- .name = "offset",
- .type = FIO_OPT_STR_VAL,
- .off1 = td_var_offset(start_offset),
- },
{
.name = "zonesize",
.type = FIO_OPT_STR_VAL,
.off1 = td_var_offset(zone_size),
+ .help = "Give size of an IO zone",
+ .def = "0",
},
{
.name = "zoneskip",
.type = FIO_OPT_STR_VAL,
.off1 = td_var_offset(zone_skip),
+ .help = "Space between IO zones",
+ .def = "0",
},
{
.name = "lockmem",
.type = FIO_OPT_STR_VAL,
.cb = str_lockmem_cb,
- },
- {
- .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]),
- },
- {
- .name = "nrfiles",
- .type = FIO_OPT_INT,
- .off1 = td_var_offset(nr_files),
- },
- {
- .name = "iodepth",
- .type = FIO_OPT_INT,
- .off1 = td_var_offset(iodepth),
- },
- {
- .name = "fsync",
- .type = FIO_OPT_INT,
- .off1 = td_var_offset(fsync_blocks),
+ .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),
- .max_val= 100,
+ .maxval = 100,
+ .help = "Percentage of mixed workload that is reads",
+ .def = "50",
},
{
.name = "rwmixwrite",
.type = FIO_OPT_INT,
.off1 = td_var_offset(rwmixwrite),
- .max_val= 100,
+ .maxval = 100,
+ .help = "Percentage of mixed workload that is writes",
+ .def = "50",
},
{
.name = "nice",
.type = FIO_OPT_INT,
.off1 = td_var_offset(nice),
+ .help = "Set job CPU nice value",
+ .minval = -19,
+ .maxval = 20,
+ .def = "0",
},
#ifdef FIO_HAVE_IOPRIO
{
.name = "prio",
.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)
+ .off1 = td_var_offset(thinktime),
+ .help = "Idle time between IO buffers (usec)",
+ .def = "0",
},
{
- .name = "rate",
+ .name = "thinktime_blocks",
.type = FIO_OPT_INT,
- .off1 = td_var_offset(rate)
+ .off1 = td_var_offset(thinktime_blocks),
+ .help = "IO buffer period between 'thinktime'",
+ .def = "1",
},
{
- .name = "ratemin",
+ .name = "rate",
.type = FIO_OPT_INT,
- .off1 = td_var_offset(ratemin)
+ .off1 = td_var_offset(rate),
+ .help = "Set bandwidth rate",
},
{
- .name = "ratecycle",
+ .name = "ratemin",
.type = FIO_OPT_INT,
- .off1 = td_var_offset(ratecycle)
+ .off1 = td_var_offset(ratemin),
+ .help = "The bottom limit accepted",
},
{
- .name = "startdelay",
+ .name = "ratecycle",
.type = FIO_OPT_INT,
- .off1 = td_var_offset(start_delay)
- },
- {
- .name = "timeout",
- .type = FIO_OPT_STR_VAL_TIME,
- .off1 = td_var_offset(timeout)
+ .off1 = td_var_offset(ratecycle),
+ .help = "Window average for rate limits (msec)",
+ .def = "1000",
},
{
.name = "invalidate",
- .type = FIO_OPT_INT,
- .off1 = td_var_offset(invalidate_cache)
+ .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,
- .off1 = td_var_offset(sync_io)
+ .type = FIO_OPT_BOOL,
+ .off1 = td_var_offset(sync_io),
+ .help = "Use O_SYNC for buffered writes",
+ .def = "0",
},
{
.name = "bwavgtime",
.type = FIO_OPT_INT,
- .off1 = td_var_offset(bw_avg_time)
+ .off1 = td_var_offset(bw_avg_time),
+ .help = "Time window over which to calculate bandwidth (msec)",
+ .def = "500",
},
{
.name = "create_serialize",
- .type = FIO_OPT_INT,
- .off1 = td_var_offset(create_serialize)
+ .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,
- .off1 = td_var_offset(create_fsync)
- },
- {
- .name = "loops",
- .type = FIO_OPT_INT,
- .off1 = td_var_offset(loops)
- },
- {
- .name = "numjobs",
- .type = FIO_OPT_INT,
- .off1 = td_var_offset(numjobs)
+ .type = FIO_OPT_BOOL,
+ .off1 = td_var_offset(create_fsync),
+ .help = "Fsync file after creation",
+ .def = "1",
},
{
.name = "cpuload",
.type = FIO_OPT_INT,
- .off1 = td_var_offset(cpuload)
+ .off1 = td_var_offset(cpuload),
+ .help = "Use this percentage of CPU",
},
{
.name = "cpuchunks",
.type = FIO_OPT_INT,
- .off1 = td_var_offset(cpucycle)
- },
- {
- .name = "direct",
- .type = FIO_OPT_INT,
- .off1 = td_var_offset(odirect)
- },
- {
- .name = "overwrite",
- .type = FIO_OPT_INT,
- .off1 = td_var_offset(overwrite)
+ .off1 = td_var_offset(cpucycle),
+ .help = "Length of the CPU burn cycles",
},
#ifdef FIO_HAVE_CPU_AFFINITY
{
.name = "cpumask",
.type = FIO_OPT_INT,
.cb = str_cpumask_cb,
+ .help = "CPU affinity mask",
},
#endif
{
.name = "end_fsync",
- .type = FIO_OPT_INT,
- .off1 = td_var_offset(end_fsync)
+ .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_STR_SET,
+ .type = FIO_OPT_BOOL,
.off1 = td_var_offset(unlink),
+ .help = "Unlink created files after job has completed",
+ .def = "0",
},
{
.name = "exitall",
.type = FIO_OPT_STR_SET,
.cb = str_exitall_cb,
+ .help = "Terminate all jobs when one exits",
},
{
.name = "stonewall",
.type = FIO_OPT_STR_SET,
.off1 = td_var_offset(stonewall),
+ .help = "Insert a hard barrier between this job and previous",
},
{
.name = "thread",
.type = FIO_OPT_STR_SET,
- .off1 = td_var_offset(thread),
+ .off1 = td_var_offset(use_thread),
+ .help = "Use threads instead of forks",
},
{
.name = "write_bw_log",
.type = FIO_OPT_STR_SET,
.off1 = td_var_offset(write_bw_log),
+ .help = "Write log of bandwidth during run",
},
{
.name = "write_lat_log",
.type = FIO_OPT_STR_SET,
.off1 = td_var_offset(write_lat_log),
- },
- {
- .name = "norandommap",
- .type = FIO_OPT_STR_SET,
- .off1 = td_var_offset(norandommap),
- },
- {
- .name = "bs_unaligned",
- .type = FIO_OPT_STR_SET,
- .off1 = td_var_offset(bs_unaligned),
+ .help = "Write log of latency during run",
},
{
.name = "hugepage-size",
.type = FIO_OPT_STR_VAL,
.off1 = td_var_offset(hugepage_size),
+ .help = "When using hugepages, specify size of each page",
+ .def = __stringify(FIO_HUGE_PAGE),
},
{
.name = NULL,
.has_arg = no_argument,
.val = 'v',
},
+ {
+ .name = "help",
+ .has_arg = no_argument,
+ .val = 'h',
+ },
+ {
+ .name = "cmdhelp",
+ .has_arg = required_argument,
+ .val = 'c',
+ },
{
.name = NULL,
},
};
-static int def_timeout = DEF_TIMEOUT;
+static int def_timeout = 0;
-static char fio_version_string[] = "fio 1.9";
+static char fio_version_string[] = "fio 1.11";
static char **ini_file;
static int max_jobs = MAX_JOBS;
FILE *f_out = NULL;
FILE *f_err = NULL;
-static int write_lat_log = DEF_WRITE_LAT_LOG;
-static int write_bw_log = DEF_WRITE_BW_LOG;
+static int write_lat_log = 0;
+int write_bw_log = 0;
/*
* Return a free job structure.
if (td == &def_thread)
return;
+ if (td->error)
+ fprintf(f_out, "fio: %s\n", td->verror);
+
memset(&threads[td->thread_number - 1], 0, sizeof(*td));
thread_number--;
}
if (td == &def_thread)
return 0;
- /*
- * Set default io engine, if none set
- */
- if (!td->io_ops) {
- td->io_ops = load_ioengine(td, DEF_IO_ENGINE_NAME);
- if (!td->io_ops) {
- log_err("default engine %s not there?\n", DEF_IO_ENGINE_NAME);
- return 1;
- }
- }
+ assert(td->io_ops);
if (td->odirect)
td->io_ops->flags |= FIO_RAWIO;
char tmp[PATH_MAX];
int len = 0;
- if (td->directory && td->directory[0] != '\0')
- sprintf(tmp, "%s/", td->directory);
+ if (td->directory && td->directory[0] != '\0') {
+ if (lstat(td->directory, &sb) < 0) {
+ log_err("fio: %s is not a directory\n", td->directory);
+ td_verror(td, errno);
+ return 1;
+ }
+ if (!S_ISDIR(sb.st_mode)) {
+ log_err("fio: %s is not a directory\n", td->directory);
+ return 1;
+ }
+ len = sprintf(tmp, "%s/", td->directory);
+ }
td->files = malloc(sizeof(struct fio_file) * td->nr_files);
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);
return 0;
if (td->rand_repeatable)
- seeds[3] = DEF_RANDSEED;
+ seeds[3] = FIO_RANDSEED;
if (!td->norandommap) {
for_each_file(td, f, i) {
}
/*
- * fill globals
+ * fill default options
*/
- def_thread.ddir = DDIR_READ;
- def_thread.iomix = 0;
- def_thread.bs[DDIR_READ] = DEF_BS;
- def_thread.bs[DDIR_WRITE] = DEF_BS;
- def_thread.min_bs[DDIR_READ] = def_thread.min_bs[DDIR_WRITE] = 0;
- def_thread.max_bs[DDIR_READ] = def_thread.max_bs[DDIR_WRITE] = 0;
- def_thread.odirect = DEF_ODIRECT;
- def_thread.ratecycle = DEF_RATE_CYCLE;
- def_thread.sequential = DEF_SEQUENTIAL;
+ fill_default_options(&def_thread, options);
+
def_thread.timeout = def_timeout;
- def_thread.overwrite = DEF_OVERWRITE;
- def_thread.invalidate_cache = DEF_INVALIDATE;
- def_thread.sync_io = DEF_SYNCIO;
- def_thread.mem_type = MEM_MALLOC;
- def_thread.bw_avg_time = DEF_BWAVGTIME;
- def_thread.create_serialize = DEF_CREATE_SER;
- def_thread.create_fsync = DEF_CREATE_FSYNC;
- def_thread.loops = DEF_LOOPS;
- def_thread.verify = DEF_VERIFY;
- def_thread.stonewall = DEF_STONEWALL;
- def_thread.numjobs = DEF_NUMJOBS;
- def_thread.use_thread = DEF_USE_THREAD;
- def_thread.rwmixcycle = DEF_RWMIX_CYCLE;
- def_thread.rwmixread = DEF_RWMIX_READ;
- def_thread.nice = DEF_NICE;
- def_thread.rand_repeatable = DEF_RAND_REPEAT;
- def_thread.nr_files = DEF_NR_FILES;
- def_thread.unlink = DEF_UNLINK;
def_thread.write_bw_log = write_bw_log;
def_thread.write_lat_log = write_lat_log;
- def_thread.norandommap = DEF_NO_RAND_MAP;
- def_thread.hugepage_size = DEF_HUGEPAGE_SIZE;
+
#ifdef FIO_HAVE_DISK_UTIL
def_thread.do_disk_util = 1;
#endif
printf("\t--bandwidth-log\tGenerate per-job bandwidth logs\n");
printf("\t--minimal\tMinimal (terse) output\n");
printf("\t--version\tPrint version info and exit\n");
+ printf("\t--help\t\tPrint this page\n");
+ printf("\t--cmdhelp=cmd\tPrint command help, \"all\" for all of them\n");
}
static int parse_cmd_line(int argc, char *argv[])
case 'h':
usage();
exit(0);
+ case 'c':
+ ret = show_cmd_help(options, optarg);
+ exit(ret);
case 'v':
printf("%s\n", fio_version_string);
exit(0);
break;
}
default:
- printf("optarg <<%s>>\n", argv[optind]);
break;
}
}
f_out = stdout;
f_err = stderr;
+ options_init(options);
+
dupe_job_options();
if (setup_thread_area())
projects / fio.git / blobdiff