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