master
hx 995 lines 22.1 KB
Raw
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.
12
13 {
14 .name = "version",
15 .args_type = "",
16 .params = "",
17 .help = "show the version of QEMU",
18 .cmd = hmp_info_version,
19 .flags = "p",
20 },
21
22 SRST
23 ``info version``
24 Show the version of QEMU.
25 ERST
26
27 {
28 .name = "network",
29 .args_type = "",
30 .params = "",
31 .help = "show the network state",
32 .cmd = hmp_info_network,
33 },
34
35 SRST
36 ``info network``
37 Show the network state.
38 ERST
39
40 {
41 .name = "chardev",
42 .args_type = "",
43 .params = "",
44 .help = "show the character devices",
45 .cmd = hmp_info_chardev,
46 .flags = "p",
47 },
48
49 SRST
50 ``info chardev``
51 Show the character devices.
52 ERST
53
54 {
55 .name = "block",
56 .args_type = "nodes:-n,verbose:-v,device:B?",
57 .params = "[-n] [-v] [device]",
58 .help = "show info of one block device or all block devices "
59 "(-n: show named nodes; -v: show details)",
60 .cmd = hmp_info_block,
61 },
62
63 SRST
64 ``info block``
65 Show info of one block device or all block devices.
66 ERST
67
68 {
69 .name = "blockstats",
70 .args_type = "",
71 .params = "",
72 .help = "show block device statistics",
73 .cmd = hmp_info_blockstats,
74 },
75
76 SRST
77 ``info blockstats``
78 Show block device statistics.
79 ERST
80
81 {
82 .name = "block-jobs",
83 .args_type = "",
84 .params = "",
85 .help = "show progress of ongoing block device operations",
86 .cmd = hmp_info_block_jobs,
87 },
88
89 SRST
90 ``info block-jobs``
91 Show progress of ongoing block device operations.
92 ERST
93
94 {
95 .name = "registers",
96 .args_type = "cpustate_all:-a,vcpu:i?",
97 .params = "[-a|vcpu]",
98 .help = "show the cpu registers (-a: show register info for all cpus;"
99 " vcpu: specific vCPU to query; show the current CPU's registers if"
100 " no argument is specified)",
101 .cmd = hmp_info_registers,
102 },
103
104 SRST
105 ``info registers``
106 Show the cpu registers.
107 ERST
108
109 {
110 .name = "lapic",
111 .args_type = "apic-id:i?",
112 .params = "[apic-id]",
113 .help = "show local apic state (apic-id: local apic to read, default is which of current CPU)",
114 .cmd = hmp_info_local_apic,
115 .arch_bitmask = QEMU_ARCH_I386,
116 },
117
118 SRST
119 ``info lapic``
120 Show local APIC state
121 ERST
122
123 {
124 .name = "cpus",
125 .args_type = "",
126 .params = "",
127 .help = "show infos for each CPU",
128 .cmd = hmp_info_cpus,
129 },
130
131 SRST
132 ``info cpus``
133 Show infos for each CPU.
134 ERST
135
136 {
137 .name = "history",
138 .args_type = "",
139 .params = "",
140 .help = "show the command line history",
141 .cmd = hmp_info_history,
142 .flags = "p",
143 },
144
145 SRST
146 ``info history``
147 Show the command line history.
148 ERST
149
150 {
151 .name = "irq",
152 .args_type = "",
153 .params = "",
154 .help = "show the interrupts statistics (if available)",
155 .cmd_info_hrt = qmp_x_query_irq,
156 },
157
158 SRST
159 ``info irq``
160 Show the interrupts statistics (if available).
161 ERST
162
163 {
164 .name = "pic",
165 .args_type = "",
166 .params = "",
167 .help = "show PIC state",
168 .cmd_info_hrt = qmp_x_query_interrupt_controllers,
169 },
170
171 SRST
172 ``info pic``
173 Show PIC state.
174 ERST
175
176 {
177 .name = "pci",
178 .args_type = "",
179 .params = "",
180 .help = "show PCI info",
181 .cmd = hmp_info_pci,
182 },
183
184 SRST
185 ``info pci``
186 Show PCI information.
187 ERST
188
189 {
190 .name = "tlb",
191 .args_type = "",
192 .params = "",
193 .help = "show virtual to physical memory mappings",
194 .cmd = hmp_info_tlb,
195 .arch_bitmask = QEMU_ARCH_I386 | QEMU_ARCH_SH4 | QEMU_ARCH_SPARC \
196 | QEMU_ARCH_PPC | QEMU_ARCH_XTENSA | QEMU_ARCH_M68K,
197 },
198
199 SRST
200 ``info tlb``
201 Show virtual to physical memory mappings.
202 ERST
203
204 {
205 .name = "mem",
206 .args_type = "",
207 .params = "",
208 .help = "show the active virtual memory mappings",
209 .cmd = hmp_info_mem,
210 .arch_bitmask = QEMU_ARCH_I386 | QEMU_ARCH_RISCV,
211 },
212
213 SRST
214 ``info mem``
215 Show the active virtual memory mappings.
216 ERST
217
218 {
219 .name = "mtree",
220 .args_type = "flatview:-f,dispatch_tree:-d,owner:-o,disabled:-D",
221 .params = "[-f][-d][-o][-D]",
222 .help = "show memory tree (-f: dump flat view for address spaces;"
223 "-d: dump dispatch tree, valid with -f only);"
224 "-o: dump region owners/parents;"
225 "-D: dump disabled regions",
226 .cmd = hmp_info_mtree,
227 },
228
229 SRST
230 ``info mtree``
231 Show memory tree.
232 ERST
233
234 #if defined(CONFIG_TCG)
235 {
236 .name = "jit",
237 .args_type = "",
238 .params = "",
239 .help = "show dynamic compiler info",
240 },
241 #endif
242
243 SRST
244 ``info jit``
245 Show dynamic compiler info.
246 ERST
247
248 {
249 .name = "sync-profile",
250 .args_type = "mean:-m,no_coalesce:-n,max:i?",
251 .params = "[-m] [-n] [max]",
252 .help = "show synchronization profiling info, up to max entries "
253 "(default: 10), sorted by total wait time. (-m: sort by "
254 "mean wait time; -n: do not coalesce objects with the "
255 "same call site)",
256 .cmd = hmp_info_sync_profile,
257 },
258
259 SRST
260 ``info sync-profile [-m|-n]`` [*max*]
261 Show synchronization profiling info, up to *max* entries (default: 10),
262 sorted by total wait time.
263
264 ``-m``
265 sort by mean wait time
266 ``-n``
267 do not coalesce objects with the same call site
268
269 When different objects that share the same call site are coalesced,
270 the "Object" field shows---enclosed in brackets---the number of objects
271 being coalesced.
272 ERST
273
274 {
275 .name = "accel",
276 .args_type = "",
277 .params = "",
278 .help = "show accelerator statistics",
279 },
280
281 SRST
282 ``info accel``
283 Show accelerator statistics.
284 ERST
285
286 {
287 .name = "kvm",
288 .args_type = "",
289 .params = "",
290 .help = "show KVM information",
291 .cmd = hmp_info_kvm,
292 },
293
294 SRST
295 ``info kvm``
296 Show KVM information.
297 ERST
298
299 {
300 .name = "accelerators",
301 .args_type = "",
302 .params = "",
303 .help = "show present and enabled information",
304 .cmd = hmp_info_accelerators,
305 },
306
307 SRST
308 ``info accelerators``
309 Show which accelerators are compiled into a QEMU binary, and what accelerator
310 is in use. For example::
311
312 kvm qtest [tcg]
313
314 indicates that TCG in use, and that KVM and qtest are also available.
315 ERST
316
317 {
318 .name = "numa",
319 .args_type = "",
320 .params = "",
321 .help = "show NUMA information",
322 .cmd_info_hrt = qmp_x_query_numa,
323 },
324
325 SRST
326 ``info numa``
327 Show NUMA information.
328 ERST
329
330 {
331 .name = "usb",
332 .args_type = "",
333 .params = "",
334 .help = "show guest USB devices",
335 .cmd_info_hrt = qmp_x_query_usb,
336 },
337
338 SRST
339 ``info usb``
340 Show guest USB devices.
341 ERST
342
343 {
344 .name = "usbhost",
345 .args_type = "",
346 .params = "",
347 .help = "show host USB devices",
348 },
349
350 SRST
351 ``info usbhost``
352 Show host USB devices.
353 ERST
354
355 /* BEGIN deprecated */
356 {
357 .name = "capture",
358 .args_type = "",
359 .params = "",
360 .help = "show capture information (deprecated)",
361 .cmd = hmp_info_capture,
362 },
363
364 SRST
365 ``info capture``
366 Show capture information (deprecated).
367 ERST
368 /* END deprecated */
369
370 {
371 .name = "snapshots",
372 .args_type = "",
373 .params = "",
374 .help = "show the currently saved VM snapshots",
375 .cmd = hmp_info_snapshots,
376 },
377
378 SRST
379 ``info snapshots``
380 Show the currently saved VM snapshots.
381 ERST
382
383 {
384 .name = "status",
385 .args_type = "",
386 .params = "",
387 .help = "show the current VM status (running|paused)",
388 .cmd = hmp_info_status,
389 .flags = "p",
390 },
391
392 SRST
393 ``info status``
394 Show the current VM status (running|paused).
395 ERST
396
397 {
398 .name = "mice",
399 .args_type = "",
400 .params = "",
401 .help = "show which guest mouse is receiving events",
402 .cmd = hmp_info_mice,
403 },
404
405 SRST
406 ``info mice``
407 Show which guest mouse is receiving events.
408 ERST
409
410 #if defined(CONFIG_VNC)
411 {
412 .name = "vnc",
413 .args_type = "",
414 .params = "",
415 .help = "show the vnc server status",
416 .cmd = hmp_info_vnc,
417 },
418 #endif
419
420 SRST
421 ``info vnc``
422 Show the vnc server status.
423 ERST
424
425 #if defined(CONFIG_SPICE)
426 {
427 .name = "spice",
428 .args_type = "",
429 .params = "",
430 .help = "show the spice server status",
431 .cmd = hmp_info_spice,
432 },
433 #endif
434
435 SRST
436 ``info spice``
437 Show the spice server status.
438 ERST
439
440 {
441 .name = "name",
442 .args_type = "",
443 .params = "",
444 .help = "show the current VM name",
445 .cmd = hmp_info_name,
446 .flags = "p",
447 },
448
449 SRST
450 ``info name``
451 Show the current VM name.
452 ERST
453
454 {
455 .name = "uuid",
456 .args_type = "",
457 .params = "",
458 .help = "show the current VM UUID",
459 .cmd = hmp_info_uuid,
460 .flags = "p",
461 },
462
463 SRST
464 ``info uuid``
465 Show the current VM UUID.
466 ERST
467
468 #if defined(CONFIG_SLIRP)
469 {
470 .name = "usernet",
471 .args_type = "",
472 .params = "",
473 .help = "show user network stack connection states",
474 .cmd = hmp_info_usernet,
475 },
476 #endif
477
478 SRST
479 ``info usernet``
480 Show user network stack connection states.
481 ERST
482
483 {
484 .name = "migrate",
485 .args_type = "all:-a",
486 .params = "[-a]",
487 .help = "show migration status (-a: all, dump all status)",
488 .cmd = hmp_info_migrate,
489 },
490
491 SRST
492 ``info migrate``
493 Show migration status.
494 ERST
495
496 {
497 .name = "migrate_capabilities",
498 .args_type = "",
499 .params = "",
500 .help = "show current migration capabilities",
501 .cmd = hmp_info_migrate_capabilities,
502 },
503
504 SRST
505 ``info migrate_capabilities``
506 Show current migration capabilities.
507 ERST
508
509 {
510 .name = "migrate_parameters",
511 .args_type = "",
512 .params = "",
513 .help = "show current migration parameters",
514 .cmd = hmp_info_migrate_parameters,
515 },
516
517 SRST
518 ``info migrate_parameters``
519 Show current migration parameters.
520 ERST
521
522 {
523 .name = "balloon",
524 .args_type = "",
525 .params = "",
526 .help = "show balloon information",
527 .cmd = hmp_info_balloon,
528 },
529
530 SRST
531 ``info balloon``
532 Show balloon information.
533 ERST
534
535 {
536 .name = "qtree",
537 .args_type = "brief:-b",
538 .params = "[-b]",
539 .help = "show device tree (-b: brief, omit properties)",
540 .cmd = hmp_info_qtree,
541 },
542
543 SRST
544 ``info qtree``
545 Show device tree.
546 ERST
547
548 {
549 .name = "qdm",
550 .args_type = "",
551 .params = "",
552 .help = "show qdev device model list",
553 .cmd = hmp_info_qdm,
554 },
555
556 SRST
557 ``info qdm``
558 Show qdev device model list.
559 ERST
560
561 {
562 .name = "qom-tree",
563 .args_type = "path:s?",
564 .params = "[path]",
565 .help = "show QOM composition tree",
566 .cmd = hmp_info_qom_tree,
567 .flags = "p",
568 },
569
570 SRST
571 ``info qom-tree``
572 Show QOM composition tree.
573 ERST
574
575 {
576 .name = "roms",
577 .args_type = "",
578 .params = "",
579 .help = "show roms",
580 .cmd_info_hrt = qmp_x_query_roms,
581 },
582
583 SRST
584 ``info roms``
585 Show roms.
586 ERST
587
588 {
589 .name = "trace-events",
590 .args_type = "name:s?",
591 .params = "[name]",
592 .help = "show available trace-events & their state "
593 "(name: event name pattern)",
594 .cmd = hmp_info_trace_events,
595 .command_completion = info_trace_events_completion,
596 },
597
598 SRST
599 ``info trace-events``
600 Show available trace-events & their state.
601 ERST
602
603 {
604 .name = "tpm",
605 .args_type = "",
606 .params = "",
607 .help = "show the TPM device",
608 .cmd = hmp_info_tpm,
609 },
610
611 SRST
612 ``info tpm``
613 Show the TPM device.
614 ERST
615
616 {
617 .name = "memdev",
618 .args_type = "",
619 .params = "",
620 .help = "show memory backends",
621 .cmd = hmp_info_memdev,
622 .flags = "p",
623 },
624
625 SRST
626 ``info memdev``
627 Show memory backends
628 ERST
629
630 {
631 .name = "memory-devices",
632 .args_type = "",
633 .params = "",
634 .help = "show memory devices",
635 .cmd = hmp_info_memory_devices,
636 },
637
638 SRST
639 ``info memory-devices``
640 Show memory devices.
641 ERST
642
643 {
644 .name = "iothreads",
645 .args_type = "",
646 .params = "",
647 .help = "show iothreads",
648 .cmd = hmp_info_iothreads,
649 .flags = "p",
650 },
651
652 SRST
653 ``info iothreads``
654 Show iothread's identifiers.
655 ERST
656
657 {
658 .name = "rocker",
659 .args_type = "name:s",
660 .params = "name",
661 .help = "Show rocker switch",
662 .cmd = hmp_rocker,
663 },
664
665 SRST
666 ``info rocker`` *name*
667 Show rocker switch.
668 ERST
669
670 {
671 .name = "rocker-ports",
672 .args_type = "name:s",
673 .params = "name",
674 .help = "Show rocker ports",
675 .cmd = hmp_rocker_ports,
676 },
677
678 SRST
679 ``info rocker-ports`` *name*-ports
680 Show rocker ports.
681 ERST
682
683 {
684 .name = "rocker-of-dpa-flows",
685 .args_type = "name:s,tbl_id:i?",
686 .params = "name [tbl_id]",
687 .help = "Show rocker OF-DPA flow tables",
688 .cmd = hmp_rocker_of_dpa_flows,
689 },
690
691 SRST
692 ``info rocker-of-dpa-flows`` *name* [*tbl_id*]
693 Show rocker OF-DPA flow tables.
694 ERST
695
696 {
697 .name = "rocker-of-dpa-groups",
698 .args_type = "name:s,type:i?",
699 .params = "name [type]",
700 .help = "Show rocker OF-DPA groups",
701 .cmd = hmp_rocker_of_dpa_groups,
702 },
703
704 SRST
705 ``info rocker-of-dpa-groups`` *name* [*type*]
706 Show rocker OF-DPA groups.
707 ERST
708
709 {
710 .name = "skeys",
711 .args_type = "addr:l",
712 .params = "address",
713 .help = "Display the value of a storage key",
714 .cmd = hmp_info_skeys,
715 .arch_bitmask = QEMU_ARCH_S390X,
716 },
717
718 SRST
719 ``info skeys`` *address*
720 Display the value of a storage key (s390 only)
721 ERST
722
723 {
724 .name = "cmma",
725 .args_type = "addr:l,count:l?",
726 .params = "address [count]",
727 .help = "Display the values of the CMMA storage attributes for a range of pages",
728 .cmd = hmp_info_cmma,
729 .arch_bitmask = QEMU_ARCH_S390X,
730 },
731
732 SRST
733 ``info cmma`` *address*
734 Display the values of the CMMA storage attributes for a range of
735 pages (s390 only)
736 ERST
737
738 {
739 .name = "dump",
740 .args_type = "",
741 .params = "",
742 .help = "Display the latest dump status",
743 .cmd = hmp_info_dump,
744 },
745
746 SRST
747 ``info dump``
748 Display the latest dump status.
749 ERST
750
751 {
752 .name = "ramblock",
753 .args_type = "",
754 .params = "",
755 .help = "Display system ramblock information",
756 .cmd_info_hrt = qmp_x_query_ramblock,
757 },
758
759 SRST
760 ``info ramblock``
761 Dump all the ramblocks of the system.
762 ERST
763
764 {
765 .name = "hotpluggable-cpus",
766 .args_type = "",
767 .params = "",
768 .help = "Show information about hotpluggable CPUs",
769 .cmd = hmp_hotpluggable_cpus,
770 .flags = "p",
771 },
772
773 SRST
774 ``info hotpluggable-cpus``
775 Show information about hotpluggable CPUs
776 ERST
777
778 {
779 .name = "vm-generation-id",
780 .args_type = "",
781 .params = "",
782 .help = "Show Virtual Machine Generation ID",
783 .cmd = hmp_info_vm_generation_id,
784 },
785
786 SRST
787 ``info vm-generation-id``
788 Show Virtual Machine Generation ID
789 ERST
790
791 {
792 .name = "memory_size_summary",
793 .args_type = "",
794 .params = "",
795 .help = "show the amount of initially allocated and "
796 "present hotpluggable (if enabled) memory in bytes.",
797 .cmd = hmp_info_memory_size_summary,
798 },
799
800 SRST
801 ``info memory_size_summary``
802 Display the amount of initially allocated and present hotpluggable (if
803 enabled) memory in bytes.
804 ERST
805
806 {
807 .name = "sev",
808 .args_type = "",
809 .params = "",
810 .help = "show SEV information",
811 .cmd = hmp_info_sev,
812 .arch_bitmask = QEMU_ARCH_I386,
813 },
814
815 SRST
816 ``info sev``
817 Show SEV information.
818 ERST
819
820 {
821 .name = "replay",
822 .args_type = "",
823 .params = "",
824 .help = "show record/replay information",
825 .cmd = hmp_info_replay,
826 },
827
828 SRST
829 ``info replay``
830 Display the record/replay information: mode and the current icount.
831 ERST
832
833 {
834 .name = "dirty_rate",
835 .args_type = "",
836 .params = "",
837 .help = "show dirty rate information",
838 .cmd = hmp_info_dirty_rate,
839 },
840
841 SRST
842 ``info dirty_rate``
843 Display the vcpu dirty rate information.
844 ERST
845
846 {
847 .name = "vcpu_dirty_limit",
848 .args_type = "",
849 .params = "",
850 .help = "show dirty page limit information of all vCPU",
851 .cmd = hmp_info_vcpu_dirty_limit,
852 },
853
854 SRST
855 ``info vcpu_dirty_limit``
856 Display the vcpu dirty page limit information.
857 ERST
858
859 {
860 .name = "sgx",
861 .args_type = "",
862 .params = "",
863 .help = "show intel SGX information",
864 .cmd = hmp_info_sgx,
865 .arch_bitmask = QEMU_ARCH_I386,
866 },
867
868 SRST
869 ``info sgx``
870 Show intel SGX information.
871 ERST
872
873 {
874 .name = "via",
875 .args_type = "",
876 .params = "",
877 .help = "show guest mos6522 VIA devices",
878 .cmd = hmp_info_via,
879 },
880
881 SRST
882 ``info via``
883 Show guest mos6522 VIA devices.
884 ERST
885
886 {
887 .name = "stats",
888 .args_type = "target:s,names:s?,provider:s?",
889 .params = "target [names] [provider]",
890 .help = "show statistics for the given target (vm or vcpu); optionally filter by"
891 "name (comma-separated list, or * for all) and provider",
892 .cmd = hmp_info_stats,
893 },
894
895 SRST
896 ``info stats``
897 Show runtime-collected statistics
898 ERST
899
900 {
901 .name = "virtio",
902 .args_type = "",
903 .params = "",
904 .help = "List all available virtio devices",
905 .cmd = hmp_virtio_query,
906 .flags = "p",
907 },
908
909 SRST
910 ``info virtio``
911 List all available virtio devices
912 ERST
913
914 {
915 .name = "virtio-status",
916 .args_type = "path:s",
917 .params = "path",
918 .help = "Display status of a given virtio device",
919 .cmd = hmp_virtio_status,
920 .flags = "p",
921 },
922
923 SRST
924 ``info virtio-status`` *path*
925 Display status of a given virtio device
926 ERST
927
928 {
929 .name = "virtio-queue-status",
930 .args_type = "path:s,queue:i",
931 .params = "path queue",
932 .help = "Display status of a given virtio queue",
933 .cmd = hmp_virtio_queue_status,
934 .flags = "p",
935 },
936
937 SRST
938 ``info virtio-queue-status`` *path* *queue*
939 Display status of a given virtio queue
940 ERST
941
942 {
943 .name = "virtio-vhost-queue-status",
944 .args_type = "path:s,queue:i",
945 .params = "path queue",
946 .help = "Display status of a given vhost queue",
947 .cmd = hmp_vhost_queue_status,
948 .flags = "p",
949 },
950
951 SRST
952 ``info virtio-vhost-queue-status`` *path* *queue*
953 Display status of a given vhost queue
954 ERST
955
956 {
957 .name = "virtio-queue-element",
958 .args_type = "path:s,queue:i,index:i?",
959 .params = "path queue [index]",
960 .help = "Display element of a given virtio queue",
961 .cmd = hmp_virtio_queue_element,
962 .flags = "p",
963 },
964
965 SRST
966 ``info virtio-queue-element`` *path* *queue* [*index*]
967 Display element of a given virtio queue
968 ERST
969
970 {
971 .name = "cryptodev",
972 .args_type = "",
973 .params = "",
974 .help = "show the crypto devices",
975 .cmd = hmp_info_cryptodev,
976 .flags = "p",
977 },
978
979 SRST
980 ``info cryptodev``
981 Show the crypto devices.
982 ERST
983
984 {
985 .name = "firmware-log",
986 .args_type = "max-size:o?",
987 .params = "[max-size]",
988 .help = "show the firmware (ovmf) debug log",
989 .cmd = hmp_info_firmware_log,
990 },
991
992 SRST
993 ``info firmware-log``
994 Show the firmware (ovmf) debug log.
995 ERST