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	From: Xiao Wang <xiao.w.wang@intel.com> To: alejandro.lucero@netronome.com, tiwei.bie@intel.com Cc: maxime.coquelin@redhat.com, dev@dpdk.org, zhihong.wang@intel.com, xiaolong.ye@intel.com, Xiao Wang <xiao.w.wang@intel.com> Date: Thu, 13 Dec 2018 18:09:10 +0800 Message-Id: <20181213100910.13087-10-xiao.w.wang@intel.com> In-Reply-To: <20181213100910.13087-1-xiao.w.wang@intel.com> References: <20181213011014.110089-3-xiao.w.wang@intel.com> <20181213100910.13087-1-xiao.w.wang@intel.com> Subject: [dpdk-dev] [PATCH v3 9/9] doc: update ifc NIC document Precedence: list Errors-To: dev-bounces@dpdk.org Sender: "dev" <dev-bounces@dpdk.org>
Series	support SW assisted VDPA live migration \| [v3,0/9] support SW assisted VDPA live migration [v3,1/9] vhost: provide helper for host notifier ctrl [v3,2/9] vhost: provide helpers for virtio ring relay [v3,3/9] net/ifc: dump debug message for error [v3,4/9] net/ifc: store only registered device instance [v3,5/9] net/ifc: detect if VDPA mode is specified [v3,6/9] net/ifc: add devarg for LM mode [v3,7/9] net/ifc: use lib API for used ring logging [v3,8/9] net/ifc: support SW assisted VDPA live migration [v3,9/9] doc: update ifc NIC document

Checks

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

Commit Message

Xiao Wang 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>
---
v3:
* Add commit message for the doc update patch.
* More description on the device argument.

v2:
* 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

Patch

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