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