CMake: add option to build with NEMEA

Author: Pavel Siska

CMakeLists.txt

@@ -22,11 +22,16 @@ option(ENABLE_PROCESS_EXPERIMENTAL "Enable build of experimental process plugins
 option(ENABLE_RPMBUILD "Enable build of RPM package" ON)
 
 option(ENABLE_MILISECONDS_TIMESTAMP "Compile ipfixprobe with miliseconds timestamp precesion" OFF)
+option(ENABLE_NEMEA                 "Enable build of NEMEA plugins" OFF)
 
 if(ENABLE_MILISECONDS_TIMESTAMP)
     add_compile_definitions(IPXP_TS_MSEC)
 endif()
 
+if(ENABLE_NEMEA)
+	add_compile_definitions(WITH_NEMEA)
+endif()
+
 set(CMAKE_C_STANDARD 11)
 set(CMAKE_C_STANDARD_REQUIRED ON)
 set(CMAKE_C_EXTENSIONS ON)

cmake/dependencies.cmake

@@ -19,7 +19,7 @@ if (ENABLE_INPUT_NFB)
 	find_package(NUMA REQUIRED)
 endif()
 
-if (ENABLE_OUTPUT_UNIREC)
+if (ENABLE_OUTPUT_UNIREC OR ENABLE_NEMEA)
 	find_package(LIBTRAP REQUIRED)
 	find_package(UNIREC REQUIRED)
 endif()

include/ipfixprobe/flowifc.hpp

@@ -39,8 +39,6 @@
 #include <sys/time.h>
 
 #ifdef WITH_NEMEA
-#include "fields.h"
-
 #include <unirec/unirec.h>
 #else
 #define UR_FIELDS(...)

src/plugins/CMakeLists.txt

@@ -2,3 +2,36 @@ add_subdirectory(input)
 add_subdirectory(output)
 add_subdirectory(process)
 add_subdirectory(storage)
+
+
+if(ENABLE_NEMEA or ENABLE_OUTPUT_UNIREC)
+    message(STATUS "Running ur_processor script for process plugins")
+
+    set(OUTPUT_DIR ${CMAKE_BINARY_DIR}/src/plugins/nemea-fields/)
+    file(MAKE_DIRECTORY ${OUTPUT_DIR})
+
+    set(GENERATED_SOURCES
+        ${OUTPUT_DIR}/fields.c
+        ${OUTPUT_DIR}/fields.h
+    )
+
+    execute_process(
+        COMMAND /usr/bin/nemea/ur_processor.sh -i ${CMAKE_CURRENT_SOURCE_DIR} -o ${OUTPUT_DIR}
+        WORKING_DIRECTORY ${CMAKE_CURRENT_SOURCE_DIR}
+        RESULT_VARIABLE SCRIPT_RESULT
+    )
+
+    if(NOT SCRIPT_RESULT EQUAL 0)
+        message(FATAL_ERROR "Script ur_processor failed")
+    endif()
+
+    add_custom_target(generate_nemea_files DEPENDS ${GENERATED_SOURCES})
+
+    add_library(ipfixprobe-nemea-fields STATIC
+        ${GENERATED_SOURCES}
+    )
+
+    add_dependencies(ipfixprobe-nemea-fields generate_nemea_files)
+    target_include_directories(ipfixprobe-nemea-fields PUBLIC ${OUTPUT_DIR})
+
+endif()

src/plugins/input/nfb/src/ndp.cpp

@@ -1,30 +1,13 @@
 /**
- * \file ndp.cpp
- * \brief Packet reader using NDP library for high speed capture.
- * \author Tomas Benes <[email protected]>
- * \author Jiri Havranek <[email protected]>
- * \date 2021
- */
-/*
- * Copyright (C) 2020-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 NDP library for high speed capture.
+ * @author Jiri Havranek <[email protected]>
+ * @author Tomas Benes <[email protected]>
+ * @author Pavel Siska <[email protected]>
  *
+ * Copyright (c) 2025 CESNET
  *
+ * SPDX-License-Identifier: BSD-3-Clause
  */
 
 #include "ndp.hpp"
@@ -35,6 +18,9 @@
 #include <cstring>
 #include <iostream>
 
+#include <ipfixprobe/pluginFactory/pluginManifest.hpp>
+#include <ipfixprobe/pluginFactory/pluginRegistrar.hpp>
+
 namespace ipxp {
 
 telemetry::Content NdpPacketReader::get_queue_telemetry()
@@ -45,14 +31,23 @@ telemetry::Content NdpPacketReader::get_queue_telemetry()
 	return dict;
 }
 
-__attribute__((constructor)) static void register_this_plugin()
+static const PluginManifest ndpPluginManifest = {
+	.name = "ndp",
+	.description = "Ndp input plugin for reading packets from network interface or ndp file.",
+	.pluginVersion = "1.0.0",
+	.apiVersion = "1.0.0",
+	.usage =
+		[]() {
+			NdpOptParser parser;
+			parser.usage(std::cout);
+		},
+};
+
+NdpPacketReader::NdpPacketReader(const std::string& params)
 {
-	static PluginRecord rec = PluginRecord("ndp", []() { return new NdpPacketReader(); });
-	register_plugin(&rec);
+	init(params.c_str());
 }
 
-NdpPacketReader::NdpPacketReader() {}
-
 NdpPacketReader::~NdpPacketReader()
 {
 	close();
@@ -134,4 +129,6 @@ void NdpPacketReader::configure_telemetry_dirs(
 	register_file(queues_dir, "input-stats", statsOps);
 }
 
+static const PluginRegistrar<NdpPacketReader, InputPluginFactory> ndpRegistrar(ndpPluginManifest);
+
 } // namespace ipxp

src/plugins/input/nfb/src/ndp.hpp

@@ -1,34 +1,16 @@
 /**
- * \file ndp.hpp
- * \brief Packet reader using NDP library for high speed capture.
- * \author Tomas Benes <[email protected]>
- * \author Jiri Havranek <[email protected]>
- * \date 2021
- */
-/*
- * Copyright (C) 2020-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 NDP library for high speed capture.
+ * @author Jiri Havranek <[email protected]>
+ * @author Tomas Benes <[email protected]>
+ * @author Pavel Siska <[email protected]>
  *
+ * Copyright (c) 2025 CESNET
  *
+ * SPDX-License-Identifier: BSD-3-Clause
  */
 
-#ifndef IPXP_INPUT_NDP_HPP
-#define IPXP_INPUT_NDP_HPP
+#pragma once
 
 #include "ndpReader.hpp"
 
@@ -78,7 +60,7 @@ class NdpOptParser : public OptionsParser {
 
 class NdpPacketReader : public InputPlugin {
 public:
-	NdpPacketReader();
+	NdpPacketReader(const std::string& params);
 	~NdpPacketReader();
 
 	void init(const char* params);
@@ -106,5 +88,3 @@ class NdpPacketReader : public InputPlugin {
 };
 
 } // namespace ipxp
-
-#endif /* IPXP_INPUT_NDP_HPP */

src/plugins/output/unirec/CMakeLists.txt

@@ -15,6 +15,7 @@ target_include_directories(ipfixprobe-output-unirec PRIVATE
 )
 
 target_link_libraries(ipfixprobe-output-unirec PRIVATE
+    -Wl,--whole-archive ipfixprobe-nemea-fields -Wl,--no-whole-archive
     unirec::unirec
 	trap::trap
 )

src/plugins/process/basicplus/CMakeLists.txt

@@ -18,6 +18,13 @@ target_include_directories(ipfixprobe-process-basicplus PRIVATE
     ${CMAKE_SOURCE_DIR}/include/
 )
 
+if(ENABLE_NEMEA)
+    target_link_libraries(ipfixprobe-process-basicplus PRIVATE 
+        -Wl,--whole-archive ipfixprobe-nemea-fields -Wl,--no-whole-archive
+        unirec::unirec
+    )
+endif()
+
 install(TARGETS ipfixprobe-process-basicplus
     LIBRARY DESTINATION "${INSTALL_DIR_LIB}/ipfixprobe/process/"
-)
+)

src/plugins/process/bstats/CMakeLists.txt

@@ -18,6 +18,13 @@ target_link_libraries(ipfixprobe-process-bstats PRIVATE
     ipfixprobe-output-ipfix
 )
 
+if(ENABLE_NEMEA)
+    target_link_libraries(ipfixprobe-process-bstats PRIVATE 
+        -Wl,--whole-archive ipfixprobe-nemea-fields -Wl,--no-whole-archive
+        unirec::unirec
+    )
+endif()
+
 install(TARGETS ipfixprobe-process-bstats
     LIBRARY DESTINATION "${INSTALL_DIR_LIB}/ipfixprobe/process/"
-)
+)

src/plugins/process/dns/CMakeLists.txt

@@ -15,6 +15,13 @@ target_include_directories(ipfixprobe-process-dns PRIVATE
     ${CMAKE_SOURCE_DIR}/src/plugins/process/common
 )
 
+if(ENABLE_NEMEA)
+    target_link_libraries(ipfixprobe-process-dns PRIVATE 
+        -Wl,--whole-archive -Wl,--whole-archive ipfixprobe-nemea-fields -Wl,--no-whole-archive -Wl,--no-whole-archive
+        unirec::unirec
+    )
+endif()
+
 install(TARGETS ipfixprobe-process-dns
     LIBRARY DESTINATION "${INSTALL_DIR_LIB}/ipfixprobe/process/"
-)
+)