blktrace 1.1.0
[blktrace.git] / btt / globals.h
1 /*
2  * blktrace output analysis: generate a timeline & gather statistics
3  *
4  * Copyright (C) 2006 Alan D. Brunelle <Alan.Brunelle@hp.com>
5  *
6  *  This program is free software; you can redistribute it and/or modify
7  *  it under the terms of the GNU General Public License as published by
8  *  the Free Software Foundation; either version 2 of the License, or
9  *  (at your option) any later version.
10  *
11  *  This program is distributed in the hope that it will be useful,
12  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
13  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  *  GNU General Public License for more details.
15  *
16  *  You should have received a copy of the GNU General Public License
17  *  along with this program; if not, write to the Free Software
18  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
19  *
20  */
21 #include <stdio.h>
22 #include <string.h>
23 #include <time.h>
24
25 #include "blktrace.h"
26 #include "rbtree.h"
27 #include "list.h"
28
29 /*
30  * 0 == 1 blk
31  * 1 == 2 blks
32  * ...
33  * 1022 == 1023 blks
34  * 1023 == 1024 blks
35  * 1024 == > 1024 blks
36  */
37 #define N_HIST_BKTS     1025
38
39 #define BIT_TIME(t)     ((double)SECONDS(t) + ((double)NANO_SECONDS(t) / 1.0e9))
40
41 #define BIT_START(iop)  ((iop)->t.sector)
42 #define BIT_END(iop)    ((iop)->t.sector + ((iop)->t.bytes >> 9))
43 #define IOP_READ(iop)   ((iop)->t.action & BLK_TC_ACT(BLK_TC_READ))
44 #define IOP_RW(iop)     (IOP_READ(iop) ? 1 : 0)
45
46 #define TO_SEC(nanosec) ((double)(nanosec) / 1.0e9)
47 #define TO_MSEC(nanosec) (1000.0 * TO_SEC(nanosec))
48
49 enum iop_type {
50         IOP_Q = 0,
51         IOP_X = 1,
52         IOP_A = 2,
53         IOP_G = 3,
54         IOP_M = 4,
55         IOP_D = 5,
56         IOP_C = 6,
57         IOP_R = 7,
58         IOP_I = 8,
59         IOP_S = 9
60 };
61 #define N_IOP_TYPES     (IOP_S + 1)
62
63 struct mode {
64         int most_seeks, nmds;
65         long long *modes;
66 };
67
68 struct io;
69 struct io_list {
70         struct list_head head;
71         struct io *iop;
72         int cy_users;
73 };
74
75 struct avg_info {
76         __u64 min, max, total;
77         double avg;
78         int n;
79 };
80
81 struct avgs_info {
82         struct avg_info q2q_dm;
83         struct avg_info q2a_dm;
84         struct avg_info q2c_dm;
85
86         struct avg_info q2q;
87         struct avg_info q2a;
88         struct avg_info q2g;
89         struct avg_info s2g;
90         struct avg_info g2i;
91         struct avg_info q2m;
92         struct avg_info i2d;
93         struct avg_info m2d;
94         struct avg_info d2c;
95         struct avg_info q2c;
96
97         struct avg_info blks;           /* Blocks transferred */
98 };
99
100 struct range_info {
101         struct list_head head;          /* on: qranges OR cranges */
102         __u64 start, end;
103 };
104
105 struct region_info {
106         struct list_head qranges;
107         struct list_head cranges;
108 };
109
110 struct p_info {
111         struct region_info regions;
112         struct avgs_info avgs;
113         __u64 last_q;
114         __u32 pid;
115         char *name;
116 };
117
118 struct stats {
119         __u64 rqm[2], ios[2], sec[2], wait, svctm;
120         double last_qu_change, last_dev_change, tot_qusz, idle_time;
121         int cur_qusz, cur_dev;
122 };
123
124 struct stats_t {
125         double n;
126         double rqm_s[2], ios_s[2], sec_s[2];
127         double avgrq_sz, avgqu_sz, await, svctm, p_util;
128 };
129
130 struct d_info {
131         struct list_head all_head, hash_head;
132         void *heads;
133         struct region_info regions;
134         char *devmap, dip_name[256];
135         void *q2q_handle, *seek_handle, *bno_dump_handle, *up_hist_handle;
136         void *q2d_priv, *aqd_handle, *rstat_handle, *p_live_handle;
137         void *q2d_plat_handle, *q2c_plat_handle, *d2c_plat_handle;
138         FILE *q2d_ofp, *d2c_ofp, *q2c_ofp, *pit_fp;
139         struct avgs_info avgs;
140         struct stats stats, all_stats;
141         __u64 last_q, n_qs, n_ds;
142         __u64 n_act_q, t_act_q; /* # currently active when Q comes in */
143         __u32 device;
144
145         int pre_culling;
146         int is_plugged, nplugs, nplugs_t;
147         __u64 nios_up, nios_upt;
148         double start_time, last_plug, plugged_time, end_time;
149 };
150
151 struct io {
152         struct rb_node rb_node;
153         struct list_head f_head, a_head;
154         struct d_info *dip;
155         struct p_info *pip;
156         void *pdu;
157         __u64 bytes_left, g_time, i_time, m_time, d_time, c_time, d_sec, c_sec;
158         __u64 s_time;
159         __u32 d_nsec, c_nsec;
160
161         struct blk_io_trace t;
162
163         int linked;
164         enum iop_type type;
165 };
166
167 struct p_live_info {
168         unsigned long nlives;
169         double avg_live, avg_lull, p_live;
170 };
171
172 /* bt_timeline.c */
173
174 extern char bt_timeline_version[], *devices, *exes, *input_name, *output_name;
175 extern char *seek_name, *iostat_name, *d2c_name, *q2c_name, *per_io_name;
176 extern char *bno_dump_name, *unplug_hist_name, *sps_name, *aqd_name, *q2d_name;
177 extern char *per_io_trees;
178 extern double range_delta, plat_freq, last_t_seen;
179 extern FILE *rngs_ofp, *avgs_ofp, *xavgs_ofp, *iostat_ofp, *per_io_ofp;
180 extern FILE *msgs_ofp;
181 extern int verbose, done, time_bounded, output_all_data, seek_absolute;
182 extern int easy_parse_avgs, ignore_remaps, do_p_live;
183 extern unsigned int n_devs;
184 extern unsigned long n_traces;
185 extern struct list_head all_devs, all_procs;
186 extern struct avgs_info all_avgs;
187 extern __u64 last_q;
188 extern struct region_info all_regions;
189 extern struct list_head all_ios, free_ios;
190 extern __u64 iostat_interval, iostat_last_stamp;
191 extern time_t genesis, last_vtrace;
192 extern double t_astart, t_aend;
193 extern __u64 q_histo[N_HIST_BKTS], d_histo[N_HIST_BKTS];
194
195 /* args.c */
196 void handle_args(int argc, char *argv[]);
197 void clean_args();
198
199 /* aqd.c */
200 void *aqd_alloc(struct d_info *dip);
201 void aqd_free(void *info);
202 void aqd_clean(void);
203 void aqd_issue(void *info, double ts);
204 void aqd_complete(void *info, double ts);
205
206 /* devmap.c */
207 int dev_map_read(char *fname);
208 char *dev_map_find(__u32 device);
209 void dev_map_exit(void);
210
211 /* devs.c */
212 void init_dev_heads(void);
213 struct d_info *dip_alloc(__u32 device, struct io *iop);
214 void iop_rem_dip(struct io *iop);
215 struct d_info *__dip_find(__u32 device);
216 void dip_foreach_list(struct io *iop, enum iop_type type, struct list_head *hd);
217 void dip_foreach(struct io *iop, enum iop_type type,
218                  void (*fnc)(struct io *iop, struct io *this), int rm_after);
219 struct io *dip_find_sec(struct d_info *dip, enum iop_type type, __u64 sec);
220 void dip_foreach_out(void (*func)(struct d_info *, void *), void *arg);
221 void dip_plug(__u32 dev, double cur_time);
222 void dip_unplug(__u32 dev, double cur_time, __u64 nio_ups);
223 void dip_unplug_tm(__u32 dev, double cur_time, __u64 nio_ups);
224 void dip_exit(void);
225 void dip_cleanup(void);
226
227 /* dip_rb.c */
228 int rb_insert(struct rb_root *root, struct io *iop);
229 struct io *rb_find_sec(struct rb_root *root, __u64 sec);
230 void rb_foreach(struct rb_node *n, struct io *iop,
231                       void (*fnc)(struct io *iop, struct io *this),
232                       struct list_head *head);
233
234 /* iostat.c */
235 void iostat_init(void);
236 void iostat_getrq(struct io *iop);
237 void iostat_merge(struct io *iop);
238 void iostat_issue(struct io *iop);
239 void iostat_complete(struct io *d_iop, struct io *c_iop);
240 void iostat_check_time(__u64 stamp);
241 void iostat_dump_stats(__u64 stamp, int all);
242
243 /* latency.c */
244 void latency_alloc(struct d_info *dip);
245 void latency_clean(void);
246 void latency_q2d(struct d_info *dip, __u64 tstamp, __u64 latency);
247 void latency_d2c(struct d_info *dip, __u64 tstamp, __u64 latency);
248 void latency_q2c(struct d_info *dip, __u64 tstamp, __u64 latency);
249
250 /* misc.c */
251 void add_file(FILE *fp, char *oname);
252 void add_buf(void *buf);
253 char *make_dev_hdr(char *pad, size_t len, struct d_info *dip, int add_parens);
254 char *mkhandle(struct d_info *dip, char *str, size_t len);
255 FILE *my_fopen(const char *path, const char *mode);
256 int my_open(const char *path, int flags);
257 void dbg_ping(void);
258 void clean_allocs(void);
259
260 /* mmap.c */
261 void setup_ifile(char *fname);
262 void cleanup_ifile(void);
263 int next_trace(struct blk_io_trace *t, void **pdu);
264 double pct_done(void);
265
266 /* output.c */
267 int output_avgs(FILE *ofp);
268 int output_ranges(FILE *ofp);
269
270 /* proc.c */
271 void process_alloc(__u32 pid, char *name);
272 struct p_info *find_process(__u32 pid, char *name);
273 void pip_update_q(struct io *iop);
274 void pip_foreach_out(void (*f)(struct p_info *, void *), void *arg);
275 void pip_exit(void);
276
277 /* bno_dump.c */
278 void *bno_dump_alloc(struct d_info *dip);
279 void bno_dump_free(void *param);
280 void bno_dump_add(void *handle, struct io *iop);
281 void bno_dump_clean(void);
282
283 /* plat.c */
284 void *plat_alloc(struct d_info *dip, char *post);
285 void plat_free(void *info);
286 void plat_clean(void);
287 void plat_x2c(void *info, __u64 ts, __u64 latency);
288
289 /* p_live.c */
290 void *p_live_alloc(void);
291 void p_live_free(void *p);
292 void p_live_add(struct d_info *dip, __u64 dt, __u64 ct);
293 void p_live_exit(void);
294 struct p_live_info *p_live_get(struct d_info *dip, int base_y);
295
296 /* q2d.c */
297 void q2d_histo_add(void *priv, __u64 q2d);
298 void *q2d_alloc(void);
299 void q2d_free(void *priv);
300 void q2d_display_header(FILE *fp);
301 void q2d_display_dashes(FILE *fp);
302 void q2d_display(FILE *fp, void *priv);
303 int q2d_ok(void *priv);
304 void q2d_acc(void *a1, void *a2);
305
306 /* rstats.c */
307 void *rstat_alloc(struct d_info *dip);
308 void rstat_free(void *ptr);
309 void rstat_add(void *ptr, double cur, unsigned long long nblks);
310 int rstat_init(void);
311 void rstat_exit(void);
312
313 /* seek.c */
314 void *seeki_alloc(struct d_info *dip, char *post);
315 void seeki_free(void *param);
316 void seek_clean(void);
317 void seeki_add(void *handle, struct io *iop);
318 double seeki_mean(void *handle);
319 long long seeki_nseeks(void *handle);
320 long long seeki_median(void *handle);
321 int seeki_mode(void *handle, struct mode *mp);
322
323 /* trace.c */
324 void add_trace(struct io *iop);
325
326 /* trace_complete.c */
327 void trace_complete(struct io *c_iop);
328
329 /* trace_im.c */
330 void run_im(struct io *im_iop, struct io *d_iop, struct io *c_iop);
331 void run_unim(struct io *im_iop, struct io *d_iop, struct io *c_iop);
332 int ready_im(struct io *im_iop, struct io *c_iop);
333 void trace_insert(struct io *i_iop);
334 void trace_merge(struct io *m_iop);
335 void trace_getrq(struct io *g_iop);
336 void trace_sleeprq(struct io *s_iop);
337
338 /* trace_issue.c */
339 void run_issue(struct io *d_iop, struct io *u_iop, struct io *c_iop);
340 void run_unissue(struct io *d_iop, struct io *u_iop, struct io *c_iop);
341 int ready_issue(struct io *d_iop, struct io *c_iop);
342 void trace_issue(struct io *d_iop);
343
344 /* trace_plug.c */
345 void trace_plug(struct io *p_iop);
346 void trace_unplug_io(struct io *u_iop);
347 void trace_unplug_timer(struct io *u_iop);
348
349 /* trace_queue.c */
350 void run_queue(struct io *q_iop, struct io *u_iop, struct io *c_iop);
351 int ready_queue(struct io *q_iop, struct io *c_iop);
352 void trace_queue(struct io *q_iop);
353
354 /* trace_remap.c */
355 void run_remap(struct io *a_iop, struct io *u_iop, struct io *c_iop);
356 int ready_remap(struct io *a_iop, struct io *c_iop);
357 void trace_remap(struct io *a_iop);
358
359 /* trace_requeue.c */
360 void trace_requeue(struct io *r_iop);
361
362 /* unplug_hist.c */
363 void *unplug_hist_alloc(struct d_info *dip);
364 void unplug_hist_free(void *arg);
365 void unplug_hist_add(struct io *u_iop);
366
367 #include "inlines.h"