c4f353dcb409ab75ebafec978feaeea9e07647f4
[blktrace.git] / btt / README
1 blktrace Timeline
2 -----------------
3
4 Alan D. Brunelle (initial version)
5
6 Usage
7 -----
8
9 Usage: btt
10         [ -d <seconds>     | --range-delta=<seconds> ]
11         [ -D <dev;...>     | --devices=<dev;...> ]
12         [ -e <exe,...>     | --exes=<exe,...>  ]
13         [ -h               | --help ]
14         [ -i <input name>  | --input-file=<input name> ]
15         [ -I <output name> | --iostat=<output name> ]
16         [ -l <output name> | --d2c-latencies=<output name> ]
17         [ -M <dev map>     | --dev-maps=<dev map>
18         [ -o <output name> | --output-file=<output name> ]
19         [ -p <output name> | --per-io-dump=<output name> ]
20         [ -q <output name> | --q2c-latencies=<output name> ]
21         [ -s <output name> | --seeks=<output name> ]
22         [ -S <interval>    | --iostat-interval=<interval> ]
23         [ -V               | --version ]
24         [ -v               | --verbose ]
25
26 You are required to specify an input file (-i)
27
28 The -d option allows you to specify the granularity which determines
29 "activity" with regard to the .dat files -- this specific the time
30 (in seconds) that must elapse without a particular event occuring to
31 signify inactivity. The larger the number, the fewer ranges output --
32 the default is 0.1 seconds.
33
34 The -D option supplies the devices which should be looked at when
35 analyzing the input. This is a ":" separated list of devices, devices are
36 specified by a mjr,mnr tuple (e.g.: -D "8,0:8,8" specifies two devices
37 with major 8 and minor 0 and 8 respectively).
38
39 The -e option supplies the list of executables that will have I/Os
40 analyzed.
41
42 The -I option directs btt to output iostat-like data to the specified
43 file.  Refer to the iostat (sysstat) documentation for details on the
44 data columns. The -S option specifies the interval to use between data
45 output, it defaults to once per second.
46
47 The -l and -q options allow one to output per-IO D2C and Q2C latencies
48 respectively. The supplied argument provides the basis for the output
49 name for each device.
50
51 The -M option takes in a file generated by the provided script
52 (gen_disk_info.py), and allows for better output of device names.
53
54 The -p option will generate a file that contains a list of all IO
55 "sequences" - showing the parts of each IO (Q, A, I/M, D, & C).
56
57 The -s option instructs btt to output seek data, the argument provided
58 is the basis for file names output. There are two files per device,
59 read seeks and write seeks.
60
61 Overview
62 --------
63
64 btt will take in binary dump data from blkparse, and analyze the events,
65 producing a series of output from the analysis. It will also build .dat
66 files containing "range data" -- showing things like Q activity (periods
67 of time while Q events are being produced), C activity (likewise for
68 command completions), and etc.
69
70 Resources
71 ---------
72
73 vger hosts a mailing list dedicated to btrace discussion and development.
74 The list is called linux-btrace@vger.kernel.org, subscribe by sending
75 a mail to majordomo@vger.kernel.org with 'subscribe linux-btrace' in
76 the mail body.
77
78 2006-09_18, Alan D. Brunelle <alan.brunelle@hp.com>