doc: announce vhost changes to support asymmetric operation

Message ID 20240722145646.1219-1-gmuthukrishn@marvell.com (mailing list archive)
State Not Applicable, archived
Headers
Series doc: announce vhost changes to support asymmetric operation |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/loongarch-compilation success Compilation OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/github-robot: build success github build: passed
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/intel-Functional success Functional PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/iol-marvell-Functional success Functional Testing PASS
ci/iol-abi-testing success Testing PASS
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-broadcom-Functional success Functional Testing PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-compile-amd64-testing success Testing PASS
ci/iol-unit-amd64-testing success Testing PASS
ci/iol-unit-arm64-testing success Testing PASS
ci/iol-compile-arm64-testing success Testing PASS
ci/iol-sample-apps-testing success Testing PASS

Commit Message

Gowrishankar Muthukrishnan July 22, 2024, 2:56 p.m. UTC
Announce vhost ABI changes to modify few functions to support
asymmetric crypto operation.

Signed-off-by: Gowrishankar Muthukrishnan <gmuthukrishn@marvell.com>
--
RFC:
  https://patches.dpdk.org/project/dpdk/patch/20230928095300.1353-4-gmuthukrishn@marvell.com/
---
 doc/guides/rel_notes/deprecation.rst | 7 +++++++
 1 file changed, 7 insertions(+)
  

Comments

Jerin Jacob July 23, 2024, 6:30 p.m. UTC | #1
On Mon, Jul 22, 2024 at 8:33 PM Gowrishankar Muthukrishnan
<gmuthukrishn@marvell.com> wrote:
>
> Announce vhost ABI changes to modify few functions to support
> asymmetric crypto operation.
>
> Signed-off-by: Gowrishankar Muthukrishnan <gmuthukrishn@marvell.com>
> --
> RFC:
>   https://patches.dpdk.org/project/dpdk/patch/20230928095300.1353-4-gmuthukrishn@marvell.com/

Looks like in this case adding new arguments to function. Could you
check ABI versing helps here? It seems like it can be easy manged with
ABI versioning.

https://doc.dpdk.org/guides/contributing/abi_versioning.html

> ---
>  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 6948641ff6..2f5c2c5a34 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -147,3 +147,10 @@ Deprecation Notices
>    will be deprecated and subsequently removed in DPDK 24.11 release.
>    Before this, the new port library API (functions rte_swx_port_*)
>    will gradually transition from experimental to stable status.
> +
> +* vhost: The function ``rte_vhost_crypto_create`` will accept a new parameter
> +  to specify rte_mempool for asymmetric crypto session. The function
> +  ``rte_vhost_crypto_finalize_requests`` will accept two new parameters,
> +  where the first one is to specify vhost device id and other one is to specify
> +  the virtio queue index. These two modifications are required to support
> +  asymmetric crypto operation in vhost crypto and will break ABI.
> --
> 2.21.0
>
  
Gowrishankar Muthukrishnan July 25, 2024, 9:29 a.m. UTC | #2
Sure Jerin. I’ll drop this proposal as ABI versioning could help. Thanks.




Looks like in this case adding new arguments to function. Could you

check ABI versing helps here? It seems like it can be easy manged with

ABI versioning.
  

Patch

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 6948641ff6..2f5c2c5a34 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -147,3 +147,10 @@  Deprecation Notices
   will be deprecated and subsequently removed in DPDK 24.11 release.
   Before this, the new port library API (functions rte_swx_port_*)
   will gradually transition from experimental to stable status.
+
+* vhost: The function ``rte_vhost_crypto_create`` will accept a new parameter
+  to specify rte_mempool for asymmetric crypto session. The function
+  ``rte_vhost_crypto_finalize_requests`` will accept two new parameters,
+  where the first one is to specify vhost device id and other one is to specify
+  the virtio queue index. These two modifications are required to support
+  asymmetric crypto operation in vhost crypto and will break ABI.