fixed compiler warnings if NDEBUG enabled in core code
[fio.git] / ioengines.c
1 /*
2  * The io parts of the fio tool, includes workers for sync and mmap'ed
3  * io, as well as both posix and linux libaio support.
4  *
5  * sync io is implemented on top of aio.
6  *
7  * This is not really specific to fio, if the get_io_u/put_io_u and
8  * structures was pulled into this as well it would be a perfectly
9  * generic io engine that could be used for other projects.
10  *
11  */
12 #include <stdlib.h>
13 #include <unistd.h>
14 #include <string.h>
15 #include <dlfcn.h>
16 #include <fcntl.h>
17 #include <assert.h>
18 #include <sys/types.h>
19 #include <dirent.h>
20 #include <errno.h>
21
22 #include "fio.h"
23 #include "diskutil.h"
24 #include "zbd.h"
25
26 static FLIST_HEAD(engine_list);
27
28 static bool check_engine_ops(struct thread_data *td, struct ioengine_ops *ops)
29 {
30         if (ops->version != FIO_IOOPS_VERSION) {
31                 log_err("bad ioops version %d (want %d)\n", ops->version,
32                                                         FIO_IOOPS_VERSION);
33                 return true;
34         }
35
36         if (!ops->queue) {
37                 log_err("%s: no queue handler\n", ops->name);
38                 return true;
39         }
40
41         /*
42          * sync engines only need a ->queue()
43          */
44         if (ops->flags & FIO_SYNCIO)
45                 return false;
46
47         /*
48          * async engines aren't reliable with offload
49          */
50         if ((td->o.io_submit_mode == IO_MODE_OFFLOAD) &&
51             (ops->flags & FIO_NO_OFFLOAD)) {
52                 log_err("%s: can't be used with offloaded submit. Use a sync "
53                         "engine\n", ops->name);
54                 return true;
55         }
56
57         if (!ops->event || !ops->getevents) {
58                 log_err("%s: no event/getevents handler\n", ops->name);
59                 return true;
60         }
61
62         return false;
63 }
64
65 void unregister_ioengine(struct ioengine_ops *ops)
66 {
67         dprint(FD_IO, "ioengine %s unregistered\n", ops->name);
68         flist_del_init(&ops->list);
69 }
70
71 void register_ioengine(struct ioengine_ops *ops)
72 {
73         dprint(FD_IO, "ioengine %s registered\n", ops->name);
74         flist_add_tail(&ops->list, &engine_list);
75 }
76
77 static struct ioengine_ops *find_ioengine(const char *name)
78 {
79         struct ioengine_ops *ops;
80         struct flist_head *entry;
81
82         flist_for_each(entry, &engine_list) {
83                 ops = flist_entry(entry, struct ioengine_ops, list);
84                 if (!strcmp(name, ops->name))
85                         return ops;
86         }
87
88         return NULL;
89 }
90
91 #ifdef CONFIG_DYNAMIC_ENGINES
92 static void *dlopen_external(struct thread_data *td, const char *engine)
93 {
94         char engine_path[PATH_MAX];
95         void *dlhandle;
96
97         sprintf(engine_path, "%s/fio-%s.so", FIO_EXT_ENG_DIR, engine);
98
99         dprint(FD_IO, "dlopen external %s\n", engine_path);
100         dlhandle = dlopen(engine_path, RTLD_LAZY);
101         if (!dlhandle)
102                 log_info("Engine %s not found; Either name is invalid, was not built, or fio-engine-%s package is missing.\n",
103                          engine, engine);
104
105         return dlhandle;
106 }
107 #else
108 #define dlopen_external(td, engine) (NULL)
109 #endif
110
111 static struct ioengine_ops *dlopen_ioengine(struct thread_data *td,
112                                             const char *engine_lib)
113 {
114         struct ioengine_ops *ops;
115         void *dlhandle;
116
117         if (!strncmp(engine_lib, "linuxaio", 8) ||
118             !strncmp(engine_lib, "aio", 3))
119                 engine_lib = "libaio";
120
121         dprint(FD_IO, "dlopen engine %s\n", engine_lib);
122
123         dlerror();
124         dlhandle = dlopen(engine_lib, RTLD_LAZY);
125         if (!dlhandle) {
126                 dlhandle = dlopen_external(td, engine_lib);
127                 if (!dlhandle) {
128                         td_vmsg(td, -1, dlerror(), "dlopen");
129                         return NULL;
130                 }
131         }
132
133         /*
134          * Unlike the included modules, external engines should have a
135          * non-static ioengine structure that we can reference.
136          */
137         ops = dlsym(dlhandle, engine_lib);
138         if (!ops)
139                 ops = dlsym(dlhandle, "ioengine");
140
141         /*
142          * For some external engines (like C++ ones) it is not that trivial
143          * to provide a non-static ionengine structure that we can reference.
144          * Instead we call a method which allocates the required ioengine
145          * structure.
146          */
147         if (!ops) {
148                 get_ioengine_t get_ioengine = dlsym(dlhandle, "get_ioengine");
149
150                 if (get_ioengine)
151                         get_ioengine(&ops);
152         }
153
154         if (!ops) {
155                 td_vmsg(td, -1, dlerror(), "dlsym");
156                 dlclose(dlhandle);
157                 return NULL;
158         }
159
160         ops->dlhandle = dlhandle;
161         return ops;
162 }
163
164 static struct ioengine_ops *__load_ioengine(const char *engine)
165 {
166         /*
167          * linux libaio has alias names, so convert to what we want
168          */
169         if (!strncmp(engine, "linuxaio", 8) || !strncmp(engine, "aio", 3)) {
170                 dprint(FD_IO, "converting ioengine name: %s -> libaio\n",
171                        engine);
172                 engine = "libaio";
173         }
174
175         dprint(FD_IO, "load ioengine %s\n", engine);
176         return find_ioengine(engine);
177 }
178
179 struct ioengine_ops *load_ioengine(struct thread_data *td)
180 {
181         struct ioengine_ops *ops = NULL;
182         const char *name;
183
184         /*
185          * Use ->ioengine_so_path if an external ioengine path is specified.
186          * In this case, ->ioengine is "external" which also means the prefix
187          * for external ioengines "external:" is properly used.
188          */
189         name = td->o.ioengine_so_path ?: td->o.ioengine;
190
191         /*
192          * Try to load ->ioengine first, and if failed try to dlopen(3) either
193          * ->ioengine or ->ioengine_so_path.  This is redundant for an external
194          * ioengine with prefix, and also leaves the possibility of unexpected
195          * behavior (e.g. if the "external" ioengine exists), but we do this
196          * so as not to break job files not using the prefix.
197          */
198         ops = __load_ioengine(td->o.ioengine);
199
200         /* We do re-dlopen existing handles, for reference counting */
201         if (!ops || ops->dlhandle)
202                 ops = dlopen_ioengine(td, name);
203
204         /*
205          * If ops is NULL, we failed to load ->ioengine, and also failed to
206          * dlopen(3) either ->ioengine or ->ioengine_so_path as a path.
207          */
208         if (!ops) {
209                 log_err("fio: engine %s not loadable\n", name);
210                 return NULL;
211         }
212
213         /*
214          * Check that the required methods are there.
215          */
216         if (check_engine_ops(td, ops))
217                 return NULL;
218
219         return ops;
220 }
221
222 /*
223  * For cleaning up an ioengine which never made it to init().
224  */
225 void free_ioengine(struct thread_data *td)
226 {
227         assert(td != NULL && td->io_ops != NULL);
228
229         dprint(FD_IO, "free ioengine %s\n", td->io_ops->name);
230
231         if (td->eo && td->io_ops->options) {
232                 options_free(td->io_ops->options, td->eo);
233                 free(td->eo);
234                 td->eo = NULL;
235         }
236
237         if (td->io_ops->dlhandle) {
238                 dprint(FD_IO, "dlclose ioengine %s\n", td->io_ops->name);
239                 dlclose(td->io_ops->dlhandle);
240         }
241
242         td->io_ops = NULL;
243 }
244
245 void close_ioengine(struct thread_data *td)
246 {
247         dprint(FD_IO, "close ioengine %s\n", td->io_ops->name);
248
249         if (td->io_ops->cleanup) {
250                 td->io_ops->cleanup(td);
251                 td->io_ops_data = NULL;
252         }
253
254         free_ioengine(td);
255 }
256
257 int td_io_prep(struct thread_data *td, struct io_u *io_u)
258 {
259         dprint_io_u(io_u, "prep");
260         fio_ro_check(td, io_u);
261
262         lock_file(td, io_u->file, io_u->ddir);
263
264         if (td->io_ops->prep) {
265                 int ret = td->io_ops->prep(td, io_u);
266
267                 dprint(FD_IO, "prep: io_u %p: ret=%d\n", io_u, ret);
268
269                 if (ret)
270                         unlock_file(td, io_u->file);
271                 return ret;
272         }
273
274         return 0;
275 }
276
277 int td_io_getevents(struct thread_data *td, unsigned int min, unsigned int max,
278                     const struct timespec *t)
279 {
280         int r = 0;
281
282         /*
283          * For ioengine=rdma one side operation RDMA_WRITE or RDMA_READ,
284          * server side gets a message from the client
285          * side that the task is finished, and
286          * td->done is set to 1 after td_io_commit(). In this case,
287          * there is no need to reap complete event in server side.
288          */
289         if (td->done)
290                 return 0;
291
292         if (min > 0 && td->io_ops->commit) {
293                 r = td->io_ops->commit(td);
294                 if (r < 0)
295                         goto out;
296         }
297         if (max > td->cur_depth)
298                 max = td->cur_depth;
299         if (min > max)
300                 max = min;
301
302         r = 0;
303         if (max && td->io_ops->getevents)
304                 r = td->io_ops->getevents(td, min, max, t);
305 out:
306         if (r >= 0) {
307                 /*
308                  * Reflect that our submitted requests were retrieved with
309                  * whatever OS async calls are in the underlying engine.
310                  */
311                 td->io_u_in_flight -= r;
312                 io_u_mark_complete(td, r);
313         } else
314                 td_verror(td, r, "get_events");
315
316         dprint(FD_IO, "getevents: %d\n", r);
317         return r;
318 }
319
320 enum fio_q_status td_io_queue(struct thread_data *td, struct io_u *io_u)
321 {
322         const enum fio_ddir ddir = acct_ddir(io_u);
323         unsigned long long buflen = io_u->xfer_buflen;
324         enum fio_q_status ret;
325
326         dprint_io_u(io_u, "queue");
327         fio_ro_check(td, io_u);
328
329         assert((io_u->flags & IO_U_F_FLIGHT) == 0);
330         io_u_set(td, io_u, IO_U_F_FLIGHT);
331
332         /*
333          * If overlap checking was enabled in offload mode we
334          * can release this lock that was acquired when we
335          * started the overlap check because the IO_U_F_FLIGHT
336          * flag is now set
337          */
338         if (td_offload_overlap(td)) {
339                 int res;
340
341                 res = pthread_mutex_unlock(&overlap_check);
342                 if (fio_unlikely(res != 0)) {
343                         log_err("failed to unlock overlap check mutex, err: %i:%s", errno, strerror(errno));
344                         abort();
345                 }
346         }
347
348         assert(fio_file_open(io_u->file));
349
350         /*
351          * If using a write iolog, store this entry.
352          */
353         log_io_u(td, io_u);
354
355         io_u->error = 0;
356         io_u->resid = 0;
357
358         if (td_ioengine_flagged(td, FIO_SYNCIO) ||
359                 (td_ioengine_flagged(td, FIO_ASYNCIO_SYNC_TRIM) && 
360                 io_u->ddir == DDIR_TRIM)) {
361                 if (fio_fill_issue_time(td))
362                         fio_gettime(&io_u->issue_time, NULL);
363
364                 /*
365                  * only used for iolog
366                  */
367                 if (td->o.read_iolog_file)
368                         memcpy(&td->last_issue, &io_u->issue_time,
369                                         sizeof(io_u->issue_time));
370         }
371
372
373         if (ddir_rw(ddir)) {
374                 if (!(io_u->flags & IO_U_F_VER_LIST)) {
375                         td->io_issues[ddir]++;
376                         td->io_issue_bytes[ddir] += buflen;
377                 }
378                 td->rate_io_issue_bytes[ddir] += buflen;
379         }
380
381         ret = td->io_ops->queue(td, io_u);
382         zbd_queue_io_u(td, io_u, ret);
383
384         unlock_file(td, io_u->file);
385
386         if (ret == FIO_Q_BUSY && ddir_rw(ddir)) {
387                 td->io_issues[ddir]--;
388                 td->io_issue_bytes[ddir] -= buflen;
389                 td->rate_io_issue_bytes[ddir] -= buflen;
390                 io_u_clear(td, io_u, IO_U_F_FLIGHT);
391         }
392
393         /*
394          * If an error was seen and the io engine didn't propagate it
395          * back to 'td', do so.
396          */
397         if (io_u->error && !td->error)
398                 td_verror(td, io_u->error, "td_io_queue");
399
400         /*
401          * Add warning for O_DIRECT so that users have an easier time
402          * spotting potentially bad alignment. If this triggers for the first
403          * IO, then it's likely an alignment problem or because the host fs
404          * does not support O_DIRECT
405          */
406         if (io_u->error == EINVAL && td->io_issues[io_u->ddir & 1] == 1 &&
407             td->o.odirect) {
408
409                 log_info("fio: first direct IO errored. File system may not "
410                          "support direct IO, or iomem_align= is bad, or "
411                          "invalid block size. Try setting direct=0.\n");
412         }
413
414         if (zbd_unaligned_write(io_u->error) &&
415             td->io_issues[io_u->ddir & 1] == 1 &&
416             td->o.zone_mode != ZONE_MODE_ZBD) {
417                 log_info("fio: first I/O failed. If %s is a zoned block device, consider --zonemode=zbd\n",
418                          io_u->file->file_name);
419         }
420
421         if (!td->io_ops->commit) {
422                 io_u_mark_submit(td, 1);
423                 io_u_mark_complete(td, 1);
424         }
425
426         if (ret == FIO_Q_COMPLETED) {
427                 if (ddir_rw(io_u->ddir) ||
428                     (ddir_sync(io_u->ddir) && td->runstate != TD_FSYNCING)) {
429                         io_u_mark_depth(td, 1);
430                         td->ts.total_io_u[io_u->ddir]++;
431                 }
432         } else if (ret == FIO_Q_QUEUED) {
433                 td->io_u_queued++;
434
435                 if (ddir_rw(io_u->ddir) ||
436                     (ddir_sync(io_u->ddir) && td->runstate != TD_FSYNCING))
437                         td->ts.total_io_u[io_u->ddir]++;
438
439                 if (td->io_u_queued >= td->o.iodepth_batch)
440                         td_io_commit(td);
441         }
442
443         if (!td_ioengine_flagged(td, FIO_SYNCIO) &&
444                 (!td_ioengine_flagged(td, FIO_ASYNCIO_SYNC_TRIM) ||
445                  io_u->ddir != DDIR_TRIM)) {
446                 if (fio_fill_issue_time(td))
447                         fio_gettime(&io_u->issue_time, NULL);
448
449                 /*
450                  * only used for iolog
451                  */
452                 if (td->o.read_iolog_file)
453                         memcpy(&td->last_issue, &io_u->issue_time,
454                                         sizeof(io_u->issue_time));
455         }
456
457         return ret;
458 }
459
460 int td_io_init(struct thread_data *td)
461 {
462         int ret = 0;
463
464         if (td->io_ops->init) {
465                 ret = td->io_ops->init(td);
466                 if (ret)
467                         log_err("fio: io engine %s init failed.%s\n",
468                                 td->io_ops->name,
469                                 td->o.iodepth > 1 ?
470                                 " Perhaps try reducing io depth?" : "");
471                 else
472                         td->io_ops_init = 1;
473                 if (!td->error)
474                         td->error = ret;
475         }
476
477         return ret;
478 }
479
480 void td_io_commit(struct thread_data *td)
481 {
482         int ret;
483
484         dprint(FD_IO, "calling ->commit(), depth %d\n", td->cur_depth);
485
486         if (!td->cur_depth || !td->io_u_queued)
487                 return;
488
489         io_u_mark_depth(td, td->io_u_queued);
490
491         if (td->io_ops->commit) {
492                 ret = td->io_ops->commit(td);
493                 if (ret)
494                         td_verror(td, -ret, "io commit");
495         }
496
497         /*
498          * Reflect that events were submitted as async IO requests.
499          */
500         td->io_u_in_flight += td->io_u_queued;
501         td->io_u_queued = 0;
502 }
503
504 int td_io_open_file(struct thread_data *td, struct fio_file *f)
505 {
506         if (fio_file_closing(f)) {
507                 /*
508                  * Open translates to undo closing.
509                  */
510                 fio_file_clear_closing(f);
511                 get_file(f);
512                 return 0;
513         }
514         assert(!fio_file_open(f));
515         assert(f->fd == -1);
516         assert(td->io_ops->open_file);
517
518         if (td->io_ops->open_file(td, f)) {
519                 if (td->error == EINVAL && td->o.odirect)
520                         log_err("fio: destination does not support O_DIRECT\n");
521                 if (td->error == EMFILE) {
522                         log_err("fio: try reducing/setting openfiles (failed"
523                                 " at %u of %u)\n", td->nr_open_files,
524                                                         td->o.nr_files);
525                 }
526
527                 assert(f->fd == -1);
528                 assert(!fio_file_open(f));
529                 return 1;
530         }
531
532         fio_file_reset(td, f);
533         fio_file_set_open(f);
534         fio_file_clear_closing(f);
535         disk_util_inc(f->du);
536
537         td->nr_open_files++;
538         get_file(f);
539
540         if (f->filetype == FIO_TYPE_PIPE) {
541                 if (td_random(td)) {
542                         log_err("fio: can't seek on pipes (no random io)\n");
543                         goto err;
544                 }
545         }
546
547         if (td_ioengine_flagged(td, FIO_DISKLESSIO))
548                 goto done;
549
550         if (td->o.invalidate_cache && file_invalidate_cache(td, f))
551                 goto err;
552
553         if (td->o.fadvise_hint != F_ADV_NONE &&
554             (f->filetype == FIO_TYPE_BLOCK || f->filetype == FIO_TYPE_FILE)) {
555                 int flags;
556
557                 if (td->o.fadvise_hint == F_ADV_TYPE) {
558                         if (td_random(td))
559                                 flags = POSIX_FADV_RANDOM;
560                         else
561                                 flags = POSIX_FADV_SEQUENTIAL;
562                 } else if (td->o.fadvise_hint == F_ADV_RANDOM)
563                         flags = POSIX_FADV_RANDOM;
564                 else if (td->o.fadvise_hint == F_ADV_SEQUENTIAL)
565                         flags = POSIX_FADV_SEQUENTIAL;
566                 else {
567                         log_err("fio: unknown fadvise type %d\n",
568                                                         td->o.fadvise_hint);
569                         flags = POSIX_FADV_NORMAL;
570                 }
571
572                 if (posix_fadvise(f->fd, f->file_offset, f->io_size, flags) < 0) {
573                         if (!fio_did_warn(FIO_WARN_FADVISE))
574                                 log_err("fio: fadvise hint failed\n");
575                 }
576         }
577 #ifdef FIO_HAVE_WRITE_HINT
578         if (fio_option_is_set(&td->o, write_hint) &&
579             (f->filetype == FIO_TYPE_BLOCK || f->filetype == FIO_TYPE_FILE)) {
580                 uint64_t hint = td->o.write_hint;
581                 int cmd;
582
583                 /*
584                  * For direct IO, we just need/want to set the hint on
585                  * the file descriptor. For buffered IO, we need to set
586                  * it on the inode.
587                  */
588                 if (td->o.odirect)
589                         cmd = F_SET_FILE_RW_HINT;
590                 else
591                         cmd = F_SET_RW_HINT;
592
593                 if (fcntl(f->fd, cmd, &hint) < 0) {
594                         td_verror(td, errno, "fcntl write hint");
595                         goto err;
596                 }
597         }
598 #endif
599
600         if (td->o.odirect && !OS_O_DIRECT && fio_set_directio(td, f))
601                 goto err;
602
603 done:
604         log_file(td, f, FIO_LOG_OPEN_FILE);
605         return 0;
606 err:
607         disk_util_dec(f->du);
608         if (td->io_ops->close_file)
609                 td->io_ops->close_file(td, f);
610         return 1;
611 }
612
613 int td_io_close_file(struct thread_data *td, struct fio_file *f)
614 {
615         if (!fio_file_closing(f))
616                 log_file(td, f, FIO_LOG_CLOSE_FILE);
617
618         /*
619          * mark as closing, do real close when last io on it has completed
620          */
621         fio_file_set_closing(f);
622
623         return put_file(td, f);
624 }
625
626 int td_io_unlink_file(struct thread_data *td, struct fio_file *f)
627 {
628         if (td->io_ops->unlink_file)
629                 return td->io_ops->unlink_file(td, f);
630         else {
631                 int ret;
632
633                 ret = unlink(f->file_name);
634                 if (ret < 0)
635                         return errno;
636
637                 return 0;
638         }
639 }
640
641 int td_io_get_file_size(struct thread_data *td, struct fio_file *f)
642 {
643         if (!td->io_ops->get_file_size)
644                 return 0;
645
646         return td->io_ops->get_file_size(td, f);
647 }
648
649 #ifdef CONFIG_DYNAMIC_ENGINES
650 /* Load all dynamic engines in FIO_EXT_ENG_DIR for enghelp command */
651 static void
652 fio_load_dynamic_engines(struct thread_data *td)
653 {
654         DIR *dirhandle = NULL;
655         struct dirent *dirent = NULL;
656         char engine_path[PATH_MAX];
657
658         dirhandle = opendir(FIO_EXT_ENG_DIR);
659         if (!dirhandle)
660                 return;
661
662         while ((dirent = readdir(dirhandle)) != NULL) {
663                 if (!strcmp(dirent->d_name, ".") ||
664                     !strcmp(dirent->d_name, ".."))
665                         continue;
666
667                 sprintf(engine_path, "%s/%s", FIO_EXT_ENG_DIR, dirent->d_name);
668                 dlopen_ioengine(td, engine_path);
669         }
670
671         closedir(dirhandle);
672 }
673 #else
674 #define fio_load_dynamic_engines(td) do { } while (0)
675 #endif
676
677 int fio_show_ioengine_help(const char *engine)
678 {
679         struct flist_head *entry;
680         struct thread_data td;
681         struct ioengine_ops *io_ops;
682         char *sep;
683         int ret = 1;
684
685         memset(&td, 0, sizeof(struct thread_data));
686
687         if (!engine || !*engine) {
688                 log_info("Available IO engines:\n");
689                 fio_load_dynamic_engines(&td);
690                 flist_for_each(entry, &engine_list) {
691                         io_ops = flist_entry(entry, struct ioengine_ops, list);
692                         log_info("\t%s\n", io_ops->name);
693                 }
694                 return 0;
695         }
696         sep = strchr(engine, ',');
697         if (sep) {
698                 *sep = 0;
699                 sep++;
700         }
701
702         td.o.ioengine = (char *)engine;
703         td.io_ops = load_ioengine(&td);
704
705         if (!td.io_ops) {
706                 log_info("IO engine %s not found\n", engine);
707                 return 1;
708         }
709
710         if (td.io_ops->options)
711                 ret = show_cmd_help(td.io_ops->options, sep);
712         else
713                 log_info("IO engine %s has no options\n", td.io_ops->name);
714
715         free_ioengine(&td);
716         return ret;
717 }