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         [ -t <sec>         | --time-start=<sec> ]
  24         [ -T <sec>         | --time-end=<sec> ]
  25         [ -V               | --version ]
  26         [ -v               | --verbose ]
  27
  28 You are required to specify an input file (-i)
  29
  30 The -d option allows you to specify the granularity which determines
  31 "activity" with regard to the .dat files -- this specific the time
  32 (in seconds) that must elapse without a particular event occuring to
  33 signify inactivity. The larger the number, the fewer ranges output --
  34 the default is 0.1 seconds.
  35
  36 The -D option supplies the devices which should be looked at when
  37 analyzing the input. This is a ":" separated list of devices, devices are
  38 specified by a mjr,mnr tuple (e.g.: -D "8,0:8,8" specifies two devices
  39 with major 8 and minor 0 and 8 respectively).
  40
  41 The -e option supplies the list of executables that will have I/Os
  42 analyzed.
  43
  44 The -I option directs btt to output iostat-like data to the specified
  45 file.  Refer to the iostat (sysstat) documentation for details on the
  46 data columns. The -S option specifies the interval to use between data
  47 output, it defaults to once per second.
  48
  49 The -l and -q options allow one to output per-IO D2C and Q2C latencies
  50 respectively. The supplied argument provides the basis for the output
  51 name for each device.
  52
  53 The -M option takes in a file generated by the provided script
  54 (gen_disk_info.py), and allows for better output of device names.
  55
  56 The -p option will generate a file that contains a list of all IO
  57 "sequences" - showing the parts of each IO (Q, A, I/M, D, & C).
  58
  59 The -s option instructs btt to output seek data, the argument provided
  60 is the basis for file names output. There are two files per device,
  61 read seeks and write seeks.
  62
  63 The -t/-T options allow one to set a start and/or end time for analyzing
  64 - analyzing will only be done for traces after -t's argument and before
  65 -T's argument. (-t and -T are optional, so if you specify just -t,
  66 analysis will occur for all traces after the time specified. Similarly,
  67 if only -T is specified, analysis stops after -T's seconds.)
  68
  69 Overview
  70 --------
  71
  72 btt will take in binary dump data from blkparse, and analyze the events,
  73 producing a series of output from the analysis. It will also build .dat
  74 files containing "range data" -- showing things like Q activity (periods
  75 of time while Q events are being produced), C activity (likewise for
  76 command completions), and etc.
  77
  78 Resources
  79 ---------
  80
  81 vger hosts a mailing list dedicated to btrace discussion and development.
  82 The list is called linux-btrace@vger.kernel.org, subscribe by sending
  83 a mail to majordomo@vger.kernel.org with 'subscribe linux-btrace' in
  84 the mail body.
  85
  86 2006-09_18, Alan D. Brunelle <alan.brunelle@hp.com>