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