Statistics
| Branch: | Revision:

root / qemu-monitor.hx @ 43076664

History | View | Annotate | Download (26.3 kB)

1 2313086a Blue Swirl
HXCOMM Use DEFHEADING() to define headings in both help text and texi
2 2313086a Blue Swirl
HXCOMM Text between STEXI and ETEXI are copied to texi version and
3 2313086a Blue Swirl
HXCOMM discarded from C version
4 2313086a Blue Swirl
HXCOMM DEF(command, args, callback, arg_string, help) is used to construct
5 2313086a Blue Swirl
HXCOMM monitor commands
6 2313086a Blue Swirl
HXCOMM HXCOMM can be used for comments, discarded from both texi and C
7 2313086a Blue Swirl
8 2313086a Blue Swirl
STEXI
9 2313086a Blue Swirl
@table @option
10 2313086a Blue Swirl
ETEXI
11 2313086a Blue Swirl
12 d7f9b689 Luiz Capitulino
    {
13 d7f9b689 Luiz Capitulino
        .name       = "help|?",
14 d7f9b689 Luiz Capitulino
        .args_type  = "name:s?",
15 d7f9b689 Luiz Capitulino
        .params     = "[cmd]",
16 d7f9b689 Luiz Capitulino
        .help       = "show the help",
17 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_help_cmd,
18 d7f9b689 Luiz Capitulino
    },
19 d7f9b689 Luiz Capitulino
20 2313086a Blue Swirl
STEXI
21 2313086a Blue Swirl
@item help or ? [@var{cmd}]
22 2313086a Blue Swirl
Show the help for all commands or just for command @var{cmd}.
23 2313086a Blue Swirl
ETEXI
24 2313086a Blue Swirl
25 d7f9b689 Luiz Capitulino
    {
26 d7f9b689 Luiz Capitulino
        .name       = "commit",
27 d7f9b689 Luiz Capitulino
        .args_type  = "device:B",
28 d7f9b689 Luiz Capitulino
        .params     = "device|all",
29 d7f9b689 Luiz Capitulino
        .help       = "commit changes to the disk images (if -snapshot is used) or backing files",
30 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_commit,
31 d7f9b689 Luiz Capitulino
    },
32 d7f9b689 Luiz Capitulino
33 2313086a Blue Swirl
STEXI
34 2313086a Blue Swirl
@item commit
35 2313086a Blue Swirl
Commit changes to the disk images (if -snapshot is used) or backing files.
36 2313086a Blue Swirl
ETEXI
37 2313086a Blue Swirl
38 d7f9b689 Luiz Capitulino
    {
39 d7f9b689 Luiz Capitulino
        .name       = "info",
40 d7f9b689 Luiz Capitulino
        .args_type  = "item:s?",
41 d7f9b689 Luiz Capitulino
        .params     = "[subcommand]",
42 d7f9b689 Luiz Capitulino
        .help       = "show various information about the system state",
43 13c7425e Luiz Capitulino
        .user_print = monitor_user_noop,
44 13c7425e Luiz Capitulino
        .mhandler.cmd_new = do_info,
45 d7f9b689 Luiz Capitulino
    },
46 d7f9b689 Luiz Capitulino
47 2313086a Blue Swirl
STEXI
48 2313086a Blue Swirl
@item info @var{subcommand}
49 2313086a Blue Swirl
Show various information about the system state.
50 2313086a Blue Swirl
51 2313086a Blue Swirl
@table @option
52 2313086a Blue Swirl
@item info version
53 2313086a Blue Swirl
show the version of QEMU
54 2313086a Blue Swirl
@item info network
55 2313086a Blue Swirl
show the various VLANs and the associated devices
56 2313086a Blue Swirl
@item info chardev
57 2313086a Blue Swirl
show the character devices
58 2313086a Blue Swirl
@item info block
59 2313086a Blue Swirl
show the block devices
60 2313086a Blue Swirl
@item info block
61 2313086a Blue Swirl
show block device statistics
62 2313086a Blue Swirl
@item info registers
63 2313086a Blue Swirl
show the cpu registers
64 2313086a Blue Swirl
@item info cpus
65 2313086a Blue Swirl
show infos for each CPU
66 2313086a Blue Swirl
@item info history
67 2313086a Blue Swirl
show the command line history
68 2313086a Blue Swirl
@item info irq
69 2313086a Blue Swirl
show the interrupts statistics (if available)
70 2313086a Blue Swirl
@item info pic
71 2313086a Blue Swirl
show i8259 (PIC) state
72 2313086a Blue Swirl
@item info pci
73 2313086a Blue Swirl
show emulated PCI device info
74 2313086a Blue Swirl
@item info tlb
75 2313086a Blue Swirl
show virtual to physical memory mappings (i386 only)
76 2313086a Blue Swirl
@item info mem
77 2313086a Blue Swirl
show the active virtual memory mappings (i386 only)
78 2313086a Blue Swirl
@item info hpet
79 2313086a Blue Swirl
show state of HPET (i386 only)
80 2313086a Blue Swirl
@item info kvm
81 2313086a Blue Swirl
show KVM information
82 2313086a Blue Swirl
@item info usb
83 2313086a Blue Swirl
show USB devices plugged on the virtual USB hub
84 2313086a Blue Swirl
@item info usbhost
85 2313086a Blue Swirl
show all USB host devices
86 2313086a Blue Swirl
@item info profile
87 2313086a Blue Swirl
show profiling information
88 2313086a Blue Swirl
@item info capture
89 2313086a Blue Swirl
show information about active capturing
90 2313086a Blue Swirl
@item info snapshots
91 2313086a Blue Swirl
show list of VM snapshots
92 2313086a Blue Swirl
@item info status
93 2313086a Blue Swirl
show the current VM status (running|paused)
94 2313086a Blue Swirl
@item info pcmcia
95 2313086a Blue Swirl
show guest PCMCIA status
96 2313086a Blue Swirl
@item info mice
97 2313086a Blue Swirl
show which guest mouse is receiving events
98 2313086a Blue Swirl
@item info vnc
99 2313086a Blue Swirl
show the vnc server status
100 2313086a Blue Swirl
@item info name
101 2313086a Blue Swirl
show the current VM name
102 2313086a Blue Swirl
@item info uuid
103 2313086a Blue Swirl
show the current VM UUID
104 2313086a Blue Swirl
@item info cpustats
105 2313086a Blue Swirl
show CPU statistics
106 6dbe553f Jan Kiszka
@item info usernet
107 6dbe553f Jan Kiszka
show user network stack connection states
108 2313086a Blue Swirl
@item info migrate
109 2313086a Blue Swirl
show migration status
110 2313086a Blue Swirl
@item info balloon
111 2313086a Blue Swirl
show balloon information
112 2313086a Blue Swirl
@item info qtree
113 2313086a Blue Swirl
show device tree
114 2313086a Blue Swirl
@end table
115 2313086a Blue Swirl
ETEXI
116 2313086a Blue Swirl
117 d7f9b689 Luiz Capitulino
    {
118 d7f9b689 Luiz Capitulino
        .name       = "q|quit",
119 d7f9b689 Luiz Capitulino
        .args_type  = "",
120 d7f9b689 Luiz Capitulino
        .params     = "",
121 d7f9b689 Luiz Capitulino
        .help       = "quit the emulator",
122 b223f35f Luiz Capitulino
        .user_print = monitor_user_noop,
123 b223f35f Luiz Capitulino
        .mhandler.cmd_new = do_quit,
124 d7f9b689 Luiz Capitulino
    },
125 d7f9b689 Luiz Capitulino
126 2313086a Blue Swirl
STEXI
127 2313086a Blue Swirl
@item q or quit
128 2313086a Blue Swirl
Quit the emulator.
129 2313086a Blue Swirl
ETEXI
130 2313086a Blue Swirl
131 d7f9b689 Luiz Capitulino
    {
132 d7f9b689 Luiz Capitulino
        .name       = "eject",
133 d7f9b689 Luiz Capitulino
        .args_type  = "force:-f,filename:B",
134 d7f9b689 Luiz Capitulino
        .params     = "[-f] device",
135 d7f9b689 Luiz Capitulino
        .help       = "eject a removable medium (use -f to force it)",
136 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_eject,
137 d7f9b689 Luiz Capitulino
    },
138 d7f9b689 Luiz Capitulino
139 2313086a Blue Swirl
STEXI
140 2313086a Blue Swirl
@item eject [-f] @var{device}
141 2313086a Blue Swirl
Eject a removable medium (use -f to force it).
142 2313086a Blue Swirl
ETEXI
143 2313086a Blue Swirl
144 d7f9b689 Luiz Capitulino
    {
145 d7f9b689 Luiz Capitulino
        .name       = "change",
146 d7f9b689 Luiz Capitulino
        .args_type  = "device:B,target:F,arg:s?",
147 d7f9b689 Luiz Capitulino
        .params     = "device filename [format]",
148 d7f9b689 Luiz Capitulino
        .help       = "change a removable medium, optional format",
149 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_change,
150 d7f9b689 Luiz Capitulino
    },
151 d7f9b689 Luiz Capitulino
152 2313086a Blue Swirl
STEXI
153 2313086a Blue Swirl
@item change @var{device} @var{setting}
154 2313086a Blue Swirl
155 2313086a Blue Swirl
Change the configuration of a device.
156 2313086a Blue Swirl
157 2313086a Blue Swirl
@table @option
158 2313086a Blue Swirl
@item change @var{diskdevice} @var{filename} [@var{format}]
159 2313086a Blue Swirl
Change the medium for a removable disk device to point to @var{filename}. eg
160 2313086a Blue Swirl
161 2313086a Blue Swirl
@example
162 2313086a Blue Swirl
(qemu) change ide1-cd0 /path/to/some.iso
163 2313086a Blue Swirl
@end example
164 2313086a Blue Swirl
165 2313086a Blue Swirl
@var{format} is optional.
166 2313086a Blue Swirl
167 2313086a Blue Swirl
@item change vnc @var{display},@var{options}
168 2313086a Blue Swirl
Change the configuration of the VNC server. The valid syntax for @var{display}
169 2313086a Blue Swirl
and @var{options} are described at @ref{sec_invocation}. eg
170 2313086a Blue Swirl
171 2313086a Blue Swirl
@example
172 2313086a Blue Swirl
(qemu) change vnc localhost:1
173 2313086a Blue Swirl
@end example
174 2313086a Blue Swirl
175 2313086a Blue Swirl
@item change vnc password [@var{password}]
176 2313086a Blue Swirl
177 2313086a Blue Swirl
Change the password associated with the VNC server. If the new password is not
178 2313086a Blue Swirl
supplied, the monitor will prompt for it to be entered. VNC passwords are only
179 2313086a Blue Swirl
significant up to 8 letters. eg
180 2313086a Blue Swirl
181 2313086a Blue Swirl
@example
182 2313086a Blue Swirl
(qemu) change vnc password
183 2313086a Blue Swirl
Password: ********
184 2313086a Blue Swirl
@end example
185 2313086a Blue Swirl
186 2313086a Blue Swirl
@end table
187 2313086a Blue Swirl
ETEXI
188 2313086a Blue Swirl
189 d7f9b689 Luiz Capitulino
    {
190 d7f9b689 Luiz Capitulino
        .name       = "screendump",
191 d7f9b689 Luiz Capitulino
        .args_type  = "filename:F",
192 d7f9b689 Luiz Capitulino
        .params     = "filename",
193 d7f9b689 Luiz Capitulino
        .help       = "save screen into PPM image 'filename'",
194 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_screen_dump,
195 d7f9b689 Luiz Capitulino
    },
196 d7f9b689 Luiz Capitulino
197 2313086a Blue Swirl
STEXI
198 2313086a Blue Swirl
@item screendump @var{filename}
199 2313086a Blue Swirl
Save screen into PPM image @var{filename}.
200 2313086a Blue Swirl
ETEXI
201 2313086a Blue Swirl
202 d7f9b689 Luiz Capitulino
    {
203 d7f9b689 Luiz Capitulino
        .name       = "logfile",
204 d7f9b689 Luiz Capitulino
        .args_type  = "filename:F",
205 d7f9b689 Luiz Capitulino
        .params     = "filename",
206 d7f9b689 Luiz Capitulino
        .help       = "output logs to 'filename'",
207 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_logfile,
208 d7f9b689 Luiz Capitulino
    },
209 d7f9b689 Luiz Capitulino
210 2313086a Blue Swirl
STEXI
211 2313086a Blue Swirl
@item logfile @var{filename}
212 2313086a Blue Swirl
Output logs to @var{filename}.
213 2313086a Blue Swirl
ETEXI
214 2313086a Blue Swirl
215 d7f9b689 Luiz Capitulino
    {
216 d7f9b689 Luiz Capitulino
        .name       = "log",
217 d7f9b689 Luiz Capitulino
        .args_type  = "items:s",
218 d7f9b689 Luiz Capitulino
        .params     = "item1[,...]",
219 d7f9b689 Luiz Capitulino
        .help       = "activate logging of the specified items to '/tmp/qemu.log'",
220 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_log,
221 d7f9b689 Luiz Capitulino
    },
222 d7f9b689 Luiz Capitulino
223 2313086a Blue Swirl
STEXI
224 2313086a Blue Swirl
@item log @var{item1}[,...]
225 2313086a Blue Swirl
Activate logging of the specified items to @file{/tmp/qemu.log}.
226 2313086a Blue Swirl
ETEXI
227 2313086a Blue Swirl
228 d7f9b689 Luiz Capitulino
    {
229 d7f9b689 Luiz Capitulino
        .name       = "savevm",
230 d7f9b689 Luiz Capitulino
        .args_type  = "name:s?",
231 d7f9b689 Luiz Capitulino
        .params     = "[tag|id]",
232 d7f9b689 Luiz Capitulino
        .help       = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
233 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_savevm,
234 d7f9b689 Luiz Capitulino
    },
235 d7f9b689 Luiz Capitulino
236 2313086a Blue Swirl
STEXI
237 2313086a Blue Swirl
@item savevm [@var{tag}|@var{id}]
238 2313086a Blue Swirl
Create a snapshot of the whole virtual machine. If @var{tag} is
239 2313086a Blue Swirl
provided, it is used as human readable identifier. If there is already
240 2313086a Blue Swirl
a snapshot with the same tag or ID, it is replaced. More info at
241 2313086a Blue Swirl
@ref{vm_snapshots}.
242 2313086a Blue Swirl
ETEXI
243 2313086a Blue Swirl
244 d7f9b689 Luiz Capitulino
    {
245 d7f9b689 Luiz Capitulino
        .name       = "loadvm",
246 d7f9b689 Luiz Capitulino
        .args_type  = "name:s",
247 d7f9b689 Luiz Capitulino
        .params     = "tag|id",
248 d7f9b689 Luiz Capitulino
        .help       = "restore a VM snapshot from its tag or id",
249 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_loadvm,
250 d7f9b689 Luiz Capitulino
    },
251 d7f9b689 Luiz Capitulino
252 2313086a Blue Swirl
STEXI
253 2313086a Blue Swirl
@item loadvm @var{tag}|@var{id}
254 2313086a Blue Swirl
Set the whole virtual machine to the snapshot identified by the tag
255 2313086a Blue Swirl
@var{tag} or the unique snapshot ID @var{id}.
256 2313086a Blue Swirl
ETEXI
257 2313086a Blue Swirl
258 d7f9b689 Luiz Capitulino
    {
259 d7f9b689 Luiz Capitulino
        .name       = "delvm",
260 d7f9b689 Luiz Capitulino
        .args_type  = "name:s",
261 d7f9b689 Luiz Capitulino
        .params     = "tag|id",
262 d7f9b689 Luiz Capitulino
        .help       = "delete a VM snapshot from its tag or id",
263 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_delvm,
264 d7f9b689 Luiz Capitulino
    },
265 d7f9b689 Luiz Capitulino
266 2313086a Blue Swirl
STEXI
267 2313086a Blue Swirl
@item delvm @var{tag}|@var{id}
268 2313086a Blue Swirl
Delete the snapshot identified by @var{tag} or @var{id}.
269 2313086a Blue Swirl
ETEXI
270 2313086a Blue Swirl
271 d7f9b689 Luiz Capitulino
    {
272 d7f9b689 Luiz Capitulino
        .name       = "singlestep",
273 d7f9b689 Luiz Capitulino
        .args_type  = "option:s?",
274 d7f9b689 Luiz Capitulino
        .params     = "[on|off]",
275 d7f9b689 Luiz Capitulino
        .help       = "run emulation in singlestep mode or switch to normal mode",
276 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_singlestep,
277 d7f9b689 Luiz Capitulino
    },
278 d7f9b689 Luiz Capitulino
279 2313086a Blue Swirl
STEXI
280 2313086a Blue Swirl
@item singlestep [off]
281 2313086a Blue Swirl
Run the emulation in single step mode.
282 2313086a Blue Swirl
If called with option off, the emulation returns to normal mode.
283 2313086a Blue Swirl
ETEXI
284 2313086a Blue Swirl
285 d7f9b689 Luiz Capitulino
    {
286 d7f9b689 Luiz Capitulino
        .name       = "stop",
287 d7f9b689 Luiz Capitulino
        .args_type  = "",
288 d7f9b689 Luiz Capitulino
        .params     = "",
289 d7f9b689 Luiz Capitulino
        .help       = "stop emulation",
290 e0c97bde Luiz Capitulino
        .user_print = monitor_user_noop,
291 e0c97bde Luiz Capitulino
        .mhandler.cmd_new = do_stop,
292 d7f9b689 Luiz Capitulino
    },
293 d7f9b689 Luiz Capitulino
294 2313086a Blue Swirl
STEXI
295 2313086a Blue Swirl
@item stop
296 2313086a Blue Swirl
Stop emulation.
297 2313086a Blue Swirl
ETEXI
298 2313086a Blue Swirl
299 d7f9b689 Luiz Capitulino
    {
300 d7f9b689 Luiz Capitulino
        .name       = "c|cont",
301 d7f9b689 Luiz Capitulino
        .args_type  = "",
302 d7f9b689 Luiz Capitulino
        .params     = "",
303 d7f9b689 Luiz Capitulino
        .help       = "resume emulation",
304 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_cont,
305 d7f9b689 Luiz Capitulino
    },
306 d7f9b689 Luiz Capitulino
307 2313086a Blue Swirl
STEXI
308 2313086a Blue Swirl
@item c or cont
309 2313086a Blue Swirl
Resume emulation.
310 2313086a Blue Swirl
ETEXI
311 2313086a Blue Swirl
312 d7f9b689 Luiz Capitulino
    {
313 d7f9b689 Luiz Capitulino
        .name       = "gdbserver",
314 d7f9b689 Luiz Capitulino
        .args_type  = "device:s?",
315 d7f9b689 Luiz Capitulino
        .params     = "[device]",
316 d7f9b689 Luiz Capitulino
        .help       = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
317 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_gdbserver,
318 d7f9b689 Luiz Capitulino
    },
319 d7f9b689 Luiz Capitulino
320 2313086a Blue Swirl
STEXI
321 2313086a Blue Swirl
@item gdbserver [@var{port}]
322 2313086a Blue Swirl
Start gdbserver session (default @var{port}=1234)
323 2313086a Blue Swirl
ETEXI
324 2313086a Blue Swirl
325 d7f9b689 Luiz Capitulino
    {
326 d7f9b689 Luiz Capitulino
        .name       = "x",
327 d7f9b689 Luiz Capitulino
        .args_type  = "fmt:/,addr:l",
328 d7f9b689 Luiz Capitulino
        .params     = "/fmt addr",
329 d7f9b689 Luiz Capitulino
        .help       = "virtual memory dump starting at 'addr'",
330 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_memory_dump,
331 d7f9b689 Luiz Capitulino
    },
332 d7f9b689 Luiz Capitulino
333 2313086a Blue Swirl
STEXI
334 2313086a Blue Swirl
@item x/fmt @var{addr}
335 2313086a Blue Swirl
Virtual memory dump starting at @var{addr}.
336 2313086a Blue Swirl
ETEXI
337 2313086a Blue Swirl
338 d7f9b689 Luiz Capitulino
    {
339 d7f9b689 Luiz Capitulino
        .name       = "xp",
340 d7f9b689 Luiz Capitulino
        .args_type  = "fmt:/,addr:l",
341 d7f9b689 Luiz Capitulino
        .params     = "/fmt addr",
342 d7f9b689 Luiz Capitulino
        .help       = "physical memory dump starting at 'addr'",
343 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_physical_memory_dump,
344 d7f9b689 Luiz Capitulino
    },
345 d7f9b689 Luiz Capitulino
346 2313086a Blue Swirl
STEXI
347 2313086a Blue Swirl
@item xp /@var{fmt} @var{addr}
348 2313086a Blue Swirl
Physical memory dump starting at @var{addr}.
349 2313086a Blue Swirl
350 2313086a Blue Swirl
@var{fmt} is a format which tells the command how to format the
351 2313086a Blue Swirl
data. Its syntax is: @option{/@{count@}@{format@}@{size@}}
352 2313086a Blue Swirl
353 2313086a Blue Swirl
@table @var
354 2313086a Blue Swirl
@item count
355 2313086a Blue Swirl
is the number of items to be dumped.
356 2313086a Blue Swirl
357 2313086a Blue Swirl
@item format
358 2313086a Blue Swirl
can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
359 2313086a Blue Swirl
c (char) or i (asm instruction).
360 2313086a Blue Swirl
361 2313086a Blue Swirl
@item size
362 2313086a Blue Swirl
can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
363 2313086a Blue Swirl
@code{h} or @code{w} can be specified with the @code{i} format to
364 2313086a Blue Swirl
respectively select 16 or 32 bit code instruction size.
365 2313086a Blue Swirl
366 2313086a Blue Swirl
@end table
367 2313086a Blue Swirl
368 2313086a Blue Swirl
Examples:
369 2313086a Blue Swirl
@itemize
370 2313086a Blue Swirl
@item
371 2313086a Blue Swirl
Dump 10 instructions at the current instruction pointer:
372 2313086a Blue Swirl
@example
373 2313086a Blue Swirl
(qemu) x/10i $eip
374 2313086a Blue Swirl
0x90107063:  ret
375 2313086a Blue Swirl
0x90107064:  sti
376 2313086a Blue Swirl
0x90107065:  lea    0x0(%esi,1),%esi
377 2313086a Blue Swirl
0x90107069:  lea    0x0(%edi,1),%edi
378 2313086a Blue Swirl
0x90107070:  ret
379 2313086a Blue Swirl
0x90107071:  jmp    0x90107080
380 2313086a Blue Swirl
0x90107073:  nop
381 2313086a Blue Swirl
0x90107074:  nop
382 2313086a Blue Swirl
0x90107075:  nop
383 2313086a Blue Swirl
0x90107076:  nop
384 2313086a Blue Swirl
@end example
385 2313086a Blue Swirl
386 2313086a Blue Swirl
@item
387 2313086a Blue Swirl
Dump 80 16 bit values at the start of the video memory.
388 2313086a Blue Swirl
@smallexample
389 2313086a Blue Swirl
(qemu) xp/80hx 0xb8000
390 2313086a Blue Swirl
0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
391 2313086a Blue Swirl
0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
392 2313086a Blue Swirl
0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
393 2313086a Blue Swirl
0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
394 2313086a Blue Swirl
0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
395 2313086a Blue Swirl
0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
396 2313086a Blue Swirl
0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
397 2313086a Blue Swirl
0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
398 2313086a Blue Swirl
0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
399 2313086a Blue Swirl
0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
400 2313086a Blue Swirl
@end smallexample
401 2313086a Blue Swirl
@end itemize
402 2313086a Blue Swirl
ETEXI
403 2313086a Blue Swirl
404 d7f9b689 Luiz Capitulino
    {
405 d7f9b689 Luiz Capitulino
        .name       = "p|print",
406 d7f9b689 Luiz Capitulino
        .args_type  = "fmt:/,val:l",
407 d7f9b689 Luiz Capitulino
        .params     = "/fmt expr",
408 d7f9b689 Luiz Capitulino
        .help       = "print expression value (use $reg for CPU register access)",
409 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_print,
410 d7f9b689 Luiz Capitulino
    },
411 d7f9b689 Luiz Capitulino
412 2313086a Blue Swirl
STEXI
413 2313086a Blue Swirl
@item p or print/@var{fmt} @var{expr}
414 2313086a Blue Swirl
415 2313086a Blue Swirl
Print expression value. Only the @var{format} part of @var{fmt} is
416 2313086a Blue Swirl
used.
417 2313086a Blue Swirl
ETEXI
418 2313086a Blue Swirl
419 d7f9b689 Luiz Capitulino
    {
420 d7f9b689 Luiz Capitulino
        .name       = "i",
421 d7f9b689 Luiz Capitulino
        .args_type  = "fmt:/,addr:i,index:i.",
422 d7f9b689 Luiz Capitulino
        .params     = "/fmt addr",
423 d7f9b689 Luiz Capitulino
        .help       = "I/O port read",
424 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_ioport_read,
425 d7f9b689 Luiz Capitulino
    },
426 d7f9b689 Luiz Capitulino
427 2313086a Blue Swirl
STEXI
428 2313086a Blue Swirl
Read I/O port.
429 2313086a Blue Swirl
ETEXI
430 2313086a Blue Swirl
431 d7f9b689 Luiz Capitulino
    {
432 d7f9b689 Luiz Capitulino
        .name       = "o",
433 d7f9b689 Luiz Capitulino
        .args_type  = "fmt:/,addr:i,val:i",
434 d7f9b689 Luiz Capitulino
        .params     = "/fmt addr value",
435 d7f9b689 Luiz Capitulino
        .help       = "I/O port write",
436 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_ioport_write,
437 d7f9b689 Luiz Capitulino
    },
438 d7f9b689 Luiz Capitulino
439 f114784f Jan Kiszka
STEXI
440 f114784f Jan Kiszka
Write to I/O port.
441 f114784f Jan Kiszka
ETEXI
442 2313086a Blue Swirl
443 d7f9b689 Luiz Capitulino
    {
444 d7f9b689 Luiz Capitulino
        .name       = "sendkey",
445 d7f9b689 Luiz Capitulino
        .args_type  = "string:s,hold_time:i?",
446 d7f9b689 Luiz Capitulino
        .params     = "keys [hold_ms]",
447 d7f9b689 Luiz Capitulino
        .help       = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
448 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_sendkey,
449 d7f9b689 Luiz Capitulino
    },
450 d7f9b689 Luiz Capitulino
451 2313086a Blue Swirl
STEXI
452 2313086a Blue Swirl
@item sendkey @var{keys}
453 2313086a Blue Swirl
454 2313086a Blue Swirl
Send @var{keys} to the emulator. @var{keys} could be the name of the
455 2313086a Blue Swirl
key or @code{#} followed by the raw value in either decimal or hexadecimal
456 2313086a Blue Swirl
format. Use @code{-} to press several keys simultaneously. Example:
457 2313086a Blue Swirl
@example
458 2313086a Blue Swirl
sendkey ctrl-alt-f1
459 2313086a Blue Swirl
@end example
460 2313086a Blue Swirl
461 2313086a Blue Swirl
This command is useful to send keys that your graphical user interface
462 2313086a Blue Swirl
intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
463 2313086a Blue Swirl
ETEXI
464 2313086a Blue Swirl
465 d7f9b689 Luiz Capitulino
    {
466 d7f9b689 Luiz Capitulino
        .name       = "system_reset",
467 d7f9b689 Luiz Capitulino
        .args_type  = "",
468 d7f9b689 Luiz Capitulino
        .params     = "",
469 d7f9b689 Luiz Capitulino
        .help       = "reset the system",
470 c80d259e Luiz Capitulino
        .user_print = monitor_user_noop,
471 c80d259e Luiz Capitulino
        .mhandler.cmd_new = do_system_reset,
472 d7f9b689 Luiz Capitulino
    },
473 d7f9b689 Luiz Capitulino
474 2313086a Blue Swirl
STEXI
475 2313086a Blue Swirl
@item system_reset
476 2313086a Blue Swirl
477 2313086a Blue Swirl
Reset the system.
478 2313086a Blue Swirl
ETEXI
479 2313086a Blue Swirl
480 d7f9b689 Luiz Capitulino
    {
481 d7f9b689 Luiz Capitulino
        .name       = "system_powerdown",
482 d7f9b689 Luiz Capitulino
        .args_type  = "",
483 d7f9b689 Luiz Capitulino
        .params     = "",
484 d7f9b689 Luiz Capitulino
        .help       = "send system power down event",
485 43076664 Luiz Capitulino
        .user_print = monitor_user_noop,
486 43076664 Luiz Capitulino
        .mhandler.cmd_new = do_system_powerdown,
487 d7f9b689 Luiz Capitulino
    },
488 d7f9b689 Luiz Capitulino
489 2313086a Blue Swirl
STEXI
490 2313086a Blue Swirl
@item system_powerdown
491 2313086a Blue Swirl
492 2313086a Blue Swirl
Power down the system (if supported).
493 2313086a Blue Swirl
ETEXI
494 2313086a Blue Swirl
495 d7f9b689 Luiz Capitulino
    {
496 d7f9b689 Luiz Capitulino
        .name       = "sum",
497 d7f9b689 Luiz Capitulino
        .args_type  = "start:i,size:i",
498 d7f9b689 Luiz Capitulino
        .params     = "addr size",
499 d7f9b689 Luiz Capitulino
        .help       = "compute the checksum of a memory region",
500 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_sum,
501 d7f9b689 Luiz Capitulino
    },
502 d7f9b689 Luiz Capitulino
503 2313086a Blue Swirl
STEXI
504 2313086a Blue Swirl
@item sum @var{addr} @var{size}
505 2313086a Blue Swirl
506 2313086a Blue Swirl
Compute the checksum of a memory region.
507 2313086a Blue Swirl
ETEXI
508 2313086a Blue Swirl
509 d7f9b689 Luiz Capitulino
    {
510 d7f9b689 Luiz Capitulino
        .name       = "usb_add",
511 d7f9b689 Luiz Capitulino
        .args_type  = "devname:s",
512 d7f9b689 Luiz Capitulino
        .params     = "device",
513 d7f9b689 Luiz Capitulino
        .help       = "add USB device (e.g. 'host:bus.addr' or 'host:vendor_id:product_id')",
514 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_usb_add,
515 d7f9b689 Luiz Capitulino
    },
516 d7f9b689 Luiz Capitulino
517 2313086a Blue Swirl
STEXI
518 2313086a Blue Swirl
@item usb_add @var{devname}
519 2313086a Blue Swirl
520 2313086a Blue Swirl
Add the USB device @var{devname}.  For details of available devices see
521 2313086a Blue Swirl
@ref{usb_devices}
522 2313086a Blue Swirl
ETEXI
523 2313086a Blue Swirl
524 d7f9b689 Luiz Capitulino
    {
525 d7f9b689 Luiz Capitulino
        .name       = "usb_del",
526 d7f9b689 Luiz Capitulino
        .args_type  = "devname:s",
527 d7f9b689 Luiz Capitulino
        .params     = "device",
528 d7f9b689 Luiz Capitulino
        .help       = "remove USB device 'bus.addr'",
529 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_usb_del,
530 d7f9b689 Luiz Capitulino
    },
531 d7f9b689 Luiz Capitulino
532 2313086a Blue Swirl
STEXI
533 2313086a Blue Swirl
@item usb_del @var{devname}
534 2313086a Blue Swirl
535 2313086a Blue Swirl
Remove the USB device @var{devname} from the QEMU virtual USB
536 2313086a Blue Swirl
hub. @var{devname} has the syntax @code{bus.addr}. Use the monitor
537 2313086a Blue Swirl
command @code{info usb} to see the devices you can remove.
538 2313086a Blue Swirl
ETEXI
539 2313086a Blue Swirl
540 d7f9b689 Luiz Capitulino
    {
541 d7f9b689 Luiz Capitulino
        .name       = "device_add",
542 d7f9b689 Luiz Capitulino
        .args_type  = "config:s",
543 d7f9b689 Luiz Capitulino
        .params     = "device",
544 d7f9b689 Luiz Capitulino
        .help       = "add device, like -device on the command line",
545 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_device_add,
546 d7f9b689 Luiz Capitulino
    },
547 d7f9b689 Luiz Capitulino
548 3418bd25 Gerd Hoffmann
STEXI
549 3418bd25 Gerd Hoffmann
@item device_add @var{config}
550 3418bd25 Gerd Hoffmann
551 3418bd25 Gerd Hoffmann
Add device.
552 3418bd25 Gerd Hoffmann
ETEXI
553 3418bd25 Gerd Hoffmann
554 d7f9b689 Luiz Capitulino
    {
555 d7f9b689 Luiz Capitulino
        .name       = "device_del",
556 d7f9b689 Luiz Capitulino
        .args_type  = "id:s",
557 d7f9b689 Luiz Capitulino
        .params     = "device",
558 d7f9b689 Luiz Capitulino
        .help       = "remove device",
559 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_device_del,
560 d7f9b689 Luiz Capitulino
    },
561 d7f9b689 Luiz Capitulino
562 3418bd25 Gerd Hoffmann
STEXI
563 3418bd25 Gerd Hoffmann
@item device_del @var{id}
564 3418bd25 Gerd Hoffmann
565 3418bd25 Gerd Hoffmann
Remove device @var{id}.
566 3418bd25 Gerd Hoffmann
ETEXI
567 3418bd25 Gerd Hoffmann
568 d7f9b689 Luiz Capitulino
    {
569 d7f9b689 Luiz Capitulino
        .name       = "cpu",
570 d7f9b689 Luiz Capitulino
        .args_type  = "index:i",
571 d7f9b689 Luiz Capitulino
        .params     = "index",
572 d7f9b689 Luiz Capitulino
        .help       = "set the default CPU",
573 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_cpu_set,
574 d7f9b689 Luiz Capitulino
    },
575 3418bd25 Gerd Hoffmann
576 2313086a Blue Swirl
STEXI
577 2313086a Blue Swirl
Set the default CPU.
578 2313086a Blue Swirl
ETEXI
579 2313086a Blue Swirl
580 d7f9b689 Luiz Capitulino
    {
581 d7f9b689 Luiz Capitulino
        .name       = "mouse_move",
582 d7f9b689 Luiz Capitulino
        .args_type  = "dx_str:s,dy_str:s,dz_str:s?",
583 d7f9b689 Luiz Capitulino
        .params     = "dx dy [dz]",
584 d7f9b689 Luiz Capitulino
        .help       = "send mouse move events",
585 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_mouse_move,
586 d7f9b689 Luiz Capitulino
    },
587 d7f9b689 Luiz Capitulino
588 2313086a Blue Swirl
STEXI
589 2313086a Blue Swirl
@item mouse_move @var{dx} @var{dy} [@var{dz}]
590 2313086a Blue Swirl
Move the active mouse to the specified coordinates @var{dx} @var{dy}
591 2313086a Blue Swirl
with optional scroll axis @var{dz}.
592 2313086a Blue Swirl
ETEXI
593 2313086a Blue Swirl
594 d7f9b689 Luiz Capitulino
    {
595 d7f9b689 Luiz Capitulino
        .name       = "mouse_button",
596 d7f9b689 Luiz Capitulino
        .args_type  = "button_state:i",
597 d7f9b689 Luiz Capitulino
        .params     = "state",
598 d7f9b689 Luiz Capitulino
        .help       = "change mouse button state (1=L, 2=M, 4=R)",
599 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_mouse_button,
600 d7f9b689 Luiz Capitulino
    },
601 d7f9b689 Luiz Capitulino
602 2313086a Blue Swirl
STEXI
603 2313086a Blue Swirl
@item mouse_button @var{val}
604 2313086a Blue Swirl
Change the active mouse button state @var{val} (1=L, 2=M, 4=R).
605 2313086a Blue Swirl
ETEXI
606 2313086a Blue Swirl
607 d7f9b689 Luiz Capitulino
    {
608 d7f9b689 Luiz Capitulino
        .name       = "mouse_set",
609 d7f9b689 Luiz Capitulino
        .args_type  = "index:i",
610 d7f9b689 Luiz Capitulino
        .params     = "index",
611 d7f9b689 Luiz Capitulino
        .help       = "set which mouse device receives events",
612 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_mouse_set,
613 d7f9b689 Luiz Capitulino
    },
614 d7f9b689 Luiz Capitulino
615 2313086a Blue Swirl
STEXI
616 2313086a Blue Swirl
@item mouse_set @var{index}
617 2313086a Blue Swirl
Set which mouse device receives events at given @var{index}, index
618 2313086a Blue Swirl
can be obtained with
619 2313086a Blue Swirl
@example
620 2313086a Blue Swirl
info mice
621 2313086a Blue Swirl
@end example
622 2313086a Blue Swirl
ETEXI
623 2313086a Blue Swirl
624 2313086a Blue Swirl
#ifdef HAS_AUDIO
625 d7f9b689 Luiz Capitulino
    {
626 d7f9b689 Luiz Capitulino
        .name       = "wavcapture",
627 d7f9b689 Luiz Capitulino
        .args_type  = "path:F,freq:i?,bits:i?,nchannels:i?",
628 d7f9b689 Luiz Capitulino
        .params     = "path [frequency [bits [channels]]]",
629 d7f9b689 Luiz Capitulino
        .help       = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
630 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_wav_capture,
631 d7f9b689 Luiz Capitulino
    },
632 2313086a Blue Swirl
#endif
633 2313086a Blue Swirl
STEXI
634 2313086a Blue Swirl
@item wavcapture @var{filename} [@var{frequency} [@var{bits} [@var{channels}]]]
635 2313086a Blue Swirl
Capture audio into @var{filename}. Using sample rate @var{frequency}
636 2313086a Blue Swirl
bits per sample @var{bits} and number of channels @var{channels}.
637 2313086a Blue Swirl
638 2313086a Blue Swirl
Defaults:
639 2313086a Blue Swirl
@itemize @minus
640 2313086a Blue Swirl
@item Sample rate = 44100 Hz - CD quality
641 2313086a Blue Swirl
@item Bits = 16
642 2313086a Blue Swirl
@item Number of channels = 2 - Stereo
643 2313086a Blue Swirl
@end itemize
644 2313086a Blue Swirl
ETEXI
645 2313086a Blue Swirl
646 2313086a Blue Swirl
#ifdef HAS_AUDIO
647 d7f9b689 Luiz Capitulino
    {
648 d7f9b689 Luiz Capitulino
        .name       = "stopcapture",
649 d7f9b689 Luiz Capitulino
        .args_type  = "n:i",
650 d7f9b689 Luiz Capitulino
        .params     = "capture index",
651 d7f9b689 Luiz Capitulino
        .help       = "stop capture",
652 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_stop_capture,
653 d7f9b689 Luiz Capitulino
    },
654 2313086a Blue Swirl
#endif
655 2313086a Blue Swirl
STEXI
656 2313086a Blue Swirl
@item stopcapture @var{index}
657 2313086a Blue Swirl
Stop capture with a given @var{index}, index can be obtained with
658 2313086a Blue Swirl
@example
659 2313086a Blue Swirl
info capture
660 2313086a Blue Swirl
@end example
661 2313086a Blue Swirl
ETEXI
662 2313086a Blue Swirl
663 d7f9b689 Luiz Capitulino
    {
664 d7f9b689 Luiz Capitulino
        .name       = "memsave",
665 d7f9b689 Luiz Capitulino
        .args_type  = "val:l,size:i,filename:s",
666 d7f9b689 Luiz Capitulino
        .params     = "addr size file",
667 d7f9b689 Luiz Capitulino
        .help       = "save to disk virtual memory dump starting at 'addr' of size 'size'",
668 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_memory_save,
669 d7f9b689 Luiz Capitulino
    },
670 d7f9b689 Luiz Capitulino
671 2313086a Blue Swirl
STEXI
672 2313086a Blue Swirl
@item memsave @var{addr} @var{size} @var{file}
673 2313086a Blue Swirl
save to disk virtual memory dump starting at @var{addr} of size @var{size}.
674 2313086a Blue Swirl
ETEXI
675 2313086a Blue Swirl
676 d7f9b689 Luiz Capitulino
    {
677 d7f9b689 Luiz Capitulino
        .name       = "pmemsave",
678 d7f9b689 Luiz Capitulino
        .args_type  = "val:l,size:i,filename:s",
679 d7f9b689 Luiz Capitulino
        .params     = "addr size file",
680 d7f9b689 Luiz Capitulino
        .help       = "save to disk physical memory dump starting at 'addr' of size 'size'",
681 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_physical_memory_save,
682 d7f9b689 Luiz Capitulino
    },
683 d7f9b689 Luiz Capitulino
684 2313086a Blue Swirl
STEXI
685 2313086a Blue Swirl
@item pmemsave @var{addr} @var{size} @var{file}
686 2313086a Blue Swirl
save to disk physical memory dump starting at @var{addr} of size @var{size}.
687 2313086a Blue Swirl
ETEXI
688 2313086a Blue Swirl
689 d7f9b689 Luiz Capitulino
    {
690 d7f9b689 Luiz Capitulino
        .name       = "boot_set",
691 d7f9b689 Luiz Capitulino
        .args_type  = "bootdevice:s",
692 d7f9b689 Luiz Capitulino
        .params     = "bootdevice",
693 d7f9b689 Luiz Capitulino
        .help       = "define new values for the boot device list",
694 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_boot_set,
695 d7f9b689 Luiz Capitulino
    },
696 d7f9b689 Luiz Capitulino
697 2313086a Blue Swirl
STEXI
698 2313086a Blue Swirl
@item boot_set @var{bootdevicelist}
699 2313086a Blue Swirl
700 2313086a Blue Swirl
Define new values for the boot device list. Those values will override
701 2313086a Blue Swirl
the values specified on the command line through the @code{-boot} option.
702 2313086a Blue Swirl
703 2313086a Blue Swirl
The values that can be specified here depend on the machine type, but are
704 2313086a Blue Swirl
the same that can be specified in the @code{-boot} command line option.
705 2313086a Blue Swirl
ETEXI
706 2313086a Blue Swirl
707 2313086a Blue Swirl
#if defined(TARGET_I386)
708 d7f9b689 Luiz Capitulino
    {
709 d7f9b689 Luiz Capitulino
        .name       = "nmi",
710 d7f9b689 Luiz Capitulino
        .args_type  = "cpu_index:i",
711 d7f9b689 Luiz Capitulino
        .params     = "cpu",
712 d7f9b689 Luiz Capitulino
        .help       = "inject an NMI on the given CPU",
713 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_inject_nmi,
714 d7f9b689 Luiz Capitulino
    },
715 2313086a Blue Swirl
#endif
716 2313086a Blue Swirl
STEXI
717 2313086a Blue Swirl
@item nmi @var{cpu}
718 2313086a Blue Swirl
Inject an NMI on the given CPU (x86 only).
719 2313086a Blue Swirl
ETEXI
720 2313086a Blue Swirl
721 d7f9b689 Luiz Capitulino
    {
722 d7f9b689 Luiz Capitulino
        .name       = "migrate",
723 d7f9b689 Luiz Capitulino
        .args_type  = "detach:-d,uri:s",
724 d7f9b689 Luiz Capitulino
        .params     = "[-d] uri",
725 d7f9b689 Luiz Capitulino
        .help       = "migrate to URI (using -d to not wait for completion)",
726 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_migrate,
727 d7f9b689 Luiz Capitulino
    },
728 d7f9b689 Luiz Capitulino
729 2313086a Blue Swirl
STEXI
730 2313086a Blue Swirl
@item migrate [-d] @var{uri}
731 2313086a Blue Swirl
Migrate to @var{uri} (using -d to not wait for completion).
732 2313086a Blue Swirl
ETEXI
733 2313086a Blue Swirl
734 d7f9b689 Luiz Capitulino
    {
735 d7f9b689 Luiz Capitulino
        .name       = "migrate_cancel",
736 d7f9b689 Luiz Capitulino
        .args_type  = "",
737 d7f9b689 Luiz Capitulino
        .params     = "",
738 d7f9b689 Luiz Capitulino
        .help       = "cancel the current VM migration",
739 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_migrate_cancel,
740 d7f9b689 Luiz Capitulino
    },
741 d7f9b689 Luiz Capitulino
742 2313086a Blue Swirl
STEXI
743 2313086a Blue Swirl
@item migrate_cancel
744 2313086a Blue Swirl
Cancel the current VM migration.
745 2313086a Blue Swirl
ETEXI
746 2313086a Blue Swirl
747 d7f9b689 Luiz Capitulino
    {
748 d7f9b689 Luiz Capitulino
        .name       = "migrate_set_speed",
749 d7f9b689 Luiz Capitulino
        .args_type  = "value:s",
750 d7f9b689 Luiz Capitulino
        .params     = "value",
751 d7f9b689 Luiz Capitulino
        .help       = "set maximum speed (in bytes) for migrations",
752 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_migrate_set_speed,
753 d7f9b689 Luiz Capitulino
    },
754 d7f9b689 Luiz Capitulino
755 2313086a Blue Swirl
STEXI
756 2313086a Blue Swirl
@item migrate_set_speed @var{value}
757 2313086a Blue Swirl
Set maximum speed to @var{value} (in bytes) for migrations.
758 2313086a Blue Swirl
ETEXI
759 2313086a Blue Swirl
760 d7f9b689 Luiz Capitulino
    {
761 d7f9b689 Luiz Capitulino
        .name       = "migrate_set_downtime",
762 d7f9b689 Luiz Capitulino
        .args_type  = "value:s",
763 d7f9b689 Luiz Capitulino
        .params     = "value",
764 d7f9b689 Luiz Capitulino
        .help       = "set maximum tolerated downtime (in seconds) for migrations",
765 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_migrate_set_downtime,
766 d7f9b689 Luiz Capitulino
    },
767 2ea42952 Glauber Costa
768 2ea42952 Glauber Costa
STEXI
769 2ea42952 Glauber Costa
@item migrate_set_downtime @var{second}
770 2ea42952 Glauber Costa
Set maximum tolerated downtime (in seconds) for migration.
771 2ea42952 Glauber Costa
ETEXI
772 2ea42952 Glauber Costa
773 2313086a Blue Swirl
#if defined(TARGET_I386)
774 d7f9b689 Luiz Capitulino
    {
775 d7f9b689 Luiz Capitulino
        .name       = "drive_add",
776 d7f9b689 Luiz Capitulino
        .args_type  = "pci_addr:s,opts:s",
777 d7f9b689 Luiz Capitulino
        .params     = "[[<domain>:]<bus>:]<slot>\n"
778 d7f9b689 Luiz Capitulino
                      "[file=file][,if=type][,bus=n]\n"
779 d7f9b689 Luiz Capitulino
                      "[,unit=m][,media=d][index=i]\n"
780 d7f9b689 Luiz Capitulino
                      "[,cyls=c,heads=h,secs=s[,trans=t]]\n"
781 d7f9b689 Luiz Capitulino
                      "[snapshot=on|off][,cache=on|off]",
782 d7f9b689 Luiz Capitulino
        .help       = "add drive to PCI storage controller",
783 af4ce882 Luiz Capitulino
        .mhandler.cmd = drive_hot_add,
784 d7f9b689 Luiz Capitulino
    },
785 2313086a Blue Swirl
#endif
786 d7f9b689 Luiz Capitulino
787 2313086a Blue Swirl
STEXI
788 2313086a Blue Swirl
@item drive_add
789 2313086a Blue Swirl
Add drive to PCI storage controller.
790 2313086a Blue Swirl
ETEXI
791 2313086a Blue Swirl
792 2313086a Blue Swirl
#if defined(TARGET_I386)
793 d7f9b689 Luiz Capitulino
    {
794 d7f9b689 Luiz Capitulino
        .name       = "pci_add",
795 d7f9b689 Luiz Capitulino
        .args_type  = "pci_addr:s,type:s,opts:s?",
796 d7f9b689 Luiz Capitulino
        .params     = "auto|[[<domain>:]<bus>:]<slot> nic|storage [[vlan=n][,macaddr=addr][,model=type]] [file=file][,if=type][,bus=nr]...",
797 d7f9b689 Luiz Capitulino
        .help       = "hot-add PCI device",
798 af4ce882 Luiz Capitulino
        .mhandler.cmd = pci_device_hot_add,
799 d7f9b689 Luiz Capitulino
    },
800 2313086a Blue Swirl
#endif
801 d7f9b689 Luiz Capitulino
802 2313086a Blue Swirl
STEXI
803 2313086a Blue Swirl
@item pci_add
804 2313086a Blue Swirl
Hot-add PCI device.
805 2313086a Blue Swirl
ETEXI
806 2313086a Blue Swirl
807 2313086a Blue Swirl
#if defined(TARGET_I386)
808 d7f9b689 Luiz Capitulino
    {
809 d7f9b689 Luiz Capitulino
        .name       = "pci_del",
810 d7f9b689 Luiz Capitulino
        .args_type  = "pci_addr:s",
811 d7f9b689 Luiz Capitulino
        .params     = "[[<domain>:]<bus>:]<slot>",
812 d7f9b689 Luiz Capitulino
        .help       = "hot remove PCI device",
813 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_pci_device_hot_remove,
814 d7f9b689 Luiz Capitulino
    },
815 2313086a Blue Swirl
#endif
816 d7f9b689 Luiz Capitulino
817 2313086a Blue Swirl
STEXI
818 2313086a Blue Swirl
@item pci_del
819 2313086a Blue Swirl
Hot remove PCI device.
820 2313086a Blue Swirl
ETEXI
821 2313086a Blue Swirl
822 d7f9b689 Luiz Capitulino
    {
823 d7f9b689 Luiz Capitulino
        .name       = "host_net_add",
824 d7f9b689 Luiz Capitulino
        .args_type  = "device:s,opts:s?",
825 d7f9b689 Luiz Capitulino
        .params     = "tap|user|socket|vde|dump [options]",
826 d7f9b689 Luiz Capitulino
        .help       = "add host VLAN client",
827 af4ce882 Luiz Capitulino
        .mhandler.cmd = net_host_device_add,
828 d7f9b689 Luiz Capitulino
    },
829 d7f9b689 Luiz Capitulino
830 2313086a Blue Swirl
STEXI
831 2313086a Blue Swirl
@item host_net_add
832 2313086a Blue Swirl
Add host VLAN client.
833 2313086a Blue Swirl
ETEXI
834 2313086a Blue Swirl
835 d7f9b689 Luiz Capitulino
    {
836 d7f9b689 Luiz Capitulino
        .name       = "host_net_remove",
837 d7f9b689 Luiz Capitulino
        .args_type  = "vlan_id:i,device:s",
838 d7f9b689 Luiz Capitulino
        .params     = "vlan_id name",
839 d7f9b689 Luiz Capitulino
        .help       = "remove host VLAN client",
840 af4ce882 Luiz Capitulino
        .mhandler.cmd = net_host_device_remove,
841 d7f9b689 Luiz Capitulino
    },
842 d7f9b689 Luiz Capitulino
843 2313086a Blue Swirl
STEXI
844 2313086a Blue Swirl
@item host_net_remove
845 2313086a Blue Swirl
Remove host VLAN client.
846 2313086a Blue Swirl
ETEXI
847 2313086a Blue Swirl
848 2313086a Blue Swirl
#ifdef CONFIG_SLIRP
849 d7f9b689 Luiz Capitulino
    {
850 d7f9b689 Luiz Capitulino
        .name       = "hostfwd_add",
851 d7f9b689 Luiz Capitulino
        .args_type  = "arg1:s,arg2:s?,arg3:s?",
852 d7f9b689 Luiz Capitulino
        .params     = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
853 d7f9b689 Luiz Capitulino
        .help       = "redirect TCP or UDP connections from host to guest (requires -net user)",
854 af4ce882 Luiz Capitulino
        .mhandler.cmd = net_slirp_hostfwd_add,
855 d7f9b689 Luiz Capitulino
    },
856 d7f9b689 Luiz Capitulino
857 d7f9b689 Luiz Capitulino
    {
858 d7f9b689 Luiz Capitulino
        .name       = "hostfwd_remove",
859 d7f9b689 Luiz Capitulino
        .args_type  = "arg1:s,arg2:s?,arg3:s?",
860 d7f9b689 Luiz Capitulino
        .params     = "[vlan_id name] [tcp|udp]:[hostaddr]:hostport",
861 d7f9b689 Luiz Capitulino
        .help       = "remove host-to-guest TCP or UDP redirection",
862 af4ce882 Luiz Capitulino
        .mhandler.cmd = net_slirp_hostfwd_remove,
863 d7f9b689 Luiz Capitulino
    },
864 d7f9b689 Luiz Capitulino
865 2313086a Blue Swirl
#endif
866 2313086a Blue Swirl
STEXI
867 2313086a Blue Swirl
@item host_net_redir
868 2313086a Blue Swirl
Redirect TCP or UDP connections from host to guest (requires -net user).
869 2313086a Blue Swirl
ETEXI
870 2313086a Blue Swirl
871 d7f9b689 Luiz Capitulino
    {
872 d7f9b689 Luiz Capitulino
        .name       = "balloon",
873 d7f9b689 Luiz Capitulino
        .args_type  = "value:i",
874 d7f9b689 Luiz Capitulino
        .params     = "target",
875 d7f9b689 Luiz Capitulino
        .help       = "request VM to change it's memory allocation (in MB)",
876 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_balloon,
877 d7f9b689 Luiz Capitulino
    },
878 d7f9b689 Luiz Capitulino
879 2313086a Blue Swirl
STEXI
880 2313086a Blue Swirl
@item balloon @var{value}
881 2313086a Blue Swirl
Request VM to change its memory allocation to @var{value} (in MB).
882 2313086a Blue Swirl
ETEXI
883 2313086a Blue Swirl
884 d7f9b689 Luiz Capitulino
    {
885 d7f9b689 Luiz Capitulino
        .name       = "set_link",
886 d7f9b689 Luiz Capitulino
        .args_type  = "name:s,up_or_down:s",
887 d7f9b689 Luiz Capitulino
        .params     = "name up|down",
888 d7f9b689 Luiz Capitulino
        .help       = "change the link status of a network adapter",
889 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_set_link,
890 d7f9b689 Luiz Capitulino
    },
891 d7f9b689 Luiz Capitulino
892 2313086a Blue Swirl
STEXI
893 2313086a Blue Swirl
@item set_link @var{name} [up|down]
894 2313086a Blue Swirl
Set link @var{name} up or down.
895 2313086a Blue Swirl
ETEXI
896 2313086a Blue Swirl
897 d7f9b689 Luiz Capitulino
    {
898 d7f9b689 Luiz Capitulino
        .name       = "watchdog_action",
899 d7f9b689 Luiz Capitulino
        .args_type  = "action:s",
900 d7f9b689 Luiz Capitulino
        .params     = "[reset|shutdown|poweroff|pause|debug|none]",
901 d7f9b689 Luiz Capitulino
        .help       = "change watchdog action",
902 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_watchdog_action,
903 d7f9b689 Luiz Capitulino
    },
904 d7f9b689 Luiz Capitulino
905 2313086a Blue Swirl
STEXI
906 2313086a Blue Swirl
@item watchdog_action
907 2313086a Blue Swirl
Change watchdog action.
908 2313086a Blue Swirl
ETEXI
909 2313086a Blue Swirl
910 d7f9b689 Luiz Capitulino
    {
911 d7f9b689 Luiz Capitulino
        .name       = "acl_show",
912 d7f9b689 Luiz Capitulino
        .args_type  = "aclname:s",
913 d7f9b689 Luiz Capitulino
        .params     = "aclname",
914 d7f9b689 Luiz Capitulino
        .help       = "list rules in the access control list",
915 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_acl_show,
916 d7f9b689 Luiz Capitulino
    },
917 d7f9b689 Luiz Capitulino
918 2313086a Blue Swirl
STEXI
919 15dfcd45 Jan Kiszka
@item acl_show @var{aclname}
920 15dfcd45 Jan Kiszka
List all the matching rules in the access control list, and the default
921 15dfcd45 Jan Kiszka
policy. There are currently two named access control lists,
922 15dfcd45 Jan Kiszka
@var{vnc.x509dname} and @var{vnc.username} matching on the x509 client
923 15dfcd45 Jan Kiszka
certificate distinguished name, and SASL username respectively.
924 15dfcd45 Jan Kiszka
ETEXI
925 2313086a Blue Swirl
926 d7f9b689 Luiz Capitulino
    {
927 d7f9b689 Luiz Capitulino
        .name       = "acl_policy",
928 d7f9b689 Luiz Capitulino
        .args_type  = "aclname:s,policy:s",
929 d7f9b689 Luiz Capitulino
        .params     = "aclname allow|deny",
930 d7f9b689 Luiz Capitulino
        .help       = "set default access control list policy",
931 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_acl_policy,
932 d7f9b689 Luiz Capitulino
    },
933 d7f9b689 Luiz Capitulino
934 15dfcd45 Jan Kiszka
STEXI
935 cbbfacc6 Jan Kiszka
@item acl_policy @var{aclname} @code{allow|deny}
936 15dfcd45 Jan Kiszka
Set the default access control list policy, used in the event that
937 2313086a Blue Swirl
none of the explicit rules match. The default policy at startup is
938 15dfcd45 Jan Kiszka
always @code{deny}.
939 15dfcd45 Jan Kiszka
ETEXI
940 15dfcd45 Jan Kiszka
941 d7f9b689 Luiz Capitulino
    {
942 d7f9b689 Luiz Capitulino
        .name       = "acl_add",
943 d7f9b689 Luiz Capitulino
        .args_type  = "aclname:s,match:s,policy:s,index:i?",
944 d7f9b689 Luiz Capitulino
        .params     = "aclname match allow|deny [index]",
945 d7f9b689 Luiz Capitulino
        .help       = "add a match rule to the access control list",
946 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_acl_add,
947 d7f9b689 Luiz Capitulino
    },
948 d7f9b689 Luiz Capitulino
949 15dfcd45 Jan Kiszka
STEXI
950 15dfcd45 Jan Kiszka
@item acl_allow @var{aclname} @var{match} @code{allow|deny} [@var{index}]
951 15dfcd45 Jan Kiszka
Add a match rule to the access control list, allowing or denying access.
952 15dfcd45 Jan Kiszka
The match will normally be an exact username or x509 distinguished name,
953 15dfcd45 Jan Kiszka
but can optionally include wildcard globs. eg @code{*@@EXAMPLE.COM} to
954 15dfcd45 Jan Kiszka
allow all users in the @code{EXAMPLE.COM} kerberos realm. The match will
955 2313086a Blue Swirl
normally be appended to the end of the ACL, but can be inserted
956 15dfcd45 Jan Kiszka
earlier in the list if the optional @var{index} parameter is supplied.
957 15dfcd45 Jan Kiszka
ETEXI
958 15dfcd45 Jan Kiszka
959 d7f9b689 Luiz Capitulino
    {
960 d7f9b689 Luiz Capitulino
        .name       = "acl_remove",
961 d7f9b689 Luiz Capitulino
        .args_type  = "aclname:s,match:s",
962 d7f9b689 Luiz Capitulino
        .params     = "aclname match",
963 d7f9b689 Luiz Capitulino
        .help       = "remove a match rule from the access control list",
964 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_acl_remove,
965 d7f9b689 Luiz Capitulino
    },
966 d7f9b689 Luiz Capitulino
967 15dfcd45 Jan Kiszka
STEXI
968 15dfcd45 Jan Kiszka
@item acl_remove @var{aclname} @var{match}
969 15dfcd45 Jan Kiszka
Remove the specified match rule from the access control list.
970 15dfcd45 Jan Kiszka
ETEXI
971 15dfcd45 Jan Kiszka
972 d7f9b689 Luiz Capitulino
    {
973 d7f9b689 Luiz Capitulino
        .name       = "acl_reset",
974 d7f9b689 Luiz Capitulino
        .args_type  = "aclname:s",
975 d7f9b689 Luiz Capitulino
        .params     = "aclname",
976 d7f9b689 Luiz Capitulino
        .help       = "reset the access control list",
977 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_acl_reset,
978 d7f9b689 Luiz Capitulino
    },
979 d7f9b689 Luiz Capitulino
980 15dfcd45 Jan Kiszka
STEXI
981 15dfcd45 Jan Kiszka
@item acl_remove @var{aclname} @var{match}
982 15dfcd45 Jan Kiszka
Remove all matches from the access control list, and set the default
983 2313086a Blue Swirl
policy back to @code{deny}.
984 2313086a Blue Swirl
ETEXI
985 2313086a Blue Swirl
986 79c4f6b0 Huang Ying
#if defined(TARGET_I386)
987 d7f9b689 Luiz Capitulino
988 d7f9b689 Luiz Capitulino
    {
989 d7f9b689 Luiz Capitulino
        .name       = "mce",
990 d7f9b689 Luiz Capitulino
        .args_type  = "cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
991 d7f9b689 Luiz Capitulino
        .params     = "cpu bank status mcgstatus addr misc",
992 d7f9b689 Luiz Capitulino
        .help       = "inject a MCE on the given CPU",
993 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_inject_mce,
994 d7f9b689 Luiz Capitulino
    },
995 d7f9b689 Luiz Capitulino
996 79c4f6b0 Huang Ying
#endif
997 79c4f6b0 Huang Ying
STEXI
998 79c4f6b0 Huang Ying
@item mce @var{cpu} @var{bank} @var{status} @var{mcgstatus} @var{addr} @var{misc}
999 79c4f6b0 Huang Ying
Inject an MCE on the given CPU (x86 only).
1000 79c4f6b0 Huang Ying
ETEXI
1001 79c4f6b0 Huang Ying
1002 d7f9b689 Luiz Capitulino
    {
1003 d7f9b689 Luiz Capitulino
        .name       = "getfd",
1004 d7f9b689 Luiz Capitulino
        .args_type  = "fdname:s",
1005 d7f9b689 Luiz Capitulino
        .params     = "getfd name",
1006 d7f9b689 Luiz Capitulino
        .help       = "receive a file descriptor via SCM rights and assign it a name",
1007 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_getfd,
1008 d7f9b689 Luiz Capitulino
    },
1009 d7f9b689 Luiz Capitulino
1010 f07918fd Mark McLoughlin
STEXI
1011 f07918fd Mark McLoughlin
@item getfd @var{fdname}
1012 f07918fd Mark McLoughlin
If a file descriptor is passed alongside this command using the SCM_RIGHTS
1013 f07918fd Mark McLoughlin
mechanism on unix sockets, it is stored using the name @var{fdname} for
1014 f07918fd Mark McLoughlin
later use by other monitor commands.
1015 f07918fd Mark McLoughlin
ETEXI
1016 f07918fd Mark McLoughlin
1017 d7f9b689 Luiz Capitulino
    {
1018 d7f9b689 Luiz Capitulino
        .name       = "closefd",
1019 d7f9b689 Luiz Capitulino
        .args_type  = "fdname:s",
1020 d7f9b689 Luiz Capitulino
        .params     = "closefd name",
1021 d7f9b689 Luiz Capitulino
        .help       = "close a file descriptor previously passed via SCM rights",
1022 af4ce882 Luiz Capitulino
        .mhandler.cmd = do_closefd,
1023 d7f9b689 Luiz Capitulino
    },
1024 d7f9b689 Luiz Capitulino
1025 f07918fd Mark McLoughlin
STEXI
1026 f07918fd Mark McLoughlin
@item closefd @var{fdname}
1027 f07918fd Mark McLoughlin
Close the file descriptor previously assigned to @var{fdname} using the
1028 f07918fd Mark McLoughlin
@code{getfd} command. This is only needed if the file descriptor was never
1029 f07918fd Mark McLoughlin
used by another monitor command.
1030 f07918fd Mark McLoughlin
ETEXI
1031 f07918fd Mark McLoughlin
1032 2313086a Blue Swirl
STEXI
1033 2313086a Blue Swirl
@end table
1034 2313086a Blue Swirl
ETEXI