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