xref: /openbmc/qemu/hmp-commands-info.hx (revision f8ed85ac992c48814d916d5df4d44f9a971c5de4) 
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        .mhandler.cmd = hmp_info_version,
22    },
23
24STEXI
25@item info version
26@findex version
27Show the version of QEMU.
28ETEXI
29
30    {
31        .name       = "network",
32        .args_type  = "",
33        .params     = "",
34        .help       = "show the network state",
35        .mhandler.cmd = hmp_info_network,
36    },
37
38STEXI
39@item info network
40@findex network
41Show the network state.
42ETEXI
43
44    {
45        .name       = "chardev",
46        .args_type  = "",
47        .params     = "",
48        .help       = "show the character devices",
49        .mhandler.cmd = hmp_info_chardev,
50    },
51
52STEXI
53@item info chardev
54@findex chardev
55Show the character devices.
56ETEXI
57
58    {
59        .name       = "block",
60        .args_type  = "nodes:-n,verbose:-v,device:B?",
61        .params     = "[-n] [-v] [device]",
62        .help       = "show info of one block device or all block devices "
63                      "(-n: show named nodes; -v: show details)",
64        .mhandler.cmd = hmp_info_block,
65    },
66
67STEXI
68@item info block
69@findex block
70Show info of one block device or all block devices.
71ETEXI
72
73    {
74        .name       = "blockstats",
75        .args_type  = "",
76        .params     = "",
77        .help       = "show block device statistics",
78        .mhandler.cmd = hmp_info_blockstats,
79    },
80
81STEXI
82@item info blockstats
83@findex blockstats
84Show block device statistics.
85ETEXI
86
87    {
88        .name       = "block-jobs",
89        .args_type  = "",
90        .params     = "",
91        .help       = "show progress of ongoing block device operations",
92        .mhandler.cmd = hmp_info_block_jobs,
93    },
94
95STEXI
96@item info block-jobs
97@findex block-jobs
98Show progress of ongoing block device operations.
99ETEXI
100
101    {
102        .name       = "registers",
103        .args_type  = "",
104        .params     = "",
105        .help       = "show the cpu registers",
106        .mhandler.cmd = hmp_info_registers,
107    },
108
109STEXI
110@item info registers
111@findex registers
112Show the cpu registers.
113ETEXI
114
115    {
116        .name       = "cpus",
117        .args_type  = "",
118        .params     = "",
119        .help       = "show infos for each CPU",
120        .mhandler.cmd = hmp_info_cpus,
121    },
122
123STEXI
124@item info cpus
125@findex cpus
126Show infos for each CPU.
127ETEXI
128
129    {
130        .name       = "history",
131        .args_type  = "",
132        .params     = "",
133        .help       = "show the command line history",
134        .mhandler.cmd = hmp_info_history,
135    },
136
137STEXI
138@item info history
139@findex history
140Show the command line history.
141ETEXI
142
143#if defined(TARGET_I386) || defined(TARGET_PPC) || defined(TARGET_MIPS) || \
144    defined(TARGET_LM32) || (defined(TARGET_SPARC) && !defined(TARGET_SPARC64))
145    {
146        .name       = "irq",
147        .args_type  = "",
148        .params     = "",
149        .help       = "show the interrupts statistics (if available)",
150#ifdef TARGET_SPARC
151        .mhandler.cmd = sun4m_hmp_info_irq,
152#elif defined(TARGET_LM32)
153        .mhandler.cmd = lm32_hmp_info_irq,
154#else
155        .mhandler.cmd = hmp_info_irq,
156#endif
157    },
158
159STEXI
160@item info irq
161@findex irq
162Show the interrupts statistics (if available).
163ETEXI
164
165    {
166        .name       = "pic",
167        .args_type  = "",
168        .params     = "",
169        .help       = "show i8259 (PIC) state",
170#ifdef TARGET_SPARC
171        .mhandler.cmd = sun4m_hmp_info_pic,
172#elif defined(TARGET_LM32)
173        .mhandler.cmd = lm32_hmp_info_pic,
174#else
175        .mhandler.cmd = hmp_info_pic,
176#endif
177    },
178#endif
179
180STEXI
181@item info pic
182@findex pic
183Show i8259 (PIC) state.
184ETEXI
185
186#if defined(TARGET_I386) || defined(TARGET_SH4) || defined(TARGET_SPARC) || \
187    defined(TARGET_PPC) || defined(TARGET_XTENSA)
188    {
189        .name       = "tlb",
190        .args_type  = "",
191        .params     = "",
192        .help       = "show virtual to physical memory mappings",
193        .mhandler.cmd = hmp_info_tlb,
194    },
195#endif
196
197STEXI
198@item info tlb
199@findex tlb
200Show virtual to physical memory mappings.
201ETEXI
202
203#if defined(TARGET_I386)
204    {
205        .name       = "mem",
206        .args_type  = "",
207        .params     = "",
208        .help       = "show the active virtual memory mappings",
209        .mhandler.cmd = hmp_info_mem,
210    },
211#endif
212
213STEXI
214@item info mem
215@findex mem
216Show the active virtual memory mappings.
217ETEXI
218
219    {
220        .name       = "mtree",
221        .args_type  = "",
222        .params     = "",
223        .help       = "show memory tree",
224        .mhandler.cmd = hmp_info_mtree,
225    },
226
227STEXI
228@item info mtree
229@findex mtree
230Show memory tree.
231ETEXI
232
233    {
234        .name       = "jit",
235        .args_type  = "",
236        .params     = "",
237        .help       = "show dynamic compiler info",
238        .mhandler.cmd = hmp_info_jit,
239    },
240
241STEXI
242@item info jit
243@findex jit
244Show dynamic compiler info.
245ETEXI
246
247    {
248        .name       = "opcount",
249        .args_type  = "",
250        .params     = "",
251        .help       = "show dynamic compiler opcode counters",
252        .mhandler.cmd = hmp_info_opcount,
253    },
254
255STEXI
256@item info opcount
257@findex opcount
258Show dynamic compiler opcode counters
259ETEXI
260
261    {
262        .name       = "kvm",
263        .args_type  = "",
264        .params     = "",
265        .help       = "show KVM information",
266        .mhandler.cmd = hmp_info_kvm,
267    },
268
269STEXI
270@item info kvm
271@findex kvm
272Show KVM information.
273ETEXI
274
275    {
276        .name       = "numa",
277        .args_type  = "",
278        .params     = "",
279        .help       = "show NUMA information",
280        .mhandler.cmd = hmp_info_numa,
281    },
282
283STEXI
284@item info numa
285@findex numa
286Show NUMA information.
287ETEXI
288
289    {
290        .name       = "usb",
291        .args_type  = "",
292        .params     = "",
293        .help       = "show guest USB devices",
294        .mhandler.cmd = hmp_info_usb,
295    },
296
297STEXI
298@item info usb
299@findex usb
300Show guest USB devices.
301ETEXI
302
303    {
304        .name       = "usbhost",
305        .args_type  = "",
306        .params     = "",
307        .help       = "show host USB devices",
308        .mhandler.cmd = hmp_info_usbhost,
309    },
310
311STEXI
312@item info usbhost
313@findex usbhost
314Show host USB devices.
315ETEXI
316
317    {
318        .name       = "profile",
319        .args_type  = "",
320        .params     = "",
321        .help       = "show profiling information",
322        .mhandler.cmd = hmp_info_profile,
323    },
324
325STEXI
326@item info profile
327@findex profile
328Show profiling information.
329ETEXI
330
331    {
332        .name       = "capture",
333        .args_type  = "",
334        .params     = "",
335        .help       = "show capture information",
336        .mhandler.cmd = hmp_info_capture,
337    },
338
339STEXI
340@item info capture
341@findex capture
342Show capture information.
343ETEXI
344
345    {
346        .name       = "snapshots",
347        .args_type  = "",
348        .params     = "",
349        .help       = "show the currently saved VM snapshots",
350        .mhandler.cmd = hmp_info_snapshots,
351    },
352
353STEXI
354@item info snapshots
355@findex snapshots
356Show the currently saved VM snapshots.
357ETEXI
358
359    {
360        .name       = "status",
361        .args_type  = "",
362        .params     = "",
363        .help       = "show the current VM status (running|paused)",
364        .mhandler.cmd = hmp_info_status,
365    },
366
367STEXI
368@item info status
369@findex status
370Show the current VM status (running|paused).
371ETEXI
372
373    {
374        .name       = "mice",
375        .args_type  = "",
376        .params     = "",
377        .help       = "show which guest mouse is receiving events",
378        .mhandler.cmd = hmp_info_mice,
379    },
380
381STEXI
382@item info mice
383@findex mice
384Show which guest mouse is receiving events.
385ETEXI
386
387    {
388        .name       = "vnc",
389        .args_type  = "",
390        .params     = "",
391        .help       = "show the vnc server status",
392        .mhandler.cmd = hmp_info_vnc,
393    },
394
395STEXI
396@item info vnc
397@findex vnc
398Show the vnc server status.
399ETEXI
400
401#if defined(CONFIG_SPICE)
402    {
403        .name       = "spice",
404        .args_type  = "",
405        .params     = "",
406        .help       = "show the spice server status",
407        .mhandler.cmd = hmp_info_spice,
408    },
409#endif
410
411STEXI
412@item info spice
413@findex spice
414Show the spice server status.
415ETEXI
416
417    {
418        .name       = "name",
419        .args_type  = "",
420        .params     = "",
421        .help       = "show the current VM name",
422        .mhandler.cmd = hmp_info_name,
423    },
424
425STEXI
426@item info name
427@findex name
428Show the current VM name.
429ETEXI
430
431    {
432        .name       = "uuid",
433        .args_type  = "",
434        .params     = "",
435        .help       = "show the current VM UUID",
436        .mhandler.cmd = hmp_info_uuid,
437    },
438
439STEXI
440@item info uuid
441@findex uuid
442Show the current VM UUID.
443ETEXI
444
445    {
446        .name       = "cpustats",
447        .args_type  = "",
448        .params     = "",
449        .help       = "show CPU statistics",
450        .mhandler.cmd = hmp_info_cpustats,
451    },
452
453STEXI
454@item info cpustats
455@findex cpustats
456Show CPU statistics.
457ETEXI
458
459#if defined(CONFIG_SLIRP)
460    {
461        .name       = "usernet",
462        .args_type  = "",
463        .params     = "",
464        .help       = "show user network stack connection states",
465        .mhandler.cmd = hmp_info_usernet,
466    },
467#endif
468
469STEXI
470@item info usernet
471@findex usernet
472Show user network stack connection states.
473ETEXI
474
475    {
476        .name       = "migrate",
477        .args_type  = "",
478        .params     = "",
479        .help       = "show migration status",
480        .mhandler.cmd = hmp_info_migrate,
481    },
482
483STEXI
484@item info migrate
485@findex migrate
486Show migration status.
487ETEXI
488
489    {
490        .name       = "migrate_capabilities",
491        .args_type  = "",
492        .params     = "",
493        .help       = "show current migration capabilities",
494        .mhandler.cmd = hmp_info_migrate_capabilities,
495    },
496
497STEXI
498@item info migrate_capabilities
499@findex migrate_capabilities
500Show current migration capabilities.
501ETEXI
502
503    {
504        .name       = "migrate_parameters",
505        .args_type  = "",
506        .params     = "",
507        .help       = "show current migration parameters",
508        .mhandler.cmd = hmp_info_migrate_parameters,
509    },
510
511STEXI
512@item info migrate_parameters
513@findex migrate_parameters
514Show current migration parameters.
515ETEXI
516
517    {
518        .name       = "migrate_cache_size",
519        .args_type  = "",
520        .params     = "",
521        .help       = "show current migration xbzrle cache size",
522        .mhandler.cmd = hmp_info_migrate_cache_size,
523    },
524
525STEXI
526@item info migrate_cache_size
527@findex migrate_cache_size
528Show current migration xbzrle cache size.
529ETEXI
530
531    {
532        .name       = "balloon",
533        .args_type  = "",
534        .params     = "",
535        .help       = "show balloon information",
536        .mhandler.cmd = hmp_info_balloon,
537    },
538
539STEXI
540@item info balloon
541@findex balloon
542Show balloon information.
543ETEXI
544
545    {
546        .name       = "qtree",
547        .args_type  = "",
548        .params     = "",
549        .help       = "show device tree",
550        .mhandler.cmd = hmp_info_qtree,
551    },
552
553STEXI
554@item info qtree
555@findex qtree
556Show device tree.
557ETEXI
558
559    {
560        .name       = "qdm",
561        .args_type  = "",
562        .params     = "",
563        .help       = "show qdev device model list",
564        .mhandler.cmd = hmp_info_qdm,
565    },
566
567STEXI
568@item info qdm
569@findex qdm
570Show qdev device model list.
571ETEXI
572
573    {
574        .name       = "qom-tree",
575        .args_type  = "path:s?",
576        .params     = "[path]",
577        .help       = "show QOM composition tree",
578        .mhandler.cmd = hmp_info_qom_tree,
579    },
580
581STEXI
582@item info qom-tree
583@findex qom-tree
584Show QOM composition tree.
585ETEXI
586
587    {
588        .name       = "roms",
589        .args_type  = "",
590        .params     = "",
591        .help       = "show roms",
592        .mhandler.cmd = hmp_info_roms,
593    },
594
595STEXI
596@item info roms
597@findex roms
598Show roms.
599ETEXI
600
601    {
602        .name       = "trace-events",
603        .args_type  = "",
604        .params     = "",
605        .help       = "show available trace-events & their state",
606        .mhandler.cmd = hmp_info_trace_events,
607    },
608
609STEXI
610@item info trace-events
611@findex trace-events
612Show available trace-events & their state.
613ETEXI
614
615    {
616        .name       = "tpm",
617        .args_type  = "",
618        .params     = "",
619        .help       = "show the TPM device",
620        .mhandler.cmd = hmp_info_tpm,
621    },
622
623STEXI
624@item info tpm
625@findex tpm
626Show the TPM device.
627ETEXI
628
629    {
630        .name       = "memdev",
631        .args_type  = "",
632        .params     = "",
633        .help       = "show memory backends",
634        .mhandler.cmd = hmp_info_memdev,
635    },
636
637STEXI
638@item info memdev
639@findex memdev
640Show memory backends
641ETEXI
642
643    {
644        .name       = "memory-devices",
645        .args_type  = "",
646        .params     = "",
647        .help       = "show memory devices",
648        .mhandler.cmd = hmp_info_memory_devices,
649    },
650
651STEXI
652@item info memory-devices
653@findex memory-devices
654Show memory devices.
655ETEXI
656
657    {
658        .name       = "iothreads",
659        .args_type  = "",
660        .params     = "",
661        .help       = "show iothreads",
662        .mhandler.cmd = hmp_info_iothreads,
663    },
664
665STEXI
666@item info iothreads
667@findex iothreads
668Show iothread's identifiers.
669ETEXI
670
671    {
672        .name       = "rocker",
673        .args_type  = "name:s",
674        .params     = "name",
675        .help       = "Show rocker switch",
676        .mhandler.cmd = hmp_rocker,
677    },
678
679STEXI
680@item info rocker @var{name}
681@findex rocker
682Show rocker switch.
683ETEXI
684
685    {
686        .name       = "rocker-ports",
687        .args_type  = "name:s",
688        .params     = "name",
689        .help       = "Show rocker ports",
690        .mhandler.cmd = hmp_rocker_ports,
691    },
692
693STEXI
694@item info rocker_ports @var{name}-ports
695@findex ocker-ports
696Show rocker ports.
697ETEXI
698
699    {
700        .name       = "rocker-of-dpa-flows",
701        .args_type  = "name:s,tbl_id:i?",
702        .params     = "name [tbl_id]",
703        .help       = "Show rocker OF-DPA flow tables",
704        .mhandler.cmd = hmp_rocker_of_dpa_flows,
705    },
706
707STEXI
708@item info rocker_of_dpa_flows @var{name} [@var{tbl_id}]
709@findex rocker-of-dpa-flows
710Show rocker OF-DPA flow tables.
711ETEXI
712
713    {
714        .name       = "rocker-of-dpa-groups",
715        .args_type  = "name:s,type:i?",
716        .params     = "name [type]",
717        .help       = "Show rocker OF-DPA groups",
718        .mhandler.cmd = hmp_rocker_of_dpa_groups,
719    },
720
721STEXI
722@item info rocker-of-dpa-groups @var{name} [@var{type}]
723@findex rocker-of-dpa-groups
724Show rocker OF-DPA groups.
725ETEXI
726
727#if defined(TARGET_S390X)
728    {
729        .name       = "skeys",
730        .args_type  = "addr:l",
731        .params     = "address",
732        .help       = "Display the value of a storage key",
733        .mhandler.cmd = hmp_info_skeys,
734    },
735#endif
736
737STEXI
738@item info skeys @var{address}
739@findex skeys
740Display the value of a storage key (s390 only)
741ETEXI
742
743STEXI
744@end table
745ETEXI
746
747STEXI
748@end table
749ETEXI
750