xref: /csrg-svn/usr.sbin/trpt/trpt.8 (revision 47470)
1*47470Scael.\" Copyright (c) 1983, 1991 The Regents of the University of California.
235587Sbostic.\" All rights reserved.
319020Smckusick.\"
443851Strent.\" %sccs.include.redist.man%
519020Smckusick.\"
6*47470Scael.\"     @(#)trpt.8	6.5 (Berkeley) 03/16/91
735587Sbostic.\"
8*47470Scael.Dd
9*47470Scael.Dt TRPT 8
10*47470Scael.Os BSD 4.2
11*47470Scael.Sh NAME
12*47470Scael.Nm trpt
13*47470Scael.Nd transliterate protocol trace
14*47470Scael.Sh SYNOPSIS
15*47470Scael.Nm trpt
16*47470Scael.Op Fl a
17*47470Scael.Op Fl f
18*47470Scael.Op Fl j
19*47470Scael.Op Fl p Ar hex-address
20*47470Scael.Op Fl s
21*47470Scael.Op Fl t
22*47470Scael.Oo
23*47470Scael.Ar system Op Ar core
24*47470Scael.Oc
25*47470Scael.Sh DESCRIPTION
26*47470Scael.Nm Trpt
27*47470Scaelinterrogates the buffer of
28*47470Scael.Tn TCP
29*47470Scaeltrace records created
30*47470Scaelwhen a socket is marked for
31*47470Scael.Dq debugging
32*47470Scael(see
33*47470Scael.Xr setsockopt 2 ) ,
3419020Smckusickand prints a readable description of these records.
3519020SmckusickWhen no options are supplied,
36*47470Scael.Nm trpt
3719020Smckusickprints all the trace records found in the system
38*47470Scaelgrouped according to
39*47470Scael.Tn TCP
40*47470Scaelconnection protocol control
41*47470Scaelblock
42*47470Scael.Pq Tn PCB .
43*47470ScaelThe following options may be used to
4419020Smckusickalter this behavior.
45*47470Scael.Bl -tag -width Ds
46*47470Scael.It Fl a
47*47470ScaelIn addition to the normal output,
4828798Skarelsprint the values of the source and destination
4928798Skarelsaddresses for each packet recorded.
50*47470Scael.It Fl f
51*47470ScaelFollow the trace as it occurs, waiting a short time for additional records
52*47470Scaeleach time the end of the log is reached.
53*47470Scael.It Fl j
54*47470ScaelJust give a list of the protocol control block
55*47470Scaeladdresses for which there are trace records.
56*47470Scael.It Fl p
57*47470ScaelShow only trace records associated with the protocol
58*47470Scaelcontrol block at the given address
59*47470Scael.Ar hex-address .
60*47470Scael.It Fl s
61*47470ScaelIn addition to the normal output,
6219020Smckusickprint a detailed description of the packet
6328798Skarelssequencing information.
64*47470Scael.It Fl t
6519020Smckusickin addition to the normal output,
6619020Smckusickprint the values for all timers at each
6728798Skarelspoint in the trace.
68*47470Scael.El
69*47470Scael.Pp
7019020SmckusickThe recommended use of
71*47470Scael.Nm trpt
7219020Smckusickis as follows.
7319020SmckusickIsolate the problem and enable debugging on the
7419020Smckusicksocket(s) involved in the connection.
7519020SmckusickFind the address of the protocol control blocks
7619020Smckusickassociated with the sockets using the
77*47470Scael.Fl A
7819020Smckusickoption to
79*47470Scael.Xr netstat 1 .
8019020SmckusickThen run
81*47470Scael.Nm trpt
8219020Smckusickwith the
83*47470Scael.Fl p
8419020Smckusickoption, supplying the associated
8528798Skarelsprotocol control block addresses.
8628798SkarelsThe
87*47470Scael.Fl f
8828798Skarelsoption can be used to follow the trace log once the trace is located.
8928798SkarelsIf there are
9019020Smckusickmany sockets using the debugging option, the
91*47470Scael.Fl j
9219020Smckusickoption may be useful in checking to see if
9319020Smckusickany trace records are present for the socket in
9419020Smckusickquestion.
9528798SkarelsThe
96*47470Scael.Pp
9719020SmckusickIf debugging is being performed on a system or
9819020Smckusickcore file other than the default, the last two
9919020Smckusickarguments may be used to supplant the defaults.
100*47470Scael.Sh FILES
101*47470Scael.Bl -tag -width /dev/kmem -compact
102*47470Scael.It Pa /vmunix
103*47470Scael.It Pa /dev/kmem
104*47470Scael.El
105*47470Scael.Sh SEE ALSO
106*47470Scael.Xr netstat 1 ,
107*47470Scael.Xr setsockopt 2 ,
108*47470Scael.Xr trsp 8
109*47470Scael.Sh DIAGNOSTICS
110*47470Scael.Bl -tag -width Ds
111*47470Scael.It Sy no namelist
112*47470ScaelWhen the system image doesn't
11319020Smckusickcontain the proper symbols to find the trace buffer;
11419020Smckusickothers which should be self explanatory.
115*47470Scael.El
116*47470Scael.Sh BUGS
11719020SmckusickShould also print the data for each input or output,
11819020Smckusickbut this is not saved in the race record.
119*47470Scael.Pp
12019020SmckusickThe output format is inscrutable and should be described
12119020Smckusickhere.
122*47470Scael.Sh HISTORY
123*47470ScaelThe
124*47470Scael.Nm
125*47470Scaelcommand appeared in
126*47470Scael.Bx 4.2 .
127