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,resume:-r,uri:s",
 913         .params     = "[-d] [-r] uri",
 914         .help       = "migrate to URI (using -d to not wait for completion)"
 915                       "\n\t\t\t -r to resume a paused postcopy migration",
 916         .cmd        = hmp_migrate,
 917     },
 918
 919
 920 SRST
 921 ``migrate [-d] [-r]`` *uri*
 922   Migrate the VM to *uri*.
 923
 924   ``-d``
 925     Start the migration process, but do not wait for its completion.  To
 926     query an ongoing migration process, use "info migrate".
 927   ``-r``
 928     Resume a paused postcopy migration.
 929 ERST
 930
 931     {
 932         .name       = "migrate_cancel",
 933         .args_type  = "",
 934         .params     = "",
 935         .help       = "cancel the current VM migration",
 936         .cmd        = hmp_migrate_cancel,
 937     },
 938
 939 SRST
 940 ``migrate_cancel``
 941   Cancel the current VM migration.
 942 ERST
 943
 944     {
 945         .name       = "migrate_continue",
 946         .args_type  = "state:s",
 947         .params     = "state",
 948         .help       = "Continue migration from the given paused state",
 949         .cmd        = hmp_migrate_continue,
 950     },
 951 SRST
 952 ``migrate_continue`` *state*
 953   Continue migration from the paused state *state*
 954 ERST
 955
 956     {
 957         .name       = "migrate_incoming",
 958         .args_type  = "uri:s",
 959         .params     = "uri",
 960         .help       = "Continue an incoming migration from an -incoming defer",
 961         .cmd        = hmp_migrate_incoming,
 962     },
 963
 964 SRST
 965 ``migrate_incoming`` *uri*
 966   Continue an incoming migration using the *uri* (that has the same syntax
 967   as the ``-incoming`` option).
 968 ERST
 969
 970     {
 971         .name       = "migrate_recover",
 972         .args_type  = "uri:s",
 973         .params     = "uri",
 974         .help       = "Continue a paused incoming postcopy migration",
 975         .cmd        = hmp_migrate_recover,
 976     },
 977
 978 SRST
 979 ``migrate_recover`` *uri*
 980   Continue a paused incoming postcopy migration using the *uri*.
 981 ERST
 982
 983     {
 984         .name       = "migrate_pause",
 985         .args_type  = "",
 986         .params     = "",
 987         .help       = "Pause an ongoing migration (postcopy-only)",
 988         .cmd        = hmp_migrate_pause,
 989     },
 990
 991 SRST
 992 ``migrate_pause``
 993   Pause an ongoing migration.  Currently it only supports postcopy.
 994 ERST
 995
 996     {
 997         .name       = "migrate_set_capability",
 998         .args_type  = "capability:s,state:b",
 999         .params     = "capability state",
1000         .help       = "Enable/Disable the usage of a capability for migration",
1001         .cmd        = hmp_migrate_set_capability,
1002         .command_completion = migrate_set_capability_completion,
1003     },
1004
1005 SRST
1006 ``migrate_set_capability`` *capability* *state*
1007   Enable/Disable the usage of a capability *capability* for migration.
1008 ERST
1009
1010     {
1011         .name       = "migrate_set_parameter",
1012         .args_type  = "parameter:s,value:s",
1013         .params     = "parameter value",
1014         .help       = "Set the parameter for migration",
1015         .cmd        = hmp_migrate_set_parameter,
1016         .command_completion = migrate_set_parameter_completion,
1017     },
1018
1019 SRST
1020 ``migrate_set_parameter`` *parameter* *value*
1021   Set the parameter *parameter* for migration.
1022 ERST
1023
1024     {
1025         .name       = "migrate_start_postcopy",
1026         .args_type  = "",
1027         .params     = "",
1028         .help       = "Followup to a migration command to switch the migration"
1029                       " to postcopy mode. The postcopy-ram capability must "
1030                       "be set on both source and destination before the "
1031                       "original migration command .",
1032         .cmd        = hmp_migrate_start_postcopy,
1033     },
1034
1035 SRST
1036 ``migrate_start_postcopy``
1037   Switch in-progress migration to postcopy mode. Ignored after the end of
1038   migration (or once already in postcopy).
1039 ERST
1040
1041 #ifdef CONFIG_REPLICATION
1042     {
1043         .name       = "x_colo_lost_heartbeat",
1044         .args_type  = "",
1045         .params     = "",
1046         .help       = "Tell COLO that heartbeat is lost,\n\t\t\t"
1047                       "a failover or takeover is needed.",
1048         .cmd = hmp_x_colo_lost_heartbeat,
1049     },
1050 #endif
1051
1052 SRST
1053 ``x_colo_lost_heartbeat``
1054   Tell COLO that heartbeat is lost, a failover or takeover is needed.
1055 ERST
1056
1057     {
1058         .name       = "client_migrate_info",
1059         .args_type  = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1060         .params     = "protocol hostname port tls-port cert-subject",
1061         .help       = "set migration information for remote display",
1062         .cmd        = hmp_client_migrate_info,
1063     },
1064
1065 SRST
1066 ``client_migrate_info`` *protocol* *hostname* *port* *tls-port* *cert-subject*
1067   Set migration information for remote display.  This makes the server
1068   ask the client to automatically reconnect using the new parameters
1069   once migration finished successfully.  Only implemented for SPICE.
1070 ERST
1071
1072     {
1073         .name       = "dump-guest-memory",
1074         .args_type  = "paging:-p,detach:-d,windmp:-w,zlib:-z,lzo:-l,snappy:-s,raw:-R,filename:F,begin:l?,length:l?",
1075         .params     = "[-p] [-d] [-z|-l|-s|-w] [-R] filename [begin length]",
1076         .help       = "dump guest memory into file 'filename'.\n\t\t\t"
1077                       "-p: do paging to get guest's memory mapping.\n\t\t\t"
1078                       "-d: return immediately (do not wait for completion).\n\t\t\t"
1079                       "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1080                       "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1081                       "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
1082                       "-R: when using kdump (-z, -l, -s), use raw rather than makedumpfile-flattened\n\t\t\t"
1083                       "    format\n\t\t\t"
1084                       "-w: dump in Windows crashdump format (can be used instead of ELF-dump converting),\n\t\t\t"
1085                       "    for Windows x86 and x64 guests with vmcoreinfo driver only.\n\t\t\t"
1086                       "begin: the starting physical address.\n\t\t\t"
1087                       "length: the memory size, in bytes.",
1088         .cmd        = hmp_dump_guest_memory,
1089     },
1090
1091 SRST
1092 ``dump-guest-memory [-p]`` *filename* *begin* *length*
1093   \
1094 ``dump-guest-memory [-z|-l|-s|-w]`` *filename*
1095   Dump guest memory to *protocol*. The file can be processed with crash or
1096   gdb. Without ``-z|-l|-s|-w``, the dump format is ELF.
1097
1098   ``-p``
1099     do paging to get guest's memory mapping.
1100   ``-z``
1101     dump in kdump-compressed format, with zlib compression.
1102   ``-l``
1103     dump in kdump-compressed format, with lzo compression.
1104   ``-s``
1105     dump in kdump-compressed format, with snappy compression.
1106   ``-R``
1107     when using kdump (-z, -l, -s), use raw rather than makedumpfile-flattened
1108     format
1109   ``-w``
1110     dump in Windows crashdump format (can be used instead of ELF-dump converting),
1111     for Windows x64 guests with vmcoreinfo driver only
1112   *filename*
1113     dump file name.
1114   *begin*
1115     the starting physical address. It's optional, and should be
1116     specified together with *length*.
1117   *length*
1118     the memory size, in bytes. It's optional, and should be specified
1119     together with *begin*.
1120
1121 ERST
1122
1123 #if defined(TARGET_S390X)
1124     {
1125         .name       = "dump-skeys",
1126         .args_type  = "filename:F",
1127         .params     = "",
1128         .help       = "Save guest storage keys into file 'filename'.\n",
1129         .cmd        = hmp_dump_skeys,
1130     },
1131 #endif
1132
1133 SRST
1134 ``dump-skeys`` *filename*
1135   Save guest storage keys to a file.
1136 ERST
1137
1138 #if defined(TARGET_S390X)
1139     {
1140         .name       = "migration_mode",
1141         .args_type  = "mode:i",
1142         .params     = "mode",
1143         .help       = "Enables or disables migration mode\n",
1144         .cmd        = hmp_migrationmode,
1145     },
1146 #endif
1147
1148 SRST
1149 ``migration_mode`` *mode*
1150   Enables or disables migration mode.
1151 ERST
1152
1153     {
1154         .name       = "snapshot_blkdev",
1155         .args_type  = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1156         .params     = "[-n] device [new-image-file] [format]",
1157         .help       = "initiates a live snapshot\n\t\t\t"
1158                       "of device. If a new image file is specified, the\n\t\t\t"
1159                       "new image file will become the new root image.\n\t\t\t"
1160                       "If format is specified, the snapshot file will\n\t\t\t"
1161                       "be created in that format.\n\t\t\t"
1162                       "The default format is qcow2.  The -n flag requests QEMU\n\t\t\t"
1163                       "to reuse the image found in new-image-file, instead of\n\t\t\t"
1164                       "recreating it from scratch.",
1165         .cmd        = hmp_snapshot_blkdev,
1166     },
1167
1168 SRST
1169 ``snapshot_blkdev``
1170   Snapshot device, using snapshot file as target if provided
1171 ERST
1172
1173     {
1174         .name       = "snapshot_blkdev_internal",
1175         .args_type  = "device:B,name:s",
1176         .params     = "device name",
1177         .help       = "take an internal snapshot of device.\n\t\t\t"
1178                       "The format of the image used by device must\n\t\t\t"
1179                       "support it, such as qcow2.\n\t\t\t",
1180         .cmd        = hmp_snapshot_blkdev_internal,
1181     },
1182
1183 SRST
1184 ``snapshot_blkdev_internal``
1185   Take an internal snapshot on device if it support
1186 ERST
1187
1188     {
1189         .name       = "snapshot_delete_blkdev_internal",
1190         .args_type  = "device:B,name:s,id:s?",
1191         .params     = "device name [id]",
1192         .help       = "delete an internal snapshot of device.\n\t\t\t"
1193                       "If id is specified, qemu will try delete\n\t\t\t"
1194                       "the snapshot matching both id and name.\n\t\t\t"
1195                       "The format of the image used by device must\n\t\t\t"
1196                       "support it, such as qcow2.\n\t\t\t",
1197         .cmd        = hmp_snapshot_delete_blkdev_internal,
1198     },
1199
1200 SRST
1201 ``snapshot_delete_blkdev_internal``
1202   Delete an internal snapshot on device if it support
1203 ERST
1204
1205     {
1206         .name       = "drive_mirror",
1207         .args_type  = "reuse:-n,full:-f,device:B,target:s,format:s?",
1208         .params     = "[-n] [-f] device target [format]",
1209         .help       = "initiates live storage\n\t\t\t"
1210                       "migration for a device. The device's contents are\n\t\t\t"
1211                       "copied to the new image file, including data that\n\t\t\t"
1212                       "is written after the command is started.\n\t\t\t"
1213                       "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1214                       "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1215                       "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1216                       "so that the result does not need a backing file.\n\t\t\t",
1217         .cmd        = hmp_drive_mirror,
1218     },
1219 SRST
1220 ``drive_mirror``
1221   Start mirroring a block device's writes to a new destination,
1222   using the specified target.
1223 ERST
1224
1225     {
1226         .name       = "drive_backup",
1227         .args_type  = "reuse:-n,full:-f,compress:-c,device:B,target:s,format:s?",
1228         .params     = "[-n] [-f] [-c] device target [format]",
1229         .help       = "initiates a point-in-time\n\t\t\t"
1230                       "copy for a device. The device's contents are\n\t\t\t"
1231                       "copied to the new image file, excluding data that\n\t\t\t"
1232                       "is written after the command is started.\n\t\t\t"
1233                       "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1234                       "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1235                       "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1236                       "so that the result does not need a backing file.\n\t\t\t"
1237                       "The -c flag requests QEMU to compress backup data\n\t\t\t"
1238                       "(if the target format supports it).\n\t\t\t",
1239         .cmd        = hmp_drive_backup,
1240     },
1241 SRST
1242 ``drive_backup``
1243   Start a point-in-time copy of a block device to a specified target.
1244 ERST
1245
1246     {
1247         .name       = "drive_add",
1248         .args_type  = "node:-n,pci_addr:s,opts:s",
1249         .params     = "[-n] [[<domain>:]<bus>:]<slot>\n"
1250                       "[file=file][,if=type][,bus=n]\n"
1251                       "[,unit=m][,media=d][,index=i]\n"
1252                       "[,snapshot=on|off][,cache=on|off]\n"
1253                       "[,readonly=on|off][,copy-on-read=on|off]",
1254         .help       = "add drive to PCI storage controller",
1255         .cmd        = hmp_drive_add,
1256     },
1257
1258 SRST
1259 ``drive_add``
1260   Add drive to PCI storage controller.
1261 ERST
1262
1263     {
1264         .name       = "pcie_aer_inject_error",
1265         .args_type  = "advisory_non_fatal:-a,correctable:-c,"
1266                       "id:s,error_status:s,"
1267                       "header0:i?,header1:i?,header2:i?,header3:i?,"
1268                       "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1269         .params     = "[-a] [-c] id "
1270                       "<error_status> [<tlp header> [<tlp header prefix>]]",
1271         .help       = "inject pcie aer error\n\t\t\t"
1272                       " -a for advisory non fatal error\n\t\t\t"
1273                       " -c for correctable error\n\t\t\t"
1274                       "<id> = qdev device id\n\t\t\t"
1275                       "<error_status> = error string or 32bit\n\t\t\t"
1276                       "<tlp header> = 32bit x 4\n\t\t\t"
1277                       "<tlp header prefix> = 32bit x 4",
1278         .cmd        = hmp_pcie_aer_inject_error,
1279     },
1280
1281 SRST
1282 ``pcie_aer_inject_error``
1283   Inject PCIe AER error
1284 ERST
1285
1286     {
1287         .name       = "netdev_add",
1288         .args_type  = "netdev:O",
1289         .params     = "[user|tap|socket|stream|dgram|vde|bridge|hubport|netmap|vhost-user"
1290 #ifdef CONFIG_AF_XDP
1291                       "|af-xdp"
1292 #endif
1293 #ifdef CONFIG_VMNET
1294                       "|vmnet-host|vmnet-shared|vmnet-bridged"
1295 #endif
1296                       "],id=str[,prop=value][,...]",
1297         .help       = "add host network device",
1298         .cmd        = hmp_netdev_add,
1299         .command_completion = netdev_add_completion,
1300         .flags      = "p",
1301     },
1302
1303 SRST
1304 ``netdev_add``
1305   Add host network device.
1306 ERST
1307
1308     {
1309         .name       = "netdev_del",
1310         .args_type  = "id:s",
1311         .params     = "id",
1312         .help       = "remove host network device",
1313         .cmd        = hmp_netdev_del,
1314         .command_completion = netdev_del_completion,
1315         .flags      = "p",
1316     },
1317
1318 SRST
1319 ``netdev_del``
1320   Remove host network device.
1321 ERST
1322
1323     {
1324         .name       = "object_add",
1325         .args_type  = "object:S",
1326         .params     = "[qom-type=]type,id=str[,prop=value][,...]",
1327         .help       = "create QOM object",
1328         .cmd        = hmp_object_add,
1329         .command_completion = object_add_completion,
1330         .flags      = "p",
1331     },
1332
1333 SRST
1334 ``object_add``
1335   Create QOM object.
1336 ERST
1337
1338     {
1339         .name       = "object_del",
1340         .args_type  = "id:s",
1341         .params     = "id",
1342         .help       = "destroy QOM object",
1343         .cmd        = hmp_object_del,
1344         .command_completion = object_del_completion,
1345         .flags      = "p",
1346     },
1347
1348 SRST
1349 ``object_del``
1350   Destroy QOM object.
1351 ERST
1352
1353 #ifdef CONFIG_SLIRP
1354     {
1355         .name       = "hostfwd_add",
1356         .args_type  = "arg1:s,arg2:s?",
1357         .params     = "[netdev_id] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1358         .help       = "redirect TCP or UDP connections from host to guest (requires -net user)",
1359         .cmd        = hmp_hostfwd_add,
1360     },
1361 #endif
1362 SRST
1363 ``hostfwd_add``
1364   Redirect TCP or UDP connections from host to guest (requires -net user).
1365 ERST
1366
1367 #ifdef CONFIG_SLIRP
1368     {
1369         .name       = "hostfwd_remove",
1370         .args_type  = "arg1:s,arg2:s?",
1371         .params     = "[netdev_id] [tcp|udp]:[hostaddr]:hostport",
1372         .help       = "remove host-to-guest TCP or UDP redirection",
1373         .cmd        = hmp_hostfwd_remove,
1374     },
1375
1376 #endif
1377 SRST
1378 ``hostfwd_remove``
1379   Remove host-to-guest TCP or UDP redirection.
1380 ERST
1381
1382     {
1383         .name       = "balloon",
1384         .args_type  = "value:M",
1385         .params     = "target",
1386         .help       = "request VM to change its memory allocation (in MB)",
1387         .cmd        = hmp_balloon,
1388     },
1389
1390 SRST
1391 ``balloon`` *value*
1392   Request VM to change its memory allocation to *value* (in MB).
1393 ERST
1394
1395     {
1396         .name       = "set_link",
1397         .args_type  = "name:s,up:b",
1398         .params     = "name on|off",
1399         .help       = "change the link status of a network adapter",
1400         .cmd        = hmp_set_link,
1401         .command_completion = set_link_completion,
1402     },
1403
1404 SRST
1405 ``set_link`` *name* ``[on|off]``
1406   Switch link *name* on (i.e. up) or off (i.e. down).
1407 ERST
1408
1409     {
1410         .name       = "watchdog_action",
1411         .args_type  = "action:s",
1412         .params     = "[reset|shutdown|poweroff|pause|debug|none|inject-nmi]",
1413         .help       = "change watchdog action",
1414         .cmd        = hmp_watchdog_action,
1415         .command_completion = watchdog_action_completion,
1416     },
1417
1418 SRST
1419 ``watchdog_action``
1420   Change watchdog action.
1421 ERST
1422
1423     {
1424         .name       = "nbd_server_start",
1425         .args_type  = "all:-a,writable:-w,uri:s",
1426         .params     = "nbd_server_start [-a] [-w] host:port",
1427         .help       = "serve block devices on the given host and port",
1428         .cmd        = hmp_nbd_server_start,
1429         .flags      = "p",
1430     },
1431 SRST
1432 ``nbd_server_start`` *host*:*port*
1433   Start an NBD server on the given host and/or port.  If the ``-a``
1434   option is included, all of the virtual machine's block devices that
1435   have an inserted media on them are automatically exported; in this case,
1436   the ``-w`` option makes the devices writable too.
1437 ERST
1438
1439     {
1440         .name       = "nbd_server_add",
1441         .args_type  = "writable:-w,device:B,name:s?",
1442         .params     = "nbd_server_add [-w] device [name]",
1443         .help       = "export a block device via NBD",
1444         .cmd        = hmp_nbd_server_add,
1445         .flags      = "p",
1446     },
1447 SRST
1448 ``nbd_server_add`` *device* [ *name* ]
1449   Export a block device through QEMU's NBD server, which must be started
1450   beforehand with ``nbd_server_start``.  The ``-w`` option makes the
1451   exported device writable too.  The export name is controlled by *name*,
1452   defaulting to *device*.
1453 ERST
1454
1455     {
1456         .name       = "nbd_server_remove",
1457         .args_type  = "force:-f,name:s",
1458         .params     = "nbd_server_remove [-f] name",
1459         .help       = "remove an export previously exposed via NBD",
1460         .cmd        = hmp_nbd_server_remove,
1461         .flags      = "p",
1462     },
1463 SRST
1464 ``nbd_server_remove [-f]`` *name*
1465   Stop exporting a block device through QEMU's NBD server, which was
1466   previously started with ``nbd_server_add``.  The ``-f``
1467   option forces the server to drop the export immediately even if
1468   clients are connected; otherwise the command fails unless there are no
1469   clients.
1470 ERST
1471
1472     {
1473         .name       = "nbd_server_stop",
1474         .args_type  = "",
1475         .params     = "nbd_server_stop",
1476         .help       = "stop serving block devices using the NBD protocol",
1477         .cmd        = hmp_nbd_server_stop,
1478         .flags      = "p",
1479     },
1480 SRST
1481 ``nbd_server_stop``
1482   Stop the QEMU embedded NBD server.
1483 ERST
1484
1485
1486 #if defined(TARGET_I386)
1487
1488     {
1489         .name       = "mce",
1490         .args_type  = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1491         .params     = "[-b] cpu bank status mcgstatus addr misc",
1492         .help       = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1493         .cmd        = hmp_mce,
1494     },
1495
1496 #endif
1497 SRST
1498 ``mce`` *cpu* *bank* *status* *mcgstatus* *addr* *misc*
1499   Inject an MCE on the given CPU (x86 only).
1500 ERST
1501
1502 #ifdef CONFIG_POSIX
1503     {
1504         .name       = "getfd",
1505         .args_type  = "fdname:s",
1506         .params     = "getfd name",
1507         .help       = "receive a file descriptor via SCM rights and assign it a name",
1508         .cmd        = hmp_getfd,
1509         .flags      = "p",
1510     },
1511
1512 SRST
1513 ``getfd`` *fdname*
1514   If a file descriptor is passed alongside this command using the SCM_RIGHTS
1515   mechanism on unix sockets, it is stored using the name *fdname* for
1516   later use by other monitor commands.
1517 ERST
1518 #endif
1519
1520     {
1521         .name       = "closefd",
1522         .args_type  = "fdname:s",
1523         .params     = "closefd name",
1524         .help       = "close a file descriptor previously passed via SCM rights",
1525         .cmd        = hmp_closefd,
1526         .flags      = "p",
1527     },
1528
1529 SRST
1530 ``closefd`` *fdname*
1531   Close the file descriptor previously assigned to *fdname* using the
1532   ``getfd`` command. This is only needed if the file descriptor was never
1533   used by another monitor command.
1534 ERST
1535
1536     {
1537         .name       = "block_set_io_throttle",
1538         .args_type  = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1539         .params     = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1540         .help       = "change I/O throttle limits for a block drive",
1541         .cmd        = hmp_block_set_io_throttle,
1542         .flags      = "p",
1543     },
1544
1545 SRST
1546 ``block_set_io_throttle`` *device* *bps* *bps_rd* *bps_wr* *iops* *iops_rd* *iops_wr*
1547   Change I/O throttle limits for a block drive to
1548   *bps* *bps_rd* *bps_wr* *iops* *iops_rd* *iops_wr*.
1549   *device* can be a block device name, a qdev ID or a QOM path.
1550 ERST
1551
1552     {
1553         .name       = "set_password",
1554         .args_type  = "protocol:s,password:s,display:-ds,connected:s?",
1555         .params     = "protocol password [-d display] [action-if-connected]",
1556         .help       = "set spice/vnc password",
1557         .cmd        = hmp_set_password,
1558     },
1559
1560 SRST
1561 ``set_password [ vnc | spice ] password [ -d display ] [ action-if-connected ]``
1562   Change spice/vnc password.  *display* can be used with 'vnc' to specify
1563   which display to set the password on.  *action-if-connected* specifies
1564   what should happen in case a connection is established: *fail* makes
1565   the password change fail.  *disconnect* changes the password and
1566   disconnects the client.  *keep* changes the password and keeps the
1567   connection up.  *keep* is the default.
1568 ERST
1569
1570     {
1571         .name       = "expire_password",
1572         .args_type  = "protocol:s,time:s,display:-ds",
1573         .params     = "protocol time [-d display]",
1574         .help       = "set spice/vnc password expire-time",
1575         .cmd        = hmp_expire_password,
1576     },
1577
1578 SRST
1579 ``expire_password [ vnc | spice ] expire-time [ -d display ]``
1580   Specify when a password for spice/vnc becomes invalid.
1581   *display* behaves the same as in ``set_password``.
1582   *expire-time* accepts:
1583
1584   ``now``
1585     Invalidate password instantly.
1586   ``never``
1587     Password stays valid forever.
1588   ``+``\ *nsec*
1589     Password stays valid for *nsec* seconds starting now.
1590   *nsec*
1591     Password is invalidated at the given time.  *nsec* are the seconds
1592     passed since 1970, i.e. unix epoch.
1593
1594 ERST
1595
1596     {
1597         .name       = "chardev-add",
1598         .args_type  = "args:s",
1599         .params     = "args",
1600         .help       = "add chardev",
1601         .cmd        = hmp_chardev_add,
1602         .command_completion = chardev_add_completion,
1603     },
1604
1605 SRST
1606 ``chardev-add`` *args*
1607   chardev-add accepts the same parameters as the -chardev command line switch.
1608 ERST
1609
1610     {
1611         .name       = "chardev-change",
1612         .args_type  = "id:s,args:s",
1613         .params     = "id args",
1614         .help       = "change chardev",
1615         .cmd        = hmp_chardev_change,
1616     },
1617
1618 SRST
1619 ``chardev-change`` *args*
1620   chardev-change accepts existing chardev *id* and then the same arguments
1621   as the -chardev command line switch (except for "id").
1622 ERST
1623
1624     {
1625         .name       = "chardev-remove",
1626         .args_type  = "id:s",
1627         .params     = "id",
1628         .help       = "remove chardev",
1629         .cmd        = hmp_chardev_remove,
1630         .command_completion = chardev_remove_completion,
1631     },
1632
1633 SRST
1634 ``chardev-remove`` *id*
1635   Removes the chardev *id*.
1636 ERST
1637
1638     {
1639         .name       = "chardev-send-break",
1640         .args_type  = "id:s",
1641         .params     = "id",
1642         .help       = "send a break on chardev",
1643         .cmd        = hmp_chardev_send_break,
1644         .command_completion = chardev_remove_completion,
1645     },
1646
1647 SRST
1648 ``chardev-send-break`` *id*
1649   Send a break on the chardev *id*.
1650 ERST
1651
1652     {
1653         .name       = "qemu-io",
1654         .args_type  = "qdev:-d,device:B,command:s",
1655         .params     = "[-d] [device] \"[command]\"",
1656         .help       = "run a qemu-io command on a block device\n\t\t\t"
1657                       "-d: [device] is a device ID rather than a "
1658                       "drive ID or node name",
1659         .cmd        = hmp_qemu_io,
1660     },
1661
1662 SRST
1663 ``qemu-io`` *device* *command*
1664   Executes a qemu-io command on the given block device.
1665 ERST
1666
1667     {
1668         .name       = "qom-list",
1669         .args_type  = "path:s?",
1670         .params     = "path",
1671         .help       = "list QOM properties",
1672         .cmd        = hmp_qom_list,
1673         .flags      = "p",
1674     },
1675
1676 SRST
1677 ``qom-list`` [*path*]
1678   Print QOM properties of object at location *path*
1679 ERST
1680
1681     {
1682         .name       = "qom-get",
1683         .args_type  = "path:s,property:s",
1684         .params     = "path property",
1685         .help       = "print QOM property",
1686         .cmd        = hmp_qom_get,
1687         .flags      = "p",
1688     },
1689
1690 SRST
1691 ``qom-get`` *path* *property*
1692   Print QOM property *property* of object at location *path*
1693 ERST
1694
1695     {
1696         .name       = "qom-set",
1697         .args_type  = "json:-j,path:s,property:s,value:S",
1698         .params     = "[-j] path property value",
1699         .help       = "set QOM property.\n\t\t\t"
1700                       "-j: the value is specified in json format.",
1701         .cmd        = hmp_qom_set,
1702         .flags      = "p",
1703     },
1704
1705 SRST
1706 ``qom-set`` *path* *property* *value*
1707   Set QOM property *property* of object at location *path* to value *value*
1708 ERST
1709
1710     {
1711         .name       = "replay_break",
1712         .args_type  = "icount:l",
1713         .params     = "icount",
1714         .help       = "set breakpoint at the specified instruction count",
1715         .cmd        = hmp_replay_break,
1716     },
1717
1718 SRST
1719 ``replay_break`` *icount*
1720   Set replay breakpoint at instruction count *icount*.
1721   Execution stops when the specified instruction is reached.
1722   There can be at most one breakpoint. When breakpoint is set, any prior
1723   one is removed.  The breakpoint may be set only in replay mode and only
1724   "in the future", i.e. at instruction counts greater than the current one.
1725   The current instruction count can be observed with ``info replay``.
1726 ERST
1727
1728     {
1729         .name       = "replay_delete_break",
1730         .args_type  = "",
1731         .params     = "",
1732         .help       = "remove replay breakpoint",
1733         .cmd        = hmp_replay_delete_break,
1734     },
1735
1736 SRST
1737 ``replay_delete_break``
1738   Remove replay breakpoint which was previously set with ``replay_break``.
1739   The command is ignored when there are no replay breakpoints.
1740 ERST
1741
1742     {
1743         .name       = "replay_seek",
1744         .args_type  = "icount:l",
1745         .params     = "icount",
1746         .help       = "replay execution to the specified instruction count",
1747         .cmd        = hmp_replay_seek,
1748     },
1749
1750 SRST
1751 ``replay_seek`` *icount*
1752   Automatically proceed to the instruction count *icount*, when
1753   replaying the execution. The command automatically loads nearest
1754   snapshot and replays the execution to find the desired instruction.
1755   When there is no preceding snapshot or the execution is not replayed,
1756   then the command fails.
1757   *icount* for the reference may be observed with ``info replay`` command.
1758 ERST
1759
1760     {
1761         .name       = "calc_dirty_rate",
1762         .args_type  = "dirty_ring:-r,dirty_bitmap:-b,second:l,sample_pages_per_GB:l?",
1763         .params     = "[-r] [-b] second [sample_pages_per_GB]",
1764         .help       = "start a round of guest dirty rate measurement (using -r to"
1765                       "\n\t\t\t specify dirty ring as the method of calculation and"
1766                       "\n\t\t\t -b to specify dirty bitmap as method of calculation)",
1767         .cmd        = hmp_calc_dirty_rate,
1768     },
1769
1770 SRST
1771 ``calc_dirty_rate`` *second*
1772   Start a round of dirty rate measurement with the period specified in *second*.
1773   The result of the dirty rate measurement may be observed with ``info
1774   dirty_rate`` command.
1775 ERST
1776
1777     {
1778         .name       = "set_vcpu_dirty_limit",
1779         .args_type  = "dirty_rate:l,cpu_index:l?",
1780         .params     = "dirty_rate [cpu_index]",
1781         .help       = "set dirty page rate limit, use cpu_index to set limit"
1782                       "\n\t\t\t\t\t on a specified virtual cpu",
1783         .cmd        = hmp_set_vcpu_dirty_limit,
1784     },
1785
1786 SRST
1787 ``set_vcpu_dirty_limit``
1788   Set dirty page rate limit on virtual CPU, the information about all the
1789   virtual CPU dirty limit status can be observed with ``info vcpu_dirty_limit``
1790   command.
1791 ERST
1792
1793     {
1794         .name       = "cancel_vcpu_dirty_limit",
1795         .args_type  = "cpu_index:l?",
1796         .params     = "[cpu_index]",
1797         .help       = "cancel dirty page rate limit, use cpu_index to cancel"
1798                       "\n\t\t\t\t\t limit on a specified virtual cpu",
1799         .cmd        = hmp_cancel_vcpu_dirty_limit,
1800     },
1801
1802 SRST
1803 ``cancel_vcpu_dirty_limit``
1804   Cancel dirty page rate limit on virtual CPU, the information about all the
1805   virtual CPU dirty limit status can be observed with ``info vcpu_dirty_limit``
1806   command.
1807 ERST
1808
1809     {
1810         .name       = "info",
1811         .args_type  = "item:s?",
1812         .params     = "[subcommand]",
1813         .help       = "show various information about the system state",
1814         .cmd        = hmp_info_help,
1815         .sub_table  = hmp_info_cmds,
1816         .flags      = "p",
1817     },
1818
1819 #if defined(CONFIG_FDT)
1820     {
1821         .name       = "dumpdtb",
1822         .args_type  = "filename:F",
1823         .params     = "filename",
1824         .help       = "dump the FDT in dtb format to 'filename'",
1825         .cmd        = hmp_dumpdtb,
1826     },
1827
1828 SRST
1829 ``dumpdtb`` *filename*
1830   Dump the FDT in dtb format to *filename*.
1831 ERST
1832 #endif
1833
1834 #if defined(CONFIG_XEN_EMU)
1835     {
1836         .name       = "xen-event-inject",
1837         .args_type  = "port:i",
1838         .params     = "port",
1839         .help       = "inject event channel",
1840         .cmd        = hmp_xen_event_inject,
1841     },
1842
1843 SRST
1844 ``xen-event-inject`` *port*
1845   Notify guest via event channel on port *port*.
1846 ERST
1847
1848
1849     {
1850         .name       = "xen-event-list",
1851         .args_type  = "",
1852         .params     = "",
1853         .help       = "list event channel state",
1854         .cmd        = hmp_xen_event_list,
1855     },
1856
1857 SRST
1858 ``xen-event-list``
1859   List event channels in the guest
1860 ERST
1861 #endif