hmp-commands.hx

   1 HXCOMM See docs/devel/docs.rst for the format of this file.
   2 HXCOMM
   3 HXCOMM This file defines the contents of an array of HMPCommand structs
   4 HXCOMM which specify the name, behaviour and help text for HMP commands.
   5 HXCOMM Text between SRST and ERST is rST format documentation.
   6 HXCOMM HXCOMM can be used for comments, discarded from both rST and C.
   7
   8
   9     {
  10         .name       = "help|?",
  11         .args_type  = "name:S?",
  12         .params     = "[cmd]",
  13         .help       = "show the help",
  14         .cmd        = hmp_help,
  15         .flags      = "p",
  16     },
  17
  18 SRST
  19 ``help`` or ``?`` [*cmd*]
  20   Show the help for all commands or just for command *cmd*.
  21 ERST
  22
  23     {
  24         .name       = "commit",
  25         .args_type  = "device:B",
  26         .params     = "device|all",
  27         .help       = "commit changes to the disk images (if -snapshot is used) or backing files",
  28         .cmd        = hmp_commit,
  29     },
  30
  31 SRST
  32 ``commit``
  33   Commit changes to the disk images (if -snapshot is used) or backing files.
  34   If the backing file is smaller than the snapshot, then the backing file
  35   will be resized to be the same size as the snapshot.  If the snapshot is
  36   smaller than the backing file, the backing file will not be truncated.
  37   If you want the backing file to match the size of the smaller snapshot,
  38   you can safely truncate it yourself once the commit operation successfully
  39   completes.
  40 ERST
  41
  42     {
  43         .name       = "quit|q",
  44         .args_type  = "",
  45         .params     = "",
  46         .help       = "quit the emulator",
  47         .cmd        = hmp_quit,
  48         .flags      = "p",
  49     },
  50
  51 SRST
  52 ``quit`` or ``q``
  53   Quit the emulator.
  54 ERST
  55
  56     {
  57         .name       = "exit_preconfig",
  58         .args_type  = "",
  59         .params     = "",
  60         .help       = "exit the preconfig state",
  61         .cmd        = hmp_exit_preconfig,
  62         .flags      = "p",
  63     },
  64
  65 SRST
  66 ``exit_preconfig``
  67   This command makes QEMU exit the preconfig state and proceed with
  68   VM initialization using configuration data provided on the command line
  69   and via the QMP monitor during the preconfig state. The command is only
  70   available during the preconfig state (i.e. when the --preconfig command
  71   line option was in use).
  72 ERST
  73
  74     {
  75         .name       = "block_resize",
  76         .args_type  = "device:B,size:o",
  77         .params     = "device size",
  78         .help       = "resize a block image",
  79         .cmd        = hmp_block_resize,
  80         .coroutine  = true,
  81         .flags      = "p",
  82     },
  83
  84 SRST
  85 ``block_resize``
  86   Resize a block image while a guest is running.  Usually requires guest
  87   action to see the updated size.  Resize to a lower size is supported,
  88   but should be used with extreme caution.  Note that this command only
  89   resizes image files, it can not resize block devices like LVM volumes.
  90 ERST
  91
  92     {
  93         .name       = "block_stream",
  94         .args_type  = "device:B,speed:o?,base:s?",
  95         .params     = "device [speed [base]]",
  96         .help       = "copy data from a backing file into a block device",
  97         .cmd        = hmp_block_stream,
  98         .flags      = "p",
  99     },
 100
 101 SRST
 102 ``block_stream``
 103   Copy data from a backing file into a block device.
 104 ERST
 105
 106     {
 107         .name       = "block_job_set_speed",
 108         .args_type  = "device:B,speed:o",
 109         .params     = "device speed",
 110         .help       = "set maximum speed for a background block operation",
 111         .cmd        = hmp_block_job_set_speed,
 112         .flags      = "p",
 113     },
 114
 115 SRST
 116 ``block_job_set_speed``
 117   Set maximum speed for a background block operation.
 118 ERST
 119
 120     {
 121         .name       = "block_job_cancel",
 122         .args_type  = "force:-f,device:B",
 123         .params     = "[-f] device",
 124         .help       = "stop an active background block operation (use -f"
 125                       "\n\t\t\t if you want to abort the operation immediately"
 126                       "\n\t\t\t instead of keep running until data is in sync)",
 127         .cmd        = hmp_block_job_cancel,
 128         .flags      = "p",
 129     },
 130
 131 SRST
 132 ``block_job_cancel``
 133   Stop an active background block operation (streaming, mirroring).
 134 ERST
 135
 136     {
 137         .name       = "block_job_complete",
 138         .args_type  = "device:B",
 139         .params     = "device",
 140         .help       = "stop an active background block operation",
 141         .cmd        = hmp_block_job_complete,
 142         .flags      = "p",
 143     },
 144
 145 SRST
 146 ``block_job_complete``
 147   Manually trigger completion of an active background block operation.
 148   For mirroring, this will switch the device to the destination path.
 149 ERST
 150
 151     {
 152         .name       = "block_job_pause",
 153         .args_type  = "device:B",
 154         .params     = "device",
 155         .help       = "pause an active background block operation",
 156         .cmd        = hmp_block_job_pause,
 157         .flags      = "p",
 158     },
 159
 160 SRST
 161 ``block_job_pause``
 162   Pause an active block streaming operation.
 163 ERST
 164
 165     {
 166         .name       = "block_job_resume",
 167         .args_type  = "device:B",
 168         .params     = "device",
 169         .help       = "resume a paused background block operation",
 170         .cmd        = hmp_block_job_resume,
 171         .flags      = "p",
 172     },
 173
 174 SRST
 175 ``block_job_resume``
 176   Resume a paused block streaming operation.
 177 ERST
 178
 179     {
 180         .name       = "eject",
 181         .args_type  = "force:-f,device:B",
 182         .params     = "[-f] device",
 183         .help       = "eject a removable medium (use -f to force it)",
 184         .cmd        = hmp_eject,
 185     },
 186
 187 SRST
 188 ``eject [-f]`` *device*
 189   Eject a removable medium (use -f to force it).
 190 ERST
 191
 192     {
 193         .name       = "drive_del",
 194         .args_type  = "id:B",
 195         .params     = "device",
 196         .help       = "remove host block device",
 197         .cmd        = hmp_drive_del,
 198     },
 199
 200 SRST
 201 ``drive_del`` *device*
 202   Remove host block device.  The result is that guest generated IO is no longer
 203   submitted against the host device underlying the disk.  Once a drive has
 204   been deleted, the QEMU Block layer returns -EIO which results in IO
 205   errors in the guest for applications that are reading/writing to the device.
 206   These errors are always reported to the guest, regardless of the drive's error
 207   actions (drive options rerror, werror).
 208 ERST
 209
 210     {
 211         .name       = "change",
 212         .args_type  = "device:B,force:-f,target:F,arg:s?,read-only-mode:s?",
 213         .params     = "device [-f] filename [format [read-only-mode]]",
 214         .help       = "change a removable medium, optional format, use -f to force the operation",
 215         .cmd        = hmp_change,
 216     },
 217
 218 SRST
 219 ``change`` *device* *setting*
 220   Change the configuration of a device.
 221
 222   ``change`` *diskdevice* [-f] *filename* [*format* [*read-only-mode*]]
 223     Change the medium for a removable disk device to point to *filename*. eg::
 224
 225       (qemu) change ide1-cd0 /path/to/some.iso
 226
 227     ``-f``
 228       forces the operation even if the guest has locked the tray.
 229
 230     *format* is optional.
 231
 232     *read-only-mode* may be used to change the read-only status of the device.
 233     It accepts the following values:
 234
 235     retain
 236       Retains the current status; this is the default.
 237
 238     read-only
 239       Makes the device read-only.
 240
 241     read-write
 242       Makes the device writable.
 243
 244   ``change vnc password`` [*password*]
 245
 246     Change the password associated with the VNC server. If the new password
 247     is not supplied, the monitor will prompt for it to be entered. VNC
 248     passwords are only significant up to 8 letters. eg::
 249
 250       (qemu) change vnc password
 251       Password: ********
 252
 253 ERST
 254
 255 #ifdef CONFIG_PIXMAN
 256     {
 257         .name       = "screendump",
 258         .args_type  = "filename:F,format:-fs,device:s?,head:i?",
 259         .params     = "filename [-f format] [device [head]]",
 260         .help       = "save screen from head 'head' of display device 'device'"
 261                       "in specified format 'format' as image 'filename'."
 262                       "Currently only 'png' and 'ppm' formats are supported.",
 263          .cmd        = hmp_screendump,
 264         .coroutine  = true,
 265     },
 266
 267 SRST
 268 ``screendump`` *filename*
 269   Save screen into PPM image *filename*.
 270 ERST
 271 #endif
 272
 273     {
 274         .name       = "logfile",
 275         .args_type  = "filename:F",
 276         .params     = "filename",
 277         .help       = "output logs to 'filename'",
 278         .cmd        = hmp_logfile,
 279     },
 280
 281 SRST
 282 ``logfile`` *filename*
 283   Output logs to *filename*.
 284 ERST
 285
 286     {
 287         .name       = "trace-event",
 288         .args_type  = "name:s,option:b,vcpu:i?",
 289         .params     = "name on|off [vcpu]",
 290         .help       = "changes status of a specific trace event "
 291                       "(vcpu: vCPU to set, default is all)",
 292         .cmd = hmp_trace_event,
 293         .command_completion = trace_event_completion,
 294     },
 295
 296 SRST
 297 ``trace-event``
 298   changes status of a trace event
 299 ERST
 300
 301 #if defined(CONFIG_TRACE_SIMPLE)
 302     {
 303         .name       = "trace-file",
 304         .args_type  = "op:s?,arg:F?",
 305         .params     = "on|off|flush|set [arg]",
 306         .help       = "open, close, or flush trace file, or set a new file name",
 307         .cmd        = hmp_trace_file,
 308     },
 309
 310 SRST
 311 ``trace-file on|off|flush``
 312   Open, close, or flush the trace file.  If no argument is given, the
 313   status of the trace file is displayed.
 314 ERST
 315 #endif
 316
 317     {
 318         .name       = "log",
 319         .args_type  = "items:s",
 320         .params     = "item1[,...]",
 321         .help       = "activate logging of the specified items",
 322         .cmd        = hmp_log,
 323     },
 324
 325 SRST
 326 ``log`` *item1*\ [,...]
 327   Activate logging of the specified items.
 328 ERST
 329
 330     {
 331         .name       = "savevm",
 332         .args_type  = "name:s?",
 333         .params     = "tag",
 334         .help       = "save a VM snapshot. If no tag is provided, a new snapshot is created",
 335         .cmd        = hmp_savevm,
 336     },
 337
 338 SRST
 339 ``savevm`` *tag*
 340   Create a snapshot of the whole virtual machine. If *tag* is
 341   provided, it is used as human readable identifier. If there is already
 342   a snapshot with the same tag, it is replaced. More info at
 343   :ref:`vm_005fsnapshots`.
 344
 345   Since 4.0, savevm stopped allowing the snapshot id to be set, accepting
 346   only *tag* as parameter.
 347 ERST
 348
 349     {
 350         .name       = "loadvm",
 351         .args_type  = "name:s",
 352         .params     = "tag",
 353         .help       = "restore a VM snapshot from its tag",
 354         .cmd        = hmp_loadvm,
 355         .command_completion = loadvm_completion,
 356     },
 357
 358 SRST
 359 ``loadvm`` *tag*
 360   Set the whole virtual machine to the snapshot identified by the tag
 361   *tag*.
 362
 363   Since 4.0, loadvm stopped accepting snapshot id as parameter.
 364 ERST
 365
 366     {
 367         .name       = "delvm",
 368         .args_type  = "name:s",
 369         .params     = "tag",
 370         .help       = "delete a VM snapshot from its tag",
 371         .cmd        = hmp_delvm,
 372         .command_completion = delvm_completion,
 373     },
 374
 375 SRST
 376 ``delvm`` *tag*
 377   Delete the snapshot identified by *tag*.
 378
 379   Since 4.0, delvm stopped deleting snapshots by snapshot id, accepting
 380   only *tag* as parameter.
 381 ERST
 382
 383     {
 384         .name       = "one-insn-per-tb",
 385         .args_type  = "option:s?",
 386         .params     = "[on|off]",
 387         .help       = "run emulation with one guest instruction per translation block",
 388         .cmd        = hmp_one_insn_per_tb,
 389     },
 390
 391 SRST
 392 ``one-insn-per-tb [off]``
 393   Run the emulation with one guest instruction per translation block.
 394   This slows down emulation a lot, but can be useful in some situations,
 395   such as when trying to analyse the logs produced by the ``-d`` option.
 396   This only has an effect when using TCG, not with KVM or other accelerators.
 397
 398   If called with option off, the emulation returns to normal mode.
 399 ERST
 400
 401     {
 402         .name       = "stop|s",
 403         .args_type  = "",
 404         .params     = "",
 405         .help       = "stop emulation",
 406         .cmd        = hmp_stop,
 407     },
 408
 409 SRST
 410 ``stop`` or ``s``
 411   Stop emulation.
 412 ERST
 413
 414     {
 415         .name       = "cont|c",
 416         .args_type  = "",
 417         .params     = "",
 418         .help       = "resume emulation",
 419         .cmd        = hmp_cont,
 420     },
 421
 422 SRST
 423 ``cont`` or ``c``
 424   Resume emulation.
 425 ERST
 426
 427     {
 428         .name       = "system_wakeup",
 429         .args_type  = "",
 430         .params     = "",
 431         .help       = "wakeup guest from suspend",
 432         .cmd        = hmp_system_wakeup,
 433     },
 434
 435 SRST
 436 ``system_wakeup``
 437   Wakeup guest from suspend.
 438 ERST
 439
 440     {
 441         .name       = "gdbserver",
 442         .args_type  = "device:s?",
 443         .params     = "[device]",
 444         .help       = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
 445         .cmd        = hmp_gdbserver,
 446     },
 447
 448 SRST
 449 ``gdbserver`` [*port*]
 450   Start gdbserver session (default *port*\=1234)
 451 ERST
 452
 453     {
 454         .name       = "x",
 455         .args_type  = "fmt:/,addr:l",
 456         .params     = "/fmt addr",
 457         .help       = "virtual memory dump starting at 'addr'",
 458         .cmd        = hmp_memory_dump,
 459     },
 460
 461 SRST
 462 ``x/``\ *fmt* *addr*
 463   Virtual memory dump starting at *addr*.
 464 ERST
 465
 466     {
 467         .name       = "xp",
 468         .args_type  = "fmt:/,addr:l",
 469         .params     = "/fmt addr",
 470         .help       = "physical memory dump starting at 'addr'",
 471         .cmd        = hmp_physical_memory_dump,
 472     },
 473
 474 SRST
 475 ``xp /``\ *fmt* *addr*
 476   Physical memory dump starting at *addr*.
 477
 478   *fmt* is a format which tells the command how to format the
 479   data. Its syntax is: ``/{count}{format}{size}``
 480
 481   *count*
 482     is the number of items to be dumped.
 483   *format*
 484     can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
 485     c (char) or i (asm instruction).
 486   *size*
 487     can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
 488     ``h`` or ``w`` can be specified with the ``i`` format to
 489     respectively select 16 or 32 bit code instruction size.
 490
 491   Examples:
 492
 493   Dump 10 instructions at the current instruction pointer::
 494
 495     (qemu) x/10i $eip
 496     0x90107063:  ret
 497     0x90107064:  sti
 498     0x90107065:  lea    0x0(%esi,1),%esi
 499     0x90107069:  lea    0x0(%edi,1),%edi
 500     0x90107070:  ret
 501     0x90107071:  jmp    0x90107080
 502     0x90107073:  nop
 503     0x90107074:  nop
 504     0x90107075:  nop
 505     0x90107076:  nop
 506
 507   Dump 80 16 bit values at the start of the video memory::
 508
 509     (qemu) xp/80hx 0xb8000
 510     0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
 511     0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
 512     0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
 513     0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
 514     0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
 515     0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
 516     0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
 517     0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
 518     0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
 519     0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
 520
 521 ERST
 522
 523     {
 524         .name       = "gpa2hva",
 525         .args_type  = "addr:l",
 526         .params     = "addr",
 527         .help       = "print the host virtual address corresponding to a guest physical address",
 528         .cmd        = hmp_gpa2hva,
 529     },
 530
 531 SRST
 532 ``gpa2hva`` *addr*
 533   Print the host virtual address at which the guest's physical address *addr*
 534   is mapped.
 535 ERST
 536
 537 #ifdef CONFIG_LINUX
 538     {
 539         .name       = "gpa2hpa",
 540         .args_type  = "addr:l",
 541         .params     = "addr",
 542         .help       = "print the host physical address corresponding to a guest physical address",
 543         .cmd        = hmp_gpa2hpa,
 544     },
 545 #endif
 546
 547 SRST
 548 ``gpa2hpa`` *addr*
 549   Print the host physical address at which the guest's physical address *addr*
 550   is mapped.
 551 ERST
 552
 553     {
 554         .name       = "gva2gpa",
 555         .args_type  = "addr:l",
 556         .params     = "addr",
 557         .help       = "print the guest physical address corresponding to a guest virtual address",
 558         .cmd        = hmp_gva2gpa,
 559     },
 560
 561 SRST
 562 ``gva2gpa`` *addr*
 563   Print the guest physical address at which the guest's virtual address *addr*
 564   is mapped based on the mapping for the current CPU.
 565 ERST
 566
 567     {
 568         .name       = "print|p",
 569         .args_type  = "fmt:/,val:l",
 570         .params     = "/fmt expr",
 571         .help       = "print expression value (use $reg for CPU register access)",
 572         .cmd        = hmp_print,
 573     },
 574
 575 SRST
 576 ``print`` or ``p/``\ *fmt* *expr*
 577   Print expression value. Only the *format* part of *fmt* is
 578   used.
 579 ERST
 580
 581     {
 582         .name       = "i",
 583         .args_type  = "fmt:/,addr:i,index:i.",
 584         .params     = "/fmt addr",
 585         .help       = "I/O port read",
 586         .cmd        = hmp_ioport_read,
 587     },
 588
 589 SRST
 590 ``i/``\ *fmt* *addr* [.\ *index*\ ]
 591   Read I/O port.
 592 ERST
 593
 594     {
 595         .name       = "o",
 596         .args_type  = "fmt:/,addr:i,val:i",
 597         .params     = "/fmt addr value",
 598         .help       = "I/O port write",
 599         .cmd        = hmp_ioport_write,
 600     },
 601
 602 SRST
 603 ``o/``\ *fmt* *addr* *val*
 604   Write to I/O port.
 605 ERST
 606
 607     {
 608         .name       = "sendkey",
 609         .args_type  = "keys:s,hold-time:i?",
 610         .params     = "keys [hold_ms]",
 611         .help       = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
 612         .cmd        = hmp_sendkey,
 613         .command_completion = sendkey_completion,
 614     },
 615
 616 SRST
 617 ``sendkey`` *keys*
 618   Send *keys* to the guest. *keys* could be the name of the
 619   key or the raw value in hexadecimal format. Use ``-`` to press
 620   several keys simultaneously. Example::
 621
 622     sendkey ctrl-alt-f1
 623
 624   This command is useful to send keys that your graphical user interface
 625   intercepts at low level, such as ``ctrl-alt-f1`` in X Window.
 626 ERST
 627     {
 628         .name       = "sync-profile",
 629         .args_type  = "op:s?",
 630         .params     = "[on|off|reset]",
 631         .help       = "enable, disable or reset synchronization profiling. "
 632                       "With no arguments, prints whether profiling is on or off.",
 633         .cmd        = hmp_sync_profile,
 634     },
 635
 636 SRST
 637 ``sync-profile [on|off|reset]``
 638   Enable, disable or reset synchronization profiling. With no arguments, prints
 639   whether profiling is on or off.
 640 ERST
 641
 642     {
 643         .name       = "system_reset",
 644         .args_type  = "",
 645         .params     = "",
 646         .help       = "reset the system",
 647         .cmd        = hmp_system_reset,
 648     },
 649
 650 SRST
 651 ``system_reset``
 652   Reset the system.
 653 ERST
 654
 655     {
 656         .name       = "system_powerdown",
 657         .args_type  = "",
 658         .params     = "",
 659         .help       = "send system power down event",
 660         .cmd        = hmp_system_powerdown,
 661     },
 662
 663 SRST
 664 ``system_powerdown``
 665   Power down the system (if supported).
 666 ERST
 667
 668     {
 669         .name       = "sum",
 670         .args_type  = "start:i,size:i",
 671         .params     = "addr size",
 672         .help       = "compute the checksum of a memory region",
 673         .cmd        = hmp_sum,
 674     },
 675
 676 SRST
 677 ``sum`` *addr* *size*
 678   Compute the checksum of a memory region.
 679 ERST
 680
 681     {
 682         .name       = "device_add",
 683         .args_type  = "device:O",
 684         .params     = "driver[,prop=value][,...]",
 685         .help       = "add device, like -device on the command line",
 686         .cmd        = hmp_device_add,
 687         .command_completion = device_add_completion,
 688     },
 689
 690 SRST
 691 ``device_add`` *config*
 692   Add device.
 693 ERST
 694
 695     {
 696         .name       = "device_del",
 697         .args_type  = "id:s",
 698         .params     = "device",
 699         .help       = "remove device",
 700         .cmd        = hmp_device_del,
 701         .command_completion = device_del_completion,
 702     },
 703
 704 SRST
 705 ``device_del`` *id*
 706   Remove device *id*. *id* may be a short ID
 707   or a QOM object path.
 708 ERST
 709
 710     {
 711         .name       = "cpu",
 712         .args_type  = "index:i",
 713         .params     = "index",
 714         .help       = "set the default CPU",
 715         .cmd        = hmp_cpu,
 716     },
 717
 718 SRST
 719 ``cpu`` *index*
 720   Set the default CPU.
 721 ERST
 722
 723     {
 724         .name       = "mouse_move",
 725         .args_type  = "dx_str:s,dy_str:s,dz_str:s?",
 726         .params     = "dx dy [dz]",
 727         .help       = "send mouse move events",
 728         .cmd        = hmp_mouse_move,
 729     },
 730
 731 SRST
 732 ``mouse_move`` *dx* *dy* [*dz*]
 733   Move the active mouse to the specified coordinates *dx* *dy*
 734   with optional scroll axis *dz*.
 735 ERST
 736
 737     {
 738         .name       = "mouse_button",
 739         .args_type  = "button_state:i",
 740         .params     = "state",
 741         .help       = "change mouse button state (1=L, 2=M, 4=R)",
 742         .cmd        = hmp_mouse_button,
 743     },
 744
 745 SRST
 746 ``mouse_button`` *val*
 747   Change the active mouse button state *val* (1=L, 2=M, 4=R).
 748 ERST
 749
 750     {
 751         .name       = "mouse_set",
 752         .args_type  = "index:i",
 753         .params     = "index",
 754         .help       = "set which mouse device receives events",
 755         .cmd        = hmp_mouse_set,
 756     },
 757
 758 SRST
 759 ``mouse_set`` *index*
 760   Set which mouse device receives events at given *index*, index
 761   can be obtained with::
 762
 763     info mice
 764
 765 ERST
 766
 767     {
 768         .name       = "wavcapture",
 769         .args_type  = "path:F,audiodev:s,freq:i?,bits:i?,nchannels:i?",
 770         .params     = "path audiodev [frequency [bits [channels]]]",
 771         .help       = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
 772         .cmd        = hmp_wavcapture,
 773     },
 774 SRST
 775 ``wavcapture`` *filename* *audiodev* [*frequency* [*bits* [*channels*]]]
 776   Capture audio into *filename* from *audiodev*, using sample rate
 777   *frequency* bits per sample *bits* and number of channels
 778   *channels*.
 779
 780   Defaults:
 781
 782   - Sample rate = 44100 Hz - CD quality
 783   - Bits = 16
 784   - Number of channels = 2 - Stereo
 785 ERST
 786
 787     {
 788         .name       = "stopcapture",
 789         .args_type  = "n:i",
 790         .params     = "capture index",
 791         .help       = "stop capture",
 792         .cmd        = hmp_stopcapture,
 793     },
 794 SRST
 795 ``stopcapture`` *index*
 796   Stop capture with a given *index*, index can be obtained with::
 797
 798     info capture
 799
 800 ERST
 801
 802     {
 803         .name       = "memsave",
 804         .args_type  = "val:l,size:i,filename:s",
 805         .params     = "addr size file",
 806         .help       = "save to disk virtual memory dump starting at 'addr' of size 'size'",
 807         .cmd        = hmp_memsave,
 808     },
 809
 810 SRST
 811 ``memsave`` *addr* *size* *file*
 812   save to disk virtual memory dump starting at *addr* of size *size*.
 813 ERST
 814
 815     {
 816         .name       = "pmemsave",
 817         .args_type  = "val:l,size:i,filename:s",
 818         .params     = "addr size file",
 819         .help       = "save to disk physical memory dump starting at 'addr' of size 'size'",
 820         .cmd        = hmp_pmemsave,
 821     },
 822
 823 SRST
 824 ``pmemsave`` *addr* *size* *file*
 825   save to disk physical memory dump starting at *addr* of size *size*.
 826 ERST
 827
 828     {
 829         .name       = "boot_set",
 830         .args_type  = "bootdevice:s",
 831         .params     = "bootdevice",
 832         .help       = "define new values for the boot device list",
 833         .cmd        = hmp_boot_set,
 834     },
 835
 836 SRST
 837 ``boot_set`` *bootdevicelist*
 838   Define new values for the boot device list. Those values will override
 839   the values specified on the command line through the ``-boot`` option.
 840
 841   The values that can be specified here depend on the machine type, but are
 842   the same that can be specified in the ``-boot`` command line option.
 843 ERST
 844
 845     {
 846         .name       = "nmi",
 847         .args_type  = "",
 848         .params     = "",
 849         .help       = "inject an NMI",
 850         .cmd        = hmp_nmi,
 851     },
 852 SRST
 853 ``nmi`` *cpu*
 854   Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
 855 ERST
 856
 857     {
 858         .name       = "ringbuf_write",
 859         .args_type  = "device:s,data:s",
 860         .params     = "device data",
 861         .help       = "Write to a ring buffer character device",
 862         .cmd        = hmp_ringbuf_write,
 863         .command_completion = ringbuf_write_completion,
 864     },
 865
 866 SRST
 867 ``ringbuf_write`` *device* *data*
 868   Write *data* to ring buffer character device *device*.
 869   *data* must be a UTF-8 string.
 870 ERST
 871
 872     {
 873         .name       = "ringbuf_read",
 874         .args_type  = "device:s,size:i",
 875         .params     = "device size",
 876         .help       = "Read from a ring buffer character device",
 877         .cmd        = hmp_ringbuf_read,
 878         .command_completion = ringbuf_write_completion,
 879     },
 880
 881 SRST
 882 ``ringbuf_read`` *device*
 883   Read and print up to *size* bytes from ring buffer character
 884   device *device*.
 885   Certain non-printable characters are printed ``\uXXXX``, where ``XXXX`` is the
 886   character code in hexadecimal.  Character ``\`` is printed ``\\``.
 887   Bug: can screw up when the buffer contains invalid UTF-8 sequences,
 888   NUL characters, after the ring buffer lost data, and when reading
 889   stops because the size limit is reached.
 890 ERST
 891
 892     {
 893         .name       = "announce_self",
 894         .args_type  = "interfaces:s?,id:s?",
 895         .params     = "[interfaces] [id]",
 896         .help       = "Trigger GARP/RARP announcements",
 897         .cmd        = hmp_announce_self,
 898     },
 899
 900 SRST
 901 ``announce_self``
 902   Trigger a round of GARP/RARP broadcasts; this is useful for explicitly
 903   updating the network infrastructure after a reconfiguration or some forms
 904   of migration. The timings of the round are set by the migration announce
 905   parameters. An optional comma separated *interfaces* list restricts the
 906   announce to the named set of interfaces. An optional *id* can be used to
 907   start a separate announce timer and to change the parameters of it later.
 908 ERST
 909
 910     {
 911         .name       = "migrate",
 912         .args_type  = "detach:-d,blk:-b,inc:-i,resume:-r,uri:s",
 913         .params     = "[-d] [-b] [-i] [-r] uri",
 914         .help       = "migrate to URI (using -d to not wait for completion)"
 915                       "\n\t\t\t -b for migration without shared storage with"
 916                       " full copy of disk\n\t\t\t -i for migration without "
 917                       "shared storage with incremental copy of disk "
 918                       "(base image shared between src and destination)"
 919                       "\n\t\t\t -r to resume a paused migration",
 920         .cmd        = hmp_migrate,
 921     },
 922
 923
 924 SRST
 925 ``migrate [-d] [-b] [-i]`` *uri*
 926   Migrate to *uri* (using -d to not wait for completion).
 927
 928   ``-b``
 929     for migration with full copy of disk
 930   ``-i``
 931     for migration with incremental copy of disk (base image is shared)
 932 ERST
 933
 934     {
 935         .name       = "migrate_cancel",
 936         .args_type  = "",
 937         .params     = "",
 938         .help       = "cancel the current VM migration",
 939         .cmd        = hmp_migrate_cancel,
 940     },
 941
 942 SRST
 943 ``migrate_cancel``
 944   Cancel the current VM migration.
 945 ERST
 946
 947     {
 948         .name       = "migrate_continue",
 949         .args_type  = "state:s",
 950         .params     = "state",
 951         .help       = "Continue migration from the given paused state",
 952         .cmd        = hmp_migrate_continue,
 953     },
 954 SRST
 955 ``migrate_continue`` *state*
 956   Continue migration from the paused state *state*
 957 ERST
 958
 959     {
 960         .name       = "migrate_incoming",
 961         .args_type  = "uri:s",
 962         .params     = "uri",
 963         .help       = "Continue an incoming migration from an -incoming defer",
 964         .cmd        = hmp_migrate_incoming,
 965     },
 966
 967 SRST
 968 ``migrate_incoming`` *uri*
 969   Continue an incoming migration using the *uri* (that has the same syntax
 970   as the ``-incoming`` option).
 971 ERST
 972
 973     {
 974         .name       = "migrate_recover",
 975         .args_type  = "uri:s",
 976         .params     = "uri",
 977         .help       = "Continue a paused incoming postcopy migration",
 978         .cmd        = hmp_migrate_recover,
 979     },
 980
 981 SRST
 982 ``migrate_recover`` *uri*
 983   Continue a paused incoming postcopy migration using the *uri*.
 984 ERST
 985
 986     {
 987         .name       = "migrate_pause",
 988         .args_type  = "",
 989         .params     = "",
 990         .help       = "Pause an ongoing migration (postcopy-only)",
 991         .cmd        = hmp_migrate_pause,
 992     },
 993
 994 SRST
 995 ``migrate_pause``
 996   Pause an ongoing migration.  Currently it only supports postcopy.
 997 ERST
 998
 999     {
1000         .name       = "migrate_set_capability",
1001         .args_type  = "capability:s,state:b",
1002         .params     = "capability state",
1003         .help       = "Enable/Disable the usage of a capability for migration",
1004         .cmd        = hmp_migrate_set_capability,
1005         .command_completion = migrate_set_capability_completion,
1006     },
1007
1008 SRST
1009 ``migrate_set_capability`` *capability* *state*
1010   Enable/Disable the usage of a capability *capability* for migration.
1011 ERST
1012
1013     {
1014         .name       = "migrate_set_parameter",
1015         .args_type  = "parameter:s,value:s",
1016         .params     = "parameter value",
1017         .help       = "Set the parameter for migration",
1018         .cmd        = hmp_migrate_set_parameter,
1019         .command_completion = migrate_set_parameter_completion,
1020     },
1021
1022 SRST
1023 ``migrate_set_parameter`` *parameter* *value*
1024   Set the parameter *parameter* for migration.
1025 ERST
1026
1027     {
1028         .name       = "migrate_start_postcopy",
1029         .args_type  = "",
1030         .params     = "",
1031         .help       = "Followup to a migration command to switch the migration"
1032                       " to postcopy mode. The postcopy-ram capability must "
1033                       "be set on both source and destination before the "
1034                       "original migration command .",
1035         .cmd        = hmp_migrate_start_postcopy,
1036     },
1037
1038 SRST
1039 ``migrate_start_postcopy``
1040   Switch in-progress migration to postcopy mode. Ignored after the end of
1041   migration (or once already in postcopy).
1042 ERST
1043
1044 #ifdef CONFIG_REPLICATION
1045     {
1046         .name       = "x_colo_lost_heartbeat",
1047         .args_type  = "",
1048         .params     = "",
1049         .help       = "Tell COLO that heartbeat is lost,\n\t\t\t"
1050                       "a failover or takeover is needed.",
1051         .cmd = hmp_x_colo_lost_heartbeat,
1052     },
1053 #endif
1054
1055 SRST
1056 ``x_colo_lost_heartbeat``
1057   Tell COLO that heartbeat is lost, a failover or takeover is needed.
1058 ERST
1059
1060     {
1061         .name       = "client_migrate_info",
1062         .args_type  = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1063         .params     = "protocol hostname port tls-port cert-subject",
1064         .help       = "set migration information for remote display",
1065         .cmd        = hmp_client_migrate_info,
1066     },
1067
1068 SRST
1069 ``client_migrate_info`` *protocol* *hostname* *port* *tls-port* *cert-subject*
1070   Set migration information for remote display.  This makes the server
1071   ask the client to automatically reconnect using the new parameters
1072   once migration finished successfully.  Only implemented for SPICE.
1073 ERST
1074
1075     {
1076         .name       = "dump-guest-memory",
1077         .args_type  = "paging:-p,detach:-d,windmp:-w,zlib:-z,lzo:-l,snappy:-s,raw:-R,filename:F,begin:l?,length:l?",
1078         .params     = "[-p] [-d] [-z|-l|-s|-w] [-R] filename [begin length]",
1079         .help       = "dump guest memory into file 'filename'.\n\t\t\t"
1080                       "-p: do paging to get guest's memory mapping.\n\t\t\t"
1081                       "-d: return immediately (do not wait for completion).\n\t\t\t"
1082                       "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1083                       "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1084                       "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
1085                       "-R: when using kdump (-z, -l, -s), use raw rather than makedumpfile-flattened\n\t\t\t"
1086                       "    format\n\t\t\t"
1087                       "-w: dump in Windows crashdump format (can be used instead of ELF-dump converting),\n\t\t\t"
1088                       "    for Windows x86 and x64 guests with vmcoreinfo driver only.\n\t\t\t"
1089                       "begin: the starting physical address.\n\t\t\t"
1090                       "length: the memory size, in bytes.",
1091         .cmd        = hmp_dump_guest_memory,
1092     },
1093
1094 SRST
1095 ``dump-guest-memory [-p]`` *filename* *begin* *length*
1096   \
1097 ``dump-guest-memory [-z|-l|-s|-w]`` *filename*
1098   Dump guest memory to *protocol*. The file can be processed with crash or
1099   gdb. Without ``-z|-l|-s|-w``, the dump format is ELF.
1100
1101   ``-p``
1102     do paging to get guest's memory mapping.
1103   ``-z``
1104     dump in kdump-compressed format, with zlib compression.
1105   ``-l``
1106     dump in kdump-compressed format, with lzo compression.
1107   ``-s``
1108     dump in kdump-compressed format, with snappy compression.
1109   ``-R``
1110     when using kdump (-z, -l, -s), use raw rather than makedumpfile-flattened
1111     format
1112   ``-w``
1113     dump in Windows crashdump format (can be used instead of ELF-dump converting),
1114     for Windows x64 guests with vmcoreinfo driver only
1115   *filename*
1116     dump file name.
1117   *begin*
1118     the starting physical address. It's optional, and should be
1119     specified together with *length*.
1120   *length*
1121     the memory size, in bytes. It's optional, and should be specified
1122     together with *begin*.
1123
1124 ERST
1125
1126 #if defined(TARGET_S390X)
1127     {
1128         .name       = "dump-skeys",
1129         .args_type  = "filename:F",
1130         .params     = "",
1131         .help       = "Save guest storage keys into file 'filename'.\n",
1132         .cmd        = hmp_dump_skeys,
1133     },
1134 #endif
1135
1136 SRST
1137 ``dump-skeys`` *filename*
1138   Save guest storage keys to a file.
1139 ERST
1140
1141 #if defined(TARGET_S390X)
1142     {
1143         .name       = "migration_mode",
1144         .args_type  = "mode:i",
1145         .params     = "mode",
1146         .help       = "Enables or disables migration mode\n",
1147         .cmd        = hmp_migrationmode,
1148     },
1149 #endif
1150
1151 SRST
1152 ``migration_mode`` *mode*
1153   Enables or disables migration mode.
1154 ERST
1155
1156     {
1157         .name       = "snapshot_blkdev",
1158         .args_type  = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1159         .params     = "[-n] device [new-image-file] [format]",
1160         .help       = "initiates a live snapshot\n\t\t\t"
1161                       "of device. If a new image file is specified, the\n\t\t\t"
1162                       "new image file will become the new root image.\n\t\t\t"
1163                       "If format is specified, the snapshot file will\n\t\t\t"
1164                       "be created in that format.\n\t\t\t"
1165                       "The default format is qcow2.  The -n flag requests QEMU\n\t\t\t"
1166                       "to reuse the image found in new-image-file, instead of\n\t\t\t"
1167                       "recreating it from scratch.",
1168         .cmd        = hmp_snapshot_blkdev,
1169     },
1170
1171 SRST
1172 ``snapshot_blkdev``
1173   Snapshot device, using snapshot file as target if provided
1174 ERST
1175
1176     {
1177         .name       = "snapshot_blkdev_internal",
1178         .args_type  = "device:B,name:s",
1179         .params     = "device name",
1180         .help       = "take an internal snapshot of device.\n\t\t\t"
1181                       "The format of the image used by device must\n\t\t\t"
1182                       "support it, such as qcow2.\n\t\t\t",
1183         .cmd        = hmp_snapshot_blkdev_internal,
1184     },
1185
1186 SRST
1187 ``snapshot_blkdev_internal``
1188   Take an internal snapshot on device if it support
1189 ERST
1190
1191     {
1192         .name       = "snapshot_delete_blkdev_internal",
1193         .args_type  = "device:B,name:s,id:s?",
1194         .params     = "device name [id]",
1195         .help       = "delete an internal snapshot of device.\n\t\t\t"
1196                       "If id is specified, qemu will try delete\n\t\t\t"
1197                       "the snapshot matching both id and name.\n\t\t\t"
1198                       "The format of the image used by device must\n\t\t\t"
1199                       "support it, such as qcow2.\n\t\t\t",
1200         .cmd        = hmp_snapshot_delete_blkdev_internal,
1201     },
1202
1203 SRST
1204 ``snapshot_delete_blkdev_internal``
1205   Delete an internal snapshot on device if it support
1206 ERST
1207
1208     {
1209         .name       = "drive_mirror",
1210         .args_type  = "reuse:-n,full:-f,device:B,target:s,format:s?",
1211         .params     = "[-n] [-f] device target [format]",
1212         .help       = "initiates live storage\n\t\t\t"
1213                       "migration for a device. The device's contents are\n\t\t\t"
1214                       "copied to the new image file, including data that\n\t\t\t"
1215                       "is written after the command is started.\n\t\t\t"
1216                       "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1217                       "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1218                       "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1219                       "so that the result does not need a backing file.\n\t\t\t",
1220         .cmd        = hmp_drive_mirror,
1221     },
1222 SRST
1223 ``drive_mirror``
1224   Start mirroring a block device's writes to a new destination,
1225   using the specified target.
1226 ERST
1227
1228     {
1229         .name       = "drive_backup",
1230         .args_type  = "reuse:-n,full:-f,compress:-c,device:B,target:s,format:s?",
1231         .params     = "[-n] [-f] [-c] device target [format]",
1232         .help       = "initiates a point-in-time\n\t\t\t"
1233                       "copy for a device. The device's contents are\n\t\t\t"
1234                       "copied to the new image file, excluding data that\n\t\t\t"
1235                       "is written after the command is started.\n\t\t\t"
1236                       "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1237                       "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1238                       "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1239                       "so that the result does not need a backing file.\n\t\t\t"
1240                       "The -c flag requests QEMU to compress backup data\n\t\t\t"
1241                       "(if the target format supports it).\n\t\t\t",
1242         .cmd        = hmp_drive_backup,
1243     },
1244 SRST
1245 ``drive_backup``
1246   Start a point-in-time copy of a block device to a specified target.
1247 ERST
1248
1249     {
1250         .name       = "drive_add",
1251         .args_type  = "node:-n,pci_addr:s,opts:s",
1252         .params     = "[-n] [[<domain>:]<bus>:]<slot>\n"
1253                       "[file=file][,if=type][,bus=n]\n"
1254                       "[,unit=m][,media=d][,index=i]\n"
1255                       "[,snapshot=on|off][,cache=on|off]\n"
1256                       "[,readonly=on|off][,copy-on-read=on|off]",
1257         .help       = "add drive to PCI storage controller",
1258         .cmd        = hmp_drive_add,
1259     },
1260
1261 SRST
1262 ``drive_add``
1263   Add drive to PCI storage controller.
1264 ERST
1265
1266     {
1267         .name       = "pcie_aer_inject_error",
1268         .args_type  = "advisory_non_fatal:-a,correctable:-c,"
1269                       "id:s,error_status:s,"
1270                       "header0:i?,header1:i?,header2:i?,header3:i?,"
1271                       "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1272         .params     = "[-a] [-c] id "
1273                       "<error_status> [<tlp header> [<tlp header prefix>]]",
1274         .help       = "inject pcie aer error\n\t\t\t"
1275                       " -a for advisory non fatal error\n\t\t\t"
1276                       " -c for correctable error\n\t\t\t"
1277                       "<id> = qdev device id\n\t\t\t"
1278                       "<error_status> = error string or 32bit\n\t\t\t"
1279                       "<tlp header> = 32bit x 4\n\t\t\t"
1280                       "<tlp header prefix> = 32bit x 4",
1281         .cmd        = hmp_pcie_aer_inject_error,
1282     },
1283
1284 SRST
1285 ``pcie_aer_inject_error``
1286   Inject PCIe AER error
1287 ERST
1288
1289     {
1290         .name       = "netdev_add",
1291         .args_type  = "netdev:O",
1292         .params     = "[user|tap|socket|stream|dgram|vde|bridge|hubport|netmap|vhost-user"
1293 #ifdef CONFIG_AF_XDP
1294                       "|af-xdp"
1295 #endif
1296 #ifdef CONFIG_VMNET
1297                       "|vmnet-host|vmnet-shared|vmnet-bridged"
1298 #endif
1299                       "],id=str[,prop=value][,...]",
1300         .help       = "add host network device",
1301         .cmd        = hmp_netdev_add,
1302         .command_completion = netdev_add_completion,
1303         .flags      = "p",
1304     },
1305
1306 SRST
1307 ``netdev_add``
1308   Add host network device.
1309 ERST
1310
1311     {
1312         .name       = "netdev_del",
1313         .args_type  = "id:s",
1314         .params     = "id",
1315         .help       = "remove host network device",
1316         .cmd        = hmp_netdev_del,
1317         .command_completion = netdev_del_completion,
1318         .flags      = "p",
1319     },
1320
1321 SRST
1322 ``netdev_del``
1323   Remove host network device.
1324 ERST
1325
1326     {
1327         .name       = "object_add",
1328         .args_type  = "object:S",
1329         .params     = "[qom-type=]type,id=str[,prop=value][,...]",
1330         .help       = "create QOM object",
1331         .cmd        = hmp_object_add,
1332         .command_completion = object_add_completion,
1333         .flags      = "p",
1334     },
1335
1336 SRST
1337 ``object_add``
1338   Create QOM object.
1339 ERST
1340
1341     {
1342         .name       = "object_del",
1343         .args_type  = "id:s",
1344         .params     = "id",
1345         .help       = "destroy QOM object",
1346         .cmd        = hmp_object_del,
1347         .command_completion = object_del_completion,
1348         .flags      = "p",
1349     },
1350
1351 SRST
1352 ``object_del``
1353   Destroy QOM object.
1354 ERST
1355
1356 #ifdef CONFIG_SLIRP
1357     {
1358         .name       = "hostfwd_add",
1359         .args_type  = "arg1:s,arg2:s?",
1360         .params     = "[netdev_id] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1361         .help       = "redirect TCP or UDP connections from host to guest (requires -net user)",
1362         .cmd        = hmp_hostfwd_add,
1363     },
1364 #endif
1365 SRST
1366 ``hostfwd_add``
1367   Redirect TCP or UDP connections from host to guest (requires -net user).
1368 ERST
1369
1370 #ifdef CONFIG_SLIRP
1371     {
1372         .name       = "hostfwd_remove",
1373         .args_type  = "arg1:s,arg2:s?",
1374         .params     = "[netdev_id] [tcp|udp]:[hostaddr]:hostport",
1375         .help       = "remove host-to-guest TCP or UDP redirection",
1376         .cmd        = hmp_hostfwd_remove,
1377     },
1378
1379 #endif
1380 SRST
1381 ``hostfwd_remove``
1382   Remove host-to-guest TCP or UDP redirection.
1383 ERST
1384
1385     {
1386         .name       = "balloon",
1387         .args_type  = "value:M",
1388         .params     = "target",
1389         .help       = "request VM to change its memory allocation (in MB)",
1390         .cmd        = hmp_balloon,
1391     },
1392
1393 SRST
1394 ``balloon`` *value*
1395   Request VM to change its memory allocation to *value* (in MB).
1396 ERST
1397
1398     {
1399         .name       = "set_link",
1400         .args_type  = "name:s,up:b",
1401         .params     = "name on|off",
1402         .help       = "change the link status of a network adapter",
1403         .cmd        = hmp_set_link,
1404         .command_completion = set_link_completion,
1405     },
1406
1407 SRST
1408 ``set_link`` *name* ``[on|off]``
1409   Switch link *name* on (i.e. up) or off (i.e. down).
1410 ERST
1411
1412     {
1413         .name       = "watchdog_action",
1414         .args_type  = "action:s",
1415         .params     = "[reset|shutdown|poweroff|pause|debug|none|inject-nmi]",
1416         .help       = "change watchdog action",
1417         .cmd        = hmp_watchdog_action,
1418         .command_completion = watchdog_action_completion,
1419     },
1420
1421 SRST
1422 ``watchdog_action``
1423   Change watchdog action.
1424 ERST
1425
1426     {
1427         .name       = "nbd_server_start",
1428         .args_type  = "all:-a,writable:-w,uri:s",
1429         .params     = "nbd_server_start [-a] [-w] host:port",
1430         .help       = "serve block devices on the given host and port",
1431         .cmd        = hmp_nbd_server_start,
1432         .flags      = "p",
1433     },
1434 SRST
1435 ``nbd_server_start`` *host*:*port*
1436   Start an NBD server on the given host and/or port.  If the ``-a``
1437   option is included, all of the virtual machine's block devices that
1438   have an inserted media on them are automatically exported; in this case,
1439   the ``-w`` option makes the devices writable too.
1440 ERST
1441
1442     {
1443         .name       = "nbd_server_add",
1444         .args_type  = "writable:-w,device:B,name:s?",
1445         .params     = "nbd_server_add [-w] device [name]",
1446         .help       = "export a block device via NBD",
1447         .cmd        = hmp_nbd_server_add,
1448         .flags      = "p",
1449     },
1450 SRST
1451 ``nbd_server_add`` *device* [ *name* ]
1452   Export a block device through QEMU's NBD server, which must be started
1453   beforehand with ``nbd_server_start``.  The ``-w`` option makes the
1454   exported device writable too.  The export name is controlled by *name*,
1455   defaulting to *device*.
1456 ERST
1457
1458     {
1459         .name       = "nbd_server_remove",
1460         .args_type  = "force:-f,name:s",
1461         .params     = "nbd_server_remove [-f] name",
1462         .help       = "remove an export previously exposed via NBD",
1463         .cmd        = hmp_nbd_server_remove,
1464         .flags      = "p",
1465     },
1466 SRST
1467 ``nbd_server_remove [-f]`` *name*
1468   Stop exporting a block device through QEMU's NBD server, which was
1469   previously started with ``nbd_server_add``.  The ``-f``
1470   option forces the server to drop the export immediately even if
1471   clients are connected; otherwise the command fails unless there are no
1472   clients.
1473 ERST
1474
1475     {
1476         .name       = "nbd_server_stop",
1477         .args_type  = "",
1478         .params     = "nbd_server_stop",
1479         .help       = "stop serving block devices using the NBD protocol",
1480         .cmd        = hmp_nbd_server_stop,
1481         .flags      = "p",
1482     },
1483 SRST
1484 ``nbd_server_stop``
1485   Stop the QEMU embedded NBD server.
1486 ERST
1487
1488
1489 #if defined(TARGET_I386)
1490
1491     {
1492         .name       = "mce",
1493         .args_type  = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1494         .params     = "[-b] cpu bank status mcgstatus addr misc",
1495         .help       = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1496         .cmd        = hmp_mce,
1497     },
1498
1499 #endif
1500 SRST
1501 ``mce`` *cpu* *bank* *status* *mcgstatus* *addr* *misc*
1502   Inject an MCE on the given CPU (x86 only).
1503 ERST
1504
1505 #ifdef CONFIG_POSIX
1506     {
1507         .name       = "getfd",
1508         .args_type  = "fdname:s",
1509         .params     = "getfd name",
1510         .help       = "receive a file descriptor via SCM rights and assign it a name",
1511         .cmd        = hmp_getfd,
1512         .flags      = "p",
1513     },
1514
1515 SRST
1516 ``getfd`` *fdname*
1517   If a file descriptor is passed alongside this command using the SCM_RIGHTS
1518   mechanism on unix sockets, it is stored using the name *fdname* for
1519   later use by other monitor commands.
1520 ERST
1521 #endif
1522
1523     {
1524         .name       = "closefd",
1525         .args_type  = "fdname:s",
1526         .params     = "closefd name",
1527         .help       = "close a file descriptor previously passed via SCM rights",
1528         .cmd        = hmp_closefd,
1529         .flags      = "p",
1530     },
1531
1532 SRST
1533 ``closefd`` *fdname*
1534   Close the file descriptor previously assigned to *fdname* using the
1535   ``getfd`` command. This is only needed if the file descriptor was never
1536   used by another monitor command.
1537 ERST
1538
1539     {
1540         .name       = "block_set_io_throttle",
1541         .args_type  = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1542         .params     = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1543         .help       = "change I/O throttle limits for a block drive",
1544         .cmd        = hmp_block_set_io_throttle,
1545         .flags      = "p",
1546     },
1547
1548 SRST
1549 ``block_set_io_throttle`` *device* *bps* *bps_rd* *bps_wr* *iops* *iops_rd* *iops_wr*
1550   Change I/O throttle limits for a block drive to
1551   *bps* *bps_rd* *bps_wr* *iops* *iops_rd* *iops_wr*.
1552   *device* can be a block device name, a qdev ID or a QOM path.
1553 ERST
1554
1555     {
1556         .name       = "set_password",
1557         .args_type  = "protocol:s,password:s,display:-ds,connected:s?",
1558         .params     = "protocol password [-d display] [action-if-connected]",
1559         .help       = "set spice/vnc password",
1560         .cmd        = hmp_set_password,
1561     },
1562
1563 SRST
1564 ``set_password [ vnc | spice ] password [ -d display ] [ action-if-connected ]``
1565   Change spice/vnc password.  *display* can be used with 'vnc' to specify
1566   which display to set the password on.  *action-if-connected* specifies
1567   what should happen in case a connection is established: *fail* makes
1568   the password change fail.  *disconnect* changes the password and
1569   disconnects the client.  *keep* changes the password and keeps the
1570   connection up.  *keep* is the default.
1571 ERST
1572
1573     {
1574         .name       = "expire_password",
1575         .args_type  = "protocol:s,time:s,display:-ds",
1576         .params     = "protocol time [-d display]",
1577         .help       = "set spice/vnc password expire-time",
1578         .cmd        = hmp_expire_password,
1579     },
1580
1581 SRST
1582 ``expire_password [ vnc | spice ] expire-time [ -d display ]``
1583   Specify when a password for spice/vnc becomes invalid.
1584   *display* behaves the same as in ``set_password``.
1585   *expire-time* accepts:
1586
1587   ``now``
1588     Invalidate password instantly.
1589   ``never``
1590     Password stays valid forever.
1591   ``+``\ *nsec*
1592     Password stays valid for *nsec* seconds starting now.
1593   *nsec*
1594     Password is invalidated at the given time.  *nsec* are the seconds
1595     passed since 1970, i.e. unix epoch.
1596
1597 ERST
1598
1599     {
1600         .name       = "chardev-add",
1601         .args_type  = "args:s",
1602         .params     = "args",
1603         .help       = "add chardev",
1604         .cmd        = hmp_chardev_add,
1605         .command_completion = chardev_add_completion,
1606     },
1607
1608 SRST
1609 ``chardev-add`` *args*
1610   chardev-add accepts the same parameters as the -chardev command line switch.
1611 ERST
1612
1613     {
1614         .name       = "chardev-change",
1615         .args_type  = "id:s,args:s",
1616         .params     = "id args",
1617         .help       = "change chardev",
1618         .cmd        = hmp_chardev_change,
1619     },
1620
1621 SRST
1622 ``chardev-change`` *args*
1623   chardev-change accepts existing chardev *id* and then the same arguments
1624   as the -chardev command line switch (except for "id").
1625 ERST
1626
1627     {
1628         .name       = "chardev-remove",
1629         .args_type  = "id:s",
1630         .params     = "id",
1631         .help       = "remove chardev",
1632         .cmd        = hmp_chardev_remove,
1633         .command_completion = chardev_remove_completion,
1634     },
1635
1636 SRST
1637 ``chardev-remove`` *id*
1638   Removes the chardev *id*.
1639 ERST
1640
1641     {
1642         .name       = "chardev-send-break",
1643         .args_type  = "id:s",
1644         .params     = "id",
1645         .help       = "send a break on chardev",
1646         .cmd        = hmp_chardev_send_break,
1647         .command_completion = chardev_remove_completion,
1648     },
1649
1650 SRST
1651 ``chardev-send-break`` *id*
1652   Send a break on the chardev *id*.
1653 ERST
1654
1655     {
1656         .name       = "qemu-io",
1657         .args_type  = "qdev:-d,device:B,command:s",
1658         .params     = "[-d] [device] \"[command]\"",
1659         .help       = "run a qemu-io command on a block device\n\t\t\t"
1660                       "-d: [device] is a device ID rather than a "
1661                       "drive ID or node name",
1662         .cmd        = hmp_qemu_io,
1663     },
1664
1665 SRST
1666 ``qemu-io`` *device* *command*
1667   Executes a qemu-io command on the given block device.
1668 ERST
1669
1670     {
1671         .name       = "qom-list",
1672         .args_type  = "path:s?",
1673         .params     = "path",
1674         .help       = "list QOM properties",
1675         .cmd        = hmp_qom_list,
1676         .flags      = "p",
1677     },
1678
1679 SRST
1680 ``qom-list`` [*path*]
1681   Print QOM properties of object at location *path*
1682 ERST
1683
1684     {
1685         .name       = "qom-get",
1686         .args_type  = "path:s,property:s",
1687         .params     = "path property",
1688         .help       = "print QOM property",
1689         .cmd        = hmp_qom_get,
1690         .flags      = "p",
1691     },
1692
1693 SRST
1694 ``qom-get`` *path* *property*
1695   Print QOM property *property* of object at location *path*
1696 ERST
1697
1698     {
1699         .name       = "qom-set",
1700         .args_type  = "json:-j,path:s,property:s,value:S",
1701         .params     = "[-j] path property value",
1702         .help       = "set QOM property.\n\t\t\t"
1703                       "-j: the value is specified in json format.",
1704         .cmd        = hmp_qom_set,
1705         .flags      = "p",
1706     },
1707
1708 SRST
1709 ``qom-set`` *path* *property* *value*
1710   Set QOM property *property* of object at location *path* to value *value*
1711 ERST
1712
1713     {
1714         .name       = "replay_break",
1715         .args_type  = "icount:l",
1716         .params     = "icount",
1717         .help       = "set breakpoint at the specified instruction count",
1718         .cmd        = hmp_replay_break,
1719     },
1720
1721 SRST
1722 ``replay_break`` *icount*
1723   Set replay breakpoint at instruction count *icount*.
1724   Execution stops when the specified instruction is reached.
1725   There can be at most one breakpoint. When breakpoint is set, any prior
1726   one is removed.  The breakpoint may be set only in replay mode and only
1727   "in the future", i.e. at instruction counts greater than the current one.
1728   The current instruction count can be observed with ``info replay``.
1729 ERST
1730
1731     {
1732         .name       = "replay_delete_break",
1733         .args_type  = "",
1734         .params     = "",
1735         .help       = "remove replay breakpoint",
1736         .cmd        = hmp_replay_delete_break,
1737     },
1738
1739 SRST
1740 ``replay_delete_break``
1741   Remove replay breakpoint which was previously set with ``replay_break``.
1742   The command is ignored when there are no replay breakpoints.
1743 ERST
1744
1745     {
1746         .name       = "replay_seek",
1747         .args_type  = "icount:l",
1748         .params     = "icount",
1749         .help       = "replay execution to the specified instruction count",
1750         .cmd        = hmp_replay_seek,
1751     },
1752
1753 SRST
1754 ``replay_seek`` *icount*
1755   Automatically proceed to the instruction count *icount*, when
1756   replaying the execution. The command automatically loads nearest
1757   snapshot and replays the execution to find the desired instruction.
1758   When there is no preceding snapshot or the execution is not replayed,
1759   then the command fails.
1760   *icount* for the reference may be observed with ``info replay`` command.
1761 ERST
1762
1763     {
1764         .name       = "calc_dirty_rate",
1765         .args_type  = "dirty_ring:-r,dirty_bitmap:-b,second:l,sample_pages_per_GB:l?",
1766         .params     = "[-r] [-b] second [sample_pages_per_GB]",
1767         .help       = "start a round of guest dirty rate measurement (using -r to"
1768                       "\n\t\t\t specify dirty ring as the method of calculation and"
1769                       "\n\t\t\t -b to specify dirty bitmap as method of calculation)",
1770         .cmd        = hmp_calc_dirty_rate,
1771     },
1772
1773 SRST
1774 ``calc_dirty_rate`` *second*
1775   Start a round of dirty rate measurement with the period specified in *second*.
1776   The result of the dirty rate measurement may be observed with ``info
1777   dirty_rate`` command.
1778 ERST
1779
1780     {
1781         .name       = "set_vcpu_dirty_limit",
1782         .args_type  = "dirty_rate:l,cpu_index:l?",
1783         .params     = "dirty_rate [cpu_index]",
1784         .help       = "set dirty page rate limit, use cpu_index to set limit"
1785                       "\n\t\t\t\t\t on a specified virtual cpu",
1786         .cmd        = hmp_set_vcpu_dirty_limit,
1787     },
1788
1789 SRST
1790 ``set_vcpu_dirty_limit``
1791   Set dirty page rate limit on virtual CPU, the information about all the
1792   virtual CPU dirty limit status can be observed with ``info vcpu_dirty_limit``
1793   command.
1794 ERST
1795
1796     {
1797         .name       = "cancel_vcpu_dirty_limit",
1798         .args_type  = "cpu_index:l?",
1799         .params     = "[cpu_index]",
1800         .help       = "cancel dirty page rate limit, use cpu_index to cancel"
1801                       "\n\t\t\t\t\t limit on a specified virtual cpu",
1802         .cmd        = hmp_cancel_vcpu_dirty_limit,
1803     },
1804
1805 SRST
1806 ``cancel_vcpu_dirty_limit``
1807   Cancel dirty page rate limit on virtual CPU, the information about all the
1808   virtual CPU dirty limit status can be observed with ``info vcpu_dirty_limit``
1809   command.
1810 ERST
1811
1812     {
1813         .name       = "info",
1814         .args_type  = "item:s?",
1815         .params     = "[subcommand]",
1816         .help       = "show various information about the system state",
1817         .cmd        = hmp_info_help,
1818         .sub_table  = hmp_info_cmds,
1819         .flags      = "p",
1820     },
1821
1822 #if defined(CONFIG_FDT)
1823     {
1824         .name       = "dumpdtb",
1825         .args_type  = "filename:F",
1826         .params     = "filename",
1827         .help       = "dump the FDT in dtb format to 'filename'",
1828         .cmd        = hmp_dumpdtb,
1829     },
1830
1831 SRST
1832 ``dumpdtb`` *filename*
1833   Dump the FDT in dtb format to *filename*.
1834 ERST
1835 #endif
1836
1837 #if defined(CONFIG_XEN_EMU)
1838     {
1839         .name       = "xen-event-inject",
1840         .args_type  = "port:i",
1841         .params     = "port",
1842         .help       = "inject event channel",
1843         .cmd        = hmp_xen_event_inject,
1844     },
1845
1846 SRST
1847 ``xen-event-inject`` *port*
1848   Notify guest via event channel on port *port*.
1849 ERST
1850
1851
1852     {
1853         .name       = "xen-event-list",
1854         .args_type  = "",
1855         .params     = "",
1856         .help       = "list event channel state",
1857         .cmd        = hmp_xen_event_list,
1858     },
1859
1860 SRST
1861 ``xen-event-list``
1862   List event channels in the guest
1863 ERST
1864 #endif