[v3] vhost: mark vDPA driver API as internal
Checks
Commit Message
This patch marks the vDPA driver APIs as internal and
rename the corresponding header file to vdpa_driver.h.
Signed-off-by: Maxime Coquelin <maxime.coquelin@redhat.com>
Acked-by: Thomas Monjalon <thomas@monjalon.net>
Reviewed-by: Chenbo Xia <chenbo.xia@intel.com>
---
Changes in v3:
==============
- Update deprecation notice and release note
Changes in v2:
=============
- Alphabetical ordering in version.map (David)
- Rename header to vdpa_driver.h (David)
- Add Techboard in Cc to vote for API breakage exception
doc/guides/rel_notes/deprecation.rst | 4 ----
doc/guides/rel_notes/release_21_11.rst | 4 ++++
drivers/vdpa/ifc/ifcvf_vdpa.c | 2 +-
drivers/vdpa/mlx5/mlx5_vdpa.h | 2 +-
lib/vhost/meson.build | 4 +++-
lib/vhost/vdpa.c | 2 +-
lib/vhost/{rte_vdpa_dev.h => vdpa_driver.h} | 12 +++++++++---
lib/vhost/version.map | 13 +++++++++----
lib/vhost/vhost.h | 2 +-
9 files changed, 29 insertions(+), 16 deletions(-)
rename lib/vhost/{rte_vdpa_dev.h => vdpa_driver.h} (95%)
Comments
On 11/2/21 10:56, Maxime Coquelin wrote:
> This patch marks the vDPA driver APIs as internal and
> rename the corresponding header file to vdpa_driver.h.
>
> Signed-off-by: Maxime Coquelin <maxime.coquelin@redhat.com>
> Acked-by: Thomas Monjalon <thomas@monjalon.net>
> Reviewed-by: Chenbo Xia <chenbo.xia@intel.com>
> ---
> Changes in v3:
> ==============
> - Update deprecation notice and release note
>
> Changes in v2:
> =============
> - Alphabetical ordering in version.map (David)
> - Rename header to vdpa_driver.h (David)
> - Add Techboard in Cc to vote for API breakage exception
>
> doc/guides/rel_notes/deprecation.rst | 4 ----
> doc/guides/rel_notes/release_21_11.rst | 4 ++++
> drivers/vdpa/ifc/ifcvf_vdpa.c | 2 +-
> drivers/vdpa/mlx5/mlx5_vdpa.h | 2 +-
> lib/vhost/meson.build | 4 +++-
> lib/vhost/vdpa.c | 2 +-
> lib/vhost/{rte_vdpa_dev.h => vdpa_driver.h} | 12 +++++++++---
> lib/vhost/version.map | 13 +++++++++----
> lib/vhost/vhost.h | 2 +-
> 9 files changed, 29 insertions(+), 16 deletions(-)
> rename lib/vhost/{rte_vdpa_dev.h => vdpa_driver.h} (95%)
>
Applied to dpdk-next-virtio/main.
Thanks,
Maxime
@@ -107,10 +107,6 @@ Deprecation Notices
is deprecated as ambiguous with respect to the embedded switch. The use of
these attributes will become invalid starting from DPDK 22.11.
-* vhost: ``rte_vdpa_register_device``, ``rte_vdpa_unregister_device``,
- ``rte_vhost_host_notifier_ctrl`` and ``rte_vdpa_relay_vring_used`` vDPA
- driver interface will be marked as internal in DPDK v21.11.
-
* vhost: rename ``struct vhost_device_ops`` to ``struct rte_vhost_device_ops``
in DPDK v21.11.
@@ -475,6 +475,10 @@ API Changes
* eventdev: Moved memory used by timer adapters to hugepage. This will prevent
TLB misses if any and aligns to memory structure of other subsystems.
+* vhost: ``rte_vdpa_register_device``, ``rte_vdpa_unregister_device``,
+ ``rte_vhost_host_notifier_ctrl`` and ``rte_vdpa_relay_vring_used`` vDPA
+ driver interface are marked as internal.
+
ABI Changes
-----------
@@ -17,7 +17,7 @@
#include <rte_bus_pci.h>
#include <rte_vhost.h>
#include <rte_vdpa.h>
-#include <rte_vdpa_dev.h>
+#include <vdpa_driver.h>
#include <rte_vfio.h>
#include <rte_spinlock.h>
#include <rte_log.h>
@@ -12,7 +12,7 @@
#pragma GCC diagnostic ignored "-Wpedantic"
#endif
#include <rte_vdpa.h>
-#include <rte_vdpa_dev.h>
+#include <vdpa_driver.h>
#include <rte_vhost.h>
#ifdef PEDANTIC
#pragma GCC diagnostic error "-Wpedantic"
@@ -29,9 +29,11 @@ sources = files(
)
headers = files(
'rte_vdpa.h',
- 'rte_vdpa_dev.h',
'rte_vhost.h',
'rte_vhost_async.h',
'rte_vhost_crypto.h',
)
+driver_sdk_headers = files(
+ 'vdpa_driver.h',
+)
deps += ['ethdev', 'cryptodev', 'hash', 'pci']
@@ -17,7 +17,7 @@
#include <rte_tailq.h>
#include "rte_vdpa.h"
-#include "rte_vdpa_dev.h"
+#include "vdpa_driver.h"
#include "vhost.h"
/** Double linked list of vDPA devices. */
similarity index 95%
rename from lib/vhost/rte_vdpa_dev.h
rename to lib/vhost/vdpa_driver.h
@@ -2,11 +2,13 @@
* Copyright(c) 2018 Intel Corporation
*/
-#ifndef _RTE_VDPA_H_DEV_
-#define _RTE_VDPA_H_DEV_
+#ifndef _VDPA_DRIVER_H_
+#define _VDPA_DRIVER_H_
#include <stdbool.h>
+#include <rte_compat.h>
+
#include "rte_vhost.h"
#include "rte_vdpa.h"
@@ -88,6 +90,7 @@ struct rte_vdpa_device {
* @return
* vDPA device pointer on success, NULL on failure
*/
+__rte_internal
struct rte_vdpa_device *
rte_vdpa_register_device(struct rte_device *rte_dev,
struct rte_vdpa_dev_ops *ops);
@@ -100,6 +103,7 @@ rte_vdpa_register_device(struct rte_device *rte_dev,
* @return
* device id on success, -1 on failure
*/
+__rte_internal
int
rte_vdpa_unregister_device(struct rte_vdpa_device *dev);
@@ -115,6 +119,7 @@ rte_vdpa_unregister_device(struct rte_vdpa_device *dev);
* @return
* 0 on success, -1 on failure
*/
+__rte_internal
int
rte_vhost_host_notifier_ctrl(int vid, uint16_t qid, bool enable);
@@ -132,7 +137,8 @@ rte_vhost_host_notifier_ctrl(int vid, uint16_t qid, bool enable);
* @return
* number of synced used entries on success, -1 on failure
*/
+__rte_internal
int
rte_vdpa_relay_vring_used(int vid, uint16_t qid, void *vring_m);
-#endif /* _RTE_VDPA_DEV_H_ */
+#endif /* _VDPA_DRIVER_H_ */
@@ -8,10 +8,7 @@ DPDK_22 {
rte_vdpa_get_rte_device;
rte_vdpa_get_stats;
rte_vdpa_get_stats_names;
- rte_vdpa_register_device;
- rte_vdpa_relay_vring_used;
rte_vdpa_reset_stats;
- rte_vdpa_unregister_device;
rte_vhost_avail_entries;
rte_vhost_clr_inflight_desc_packed;
rte_vhost_clr_inflight_desc_split;
@@ -52,7 +49,6 @@ DPDK_22 {
rte_vhost_get_vring_base_from_inflight;
rte_vhost_get_vring_num;
rte_vhost_gpa_to_vva;
- rte_vhost_host_notifier_ctrl;
rte_vhost_log_used_vring;
rte_vhost_log_write;
rte_vhost_rx_queue_count;
@@ -89,3 +85,12 @@ EXPERIMENTAL {
# added in 21.11
rte_vhost_get_monitor_addr;
};
+
+INTERNAL {
+ global;
+
+ rte_vdpa_register_device;
+ rte_vdpa_relay_vring_used;
+ rte_vdpa_unregister_device;
+ rte_vhost_host_notifier_ctrl;
+};
@@ -22,7 +22,7 @@
#include "rte_vhost.h"
#include "rte_vdpa.h"
-#include "rte_vdpa_dev.h"
+#include "vdpa_driver.h"
#include "rte_vhost_async.h"