doc: announce changes in security session struct

Message ID 20210803122335.694818-1-gakhil@marvell.com (mailing list archive)
State Accepted, archived
Headers
Series doc: announce changes in security session struct |

Checks

Context Check Description
ci/checkpatch warning coding style issues
ci/github-robot success github build: passed
ci/iol-spell-check-testing warning Testing issues
ci/iol-intel-Functional success Functional Testing PASS
ci/Intel-compilation success Compilation OK
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-aarch64-unit-testing success Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-aarch64-compile-testing success Testing PASS
ci/intel-Testing success Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-abi-testing success Testing PASS
ci/iol-x86_64-unit-testing success Testing PASS
ci/iol-x86_64-compile-testing success Testing PASS

Commit Message

Akhil Goyal Aug. 3, 2021, 12:23 p.m. UTC
  The structure rte_security_session is not directly used
by the application. The application just need an opaque
pointer to attached to the mbuf or rte_crypto_op while
enqueue. Hence, it can be hidden inside the library
and would prevent unnecessary indirection to the priv
session data in fastpath.

Signed-off-by: Akhil Goyal <gakhil@marvell.com>
---
 doc/guides/rel_notes/deprecation.rst | 4 ++++
 1 file changed, 4 insertions(+)
  

Comments

Ananyev, Konstantin Aug. 3, 2021, 12:36 p.m. UTC | #1
> The structure rte_security_session is not directly used
> by the application. The application just need an opaque
> pointer to attached to the mbuf or rte_crypto_op while
> enqueue. Hence, it can be hidden inside the library
> and would prevent unnecessary indirection to the priv
> session data in fastpath.
> 
> Signed-off-by: Akhil Goyal <gakhil@marvell.com>
> ---
>  doc/guides/rel_notes/deprecation.rst | 4 ++++
>  1 file changed, 4 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index c540c90f8e..8da1c2648c 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -159,3 +159,7 @@ Deprecation Notices
>  * security: The functions ``rte_security_set_pkt_metadata`` and
>    ``rte_security_get_userdata`` will be made inline functions and additional
>    flags will be added in structure ``rte_security_ctx`` in DPDK 21.11.
> +
> +* security: Hide stucture ``rte_security_session`` and expose an opaque
> +  pointer for the private data to the application which can be attached
> +  to the packet while enqueuing.
> --

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

> 2.25.1
  
Ajit Khaparde Aug. 3, 2021, 6:01 p.m. UTC | #2
On Tue, Aug 3, 2021 at 5:36 AM Ananyev, Konstantin
<konstantin.ananyev@intel.com> wrote:
>
>
> > The structure rte_security_session is not directly used
> > by the application. The application just need an opaque
> > pointer to attached to the mbuf or rte_crypto_op while
> > enqueue. Hence, it can be hidden inside the library
> > and would prevent unnecessary indirection to the priv
> > session data in fastpath.
> >
> > Signed-off-by: Akhil Goyal <gakhil@marvell.com>
> > ---
> >  doc/guides/rel_notes/deprecation.rst | 4 ++++
> >  1 file changed, 4 insertions(+)
> >
> > diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> > index c540c90f8e..8da1c2648c 100644
> > --- a/doc/guides/rel_notes/deprecation.rst
> > +++ b/doc/guides/rel_notes/deprecation.rst
> > @@ -159,3 +159,7 @@ Deprecation Notices
> >  * security: The functions ``rte_security_set_pkt_metadata`` and
> >    ``rte_security_get_userdata`` will be made inline functions and additional
> >    flags will be added in structure ``rte_security_ctx`` in DPDK 21.11.
> > +
> > +* security: Hide stucture ``rte_security_session`` and expose an opaque
> > +  pointer for the private data to the application which can be attached
> > +  to the packet while enqueuing.
> > --
>
> Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
Acked-by: Ajit Khaparde <ajit.khaparde@broadcom.com>

>
> > 2.25.1
>
  
Anoob Joseph Aug. 5, 2021, 4:15 a.m. UTC | #3
> Subject: [EXT] Re: [PATCH] doc: announce changes in security session struct
> 
> 
> On Tue, Aug 3, 2021 at 5:36 AM Ananyev, Konstantin
> <konstantin.ananyev@intel.com> wrote:
> >
> >
> > > The structure rte_security_session is not directly used
> > > by the application. The application just need an opaque
> > > pointer to attached to the mbuf or rte_crypto_op while
> > > enqueue. Hence, it can be hidden inside the library
> > > and would prevent unnecessary indirection to the priv
> > > session data in fastpath.
> > >
> > > Signed-off-by: Akhil Goyal <gakhil@marvell.com>
> > > ---
> > >  doc/guides/rel_notes/deprecation.rst | 4 ++++
> > >  1 file changed, 4 insertions(+)
> > >
> > > diff --git a/doc/guides/rel_notes/deprecation.rst
> b/doc/guides/rel_notes/deprecation.rst
> > > index c540c90f8e..8da1c2648c 100644
> > > --- a/doc/guides/rel_notes/deprecation.rst
> > > +++ b/doc/guides/rel_notes/deprecation.rst
> > > @@ -159,3 +159,7 @@ Deprecation Notices
> > >  * security: The functions ``rte_security_set_pkt_metadata`` and
> > >    ``rte_security_get_userdata`` will be made inline functions and additional
> > >    flags will be added in structure ``rte_security_ctx`` in DPDK 21.11.
> > > +
> > > +* security: Hide stucture ``rte_security_session`` and expose an opaque
> > > +  pointer for the private data to the application which can be attached
> > > +  to the packet while enqueuing.
> > > --
> >
> > Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
> Acked-by: Ajit Khaparde <ajit.khaparde@broadcom.com>

Acked-by: Anoob Joseph <anoobj@marvell.com>
  
Jerin Jacob Aug. 7, 2021, 1:34 p.m. UTC | #4
On Thu, Aug 5, 2021 at 9:45 AM Anoob Joseph <anoobj@marvell.com> wrote:
>
> > Subject: [EXT] Re: [PATCH] doc: announce changes in security session struct
> >
> >
> > On Tue, Aug 3, 2021 at 5:36 AM Ananyev, Konstantin
> > <konstantin.ananyev@intel.com> wrote:
> > >
> > >
> > > > The structure rte_security_session is not directly used
> > > > by the application. The application just need an opaque
> > > > pointer to attached to the mbuf or rte_crypto_op while
> > > > enqueue. Hence, it can be hidden inside the library
> > > > and would prevent unnecessary indirection to the priv
> > > > session data in fastpath.
> > > >
> > > > Signed-off-by: Akhil Goyal <gakhil@marvell.com>
> > > > ---
> > > >  doc/guides/rel_notes/deprecation.rst | 4 ++++
> > > >  1 file changed, 4 insertions(+)
> > > >
> > > > diff --git a/doc/guides/rel_notes/deprecation.rst
> > b/doc/guides/rel_notes/deprecation.rst
> > > > index c540c90f8e..8da1c2648c 100644
> > > > --- a/doc/guides/rel_notes/deprecation.rst
> > > > +++ b/doc/guides/rel_notes/deprecation.rst
> > > > @@ -159,3 +159,7 @@ Deprecation Notices
> > > >  * security: The functions ``rte_security_set_pkt_metadata`` and
> > > >    ``rte_security_get_userdata`` will be made inline functions and additional
> > > >    flags will be added in structure ``rte_security_ctx`` in DPDK 21.11.
> > > > +
> > > > +* security: Hide stucture ``rte_security_session`` and expose an opaque
> > > > +  pointer for the private data to the application which can be attached
> > > > +  to the packet while enqueuing.
> > > > --
> > >
> > > Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
> > Acked-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
>
> Acked-by: Anoob Joseph <anoobj@marvell.com>

Acked-by: Jerin Jacob <jerinj@marvell.com>
  
Thomas Monjalon Aug. 7, 2021, 5:08 p.m. UTC | #5
> > > > > The structure rte_security_session is not directly used
> > > > > by the application. The application just need an opaque
> > > > > pointer to attached to the mbuf or rte_crypto_op while
> > > > > enqueue. Hence, it can be hidden inside the library
> > > > > and would prevent unnecessary indirection to the priv
> > > > > session data in fastpath.
> > > > >
> > > > > Signed-off-by: Akhil Goyal <gakhil@marvell.com>
> > > > > ---
> > > > > +* security: Hide stucture ``rte_security_session`` and expose an opaque
> > > > > +  pointer for the private data to the application which can be attached
> > > > > +  to the packet while enqueuing.
> > > >
> > > > Acked-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
> > > Acked-by: Ajit Khaparde <ajit.khaparde@broadcom.com>
> > Acked-by: Anoob Joseph <anoobj@marvell.com>
> Acked-by: Jerin Jacob <jerinj@marvell.com>

Applied, thanks.
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index c540c90f8e..8da1c2648c 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -159,3 +159,7 @@  Deprecation Notices
 * security: The functions ``rte_security_set_pkt_metadata`` and
   ``rte_security_get_userdata`` will be made inline functions and additional
   flags will be added in structure ``rte_security_ctx`` in DPDK 21.11.
+
+* security: Hide stucture ``rte_security_session`` and expose an opaque
+  pointer for the private data to the application which can be attached
+  to the packet while enqueuing.