blob: 06746f0afc3761a2744ce1bd729ab33554382d8c [file] [log] [blame]
Peter Maydelld95f2602023-12-12 16:23:13 +00001HXCOMM See docs/devel/docs.rst for the format of this file.
2HXCOMM
3HXCOMM This file defines the contents of an array of HMPCommand structs
4HXCOMM which specify the name, behaviour and help text for HMP commands.
5HXCOMM Text between SRST and ERST is rST format documentation.
Peter Maydell3c95fde2020-03-06 17:17:44 +00006HXCOMM HXCOMM can be used for comments, discarded from both rST and C.
Blue Swirl23130862009-06-06 08:22:04 +00007
Blue Swirl23130862009-06-06 08:22:04 +00008
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03009 {
10 .name = "help|?",
Wenchao Xia129be002013-08-27 20:38:26 +080011 .args_type = "name:S?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030012 .params = "[cmd]",
13 .help = "show the help",
Markus Armbrustercbf81992023-01-24 13:19:43 +010014 .cmd = hmp_help,
Dr. David Alan Gilbert31785f12018-06-20 16:39:42 +010015 .flags = "p",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030016 },
17
Peter Maydella6b30bc2020-02-28 15:36:06 +000018SRST
19``help`` or ``?`` [*cmd*]
20 Show the help for all commands or just for command *cmd*.
21ERST
Blue Swirl23130862009-06-06 08:22:04 +000022
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030023 {
24 .name = "commit",
25 .args_type = "device:B",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030026 .params = "device|all",
27 .help = "commit changes to the disk images (if -snapshot is used) or backing files",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +040028 .cmd = hmp_commit,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030029 },
30
Peter Maydella6b30bc2020-02-28 15:36:06 +000031SRST
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.
40ERST
Blue Swirl23130862009-06-06 08:22:04 +000041
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030042 {
Peter Maydellff688cd2020-11-21 15:17:11 +000043 .name = "quit|q",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030044 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030045 .params = "",
46 .help = "quit the emulator",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +040047 .cmd = hmp_quit,
Paolo Bonziniebe34442020-10-27 06:56:32 -040048 .flags = "p",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030049 },
50
Peter Maydella6b30bc2020-02-28 15:36:06 +000051SRST
Peter Maydellff688cd2020-11-21 15:17:11 +000052``quit`` or ``q``
Peter Maydella6b30bc2020-02-28 15:36:06 +000053 Quit the emulator.
54ERST
Blue Swirl23130862009-06-06 08:22:04 +000055
Luiz Capitulinod7f9b682009-10-07 13:41:50 -030056 {
Dr. David Alan Gilbert8e8581e2018-06-20 16:39:46 +010057 .name = "exit_preconfig",
58 .args_type = "",
59 .params = "",
60 .help = "exit the preconfig state",
61 .cmd = hmp_exit_preconfig,
62 .flags = "p",
63 },
64
Peter Maydella6b30bc2020-02-28 15:36:06 +000065SRST
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).
72ERST
Dr. David Alan Gilbert8e8581e2018-06-20 16:39:46 +010073
74 {
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +010075 .name = "block_resize",
76 .args_type = "device:B,size:o",
77 .params = "device size",
78 .help = "resize a block image",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +040079 .cmd = hmp_block_resize,
Kevin Wolfeb94b812020-10-05 17:58:55 +020080 .coroutine = true,
Paolo Bonzinif55ba802020-11-03 04:37:20 -050081 .flags = "p",
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +010082 },
83
Peter Maydella6b30bc2020-02-28 15:36:06 +000084SRST
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.
90ERST
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +010091
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +000092 {
93 .name = "block_stream",
Stefan Hajnoczic83c66c2012-04-25 16:51:03 +010094 .args_type = "device:B,speed:o?,base:s?",
95 .params = "device [speed [base]]",
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +000096 .help = "copy data from a backing file into a block device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +040097 .cmd = hmp_block_stream,
Paolo Bonzinif55ba802020-11-03 04:37:20 -050098 .flags = "p",
Stefan Hajnoczi12bd4512012-01-18 14:40:46 +000099 },
100
Peter Maydella6b30bc2020-02-28 15:36:06 +0000101SRST
102``block_stream``
103 Copy data from a backing file into a block device.
104ERST
Christoph Hellwig6d4a2b32011-01-24 13:32:33 +0100105
106 {
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +0000107 .name = "block_job_set_speed",
Stefan Hajnoczi882ec7c2012-04-25 16:51:02 +0100108 .args_type = "device:B,speed:o",
109 .params = "device speed",
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +0000110 .help = "set maximum speed for a background block operation",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400111 .cmd = hmp_block_job_set_speed,
Paolo Bonzinif55ba802020-11-03 04:37:20 -0500112 .flags = "p",
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +0000113 },
114
Peter Maydella6b30bc2020-02-28 15:36:06 +0000115SRST
116``block_job_set_speed``
117 Set maximum speed for a background block operation.
118ERST
Stefan Hajnoczi2d47c6e2012-01-18 14:40:47 +0000119
120 {
Stefan Hajnoczi370521a2012-01-18 14:40:48 +0000121 .name = "block_job_cancel",
Paolo Bonzini6e37fb82012-09-28 17:22:51 +0200122 .args_type = "force:-f,device:B",
123 .params = "[-f] device",
124 .help = "stop an active background block operation (use -f"
Liang Lib76e4452018-03-13 08:12:16 -0400125 "\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)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400127 .cmd = hmp_block_job_cancel,
Paolo Bonzinif55ba802020-11-03 04:37:20 -0500128 .flags = "p",
Stefan Hajnoczi370521a2012-01-18 14:40:48 +0000129 },
130
Peter Maydella6b30bc2020-02-28 15:36:06 +0000131SRST
132``block_job_cancel``
133 Stop an active background block operation (streaming, mirroring).
134ERST
Paolo Bonziniaeae8832012-10-18 16:49:21 +0200135
136 {
137 .name = "block_job_complete",
138 .args_type = "device:B",
139 .params = "device",
140 .help = "stop an active background block operation",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400141 .cmd = hmp_block_job_complete,
Paolo Bonzinif55ba802020-11-03 04:37:20 -0500142 .flags = "p",
Paolo Bonziniaeae8832012-10-18 16:49:21 +0200143 },
144
Peter Maydella6b30bc2020-02-28 15:36:06 +0000145SRST
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.
149ERST
Stefan Hajnoczi370521a2012-01-18 14:40:48 +0000150
151 {
Paolo Bonzini6e37fb82012-09-28 17:22:51 +0200152 .name = "block_job_pause",
153 .args_type = "device:B",
154 .params = "device",
155 .help = "pause an active background block operation",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400156 .cmd = hmp_block_job_pause,
Paolo Bonzinif55ba802020-11-03 04:37:20 -0500157 .flags = "p",
Paolo Bonzini6e37fb82012-09-28 17:22:51 +0200158 },
159
Peter Maydella6b30bc2020-02-28 15:36:06 +0000160SRST
161``block_job_pause``
162 Pause an active block streaming operation.
163ERST
Paolo Bonzini6e37fb82012-09-28 17:22:51 +0200164
165 {
166 .name = "block_job_resume",
167 .args_type = "device:B",
168 .params = "device",
169 .help = "resume a paused background block operation",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400170 .cmd = hmp_block_job_resume,
Paolo Bonzinif55ba802020-11-03 04:37:20 -0500171 .flags = "p",
Paolo Bonzini6e37fb82012-09-28 17:22:51 +0200172 },
173
Peter Maydella6b30bc2020-02-28 15:36:06 +0000174SRST
175``block_job_resume``
176 Resume a paused block streaming operation.
177ERST
Paolo Bonzini6e37fb82012-09-28 17:22:51 +0200178
179 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300180 .name = "eject",
Luiz Capitulino78d714e2009-12-14 18:53:21 -0200181 .args_type = "force:-f,device:B",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300182 .params = "[-f] device",
183 .help = "eject a removable medium (use -f to force it)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400184 .cmd = hmp_eject,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300185 },
186
Peter Maydella6b30bc2020-02-28 15:36:06 +0000187SRST
188``eject [-f]`` *device*
189 Eject a removable medium (use -f to force it).
190ERST
Blue Swirl23130862009-06-06 08:22:04 +0000191
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300192 {
Ryan Harper9063f812010-11-12 11:07:13 -0600193 .name = "drive_del",
Hani Benhabilesf7bdc412014-04-13 16:25:05 +0100194 .args_type = "id:B",
Ryan Harper9063f812010-11-12 11:07:13 -0600195 .params = "device",
196 .help = "remove host block device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400197 .cmd = hmp_drive_del,
Ryan Harper9063f812010-11-12 11:07:13 -0600198 },
199
Peter Maydella6b30bc2020-02-28 15:36:06 +0000200SRST
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).
208ERST
Ryan Harper9063f812010-11-12 11:07:13 -0600209
210 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300211 .name = "change",
Denis V. Lunev80dd5af2022-04-13 01:18:46 +0300212 .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",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400215 .cmd = hmp_change,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300216 },
217
Peter Maydella6b30bc2020-02-28 15:36:06 +0000218SRST
219``change`` *device* *setting*
220 Change the configuration of a device.
221
Denis V. Lunev80dd5af2022-04-13 01:18:46 +0300222 ``change`` *diskdevice* [-f] *filename* [*format* [*read-only-mode*]]
Peter Maydella6b30bc2020-02-28 15:36:06 +0000223 Change the medium for a removable disk device to point to *filename*. eg::
224
225 (qemu) change ide1-cd0 /path/to/some.iso
226
Denis V. Lunev80dd5af2022-04-13 01:18:46 +0300227 ``-f``
228 forces the operation even if the guest has locked the tray.
229
Peter Maydella6b30bc2020-02-28 15:36:06 +0000230 *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
Peter Maydella6b30bc2020-02-28 15:36:06 +0000244 ``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
253ERST
Blue Swirl23130862009-06-06 08:22:04 +0000254
Marc-André Lureauf38aa2c2023-08-30 13:38:29 +0400255#ifdef CONFIG_PIXMAN
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300256 {
257 .name = "screendump",
Kshitij Suri9a0a1192022-04-08 07:13:35 +0000258 .args_type = "filename:F,format:-fs,device:s?,head:i?",
259 .params = "filename [-f format] [device [head]]",
260 .help = "save screen from head 'head' of display device 'device'"
261 "in specified format 'format' as image 'filename'."
262 "Currently only 'png' and 'ppm' formats are supported.",
263 .cmd = hmp_screendump,
Marc-André Lureau0d9b90c2020-10-27 17:36:02 +0400264 .coroutine = true,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300265 },
266
Peter Maydella6b30bc2020-02-28 15:36:06 +0000267SRST
268``screendump`` *filename*
269 Save screen into PPM image *filename*.
270ERST
Marc-André Lureauf38aa2c2023-08-30 13:38:29 +0400271#endif
Blue Swirl23130862009-06-06 08:22:04 +0000272
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300273 {
274 .name = "logfile",
275 .args_type = "filename:F",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300276 .params = "filename",
277 .help = "output logs to 'filename'",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400278 .cmd = hmp_logfile,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300279 },
280
Peter Maydella6b30bc2020-02-28 15:36:06 +0000281SRST
282``logfile`` *filename*
283 Output logs to *filename*.
284ERST
Blue Swirl23130862009-06-06 08:22:04 +0000285
Prerna Saxena22890ab2010-06-24 17:04:53 +0530286 {
287 .name = "trace-event",
Lluís Vilanova77e2b172016-07-11 12:53:57 +0200288 .args_type = "name:s,option:b,vcpu:i?",
289 .params = "name on|off [vcpu]",
290 .help = "changes status of a specific trace event "
291 "(vcpu: vCPU to set, default is all)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400292 .cmd = hmp_trace_event,
Dr. David Alan Gilbert987bd272015-08-14 11:27:43 +0100293 .command_completion = trace_event_completion,
Prerna Saxena22890ab2010-06-24 17:04:53 +0530294 },
295
Peter Maydella6b30bc2020-02-28 15:36:06 +0000296SRST
297``trace-event``
298 changes status of a trace event
299ERST
Stefan Hajnoczic5ceb522010-07-13 09:26:33 +0100300
Michael Rothc45a8162011-10-02 08:44:37 -0500301#if defined(CONFIG_TRACE_SIMPLE)
Stefan Hajnoczic5ceb522010-07-13 09:26:33 +0100302 {
303 .name = "trace-file",
304 .args_type = "op:s?,arg:F?",
305 .params = "on|off|flush|set [arg]",
306 .help = "open, close, or flush trace file, or set a new file name",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400307 .cmd = hmp_trace_file,
Stefan Hajnoczic5ceb522010-07-13 09:26:33 +0100308 },
309
Peter Maydella6b30bc2020-02-28 15:36:06 +0000310SRST
311``trace-file on|off|flush``
312 Open, close, or flush the trace file. If no argument is given, the
313 status of the trace file is displayed.
314ERST
Prerna Saxena22890ab2010-06-24 17:04:53 +0530315#endif
316
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300317 {
318 .name = "log",
319 .args_type = "items:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300320 .params = "item1[,...]",
Peter Maydell989b6972013-02-26 17:52:40 +0000321 .help = "activate logging of the specified items",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400322 .cmd = hmp_log,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300323 },
324
Peter Maydella6b30bc2020-02-28 15:36:06 +0000325SRST
326``log`` *item1*\ [,...]
327 Activate logging of the specified items.
328ERST
Blue Swirl23130862009-06-06 08:22:04 +0000329
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300330 {
331 .name = "savevm",
332 .args_type = "name:s?",
Daniel Henrique Barboza6ca08042018-11-07 11:09:58 -0200333 .params = "tag",
334 .help = "save a VM snapshot. If no tag is provided, a new snapshot is created",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400335 .cmd = hmp_savevm,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300336 },
337
Peter Maydella6b30bc2020-02-28 15:36:06 +0000338SRST
339``savevm`` *tag*
340 Create a snapshot of the whole virtual machine. If *tag* is
341 provided, it is used as human readable identifier. If there is already
342 a snapshot with the same tag, it is replaced. More info at
343 :ref:`vm_005fsnapshots`.
344
345 Since 4.0, savevm stopped allowing the snapshot id to be set, accepting
346 only *tag* as parameter.
347ERST
Blue Swirl23130862009-06-06 08:22:04 +0000348
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300349 {
350 .name = "loadvm",
351 .args_type = "name:s",
Daniel Henrique Barboza6ca08042018-11-07 11:09:58 -0200352 .params = "tag",
353 .help = "restore a VM snapshot from its tag",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400354 .cmd = hmp_loadvm,
Hani Benhabilesb21631f2014-05-27 23:39:37 +0100355 .command_completion = loadvm_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300356 },
357
Peter Maydella6b30bc2020-02-28 15:36:06 +0000358SRST
359``loadvm`` *tag*
360 Set the whole virtual machine to the snapshot identified by the tag
361 *tag*.
362
363 Since 4.0, loadvm stopped accepting snapshot id as parameter.
364ERST
Blue Swirl23130862009-06-06 08:22:04 +0000365
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300366 {
367 .name = "delvm",
368 .args_type = "name:s",
Daniel Henrique Barboza6ca08042018-11-07 11:09:58 -0200369 .params = "tag",
370 .help = "delete a VM snapshot from its tag",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400371 .cmd = hmp_delvm,
Hani Benhabilesb21631f2014-05-27 23:39:37 +0100372 .command_completion = delvm_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300373 },
374
Peter Maydella6b30bc2020-02-28 15:36:06 +0000375SRST
376``delvm`` *tag*
377 Delete the snapshot identified by *tag*.
378
379 Since 4.0, delvm stopped deleting snapshots by snapshot id, accepting
380 only *tag* as parameter.
381ERST
Blue Swirl23130862009-06-06 08:22:04 +0000382
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300383 {
Peter Maydelle9ccfdd2023-04-17 17:40:39 +0100384 .name = "one-insn-per-tb",
385 .args_type = "option:s?",
386 .params = "[on|off]",
387 .help = "run emulation with one guest instruction per translation block",
388 .cmd = hmp_one_insn_per_tb,
389 },
390
391SRST
392``one-insn-per-tb [off]``
393 Run the emulation with one guest instruction per translation block.
394 This slows down emulation a lot, but can be useful in some situations,
395 such as when trying to analyse the logs produced by the ``-d`` option.
396 This only has an effect when using TCG, not with KVM or other accelerators.
397
398 If called with option off, the emulation returns to normal mode.
399ERST
400
401 {
BALATON Zoltande4cf842021-10-30 11:49:37 +0200402 .name = "stop|s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300403 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300404 .params = "",
405 .help = "stop emulation",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400406 .cmd = hmp_stop,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300407 },
408
Peter Maydella6b30bc2020-02-28 15:36:06 +0000409SRST
BALATON Zoltande4cf842021-10-30 11:49:37 +0200410``stop`` or ``s``
Peter Maydella6b30bc2020-02-28 15:36:06 +0000411 Stop emulation.
412ERST
Blue Swirl23130862009-06-06 08:22:04 +0000413
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300414 {
Peter Maydellff688cd2020-11-21 15:17:11 +0000415 .name = "cont|c",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300416 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300417 .params = "",
418 .help = "resume emulation",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400419 .cmd = hmp_cont,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300420 },
421
Peter Maydella6b30bc2020-02-28 15:36:06 +0000422SRST
Peter Maydellff688cd2020-11-21 15:17:11 +0000423``cont`` or ``c``
Peter Maydella6b30bc2020-02-28 15:36:06 +0000424 Resume emulation.
425ERST
Blue Swirl23130862009-06-06 08:22:04 +0000426
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300427 {
Gerd Hoffmann9b9df252012-02-23 13:45:21 +0100428 .name = "system_wakeup",
429 .args_type = "",
430 .params = "",
431 .help = "wakeup guest from suspend",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400432 .cmd = hmp_system_wakeup,
Gerd Hoffmann9b9df252012-02-23 13:45:21 +0100433 },
434
Peter Maydella6b30bc2020-02-28 15:36:06 +0000435SRST
436``system_wakeup``
437 Wakeup guest from suspend.
438ERST
Gerd Hoffmann9b9df252012-02-23 13:45:21 +0100439
440 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300441 .name = "gdbserver",
442 .args_type = "device:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300443 .params = "[device]",
444 .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400445 .cmd = hmp_gdbserver,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300446 },
447
Peter Maydella6b30bc2020-02-28 15:36:06 +0000448SRST
449``gdbserver`` [*port*]
450 Start gdbserver session (default *port*\=1234)
451ERST
Blue Swirl23130862009-06-06 08:22:04 +0000452
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300453 {
454 .name = "x",
455 .args_type = "fmt:/,addr:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300456 .params = "/fmt addr",
457 .help = "virtual memory dump starting at 'addr'",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400458 .cmd = hmp_memory_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300459 },
460
Peter Maydella6b30bc2020-02-28 15:36:06 +0000461SRST
462``x/``\ *fmt* *addr*
463 Virtual memory dump starting at *addr*.
464ERST
Blue Swirl23130862009-06-06 08:22:04 +0000465
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300466 {
467 .name = "xp",
468 .args_type = "fmt:/,addr:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300469 .params = "/fmt addr",
470 .help = "physical memory dump starting at 'addr'",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400471 .cmd = hmp_physical_memory_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300472 },
473
Peter Maydella6b30bc2020-02-28 15:36:06 +0000474SRST
475``xp /``\ *fmt* *addr*
476 Physical memory dump starting at *addr*.
477
478 *fmt* is a format which tells the command how to format the
479 data. Its syntax is: ``/{count}{format}{size}``
480
481 *count*
482 is the number of items to be dumped.
483 *format*
484 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
485 c (char) or i (asm instruction).
486 *size*
487 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
488 ``h`` or ``w`` can be specified with the ``i`` format to
489 respectively select 16 or 32 bit code instruction size.
490
491 Examples:
492
493 Dump 10 instructions at the current instruction pointer::
494
495 (qemu) x/10i $eip
496 0x90107063: ret
497 0x90107064: sti
498 0x90107065: lea 0x0(%esi,1),%esi
499 0x90107069: lea 0x0(%edi,1),%edi
500 0x90107070: ret
501 0x90107071: jmp 0x90107080
502 0x90107073: nop
503 0x90107074: nop
504 0x90107075: nop
505 0x90107076: nop
506
507 Dump 80 16 bit values at the start of the video memory::
508
509 (qemu) xp/80hx 0xb8000
510 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
511 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
512 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
513 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
514 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
515 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
516 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
517 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
518 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
519 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
520
521ERST
Blue Swirl23130862009-06-06 08:22:04 +0000522
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300523 {
Paolo Bonzinie9628442017-04-20 15:30:58 +0200524 .name = "gpa2hva",
525 .args_type = "addr:l",
526 .params = "addr",
527 .help = "print the host virtual address corresponding to a guest physical address",
528 .cmd = hmp_gpa2hva,
529 },
530
Peter Maydella6b30bc2020-02-28 15:36:06 +0000531SRST
532``gpa2hva`` *addr*
533 Print the host virtual address at which the guest's physical address *addr*
534 is mapped.
535ERST
Paolo Bonzinie9628442017-04-20 15:30:58 +0200536
537#ifdef CONFIG_LINUX
538 {
539 .name = "gpa2hpa",
540 .args_type = "addr:l",
541 .params = "addr",
542 .help = "print the host physical address corresponding to a guest physical address",
543 .cmd = hmp_gpa2hpa,
544 },
545#endif
546
Peter Maydella6b30bc2020-02-28 15:36:06 +0000547SRST
548``gpa2hpa`` *addr*
549 Print the host physical address at which the guest's physical address *addr*
550 is mapped.
551ERST
Paolo Bonzinie9628442017-04-20 15:30:58 +0200552
553 {
Dr. David Alan Gilbert574d9692019-04-12 16:26:52 +0100554 .name = "gva2gpa",
555 .args_type = "addr:l",
556 .params = "addr",
557 .help = "print the guest physical address corresponding to a guest virtual address",
558 .cmd = hmp_gva2gpa,
559 },
560
Peter Maydella6b30bc2020-02-28 15:36:06 +0000561SRST
562``gva2gpa`` *addr*
563 Print the guest physical address at which the guest's virtual address *addr*
564 is mapped based on the mapping for the current CPU.
565ERST
Dr. David Alan Gilbert574d9692019-04-12 16:26:52 +0100566
567 {
Peter Maydellff688cd2020-11-21 15:17:11 +0000568 .name = "print|p",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300569 .args_type = "fmt:/,val:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300570 .params = "/fmt expr",
571 .help = "print expression value (use $reg for CPU register access)",
Markus Armbrustercbf81992023-01-24 13:19:43 +0100572 .cmd = hmp_print,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300573 },
574
Peter Maydella6b30bc2020-02-28 15:36:06 +0000575SRST
Peter Maydellff688cd2020-11-21 15:17:11 +0000576``print`` or ``p/``\ *fmt* *expr*
Peter Maydella6b30bc2020-02-28 15:36:06 +0000577 Print expression value. Only the *format* part of *fmt* is
578 used.
579ERST
Blue Swirl23130862009-06-06 08:22:04 +0000580
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300581 {
582 .name = "i",
583 .args_type = "fmt:/,addr:i,index:i.",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300584 .params = "/fmt addr",
585 .help = "I/O port read",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400586 .cmd = hmp_ioport_read,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300587 },
588
Peter Maydella6b30bc2020-02-28 15:36:06 +0000589SRST
590``i/``\ *fmt* *addr* [.\ *index*\ ]
591 Read I/O port.
592ERST
Blue Swirl23130862009-06-06 08:22:04 +0000593
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300594 {
595 .name = "o",
596 .args_type = "fmt:/,addr:i,val:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300597 .params = "/fmt addr value",
598 .help = "I/O port write",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400599 .cmd = hmp_ioport_write,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300600 },
601
Peter Maydella6b30bc2020-02-28 15:36:06 +0000602SRST
603``o/``\ *fmt* *addr* *val*
604 Write to I/O port.
605ERST
Blue Swirl23130862009-06-06 08:22:04 +0000606
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300607 {
608 .name = "sendkey",
Amos Kong2ef20c12012-08-31 10:56:22 +0800609 .args_type = "keys:s,hold-time:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300610 .params = "keys [hold_ms]",
611 .help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400612 .cmd = hmp_sendkey,
Hani Benhabiles29136cd2014-05-07 23:41:27 +0100613 .command_completion = sendkey_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300614 },
615
Peter Maydella6b30bc2020-02-28 15:36:06 +0000616SRST
617``sendkey`` *keys*
618 Send *keys* to the guest. *keys* could be the name of the
619 key or the raw value in hexadecimal format. Use ``-`` to press
620 several keys simultaneously. Example::
621
622 sendkey ctrl-alt-f1
623
624 This command is useful to send keys that your graphical user interface
625 intercepts at low level, such as ``ctrl-alt-f1`` in X Window.
626ERST
Emilio G. Cotadd12e1b2018-08-15 16:00:03 -0400627 {
628 .name = "sync-profile",
629 .args_type = "op:s?",
630 .params = "[on|off|reset]",
631 .help = "enable, disable or reset synchronization profiling. "
632 "With no arguments, prints whether profiling is on or off.",
633 .cmd = hmp_sync_profile,
634 },
635
Peter Maydella6b30bc2020-02-28 15:36:06 +0000636SRST
637``sync-profile [on|off|reset]``
638 Enable, disable or reset synchronization profiling. With no arguments, prints
639 whether profiling is on or off.
640ERST
Blue Swirl23130862009-06-06 08:22:04 +0000641
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300642 {
643 .name = "system_reset",
644 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300645 .params = "",
646 .help = "reset the system",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400647 .cmd = hmp_system_reset,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300648 },
649
Peter Maydella6b30bc2020-02-28 15:36:06 +0000650SRST
651``system_reset``
652 Reset the system.
653ERST
Blue Swirl23130862009-06-06 08:22:04 +0000654
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300655 {
656 .name = "system_powerdown",
657 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300658 .params = "",
659 .help = "send system power down event",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400660 .cmd = hmp_system_powerdown,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300661 },
662
Peter Maydella6b30bc2020-02-28 15:36:06 +0000663SRST
664``system_powerdown``
665 Power down the system (if supported).
666ERST
Blue Swirl23130862009-06-06 08:22:04 +0000667
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300668 {
669 .name = "sum",
670 .args_type = "start:i,size:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300671 .params = "addr size",
672 .help = "compute the checksum of a memory region",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400673 .cmd = hmp_sum,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300674 },
675
Peter Maydella6b30bc2020-02-28 15:36:06 +0000676SRST
677``sum`` *addr* *size*
678 Compute the checksum of a memory region.
679ERST
Blue Swirl23130862009-06-06 08:22:04 +0000680
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300681 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300682 .name = "device_add",
Markus Armbrusterc7e4e8c2010-02-10 20:47:28 +0100683 .args_type = "device:O",
684 .params = "driver[,prop=value][,...]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300685 .help = "add device, like -device on the command line",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400686 .cmd = hmp_device_add,
Hani Benhabiles2da1b3a2014-04-13 16:25:07 +0100687 .command_completion = device_add_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300688 },
689
Peter Maydella6b30bc2020-02-28 15:36:06 +0000690SRST
691``device_add`` *config*
692 Add device.
693ERST
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200694
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300695 {
696 .name = "device_del",
697 .args_type = "id:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300698 .params = "device",
699 .help = "remove device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400700 .cmd = hmp_device_del,
Hani Benhabiles2da1b3a2014-04-13 16:25:07 +0100701 .command_completion = device_del_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300702 },
703
Peter Maydella6b30bc2020-02-28 15:36:06 +0000704SRST
705``device_del`` *id*
706 Remove device *id*. *id* may be a short ID
707 or a QOM object path.
708ERST
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200709
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300710 {
711 .name = "cpu",
712 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300713 .params = "index",
714 .help = "set the default CPU",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400715 .cmd = hmp_cpu,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300716 },
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200717
Peter Maydella6b30bc2020-02-28 15:36:06 +0000718SRST
719``cpu`` *index*
720 Set the default CPU.
721ERST
Blue Swirl23130862009-06-06 08:22:04 +0000722
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300723 {
724 .name = "mouse_move",
725 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300726 .params = "dx dy [dz]",
727 .help = "send mouse move events",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400728 .cmd = hmp_mouse_move,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300729 },
730
Peter Maydella6b30bc2020-02-28 15:36:06 +0000731SRST
732``mouse_move`` *dx* *dy* [*dz*]
733 Move the active mouse to the specified coordinates *dx* *dy*
734 with optional scroll axis *dz*.
735ERST
Blue Swirl23130862009-06-06 08:22:04 +0000736
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300737 {
738 .name = "mouse_button",
739 .args_type = "button_state:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300740 .params = "state",
741 .help = "change mouse button state (1=L, 2=M, 4=R)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400742 .cmd = hmp_mouse_button,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300743 },
744
Peter Maydella6b30bc2020-02-28 15:36:06 +0000745SRST
746``mouse_button`` *val*
747 Change the active mouse button state *val* (1=L, 2=M, 4=R).
748ERST
Blue Swirl23130862009-06-06 08:22:04 +0000749
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300750 {
751 .name = "mouse_set",
752 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300753 .params = "index",
754 .help = "set which mouse device receives events",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400755 .cmd = hmp_mouse_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300756 },
757
Peter Maydella6b30bc2020-02-28 15:36:06 +0000758SRST
759``mouse_set`` *index*
760 Set which mouse device receives events at given *index*, index
761 can be obtained with::
762
763 info mice
764
765ERST
Blue Swirl23130862009-06-06 08:22:04 +0000766
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300767 {
768 .name = "wavcapture",
Kővágó, Zoltánf0b9f362019-08-19 01:06:48 +0200769 .args_type = "path:F,audiodev:s,freq:i?,bits:i?,nchannels:i?",
770 .params = "path audiodev [frequency [bits [channels]]]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300771 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400772 .cmd = hmp_wavcapture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300773 },
Peter Maydella6b30bc2020-02-28 15:36:06 +0000774SRST
775``wavcapture`` *filename* *audiodev* [*frequency* [*bits* [*channels*]]]
776 Capture audio into *filename* from *audiodev*, using sample rate
777 *frequency* bits per sample *bits* and number of channels
778 *channels*.
779
780 Defaults:
781
782 - Sample rate = 44100 Hz - CD quality
783 - Bits = 16
784 - Number of channels = 2 - Stereo
785ERST
Blue Swirl23130862009-06-06 08:22:04 +0000786
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300787 {
788 .name = "stopcapture",
789 .args_type = "n:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300790 .params = "capture index",
791 .help = "stop capture",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400792 .cmd = hmp_stopcapture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300793 },
Peter Maydella6b30bc2020-02-28 15:36:06 +0000794SRST
795``stopcapture`` *index*
796 Stop capture with a given *index*, index can be obtained with::
797
798 info capture
799
800ERST
Blue Swirl23130862009-06-06 08:22:04 +0000801
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300802 {
803 .name = "memsave",
804 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300805 .params = "addr size file",
806 .help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400807 .cmd = hmp_memsave,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300808 },
809
Peter Maydella6b30bc2020-02-28 15:36:06 +0000810SRST
811``memsave`` *addr* *size* *file*
812 save to disk virtual memory dump starting at *addr* of size *size*.
813ERST
Blue Swirl23130862009-06-06 08:22:04 +0000814
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300815 {
816 .name = "pmemsave",
817 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300818 .params = "addr size file",
819 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400820 .cmd = hmp_pmemsave,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300821 },
822
Peter Maydella6b30bc2020-02-28 15:36:06 +0000823SRST
824``pmemsave`` *addr* *size* *file*
825 save to disk physical memory dump starting at *addr* of size *size*.
826ERST
Blue Swirl23130862009-06-06 08:22:04 +0000827
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300828 {
829 .name = "boot_set",
830 .args_type = "bootdevice:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300831 .params = "bootdevice",
832 .help = "define new values for the boot device list",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400833 .cmd = hmp_boot_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300834 },
835
Peter Maydella6b30bc2020-02-28 15:36:06 +0000836SRST
837``boot_set`` *bootdevicelist*
838 Define new values for the boot device list. Those values will override
839 the values specified on the command line through the ``-boot`` option.
840
841 The values that can be specified here depend on the machine type, but are
842 the same that can be specified in the ``-boot`` command line option.
843ERST
Blue Swirl23130862009-06-06 08:22:04 +0000844
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300845 {
846 .name = "nmi",
Luiz Capitulinoe9b4b432011-04-29 12:11:50 -0300847 .args_type = "",
848 .params = "",
Alexey Kardashevskiy9cb805f2014-08-20 22:16:33 +1000849 .help = "inject an NMI",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400850 .cmd = hmp_nmi,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300851 },
Peter Maydella6b30bc2020-02-28 15:36:06 +0000852SRST
853``nmi`` *cpu*
854 Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
855ERST
Lei Li1f590cf2013-01-25 00:03:20 +0800856
857 {
Markus Armbruster3949e592013-02-06 21:27:24 +0100858 .name = "ringbuf_write",
Lei Li1f590cf2013-01-25 00:03:20 +0800859 .args_type = "device:s,data:s",
860 .params = "device data",
Markus Armbruster3949e592013-02-06 21:27:24 +0100861 .help = "Write to a ring buffer character device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400862 .cmd = hmp_ringbuf_write,
Hani Benhabiles8e597772014-05-27 23:39:30 +0100863 .command_completion = ringbuf_write_completion,
Lei Li1f590cf2013-01-25 00:03:20 +0800864 },
865
Peter Maydella6b30bc2020-02-28 15:36:06 +0000866SRST
867``ringbuf_write`` *device* *data*
868 Write *data* to ring buffer character device *device*.
869 *data* must be a UTF-8 string.
870ERST
Blue Swirl23130862009-06-06 08:22:04 +0000871
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300872 {
Markus Armbruster3949e592013-02-06 21:27:24 +0100873 .name = "ringbuf_read",
Lei Li49b6d722013-01-25 00:03:21 +0800874 .args_type = "device:s,size:i",
875 .params = "device size",
Markus Armbruster3949e592013-02-06 21:27:24 +0100876 .help = "Read from a ring buffer character device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400877 .cmd = hmp_ringbuf_read,
Hani Benhabiles8e597772014-05-27 23:39:30 +0100878 .command_completion = ringbuf_write_completion,
Lei Li49b6d722013-01-25 00:03:21 +0800879 },
880
Peter Maydella6b30bc2020-02-28 15:36:06 +0000881SRST
882``ringbuf_read`` *device*
883 Read and print up to *size* bytes from ring buffer character
884 device *device*.
885 Certain non-printable characters are printed ``\uXXXX``, where ``XXXX`` is the
886 character code in hexadecimal. Character ``\`` is printed ``\\``.
887 Bug: can screw up when the buffer contains invalid UTF-8 sequences,
888 NUL characters, after the ring buffer lost data, and when reading
889 stops because the size limit is reached.
890ERST
Lei Li49b6d722013-01-25 00:03:21 +0800891
892 {
Dr. David Alan Gilbert544f6ea2019-02-27 13:24:12 +0000893 .name = "announce_self",
Dr. David Alan Gilbertc6644542019-06-20 19:47:05 +0100894 .args_type = "interfaces:s?,id:s?",
895 .params = "[interfaces] [id]",
Dr. David Alan Gilbert544f6ea2019-02-27 13:24:12 +0000896 .help = "Trigger GARP/RARP announcements",
897 .cmd = hmp_announce_self,
898 },
899
Peter Maydella6b30bc2020-02-28 15:36:06 +0000900SRST
901``announce_self``
902 Trigger a round of GARP/RARP broadcasts; this is useful for explicitly
903 updating the network infrastructure after a reconfiguration or some forms
904 of migration. The timings of the round are set by the migration announce
905 parameters. An optional comma separated *interfaces* list restricts the
906 announce to the named set of interfaces. An optional *id* can be used to
907 start a separate announce timer and to change the parameters of it later.
908ERST
Dr. David Alan Gilbert544f6ea2019-02-27 13:24:12 +0000909
910 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300911 .name = "migrate",
Fabiano Rosas18d154f2024-04-30 11:27:34 -0300912 .args_type = "detach:-d,resume:-r,uri:s",
913 .params = "[-d] [-r] uri",
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200914 .help = "migrate to URI (using -d to not wait for completion)"
Peter Xudb8cb7b2024-05-03 10:41:26 -0400915 "\n\t\t\t -r to resume a paused postcopy migration",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400916 .cmd = hmp_migrate,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300917 },
918
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200919
Peter Maydella6b30bc2020-02-28 15:36:06 +0000920SRST
Peter Xudb8cb7b2024-05-03 10:41:26 -0400921``migrate [-d] [-r]`` *uri*
922 Migrate the VM to *uri*.
923
924 ``-d``
925 Start the migration process, but do not wait for its completion. To
926 query an ongoing migration process, use "info migrate".
927 ``-r``
928 Resume a paused postcopy migration.
Peter Maydella6b30bc2020-02-28 15:36:06 +0000929ERST
Blue Swirl23130862009-06-06 08:22:04 +0000930
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300931 {
932 .name = "migrate_cancel",
933 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300934 .params = "",
935 .help = "cancel the current VM migration",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400936 .cmd = hmp_migrate_cancel,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300937 },
938
Peter Maydella6b30bc2020-02-28 15:36:06 +0000939SRST
940``migrate_cancel``
941 Cancel the current VM migration.
942ERST
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300943
Dr. David Alan Gilbert94ae12c2017-10-20 10:05:54 +0100944 {
945 .name = "migrate_continue",
946 .args_type = "state:s",
947 .params = "state",
948 .help = "Continue migration from the given paused state",
949 .cmd = hmp_migrate_continue,
950 },
Peter Maydella6b30bc2020-02-28 15:36:06 +0000951SRST
952``migrate_continue`` *state*
953 Continue migration from the paused state *state*
954ERST
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300955
956 {
Dr. David Alan Gilbertbf1ae1f2015-02-19 11:40:28 +0000957 .name = "migrate_incoming",
958 .args_type = "uri:s",
959 .params = "uri",
960 .help = "Continue an incoming migration from an -incoming defer",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400961 .cmd = hmp_migrate_incoming,
Dr. David Alan Gilbertbf1ae1f2015-02-19 11:40:28 +0000962 },
963
Peter Maydella6b30bc2020-02-28 15:36:06 +0000964SRST
965``migrate_incoming`` *uri*
966 Continue an incoming migration using the *uri* (that has the same syntax
967 as the ``-incoming`` option).
968ERST
Dr. David Alan Gilbertbf1ae1f2015-02-19 11:40:28 +0000969
Peter Xu3b563c42018-05-02 18:47:37 +0800970 {
971 .name = "migrate_recover",
972 .args_type = "uri:s",
973 .params = "uri",
974 .help = "Continue a paused incoming postcopy migration",
975 .cmd = hmp_migrate_recover,
976 },
977
Peter Maydella6b30bc2020-02-28 15:36:06 +0000978SRST
979``migrate_recover`` *uri*
980 Continue a paused incoming postcopy migration using the *uri*.
981ERST
Dr. David Alan Gilbertbf1ae1f2015-02-19 11:40:28 +0000982
983 {
Peter Xud37297d2018-05-02 18:47:40 +0800984 .name = "migrate_pause",
985 .args_type = "",
986 .params = "",
987 .help = "Pause an ongoing migration (postcopy-only)",
988 .cmd = hmp_migrate_pause,
989 },
990
Peter Maydella6b30bc2020-02-28 15:36:06 +0000991SRST
992``migrate_pause``
993 Pause an ongoing migration. Currently it only supports postcopy.
994ERST
Peter Xud37297d2018-05-02 18:47:40 +0800995
996 {
Orit Wasserman00458432012-08-06 21:42:48 +0300997 .name = "migrate_set_capability",
998 .args_type = "capability:s,state:b",
999 .params = "capability state",
1000 .help = "Enable/Disable the usage of a capability for migration",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001001 .cmd = hmp_migrate_set_capability,
Hani Benhabilesc68a0402014-05-27 23:39:32 +01001002 .command_completion = migrate_set_capability_completion,
Orit Wasserman00458432012-08-06 21:42:48 +03001003 },
1004
Peter Maydella6b30bc2020-02-28 15:36:06 +00001005SRST
1006``migrate_set_capability`` *capability* *state*
1007 Enable/Disable the usage of a capability *capability* for migration.
1008ERST
Orit Wasserman00458432012-08-06 21:42:48 +03001009
1010 {
Liang Li50e9a622015-03-23 16:32:29 +08001011 .name = "migrate_set_parameter",
Daniel P. Berrange69ef1f32016-04-27 11:05:15 +01001012 .args_type = "parameter:s,value:s",
Liang Li50e9a622015-03-23 16:32:29 +08001013 .params = "parameter value",
1014 .help = "Set the parameter for migration",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001015 .cmd = hmp_migrate_set_parameter,
Liang Li50e9a622015-03-23 16:32:29 +08001016 .command_completion = migrate_set_parameter_completion,
1017 },
1018
Peter Maydella6b30bc2020-02-28 15:36:06 +00001019SRST
1020``migrate_set_parameter`` *parameter* *value*
1021 Set the parameter *parameter* for migration.
1022ERST
Liang Li50e9a622015-03-23 16:32:29 +08001023
1024 {
Dr. David Alan Gilbert4886a1b2015-11-05 18:10:56 +00001025 .name = "migrate_start_postcopy",
1026 .args_type = "",
1027 .params = "",
Dr. David Alan Gilberta54d3402015-11-12 11:34:44 +00001028 .help = "Followup to a migration command to switch the migration"
Dr. David Alan Gilbert32c3db52016-03-11 09:53:36 +00001029 " to postcopy mode. The postcopy-ram capability must "
Greg Kurzc2eb7f22018-02-07 16:41:43 +01001030 "be set on both source and destination before the "
1031 "original migration command .",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001032 .cmd = hmp_migrate_start_postcopy,
Dr. David Alan Gilbert4886a1b2015-11-05 18:10:56 +00001033 },
1034
Peter Maydella6b30bc2020-02-28 15:36:06 +00001035SRST
1036``migrate_start_postcopy``
1037 Switch in-progress migration to postcopy mode. Ignored after the end of
1038 migration (or once already in postcopy).
1039ERST
Dr. David Alan Gilbert4886a1b2015-11-05 18:10:56 +00001040
Vladimir Sementsov-Ogievskiy51e47cf2023-04-28 22:49:21 +03001041#ifdef CONFIG_REPLICATION
Dr. David Alan Gilbert4886a1b2015-11-05 18:10:56 +00001042 {
zhanghailiangd89e6662016-10-27 14:43:03 +08001043 .name = "x_colo_lost_heartbeat",
1044 .args_type = "",
1045 .params = "",
1046 .help = "Tell COLO that heartbeat is lost,\n\t\t\t"
1047 "a failover or takeover is needed.",
1048 .cmd = hmp_x_colo_lost_heartbeat,
1049 },
Vladimir Sementsov-Ogievskiy51e47cf2023-04-28 22:49:21 +03001050#endif
zhanghailiangd89e6662016-10-27 14:43:03 +08001051
Peter Maydella6b30bc2020-02-28 15:36:06 +00001052SRST
1053``x_colo_lost_heartbeat``
1054 Tell COLO that heartbeat is lost, a failover or takeover is needed.
1055ERST
zhanghailiangd89e6662016-10-27 14:43:03 +08001056
1057 {
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001058 .name = "client_migrate_info",
1059 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1060 .params = "protocol hostname port tls-port cert-subject",
Markus Armbruster13cadef2015-03-05 19:16:58 +01001061 .help = "set migration information for remote display",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001062 .cmd = hmp_client_migrate_info,
Jes Sorensenf8882562010-12-16 13:52:16 +01001063 },
1064
Peter Maydella6b30bc2020-02-28 15:36:06 +00001065SRST
1066``client_migrate_info`` *protocol* *hostname* *port* *tls-port* *cert-subject*
1067 Set migration information for remote display. This makes the server
1068 ask the client to automatically reconnect using the new parameters
1069 once migration finished successfully. Only implemented for SPICE.
1070ERST
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001071
Wen Congyang783e9b42012-05-07 12:10:47 +08001072 {
1073 .name = "dump-guest-memory",
Stephen Brennane6549192023-09-18 16:32:33 -07001074 .args_type = "paging:-p,detach:-d,windmp:-w,zlib:-z,lzo:-l,snappy:-s,raw:-R,filename:F,begin:l?,length:l?",
1075 .params = "[-p] [-d] [-z|-l|-s|-w] [-R] filename [begin length]",
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001076 .help = "dump guest memory into file 'filename'.\n\t\t\t"
1077 "-p: do paging to get guest's memory mapping.\n\t\t\t"
Peter Xu228de9c2016-02-18 13:16:47 +08001078 "-d: return immediately (do not wait for completion).\n\t\t\t"
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001079 "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1080 "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1081 "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
Stephen Brennane6549192023-09-18 16:32:33 -07001082 "-R: when using kdump (-z, -l, -s), use raw rather than makedumpfile-flattened\n\t\t\t"
1083 " format\n\t\t\t"
Viktor Prutyanov2da91b52018-05-17 19:23:39 +03001084 "-w: dump in Windows crashdump format (can be used instead of ELF-dump converting),\n\t\t\t"
Viktor Prutyanovf5daa822022-04-06 20:15:58 +03001085 " for Windows x86 and x64 guests with vmcoreinfo driver only.\n\t\t\t"
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001086 "begin: the starting physical address.\n\t\t\t"
1087 "length: the memory size, in bytes.",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001088 .cmd = hmp_dump_guest_memory,
Wen Congyang783e9b42012-05-07 12:10:47 +08001089 },
1090
Peter Maydella6b30bc2020-02-28 15:36:06 +00001091SRST
1092``dump-guest-memory [-p]`` *filename* *begin* *length*
1093 \
1094``dump-guest-memory [-z|-l|-s|-w]`` *filename*
1095 Dump guest memory to *protocol*. The file can be processed with crash or
1096 gdb. Without ``-z|-l|-s|-w``, the dump format is ELF.
1097
1098 ``-p``
1099 do paging to get guest's memory mapping.
1100 ``-z``
1101 dump in kdump-compressed format, with zlib compression.
1102 ``-l``
1103 dump in kdump-compressed format, with lzo compression.
1104 ``-s``
1105 dump in kdump-compressed format, with snappy compression.
Stephen Brennane6549192023-09-18 16:32:33 -07001106 ``-R``
1107 when using kdump (-z, -l, -s), use raw rather than makedumpfile-flattened
1108 format
Peter Maydella6b30bc2020-02-28 15:36:06 +00001109 ``-w``
1110 dump in Windows crashdump format (can be used instead of ELF-dump converting),
1111 for Windows x64 guests with vmcoreinfo driver only
1112 *filename*
1113 dump file name.
1114 *begin*
1115 the starting physical address. It's optional, and should be
1116 specified together with *length*.
1117 *length*
1118 the memory size, in bytes. It's optional, and should be specified
1119 together with *begin*.
1120
1121ERST
Wen Congyang783e9b42012-05-07 12:10:47 +08001122
Jason J. Hernea4538a52015-06-26 14:07:21 -04001123#if defined(TARGET_S390X)
1124 {
1125 .name = "dump-skeys",
1126 .args_type = "filename:F",
1127 .params = "",
1128 .help = "Save guest storage keys into file 'filename'.\n",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001129 .cmd = hmp_dump_skeys,
Jason J. Hernea4538a52015-06-26 14:07:21 -04001130 },
1131#endif
1132
Peter Maydella6b30bc2020-02-28 15:36:06 +00001133SRST
1134``dump-skeys`` *filename*
1135 Save guest storage keys to a file.
1136ERST
Jason J. Hernea4538a52015-06-26 14:07:21 -04001137
Claudio Imbrendaf860d492016-08-15 18:44:04 +02001138#if defined(TARGET_S390X)
1139 {
1140 .name = "migration_mode",
1141 .args_type = "mode:i",
1142 .params = "mode",
1143 .help = "Enables or disables migration mode\n",
1144 .cmd = hmp_migrationmode,
1145 },
1146#endif
1147
Peter Maydella6b30bc2020-02-28 15:36:06 +00001148SRST
1149``migration_mode`` *mode*
1150 Enables or disables migration mode.
1151ERST
Claudio Imbrendaf860d492016-08-15 18:44:04 +02001152
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001153 {
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001154 .name = "snapshot_blkdev",
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001155 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1156 .params = "[-n] device [new-image-file] [format]",
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001157 .help = "initiates a live snapshot\n\t\t\t"
1158 "of device. If a new image file is specified, the\n\t\t\t"
1159 "new image file will become the new root image.\n\t\t\t"
1160 "If format is specified, the snapshot file will\n\t\t\t"
Wenchao Xia775ca882013-09-11 14:04:37 +08001161 "be created in that format.\n\t\t\t"
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001162 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1163 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1164 "recreating it from scratch.",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001165 .cmd = hmp_snapshot_blkdev,
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001166 },
1167
Peter Maydella6b30bc2020-02-28 15:36:06 +00001168SRST
1169``snapshot_blkdev``
1170 Snapshot device, using snapshot file as target if provided
1171ERST
Jes Sorensenf8882562010-12-16 13:52:16 +01001172
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001173 {
Wenchao Xia775ca882013-09-11 14:04:37 +08001174 .name = "snapshot_blkdev_internal",
1175 .args_type = "device:B,name:s",
1176 .params = "device name",
1177 .help = "take an internal snapshot of device.\n\t\t\t"
1178 "The format of the image used by device must\n\t\t\t"
1179 "support it, such as qcow2.\n\t\t\t",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001180 .cmd = hmp_snapshot_blkdev_internal,
Wenchao Xia775ca882013-09-11 14:04:37 +08001181 },
1182
Peter Maydella6b30bc2020-02-28 15:36:06 +00001183SRST
1184``snapshot_blkdev_internal``
1185 Take an internal snapshot on device if it support
1186ERST
Wenchao Xia775ca882013-09-11 14:04:37 +08001187
1188 {
Wenchao Xia7a4ed2e2013-09-11 14:04:38 +08001189 .name = "snapshot_delete_blkdev_internal",
1190 .args_type = "device:B,name:s,id:s?",
1191 .params = "device name [id]",
1192 .help = "delete an internal snapshot of device.\n\t\t\t"
1193 "If id is specified, qemu will try delete\n\t\t\t"
1194 "the snapshot matching both id and name.\n\t\t\t"
1195 "The format of the image used by device must\n\t\t\t"
1196 "support it, such as qcow2.\n\t\t\t",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001197 .cmd = hmp_snapshot_delete_blkdev_internal,
Wenchao Xia7a4ed2e2013-09-11 14:04:38 +08001198 },
1199
Peter Maydella6b30bc2020-02-28 15:36:06 +00001200SRST
1201``snapshot_delete_blkdev_internal``
1202 Delete an internal snapshot on device if it support
1203ERST
Wenchao Xia7a4ed2e2013-09-11 14:04:38 +08001204
1205 {
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02001206 .name = "drive_mirror",
1207 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1208 .params = "[-n] [-f] device target [format]",
1209 .help = "initiates live storage\n\t\t\t"
1210 "migration for a device. The device's contents are\n\t\t\t"
1211 "copied to the new image file, including data that\n\t\t\t"
1212 "is written after the command is started.\n\t\t\t"
1213 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1214 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1215 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1216 "so that the result does not need a backing file.\n\t\t\t",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001217 .cmd = hmp_drive_mirror,
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02001218 },
Peter Maydella6b30bc2020-02-28 15:36:06 +00001219SRST
1220``drive_mirror``
1221 Start mirroring a block device's writes to a new destination,
1222 using the specified target.
1223ERST
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02001224
1225 {
Stefan Hajnoczide909302013-06-26 14:11:58 +02001226 .name = "drive_backup",
Pavel Butsykin13b94142016-07-22 11:17:52 +03001227 .args_type = "reuse:-n,full:-f,compress:-c,device:B,target:s,format:s?",
1228 .params = "[-n] [-f] [-c] device target [format]",
Stefan Hajnoczide909302013-06-26 14:11:58 +02001229 .help = "initiates a point-in-time\n\t\t\t"
1230 "copy for a device. The device's contents are\n\t\t\t"
1231 "copied to the new image file, excluding data that\n\t\t\t"
1232 "is written after the command is started.\n\t\t\t"
1233 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1234 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1235 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
Pavel Butsykin13b94142016-07-22 11:17:52 +03001236 "so that the result does not need a backing file.\n\t\t\t"
1237 "The -c flag requests QEMU to compress backup data\n\t\t\t"
1238 "(if the target format supports it).\n\t\t\t",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001239 .cmd = hmp_drive_backup,
Stefan Hajnoczide909302013-06-26 14:11:58 +02001240 },
Peter Maydella6b30bc2020-02-28 15:36:06 +00001241SRST
1242``drive_backup``
zhaolichange3a6e0d2020-09-17 15:50:20 +08001243 Start a point-in-time copy of a block device to a specified target.
Peter Maydella6b30bc2020-02-28 15:36:06 +00001244ERST
Stefan Hajnoczide909302013-06-26 14:11:58 +02001245
1246 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001247 .name = "drive_add",
Kevin Wolfabb21ac2016-02-23 17:33:24 +01001248 .args_type = "node:-n,pci_addr:s,opts:s",
1249 .params = "[-n] [[<domain>:]<bus>:]<slot>\n"
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001250 "[file=file][,if=type][,bus=n]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +00001251 "[,unit=m][,media=d][,index=i]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +00001252 "[,snapshot=on|off][,cache=on|off]\n"
1253 "[,readonly=on|off][,copy-on-read=on|off]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001254 .help = "add drive to PCI storage controller",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001255 .cmd = hmp_drive_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001256 },
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001257
Peter Maydella6b30bc2020-02-28 15:36:06 +00001258SRST
1259``drive_add``
1260 Add drive to PCI storage controller.
1261ERST
Blue Swirl23130862009-06-06 08:22:04 +00001262
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001263 {
Isaku Yamahata2ae63bd2010-12-24 12:14:14 +09001264 .name = "pcie_aer_inject_error",
1265 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1266 "id:s,error_status:s,"
1267 "header0:i?,header1:i?,header2:i?,header3:i?,"
1268 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1269 .params = "[-a] [-c] id "
1270 "<error_status> [<tlp header> [<tlp header prefix>]]",
1271 .help = "inject pcie aer error\n\t\t\t"
1272 " -a for advisory non fatal error\n\t\t\t"
1273 " -c for correctable error\n\t\t\t"
1274 "<id> = qdev device id\n\t\t\t"
1275 "<error_status> = error string or 32bit\n\t\t\t"
Zenghui Yu8ad4e452020-12-04 11:09:53 +08001276 "<tlp header> = 32bit x 4\n\t\t\t"
1277 "<tlp header prefix> = 32bit x 4",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001278 .cmd = hmp_pcie_aer_inject_error,
Isaku Yamahata2ae63bd2010-12-24 12:14:14 +09001279 },
1280
Peter Maydella6b30bc2020-02-28 15:36:06 +00001281SRST
1282``pcie_aer_inject_error``
1283 Inject PCIe AER error
1284ERST
Isaku Yamahata2ae63bd2010-12-24 12:14:14 +09001285
1286 {
Markus Armbrusterae82d322010-03-25 17:22:40 +01001287 .name = "netdev_add",
1288 .args_type = "netdev:O",
Laurent Vivier5166fe02022-10-21 11:09:11 +02001289 .params = "[user|tap|socket|stream|dgram|vde|bridge|hubport|netmap|vhost-user"
Ilya Maximetscb039ef2023-09-13 20:34:37 +02001290#ifdef CONFIG_AF_XDP
1291 "|af-xdp"
1292#endif
Vladislav Yaroshchukfd8c8c02022-03-17 20:28:39 +03001293#ifdef CONFIG_VMNET
1294 "|vmnet-host|vmnet-shared|vmnet-bridged"
1295#endif
1296 "],id=str[,prop=value][,...]",
Markus Armbrusterae82d322010-03-25 17:22:40 +01001297 .help = "add host network device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001298 .cmd = hmp_netdev_add,
Hani Benhabilesb162b492014-05-07 23:41:31 +01001299 .command_completion = netdev_add_completion,
Paolo Bonzini48f596c2021-05-11 11:39:55 -04001300 .flags = "p",
Markus Armbrusterae82d322010-03-25 17:22:40 +01001301 },
1302
Peter Maydella6b30bc2020-02-28 15:36:06 +00001303SRST
1304``netdev_add``
1305 Add host network device.
1306ERST
Markus Armbrusterae82d322010-03-25 17:22:40 +01001307
1308 {
1309 .name = "netdev_del",
1310 .args_type = "id:s",
1311 .params = "id",
1312 .help = "remove host network device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001313 .cmd = hmp_netdev_del,
Hani Benhabiles11b389f2014-05-07 23:41:32 +01001314 .command_completion = netdev_del_completion,
Paolo Bonzini48f596c2021-05-11 11:39:55 -04001315 .flags = "p",
Markus Armbrusterae82d322010-03-25 17:22:40 +01001316 },
1317
Peter Maydella6b30bc2020-02-28 15:36:06 +00001318SRST
1319``netdev_del``
1320 Remove host network device.
1321ERST
Markus Armbrusterae82d322010-03-25 17:22:40 +01001322
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001323 {
Paolo Bonzinicff8b2c2013-12-20 23:21:10 +01001324 .name = "object_add",
Kevin Wolfda0a9322021-02-17 15:27:54 +01001325 .args_type = "object:S",
Paolo Bonzinicff8b2c2013-12-20 23:21:10 +01001326 .params = "[qom-type=]type,id=str[,prop=value][,...]",
1327 .help = "create QOM object",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001328 .cmd = hmp_object_add,
Hani Benhabilesbfa40f72014-04-13 16:25:06 +01001329 .command_completion = object_add_completion,
Paolo Bonzini9e330132020-11-03 04:39:02 -05001330 .flags = "p",
Paolo Bonzinicff8b2c2013-12-20 23:21:10 +01001331 },
1332
Peter Maydella6b30bc2020-02-28 15:36:06 +00001333SRST
1334``object_add``
1335 Create QOM object.
1336ERST
Paolo Bonzinicff8b2c2013-12-20 23:21:10 +01001337
1338 {
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001339 .name = "object_del",
1340 .args_type = "id:s",
1341 .params = "id",
1342 .help = "destroy QOM object",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001343 .cmd = hmp_object_del,
Hani Benhabilesbfa40f72014-04-13 16:25:06 +01001344 .command_completion = object_del_completion,
Paolo Bonzini9e330132020-11-03 04:39:02 -05001345 .flags = "p",
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001346 },
1347
Peter Maydella6b30bc2020-02-28 15:36:06 +00001348SRST
1349``object_del``
1350 Destroy QOM object.
1351ERST
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001352
Blue Swirl23130862009-06-06 08:22:04 +00001353#ifdef CONFIG_SLIRP
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001354 {
1355 .name = "hostfwd_add",
Thomas Huthb4983c52019-12-05 11:41:09 +01001356 .args_type = "arg1:s,arg2:s?",
1357 .params = "[netdev_id] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001358 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001359 .cmd = hmp_hostfwd_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001360 },
Markus Armbruster21413d62010-05-04 13:20:30 +02001361#endif
Peter Maydella6b30bc2020-02-28 15:36:06 +00001362SRST
1363``hostfwd_add``
1364 Redirect TCP or UDP connections from host to guest (requires -net user).
1365ERST
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001366
Markus Armbruster21413d62010-05-04 13:20:30 +02001367#ifdef CONFIG_SLIRP
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001368 {
1369 .name = "hostfwd_remove",
Thomas Huthb4983c52019-12-05 11:41:09 +01001370 .args_type = "arg1:s,arg2:s?",
1371 .params = "[netdev_id] [tcp|udp]:[hostaddr]:hostport",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001372 .help = "remove host-to-guest TCP or UDP redirection",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001373 .cmd = hmp_hostfwd_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001374 },
1375
Blue Swirl23130862009-06-06 08:22:04 +00001376#endif
Peter Maydella6b30bc2020-02-28 15:36:06 +00001377SRST
1378``hostfwd_remove``
1379 Remove host-to-guest TCP or UDP redirection.
1380ERST
Blue Swirl23130862009-06-06 08:22:04 +00001381
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001382 {
1383 .name = "balloon",
Luiz Capitulino3b0bd6e2009-12-18 13:25:05 -02001384 .args_type = "value:M",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001385 .params = "target",
Riccardo Magliocchetti3c056132010-05-19 18:49:28 +02001386 .help = "request VM to change its memory allocation (in MB)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001387 .cmd = hmp_balloon,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001388 },
1389
Peter Maydella6b30bc2020-02-28 15:36:06 +00001390SRST
1391``balloon`` *value*
1392 Request VM to change its memory allocation to *value* (in MB).
1393ERST
Blue Swirl23130862009-06-06 08:22:04 +00001394
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001395 {
1396 .name = "set_link",
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001397 .args_type = "name:s,up:b",
1398 .params = "name on|off",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001399 .help = "change the link status of a network adapter",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001400 .cmd = hmp_set_link,
Hani Benhabiles40d19392014-05-07 23:41:30 +01001401 .command_completion = set_link_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001402 },
1403
Peter Maydella6b30bc2020-02-28 15:36:06 +00001404SRST
1405``set_link`` *name* ``[on|off]``
1406 Switch link *name* on (i.e. up) or off (i.e. down).
1407ERST
Blue Swirl23130862009-06-06 08:22:04 +00001408
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001409 {
1410 .name = "watchdog_action",
1411 .args_type = "action:s",
Dayu Liu78051322024-04-01 17:43:55 +08001412 .params = "[reset|shutdown|poweroff|pause|debug|none|inject-nmi]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001413 .help = "change watchdog action",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001414 .cmd = hmp_watchdog_action,
Hani Benhabilesd0ece342014-05-27 23:39:31 +01001415 .command_completion = watchdog_action_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001416 },
1417
Peter Maydella6b30bc2020-02-28 15:36:06 +00001418SRST
1419``watchdog_action``
1420 Change watchdog action.
1421ERST
Blue Swirl23130862009-06-06 08:22:04 +00001422
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001423 {
Paolo Bonzini40577252012-08-23 11:53:04 +02001424 .name = "nbd_server_start",
1425 .args_type = "all:-a,writable:-w,uri:s",
1426 .params = "nbd_server_start [-a] [-w] host:port",
1427 .help = "serve block devices on the given host and port",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001428 .cmd = hmp_nbd_server_start,
Paolo Bonzinif55ba802020-11-03 04:37:20 -05001429 .flags = "p",
Paolo Bonzini40577252012-08-23 11:53:04 +02001430 },
Peter Maydella6b30bc2020-02-28 15:36:06 +00001431SRST
1432``nbd_server_start`` *host*:*port*
1433 Start an NBD server on the given host and/or port. If the ``-a``
1434 option is included, all of the virtual machine's block devices that
1435 have an inserted media on them are automatically exported; in this case,
1436 the ``-w`` option makes the devices writable too.
1437ERST
Paolo Bonzini40577252012-08-23 11:53:04 +02001438
1439 {
1440 .name = "nbd_server_add",
Eric Blakedba49322018-01-09 13:28:02 -06001441 .args_type = "writable:-w,device:B,name:s?",
1442 .params = "nbd_server_add [-w] device [name]",
Paolo Bonzini40577252012-08-23 11:53:04 +02001443 .help = "export a block device via NBD",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001444 .cmd = hmp_nbd_server_add,
Paolo Bonzinif55ba802020-11-03 04:37:20 -05001445 .flags = "p",
Paolo Bonzini40577252012-08-23 11:53:04 +02001446 },
Peter Maydella6b30bc2020-02-28 15:36:06 +00001447SRST
1448``nbd_server_add`` *device* [ *name* ]
1449 Export a block device through QEMU's NBD server, which must be started
1450 beforehand with ``nbd_server_start``. The ``-w`` option makes the
1451 exported device writable too. The export name is controlled by *name*,
1452 defaulting to *device*.
1453ERST
Paolo Bonzini40577252012-08-23 11:53:04 +02001454
1455 {
Eric Blake08fb10a2018-01-25 08:45:57 -06001456 .name = "nbd_server_remove",
1457 .args_type = "force:-f,name:s",
1458 .params = "nbd_server_remove [-f] name",
1459 .help = "remove an export previously exposed via NBD",
1460 .cmd = hmp_nbd_server_remove,
Paolo Bonzinif55ba802020-11-03 04:37:20 -05001461 .flags = "p",
Eric Blake08fb10a2018-01-25 08:45:57 -06001462 },
Peter Maydella6b30bc2020-02-28 15:36:06 +00001463SRST
1464``nbd_server_remove [-f]`` *name*
1465 Stop exporting a block device through QEMU's NBD server, which was
1466 previously started with ``nbd_server_add``. The ``-f``
1467 option forces the server to drop the export immediately even if
1468 clients are connected; otherwise the command fails unless there are no
1469 clients.
1470ERST
Eric Blake08fb10a2018-01-25 08:45:57 -06001471
1472 {
Paolo Bonzini40577252012-08-23 11:53:04 +02001473 .name = "nbd_server_stop",
1474 .args_type = "",
1475 .params = "nbd_server_stop",
1476 .help = "stop serving block devices using the NBD protocol",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001477 .cmd = hmp_nbd_server_stop,
Paolo Bonzinif55ba802020-11-03 04:37:20 -05001478 .flags = "p",
Paolo Bonzini40577252012-08-23 11:53:04 +02001479 },
Peter Maydella6b30bc2020-02-28 15:36:06 +00001480SRST
1481``nbd_server_stop``
1482 Stop the QEMU embedded NBD server.
1483ERST
Paolo Bonzini40577252012-08-23 11:53:04 +02001484
1485
Huang Ying79c4f6b2009-06-23 10:05:14 +08001486#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001487
1488 {
1489 .name = "mce",
Jin Dongming31ce5e02010-12-10 17:21:02 +09001490 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1491 .params = "[-b] cpu bank status mcgstatus addr misc",
1492 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001493 .cmd = hmp_mce,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001494 },
1495
Huang Ying79c4f6b2009-06-23 10:05:14 +08001496#endif
Peter Maydella6b30bc2020-02-28 15:36:06 +00001497SRST
1498``mce`` *cpu* *bank* *status* *mcgstatus* *addr* *misc*
1499 Inject an MCE on the given CPU (x86 only).
1500ERST
Huang Ying79c4f6b2009-06-23 10:05:14 +08001501
Marc-André Lureau4bf21c72023-03-02 19:05:41 +04001502#ifdef CONFIG_POSIX
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001503 {
1504 .name = "getfd",
1505 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001506 .params = "getfd name",
1507 .help = "receive a file descriptor via SCM rights and assign it a name",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001508 .cmd = hmp_getfd,
Paolo Bonzinif55ba802020-11-03 04:37:20 -05001509 .flags = "p",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001510 },
1511
Peter Maydella6b30bc2020-02-28 15:36:06 +00001512SRST
1513``getfd`` *fdname*
1514 If a file descriptor is passed alongside this command using the SCM_RIGHTS
1515 mechanism on unix sockets, it is stored using the name *fdname* for
1516 later use by other monitor commands.
1517ERST
Marc-André Lureau4bf21c72023-03-02 19:05:41 +04001518#endif
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001519
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001520 {
1521 .name = "closefd",
1522 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001523 .params = "closefd name",
1524 .help = "close a file descriptor previously passed via SCM rights",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001525 .cmd = hmp_closefd,
Paolo Bonzinif55ba802020-11-03 04:37:20 -05001526 .flags = "p",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001527 },
1528
Peter Maydella6b30bc2020-02-28 15:36:06 +00001529SRST
1530``closefd`` *fdname*
1531 Close the file descriptor previously assigned to *fdname* using the
1532 ``getfd`` command. This is only needed if the file descriptor was never
1533 used by another monitor command.
1534ERST
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001535
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001536 {
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001537 .name = "block_set_io_throttle",
1538 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1539 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1540 .help = "change I/O throttle limits for a block drive",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001541 .cmd = hmp_block_set_io_throttle,
Paolo Bonzinif55ba802020-11-03 04:37:20 -05001542 .flags = "p",
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001543 },
1544
Peter Maydella6b30bc2020-02-28 15:36:06 +00001545SRST
1546``block_set_io_throttle`` *device* *bps* *bps_rd* *bps_wr* *iops* *iops_rd* *iops_wr*
1547 Change I/O throttle limits for a block drive to
1548 *bps* *bps_rd* *bps_wr* *iops* *iops_rd* *iops_wr*.
1549 *device* can be a block device name, a qdev ID or a QOM path.
1550ERST
Jan Kiszkab40292e2010-05-31 14:43:31 -03001551
Jan Kiszka33572ec2010-05-31 14:43:30 -03001552 {
Gerd Hoffmann75721502010-10-07 12:22:54 +02001553 .name = "set_password",
Stefan Reiter675fd3c2022-02-25 09:49:49 +01001554 .args_type = "protocol:s,password:s,display:-ds,connected:s?",
1555 .params = "protocol password [-d display] [action-if-connected]",
Gerd Hoffmann75721502010-10-07 12:22:54 +02001556 .help = "set spice/vnc password",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001557 .cmd = hmp_set_password,
Gerd Hoffmann75721502010-10-07 12:22:54 +02001558 },
1559
Peter Maydella6b30bc2020-02-28 15:36:06 +00001560SRST
Stefan Reiter675fd3c2022-02-25 09:49:49 +01001561``set_password [ vnc | spice ] password [ -d display ] [ action-if-connected ]``
1562 Change spice/vnc password. *display* can be used with 'vnc' to specify
1563 which display to set the password on. *action-if-connected* specifies
1564 what should happen in case a connection is established: *fail* makes
1565 the password change fail. *disconnect* changes the password and
Markus Armbruster89825522021-09-09 10:12:19 +02001566 disconnects the client. *keep* changes the password and keeps the
1567 connection up. *keep* is the default.
Peter Maydella6b30bc2020-02-28 15:36:06 +00001568ERST
Gerd Hoffmann75721502010-10-07 12:22:54 +02001569
1570 {
1571 .name = "expire_password",
Stefan Reiter675fd3c2022-02-25 09:49:49 +01001572 .args_type = "protocol:s,time:s,display:-ds",
1573 .params = "protocol time [-d display]",
Gerd Hoffmann75721502010-10-07 12:22:54 +02001574 .help = "set spice/vnc password expire-time",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001575 .cmd = hmp_expire_password,
Gerd Hoffmann75721502010-10-07 12:22:54 +02001576 },
1577
Peter Maydella6b30bc2020-02-28 15:36:06 +00001578SRST
Stefan Reiter675fd3c2022-02-25 09:49:49 +01001579``expire_password [ vnc | spice ] expire-time [ -d display ]``
1580 Specify when a password for spice/vnc becomes invalid.
1581 *display* behaves the same as in ``set_password``.
1582 *expire-time* accepts:
Peter Maydella6b30bc2020-02-28 15:36:06 +00001583
1584 ``now``
1585 Invalidate password instantly.
1586 ``never``
1587 Password stays valid forever.
1588 ``+``\ *nsec*
1589 Password stays valid for *nsec* seconds starting now.
1590 *nsec*
1591 Password is invalidated at the given time. *nsec* are the seconds
1592 passed since 1970, i.e. unix epoch.
1593
1594ERST
Gerd Hoffmann75721502010-10-07 12:22:54 +02001595
Gerd Hoffmann46920822013-02-28 08:46:10 +01001596 {
1597 .name = "chardev-add",
1598 .args_type = "args:s",
1599 .params = "args",
1600 .help = "add chardev",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001601 .cmd = hmp_chardev_add,
Hani Benhabiles13e315d2014-05-07 23:41:29 +01001602 .command_completion = chardev_add_completion,
Gerd Hoffmann46920822013-02-28 08:46:10 +01001603 },
1604
Peter Maydella6b30bc2020-02-28 15:36:06 +00001605SRST
1606``chardev-add`` *args*
1607 chardev-add accepts the same parameters as the -chardev command line switch.
1608ERST
Anton Nefedov75b60162017-07-06 15:08:57 +03001609
1610 {
1611 .name = "chardev-change",
1612 .args_type = "id:s,args:s",
1613 .params = "id args",
1614 .help = "change chardev",
1615 .cmd = hmp_chardev_change,
1616 },
1617
Peter Maydella6b30bc2020-02-28 15:36:06 +00001618SRST
1619``chardev-change`` *args*
1620 chardev-change accepts existing chardev *id* and then the same arguments
1621 as the -chardev command line switch (except for "id").
1622ERST
Gerd Hoffmann46920822013-02-28 08:46:10 +01001623
1624 {
1625 .name = "chardev-remove",
1626 .args_type = "id:s",
1627 .params = "id",
1628 .help = "remove chardev",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001629 .cmd = hmp_chardev_remove,
Hani Benhabiles6297d9a2014-05-07 23:41:28 +01001630 .command_completion = chardev_remove_completion,
Gerd Hoffmann46920822013-02-28 08:46:10 +01001631 },
1632
Peter Maydella6b30bc2020-02-28 15:36:06 +00001633SRST
1634``chardev-remove`` *id*
1635 Removes the chardev *id*.
1636ERST
Gerd Hoffmannf1088902012-12-19 10:33:40 +01001637
1638 {
Stefan Fritschbd1d5ad2017-06-11 09:48:17 +02001639 .name = "chardev-send-break",
1640 .args_type = "id:s",
1641 .params = "id",
1642 .help = "send a break on chardev",
1643 .cmd = hmp_chardev_send_break,
1644 .command_completion = chardev_remove_completion,
1645 },
1646
Peter Maydella6b30bc2020-02-28 15:36:06 +00001647SRST
1648``chardev-send-break`` *id*
1649 Send a break on the chardev *id*.
1650ERST
Stefan Fritschbd1d5ad2017-06-11 09:48:17 +02001651
1652 {
Kevin Wolf587da2c2013-06-05 14:19:41 +02001653 .name = "qemu-io",
Kevin Wolf89b6fc42019-12-17 15:13:34 +01001654 .args_type = "qdev:-d,device:B,command:s",
1655 .params = "[-d] [device] \"[command]\"",
1656 .help = "run a qemu-io command on a block device\n\t\t\t"
1657 "-d: [device] is a device ID rather than a "
1658 "drive ID or node name",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001659 .cmd = hmp_qemu_io,
Kevin Wolf587da2c2013-06-05 14:19:41 +02001660 },
1661
Peter Maydella6b30bc2020-02-28 15:36:06 +00001662SRST
1663``qemu-io`` *device* *command*
1664 Executes a qemu-io command on the given block device.
1665ERST
Kevin Wolf587da2c2013-06-05 14:19:41 +02001666
1667 {
Andreas Färber89d7fa92014-05-07 18:08:29 +02001668 .name = "qom-list",
1669 .args_type = "path:s?",
1670 .params = "path",
1671 .help = "list QOM properties",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001672 .cmd = hmp_qom_list,
Dr. David Alan Gilbert8c7c7ec2018-06-20 16:39:45 +01001673 .flags = "p",
Andreas Färber89d7fa92014-05-07 18:08:29 +02001674 },
1675
Peter Maydella6b30bc2020-02-28 15:36:06 +00001676SRST
1677``qom-list`` [*path*]
1678 Print QOM properties of object at location *path*
1679ERST
Andreas Färber89d7fa92014-05-07 18:08:29 +02001680
1681 {
Dr. David Alan Gilbert89cf4fe2020-05-20 16:11:07 +01001682 .name = "qom-get",
1683 .args_type = "path:s,property:s",
1684 .params = "path property",
1685 .help = "print QOM property",
1686 .cmd = hmp_qom_get,
1687 .flags = "p",
1688 },
1689
1690SRST
1691``qom-get`` *path* *property*
1692 Print QOM property *property* of object at location *path*
1693ERST
1694
1695 {
Andreas Färberc0e6ee92014-05-07 19:48:15 +02001696 .name = "qom-set",
David Hildenbrand2d9e3dd2020-06-10 09:51:53 +02001697 .args_type = "json:-j,path:s,property:s,value:S",
1698 .params = "[-j] path property value",
1699 .help = "set QOM property.\n\t\t\t"
1700 "-j: the value is specified in json format.",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001701 .cmd = hmp_qom_set,
Dr. David Alan Gilbert8c7c7ec2018-06-20 16:39:45 +01001702 .flags = "p",
Andreas Färberc0e6ee92014-05-07 19:48:15 +02001703 },
1704
Peter Maydella6b30bc2020-02-28 15:36:06 +00001705SRST
1706``qom-set`` *path* *property* *value*
1707 Set QOM property *property* of object at location *path* to value *value*
1708ERST
Andreas Färberc0e6ee92014-05-07 19:48:15 +02001709
1710 {
Pavel Dovgalyuke7510672020-10-03 20:13:26 +03001711 .name = "replay_break",
Alex Bennéeae49ce02021-05-20 18:43:01 +01001712 .args_type = "icount:l",
Pavel Dovgalyuke7510672020-10-03 20:13:26 +03001713 .params = "icount",
1714 .help = "set breakpoint at the specified instruction count",
1715 .cmd = hmp_replay_break,
1716 },
1717
1718SRST
1719``replay_break`` *icount*
1720 Set replay breakpoint at instruction count *icount*.
1721 Execution stops when the specified instruction is reached.
1722 There can be at most one breakpoint. When breakpoint is set, any prior
1723 one is removed. The breakpoint may be set only in replay mode and only
1724 "in the future", i.e. at instruction counts greater than the current one.
1725 The current instruction count can be observed with ``info replay``.
1726ERST
1727
1728 {
1729 .name = "replay_delete_break",
1730 .args_type = "",
1731 .params = "",
1732 .help = "remove replay breakpoint",
1733 .cmd = hmp_replay_delete_break,
1734 },
1735
1736SRST
1737``replay_delete_break``
1738 Remove replay breakpoint which was previously set with ``replay_break``.
1739 The command is ignored when there are no replay breakpoints.
1740ERST
1741
1742 {
Pavel Dovgalyukf6baed32020-10-03 20:13:31 +03001743 .name = "replay_seek",
Alex Bennéeae49ce02021-05-20 18:43:01 +01001744 .args_type = "icount:l",
Pavel Dovgalyukf6baed32020-10-03 20:13:31 +03001745 .params = "icount",
1746 .help = "replay execution to the specified instruction count",
1747 .cmd = hmp_replay_seek,
1748 },
1749
1750SRST
1751``replay_seek`` *icount*
1752 Automatically proceed to the instruction count *icount*, when
1753 replaying the execution. The command automatically loads nearest
1754 snapshot and replays the execution to find the desired instruction.
1755 When there is no preceding snapshot or the execution is not replayed,
1756 then the command fails.
1757 *icount* for the reference may be observed with ``info replay`` command.
1758ERST
1759
1760 {
Peter Xua4a571d2021-06-07 09:11:57 +08001761 .name = "calc_dirty_rate",
Hyman Huang(黄勇)826b8bc2021-07-20 23:19:17 +08001762 .args_type = "dirty_ring:-r,dirty_bitmap:-b,second:l,sample_pages_per_GB:l?",
1763 .params = "[-r] [-b] second [sample_pages_per_GB]",
1764 .help = "start a round of guest dirty rate measurement (using -r to"
1765 "\n\t\t\t specify dirty ring as the method of calculation and"
1766 "\n\t\t\t -b to specify dirty bitmap as method of calculation)",
Peter Xua4a571d2021-06-07 09:11:57 +08001767 .cmd = hmp_calc_dirty_rate,
1768 },
Hyman Huang(黄勇)f3b2e382022-06-26 01:38:36 +08001769
1770SRST
Dr. David Alan Gilbert22269b02022-09-08 19:35:03 +01001771``calc_dirty_rate`` *second*
1772 Start a round of dirty rate measurement with the period specified in *second*.
1773 The result of the dirty rate measurement may be observed with ``info
1774 dirty_rate`` command.
Hyman Huang(黄勇)f3b2e382022-06-26 01:38:36 +08001775ERST
1776
1777 {
1778 .name = "set_vcpu_dirty_limit",
1779 .args_type = "dirty_rate:l,cpu_index:l?",
1780 .params = "dirty_rate [cpu_index]",
1781 .help = "set dirty page rate limit, use cpu_index to set limit"
1782 "\n\t\t\t\t\t on a specified virtual cpu",
1783 .cmd = hmp_set_vcpu_dirty_limit,
1784 },
1785
1786SRST
Dr. David Alan Gilbert22269b02022-09-08 19:35:03 +01001787``set_vcpu_dirty_limit``
1788 Set dirty page rate limit on virtual CPU, the information about all the
Hyman Huang(黄勇)f3b2e382022-06-26 01:38:36 +08001789 virtual CPU dirty limit status can be observed with ``info vcpu_dirty_limit``
1790 command.
1791ERST
1792
1793 {
1794 .name = "cancel_vcpu_dirty_limit",
1795 .args_type = "cpu_index:l?",
1796 .params = "[cpu_index]",
1797 .help = "cancel dirty page rate limit, use cpu_index to cancel"
1798 "\n\t\t\t\t\t limit on a specified virtual cpu",
1799 .cmd = hmp_cancel_vcpu_dirty_limit,
1800 },
Dr. David Alan Gilbert22269b02022-09-08 19:35:03 +01001801
1802SRST
1803``cancel_vcpu_dirty_limit``
1804 Cancel dirty page rate limit on virtual CPU, the information about all the
1805 virtual CPU dirty limit status can be observed with ``info vcpu_dirty_limit``
1806 command.
1807ERST
1808
1809 {
1810 .name = "info",
1811 .args_type = "item:s?",
1812 .params = "[subcommand]",
1813 .help = "show various information about the system state",
1814 .cmd = hmp_info_help,
1815 .sub_table = hmp_info_cmds,
1816 .flags = "p",
1817 },
Daniel Henrique Barbozabf353ad2022-09-26 14:38:40 -03001818
1819#if defined(CONFIG_FDT)
1820 {
1821 .name = "dumpdtb",
1822 .args_type = "filename:F",
1823 .params = "filename",
1824 .help = "dump the FDT in dtb format to 'filename'",
1825 .cmd = hmp_dumpdtb,
1826 },
1827
1828SRST
1829``dumpdtb`` *filename*
1830 Dump the FDT in dtb format to *filename*.
1831ERST
1832#endif
Joao Martins507cb642018-08-21 12:16:19 -04001833
1834#if defined(CONFIG_XEN_EMU)
1835 {
1836 .name = "xen-event-inject",
1837 .args_type = "port:i",
1838 .params = "port",
1839 .help = "inject event channel",
1840 .cmd = hmp_xen_event_inject,
1841 },
1842
1843SRST
1844``xen-event-inject`` *port*
1845 Notify guest via event channel on port *port*.
1846ERST
1847
1848
1849 {
1850 .name = "xen-event-list",
1851 .args_type = "",
1852 .params = "",
1853 .help = "list event channel state",
1854 .cmd = hmp_xen_event_list,
1855 },
1856
1857SRST
1858``xen-event-list``
1859 List event channels in the guest
1860ERST
1861#endif