diff mbox series

[v3,9/9] doc: update ifc NIC document

Message ID 20181213100910.13087-10-xiao.w.wang@intel.com (mailing list archive)
State Superseded, archived
Delegated to: Maxime Coquelin
Headers show
Series support SW assisted VDPA live migration | expand


Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK

Commit Message

Wang, Xiao W Dec. 13, 2018, 10:09 a.m. UTC
Add the SW assisted VDPA live migration feature into NIC doc.

Signed-off-by: Xiao Wang <xiao.w.wang@intel.com>
* Add commit message for the doc update patch.
* More description on the device argument.

* Add release note.
 doc/guides/nics/ifc.rst                | 8 ++++++++
 doc/guides/rel_notes/release_19_02.rst | 5 +++++
 2 files changed, 13 insertions(+)
diff mbox series


diff --git a/doc/guides/nics/ifc.rst b/doc/guides/nics/ifc.rst
index 48f9adf1d..eb55d329a 100644
--- a/doc/guides/nics/ifc.rst
+++ b/doc/guides/nics/ifc.rst
@@ -39,6 +39,13 @@  the driver probe a new container is created for this device, with this
 container vDPA driver can program DMA remapping table with the VM's memory
 region information.
+The device argument "swlm=1" will configure the driver into SW assisted live
+migration mode. In this mode, the driver will set up a SW relay thread when LM
+happens, this thread will help device to log dirty pages. Thus this mode does
+not require HW to implement a dirty page logging function block, but will
+consume some percentage of CPU resource depending on the network throughput.
+If no "swlm=1" specified, driver will rely on device's logging capability.
 Key IFCVF vDPA driver ops
@@ -70,6 +77,7 @@  Features
 Features of the IFCVF driver are:
 - Compatibility with virtio 0.95 and 1.0.
+- SW assisted vDPA live migration.
diff --git a/doc/guides/rel_notes/release_19_02.rst b/doc/guides/rel_notes/release_19_02.rst
index a94fa86a7..ea3909631 100644
--- a/doc/guides/rel_notes/release_19_02.rst
+++ b/doc/guides/rel_notes/release_19_02.rst
@@ -54,6 +54,11 @@  New Features
      Also, make sure to start the actual text at the margin.
+* **Add support for SW-assisted VDPA live migration.**
+  This SW-assisted VDPA live migration facility helps VDPA devices without
+  logging capability to perform live migration, a mediate SW relay can help
+  devices to track dirty pages caused by DMA. IFC driver has enabled this
+  SW-assisted live migration mode.
 Removed Items