[Patch v2] doc: announce bus/vmbus API changes

[Patch v2] doc: announce bus/vmbus API changes

[longli]

From: Long Li <longli@microsoft.com>

All vmbus APIs are used internally by DPDK core and net/netvsc PMD.
It's not feasible or practical to use those APIs by the application.
Those APIs will be moved from "DPDK" to "Internal" in DPDK 25.11.

Signed-off-by: Long Li <longli@microsoft.com>
---
Change in v2:
add details on what APIs will be changed

 doc/guides/rel_notes/deprecation.rst | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
index 3f5f0e949c..0ff7dd69cd 100644
--- a/doc/guides/rel_notes/deprecation.rst
+++ b/doc/guides/rel_notes/deprecation.rst
@@ -138,3 +138,27 @@ 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.
+
+* bus/vmbus: Starting DPDK 25.11, all the vmbus APIs will be moved
+  from "DPDK" to "INTERNAL" in drivers/bus/vmbus/version.map.
+  Those APIs are used only by DPDK core and net/netvsc PMD.
+  The following APIs wil be moved:
+  rte_vmbus_chan_close
+  rte_vmbus_chan_open
+  rte_vmbus_chan_recv
+  rte_vmbus_chan_recv_raw
+  rte_vmbus_chan_rx_empty
+  rte_vmbus_chan_send
+  rte_vmbus_chan_send_sglist
+  rte_vmbus_chan_signal_read
+  rte_vmbus_chan_signal_tx
+  rte_vmbus_irq_mask
+  rte_vmbus_irq_read
+  rte_vmbus_irq_unmask
+  rte_vmbus_map_device
+  rte_vmbus_max_channels
+  rte_vmbus_probe
+  rte_vmbus_scan
+  rte_vmbus_set_latency
+  rte_vmbus_sub_channel_index
+  rte_vmbus_subchan_open
-- 
2.34.1

Re: [Patch v2] doc: announce bus/vmbus API changes

[David Marchand]

On Sat, Mar 15, 2025 at 1:35 AM <longli@linuxonhyperv.com> wrote:
>
> From: Long Li <longli@microsoft.com>
>
> All vmbus APIs are used internally by DPDK core and net/netvsc PMD.
> It's not feasible or practical to use those APIs by the application.
> Those APIs will be moved from "DPDK" to "Internal" in DPDK 25.11.
>
> Signed-off-by: Long Li <longli@microsoft.com>
> ---
> Change in v2:
> add details on what APIs will be changed
>
>  doc/guides/rel_notes/deprecation.rst | 24 ++++++++++++++++++++++++
>  1 file changed, 24 insertions(+)
>
> diff --git a/doc/guides/rel_notes/deprecation.rst b/doc/guides/rel_notes/deprecation.rst
> index 3f5f0e949c..0ff7dd69cd 100644
> --- a/doc/guides/rel_notes/deprecation.rst
> +++ b/doc/guides/rel_notes/deprecation.rst
> @@ -138,3 +138,27 @@ 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.
> +
> +* bus/vmbus: Starting DPDK 25.11, all the vmbus APIs will be moved
> +  from "DPDK" to "INTERNAL" in drivers/bus/vmbus/version.map.

Nit: I would not mention version.map: it is just an implementation
detail (of symbol exports/versioning) that will become obsolete
if/when my rework gets merged.
https://patchwork.dpdk.org/project/dpdk/list/?series=34828&state=*


> +  Those APIs are used only by DPDK core and net/netvsc PMD.
> +  The following APIs wil be moved:
> +  rte_vmbus_chan_close
> +  rte_vmbus_chan_open
> +  rte_vmbus_chan_recv
> +  rte_vmbus_chan_recv_raw
> +  rte_vmbus_chan_rx_empty
> +  rte_vmbus_chan_send
> +  rte_vmbus_chan_send_sglist
> +  rte_vmbus_chan_signal_read
> +  rte_vmbus_chan_signal_tx
> +  rte_vmbus_irq_mask
> +  rte_vmbus_irq_read
> +  rte_vmbus_irq_unmask
> +  rte_vmbus_map_device
> +  rte_vmbus_max_channels
> +  rte_vmbus_probe
> +  rte_vmbus_scan
> +  rte_vmbus_set_latency
> +  rte_vmbus_sub_channel_index
> +  rte_vmbus_subchan_open

So all symbols from rte_bus_vmbus.h header become internal.

As part of the move during 25.11, this header will have to be renamed,
and moved to the driver_sdk_headers list like other buses (see
bus_pci_driver.h, for example).
Keep this in mind when doing the API change during 25.11.
(this is just a heads up, we don't need to mention this point in the
deprecation notices)


Otherwise, this cleanup lgtm.
Thanks.

-- 
David Marchand