MAINTAINERS: Add include/hw/xtensa/mx_pic.h to the XTFPGA machine section
[qemu/ar7.git] / hmp-commands.hx
blobc0a27688b64c15da9d239446f452449482647c7e
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.
10 .name = "help|?",
11 .args_type = "name:S?",
12 .params = "[cmd]",
13 .help = "show the help",
14 .cmd = hmp_help,
15 .flags = "p",
18 SRST
19 ``help`` or ``?`` [*cmd*]
20 Show the help for all commands or just for command *cmd*.
21 ERST
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,
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
43 .name = "quit|q",
44 .args_type = "",
45 .params = "",
46 .help = "quit the emulator",
47 .cmd = hmp_quit,
48 .flags = "p",
51 SRST
52 ``quit`` or ``q``
53 Quit the emulator.
54 ERST
57 .name = "exit_preconfig",
58 .args_type = "",
59 .params = "",
60 .help = "exit the preconfig state",
61 .cmd = hmp_exit_preconfig,
62 .flags = "p",
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
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",
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
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",
101 SRST
102 ``block_stream``
103 Copy data from a backing file into a block device.
104 ERST
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",
115 SRST
116 ``block_job_set_speed``
117 Set maximum speed for a background block operation.
118 ERST
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",
131 SRST
132 ``block_job_cancel``
133 Stop an active background block operation (streaming, mirroring).
134 ERST
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",
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
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",
160 SRST
161 ``block_job_pause``
162 Pause an active block streaming operation.
163 ERST
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",
174 SRST
175 ``block_job_resume``
176 Resume a paused block streaming operation.
177 ERST
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,
187 SRST
188 ``eject [-f]`` *device*
189 Eject a removable medium (use -f to force it).
190 ERST
193 .name = "drive_del",
194 .args_type = "id:B",
195 .params = "device",
196 .help = "remove host block device",
197 .cmd = hmp_drive_del,
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
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,
218 SRST
219 ``change`` *device* *setting*
220 Change the configuration of a device.
222 ``change`` *diskdevice* [-f] *filename* [*format* [*read-only-mode*]]
223 Change the medium for a removable disk device to point to *filename*. eg::
225 (qemu) change ide1-cd0 /path/to/some.iso
227 ``-f``
228 forces the operation even if the guest has locked the tray.
230 *format* is optional.
232 *read-only-mode* may be used to change the read-only status of the device.
233 It accepts the following values:
235 retain
236 Retains the current status; this is the default.
238 read-only
239 Makes the device read-only.
241 read-write
242 Makes the device writable.
244 ``change vnc password`` [*password*]
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::
250 (qemu) change vnc password
251 Password: ********
253 ERST
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,
266 SRST
267 ``screendump`` *filename*
268 Save screen into PPM image *filename*.
269 ERST
272 .name = "logfile",
273 .args_type = "filename:F",
274 .params = "filename",
275 .help = "output logs to 'filename'",
276 .cmd = hmp_logfile,
279 SRST
280 ``logfile`` *filename*
281 Output logs to *filename*.
282 ERST
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,
294 SRST
295 ``trace-event``
296 changes status of a trace event
297 ERST
299 #if defined(CONFIG_TRACE_SIMPLE)
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,
308 SRST
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.
312 ERST
313 #endif
316 .name = "log",
317 .args_type = "items:s",
318 .params = "item1[,...]",
319 .help = "activate logging of the specified items",
320 .cmd = hmp_log,
323 SRST
324 ``log`` *item1*\ [,...]
325 Activate logging of the specified items.
326 ERST
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,
336 SRST
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`.
343 Since 4.0, savevm stopped allowing the snapshot id to be set, accepting
344 only *tag* as parameter.
345 ERST
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,
356 SRST
357 ``loadvm`` *tag*
358 Set the whole virtual machine to the snapshot identified by the tag
359 *tag*.
361 Since 4.0, loadvm stopped accepting snapshot id as parameter.
362 ERST
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,
373 SRST
374 ``delvm`` *tag*
375 Delete the snapshot identified by *tag*.
377 Since 4.0, delvm stopped deleting snapshots by snapshot id, accepting
378 only *tag* as parameter.
379 ERST
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,
389 SRST
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.
396 If called with option off, the emulation returns to normal mode.
397 ERST
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,
407 SRST
408 ``singlestep [off]``
409 This is a deprecated synonym for the one-insn-per-tb command.
410 ERST
413 .name = "stop|s",
414 .args_type = "",
415 .params = "",
416 .help = "stop emulation",
417 .cmd = hmp_stop,
420 SRST
421 ``stop`` or ``s``
422 Stop emulation.
423 ERST
426 .name = "cont|c",
427 .args_type = "",
428 .params = "",
429 .help = "resume emulation",
430 .cmd = hmp_cont,
433 SRST
434 ``cont`` or ``c``
435 Resume emulation.
436 ERST
439 .name = "system_wakeup",
440 .args_type = "",
441 .params = "",
442 .help = "wakeup guest from suspend",
443 .cmd = hmp_system_wakeup,
446 SRST
447 ``system_wakeup``
448 Wakeup guest from suspend.
449 ERST
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,
459 SRST
460 ``gdbserver`` [*port*]
461 Start gdbserver session (default *port*\=1234)
462 ERST
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,
472 SRST
473 ``x/``\ *fmt* *addr*
474 Virtual memory dump starting at *addr*.
475 ERST
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,
485 SRST
486 ``xp /``\ *fmt* *addr*
487 Physical memory dump starting at *addr*.
489 *fmt* is a format which tells the command how to format the
490 data. Its syntax is: ``/{count}{format}{size}``
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.
502 Examples:
504 Dump 10 instructions at the current instruction pointer::
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
518 Dump 80 16 bit values at the start of the video memory::
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
532 ERST
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,
542 SRST
543 ``gpa2hva`` *addr*
544 Print the host virtual address at which the guest's physical address *addr*
545 is mapped.
546 ERST
548 #ifdef CONFIG_LINUX
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,
556 #endif
558 SRST
559 ``gpa2hpa`` *addr*
560 Print the host physical address at which the guest's physical address *addr*
561 is mapped.
562 ERST
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,
572 SRST
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.
576 ERST
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,
586 SRST
587 ``print`` or ``p/``\ *fmt* *expr*
588 Print expression value. Only the *format* part of *fmt* is
589 used.
590 ERST
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,
600 SRST
601 ``i/``\ *fmt* *addr* [.\ *index*\ ]
602 Read I/O port.
603 ERST
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,
613 SRST
614 ``o/``\ *fmt* *addr* *val*
615 Write to I/O port.
616 ERST
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,
627 SRST
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::
633 sendkey ctrl-alt-f1
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.
637 ERST
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,
647 SRST
648 ``sync-profile [on|off|reset]``
649 Enable, disable or reset synchronization profiling. With no arguments, prints
650 whether profiling is on or off.
651 ERST
654 .name = "system_reset",
655 .args_type = "",
656 .params = "",
657 .help = "reset the system",
658 .cmd = hmp_system_reset,
661 SRST
662 ``system_reset``
663 Reset the system.
664 ERST
667 .name = "system_powerdown",
668 .args_type = "",
669 .params = "",
670 .help = "send system power down event",
671 .cmd = hmp_system_powerdown,
674 SRST
675 ``system_powerdown``
676 Power down the system (if supported).
677 ERST
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,
687 SRST
688 ``sum`` *addr* *size*
689 Compute the checksum of a memory region.
690 ERST
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,
701 SRST
702 ``device_add`` *config*
703 Add device.
704 ERST
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,
715 SRST
716 ``device_del`` *id*
717 Remove device *id*. *id* may be a short ID
718 or a QOM object path.
719 ERST
722 .name = "cpu",
723 .args_type = "index:i",
724 .params = "index",
725 .help = "set the default CPU",
726 .cmd = hmp_cpu,
729 SRST
730 ``cpu`` *index*
731 Set the default CPU.
732 ERST
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,
742 SRST
743 ``mouse_move`` *dx* *dy* [*dz*]
744 Move the active mouse to the specified coordinates *dx* *dy*
745 with optional scroll axis *dz*.
746 ERST
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,
756 SRST
757 ``mouse_button`` *val*
758 Change the active mouse button state *val* (1=L, 2=M, 4=R).
759 ERST
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,
769 SRST
770 ``mouse_set`` *index*
771 Set which mouse device receives events at given *index*, index
772 can be obtained with::
774 info mice
776 ERST
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,
785 SRST
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*.
791 Defaults:
793 - Sample rate = 44100 Hz - CD quality
794 - Bits = 16
795 - Number of channels = 2 - Stereo
796 ERST
799 .name = "stopcapture",
800 .args_type = "n:i",
801 .params = "capture index",
802 .help = "stop capture",
803 .cmd = hmp_stopcapture,
805 SRST
806 ``stopcapture`` *index*
807 Stop capture with a given *index*, index can be obtained with::
809 info capture
811 ERST
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,
821 SRST
822 ``memsave`` *addr* *size* *file*
823 save to disk virtual memory dump starting at *addr* of size *size*.
824 ERST
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,
834 SRST
835 ``pmemsave`` *addr* *size* *file*
836 save to disk physical memory dump starting at *addr* of size *size*.
837 ERST
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,
847 SRST
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.
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.
854 ERST
857 .name = "nmi",
858 .args_type = "",
859 .params = "",
860 .help = "inject an NMI",
861 .cmd = hmp_nmi,
863 SRST
864 ``nmi`` *cpu*
865 Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
866 ERST
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,
877 SRST
878 ``ringbuf_write`` *device* *data*
879 Write *data* to ring buffer character device *device*.
880 *data* must be a UTF-8 string.
881 ERST
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,
892 SRST
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.
901 ERST
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,
911 SRST
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.
919 ERST
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,
935 SRST
936 ``migrate [-d] [-b] [-i]`` *uri*
937 Migrate to *uri* (using -d to not wait for completion).
939 ``-b``
940 for migration with full copy of disk
941 ``-i``
942 for migration with incremental copy of disk (base image is shared)
943 ERST
946 .name = "migrate_cancel",
947 .args_type = "",
948 .params = "",
949 .help = "cancel the current VM migration",
950 .cmd = hmp_migrate_cancel,
953 SRST
954 ``migrate_cancel``
955 Cancel the current VM migration.
956 ERST
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,
965 SRST
966 ``migrate_continue`` *state*
967 Continue migration from the paused state *state*
968 ERST
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,
978 SRST
979 ``migrate_incoming`` *uri*
980 Continue an incoming migration using the *uri* (that has the same syntax
981 as the ``-incoming`` option).
982 ERST
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,
992 SRST
993 ``migrate_recover`` *uri*
994 Continue a paused incoming postcopy migration using the *uri*.
995 ERST
998 .name = "migrate_pause",
999 .args_type = "",
1000 .params = "",
1001 .help = "Pause an ongoing migration (postcopy-only)",
1002 .cmd = hmp_migrate_pause,
1005 SRST
1006 ``migrate_pause``
1007 Pause an ongoing migration. Currently it only supports postcopy.
1008 ERST
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,
1019 SRST
1020 ``migrate_set_capability`` *capability* *state*
1021 Enable/Disable the usage of a capability *capability* for migration.
1022 ERST
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,
1033 SRST
1034 ``migrate_set_parameter`` *parameter* *value*
1035 Set the parameter *parameter* for migration.
1036 ERST
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,
1049 SRST
1050 ``migrate_start_postcopy``
1051 Switch in-progress migration to postcopy mode. Ignored after the end of
1052 migration (or once already in postcopy).
1053 ERST
1055 #ifdef CONFIG_REPLICATION
1057 .name = "x_colo_lost_heartbeat",
1058 .args_type = "",
1059 .params = "",
1060 .help = "Tell COLO that heartbeat is lost,\n\t\t\t"
1061 "a failover or takeover is needed.",
1062 .cmd = hmp_x_colo_lost_heartbeat,
1064 #endif
1066 SRST
1067 ``x_colo_lost_heartbeat``
1068 Tell COLO that heartbeat is lost, a failover or takeover is needed.
1069 ERST
1072 .name = "client_migrate_info",
1073 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1074 .params = "protocol hostname port tls-port cert-subject",
1075 .help = "set migration information for remote display",
1076 .cmd = hmp_client_migrate_info,
1079 SRST
1080 ``client_migrate_info`` *protocol* *hostname* *port* *tls-port* *cert-subject*
1081 Set migration information for remote display. This makes the server
1082 ask the client to automatically reconnect using the new parameters
1083 once migration finished successfully. Only implemented for SPICE.
1084 ERST
1087 .name = "dump-guest-memory",
1088 .args_type = "paging:-p,detach:-d,windmp:-w,zlib:-z,lzo:-l,snappy:-s,raw:-R,filename:F,begin:l?,length:l?",
1089 .params = "[-p] [-d] [-z|-l|-s|-w] [-R] filename [begin length]",
1090 .help = "dump guest memory into file 'filename'.\n\t\t\t"
1091 "-p: do paging to get guest's memory mapping.\n\t\t\t"
1092 "-d: return immediately (do not wait for completion).\n\t\t\t"
1093 "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1094 "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1095 "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
1096 "-R: when using kdump (-z, -l, -s), use raw rather than makedumpfile-flattened\n\t\t\t"
1097 " format\n\t\t\t"
1098 "-w: dump in Windows crashdump format (can be used instead of ELF-dump converting),\n\t\t\t"
1099 " for Windows x86 and x64 guests with vmcoreinfo driver only.\n\t\t\t"
1100 "begin: the starting physical address.\n\t\t\t"
1101 "length: the memory size, in bytes.",
1102 .cmd = hmp_dump_guest_memory,
1105 SRST
1106 ``dump-guest-memory [-p]`` *filename* *begin* *length*
1108 ``dump-guest-memory [-z|-l|-s|-w]`` *filename*
1109 Dump guest memory to *protocol*. The file can be processed with crash or
1110 gdb. Without ``-z|-l|-s|-w``, the dump format is ELF.
1112 ``-p``
1113 do paging to get guest's memory mapping.
1114 ``-z``
1115 dump in kdump-compressed format, with zlib compression.
1116 ``-l``
1117 dump in kdump-compressed format, with lzo compression.
1118 ``-s``
1119 dump in kdump-compressed format, with snappy compression.
1120 ``-R``
1121 when using kdump (-z, -l, -s), use raw rather than makedumpfile-flattened
1122 format
1123 ``-w``
1124 dump in Windows crashdump format (can be used instead of ELF-dump converting),
1125 for Windows x64 guests with vmcoreinfo driver only
1126 *filename*
1127 dump file name.
1128 *begin*
1129 the starting physical address. It's optional, and should be
1130 specified together with *length*.
1131 *length*
1132 the memory size, in bytes. It's optional, and should be specified
1133 together with *begin*.
1135 ERST
1137 #if defined(TARGET_S390X)
1139 .name = "dump-skeys",
1140 .args_type = "filename:F",
1141 .params = "",
1142 .help = "Save guest storage keys into file 'filename'.\n",
1143 .cmd = hmp_dump_skeys,
1145 #endif
1147 SRST
1148 ``dump-skeys`` *filename*
1149 Save guest storage keys to a file.
1150 ERST
1152 #if defined(TARGET_S390X)
1154 .name = "migration_mode",
1155 .args_type = "mode:i",
1156 .params = "mode",
1157 .help = "Enables or disables migration mode\n",
1158 .cmd = hmp_migrationmode,
1160 #endif
1162 SRST
1163 ``migration_mode`` *mode*
1164 Enables or disables migration mode.
1165 ERST
1168 .name = "snapshot_blkdev",
1169 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1170 .params = "[-n] device [new-image-file] [format]",
1171 .help = "initiates a live snapshot\n\t\t\t"
1172 "of device. If a new image file is specified, the\n\t\t\t"
1173 "new image file will become the new root image.\n\t\t\t"
1174 "If format is specified, the snapshot file will\n\t\t\t"
1175 "be created in that format.\n\t\t\t"
1176 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1177 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1178 "recreating it from scratch.",
1179 .cmd = hmp_snapshot_blkdev,
1182 SRST
1183 ``snapshot_blkdev``
1184 Snapshot device, using snapshot file as target if provided
1185 ERST
1188 .name = "snapshot_blkdev_internal",
1189 .args_type = "device:B,name:s",
1190 .params = "device name",
1191 .help = "take an internal snapshot of device.\n\t\t\t"
1192 "The format of the image used by device must\n\t\t\t"
1193 "support it, such as qcow2.\n\t\t\t",
1194 .cmd = hmp_snapshot_blkdev_internal,
1197 SRST
1198 ``snapshot_blkdev_internal``
1199 Take an internal snapshot on device if it support
1200 ERST
1203 .name = "snapshot_delete_blkdev_internal",
1204 .args_type = "device:B,name:s,id:s?",
1205 .params = "device name [id]",
1206 .help = "delete an internal snapshot of device.\n\t\t\t"
1207 "If id is specified, qemu will try delete\n\t\t\t"
1208 "the snapshot matching both id and name.\n\t\t\t"
1209 "The format of the image used by device must\n\t\t\t"
1210 "support it, such as qcow2.\n\t\t\t",
1211 .cmd = hmp_snapshot_delete_blkdev_internal,
1214 SRST
1215 ``snapshot_delete_blkdev_internal``
1216 Delete an internal snapshot on device if it support
1217 ERST
1220 .name = "drive_mirror",
1221 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1222 .params = "[-n] [-f] device target [format]",
1223 .help = "initiates live storage\n\t\t\t"
1224 "migration for a device. The device's contents are\n\t\t\t"
1225 "copied to the new image file, including data that\n\t\t\t"
1226 "is written after the command is started.\n\t\t\t"
1227 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1228 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1229 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1230 "so that the result does not need a backing file.\n\t\t\t",
1231 .cmd = hmp_drive_mirror,
1233 SRST
1234 ``drive_mirror``
1235 Start mirroring a block device's writes to a new destination,
1236 using the specified target.
1237 ERST
1240 .name = "drive_backup",
1241 .args_type = "reuse:-n,full:-f,compress:-c,device:B,target:s,format:s?",
1242 .params = "[-n] [-f] [-c] device target [format]",
1243 .help = "initiates a point-in-time\n\t\t\t"
1244 "copy for a device. The device's contents are\n\t\t\t"
1245 "copied to the new image file, excluding data that\n\t\t\t"
1246 "is written after the command is started.\n\t\t\t"
1247 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1248 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1249 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1250 "so that the result does not need a backing file.\n\t\t\t"
1251 "The -c flag requests QEMU to compress backup data\n\t\t\t"
1252 "(if the target format supports it).\n\t\t\t",
1253 .cmd = hmp_drive_backup,
1255 SRST
1256 ``drive_backup``
1257 Start a point-in-time copy of a block device to a specified target.
1258 ERST
1261 .name = "drive_add",
1262 .args_type = "node:-n,pci_addr:s,opts:s",
1263 .params = "[-n] [[<domain>:]<bus>:]<slot>\n"
1264 "[file=file][,if=type][,bus=n]\n"
1265 "[,unit=m][,media=d][,index=i]\n"
1266 "[,snapshot=on|off][,cache=on|off]\n"
1267 "[,readonly=on|off][,copy-on-read=on|off]",
1268 .help = "add drive to PCI storage controller",
1269 .cmd = hmp_drive_add,
1272 SRST
1273 ``drive_add``
1274 Add drive to PCI storage controller.
1275 ERST
1278 .name = "pcie_aer_inject_error",
1279 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1280 "id:s,error_status:s,"
1281 "header0:i?,header1:i?,header2:i?,header3:i?,"
1282 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1283 .params = "[-a] [-c] id "
1284 "<error_status> [<tlp header> [<tlp header prefix>]]",
1285 .help = "inject pcie aer error\n\t\t\t"
1286 " -a for advisory non fatal error\n\t\t\t"
1287 " -c for correctable error\n\t\t\t"
1288 "<id> = qdev device id\n\t\t\t"
1289 "<error_status> = error string or 32bit\n\t\t\t"
1290 "<tlp header> = 32bit x 4\n\t\t\t"
1291 "<tlp header prefix> = 32bit x 4",
1292 .cmd = hmp_pcie_aer_inject_error,
1295 SRST
1296 ``pcie_aer_inject_error``
1297 Inject PCIe AER error
1298 ERST
1301 .name = "netdev_add",
1302 .args_type = "netdev:O",
1303 .params = "[user|tap|socket|stream|dgram|vde|bridge|hubport|netmap|vhost-user"
1304 #ifdef CONFIG_AF_XDP
1305 "|af-xdp"
1306 #endif
1307 #ifdef CONFIG_VMNET
1308 "|vmnet-host|vmnet-shared|vmnet-bridged"
1309 #endif
1310 "],id=str[,prop=value][,...]",
1311 .help = "add host network device",
1312 .cmd = hmp_netdev_add,
1313 .command_completion = netdev_add_completion,
1314 .flags = "p",
1317 SRST
1318 ``netdev_add``
1319 Add host network device.
1320 ERST
1323 .name = "netdev_del",
1324 .args_type = "id:s",
1325 .params = "id",
1326 .help = "remove host network device",
1327 .cmd = hmp_netdev_del,
1328 .command_completion = netdev_del_completion,
1329 .flags = "p",
1332 SRST
1333 ``netdev_del``
1334 Remove host network device.
1335 ERST
1338 .name = "object_add",
1339 .args_type = "object:S",
1340 .params = "[qom-type=]type,id=str[,prop=value][,...]",
1341 .help = "create QOM object",
1342 .cmd = hmp_object_add,
1343 .command_completion = object_add_completion,
1344 .flags = "p",
1347 SRST
1348 ``object_add``
1349 Create QOM object.
1350 ERST
1353 .name = "object_del",
1354 .args_type = "id:s",
1355 .params = "id",
1356 .help = "destroy QOM object",
1357 .cmd = hmp_object_del,
1358 .command_completion = object_del_completion,
1359 .flags = "p",
1362 SRST
1363 ``object_del``
1364 Destroy QOM object.
1365 ERST
1367 #ifdef CONFIG_SLIRP
1369 .name = "hostfwd_add",
1370 .args_type = "arg1:s,arg2:s?",
1371 .params = "[netdev_id] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1372 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
1373 .cmd = hmp_hostfwd_add,
1375 #endif
1376 SRST
1377 ``hostfwd_add``
1378 Redirect TCP or UDP connections from host to guest (requires -net user).
1379 ERST
1381 #ifdef CONFIG_SLIRP
1383 .name = "hostfwd_remove",
1384 .args_type = "arg1:s,arg2:s?",
1385 .params = "[netdev_id] [tcp|udp]:[hostaddr]:hostport",
1386 .help = "remove host-to-guest TCP or UDP redirection",
1387 .cmd = hmp_hostfwd_remove,
1390 #endif
1391 SRST
1392 ``hostfwd_remove``
1393 Remove host-to-guest TCP or UDP redirection.
1394 ERST
1397 .name = "balloon",
1398 .args_type = "value:M",
1399 .params = "target",
1400 .help = "request VM to change its memory allocation (in MB)",
1401 .cmd = hmp_balloon,
1404 SRST
1405 ``balloon`` *value*
1406 Request VM to change its memory allocation to *value* (in MB).
1407 ERST
1410 .name = "set_link",
1411 .args_type = "name:s,up:b",
1412 .params = "name on|off",
1413 .help = "change the link status of a network adapter",
1414 .cmd = hmp_set_link,
1415 .command_completion = set_link_completion,
1418 SRST
1419 ``set_link`` *name* ``[on|off]``
1420 Switch link *name* on (i.e. up) or off (i.e. down).
1421 ERST
1424 .name = "watchdog_action",
1425 .args_type = "action:s",
1426 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1427 .help = "change watchdog action",
1428 .cmd = hmp_watchdog_action,
1429 .command_completion = watchdog_action_completion,
1432 SRST
1433 ``watchdog_action``
1434 Change watchdog action.
1435 ERST
1438 .name = "nbd_server_start",
1439 .args_type = "all:-a,writable:-w,uri:s",
1440 .params = "nbd_server_start [-a] [-w] host:port",
1441 .help = "serve block devices on the given host and port",
1442 .cmd = hmp_nbd_server_start,
1443 .flags = "p",
1445 SRST
1446 ``nbd_server_start`` *host*:*port*
1447 Start an NBD server on the given host and/or port. If the ``-a``
1448 option is included, all of the virtual machine's block devices that
1449 have an inserted media on them are automatically exported; in this case,
1450 the ``-w`` option makes the devices writable too.
1451 ERST
1454 .name = "nbd_server_add",
1455 .args_type = "writable:-w,device:B,name:s?",
1456 .params = "nbd_server_add [-w] device [name]",
1457 .help = "export a block device via NBD",
1458 .cmd = hmp_nbd_server_add,
1459 .flags = "p",
1461 SRST
1462 ``nbd_server_add`` *device* [ *name* ]
1463 Export a block device through QEMU's NBD server, which must be started
1464 beforehand with ``nbd_server_start``. The ``-w`` option makes the
1465 exported device writable too. The export name is controlled by *name*,
1466 defaulting to *device*.
1467 ERST
1470 .name = "nbd_server_remove",
1471 .args_type = "force:-f,name:s",
1472 .params = "nbd_server_remove [-f] name",
1473 .help = "remove an export previously exposed via NBD",
1474 .cmd = hmp_nbd_server_remove,
1475 .flags = "p",
1477 SRST
1478 ``nbd_server_remove [-f]`` *name*
1479 Stop exporting a block device through QEMU's NBD server, which was
1480 previously started with ``nbd_server_add``. The ``-f``
1481 option forces the server to drop the export immediately even if
1482 clients are connected; otherwise the command fails unless there are no
1483 clients.
1484 ERST
1487 .name = "nbd_server_stop",
1488 .args_type = "",
1489 .params = "nbd_server_stop",
1490 .help = "stop serving block devices using the NBD protocol",
1491 .cmd = hmp_nbd_server_stop,
1492 .flags = "p",
1494 SRST
1495 ``nbd_server_stop``
1496 Stop the QEMU embedded NBD server.
1497 ERST
1500 #if defined(TARGET_I386)
1503 .name = "mce",
1504 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1505 .params = "[-b] cpu bank status mcgstatus addr misc",
1506 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1507 .cmd = hmp_mce,
1510 #endif
1511 SRST
1512 ``mce`` *cpu* *bank* *status* *mcgstatus* *addr* *misc*
1513 Inject an MCE on the given CPU (x86 only).
1514 ERST
1516 #ifdef CONFIG_POSIX
1518 .name = "getfd",
1519 .args_type = "fdname:s",
1520 .params = "getfd name",
1521 .help = "receive a file descriptor via SCM rights and assign it a name",
1522 .cmd = hmp_getfd,
1523 .flags = "p",
1526 SRST
1527 ``getfd`` *fdname*
1528 If a file descriptor is passed alongside this command using the SCM_RIGHTS
1529 mechanism on unix sockets, it is stored using the name *fdname* for
1530 later use by other monitor commands.
1531 ERST
1532 #endif
1535 .name = "closefd",
1536 .args_type = "fdname:s",
1537 .params = "closefd name",
1538 .help = "close a file descriptor previously passed via SCM rights",
1539 .cmd = hmp_closefd,
1540 .flags = "p",
1543 SRST
1544 ``closefd`` *fdname*
1545 Close the file descriptor previously assigned to *fdname* using the
1546 ``getfd`` command. This is only needed if the file descriptor was never
1547 used by another monitor command.
1548 ERST
1551 .name = "block_set_io_throttle",
1552 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1553 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1554 .help = "change I/O throttle limits for a block drive",
1555 .cmd = hmp_block_set_io_throttle,
1556 .flags = "p",
1559 SRST
1560 ``block_set_io_throttle`` *device* *bps* *bps_rd* *bps_wr* *iops* *iops_rd* *iops_wr*
1561 Change I/O throttle limits for a block drive to
1562 *bps* *bps_rd* *bps_wr* *iops* *iops_rd* *iops_wr*.
1563 *device* can be a block device name, a qdev ID or a QOM path.
1564 ERST
1567 .name = "set_password",
1568 .args_type = "protocol:s,password:s,display:-ds,connected:s?",
1569 .params = "protocol password [-d display] [action-if-connected]",
1570 .help = "set spice/vnc password",
1571 .cmd = hmp_set_password,
1574 SRST
1575 ``set_password [ vnc | spice ] password [ -d display ] [ action-if-connected ]``
1576 Change spice/vnc password. *display* can be used with 'vnc' to specify
1577 which display to set the password on. *action-if-connected* specifies
1578 what should happen in case a connection is established: *fail* makes
1579 the password change fail. *disconnect* changes the password and
1580 disconnects the client. *keep* changes the password and keeps the
1581 connection up. *keep* is the default.
1582 ERST
1585 .name = "expire_password",
1586 .args_type = "protocol:s,time:s,display:-ds",
1587 .params = "protocol time [-d display]",
1588 .help = "set spice/vnc password expire-time",
1589 .cmd = hmp_expire_password,
1592 SRST
1593 ``expire_password [ vnc | spice ] expire-time [ -d display ]``
1594 Specify when a password for spice/vnc becomes invalid.
1595 *display* behaves the same as in ``set_password``.
1596 *expire-time* accepts:
1598 ``now``
1599 Invalidate password instantly.
1600 ``never``
1601 Password stays valid forever.
1602 ``+``\ *nsec*
1603 Password stays valid for *nsec* seconds starting now.
1604 *nsec*
1605 Password is invalidated at the given time. *nsec* are the seconds
1606 passed since 1970, i.e. unix epoch.
1608 ERST
1611 .name = "chardev-add",
1612 .args_type = "args:s",
1613 .params = "args",
1614 .help = "add chardev",
1615 .cmd = hmp_chardev_add,
1616 .command_completion = chardev_add_completion,
1619 SRST
1620 ``chardev-add`` *args*
1621 chardev-add accepts the same parameters as the -chardev command line switch.
1622 ERST
1625 .name = "chardev-change",
1626 .args_type = "id:s,args:s",
1627 .params = "id args",
1628 .help = "change chardev",
1629 .cmd = hmp_chardev_change,
1632 SRST
1633 ``chardev-change`` *args*
1634 chardev-change accepts existing chardev *id* and then the same arguments
1635 as the -chardev command line switch (except for "id").
1636 ERST
1639 .name = "chardev-remove",
1640 .args_type = "id:s",
1641 .params = "id",
1642 .help = "remove chardev",
1643 .cmd = hmp_chardev_remove,
1644 .command_completion = chardev_remove_completion,
1647 SRST
1648 ``chardev-remove`` *id*
1649 Removes the chardev *id*.
1650 ERST
1653 .name = "chardev-send-break",
1654 .args_type = "id:s",
1655 .params = "id",
1656 .help = "send a break on chardev",
1657 .cmd = hmp_chardev_send_break,
1658 .command_completion = chardev_remove_completion,
1661 SRST
1662 ``chardev-send-break`` *id*
1663 Send a break on the chardev *id*.
1664 ERST
1667 .name = "qemu-io",
1668 .args_type = "qdev:-d,device:B,command:s",
1669 .params = "[-d] [device] \"[command]\"",
1670 .help = "run a qemu-io command on a block device\n\t\t\t"
1671 "-d: [device] is a device ID rather than a "
1672 "drive ID or node name",
1673 .cmd = hmp_qemu_io,
1676 SRST
1677 ``qemu-io`` *device* *command*
1678 Executes a qemu-io command on the given block device.
1679 ERST
1682 .name = "qom-list",
1683 .args_type = "path:s?",
1684 .params = "path",
1685 .help = "list QOM properties",
1686 .cmd = hmp_qom_list,
1687 .flags = "p",
1690 SRST
1691 ``qom-list`` [*path*]
1692 Print QOM properties of object at location *path*
1693 ERST
1696 .name = "qom-get",
1697 .args_type = "path:s,property:s",
1698 .params = "path property",
1699 .help = "print QOM property",
1700 .cmd = hmp_qom_get,
1701 .flags = "p",
1704 SRST
1705 ``qom-get`` *path* *property*
1706 Print QOM property *property* of object at location *path*
1707 ERST
1710 .name = "qom-set",
1711 .args_type = "json:-j,path:s,property:s,value:S",
1712 .params = "[-j] path property value",
1713 .help = "set QOM property.\n\t\t\t"
1714 "-j: the value is specified in json format.",
1715 .cmd = hmp_qom_set,
1716 .flags = "p",
1719 SRST
1720 ``qom-set`` *path* *property* *value*
1721 Set QOM property *property* of object at location *path* to value *value*
1722 ERST
1725 .name = "replay_break",
1726 .args_type = "icount:l",
1727 .params = "icount",
1728 .help = "set breakpoint at the specified instruction count",
1729 .cmd = hmp_replay_break,
1732 SRST
1733 ``replay_break`` *icount*
1734 Set replay breakpoint at instruction count *icount*.
1735 Execution stops when the specified instruction is reached.
1736 There can be at most one breakpoint. When breakpoint is set, any prior
1737 one is removed. The breakpoint may be set only in replay mode and only
1738 "in the future", i.e. at instruction counts greater than the current one.
1739 The current instruction count can be observed with ``info replay``.
1740 ERST
1743 .name = "replay_delete_break",
1744 .args_type = "",
1745 .params = "",
1746 .help = "remove replay breakpoint",
1747 .cmd = hmp_replay_delete_break,
1750 SRST
1751 ``replay_delete_break``
1752 Remove replay breakpoint which was previously set with ``replay_break``.
1753 The command is ignored when there are no replay breakpoints.
1754 ERST
1757 .name = "replay_seek",
1758 .args_type = "icount:l",
1759 .params = "icount",
1760 .help = "replay execution to the specified instruction count",
1761 .cmd = hmp_replay_seek,
1764 SRST
1765 ``replay_seek`` *icount*
1766 Automatically proceed to the instruction count *icount*, when
1767 replaying the execution. The command automatically loads nearest
1768 snapshot and replays the execution to find the desired instruction.
1769 When there is no preceding snapshot or the execution is not replayed,
1770 then the command fails.
1771 *icount* for the reference may be observed with ``info replay`` command.
1772 ERST
1775 .name = "calc_dirty_rate",
1776 .args_type = "dirty_ring:-r,dirty_bitmap:-b,second:l,sample_pages_per_GB:l?",
1777 .params = "[-r] [-b] second [sample_pages_per_GB]",
1778 .help = "start a round of guest dirty rate measurement (using -r to"
1779 "\n\t\t\t specify dirty ring as the method of calculation and"
1780 "\n\t\t\t -b to specify dirty bitmap as method of calculation)",
1781 .cmd = hmp_calc_dirty_rate,
1784 SRST
1785 ``calc_dirty_rate`` *second*
1786 Start a round of dirty rate measurement with the period specified in *second*.
1787 The result of the dirty rate measurement may be observed with ``info
1788 dirty_rate`` command.
1789 ERST
1792 .name = "set_vcpu_dirty_limit",
1793 .args_type = "dirty_rate:l,cpu_index:l?",
1794 .params = "dirty_rate [cpu_index]",
1795 .help = "set dirty page rate limit, use cpu_index to set limit"
1796 "\n\t\t\t\t\t on a specified virtual cpu",
1797 .cmd = hmp_set_vcpu_dirty_limit,
1800 SRST
1801 ``set_vcpu_dirty_limit``
1802 Set dirty page rate limit on virtual CPU, the information about all the
1803 virtual CPU dirty limit status can be observed with ``info vcpu_dirty_limit``
1804 command.
1805 ERST
1808 .name = "cancel_vcpu_dirty_limit",
1809 .args_type = "cpu_index:l?",
1810 .params = "[cpu_index]",
1811 .help = "cancel dirty page rate limit, use cpu_index to cancel"
1812 "\n\t\t\t\t\t limit on a specified virtual cpu",
1813 .cmd = hmp_cancel_vcpu_dirty_limit,
1816 SRST
1817 ``cancel_vcpu_dirty_limit``
1818 Cancel dirty page rate limit on virtual CPU, the information about all the
1819 virtual CPU dirty limit status can be observed with ``info vcpu_dirty_limit``
1820 command.
1821 ERST
1824 .name = "info",
1825 .args_type = "item:s?",
1826 .params = "[subcommand]",
1827 .help = "show various information about the system state",
1828 .cmd = hmp_info_help,
1829 .sub_table = hmp_info_cmds,
1830 .flags = "p",
1833 #if defined(CONFIG_FDT)
1835 .name = "dumpdtb",
1836 .args_type = "filename:F",
1837 .params = "filename",
1838 .help = "dump the FDT in dtb format to 'filename'",
1839 .cmd = hmp_dumpdtb,
1842 SRST
1843 ``dumpdtb`` *filename*
1844 Dump the FDT in dtb format to *filename*.
1845 ERST
1846 #endif
1848 #if defined(CONFIG_XEN_EMU)
1850 .name = "xen-event-inject",
1851 .args_type = "port:i",
1852 .params = "port",
1853 .help = "inject event channel",
1854 .cmd = hmp_xen_event_inject,
1857 SRST
1858 ``xen-event-inject`` *port*
1859 Notify guest via event channel on port *port*.
1860 ERST
1864 .name = "xen-event-list",
1865 .args_type = "",
1866 .params = "",
1867 .help = "list event channel state",
1868 .cmd = hmp_xen_event_list,
1871 SRST
1872 ``xen-event-list``
1873 List event channels in the guest
1874 ERST
1875 #endif