[PATCH] Add Alan's btt tool
[blktrace.git] / btt / README
1 blktrace Timeline
2 -----------------
3
4 Alan D. Brunelle (initial version)
5
6 Usage
7 -----
8
9 $ btt -i <input file> (-l | -m) [-d <range delta>] [-D <devices...>]
10       [-e <executables...>] [-h] [-M map information] [-o <output file>]
11       [-v] [-V]
12
13 You are required to:
14
15 o  Specify an input file (-i)
16
17 o  Specify MD (-m) or LVM2/DM (-l) devices present (If no software RAID
18    devices, use -m.) This is a workaround for issues between LVM2 and MD
19    remap events that needs to be cleaned up. [DM devices are not working
20    as of right now, always specify -m for individual disks and/or MD
21    devices.]
22
23 The -d argument allows you to specify the granularity which dtermines
24 "activity" with regard to the .dat files -- this specific the time
25 (in seconds) that must elapse without a particular event occuring to
26 signify inactivity. The larger the number, the fewer ranges output --
27 the default is 0.1 seconds.
28
29 The -D argument supplies the devices which should be looked at when
30 analyzing the input. This is a ":" separated list of devices, devices are
31 specified by a mjr,mnr tuple (e.g.: -D "8,0:8,8" specifies two devices
32 with major 8 and minor 0 and 8 respectively).
33
34 The -e argument supplies the list of executables that will have I/Os
35 analyzed.
36
37 The -M argument takes in a file generated by the provided script
38 (gen_disk_info.py), and allows for better output of device names.
39
40 Overview
41 --------
42
43 btt will take in binary dump data from blkparse, and analyze the events,
44 producing a series of output from the analysis. It will also build .dat
45 files containing "range data" -- showing things like Q activity (periods
46 of time while Q events are being produced), C activity (likewise for
47 command completions), and etc.
48
49 Resources
50 ---------
51
52 vger hosts a mailing list dedicated to btrace discussion and development.
53 The list is called linux-btrace@vger.kernel.org, subscribe by sending
54 a mail to majordomo@vger.kernel.org with 'subscribe linux-btrace' in
55 the mail body.
56
57 2006-05-17, Alan D. Brunelle <alan.brunelle@hp.com>