io_u.h

   1 #ifndef FIO_IO_U
   2 #define FIO_IO_U
   3
   4 #include "compiler/compiler.h"
   5 #include "os/os.h"
   6 #include "io_ddir.h"
   7 #include "debug.h"
   8 #include "file.h"
   9 #include "workqueue.h"
  10
  11 #ifdef CONFIG_LIBAIO
  12 #include <libaio.h>
  13 #endif
  14
  15 enum {
  16         IO_U_F_FREE             = 1 << 0,
  17         IO_U_F_FLIGHT           = 1 << 1,
  18         IO_U_F_NO_FILE_PUT      = 1 << 2,
  19         IO_U_F_IN_CUR_DEPTH     = 1 << 3,
  20         IO_U_F_BUSY_OK          = 1 << 4,
  21         IO_U_F_TRIMMED          = 1 << 5,
  22         IO_U_F_BARRIER          = 1 << 6,
  23         IO_U_F_VER_LIST         = 1 << 7,
  24         IO_U_F_PRIORITY         = 1 << 8,
  25 };
  26
  27 /*
  28  * The io unit
  29  */
  30 struct io_u {
  31         struct timespec start_time;
  32         struct timespec issue_time;
  33
  34         struct fio_file *file;
  35         unsigned int flags;
  36         enum fio_ddir ddir;
  37
  38         /*
  39          * For replay workloads, we may want to account as a different
  40          * IO type than what is being submitted.
  41          */
  42         enum fio_ddir acct_ddir;
  43
  44         /*
  45          * Write generation
  46          */
  47         unsigned short numberio;
  48
  49         /*
  50          * Allocated/set buffer and length
  51          */
  52         unsigned long long buflen;
  53         unsigned long long offset;      /* is really ->xfer_offset... */
  54         unsigned long long verify_offset;       /* is really ->offset */
  55         void *buf;
  56
  57         /*
  58          * Initial seed for generating the buffer contents
  59          */
  60         uint64_t rand_seed;
  61
  62         /*
  63          * IO engine state, may be different from above when we get
  64          * partial transfers / residual data counts
  65          */
  66         void *xfer_buf;
  67         unsigned long long xfer_buflen;
  68
  69         /*
  70          * Parameter related to pre-filled buffers and
  71          * their size to handle variable block sizes.
  72          */
  73         unsigned long long buf_filled_len;
  74
  75         struct io_piece *ipo;
  76
  77         unsigned long long resid;
  78         unsigned int error;
  79
  80         /*
  81          * io engine private data
  82          */
  83         union {
  84                 unsigned int index;
  85                 unsigned int seen;
  86                 void *engine_data;
  87         };
  88
  89         union {
  90                 struct flist_head verify_list;
  91                 struct workqueue_work work;
  92         };
  93
  94         /*
  95          * ZBD mode zbd_queue_io callback: called after engine->queue operation
  96          * to advance a zone write pointer and eventually unlock the I/O zone.
  97          * @q indicates the I/O queue status (busy, queued or completed).
  98          * @success == true means that the I/O operation has been queued or
  99          * completed successfully.
 100          */
 101         void (*zbd_queue_io)(struct thread_data *td, struct io_u *, int q,
 102                              bool success);
 103
 104         /*
 105          * ZBD mode zbd_put_io callback: called in after completion of an I/O
 106          * or commit of an async I/O to unlock the I/O target zone.
 107          */
 108         void (*zbd_put_io)(struct thread_data *td, const struct io_u *);
 109
 110         /*
 111          * Callback for io completion
 112          */
 113         int (*end_io)(struct thread_data *, struct io_u **);
 114
 115         union {
 116 #ifdef CONFIG_LIBAIO
 117                 struct iocb iocb;
 118 #endif
 119 #ifdef CONFIG_POSIXAIO
 120                 os_aiocb_t aiocb;
 121 #endif
 122 #ifdef FIO_HAVE_SGIO
 123                 struct sg_io_hdr hdr;
 124 #endif
 125 #ifdef CONFIG_SOLARISAIO
 126                 aio_result_t resultp;
 127 #endif
 128 #ifdef CONFIG_RDMA
 129                 struct ibv_mr *mr;
 130 #endif
 131                 void *mmap_data;
 132         };
 133 };
 134
 135 /*
 136  * io unit handling
 137  */
 138 extern struct io_u *__get_io_u(struct thread_data *);
 139 extern struct io_u *get_io_u(struct thread_data *);
 140 extern void put_io_u(struct thread_data *, struct io_u *);
 141 extern void clear_io_u(struct thread_data *, struct io_u *);
 142 extern void requeue_io_u(struct thread_data *, struct io_u **);
 143 extern int __must_check io_u_sync_complete(struct thread_data *, struct io_u *);
 144 extern int __must_check io_u_queued_complete(struct thread_data *, int);
 145 extern void io_u_queued(struct thread_data *, struct io_u *);
 146 extern int io_u_quiesce(struct thread_data *);
 147 extern void io_u_log_error(struct thread_data *, struct io_u *);
 148 extern void io_u_mark_depth(struct thread_data *, unsigned int);
 149 extern void fill_io_buffer(struct thread_data *, void *, unsigned long long, unsigned long long);
 150 extern void io_u_fill_buffer(struct thread_data *td, struct io_u *, unsigned long long, unsigned long long);
 151 void io_u_mark_complete(struct thread_data *, unsigned int);
 152 void io_u_mark_submit(struct thread_data *, unsigned int);
 153 bool queue_full(const struct thread_data *);
 154
 155 int do_io_u_sync(const struct thread_data *, struct io_u *);
 156 int do_io_u_trim(const struct thread_data *, struct io_u *);
 157
 158 #ifdef FIO_INC_DEBUG
 159 static inline void dprint_io_u(struct io_u *io_u, const char *p)
 160 {
 161         struct fio_file *f = io_u->file;
 162
 163         if (f)
 164                 dprint(FD_IO, "%s: io_u %p: off=0x%llx,len=0x%llx,ddir=%d,file=%s\n",
 165                                 p, io_u,
 166                                 (unsigned long long) io_u->offset,
 167                                 io_u->buflen, io_u->ddir,
 168                                 f->file_name);
 169         else
 170                 dprint(FD_IO, "%s: io_u %p: off=0x%llx,len=0x%llx,ddir=%d\n",
 171                                 p, io_u,
 172                                 (unsigned long long) io_u->offset,
 173                                 io_u->buflen, io_u->ddir);
 174 }
 175 #else
 176 #define dprint_io_u(io_u, p)
 177 #endif
 178
 179 static inline enum fio_ddir acct_ddir(struct io_u *io_u)
 180 {
 181         if (io_u->acct_ddir != -1)
 182                 return io_u->acct_ddir;
 183
 184         return io_u->ddir;
 185 }
 186
 187 #define io_u_clear(td, io_u, val)       \
 188         td_flags_clear((td), &(io_u->flags), (val))
 189 #define io_u_set(td, io_u, val)         \
 190         td_flags_set((td), &(io_u)->flags, (val))
 191 #define io_u_is_prio(io_u)      \
 192         (io_u->flags & (unsigned int) IO_U_F_PRIORITY) != 0
 193
 194 #endif