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