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