Commit | Line | Data |
---|---|---|
ad787160 C |
1 | .\" Copyright (c) 1983, 1991, 1993 |
2 | .\" The Regents of the University of California. All rights reserved. | |
79be0566 | 3 | .\" |
ad787160 C |
4 | .\" Redistribution and use in source and binary forms, with or without |
5 | .\" modification, are permitted provided that the following conditions | |
6 | .\" are met: | |
7 | .\" 1. Redistributions of source code must retain the above copyright | |
8 | .\" notice, this list of conditions and the following disclaimer. | |
9 | .\" 2. Redistributions in binary form must reproduce the above copyright | |
10 | .\" notice, this list of conditions and the following disclaimer in the | |
11 | .\" documentation and/or other materials provided with the distribution. | |
12 | .\" 3. All advertising materials mentioning features or use of this software | |
13 | .\" must display the following acknowledgement: | |
14 | .\" This product includes software developed by the University of | |
15 | .\" California, Berkeley and its contributors. | |
16 | .\" 4. Neither the name of the University nor the names of its contributors | |
17 | .\" may be used to endorse or promote products derived from this software | |
18 | .\" without specific prior written permission. | |
79be0566 | 19 | .\" |
ad787160 C |
20 | .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND |
21 | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |
22 | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |
23 | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE | |
24 | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
25 | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |
26 | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
27 | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |
28 | .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |
29 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |
30 | .\" SUCH DAMAGE. | |
dbee94a9 | 31 | .\" |
ad787160 C |
32 | .\" @(#)trpt.8 8.1 (Berkeley) 6/6/93 |
33 | .\" | |
34 | .Dd June 6, 1993 | |
b42074ab CL |
35 | .Dt TRPT 8 |
36 | .Os BSD 4.2 | |
37 | .Sh NAME | |
38 | .Nm trpt | |
39 | .Nd transliterate protocol trace | |
40 | .Sh SYNOPSIS | |
41 | .Nm trpt | |
42 | .Op Fl a | |
43 | .Op Fl f | |
44 | .Op Fl j | |
45 | .Op Fl p Ar hex-address | |
46 | .Op Fl s | |
47 | .Op Fl t | |
48 | .Oo | |
49 | .Ar system Op Ar core | |
50 | .Oc | |
51 | .Sh DESCRIPTION | |
52 | .Nm Trpt | |
53 | interrogates the buffer of | |
54 | .Tn TCP | |
55 | trace records created | |
56 | when a socket is marked for | |
57 | .Dq debugging | |
58 | (see | |
59 | .Xr setsockopt 2 ) , | |
79be0566 KM |
60 | and prints a readable description of these records. |
61 | When no options are supplied, | |
b42074ab | 62 | .Nm trpt |
79be0566 | 63 | prints all the trace records found in the system |
b42074ab CL |
64 | grouped according to |
65 | .Tn TCP | |
66 | connection protocol control | |
67 | block | |
68 | .Pq Tn PCB . | |
69 | The following options may be used to | |
79be0566 | 70 | alter this behavior. |
b42074ab CL |
71 | .Bl -tag -width Ds |
72 | .It Fl a | |
73 | In addition to the normal output, | |
6e29ad7e MK |
74 | print the values of the source and destination |
75 | addresses for each packet recorded. | |
b42074ab CL |
76 | .It Fl f |
77 | Follow the trace as it occurs, waiting a short time for additional records | |
78 | each time the end of the log is reached. | |
79 | .It Fl j | |
80 | Just give a list of the protocol control block | |
81 | addresses for which there are trace records. | |
82 | .It Fl p | |
83 | Show only trace records associated with the protocol | |
84 | control block at the given address | |
85 | .Ar hex-address . | |
86 | .It Fl s | |
87 | In addition to the normal output, | |
79be0566 | 88 | print a detailed description of the packet |
6e29ad7e | 89 | sequencing information. |
b42074ab | 90 | .It Fl t |
79be0566 KM |
91 | in addition to the normal output, |
92 | print the values for all timers at each | |
6e29ad7e | 93 | point in the trace. |
b42074ab CL |
94 | .El |
95 | .Pp | |
79be0566 | 96 | The recommended use of |
b42074ab | 97 | .Nm trpt |
79be0566 KM |
98 | is as follows. |
99 | Isolate the problem and enable debugging on the | |
100 | socket(s) involved in the connection. | |
101 | Find the address of the protocol control blocks | |
102 | associated with the sockets using the | |
b42074ab | 103 | .Fl A |
79be0566 | 104 | option to |
b42074ab | 105 | .Xr netstat 1 . |
79be0566 | 106 | Then run |
b42074ab | 107 | .Nm trpt |
79be0566 | 108 | with the |
b42074ab | 109 | .Fl p |
79be0566 | 110 | option, supplying the associated |
6e29ad7e MK |
111 | protocol control block addresses. |
112 | The | |
b42074ab | 113 | .Fl f |
6e29ad7e MK |
114 | option can be used to follow the trace log once the trace is located. |
115 | If there are | |
79be0566 | 116 | many sockets using the debugging option, the |
b42074ab | 117 | .Fl j |
79be0566 KM |
118 | option may be useful in checking to see if |
119 | any trace records are present for the socket in | |
120 | question. | |
6e29ad7e | 121 | The |
b42074ab | 122 | .Pp |
79be0566 KM |
123 | If debugging is being performed on a system or |
124 | core file other than the default, the last two | |
125 | arguments may be used to supplant the defaults. | |
b42074ab CL |
126 | .Sh FILES |
127 | .Bl -tag -width /dev/kmem -compact | |
128 | .It Pa /vmunix | |
129 | .It Pa /dev/kmem | |
130 | .El | |
131 | .Sh SEE ALSO | |
132 | .Xr netstat 1 , | |
133 | .Xr setsockopt 2 , | |
134 | .Xr trsp 8 | |
135 | .Sh DIAGNOSTICS | |
136 | .Bl -tag -width Ds | |
137 | .It Sy no namelist | |
138 | When the system image doesn't | |
79be0566 KM |
139 | contain the proper symbols to find the trace buffer; |
140 | others which should be self explanatory. | |
b42074ab CL |
141 | .El |
142 | .Sh BUGS | |
79be0566 KM |
143 | Should also print the data for each input or output, |
144 | but this is not saved in the race record. | |
b42074ab | 145 | .Pp |
79be0566 KM |
146 | The output format is inscrutable and should be described |
147 | here. | |
b42074ab CL |
148 | .Sh HISTORY |
149 | The | |
150 | .Nm | |
151 | command appeared in | |
152 | .Bx 4.2 . |