[PATCH] Separate io engines into separate loadable objects
[fio.git] / init.c
diff --git a/init.c b/init.c
index 6bf338532d6b528714274f7b243932b5459276cb..3eaf9b7f383bab8451d4c75b9d193772870cbe84 100644 (file)
--- a/init.c
+++ b/init.c
@@ -1,3 +1,7 @@
+/*
+ * This file contains the ini and command liner parser. It will create
+ * and initialize the specified jobs.
+ */
 #include <stdio.h>
 #include <stdlib.h>
 #include <unistd.h>
@@ -12,6 +16,9 @@
 
 #include "fio.h"
 
+/*
+ * The default options
+ */
 #define DEF_BS                 (4096)
 #define DEF_TIMEOUT            (0)
 #define DEF_RATE_CYCLE         (1000)
 #define DEF_RWMIX_READ         (50)
 #define DEF_NICE               (0)
 
-static char fio_version_string[] = "fio 1.4";
+static int def_timeout = DEF_TIMEOUT;
+
+static char fio_version_string[] = "fio 1.5";
 
-static int repeatable = DEF_RAND_REPEAT;
-static char *ini_file;
+static char **ini_file;
 static int max_jobs = MAX_JOBS;
 
 struct thread_data def_thread;
@@ -53,10 +61,14 @@ int rate_quit = 0;
 int write_lat_log = 0;
 int write_bw_log = 0;
 int exitall_on_terminate = 0;
+int terse_output = 0;
 unsigned long long mlock_size = 0;
 FILE *f_out = NULL;
 FILE *f_err = NULL;
 
+/*
+ * Return a free job structure.
+ */
 static struct thread_data *get_new_job(int global, struct thread_data *parent)
 {
        struct thread_data *td;
@@ -72,7 +84,6 @@ static struct thread_data *get_new_job(int global, struct thread_data *parent)
 
        td->fd = -1;
        td->thread_number = thread_number;
-
        return td;
 }
 
@@ -82,6 +93,11 @@ static void put_job(struct thread_data *td)
        thread_number--;
 }
 
+/*
+ * Adds a job to the list of things todo. Sanitizes the various options
+ * to make sure we don't have conflicts, and initializes various
+ * members of td.
+ */
 static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
 {
        char *ddir_str[] = { "read", "write", "randread", "randwrite",
@@ -108,7 +124,7 @@ static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
        if (td == &def_thread)
                return 0;
 
-       if (td->io_engine & FIO_SYNCIO)
+       if (td->io_ops->flags & FIO_SYNCIO)
                td->iodepth = 1;
        else {
                if (!td->iodepth)
@@ -121,6 +137,12 @@ static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
        if (td->zone_size && !td->sequential)
                td->zone_size = 0;
 
+       /*
+        * Reads can do overwrites, we always need to pre-create the file
+        */
+       if (td_read(td) || td_rw(td))
+               td->overwrite = 1;
+
        td->filetype = FIO_TYPE_FILE;
        if (!stat(jobname, &sb)) {
                if (S_ISBLK(sb.st_mode))
@@ -133,9 +155,9 @@ static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
                char tmp[PATH_MAX];
 
                if (td->directory && td->directory[0] != '\0')
-                       sprintf(tmp, "%s/%s.%d", td->directory, jobname, td->jobnum);
+                       sprintf(tmp, "%s/%s.%d", td->directory, jobname, td->thread_number);
                else
-                       sprintf(tmp, "%s.%d", jobname, td->jobnum);
+                       sprintf(tmp, "%s.%d", jobname, td->thread_number);
                td->file_name = strdup(tmp);
        } else
                td->file_name = strdup(jobname);
@@ -173,10 +195,15 @@ static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
 
        ddir = td->ddir + (!td->sequential << 1) + (td->iomix << 2);
 
-       if (!job_add_num)
-               fprintf(f_out, "%s: (g=%d): rw=%s, odir=%d, bs=%d-%d, rate=%d, ioengine=%s, iodepth=%d\n", td->name, td->groupid, ddir_str[ddir], td->odirect, td->min_bs, td->max_bs, td->rate, td->io_engine_name, td->iodepth);
-       else if (job_add_num == 1)
-               fprintf(f_out, "...\n");
+       if (!terse_output) {
+               if (!job_add_num) {
+                       if (td->io_ops->flags & FIO_CPUIO)
+                               fprintf(f_out, "%s: ioengine=cpu, cpuload=%u, cpucycle=%u\n", td->name, td->cpuload, td->cpucycle);
+                       else
+                               fprintf(f_out, "%s: (g=%d): rw=%s, odir=%d, bs=%d-%d, rate=%d, ioengine=%s, iodepth=%d\n", td->name, td->groupid, ddir_str[ddir], td->odirect, td->min_bs, td->max_bs, td->rate, td->io_ops->name, td->iodepth);
+               } else if (job_add_num == 1)
+                       fprintf(f_out, "...\n");
+       }
 
        /*
         * recurse add identical jobs, clear numjobs and stonewall options
@@ -191,7 +218,6 @@ static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
 
                td_new->numjobs = 1;
                td_new->stonewall = 0;
-               td_new->jobnum = numjobs;
                job_add_num = numjobs - 1;
 
                if (add_job(td_new, jobname, job_add_num))
@@ -203,6 +229,10 @@ err:
        return -1;
 }
 
+/*
+ * Initialize the various random states we need (random io, block size ranges,
+ * read/write mix, etc).
+ */
 int init_random_state(struct thread_data *td)
 {
        unsigned long seeds[4];
@@ -229,7 +259,7 @@ int init_random_state(struct thread_data *td)
        if (td->sequential)
                return 0;
 
-       if (repeatable)
+       if (td->rand_repeatable)
                seeds[3] = DEF_RANDSEED;
 
        blocks = (td->io_size + td->min_bs - 1) / td->min_bs;
@@ -256,7 +286,24 @@ static void fill_cpu_mask(os_cpu_mask_t cpumask, int cpu)
 #endif
 }
 
-static unsigned long get_mult(char c)
+static unsigned long get_mult_time(char c)
+{
+       switch (c) {
+               case 'm':
+               case 'M':
+                       return 60;
+               case 'h':
+               case 'H':
+                       return 60 * 60;
+               case 'd':
+               case 'D':
+                       return 24 * 60 * 60;
+               default:
+                       return 1;
+       }
+}
+
+static unsigned long get_mult_bytes(char c)
 {
        switch (c) {
                case 'k':
@@ -276,7 +323,7 @@ static unsigned long get_mult(char c)
 /*
  * convert string after '=' into decimal value, noting any size suffix
  */
-static int str_cnv(char *p, unsigned long long *val)
+static int str_to_decimal(char *p, unsigned long long *val, int kilo)
 {
        char *str;
        int len;
@@ -292,16 +339,27 @@ static int str_cnv(char *p, unsigned long long *val)
        if (*val == ULONG_MAX && errno == ERANGE)
                return 1;
 
-       *val *= get_mult(str[len - 1]);
+       if (kilo)
+               *val *= get_mult_bytes(str[len - 1]);
+       else
+               *val *= get_mult_time(str[len - 1]);
        return 0;
 }
 
-static int check_strcnv(char *p, char *name, unsigned long long *val)
+static int check_str_bytes(char *p, char *name, unsigned long long *val)
+{
+       if (strncmp(p, name, strlen(name) - 1))
+               return 1;
+
+       return str_to_decimal(p, val, 1);
+}
+
+static int check_str_time(char *p, char *name, unsigned long long *val)
 {
        if (strncmp(p, name, strlen(name) - 1))
                return 1;
 
-       return str_cnv(p, val);
+       return str_to_decimal(p, val, 0);
 }
 
 static void strip_blank_front(char **p)
@@ -366,12 +424,12 @@ static int check_strstore(char *p, char *name, char *dest)
        return 0;
 }
 
-static int __check_range(char *str, unsigned long *val)
+static int __check_range_bytes(char *str, unsigned long *val)
 {
        char suffix;
 
        if (sscanf(str, "%lu%c", val, &suffix) == 2) {
-               *val *= get_mult(suffix);
+               *val *= get_mult_bytes(suffix);
                return 0;
        }
 
@@ -381,7 +439,8 @@ static int __check_range(char *str, unsigned long *val)
        return 1;
 }
 
-static int check_range(char *p, char *name, unsigned long *s, unsigned long *e)
+static int check_range_bytes(char *p, char *name, unsigned long *s,
+                            unsigned long *e)
 {
        char option[128];
        char *str, *p1, *p2;
@@ -417,7 +476,7 @@ static int check_range(char *p, char *name, unsigned long *s, unsigned long *e)
        p2 = p + 1;
        *p = '\0';
 
-       if (!__check_range(p1, s) && !__check_range(p2, e))
+       if (!__check_range_bytes(p1, s) && !__check_range_bytes(p2, e))
                return 0;
 
        return 1;
@@ -535,41 +594,21 @@ static int str_mem_cb(struct thread_data *td, char *mem)
 
 static int str_ioengine_cb(struct thread_data *td, char *str)
 {
-       if (!strncmp(str, "linuxaio", 8) || !strncmp(str, "aio", 3) ||
-           !strncmp(str, "libaio", 6)) {
-               strcpy(td->io_engine_name, "libaio");
-               td->io_engine = FIO_LIBAIO;
-               return 0;
-       } else if (!strncmp(str, "posixaio", 8)) {
-               strcpy(td->io_engine_name, "posixaio");
-               td->io_engine = FIO_POSIXAIO;
-               return 0;
-       } else if (!strncmp(str, "sync", 4)) {
-               strcpy(td->io_engine_name, "sync");
-               td->io_engine = FIO_SYNCIO;
-               return 0;
-       } else if (!strncmp(str, "mmap", 4)) {
-               strcpy(td->io_engine_name, "mmap");
-               td->io_engine = FIO_MMAPIO;
-               return 0;
-       } else if (!strncmp(str, "sgio", 4)) {
-               strcpy(td->io_engine_name, "sgio");
-               td->io_engine = FIO_SGIO;
-               return 0;
-       } else if (!strncmp(str, "splice", 6)) {
-               strcpy(td->io_engine_name, "splice");
-               td->io_engine = FIO_SPLICEIO;
+       if (!str)
+               str = DEF_IO_ENGINE_NAME;
+
+       td->io_ops = load_ioengine(td, str);
+       if (td->io_ops)
                return 0;
-       }
 
-       log_err("fio: ioengine: { linuxaio, aio, libaio }, posixaio, sync, mmap, sgio, splice\n");
+       log_err("fio: ioengine: { linuxaio, aio, libaio }, posixaio, sync, mmap, sgio, splice, cpu\n");
        return 1;
 }
 
 /*
  * This is our [ini] type file parser.
  */
-int parse_jobs_ini(char *file)
+int parse_jobs_ini(char *file, int stonewall_flag)
 {
        unsigned int prioclass, prio, cpu, global, il;
        unsigned long long ull;
@@ -579,7 +618,7 @@ int parse_jobs_ini(char *file)
        fpos_t off;
        FILE *f;
        char *p;
-       int ret = 0;
+       int ret = 0, stonewall;
 
        f = fopen(file, "r");
        if (!f) {
@@ -591,6 +630,7 @@ int parse_jobs_ini(char *file)
        name = malloc(256);
        tmpbuf = malloc(4096);
 
+       stonewall = stonewall_flag;
        while ((p = fgets(string, 4096, f)) != NULL) {
                if (ret)
                        break;
@@ -609,6 +649,14 @@ int parse_jobs_ini(char *file)
                        break;
                }
 
+               /*
+                * Seperate multiple job files by a stonewall
+                */
+               if (!global && stonewall) {
+                       td->stonewall = stonewall;
+                       stonewall = 0;
+               }
+
                fgetpos(f, &off);
                while ((p = fgets(string, 4096, f)) != NULL) {
                        if (is_empty_or_comment(p))
@@ -644,6 +692,11 @@ int parse_jobs_ini(char *file)
                                fgetpos(f, &off);
                                continue;
                        }
+                       if (!check_int(p, "rand_repeatable", &il)) {
+                               td->rand_repeatable = il;
+                               fgetpos(f, &off);
+                               continue;
+                       }
                        if (!check_int(p, "rate", &td->rate)) {
                                fgetpos(f, &off);
                                continue;
@@ -656,6 +709,14 @@ int parse_jobs_ini(char *file)
                                fgetpos(f, &off);
                                continue;
                        }
+                       if (!check_int(p, "cpuload", &td->cpuload)) {
+                               fgetpos(f, &off);
+                               continue;
+                       }
+                       if (!check_int(p, "cpuchunks", &td->cpucycle)) {
+                               fgetpos(f, &off);
+                               continue;
+                       }
                        if (!check_int(p, "thinktime", &td->thinktime)) {
                                fgetpos(f, &off);
                                continue;
@@ -679,7 +740,8 @@ int parse_jobs_ini(char *file)
                                fgetpos(f, &off);
                                continue;
                        }
-                       if (!check_int(p, "timeout", &td->timeout)) {
+                       if (!check_str_time(p, "timeout", &ull)) {
+                               td->timeout = ull;
                                fgetpos(f, &off);
                                continue;
                        }
@@ -751,7 +813,7 @@ int parse_jobs_ini(char *file)
                                fgetpos(f, &off);
                                continue;
                        }
-                       if (!check_range(p, "bsrange", &ul1, &ul2)) {
+                       if (!check_range_bytes(p, "bsrange", &ul1, &ul2)) {
                                if (ul1 > ul2) {
                                        td->max_bs = ul1;
                                        td->min_bs = ul2;
@@ -762,28 +824,28 @@ int parse_jobs_ini(char *file)
                                fgetpos(f, &off);
                                continue;
                        }
-                       if (!check_strcnv(p, "bs", &ull)) {
+                       if (!check_str_bytes(p, "bs", &ull)) {
                                td->bs = ull;
                                fgetpos(f, &off);
                                continue;
                        }
-                       if (!check_strcnv(p, "size", &td->file_size)) {
+                       if (!check_str_bytes(p, "size", &td->file_size)) {
                                fgetpos(f, &off);
                                continue;
                        }
-                       if (!check_strcnv(p, "offset", &td->file_offset)) {
+                       if (!check_str_bytes(p, "offset", &td->file_offset)) {
                                fgetpos(f, &off);
                                continue;
                        }
-                       if (!check_strcnv(p, "zonesize", &td->zone_size)) {
+                       if (!check_str_bytes(p, "zonesize", &td->zone_size)) {
                                fgetpos(f, &off);
                                continue;
                        }
-                       if (!check_strcnv(p, "zoneskip", &td->zone_skip)) {
+                       if (!check_str_bytes(p, "zoneskip", &td->zone_skip)) {
                                fgetpos(f, &off);
                                continue;
                        }
-                       if (!check_strcnv(p, "lockmem", &mlock_size)) {
+                       if (!check_str_bytes(p, "lockmem", &mlock_size)) {
                                fgetpos(f, &off);
                                continue;
                        }
@@ -916,12 +978,10 @@ static int fill_def_thread(void)
        def_thread.bs = DEF_BS;
        def_thread.min_bs = -1;
        def_thread.max_bs = -1;
-       def_thread.io_engine = DEF_IO_ENGINE;
-       strcpy(def_thread.io_engine_name, DEF_IO_ENGINE_NAME);
        def_thread.odirect = DEF_ODIRECT;
        def_thread.ratecycle = DEF_RATE_CYCLE;
        def_thread.sequential = DEF_SEQUENTIAL;
-       def_thread.timeout = DEF_TIMEOUT;
+       def_thread.timeout = def_timeout;
        def_thread.create_file = DEF_CREATE;
        def_thread.overwrite = DEF_OVERWRITE;
        def_thread.invalidate_cache = DEF_INVALIDATE;
@@ -938,6 +998,7 @@ static int fill_def_thread(void)
        def_thread.rwmixcycle = DEF_RWMIX_CYCLE;
        def_thread.rwmixread = DEF_RWMIX_READ;
        def_thread.nice = DEF_NICE;
+       def_thread.rand_repeatable = DEF_RAND_REPEAT;
 #ifdef FIO_HAVE_DISK_UTIL
        def_thread.do_disk_util = 1;
 #endif
@@ -948,62 +1009,44 @@ static int fill_def_thread(void)
 static void usage(char *name)
 {
        printf("%s\n", fio_version_string);
-       printf("\t-s IO is sequential\n");
-       printf("\t-b Block size in KiB for each IO\n");
+       printf("\t-o Write output to file\n");
        printf("\t-t Runtime in seconds\n");
-       printf("\t-R Exit all threads on failure to meet rate goal\n");
-       printf("\t-o Use O_DIRECT\n");
        printf("\t-l Generate per-job latency logs\n");
        printf("\t-w Generate per-job bandwidth logs\n");
-       printf("\t-f Job file (Required)\n");
+       printf("\t-m Minimal (terse) output\n");
        printf("\t-v Print version info and exit\n");
 }
 
-static void parse_cmd_line(int argc, char *argv[])
+static int parse_cmd_line(int argc, char *argv[])
 {
-       int c;
+       int c, idx = 1, ini_idx = 0;
 
-       while ((c = getopt(argc, argv, "s:b:t:r:R:o:f:lwvhO:")) != EOF) {
+       while ((c = getopt(argc, argv, "t:o:lwvhm")) != EOF) {
                switch (c) {
-                       case 's':
-                               def_thread.sequential = !!atoi(optarg);
-                               break;
-                       case 'b':
-                               def_thread.bs = atoi(optarg);
-                               def_thread.bs <<= 10;
-                               if (!def_thread.bs) {
-                                       printf("bad block size\n");
-                                       def_thread.bs = DEF_BS;
-                               }
-                               break;
                        case 't':
-                               def_thread.timeout = atoi(optarg);
-                               break;
-                       case 'r':
-                               repeatable = !!atoi(optarg);
-                               break;
-                       case 'R':
-                               rate_quit = !!atoi(optarg);
-                               break;
-                       case 'o':
-                               def_thread.odirect = !!atoi(optarg);
-                               break;
-                       case 'f':
-                               ini_file = strdup(optarg);
+                               def_timeout = atoi(optarg);
+                               idx = optind;
                                break;
                        case 'l':
                                write_lat_log = 1;
+                               idx = optind;
                                break;
                        case 'w':
                                write_bw_log = 1;
+                               idx = optind;
                                break;
-                       case 'O':
+                       case 'o':
                                f_out = fopen(optarg, "w+");
                                if (!f_out) {
                                        perror("fopen output");
                                        exit(1);
                                }
                                f_err = f_out;
+                               idx = optind;
+                               break;
+                       case 'm':
+                               terse_output = 1;
+                               idx = optind;
                                break;
                        case 'h':
                                usage(argv[0]);
@@ -1014,12 +1057,19 @@ static void parse_cmd_line(int argc, char *argv[])
                }
        }
 
-       if (!ini_file && argc > 1 && argv[argc - 1][0] != '-')
-               ini_file = strdup(argv[argc - 1]);
+       while (idx < argc) {
+               ini_idx++;
+               ini_file = realloc(ini_file, ini_idx * sizeof(char *));
+               ini_file[ini_idx - 1] = strdup(argv[idx]);
+               idx++;
+       }
+
        if (!f_out) {
                f_out = stdout;
                f_err = stderr;
        }
+
+       return ini_idx;
 }
 
 static void free_shm(void)
@@ -1033,6 +1083,11 @@ static void free_shm(void)
        }
 }
 
+/*
+ * The thread area is shared between the main process and the job
+ * threads/processes. So setup a shared memory segment that will hold
+ * all the job info.
+ */
 static int setup_thread_area(void)
 {
        /*
@@ -1040,9 +1095,9 @@ static int setup_thread_area(void)
         * we get a failure that looks like too large a shm segment
         */
        do {
-               int s = max_jobs * sizeof(struct thread_data);
+               size_t size = max_jobs * sizeof(struct thread_data);
 
-               shm_id = shmget(0, s, IPC_CREAT | 0600);
+               shm_id = shmget(0, size, IPC_CREAT | 0600);
                if (shm_id != -1)
                        break;
                if (errno != EINVAL) {
@@ -1068,21 +1123,28 @@ static int setup_thread_area(void)
 
 int parse_options(int argc, char *argv[])
 {
+       int job_files, i;
+
        if (setup_thread_area())
                return 1;
        if (fill_def_thread())
                return 1;
 
-       parse_cmd_line(argc, argv);
-
-       if (!ini_file) {
-               log_err("Need job file\n");
+       job_files = parse_cmd_line(argc, argv);
+       if (!job_files) {
+               log_err("Need job file(s)\n");
                usage(argv[0]);
                return 1;
        }
 
-       if (parse_jobs_ini(ini_file))
-               return 1;
+       for (i = 0; i < job_files; i++) {
+               if (fill_def_thread())
+                       return 1;
+               if (parse_jobs_ini(ini_file[i], i))
+                       return 1;
+               free(ini_file[i]);
+       }
 
+       free(ini_file);
        return 0;
 }