-HXCOMM Use DEFHEADING() to define headings in both help text and texi
-HXCOMM Text between STEXI and ETEXI are copied to texi version and
-HXCOMM discarded from C version
+HXCOMM Use DEFHEADING() to define headings in both help text and rST.
+HXCOMM Text between SRST and ERST is copied to the rST version and
+HXCOMM discarded from C version.
HXCOMM DEF(command, args, callback, arg_string, help) is used to construct
HXCOMM monitor info commands
-HXCOMM HXCOMM can be used for comments, discarded from both texi and C
+HXCOMM HXCOMM can be used for comments, discarded from both rST and C.
HXCOMM
HXCOMM In this file, generally SRST fragments should have two extra
HXCOMM spaces of indent, so that the documentation list item for "info foo"
HXCOMM "info" documentation entry. The exception is the first SRST
HXCOMM fragment that defines that top level entry.
-STEXI
-@table @option
-@item info @var{subcommand}
-@findex info
-Show various information about the system state.
-@table @option
-ETEXI
SRST
``info`` *subcommand*
Show various information about the system state.
.flags = "p",
},
-STEXI
-@item info version
-@findex info version
-Show the version of QEMU.
-ETEXI
SRST
``info version``
Show the version of QEMU.
.cmd = hmp_info_network,
},
-STEXI
-@item info network
-@findex info network
-Show the network state.
-ETEXI
SRST
``info network``
Show the network state.
.flags = "p",
},
-STEXI
-@item info chardev
-@findex info chardev
-Show the character devices.
-ETEXI
SRST
``info chardev``
Show the character devices.
.cmd = hmp_info_block,
},
-STEXI
-@item info block
-@findex info block
-Show info of one block device or all block devices.
-ETEXI
SRST
``info block``
Show info of one block device or all block devices.
.cmd = hmp_info_blockstats,
},
-STEXI
-@item info blockstats
-@findex info blockstats
-Show block device statistics.
-ETEXI
SRST
``info blockstats``
Show block device statistics.
.cmd = hmp_info_block_jobs,
},
-STEXI
-@item info block-jobs
-@findex info block-jobs
-Show progress of ongoing block device operations.
-ETEXI
SRST
``info block-jobs``
Show progress of ongoing block device operations.
{
.name = "registers",
- .args_type = "cpustate_all:-a",
- .params = "[-a]",
- .help = "show the cpu registers (-a: all - show register info for all cpus)",
+ .args_type = "cpustate_all:-a,vcpu:i?",
+ .params = "[-a|vcpu]",
+ .help = "show the cpu registers (-a: show register info for all cpus;"
+ " vcpu: specific vCPU to query; show the current CPU's registers if"
+ " no argument is specified)",
.cmd = hmp_info_registers,
},
-STEXI
-@item info registers
-@findex info registers
-Show the cpu registers.
-ETEXI
SRST
``info registers``
Show the cpu registers.
},
#endif
-STEXI
-@item info lapic
-@findex info lapic
-Show local APIC state
-ETEXI
SRST
``info lapic``
Show local APIC state
ERST
-#if defined(TARGET_I386)
- {
- .name = "ioapic",
- .args_type = "",
- .params = "",
- .help = "show io apic state",
- .cmd = hmp_info_io_apic,
- },
-#endif
-
-STEXI
-@item info ioapic
-@findex info ioapic
-Show io APIC state
-ETEXI
-SRST
- ``info ioapic``
- Show io APIC state
-ERST
-
{
.name = "cpus",
.args_type = "",
.cmd = hmp_info_cpus,
},
-STEXI
-@item info cpus
-@findex info cpus
-Show infos for each CPU.
-ETEXI
SRST
``info cpus``
Show infos for each CPU.
.flags = "p",
},
-STEXI
-@item info history
-@findex info history
-Show the command line history.
-ETEXI
SRST
``info history``
Show the command line history.
.args_type = "",
.params = "",
.help = "show the interrupts statistics (if available)",
- .cmd = hmp_info_irq,
+ .cmd_info_hrt = qmp_x_query_irq,
},
-STEXI
-@item info irq
-@findex info irq
-Show the interrupts statistics (if available).
-ETEXI
SRST
``info irq``
Show the interrupts statistics (if available).
.cmd = hmp_info_pic,
},
-STEXI
-@item info pic
-@findex info pic
-Show PIC state.
-ETEXI
SRST
``info pic``
Show PIC state.
.args_type = "",
.params = "",
.help = "show RDMA state",
- .cmd = hmp_info_rdma,
+ .cmd_info_hrt = qmp_x_query_rdma,
},
-STEXI
-@item info rdma
-@findex info rdma
-Show RDMA state.
-ETEXI
SRST
``info rdma``
Show RDMA state.
.cmd = hmp_info_pci,
},
-STEXI
-@item info pci
-@findex info pci
-Show PCI information.
-ETEXI
SRST
``info pci``
Show PCI information.
},
#endif
-STEXI
-@item info tlb
-@findex info tlb
-Show virtual to physical memory mappings.
-ETEXI
SRST
``info tlb``
Show virtual to physical memory mappings.
},
#endif
-STEXI
-@item info mem
-@findex info mem
-Show the active virtual memory mappings.
-ETEXI
SRST
``info mem``
Show the active virtual memory mappings.
{
.name = "mtree",
- .args_type = "flatview:-f,dispatch_tree:-d,owner:-o",
- .params = "[-f][-d][-o]",
+ .args_type = "flatview:-f,dispatch_tree:-d,owner:-o,disabled:-D",
+ .params = "[-f][-d][-o][-D]",
.help = "show memory tree (-f: dump flat view for address spaces;"
"-d: dump dispatch tree, valid with -f only);"
- "-o: dump region owners/parents",
+ "-o: dump region owners/parents;"
+ "-D: dump disabled regions",
.cmd = hmp_info_mtree,
},
-STEXI
-@item info mtree
-@findex info mtree
-Show memory tree.
-ETEXI
SRST
``info mtree``
Show memory tree.
.args_type = "",
.params = "",
.help = "show dynamic compiler info",
- .cmd = hmp_info_jit,
},
#endif
-STEXI
-@item info jit
-@findex info jit
-Show dynamic compiler info.
-ETEXI
SRST
``info jit``
Show dynamic compiler info.
.args_type = "",
.params = "",
.help = "show dynamic compiler opcode counters",
- .cmd = hmp_info_opcount,
},
#endif
-STEXI
-@item info opcount
-@findex info opcount
-Show dynamic compiler opcode counters
-ETEXI
SRST
``info opcount``
Show dynamic compiler opcode counters
.cmd = hmp_info_sync_profile,
},
-STEXI
-@item info sync-profile [-m|-n] [@var{max}]
-@findex info sync-profile
-Show synchronization profiling info, up to @var{max} entries (default: 10),
-sorted by total wait time.
- -m: sort by mean wait time
- -n: do not coalesce objects with the same call site
-When different objects that share the same call site are coalesced, the "Object"
-field shows---enclosed in brackets---the number of objects being coalesced.
-ETEXI
SRST
``info sync-profile [-m|-n]`` [*max*]
Show synchronization profiling info, up to *max* entries (default: 10),
.cmd = hmp_info_kvm,
},
-STEXI
-@item info kvm
-@findex info kvm
-Show KVM information.
-ETEXI
SRST
``info kvm``
Show KVM information.
.args_type = "",
.params = "",
.help = "show NUMA information",
- .cmd = hmp_info_numa,
+ .cmd_info_hrt = qmp_x_query_numa,
},
-STEXI
-@item info numa
-@findex info numa
-Show NUMA information.
-ETEXI
SRST
``info numa``
Show NUMA information.
.args_type = "",
.params = "",
.help = "show guest USB devices",
- .cmd = hmp_info_usb,
+ .cmd_info_hrt = qmp_x_query_usb,
},
-STEXI
-@item info usb
-@findex info usb
-Show guest USB devices.
-ETEXI
SRST
``info usb``
Show guest USB devices.
.args_type = "",
.params = "",
.help = "show host USB devices",
- .cmd = hmp_info_usbhost,
},
-STEXI
-@item info usbhost
-@findex info usbhost
-Show host USB devices.
-ETEXI
SRST
``info usbhost``
Show host USB devices.
ERST
- {
- .name = "profile",
- .args_type = "",
- .params = "",
- .help = "show profiling information",
- .cmd = hmp_info_profile,
- },
-
-STEXI
-@item info profile
-@findex info profile
-Show profiling information.
-ETEXI
-SRST
- ``info profile``
- Show profiling information.
-ERST
-
{
.name = "capture",
.args_type = "",
.cmd = hmp_info_capture,
},
-STEXI
-@item info capture
-@findex info capture
-Show capture information.
-ETEXI
SRST
``info capture``
Show capture information.
.cmd = hmp_info_snapshots,
},
-STEXI
-@item info snapshots
-@findex info snapshots
-Show the currently saved VM snapshots.
-ETEXI
SRST
``info snapshots``
Show the currently saved VM snapshots.
.flags = "p",
},
-STEXI
-@item info status
-@findex info status
-Show the current VM status (running|paused).
-ETEXI
SRST
``info status``
Show the current VM status (running|paused).
.cmd = hmp_info_mice,
},
-STEXI
-@item info mice
-@findex info mice
-Show which guest mouse is receiving events.
-ETEXI
SRST
``info mice``
Show which guest mouse is receiving events.
},
#endif
-STEXI
-@item info vnc
-@findex info vnc
-Show the vnc server status.
-ETEXI
SRST
``info vnc``
Show the vnc server status.
},
#endif
-STEXI
-@item info spice
-@findex info spice
-Show the spice server status.
-ETEXI
SRST
``info spice``
Show the spice server status.
.flags = "p",
},
-STEXI
-@item info name
-@findex info name
-Show the current VM name.
-ETEXI
SRST
``info name``
Show the current VM name.
.flags = "p",
},
-STEXI
-@item info uuid
-@findex info uuid
-Show the current VM UUID.
-ETEXI
SRST
``info uuid``
Show the current VM UUID.
ERST
- {
- .name = "cpustats",
- .args_type = "",
- .params = "",
- .help = "show CPU statistics",
- .cmd = hmp_info_cpustats,
- },
-
-STEXI
-@item info cpustats
-@findex info cpustats
-Show CPU statistics.
-ETEXI
-SRST
- ``info cpustats``
- Show CPU statistics.
-ERST
-
#if defined(CONFIG_SLIRP)
{
.name = "usernet",
},
#endif
-STEXI
-@item info usernet
-@findex info usernet
-Show user network stack connection states.
-ETEXI
SRST
``info usernet``
Show user network stack connection states.
.cmd = hmp_info_migrate,
},
-STEXI
-@item info migrate
-@findex info migrate
-Show migration status.
-ETEXI
SRST
``info migrate``
Show migration status.
.cmd = hmp_info_migrate_capabilities,
},
-STEXI
-@item info migrate_capabilities
-@findex info migrate_capabilities
-Show current migration capabilities.
-ETEXI
SRST
``info migrate_capabilities``
Show current migration capabilities.
.cmd = hmp_info_migrate_parameters,
},
-STEXI
-@item info migrate_parameters
-@findex info migrate_parameters
-Show current migration parameters.
-ETEXI
SRST
``info migrate_parameters``
Show current migration parameters.
ERST
- {
- .name = "migrate_cache_size",
- .args_type = "",
- .params = "",
- .help = "show current migration xbzrle cache size",
- .cmd = hmp_info_migrate_cache_size,
- },
-
-STEXI
-@item info migrate_cache_size
-@findex info migrate_cache_size
-Show current migration xbzrle cache size.
-ETEXI
-SRST
- ``info migrate_cache_size``
- Show current migration xbzrle cache size.
-ERST
-
{
.name = "balloon",
.args_type = "",
.cmd = hmp_info_balloon,
},
-STEXI
-@item info balloon
-@findex info balloon
-Show balloon information.
-ETEXI
SRST
``info balloon``
Show balloon information.
.cmd = hmp_info_qtree,
},
-STEXI
-@item info qtree
-@findex info qtree
-Show device tree.
-ETEXI
SRST
``info qtree``
Show device tree.
.cmd = hmp_info_qdm,
},
-STEXI
-@item info qdm
-@findex info qdm
-Show qdev device model list.
-ETEXI
SRST
``info qdm``
Show qdev device model list.
.flags = "p",
},
-STEXI
-@item info qom-tree
-@findex info qom-tree
-Show QOM composition tree.
-ETEXI
SRST
``info qom-tree``
Show QOM composition tree.
.args_type = "",
.params = "",
.help = "show roms",
- .cmd = hmp_info_roms,
+ .cmd_info_hrt = qmp_x_query_roms,
},
-STEXI
-@item info roms
-@findex info roms
-Show roms.
-ETEXI
SRST
``info roms``
Show roms.
.command_completion = info_trace_events_completion,
},
-STEXI
-@item info trace-events
-@findex info trace-events
-Show available trace-events & their state.
-ETEXI
SRST
``info trace-events``
Show available trace-events & their state.
.cmd = hmp_info_tpm,
},
-STEXI
-@item info tpm
-@findex info tpm
-Show the TPM device.
-ETEXI
SRST
``info tpm``
Show the TPM device.
.flags = "p",
},
-STEXI
-@item info memdev
-@findex info memdev
-Show memory backends
-ETEXI
SRST
``info memdev``
Show memory backends
.cmd = hmp_info_memory_devices,
},
-STEXI
-@item info memory-devices
-@findex info memory-devices
-Show memory devices.
-ETEXI
SRST
``info memory-devices``
Show memory devices.
.flags = "p",
},
-STEXI
-@item info iothreads
-@findex info iothreads
-Show iothread's identifiers.
-ETEXI
SRST
``info iothreads``
Show iothread's identifiers.
.cmd = hmp_rocker,
},
-STEXI
-@item info rocker @var{name}
-@findex info rocker
-Show rocker switch.
-ETEXI
SRST
``info rocker`` *name*
Show rocker switch.
.cmd = hmp_rocker_ports,
},
-STEXI
-@item info rocker-ports @var{name}-ports
-@findex info rocker-ports
-Show rocker ports.
-ETEXI
SRST
``info rocker-ports`` *name*-ports
Show rocker ports.
.cmd = hmp_rocker_of_dpa_flows,
},
-STEXI
-@item info rocker-of-dpa-flows @var{name} [@var{tbl_id}]
-@findex info rocker-of-dpa-flows
-Show rocker OF-DPA flow tables.
-ETEXI
SRST
``info rocker-of-dpa-flows`` *name* [*tbl_id*]
Show rocker OF-DPA flow tables.
.cmd = hmp_rocker_of_dpa_groups,
},
-STEXI
-@item info rocker-of-dpa-groups @var{name} [@var{type}]
-@findex info rocker-of-dpa-groups
-Show rocker OF-DPA groups.
-ETEXI
SRST
``info rocker-of-dpa-groups`` *name* [*type*]
Show rocker OF-DPA groups.
},
#endif
-STEXI
-@item info skeys @var{address}
-@findex info skeys
-Display the value of a storage key (s390 only)
-ETEXI
SRST
``info skeys`` *address*
Display the value of a storage key (s390 only)
},
#endif
-STEXI
-@item info cmma @var{address}
-@findex info cmma
-Display the values of the CMMA storage attributes for a range of pages (s390 only)
-ETEXI
SRST
``info cmma`` *address*
Display the values of the CMMA storage attributes for a range of
.cmd = hmp_info_dump,
},
-STEXI
-@item info dump
-@findex info dump
-Display the latest dump status.
-ETEXI
SRST
``info dump``
Display the latest dump status.
.args_type = "",
.params = "",
.help = "Display system ramblock information",
- .cmd = hmp_info_ramblock,
+ .cmd_info_hrt = qmp_x_query_ramblock,
},
-STEXI
-@item info ramblock
-@findex info ramblock
-Dump all the ramblocks of the system.
-ETEXI
SRST
``info ramblock``
Dump all the ramblocks of the system.
.flags = "p",
},
-STEXI
-@item info hotpluggable-cpus
-@findex info hotpluggable-cpus
-Show information about hotpluggable CPUs
-ETEXI
SRST
``info hotpluggable-cpus``
Show information about hotpluggable CPUs
.cmd = hmp_info_vm_generation_id,
},
-STEXI
-@item info vm-generation-id
-@findex info vm-generation-id
-Show Virtual Machine Generation ID
-ETEXI
SRST
``info vm-generation-id``
Show Virtual Machine Generation ID
.cmd = hmp_info_memory_size_summary,
},
-STEXI
-@item info memory_size_summary
-@findex info memory_size_summary
-Display the amount of initially allocated and present hotpluggable (if
-enabled) memory in bytes.
-ETEXI
SRST
``info memory_size_summary``
Display the amount of initially allocated and present hotpluggable (if
},
#endif
-STEXI
-@item info sev
-@findex info sev
-Show SEV information.
-ETEXI
SRST
``info sev``
Show SEV information.
ERST
-STEXI
-@end table
-ETEXI
+ {
+ .name = "replay",
+ .args_type = "",
+ .params = "",
+ .help = "show record/replay information",
+ .cmd = hmp_info_replay,
+ },
+
+SRST
+ ``info replay``
+ Display the record/replay information: mode and the current icount.
+ERST
+
+ {
+ .name = "dirty_rate",
+ .args_type = "",
+ .params = "",
+ .help = "show dirty rate information",
+ .cmd = hmp_info_dirty_rate,
+ },
+
+SRST
+ ``info dirty_rate``
+ Display the vcpu dirty rate information.
+ERST
+
+ {
+ .name = "vcpu_dirty_limit",
+ .args_type = "",
+ .params = "",
+ .help = "show dirty page limit information of all vCPU",
+ .cmd = hmp_info_vcpu_dirty_limit,
+ },
+
+SRST
+ ``info vcpu_dirty_limit``
+ Display the vcpu dirty page limit information.
+ERST
-STEXI
-@end table
-ETEXI
+#if defined(TARGET_I386)
+ {
+ .name = "sgx",
+ .args_type = "",
+ .params = "",
+ .help = "show intel SGX information",
+ .cmd = hmp_info_sgx,
+ },
+#endif
+
+SRST
+ ``info sgx``
+ Show intel SGX information.
+ERST
+
+#if defined(CONFIG_MOS6522)
+ {
+ .name = "via",
+ .args_type = "",
+ .params = "",
+ .help = "show guest mos6522 VIA devices",
+ .cmd = hmp_info_via,
+ },
+#endif
+
+SRST
+ ``info via``
+ Show guest mos6522 VIA devices.
+ERST
+
+ {
+ .name = "stats",
+ .args_type = "target:s,names:s?,provider:s?",
+ .params = "target [names] [provider]",
+ .help = "show statistics for the given target (vm or vcpu); optionally filter by"
+ "name (comma-separated list, or * for all) and provider",
+ .cmd = hmp_info_stats,
+ },
+
+SRST
+ ``stats``
+ Show runtime-collected statistics
+ERST
+
+ {
+ .name = "virtio",
+ .args_type = "",
+ .params = "",
+ .help = "List all available virtio devices",
+ .cmd = hmp_virtio_query,
+ .flags = "p",
+ },
+
+SRST
+ ``info virtio``
+ List all available virtio devices
+ERST
+
+ {
+ .name = "virtio-status",
+ .args_type = "path:s",
+ .params = "path",
+ .help = "Display status of a given virtio device",
+ .cmd = hmp_virtio_status,
+ .flags = "p",
+ },
+
+SRST
+ ``info virtio-status`` *path*
+ Display status of a given virtio device
+ERST
+
+ {
+ .name = "virtio-queue-status",
+ .args_type = "path:s,queue:i",
+ .params = "path queue",
+ .help = "Display status of a given virtio queue",
+ .cmd = hmp_virtio_queue_status,
+ .flags = "p",
+ },
+
+SRST
+ ``info virtio-queue-status`` *path* *queue*
+ Display status of a given virtio queue
+ERST
+
+ {
+ .name = "virtio-vhost-queue-status",
+ .args_type = "path:s,queue:i",
+ .params = "path queue",
+ .help = "Display status of a given vhost queue",
+ .cmd = hmp_vhost_queue_status,
+ .flags = "p",
+ },
+
+SRST
+ ``info virtio-vhost-queue-status`` *path* *queue*
+ Display status of a given vhost queue
+ERST
+
+ {
+ .name = "virtio-queue-element",
+ .args_type = "path:s,queue:i,index:i?",
+ .params = "path queue [index]",
+ .help = "Display element of a given virtio queue",
+ .cmd = hmp_virtio_queue_element,
+ .flags = "p",
+ },
+
+SRST
+ ``info virtio-queue-element`` *path* *queue* [*index*]
+ Display element of a given virtio queue
+ERST
+
+ {
+ .name = "cryptodev",
+ .args_type = "",
+ .params = "",
+ .help = "show the crypto devices",
+ .cmd = hmp_info_cryptodev,
+ .flags = "p",
+ },
+
+SRST
+ ``info cryptodev``
+ Show the crypto devices.
+ERST