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