ipfixprobe - introduce input RAW plugin

Author: SiskaPavel

src/plugins/input/CMakeLists.txt

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

src/plugins/input/raw/CMakeLists.txt

@@ -0,0 +1,23 @@
+project(ipfixprobe-input-raw VERSION 1.0.0 DESCRIPTION "ipfixprobe-input-raw plugin")
+
+add_library(ipfixprobe-input-raw MODULE
+    src/raw.cpp
+    src/raw.hpp
+)
+
+set_target_properties(ipfixprobe-input-raw PROPERTIES
+    CXX_VISIBILITY_PRESET hidden
+    VISIBILITY_INLINES_HIDDEN YES
+)
+
+target_include_directories(ipfixprobe-input-raw PRIVATE
+	${CMAKE_SOURCE_DIR}/include/
+	${CMAKE_SOURCE_DIR}/src/plugins/input/parser
+)
+
+target_link_libraries(ipfixprobe-input-raw PRIVATE ipfixprobe-parser)
+
+install(
+    TARGETS ipfixprobe-input-raw
+    LIBRARY DESTINATION "${INSTALL_DIR_LIB}/ipfixprobe/input/"
+)

src/plugins/input/raw/README.md

@@ -1,35 +1,19 @@
 /**
- * \file raw.cpp
- * \brief Packet reader using raw sockets.
- *    More info at https://www.kernel.org/doc/html/latest/networking/packet_mmap.html
- * \author Jiri Havranek <[email protected]>
- * \date 2021
- */
-/*
- * Copyright (C) 2021 CESNET
- *
- * LICENSE TERMS
- *
- * 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.
+ * @file
+ * @brief Packet reader using raw sockets
+ * @author Jiri Havranek <[email protected]>
+ * @author Pavel Siska <[email protected]>
+ * @date 2025
  *
+ * https://www.kernel.org/doc/html/latest/networking/packet_mmap.html
  *
+ * Copyright (c) 2025 CESNET
  *
+ * SPDX-License-Identifier: BSD-3-Clause
  */
 
-#include "raw.hpp"
-
 #include "parser.hpp"
+#include "raw.hpp"
 
 #include <cstdlib>
 #include <cstring>
@@ -38,10 +22,10 @@
 
 #include <arpa/inet.h>
 #include <ifaddrs.h>
-#include <linux/if_packet.h>
+#include <ipfixprobe/pluginFactory/pluginManifest.hpp>
+#include <ipfixprobe/pluginFactory/pluginRegistrar.hpp>
 #include <net/ethernet.h>
 #include <net/if.h>
-#include <poll.h>
 #include <sys/ioctl.h>
 #include <sys/mman.h>
 #include <sys/socket.h>
@@ -57,13 +41,19 @@ namespace ipxp {
 // Read only 1 packet into packet block
 constexpr size_t RAW_PACKET_BLOCK_SIZE = 1;
 
-__attribute__((constructor)) static void register_this_plugin()
-{
-	static PluginRecord rec = PluginRecord("raw", []() { return new RawReader(); });
-	register_plugin(&rec);
-}
-
-RawReader::RawReader()
+static const PluginManifest rawPluginManifest = {
+	.name = "raw",
+	.description = "Raw input plugin for reading packets from a raw socket.",
+	.pluginVersion = "1.0.0",
+	.apiVersion = "1.0.0",
+	.usage =
+		[]() {
+			RawOptParser parser;
+			parser.usage(std::cout);
+		},
+};
+
+RawReader::RawReader(const std::string& params)
 	: m_sock(-1)
 	, m_fanout(0)
 	, m_rd(nullptr)
@@ -78,6 +68,7 @@ RawReader::RawReader()
 	, m_pbd(nullptr)
 	, m_pkts_left(0)
 {
+	init(params.c_str());
 }
 
 RawReader::~RawReader()
@@ -383,4 +374,6 @@ InputPlugin::Result RawReader::get(PacketBlock& packets)
 	return packets.cnt ? Result::PARSED : Result::NOT_PARSED;
 }
 
+static const PluginRegistrar<RawReader, InputPluginFactory> rawRegistrar(rawPluginManifest);
+
 } // namespace ipxp

src/plugins/input/raw.cpp src/plugins/input/raw/src/raw.cppsrc/plugins/input/raw.cpp renamed to src/plugins/input/raw/src/raw.cpp

@@ -1,38 +1,27 @@
 /**
- * \file raw.hpp
- * \brief Packet reader using raw sockets
- * \author Jiri Havranek <[email protected]>
- * \date 2021
- */
-/*
- * Copyright (C) 2021 CESNET
- *
- * LICENSE TERMS
- *
- * 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.
- *
+ * @file
+ * @brief Packet reader using raw sockets
+ * @author Jiri Havranek <[email protected]>
+ * @author Pavel Siska <[email protected]>
+ * @date 2025
  *
+ * Copyright (c) 2025 CESNET
  *
+ * SPDX-License-Identifier: BSD-3-Clause
  */
 
-#ifndef IPXP_INPUT_RAW_HPP
-#define IPXP_INPUT_RAW_HPP
+#pragma once
+
+#include <cstdint>
+#include <exception>
+#include <string>
 
-#include <ipfixprobe/input.hpp>
+#include <ipfixprobe/inputPlugin.hpp>
 #include <ipfixprobe/options.hpp>
 #include <ipfixprobe/packet.hpp>
 #include <ipfixprobe/utils.hpp>
+#include <linux/if_packet.h>
+#include <poll.h>
 
 namespace ipxp {
 
@@ -126,7 +115,7 @@ class RawOptParser : public OptionsParser {
 
 class RawReader : public InputPlugin {
 public:
-	RawReader();
+	RawReader(const std::string& params);
 	~RawReader();
 	void init(const char* params);
 	void close();
@@ -163,4 +152,3 @@ class RawReader : public InputPlugin {
 void packet_handler(u_char* arg, const struct pcap_pkthdr* h, const u_char* data);
 
 } // namespace ipxp
-#endif /* IPXP_INPUT_RAW_HPP */