iolog.h

   1 #ifndef FIO_IOLOG_H
   2 #define FIO_IOLOG_H
   3
   4 #include "lib/rbtree.h"
   5 #include "lib/ieee754.h"
   6 #include "flist.h"
   7 #include "ioengine.h"
   8
   9 /*
  10  * Use for maintaining statistics
  11  */
  12 struct io_stat {
  13         uint64_t max_val;
  14         uint64_t min_val;
  15         uint64_t samples;
  16
  17         fio_fp64_t mean;
  18         fio_fp64_t S;
  19 };
  20
  21 /*
  22  * A single data sample
  23  */
  24 struct io_sample {
  25         uint64_t time;
  26         uint64_t val;
  27         uint32_t __ddir;
  28         uint32_t bs;
  29 };
  30
  31 struct io_sample_offset {
  32         struct io_sample s;
  33         uint64_t offset;
  34 };
  35
  36 enum {
  37         IO_LOG_TYPE_LAT = 1,
  38         IO_LOG_TYPE_CLAT,
  39         IO_LOG_TYPE_SLAT,
  40         IO_LOG_TYPE_BW,
  41         IO_LOG_TYPE_IOPS,
  42 };
  43
  44 /*
  45  * Dynamically growing data sample log
  46  */
  47 struct io_log {
  48         /*
  49          * Entries already logged
  50          */
  51         uint64_t nr_samples;
  52         uint64_t max_samples;
  53         void *log;
  54
  55         unsigned int log_ddir_mask;
  56
  57         char *filename;
  58
  59         struct thread_data *td;
  60
  61         unsigned int log_type;
  62
  63         /*
  64          * If we fail extending the log, stop collecting more entries.
  65          */
  66         unsigned int disabled;
  67
  68         /*
  69          * Log offsets
  70          */
  71         unsigned int log_offset;
  72
  73         /*
  74          * Max size of log entries before a chunk is compressed
  75          */
  76         unsigned int log_gz;
  77
  78         /*
  79          * Don't deflate for storing, just store the compressed bits
  80          */
  81         unsigned int log_gz_store;
  82
  83         /*
  84          * Windowed average, for logging single entries average over some
  85          * period of time.
  86          */
  87         struct io_stat avg_window[DDIR_RWDIR_CNT];
  88         unsigned long avg_msec;
  89         unsigned long avg_last;
  90
  91         pthread_mutex_t chunk_lock;
  92         unsigned int chunk_seq;
  93         struct flist_head chunk_list;
  94 };
  95
  96 /*
  97  * If the upper bit is set, then we have the offset as well
  98  */
  99 #define LOG_OFFSET_SAMPLE_BIT   0x80000000U
 100 #define io_sample_ddir(io)      ((io)->__ddir & ~LOG_OFFSET_SAMPLE_BIT)
 101
 102 static inline void io_sample_set_ddir(struct io_log *log,
 103                                       struct io_sample *io,
 104                                       enum fio_ddir ddir)
 105 {
 106         io->__ddir = ddir | log->log_ddir_mask;
 107 }
 108
 109 static inline size_t __log_entry_sz(int log_offset)
 110 {
 111         if (log_offset)
 112                 return sizeof(struct io_sample_offset);
 113         else
 114                 return sizeof(struct io_sample);
 115 }
 116
 117 static inline size_t log_entry_sz(struct io_log *log)
 118 {
 119         return __log_entry_sz(log->log_offset);
 120 }
 121
 122 static inline struct io_sample *__get_sample(void *samples, int log_offset,
 123                                              uint64_t sample)
 124 {
 125         uint64_t sample_offset = sample * __log_entry_sz(log_offset);
 126         return (struct io_sample *) ((char *) samples + sample_offset);
 127 }
 128
 129 static inline struct io_sample *get_sample(struct io_log *iolog,
 130                                            uint64_t sample)
 131 {
 132         return __get_sample(iolog->log, iolog->log_offset, sample);
 133 }
 134
 135 enum {
 136         IP_F_ONRB       = 1,
 137         IP_F_ONLIST     = 2,
 138         IP_F_TRIMMED    = 4,
 139         IP_F_IN_FLIGHT  = 8,
 140 };
 141
 142 /*
 143  * When logging io actions, this matches a single sent io_u
 144  */
 145 struct io_piece {
 146         union {
 147                 struct rb_node rb_node;
 148                 struct flist_head list;
 149         };
 150         struct flist_head trim_list;
 151         union {
 152                 int fileno;
 153                 struct fio_file *file;
 154         };
 155         unsigned long long offset;
 156         unsigned short numberio;
 157         unsigned long len;
 158         unsigned int flags;
 159         enum fio_ddir ddir;
 160         union {
 161                 unsigned long delay;
 162                 unsigned int file_action;
 163         };
 164 };
 165
 166 /*
 167  * Log exports
 168  */
 169 enum file_log_act {
 170         FIO_LOG_ADD_FILE,
 171         FIO_LOG_OPEN_FILE,
 172         FIO_LOG_CLOSE_FILE,
 173         FIO_LOG_UNLINK_FILE,
 174 };
 175
 176 struct io_u;
 177 extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
 178 extern void log_io_u(const struct thread_data *, const struct io_u *);
 179 extern void log_file(struct thread_data *, struct fio_file *, enum file_log_act);
 180 extern int __must_check init_iolog(struct thread_data *td);
 181 extern void log_io_piece(struct thread_data *, struct io_u *);
 182 extern void unlog_io_piece(struct thread_data *, struct io_u *);
 183 extern void trim_io_piece(struct thread_data *, const struct io_u *);
 184 extern void queue_io_piece(struct thread_data *, struct io_piece *);
 185 extern void prune_io_piece_log(struct thread_data *);
 186 extern void write_iolog_close(struct thread_data *);
 187
 188 #ifdef CONFIG_ZLIB
 189 extern int iolog_file_inflate(const char *);
 190 #endif
 191
 192 /*
 193  * Logging
 194  */
 195 struct log_params {
 196         struct thread_data *td;
 197         unsigned long avg_msec;
 198         int log_type;
 199         int log_offset;
 200         int log_gz;
 201         int log_gz_store;
 202         int log_compress;
 203 };
 204
 205 extern void finalize_logs(struct thread_data *td);
 206 extern void add_lat_sample(struct thread_data *, enum fio_ddir, unsigned long,
 207                                 unsigned int, uint64_t);
 208 extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long,
 209                                 unsigned int, uint64_t);
 210 extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long,
 211                                 unsigned int, uint64_t);
 212 extern void add_bw_sample(struct thread_data *, enum fio_ddir, unsigned int,
 213                                 struct timeval *);
 214 extern void add_iops_sample(struct thread_data *, enum fio_ddir, unsigned int,
 215                                 struct timeval *);
 216 extern void init_disk_util(struct thread_data *);
 217 extern void update_rusage_stat(struct thread_data *);
 218 extern void setup_log(struct io_log **, struct log_params *, const char *);
 219 extern void flush_log(struct io_log *, int);
 220 extern void free_log(struct io_log *);
 221 extern struct io_log *agg_io_log[DDIR_RWDIR_CNT];
 222 extern int write_bw_log;
 223 extern void add_agg_sample(unsigned long, enum fio_ddir, unsigned int);
 224 extern void fio_writeout_logs(struct thread_data *);
 225 extern int iolog_flush(struct io_log *, int);
 226
 227 static inline void init_ipo(struct io_piece *ipo)
 228 {
 229         memset(ipo, 0, sizeof(*ipo));
 230         INIT_FLIST_HEAD(&ipo->trim_list);
 231 }
 232
 233 #endif