Merge tag 'pull-maintainer-may24-160524-2' of https://gitlab.com/stsquad/qemu into...

[mirror_qemu.git] / hmp-commands.hx

diff --git a/hmp-commands.hx b/hmp-commands.hx
index b87c250e23b87232cf748245cf578d05d048ea0c..06746f0afc3761a2744ce1bd729ab33554382d8c 100644 (file)
--- a/hmp-commands.hx
+++ b/hmp-commands.hx
@@ -1,8 +1,8 @@
-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 See docs/devel/docs.rst for the format of this file.
+HXCOMM
+HXCOMM This file defines the contents of an array of HMPCommand structs
+HXCOMM which specify the name, behaviour and help text for HMP commands.
+HXCOMM Text between SRST and ERST is rST format documentation.

 HXCOMM HXCOMM can be used for comments, discarded from both rST and C.
 
 
 HXCOMM HXCOMM can be used for comments, discarded from both rST and C.
 
 


@@ -252,6 +252,7 @@ SRST
 
 ERST
 
 
 ERST
 

+#ifdef CONFIG_PIXMAN

     {
         .name       = "screendump",
         .args_type  = "filename:F,format:-fs,device:s?,head:i?",
     {
         .name       = "screendump",
         .args_type  = "filename:F,format:-fs,device:s?,head:i?",


@@ -267,6 +268,7 @@ SRST
 ``screendump`` *filename*
   Save screen into PPM image *filename*.
 ERST
 ``screendump`` *filename*
   Save screen into PPM image *filename*.
 ERST

+#endif

 
     {
         .name       = "logfile",
 
     {
         .name       = "logfile",


@@ -379,16 +381,20 @@ SRST
 ERST
 
     {
 ERST
 
     {

-        .name       = "singlestep",
+        .name       = "one-insn-per-tb",

         .args_type  = "option:s?",
         .params     = "[on|off]",
         .args_type  = "option:s?",
         .params     = "[on|off]",

-        .help       = "run emulation in singlestep mode or switch to normal mode",
-        .cmd        = hmp_singlestep,
+        .help       = "run emulation with one guest instruction per translation block",
+        .cmd        = hmp_one_insn_per_tb,

     },
 
 SRST
     },
 
 SRST

-``singlestep [off]``
-  Run the emulation in single step mode.
+``one-insn-per-tb [off]``
+  Run the emulation with one guest instruction per translation block.
+  This slows down emulation a lot, but can be useful in some situations,
+  such as when trying to analyse the logs produced by the ``-d`` option.
+  This only has an effect when using TCG, not with KVM or other accelerators.
+

   If called with option off, the emulation returns to normal mode.
 ERST
 
   If called with option off, the emulation returns to normal mode.
 ERST
 


@@ -903,26 +909,23 @@ ERST
 
     {
         .name       = "migrate",
 
     {
         .name       = "migrate",

-        .args_type  = "detach:-d,blk:-b,inc:-i,resume:-r,uri:s",
-        .params     = "[-d] [-b] [-i] [-r] uri",
+        .args_type  = "detach:-d,resume:-r,uri:s",
+        .params     = "[-d] [-r] uri",

         .help       = "migrate to URI (using -d to not wait for completion)"
         .help       = "migrate to URI (using -d to not wait for completion)"

-                     "\n\t\t\t -b for migration without shared storage with"
-                     " full copy of disk\n\t\t\t -i for migration without "
-                     "shared storage with incremental copy of disk "
-                     "(base image shared between src and destination)"
-                      "\n\t\t\t -r to resume a paused migration",
+                     "\n\t\t\t -r to resume a paused postcopy migration",

         .cmd        = hmp_migrate,
     },
 
 
 SRST
         .cmd        = hmp_migrate,
     },
 
 
 SRST

-``migrate [-d] [-b] [-i]`` *uri*
-  Migrate to *uri* (using -d to not wait for completion).
+``migrate [-d] [-r]`` *uri*
+  Migrate the VM to *uri*.

 
 

-  ``-b``
-    for migration with full copy of disk
-  ``-i``
-    for migration with incremental copy of disk (base image is shared)
+  ``-d``
+    Start the migration process, but do not wait for its completion.  To
+    query an ongoing migration process, use "info migrate".
+  ``-r``
+    Resume a paused postcopy migration.

 ERST
 
     {
 ERST
 
     {


@@ -1035,6 +1038,7 @@ SRST
   migration (or once already in postcopy).
 ERST
 
   migration (or once already in postcopy).
 ERST
 

+#ifdef CONFIG_REPLICATION

     {
         .name       = "x_colo_lost_heartbeat",
         .args_type  = "",
     {
         .name       = "x_colo_lost_heartbeat",
         .args_type  = "",


@@ -1043,6 +1047,7 @@ ERST
                       "a failover or takeover is needed.",
         .cmd = hmp_x_colo_lost_heartbeat,
     },
                       "a failover or takeover is needed.",
         .cmd = hmp_x_colo_lost_heartbeat,
     },

+#endif

 
 SRST
 ``x_colo_lost_heartbeat``
 
 SRST
 ``x_colo_lost_heartbeat``


@@ -1066,14 +1071,16 @@ ERST
 
     {
         .name       = "dump-guest-memory",
 
     {
         .name       = "dump-guest-memory",

-        .args_type  = "paging:-p,detach:-d,windmp:-w,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:l?,length:l?",
-        .params     = "[-p] [-d] [-z|-l|-s|-w] filename [begin length]",
+        .args_type  = "paging:-p,detach:-d,windmp:-w,zlib:-z,lzo:-l,snappy:-s,raw:-R,filename:F,begin:l?,length:l?",
+        .params     = "[-p] [-d] [-z|-l|-s|-w] [-R] filename [begin length]",

         .help       = "dump guest memory into file 'filename'.\n\t\t\t"
                       "-p: do paging to get guest's memory mapping.\n\t\t\t"
                       "-d: return immediately (do not wait for completion).\n\t\t\t"
                       "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
                       "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
                       "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"
         .help       = "dump guest memory into file 'filename'.\n\t\t\t"
                       "-p: do paging to get guest's memory mapping.\n\t\t\t"
                       "-d: return immediately (do not wait for completion).\n\t\t\t"
                       "-z: dump in kdump-compressed format, with zlib compression.\n\t\t\t"
                       "-l: dump in kdump-compressed format, with lzo compression.\n\t\t\t"
                       "-s: dump in kdump-compressed format, with snappy compression.\n\t\t\t"

+                      "-R: when using kdump (-z, -l, -s), use raw rather than makedumpfile-flattened\n\t\t\t"
+                      "    format\n\t\t\t"

                       "-w: dump in Windows crashdump format (can be used instead of ELF-dump converting),\n\t\t\t"
                       "    for Windows x86 and x64 guests with vmcoreinfo driver only.\n\t\t\t"
                       "begin: the starting physical address.\n\t\t\t"
                       "-w: dump in Windows crashdump format (can be used instead of ELF-dump converting),\n\t\t\t"
                       "    for Windows x86 and x64 guests with vmcoreinfo driver only.\n\t\t\t"
                       "begin: the starting physical address.\n\t\t\t"


@@ -1096,6 +1103,9 @@ SRST
     dump in kdump-compressed format, with lzo compression.
   ``-s``
     dump in kdump-compressed format, with snappy compression.
     dump in kdump-compressed format, with lzo compression.
   ``-s``
     dump in kdump-compressed format, with snappy compression.

+  ``-R``
+    when using kdump (-z, -l, -s), use raw rather than makedumpfile-flattened
+    format

   ``-w``
     dump in Windows crashdump format (can be used instead of ELF-dump converting),
     for Windows x64 guests with vmcoreinfo driver only
   ``-w``
     dump in Windows crashdump format (can be used instead of ELF-dump converting),
     for Windows x64 guests with vmcoreinfo driver only


@@ -1277,6 +1287,9 @@ ERST
         .name       = "netdev_add",
         .args_type  = "netdev:O",
         .params     = "[user|tap|socket|stream|dgram|vde|bridge|hubport|netmap|vhost-user"
         .name       = "netdev_add",
         .args_type  = "netdev:O",
         .params     = "[user|tap|socket|stream|dgram|vde|bridge|hubport|netmap|vhost-user"

+#ifdef CONFIG_AF_XDP
+                      "|af-xdp"
+#endif

 #ifdef CONFIG_VMNET
                       "|vmnet-host|vmnet-shared|vmnet-bridged"
 #endif
 #ifdef CONFIG_VMNET
                       "|vmnet-host|vmnet-shared|vmnet-bridged"
 #endif


@@ -1396,7 +1409,7 @@ ERST
     {
         .name       = "watchdog_action",
         .args_type  = "action:s",
     {
         .name       = "watchdog_action",
         .args_type  = "action:s",

-        .params     = "[reset|shutdown|poweroff|pause|debug|none]",
+        .params     = "[reset|shutdown|poweroff|pause|debug|none|inject-nmi]",

         .help       = "change watchdog action",
         .cmd        = hmp_watchdog_action,
         .command_completion = watchdog_action_completion,
         .help       = "change watchdog action",
         .cmd        = hmp_watchdog_action,
         .command_completion = watchdog_action_completion,


@@ -1486,6 +1499,7 @@ SRST
   Inject an MCE on the given CPU (x86 only).
 ERST
 
   Inject an MCE on the given CPU (x86 only).
 ERST
 

+#ifdef CONFIG_POSIX

     {
         .name       = "getfd",
         .args_type  = "fdname:s",
     {
         .name       = "getfd",
         .args_type  = "fdname:s",


@@ -1501,6 +1515,7 @@ SRST
   mechanism on unix sockets, it is stored using the name *fdname* for
   later use by other monitor commands.
 ERST
   mechanism on unix sockets, it is stored using the name *fdname* for
   later use by other monitor commands.
 ERST

+#endif

 
     {
         .name       = "closefd",
 
     {
         .name       = "closefd",