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
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 @item info @
var{subcommand
}
18 Show various information about the system state
.
23 Show various information about the system state
.
31 .help
= "show the version of QEMU",
32 .cmd
= hmp_info_version
,
39 Show the version of QEMU
.
43 Show the version of QEMU
.
50 .help
= "show the network state",
51 .cmd
= hmp_info_network
,
57 Show the network state
.
61 Show the network state
.
68 .help
= "show the character devices",
69 .cmd
= hmp_info_chardev
,
76 Show the character devices
.
80 Show the character devices
.
85 .args_type
= "nodes:-n,verbose:-v,device:B?",
86 .params
= "[-n] [-v] [device]",
87 .help
= "show info of one block device or all block devices "
88 "(-n: show named nodes; -v: show details)",
89 .cmd
= hmp_info_block
,
95 Show info of one block device or all block devices
.
99 Show info of one block device or all block devices
.
103 .name
= "blockstats",
106 .help
= "show block device statistics",
107 .cmd
= hmp_info_blockstats
,
111 @item info blockstats
112 @findex info blockstats
113 Show block device statistics
.
117 Show block device statistics
.
121 .name
= "block-jobs",
124 .help
= "show progress of ongoing block device operations",
125 .cmd
= hmp_info_block_jobs
,
129 @item info block
-jobs
130 @findex info block
-jobs
131 Show progress of ongoing block device operations
.
135 Show progress of ongoing block device operations
.
140 .args_type
= "cpustate_all:-a",
142 .help
= "show the cpu registers (-a: all - show register info for all cpus)",
143 .cmd
= hmp_info_registers
,
148 @findex info registers
149 Show the cpu registers
.
153 Show the cpu registers
.
156 #
if defined(TARGET_I386
)
159 .args_type
= "apic-id:i?",
160 .params
= "[apic-id]",
161 .help
= "show local apic state (apic-id: local apic to read, default is which of current CPU)",
163 .cmd
= hmp_info_local_apic
,
170 Show local APIC state
174 Show local APIC state
177 #
if defined(TARGET_I386
)
182 .help
= "show io apic state",
183 .cmd
= hmp_info_io_apic
,
201 .help
= "show infos for each CPU",
202 .cmd
= hmp_info_cpus
,
208 Show infos
for each CPU
.
212 Show infos
for each CPU
.
219 .help
= "show the command line history",
220 .cmd
= hmp_info_history
,
227 Show the command line history
.
231 Show the command line history
.
238 .help
= "show the interrupts statistics (if available)",
245 Show the interrupts
statistics (if available
).
249 Show the interrupts
statistics (if available
).
256 .help
= "show PIC state",
274 .help
= "show RDMA state",
275 .cmd
= hmp_info_rdma
,
292 .help
= "show PCI info",
299 Show PCI information
.
303 Show PCI information
.
306 #
if defined(TARGET_I386
) ||
defined(TARGET_SH4
) ||
defined(TARGET_SPARC
) || \
307 defined(TARGET_PPC
) ||
defined(TARGET_XTENSA
) ||
defined(TARGET_M68K
)
312 .help
= "show virtual to physical memory mappings",
320 Show virtual to physical memory mappings
.
324 Show virtual to physical memory mappings
.
327 #
if defined(TARGET_I386
) ||
defined(TARGET_RISCV
)
332 .help
= "show the active virtual memory mappings",
340 Show the active virtual memory mappings
.
344 Show the active virtual memory mappings
.
349 .args_type
= "flatview:-f,dispatch_tree:-d,owner:-o",
350 .params
= "[-f][-d][-o]",
351 .help
= "show memory tree (-f: dump flat view for address spaces;"
352 "-d: dump dispatch tree, valid with -f only);"
353 "-o: dump region owners/parents",
354 .cmd
= hmp_info_mtree
,
367 #
if defined(CONFIG_TCG
)
372 .help
= "show dynamic compiler info",
380 Show
dynamic compiler info
.
384 Show
dynamic compiler info
.
387 #
if defined(CONFIG_TCG
)
392 .help
= "show dynamic compiler opcode counters",
393 .cmd
= hmp_info_opcount
,
400 Show
dynamic compiler opcode counters
404 Show
dynamic compiler opcode counters
408 .name
= "sync-profile",
409 .args_type
= "mean:-m,no_coalesce:-n,max:i?",
410 .params
= "[-m] [-n] [max]",
411 .help
= "show synchronization profiling info, up to max entries "
412 "(default: 10), sorted by total wait time. (-m: sort by "
413 "mean wait time; -n: do not coalesce objects with the "
415 .cmd
= hmp_info_sync_profile
,
419 @item info sync
-profile
[-m|
-n
] [@
var{max
}]
420 @findex info sync
-profile
421 Show synchronization profiling info
, up to @
var{max
} entries (default: 10),
422 sorted by total wait time
.
423 -m
: sort by mean wait time
424 -n
: do not coalesce objects with the same call site
425 When different objects that share the same call site are coalesced
, the
"Object"
426 field shows
---enclosed
in brackets
---the number of objects being coalesced
.
429 ``info sync
-profile
[-m|
-n
]``
[*max
*]
430 Show synchronization profiling info
, up to
*max
* entries (default: 10),
431 sorted by total wait time
.
434 sort by mean wait time
436 do not coalesce objects with the same call site
438 When different objects that share the same call site are coalesced
,
439 the
"Object" field shows
---enclosed
in brackets
---the number of objects
447 .help
= "show KVM information",
454 Show KVM information
.
458 Show KVM information
.
465 .help
= "show NUMA information",
466 .cmd
= hmp_info_numa
,
472 Show NUMA information
.
476 Show NUMA information
.
483 .help
= "show guest USB devices",
490 Show guest USB devices
.
494 Show guest USB devices
.
501 .help
= "show host USB devices",
502 .cmd
= hmp_info_usbhost
,
508 Show host USB devices
.
512 Show host USB devices
.
519 .help
= "show profiling information",
520 .cmd
= hmp_info_profile
,
526 Show profiling information
.
530 Show profiling information
.
537 .help
= "show capture information",
538 .cmd
= hmp_info_capture
,
544 Show capture information
.
548 Show capture information
.
555 .help
= "show the currently saved VM snapshots",
556 .cmd
= hmp_info_snapshots
,
561 @findex info snapshots
562 Show the currently saved VM snapshots
.
566 Show the currently saved VM snapshots
.
573 .help
= "show the current VM status (running|paused)",
574 .cmd
= hmp_info_status
,
581 Show the current VM
status (running|paused
).
585 Show the current VM
status (running|paused
).
592 .help
= "show which guest mouse is receiving events",
593 .cmd
= hmp_info_mice
,
599 Show which guest mouse is receiving events
.
603 Show which guest mouse is receiving events
.
606 #
if defined(CONFIG_VNC
)
611 .help
= "show the vnc server status",
619 Show the vnc server status
.
623 Show the vnc server status
.
626 #
if defined(CONFIG_SPICE
)
631 .help
= "show the spice server status",
632 .cmd
= hmp_info_spice
,
639 Show the spice server status
.
643 Show the spice server status
.
650 .help
= "show the current VM name",
651 .cmd
= hmp_info_name
,
658 Show the current VM name
.
662 Show the current VM name
.
669 .help
= "show the current VM UUID",
670 .cmd
= hmp_info_uuid
,
677 Show the current VM UUID
.
681 Show the current VM UUID
.
688 .help
= "show CPU statistics",
689 .cmd
= hmp_info_cpustats
,
694 @findex info cpustats
702 #
if defined(CONFIG_SLIRP
)
707 .help
= "show user network stack connection states",
708 .cmd
= hmp_info_usernet
,
715 Show user network stack connection states
.
719 Show user network stack connection states
.
726 .help
= "show migration status",
727 .cmd
= hmp_info_migrate
,
733 Show migration status
.
737 Show migration status
.
741 .name
= "migrate_capabilities",
744 .help
= "show current migration capabilities",
745 .cmd
= hmp_info_migrate_capabilities
,
749 @item info migrate_capabilities
750 @findex info migrate_capabilities
751 Show current migration capabilities
.
754 ``info migrate_capabilities``
755 Show current migration capabilities
.
759 .name
= "migrate_parameters",
762 .help
= "show current migration parameters",
763 .cmd
= hmp_info_migrate_parameters
,
767 @item info migrate_parameters
768 @findex info migrate_parameters
769 Show current migration parameters
.
772 ``info migrate_parameters``
773 Show current migration parameters
.
777 .name
= "migrate_cache_size",
780 .help
= "show current migration xbzrle cache size",
781 .cmd
= hmp_info_migrate_cache_size
,
785 @item info migrate_cache_size
786 @findex info migrate_cache_size
787 Show current migration xbzrle cache size
.
790 ``info migrate_cache_size``
791 Show current migration xbzrle cache size
.
798 .help
= "show balloon information",
799 .cmd
= hmp_info_balloon
,
805 Show balloon information
.
809 Show balloon information
.
816 .help
= "show device tree",
817 .cmd
= hmp_info_qtree
,
834 .help
= "show qdev device model list",
841 Show qdev device model list
.
845 Show qdev device model list
.
850 .args_type
= "path:s?",
852 .help
= "show QOM composition tree",
853 .cmd
= hmp_info_qom_tree
,
859 @findex info qom
-tree
860 Show QOM composition tree
.
864 Show QOM composition tree
.
872 .cmd
= hmp_info_roms
,
886 .name
= "trace-events",
887 .args_type
= "name:s?,vcpu:i?",
888 .params
= "[name] [vcpu]",
889 .help
= "show available trace-events & their state "
890 "(name: event name pattern; vcpu: vCPU to query, default is any)",
891 .cmd
= hmp_info_trace_events
,
892 .command_completion
= info_trace_events_completion
,
896 @item info
trace-events
897 @findex info
trace-events
898 Show available
trace-events
& their state
.
901 ``info
trace-events``
902 Show available
trace-events
& their state
.
909 .help
= "show the TPM device",
927 .help
= "show memory backends",
928 .cmd
= hmp_info_memdev
,
943 .name
= "memory-devices",
946 .help
= "show memory devices",
947 .cmd
= hmp_info_memory_devices
,
951 @item info memory
-devices
952 @findex info memory
-devices
956 ``info memory
-devices``
964 .help
= "show iothreads",
965 .cmd
= hmp_info_iothreads
,
971 @findex info iothreads
972 Show iothread
's identifiers.
976 Show iothread's identifiers
.
981 .args_type
= "name:s",
983 .help
= "Show rocker switch",
988 @item info rocker @
var{name
}
993 ``info rocker``
*name
*
998 .name
= "rocker-ports",
999 .args_type
= "name:s",
1001 .help
= "Show rocker ports",
1002 .cmd
= hmp_rocker_ports
,
1006 @item info rocker
-ports @
var{name
}-ports
1007 @findex info rocker
-ports
1011 ``info rocker
-ports``
*name
*-ports
1016 .name
= "rocker-of-dpa-flows",
1017 .args_type
= "name:s,tbl_id:i?",
1018 .params
= "name [tbl_id]",
1019 .help
= "Show rocker OF-DPA flow tables",
1020 .cmd
= hmp_rocker_of_dpa_flows
,
1024 @item info rocker
-of
-dpa
-flows @
var{name
} [@
var{tbl_id
}]
1025 @findex info rocker
-of
-dpa
-flows
1026 Show rocker OF
-DPA flow tables
.
1029 ``info rocker
-of
-dpa
-flows``
*name
* [*tbl_id
*]
1030 Show rocker OF
-DPA flow tables
.
1034 .name
= "rocker-of-dpa-groups",
1035 .args_type
= "name:s,type:i?",
1036 .params
= "name [type]",
1037 .help
= "Show rocker OF-DPA groups",
1038 .cmd
= hmp_rocker_of_dpa_groups
,
1042 @item info rocker
-of
-dpa
-groups @
var{name
} [@
var{type
}]
1043 @findex info rocker
-of
-dpa
-groups
1044 Show rocker OF
-DPA groups
.
1047 ``info rocker
-of
-dpa
-groups``
*name
* [*type
*]
1048 Show rocker OF
-DPA groups
.
1051 #
if defined(TARGET_S390X
)
1054 .args_type
= "addr:l",
1055 .params
= "address",
1056 .help
= "Display the value of a storage key",
1057 .cmd
= hmp_info_skeys
,
1062 @item info skeys @
var{address
}
1064 Display the value of a storage
key (s390 only
)
1067 ``info skeys``
*address
*
1068 Display the value of a storage
key (s390 only
)
1071 #
if defined(TARGET_S390X
)
1074 .args_type
= "addr:l,count:l?",
1075 .params
= "address [count]",
1076 .help
= "Display the values of the CMMA storage attributes for a range of pages",
1077 .cmd
= hmp_info_cmma
,
1082 @item info cmma @
var{address
}
1084 Display the values of the CMMA storage attributes
for a range of
pages (s390 only
)
1087 ``info cmma``
*address
*
1088 Display the values of the CMMA storage attributes
for a range of
1096 .help
= "Display the latest dump status",
1097 .cmd
= hmp_info_dump
,
1103 Display the latest dump status
.
1107 Display the latest dump status
.
1114 .help
= "Display system ramblock information",
1115 .cmd
= hmp_info_ramblock
,
1120 @findex info ramblock
1121 Dump all the ramblocks of the system
.
1125 Dump all the ramblocks of the system
.
1129 .name
= "hotpluggable-cpus",
1132 .help
= "Show information about hotpluggable CPUs",
1133 .cmd
= hmp_hotpluggable_cpus
,
1138 @item info hotpluggable
-cpus
1139 @findex info hotpluggable
-cpus
1140 Show information about hotpluggable CPUs
1143 ``info hotpluggable
-cpus``
1144 Show information about hotpluggable CPUs
1148 .name
= "vm-generation-id",
1151 .help
= "Show Virtual Machine Generation ID",
1152 .cmd
= hmp_info_vm_generation_id
,
1156 @item info vm
-generation
-id
1157 @findex info vm
-generation
-id
1158 Show Virtual Machine Generation ID
1161 ``info vm
-generation
-id``
1162 Show Virtual Machine Generation ID
1166 .name
= "memory_size_summary",
1169 .help
= "show the amount of initially allocated and "
1170 "present hotpluggable (if enabled) memory in bytes.",
1171 .cmd
= hmp_info_memory_size_summary
,
1175 @item info memory_size_summary
1176 @findex info memory_size_summary
1177 Display the amount of initially allocated and present
hotpluggable (if
1178 enabled
) memory
in bytes
.
1181 ``info memory_size_summary``
1182 Display the amount of initially allocated and present
hotpluggable (if
1183 enabled
) memory
in bytes
.
1186 #
if defined(TARGET_I386
)
1191 .help
= "show SEV information",
1192 .cmd
= hmp_info_sev
,
1199 Show SEV information
.
1203 Show SEV information
.