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