ipfixprobe - introduce process PSTATS plugin

Author: Pavel Siska

src/plugins/process/CMakeLists.txt

@@ -9,3 +9,4 @@ add_subdirectory(flowHash)
 add_subdirectory(osquery)
 add_subdirectory(idpContent)
 add_subdirectory(phists)
+add_subdirectory(pstats)

src/plugins/process/pstats/CMakeLists.txt

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

src/plugins/process/pstats/README.md

@@ -1,30 +1,14 @@
 /**
- * \file pstats.cpp
- * \brief Plugin for parsing pstats traffic.
- * \author Tomas Cejka <[email protected]>
- * \author Karel Hynek <[email protected]>
- * \date 2020
- */
-/*
- * Copyright (C) 2020 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 parsing pstats traffic.
+ * @author Tomas Cejka <[email protected]>
+ * @author Karel Hynek <[email protected]>
+ * @author Pavel Siska <[email protected]>
+ * @date 2025
  *
+ * Copyright (c) 2025 CESNET
  *
+ * SPDX-License-Identifier: BSD-3-Clause
  */
 
 #include "pstats.hpp"
@@ -36,16 +20,24 @@
 #include <string>
 #include <vector>
 
+#include <ipfixprobe/pluginFactory/pluginManifest.hpp>
+#include <ipfixprobe/pluginFactory/pluginRegistrar.hpp>
+
 namespace ipxp {
 
-int RecordExtPSTATS::REGISTERED_ID = -1;
+int RecordExtPSTATS::REGISTERED_ID = ProcessPluginIDGenerator::instance().generatePluginID();
 
-__attribute__((constructor)) static void register_this_plugin()
-{
-	static PluginRecord rec = PluginRecord("pstats", []() { return new PSTATSPlugin(); });
-	register_plugin(&rec);
-	RecordExtPSTATS::REGISTERED_ID = register_extension();
-}
+static const PluginManifest pstatsPluginManifest = {
+	.name = "pstats",
+	.description = "Pstats process plugin for computing packet bursts stats.",
+	.pluginVersion = "1.0.0",
+	.apiVersion = "1.0.0",
+	.usage =
+		[]() {
+			PSTATSOptParser parser;
+			parser.usage(std::cout);
+		},
+};
 
 // #define DEBUG_PSTATS
 
@@ -56,10 +48,11 @@ __attribute__((constructor)) static void register_this_plugin()
 #define DEBUG_MSG(format, ...)
 #endif
 
-PSTATSPlugin::PSTATSPlugin()
+PSTATSPlugin::PSTATSPlugin(const std::string& params)
 	: use_zeros(false)
 	, skip_dup_pkts(false)
 {
+	init(params.c_str());
 }
 
 PSTATSPlugin::~PSTATSPlugin()
@@ -177,4 +170,7 @@ int PSTATSPlugin::post_update(Flow& rec, const Packet& pkt)
 	return 0;
 }
 
+static const PluginRegistrar<PSTATSPlugin, ProcessPluginFactory>
+	pstatsRegistrar(pstatsPluginManifest);
+
 } // namespace ipxp

src/plugins/process/pstats.cpp src/plugins/process/pstats/src/pstats.cppsrc/plugins/process/pstats.cpp renamed to src/plugins/process/pstats/src/pstats.cpp

@@ -1,34 +1,17 @@
 /**
- * \file pstats.h
- * \brief Plugin for parsing pstats traffic.
- * \author Tomas Cejka <[email protected]>
- * \author Karel Hynek <[email protected]>
- * \date 2020
- */
-/*
- * Copyright (C) 2020 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 parsing pstats traffic.
+ * @author Tomas Cejka <[email protected]>
+ * @author Karel Hynek <[email protected]>
+ * @author Pavel Siska <[email protected]>
+ * @date 2025
  *
+ * Copyright (c) 2025 CESNET
  *
+ * SPDX-License-Identifier: BSD-3-Clause
  */
 
-#ifndef IPXP_PROCESS_PSTATS_HPP
-#define IPXP_PROCESS_PSTATS_HPP
+#pragma once
 
 #include <cstring>
 #include <sstream>
@@ -44,7 +27,7 @@
 #include <ipfixprobe/ipfix-elements.hpp>
 #include <ipfixprobe/options.hpp>
 #include <ipfixprobe/packet.hpp>
-#include <ipfixprobe/process.hpp>
+#include <ipfixprobe/processPlugin.hpp>
 
 namespace ipxp {
 
@@ -230,7 +213,7 @@ struct RecordExtPSTATS : public RecordExt {
  */
 class PSTATSPlugin : public ProcessPlugin {
 public:
-	PSTATSPlugin();
+	PSTATSPlugin(const std::string& params);
 	~PSTATSPlugin();
 	void init(const char* params);
 	void close();
@@ -249,4 +232,3 @@ class PSTATSPlugin : public ProcessPlugin {
 };
 
 } // namespace ipxp
-#endif /* IPXP_PROCESS_PSTATS_HPP */