2010-09-13 19:26:00 +04:00
|
|
|
|
HXCOMM QMP dispatch table and documentation
|
|
|
|
|
HXCOMM Text between SQMP and EQMP is copied to the QMP documention file and
|
|
|
|
|
HXCOMM does not show up in the other formats.
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
QMP Supported Commands
|
|
|
|
|
----------------------
|
|
|
|
|
|
|
|
|
|
This document describes all commands currently supported by QMP.
|
|
|
|
|
|
|
|
|
|
Most of the time their usage is exactly the same as in the user Monitor, this
|
|
|
|
|
means that any other document which also describe commands (the manpage,
|
|
|
|
|
QEMU's manual, etc) can and should be consulted.
|
|
|
|
|
|
|
|
|
|
QMP has two types of commands: regular and query commands. Regular commands
|
|
|
|
|
usually change the Virtual Machine's state someway, while query commands just
|
|
|
|
|
return information. The sections below are divided accordingly.
|
|
|
|
|
|
|
|
|
|
It's important to observe that all communication examples are formatted in
|
|
|
|
|
a reader-friendly way, so that they're easier to understand. However, in real
|
|
|
|
|
protocol usage, they're emitted as a single line.
|
|
|
|
|
|
|
|
|
|
Also, the following notation is used to denote data flow:
|
|
|
|
|
|
|
|
|
|
-> data issued by the Client
|
|
|
|
|
<- Server data response
|
|
|
|
|
|
|
|
|
|
Please, refer to the QMP specification (QMP/qmp-spec.txt) for detailed
|
|
|
|
|
information on the Server command and response formats.
|
|
|
|
|
|
|
|
|
|
NOTE: This document is temporary and will be replaced soon.
|
|
|
|
|
|
|
|
|
|
1. Stability Considerations
|
|
|
|
|
===========================
|
|
|
|
|
|
|
|
|
|
The current QMP command set (described in this file) may be useful for a
|
|
|
|
|
number of use cases, however it's limited and several commands have bad
|
|
|
|
|
defined semantics, specially with regard to command completion.
|
|
|
|
|
|
|
|
|
|
These problems are going to be solved incrementally in the next QEMU releases
|
|
|
|
|
and we're going to establish a deprecation policy for badly defined commands.
|
|
|
|
|
|
|
|
|
|
If you're planning to adopt QMP, please observe the following:
|
|
|
|
|
|
2011-07-27 10:32:56 +04:00
|
|
|
|
1. The deprecation policy will take effect and be documented soon, please
|
2010-09-13 19:26:00 +04:00
|
|
|
|
check the documentation of each used command as soon as a new release of
|
|
|
|
|
QEMU is available
|
|
|
|
|
|
|
|
|
|
2. DO NOT rely on anything which is not explicit documented
|
|
|
|
|
|
|
|
|
|
3. Errors, in special, are not documented. Applications should NOT check
|
|
|
|
|
for specific errors classes or data (it's strongly recommended to only
|
|
|
|
|
check for the "error" key)
|
|
|
|
|
|
|
|
|
|
2. Regular Commands
|
|
|
|
|
===================
|
|
|
|
|
|
|
|
|
|
Server's responses in the examples below are always a success response, please
|
|
|
|
|
refer to the QMP specification for more details on error responses.
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "quit",
|
|
|
|
|
.args_type = "",
|
2011-09-15 21:20:28 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_quit,
|
2010-09-13 19:26:00 +04:00
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
quit
|
|
|
|
|
----
|
|
|
|
|
|
|
|
|
|
Quit the emulator.
|
|
|
|
|
|
|
|
|
|
Arguments: None.
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "quit" }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "eject",
|
|
|
|
|
.args_type = "force:-f,device:B",
|
2011-12-07 22:02:36 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_eject,
|
2010-09-13 19:26:00 +04:00
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
eject
|
|
|
|
|
-----
|
|
|
|
|
|
|
|
|
|
Eject a removable medium.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- force: force ejection (json-bool, optional)
|
|
|
|
|
- device: device name (json-string)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "eject", "arguments": { "device": "ide1-cd0" } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
|
|
|
|
Note: The "force" argument defaults to false.
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "change",
|
|
|
|
|
.args_type = "device:B,target:F,arg:s?",
|
2011-12-08 17:13:50 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_change,
|
2010-09-13 19:26:00 +04:00
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
change
|
|
|
|
|
------
|
|
|
|
|
|
|
|
|
|
Change a removable medium or VNC configuration.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "device": device name (json-string)
|
|
|
|
|
- "target": filename or item (json-string)
|
|
|
|
|
- "arg": additional argument (json-string, optional)
|
|
|
|
|
|
|
|
|
|
Examples:
|
|
|
|
|
|
|
|
|
|
1. Change a removable medium
|
|
|
|
|
|
|
|
|
|
-> { "execute": "change",
|
|
|
|
|
"arguments": { "device": "ide1-cd0",
|
|
|
|
|
"target": "/srv/images/Fedora-12-x86_64-DVD.iso" } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
|
|
|
|
2. Change VNC password
|
|
|
|
|
|
|
|
|
|
-> { "execute": "change",
|
|
|
|
|
"arguments": { "device": "vnc", "target": "password",
|
|
|
|
|
"arg": "foobar1" } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "screendump",
|
|
|
|
|
.args_type = "filename:F",
|
2012-05-24 20:48:23 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_screendump,
|
2010-09-13 19:26:00 +04:00
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
screendump
|
|
|
|
|
----------
|
|
|
|
|
|
|
|
|
|
Save screen into PPM image.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "filename": file path (json-string)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "screendump", "arguments": { "filename": "/tmp/image" } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "stop",
|
|
|
|
|
.args_type = "",
|
2011-09-15 21:34:39 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_stop,
|
2010-09-13 19:26:00 +04:00
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
stop
|
|
|
|
|
----
|
|
|
|
|
|
|
|
|
|
Stop the emulator.
|
|
|
|
|
|
|
|
|
|
Arguments: None.
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "stop" }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "cont",
|
|
|
|
|
.args_type = "",
|
2011-11-22 23:58:31 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_cont,
|
2010-09-13 19:26:00 +04:00
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
cont
|
|
|
|
|
----
|
|
|
|
|
|
|
|
|
|
Resume emulation.
|
|
|
|
|
|
|
|
|
|
Arguments: None.
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "cont" }
|
|
|
|
|
<- { "return": {} }
|
2012-02-23 16:45:21 +04:00
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "system_wakeup",
|
|
|
|
|
.args_type = "",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_system_wakeup,
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
system_wakeup
|
|
|
|
|
-------------
|
|
|
|
|
|
|
|
|
|
Wakeup guest from suspend.
|
|
|
|
|
|
|
|
|
|
Arguments: None.
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "system_wakeup" }
|
|
|
|
|
<- { "return": {} }
|
2010-09-13 19:26:00 +04:00
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "system_reset",
|
|
|
|
|
.args_type = "",
|
2011-09-15 21:41:46 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_system_reset,
|
2010-09-13 19:26:00 +04:00
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
system_reset
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
Reset the system.
|
|
|
|
|
|
|
|
|
|
Arguments: None.
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "system_reset" }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "system_powerdown",
|
|
|
|
|
.args_type = "",
|
2011-11-28 04:40:03 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_system_powerdown,
|
2010-09-13 19:26:00 +04:00
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
system_powerdown
|
|
|
|
|
----------------
|
|
|
|
|
|
|
|
|
|
Send system power down event.
|
|
|
|
|
|
|
|
|
|
Arguments: None.
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "system_powerdown" }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "device_add",
|
|
|
|
|
.args_type = "device:O",
|
|
|
|
|
.params = "driver[,prop=value][,...]",
|
|
|
|
|
.help = "add device, like -device on the command line",
|
|
|
|
|
.user_print = monitor_user_noop,
|
|
|
|
|
.mhandler.cmd_new = do_device_add,
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
device_add
|
|
|
|
|
----------
|
|
|
|
|
|
|
|
|
|
Add a device.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "driver": the name of the new device's driver (json-string)
|
|
|
|
|
- "bus": the device's parent bus (device tree path, json-string, optional)
|
|
|
|
|
- "id": the device's ID, must be unique (json-string)
|
|
|
|
|
- device properties
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "device_add", "arguments": { "driver": "e1000", "id": "net1" } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
|
|
|
|
Notes:
|
|
|
|
|
|
|
|
|
|
(1) For detailed information about this command, please refer to the
|
|
|
|
|
'docs/qdev-device-use.txt' file.
|
|
|
|
|
|
|
|
|
|
(2) It's possible to list device properties by running QEMU with the
|
|
|
|
|
"-device DEVICE,\?" command-line argument, where DEVICE is the device's name
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "device_del",
|
|
|
|
|
.args_type = "id:s",
|
2012-03-29 19:38:50 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_device_del,
|
2010-09-13 19:26:00 +04:00
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
device_del
|
|
|
|
|
----------
|
|
|
|
|
|
|
|
|
|
Remove a device.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "id": the device's ID (json-string)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "device_del", "arguments": { "id": "net1" } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
2012-08-31 06:56:26 +04:00
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "send-key",
|
|
|
|
|
.args_type = "keys:O,hold-time:i?",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_send_key,
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
send-key
|
|
|
|
|
----------
|
|
|
|
|
|
|
|
|
|
Send keys to VM.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
keys array:
|
2013-07-16 15:52:14 +04:00
|
|
|
|
- "key": key sequence (a json-array of key union values,
|
|
|
|
|
union can be number or qcode enum)
|
2012-08-31 06:56:26 +04:00
|
|
|
|
|
|
|
|
|
- hold-time: time to delay key up events, milliseconds. Defaults to 100
|
|
|
|
|
(json-int, optional)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "send-key",
|
2013-07-16 15:52:14 +04:00
|
|
|
|
"arguments": { "keys": [ { "type": "qcode", "data": "ctrl" },
|
|
|
|
|
{ "type": "qcode", "data": "alt" },
|
|
|
|
|
{ "type": "qcode", "data": "delete" } ] } }
|
2012-08-31 06:56:26 +04:00
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
2010-09-13 19:26:00 +04:00
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "cpu",
|
|
|
|
|
.args_type = "index:i",
|
2011-10-06 21:31:39 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_cpu,
|
2010-09-13 19:26:00 +04:00
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
cpu
|
|
|
|
|
---
|
|
|
|
|
|
|
|
|
|
Set the default CPU.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "index": the CPU's index (json-int)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "cpu", "arguments": { "index": 0 } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
|
|
|
|
Note: CPUs' indexes are obtained with the 'query-cpus' command.
|
|
|
|
|
|
2013-04-30 17:41:25 +04:00
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "cpu-add",
|
|
|
|
|
.args_type = "id:i",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_cpu_add,
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
cpu-add
|
|
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
Adds virtual cpu
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "id": cpu id (json-int)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "cpu-add", "arguments": { "id": 2 } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
2010-09-13 19:26:00 +04:00
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "memsave",
|
2011-11-22 22:32:37 +04:00
|
|
|
|
.args_type = "val:l,size:i,filename:s,cpu:i?",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_memsave,
|
2010-09-13 19:26:00 +04:00
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
memsave
|
|
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
Save to disk virtual memory dump starting at 'val' of size 'size'.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "val": the starting address (json-int)
|
|
|
|
|
- "size": the memory size, in bytes (json-int)
|
|
|
|
|
- "filename": file path (json-string)
|
2011-11-22 22:32:37 +04:00
|
|
|
|
- "cpu": virtual CPU index (json-int, optional)
|
2010-09-13 19:26:00 +04:00
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "memsave",
|
|
|
|
|
"arguments": { "val": 10,
|
|
|
|
|
"size": 100,
|
|
|
|
|
"filename": "/tmp/virtual-mem-dump" } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "pmemsave",
|
|
|
|
|
.args_type = "val:l,size:i,filename:s",
|
2011-11-22 23:26:46 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_pmemsave,
|
2010-09-13 19:26:00 +04:00
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
pmemsave
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
Save to disk physical memory dump starting at 'val' of size 'size'.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "val": the starting address (json-int)
|
|
|
|
|
- "size": the memory size, in bytes (json-int)
|
|
|
|
|
- "filename": file path (json-string)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "pmemsave",
|
|
|
|
|
"arguments": { "val": 10,
|
|
|
|
|
"size": 100,
|
|
|
|
|
"filename": "/tmp/physical-mem-dump" } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
2011-03-07 12:05:15 +03:00
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "inject-nmi",
|
|
|
|
|
.args_type = "",
|
2011-11-23 18:55:53 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_inject_nmi,
|
2011-03-07 12:05:15 +03:00
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
inject-nmi
|
|
|
|
|
----------
|
|
|
|
|
|
|
|
|
|
Inject an NMI on guest's CPUs.
|
|
|
|
|
|
|
|
|
|
Arguments: None.
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "inject-nmi" }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
2012-07-27 23:18:16 +04:00
|
|
|
|
Note: inject-nmi fails when the guest doesn't support injecting.
|
2012-12-05 18:50:07 +04:00
|
|
|
|
Currently, only x86 (NMI) and s390x (RESTART) guests do.
|
2011-03-07 12:05:15 +03:00
|
|
|
|
|
2013-01-24 20:03:20 +04:00
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
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 00:27:24 +04:00
|
|
|
|
.name = "ringbuf-write",
|
2013-02-07 00:27:14 +04:00
|
|
|
|
.args_type = "device:s,data:s,format:s?",
|
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 00:27:24 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_ringbuf_write,
|
2013-01-24 20:03:20 +04:00
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
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 00:27:24 +04:00
|
|
|
|
ringbuf-write
|
2013-01-24 20:03:20 +04: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 00:27:24 +04:00
|
|
|
|
Write to a ring buffer character device.
|
2013-01-24 20:03:20 +04:00
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
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 00:27:24 +04:00
|
|
|
|
- "device": ring buffer character device name (json-string)
|
|
|
|
|
- "data": data to write (json-string)
|
|
|
|
|
- "format": data format (json-string, optional)
|
|
|
|
|
- Possible values: "utf8" (default), "base64"
|
|
|
|
|
Bug: invalid base64 is currently not rejected.
|
|
|
|
|
Whitespace *is* invalid.
|
2013-01-24 20:03:20 +04:00
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
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 00:27:24 +04:00
|
|
|
|
-> { "execute": "ringbuf-write",
|
|
|
|
|
"arguments": { "device": "foo",
|
2013-01-24 20:03:20 +04:00
|
|
|
|
"data": "abcdefgh",
|
|
|
|
|
"format": "utf8" } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
2013-01-24 20:03:21 +04:00
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
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 00:27:24 +04:00
|
|
|
|
.name = "ringbuf-read",
|
2013-01-24 20:03:21 +04:00
|
|
|
|
.args_type = "device:s,size:i,format:s?",
|
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 00:27:24 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_ringbuf_read,
|
2013-01-24 20:03:21 +04:00
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
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 00:27:24 +04:00
|
|
|
|
ringbuf-read
|
2013-01-24 20:03:21 +04: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 00:27:24 +04:00
|
|
|
|
Read from a ring buffer character device.
|
2013-01-24 20:03:21 +04:00
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
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 00:27:24 +04:00
|
|
|
|
- "device": ring buffer character device name (json-string)
|
|
|
|
|
- "size": how many bytes to read at most (json-int)
|
|
|
|
|
- Number of data bytes, not number of characters in encoded data
|
|
|
|
|
- "format": data format (json-string, optional)
|
|
|
|
|
- Possible values: "utf8" (default), "base64"
|
|
|
|
|
- Naturally, format "utf8" works only when the ring buffer
|
|
|
|
|
contains valid UTF-8 text. Invalid UTF-8 sequences get
|
|
|
|
|
replaced. Bug: replacement doesn't work. Bug: can screw
|
|
|
|
|
up on encountering NUL characters, after the ring buffer
|
|
|
|
|
lost data, and when reading stops because the size limit
|
|
|
|
|
is reached.
|
2013-01-24 20:03:21 +04:00
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
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 00:27:24 +04:00
|
|
|
|
-> { "execute": "ringbuf-read",
|
|
|
|
|
"arguments": { "device": "foo",
|
2013-01-24 20:03:21 +04:00
|
|
|
|
"size": 1000,
|
|
|
|
|
"format": "utf8" } }
|
2013-02-07 00:27:15 +04:00
|
|
|
|
<- {"return": "abcdefgh"}
|
2013-01-24 20:03:21 +04:00
|
|
|
|
|
2012-01-25 16:24:51 +04:00
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "xen-save-devices-state",
|
|
|
|
|
.args_type = "filename:F",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_xen_save_devices_state,
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
xen-save-devices-state
|
|
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
Save the state of all devices to file. The RAM and the block devices
|
|
|
|
|
of the VM are not saved by this command.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "filename": the file to save the state of the devices to as binary
|
|
|
|
|
data. See xen-save-devices-state.txt for a description of the binary
|
|
|
|
|
format.
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "xen-save-devices-state",
|
|
|
|
|
"arguments": { "filename": "/tmp/save" } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
2012-10-03 17:48:19 +04:00
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "xen-set-global-dirty-log",
|
|
|
|
|
.args_type = "enable:b",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_xen_set_global_dirty_log,
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
xen-set-global-dirty-log
|
|
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
Enable or disable the global dirty log mode.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "enable": Enable it or disable it.
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "xen-set-global-dirty-log",
|
|
|
|
|
"arguments": { "enable": true } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
2010-09-13 19:26:00 +04:00
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "migrate",
|
|
|
|
|
.args_type = "detach:-d,blk:-b,inc:-i,uri:s",
|
2011-12-05 20:48:01 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_migrate,
|
2010-09-13 19:26:00 +04:00
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
migrate
|
|
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
Migrate to URI.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "blk": block migration, full disk copy (json-bool, optional)
|
|
|
|
|
- "inc": incremental disk copy (json-bool, optional)
|
|
|
|
|
- "uri": Destination URI (json-string)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "migrate", "arguments": { "uri": "tcp:0:4446" } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
|
|
|
|
Notes:
|
|
|
|
|
|
|
|
|
|
(1) The 'query-migrate' command should be used to check migration's progress
|
|
|
|
|
and final result (this information is provided by the 'status' member)
|
|
|
|
|
(2) All boolean arguments default to false
|
|
|
|
|
(3) The user Monitor's "detach" argument is invalid in QMP and should not
|
|
|
|
|
be used
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "migrate_cancel",
|
|
|
|
|
.args_type = "",
|
2011-11-28 04:54:09 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_migrate_cancel,
|
2010-09-13 19:26:00 +04:00
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
migrate_cancel
|
|
|
|
|
--------------
|
|
|
|
|
|
|
|
|
|
Cancel the current migration.
|
|
|
|
|
|
|
|
|
|
Arguments: None.
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "migrate_cancel" }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
2012-08-06 22:42:54 +04:00
|
|
|
|
EQMP
|
|
|
|
|
{
|
|
|
|
|
.name = "migrate-set-cache-size",
|
|
|
|
|
.args_type = "value:o",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_migrate_set_cache_size,
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
migrate-set-cache-size
|
2013-02-11 18:11:10 +04:00
|
|
|
|
----------------------
|
2012-08-06 22:42:54 +04:00
|
|
|
|
|
|
|
|
|
Set cache size to be used by XBZRLE migration, the cache size will be rounded
|
|
|
|
|
down to the nearest power of 2
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "value": cache size in bytes (json-int)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "migrate-set-cache-size", "arguments": { "value": 536870912 } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
{
|
|
|
|
|
.name = "query-migrate-cache-size",
|
|
|
|
|
.args_type = "",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_query_migrate_cache_size,
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
query-migrate-cache-size
|
2013-02-11 18:11:10 +04:00
|
|
|
|
------------------------
|
2012-08-06 22:42:54 +04:00
|
|
|
|
|
|
|
|
|
Show cache size to be used by XBZRLE migration
|
|
|
|
|
|
|
|
|
|
returns a json-object with the following information:
|
|
|
|
|
- "size" : json-int
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "query-migrate-cache-size" }
|
|
|
|
|
<- { "return": 67108864 }
|
|
|
|
|
|
2010-09-13 19:26:00 +04:00
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "migrate_set_speed",
|
2010-11-25 04:06:05 +03:00
|
|
|
|
.args_type = "value:o",
|
2011-11-28 17:59:37 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_migrate_set_speed,
|
2010-09-13 19:26:00 +04:00
|
|
|
|
},
|
|
|
|
|
|
2010-04-23 15:28:21 +04:00
|
|
|
|
SQMP
|
2011-03-09 16:31:06 +03:00
|
|
|
|
migrate_set_speed
|
|
|
|
|
-----------------
|
2010-04-23 15:28:21 +04:00
|
|
|
|
|
2011-03-09 16:31:06 +03:00
|
|
|
|
Set maximum speed for migrations.
|
2010-04-23 15:28:21 +04:00
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
2011-03-09 16:31:06 +03:00
|
|
|
|
- "value": maximum speed, in bytes per second (json-int)
|
2010-04-23 15:28:21 +04:00
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
2011-03-09 16:31:06 +03:00
|
|
|
|
-> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } }
|
2010-04-23 15:28:21 +04:00
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
2011-03-09 16:31:06 +03:00
|
|
|
|
.name = "migrate_set_downtime",
|
|
|
|
|
.args_type = "value:T",
|
2011-11-28 05:18:01 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_migrate_set_downtime,
|
2010-04-23 15:28:21 +04:00
|
|
|
|
},
|
|
|
|
|
|
2010-09-13 19:26:00 +04:00
|
|
|
|
SQMP
|
2011-03-09 16:31:06 +03:00
|
|
|
|
migrate_set_downtime
|
|
|
|
|
--------------------
|
2010-09-13 19:26:00 +04:00
|
|
|
|
|
2011-03-09 16:31:06 +03:00
|
|
|
|
Set maximum tolerated downtime (in seconds) for migrations.
|
2010-09-13 19:26:00 +04:00
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
2011-03-09 16:31:06 +03:00
|
|
|
|
- "value": maximum downtime (json-number)
|
2010-09-13 19:26:00 +04:00
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
2011-03-09 16:31:06 +03:00
|
|
|
|
-> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } }
|
2010-09-13 19:26:00 +04:00
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
2011-03-09 16:31:06 +03: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",
|
|
|
|
|
.help = "send migration info to spice/vnc client",
|
2010-09-13 19:26:00 +04:00
|
|
|
|
.user_print = monitor_user_noop,
|
2011-10-17 12:03:18 +04:00
|
|
|
|
.mhandler.cmd_async = client_migrate_info,
|
|
|
|
|
.flags = MONITOR_CMD_ASYNC,
|
2010-09-13 19:26:00 +04:00
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
2011-03-09 16:31:06 +03:00
|
|
|
|
client_migrate_info
|
|
|
|
|
------------------
|
2010-09-13 19:26:00 +04:00
|
|
|
|
|
2011-03-09 16:31:06 +03:00
|
|
|
|
Set the spice/vnc connection info for the migration target. The spice/vnc
|
|
|
|
|
server will ask the spice/vnc client to automatically reconnect using the
|
|
|
|
|
new parameters (if specified) once the vm migration finished successfully.
|
2010-09-13 19:26:00 +04:00
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
2011-03-09 16:31:06 +03:00
|
|
|
|
- "protocol": protocol: "spice" or "vnc" (json-string)
|
|
|
|
|
- "hostname": migration target hostname (json-string)
|
|
|
|
|
- "port": spice/vnc tcp port for plaintext channels (json-int, optional)
|
|
|
|
|
- "tls-port": spice tcp port for tls-secured channels (json-int, optional)
|
|
|
|
|
- "cert-subject": server certificate subject (json-string, optional)
|
2010-09-13 19:26:00 +04:00
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
2011-03-09 16:31:06 +03:00
|
|
|
|
-> { "execute": "client_migrate_info",
|
|
|
|
|
"arguments": { "protocol": "spice",
|
|
|
|
|
"hostname": "virt42.lab.kraxel.org",
|
|
|
|
|
"port": 1234 } }
|
2010-09-13 19:26:00 +04:00
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
2012-05-07 08:10:47 +04:00
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "dump-guest-memory",
|
2014-02-18 10:11:36 +04:00
|
|
|
|
.args_type = "paging:b,protocol:s,begin:i?,end:i?,format:s?",
|
|
|
|
|
.params = "-p protocol [begin] [length] [format]",
|
2012-05-07 08:10:47 +04:00
|
|
|
|
.help = "dump guest memory to file",
|
|
|
|
|
.user_print = monitor_user_noop,
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_dump_guest_memory,
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
dump
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Dump guest memory to file. The file can be processed with crash or gdb.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "paging": do paging to get guest's memory mapping (json-bool)
|
|
|
|
|
- "protocol": destination file(started with "file:") or destination file
|
|
|
|
|
descriptor (started with "fd:") (json-string)
|
|
|
|
|
- "begin": the starting physical address. It's optional, and should be specified
|
|
|
|
|
with length together (json-int)
|
|
|
|
|
- "length": the memory size, in bytes. It's optional, and should be specified
|
|
|
|
|
with begin together (json-int)
|
2014-02-18 10:11:36 +04:00
|
|
|
|
- "format": the format of guest memory dump. It's optional, and can be
|
|
|
|
|
elf|kdump-zlib|kdump-lzo|kdump-snappy, but non-elf formats will
|
|
|
|
|
conflict with paging and filter, ie. begin and length (json-string)
|
2012-05-07 08:10:47 +04:00
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "dump-guest-memory", "arguments": { "protocol": "fd:dump" } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
|
|
|
|
Notes:
|
|
|
|
|
|
|
|
|
|
(1) All boolean arguments default to false
|
|
|
|
|
|
2014-02-18 10:11:38 +04:00
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "query-dump-guest-memory-capability",
|
|
|
|
|
.args_type = "",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_query_dump_guest_memory_capability,
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
query-dump-guest-memory-capability
|
|
|
|
|
----------
|
|
|
|
|
|
|
|
|
|
Show available formats for 'dump-guest-memory'
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "query-dump-guest-memory-capability" }
|
|
|
|
|
<- { "return": { "formats":
|
|
|
|
|
["elf", "kdump-zlib", "kdump-lzo", "kdump-snappy"] }
|
|
|
|
|
|
2010-09-13 19:26:00 +04:00
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "netdev_add",
|
|
|
|
|
.args_type = "netdev:O",
|
2012-04-19 00:34:15 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_netdev_add,
|
2010-09-13 19:26:00 +04:00
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
netdev_add
|
|
|
|
|
----------
|
|
|
|
|
|
|
|
|
|
Add host network device.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "type": the device type, "tap", "user", ... (json-string)
|
|
|
|
|
- "id": the device's ID, must be unique (json-string)
|
|
|
|
|
- device options
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "netdev_add", "arguments": { "type": "user", "id": "netdev1" } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
2013-02-22 21:31:51 +04:00
|
|
|
|
Note: The supported device options are the same ones supported by the '-netdev'
|
2010-09-13 19:26:00 +04:00
|
|
|
|
command-line argument, which are listed in the '-help' output or QEMU's
|
|
|
|
|
manual
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "netdev_del",
|
|
|
|
|
.args_type = "id:s",
|
2012-04-16 21:36:32 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_netdev_del,
|
2010-09-13 19:26:00 +04:00
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
netdev_del
|
|
|
|
|
----------
|
|
|
|
|
|
|
|
|
|
Remove host network device.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "id": the device's ID, must be unique (json-string)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "netdev_del", "arguments": { "id": "netdev1" } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
2011-01-24 15:32:33 +03:00
|
|
|
|
|
2013-12-21 02:21:10 +04:00
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "object-add",
|
|
|
|
|
.args_type = "qom-type:s,id:s,props:q?",
|
|
|
|
|
.mhandler.cmd_new = qmp_object_add,
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
object-add
|
|
|
|
|
----------
|
|
|
|
|
|
|
|
|
|
Create QOM object.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "qom-type": the object's QOM type, i.e. the class name (json-string)
|
|
|
|
|
- "id": the object's ID, must be unique (json-string)
|
|
|
|
|
- "props": a dictionary of object property values (optional, json-dict)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "object-add", "arguments": { "qom-type": "rng-random", "id": "rng1",
|
|
|
|
|
"props": { "filename": "/dev/hwrng" } } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
2011-01-24 15:32:33 +03:00
|
|
|
|
EQMP
|
|
|
|
|
|
2013-12-21 02:21:09 +04:00
|
|
|
|
{
|
|
|
|
|
.name = "object-del",
|
|
|
|
|
.args_type = "id:s",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_object_del,
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
object-del
|
|
|
|
|
----------
|
|
|
|
|
|
|
|
|
|
Remove QOM object.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "id": the object's ID (json-string)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "object-del", "arguments": { "id": "rng1" } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
|
2011-01-24 15:32:33 +03:00
|
|
|
|
{
|
|
|
|
|
.name = "block_resize",
|
2014-01-24 00:31:37 +04:00
|
|
|
|
.args_type = "device:s?,node-name:s?,size:o",
|
2011-11-25 20:57:10 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_block_resize,
|
2011-01-24 15:32:33 +03:00
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
block_resize
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
Resize a block image while a guest is running.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "device": the device's ID, must be unique (json-string)
|
2014-01-24 00:31:37 +04:00
|
|
|
|
- "node-name": the node name in the block driver state graph (json-string)
|
2011-01-24 15:32:33 +03:00
|
|
|
|
- "size": new size
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "block_resize", "arguments": { "device": "scratch", "size": 1073741824 } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
2011-07-11 22:01:09 +04:00
|
|
|
|
EQMP
|
|
|
|
|
|
2012-01-18 18:40:46 +04:00
|
|
|
|
{
|
2012-04-11 19:27:10 +04:00
|
|
|
|
.name = "block-stream",
|
2012-09-28 19:22:59 +04:00
|
|
|
|
.args_type = "device:B,base:s?,speed:o?,on-error:s?",
|
2012-01-18 18:40:46 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_block_stream,
|
|
|
|
|
},
|
|
|
|
|
|
QAPI: add command for live block commit, 'block-commit'
The command for live block commit is added, which has the following
arguments:
device: the block device to perform the commit on (mandatory)
base: the base image to commit into; optional (if not specified,
it is the underlying original image)
top: the top image of the commit - all data from inside top down
to base will be committed into base (mandatory for now; see
note, below)
speed: maximum speed, in bytes/sec
Note: Eventually this command will support merging down the active layer,
but that code is not yet complete. If the active layer is passed
in as top, then an error will be returned. Once merging down the
active layer is supported, the 'top' argument may become optional,
and default to the active layer.
The is done as a block job, so upon completion a BLOCK_JOB_COMPLETED will
be emitted.
Signed-off-by: Jeff Cody <jcody@redhat.com>
Reviewed-by: Eric Blake <eblake@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2012-09-27 21:29:16 +04:00
|
|
|
|
{
|
|
|
|
|
.name = "block-commit",
|
|
|
|
|
.args_type = "device:B,base:s?,top:s,speed:o?",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_block_commit,
|
|
|
|
|
},
|
|
|
|
|
|
2014-01-24 18:02:37 +04:00
|
|
|
|
SQMP
|
|
|
|
|
block-commit
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
Live commit of data from overlay image nodes into backing nodes - i.e., writes
|
|
|
|
|
data between 'top' and 'base' into 'base'.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "device": The device's ID, must be unique (json-string)
|
|
|
|
|
- "base": The file name of the backing image to write data into.
|
|
|
|
|
If not specified, this is the deepest backing image
|
|
|
|
|
(json-string, optional)
|
|
|
|
|
- "top": The file name of the backing image within the image chain,
|
|
|
|
|
which contains the topmost data to be committed down.
|
|
|
|
|
|
|
|
|
|
If top == base, that is an error.
|
|
|
|
|
If top == active, the job will not be completed by itself,
|
|
|
|
|
user needs to complete the job with the block-job-complete
|
|
|
|
|
command after getting the ready event. (Since 2.0)
|
|
|
|
|
|
|
|
|
|
If the base image is smaller than top, then the base image
|
|
|
|
|
will be resized to be the same size as top. If top is
|
|
|
|
|
smaller than the base image, the base will not be
|
|
|
|
|
truncated. If you want the base image size to match the
|
|
|
|
|
size of the smaller top, you can safely truncate it
|
|
|
|
|
yourself once the commit operation successfully completes.
|
|
|
|
|
(json-string)
|
|
|
|
|
- "speed": the maximum speed, in bytes per second (json-int, optional)
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "block-commit", "arguments": { "device": "virtio0",
|
|
|
|
|
"top": "/tmp/snap1.qcow2" } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
block: add drive-backup QMP command
@drive-backup
Start a point-in-time copy of a block device to a new destination. The
status of ongoing drive-backup operations can be checked with
query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
The operation can be stopped before it has completed using the
block-job-cancel command.
@device: the name of the device which should be copied.
@target: the target of the new image. If the file exists, or if it
is a device, the existing file/device will be used as the new
destination. If it does not exist, a new file will be created.
@format: #optional the format of the new destination, default is to
probe if @mode is 'existing', else the format of the source
@mode: #optional whether and how QEMU should create a new image, default is
'absolute-paths'.
@speed: #optional the maximum speed, in bytes per second
@on-source-error: #optional the action to take on an error on the source,
default 'report'. 'stop' and 'enospc' can only be used
if the block device supports io-status (see BlockInfo).
@on-target-error: #optional the action to take on an error on the target,
default 'report' (no limitations, since this applies to
a different block device than @device).
Note that @on-source-error and @on-target-error only affect background I/O.
If an error occurs during a guest write request, the device's rerror/werror
actions will be used.
Returns: nothing on success
If @device is not a valid block device, DeviceNotFound
Since 1.6
Reviewed-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Kevin Wolf <kwolf@redhat.com>
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2013-06-24 19:13:14 +04:00
|
|
|
|
{
|
|
|
|
|
.name = "drive-backup",
|
2013-06-26 16:11:57 +04:00
|
|
|
|
.args_type = "sync:s,device:B,target:s,speed:i?,mode:s?,format:s?,"
|
block: add drive-backup QMP command
@drive-backup
Start a point-in-time copy of a block device to a new destination. The
status of ongoing drive-backup operations can be checked with
query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
The operation can be stopped before it has completed using the
block-job-cancel command.
@device: the name of the device which should be copied.
@target: the target of the new image. If the file exists, or if it
is a device, the existing file/device will be used as the new
destination. If it does not exist, a new file will be created.
@format: #optional the format of the new destination, default is to
probe if @mode is 'existing', else the format of the source
@mode: #optional whether and how QEMU should create a new image, default is
'absolute-paths'.
@speed: #optional the maximum speed, in bytes per second
@on-source-error: #optional the action to take on an error on the source,
default 'report'. 'stop' and 'enospc' can only be used
if the block device supports io-status (see BlockInfo).
@on-target-error: #optional the action to take on an error on the target,
default 'report' (no limitations, since this applies to
a different block device than @device).
Note that @on-source-error and @on-target-error only affect background I/O.
If an error occurs during a guest write request, the device's rerror/werror
actions will be used.
Returns: nothing on success
If @device is not a valid block device, DeviceNotFound
Since 1.6
Reviewed-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Kevin Wolf <kwolf@redhat.com>
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2013-06-24 19:13:14 +04:00
|
|
|
|
"on-source-error:s?,on-target-error:s?",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_drive_backup,
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
drive-backup
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
Start a point-in-time copy of a block device to a new destination. The
|
|
|
|
|
status of ongoing drive-backup operations can be checked with
|
|
|
|
|
query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
|
|
|
|
|
The operation can be stopped before it has completed using the
|
|
|
|
|
block-job-cancel command.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "device": the name of the device which should be copied.
|
|
|
|
|
(json-string)
|
|
|
|
|
- "target": the target of the new image. If the file exists, or if it is a
|
|
|
|
|
device, the existing file/device will be used as the new
|
|
|
|
|
destination. If it does not exist, a new file will be created.
|
|
|
|
|
(json-string)
|
|
|
|
|
- "format": the format of the new destination, default is to probe if 'mode' is
|
|
|
|
|
'existing', else the format of the source
|
|
|
|
|
(json-string, optional)
|
2013-06-26 16:11:57 +04:00
|
|
|
|
- "sync": what parts of the disk image should be copied to the destination;
|
|
|
|
|
possibilities include "full" for all the disk, "top" for only the sectors
|
|
|
|
|
allocated in the topmost image, or "none" to only replicate new I/O
|
|
|
|
|
(MirrorSyncMode).
|
block: add drive-backup QMP command
@drive-backup
Start a point-in-time copy of a block device to a new destination. The
status of ongoing drive-backup operations can be checked with
query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
The operation can be stopped before it has completed using the
block-job-cancel command.
@device: the name of the device which should be copied.
@target: the target of the new image. If the file exists, or if it
is a device, the existing file/device will be used as the new
destination. If it does not exist, a new file will be created.
@format: #optional the format of the new destination, default is to
probe if @mode is 'existing', else the format of the source
@mode: #optional whether and how QEMU should create a new image, default is
'absolute-paths'.
@speed: #optional the maximum speed, in bytes per second
@on-source-error: #optional the action to take on an error on the source,
default 'report'. 'stop' and 'enospc' can only be used
if the block device supports io-status (see BlockInfo).
@on-target-error: #optional the action to take on an error on the target,
default 'report' (no limitations, since this applies to
a different block device than @device).
Note that @on-source-error and @on-target-error only affect background I/O.
If an error occurs during a guest write request, the device's rerror/werror
actions will be used.
Returns: nothing on success
If @device is not a valid block device, DeviceNotFound
Since 1.6
Reviewed-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Kevin Wolf <kwolf@redhat.com>
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2013-06-24 19:13:14 +04:00
|
|
|
|
- "mode": whether and how QEMU should create a new image
|
|
|
|
|
(NewImageMode, optional, default 'absolute-paths')
|
|
|
|
|
- "speed": the maximum speed, in bytes per second (json-int, optional)
|
|
|
|
|
- "on-source-error": the action to take on an error on the source, default
|
|
|
|
|
'report'. 'stop' and 'enospc' can only be used
|
|
|
|
|
if the block device supports io-status.
|
|
|
|
|
(BlockdevOnError, optional)
|
|
|
|
|
- "on-target-error": the action to take on an error on the target, default
|
|
|
|
|
'report' (no limitations, since this applies to
|
|
|
|
|
a different block device than device).
|
|
|
|
|
(BlockdevOnError, optional)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
-> { "execute": "drive-backup", "arguments": { "device": "drive0",
|
2013-07-26 22:39:04 +04:00
|
|
|
|
"sync": "full",
|
block: add drive-backup QMP command
@drive-backup
Start a point-in-time copy of a block device to a new destination. The
status of ongoing drive-backup operations can be checked with
query-block-jobs where the BlockJobInfo.type field has the value 'backup'.
The operation can be stopped before it has completed using the
block-job-cancel command.
@device: the name of the device which should be copied.
@target: the target of the new image. If the file exists, or if it
is a device, the existing file/device will be used as the new
destination. If it does not exist, a new file will be created.
@format: #optional the format of the new destination, default is to
probe if @mode is 'existing', else the format of the source
@mode: #optional whether and how QEMU should create a new image, default is
'absolute-paths'.
@speed: #optional the maximum speed, in bytes per second
@on-source-error: #optional the action to take on an error on the source,
default 'report'. 'stop' and 'enospc' can only be used
if the block device supports io-status (see BlockInfo).
@on-target-error: #optional the action to take on an error on the target,
default 'report' (no limitations, since this applies to
a different block device than @device).
Note that @on-source-error and @on-target-error only affect background I/O.
If an error occurs during a guest write request, the device's rerror/werror
actions will be used.
Returns: nothing on success
If @device is not a valid block device, DeviceNotFound
Since 1.6
Reviewed-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Kevin Wolf <kwolf@redhat.com>
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
Signed-off-by: Kevin Wolf <kwolf@redhat.com>
2013-06-24 19:13:14 +04:00
|
|
|
|
"target": "backup.img" } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
EQMP
|
|
|
|
|
|
2012-01-18 18:40:47 +04:00
|
|
|
|
{
|
2012-04-11 19:27:10 +04:00
|
|
|
|
.name = "block-job-set-speed",
|
2012-04-25 19:51:02 +04:00
|
|
|
|
.args_type = "device:B,speed:o",
|
2012-01-18 18:40:47 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_block_job_set_speed,
|
|
|
|
|
},
|
|
|
|
|
|
2012-01-18 18:40:48 +04:00
|
|
|
|
{
|
2012-04-11 19:27:10 +04:00
|
|
|
|
.name = "block-job-cancel",
|
2012-09-28 19:22:51 +04:00
|
|
|
|
.args_type = "device:B,force:b?",
|
2012-01-18 18:40:48 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_block_job_cancel,
|
|
|
|
|
},
|
2012-09-28 19:22:51 +04:00
|
|
|
|
{
|
|
|
|
|
.name = "block-job-pause",
|
|
|
|
|
.args_type = "device:B",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_block_job_pause,
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
.name = "block-job-resume",
|
|
|
|
|
.args_type = "device:B",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_block_job_resume,
|
|
|
|
|
},
|
2012-10-18 18:49:21 +04:00
|
|
|
|
{
|
|
|
|
|
.name = "block-job-complete",
|
|
|
|
|
.args_type = "device:B",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_block_job_complete,
|
|
|
|
|
},
|
2012-02-29 00:54:07 +04:00
|
|
|
|
{
|
2012-03-06 21:55:57 +04:00
|
|
|
|
.name = "transaction",
|
2012-03-22 15:51:11 +04:00
|
|
|
|
.args_type = "actions:q",
|
2012-03-06 21:55:57 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_transaction,
|
2012-02-29 00:54:07 +04:00
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
2012-03-06 21:55:57 +04:00
|
|
|
|
transaction
|
|
|
|
|
-----------
|
2012-02-29 00:54:07 +04:00
|
|
|
|
|
2013-09-11 10:04:34 +04:00
|
|
|
|
Atomically operate on one or more block devices. The only supported operations
|
|
|
|
|
for now are drive-backup, internal and external snapshotting. A list of
|
|
|
|
|
dictionaries is accepted, that contains the actions to be performed.
|
|
|
|
|
If there is any failure performing any of the operations, all operations
|
|
|
|
|
for the group are abandoned.
|
2012-02-29 00:54:07 +04:00
|
|
|
|
|
2013-09-11 10:04:34 +04:00
|
|
|
|
For external snapshots, the dictionary contains the device, the file to use for
|
|
|
|
|
the new snapshot, and the format. The default format, if not specified, is
|
|
|
|
|
qcow2.
|
2012-02-29 00:54:07 +04:00
|
|
|
|
|
2012-03-06 21:55:58 +04:00
|
|
|
|
Each new snapshot defaults to being created by QEMU (wiping any
|
|
|
|
|
contents if the file already exists), but it is also possible to reuse
|
|
|
|
|
an externally-created file. In the latter case, you should ensure that
|
|
|
|
|
the new image file has the same contents as the current one; QEMU cannot
|
|
|
|
|
perform any meaningful check. Typically this is achieved by using the
|
|
|
|
|
current image file as the backing file for the new image.
|
|
|
|
|
|
2013-09-11 10:04:34 +04:00
|
|
|
|
On failure, the original disks pre-snapshot attempt will be used.
|
|
|
|
|
|
|
|
|
|
For internal snapshots, the dictionary contains the device and the snapshot's
|
|
|
|
|
name. If an internal snapshot matching name already exists, the request will
|
|
|
|
|
be rejected. Only some image formats support it, for example, qcow2, rbd,
|
|
|
|
|
and sheepdog.
|
|
|
|
|
|
|
|
|
|
On failure, qemu will try delete the newly created internal snapshot in the
|
|
|
|
|
transaction. When an I/O error occurs during deletion, the user needs to fix
|
|
|
|
|
it later with qemu-img or other command.
|
|
|
|
|
|
2012-02-29 00:54:07 +04:00
|
|
|
|
Arguments:
|
|
|
|
|
|
2012-03-06 21:55:57 +04:00
|
|
|
|
actions array:
|
|
|
|
|
- "type": the operation to perform. The only supported
|
|
|
|
|
value is "blockdev-snapshot-sync". (json-string)
|
|
|
|
|
- "data": a dictionary. The contents depend on the value
|
|
|
|
|
of "type". When "type" is "blockdev-snapshot-sync":
|
|
|
|
|
- "device": device name to snapshot (json-string)
|
2014-01-24 00:31:38 +04:00
|
|
|
|
- "node-name": graph node name to snapshot (json-string)
|
2012-03-06 21:55:57 +04:00
|
|
|
|
- "snapshot-file": name of new image file (json-string)
|
2014-01-24 00:31:38 +04:00
|
|
|
|
- "snapshot-node-name": graph node name of the new snapshot (json-string)
|
2012-03-06 21:55:57 +04:00
|
|
|
|
- "format": format of new image (json-string, optional)
|
2012-03-06 21:55:58 +04:00
|
|
|
|
- "mode": whether and how QEMU should create the snapshot file
|
|
|
|
|
(NewImageMode, optional, default "absolute-paths")
|
2013-09-11 10:04:34 +04:00
|
|
|
|
When "type" is "blockdev-snapshot-internal-sync":
|
|
|
|
|
- "device": device name to snapshot (json-string)
|
|
|
|
|
- "name": name of the new snapshot (json-string)
|
2012-02-29 00:54:07 +04:00
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
2012-03-06 21:55:57 +04:00
|
|
|
|
-> { "execute": "transaction",
|
|
|
|
|
"arguments": { "actions": [
|
2014-05-06 19:39:03 +04:00
|
|
|
|
{ "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd0",
|
2012-03-06 21:55:57 +04:00
|
|
|
|
"snapshot-file": "/some/place/my-image",
|
|
|
|
|
"format": "qcow2" } },
|
2014-05-06 19:39:03 +04:00
|
|
|
|
{ "type": "blockdev-snapshot-sync", "data" : { "node-name": "myfile",
|
2014-01-24 00:31:38 +04:00
|
|
|
|
"snapshot-file": "/some/place/my-image2",
|
|
|
|
|
"snapshot-node-name": "node3432",
|
|
|
|
|
"mode": "existing",
|
|
|
|
|
"format": "qcow2" } },
|
2014-05-06 19:39:03 +04:00
|
|
|
|
{ "type": "blockdev-snapshot-sync", "data" : { "device": "ide-hd1",
|
2012-03-06 21:55:57 +04:00
|
|
|
|
"snapshot-file": "/some/place/my-image2",
|
2012-03-06 21:55:58 +04:00
|
|
|
|
"mode": "existing",
|
2013-09-11 10:04:34 +04:00
|
|
|
|
"format": "qcow2" } },
|
2014-05-06 19:39:03 +04:00
|
|
|
|
{ "type": "blockdev-snapshot-internal-sync", "data" : {
|
2013-09-11 10:04:34 +04:00
|
|
|
|
"device": "ide-hd2",
|
|
|
|
|
"name": "snapshot0" } } ] } }
|
2012-02-29 00:54:07 +04:00
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
|
|
|
|
EQMP
|
2012-01-18 18:40:48 +04:00
|
|
|
|
|
2011-07-11 22:01:09 +04:00
|
|
|
|
{
|
|
|
|
|
.name = "blockdev-snapshot-sync",
|
2014-01-24 00:31:38 +04:00
|
|
|
|
.args_type = "device:s?,node-name:s?,snapshot-file:s,snapshot-node-name:s?,format:s?,mode:s?",
|
2011-11-25 22:15:19 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_blockdev_snapshot_sync,
|
2011-07-11 22:01:09 +04:00
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
blockdev-snapshot-sync
|
|
|
|
|
----------------------
|
|
|
|
|
|
|
|
|
|
Synchronous snapshot of a block device. snapshot-file specifies the
|
|
|
|
|
target of the new image. If the file exists, or if it is a device, the
|
|
|
|
|
snapshot will be created in the existing file/device. If does not
|
|
|
|
|
exist, a new file will be created. format specifies the format of the
|
|
|
|
|
snapshot image, default is qcow2.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "device": device name to snapshot (json-string)
|
2014-01-24 00:31:38 +04:00
|
|
|
|
- "node-name": graph node name to snapshot (json-string)
|
2011-07-11 22:01:09 +04:00
|
|
|
|
- "snapshot-file": name of new image file (json-string)
|
2014-01-24 00:31:38 +04:00
|
|
|
|
- "snapshot-node-name": graph node name of the new snapshot (json-string)
|
2012-03-06 21:55:59 +04:00
|
|
|
|
- "mode": whether and how QEMU should create the snapshot file
|
|
|
|
|
(NewImageMode, optional, default "absolute-paths")
|
2011-07-11 22:01:09 +04:00
|
|
|
|
- "format": format of new image (json-string, optional)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
2011-10-11 00:30:08 +04:00
|
|
|
|
-> { "execute": "blockdev-snapshot-sync", "arguments": { "device": "ide-hd0",
|
|
|
|
|
"snapshot-file":
|
|
|
|
|
"/some/place/my-image",
|
|
|
|
|
"format": "qcow2" } }
|
2011-07-11 22:01:09 +04:00
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
2013-09-11 10:04:35 +04:00
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "blockdev-snapshot-internal-sync",
|
|
|
|
|
.args_type = "device:B,name:s",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_blockdev_snapshot_internal_sync,
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
blockdev-snapshot-internal-sync
|
|
|
|
|
-------------------------------
|
|
|
|
|
|
|
|
|
|
Synchronously take an internal snapshot of a block device when the format of
|
|
|
|
|
image used supports it. If the name is an empty string, or a snapshot with
|
|
|
|
|
name already exists, the operation will fail.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "device": device name to snapshot (json-string)
|
|
|
|
|
- "name": name of the new snapshot (json-string)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "blockdev-snapshot-internal-sync",
|
|
|
|
|
"arguments": { "device": "ide-hd0",
|
|
|
|
|
"name": "snapshot0" }
|
|
|
|
|
}
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
2013-09-11 10:04:36 +04:00
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "blockdev-snapshot-delete-internal-sync",
|
|
|
|
|
.args_type = "device:B,id:s?,name:s?",
|
|
|
|
|
.mhandler.cmd_new =
|
|
|
|
|
qmp_marshal_input_blockdev_snapshot_delete_internal_sync,
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
blockdev-snapshot-delete-internal-sync
|
|
|
|
|
--------------------------------------
|
|
|
|
|
|
|
|
|
|
Synchronously delete an internal snapshot of a block device when the format of
|
|
|
|
|
image used supports it. The snapshot is identified by name or id or both. One
|
|
|
|
|
of name or id is required. If the snapshot is not found, the operation will
|
|
|
|
|
fail.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "device": device name (json-string)
|
|
|
|
|
- "id": ID of the snapshot (json-string, optional)
|
|
|
|
|
- "name": name of the snapshot (json-string, optional)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "blockdev-snapshot-delete-internal-sync",
|
|
|
|
|
"arguments": { "device": "ide-hd0",
|
|
|
|
|
"name": "snapshot0" }
|
|
|
|
|
}
|
|
|
|
|
<- { "return": {
|
|
|
|
|
"id": "1",
|
|
|
|
|
"name": "snapshot0",
|
|
|
|
|
"vm-state-size": 0,
|
|
|
|
|
"date-sec": 1000012,
|
|
|
|
|
"date-nsec": 10,
|
|
|
|
|
"vm-clock-sec": 100,
|
|
|
|
|
"vm-clock-nsec": 20
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2012-10-18 18:49:24 +04:00
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "drive-mirror",
|
2012-10-18 18:49:28 +04:00
|
|
|
|
.args_type = "sync:s,device:B,target:s,speed:i?,mode:s?,format:s?,"
|
2013-01-21 20:09:46 +04:00
|
|
|
|
"on-source-error:s?,on-target-error:s?,"
|
2013-01-22 12:03:13 +04:00
|
|
|
|
"granularity:i?,buf-size:i?",
|
2012-10-18 18:49:24 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_drive_mirror,
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
drive-mirror
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
Start mirroring a block device's writes to a new destination. target
|
|
|
|
|
specifies the target of the new image. If the file exists, or if it is
|
|
|
|
|
a device, it will be used as the new destination for writes. If it does not
|
|
|
|
|
exist, a new file will be created. format specifies the format of the
|
|
|
|
|
mirror image, default is to probe if mode='existing', else the format
|
|
|
|
|
of the source.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "device": device name to operate on (json-string)
|
|
|
|
|
- "target": name of new image file (json-string)
|
|
|
|
|
- "format": format of new image (json-string, optional)
|
|
|
|
|
- "mode": how an image file should be created into the target
|
|
|
|
|
file/device (NewImageMode, optional, default 'absolute-paths')
|
|
|
|
|
- "speed": maximum speed of the streaming job, in bytes per second
|
|
|
|
|
(json-int)
|
2013-01-21 20:09:46 +04:00
|
|
|
|
- "granularity": granularity of the dirty bitmap, in bytes (json-int, optional)
|
2013-01-22 12:03:13 +04:00
|
|
|
|
- "buf_size": maximum amount of data in flight from source to target, in bytes
|
|
|
|
|
(json-int, default 10M)
|
2012-10-18 18:49:24 +04:00
|
|
|
|
- "sync": what parts of the disk image should be copied to the destination;
|
|
|
|
|
possibilities include "full" for all the disk, "top" for only the sectors
|
|
|
|
|
allocated in the topmost image, or "none" to only replicate new I/O
|
|
|
|
|
(MirrorSyncMode).
|
2012-10-18 18:49:28 +04:00
|
|
|
|
- "on-source-error": the action to take on an error on the source
|
|
|
|
|
(BlockdevOnError, default 'report')
|
|
|
|
|
- "on-target-error": the action to take on an error on the target
|
|
|
|
|
(BlockdevOnError, default 'report')
|
|
|
|
|
|
2013-01-21 20:09:46 +04:00
|
|
|
|
The default value of the granularity is the image cluster size clamped
|
|
|
|
|
between 4096 and 65536, if the image format defines one. If the format
|
|
|
|
|
does not define a cluster size, the default value of the granularity
|
|
|
|
|
is 65536.
|
2012-10-18 18:49:24 +04:00
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "drive-mirror", "arguments": { "device": "ide-hd0",
|
|
|
|
|
"target": "/some/place/my-image",
|
|
|
|
|
"sync": "full",
|
|
|
|
|
"format": "qcow2" } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
2010-09-13 19:26:00 +04:00
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "balloon",
|
|
|
|
|
.args_type = "value:M",
|
2011-11-25 20:38:09 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_balloon,
|
2010-09-13 19:26:00 +04:00
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
balloon
|
|
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
Request VM to change its memory allocation (in bytes).
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "value": New memory allocation (json-int)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "balloon", "arguments": { "value": 536870912 } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "set_link",
|
|
|
|
|
.args_type = "name:s,up:b",
|
2011-11-23 19:11:55 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_set_link,
|
2010-09-13 19:26:00 +04:00
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
set_link
|
|
|
|
|
--------
|
|
|
|
|
|
|
|
|
|
Change the link status of a network adapter.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "name": network device name (json-string)
|
|
|
|
|
- "up": status is up (json-bool)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "set_link", "arguments": { "name": "e1000.0", "up": false } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "getfd",
|
|
|
|
|
.args_type = "fdname:s",
|
|
|
|
|
.params = "getfd name",
|
|
|
|
|
.help = "receive a file descriptor via SCM rights and assign it a name",
|
2012-06-22 22:36:09 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_getfd,
|
2010-09-13 19:26:00 +04:00
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
getfd
|
|
|
|
|
-----
|
|
|
|
|
|
|
|
|
|
Receive a file descriptor via SCM rights and assign it a name.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "fdname": file descriptor name (json-string)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "getfd", "arguments": { "fdname": "fd1" } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
2012-06-22 22:36:09 +04:00
|
|
|
|
Notes:
|
|
|
|
|
|
|
|
|
|
(1) If the name specified by the "fdname" argument already exists,
|
|
|
|
|
the file descriptor assigned to it will be closed and replaced
|
|
|
|
|
by the received file descriptor.
|
|
|
|
|
(2) The 'closefd' command can be used to explicitly close the file
|
|
|
|
|
descriptor when it is no longer needed.
|
|
|
|
|
|
2010-09-13 19:26:00 +04:00
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "closefd",
|
|
|
|
|
.args_type = "fdname:s",
|
|
|
|
|
.params = "closefd name",
|
|
|
|
|
.help = "close a file descriptor previously passed via SCM rights",
|
2012-06-22 22:36:09 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_closefd,
|
2010-09-13 19:26:00 +04:00
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
closefd
|
|
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
Close a file descriptor previously passed via SCM rights.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "fdname": file descriptor name (json-string)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "closefd", "arguments": { "fdname": "fd1" } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
2012-08-15 00:43:43 +04:00
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "add-fd",
|
|
|
|
|
.args_type = "fdset-id:i?,opaque:s?",
|
|
|
|
|
.params = "add-fd fdset-id opaque",
|
|
|
|
|
.help = "Add a file descriptor, that was passed via SCM rights, to an fd set",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_add_fd,
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
add-fd
|
|
|
|
|
-------
|
|
|
|
|
|
|
|
|
|
Add a file descriptor, that was passed via SCM rights, to an fd set.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "fdset-id": The ID of the fd set to add the file descriptor to.
|
|
|
|
|
(json-int, optional)
|
|
|
|
|
- "opaque": A free-form string that can be used to describe the fd.
|
|
|
|
|
(json-string, optional)
|
|
|
|
|
|
|
|
|
|
Return a json-object with the following information:
|
|
|
|
|
|
|
|
|
|
- "fdset-id": The ID of the fd set that the fd was added to. (json-int)
|
|
|
|
|
- "fd": The file descriptor that was received via SCM rights and added to the
|
|
|
|
|
fd set. (json-int)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "add-fd", "arguments": { "fdset-id": 1 } }
|
|
|
|
|
<- { "return": { "fdset-id": 1, "fd": 3 } }
|
|
|
|
|
|
|
|
|
|
Notes:
|
|
|
|
|
|
|
|
|
|
(1) The list of fd sets is shared by all monitor connections.
|
|
|
|
|
(2) If "fdset-id" is not specified, a new fd set will be created.
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "remove-fd",
|
|
|
|
|
.args_type = "fdset-id:i,fd:i?",
|
|
|
|
|
.params = "remove-fd fdset-id fd",
|
|
|
|
|
.help = "Remove a file descriptor from an fd set",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_remove_fd,
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
remove-fd
|
|
|
|
|
---------
|
|
|
|
|
|
|
|
|
|
Remove a file descriptor from an fd set.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "fdset-id": The ID of the fd set that the file descriptor belongs to.
|
|
|
|
|
(json-int)
|
|
|
|
|
- "fd": The file descriptor that is to be removed. (json-int, optional)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "remove-fd", "arguments": { "fdset-id": 1, "fd": 3 } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
|
|
|
|
Notes:
|
|
|
|
|
|
|
|
|
|
(1) The list of fd sets is shared by all monitor connections.
|
|
|
|
|
(2) If "fd" is not specified, all file descriptors in "fdset-id" will be
|
|
|
|
|
removed.
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "query-fdsets",
|
|
|
|
|
.args_type = "",
|
|
|
|
|
.help = "Return information describing all fd sets",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_query_fdsets,
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
query-fdsets
|
|
|
|
|
-------------
|
|
|
|
|
|
|
|
|
|
Return information describing all fd sets.
|
|
|
|
|
|
|
|
|
|
Arguments: None
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "query-fdsets" }
|
|
|
|
|
<- { "return": [
|
|
|
|
|
{
|
|
|
|
|
"fds": [
|
|
|
|
|
{
|
|
|
|
|
"fd": 30,
|
|
|
|
|
"opaque": "rdonly:/path/to/file"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"fd": 24,
|
|
|
|
|
"opaque": "rdwr:/path/to/file"
|
|
|
|
|
}
|
|
|
|
|
],
|
|
|
|
|
"fdset-id": 1
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"fds": [
|
|
|
|
|
{
|
|
|
|
|
"fd": 28
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"fd": 29
|
|
|
|
|
}
|
|
|
|
|
],
|
|
|
|
|
"fdset-id": 0
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
Note: The list of fd sets is shared by all monitor connections.
|
|
|
|
|
|
2010-09-13 19:26:00 +04:00
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "block_passwd",
|
2014-01-24 00:31:35 +04:00
|
|
|
|
.args_type = "device:s?,node-name:s?,password:s",
|
2011-11-23 19:28:21 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_block_passwd,
|
2010-09-13 19:26:00 +04:00
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
block_passwd
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
Set the password of encrypted block devices.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "device": device name (json-string)
|
2014-01-24 00:31:35 +04:00
|
|
|
|
- "node-name": name in the block driver state graph (json-string)
|
2010-09-13 19:26:00 +04:00
|
|
|
|
- "password": password (json-string)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "block_passwd", "arguments": { "device": "ide0-hd0",
|
|
|
|
|
"password": "12345" } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
2011-11-08 09:00:31 +04:00
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "block_set_io_throttle",
|
2013-09-02 16:14:41 +04:00
|
|
|
|
.args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l,bps_max:l?,bps_rd_max:l?,bps_wr_max:l?,iops_max:l?,iops_rd_max:l?,iops_wr_max:l?,iops_size:l?",
|
2011-12-14 22:49:14 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_block_set_io_throttle,
|
2011-11-08 09:00:31 +04:00
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
block_set_io_throttle
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
Change I/O throttle limits for a block drive.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "device": device name (json-string)
|
2013-08-31 00:44:11 +04:00
|
|
|
|
- "bps": total throughput limit in bytes per second (json-int)
|
|
|
|
|
- "bps_rd": read throughput limit in bytes per second (json-int)
|
|
|
|
|
- "bps_wr": write throughput limit in bytes per second (json-int)
|
|
|
|
|
- "iops": total I/O operations per second (json-int)
|
|
|
|
|
- "iops_rd": read I/O operations per second (json-int)
|
|
|
|
|
- "iops_wr": write I/O operations per second (json-int)
|
2013-09-02 16:14:40 +04:00
|
|
|
|
- "bps_max": total max in bytes (json-int)
|
|
|
|
|
- "bps_rd_max": read max in bytes (json-int)
|
|
|
|
|
- "bps_wr_max": write max in bytes (json-int)
|
|
|
|
|
- "iops_max": total I/O operations max (json-int)
|
|
|
|
|
- "iops_rd_max": read I/O operations max (json-int)
|
|
|
|
|
- "iops_wr_max": write I/O operations max (json-int)
|
2013-09-02 16:14:41 +04:00
|
|
|
|
- "iops_size": I/O size in bytes when limiting (json-int)
|
2011-11-08 09:00:31 +04:00
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "block_set_io_throttle", "arguments": { "device": "virtio0",
|
2013-08-31 00:44:11 +04:00
|
|
|
|
"bps": 1000000,
|
|
|
|
|
"bps_rd": 0,
|
|
|
|
|
"bps_wr": 0,
|
|
|
|
|
"iops": 0,
|
|
|
|
|
"iops_rd": 0,
|
2013-09-02 16:14:40 +04:00
|
|
|
|
"iops_wr": 0,
|
|
|
|
|
"bps_max": 8000000,
|
|
|
|
|
"bps_rd_max": 0,
|
|
|
|
|
"bps_wr_max": 0,
|
|
|
|
|
"iops_max": 0,
|
|
|
|
|
"iops_rd_max": 0,
|
2013-09-02 16:14:41 +04:00
|
|
|
|
"iops_wr_max": 0,
|
|
|
|
|
"iops_size": 0 } }
|
2011-11-08 09:00:31 +04:00
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
2010-10-07 14:22:54 +04:00
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "set_password",
|
|
|
|
|
.args_type = "protocol:s,password:s,connected:s?",
|
2011-12-07 17:17:51 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_set_password,
|
2010-10-07 14:22:54 +04:00
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
set_password
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
Set the password for vnc/spice protocols.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "protocol": protocol name (json-string)
|
|
|
|
|
- "password": password (json-string)
|
|
|
|
|
- "connected": [ keep | disconnect | fail ] (josn-string, optional)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "set_password", "arguments": { "protocol": "vnc",
|
|
|
|
|
"password": "secret" } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "expire_password",
|
|
|
|
|
.args_type = "protocol:s,time:s",
|
2011-12-07 17:47:57 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_expire_password,
|
2010-10-07 14:22:54 +04:00
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
expire_password
|
|
|
|
|
---------------
|
|
|
|
|
|
|
|
|
|
Set the password expire time for vnc/spice protocols.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "protocol": protocol name (json-string)
|
|
|
|
|
- "time": [ now | never | +secs | secs ] (json-string)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "expire_password", "arguments": { "protocol": "vnc",
|
|
|
|
|
"time": "+60" } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
2010-09-13 19:26:00 +04:00
|
|
|
|
EQMP
|
|
|
|
|
|
Introduce a 'client_add' monitor command accepting an open FD
Allow client connections for VNC and socket based character
devices to be passed in over the monitor using SCM_RIGHTS.
One intended usage scenario is to start QEMU with VNC on a
UNIX domain socket. An unprivileged user which cannot access
the UNIX domain socket, can then connect to QEMU's VNC server
by passing an open FD to libvirt, which passes it onto QEMU.
{ "execute": "get_fd", "arguments": { "fdname": "myclient" } }
{ "return": {} }
{ "execute": "add_client", "arguments": { "protocol": "vnc",
"fdname": "myclient",
"skipauth": true } }
{ "return": {} }
In this case 'protocol' can be 'vnc' or 'spice', or the name
of a character device (eg from -chardev id=XXXX)
The 'skipauth' parameter can be used to skip any configured
VNC authentication scheme, which is useful if the mgmt layer
talking to the monitor has already authenticated the client
in another way.
* console.h: Define 'vnc_display_add_client' method
* monitor.c: Implement 'client_add' command
* qemu-char.c, qemu-char.h: Add 'qemu_char_add_client' method
* qerror.c, qerror.h: Add QERR_ADD_CLIENT_FAILED
* qmp-commands.hx: Declare 'client_add' command
* ui/vnc.c: Implement 'vnc_display_add_client' method
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2011-06-23 16:31:42 +04:00
|
|
|
|
{
|
|
|
|
|
.name = "add_client",
|
2012-02-13 17:43:08 +04:00
|
|
|
|
.args_type = "protocol:s,fdname:s,skipauth:b?,tls:b?",
|
2012-09-13 23:52:20 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_add_client,
|
Introduce a 'client_add' monitor command accepting an open FD
Allow client connections for VNC and socket based character
devices to be passed in over the monitor using SCM_RIGHTS.
One intended usage scenario is to start QEMU with VNC on a
UNIX domain socket. An unprivileged user which cannot access
the UNIX domain socket, can then connect to QEMU's VNC server
by passing an open FD to libvirt, which passes it onto QEMU.
{ "execute": "get_fd", "arguments": { "fdname": "myclient" } }
{ "return": {} }
{ "execute": "add_client", "arguments": { "protocol": "vnc",
"fdname": "myclient",
"skipauth": true } }
{ "return": {} }
In this case 'protocol' can be 'vnc' or 'spice', or the name
of a character device (eg from -chardev id=XXXX)
The 'skipauth' parameter can be used to skip any configured
VNC authentication scheme, which is useful if the mgmt layer
talking to the monitor has already authenticated the client
in another way.
* console.h: Define 'vnc_display_add_client' method
* monitor.c: Implement 'client_add' command
* qemu-char.c, qemu-char.h: Add 'qemu_char_add_client' method
* qerror.c, qerror.h: Add QERR_ADD_CLIENT_FAILED
* qmp-commands.hx: Declare 'client_add' command
* ui/vnc.c: Implement 'vnc_display_add_client' method
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2011-06-23 16:31:42 +04:00
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
add_client
|
|
|
|
|
----------
|
|
|
|
|
|
|
|
|
|
Add a graphics client
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "protocol": protocol name (json-string)
|
|
|
|
|
- "fdname": file descriptor name (json-string)
|
2012-02-13 17:43:08 +04:00
|
|
|
|
- "skipauth": whether to skip authentication (json-bool, optional)
|
|
|
|
|
- "tls": whether to perform TLS (json-bool, optional)
|
Introduce a 'client_add' monitor command accepting an open FD
Allow client connections for VNC and socket based character
devices to be passed in over the monitor using SCM_RIGHTS.
One intended usage scenario is to start QEMU with VNC on a
UNIX domain socket. An unprivileged user which cannot access
the UNIX domain socket, can then connect to QEMU's VNC server
by passing an open FD to libvirt, which passes it onto QEMU.
{ "execute": "get_fd", "arguments": { "fdname": "myclient" } }
{ "return": {} }
{ "execute": "add_client", "arguments": { "protocol": "vnc",
"fdname": "myclient",
"skipauth": true } }
{ "return": {} }
In this case 'protocol' can be 'vnc' or 'spice', or the name
of a character device (eg from -chardev id=XXXX)
The 'skipauth' parameter can be used to skip any configured
VNC authentication scheme, which is useful if the mgmt layer
talking to the monitor has already authenticated the client
in another way.
* console.h: Define 'vnc_display_add_client' method
* monitor.c: Implement 'client_add' command
* qemu-char.c, qemu-char.h: Add 'qemu_char_add_client' method
* qerror.c, qerror.h: Add QERR_ADD_CLIENT_FAILED
* qmp-commands.hx: Declare 'client_add' command
* ui/vnc.c: Implement 'vnc_display_add_client' method
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2011-06-23 16:31:42 +04:00
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "add_client", "arguments": { "protocol": "vnc",
|
|
|
|
|
"fdname": "myclient" } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
|
|
|
|
EQMP
|
2010-09-13 19:26:00 +04:00
|
|
|
|
{
|
|
|
|
|
.name = "qmp_capabilities",
|
|
|
|
|
.args_type = "",
|
|
|
|
|
.params = "",
|
|
|
|
|
.help = "enable QMP capabilities",
|
|
|
|
|
.user_print = monitor_user_noop,
|
|
|
|
|
.mhandler.cmd_new = do_qmp_capabilities,
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
qmp_capabilities
|
|
|
|
|
----------------
|
|
|
|
|
|
|
|
|
|
Enable QMP capabilities.
|
|
|
|
|
|
|
|
|
|
Arguments: None.
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "qmp_capabilities" }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
|
|
|
|
Note: This command must be issued before issuing any other command.
|
|
|
|
|
|
2010-10-22 16:08:02 +04:00
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "human-monitor-command",
|
|
|
|
|
.args_type = "command-line:s,cpu-index:i?",
|
2011-11-25 23:52:45 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_human_monitor_command,
|
2010-10-22 16:08:02 +04:00
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
human-monitor-command
|
|
|
|
|
---------------------
|
|
|
|
|
|
|
|
|
|
Execute a Human Monitor command.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- command-line: the command name and its arguments, just like the
|
|
|
|
|
Human Monitor's shell (json-string)
|
|
|
|
|
- cpu-index: select the CPU number to be used by commands which access CPU
|
|
|
|
|
data, like 'info registers'. The Monitor selects CPU 0 if this
|
|
|
|
|
argument is not provided (json-int, optional)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "human-monitor-command", "arguments": { "command-line": "info kvm" } }
|
|
|
|
|
<- { "return": "kvm support: enabled\r\n" }
|
|
|
|
|
|
|
|
|
|
Notes:
|
|
|
|
|
|
|
|
|
|
(1) The Human Monitor is NOT an stable interface, this means that command
|
|
|
|
|
names, arguments and responses can change or be removed at ANY time.
|
|
|
|
|
Applications that rely on long term stability guarantees should NOT
|
|
|
|
|
use this command
|
|
|
|
|
|
|
|
|
|
(2) Limitations:
|
|
|
|
|
|
|
|
|
|
o This command is stateless, this means that commands that depend
|
|
|
|
|
on state information (such as getfd) might not work
|
|
|
|
|
|
|
|
|
|
o Commands that prompt the user for data (eg. 'cont' when the block
|
|
|
|
|
device is encrypted) don't currently work
|
|
|
|
|
|
2010-09-13 19:26:00 +04:00
|
|
|
|
3. Query Commands
|
|
|
|
|
=================
|
|
|
|
|
|
|
|
|
|
HXCOMM Each query command below is inside a SQMP/EQMP section, do NOT change
|
|
|
|
|
HXCOMM this! We will possibly move query commands definitions inside those
|
|
|
|
|
HXCOMM sections, just like regular commands.
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
query-version
|
|
|
|
|
-------------
|
|
|
|
|
|
|
|
|
|
Show QEMU version.
|
|
|
|
|
|
|
|
|
|
Return a json-object with the following information:
|
|
|
|
|
|
|
|
|
|
- "qemu": A json-object containing three integer values:
|
|
|
|
|
- "major": QEMU's major version (json-int)
|
|
|
|
|
- "minor": QEMU's minor version (json-int)
|
|
|
|
|
- "micro": QEMU's micro version (json-int)
|
|
|
|
|
- "package": package's version (json-string)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "query-version" }
|
|
|
|
|
<- {
|
|
|
|
|
"return":{
|
|
|
|
|
"qemu":{
|
|
|
|
|
"major":0,
|
|
|
|
|
"minor":11,
|
|
|
|
|
"micro":5
|
|
|
|
|
},
|
|
|
|
|
"package":""
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
2011-08-27 00:38:13 +04:00
|
|
|
|
{
|
|
|
|
|
.name = "query-version",
|
|
|
|
|
.args_type = "",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_query_version,
|
|
|
|
|
},
|
|
|
|
|
|
2010-09-13 19:26:00 +04:00
|
|
|
|
SQMP
|
|
|
|
|
query-commands
|
|
|
|
|
--------------
|
|
|
|
|
|
|
|
|
|
List QMP available commands.
|
|
|
|
|
|
|
|
|
|
Each command is represented by a json-object, the returned value is a json-array
|
|
|
|
|
of all commands.
|
|
|
|
|
|
|
|
|
|
Each json-object contain:
|
|
|
|
|
|
|
|
|
|
- "name": command's name (json-string)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "query-commands" }
|
|
|
|
|
<- {
|
|
|
|
|
"return":[
|
|
|
|
|
{
|
|
|
|
|
"name":"query-balloon"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"name":"system_powerdown"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
Note: This example has been shortened as the real response is too long.
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
2011-09-21 21:31:51 +04:00
|
|
|
|
{
|
|
|
|
|
.name = "query-commands",
|
|
|
|
|
.args_type = "",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_query_commands,
|
|
|
|
|
},
|
|
|
|
|
|
2012-05-21 20:59:51 +04:00
|
|
|
|
SQMP
|
|
|
|
|
query-events
|
|
|
|
|
--------------
|
|
|
|
|
|
|
|
|
|
List QMP available events.
|
|
|
|
|
|
|
|
|
|
Each event is represented by a json-object, the returned value is a json-array
|
|
|
|
|
of all events.
|
|
|
|
|
|
|
|
|
|
Each json-object contains:
|
|
|
|
|
|
|
|
|
|
- "name": event's name (json-string)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "query-events" }
|
|
|
|
|
<- {
|
|
|
|
|
"return":[
|
|
|
|
|
{
|
|
|
|
|
"name":"SHUTDOWN"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"name":"RESET"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
Note: This example has been shortened as the real response is too long.
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "query-events",
|
|
|
|
|
.args_type = "",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_query_events,
|
|
|
|
|
},
|
|
|
|
|
|
2010-09-13 19:26:00 +04:00
|
|
|
|
SQMP
|
|
|
|
|
query-chardev
|
|
|
|
|
-------------
|
|
|
|
|
|
|
|
|
|
Each device is represented by a json-object. The returned value is a json-array
|
|
|
|
|
of all devices.
|
|
|
|
|
|
|
|
|
|
Each json-object contain the following:
|
|
|
|
|
|
|
|
|
|
- "label": device's label (json-string)
|
|
|
|
|
- "filename": device's file (json-string)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "query-chardev" }
|
|
|
|
|
<- {
|
|
|
|
|
"return":[
|
|
|
|
|
{
|
|
|
|
|
"label":"monitor",
|
|
|
|
|
"filename":"stdio"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"label":"serial0",
|
|
|
|
|
"filename":"vc"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
2011-09-14 23:05:49 +04:00
|
|
|
|
{
|
|
|
|
|
.name = "query-chardev",
|
|
|
|
|
.args_type = "",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_query_chardev,
|
|
|
|
|
},
|
|
|
|
|
|
2014-02-01 15:52:42 +04:00
|
|
|
|
SQMP
|
|
|
|
|
query-chardev-backends
|
|
|
|
|
-------------
|
|
|
|
|
|
|
|
|
|
List available character device backends.
|
|
|
|
|
|
|
|
|
|
Each backend is represented by a json-object, the returned value is a json-array
|
|
|
|
|
of all backends.
|
|
|
|
|
|
|
|
|
|
Each json-object contains:
|
|
|
|
|
|
|
|
|
|
- "name": backend name (json-string)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "query-chardev-backends" }
|
|
|
|
|
<- {
|
|
|
|
|
"return":[
|
|
|
|
|
{
|
|
|
|
|
"name":"udp"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"name":"tcp"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"name":"unix"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"name":"spiceport"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "query-chardev-backends",
|
|
|
|
|
.args_type = "",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_query_chardev_backends,
|
|
|
|
|
},
|
|
|
|
|
|
2010-09-13 19:26:00 +04:00
|
|
|
|
SQMP
|
|
|
|
|
query-block
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
Show the block devices.
|
|
|
|
|
|
|
|
|
|
Each block device information is stored in a json-object and the returned value
|
|
|
|
|
is a json-array of all devices.
|
|
|
|
|
|
|
|
|
|
Each json-object contain the following:
|
|
|
|
|
|
|
|
|
|
- "device": device name (json-string)
|
|
|
|
|
- "type": device type (json-string)
|
2011-05-16 17:04:55 +04:00
|
|
|
|
- deprecated, retained for backward compatibility
|
|
|
|
|
- Possible values: "unknown"
|
2010-09-13 19:26:00 +04:00
|
|
|
|
- "removable": true if the device is removable, false otherwise (json-bool)
|
|
|
|
|
- "locked": true if the device is locked, false otherwise (json-bool)
|
2013-01-29 20:58:41 +04:00
|
|
|
|
- "tray_open": only present if removable, true if the device has a tray,
|
2011-09-06 20:58:53 +04:00
|
|
|
|
and it is open (json-bool)
|
2010-09-13 19:26:00 +04:00
|
|
|
|
- "inserted": only present if the device is inserted, it is a json-object
|
|
|
|
|
containing the following:
|
|
|
|
|
- "file": device file name (json-string)
|
|
|
|
|
- "ro": true if read-only, false otherwise (json-bool)
|
|
|
|
|
- "drv": driver format name (json-string)
|
|
|
|
|
- Possible values: "blkdebug", "bochs", "cloop", "cow", "dmg",
|
|
|
|
|
"file", "file", "ftp", "ftps", "host_cdrom",
|
|
|
|
|
"host_device", "host_floppy", "http", "https",
|
|
|
|
|
"nbd", "parallels", "qcow", "qcow2", "raw",
|
|
|
|
|
"tftp", "vdi", "vmdk", "vpc", "vvfat"
|
|
|
|
|
- "backing_file": backing file name (json-string, optional)
|
2012-08-02 12:22:48 +04:00
|
|
|
|
- "backing_file_depth": number of files in the backing file chain (json-int)
|
2010-09-13 19:26:00 +04:00
|
|
|
|
- "encrypted": true if encrypted, false otherwise (json-bool)
|
2011-11-08 09:00:31 +04:00
|
|
|
|
- "bps": limit total bytes per second (json-int)
|
|
|
|
|
- "bps_rd": limit read bytes per second (json-int)
|
|
|
|
|
- "bps_wr": limit write bytes per second (json-int)
|
|
|
|
|
- "iops": limit total I/O operations per second (json-int)
|
|
|
|
|
- "iops_rd": limit read operations per second (json-int)
|
|
|
|
|
- "iops_wr": limit write operations per second (json-int)
|
2013-09-02 16:14:40 +04:00
|
|
|
|
- "bps_max": total max in bytes (json-int)
|
|
|
|
|
- "bps_rd_max": read max in bytes (json-int)
|
|
|
|
|
- "bps_wr_max": write max in bytes (json-int)
|
|
|
|
|
- "iops_max": total I/O operations max (json-int)
|
|
|
|
|
- "iops_rd_max": read I/O operations max (json-int)
|
|
|
|
|
- "iops_wr_max": write I/O operations max (json-int)
|
2013-09-02 16:14:41 +04:00
|
|
|
|
- "iops_size": I/O size when limiting by iops (json-int)
|
2014-05-18 02:58:19 +04:00
|
|
|
|
- "detect_zeroes": detect and optimize zero writing (json-string)
|
|
|
|
|
- Possible values: "off", "on", "unmap"
|
2013-06-06 08:27:59 +04:00
|
|
|
|
- "image": the detail of the image, it is a json-object containing
|
|
|
|
|
the following:
|
|
|
|
|
- "filename": image file name (json-string)
|
|
|
|
|
- "format": image format (json-string)
|
|
|
|
|
- "virtual-size": image capacity in bytes (json-int)
|
|
|
|
|
- "dirty-flag": true if image is not cleanly closed, not present
|
|
|
|
|
means clean (json-bool, optional)
|
|
|
|
|
- "actual-size": actual size on disk in bytes of the image, not
|
|
|
|
|
present when image does not support thin
|
|
|
|
|
provision (json-int, optional)
|
|
|
|
|
- "cluster-size": size of a cluster in bytes, not present if image
|
|
|
|
|
format does not support it (json-int, optional)
|
|
|
|
|
- "encrypted": true if the image is encrypted, not present means
|
|
|
|
|
false or the image format does not support
|
|
|
|
|
encryption (json-bool, optional)
|
|
|
|
|
- "backing_file": backing file name, not present means no backing
|
|
|
|
|
file is used or the image format does not
|
|
|
|
|
support backing file chain
|
|
|
|
|
(json-string, optional)
|
|
|
|
|
- "full-backing-filename": full path of the backing file, not
|
|
|
|
|
present if it equals backing_file or no
|
|
|
|
|
backing file is used
|
|
|
|
|
(json-string, optional)
|
|
|
|
|
- "backing-filename-format": the format of the backing file, not
|
|
|
|
|
present means unknown or no backing
|
|
|
|
|
file (json-string, optional)
|
|
|
|
|
- "snapshots": the internal snapshot info, it is an optional list
|
|
|
|
|
of json-object containing the following:
|
|
|
|
|
- "id": unique snapshot id (json-string)
|
|
|
|
|
- "name": snapshot name (json-string)
|
|
|
|
|
- "vm-state-size": size of the VM state in bytes (json-int)
|
|
|
|
|
- "date-sec": UTC date of the snapshot in seconds (json-int)
|
|
|
|
|
- "date-nsec": fractional part in nanoseconds to be used with
|
2013-08-31 00:44:11 +04:00
|
|
|
|
date-sec (json-int)
|
2013-06-06 08:27:59 +04:00
|
|
|
|
- "vm-clock-sec": VM clock relative to boot in seconds
|
|
|
|
|
(json-int)
|
|
|
|
|
- "vm-clock-nsec": fractional part in nanoseconds to be used
|
|
|
|
|
with vm-clock-sec (json-int)
|
|
|
|
|
- "backing-image": the detail of the backing image, it is an
|
|
|
|
|
optional json-object only present when a
|
|
|
|
|
backing image present for this image
|
2011-11-08 09:00:31 +04:00
|
|
|
|
|
2011-09-27 00:43:54 +04:00
|
|
|
|
- "io-status": I/O operation status, only present if the device supports it
|
|
|
|
|
and the VM is configured to stop on errors. It's always reset
|
|
|
|
|
to "ok" when the "cont" command is issued (json_string, optional)
|
|
|
|
|
- Possible values: "ok", "failed", "nospace"
|
2010-09-13 19:26:00 +04:00
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "query-block" }
|
|
|
|
|
<- {
|
|
|
|
|
"return":[
|
|
|
|
|
{
|
2011-09-27 00:43:54 +04:00
|
|
|
|
"io-status": "ok",
|
2010-09-13 19:26:00 +04:00
|
|
|
|
"device":"ide0-hd0",
|
|
|
|
|
"locked":false,
|
|
|
|
|
"removable":false,
|
|
|
|
|
"inserted":{
|
|
|
|
|
"ro":false,
|
|
|
|
|
"drv":"qcow2",
|
|
|
|
|
"encrypted":false,
|
2013-06-06 08:27:59 +04:00
|
|
|
|
"file":"disks/test.qcow2",
|
|
|
|
|
"backing_file_depth":1,
|
2011-11-08 09:00:31 +04:00
|
|
|
|
"bps":1000000,
|
|
|
|
|
"bps_rd":0,
|
|
|
|
|
"bps_wr":0,
|
|
|
|
|
"iops":1000000,
|
|
|
|
|
"iops_rd":0,
|
|
|
|
|
"iops_wr":0,
|
2013-09-02 16:14:40 +04:00
|
|
|
|
"bps_max": 8000000,
|
|
|
|
|
"bps_rd_max": 0,
|
|
|
|
|
"bps_wr_max": 0,
|
|
|
|
|
"iops_max": 0,
|
|
|
|
|
"iops_rd_max": 0,
|
|
|
|
|
"iops_wr_max": 0,
|
2013-09-02 16:14:41 +04:00
|
|
|
|
"iops_size": 0,
|
2014-05-18 02:58:19 +04:00
|
|
|
|
"detect_zeroes": "on",
|
2013-06-06 08:27:59 +04:00
|
|
|
|
"image":{
|
|
|
|
|
"filename":"disks/test.qcow2",
|
|
|
|
|
"format":"qcow2",
|
|
|
|
|
"virtual-size":2048000,
|
|
|
|
|
"backing_file":"base.qcow2",
|
|
|
|
|
"full-backing-filename":"disks/base.qcow2",
|
|
|
|
|
"backing-filename-format:"qcow2",
|
|
|
|
|
"snapshots":[
|
|
|
|
|
{
|
|
|
|
|
"id": "1",
|
|
|
|
|
"name": "snapshot1",
|
|
|
|
|
"vm-state-size": 0,
|
|
|
|
|
"date-sec": 10000200,
|
|
|
|
|
"date-nsec": 12,
|
|
|
|
|
"vm-clock-sec": 206,
|
|
|
|
|
"vm-clock-nsec": 30
|
|
|
|
|
}
|
|
|
|
|
],
|
|
|
|
|
"backing-image":{
|
|
|
|
|
"filename":"disks/base.qcow2",
|
|
|
|
|
"format":"qcow2",
|
|
|
|
|
"virtual-size":2048000
|
|
|
|
|
}
|
|
|
|
|
}
|
2010-09-13 19:26:00 +04:00
|
|
|
|
},
|
2011-05-16 17:04:55 +04:00
|
|
|
|
"type":"unknown"
|
2010-09-13 19:26:00 +04:00
|
|
|
|
},
|
|
|
|
|
{
|
2011-09-27 00:43:54 +04:00
|
|
|
|
"io-status": "ok",
|
2010-09-13 19:26:00 +04:00
|
|
|
|
"device":"ide1-cd0",
|
|
|
|
|
"locked":false,
|
|
|
|
|
"removable":true,
|
2011-05-16 17:04:55 +04:00
|
|
|
|
"type":"unknown"
|
2010-09-13 19:26:00 +04:00
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"device":"floppy0",
|
|
|
|
|
"locked":false,
|
|
|
|
|
"removable":true,
|
2011-05-16 17:04:55 +04:00
|
|
|
|
"type":"unknown"
|
2010-09-13 19:26:00 +04:00
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"device":"sd0",
|
|
|
|
|
"locked":false,
|
|
|
|
|
"removable":true,
|
2011-05-16 17:04:55 +04:00
|
|
|
|
"type":"unknown"
|
2010-09-13 19:26:00 +04:00
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
2011-09-22 00:16:47 +04:00
|
|
|
|
{
|
|
|
|
|
.name = "query-block",
|
|
|
|
|
.args_type = "",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_query_block,
|
|
|
|
|
},
|
|
|
|
|
|
2010-09-13 19:26:00 +04:00
|
|
|
|
SQMP
|
|
|
|
|
query-blockstats
|
|
|
|
|
----------------
|
|
|
|
|
|
|
|
|
|
Show block device statistics.
|
|
|
|
|
|
|
|
|
|
Each device statistic information is stored in a json-object and the returned
|
|
|
|
|
value is a json-array of all devices.
|
|
|
|
|
|
|
|
|
|
Each json-object contain the following:
|
|
|
|
|
|
|
|
|
|
- "device": device name (json-string)
|
|
|
|
|
- "stats": A json-object with the statistics information, it contains:
|
|
|
|
|
- "rd_bytes": bytes read (json-int)
|
|
|
|
|
- "wr_bytes": bytes written (json-int)
|
|
|
|
|
- "rd_operations": read operations (json-int)
|
|
|
|
|
- "wr_operations": write operations (json-int)
|
2011-08-22 02:25:58 +04:00
|
|
|
|
- "flush_operations": cache flush operations (json-int)
|
2011-08-25 10:26:10 +04:00
|
|
|
|
- "wr_total_time_ns": total time spend on writes in nano-seconds (json-int)
|
|
|
|
|
- "rd_total_time_ns": total time spend on reads in nano-seconds (json-int)
|
|
|
|
|
- "flush_total_time_ns": total time spend on cache flushes in nano-seconds (json-int)
|
2010-09-13 19:26:00 +04:00
|
|
|
|
- "wr_highest_offset": Highest offset of a sector written since the
|
|
|
|
|
BlockDriverState has been opened (json-int)
|
|
|
|
|
- "parent": Contains recursively the statistics of the underlying
|
|
|
|
|
protocol (e.g. the host file for a qcow2 image). If there is
|
|
|
|
|
no underlying protocol, this field is omitted
|
|
|
|
|
(json-object, optional)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "query-blockstats" }
|
|
|
|
|
<- {
|
|
|
|
|
"return":[
|
|
|
|
|
{
|
|
|
|
|
"device":"ide0-hd0",
|
|
|
|
|
"parent":{
|
|
|
|
|
"stats":{
|
|
|
|
|
"wr_highest_offset":3686448128,
|
|
|
|
|
"wr_bytes":9786368,
|
|
|
|
|
"wr_operations":751,
|
|
|
|
|
"rd_bytes":122567168,
|
|
|
|
|
"rd_operations":36772
|
2011-08-25 10:26:10 +04:00
|
|
|
|
"wr_total_times_ns":313253456
|
|
|
|
|
"rd_total_times_ns":3465673657
|
|
|
|
|
"flush_total_times_ns":49653
|
2011-08-22 02:25:58 +04:00
|
|
|
|
"flush_operations":61,
|
2010-09-13 19:26:00 +04:00
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
"stats":{
|
|
|
|
|
"wr_highest_offset":2821110784,
|
|
|
|
|
"wr_bytes":9786368,
|
|
|
|
|
"wr_operations":692,
|
|
|
|
|
"rd_bytes":122739200,
|
|
|
|
|
"rd_operations":36604
|
2011-08-22 02:25:58 +04:00
|
|
|
|
"flush_operations":51,
|
2011-08-25 10:26:10 +04:00
|
|
|
|
"wr_total_times_ns":313253456
|
|
|
|
|
"rd_total_times_ns":3465673657
|
|
|
|
|
"flush_total_times_ns":49653
|
2010-09-13 19:26:00 +04:00
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"device":"ide1-cd0",
|
|
|
|
|
"stats":{
|
|
|
|
|
"wr_highest_offset":0,
|
|
|
|
|
"wr_bytes":0,
|
|
|
|
|
"wr_operations":0,
|
|
|
|
|
"rd_bytes":0,
|
|
|
|
|
"rd_operations":0
|
2011-08-22 02:25:58 +04:00
|
|
|
|
"flush_operations":0,
|
2011-08-25 10:26:10 +04:00
|
|
|
|
"wr_total_times_ns":0
|
|
|
|
|
"rd_total_times_ns":0
|
|
|
|
|
"flush_total_times_ns":0
|
2010-09-13 19:26:00 +04:00
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"device":"floppy0",
|
|
|
|
|
"stats":{
|
|
|
|
|
"wr_highest_offset":0,
|
|
|
|
|
"wr_bytes":0,
|
|
|
|
|
"wr_operations":0,
|
|
|
|
|
"rd_bytes":0,
|
|
|
|
|
"rd_operations":0
|
2011-08-22 02:25:58 +04:00
|
|
|
|
"flush_operations":0,
|
2011-08-25 10:26:10 +04:00
|
|
|
|
"wr_total_times_ns":0
|
|
|
|
|
"rd_total_times_ns":0
|
|
|
|
|
"flush_total_times_ns":0
|
2010-09-13 19:26:00 +04:00
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"device":"sd0",
|
|
|
|
|
"stats":{
|
|
|
|
|
"wr_highest_offset":0,
|
|
|
|
|
"wr_bytes":0,
|
|
|
|
|
"wr_operations":0,
|
|
|
|
|
"rd_bytes":0,
|
|
|
|
|
"rd_operations":0
|
2011-08-22 02:25:58 +04:00
|
|
|
|
"flush_operations":0,
|
2011-08-25 10:26:10 +04:00
|
|
|
|
"wr_total_times_ns":0
|
|
|
|
|
"rd_total_times_ns":0
|
|
|
|
|
"flush_total_times_ns":0
|
2010-09-13 19:26:00 +04:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
2011-09-22 22:56:36 +04:00
|
|
|
|
{
|
|
|
|
|
.name = "query-blockstats",
|
|
|
|
|
.args_type = "",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_query_blockstats,
|
|
|
|
|
},
|
|
|
|
|
|
2010-09-13 19:26:00 +04:00
|
|
|
|
SQMP
|
|
|
|
|
query-cpus
|
|
|
|
|
----------
|
|
|
|
|
|
|
|
|
|
Show CPU information.
|
|
|
|
|
|
|
|
|
|
Return a json-array. Each CPU is represented by a json-object, which contains:
|
|
|
|
|
|
|
|
|
|
- "CPU": CPU index (json-int)
|
|
|
|
|
- "current": true if this is the current CPU, false otherwise (json-bool)
|
|
|
|
|
- "halted": true if the cpu is halted, false otherwise (json-bool)
|
|
|
|
|
- Current program counter. The key's name depends on the architecture:
|
|
|
|
|
"pc": i386/x86_64 (json-int)
|
|
|
|
|
"nip": PPC (json-int)
|
|
|
|
|
"pc" and "npc": sparc (json-int)
|
|
|
|
|
"PC": mips (json-int)
|
2011-03-15 14:26:31 +03:00
|
|
|
|
- "thread_id": ID of the underlying host thread (json-int)
|
2010-09-13 19:26:00 +04:00
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "query-cpus" }
|
|
|
|
|
<- {
|
|
|
|
|
"return":[
|
|
|
|
|
{
|
|
|
|
|
"CPU":0,
|
|
|
|
|
"current":true,
|
|
|
|
|
"halted":false,
|
|
|
|
|
"pc":3227107138
|
2011-03-15 14:26:31 +03:00
|
|
|
|
"thread_id":3134
|
2010-09-13 19:26:00 +04:00
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"CPU":1,
|
|
|
|
|
"current":false,
|
|
|
|
|
"halted":true,
|
|
|
|
|
"pc":7108165
|
2011-03-15 14:26:31 +03:00
|
|
|
|
"thread_id":3135
|
2010-09-13 19:26:00 +04:00
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
2011-09-21 23:38:35 +04:00
|
|
|
|
{
|
|
|
|
|
.name = "query-cpus",
|
|
|
|
|
.args_type = "",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_query_cpus,
|
|
|
|
|
},
|
|
|
|
|
|
2014-02-27 14:48:42 +04:00
|
|
|
|
SQMP
|
|
|
|
|
query-iothreads
|
|
|
|
|
---------------
|
|
|
|
|
|
|
|
|
|
Returns a list of information about each iothread.
|
|
|
|
|
|
|
|
|
|
Note this list excludes the QEMU main loop thread, which is not declared
|
|
|
|
|
using the -object iothread command-line option. It is always the main thread
|
|
|
|
|
of the process.
|
|
|
|
|
|
|
|
|
|
Return a json-array. Each iothread is represented by a json-object, which contains:
|
|
|
|
|
|
|
|
|
|
- "id": name of iothread (json-str)
|
|
|
|
|
- "thread-id": ID of the underlying host thread (json-int)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "query-iothreads" }
|
|
|
|
|
<- {
|
|
|
|
|
"return":[
|
|
|
|
|
{
|
|
|
|
|
"id":"iothread0",
|
|
|
|
|
"thread-id":3134
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"id":"iothread1",
|
|
|
|
|
"thread-id":3135
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "query-iothreads",
|
|
|
|
|
.args_type = "",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_query_iothreads,
|
|
|
|
|
},
|
|
|
|
|
|
2010-09-13 19:26:00 +04:00
|
|
|
|
SQMP
|
|
|
|
|
query-pci
|
|
|
|
|
---------
|
|
|
|
|
|
|
|
|
|
PCI buses and devices information.
|
|
|
|
|
|
|
|
|
|
The returned value is a json-array of all buses. Each bus is represented by
|
|
|
|
|
a json-object, which has a key with a json-array of all PCI devices attached
|
|
|
|
|
to it. Each device is represented by a json-object.
|
|
|
|
|
|
|
|
|
|
The bus json-object contains the following:
|
|
|
|
|
|
|
|
|
|
- "bus": bus number (json-int)
|
|
|
|
|
- "devices": a json-array of json-objects, each json-object represents a
|
|
|
|
|
PCI device
|
|
|
|
|
|
|
|
|
|
The PCI device json-object contains the following:
|
|
|
|
|
|
|
|
|
|
- "bus": identical to the parent's bus number (json-int)
|
|
|
|
|
- "slot": slot number (json-int)
|
|
|
|
|
- "function": function number (json-int)
|
|
|
|
|
- "class_info": a json-object containing:
|
|
|
|
|
- "desc": device class description (json-string, optional)
|
|
|
|
|
- "class": device class number (json-int)
|
|
|
|
|
- "id": a json-object containing:
|
|
|
|
|
- "device": device ID (json-int)
|
|
|
|
|
- "vendor": vendor ID (json-int)
|
|
|
|
|
- "irq": device's IRQ if assigned (json-int, optional)
|
|
|
|
|
- "qdev_id": qdev id string (json-string)
|
|
|
|
|
- "pci_bridge": It's a json-object, only present if this device is a
|
|
|
|
|
PCI bridge, contains:
|
|
|
|
|
- "bus": bus number (json-int)
|
|
|
|
|
- "secondary": secondary bus number (json-int)
|
|
|
|
|
- "subordinate": subordinate bus number (json-int)
|
|
|
|
|
- "io_range": I/O memory range information, a json-object with the
|
|
|
|
|
following members:
|
|
|
|
|
- "base": base address, in bytes (json-int)
|
|
|
|
|
- "limit": limit address, in bytes (json-int)
|
|
|
|
|
- "memory_range": memory range information, a json-object with the
|
|
|
|
|
following members:
|
|
|
|
|
- "base": base address, in bytes (json-int)
|
|
|
|
|
- "limit": limit address, in bytes (json-int)
|
|
|
|
|
- "prefetchable_range": Prefetchable memory range information, a
|
|
|
|
|
json-object with the following members:
|
|
|
|
|
- "base": base address, in bytes (json-int)
|
|
|
|
|
- "limit": limit address, in bytes (json-int)
|
|
|
|
|
- "devices": a json-array of PCI devices if there's any attached, each
|
|
|
|
|
each element is represented by a json-object, which contains
|
|
|
|
|
the same members of the 'PCI device json-object' described
|
|
|
|
|
above (optional)
|
|
|
|
|
- "regions": a json-array of json-objects, each json-object represents a
|
|
|
|
|
memory region of this device
|
|
|
|
|
|
|
|
|
|
The memory range json-object contains the following:
|
|
|
|
|
|
|
|
|
|
- "base": base memory address (json-int)
|
|
|
|
|
- "limit": limit value (json-int)
|
|
|
|
|
|
|
|
|
|
The region json-object can be an I/O region or a memory region, an I/O region
|
|
|
|
|
json-object contains the following:
|
|
|
|
|
|
|
|
|
|
- "type": "io" (json-string, fixed)
|
|
|
|
|
- "bar": BAR number (json-int)
|
|
|
|
|
- "address": memory address (json-int)
|
|
|
|
|
- "size": memory size (json-int)
|
|
|
|
|
|
|
|
|
|
A memory region json-object contains the following:
|
|
|
|
|
|
|
|
|
|
- "type": "memory" (json-string, fixed)
|
|
|
|
|
- "bar": BAR number (json-int)
|
|
|
|
|
- "address": memory address (json-int)
|
|
|
|
|
- "size": memory size (json-int)
|
|
|
|
|
- "mem_type_64": true or false (json-bool)
|
|
|
|
|
- "prefetch": true or false (json-bool)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "query-pci" }
|
|
|
|
|
<- {
|
|
|
|
|
"return":[
|
|
|
|
|
{
|
|
|
|
|
"bus":0,
|
|
|
|
|
"devices":[
|
|
|
|
|
{
|
|
|
|
|
"bus":0,
|
|
|
|
|
"qdev_id":"",
|
|
|
|
|
"slot":0,
|
|
|
|
|
"class_info":{
|
|
|
|
|
"class":1536,
|
|
|
|
|
"desc":"Host bridge"
|
|
|
|
|
},
|
|
|
|
|
"id":{
|
|
|
|
|
"device":32902,
|
|
|
|
|
"vendor":4663
|
|
|
|
|
},
|
|
|
|
|
"function":0,
|
|
|
|
|
"regions":[
|
|
|
|
|
|
|
|
|
|
]
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"bus":0,
|
|
|
|
|
"qdev_id":"",
|
|
|
|
|
"slot":1,
|
|
|
|
|
"class_info":{
|
|
|
|
|
"class":1537,
|
|
|
|
|
"desc":"ISA bridge"
|
|
|
|
|
},
|
|
|
|
|
"id":{
|
|
|
|
|
"device":32902,
|
|
|
|
|
"vendor":28672
|
|
|
|
|
},
|
|
|
|
|
"function":0,
|
|
|
|
|
"regions":[
|
|
|
|
|
|
|
|
|
|
]
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"bus":0,
|
|
|
|
|
"qdev_id":"",
|
|
|
|
|
"slot":1,
|
|
|
|
|
"class_info":{
|
|
|
|
|
"class":257,
|
|
|
|
|
"desc":"IDE controller"
|
|
|
|
|
},
|
|
|
|
|
"id":{
|
|
|
|
|
"device":32902,
|
|
|
|
|
"vendor":28688
|
|
|
|
|
},
|
|
|
|
|
"function":1,
|
|
|
|
|
"regions":[
|
|
|
|
|
{
|
|
|
|
|
"bar":4,
|
|
|
|
|
"size":16,
|
|
|
|
|
"address":49152,
|
|
|
|
|
"type":"io"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"bus":0,
|
|
|
|
|
"qdev_id":"",
|
|
|
|
|
"slot":2,
|
|
|
|
|
"class_info":{
|
|
|
|
|
"class":768,
|
|
|
|
|
"desc":"VGA controller"
|
|
|
|
|
},
|
|
|
|
|
"id":{
|
|
|
|
|
"device":4115,
|
|
|
|
|
"vendor":184
|
|
|
|
|
},
|
|
|
|
|
"function":0,
|
|
|
|
|
"regions":[
|
|
|
|
|
{
|
|
|
|
|
"prefetch":true,
|
|
|
|
|
"mem_type_64":false,
|
|
|
|
|
"bar":0,
|
|
|
|
|
"size":33554432,
|
|
|
|
|
"address":4026531840,
|
|
|
|
|
"type":"memory"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"prefetch":false,
|
|
|
|
|
"mem_type_64":false,
|
|
|
|
|
"bar":1,
|
|
|
|
|
"size":4096,
|
|
|
|
|
"address":4060086272,
|
|
|
|
|
"type":"memory"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"prefetch":false,
|
|
|
|
|
"mem_type_64":false,
|
|
|
|
|
"bar":6,
|
|
|
|
|
"size":65536,
|
|
|
|
|
"address":-1,
|
|
|
|
|
"type":"memory"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"bus":0,
|
|
|
|
|
"qdev_id":"",
|
|
|
|
|
"irq":11,
|
|
|
|
|
"slot":4,
|
|
|
|
|
"class_info":{
|
|
|
|
|
"class":1280,
|
|
|
|
|
"desc":"RAM controller"
|
|
|
|
|
},
|
|
|
|
|
"id":{
|
|
|
|
|
"device":6900,
|
|
|
|
|
"vendor":4098
|
|
|
|
|
},
|
|
|
|
|
"function":0,
|
|
|
|
|
"regions":[
|
|
|
|
|
{
|
|
|
|
|
"bar":0,
|
|
|
|
|
"size":32,
|
|
|
|
|
"address":49280,
|
|
|
|
|
"type":"io"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
Note: This example has been shortened as the real response is too long.
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
2011-10-21 20:15:33 +04:00
|
|
|
|
{
|
|
|
|
|
.name = "query-pci",
|
|
|
|
|
.args_type = "",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_query_pci,
|
|
|
|
|
},
|
|
|
|
|
|
2010-09-13 19:26:00 +04:00
|
|
|
|
SQMP
|
|
|
|
|
query-kvm
|
|
|
|
|
---------
|
|
|
|
|
|
|
|
|
|
Show KVM information.
|
|
|
|
|
|
|
|
|
|
Return a json-object with the following information:
|
|
|
|
|
|
|
|
|
|
- "enabled": true if KVM support is enabled, false otherwise (json-bool)
|
|
|
|
|
- "present": true if QEMU has KVM support, false otherwise (json-bool)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "query-kvm" }
|
|
|
|
|
<- { "return": { "enabled": true, "present": true } }
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
2011-09-12 22:10:53 +04:00
|
|
|
|
{
|
|
|
|
|
.name = "query-kvm",
|
|
|
|
|
.args_type = "",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_query_kvm,
|
|
|
|
|
},
|
|
|
|
|
|
2010-09-13 19:26:00 +04:00
|
|
|
|
SQMP
|
|
|
|
|
query-status
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
Return a json-object with the following information:
|
|
|
|
|
|
|
|
|
|
- "running": true if the VM is running, or false if it is paused (json-bool)
|
|
|
|
|
- "singlestep": true if the VM is in single step mode,
|
|
|
|
|
false otherwise (json-bool)
|
2011-08-29 23:02:57 +04:00
|
|
|
|
- "status": one of the following values (json-string)
|
|
|
|
|
"debug" - QEMU is running on a debugger
|
|
|
|
|
"inmigrate" - guest is paused waiting for an incoming migration
|
|
|
|
|
"internal-error" - An internal error that prevents further guest
|
|
|
|
|
execution has occurred
|
|
|
|
|
"io-error" - the last IOP has failed and the device is configured
|
|
|
|
|
to pause on I/O errors
|
|
|
|
|
"paused" - guest has been paused via the 'stop' command
|
|
|
|
|
"postmigrate" - guest is paused following a successful 'migrate'
|
|
|
|
|
"prelaunch" - QEMU was started with -S and guest has not started
|
|
|
|
|
"finish-migrate" - guest is paused to finish the migration process
|
|
|
|
|
"restore-vm" - guest is paused to restore VM state
|
|
|
|
|
"running" - guest is actively running
|
|
|
|
|
"save-vm" - guest is paused to save the VM state
|
|
|
|
|
"shutdown" - guest is shut down (and -no-shutdown is in use)
|
|
|
|
|
"watchdog" - the watchdog action is configured to pause and
|
|
|
|
|
has been triggered
|
2010-09-13 19:26:00 +04:00
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "query-status" }
|
2011-08-29 23:02:57 +04:00
|
|
|
|
<- { "return": { "running": true, "singlestep": false, "status": "running" } }
|
2010-09-13 19:26:00 +04:00
|
|
|
|
|
|
|
|
|
EQMP
|
2011-09-13 00:54:20 +04:00
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "query-status",
|
|
|
|
|
.args_type = "",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_query_status,
|
|
|
|
|
},
|
2010-09-13 19:26:00 +04:00
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
query-mice
|
|
|
|
|
----------
|
|
|
|
|
|
|
|
|
|
Show VM mice information.
|
|
|
|
|
|
|
|
|
|
Each mouse is represented by a json-object, the returned value is a json-array
|
|
|
|
|
of all mice.
|
|
|
|
|
|
|
|
|
|
The mouse json-object contains the following:
|
|
|
|
|
|
|
|
|
|
- "name": mouse's name (json-string)
|
|
|
|
|
- "index": mouse's index (json-int)
|
|
|
|
|
- "current": true if this mouse is receiving events, false otherwise (json-bool)
|
|
|
|
|
- "absolute": true if the mouse generates absolute input events (json-bool)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "query-mice" }
|
|
|
|
|
<- {
|
|
|
|
|
"return":[
|
|
|
|
|
{
|
|
|
|
|
"name":"QEMU Microsoft Mouse",
|
|
|
|
|
"index":0,
|
|
|
|
|
"current":false,
|
|
|
|
|
"absolute":false
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"name":"QEMU PS/2 Mouse",
|
|
|
|
|
"index":1,
|
|
|
|
|
"current":true,
|
|
|
|
|
"absolute":true
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
2011-09-21 22:29:55 +04:00
|
|
|
|
{
|
|
|
|
|
.name = "query-mice",
|
|
|
|
|
.args_type = "",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_query_mice,
|
|
|
|
|
},
|
|
|
|
|
|
2010-09-13 19:26:00 +04:00
|
|
|
|
SQMP
|
|
|
|
|
query-vnc
|
|
|
|
|
---------
|
|
|
|
|
|
|
|
|
|
Show VNC server information.
|
|
|
|
|
|
|
|
|
|
Return a json-object with server information. Connected clients are returned
|
|
|
|
|
as a json-array of json-objects.
|
|
|
|
|
|
|
|
|
|
The main json-object contains the following:
|
|
|
|
|
|
|
|
|
|
- "enabled": true or false (json-bool)
|
|
|
|
|
- "host": server's IP address (json-string)
|
|
|
|
|
- "family": address family (json-string)
|
|
|
|
|
- Possible values: "ipv4", "ipv6", "unix", "unknown"
|
|
|
|
|
- "service": server's port number (json-string)
|
|
|
|
|
- "auth": authentication method (json-string)
|
|
|
|
|
- Possible values: "invalid", "none", "ra2", "ra2ne", "sasl", "tight",
|
|
|
|
|
"tls", "ultra", "unknown", "vencrypt", "vencrypt",
|
|
|
|
|
"vencrypt+plain", "vencrypt+tls+none",
|
|
|
|
|
"vencrypt+tls+plain", "vencrypt+tls+sasl",
|
|
|
|
|
"vencrypt+tls+vnc", "vencrypt+x509+none",
|
|
|
|
|
"vencrypt+x509+plain", "vencrypt+x509+sasl",
|
|
|
|
|
"vencrypt+x509+vnc", "vnc"
|
|
|
|
|
- "clients": a json-array of all connected clients
|
|
|
|
|
|
|
|
|
|
Clients are described by a json-object, each one contain the following:
|
|
|
|
|
|
|
|
|
|
- "host": client's IP address (json-string)
|
|
|
|
|
- "family": address family (json-string)
|
|
|
|
|
- Possible values: "ipv4", "ipv6", "unix", "unknown"
|
|
|
|
|
- "service": client's port number (json-string)
|
|
|
|
|
- "x509_dname": TLS dname (json-string, optional)
|
|
|
|
|
- "sasl_username": SASL username (json-string, optional)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "query-vnc" }
|
|
|
|
|
<- {
|
|
|
|
|
"return":{
|
|
|
|
|
"enabled":true,
|
|
|
|
|
"host":"0.0.0.0",
|
|
|
|
|
"service":"50402",
|
|
|
|
|
"auth":"vnc",
|
|
|
|
|
"family":"ipv4",
|
|
|
|
|
"clients":[
|
|
|
|
|
{
|
|
|
|
|
"host":"127.0.0.1",
|
|
|
|
|
"service":"50401",
|
|
|
|
|
"family":"ipv4"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
2011-10-17 22:41:22 +04:00
|
|
|
|
{
|
|
|
|
|
.name = "query-vnc",
|
|
|
|
|
.args_type = "",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_query_vnc,
|
|
|
|
|
},
|
|
|
|
|
|
2010-11-30 13:02:51 +03:00
|
|
|
|
SQMP
|
|
|
|
|
query-spice
|
|
|
|
|
-----------
|
|
|
|
|
|
|
|
|
|
Show SPICE server information.
|
|
|
|
|
|
|
|
|
|
Return a json-object with server information. Connected clients are returned
|
|
|
|
|
as a json-array of json-objects.
|
|
|
|
|
|
|
|
|
|
The main json-object contains the following:
|
|
|
|
|
|
|
|
|
|
- "enabled": true or false (json-bool)
|
|
|
|
|
- "host": server's IP address (json-string)
|
|
|
|
|
- "port": server's port number (json-int, optional)
|
|
|
|
|
- "tls-port": server's port number (json-int, optional)
|
|
|
|
|
- "auth": authentication method (json-string)
|
|
|
|
|
- Possible values: "none", "spice"
|
|
|
|
|
- "channels": a json-array of all active channels clients
|
|
|
|
|
|
|
|
|
|
Channels are described by a json-object, each one contain the following:
|
|
|
|
|
|
|
|
|
|
- "host": client's IP address (json-string)
|
|
|
|
|
- "family": address family (json-string)
|
|
|
|
|
- Possible values: "ipv4", "ipv6", "unix", "unknown"
|
|
|
|
|
- "port": client's port number (json-string)
|
|
|
|
|
- "connection-id": spice connection id. All channels with the same id
|
|
|
|
|
belong to the same spice session (json-int)
|
|
|
|
|
- "channel-type": channel type. "1" is the main control channel, filter for
|
|
|
|
|
this one if you want track spice sessions only (json-int)
|
|
|
|
|
- "channel-id": channel id. Usually "0", might be different needed when
|
|
|
|
|
multiple channels of the same type exist, such as multiple
|
|
|
|
|
display channels in a multihead setup (json-int)
|
|
|
|
|
- "tls": whevener the channel is encrypted (json-bool)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "query-spice" }
|
|
|
|
|
<- {
|
|
|
|
|
"return": {
|
|
|
|
|
"enabled": true,
|
|
|
|
|
"auth": "spice",
|
|
|
|
|
"port": 5920,
|
|
|
|
|
"tls-port": 5921,
|
|
|
|
|
"host": "0.0.0.0",
|
|
|
|
|
"channels": [
|
|
|
|
|
{
|
|
|
|
|
"port": "54924",
|
|
|
|
|
"family": "ipv4",
|
|
|
|
|
"channel-type": 1,
|
|
|
|
|
"connection-id": 1804289383,
|
|
|
|
|
"host": "127.0.0.1",
|
|
|
|
|
"channel-id": 0,
|
|
|
|
|
"tls": true
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"port": "36710",
|
|
|
|
|
"family": "ipv4",
|
|
|
|
|
"channel-type": 4,
|
|
|
|
|
"connection-id": 1804289383,
|
|
|
|
|
"host": "127.0.0.1",
|
|
|
|
|
"channel-id": 0,
|
|
|
|
|
"tls": false
|
|
|
|
|
},
|
|
|
|
|
[ ... more channels follow ... ]
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
2011-10-20 23:01:33 +04:00
|
|
|
|
#if defined(CONFIG_SPICE)
|
|
|
|
|
{
|
|
|
|
|
.name = "query-spice",
|
|
|
|
|
.args_type = "",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_query_spice,
|
|
|
|
|
},
|
|
|
|
|
#endif
|
|
|
|
|
|
2010-09-13 19:26:00 +04:00
|
|
|
|
SQMP
|
|
|
|
|
query-name
|
|
|
|
|
----------
|
|
|
|
|
|
|
|
|
|
Show VM name.
|
|
|
|
|
|
|
|
|
|
Return a json-object with the following information:
|
|
|
|
|
|
|
|
|
|
- "name": VM's name (json-string, optional)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "query-name" }
|
|
|
|
|
<- { "return": { "name": "qemu-name" } }
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
2011-09-02 21:34:48 +04:00
|
|
|
|
{
|
|
|
|
|
.name = "query-name",
|
|
|
|
|
.args_type = "",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_query_name,
|
|
|
|
|
},
|
|
|
|
|
|
2010-09-13 19:26:00 +04:00
|
|
|
|
SQMP
|
|
|
|
|
query-uuid
|
|
|
|
|
----------
|
|
|
|
|
|
|
|
|
|
Show VM UUID.
|
|
|
|
|
|
|
|
|
|
Return a json-object with the following information:
|
|
|
|
|
|
|
|
|
|
- "UUID": Universally Unique Identifier (json-string)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "query-uuid" }
|
|
|
|
|
<- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } }
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
2011-09-14 00:16:25 +04:00
|
|
|
|
{
|
|
|
|
|
.name = "query-uuid",
|
|
|
|
|
.args_type = "",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_query_uuid,
|
|
|
|
|
},
|
|
|
|
|
|
2013-04-25 13:50:35 +04:00
|
|
|
|
SQMP
|
|
|
|
|
query-command-line-options
|
|
|
|
|
--------------------------
|
|
|
|
|
|
|
|
|
|
Show command line option schema.
|
|
|
|
|
|
|
|
|
|
Return a json-array of command line option schema for all options (or for
|
|
|
|
|
the given option), returning an error if the given option doesn't exist.
|
|
|
|
|
|
|
|
|
|
Each array entry contains the following:
|
|
|
|
|
|
|
|
|
|
- "option": option name (json-string)
|
|
|
|
|
- "parameters": a json-array describes all parameters of the option:
|
|
|
|
|
- "name": parameter name (json-string)
|
|
|
|
|
- "type": parameter type (one of 'string', 'boolean', 'number',
|
|
|
|
|
or 'size')
|
|
|
|
|
- "help": human readable description of the parameter
|
|
|
|
|
(json-string, optional)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "query-command-line-options", "arguments": { "option": "option-rom" } }
|
|
|
|
|
<- { "return": [
|
|
|
|
|
{
|
|
|
|
|
"parameters": [
|
|
|
|
|
{
|
|
|
|
|
"name": "romfile",
|
|
|
|
|
"type": "string"
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
"name": "bootindex",
|
|
|
|
|
"type": "number"
|
|
|
|
|
}
|
|
|
|
|
],
|
|
|
|
|
"option": "option-rom"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "query-command-line-options",
|
|
|
|
|
.args_type = "option:s?",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_query_command_line_options,
|
|
|
|
|
},
|
|
|
|
|
|
2010-09-13 19:26:00 +04:00
|
|
|
|
SQMP
|
|
|
|
|
query-migrate
|
|
|
|
|
-------------
|
|
|
|
|
|
|
|
|
|
Migration status.
|
|
|
|
|
|
|
|
|
|
Return a json-object. If migration is active there will be another json-object
|
|
|
|
|
with RAM migration status and if block migration is active another one with
|
|
|
|
|
block migration status.
|
|
|
|
|
|
|
|
|
|
The main json-object contains the following:
|
|
|
|
|
|
|
|
|
|
- "status": migration status (json-string)
|
2014-05-16 18:40:47 +04:00
|
|
|
|
- Possible values: "setup", "active", "completed", "failed", "cancelled"
|
2012-08-18 15:17:10 +04:00
|
|
|
|
- "total-time": total amount of ms since migration started. If
|
|
|
|
|
migration has ended, it returns the total migration
|
2013-02-11 18:11:10 +04:00
|
|
|
|
time (json-int)
|
2013-08-10 00:05:45 +04:00
|
|
|
|
- "setup-time" amount of setup time in milliseconds _before_ the
|
|
|
|
|
iterations begin but _after_ the QMP command is issued.
|
|
|
|
|
This is designed to provide an accounting of any activities
|
|
|
|
|
(such as RDMA pinning) which may be expensive, but do not
|
|
|
|
|
actually occur during the iterative migration rounds
|
|
|
|
|
themselves. (json-int)
|
2012-08-13 11:35:16 +04:00
|
|
|
|
- "downtime": only present when migration has finished correctly
|
|
|
|
|
total amount in ms for downtime that happened (json-int)
|
2012-08-13 11:53:12 +04:00
|
|
|
|
- "expected-downtime": only present while migration is active
|
|
|
|
|
total amount in ms for downtime that was calculated on
|
2013-02-11 18:11:10 +04:00
|
|
|
|
the last bitmap round (json-int)
|
2010-09-13 19:26:00 +04:00
|
|
|
|
- "ram": only present if "status" is "active", it is a json-object with the
|
2013-02-11 18:11:10 +04:00
|
|
|
|
following RAM information:
|
|
|
|
|
- "transferred": amount transferred in bytes (json-int)
|
|
|
|
|
- "remaining": amount remaining to transfer in bytes (json-int)
|
|
|
|
|
- "total": total amount of memory in bytes (json-int)
|
|
|
|
|
- "duplicate": number of pages filled entirely with the same
|
|
|
|
|
byte (json-int)
|
|
|
|
|
These are sent over the wire much more efficiently.
|
2013-03-26 13:58:37 +04:00
|
|
|
|
- "skipped": number of skipped zero pages (json-int)
|
2013-04-28 13:49:57 +04:00
|
|
|
|
- "normal" : number of whole pages transferred. I.e. they
|
2013-02-11 18:11:10 +04:00
|
|
|
|
were not sent as duplicate or xbzrle pages (json-int)
|
|
|
|
|
- "normal-bytes" : number of bytes transferred in whole
|
|
|
|
|
pages. This is just normal pages times size of one page,
|
|
|
|
|
but this way upper levels don't need to care about page
|
|
|
|
|
size (json-int)
|
2014-04-04 13:57:55 +04:00
|
|
|
|
- "dirty-sync-count": times that dirty ram was synchronized (json-int)
|
2010-09-13 19:26:00 +04:00
|
|
|
|
- "disk": only present if "status" is "active" and it is a block migration,
|
2013-02-11 18:11:10 +04:00
|
|
|
|
it is a json-object with the following disk information:
|
|
|
|
|
- "transferred": amount transferred in bytes (json-int)
|
|
|
|
|
- "remaining": amount remaining to transfer in bytes json-int)
|
|
|
|
|
- "total": total disk size in bytes (json-int)
|
2012-08-06 22:42:57 +04:00
|
|
|
|
- "xbzrle-cache": only present if XBZRLE is active.
|
|
|
|
|
It is a json-object with the following XBZRLE information:
|
2013-02-11 18:11:10 +04:00
|
|
|
|
- "cache-size": XBZRLE cache size in bytes
|
|
|
|
|
- "bytes": number of bytes transferred for XBZRLE compressed pages
|
2012-08-06 22:42:57 +04:00
|
|
|
|
- "pages": number of XBZRLE compressed pages
|
2013-02-11 18:11:10 +04:00
|
|
|
|
- "cache-miss": number of XBRZRLE page cache misses
|
2014-04-04 13:57:56 +04:00
|
|
|
|
- "cache-miss-rate": rate of XBRZRLE page cache misses
|
2013-02-11 18:11:10 +04:00
|
|
|
|
- "overflow": number of times XBZRLE overflows. This means
|
|
|
|
|
that the XBZRLE encoding was bigger than just sent the
|
|
|
|
|
whole page, and then we sent the whole page instead (as as
|
|
|
|
|
normal page).
|
|
|
|
|
|
2010-09-13 19:26:00 +04:00
|
|
|
|
Examples:
|
|
|
|
|
|
|
|
|
|
1. Before the first migration
|
|
|
|
|
|
|
|
|
|
-> { "execute": "query-migrate" }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
|
|
|
|
2. Migration is done and has succeeded
|
|
|
|
|
|
|
|
|
|
-> { "execute": "query-migrate" }
|
2012-08-06 22:42:56 +04:00
|
|
|
|
<- { "return": {
|
|
|
|
|
"status": "completed",
|
|
|
|
|
"ram":{
|
|
|
|
|
"transferred":123,
|
|
|
|
|
"remaining":123,
|
|
|
|
|
"total":246,
|
|
|
|
|
"total-time":12345,
|
2013-08-10 00:05:45 +04:00
|
|
|
|
"setup-time":12345,
|
2012-08-13 11:35:16 +04:00
|
|
|
|
"downtime":12345,
|
2012-08-06 22:42:56 +04:00
|
|
|
|
"duplicate":123,
|
|
|
|
|
"normal":123,
|
2014-04-04 13:57:55 +04:00
|
|
|
|
"normal-bytes":123456,
|
|
|
|
|
"dirty-sync-count":15
|
2012-08-06 22:42:56 +04:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
2010-09-13 19:26:00 +04:00
|
|
|
|
|
|
|
|
|
3. Migration is done and has failed
|
|
|
|
|
|
|
|
|
|
-> { "execute": "query-migrate" }
|
|
|
|
|
<- { "return": { "status": "failed" } }
|
|
|
|
|
|
|
|
|
|
4. Migration is being performed and is not a block migration:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "query-migrate" }
|
|
|
|
|
<- {
|
|
|
|
|
"return":{
|
|
|
|
|
"status":"active",
|
|
|
|
|
"ram":{
|
|
|
|
|
"transferred":123,
|
|
|
|
|
"remaining":123,
|
2012-08-06 22:42:55 +04:00
|
|
|
|
"total":246,
|
2012-08-06 22:42:56 +04:00
|
|
|
|
"total-time":12345,
|
2013-08-10 00:05:45 +04:00
|
|
|
|
"setup-time":12345,
|
2012-08-13 11:53:12 +04:00
|
|
|
|
"expected-downtime":12345,
|
2012-08-06 22:42:56 +04:00
|
|
|
|
"duplicate":123,
|
|
|
|
|
"normal":123,
|
2014-04-04 13:57:55 +04:00
|
|
|
|
"normal-bytes":123456,
|
|
|
|
|
"dirty-sync-count":15
|
2010-09-13 19:26:00 +04:00
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
5. Migration is being performed and is a block migration:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "query-migrate" }
|
|
|
|
|
<- {
|
|
|
|
|
"return":{
|
|
|
|
|
"status":"active",
|
|
|
|
|
"ram":{
|
|
|
|
|
"total":1057024,
|
|
|
|
|
"remaining":1053304,
|
2012-08-06 22:42:55 +04:00
|
|
|
|
"transferred":3720,
|
2012-08-06 22:42:56 +04:00
|
|
|
|
"total-time":12345,
|
2013-08-10 00:05:45 +04:00
|
|
|
|
"setup-time":12345,
|
2012-08-13 11:53:12 +04:00
|
|
|
|
"expected-downtime":12345,
|
2012-08-06 22:42:56 +04:00
|
|
|
|
"duplicate":123,
|
|
|
|
|
"normal":123,
|
2014-04-04 13:57:55 +04:00
|
|
|
|
"normal-bytes":123456,
|
|
|
|
|
"dirty-sync-count":15
|
2010-09-13 19:26:00 +04:00
|
|
|
|
},
|
|
|
|
|
"disk":{
|
|
|
|
|
"total":20971520,
|
|
|
|
|
"remaining":20880384,
|
|
|
|
|
"transferred":91136
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2012-08-06 22:42:57 +04:00
|
|
|
|
6. Migration is being performed and XBZRLE is active:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "query-migrate" }
|
|
|
|
|
<- {
|
|
|
|
|
"return":{
|
|
|
|
|
"status":"active",
|
|
|
|
|
"capabilities" : [ { "capability": "xbzrle", "state" : true } ],
|
|
|
|
|
"ram":{
|
|
|
|
|
"total":1057024,
|
|
|
|
|
"remaining":1053304,
|
|
|
|
|
"transferred":3720,
|
|
|
|
|
"total-time":12345,
|
2013-08-10 00:05:45 +04:00
|
|
|
|
"setup-time":12345,
|
2012-08-13 11:53:12 +04:00
|
|
|
|
"expected-downtime":12345,
|
2012-08-06 22:42:57 +04:00
|
|
|
|
"duplicate":10,
|
|
|
|
|
"normal":3333,
|
2014-04-04 13:57:55 +04:00
|
|
|
|
"normal-bytes":3412992,
|
|
|
|
|
"dirty-sync-count":15
|
2012-08-06 22:42:57 +04:00
|
|
|
|
},
|
|
|
|
|
"xbzrle-cache":{
|
|
|
|
|
"cache-size":67108864,
|
|
|
|
|
"bytes":20971520,
|
|
|
|
|
"pages":2444343,
|
|
|
|
|
"cache-miss":2244,
|
2014-04-04 13:57:56 +04:00
|
|
|
|
"cache-miss-rate":0.123,
|
2012-08-06 22:42:57 +04:00
|
|
|
|
"overflow":34434
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
2010-09-13 19:26:00 +04:00
|
|
|
|
EQMP
|
|
|
|
|
|
2011-09-14 00:37:16 +04:00
|
|
|
|
{
|
|
|
|
|
.name = "query-migrate",
|
|
|
|
|
.args_type = "",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_query_migrate,
|
|
|
|
|
},
|
|
|
|
|
|
2012-08-06 22:42:47 +04:00
|
|
|
|
SQMP
|
2012-08-06 22:42:48 +04:00
|
|
|
|
migrate-set-capabilities
|
2013-02-11 18:11:10 +04:00
|
|
|
|
------------------------
|
2012-08-06 22:42:48 +04:00
|
|
|
|
|
|
|
|
|
Enable/Disable migration capabilities
|
|
|
|
|
|
2013-02-11 18:11:10 +04:00
|
|
|
|
- "xbzrle": XBZRLE support
|
2012-08-06 22:42:48 +04:00
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "migrate-set-capabilities" , "arguments":
|
|
|
|
|
{ "capabilities": [ { "capability": "xbzrle", "state": true } ] } }
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "migrate-set-capabilities",
|
|
|
|
|
.args_type = "capabilities:O",
|
|
|
|
|
.params = "capability:s,state:b",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_migrate_set_capabilities,
|
|
|
|
|
},
|
|
|
|
|
SQMP
|
2012-08-06 22:42:47 +04:00
|
|
|
|
query-migrate-capabilities
|
2013-02-11 18:11:10 +04:00
|
|
|
|
--------------------------
|
2012-08-06 22:42:47 +04:00
|
|
|
|
|
|
|
|
|
Query current migration capabilities
|
|
|
|
|
|
|
|
|
|
- "capabilities": migration capabilities state
|
|
|
|
|
- "xbzrle" : XBZRLE state (json-bool)
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "query-migrate-capabilities" }
|
2013-01-31 11:12:17 +04:00
|
|
|
|
<- { "return": [ { "state": false, "capability": "xbzrle" } ] }
|
|
|
|
|
|
2012-08-06 22:42:47 +04:00
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "query-migrate-capabilities",
|
|
|
|
|
.args_type = "",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_query_migrate_capabilities,
|
|
|
|
|
},
|
|
|
|
|
|
2010-09-13 19:26:00 +04:00
|
|
|
|
SQMP
|
|
|
|
|
query-balloon
|
|
|
|
|
-------------
|
|
|
|
|
|
|
|
|
|
Show balloon information.
|
|
|
|
|
|
|
|
|
|
Make an asynchronous request for balloon info. When the request completes a
|
|
|
|
|
json-object will be returned containing the following data:
|
|
|
|
|
|
|
|
|
|
- "actual": current balloon value in bytes (json-int)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "query-balloon" }
|
|
|
|
|
<- {
|
|
|
|
|
"return":{
|
|
|
|
|
"actual":1073741824,
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
2011-10-21 17:41:37 +04:00
|
|
|
|
{
|
|
|
|
|
.name = "query-balloon",
|
|
|
|
|
.args_type = "",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_query_balloon,
|
|
|
|
|
},
|
2011-12-13 00:29:34 +04:00
|
|
|
|
|
2012-01-18 18:40:49 +04:00
|
|
|
|
{
|
|
|
|
|
.name = "query-block-jobs",
|
|
|
|
|
.args_type = "",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_query_block_jobs,
|
|
|
|
|
},
|
|
|
|
|
|
2011-12-13 00:29:34 +04:00
|
|
|
|
{
|
|
|
|
|
.name = "qom-list",
|
|
|
|
|
.args_type = "path:s",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_qom_list,
|
|
|
|
|
},
|
2011-12-13 00:29:35 +04:00
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "qom-set",
|
2012-03-22 15:51:11 +04:00
|
|
|
|
.args_type = "path:s,property:s,value:q",
|
2011-12-13 00:29:35 +04:00
|
|
|
|
.mhandler.cmd_new = qmp_qom_set,
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "qom-get",
|
|
|
|
|
.args_type = "path:s,property:s",
|
|
|
|
|
.mhandler.cmd_new = qmp_qom_get,
|
|
|
|
|
},
|
2011-12-08 17:45:55 +04:00
|
|
|
|
|
2012-08-22 18:43:07 +04:00
|
|
|
|
{
|
|
|
|
|
.name = "nbd-server-start",
|
|
|
|
|
.args_type = "addr:q",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_nbd_server_start,
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
.name = "nbd-server-add",
|
|
|
|
|
.args_type = "device:B,writable:b?",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_nbd_server_add,
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
.name = "nbd-server-stop",
|
|
|
|
|
.args_type = "",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_nbd_server_stop,
|
|
|
|
|
},
|
|
|
|
|
|
2011-12-08 17:45:55 +04:00
|
|
|
|
{
|
|
|
|
|
.name = "change-vnc-password",
|
|
|
|
|
.args_type = "password:s",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_change_vnc_password,
|
|
|
|
|
},
|
2011-12-23 00:40:54 +04:00
|
|
|
|
{
|
|
|
|
|
.name = "qom-list-types",
|
|
|
|
|
.args_type = "implements:s?,abstract:b?",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_qom_list_types,
|
|
|
|
|
},
|
2012-08-10 20:04:09 +04:00
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "device-list-properties",
|
|
|
|
|
.args_type = "typename:s",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_device_list_properties,
|
|
|
|
|
},
|
|
|
|
|
|
2012-08-10 20:04:11 +04:00
|
|
|
|
{
|
|
|
|
|
.name = "query-machines",
|
|
|
|
|
.args_type = "",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_query_machines,
|
|
|
|
|
},
|
|
|
|
|
|
2012-08-10 20:04:13 +04:00
|
|
|
|
{
|
|
|
|
|
.name = "query-cpu-definitions",
|
|
|
|
|
.args_type = "",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_query_cpu_definitions,
|
|
|
|
|
},
|
|
|
|
|
|
2012-08-20 18:31:38 +04:00
|
|
|
|
{
|
|
|
|
|
.name = "query-target",
|
|
|
|
|
.args_type = "",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_query_target,
|
|
|
|
|
},
|
2012-12-19 13:33:56 +04:00
|
|
|
|
|
Support for TPM command line options
This patch adds support for TPM command line options.
The command line options supported here are
./qemu-... -tpmdev passthrough,path=<path to TPM device>,id=<id>
-device tpm-tis,tpmdev=<id>,id=<other id>
and
./qemu-... -tpmdev help
where the latter works similar to -soundhw help and shows a list of
available TPM backends (for example 'passthrough').
Using the type parameter, the backend is chosen, i.e., 'passthrough' for the
passthrough driver. The interpretation of the other parameters along
with determining whether enough parameters were provided is pushed into
the backend driver, which needs to implement the interface function
'create' and return a TPMDriverOpts structure if the VM can be started or
'NULL' if not enough or bad parameters were provided.
Monitor support for 'info tpm' has been added. It for example prints the
following:
(qemu) info tpm
TPM devices:
tpm0: model=tpm-tis
\ tpm0: type=passthrough,path=/dev/tpm0,cancel-path=/sys/devices/pnp0/00:09/cancel
Signed-off-by: Stefan Berger <stefanb@linux.vnet.ibm.com>
Reviewed-by: Corey Bryant <coreyb@linux.vnet.ibm.com>
Reviewed-by: Joel Schopp <jschopp@linux.vnet.ibm.com>
Message-id: 1361987275-26289-2-git-send-email-stefanb@linux.vnet.ibm.com
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2013-02-27 21:47:49 +04:00
|
|
|
|
{
|
|
|
|
|
.name = "query-tpm",
|
|
|
|
|
.args_type = "",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_query_tpm,
|
|
|
|
|
},
|
|
|
|
|
|
2013-03-20 20:34:49 +04:00
|
|
|
|
SQMP
|
|
|
|
|
query-tpm
|
|
|
|
|
---------
|
|
|
|
|
|
|
|
|
|
Return information about the TPM device.
|
|
|
|
|
|
|
|
|
|
Arguments: None
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "query-tpm" }
|
|
|
|
|
<- { "return":
|
|
|
|
|
[
|
|
|
|
|
{ "model": "tpm-tis",
|
|
|
|
|
"options":
|
|
|
|
|
{ "type": "passthrough",
|
|
|
|
|
"data":
|
|
|
|
|
{ "cancel-path": "/sys/class/misc/tpm0/device/cancel",
|
|
|
|
|
"path": "/dev/tpm0"
|
|
|
|
|
}
|
|
|
|
|
},
|
|
|
|
|
"id": "tpm0"
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
Support for TPM command line options
This patch adds support for TPM command line options.
The command line options supported here are
./qemu-... -tpmdev passthrough,path=<path to TPM device>,id=<id>
-device tpm-tis,tpmdev=<id>,id=<other id>
and
./qemu-... -tpmdev help
where the latter works similar to -soundhw help and shows a list of
available TPM backends (for example 'passthrough').
Using the type parameter, the backend is chosen, i.e., 'passthrough' for the
passthrough driver. The interpretation of the other parameters along
with determining whether enough parameters were provided is pushed into
the backend driver, which needs to implement the interface function
'create' and return a TPMDriverOpts structure if the VM can be started or
'NULL' if not enough or bad parameters were provided.
Monitor support for 'info tpm' has been added. It for example prints the
following:
(qemu) info tpm
TPM devices:
tpm0: model=tpm-tis
\ tpm0: type=passthrough,path=/dev/tpm0,cancel-path=/sys/devices/pnp0/00:09/cancel
Signed-off-by: Stefan Berger <stefanb@linux.vnet.ibm.com>
Reviewed-by: Corey Bryant <coreyb@linux.vnet.ibm.com>
Reviewed-by: Joel Schopp <jschopp@linux.vnet.ibm.com>
Message-id: 1361987275-26289-2-git-send-email-stefanb@linux.vnet.ibm.com
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2013-02-27 21:47:49 +04:00
|
|
|
|
{
|
|
|
|
|
.name = "query-tpm-models",
|
|
|
|
|
.args_type = "",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_query_tpm_models,
|
|
|
|
|
},
|
|
|
|
|
|
2013-03-20 20:34:49 +04:00
|
|
|
|
SQMP
|
|
|
|
|
query-tpm-models
|
|
|
|
|
----------------
|
|
|
|
|
|
|
|
|
|
Return a list of supported TPM models.
|
|
|
|
|
|
|
|
|
|
Arguments: None
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "query-tpm-models" }
|
|
|
|
|
<- { "return": [ "tpm-tis" ] }
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
Support for TPM command line options
This patch adds support for TPM command line options.
The command line options supported here are
./qemu-... -tpmdev passthrough,path=<path to TPM device>,id=<id>
-device tpm-tis,tpmdev=<id>,id=<other id>
and
./qemu-... -tpmdev help
where the latter works similar to -soundhw help and shows a list of
available TPM backends (for example 'passthrough').
Using the type parameter, the backend is chosen, i.e., 'passthrough' for the
passthrough driver. The interpretation of the other parameters along
with determining whether enough parameters were provided is pushed into
the backend driver, which needs to implement the interface function
'create' and return a TPMDriverOpts structure if the VM can be started or
'NULL' if not enough or bad parameters were provided.
Monitor support for 'info tpm' has been added. It for example prints the
following:
(qemu) info tpm
TPM devices:
tpm0: model=tpm-tis
\ tpm0: type=passthrough,path=/dev/tpm0,cancel-path=/sys/devices/pnp0/00:09/cancel
Signed-off-by: Stefan Berger <stefanb@linux.vnet.ibm.com>
Reviewed-by: Corey Bryant <coreyb@linux.vnet.ibm.com>
Reviewed-by: Joel Schopp <jschopp@linux.vnet.ibm.com>
Message-id: 1361987275-26289-2-git-send-email-stefanb@linux.vnet.ibm.com
Signed-off-by: Anthony Liguori <aliguori@us.ibm.com>
2013-02-27 21:47:49 +04:00
|
|
|
|
{
|
|
|
|
|
.name = "query-tpm-types",
|
|
|
|
|
.args_type = "",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_query_tpm_types,
|
|
|
|
|
},
|
|
|
|
|
|
2013-03-20 20:34:49 +04:00
|
|
|
|
SQMP
|
|
|
|
|
query-tpm-types
|
|
|
|
|
---------------
|
|
|
|
|
|
|
|
|
|
Return a list of supported TPM types.
|
|
|
|
|
|
|
|
|
|
Arguments: None
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "query-tpm-types" }
|
|
|
|
|
<- { "return": [ "passthrough" ] }
|
|
|
|
|
|
|
|
|
|
EQMP
|
|
|
|
|
|
2012-12-19 13:33:56 +04:00
|
|
|
|
{
|
|
|
|
|
.name = "chardev-add",
|
|
|
|
|
.args_type = "id:s,backend:q",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_chardev_add,
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
chardev-add
|
|
|
|
|
----------------
|
|
|
|
|
|
|
|
|
|
Add a chardev.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "id": the chardev's ID, must be unique (json-string)
|
|
|
|
|
- "backend": chardev backend type + parameters
|
|
|
|
|
|
2012-12-19 16:13:57 +04:00
|
|
|
|
Examples:
|
2012-12-19 13:33:56 +04:00
|
|
|
|
|
|
|
|
|
-> { "execute" : "chardev-add",
|
|
|
|
|
"arguments" : { "id" : "foo",
|
|
|
|
|
"backend" : { "type" : "null", "data" : {} } } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
2012-12-19 16:13:57 +04:00
|
|
|
|
-> { "execute" : "chardev-add",
|
|
|
|
|
"arguments" : { "id" : "bar",
|
|
|
|
|
"backend" : { "type" : "file",
|
|
|
|
|
"data" : { "out" : "/tmp/bar.log" } } } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
2012-12-20 17:39:13 +04:00
|
|
|
|
-> { "execute" : "chardev-add",
|
|
|
|
|
"arguments" : { "id" : "baz",
|
|
|
|
|
"backend" : { "type" : "pty", "data" : {} } } }
|
|
|
|
|
<- { "return": { "pty" : "/dev/pty/42" } }
|
|
|
|
|
|
2012-12-19 13:33:56 +04:00
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "chardev-remove",
|
|
|
|
|
.args_type = "id:s",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_chardev_remove,
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
chardev-remove
|
|
|
|
|
--------------
|
|
|
|
|
|
|
|
|
|
Remove a chardev.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "id": the chardev's ID, must exist and not be in use (json-string)
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "chardev-remove", "arguments": { "id" : "foo" } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
net: add support of mac-programming over macvtap in QEMU side
Currently macvtap based macvlan device is working in promiscuous
mode, we want to implement mac-programming over macvtap through
Libvirt for better performance.
Design:
QEMU notifies Libvirt when rx-filter config is changed in guest,
then Libvirt query the rx-filter information by a monitor command,
and sync the change to macvtap device. Related rx-filter config
of the nic contains main mac, rx-mode items and vlan table.
This patch adds a QMP event to notify management of rx-filter change,
and adds a monitor command for management to query rx-filter
information.
Test:
If we repeatedly add/remove vlan, and change macaddr of vlan
interfaces in guest by a loop script.
Result:
The events will flood the QMP client(management), management takes
too much resource to process the events.
Event_throttle API (set rate to 1 ms) can avoid the events to flood
QMP client, but it could cause an unexpected delay (~1ms), guests
guests normally expect rx-filter updates immediately.
So we use a flag for each nic to avoid events flooding, the event
is emitted once until the query command is executed. The flag
implementation could not introduce unexpected delay.
There maybe exist an uncontrollable delay if we let Libvirt do the
real change, guests normally expect rx-filter updates immediately.
But it's another separate issue, we can investigate it when the
work in Libvirt side is done.
Michael S. Tsirkin: tweaked to enable events on start
Michael S. Tsirkin: fixed not to crash when no id
Michael S. Tsirkin: fold in patch:
"additional fixes for mac-programming feature"
Amos Kong: always notify QMP client if mactable is changed
Amos Kong: return NULL list if no net client supports rx-filter query
Reviewed-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Amos Kong <akong@redhat.com>
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
2013-06-14 11:45:52 +04:00
|
|
|
|
EQMP
|
|
|
|
|
{
|
|
|
|
|
.name = "query-rx-filter",
|
|
|
|
|
.args_type = "name:s?",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_query_rx_filter,
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
query-rx-filter
|
|
|
|
|
---------------
|
|
|
|
|
|
|
|
|
|
Show rx-filter information.
|
|
|
|
|
|
|
|
|
|
Returns a json-array of rx-filter information for all NICs (or for the
|
|
|
|
|
given NIC), returning an error if the given NIC doesn't exist, or
|
|
|
|
|
given NIC doesn't support rx-filter querying, or given net client
|
|
|
|
|
isn't a NIC.
|
|
|
|
|
|
|
|
|
|
The query will clear the event notification flag of each NIC, then qemu
|
|
|
|
|
will start to emit event to QMP monitor.
|
|
|
|
|
|
|
|
|
|
Each array entry contains the following:
|
|
|
|
|
|
|
|
|
|
- "name": net client name (json-string)
|
|
|
|
|
- "promiscuous": promiscuous mode is enabled (json-bool)
|
|
|
|
|
- "multicast": multicast receive state (one of 'normal', 'none', 'all')
|
|
|
|
|
- "unicast": unicast receive state (one of 'normal', 'none', 'all')
|
2014-03-26 04:19:43 +04:00
|
|
|
|
- "vlan": vlan receive state (one of 'normal', 'none', 'all') (Since 2.0)
|
net: add support of mac-programming over macvtap in QEMU side
Currently macvtap based macvlan device is working in promiscuous
mode, we want to implement mac-programming over macvtap through
Libvirt for better performance.
Design:
QEMU notifies Libvirt when rx-filter config is changed in guest,
then Libvirt query the rx-filter information by a monitor command,
and sync the change to macvtap device. Related rx-filter config
of the nic contains main mac, rx-mode items and vlan table.
This patch adds a QMP event to notify management of rx-filter change,
and adds a monitor command for management to query rx-filter
information.
Test:
If we repeatedly add/remove vlan, and change macaddr of vlan
interfaces in guest by a loop script.
Result:
The events will flood the QMP client(management), management takes
too much resource to process the events.
Event_throttle API (set rate to 1 ms) can avoid the events to flood
QMP client, but it could cause an unexpected delay (~1ms), guests
guests normally expect rx-filter updates immediately.
So we use a flag for each nic to avoid events flooding, the event
is emitted once until the query command is executed. The flag
implementation could not introduce unexpected delay.
There maybe exist an uncontrollable delay if we let Libvirt do the
real change, guests normally expect rx-filter updates immediately.
But it's another separate issue, we can investigate it when the
work in Libvirt side is done.
Michael S. Tsirkin: tweaked to enable events on start
Michael S. Tsirkin: fixed not to crash when no id
Michael S. Tsirkin: fold in patch:
"additional fixes for mac-programming feature"
Amos Kong: always notify QMP client if mactable is changed
Amos Kong: return NULL list if no net client supports rx-filter query
Reviewed-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Amos Kong <akong@redhat.com>
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
2013-06-14 11:45:52 +04:00
|
|
|
|
- "broadcast-allowed": allow to receive broadcast (json-bool)
|
|
|
|
|
- "multicast-overflow": multicast table is overflowed (json-bool)
|
|
|
|
|
- "unicast-overflow": unicast table is overflowed (json-bool)
|
|
|
|
|
- "main-mac": main macaddr string (json-string)
|
|
|
|
|
- "vlan-table": a json-array of active vlan id
|
|
|
|
|
- "unicast-table": a json-array of unicast macaddr string
|
|
|
|
|
- "multicast-table": a json-array of multicast macaddr string
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "query-rx-filter", "arguments": { "name": "vnet0" } }
|
|
|
|
|
<- { "return": [
|
|
|
|
|
{
|
|
|
|
|
"promiscuous": true,
|
|
|
|
|
"name": "vnet0",
|
|
|
|
|
"main-mac": "52:54:00:12:34:56",
|
|
|
|
|
"unicast": "normal",
|
2014-03-26 04:19:43 +04:00
|
|
|
|
"vlan": "normal",
|
net: add support of mac-programming over macvtap in QEMU side
Currently macvtap based macvlan device is working in promiscuous
mode, we want to implement mac-programming over macvtap through
Libvirt for better performance.
Design:
QEMU notifies Libvirt when rx-filter config is changed in guest,
then Libvirt query the rx-filter information by a monitor command,
and sync the change to macvtap device. Related rx-filter config
of the nic contains main mac, rx-mode items and vlan table.
This patch adds a QMP event to notify management of rx-filter change,
and adds a monitor command for management to query rx-filter
information.
Test:
If we repeatedly add/remove vlan, and change macaddr of vlan
interfaces in guest by a loop script.
Result:
The events will flood the QMP client(management), management takes
too much resource to process the events.
Event_throttle API (set rate to 1 ms) can avoid the events to flood
QMP client, but it could cause an unexpected delay (~1ms), guests
guests normally expect rx-filter updates immediately.
So we use a flag for each nic to avoid events flooding, the event
is emitted once until the query command is executed. The flag
implementation could not introduce unexpected delay.
There maybe exist an uncontrollable delay if we let Libvirt do the
real change, guests normally expect rx-filter updates immediately.
But it's another separate issue, we can investigate it when the
work in Libvirt side is done.
Michael S. Tsirkin: tweaked to enable events on start
Michael S. Tsirkin: fixed not to crash when no id
Michael S. Tsirkin: fold in patch:
"additional fixes for mac-programming feature"
Amos Kong: always notify QMP client if mactable is changed
Amos Kong: return NULL list if no net client supports rx-filter query
Reviewed-by: Eric Blake <eblake@redhat.com>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Amos Kong <akong@redhat.com>
Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
2013-06-14 11:45:52 +04:00
|
|
|
|
"vlan-table": [
|
|
|
|
|
4,
|
|
|
|
|
0
|
|
|
|
|
],
|
|
|
|
|
"unicast-table": [
|
|
|
|
|
],
|
|
|
|
|
"multicast": "normal",
|
|
|
|
|
"multicast-overflow": false,
|
|
|
|
|
"unicast-overflow": false,
|
|
|
|
|
"multicast-table": [
|
|
|
|
|
"01:00:5e:00:00:01",
|
|
|
|
|
"33:33:00:00:00:01",
|
|
|
|
|
"33:33:ff:12:34:56"
|
|
|
|
|
],
|
|
|
|
|
"broadcast-allowed": false
|
|
|
|
|
}
|
|
|
|
|
]
|
|
|
|
|
}
|
|
|
|
|
|
2013-09-23 17:26:03 +04:00
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "blockdev-add",
|
|
|
|
|
.args_type = "options:q",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_blockdev_add,
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
blockdev-add
|
|
|
|
|
------------
|
|
|
|
|
|
|
|
|
|
Add a block device.
|
|
|
|
|
|
|
|
|
|
Arguments:
|
|
|
|
|
|
|
|
|
|
- "options": block driver options
|
|
|
|
|
|
|
|
|
|
Example (1):
|
|
|
|
|
|
|
|
|
|
-> { "execute": "blockdev-add",
|
|
|
|
|
"arguments": { "options" : { "driver": "qcow2",
|
|
|
|
|
"file": { "driver": "file",
|
|
|
|
|
"filename": "test.qcow2" } } } }
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
|
|
|
|
Example (2):
|
|
|
|
|
|
|
|
|
|
-> { "execute": "blockdev-add",
|
|
|
|
|
"arguments": {
|
|
|
|
|
"options": {
|
|
|
|
|
"driver": "qcow2",
|
|
|
|
|
"id": "my_disk",
|
|
|
|
|
"discard": "unmap",
|
|
|
|
|
"cache": {
|
|
|
|
|
"direct": true,
|
|
|
|
|
"writeback": true
|
|
|
|
|
},
|
|
|
|
|
"file": {
|
|
|
|
|
"driver": "file",
|
|
|
|
|
"filename": "/tmp/test.qcow2"
|
|
|
|
|
},
|
|
|
|
|
"backing": {
|
|
|
|
|
"driver": "raw",
|
|
|
|
|
"file": {
|
|
|
|
|
"driver": "file",
|
|
|
|
|
"filename": "/dev/fdset/4"
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
<- { "return": {} }
|
|
|
|
|
|
2014-01-24 00:31:34 +04:00
|
|
|
|
EQMP
|
|
|
|
|
|
|
|
|
|
{
|
|
|
|
|
.name = "query-named-block-nodes",
|
|
|
|
|
.args_type = "",
|
|
|
|
|
.mhandler.cmd_new = qmp_marshal_input_query_named_block_nodes,
|
|
|
|
|
},
|
|
|
|
|
|
|
|
|
|
SQMP
|
|
|
|
|
@query-named-block-nodes
|
|
|
|
|
------------------------
|
|
|
|
|
|
|
|
|
|
Return a list of BlockDeviceInfo for all the named block driver nodes
|
|
|
|
|
|
|
|
|
|
Example:
|
|
|
|
|
|
|
|
|
|
-> { "execute": "query-named-block-nodes" }
|
|
|
|
|
<- { "return": [ { "ro":false,
|
|
|
|
|
"drv":"qcow2",
|
|
|
|
|
"encrypted":false,
|
|
|
|
|
"file":"disks/test.qcow2",
|
|
|
|
|
"node-name": "my-node",
|
|
|
|
|
"backing_file_depth":1,
|
|
|
|
|
"bps":1000000,
|
|
|
|
|
"bps_rd":0,
|
|
|
|
|
"bps_wr":0,
|
|
|
|
|
"iops":1000000,
|
|
|
|
|
"iops_rd":0,
|
|
|
|
|
"iops_wr":0,
|
|
|
|
|
"bps_max": 8000000,
|
|
|
|
|
"bps_rd_max": 0,
|
|
|
|
|
"bps_wr_max": 0,
|
|
|
|
|
"iops_max": 0,
|
|
|
|
|
"iops_rd_max": 0,
|
|
|
|
|
"iops_wr_max": 0,
|
|
|
|
|
"iops_size": 0,
|
|
|
|
|
"image":{
|
|
|
|
|
"filename":"disks/test.qcow2",
|
|
|
|
|
"format":"qcow2",
|
|
|
|
|
"virtual-size":2048000,
|
|
|
|
|
"backing_file":"base.qcow2",
|
|
|
|
|
"full-backing-filename":"disks/base.qcow2",
|
|
|
|
|
"backing-filename-format:"qcow2",
|
|
|
|
|
"snapshots":[
|
|
|
|
|
{
|
|
|
|
|
"id": "1",
|
|
|
|
|
"name": "snapshot1",
|
|
|
|
|
"vm-state-size": 0,
|
|
|
|
|
"date-sec": 10000200,
|
|
|
|
|
"date-nsec": 12,
|
|
|
|
|
"vm-clock-sec": 206,
|
|
|
|
|
"vm-clock-nsec": 30
|
|
|
|
|
}
|
|
|
|
|
],
|
|
|
|
|
"backing-image":{
|
|
|
|
|
"filename":"disks/base.qcow2",
|
|
|
|
|
"format":"qcow2",
|
|
|
|
|
"virtual-size":2048000
|
|
|
|
|
}
|
|
|
|
|
} } ] }
|
|
|
|
|
|
2012-12-19 13:33:56 +04:00
|
|
|
|
EQMP
|