xref: /netbsd-src/usr.bin/shmif_dumpbus/shmif_dumpbus.1 (revision 2164f8a67dc04c1a8ef27f5a7c25bb96e1a5b7d7)
1*2164f8a6Swiz.\"	$NetBSD: shmif_dumpbus.1,v 1.2 2011/01/12 19:53:12 wiz Exp $
2fca51725Spooka.\"
3fca51725Spooka.\" Copyright (c) 2011 Antti Kantee.  All rights reserved.
4fca51725Spooka.\"
5fca51725Spooka.\" Redistribution and use in source and binary forms, with or without
6fca51725Spooka.\" modification, are permitted provided that the following conditions
7fca51725Spooka.\" are met:
8fca51725Spooka.\" 1. Redistributions of source code must retain the above copyright
9fca51725Spooka.\"    notice, this list of conditions and the following disclaimer.
10fca51725Spooka.\" 2. Redistributions in binary form must reproduce the above copyright
11fca51725Spooka.\"    notice, this list of conditions and the following disclaimer in the
12fca51725Spooka.\"    documentation and/or other materials provided with the distribution.
13fca51725Spooka.\"
14fca51725Spooka.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS "AS IS" AND
15fca51725Spooka.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16fca51725Spooka.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17fca51725Spooka.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18fca51725Spooka.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19fca51725Spooka.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20fca51725Spooka.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21fca51725Spooka.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22fca51725Spooka.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23fca51725Spooka.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
24fca51725Spooka.\" SUCH DAMAGE.
25fca51725Spooka.\"
26fca51725Spooka.Dd January 12, 2011
27fca51725Spooka.Dt SHMIF_DUMPBUS 1
28fca51725Spooka.Os
29fca51725Spooka.Sh NAME
30fca51725Spooka.Nm shmif_dumpbus
31fca51725Spooka.Nd examine shmif bus contents
32fca51725Spooka.Sh SYNOPSIS
33fca51725Spooka.Nm
34fca51725Spooka.Op Fl h
35fca51725Spooka.Op Fl p Ar pcapfile
36fca51725Spooka.Ar busfile
37fca51725Spooka.Sh DESCRIPTION
38fca51725SpookaThe
39fca51725Spooka.Nm
40fca51725Spookautility examines the bus of an
41fca51725Spooka.Xr shmif 4
42fca51725SpookaEthernet interface.
43fca51725SpookaThe most useful feature is converting the bus to the
44fca51725Spooka.Xr pcap 3
45fca51725Spookafile format for later examination.
46fca51725Spooka.Nm
47fca51725Spookaitself is limited to displaying only very basic information about
48fca51725Spookaeach frame.
49fca51725Spooka.Pp
50fca51725Spooka.Nm
51fca51725Spookaaccepts the following flags:
52fca51725Spooka.Bl -tag -width xxxpcapfilexxx
53fca51725Spooka.It Fl h
54fca51725SpookaPrint bus header only and skip contents.
55fca51725Spooka.It Fl p Ar pcapfile
56fca51725SpookaConvert bus contents to the
57fca51725Spooka.Xr pcap 3
58fca51725Spookaformat and write the result to
59fca51725Spooka.Ar pcapfile .
60fca51725SpookaThe file
61fca51725Spooka.Fl
62fca51725Spookasignifies stdout.
63fca51725Spooka.El
64fca51725Spooka.Sh EXAMPLES
65fca51725SpookaFeed the busfile contents to pcap:
66fca51725Spooka.Bd -literal -offset indent
67fca51725Spooka$ shmif_dumpbus -p - busfile | tcpdump -r -
68fca51725Spooka.Ed
69fca51725Spooka.Sh SEE ALSO
70fca51725Spooka.Xr pcap 3 ,
71*2164f8a6Swiz.Xr shmif 4 ,
72*2164f8a6Swiz.Xr tcpdump 8
73fca51725Spooka.Sh CAVEATS
74fca51725Spooka.Nm
75fca51725Spookadoes not lock the busfile and is best used for post-mortem analysis
76fca51725Spookaof the bus traffic.
77fca51725Spooka.Pp
78fca51725SpookaThe timestamp for each frame contains the sender's timestamp and
79fca51725Spookamay not be monotonically increasing with respect to the frame order
80fca51725Spookain the dump.
81