X-Git-Url: http://git.osdn.net/view?a=blobdiff_plain;f=hmp-commands-info.hx;h=f5b37eb74abfa56e60ee4b2b15a9c87510e44ddb;hb=0180a744636e6951996240b96a250d20ad0fad0d;hp=257ee7d7a3f9249ca14e5d35016ea90fd296b355;hpb=f5c7af6295b18c9cb9bc183648ce37481b49f432;p=qmiga%2Fqemu.git diff --git a/hmp-commands-info.hx b/hmp-commands-info.hx index 257ee7d7a3..f5b37eb74a 100644 --- a/hmp-commands-info.hx +++ b/hmp-commands-info.hx @@ -1,17 +1,21 @@ -HXCOMM Use DEFHEADING() to define headings in both help text and texi -HXCOMM Text between STEXI and ETEXI are copied to texi version and -HXCOMM discarded from C version +HXCOMM Use DEFHEADING() to define headings in both help text and rST. +HXCOMM Text between SRST and ERST is copied to the rST version and +HXCOMM discarded from C version. HXCOMM DEF(command, args, callback, arg_string, help) is used to construct HXCOMM monitor info commands -HXCOMM HXCOMM can be used for comments, discarded from both texi and C +HXCOMM HXCOMM can be used for comments, discarded from both rST and C. +HXCOMM +HXCOMM In this file, generally SRST fragments should have two extra +HXCOMM spaces of indent, so that the documentation list item for "info foo" +HXCOMM appears inside the documentation list item for the top level +HXCOMM "info" documentation entry. The exception is the first SRST +HXCOMM fragment that defines that top level entry. -STEXI -@table @option -@item info @var{subcommand} -@findex info -Show various information about the system state. -@table @option -ETEXI +SRST +``info`` *subcommand* + Show various information about the system state. + +ERST { .name = "version", @@ -22,11 +26,10 @@ ETEXI .flags = "p", }, -STEXI -@item info version -@findex info version -Show the version of QEMU. -ETEXI +SRST + ``info version`` + Show the version of QEMU. +ERST { .name = "network", @@ -36,11 +39,10 @@ ETEXI .cmd = hmp_info_network, }, -STEXI -@item info network -@findex info network -Show the network state. -ETEXI +SRST + ``info network`` + Show the network state. +ERST { .name = "chardev", @@ -51,11 +53,10 @@ ETEXI .flags = "p", }, -STEXI -@item info chardev -@findex info chardev -Show the character devices. -ETEXI +SRST + ``info chardev`` + Show the character devices. +ERST { .name = "block", @@ -66,11 +67,10 @@ ETEXI .cmd = hmp_info_block, }, -STEXI -@item info block -@findex info block -Show info of one block device or all block devices. -ETEXI +SRST + ``info block`` + Show info of one block device or all block devices. +ERST { .name = "blockstats", @@ -80,11 +80,10 @@ ETEXI .cmd = hmp_info_blockstats, }, -STEXI -@item info blockstats -@findex info blockstats -Show block device statistics. -ETEXI +SRST + ``info blockstats`` + Show block device statistics. +ERST { .name = "block-jobs", @@ -94,25 +93,25 @@ ETEXI .cmd = hmp_info_block_jobs, }, -STEXI -@item info block-jobs -@findex info block-jobs -Show progress of ongoing block device operations. -ETEXI +SRST + ``info block-jobs`` + Show progress of ongoing block device operations. +ERST { .name = "registers", - .args_type = "cpustate_all:-a", - .params = "[-a]", - .help = "show the cpu registers (-a: all - show register info for all cpus)", + .args_type = "cpustate_all:-a,vcpu:i?", + .params = "[-a|vcpu]", + .help = "show the cpu registers (-a: show register info for all cpus;" + " vcpu: specific vCPU to query; show the current CPU's registers if" + " no argument is specified)", .cmd = hmp_info_registers, }, -STEXI -@item info registers -@findex info registers -Show the cpu registers. -ETEXI +SRST + ``info registers`` + Show the cpu registers. +ERST #if defined(TARGET_I386) { @@ -125,27 +124,10 @@ ETEXI }, #endif -STEXI -@item info lapic -@findex info lapic -Show local APIC state -ETEXI - -#if defined(TARGET_I386) - { - .name = "ioapic", - .args_type = "", - .params = "", - .help = "show io apic state", - .cmd = hmp_info_io_apic, - }, -#endif - -STEXI -@item info ioapic -@findex info ioapic -Show io APIC state -ETEXI +SRST + ``info lapic`` + Show local APIC state +ERST { .name = "cpus", @@ -155,11 +137,10 @@ ETEXI .cmd = hmp_info_cpus, }, -STEXI -@item info cpus -@findex info cpus -Show infos for each CPU. -ETEXI +SRST + ``info cpus`` + Show infos for each CPU. +ERST { .name = "history", @@ -170,25 +151,23 @@ ETEXI .flags = "p", }, -STEXI -@item info history -@findex info history -Show the command line history. -ETEXI +SRST + ``info history`` + Show the command line history. +ERST { .name = "irq", .args_type = "", .params = "", .help = "show the interrupts statistics (if available)", - .cmd = hmp_info_irq, + .cmd_info_hrt = qmp_x_query_irq, }, -STEXI -@item info irq -@findex info irq -Show the interrupts statistics (if available). -ETEXI +SRST + ``info irq`` + Show the interrupts statistics (if available). +ERST { .name = "pic", @@ -198,25 +177,23 @@ ETEXI .cmd = hmp_info_pic, }, -STEXI -@item info pic -@findex info pic -Show PIC state. -ETEXI +SRST + ``info pic`` + Show PIC state. +ERST { .name = "rdma", .args_type = "", .params = "", .help = "show RDMA state", - .cmd = hmp_info_rdma, + .cmd_info_hrt = qmp_x_query_rdma, }, -STEXI -@item info rdma -@findex info rdma -Show RDMA state. -ETEXI +SRST + ``info rdma`` + Show RDMA state. +ERST { .name = "pci", @@ -226,11 +203,10 @@ ETEXI .cmd = hmp_info_pci, }, -STEXI -@item info pci -@findex info pci -Show PCI information. -ETEXI +SRST + ``info pci`` + Show PCI information. +ERST #if defined(TARGET_I386) || defined(TARGET_SH4) || defined(TARGET_SPARC) || \ defined(TARGET_PPC) || defined(TARGET_XTENSA) || defined(TARGET_M68K) @@ -243,11 +219,10 @@ ETEXI }, #endif -STEXI -@item info tlb -@findex info tlb -Show virtual to physical memory mappings. -ETEXI +SRST + ``info tlb`` + Show virtual to physical memory mappings. +ERST #if defined(TARGET_I386) || defined(TARGET_RISCV) { @@ -259,27 +234,26 @@ ETEXI }, #endif -STEXI -@item info mem -@findex info mem -Show the active virtual memory mappings. -ETEXI +SRST + ``info mem`` + Show the active virtual memory mappings. +ERST { .name = "mtree", - .args_type = "flatview:-f,dispatch_tree:-d,owner:-o", - .params = "[-f][-d][-o]", + .args_type = "flatview:-f,dispatch_tree:-d,owner:-o,disabled:-D", + .params = "[-f][-d][-o][-D]", .help = "show memory tree (-f: dump flat view for address spaces;" "-d: dump dispatch tree, valid with -f only);" - "-o: dump region owners/parents", + "-o: dump region owners/parents;" + "-D: dump disabled regions", .cmd = hmp_info_mtree, }, -STEXI -@item info mtree -@findex info mtree -Show memory tree. -ETEXI +SRST + ``info mtree`` + Show memory tree. +ERST #if defined(CONFIG_TCG) { @@ -287,15 +261,13 @@ ETEXI .args_type = "", .params = "", .help = "show dynamic compiler info", - .cmd = hmp_info_jit, }, #endif -STEXI -@item info jit -@findex info jit -Show dynamic compiler info. -ETEXI +SRST + ``info jit`` + Show dynamic compiler info. +ERST #if defined(CONFIG_TCG) { @@ -303,15 +275,13 @@ ETEXI .args_type = "", .params = "", .help = "show dynamic compiler opcode counters", - .cmd = hmp_info_opcount, }, #endif -STEXI -@item info opcount -@findex info opcount -Show dynamic compiler opcode counters -ETEXI +SRST + ``info opcount`` + Show dynamic compiler opcode counters +ERST { .name = "sync-profile", @@ -324,16 +294,20 @@ ETEXI .cmd = hmp_info_sync_profile, }, -STEXI -@item info sync-profile [-m|-n] [@var{max}] -@findex info sync-profile -Show synchronization profiling info, up to @var{max} entries (default: 10), -sorted by total wait time. - -m: sort by mean wait time - -n: do not coalesce objects with the same call site -When different objects that share the same call site are coalesced, the "Object" -field shows---enclosed in brackets---the number of objects being coalesced. -ETEXI +SRST + ``info sync-profile [-m|-n]`` [*max*] + Show synchronization profiling info, up to *max* entries (default: 10), + sorted by total wait time. + + ``-m`` + sort by mean wait time + ``-n`` + do not coalesce objects with the same call site + + When different objects that share the same call site are coalesced, + the "Object" field shows---enclosed in brackets---the number of objects + being coalesced. +ERST { .name = "kvm", @@ -343,67 +317,48 @@ ETEXI .cmd = hmp_info_kvm, }, -STEXI -@item info kvm -@findex info kvm -Show KVM information. -ETEXI +SRST + ``info kvm`` + Show KVM information. +ERST { .name = "numa", .args_type = "", .params = "", .help = "show NUMA information", - .cmd = hmp_info_numa, + .cmd_info_hrt = qmp_x_query_numa, }, -STEXI -@item info numa -@findex info numa -Show NUMA information. -ETEXI +SRST + ``info numa`` + Show NUMA information. +ERST { .name = "usb", .args_type = "", .params = "", .help = "show guest USB devices", - .cmd = hmp_info_usb, + .cmd_info_hrt = qmp_x_query_usb, }, -STEXI -@item info usb -@findex info usb -Show guest USB devices. -ETEXI +SRST + ``info usb`` + Show guest USB devices. +ERST { .name = "usbhost", .args_type = "", .params = "", .help = "show host USB devices", - .cmd = hmp_info_usbhost, }, -STEXI -@item info usbhost -@findex info usbhost -Show host USB devices. -ETEXI - - { - .name = "profile", - .args_type = "", - .params = "", - .help = "show profiling information", - .cmd = hmp_info_profile, - }, - -STEXI -@item info profile -@findex info profile -Show profiling information. -ETEXI +SRST + ``info usbhost`` + Show host USB devices. +ERST { .name = "capture", @@ -413,11 +368,10 @@ ETEXI .cmd = hmp_info_capture, }, -STEXI -@item info capture -@findex info capture -Show capture information. -ETEXI +SRST + ``info capture`` + Show capture information. +ERST { .name = "snapshots", @@ -427,11 +381,10 @@ ETEXI .cmd = hmp_info_snapshots, }, -STEXI -@item info snapshots -@findex info snapshots -Show the currently saved VM snapshots. -ETEXI +SRST + ``info snapshots`` + Show the currently saved VM snapshots. +ERST { .name = "status", @@ -442,11 +395,10 @@ ETEXI .flags = "p", }, -STEXI -@item info status -@findex info status -Show the current VM status (running|paused). -ETEXI +SRST + ``info status`` + Show the current VM status (running|paused). +ERST { .name = "mice", @@ -456,11 +408,10 @@ ETEXI .cmd = hmp_info_mice, }, -STEXI -@item info mice -@findex info mice -Show which guest mouse is receiving events. -ETEXI +SRST + ``info mice`` + Show which guest mouse is receiving events. +ERST #if defined(CONFIG_VNC) { @@ -472,11 +423,10 @@ ETEXI }, #endif -STEXI -@item info vnc -@findex info vnc -Show the vnc server status. -ETEXI +SRST + ``info vnc`` + Show the vnc server status. +ERST #if defined(CONFIG_SPICE) { @@ -488,11 +438,10 @@ ETEXI }, #endif -STEXI -@item info spice -@findex info spice -Show the spice server status. -ETEXI +SRST + ``info spice`` + Show the spice server status. +ERST { .name = "name", @@ -503,11 +452,10 @@ ETEXI .flags = "p", }, -STEXI -@item info name -@findex info name -Show the current VM name. -ETEXI +SRST + ``info name`` + Show the current VM name. +ERST { .name = "uuid", @@ -518,25 +466,10 @@ ETEXI .flags = "p", }, -STEXI -@item info uuid -@findex info uuid -Show the current VM UUID. -ETEXI - - { - .name = "cpustats", - .args_type = "", - .params = "", - .help = "show CPU statistics", - .cmd = hmp_info_cpustats, - }, - -STEXI -@item info cpustats -@findex info cpustats -Show CPU statistics. -ETEXI +SRST + ``info uuid`` + Show the current VM UUID. +ERST #if defined(CONFIG_SLIRP) { @@ -548,11 +481,10 @@ ETEXI }, #endif -STEXI -@item info usernet -@findex info usernet -Show user network stack connection states. -ETEXI +SRST + ``info usernet`` + Show user network stack connection states. +ERST { .name = "migrate", @@ -562,11 +494,10 @@ ETEXI .cmd = hmp_info_migrate, }, -STEXI -@item info migrate -@findex info migrate -Show migration status. -ETEXI +SRST + ``info migrate`` + Show migration status. +ERST { .name = "migrate_capabilities", @@ -576,11 +507,10 @@ ETEXI .cmd = hmp_info_migrate_capabilities, }, -STEXI -@item info migrate_capabilities -@findex info migrate_capabilities -Show current migration capabilities. -ETEXI +SRST + ``info migrate_capabilities`` + Show current migration capabilities. +ERST { .name = "migrate_parameters", @@ -590,25 +520,10 @@ ETEXI .cmd = hmp_info_migrate_parameters, }, -STEXI -@item info migrate_parameters -@findex info migrate_parameters -Show current migration parameters. -ETEXI - - { - .name = "migrate_cache_size", - .args_type = "", - .params = "", - .help = "show current migration xbzrle cache size", - .cmd = hmp_info_migrate_cache_size, - }, - -STEXI -@item info migrate_cache_size -@findex info migrate_cache_size -Show current migration xbzrle cache size. -ETEXI +SRST + ``info migrate_parameters`` + Show current migration parameters. +ERST { .name = "balloon", @@ -618,11 +533,10 @@ ETEXI .cmd = hmp_info_balloon, }, -STEXI -@item info balloon -@findex info balloon -Show balloon information. -ETEXI +SRST + ``info balloon`` + Show balloon information. +ERST { .name = "qtree", @@ -632,11 +546,10 @@ ETEXI .cmd = hmp_info_qtree, }, -STEXI -@item info qtree -@findex info qtree -Show device tree. -ETEXI +SRST + ``info qtree`` + Show device tree. +ERST { .name = "qdm", @@ -646,11 +559,10 @@ ETEXI .cmd = hmp_info_qdm, }, -STEXI -@item info qdm -@findex info qdm -Show qdev device model list. -ETEXI +SRST + ``info qdm`` + Show qdev device model list. +ERST { .name = "qom-tree", @@ -661,25 +573,23 @@ ETEXI .flags = "p", }, -STEXI -@item info qom-tree -@findex info qom-tree -Show QOM composition tree. -ETEXI +SRST + ``info qom-tree`` + Show QOM composition tree. +ERST { .name = "roms", .args_type = "", .params = "", .help = "show roms", - .cmd = hmp_info_roms, + .cmd_info_hrt = qmp_x_query_roms, }, -STEXI -@item info roms -@findex info roms -Show roms. -ETEXI +SRST + ``info roms`` + Show roms. +ERST { .name = "trace-events", @@ -691,11 +601,10 @@ ETEXI .command_completion = info_trace_events_completion, }, -STEXI -@item info trace-events -@findex info trace-events -Show available trace-events & their state. -ETEXI +SRST + ``info trace-events`` + Show available trace-events & their state. +ERST { .name = "tpm", @@ -705,11 +614,10 @@ ETEXI .cmd = hmp_info_tpm, }, -STEXI -@item info tpm -@findex info tpm -Show the TPM device. -ETEXI +SRST + ``info tpm`` + Show the TPM device. +ERST { .name = "memdev", @@ -720,11 +628,10 @@ ETEXI .flags = "p", }, -STEXI -@item info memdev -@findex info memdev -Show memory backends -ETEXI +SRST + ``info memdev`` + Show memory backends +ERST { .name = "memory-devices", @@ -734,11 +641,10 @@ ETEXI .cmd = hmp_info_memory_devices, }, -STEXI -@item info memory-devices -@findex info memory-devices -Show memory devices. -ETEXI +SRST + ``info memory-devices`` + Show memory devices. +ERST { .name = "iothreads", @@ -749,11 +655,10 @@ ETEXI .flags = "p", }, -STEXI -@item info iothreads -@findex info iothreads -Show iothread's identifiers. -ETEXI +SRST + ``info iothreads`` + Show iothread's identifiers. +ERST { .name = "rocker", @@ -763,11 +668,10 @@ ETEXI .cmd = hmp_rocker, }, -STEXI -@item info rocker @var{name} -@findex info rocker -Show rocker switch. -ETEXI +SRST + ``info rocker`` *name* + Show rocker switch. +ERST { .name = "rocker-ports", @@ -777,11 +681,10 @@ ETEXI .cmd = hmp_rocker_ports, }, -STEXI -@item info rocker-ports @var{name}-ports -@findex info rocker-ports -Show rocker ports. -ETEXI +SRST + ``info rocker-ports`` *name*-ports + Show rocker ports. +ERST { .name = "rocker-of-dpa-flows", @@ -791,11 +694,10 @@ ETEXI .cmd = hmp_rocker_of_dpa_flows, }, -STEXI -@item info rocker-of-dpa-flows @var{name} [@var{tbl_id}] -@findex info rocker-of-dpa-flows -Show rocker OF-DPA flow tables. -ETEXI +SRST + ``info rocker-of-dpa-flows`` *name* [*tbl_id*] + Show rocker OF-DPA flow tables. +ERST { .name = "rocker-of-dpa-groups", @@ -805,11 +707,10 @@ ETEXI .cmd = hmp_rocker_of_dpa_groups, }, -STEXI -@item info rocker-of-dpa-groups @var{name} [@var{type}] -@findex info rocker-of-dpa-groups -Show rocker OF-DPA groups. -ETEXI +SRST + ``info rocker-of-dpa-groups`` *name* [*type*] + Show rocker OF-DPA groups. +ERST #if defined(TARGET_S390X) { @@ -821,11 +722,10 @@ ETEXI }, #endif -STEXI -@item info skeys @var{address} -@findex info skeys -Display the value of a storage key (s390 only) -ETEXI +SRST + ``info skeys`` *address* + Display the value of a storage key (s390 only) +ERST #if defined(TARGET_S390X) { @@ -837,11 +737,11 @@ ETEXI }, #endif -STEXI -@item info cmma @var{address} -@findex info cmma -Display the values of the CMMA storage attributes for a range of pages (s390 only) -ETEXI +SRST + ``info cmma`` *address* + Display the values of the CMMA storage attributes for a range of + pages (s390 only) +ERST { .name = "dump", @@ -851,25 +751,23 @@ ETEXI .cmd = hmp_info_dump, }, -STEXI -@item info dump -@findex info dump -Display the latest dump status. -ETEXI +SRST + ``info dump`` + Display the latest dump status. +ERST { .name = "ramblock", .args_type = "", .params = "", .help = "Display system ramblock information", - .cmd = hmp_info_ramblock, + .cmd_info_hrt = qmp_x_query_ramblock, }, -STEXI -@item info ramblock -@findex info ramblock -Dump all the ramblocks of the system. -ETEXI +SRST + ``info ramblock`` + Dump all the ramblocks of the system. +ERST { .name = "hotpluggable-cpus", @@ -880,11 +778,10 @@ ETEXI .flags = "p", }, -STEXI -@item info hotpluggable-cpus -@findex info hotpluggable-cpus -Show information about hotpluggable CPUs -ETEXI +SRST + ``info hotpluggable-cpus`` + Show information about hotpluggable CPUs +ERST { .name = "vm-generation-id", @@ -894,11 +791,10 @@ ETEXI .cmd = hmp_info_vm_generation_id, }, -STEXI -@item info vm-generation-id -@findex info vm-generation-id -Show Virtual Machine Generation ID -ETEXI +SRST + ``info vm-generation-id`` + Show Virtual Machine Generation ID +ERST { .name = "memory_size_summary", @@ -909,12 +805,11 @@ ETEXI .cmd = hmp_info_memory_size_summary, }, -STEXI -@item info memory_size_summary -@findex info memory_size_summary -Display the amount of initially allocated and present hotpluggable (if -enabled) memory in bytes. -ETEXI +SRST + ``info memory_size_summary`` + Display the amount of initially allocated and present hotpluggable (if + enabled) memory in bytes. +ERST #if defined(TARGET_I386) { @@ -926,16 +821,174 @@ ETEXI }, #endif -STEXI -@item info sev -@findex info sev -Show SEV information. -ETEXI +SRST + ``info sev`` + Show SEV information. +ERST + + { + .name = "replay", + .args_type = "", + .params = "", + .help = "show record/replay information", + .cmd = hmp_info_replay, + }, + +SRST + ``info replay`` + Display the record/replay information: mode and the current icount. +ERST + + { + .name = "dirty_rate", + .args_type = "", + .params = "", + .help = "show dirty rate information", + .cmd = hmp_info_dirty_rate, + }, + +SRST + ``info dirty_rate`` + Display the vcpu dirty rate information. +ERST + + { + .name = "vcpu_dirty_limit", + .args_type = "", + .params = "", + .help = "show dirty page limit information of all vCPU", + .cmd = hmp_info_vcpu_dirty_limit, + }, + +SRST + ``info vcpu_dirty_limit`` + Display the vcpu dirty page limit information. +ERST + +#if defined(TARGET_I386) + { + .name = "sgx", + .args_type = "", + .params = "", + .help = "show intel SGX information", + .cmd = hmp_info_sgx, + }, +#endif + +SRST + ``info sgx`` + Show intel SGX information. +ERST + +#if defined(CONFIG_MOS6522) + { + .name = "via", + .args_type = "", + .params = "", + .help = "show guest mos6522 VIA devices", + .cmd = hmp_info_via, + }, +#endif + +SRST + ``info via`` + Show guest mos6522 VIA devices. +ERST + + { + .name = "stats", + .args_type = "target:s,names:s?,provider:s?", + .params = "target [names] [provider]", + .help = "show statistics for the given target (vm or vcpu); optionally filter by" + "name (comma-separated list, or * for all) and provider", + .cmd = hmp_info_stats, + }, + +SRST + ``stats`` + Show runtime-collected statistics +ERST + + { + .name = "virtio", + .args_type = "", + .params = "", + .help = "List all available virtio devices", + .cmd = hmp_virtio_query, + .flags = "p", + }, + +SRST + ``info virtio`` + List all available virtio devices +ERST -STEXI -@end table -ETEXI + { + .name = "virtio-status", + .args_type = "path:s", + .params = "path", + .help = "Display status of a given virtio device", + .cmd = hmp_virtio_status, + .flags = "p", + }, + +SRST + ``info virtio-status`` *path* + Display status of a given virtio device +ERST + + { + .name = "virtio-queue-status", + .args_type = "path:s,queue:i", + .params = "path queue", + .help = "Display status of a given virtio queue", + .cmd = hmp_virtio_queue_status, + .flags = "p", + }, + +SRST + ``info virtio-queue-status`` *path* *queue* + Display status of a given virtio queue +ERST + + { + .name = "virtio-vhost-queue-status", + .args_type = "path:s,queue:i", + .params = "path queue", + .help = "Display status of a given vhost queue", + .cmd = hmp_vhost_queue_status, + .flags = "p", + }, + +SRST + ``info virtio-vhost-queue-status`` *path* *queue* + Display status of a given vhost queue +ERST + + { + .name = "virtio-queue-element", + .args_type = "path:s,queue:i,index:i?", + .params = "path queue [index]", + .help = "Display element of a given virtio queue", + .cmd = hmp_virtio_queue_element, + .flags = "p", + }, + +SRST + ``info virtio-queue-element`` *path* *queue* [*index*] + Display element of a given virtio queue +ERST + + { + .name = "cryptodev", + .args_type = "", + .params = "", + .help = "show the crypto devices", + .cmd = hmp_info_cryptodev, + .flags = "p", + }, -STEXI -@end table -ETEXI +SRST + ``info cryptodev`` + Show the crypto devices. +ERST