ioengines: clarify FIO_RO_NEEDS_RW_OPEN flag
[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 FIO_JOBNAME_SIZE        128
146 #define FIO_JOBDESC_SIZE        256
147 #define FIO_VERROR_SIZE         128
148 #define UNIFIED_SPLIT           0
149 #define UNIFIED_MIXED           1
150 #define UNIFIED_BOTH            2
151
152 enum fio_lat {
153         FIO_SLAT = 0,
154         FIO_CLAT,
155         FIO_LAT,
156
157         FIO_LAT_CNT = 3,
158 };
159
160 struct clat_prio_stat {
161         uint64_t io_u_plat[FIO_IO_U_PLAT_NR];
162         struct io_stat clat_stat;
163         uint32_t ioprio;
164 };
165
166 struct thread_stat {
167         char name[FIO_JOBNAME_SIZE];
168         char verror[FIO_VERROR_SIZE];
169         uint32_t error;
170         uint32_t thread_number;
171         uint32_t groupid;
172         uint32_t pid;
173         char description[FIO_JOBDESC_SIZE];
174         uint32_t members;
175         uint32_t unified_rw_rep;
176         uint32_t disable_prio_stat;
177
178         /*
179          * bandwidth and latency stats
180          */
181         struct io_stat sync_stat __attribute__((aligned(8)));/* fsync etc stats */
182         struct io_stat clat_stat[DDIR_RWDIR_CNT]; /* completion latency */
183         struct io_stat slat_stat[DDIR_RWDIR_CNT]; /* submission latency */
184         struct io_stat lat_stat[DDIR_RWDIR_CNT]; /* total latency */
185         struct io_stat bw_stat[DDIR_RWDIR_CNT]; /* bandwidth stats */
186         struct io_stat iops_stat[DDIR_RWDIR_CNT]; /* IOPS stats */
187
188         /*
189          * fio system usage accounting
190          */
191         uint64_t usr_time;
192         uint64_t sys_time;
193         uint64_t ctx;
194         uint64_t minf, majf;
195
196         /*
197          * IO depth and latency stats
198          */
199         uint32_t clat_percentiles;
200         uint32_t lat_percentiles;
201         uint32_t slat_percentiles;
202         uint32_t pad;
203         uint64_t percentile_precision;
204         fio_fp64_t percentile_list[FIO_IO_U_LIST_MAX_LEN];
205
206         uint64_t io_u_map[FIO_IO_U_MAP_NR];
207         uint64_t io_u_submit[FIO_IO_U_MAP_NR];
208         uint64_t io_u_complete[FIO_IO_U_MAP_NR];
209         uint64_t io_u_lat_n[FIO_IO_U_LAT_N_NR];
210         uint64_t io_u_lat_u[FIO_IO_U_LAT_U_NR];
211         uint64_t io_u_lat_m[FIO_IO_U_LAT_M_NR];
212         uint64_t io_u_plat[FIO_LAT_CNT][DDIR_RWDIR_CNT][FIO_IO_U_PLAT_NR];
213         uint64_t io_u_sync_plat[FIO_IO_U_PLAT_NR];
214
215         uint64_t total_io_u[DDIR_RWDIR_SYNC_CNT];
216         uint64_t short_io_u[DDIR_RWDIR_CNT];
217         uint64_t drop_io_u[DDIR_RWDIR_CNT];
218         uint64_t total_submit;
219         uint64_t total_complete;
220
221         uint64_t io_bytes[DDIR_RWDIR_CNT];
222         uint64_t runtime[DDIR_RWDIR_CNT];
223         uint64_t total_run_time;
224
225         /*
226          * IO Error related stats
227          */
228         union {
229                 uint16_t continue_on_error;
230                 uint32_t pad2;
231         };
232         uint32_t first_error;
233         uint64_t total_err_count;
234
235         /* ZBD stats */
236         uint64_t nr_zone_resets;
237
238         uint64_t nr_block_infos;
239         uint32_t block_infos[MAX_NR_BLOCK_INFOS];
240
241         uint32_t kb_base;
242         uint32_t unit_base;
243
244         uint32_t latency_depth;
245         uint32_t pad3;
246         uint64_t latency_target;
247         fio_fp64_t latency_percentile;
248         uint64_t latency_window;
249
250         uint32_t sig_figs;
251
252         uint64_t ss_dur;
253         uint32_t ss_state;
254         uint32_t ss_head;
255
256         fio_fp64_t ss_limit;
257         fio_fp64_t ss_slope;
258         fio_fp64_t ss_deviation;
259         fio_fp64_t ss_criterion;
260
261         /* A mirror of td->ioprio. */
262         uint32_t ioprio;
263
264         union {
265                 uint64_t *ss_iops_data;
266                 /*
267                  * For FIO_NET_CMD_TS, the pointed to data will temporarily
268                  * be stored at this offset from the start of the payload.
269                  */
270                 uint64_t ss_iops_data_offset;
271                 uint64_t pad4;
272         };
273
274         union {
275                 uint64_t *ss_bw_data;
276                 /*
277                  * For FIO_NET_CMD_TS, the pointed to data will temporarily
278                  * be stored at this offset from the start of the payload.
279                  */
280                 uint64_t ss_bw_data_offset;
281                 uint64_t pad5;
282         };
283
284         union {
285                 struct clat_prio_stat *clat_prio[DDIR_RWDIR_CNT];
286                 /*
287                  * For FIO_NET_CMD_TS, the pointed to data will temporarily
288                  * be stored at this offset from the start of the payload.
289                  */
290                 uint64_t clat_prio_offset[DDIR_RWDIR_CNT];
291                 uint64_t pad6;
292         };
293         uint32_t nr_clat_prio[DDIR_RWDIR_CNT];
294
295         uint64_t cachehit;
296         uint64_t cachemiss;
297 } __attribute__((packed));
298
299 #define JOBS_ETA {                                                      \
300         uint32_t nr_running;                                            \
301         uint32_t nr_ramp;                                               \
302                                                                         \
303         uint32_t nr_pending;                                            \
304         uint32_t nr_setting_up;                                         \
305                                                                         \
306         uint64_t m_rate[DDIR_RWDIR_CNT];                                \
307         uint64_t t_rate[DDIR_RWDIR_CNT];                                \
308         uint64_t rate[DDIR_RWDIR_CNT];                                  \
309         uint32_t m_iops[DDIR_RWDIR_CNT];                                \
310         uint32_t t_iops[DDIR_RWDIR_CNT];                                \
311         uint32_t iops[DDIR_RWDIR_CNT];                                  \
312         uint32_t pad;                                                   \
313         uint64_t elapsed_sec;                                           \
314         uint64_t eta_sec;                                               \
315         uint32_t is_pow2;                                               \
316         uint32_t unit_base;                                             \
317                                                                         \
318         uint32_t sig_figs;                                              \
319                                                                         \
320         uint32_t files_open;                                            \
321                                                                         \
322         /*                                                              \
323          * Network 'copy' of run_str[]                                  \
324          */                                                             \
325         uint32_t nr_threads;                                            \
326         uint32_t pad2;                                                  \
327         uint8_t run_str[];                                              \
328 }
329
330 struct jobs_eta JOBS_ETA;
331 struct jobs_eta_packed JOBS_ETA __attribute__((packed));
332
333 struct io_u_plat_entry {
334         struct flist_head list;
335         uint64_t io_u_plat[FIO_IO_U_PLAT_NR];
336 };
337
338 extern struct fio_sem *stat_sem;
339
340 extern struct jobs_eta *get_jobs_eta(bool force, size_t *size);
341
342 extern void stat_init(void);
343 extern void stat_exit(void);
344
345 extern struct json_object * show_thread_status(struct thread_stat *ts, struct group_run_stats *rs, struct flist_head *, struct buf_output *);
346 extern void show_group_stats(struct group_run_stats *rs, struct buf_output *);
347 extern bool calc_thread_status(struct jobs_eta *je, int force);
348 extern void display_thread_status(struct jobs_eta *je);
349 extern void __show_run_stats(void);
350 extern int __show_running_run_stats(void);
351 extern void show_running_run_stats(void);
352 extern void check_for_running_stats(void);
353 extern void sum_thread_stats(struct thread_stat *dst, struct thread_stat *src);
354 extern void sum_group_stats(struct group_run_stats *dst, struct group_run_stats *src);
355 extern void init_thread_stat_min_vals(struct thread_stat *ts);
356 extern void init_thread_stat(struct thread_stat *ts);
357 extern void init_group_run_stat(struct group_run_stats *gs);
358 extern void eta_to_str(char *str, unsigned long eta_sec);
359 extern bool calc_lat(struct io_stat *is, unsigned long long *min, unsigned long long *max, double *mean, double *dev);
360 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);
361 extern void stat_calc_lat_n(struct thread_stat *ts, double *io_u_lat);
362 extern void stat_calc_lat_m(struct thread_stat *ts, double *io_u_lat);
363 extern void stat_calc_lat_u(struct thread_stat *ts, double *io_u_lat);
364 extern void stat_calc_dist(uint64_t *map, unsigned long total, double *io_u_dist);
365 extern void reset_io_stats(struct thread_data *);
366 extern void update_rusage_stat(struct thread_data *);
367 extern void clear_rusage_stat(struct thread_data *);
368
369 extern void add_lat_sample(struct thread_data *, enum fio_ddir, unsigned long long,
370                            unsigned long long, uint64_t, unsigned int, unsigned short);
371 extern void add_clat_sample(struct thread_data *, enum fio_ddir, unsigned long long,
372                             unsigned long long, uint64_t, unsigned int, unsigned short);
373 extern void add_slat_sample(struct thread_data *, enum fio_ddir, unsigned long long,
374                                 unsigned long long, uint64_t, unsigned int);
375 extern void add_agg_sample(union io_sample_data, enum fio_ddir, unsigned long long);
376 extern void add_iops_sample(struct thread_data *, struct io_u *,
377                                 unsigned int);
378 extern void add_bw_sample(struct thread_data *, struct io_u *,
379                                 unsigned int, unsigned long long);
380 extern void add_sync_clat_sample(struct thread_stat *ts,
381                                 unsigned long long nsec);
382 extern int calc_log_samples(void);
383 extern void free_clat_prio_stats(struct thread_stat *);
384 extern int alloc_clat_prio_stat_ddir(struct thread_stat *, enum fio_ddir, int);
385
386 extern void print_disk_util(struct disk_util_stat *, struct disk_util_agg *, int terse, struct buf_output *);
387 extern void json_array_add_disk_util(struct disk_util_stat *dus,
388                                 struct disk_util_agg *agg, struct json_array *parent);
389
390 extern struct io_log *agg_io_log[DDIR_RWDIR_CNT];
391 extern bool write_bw_log;
392
393 static inline bool nsec_to_usec(unsigned long long *min,
394                                 unsigned long long *max, double *mean,
395                                 double *dev)
396 {
397         if (*min > 2000 && *max > 99999 && *dev > 1000.0) {
398                 *min /= 1000;
399                 *max /= 1000;
400                 *mean /= 1000.0;
401                 *dev /= 1000.0;
402                 return true;
403         }
404
405         return false;
406 }
407
408 static inline bool nsec_to_msec(unsigned long long *min,
409                                 unsigned long long *max, double *mean,
410                                 double *dev)
411 {
412         if (*min > 2000000 && *max > 99999999ULL && *dev > 1000000.0) {
413                 *min /= 1000000;
414                 *max /= 1000000;
415                 *mean /= 1000000.0;
416                 *dev /= 1000000.0;
417                 return true;
418         }
419
420         return false;
421 }
422
423 /*
424  * Worst level condensing would be 1:5, so allow enough room for that
425  */
426 #define __THREAD_RUNSTR_SZ(nr)  ((nr) * 5)
427 #define THREAD_RUNSTR_SZ        __THREAD_RUNSTR_SZ(thread_number)
428
429 uint32_t *io_u_block_info(struct thread_data *td, struct io_u *io_u);
430
431 #endif