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