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