ipfixprobe: register process plugin ID at runtime

Author: Pavel Siska

include/ipfixprobe/processPlugin.hpp

@@ -41,7 +41,11 @@ namespace ipxp {
  */
 class IPXP_API ProcessPlugin : public Plugin {
 public:
-	ProcessPlugin() {}
+	ProcessPlugin(int pluginID)
+		: m_pluginID(pluginID)
+	{
+	}
+
 	virtual ~ProcessPlugin() {}
 	virtual ProcessPlugin* copy() = 0;
 
@@ -102,6 +106,9 @@ class IPXP_API ProcessPlugin : public Plugin {
 	 * \param [in,out] rec Reference to flow record.
 	 */
 	virtual void pre_export(Flow& rec) { (void) rec; }
+
+protected:
+	int m_pluginID;
 };
 
 /**
@@ -167,6 +174,6 @@ class IPXP_API PluginFactory;
  *
  * Provides a factory for creating ProcessPlugin instances using a string-based constructor.
  */
-using ProcessPluginFactory = PluginFactory<ProcessPlugin, const std::string&>;
+using ProcessPluginFactory = PluginFactory<ProcessPlugin, const std::string&, int>;
 
 } // namespace ipxp

src/core/ipfixprobe.cpp

@@ -297,7 +297,9 @@ bool process_plugin_args(ipxp_conf_t& conf, IpfixprobeOptParser& parser)
 
 		try {
 			auto& processPluginFactory = ProcessPluginFactory::getInstance();
-			processPlugin = processPluginFactory.createShared(process_name, process_params);
+			const int pluginID = ProcessPluginIDGenerator::instance().generatePluginID();
+			processPlugin
+				= processPluginFactory.createShared(process_name, process_params, pluginID);
 			if (processPlugin == nullptr) {
 				throw IPXPError("invalid process plugin " + process_name);
 			}

src/plugins/process/basicplus/src/basicplus.cpp

@@ -19,8 +19,6 @@
 
 namespace ipxp {
 
-int RecordExtBASICPLUS::REGISTERED_ID = ProcessPluginIDGenerator::instance().generatePluginID();
-
 static const PluginManifest basicplusPluginManifest = {
 	.name = "basicplus",
 	.description = "Basicplus process plugin for parsing basicplus traffic.",
@@ -29,7 +27,8 @@ static const PluginManifest basicplusPluginManifest = {
 	.usage = nullptr,
 };
 
-BASICPLUSPlugin::BASICPLUSPlugin(const std::string& params)
+BASICPLUSPlugin::BASICPLUSPlugin(const std::string& params, int pluginID)
+	: ProcessPlugin(pluginID)
 {
 	(void) params;
 }
@@ -53,7 +52,7 @@ ProcessPlugin* BASICPLUSPlugin::copy()
 
 int BASICPLUSPlugin::post_create(Flow& rec, const Packet& pkt)
 {
-	RecordExtBASICPLUS* p = new RecordExtBASICPLUS();
+	RecordExtBASICPLUS* p = new RecordExtBASICPLUS(m_pluginID);
 
 	rec.add_extension(p);
 
@@ -71,8 +70,7 @@ int BASICPLUSPlugin::post_create(Flow& rec, const Packet& pkt)
 
 int BASICPLUSPlugin::pre_update(Flow& rec, Packet& pkt)
 {
-	RecordExtBASICPLUS* p
-		= (RecordExtBASICPLUS*) rec.get_extension(RecordExtBASICPLUS::REGISTERED_ID);
+	RecordExtBASICPLUS* p = (RecordExtBASICPLUS*) rec.get_extension(m_pluginID);
 	uint8_t dir = pkt.source_pkt ? 0 : 1;
 
 	if (p->ip_ttl[dir] < pkt.ip_ttl) {

src/plugins/process/basicplus/src/basicplus.hpp

@@ -48,8 +48,6 @@ UR_FIELDS(
  * \brief Flow record extension header for storing parsed BASICPLUS packets.
  */
 struct RecordExtBASICPLUS : public RecordExt {
-	static int REGISTERED_ID;
-
 	uint8_t ip_ttl[2];
 	uint8_t ip_flg[2];
 	uint16_t tcp_win[2];
@@ -59,8 +57,8 @@ struct RecordExtBASICPLUS : public RecordExt {
 
 	bool dst_filled;
 
-	RecordExtBASICPLUS()
-		: RecordExt(REGISTERED_ID)
+	RecordExtBASICPLUS(int pluginID)
+		: RecordExt(pluginID)
 	{
 		ip_ttl[0] = 0;
 		ip_ttl[1] = 0;
@@ -140,7 +138,7 @@ struct RecordExtBASICPLUS : public RecordExt {
  */
 class BASICPLUSPlugin : public ProcessPlugin {
 public:
-	BASICPLUSPlugin(const std::string& params);
+	BASICPLUSPlugin(const std::string& params, int pluginID);
 	~BASICPLUSPlugin();
 	void init(const char* params);
 	void close();
@@ -151,7 +149,7 @@ class BASICPLUSPlugin : public ProcessPlugin {
 			"Extend basic fields with TTL, TCP window, options, MSS and SYN size");
 	}
 	std::string get_name() const { return "basicplus"; }
-	RecordExt* get_ext() const { return new RecordExtBASICPLUS(); }
+	RecordExt* get_ext() const { return new RecordExtBASICPLUS(m_pluginID); }
 	ProcessPlugin* copy();
 
 	int post_create(Flow& rec, const Packet& pkt);

src/plugins/process/bstats/src/bstats.cpp

@@ -19,8 +19,6 @@
 
 namespace ipxp {
 
-int RecordExtBSTATS::REGISTERED_ID = ProcessPluginIDGenerator::instance().generatePluginID();
-
 static const PluginManifest bstatsPluginManifest = {
 	.name = "bstats",
 	.description = "Bstats process plugin for computing packet bursts stats.",
@@ -32,7 +30,8 @@ static const PluginManifest bstatsPluginManifest = {
 const struct timeval BSTATSPlugin::min_packet_in_burst
 	= {MAXIMAL_INTERPKT_TIME / 1000, (MAXIMAL_INTERPKT_TIME % 1000) * 1000};
 
-BSTATSPlugin::BSTATSPlugin(const std::string& params)
+BSTATSPlugin::BSTATSPlugin(const std::string& params, int pluginID)
+	: ProcessPlugin(pluginID)
 {
 	init(params.c_str());
 }
@@ -132,7 +131,7 @@ void BSTATSPlugin::update_record(RecordExtBSTATS* bstats_record, const Packet& p
 
 int BSTATSPlugin::post_create(Flow& rec, const Packet& pkt)
 {
-	RecordExtBSTATS* bstats_record = new RecordExtBSTATS();
+	RecordExtBSTATS* bstats_record = new RecordExtBSTATS(m_pluginID);
 
 	rec.add_extension(bstats_record);
 	update_record(bstats_record, pkt);
@@ -141,8 +140,7 @@ int BSTATSPlugin::post_create(Flow& rec, const Packet& pkt)
 
 int BSTATSPlugin::pre_update(Flow& rec, Packet& pkt)
 {
-	RecordExtBSTATS* bstats_record
-		= static_cast<RecordExtBSTATS*>(rec.get_extension(RecordExtBSTATS::REGISTERED_ID));
+	RecordExtBSTATS* bstats_record = static_cast<RecordExtBSTATS*>(rec.get_extension(m_pluginID));
 
 	update_record(bstats_record, pkt);
 	return 0;
@@ -159,12 +157,11 @@ void BSTATSPlugin::pre_export(Flow& rec)
 {
 	uint32_t packets = rec.src_packets + rec.dst_packets;
 	if (packets <= MINIMAL_PACKETS_IN_BURST) {
-		rec.remove_extension(RecordExtBSTATS::REGISTERED_ID);
+		rec.remove_extension(m_pluginID);
 		return;
 	}
 
-	RecordExtBSTATS* bstats_record
-		= static_cast<RecordExtBSTATS*>(rec.get_extension(RecordExtBSTATS::REGISTERED_ID));
+	RecordExtBSTATS* bstats_record = static_cast<RecordExtBSTATS*>(rec.get_extension(m_pluginID));
 
 	for (int direction = 0; direction < 2; direction++) {
 		if (bstats_record->BCOUNT < BSTATS_MAXELENCOUNT

src/plugins/process/bstats/src/bstats.hpp

@@ -68,8 +68,6 @@ struct RecordExtBSTATS : public RecordExt {
 		DStop = 1057
 	} eHdrFieldID;
 
-	static int REGISTERED_ID;
-
 	uint16_t burst_count[2];
 	uint8_t burst_empty[2];
 
@@ -78,8 +76,8 @@ struct RecordExtBSTATS : public RecordExt {
 	struct timeval brst_start[2][BSTATS_MAXELENCOUNT];
 	struct timeval brst_end[2][BSTATS_MAXELENCOUNT];
 
-	RecordExtBSTATS()
-		: RecordExt(REGISTERED_ID)
+	RecordExtBSTATS(int pluginID)
+		: RecordExt(pluginID)
 	{
 		memset(burst_count, 0, 2 * sizeof(uint16_t));
 		memset(burst_empty, 0, 2 * sizeof(uint8_t));
@@ -243,7 +241,7 @@ struct RecordExtBSTATS : public RecordExt {
  */
 class BSTATSPlugin : public ProcessPlugin {
 public:
-	BSTATSPlugin(const std::string& params);
+	BSTATSPlugin(const std::string& params, int pluginID);
 	~BSTATSPlugin();
 	void init(const char* params);
 	void close();
@@ -252,7 +250,7 @@ class BSTATSPlugin : public ProcessPlugin {
 		return new OptionsParser("bstats", "Compute packet bursts stats");
 	}
 	std::string get_name() const { return "bstats"; }
-	RecordExt* get_ext() const { return new RecordExtBSTATS(); }
+	RecordExt* get_ext() const { return new RecordExtBSTATS(m_pluginID); }
 	ProcessPlugin* copy();
 
 	int pre_create(Packet& pkt);

src/plugins/process/dns/src/dns.cpp

@@ -27,8 +27,6 @@
 
 namespace ipxp {
 
-int RecordExtDNS::REGISTERED_ID = ProcessPluginIDGenerator::instance().generatePluginID();
-
 static const PluginManifest dnsPluginManifest = {
 	.name = "dns",
 	.description = "Dns process plugin for parsing dns traffic.",
@@ -64,8 +62,9 @@ static const PluginManifest dnsPluginManifest = {
  */
 #define GET_OFFSET(half1, half2) ((((uint8_t) (half1) & 0x3F) << 8) | (uint8_t) (half2))
 
-DNSPlugin::DNSPlugin(const std::string& params)
-	: queries(0)
+DNSPlugin::DNSPlugin(const std::string& params, int pluginID)
+	: ProcessPlugin(pluginID)
+	, queries(0)
 	, responses(0)
 	, total(0)
 	, data_begin(nullptr)
@@ -107,7 +106,7 @@ int DNSPlugin::post_create(Flow& rec, const Packet& pkt)
 int DNSPlugin::post_update(Flow& rec, const Packet& pkt)
 {
 	if (pkt.dst_port == 53 || pkt.src_port == 53) {
-		RecordExt* ext = rec.get_extension(RecordExtDNS::REGISTERED_ID);
+		RecordExt* ext = rec.get_extension(m_pluginID);
 		if (ext == nullptr) {
 			return add_ext_dns(
 				reinterpret_cast<const char*>(pkt.payload),
@@ -669,7 +668,7 @@ bool DNSPlugin::parse_dns(const char* data, unsigned int payload_len, bool tcp,
  */
 int DNSPlugin::add_ext_dns(const char* data, unsigned int payload_len, bool tcp, Flow& rec)
 {
-	RecordExtDNS* ext = new RecordExtDNS();
+	RecordExtDNS* ext = new RecordExtDNS(m_pluginID);
 	if (!parse_dns(data, payload_len, tcp, ext)) {
 		delete ext;
 		return 0;

src/plugins/process/dns/src/dns.hpp

@@ -50,8 +50,6 @@ UR_FIELDS(
  * \brief Flow record extension header for storing parsed DNS packets.
  */
 struct RecordExtDNS : public RecordExt {
-	static int REGISTERED_ID;
-
 	uint16_t id;
 	uint16_t answers;
 	uint8_t rcode;
@@ -67,8 +65,8 @@ struct RecordExtDNS : public RecordExt {
 	/**
 	 * \brief Constructor.
 	 */
-	RecordExtDNS()
-		: RecordExt(REGISTERED_ID)
+	RecordExtDNS(int pluginID)
+		: RecordExt(pluginID)
 	{
 		id = 0;
 		answers = 0;
@@ -150,13 +148,13 @@ struct RecordExtDNS : public RecordExt {
  */
 class DNSPlugin : public ProcessPlugin {
 public:
-	DNSPlugin(const std::string& params);
+	DNSPlugin(const std::string& params, int pluginID);
 	~DNSPlugin();
 	void init(const char* params);
 	void close();
 	OptionsParser* get_parser() const { return new OptionsParser("dns", "Parse DNS packets"); }
 	std::string get_name() const { return "dns"; }
-	RecordExt* get_ext() const { return new RecordExtDNS(); }
+	RecordExt* get_ext() const { return new RecordExtDNS(m_pluginID); }
 	ProcessPlugin* copy();
 
 	int post_create(Flow& rec, const Packet& pkt);

src/plugins/process/dnssd/src/dnssd.cpp

@@ -28,8 +28,6 @@
 
 namespace ipxp {
 
-int RecordExtDNSSD::REGISTERED_ID = ProcessPluginIDGenerator::instance().generatePluginID();
-
 static const PluginManifest dnssdPluginManifest = {
 	.name = "dnssd",
 	.description = "Dnssd process plugin for parsing dnssd traffic.",
@@ -70,8 +68,9 @@ static const PluginManifest dnssdPluginManifest = {
  */
 #define GET_OFFSET(half1, half2) ((((uint8_t) (half1) & 0x3F) << 8) | (uint8_t) (half2))
 
-DNSSDPlugin::DNSSDPlugin(const std::string& params)
-	: txt_all_records(false)
+DNSSDPlugin::DNSSDPlugin(const std::string& params, int pluginID)
+	: ProcessPlugin(pluginID)
+	, txt_all_records(false)
 	, queries(0)
 	, responses(0)
 	, total(0)
@@ -124,7 +123,7 @@ int DNSSDPlugin::post_create(Flow& rec, const Packet& pkt)
 int DNSSDPlugin::post_update(Flow& rec, const Packet& pkt)
 {
 	if (pkt.dst_port == 5353 || pkt.src_port == 5353) {
-		RecordExt* ext = rec.get_extension(RecordExtDNSSD::REGISTERED_ID);
+		RecordExt* ext = rec.get_extension(m_pluginID);
 
 		if (ext == nullptr) {
 			return add_ext_dnssd(
@@ -713,7 +712,7 @@ void DNSSDPlugin::filtered_append(
  */
 int DNSSDPlugin::add_ext_dnssd(const char* data, unsigned int payload_len, bool tcp, Flow& rec)
 {
-	RecordExtDNSSD* ext = new RecordExtDNSSD();
+	RecordExtDNSSD* ext = new RecordExtDNSSD(m_pluginID);
 
 	if (!parse_dns(data, payload_len, tcp, ext)) {
 		delete ext;

src/plugins/process/dnssd/src/dnssd.hpp

@@ -87,16 +87,14 @@ struct DnsSdRr {
  * \brief Flow record extension header for storing parsed DNSSD packets.
  */
 struct RecordExtDNSSD : public RecordExt {
-	static int REGISTERED_ID;
-
 	std::list<std::string> queries;
 	std::list<DnsSdRr> responses;
 
 	/**
 	 * \brief Constructor.
 	 */
-	RecordExtDNSSD()
-		: RecordExt(REGISTERED_ID)
+	RecordExtDNSSD(int pluginID)
+		: RecordExt(pluginID)
 	{
 	}
 
@@ -242,13 +240,13 @@ struct RecordExtDNSSD : public RecordExt {
  */
 class DNSSDPlugin : public ProcessPlugin {
 public:
-	DNSSDPlugin(const std::string& params);
+	DNSSDPlugin(const std::string& params, int pluginID);
 	~DNSSDPlugin();
 	void init(const char* params);
 	void close();
 	OptionsParser* get_parser() const { return new DNSSDOptParser(); }
 	std::string get_name() const { return "dnssd"; }
-	RecordExt* get_ext() const { return new RecordExtDNSSD(); }
+	RecordExt* get_ext() const { return new RecordExtDNSSD(m_pluginID); }
 	ProcessPlugin* copy();
 
 	int post_create(Flow& rec, const Packet& pkt);