hmp-commands-info.hx 16.5 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 26 27 28 29 30 31 32 33 34
    },

STEXI
@item info version
@findex version
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 40 41 42 43 44 45 46 47 48
    },

STEXI
@item info network
@findex network
Show the network state.
ETEXI

    {
        .name       = "chardev",
        .args_type  = "",
        .params     = "",
        .help       = "show the character devices",
49
        .cmd        = hmp_info_chardev,
50 51 52 53 54 55 56 57 58 59 60 61 62 63
    },

STEXI
@item info chardev
@findex chardev
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 69 70 71 72 73 74 75 76 77
    },

STEXI
@item info block
@findex block
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 83 84 85 86 87 88 89 90 91
    },

STEXI
@item info blockstats
@findex blockstats
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 97 98 99 100 101 102 103 104 105
    },

STEXI
@item info block-jobs
@findex block-jobs
Show progress of ongoing block device operations.
ETEXI

    {
        .name       = "registers",
        .args_type  = "",
        .params     = "",
        .help       = "show the cpu registers",
106
        .cmd        = hmp_info_registers,
107 108 109 110 111 112
    },

STEXI
@item info registers
@findex registers
Show the cpu registers.
113 114 115 116 117 118 119 120
ETEXI

#if defined(TARGET_I386)
    {
        .name       = "lapic",
        .args_type  = "",
        .params     = "",
        .help       = "show local apic state",
121
        .cmd        = hmp_info_local_apic,
122 123 124 125 126 127 128
    },
#endif

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

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

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

    {
        .name       = "cpus",
        .args_type  = "",
        .params     = "",
        .help       = "show infos for each CPU",
152
        .cmd        = hmp_info_cpus,
153 154 155 156 157 158 159 160 161 162 163 164 165
    },

STEXI
@item info cpus
@findex cpus
Show infos for each CPU.
ETEXI

    {
        .name       = "history",
        .args_type  = "",
        .params     = "",
        .help       = "show the command line history",
166
        .cmd        = hmp_info_history,
167 168 169 170 171 172 173 174 175 176 177 178 179
    },

STEXI
@item info history
@findex history
Show the command line history.
ETEXI

    {
        .name       = "irq",
        .args_type  = "",
        .params     = "",
        .help       = "show the interrupts statistics (if available)",
180
        .cmd        = hmp_info_irq,
181 182 183 184 185 186 187 188 189 190 191 192
    },

STEXI
@item info irq
@findex irq
Show the interrupts statistics (if available).
ETEXI

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

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

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

STEXI
@item info pci
@findex pci
Show PCI information.
215 216 217 218 219 220 221 222 223
ETEXI

#if defined(TARGET_I386) || defined(TARGET_SH4) || defined(TARGET_SPARC) || \
    defined(TARGET_PPC) || defined(TARGET_XTENSA)
    {
        .name       = "tlb",
        .args_type  = "",
        .params     = "",
        .help       = "show virtual to physical memory mappings",
224
        .cmd        = hmp_info_tlb,
225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
    },
#endif

STEXI
@item info tlb
@findex tlb
Show virtual to physical memory mappings.
ETEXI

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

STEXI
@item info mem
@findex mem
Show the active virtual memory mappings.
ETEXI

    {
        .name       = "mtree",
252 253 254
        .args_type  = "flatview:-f",
        .params     = "[-f]",
        .help       = "show memory tree (-f: dump flat view for address spaces)",
255
        .cmd        = hmp_info_mtree,
256 257 258 259 260 261 262 263 264 265 266 267 268
    },

STEXI
@item info mtree
@findex mtree
Show memory tree.
ETEXI

    {
        .name       = "jit",
        .args_type  = "",
        .params     = "",
        .help       = "show dynamic compiler info",
269
        .cmd        = hmp_info_jit,
270 271 272 273 274 275 276 277 278 279 280 281 282
    },

STEXI
@item info jit
@findex jit
Show dynamic compiler info.
ETEXI

    {
        .name       = "opcount",
        .args_type  = "",
        .params     = "",
        .help       = "show dynamic compiler opcode counters",
283
        .cmd        = hmp_info_opcount,
284 285 286 287 288 289 290 291 292 293 294 295 296
    },

STEXI
@item info opcount
@findex opcount
Show dynamic compiler opcode counters
ETEXI

    {
        .name       = "kvm",
        .args_type  = "",
        .params     = "",
        .help       = "show KVM information",
297
        .cmd        = hmp_info_kvm,
298 299 300 301 302 303 304 305 306 307 308 309 310
    },

STEXI
@item info kvm
@findex kvm
Show KVM information.
ETEXI

    {
        .name       = "numa",
        .args_type  = "",
        .params     = "",
        .help       = "show NUMA information",
311
        .cmd        = hmp_info_numa,
312 313 314 315 316 317 318 319 320 321 322 323 324
    },

STEXI
@item info numa
@findex numa
Show NUMA information.
ETEXI

    {
        .name       = "usb",
        .args_type  = "",
        .params     = "",
        .help       = "show guest USB devices",
325
        .cmd        = hmp_info_usb,
326 327 328 329 330 331 332 333 334 335 336 337 338
    },

STEXI
@item info usb
@findex usb
Show guest USB devices.
ETEXI

    {
        .name       = "usbhost",
        .args_type  = "",
        .params     = "",
        .help       = "show host USB devices",
339
        .cmd        = hmp_info_usbhost,
340 341 342 343 344 345 346 347 348 349 350 351 352
    },

STEXI
@item info usbhost
@findex usbhost
Show host USB devices.
ETEXI

    {
        .name       = "profile",
        .args_type  = "",
        .params     = "",
        .help       = "show profiling information",
353
        .cmd        = hmp_info_profile,
354 355 356 357 358 359 360 361 362 363 364 365 366
    },

STEXI
@item info profile
@findex profile
Show profiling information.
ETEXI

    {
        .name       = "capture",
        .args_type  = "",
        .params     = "",
        .help       = "show capture information",
367
        .cmd        = hmp_info_capture,
368 369 370 371 372 373 374 375 376 377 378 379 380
    },

STEXI
@item info capture
@findex capture
Show capture information.
ETEXI

    {
        .name       = "snapshots",
        .args_type  = "",
        .params     = "",
        .help       = "show the currently saved VM snapshots",
381
        .cmd        = hmp_info_snapshots,
382 383 384 385 386 387 388 389 390 391 392 393 394
    },

STEXI
@item info snapshots
@findex snapshots
Show the currently saved VM snapshots.
ETEXI

    {
        .name       = "status",
        .args_type  = "",
        .params     = "",
        .help       = "show the current VM status (running|paused)",
395
        .cmd        = hmp_info_status,
396 397 398 399 400 401 402 403 404 405 406 407 408
    },

STEXI
@item info status
@findex status
Show the current VM status (running|paused).
ETEXI

    {
        .name       = "mice",
        .args_type  = "",
        .params     = "",
        .help       = "show which guest mouse is receiving events",
409
        .cmd        = hmp_info_mice,
410 411 412 413 414 415 416 417 418 419 420 421 422
    },

STEXI
@item info mice
@findex mice
Show which guest mouse is receiving events.
ETEXI

    {
        .name       = "vnc",
        .args_type  = "",
        .params     = "",
        .help       = "show the vnc server status",
423
        .cmd        = hmp_info_vnc,
424 425 426 427 428 429 430 431 432 433 434 435 436 437
    },

STEXI
@item info vnc
@findex vnc
Show the vnc server status.
ETEXI

#if defined(CONFIG_SPICE)
    {
        .name       = "spice",
        .args_type  = "",
        .params     = "",
        .help       = "show the spice server status",
438
        .cmd        = hmp_info_spice,
439 440 441 442 443 444 445 446 447 448 449 450 451 452
    },
#endif

STEXI
@item info spice
@findex spice
Show the spice server status.
ETEXI

    {
        .name       = "name",
        .args_type  = "",
        .params     = "",
        .help       = "show the current VM name",
453
        .cmd        = hmp_info_name,
454 455 456 457 458 459 460 461 462 463 464 465 466
    },

STEXI
@item info name
@findex name
Show the current VM name.
ETEXI

    {
        .name       = "uuid",
        .args_type  = "",
        .params     = "",
        .help       = "show the current VM UUID",
467
        .cmd        = hmp_info_uuid,
468 469 470 471 472 473 474 475 476 477 478 479 480
    },

STEXI
@item info uuid
@findex uuid
Show the current VM UUID.
ETEXI

    {
        .name       = "cpustats",
        .args_type  = "",
        .params     = "",
        .help       = "show CPU statistics",
481
        .cmd        = hmp_info_cpustats,
482 483 484 485 486 487 488 489 490 491 492 493 494 495
    },

STEXI
@item info cpustats
@findex cpustats
Show CPU statistics.
ETEXI

#if defined(CONFIG_SLIRP)
    {
        .name       = "usernet",
        .args_type  = "",
        .params     = "",
        .help       = "show user network stack connection states",
496
        .cmd        = hmp_info_usernet,
497 498 499 500 501 502 503 504 505 506 507 508 509 510
    },
#endif

STEXI
@item info usernet
@findex usernet
Show user network stack connection states.
ETEXI

    {
        .name       = "migrate",
        .args_type  = "",
        .params     = "",
        .help       = "show migration status",
511
        .cmd        = hmp_info_migrate,
512 513 514 515 516 517 518 519 520 521 522 523 524
    },

STEXI
@item info migrate
@findex migrate
Show migration status.
ETEXI

    {
        .name       = "migrate_capabilities",
        .args_type  = "",
        .params     = "",
        .help       = "show current migration capabilities",
525
        .cmd        = hmp_info_migrate_capabilities,
526 527 528 529 530 531 532 533 534 535 536 537 538
    },

STEXI
@item info migrate_capabilities
@findex migrate_capabilities
Show current migration capabilities.
ETEXI

    {
        .name       = "migrate_parameters",
        .args_type  = "",
        .params     = "",
        .help       = "show current migration parameters",
539
        .cmd        = hmp_info_migrate_parameters,
540 541 542 543 544 545 546 547 548 549 550 551 552
    },

STEXI
@item info migrate_parameters
@findex migrate_parameters
Show current migration parameters.
ETEXI

    {
        .name       = "migrate_cache_size",
        .args_type  = "",
        .params     = "",
        .help       = "show current migration xbzrle cache size",
553
        .cmd        = hmp_info_migrate_cache_size,
554 555 556 557 558 559 560 561 562 563 564 565 566
    },

STEXI
@item info migrate_cache_size
@findex migrate_cache_size
Show current migration xbzrle cache size.
ETEXI

    {
        .name       = "balloon",
        .args_type  = "",
        .params     = "",
        .help       = "show balloon information",
567
        .cmd        = hmp_info_balloon,
568 569 570 571 572 573 574 575 576 577 578 579 580
    },

STEXI
@item info balloon
@findex balloon
Show balloon information.
ETEXI

    {
        .name       = "qtree",
        .args_type  = "",
        .params     = "",
        .help       = "show device tree",
581
        .cmd        = hmp_info_qtree,
582 583 584 585 586 587 588 589 590 591 592 593 594
    },

STEXI
@item info qtree
@findex qtree
Show device tree.
ETEXI

    {
        .name       = "qdm",
        .args_type  = "",
        .params     = "",
        .help       = "show qdev device model list",
595
        .cmd        = hmp_info_qdm,
596 597 598 599 600 601 602 603 604 605 606 607 608
    },

STEXI
@item info qdm
@findex qdm
Show qdev device model list.
ETEXI

    {
        .name       = "qom-tree",
        .args_type  = "path:s?",
        .params     = "[path]",
        .help       = "show QOM composition tree",
609
        .cmd        = hmp_info_qom_tree,
610 611 612 613 614 615 616 617 618 619 620 621 622
    },

STEXI
@item info qom-tree
@findex qom-tree
Show QOM composition tree.
ETEXI

    {
        .name       = "roms",
        .args_type  = "",
        .params     = "",
        .help       = "show roms",
623
        .cmd        = hmp_info_roms,
624 625 626 627 628 629 630 631 632 633
    },

STEXI
@item info roms
@findex roms
Show roms.
ETEXI

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

STEXI
@item info trace-events
@findex trace-events
Show available trace-events & their state.
ETEXI

    {
        .name       = "tpm",
        .args_type  = "",
        .params     = "",
        .help       = "show the TPM device",
653
        .cmd        = hmp_info_tpm,
654 655 656 657 658 659 660 661 662 663 664 665 666
    },

STEXI
@item info tpm
@findex tpm
Show the TPM device.
ETEXI

    {
        .name       = "memdev",
        .args_type  = "",
        .params     = "",
        .help       = "show memory backends",
667
        .cmd        = hmp_info_memdev,
668 669 670 671 672 673 674 675 676 677 678 679 680
    },

STEXI
@item info memdev
@findex memdev
Show memory backends
ETEXI

    {
        .name       = "memory-devices",
        .args_type  = "",
        .params     = "",
        .help       = "show memory devices",
681
        .cmd        = hmp_info_memory_devices,
682 683 684 685 686 687 688 689 690 691 692 693 694
    },

STEXI
@item info memory-devices
@findex memory-devices
Show memory devices.
ETEXI

    {
        .name       = "iothreads",
        .args_type  = "",
        .params     = "",
        .help       = "show iothreads",
695
        .cmd        = hmp_info_iothreads,
696 697 698 699 700 701 702 703 704 705 706 707 708
    },

STEXI
@item info iothreads
@findex iothreads
Show iothread's identifiers.
ETEXI

    {
        .name       = "rocker",
        .args_type  = "name:s",
        .params     = "name",
        .help       = "Show rocker switch",
709
        .cmd        = hmp_rocker,
710 711 712 713 714 715 716 717 718 719 720 721 722
    },

STEXI
@item info rocker @var{name}
@findex rocker
Show rocker switch.
ETEXI

    {
        .name       = "rocker-ports",
        .args_type  = "name:s",
        .params     = "name",
        .help       = "Show rocker ports",
723
        .cmd        = hmp_rocker_ports,
724 725 726 727 728 729 730 731 732 733 734 735 736
    },

STEXI
@item info rocker_ports @var{name}-ports
@findex ocker-ports
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",
737
        .cmd        = hmp_rocker_of_dpa_flows,
738 739 740 741 742 743 744 745 746 747 748 749 750
    },

STEXI
@item info rocker_of_dpa_flows @var{name} [@var{tbl_id}]
@findex rocker-of-dpa-flows
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",
751
        .cmd        = hmp_rocker_of_dpa_groups,
752 753 754 755 756 757 758 759 760 761 762 763 764 765
    },

STEXI
@item info rocker-of-dpa-groups @var{name} [@var{type}]
@findex rocker-of-dpa-groups
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",
766
        .cmd        = hmp_info_skeys,
767 768 769 770 771 772 773
    },
#endif

STEXI
@item info skeys @var{address}
@findex skeys
Display the value of a storage key (s390 only)
774 775 776 777 778 779 780
ETEXI

    {
        .name       = "dump",
        .args_type  = "",
        .params     = "",
        .help       = "Display the latest dump status",
781
        .cmd        = hmp_info_dump,
782 783 784 785 786 787
    },

STEXI
@item info dump
@findex dump
Display the latest dump status.
788 789 790 791 792 793 794 795 796 797 798 799 800 801
ETEXI

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

STEXI
@item info ramblock
@findex ramblock
Dump all the ramblocks of the system.
802 803 804 805 806 807 808
ETEXI

    {
        .name       = "hotpluggable-cpus",
        .args_type  = "",
        .params     = "",
        .help       = "Show information about hotpluggable CPUs",
809
        .cmd        = hmp_hotpluggable_cpus,
810 811 812 813 814 815
    },

STEXI
@item info hotpluggable-cpus
@findex hotpluggable-cpus
Show information about hotpluggable CPUs
816 817
ETEXI

818 819 820 821 822 823 824 825 826 827 828 829 830 831
STEXI
@item info vm-generation-id
@findex vm-generation-id
Show Virtual Machine Generation ID
ETEXI

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

832 833 834
STEXI
@end table
ETEXI
835 836 837 838

STEXI
@end table
ETEXI