Separate io_u from ioengine [2/3] - move io_u functions
[fio.git] / ioengines.c
index 8b71e13449638dfec259370a57b74d1f7f1258c2..c90a2ca5bde30e75dec5261130b6b77fb6a1999b 100644 (file)
 
 static FLIST_HEAD(engine_list);
 
-static int check_engine_ops(struct ioengine_ops *ops)
+static bool check_engine_ops(struct ioengine_ops *ops)
 {
        if (ops->version != FIO_IOOPS_VERSION) {
                log_err("bad ioops version %d (want %d)\n", ops->version,
                                                        FIO_IOOPS_VERSION);
-               return 1;
+               return true;
        }
 
        if (!ops->queue) {
                log_err("%s: no queue handler\n", ops->name);
-               return 1;
+               return true;
        }
 
        /*
         * sync engines only need a ->queue()
         */
        if (ops->flags & FIO_SYNCIO)
-               return 0;
+               return false;
 
-       if (!ops->event) {
-               log_err("%s: no event handler\n", ops->name);
-               return 1;
-       }
-       if (!ops->getevents) {
-               log_err("%s: no getevents handler\n", ops->name);
-               return 1;
-       }
-       if (!ops->queue) {
-               log_err("%s: no queue handler\n", ops->name);
-               return 1;
+       if (!ops->event || !ops->getevents) {
+               log_err("%s: no event/getevents handler\n", ops->name);
+               return true;
        }
 
-       return 0;
+       return false;
 }
 
 void unregister_ioengine(struct ioengine_ops *ops)
@@ -107,23 +99,38 @@ static struct ioengine_ops *dlopen_ioengine(struct thread_data *td,
        ops = dlsym(dlhandle, engine_lib);
        if (!ops)
                ops = dlsym(dlhandle, "ioengine");
+
+       /*
+        * For some external engines (like C++ ones) it is not that trivial
+        * to provide a non-static ionengine structure that we can reference.
+        * Instead we call a method which allocates the required ioengine
+        * structure.
+        */
+       if (!ops) {
+               get_ioengine_t get_ioengine = dlsym(dlhandle, "get_ioengine");
+
+               if (get_ioengine)
+                       get_ioengine(&ops);
+       }
+
        if (!ops) {
                td_vmsg(td, -1, dlerror(), "dlsym");
                dlclose(dlhandle);
                return NULL;
        }
 
-       ops->dlhandle = dlhandle;
+       td->io_ops_dlhandle = dlhandle;
        return ops;
 }
 
 struct ioengine_ops *load_ioengine(struct thread_data *td, const char *name)
 {
-       struct ioengine_ops *ops, *ret;
-       char engine[16];
+       struct ioengine_ops *ops;
+       char engine[64];
 
        dprint(FD_IO, "load ioengine %s\n", name);
 
+       engine[sizeof(engine) - 1] = '\0';
        strncpy(engine, name, sizeof(engine) - 1);
 
        /*
@@ -147,11 +154,7 @@ struct ioengine_ops *load_ioengine(struct thread_data *td, const char *name)
        if (check_engine_ops(ops))
                return NULL;
 
-       ret = malloc(sizeof(*ret));
-       memcpy(ret, ops, sizeof(*ret));
-       ret->data = NULL;
-
-       return ret;
+       return ops;
 }
 
 /*
@@ -167,10 +170,9 @@ void free_ioengine(struct thread_data *td)
                td->eo = NULL;
        }
 
-       if (td->io_ops->dlhandle)
-               dlclose(td->io_ops->dlhandle);
+       if (td->io_ops_dlhandle)
+               dlclose(td->io_ops_dlhandle);
 
-       free(td->io_ops);
        td->io_ops = NULL;
 }
 
@@ -180,7 +182,7 @@ void close_ioengine(struct thread_data *td)
 
        if (td->io_ops->cleanup) {
                td->io_ops->cleanup(td);
-               td->io_ops->data = NULL;
+               td->io_ops_data = NULL;
        }
 
        free_ioengine(td);
@@ -206,7 +208,7 @@ int td_io_prep(struct thread_data *td, struct io_u *io_u)
 }
 
 int td_io_getevents(struct thread_data *td, unsigned int min, unsigned int max,
-                   struct timespec *t)
+                   const struct timespec *t)
 {
        int r = 0;
 
@@ -250,20 +252,27 @@ out:
 
 int td_io_queue(struct thread_data *td, struct io_u *io_u)
 {
+       const enum fio_ddir ddir = acct_ddir(io_u);
+       unsigned long buflen = io_u->xfer_buflen;
        int ret;
 
        dprint_io_u(io_u, "queue");
        fio_ro_check(td, io_u);
 
        assert((io_u->flags & IO_U_F_FLIGHT) == 0);
-       io_u->flags |= IO_U_F_FLIGHT;
+       io_u_set(td, io_u, IO_U_F_FLIGHT);
 
        assert(fio_file_open(io_u->file));
 
+       /*
+        * If using a write iolog, store this entry.
+        */
+       log_io_u(td, io_u);
+
        io_u->error = 0;
        io_u->resid = 0;
 
-       if (td->io_ops->flags & FIO_SYNCIO) {
+       if (td_ioengine_flagged(td, FIO_SYNCIO)) {
                if (fio_fill_issue_time(td))
                        fio_gettime(&io_u->issue_time, NULL);
 
@@ -275,13 +284,30 @@ int td_io_queue(struct thread_data *td, struct io_u *io_u)
                                        sizeof(struct timeval));
        }
 
-       if (ddir_rw(io_u->ddir))
-               td->io_issues[io_u->ddir]++;
+       if (ddir_rw(ddir)) {
+               td->io_issues[ddir]++;
+               td->io_issue_bytes[ddir] += buflen;
+               td->rate_io_issue_bytes[ddir] += buflen;
+       }
 
        ret = td->io_ops->queue(td, io_u);
 
        unlock_file(td, io_u->file);
 
+       if (ret == FIO_Q_BUSY && ddir_rw(ddir)) {
+               td->io_issues[ddir]--;
+               td->io_issue_bytes[ddir] -= buflen;
+               td->rate_io_issue_bytes[ddir] -= buflen;
+               io_u_clear(td, io_u, IO_U_F_FLIGHT);
+       }
+
+       /*
+        * If an error was seen and the io engine didn't propagate it
+        * back to 'td', do so.
+        */
+       if (io_u->error && !td->error)
+               td_verror(td, io_u->error, "td_io_queue");
+
        /*
         * Add warning for O_DIRECT so that users have an easier time
         * spotting potentially bad alignment. If this triggers for the first
@@ -292,10 +318,11 @@ int td_io_queue(struct thread_data *td, struct io_u *io_u)
            td->o.odirect) {
 
                log_info("fio: first direct IO errored. File system may not "
-                        "support direct IO, or iomem_align= is bad.\n");
+                        "support direct IO, or iomem_align= is bad. Try "
+                        "setting direct=0.\n");
        }
 
-       if (!td->io_ops->commit || ddir_trim(io_u->ddir)) {
+       if (!td->io_ops->commit || io_u->ddir == DDIR_TRIM) {
                io_u_mark_submit(td, 1);
                io_u_mark_complete(td, 1);
        }
@@ -308,10 +335,10 @@ int td_io_queue(struct thread_data *td, struct io_u *io_u)
        } else if (ret == FIO_Q_QUEUED) {
                int r;
 
-               if (ddir_rw(io_u->ddir)) {
-                       td->io_u_queued++;
+               td->io_u_queued++;
+
+               if (ddir_rw(io_u->ddir))
                        td->ts.total_io_u[io_u->ddir]++;
-               }
 
                if (td->io_u_queued >= td->o.iodepth_batch) {
                        r = td_io_commit(td);
@@ -320,7 +347,7 @@ int td_io_queue(struct thread_data *td, struct io_u *io_u)
                }
        }
 
-       if ((td->io_ops->flags & FIO_SYNCIO) == 0) {
+       if (!td_ioengine_flagged(td, FIO_SYNCIO)) {
                if (fio_fill_issue_time(td))
                        fio_gettime(&io_u->issue_time, NULL);
 
@@ -341,10 +368,13 @@ int td_io_init(struct thread_data *td)
 
        if (td->io_ops->init) {
                ret = td->io_ops->init(td);
-               if (ret && td->o.iodepth > 1) {
-                       log_err("fio: io engine init failed. Perhaps try"
-                               " reducing io depth?\n");
-               }
+               if (ret)
+                       log_err("fio: io engine %s init failed.%s\n",
+                               td->io_ops->name,
+                               td->o.iodepth > 1 ?
+                               " Perhaps try reducing io depth?" : "");
+               else
+                       td->io_ops_init = 1;
                if (!td->error)
                        td->error = ret;
        }
@@ -397,7 +427,7 @@ int td_io_open_file(struct thread_data *td, struct fio_file *f)
                return 1;
        }
 
-       fio_file_reset(f);
+       fio_file_reset(td, f);
        fio_file_set_open(f);
        fio_file_clear_closing(f);
        disk_util_inc(f->du);
@@ -412,26 +442,47 @@ int td_io_open_file(struct thread_data *td, struct fio_file *f)
                }
        }
 
-       if (td->io_ops->flags & FIO_DISKLESSIO)
+       if (td_ioengine_flagged(td, FIO_DISKLESSIO))
                goto done;
 
        if (td->o.invalidate_cache && file_invalidate_cache(td, f))
                goto err;
 
-       if (td->o.fadvise_hint &&
-           (f->filetype == FIO_TYPE_BD || f->filetype == FIO_TYPE_FILE)) {
+       if (td->o.fadvise_hint != F_ADV_NONE &&
+           (f->filetype == FIO_TYPE_BLOCK || f->filetype == FIO_TYPE_FILE)) {
                int flags;
 
-               if (td_random(td))
+               if (td->o.fadvise_hint == F_ADV_TYPE) {
+                       if (td_random(td))
+                               flags = POSIX_FADV_RANDOM;
+                       else
+                               flags = POSIX_FADV_SEQUENTIAL;
+               } else if (td->o.fadvise_hint == F_ADV_RANDOM)
                        flags = POSIX_FADV_RANDOM;
-               else
+               else if (td->o.fadvise_hint == F_ADV_SEQUENTIAL)
                        flags = POSIX_FADV_SEQUENTIAL;
+               else {
+                       log_err("fio: unknown fadvise type %d\n",
+                                                       td->o.fadvise_hint);
+                       flags = POSIX_FADV_NORMAL;
+               }
 
                if (posix_fadvise(f->fd, f->file_offset, f->io_size, flags) < 0) {
                        td_verror(td, errno, "fadvise");
                        goto err;
                }
        }
+#ifdef FIO_HAVE_STREAMID
+       if (td->o.fadvise_stream &&
+           (f->filetype == FIO_TYPE_BLOCK || f->filetype == FIO_TYPE_FILE)) {
+               off_t stream = td->o.fadvise_stream;
+
+               if (posix_fadvise(f->fd, stream, f->io_size, POSIX_FADV_STREAMID) < 0) {
+                       td_verror(td, errno, "fadvise streamid");
+                       goto err;
+               }
+       }
+#endif
 
 #ifdef FIO_OS_DIRECTIO
        /*
@@ -443,7 +494,12 @@ int td_io_open_file(struct thread_data *td, struct fio_file *f)
 
                if (ret) {
                        td_verror(td, ret, "fio_set_odirect");
-                       log_err("fio: the file system does not seem to support direct IO\n");
+                       if (ret == ENOTTY) { /* ENOTTY suggests RAW device or ZFS */
+                               log_err("fio: doing directIO to RAW devices or ZFS not supported\n");
+                       } else {
+                               log_err("fio: the file system does not seem to support direct IO\n");
+                       }
+
                        goto err;
                }
        }
@@ -470,89 +526,49 @@ int td_io_close_file(struct thread_data *td, struct fio_file *f)
        fio_file_set_closing(f);
 
        disk_util_dec(f->du);
-       unlock_file_all(td, f);
 
-       return put_file(td, f);
-}
+       if (td->o.file_lock_mode != FILE_LOCK_NONE)
+               unlock_file_all(td, f);
 
-int td_io_get_file_size(struct thread_data *td, struct fio_file *f)
-{
-       if (!td->io_ops->get_file_size)
-               return 0;
-
-       return td->io_ops->get_file_size(td, f);
+       return put_file(td, f);
 }
 
-static int do_sync_file_range(struct thread_data *td, struct fio_file *f)
+int td_io_unlink_file(struct thread_data *td, struct fio_file *f)
 {
-       off64_t offset, nbytes;
+       if (td->io_ops->unlink_file)
+               return td->io_ops->unlink_file(td, f);
+       else {
+               int ret;
 
-       offset = f->first_write;
-       nbytes = f->last_write - f->first_write;
+               ret = unlink(f->file_name);
+               if (ret < 0)
+                       return errno;
 
-       if (!nbytes)
                return 0;
-
-       return sync_file_range(f->fd, offset, nbytes, td->o.sync_file_range);
-}
-
-int do_io_u_sync(struct thread_data *td, struct io_u *io_u)
-{
-       int ret;
-
-       if (io_u->ddir == DDIR_SYNC) {
-               ret = fsync(io_u->file->fd);
-       } else if (io_u->ddir == DDIR_DATASYNC) {
-#ifdef FIO_HAVE_FDATASYNC
-               ret = fdatasync(io_u->file->fd);
-#else
-               ret = io_u->xfer_buflen;
-               io_u->error = EINVAL;
-#endif
-       } else if (io_u->ddir == DDIR_SYNC_FILE_RANGE)
-               ret = do_sync_file_range(td, io_u->file);
-       else {
-               ret = io_u->xfer_buflen;
-               io_u->error = EINVAL;
        }
-
-       if (ret < 0)
-               io_u->error = errno;
-
-       return ret;
 }
 
-int do_io_u_trim(struct thread_data *td, struct io_u *io_u)
+int td_io_get_file_size(struct thread_data *td, struct fio_file *f)
 {
-#ifndef FIO_HAVE_TRIM
-       io_u->error = EINVAL;
-       return 0;
-#else
-       struct fio_file *f = io_u->file;
-       int ret;
-
-       ret = os_trim(f->fd, io_u->offset, io_u->xfer_buflen);
-       if (!ret)
-               return io_u->xfer_buflen;
+       if (!td->io_ops->get_file_size)
+               return 0;
 
-       io_u->error = ret;
-       return 0;
-#endif
+       return td->io_ops->get_file_size(td, f);
 }
 
 int fio_show_ioengine_help(const char *engine)
 {
        struct flist_head *entry;
        struct thread_data td;
+       struct ioengine_ops *io_ops;
        char *sep;
        int ret = 1;
 
        if (!engine || !*engine) {
                log_info("Available IO engines:\n");
                flist_for_each(entry, &engine_list) {
-                       td.io_ops = flist_entry(entry, struct ioengine_ops,
-                                               list);
-                       log_info("\t%s\n", td.io_ops->name);
+                       io_ops = flist_entry(entry, struct ioengine_ops, list);
+                       log_info("\t%s\n", io_ops->name);
                }
                return 0;
        }
@@ -564,16 +580,16 @@ int fio_show_ioengine_help(const char *engine)
 
        memset(&td, 0, sizeof(td));
 
-       td.io_ops = load_ioengine(&td, engine);
-       if (!td.io_ops) {
+       io_ops = load_ioengine(&td, engine);
+       if (!io_ops) {
                log_info("IO engine %s not found\n", engine);
                return 1;
        }
 
-       if (td.io_ops->options)
-               ret = show_cmd_help(td.io_ops->options, sep);
+       if (io_ops->options)
+               ret = show_cmd_help(io_ops->options, sep);
        else
-               log_info("IO engine %s has no options\n", td.io_ops->name);
+               log_info("IO engine %s has no options\n", io_ops->name);
 
        free_ioengine(&td);