trpt.tproj/trpt.8

   1 .\" Copyright (c) 1983, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   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.
  19 .\"
  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.
  31 .\"
  32 .\"     @(#)trpt.8      8.2 (Berkeley) 12/11/93
  33 .\"
  34 .Dd December 11, 1993
  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 ) ,
  60 and prints a readable description of these records.
  61 When no options are supplied,
  62 .Nm trpt
  63 prints all the trace records found in the system
  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
  70 alter this behavior.
  71 .Bl -tag -width Ds
  72 .It Fl a
  73 In addition to the normal output,
  74 print the values of the source and destination
  75 addresses for each packet recorded.
  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,
  88 print a detailed description of the packet
  89 sequencing information.
  90 .It Fl t
  91 in addition to the normal output,
  92 print the values for all timers at each
  93 point in the trace.
  94 .El
  95 .Pp
  96 The recommended use of
  97 .Nm trpt
  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
 103 .Fl A
 104 option to
 105 .Xr netstat 1 .
 106 Then run
 107 .Nm trpt
 108 with the
 109 .Fl p
 110 option, supplying the associated
 111 protocol control block addresses.
 112 The
 113 .Fl f
 114 option can be used to follow the trace log once the trace is located.
 115 If there are
 116 many sockets using the debugging option, the
 117 .Fl j
 118 option may be useful in checking to see if
 119 any trace records are present for the socket in
 120 question.
 121 .Pp
 122 If debugging is being performed on a system or
 123 core file other than the default, the last two
 124 arguments may be used to supplant the defaults.
 125 .Sh FILES
 126 .Bl -tag -width /dev/kmem -compact
 127 .It Pa /vmunix
 128 .It Pa /dev/kmem
 129 .El
 130 .Sh SEE ALSO
 131 .Xr netstat 1 ,
 132 .Xr setsockopt 2 ,
 133 .Xr trsp 8
 134 .Sh DIAGNOSTICS
 135 .Bl -tag -width Ds
 136 .It Sy no namelist
 137 When the system image doesn't
 138 contain the proper symbols to find the trace buffer;
 139 others which should be self explanatory.
 140 .El
 141 .Sh BUGS
 142 Should also print the data for each input or output,
 143 but this is not saved in the race record.
 144 .Pp
 145 The output format is inscrutable and should be described
 146 here.
 147 .Sh HISTORY
 148 The
 149 .Nm
 150 command appeared in
 151 .Bx 4.2 .