Re: [dpdk-dev] [PATCH v2 2/6] lib/cryptodev: add asym op support in cryptodev

["De Lara Guarch, Pablo" <pablo.de.lara.guarch@intel.com>]

Hi Shally,

> -----Original Message-----
> From: Verma, Shally [mailto:Shally.Verma@cavium.com]
> Sent: Tuesday, May 8, 2018 11:58 AM
> To: Trahe, Fiona <fiona.trahe@intel.com>; De Lara Guarch, Pablo
> <pablo.de.lara.guarch@intel.com>
> Cc: Doherty, Declan <declan.doherty@intel.com>; Athreya, Narayana Prasad
> <NarayanaPrasad.Athreya@cavium.com>; Sahu, Sunila
> <Sunila.Sahu@cavium.com>; Gupta, Ashish <Ashish.Gupta@cavium.com>;
> dev@dpdk.org; Sahu, Sunila <Sunila.Sahu@cavium.com>; Gupta, Ashish
> <Ashish.Gupta@cavium.com>; Kotamarthy, Kanaka
> <Kanaka.Kotamarthy@cavium.com>; Marisetti, Balaji
> <Balaji.Marisetti@cavium.com>
> Subject: RE: [PATCH v2 2/6] lib/cryptodev: add asym op support in cryptodev
> 
> Hi Fiona
> 
> >-----Original Message-----
> >From: Trahe, Fiona [mailto:fiona.trahe@intel.com]
> >Sent: 08 May 2018 16:22
> >To: Verma, Shally <Shally.Verma@cavium.com>; De Lara Guarch, Pablo
> ><pablo.de.lara.guarch@intel.com>
> >Cc: Doherty, Declan <declan.doherty@intel.com>; Athreya, Narayana
> >Prasad <NarayanaPrasad.Athreya@cavium.com>; Sahu, Sunila
> ><Sunila.Sahu@cavium.com>; Gupta, Ashish <Ashish.Gupta@cavium.com>;
> >dev@dpdk.org; Sahu, Sunila <Sunila.Sahu@cavium.com>; Gupta, Ashish
> ><Ashish.Gupta@cavium.com>; Trahe, Fiona <fiona.trahe@intel.com>
> >Subject: RE: [PATCH v2 2/6] lib/cryptodev: add asym op support in
> >cryptodev
> >
> >Hi Shally,
> >
> >Reviewing the asymm v2 patch - quick comment:
> >
> >> List of TBDs:
> >> - change PMD ops session_get_size, session_configure, session_clear
> >>   to sym_session_* APIs
> >> - change external get_session_private_size to sym_get_session_*
> >> - per-service stats update
> >[Fiona] You'll need to send a deprecation notice for any changes to
> >existing cryptodev APIs in
> >18.05 if you want the changes applied in 18.08
> 
> Thanks for info. However, assume API name change is not blocker for spec to be
> in 18.08. So, I planned to do it at later stage after spec get stabilize and
> accepted.
> Do you have any other thoughts to it?

Any modifications to the API, including name changes, require a deprecation notice.
Making this change will break the compilation of all the apps using it.
What I would suggest is renaming the function and creating a wrapper with the current name,
calling the new function, and marking it as rte_deprecated.

Something like:

/*
* @deprecated ...
*/

__rte_deprecated
unsigned 
rte_cryptodev_get_session_private_size(...) {

return rte_cryptodev_get_sym_session_private_size(...);
}

This way, we can give users time to change to the new API, without breaking directly the code.

Thanks,
Pablo

> 
> Shally