[dpdk-dev] [PATCH] doc: add cryptodev xform deprecation notice

[dpdk-dev] [PATCH] doc: add cryptodev xform deprecation notice

[Fan Zhang]

This patch adds the deprecation notice of changing Cryptodev
symmetric xform structure for DPDK 19.05.

Signed-off-by: Fan Zhang <roy.fan.zhang@intel.com>
---
 doc/guides/rel_notes/deprecation.rst | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 1b4fcb7e6..5166d6eb5 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -75,3 +75,9 @@ 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`` in
+  19.05. The structure ``rte_table_action_sym_crypto_params`` in pipeline
+  library will be updated accordingly.
-- 
2.14.5

Re: [dpdk-dev] [PATCH] doc: add cryptodev xform deprecation notice

[Akhil Goyal]

Hi Fan,

On 2/8/2019 4:47 PM, Fan Zhang wrote:
> This patch adds the deprecation notice of changing Cryptodev
> symmetric xform structure for DPDK 19.05.
It would be better if a need of this change is explained in the 
description of the patch and I believe the change will be accepted for 
19.08 release and not 19.05.
>
> Signed-off-by: Fan Zhang <roy.fan.zhang@intel.com>
> ---
>   doc/guides/rel_notes/deprecation.rst | 6 ++++++
>   1 file changed, 6 insertions(+)
>
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 1b4fcb7e6..5166d6eb5 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -75,3 +75,9 @@ 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`` in
> +  19.05. The structure ``rte_table_action_sym_crypto_params`` in pipeline
> +  library will be updated accordingly.

Re: [dpdk-dev] [PATCH] doc: add cryptodev xform deprecation notice

[Zhang, Roy Fan]

Hi,

The reason of this change is for a more formal API for cryptodev. Since the
key is for creating session and not meant to be modified by the driver.

The patch is finished I am doing some last checks. Is there any reason to
delay the patch for 19.08?

Regards,
Fan

> -----Original Message-----
> From: Akhil Goyal [mailto:akhil.goyal@nxp.com]
> Sent: Thursday, February 28, 2019 10:08 AM
> To: Zhang, Roy Fan <roy.fan.zhang@intel.com>; dev@dpdk.org
> Subject: Re: [dpdk-dev] [PATCH] doc: add cryptodev xform deprecation
> notice
> 
> Hi Fan,
> 
> On 2/8/2019 4:47 PM, Fan Zhang wrote:
> > This patch adds the deprecation notice of changing Cryptodev symmetric
> > xform structure for DPDK 19.05.
> It would be better if a need of this change is explained in the description of
> the patch and I believe the change will be accepted for
> 19.08 release and not 19.05.
> >
> > Signed-off-by: Fan Zhang <roy.fan.zhang@intel.com>
> > ---
> >   doc/guides/rel_notes/deprecation.rst | 6 ++++++
> >   1 file changed, 6 insertions(+)
> >
> > diff --git a/doc/guides/rel_notes/deprecation.rst
> > b/doc/guides/rel_notes/deprecation.rst
> > index 1b4fcb7e6..5166d6eb5 100644
> > --- a/doc/guides/rel_notes/deprecation.rst
> > +++ b/doc/guides/rel_notes/deprecation.rst
> > @@ -75,3 +75,9 @@ 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`` in
> > +  19.05. The structure ``rte_table_action_sym_crypto_params`` in
> > +pipeline
> > +  library will be updated accordingly.

[dpdk-dev] [PATCH v2] doc: add cryptodev xform deprecation notice

[Fan Zhang]

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>
---
v2:
- updated description to the patch.

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

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 1b4fcb7e6..5166d6eb5 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -75,3 +75,9 @@ 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`` in
+  19.05. The structure ``rte_table_action_sym_crypto_params`` in pipeline
+  library will be updated accordingly.
-- 
2.14.5

[dpdk-dev] [PATCH v3] doc: add cryptodev xform deprecation notice

[Fan Zhang]

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

[dpdk-dev] [PATCH v3] doc: add cryptodev xform deprecation notice

[Fan Zhang]

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

Re: [dpdk-dev] [PATCH v3] doc: add cryptodev xform deprecation notice

[Akhil Goyal]

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>

Re: [dpdk-dev] [PATCH v3] doc: add cryptodev xform deprecation notice

[Akhil Goyal]

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>

Re: [dpdk-dev] [PATCH v3] doc: add cryptodev xform deprecation notice

[Akhil Goyal]

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/

Re: [dpdk-dev] [PATCH v3] doc: add cryptodev xform deprecation notice

[Akhil Goyal]

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/

Re: [dpdk-dev] [PATCH v3] doc: add cryptodev xform deprecation notice

[Akhil Goyal]

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.

Re: [dpdk-dev] [PATCH v3] doc: add cryptodev xform deprecation notice

[Akhil Goyal]

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.

Re: [dpdk-dev] [PATCH v3] doc: add cryptodev xform deprecation notice

[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?

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

-Akhil

Re: [dpdk-dev] [PATCH v3] doc: add cryptodev xform deprecation notice

[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?

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

-Akhil

Re: [dpdk-dev] [PATCH v3] doc: add cryptodev xform deprecation notice

[Thomas Monjalon]

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.

Re: [dpdk-dev] [PATCH v3] doc: add cryptodev xform deprecation notice

[Thomas Monjalon]

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.

Re: [dpdk-dev] [PATCH v3] doc: add cryptodev xform deprecation notice

[Trahe, Fiona]

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

Re: [dpdk-dev] [PATCH v3] doc: add cryptodev xform deprecation notice

[Trahe, Fiona]

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

Re: [dpdk-dev] [PATCH v3] doc: add cryptodev xform deprecation notice

[Anoob Joseph]

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

Re: [dpdk-dev] [PATCH v3] doc: add cryptodev xform deprecation notice

[Anoob Joseph]

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