share/man/man4/vinumdebug.4

   1 .\" Copyright (c) 2003 Greg Lehey
   2 .\" 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 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  16 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  23 .\" SUCH DAMAGE.
  24 .\"
  25 .\" $FreeBSD$
  26 .\"
  27 .Dd December 30, 2003
  28 .Dt VINUMDEBUG 4
  29 .Os
  30 .Sh NAME
  31 .Nm vinumdebug
  32 .Nd debug macros for
  33 .Xr vinum 4
  34 .Sh DESCRIPTION
  35 This man page describes
  36 .Xr gdb 4
  37 macros for debugging the
  38 .Xr vinum 4
  39 kernel module.
  40 See
  41 .Xr gdb 4
  42 for the description of the kernel debugging environment.
  43 No further action is required to access the
  44 .Xr vinum 4
  45 debug macros.
  46 They are loaded automatically along with the other macros.
  47 .Sh COMMANDS
  48 .Bl -tag -width ".Ic rrqe Ar rqe"
  49 .It Ic finfo
  50 Show recently freed
  51 .Xr vinum 4
  52 memory blocks.
  53 .It Ic meminfo
  54 Equivalent of the
  55 .Nm vinum Ic info Fl v
  56 command.
  57 .It Ic rq
  58 Show information about the request pointed to by the variable
  59 .Va rq
  60 in the current frame.
  61 .It Ic rqe
  62 Show information about the request element pointed to by the variable
  63 .Va rqe
  64 in the current frame.
  65 .It Ic rqi
  66 Print out a simplified version of the same information as the
  67 .Nm vinum Ic info Fl V
  68 command.
  69 .It Ic rqinfo
  70 Show the
  71 .Xr vinum 4
  72 request log buffer like the
  73 .Nm vinum Ic info Fl V
  74 command.
  75 .It Ic rqq Ar rq
  76 Show information about the request
  77 .Pq Vt "struct rq"
  78 pointed at by
  79 .Ar rq .
  80 .It Ic rqq0
  81 Print information on some
  82 .Xr vinum 4
  83 request structures.
  84 .It Ic rqq1
  85 Print information on some
  86 .Xr vinum 4
  87 request structures.
  88 .It Ic rrqe Ar rqe
  89 Show information about the request element
  90 .Pq Vt "struct rqe"
  91 pointed at by the parameter
  92 .Ar rqe .
  93 .El
  94 .Sh AUTHORS
  95 This man page was written by
  96 .An "Greg Lehey" Aq grog@FreeBSD.org .
  97 .Sh SEE ALSO
  98 .Xr gdb 4 ,
  99 .Xr vinum 4 ,
 100 .Xr vinum 8