Fio 1.22-rc3
[fio.git] / init.c
diff --git a/init.c b/init.c
index e8b94d6b24ce57bbf442d255ae36004b8b893854..5de6f4f6df7b7e13d33733d456224d86658f7537 100644 (file)
--- a/init.c
+++ b/init.c
 
 #include "fio.h"
 #include "parse.h"
+#include "smalloc.h"
+#include "filehash.h"
 
-static char fio_version_string[] = "fio 1.16";
+static char fio_version_string[] = "fio 1.22-rc3";
 
 #define FIO_RANDSEED           (0xb1899bedUL)
 
@@ -30,22 +32,29 @@ struct thread_data *threads = NULL;
 
 int exitall_on_terminate = 0;
 int terse_output = 0;
+int eta_print;
 unsigned long long mlock_size = 0;
 FILE *f_out = NULL;
 FILE *f_err = NULL;
+char *job_section = NULL;
 
 int write_bw_log = 0;
+int read_only = 0;
 
-static int def_timeout = 0;
-static int write_lat_log = 0;
+static int def_timeout;
+static int write_lat_log;
 
 static int prev_group_jobs;
 
+unsigned long fio_debug = 0;
+unsigned int fio_debug_jobno = -1;
+unsigned int *fio_debug_jobp = NULL;
+
 /*
  * Command line options. These will contain the above, plus a few
  * extra that only pertain to fio itself and not jobs.
  */
-static struct option long_options[FIO_NR_OPTIONS] = {
+static struct option l_opts[FIO_NR_OPTIONS] = {
        {
                .name           = "output",
                .has_arg        = required_argument,
@@ -89,7 +98,32 @@ static struct option long_options[FIO_NR_OPTIONS] = {
        {
                .name           = "showcmd",
                .has_arg        = no_argument,
-               .val            = 's'
+               .val            = 's',
+       },
+       {
+               .name           = "readonly",
+               .has_arg        = no_argument,
+               .val            = 'r',
+       },
+       {
+               .name           = "eta",
+               .has_arg        = required_argument,
+               .val            = 'e',
+       },
+       {
+               .name           = "debug",
+               .has_arg        = required_argument,
+               .val            = 'd',
+       },
+       {
+               .name           = "section",
+               .has_arg        = required_argument,
+               .val            = 'x',
+       },
+       {
+               .name           = "alloc-size",
+               .has_arg        = required_argument,
+               .val            = 'a',
        },
        {
                .name           = NULL,
@@ -180,8 +214,11 @@ static int fixup_options(struct thread_data *td)
 {
        struct thread_options *o = &td->o;
 
-       if (o->rwmix[DDIR_READ] + o->rwmix[DDIR_WRITE] > 100)
-               o->rwmix[DDIR_WRITE] = 100 - o->rwmix[DDIR_READ];
+       if (read_only && td_write(td)) {
+               log_err("fio: job <%s> has write bit set, but fio is in"
+                       " read-only mode\n", td->o.name);
+               return 1;
+       }
 
        if (o->write_iolog_file && o->read_iolog_file) {
                log_err("fio: read iolog overrides write_iolog\n");
@@ -189,13 +226,6 @@ static int fixup_options(struct thread_data *td)
                o->write_iolog_file = NULL;
        }
 
-       if (td->io_ops->flags & FIO_SYNCIO)
-               o->iodepth = 1;
-       else {
-               if (!o->iodepth)
-                       o->iodepth = o->open_files;
-       }
-
        /*
         * only really works for sequential io for now, and with 1 file
         */
@@ -209,11 +239,11 @@ static int fixup_options(struct thread_data *td)
                o->overwrite = 1;
 
        if (!o->min_bs[DDIR_READ])
-               o->min_bs[DDIR_READ]= o->bs[DDIR_READ];
+               o->min_bs[DDIR_READ] = o->bs[DDIR_READ];
        if (!o->max_bs[DDIR_READ])
                o->max_bs[DDIR_READ] = o->bs[DDIR_READ];
        if (!o->min_bs[DDIR_WRITE])
-               o->min_bs[DDIR_WRITE]= o->bs[DDIR_WRITE];
+               o->min_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
        if (!o->max_bs[DDIR_WRITE])
                o->max_bs[DDIR_WRITE] = o->bs[DDIR_WRITE];
 
@@ -222,9 +252,6 @@ static int fixup_options(struct thread_data *td)
        if (!o->file_size_high)
                o->file_size_high = o->file_size_low;
 
-       if (td_read(td) && !td_rw(td))
-               o->verify = 0;
-
        if (o->norandommap && o->verify != VERIFY_NONE) {
                log_err("fio: norandommap given, verify disabled\n");
                o->verify = VERIFY_NONE;
@@ -279,6 +306,16 @@ static int fixup_options(struct thread_data *td)
                o->time_based = 0;
        }
 
+       if (o->fill_device && !o->size)
+               o->size = -1ULL;
+
+       if (td_rw(td) && td->o.verify != VERIFY_NONE)
+               log_info("fio: mixed read/write workload with verify. May not "
+                "work as expected, unless you pre-populated the file\n");
+
+       if (td->o.verify != VERIFY_NONE)
+               td->o.refill_buffers = 1;
+
        return 0;
 }
 
@@ -416,14 +453,15 @@ static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
                td->io_ops->flags |= FIO_RAWIO;
 
        file_alloced = 0;
-       if (!td->o.filename && !td->files_index) {
+       if (!td->o.filename && !td->files_index && !td->o.read_iolog_file) {
                file_alloced = 1;
 
                if (td->o.nr_files == 1 && exists_and_not_file(jobname))
                        add_file(td, jobname);
                else {
                        for (i = 0; i < td->o.nr_files; i++) {
-                               sprintf(fname, "%s.%d.%d", jobname, td->thread_number, i);
+                               sprintf(fname, "%s.%d.%d", jobname,
+                                                       td->thread_number, i);
                                add_file(td, fname);
                        }
                }
@@ -439,7 +477,7 @@ static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
                        f->real_file_size = -1ULL;
        }
 
-       td->mutex = fio_sem_init(0);
+       td->mutex = fio_mutex_init(0);
 
        td->ts.clat_stat[0].min_val = td->ts.clat_stat[1].min_val = ULONG_MAX;
        td->ts.slat_stat[0].min_val = td->ts.slat_stat[1].min_val = ULONG_MAX;
@@ -473,9 +511,12 @@ static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
 
        if (!terse_output) {
                if (!job_add_num) {
-                       if (!strcmp(td->io_ops->name, "cpuio"))
-                               log_info("%s: ioengine=cpu, cpuload=%u, cpucycle=%u\n", td->o.name, td->o.cpuload, td->o.cpucycle);
-                       else {
+                       if (!strcmp(td->io_ops->name, "cpuio")) {
+                               log_info("%s: ioengine=cpu, cpuload=%u,"
+                                        " cpucycle=%u\n", td->o.name,
+                                                       td->o.cpuload,
+                                                       td->o.cpucycle);
+                       } else {
                                char *c1, *c2, *c3, *c4;
 
                                c1 = to_kmg(td->o.min_bs[DDIR_READ]);
@@ -483,7 +524,13 @@ static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
                                c3 = to_kmg(td->o.min_bs[DDIR_WRITE]);
                                c4 = to_kmg(td->o.max_bs[DDIR_WRITE]);
 
-                               log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s, ioengine=%s, iodepth=%u\n", td->o.name, td->groupid, ddir_str[td->o.td_ddir], c1, c2, c3, c4, td->io_ops->name, td->o.iodepth);
+                               log_info("%s: (g=%d): rw=%s, bs=%s-%s/%s-%s,"
+                                        " ioengine=%s, iodepth=%u\n",
+                                               td->o.name, td->groupid,
+                                               ddir_str[td->o.td_ddir],
+                                               c1, c2, c3, c4,
+                                               td->io_ops->name,
+                                               td->o.iodepth);
 
                                free(c1);
                                free(c2);
@@ -527,6 +574,16 @@ err:
        return -1;
 }
 
+static int skip_this_section(const char *name)
+{
+       if (!job_section)
+               return 0;
+       if (!strncmp(name, "global", 6))
+               return 0;
+
+       return strncmp(job_section, name, strlen(job_section));
+}
+
 static int is_empty_or_comment(char *line)
 {
        unsigned int i;
@@ -551,38 +608,69 @@ static int parse_jobs_ini(char *file, int stonewall_flag)
        unsigned int global;
        struct thread_data *td;
        char *string, *name;
-       fpos_t off;
        FILE *f;
        char *p;
        int ret = 0, stonewall;
        int first_sect = 1;
+       int skip_fgets = 0;
+       int inside_skip = 0;
+       char **opts;
+       int i, alloc_opts, num_opts;
+
+       if (!strcmp(file, "-"))
+               f = stdin;
+       else
+               f = fopen(file, "r");
 
-       f = fopen(file, "r");
        if (!f) {
                perror("fopen job file");
                return 1;
        }
 
        string = malloc(4096);
-       name = malloc(256);
-       memset(name, 0, 256);
+
+       /*
+        * it's really 256 + small bit, 280 should suffice
+        */
+       name = malloc(280);
+       memset(name, 0, 280);
+
+       alloc_opts = 8;
+       opts = malloc(sizeof(char *) * alloc_opts);
+       num_opts = 0;
 
        stonewall = stonewall_flag;
        do {
-               p = fgets(string, 4095, f);
-               if (!p)
-                       break;
+               /*
+                * if skip_fgets is set, we already have loaded a line we
+                * haven't handled.
+                */
+               if (!skip_fgets) {
+                       p = fgets(string, 4095, f);
+                       if (!p)
+                               break;
+               }
 
+               skip_fgets = 0;
                strip_blank_front(&p);
                strip_blank_end(p);
 
                if (is_empty_or_comment(p))
                        continue;
                if (sscanf(p, "[%255s]", name) != 1) {
-                       log_err("fio: option <%s> outside of job section\n", p);
-                       continue;
+                       if (inside_skip)
+                               continue;
+                       log_err("fio: option <%s> outside of [] job section\n",
+                                                                       p);
+                       break;
                }
 
+               if (skip_this_section(name)) {
+                       inside_skip = 1;
+                       continue;
+               } else
+                       inside_skip = 0;
+
                global = !strncmp(name, "global", 6);
 
                name[strlen(name) - 1] = '\0';
@@ -609,45 +697,64 @@ static int parse_jobs_ini(char *file, int stonewall_flag)
                        stonewall = 0;
                }
 
-               fgetpos(f, &off);
+               num_opts = 0;
+               memset(opts, 0, alloc_opts * sizeof(char *));
+
                while ((p = fgets(string, 4096, f)) != NULL) {
                        if (is_empty_or_comment(p))
                                continue;
 
                        strip_blank_front(&p);
 
-                       if (p[0] == '[')
+                       /*
+                        * new section, break out and make sure we don't
+                        * fgets() a new line at the top.
+                        */
+                       if (p[0] == '[') {
+                               skip_fgets = 1;
                                break;
+                       }
 
                        strip_blank_end(p);
 
-                       fgetpos(f, &off);
+                       if (num_opts == alloc_opts) {
+                               alloc_opts <<= 1;
+                               opts = realloc(opts,
+                                               alloc_opts * sizeof(char *));
+                       }
 
-                       /*
-                        * Don't break here, continue parsing options so we
-                        * dump all the bad ones. Makes trial/error fixups
-                        * easier on the user.
-                        */
-                       ret |= fio_option_parse(td, p);
-                       if (!ret && dump_cmdline)
-                               log_info("--%s ", p);
+                       opts[num_opts] = strdup(p);
+                       num_opts++;
                }
 
+               ret = fio_options_parse(td, opts, num_opts);
                if (!ret) {
-                       fsetpos(f, &off);
+                       if (dump_cmdline)
+                               for (i = 0; i < num_opts; i++)
+                                       log_info("--%s ", opts[i]);
+
                        ret = add_job(td, name, 0);
                } else {
                        log_err("fio: job %s dropped\n", name);
                        put_job(td);
                }
+
+               for (i = 0; i < num_opts; i++)
+                       free(opts[i]);
+               num_opts = 0;
        } while (!ret);
 
        if (dump_cmdline)
                log_info("\n");
 
+       for (i = 0; i < num_opts; i++)
+               free(opts[i]);
+
        free(string);
        free(name);
-       fclose(f);
+       free(opts);
+       if (f != stdin)
+               fclose(f);
        return ret;
 }
 
@@ -655,10 +762,7 @@ static int fill_def_thread(void)
 {
        memset(&def_thread, 0, sizeof(def_thread));
 
-       if (fio_getaffinity(getpid(), &def_thread.o.cpumask) == -1) {
-               perror("sched_getaffinity");
-               return 1;
-       }
+       fio_getaffinity(getpid(), &def_thread.o.cpumask);
 
        /*
         * fill default options
@@ -669,10 +773,6 @@ static int fill_def_thread(void)
        def_thread.o.write_bw_log = write_bw_log;
        def_thread.o.write_lat_log = write_lat_log;
 
-#ifdef FIO_HAVE_DISK_UTIL
-       def_thread.o.do_disk_util = 1;
-#endif
-
        return 0;
 }
 
@@ -681,19 +781,28 @@ static void free_shm(void)
        struct shmid_ds sbuf;
 
        if (threads) {
-               shmdt((void *) threads);
+               void *tp = threads;
+
                threads = NULL;
+               file_hash_exit();
+               fio_debug_jobp = NULL;
+               shmdt(tp);
                shmctl(shm_id, IPC_RMID, &sbuf);
        }
+
+       scleanup();
 }
 
 /*
  * 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.
+ * all the job info. We use the end of the region for keeping track of
+ * open files across jobs, for file sharing.
  */
 static int setup_thread_area(void)
 {
+       void *hash;
+
        /*
         * 1024 is too much on some machines, scale max_jobs if
         * we get a failure that looks like too large a shm segment
@@ -701,6 +810,9 @@ static int setup_thread_area(void)
        do {
                size_t size = max_jobs * sizeof(struct thread_data);
 
+               size += file_hash_size;
+               size += sizeof(unsigned int);
+
                shm_id = shmget(0, size, IPC_CREAT | 0600);
                if (shm_id != -1)
                        break;
@@ -721,13 +833,20 @@ static int setup_thread_area(void)
                return 1;
        }
 
+       memset(threads, 0, max_jobs * sizeof(struct thread_data));
+       hash = (void *) threads + max_jobs * sizeof(struct thread_data);
+       fio_debug_jobp = (void *) hash + file_hash_size;
+       *fio_debug_jobp = -1;
+       file_hash_init(hash);
        atexit(free_shm);
        return 0;
 }
 
-static void usage(void)
+static void usage(const char *name)
 {
        printf("%s\n", fio_version_string);
+       printf("%s [options] [job options] <job file(s)>\n", name);
+       printf("\t--debug=options\tEnable debug logging\n");
        printf("\t--output\tWrite output to file\n");
        printf("\t--timeout\tRuntime in seconds\n");
        printf("\t--latency-log\tGenerate per-job latency logs\n");
@@ -735,17 +854,107 @@ static void usage(void)
        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");
+       printf("\t--cmdhelp=cmd\tPrint command help, \"all\" for all of"
+               " them\n");
        printf("\t--showcmd\tTurn a job file into command line options\n");
+       printf("\t--eta=when\tWhen ETA estimate should be printed\n");
+       printf("\t          \tMay be \"always\", \"never\" or \"auto\"\n");
+       printf("\t--readonly\tTurn on safety read-only checks, preventing"
+               " writes\n");
+       printf("\t--section=name\tOnly run specified section in job file\n");
+       printf("\t--alloc-size=kb\tSet smalloc pool to this size in kb"
+               " (def 1024)\n");
+}
+
+#ifdef FIO_INC_DEBUG
+struct debug_level debug_levels[] = {
+       { .name = "process",    .shift = FD_PROCESS, },
+       { .name = "file",       .shift = FD_FILE, },
+       { .name = "io",         .shift = FD_IO, },
+       { .name = "mem",        .shift = FD_MEM, },
+       { .name = "blktrace",   .shift = FD_BLKTRACE },
+       { .name = "verify",     .shift = FD_VERIFY },
+       { .name = "random",     .shift = FD_RANDOM },
+       { .name = "parse",      .shift = FD_PARSE },
+       { .name = "diskutil",   .shift = FD_DISKUTIL },
+       { .name = "job",        .shift = FD_JOB },
+       { .name = NULL, },
+};
+
+static int set_debug(const char *string)
+{
+       struct debug_level *dl;
+       char *p = (char *) string;
+       char *opt;
+       int i;
+
+       if (!strcmp(string, "?") || !strcmp(string, "help")) {
+               int i;
+
+               log_info("fio: dumping debug options:");
+               for (i = 0; debug_levels[i].name; i++) {
+                       dl = &debug_levels[i];
+                       log_info("%s,", dl->name);
+               }
+               log_info("all\n");
+               return 1;
+       }
+
+       while ((opt = strsep(&p, ",")) != NULL) {
+               int found = 0;
+
+               if (!strncmp(opt, "all", 3)) {
+                       log_info("fio: set all debug options\n");
+                       fio_debug = ~0UL;
+                       continue;
+               }
+
+               for (i = 0; debug_levels[i].name; i++) {
+                       dl = &debug_levels[i];
+                       found = !strncmp(opt, dl->name, strlen(dl->name));
+                       if (!found)
+                               continue;
+
+                       if (dl->shift == FD_JOB) {
+                               opt = strchr(opt, ':');
+                               if (!opt) {
+                                       log_err("fio: missing job number\n");
+                                       break;
+                               }
+                               opt++;
+                               fio_debug_jobno = atoi(opt);
+                               log_info("fio: set debug jobno %d\n",
+                                                       fio_debug_jobno);
+                       } else {
+                               log_info("fio: set debug option %s\n", opt);
+                               fio_debug |= (1UL << dl->shift);
+                       }
+                       break;
+               }
+
+               if (!found)
+                       log_err("fio: debug mask %s not found\n", opt);
+       }
+       return 0;
+}
+#else
+static int set_debug(const char *string)
+{
+       log_err("fio: debug tracing not included in build\n");
+       return 1;
 }
+#endif
 
 static int parse_cmd_line(int argc, char *argv[])
 {
        struct thread_data *td = NULL;
-       int c, ini_idx = 0, lidx, ret, dont_add_job = 0;
+       int c, ini_idx = 0, lidx, ret = 0, do_exit = 0, exit_val = 0;
 
-       while ((c = getopt_long_only(argc, argv, "", long_options, &lidx)) != -1) {
+       while ((c = getopt_long_only(argc, argv, "", l_opts, &lidx)) != -1) {
                switch (c) {
+               case 'a':
+                       smalloc_pool_size = atoi(optarg);
+                       break;
                case 't':
                        def_timeout = atoi(optarg);
                        break;
@@ -767,18 +976,43 @@ static int parse_cmd_line(int argc, char *argv[])
                        terse_output = 1;
                        break;
                case 'h':
-                       usage();
+                       usage(argv[0]);
                        exit(0);
                case 'c':
                        exit(fio_show_option_help(optarg));
                case 's':
                        dump_cmdline = 1;
                        break;
+               case 'r':
+                       read_only = 1;
+                       break;
                case 'v':
                        printf("%s\n", fio_version_string);
                        exit(0);
+               case 'e':
+                       if (!strcmp("always", optarg))
+                               eta_print = FIO_ETA_ALWAYS;
+                       else if (!strcmp("never", optarg))
+                               eta_print = FIO_ETA_NEVER;
+                       break;
+               case 'd':
+                       if (set_debug(optarg))
+                               do_exit++;
+                       break;
+               case 'x':
+                       if (!strcmp(optarg, "global")) {
+                               log_err("fio: can't use global as only "
+                                       "section\n");
+                               do_exit++;
+                               exit_val = 1;
+                               break;
+                       }
+                       if (job_section)
+                               free(job_section);
+                       job_section = strdup(optarg);
+                       break;
                case FIO_GETOPT_JOB: {
-                       const char *opt = long_options[lidx].name;
+                       const char *opt = l_opts[lidx].name;
                        char *val = optarg;
 
                        if (!strncmp(opt, "name", 4) && td) {
@@ -790,35 +1024,38 @@ static int parse_cmd_line(int argc, char *argv[])
                                td = NULL;
                        }
                        if (!td) {
+                               int is_section = !strncmp(opt, "name", 4);
                                int global = 0;
 
-                               if (strncmp(opt, "name", 4) ||
-                                   !strncmp(val, "global", 6))
+                               if (!is_section || !strncmp(val, "global", 6))
                                        global = 1;
 
+                               if (is_section && skip_this_section(val))
+                                       continue;
+
                                td = get_new_job(global, &def_thread);
                                if (!td)
                                        return 0;
                        }
 
                        ret = fio_cmd_option_parse(td, opt, val);
-                       if (ret)
-                               dont_add_job = 1;
                        break;
                }
                default:
+                       do_exit++;
+                       exit_val = 1;
                        break;
                }
        }
 
+       if (do_exit)
+               exit(exit_val);
+
        if (td) {
-               if (dont_add_job)
-                       put_job(td);
-               else {
+               if (!ret)
                        ret = add_job(td, td->o.name ?: "fio", 0);
-                       if (ret)
-                               put_job(td);
-               }
+               if (ret)
+                       put_job(td);
        }
 
        while (optind < argc) {
@@ -831,7 +1068,6 @@ static int parse_cmd_line(int argc, char *argv[])
        return ini_idx;
 }
 
-
 int parse_options(int argc, char *argv[])
 {
        int job_files, i;
@@ -839,7 +1075,7 @@ int parse_options(int argc, char *argv[])
        f_out = stdout;
        f_err = stderr;
 
-       fio_options_dup_and_init(long_options);
+       fio_options_dup_and_init(l_opts);
 
        if (setup_thread_area())
                return 1;
@@ -864,6 +1100,7 @@ int parse_options(int argc, char *argv[])
                        return 0;
 
                log_err("No jobs defined(s)\n");
+               usage(argv[0]);
                return 1;
        }