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