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