ipfixprobe - introduce input DPDK plugin

Author: Pavel Siska

CMakeLists.txt

@@ -12,6 +12,8 @@ include(cmake/installation.cmake)
 
 set(CMAKE_MODULE_PATH ${CMAKE_SOURCE_DIR}/cmake/modules)
 
+option(ENABLE_INPUT_DPDK "Enable build of input DPDK plugin" ON)
+
 set(CMAKE_C_STANDARD 11)
 set(CMAKE_C_STANDARD_REQUIRED ON)
 set(CMAKE_C_EXTENSIONS ON)

cmake/dependencies.cmake

@@ -4,3 +4,7 @@ find_package(PkgConfig REQUIRED)
 find_package(Threads REQUIRED)
 find_package(Atomic REQUIRED)
 find_package(Unwind REQUIRED)
+
+if (ENABLE_INPUT_DPDK)
+	pkg_check_modules(DPDK REQUIRED libdpdk)
+endif()

src/plugins/input/CMakeLists.txt

@@ -1,3 +1,4 @@
 add_subdirectory(parser)
 add_subdirectory(pcap)
 add_subdirectory(raw)
+add_subdirectory(dpdk)

src/plugins/input/dpdk/CMakeLists.txt

@@ -0,0 +1,38 @@
+project(ipfixprobe-input-dpdk VERSION 1.0.0 DESCRIPTION "ipfixprobe-input-dpdk plugin")
+
+add_library(ipfixprobe-input-dpdk MODULE
+    src/dpdk.cpp
+    src/dpdkDevice.cpp
+    src/dpdkDevice.hpp
+    src/dpdk.hpp
+    src/dpdkMbuf.cpp
+    src/dpdkMbuf.hpp
+    src/dpdkPortTelemetry.cpp
+    src/dpdkPortTelemetry.hpp
+    src/dpdkTelemetry.cpp
+    src/dpdkTelemetry.hpp
+    src/dpdk-ring.cpp
+    src/dpdk-ring.hpp
+)
+
+set_target_properties(ipfixprobe-input-dpdk PROPERTIES
+    CXX_VISIBILITY_PRESET hidden
+    VISIBILITY_INLINES_HIDDEN YES
+)
+
+target_include_directories(ipfixprobe-input-dpdk PRIVATE 
+	${DPDK_INCLUDE_DIRS}
+	${CMAKE_SOURCE_DIR}/include/
+	${CMAKE_SOURCE_DIR}/src/plugins/input/parser
+)
+
+target_compile_options(ipfixprobe-input-dpdk PRIVATE ${DPDK_CFLAGS_OTHER})
+
+target_link_libraries(ipfixprobe-input-dpdk PRIVATE
+	ipfixprobe-parser
+	${DPDK_LIBRARIES}
+)
+
+install(TARGETS ipfixprobe-input-dpdk
+    LIBRARY DESTINATION "${INSTALL_DIR_LIB}/ipfixprobe/input/"
+)

src/plugins/input/dpdk/README.md

@@ -1,47 +1,42 @@
 /**
- * \file dpdk-ring.cpp
- * \brief DPDK ring input interface for ipfixprobe (secondary DPDK app).
- * \author Jaroslav Pesek <[email protected]>
- * \date 2023
- */
-/*
- * Copyright (C) 2023 CESNET
- *
- * LICENSE TERMS
+ * @file
+ * @brief DPDK ring input interface for ipfixprobe (secondary DPDK app).
+ * @author Pavel Siska <[email protected]>
+ * @author Jaroslav Pesek <[email protected]>
+ * @date 2025
  *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- * 1. Redistributions of source code must retain the above copyright
- *    notice, this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- *    notice, this list of conditions and the following disclaimer in
- *    the documentation and/or other materials provided with the
- *    distribution.
- * 3. Neither the name of the Company nor the names of its contributors
- *    may be used to endorse or promote products derived from this
- *    software without specific prior written permission.
+ * Copyright (c) 2025 CESNET
  *
+ * SPDX-License-Identifier: BSD-3-Clause
  */
-#include "dpdk-ring.h"
 
+#include "dpdk-ring.hpp"
 #include "parser.hpp"
 
 #include <cstring>
 #include <mutex>
 
+#include <ipfixprobe/pluginFactory/pluginManifest.hpp>
+#include <ipfixprobe/pluginFactory/pluginRegistrar.hpp>
 #include <rte_eal.h>
 #include <rte_errno.h>
 #include <rte_ethdev.h>
 #include <rte_version.h>
 #include <unistd.h>
 
 namespace ipxp {
-__attribute__((constructor)) static void register_this_plugin()
-{
-	static PluginRecord rec = PluginRecord("dpdk-ring", []() { return new DpdkRingReader(); });
-	register_plugin(&rec);
-}
+
+static const PluginManifest dpdkRingPluginManifest = {
+	.name = "dpdk-ring",
+	.description = "Input plugin for reading packets using DPDK ring.",
+	.pluginVersion = "1.0.0",
+	.apiVersion = "1.0.0",
+	.usage =
+		[]() {
+			DpdkRingOptParser parser;
+			parser.usage(std::cout);
+		},
+};
 
 DpdkRingCore* DpdkRingCore::m_instance = nullptr;
 
@@ -108,10 +103,11 @@ void DpdkRingCore::configureEal(const std::string& ealParams)
 	}
 }
 
-DpdkRingReader::DpdkRingReader()
+DpdkRingReader::DpdkRingReader(const std::string& params)
 	: m_dpdkRingCore(DpdkRingCore::getInstance())
 {
 	pkts_read_ = 0;
+	init(params.c_str());
 }
 
 DpdkRingReader::~DpdkRingReader()
@@ -270,4 +266,7 @@ void DpdkRingReader::prefetchPackets()
 	}
 }
 
+static const PluginRegistrar<DpdkRingReader, InputPluginFactory>
+	dpdkRingRegistrar(dpdkRingPluginManifest);
+
 } // namespace ipxp

src/plugins/input/dpdk-ring.cpp src/plugins/input/dpdk/src/dpdk-ring.cppsrc/plugins/input/dpdk-ring.cpp renamed to src/plugins/input/dpdk/src/dpdk-ring.cpp

@@ -1,42 +1,27 @@
 /**
- * \file dpdk-ring.h
- * \brief DPDK ring input interface for ipfixprobe (secondary DPDK app).
- * \author Jaroslav Pesek <[email protected]>
- * \date 2023
- */
-/*
- * Copyright (C) 2023 CESNET
- *
- * LICENSE TERMS
+ * @file
+ * @brief DPDK ring input interface for ipfixprobe (secondary DPDK app).
+ * @author Pavel Siska <[email protected]>
+ * @author Jaroslav Pesek <[email protected]>
+ * @date 2025
  *
- * Redistribution and use in source and binary forms, with or without
- * modification, are permitted provided that the following conditions
- * are met:
- * 1. Redistributions of source code must retain the above copyright
- *    notice, this list of conditions and the following disclaimer.
- * 2. Redistributions in binary form must reproduce the above copyright
- *    notice, this list of conditions and the following disclaimer in
- *    the documentation and/or other materials provided with the
- *    distribution.
- * 3. Neither the name of the Company nor the names of its contributors
- *    may be used to endorse or promote products derived from this
- *    software without specific prior written permission.
+ * Copyright (c) 2025 CESNET
  *
+ * SPDX-License-Identifier: BSD-3-Clause
  */
-#ifdef WITH_DPDK
 
-#ifndef IPXP_DPDK_RING_READER_H
-#define IPXP_DPDK_RING_READER_H
+#pragma once
 
 #include <memory>
 #include <sstream>
 
-#include <ipfixprobe/input.hpp>
+#include <ipfixprobe/inputPlugin.hpp>
 #include <ipfixprobe/utils.hpp>
 #include <rte_mbuf.h>
 #include <rte_ring.h>
 
 namespace ipxp {
+
 class DpdkRingOptParser : public OptionsParser {
 private:
 	static constexpr size_t DEFAULT_MBUF_BURST_SIZE = 64;
@@ -48,8 +33,8 @@ class DpdkRingOptParser : public OptionsParser {
 public:
 	DpdkRingOptParser()
 		: OptionsParser(
-			"dpdk-ring",
-			"DPDK ring input interface for ipfixprobe (secondary DPDK app).")
+			  "dpdk-ring",
+			  "DPDK ring input interface for ipfixprobe (secondary DPDK app).")
 		, pkt_buffer_size_(DEFAULT_MBUF_BURST_SIZE)
 	{
 		register_option(
@@ -131,7 +116,7 @@ class DpdkRingReader : public InputPlugin {
 	std::string get_name() const override { return "dpdk-ring"; }
 
 	~DpdkRingReader();
-	DpdkRingReader();
+	DpdkRingReader(const std::string& params);
 
 	void configure_telemetry_dirs(
 		std::shared_ptr<telemetry::Directory> plugin_dir,
@@ -175,7 +160,5 @@ class DpdkRingReader : public InputPlugin {
 	bool m_nfbMetadataEnabled = false;
 	NfbMetadataDynfieldInfo m_nfbMetadataDynfieldInfo = {};
 };
-} // namespace ipxp
 
-#endif // IPXP_DPDK_RING_READER_H
-#endif
+} // namespace ipxp