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