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