Skip to contentSkip to conversation

doc: add cryptodev xform deprecation notice

PATCH Superseded Fan Zhang 5 participants 12 messages Feb 8, 2019 – Apr 3, 2019

lore
Share & tools
lore

Fan Zhang

author
#0 lore raw

PATCH 1/1 doc: add cryptodev xform deprecation notice

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

---
 doc/guides/rel_notes/deprecation.rst | 6 ++++++
 1 file changed, 6 insertions(+)
doc/guides/rel_notes/deprecation.rst +6 -0
index 1b4fcb7e6..5166d6eb5 100644
@@ -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.
Signature · 1 line
2.14.5
#1 lore raw

Hi Fan,

Quoted 2 lines · Fan Zhang

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.

Quoted 20 lines
---
  doc/guides/rel_notes/deprecation.rst | 6 ++++++
  1 file changed, 6 insertions(+)
doc/guides/rel_notes/deprecation.rst +6 -0
index 1b4fcb7e6..5166d6eb5 100644
@@ -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 lore raw

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

Quoted 41 lines

-----Original Message-----
From: Akhil Goyal [mailto:[email protected]]
Sent: Thursday, February 28, 2019 10:08 AM
To: Zhang, Roy Fan <[email protected]>; [email protected]
Subject: Re: [dpdk-dev] [PATCH] doc: add cryptodev xform deprecation notice

Hi Fan,

Quoted 2 lines · Fan Zhang

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.

Quoted 12 lines
---
  doc/guides/rel_notes/deprecation.rst | 6 ++++++
  1 file changed, 6 insertions(+)
doc/guides/rel_notes/deprecation.rst +0 -0
index 1b4fcb7e6..5166d6eb5 100644

doc/guides/rel_notes/deprecation.rst Deprecation Notices · line 76

Quoted 2 lines
doc/guides/rel_notes/deprecation.rst +0 -0
@@ -75,3 +75,9 @@ Deprecation Notices
 
  * crypto/aesni_mb: the minimum supported intel-ipsec-mb library version

will be

Quoted 11 lines
doc/guides/rel_notes/deprecation.rst +10 -0
    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.
author
#3 lore raw

PATCH v2 1/1 doc: add cryptodev xform deprecation notice

In reply to 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.

---
v2:
- updated description to the patch.

 doc/guides/rel_notes/deprecation.rst | 6 ++++++
 1 file changed, 6 insertions(+)
doc/guides/rel_notes/deprecation.rst +6 -0
index 1b4fcb7e6..5166d6eb5 100644
@@ -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.
Signature · 1 line
2.14.5
author
#4 lore raw

PATCH v3 1/1 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.

---
v3:
- Removed target release.

v2:
- Added description.

 doc/guides/rel_notes/deprecation.rst | 4 ++++
 1 file changed, 4 insertions(+)
doc/guides/rel_notes/deprecation.rst +4 -0
index 1b4fcb7e6..f35ac5b96 100644
@@ -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``.
Signature · 1 line
2.14.5
Acked-by on v3 1/1
#5 lore raw
Quoted 22 lines · 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.

---
v3:
- Removed target release.

v2:
- Added description.

  doc/guides/rel_notes/deprecation.rst | 4 ++++
  1 file changed, 4 insertions(+)
doc/guides/rel_notes/deprecation.rst +0 -0
index 1b4fcb7e6..f35ac5b96 100644

doc/guides/rel_notes/deprecation.rst Deprecation Notices · line 81

Quoted 7 lines
doc/guides/rel_notes/deprecation.rst +4 -0
@@ -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``.
#6 lore raw
Quoted 25 lines · Akhil Goyal
Quoted 23 lines · 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.

---
v3:
- Removed target release.

v2:
- Added description.

   doc/guides/rel_notes/deprecation.rst | 4 ++++
   1 file changed, 4 insertions(+)
doc/guides/rel_notes/deprecation.rst +0 -0
index 1b4fcb7e6..f35ac5b96 100644
@@ -75,3 +75,7 @@ Deprecation Notices
 
Quoted 7 lines

doc/guides/rel_notes/deprecation.rst Deprecation Notices · line 81

Quoted 6 lines
doc/guides/rel_notes/deprecation.rst +4 -0
   * 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``.

delegated to master.
should be applied along with
http://patches.dpdk.org/patch/51395/

Applied
#7 lore raw
Quoted 33 lines · Akhil Goyal
Quoted 24 lines · Akhil Goyal
Quoted 23 lines · 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.

---
v3:
- Removed target release.

v2:
- Added description.

    doc/guides/rel_notes/deprecation.rst | 4 ++++
    1 file changed, 4 insertions(+)
doc/guides/rel_notes/deprecation.rst +0 -0
index 1b4fcb7e6..f35ac5b96 100644
@@ -75,3 +75,7 @@ Deprecation Notices
 
Quoted 7 lines

doc/guides/rel_notes/deprecation.rst Deprecation Notices · line 81

Quoted 6 lines
doc/guides/rel_notes/deprecation.rst +4 -0
    * 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``.
Quoted 4 lines

delegated to master.
should be applied along with
http://patches.dpdk.org/patch/51395/

Applied to dpdk-next-crypto
Thanks.

#8 lore raw
Quoted 34 lines · Akhil Goyal
Quoted 32 lines · Akhil Goyal
Quoted 31 lines · Akhil Goyal
Quoted 22 lines · 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.

---
v3:
- Removed target release.

v2:
- Added description.

     doc/guides/rel_notes/deprecation.rst | 4 ++++
     1 file changed, 4 insertions(+)
doc/guides/rel_notes/deprecation.rst +0 -0
index 1b4fcb7e6..f35ac5b96 100644

doc/guides/rel_notes/deprecation.rst Deprecation Notices · line 81

Quoted 7 lines
doc/guides/rel_notes/deprecation.rst +4 -0
@@ -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``.
Quoted 7 lines
Quoted 4 lines

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

#9 lore raw

29/03/2019 16:59, Akhil Goyal:

Quoted 43 lines · Akhil Goyal
Quoted 34 lines · Akhil Goyal
Quoted 32 lines · Akhil Goyal
Quoted 31 lines · Fan Zhang
Quoted 22 lines

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.

---
v3:
- Removed target release.

v2:
- Added description.

     doc/guides/rel_notes/deprecation.rst | 4 ++++
     1 file changed, 4 insertions(+)
doc/guides/rel_notes/deprecation.rst +0 -0
index 1b4fcb7e6..f35ac5b96 100644

doc/guides/rel_notes/deprecation.rst Deprecation Notices · line 81

Quoted 7 lines
doc/guides/rel_notes/deprecation.rst +4 -0
@@ -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``.
Quoted 7 lines
Quoted 4 lines

delegated to master.
should be applied along with
http://patches.dpdk.org/patch/51395/

Applied to dpdk-next-crypto
Thanks.

Quoted 6 lines

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.

Acked-by on v3 1/1
#10 lore raw
In reply to Fan Zhang
Quoted 11 lines

-----Original Message-----
From: Zhang, Roy Fan
Sent: Friday, March 22, 2019 4:35 PM
To: [email protected]
Cc: [email protected]; Zhang, Roy Fan <[email protected]>; Kusztal, ArkadiuszX <[email protected]>; De Lara Guarch, Pablo <[email protected]>; Doherty, Declan <[email protected]>; Trahe, Fiona <[email protected]>
Subject: [PATCH v3] doc: add cryptodev xform deprecation notice

Quoted 7 lines

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.

Acked-by on v3 1/1
#11 lore raw
In reply to Fan Zhang
Quoted 43 lines

-----Original Message-----
From: dev <[email protected]> On Behalf Of Fan Zhang
Sent: Friday, March 22, 2019 10:05 PM
To: [email protected]
Cc: [email protected]; [email protected]; [email protected]; [email protected]; [email protected]; [email protected]
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.

---
v3:
- Removed target release.

v2:
- Added description.

 doc/guides/rel_notes/deprecation.rst | 4 ++++
 1 file changed, 4 insertions(+)
doc/guides/rel_notes/deprecation.rst +0 -0
index 1b4fcb7e6..f35ac5b96 100644
@@ -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.

doc/guides/rel_notes/deprecation.rst +6 -1
+
+* 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``.
--
Quoted 1 line

2.14.5