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
 115          * milliseconds.
 116          */
 117         struct io_hist hist_window[DDIR_RWDIR_CNT];
 118         unsigned long hist_msec;
 119         int hist_coarseness;
 120
 121         pthread_mutex_t chunk_lock;
 122         unsigned int chunk_seq;
 123         struct flist_head chunk_list;
 124 };
 125
 126 /*
 127  * If the upper bit is set, then we have the offset as well
 128  */
 129 #define LOG_OFFSET_SAMPLE_BIT   0x80000000U
 130 #define io_sample_ddir(io)      ((io)->__ddir & ~LOG_OFFSET_SAMPLE_BIT)
 131
 132 static inline void io_sample_set_ddir(struct io_log *log,
 133                                       struct io_sample *io,
 134                                       enum fio_ddir ddir)
 135 {
 136         io->__ddir = ddir | log->log_ddir_mask;
 137 }
 138
 139 static inline size_t __log_entry_sz(int log_offset)
 140 {
 141         if (log_offset)
 142                 return sizeof(struct io_sample_offset);
 143         else
 144                 return sizeof(struct io_sample);
 145 }
 146
 147 static inline size_t log_entry_sz(struct io_log *log)
 148 {
 149         return __log_entry_sz(log->log_offset);
 150 }
 151
 152 static inline struct io_sample *__get_sample(void *samples, int log_offset,
 153                                              uint64_t sample)
 154 {
 155         uint64_t sample_offset = sample * __log_entry_sz(log_offset);
 156         return (struct io_sample *) ((char *) samples + sample_offset);
 157 }
 158
 159 struct io_logs *iolog_cur_log(struct io_log *);
 160 uint64_t iolog_nr_samples(struct io_log *);
 161 void regrow_logs(struct thread_data *);
 162
 163 static inline struct io_sample *get_sample(struct io_log *iolog,
 164                                            struct io_logs *cur_log,
 165                                            uint64_t sample)
 166 {
 167         return __get_sample(cur_log->log, iolog->log_offset, sample);
 168 }
 169
 170 enum {
 171         IP_F_ONRB       = 1,
 172         IP_F_ONLIST     = 2,
 173         IP_F_TRIMMED    = 4,
 174         IP_F_IN_FLIGHT  = 8,
 175 };
 176
 177 /*
 178  * When logging io actions, this matches a single sent io_u
 179  */
 180 struct io_piece {
 181         union {
 182                 struct rb_node rb_node;
 183                 struct flist_head list;
 184         };
 185         struct flist_head trim_list;
 186         union {
 187                 int fileno;
 188                 struct fio_file *file;
 189         };
 190         unsigned long long offset;
 191         unsigned short numberio;
 192         unsigned long len;
 193         unsigned int flags;
 194         enum fio_ddir ddir;
 195         union {
 196                 unsigned long delay;
 197                 unsigned int file_action;
 198         };
 199 };
 200
 201 /*
 202  * Log exports
 203  */
 204 enum file_log_act {
 205         FIO_LOG_ADD_FILE,
 206         FIO_LOG_OPEN_FILE,
 207         FIO_LOG_CLOSE_FILE,
 208         FIO_LOG_UNLINK_FILE,
 209 };
 210
 211 struct io_u;
 212 extern int __must_check read_iolog_get(struct thread_data *, struct io_u *);
 213 extern void log_io_u(const struct thread_data *, const struct io_u *);
 214 extern void log_file(struct thread_data *, struct fio_file *, enum file_log_act);
 215 extern int __must_check init_iolog(struct thread_data *td);
 216 extern void log_io_piece(struct thread_data *, struct io_u *);
 217 extern void unlog_io_piece(struct thread_data *, struct io_u *);
 218 extern void trim_io_piece(struct thread_data *, const struct io_u *);
 219 extern void queue_io_piece(struct thread_data *, struct io_piece *);
 220 extern void prune_io_piece_log(struct thread_data *);
 221 extern void write_iolog_close(struct thread_data *);
 222 extern int iolog_compress_init(struct thread_data *, struct sk_out *);
 223 extern void iolog_compress_exit(struct thread_data *);
 224 extern size_t log_chunk_sizes(struct io_log *);
 225
 226 #ifdef CONFIG_ZLIB
 227 extern int iolog_file_inflate(const char *);
 228 #endif
 229
 230 /*
 231  * Logging
 232  */
 233 struct log_params {
 234         struct thread_data *td;
 235         unsigned long avg_msec;
 236         unsigned long hist_msec;
 237         int hist_coarseness;
 238         int log_type;
 239         int log_offset;
 240         int log_gz;
 241         int log_gz_store;
 242         int log_compress;
 243 };
 244
 245 static inline bool per_unit_log(struct io_log *log)
 246 {
 247         return log && !log->avg_msec;
 248 }
 249
 250 static inline bool inline_log(struct io_log *log)
 251 {
 252         return log->log_type == IO_LOG_TYPE_LAT ||
 253                 log->log_type == IO_LOG_TYPE_CLAT ||
 254                 log->log_type == IO_LOG_TYPE_SLAT;
 255 }
 256
 257 extern void finalize_logs(struct thread_data *td, bool);
 258 extern void setup_log(struct io_log **, struct log_params *, const char *);
 259 extern void flush_log(struct io_log *, bool);
 260 extern void flush_samples(FILE *, void *, uint64_t);
 261 extern void free_log(struct io_log *);
 262 extern void fio_writeout_logs(bool);
 263 extern void td_writeout_logs(struct thread_data *, bool);
 264 extern int iolog_cur_flush(struct io_log *, struct io_logs *);
 265
 266 static inline void init_ipo(struct io_piece *ipo)
 267 {
 268         memset(ipo, 0, sizeof(*ipo));
 269         INIT_FLIST_HEAD(&ipo->trim_list);
 270 }
 271
 272 struct iolog_compress {
 273         struct flist_head list;
 274         void *buf;
 275         size_t len;
 276         unsigned int seq;
 277 };
 278
 279 #endif