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