blob: 2db5701d49c28186b1c20bfea3df9474ddc83674 [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 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300402 .name = "singlestep",
403 .args_type = "option:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300404 .params = "[on|off]",
Peter Maydelle9ccfdd2023-04-17 17:40:39 +0100405 .help = "deprecated synonym for one-insn-per-tb",
406 .cmd = hmp_one_insn_per_tb,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300407 },
408
Peter Maydella6b30bc2020-02-28 15:36:06 +0000409SRST
410``singlestep [off]``
Peter Maydelle9ccfdd2023-04-17 17:40:39 +0100411 This is a deprecated synonym for the one-insn-per-tb command.
Peter Maydella6b30bc2020-02-28 15:36:06 +0000412ERST
Blue Swirl23130862009-06-06 08:22:04 +0000413
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300414 {
BALATON Zoltande4cf842021-10-30 11:49:37 +0200415 .name = "stop|s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300416 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300417 .params = "",
418 .help = "stop emulation",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400419 .cmd = hmp_stop,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300420 },
421
Peter Maydella6b30bc2020-02-28 15:36:06 +0000422SRST
BALATON Zoltande4cf842021-10-30 11:49:37 +0200423``stop`` or ``s``
Peter Maydella6b30bc2020-02-28 15:36:06 +0000424 Stop emulation.
425ERST
Blue Swirl23130862009-06-06 08:22:04 +0000426
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300427 {
Peter Maydellff688cd2020-11-21 15:17:11 +0000428 .name = "cont|c",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300429 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300430 .params = "",
431 .help = "resume emulation",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400432 .cmd = hmp_cont,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300433 },
434
Peter Maydella6b30bc2020-02-28 15:36:06 +0000435SRST
Peter Maydellff688cd2020-11-21 15:17:11 +0000436``cont`` or ``c``
Peter Maydella6b30bc2020-02-28 15:36:06 +0000437 Resume emulation.
438ERST
Blue Swirl23130862009-06-06 08:22:04 +0000439
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300440 {
Gerd Hoffmann9b9df252012-02-23 13:45:21 +0100441 .name = "system_wakeup",
442 .args_type = "",
443 .params = "",
444 .help = "wakeup guest from suspend",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400445 .cmd = hmp_system_wakeup,
Gerd Hoffmann9b9df252012-02-23 13:45:21 +0100446 },
447
Peter Maydella6b30bc2020-02-28 15:36:06 +0000448SRST
449``system_wakeup``
450 Wakeup guest from suspend.
451ERST
Gerd Hoffmann9b9df252012-02-23 13:45:21 +0100452
453 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300454 .name = "gdbserver",
455 .args_type = "device:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300456 .params = "[device]",
457 .help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400458 .cmd = hmp_gdbserver,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300459 },
460
Peter Maydella6b30bc2020-02-28 15:36:06 +0000461SRST
462``gdbserver`` [*port*]
463 Start gdbserver session (default *port*\=1234)
464ERST
Blue Swirl23130862009-06-06 08:22:04 +0000465
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300466 {
467 .name = "x",
468 .args_type = "fmt:/,addr:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300469 .params = "/fmt addr",
470 .help = "virtual memory dump starting at 'addr'",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400471 .cmd = hmp_memory_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300472 },
473
Peter Maydella6b30bc2020-02-28 15:36:06 +0000474SRST
475``x/``\ *fmt* *addr*
476 Virtual memory dump starting at *addr*.
477ERST
Blue Swirl23130862009-06-06 08:22:04 +0000478
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300479 {
480 .name = "xp",
481 .args_type = "fmt:/,addr:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300482 .params = "/fmt addr",
483 .help = "physical memory dump starting at 'addr'",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400484 .cmd = hmp_physical_memory_dump,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300485 },
486
Peter Maydella6b30bc2020-02-28 15:36:06 +0000487SRST
488``xp /``\ *fmt* *addr*
489 Physical memory dump starting at *addr*.
490
491 *fmt* is a format which tells the command how to format the
492 data. Its syntax is: ``/{count}{format}{size}``
493
494 *count*
495 is the number of items to be dumped.
496 *format*
497 can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
498 c (char) or i (asm instruction).
499 *size*
500 can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
501 ``h`` or ``w`` can be specified with the ``i`` format to
502 respectively select 16 or 32 bit code instruction size.
503
504 Examples:
505
506 Dump 10 instructions at the current instruction pointer::
507
508 (qemu) x/10i $eip
509 0x90107063: ret
510 0x90107064: sti
511 0x90107065: lea 0x0(%esi,1),%esi
512 0x90107069: lea 0x0(%edi,1),%edi
513 0x90107070: ret
514 0x90107071: jmp 0x90107080
515 0x90107073: nop
516 0x90107074: nop
517 0x90107075: nop
518 0x90107076: nop
519
520 Dump 80 16 bit values at the start of the video memory::
521
522 (qemu) xp/80hx 0xb8000
523 0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
524 0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
525 0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
526 0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
527 0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
528 0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
529 0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
530 0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
531 0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
532 0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
533
534ERST
Blue Swirl23130862009-06-06 08:22:04 +0000535
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300536 {
Paolo Bonzinie9628442017-04-20 15:30:58 +0200537 .name = "gpa2hva",
538 .args_type = "addr:l",
539 .params = "addr",
540 .help = "print the host virtual address corresponding to a guest physical address",
541 .cmd = hmp_gpa2hva,
542 },
543
Peter Maydella6b30bc2020-02-28 15:36:06 +0000544SRST
545``gpa2hva`` *addr*
546 Print the host virtual address at which the guest's physical address *addr*
547 is mapped.
548ERST
Paolo Bonzinie9628442017-04-20 15:30:58 +0200549
550#ifdef CONFIG_LINUX
551 {
552 .name = "gpa2hpa",
553 .args_type = "addr:l",
554 .params = "addr",
555 .help = "print the host physical address corresponding to a guest physical address",
556 .cmd = hmp_gpa2hpa,
557 },
558#endif
559
Peter Maydella6b30bc2020-02-28 15:36:06 +0000560SRST
561``gpa2hpa`` *addr*
562 Print the host physical address at which the guest's physical address *addr*
563 is mapped.
564ERST
Paolo Bonzinie9628442017-04-20 15:30:58 +0200565
566 {
Dr. David Alan Gilbert574d9692019-04-12 16:26:52 +0100567 .name = "gva2gpa",
568 .args_type = "addr:l",
569 .params = "addr",
570 .help = "print the guest physical address corresponding to a guest virtual address",
571 .cmd = hmp_gva2gpa,
572 },
573
Peter Maydella6b30bc2020-02-28 15:36:06 +0000574SRST
575``gva2gpa`` *addr*
576 Print the guest physical address at which the guest's virtual address *addr*
577 is mapped based on the mapping for the current CPU.
578ERST
Dr. David Alan Gilbert574d9692019-04-12 16:26:52 +0100579
580 {
Peter Maydellff688cd2020-11-21 15:17:11 +0000581 .name = "print|p",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300582 .args_type = "fmt:/,val:l",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300583 .params = "/fmt expr",
584 .help = "print expression value (use $reg for CPU register access)",
Markus Armbrustercbf81992023-01-24 13:19:43 +0100585 .cmd = hmp_print,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300586 },
587
Peter Maydella6b30bc2020-02-28 15:36:06 +0000588SRST
Peter Maydellff688cd2020-11-21 15:17:11 +0000589``print`` or ``p/``\ *fmt* *expr*
Peter Maydella6b30bc2020-02-28 15:36:06 +0000590 Print expression value. Only the *format* part of *fmt* is
591 used.
592ERST
Blue Swirl23130862009-06-06 08:22:04 +0000593
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300594 {
595 .name = "i",
596 .args_type = "fmt:/,addr:i,index:i.",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300597 .params = "/fmt addr",
598 .help = "I/O port read",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400599 .cmd = hmp_ioport_read,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300600 },
601
Peter Maydella6b30bc2020-02-28 15:36:06 +0000602SRST
603``i/``\ *fmt* *addr* [.\ *index*\ ]
604 Read I/O port.
605ERST
Blue Swirl23130862009-06-06 08:22:04 +0000606
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300607 {
608 .name = "o",
609 .args_type = "fmt:/,addr:i,val:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300610 .params = "/fmt addr value",
611 .help = "I/O port write",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400612 .cmd = hmp_ioport_write,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300613 },
614
Peter Maydella6b30bc2020-02-28 15:36:06 +0000615SRST
616``o/``\ *fmt* *addr* *val*
617 Write to I/O port.
618ERST
Blue Swirl23130862009-06-06 08:22:04 +0000619
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300620 {
621 .name = "sendkey",
Amos Kong2ef20c12012-08-31 10:56:22 +0800622 .args_type = "keys:s,hold-time:i?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300623 .params = "keys [hold_ms]",
624 .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 +0400625 .cmd = hmp_sendkey,
Hani Benhabiles29136cd2014-05-07 23:41:27 +0100626 .command_completion = sendkey_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300627 },
628
Peter Maydella6b30bc2020-02-28 15:36:06 +0000629SRST
630``sendkey`` *keys*
631 Send *keys* to the guest. *keys* could be the name of the
632 key or the raw value in hexadecimal format. Use ``-`` to press
633 several keys simultaneously. Example::
634
635 sendkey ctrl-alt-f1
636
637 This command is useful to send keys that your graphical user interface
638 intercepts at low level, such as ``ctrl-alt-f1`` in X Window.
639ERST
Emilio G. Cotadd12e1b2018-08-15 16:00:03 -0400640 {
641 .name = "sync-profile",
642 .args_type = "op:s?",
643 .params = "[on|off|reset]",
644 .help = "enable, disable or reset synchronization profiling. "
645 "With no arguments, prints whether profiling is on or off.",
646 .cmd = hmp_sync_profile,
647 },
648
Peter Maydella6b30bc2020-02-28 15:36:06 +0000649SRST
650``sync-profile [on|off|reset]``
651 Enable, disable or reset synchronization profiling. With no arguments, prints
652 whether profiling is on or off.
653ERST
Blue Swirl23130862009-06-06 08:22:04 +0000654
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300655 {
656 .name = "system_reset",
657 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300658 .params = "",
659 .help = "reset the system",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400660 .cmd = hmp_system_reset,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300661 },
662
Peter Maydella6b30bc2020-02-28 15:36:06 +0000663SRST
664``system_reset``
665 Reset the system.
666ERST
Blue Swirl23130862009-06-06 08:22:04 +0000667
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300668 {
669 .name = "system_powerdown",
670 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300671 .params = "",
672 .help = "send system power down event",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400673 .cmd = hmp_system_powerdown,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300674 },
675
Peter Maydella6b30bc2020-02-28 15:36:06 +0000676SRST
677``system_powerdown``
678 Power down the system (if supported).
679ERST
Blue Swirl23130862009-06-06 08:22:04 +0000680
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300681 {
682 .name = "sum",
683 .args_type = "start:i,size:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300684 .params = "addr size",
685 .help = "compute the checksum of a memory region",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400686 .cmd = hmp_sum,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300687 },
688
Peter Maydella6b30bc2020-02-28 15:36:06 +0000689SRST
690``sum`` *addr* *size*
691 Compute the checksum of a memory region.
692ERST
Blue Swirl23130862009-06-06 08:22:04 +0000693
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300694 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300695 .name = "device_add",
Markus Armbrusterc7e4e8c2010-02-10 20:47:28 +0100696 .args_type = "device:O",
697 .params = "driver[,prop=value][,...]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300698 .help = "add device, like -device on the command line",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400699 .cmd = hmp_device_add,
Hani Benhabiles2da1b3a2014-04-13 16:25:07 +0100700 .command_completion = device_add_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300701 },
702
Peter Maydella6b30bc2020-02-28 15:36:06 +0000703SRST
704``device_add`` *config*
705 Add device.
706ERST
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200707
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300708 {
709 .name = "device_del",
710 .args_type = "id:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300711 .params = "device",
712 .help = "remove device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400713 .cmd = hmp_device_del,
Hani Benhabiles2da1b3a2014-04-13 16:25:07 +0100714 .command_completion = device_del_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300715 },
716
Peter Maydella6b30bc2020-02-28 15:36:06 +0000717SRST
718``device_del`` *id*
719 Remove device *id*. *id* may be a short ID
720 or a QOM object path.
721ERST
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200722
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300723 {
724 .name = "cpu",
725 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300726 .params = "index",
727 .help = "set the default CPU",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400728 .cmd = hmp_cpu,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300729 },
Gerd Hoffmann3418bd22009-09-25 21:42:41 +0200730
Peter Maydella6b30bc2020-02-28 15:36:06 +0000731SRST
732``cpu`` *index*
733 Set the default CPU.
734ERST
Blue Swirl23130862009-06-06 08:22:04 +0000735
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300736 {
737 .name = "mouse_move",
738 .args_type = "dx_str:s,dy_str:s,dz_str:s?",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300739 .params = "dx dy [dz]",
740 .help = "send mouse move events",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400741 .cmd = hmp_mouse_move,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300742 },
743
Peter Maydella6b30bc2020-02-28 15:36:06 +0000744SRST
745``mouse_move`` *dx* *dy* [*dz*]
746 Move the active mouse to the specified coordinates *dx* *dy*
747 with optional scroll axis *dz*.
748ERST
Blue Swirl23130862009-06-06 08:22:04 +0000749
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300750 {
751 .name = "mouse_button",
752 .args_type = "button_state:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300753 .params = "state",
754 .help = "change mouse button state (1=L, 2=M, 4=R)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400755 .cmd = hmp_mouse_button,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300756 },
757
Peter Maydella6b30bc2020-02-28 15:36:06 +0000758SRST
759``mouse_button`` *val*
760 Change the active mouse button state *val* (1=L, 2=M, 4=R).
761ERST
Blue Swirl23130862009-06-06 08:22:04 +0000762
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300763 {
764 .name = "mouse_set",
765 .args_type = "index:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300766 .params = "index",
767 .help = "set which mouse device receives events",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400768 .cmd = hmp_mouse_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300769 },
770
Peter Maydella6b30bc2020-02-28 15:36:06 +0000771SRST
772``mouse_set`` *index*
773 Set which mouse device receives events at given *index*, index
774 can be obtained with::
775
776 info mice
777
778ERST
Blue Swirl23130862009-06-06 08:22:04 +0000779
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300780 {
781 .name = "wavcapture",
Kővágó, Zoltánf0b9f362019-08-19 01:06:48 +0200782 .args_type = "path:F,audiodev:s,freq:i?,bits:i?,nchannels:i?",
783 .params = "path audiodev [frequency [bits [channels]]]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300784 .help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400785 .cmd = hmp_wavcapture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300786 },
Peter Maydella6b30bc2020-02-28 15:36:06 +0000787SRST
788``wavcapture`` *filename* *audiodev* [*frequency* [*bits* [*channels*]]]
789 Capture audio into *filename* from *audiodev*, using sample rate
790 *frequency* bits per sample *bits* and number of channels
791 *channels*.
792
793 Defaults:
794
795 - Sample rate = 44100 Hz - CD quality
796 - Bits = 16
797 - Number of channels = 2 - Stereo
798ERST
Blue Swirl23130862009-06-06 08:22:04 +0000799
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300800 {
801 .name = "stopcapture",
802 .args_type = "n:i",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300803 .params = "capture index",
804 .help = "stop capture",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400805 .cmd = hmp_stopcapture,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300806 },
Peter Maydella6b30bc2020-02-28 15:36:06 +0000807SRST
808``stopcapture`` *index*
809 Stop capture with a given *index*, index can be obtained with::
810
811 info capture
812
813ERST
Blue Swirl23130862009-06-06 08:22:04 +0000814
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300815 {
816 .name = "memsave",
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 virtual memory dump starting at 'addr' of size 'size'",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400820 .cmd = hmp_memsave,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300821 },
822
Peter Maydella6b30bc2020-02-28 15:36:06 +0000823SRST
824``memsave`` *addr* *size* *file*
825 save to disk virtual 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 = "pmemsave",
830 .args_type = "val:l,size:i,filename:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300831 .params = "addr size file",
832 .help = "save to disk physical memory dump starting at 'addr' of size 'size'",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400833 .cmd = hmp_pmemsave,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300834 },
835
Peter Maydella6b30bc2020-02-28 15:36:06 +0000836SRST
837``pmemsave`` *addr* *size* *file*
838 save to disk physical memory dump starting at *addr* of size *size*.
839ERST
Blue Swirl23130862009-06-06 08:22:04 +0000840
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300841 {
842 .name = "boot_set",
843 .args_type = "bootdevice:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300844 .params = "bootdevice",
845 .help = "define new values for the boot device list",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400846 .cmd = hmp_boot_set,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300847 },
848
Peter Maydella6b30bc2020-02-28 15:36:06 +0000849SRST
850``boot_set`` *bootdevicelist*
851 Define new values for the boot device list. Those values will override
852 the values specified on the command line through the ``-boot`` option.
853
854 The values that can be specified here depend on the machine type, but are
855 the same that can be specified in the ``-boot`` command line option.
856ERST
Blue Swirl23130862009-06-06 08:22:04 +0000857
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300858 {
859 .name = "nmi",
Luiz Capitulinoe9b4b432011-04-29 12:11:50 -0300860 .args_type = "",
861 .params = "",
Alexey Kardashevskiy9cb805f2014-08-20 22:16:33 +1000862 .help = "inject an NMI",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400863 .cmd = hmp_nmi,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300864 },
Peter Maydella6b30bc2020-02-28 15:36:06 +0000865SRST
866``nmi`` *cpu*
867 Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
868ERST
Lei Li1f590cf2013-01-25 00:03:20 +0800869
870 {
Markus Armbruster3949e592013-02-06 21:27:24 +0100871 .name = "ringbuf_write",
Lei Li1f590cf2013-01-25 00:03:20 +0800872 .args_type = "device:s,data:s",
873 .params = "device data",
Markus Armbruster3949e592013-02-06 21:27:24 +0100874 .help = "Write to a ring buffer character device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400875 .cmd = hmp_ringbuf_write,
Hani Benhabiles8e597772014-05-27 23:39:30 +0100876 .command_completion = ringbuf_write_completion,
Lei Li1f590cf2013-01-25 00:03:20 +0800877 },
878
Peter Maydella6b30bc2020-02-28 15:36:06 +0000879SRST
880``ringbuf_write`` *device* *data*
881 Write *data* to ring buffer character device *device*.
882 *data* must be a UTF-8 string.
883ERST
Blue Swirl23130862009-06-06 08:22:04 +0000884
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300885 {
Markus Armbruster3949e592013-02-06 21:27:24 +0100886 .name = "ringbuf_read",
Lei Li49b6d722013-01-25 00:03:21 +0800887 .args_type = "device:s,size:i",
888 .params = "device size",
Markus Armbruster3949e592013-02-06 21:27:24 +0100889 .help = "Read from a ring buffer character device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400890 .cmd = hmp_ringbuf_read,
Hani Benhabiles8e597772014-05-27 23:39:30 +0100891 .command_completion = ringbuf_write_completion,
Lei Li49b6d722013-01-25 00:03:21 +0800892 },
893
Peter Maydella6b30bc2020-02-28 15:36:06 +0000894SRST
895``ringbuf_read`` *device*
896 Read and print up to *size* bytes from ring buffer character
897 device *device*.
898 Certain non-printable characters are printed ``\uXXXX``, where ``XXXX`` is the
899 character code in hexadecimal. Character ``\`` is printed ``\\``.
900 Bug: can screw up when the buffer contains invalid UTF-8 sequences,
901 NUL characters, after the ring buffer lost data, and when reading
902 stops because the size limit is reached.
903ERST
Lei Li49b6d722013-01-25 00:03:21 +0800904
905 {
Dr. David Alan Gilbert544f6ea2019-02-27 13:24:12 +0000906 .name = "announce_self",
Dr. David Alan Gilbertc6644542019-06-20 19:47:05 +0100907 .args_type = "interfaces:s?,id:s?",
908 .params = "[interfaces] [id]",
Dr. David Alan Gilbert544f6ea2019-02-27 13:24:12 +0000909 .help = "Trigger GARP/RARP announcements",
910 .cmd = hmp_announce_self,
911 },
912
Peter Maydella6b30bc2020-02-28 15:36:06 +0000913SRST
914``announce_self``
915 Trigger a round of GARP/RARP broadcasts; this is useful for explicitly
916 updating the network infrastructure after a reconfiguration or some forms
917 of migration. The timings of the round are set by the migration announce
918 parameters. An optional comma separated *interfaces* list restricts the
919 announce to the named set of interfaces. An optional *id* can be used to
920 start a separate announce timer and to change the parameters of it later.
921ERST
Dr. David Alan Gilbert544f6ea2019-02-27 13:24:12 +0000922
923 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300924 .name = "migrate",
Peter Xu7a4da282018-05-02 18:47:23 +0800925 .args_type = "detach:-d,blk:-b,inc:-i,resume:-r,uri:s",
926 .params = "[-d] [-b] [-i] [-r] uri",
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200927 .help = "migrate to URI (using -d to not wait for completion)"
928 "\n\t\t\t -b for migration without shared storage with"
929 " full copy of disk\n\t\t\t -i for migration without "
930 "shared storage with incremental copy of disk "
Peter Xu7a4da282018-05-02 18:47:23 +0800931 "(base image shared between src and destination)"
932 "\n\t\t\t -r to resume a paused migration",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400933 .cmd = hmp_migrate,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300934 },
935
lirans@il.ibm.comfbc3d962009-11-02 15:41:13 +0200936
Peter Maydella6b30bc2020-02-28 15:36:06 +0000937SRST
938``migrate [-d] [-b] [-i]`` *uri*
939 Migrate to *uri* (using -d to not wait for completion).
940
941 ``-b``
942 for migration with full copy of disk
943 ``-i``
944 for migration with incremental copy of disk (base image is shared)
945ERST
Blue Swirl23130862009-06-06 08:22:04 +0000946
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300947 {
948 .name = "migrate_cancel",
949 .args_type = "",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300950 .params = "",
951 .help = "cancel the current VM migration",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400952 .cmd = hmp_migrate_cancel,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -0300953 },
954
Peter Maydella6b30bc2020-02-28 15:36:06 +0000955SRST
956``migrate_cancel``
957 Cancel the current VM migration.
958ERST
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300959
Dr. David Alan Gilbert94ae12c2017-10-20 10:05:54 +0100960 {
961 .name = "migrate_continue",
962 .args_type = "state:s",
963 .params = "state",
964 .help = "Continue migration from the given paused state",
965 .cmd = hmp_migrate_continue,
966 },
Peter Maydella6b30bc2020-02-28 15:36:06 +0000967SRST
968``migrate_continue`` *state*
969 Continue migration from the paused state *state*
970ERST
Orit Wasserman9e1ba4c2012-08-06 21:42:54 +0300971
972 {
Dr. David Alan Gilbertbf1ae1f2015-02-19 11:40:28 +0000973 .name = "migrate_incoming",
974 .args_type = "uri:s",
975 .params = "uri",
976 .help = "Continue an incoming migration from an -incoming defer",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +0400977 .cmd = hmp_migrate_incoming,
Dr. David Alan Gilbertbf1ae1f2015-02-19 11:40:28 +0000978 },
979
Peter Maydella6b30bc2020-02-28 15:36:06 +0000980SRST
981``migrate_incoming`` *uri*
982 Continue an incoming migration using the *uri* (that has the same syntax
983 as the ``-incoming`` option).
984ERST
Dr. David Alan Gilbertbf1ae1f2015-02-19 11:40:28 +0000985
Peter Xu3b563c42018-05-02 18:47:37 +0800986 {
987 .name = "migrate_recover",
988 .args_type = "uri:s",
989 .params = "uri",
990 .help = "Continue a paused incoming postcopy migration",
991 .cmd = hmp_migrate_recover,
992 },
993
Peter Maydella6b30bc2020-02-28 15:36:06 +0000994SRST
995``migrate_recover`` *uri*
996 Continue a paused incoming postcopy migration using the *uri*.
997ERST
Dr. David Alan Gilbertbf1ae1f2015-02-19 11:40:28 +0000998
999 {
Peter Xud37297d2018-05-02 18:47:40 +08001000 .name = "migrate_pause",
1001 .args_type = "",
1002 .params = "",
1003 .help = "Pause an ongoing migration (postcopy-only)",
1004 .cmd = hmp_migrate_pause,
1005 },
1006
Peter Maydella6b30bc2020-02-28 15:36:06 +00001007SRST
1008``migrate_pause``
1009 Pause an ongoing migration. Currently it only supports postcopy.
1010ERST
Peter Xud37297d2018-05-02 18:47:40 +08001011
1012 {
Orit Wasserman00458432012-08-06 21:42:48 +03001013 .name = "migrate_set_capability",
1014 .args_type = "capability:s,state:b",
1015 .params = "capability state",
1016 .help = "Enable/Disable the usage of a capability for migration",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001017 .cmd = hmp_migrate_set_capability,
Hani Benhabilesc68a0402014-05-27 23:39:32 +01001018 .command_completion = migrate_set_capability_completion,
Orit Wasserman00458432012-08-06 21:42:48 +03001019 },
1020
Peter Maydella6b30bc2020-02-28 15:36:06 +00001021SRST
1022``migrate_set_capability`` *capability* *state*
1023 Enable/Disable the usage of a capability *capability* for migration.
1024ERST
Orit Wasserman00458432012-08-06 21:42:48 +03001025
1026 {
Liang Li50e9a622015-03-23 16:32:29 +08001027 .name = "migrate_set_parameter",
Daniel P. Berrange69ef1f32016-04-27 11:05:15 +01001028 .args_type = "parameter:s,value:s",
Liang Li50e9a622015-03-23 16:32:29 +08001029 .params = "parameter value",
1030 .help = "Set the parameter for migration",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001031 .cmd = hmp_migrate_set_parameter,
Liang Li50e9a622015-03-23 16:32:29 +08001032 .command_completion = migrate_set_parameter_completion,
1033 },
1034
Peter Maydella6b30bc2020-02-28 15:36:06 +00001035SRST
1036``migrate_set_parameter`` *parameter* *value*
1037 Set the parameter *parameter* for migration.
1038ERST
Liang Li50e9a622015-03-23 16:32:29 +08001039
1040 {
Dr. David Alan Gilbert4886a1b2015-11-05 18:10:56 +00001041 .name = "migrate_start_postcopy",
1042 .args_type = "",
1043 .params = "",
Dr. David Alan Gilberta54d3402015-11-12 11:34:44 +00001044 .help = "Followup to a migration command to switch the migration"
Dr. David Alan Gilbert32c3db52016-03-11 09:53:36 +00001045 " to postcopy mode. The postcopy-ram capability must "
Greg Kurzc2eb7f22018-02-07 16:41:43 +01001046 "be set on both source and destination before the "
1047 "original migration command .",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001048 .cmd = hmp_migrate_start_postcopy,
Dr. David Alan Gilbert4886a1b2015-11-05 18:10:56 +00001049 },
1050
Peter Maydella6b30bc2020-02-28 15:36:06 +00001051SRST
1052``migrate_start_postcopy``
1053 Switch in-progress migration to postcopy mode. Ignored after the end of
1054 migration (or once already in postcopy).
1055ERST
Dr. David Alan Gilbert4886a1b2015-11-05 18:10:56 +00001056
Vladimir Sementsov-Ogievskiy51e47cf2023-04-28 22:49:21 +03001057#ifdef CONFIG_REPLICATION
Dr. David Alan Gilbert4886a1b2015-11-05 18:10:56 +00001058 {
zhanghailiangd89e6662016-10-27 14:43:03 +08001059 .name = "x_colo_lost_heartbeat",
1060 .args_type = "",
1061 .params = "",
1062 .help = "Tell COLO that heartbeat is lost,\n\t\t\t"
1063 "a failover or takeover is needed.",
1064 .cmd = hmp_x_colo_lost_heartbeat,
1065 },
Vladimir Sementsov-Ogievskiy51e47cf2023-04-28 22:49:21 +03001066#endif
zhanghailiangd89e6662016-10-27 14:43:03 +08001067
Peter Maydella6b30bc2020-02-28 15:36:06 +00001068SRST
1069``x_colo_lost_heartbeat``
1070 Tell COLO that heartbeat is lost, a failover or takeover is needed.
1071ERST
zhanghailiangd89e6662016-10-27 14:43:03 +08001072
1073 {
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001074 .name = "client_migrate_info",
1075 .args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
1076 .params = "protocol hostname port tls-port cert-subject",
Markus Armbruster13cadef2015-03-05 19:16:58 +01001077 .help = "set migration information for remote display",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001078 .cmd = hmp_client_migrate_info,
Jes Sorensenf8882562010-12-16 13:52:16 +01001079 },
1080
Peter Maydella6b30bc2020-02-28 15:36:06 +00001081SRST
1082``client_migrate_info`` *protocol* *hostname* *port* *tls-port* *cert-subject*
1083 Set migration information for remote display. This makes the server
1084 ask the client to automatically reconnect using the new parameters
1085 once migration finished successfully. Only implemented for SPICE.
1086ERST
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001087
Wen Congyang783e9b42012-05-07 12:10:47 +08001088 {
1089 .name = "dump-guest-memory",
Stephen Brennane6549192023-09-18 16:32:33 -07001090 .args_type = "paging:-p,detach:-d,windmp:-w,zlib:-z,lzo:-l,snappy:-s,raw:-R,filename:F,begin:l?,length:l?",
1091 .params = "[-p] [-d] [-z|-l|-s|-w] [-R] filename [begin length]",
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001092 .help = "dump guest memory into file 'filename'.\n\t\t\t"
1093 "-p: do paging to get guest's memory mapping.\n\t\t\t"
Peter Xu228de9c2016-02-18 13:16:47 +08001094 "-d: return immediately (do not wait for completion).\n\t\t\t"
Qiao Nuohan1b7a0f72014-04-17 16:15:07 +08001095 "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
1096 "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
1097 "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
Stephen Brennane6549192023-09-18 16:32:33 -07001098 "-R: when using kdump (-z, -l, -s), use raw rather than makedumpfile-flattened\n\t\t\t"
1099 " format\n\t\t\t"
Viktor Prutyanov2da91b52018-05-17 19:23:39 +03001100 "-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 +03001101 " for Windows x86 and x64 guests with vmcoreinfo driver only.\n\t\t\t"
Qiao Nuohanc20499d2014-04-17 16:15:06 +08001102 "begin: the starting physical address.\n\t\t\t"
1103 "length: the memory size, in bytes.",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001104 .cmd = hmp_dump_guest_memory,
Wen Congyang783e9b42012-05-07 12:10:47 +08001105 },
1106
Peter Maydella6b30bc2020-02-28 15:36:06 +00001107SRST
1108``dump-guest-memory [-p]`` *filename* *begin* *length*
1109 \
1110``dump-guest-memory [-z|-l|-s|-w]`` *filename*
1111 Dump guest memory to *protocol*. The file can be processed with crash or
1112 gdb. Without ``-z|-l|-s|-w``, the dump format is ELF.
1113
1114 ``-p``
1115 do paging to get guest's memory mapping.
1116 ``-z``
1117 dump in kdump-compressed format, with zlib compression.
1118 ``-l``
1119 dump in kdump-compressed format, with lzo compression.
1120 ``-s``
1121 dump in kdump-compressed format, with snappy compression.
Stephen Brennane6549192023-09-18 16:32:33 -07001122 ``-R``
1123 when using kdump (-z, -l, -s), use raw rather than makedumpfile-flattened
1124 format
Peter Maydella6b30bc2020-02-28 15:36:06 +00001125 ``-w``
1126 dump in Windows crashdump format (can be used instead of ELF-dump converting),
1127 for Windows x64 guests with vmcoreinfo driver only
1128 *filename*
1129 dump file name.
1130 *begin*
1131 the starting physical address. It's optional, and should be
1132 specified together with *length*.
1133 *length*
1134 the memory size, in bytes. It's optional, and should be specified
1135 together with *begin*.
1136
1137ERST
Wen Congyang783e9b42012-05-07 12:10:47 +08001138
Jason J. Hernea4538a52015-06-26 14:07:21 -04001139#if defined(TARGET_S390X)
1140 {
1141 .name = "dump-skeys",
1142 .args_type = "filename:F",
1143 .params = "",
1144 .help = "Save guest storage keys into file 'filename'.\n",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001145 .cmd = hmp_dump_skeys,
Jason J. Hernea4538a52015-06-26 14:07:21 -04001146 },
1147#endif
1148
Peter Maydella6b30bc2020-02-28 15:36:06 +00001149SRST
1150``dump-skeys`` *filename*
1151 Save guest storage keys to a file.
1152ERST
Jason J. Hernea4538a52015-06-26 14:07:21 -04001153
Claudio Imbrendaf860d492016-08-15 18:44:04 +02001154#if defined(TARGET_S390X)
1155 {
1156 .name = "migration_mode",
1157 .args_type = "mode:i",
1158 .params = "mode",
1159 .help = "Enables or disables migration mode\n",
1160 .cmd = hmp_migrationmode,
1161 },
1162#endif
1163
Peter Maydella6b30bc2020-02-28 15:36:06 +00001164SRST
1165``migration_mode`` *mode*
1166 Enables or disables migration mode.
1167ERST
Claudio Imbrendaf860d492016-08-15 18:44:04 +02001168
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001169 {
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001170 .name = "snapshot_blkdev",
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001171 .args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
1172 .params = "[-n] device [new-image-file] [format]",
Jes Sorensen2ea720d2011-03-09 16:54:34 +01001173 .help = "initiates a live snapshot\n\t\t\t"
1174 "of device. If a new image file is specified, the\n\t\t\t"
1175 "new image file will become the new root image.\n\t\t\t"
1176 "If format is specified, the snapshot file will\n\t\t\t"
Wenchao Xia775ca882013-09-11 14:04:37 +08001177 "be created in that format.\n\t\t\t"
Paolo Bonzini6cc2a412012-03-06 18:55:59 +01001178 "The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
1179 "to reuse the image found in new-image-file, instead of\n\t\t\t"
1180 "recreating it from scratch.",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001181 .cmd = hmp_snapshot_blkdev,
Gerd Hoffmanne866e232010-04-23 13:28:21 +02001182 },
1183
Peter Maydella6b30bc2020-02-28 15:36:06 +00001184SRST
1185``snapshot_blkdev``
1186 Snapshot device, using snapshot file as target if provided
1187ERST
Jes Sorensenf8882562010-12-16 13:52:16 +01001188
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001189 {
Wenchao Xia775ca882013-09-11 14:04:37 +08001190 .name = "snapshot_blkdev_internal",
1191 .args_type = "device:B,name:s",
1192 .params = "device name",
1193 .help = "take an internal snapshot of device.\n\t\t\t"
1194 "The format of the image used by device must\n\t\t\t"
1195 "support it, such as qcow2.\n\t\t\t",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001196 .cmd = hmp_snapshot_blkdev_internal,
Wenchao Xia775ca882013-09-11 14:04:37 +08001197 },
1198
Peter Maydella6b30bc2020-02-28 15:36:06 +00001199SRST
1200``snapshot_blkdev_internal``
1201 Take an internal snapshot on device if it support
1202ERST
Wenchao Xia775ca882013-09-11 14:04:37 +08001203
1204 {
Wenchao Xia7a4ed2e2013-09-11 14:04:38 +08001205 .name = "snapshot_delete_blkdev_internal",
1206 .args_type = "device:B,name:s,id:s?",
1207 .params = "device name [id]",
1208 .help = "delete an internal snapshot of device.\n\t\t\t"
1209 "If id is specified, qemu will try delete\n\t\t\t"
1210 "the snapshot matching both id and name.\n\t\t\t"
1211 "The format of the image used by device must\n\t\t\t"
1212 "support it, such as qcow2.\n\t\t\t",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001213 .cmd = hmp_snapshot_delete_blkdev_internal,
Wenchao Xia7a4ed2e2013-09-11 14:04:38 +08001214 },
1215
Peter Maydella6b30bc2020-02-28 15:36:06 +00001216SRST
1217``snapshot_delete_blkdev_internal``
1218 Delete an internal snapshot on device if it support
1219ERST
Wenchao Xia7a4ed2e2013-09-11 14:04:38 +08001220
1221 {
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02001222 .name = "drive_mirror",
1223 .args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
1224 .params = "[-n] [-f] device target [format]",
1225 .help = "initiates live storage\n\t\t\t"
1226 "migration for a device. The device's contents are\n\t\t\t"
1227 "copied to the new image file, including data that\n\t\t\t"
1228 "is written after the command is started.\n\t\t\t"
1229 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1230 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1231 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
1232 "so that the result does not need a backing file.\n\t\t\t",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001233 .cmd = hmp_drive_mirror,
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02001234 },
Peter Maydella6b30bc2020-02-28 15:36:06 +00001235SRST
1236``drive_mirror``
1237 Start mirroring a block device's writes to a new destination,
1238 using the specified target.
1239ERST
Paolo Bonzinid9b902d2012-10-18 16:49:24 +02001240
1241 {
Stefan Hajnoczide909302013-06-26 14:11:58 +02001242 .name = "drive_backup",
Pavel Butsykin13b94142016-07-22 11:17:52 +03001243 .args_type = "reuse:-n,full:-f,compress:-c,device:B,target:s,format:s?",
1244 .params = "[-n] [-f] [-c] device target [format]",
Stefan Hajnoczide909302013-06-26 14:11:58 +02001245 .help = "initiates a point-in-time\n\t\t\t"
1246 "copy for a device. The device's contents are\n\t\t\t"
1247 "copied to the new image file, excluding data that\n\t\t\t"
1248 "is written after the command is started.\n\t\t\t"
1249 "The -n flag requests QEMU to reuse the image found\n\t\t\t"
1250 "in new-image-file, instead of recreating it from scratch.\n\t\t\t"
1251 "The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
Pavel Butsykin13b94142016-07-22 11:17:52 +03001252 "so that the result does not need a backing file.\n\t\t\t"
1253 "The -c flag requests QEMU to compress backup data\n\t\t\t"
1254 "(if the target format supports it).\n\t\t\t",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001255 .cmd = hmp_drive_backup,
Stefan Hajnoczide909302013-06-26 14:11:58 +02001256 },
Peter Maydella6b30bc2020-02-28 15:36:06 +00001257SRST
1258``drive_backup``
zhaolichange3a6e0d2020-09-17 15:50:20 +08001259 Start a point-in-time copy of a block device to a specified target.
Peter Maydella6b30bc2020-02-28 15:36:06 +00001260ERST
Stefan Hajnoczide909302013-06-26 14:11:58 +02001261
1262 {
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001263 .name = "drive_add",
Kevin Wolfabb21ac2016-02-23 17:33:24 +01001264 .args_type = "node:-n,pci_addr:s,opts:s",
1265 .params = "[-n] [[<domain>:]<bus>:]<slot>\n"
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001266 "[file=file][,if=type][,bus=n]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +00001267 "[,unit=m][,media=d][,index=i]\n"
Stefan Hajnoczifb0490f2011-11-17 13:40:32 +00001268 "[,snapshot=on|off][,cache=on|off]\n"
1269 "[,readonly=on|off][,copy-on-read=on|off]",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001270 .help = "add drive to PCI storage controller",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001271 .cmd = hmp_drive_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001272 },
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001273
Peter Maydella6b30bc2020-02-28 15:36:06 +00001274SRST
1275``drive_add``
1276 Add drive to PCI storage controller.
1277ERST
Blue Swirl23130862009-06-06 08:22:04 +00001278
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001279 {
Isaku Yamahata2ae63bd2010-12-24 12:14:14 +09001280 .name = "pcie_aer_inject_error",
1281 .args_type = "advisory_non_fatal:-a,correctable:-c,"
1282 "id:s,error_status:s,"
1283 "header0:i?,header1:i?,header2:i?,header3:i?,"
1284 "prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
1285 .params = "[-a] [-c] id "
1286 "<error_status> [<tlp header> [<tlp header prefix>]]",
1287 .help = "inject pcie aer error\n\t\t\t"
1288 " -a for advisory non fatal error\n\t\t\t"
1289 " -c for correctable error\n\t\t\t"
1290 "<id> = qdev device id\n\t\t\t"
1291 "<error_status> = error string or 32bit\n\t\t\t"
Zenghui Yu8ad4e452020-12-04 11:09:53 +08001292 "<tlp header> = 32bit x 4\n\t\t\t"
1293 "<tlp header prefix> = 32bit x 4",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001294 .cmd = hmp_pcie_aer_inject_error,
Isaku Yamahata2ae63bd2010-12-24 12:14:14 +09001295 },
1296
Peter Maydella6b30bc2020-02-28 15:36:06 +00001297SRST
1298``pcie_aer_inject_error``
1299 Inject PCIe AER error
1300ERST
Isaku Yamahata2ae63bd2010-12-24 12:14:14 +09001301
1302 {
Markus Armbrusterae82d322010-03-25 17:22:40 +01001303 .name = "netdev_add",
1304 .args_type = "netdev:O",
Laurent Vivier5166fe02022-10-21 11:09:11 +02001305 .params = "[user|tap|socket|stream|dgram|vde|bridge|hubport|netmap|vhost-user"
Ilya Maximetscb039ef2023-09-13 20:34:37 +02001306#ifdef CONFIG_AF_XDP
1307 "|af-xdp"
1308#endif
Vladislav Yaroshchukfd8c8c02022-03-17 20:28:39 +03001309#ifdef CONFIG_VMNET
1310 "|vmnet-host|vmnet-shared|vmnet-bridged"
1311#endif
1312 "],id=str[,prop=value][,...]",
Markus Armbrusterae82d322010-03-25 17:22:40 +01001313 .help = "add host network device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001314 .cmd = hmp_netdev_add,
Hani Benhabilesb162b492014-05-07 23:41:31 +01001315 .command_completion = netdev_add_completion,
Paolo Bonzini48f596c2021-05-11 11:39:55 -04001316 .flags = "p",
Markus Armbrusterae82d322010-03-25 17:22:40 +01001317 },
1318
Peter Maydella6b30bc2020-02-28 15:36:06 +00001319SRST
1320``netdev_add``
1321 Add host network device.
1322ERST
Markus Armbrusterae82d322010-03-25 17:22:40 +01001323
1324 {
1325 .name = "netdev_del",
1326 .args_type = "id:s",
1327 .params = "id",
1328 .help = "remove host network device",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001329 .cmd = hmp_netdev_del,
Hani Benhabiles11b389f2014-05-07 23:41:32 +01001330 .command_completion = netdev_del_completion,
Paolo Bonzini48f596c2021-05-11 11:39:55 -04001331 .flags = "p",
Markus Armbrusterae82d322010-03-25 17:22:40 +01001332 },
1333
Peter Maydella6b30bc2020-02-28 15:36:06 +00001334SRST
1335``netdev_del``
1336 Remove host network device.
1337ERST
Markus Armbrusterae82d322010-03-25 17:22:40 +01001338
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001339 {
Paolo Bonzinicff8b2c2013-12-20 23:21:10 +01001340 .name = "object_add",
Kevin Wolfda0a9322021-02-17 15:27:54 +01001341 .args_type = "object:S",
Paolo Bonzinicff8b2c2013-12-20 23:21:10 +01001342 .params = "[qom-type=]type,id=str[,prop=value][,...]",
1343 .help = "create QOM object",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001344 .cmd = hmp_object_add,
Hani Benhabilesbfa40f72014-04-13 16:25:06 +01001345 .command_completion = object_add_completion,
Paolo Bonzini9e330132020-11-03 04:39:02 -05001346 .flags = "p",
Paolo Bonzinicff8b2c2013-12-20 23:21:10 +01001347 },
1348
Peter Maydella6b30bc2020-02-28 15:36:06 +00001349SRST
1350``object_add``
1351 Create QOM object.
1352ERST
Paolo Bonzinicff8b2c2013-12-20 23:21:10 +01001353
1354 {
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001355 .name = "object_del",
1356 .args_type = "id:s",
1357 .params = "id",
1358 .help = "destroy QOM object",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001359 .cmd = hmp_object_del,
Hani Benhabilesbfa40f72014-04-13 16:25:06 +01001360 .command_completion = object_del_completion,
Paolo Bonzini9e330132020-11-03 04:39:02 -05001361 .flags = "p",
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001362 },
1363
Peter Maydella6b30bc2020-02-28 15:36:06 +00001364SRST
1365``object_del``
1366 Destroy QOM object.
1367ERST
Paolo Bonziniab2d0532013-12-20 23:21:09 +01001368
Blue Swirl23130862009-06-06 08:22:04 +00001369#ifdef CONFIG_SLIRP
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001370 {
1371 .name = "hostfwd_add",
Thomas Huthb4983c52019-12-05 11:41:09 +01001372 .args_type = "arg1:s,arg2:s?",
1373 .params = "[netdev_id] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001374 .help = "redirect TCP or UDP connections from host to guest (requires -net user)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001375 .cmd = hmp_hostfwd_add,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001376 },
Markus Armbruster21413d62010-05-04 13:20:30 +02001377#endif
Peter Maydella6b30bc2020-02-28 15:36:06 +00001378SRST
1379``hostfwd_add``
1380 Redirect TCP or UDP connections from host to guest (requires -net user).
1381ERST
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001382
Markus Armbruster21413d62010-05-04 13:20:30 +02001383#ifdef CONFIG_SLIRP
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001384 {
1385 .name = "hostfwd_remove",
Thomas Huthb4983c52019-12-05 11:41:09 +01001386 .args_type = "arg1:s,arg2:s?",
1387 .params = "[netdev_id] [tcp|udp]:[hostaddr]:hostport",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001388 .help = "remove host-to-guest TCP or UDP redirection",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001389 .cmd = hmp_hostfwd_remove,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001390 },
1391
Blue Swirl23130862009-06-06 08:22:04 +00001392#endif
Peter Maydella6b30bc2020-02-28 15:36:06 +00001393SRST
1394``hostfwd_remove``
1395 Remove host-to-guest TCP or UDP redirection.
1396ERST
Blue Swirl23130862009-06-06 08:22:04 +00001397
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001398 {
1399 .name = "balloon",
Luiz Capitulino3b0bd6e2009-12-18 13:25:05 -02001400 .args_type = "value:M",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001401 .params = "target",
Riccardo Magliocchetti3c056132010-05-19 18:49:28 +02001402 .help = "request VM to change its memory allocation (in MB)",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001403 .cmd = hmp_balloon,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001404 },
1405
Peter Maydella6b30bc2020-02-28 15:36:06 +00001406SRST
1407``balloon`` *value*
1408 Request VM to change its memory allocation to *value* (in MB).
1409ERST
Blue Swirl23130862009-06-06 08:22:04 +00001410
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001411 {
1412 .name = "set_link",
Markus Armbrusterc9b26a42010-03-26 09:07:10 +01001413 .args_type = "name:s,up:b",
1414 .params = "name on|off",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001415 .help = "change the link status of a network adapter",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001416 .cmd = hmp_set_link,
Hani Benhabiles40d19392014-05-07 23:41:30 +01001417 .command_completion = set_link_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001418 },
1419
Peter Maydella6b30bc2020-02-28 15:36:06 +00001420SRST
1421``set_link`` *name* ``[on|off]``
1422 Switch link *name* on (i.e. up) or off (i.e. down).
1423ERST
Blue Swirl23130862009-06-06 08:22:04 +00001424
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001425 {
1426 .name = "watchdog_action",
1427 .args_type = "action:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001428 .params = "[reset|shutdown|poweroff|pause|debug|none]",
1429 .help = "change watchdog action",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001430 .cmd = hmp_watchdog_action,
Hani Benhabilesd0ece342014-05-27 23:39:31 +01001431 .command_completion = watchdog_action_completion,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001432 },
1433
Peter Maydella6b30bc2020-02-28 15:36:06 +00001434SRST
1435``watchdog_action``
1436 Change watchdog action.
1437ERST
Blue Swirl23130862009-06-06 08:22:04 +00001438
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001439 {
Paolo Bonzini40577252012-08-23 11:53:04 +02001440 .name = "nbd_server_start",
1441 .args_type = "all:-a,writable:-w,uri:s",
1442 .params = "nbd_server_start [-a] [-w] host:port",
1443 .help = "serve block devices on the given host and port",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001444 .cmd = hmp_nbd_server_start,
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_start`` *host*:*port*
1449 Start an NBD server on the given host and/or port. If the ``-a``
1450 option is included, all of the virtual machine's block devices that
1451 have an inserted media on them are automatically exported; in this case,
1452 the ``-w`` option makes the devices writable too.
1453ERST
Paolo Bonzini40577252012-08-23 11:53:04 +02001454
1455 {
1456 .name = "nbd_server_add",
Eric Blakedba49322018-01-09 13:28:02 -06001457 .args_type = "writable:-w,device:B,name:s?",
1458 .params = "nbd_server_add [-w] device [name]",
Paolo Bonzini40577252012-08-23 11:53:04 +02001459 .help = "export a block device via NBD",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001460 .cmd = hmp_nbd_server_add,
Paolo Bonzinif55ba802020-11-03 04:37:20 -05001461 .flags = "p",
Paolo Bonzini40577252012-08-23 11:53:04 +02001462 },
Peter Maydella6b30bc2020-02-28 15:36:06 +00001463SRST
1464``nbd_server_add`` *device* [ *name* ]
1465 Export a block device through QEMU's NBD server, which must be started
1466 beforehand with ``nbd_server_start``. The ``-w`` option makes the
1467 exported device writable too. The export name is controlled by *name*,
1468 defaulting to *device*.
1469ERST
Paolo Bonzini40577252012-08-23 11:53:04 +02001470
1471 {
Eric Blake08fb10a2018-01-25 08:45:57 -06001472 .name = "nbd_server_remove",
1473 .args_type = "force:-f,name:s",
1474 .params = "nbd_server_remove [-f] name",
1475 .help = "remove an export previously exposed via NBD",
1476 .cmd = hmp_nbd_server_remove,
Paolo Bonzinif55ba802020-11-03 04:37:20 -05001477 .flags = "p",
Eric Blake08fb10a2018-01-25 08:45:57 -06001478 },
Peter Maydella6b30bc2020-02-28 15:36:06 +00001479SRST
1480``nbd_server_remove [-f]`` *name*
1481 Stop exporting a block device through QEMU's NBD server, which was
1482 previously started with ``nbd_server_add``. The ``-f``
1483 option forces the server to drop the export immediately even if
1484 clients are connected; otherwise the command fails unless there are no
1485 clients.
1486ERST
Eric Blake08fb10a2018-01-25 08:45:57 -06001487
1488 {
Paolo Bonzini40577252012-08-23 11:53:04 +02001489 .name = "nbd_server_stop",
1490 .args_type = "",
1491 .params = "nbd_server_stop",
1492 .help = "stop serving block devices using the NBD protocol",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001493 .cmd = hmp_nbd_server_stop,
Paolo Bonzinif55ba802020-11-03 04:37:20 -05001494 .flags = "p",
Paolo Bonzini40577252012-08-23 11:53:04 +02001495 },
Peter Maydella6b30bc2020-02-28 15:36:06 +00001496SRST
1497``nbd_server_stop``
1498 Stop the QEMU embedded NBD server.
1499ERST
Paolo Bonzini40577252012-08-23 11:53:04 +02001500
1501
Huang Ying79c4f6b2009-06-23 10:05:14 +08001502#if defined(TARGET_I386)
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001503
1504 {
1505 .name = "mce",
Jin Dongming31ce5e02010-12-10 17:21:02 +09001506 .args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
1507 .params = "[-b] cpu bank status mcgstatus addr misc",
1508 .help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001509 .cmd = hmp_mce,
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001510 },
1511
Huang Ying79c4f6b2009-06-23 10:05:14 +08001512#endif
Peter Maydella6b30bc2020-02-28 15:36:06 +00001513SRST
1514``mce`` *cpu* *bank* *status* *mcgstatus* *addr* *misc*
1515 Inject an MCE on the given CPU (x86 only).
1516ERST
Huang Ying79c4f6b2009-06-23 10:05:14 +08001517
Marc-André Lureau4bf21c72023-03-02 19:05:41 +04001518#ifdef CONFIG_POSIX
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001519 {
1520 .name = "getfd",
1521 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001522 .params = "getfd name",
1523 .help = "receive a file descriptor via SCM rights and assign it a name",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001524 .cmd = hmp_getfd,
Paolo Bonzinif55ba802020-11-03 04:37:20 -05001525 .flags = "p",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001526 },
1527
Peter Maydella6b30bc2020-02-28 15:36:06 +00001528SRST
1529``getfd`` *fdname*
1530 If a file descriptor is passed alongside this command using the SCM_RIGHTS
1531 mechanism on unix sockets, it is stored using the name *fdname* for
1532 later use by other monitor commands.
1533ERST
Marc-André Lureau4bf21c72023-03-02 19:05:41 +04001534#endif
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001535
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001536 {
1537 .name = "closefd",
1538 .args_type = "fdname:s",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001539 .params = "closefd name",
1540 .help = "close a file descriptor previously passed via SCM rights",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001541 .cmd = hmp_closefd,
Paolo Bonzinif55ba802020-11-03 04:37:20 -05001542 .flags = "p",
Luiz Capitulinod7f9b682009-10-07 13:41:50 -03001543 },
1544
Peter Maydella6b30bc2020-02-28 15:36:06 +00001545SRST
1546``closefd`` *fdname*
1547 Close the file descriptor previously assigned to *fdname* using the
1548 ``getfd`` command. This is only needed if the file descriptor was never
1549 used by another monitor command.
1550ERST
Mark McLoughlinf07918f2009-07-22 09:11:40 +01001551
Luiz Capitulinoa3a55a22009-12-04 15:24:09 -02001552 {
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001553 .name = "block_set_io_throttle",
1554 .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
1555 .params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
1556 .help = "change I/O throttle limits for a block drive",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001557 .cmd = hmp_block_set_io_throttle,
Paolo Bonzinif55ba802020-11-03 04:37:20 -05001558 .flags = "p",
Zhi Yong Wu727f0052011-11-08 13:00:31 +08001559 },
1560
Peter Maydella6b30bc2020-02-28 15:36:06 +00001561SRST
1562``block_set_io_throttle`` *device* *bps* *bps_rd* *bps_wr* *iops* *iops_rd* *iops_wr*
1563 Change I/O throttle limits for a block drive to
1564 *bps* *bps_rd* *bps_wr* *iops* *iops_rd* *iops_wr*.
1565 *device* can be a block device name, a qdev ID or a QOM path.
1566ERST
Jan Kiszkab40292e2010-05-31 14:43:31 -03001567
Jan Kiszka33572ec2010-05-31 14:43:30 -03001568 {
Gerd Hoffmann75721502010-10-07 12:22:54 +02001569 .name = "set_password",
Stefan Reiter675fd3c2022-02-25 09:49:49 +01001570 .args_type = "protocol:s,password:s,display:-ds,connected:s?",
1571 .params = "protocol password [-d display] [action-if-connected]",
Gerd Hoffmann75721502010-10-07 12:22:54 +02001572 .help = "set spice/vnc password",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001573 .cmd = hmp_set_password,
Gerd Hoffmann75721502010-10-07 12:22:54 +02001574 },
1575
Peter Maydella6b30bc2020-02-28 15:36:06 +00001576SRST
Stefan Reiter675fd3c2022-02-25 09:49:49 +01001577``set_password [ vnc | spice ] password [ -d display ] [ action-if-connected ]``
1578 Change spice/vnc password. *display* can be used with 'vnc' to specify
1579 which display to set the password on. *action-if-connected* specifies
1580 what should happen in case a connection is established: *fail* makes
1581 the password change fail. *disconnect* changes the password and
Markus Armbruster89825522021-09-09 10:12:19 +02001582 disconnects the client. *keep* changes the password and keeps the
1583 connection up. *keep* is the default.
Peter Maydella6b30bc2020-02-28 15:36:06 +00001584ERST
Gerd Hoffmann75721502010-10-07 12:22:54 +02001585
1586 {
1587 .name = "expire_password",
Stefan Reiter675fd3c2022-02-25 09:49:49 +01001588 .args_type = "protocol:s,time:s,display:-ds",
1589 .params = "protocol time [-d display]",
Gerd Hoffmann75721502010-10-07 12:22:54 +02001590 .help = "set spice/vnc password expire-time",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001591 .cmd = hmp_expire_password,
Gerd Hoffmann75721502010-10-07 12:22:54 +02001592 },
1593
Peter Maydella6b30bc2020-02-28 15:36:06 +00001594SRST
Stefan Reiter675fd3c2022-02-25 09:49:49 +01001595``expire_password [ vnc | spice ] expire-time [ -d display ]``
1596 Specify when a password for spice/vnc becomes invalid.
1597 *display* behaves the same as in ``set_password``.
1598 *expire-time* accepts:
Peter Maydella6b30bc2020-02-28 15:36:06 +00001599
1600 ``now``
1601 Invalidate password instantly.
1602 ``never``
1603 Password stays valid forever.
1604 ``+``\ *nsec*
1605 Password stays valid for *nsec* seconds starting now.
1606 *nsec*
1607 Password is invalidated at the given time. *nsec* are the seconds
1608 passed since 1970, i.e. unix epoch.
1609
1610ERST
Gerd Hoffmann75721502010-10-07 12:22:54 +02001611
Gerd Hoffmann46920822013-02-28 08:46:10 +01001612 {
1613 .name = "chardev-add",
1614 .args_type = "args:s",
1615 .params = "args",
1616 .help = "add chardev",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001617 .cmd = hmp_chardev_add,
Hani Benhabiles13e315d2014-05-07 23:41:29 +01001618 .command_completion = chardev_add_completion,
Gerd Hoffmann46920822013-02-28 08:46:10 +01001619 },
1620
Peter Maydella6b30bc2020-02-28 15:36:06 +00001621SRST
1622``chardev-add`` *args*
1623 chardev-add accepts the same parameters as the -chardev command line switch.
1624ERST
Anton Nefedov75b60162017-07-06 15:08:57 +03001625
1626 {
1627 .name = "chardev-change",
1628 .args_type = "id:s,args:s",
1629 .params = "id args",
1630 .help = "change chardev",
1631 .cmd = hmp_chardev_change,
1632 },
1633
Peter Maydella6b30bc2020-02-28 15:36:06 +00001634SRST
1635``chardev-change`` *args*
1636 chardev-change accepts existing chardev *id* and then the same arguments
1637 as the -chardev command line switch (except for "id").
1638ERST
Gerd Hoffmann46920822013-02-28 08:46:10 +01001639
1640 {
1641 .name = "chardev-remove",
1642 .args_type = "id:s",
1643 .params = "id",
1644 .help = "remove chardev",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001645 .cmd = hmp_chardev_remove,
Hani Benhabiles6297d9a2014-05-07 23:41:28 +01001646 .command_completion = chardev_remove_completion,
Gerd Hoffmann46920822013-02-28 08:46:10 +01001647 },
1648
Peter Maydella6b30bc2020-02-28 15:36:06 +00001649SRST
1650``chardev-remove`` *id*
1651 Removes the chardev *id*.
1652ERST
Gerd Hoffmannf1088902012-12-19 10:33:40 +01001653
1654 {
Stefan Fritschbd1d5ad2017-06-11 09:48:17 +02001655 .name = "chardev-send-break",
1656 .args_type = "id:s",
1657 .params = "id",
1658 .help = "send a break on chardev",
1659 .cmd = hmp_chardev_send_break,
1660 .command_completion = chardev_remove_completion,
1661 },
1662
Peter Maydella6b30bc2020-02-28 15:36:06 +00001663SRST
1664``chardev-send-break`` *id*
1665 Send a break on the chardev *id*.
1666ERST
Stefan Fritschbd1d5ad2017-06-11 09:48:17 +02001667
1668 {
Kevin Wolf587da2c2013-06-05 14:19:41 +02001669 .name = "qemu-io",
Kevin Wolf89b6fc42019-12-17 15:13:34 +01001670 .args_type = "qdev:-d,device:B,command:s",
1671 .params = "[-d] [device] \"[command]\"",
1672 .help = "run a qemu-io command on a block device\n\t\t\t"
1673 "-d: [device] is a device ID rather than a "
1674 "drive ID or node name",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001675 .cmd = hmp_qemu_io,
Kevin Wolf587da2c2013-06-05 14:19:41 +02001676 },
1677
Peter Maydella6b30bc2020-02-28 15:36:06 +00001678SRST
1679``qemu-io`` *device* *command*
1680 Executes a qemu-io command on the given block device.
1681ERST
Kevin Wolf587da2c2013-06-05 14:19:41 +02001682
1683 {
Andreas Färber89d7fa92014-05-07 18:08:29 +02001684 .name = "qom-list",
1685 .args_type = "path:s?",
1686 .params = "path",
1687 .help = "list QOM properties",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001688 .cmd = hmp_qom_list,
Dr. David Alan Gilbert8c7c7ec2018-06-20 16:39:45 +01001689 .flags = "p",
Andreas Färber89d7fa92014-05-07 18:08:29 +02001690 },
1691
Peter Maydella6b30bc2020-02-28 15:36:06 +00001692SRST
1693``qom-list`` [*path*]
1694 Print QOM properties of object at location *path*
1695ERST
Andreas Färber89d7fa92014-05-07 18:08:29 +02001696
1697 {
Dr. David Alan Gilbert89cf4fe2020-05-20 16:11:07 +01001698 .name = "qom-get",
1699 .args_type = "path:s,property:s",
1700 .params = "path property",
1701 .help = "print QOM property",
1702 .cmd = hmp_qom_get,
1703 .flags = "p",
1704 },
1705
1706SRST
1707``qom-get`` *path* *property*
1708 Print QOM property *property* of object at location *path*
1709ERST
1710
1711 {
Andreas Färberc0e6ee92014-05-07 19:48:15 +02001712 .name = "qom-set",
David Hildenbrand2d9e3dd2020-06-10 09:51:53 +02001713 .args_type = "json:-j,path:s,property:s,value:S",
1714 .params = "[-j] path property value",
1715 .help = "set QOM property.\n\t\t\t"
1716 "-j: the value is specified in json format.",
Marc-André Lureau2b9e3572016-09-12 13:19:06 +04001717 .cmd = hmp_qom_set,
Dr. David Alan Gilbert8c7c7ec2018-06-20 16:39:45 +01001718 .flags = "p",
Andreas Färberc0e6ee92014-05-07 19:48:15 +02001719 },
1720
Peter Maydella6b30bc2020-02-28 15:36:06 +00001721SRST
1722``qom-set`` *path* *property* *value*
1723 Set QOM property *property* of object at location *path* to value *value*
1724ERST
Andreas Färberc0e6ee92014-05-07 19:48:15 +02001725
1726 {
Pavel Dovgalyuke7510672020-10-03 20:13:26 +03001727 .name = "replay_break",
Alex Bennéeae49ce02021-05-20 18:43:01 +01001728 .args_type = "icount:l",
Pavel Dovgalyuke7510672020-10-03 20:13:26 +03001729 .params = "icount",
1730 .help = "set breakpoint at the specified instruction count",
1731 .cmd = hmp_replay_break,
1732 },
1733
1734SRST
1735``replay_break`` *icount*
1736 Set replay breakpoint at instruction count *icount*.
1737 Execution stops when the specified instruction is reached.
1738 There can be at most one breakpoint. When breakpoint is set, any prior
1739 one is removed. The breakpoint may be set only in replay mode and only
1740 "in the future", i.e. at instruction counts greater than the current one.
1741 The current instruction count can be observed with ``info replay``.
1742ERST
1743
1744 {
1745 .name = "replay_delete_break",
1746 .args_type = "",
1747 .params = "",
1748 .help = "remove replay breakpoint",
1749 .cmd = hmp_replay_delete_break,
1750 },
1751
1752SRST
1753``replay_delete_break``
1754 Remove replay breakpoint which was previously set with ``replay_break``.
1755 The command is ignored when there are no replay breakpoints.
1756ERST
1757
1758 {
Pavel Dovgalyukf6baed32020-10-03 20:13:31 +03001759 .name = "replay_seek",
Alex Bennéeae49ce02021-05-20 18:43:01 +01001760 .args_type = "icount:l",
Pavel Dovgalyukf6baed32020-10-03 20:13:31 +03001761 .params = "icount",
1762 .help = "replay execution to the specified instruction count",
1763 .cmd = hmp_replay_seek,
1764 },
1765
1766SRST
1767``replay_seek`` *icount*
1768 Automatically proceed to the instruction count *icount*, when
1769 replaying the execution. The command automatically loads nearest
1770 snapshot and replays the execution to find the desired instruction.
1771 When there is no preceding snapshot or the execution is not replayed,
1772 then the command fails.
1773 *icount* for the reference may be observed with ``info replay`` command.
1774ERST
1775
1776 {
Peter Xua4a571d2021-06-07 09:11:57 +08001777 .name = "calc_dirty_rate",
Hyman Huang(黄勇)826b8bc2021-07-20 23:19:17 +08001778 .args_type = "dirty_ring:-r,dirty_bitmap:-b,second:l,sample_pages_per_GB:l?",
1779 .params = "[-r] [-b] second [sample_pages_per_GB]",
1780 .help = "start a round of guest dirty rate measurement (using -r to"
1781 "\n\t\t\t specify dirty ring as the method of calculation and"
1782 "\n\t\t\t -b to specify dirty bitmap as method of calculation)",
Peter Xua4a571d2021-06-07 09:11:57 +08001783 .cmd = hmp_calc_dirty_rate,
1784 },
Hyman Huang(黄勇)f3b2e382022-06-26 01:38:36 +08001785
1786SRST
Dr. David Alan Gilbert22269b02022-09-08 19:35:03 +01001787``calc_dirty_rate`` *second*
1788 Start a round of dirty rate measurement with the period specified in *second*.
1789 The result of the dirty rate measurement may be observed with ``info
1790 dirty_rate`` command.
Hyman Huang(黄勇)f3b2e382022-06-26 01:38:36 +08001791ERST
1792
1793 {
1794 .name = "set_vcpu_dirty_limit",
1795 .args_type = "dirty_rate:l,cpu_index:l?",
1796 .params = "dirty_rate [cpu_index]",
1797 .help = "set dirty page rate limit, use cpu_index to set limit"
1798 "\n\t\t\t\t\t on a specified virtual cpu",
1799 .cmd = hmp_set_vcpu_dirty_limit,
1800 },
1801
1802SRST
Dr. David Alan Gilbert22269b02022-09-08 19:35:03 +01001803``set_vcpu_dirty_limit``
1804 Set dirty page rate limit on virtual CPU, the information about all the
Hyman Huang(黄勇)f3b2e382022-06-26 01:38:36 +08001805 virtual CPU dirty limit status can be observed with ``info vcpu_dirty_limit``
1806 command.
1807ERST
1808
1809 {
1810 .name = "cancel_vcpu_dirty_limit",
1811 .args_type = "cpu_index:l?",
1812 .params = "[cpu_index]",
1813 .help = "cancel dirty page rate limit, use cpu_index to cancel"
1814 "\n\t\t\t\t\t limit on a specified virtual cpu",
1815 .cmd = hmp_cancel_vcpu_dirty_limit,
1816 },
Dr. David Alan Gilbert22269b02022-09-08 19:35:03 +01001817
1818SRST
1819``cancel_vcpu_dirty_limit``
1820 Cancel dirty page rate limit on virtual CPU, the information about all the
1821 virtual CPU dirty limit status can be observed with ``info vcpu_dirty_limit``
1822 command.
1823ERST
1824
1825 {
1826 .name = "info",
1827 .args_type = "item:s?",
1828 .params = "[subcommand]",
1829 .help = "show various information about the system state",
1830 .cmd = hmp_info_help,
1831 .sub_table = hmp_info_cmds,
1832 .flags = "p",
1833 },
Daniel Henrique Barbozabf353ad2022-09-26 14:38:40 -03001834
1835#if defined(CONFIG_FDT)
1836 {
1837 .name = "dumpdtb",
1838 .args_type = "filename:F",
1839 .params = "filename",
1840 .help = "dump the FDT in dtb format to 'filename'",
1841 .cmd = hmp_dumpdtb,
1842 },
1843
1844SRST
1845``dumpdtb`` *filename*
1846 Dump the FDT in dtb format to *filename*.
1847ERST
1848#endif
Joao Martins507cb642018-08-21 12:16:19 -04001849
1850#if defined(CONFIG_XEN_EMU)
1851 {
1852 .name = "xen-event-inject",
1853 .args_type = "port:i",
1854 .params = "port",
1855 .help = "inject event channel",
1856 .cmd = hmp_xen_event_inject,
1857 },
1858
1859SRST
1860``xen-event-inject`` *port*
1861 Notify guest via event channel on port *port*.
1862ERST
1863
1864
1865 {
1866 .name = "xen-event-list",
1867 .args_type = "",
1868 .params = "",
1869 .help = "list event channel state",
1870 .cmd = hmp_xen_event_list,
1871 },
1872
1873SRST
1874``xen-event-list``
1875 List event channels in the guest
1876ERST
1877#endif