vhost: mark vDPA driver API as internal
authorMaxime Coquelin <maxime.coquelin@redhat.com>
Tue, 2 Nov 2021 09:56:11 +0000 (10:56 +0100)
committerMaxime Coquelin <maxime.coquelin@redhat.com>
Wed, 3 Nov 2021 08:11:34 +0000 (09:11 +0100)
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>
doc/guides/rel_notes/deprecation.rst
doc/guides/rel_notes/release_21_11.rst
drivers/vdpa/ifc/ifcvf_vdpa.c
drivers/vdpa/mlx5/mlx5_vdpa.h
lib/vhost/meson.build
lib/vhost/rte_vdpa_dev.h [deleted file]
lib/vhost/vdpa.c
lib/vhost/vdpa_driver.h [new file with mode: 0644]
lib/vhost/version.map
lib/vhost/vhost.h

index a708ad7..9c303a1 100644 (file)
@@ -104,10 +104,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.
 
index 5a0e56d..814ecac 100644 (file)
@@ -464,6 +464,10 @@ API Changes
   should be provided, and offset for immediate source bitfield is assigned
   from destination one.
 
+* 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.
+
 * cryptodev: The API rte_cryptodev_pmd_is_valid_dev is modified to
   rte_cryptodev_is_valid_dev as it can be used by the application as
   well as PMD to check whether the device is valid or not.
index dd5251d..3853c4c 100644 (file)
@@ -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>
index cf4f384..a6c9404 100644 (file)
@@ -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"
index 2d8fe02..cdb37a4 100644 (file)
@@ -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']
diff --git a/lib/vhost/rte_vdpa_dev.h b/lib/vhost/rte_vdpa_dev.h
deleted file mode 100644 (file)
index b0f4948..0000000
+++ /dev/null
@@ -1,138 +0,0 @@
-/* SPDX-License-Identifier: BSD-3-Clause
- * Copyright(c) 2018 Intel Corporation
- */
-
-#ifndef _RTE_VDPA_H_DEV_
-#define _RTE_VDPA_H_DEV_
-
-#include <stdbool.h>
-
-#include "rte_vhost.h"
-#include "rte_vdpa.h"
-
-#define RTE_VHOST_QUEUE_ALL UINT16_MAX
-
-/**
- * vdpa device operations
- */
-struct rte_vdpa_dev_ops {
-       /** Get capabilities of this device (Mandatory) */
-       int (*get_queue_num)(struct rte_vdpa_device *dev, uint32_t *queue_num);
-
-       /** Get supported features of this device (Mandatory) */
-       int (*get_features)(struct rte_vdpa_device *dev, uint64_t *features);
-
-       /** Get supported protocol features of this device (Mandatory) */
-       int (*get_protocol_features)(struct rte_vdpa_device *dev,
-                       uint64_t *protocol_features);
-
-       /** Driver configure the device (Mandatory) */
-       int (*dev_conf)(int vid);
-
-       /** Driver close the device (Mandatory) */
-       int (*dev_close)(int vid);
-
-       /** Enable/disable this vring (Mandatory) */
-       int (*set_vring_state)(int vid, int vring, int state);
-
-       /** Set features when changed (Mandatory) */
-       int (*set_features)(int vid);
-
-       /** Destination operations when migration done */
-       int (*migration_done)(int vid);
-
-       /** Get the vfio group fd */
-       int (*get_vfio_group_fd)(int vid);
-
-       /** Get the vfio device fd */
-       int (*get_vfio_device_fd)(int vid);
-
-       /** Get the notify area info of the queue */
-       int (*get_notify_area)(int vid, int qid,
-                       uint64_t *offset, uint64_t *size);
-
-       /** Get statistics name */
-       int (*get_stats_names)(struct rte_vdpa_device *dev,
-                       struct rte_vdpa_stat_name *stats_names,
-                       unsigned int size);
-
-       /** Get statistics of the queue */
-       int (*get_stats)(struct rte_vdpa_device *dev, int qid,
-                       struct rte_vdpa_stat *stats, unsigned int n);
-
-       /** Reset statistics of the queue */
-       int (*reset_stats)(struct rte_vdpa_device *dev, int qid);
-
-       /** Reserved for future extension */
-       void *reserved[2];
-};
-
-/**
- * vdpa device structure includes device address and device operations.
- */
-struct rte_vdpa_device {
-       RTE_TAILQ_ENTRY(rte_vdpa_device) next;
-       /** Generic device information */
-       struct rte_device *device;
-       /** vdpa device operations */
-       struct rte_vdpa_dev_ops *ops;
-};
-
-/**
- * Register a vdpa device
- *
- * @param rte_dev
- *  the generic device pointer
- * @param ops
- *  the vdpa device operations
- * @return
- *  vDPA device pointer on success, NULL on failure
- */
-struct rte_vdpa_device *
-rte_vdpa_register_device(struct rte_device *rte_dev,
-               struct rte_vdpa_dev_ops *ops);
-
-/**
- * Unregister a vdpa device
- *
- * @param dev
- *  vDPA device pointer
- * @return
- *  device id on success, -1 on failure
- */
-int
-rte_vdpa_unregister_device(struct rte_vdpa_device *dev);
-
-/**
- * Enable/Disable host notifier mapping for a vdpa port.
- *
- * @param vid
- *  vhost device id
- * @param enable
- *  true for host notifier map, false for host notifier unmap
- * @param qid
- *  vhost queue id, RTE_VHOST_QUEUE_ALL to configure all the device queues
- * @return
- *  0 on success, -1 on failure
- */
-int
-rte_vhost_host_notifier_ctrl(int vid, uint16_t qid, bool enable);
-
-/**
- * Synchronize the used ring from mediated ring to guest, log dirty
- * page for each writeable buffer, caller should handle the used
- * ring logging before device stop.
- *
- * @param vid
- *  vhost device id
- * @param qid
- *  vhost queue id
- * @param vring_m
- *  mediated virtio ring pointer
- * @return
- *  number of synced used entries on success, -1 on failure
- */
-int
-rte_vdpa_relay_vring_used(int vid, uint16_t qid, void *vring_m);
-
-#endif /* _RTE_VDPA_DEV_H_ */
index 6dd9185..09ad5d8 100644 (file)
@@ -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. */
diff --git a/lib/vhost/vdpa_driver.h b/lib/vhost/vdpa_driver.h
new file mode 100644 (file)
index 0000000..fc2d6ac
--- /dev/null
@@ -0,0 +1,144 @@
+/* SPDX-License-Identifier: BSD-3-Clause
+ * Copyright(c) 2018 Intel Corporation
+ */
+
+#ifndef _VDPA_DRIVER_H_
+#define _VDPA_DRIVER_H_
+
+#include <stdbool.h>
+
+#include <rte_compat.h>
+
+#include "rte_vhost.h"
+#include "rte_vdpa.h"
+
+#define RTE_VHOST_QUEUE_ALL UINT16_MAX
+
+/**
+ * vdpa device operations
+ */
+struct rte_vdpa_dev_ops {
+       /** Get capabilities of this device (Mandatory) */
+       int (*get_queue_num)(struct rte_vdpa_device *dev, uint32_t *queue_num);
+
+       /** Get supported features of this device (Mandatory) */
+       int (*get_features)(struct rte_vdpa_device *dev, uint64_t *features);
+
+       /** Get supported protocol features of this device (Mandatory) */
+       int (*get_protocol_features)(struct rte_vdpa_device *dev,
+                       uint64_t *protocol_features);
+
+       /** Driver configure the device (Mandatory) */
+       int (*dev_conf)(int vid);
+
+       /** Driver close the device (Mandatory) */
+       int (*dev_close)(int vid);
+
+       /** Enable/disable this vring (Mandatory) */
+       int (*set_vring_state)(int vid, int vring, int state);
+
+       /** Set features when changed (Mandatory) */
+       int (*set_features)(int vid);
+
+       /** Destination operations when migration done */
+       int (*migration_done)(int vid);
+
+       /** Get the vfio group fd */
+       int (*get_vfio_group_fd)(int vid);
+
+       /** Get the vfio device fd */
+       int (*get_vfio_device_fd)(int vid);
+
+       /** Get the notify area info of the queue */
+       int (*get_notify_area)(int vid, int qid,
+                       uint64_t *offset, uint64_t *size);
+
+       /** Get statistics name */
+       int (*get_stats_names)(struct rte_vdpa_device *dev,
+                       struct rte_vdpa_stat_name *stats_names,
+                       unsigned int size);
+
+       /** Get statistics of the queue */
+       int (*get_stats)(struct rte_vdpa_device *dev, int qid,
+                       struct rte_vdpa_stat *stats, unsigned int n);
+
+       /** Reset statistics of the queue */
+       int (*reset_stats)(struct rte_vdpa_device *dev, int qid);
+
+       /** Reserved for future extension */
+       void *reserved[2];
+};
+
+/**
+ * vdpa device structure includes device address and device operations.
+ */
+struct rte_vdpa_device {
+       RTE_TAILQ_ENTRY(rte_vdpa_device) next;
+       /** Generic device information */
+       struct rte_device *device;
+       /** vdpa device operations */
+       struct rte_vdpa_dev_ops *ops;
+};
+
+/**
+ * Register a vdpa device
+ *
+ * @param rte_dev
+ *  the generic device pointer
+ * @param ops
+ *  the vdpa device operations
+ * @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);
+
+/**
+ * Unregister a vdpa device
+ *
+ * @param dev
+ *  vDPA device pointer
+ * @return
+ *  device id on success, -1 on failure
+ */
+__rte_internal
+int
+rte_vdpa_unregister_device(struct rte_vdpa_device *dev);
+
+/**
+ * Enable/Disable host notifier mapping for a vdpa port.
+ *
+ * @param vid
+ *  vhost device id
+ * @param enable
+ *  true for host notifier map, false for host notifier unmap
+ * @param qid
+ *  vhost queue id, RTE_VHOST_QUEUE_ALL to configure all the device queues
+ * @return
+ *  0 on success, -1 on failure
+ */
+__rte_internal
+int
+rte_vhost_host_notifier_ctrl(int vid, uint16_t qid, bool enable);
+
+/**
+ * Synchronize the used ring from mediated ring to guest, log dirty
+ * page for each writeable buffer, caller should handle the used
+ * ring logging before device stop.
+ *
+ * @param vid
+ *  vhost device id
+ * @param qid
+ *  vhost queue id
+ * @param vring_m
+ *  mediated virtio ring pointer
+ * @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 /* _VDPA_DRIVER_H_ */
index c8599dd..a7ef7f1 100644 (file)
@@ -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;
+};
index 05ccc35..c072192 100644 (file)
@@ -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"