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