xref: /openbmc/qemu/hmp-commands-info.hx (revision f28d0dfd) 
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 i8259 (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",
257        .params     = "[-f][-d]",
258        .help       = "show memory tree (-f: dump flat view for address spaces;"
259                      "-d: dump dispatch tree, valid with -f only)",
260        .cmd        = hmp_info_mtree,
261    },
262
263STEXI
264@item info mtree
265@findex info mtree
266Show memory tree.
267ETEXI
268
269#if defined(CONFIG_TCG)
270    {
271        .name       = "jit",
272        .args_type  = "",
273        .params     = "",
274        .help       = "show dynamic compiler info",
275        .cmd        = hmp_info_jit,
276    },
277#endif
278
279STEXI
280@item info jit
281@findex info jit
282Show dynamic compiler info.
283ETEXI
284
285#if defined(CONFIG_TCG)
286    {
287        .name       = "opcount",
288        .args_type  = "",
289        .params     = "",
290        .help       = "show dynamic compiler opcode counters",
291        .cmd        = hmp_info_opcount,
292    },
293#endif
294
295STEXI
296@item info opcount
297@findex info opcount
298Show dynamic compiler opcode counters
299ETEXI
300
301    {
302        .name       = "kvm",
303        .args_type  = "",
304        .params     = "",
305        .help       = "show KVM information",
306        .cmd        = hmp_info_kvm,
307    },
308
309STEXI
310@item info kvm
311@findex info kvm
312Show KVM information.
313ETEXI
314
315    {
316        .name       = "numa",
317        .args_type  = "",
318        .params     = "",
319        .help       = "show NUMA information",
320        .cmd        = hmp_info_numa,
321    },
322
323STEXI
324@item info numa
325@findex info numa
326Show NUMA information.
327ETEXI
328
329    {
330        .name       = "usb",
331        .args_type  = "",
332        .params     = "",
333        .help       = "show guest USB devices",
334        .cmd        = hmp_info_usb,
335    },
336
337STEXI
338@item info usb
339@findex info usb
340Show guest USB devices.
341ETEXI
342
343    {
344        .name       = "usbhost",
345        .args_type  = "",
346        .params     = "",
347        .help       = "show host USB devices",
348        .cmd        = hmp_info_usbhost,
349    },
350
351STEXI
352@item info usbhost
353@findex info usbhost
354Show host USB devices.
355ETEXI
356
357    {
358        .name       = "profile",
359        .args_type  = "",
360        .params     = "",
361        .help       = "show profiling information",
362        .cmd        = hmp_info_profile,
363    },
364
365STEXI
366@item info profile
367@findex info profile
368Show profiling information.
369ETEXI
370
371    {
372        .name       = "capture",
373        .args_type  = "",
374        .params     = "",
375        .help       = "show capture information",
376        .cmd        = hmp_info_capture,
377    },
378
379STEXI
380@item info capture
381@findex info capture
382Show capture information.
383ETEXI
384
385    {
386        .name       = "snapshots",
387        .args_type  = "",
388        .params     = "",
389        .help       = "show the currently saved VM snapshots",
390        .cmd        = hmp_info_snapshots,
391    },
392
393STEXI
394@item info snapshots
395@findex info snapshots
396Show the currently saved VM snapshots.
397ETEXI
398
399    {
400        .name       = "status",
401        .args_type  = "",
402        .params     = "",
403        .help       = "show the current VM status (running|paused)",
404        .cmd        = hmp_info_status,
405        .flags      = "p",
406    },
407
408STEXI
409@item info status
410@findex info status
411Show the current VM status (running|paused).
412ETEXI
413
414    {
415        .name       = "mice",
416        .args_type  = "",
417        .params     = "",
418        .help       = "show which guest mouse is receiving events",
419        .cmd        = hmp_info_mice,
420    },
421
422STEXI
423@item info mice
424@findex info mice
425Show which guest mouse is receiving events.
426ETEXI
427
428    {
429        .name       = "vnc",
430        .args_type  = "",
431        .params     = "",
432        .help       = "show the vnc server status",
433        .cmd        = hmp_info_vnc,
434    },
435
436STEXI
437@item info vnc
438@findex info vnc
439Show the vnc server status.
440ETEXI
441
442#if defined(CONFIG_SPICE)
443    {
444        .name       = "spice",
445        .args_type  = "",
446        .params     = "",
447        .help       = "show the spice server status",
448        .cmd        = hmp_info_spice,
449    },
450#endif
451
452STEXI
453@item info spice
454@findex info spice
455Show the spice server status.
456ETEXI
457
458    {
459        .name       = "name",
460        .args_type  = "",
461        .params     = "",
462        .help       = "show the current VM name",
463        .cmd        = hmp_info_name,
464        .flags      = "p",
465    },
466
467STEXI
468@item info name
469@findex info name
470Show the current VM name.
471ETEXI
472
473    {
474        .name       = "uuid",
475        .args_type  = "",
476        .params     = "",
477        .help       = "show the current VM UUID",
478        .cmd        = hmp_info_uuid,
479        .flags      = "p",
480    },
481
482STEXI
483@item info uuid
484@findex info uuid
485Show the current VM UUID.
486ETEXI
487
488    {
489        .name       = "cpustats",
490        .args_type  = "",
491        .params     = "",
492        .help       = "show CPU statistics",
493        .cmd        = hmp_info_cpustats,
494    },
495
496STEXI
497@item info cpustats
498@findex info cpustats
499Show CPU statistics.
500ETEXI
501
502#if defined(CONFIG_SLIRP)
503    {
504        .name       = "usernet",
505        .args_type  = "",
506        .params     = "",
507        .help       = "show user network stack connection states",
508        .cmd        = hmp_info_usernet,
509    },
510#endif
511
512STEXI
513@item info usernet
514@findex info usernet
515Show user network stack connection states.
516ETEXI
517
518    {
519        .name       = "migrate",
520        .args_type  = "",
521        .params     = "",
522        .help       = "show migration status",
523        .cmd        = hmp_info_migrate,
524    },
525
526STEXI
527@item info migrate
528@findex info migrate
529Show migration status.
530ETEXI
531
532    {
533        .name       = "migrate_capabilities",
534        .args_type  = "",
535        .params     = "",
536        .help       = "show current migration capabilities",
537        .cmd        = hmp_info_migrate_capabilities,
538    },
539
540STEXI
541@item info migrate_capabilities
542@findex info migrate_capabilities
543Show current migration capabilities.
544ETEXI
545
546    {
547        .name       = "migrate_parameters",
548        .args_type  = "",
549        .params     = "",
550        .help       = "show current migration parameters",
551        .cmd        = hmp_info_migrate_parameters,
552    },
553
554STEXI
555@item info migrate_parameters
556@findex info migrate_parameters
557Show current migration parameters.
558ETEXI
559
560    {
561        .name       = "migrate_cache_size",
562        .args_type  = "",
563        .params     = "",
564        .help       = "show current migration xbzrle cache size",
565        .cmd        = hmp_info_migrate_cache_size,
566    },
567
568STEXI
569@item info migrate_cache_size
570@findex info migrate_cache_size
571Show current migration xbzrle cache size.
572ETEXI
573
574    {
575        .name       = "balloon",
576        .args_type  = "",
577        .params     = "",
578        .help       = "show balloon information",
579        .cmd        = hmp_info_balloon,
580    },
581
582STEXI
583@item info balloon
584@findex info balloon
585Show balloon information.
586ETEXI
587
588    {
589        .name       = "qtree",
590        .args_type  = "",
591        .params     = "",
592        .help       = "show device tree",
593        .cmd        = hmp_info_qtree,
594    },
595
596STEXI
597@item info qtree
598@findex info qtree
599Show device tree.
600ETEXI
601
602    {
603        .name       = "qdm",
604        .args_type  = "",
605        .params     = "",
606        .help       = "show qdev device model list",
607        .cmd        = hmp_info_qdm,
608    },
609
610STEXI
611@item info qdm
612@findex info qdm
613Show qdev device model list.
614ETEXI
615
616    {
617        .name       = "qom-tree",
618        .args_type  = "path:s?",
619        .params     = "[path]",
620        .help       = "show QOM composition tree",
621        .cmd        = hmp_info_qom_tree,
622        .flags      = "p",
623    },
624
625STEXI
626@item info qom-tree
627@findex info qom-tree
628Show QOM composition tree.
629ETEXI
630
631    {
632        .name       = "roms",
633        .args_type  = "",
634        .params     = "",
635        .help       = "show roms",
636        .cmd        = hmp_info_roms,
637    },
638
639STEXI
640@item info roms
641@findex info roms
642Show roms.
643ETEXI
644
645    {
646        .name       = "trace-events",
647        .args_type  = "name:s?,vcpu:i?",
648        .params     = "[name] [vcpu]",
649        .help       = "show available trace-events & their state "
650                      "(name: event name pattern; vcpu: vCPU to query, default is any)",
651        .cmd = hmp_info_trace_events,
652        .command_completion = info_trace_events_completion,
653    },
654
655STEXI
656@item info trace-events
657@findex info trace-events
658Show available trace-events & their state.
659ETEXI
660
661    {
662        .name       = "tpm",
663        .args_type  = "",
664        .params     = "",
665        .help       = "show the TPM device",
666        .cmd        = hmp_info_tpm,
667    },
668
669STEXI
670@item info tpm
671@findex info tpm
672Show the TPM device.
673ETEXI
674
675    {
676        .name       = "memdev",
677        .args_type  = "",
678        .params     = "",
679        .help       = "show memory backends",
680        .cmd        = hmp_info_memdev,
681        .flags      = "p",
682    },
683
684STEXI
685@item info memdev
686@findex info memdev
687Show memory backends
688ETEXI
689
690    {
691        .name       = "memory-devices",
692        .args_type  = "",
693        .params     = "",
694        .help       = "show memory devices",
695        .cmd        = hmp_info_memory_devices,
696    },
697
698STEXI
699@item info memory-devices
700@findex info memory-devices
701Show memory devices.
702ETEXI
703
704    {
705        .name       = "iothreads",
706        .args_type  = "",
707        .params     = "",
708        .help       = "show iothreads",
709        .cmd        = hmp_info_iothreads,
710        .flags      = "p",
711    },
712
713STEXI
714@item info iothreads
715@findex info iothreads
716Show iothread's identifiers.
717ETEXI
718
719    {
720        .name       = "rocker",
721        .args_type  = "name:s",
722        .params     = "name",
723        .help       = "Show rocker switch",
724        .cmd        = hmp_rocker,
725    },
726
727STEXI
728@item info rocker @var{name}
729@findex info rocker
730Show rocker switch.
731ETEXI
732
733    {
734        .name       = "rocker-ports",
735        .args_type  = "name:s",
736        .params     = "name",
737        .help       = "Show rocker ports",
738        .cmd        = hmp_rocker_ports,
739    },
740
741STEXI
742@item info rocker-ports @var{name}-ports
743@findex info rocker-ports
744Show rocker ports.
745ETEXI
746
747    {
748        .name       = "rocker-of-dpa-flows",
749        .args_type  = "name:s,tbl_id:i?",
750        .params     = "name [tbl_id]",
751        .help       = "Show rocker OF-DPA flow tables",
752        .cmd        = hmp_rocker_of_dpa_flows,
753    },
754
755STEXI
756@item info rocker-of-dpa-flows @var{name} [@var{tbl_id}]
757@findex info rocker-of-dpa-flows
758Show rocker OF-DPA flow tables.
759ETEXI
760
761    {
762        .name       = "rocker-of-dpa-groups",
763        .args_type  = "name:s,type:i?",
764        .params     = "name [type]",
765        .help       = "Show rocker OF-DPA groups",
766        .cmd        = hmp_rocker_of_dpa_groups,
767    },
768
769STEXI
770@item info rocker-of-dpa-groups @var{name} [@var{type}]
771@findex info rocker-of-dpa-groups
772Show rocker OF-DPA groups.
773ETEXI
774
775#if defined(TARGET_S390X)
776    {
777        .name       = "skeys",
778        .args_type  = "addr:l",
779        .params     = "address",
780        .help       = "Display the value of a storage key",
781        .cmd        = hmp_info_skeys,
782    },
783#endif
784
785STEXI
786@item info skeys @var{address}
787@findex info skeys
788Display the value of a storage key (s390 only)
789ETEXI
790
791#if defined(TARGET_S390X)
792    {
793        .name       = "cmma",
794        .args_type  = "addr:l,count:l?",
795        .params     = "address [count]",
796        .help       = "Display the values of the CMMA storage attributes for a range of pages",
797        .cmd        = hmp_info_cmma,
798    },
799#endif
800
801STEXI
802@item info cmma @var{address}
803@findex info cmma
804Display the values of the CMMA storage attributes for a range of pages (s390 only)
805ETEXI
806
807    {
808        .name       = "dump",
809        .args_type  = "",
810        .params     = "",
811        .help       = "Display the latest dump status",
812        .cmd        = hmp_info_dump,
813    },
814
815STEXI
816@item info dump
817@findex info dump
818Display the latest dump status.
819ETEXI
820
821    {
822        .name       = "ramblock",
823        .args_type  = "",
824        .params     = "",
825        .help       = "Display system ramblock information",
826        .cmd        = hmp_info_ramblock,
827    },
828
829STEXI
830@item info ramblock
831@findex info ramblock
832Dump all the ramblocks of the system.
833ETEXI
834
835    {
836        .name       = "hotpluggable-cpus",
837        .args_type  = "",
838        .params     = "",
839        .help       = "Show information about hotpluggable CPUs",
840        .cmd        = hmp_hotpluggable_cpus,
841        .flags      = "p",
842    },
843
844STEXI
845@item info hotpluggable-cpus
846@findex info hotpluggable-cpus
847Show information about hotpluggable CPUs
848ETEXI
849
850    {
851        .name       = "vm-generation-id",
852        .args_type  = "",
853        .params     = "",
854        .help       = "Show Virtual Machine Generation ID",
855        .cmd = hmp_info_vm_generation_id,
856    },
857
858STEXI
859@item info vm-generation-id
860@findex info vm-generation-id
861Show Virtual Machine Generation ID
862ETEXI
863
864    {
865        .name       = "memory_size_summary",
866        .args_type  = "",
867        .params     = "",
868        .help       = "show the amount of initially allocated and "
869                      "present hotpluggable (if enabled) memory in bytes.",
870        .cmd        = hmp_info_memory_size_summary,
871    },
872
873STEXI
874@item info memory_size_summary
875@findex info memory_size_summary
876Display the amount of initially allocated and present hotpluggable (if
877enabled) memory in bytes.
878ETEXI
879
880#if defined(TARGET_I386)
881    {
882        .name       = "sev",
883        .args_type  = "",
884        .params     = "",
885        .help       = "show SEV information",
886        .cmd        = hmp_info_sev,
887    },
888#endif
889
890STEXI
891@item info sev
892@findex info sev
893Show SEV information.
894ETEXI
895
896STEXI
897@end table
898ETEXI
899
900STEXI
901@end table
902ETEXI
903