[dpdk-dev] [PATCH] doc: add note for builtin-net-driver option

[dpdk-dev] [PATCH] doc: add note for builtin-net-driver option

[Marvin Liu]

If builtin-net-driver option is enabled, simple vhost device will not
enable protocol feature bit. QEMU vhost net device startup will be
failed without protocol feature. Then QEMU process will be aborted when
reloading virtio net driver due to previous failure.

Signed-off-by: Marvin Liu <yong.liu@intel.com>

diff --git a/doc/guides/sample_app_ug/vhost.rst b/doc/guides/sample_app_ug/vhost.rst
index 9112e7897..01adae408 100644
--- a/doc/guides/sample_app_ug/vhost.rst
+++ b/doc/guides/sample_app_ug/vhost.rst
@@ -158,6 +158,10 @@ when disabling VLAN strip. Such feature, which heavily depends on hardware,
 should be removed from this example to reduce confusion. Now, VLAN strip is
 enabled and cannot be disabled.
 
+**--builtin-net-driver**
+The builtin-net-driver option enabled very simple enqueue and dequeue function.
+This option is disabled by default.
+
 Common Issues
 -------------
 
@@ -192,3 +196,10 @@ Common Issues
   according to the NIC's property. ::
 
       make EXTRA_CFLAGS="-DMAX_QUEUES=320"
+
+* QEMU abort when builtin-net-driver option enabled
+
+  QEMU vhost net device startup will be failed without
+  VHOST_USER_F_PROTOCOL_FEATURES feature bit. Thus will cause QEMU process
+  abort when reloading virtio driver. DPDK vhost-user can be the replacement
+  of QEMU.
-- 
2.17.0

[dpdk-dev] [PATCH v2] doc: add note for builtin-net-driver option

[Marvin Liu]

Option builtin-net-driver is used to demonstrate how to implement
vhost-user driver based on vhost lib APIs. Unfortunately, very simple
vhost driver in vhost sample is incompatible with QEMU as protocol
feature not supported.

Signed-off-by: Marvin Liu <yong.liu@intel.com>
---
v2:
* Updated descriptions.
---
diff --git a/doc/guides/sample_app_ug/vhost.rst b/doc/guides/sample_app_ug/vhost.rst
index 9112e7897..396d83211 100644
--- a/doc/guides/sample_app_ug/vhost.rst
+++ b/doc/guides/sample_app_ug/vhost.rst
@@ -158,6 +158,11 @@ when disabling VLAN strip. Such feature, which heavily depends on hardware,
 should be removed from this example to reduce confusion. Now, VLAN strip is
 enabled and cannot be disabled.
 
+**--builtin-net-driver**
+Very simple enqueue and dequeue function will be used when this option is
+given. It can demonstrate how to construct vhost-user driver with vhost lib
+APIs. It is disabled by default.
+
 Common Issues
 -------------
 
@@ -192,3 +197,8 @@ Common Issues
   according to the NIC's property. ::
 
       make EXTRA_CFLAGS="-DMAX_QUEUES=320"
+
+* Option "builtin-net-driver" is incompatible with QEMU.
+
+  QEMU vhost net device start will fail if protocol feature is not
+  negotiated. DPDK virtio-user can be the replacement of QEMU.
-- 
2.17.0

Re: [dpdk-dev] [PATCH v2] doc: add note for builtin-net-driver option

[Tiwei Bie]

On Thu, Jul 26, 2018 at 10:27:38PM +0800, Marvin Liu wrote:
> Option builtin-net-driver is used to demonstrate how to implement
> vhost-user driver based on vhost lib APIs. Unfortunately, very simple
> vhost driver in vhost sample is incompatible with QEMU as protocol
> feature not supported.
> 
> Signed-off-by: Marvin Liu <yong.liu@intel.com>
> ---
> v2:
> * Updated descriptions.
> ---
> diff --git a/doc/guides/sample_app_ug/vhost.rst b/doc/guides/sample_app_ug/vhost.rst
> index 9112e7897..396d83211 100644
> --- a/doc/guides/sample_app_ug/vhost.rst
> +++ b/doc/guides/sample_app_ug/vhost.rst
> @@ -158,6 +158,11 @@ when disabling VLAN strip. Such feature, which heavily depends on hardware,
>  should be removed from this example to reduce confusion. Now, VLAN strip is
>  enabled and cannot be disabled.
>  
> +**--builtin-net-driver**
> +Very simple enqueue and dequeue function will be used when this option is
> +given. It can demonstrate how to construct vhost-user driver with vhost lib
> +APIs. It is disabled by default.

Maybe something like:

A very simple vhost-user net driver which demonstrates how to
use the generic vhost APIs will be used when this option is
given. It is disabled by default.

> +
>  Common Issues
>  -------------
>  
> @@ -192,3 +197,8 @@ Common Issues
>    according to the NIC's property. ::
>  
>        make EXTRA_CFLAGS="-DMAX_QUEUES=320"
> +
> +* Option "builtin-net-driver" is incompatible with QEMU.

Better to remove above '.'

> +
> +  QEMU vhost net device start will fail if protocol feature is not
> +  negotiated. DPDK virtio-user can be the replacement of QEMU.
> -- 
> 2.17.0
> 

[dpdk-dev] [PATCH v3] doc: add note for builtin-net-driver option

[Marvin Liu]

Very simple version of vhost-user driver in vhost sample will be used if
builtin-net-driver option is enabled. This driver is based on generic
vhost lib APIs. Unfortunately, the implementation is incompatible with
QEMU as protocol feature is not supported.

Signed-off-by: Marvin Liu <yong.liu@intel.com>

diff --git a/doc/guides/sample_app_ug/vhost.rst b/doc/guides/sample_app_ug/vhost.rst
index 9112e7897..fd42cb3f7 100644
--- a/doc/guides/sample_app_ug/vhost.rst
+++ b/doc/guides/sample_app_ug/vhost.rst
@@ -158,6 +158,10 @@ when disabling VLAN strip. Such feature, which heavily depends on hardware,
 should be removed from this example to reduce confusion. Now, VLAN strip is
 enabled and cannot be disabled.
 
+**--builtin-net-driver**
+A very simple vhost-user net driver which demonstrates how to use the generic
+vhost APIs will be used when this option is given. It is disabled by default.
+
 Common Issues
 -------------
 
@@ -192,3 +196,8 @@ Common Issues
   according to the NIC's property. ::
 
       make EXTRA_CFLAGS="-DMAX_QUEUES=320"
+
+* Option "builtin-net-driver" is incompatible with QEMU
+
+  QEMU vhost net device start will fail if protocol feature is not negotiated.
+  DPDK virtio-user pmd can be the replacement of QEMU.
-- 
2.17.0

Re: [dpdk-dev] [PATCH v3] doc: add note for builtin-net-driver option

[Mcnamara, John]

> -----Original Message-----
> From: Liu, Yong
> Sent: Tuesday, July 31, 2018 5:01 PM
> To: Mcnamara, John <john.mcnamara@intel.com>; Bie, Tiwei
> <tiwei.bie@intel.com>; dev@dpdk.org
> Cc: Liu, Yong <yong.liu@intel.com>
> Subject: [PATCH v3] doc: add note for builtin-net-driver option
> 
> Very simple version of vhost-user driver in vhost sample will be used if
> builtin-net-driver option is enabled. This driver is based on generic vhost
> lib APIs. Unfortunately, the implementation is incompatible with QEMU as
> protocol feature is not supported.
> 
> Signed-off-by: Marvin Liu <yong.liu@intel.com>

Acked-by: John McNamara <john.mcnamara@intel.com>

Re: [dpdk-dev] [PATCH v3] doc: add note for builtin-net-driver option

[Thomas Monjalon]

> > Very simple version of vhost-user driver in vhost sample will be used if
> > builtin-net-driver option is enabled. This driver is based on generic vhost
> > lib APIs. Unfortunately, the implementation is incompatible with QEMU as
> > protocol feature is not supported.
> > 
> > Signed-off-by: Marvin Liu <yong.liu@intel.com>
> 
> Acked-by: John McNamara <john.mcnamara@intel.com>

Applied, thanks