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
130 #if defined(TARGET_I386)
135 .help = "show io apic state",
136 .cmd = hmp_info_io_apic,
149 .help = "show infos for each CPU",
150 .cmd = hmp_info_cpus,
155 Show infos for each CPU.
162 .help = "show the command line history",
163 .cmd = hmp_info_history,
169 Show the command line history.
176 .help = "show the interrupts statistics (if available)",
182 Show the interrupts statistics (if available).
189 .help = "show PIC state",
202 .help = "show RDMA state",
203 .cmd = hmp_info_rdma,
215 .help = "show PCI info",
221 Show PCI information.
224 #if defined(TARGET_I386) || defined(TARGET_SH4) || defined(TARGET_SPARC) || \
225 defined(TARGET_PPC) || defined(TARGET_XTENSA) || defined(TARGET_M68K)
230 .help = "show virtual to physical memory mappings",
237 Show virtual to physical memory mappings.
240 #if defined(TARGET_I386) || defined(TARGET_RISCV)
245 .help = "show the active virtual memory mappings",
252 Show the active virtual memory mappings.
257 .args_type = "flatview:-f,dispatch_tree:-d,owner:-o,disabled:-D",
258 .params = "[-f][-d][-o][-D]",
259 .help = "show memory tree (-f: dump flat view for address spaces;"
260 "-d: dump dispatch tree, valid with -f only);"
261 "-o: dump region owners/parents;"
262 "-D: dump disabled regions",
263 .cmd = hmp_info_mtree,
271 #if defined(CONFIG_TCG)
276 .help = "show dynamic compiler info",
283 Show dynamic compiler info.
286 #if defined(CONFIG_TCG)
291 .help = "show dynamic compiler opcode counters",
292 .cmd = hmp_info_opcount,
298 Show dynamic compiler opcode counters
302 .name = "sync-profile",
303 .args_type = "mean:-m,no_coalesce:-n,max:i?",
304 .params = "[-m] [-n] [max]",
305 .help = "show synchronization profiling info, up to max entries "
306 "(default: 10), sorted by total wait time. (-m: sort by "
307 "mean wait time; -n: do not coalesce objects with the "
309 .cmd = hmp_info_sync_profile,
313 ``info sync-profile [-m|-n]`` [*max*]
314 Show synchronization profiling info, up to *max* entries (default: 10),
315 sorted by total wait time.
318 sort by mean wait time
320 do not coalesce objects with the same call site
322 When different objects that share the same call site are coalesced,
323 the "Object" field shows---enclosed in brackets---the number of objects
331 .help = "show KVM information",
337 Show KVM information.
344 .help = "show NUMA information",
345 .cmd = hmp_info_numa,
350 Show NUMA information.
357 .help = "show guest USB devices",
363 Show guest USB devices.
370 .help = "show host USB devices",
371 .cmd = hmp_info_usbhost,
376 Show host USB devices.
383 .help = "show profiling information",
384 .cmd = hmp_info_profile,
389 Show profiling information.
396 .help = "show capture information",
397 .cmd = hmp_info_capture,
402 Show capture information.
409 .help = "show the currently saved VM snapshots",
410 .cmd = hmp_info_snapshots,
415 Show the currently saved VM snapshots.
422 .help = "show the current VM status (running|paused)",
423 .cmd = hmp_info_status,
429 Show the current VM status (running|paused).
436 .help = "show which guest mouse is receiving events",
437 .cmd = hmp_info_mice,
442 Show which guest mouse is receiving events.
445 #if defined(CONFIG_VNC)
450 .help = "show the vnc server status",
457 Show the vnc server status.
460 #if defined(CONFIG_SPICE)
465 .help = "show the spice server status",
466 .cmd = hmp_info_spice,
472 Show the spice server status.
479 .help = "show the current VM name",
480 .cmd = hmp_info_name,
486 Show the current VM name.
493 .help = "show the current VM UUID",
494 .cmd = hmp_info_uuid,
500 Show the current VM UUID.
507 .help = "show CPU statistics",
508 .cmd = hmp_info_cpustats,
516 #if defined(CONFIG_SLIRP)
521 .help = "show user network stack connection states",
522 .cmd = hmp_info_usernet,
528 Show user network stack connection states.
535 .help = "show migration status",
536 .cmd = hmp_info_migrate,
541 Show migration status.
545 .name = "migrate_capabilities",
548 .help = "show current migration capabilities",
549 .cmd = hmp_info_migrate_capabilities,
553 ``info migrate_capabilities``
554 Show current migration capabilities.
558 .name = "migrate_parameters",
561 .help = "show current migration parameters",
562 .cmd = hmp_info_migrate_parameters,
566 ``info migrate_parameters``
567 Show current migration parameters.
574 .help = "show balloon information",
575 .cmd = hmp_info_balloon,
580 Show balloon information.
587 .help = "show device tree",
588 .cmd = hmp_info_qtree,
600 .help = "show qdev device model list",
606 Show qdev device model list.
611 .args_type = "path:s?",
613 .help = "show QOM composition tree",
614 .cmd = hmp_info_qom_tree,
620 Show QOM composition tree.
628 .cmd = hmp_info_roms,
637 .name = "trace-events",
638 .args_type = "name:s?,vcpu:i?",
639 .params = "[name] [vcpu]",
640 .help = "show available trace-events & their state "
641 "(name: event name pattern; vcpu: vCPU to query, default is any)",
642 .cmd = hmp_info_trace_events,
643 .command_completion = info_trace_events_completion,
647 ``info trace-events``
648 Show available trace-events & their state.
655 .help = "show the TPM device",
668 .help = "show memory backends",
669 .cmd = hmp_info_memdev,
679 .name = "memory-devices",
682 .help = "show memory devices",
683 .cmd = hmp_info_memory_devices,
687 ``info memory-devices``
695 .help = "show iothreads",
696 .cmd = hmp_info_iothreads,
702 Show iothread's identifiers.
707 .args_type = "name:s",
709 .help = "Show rocker switch",
714 ``info rocker`` *name*
719 .name = "rocker-ports",
720 .args_type = "name:s",
722 .help = "Show rocker ports",
723 .cmd = hmp_rocker_ports,
727 ``info rocker-ports`` *name*-ports
732 .name = "rocker-of-dpa-flows",
733 .args_type = "name:s,tbl_id:i?",
734 .params = "name [tbl_id]",
735 .help = "Show rocker OF-DPA flow tables",
736 .cmd = hmp_rocker_of_dpa_flows,
740 ``info rocker-of-dpa-flows`` *name* [*tbl_id*]
741 Show rocker OF-DPA flow tables.
745 .name = "rocker-of-dpa-groups",
746 .args_type = "name:s,type:i?",
747 .params = "name [type]",
748 .help = "Show rocker OF-DPA groups",
749 .cmd = hmp_rocker_of_dpa_groups,
753 ``info rocker-of-dpa-groups`` *name* [*type*]
754 Show rocker OF-DPA groups.
757 #if defined(TARGET_S390X)
760 .args_type = "addr:l",
762 .help = "Display the value of a storage key",
763 .cmd = hmp_info_skeys,
768 ``info skeys`` *address*
769 Display the value of a storage key (s390 only)
772 #if defined(TARGET_S390X)
775 .args_type = "addr:l,count:l?",
776 .params = "address [count]",
777 .help = "Display the values of the CMMA storage attributes for a range of pages",
778 .cmd = hmp_info_cmma,
783 ``info cmma`` *address*
784 Display the values of the CMMA storage attributes for a range of
792 .help = "Display the latest dump status",
793 .cmd = hmp_info_dump,
798 Display the latest dump status.
805 .help = "Display system ramblock information",
806 .cmd = hmp_info_ramblock,
811 Dump all the ramblocks of the system.
815 .name = "hotpluggable-cpus",
818 .help = "Show information about hotpluggable CPUs",
819 .cmd = hmp_hotpluggable_cpus,
824 ``info hotpluggable-cpus``
825 Show information about hotpluggable CPUs
829 .name = "vm-generation-id",
832 .help = "Show Virtual Machine Generation ID",
833 .cmd = hmp_info_vm_generation_id,
837 ``info vm-generation-id``
838 Show Virtual Machine Generation ID
842 .name = "memory_size_summary",
845 .help = "show the amount of initially allocated and "
846 "present hotpluggable (if enabled) memory in bytes.",
847 .cmd = hmp_info_memory_size_summary,
851 ``info memory_size_summary``
852 Display the amount of initially allocated and present hotpluggable (if
853 enabled) memory in bytes.
856 #if defined(TARGET_I386)
861 .help = "show SEV information",
868 Show SEV information.
875 .help = "show record/replay information",
876 .cmd = hmp_info_replay,
881 Display the record/replay information: mode and the current icount.