Add/correct missing command line options in help text
[fio.git] / init.c
diff --git a/init.c b/init.c
index 073ad4c370230c9f63eddf509ec73328fce8c9c2..f5dff5059dabd76b6477a2a074de1ec42a79a3dc 100644 (file)
--- a/init.c
+++ b/init.c
@@ -17,7 +17,7 @@
 #include "fio.h"
 #include "parse.h"
 
-static char fio_version_string[] = "fio 1.16.4";
+static char fio_version_string[] = "fio 1.18.1";
 
 #define FIO_RANDSEED           (0xb1899bedUL)
 
@@ -30,17 +30,21 @@ 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;
 
 int write_bw_log = 0;
+int read_only = 0;
 
 static int def_timeout = 0;
 static int write_lat_log = 0;
 
 static int prev_group_jobs;
 
+unsigned long fio_debug = 0;
+
 /*
  * Command line options. These will contain the above, plus a few
  * extra that only pertain to fio itself and not jobs.
@@ -89,7 +93,22 @@ 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           = NULL,
@@ -180,6 +199,11 @@ static int fixup_options(struct thread_data *td)
 {
        struct thread_options *o = &td->o;
 
+       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->rwmix[DDIR_READ] + o->rwmix[DDIR_WRITE] > 100)
                o->rwmix[DDIR_WRITE] = 100 - o->rwmix[DDIR_READ];
 
@@ -189,13 +213,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
         */
@@ -222,9 +239,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 +293,13 @@ static int fixup_options(struct thread_data *td)
                o->time_based = 0;
        }
 
+       if (o->fill_device && !o->size)
+               o->size = ULONG_LONG_MAX;
+       
+       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");
+
        return 0;
 }
 
@@ -551,36 +572,51 @@ 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;
+
+       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);
 
        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;
+                       log_err("fio: option <%s> outside of [] job section\n", p);
+                       break;
                }
 
                global = !strncmp(name, "global", 6);
@@ -609,20 +645,23 @@ static int parse_jobs_ini(char *file, int stonewall_flag)
                        stonewall = 0;
                }
 
-               fgetpos(f, &off);
                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);
-
                        /*
                         * Don't break here, continue parsing options so we
                         * dump all the bad ones. Makes trial/error fixups
@@ -633,10 +672,9 @@ static int parse_jobs_ini(char *file, int stonewall_flag)
                                log_info("--%s ", p);
                }
 
-               if (!ret) {
-                       fsetpos(f, &off);
+               if (!ret)
                        ret = add_job(td, name, 0);
-               else {
+               else {
                        log_err("fio: job %s dropped\n", name);
                        put_job(td);
                }
@@ -647,7 +685,8 @@ static int parse_jobs_ini(char *file, int stonewall_flag)
 
        free(string);
        free(name);
-       fclose(f);
+       if (f != stdin)
+               fclose(f);
        return ret;
 }
 
@@ -714,13 +753,16 @@ static int setup_thread_area(void)
                return 1;
        }
 
+       memset(threads, 0, max_jobs * sizeof(struct thread_data));
        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");
@@ -730,8 +772,68 @@ static void usage(void)
        printf("\t--help\t\tPrint this page\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");
 }
 
+#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 },
+       { },
+};
+
+static void 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;
+       } else if (!strcmp(string, "all")) {
+               fio_debug = ~0UL;
+               return;
+       }
+
+       while ((opt = strsep(&p, ",")) != NULL) {
+               int found = 0;
+
+               for (i = 0; debug_levels[i].name; i++) {
+                       dl = &debug_levels[i];
+                       if (!strncmp(opt, dl->name, strlen(opt))) {
+                               log_info("fio: set debug option %s\n", opt);
+                               found = 1;
+                               fio_debug |= (1UL << dl->shift);
+                               break;
+                       }
+               }
+
+               if (!found)
+                       log_err("fio: debug mask %s not found\n", opt);
+       }
+}
+#else
+static void set_debug(const char *string)
+{
+       log_err("fio: debug tracing not included in build\n");
+}
+#endif
+
 static int parse_cmd_line(int argc, char *argv[])
 {
        struct thread_data *td = NULL;
@@ -760,16 +862,28 @@ 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':
+                       set_debug(optarg);
+                       break;
                case FIO_GETOPT_JOB: {
                        const char *opt = long_options[lidx].name;
                        char *val = optarg;
@@ -824,7 +938,6 @@ static int parse_cmd_line(int argc, char *argv[])
        return ini_idx;
 }
 
-
 int parse_options(int argc, char *argv[])
 {
        int job_files, i;
@@ -857,6 +970,7 @@ int parse_options(int argc, char *argv[])
                        return 0;
 
                log_err("No jobs defined(s)\n");
+               usage(argv[0]);
                return 1;
        }