[v2] doc: announce change in crypto raw data vector

Message ID 20210805135529.14146-1-hemant.agrawal@nxp.com (mailing list archive)
State Accepted, archived
Headers
Series [v2] doc: announce change in crypto raw data vector |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/github-robot fail github build: failed
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-spell-check-testing warning Testing issues
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-aarch64-unit-testing success Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-abi-testing success Testing PASS
ci/iol-x86_64-compile-testing fail Testing issues
ci/iol-x86_64-unit-testing success Testing PASS

Commit Message

Hemant Agrawal Aug. 5, 2021, 1:55 p.m. UTC
  The current crypto raw data vectors need to be extended to support
out of place processing. It is proposed to add additional desl_sgl
to provide details for destination sgl.
The same is also extended to support rte_security usecases, where
we need total data length to know how much additional memory space
is available in buffer other than data length so that driver/HW
can write expanded size data after encryption.

Signed-off-by: Gagandeep Singh <G.Singh@nxp.com>
Signed-off-by: Hemant Agrawal <hemant.agrawal@nxp.com>
---
 doc/guides/rel_notes/deprecation.rst | 12 ++++++++++++
 1 file changed, 12 insertions(+)
  

Comments

Akhil Goyal Aug. 5, 2021, 2:04 p.m. UTC | #1
> The current crypto raw data vectors need to be extended to support
> out of place processing. It is proposed to add additional desl_sgl
> to provide details for destination sgl.
> The same is also extended to support rte_security usecases, where
> we need total data length to know how much additional memory space
> is available in buffer other than data length so that driver/HW
> can write expanded size data after encryption.
> 
> Signed-off-by: Gagandeep Singh <G.Singh@nxp.com>
> Signed-off-by: Hemant Agrawal <hemant.agrawal@nxp.com>
> ---
>  doc/guides/rel_notes/deprecation.rst | 12 ++++++++++++
>  1 file changed, 12 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst
> b/doc/guides/rel_notes/deprecation.rst
> index f4a4d00db2..c19a306c93 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -193,3 +193,15 @@ Deprecation Notices
>    reserved bytes to 2 (from 3), and use 1 byte to indicate warnings and other
>    information from the crypto/security operation. This field will be used to
>    communicate events such as soft expiry with IPsec in lookaside mode.
> +
> +* cryptodev: The structure ``rte_crypto_sym_vec`` would be updated to add
> +  ``dest_sgl`` to support out of place processing. This field will be null for
> +  inplace processing. This change is targeted for DPDK 21.11
> +
> +* cryptodev: The structure ``rte_crypto_vec`` would be updated to add
> +  ``tot_len`` to support total buffer length. This is required for security
> +  cases like IPsec and PDCP encryption offload to know how much additional
> +  memory space is available in buffer other than data length so that
> driver/HW
> +  can write expanded size data after encryption. This change is targeted for
> +  DPDK 21.11
> +
Acked-by: Akhil Goyal <gakhil@marvell.com>
  
Hemant Agrawal Aug. 6, 2021, 6:35 a.m. UTC | #2
ping for review.


On 8/5/2021 7:25 PM, Hemant Agrawal wrote:
> The current crypto raw data vectors need to be extended to support
> out of place processing. It is proposed to add additional desl_sgl
> to provide details for destination sgl.
> The same is also extended to support rte_security usecases, where
> we need total data length to know how much additional memory space
> is available in buffer other than data length so that driver/HW
> can write expanded size data after encryption.
>
> Signed-off-by: Gagandeep Singh <G.Singh@nxp.com>
> Signed-off-by: Hemant Agrawal <hemant.agrawal@nxp.com>
> ---
>   doc/guides/rel_notes/deprecation.rst | 12 ++++++++++++
>   1 file changed, 12 insertions(+)
>
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index f4a4d00db2..c19a306c93 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -193,3 +193,15 @@ Deprecation Notices
>     reserved bytes to 2 (from 3), and use 1 byte to indicate warnings and other
>     information from the crypto/security operation. This field will be used to
>     communicate events such as soft expiry with IPsec in lookaside mode.
> +
> +* cryptodev: The structure ``rte_crypto_sym_vec`` would be updated to add
> +  ``dest_sgl`` to support out of place processing. This field will be null for
> +  inplace processing. This change is targeted for DPDK 21.11
> +
> +* cryptodev: The structure ``rte_crypto_vec`` would be updated to add
> +  ``tot_len`` to support total buffer length. This is required for security
> +  cases like IPsec and PDCP encryption offload to know how much additional
> +  memory space is available in buffer other than data length so that driver/HW
> +  can write expanded size data after encryption. This change is targeted for
> +  DPDK 21.11
> +
  
Ananyev, Konstantin Aug. 6, 2021, 10:04 a.m. UTC | #3
Hi Hemant,

> > The current crypto raw data vectors need to be extended to support
> > out of place processing. It is proposed to add additional desl_sgl
> > to provide details for destination sgl.
> > The same is also extended to support rte_security usecases, where
> > we need total data length to know how much additional memory space
> > is available in buffer other than data length so that driver/HW
> > can write expanded size data after encryption.
> >
> > Signed-off-by: Gagandeep Singh <G.Singh@nxp.com>
> > Signed-off-by: Hemant Agrawal <hemant.agrawal@nxp.com>
> > ---
> >   doc/guides/rel_notes/deprecation.rst | 12 ++++++++++++
> >   1 file changed, 12 insertions(+)
> >
> > diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> > index f4a4d00db2..c19a306c93 100644
> > --- a/doc/guides/rel_notes/deprecation.rst
> > +++ b/doc/guides/rel_notes/deprecation.rst
> > @@ -193,3 +193,15 @@ Deprecation Notices
> >     reserved bytes to 2 (from 3), and use 1 byte to indicate warnings and other
> >     information from the crypto/security operation. This field will be used to
> >     communicate events such as soft expiry with IPsec in lookaside mode.
> > +
> > +* cryptodev: The structure ``rte_crypto_sym_vec`` would be updated to add
> > +  ``dest_sgl`` to support out of place processing. This field will be null for
> > +  inplace processing. This change is targeted for DPDK 21.11

Seems ok to me, just one question:
would layout (number of elems in SG, length of each elem)
for sgl and dest_sgl always be identical? 

> > +
> > +* cryptodev: The structure ``rte_crypto_vec`` would be updated to add
> > +  ``tot_len`` to support total buffer length. This is required for security
> > +  cases like IPsec and PDCP encryption offload to know how much additional
> > +  memory space is available in buffer other than data length so that driver/HW
> > +  can write expanded size data after encryption. This change is targeted for
> > +  DPDK 21.11
> > +

Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
  
Hemant Agrawal Aug. 6, 2021, 10:25 a.m. UTC | #4
Hi Konstantin

On 8/6/2021 3:34 PM, Ananyev, Konstantin wrote:
> Hi Hemant,
>
>>> The current crypto raw data vectors need to be extended to support
>>> out of place processing. It is proposed to add additional desl_sgl
>>> to provide details for destination sgl.
>>> The same is also extended to support rte_security usecases, where
>>> we need total data length to know how much additional memory space
>>> is available in buffer other than data length so that driver/HW
>>> can write expanded size data after encryption.
>>>
>>> Signed-off-by: Gagandeep Singh <G.Singh@nxp.com>
>>> Signed-off-by: Hemant Agrawal <hemant.agrawal@nxp.com>
>>> ---
>>>    doc/guides/rel_notes/deprecation.rst | 12 ++++++++++++
>>>    1 file changed, 12 insertions(+)
>>>
>>> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
>>> index f4a4d00db2..c19a306c93 100644
>>> --- a/doc/guides/rel_notes/deprecation.rst
>>> +++ b/doc/guides/rel_notes/deprecation.rst
>>> @@ -193,3 +193,15 @@ Deprecation Notices
>>>      reserved bytes to 2 (from 3), and use 1 byte to indicate warnings and other
>>>      information from the crypto/security operation. This field will be used to
>>>      communicate events such as soft expiry with IPsec in lookaside mode.
>>> +
>>> +* cryptodev: The structure ``rte_crypto_sym_vec`` would be updated to add
>>> +  ``dest_sgl`` to support out of place processing. This field will be null for
>>> +  inplace processing. This change is targeted for DPDK 21.11
> Seems ok to me, just one question:
> would layout (number of elems in SG, length of each elem)
> for sgl and dest_sgl always be identical?

No, there shall not be any such restriction. Both source and destination 
can be different buffer  with their own number of elem (if any) and 
length of each elem.

>>> +
>>> +* cryptodev: The structure ``rte_crypto_vec`` would be updated to add
>>> +  ``tot_len`` to support total buffer length. This is required for security
>>> +  cases like IPsec and PDCP encryption offload to know how much additional
>>> +  memory space is available in buffer other than data length so that driver/HW
>>> +  can write expanded size data after encryption. This change is targeted for
>>> +  DPDK 21.11
>>> +
> Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
>
  
Ananyev, Konstantin Aug. 6, 2021, 10:38 a.m. UTC | #5
> >>> The current crypto raw data vectors need to be extended to support
> >>> out of place processing. It is proposed to add additional desl_sgl
> >>> to provide details for destination sgl.
> >>> The same is also extended to support rte_security usecases, where
> >>> we need total data length to know how much additional memory space
> >>> is available in buffer other than data length so that driver/HW
> >>> can write expanded size data after encryption.
> >>>
> >>> Signed-off-by: Gagandeep Singh <G.Singh@nxp.com>
> >>> Signed-off-by: Hemant Agrawal <hemant.agrawal@nxp.com>
> >>> ---
> >>>    doc/guides/rel_notes/deprecation.rst | 12 ++++++++++++
> >>>    1 file changed, 12 insertions(+)
> >>>
> >>> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> >>> index f4a4d00db2..c19a306c93 100644
> >>> --- a/doc/guides/rel_notes/deprecation.rst
> >>> +++ b/doc/guides/rel_notes/deprecation.rst
> >>> @@ -193,3 +193,15 @@ Deprecation Notices
> >>>      reserved bytes to 2 (from 3), and use 1 byte to indicate warnings and other
> >>>      information from the crypto/security operation. This field will be used to
> >>>      communicate events such as soft expiry with IPsec in lookaside mode.
> >>> +
> >>> +* cryptodev: The structure ``rte_crypto_sym_vec`` would be updated to add
> >>> +  ``dest_sgl`` to support out of place processing. This field will be null for
> >>> +  inplace processing. This change is targeted for DPDK 21.11
> > Seems ok to me, just one question:
> > would layout (number of elems in SG, length of each elem)
> > for sgl and dest_sgl always be identical?
> 
> No, there shall not be any such restriction. Both source and destination
> can be different buffer  with their own number of elem (if any) and
> length of each elem.

Ok, thanks for clarification.

> 
> >>> +
> >>> +* cryptodev: The structure ``rte_crypto_vec`` would be updated to add
> >>> +  ``tot_len`` to support total buffer length. This is required for security
> >>> +  cases like IPsec and PDCP encryption offload to know how much additional
> >>> +  memory space is available in buffer other than data length so that driver/HW
> >>> +  can write expanded size data after encryption. This change is targeted for
> >>> +  DPDK 21.11
> >>> +
> > Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
> >
  
Thomas Monjalon Aug. 7, 2021, 3:17 p.m. UTC | #6
05/08/2021 16:04, Akhil Goyal:
> > The current crypto raw data vectors need to be extended to support
> > out of place processing. It is proposed to add additional desl_sgl
> > to provide details for destination sgl.
> > The same is also extended to support rte_security usecases, where
> > we need total data length to know how much additional memory space
> > is available in buffer other than data length so that driver/HW
> > can write expanded size data after encryption.
> > 
> > Signed-off-by: Gagandeep Singh <G.Singh@nxp.com>
> > Signed-off-by: Hemant Agrawal <hemant.agrawal@nxp.com>
> > ---
> > +* cryptodev: The structure ``rte_crypto_sym_vec`` would be updated to add
> > +  ``dest_sgl`` to support out of place processing. This field will be null for
> > +  inplace processing. This change is targeted for DPDK 21.11
> > +
> > +* cryptodev: The structure ``rte_crypto_vec`` would be updated to add
> > +  ``tot_len`` to support total buffer length. This is required for security
> > +  cases like IPsec and PDCP encryption offload to know how much additional
> > +  memory space is available in buffer other than data length so that
> > driver/HW
> > +  can write expanded size data after encryption. This change is targeted for
> > +  DPDK 21.11
> > +
> Acked-by: Akhil Goyal <gakhil@marvell.com>
Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
Acked-by: Thomas Monjalon <thomas@monjalon.net>

Applied, thanks.
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index f4a4d00db2..c19a306c93 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -193,3 +193,15 @@  Deprecation Notices
   reserved bytes to 2 (from 3), and use 1 byte to indicate warnings and other
   information from the crypto/security operation. This field will be used to
   communicate events such as soft expiry with IPsec in lookaside mode.
+
+* cryptodev: The structure ``rte_crypto_sym_vec`` would be updated to add
+  ``dest_sgl`` to support out of place processing. This field will be null for
+  inplace processing. This change is targeted for DPDK 21.11
+
+* cryptodev: The structure ``rte_crypto_vec`` would be updated to add
+  ``tot_len`` to support total buffer length. This is required for security
+  cases like IPsec and PDCP encryption offload to know how much additional
+  memory space is available in buffer other than data length so that driver/HW
+  can write expanded size data after encryption. This change is targeted for
+  DPDK 21.11
+