docs/interop/bitmaps: Clean up a reference to qemu-qmp-ref
[qemu/armbru.git] / hmp-commands-info.hx
blobda120f82a32fb5d9fbe812e864b33942e5afb915
1 HXCOMM See docs/devel/docs.rst for the format of this file.
2 HXCOMM
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.
7 HXCOMM
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.
14 SRST
15 ``info`` *subcommand*
16 Show various information about the system state.
18 ERST
21 .name = "version",
22 .args_type = "",
23 .params = "",
24 .help = "show the version of QEMU",
25 .cmd = hmp_info_version,
26 .flags = "p",
29 SRST
30 ``info version``
31 Show the version of QEMU.
32 ERST
35 .name = "network",
36 .args_type = "",
37 .params = "",
38 .help = "show the network state",
39 .cmd = hmp_info_network,
42 SRST
43 ``info network``
44 Show the network state.
45 ERST
48 .name = "chardev",
49 .args_type = "",
50 .params = "",
51 .help = "show the character devices",
52 .cmd = hmp_info_chardev,
53 .flags = "p",
56 SRST
57 ``info chardev``
58 Show the character devices.
59 ERST
62 .name = "block",
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,
70 SRST
71 ``info block``
72 Show info of one block device or all block devices.
73 ERST
76 .name = "blockstats",
77 .args_type = "",
78 .params = "",
79 .help = "show block device statistics",
80 .cmd = hmp_info_blockstats,
83 SRST
84 ``info blockstats``
85 Show block device statistics.
86 ERST
89 .name = "block-jobs",
90 .args_type = "",
91 .params = "",
92 .help = "show progress of ongoing block device operations",
93 .cmd = hmp_info_block_jobs,
96 SRST
97 ``info block-jobs``
98 Show progress of ongoing block device operations.
99 ERST
102 .name = "registers",
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,
111 SRST
112 ``info registers``
113 Show the cpu registers.
114 ERST
116 #if defined(TARGET_I386)
118 .name = "lapic",
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,
125 #endif
127 SRST
128 ``info lapic``
129 Show local APIC state
130 ERST
133 .name = "cpus",
134 .args_type = "",
135 .params = "",
136 .help = "show infos for each CPU",
137 .cmd = hmp_info_cpus,
140 SRST
141 ``info cpus``
142 Show infos for each CPU.
143 ERST
146 .name = "history",
147 .args_type = "",
148 .params = "",
149 .help = "show the command line history",
150 .cmd = hmp_info_history,
151 .flags = "p",
154 SRST
155 ``info history``
156 Show the command line history.
157 ERST
160 .name = "irq",
161 .args_type = "",
162 .params = "",
163 .help = "show the interrupts statistics (if available)",
164 .cmd_info_hrt = qmp_x_query_irq,
167 SRST
168 ``info irq``
169 Show the interrupts statistics (if available).
170 ERST
173 .name = "pic",
174 .args_type = "",
175 .params = "",
176 .help = "show PIC state",
177 .cmd = hmp_info_pic,
180 SRST
181 ``info pic``
182 Show PIC state.
183 ERST
186 .name = "rdma",
187 .args_type = "",
188 .params = "",
189 .help = "show RDMA state",
190 .cmd_info_hrt = qmp_x_query_rdma,
193 SRST
194 ``info rdma``
195 Show RDMA state.
196 ERST
199 .name = "pci",
200 .args_type = "",
201 .params = "",
202 .help = "show PCI info",
203 .cmd = hmp_info_pci,
206 SRST
207 ``info pci``
208 Show PCI information.
209 ERST
211 #if defined(TARGET_I386) || defined(TARGET_SH4) || defined(TARGET_SPARC) || \
212 defined(TARGET_PPC) || defined(TARGET_XTENSA) || defined(TARGET_M68K)
214 .name = "tlb",
215 .args_type = "",
216 .params = "",
217 .help = "show virtual to physical memory mappings",
218 .cmd = hmp_info_tlb,
220 #endif
222 SRST
223 ``info tlb``
224 Show virtual to physical memory mappings.
225 ERST
227 #if defined(TARGET_I386) || defined(TARGET_RISCV)
229 .name = "mem",
230 .args_type = "",
231 .params = "",
232 .help = "show the active virtual memory mappings",
233 .cmd = hmp_info_mem,
235 #endif
237 SRST
238 ``info mem``
239 Show the active virtual memory mappings.
240 ERST
243 .name = "mtree",
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,
253 SRST
254 ``info mtree``
255 Show memory tree.
256 ERST
258 #if defined(CONFIG_TCG)
260 .name = "jit",
261 .args_type = "",
262 .params = "",
263 .help = "show dynamic compiler info",
265 #endif
267 SRST
268 ``info jit``
269 Show dynamic compiler info.
270 ERST
272 #if defined(CONFIG_TCG)
274 .name = "opcount",
275 .args_type = "",
276 .params = "",
277 .help = "show dynamic compiler opcode counters",
279 #endif
281 SRST
282 ``info opcount``
283 Show dynamic compiler opcode counters
284 ERST
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 "
293 "same call site)",
294 .cmd = hmp_info_sync_profile,
297 SRST
298 ``info sync-profile [-m|-n]`` [*max*]
299 Show synchronization profiling info, up to *max* entries (default: 10),
300 sorted by total wait time.
302 ``-m``
303 sort by mean wait time
304 ``-n``
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
309 being coalesced.
310 ERST
313 .name = "kvm",
314 .args_type = "",
315 .params = "",
316 .help = "show KVM information",
317 .cmd = hmp_info_kvm,
320 SRST
321 ``info kvm``
322 Show KVM information.
323 ERST
326 .name = "numa",
327 .args_type = "",
328 .params = "",
329 .help = "show NUMA information",
330 .cmd_info_hrt = qmp_x_query_numa,
333 SRST
334 ``info numa``
335 Show NUMA information.
336 ERST
339 .name = "usb",
340 .args_type = "",
341 .params = "",
342 .help = "show guest USB devices",
343 .cmd_info_hrt = qmp_x_query_usb,
346 SRST
347 ``info usb``
348 Show guest USB devices.
349 ERST
352 .name = "usbhost",
353 .args_type = "",
354 .params = "",
355 .help = "show host USB devices",
358 SRST
359 ``info usbhost``
360 Show host USB devices.
361 ERST
364 .name = "capture",
365 .args_type = "",
366 .params = "",
367 .help = "show capture information",
368 .cmd = hmp_info_capture,
371 SRST
372 ``info capture``
373 Show capture information.
374 ERST
377 .name = "snapshots",
378 .args_type = "",
379 .params = "",
380 .help = "show the currently saved VM snapshots",
381 .cmd = hmp_info_snapshots,
384 SRST
385 ``info snapshots``
386 Show the currently saved VM snapshots.
387 ERST
390 .name = "status",
391 .args_type = "",
392 .params = "",
393 .help = "show the current VM status (running|paused)",
394 .cmd = hmp_info_status,
395 .flags = "p",
398 SRST
399 ``info status``
400 Show the current VM status (running|paused).
401 ERST
404 .name = "mice",
405 .args_type = "",
406 .params = "",
407 .help = "show which guest mouse is receiving events",
408 .cmd = hmp_info_mice,
411 SRST
412 ``info mice``
413 Show which guest mouse is receiving events.
414 ERST
416 #if defined(CONFIG_VNC)
418 .name = "vnc",
419 .args_type = "",
420 .params = "",
421 .help = "show the vnc server status",
422 .cmd = hmp_info_vnc,
424 #endif
426 SRST
427 ``info vnc``
428 Show the vnc server status.
429 ERST
431 #if defined(CONFIG_SPICE)
433 .name = "spice",
434 .args_type = "",
435 .params = "",
436 .help = "show the spice server status",
437 .cmd = hmp_info_spice,
439 #endif
441 SRST
442 ``info spice``
443 Show the spice server status.
444 ERST
447 .name = "name",
448 .args_type = "",
449 .params = "",
450 .help = "show the current VM name",
451 .cmd = hmp_info_name,
452 .flags = "p",
455 SRST
456 ``info name``
457 Show the current VM name.
458 ERST
461 .name = "uuid",
462 .args_type = "",
463 .params = "",
464 .help = "show the current VM UUID",
465 .cmd = hmp_info_uuid,
466 .flags = "p",
469 SRST
470 ``info uuid``
471 Show the current VM UUID.
472 ERST
474 #if defined(CONFIG_SLIRP)
476 .name = "usernet",
477 .args_type = "",
478 .params = "",
479 .help = "show user network stack connection states",
480 .cmd = hmp_info_usernet,
482 #endif
484 SRST
485 ``info usernet``
486 Show user network stack connection states.
487 ERST
490 .name = "migrate",
491 .args_type = "",
492 .params = "",
493 .help = "show migration status",
494 .cmd = hmp_info_migrate,
497 SRST
498 ``info migrate``
499 Show migration status.
500 ERST
503 .name = "migrate_capabilities",
504 .args_type = "",
505 .params = "",
506 .help = "show current migration capabilities",
507 .cmd = hmp_info_migrate_capabilities,
510 SRST
511 ``info migrate_capabilities``
512 Show current migration capabilities.
513 ERST
516 .name = "migrate_parameters",
517 .args_type = "",
518 .params = "",
519 .help = "show current migration parameters",
520 .cmd = hmp_info_migrate_parameters,
523 SRST
524 ``info migrate_parameters``
525 Show current migration parameters.
526 ERST
529 .name = "balloon",
530 .args_type = "",
531 .params = "",
532 .help = "show balloon information",
533 .cmd = hmp_info_balloon,
536 SRST
537 ``info balloon``
538 Show balloon information.
539 ERST
542 .name = "qtree",
543 .args_type = "",
544 .params = "",
545 .help = "show device tree",
546 .cmd = hmp_info_qtree,
549 SRST
550 ``info qtree``
551 Show device tree.
552 ERST
555 .name = "qdm",
556 .args_type = "",
557 .params = "",
558 .help = "show qdev device model list",
559 .cmd = hmp_info_qdm,
562 SRST
563 ``info qdm``
564 Show qdev device model list.
565 ERST
568 .name = "qom-tree",
569 .args_type = "path:s?",
570 .params = "[path]",
571 .help = "show QOM composition tree",
572 .cmd = hmp_info_qom_tree,
573 .flags = "p",
576 SRST
577 ``info qom-tree``
578 Show QOM composition tree.
579 ERST
582 .name = "roms",
583 .args_type = "",
584 .params = "",
585 .help = "show roms",
586 .cmd_info_hrt = qmp_x_query_roms,
589 SRST
590 ``info roms``
591 Show roms.
592 ERST
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,
604 SRST
605 ``info trace-events``
606 Show available trace-events & their state.
607 ERST
610 .name = "tpm",
611 .args_type = "",
612 .params = "",
613 .help = "show the TPM device",
614 .cmd = hmp_info_tpm,
617 SRST
618 ``info tpm``
619 Show the TPM device.
620 ERST
623 .name = "memdev",
624 .args_type = "",
625 .params = "",
626 .help = "show memory backends",
627 .cmd = hmp_info_memdev,
628 .flags = "p",
631 SRST
632 ``info memdev``
633 Show memory backends
634 ERST
637 .name = "memory-devices",
638 .args_type = "",
639 .params = "",
640 .help = "show memory devices",
641 .cmd = hmp_info_memory_devices,
644 SRST
645 ``info memory-devices``
646 Show memory devices.
647 ERST
650 .name = "iothreads",
651 .args_type = "",
652 .params = "",
653 .help = "show iothreads",
654 .cmd = hmp_info_iothreads,
655 .flags = "p",
658 SRST
659 ``info iothreads``
660 Show iothread's identifiers.
661 ERST
664 .name = "rocker",
665 .args_type = "name:s",
666 .params = "name",
667 .help = "Show rocker switch",
668 .cmd = hmp_rocker,
671 SRST
672 ``info rocker`` *name*
673 Show rocker switch.
674 ERST
677 .name = "rocker-ports",
678 .args_type = "name:s",
679 .params = "name",
680 .help = "Show rocker ports",
681 .cmd = hmp_rocker_ports,
684 SRST
685 ``info rocker-ports`` *name*-ports
686 Show rocker ports.
687 ERST
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,
697 SRST
698 ``info rocker-of-dpa-flows`` *name* [*tbl_id*]
699 Show rocker OF-DPA flow tables.
700 ERST
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,
710 SRST
711 ``info rocker-of-dpa-groups`` *name* [*type*]
712 Show rocker OF-DPA groups.
713 ERST
715 #if defined(TARGET_S390X)
717 .name = "skeys",
718 .args_type = "addr:l",
719 .params = "address",
720 .help = "Display the value of a storage key",
721 .cmd = hmp_info_skeys,
723 #endif
725 SRST
726 ``info skeys`` *address*
727 Display the value of a storage key (s390 only)
728 ERST
730 #if defined(TARGET_S390X)
732 .name = "cmma",
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,
738 #endif
740 SRST
741 ``info cmma`` *address*
742 Display the values of the CMMA storage attributes for a range of
743 pages (s390 only)
744 ERST
747 .name = "dump",
748 .args_type = "",
749 .params = "",
750 .help = "Display the latest dump status",
751 .cmd = hmp_info_dump,
754 SRST
755 ``info dump``
756 Display the latest dump status.
757 ERST
760 .name = "ramblock",
761 .args_type = "",
762 .params = "",
763 .help = "Display system ramblock information",
764 .cmd_info_hrt = qmp_x_query_ramblock,
767 SRST
768 ``info ramblock``
769 Dump all the ramblocks of the system.
770 ERST
773 .name = "hotpluggable-cpus",
774 .args_type = "",
775 .params = "",
776 .help = "Show information about hotpluggable CPUs",
777 .cmd = hmp_hotpluggable_cpus,
778 .flags = "p",
781 SRST
782 ``info hotpluggable-cpus``
783 Show information about hotpluggable CPUs
784 ERST
787 .name = "vm-generation-id",
788 .args_type = "",
789 .params = "",
790 .help = "Show Virtual Machine Generation ID",
791 .cmd = hmp_info_vm_generation_id,
794 SRST
795 ``info vm-generation-id``
796 Show Virtual Machine Generation ID
797 ERST
800 .name = "memory_size_summary",
801 .args_type = "",
802 .params = "",
803 .help = "show the amount of initially allocated and "
804 "present hotpluggable (if enabled) memory in bytes.",
805 .cmd = hmp_info_memory_size_summary,
808 SRST
809 ``info memory_size_summary``
810 Display the amount of initially allocated and present hotpluggable (if
811 enabled) memory in bytes.
812 ERST
814 #if defined(TARGET_I386)
816 .name = "sev",
817 .args_type = "",
818 .params = "",
819 .help = "show SEV information",
820 .cmd = hmp_info_sev,
822 #endif
824 SRST
825 ``info sev``
826 Show SEV information.
827 ERST
830 .name = "replay",
831 .args_type = "",
832 .params = "",
833 .help = "show record/replay information",
834 .cmd = hmp_info_replay,
837 SRST
838 ``info replay``
839 Display the record/replay information: mode and the current icount.
840 ERST
843 .name = "dirty_rate",
844 .args_type = "",
845 .params = "",
846 .help = "show dirty rate information",
847 .cmd = hmp_info_dirty_rate,
850 SRST
851 ``info dirty_rate``
852 Display the vcpu dirty rate information.
853 ERST
856 .name = "vcpu_dirty_limit",
857 .args_type = "",
858 .params = "",
859 .help = "show dirty page limit information of all vCPU",
860 .cmd = hmp_info_vcpu_dirty_limit,
863 SRST
864 ``info vcpu_dirty_limit``
865 Display the vcpu dirty page limit information.
866 ERST
868 #if defined(TARGET_I386)
870 .name = "sgx",
871 .args_type = "",
872 .params = "",
873 .help = "show intel SGX information",
874 .cmd = hmp_info_sgx,
876 #endif
878 SRST
879 ``info sgx``
880 Show intel SGX information.
881 ERST
883 #if defined(CONFIG_MOS6522)
885 .name = "via",
886 .args_type = "",
887 .params = "",
888 .help = "show guest mos6522 VIA devices",
889 .cmd = hmp_info_via,
891 #endif
893 SRST
894 ``info via``
895 Show guest mos6522 VIA devices.
896 ERST
899 .name = "stats",
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,
907 SRST
908 ``stats``
909 Show runtime-collected statistics
910 ERST
913 .name = "virtio",
914 .args_type = "",
915 .params = "",
916 .help = "List all available virtio devices",
917 .cmd = hmp_virtio_query,
918 .flags = "p",
921 SRST
922 ``info virtio``
923 List all available virtio devices
924 ERST
927 .name = "virtio-status",
928 .args_type = "path:s",
929 .params = "path",
930 .help = "Display status of a given virtio device",
931 .cmd = hmp_virtio_status,
932 .flags = "p",
935 SRST
936 ``info virtio-status`` *path*
937 Display status of a given virtio device
938 ERST
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,
946 .flags = "p",
949 SRST
950 ``info virtio-queue-status`` *path* *queue*
951 Display status of a given virtio queue
952 ERST
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,
960 .flags = "p",
963 SRST
964 ``info virtio-vhost-queue-status`` *path* *queue*
965 Display status of a given vhost queue
966 ERST
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,
974 .flags = "p",
977 SRST
978 ``info virtio-queue-element`` *path* *queue* [*index*]
979 Display element of a given virtio queue
980 ERST
983 .name = "cryptodev",
984 .args_type = "",
985 .params = "",
986 .help = "show the crypto devices",
987 .cmd = hmp_info_cryptodev,
988 .flags = "p",
991 SRST
992 ``info cryptodev``
993 Show the crypto devices.
994 ERST