Merge branch 'asmfix' of https://github.com/oohal/fio
[fio.git] / ioengines.c
index 185314f05fd41f7bb6291217012f8c7f6f3f8beb..919781c4e8e11a78a62c0e4fa189fdc820a30902 100644 (file)
 #include <unistd.h>
 #include <string.h>
 #include <dlfcn.h>
+#include <fcntl.h>
 #include <assert.h>
 
 #include "fio.h"
-#include "os.h"
+#include "diskutil.h"
 
-static LIST_HEAD(engine_list);
+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;
+               log_err("bad ioops version %d (want %d)\n", ops->version,
+                                                       FIO_IOOPS_VERSION);
+               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;
-       
-       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;
+               return false;
+
+       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)
 {
-       list_del(&ops->list);
-       INIT_LIST_HEAD(&ops->list);
+       dprint(FD_IO, "ioengine %s unregistered\n", ops->name);
+       flist_del(&ops->list);
+       INIT_FLIST_HEAD(&ops->list);
 }
 
 void register_ioengine(struct ioengine_ops *ops)
 {
-       INIT_LIST_HEAD(&ops->list);
-       list_add_tail(&ops->list, &engine_list);
+       dprint(FD_IO, "ioengine %s registered\n", ops->name);
+       INIT_FLIST_HEAD(&ops->list);
+       flist_add_tail(&ops->list, &engine_list);
 }
 
 static struct ioengine_ops *find_ioengine(const char *name)
 {
        struct ioengine_ops *ops;
-       struct list_head *entry;
+       struct flist_head *entry;
 
-       list_for_each(entry, &engine_list) {
-               ops = list_entry(entry, struct ioengine_ops, list);
+       flist_for_each(entry, &engine_list) {
+               ops = flist_entry(entry, struct ioengine_ops, list);
                if (!strcmp(name, ops->name))
                        return ops;
        }
@@ -87,6 +83,8 @@ static struct ioengine_ops *dlopen_ioengine(struct thread_data *td,
        struct ioengine_ops *ops;
        void *dlhandle;
 
+       dprint(FD_IO, "dload engine %s\n", engine_lib);
+
        dlerror();
        dlhandle = dlopen(engine_lib, RTLD_LAZY);
        if (!dlhandle) {
@@ -98,22 +96,41 @@ static struct ioengine_ops *dlopen_ioengine(struct thread_data *td,
         * Unlike the included modules, external engines should have a
         * non-static ioengine structure that we can reference.
         */
-       ops = dlsym(dlhandle, "ioengine");
+       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);
 
        /*
@@ -137,98 +154,209 @@ 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 ops;
+}
 
-       return ret;
+/*
+ * For cleaning up an ioengine which never made it to init().
+ */
+void free_ioengine(struct thread_data *td)
+{
+       dprint(FD_IO, "free ioengine %s\n", td->io_ops->name);
+
+       if (td->eo && td->io_ops->options) {
+               options_free(td->io_ops->options, td->eo);
+               free(td->eo);
+               td->eo = NULL;
+       }
+
+       if (td->io_ops_dlhandle)
+               dlclose(td->io_ops_dlhandle);
+
+       td->io_ops = NULL;
 }
 
 void close_ioengine(struct thread_data *td)
 {
-       if (td->io_ops->cleanup)
-               td->io_ops->cleanup(td);
+       dprint(FD_IO, "close ioengine %s\n", td->io_ops->name);
 
-       if (td->io_ops->dlhandle)
-               dlclose(td->io_ops->dlhandle);
+       if (td->io_ops->cleanup) {
+               td->io_ops->cleanup(td);
+               td->io_ops_data = NULL;
+       }
 
-       free(td->io_ops);
-       td->io_ops = NULL;
+       free_ioengine(td);
 }
 
 int td_io_prep(struct thread_data *td, struct io_u *io_u)
 {
-       if (td->io_ops->prep)
-               return td->io_ops->prep(td, io_u);
+       dprint_io_u(io_u, "prep");
+       fio_ro_check(td, io_u);
+
+       lock_file(td, io_u->file, io_u->ddir);
+
+       if (td->io_ops->prep) {
+               int ret = td->io_ops->prep(td, io_u);
+
+               dprint(FD_IO, "->prep(%p)=%d\n", io_u, ret);
+               if (ret)
+                       unlock_file(td, io_u->file);
+               return ret;
+       }
 
        return 0;
 }
 
-int td_io_getevents(struct thread_data *td, int min, int max,
-                   struct timespec *t)
+int td_io_getevents(struct thread_data *td, unsigned int min, unsigned int max,
+                   const struct timespec *t)
 {
-       if (min > 0 && td->io_ops->commit) {
-               int r = td->io_ops->commit(td);
+       int r = 0;
+
+       /*
+        * For ioengine=rdma one side operation RDMA_WRITE or RDMA_READ,
+        * server side gets a message from the client
+        * side that the task is finished, and
+        * td->done is set to 1 after td_io_commit(). In this case,
+        * there is no need to reap complete event in server side.
+        */
+       if (td->done)
+               return 0;
 
+       if (min > 0 && td->io_ops->commit) {
+               r = td->io_ops->commit(td);
                if (r < 0)
-                       return r;
+                       goto out;
        }
-       if (td->io_ops->getevents)
-               return td->io_ops->getevents(td, min, max, t);
+       if (max > td->cur_depth)
+               max = td->cur_depth;
+       if (min > max)
+               max = min;
+
+       r = 0;
+       if (max && td->io_ops->getevents)
+               r = td->io_ops->getevents(td, min, max, t);
+out:
+       if (r >= 0) {
+               /*
+                * Reflect that our submitted requests were retrieved with
+                * whatever OS async calls are in the underlying engine.
+                */
+               td->io_u_in_flight -= r;
+               io_u_mark_complete(td, r);
+       } else
+               td_verror(td, r, "get_events");
 
-       return 0;
+       dprint(FD_IO, "getevents: %d\n", r);
+       return r;
 }
 
 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) {
-               fio_gettime(&io_u->issue_time, NULL);
+       if (td_ioengine_flagged(td, FIO_SYNCIO)) {
+               if (fio_fill_issue_time(td))
+                       fio_gettime(&io_u->issue_time, NULL);
 
                /*
-                * for a sync engine, set the timeout upfront
+                * only used for iolog
                 */
-               if (mtime_since(&td->timeout_end, &io_u->issue_time) < IO_U_TIMEOUT)
-                       io_u_set_timeout(td);
+               if (td->o.read_iolog_file)
+                       memcpy(&td->last_issue, &io_u->issue_time,
+                                       sizeof(io_u->issue_time));
        }
 
-       if (io_u->ddir != DDIR_SYNC)
-               td->io_issues[io_u->ddir]++;
-
-       io_u_mark_depth(td, io_u);
+       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);
 
-       if (ret == FIO_Q_QUEUED || ret == FIO_Q_COMPLETED)
-               get_file(io_u->file);
+       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
+        * IO, then it's likely an alignment problem or because the host fs
+        * does not support O_DIRECT
+        */
+       if (io_u->error == EINVAL && td->io_issues[io_u->ddir & 1] == 1 &&
+           td->o.odirect) {
 
-       if (ret == FIO_Q_QUEUED) {
+               log_info("fio: first direct IO errored. File system may not "
+                        "support direct IO, or iomem_align= is bad. Try "
+                        "setting direct=0.\n");
+       }
+
+       if (!td->io_ops->commit || io_u->ddir == DDIR_TRIM) {
+               io_u_mark_submit(td, 1);
+               io_u_mark_complete(td, 1);
+       }
+
+       if (ret == FIO_Q_COMPLETED) {
+               if (ddir_rw(io_u->ddir)) {
+                       io_u_mark_depth(td, 1);
+                       td->ts.total_io_u[io_u->ddir]++;
+               }
+       } else if (ret == FIO_Q_QUEUED) {
                int r;
 
                td->io_u_queued++;
-               if (td->io_u_queued > td->iodepth_batch) {
+
+               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);
                        if (r < 0)
                                return r;
                }
        }
 
-       if ((td->io_ops->flags & FIO_SYNCIO) == 0) {
-               fio_gettime(&io_u->issue_time, NULL);
+       if (!td_ioengine_flagged(td, FIO_SYNCIO)) {
+               if (fio_fill_issue_time(td))
+                       fio_gettime(&io_u->issue_time, NULL);
 
                /*
-                * async engine, set the timeout here
+                * only used for iolog
                 */
-               if (ret == FIO_Q_QUEUED &&
-                   mtime_since(&td->timeout_end, &io_u->issue_time) < IO_U_TIMEOUT)
-                       io_u_set_timeout(td);
+               if (td->o.read_iolog_file)
+                       memcpy(&td->last_issue, &io_u->issue_time,
+                                       sizeof(io_u->issue_time));
        }
 
        return ret;
@@ -236,50 +364,227 @@ int td_io_queue(struct thread_data *td, struct io_u *io_u)
 
 int td_io_init(struct thread_data *td)
 {
-       if (td->io_ops->init)
-               return td->io_ops->init(td);
+       int ret = 0;
+
+       if (td->io_ops->init) {
+               ret = td->io_ops->init(td);
+               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;
+       }
 
-       return 0;
+       return ret;
 }
 
 int td_io_commit(struct thread_data *td)
 {
-       if (!td->cur_depth)
+       int ret;
+
+       dprint(FD_IO, "calling ->commit(), depth %d\n", td->cur_depth);
+
+       if (!td->cur_depth || !td->io_u_queued)
                return 0;
 
+       io_u_mark_depth(td, td->io_u_queued);
+
+       if (td->io_ops->commit) {
+               ret = td->io_ops->commit(td);
+               if (ret)
+                       td_verror(td, -ret, "io commit");
+       }
+
+       /*
+        * Reflect that events were submitted as async IO requests.
+        */
+       td->io_u_in_flight += td->io_u_queued;
        td->io_u_queued = 0;
-       if (td->io_ops->commit)
-               return td->io_ops->commit(td);
 
        return 0;
 }
 
 int td_io_open_file(struct thread_data *td, struct fio_file *f)
 {
-       if (td->io_ops->open_file(td, f))
-               return 1;
+       assert(!fio_file_open(f));
+       assert(f->fd == -1);
+
+       if (td->io_ops->open_file(td, f)) {
+               if (td->error == EINVAL && td->o.odirect)
+                       log_err("fio: destination does not support O_DIRECT\n");
+               if (td->error == EMFILE) {
+                       log_err("fio: try reducing/setting openfiles (failed"
+                               " at %u of %u)\n", td->nr_open_files,
+                                                       td->o.nr_files);
+               }
 
-       f->last_free_lookup = 0;
-       f->last_completed_pos = 0;
-       f->last_pos = 0;
-       f->flags |= FIO_FILE_OPEN;
-       f->flags &= ~FIO_FILE_CLOSING;
+               assert(f->fd == -1);
+               assert(!fio_file_open(f));
+               return 1;
+       }
 
-       if (f->file_map)
-               memset(f->file_map, 0, f->num_maps * sizeof(long));
+       fio_file_reset(td, f);
+       fio_file_set_open(f);
+       fio_file_clear_closing(f);
+       disk_util_inc(f->du);
 
        td->nr_open_files++;
        get_file(f);
+
+       if (f->filetype == FIO_TYPE_PIPE) {
+               if (td_random(td)) {
+                       log_err("fio: can't seek on pipes (no random io)\n");
+                       goto err;
+               }
+       }
+
+       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_ADV_NONE &&
+           (f->filetype == FIO_TYPE_BLOCK || f->filetype == FIO_TYPE_FILE)) {
+               int flags;
+
+               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 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_WRITE_HINT
+       if (fio_option_is_set(&td->o, write_hint) &&
+           (f->filetype == FIO_TYPE_BLOCK || f->filetype == FIO_TYPE_FILE)) {
+               uint64_t hint = td->o.write_hint;
+               int cmd;
+
+               /*
+                * For direct IO, we just need/want to set the hint on
+                * the file descriptor. For buffered IO, we need to set
+                * it on the inode.
+                */
+               if (td->o.odirect)
+                       cmd = F_SET_FILE_RW_HINT;
+               else
+                       cmd = F_SET_RW_HINT;
+
+               if (fcntl(f->fd, cmd, &hint) < 0) {
+                       td_verror(td, errno, "fcntl write hint");
+                       goto err;
+               }
+       }
+#endif
+
+       if (td->o.odirect && !OS_O_DIRECT && fio_set_directio(td, f))
+               goto err;
+
+done:
+       log_file(td, f, FIO_LOG_OPEN_FILE);
        return 0;
+err:
+       disk_util_dec(f->du);
+       if (td->io_ops->close_file)
+               td->io_ops->close_file(td, f);
+       return 1;
 }
 
-void td_io_close_file(struct thread_data *td, struct fio_file *f)
+int td_io_close_file(struct thread_data *td, struct fio_file *f)
 {
+       if (!fio_file_closing(f))
+               log_file(td, f, FIO_LOG_CLOSE_FILE);
+
        /*
         * mark as closing, do real close when last io on it has completed
         */
-       f->flags |= FIO_FILE_CLOSING;
+       fio_file_set_closing(f);
 
-       put_file(td, f);
+       disk_util_dec(f->du);
+
+       if (td->o.file_lock_mode != FILE_LOCK_NONE)
+               unlock_file_all(td, f);
+
+       return put_file(td, f);
 }
 
+int td_io_unlink_file(struct thread_data *td, struct fio_file *f)
+{
+       if (td->io_ops->unlink_file)
+               return td->io_ops->unlink_file(td, f);
+       else {
+               int ret;
+
+               ret = unlink(f->file_name);
+               if (ret < 0)
+                       return errno;
+
+               return 0;
+       }
+}
+
+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);
+}
+
+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) {
+                       io_ops = flist_entry(entry, struct ioengine_ops, list);
+                       log_info("\t%s\n", io_ops->name);
+               }
+               return 0;
+       }
+       sep = strchr(engine, ',');
+       if (sep) {
+               *sep = 0;
+               sep++;
+       }
+
+       memset(&td, 0, sizeof(td));
+
+       io_ops = load_ioengine(&td, engine);
+       if (!io_ops) {
+               log_info("IO engine %s not found\n", engine);
+               return 1;
+       }
+
+       if (io_ops->options)
+               ret = show_cmd_help(io_ops->options, sep);
+       else
+               log_info("IO engine %s has no options\n", io_ops->name);
+
+       free_ioengine(&td);
+
+       return ret;
+}