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 RDMA state",
212 .cmd
= hmp_info_rdma
,
225 .help
= "show PCI info",
232 Show PCI information
.
235 #
if defined(TARGET_I386
) ||
defined(TARGET_SH4
) ||
defined(TARGET_SPARC
) || \
236 defined(TARGET_PPC
) ||
defined(TARGET_XTENSA
) ||
defined(TARGET_M68K
)
241 .help
= "show virtual to physical memory mappings",
249 Show virtual to physical memory mappings
.
252 #
if defined(TARGET_I386
)
257 .help
= "show the active virtual memory mappings",
265 Show the active virtual memory mappings
.
270 .args_type
= "flatview:-f,dispatch_tree:-d,owner:-o",
271 .params
= "[-f][-d][-o]",
272 .help
= "show memory tree (-f: dump flat view for address spaces;"
273 "-d: dump dispatch tree, valid with -f only);"
274 "-o: dump region owners/parents",
275 .cmd
= hmp_info_mtree
,
284 #
if defined(CONFIG_TCG
)
289 .help
= "show dynamic compiler info",
297 Show
dynamic compiler info
.
300 #
if defined(CONFIG_TCG
)
305 .help
= "show dynamic compiler opcode counters",
306 .cmd
= hmp_info_opcount
,
313 Show
dynamic compiler opcode counters
317 .name
= "sync-profile",
318 .args_type
= "mean:-m,no_coalesce:-n,max:i?",
319 .params
= "[-m] [-n] [max]",
320 .help
= "show synchronization profiling info, up to max entries "
321 "(default: 10), sorted by total wait time. (-m: sort by "
322 "mean wait time; -n: do not coalesce objects with the "
324 .cmd
= hmp_info_sync_profile
,
328 @item info sync
-profile
[-m|
-n
] [@
var{max
}]
329 @findex info sync
-profile
330 Show synchronization profiling info
, up to @
var{max
} entries (default: 10),
331 sorted by total wait time
.
332 -m
: sort by mean wait time
333 -n
: do not coalesce objects with the same call site
334 When different objects that share the same call site are coalesced
, the
"Object"
335 field shows
---enclosed
in brackets
---the number of objects being coalesced
.
342 .help
= "show KVM information",
349 Show KVM information
.
356 .help
= "show NUMA information",
357 .cmd
= hmp_info_numa
,
363 Show NUMA information
.
370 .help
= "show guest USB devices",
377 Show guest USB devices
.
384 .help
= "show host USB devices",
385 .cmd
= hmp_info_usbhost
,
391 Show host USB devices
.
398 .help
= "show profiling information",
399 .cmd
= hmp_info_profile
,
405 Show profiling information
.
412 .help
= "show capture information",
413 .cmd
= hmp_info_capture
,
419 Show capture information
.
426 .help
= "show the currently saved VM snapshots",
427 .cmd
= hmp_info_snapshots
,
432 @findex info snapshots
433 Show the currently saved VM snapshots
.
440 .help
= "show the current VM status (running|paused)",
441 .cmd
= hmp_info_status
,
448 Show the current VM
status (running|paused
).
455 .help
= "show which guest mouse is receiving events",
456 .cmd
= hmp_info_mice
,
462 Show which guest mouse is receiving events
.
465 #
if defined(CONFIG_VNC
)
470 .help
= "show the vnc server status",
478 Show the vnc server status
.
481 #
if defined(CONFIG_SPICE
)
486 .help
= "show the spice server status",
487 .cmd
= hmp_info_spice
,
494 Show the spice server status
.
501 .help
= "show the current VM name",
502 .cmd
= hmp_info_name
,
509 Show the current VM name
.
516 .help
= "show the current VM UUID",
517 .cmd
= hmp_info_uuid
,
524 Show the current VM UUID
.
531 .help
= "show CPU statistics",
532 .cmd
= hmp_info_cpustats
,
537 @findex info cpustats
541 #
if defined(CONFIG_SLIRP
)
546 .help
= "show user network stack connection states",
547 .cmd
= hmp_info_usernet
,
554 Show user network stack connection states
.
561 .help
= "show migration status",
562 .cmd
= hmp_info_migrate
,
568 Show migration status
.
572 .name
= "migrate_capabilities",
575 .help
= "show current migration capabilities",
576 .cmd
= hmp_info_migrate_capabilities
,
580 @item info migrate_capabilities
581 @findex info migrate_capabilities
582 Show current migration capabilities
.
586 .name
= "migrate_parameters",
589 .help
= "show current migration parameters",
590 .cmd
= hmp_info_migrate_parameters
,
594 @item info migrate_parameters
595 @findex info migrate_parameters
596 Show current migration parameters
.
600 .name
= "migrate_cache_size",
603 .help
= "show current migration xbzrle cache size",
604 .cmd
= hmp_info_migrate_cache_size
,
608 @item info migrate_cache_size
609 @findex info migrate_cache_size
610 Show current migration xbzrle cache size
.
617 .help
= "show balloon information",
618 .cmd
= hmp_info_balloon
,
624 Show balloon information
.
631 .help
= "show device tree",
632 .cmd
= hmp_info_qtree
,
645 .help
= "show qdev device model list",
652 Show qdev device model list
.
657 .args_type
= "path:s?",
659 .help
= "show QOM composition tree",
660 .cmd
= hmp_info_qom_tree
,
666 @findex info qom
-tree
667 Show QOM composition tree
.
675 .cmd
= hmp_info_roms
,
685 .name
= "trace-events",
686 .args_type
= "name:s?,vcpu:i?",
687 .params
= "[name] [vcpu]",
688 .help
= "show available trace-events & their state "
689 "(name: event name pattern; vcpu: vCPU to query, default is any)",
690 .cmd
= hmp_info_trace_events
,
691 .command_completion
= info_trace_events_completion
,
695 @item info
trace-events
696 @findex info
trace-events
697 Show available
trace-events
& their state
.
704 .help
= "show the TPM device",
718 .help
= "show memory backends",
719 .cmd
= hmp_info_memdev
,
730 .name
= "memory-devices",
733 .help
= "show memory devices",
734 .cmd
= hmp_info_memory_devices
,
738 @item info memory
-devices
739 @findex info memory
-devices
747 .help
= "show iothreads",
748 .cmd
= hmp_info_iothreads
,
754 @findex info iothreads
755 Show iothread
's identifiers.
760 .args_type = "name:s",
762 .help = "Show rocker switch",
767 @item info rocker @var{name}
773 .name = "rocker-ports",
774 .args_type = "name:s",
776 .help = "Show rocker ports",
777 .cmd = hmp_rocker_ports,
781 @item info rocker-ports @var{name}-ports
782 @findex info rocker-ports
787 .name = "rocker-of-dpa-flows",
788 .args_type = "name:s,tbl_id:i?",
789 .params = "name [tbl_id]",
790 .help = "Show rocker OF-DPA flow tables",
791 .cmd = hmp_rocker_of_dpa_flows,
795 @item info rocker-of-dpa-flows @var{name} [@var{tbl_id}]
796 @findex info rocker-of-dpa-flows
797 Show rocker OF-DPA flow tables.
801 .name = "rocker-of-dpa-groups",
802 .args_type = "name:s,type:i?",
803 .params = "name [type]",
804 .help = "Show rocker OF-DPA groups",
805 .cmd = hmp_rocker_of_dpa_groups,
809 @item info rocker-of-dpa-groups @var{name} [@var{type}]
810 @findex info rocker-of-dpa-groups
811 Show rocker OF-DPA groups.
814 #if defined(TARGET_S390X)
817 .args_type = "addr:l",
819 .help = "Display the value of a storage key",
820 .cmd = hmp_info_skeys,
825 @item info skeys @var{address}
827 Display the value of a storage key (s390 only)
830 #if defined(TARGET_S390X)
833 .args_type = "addr:l,count:l?",
834 .params = "address [count]",
835 .help = "Display the values of the CMMA storage attributes for a range of pages",
836 .cmd = hmp_info_cmma,
841 @item info cmma @var{address}
843 Display the values of the CMMA storage attributes for a range of pages (s390 only)
850 .help = "Display the latest dump status",
851 .cmd = hmp_info_dump,
857 Display the latest dump status.
864 .help = "Display system ramblock information",
865 .cmd = hmp_info_ramblock,
870 @findex info ramblock
871 Dump all the ramblocks of the system.
875 .name = "hotpluggable-cpus",
878 .help = "Show information about hotpluggable CPUs",
879 .cmd = hmp_hotpluggable_cpus,
884 @item info hotpluggable-cpus
885 @findex info hotpluggable-cpus
886 Show information about hotpluggable CPUs
890 .name = "vm-generation-id",
893 .help = "Show Virtual Machine Generation ID",
894 .cmd = hmp_info_vm_generation_id,
898 @item info vm-generation-id
899 @findex info vm-generation-id
900 Show Virtual Machine Generation ID
904 .name = "memory_size_summary",
907 .help = "show the amount of initially allocated and "
908 "present hotpluggable (if enabled) memory in bytes.",
909 .cmd = hmp_info_memory_size_summary,
913 @item info memory_size_summary
914 @findex info memory_size_summary
915 Display the amount of initially allocated and present hotpluggable (if
916 enabled) memory in bytes.
919 #if defined(TARGET_I386)
924 .help = "show SEV information",
932 Show SEV information.