hmp-commands-info.hx 18.3 KB
Newer Older
1 2 3 4 5 6 7 8 9
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 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

STEXI
@table @option
10 11 12 13
@item info @var{subcommand}
@findex info
Show various information about the system state.
@table @option
14 15 16 17 18 19 20
ETEXI

    {
        .name       = "version",
        .args_type  = "",
        .params     = "",
        .help       = "show the version of QEMU",
21
        .cmd        = hmp_info_version,
22 23 24 25
    },

STEXI
@item info version
26
@findex info version
27 28 29 30 31 32 33 34
Show the version of QEMU.
ETEXI

    {
        .name       = "network",
        .args_type  = "",
        .params     = "",
        .help       = "show the network state",
35
        .cmd        = hmp_info_network,
36 37 38 39
    },

STEXI
@item info network
40
@findex info network
41 42 43 44 45 46 47 48
Show the network state.
ETEXI

    {
        .name       = "chardev",
        .args_type  = "",
        .params     = "",
        .help       = "show the character devices",
49
        .cmd        = hmp_info_chardev,
50 51 52 53
    },

STEXI
@item info chardev
54
@findex info chardev
55 56 57 58 59 60 61 62 63
Show the character devices.
ETEXI

    {
        .name       = "block",
        .args_type  = "nodes:-n,verbose:-v,device:B?",
        .params     = "[-n] [-v] [device]",
        .help       = "show info of one block device or all block devices "
                      "(-n: show named nodes; -v: show details)",
64
        .cmd        = hmp_info_block,
65 66 67 68
    },

STEXI
@item info block
69
@findex info block
70 71 72 73 74 75 76 77
Show info of one block device or all block devices.
ETEXI

    {
        .name       = "blockstats",
        .args_type  = "",
        .params     = "",
        .help       = "show block device statistics",
78
        .cmd        = hmp_info_blockstats,
79 80 81 82
    },

STEXI
@item info blockstats
83
@findex info blockstats
84 85 86 87 88 89 90 91
Show block device statistics.
ETEXI

    {
        .name       = "block-jobs",
        .args_type  = "",
        .params     = "",
        .help       = "show progress of ongoing block device operations",
92
        .cmd        = hmp_info_block_jobs,
93 94 95 96
    },

STEXI
@item info block-jobs
97
@findex info block-jobs
98 99 100 101 102
Show progress of ongoing block device operations.
ETEXI

    {
        .name       = "registers",
103 104 105
        .args_type  = "cpustate_all:-a",
        .params     = "[-a]",
        .help       = "show the cpu registers (-a: all - show register info for all cpus)",
106
        .cmd        = hmp_info_registers,
107 108 109 110
    },

STEXI
@item info registers
111
@findex info registers
112
Show the cpu registers.
113 114 115 116 117
ETEXI

#if defined(TARGET_I386)
    {
        .name       = "lapic",
118 119 120 121
        .args_type  = "apic-id:i?",
        .params     = "[apic-id]",
        .help       = "show local apic state (apic-id: local apic to read, default is which of current CPU)",

122
        .cmd        = hmp_info_local_apic,
123 124 125 126 127
    },
#endif

STEXI
@item info lapic
128
@findex info lapic
129
Show local APIC state
130 131 132 133 134 135 136 137
ETEXI

#if defined(TARGET_I386)
    {
        .name       = "ioapic",
        .args_type  = "",
        .params     = "",
        .help       = "show io apic state",
138
        .cmd        = hmp_info_io_apic,
139 140 141 142 143
    },
#endif

STEXI
@item info ioapic
144
@findex info ioapic
145
Show io APIC state
146 147 148 149 150 151 152
ETEXI

    {
        .name       = "cpus",
        .args_type  = "",
        .params     = "",
        .help       = "show infos for each CPU",
153
        .cmd        = hmp_info_cpus,
154 155 156 157
    },

STEXI
@item info cpus
158
@findex info cpus
159 160 161 162 163 164 165 166
Show infos for each CPU.
ETEXI

    {
        .name       = "history",
        .args_type  = "",
        .params     = "",
        .help       = "show the command line history",
167
        .cmd        = hmp_info_history,
168 169 170 171
    },

STEXI
@item info history
172
@findex info history
173 174 175 176 177 178 179 180
Show the command line history.
ETEXI

    {
        .name       = "irq",
        .args_type  = "",
        .params     = "",
        .help       = "show the interrupts statistics (if available)",
181
        .cmd        = hmp_info_irq,
182 183 184 185
    },

STEXI
@item info irq
186
@findex info irq
187 188 189 190 191 192 193
Show the interrupts statistics (if available).
ETEXI

    {
        .name       = "pic",
        .args_type  = "",
        .params     = "",
194
        .help       = "show PIC state",
195
        .cmd        = hmp_info_pic,
196 197 198 199
    },

STEXI
@item info pic
200
@findex info pic
201
Show i8259 (PIC) state.
Paolo Bonzini's avatar
Paolo Bonzini committed
202 203 204 205 206 207 208
ETEXI

    {
        .name       = "pci",
        .args_type  = "",
        .params     = "",
        .help       = "show PCI info",
209
        .cmd        = hmp_info_pci,
Paolo Bonzini's avatar
Paolo Bonzini committed
210 211 212 213
    },

STEXI
@item info pci
214
@findex info pci
Paolo Bonzini's avatar
Paolo Bonzini committed
215
Show PCI information.
216 217 218
ETEXI

#if defined(TARGET_I386) || defined(TARGET_SH4) || defined(TARGET_SPARC) || \
219
    defined(TARGET_PPC) || defined(TARGET_XTENSA) || defined(TARGET_M68K)
220 221 222 223 224
    {
        .name       = "tlb",
        .args_type  = "",
        .params     = "",
        .help       = "show virtual to physical memory mappings",
225
        .cmd        = hmp_info_tlb,
226 227 228 229 230
    },
#endif

STEXI
@item info tlb
231
@findex info tlb
232 233 234 235 236 237 238 239 240
Show virtual to physical memory mappings.
ETEXI

#if defined(TARGET_I386)
    {
        .name       = "mem",
        .args_type  = "",
        .params     = "",
        .help       = "show the active virtual memory mappings",
241
        .cmd        = hmp_info_mem,
242 243 244 245 246
    },
#endif

STEXI
@item info mem
247
@findex info mem
248 249 250 251 252
Show the active virtual memory mappings.
ETEXI

    {
        .name       = "mtree",
253 254 255 256
        .args_type  = "flatview:-f,dispatch_tree:-d",
        .params     = "[-f][-d]",
        .help       = "show memory tree (-f: dump flat view for address spaces;"
                      "-d: dump dispatch tree, valid with -f only)",
257
        .cmd        = hmp_info_mtree,
258 259 260 261
    },

STEXI
@item info mtree
262
@findex info mtree
263 264 265
Show memory tree.
ETEXI

266
#if defined(CONFIG_TCG)
267 268 269 270 271
    {
        .name       = "jit",
        .args_type  = "",
        .params     = "",
        .help       = "show dynamic compiler info",
272
        .cmd        = hmp_info_jit,
273
    },
274
#endif
275 276 277

STEXI
@item info jit
278
@findex info jit
279 280 281
Show dynamic compiler info.
ETEXI

282
#if defined(CONFIG_TCG)
283 284 285 286 287
    {
        .name       = "opcount",
        .args_type  = "",
        .params     = "",
        .help       = "show dynamic compiler opcode counters",
288
        .cmd        = hmp_info_opcount,
289
    },
290
#endif
291 292 293

STEXI
@item info opcount
294
@findex info opcount
295 296 297 298 299 300 301 302
Show dynamic compiler opcode counters
ETEXI

    {
        .name       = "kvm",
        .args_type  = "",
        .params     = "",
        .help       = "show KVM information",
303
        .cmd        = hmp_info_kvm,
304 305 306 307
    },

STEXI
@item info kvm
308
@findex info kvm
309 310 311 312 313 314 315 316
Show KVM information.
ETEXI

    {
        .name       = "numa",
        .args_type  = "",
        .params     = "",
        .help       = "show NUMA information",
317
        .cmd        = hmp_info_numa,
318 319 320 321
    },

STEXI
@item info numa
322
@findex info numa
323 324 325 326 327 328 329 330
Show NUMA information.
ETEXI

    {
        .name       = "usb",
        .args_type  = "",
        .params     = "",
        .help       = "show guest USB devices",
331
        .cmd        = hmp_info_usb,
332 333 334 335
    },

STEXI
@item info usb
336
@findex info usb
337 338 339 340 341 342 343 344
Show guest USB devices.
ETEXI

    {
        .name       = "usbhost",
        .args_type  = "",
        .params     = "",
        .help       = "show host USB devices",
345
        .cmd        = hmp_info_usbhost,
346 347 348 349
    },

STEXI
@item info usbhost
350
@findex info usbhost
351 352 353 354 355 356 357 358
Show host USB devices.
ETEXI

    {
        .name       = "profile",
        .args_type  = "",
        .params     = "",
        .help       = "show profiling information",
359
        .cmd        = hmp_info_profile,
360 361 362 363
    },

STEXI
@item info profile
364
@findex info profile
365 366 367 368 369 370 371 372
Show profiling information.
ETEXI

    {
        .name       = "capture",
        .args_type  = "",
        .params     = "",
        .help       = "show capture information",
373
        .cmd        = hmp_info_capture,
374 375 376 377
    },

STEXI
@item info capture
378
@findex info capture
379 380 381 382 383 384 385 386
Show capture information.
ETEXI

    {
        .name       = "snapshots",
        .args_type  = "",
        .params     = "",
        .help       = "show the currently saved VM snapshots",
387
        .cmd        = hmp_info_snapshots,
388 389 390 391
    },

STEXI
@item info snapshots
392
@findex info snapshots
393 394 395 396 397 398 399 400
Show the currently saved VM snapshots.
ETEXI

    {
        .name       = "status",
        .args_type  = "",
        .params     = "",
        .help       = "show the current VM status (running|paused)",
401
        .cmd        = hmp_info_status,
402 403 404 405
    },

STEXI
@item info status
406
@findex info status
407 408 409 410 411 412 413 414
Show the current VM status (running|paused).
ETEXI

    {
        .name       = "mice",
        .args_type  = "",
        .params     = "",
        .help       = "show which guest mouse is receiving events",
415
        .cmd        = hmp_info_mice,
416 417 418 419
    },

STEXI
@item info mice
420
@findex info mice
421 422 423 424 425 426 427 428
Show which guest mouse is receiving events.
ETEXI

    {
        .name       = "vnc",
        .args_type  = "",
        .params     = "",
        .help       = "show the vnc server status",
429
        .cmd        = hmp_info_vnc,
430 431 432 433
    },

STEXI
@item info vnc
434
@findex info vnc
435 436 437 438 439 440 441 442 443
Show the vnc server status.
ETEXI

#if defined(CONFIG_SPICE)
    {
        .name       = "spice",
        .args_type  = "",
        .params     = "",
        .help       = "show the spice server status",
444
        .cmd        = hmp_info_spice,
445 446 447 448 449
    },
#endif

STEXI
@item info spice
450
@findex info spice
451 452 453 454 455 456 457 458
Show the spice server status.
ETEXI

    {
        .name       = "name",
        .args_type  = "",
        .params     = "",
        .help       = "show the current VM name",
459
        .cmd        = hmp_info_name,
460 461 462 463
    },

STEXI
@item info name
464
@findex info name
465 466 467 468 469 470 471 472
Show the current VM name.
ETEXI

    {
        .name       = "uuid",
        .args_type  = "",
        .params     = "",
        .help       = "show the current VM UUID",
473
        .cmd        = hmp_info_uuid,
474 475 476 477
    },

STEXI
@item info uuid
478
@findex info uuid
479 480 481 482 483 484 485 486
Show the current VM UUID.
ETEXI

    {
        .name       = "cpustats",
        .args_type  = "",
        .params     = "",
        .help       = "show CPU statistics",
487
        .cmd        = hmp_info_cpustats,
488 489 490 491
    },

STEXI
@item info cpustats
492
@findex info cpustats
493 494 495 496 497 498 499 500 501
Show CPU statistics.
ETEXI

#if defined(CONFIG_SLIRP)
    {
        .name       = "usernet",
        .args_type  = "",
        .params     = "",
        .help       = "show user network stack connection states",
502
        .cmd        = hmp_info_usernet,
503 504 505 506 507
    },
#endif

STEXI
@item info usernet
508
@findex info usernet
509 510 511 512 513 514 515 516
Show user network stack connection states.
ETEXI

    {
        .name       = "migrate",
        .args_type  = "",
        .params     = "",
        .help       = "show migration status",
517
        .cmd        = hmp_info_migrate,
518 519 520 521
    },

STEXI
@item info migrate
522
@findex info migrate
523 524 525 526 527 528 529 530
Show migration status.
ETEXI

    {
        .name       = "migrate_capabilities",
        .args_type  = "",
        .params     = "",
        .help       = "show current migration capabilities",
531
        .cmd        = hmp_info_migrate_capabilities,
532 533 534 535
    },

STEXI
@item info migrate_capabilities
536
@findex info migrate_capabilities
537 538 539 540 541 542 543 544
Show current migration capabilities.
ETEXI

    {
        .name       = "migrate_parameters",
        .args_type  = "",
        .params     = "",
        .help       = "show current migration parameters",
545
        .cmd        = hmp_info_migrate_parameters,
546 547 548 549
    },

STEXI
@item info migrate_parameters
550
@findex info migrate_parameters
551 552 553 554 555 556 557 558
Show current migration parameters.
ETEXI

    {
        .name       = "migrate_cache_size",
        .args_type  = "",
        .params     = "",
        .help       = "show current migration xbzrle cache size",
559
        .cmd        = hmp_info_migrate_cache_size,
560 561 562 563
    },

STEXI
@item info migrate_cache_size
564
@findex info migrate_cache_size
565 566 567 568 569 570 571 572
Show current migration xbzrle cache size.
ETEXI

    {
        .name       = "balloon",
        .args_type  = "",
        .params     = "",
        .help       = "show balloon information",
573
        .cmd        = hmp_info_balloon,
574 575 576 577
    },

STEXI
@item info balloon
578
@findex info balloon
579 580 581 582 583 584 585 586
Show balloon information.
ETEXI

    {
        .name       = "qtree",
        .args_type  = "",
        .params     = "",
        .help       = "show device tree",
587
        .cmd        = hmp_info_qtree,
588 589 590 591
    },

STEXI
@item info qtree
592
@findex info qtree
593 594 595 596 597 598 599 600
Show device tree.
ETEXI

    {
        .name       = "qdm",
        .args_type  = "",
        .params     = "",
        .help       = "show qdev device model list",
601
        .cmd        = hmp_info_qdm,
602 603 604 605
    },

STEXI
@item info qdm
606
@findex info qdm
607 608 609 610 611 612 613 614
Show qdev device model list.
ETEXI

    {
        .name       = "qom-tree",
        .args_type  = "path:s?",
        .params     = "[path]",
        .help       = "show QOM composition tree",
615
        .cmd        = hmp_info_qom_tree,
616 617 618 619
    },

STEXI
@item info qom-tree
620
@findex info qom-tree
621 622 623 624 625 626 627 628
Show QOM composition tree.
ETEXI

    {
        .name       = "roms",
        .args_type  = "",
        .params     = "",
        .help       = "show roms",
629
        .cmd        = hmp_info_roms,
630 631 632 633
    },

STEXI
@item info roms
634
@findex info roms
635 636 637 638 639
Show roms.
ETEXI

    {
        .name       = "trace-events",
640 641
        .args_type  = "name:s?,vcpu:i?",
        .params     = "[name] [vcpu]",
642
        .help       = "show available trace-events & their state "
643
                      "(name: event name pattern; vcpu: vCPU to query, default is any)",
644
        .cmd = hmp_info_trace_events,
645
        .command_completion = info_trace_events_completion,
646 647 648 649
    },

STEXI
@item info trace-events
650
@findex info trace-events
651 652 653 654 655 656 657 658
Show available trace-events & their state.
ETEXI

    {
        .name       = "tpm",
        .args_type  = "",
        .params     = "",
        .help       = "show the TPM device",
659
        .cmd        = hmp_info_tpm,
660 661 662 663
    },

STEXI
@item info tpm
664
@findex info tpm
665 666 667 668 669 670 671 672
Show the TPM device.
ETEXI

    {
        .name       = "memdev",
        .args_type  = "",
        .params     = "",
        .help       = "show memory backends",
673
        .cmd        = hmp_info_memdev,
674 675 676 677
    },

STEXI
@item info memdev
678
@findex info memdev
679 680 681 682 683 684 685 686
Show memory backends
ETEXI

    {
        .name       = "memory-devices",
        .args_type  = "",
        .params     = "",
        .help       = "show memory devices",
687
        .cmd        = hmp_info_memory_devices,
688 689 690 691
    },

STEXI
@item info memory-devices
692
@findex info memory-devices
693 694 695 696 697 698 699 700
Show memory devices.
ETEXI

    {
        .name       = "iothreads",
        .args_type  = "",
        .params     = "",
        .help       = "show iothreads",
701
        .cmd        = hmp_info_iothreads,
702 703 704 705
    },

STEXI
@item info iothreads
706
@findex info iothreads
707 708 709 710 711 712 713 714
Show iothread's identifiers.
ETEXI

    {
        .name       = "rocker",
        .args_type  = "name:s",
        .params     = "name",
        .help       = "Show rocker switch",
715
        .cmd        = hmp_rocker,
716 717 718 719
    },

STEXI
@item info rocker @var{name}
720
@findex info rocker
721 722 723 724 725 726 727 728
Show rocker switch.
ETEXI

    {
        .name       = "rocker-ports",
        .args_type  = "name:s",
        .params     = "name",
        .help       = "Show rocker ports",
729
        .cmd        = hmp_rocker_ports,
730 731 732
    },

STEXI
733
@item info rocker-ports @var{name}-ports
734
@findex info rocker-ports
735 736 737 738 739 740 741 742
Show rocker ports.
ETEXI

    {
        .name       = "rocker-of-dpa-flows",
        .args_type  = "name:s,tbl_id:i?",
        .params     = "name [tbl_id]",
        .help       = "Show rocker OF-DPA flow tables",
743
        .cmd        = hmp_rocker_of_dpa_flows,
744 745 746
    },

STEXI
747
@item info rocker-of-dpa-flows @var{name} [@var{tbl_id}]
748
@findex info rocker-of-dpa-flows
749 750 751 752 753 754 755 756
Show rocker OF-DPA flow tables.
ETEXI

    {
        .name       = "rocker-of-dpa-groups",
        .args_type  = "name:s,type:i?",
        .params     = "name [type]",
        .help       = "Show rocker OF-DPA groups",
757
        .cmd        = hmp_rocker_of_dpa_groups,
758 759 760 761
    },

STEXI
@item info rocker-of-dpa-groups @var{name} [@var{type}]
762
@findex info rocker-of-dpa-groups
763 764 765 766 767 768 769 770 771
Show rocker OF-DPA groups.
ETEXI

#if defined(TARGET_S390X)
    {
        .name       = "skeys",
        .args_type  = "addr:l",
        .params     = "address",
        .help       = "Display the value of a storage key",
772
        .cmd        = hmp_info_skeys,
773 774 775 776 777
    },
#endif

STEXI
@item info skeys @var{address}
778
@findex info skeys
779
Display the value of a storage key (s390 only)
780 781 782 783 784 785 786 787 788 789 790 791 792 793
ETEXI

#if defined(TARGET_S390X)
    {
        .name       = "cmma",
        .args_type  = "addr:l,count:l?",
        .params     = "address [count]",
        .help       = "Display the values of the CMMA storage attributes for a range of pages",
        .cmd        = hmp_info_cmma,
    },
#endif

STEXI
@item info cmma @var{address}
794
@findex info cmma
795
Display the values of the CMMA storage attributes for a range of pages (s390 only)
796 797 798 799 800 801 802
ETEXI

    {
        .name       = "dump",
        .args_type  = "",
        .params     = "",
        .help       = "Display the latest dump status",
803
        .cmd        = hmp_info_dump,
804 805 806 807
    },

STEXI
@item info dump
808
@findex info dump
809
Display the latest dump status.
810 811 812 813 814 815 816 817 818 819 820 821
ETEXI

    {
        .name       = "ramblock",
        .args_type  = "",
        .params     = "",
        .help       = "Display system ramblock information",
        .cmd        = hmp_info_ramblock,
    },

STEXI
@item info ramblock
822
@findex info ramblock
823
Dump all the ramblocks of the system.
824 825 826 827 828 829 830
ETEXI

    {
        .name       = "hotpluggable-cpus",
        .args_type  = "",
        .params     = "",
        .help       = "Show information about hotpluggable CPUs",
831
        .cmd        = hmp_hotpluggable_cpus,
832 833 834 835
    },

STEXI
@item info hotpluggable-cpus
836
@findex info hotpluggable-cpus
837
Show information about hotpluggable CPUs
838 839 840 841 842 843 844 845 846 847
ETEXI

    {
        .name       = "vm-generation-id",
        .args_type  = "",
        .params     = "",
        .help       = "Show Virtual Machine Generation ID",
        .cmd = hmp_info_vm_generation_id,
    },

848
STEXI
849
@item info vm-generation-id
850
@findex info vm-generation-id
851
Show Virtual Machine Generation ID
852 853 854 855 856 857 858 859 860 861 862
ETEXI

    {
        .name       = "memory_size_summary",
        .args_type  = "",
        .params     = "",
        .help       = "show the amount of initially allocated and "
                      "present hotpluggable (if enabled) memory in bytes.",
        .cmd        = hmp_info_memory_size_summary,
    },

863 864
STEXI
@item info memory_size_summary
865
@findex info memory_size_summary
866 867 868 869
Display the amount of initially allocated and present hotpluggable (if
enabled) memory in bytes.
ETEXI

870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885
#if defined(TARGET_I386)
    {
        .name       = "sev",
        .args_type  = "",
        .params     = "",
        .help       = "show SEV information",
        .cmd        = hmp_info_sev,
    },
#endif

STEXI
@item info sev
@findex info sev
Show SEV information.
ETEXI

886 887 888
STEXI
@end table
ETEXI
889 890 891 892

STEXI
@end table
ETEXI