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 struct io_hist {
  22         uint64_t samples;
  23         unsigned long hist_last;
  24 };
  25
  26 /*
  27  * A single data sample
  28  */
  29 struct io_sample {
  30         uint64_t time;
  31         uint64_t val;
  32         uint32_t __ddir;
  33         uint32_t bs;
  34 };
  35
  36 struct io_sample_offset {
  37         struct io_sample s;
  38         uint64_t offset;
  39 };
  40
  41 enum {
  42         IO_LOG_TYPE_LAT = 1,
  43         IO_LOG_TYPE_CLAT,
  44         IO_LOG_TYPE_SLAT,
  45         IO_LOG_TYPE_BW,
  46         IO_LOG_TYPE_IOPS,
  47         IO_LOG_TYPE_HIST,
  48 };
  49
  50 #define DEF_LOG_ENTRIES         1024
  51 #define MAX_LOG_ENTRIES         (1024 * DEF_LOG_ENTRIES)
  52
  53 struct io_logs {
  54         struct flist_head list;
  55         uint64_t nr_samples;
  56         uint64_t max_samples;
  57         void *log;
  58 };
  59
  60 /*
  61  * Dynamically growing data sample log
  62  */
  63 struct io_log {
  64         /*
  65          * Entries already logged
  66          */
  67         struct flist_head io_logs;
  68         uint32_t cur_log_max;
  69
  70         /*
  71          * When the current log runs out of space, store events here until
  72          * we have a chance to regrow
  73          */
  74         struct io_logs *pending;
  75
  76         unsigned int log_ddir_mask;
  77
  78         char *filename;
  79
  80         struct thread_data *td;
  81
  82         unsigned int log_type;
  83
  84         /*
  85          * If we fail extending the log, stop collecting more entries.
  86          */
  87         bool disabled;
  88
  89         /*
  90          * Log offsets
  91          */
  92         unsigned int log_offset;
  93
  94         /*
  95          * Max size of log entries before a chunk is compressed
  96          */
  97         unsigned int log_gz;
  98
  99         /*
 100          * Don't deflate for storing, just store the compressed bits
 101          */
 102         unsigned int log_gz_store;
 103
 104         /*
 105          * Windowed average, for logging single entries average over some
 106          * period of time.
 107          */
 108         struct io_stat avg_window[DDIR_RWDIR_CNT];
 109         unsigned long avg_msec;
 110         unsigned long avg_last;
 111
 112   /*
 113    * Windowed latency histograms, for keeping track of when we need to
 114    * save a copy of the histogram every approximately hist_msec milliseconds.
 115    */
 116         struct io_hist hist_window[DDIR_RWDIR_CNT];
 117         unsigned long hist_msec;
 118         int hist_coarseness;
 119
 120         pthread_mutex_t chunk_lock;
 121         unsigned int chunk_seq;
 122         struct flist_head chunk_list;
 123 };
 124
 125 /*
 126  * If the upper bit is set, then we have the offset as well
 127  */
 128 #define LOG_OFFSET_SAMPLE_BIT   0x80000000U
 129 #define io_sample_ddir(io)      ((io)->__ddir & ~LOG_OFFSET_SAMPLE_BIT)
 130
 131 static inline void io_sample_set_ddir(struct io_log *log,
 132                                       struct io_sample *io,
 133                                       enum fio_ddir ddir)
 134 {
 135         io->__ddir = ddir | log->log_ddir_mask;
 136 }
 137
 138 static inline size_t __log_entry_sz(int log_offset)
 139 {
 140         if (log_offset)
 141                 return sizeof(struct io_sample_offset);
 142         else
 143                 return sizeof(struct io_sample);
 144 }
 145
 146 static inline size_t log_entry_sz(struct io_log *log)
 147 {
 148         return __log_entry_sz(log->log_offset);
 149 }
 150
 151 static inline struct io_sample *__get_sample(void *samples, int log_offset,
 152                                              uint64_t sample)
 153 {
 154         uint64_t sample_offset = sample * __log_entry_sz(log_offset);
 155         return (struct io_sample *) ((char *) samples + sample_offset);
 156 }
 157
 158 struct io_logs *iolog_cur_log(struct io_log *);
 159 uint64_t iolog_nr_samples(struct io_log *);
 160 void regrow_logs(struct thread_data *);
 161
 162 static inline struct io_sample *get_sample(struct io_log *iolog,
 163                                            struct io_logs *cur_log,
 164                                            uint64_t sample)
 165 {
 166         return __get_sample(cur_log->log, iolog->log_offset, sample);
 167 }
 168
 169 enum {
 170         IP_F_ONRB       = 1,
 171         IP_F_ONLIST     = 2,
 172         IP_F_TRIMMED    = 4,
 173         IP_F_IN_FLIGHT  = 8,
 174 };
 175
 176 /*
 177  * When logging io actions, this matches a single sent io_u
 178  */
 179 struct io_piece {
 180         union {
 181                 struct rb_node rb_node;
 182                 struct flist_head list;
 183         };
 184         struct flist_head trim_list;
 185         union {
 186                 int fileno;
 187                 struct fio_file *file;
 188         };
 189         unsigned long long offset;
 190         unsigned short numberio;
 191         unsigned long len;
 192         unsigned int flags;
 193         enum fio_ddir ddir;
 194         union {
 195                 unsigned long delay;
 196                 unsigned int file_action;
 197         };
 198 };
 199
 200 /*
 201  * Log exports
 202  */
 203 enum file_log_act {
 204         FIO_LOG_ADD_FILE,
 205         FIO_LOG_OPEN_FILE,
 206         FIO_LOG_CLOSE_FILE,
 207         FIO_LOG_UNLINK_FILE,
 208 };
 209
 210 struct io_u;
 211 extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
 212 extern void log_io_u(const struct thread_data *, const struct io_u *);
 213 extern void log_file(struct thread_data *, struct fio_file *, enum file_log_act);
 214 extern int __must_check init_iolog(struct thread_data *td);
 215 extern void log_io_piece(struct thread_data *, struct io_u *);
 216 extern void unlog_io_piece(struct thread_data *, struct io_u *);
 217 extern void trim_io_piece(struct thread_data *, const struct io_u *);
 218 extern void queue_io_piece(struct thread_data *, struct io_piece *);
 219 extern void prune_io_piece_log(struct thread_data *);
 220 extern void write_iolog_close(struct thread_data *);
 221 extern int iolog_compress_init(struct thread_data *, struct sk_out *);
 222 extern void iolog_compress_exit(struct thread_data *);
 223 extern size_t log_chunk_sizes(struct io_log *);
 224
 225 #ifdef CONFIG_ZLIB
 226 extern int iolog_file_inflate(const char *);
 227 #endif
 228
 229 /*
 230  * Logging
 231  */
 232 struct log_params {
 233         struct thread_data *td;
 234         unsigned long avg_msec;
 235         unsigned long hist_msec;
 236         int hist_coarseness;
 237         int log_type;
 238         int log_offset;
 239         int log_gz;
 240         int log_gz_store;
 241         int log_compress;
 242 };
 243
 244 static inline bool per_unit_log(struct io_log *log)
 245 {
 246         return log && !log->avg_msec;
 247 }
 248
 249 static inline bool inline_log(struct io_log *log)
 250 {
 251         return log->log_type == IO_LOG_TYPE_LAT ||
 252                 log->log_type == IO_LOG_TYPE_CLAT ||
 253                 log->log_type == IO_LOG_TYPE_SLAT;
 254 }
 255
 256 extern void finalize_logs(struct thread_data *td, bool);
 257 extern void setup_log(struct io_log **, struct log_params *, const char *);
 258 extern void flush_log(struct io_log *, bool);
 259 extern void flush_samples(FILE *, void *, uint64_t);
 260 extern void free_log(struct io_log *);
 261 extern void fio_writeout_logs(bool);
 262 extern void td_writeout_logs(struct thread_data *, bool);
 263 extern int iolog_cur_flush(struct io_log *, struct io_logs *);
 264
 265 static inline void init_ipo(struct io_piece *ipo)
 266 {
 267         memset(ipo, 0, sizeof(*ipo));
 268         INIT_FLIST_HEAD(&ipo->trim_list);
 269 }
 270
 271 struct iolog_compress {
 272         struct flist_head list;
 273         void *buf;
 274         size_t len;
 275         unsigned int seq;
 276 };
 277
 278 #endif