migration: remove unused field bytes_xfer

[mirror_qemu.git] / hmp-commands.hx

diff --git a/hmp-commands.hx b/hmp-commands.hx
index 7ce991f4dd31f162007a371bcbde29f449fa662c..bfa5681dd2579c120d656982871c4439afd49400 100644 (file)
--- a/hmp-commands.hx
+++ b/hmp-commands.hx
@@ -55,6 +55,25 @@ STEXI
 @item q or quit
 @findex quit
 Quit the emulator.
 @item q or quit
 @findex quit
 Quit the emulator.

+ETEXI
+
+    {
+        .name       = "exit_preconfig",
+        .args_type  = "",
+        .params     = "",
+        .help       = "exit the preconfig state",
+        .cmd        = hmp_exit_preconfig,
+        .flags      = "p",
+    },
+
+STEXI
+@item exit_preconfig
+@findex exit_preconfig
+This command makes QEMU exit the preconfig state and proceed with
+VM initialization using configuration data provided on the command line
+and via the QMP monitor during the preconfig state. The command is only
+available during the preconfig state (i.e. when the --preconfig command
+line option was in use).

 ETEXI
 
     {
 ETEXI
 
     {


@@ -331,49 +350,57 @@ ETEXI
     {
         .name       = "savevm",
         .args_type  = "name:s?",
     {
         .name       = "savevm",
         .args_type  = "name:s?",

-        .params     = "[tag|id]",
-        .help       = "save a VM snapshot. If no tag or id are provided, a new snapshot is created",
+        .params     = "tag",
+        .help       = "save a VM snapshot. If no tag is provided, a new snapshot is created",

         .cmd        = hmp_savevm,
     },
 
 STEXI
         .cmd        = hmp_savevm,
     },
 
 STEXI

-@item savevm [@var{tag}|@var{id}]
+@item savevm @var{tag}

 @findex savevm
 Create a snapshot of the whole virtual machine. If @var{tag} is
 provided, it is used as human readable identifier. If there is already
 @findex savevm
 Create a snapshot of the whole virtual machine. If @var{tag} is
 provided, it is used as human readable identifier. If there is already

-a snapshot with the same tag or ID, it is replaced. More info at
+a snapshot with the same tag, it is replaced. More info at

 @ref{vm_snapshots}.
 @ref{vm_snapshots}.

+
+Since 4.0, savevm stopped allowing the snapshot id to be set, accepting
+only @var{tag} as parameter.

 ETEXI
 
     {
         .name       = "loadvm",
         .args_type  = "name:s",
 ETEXI
 
     {
         .name       = "loadvm",
         .args_type  = "name:s",

-        .params     = "tag|id",
-        .help       = "restore a VM snapshot from its tag or id",
+        .params     = "tag",
+        .help       = "restore a VM snapshot from its tag",

         .cmd        = hmp_loadvm,
         .command_completion = loadvm_completion,
     },
 
 STEXI
         .cmd        = hmp_loadvm,
         .command_completion = loadvm_completion,
     },
 
 STEXI

-@item loadvm @var{tag}|@var{id}
+@item loadvm @var{tag}

 @findex loadvm
 Set the whole virtual machine to the snapshot identified by the tag
 @findex loadvm
 Set the whole virtual machine to the snapshot identified by the tag

-@var{tag} or the unique snapshot ID @var{id}.
+@var{tag}.
+
+Since 4.0, loadvm stopped accepting snapshot id as parameter.

 ETEXI
 
     {
         .name       = "delvm",
         .args_type  = "name:s",
 ETEXI
 
     {
         .name       = "delvm",
         .args_type  = "name:s",

-        .params     = "tag|id",
-        .help       = "delete a VM snapshot from its tag or id",
+        .params     = "tag",
+        .help       = "delete a VM snapshot from its tag",

         .cmd        = hmp_delvm,
         .command_completion = delvm_completion,
     },
 
 STEXI
         .cmd        = hmp_delvm,
         .command_completion = delvm_completion,
     },
 
 STEXI

-@item delvm @var{tag}|@var{id}
+@item delvm @var{tag}

 @findex delvm
 @findex delvm

-Delete the snapshot identified by @var{tag} or @var{id}.
+Delete the snapshot identified by @var{tag}.
+
+Since 4.0, delvm stopped deleting snapshots by snapshot id, accepting
+only @var{tag} as parameter.

 ETEXI
 
     {
 ETEXI
 
     {


@@ -558,6 +585,21 @@ STEXI
 @findex gpa2hpa
 Print the host physical address at which the guest's physical address @var{addr}
 is mapped.
 @findex gpa2hpa
 Print the host physical address at which the guest's physical address @var{addr}
 is mapped.

+ETEXI
+
+    {
+        .name       = "gva2gpa",
+        .args_type  = "addr:l",
+        .params     = "addr",
+        .help       = "print the guest physical address corresponding to a guest virtual address",
+        .cmd        = hmp_gva2gpa,
+    },
+
+STEXI
+@item gva2gpa @var{addr}
+@findex gva2gpa
+Print the guest physical address at which the guest's virtual address @var{addr}
+is mapped based on the mapping for the current CPU.

 ETEXI
 
     {
 ETEXI
 
     {


@@ -624,6 +666,21 @@ sendkey ctrl-alt-f1
 
 This command is useful to send keys that your graphical user interface
 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.
 
 This command is useful to send keys that your graphical user interface
 intercepts at low level, such as @code{ctrl-alt-f1} in X Window.

+ETEXI
+    {
+        .name       = "sync-profile",
+        .args_type  = "op:s?",
+        .params     = "[on|off|reset]",
+        .help       = "enable, disable or reset synchronization profiling. "
+                      "With no arguments, prints whether profiling is on or off.",
+        .cmd        = hmp_sync_profile,
+    },
+
+STEXI
+@item sync-profile [on|off|reset]
+@findex sync-profile
+Enable, disable or reset synchronization profiling. With no arguments, prints
+whether profiling is on or off.

 ETEXI
 
     {
 ETEXI
 
     {


@@ -894,6 +951,25 @@ Bug: can screw up when the buffer contains invalid UTF-8 sequences,
 NUL characters, after the ring buffer lost data, and when reading
 stops because the size limit is reached.
 
 NUL characters, after the ring buffer lost data, and when reading
 stops because the size limit is reached.
 

+ETEXI
+
+    {
+        .name       = "announce_self",
+        .args_type  = "interfaces:s?,id:s?",
+        .params     = "[interfaces] [id]",
+        .help       = "Trigger GARP/RARP announcements",
+        .cmd        = hmp_announce_self,
+    },
+
+STEXI
+@item announce_self
+@findex announce_self
+Trigger a round of GARP/RARP broadcasts; this is useful for explicitly updating the
+network infrastructure after a reconfiguration or some forms of migration.
+The timings of the round are set by the migration announce parameters.
+An optional comma separated @var{interfaces} list restricts the announce to the
+named set of interfaces. An optional @var{id} can be used to start a separate announce
+timer and to change the parameters of it later.

 ETEXI
 
     {
 ETEXI
 
     {


@@ -1117,30 +1193,33 @@ ETEXI
 
     {
         .name       = "dump-guest-memory",
 
     {
         .name       = "dump-guest-memory",

-        .args_type  = "paging:-p,detach:-d,zlib:-z,lzo:-l,snappy:-s,filename:F,begin:l?,length:l?",
-        .params     = "[-p] [-d] [-z|-l|-s] filename [begin length]",
+        .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]",

         .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"

+                      "-w: dump in Windows crashdump format (can be used instead of ELF-dump converting),\n\t\t\t"
+                      "    for Windows x64 guests with vmcoreinfo driver only.\n\t\t\t"

                       "begin: the starting physical address.\n\t\t\t"
                       "length: the memory size, in bytes.",
         .cmd        = hmp_dump_guest_memory,
     },
 
                       "begin: the starting physical address.\n\t\t\t"
                       "length: the memory size, in bytes.",
         .cmd        = hmp_dump_guest_memory,
     },
 

-

 STEXI
 @item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}
 STEXI
 @item dump-guest-memory [-p] @var{filename} @var{begin} @var{length}

-@item dump-guest-memory [-z|-l|-s] @var{filename}
+@item dump-guest-memory [-z|-l|-s|-w] @var{filename}

 @findex dump-guest-memory
 Dump guest memory to @var{protocol}. The file can be processed with crash or
 @findex dump-guest-memory
 Dump guest memory to @var{protocol}. The file can be processed with crash or

-gdb. Without -z|-l|-s, the dump format is ELF.
+gdb. Without -z|-l|-s|-w, the dump format is ELF.

         -p: do paging to get guest's memory mapping.
         -z: dump in kdump-compressed format, with zlib compression.
         -l: dump in kdump-compressed format, with lzo compression.
         -s: dump in kdump-compressed format, with snappy compression.
         -p: do paging to get guest's memory mapping.
         -z: dump in kdump-compressed format, with zlib compression.
         -l: dump in kdump-compressed format, with lzo compression.
         -s: dump in kdump-compressed format, with snappy compression.

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

   filename: dump file name.
      begin: the starting physical address. It's optional, and should be
             specified together with length.
   filename: dump file name.
      begin: the starting physical address. It's optional, and should be
             specified together with length.


@@ -1812,14 +1891,16 @@ ETEXI
         .name       = "cpu-add",
         .args_type  = "id:i",
         .params     = "id",
         .name       = "cpu-add",
         .args_type  = "id:i",
         .params     = "id",

-        .help       = "add cpu",
+        .help       = "add cpu (deprecated, use device_add instead)",

         .cmd        = hmp_cpu_add,
     },
 
 STEXI
 @item cpu-add @var{id}
 @findex cpu-add
         .cmd        = hmp_cpu_add,
     },
 
 STEXI
 @item cpu-add @var{id}
 @findex cpu-add

-Add CPU with id @var{id}
+Add CPU with id @var{id}.  This command is deprecated, please
++use @code{device_add} instead. For details, refer to
+'docs/cpu-hotplug.rst'.

 ETEXI
 
     {
 ETEXI
 
     {


@@ -1828,6 +1909,7 @@ ETEXI
         .params     = "path",
         .help       = "list QOM properties",
         .cmd        = hmp_qom_list,
         .params     = "path",
         .help       = "list QOM properties",
         .cmd        = hmp_qom_list,

+        .flags      = "p",

     },
 
 STEXI
     },
 
 STEXI


@@ -1841,6 +1923,7 @@ ETEXI
         .params     = "path property value",
         .help       = "set QOM property",
         .cmd        = hmp_qom_set,
         .params     = "path property value",
         .help       = "set QOM property",
         .cmd        = hmp_qom_set,

+        .flags      = "p",

     },
 
 STEXI
     },
 
 STEXI


@@ -1854,7 +1937,8 @@ ETEXI
         .params     = "[subcommand]",
         .help       = "show various information about the system state",
         .cmd        = hmp_info_help,
         .params     = "[subcommand]",
         .help       = "show various information about the system state",
         .cmd        = hmp_info_help,

-        .sub_table  = info_cmds,
+        .sub_table  = hmp_info_cmds,
+        .flags      = "p",

     },
 
 STEXI
     },
 
 STEXI