stat.h

   1 #ifndef FIO_STAT_H
   2 #define FIO_STAT_H
   3
   4 #include "iolog.h"
   5 #include "lib/output_buffer.h"
   6
   7 struct lat_step_stats {
   8         uint64_t iops[DDIR_RWDIR_CNT];
   9         fio_fp64_t avg[DDIR_RWDIR_CNT];
  10 };
  11
  12 struct group_run_stats {
  13         uint64_t max_run[DDIR_RWDIR_CNT], min_run[DDIR_RWDIR_CNT];
  14         uint64_t max_bw[DDIR_RWDIR_CNT], min_bw[DDIR_RWDIR_CNT];
  15         uint64_t iobytes[DDIR_RWDIR_CNT];
  16         uint64_t agg[DDIR_RWDIR_CNT];
  17         uint32_t kb_base;
  18         uint32_t unit_base;
  19         uint32_t sig_figs;
  20         uint32_t groupid;
  21         uint32_t unified_rw_rep;
  22 } __attribute__((packed));
  23
  24 /*
  25  * How many depth levels to log
  26  */
  27 #define FIO_IO_U_MAP_NR 7
  28 #define FIO_IO_U_LAT_N_NR 10
  29 #define FIO_IO_U_LAT_U_NR 10
  30 #define FIO_IO_U_LAT_M_NR 12
  31
  32 /*
  33  * Constants for clat percentiles
  34  */
  35 #define FIO_IO_U_PLAT_BITS 6
  36 #define FIO_IO_U_PLAT_VAL (1 << FIO_IO_U_PLAT_BITS)
  37 #define FIO_IO_U_PLAT_GROUP_NR 29
  38 #define FIO_IO_U_PLAT_NR (FIO_IO_U_PLAT_GROUP_NR * FIO_IO_U_PLAT_VAL)
  39 #define FIO_IO_U_LIST_MAX_LEN 20 /* The size of the default and user-specified
  40                                         list of percentiles */
  41
  42 /*
  43  * Aggregate clat samples to report percentile(s) of them.
  44  *
  45  * EXECUTIVE SUMMARY
  46  *
  47  * FIO_IO_U_PLAT_BITS determines the maximum statistical error on the
  48  * value of resulting percentiles. The error will be approximately
  49  * 1/2^(FIO_IO_U_PLAT_BITS+1) of the value.
  50  *
  51  * FIO_IO_U_PLAT_GROUP_NR and FIO_IO_U_PLAT_BITS determine the maximum
  52  * range being tracked for latency samples. The maximum value tracked
  53  * accurately will be 2^(GROUP_NR + PLAT_BITS - 1) nanoseconds.
  54  *
  55  * FIO_IO_U_PLAT_GROUP_NR and FIO_IO_U_PLAT_BITS determine the memory
  56  * requirement of storing those aggregate counts. The memory used will
  57  * be (FIO_IO_U_PLAT_GROUP_NR * 2^FIO_IO_U_PLAT_BITS) * sizeof(int)
  58  * bytes.
  59  *
  60  * FIO_IO_U_PLAT_NR is the total number of buckets.
  61  *
  62  * DETAILS
  63  *
  64  * Suppose the clat varies from 0 to 999 (usec), the straightforward
  65  * method is to keep an array of (999 + 1) buckets, in which a counter
  66  * keeps the count of samples which fall in the bucket, e.g.,
  67  * {[0],[1],...,[999]}. However this consumes a huge amount of space,
  68  * and can be avoided if an approximation is acceptable.
  69  *
  70  * One such method is to let the range of the bucket to be greater
  71  * than one. This method has low accuracy when the value is small. For
  72  * example, let the buckets be {[0,99],[100,199],...,[900,999]}, and
  73  * the represented value of each bucket be the mean of the range. Then
  74  * a value 0 has an round-off error of 49.5. To improve on this, we
  75  * use buckets with non-uniform ranges, while bounding the error of
  76  * each bucket within a ratio of the sample value. A simple example
  77  * would be when error_bound = 0.005, buckets are {
  78  * {[0],[1],...,[99]}, {[100,101],[102,103],...,[198,199]},..,
  79  * {[900,909],[910,919]...}  }. The total range is partitioned into
  80  * groups with different ranges, then buckets with uniform ranges. An
  81  * upper bound of the error is (range_of_bucket/2)/value_of_bucket
  82  *
  83  * For better efficiency, we implement this using base two. We group
  84  * samples by their Most Significant Bit (MSB), extract the next M bit
  85  * of them as an index within the group, and discard the rest of the
  86  * bits.
  87  *
  88  * E.g., assume a sample 'x' whose MSB is bit n (starting from bit 0),
  89  * and use M bit for indexing
  90  *
  91  *        | n |    M bits   | bit (n-M-1) ... bit 0 |
  92  *
  93  * Because x is at least 2^n, and bit 0 to bit (n-M-1) is at most
  94  * (2^(n-M) - 1), discarding bit 0 to (n-M-1) makes the round-off
  95  * error
  96  *
  97  *           2^(n-M)-1    2^(n-M)    1
  98  *      e <= --------- <= ------- = ---
  99  *             2^n          2^n     2^M
 100  *
 101  * Furthermore, we use "mean" of the range to represent the bucket,
 102  * the error e can be lowered by half to 1 / 2^(M+1). By using M bits
 103  * as the index, each group must contains 2^M buckets.
 104  *
 105  * E.g. Let M (FIO_IO_U_PLAT_BITS) be 6
 106  *      Error bound is 1/2^(6+1) = 0.0078125 (< 1%)
 107  *
 108  *      Group   MSB     #discarded      range of                #buckets
 109  *                      error_bits      value
 110  *      ----------------------------------------------------------------
 111  *      0*      0~5     0               [0,63]                  64
 112  *      1*      6       0               [64,127]                64
 113  *      2       7       1               [128,255]               64
 114  *      3       8       2               [256,511]               64
 115  *      4       9       3               [512,1023]              64
 116  *      ...     ...     ...             [...,...]               ...
 117  *      28      33      27              [8589934592,+inf]**     64
 118  *
 119  *  * Special cases: when n < (M-1) or when n == (M-1), in both cases,
 120  *    the value cannot be rounded off. Use all bits of the sample as
 121  *    index.
 122  *
 123  *  ** If a sample's MSB is greater than 33, it will be counted as 33.
 124  */
 125
 126 /*
 127  * Trim cycle count measurements
 128  */
 129 #define MAX_NR_BLOCK_INFOS      8192
 130 #define BLOCK_INFO_STATE_SHIFT  29
 131 #define BLOCK_INFO_TRIMS(block_info)    \
 132         ((block_info) & ((1 << BLOCK_INFO_STATE_SHIFT) - 1))
 133 #define BLOCK_INFO_STATE(block_info)            \
 134         ((block_info) >> BLOCK_INFO_STATE_SHIFT)
 135 #define BLOCK_INFO(state, trim_cycles)  \
 136         ((trim_cycles) | ((unsigned int) (state) << BLOCK_INFO_STATE_SHIFT))
 137 #define BLOCK_INFO_SET_STATE(block_info, state) \
 138         BLOCK_INFO(state, BLOCK_INFO_TRIMS(block_info))
 139 enum block_info_state {
 140         BLOCK_STATE_UNINIT,
 141         BLOCK_STATE_TRIMMED,
 142         BLOCK_STATE_WRITTEN,
 143         BLOCK_STATE_TRIM_FAILURE,
 144         BLOCK_STATE_WRITE_FAILURE,
 145         BLOCK_STATE_COUNT,
 146 };
 147
 148 #define MAX_PATTERN_SIZE        512
 149 #define FIO_JOBNAME_SIZE        128
 150 #define FIO_JOBDESC_SIZE        256
 151 #define FIO_VERROR_SIZE         128
 152
 153 #define MAX_STEP_STATS          64
 154
 155 struct thread_stat {
 156         char name[FIO_JOBNAME_SIZE];
 157         char verror[FIO_VERROR_SIZE];
 158         uint32_t error;
 159         uint32_t thread_number;
 160         uint32_t groupid;
 161         uint32_t pid;
 162         char description[FIO_JOBDESC_SIZE];
 163         uint32_t members;
 164         uint32_t unified_rw_rep;
 165
 166         /*
 167          * bandwidth and latency stats
 168          */
 169         struct io_stat sync_stat __attribute__((aligned(8)));/* fsync etc stats */
 170         struct io_stat clat_stat[DDIR_RWDIR_CNT]; /* completion latency */
 171         struct io_stat slat_stat[DDIR_RWDIR_CNT]; /* submission latency */
 172         struct io_stat lat_stat[DDIR_RWDIR_CNT]; /* total latency */
 173         struct io_stat bw_stat[DDIR_RWDIR_CNT]; /* bandwidth stats */
 174         struct io_stat iops_stat[DDIR_RWDIR_CNT]; /* IOPS stats */
 175
 176         /*
 177          * fio system usage accounting
 178          */
 179         uint64_t usr_time;
 180         uint64_t sys_time;
 181         uint64_t ctx;
 182         uint64_t minf, majf;
 183
 184         /*
 185          * IO depth and latency stats
 186          */
 187         uint32_t clat_percentiles;
 188         uint32_t lat_percentiles;
 189         uint64_t percentile_precision;
 190         fio_fp64_t percentile_list[FIO_IO_U_LIST_MAX_LEN];
 191
 192         uint64_t io_u_map[FIO_IO_U_MAP_NR];
 193         uint64_t io_u_submit[FIO_IO_U_MAP_NR];
 194         uint64_t io_u_complete[FIO_IO_U_MAP_NR];
 195         uint64_t io_u_lat_n[FIO_IO_U_LAT_N_NR];
 196         uint64_t io_u_lat_u[FIO_IO_U_LAT_U_NR];
 197         uint64_t io_u_lat_m[FIO_IO_U_LAT_M_NR];
 198         uint64_t io_u_plat[DDIR_RWDIR_CNT][FIO_IO_U_PLAT_NR];
 199         uint64_t io_u_sync_plat[FIO_IO_U_PLAT_NR];
 200
 201         uint64_t total_io_u[DDIR_RWDIR_SYNC_CNT];
 202         uint64_t short_io_u[DDIR_RWDIR_CNT];
 203         uint64_t drop_io_u[DDIR_RWDIR_CNT];
 204         uint64_t total_submit;
 205         uint64_t total_complete;
 206
 207         uint64_t io_bytes[DDIR_RWDIR_CNT];
 208         uint64_t runtime[DDIR_RWDIR_CNT];
 209         uint64_t total_run_time;
 210
 211         /*
 212          * IO Error related stats
 213          */
 214         union {
 215                 uint16_t continue_on_error;
 216                 uint32_t pad2;
 217         };
 218         uint32_t first_error;
 219         uint64_t total_err_count;
 220
 221         /* ZBD stats */
 222         uint64_t nr_zone_resets;
 223
 224         uint64_t nr_block_infos;
 225         uint32_t block_infos[MAX_NR_BLOCK_INFOS];
 226
 227         uint32_t kb_base;
 228         uint32_t unit_base;
 229
 230         uint32_t latency_depth;
 231         uint32_t pad3;
 232         uint64_t latency_target;
 233         fio_fp64_t latency_percentile;
 234         uint64_t latency_window;
 235
 236         uint32_t sig_figs;
 237         uint32_t pad4;
 238
 239         struct lat_step_stats step_stats[MAX_STEP_STATS];
 240
 241         uint64_t ss_dur;
 242         uint32_t ss_state;
 243         uint32_t ss_head;
 244
 245         fio_fp64_t ss_limit;
 246         fio_fp64_t ss_slope;
 247         fio_fp64_t ss_deviation;
 248         fio_fp64_t ss_criterion;
 249
 250         union {
 251                 uint64_t *ss_iops_data;
 252                 uint64_t pad5;
 253         };
 254
 255         union {
 256                 uint64_t *ss_bw_data;
 257                 uint64_t pad6;
 258         };
 259 } __attribute__((packed));
 260
 261 struct jobs_eta {
 262         uint32_t nr_running;
 263         uint32_t nr_ramp;
 264
 265         uint32_t nr_pending;
 266         uint32_t nr_setting_up;
 267
 268         uint64_t m_rate[DDIR_RWDIR_CNT], t_rate[DDIR_RWDIR_CNT];
 269         uint64_t rate[DDIR_RWDIR_CNT];
 270         uint32_t m_iops[DDIR_RWDIR_CNT], t_iops[DDIR_RWDIR_CNT];
 271         uint32_t iops[DDIR_RWDIR_CNT];
 272         uint64_t elapsed_sec;
 273         uint64_t eta_sec;
 274         uint32_t is_pow2;
 275         uint32_t unit_base;
 276
 277         uint32_t sig_figs;
 278
 279         uint32_t files_open;
 280
 281         /*
 282          * Network 'copy' of run_str[]
 283          */
 284         uint32_t nr_threads;
 285         uint8_t run_str[];
 286 } __attribute__((packed));
 287
 288 struct io_u_plat_entry {
 289         struct flist_head list;
 290         uint64_t io_u_plat[FIO_IO_U_PLAT_NR];
 291 };
 292
 293 extern struct fio_sem *stat_sem;
 294
 295 extern struct jobs_eta *get_jobs_eta(bool force, size_t *size);
 296
 297 extern void stat_init(void);
 298 extern void stat_exit(void);
 299
 300 extern struct json_object * show_thread_status(struct thread_stat *ts, struct group_run_stats *rs, struct flist_head *, struct buf_output *);
 301 extern void show_group_stats(struct group_run_stats *rs, struct buf_output *);
 302 extern bool calc_thread_status(struct jobs_eta *je, int force);
 303 extern void display_thread_status(struct jobs_eta *je);
 304 extern void __show_run_stats(void);
 305 extern void __show_running_run_stats(void);
 306 extern void show_running_run_stats(void);
 307 extern void check_for_running_stats(void);
 308 extern void sum_thread_stats(struct thread_stat *dst, struct thread_stat *src, bool first);
 309 extern void sum_group_stats(struct group_run_stats *dst, struct group_run_stats *src);
 310 extern void init_thread_stat(struct thread_stat *ts);
 311 extern void init_group_run_stat(struct group_run_stats *gs);
 312 extern void eta_to_str(char *str, unsigned long eta_sec);
 313 extern bool calc_lat(struct io_stat *is, unsigned long long *min, unsigned long long *max, double *mean, double *dev);
 314 extern unsigned int calc_clat_percentiles(uint64_t *io_u_plat, unsigned long long nr, fio_fp64_t *plist, unsigned long long **output, unsigned long long *maxv, unsigned long long *minv);
 315 extern void stat_calc_lat_n(struct thread_stat *ts, double *io_u_lat);
 316 extern void stat_calc_lat_m(struct thread_stat *ts, double *io_u_lat);
 317 extern void stat_calc_lat_u(struct thread_stat *ts, double *io_u_lat);
 318 extern void stat_calc_dist(uint64_t *map, unsigned long total, double *io_u_dist);
 319 extern void reset_io_stats(struct thread_data *);
 320 extern void update_rusage_stat(struct thread_data *);
 321 extern void clear_rusage_stat(struct thread_data *);
 322
 323 extern void add_lat_sample(struct thread_data *, enum fio_ddir, unsigned long long,
 324                                 unsigned long long, uint64_t);
 325 extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long long,
 326                                 unsigned long long, uint64_t);
 327 extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long,
 328                                 unsigned long long, uint64_t);
 329 extern void add_agg_sample(union io_sample_data, enum fio_ddir, unsigned long long);
 330 extern void add_iops_sample(struct thread_data *, struct io_u *,
 331                                 unsigned int);
 332 extern void add_bw_sample(struct thread_data *, struct io_u *,
 333                                 unsigned int, unsigned long long);
 334 extern void add_sync_clat_sample(struct thread_stat *ts,
 335                                         unsigned long long nsec);
 336 extern int calc_log_samples(void);
 337
 338 extern struct io_log *agg_io_log[DDIR_RWDIR_CNT];
 339 extern bool write_bw_log;
 340
 341 static inline bool nsec_to_usec(unsigned long long *min,
 342                                 unsigned long long *max, double *mean,
 343                                 double *dev)
 344 {
 345         if (*min > 2000 && *max > 99999 && *dev > 1000.0) {
 346                 *min /= 1000;
 347                 *max /= 1000;
 348                 *mean /= 1000.0;
 349                 *dev /= 1000.0;
 350                 return true;
 351         }
 352
 353         return false;
 354 }
 355
 356 static inline bool nsec_to_msec(unsigned long long *min,
 357                                 unsigned long long *max, double *mean,
 358                                 double *dev)
 359 {
 360         if (*min > 2000000 && *max > 99999999ULL && *dev > 1000000.0) {
 361                 *min /= 1000000;
 362                 *max /= 1000000;
 363                 *mean /= 1000000.0;
 364                 *dev /= 1000000.0;
 365                 return true;
 366         }
 367
 368         return false;
 369 }
 370
 371 /*
 372  * Worst level condensing would be 1:5, so allow enough room for that
 373  */
 374 #define __THREAD_RUNSTR_SZ(nr)  ((nr) * 5)
 375 #define THREAD_RUNSTR_SZ        __THREAD_RUNSTR_SZ(thread_number)
 376
 377 uint32_t *io_u_block_info(struct thread_data *td, struct io_u *io_u);
 378
 379 #endif