| 1 | <?xml version="1.0" encoding="UTF-8"?>
|
|---|
| 2 | <!--
|
|---|
| 3 | manpage, user manual, usage: VBoxManage debugvm
|
|---|
| 4 |
|
|---|
| 5 | Copyright (C) 2006-2015 Oracle Corporation
|
|---|
| 6 |
|
|---|
| 7 | This file is part of VirtualBox Open Source Edition (OSE), as
|
|---|
| 8 | available from http://www.virtualbox.org. This file is free software;
|
|---|
| 9 | you can redistribute it and/or modify it under the terms of the GNU
|
|---|
| 10 | General Public License (GPL) as published by the Free Software
|
|---|
| 11 | Foundation, in version 2 as it comes in the "COPYING" file of the
|
|---|
| 12 | VirtualBox OSE distribution. VirtualBox OSE is distributed in the
|
|---|
| 13 | hope that it will be useful, but WITHOUT ANY WARRANTY of any kind.
|
|---|
| 14 | -->
|
|---|
| 15 | <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd">
|
|---|
| 16 | <refentry id="vboxmanage-debugvm" lang="en">
|
|---|
| 17 |
|
|---|
| 18 | <refentryinfo>
|
|---|
| 19 | <pubdate>$Date: 2015-06-19 23:25:00 +0000 (Fri, 19 Jun 2015) $</pubdate>
|
|---|
| 20 | <title>VBoxManage debugvm</title>
|
|---|
| 21 | </refentryinfo>
|
|---|
| 22 |
|
|---|
| 23 | <refmeta>
|
|---|
| 24 | <refentrytitle>VBoxManage-debugvm</refentrytitle>
|
|---|
| 25 | <manvolnum>1</manvolnum>
|
|---|
| 26 | </refmeta>
|
|---|
| 27 |
|
|---|
| 28 | <refnamediv>
|
|---|
| 29 | <refname>VBoxManage-debugvm</refname>
|
|---|
| 30 | <refpurpose>introspection and guest debugging</refpurpose>
|
|---|
| 31 | <refclass>Oracle VM VirtualBox</refclass>
|
|---|
| 32 | </refnamediv>
|
|---|
| 33 |
|
|---|
| 34 | <refsynopsisdiv>
|
|---|
| 35 | <cmdsynopsis id="synopsis-vboxmanage-debugvm-dumpvmcore">
|
|---|
| 36 | <command>VBoxManage debugvm</command>
|
|---|
| 37 | <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
|
|---|
| 38 | <arg choice="plain">dumpvmcore</arg>
|
|---|
| 39 | <arg>--filename <replaceable>name</replaceable></arg>
|
|---|
| 40 | </cmdsynopsis>
|
|---|
| 41 | <cmdsynopsis id="synopsis-vboxmanage-debugvm-info">
|
|---|
| 42 | <command>VBoxManage debugvm</command>
|
|---|
| 43 | <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
|
|---|
| 44 | <arg choice="plain">info</arg>
|
|---|
| 45 | <arg choice="req"><replaceable>item</replaceable></arg>
|
|---|
| 46 | <arg rep="repeat"><replaceable>args</replaceable></arg>
|
|---|
| 47 | </cmdsynopsis>
|
|---|
| 48 | <cmdsynopsis id="synopsis-vboxmanage-debugvm-injectnmi">
|
|---|
| 49 | <command>VBoxManage debugvm</command>
|
|---|
| 50 | <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
|
|---|
| 51 | <arg choice="plain">injectnmi</arg>
|
|---|
| 52 | </cmdsynopsis>
|
|---|
| 53 | <cmdsynopsis id="synopsis-vboxmanage-debugvm-log">
|
|---|
| 54 | <command>VBoxManage debugvm</command>
|
|---|
| 55 | <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
|
|---|
| 56 | <arg choice="plain">log</arg>
|
|---|
| 57 | <group><arg>--release</arg><arg>--debug</arg></group>
|
|---|
| 58 | <arg rep="repeat"><replaceable>group-settings</replaceable></arg>
|
|---|
| 59 | </cmdsynopsis>
|
|---|
| 60 | <cmdsynopsis id="synopsis-vboxmanage-debugvm-logdest">
|
|---|
| 61 | <command>VBoxManage debugvm</command>
|
|---|
| 62 | <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
|
|---|
| 63 | <arg choice="plain">logdest</arg>
|
|---|
| 64 | <group><arg>--release</arg><arg>--debug</arg></group>
|
|---|
| 65 | <arg rep="repeat"><replaceable>destinations</replaceable></arg>
|
|---|
| 66 | </cmdsynopsis>
|
|---|
| 67 | <cmdsynopsis id="synopsis-vboxmanage-debugvm-logflags">
|
|---|
| 68 | <command>VBoxManage debugvm</command>
|
|---|
| 69 | <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
|
|---|
| 70 | <arg choice="plain">logflags</arg>
|
|---|
| 71 | <group><arg>--release</arg><arg>--debug</arg></group>
|
|---|
| 72 | <arg rep="repeat"><replaceable>flags</replaceable></arg>
|
|---|
| 73 | </cmdsynopsis>
|
|---|
| 74 | <cmdsynopsis id="synopsis-vboxmanage-debugvm-osdetect">
|
|---|
| 75 | <command>VBoxManage debugvm</command>
|
|---|
| 76 | <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
|
|---|
| 77 | <arg choice="plain">osdetect</arg>
|
|---|
| 78 | </cmdsynopsis>
|
|---|
| 79 | <cmdsynopsis id="synopsis-vboxmanage-debugvm-osinfo">
|
|---|
| 80 | <command>VBoxManage debugvm</command>
|
|---|
| 81 | <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
|
|---|
| 82 | <arg choice="plain">osinfo</arg>
|
|---|
| 83 | </cmdsynopsis>
|
|---|
| 84 | <cmdsynopsis id="synopsis-vboxmanage-debugvm-osdmesg">
|
|---|
| 85 | <command>VBoxManage debugvm</command>
|
|---|
| 86 | <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
|
|---|
| 87 | <arg choice="plain">osdmesg</arg>
|
|---|
| 88 | <arg>--lines <replaceable>lines</replaceable></arg>
|
|---|
| 89 | </cmdsynopsis>
|
|---|
| 90 | <cmdsynopsis id="synopsis-vboxmanage-debugvm-getregisters">
|
|---|
| 91 | <command>VBoxManage debugvm</command>
|
|---|
| 92 | <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
|
|---|
| 93 | <arg choice="plain">getregisters</arg>
|
|---|
| 94 | <arg>--cpu <replaceable>id</replaceable></arg>
|
|---|
| 95 | <arg rep="repeat"><replaceable>reg-set.reg-name</replaceable></arg>
|
|---|
| 96 | </cmdsynopsis>
|
|---|
| 97 | <cmdsynopsis id="synopsis-vboxmanage-debugvm-setregisters">
|
|---|
| 98 | <command>VBoxManage debugvm</command>
|
|---|
| 99 | <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
|
|---|
| 100 | <arg choice="plain">setregisters</arg>
|
|---|
| 101 | <arg>--cpu <replaceable>id</replaceable></arg>
|
|---|
| 102 | <arg rep="repeat"><replaceable>reg-set.reg-name=value</replaceable></arg>
|
|---|
| 103 | </cmdsynopsis>
|
|---|
| 104 | <cmdsynopsis id="synopsis-vboxmanage-debugvm-show">
|
|---|
| 105 | <command>VBoxManage debugvm</command>
|
|---|
| 106 | <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
|
|---|
| 107 | <arg choice="plain">show</arg>
|
|---|
| 108 | <group><arg>--human-readable</arg><arg>--sh-export</arg><arg>--sh-eval</arg><arg>--cmd-set</arg></group>
|
|---|
| 109 | <arg rep="repeat"><replaceable>settings-item</replaceable></arg>
|
|---|
| 110 | </cmdsynopsis>
|
|---|
| 111 | <cmdsynopsis id="synopsis-vboxmanage-debugvm-statistics">
|
|---|
| 112 | <command>VBoxManage debugvm</command>
|
|---|
| 113 | <arg choice="req"><replaceable>uuid|vmname</replaceable></arg>
|
|---|
| 114 | <arg choice="plain">statistics</arg>
|
|---|
| 115 | <arg>--reset</arg>
|
|---|
| 116 | <arg>--descriptions</arg>
|
|---|
| 117 | <arg>--pattern <replaceable>pattern</replaceable></arg>
|
|---|
| 118 | </cmdsynopsis>
|
|---|
| 119 | </refsynopsisdiv>
|
|---|
| 120 | <refsect1>
|
|---|
| 121 | <title>Description</title>
|
|---|
| 122 |
|
|---|
| 123 | <para>The "debugvm" commands are for experts who want to tinker with the
|
|---|
| 124 | exact details of virtual machine execution. Like the VM debugger<remark role="help-manual">
|
|---|
| 125 | described in <xref linkend="ts_debugger" /></remark>, these commands are only useful if you are
|
|---|
| 126 | very familiar with the details of the PC architecture and how to debug
|
|---|
| 127 | software.</para>
|
|---|
| 128 |
|
|---|
| 129 | <refsect2 id="vboxmanage-debugvm-common-options">
|
|---|
| 130 | <title>Common options</title>
|
|---|
| 131 | <remark role="help-scope" condition="GLOBAL"/>
|
|---|
| 132 | <para>The subcommands of <command>debugvm</command> all operate on a running virtual
|
|---|
| 133 | machine:</para>
|
|---|
| 134 | <variablelist>
|
|---|
| 135 | <varlistentry>
|
|---|
| 136 | <term><replaceable>uuid|vmname</replaceable></term>
|
|---|
| 137 | <listitem><para>Either the UUID or the name (case sensitive) of a VM.</para></listitem>
|
|---|
| 138 | </varlistentry>
|
|---|
| 139 | </variablelist>
|
|---|
| 140 | </refsect2>
|
|---|
| 141 |
|
|---|
| 142 | <refsect2 id="vboxmanage-debugvm-dumpvmcore">
|
|---|
| 143 | <title>debugvm dumpvmcore</title>
|
|---|
| 144 | <remark role="help-copy-synopsis"/>
|
|---|
| 145 | <para>
|
|---|
| 146 | Creates a system dump file of the specified VM. This file will have
|
|---|
| 147 | the standard ELF core format (with custom sections)<remark role="help-manual">; see
|
|---|
| 148 | <xref linkend="ts_guest-core-format" /></remark>.
|
|---|
| 149 | </para>
|
|---|
| 150 | <para>
|
|---|
| 151 | This corresponds to the <command>writecore</command> command in the debugger.
|
|---|
| 152 | </para>
|
|---|
| 153 | <variablelist>
|
|---|
| 154 | <varlistentry>
|
|---|
| 155 | <term><option>--filename <replaceable>filename</replaceable></option></term>
|
|---|
| 156 | <listitem><para>The name of the output file.</para></listitem>
|
|---|
| 157 | </varlistentry>
|
|---|
| 158 | </variablelist>
|
|---|
| 159 | </refsect2>
|
|---|
| 160 |
|
|---|
| 161 | <refsect2 id="vboxmanage-debugvm-info">
|
|---|
| 162 | <title>debugvm info</title>
|
|---|
| 163 | <remark role="help-copy-synopsis"/>
|
|---|
| 164 | <para>
|
|---|
| 165 | Displays info items relating to the VMM, device emulations and
|
|---|
| 166 | associated drivers.
|
|---|
| 167 | </para>
|
|---|
| 168 | <para>
|
|---|
| 169 | This corresponds to the <command>info</command> command in the debugger.
|
|---|
| 170 | </para>
|
|---|
| 171 | <variablelist>
|
|---|
| 172 | <varlistentry>
|
|---|
| 173 | <term><replaceable>info</replaceable></term>
|
|---|
| 174 | <listitem>
|
|---|
| 175 | <para>Name of the info item to display. The special name
|
|---|
| 176 | <option>help</option> will list all the available info items and
|
|---|
| 177 | hints about optional arguments.</para>
|
|---|
| 178 | </listitem>
|
|---|
| 179 | </varlistentry>
|
|---|
| 180 | <varlistentry>
|
|---|
| 181 | <term><replaceable>args</replaceable></term>
|
|---|
| 182 | <listitem>
|
|---|
| 183 | <para>Optional argument string for the info item handler. Most info items
|
|---|
| 184 | does not take any extra arguments. Arguments not recognized are generally
|
|---|
| 185 | ignored.</para>
|
|---|
| 186 | </listitem>
|
|---|
| 187 | </varlistentry>
|
|---|
| 188 | </variablelist>
|
|---|
| 189 | </refsect2>
|
|---|
| 190 |
|
|---|
| 191 | <refsect2 id="vboxmanage-debugvm-injectnmi">
|
|---|
| 192 | <title>debugvm injectnmi</title>
|
|---|
| 193 | <remark role="help-copy-synopsis"/>
|
|---|
| 194 | <para>
|
|---|
| 195 | Causes a non-maskable interrupt (NMI) to be injected into the guest. This
|
|---|
| 196 | might be useful for certain debugging scenarios. What happens exactly is
|
|---|
| 197 | dependent on the guest operating system, but an NMI can crash the whole
|
|---|
| 198 | guest operating system. Do not use unless you know what you're doing.
|
|---|
| 199 | </para>
|
|---|
| 200 | </refsect2>
|
|---|
| 201 |
|
|---|
| 202 | <refsect2 id="vboxmanage-debugvm-log">
|
|---|
| 203 | <title>debugvm log</title>
|
|---|
| 204 | <remark role="help-copy-synopsis"/>
|
|---|
| 205 | <para>
|
|---|
| 206 | TODO
|
|---|
| 207 | </para>
|
|---|
| 208 | </refsect2>
|
|---|
| 209 |
|
|---|
| 210 | <refsect2 id="vboxmanage-debugvm-logdest">
|
|---|
| 211 | <title>debugvm logdest</title>
|
|---|
| 212 | <remark role="help-copy-synopsis"/>
|
|---|
| 213 | <para>
|
|---|
| 214 | TODO
|
|---|
| 215 | </para>
|
|---|
| 216 | </refsect2>
|
|---|
| 217 |
|
|---|
| 218 | <refsect2 id="vboxmanage-debugvm-logflags">
|
|---|
| 219 | <title>debugvm logflags</title>
|
|---|
| 220 | <remark role="help-copy-synopsis"/>
|
|---|
| 221 | <para>
|
|---|
| 222 | TODO
|
|---|
| 223 | </para>
|
|---|
| 224 | </refsect2>
|
|---|
| 225 |
|
|---|
| 226 | <refsect2 id="vboxmanage-debugvm-osdetect">
|
|---|
| 227 | <title>debugvm osdetect</title>
|
|---|
| 228 | <remark role="help-copy-synopsis"/>
|
|---|
| 229 | <para>
|
|---|
| 230 | Make the VMM's debugger facility (re)-detect the guest operating system (OS).
|
|---|
| 231 | This will first load all debugger plug-ins.
|
|---|
| 232 | </para>
|
|---|
| 233 | <para>
|
|---|
| 234 | This corresponds to the <command>detect</command> command in the debugger.
|
|---|
| 235 | </para>
|
|---|
| 236 | </refsect2>
|
|---|
| 237 |
|
|---|
| 238 | <refsect2 id="vboxmanage-debugvm-osinfo">
|
|---|
| 239 | <title>debugvm osinfo</title>
|
|---|
| 240 | <remark role="help-copy-synopsis"/>
|
|---|
| 241 | <para>
|
|---|
| 242 | Displays information about the guest operating system (OS) previously
|
|---|
| 243 | detected by the VMM's debugger facility.
|
|---|
| 244 | </para>
|
|---|
| 245 | </refsect2>
|
|---|
| 246 |
|
|---|
| 247 | <refsect2 id="vboxmanage-debugvm-osdmesg">
|
|---|
| 248 | <title>debugvm osdmesg</title>
|
|---|
| 249 | <remark role="help-copy-synopsis"/>
|
|---|
| 250 | <para>
|
|---|
| 251 | Displays the guest OS kernel log, if detected and supported.
|
|---|
| 252 | </para>
|
|---|
| 253 | <variablelist>
|
|---|
| 254 | <varlistentry>
|
|---|
| 255 | <term><option>--lines <replaceable>lines</replaceable></option></term>
|
|---|
| 256 | <listitem><para>Number of lines of the log to display, counting from
|
|---|
| 257 | the end. The default is infinite.</para></listitem>
|
|---|
| 258 | </varlistentry>
|
|---|
| 259 | </variablelist>
|
|---|
| 260 | </refsect2>
|
|---|
| 261 |
|
|---|
| 262 | <refsect2 id="vboxmanage-debugvm-getregisters">
|
|---|
| 263 | <title>debugvm getregisters</title>
|
|---|
| 264 | <remark role="help-copy-synopsis"/>
|
|---|
| 265 | <para>
|
|---|
| 266 | Retrieves register values for guest CPUs and emulated devices.
|
|---|
| 267 | </para>
|
|---|
| 268 | <variablelist>
|
|---|
| 269 | <varlistentry>
|
|---|
| 270 | <term><replaceable>reg-set.reg-name</replaceable></term>
|
|---|
| 271 | <listitem>
|
|---|
| 272 | <para>One of more registers, each having one of the following forms:</para>
|
|---|
| 273 | <itemizedlist>
|
|---|
| 274 | <listitem><para><replaceable>register-set.register-name.sub-field</replaceable></para></listitem>
|
|---|
| 275 | <listitem><para><replaceable>register-set.register-name</replaceable></para></listitem>
|
|---|
| 276 | <listitem><para><replaceable>cpu-register-name.sub-field</replaceable></para></listitem>
|
|---|
| 277 | <listitem><para><replaceable>cpu-register-name</replaceable></para></listitem>
|
|---|
| 278 | <listitem><para><replaceable>all</replaceable></para></listitem>
|
|---|
| 279 | </itemizedlist>
|
|---|
| 280 | <para>The <replaceable>all</replaceable> form will cause all registers
|
|---|
| 281 | to be shown (no sub-fields). The registers names are case-insensitive.
|
|---|
| 282 | </para>
|
|---|
| 283 | </listitem>
|
|---|
| 284 | </varlistentry>
|
|---|
| 285 | <varlistentry>
|
|---|
| 286 | <term><option>--cpu <replaceable>id</replaceable></option></term>
|
|---|
| 287 | <listitem><para>Selects the CPU register set when specifying just a
|
|---|
| 288 | CPU register (3rd and 4th form). The default is 0.</para>
|
|---|
| 289 | </listitem>
|
|---|
| 290 | </varlistentry>
|
|---|
| 291 | </variablelist>
|
|---|
| 292 | </refsect2>
|
|---|
| 293 |
|
|---|
| 294 | <refsect2 id="vboxmanage-debugvm-setregisters">
|
|---|
| 295 | <title>debugvm setregisters</title>
|
|---|
| 296 | <remark role="help-copy-synopsis"/>
|
|---|
| 297 | <para>
|
|---|
| 298 | Changes register values for guest CPUs and emulated devices.
|
|---|
| 299 | </para>
|
|---|
| 300 | <variablelist>
|
|---|
| 301 | <varlistentry>
|
|---|
| 302 | <term><replaceable>reg-set.reg-name=value</replaceable></term>
|
|---|
| 303 | <listitem>
|
|---|
| 304 | <para>One of more register assignment, each having one of the following forms:</para>
|
|---|
| 305 | <itemizedlist>
|
|---|
| 306 | <listitem><para><replaceable>register-set.register-name.sub-field=value</replaceable></para></listitem>
|
|---|
| 307 | <listitem><para><replaceable>register-set.register-name=value</replaceable></para></listitem>
|
|---|
| 308 | <listitem><para><replaceable>cpu-register-name.sub-field=value</replaceable></para></listitem>
|
|---|
| 309 | <listitem><para><replaceable>cpu-register-name=value</replaceable></para></listitem>
|
|---|
| 310 | </itemizedlist>
|
|---|
| 311 | <para>The value format should be in the same style as what
|
|---|
| 312 | <command>getregisters</command> displays, with the exception that
|
|---|
| 313 | both octal and decimal can be used instead of hexadecimal.</para>
|
|---|
| 314 | </listitem>
|
|---|
| 315 | </varlistentry>
|
|---|
| 316 | <varlistentry>
|
|---|
| 317 | <term><option>--cpu <replaceable>id</replaceable></option></term>
|
|---|
| 318 | <listitem><para>Selects the CPU register set when specifying just a
|
|---|
| 319 | CPU register (3rd and 4th form). The default is 0.</para>
|
|---|
| 320 | </listitem>
|
|---|
| 321 | </varlistentry>
|
|---|
| 322 | </variablelist>
|
|---|
| 323 | </refsect2>
|
|---|
| 324 |
|
|---|
| 325 | <refsect2 id="vboxmanage-debugvm-show">
|
|---|
| 326 | <title>debugvm show</title>
|
|---|
| 327 | <remark role="help-copy-synopsis"/>
|
|---|
| 328 | <para>
|
|---|
| 329 | TODO
|
|---|
| 330 | </para>
|
|---|
| 331 | </refsect2>
|
|---|
| 332 |
|
|---|
| 333 | <refsect2 id="vboxmanage-debugvm-statistics">
|
|---|
| 334 | <title>debugvm statistics</title>
|
|---|
| 335 | <remark role="help-copy-synopsis"/>
|
|---|
| 336 | <para>
|
|---|
| 337 | Displays or resets VMM statistics.
|
|---|
| 338 | </para>
|
|---|
| 339 | <para>
|
|---|
| 340 | Retrieves register values for guest CPUs and emulated devices.
|
|---|
| 341 | </para>
|
|---|
| 342 | <variablelist>
|
|---|
| 343 | <varlistentry>
|
|---|
| 344 | <term><option>--pattern <replaceable>pattern</replaceable></option></term>
|
|---|
| 345 | <listitem><para>DOS/NT-style wildcards patterns for selecting statistics. Multiple
|
|---|
| 346 | patterns can be specified by using the '|' (pipe) character as separator.</para>
|
|---|
| 347 | </listitem>
|
|---|
| 348 | </varlistentry>
|
|---|
| 349 | <varlistentry>
|
|---|
| 350 | <term><option>--reset</option></term>
|
|---|
| 351 | <listitem><para>Select reset instead of display mode.</para></listitem>
|
|---|
| 352 | </varlistentry>
|
|---|
| 353 | </variablelist>
|
|---|
| 354 |
|
|---|
| 355 | </refsect2>
|
|---|
| 356 |
|
|---|
| 357 | </refsect1>
|
|---|
| 358 |
|
|---|
| 359 | </refentry>
|
|---|
| 360 |
|
|---|
| 361 |
|
|---|
