2020-03-07 01:17:44 +08:00
|
|
|
HXCOMM Use DEFHEADING() to define headings in both help text and rST.
|
|
|
|
HXCOMM Text between SRST and ERST is copied to the rST version and
|
|
|
|
HXCOMM discarded from C version.
|
2009-06-06 16:22:04 +08:00
|
|
|
HXCOMM DEF(command, args, callback, arg_string, help) is used to construct
|
|
|
|
HXCOMM monitor commands
|
2020-03-07 01:17:44 +08:00
|
|
|
HXCOMM HXCOMM can be used for comments, discarded from both rST and C.
|
2009-06-06 16:22:04 +08:00
|
|
|
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "help|?",
|
2013-08-27 20:38:26 +08:00
|
|
|
.args_type = "name:S?",
|
2009-10-08 00:41:50 +08:00
|
|
|
.params = "[cmd]",
|
|
|
|
.help = "show the help",
|
2023-01-24 20:19:43 +08:00
|
|
|
.cmd = hmp_help,
|
2018-06-20 23:39:42 +08:00
|
|
|
.flags = "p",
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``help`` or ``?`` [*cmd*]
|
|
|
|
Show the help for all commands or just for command *cmd*.
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "commit",
|
|
|
|
.args_type = "device:B",
|
|
|
|
.params = "device|all",
|
|
|
|
.help = "commit changes to the disk images (if -snapshot is used) or backing files",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_commit,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``commit``
|
|
|
|
Commit changes to the disk images (if -snapshot is used) or backing files.
|
|
|
|
If the backing file is smaller than the snapshot, then the backing file
|
|
|
|
will be resized to be the same size as the snapshot. If the snapshot is
|
|
|
|
smaller than the backing file, the backing file will not be truncated.
|
|
|
|
If you want the backing file to match the size of the smaller snapshot,
|
|
|
|
you can safely truncate it yourself once the commit operation successfully
|
|
|
|
completes.
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
2020-11-21 23:17:11 +08:00
|
|
|
.name = "quit|q",
|
2009-10-08 00:41:50 +08:00
|
|
|
.args_type = "",
|
|
|
|
.params = "",
|
|
|
|
.help = "quit the emulator",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_quit,
|
2020-10-27 18:56:32 +08:00
|
|
|
.flags = "p",
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
2020-11-21 23:17:11 +08:00
|
|
|
``quit`` or ``q``
|
2020-02-28 23:36:06 +08:00
|
|
|
Quit the emulator.
|
|
|
|
ERST
|
2018-06-20 23:39:46 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "exit_preconfig",
|
|
|
|
.args_type = "",
|
|
|
|
.params = "",
|
|
|
|
.help = "exit the preconfig state",
|
|
|
|
.cmd = hmp_exit_preconfig,
|
|
|
|
.flags = "p",
|
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``exit_preconfig``
|
|
|
|
This command makes QEMU exit the preconfig state and proceed with
|
|
|
|
VM initialization using configuration data provided on the command line
|
|
|
|
and via the QMP monitor during the preconfig state. The command is only
|
|
|
|
available during the preconfig state (i.e. when the --preconfig command
|
|
|
|
line option was in use).
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2011-01-24 20:32:33 +08:00
|
|
|
{
|
|
|
|
.name = "block_resize",
|
|
|
|
.args_type = "device:B,size:o",
|
|
|
|
.params = "device size",
|
|
|
|
.help = "resize a block image",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_block_resize,
|
2020-10-05 23:58:55 +08:00
|
|
|
.coroutine = true,
|
2020-11-03 17:37:20 +08:00
|
|
|
.flags = "p",
|
2011-01-24 20:32:33 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``block_resize``
|
|
|
|
Resize a block image while a guest is running. Usually requires guest
|
|
|
|
action to see the updated size. Resize to a lower size is supported,
|
|
|
|
but should be used with extreme caution. Note that this command only
|
|
|
|
resizes image files, it can not resize block devices like LVM volumes.
|
|
|
|
ERST
|
2011-01-24 20:32:33 +08:00
|
|
|
|
2012-01-18 22:40:46 +08:00
|
|
|
{
|
|
|
|
.name = "block_stream",
|
2012-04-25 23:51:03 +08:00
|
|
|
.args_type = "device:B,speed:o?,base:s?",
|
|
|
|
.params = "device [speed [base]]",
|
2012-01-18 22:40:46 +08:00
|
|
|
.help = "copy data from a backing file into a block device",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_block_stream,
|
2020-11-03 17:37:20 +08:00
|
|
|
.flags = "p",
|
2012-01-18 22:40:46 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``block_stream``
|
|
|
|
Copy data from a backing file into a block device.
|
|
|
|
ERST
|
2012-01-18 22:40:47 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "block_job_set_speed",
|
2012-04-25 23:51:02 +08:00
|
|
|
.args_type = "device:B,speed:o",
|
|
|
|
.params = "device speed",
|
2012-01-18 22:40:47 +08:00
|
|
|
.help = "set maximum speed for a background block operation",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_block_job_set_speed,
|
2020-11-03 17:37:20 +08:00
|
|
|
.flags = "p",
|
2012-01-18 22:40:47 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``block_job_set_speed``
|
|
|
|
Set maximum speed for a background block operation.
|
|
|
|
ERST
|
2012-01-18 22:40:48 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "block_job_cancel",
|
2012-09-28 23:22:51 +08:00
|
|
|
.args_type = "force:-f,device:B",
|
|
|
|
.params = "[-f] device",
|
|
|
|
.help = "stop an active background block operation (use -f"
|
block/mirror: change the semantic of 'force' of block-job-cancel
When doing drive mirror to a low speed shared storage, if there was heavy
BLK IO write workload in VM after the 'ready' event, drive mirror block job
can't be canceled immediately, it would keep running until the heavy BLK IO
workload stopped in the VM.
Libvirt depends on the current block-job-cancel semantics, which is that
when used without a flag after the 'ready' event, the command blocks
until data is in sync. However, these semantics are awkward in other
situations, for example, people may use drive mirror for realtime
backups while still wanting to use block live migration. Libvirt cannot
start a block live migration while another drive mirror is in progress,
but the user would rather abandon the backup attempt as broken and
proceed with the live migration than be stuck waiting for the current
drive mirror backup to finish.
The drive-mirror command already includes a 'force' flag, which libvirt
does not use, although it documented the flag as only being useful to
quit a job which is paused. However, since quitting a paused job has
the same effect as abandoning a backup in a non-paused job (namely, the
destination file is not in sync, and the command completes immediately),
we can just improve the documentation to make the force flag obviously
useful.
Cc: Paolo Bonzini <pbonzini@redhat.com>
Cc: Jeff Cody <jcody@redhat.com>
Cc: Kevin Wolf <kwolf@redhat.com>
Cc: Max Reitz <mreitz@redhat.com>
Cc: Eric Blake <eblake@redhat.com>
Cc: John Snow <jsnow@redhat.com>
Reported-by: Huaitong Han <huanhuaitong@didichuxing.com>
Signed-off-by: Huaitong Han <huanhuaitong@didichuxing.com>
Signed-off-by: Liang Li <liliangleo@didichuxing.com>
Signed-off-by: Jeff Cody <jcody@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2018-03-13 20:12:16 +08:00
|
|
|
"\n\t\t\t if you want to abort the operation immediately"
|
|
|
|
"\n\t\t\t instead of keep running until data is in sync)",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_block_job_cancel,
|
2020-11-03 17:37:20 +08:00
|
|
|
.flags = "p",
|
2012-01-18 22:40:48 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``block_job_cancel``
|
|
|
|
Stop an active background block operation (streaming, mirroring).
|
|
|
|
ERST
|
2012-10-18 22:49:21 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "block_job_complete",
|
|
|
|
.args_type = "device:B",
|
|
|
|
.params = "device",
|
|
|
|
.help = "stop an active background block operation",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_block_job_complete,
|
2020-11-03 17:37:20 +08:00
|
|
|
.flags = "p",
|
2012-10-18 22:49:21 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``block_job_complete``
|
|
|
|
Manually trigger completion of an active background block operation.
|
|
|
|
For mirroring, this will switch the device to the destination path.
|
|
|
|
ERST
|
2012-09-28 23:22:51 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "block_job_pause",
|
|
|
|
.args_type = "device:B",
|
|
|
|
.params = "device",
|
|
|
|
.help = "pause an active background block operation",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_block_job_pause,
|
2020-11-03 17:37:20 +08:00
|
|
|
.flags = "p",
|
2012-09-28 23:22:51 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``block_job_pause``
|
|
|
|
Pause an active block streaming operation.
|
|
|
|
ERST
|
2012-09-28 23:22:51 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "block_job_resume",
|
|
|
|
.args_type = "device:B",
|
|
|
|
.params = "device",
|
|
|
|
.help = "resume a paused background block operation",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_block_job_resume,
|
2020-11-03 17:37:20 +08:00
|
|
|
.flags = "p",
|
2012-09-28 23:22:51 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``block_job_resume``
|
|
|
|
Resume a paused block streaming operation.
|
|
|
|
ERST
|
2011-01-24 20:32:33 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "eject",
|
2009-12-15 04:53:21 +08:00
|
|
|
.args_type = "force:-f,device:B",
|
2009-10-08 00:41:50 +08:00
|
|
|
.params = "[-f] device",
|
|
|
|
.help = "eject a removable medium (use -f to force it)",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_eject,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``eject [-f]`` *device*
|
|
|
|
Eject a removable medium (use -f to force it).
|
|
|
|
ERST
|
2010-11-13 01:07:13 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "drive_del",
|
2014-04-13 23:25:05 +08:00
|
|
|
.args_type = "id:B",
|
2010-11-13 01:07:13 +08:00
|
|
|
.params = "device",
|
|
|
|
.help = "remove host block device",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_drive_del,
|
2010-11-13 01:07:13 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``drive_del`` *device*
|
|
|
|
Remove host block device. The result is that guest generated IO is no longer
|
|
|
|
submitted against the host device underlying the disk. Once a drive has
|
|
|
|
been deleted, the QEMU Block layer returns -EIO which results in IO
|
|
|
|
errors in the guest for applications that are reading/writing to the device.
|
|
|
|
These errors are always reported to the guest, regardless of the drive's error
|
|
|
|
actions (drive options rerror, werror).
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "change",
|
2022-04-13 06:18:46 +08:00
|
|
|
.args_type = "device:B,force:-f,target:F,arg:s?,read-only-mode:s?",
|
|
|
|
.params = "device [-f] filename [format [read-only-mode]]",
|
|
|
|
.help = "change a removable medium, optional format, use -f to force the operation",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_change,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``change`` *device* *setting*
|
|
|
|
Change the configuration of a device.
|
|
|
|
|
2022-04-13 06:18:46 +08:00
|
|
|
``change`` *diskdevice* [-f] *filename* [*format* [*read-only-mode*]]
|
2020-02-28 23:36:06 +08:00
|
|
|
Change the medium for a removable disk device to point to *filename*. eg::
|
|
|
|
|
|
|
|
(qemu) change ide1-cd0 /path/to/some.iso
|
|
|
|
|
2022-04-13 06:18:46 +08:00
|
|
|
``-f``
|
|
|
|
forces the operation even if the guest has locked the tray.
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
*format* is optional.
|
|
|
|
|
|
|
|
*read-only-mode* may be used to change the read-only status of the device.
|
|
|
|
It accepts the following values:
|
|
|
|
|
|
|
|
retain
|
|
|
|
Retains the current status; this is the default.
|
|
|
|
|
|
|
|
read-only
|
|
|
|
Makes the device read-only.
|
|
|
|
|
|
|
|
read-write
|
|
|
|
Makes the device writable.
|
|
|
|
|
|
|
|
``change vnc password`` [*password*]
|
|
|
|
|
|
|
|
Change the password associated with the VNC server. If the new password
|
|
|
|
is not supplied, the monitor will prompt for it to be entered. VNC
|
|
|
|
passwords are only significant up to 8 letters. eg::
|
|
|
|
|
|
|
|
(qemu) change vnc password
|
|
|
|
Password: ********
|
|
|
|
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "screendump",
|
2022-04-08 15:13:35 +08:00
|
|
|
.args_type = "filename:F,format:-fs,device:s?,head:i?",
|
|
|
|
.params = "filename [-f format] [device [head]]",
|
|
|
|
.help = "save screen from head 'head' of display device 'device'"
|
|
|
|
"in specified format 'format' as image 'filename'."
|
|
|
|
"Currently only 'png' and 'ppm' formats are supported.",
|
|
|
|
.cmd = hmp_screendump,
|
2020-10-27 21:36:02 +08:00
|
|
|
.coroutine = true,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``screendump`` *filename*
|
|
|
|
Save screen into PPM image *filename*.
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "logfile",
|
|
|
|
.args_type = "filename:F",
|
|
|
|
.params = "filename",
|
|
|
|
.help = "output logs to 'filename'",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_logfile,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``logfile`` *filename*
|
|
|
|
Output logs to *filename*.
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2010-06-24 19:34:53 +08:00
|
|
|
{
|
|
|
|
.name = "trace-event",
|
2016-07-11 18:53:57 +08:00
|
|
|
.args_type = "name:s,option:b,vcpu:i?",
|
|
|
|
.params = "name on|off [vcpu]",
|
|
|
|
.help = "changes status of a specific trace event "
|
|
|
|
"(vcpu: vCPU to set, default is all)",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_trace_event,
|
2015-08-14 18:27:43 +08:00
|
|
|
.command_completion = trace_event_completion,
|
2010-06-24 19:34:53 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``trace-event``
|
|
|
|
changes status of a trace event
|
|
|
|
ERST
|
2010-07-13 16:26:33 +08:00
|
|
|
|
2011-10-02 21:44:37 +08:00
|
|
|
#if defined(CONFIG_TRACE_SIMPLE)
|
2010-07-13 16:26:33 +08:00
|
|
|
{
|
|
|
|
.name = "trace-file",
|
|
|
|
.args_type = "op:s?,arg:F?",
|
|
|
|
.params = "on|off|flush|set [arg]",
|
|
|
|
.help = "open, close, or flush trace file, or set a new file name",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_trace_file,
|
2010-07-13 16:26:33 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``trace-file on|off|flush``
|
|
|
|
Open, close, or flush the trace file. If no argument is given, the
|
|
|
|
status of the trace file is displayed.
|
|
|
|
ERST
|
2010-06-24 19:34:53 +08:00
|
|
|
#endif
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "log",
|
|
|
|
.args_type = "items:s",
|
|
|
|
.params = "item1[,...]",
|
2013-02-27 01:52:40 +08:00
|
|
|
.help = "activate logging of the specified items",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_log,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``log`` *item1*\ [,...]
|
|
|
|
Activate logging of the specified items.
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "savevm",
|
|
|
|
.args_type = "name:s?",
|
block/snapshot.c: eliminate use of ID input in snapshot operations
At this moment, QEMU attempts to create/load/delete snapshots
by using either an ID (id_str) or a name. The problem is that the code
isn't consistent of whether the entered argument is an ID or a name,
causing unexpected behaviors.
For example, when creating snapshots via savevm <arg>, what happens is that
"arg" is treated as both name and id_str. In a guest without snapshots, create
a single snapshot via savevm:
(qemu) savevm 0
(qemu) info snapshots
List of snapshots present on all disks:
ID TAG VM SIZE DATE VM CLOCK
-- 0 741M 2018-07-31 13:39:56 00:41:25.313
A snapshot with name "0" is created. ID is hidden from the user, but the
ID is a non-zero integer that starts at "1". Thus, this snapshot has
id_str=1, TAG="0". Creating a second snapshot with arg = 1, the first one
is deleted:
(qemu) savevm 1
(qemu) info snapshots
List of snapshots present on all disks:
ID TAG VM SIZE DATE VM CLOCK
-- 1 741M 2018-07-31 13:42:14 00:41:55.252
What happened?
- when creating the second snapshot, a verification is done inside
bdrv_all_delete_snapshot to delete any existing snapshots that matches an
string argument. Here, the code calls bdrv_all_delete_snapshot("1", ...);
- bdrv_all_delete_snapshot calls bdrv_snapshot_find(..., "1") for each
BlockDriverState of the guest. And this is where things goes tilting:
bdrv_snapshot_find does a search by both id_str and name. It finds
out that there is a snapshot that has id_str = 1, stores a reference
to the snapshot in the sn_info pointer and then returns match found;
- since a match was found, a call to bdrv_snapshot_delete_by_id_or_name() is
made. This function ignores the pointer written by bdrv_snapshot_find. Instead,
it deletes the snapshot using bdrv_snapshot_delete() calling it first with
id_str = 1. If it fails to delete, then it calls it again with name = 1.
- after all that, QEMU creates the new snapshot, that has id_str = 1 and
name = 1. The user is left wondering that happened with the first snapshot
created. Similar bugs can be triggered when using loadvm and delvm.
Before contemplating discarding the use of ID input in these operations,
I've searched the code of what would be the implications. My findings
are:
- the RBD and Sheepdog drivers don't care. Both uses the 'name' field as
key in their logic, making id_str = name when appropriate.
replay-snapshot.c does not make any special use of id_str;
- qcow2 uses id_str as an unique identifier but it is automatically
calculated, not being influenced by user input. Other than that, there are
no distinguish operations made only with id_str;
- in blockdev.c, the delete operation uses a match of both id_str AND
name. Given that id_str is either a copy of 'name' or auto-generated,
we're fine here.
This gives motivation to not consider ID as a valid user input in HMP
commands - sticking with 'name' input only is more consistent. To
accomplish that, the following changes were made in this patch:
- bdrv_snapshot_find() does not match for id_str anymore, only 'name'. The
function is called in save_snapshot(), load_snapshot(), bdrv_all_delete_snapshot()
and bdrv_all_find_snapshot(). This change makes the search function more
predictable and does not change the behavior of any underlying code that uses
these affected functions, which are related to HMP (which is fine) and the
main loop inside vl.c (which doesn't care about it anyways);
- bdrv_all_delete_snapshot() does not call bdrv_snapshot_delete_by_id_or_name
anymore. Instead, it uses the pointer returned by bdrv_snapshot_find to
erase the snapshot with the exact match of id_str an name. This function
is called in save_snapshot and hmp_delvm, thus this change produces the
intended effect;
- documentation changes to reflect the new behavior. I consider this to
be an API fix instead of an API change - the user was already creating
snapshots using 'name', but now he/she will also enjoy a consistent
behavior.
Ideally we would get rid of the id_str field entirely, but this would have
repercussions on existing snapshots. Another day perhaps.
Signed-off-by: Daniel Henrique Barboza <danielhb413@gmail.com>
Acked-by: Dr. David Alan Gilbert <dgilbert@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2018-11-07 21:09:58 +08:00
|
|
|
.params = "tag",
|
|
|
|
.help = "save a VM snapshot. If no tag is provided, a new snapshot is created",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_savevm,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``savevm`` *tag*
|
|
|
|
Create a snapshot of the whole virtual machine. If *tag* is
|
|
|
|
provided, it is used as human readable identifier. If there is already
|
|
|
|
a snapshot with the same tag, it is replaced. More info at
|
|
|
|
:ref:`vm_005fsnapshots`.
|
|
|
|
|
|
|
|
Since 4.0, savevm stopped allowing the snapshot id to be set, accepting
|
|
|
|
only *tag* as parameter.
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "loadvm",
|
|
|
|
.args_type = "name:s",
|
block/snapshot.c: eliminate use of ID input in snapshot operations
At this moment, QEMU attempts to create/load/delete snapshots
by using either an ID (id_str) or a name. The problem is that the code
isn't consistent of whether the entered argument is an ID or a name,
causing unexpected behaviors.
For example, when creating snapshots via savevm <arg>, what happens is that
"arg" is treated as both name and id_str. In a guest without snapshots, create
a single snapshot via savevm:
(qemu) savevm 0
(qemu) info snapshots
List of snapshots present on all disks:
ID TAG VM SIZE DATE VM CLOCK
-- 0 741M 2018-07-31 13:39:56 00:41:25.313
A snapshot with name "0" is created. ID is hidden from the user, but the
ID is a non-zero integer that starts at "1". Thus, this snapshot has
id_str=1, TAG="0". Creating a second snapshot with arg = 1, the first one
is deleted:
(qemu) savevm 1
(qemu) info snapshots
List of snapshots present on all disks:
ID TAG VM SIZE DATE VM CLOCK
-- 1 741M 2018-07-31 13:42:14 00:41:55.252
What happened?
- when creating the second snapshot, a verification is done inside
bdrv_all_delete_snapshot to delete any existing snapshots that matches an
string argument. Here, the code calls bdrv_all_delete_snapshot("1", ...);
- bdrv_all_delete_snapshot calls bdrv_snapshot_find(..., "1") for each
BlockDriverState of the guest. And this is where things goes tilting:
bdrv_snapshot_find does a search by both id_str and name. It finds
out that there is a snapshot that has id_str = 1, stores a reference
to the snapshot in the sn_info pointer and then returns match found;
- since a match was found, a call to bdrv_snapshot_delete_by_id_or_name() is
made. This function ignores the pointer written by bdrv_snapshot_find. Instead,
it deletes the snapshot using bdrv_snapshot_delete() calling it first with
id_str = 1. If it fails to delete, then it calls it again with name = 1.
- after all that, QEMU creates the new snapshot, that has id_str = 1 and
name = 1. The user is left wondering that happened with the first snapshot
created. Similar bugs can be triggered when using loadvm and delvm.
Before contemplating discarding the use of ID input in these operations,
I've searched the code of what would be the implications. My findings
are:
- the RBD and Sheepdog drivers don't care. Both uses the 'name' field as
key in their logic, making id_str = name when appropriate.
replay-snapshot.c does not make any special use of id_str;
- qcow2 uses id_str as an unique identifier but it is automatically
calculated, not being influenced by user input. Other than that, there are
no distinguish operations made only with id_str;
- in blockdev.c, the delete operation uses a match of both id_str AND
name. Given that id_str is either a copy of 'name' or auto-generated,
we're fine here.
This gives motivation to not consider ID as a valid user input in HMP
commands - sticking with 'name' input only is more consistent. To
accomplish that, the following changes were made in this patch:
- bdrv_snapshot_find() does not match for id_str anymore, only 'name'. The
function is called in save_snapshot(), load_snapshot(), bdrv_all_delete_snapshot()
and bdrv_all_find_snapshot(). This change makes the search function more
predictable and does not change the behavior of any underlying code that uses
these affected functions, which are related to HMP (which is fine) and the
main loop inside vl.c (which doesn't care about it anyways);
- bdrv_all_delete_snapshot() does not call bdrv_snapshot_delete_by_id_or_name
anymore. Instead, it uses the pointer returned by bdrv_snapshot_find to
erase the snapshot with the exact match of id_str an name. This function
is called in save_snapshot and hmp_delvm, thus this change produces the
intended effect;
- documentation changes to reflect the new behavior. I consider this to
be an API fix instead of an API change - the user was already creating
snapshots using 'name', but now he/she will also enjoy a consistent
behavior.
Ideally we would get rid of the id_str field entirely, but this would have
repercussions on existing snapshots. Another day perhaps.
Signed-off-by: Daniel Henrique Barboza <danielhb413@gmail.com>
Acked-by: Dr. David Alan Gilbert <dgilbert@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2018-11-07 21:09:58 +08:00
|
|
|
.params = "tag",
|
|
|
|
.help = "restore a VM snapshot from its tag",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_loadvm,
|
2014-05-28 06:39:37 +08:00
|
|
|
.command_completion = loadvm_completion,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``loadvm`` *tag*
|
|
|
|
Set the whole virtual machine to the snapshot identified by the tag
|
|
|
|
*tag*.
|
|
|
|
|
|
|
|
Since 4.0, loadvm stopped accepting snapshot id as parameter.
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "delvm",
|
|
|
|
.args_type = "name:s",
|
block/snapshot.c: eliminate use of ID input in snapshot operations
At this moment, QEMU attempts to create/load/delete snapshots
by using either an ID (id_str) or a name. The problem is that the code
isn't consistent of whether the entered argument is an ID or a name,
causing unexpected behaviors.
For example, when creating snapshots via savevm <arg>, what happens is that
"arg" is treated as both name and id_str. In a guest without snapshots, create
a single snapshot via savevm:
(qemu) savevm 0
(qemu) info snapshots
List of snapshots present on all disks:
ID TAG VM SIZE DATE VM CLOCK
-- 0 741M 2018-07-31 13:39:56 00:41:25.313
A snapshot with name "0" is created. ID is hidden from the user, but the
ID is a non-zero integer that starts at "1". Thus, this snapshot has
id_str=1, TAG="0". Creating a second snapshot with arg = 1, the first one
is deleted:
(qemu) savevm 1
(qemu) info snapshots
List of snapshots present on all disks:
ID TAG VM SIZE DATE VM CLOCK
-- 1 741M 2018-07-31 13:42:14 00:41:55.252
What happened?
- when creating the second snapshot, a verification is done inside
bdrv_all_delete_snapshot to delete any existing snapshots that matches an
string argument. Here, the code calls bdrv_all_delete_snapshot("1", ...);
- bdrv_all_delete_snapshot calls bdrv_snapshot_find(..., "1") for each
BlockDriverState of the guest. And this is where things goes tilting:
bdrv_snapshot_find does a search by both id_str and name. It finds
out that there is a snapshot that has id_str = 1, stores a reference
to the snapshot in the sn_info pointer and then returns match found;
- since a match was found, a call to bdrv_snapshot_delete_by_id_or_name() is
made. This function ignores the pointer written by bdrv_snapshot_find. Instead,
it deletes the snapshot using bdrv_snapshot_delete() calling it first with
id_str = 1. If it fails to delete, then it calls it again with name = 1.
- after all that, QEMU creates the new snapshot, that has id_str = 1 and
name = 1. The user is left wondering that happened with the first snapshot
created. Similar bugs can be triggered when using loadvm and delvm.
Before contemplating discarding the use of ID input in these operations,
I've searched the code of what would be the implications. My findings
are:
- the RBD and Sheepdog drivers don't care. Both uses the 'name' field as
key in their logic, making id_str = name when appropriate.
replay-snapshot.c does not make any special use of id_str;
- qcow2 uses id_str as an unique identifier but it is automatically
calculated, not being influenced by user input. Other than that, there are
no distinguish operations made only with id_str;
- in blockdev.c, the delete operation uses a match of both id_str AND
name. Given that id_str is either a copy of 'name' or auto-generated,
we're fine here.
This gives motivation to not consider ID as a valid user input in HMP
commands - sticking with 'name' input only is more consistent. To
accomplish that, the following changes were made in this patch:
- bdrv_snapshot_find() does not match for id_str anymore, only 'name'. The
function is called in save_snapshot(), load_snapshot(), bdrv_all_delete_snapshot()
and bdrv_all_find_snapshot(). This change makes the search function more
predictable and does not change the behavior of any underlying code that uses
these affected functions, which are related to HMP (which is fine) and the
main loop inside vl.c (which doesn't care about it anyways);
- bdrv_all_delete_snapshot() does not call bdrv_snapshot_delete_by_id_or_name
anymore. Instead, it uses the pointer returned by bdrv_snapshot_find to
erase the snapshot with the exact match of id_str an name. This function
is called in save_snapshot and hmp_delvm, thus this change produces the
intended effect;
- documentation changes to reflect the new behavior. I consider this to
be an API fix instead of an API change - the user was already creating
snapshots using 'name', but now he/she will also enjoy a consistent
behavior.
Ideally we would get rid of the id_str field entirely, but this would have
repercussions on existing snapshots. Another day perhaps.
Signed-off-by: Daniel Henrique Barboza <danielhb413@gmail.com>
Acked-by: Dr. David Alan Gilbert <dgilbert@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2018-11-07 21:09:58 +08:00
|
|
|
.params = "tag",
|
|
|
|
.help = "delete a VM snapshot from its tag",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_delvm,
|
2014-05-28 06:39:37 +08:00
|
|
|
.command_completion = delvm_completion,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``delvm`` *tag*
|
|
|
|
Delete the snapshot identified by *tag*.
|
|
|
|
|
|
|
|
Since 4.0, delvm stopped deleting snapshots by snapshot id, accepting
|
|
|
|
only *tag* as parameter.
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2023-04-18 00:40:39 +08:00
|
|
|
{
|
|
|
|
.name = "one-insn-per-tb",
|
|
|
|
.args_type = "option:s?",
|
|
|
|
.params = "[on|off]",
|
|
|
|
.help = "run emulation with one guest instruction per translation block",
|
|
|
|
.cmd = hmp_one_insn_per_tb,
|
|
|
|
},
|
|
|
|
|
|
|
|
SRST
|
|
|
|
``one-insn-per-tb [off]``
|
|
|
|
Run the emulation with one guest instruction per translation block.
|
|
|
|
This slows down emulation a lot, but can be useful in some situations,
|
|
|
|
such as when trying to analyse the logs produced by the ``-d`` option.
|
|
|
|
This only has an effect when using TCG, not with KVM or other accelerators.
|
|
|
|
|
|
|
|
If called with option off, the emulation returns to normal mode.
|
|
|
|
ERST
|
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "singlestep",
|
|
|
|
.args_type = "option:s?",
|
|
|
|
.params = "[on|off]",
|
2023-04-18 00:40:39 +08:00
|
|
|
.help = "deprecated synonym for one-insn-per-tb",
|
|
|
|
.cmd = hmp_one_insn_per_tb,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``singlestep [off]``
|
2023-04-18 00:40:39 +08:00
|
|
|
This is a deprecated synonym for the one-insn-per-tb command.
|
2020-02-28 23:36:06 +08:00
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
2021-10-30 17:49:37 +08:00
|
|
|
.name = "stop|s",
|
2009-10-08 00:41:50 +08:00
|
|
|
.args_type = "",
|
|
|
|
.params = "",
|
|
|
|
.help = "stop emulation",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_stop,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
2021-10-30 17:49:37 +08:00
|
|
|
``stop`` or ``s``
|
2020-02-28 23:36:06 +08:00
|
|
|
Stop emulation.
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
2020-11-21 23:17:11 +08:00
|
|
|
.name = "cont|c",
|
2009-10-08 00:41:50 +08:00
|
|
|
.args_type = "",
|
|
|
|
.params = "",
|
|
|
|
.help = "resume emulation",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_cont,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
2020-11-21 23:17:11 +08:00
|
|
|
``cont`` or ``c``
|
2020-02-28 23:36:06 +08:00
|
|
|
Resume emulation.
|
|
|
|
ERST
|
2012-02-23 20:45:21 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "system_wakeup",
|
|
|
|
.args_type = "",
|
|
|
|
.params = "",
|
|
|
|
.help = "wakeup guest from suspend",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_system_wakeup,
|
2012-02-23 20:45:21 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``system_wakeup``
|
|
|
|
Wakeup guest from suspend.
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "gdbserver",
|
|
|
|
.args_type = "device:s?",
|
|
|
|
.params = "[device]",
|
|
|
|
.help = "start gdbserver on given device (default 'tcp::1234'), stop with 'none'",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_gdbserver,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``gdbserver`` [*port*]
|
|
|
|
Start gdbserver session (default *port*\=1234)
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "x",
|
|
|
|
.args_type = "fmt:/,addr:l",
|
|
|
|
.params = "/fmt addr",
|
|
|
|
.help = "virtual memory dump starting at 'addr'",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_memory_dump,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``x/``\ *fmt* *addr*
|
|
|
|
Virtual memory dump starting at *addr*.
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "xp",
|
|
|
|
.args_type = "fmt:/,addr:l",
|
|
|
|
.params = "/fmt addr",
|
|
|
|
.help = "physical memory dump starting at 'addr'",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_physical_memory_dump,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``xp /``\ *fmt* *addr*
|
|
|
|
Physical memory dump starting at *addr*.
|
|
|
|
|
|
|
|
*fmt* is a format which tells the command how to format the
|
|
|
|
data. Its syntax is: ``/{count}{format}{size}``
|
|
|
|
|
|
|
|
*count*
|
|
|
|
is the number of items to be dumped.
|
|
|
|
*format*
|
|
|
|
can be x (hex), d (signed decimal), u (unsigned decimal), o (octal),
|
|
|
|
c (char) or i (asm instruction).
|
|
|
|
*size*
|
|
|
|
can be b (8 bits), h (16 bits), w (32 bits) or g (64 bits). On x86,
|
|
|
|
``h`` or ``w`` can be specified with the ``i`` format to
|
|
|
|
respectively select 16 or 32 bit code instruction size.
|
|
|
|
|
|
|
|
Examples:
|
|
|
|
|
|
|
|
Dump 10 instructions at the current instruction pointer::
|
|
|
|
|
|
|
|
(qemu) x/10i $eip
|
|
|
|
0x90107063: ret
|
|
|
|
0x90107064: sti
|
|
|
|
0x90107065: lea 0x0(%esi,1),%esi
|
|
|
|
0x90107069: lea 0x0(%edi,1),%edi
|
|
|
|
0x90107070: ret
|
|
|
|
0x90107071: jmp 0x90107080
|
|
|
|
0x90107073: nop
|
|
|
|
0x90107074: nop
|
|
|
|
0x90107075: nop
|
|
|
|
0x90107076: nop
|
|
|
|
|
|
|
|
Dump 80 16 bit values at the start of the video memory::
|
|
|
|
|
|
|
|
(qemu) xp/80hx 0xb8000
|
|
|
|
0x000b8000: 0x0b50 0x0b6c 0x0b65 0x0b78 0x0b38 0x0b36 0x0b2f 0x0b42
|
|
|
|
0x000b8010: 0x0b6f 0x0b63 0x0b68 0x0b73 0x0b20 0x0b56 0x0b47 0x0b41
|
|
|
|
0x000b8020: 0x0b42 0x0b69 0x0b6f 0x0b73 0x0b20 0x0b63 0x0b75 0x0b72
|
|
|
|
0x000b8030: 0x0b72 0x0b65 0x0b6e 0x0b74 0x0b2d 0x0b63 0x0b76 0x0b73
|
|
|
|
0x000b8040: 0x0b20 0x0b30 0x0b35 0x0b20 0x0b4e 0x0b6f 0x0b76 0x0b20
|
|
|
|
0x000b8050: 0x0b32 0x0b30 0x0b30 0x0b33 0x0720 0x0720 0x0720 0x0720
|
|
|
|
0x000b8060: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
|
|
|
|
0x000b8070: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
|
|
|
|
0x000b8080: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
|
|
|
|
0x000b8090: 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720 0x0720
|
|
|
|
|
|
|
|
ERST
|
2017-04-20 21:30:58 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "gpa2hva",
|
|
|
|
.args_type = "addr:l",
|
|
|
|
.params = "addr",
|
|
|
|
.help = "print the host virtual address corresponding to a guest physical address",
|
|
|
|
.cmd = hmp_gpa2hva,
|
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``gpa2hva`` *addr*
|
|
|
|
Print the host virtual address at which the guest's physical address *addr*
|
|
|
|
is mapped.
|
|
|
|
ERST
|
2017-04-20 21:30:58 +08:00
|
|
|
|
|
|
|
#ifdef CONFIG_LINUX
|
|
|
|
{
|
|
|
|
.name = "gpa2hpa",
|
|
|
|
.args_type = "addr:l",
|
|
|
|
.params = "addr",
|
|
|
|
.help = "print the host physical address corresponding to a guest physical address",
|
|
|
|
.cmd = hmp_gpa2hpa,
|
|
|
|
},
|
|
|
|
#endif
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``gpa2hpa`` *addr*
|
|
|
|
Print the host physical address at which the guest's physical address *addr*
|
|
|
|
is mapped.
|
|
|
|
ERST
|
2019-04-12 23:26:52 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "gva2gpa",
|
|
|
|
.args_type = "addr:l",
|
|
|
|
.params = "addr",
|
|
|
|
.help = "print the guest physical address corresponding to a guest virtual address",
|
|
|
|
.cmd = hmp_gva2gpa,
|
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``gva2gpa`` *addr*
|
|
|
|
Print the guest physical address at which the guest's virtual address *addr*
|
|
|
|
is mapped based on the mapping for the current CPU.
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
2020-11-21 23:17:11 +08:00
|
|
|
.name = "print|p",
|
2009-10-08 00:41:50 +08:00
|
|
|
.args_type = "fmt:/,val:l",
|
|
|
|
.params = "/fmt expr",
|
|
|
|
.help = "print expression value (use $reg for CPU register access)",
|
2023-01-24 20:19:43 +08:00
|
|
|
.cmd = hmp_print,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
2020-11-21 23:17:11 +08:00
|
|
|
``print`` or ``p/``\ *fmt* *expr*
|
2020-02-28 23:36:06 +08:00
|
|
|
Print expression value. Only the *format* part of *fmt* is
|
|
|
|
used.
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "i",
|
|
|
|
.args_type = "fmt:/,addr:i,index:i.",
|
|
|
|
.params = "/fmt addr",
|
|
|
|
.help = "I/O port read",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_ioport_read,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``i/``\ *fmt* *addr* [.\ *index*\ ]
|
|
|
|
Read I/O port.
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "o",
|
|
|
|
.args_type = "fmt:/,addr:i,val:i",
|
|
|
|
.params = "/fmt addr value",
|
|
|
|
.help = "I/O port write",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_ioport_write,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``o/``\ *fmt* *addr* *val*
|
|
|
|
Write to I/O port.
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "sendkey",
|
2012-08-31 10:56:22 +08:00
|
|
|
.args_type = "keys:s,hold-time:i?",
|
2009-10-08 00:41:50 +08:00
|
|
|
.params = "keys [hold_ms]",
|
|
|
|
.help = "send keys to the VM (e.g. 'sendkey ctrl-alt-f1', default hold time=100 ms)",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_sendkey,
|
2014-05-08 06:41:27 +08:00
|
|
|
.command_completion = sendkey_completion,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``sendkey`` *keys*
|
|
|
|
Send *keys* to the guest. *keys* could be the name of the
|
|
|
|
key or the raw value in hexadecimal format. Use ``-`` to press
|
|
|
|
several keys simultaneously. Example::
|
|
|
|
|
|
|
|
sendkey ctrl-alt-f1
|
|
|
|
|
|
|
|
This command is useful to send keys that your graphical user interface
|
|
|
|
intercepts at low level, such as ``ctrl-alt-f1`` in X Window.
|
|
|
|
ERST
|
2018-08-16 04:00:03 +08:00
|
|
|
{
|
|
|
|
.name = "sync-profile",
|
|
|
|
.args_type = "op:s?",
|
|
|
|
.params = "[on|off|reset]",
|
|
|
|
.help = "enable, disable or reset synchronization profiling. "
|
|
|
|
"With no arguments, prints whether profiling is on or off.",
|
|
|
|
.cmd = hmp_sync_profile,
|
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``sync-profile [on|off|reset]``
|
|
|
|
Enable, disable or reset synchronization profiling. With no arguments, prints
|
|
|
|
whether profiling is on or off.
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "system_reset",
|
|
|
|
.args_type = "",
|
|
|
|
.params = "",
|
|
|
|
.help = "reset the system",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_system_reset,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``system_reset``
|
|
|
|
Reset the system.
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "system_powerdown",
|
|
|
|
.args_type = "",
|
|
|
|
.params = "",
|
|
|
|
.help = "send system power down event",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_system_powerdown,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``system_powerdown``
|
|
|
|
Power down the system (if supported).
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "sum",
|
|
|
|
.args_type = "start:i,size:i",
|
|
|
|
.params = "addr size",
|
|
|
|
.help = "compute the checksum of a memory region",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_sum,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``sum`` *addr* *size*
|
|
|
|
Compute the checksum of a memory region.
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "device_add",
|
2010-02-11 03:47:28 +08:00
|
|
|
.args_type = "device:O",
|
|
|
|
.params = "driver[,prop=value][,...]",
|
2009-10-08 00:41:50 +08:00
|
|
|
.help = "add device, like -device on the command line",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_device_add,
|
2014-04-13 23:25:07 +08:00
|
|
|
.command_completion = device_add_completion,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``device_add`` *config*
|
|
|
|
Add device.
|
|
|
|
ERST
|
2009-09-26 03:42:41 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "device_del",
|
|
|
|
.args_type = "id:s",
|
|
|
|
.params = "device",
|
|
|
|
.help = "remove device",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_device_del,
|
2014-04-13 23:25:07 +08:00
|
|
|
.command_completion = device_del_completion,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``device_del`` *id*
|
|
|
|
Remove device *id*. *id* may be a short ID
|
|
|
|
or a QOM object path.
|
|
|
|
ERST
|
2009-09-26 03:42:41 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "cpu",
|
|
|
|
.args_type = "index:i",
|
|
|
|
.params = "index",
|
|
|
|
.help = "set the default CPU",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_cpu,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
2009-09-26 03:42:41 +08:00
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``cpu`` *index*
|
|
|
|
Set the default CPU.
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "mouse_move",
|
|
|
|
.args_type = "dx_str:s,dy_str:s,dz_str:s?",
|
|
|
|
.params = "dx dy [dz]",
|
|
|
|
.help = "send mouse move events",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_mouse_move,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``mouse_move`` *dx* *dy* [*dz*]
|
|
|
|
Move the active mouse to the specified coordinates *dx* *dy*
|
|
|
|
with optional scroll axis *dz*.
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "mouse_button",
|
|
|
|
.args_type = "button_state:i",
|
|
|
|
.params = "state",
|
|
|
|
.help = "change mouse button state (1=L, 2=M, 4=R)",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_mouse_button,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``mouse_button`` *val*
|
|
|
|
Change the active mouse button state *val* (1=L, 2=M, 4=R).
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "mouse_set",
|
|
|
|
.args_type = "index:i",
|
|
|
|
.params = "index",
|
|
|
|
.help = "set which mouse device receives events",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_mouse_set,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``mouse_set`` *index*
|
|
|
|
Set which mouse device receives events at given *index*, index
|
|
|
|
can be obtained with::
|
|
|
|
|
|
|
|
info mice
|
|
|
|
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "wavcapture",
|
2019-08-19 07:06:48 +08:00
|
|
|
.args_type = "path:F,audiodev:s,freq:i?,bits:i?,nchannels:i?",
|
|
|
|
.params = "path audiodev [frequency [bits [channels]]]",
|
2009-10-08 00:41:50 +08:00
|
|
|
.help = "capture audio to a wave file (default frequency=44100 bits=16 channels=2)",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_wavcapture,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``wavcapture`` *filename* *audiodev* [*frequency* [*bits* [*channels*]]]
|
|
|
|
Capture audio into *filename* from *audiodev*, using sample rate
|
|
|
|
*frequency* bits per sample *bits* and number of channels
|
|
|
|
*channels*.
|
|
|
|
|
|
|
|
Defaults:
|
|
|
|
|
|
|
|
- Sample rate = 44100 Hz - CD quality
|
|
|
|
- Bits = 16
|
|
|
|
- Number of channels = 2 - Stereo
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "stopcapture",
|
|
|
|
.args_type = "n:i",
|
|
|
|
.params = "capture index",
|
|
|
|
.help = "stop capture",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_stopcapture,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``stopcapture`` *index*
|
|
|
|
Stop capture with a given *index*, index can be obtained with::
|
|
|
|
|
|
|
|
info capture
|
|
|
|
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "memsave",
|
|
|
|
.args_type = "val:l,size:i,filename:s",
|
|
|
|
.params = "addr size file",
|
|
|
|
.help = "save to disk virtual memory dump starting at 'addr' of size 'size'",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_memsave,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``memsave`` *addr* *size* *file*
|
|
|
|
save to disk virtual memory dump starting at *addr* of size *size*.
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "pmemsave",
|
|
|
|
.args_type = "val:l,size:i,filename:s",
|
|
|
|
.params = "addr size file",
|
|
|
|
.help = "save to disk physical memory dump starting at 'addr' of size 'size'",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_pmemsave,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``pmemsave`` *addr* *size* *file*
|
|
|
|
save to disk physical memory dump starting at *addr* of size *size*.
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "boot_set",
|
|
|
|
.args_type = "bootdevice:s",
|
|
|
|
.params = "bootdevice",
|
|
|
|
.help = "define new values for the boot device list",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_boot_set,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``boot_set`` *bootdevicelist*
|
|
|
|
Define new values for the boot device list. Those values will override
|
|
|
|
the values specified on the command line through the ``-boot`` option.
|
|
|
|
|
|
|
|
The values that can be specified here depend on the machine type, but are
|
|
|
|
the same that can be specified in the ``-boot`` command line option.
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "nmi",
|
2011-04-29 23:11:50 +08:00
|
|
|
.args_type = "",
|
|
|
|
.params = "",
|
2014-08-20 20:16:33 +08:00
|
|
|
.help = "inject an NMI",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_nmi,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``nmi`` *cpu*
|
|
|
|
Inject an NMI on the default CPU (x86/s390) or all CPUs (ppc64).
|
|
|
|
ERST
|
2013-01-25 00:03:20 +08:00
|
|
|
|
|
|
|
{
|
qemu-char: Saner naming of memchar stuff & doc fixes
New device, has never been released, so we can still improve things
without worrying about compatibility.
Naming is a mess. The code calls the device driver CirMemCharDriver,
the public API calls it "memory", "memchardev", or "memchar", and the
special commands are named like "memchar-FOO". "memory" is a
particularly unfortunate choice, because there's another character
device driver called MemoryDriver. Moreover, the device's distinctive
property is that it's a ring buffer, not that's in memory. Therefore:
* Rename CirMemCharDriver to RingBufCharDriver, and call the thing a
"ringbuf" in the API.
* Rename QMP and HMP commands from memchar-FOO to ringbuf-FOO.
* Rename device parameter from maxcapacity to size (simple words are
good for you).
* Clearly mark the parameter as optional in documentation.
* Fix error reporting so that chardev-add reports to current monitor,
not stderr.
* Replace cirmem in C identifiers by ringbuf.
* Rework documentation. Document the impact of our crappy UTF-8
handling on reading.
* QMP examples that even work.
I could split this up into multiple commits, but they'd change the
same documentation lines multiple times. Not worth it.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2013-02-07 04:27:24 +08:00
|
|
|
.name = "ringbuf_write",
|
2013-01-25 00:03:20 +08:00
|
|
|
.args_type = "device:s,data:s",
|
|
|
|
.params = "device data",
|
qemu-char: Saner naming of memchar stuff & doc fixes
New device, has never been released, so we can still improve things
without worrying about compatibility.
Naming is a mess. The code calls the device driver CirMemCharDriver,
the public API calls it "memory", "memchardev", or "memchar", and the
special commands are named like "memchar-FOO". "memory" is a
particularly unfortunate choice, because there's another character
device driver called MemoryDriver. Moreover, the device's distinctive
property is that it's a ring buffer, not that's in memory. Therefore:
* Rename CirMemCharDriver to RingBufCharDriver, and call the thing a
"ringbuf" in the API.
* Rename QMP and HMP commands from memchar-FOO to ringbuf-FOO.
* Rename device parameter from maxcapacity to size (simple words are
good for you).
* Clearly mark the parameter as optional in documentation.
* Fix error reporting so that chardev-add reports to current monitor,
not stderr.
* Replace cirmem in C identifiers by ringbuf.
* Rework documentation. Document the impact of our crappy UTF-8
handling on reading.
* QMP examples that even work.
I could split this up into multiple commits, but they'd change the
same documentation lines multiple times. Not worth it.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2013-02-07 04:27:24 +08:00
|
|
|
.help = "Write to a ring buffer character device",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_ringbuf_write,
|
2014-05-28 06:39:30 +08:00
|
|
|
.command_completion = ringbuf_write_completion,
|
2013-01-25 00:03:20 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``ringbuf_write`` *device* *data*
|
|
|
|
Write *data* to ring buffer character device *device*.
|
|
|
|
*data* must be a UTF-8 string.
|
|
|
|
ERST
|
2013-01-25 00:03:21 +08:00
|
|
|
|
|
|
|
{
|
qemu-char: Saner naming of memchar stuff & doc fixes
New device, has never been released, so we can still improve things
without worrying about compatibility.
Naming is a mess. The code calls the device driver CirMemCharDriver,
the public API calls it "memory", "memchardev", or "memchar", and the
special commands are named like "memchar-FOO". "memory" is a
particularly unfortunate choice, because there's another character
device driver called MemoryDriver. Moreover, the device's distinctive
property is that it's a ring buffer, not that's in memory. Therefore:
* Rename CirMemCharDriver to RingBufCharDriver, and call the thing a
"ringbuf" in the API.
* Rename QMP and HMP commands from memchar-FOO to ringbuf-FOO.
* Rename device parameter from maxcapacity to size (simple words are
good for you).
* Clearly mark the parameter as optional in documentation.
* Fix error reporting so that chardev-add reports to current monitor,
not stderr.
* Replace cirmem in C identifiers by ringbuf.
* Rework documentation. Document the impact of our crappy UTF-8
handling on reading.
* QMP examples that even work.
I could split this up into multiple commits, but they'd change the
same documentation lines multiple times. Not worth it.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2013-02-07 04:27:24 +08:00
|
|
|
.name = "ringbuf_read",
|
2013-01-25 00:03:21 +08:00
|
|
|
.args_type = "device:s,size:i",
|
|
|
|
.params = "device size",
|
qemu-char: Saner naming of memchar stuff & doc fixes
New device, has never been released, so we can still improve things
without worrying about compatibility.
Naming is a mess. The code calls the device driver CirMemCharDriver,
the public API calls it "memory", "memchardev", or "memchar", and the
special commands are named like "memchar-FOO". "memory" is a
particularly unfortunate choice, because there's another character
device driver called MemoryDriver. Moreover, the device's distinctive
property is that it's a ring buffer, not that's in memory. Therefore:
* Rename CirMemCharDriver to RingBufCharDriver, and call the thing a
"ringbuf" in the API.
* Rename QMP and HMP commands from memchar-FOO to ringbuf-FOO.
* Rename device parameter from maxcapacity to size (simple words are
good for you).
* Clearly mark the parameter as optional in documentation.
* Fix error reporting so that chardev-add reports to current monitor,
not stderr.
* Replace cirmem in C identifiers by ringbuf.
* Rework documentation. Document the impact of our crappy UTF-8
handling on reading.
* QMP examples that even work.
I could split this up into multiple commits, but they'd change the
same documentation lines multiple times. Not worth it.
Signed-off-by: Markus Armbruster <armbru@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2013-02-07 04:27:24 +08:00
|
|
|
.help = "Read from a ring buffer character device",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_ringbuf_read,
|
2014-05-28 06:39:30 +08:00
|
|
|
.command_completion = ringbuf_write_completion,
|
2013-01-25 00:03:21 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``ringbuf_read`` *device*
|
|
|
|
Read and print up to *size* bytes from ring buffer character
|
|
|
|
device *device*.
|
|
|
|
Certain non-printable characters are printed ``\uXXXX``, where ``XXXX`` is the
|
|
|
|
character code in hexadecimal. Character ``\`` is printed ``\\``.
|
|
|
|
Bug: can screw up when the buffer contains invalid UTF-8 sequences,
|
|
|
|
NUL characters, after the ring buffer lost data, and when reading
|
|
|
|
stops because the size limit is reached.
|
|
|
|
ERST
|
2019-02-27 21:24:12 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "announce_self",
|
2019-06-21 02:47:05 +08:00
|
|
|
.args_type = "interfaces:s?,id:s?",
|
|
|
|
.params = "[interfaces] [id]",
|
2019-02-27 21:24:12 +08:00
|
|
|
.help = "Trigger GARP/RARP announcements",
|
|
|
|
.cmd = hmp_announce_self,
|
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``announce_self``
|
|
|
|
Trigger a round of GARP/RARP broadcasts; this is useful for explicitly
|
|
|
|
updating the network infrastructure after a reconfiguration or some forms
|
|
|
|
of migration. The timings of the round are set by the migration announce
|
|
|
|
parameters. An optional comma separated *interfaces* list restricts the
|
|
|
|
announce to the named set of interfaces. An optional *id* can be used to
|
|
|
|
start a separate announce timer and to change the parameters of it later.
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "migrate",
|
2018-05-02 18:47:23 +08:00
|
|
|
.args_type = "detach:-d,blk:-b,inc:-i,resume:-r,uri:s",
|
|
|
|
.params = "[-d] [-b] [-i] [-r] uri",
|
2009-11-02 21:41:13 +08:00
|
|
|
.help = "migrate to URI (using -d to not wait for completion)"
|
|
|
|
"\n\t\t\t -b for migration without shared storage with"
|
|
|
|
" full copy of disk\n\t\t\t -i for migration without "
|
|
|
|
"shared storage with incremental copy of disk "
|
2018-05-02 18:47:23 +08:00
|
|
|
"(base image shared between src and destination)"
|
|
|
|
"\n\t\t\t -r to resume a paused migration",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_migrate,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-11-02 21:41:13 +08:00
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``migrate [-d] [-b] [-i]`` *uri*
|
|
|
|
Migrate to *uri* (using -d to not wait for completion).
|
|
|
|
|
|
|
|
``-b``
|
|
|
|
for migration with full copy of disk
|
|
|
|
``-i``
|
|
|
|
for migration with incremental copy of disk (base image is shared)
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "migrate_cancel",
|
|
|
|
.args_type = "",
|
|
|
|
.params = "",
|
|
|
|
.help = "cancel the current VM migration",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_migrate_cancel,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``migrate_cancel``
|
|
|
|
Cancel the current VM migration.
|
|
|
|
ERST
|
2012-08-07 02:42:54 +08:00
|
|
|
|
2017-10-20 17:05:54 +08:00
|
|
|
{
|
|
|
|
.name = "migrate_continue",
|
|
|
|
.args_type = "state:s",
|
|
|
|
.params = "state",
|
|
|
|
.help = "Continue migration from the given paused state",
|
|
|
|
.cmd = hmp_migrate_continue,
|
|
|
|
},
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``migrate_continue`` *state*
|
|
|
|
Continue migration from the paused state *state*
|
|
|
|
ERST
|
2015-02-19 19:40:28 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "migrate_incoming",
|
|
|
|
.args_type = "uri:s",
|
|
|
|
.params = "uri",
|
|
|
|
.help = "Continue an incoming migration from an -incoming defer",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_migrate_incoming,
|
2015-02-19 19:40:28 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``migrate_incoming`` *uri*
|
|
|
|
Continue an incoming migration using the *uri* (that has the same syntax
|
|
|
|
as the ``-incoming`` option).
|
|
|
|
ERST
|
2015-02-19 19:40:28 +08:00
|
|
|
|
2018-05-02 18:47:37 +08:00
|
|
|
{
|
|
|
|
.name = "migrate_recover",
|
|
|
|
.args_type = "uri:s",
|
|
|
|
.params = "uri",
|
|
|
|
.help = "Continue a paused incoming postcopy migration",
|
|
|
|
.cmd = hmp_migrate_recover,
|
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``migrate_recover`` *uri*
|
|
|
|
Continue a paused incoming postcopy migration using the *uri*.
|
|
|
|
ERST
|
2018-05-02 18:47:40 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "migrate_pause",
|
|
|
|
.args_type = "",
|
|
|
|
.params = "",
|
|
|
|
.help = "Pause an ongoing migration (postcopy-only)",
|
|
|
|
.cmd = hmp_migrate_pause,
|
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``migrate_pause``
|
|
|
|
Pause an ongoing migration. Currently it only supports postcopy.
|
|
|
|
ERST
|
2012-08-07 02:42:54 +08:00
|
|
|
|
2012-08-07 02:42:48 +08:00
|
|
|
{
|
|
|
|
.name = "migrate_set_capability",
|
|
|
|
.args_type = "capability:s,state:b",
|
|
|
|
.params = "capability state",
|
|
|
|
.help = "Enable/Disable the usage of a capability for migration",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_migrate_set_capability,
|
2014-05-28 06:39:32 +08:00
|
|
|
.command_completion = migrate_set_capability_completion,
|
2012-08-07 02:42:48 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``migrate_set_capability`` *capability* *state*
|
|
|
|
Enable/Disable the usage of a capability *capability* for migration.
|
|
|
|
ERST
|
2015-03-23 16:32:29 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "migrate_set_parameter",
|
2016-04-27 18:05:15 +08:00
|
|
|
.args_type = "parameter:s,value:s",
|
2015-03-23 16:32:29 +08:00
|
|
|
.params = "parameter value",
|
|
|
|
.help = "Set the parameter for migration",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_migrate_set_parameter,
|
2015-03-23 16:32:29 +08:00
|
|
|
.command_completion = migrate_set_parameter_completion,
|
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``migrate_set_parameter`` *parameter* *value*
|
|
|
|
Set the parameter *parameter* for migration.
|
|
|
|
ERST
|
2015-11-06 02:10:56 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "migrate_start_postcopy",
|
|
|
|
.args_type = "",
|
|
|
|
.params = "",
|
2015-11-12 19:34:44 +08:00
|
|
|
.help = "Followup to a migration command to switch the migration"
|
2016-03-11 17:53:36 +08:00
|
|
|
" to postcopy mode. The postcopy-ram capability must "
|
2018-02-07 23:41:43 +08:00
|
|
|
"be set on both source and destination before the "
|
|
|
|
"original migration command .",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_migrate_start_postcopy,
|
2015-11-06 02:10:56 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``migrate_start_postcopy``
|
|
|
|
Switch in-progress migration to postcopy mode. Ignored after the end of
|
|
|
|
migration (or once already in postcopy).
|
|
|
|
ERST
|
COLO: Add 'x-colo-lost-heartbeat' command to trigger failover
We leave users to choose whatever heartbeat solution they want,
if the heartbeat is lost, or other errors they detect, they can use
experimental command 'x_colo_lost_heartbeat' to tell COLO to do failover,
COLO will do operations accordingly.
For example, if the command is sent to the Primary side,
the Primary side will exit COLO mode, does cleanup work,
and then, PVM will take over the service work. If sent to the Secondary side,
the Secondary side will run failover work, then takes over PVM's service work.
Cc: Luiz Capitulino <lcapitulino@redhat.com>
Cc: Eric Blake <eblake@redhat.com>
Cc: Markus Armbruster <armbru@redhat.com>
Signed-off-by: zhanghailiang <zhang.zhanghailiang@huawei.com>
Signed-off-by: Li Zhijian <lizhijian@cn.fujitsu.com>
Reviewed-by: Dr. David Alan Gilbert <dgilbert@redhat.com>
Reviewed-by: Amit Shah <amit.shah@redhat.com>
Signed-off-by: Amit Shah <amit@amitshah.net>
2016-10-27 14:43:03 +08:00
|
|
|
|
2023-04-29 03:49:21 +08:00
|
|
|
#ifdef CONFIG_REPLICATION
|
COLO: Add 'x-colo-lost-heartbeat' command to trigger failover
We leave users to choose whatever heartbeat solution they want,
if the heartbeat is lost, or other errors they detect, they can use
experimental command 'x_colo_lost_heartbeat' to tell COLO to do failover,
COLO will do operations accordingly.
For example, if the command is sent to the Primary side,
the Primary side will exit COLO mode, does cleanup work,
and then, PVM will take over the service work. If sent to the Secondary side,
the Secondary side will run failover work, then takes over PVM's service work.
Cc: Luiz Capitulino <lcapitulino@redhat.com>
Cc: Eric Blake <eblake@redhat.com>
Cc: Markus Armbruster <armbru@redhat.com>
Signed-off-by: zhanghailiang <zhang.zhanghailiang@huawei.com>
Signed-off-by: Li Zhijian <lizhijian@cn.fujitsu.com>
Reviewed-by: Dr. David Alan Gilbert <dgilbert@redhat.com>
Reviewed-by: Amit Shah <amit.shah@redhat.com>
Signed-off-by: Amit Shah <amit@amitshah.net>
2016-10-27 14:43:03 +08:00
|
|
|
{
|
|
|
|
.name = "x_colo_lost_heartbeat",
|
|
|
|
.args_type = "",
|
|
|
|
.params = "",
|
|
|
|
.help = "Tell COLO that heartbeat is lost,\n\t\t\t"
|
|
|
|
"a failover or takeover is needed.",
|
|
|
|
.cmd = hmp_x_colo_lost_heartbeat,
|
|
|
|
},
|
2023-04-29 03:49:21 +08:00
|
|
|
#endif
|
COLO: Add 'x-colo-lost-heartbeat' command to trigger failover
We leave users to choose whatever heartbeat solution they want,
if the heartbeat is lost, or other errors they detect, they can use
experimental command 'x_colo_lost_heartbeat' to tell COLO to do failover,
COLO will do operations accordingly.
For example, if the command is sent to the Primary side,
the Primary side will exit COLO mode, does cleanup work,
and then, PVM will take over the service work. If sent to the Secondary side,
the Secondary side will run failover work, then takes over PVM's service work.
Cc: Luiz Capitulino <lcapitulino@redhat.com>
Cc: Eric Blake <eblake@redhat.com>
Cc: Markus Armbruster <armbru@redhat.com>
Signed-off-by: zhanghailiang <zhang.zhanghailiang@huawei.com>
Signed-off-by: Li Zhijian <lizhijian@cn.fujitsu.com>
Reviewed-by: Dr. David Alan Gilbert <dgilbert@redhat.com>
Reviewed-by: Amit Shah <amit.shah@redhat.com>
Signed-off-by: Amit Shah <amit@amitshah.net>
2016-10-27 14:43:03 +08:00
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``x_colo_lost_heartbeat``
|
|
|
|
Tell COLO that heartbeat is lost, a failover or takeover is needed.
|
|
|
|
ERST
|
2010-12-16 20:52:16 +08:00
|
|
|
|
|
|
|
{
|
2011-03-09 23:54:34 +08:00
|
|
|
.name = "client_migrate_info",
|
|
|
|
.args_type = "protocol:s,hostname:s,port:i?,tls-port:i?,cert-subject:s?",
|
|
|
|
.params = "protocol hostname port tls-port cert-subject",
|
2015-03-06 02:16:58 +08:00
|
|
|
.help = "set migration information for remote display",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_client_migrate_info,
|
2010-12-16 20:52:16 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``client_migrate_info`` *protocol* *hostname* *port* *tls-port* *cert-subject*
|
|
|
|
Set migration information for remote display. This makes the server
|
|
|
|
ask the client to automatically reconnect using the new parameters
|
|
|
|
once migration finished successfully. Only implemented for SPICE.
|
|
|
|
ERST
|
2010-04-23 19:28:21 +08:00
|
|
|
|
2012-05-07 12:10:47 +08:00
|
|
|
{
|
|
|
|
.name = "dump-guest-memory",
|
2023-09-19 07:32:33 +08:00
|
|
|
.args_type = "paging:-p,detach:-d,windmp:-w,zlib:-z,lzo:-l,snappy:-s,raw:-R,filename:F,begin:l?,length:l?",
|
|
|
|
.params = "[-p] [-d] [-z|-l|-s|-w] [-R] filename [begin length]",
|
2014-04-17 16:15:06 +08:00
|
|
|
.help = "dump guest memory into file 'filename'.\n\t\t\t"
|
|
|
|
"-p: do paging to get guest's memory mapping.\n\t\t\t"
|
2016-02-18 13:16:47 +08:00
|
|
|
"-d: return immediately (do not wait for completion).\n\t\t\t"
|
2014-04-17 16:15:07 +08:00
|
|
|
"-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
|
|
|
|
"-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
|
|
|
|
"-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
|
2023-09-19 07:32:33 +08:00
|
|
|
"-R: when using kdump (-z, -l, -s), use raw rather than makedumpfile-flattened\n\t\t\t"
|
|
|
|
" format\n\t\t\t"
|
2018-05-18 00:23:39 +08:00
|
|
|
"-w: dump in Windows crashdump format (can be used instead of ELF-dump converting),\n\t\t\t"
|
2022-04-07 01:15:58 +08:00
|
|
|
" for Windows x86 and x64 guests with vmcoreinfo driver only.\n\t\t\t"
|
2014-04-17 16:15:06 +08:00
|
|
|
"begin: the starting physical address.\n\t\t\t"
|
|
|
|
"length: the memory size, in bytes.",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_dump_guest_memory,
|
2012-05-07 12:10:47 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``dump-guest-memory [-p]`` *filename* *begin* *length*
|
|
|
|
\
|
|
|
|
``dump-guest-memory [-z|-l|-s|-w]`` *filename*
|
|
|
|
Dump guest memory to *protocol*. The file can be processed with crash or
|
|
|
|
gdb. Without ``-z|-l|-s|-w``, the dump format is ELF.
|
|
|
|
|
|
|
|
``-p``
|
|
|
|
do paging to get guest's memory mapping.
|
|
|
|
``-z``
|
|
|
|
dump in kdump-compressed format, with zlib compression.
|
|
|
|
``-l``
|
|
|
|
dump in kdump-compressed format, with lzo compression.
|
|
|
|
``-s``
|
|
|
|
dump in kdump-compressed format, with snappy compression.
|
2023-09-19 07:32:33 +08:00
|
|
|
``-R``
|
|
|
|
when using kdump (-z, -l, -s), use raw rather than makedumpfile-flattened
|
|
|
|
format
|
2020-02-28 23:36:06 +08:00
|
|
|
``-w``
|
|
|
|
dump in Windows crashdump format (can be used instead of ELF-dump converting),
|
|
|
|
for Windows x64 guests with vmcoreinfo driver only
|
|
|
|
*filename*
|
|
|
|
dump file name.
|
|
|
|
*begin*
|
|
|
|
the starting physical address. It's optional, and should be
|
|
|
|
specified together with *length*.
|
|
|
|
*length*
|
|
|
|
the memory size, in bytes. It's optional, and should be specified
|
|
|
|
together with *begin*.
|
|
|
|
|
|
|
|
ERST
|
2012-05-07 12:10:47 +08:00
|
|
|
|
2015-06-27 02:07:21 +08:00
|
|
|
#if defined(TARGET_S390X)
|
|
|
|
{
|
|
|
|
.name = "dump-skeys",
|
|
|
|
.args_type = "filename:F",
|
|
|
|
.params = "",
|
|
|
|
.help = "Save guest storage keys into file 'filename'.\n",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_dump_skeys,
|
2015-06-27 02:07:21 +08:00
|
|
|
},
|
|
|
|
#endif
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``dump-skeys`` *filename*
|
|
|
|
Save guest storage keys to a file.
|
|
|
|
ERST
|
2016-08-16 00:44:04 +08:00
|
|
|
|
|
|
|
#if defined(TARGET_S390X)
|
|
|
|
{
|
|
|
|
.name = "migration_mode",
|
|
|
|
.args_type = "mode:i",
|
|
|
|
.params = "mode",
|
|
|
|
.help = "Enables or disables migration mode\n",
|
|
|
|
.cmd = hmp_migrationmode,
|
|
|
|
},
|
|
|
|
#endif
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``migration_mode`` *mode*
|
|
|
|
Enables or disables migration mode.
|
|
|
|
ERST
|
2015-06-27 02:07:21 +08:00
|
|
|
|
2010-04-23 19:28:21 +08:00
|
|
|
{
|
2011-03-09 23:54:34 +08:00
|
|
|
.name = "snapshot_blkdev",
|
2012-03-07 01:55:59 +08:00
|
|
|
.args_type = "reuse:-n,device:B,snapshot-file:s?,format:s?",
|
|
|
|
.params = "[-n] device [new-image-file] [format]",
|
2011-03-09 23:54:34 +08:00
|
|
|
.help = "initiates a live snapshot\n\t\t\t"
|
|
|
|
"of device. If a new image file is specified, the\n\t\t\t"
|
|
|
|
"new image file will become the new root image.\n\t\t\t"
|
|
|
|
"If format is specified, the snapshot file will\n\t\t\t"
|
2013-09-11 14:04:37 +08:00
|
|
|
"be created in that format.\n\t\t\t"
|
2012-03-07 01:55:59 +08:00
|
|
|
"The default format is qcow2. The -n flag requests QEMU\n\t\t\t"
|
|
|
|
"to reuse the image found in new-image-file, instead of\n\t\t\t"
|
|
|
|
"recreating it from scratch.",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_snapshot_blkdev,
|
2010-04-23 19:28:21 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``snapshot_blkdev``
|
|
|
|
Snapshot device, using snapshot file as target if provided
|
|
|
|
ERST
|
2013-09-11 14:04:37 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "snapshot_blkdev_internal",
|
|
|
|
.args_type = "device:B,name:s",
|
|
|
|
.params = "device name",
|
|
|
|
.help = "take an internal snapshot of device.\n\t\t\t"
|
|
|
|
"The format of the image used by device must\n\t\t\t"
|
|
|
|
"support it, such as qcow2.\n\t\t\t",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_snapshot_blkdev_internal,
|
2013-09-11 14:04:37 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``snapshot_blkdev_internal``
|
|
|
|
Take an internal snapshot on device if it support
|
|
|
|
ERST
|
2013-09-11 14:04:38 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "snapshot_delete_blkdev_internal",
|
|
|
|
.args_type = "device:B,name:s,id:s?",
|
|
|
|
.params = "device name [id]",
|
|
|
|
.help = "delete an internal snapshot of device.\n\t\t\t"
|
|
|
|
"If id is specified, qemu will try delete\n\t\t\t"
|
|
|
|
"the snapshot matching both id and name.\n\t\t\t"
|
|
|
|
"The format of the image used by device must\n\t\t\t"
|
|
|
|
"support it, such as qcow2.\n\t\t\t",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_snapshot_delete_blkdev_internal,
|
2013-09-11 14:04:38 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``snapshot_delete_blkdev_internal``
|
|
|
|
Delete an internal snapshot on device if it support
|
|
|
|
ERST
|
2012-10-18 22:49:24 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "drive_mirror",
|
|
|
|
.args_type = "reuse:-n,full:-f,device:B,target:s,format:s?",
|
|
|
|
.params = "[-n] [-f] device target [format]",
|
|
|
|
.help = "initiates live storage\n\t\t\t"
|
|
|
|
"migration for a device. The device's contents are\n\t\t\t"
|
|
|
|
"copied to the new image file, including data that\n\t\t\t"
|
|
|
|
"is written after the command is started.\n\t\t\t"
|
|
|
|
"The -n flag requests QEMU to reuse the image found\n\t\t\t"
|
|
|
|
"in new-image-file, instead of recreating it from scratch.\n\t\t\t"
|
|
|
|
"The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
|
|
|
|
"so that the result does not need a backing file.\n\t\t\t",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_drive_mirror,
|
2012-10-18 22:49:24 +08:00
|
|
|
},
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``drive_mirror``
|
|
|
|
Start mirroring a block device's writes to a new destination,
|
|
|
|
using the specified target.
|
|
|
|
ERST
|
2013-06-26 20:11:58 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "drive_backup",
|
2016-07-22 16:17:52 +08:00
|
|
|
.args_type = "reuse:-n,full:-f,compress:-c,device:B,target:s,format:s?",
|
|
|
|
.params = "[-n] [-f] [-c] device target [format]",
|
2013-06-26 20:11:58 +08:00
|
|
|
.help = "initiates a point-in-time\n\t\t\t"
|
|
|
|
"copy for a device. The device's contents are\n\t\t\t"
|
|
|
|
"copied to the new image file, excluding data that\n\t\t\t"
|
|
|
|
"is written after the command is started.\n\t\t\t"
|
|
|
|
"The -n flag requests QEMU to reuse the image found\n\t\t\t"
|
|
|
|
"in new-image-file, instead of recreating it from scratch.\n\t\t\t"
|
|
|
|
"The -f flag requests QEMU to copy the whole disk,\n\t\t\t"
|
2016-07-22 16:17:52 +08:00
|
|
|
"so that the result does not need a backing file.\n\t\t\t"
|
|
|
|
"The -c flag requests QEMU to compress backup data\n\t\t\t"
|
|
|
|
"(if the target format supports it).\n\t\t\t",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_drive_backup,
|
2013-06-26 20:11:58 +08:00
|
|
|
},
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``drive_backup``
|
2020-09-17 15:50:20 +08:00
|
|
|
Start a point-in-time copy of a block device to a specified target.
|
2020-02-28 23:36:06 +08:00
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "drive_add",
|
2016-02-24 00:33:24 +08:00
|
|
|
.args_type = "node:-n,pci_addr:s,opts:s",
|
|
|
|
.params = "[-n] [[<domain>:]<bus>:]<slot>\n"
|
2009-10-08 00:41:50 +08:00
|
|
|
"[file=file][,if=type][,bus=n]\n"
|
2011-11-17 21:40:32 +08:00
|
|
|
"[,unit=m][,media=d][,index=i]\n"
|
|
|
|
"[,snapshot=on|off][,cache=on|off]\n"
|
|
|
|
"[,readonly=on|off][,copy-on-read=on|off]",
|
2009-10-08 00:41:50 +08:00
|
|
|
.help = "add drive to PCI storage controller",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_drive_add,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``drive_add``
|
|
|
|
Add drive to PCI storage controller.
|
|
|
|
ERST
|
2010-12-24 11:14:14 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "pcie_aer_inject_error",
|
|
|
|
.args_type = "advisory_non_fatal:-a,correctable:-c,"
|
|
|
|
"id:s,error_status:s,"
|
|
|
|
"header0:i?,header1:i?,header2:i?,header3:i?,"
|
|
|
|
"prefix0:i?,prefix1:i?,prefix2:i?,prefix3:i?",
|
|
|
|
.params = "[-a] [-c] id "
|
|
|
|
"<error_status> [<tlp header> [<tlp header prefix>]]",
|
|
|
|
.help = "inject pcie aer error\n\t\t\t"
|
|
|
|
" -a for advisory non fatal error\n\t\t\t"
|
|
|
|
" -c for correctable error\n\t\t\t"
|
|
|
|
"<id> = qdev device id\n\t\t\t"
|
|
|
|
"<error_status> = error string or 32bit\n\t\t\t"
|
2020-12-04 11:09:53 +08:00
|
|
|
"<tlp header> = 32bit x 4\n\t\t\t"
|
|
|
|
"<tlp header prefix> = 32bit x 4",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_pcie_aer_inject_error,
|
2010-12-24 11:14:14 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``pcie_aer_inject_error``
|
|
|
|
Inject PCIe AER error
|
|
|
|
ERST
|
2010-03-26 00:22:40 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "netdev_add",
|
|
|
|
.args_type = "netdev:O",
|
qapi: net: add stream and dgram netdevs
Copied from socket netdev file and modified to use SocketAddress
to be able to introduce new features like unix socket.
"udp" and "mcast" are squashed into dgram netdev, multicast is detected
according to the IP address type.
"listen" and "connect" modes are managed by stream netdev. An optional
parameter "server" defines the mode (off by default)
The two new types need to be parsed the modern way with -netdev, because
with the traditional way, the "type" field of netdev structure collides with
the "type" field of SocketAddress and prevents the correct evaluation of the
command line option. Moreover the traditional way doesn't allow to use
the same type (SocketAddress) several times with the -netdev option
(needed to specify "local" and "remote" addresses).
The previous commit paved the way for parsing the modern way, but
omitted one detail: how to pick modern vs. traditional, in
netdev_is_modern().
We want to pick based on the value of parameter "type". But how to
extract it from the option argument?
Parsing the option argument, either the modern or the traditional way,
extracts it for us, but only if parsing succeeds.
If parsing fails, there is no good option. No matter which parser we
pick, it'll be the wrong one for some arguments, and the error
reporting will be confusing.
Fortunately, the traditional parser accepts *anything* when called in
a certain way. This maximizes our chance to extract the value of
"type", and in turn minimizes the risk of confusing error reporting.
Signed-off-by: Laurent Vivier <lvivier@redhat.com>
Reviewed-by: Stefano Brivio <sbrivio@redhat.com>
Acked-by: Markus Armbruster <armbru@redhat.com>
Acked-by: Michael S. Tsirkin <mst@redhat.com>
Signed-off-by: Jason Wang <jasowang@redhat.com>
2022-10-21 17:09:11 +08:00
|
|
|
.params = "[user|tap|socket|stream|dgram|vde|bridge|hubport|netmap|vhost-user"
|
net: add initial support for AF_XDP network backend
AF_XDP is a network socket family that allows communication directly
with the network device driver in the kernel, bypassing most or all
of the kernel networking stack. In the essence, the technology is
pretty similar to netmap. But, unlike netmap, AF_XDP is Linux-native
and works with any network interfaces without driver modifications.
Unlike vhost-based backends (kernel, user, vdpa), AF_XDP doesn't
require access to character devices or unix sockets. Only access to
the network interface itself is necessary.
This patch implements a network backend that communicates with the
kernel by creating an AF_XDP socket. A chunk of userspace memory
is shared between QEMU and the host kernel. 4 ring buffers (Tx, Rx,
Fill and Completion) are placed in that memory along with a pool of
memory buffers for the packet data. Data transmission is done by
allocating one of the buffers, copying packet data into it and
placing the pointer into Tx ring. After transmission, device will
return the buffer via Completion ring. On Rx, device will take
a buffer form a pre-populated Fill ring, write the packet data into
it and place the buffer into Rx ring.
AF_XDP network backend takes on the communication with the host
kernel and the network interface and forwards packets to/from the
peer device in QEMU.
Usage example:
-device virtio-net-pci,netdev=guest1,mac=00:16:35:AF:AA:5C
-netdev af-xdp,ifname=ens6f1np1,id=guest1,mode=native,queues=1
XDP program bridges the socket with a network interface. It can be
attached to the interface in 2 different modes:
1. skb - this mode should work for any interface and doesn't require
driver support. With a caveat of lower performance.
2. native - this does require support from the driver and allows to
bypass skb allocation in the kernel and potentially use
zero-copy while getting packets in/out userspace.
By default, QEMU will try to use native mode and fall back to skb.
Mode can be forced via 'mode' option. To force 'copy' even in native
mode, use 'force-copy=on' option. This might be useful if there is
some issue with the driver.
Option 'queues=N' allows to specify how many device queues should
be open. Note that all the queues that are not open are still
functional and can receive traffic, but it will not be delivered to
QEMU. So, the number of device queues should generally match the
QEMU configuration, unless the device is shared with something
else and the traffic re-direction to appropriate queues is correctly
configured on a device level (e.g. with ethtool -N).
'start-queue=M' option can be used to specify from which queue id
QEMU should start configuring 'N' queues. It might also be necessary
to use this option with certain NICs, e.g. MLX5 NICs. See the docs
for examples.
In a general case QEMU will need CAP_NET_ADMIN and CAP_SYS_ADMIN
or CAP_BPF capabilities in order to load default XSK/XDP programs to
the network interface and configure BPF maps. It is possible, however,
to run with no capabilities. For that to work, an external process
with enough capabilities will need to pre-load default XSK program,
create AF_XDP sockets and pass their file descriptors to QEMU process
on startup via 'sock-fds' option. Network backend will need to be
configured with 'inhibit=on' to avoid loading of the program.
QEMU will need 32 MB of locked memory (RLIMIT_MEMLOCK) per queue
or CAP_IPC_LOCK.
There are few performance challenges with the current network backends.
First is that they do not support IO threads. This means that data
path is handled by the main thread in QEMU and may slow down other
work or may be slowed down by some other work. This also means that
taking advantage of multi-queue is generally not possible today.
Another thing is that data path is going through the device emulation
code, which is not really optimized for performance. The fastest
"frontend" device is virtio-net. But it's not optimized for heavy
traffic either, because it expects such use-cases to be handled via
some implementation of vhost (user, kernel, vdpa). In practice, we
have virtio notifications and rcu lock/unlock on a per-packet basis
and not very efficient accesses to the guest memory. Communication
channels between backend and frontend devices do not allow passing
more than one packet at a time as well.
Some of these challenges can be avoided in the future by adding better
batching into device emulation or by implementing vhost-af-xdp variant.
There are also a few kernel limitations. AF_XDP sockets do not
support any kinds of checksum or segmentation offloading. Buffers
are limited to a page size (4K), i.e. MTU is limited. Multi-buffer
support implementation for AF_XDP is in progress, but not ready yet.
Also, transmission in all non-zero-copy modes is synchronous, i.e.
done in a syscall. That doesn't allow high packet rates on virtual
interfaces.
However, keeping in mind all of these challenges, current implementation
of the AF_XDP backend shows a decent performance while running on top
of a physical NIC with zero-copy support.
Test setup:
2 VMs running on 2 physical hosts connected via ConnectX6-Dx card.
Network backend is configured to open the NIC directly in native mode.
The driver supports zero-copy. NIC is configured to use 1 queue.
Inside a VM - iperf3 for basic TCP performance testing and dpdk-testpmd
for PPS testing.
iperf3 result:
TCP stream : 19.1 Gbps
dpdk-testpmd (single queue, single CPU core, 64 B packets) results:
Tx only : 3.4 Mpps
Rx only : 2.0 Mpps
L2 FWD Loopback : 1.5 Mpps
In skb mode the same setup shows much lower performance, similar to
the setup where pair of physical NICs is replaced with veth pair:
iperf3 result:
TCP stream : 9 Gbps
dpdk-testpmd (single queue, single CPU core, 64 B packets) results:
Tx only : 1.2 Mpps
Rx only : 1.0 Mpps
L2 FWD Loopback : 0.7 Mpps
Results in skb mode or over the veth are close to results of a tap
backend with vhost=on and disabled segmentation offloading bridged
with a NIC.
Signed-off-by: Ilya Maximets <i.maximets@ovn.org>
Reviewed-by: Daniel P. Berrangé <berrange@redhat.com> (docker/lcitool)
Signed-off-by: Jason Wang <jasowang@redhat.com>
2023-09-14 02:34:37 +08:00
|
|
|
#ifdef CONFIG_AF_XDP
|
|
|
|
"|af-xdp"
|
|
|
|
#endif
|
2022-03-18 01:28:39 +08:00
|
|
|
#ifdef CONFIG_VMNET
|
|
|
|
"|vmnet-host|vmnet-shared|vmnet-bridged"
|
|
|
|
#endif
|
|
|
|
"],id=str[,prop=value][,...]",
|
2010-03-26 00:22:40 +08:00
|
|
|
.help = "add host network device",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_netdev_add,
|
2014-05-08 06:41:31 +08:00
|
|
|
.command_completion = netdev_add_completion,
|
2021-05-11 23:39:55 +08:00
|
|
|
.flags = "p",
|
2010-03-26 00:22:40 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``netdev_add``
|
|
|
|
Add host network device.
|
|
|
|
ERST
|
2010-03-26 00:22:40 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "netdev_del",
|
|
|
|
.args_type = "id:s",
|
|
|
|
.params = "id",
|
|
|
|
.help = "remove host network device",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_netdev_del,
|
2014-05-08 06:41:32 +08:00
|
|
|
.command_completion = netdev_del_completion,
|
2021-05-11 23:39:55 +08:00
|
|
|
.flags = "p",
|
2010-03-26 00:22:40 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``netdev_del``
|
|
|
|
Remove host network device.
|
|
|
|
ERST
|
2013-12-21 06:21:10 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "object_add",
|
2021-02-17 22:27:54 +08:00
|
|
|
.args_type = "object:S",
|
2013-12-21 06:21:10 +08:00
|
|
|
.params = "[qom-type=]type,id=str[,prop=value][,...]",
|
|
|
|
.help = "create QOM object",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_object_add,
|
2014-04-13 23:25:06 +08:00
|
|
|
.command_completion = object_add_completion,
|
2020-11-03 17:39:02 +08:00
|
|
|
.flags = "p",
|
2013-12-21 06:21:10 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``object_add``
|
|
|
|
Create QOM object.
|
|
|
|
ERST
|
2013-12-21 06:21:09 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "object_del",
|
|
|
|
.args_type = "id:s",
|
|
|
|
.params = "id",
|
|
|
|
.help = "destroy QOM object",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_object_del,
|
2014-04-13 23:25:06 +08:00
|
|
|
.command_completion = object_del_completion,
|
2020-11-03 17:39:02 +08:00
|
|
|
.flags = "p",
|
2013-12-21 06:21:09 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``object_del``
|
|
|
|
Destroy QOM object.
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
|
|
|
#ifdef CONFIG_SLIRP
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "hostfwd_add",
|
2019-12-05 18:41:09 +08:00
|
|
|
.args_type = "arg1:s,arg2:s?",
|
|
|
|
.params = "[netdev_id] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
|
2009-10-08 00:41:50 +08:00
|
|
|
.help = "redirect TCP or UDP connections from host to guest (requires -net user)",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_hostfwd_add,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
2010-05-04 19:20:30 +08:00
|
|
|
#endif
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``hostfwd_add``
|
|
|
|
Redirect TCP or UDP connections from host to guest (requires -net user).
|
|
|
|
ERST
|
2009-10-08 00:41:50 +08:00
|
|
|
|
2010-05-04 19:20:30 +08:00
|
|
|
#ifdef CONFIG_SLIRP
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "hostfwd_remove",
|
2019-12-05 18:41:09 +08:00
|
|
|
.args_type = "arg1:s,arg2:s?",
|
|
|
|
.params = "[netdev_id] [tcp|udp]:[hostaddr]:hostport",
|
2009-10-08 00:41:50 +08:00
|
|
|
.help = "remove host-to-guest TCP or UDP redirection",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_hostfwd_remove,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-06 16:22:04 +08:00
|
|
|
#endif
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``hostfwd_remove``
|
|
|
|
Remove host-to-guest TCP or UDP redirection.
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "balloon",
|
2009-12-18 23:25:05 +08:00
|
|
|
.args_type = "value:M",
|
2009-10-08 00:41:50 +08:00
|
|
|
.params = "target",
|
2010-05-20 00:49:28 +08:00
|
|
|
.help = "request VM to change its memory allocation (in MB)",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_balloon,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``balloon`` *value*
|
|
|
|
Request VM to change its memory allocation to *value* (in MB).
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "set_link",
|
2010-03-26 16:07:10 +08:00
|
|
|
.args_type = "name:s,up:b",
|
|
|
|
.params = "name on|off",
|
2009-10-08 00:41:50 +08:00
|
|
|
.help = "change the link status of a network adapter",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_set_link,
|
2014-05-08 06:41:30 +08:00
|
|
|
.command_completion = set_link_completion,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``set_link`` *name* ``[on|off]``
|
|
|
|
Switch link *name* on (i.e. up) or off (i.e. down).
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "watchdog_action",
|
|
|
|
.args_type = "action:s",
|
|
|
|
.params = "[reset|shutdown|poweroff|pause|debug|none]",
|
|
|
|
.help = "change watchdog action",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_watchdog_action,
|
2014-05-28 06:39:31 +08:00
|
|
|
.command_completion = watchdog_action_completion,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``watchdog_action``
|
|
|
|
Change watchdog action.
|
|
|
|
ERST
|
2009-06-06 16:22:04 +08:00
|
|
|
|
2012-08-23 17:53:04 +08:00
|
|
|
{
|
|
|
|
.name = "nbd_server_start",
|
|
|
|
.args_type = "all:-a,writable:-w,uri:s",
|
|
|
|
.params = "nbd_server_start [-a] [-w] host:port",
|
|
|
|
.help = "serve block devices on the given host and port",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_nbd_server_start,
|
2020-11-03 17:37:20 +08:00
|
|
|
.flags = "p",
|
2012-08-23 17:53:04 +08:00
|
|
|
},
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``nbd_server_start`` *host*:*port*
|
|
|
|
Start an NBD server on the given host and/or port. If the ``-a``
|
|
|
|
option is included, all of the virtual machine's block devices that
|
|
|
|
have an inserted media on them are automatically exported; in this case,
|
|
|
|
the ``-w`` option makes the devices writable too.
|
|
|
|
ERST
|
2012-08-23 17:53:04 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "nbd_server_add",
|
2018-01-10 03:28:02 +08:00
|
|
|
.args_type = "writable:-w,device:B,name:s?",
|
|
|
|
.params = "nbd_server_add [-w] device [name]",
|
2012-08-23 17:53:04 +08:00
|
|
|
.help = "export a block device via NBD",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_nbd_server_add,
|
2020-11-03 17:37:20 +08:00
|
|
|
.flags = "p",
|
2012-08-23 17:53:04 +08:00
|
|
|
},
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``nbd_server_add`` *device* [ *name* ]
|
|
|
|
Export a block device through QEMU's NBD server, which must be started
|
|
|
|
beforehand with ``nbd_server_start``. The ``-w`` option makes the
|
|
|
|
exported device writable too. The export name is controlled by *name*,
|
|
|
|
defaulting to *device*.
|
|
|
|
ERST
|
2018-01-25 22:45:57 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "nbd_server_remove",
|
|
|
|
.args_type = "force:-f,name:s",
|
|
|
|
.params = "nbd_server_remove [-f] name",
|
|
|
|
.help = "remove an export previously exposed via NBD",
|
|
|
|
.cmd = hmp_nbd_server_remove,
|
2020-11-03 17:37:20 +08:00
|
|
|
.flags = "p",
|
2018-01-25 22:45:57 +08:00
|
|
|
},
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``nbd_server_remove [-f]`` *name*
|
|
|
|
Stop exporting a block device through QEMU's NBD server, which was
|
|
|
|
previously started with ``nbd_server_add``. The ``-f``
|
|
|
|
option forces the server to drop the export immediately even if
|
|
|
|
clients are connected; otherwise the command fails unless there are no
|
|
|
|
clients.
|
|
|
|
ERST
|
2012-08-23 17:53:04 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "nbd_server_stop",
|
|
|
|
.args_type = "",
|
|
|
|
.params = "nbd_server_stop",
|
|
|
|
.help = "stop serving block devices using the NBD protocol",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_nbd_server_stop,
|
2020-11-03 17:37:20 +08:00
|
|
|
.flags = "p",
|
2012-08-23 17:53:04 +08:00
|
|
|
},
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``nbd_server_stop``
|
|
|
|
Stop the QEMU embedded NBD server.
|
|
|
|
ERST
|
2012-08-23 17:53:04 +08:00
|
|
|
|
|
|
|
|
2009-06-23 10:05:14 +08:00
|
|
|
#if defined(TARGET_I386)
|
2009-10-08 00:41:50 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "mce",
|
2010-12-10 16:21:02 +08:00
|
|
|
.args_type = "broadcast:-b,cpu_index:i,bank:i,status:l,mcg_status:l,addr:l,misc:l",
|
|
|
|
.params = "[-b] cpu bank status mcgstatus addr misc",
|
|
|
|
.help = "inject a MCE on the given CPU [and broadcast to other CPUs with -b option]",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_mce,
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2009-06-23 10:05:14 +08:00
|
|
|
#endif
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``mce`` *cpu* *bank* *status* *mcgstatus* *addr* *misc*
|
|
|
|
Inject an MCE on the given CPU (x86 only).
|
|
|
|
ERST
|
2009-07-22 16:11:40 +08:00
|
|
|
|
2023-03-02 23:05:41 +08:00
|
|
|
#ifdef CONFIG_POSIX
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "getfd",
|
|
|
|
.args_type = "fdname:s",
|
|
|
|
.params = "getfd name",
|
|
|
|
.help = "receive a file descriptor via SCM rights and assign it a name",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_getfd,
|
2020-11-03 17:37:20 +08:00
|
|
|
.flags = "p",
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``getfd`` *fdname*
|
|
|
|
If a file descriptor is passed alongside this command using the SCM_RIGHTS
|
|
|
|
mechanism on unix sockets, it is stored using the name *fdname* for
|
|
|
|
later use by other monitor commands.
|
|
|
|
ERST
|
2023-03-02 23:05:41 +08:00
|
|
|
#endif
|
2009-07-22 16:11:40 +08:00
|
|
|
|
2009-10-08 00:41:50 +08:00
|
|
|
{
|
|
|
|
.name = "closefd",
|
|
|
|
.args_type = "fdname:s",
|
|
|
|
.params = "closefd name",
|
|
|
|
.help = "close a file descriptor previously passed via SCM rights",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_closefd,
|
2020-11-03 17:37:20 +08:00
|
|
|
.flags = "p",
|
2009-10-08 00:41:50 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``closefd`` *fdname*
|
|
|
|
Close the file descriptor previously assigned to *fdname* using the
|
|
|
|
``getfd`` command. This is only needed if the file descriptor was never
|
|
|
|
used by another monitor command.
|
|
|
|
ERST
|
2009-12-05 01:24:09 +08:00
|
|
|
|
2011-11-08 13:00:31 +08:00
|
|
|
{
|
|
|
|
.name = "block_set_io_throttle",
|
|
|
|
.args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l",
|
|
|
|
.params = "device bps bps_rd bps_wr iops iops_rd iops_wr",
|
|
|
|
.help = "change I/O throttle limits for a block drive",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_block_set_io_throttle,
|
2020-11-03 17:37:20 +08:00
|
|
|
.flags = "p",
|
2011-11-08 13:00:31 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``block_set_io_throttle`` *device* *bps* *bps_rd* *bps_wr* *iops* *iops_rd* *iops_wr*
|
|
|
|
Change I/O throttle limits for a block drive to
|
|
|
|
*bps* *bps_rd* *bps_wr* *iops* *iops_rd* *iops_wr*.
|
|
|
|
*device* can be a block device name, a qdev ID or a QOM path.
|
|
|
|
ERST
|
2010-10-07 18:22:54 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "set_password",
|
2022-02-25 16:49:49 +08:00
|
|
|
.args_type = "protocol:s,password:s,display:-ds,connected:s?",
|
|
|
|
.params = "protocol password [-d display] [action-if-connected]",
|
2010-10-07 18:22:54 +08:00
|
|
|
.help = "set spice/vnc password",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_set_password,
|
2010-10-07 18:22:54 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
2022-02-25 16:49:49 +08:00
|
|
|
``set_password [ vnc | spice ] password [ -d display ] [ action-if-connected ]``
|
|
|
|
Change spice/vnc password. *display* can be used with 'vnc' to specify
|
|
|
|
which display to set the password on. *action-if-connected* specifies
|
|
|
|
what should happen in case a connection is established: *fail* makes
|
|
|
|
the password change fail. *disconnect* changes the password and
|
2021-09-09 16:12:19 +08:00
|
|
|
disconnects the client. *keep* changes the password and keeps the
|
|
|
|
connection up. *keep* is the default.
|
2020-02-28 23:36:06 +08:00
|
|
|
ERST
|
2010-10-07 18:22:54 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "expire_password",
|
2022-02-25 16:49:49 +08:00
|
|
|
.args_type = "protocol:s,time:s,display:-ds",
|
|
|
|
.params = "protocol time [-d display]",
|
2010-10-07 18:22:54 +08:00
|
|
|
.help = "set spice/vnc password expire-time",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_expire_password,
|
2010-10-07 18:22:54 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
2022-02-25 16:49:49 +08:00
|
|
|
``expire_password [ vnc | spice ] expire-time [ -d display ]``
|
|
|
|
Specify when a password for spice/vnc becomes invalid.
|
|
|
|
*display* behaves the same as in ``set_password``.
|
|
|
|
*expire-time* accepts:
|
2020-02-28 23:36:06 +08:00
|
|
|
|
|
|
|
``now``
|
|
|
|
Invalidate password instantly.
|
|
|
|
``never``
|
|
|
|
Password stays valid forever.
|
|
|
|
``+``\ *nsec*
|
|
|
|
Password stays valid for *nsec* seconds starting now.
|
|
|
|
*nsec*
|
|
|
|
Password is invalidated at the given time. *nsec* are the seconds
|
|
|
|
passed since 1970, i.e. unix epoch.
|
|
|
|
|
|
|
|
ERST
|
2012-12-19 17:33:40 +08:00
|
|
|
|
2013-02-28 15:46:10 +08:00
|
|
|
{
|
|
|
|
.name = "chardev-add",
|
|
|
|
.args_type = "args:s",
|
|
|
|
.params = "args",
|
|
|
|
.help = "add chardev",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_chardev_add,
|
2014-05-08 06:41:29 +08:00
|
|
|
.command_completion = chardev_add_completion,
|
2013-02-28 15:46:10 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``chardev-add`` *args*
|
|
|
|
chardev-add accepts the same parameters as the -chardev command line switch.
|
|
|
|
ERST
|
2017-07-06 20:08:57 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "chardev-change",
|
|
|
|
.args_type = "id:s,args:s",
|
|
|
|
.params = "id args",
|
|
|
|
.help = "change chardev",
|
|
|
|
.cmd = hmp_chardev_change,
|
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``chardev-change`` *args*
|
|
|
|
chardev-change accepts existing chardev *id* and then the same arguments
|
|
|
|
as the -chardev command line switch (except for "id").
|
|
|
|
ERST
|
2013-02-28 15:46:10 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "chardev-remove",
|
|
|
|
.args_type = "id:s",
|
|
|
|
.params = "id",
|
|
|
|
.help = "remove chardev",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_chardev_remove,
|
2014-05-08 06:41:28 +08:00
|
|
|
.command_completion = chardev_remove_completion,
|
2013-02-28 15:46:10 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``chardev-remove`` *id*
|
|
|
|
Removes the chardev *id*.
|
|
|
|
ERST
|
2017-06-11 15:48:17 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "chardev-send-break",
|
|
|
|
.args_type = "id:s",
|
|
|
|
.params = "id",
|
|
|
|
.help = "send a break on chardev",
|
|
|
|
.cmd = hmp_chardev_send_break,
|
|
|
|
.command_completion = chardev_remove_completion,
|
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``chardev-send-break`` *id*
|
|
|
|
Send a break on the chardev *id*.
|
|
|
|
ERST
|
2013-06-05 20:19:41 +08:00
|
|
|
|
|
|
|
{
|
|
|
|
.name = "qemu-io",
|
2019-12-17 22:13:34 +08:00
|
|
|
.args_type = "qdev:-d,device:B,command:s",
|
|
|
|
.params = "[-d] [device] \"[command]\"",
|
|
|
|
.help = "run a qemu-io command on a block device\n\t\t\t"
|
|
|
|
"-d: [device] is a device ID rather than a "
|
|
|
|
"drive ID or node name",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_qemu_io,
|
2013-06-05 20:19:41 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``qemu-io`` *device* *command*
|
|
|
|
Executes a qemu-io command on the given block device.
|
|
|
|
ERST
|
2013-12-12 02:24:14 +08:00
|
|
|
|
2014-05-08 00:08:29 +08:00
|
|
|
{
|
|
|
|
.name = "qom-list",
|
|
|
|
.args_type = "path:s?",
|
|
|
|
.params = "path",
|
|
|
|
.help = "list QOM properties",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_qom_list,
|
2018-06-20 23:39:45 +08:00
|
|
|
.flags = "p",
|
2014-05-08 00:08:29 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``qom-list`` [*path*]
|
|
|
|
Print QOM properties of object at location *path*
|
|
|
|
ERST
|
2014-05-08 01:48:15 +08:00
|
|
|
|
2020-05-20 23:11:07 +08:00
|
|
|
{
|
|
|
|
.name = "qom-get",
|
|
|
|
.args_type = "path:s,property:s",
|
|
|
|
.params = "path property",
|
|
|
|
.help = "print QOM property",
|
|
|
|
.cmd = hmp_qom_get,
|
|
|
|
.flags = "p",
|
|
|
|
},
|
|
|
|
|
|
|
|
SRST
|
|
|
|
``qom-get`` *path* *property*
|
|
|
|
Print QOM property *property* of object at location *path*
|
|
|
|
ERST
|
|
|
|
|
2014-05-08 01:48:15 +08:00
|
|
|
{
|
|
|
|
.name = "qom-set",
|
2020-06-10 15:51:53 +08:00
|
|
|
.args_type = "json:-j,path:s,property:s,value:S",
|
|
|
|
.params = "[-j] path property value",
|
|
|
|
.help = "set QOM property.\n\t\t\t"
|
|
|
|
"-j: the value is specified in json format.",
|
2016-09-12 17:19:06 +08:00
|
|
|
.cmd = hmp_qom_set,
|
2018-06-20 23:39:45 +08:00
|
|
|
.flags = "p",
|
2014-05-08 01:48:15 +08:00
|
|
|
},
|
|
|
|
|
2020-02-28 23:36:06 +08:00
|
|
|
SRST
|
|
|
|
``qom-set`` *path* *property* *value*
|
|
|
|
Set QOM property *property* of object at location *path* to value *value*
|
|
|
|
ERST
|
2010-06-01 01:43:31 +08:00
|
|
|
|
2020-10-04 01:13:26 +08:00
|
|
|
{
|
|
|
|
.name = "replay_break",
|
2021-05-21 01:43:01 +08:00
|
|
|
.args_type = "icount:l",
|
2020-10-04 01:13:26 +08:00
|
|
|
.params = "icount",
|
|
|
|
.help = "set breakpoint at the specified instruction count",
|
|
|
|
.cmd = hmp_replay_break,
|
|
|
|
},
|
|
|
|
|
|
|
|
SRST
|
|
|
|
``replay_break`` *icount*
|
|
|
|
Set replay breakpoint at instruction count *icount*.
|
|
|
|
Execution stops when the specified instruction is reached.
|
|
|
|
There can be at most one breakpoint. When breakpoint is set, any prior
|
|
|
|
one is removed. The breakpoint may be set only in replay mode and only
|
|
|
|
"in the future", i.e. at instruction counts greater than the current one.
|
|
|
|
The current instruction count can be observed with ``info replay``.
|
|
|
|
ERST
|
|
|
|
|
|
|
|
{
|
|
|
|
.name = "replay_delete_break",
|
|
|
|
.args_type = "",
|
|
|
|
.params = "",
|
|
|
|
.help = "remove replay breakpoint",
|
|
|
|
.cmd = hmp_replay_delete_break,
|
|
|
|
},
|
|
|
|
|
|
|
|
SRST
|
|
|
|
``replay_delete_break``
|
|
|
|
Remove replay breakpoint which was previously set with ``replay_break``.
|
|
|
|
The command is ignored when there are no replay breakpoints.
|
|
|
|
ERST
|
|
|
|
|
2020-10-04 01:13:31 +08:00
|
|
|
{
|
|
|
|
.name = "replay_seek",
|
2021-05-21 01:43:01 +08:00
|
|
|
.args_type = "icount:l",
|
2020-10-04 01:13:31 +08:00
|
|
|
.params = "icount",
|
|
|
|
.help = "replay execution to the specified instruction count",
|
|
|
|
.cmd = hmp_replay_seek,
|
|
|
|
},
|
|
|
|
|
|
|
|
SRST
|
|
|
|
``replay_seek`` *icount*
|
|
|
|
Automatically proceed to the instruction count *icount*, when
|
|
|
|
replaying the execution. The command automatically loads nearest
|
|
|
|
snapshot and replays the execution to find the desired instruction.
|
|
|
|
When there is no preceding snapshot or the execution is not replayed,
|
|
|
|
then the command fails.
|
|
|
|
*icount* for the reference may be observed with ``info replay`` command.
|
|
|
|
ERST
|
|
|
|
|
2021-06-07 09:11:57 +08:00
|
|
|
{
|
|
|
|
.name = "calc_dirty_rate",
|
2021-07-20 23:19:17 +08:00
|
|
|
.args_type = "dirty_ring:-r,dirty_bitmap:-b,second:l,sample_pages_per_GB:l?",
|
|
|
|
.params = "[-r] [-b] second [sample_pages_per_GB]",
|
|
|
|
.help = "start a round of guest dirty rate measurement (using -r to"
|
|
|
|
"\n\t\t\t specify dirty ring as the method of calculation and"
|
|
|
|
"\n\t\t\t -b to specify dirty bitmap as method of calculation)",
|
2021-06-07 09:11:57 +08:00
|
|
|
.cmd = hmp_calc_dirty_rate,
|
|
|
|
},
|
2022-06-26 01:38:36 +08:00
|
|
|
|
|
|
|
SRST
|
2022-09-09 02:35:03 +08:00
|
|
|
``calc_dirty_rate`` *second*
|
|
|
|
Start a round of dirty rate measurement with the period specified in *second*.
|
|
|
|
The result of the dirty rate measurement may be observed with ``info
|
|
|
|
dirty_rate`` command.
|
2022-06-26 01:38:36 +08:00
|
|
|
ERST
|
|
|
|
|
|
|
|
{
|
|
|
|
.name = "set_vcpu_dirty_limit",
|
|
|
|
.args_type = "dirty_rate:l,cpu_index:l?",
|
|
|
|
.params = "dirty_rate [cpu_index]",
|
|
|
|
.help = "set dirty page rate limit, use cpu_index to set limit"
|
|
|
|
"\n\t\t\t\t\t on a specified virtual cpu",
|
|
|
|
.cmd = hmp_set_vcpu_dirty_limit,
|
|
|
|
},
|
|
|
|
|
|
|
|
SRST
|
2022-09-09 02:35:03 +08:00
|
|
|
``set_vcpu_dirty_limit``
|
|
|
|
Set dirty page rate limit on virtual CPU, the information about all the
|
2022-06-26 01:38:36 +08:00
|
|
|
virtual CPU dirty limit status can be observed with ``info vcpu_dirty_limit``
|
|
|
|
command.
|
|
|
|
ERST
|
|
|
|
|
|
|
|
{
|
|
|
|
.name = "cancel_vcpu_dirty_limit",
|
|
|
|
.args_type = "cpu_index:l?",
|
|
|
|
.params = "[cpu_index]",
|
|
|
|
.help = "cancel dirty page rate limit, use cpu_index to cancel"
|
|
|
|
"\n\t\t\t\t\t limit on a specified virtual cpu",
|
|
|
|
.cmd = hmp_cancel_vcpu_dirty_limit,
|
|
|
|
},
|
2022-09-09 02:35:03 +08:00
|
|
|
|
|
|
|
SRST
|
|
|
|
``cancel_vcpu_dirty_limit``
|
|
|
|
Cancel dirty page rate limit on virtual CPU, the information about all the
|
|
|
|
virtual CPU dirty limit status can be observed with ``info vcpu_dirty_limit``
|
|
|
|
command.
|
|
|
|
ERST
|
|
|
|
|
|
|
|
{
|
|
|
|
.name = "info",
|
|
|
|
.args_type = "item:s?",
|
|
|
|
.params = "[subcommand]",
|
|
|
|
.help = "show various information about the system state",
|
|
|
|
.cmd = hmp_info_help,
|
|
|
|
.sub_table = hmp_info_cmds,
|
|
|
|
.flags = "p",
|
|
|
|
},
|
2022-09-27 01:38:40 +08:00
|
|
|
|
|
|
|
#if defined(CONFIG_FDT)
|
|
|
|
{
|
|
|
|
.name = "dumpdtb",
|
|
|
|
.args_type = "filename:F",
|
|
|
|
.params = "filename",
|
|
|
|
.help = "dump the FDT in dtb format to 'filename'",
|
|
|
|
.cmd = hmp_dumpdtb,
|
|
|
|
},
|
|
|
|
|
|
|
|
SRST
|
|
|
|
``dumpdtb`` *filename*
|
|
|
|
Dump the FDT in dtb format to *filename*.
|
|
|
|
ERST
|
|
|
|
#endif
|
2018-08-22 00:16:19 +08:00
|
|
|
|
|
|
|
#if defined(CONFIG_XEN_EMU)
|
|
|
|
{
|
|
|
|
.name = "xen-event-inject",
|
|
|
|
.args_type = "port:i",
|
|
|
|
.params = "port",
|
|
|
|
.help = "inject event channel",
|
|
|
|
.cmd = hmp_xen_event_inject,
|
|
|
|
},
|
|
|
|
|
|
|
|
SRST
|
|
|
|
``xen-event-inject`` *port*
|
|
|
|
Notify guest via event channel on port *port*.
|
|
|
|
ERST
|
|
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
.name = "xen-event-list",
|
|
|
|
.args_type = "",
|
|
|
|
.params = "",
|
|
|
|
.help = "list event channel state",
|
|
|
|
.cmd = hmp_xen_event_list,
|
|
|
|
},
|
|
|
|
|
|
|
|
SRST
|
|
|
|
``xen-event-list``
|
|
|
|
List event channels in the guest
|
|
|
|
ERST
|
|
|
|
#endif
|