1 HXCOMM Use
DEFHEADING() to define headings
in both help text and texi
2 HXCOMM Text between STEXI and ETEXI are copied to texi 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 texi and C
10 @item info @
var{subcommand
}
12 Show various information about the system state
.
20 .help
= "show the version of QEMU",
21 .cmd
= hmp_info_version
,
28 Show the version of QEMU
.
35 .help
= "show the network state",
36 .cmd
= hmp_info_network
,
42 Show the network state
.
49 .help
= "show the character devices",
50 .cmd
= hmp_info_chardev
,
57 Show the character devices
.
62 .args_type
= "nodes:-n,verbose:-v,device:B?",
63 .params
= "[-n] [-v] [device]",
64 .help
= "show info of one block device or all block devices "
65 "(-n: show named nodes; -v: show details)",
66 .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 @findex info blockstats
86 Show block device statistics
.
93 .help
= "show progress of ongoing block device operations",
94 .cmd
= hmp_info_block_jobs
,
99 @findex info block
-jobs
100 Show progress of ongoing block device operations
.
105 .args_type
= "cpustate_all:-a",
107 .help
= "show the cpu registers (-a: all - show register info for all cpus)",
108 .cmd
= hmp_info_registers
,
113 @findex info registers
114 Show the cpu registers
.
117 #
if defined(TARGET_I386
)
120 .args_type
= "apic-id:i?",
121 .params
= "[apic-id]",
122 .help
= "show local apic state (apic-id: local apic to read, default is which of current CPU)",
124 .cmd
= hmp_info_local_apic
,
131 Show local APIC state
134 #
if defined(TARGET_I386
)
139 .help
= "show io apic state",
140 .cmd
= hmp_info_io_apic
,
154 .help
= "show infos for each CPU",
155 .cmd
= hmp_info_cpus
,
161 Show infos
for each CPU
.
168 .help
= "show the command line history",
169 .cmd
= hmp_info_history
,
176 Show the command line history
.
183 .help
= "show the interrupts statistics (if available)",
190 Show the interrupts
statistics (if available
).
197 .help
= "show PIC state",
211 .help
= "show PCI info",
218 Show PCI information
.
221 #
if defined(TARGET_I386
) ||
defined(TARGET_SH4
) ||
defined(TARGET_SPARC
) || \
222 defined(TARGET_PPC
) ||
defined(TARGET_XTENSA
) ||
defined(TARGET_M68K
)
227 .help
= "show virtual to physical memory mappings",
235 Show virtual to physical memory mappings
.
238 #
if defined(TARGET_I386
)
243 .help
= "show the active virtual memory mappings",
251 Show the active virtual memory mappings
.
256 .args_type
= "flatview:-f,dispatch_tree:-d,owner:-o",
257 .params
= "[-f][-d][-o]",
258 .help
= "show memory tree (-f: dump flat view for address spaces;"
259 "-d: dump dispatch tree, valid with -f only);"
260 "-o: dump region owners/parents",
261 .cmd
= hmp_info_mtree
,
270 #
if defined(CONFIG_TCG
)
275 .help
= "show dynamic compiler info",
283 Show
dynamic compiler info
.
286 #
if defined(CONFIG_TCG
)
291 .help
= "show dynamic compiler opcode counters",
292 .cmd
= hmp_info_opcount
,
299 Show
dynamic compiler opcode counters
303 .name
= "sync-profile",
304 .args_type
= "mean:-m,no_coalesce:-n,max:i?",
305 .params
= "[-m] [-n] [max]",
306 .help
= "show synchronization profiling info, up to max entries "
307 "(default: 10), sorted by total wait time. (-m: sort by "
308 "mean wait time; -n: do not coalesce objects with the "
310 .cmd
= hmp_info_sync_profile
,
314 @item info sync
-profile
[-m|
-n
] [@
var{max
}]
315 @findex info sync
-profile
316 Show synchronization profiling info
, up to @
var{max
} entries (default: 10),
317 sorted by total wait time
.
318 -m
: sort by mean wait time
319 -n
: do not coalesce objects with the same call site
320 When different objects that share the same call site are coalesced
, the
"Object"
321 field shows
---enclosed
in brackets
---the number of objects being coalesced
.
328 .help
= "show KVM information",
335 Show KVM information
.
342 .help
= "show NUMA information",
343 .cmd
= hmp_info_numa
,
349 Show NUMA information
.
356 .help
= "show guest USB devices",
363 Show guest USB devices
.
370 .help
= "show host USB devices",
371 .cmd
= hmp_info_usbhost
,
377 Show host USB devices
.
384 .help
= "show profiling information",
385 .cmd
= hmp_info_profile
,
391 Show profiling information
.
398 .help
= "show capture information",
399 .cmd
= hmp_info_capture
,
405 Show capture information
.
412 .help
= "show the currently saved VM snapshots",
413 .cmd
= hmp_info_snapshots
,
418 @findex info snapshots
419 Show the currently saved VM snapshots
.
426 .help
= "show the current VM status (running|paused)",
427 .cmd
= hmp_info_status
,
434 Show the current VM
status (running|paused
).
441 .help
= "show which guest mouse is receiving events",
442 .cmd
= hmp_info_mice
,
448 Show which guest mouse is receiving events
.
451 #
if defined(CONFIG_VNC
)
456 .help
= "show the vnc server status",
464 Show the vnc server status
.
467 #
if defined(CONFIG_SPICE
)
472 .help
= "show the spice server status",
473 .cmd
= hmp_info_spice
,
480 Show the spice server status
.
487 .help
= "show the current VM name",
488 .cmd
= hmp_info_name
,
495 Show the current VM name
.
502 .help
= "show the current VM UUID",
503 .cmd
= hmp_info_uuid
,
510 Show the current VM UUID
.
517 .help
= "show CPU statistics",
518 .cmd
= hmp_info_cpustats
,
523 @findex info cpustats
527 #
if defined(CONFIG_SLIRP
)
532 .help
= "show user network stack connection states",
533 .cmd
= hmp_info_usernet
,
540 Show user network stack connection states
.
547 .help
= "show migration status",
548 .cmd
= hmp_info_migrate
,
554 Show migration status
.
558 .name
= "migrate_capabilities",
561 .help
= "show current migration capabilities",
562 .cmd
= hmp_info_migrate_capabilities
,
566 @item info migrate_capabilities
567 @findex info migrate_capabilities
568 Show current migration capabilities
.
572 .name
= "migrate_parameters",
575 .help
= "show current migration parameters",
576 .cmd
= hmp_info_migrate_parameters
,
580 @item info migrate_parameters
581 @findex info migrate_parameters
582 Show current migration parameters
.
586 .name
= "migrate_cache_size",
589 .help
= "show current migration xbzrle cache size",
590 .cmd
= hmp_info_migrate_cache_size
,
594 @item info migrate_cache_size
595 @findex info migrate_cache_size
596 Show current migration xbzrle cache size
.
603 .help
= "show balloon information",
604 .cmd
= hmp_info_balloon
,
610 Show balloon information
.
617 .help
= "show device tree",
618 .cmd
= hmp_info_qtree
,
631 .help
= "show qdev device model list",
638 Show qdev device model list
.
643 .args_type
= "path:s?",
645 .help
= "show QOM composition tree",
646 .cmd
= hmp_info_qom_tree
,
652 @findex info qom
-tree
653 Show QOM composition tree
.
661 .cmd
= hmp_info_roms
,
671 .name
= "trace-events",
672 .args_type
= "name:s?,vcpu:i?",
673 .params
= "[name] [vcpu]",
674 .help
= "show available trace-events & their state "
675 "(name: event name pattern; vcpu: vCPU to query, default is any)",
676 .cmd
= hmp_info_trace_events
,
677 .command_completion
= info_trace_events_completion
,
681 @item info
trace-events
682 @findex info
trace-events
683 Show available
trace-events
& their state
.
690 .help
= "show the TPM device",
704 .help
= "show memory backends",
705 .cmd
= hmp_info_memdev
,
716 .name
= "memory-devices",
719 .help
= "show memory devices",
720 .cmd
= hmp_info_memory_devices
,
724 @item info memory
-devices
725 @findex info memory
-devices
733 .help
= "show iothreads",
734 .cmd
= hmp_info_iothreads
,
740 @findex info iothreads
741 Show iothread
's identifiers.
746 .args_type = "name:s",
748 .help = "Show rocker switch",
753 @item info rocker @var{name}
759 .name = "rocker-ports",
760 .args_type = "name:s",
762 .help = "Show rocker ports",
763 .cmd = hmp_rocker_ports,
767 @item info rocker-ports @var{name}-ports
768 @findex info rocker-ports
773 .name = "rocker-of-dpa-flows",
774 .args_type = "name:s,tbl_id:i?",
775 .params = "name [tbl_id]",
776 .help = "Show rocker OF-DPA flow tables",
777 .cmd = hmp_rocker_of_dpa_flows,
781 @item info rocker-of-dpa-flows @var{name} [@var{tbl_id}]
782 @findex info rocker-of-dpa-flows
783 Show rocker OF-DPA flow tables.
787 .name = "rocker-of-dpa-groups",
788 .args_type = "name:s,type:i?",
789 .params = "name [type]",
790 .help = "Show rocker OF-DPA groups",
791 .cmd = hmp_rocker_of_dpa_groups,
795 @item info rocker-of-dpa-groups @var{name} [@var{type}]
796 @findex info rocker-of-dpa-groups
797 Show rocker OF-DPA groups.
800 #if defined(TARGET_S390X)
803 .args_type = "addr:l",
805 .help = "Display the value of a storage key",
806 .cmd = hmp_info_skeys,
811 @item info skeys @var{address}
813 Display the value of a storage key (s390 only)
816 #if defined(TARGET_S390X)
819 .args_type = "addr:l,count:l?",
820 .params = "address [count]",
821 .help = "Display the values of the CMMA storage attributes for a range of pages",
822 .cmd = hmp_info_cmma,
827 @item info cmma @var{address}
829 Display the values of the CMMA storage attributes for a range of pages (s390 only)
836 .help = "Display the latest dump status",
837 .cmd = hmp_info_dump,
843 Display the latest dump status.
850 .help = "Display system ramblock information",
851 .cmd = hmp_info_ramblock,
856 @findex info ramblock
857 Dump all the ramblocks of the system.
861 .name = "hotpluggable-cpus",
864 .help = "Show information about hotpluggable CPUs",
865 .cmd = hmp_hotpluggable_cpus,
870 @item info hotpluggable-cpus
871 @findex info hotpluggable-cpus
872 Show information about hotpluggable CPUs
876 .name = "vm-generation-id",
879 .help = "Show Virtual Machine Generation ID",
880 .cmd = hmp_info_vm_generation_id,
884 @item info vm-generation-id
885 @findex info vm-generation-id
886 Show Virtual Machine Generation ID
890 .name = "memory_size_summary",
893 .help = "show the amount of initially allocated and "
894 "present hotpluggable (if enabled) memory in bytes.",
895 .cmd = hmp_info_memory_size_summary,
899 @item info memory_size_summary
900 @findex info memory_size_summary
901 Display the amount of initially allocated and present hotpluggable (if
902 enabled) memory in bytes.
905 #if defined(TARGET_I386)
910 .help = "show SEV information",
918 Show SEV information.