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