1 HXCOMM Use
DEFHEADING() to define headings
in both help text and rST
.
2 HXCOMM Text between SRST and ERST is copied to the rST version and
3 HXCOMM discarded from C version
.
4 HXCOMM
DEF(command
, args
, callback, arg_string
, help
) is used to construct
5 HXCOMM monitor info commands
6 HXCOMM HXCOMM can be used
for comments
, discarded from both rST and C
.
8 HXCOMM In
this file
, generally SRST fragments should have two extra
9 HXCOMM spaces of indent
, so that the documentation list item
for "info foo"
10 HXCOMM appears inside the documentation list item
for the top level
11 HXCOMM
"info" documentation entry
. The exception is the first SRST
12 HXCOMM fragment that defines that top level entry
.
16 Show various information about the system state
.
24 .help
= "show the version of QEMU",
25 .cmd
= hmp_info_version
,
31 Show the version of QEMU
.
38 .help
= "show the network state",
39 .cmd
= hmp_info_network
,
44 Show the network state
.
51 .help
= "show the character devices",
52 .cmd
= hmp_info_chardev
,
58 Show the character devices
.
63 .args_type
= "nodes:-n,verbose:-v,device:B?",
64 .params
= "[-n] [-v] [device]",
65 .help
= "show info of one block device or all block devices "
66 "(-n: show named nodes; -v: show details)",
67 .cmd
= hmp_info_block
,
72 Show info of one block device or all block devices
.
79 .help
= "show block device statistics",
80 .cmd
= hmp_info_blockstats
,
85 Show block device statistics
.
92 .help
= "show progress of ongoing block device operations",
93 .cmd
= hmp_info_block_jobs
,
98 Show progress of ongoing block device operations
.
103 .args_type
= "cpustate_all:-a,vcpu:i?",
104 .params
= "[-a|vcpu]",
105 .help
= "show the cpu registers (-a: show register info for all cpus;"
106 " vcpu: specific vCPU to query; show the current CPU's registers if"
107 " no argument is specified)",
108 .cmd
= hmp_info_registers
,
113 Show the cpu registers
.
116 #
if defined(TARGET_I386
)
119 .args_type
= "apic-id:i?",
120 .params
= "[apic-id]",
121 .help
= "show local apic state (apic-id: local apic to read, default is which of current CPU)",
123 .cmd
= hmp_info_local_apic
,
129 Show local APIC state
136 .help
= "show infos for each CPU",
137 .cmd
= hmp_info_cpus
,
142 Show infos
for each CPU
.
149 .help
= "show the command line history",
150 .cmd
= hmp_info_history
,
156 Show the command line history
.
163 .help
= "show the interrupts statistics (if available)",
164 .cmd_info_hrt
= qmp_x_query_irq
,
169 Show the interrupts
statistics (if available
).
176 .help
= "show PIC state",
189 .help
= "show RDMA state",
190 .cmd_info_hrt
= qmp_x_query_rdma
,
202 .help
= "show PCI info",
208 Show PCI information
.
211 #
if defined(TARGET_I386
) ||
defined(TARGET_SH4
) ||
defined(TARGET_SPARC
) || \
212 defined(TARGET_PPC
) ||
defined(TARGET_XTENSA
) ||
defined(TARGET_M68K
)
217 .help
= "show virtual to physical memory mappings",
224 Show virtual to physical memory mappings
.
227 #
if defined(TARGET_I386
) ||
defined(TARGET_RISCV
)
232 .help
= "show the active virtual memory mappings",
239 Show the active virtual memory mappings
.
244 .args_type
= "flatview:-f,dispatch_tree:-d,owner:-o,disabled:-D",
245 .params
= "[-f][-d][-o][-D]",
246 .help
= "show memory tree (-f: dump flat view for address spaces;"
247 "-d: dump dispatch tree, valid with -f only);"
248 "-o: dump region owners/parents;"
249 "-D: dump disabled regions",
250 .cmd
= hmp_info_mtree
,
258 #
if defined(CONFIG_TCG
)
263 .help
= "show dynamic compiler info",
269 Show
dynamic compiler info
.
272 #
if defined(CONFIG_TCG
)
277 .help
= "show dynamic compiler opcode counters",
283 Show
dynamic compiler opcode counters
287 .name
= "sync-profile",
288 .args_type
= "mean:-m,no_coalesce:-n,max:i?",
289 .params
= "[-m] [-n] [max]",
290 .help
= "show synchronization profiling info, up to max entries "
291 "(default: 10), sorted by total wait time. (-m: sort by "
292 "mean wait time; -n: do not coalesce objects with the "
294 .cmd
= hmp_info_sync_profile
,
298 ``info sync
-profile
[-m|
-n
]``
[*max
*]
299 Show synchronization profiling info
, up to
*max
* entries (default: 10),
300 sorted by total wait time
.
303 sort by mean wait time
305 do not coalesce objects with the same call site
307 When different objects that share the same call site are coalesced
,
308 the
"Object" field shows
---enclosed
in brackets
---the number of objects
316 .help
= "show KVM information",
322 Show KVM information
.
329 .help
= "show NUMA information",
330 .cmd_info_hrt
= qmp_x_query_numa
,
335 Show NUMA information
.
342 .help
= "show guest USB devices",
343 .cmd_info_hrt
= qmp_x_query_usb
,
348 Show guest USB devices
.
355 .help
= "show host USB devices",
360 Show host USB devices
.
363 #
if defined(CONFIG_TCG
)
368 .help
= "show profiling information",
369 .cmd_info_hrt
= qmp_x_query_profile
,
375 Show profiling information
.
382 .help
= "show capture information",
383 .cmd
= hmp_info_capture
,
388 Show capture information
.
395 .help
= "show the currently saved VM snapshots",
396 .cmd
= hmp_info_snapshots
,
401 Show the currently saved VM snapshots
.
408 .help
= "show the current VM status (running|paused)",
409 .cmd
= hmp_info_status
,
415 Show the current VM
status (running|paused
).
422 .help
= "show which guest mouse is receiving events",
423 .cmd
= hmp_info_mice
,
428 Show which guest mouse is receiving events
.
431 #
if defined(CONFIG_VNC
)
436 .help
= "show the vnc server status",
443 Show the vnc server status
.
446 #
if defined(CONFIG_SPICE
)
451 .help
= "show the spice server status",
452 .cmd
= hmp_info_spice
,
458 Show the spice server status
.
465 .help
= "show the current VM name",
466 .cmd
= hmp_info_name
,
472 Show the current VM name
.
479 .help
= "show the current VM UUID",
480 .cmd
= hmp_info_uuid
,
486 Show the current VM UUID
.
489 #
if defined(CONFIG_SLIRP
)
494 .help
= "show user network stack connection states",
495 .cmd
= hmp_info_usernet
,
501 Show user network stack connection states
.
508 .help
= "show migration status",
509 .cmd
= hmp_info_migrate
,
514 Show migration status
.
518 .name
= "migrate_capabilities",
521 .help
= "show current migration capabilities",
522 .cmd
= hmp_info_migrate_capabilities
,
526 ``info migrate_capabilities``
527 Show current migration capabilities
.
531 .name
= "migrate_parameters",
534 .help
= "show current migration parameters",
535 .cmd
= hmp_info_migrate_parameters
,
539 ``info migrate_parameters``
540 Show current migration parameters
.
547 .help
= "show balloon information",
548 .cmd
= hmp_info_balloon
,
553 Show balloon information
.
560 .help
= "show device tree",
561 .cmd
= hmp_info_qtree
,
573 .help
= "show qdev device model list",
579 Show qdev device model list
.
584 .args_type
= "path:s?",
586 .help
= "show QOM composition tree",
587 .cmd
= hmp_info_qom_tree
,
593 Show QOM composition tree
.
601 .cmd_info_hrt
= qmp_x_query_roms
,
610 .name
= "trace-events",
611 .args_type
= "name:s?,vcpu:i?",
612 .params
= "[name] [vcpu]",
613 .help
= "show available trace-events & their state "
614 "(name: event name pattern; vcpu: vCPU to query, default is any)",
615 .cmd
= hmp_info_trace_events
,
616 .command_completion
= info_trace_events_completion
,
620 ``info
trace-events``
621 Show available
trace-events
& their state
.
628 .help
= "show the TPM device",
641 .help
= "show memory backends",
642 .cmd
= hmp_info_memdev
,
652 .name
= "memory-devices",
655 .help
= "show memory devices",
656 .cmd
= hmp_info_memory_devices
,
660 ``info memory
-devices``
668 .help
= "show iothreads",
669 .cmd
= hmp_info_iothreads
,
675 Show iothread
's identifiers.
680 .args_type = "name:s",
682 .help = "Show rocker switch",
687 ``info rocker`` *name*
692 .name = "rocker-ports",
693 .args_type = "name:s",
695 .help = "Show rocker ports",
696 .cmd = hmp_rocker_ports,
700 ``info rocker-ports`` *name*-ports
705 .name = "rocker-of-dpa-flows",
706 .args_type = "name:s,tbl_id:i?",
707 .params = "name [tbl_id]",
708 .help = "Show rocker OF-DPA flow tables",
709 .cmd = hmp_rocker_of_dpa_flows,
713 ``info rocker-of-dpa-flows`` *name* [*tbl_id*]
714 Show rocker OF-DPA flow tables.
718 .name = "rocker-of-dpa-groups",
719 .args_type = "name:s,type:i?",
720 .params = "name [type]",
721 .help = "Show rocker OF-DPA groups",
722 .cmd = hmp_rocker_of_dpa_groups,
726 ``info rocker-of-dpa-groups`` *name* [*type*]
727 Show rocker OF-DPA groups.
730 #if defined(TARGET_S390X)
733 .args_type = "addr:l",
735 .help = "Display the value of a storage key",
736 .cmd = hmp_info_skeys,
741 ``info skeys`` *address*
742 Display the value of a storage key (s390 only)
745 #if defined(TARGET_S390X)
748 .args_type = "addr:l,count:l?",
749 .params = "address [count]",
750 .help = "Display the values of the CMMA storage attributes for a range of pages",
751 .cmd = hmp_info_cmma,
756 ``info cmma`` *address*
757 Display the values of the CMMA storage attributes for a range of
765 .help = "Display the latest dump status",
766 .cmd = hmp_info_dump,
771 Display the latest dump status.
778 .help = "Display system ramblock information",
779 .cmd_info_hrt = qmp_x_query_ramblock,
784 Dump all the ramblocks of the system.
788 .name = "hotpluggable-cpus",
791 .help = "Show information about hotpluggable CPUs",
792 .cmd = hmp_hotpluggable_cpus,
797 ``info hotpluggable-cpus``
798 Show information about hotpluggable CPUs
802 .name = "vm-generation-id",
805 .help = "Show Virtual Machine Generation ID",
806 .cmd = hmp_info_vm_generation_id,
810 ``info vm-generation-id``
811 Show Virtual Machine Generation ID
815 .name = "memory_size_summary",
818 .help = "show the amount of initially allocated and "
819 "present hotpluggable (if enabled) memory in bytes.",
820 .cmd = hmp_info_memory_size_summary,
824 ``info memory_size_summary``
825 Display the amount of initially allocated and present hotpluggable (if
826 enabled) memory in bytes.
829 #if defined(TARGET_I386)
834 .help = "show SEV information",
841 Show SEV information.
848 .help = "show record/replay information",
849 .cmd = hmp_info_replay,
854 Display the record/replay information: mode and the current icount.
858 .name = "dirty_rate",
861 .help = "show dirty rate information",
862 .cmd = hmp_info_dirty_rate,
867 Display the vcpu dirty rate information.
871 .name = "vcpu_dirty_limit",
874 .help = "show dirty page limit information of all vCPU",
875 .cmd = hmp_info_vcpu_dirty_limit,
879 ``info vcpu_dirty_limit``
880 Display the vcpu dirty page limit information.
883 #if defined(TARGET_I386)
888 .help = "show intel SGX information",
895 Show intel SGX information.
898 #if defined(CONFIG_MOS6522)
903 .help = "show guest mos6522 VIA devices",
910 Show guest mos6522 VIA devices.
915 .args_type = "target:s,names:s?,provider:s?",
916 .params = "target [names] [provider]",
917 .help = "show statistics for the given target (vm or vcpu); optionally filter by"
918 "name (comma-separated list, or * for all) and provider",
919 .cmd = hmp_info_stats,
924 Show runtime-collected statistics
931 .help = "List all available virtio devices",
932 .cmd = hmp_virtio_query,
938 List all available virtio devices
942 .name = "virtio-status",
943 .args_type = "path:s",
945 .help = "Display status of a given virtio device",
946 .cmd = hmp_virtio_status,
951 ``info virtio-status`` *path*
952 Display status of a given virtio device
956 .name = "virtio-queue-status",
957 .args_type = "path:s,queue:i",
958 .params = "path queue",
959 .help = "Display status of a given virtio queue",
960 .cmd = hmp_virtio_queue_status,
965 ``info virtio-queue-status`` *path* *queue*
966 Display status of a given virtio queue
970 .name = "virtio-vhost-queue-status",
971 .args_type = "path:s,queue:i",
972 .params = "path queue",
973 .help = "Display status of a given vhost queue",
974 .cmd = hmp_vhost_queue_status,
979 ``info virtio-vhost-queue-status`` *path* *queue*
980 Display status of a given vhost queue
984 .name = "virtio-queue-element",
985 .args_type = "path:s,queue:i,index:i?",
986 .params = "path queue [index]",
987 .help = "Display element of a given virtio queue",
988 .cmd = hmp_virtio_queue_element,
993 ``info virtio-queue-element`` *path* *queue* [*index*]
994 Display element of a given virtio queue