hmp-commands-info.hx

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