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.
367 .help = "show capture information",
368 .cmd = hmp_info_capture,
373 Show capture information.
380 .help = "show the currently saved VM snapshots",
381 .cmd = hmp_info_snapshots,
386 Show the currently saved VM snapshots.
393 .help = "show the current VM status (running|paused)",
394 .cmd = hmp_info_status,
400 Show the current VM status (running|paused).
407 .help = "show which guest mouse is receiving events",
408 .cmd = hmp_info_mice,
413 Show which guest mouse is receiving events.
416 #if defined(CONFIG_VNC)
421 .help = "show the vnc server status",
428 Show the vnc server status.
431 #if defined(CONFIG_SPICE)
436 .help = "show the spice server status",
437 .cmd = hmp_info_spice,
443 Show the spice server status.
450 .help = "show the current VM name",
451 .cmd = hmp_info_name,
457 Show the current VM name.
464 .help = "show the current VM UUID",
465 .cmd = hmp_info_uuid,
471 Show the current VM UUID.
474 #if defined(CONFIG_SLIRP)
479 .help = "show user network stack connection states",
480 .cmd = hmp_info_usernet,
486 Show user network stack connection states.
493 .help = "show migration status",
494 .cmd = hmp_info_migrate,
499 Show migration status.
503 .name = "migrate_capabilities",
506 .help = "show current migration capabilities",
507 .cmd = hmp_info_migrate_capabilities,
511 ``info migrate_capabilities``
512 Show current migration capabilities.
516 .name = "migrate_parameters",
519 .help = "show current migration parameters",
520 .cmd = hmp_info_migrate_parameters,
524 ``info migrate_parameters``
525 Show current migration parameters.
532 .help = "show balloon information",
533 .cmd = hmp_info_balloon,
538 Show balloon information.
545 .help = "show device tree",
546 .cmd = hmp_info_qtree,
558 .help = "show qdev device model list",
564 Show qdev device model list.
569 .args_type = "path:s?",
571 .help = "show QOM composition tree",
572 .cmd = hmp_info_qom_tree,
578 Show QOM composition tree.
586 .cmd_info_hrt = qmp_x_query_roms,
595 .name = "trace-events",
596 .args_type = "name:s?,vcpu:i?",
597 .params = "[name] [vcpu]",
598 .help = "show available trace-events & their state "
599 "(name: event name pattern; vcpu: vCPU to query, default is any)",
600 .cmd = hmp_info_trace_events,
601 .command_completion = info_trace_events_completion,
605 ``info trace-events``
606 Show available trace-events & their state.
613 .help = "show the TPM device",
626 .help = "show memory backends",
627 .cmd = hmp_info_memdev,
637 .name = "memory-devices",
640 .help = "show memory devices",
641 .cmd = hmp_info_memory_devices,
645 ``info memory-devices``
653 .help = "show iothreads",
654 .cmd = hmp_info_iothreads,
660 Show iothread's identifiers.
665 .args_type = "name:s",
667 .help = "Show rocker switch",
672 ``info rocker`` *name*
677 .name = "rocker-ports",
678 .args_type = "name:s",
680 .help = "Show rocker ports",
681 .cmd = hmp_rocker_ports,
685 ``info rocker-ports`` *name*-ports
690 .name = "rocker-of-dpa-flows",
691 .args_type = "name:s,tbl_id:i?",
692 .params = "name [tbl_id]",
693 .help = "Show rocker OF-DPA flow tables",
694 .cmd = hmp_rocker_of_dpa_flows,
698 ``info rocker-of-dpa-flows`` *name* [*tbl_id*]
699 Show rocker OF-DPA flow tables.
703 .name = "rocker-of-dpa-groups",
704 .args_type = "name:s,type:i?",
705 .params = "name [type]",
706 .help = "Show rocker OF-DPA groups",
707 .cmd = hmp_rocker_of_dpa_groups,
711 ``info rocker-of-dpa-groups`` *name* [*type*]
712 Show rocker OF-DPA groups.
715 #if defined(TARGET_S390X)
718 .args_type = "addr:l",
720 .help = "Display the value of a storage key",
721 .cmd = hmp_info_skeys,
726 ``info skeys`` *address*
727 Display the value of a storage key (s390 only)
730 #if defined(TARGET_S390X)
733 .args_type = "addr:l,count:l?",
734 .params = "address [count]",
735 .help = "Display the values of the CMMA storage attributes for a range of pages",
736 .cmd = hmp_info_cmma,
741 ``info cmma`` *address*
742 Display the values of the CMMA storage attributes for a range of
750 .help = "Display the latest dump status",
751 .cmd = hmp_info_dump,
756 Display the latest dump status.
763 .help = "Display system ramblock information",
764 .cmd_info_hrt = qmp_x_query_ramblock,
769 Dump all the ramblocks of the system.
773 .name = "hotpluggable-cpus",
776 .help = "Show information about hotpluggable CPUs",
777 .cmd = hmp_hotpluggable_cpus,
782 ``info hotpluggable-cpus``
783 Show information about hotpluggable CPUs
787 .name = "vm-generation-id",
790 .help = "Show Virtual Machine Generation ID",
791 .cmd = hmp_info_vm_generation_id,
795 ``info vm-generation-id``
796 Show Virtual Machine Generation ID
800 .name = "memory_size_summary",
803 .help = "show the amount of initially allocated and "
804 "present hotpluggable (if enabled) memory in bytes.",
805 .cmd = hmp_info_memory_size_summary,
809 ``info memory_size_summary``
810 Display the amount of initially allocated and present hotpluggable (if
811 enabled) memory in bytes.
814 #if defined(TARGET_I386)
819 .help = "show SEV information",
826 Show SEV information.
833 .help = "show record/replay information",
834 .cmd = hmp_info_replay,
839 Display the record/replay information: mode and the current icount.
843 .name = "dirty_rate",
846 .help = "show dirty rate information",
847 .cmd = hmp_info_dirty_rate,
852 Display the vcpu dirty rate information.
856 .name = "vcpu_dirty_limit",
859 .help = "show dirty page limit information of all vCPU",
860 .cmd = hmp_info_vcpu_dirty_limit,
864 ``info vcpu_dirty_limit``
865 Display the vcpu dirty page limit information.
868 #if defined(TARGET_I386)
873 .help = "show intel SGX information",
880 Show intel SGX information.
883 #if defined(CONFIG_MOS6522)
888 .help = "show guest mos6522 VIA devices",
895 Show guest mos6522 VIA devices.
900 .args_type = "target:s,names:s?,provider:s?",
901 .params = "target [names] [provider]",
902 .help = "show statistics for the given target (vm or vcpu); optionally filter by"
903 "name (comma-separated list, or * for all) and provider",
904 .cmd = hmp_info_stats,
909 Show runtime-collected statistics
916 .help = "List all available virtio devices",
917 .cmd = hmp_virtio_query,
923 List all available virtio devices
927 .name = "virtio-status",
928 .args_type = "path:s",
930 .help = "Display status of a given virtio device",
931 .cmd = hmp_virtio_status,
936 ``info virtio-status`` *path*
937 Display status of a given virtio device
941 .name = "virtio-queue-status",
942 .args_type = "path:s,queue:i",
943 .params = "path queue",
944 .help = "Display status of a given virtio queue",
945 .cmd = hmp_virtio_queue_status,
950 ``info virtio-queue-status`` *path* *queue*
951 Display status of a given virtio queue
955 .name = "virtio-vhost-queue-status",
956 .args_type = "path:s,queue:i",
957 .params = "path queue",
958 .help = "Display status of a given vhost queue",
959 .cmd = hmp_vhost_queue_status,
964 ``info virtio-vhost-queue-status`` *path* *queue*
965 Display status of a given vhost queue
969 .name = "virtio-queue-element",
970 .args_type = "path:s,queue:i,index:i?",
971 .params = "path queue [index]",
972 .help = "Display element of a given virtio queue",
973 .cmd = hmp_virtio_queue_element,
978 ``info virtio-queue-element`` *path* *queue* [*index*]
979 Display element of a given virtio queue
986 .help = "show the crypto devices",
987 .cmd = hmp_info_cryptodev,
993 Show the crypto devices.