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