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