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