virt-mem.1

   1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
   2 .\"
   3 .\" Standard preamble:
   4 .\" ========================================================================
   5 .de Sh \" Subsection heading
   6 .br
   7 .if t .Sp
   8 .ne 5
   9 .PP
  10 \fB\\$1\fR
  11 .PP
  12 ..
  13 .de Sp \" Vertical space (when we can't use .PP)
  14 .if t .sp .5v
  15 .if n .sp
  16 ..
  17 .de Vb \" Begin verbatim text
  18 .ft CW
  19 .nf
  20 .ne \\$1
  21 ..
  22 .de Ve \" End verbatim text
  23 .ft R
  24 .fi
  25 ..
  26 .\" Set up some character translations and predefined strings.  \*(-- will
  27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
  28 .\" double quote, and \*(R" will give a right double quote.  | will give a
  29 .\" real vertical bar.  \*(C+ will give a nicer C++.  Capital omega is used to
  30 .\" do unbreakable dashes and therefore won't be available.  \*(C` and \*(C'
  31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
  32 .tr \(*W-|\(bv\*(Tr
  33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
  34 .ie n \{\
  35 .    ds -- \(*W-
  36 .    ds PI pi
  37 .    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
  38 .    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
  39 .    ds L" ""
  40 .    ds R" ""
  41 .    ds C` ""
  42 .    ds C' ""
  43 'br\}
  44 .el\{\
  45 .    ds -- \|\(em\|
  46 .    ds PI \(*p
  47 .    ds L" ``
  48 .    ds R" ''
  49 'br\}
  50 .\"
  51 .\" If the F register is turned on, we'll generate index entries on stderr for
  52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
  53 .\" entries marked with X<> in POD.  Of course, you'll have to process the
  54 .\" output yourself in some meaningful fashion.
  55 .if \nF \{\
  56 .    de IX
  57 .    tm Index:\\$1\t\\n%\t"\\$2"
  58 ..
  59 .    nr % 0
  60 .    rr F
  61 .\}
  62 .\"
  63 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
  64 .\" way too many mistakes in technical documents.
  65 .hy 0
  66 .if n .na
  67 .\"
  68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
  69 .\" Fear.  Run.  Save yourself.  No user-serviceable parts.
  70 .    \" fudge factors for nroff and troff
  71 .if n \{\
  72 .    ds #H 0
  73 .    ds #V .8m
  74 .    ds #F .3m
  75 .    ds #[ \f1
  76 .    ds #] \fP
  77 .\}
  78 .if t \{\
  79 .    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
  80 .    ds #V .6m
  81 .    ds #F 0
  82 .    ds #[ \&
  83 .    ds #] \&
  84 .\}
  85 .    \" simple accents for nroff and troff
  86 .if n \{\
  87 .    ds ' \&
  88 .    ds ` \&
  89 .    ds ^ \&
  90 .    ds , \&
  91 .    ds ~ ~
  92 .    ds /
  93 .\}
  94 .if t \{\
  95 .    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
  96 .    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
  97 .    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
  98 .    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
  99 .    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
 100 .    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
 101 .\}
 102 .    \" troff and (daisy-wheel) nroff accents
 103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
 104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
 105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
 106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
 107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
 108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
 109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
 110 .ds ae a\h'-(\w'a'u*4/10)'e
 111 .ds Ae A\h'-(\w'A'u*4/10)'E
 112 .    \" corrections for vroff
 113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
 114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
 115 .    \" for low resolution devices (crt and lpr)
 116 .if \n(.H>23 .if \n(.V>19 \
 117 \{\
 118 .    ds : e
 119 .    ds 8 ss
 120 .    ds o a
 121 .    ds d- d\h'-1'\(ga
 122 .    ds D- D\h'-1'\(hy
 123 .    ds th \o'bp'
 124 .    ds Th \o'LP'
 125 .    ds ae ae
 126 .    ds Ae AE
 127 .\}
 128 .rm #[ #] #H #V #F C
 129 .\" ========================================================================
 130 .\"
 131 .IX Title "VIRT-MEM 1"
 132 .TH VIRT-MEM 1 "2008-06-10" "virt-mem-0.2.1" "Virtualization Support"
 133 .SH "NAME"
 134 virt\-uname \- system information for virtual machines
 135 .PP
 136 virt\-dmesg \- print kernel messages for virtual machines
 137 .SH "SUMMARY"
 138 .IX Header "SUMMARY"
 139 virt-uname [\-options] [domains...]
 140 .PP
 141 virt-dmesg [\-options] [domains...]
 142 .SH "DESCRIPTION"
 143 .IX Header "DESCRIPTION"
 144 These virtualization tools allow you to inspect the status of
 145 virtual machines running Linux.
 146 .PP
 147 The tools all use libvirt so are capable of showing stats across a
 148 variety of different virtualization systems.
 149 .SH "COMMON OPTIONS"
 150 .IX Header "COMMON OPTIONS"
 151 .IP "\fB\-c uri\fR, \fB\-\-connect uri\fR" 4
 152 .IX Item "-c uri, --connect uri"
 153 Connect to libvirt \s-1URI\s0.  The default is to connect to the default
 154 libvirt \s-1URI\s0, normally Xen.
 155 .IP "\fB\-\-csv\fR" 4
 156 .IX Item "--csv"
 157 Print the results in \s-1CSV\s0 format, suitable for importing into a
 158 spreadsheet or database.
 159 .Sp
 160 This option is only supported if virt-mem was built with \s-1CSV\s0 support.
 161 .IP "\fB\-\-debug\fR" 4
 162 .IX Item "--debug"
 163 Emit debugging information on stderr.  Please supply this if you
 164 report a bug.
 165 .IP "\fB\-\-help\fR" 4
 166 .IX Item "--help"
 167 Display usage summary.
 168 .IP "\fB\-t memoryimage\fR" 4
 169 .IX Item "-t memoryimage"
 170 Test mode.  Instead of checking libvirt for domain information, this
 171 runs the virt-mem tool directly on the memory image supplied.  You may
 172 specify the \fB\-t\fR option multiple times.
 173 .IP "\fB\-\-version\fR" 4
 174 .IX Item "--version"
 175 Display version and exit.
 176 .IP "\fB\-E auto|littleendian|bigendian\fR" 4
 177 .IX Item "-E auto|littleendian|bigendian"
 178 .PD 0
 179 .IP "\fB\-T auto|i386|x86\-64|\f(BIaddress\fB\fR" 4
 180 .IX Item "-T auto|i386|x86-64|address"
 181 .IP "\fB\-W auto|32|64\fR" 4
 182 .IX Item "-W auto|32|64"
 183 .PD
 184 These options force the endianness, text address, and word size for
 185 the subsequent domains listed on the command line (or if no domains
 186 are listed, then for all domains).
 187 .Sp
 188 These default to \fIauto\fR which tries to do automatic detection (using
 189 libvirt, or details from the memory images themselves).  You only need
 190 to use these options if virt-mem tools get the automatic detection
 191 wrong.
 192 .Sp
 193 Endianness (\fI\-E\fR) sets the memory endianness, for data, pointers and
 194 so on.
 195 .Sp
 196 Text address (\fI\-T\fR) sets the base address of the kernel image.  \fI\-T
 197 i386\fR means to try some common addresses for i386\-based kernels.  \fI\-T
 198 x86\-64\fR means to try some common addresses for x86\-64\-based kernels.
 199 \&\fI\-T \fIaddress\fI\fR sets the address specifically (\fI0x\fR prefix is
 200 allowed to specify hex addresses).
 201 .Sp
 202 Word size (\fI\-W\fR) sets the word size, 32 or 64 bits.
 203 .IP "\fB\-A auto|i386|x86\-64|...\fR" 4
 204 .IX Item "-A auto|i386|x86-64|..."
 205 This option sets the architecture to one of a collection of known
 206 architectures.  It is equivalent to setting endianness and wordsize in
 207 one go, but not text address.
 208 .SH "EXAMPLES"
 209 .IX Header "EXAMPLES"
 210 .Vb 3
 211 \& # virt-uname
 212 \& f9x32kvm: Linux localhost.localdomain 2.6.24-0.155.rc7.git6.fc9 #1
 213 \& SMP Tue Jan 15 17:52:31 EST 2008 i686 (none)
 214 .Ve
 215 .PP
 216 .Vb 11
 217 \& # virt-dmesg f9x32kvm | tail
 218 \& <6>Bluetooth: Core ver 2.11
 219 \& <6>NET: Registered protocol family 31
 220 \& <6>Bluetooth: HCI device and connection manager initialized
 221 \& <6>Bluetooth: HCI socket layer initialized
 222 \& <6>Bluetooth: L2CAP ver 2.9
 223 \& <6>Bluetooth: L2CAP socket layer initialized
 224 \& <6>Bluetooth: RFCOMM socket layer initialized
 225 \& <6>Bluetooth: RFCOMM TTY layer initialized
 226 \& <6>Bluetooth: RFCOMM ver 1.8
 227 \& <7>eth0: no IPv6 routers present
 228 .Ve
 229 .SH "SHORTCOMINGS"
 230 .IX Header "SHORTCOMINGS"
 231 The virt-mem tools spy on the guest's memory image.  There are some
 232 shortcomings to this, described here.
 233 .PP
 234 (1) Only works on specific, tested releases of Linux kernels.  Support
 235 for arbitrary Linux kernel versions may be patchy because of changes
 236 in the internal structures used.  Support for non-Linux kernels is
 237 currently non\-existent, and probably impossible for Windows because of
 238 lack of an acceptable source license.
 239 .PP
 240 (2) Heuristics are used which may mean in the worst case that the
 241 output is wrong.
 242 .PP
 243 (3) Structures which are frequently modified may cause errors.  This
 244 could be a problem if, for example, the process table in the guest is
 245 being rapidly updated.
 246 .PP
 247 (4) We have to scan memory to find kernel symbols, etc., which can be
 248 quite slow.  Optimizing the memory scanner would help, and caching the
 249 base address of the symbol table(s) would make it dramatically faster.
 250 .SH "SECURITY"
 251 .IX Header "SECURITY"
 252 The current code tries hard to be secure against malicious guests, for
 253 example guests which set up malicious kernel memory.
 254 .SH "SEE ALSO"
 255 .IX Header "SEE ALSO"
 256 \&\fIuname\fR\|(1),\fIdmesg\fR\|(1),
 257 \&\fIvirsh\fR\|(1),
 258 \&\fIxm\fR\|(1),
 259 <http://www.libvirt.org/ocaml/>,
 260 <http://www.libvirt.org/>,
 261 <http://et.redhat.com/~rjones/>,
 262 <http://caml.inria.fr/>
 263 .SH "AUTHORS"
 264 .IX Header "AUTHORS"
 265 Richard W.M. Jones <rjones @ redhat . com>
 266 .SH "COPYRIGHT"
 267 .IX Header "COPYRIGHT"
 268 (C) Copyright 2008 Red Hat Inc., Richard W.M. Jones
 269 http://libvirt.org/
 270 .PP
 271 This program is free software; you can redistribute it and/or modify
 272 it under the terms of the \s-1GNU\s0 General Public License as published by
 273 the Free Software Foundation; either version 2 of the License, or
 274 (at your option) any later version.
 275 .PP
 276 This program is distributed in the hope that it will be useful,
 277 but \s-1WITHOUT\s0 \s-1ANY\s0 \s-1WARRANTY\s0; without even the implied warranty of
 278 \&\s-1MERCHANTABILITY\s0 or \s-1FITNESS\s0 \s-1FOR\s0 A \s-1PARTICULAR\s0 \s-1PURPOSE\s0.  See the
 279 \&\s-1GNU\s0 General Public License for more details.
 280 .PP
 281 You should have received a copy of the \s-1GNU\s0 General Public License
 282 along with this program; if not, write to the Free Software
 283 Foundation, Inc., 675 Mass Ave, Cambridge, \s-1MA\s0 02139, \s-1USA\s0.
 284 .SH "REPORTING BUGS"
 285 .IX Header "REPORTING BUGS"
 286 Bugs can be viewed on the Red Hat Bugzilla page:
 287 <https://bugzilla.redhat.com/>.
 288 .PP
 289 If you find a bug in virt\-mem, please follow these steps to report it:
 290 .IP "1. Check for existing bug reports" 4
 291 .IX Item "1. Check for existing bug reports"
 292 Go to <https://bugzilla.redhat.com/> and search for similar bugs.
 293 Someone may already have reported the same bug, and they may even
 294 have fixed it.
 295 .IP "2. Capture debug and error messages" 4
 296 .IX Item "2. Capture debug and error messages"
 297 Run
 298 .Sp
 299 .Vb 1
 300 \& virt-[program] --debug > virt-mem.log 2>&1
 301 .Ve
 302 .Sp
 303 and keep \fIvirt\-mem.log\fR.  It contains error messages which you should
 304 submit with your bug report.
 305 .IP "3. Get version of virt-mem and version of libvirt." 4
 306 .IX Item "3. Get version of virt-mem and version of libvirt."
 307 Run
 308 .Sp
 309 .Vb 1
 310 \& virt-[program] --version
 311 .Ve
 312 .IP "4. Submit a bug report." 4
 313 .IX Item "4. Submit a bug report."
 314 Go to <https://bugzilla.redhat.com/> and enter a new bug.
 315 Please describe the problem in as much detail as possible.
 316 .Sp
 317 Remember to include the version numbers (step 3) and the debug
 318 messages file (step 2).
 319 .IP "5. Assign the bug to rjones @ redhat.com" 4
 320 .IX Item "5. Assign the bug to rjones @ redhat.com"
 321 Assign or reassign the bug to \fBrjones @ redhat.com\fR (without the
 322 spaces).  You can also send me an email with the bug number if you
 323 want a faster response.