[dpdk-dev] [PATCH] cryptodev: Remove EXPERIMENTAL label

[dpdk-dev] [PATCH] cryptodev: Remove EXPERIMENTAL label

[Fiona Trahe]

The cryptodev API was introduced in the DPDK 2.2 release.
Since then it has
 - been reviewed and iterated for the DPDK 16.04 release
 - had extensive use by the l2fwd-crypto app,
			the ipsec-secgw example app,
			the test app.
We believe it is now stable and the EXPERIMENTAL label should be removed.

Signed-off-by: Fiona Trahe <fiona.trahe@intel.com>
---
 MAINTAINERS                          | 2 +-
 config/common_base                   | 1 -
 lib/librte_cryptodev/rte_cryptodev.h | 2 --
 3 files changed, 1 insertion(+), 4 deletions(-)

diff --git a/MAINTAINERS b/MAINTAINERS
index 85d72ca..a7570cd 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -231,7 +231,7 @@ M: Thomas Monjalon <thomas.monjalon@6wind.com>
 F: lib/librte_ether/
 F: scripts/test-null.sh
 
-Crypto API - EXPERIMENTAL
+Crypto API
 M: Declan Doherty <declan.doherty@intel.com>
 F: lib/librte_cryptodev/
 F: app/test/test_cryptodev*
diff --git a/config/common_base b/config/common_base
index abd6a64..0124e86 100644
--- a/config/common_base
+++ b/config/common_base
@@ -327,7 +327,6 @@ CONFIG_RTE_PMD_PACKET_PREFETCH=y
 
 #
 # Compile generic crypto device library
-# EXPERIMENTAL: API may change without prior notice
 #
 CONFIG_RTE_LIBRTE_CRYPTODEV=y
 CONFIG_RTE_LIBRTE_CRYPTODEV_DEBUG=n
diff --git a/lib/librte_cryptodev/rte_cryptodev.h b/lib/librte_cryptodev/rte_cryptodev.h
index b599c95..1427dcf 100644
--- a/lib/librte_cryptodev/rte_cryptodev.h
+++ b/lib/librte_cryptodev/rte_cryptodev.h
@@ -40,8 +40,6 @@
  * Defines RTE Crypto Device APIs for the provisioning of cipher and
  * authentication operations.
  *
- * @b EXPERIMENTAL: this API may change without prior notice
- *
  */
 
 #ifdef __cplusplus
-- 
2.1.0

Re: [dpdk-dev] [PATCH] cryptodev: Remove EXPERIMENTAL label

[Thomas Monjalon]

2016-04-05 08:53, Fiona Trahe:
> The cryptodev API was introduced in the DPDK 2.2 release.
> Since then it has
>  - been reviewed and iterated for the DPDK 16.04 release
>  - had extensive use by the l2fwd-crypto app,
> 			the ipsec-secgw example app,
> 			the test app.
> We believe it is now stable and the EXPERIMENTAL label should be removed.

Are you sure sure? :)
It means you will try hard to not change the API anymore
or you'll need a deprecation notice strongly agreed (outside of your team).

>   * Defines RTE Crypto Device APIs for the provisioning of cipher and
>   * authentication operations.
>   *

This empty line can be removed.

> - * @b EXPERIMENTAL: this API may change without prior notice
> - *
>   */

Re: [dpdk-dev] [PATCH] cryptodev: Remove EXPERIMENTAL label

[Trahe, Fiona]

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> Sent: Tuesday, April 05, 2016 9:48 AM
> To: Trahe, Fiona
> Cc: dev@dpdk.org; Doherty, Declan
> Subject: Re: [dpdk-dev] [PATCH] cryptodev: Remove EXPERIMENTAL label
> 
> 2016-04-05 08:53, Fiona Trahe:
> > The cryptodev API was introduced in the DPDK 2.2 release.
> > Since then it has
> >  - been reviewed and iterated for the DPDK 16.04 release
> >  - had extensive use by the l2fwd-crypto app,
> > 			the ipsec-secgw example app,
> > 			the test app.
> > We believe it is now stable and the EXPERIMENTAL label should be removed.
> 
> Are you sure sure? :)
> It means you will try hard to not change the API anymore or you'll need a
> deprecation notice strongly agreed (outside of your team).
We're sure sure :)

> 
> >   * Defines RTE Crypto Device APIs for the provisioning of cipher and
> >   * authentication operations.
> >   *
> 
> This empty line can be removed.
> 
> > - * @b EXPERIMENTAL: this API may change without prior notice
> > - *
> >   */
A v2 without the empty line will follow shortly.

Re: [dpdk-dev] [PATCH] cryptodev: Remove EXPERIMENTAL label

[Thomas Monjalon]

2016-04-05 09:48, Trahe, Fiona:
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> > 2016-04-05 08:53, Fiona Trahe:
> > > The cryptodev API was introduced in the DPDK 2.2 release.
> > > Since then it has
> > >  - been reviewed and iterated for the DPDK 16.04 release
> > >  - had extensive use by the l2fwd-crypto app,
> > > 			the ipsec-secgw example app,
> > > 			the test app.
> > > We believe it is now stable and the EXPERIMENTAL label should be removed.
> > 
> > Are you sure sure? :)
> > It means you will try hard to not change the API anymore or you'll need a
> > deprecation notice strongly agreed (outside of your team).
> 
> We're sure sure :)

I think we could change the namespace before making this API stable.
What about using a dpdk_ prefix instead of rte_ ?
(and some macros have CRYPTODEV or CDEV prefixes)

[dpdk-dev] Change new libraries to have dpdk_ prefix instead of rte_

[Declan Doherty]

I'd like people opinion of Thomas proposal to have all new libraries use 
a dpdk_ prefix instead of rte_*. Although I agree that dpdk_ would 
probably make sense, I don't like the ascetics of inconsistent prefixes 
on dpdk libraries. Any comments?




2016-04-05 09:48, Trahe, Fiona:
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> > 2016-04-05 08:53, Fiona Trahe:
> > > The cryptodev API was introduced in the DPDK 2.2 release.
> > > Since then it has
> > >  - been reviewed and iterated for the DPDK 16.04 release
> > >  - had extensive use by the l2fwd-crypto app,
> > > 			the ipsec-secgw example app,
> > > 			the test app.
> > > We believe it is now stable and the EXPERIMENTAL label should be removed.
> >
> > Are you sure sure? :)
> > It means you will try hard to not change the API anymore or you'll need a
> > deprecation notice strongly agreed (outside of your team).
>
> We're sure sure :)

I think we could change the namespace before making this API stable.
What about using a dpdk_ prefix instead of rte_ ?
(and some macros have CRYPTODEV or CDEV prefixes)

Re: [dpdk-dev] Change new libraries to have dpdk_ prefix instead of rte_

[Ananyev, Konstantin]

> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Declan Doherty
> Sent: Tuesday, April 05, 2016 2:29 PM
> To: dev@dpdk.org
> Subject: [dpdk-dev] Change new libraries to have dpdk_ prefix instead of rte_
> 
> I'd like people opinion of Thomas proposal to have all new libraries use
> a dpdk_ prefix instead of rte_*. Although I agree that dpdk_ would
> probably make sense, I don't like the ascetics of inconsistent prefixes
> on dpdk libraries. Any comments?

I suppose it is a bit strange to have rte_ prefix for one set of libraries,
and dpdk_ prefix for others.
If we'd decide to change the prefix, then my vote would be to do
that for all dpdk libraries at once.       
BTW, why do we need to change it at all?
'rte_' is probably not the best one, but at least it is well known/used.
Konstantin 

> 
> 
> 
> 
> 2016-04-05 09:48, Trahe, Fiona:
> > From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> > > 2016-04-05 08:53, Fiona Trahe:
> > > > The cryptodev API was introduced in the DPDK 2.2 release.
> > > > Since then it has
> > > >  - been reviewed and iterated for the DPDK 16.04 release
> > > >  - had extensive use by the l2fwd-crypto app,
> > > > 			the ipsec-secgw example app,
> > > > 			the test app.
> > > > We believe it is now stable and the EXPERIMENTAL label should be removed.
> > >
> > > Are you sure sure? :)
> > > It means you will try hard to not change the API anymore or you'll need a
> > > deprecation notice strongly agreed (outside of your team).
> >
> > We're sure sure :)
> 
> I think we could change the namespace before making this API stable.
> What about using a dpdk_ prefix instead of rte_ ?
> (and some macros have CRYPTODEV or CDEV prefixes)
> 

Re: [dpdk-dev] Change new libraries to have dpdk_ prefix instead of rte_

[Thomas Monjalon]

Thanks for commenting and making the debate alive :)

2016-04-05 14:03, Ananyev, Konstantin:
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Declan Doherty
> > From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> > > I think we could change the namespace before making this API stable.
> > > What about using a dpdk_ prefix instead of rte_ ?
> > 
> > I'd like people opinion of Thomas proposal to have all new libraries use
> > a dpdk_ prefix instead of rte_*. Although I agree that dpdk_ would
> > probably make sense, I don't like the ascetics of inconsistent prefixes
> > on dpdk libraries. Any comments?
> 
> I suppose it is a bit strange to have rte_ prefix for one set of libraries,
> and dpdk_ prefix for others.

Don't you think it is strange to have a prefix not related with
the public project name?
Is it strange to have some functions without any prefix at all?
(examples in rte_ether.h)

> If we'd decide to change the prefix, then my vote would be to do
> that for all dpdk libraries at once.
> BTW, why do we need to change it at all?
> 'rte_' is probably not the best one, but at least it is well known/used.

Well known, really? The question is how large is the audience we target.
Please see my other email: http://dpdk.org/ml/archives/dev/2016-April/037048.html

Re: [dpdk-dev] Change new libraries to have dpdk_ prefix instead of rte_

[Wiles, Keith]

>
>> -----Original Message-----
>> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Declan Doherty
>> Sent: Tuesday, April 05, 2016 2:29 PM
>> To: dev@dpdk.org
>> Subject: [dpdk-dev] Change new libraries to have dpdk_ prefix instead of rte_
>> 
>> I'd like people opinion of Thomas proposal to have all new libraries use
>> a dpdk_ prefix instead of rte_*. Although I agree that dpdk_ would
>> probably make sense, I don't like the ascetics of inconsistent prefixes
>> on dpdk libraries. Any comments?
>
>I suppose it is a bit strange to have rte_ prefix for one set of libraries,
>and dpdk_ prefix for others.
>If we'd decide to change the prefix, then my vote would be to do
>that for all dpdk libraries at once.       
>BTW, why do we need to change it at all?
>'rte_' is probably not the best one, but at least it is well known/used.
>Konstantin

I agree with Thomas as a Type One like person I would like to change it too, but think Konstantin’s point is very valid and we do not need to change existing APIs. I could live with changing the new libraries only, but then we get into the multiple prefixes problem :-(
> 
>
>> 
>> 
>> 
>> 
>> 2016-04-05 09:48, Trahe, Fiona:
>> > From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
>> > > 2016-04-05 08:53, Fiona Trahe:
>> > > > The cryptodev API was introduced in the DPDK 2.2 release.
>> > > > Since then it has
>> > > >  - been reviewed and iterated for the DPDK 16.04 release
>> > > >  - had extensive use by the l2fwd-crypto app,
>> > > > 			the ipsec-secgw example app,
>> > > > 			the test app.
>> > > > We believe it is now stable and the EXPERIMENTAL label should be removed.
>> > >
>> > > Are you sure sure? :)
>> > > It means you will try hard to not change the API anymore or you'll need a
>> > > deprecation notice strongly agreed (outside of your team).
>> >
>> > We're sure sure :)
>> 
>> I think we could change the namespace before making this API stable.
>> What about using a dpdk_ prefix instead of rte_ ?
>> (and some macros have CRYPTODEV or CDEV prefixes)
>> 
>
>


Regards,
Keith

[dpdk-dev] [PATCH] cryptodev: Remove EXPERIMENTAL label

[Fiona Trahe]

The cryptodev API was introduced in the DPDK 2.2 release.
Since then it has
 - been reviewed and iterated for the DPDK 16.04 release
 - had extensive use by the l2fwd-crypto app,
			the ipsec-secgw example app,
			the test app.
We believe it is now stable and the EXPERIMENTAL label should be removed.

v2:
- remove extra empty line

Signed-off-by: Fiona Trahe <fiona.trahe@intel.com>
---
 MAINTAINERS                          | 2 +-
 config/common_base                   | 1 -
 lib/librte_cryptodev/rte_cryptodev.h | 3 ---
 3 files changed, 1 insertion(+), 5 deletions(-)

diff --git a/MAINTAINERS b/MAINTAINERS
index 85d72ca..a7570cd 100644
--- a/MAINTAINERS
+++ b/MAINTAINERS
@@ -231,7 +231,7 @@ M: Thomas Monjalon <thomas.monjalon@6wind.com>
 F: lib/librte_ether/
 F: scripts/test-null.sh
 
-Crypto API - EXPERIMENTAL
+Crypto API
 M: Declan Doherty <declan.doherty@intel.com>
 F: lib/librte_cryptodev/
 F: app/test/test_cryptodev*
diff --git a/config/common_base b/config/common_base
index abd6a64..0124e86 100644
--- a/config/common_base
+++ b/config/common_base
@@ -327,7 +327,6 @@ CONFIG_RTE_PMD_PACKET_PREFETCH=y
 
 #
 # Compile generic crypto device library
-# EXPERIMENTAL: API may change without prior notice
 #
 CONFIG_RTE_LIBRTE_CRYPTODEV=y
 CONFIG_RTE_LIBRTE_CRYPTODEV_DEBUG=n
diff --git a/lib/librte_cryptodev/rte_cryptodev.h b/lib/librte_cryptodev/rte_cryptodev.h
index 568ffbb..d47f1e8 100644
--- a/lib/librte_cryptodev/rte_cryptodev.h
+++ b/lib/librte_cryptodev/rte_cryptodev.h
@@ -39,9 +39,6 @@
  *
  * Defines RTE Crypto Device APIs for the provisioning of cipher and
  * authentication operations.
- *
- * @b EXPERIMENTAL: this API may change without prior notice
- *
  */
 
 #ifdef __cplusplus
-- 
2.1.0

Re: [dpdk-dev] [PATCH] cryptodev: Remove EXPERIMENTAL label

[Thomas Monjalon]

2016-04-06 12:05, Fiona Trahe:
> The cryptodev API was introduced in the DPDK 2.2 release.
> Since then it has
>  - been reviewed and iterated for the DPDK 16.04 release
>  - had extensive use by the l2fwd-crypto app,
> 			the ipsec-secgw example app,
> 			the test app.
> We believe it is now stable and the EXPERIMENTAL label should be removed.

I thought it was a good idea to use a dpdk_ prefix in this new "stable" lib,
but it appears that almost everybody is against having a mix of prefixes.

Acked-by: Thomas Monjalon <thomas.monjalon@6wind.com>

> v2:

The v2 is missing in the title (option -v2 in git).

Re: [dpdk-dev] [PATCH] cryptodev: Remove EXPERIMENTAL label

[Trahe, Fiona]

> -----Original Message-----
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> Sent: Wednesday, April 06, 2016 5:37 PM
> To: Trahe, Fiona
> Cc: dev@dpdk.org; Doherty, Declan
> Subject: Re: [dpdk-dev] [PATCH] cryptodev: Remove EXPERIMENTAL label
> 
> 2016-04-06 12:05, Fiona Trahe:
> > The cryptodev API was introduced in the DPDK 2.2 release.
> > Since then it has
> >  - been reviewed and iterated for the DPDK 16.04 release
> >  - had extensive use by the l2fwd-crypto app,
> > 			the ipsec-secgw example app,
> > 			the test app.
> > We believe it is now stable and the EXPERIMENTAL label should be removed.
> 
> I thought it was a good idea to use a dpdk_ prefix in this new "stable" lib, but it
> appears that almost everybody is against having a mix of prefixes.
> 
> Acked-by: Thomas Monjalon <thomas.monjalon@6wind.com>
> 
> > v2:
> 
> The v2 is missing in the title (option -v2 in git).
Sorry :(
Do  you want me to resend with updated subject?

Re: [dpdk-dev] [PATCH] cryptodev: Remove EXPERIMENTAL label

[Thomas Monjalon]

2016-04-06 16:46, Trahe, Fiona:
> From: Thomas Monjalon [mailto:thomas.monjalon@6wind.com]
> > > v2:
> > 
> > The v2 is missing in the title (option -v2 in git).
> Sorry :(
> Do  you want me to resend with updated subject?

No, it was just for information for next times.

Re: [dpdk-dev] [PATCH] cryptodev: Remove EXPERIMENTAL label

[Thomas Monjalon]

> > The cryptodev API was introduced in the DPDK 2.2 release.
> > Since then it has
> >  - been reviewed and iterated for the DPDK 16.04 release
> >  - had extensive use by the l2fwd-crypto app,
> > 			the ipsec-secgw example app,
> > 			the test app.
> > We believe it is now stable and the EXPERIMENTAL label should be removed.
> 
> I thought it was a good idea to use a dpdk_ prefix in this new "stable" lib,
> but it appears that almost everybody is against having a mix of prefixes.
> 
> Acked-by: Thomas Monjalon <thomas.monjalon@6wind.com>

Applied, thanks