[dpdk-dev] [PATCH] doc: update multiple instance info for NULL crypto

[dpdk-dev] [PATCH] doc: update multiple instance info for NULL crypto

[Vipin Varghese]

Add foot note & example to inform user how to use multiple instance.

Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>
---
 doc/guides/cryptodevs/null.rst | 20 +++++++++++++++++---
 1 file changed, 17 insertions(+), 3 deletions(-)

diff --git a/doc/guides/cryptodevs/null.rst b/doc/guides/cryptodevs/null.rst
index 03a3ddc..b7072b0 100644
--- a/doc/guides/cryptodevs/null.rst
+++ b/doc/guides/cryptodevs/null.rst
@@ -41,6 +41,11 @@ each mbuf in the burst will be enqueued in an internal buffer for collection on
 a dequeue call as long as the mbuf has a valid rte_mbuf_offload operation with
 a valid rte_cryptodev_session or rte_crypto_xform chain of operations.
 
+.. Note::
+
+    In case of multiple instances of NULL cryptos, each instance should be of
+    unique id.
+
 Features
 --------
 
@@ -91,7 +96,16 @@ The following parameters (all optional) can be provided in the previous two call
 
 Example:
 
-.. code-block:: console
+Single vdev instance::
+
+   ./l2fwd-crypto -l 1 -n 4 \
+   --vdev="crypto_null,socket_id=0,max_nb_sessions=128" \
+   -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "null"
+
+Multiple vdev instance::
+
+   ./l2fwd-crypto -l 1-2 -n 4 \
+   --vdev="crypto_null_0,socket_id=0,max_nb_sessions=128" \
+   --vdev="crypto_null_1,socket_id=1,max_nb_sessions=128" \
+   -- -p 0x3 --cdev SW --chain CIPHER_HASH --cipher_algo null --auth_algo null
 
-    ./l2fwd-crypto -l 1 -n 4 --vdev="crypto_null,socket_id=0,max_nb_sessions=128" \
-    -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "null"
-- 
1.9.1

Re: [dpdk-dev] [PATCH] doc: update multiple instance info for NULL crypto

[De Lara Guarch, Pablo]

Hi Vipin,

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Vipin Varghese
> Sent: Monday, February 5, 2018 2:32 PM
> To: dev@dpdk.org; Kovacevic, Marko <marko.kovacevic@intel.com>
> Cc: Mcnamara, John <john.mcnamara@intel.com>; Varghese, Vipin
> <vipin.varghese@intel.com>
> Subject: [dpdk-dev] [PATCH] doc: update multiple instance info for NULL
> crypto
> 
> Add foot note & example to inform user how to use multiple instance.
> 
> Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>
> ---
>  doc/guides/cryptodevs/null.rst | 20 +++++++++++++++++---
>  1 file changed, 17 insertions(+), 3 deletions(-)
> 
> diff --git a/doc/guides/cryptodevs/null.rst b/doc/guides/cryptodevs/null.rst
> index 03a3ddc..b7072b0 100644
> --- a/doc/guides/cryptodevs/null.rst
> +++ b/doc/guides/cryptodevs/null.rst
> @@ -41,6 +41,11 @@ each mbuf in the burst will be enqueued in an
> internal buffer for collection on  a dequeue call as long as the mbuf has a
> valid rte_mbuf_offload operation with  a valid rte_cryptodev_session or
> rte_crypto_xform chain of operations.
> 
> +.. Note::
> +
> +    In case of multiple instances of NULL cryptos, each instance should be of
> +    unique id.

I would use "NULL crypto PMDs".

> +
>  Features
>  --------
> 
> @@ -91,7 +96,16 @@ The following parameters (all optional) can be
> provided in the previous two call
> 
>  Example:
> 
> -.. code-block:: console
> +Single vdev instance::
> +
> +   ./l2fwd-crypto -l 1 -n 4 \
> +   --vdev="crypto_null,socket_id=0,max_nb_sessions=128" \
> +   -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "null"
> +
> +Multiple vdev instance::

"instances".

> +
> +   ./l2fwd-crypto -l 1-2 -n 4 \
> +   --vdev="crypto_null_0,socket_id=0,max_nb_sessions=128" \
> +   --vdev="crypto_null_1,socket_id=1,max_nb_sessions=128" \
> +   -- -p 0x3 --cdev SW --chain CIPHER_HASH --cipher_algo null
> + --auth_algo null
> 
> -    ./l2fwd-crypto -l 1 -n 4 --
> vdev="crypto_null,socket_id=0,max_nb_sessions=128" \
> -    -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "null"
> --
> 1.9.1

This looks good to me, but I think this can be extended to other PMDs, not just NULL crypto.
Could you send another version, changing the other guides (for the SW based drivers)?

Thanks,
Pablo

[dpdk-dev] [PATCH v2] doc: update multiple instance info for NULL crypto

[Vipin Varghese]

Add foot note & example to inform user how to use multiple instance.

Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>
---

V2 Changes:
 - Updated Note for better wording - Pablo
 - Multiple instance information to Crypto Device Lib - Pablo
---
 doc/guides/cryptodevs/null.rst | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/doc/guides/cryptodevs/null.rst b/doc/guides/cryptodevs/null.rst
index 03a3ddc..f476e9d 100644
--- a/doc/guides/cryptodevs/null.rst
+++ b/doc/guides/cryptodevs/null.rst
@@ -41,6 +41,10 @@ each mbuf in the burst will be enqueued in an internal buffer for collection on
 a dequeue call as long as the mbuf has a valid rte_mbuf_offload operation with
 a valid rte_cryptodev_session or rte_crypto_xform chain of operations.
 
+.. Note::
+
+    In case of multiple NULL cryptos PMD instances, each should have unique id.
+
 Features
 --------
 
@@ -91,7 +95,9 @@ The following parameters (all optional) can be provided in the previous two call
 
 Example:
 
-.. code-block:: console
+-.. code-block:: console
+
+   ./l2fwd-crypto -l 1 -n 4 \
+   --vdev="crypto_null,socket_id=0,max_nb_sessions=128" \
+   -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "null"
 
-    ./l2fwd-crypto -l 1 -n 4 --vdev="crypto_null,socket_id=0,max_nb_sessions=128" \
-    -- -p 1 --cdev SW --chain CIPHER_ONLY --cipher_algo "null"
-- 
1.9.1

[dpdk-dev] [PATCH v3] doc: add info on multiple instance SW crypto

[Vipin Varghese]

Add infomration to explain applications using multiple instances of sw
crypto with example.

Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>
---

V3 Changes:
 - moved the multiple sw crypto to more generic place holder - Pablo

V2 Changes:
 - Updated Note for better wording - Pablo
 - Multiple instance information to Crypto Device Lib - Pablo
---
 doc/guides/prog_guide/cryptodev_lib.rst | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/doc/guides/prog_guide/cryptodev_lib.rst b/doc/guides/prog_guide/cryptodev_lib.rst
index 2b338b9..d11e377 100644
--- a/doc/guides/prog_guide/cryptodev_lib.rst
+++ b/doc/guides/prog_guide/cryptodev_lib.rst
@@ -70,6 +70,15 @@ From the command line using the --vdev EAL option
 
    --vdev  'crypto_aesni_mb0,max_nb_queue_pairs=2,max_nb_sessions=1024,socket_id=0'
 
+.. Note::
+
+   * If DPDK application requires multiple software crypto PMD devices then required
+     number of ``--vdev`` with appropriate libraries are to be added.
+
+   * An Application with crypto PMD instaces sharing the same library requires unique ID.
+
+   Example: ``--vdev  'crypto_aesni_mb0' --vdev  'crypto_aesni_mb1'``
+
 Our using the rte_vdev_init API within the application code.
 
 .. code-block:: c
-- 
1.9.1

Re: [dpdk-dev] [PATCH v3] doc: add info on multiple instance SW crypto

[De Lara Guarch, Pablo]

> -----Original Message-----
> From: Varghese, Vipin
> Sent: Tuesday, February 6, 2018 4:12 PM
> To: dev@dpdk.org; De Lara Guarch, Pablo
> <pablo.de.lara.guarch@intel.com>
> Cc: stable@dpdk.org; Mcnamara, John <john.mcnamara@intel.com>;
> Kovacevic, Marko <marko.kovacevic@intel.com>; Varghese, Vipin
> <vipin.varghese@intel.com>
> Subject: [PATCH v3] doc: add info on multiple instance SW crypto
> 
> Add infomration to explain applications using multiple instances of sw
> crypto with example.
> 
> Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>
> ---
> 
> V3 Changes:
>  - moved the multiple sw crypto to more generic place holder - Pablo
> 
> V2 Changes:
>  - Updated Note for better wording - Pablo
>  - Multiple instance information to Crypto Device Lib - Pablo
> ---
>  doc/guides/prog_guide/cryptodev_lib.rst | 9 +++++++++
>  1 file changed, 9 insertions(+)
> 
> diff --git a/doc/guides/prog_guide/cryptodev_lib.rst
> b/doc/guides/prog_guide/cryptodev_lib.rst
> index 2b338b9..d11e377 100644
> --- a/doc/guides/prog_guide/cryptodev_lib.rst
> +++ b/doc/guides/prog_guide/cryptodev_lib.rst
> @@ -70,6 +70,15 @@ From the command line using the --vdev EAL option
> 
>     --vdev
> 'crypto_aesni_mb0,max_nb_queue_pairs=2,max_nb_sessions=1024,socket
> _id=0'
> 
> +.. Note::
> +
> +   * If DPDK application requires multiple software crypto PMD devices
> then required
> +     number of ``--vdev`` with appropriate libraries are to be added.
> +
> +   * An Application with crypto PMD instaces sharing the same library
> requires unique ID.

Typo: instances (which could be fixed when merging).

Also, there is no need to add stable@dpdk.org, so I will remove it from the CC list.

Apart from this:

Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>

Re: [dpdk-dev] [PATCH v3] doc: add info on multiple instance SW crypto

[Thomas Monjalon]

> > Add infomration to explain applications using multiple instances of sw
> > crypto with example.
> > 
> > Signed-off-by: Vipin Varghese <vipin.varghese@intel.com>
> 
> Typo: instances (which could be fixed when merging).
> 
> Also, there is no need to add stable@dpdk.org, so I will remove it from the CC list.
> 
> Apart from this:
> 
> Acked-by: Pablo de Lara <pablo.de.lara.guarch@intel.com>

Applied, thanks