tap: import linux multiqueue constants
[qemu/ar7.git] / hmp-commands.hx
blobbdd48f3469e0cd3fb76d7b4e3ee732e22f005ecf
1 HXCOMM Use DEFHEADING() to define headings in both help text and texi
2 HXCOMM Text between STEXI and ETEXI are copied to texi 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 texi and C
8 STEXI
9 @table @option
10 ETEXI
13 .name = "help|?",
14 .args_type = "name:s?",
15 .params = "[cmd]",
16 .help = "show the help",
17 .mhandler.cmd = do_help_cmd,
20 STEXI
21 @item help or ? [@var{cmd}]
22 @findex help
23 Show the help for all commands or just for command @var{cmd}.
24 ETEXI
27 .name = "commit",
28 .args_type = "device:B",
29 .params = "device|all",
30 .help = "commit changes to the disk images (if -snapshot is used) or backing files",
31 .mhandler.cmd = do_commit,
34 STEXI
35 @item commit
36 @findex commit
37 Commit changes to the disk images (if -snapshot is used) or backing files.
38 ETEXI
41 .name = "q|quit",
42 .args_type = "",
43 .params = "",
44 .help = "quit the emulator",
45 .user_print = monitor_user_noop,
46 .mhandler.cmd = hmp_quit,
49 STEXI
50 @item q or quit
51 @findex quit
52 Quit the emulator.
53 ETEXI
56 .name = "block_resize",
57 .args_type = "device:B,size:o",
58 .params = "device size",
59 .help = "resize a block image",
60 .mhandler.cmd = hmp_block_resize,
63 STEXI
64 @item block_resize
65 @findex block_resize
66 Resize a block image while a guest is running. Usually requires guest
67 action to see the updated size. Resize to a lower size is supported,
68 but should be used with extreme caution. Note that this command only
69 resizes image files, it can not resize block devices like LVM volumes.
70 ETEXI
73 .name = "block_stream",
74 .args_type = "device:B,speed:o?,base:s?",
75 .params = "device [speed [base]]",
76 .help = "copy data from a backing file into a block device",
77 .mhandler.cmd = hmp_block_stream,
80 STEXI
81 @item block_stream
82 @findex block_stream
83 Copy data from a backing file into a block device.
84 ETEXI
87 .name = "block_job_set_speed",
88 .args_type = "device:B,speed:o",
89 .params = "device speed",
90 .help = "set maximum speed for a background block operation",
91 .mhandler.cmd = hmp_block_job_set_speed,
94 STEXI
95 @item block_job_set_speed
96 @findex block_job_set_speed
97 Set maximum speed for a background block operation.
98 ETEXI
101 .name = "block_job_cancel",
102 .args_type = "force:-f,device:B",
103 .params = "[-f] device",
104 .help = "stop an active background block operation (use -f"
105 "\n\t\t\t if the operation is currently paused)",
106 .mhandler.cmd = hmp_block_job_cancel,
109 STEXI
110 @item block_job_cancel
111 @findex block_job_cancel
112 Stop an active background block operation (streaming, mirroring).
113 ETEXI
116 .name = "block_job_complete",
117 .args_type = "device:B",
118 .params = "device",
119 .help = "stop an active background block operation",
120 .mhandler.cmd = hmp_block_job_complete,
123 STEXI
124 @item block_job_complete
125 @findex block_job_complete
126 Manually trigger completion of an active background block operation.
127 For mirroring, this will switch the device to the destination path.
128 ETEXI
131 .name = "block_job_pause",
132 .args_type = "device:B",
133 .params = "device",
134 .help = "pause an active background block operation",
135 .mhandler.cmd = hmp_block_job_pause,
138 STEXI
139 @item block_job_pause
140 @findex block_job_pause
141 Pause an active block streaming operation.
142 ETEXI
145 .name = "block_job_resume",
146 .args_type = "device:B",
147 .params = "device",
148 .help = "resume a paused background block operation",
149 .mhandler.cmd = hmp_block_job_resume,
152 STEXI
153 @item block_job_resume
154 @findex block_job_resume
155 Resume a paused block streaming operation.
156 ETEXI
159 .name = "eject",
160 .args_type = "force:-f,device:B",
161 .params = "[-f] device",
162 .help = "eject a removable medium (use -f to force it)",
163 .mhandler.cmd = hmp_eject,
166 STEXI
167 @item eject [-f] @var{device}
168 @findex eject
169 Eject a removable medium (use -f to force it).
170 ETEXI
173 .name = "drive_del",
174 .args_type = "id:s",
175 .params = "device",
176 .help = "remove host block device",
177 .user_print = monitor_user_noop,
178 .mhandler.cmd_new = do_drive_del,
181 STEXI
182 @item drive_del @var{device}
183 @findex drive_del
184 Remove host block device. The result is that guest generated IO is no longer
185 submitted against the host device underlying the disk. Once a drive has
186 been deleted, the QEMU Block layer returns -EIO which results in IO
187 errors in the guest for applications that are reading/writing to the device.
188 ETEXI
191 .name = "change",
192 .args_type = "device:B,target:F,arg:s?",
193 .params = "device filename [format]",
194 .help = "change a removable medium, optional format",
195 .mhandler.cmd = hmp_change,
198 STEXI
199 @item change @var{device} @var{setting}
200 @findex change
202 Change the configuration of a device.
204 @table @option
205 @item change @var{diskdevice} @var{filename} [@var{format}]
206 Change the medium for a removable disk device to point to @var{filename}. eg
208 @example
209 (qemu) change ide1-cd0 /path/to/some.iso
210 @end example
212 @var{format} is optional.
214 @item change vnc @var{display},@var{options}
215 Change the configuration of the VNC server. The valid syntax for @var{display}
216 and @var{options} are described at @ref{sec_invocation}. eg
218 @example
219 (qemu) change vnc localhost:1
220 @end example
222 @item change vnc password [@var{password}]
224 Change the password associated with the VNC server. If the new password is not
225 supplied, the monitor will prompt for it to be entered. VNC passwords are only
226 significant up to 8 letters. eg
228 @example
229 (qemu) change vnc password
230 Password: ********
231 @end example
233 @end table
234 ETEXI
237 .name = "screendump",
238 .args_type = "filename:F",
239 .params = "filename",
240 .help = "save screen into PPM image 'filename'",
241 .mhandler.cmd = hmp_screen_dump,
244 STEXI
245 @item screendump @var{filename}
246 @findex screendump
247 Save screen into PPM image @var{filename}.
248 ETEXI
251 .name = "logfile",
252 .args_type = "filename:F",
253 .params = "filename",
254 .help = "output logs to 'filename'",
255 .mhandler.cmd = do_logfile,
258 STEXI
259 @item logfile @var{filename}
260 @findex logfile
261 Output logs to @var{filename}.
262 ETEXI
265 .name = "trace-event",
266 .args_type = "name:s,option:b",
267 .params = "name on|off",
268 .help = "changes status of a specific trace event",
269 .mhandler.cmd = do_trace_event_set_state,
272 STEXI
273 @item trace-event
274 @findex trace-event
275 changes status of a trace event
276 ETEXI
278 #if defined(CONFIG_TRACE_SIMPLE)
280 .name = "trace-file",
281 .args_type = "op:s?,arg:F?",
282 .params = "on|off|flush|set [arg]",
283 .help = "open, close, or flush trace file, or set a new file name",
284 .mhandler.cmd = do_trace_file,
287 STEXI
288 @item trace-file on|off|flush
289 @findex trace-file
290 Open, close, or flush the trace file. If no argument is given, the status of the trace file is displayed.
291 ETEXI
292 #endif
295 .name = "log",
296 .args_type = "items:s",
297 .params = "item1[,...]",
298 .help = "activate logging of the specified items to '/tmp/qemu.log'",
299 .mhandler.cmd = do_log,
302 STEXI
303 @item log @var{item1}[,...]
304 @findex log
305 Activate logging of the specified items to @file{/tmp/qemu.log}.
306 ETEXI
309 .name = "savevm",
310 .args_type = "name:s?",
311 .params = "[tag|id]",
312 .help = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
313 .mhandler.cmd = do_savevm,
316 STEXI
317 @item savevm [@var{tag}|@var{id}]
318 @findex savevm
319 Create a snapshot of the whole virtual machine. If @var{tag} is
320 provided, it is used as human readable identifier. If there is already
321 a snapshot with the same tag or ID, it is replaced. More info at
322 @ref{vm_snapshots}.
323 ETEXI
326 .name = "loadvm",
327 .args_type = "name:s",
328 .params = "tag|id",
329 .help = "restore a VM snapshot from its tag or id",
330 .mhandler.cmd = do_loadvm,
333 STEXI
334 @item loadvm @var{tag}|@var{id}
335 @findex loadvm
336 Set the whole virtual machine to the snapshot identified by the tag
337 @var{tag} or the unique snapshot ID @var{id}.
338 ETEXI
341 .name = "delvm",
342 .args_type = "name:s",
343 .params = "tag|id",
344 .help = "delete a VM snapshot from its tag or id",
345 .mhandler.cmd = do_delvm,
348 STEXI
349 @item delvm @var{tag}|@var{id}
350 @findex delvm
351 Delete the snapshot identified by @var{tag} or @var{id}.
352 ETEXI
355 .name = "singlestep",
356 .args_type = "option:s?",
357 .params = "[on|off]",
358 .help = "run emulation in singlestep mode or switch to normal mode",
359 .mhandler.cmd = do_singlestep,
362 STEXI
363 @item singlestep [off]
364 @findex singlestep
365 Run the emulation in single step mode.
366 If called with option off, the emulation returns to normal mode.
367 ETEXI
370 .name = "stop",
371 .args_type = "",
372 .params = "",
373 .help = "stop emulation",
374 .mhandler.cmd = hmp_stop,
377 STEXI
378 @item stop
379 @findex stop
380 Stop emulation.
381 ETEXI
384 .name = "c|cont",
385 .args_type = "",
386 .params = "",
387 .help = "resume emulation",
388 .mhandler.cmd = hmp_cont,
391 STEXI
392 @item c or cont
393 @findex cont
394 Resume emulation.
395 ETEXI
398 .name = "system_wakeup",
399 .args_type = "",
400 .params = "",
401 .help = "wakeup guest from suspend",
402 .mhandler.cmd = hmp_system_wakeup,
405 STEXI
406 @item system_wakeup
407 @findex system_wakeup
408 Wakeup guest from suspend.
409 ETEXI
412 .name = "gdbserver",
413 .args_type = "device:s?",
414 .params = "[device]",
415 .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
416 .mhandler.cmd = do_gdbserver,
419 STEXI
420 @item gdbserver [@var{port}]
421 @findex gdbserver
422 Start gdbserver session (default @var{port}=1234)
423 ETEXI
426 .name = "x",
427 .args_type = "fmt:/,addr:l",
428 .params = "/fmt addr",
429 .help = "virtual memory dump starting at 'addr'",
430 .mhandler.cmd = do_memory_dump,
433 STEXI
434 @item x/fmt @var{addr}
435 @findex x
436 Virtual memory dump starting at @var{addr}.
437 ETEXI
440 .name = "xp",
441 .args_type = "fmt:/,addr:l",
442 .params = "/fmt addr",
443 .help = "physical memory dump starting at 'addr'",
444 .mhandler.cmd = do_physical_memory_dump,
447 STEXI
448 @item xp /@var{fmt} @var{addr}
449 @findex xp
450 Physical memory dump starting at @var{addr}.
452 @var{fmt} is a format which tells the command how to format the
453 data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
455 @table @var
456 @item count
457 is the number of items to be dumped.
459 @item format
460 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
461 c (char) or i (asm instruction).
463 @item size
464 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
465 @code{h} or @code{w} can be specified with the @code{i} format to
466 respectively select 16 or 32 bit code instruction size.
468 @end table
470 Examples:
471 @itemize
472 @item
473 Dump 10 instructions at the current instruction pointer:
474 @example
475 (qemu) x/10i $eip
476 0x90107063: ret
477 0x90107064: sti
478 0x90107065: lea 0x0(%esi,1),%esi
479 0x90107069: lea 0x0(%edi,1),%edi
480 0x90107070: ret
481 0x90107071: jmp 0x90107080
482 0x90107073: nop
483 0x90107074: nop
484 0x90107075: nop
485 0x90107076: nop
486 @end example
488 @item
489 Dump 80 16 bit values at the start of the video memory.
490 @smallexample
491 (qemu) xp/80hx 0xb8000
492 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
493 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
494 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
495 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
496 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
497 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
498 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
499 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
500 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
501 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
502 @end smallexample
503 @end itemize
504 ETEXI
507 .name = "p|print",
508 .args_type = "fmt:/,val:l",
509 .params = "/fmt expr",
510 .help = "print expression value (use $reg for CPU register access)",
511 .mhandler.cmd = do_print,
514 STEXI
515 @item p or print/@var{fmt} @var{expr}
516 @findex print
518 Print expression value. Only the @var{format} part of @var{fmt} is
519 used.
520 ETEXI
523 .name = "i",
524 .args_type = "fmt:/,addr:i,index:i.",
525 .params = "/fmt addr",
526 .help = "I/O port read",
527 .mhandler.cmd = do_ioport_read,
530 STEXI
531 Read I/O port.
532 ETEXI
535 .name = "o",
536 .args_type = "fmt:/,addr:i,val:i",
537 .params = "/fmt addr value",
538 .help = "I/O port write",
539 .mhandler.cmd = do_ioport_write,
542 STEXI
543 Write to I/O port.
544 ETEXI
547 .name = "sendkey",
548 .args_type = "keys:s,hold-time:i?",
549 .params = "keys [hold_ms]",
550 .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
551 .mhandler.cmd = hmp_send_key,
554 STEXI
555 @item sendkey @var{keys}
556 @findex sendkey
558 Send @var{keys} to the guest. @var{keys} could be the name of the
559 key or the raw value in hexadecimal format. Use @code{-} to press
560 several keys simultaneously. Example:
561 @example
562 sendkey ctrl-alt-f1
563 @end example
565 This command is useful to send keys that your graphical user interface
566 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
567 ETEXI
570 .name = "system_reset",
571 .args_type = "",
572 .params = "",
573 .help = "reset the system",
574 .mhandler.cmd = hmp_system_reset,
577 STEXI
578 @item system_reset
579 @findex system_reset
581 Reset the system.
582 ETEXI
585 .name = "system_powerdown",
586 .args_type = "",
587 .params = "",
588 .help = "send system power down event",
589 .mhandler.cmd = hmp_system_powerdown,
592 STEXI
593 @item system_powerdown
594 @findex system_powerdown
596 Power down the system (if supported).
597 ETEXI
600 .name = "sum",
601 .args_type = "start:i,size:i",
602 .params = "addr size",
603 .help = "compute the checksum of a memory region",
604 .mhandler.cmd = do_sum,
607 STEXI
608 @item sum @var{addr} @var{size}
609 @findex sum
611 Compute the checksum of a memory region.
612 ETEXI
615 .name = "usb_add",
616 .args_type = "devname:s",
617 .params = "device",
618 .help = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
619 .mhandler.cmd = do_usb_add,
622 STEXI
623 @item usb_add @var{devname}
624 @findex usb_add
626 Add the USB device @var{devname}. For details of available devices see
627 @ref{usb_devices}
628 ETEXI
631 .name = "usb_del",
632 .args_type = "devname:s",
633 .params = "device",
634 .help = "remove USB device 'bus.addr'",
635 .mhandler.cmd = do_usb_del,
638 STEXI
639 @item usb_del @var{devname}
640 @findex usb_del
642 Remove the USB device @var{devname} from the QEMU virtual USB
643 hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
644 command @code{info usb} to see the devices you can remove.
645 ETEXI
648 .name = "device_add",
649 .args_type = "device:O",
650 .params = "driver[,prop=value][,...]",
651 .help = "add device, like -device on the command line",
652 .user_print = monitor_user_noop,
653 .mhandler.cmd_new = do_device_add,
656 STEXI
657 @item device_add @var{config}
658 @findex device_add
660 Add device.
661 ETEXI
664 .name = "device_del",
665 .args_type = "id:s",
666 .params = "device",
667 .help = "remove device",
668 .mhandler.cmd = hmp_device_del,
671 STEXI
672 @item device_del @var{id}
673 @findex device_del
675 Remove device @var{id}.
676 ETEXI
679 .name = "cpu",
680 .args_type = "index:i",
681 .params = "index",
682 .help = "set the default CPU",
683 .mhandler.cmd = hmp_cpu,
686 STEXI
687 @item cpu @var{index}
688 @findex cpu
689 Set the default CPU.
690 ETEXI
693 .name = "mouse_move",
694 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
695 .params = "dx dy [dz]",
696 .help = "send mouse move events",
697 .mhandler.cmd = do_mouse_move,
700 STEXI
701 @item mouse_move @var{dx} @var{dy} [@var{dz}]
702 @findex mouse_move
703 Move the active mouse to the specified coordinates @var{dx} @var{dy}
704 with optional scroll axis @var{dz}.
705 ETEXI
708 .name = "mouse_button",
709 .args_type = "button_state:i",
710 .params = "state",
711 .help = "change mouse button state (1=L, 2=M, 4=R)",
712 .mhandler.cmd = do_mouse_button,
715 STEXI
716 @item mouse_button @var{val}
717 @findex mouse_button
718 Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
719 ETEXI
722 .name = "mouse_set",
723 .args_type = "index:i",
724 .params = "index",
725 .help = "set which mouse device receives events",
726 .mhandler.cmd = do_mouse_set,
729 STEXI
730 @item mouse_set @var{index}
731 @findex mouse_set
732 Set which mouse device receives events at given @var{index}, index
733 can be obtained with
734 @example
735 info mice
736 @end example
737 ETEXI
739 #ifdef HAS_AUDIO
741 .name = "wavcapture",
742 .args_type = "path:F,freq:i?,bits:i?,nchannels:i?",
743 .params = "path [frequency [bits [channels]]]",
744 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
745 .mhandler.cmd = do_wav_capture,
747 #endif
748 STEXI
749 @item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
750 @findex wavcapture
751 Capture audio into @var{filename}. Using sample rate @var{frequency}
752 bits per sample @var{bits} and number of channels @var{channels}.
754 Defaults:
755 @itemize @minus
756 @item Sample rate = 44100 Hz - CD quality
757 @item Bits = 16
758 @item Number of channels = 2 - Stereo
759 @end itemize
760 ETEXI
762 #ifdef HAS_AUDIO
764 .name = "stopcapture",
765 .args_type = "n:i",
766 .params = "capture index",
767 .help = "stop capture",
768 .mhandler.cmd = do_stop_capture,
770 #endif
771 STEXI
772 @item stopcapture @var{index}
773 @findex stopcapture
774 Stop capture with a given @var{index}, index can be obtained with
775 @example
776 info capture
777 @end example
778 ETEXI
781 .name = "memsave",
782 .args_type = "val:l,size:i,filename:s",
783 .params = "addr size file",
784 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
785 .mhandler.cmd = hmp_memsave,
788 STEXI
789 @item memsave @var{addr} @var{size} @var{file}
790 @findex memsave
791 save to disk virtual memory dump starting at @var{addr} of size @var{size}.
792 ETEXI
795 .name = "pmemsave",
796 .args_type = "val:l,size:i,filename:s",
797 .params = "addr size file",
798 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
799 .mhandler.cmd = hmp_pmemsave,
802 STEXI
803 @item pmemsave @var{addr} @var{size} @var{file}
804 @findex pmemsave
805 save to disk physical memory dump starting at @var{addr} of size @var{size}.
806 ETEXI
809 .name = "boot_set",
810 .args_type = "bootdevice:s",
811 .params = "bootdevice",
812 .help = "define new values for the boot device list",
813 .mhandler.cmd = do_boot_set,
816 STEXI
817 @item boot_set @var{bootdevicelist}
818 @findex boot_set
820 Define new values for the boot device list. Those values will override
821 the values specified on the command line through the @code{-boot} option.
823 The values that can be specified here depend on the machine type, but are
824 the same that can be specified in the @code{-boot} command line option.
825 ETEXI
827 #if defined(TARGET_I386)
829 .name = "nmi",
830 .args_type = "",
831 .params = "",
832 .help = "inject an NMI on all guest's CPUs",
833 .mhandler.cmd = hmp_inject_nmi,
835 #endif
836 STEXI
837 @item nmi @var{cpu}
838 @findex nmi
839 Inject an NMI on the given CPU (x86 only).
841 ETEXI
844 .name = "memchar_write",
845 .args_type = "device:s,data:s",
846 .params = "device data",
847 .help = "Provide writing interface for CirMemCharDriver. Write"
848 "'data' to it.",
849 .mhandler.cmd = hmp_memchar_write,
852 STEXI
853 @item memchar_write @var{device} @var{data}
854 @findex memchar_write
855 Provide writing interface for CirMemCharDriver. Write @var{data}
856 to char device 'memory'.
858 ETEXI
861 .name = "memchar_read",
862 .args_type = "device:s,size:i",
863 .params = "device size",
864 .help = "Provide read interface for CirMemCharDriver. Read from"
865 "it and return the data with size.",
866 .mhandler.cmd = hmp_memchar_read,
869 STEXI
870 @item memchar_read @var{device}
871 @findex memchar_read
872 Provide read interface for CirMemCharDriver. Read from char device
873 'memory' and return the data.
875 @var{size} is the size of data want to read from. Refer to unencoded
876 size of the raw data, would adjust to the init size of the memchar
877 if the requested size is larger than it.
879 ETEXI
882 .name = "migrate",
883 .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
884 .params = "[-d] [-b] [-i] uri",
885 .help = "migrate to URI (using -d to not wait for completion)"
886 "\n\t\t\t -b for migration without shared storage with"
887 " full copy of disk\n\t\t\t -i for migration without "
888 "shared storage with incremental copy of disk "
889 "(base image shared between src and destination)",
890 .mhandler.cmd = hmp_migrate,
894 STEXI
895 @item migrate [-d] [-b] [-i] @var{uri}
896 @findex migrate
897 Migrate to @var{uri} (using -d to not wait for completion).
898 -b for migration with full copy of disk
899 -i for migration with incremental copy of disk (base image is shared)
900 ETEXI
903 .name = "migrate_cancel",
904 .args_type = "",
905 .params = "",
906 .help = "cancel the current VM migration",
907 .mhandler.cmd = hmp_migrate_cancel,
910 STEXI
911 @item migrate_cancel
912 @findex migrate_cancel
913 Cancel the current VM migration.
915 ETEXI
918 .name = "migrate_set_cache_size",
919 .args_type = "value:o",
920 .params = "value",
921 .help = "set cache size (in bytes) for XBZRLE migrations,"
922 "the cache size will be rounded down to the nearest "
923 "power of 2.\n"
924 "The cache size affects the number of cache misses."
925 "In case of a high cache miss ratio you need to increase"
926 " the cache size",
927 .mhandler.cmd = hmp_migrate_set_cache_size,
930 STEXI
931 @item migrate_set_cache_size @var{value}
932 @findex migrate_set_cache_size
933 Set cache size to @var{value} (in bytes) for xbzrle migrations.
934 ETEXI
937 .name = "migrate_set_speed",
938 .args_type = "value:o",
939 .params = "value",
940 .help = "set maximum speed (in bytes) for migrations. "
941 "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
942 .mhandler.cmd = hmp_migrate_set_speed,
945 STEXI
946 @item migrate_set_speed @var{value}
947 @findex migrate_set_speed
948 Set maximum speed to @var{value} (in bytes) for migrations.
949 ETEXI
952 .name = "migrate_set_downtime",
953 .args_type = "value:T",
954 .params = "value",
955 .help = "set maximum tolerated downtime (in seconds) for migrations",
956 .mhandler.cmd = hmp_migrate_set_downtime,
959 STEXI
960 @item migrate_set_downtime @var{second}
961 @findex migrate_set_downtime
962 Set maximum tolerated downtime (in seconds) for migration.
963 ETEXI
966 .name = "migrate_set_capability",
967 .args_type = "capability:s,state:b",
968 .params = "capability state",
969 .help = "Enable/Disable the usage of a capability for migration",
970 .mhandler.cmd = hmp_migrate_set_capability,
973 STEXI
974 @item migrate_set_capability @var{capability} @var{state}
975 @findex migrate_set_capability
976 Enable/Disable the usage of a capability @var{capability} for migration.
977 ETEXI
980 .name = "client_migrate_info",
981 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
982 .params = "protocol hostname port tls-port cert-subject",
983 .help = "send migration info to spice/vnc client",
984 .user_print = monitor_user_noop,
985 .mhandler.cmd_async = client_migrate_info,
986 .flags = MONITOR_CMD_ASYNC,
989 STEXI
990 @item client_migrate_info @var{protocol} @var{hostname} @var{port} @var{tls-port} @var{cert-subject}
991 @findex client_migrate_info
992 Set the spice/vnc connection info for the migration target. The spice/vnc
993 server will ask the spice/vnc client to automatically reconnect using the
994 new parameters (if specified) once the vm migration finished successfully.
995 ETEXI
997 #if defined(CONFIG_HAVE_CORE_DUMP)
999 .name = "dump-guest-memory",
1000 .args_type = "paging:-p,filename:F,begin:i?,length:i?",
1001 .params = "[-p] filename [begin] [length]",
1002 .help = "dump guest memory to file"
1003 "\n\t\t\t begin(optional): the starting physical address"
1004 "\n\t\t\t length(optional): the memory size, in bytes",
1005 .mhandler.cmd = hmp_dump_guest_memory,
1009 STEXI
1010 @item dump-guest-memory [-p] @var{protocol} @var{begin} @var{length}
1011 @findex dump-guest-memory
1012 Dump guest memory to @var{protocol}. The file can be processed with crash or
1013 gdb.
1014 filename: dump file name
1015 paging: do paging to get guest's memory mapping
1016 begin: the starting physical address. It's optional, and should be
1017 specified with length together.
1018 length: the memory size, in bytes. It's optional, and should be specified
1019 with begin together.
1020 ETEXI
1021 #endif
1024 .name = "snapshot_blkdev",
1025 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1026 .params = "[-n] device [new-image-file] [format]",
1027 .help = "initiates a live snapshot\n\t\t\t"
1028 "of device. If a new image file is specified, the\n\t\t\t"
1029 "new image file will become the new root image.\n\t\t\t"
1030 "If format is specified, the snapshot file will\n\t\t\t"
1031 "be created in that format. Otherwise the\n\t\t\t"
1032 "snapshot will be internal! (currently unsupported).\n\t\t\t"
1033 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1034 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1035 "recreating it from scratch.",
1036 .mhandler.cmd = hmp_snapshot_blkdev,
1039 STEXI
1040 @item snapshot_blkdev
1041 @findex snapshot_blkdev
1042 Snapshot device, using snapshot file as target if provided
1043 ETEXI
1046 .name = "drive_mirror",
1047 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1048 .params = "[-n] [-f] device target [format]",
1049 .help = "initiates live storage\n\t\t\t"
1050 "migration for a device. The device's contents are\n\t\t\t"
1051 "copied to the new image file, including data that\n\t\t\t"
1052 "is written after the command is started.\n\t\t\t"
1053 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1054 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1055 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1056 "so that the result does not need a backing file.\n\t\t\t",
1057 .mhandler.cmd = hmp_drive_mirror,
1059 STEXI
1060 @item drive_mirror
1061 @findex drive_mirror
1062 Start mirroring a block device's writes to a new destination,
1063 using the specified target.
1064 ETEXI
1067 .name = "drive_add",
1068 .args_type = "pci_addr:s,opts:s",
1069 .params = "[[<domain>:]<bus>:]<slot>\n"
1070 "[file=file][,if=type][,bus=n]\n"
1071 "[,unit=m][,media=d][,index=i]\n"
1072 "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
1073 "[,snapshot=on|off][,cache=on|off]\n"
1074 "[,readonly=on|off][,copy-on-read=on|off]",
1075 .help = "add drive to PCI storage controller",
1076 .mhandler.cmd = drive_hot_add,
1079 STEXI
1080 @item drive_add
1081 @findex drive_add
1082 Add drive to PCI storage controller.
1083 ETEXI
1085 #if defined(TARGET_I386)
1087 .name = "pci_add",
1088 .args_type = "pci_addr:s,type:s,opts:s?",
1089 .params = "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...",
1090 .help = "hot-add PCI device",
1091 .mhandler.cmd = pci_device_hot_add,
1093 #endif
1095 STEXI
1096 @item pci_add
1097 @findex pci_add
1098 Hot-add PCI device.
1099 ETEXI
1101 #if defined(TARGET_I386)
1103 .name = "pci_del",
1104 .args_type = "pci_addr:s",
1105 .params = "[[<domain>:]<bus>:]<slot>",
1106 .help = "hot remove PCI device",
1107 .mhandler.cmd = do_pci_device_hot_remove,
1109 #endif
1111 STEXI
1112 @item pci_del
1113 @findex pci_del
1114 Hot remove PCI device.
1115 ETEXI
1118 .name = "pcie_aer_inject_error",
1119 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1120 "id:s,error_status:s,"
1121 "header0:i?,header1:i?,header2:i?,header3:i?,"
1122 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1123 .params = "[-a] [-c] id "
1124 "<error_status> [<tlp header> [<tlp header prefix>]]",
1125 .help = "inject pcie aer error\n\t\t\t"
1126 " -a for advisory non fatal error\n\t\t\t"
1127 " -c for correctable error\n\t\t\t"
1128 "<id> = qdev device id\n\t\t\t"
1129 "<error_status> = error string or 32bit\n\t\t\t"
1130 "<tlb header> = 32bit x 4\n\t\t\t"
1131 "<tlb header prefix> = 32bit x 4",
1132 .user_print = pcie_aer_inject_error_print,
1133 .mhandler.cmd_new = do_pcie_aer_inject_error,
1136 STEXI
1137 @item pcie_aer_inject_error
1138 @findex pcie_aer_inject_error
1139 Inject PCIe AER error
1140 ETEXI
1143 .name = "host_net_add",
1144 .args_type = "device:s,opts:s?",
1145 .params = "tap|user|socket|vde|dump [options]",
1146 .help = "add host VLAN client",
1147 .mhandler.cmd = net_host_device_add,
1150 STEXI
1151 @item host_net_add
1152 @findex host_net_add
1153 Add host VLAN client.
1154 ETEXI
1157 .name = "host_net_remove",
1158 .args_type = "vlan_id:i,device:s",
1159 .params = "vlan_id name",
1160 .help = "remove host VLAN client",
1161 .mhandler.cmd = net_host_device_remove,
1164 STEXI
1165 @item host_net_remove
1166 @findex host_net_remove
1167 Remove host VLAN client.
1168 ETEXI
1171 .name = "netdev_add",
1172 .args_type = "netdev:O",
1173 .params = "[user|tap|socket],id=str[,prop=value][,...]",
1174 .help = "add host network device",
1175 .mhandler.cmd = hmp_netdev_add,
1178 STEXI
1179 @item netdev_add
1180 @findex netdev_add
1181 Add host network device.
1182 ETEXI
1185 .name = "netdev_del",
1186 .args_type = "id:s",
1187 .params = "id",
1188 .help = "remove host network device",
1189 .mhandler.cmd = hmp_netdev_del,
1192 STEXI
1193 @item netdev_del
1194 @findex netdev_del
1195 Remove host network device.
1196 ETEXI
1198 #ifdef CONFIG_SLIRP
1200 .name = "hostfwd_add",
1201 .args_type = "arg1:s,arg2:s?,arg3:s?",
1202 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
1203 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
1204 .mhandler.cmd = net_slirp_hostfwd_add,
1206 #endif
1207 STEXI
1208 @item hostfwd_add
1209 @findex hostfwd_add
1210 Redirect TCP or UDP connections from host to guest (requires -net user).
1211 ETEXI
1213 #ifdef CONFIG_SLIRP
1215 .name = "hostfwd_remove",
1216 .args_type = "arg1:s,arg2:s?,arg3:s?",
1217 .params = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
1218 .help = "remove host-to-guest TCP or UDP redirection",
1219 .mhandler.cmd = net_slirp_hostfwd_remove,
1222 #endif
1223 STEXI
1224 @item hostfwd_remove
1225 @findex hostfwd_remove
1226 Remove host-to-guest TCP or UDP redirection.
1227 ETEXI
1230 .name = "balloon",
1231 .args_type = "value:M",
1232 .params = "target",
1233 .help = "request VM to change its memory allocation (in MB)",
1234 .mhandler.cmd = hmp_balloon,
1237 STEXI
1238 @item balloon @var{value}
1239 @findex balloon
1240 Request VM to change its memory allocation to @var{value} (in MB).
1241 ETEXI
1244 .name = "set_link",
1245 .args_type = "name:s,up:b",
1246 .params = "name on|off",
1247 .help = "change the link status of a network adapter",
1248 .mhandler.cmd = hmp_set_link,
1251 STEXI
1252 @item set_link @var{name} [on|off]
1253 @findex set_link
1254 Switch link @var{name} on (i.e. up) or off (i.e. down).
1255 ETEXI
1258 .name = "watchdog_action",
1259 .args_type = "action:s",
1260 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1261 .help = "change watchdog action",
1262 .mhandler.cmd = do_watchdog_action,
1265 STEXI
1266 @item watchdog_action
1267 @findex watchdog_action
1268 Change watchdog action.
1269 ETEXI
1272 .name = "acl_show",
1273 .args_type = "aclname:s",
1274 .params = "aclname",
1275 .help = "list rules in the access control list",
1276 .mhandler.cmd = do_acl_show,
1279 STEXI
1280 @item acl_show @var{aclname}
1281 @findex acl_show
1282 List all the matching rules in the access control list, and the default
1283 policy. There are currently two named access control lists,
1284 @var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
1285 certificate distinguished name, and SASL username respectively.
1286 ETEXI
1289 .name = "acl_policy",
1290 .args_type = "aclname:s,policy:s",
1291 .params = "aclname allow|deny",
1292 .help = "set default access control list policy",
1293 .mhandler.cmd = do_acl_policy,
1296 STEXI
1297 @item acl_policy @var{aclname} @code{allow|deny}
1298 @findex acl_policy
1299 Set the default access control list policy, used in the event that
1300 none of the explicit rules match. The default policy at startup is
1301 always @code{deny}.
1302 ETEXI
1305 .name = "acl_add",
1306 .args_type = "aclname:s,match:s,policy:s,index:i?",
1307 .params = "aclname match allow|deny [index]",
1308 .help = "add a match rule to the access control list",
1309 .mhandler.cmd = do_acl_add,
1312 STEXI
1313 @item acl_add @var{aclname} @var{match} @code{allow|deny} [@var{index}]
1314 @findex acl_add
1315 Add a match rule to the access control list, allowing or denying access.
1316 The match will normally be an exact username or x509 distinguished name,
1317 but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
1318 allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
1319 normally be appended to the end of the ACL, but can be inserted
1320 earlier in the list if the optional @var{index} parameter is supplied.
1321 ETEXI
1324 .name = "acl_remove",
1325 .args_type = "aclname:s,match:s",
1326 .params = "aclname match",
1327 .help = "remove a match rule from the access control list",
1328 .mhandler.cmd = do_acl_remove,
1331 STEXI
1332 @item acl_remove @var{aclname} @var{match}
1333 @findex acl_remove
1334 Remove the specified match rule from the access control list.
1335 ETEXI
1338 .name = "acl_reset",
1339 .args_type = "aclname:s",
1340 .params = "aclname",
1341 .help = "reset the access control list",
1342 .mhandler.cmd = do_acl_reset,
1345 STEXI
1346 @item acl_reset @var{aclname}
1347 @findex acl_reset
1348 Remove all matches from the access control list, and set the default
1349 policy back to @code{deny}.
1350 ETEXI
1353 .name = "nbd_server_start",
1354 .args_type = "all:-a,writable:-w,uri:s",
1355 .params = "nbd_server_start [-a] [-w] host:port",
1356 .help = "serve block devices on the given host and port",
1357 .mhandler.cmd = hmp_nbd_server_start,
1359 STEXI
1360 @item nbd_server_start @var{host}:@var{port}
1361 @findex nbd_server_start
1362 Start an NBD server on the given host and/or port. If the @option{-a}
1363 option is included, all of the virtual machine's block devices that
1364 have an inserted media on them are automatically exported; in this case,
1365 the @option{-w} option makes the devices writable too.
1366 ETEXI
1369 .name = "nbd_server_add",
1370 .args_type = "writable:-w,device:B",
1371 .params = "nbd_server_add [-w] device",
1372 .help = "export a block device via NBD",
1373 .mhandler.cmd = hmp_nbd_server_add,
1375 STEXI
1376 @item nbd_server_add @var{device}
1377 @findex nbd_server_add
1378 Export a block device through QEMU's NBD server, which must be started
1379 beforehand with @command{nbd_server_start}. The @option{-w} option makes the
1380 exported device writable too.
1381 ETEXI
1384 .name = "nbd_server_stop",
1385 .args_type = "",
1386 .params = "nbd_server_stop",
1387 .help = "stop serving block devices using the NBD protocol",
1388 .mhandler.cmd = hmp_nbd_server_stop,
1390 STEXI
1391 @item nbd_server_stop
1392 @findex nbd_server_stop
1393 Stop the QEMU embedded NBD server.
1394 ETEXI
1397 #if defined(TARGET_I386)
1400 .name = "mce",
1401 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1402 .params = "[-b] cpu bank status mcgstatus addr misc",
1403 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
1404 .mhandler.cmd = do_inject_mce,
1407 #endif
1408 STEXI
1409 @item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
1410 @findex mce (x86)
1411 Inject an MCE on the given CPU (x86 only).
1412 ETEXI
1415 .name = "getfd",
1416 .args_type = "fdname:s",
1417 .params = "getfd name",
1418 .help = "receive a file descriptor via SCM rights and assign it a name",
1419 .mhandler.cmd = hmp_getfd,
1422 STEXI
1423 @item getfd @var{fdname}
1424 @findex getfd
1425 If a file descriptor is passed alongside this command using the SCM_RIGHTS
1426 mechanism on unix sockets, it is stored using the name @var{fdname} for
1427 later use by other monitor commands.
1428 ETEXI
1431 .name = "closefd",
1432 .args_type = "fdname:s",
1433 .params = "closefd name",
1434 .help = "close a file descriptor previously passed via SCM rights",
1435 .mhandler.cmd = hmp_closefd,
1438 STEXI
1439 @item closefd @var{fdname}
1440 @findex closefd
1441 Close the file descriptor previously assigned to @var{fdname} using the
1442 @code{getfd} command. This is only needed if the file descriptor was never
1443 used by another monitor command.
1444 ETEXI
1447 .name = "block_passwd",
1448 .args_type = "device:B,password:s",
1449 .params = "block_passwd device password",
1450 .help = "set the password of encrypted block devices",
1451 .mhandler.cmd = hmp_block_passwd,
1454 STEXI
1455 @item block_set_io_throttle @var{device} @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1456 @findex block_set_io_throttle
1457 Change I/O throttle limits for a block drive to @var{bps} @var{bps_rd} @var{bps_wr} @var{iops} @var{iops_rd} @var{iops_wr}
1458 ETEXI
1461 .name = "block_set_io_throttle",
1462 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1463 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1464 .help = "change I/O throttle limits for a block drive",
1465 .mhandler.cmd = hmp_block_set_io_throttle,
1468 STEXI
1469 @item block_passwd @var{device} @var{password}
1470 @findex block_passwd
1471 Set the encrypted device @var{device} password to @var{password}
1472 ETEXI
1475 .name = "set_password",
1476 .args_type = "protocol:s,password:s,connected:s?",
1477 .params = "protocol password action-if-connected",
1478 .help = "set spice/vnc password",
1479 .mhandler.cmd = hmp_set_password,
1482 STEXI
1483 @item set_password [ vnc | spice ] password [ action-if-connected ]
1484 @findex set_password
1486 Change spice/vnc password. Use zero to make the password stay valid
1487 forever. @var{action-if-connected} specifies what should happen in
1488 case a connection is established: @var{fail} makes the password change
1489 fail. @var{disconnect} changes the password and disconnects the
1490 client. @var{keep} changes the password and keeps the connection up.
1491 @var{keep} is the default.
1492 ETEXI
1495 .name = "expire_password",
1496 .args_type = "protocol:s,time:s",
1497 .params = "protocol time",
1498 .help = "set spice/vnc password expire-time",
1499 .mhandler.cmd = hmp_expire_password,
1502 STEXI
1503 @item expire_password [ vnc | spice ] expire-time
1504 @findex expire_password
1506 Specify when a password for spice/vnc becomes
1507 invalid. @var{expire-time} accepts:
1509 @table @var
1510 @item now
1511 Invalidate password instantly.
1513 @item never
1514 Password stays valid forever.
1516 @item +nsec
1517 Password stays valid for @var{nsec} seconds starting now.
1519 @item nsec
1520 Password is invalidated at the given time. @var{nsec} are the seconds
1521 passed since 1970, i.e. unix epoch.
1523 @end table
1524 ETEXI
1527 .name = "chardev-add",
1528 .args_type = "args:s",
1529 .params = "args",
1530 .help = "add chardev",
1531 .mhandler.cmd = hmp_chardev_add,
1534 STEXI
1535 @item chardev_add args
1536 @findex chardev_add
1538 chardev_add accepts the same parameters as the -chardev command line switch.
1540 ETEXI
1543 .name = "chardev-remove",
1544 .args_type = "id:s",
1545 .params = "id",
1546 .help = "remove chardev",
1547 .mhandler.cmd = hmp_chardev_remove,
1550 STEXI
1551 @item chardev_remove id
1552 @findex chardev_remove
1554 Removes the chardev @var{id}.
1556 ETEXI
1559 .name = "info",
1560 .args_type = "item:s?",
1561 .params = "[subcommand]",
1562 .help = "show various information about the system state",
1563 .mhandler.cmd = do_info_help,
1564 .sub_table = info_cmds,
1567 STEXI
1568 @item info @var{subcommand}
1569 @findex info
1570 Show various information about the system state.
1572 @table @option
1573 @item info version
1574 show the version of QEMU
1575 @item info network
1576 show the various VLANs and the associated devices
1577 @item info chardev
1578 show the character devices
1579 @item info block
1580 show the block devices
1581 @item info blockstats
1582 show block device statistics
1583 @item info registers
1584 show the cpu registers
1585 @item info cpus
1586 show infos for each CPU
1587 @item info history
1588 show the command line history
1589 @item info irq
1590 show the interrupts statistics (if available)
1591 @item info pic
1592 show i8259 (PIC) state
1593 @item info pci
1594 show emulated PCI device info
1595 @item info tlb
1596 show virtual to physical memory mappings (i386, SH4, SPARC, PPC, and Xtensa only)
1597 @item info mem
1598 show the active virtual memory mappings (i386 only)
1599 @item info jit
1600 show dynamic compiler info
1601 @item info numa
1602 show NUMA information
1603 @item info kvm
1604 show KVM information
1605 @item info usb
1606 show USB devices plugged on the virtual USB hub
1607 @item info usbhost
1608 show all USB host devices
1609 @item info profile
1610 show profiling information
1611 @item info capture
1612 show information about active capturing
1613 @item info snapshots
1614 show list of VM snapshots
1615 @item info status
1616 show the current VM status (running|paused)
1617 @item info pcmcia
1618 show guest PCMCIA status
1619 @item info mice
1620 show which guest mouse is receiving events
1621 @item info vnc
1622 show the vnc server status
1623 @item info name
1624 show the current VM name
1625 @item info uuid
1626 show the current VM UUID
1627 @item info cpustats
1628 show CPU statistics
1629 @item info usernet
1630 show user network stack connection states
1631 @item info migrate
1632 show migration status
1633 @item info migrate_capabilities
1634 show current migration capabilities
1635 @item info migrate_cache_size
1636 show current migration XBZRLE cache size
1637 @item info balloon
1638 show balloon information
1639 @item info qtree
1640 show device tree
1641 @item info qdm
1642 show qdev device model list
1643 @item info roms
1644 show roms
1645 @end table
1646 ETEXI
1648 STEXI
1649 @item info trace-events
1650 show available trace events and their state
1651 ETEXI
1653 STEXI
1654 @end table
1655 ETEXI