1 HXCOMM See docs/devel/docs.rst for the format of this file.
3 HXCOMM This file defines the contents of an array of HMPCommand structs
4 HXCOMM which specify the name, behaviour and help text for HMP commands.
5 HXCOMM Text between SRST and ERST is rST format documentation.
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 PCI info",
195 Show PCI information.
198 #if defined(TARGET_I386) || defined(TARGET_SH4) || defined(TARGET_SPARC) || \
199 defined(TARGET_PPC) || defined(TARGET_XTENSA) || defined(TARGET_M68K)
204 .help = "show virtual to physical memory mappings",
211 Show virtual to physical memory mappings.
214 #if defined(TARGET_I386) || defined(TARGET_RISCV)
219 .help = "show the active virtual memory mappings",
226 Show the active virtual memory mappings.
231 .args_type = "flatview:-f,dispatch_tree:-d,owner:-o,disabled:-D",
232 .params = "[-f][-d][-o][-D]",
233 .help = "show memory tree (-f: dump flat view for address spaces;"
234 "-d: dump dispatch tree, valid with -f only);"
235 "-o: dump region owners/parents;"
236 "-D: dump disabled regions",
237 .cmd = hmp_info_mtree,
245 #if defined(CONFIG_TCG)
250 .help = "show dynamic compiler info",
256 Show dynamic compiler info.
259 #if defined(CONFIG_TCG)
264 .help = "show dynamic compiler opcode counters",
270 Show dynamic compiler opcode counters
274 .name = "sync-profile",
275 .args_type = "mean:-m,no_coalesce:-n,max:i?",
276 .params = "[-m] [-n] [max]",
277 .help = "show synchronization profiling info, up to max entries "
278 "(default: 10), sorted by total wait time. (-m: sort by "
279 "mean wait time; -n: do not coalesce objects with the "
281 .cmd = hmp_info_sync_profile,
285 ``info sync-profile [-m|-n]`` [*max*]
286 Show synchronization profiling info, up to *max* entries (default: 10),
287 sorted by total wait time.
290 sort by mean wait time
292 do not coalesce objects with the same call site
294 When different objects that share the same call site are coalesced,
295 the "Object" field shows---enclosed in brackets---the number of objects
303 .help = "show KVM information",
309 Show KVM information.
316 .help = "show NUMA information",
317 .cmd_info_hrt = qmp_x_query_numa,
322 Show NUMA information.
329 .help = "show guest USB devices",
330 .cmd_info_hrt = qmp_x_query_usb,
335 Show guest USB devices.
342 .help = "show host USB devices",
347 Show host USB devices.
354 .help = "show capture information",
355 .cmd = hmp_info_capture,
360 Show capture information.
367 .help = "show the currently saved VM snapshots",
368 .cmd = hmp_info_snapshots,
373 Show the currently saved VM snapshots.
380 .help = "show the current VM status (running|paused)",
381 .cmd = hmp_info_status,
387 Show the current VM status (running|paused).
394 .help = "show which guest mouse is receiving events",
395 .cmd = hmp_info_mice,
400 Show which guest mouse is receiving events.
403 #if defined(CONFIG_VNC)
408 .help = "show the vnc server status",
415 Show the vnc server status.
418 #if defined(CONFIG_SPICE)
423 .help = "show the spice server status",
424 .cmd = hmp_info_spice,
430 Show the spice server status.
437 .help = "show the current VM name",
438 .cmd = hmp_info_name,
444 Show the current VM name.
451 .help = "show the current VM UUID",
452 .cmd = hmp_info_uuid,
458 Show the current VM UUID.
461 #if defined(CONFIG_SLIRP)
466 .help = "show user network stack connection states",
467 .cmd = hmp_info_usernet,
473 Show user network stack connection states.
480 .help = "show migration status",
481 .cmd = hmp_info_migrate,
486 Show migration status.
490 .name = "migrate_capabilities",
493 .help = "show current migration capabilities",
494 .cmd = hmp_info_migrate_capabilities,
498 ``info migrate_capabilities``
499 Show current migration capabilities.
503 .name = "migrate_parameters",
506 .help = "show current migration parameters",
507 .cmd = hmp_info_migrate_parameters,
511 ``info migrate_parameters``
512 Show current migration parameters.
519 .help = "show balloon information",
520 .cmd = hmp_info_balloon,
525 Show balloon information.
530 .args_type = "brief:-b",
532 .help = "show device tree (-b: brief, omit properties)",
533 .cmd = hmp_info_qtree,
545 .help = "show qdev device model list",
551 Show qdev device model list.
556 .args_type = "path:s?",
558 .help = "show QOM composition tree",
559 .cmd = hmp_info_qom_tree,
565 Show QOM composition tree.
573 .cmd_info_hrt = qmp_x_query_roms,
582 .name = "trace-events",
583 .args_type = "name:s?,vcpu:i?",
584 .params = "[name] [vcpu]",
585 .help = "show available trace-events & their state "
586 "(name: event name pattern; vcpu: vCPU to query, default is any)",
587 .cmd = hmp_info_trace_events,
588 .command_completion = info_trace_events_completion,
592 ``info trace-events``
593 Show available trace-events & their state.
600 .help = "show the TPM device",
613 .help = "show memory backends",
614 .cmd = hmp_info_memdev,
624 .name = "memory-devices",
627 .help = "show memory devices",
628 .cmd = hmp_info_memory_devices,
632 ``info memory-devices``
640 .help = "show iothreads",
641 .cmd = hmp_info_iothreads,
647 Show iothread's identifiers.
652 .args_type = "name:s",
654 .help = "Show rocker switch",
659 ``info rocker`` *name*
664 .name = "rocker-ports",
665 .args_type = "name:s",
667 .help = "Show rocker ports",
668 .cmd = hmp_rocker_ports,
672 ``info rocker-ports`` *name*-ports
677 .name = "rocker-of-dpa-flows",
678 .args_type = "name:s,tbl_id:i?",
679 .params = "name [tbl_id]",
680 .help = "Show rocker OF-DPA flow tables",
681 .cmd = hmp_rocker_of_dpa_flows,
685 ``info rocker-of-dpa-flows`` *name* [*tbl_id*]
686 Show rocker OF-DPA flow tables.
690 .name = "rocker-of-dpa-groups",
691 .args_type = "name:s,type:i?",
692 .params = "name [type]",
693 .help = "Show rocker OF-DPA groups",
694 .cmd = hmp_rocker_of_dpa_groups,
698 ``info rocker-of-dpa-groups`` *name* [*type*]
699 Show rocker OF-DPA groups.
702 #if defined(TARGET_S390X)
705 .args_type = "addr:l",
707 .help = "Display the value of a storage key",
708 .cmd = hmp_info_skeys,
713 ``info skeys`` *address*
714 Display the value of a storage key (s390 only)
717 #if defined(TARGET_S390X)
720 .args_type = "addr:l,count:l?",
721 .params = "address [count]",
722 .help = "Display the values of the CMMA storage attributes for a range of pages",
723 .cmd = hmp_info_cmma,
728 ``info cmma`` *address*
729 Display the values of the CMMA storage attributes for a range of
737 .help = "Display the latest dump status",
738 .cmd = hmp_info_dump,
743 Display the latest dump status.
750 .help = "Display system ramblock information",
751 .cmd_info_hrt = qmp_x_query_ramblock,
756 Dump all the ramblocks of the system.
760 .name = "hotpluggable-cpus",
763 .help = "Show information about hotpluggable CPUs",
764 .cmd = hmp_hotpluggable_cpus,
769 ``info hotpluggable-cpus``
770 Show information about hotpluggable CPUs
774 .name = "vm-generation-id",
777 .help = "Show Virtual Machine Generation ID",
778 .cmd = hmp_info_vm_generation_id,
782 ``info vm-generation-id``
783 Show Virtual Machine Generation ID
787 .name = "memory_size_summary",
790 .help = "show the amount of initially allocated and "
791 "present hotpluggable (if enabled) memory in bytes.",
792 .cmd = hmp_info_memory_size_summary,
796 ``info memory_size_summary``
797 Display the amount of initially allocated and present hotpluggable (if
798 enabled) memory in bytes.
801 #if defined(TARGET_I386)
806 .help = "show SEV information",
813 Show SEV information.
820 .help = "show record/replay information",
821 .cmd = hmp_info_replay,
826 Display the record/replay information: mode and the current icount.
830 .name = "dirty_rate",
833 .help = "show dirty rate information",
834 .cmd = hmp_info_dirty_rate,
839 Display the vcpu dirty rate information.
843 .name = "vcpu_dirty_limit",
846 .help = "show dirty page limit information of all vCPU",
847 .cmd = hmp_info_vcpu_dirty_limit,
851 ``info vcpu_dirty_limit``
852 Display the vcpu dirty page limit information.
855 #if defined(TARGET_I386)
860 .help = "show intel SGX information",
867 Show intel SGX information.
870 #if defined(CONFIG_MOS6522)
875 .help = "show guest mos6522 VIA devices",
882 Show guest mos6522 VIA devices.
887 .args_type = "target:s,names:s?,provider:s?",
888 .params = "target [names] [provider]",
889 .help = "show statistics for the given target (vm or vcpu); optionally filter by"
890 "name (comma-separated list, or * for all) and provider",
891 .cmd = hmp_info_stats,
896 Show runtime-collected statistics
903 .help = "List all available virtio devices",
904 .cmd = hmp_virtio_query,
910 List all available virtio devices
914 .name = "virtio-status",
915 .args_type = "path:s",
917 .help = "Display status of a given virtio device",
918 .cmd = hmp_virtio_status,
923 ``info virtio-status`` *path*
924 Display status of a given virtio device
928 .name = "virtio-queue-status",
929 .args_type = "path:s,queue:i",
930 .params = "path queue",
931 .help = "Display status of a given virtio queue",
932 .cmd = hmp_virtio_queue_status,
937 ``info virtio-queue-status`` *path* *queue*
938 Display status of a given virtio queue
942 .name = "virtio-vhost-queue-status",
943 .args_type = "path:s,queue:i",
944 .params = "path queue",
945 .help = "Display status of a given vhost queue",
946 .cmd = hmp_vhost_queue_status,
951 ``info virtio-vhost-queue-status`` *path* *queue*
952 Display status of a given vhost queue
956 .name = "virtio-queue-element",
957 .args_type = "path:s,queue:i,index:i?",
958 .params = "path queue [index]",
959 .help = "Display element of a given virtio queue",
960 .cmd = hmp_virtio_queue_element,
965 ``info virtio-queue-element`` *path* *queue* [*index*]
966 Display element of a given virtio queue
973 .help = "show the crypto devices",
974 .cmd = hmp_info_cryptodev,
980 Show the crypto devices.