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