diff mbox series

doc: security deprecation notice for session changes

Message ID 1542194611-5773-1-git-send-email-konstantin.ananyev@intel.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series doc: security deprecation notice for session changes |

Checks

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

Commit Message

Ananyev, Konstantin Nov. 14, 2018, 11:23 a.m. UTC 
  Add 'uint64_t opaque_data' inside struct rte_security_session.
That allows upper layer to easily associate some user defined
data with the session.
Proposed new layout for:
struct rte_security_session {
	void *sess_private_data;
	/**< Private session material */
+	uint64_t opaque_data;
+	/**< Opaque user defined data */
};

Signed-off-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
---
 doc/guides/rel_notes/deprecation.rst | 6 ++++++
 1 file changed, 6 insertions(+)

Comments

Mohammad Abdul Awal Nov. 14, 2018, 11:32 a.m. UTC | #1 
On 14/11/2018 11:23, Konstantin Ananyev wrote:
> Add 'uint64_t opaque_data' inside struct rte_security_session.
> That allows upper layer to easily associate some user defined
> data with the session.
> Proposed new layout for:
> struct rte_security_session {
> 	void *sess_private_data;
> 	/**< Private session material */
> +	uint64_t opaque_data;
> +	/**< Opaque user defined data */
> };
>
> Signed-off-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
> ---
>   doc/guides/rel_notes/deprecation.rst | 6 ++++++
>   1 file changed, 6 insertions(+)
>
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 34b28234c..0cdc42842 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -55,3 +55,9 @@ Deprecation Notices
>     - ``rte_pdump_set_socket_dir`` will be removed;
>     - The parameter, ``path``, of ``rte_pdump_init`` will be removed;
>     - The enum ``rte_pdump_socktype`` will be removed.
> +
> +* security: ABI change:
> +
> +  New field ``uint64_t opaque_data`` is planned to add into
> +  ``rte_security_session`` structure. That would allow upper layer to easily
> +  associate/de-associate some user defined data with the security session.
Acked-by: Mohammad Abdul Awal <mohammad.abdul.awal@intel.com>
Fan Zhang Nov. 14, 2018, 11:32 a.m. UTC | #2 
> -----Original Message-----
> From: dev [mailto:dev-bounces@dpdk.org] On Behalf Of Konstantin
> Ananyev
> Sent: Wednesday, November 14, 2018 11:24 AM
> To: dev@dpdk.org
> Cc: akhil.goyal@nxp.com; Doherty, Declan <declan.doherty@intel.com>;
> Ananyev, Konstantin <konstantin.ananyev@intel.com>
> Subject: [dpdk-dev] [PATCH] doc: security deprecation notice for session
> changes
> 

Acked-by: Fan Zhang <roy.fan.zhang@intel.com>
Akhil Goyal Nov. 14, 2018, 12:39 p.m. UTC | #3 
On 11/14/2018 4:53 PM, Konstantin Ananyev wrote:
> Add 'uint64_t opaque_data' inside struct rte_security_session.
> That allows upper layer to easily associate some user defined
> data with the session.
> Proposed new layout for:
> struct rte_security_session {
> 	void *sess_private_data;
> 	/**< Private session material */
> +	uint64_t opaque_data;
> +	/**< Opaque user defined data */
> };
>
> Signed-off-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
> ---
Acked-by: Akhil Goyal <akhil.goyal@nxp.com>

Does this also mean you have given the Ack for removing the experimental 
tag from security library? Because otherwise there is no point of this 
deprecation notice if the library is not formal.
>   doc/guides/rel_notes/deprecation.rst | 6 ++++++
>   1 file changed, 6 insertions(+)
>
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 34b28234c..0cdc42842 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -55,3 +55,9 @@ Deprecation Notices
>     - ``rte_pdump_set_socket_dir`` will be removed;
>     - The parameter, ``path``, of ``rte_pdump_init`` will be removed;
>     - The enum ``rte_pdump_socktype`` will be removed.
> +
> +* security: ABI change:
> +
> +  New field ``uint64_t opaque_data`` is planned to add into
> +  ``rte_security_session`` structure. That would allow upper layer to easily
> +  associate/de-associate some user defined data with the security session.
Ananyev, Konstantin Nov. 14, 2018, 1:02 p.m. UTC | #4 
> -----Original Message-----
> From: Akhil Goyal [mailto:akhil.goyal@nxp.com]
> Sent: Wednesday, November 14, 2018 12:40 PM
> To: Ananyev, Konstantin <konstantin.ananyev@intel.com>; dev@dpdk.org
> Cc: Doherty, Declan <declan.doherty@intel.com>
> Subject: Re: [dpdk-dev] [PATCH] doc: security deprecation notice for session changes
> 
> 
> 
> On 11/14/2018 4:53 PM, Konstantin Ananyev wrote:
> > Add 'uint64_t opaque_data' inside struct rte_security_session.
> > That allows upper layer to easily associate some user defined
> > data with the session.
> > Proposed new layout for:
> > struct rte_security_session {
> > 	void *sess_private_data;
> > 	/**< Private session material */
> > +	uint64_t opaque_data;
> > +	/**< Opaque user defined data */
> > };
> >
> > Signed-off-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
> > ---
> Acked-by: Akhil Goyal <akhil.goyal@nxp.com>
> 
> Does this also mean you have given the Ack for removing the experimental
> tag from security library? Because otherwise there is no point of this
> deprecation notice if the library is not formal.

For the whole library - yes.
Though I still suggest to keep 'experimental' for non-implemented functions
(rte_security_get_userdata()).
Hope that wouldn't block you guys.
Konstantin 

> >   doc/guides/rel_notes/deprecation.rst | 6 ++++++
> >   1 file changed, 6 insertions(+)
> >
> > diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> > index 34b28234c..0cdc42842 100644
> > --- a/doc/guides/rel_notes/deprecation.rst
> > +++ b/doc/guides/rel_notes/deprecation.rst
> > @@ -55,3 +55,9 @@ Deprecation Notices
> >     - ``rte_pdump_set_socket_dir`` will be removed;
> >     - The parameter, ``path``, of ``rte_pdump_init`` will be removed;
> >     - The enum ``rte_pdump_socktype`` will be removed.
> > +
> > +* security: ABI change:
> > +
> > +  New field ``uint64_t opaque_data`` is planned to add into
> > +  ``rte_security_session`` structure. That would allow upper layer to easily
> > +  associate/de-associate some user defined data with the security session.
Thomas Monjalon Nov. 24, 2018, 5:59 p.m. UTC | #5 
14/11/2018 13:39, Akhil Goyal:
> On 11/14/2018 4:53 PM, Konstantin Ananyev wrote:
> > Add 'uint64_t opaque_data' inside struct rte_security_session.
> > That allows upper layer to easily associate some user defined
> > data with the session.
> > Proposed new layout for:
> > struct rte_security_session {
> > 	void *sess_private_data;
> > 	/**< Private session material */
> > +	uint64_t opaque_data;
> > +	/**< Opaque user defined data */
> > };
> >
> > Signed-off-by: Konstantin Ananyev <konstantin.ananyev@intel.com>
> > ---
> Acked-by: Mohammad Abdul Awal <mohammad.abdul.awal@intel.com>
> Acked-by: Fan Zhang <roy.fan.zhang@intel.com>
> Acked-by: Akhil Goyal <akhil.goyal@nxp.com>

Applied
diff mbox series

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 34b28234c..0cdc42842 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -55,3 +55,9 @@  Deprecation Notices
   - ``rte_pdump_set_socket_dir`` will be removed;
   - The parameter, ``path``, of ``rte_pdump_init`` will be removed;
   - The enum ``rte_pdump_socktype`` will be removed.
+
+* security: ABI change:
+
+  New field ``uint64_t opaque_data`` is planned to add into
+  ``rte_security_session`` structure. That would allow upper layer to easily
+  associate/de-associate some user defined data with the security session.