doc: add deprecation notice for security session create API
diff mbox series

Message ID 20200730171330.16144-1-akhil.goyal@nxp.com
State Accepted
Headers show
Series
  • doc: add deprecation notice for security session create API
Related show

Checks

Context Check Description
ci/travis-robot success Travis build: passed
ci/Intel-compilation success Compilation OK
ci/checkpatch warning coding style issues

Commit Message

Akhil Goyal July 30, 2020, 5:13 p.m. UTC
The API ``rte_security_session_create`` takes only single mempool
for session and session private data. So the application need to create
mempool for twice the number of sessions needed and will also lead to
wastage of memory as session private data need more memory compared to session.
Hence the API will be modified to take two mempool pointers - one for session
and one for private data. This is very similar to crypto based session
create APIs.

Signed-off-by: Akhil Goyal <akhil.goyal@nxp.com>
---
 doc/guides/rel_notes/deprecation.rst | 7 +++++++
 1 file changed, 7 insertions(+)

Comments

Hemant Agrawal July 30, 2020, 5:17 p.m. UTC | #1
Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>
Anoob Joseph July 30, 2020, 5:26 p.m. UTC | #2
> The API ``rte_security_session_create`` takes only single mempool for session
> and session private data. So the application need to create mempool for twice
> the number of sessions needed and will also lead to wastage of memory as
> session private data need more memory compared to session.
> Hence the API will be modified to take two mempool pointers - one for session
> and one for private data. This is very similar to crypto based session create APIs.
> 
> Signed-off-by: Akhil Goyal <akhil.goyal@nxp.com>
> ---
>  doc/guides/rel_notes/deprecation.rst | 7 +++++++
>  1 file changed, 7 insertions(+)

Acked-by: Anoob Joseph <anoobj@marvell.com>
Konstantin Ananyev July 31, 2020, 9:58 a.m. UTC | #3
> -----Original Message-----
> From: Akhil Goyal <akhil.goyal@nxp.com>
> Sent: Thursday, July 30, 2020 8:14 PM
> To: dev@dpdk.org; anoobj@marvell.com; Nicolau, Radu <radu.nicolau@intel.com>; Ananyev, Konstantin
> <konstantin.ananyev@intel.com>; Doherty, Declan <declan.doherty@intel.com>; Zhang, Roy Fan <roy.fan.zhang@intel.com>
> Cc: thomas@monjalon.net; Trahe, Fiona <fiona.trahe@intel.com>; adwivedi@marvell.com; hemant.agrawal@nxp.com; Akhil Goyal
> <akhil.goyal@nxp.com>
> Subject: [PATCH] doc: add deprecation notice for security session create API
> 
> The API ``rte_security_session_create`` takes only single mempool
> for session and session private data. So the application need to create
> mempool for twice the number of sessions needed and will also lead to
> wastage of memory as session private data need more memory compared to session.
> Hence the API will be modified to take two mempool pointers - one for session
> and one for private data. This is very similar to crypto based session
> create APIs.
> 
> Signed-off-by: Akhil Goyal <akhil.goyal@nxp.com>
> ---
>  doc/guides/rel_notes/deprecation.rst | 7 +++++++
>  1 file changed, 7 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index ea4cfa7a4..9ed7b55e6 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -126,6 +126,13 @@ Deprecation Notices
>    to one it means it represents IV, when is set to zero it means J0 is used
>    directly, in this case 16 bytes of J0 need to be passed.
> 
> +* security: The API ``rte_security_session_create`` takes only single mempool
> +  for session and session private data. So the application need to create
> +  mempool for twice the number of sessions needed and will also lead to
> +  wastage of memory as session private data need more memory compared to session.
> +  Hence the API will be modified to take two mempool pointers - one for session
> +  and one for private data.
> +
>  * sched: To allow more traffic classes, flexible mapping of pipe queues to
>    traffic classes, and subport level configuration of pipes and queues
>    changes will be made to macros, data structures and API functions defined
> --

Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>

> 2.17.1
Thomas Monjalon Aug. 6, 2020, 4:19 p.m. UTC | #4
> > The API ``rte_security_session_create`` takes only single mempool
> > for session and session private data. So the application need to create
> > mempool for twice the number of sessions needed and will also lead to
> > wastage of memory as session private data need more memory compared to session.
> > Hence the API will be modified to take two mempool pointers - one for session
> > and one for private data. This is very similar to crypto based session
> > create APIs.
> > 
> > Signed-off-by: Akhil Goyal <akhil.goyal@nxp.com>
> > ---
> > +* security: The API ``rte_security_session_create`` takes only single mempool
> > +  for session and session private data. So the application need to create
> > +  mempool for twice the number of sessions needed and will also lead to
> > +  wastage of memory as session private data need more memory compared to session.
> > +  Hence the API will be modified to take two mempool pointers - one for session
> > +  and one for private data.
> > +
> Acked-by: Hemant Agrawal <hemant.agrawal@nxp.com>
> Acked-by: Anoob Joseph <anoobj@marvell.com>
> Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>

Applied

Patch
diff mbox series

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index ea4cfa7a4..9ed7b55e6 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -126,6 +126,13 @@  Deprecation Notices
   to one it means it represents IV, when is set to zero it means J0 is used
   directly, in this case 16 bytes of J0 need to be passed.
 
+* security: The API ``rte_security_session_create`` takes only single mempool
+  for session and session private data. So the application need to create
+  mempool for twice the number of sessions needed and will also lead to
+  wastage of memory as session private data need more memory compared to session.
+  Hence the API will be modified to take two mempool pointers - one for session
+  and one for private data.
+
 * sched: To allow more traffic classes, flexible mapping of pipe queues to
   traffic classes, and subport level configuration of pipes and queues
   changes will be made to macros, data structures and API functions defined