Token-based flow control
[fio.git] / init.c
diff --git a/init.c b/init.c
index 0ccb18573389906a9b8900b00f9053924ea4baf8..d7d801181c435247e24217d5d53bfcc372698837 100644 (file)
--- a/init.c
+++ b/init.c
@@ -54,7 +54,7 @@ char **job_sections = NULL;
 int nr_job_sections = 0;
 char *exec_profile = NULL;
 int warnings_fatal = 0;
-int terse_version = 2;
+int terse_version = 3;
 int is_backend = 0;
 int nr_clients = 0;
 int log_syslog = 0;
@@ -138,6 +138,11 @@ static struct option l_opts[FIO_NR_OPTIONS] = {
                .has_arg        = optional_argument,
                .val            = 'c' | FIO_CLIENT_FLAG,
        },
+       {
+               .name              = (char *) "enghelp",
+               .has_arg        = optional_argument,
+               .val                = 'i' | FIO_CLIENT_FLAG,
+       },
        {
                .name           = (char *) "showcmd",
                .has_arg        = no_argument,
@@ -216,6 +221,7 @@ static void free_shm(void)
 
                threads = NULL;
                file_hash_exit();
+               flow_exit();
                fio_debug_jobp = NULL;
                shmdt(tp);
                shmctl(shm_id, IPC_RMID, &sbuf);
@@ -250,7 +256,7 @@ static int setup_thread_area(void)
                shm_id = shmget(0, size, IPC_CREAT | 0600);
                if (shm_id != -1)
                        break;
-               if (errno != EINVAL) {
+               if (errno != EINVAL && errno != ENOMEM) {
                        perror("shmget");
                        break;
                }
@@ -272,13 +278,17 @@ static int setup_thread_area(void)
        fio_debug_jobp = (void *) hash + file_hash_size;
        *fio_debug_jobp = -1;
        file_hash_init(hash);
+
+       flow_init();
+
        return 0;
 }
 
 /*
  * Return a free job structure.
  */
-static struct thread_data *get_new_job(int global, struct thread_data *parent)
+static struct thread_data *get_new_job(int global, struct thread_data *parent,
+                                      int preserve_eo)
 {
        struct thread_data *td;
 
@@ -297,10 +307,14 @@ static struct thread_data *get_new_job(int global, struct thread_data *parent)
        td = &threads[thread_number++];
        *td = *parent;
 
+       td->io_ops = NULL;
+       if (!preserve_eo)
+               td->eo = NULL;
+
        td->o.uid = td->o.gid = -1U;
 
        dup_files(td, parent);
-       options_mem_dupe(td);
+       fio_options_mem_dupe(td);
 
        profile_add_hooks(td);
 
@@ -314,11 +328,14 @@ static void put_job(struct thread_data *td)
                return;
 
        profile_td_exit(td);
+       flow_exit_job(td);
 
        if (td->error)
                log_info("fio: %s\n", td->verror);
 
        fio_options_free(td);
+       if (td->io_ops)
+               free_ioengine(td);
 
        memset(&threads[td->thread_number - 1], 0, sizeof(*td));
        thread_number--;
@@ -327,21 +344,19 @@ static void put_job(struct thread_data *td)
 static int __setup_rate(struct thread_data *td, enum fio_ddir ddir)
 {
        unsigned int bs = td->o.min_bs[ddir];
-       unsigned long long bytes_per_sec;
 
        assert(ddir_rw(ddir));
 
        if (td->o.rate[ddir])
-               bytes_per_sec = td->o.rate[ddir];
+               td->rate_bps[ddir] = td->o.rate[ddir];
        else
-               bytes_per_sec = td->o.rate_iops[ddir] * bs;
+               td->rate_bps[ddir] = td->o.rate_iops[ddir] * bs;
 
-       if (!bytes_per_sec) {
+       if (!td->rate_bps[ddir]) {
                log_err("rate lower than supported\n");
                return -1;
        }
 
-       td->rate_nsec_cycle[ddir] = 1000000000ULL / bytes_per_sec;
        td->rate_pending_usleep[ddir] = 0;
        return 0;
 }
@@ -392,11 +407,18 @@ static int fixup_options(struct thread_data *td)
        }
 
        /*
-        * only really works for sequential io for now, and with 1 file
+        * only really works with 1 file
         */
-       if (o->zone_size && td_random(td) && o->open_files == 1)
+       if (o->zone_size && o->open_files == 1)
                o->zone_size = 0;
 
+       /*
+        * If zone_range isn't specified, backward compatibility dictates it
+        * should be made equal to zone_size.
+        */
+       if (o->zone_size && !o->zone_range)
+               o->zone_range = o->zone_size;
+
        /*
         * Reads can do overwrites, we always need to pre-create the file
         */
@@ -664,6 +686,62 @@ static int init_random_state(struct thread_data *td)
        return 0;
 }
 
+/*
+ * Initializes the ioengine configured for a job, if it has not been done so
+ * already.
+ */
+int ioengine_load(struct thread_data *td)
+{
+       const char *engine;
+
+       /*
+        * Engine has already been loaded.
+        */
+       if (td->io_ops)
+               return 0;
+
+       engine = get_engine_name(td->o.ioengine);
+       td->io_ops = load_ioengine(td, engine);
+       if (!td->io_ops) {
+               log_err("fio: failed to load engine %s\n", engine);
+               return 1;
+       }
+
+       if (td->io_ops->option_struct_size && td->io_ops->options) {
+               /*
+                * In cases where td->eo is set, clone it for a child thread.
+                * This requires that the parent thread has the same ioengine,
+                * but that requirement must be enforced by the code which
+                * cloned the thread.
+                */
+               void *origeo = td->eo;
+               /*
+                * Otherwise use the default thread options.
+                */
+               if (!origeo && td != &def_thread && def_thread.eo &&
+                   def_thread.io_ops->options == td->io_ops->options)
+                       origeo = def_thread.eo;
+
+               options_init(td->io_ops->options);
+               td->eo = malloc(td->io_ops->option_struct_size);
+               /*
+                * Use the default thread as an option template if this uses the
+                * same options structure and there are non-default options
+                * used.
+                */
+               if (origeo) {
+                       memcpy(td->eo, origeo, td->io_ops->option_struct_size);
+                       options_mem_dupe(td->eo, td->io_ops->options);
+               } else {
+                       memset(td->eo, 0, td->io_ops->option_struct_size);
+                       fill_default_options(td->eo, td->io_ops->options);
+               }
+               *(struct thread_data **)td->eo = td;
+       }
+
+       return 0;
+}
+
 /*
  * Adds a job to the list of things todo. Sanitizes the various options
  * to make sure we don't have conflicts, and initializes various
@@ -674,7 +752,6 @@ static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
        const char *ddir_str[] = { NULL, "read", "write", "rw", NULL,
                                   "randread", "randwrite", "randrw" };
        unsigned int i;
-       const char *engine;
        char fname[PATH_MAX];
        int numjobs, file_alloced;
 
@@ -695,12 +772,8 @@ static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
        if (profile_td_init(td))
                goto err;
 
-       engine = get_engine_name(td->o.ioengine);
-       td->io_ops = load_ioengine(td, engine);
-       if (!td->io_ops) {
-               log_err("fio: failed to load engine %s\n", engine);
+       if (ioengine_load(td))
                goto err;
-       }
 
        if (td->o.use_thread)
                nr_thread++;
@@ -728,6 +801,15 @@ static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
        if (fixup_options(td))
                goto err;
 
+       flow_init_job(td);
+
+       /*
+        * IO engines only need this for option callbacks, and the address may
+        * change in subprocesses.
+        */
+       if (td->eo)
+               *(struct thread_data **)td->eo = NULL;
+
        if (td->io_ops->flags & FIO_DISKLESSIO) {
                struct fio_file *f;
 
@@ -764,14 +846,14 @@ static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
                goto err;
 
        if (td->o.write_lat_log) {
-               setup_log(&td->lat_log);
-               setup_log(&td->slat_log);
-               setup_log(&td->clat_log);
+               setup_log(&td->lat_log, td->o.log_avg_msec);
+               setup_log(&td->slat_log, td->o.log_avg_msec);
+               setup_log(&td->clat_log, td->o.log_avg_msec);
        }
        if (td->o.write_bw_log)
-               setup_log(&td->bw_log);
+               setup_log(&td->bw_log, td->o.log_avg_msec);
        if (td->o.write_iops_log)
-               setup_log(&td->iops_log);
+               setup_log(&td->iops_log, td->o.log_avg_msec);
 
        if (!td->o.name)
                td->o.name = strdup(jobname);
@@ -814,7 +896,7 @@ static int add_job(struct thread_data *td, const char *jobname, int job_add_num)
         */
        numjobs = td->o.numjobs;
        while (--numjobs) {
-               struct thread_data *td_new = get_new_job(0, td);
+               struct thread_data *td_new = get_new_job(0, td, 1);
 
                if (!td_new)
                        goto err;
@@ -862,11 +944,11 @@ void add_job_opts(const char **o)
                        sprintf(jobname, "%s", o[i] + 5);
                }
                if (in_global && !td_parent)
-                       td_parent = get_new_job(1, &def_thread);
+                       td_parent = get_new_job(1, &def_thread, 0);
                else if (!in_global && !td) {
                        if (!td_parent)
                                td_parent = &def_thread;
-                       td = get_new_job(0, td_parent);
+                       td = get_new_job(0, td_parent, 0);
                }
                if (in_global)
                        fio_options_parse(td_parent, (char **) &o[i], 1);
@@ -964,7 +1046,7 @@ int parse_jobs_ini(char *file, int is_buf, int stonewall_flag)
                        if (is_buf)
                                p = strsep(&file, "\n");
                        else
-                               p = fgets(string, 4095, f);
+                               p = fgets(string, 4096, f);
                        if (!p)
                                break;
                }
@@ -1001,7 +1083,7 @@ int parse_jobs_ini(char *file, int is_buf, int stonewall_flag)
                        first_sect = 0;
                }
 
-               td = get_new_job(global, &def_thread);
+               td = get_new_job(global, &def_thread, 0);
                if (!td) {
                        ret = 1;
                        break;
@@ -1107,32 +1189,38 @@ static void usage(const char *name)
 {
        printf("fio %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");
-       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--terse-version=x Terse version output format\n");
-       printf("\t--help\t\tPrint this page\n");
-       printf("\t--cmdhelp=cmd\tPrint command help, \"all\" for all of"
+       printf("  --debug=options\tEnable debug logging. May be one/more of:\n"
+               "\t\t\tprocess,file,io,mem,blktrace,verify,random,parse,\n"
+               "\t\t\tdiskutil,job,mutex,profile,time,net\n");
+       printf("  --output\t\tWrite output to file\n");
+       printf("  --timeout\t\tRuntime in seconds\n");
+       printf("  --latency-log\t\tGenerate per-job latency logs\n");
+       printf("  --bandwidth-log\tGenerate per-job bandwidth logs\n");
+       printf("  --minimal\t\tMinimal (terse) output\n");
+       printf("  --version\t\tPrint version info and exit\n");
+       printf("  --terse-version=x\tSet terse version output format to 'x'\n");
+       printf("  --help\t\tPrint this page\n");
+       printf("  --cmdhelp=cmd\t\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"
+       printf("  --enghelp=engine\tPrint ioengine help, or list"
+               " available ioengines\n");
+       printf("  --enghelp=engine,cmd\tPrint help for an ioengine"
+               " cmd\n");
+       printf("  --showcmd\t\tTurn a job file into command line options\n");
+       printf("  --eta=when\t\tWhen ETA estimate should be printed\n");
+       printf("            \t\tMay be \"always\", \"never\" or \"auto\"\n");
+       printf("  --readonly\t\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"
+       printf("  --section=name\tOnly run specified section in job file\n");
+       printf("  --alloc-size=kb\tSet smalloc pool to this size in kb"
                " (def 1024)\n");
-       printf("\t--warnings-fatal Fio parser warnings are fatal\n");
-       printf("\t--max-jobs\tMaximum number of threads/processes to support\n");
-       printf("\t--server=args\tStart a backend fio server\n");
-       printf("\t--daemonize=pidfile Background fio server, write pid to file\n");
-       printf("\t--client=hostname Talk to remote backend fio server at hostname\n");
+       printf("  --warnings-fatal\tFio parser warnings are fatal\n");
+       printf("  --max-jobs=nr\t\tMaximum number of threads/processes to support\n");
+       printf("  --server=args\t\tStart a backend fio server\n");
+       printf("  --daemonize=pidfile\tBackground fio server, write pid to file\n");
+       printf("  --client=hostname\tTalk to remote backend fio server at hostname\n");
        printf("\nFio was written by Jens Axboe <jens.axboe@oracle.com>");
-       printf("\n                   Jens Axboe <jaxboe@fusionio.com>\n");
+       printf("\n                 Jens Axboe <jaxboe@fusionio.com>\n");
 }
 
 #ifdef FIO_INC_DEBUG
@@ -1316,6 +1404,12 @@ int parse_cmd_line(int argc, char *argv[])
                                do_exit++;
                        }
                        break;
+               case 'i':
+                       if (!cur_client) {
+                               fio_show_ioengine_help(optarg);
+                               do_exit++;
+                       }
+                       break;
                case 's':
                        dump_cmdline = 1;
                        break;
@@ -1330,7 +1424,7 @@ int parse_cmd_line(int argc, char *argv[])
                        break;
                case 'V':
                        terse_version = atoi(optarg);
-                       if (terse_version != 3) {
+                       if (!(terse_version == 2 || terse_version == 3)) {
                                log_err("fio: bad terse version format\n");
                                exit_val = 1;
                                do_exit++;
@@ -1385,12 +1479,28 @@ int parse_cmd_line(int argc, char *argv[])
                                if (is_section && skip_this_section(val))
                                        continue;
 
-                               td = get_new_job(global, &def_thread);
-                               if (!td)
+                               td = get_new_job(global, &def_thread, 1);
+                               if (!td || ioengine_load(td))
                                        return 0;
+                               fio_options_set_ioengine_opts(l_opts, td);
                        }
 
                        ret = fio_cmd_option_parse(td, opt, val);
+
+                       if (!ret && !strcmp(opt, "ioengine")) {
+                               free_ioengine(td);
+                               if (ioengine_load(td))
+                                       return 0;
+                               fio_options_set_ioengine_opts(l_opts, td);
+                       }
+                       break;
+               }
+               case FIO_GETOPT_IOENGINE: {
+                       const char *opt = l_opts[lidx].name;
+                       char *val = optarg;
+                       opt = l_opts[lidx].name;
+                       val = optarg;
+                       ret = fio_cmd_ioengine_option_parse(td, opt, val);
                        break;
                }
                case 'w':