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",
105 .help = "show the cpu registers (-a: all - show register info for all cpus)",
106 .cmd = hmp_info_registers,
111 Show the cpu registers.
114 #if defined(TARGET_I386)
117 .args_type = "apic-id:i?",
118 .params = "[apic-id]",
119 .help = "show local apic state (apic-id: local apic to read, default is which of current CPU)",
121 .cmd = hmp_info_local_apic,
127 Show local APIC state
134 .help = "show infos for each CPU",
135 .cmd = hmp_info_cpus,
140 Show infos for each CPU.
147 .help = "show the command line history",
148 .cmd = hmp_info_history,
154 Show the command line history.
161 .help = "show the interrupts statistics (if available)",
162 .cmd_info_hrt = qmp_x_query_irq,
167 Show the interrupts statistics (if available).
174 .help = "show PIC state",
187 .help = "show RDMA state",
188 .cmd_info_hrt = qmp_x_query_rdma,
200 .help = "show PCI info",
206 Show PCI information.
209 #if defined(TARGET_I386) || defined(TARGET_SH4) || defined(TARGET_SPARC) || \
210 defined(TARGET_PPC) || defined(TARGET_XTENSA) || defined(TARGET_M68K)
215 .help = "show virtual to physical memory mappings",
222 Show virtual to physical memory mappings.
225 #if defined(TARGET_I386) || defined(TARGET_RISCV)
230 .help = "show the active virtual memory mappings",
237 Show the active virtual memory mappings.
242 .args_type = "flatview:-f,dispatch_tree:-d,owner:-o,disabled:-D",
243 .params = "[-f][-d][-o][-D]",
244 .help = "show memory tree (-f: dump flat view for address spaces;"
245 "-d: dump dispatch tree, valid with -f only);"
246 "-o: dump region owners/parents;"
247 "-D: dump disabled regions",
248 .cmd = hmp_info_mtree,
256 #if defined(CONFIG_TCG)
261 .help = "show dynamic compiler info",
267 Show dynamic compiler info.
270 #if defined(CONFIG_TCG)
275 .help = "show dynamic compiler opcode counters",
281 Show dynamic compiler opcode counters
285 .name = "sync-profile",
286 .args_type = "mean:-m,no_coalesce:-n,max:i?",
287 .params = "[-m] [-n] [max]",
288 .help = "show synchronization profiling info, up to max entries "
289 "(default: 10), sorted by total wait time. (-m: sort by "
290 "mean wait time; -n: do not coalesce objects with the "
292 .cmd = hmp_info_sync_profile,
296 ``info sync-profile [-m|-n]`` [*max*]
297 Show synchronization profiling info, up to *max* entries (default: 10),
298 sorted by total wait time.
301 sort by mean wait time
303 do not coalesce objects with the same call site
305 When different objects that share the same call site are coalesced,
306 the "Object" field shows---enclosed in brackets---the number of objects
314 .help = "show KVM information",
320 Show KVM information.
327 .help = "show NUMA information",
328 .cmd_info_hrt = qmp_x_query_numa,
333 Show NUMA information.
340 .help = "show guest USB devices",
341 .cmd_info_hrt = qmp_x_query_usb,
346 Show guest USB devices.
353 .help = "show host USB devices",
358 Show host USB devices.
365 .help = "show profiling information",
366 .cmd_info_hrt = qmp_x_query_profile,
371 Show profiling information.
378 .help = "show capture information",
379 .cmd = hmp_info_capture,
384 Show capture information.
391 .help = "show the currently saved VM snapshots",
392 .cmd = hmp_info_snapshots,
397 Show the currently saved VM snapshots.
404 .help = "show the current VM status (running|paused)",
405 .cmd = hmp_info_status,
411 Show the current VM status (running|paused).
418 .help = "show which guest mouse is receiving events",
419 .cmd = hmp_info_mice,
424 Show which guest mouse is receiving events.
427 #if defined(CONFIG_VNC)
432 .help = "show the vnc server status",
439 Show the vnc server status.
442 #if defined(CONFIG_SPICE)
447 .help = "show the spice server status",
448 .cmd = hmp_info_spice,
454 Show the spice server status.
461 .help = "show the current VM name",
462 .cmd = hmp_info_name,
468 Show the current VM name.
475 .help = "show the current VM UUID",
476 .cmd = hmp_info_uuid,
482 Show the current VM UUID.
485 #if defined(CONFIG_SLIRP)
490 .help = "show user network stack connection states",
491 .cmd = hmp_info_usernet,
497 Show user network stack connection states.
504 .help = "show migration status",
505 .cmd = hmp_info_migrate,
510 Show migration status.
514 .name = "migrate_capabilities",
517 .help = "show current migration capabilities",
518 .cmd = hmp_info_migrate_capabilities,
522 ``info migrate_capabilities``
523 Show current migration capabilities.
527 .name = "migrate_parameters",
530 .help = "show current migration parameters",
531 .cmd = hmp_info_migrate_parameters,
535 ``info migrate_parameters``
536 Show current migration parameters.
543 .help = "show balloon information",
544 .cmd = hmp_info_balloon,
549 Show balloon information.
556 .help = "show device tree",
557 .cmd = hmp_info_qtree,
569 .help = "show qdev device model list",
575 Show qdev device model list.
580 .args_type = "path:s?",
582 .help = "show QOM composition tree",
583 .cmd = hmp_info_qom_tree,
589 Show QOM composition tree.
597 .cmd_info_hrt = qmp_x_query_roms,
606 .name = "trace-events",
607 .args_type = "name:s?,vcpu:i?",
608 .params = "[name] [vcpu]",
609 .help = "show available trace-events & their state "
610 "(name: event name pattern; vcpu: vCPU to query, default is any)",
611 .cmd = hmp_info_trace_events,
612 .command_completion = info_trace_events_completion,
616 ``info trace-events``
617 Show available trace-events & their state.
624 .help = "show the TPM device",
637 .help = "show memory backends",
638 .cmd = hmp_info_memdev,
648 .name = "memory-devices",
651 .help = "show memory devices",
652 .cmd = hmp_info_memory_devices,
656 ``info memory-devices``
664 .help = "show iothreads",
665 .cmd = hmp_info_iothreads,
671 Show iothread's identifiers.
676 .args_type = "name:s",
678 .help = "Show rocker switch",
683 ``info rocker`` *name*
688 .name = "rocker-ports",
689 .args_type = "name:s",
691 .help = "Show rocker ports",
692 .cmd = hmp_rocker_ports,
696 ``info rocker-ports`` *name*-ports
701 .name = "rocker-of-dpa-flows",
702 .args_type = "name:s,tbl_id:i?",
703 .params = "name [tbl_id]",
704 .help = "Show rocker OF-DPA flow tables",
705 .cmd = hmp_rocker_of_dpa_flows,
709 ``info rocker-of-dpa-flows`` *name* [*tbl_id*]
710 Show rocker OF-DPA flow tables.
714 .name = "rocker-of-dpa-groups",
715 .args_type = "name:s,type:i?",
716 .params = "name [type]",
717 .help = "Show rocker OF-DPA groups",
718 .cmd = hmp_rocker_of_dpa_groups,
722 ``info rocker-of-dpa-groups`` *name* [*type*]
723 Show rocker OF-DPA groups.
726 #if defined(TARGET_S390X)
729 .args_type = "addr:l",
731 .help = "Display the value of a storage key",
732 .cmd = hmp_info_skeys,
737 ``info skeys`` *address*
738 Display the value of a storage key (s390 only)
741 #if defined(TARGET_S390X)
744 .args_type = "addr:l,count:l?",
745 .params = "address [count]",
746 .help = "Display the values of the CMMA storage attributes for a range of pages",
747 .cmd = hmp_info_cmma,
752 ``info cmma`` *address*
753 Display the values of the CMMA storage attributes for a range of
761 .help = "Display the latest dump status",
762 .cmd = hmp_info_dump,
767 Display the latest dump status.
774 .help = "Display system ramblock information",
775 .cmd_info_hrt = qmp_x_query_ramblock,
780 Dump all the ramblocks of the system.
784 .name = "hotpluggable-cpus",
787 .help = "Show information about hotpluggable CPUs",
788 .cmd = hmp_hotpluggable_cpus,
793 ``info hotpluggable-cpus``
794 Show information about hotpluggable CPUs
798 .name = "vm-generation-id",
801 .help = "Show Virtual Machine Generation ID",
802 .cmd = hmp_info_vm_generation_id,
806 ``info vm-generation-id``
807 Show Virtual Machine Generation ID
811 .name = "memory_size_summary",
814 .help = "show the amount of initially allocated and "
815 "present hotpluggable (if enabled) memory in bytes.",
816 .cmd = hmp_info_memory_size_summary,
820 ``info memory_size_summary``
821 Display the amount of initially allocated and present hotpluggable (if
822 enabled) memory in bytes.
825 #if defined(TARGET_I386)
830 .help = "show SEV information",
837 Show SEV information.
844 .help = "show record/replay information",
845 .cmd = hmp_info_replay,
850 Display the record/replay information: mode and the current icount.
854 .name = "dirty_rate",
857 .help = "show dirty rate information",
858 .cmd = hmp_info_dirty_rate,
863 Display the vcpu dirty rate information.
866 #if defined(TARGET_I386)
871 .help = "show intel SGX information",
878 Show intel SGX information.