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