[dpdk-dev] [PATCH v7 06/10] eventdev: make driver-only headers private

Bruce Richardson bruce.richardson at intel.com
Fri Jan 29 17:48:20 CET 2021


The rte_eventdev_pmd*.h files are for drivers only and should be private
to DPDK, and not installed for app use.

Signed-off-by: Bruce Richardson <bruce.richardson at intel.com>
---
 doc/guides/rel_notes/release_21_02.rst                      | 6 ++++++
 drivers/event/dlb/dlb.c                                     | 2 +-
 drivers/event/dlb/dlb_priv.h                                | 4 ++--
 drivers/event/dlb/rte_pmd_dlb.c                             | 2 +-
 drivers/event/dlb2/dlb2.c                                   | 2 +-
 drivers/event/dlb2/pf/dlb2_pf.c                             | 4 ++--
 drivers/event/dlb2/rte_pmd_dlb2.c                           | 2 +-
 drivers/event/dpaa/dpaa_eventdev.c                          | 2 +-
 drivers/event/dpaa/dpaa_eventdev.h                          | 4 ++--
 drivers/event/dpaa2/dpaa2_eventdev.h                        | 4 ++--
 drivers/event/dsw/dsw_evdev.c                               | 4 ++--
 drivers/event/octeontx/ssovf_evdev.h                        | 2 +-
 drivers/event/octeontx2/otx2_evdev.c                        | 2 +-
 drivers/event/octeontx2/otx2_evdev.h                        | 2 +-
 drivers/event/opdl/opdl_evdev.h                             | 2 +-
 drivers/event/skeleton/skeleton_eventdev.h                  | 4 ++--
 drivers/event/sw/sw_evdev.h                                 | 2 +-
 lib/librte_eventdev/{rte_eventdev_pmd.h => eventdev_pmd.h}  | 0
 .../{rte_eventdev_pmd_pci.h => eventdev_pmd_pci.h}          | 2 +-
 .../{rte_eventdev_pmd_vdev.h => eventdev_pmd_vdev.h}        | 2 +-
 lib/librte_eventdev/meson.build                             | 3 ---
 lib/librte_eventdev/rte_event_crypto_adapter.c              | 2 +-
 lib/librte_eventdev/rte_event_eth_rx_adapter.c              | 2 +-
 lib/librte_eventdev/rte_event_eth_tx_adapter.c              | 2 +-
 lib/librte_eventdev/rte_event_timer_adapter.c               | 2 +-
 lib/librte_eventdev/rte_eventdev.c                          | 2 +-
 26 files changed, 35 insertions(+), 32 deletions(-)
 rename lib/librte_eventdev/{rte_eventdev_pmd.h => eventdev_pmd.h} (100%)
 rename lib/librte_eventdev/{rte_eventdev_pmd_pci.h => eventdev_pmd_pci.h} (99%)
 rename lib/librte_eventdev/{rte_eventdev_pmd_vdev.h => eventdev_pmd_vdev.h} (98%)

diff --git a/doc/guides/rel_notes/release_21_02.rst b/doc/guides/rel_notes/release_21_02.rst
index 3831d1ca1e..17fcfd661c 100644
--- a/doc/guides/rel_notes/release_21_02.rst
+++ b/doc/guides/rel_notes/release_21_02.rst
@@ -151,6 +151,12 @@ Removed Items
   ``ethdev_pci.h`` respectively in the source tree, to reflect the fact that
   they are non-public headers.
 
+* The internal header files ``rte_eventdev_pmd.h``, ``rte_eventdev_pmd_vdev.h`` and
+  ``rte_eventdev_pmd_pci.h`` are no longer installed as part of the DPDK ``ninja
+  install`` action and are renamed to ``eventdev_pmd.h``, ``eventdev_pmd_vdev.h`` and
+  ``eventdev_pmd_pci.h`` respectively in the source tree, to reflect the fact that
+  they are non-public headers.
+
 * Removed support for NetXtreme devices belonging to ``BCM573xx and
   BCM5740x`` families. Specifically the support for the following Broadcom
   PCI device IDs ``0x16c8, 0x16c9, 0x16ca, 0x16ce, 0x16cf, 0x16df, 0x16d0,``
diff --git a/drivers/event/dlb/dlb.c b/drivers/event/dlb/dlb.c
index a65f70882f..64e6df7373 100644
--- a/drivers/event/dlb/dlb.c
+++ b/drivers/event/dlb/dlb.c
@@ -31,7 +31,7 @@
 #include <rte_string_fns.h>
 
 #include <rte_eventdev.h>
-#include <rte_eventdev_pmd.h>
+#include <eventdev_pmd.h>
 
 #include "dlb_priv.h"
 #include "dlb_iface.h"
diff --git a/drivers/event/dlb/dlb_priv.h b/drivers/event/dlb/dlb_priv.h
index 58ff4287df..272e17482f 100644
--- a/drivers/event/dlb/dlb_priv.h
+++ b/drivers/event/dlb/dlb_priv.h
@@ -10,8 +10,8 @@
 
 #include <rte_bus_pci.h>
 #include <rte_eventdev.h>
-#include <rte_eventdev_pmd.h>
-#include <rte_eventdev_pmd_pci.h>
+#include <eventdev_pmd.h>
+#include <eventdev_pmd_pci.h>
 #include <rte_pci.h>
 
 #include "dlb_user.h"
diff --git a/drivers/event/dlb/rte_pmd_dlb.c b/drivers/event/dlb/rte_pmd_dlb.c
index bc802d381a..8f56dc306a 100644
--- a/drivers/event/dlb/rte_pmd_dlb.c
+++ b/drivers/event/dlb/rte_pmd_dlb.c
@@ -3,7 +3,7 @@
  */
 
 #include "rte_eventdev.h"
-#include "rte_eventdev_pmd.h"
+#include "eventdev_pmd.h"
 #include "rte_pmd_dlb.h"
 #include "dlb_priv.h"
 #include "dlb_inline_fns.h"
diff --git a/drivers/event/dlb2/dlb2.c b/drivers/event/dlb2/dlb2.c
index 5782960158..b28ec58bfb 100644
--- a/drivers/event/dlb2/dlb2.c
+++ b/drivers/event/dlb2/dlb2.c
@@ -20,7 +20,7 @@
 #include <rte_dev.h>
 #include <rte_errno.h>
 #include <rte_eventdev.h>
-#include <rte_eventdev_pmd.h>
+#include <eventdev_pmd.h>
 #include <rte_io.h>
 #include <rte_kvargs.h>
 #include <rte_log.h>
diff --git a/drivers/event/dlb2/pf/dlb2_pf.c b/drivers/event/dlb2/pf/dlb2_pf.c
index 632c4e099f..1a7d8fc294 100644
--- a/drivers/event/dlb2/pf/dlb2_pf.c
+++ b/drivers/event/dlb2/pf/dlb2_pf.c
@@ -26,8 +26,8 @@
 #include <rte_pci.h>
 #include <rte_bus_pci.h>
 #include <rte_eventdev.h>
-#include <rte_eventdev_pmd.h>
-#include <rte_eventdev_pmd_pci.h>
+#include <eventdev_pmd.h>
+#include <eventdev_pmd_pci.h>
 #include <rte_memory.h>
 #include <rte_string_fns.h>
 
diff --git a/drivers/event/dlb2/rte_pmd_dlb2.c b/drivers/event/dlb2/rte_pmd_dlb2.c
index b09b585f0b..43990e46ac 100644
--- a/drivers/event/dlb2/rte_pmd_dlb2.c
+++ b/drivers/event/dlb2/rte_pmd_dlb2.c
@@ -3,7 +3,7 @@
  */
 
 #include <rte_eventdev.h>
-#include <rte_eventdev_pmd.h>
+#include <eventdev_pmd.h>
 
 #include "rte_pmd_dlb2.h"
 #include "dlb2_priv.h"
diff --git a/drivers/event/dpaa/dpaa_eventdev.c b/drivers/event/dpaa/dpaa_eventdev.c
index 01ddd0eb63..460375ca30 100644
--- a/drivers/event/dpaa/dpaa_eventdev.c
+++ b/drivers/event/dpaa/dpaa_eventdev.c
@@ -24,7 +24,7 @@
 #include <rte_memzone.h>
 #include <rte_pci.h>
 #include <rte_eventdev.h>
-#include <rte_eventdev_pmd_vdev.h>
+#include <eventdev_pmd_vdev.h>
 #include <rte_ethdev.h>
 #include <rte_event_eth_rx_adapter.h>
 #include <rte_event_eth_tx_adapter.h>
diff --git a/drivers/event/dpaa/dpaa_eventdev.h b/drivers/event/dpaa/dpaa_eventdev.h
index 0b3da83a4f..b4535c7b86 100644
--- a/drivers/event/dpaa/dpaa_eventdev.h
+++ b/drivers/event/dpaa/dpaa_eventdev.h
@@ -5,8 +5,8 @@
 #ifndef __DPAA_EVENTDEV_H__
 #define __DPAA_EVENTDEV_H__
 
-#include <rte_eventdev_pmd.h>
-#include <rte_eventdev_pmd_vdev.h>
+#include <eventdev_pmd.h>
+#include <eventdev_pmd_vdev.h>
 #include <rte_atomic.h>
 #include <rte_per_lcore.h>
 
diff --git a/drivers/event/dpaa2/dpaa2_eventdev.h b/drivers/event/dpaa2/dpaa2_eventdev.h
index 785e52032e..bb87bdbab2 100644
--- a/drivers/event/dpaa2/dpaa2_eventdev.h
+++ b/drivers/event/dpaa2/dpaa2_eventdev.h
@@ -5,8 +5,8 @@
 #ifndef __DPAA2_EVENTDEV_H__
 #define __DPAA2_EVENTDEV_H__
 
-#include <rte_eventdev_pmd.h>
-#include <rte_eventdev_pmd_vdev.h>
+#include <eventdev_pmd.h>
+#include <eventdev_pmd_vdev.h>
 #include <rte_atomic.h>
 #include <mc/fsl_dpcon.h>
 #include <mc/fsl_mc_sys.h>
diff --git a/drivers/event/dsw/dsw_evdev.c b/drivers/event/dsw/dsw_evdev.c
index 933a5a559b..ae188f7e6b 100644
--- a/drivers/event/dsw/dsw_evdev.c
+++ b/drivers/event/dsw/dsw_evdev.c
@@ -5,8 +5,8 @@
 #include <stdbool.h>
 
 #include <rte_cycles.h>
-#include <rte_eventdev_pmd.h>
-#include <rte_eventdev_pmd_vdev.h>
+#include <eventdev_pmd.h>
+#include <eventdev_pmd_vdev.h>
 #include <rte_random.h>
 #include <rte_ring_elem.h>
 
diff --git a/drivers/event/octeontx/ssovf_evdev.h b/drivers/event/octeontx/ssovf_evdev.h
index 10163151cd..bb1056a955 100644
--- a/drivers/event/octeontx/ssovf_evdev.h
+++ b/drivers/event/octeontx/ssovf_evdev.h
@@ -6,7 +6,7 @@
 #define __SSOVF_EVDEV_H__
 
 #include <rte_event_eth_tx_adapter.h>
-#include <rte_eventdev_pmd_vdev.h>
+#include <eventdev_pmd_vdev.h>
 #include <rte_io.h>
 
 #include <octeontx_mbox.h>
diff --git a/drivers/event/octeontx2/otx2_evdev.c b/drivers/event/octeontx2/otx2_evdev.c
index 0fe014c24a..bb1ff456fb 100644
--- a/drivers/event/octeontx2/otx2_evdev.c
+++ b/drivers/event/octeontx2/otx2_evdev.c
@@ -7,7 +7,7 @@
 #include <rte_bus_pci.h>
 #include <rte_common.h>
 #include <rte_eal.h>
-#include <rte_eventdev_pmd_pci.h>
+#include <eventdev_pmd_pci.h>
 #include <rte_kvargs.h>
 #include <rte_mbuf_pool_ops.h>
 #include <rte_pci.h>
diff --git a/drivers/event/octeontx2/otx2_evdev.h b/drivers/event/octeontx2/otx2_evdev.h
index 0513cb81c9..2971af73b6 100644
--- a/drivers/event/octeontx2/otx2_evdev.h
+++ b/drivers/event/octeontx2/otx2_evdev.h
@@ -6,7 +6,7 @@
 #define __OTX2_EVDEV_H__
 
 #include <rte_eventdev.h>
-#include <rte_eventdev_pmd.h>
+#include <eventdev_pmd.h>
 #include <rte_event_eth_rx_adapter.h>
 #include <rte_event_eth_tx_adapter.h>
 
diff --git a/drivers/event/opdl/opdl_evdev.h b/drivers/event/opdl/opdl_evdev.h
index 610b58b356..2dca0a8a98 100644
--- a/drivers/event/opdl/opdl_evdev.h
+++ b/drivers/event/opdl/opdl_evdev.h
@@ -6,7 +6,7 @@
 #define _OPDL_EVDEV_H_
 
 #include <rte_eventdev.h>
-#include <rte_eventdev_pmd_vdev.h>
+#include <eventdev_pmd_vdev.h>
 #include <rte_atomic.h>
 #include "opdl_ring.h"
 
diff --git a/drivers/event/skeleton/skeleton_eventdev.h b/drivers/event/skeleton/skeleton_eventdev.h
index ba64b8aea4..9193f45f47 100644
--- a/drivers/event/skeleton/skeleton_eventdev.h
+++ b/drivers/event/skeleton/skeleton_eventdev.h
@@ -5,8 +5,8 @@
 #ifndef __SKELETON_EVENTDEV_H__
 #define __SKELETON_EVENTDEV_H__
 
-#include <rte_eventdev_pmd_pci.h>
-#include <rte_eventdev_pmd_vdev.h>
+#include <eventdev_pmd_pci.h>
+#include <eventdev_pmd_vdev.h>
 
 #ifdef RTE_LIBRTE_PMD_SKELETON_EVENTDEV_DEBUG
 #define PMD_DRV_LOG(level, fmt, args...) \
diff --git a/drivers/event/sw/sw_evdev.h b/drivers/event/sw/sw_evdev.h
index 1fc07b64fc..5ab6465c83 100644
--- a/drivers/event/sw/sw_evdev.h
+++ b/drivers/event/sw/sw_evdev.h
@@ -7,7 +7,7 @@
 
 #include "sw_evdev_log.h"
 #include <rte_eventdev.h>
-#include <rte_eventdev_pmd_vdev.h>
+#include <eventdev_pmd_vdev.h>
 #include <rte_atomic.h>
 
 #define SW_DEFAULT_CREDIT_QUANTA 32
diff --git a/lib/librte_eventdev/rte_eventdev_pmd.h b/lib/librte_eventdev/eventdev_pmd.h
similarity index 100%
rename from lib/librte_eventdev/rte_eventdev_pmd.h
rename to lib/librte_eventdev/eventdev_pmd.h
diff --git a/lib/librte_eventdev/rte_eventdev_pmd_pci.h b/lib/librte_eventdev/eventdev_pmd_pci.h
similarity index 99%
rename from lib/librte_eventdev/rte_eventdev_pmd_pci.h
rename to lib/librte_eventdev/eventdev_pmd_pci.h
index 5f238bf496..d14ea634b8 100644
--- a/lib/librte_eventdev/rte_eventdev_pmd_pci.h
+++ b/lib/librte_eventdev/eventdev_pmd_pci.h
@@ -26,7 +26,7 @@ extern "C" {
 #include <rte_pci.h>
 #include <rte_bus_pci.h>
 
-#include "rte_eventdev_pmd.h"
+#include "eventdev_pmd.h"
 
 typedef int (*eventdev_pmd_pci_callback_t)(struct rte_eventdev *dev);
 
diff --git a/lib/librte_eventdev/rte_eventdev_pmd_vdev.h b/lib/librte_eventdev/eventdev_pmd_vdev.h
similarity index 98%
rename from lib/librte_eventdev/rte_eventdev_pmd_vdev.h
rename to lib/librte_eventdev/eventdev_pmd_vdev.h
index 8c64a06743..bc0cf44c8c 100644
--- a/lib/librte_eventdev/rte_eventdev_pmd_vdev.h
+++ b/lib/librte_eventdev/eventdev_pmd_vdev.h
@@ -24,7 +24,7 @@ extern "C" {
 #include <rte_eal.h>
 #include <rte_bus_vdev.h>
 
-#include "rte_eventdev_pmd.h"
+#include "eventdev_pmd.h"
 
 /**
  * @internal
diff --git a/lib/librte_eventdev/meson.build b/lib/librte_eventdev/meson.build
index 0adc2cd2fd..79d36d37bb 100644
--- a/lib/librte_eventdev/meson.build
+++ b/lib/librte_eventdev/meson.build
@@ -15,9 +15,6 @@ sources = files('rte_eventdev.c',
 		'rte_event_crypto_adapter.c',
 		'rte_event_eth_tx_adapter.c')
 headers = files('rte_eventdev.h',
-		'rte_eventdev_pmd.h',
-		'rte_eventdev_pmd_pci.h',
-		'rte_eventdev_pmd_vdev.h',
 		'rte_eventdev_trace.h',
 		'rte_eventdev_trace_fp.h',
 		'rte_event_ring.h',
diff --git a/lib/librte_eventdev/rte_event_crypto_adapter.c b/lib/librte_eventdev/rte_event_crypto_adapter.c
index b04312128a..d903cdd480 100644
--- a/lib/librte_eventdev/rte_event_crypto_adapter.c
+++ b/lib/librte_eventdev/rte_event_crypto_adapter.c
@@ -15,7 +15,7 @@
 #include <rte_service_component.h>
 
 #include "rte_eventdev.h"
-#include "rte_eventdev_pmd.h"
+#include "eventdev_pmd.h"
 #include "rte_eventdev_trace.h"
 #include "rte_event_crypto_adapter.h"
 
diff --git a/lib/librte_eventdev/rte_event_eth_rx_adapter.c b/lib/librte_eventdev/rte_event_eth_rx_adapter.c
index 3c73046551..d8c635e999 100644
--- a/lib/librte_eventdev/rte_event_eth_rx_adapter.c
+++ b/lib/librte_eventdev/rte_event_eth_rx_adapter.c
@@ -19,7 +19,7 @@
 #include <rte_interrupts.h>
 
 #include "rte_eventdev.h"
-#include "rte_eventdev_pmd.h"
+#include "eventdev_pmd.h"
 #include "rte_eventdev_trace.h"
 #include "rte_event_eth_rx_adapter.h"
 
diff --git a/lib/librte_eventdev/rte_event_eth_tx_adapter.c b/lib/librte_eventdev/rte_event_eth_tx_adapter.c
index cc27bbca32..5b4c42dcff 100644
--- a/lib/librte_eventdev/rte_event_eth_tx_adapter.c
+++ b/lib/librte_eventdev/rte_event_eth_tx_adapter.c
@@ -5,7 +5,7 @@
 #include <rte_service_component.h>
 #include <rte_ethdev.h>
 
-#include "rte_eventdev_pmd.h"
+#include "eventdev_pmd.h"
 #include "rte_eventdev_trace.h"
 #include "rte_event_eth_tx_adapter.h"
 
diff --git a/lib/librte_eventdev/rte_event_timer_adapter.c b/lib/librte_eventdev/rte_event_timer_adapter.c
index 4c5e49ea3b..dd7b83087d 100644
--- a/lib/librte_eventdev/rte_event_timer_adapter.c
+++ b/lib/librte_eventdev/rte_event_timer_adapter.c
@@ -21,7 +21,7 @@
 #include <rte_cycles.h>
 
 #include "rte_eventdev.h"
-#include "rte_eventdev_pmd.h"
+#include "eventdev_pmd.h"
 #include "rte_eventdev_trace.h"
 #include "rte_event_timer_adapter.h"
 #include "rte_event_timer_adapter_pmd.h"
diff --git a/lib/librte_eventdev/rte_eventdev.c b/lib/librte_eventdev/rte_eventdev.c
index afbadc535b..b57363f804 100644
--- a/lib/librte_eventdev/rte_eventdev.c
+++ b/lib/librte_eventdev/rte_eventdev.c
@@ -35,7 +35,7 @@
 #include <rte_telemetry.h>
 
 #include "rte_eventdev.h"
-#include "rte_eventdev_pmd.h"
+#include "eventdev_pmd.h"
 #include "rte_eventdev_trace.h"
 
 static struct rte_eventdev rte_event_devices[RTE_EVENT_MAX_DEVS];
-- 
2.27.0



More information about the dev mailing list