xref: /aosp_15_r20/external/blktrace/btreplay/doc/abstract.tex (revision 1a3d31e37cc95e9919fd86900a2b6a555f55952c)
1*1a3d31e3SAndroid Build Coastguard Worker%
2*1a3d31e3SAndroid Build Coastguard Worker% Copyright (C) 2007 Alan D. Brunelle <[email protected]>
3*1a3d31e3SAndroid Build Coastguard Worker%
4*1a3d31e3SAndroid Build Coastguard Worker%  This program is free software; you can redistribute it and/or modify
5*1a3d31e3SAndroid Build Coastguard Worker%  it under the terms of the GNU General Public License as published by
6*1a3d31e3SAndroid Build Coastguard Worker%  the Free Software Foundation; either version 2 of the License, or
7*1a3d31e3SAndroid Build Coastguard Worker%  (at your option) any later version.
8*1a3d31e3SAndroid Build Coastguard Worker%
9*1a3d31e3SAndroid Build Coastguard Worker%  This program is distributed in the hope that it will be useful,
10*1a3d31e3SAndroid Build Coastguard Worker%  but WITHOUT ANY WARRANTY; without even the implied warranty of
11*1a3d31e3SAndroid Build Coastguard Worker%  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12*1a3d31e3SAndroid Build Coastguard Worker%  GNU General Public License for more details.
13*1a3d31e3SAndroid Build Coastguard Worker%
14*1a3d31e3SAndroid Build Coastguard Worker%  You should have received a copy of the GNU General Public License
15*1a3d31e3SAndroid Build Coastguard Worker%  along with this program; if not, write to the Free Software
16*1a3d31e3SAndroid Build Coastguard Worker%  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
17*1a3d31e3SAndroid Build Coastguard Worker%
18*1a3d31e3SAndroid Build Coastguard Worker%  vi :set textwidth=75
19*1a3d31e3SAndroid Build Coastguard Worker%
20*1a3d31e3SAndroid Build Coastguard WorkerThe \texttt{btrecord} and \texttt{btreplay} tools provide the ability to
21*1a3d31e3SAndroid Build Coastguard Workerrecord and replay IOs captured by the \texttt{blktrace} utility. Attempts
22*1a3d31e3SAndroid Build Coastguard Workerare made to maintain ordering, CPU mappings and time-separation of IOs. The
23*1a3d31e3SAndroid Build Coastguard Workergeneral workflow is expected to be:
24*1a3d31e3SAndroid Build Coastguard Worker
25*1a3d31e3SAndroid Build Coastguard Worker\begin{enumerate}
26*1a3d31e3SAndroid Build Coastguard Worker  \item Initiate \texttt{blktrace} to capture traces
27*1a3d31e3SAndroid Build Coastguard Worker  \item Generate traces\ldots
28*1a3d31e3SAndroid Build Coastguard Worker  \item Stop \texttt{blktrace}
29*1a3d31e3SAndroid Build Coastguard Worker  \item Run \texttt{btrecord} to convert traces into IO records
30*1a3d31e3SAndroid Build Coastguard Worker  \item Utilize \texttt{btreplay} to replay IOs
31*1a3d31e3SAndroid Build Coastguard Worker\end{enumerate}
32*1a3d31e3SAndroid Build Coastguard Worker
33*1a3d31e3SAndroid Build Coastguard WorkerThis document will discuss the operating characteristics of
34*1a3d31e3SAndroid Build Coastguard Worker\texttt{btreplay} and provide detailed command line option descriptions.
35