[v3] doc: add cryptodev xform deprecation notice

Message ID 20190322163431.28921-1-roy.fan.zhang@intel.com
State Accepted, archived
Delegated to: akhil goyal
Headers show
Series
  • [v3] doc: add cryptodev xform deprecation notice
Related show

Checks

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

Commit Message

Fan Zhang March 22, 2019, 4:34 p.m.
This patch adds the deprecation notice of changing Cryptodev
symmetric xform structure. The proposed change is to making
key pointers in the crypto xforms (cipher, auth, aead) to
indicate neither the library or the drivers will not change
the content of the key buffer.

Signed-off-by: Fan Zhang <roy.fan.zhang@intel.com>
---
v3:
- Removed target release.

v2:
- Added description.

 doc/guides/rel_notes/deprecation.rst | 4 ++++
 1 file changed, 4 insertions(+)

Comments

Akhil Goyal March 29, 2019, 1:59 p.m. | #1
On 3/22/2019 10:04 PM, Fan Zhang wrote:
> This patch adds the deprecation notice of changing Cryptodev
> symmetric xform structure. The proposed change is to making
> key pointers in the crypto xforms (cipher, auth, aead) to
> indicate neither the library or the drivers will not change
> the content of the key buffer.
>
> Signed-off-by: Fan Zhang <roy.fan.zhang@intel.com>
> ---
> v3:
> - Removed target release.
>
> v2:
> - Added description.
>
>   doc/guides/rel_notes/deprecation.rst | 4 ++++
>   1 file changed, 4 insertions(+)
>
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 1b4fcb7e6..f35ac5b96 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -75,3 +75,7 @@ Deprecation Notices
>   
>   * crypto/aesni_mb: the minimum supported intel-ipsec-mb library version will be
>     changed from 0.49.0 to 0.52.0.
> +
> +* cryptodev: the ``uint8_t *data`` member of ``key`` structure in the xforms
> +  structure (``rte_crypto_cipher_xform``, ``rte_crypto_auth_xform``, and
> +  ``rte_crypto_aead_xform``) will be changed to ``const uint8_t *data``.
Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
Akhil Goyal March 29, 2019, 2:15 p.m. | #2
On 3/29/2019 7:29 PM, Akhil Goyal wrote:
>
> On 3/22/2019 10:04 PM, Fan Zhang wrote:
>> This patch adds the deprecation notice of changing Cryptodev
>> symmetric xform structure. The proposed change is to making
>> key pointers in the crypto xforms (cipher, auth, aead) to
>> indicate neither the library or the drivers will not change
>> the content of the key buffer.
>>
>> Signed-off-by: Fan Zhang <roy.fan.zhang@intel.com>
>> ---
>> v3:
>> - Removed target release.
>>
>> v2:
>> - Added description.
>>
>>    doc/guides/rel_notes/deprecation.rst | 4 ++++
>>    1 file changed, 4 insertions(+)
>>
>> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
>> index 1b4fcb7e6..f35ac5b96 100644
>> --- a/doc/guides/rel_notes/deprecation.rst
>> +++ b/doc/guides/rel_notes/deprecation.rst
>> @@ -75,3 +75,7 @@ Deprecation Notices
>>    
>>    * crypto/aesni_mb: the minimum supported intel-ipsec-mb library version will be
>>      changed from 0.49.0 to 0.52.0.
>> +
>> +* cryptodev: the ``uint8_t *data`` member of ``key`` structure in the xforms
>> +  structure (``rte_crypto_cipher_xform``, ``rte_crypto_auth_xform``, and
>> +  ``rte_crypto_aead_xform``) will be changed to ``const uint8_t *data``.
> Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
delegated to master.
should be applied along with
http://patches.dpdk.org/patch/51395/
Akhil Goyal March 29, 2019, 3:49 p.m. | #3
On 3/29/2019 7:45 PM, Akhil Goyal wrote:
>
> On 3/29/2019 7:29 PM, Akhil Goyal wrote:
>> On 3/22/2019 10:04 PM, Fan Zhang wrote:
>>> This patch adds the deprecation notice of changing Cryptodev
>>> symmetric xform structure. The proposed change is to making
>>> key pointers in the crypto xforms (cipher, auth, aead) to
>>> indicate neither the library or the drivers will not change
>>> the content of the key buffer.
>>>
>>> Signed-off-by: Fan Zhang <roy.fan.zhang@intel.com>
>>> ---
>>> v3:
>>> - Removed target release.
>>>
>>> v2:
>>> - Added description.
>>>
>>>     doc/guides/rel_notes/deprecation.rst | 4 ++++
>>>     1 file changed, 4 insertions(+)
>>>
>>> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
>>> index 1b4fcb7e6..f35ac5b96 100644
>>> --- a/doc/guides/rel_notes/deprecation.rst
>>> +++ b/doc/guides/rel_notes/deprecation.rst
>>> @@ -75,3 +75,7 @@ Deprecation Notices
>>>     
>>>     * crypto/aesni_mb: the minimum supported intel-ipsec-mb library version will be
>>>       changed from 0.49.0 to 0.52.0.
>>> +
>>> +* cryptodev: the ``uint8_t *data`` member of ``key`` structure in the xforms
>>> +  structure (``rte_crypto_cipher_xform``, ``rte_crypto_auth_xform``, and
>>> +  ``rte_crypto_aead_xform``) will be changed to ``const uint8_t *data``.
>> Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
> delegated to master.
> should be applied along with
> http://patches.dpdk.org/patch/51395/
>
Applied to dpdk-next-crypto
Thanks.
Akhil Goyal March 29, 2019, 3:59 p.m. | #4
On 3/29/2019 9:19 PM, Akhil Goyal wrote:
>
> On 3/29/2019 7:45 PM, Akhil Goyal wrote:
>> On 3/29/2019 7:29 PM, Akhil Goyal wrote:
>>> On 3/22/2019 10:04 PM, Fan Zhang wrote:
>>>> This patch adds the deprecation notice of changing Cryptodev
>>>> symmetric xform structure. The proposed change is to making
>>>> key pointers in the crypto xforms (cipher, auth, aead) to
>>>> indicate neither the library or the drivers will not change
>>>> the content of the key buffer.
>>>>
>>>> Signed-off-by: Fan Zhang <roy.fan.zhang@intel.com>
>>>> ---
>>>> v3:
>>>> - Removed target release.
>>>>
>>>> v2:
>>>> - Added description.
>>>>
>>>>      doc/guides/rel_notes/deprecation.rst | 4 ++++
>>>>      1 file changed, 4 insertions(+)
>>>>
>>>> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
>>>> index 1b4fcb7e6..f35ac5b96 100644
>>>> --- a/doc/guides/rel_notes/deprecation.rst
>>>> +++ b/doc/guides/rel_notes/deprecation.rst
>>>> @@ -75,3 +75,7 @@ Deprecation Notices
>>>>      
>>>>      * crypto/aesni_mb: the minimum supported intel-ipsec-mb library version will be
>>>>        changed from 0.49.0 to 0.52.0.
>>>> +
>>>> +* cryptodev: the ``uint8_t *data`` member of ``key`` structure in the xforms
>>>> +  structure (``rte_crypto_cipher_xform``, ``rte_crypto_auth_xform``, and
>>>> +  ``rte_crypto_aead_xform``) will be changed to ``const uint8_t *data``.
>>> Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
>> delegated to master.
>> should be applied along with
>> http://patches.dpdk.org/patch/51395/
>>
> Applied to dpdk-next-crypto
> Thanks.
>
This patch is proposing that there will be change in the xform 
structure(API breakage) and the change is happening in the same release. 
I suppose this is not allowed.

@Thomas: Could you please suggest if the deprecation notice should be 
added in this release and the changes in the next release?

As of now not taking this patch and the proposed changes in the drivers 
in RC1.

-Akhil
Thomas Monjalon March 29, 2019, 7:56 p.m. | #5
29/03/2019 16:59, Akhil Goyal:
> 
> On 3/29/2019 9:19 PM, Akhil Goyal wrote:
> >
> > On 3/29/2019 7:45 PM, Akhil Goyal wrote:
> >> On 3/29/2019 7:29 PM, Akhil Goyal wrote:
> >>> On 3/22/2019 10:04 PM, Fan Zhang wrote:
> >>>> This patch adds the deprecation notice of changing Cryptodev
> >>>> symmetric xform structure. The proposed change is to making
> >>>> key pointers in the crypto xforms (cipher, auth, aead) to
> >>>> indicate neither the library or the drivers will not change
> >>>> the content of the key buffer.
> >>>>
> >>>> Signed-off-by: Fan Zhang <roy.fan.zhang@intel.com>
> >>>> ---
> >>>> v3:
> >>>> - Removed target release.
> >>>>
> >>>> v2:
> >>>> - Added description.
> >>>>
> >>>>      doc/guides/rel_notes/deprecation.rst | 4 ++++
> >>>>      1 file changed, 4 insertions(+)
> >>>>
> >>>> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> >>>> index 1b4fcb7e6..f35ac5b96 100644
> >>>> --- a/doc/guides/rel_notes/deprecation.rst
> >>>> +++ b/doc/guides/rel_notes/deprecation.rst
> >>>> @@ -75,3 +75,7 @@ Deprecation Notices
> >>>>      
> >>>>      * crypto/aesni_mb: the minimum supported intel-ipsec-mb library version will be
> >>>>        changed from 0.49.0 to 0.52.0.
> >>>> +
> >>>> +* cryptodev: the ``uint8_t *data`` member of ``key`` structure in the xforms
> >>>> +  structure (``rte_crypto_cipher_xform``, ``rte_crypto_auth_xform``, and
> >>>> +  ``rte_crypto_aead_xform``) will be changed to ``const uint8_t *data``.
> >>> Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
> >> delegated to master.
> >> should be applied along with
> >> http://patches.dpdk.org/patch/51395/
> >>
> > Applied to dpdk-next-crypto
> > Thanks.
> >
> This patch is proposing that there will be change in the xform 
> structure(API breakage) and the change is happening in the same release. 
> I suppose this is not allowed.
> 
> @Thomas: Could you please suggest if the deprecation notice should be 
> added in this release and the changes in the next release?

First of all, we must avoid breaking API.
If it is not avoidable, we must announce it and do the change in
the next release.
Trahe, Fiona April 1, 2019, 4:29 p.m. | #6
> -----Original Message-----
> From: Zhang, Roy Fan
> Sent: Friday, March 22, 2019 4:35 PM
> To: dev@dpdk.org
> Cc: akhil.goyal@nxp.com; Zhang, Roy Fan <roy.fan.zhang@intel.com>; Kusztal, ArkadiuszX
> <arkadiuszx.kusztal@intel.com>; De Lara Guarch, Pablo <pablo.de.lara.guarch@intel.com>; Doherty,
> Declan <declan.doherty@intel.com>; Trahe, Fiona <fiona.trahe@intel.com>
> Subject: [PATCH v3] doc: add cryptodev xform deprecation notice
> 
> This patch adds the deprecation notice of changing Cryptodev
> symmetric xform structure. The proposed change is to making
> key pointers in the crypto xforms (cipher, auth, aead) to
> indicate neither the library or the drivers will not change
> the content of the key buffer.
> 
> Signed-off-by: Fan Zhang <roy.fan.zhang@intel.com>
Acked-by: Fiona Trahe <fiona.trahe@intel.com>
Anoob Joseph April 3, 2019, 9:11 a.m. | #7
> -----Original Message-----
> From: dev <dev-bounces@dpdk.org> On Behalf Of Fan Zhang
> Sent: Friday, March 22, 2019 10:05 PM
> To: dev@dpdk.org
> Cc: akhil.goyal@nxp.com; roy.fan.zhang@intel.com;
> arkadiuszx.kusztal@intel.com; pablo.de.lara.guarch@intel.com;
> declan.doherty@intel.com; fiona.trahe@intel.com
> Subject: [dpdk-dev] [PATCH v3] doc: add cryptodev xform deprecation notice
> 
> This patch adds the deprecation notice of changing Cryptodev symmetric xform
> structure. The proposed change is to making key pointers in the crypto xforms
> (cipher, auth, aead) to indicate neither the library or the drivers will not change
> the content of the key buffer.
> 
> Signed-off-by: Fan Zhang <roy.fan.zhang@intel.com>
> ---
> v3:
> - Removed target release.
> 
> v2:
> - Added description.
> 
>  doc/guides/rel_notes/deprecation.rst | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst
> b/doc/guides/rel_notes/deprecation.rst
> index 1b4fcb7e6..f35ac5b96 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -75,3 +75,7 @@ Deprecation Notices
> 
>  * crypto/aesni_mb: the minimum supported intel-ipsec-mb library version will
> be
>    changed from 0.49.0 to 0.52.0.
> +
> +* cryptodev: the ``uint8_t *data`` member of ``key`` structure in the
> +xforms
> +  structure (``rte_crypto_cipher_xform``, ``rte_crypto_auth_xform``,
> +and
> +  ``rte_crypto_aead_xform``) will be changed to ``const uint8_t *data``.
> --
> 2.14.5

Acked-by: Anoob Joseph <anoobj@marvell.com>

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 1b4fcb7e6..f35ac5b96 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -75,3 +75,7 @@  Deprecation Notices
 
 * crypto/aesni_mb: the minimum supported intel-ipsec-mb library version will be
   changed from 0.49.0 to 0.52.0.
+
+* cryptodev: the ``uint8_t *data`` member of ``key`` structure in the xforms
+  structure (``rte_crypto_cipher_xform``, ``rte_crypto_auth_xform``, and
+  ``rte_crypto_aead_xform``) will be changed to ``const uint8_t *data``.