diff mbox series

[RFC] doc: announce removal of crypto list end enumerators

Message ID 20200729144651.17524-1-arkadiuszx.kusztal@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series [RFC] doc: announce removal of crypto list end enumerators |

Checks

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

Commit Message

Arkadiusz Kusztal July 29, 2020, 2:46 p.m. UTC 
  Enumerators RTE_CRYPTO_CIPHER_LIST_END, RTE_CRYPTO_AUTH_LIST_END,
RTE_CRYPTO_AEAD_LIST_END will be removed to prevent some problems
that may arise when adding new algorithms.

Signed-off-by: Arek Kusztal <arkadiuszx.kusztal@intel.com>
---
 doc/guides/rel_notes/deprecation.rst | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

Arkadiusz Kusztal July 29, 2020, 2:54 p.m. UTC | #1 
Hi All,

This is proposal to remove list_end enumerators from algorithms enums.
I do not expect many changes in current list of algorithms but it may happen (ChachaPoly in 20.02, GMAC move to AEAD proposal) so relying on list_end enumerator may be incorrect approach as this value may change across versions. It is used in some parts of DPDK code to specify array size so this would have to be changed with this approach.

Sorry if I not included someone in cc list.

> -----Original Message-----
> From: Kusztal, ArkadiuszX <arkadiuszx.kusztal@intel.com>
> Sent: Wednesday, July 29, 2020 4:47 PM
> To: dev@dpdk.org
> Cc: akhil.goyal@nxp.com; Trahe, Fiona <fiona.trahe@intel.com>;
> anoobj@marvell.com; shallyv@marvell.com; Doherty, Declan
> <declan.doherty@intel.com>; Zhang, Roy Fan <roy.fan.zhang@intel.com>;
> Ananyev, Konstantin <konstantin.ananyev@intel.com>; Kusztal, ArkadiuszX
> <arkadiuszx.kusztal@intel.com>
> Subject: [PATCH] [RFC] doc: announce removal of crypto list end
> enumerators
> 
> Enumerators RTE_CRYPTO_CIPHER_LIST_END,
> RTE_CRYPTO_AUTH_LIST_END, RTE_CRYPTO_AEAD_LIST_END will be
> removed to prevent some problems that may arise when adding new
> algorithms.
> 
> Signed-off-by: Arek Kusztal <arkadiuszx.kusztal@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 a58a179..34b0e3c 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -142,3 +142,9 @@ Deprecation Notices
>    Python 2 support will be completely removed in 20.11.
>    In 20.08, explicit deprecation warnings will be displayed when running
>    scripts with Python 2.
> +
> +* cryptodev: ``RTE_CRYPTO_AEAD_LIST_END`` from ``enum
> +rte_crypto_aead_algorithm``,
> +  ``RTE_CRYPTO_CIPHER_LIST_END`` from ``enum
> +rte_crypto_cipher_algorithm`` and
> +  ``RTE_CRYPTO_AUTH_LIST_END`` from ``enum
> rte_crypto_auth_algorithm``
> +will be
> +  removed.
> +
> \ No newline at end of file
> --
> 2.1.0
Bruce Richardson July 29, 2020, 3:18 p.m. UTC | #2 
On Wed, Jul 29, 2020 at 04:46:51PM +0200, Arek Kusztal wrote:
> Enumerators RTE_CRYPTO_CIPHER_LIST_END, RTE_CRYPTO_AUTH_LIST_END,
> RTE_CRYPTO_AEAD_LIST_END will be removed to prevent some problems
> that may arise when adding new algorithms.
> 
> Signed-off-by: Arek Kusztal <arkadiuszx.kusztal@intel.com>

Since these seem to cause us ABI problems:

Acked-by: Bruce Richardson <bruce.richardson@intel.com>
Fiona Trahe July 29, 2020, 3:22 p.m. UTC | #3 
> -----Original Message-----
> From: Kusztal, ArkadiuszX <arkadiuszx.kusztal@intel.com>
> Sent: Wednesday, July 29, 2020 3:47 PM
> To: dev@dpdk.org
> Cc: akhil.goyal@nxp.com; Trahe, Fiona <fiona.trahe@intel.com>; anoobj@marvell.com;
> shallyv@marvell.com; Doherty, Declan <declan.doherty@intel.com>; Zhang, Roy Fan
> <roy.fan.zhang@intel.com>; Ananyev, Konstantin <konstantin.ananyev@intel.com>; Kusztal, ArkadiuszX
> <arkadiuszx.kusztal@intel.com>
> Subject: [PATCH] [RFC] doc: announce removal of crypto list end enumerators
> 
> Enumerators RTE_CRYPTO_CIPHER_LIST_END, RTE_CRYPTO_AUTH_LIST_END,
> RTE_CRYPTO_AEAD_LIST_END will be removed to prevent some problems
> that may arise when adding new algorithms.
> 
> Signed-off-by: Arek Kusztal <arkadiuszx.kusztal@intel.com>
Acked-by: Fiona Trahe <fiona.trahe@intel.com>
David Marchand July 29, 2020, 3:24 p.m. UTC | #4 
On Wed, Jul 29, 2020 at 4:47 PM Arek Kusztal
<arkadiuszx.kusztal@intel.com> wrote:
>
> Enumerators RTE_CRYPTO_CIPHER_LIST_END, RTE_CRYPTO_AUTH_LIST_END,
> RTE_CRYPTO_AEAD_LIST_END will be removed to prevent some problems
> that may arise when adding new algorithms.

How does it cohabitate with Ferruh notice?
Is it a complement? or redundant?

https://git.dpdk.org/dpdk/commit/doc/guides/rel_notes/deprecation.rst?id=58245da070289f4b248f15970c3f8af73ea601ed


>
> Signed-off-by: Arek Kusztal <arkadiuszx.kusztal@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 a58a179..34b0e3c 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -142,3 +142,9 @@ Deprecation Notices
>    Python 2 support will be completely removed in 20.11.
>    In 20.08, explicit deprecation warnings will be displayed when running
>    scripts with Python 2.
> +
> +* cryptodev: ``RTE_CRYPTO_AEAD_LIST_END`` from ``enum rte_crypto_aead_algorithm``,
> +  ``RTE_CRYPTO_CIPHER_LIST_END`` from ``enum rte_crypto_cipher_algorithm`` and
> +  ``RTE_CRYPTO_AUTH_LIST_END`` from ``enum rte_crypto_auth_algorithm`` will be
> +  removed.
> +
Fiona Trahe July 29, 2020, 3:32 p.m. UTC | #5 
Hi David,

> -----Original Message-----
> From: David Marchand <david.marchand@redhat.com>
> Sent: Wednesday, July 29, 2020 4:24 PM
> To: Kusztal, ArkadiuszX <arkadiuszx.kusztal@intel.com>
> Cc: dev <dev@dpdk.org>; Akhil Goyal <akhil.goyal@nxp.com>; Trahe, Fiona <fiona.trahe@intel.com>;
> Anoob Joseph <anoobj@marvell.com>; shallyv@marvell.com; Doherty, Declan
> <declan.doherty@intel.com>; Zhang, Roy Fan <roy.fan.zhang@intel.com>; Ananyev, Konstantin
> <konstantin.ananyev@intel.com>
> Subject: Re: [dpdk-dev] [PATCH] [RFC] doc: announce removal of crypto list end enumerators
> 
> On Wed, Jul 29, 2020 at 4:47 PM Arek Kusztal
> <arkadiuszx.kusztal@intel.com> wrote:
> >
> > Enumerators RTE_CRYPTO_CIPHER_LIST_END, RTE_CRYPTO_AUTH_LIST_END,
> > RTE_CRYPTO_AEAD_LIST_END will be removed to prevent some problems
> > that may arise when adding new algorithms.
> 
> How does it cohabitate with Ferruh notice?
> Is it a complement? or redundant?
> 
> https://git.dpdk.org/dpdk/commit/doc/guides/rel_notes/deprecation.rst?id=58245da070289f4b248f15
> 970c3f8af73ea601ed
> 
Thanks for drawing attention to this.
It's complementary as far as I can see.
Ferruh's doesn't list all enums - but doesn’t appear to cover these crypto ones.
Akhil Goyal July 31, 2020, 9:38 a.m. UTC | #6 
Hi David,

> Hi David,
> 
> >
> > On Wed, Jul 29, 2020 at 4:47 PM Arek Kusztal
> > <arkadiuszx.kusztal@intel.com> wrote:
> > >
> > > Enumerators RTE_CRYPTO_CIPHER_LIST_END,
> RTE_CRYPTO_AUTH_LIST_END,
> > > RTE_CRYPTO_AEAD_LIST_END will be removed to prevent some problems
> > > that may arise when adding new algorithms.
> >
> > How does it cohabitate with Ferruh notice?
> > Is it a complement? or redundant?
> >
> >
> https://git.dpdk.org/dpdk/commit/doc/guides/rel_notes/deprecation.rst?id=58245da070289f4b248f15
> >
> Thanks for drawing attention to this.
> It's complementary as far as I can see.
> Ferruh's doesn't list all enums - but doesn’t appear to cover these crypto ones.

I feel we can have this deprecation notice as well for crypto specific enums.
Though I don’t want to push it if somebody has objections on this.
I am OK if Ferruh's notice looks enough to cover crypto enums as well.

Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
If no objections, Thomas or you can pick this directly on master.

Regards,
Akhil
Thomas Monjalon Aug. 6, 2020, 4:09 p.m. UTC | #7 
31/07/2020 11:38, Akhil Goyal:
> Hi David,
> 
> > Hi David,
> > 
> > >
> > > On Wed, Jul 29, 2020 at 4:47 PM Arek Kusztal
> > > <arkadiuszx.kusztal@intel.com> wrote:
> > > >
> > > > Enumerators RTE_CRYPTO_CIPHER_LIST_END,
> > RTE_CRYPTO_AUTH_LIST_END,
> > > > RTE_CRYPTO_AEAD_LIST_END will be removed to prevent some problems
> > > > that may arise when adding new algorithms.
> > >
> > > How does it cohabitate with Ferruh notice?
> > > Is it a complement? or redundant?
> > >
> > >
> > https://git.dpdk.org/dpdk/commit/doc/guides/rel_notes/deprecation.rst?id=58245da070289f4b248f15
> > >
> > Thanks for drawing attention to this.
> > It's complementary as far as I can see.
> > Ferruh's doesn't list all enums - but doesn’t appear to cover these crypto ones.
> 
> I feel we can have this deprecation notice as well for crypto specific enums.
> Though I don’t want to push it if somebody has objections on this.
> I am OK if Ferruh's notice looks enough to cover crypto enums as well.
> 
> Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
> If no objections, Thomas or you can pick this directly on master.

I think Ferruh notice would be enough, except it focus on "MAX" values,
not including the similar ones with "END" in their names.

Anyway, too much notices don't hurt.

Applied
diff mbox series

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index a58a179..34b0e3c 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -142,3 +142,9 @@  Deprecation Notices
   Python 2 support will be completely removed in 20.11.
   In 20.08, explicit deprecation warnings will be displayed when running
   scripts with Python 2.
+
+* cryptodev: ``RTE_CRYPTO_AEAD_LIST_END`` from ``enum rte_crypto_aead_algorithm``,
+  ``RTE_CRYPTO_CIPHER_LIST_END`` from ``enum rte_crypto_cipher_algorithm`` and
+  ``RTE_CRYPTO_AUTH_LIST_END`` from ``enum rte_crypto_auth_algorithm`` will be
+  removed.
+  
\ No newline at end of file