ipfixprobe - introduce process FLOW HASH plugin

Author: Pavel Siska

src/plugins/process/CMakeLists.txt

@@ -5,3 +5,4 @@ add_subdirectory(mpls)
 add_subdirectory(ntp)
 add_subdirectory(nettisa)
 add_subdirectory(vlan)
+add_subdirectory(flowHash)

src/plugins/process/flowHash/CMakeLists.txt

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

src/plugins/process/flowHash/README.md

@@ -0,0 +1,61 @@
+/**
+ * @file
+ * @brief Plugin for processing flow_hash value.
+ * @author Jakub Antonín Štigler [email protected]
+ * @author Pavel Siska <[email protected]>
+ * @date 2025
+ *
+ * Copyright (c) 2025 CESNET
+ *
+ * SPDX-License-Identifier: BSD-3-Clause
+ */
+
+#include "flow_hash.hpp"
+
+#include <iostream>
+
+#include <ipfixprobe/pluginFactory/pluginManifest.hpp>
+#include <ipfixprobe/pluginFactory/pluginRegistrar.hpp>
+
+namespace ipxp {
+
+int RecordExtFLOW_HASH::REGISTERED_ID = ProcessPluginIDGenerator::instance().generatePluginID();
+
+static const PluginManifest flowhashPluginManifest = {
+	.name = "flow_hash",
+	.description = "flow_hash process plugin for parsing flow_hash value.",
+	.pluginVersion = "1.0.0",
+	.apiVersion = "1.0.0",
+};
+
+FLOW_HASHPlugin::FLOW_HASHPlugin(const std::string& params)
+{
+	(void) params;
+}
+
+FLOW_HASHPlugin::~FLOW_HASHPlugin() {}
+
+void FLOW_HASHPlugin::init(const char* params) {}
+
+void FLOW_HASHPlugin::close() {}
+
+ProcessPlugin* FLOW_HASHPlugin::copy()
+{
+	return new FLOW_HASHPlugin(*this);
+}
+
+int FLOW_HASHPlugin::post_create(Flow& rec, const Packet& pkt)
+{
+	auto ext = new RecordExtFLOW_HASH();
+
+	ext->flow_hash = rec.flow_hash;
+
+	rec.add_extension(ext);
+
+	return 0;
+}
+
+static const PluginRegistrar<FLOW_HASHPlugin, ProcessPluginFactory>
+	flowhashRegistrar(flowhashPluginManifest);
+
+} // namespace ipxp

src/plugins/process/flowHash/src/flow_hash.cpp

@@ -1,33 +1,16 @@
 /**
- * \file flow_hash.hpp
- * \brief Plugin for parsing flow_hash traffic.
- * \author Jakub Antonín Štigler [email protected]
- * \date 2023
- */
-/*
- * Copyright (C) 2023 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 Plugin for processing flow_hash value.
+ * @author Jakub Antonín Štigler [email protected]
+ * @author Pavel Siska <[email protected]>
+ * @date 2025
  *
+ * Copyright (c) 2025 CESNET
  *
+ * SPDX-License-Identifier: BSD-3-Clause
  */
 
-#ifndef IPXP_PROCESS_FLOW_HASH_HPP
-#define IPXP_PROCESS_FLOW_HASH_HPP
+#pragma once
 
 #include <cstring>
 
@@ -42,7 +25,7 @@
 #include <ipfixprobe/flowifc.hpp>
 #include <ipfixprobe/ipfix-elements.hpp>
 #include <ipfixprobe/packet.hpp>
-#include <ipfixprobe/process.hpp>
+#include <ipfixprobe/processPlugin.hpp>
 
 namespace ipxp {
 
@@ -108,7 +91,7 @@ struct RecordExtFLOW_HASH : public RecordExt {
  */
 class FLOW_HASHPlugin : public ProcessPlugin {
 public:
-	FLOW_HASHPlugin();
+	FLOW_HASHPlugin(const std::string& params);
 	~FLOW_HASHPlugin();
 	void init(const char* params);
 	void close();
@@ -124,4 +107,3 @@ class FLOW_HASHPlugin : public ProcessPlugin {
 };
 
 } // namespace ipxp
-#endif /* IPXP_PROCESS_FLOW_HASH_HPP */