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",
 254         .params     = "[-f]",
 255         .help       = "show memory tree (-f: dump flat view for address spaces)",
 256         .cmd        = hmp_info_mtree,
 257     },
 258
 259 STEXI
 260 @item info mtree
 261 @findex mtree
 262 Show memory tree.
 263 ETEXI
 264
 265 #if defined(CONFIG_TCG)
 266     {
 267         .name       = "jit",
 268         .args_type  = "",
 269         .params     = "",
 270         .help       = "show dynamic compiler info",
 271         .cmd        = hmp_info_jit,
 272     },
 273 #endif
 274
 275 STEXI
 276 @item info jit
 277 @findex jit
 278 Show dynamic compiler info.
 279 ETEXI
 280
 281 #if defined(CONFIG_TCG)
 282     {
 283         .name       = "opcount",
 284         .args_type  = "",
 285         .params     = "",
 286         .help       = "show dynamic compiler opcode counters",
 287         .cmd        = hmp_info_opcount,
 288     },
 289 #endif
 290
 291 STEXI
 292 @item info opcount
 293 @findex opcount
 294 Show dynamic compiler opcode counters
 295 ETEXI
 296
 297     {
 298         .name       = "kvm",
 299         .args_type  = "",
 300         .params     = "",
 301         .help       = "show KVM information",
 302         .cmd        = hmp_info_kvm,
 303     },
 304
 305 STEXI
 306 @item info kvm
 307 @findex kvm
 308 Show KVM information.
 309 ETEXI
 310
 311     {
 312         .name       = "numa",
 313         .args_type  = "",
 314         .params     = "",
 315         .help       = "show NUMA information",
 316         .cmd        = hmp_info_numa,
 317     },
 318
 319 STEXI
 320 @item info numa
 321 @findex numa
 322 Show NUMA information.
 323 ETEXI
 324
 325     {
 326         .name       = "usb",
 327         .args_type  = "",
 328         .params     = "",
 329         .help       = "show guest USB devices",
 330         .cmd        = hmp_info_usb,
 331     },
 332
 333 STEXI
 334 @item info usb
 335 @findex usb
 336 Show guest USB devices.
 337 ETEXI
 338
 339     {
 340         .name       = "usbhost",
 341         .args_type  = "",
 342         .params     = "",
 343         .help       = "show host USB devices",
 344         .cmd        = hmp_info_usbhost,
 345     },
 346
 347 STEXI
 348 @item info usbhost
 349 @findex usbhost
 350 Show host USB devices.
 351 ETEXI
 352
 353     {
 354         .name       = "profile",
 355         .args_type  = "",
 356         .params     = "",
 357         .help       = "show profiling information",
 358         .cmd        = hmp_info_profile,
 359     },
 360
 361 STEXI
 362 @item info profile
 363 @findex profile
 364 Show profiling information.
 365 ETEXI
 366
 367     {
 368         .name       = "capture",
 369         .args_type  = "",
 370         .params     = "",
 371         .help       = "show capture information",
 372         .cmd        = hmp_info_capture,
 373     },
 374
 375 STEXI
 376 @item info capture
 377 @findex capture
 378 Show capture information.
 379 ETEXI
 380
 381     {
 382         .name       = "snapshots",
 383         .args_type  = "",
 384         .params     = "",
 385         .help       = "show the currently saved VM snapshots",
 386         .cmd        = hmp_info_snapshots,
 387     },
 388
 389 STEXI
 390 @item info snapshots
 391 @findex snapshots
 392 Show the currently saved VM snapshots.
 393 ETEXI
 394
 395     {
 396         .name       = "status",
 397         .args_type  = "",
 398         .params     = "",
 399         .help       = "show the current VM status (running|paused)",
 400         .cmd        = hmp_info_status,
 401     },
 402
 403 STEXI
 404 @item info status
 405 @findex status
 406 Show the current VM status (running|paused).
 407 ETEXI
 408
 409     {
 410         .name       = "mice",
 411         .args_type  = "",
 412         .params     = "",
 413         .help       = "show which guest mouse is receiving events",
 414         .cmd        = hmp_info_mice,
 415     },
 416
 417 STEXI
 418 @item info mice
 419 @findex mice
 420 Show which guest mouse is receiving events.
 421 ETEXI
 422
 423     {
 424         .name       = "vnc",
 425         .args_type  = "",
 426         .params     = "",
 427         .help       = "show the vnc server status",
 428         .cmd        = hmp_info_vnc,
 429     },
 430
 431 STEXI
 432 @item info vnc
 433 @findex vnc
 434 Show the vnc server status.
 435 ETEXI
 436
 437 #if defined(CONFIG_SPICE)
 438     {
 439         .name       = "spice",
 440         .args_type  = "",
 441         .params     = "",
 442         .help       = "show the spice server status",
 443         .cmd        = hmp_info_spice,
 444     },
 445 #endif
 446
 447 STEXI
 448 @item info spice
 449 @findex spice
 450 Show the spice server status.
 451 ETEXI
 452
 453     {
 454         .name       = "name",
 455         .args_type  = "",
 456         .params     = "",
 457         .help       = "show the current VM name",
 458         .cmd        = hmp_info_name,
 459     },
 460
 461 STEXI
 462 @item info name
 463 @findex name
 464 Show the current VM name.
 465 ETEXI
 466
 467     {
 468         .name       = "uuid",
 469         .args_type  = "",
 470         .params     = "",
 471         .help       = "show the current VM UUID",
 472         .cmd        = hmp_info_uuid,
 473     },
 474
 475 STEXI
 476 @item info uuid
 477 @findex uuid
 478 Show the current VM UUID.
 479 ETEXI
 480
 481     {
 482         .name       = "cpustats",
 483         .args_type  = "",
 484         .params     = "",
 485         .help       = "show CPU statistics",
 486         .cmd        = hmp_info_cpustats,
 487     },
 488
 489 STEXI
 490 @item info cpustats
 491 @findex cpustats
 492 Show CPU statistics.
 493 ETEXI
 494
 495 #if defined(CONFIG_SLIRP)
 496     {
 497         .name       = "usernet",
 498         .args_type  = "",
 499         .params     = "",
 500         .help       = "show user network stack connection states",
 501         .cmd        = hmp_info_usernet,
 502     },
 503 #endif
 504
 505 STEXI
 506 @item info usernet
 507 @findex usernet
 508 Show user network stack connection states.
 509 ETEXI
 510
 511     {
 512         .name       = "migrate",
 513         .args_type  = "",
 514         .params     = "",
 515         .help       = "show migration status",
 516         .cmd        = hmp_info_migrate,
 517     },
 518
 519 STEXI
 520 @item info migrate
 521 @findex migrate
 522 Show migration status.
 523 ETEXI
 524
 525     {
 526         .name       = "migrate_capabilities",
 527         .args_type  = "",
 528         .params     = "",
 529         .help       = "show current migration capabilities",
 530         .cmd        = hmp_info_migrate_capabilities,
 531     },
 532
 533 STEXI
 534 @item info migrate_capabilities
 535 @findex migrate_capabilities
 536 Show current migration capabilities.
 537 ETEXI
 538
 539     {
 540         .name       = "migrate_parameters",
 541         .args_type  = "",
 542         .params     = "",
 543         .help       = "show current migration parameters",
 544         .cmd        = hmp_info_migrate_parameters,
 545     },
 546
 547 STEXI
 548 @item info migrate_parameters
 549 @findex migrate_parameters
 550 Show current migration parameters.
 551 ETEXI
 552
 553     {
 554         .name       = "migrate_cache_size",
 555         .args_type  = "",
 556         .params     = "",
 557         .help       = "show current migration xbzrle cache size",
 558         .cmd        = hmp_info_migrate_cache_size,
 559     },
 560
 561 STEXI
 562 @item info migrate_cache_size
 563 @findex migrate_cache_size
 564 Show current migration xbzrle cache size.
 565 ETEXI
 566
 567     {
 568         .name       = "balloon",
 569         .args_type  = "",
 570         .params     = "",
 571         .help       = "show balloon information",
 572         .cmd        = hmp_info_balloon,
 573     },
 574
 575 STEXI
 576 @item info balloon
 577 @findex balloon
 578 Show balloon information.
 579 ETEXI
 580
 581     {
 582         .name       = "qtree",
 583         .args_type  = "",
 584         .params     = "",
 585         .help       = "show device tree",
 586         .cmd        = hmp_info_qtree,
 587     },
 588
 589 STEXI
 590 @item info qtree
 591 @findex qtree
 592 Show device tree.
 593 ETEXI
 594
 595     {
 596         .name       = "qdm",
 597         .args_type  = "",
 598         .params     = "",
 599         .help       = "show qdev device model list",
 600         .cmd        = hmp_info_qdm,
 601     },
 602
 603 STEXI
 604 @item info qdm
 605 @findex qdm
 606 Show qdev device model list.
 607 ETEXI
 608
 609     {
 610         .name       = "qom-tree",
 611         .args_type  = "path:s?",
 612         .params     = "[path]",
 613         .help       = "show QOM composition tree",
 614         .cmd        = hmp_info_qom_tree,
 615     },
 616
 617 STEXI
 618 @item info qom-tree
 619 @findex qom-tree
 620 Show QOM composition tree.
 621 ETEXI
 622
 623     {
 624         .name       = "roms",
 625         .args_type  = "",
 626         .params     = "",
 627         .help       = "show roms",
 628         .cmd        = hmp_info_roms,
 629     },
 630
 631 STEXI
 632 @item info roms
 633 @findex roms
 634 Show roms.
 635 ETEXI
 636
 637     {
 638         .name       = "trace-events",
 639         .args_type  = "name:s?,vcpu:i?",
 640         .params     = "[name] [vcpu]",
 641         .help       = "show available trace-events & their state "
 642                       "(name: event name pattern; vcpu: vCPU to query, default is any)",
 643         .cmd = hmp_info_trace_events,
 644         .command_completion = info_trace_events_completion,
 645     },
 646
 647 STEXI
 648 @item info trace-events
 649 @findex trace-events
 650 Show available trace-events & their state.
 651 ETEXI
 652
 653     {
 654         .name       = "tpm",
 655         .args_type  = "",
 656         .params     = "",
 657         .help       = "show the TPM device",
 658         .cmd        = hmp_info_tpm,
 659     },
 660
 661 STEXI
 662 @item info tpm
 663 @findex tpm
 664 Show the TPM device.
 665 ETEXI
 666
 667     {
 668         .name       = "memdev",
 669         .args_type  = "",
 670         .params     = "",
 671         .help       = "show memory backends",
 672         .cmd        = hmp_info_memdev,
 673     },
 674
 675 STEXI
 676 @item info memdev
 677 @findex memdev
 678 Show memory backends
 679 ETEXI
 680
 681     {
 682         .name       = "memory-devices",
 683         .args_type  = "",
 684         .params     = "",
 685         .help       = "show memory devices",
 686         .cmd        = hmp_info_memory_devices,
 687     },
 688
 689 STEXI
 690 @item info memory-devices
 691 @findex memory-devices
 692 Show memory devices.
 693 ETEXI
 694
 695     {
 696         .name       = "iothreads",
 697         .args_type  = "",
 698         .params     = "",
 699         .help       = "show iothreads",
 700         .cmd        = hmp_info_iothreads,
 701     },
 702
 703 STEXI
 704 @item info iothreads
 705 @findex iothreads
 706 Show iothread's identifiers.
 707 ETEXI
 708
 709     {
 710         .name       = "rocker",
 711         .args_type  = "name:s",
 712         .params     = "name",
 713         .help       = "Show rocker switch",
 714         .cmd        = hmp_rocker,
 715     },
 716
 717 STEXI
 718 @item info rocker @var{name}
 719 @findex rocker
 720 Show rocker switch.
 721 ETEXI
 722
 723     {
 724         .name       = "rocker-ports",
 725         .args_type  = "name:s",
 726         .params     = "name",
 727         .help       = "Show rocker ports",
 728         .cmd        = hmp_rocker_ports,
 729     },
 730
 731 STEXI
 732 @item info rocker_ports @var{name}-ports
 733 @findex ocker-ports
 734 Show rocker ports.
 735 ETEXI
 736
 737     {
 738         .name       = "rocker-of-dpa-flows",
 739         .args_type  = "name:s,tbl_id:i?",
 740         .params     = "name [tbl_id]",
 741         .help       = "Show rocker OF-DPA flow tables",
 742         .cmd        = hmp_rocker_of_dpa_flows,
 743     },
 744
 745 STEXI
 746 @item info rocker_of_dpa_flows @var{name} [@var{tbl_id}]
 747 @findex rocker-of-dpa-flows
 748 Show rocker OF-DPA flow tables.
 749 ETEXI
 750
 751     {
 752         .name       = "rocker-of-dpa-groups",
 753         .args_type  = "name:s,type:i?",
 754         .params     = "name [type]",
 755         .help       = "Show rocker OF-DPA groups",
 756         .cmd        = hmp_rocker_of_dpa_groups,
 757     },
 758
 759 STEXI
 760 @item info rocker-of-dpa-groups @var{name} [@var{type}]
 761 @findex rocker-of-dpa-groups
 762 Show rocker OF-DPA groups.
 763 ETEXI
 764
 765 #if defined(TARGET_S390X)
 766     {
 767         .name       = "skeys",
 768         .args_type  = "addr:l",
 769         .params     = "address",
 770         .help       = "Display the value of a storage key",
 771         .cmd        = hmp_info_skeys,
 772     },
 773 #endif
 774
 775 STEXI
 776 @item info skeys @var{address}
 777 @findex skeys
 778 Display the value of a storage key (s390 only)
 779 ETEXI
 780
 781 #if defined(TARGET_S390X)
 782     {
 783         .name       = "cmma",
 784         .args_type  = "addr:l,count:l?",
 785         .params     = "address [count]",
 786         .help       = "Display the values of the CMMA storage attributes for a range of pages",
 787         .cmd        = hmp_info_cmma,
 788     },
 789 #endif
 790
 791 STEXI
 792 @item info cmma @var{address}
 793 @findex cmma
 794 Display the values of the CMMA storage attributes for a range of pages (s390 only)
 795 ETEXI
 796
 797     {
 798         .name       = "dump",
 799         .args_type  = "",
 800         .params     = "",
 801         .help       = "Display the latest dump status",
 802         .cmd        = hmp_info_dump,
 803     },
 804
 805 STEXI
 806 @item info dump
 807 @findex dump
 808 Display the latest dump status.
 809 ETEXI
 810
 811     {
 812         .name       = "ramblock",
 813         .args_type  = "",
 814         .params     = "",
 815         .help       = "Display system ramblock information",
 816         .cmd        = hmp_info_ramblock,
 817     },
 818
 819 STEXI
 820 @item info ramblock
 821 @findex ramblock
 822 Dump all the ramblocks of the system.
 823 ETEXI
 824
 825     {
 826         .name       = "hotpluggable-cpus",
 827         .args_type  = "",
 828         .params     = "",
 829         .help       = "Show information about hotpluggable CPUs",
 830         .cmd        = hmp_hotpluggable_cpus,
 831     },
 832
 833 STEXI
 834 @item info hotpluggable-cpus
 835 @findex hotpluggable-cpus
 836 Show information about hotpluggable CPUs
 837 ETEXI
 838
 839 STEXI
 840 @item info vm-generation-id
 841 @findex vm-generation-id
 842 Show Virtual Machine Generation ID
 843 ETEXI
 844
 845     {
 846         .name       = "vm-generation-id",
 847         .args_type  = "",
 848         .params     = "",
 849         .help       = "Show Virtual Machine Generation ID",
 850         .cmd = hmp_info_vm_generation_id,
 851     },
 852
 853 STEXI
 854 @item info memory_size_summary
 855 @findex memory_size_summary
 856 Display the amount of initially allocated and present hotpluggable (if
 857 enabled) memory in bytes.
 858 ETEXI
 859
 860     {
 861         .name       = "memory_size_summary",
 862         .args_type  = "",
 863         .params     = "",
 864         .help       = "show the amount of initially allocated and "
 865                       "present hotpluggable (if enabled) memory in bytes.",
 866         .cmd        = hmp_info_memory_size_summary,
 867     },
 868
 869 STEXI
 870 @end table
 871 ETEXI
 872
 873 STEXI
 874 @end table
 875 ETEXI