--- /dev/null
+Content-type: text/html
+
+<HTML><HEAD><TITLE>Manpage of LKET-B2A</TITLE>
+</HEAD><BODY>
+<H1>LKET-B2A</H1>
+Section: User Commands (1)<BR>Updated: @DATE@<BR><A HREF="#index">Index</A>
+<A HREF="http://localhost/cgi-bin/man/man2html">Return to Main Contents</A><HR>
+
+<A NAME="lbAB"> </A>
+<H2>NAME</H2>
+
+lket-b2a - Converting and dumping utility for LKET binary trace data
+<P>
+
+
+
+<P>
+<A NAME="lbAC"> </A>
+<H2>SYNOPSIS</H2>
+
+<P>
+<BR>
+
+<B>lket-b2a</B>
+
+<I>OPTIONS</I>
+
+<I>IN_FILENAME</I>...
+
+<BR>
+
+<P>
+<A NAME="lbAD"> </A>
+<H2>DESCRIPTION</H2>
+
+<P>
+The trace data generated by
+<I>LKET </I>
+
+is in binary format by default for
+better performance and smaller size.
+<I>lket-b2a </I>
+
+is used to convert the
+binary trace data into readable data in ascii format and save
+them into local file or MySQL database for off-line trace analysis.
+It uses the per-cpu binary trace data files (stpd_cpu*) as inputs.
+You can use "stap -bM" with LKET to get those per-cpu files before using it.
+<P>
+The database used by
+<I>lket-b2a </I>
+
+is MySQL. So MySQL must be properly installed
+and configured in order to make
+<I>lket-b2a</I>
+
+able to dump the trace data into MySQL database.
+<P>
+<A NAME="lbAE"> </A>
+<H2>OPTIONS</H2>
+
+<I>lket-b2a </I>
+
+supports the following two options. They can be used
+together or alone but at least one of them should be specified:
+<P>
+<DL COMPACT>
+<DT><B>-m</B>
+
+<DD>
+convert and dump trace data into MySQL database. For more details,
+See the following section.
+<DT><B>-f</B>
+
+<DD>
+convert and dump trace data into local file. For more details,
+See the following section.
+<P>
+</DL>
+<A NAME="lbAF"> </A>
+<H2>DUMP TRACE DATA INTO LOCAL FILE</H2>
+
+<P>
+The generated output file is named
+<I>lket.out</I>.
+
+The following is an example:
+<P>
+
+<BR>
+
+<DL COMPACT><DT><DD>
+<PRE>
+root:/home/root/data> lket-b2a -f stpd_cpu*
+root:/home/root/data> cat lket.out
+LKET Magic: 0xAEFCDB6B
+InitHdrLen: 9
+Version Major: 1
+Version Minor: 1
+Big endian: YES
+Timing method: do_gettimeofday()
+Bits width: 64
+Initial CPU timebase: 187994 (cycles per microsecond)
+
+0.2084 APPNAME: (null) PID:20922 CPU:3 HOOKGRP:3 HOOKID:1 tid:20936,pid:20936,ppid:35,pname:systemtap/0,
+0.2086 APPNAME: (null) PID:20922 CPU:3 HOOKGRP:3 HOOKID:1 tid:20937,pid:20937,ppid:35,pname:systemtap/1,
+0.2087 APPNAME: (null) PID:20922 CPU:3 HOOKGRP:3 HOOKID:1 tid:20938,pid:20938,ppid:35,pname:systemtap/2,
+[...]
+10.24319 APPNAME: sshd PID:7203 CPU:3 HOOKGRP:2 HOOKID:2 syscall:write,
+10.24324 APPNAME: sshd PID:7203 CPU:3 HOOKGRP:2 HOOKID:1 syscall:compat_sys_select,
+[...]
+
+</PRE>
+
+</DL>
+
+
+<P>
+<A NAME="lbAG"> </A>
+<H2>DUMP TRACE DATA INTO MYSQL DATABASE</H2>
+
+<P>
+To avoid either reading the complete trace data into internal data
+structures to process, or filter through the raw trace data again
+and again to calculate the interesting metrics,
+<I>lket-b2a</I>
+
+supports convert and save the binary trace data into MySQL database to
+facilitate the query and calculation on the trace data.
+<P>
+<I>lket-b2a</I>
+
+creates the database name based on current time. And
+<I>lket-b2a </I>
+
+will not only save the trace data, but also some meta data into MySQL
+database too, such as trace header, trace table description.
+<P>
+The following is an example of navigating the trace data in MySQL database
+created by
+<I>lket-b2a</I>:
+
+<P>
+Use
+<I>lket-b2a</I>
+
+to convert and dump the binary trace data of
+<I>LKET</I>
+
+into MySQL database:
+<P>
+
+<BR>
+
+<DL COMPACT><DT><DD>
+<PRE>
+root:/home/root/data> lket-b2a -m stpd_cpu*
+
+</PRE>
+
+</DL>
+
+
+<P>
+list all databases in MySQL:
+<P>
+
+<BR>
+
+<DL COMPACT><DT><DD>
+<PRE>
+mysql> show databases;
++------------------+
+| Database |
++------------------+
+| DB20061023161626 |
+| mysql |
+| test |
++------------------+
+3 rows in set (0.00 sec)
+
+</PRE>
+
+</DL>
+
+
+<P>
+DB20061023161626 is the newly created database by "lket-b2a -m stpd_cpu*". We can list
+all the tables contained in DB20061023161626:
+<P>
+
+<BR>
+
+<DL COMPACT><DT><DD>
+<PRE>
+mysql> use DB20061023161626
+Database changed
+mysql> show tables;
++----------------------------+
+| Tables_in_DB20061023161626 |
++----------------------------+
+| 2_1 |
+| 2_2 |
+| 3_1 |
+| 3_3 |
+| 3_5 |
+| 4_1 |
+| 4_3 |
+| 4_4 |
+| 8_1 |
+| 8_3 |
+| appNameMap |
+| table_desc |
+| trace_header |
++----------------------------+
+13 rows in set (0.00 sec)
+
+</PRE>
+
+</DL>
+
+
+<P>
+The table trace_header is used to store the trace header info:
+<P>
+
+<BR>
+
+<DL COMPACT><DT><DD>
+<PRE>
+mysql> select * from trace_header;
++-----------+-----------+------------+-----------------+------------+
+| Major_Ver | Minor_Ver | Big_Endian | Timing_Method | Bits_Width |
++-----------+-----------+------------+-----------------+------------+
+| 1 | 1 | 2 | do_gettimeofday | 64 |
++-----------+-----------+------------+-----------------+------------+
+1 row in set (0.00 sec)
+
+</PRE>
+
+</DL>
+
+
+<P>
+The table appNameMap is used to store the mapping between PID and process name:
+<P>
+
+<BR>
+
+<DL COMPACT><DT><DD>
+<PRE>
+mysql> select * from appNameMap;
++-------+-----------------+
+| pid | pname |
++-------+-----------------+
+| 10764 | systemtap/0 |
+| 10765 | systemtap/1 |
+| 10766 | systemtap/2 |
+| 10767 | systemtap/3 |
+| 10768 | systemtap/4 |
+| 10769 | systemtap/5 |
+| 10770 | systemtap/6 |
+| 10771 | systemtap/7 |
+| 0 | swapper |
+| 1 | init |
+| 2 | migration/0 |
+| 3 | ksoftirqd/0 |
+| 4 | watchdog/0 |
+| 5 | migration/1 |
+[...]
+
+</PRE>
+
+</DL>
+
+
+<P>
+Each event corresponds to one table which is named as groupid_hookid. For example
+table 8_1 corresponds to
+<I>addevent.netdev.receive </I>
+
+whose groupid is 8 and hookid is 1:
+<P>
+
+<BR>
+
+<DL COMPACT><DT><DD>
+<PRE>
+mysql> select * from table_desc;
++------------+----------------------------------+
+| table_name | table_desc |
++------------+----------------------------------+
+| 2_1 | addevent.syscall.entry |
+| 2_2 | addevent.syscall.return |
+| 3_1 | process_snapshot |
+| 3_3 | addevent.process.execve |
+| 3_5 | addevent.process.fork |
+| 4_3 | addevent.ioscheduler.elv_next_re |
+| 4_4 | addevent.ioscheduler.elv_next_re |
+| 4_1 | addevent.ioscheduler.elv_add_req |
+| 8_1 | addevent.netdev.receive |
+| 8_3 | addevent.netdev.transmit |
++------------+----------------------------------+
+10 rows in set (0.00 sec)
+
+</PRE>
+
+</DL>
+
+
+<P>
+The hookid of a return type event(
+<I>addevent.*.return</I>
+
+) should be an
+even number and its value should be the corresponding entry event hookid +1.
+For example, the hookid of addevent.syscall.return is 2 and the hookid of
+addevent.syscall.entry is 1. And what's more, there will be a new column
+named
+<I>entry_usec </I>
+
+for all return type event tables which is the timestamp
+of the entry of that event. The column
+<I>entry_usec</I>
+
+is created and calculated by lket-b2a on the fly while processing the binary trace data.
+<P>
+
+<BR>
+
+<DL COMPACT><DT><DD>
+<PRE>
+mysql> select * from 2_1 limit 4;
++---------+--------+--------+------------+--------+--------------+
+| groupid | hookid | usec | process_id | cpu_id | syscall |
++---------+--------+--------+------------+--------+--------------+
+| 2 | 1 | 10727 | 20922 | 2 | read |
+| 2 | 1 | 10746 | 20922 | 2 | read |
+| 2 | 1 | 729066 | 3605 | 5 | gettimeofday |
+| 2 | 1 | 729086 | 3605 | 5 | gettimeofday |
++---------+--------+--------+------------+--------+--------------+
+4 rows in set (0.00 sec)
+
+mysql> select * from 2_2 limit 4;
++---------+--------+--------+------------+--------+------------+--------------+
+| groupid | hookid | usec | process_id | cpu_id | entry_usec | syscall |
++---------+--------+--------+------------+--------+------------+--------------+
+| 2 | 2 | 10742 | 20922 | 2 | 10727 | read |
+| 2 | 2 | 729072 | 3605 | 5 | 729066 | gettimeofday |
+| 2 | 2 | 729089 | 3605 | 5 | 729086 | gettimeofday |
+| 2 | 2 | 729100 | 3605 | 5 | 729096 | poll |
++---------+--------+--------+------------+--------+------------+--------------+
+4 rows in set (0.00 sec)
+
+</PRE>
+
+</DL>
+
+
+<P>
+<A NAME="lbAH"> </A>
+<H2>SEE ALSO</H2>
+
+<I><A HREF="http://localhost/cgi-bin/man/man2html?1+stap">stap</A></I>(1),
+
+<I><A HREF="http://localhost/cgi-bin/man/man2html?5+lket">lket</A></I>(5)
+
+<P>
+
+<HR>
+<A NAME="index"> </A><H2>Index</H2>
+<DL>
+<DT><A HREF="#lbAB">NAME</A><DD>
+<DT><A HREF="#lbAC">SYNOPSIS</A><DD>
+<DT><A HREF="#lbAD">DESCRIPTION</A><DD>
+<DT><A HREF="#lbAE">OPTIONS</A><DD>
+<DT><A HREF="#lbAF">DUMP TRACE DATA INTO LOCAL FILE</A><DD>
+<DT><A HREF="#lbAG">DUMP TRACE DATA INTO MYSQL DATABASE</A><DD>
+<DT><A HREF="#lbAH">SEE ALSO</A><DD>
+</DL>
+<HR>
+This document was created by
+<A HREF="http://localhost/cgi-bin/man/man2html">man2html</A>,
+using the manual pages.<BR>
+Time: 07:50:26 GMT, October 24, 2006
+</BODY>
+</HTML>
git://sourceware.org / systemtap-htdocs.git / commitdiff