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