-HXCOMM Use DEFHEADING() to define headings in both help text and texi
-HXCOMM Text between STEXI and ETEXI are copied to texi version and
-HXCOMM discarded from C version
+HXCOMM Use DEFHEADING() to define headings in both help text and rST.
+HXCOMM Text between SRST and ERST is copied to the rST version and
+HXCOMM discarded from C version.
HXCOMM DEF(command, args, callback, arg_string, help) is used to construct
HXCOMM monitor commands
-HXCOMM HXCOMM can be used for comments, discarded from both texi and C
+HXCOMM HXCOMM can be used for comments, discarded from both rST and C.
{
ERST
{
- .name = "q|quit",
+ .name = "quit|q",
.args_type = "",
.params = "",
.help = "quit the emulator",
.cmd = hmp_quit,
+ .flags = "p",
},
SRST
-``q`` or ``quit``
+``quit`` or ``q``
Quit the emulator.
ERST
.params = "device size",
.help = "resize a block image",
.cmd = hmp_block_resize,
+ .coroutine = true,
},
SRST
read-write
Makes the device writable.
- ``change vnc`` *display*,\ *options*
- Change the configuration of the VNC server. The valid syntax for *display*
- and *options* are described at :ref:`sec_005finvocation`. eg::
-
- (qemu) change vnc localhost:1
-
``change vnc password`` [*password*]
Change the password associated with the VNC server. If the new password
.help = "save screen from head 'head' of display device 'device' "
"into PPM image 'filename'",
.cmd = hmp_screendump,
+ .coroutine = true,
},
SRST
ERST
{
- .name = "c|cont",
+ .name = "cont|c",
.args_type = "",
.params = "",
.help = "resume emulation",
},
SRST
-``c`` or ``cont``
+``cont`` or ``c``
Resume emulation.
ERST
ERST
{
- .name = "p|print",
+ .name = "print|p",
.args_type = "fmt:/,val:l",
.params = "/fmt expr",
.help = "print expression value (use $reg for CPU register access)",
},
SRST
-``p`` or ``print/``\ *fmt* *expr*
+``print`` or ``p/``\ *fmt* *expr*
Print expression value. Only the *format* part of *fmt* is
used.
ERST
Pause an ongoing migration. Currently it only supports postcopy.
ERST
- {
- .name = "migrate_set_cache_size",
- .args_type = "value:o",
- .params = "value",
- .help = "set cache size (in bytes) for XBZRLE migrations,"
- "the cache size will be rounded down to the nearest "
- "power of 2.\n"
- "The cache size affects the number of cache misses."
- "In case of a high cache miss ratio you need to increase"
- " the cache size",
- .cmd = hmp_migrate_set_cache_size,
- },
-
-SRST
-``migrate_set_cache_size`` *value*
- Set cache size to *value* (in bytes) for xbzrle migrations.
-ERST
-
- {
- .name = "migrate_set_speed",
- .args_type = "value:o",
- .params = "value",
- .help = "set maximum speed (in bytes) for migrations. "
- "Defaults to MB if no size suffix is specified, ie. B/K/M/G/T",
- .cmd = hmp_migrate_set_speed,
- },
-
-SRST
-``migrate_set_speed`` *value*
- Set maximum speed to *value* (in bytes) for migrations.
-ERST
-
- {
- .name = "migrate_set_downtime",
- .args_type = "value:T",
- .params = "value",
- .help = "set maximum tolerated downtime (in seconds) for migrations",
- .cmd = hmp_migrate_set_downtime,
- },
-
-SRST
-``migrate_set_downtime`` *second*
- Set maximum tolerated downtime (in seconds) for migration.
-ERST
-
{
.name = "migrate_set_capability",
.args_type = "capability:s,state:b",
},
SRST
``drive_backup``
- Start a point-in-time copy of a block device to a specificed target.
+ Start a point-in-time copy of a block device to a specified target.
ERST
{
" -c for correctable error\n\t\t\t"
"<id> = qdev device id\n\t\t\t"
"<error_status> = error string or 32bit\n\t\t\t"
- "<tlb header> = 32bit x 4\n\t\t\t"
- "<tlb header prefix> = 32bit x 4",
+ "<tlp header> = 32bit x 4\n\t\t\t"
+ "<tlp header prefix> = 32bit x 4",
.cmd = hmp_pcie_aer_inject_error,
},
.help = "add host network device",
.cmd = hmp_netdev_add,
.command_completion = netdev_add_completion,
+ .flags = "p",
},
SRST
.help = "remove host network device",
.cmd = hmp_netdev_del,
.command_completion = netdev_del_completion,
+ .flags = "p",
},
SRST
{
.name = "object_add",
- .args_type = "object:O",
+ .args_type = "object:S",
.params = "[qom-type=]type,id=str[,prop=value][,...]",
.help = "create QOM object",
.cmd = hmp_object_add,
.command_completion = object_add_completion,
+ .flags = "p",
},
SRST
.help = "destroy QOM object",
.cmd = hmp_object_del,
.command_completion = object_del_completion,
+ .flags = "p",
},
SRST
#ifdef CONFIG_SLIRP
{
.name = "hostfwd_add",
- .args_type = "arg1:s,arg2:s?,arg3:s?",
- .params = "[hub_id name]|[netdev_id] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
+ .args_type = "arg1:s,arg2:s?",
+ .params = "[netdev_id] [tcp|udp]:[hostaddr]:hostport-[guestaddr]:guestport",
.help = "redirect TCP or UDP connections from host to guest (requires -net user)",
.cmd = hmp_hostfwd_add,
},
#ifdef CONFIG_SLIRP
{
.name = "hostfwd_remove",
- .args_type = "arg1:s,arg2:s?,arg3:s?",
- .params = "[hub_id name]|[netdev_id] [tcp|udp]:[hostaddr]:hostport",
+ .args_type = "arg1:s,arg2:s?",
+ .params = "[netdev_id] [tcp|udp]:[hostaddr]:hostport",
.help = "remove host-to-guest TCP or UDP redirection",
.cmd = hmp_hostfwd_remove,
},
Change watchdog action.
ERST
- {
- .name = "acl_show",
- .args_type = "aclname:s",
- .params = "aclname",
- .help = "list rules in the access control list",
- .cmd = hmp_acl_show,
- },
-
-SRST
-``acl_show`` *aclname*
- List all the matching rules in the access control list, and the default
- policy. There are currently two named access control lists,
- *vnc.x509dname* and *vnc.username* matching on the x509 client
- certificate distinguished name, and SASL username respectively.
-ERST
-
- {
- .name = "acl_policy",
- .args_type = "aclname:s,policy:s",
- .params = "aclname allow|deny",
- .help = "set default access control list policy",
- .cmd = hmp_acl_policy,
- },
-
-SRST
-``acl_policy`` *aclname* ``allow|deny``
- Set the default access control list policy, used in the event that
- none of the explicit rules match. The default policy at startup is
- always ``deny``.
-ERST
-
- {
- .name = "acl_add",
- .args_type = "aclname:s,match:s,policy:s,index:i?",
- .params = "aclname match allow|deny [index]",
- .help = "add a match rule to the access control list",
- .cmd = hmp_acl_add,
- },
-
-SRST
-``acl_add`` *aclname* *match* ``allow|deny`` [*index*]
- Add a match rule to the access control list, allowing or denying access.
- The match will normally be an exact username or x509 distinguished name,
- but can optionally include wildcard globs. eg ``*@EXAMPLE.COM`` to
- allow all users in the ``EXAMPLE.COM`` kerberos realm. The match will
- normally be appended to the end of the ACL, but can be inserted
- earlier in the list if the optional *index* parameter is supplied.
-ERST
-
- {
- .name = "acl_remove",
- .args_type = "aclname:s,match:s",
- .params = "aclname match",
- .help = "remove a match rule from the access control list",
- .cmd = hmp_acl_remove,
- },
-
-SRST
-``acl_remove`` *aclname* *match*
- Remove the specified match rule from the access control list.
-ERST
-
- {
- .name = "acl_reset",
- .args_type = "aclname:s",
- .params = "aclname",
- .help = "reset the access control list",
- .cmd = hmp_acl_reset,
- },
-
-SRST
-``acl_reset`` *aclname*
- Remove all matches from the access control list, and set the default
- policy back to ``deny``.
-ERST
-
{
.name = "nbd_server_start",
.args_type = "all:-a,writable:-w,uri:s",
used by another monitor command.
ERST
- {
- .name = "block_passwd",
- .args_type = "device:B,password:s",
- .params = "block_passwd device password",
- .help = "set the password of encrypted block devices",
- .cmd = hmp_block_passwd,
- },
-
-SRST
-``block_passwd`` *device* *password*
- Set the encrypted device *device* password to *password*
-
- This command is now obsolete and will always return an error since 2.10
-ERST
-
{
.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",
Executes a qemu-io command on the given block device.
ERST
- {
- .name = "cpu-add",
- .args_type = "id:i",
- .params = "id",
- .help = "add cpu (deprecated, use device_add instead)",
- .cmd = hmp_cpu_add,
- },
-
-SRST
-``cpu-add`` *id*
- Add CPU with id *id*. This command is deprecated, please
- +use ``device_add`` instead. For details, refer to
- 'docs/cpu-hotplug.rst'.
-ERST
-
{
.name = "qom-list",
.args_type = "path:s?",
Print QOM properties of object at location *path*
ERST
+ {
+ .name = "qom-get",
+ .args_type = "path:s,property:s",
+ .params = "path property",
+ .help = "print QOM property",
+ .cmd = hmp_qom_get,
+ .flags = "p",
+ },
+
+SRST
+``qom-get`` *path* *property*
+ Print QOM property *property* of object at location *path*
+ERST
+
{
.name = "qom-set",
- .args_type = "path:s,property:s,value:s",
- .params = "path property value",
- .help = "set QOM property",
+ .args_type = "json:-j,path:s,property:s,value:S",
+ .params = "[-j] path property value",
+ .help = "set QOM property.\n\t\t\t"
+ "-j: the value is specified in json format.",
.cmd = hmp_qom_set,
.flags = "p",
},
Set QOM property *property* of object at location *path* to value *value*
ERST
+ {
+ .name = "replay_break",
+ .args_type = "icount:l",
+ .params = "icount",
+ .help = "set breakpoint at the specified instruction count",
+ .cmd = hmp_replay_break,
+ },
+
+SRST
+``replay_break`` *icount*
+ Set replay breakpoint at instruction count *icount*.
+ Execution stops when the specified instruction is reached.
+ There can be at most one breakpoint. When breakpoint is set, any prior
+ one is removed. The breakpoint may be set only in replay mode and only
+ "in the future", i.e. at instruction counts greater than the current one.
+ The current instruction count can be observed with ``info replay``.
+ERST
+
+ {
+ .name = "replay_delete_break",
+ .args_type = "",
+ .params = "",
+ .help = "remove replay breakpoint",
+ .cmd = hmp_replay_delete_break,
+ },
+
+SRST
+``replay_delete_break``
+ Remove replay breakpoint which was previously set with ``replay_break``.
+ The command is ignored when there are no replay breakpoints.
+ERST
+
+ {
+ .name = "replay_seek",
+ .args_type = "icount:l",
+ .params = "icount",
+ .help = "replay execution to the specified instruction count",
+ .cmd = hmp_replay_seek,
+ },
+
+SRST
+``replay_seek`` *icount*
+ Automatically proceed to the instruction count *icount*, when
+ replaying the execution. The command automatically loads nearest
+ snapshot and replays the execution to find the desired instruction.
+ When there is no preceding snapshot or the execution is not replayed,
+ then the command fails.
+ *icount* for the reference may be observed with ``info replay`` command.
+ERST
+
{
.name = "info",
.args_type = "item:s?",
.flags = "p",
},
+SRST
+``calc_dirty_rate`` *second*
+ Start a round of dirty rate measurement with the period specified in *second*.
+ The result of the dirty rate measurement may be observed with ``info
+ dirty_rate`` command.
+ERST
+
+ {
+ .name = "calc_dirty_rate",
+ .args_type = "second:l,sample_pages_per_GB:l?",
+ .params = "second [sample_pages_per_GB]",
+ .help = "start a round of guest dirty rate measurement",
+ .cmd = hmp_calc_dirty_rate,
+ },
projects / mirror_qemu.git / blobdiff