diff mbox series

doc: announce restructuring of crypto session structs

Message ID 20210803115512.694546-1-gakhil@marvell.com (mailing list archive)
State Superseded, archived
Headers
Series doc: announce restructuring of crypto session structs |

Checks

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

Commit Message

Akhil Goyal Aug. 3, 2021, 11:55 a.m. UTC 
  The structures rte_cryptodev_sym_session and
rte_cryptodev_asym_session are not used by the
application directly. The application just need
an opaque pointer which it can attach to rte_crypto_op
while enqueue.
Hence, these structures can be internal to library
hidden from the user.

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

Comments

Anoob Joseph Aug. 5, 2021, 4:21 a.m. UTC | #1 
> Subject: [PATCH] doc: announce restructuring of crypto session structs
> 
> The structures rte_cryptodev_sym_session and rte_cryptodev_asym_session are
> not used by the application directly. The application just need an opaque pointer
> which it can attach to rte_crypto_op while enqueue.
> Hence, these structures can be internal to library hidden from the user.
> 
> Signed-off-by: Akhil Goyal <gakhil@marvell.com>
> ---
>  doc/guides/rel_notes/deprecation.rst | 5 +++++
>  1 file changed, 5 insertions(+)
> 
> diff --git a/doc/guides/rel_notes/deprecation.rst
> b/doc/guides/rel_notes/deprecation.rst
> index f81bd87f10..7140e345b6 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -151,6 +151,11 @@ Deprecation Notices
>  * cryptodev: The APIs for interfacing between library and PMD will be marked
>    as internal APIs in DPDK 21.11.
> 
> +* cryptodev: Hide structures ``rte_cryptodev_sym_session`` and
> +  ``rte_cryptodev_asym_session`` to remove unnecessary indirection
> +between
> +  session and the private data of session. An opaque pointer can be
> +exposed
> +  directly to application which can be attached to the ``rte_crypto_op``.
> +
>  * 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.
> --

Acked-by: Anoob Joseph <anoobj@marvell.com>
Jerin Jacob Aug. 7, 2021, 1:34 p.m. UTC | #2 
On Thu, Aug 5, 2021 at 9:51 AM Anoob Joseph <anoobj@marvell.com> wrote:
>
> > Subject: [PATCH] doc: announce restructuring of crypto session structs
> >
> > The structures rte_cryptodev_sym_session and rte_cryptodev_asym_session are
> > not used by the application directly. The application just need an opaque pointer
> > which it can attach to rte_crypto_op while enqueue.
> > Hence, these structures can be internal to library hidden from the user.
> >
> > Signed-off-by: Akhil Goyal <gakhil@marvell.com>
> > ---
> >  doc/guides/rel_notes/deprecation.rst | 5 +++++
> >  1 file changed, 5 insertions(+)
> >
> > diff --git a/doc/guides/rel_notes/deprecation.rst
> > b/doc/guides/rel_notes/deprecation.rst
> > index f81bd87f10..7140e345b6 100644
> > --- a/doc/guides/rel_notes/deprecation.rst
> > +++ b/doc/guides/rel_notes/deprecation.rst
> > @@ -151,6 +151,11 @@ Deprecation Notices
> >  * cryptodev: The APIs for interfacing between library and PMD will be marked
> >    as internal APIs in DPDK 21.11.
> >
> > +* cryptodev: Hide structures ``rte_cryptodev_sym_session`` and
> > +  ``rte_cryptodev_asym_session`` to remove unnecessary indirection
> > +between
> > +  session and the private data of session. An opaque pointer can be
> > +exposed
> > +  directly to application which can be attached to the ``rte_crypto_op``.
> > +
> >  * 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.
> > --
>
> Acked-by: Anoob Joseph <anoobj@marvell.com>

Acked-by: Jerin Jacob <jerinj@marvell.com>


>
>
>
diff mbox series

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index f81bd87f10..7140e345b6 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -151,6 +151,11 @@  Deprecation Notices
 * cryptodev: The APIs for interfacing between library and PMD will be marked
   as internal APIs in DPDK 21.11.
 
+* cryptodev: Hide structures ``rte_cryptodev_sym_session`` and
+  ``rte_cryptodev_asym_session`` to remove unnecessary indirection between
+  session and the private data of session. An opaque pointer can be exposed
+  directly to application which can be attached to the ``rte_crypto_op``. 
+
 * 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.