From f215e02bf85f68d3a6106c2a1f4f7f063f819064 Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Thu, 11 Apr 2024 10:17:27 +0200 Subject: Adding upstream version 7.0.14-dfsg. Signed-off-by: Daniel Baumann --- doc/manual/en_US/man_VBoxManage-debugvm.xml | 666 ++++++++++++++++++++++++++++ 1 file changed, 666 insertions(+) create mode 100644 doc/manual/en_US/man_VBoxManage-debugvm.xml (limited to 'doc/manual/en_US/man_VBoxManage-debugvm.xml') diff --git a/doc/manual/en_US/man_VBoxManage-debugvm.xml b/doc/manual/en_US/man_VBoxManage-debugvm.xml new file mode 100644 index 00000000..82a1c8f4 --- /dev/null +++ b/doc/manual/en_US/man_VBoxManage-debugvm.xml @@ -0,0 +1,666 @@ + + + + +%all.entities; +]> + + + $Date: 2023-01-17 15:15:46 +0100 (Tue, 17 Jan 2023) $ + VBoxManage debugvm + + + + VBoxManage-debugvm + 1 + + + + VBoxManage-debugvm + introspection and guest debugging + &product-name; + + + + + VBoxManage debugvm + uuid|vmname + dumpvmcore + --filename=name + + + VBoxManage debugvm + uuid|vmname + info + item + args + + + VBoxManage debugvm + uuid|vmname + injectnmi + + + VBoxManage debugvm + uuid|vmname + log + --release--debug + group-settings + + + VBoxManage debugvm + uuid|vmname + logdest + --release--debug + destinations + + + VBoxManage debugvm + uuid|vmname + logflags + --release--debug + flags + + + VBoxManage debugvm + uuid|vmname + osdetect + + + VBoxManage debugvm + uuid|vmname + osinfo + + + VBoxManage debugvm + uuid|vmname + osdmesg + --lines=lines + + + VBoxManage debugvm + uuid|vmname + getregisters + --cpu=id + reg-set.reg-name + + + VBoxManage debugvm + uuid|vmname + setregisters + --cpu=id + reg-set.reg-name=value + + + VBoxManage debugvm + uuid|vmname + show + --human-readable--sh-export--sh-eval--cmd-set + settings-item + + + VBoxManage debugvm + uuid|vmname + stack + --cpu=id + + + VBoxManage debugvm + uuid|vmname + statistics + --reset + --descriptions + --pattern=pattern + + + VBoxManage debugvm + uuid|vmname + guestsample + --filename=filename + --sample-interval-us=interval + --sample-time-us=time + + + + Description + + The "debugvm" commands are for experts who want to tinker with the + exact details of virtual machine execution. Like the VM debugger + described in , these commands are only useful if you are + very familiar with the details of the PC architecture and how to debug + software. + + + Common options + + The subcommands of debugvm all operate on a running virtual + machine: + + + uuid|vmname + Either the UUID or the name (case sensitive) of a VM. + + + + + + debugvm dumpvmcore + + + Creates a system dump file of the specified VM. This file will have + the standard ELF core format (with custom sections); see + . + + + This corresponds to the writecore command in the debugger. + + + + + The name of the output file. + + + + + + debugvm info + + + Displays info items relating to the VMM, device emulations and + associated drivers. + + + This corresponds to the info command in the debugger. + + + + item + + Name of the info item to display. The special name + will list all the available info items and + hints about optional arguments. + + + + args + + Optional argument string for the info item handler. Most info items + does not take any extra arguments. Arguments not recognized are generally + ignored. + + + + + + + debugvm injectnmi + + + Causes a non-maskable interrupt (NMI) to be injected into the guest. This + might be useful for certain debugging scenarios. What happens exactly is + dependent on the guest operating system, but an NMI can crash the whole + guest operating system. Do not use unless you know what you're doing. + + + + + debugvm log + + + Changes the group settings for either debug () + or release () logger of the VM process. + + + The group-settings are typically strings on the form + em.e.f.l, hm=~0 + and -em.f. Basic wildcards are supported for + group matching. The all group is an alias for + all the groups. + + + Please do keep in mind that the group settings are applied as modifications + to the current ones. + + + This corresponds to the log command in the debugger. + + + + + debugvm logdest + + + Changes the destination settings for either debug () + or release () logger of the VM process. For details + on the destination format, the best source is src/VBox/Runtime/common/log/log.cpp. + + + The destinations is one or more mnemonics, optionally + prefixed by "no" to disable them. Some of them take values after a ":" or "=" + separator. Multiple mnemonics can be separated by space or given as separate + arguments on the command line. + + + List of available destination: + + + + + Specifies a log file. If no filename is given, one will be + generated based on the current UTC time and VM process name and placed in + the current directory of the VM process. Note that this will currently not + have any effect if the log file has already been opened. + + + + + Specifies the output directory for log files. Note that this + will currently not have any effect if the log file has already been opened. + + + + + A non-zero value enables log historization, with the value + specifying how many old log files to keep. + + + + + The max size of a log file before it is historized. Default is infinite. + + + + The max age (in seconds) of a log file before it is historized. Default is infinite. + + + + Only log to the log buffer until an explicit flush (e.g. via an assertion) + occurs. This is fast and saves diskspace. + + + + Write the log content to standard output. + + + + Write the log content to standard error. + + + + Write the log content to the debugger, if supported by the host OS. + + + + Writes logging to the COM port. This is only applicable for raw-mode and ring-0 logging. + + + + Custom destination which has no meaning to VM processes.. + + + + This corresponds to the logdest command in the debugger. + + + + + debugvm logflags + + + Changes the flags on either debug () or release + () logger of the VM process. Please note that the + modifications are applied onto the existing changes, they are not replacing them. + + + The flags are a list of flag mnemonics, optionally + prefixed by a "no", "!", "~" or "-" to negate their meaning. The "+" prefix + can be used to undo previous negation or use as a separator, though better use + whitespace or separate arguments for that. + + + List of log flag mnemonics, with their counter form where applicable + (asterisk indicates defaults): + + + + + Enables or disables logging. + + + + Enabling buffering of log output before it hits the destinations. + + + + Whether to open the destination file with writethru buffering settings or not. + + + + Enables flushing of the output file (to disk) after each log statement. + + + + + Prefix each log line with lock counts for the current thread. + + + + Prefix each log line with the ID of the current CPU. + + + + Prefix each log line with the current process ID. + + + + Prefix each log line with the numberic flags corresponding to the log statement. + + + + Prefix each log line with the flag mnemonics corresponding to the log statement. + + + + Prefix each log line with the log group number for the log statement producing it. + + + + Prefix each log line with the log group name for the log statement producing it. + + + + Prefix each log line with the current thread identifier. + + + + Prefix each log line with the current thread name. + + + + Prefix each log line with the current UTC wall time. + + + + Prefix each log line with the current monotonic time since the start of the program. + + + + Prefix each log line with the current monotonic timestamp value in milliseconds since the start of the program. + + + + Prefix each log line with the current monotonic timestamp value in nanoseconds. + + + + Prefix each log line with the current CPU timestamp counter (TSC) value. + + + + Selects the whether ts and + tsc prefixes should be displayed as relative to the + previous log line or as absolute time. + + + + Selects the whether the ts and + tsc prefixes should be formatted as hexadecimal + or decimal. + + + + + + Custom log prefix, has by default no meaning for VM processes. + + + + + Output with DOS style (CRLF) or just UNIX style (LF) line endings. + + + + Overwrite the destination file or append to it. + + + + + This corresponds to the logflags command in the debugger. + + + + + debugvm osdetect + + + Make the VMM's debugger facility (re)-detect the guest operating system (OS). + This will first load all debugger plug-ins. + + + This corresponds to the detect command in the debugger. + + + + + debugvm osinfo + + + Displays information about the guest operating system (OS) previously + detected by the VMM's debugger facility. + + + + + debugvm osdmesg + + + Displays the guest OS kernel log, if detected and supported. + + + + + Number of lines of the log to display, counting from + the end. The default is infinite. + + + + + + debugvm getregisters + + + Retrieves register values for guest CPUs and emulated devices. + + + + reg-set.reg-name + + One of more registers, each having one of the following forms: + + register-set.register-name.sub-field + register-set.register-name + cpu-register-name.sub-field + cpu-register-name + all + + The all form will cause all registers + to be shown (no sub-fields). The registers names are case-insensitive. + + + + + + Selects the CPU register set when specifying just a + CPU register (3rd and 4th form). The default is 0. + + + + + + + debugvm setregisters + + + Changes register values for guest CPUs and emulated devices. + + + + reg-set.reg-name=value + + One of more register assignment, each having one of the following forms: + + register-set.register-name.sub-field=value + register-set.register-name=value + cpu-register-name.sub-field=value + cpu-register-name=value + + The value format should be in the same style as what + getregisters displays, with the exception that + both octal and decimal can be used instead of hexadecimal. + + + + + Selects the CPU register set when specifying just a + CPU register (3rd and 4th form). The default is 0. + + + + + + + debugvm show + + + Shows logging settings for the VM. + + + + + Selects human readable output. + + + + Selects output format as bourne shell style export commands. + + + + Selects output format as bourne shell style eval command input. + + + + Selects output format as DOS style SET commands. + + + settings-item + + What to display. One or more of the following: + + logdbg-settings - debug log settings. + logrel-settings - release log settings. + log-settings - alias for both debug and release log settings. + + + + + + + + + debugvm stack + + + Unwinds the guest CPU stacks to the best of our ability. It is + recommended to first run the osdetect command, as this + gives both symbols and perhaps unwind information. + + + + + Selects a single guest CPU to display the stack for. The default is all CPUs. + + + + + + + debugvm statistics + + + Displays or resets VMM statistics. + + + Retrieves register values for guest CPUs and emulated devices. + + + + + DOS/NT-style wildcards patterns for selecting statistics. Multiple + patterns can be specified by using the '|' (pipe) character as separator. + + + + + Select reset instead of display mode. + + + + + + + debugvm guestsample + + + Creates a sample report of the guest activity. + + + Retrieves the filename to dump the report to. + + + + + The filename to dump the sample report to. + + + + + The interval in microseconds between guest samples. + + + + + The amount of microseconds to take guest samples. + + + + + + + + + + -- cgit v1.2.3