@@ -92,7 +92,6 @@ HELPERS-$(CONFIG_LINUX) = qemu-bridge-helper$(EXESUF)
ifdef BUILD_DOCS
DOCS=qemu-doc.html qemu-tech.html qemu.1 qemu-img.1 qemu-nbd.8 qemu-ga.8
-DOCS+=qmp-commands.txt
ifdef CONFIG_VIRTFS
DOCS+=fsdev/virtfs-proxy-helper.1
endif
@@ -432,7 +431,7 @@ endif
install-doc: $(DOCS)
$(INSTALL_DIR) "$(DESTDIR)$(qemu_docdir)"
$(INSTALL_DATA) qemu-doc.html qemu-tech.html "$(DESTDIR)$(qemu_docdir)"
- $(INSTALL_DATA) qmp-commands.txt "$(DESTDIR)$(qemu_docdir)"
+ $(INSTALL_DATA) docs/qmp-commands.txt "$(DESTDIR)$(qemu_docdir)"
ifdef CONFIG_POSIX
$(INSTALL_DIR) "$(DESTDIR)$(mandir)/man1"
$(INSTALL_DATA) qemu.1 "$(DESTDIR)$(mandir)/man1"
@@ -555,9 +554,6 @@ qemu-monitor.texi: $(SRC_PATH)/hmp-commands.hx $(SRC_PATH)/scripts/hxtool
qemu-monitor-info.texi: $(SRC_PATH)/hmp-commands-info.hx $(SRC_PATH)/scripts/hxtool
$(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -t < $< > $@," GEN $@")
-qmp-commands.txt: $(SRC_PATH)/qmp-commands.hx $(SRC_PATH)/scripts/hxtool
- $(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -q < $< > $@," GEN $@")
-
qemu-img-cmds.texi: $(SRC_PATH)/qemu-img-cmds.hx $(SRC_PATH)/scripts/hxtool
$(call quiet-command,sh $(SRC_PATH)/scripts/hxtool -t < $< > $@," GEN $@")
@@ -53,7 +53,6 @@
/qemu-bridge-helper
/qemu-monitor.texi
/qemu-monitor-info.texi
-/qmp-commands.txt
/vscclient
/fsdev/virtfs-proxy-helper
*.[1-9]
@@ -1237,7 +1237,6 @@ M: Markus Armbruster <armbru@redhat.com>
S: Supported
F: qmp.c
F: monitor.c
-F: qmp-commands.hx
F: docs/*qmp-*
F: scripts/qmp/
T: git git://repo.or.cz/qemu/armbru.git qapi-next
@@ -964,9 +964,9 @@ Example:
Used to generate the marshaling/dispatch functions for the commands
defined in the schema. The generated code implements
-qmp_marshal_COMMAND() (mentioned in qmp-commands.hx, and registered
-automatically), and declares qmp_COMMAND() that the user must
-implement. The following files are generated:
+qmp_marshal_COMMAND() (registered automatically), and declares
+qmp_COMMAND() that the user must implement. The following files are
+generated:
$(prefix)qmp-marshal.c: command marshal/dispatch functions for each
QMP command defined in the schema. Functions
similarity index 87%
rename from qmp-commands.hx
rename to docs/qmp-commands.txt
@@ -1,8 +1,3 @@
-HXCOMM QMP dispatch table and documentation
-HXCOMM Text between SQMP and EQMP is copied to the QMP documentation file and
-HXCOMM does not show up in the other formats.
-
-SQMP
QMP Supported Commands
----------------------
@@ -58,14 +53,6 @@ If you're planning to adopt QMP, please observe the following:
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 = "",
- },
-
-SQMP
quit
----
@@ -78,14 +65,6 @@ Example:
-> { "execute": "quit" }
<- { "return": {} }
-EQMP
-
- {
- .name = "eject",
- .args_type = "force:-f,device:B",
- },
-
-SQMP
eject
-----
@@ -103,14 +82,6 @@ Example:
Note: The "force" argument defaults to false.
-EQMP
-
- {
- .name = "change",
- .args_type = "device:B,target:F,arg:s?",
- },
-
-SQMP
change
------
@@ -138,14 +109,6 @@ Examples:
"arg": "foobar1" } }
<- { "return": {} }
-EQMP
-
- {
- .name = "screendump",
- .args_type = "filename:F",
- },
-
-SQMP
screendump
----------
@@ -160,14 +123,6 @@ Example:
-> { "execute": "screendump", "arguments": { "filename": "/tmp/image" } }
<- { "return": {} }
-EQMP
-
- {
- .name = "stop",
- .args_type = "",
- },
-
-SQMP
stop
----
@@ -180,14 +135,6 @@ Example:
-> { "execute": "stop" }
<- { "return": {} }
-EQMP
-
- {
- .name = "cont",
- .args_type = "",
- },
-
-SQMP
cont
----
@@ -200,14 +147,6 @@ Example:
-> { "execute": "cont" }
<- { "return": {} }
-EQMP
-
- {
- .name = "system_wakeup",
- .args_type = "",
- },
-
-SQMP
system_wakeup
-------------
@@ -220,14 +159,6 @@ Example:
-> { "execute": "system_wakeup" }
<- { "return": {} }
-EQMP
-
- {
- .name = "system_reset",
- .args_type = "",
- },
-
-SQMP
system_reset
------------
@@ -240,14 +171,6 @@ Example:
-> { "execute": "system_reset" }
<- { "return": {} }
-EQMP
-
- {
- .name = "system_powerdown",
- .args_type = "",
- },
-
-SQMP
system_powerdown
----------------
@@ -260,16 +183,6 @@ 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",
- },
-
-SQMP
device_add
----------
@@ -295,14 +208,6 @@ Notes:
(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",
- },
-
-SQMP
device_del
----------
@@ -322,14 +227,6 @@ Example:
-> { "execute": "device_del", "arguments": { "id": "/machine/peripheral-anon/device[0]" } }
<- { "return": {} }
-EQMP
-
- {
- .name = "send-key",
- .args_type = "keys:q,hold-time:i?",
- },
-
-SQMP
send-key
----------
@@ -352,14 +249,6 @@ Example:
{ "type": "qcode", "data": "delete" } ] } }
<- { "return": {} }
-EQMP
-
- {
- .name = "cpu",
- .args_type = "index:i",
- },
-
-SQMP
cpu
---
@@ -376,14 +265,6 @@ Example:
Note: CPUs' indexes are obtained with the 'query-cpus' command.
-EQMP
-
- {
- .name = "cpu-add",
- .args_type = "id:i",
- },
-
-SQMP
cpu-add
-------
@@ -398,14 +279,6 @@ Example:
-> { "execute": "cpu-add", "arguments": { "id": 2 } }
<- { "return": {} }
-EQMP
-
- {
- .name = "memsave",
- .args_type = "val:l,size:i,filename:s,cpu:i?",
- },
-
-SQMP
memsave
-------
@@ -426,14 +299,6 @@ Example:
"filename": "/tmp/virtual-mem-dump" } }
<- { "return": {} }
-EQMP
-
- {
- .name = "pmemsave",
- .args_type = "val:l,size:i,filename:s",
- },
-
-SQMP
pmemsave
--------
@@ -453,14 +318,6 @@ Example:
"filename": "/tmp/physical-mem-dump" } }
<- { "return": {} }
-EQMP
-
- {
- .name = "inject-nmi",
- .args_type = "",
- },
-
-SQMP
inject-nmi
----------
@@ -475,14 +332,6 @@ Example:
Note: inject-nmi fails when the guest doesn't support injecting.
-EQMP
-
- {
- .name = "ringbuf-write",
- .args_type = "device:s,data:s,format:s?",
- },
-
-SQMP
ringbuf-write
-------------
@@ -503,14 +352,6 @@ Example:
"format": "utf8" } }
<- { "return": {} }
-EQMP
-
- {
- .name = "ringbuf-read",
- .args_type = "device:s,size:i,format:s?",
- },
-
-SQMP
ringbuf-read
-------------
@@ -538,14 +379,6 @@ Example:
"format": "utf8" } }
<- {"return": "abcdefgh"}
-EQMP
-
- {
- .name = "xen-save-devices-state",
- .args_type = "filename:F",
- },
-
-SQMP
xen-save-devices-state
-------
@@ -564,14 +397,6 @@ Example:
"arguments": { "filename": "/tmp/save" } }
<- { "return": {} }
-EQMP
-
- {
- .name = "xen-load-devices-state",
- .args_type = "filename:F",
- },
-
-SQMP
xen-load-devices-state
----------------------
@@ -590,14 +415,6 @@ Example:
"arguments": { "filename": "/tmp/resume" } }
<- { "return": {} }
-EQMP
-
- {
- .name = "xen-set-global-dirty-log",
- .args_type = "enable:b",
- },
-
-SQMP
xen-set-global-dirty-log
-------
@@ -613,14 +430,6 @@ Example:
"arguments": { "enable": true } }
<- { "return": {} }
-EQMP
-
- {
- .name = "migrate",
- .args_type = "detach:-d,blk:-b,inc:-i,uri:s",
- },
-
-SQMP
migrate
-------
@@ -645,14 +454,6 @@ Notes:
(3) The user Monitor's "detach" argument is invalid in QMP and should not
be used
-EQMP
-
- {
- .name = "migrate_cancel",
- .args_type = "",
- },
-
-SQMP
migrate_cancel
--------------
@@ -665,14 +466,6 @@ Example:
-> { "execute": "migrate_cancel" }
<- { "return": {} }
-EQMP
-
- {
- .name = "migrate-incoming",
- .args_type = "uri:s",
- },
-
-SQMP
migrate-incoming
----------------
@@ -693,13 +486,6 @@ Notes:
be used
(2) The uri format is the same as for -incoming
-EQMP
- {
- .name = "migrate-set-cache-size",
- .args_type = "value:o",
- },
-
-SQMP
migrate-set-cache-size
----------------------
@@ -715,13 +501,6 @@ Example:
-> { "execute": "migrate-set-cache-size", "arguments": { "value": 536870912 } }
<- { "return": {} }
-EQMP
- {
- .name = "migrate-start-postcopy",
- .args_type = "",
- },
-
-SQMP
migrate-start-postcopy
----------------------
@@ -732,14 +511,6 @@ Example:
-> { "execute": "migrate-start-postcopy" }
<- { "return": {} }
-EQMP
-
- {
- .name = "query-migrate-cache-size",
- .args_type = "",
- },
-
-SQMP
query-migrate-cache-size
------------------------
@@ -753,14 +524,6 @@ Example:
-> { "execute": "query-migrate-cache-size" }
<- { "return": 67108864 }
-EQMP
-
- {
- .name = "migrate_set_speed",
- .args_type = "value:o",
- },
-
-SQMP
migrate_set_speed
-----------------
@@ -775,14 +538,6 @@ Example:
-> { "execute": "migrate_set_speed", "arguments": { "value": 1024 } }
<- { "return": {} }
-EQMP
-
- {
- .name = "migrate_set_downtime",
- .args_type = "value:T",
- },
-
-SQMP
migrate_set_downtime
--------------------
@@ -797,16 +552,6 @@ Example:
-> { "execute": "migrate_set_downtime", "arguments": { "value": 0.1 } }
<- { "return": {} }
-EQMP
-
- {
- .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 = "set migration information for remote display",
- },
-
-SQMP
client_migrate_info
-------------------
@@ -830,16 +575,6 @@ Example:
"port": 1234 } }
<- { "return": {} }
-EQMP
-
- {
- .name = "dump-guest-memory",
- .args_type = "paging:b,protocol:s,detach:b?,begin:i?,end:i?,format:s?",
- .params = "-p protocol [-d] [begin] [length] [format]",
- .help = "dump guest memory to file",
- },
-
-SQMP
dump
@@ -870,14 +605,6 @@ Notes:
(1) All boolean arguments default to false
-EQMP
-
- {
- .name = "query-dump-guest-memory-capability",
- .args_type = "",
- },
-
-SQMP
query-dump-guest-memory-capability
----------
@@ -889,16 +616,6 @@ Example:
<- { "return": { "formats":
["elf", "kdump-zlib", "kdump-lzo", "kdump-snappy"] }
-EQMP
-
- {
- .name = "query-dump",
- .args_type = "",
- .params = "",
- .help = "query background dump status",
- },
-
-SQMP
query-dump
----------
@@ -912,16 +629,6 @@ Example:
<- { "return": { "status": "active", "completed": 1024000,
"total": 2048000 } }
-EQMP
-
-#if defined TARGET_S390X
- {
- .name = "dump-skeys",
- .args_type = "filename:F",
- },
-#endif
-
-SQMP
dump-skeys
----------
@@ -936,14 +643,6 @@ Example:
-> { "execute": "dump-skeys", "arguments": { "filename": "/tmp/skeys" } }
<- { "return": {} }
-EQMP
-
- {
- .name = "netdev_add",
- .args_type = "netdev:O",
- },
-
-SQMP
netdev_add
----------
@@ -966,14 +665,6 @@ Note: The supported device options are the same ones supported by the '-netdev'
command-line argument, which are listed in the '-help' output or QEMU's
manual
-EQMP
-
- {
- .name = "netdev_del",
- .args_type = "id:s",
- },
-
-SQMP
netdev_del
----------
@@ -989,14 +680,6 @@ Example:
<- { "return": {} }
-EQMP
-
- {
- .name = "object-add",
- .args_type = "qom-type:s,id:s,props:q?",
- },
-
-SQMP
object-add
----------
@@ -1014,14 +697,6 @@ Example:
"props": { "filename": "/dev/hwrng" } } }
<- { "return": {} }
-EQMP
-
- {
- .name = "object-del",
- .args_type = "id:s",
- },
-
-SQMP
object-del
----------
@@ -1037,15 +712,6 @@ Example:
<- { "return": {} }
-EQMP
-
-
- {
- .name = "block_resize",
- .args_type = "device:s?,node-name:s?,size:o",
- },
-
-SQMP
block_resize
------------
@@ -1062,14 +728,6 @@ Example:
-> { "execute": "block_resize", "arguments": { "device": "scratch", "size": 1073741824 } }
<- { "return": {} }
-EQMP
-
- {
- .name = "block-stream",
- .args_type = "job-id:s?,device:B,base:s?,speed:o?,backing-file:s?,on-error:s?",
- },
-
-SQMP
block-stream
------------
@@ -1106,14 +764,6 @@ Example:
"base": "/tmp/master.qcow2" } }
<- { "return": {} }
-EQMP
-
- {
- .name = "block-commit",
- .args_type = "job-id:s?,device:B,base:s?,top:s?,backing-file:s?,speed:o?",
- },
-
-SQMP
block-commit
------------
@@ -1170,16 +820,6 @@ Example:
"top": "/tmp/snap1.qcow2" } }
<- { "return": {} }
-EQMP
-
- {
- .name = "drive-backup",
- .args_type = "job-id:s?,sync:s,device:B,target:s,speed:i?,mode:s?,"
- "format:s?,bitmap:s?,compress:b?,"
- "on-source-error:s?,on-target-error:s?",
- },
-
-SQMP
drive-backup
------------
@@ -1228,15 +868,6 @@ Example:
"target": "backup.img" } }
<- { "return": {} }
-EQMP
-
- {
- .name = "blockdev-backup",
- .args_type = "job-id:s?,sync:s,device:B,target:B,speed:i?,compress:b?,"
- "on-source-error:s?,on-target-error:s?",
- },
-
-SQMP
blockdev-backup
---------------
@@ -1272,35 +903,6 @@ Example:
"target": "tgt-id" } }
<- { "return": {} }
-EQMP
-
- {
- .name = "block-job-set-speed",
- .args_type = "device:B,speed:o",
- },
-
- {
- .name = "block-job-cancel",
- .args_type = "device:B,force:b?",
- },
- {
- .name = "block-job-pause",
- .args_type = "device:B",
- },
- {
- .name = "block-job-resume",
- .args_type = "device:B",
- },
- {
- .name = "block-job-complete",
- .args_type = "device:B",
- },
- {
- .name = "transaction",
- .args_type = "actions:q,properties:q?",
- },
-
-SQMP
transaction
-----------
@@ -1387,14 +989,6 @@ Example:
"name": "snapshot0" } } ] } }
<- { "return": {} }
-EQMP
-
- {
- .name = "block-dirty-bitmap-add",
- .args_type = "node:B,name:s,granularity:i?",
- },
-
-SQMP
block-dirty-bitmap-add
----------------------
Since 2.4
@@ -1413,14 +1007,6 @@ Example:
"name": "bitmap0" } }
<- { "return": {} }
-EQMP
-
- {
- .name = "block-dirty-bitmap-remove",
- .args_type = "node:B,name:s",
- },
-
-SQMP
block-dirty-bitmap-remove
-------------------------
Since 2.4
@@ -1439,14 +1025,6 @@ Example:
"name": "bitmap0" } }
<- { "return": {} }
-EQMP
-
- {
- .name = "block-dirty-bitmap-clear",
- .args_type = "node:B,name:s",
- },
-
-SQMP
block-dirty-bitmap-clear
------------------------
Since 2.4
@@ -1466,14 +1044,6 @@ Example:
"name": "bitmap0" } }
<- { "return": {} }
-EQMP
-
- {
- .name = "blockdev-snapshot-sync",
- .args_type = "device:s?,node-name:s?,snapshot-file:s,snapshot-node-name:s?,format:s?,mode:s?",
- },
-
-SQMP
blockdev-snapshot-sync
----------------------
@@ -1501,14 +1071,6 @@ Example:
"format": "qcow2" } }
<- { "return": {} }
-EQMP
-
- {
- .name = "blockdev-snapshot",
- .args_type = "node:s,overlay:s",
- },
-
-SQMP
blockdev-snapshot
-----------------
Since 2.5
@@ -1538,14 +1100,6 @@ Example:
"overlay": "node1534" } }
<- { "return": {} }
-EQMP
-
- {
- .name = "blockdev-snapshot-internal-sync",
- .args_type = "device:B,name:s",
- },
-
-SQMP
blockdev-snapshot-internal-sync
-------------------------------
@@ -1567,14 +1121,6 @@ Example:
}
<- { "return": {} }
-EQMP
-
- {
- .name = "blockdev-snapshot-delete-internal-sync",
- .args_type = "device:B,id:s?,name:s?",
- },
-
-SQMP
blockdev-snapshot-delete-internal-sync
--------------------------------------
@@ -1606,18 +1152,6 @@ Example:
}
}
-EQMP
-
- {
- .name = "drive-mirror",
- .args_type = "job-id:s?,sync:s,device:B,target:s,speed:i?,mode:s?,"
- "format:s?,node-name:s?,replaces:s?,"
- "on-source-error:s?,on-target-error:s?,"
- "unmap:b?,"
- "granularity:i?,buf-size:i?",
- },
-
-SQMP
drive-mirror
------------
@@ -1672,16 +1206,6 @@ Example:
"format": "qcow2" } }
<- { "return": {} }
-EQMP
-
- {
- .name = "blockdev-mirror",
- .args_type = "job-id:s?,sync:s,device:B,target:B,replaces:s?,speed:i?,"
- "on-source-error:s?,on-target-error:s?,"
- "granularity:i?,buf-size:i?",
- },
-
-SQMP
blockdev-mirror
------------
@@ -1723,13 +1247,6 @@ Example:
"sync": "full" } }
<- { "return": {} }
-EQMP
- {
- .name = "change-backing-file",
- .args_type = "device:s,image-node-name:s,backing-file:s",
- },
-
-SQMP
change-backing-file
-------------------
Since: 2.1
@@ -1761,14 +1278,6 @@ Arguments:
Returns: Nothing on success
If "device" does not exist or cannot be determined, DeviceNotFound
-EQMP
-
- {
- .name = "balloon",
- .args_type = "value:M",
- },
-
-SQMP
balloon
-------
@@ -1783,14 +1292,6 @@ Example:
-> { "execute": "balloon", "arguments": { "value": 536870912 } }
<- { "return": {} }
-EQMP
-
- {
- .name = "set_link",
- .args_type = "name:s,up:b",
- },
-
-SQMP
set_link
--------
@@ -1806,16 +1307,6 @@ 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",
- },
-
-SQMP
getfd
-----
@@ -1838,16 +1329,6 @@ Notes:
(2) The 'closefd' command can be used to explicitly close the file
descriptor when it is no longer needed.
-EQMP
-
- {
- .name = "closefd",
- .args_type = "fdname:s",
- .params = "closefd name",
- .help = "close a file descriptor previously passed via SCM rights",
- },
-
-SQMP
closefd
-------
@@ -1862,16 +1343,6 @@ Example:
-> { "execute": "closefd", "arguments": { "fdname": "fd1" } }
<- { "return": {} }
-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",
- },
-
-SQMP
add-fd
-------
@@ -1900,16 +1371,6 @@ 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",
- },
-
-SQMP
remove-fd
---------
@@ -1932,15 +1393,6 @@ Notes:
(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",
- },
-
-SQMP
query-fdsets
-------------
@@ -1981,14 +1433,6 @@ Example:
Note: The list of fd sets is shared by all monitor connections.
-EQMP
-
- {
- .name = "block_passwd",
- .args_type = "device:s?,node-name:s?,password:s",
- },
-
-SQMP
block_passwd
------------
@@ -2006,14 +1450,6 @@ Example:
"password": "12345" } }
<- { "return": {} }
-EQMP
-
- {
- .name = "block_set_io_throttle",
- .args_type = "device:B,bps:l,bps_rd:l,bps_wr:l,iops:l,iops_rd:l,iops_wr:l,bps_max:l?,bps_rd_max:l?,bps_wr_max:l?,iops_max:l?,iops_rd_max:l?,iops_wr_max:l?,bps_max_length:l?,bps_rd_max_length:l?,bps_wr_max_length:l?,iops_max_length:l?,iops_rd_max_length:l?,iops_wr_max_length:l?,iops_size:l?,group:s?",
- },
-
-SQMP
block_set_io_throttle
------------
@@ -2062,14 +1498,6 @@ Example:
"iops_size": 0 } }
<- { "return": {} }
-EQMP
-
- {
- .name = "set_password",
- .args_type = "protocol:s,password:s,connected:s?",
- },
-
-SQMP
set_password
------------
@@ -2087,14 +1515,6 @@ Example:
"password": "secret" } }
<- { "return": {} }
-EQMP
-
- {
- .name = "expire_password",
- .args_type = "protocol:s,time:s",
- },
-
-SQMP
expire_password
---------------
@@ -2111,14 +1531,6 @@ Example:
"time": "+60" } }
<- { "return": {} }
-EQMP
-
- {
- .name = "add_client",
- .args_type = "protocol:s,fdname:s,skipauth:b?,tls:b?",
- },
-
-SQMP
add_client
----------
@@ -2137,15 +1549,6 @@ Example:
"fdname": "myclient" } }
<- { "return": {} }
-EQMP
- {
- .name = "qmp_capabilities",
- .args_type = "",
- .params = "",
- .help = "enable QMP capabilities",
- },
-
-SQMP
qmp_capabilities
----------------
@@ -2160,14 +1563,6 @@ Example:
Note: This command must be issued before issuing any other command.
-EQMP
-
- {
- .name = "human-monitor-command",
- .args_type = "command-line:s,cpu-index:i?",
- },
-
-SQMP
human-monitor-command
---------------------
@@ -2204,13 +1599,7 @@ Notes:
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
-------------
@@ -2238,14 +1627,6 @@ Example:
}
}
-EQMP
-
- {
- .name = "query-version",
- .args_type = "",
- },
-
-SQMP
query-commands
--------------
@@ -2274,14 +1655,6 @@ Example:
Note: This example has been shortened as the real response is too long.
-EQMP
-
- {
- .name = "query-commands",
- .args_type = "",
- },
-
-SQMP
query-events
--------------
@@ -2310,14 +1683,6 @@ Example:
Note: This example has been shortened as the real response is too long.
-EQMP
-
- {
- .name = "query-events",
- .args_type = "",
- },
-
-SQMP
query-qmp-schema
----------------
@@ -2326,14 +1691,6 @@ named schema entities. Entities are commands, events and various
types. See docs/qapi-code-gen.txt for information on their structure
and intended use.
-EQMP
-
- {
- .name = "query-qmp-schema",
- .args_type = "",
- },
-
-SQMP
query-chardev
-------------
@@ -2370,14 +1727,6 @@ Example:
]
}
-EQMP
-
- {
- .name = "query-chardev",
- .args_type = "",
- },
-
-SQMP
query-chardev-backends
-------------
@@ -2410,14 +1759,6 @@ Example:
]
}
-EQMP
-
- {
- .name = "query-chardev-backends",
- .args_type = "",
- },
-
-SQMP
query-block
-----------
@@ -2593,14 +1934,6 @@ Example:
]
}
-EQMP
-
- {
- .name = "query-block",
- .args_type = "",
- },
-
-SQMP
query-blockstats
----------------
@@ -2789,14 +2122,6 @@ Example:
]
}
-EQMP
-
- {
- .name = "query-blockstats",
- .args_type = "query-nodes:b?",
- },
-
-SQMP
query-cpus
----------
@@ -2843,14 +2168,6 @@ Example:
]
}
-EQMP
-
- {
- .name = "query-cpus",
- .args_type = "",
- },
-
-SQMP
query-iothreads
---------------
@@ -2881,14 +2198,6 @@ Example:
]
}
-EQMP
-
- {
- .name = "query-iothreads",
- .args_type = "",
- },
-
-SQMP
query-pci
---------
@@ -3097,14 +2406,6 @@ Example:
Note: This example has been shortened as the real response is too long.
-EQMP
-
- {
- .name = "query-pci",
- .args_type = "",
- },
-
-SQMP
query-kvm
---------
@@ -3120,14 +2421,6 @@ Example:
-> { "execute": "query-kvm" }
<- { "return": { "enabled": true, "present": true } }
-EQMP
-
- {
- .name = "query-kvm",
- .args_type = "",
- },
-
-SQMP
query-status
------------
@@ -3159,14 +2452,6 @@ Example:
-> { "execute": "query-status" }
<- { "return": { "running": true, "singlestep": false, "status": "running" } }
-EQMP
-
- {
- .name = "query-status",
- .args_type = "",
- },
-
-SQMP
query-mice
----------
@@ -3202,14 +2487,6 @@ Example:
]
}
-EQMP
-
- {
- .name = "query-mice",
- .args_type = "",
- },
-
-SQMP
query-vnc
---------
@@ -3264,18 +2541,6 @@ Example:
}
}
-EQMP
-
- {
- .name = "query-vnc",
- .args_type = "",
- },
- {
- .name = "query-vnc-servers",
- .args_type = "",
- },
-
-SQMP
query-spice
-----------
@@ -3343,16 +2608,6 @@ Example:
}
}
-EQMP
-
-#if defined(CONFIG_SPICE)
- {
- .name = "query-spice",
- .args_type = "",
- },
-#endif
-
-SQMP
query-name
----------
@@ -3367,14 +2622,6 @@ Example:
-> { "execute": "query-name" }
<- { "return": { "name": "qemu-name" } }
-EQMP
-
- {
- .name = "query-name",
- .args_type = "",
- },
-
-SQMP
query-uuid
----------
@@ -3389,14 +2636,6 @@ Example:
-> { "execute": "query-uuid" }
<- { "return": { "UUID": "550e8400-e29b-41d4-a716-446655440000" } }
-EQMP
-
- {
- .name = "query-uuid",
- .args_type = "",
- },
-
-SQMP
query-command-line-options
--------------------------
@@ -3437,14 +2676,6 @@ Example:
]
}
-EQMP
-
- {
- .name = "query-command-line-options",
- .args_type = "option:s?",
- },
-
-SQMP
query-migrate
-------------
@@ -3614,14 +2845,6 @@ Examples:
}
}
-EQMP
-
- {
- .name = "query-migrate",
- .args_type = "",
- },
-
-SQMP
migrate-set-capabilities
------------------------
@@ -3642,14 +2865,6 @@ Example:
-> { "execute": "migrate-set-capabilities" , "arguments":
{ "capabilities": [ { "capability": "xbzrle", "state": true } ] } }
-EQMP
-
- {
- .name = "migrate-set-capabilities",
- .args_type = "capabilities:q",
- .params = "capability:s,state:b",
- },
-SQMP
query-migrate-capabilities
--------------------------
@@ -3679,14 +2894,6 @@ Example:
{"state": false, "capability": "postcopy-ram"}
]}
-EQMP
-
- {
- .name = "query-migrate-capabilities",
- .args_type = "",
- },
-
-SQMP
migrate-set-parameters
----------------------
@@ -3707,14 +2914,6 @@ Example:
-> { "execute": "migrate-set-parameters" , "arguments":
{ "compress-level": 1 } }
-EQMP
-
- {
- .name = "migrate-set-parameters",
- .args_type =
- "compress-level:i?,compress-threads:i?,decompress-threads:i?,cpu-throttle-initial:i?,cpu-throttle-increment:i?",
- },
-SQMP
query-migrate-parameters
------------------------
@@ -3744,14 +2943,6 @@ Example:
}
}
-EQMP
-
- {
- .name = "query-migrate-parameters",
- .args_type = "",
- },
-
-SQMP
query-balloon
-------------
@@ -3771,96 +2962,6 @@ Example:
}
}
-EQMP
-
- {
- .name = "query-balloon",
- .args_type = "",
- },
-
- {
- .name = "query-block-jobs",
- .args_type = "",
- },
-
- {
- .name = "qom-list",
- .args_type = "path:s",
- },
-
- {
- .name = "qom-set",
- .args_type = "path:s,property:s,value:q",
- },
-
- {
- .name = "qom-get",
- .args_type = "path:s,property:s",
- },
-
- {
- .name = "nbd-server-start",
- .args_type = "addr:q,tls-creds:s?",
- },
- {
- .name = "nbd-server-add",
- .args_type = "device:B,writable:b?",
- },
- {
- .name = "nbd-server-stop",
- .args_type = "",
- },
-
- {
- .name = "change-vnc-password",
- .args_type = "password:s",
- },
- {
- .name = "qom-list-types",
- .args_type = "implements:s?,abstract:b?",
- },
-
- {
- .name = "device-list-properties",
- .args_type = "typename:s",
- },
-
- {
- .name = "query-machines",
- .args_type = "",
- },
-
- {
- .name = "query-cpu-definitions",
- .args_type = "",
- },
-
- {
- .name = "query-cpu-model-expansion",
- .args_type = "type:s,model:q",
- },
-
- {
- .name = "query-cpu-model-comparison",
- .args_type = "modela:q,modelb:q",
- },
-
- {
- .name = "query-cpu-model-baseline",
- .args_type = "modela:q,modelb:q",
- },
-
- {
- .name = "query-target",
- .args_type = "",
- },
-
- {
- .name = "query-tpm",
- .args_type = "",
- },
-
-SQMP
query-tpm
---------
@@ -3886,14 +2987,6 @@ Example:
]
}
-EQMP
-
- {
- .name = "query-tpm-models",
- .args_type = "",
- },
-
-SQMP
query-tpm-models
----------------
@@ -3906,14 +2999,6 @@ Example:
-> { "execute": "query-tpm-models" }
<- { "return": [ "tpm-tis" ] }
-EQMP
-
- {
- .name = "query-tpm-types",
- .args_type = "",
- },
-
-SQMP
query-tpm-types
---------------
@@ -3926,14 +3011,6 @@ Example:
-> { "execute": "query-tpm-types" }
<- { "return": [ "passthrough" ] }
-EQMP
-
- {
- .name = "chardev-add",
- .args_type = "id:s,backend:q",
- },
-
-SQMP
chardev-add
----------------
@@ -3962,15 +3039,6 @@ Examples:
"backend" : { "type" : "pty", "data" : {} } } }
<- { "return": { "pty" : "/dev/pty/42" } }
-EQMP
-
- {
- .name = "chardev-remove",
- .args_type = "id:s",
- },
-
-
-SQMP
chardev-remove
--------------
@@ -3985,13 +3053,6 @@ Example:
-> { "execute": "chardev-remove", "arguments": { "id" : "foo" } }
<- { "return": {} }
-EQMP
- {
- .name = "query-rx-filter",
- .args_type = "name:s?",
- },
-
-SQMP
query-rx-filter
---------------
@@ -4049,14 +3110,6 @@ Example:
]
}
-EQMP
-
- {
- .name = "blockdev-add",
- .args_type = "options:q",
- },
-
-SQMP
blockdev-add
------------
@@ -4107,14 +3160,6 @@ Example (2):
<- { "return": {} }
-EQMP
-
- {
- .name = "x-blockdev-del",
- .args_type = "id:s?,node-name:s?",
- },
-
-SQMP
x-blockdev-del
------------
Since 2.5
@@ -4163,14 +3208,6 @@ Example:
}
<- { "return": {} }
-EQMP
-
- {
- .name = "blockdev-open-tray",
- .args_type = "device:s,force:b?",
- },
-
-SQMP
blockdev-open-tray
------------------
@@ -4210,14 +3247,6 @@ Example:
<- { "return": {} }
-EQMP
-
- {
- .name = "blockdev-close-tray",
- .args_type = "device:s",
- },
-
-SQMP
blockdev-close-tray
-------------------
@@ -4244,14 +3273,6 @@ Example:
<- { "return": {} }
-EQMP
-
- {
- .name = "x-blockdev-remove-medium",
- .args_type = "device:s",
- },
-
-SQMP
x-blockdev-remove-medium
------------------------
@@ -4291,14 +3312,6 @@ Example:
<- { "return": {} }
-EQMP
-
- {
- .name = "x-blockdev-insert-medium",
- .args_type = "device:s,node-name:s",
- },
-
-SQMP
x-blockdev-insert-medium
------------------------
@@ -4330,14 +3343,6 @@ Example:
<- { "return": {} }
-EQMP
-
- {
- .name = "x-blockdev-change",
- .args_type = "parent:B,child:B?,node:B?",
- },
-
-SQMP
x-blockdev-change
-----------------
@@ -4382,14 +3387,6 @@ Delete a quorum's node
"child": "children.1" } }
<- { "return": {} }
-EQMP
-
- {
- .name = "query-named-block-nodes",
- .args_type = "",
- },
-
-SQMP
query-named-block-nodes
-----------------------
@@ -4443,14 +3440,6 @@ Example:
}
} } ] }
-EQMP
-
- {
- .name = "blockdev-change-medium",
- .args_type = "device:B,filename:F,format:s?,read-only-mode:s?",
- },
-
-SQMP
blockdev-change-medium
----------------------
@@ -4495,14 +3484,6 @@ Examples:
<- { "return": {} }
-EQMP
-
- {
- .name = "query-memdev",
- .args_type = "",
- },
-
-SQMP
query-memdev
------------
@@ -4532,14 +3513,6 @@ Example (1):
]
}
-EQMP
-
- {
- .name = "query-memory-devices",
- .args_type = "",
- },
-
-SQMP
query-memory-devices
--------------------
@@ -4559,14 +3532,6 @@ Example:
"type": "dimm"
} ] }
-EQMP
-
- {
- .name = "query-acpi-ospm-status",
- .args_type = "",
- },
-
-SQMP
query-acpi-ospm-status
----------------------
@@ -4581,16 +3546,6 @@ Example:
{ "slot": "3", "slot-type": "DIMM", "source": 0, "status": 0}
]}
-EQMP
-
-#if defined TARGET_I386
- {
- .name = "rtc-reset-reinjection",
- .args_type = "",
- },
-#endif
-
-SQMP
rtc-reset-reinjection
---------------------
@@ -4603,14 +3558,6 @@ Example:
-> { "execute": "rtc-reset-reinjection" }
<- { "return": {} }
-EQMP
-
- {
- .name = "trace-event-get-state",
- .args_type = "name:s,vcpu:i?",
- },
-
-SQMP
trace-event-get-state
---------------------
@@ -4635,14 +3582,6 @@ Example:
-> { "execute": "trace-event-get-state", "arguments": { "name": "qemu_memalign" } }
<- { "return": [ { "name": "qemu_memalign", "state": "disabled" } ] }
-EQMP
-
- {
- .name = "trace-event-set-state",
- .args_type = "name:s,enable:b,ignore-unavailable:b?,vcpu:i?",
- },
-
-SQMP
trace-event-set-state
---------------------
@@ -4670,14 +3609,6 @@ Example:
-> { "execute": "trace-event-set-state", "arguments": { "name": "qemu_memalign", "enable": "true" } }
<- { "return": {} }
-EQMP
-
- {
- .name = "input-send-event",
- .args_type = "console:i?,events:q",
- },
-
-SQMP
input-send-event
----------------
@@ -4733,14 +3664,6 @@ Move mouse pointer to absolute coordinates (20000, 400).
{ "type": "abs", "data" : { "axis": "y", "value" : 400 } } ] } }
<- { "return": {} }
-EQMP
-
- {
- .name = "block-set-write-threshold",
- .args_type = "node-name:s,write-threshold:l",
- },
-
-SQMP
block-set-write-threshold
------------
@@ -4760,14 +3683,6 @@ Example:
"write-threshold": 17179869184 } }
<- { "return": {} }
-EQMP
-
- {
- .name = "query-rocker",
- .args_type = "name:s",
- },
-
-SQMP
Show rocker switch
------------------
@@ -4780,14 +3695,6 @@ Example:
-> { "execute": "query-rocker", "arguments": { "name": "sw1" } }
<- { "return": {"name": "sw1", "ports": 2, "id": 1327446905938}}
-EQMP
-
- {
- .name = "query-rocker-ports",
- .args_type = "name:s",
- },
-
-SQMP
Show rocker switch ports
------------------------
@@ -4804,14 +3711,6 @@ Example:
"autoneg": "off", "link-up": true, "speed": 10000}
]}
-EQMP
-
- {
- .name = "query-rocker-of-dpa-flows",
- .args_type = "name:s,tbl-id:i?",
- },
-
-SQMP
Show rocker switch OF-DPA flow tables
-------------------------------------
@@ -4832,14 +3731,6 @@ Example:
{...more...},
]}
-EQMP
-
- {
- .name = "query-rocker-of-dpa-groups",
- .args_type = "name:s,type:i?",
- },
-
-SQMP
Show rocker OF-DPA group tables
-------------------------------
@@ -4861,16 +3752,6 @@ Example:
"pop-vlan": 1, "id": 251658240}
]}
-EQMP
-
-#if defined TARGET_ARM
- {
- .name = "query-gic-capabilities",
- .args_type = "",
- },
-#endif
-
-SQMP
query-gic-capabilities
---------------
@@ -4885,14 +3766,6 @@ Example:
<- { "return": [{ "version": 2, "emulated": true, "kernel": false },
{ "version": 3, "emulated": false, "kernel": true } ] }
-EQMP
-
- {
- .name = "query-hotpluggable-cpus",
- .args_type = "",
- },
-
-SQMP
Show existing/possible CPUs
---------------------------
@@ -119,16 +119,6 @@ There are a few things to be noticed:
5. Printing to the terminal is discouraged for QMP commands, we do it here
because it's the easiest way to demonstrate a QMP command
-Now a little hack is needed. As we're still using the old QMP server we need
-to add the new command to its internal dispatch table. This step won't be
-required in the near future. Open the qmp-commands.hx file and add the
-following at the bottom:
-
- {
- .name = "hello-world",
- .args_type = "",
- },
-
You're done. Now build qemu, run it as suggested in the "Testing" section,
and then type the following QMP command:
@@ -173,20 +163,6 @@ There are two important details to be noticed:
2. The C implementation signature must follow the schema's argument ordering,
which is defined by the "data" member
-The last step is to update the qmp-commands.hx file:
-
- {
- .name = "hello-world",
- .args_type = "message:s?",
- },
-
-Notice that the "args_type" member got our "message" argument. The character
-"s" stands for "string" and "?" means it's optional. This too must be ordered
-according to the C implementation and schema file. You can look for more
-examples in the qmp-commands.hx file if you need to define more arguments.
-
-Again, this step won't be required in the future.
-
Time to test our new version of the "hello-world" command. Build qemu, run it as
described in the "Testing" section and then send two commands:
@@ -452,13 +428,6 @@ There are a number of things to be noticed:
6. You have to include the "qmp-commands.h" header file in qemu-timer.c,
otherwise qemu won't build
-The last step is to add the corresponding entry in the qmp-commands.hx file:
-
- {
- .name = "query-alarm-clock",
- .args_type = "",
- },
-
Time to test the new command. Build qemu, run it as described in the "Testing"
section and try this:
@@ -597,13 +566,6 @@ iteration of the loop. That's because the alarm timer method in use is the
first element of the alarm_timers array. Also notice that QAPI lists are handled
by hand and we return the head of the list.
-To test this you have to add the corresponding qmp-commands.hx entry:
-
- {
- .name = "query-alarm-methods",
- .args_type = "",
- },
-
Now Build qemu, run it as explained in the "Testing" section and try our new
command:
The only remaining function of qmp-commands.hx is to let us generate qmp-commands.txt from it. Replace qmp-commands.hx by qmp-commands.txt. We intend to move the documentation into the QAPI schema and generate qapi-commands.txt from it, but not right now. Signed-off-by: Marc-André Lureau <marcandre.lureau@redhat.com> --- Makefile | 6 +- .gitignore | 1 - MAINTAINERS | 1 - docs/qapi-code-gen.txt | 6 +- qmp-commands.hx => docs/qmp-commands.txt | 1127 ------------------------------ docs/writing-qmp-commands.txt | 38 - 6 files changed, 4 insertions(+), 1175 deletions(-) rename qmp-commands.hx => docs/qmp-commands.txt (87%)