hmp-commands-info.hx

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