hmp-commands.hx

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