ipfixprobe - refactor InputPlugin

Author: SiskaPavel

include/ipfixprobe/input.hpp

@@ -0,0 +1,120 @@
+/**
+ * @file
+ * @brief Base class and factory for packet input plugins
+ * @author Pavel Siska <[email protected]>
+ * @date 2025
+ *
+ * This file defines the base class for input plugins, responsible for processing
+ * incoming packets, maintaining statistics, and integrating with the telemetry system.
+ * It also includes a factory template for plugin creation.
+ *
+ * Copyright (c) 2025 CESNET
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+
+#pragma once
+
+#include "api.hpp"
+#include "packet.hpp"
+#include "parser-stats.hpp"
+#include "plugin.hpp"
+#include "telemetry-utils.hpp"
+
+#include <cstdint>
+#include <memory>
+#include <string>
+
+#include <telemetry.hpp>
+
+namespace ipxp {
+
+/**
+ * \brief Base class for packet receivers.
+ *
+ * InputPlugin is an abstract base class for processing network packets.
+ * It provides functionality for handling telemetry directories and maintains
+ * statistics on processed packets.
+ */
+class IPXP_API InputPlugin
+	: public TelemetryUtils
+	, public Plugin {
+public:
+	enum class Result {
+		TIMEOUT = 0,
+		PARSED,
+		NOT_PARSED,
+		END_OF_FILE,
+		ERROR,
+	};
+
+	virtual ~InputPlugin() = default;
+
+	/**
+	 * @brief Retrieves a block of packets.
+	 * @param packets Reference to a PacketBlock to store received packets.
+	 * @return The result of the packet retrieval operation.
+	 */
+	virtual Result get(PacketBlock& packets) = 0;
+
+	/**
+	 * @brief Sets the telemetry directories for this plugin.
+	 * @param plugin_dir Shared pointer to the plugin-specific telemetry directory.
+	 * @param queues_dir Shared pointer to the telemetry directory for queues.
+	 */
+	void set_telemetry_dirs(
+		std::shared_ptr<telemetry::Directory> plugin_dir,
+		std::shared_ptr<telemetry::Directory> queues_dir);
+
+	/// Number of packets seen by the plugin.
+	uint64_t m_seen = 0;
+	/// Number of packets successfully parsed.
+	uint64_t m_parsed = 0;
+	/// Number of packets dropped.
+	uint64_t m_dropped = 0;
+
+protected:
+	/**
+	 * @brief Configures the telemetry directories.
+	 *
+	 * This method can be overridden by derived classes to perform additional
+	 * setup for telemetry directories.
+	 *
+	 * @param plugin_dir Shared pointer to the plugin-specific telemetry directory.
+	 * @param queues_dir Shared pointer to the telemetry directory for queues.
+	 */
+	virtual void configure_telemetry_dirs(
+		std::shared_ptr<telemetry::Directory> plugin_dir,
+		std::shared_ptr<telemetry::Directory> queues_dir)
+	{
+		(void) plugin_dir;
+		(void) queues_dir;
+	};
+
+	/// Statistics related to packet parsing.
+	ParserStats m_parser_stats = {};
+
+private:
+	void create_parser_stats_telemetry(std::shared_ptr<telemetry::Directory> queues_dir);
+};
+
+/**
+ * @brief Factory template for creating plugins.
+ *
+ * This template allows dynamic creation of plugin instances based on the specified
+ * base class and constructor argument types.
+ *
+ * @tparam Base The base class for the plugin.
+ * @tparam Args The argument types required for the plugin constructor.
+ */
+template<typename Base, typename... Args>
+class IPXP_API PluginFactory;
+
+/**
+ * @brief Type alias for the InputPlugin factory.
+ *
+ * Provides a factory for creating InputPlugin instances using a string-based constructor.
+ */
+using InputPluginFactory = PluginFactory<InputPlugin, const std::string&>;
+
+} // namespace ipxp

include/ipfixprobe/inputPlugin.hpp

@@ -13,7 +13,7 @@ add_executable(ipfixprobe
 	utils.cpp
 	workers.cpp
 	workers.hpp
-	input.cpp
+	inputPlugin.cpp
 )
 
 

src/core/CMakeLists.txt

@@ -1,40 +1,22 @@
 /**
- * \file
- * \brief
- * \author Pavel Siska <[email protected]>
- * \date 2024
- */
-/*
- * Copyright (C) 2024 CESNET
+ * @file
+ * @brief Implementation of InputPlugin telemetry integration
+ * @author Pavel Siska <[email protected]>
+ * @date 2025
+ *
+ * This file contains the implementation of telemetry-related functions for
+ * the InputPlugin class. It provides functionality to register parser statistics
+ * in the telemetry system and manage telemetry directories.
  *
- * LICENSE TERMS
+ * Copyright (c) 2025 CESNET
  *
- * 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.
+ * SPDX-License-Identifier: BSD-3-Clause
  */
 
-#include <ipfixprobe/input.hpp>
+#include <ipfixprobe/inputPlugin.hpp>
 
 namespace ipxp {
 
-InputPlugin::InputPlugin()
-	: m_seen(0)
-	, m_parsed(0)
-	, m_dropped(0)
-	, m_parser_stats()
-{
-}
-
 static telemetry::Content get_parser_stats_content(const ParserStats& parserStats)
 {
 	telemetry::Dict dict;

src/core/input.cpp src/core/inputPlugin.cppsrc/core/input.cpp renamed to src/core/inputPlugin.cpp

@@ -40,7 +40,7 @@
 #include <thread>
 
 #include <appFs.hpp>
-#include <ipfixprobe/input.hpp>
+#include <ipfixprobe/inputPlugin.hpp>
 #include <ipfixprobe/options.hpp>
 #include <ipfixprobe/output.hpp>
 #include <ipfixprobe/packet.hpp>

src/core/ipfixprobe.hpp

@@ -34,7 +34,7 @@
 #include <atomic>
 #include <future>
 
-#include <ipfixprobe/input.hpp>
+#include <ipfixprobe/inputPlugin.hpp>
 #include <ipfixprobe/output.hpp>
 #include <ipfixprobe/packet.hpp>
 #include <ipfixprobe/process.hpp>