* [PULL 1/3] qapi: Reformat the dirty-limit migration doc comments
2023-08-02 7:40 [PULL 0/3] QAPI patches patches for 2023-08-02 Markus Armbruster
@ 2023-08-02 7:40 ` Markus Armbruster
2023-08-02 7:40 ` [PULL 2/3] qapi: Craft the dirty-limit capability comment Markus Armbruster
` (2 subsequent siblings)
3 siblings, 0 replies; 5+ messages in thread
From: Markus Armbruster @ 2023-08-02 7:40 UTC (permalink / raw)
To: qemu-devel; +Cc: richard.henderson, Hyman Huang(黄勇)
From: Hyman Huang(黄勇) <yong.huang@smartx.com>
Reformat the dirty-limit migration doc comments to conform
to current conventions as commit a937b6aa739 (qapi: Reformat
doc comments to conform to current conventions).
Signed-off-by: Hyman Huang(黄勇) <yong.huang@smartx.com>
Message-ID: <169073570563.19893.2928364761104733482-1@git.sr.ht>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
[Whitespace tidied up]
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/migration.json | 67 ++++++++++++++++++++++-----------------------
1 file changed, 33 insertions(+), 34 deletions(-)
diff --git a/qapi/migration.json b/qapi/migration.json
index 6b49593d2f..dffa60fd91 100644
--- a/qapi/migration.json
+++ b/qapi/migration.json
@@ -258,17 +258,17 @@
# blocked. Present and non-empty when migration is blocked.
# (since 6.0)
#
-# @dirty-limit-throttle-time-per-round: Maximum throttle time (in microseconds) of virtual
-# CPUs each dirty ring full round, which shows how
-# MigrationCapability dirty-limit affects the guest
-# during live migration. (since 8.1)
+# @dirty-limit-throttle-time-per-round: Maximum throttle time
+# (in microseconds) of virtual CPUs each dirty ring full round,
+# which shows how MigrationCapability dirty-limit affects the
+# guest during live migration. (Since 8.1)
#
-# @dirty-limit-ring-full-time: Estimated average dirty ring full time (in microseconds)
-# each dirty ring full round, note that the value equals
-# dirty ring memory size divided by average dirty page rate
-# of virtual CPU, which can be used to observe the average
-# memory load of virtual CPU indirectly. Note that zero
-# means guest doesn't dirty memory (since 8.1)
+# @dirty-limit-ring-full-time: Estimated average dirty ring full time
+# (in microseconds) for each dirty ring full round. The value
+# equals the dirty ring memory size divided by the average dirty
+# page rate of the virtual CPU, which can be used to observe the
+# average memory load of the virtual CPU indirectly. Note that
+# zero means guest doesn't dirty memory. (Since 8.1)
#
# Since: 0.14
##
@@ -519,15 +519,14 @@
# are present. 'return-path' capability must be enabled to use
# it. (since 8.1)
#
-# @dirty-limit: If enabled, migration will use the dirty-limit algo to
-# throttle down guest instead of auto-converge algo.
-# Throttle algo only works when vCPU's dirtyrate greater
-# than 'vcpu-dirty-limit', read processes in guest os
-# aren't penalized any more, so this algo can improve
-# performance of vCPU during live migration. This is an
-# optional performance feature and should not affect the
-# correctness of the existing auto-converge algo.
-# (since 8.1)
+# @dirty-limit: If enabled, migration will use the dirty-limit
+# algorithim to throttle down guest instead of auto-converge
+# algorithim. Throttle algorithim only works when vCPU's dirtyrate
+# greater than 'vcpu-dirty-limit', read processes in guest os
+# aren't penalized any more, so this algorithim can improve
+# performance of vCPU during live migration. This is an optional
+# performance feature and should not affect the correctness of the
+# existing auto-converge algorithim. (Since 8.1)
#
# Features:
#
@@ -822,17 +821,17 @@
# Nodes are mapped to their block device name if there is one, and
# to their node name otherwise. (Since 5.2)
#
-# @x-vcpu-dirty-limit-period: Periodic time (in milliseconds) of dirty limit during
-# live migration. Should be in the range 1 to 1000ms,
-# defaults to 1000ms. (Since 8.1)
+# @x-vcpu-dirty-limit-period: Periodic time (in milliseconds) of dirty
+# limit during live migration. Should be in the range 1 to 1000ms.
+# Defaults to 1000ms. (Since 8.1)
#
# @vcpu-dirty-limit: Dirtyrate limit (MB/s) during live migration.
-# Defaults to 1. (Since 8.1)
+# Defaults to 1. (Since 8.1)
#
# Features:
#
# @unstable: Members @x-checkpoint-delay and @x-vcpu-dirty-limit-period
-# are experimental.
+# are experimental.
#
# Since: 2.4
##
@@ -988,17 +987,17 @@
# Nodes are mapped to their block device name if there is one, and
# to their node name otherwise. (Since 5.2)
#
-# @x-vcpu-dirty-limit-period: Periodic time (in milliseconds) of dirty limit during
-# live migration. Should be in the range 1 to 1000ms,
-# defaults to 1000ms. (Since 8.1)
+# @x-vcpu-dirty-limit-period: Periodic time (in milliseconds) of dirty
+# limit during live migration. Should be in the range 1 to 1000ms.
+# Defaults to 1000ms. (Since 8.1)
#
# @vcpu-dirty-limit: Dirtyrate limit (MB/s) during live migration.
-# Defaults to 1. (Since 8.1)
+# Defaults to 1. (Since 8.1)
#
# Features:
#
# @unstable: Members @x-checkpoint-delay and @x-vcpu-dirty-limit-period
-# are experimental.
+# are experimental.
#
# TODO: either fuse back into MigrationParameters, or make
# MigrationParameters members mandatory
@@ -1191,17 +1190,17 @@
# Nodes are mapped to their block device name if there is one, and
# to their node name otherwise. (Since 5.2)
#
-# @x-vcpu-dirty-limit-period: Periodic time (in milliseconds) of dirty limit during
-# live migration. Should be in the range 1 to 1000ms,
-# defaults to 1000ms. (Since 8.1)
+# @x-vcpu-dirty-limit-period: Periodic time (in milliseconds) of dirty
+# limit during live migration. Should be in the range 1 to 1000ms.
+# Defaults to 1000ms. (Since 8.1)
#
# @vcpu-dirty-limit: Dirtyrate limit (MB/s) during live migration.
-# Defaults to 1. (Since 8.1)
+# Defaults to 1. (Since 8.1)
#
# Features:
#
# @unstable: Members @x-checkpoint-delay and @x-vcpu-dirty-limit-period
-# are experimental.
+# are experimental.
#
# Since: 2.4
##
--
2.41.0
^ permalink raw reply related [flat|nested] 5+ messages in thread* [PULL 2/3] qapi: Craft the dirty-limit capability comment
2023-08-02 7:40 [PULL 0/3] QAPI patches patches for 2023-08-02 Markus Armbruster
2023-08-02 7:40 ` [PULL 1/3] qapi: Reformat the dirty-limit migration doc comments Markus Armbruster
@ 2023-08-02 7:40 ` Markus Armbruster
2023-08-02 7:40 ` [PULL 3/3] MAINTAINERS: Add section "Migration dirty limit and dirty page rate" Markus Armbruster
2023-08-02 15:14 ` [PULL 0/3] QAPI patches patches for 2023-08-02 Richard Henderson
3 siblings, 0 replies; 5+ messages in thread
From: Markus Armbruster @ 2023-08-02 7:40 UTC (permalink / raw)
To: qemu-devel; +Cc: richard.henderson, Hyman Huang(黄勇)
From: Hyman Huang(黄勇) <yong.huang@smartx.com>
Signed-off-by: Hyman Huang(黄勇) <yong.huang@smartx.com>
Message-ID: <169073570563.19893.2928364761104733482-2@git.sr.ht>
Reviewed-by: Markus Armbruster <armbru@redhat.com>
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
qapi/migration.json | 13 +++++--------
1 file changed, 5 insertions(+), 8 deletions(-)
diff --git a/qapi/migration.json b/qapi/migration.json
index dffa60fd91..8843e74b59 100644
--- a/qapi/migration.json
+++ b/qapi/migration.json
@@ -519,14 +519,11 @@
# are present. 'return-path' capability must be enabled to use
# it. (since 8.1)
#
-# @dirty-limit: If enabled, migration will use the dirty-limit
-# algorithim to throttle down guest instead of auto-converge
-# algorithim. Throttle algorithim only works when vCPU's dirtyrate
-# greater than 'vcpu-dirty-limit', read processes in guest os
-# aren't penalized any more, so this algorithim can improve
-# performance of vCPU during live migration. This is an optional
-# performance feature and should not affect the correctness of the
-# existing auto-converge algorithim. (Since 8.1)
+# @dirty-limit: If enabled, migration will throttle vCPUs as needed to
+# keep their dirty page rate within @vcpu-dirty-limit. This can
+# improve responsiveness of large guests during live migration,
+# and can result in more stable read performance. Requires KVM
+# with accelerator property "dirty-ring-size" set. (Since 8.1)
#
# Features:
#
--
2.41.0
^ permalink raw reply related [flat|nested] 5+ messages in thread