diff mbox series

[v5,10/10] doc: update ifc NIC document

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

Checks

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

Commit Message

Xiao Wang Dec. 18, 2018, 8:02 a.m. UTC 
  Add the SW assisted VDPA live migration feature into NIC doc.

Signed-off-by: Xiao Wang <xiao.w.wang@intel.com>
---
 doc/guides/nics/ifc.rst                | 12 +++++++++++-
 doc/guides/rel_notes/release_19_02.rst |  6 ++++++
 2 files changed, 17 insertions(+), 1 deletion(-)

Comments

Maxime Coquelin Dec. 18, 2018, 11:35 a.m. UTC | #1 
On 12/18/18 9:02 AM, Xiao Wang wrote:
> Add the SW assisted VDPA live migration feature into NIC doc.
> 
> Signed-off-by: Xiao Wang <xiao.w.wang@intel.com>
> ---
>   doc/guides/nics/ifc.rst                | 12 +++++++++++-
>   doc/guides/rel_notes/release_19_02.rst |  6 ++++++
>   2 files changed, 17 insertions(+), 1 deletion(-)
> 

Reviewed-by: Maxime Coquelin <maxime.coquelin@redhat.com>

Thanks,
Maxime
diff mbox series

Patch

diff --git a/doc/guides/nics/ifc.rst b/doc/guides/nics/ifc.rst
index 48f9adf1d..bdf7b4e4a 100644
--- a/doc/guides/nics/ifc.rst
+++ b/doc/guides/nics/ifc.rst
@@ -31,7 +31,8 @@  IFCVF's vendor ID and device ID are same as that of virtio net pci device,
 with its specific subsystem vendor ID and device ID. To let the device be
 probed by IFCVF driver, adding "vdpa=1" parameter helps to specify that this
 device is to be used in vDPA mode, rather than polling mode, virtio pmd will
-skip when it detects this message.
+skip when it detects this message. If no this parameter specified, device
+will not be used as a vDPA device, and it will be driven by virtio pmd.
 
 Different VF devices serve different virtio frontends which are in different
 VMs, so each VF needs to have its own DMA address translation service. During
@@ -39,6 +40,14 @@  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 "sw-live-migration=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 this parameter specified, driver will rely on device's logging
+capability.
+
 Key IFCVF vDPA driver ops
 ~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -70,6 +79,7 @@  Features
 Features of the IFCVF driver are:
 
 - Compatibility with virtio 0.95 and 1.0.
+- SW assisted vDPA live migration.
 
 
 Prerequisites
diff --git a/doc/guides/rel_notes/release_19_02.rst b/doc/guides/rel_notes/release_19_02.rst
index e86ef9511..131216e19 100644
--- a/doc/guides/rel_notes/release_19_02.rst
+++ b/doc/guides/rel_notes/release_19_02.rst
@@ -60,6 +60,12 @@  New Features
   * Added the handler to get firmware version string.
   * Added support for multicast filtering.
 
+* **Added 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 mediated SW relay can help
+  devices to track dirty pages caused by DMA. IFC driver has enabled this
+  SW-assisted live migration mode.
 
 Removed Items
 -------------