CTT - refactor CacheOptParser

Author: Zadamsa

storage/cacheOptParser.cpp

@@ -0,0 +1,114 @@
+/**
+* \file
+ * \author Damir Zainullin <[email protected]>
+ * \brief CacheOptParser implementation.
+ */
+/*
+ * 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.
+ */
+
+#include "cacheOptParser.hpp"
+
+#include <cstring>
+#include <ipfixprobe/plugin.hpp>
+#include <ipfixprobe/utils.hpp>
+
+namespace ipxp {
+
+#ifdef IPXP_FLOW_CACHE_SIZE
+static const uint32_t DEFAULT_FLOW_CACHE_SIZE = IPXP_FLOW_CACHE_SIZE;
+#else
+static const uint32_t DEFAULT_FLOW_CACHE_SIZE = 17; // 131072 records total
+#endif /* IPXP_FLOW_CACHE_SIZE */
+
+#ifdef IPXP_FLOW_LINE_SIZE
+static const uint32_t DEFAULT_FLOW_LINE_SIZE = IPXP_FLOW_LINE_SIZE;
+#else
+static const uint32_t DEFAULT_FLOW_LINE_SIZE = 4; // 16 records per line
+#endif /* IPXP_FLOW_LINE_SIZE */
+
+static const uint32_t DEFAULT_INACTIVE_TIMEOUT = 30;
+static const uint32_t DEFAULT_ACTIVE_TIMEOUT = 300;
+
+static_assert(std::is_unsigned<decltype(DEFAULT_FLOW_CACHE_SIZE)>(), "Static checks of default cache sizes won't properly work without unsigned type.");
+static_assert(bitcount<decltype(DEFAULT_FLOW_CACHE_SIZE)>(-1) > DEFAULT_FLOW_CACHE_SIZE, "Flow cache size is too big to fit in variable!");
+static_assert(bitcount<decltype(DEFAULT_FLOW_LINE_SIZE)>(-1) > DEFAULT_FLOW_LINE_SIZE, "Flow cache line size is too big to fit in variable!");
+
+static_assert(DEFAULT_FLOW_LINE_SIZE >= 1, "Flow cache line size must be at least 1!");
+static_assert(DEFAULT_FLOW_CACHE_SIZE >= DEFAULT_FLOW_LINE_SIZE, "Flow cache size must be at least cache line size!");
+
+CacheOptParser::CacheOptParser() : OptionsParser("cache", "Storage plugin implemented as a hash table"),
+      m_cache_size(1 << DEFAULT_FLOW_CACHE_SIZE), m_line_size(1 << DEFAULT_FLOW_LINE_SIZE),
+      m_active(DEFAULT_ACTIVE_TIMEOUT), m_inactive(DEFAULT_INACTIVE_TIMEOUT), m_split_biflow(false),
+      m_enable_fragmentation_cache(true), m_frag_cache_size(10007), // Prime for better distribution in hash table
+      m_frag_cache_timeout(3)
+   {
+      register_option("s", "size", "EXPONENT", "Cache size exponent to the power of two",
+         [this](const char *arg){try {unsigned exp = str2num<decltype(exp)>(arg);
+               if (exp < 4 || exp > 30) {
+                  throw PluginError("Flow cache size must be between 4 and 30");
+               }
+               m_cache_size = static_cast<uint32_t>(1) << exp;
+            } catch(std::invalid_argument &e) {return false;} return true;},
+         OptionFlags::RequiredArgument);
+      register_option("l", "line", "EXPONENT", "Cache line size exponent to the power of two",
+         [this](const char *arg){try {m_line_size = static_cast<uint32_t>(1) << str2num<decltype(m_line_size)>(arg);
+               if (m_line_size < 1) {
+                  throw PluginError("Flow cache line size must be at least 1");
+               }
+            } catch(std::invalid_argument &e) {return false;} return true;},
+         OptionFlags::RequiredArgument);
+      register_option("a", "active", "TIME", "Active timeout in seconds",
+         [this](const char *arg){try {m_active = str2num<decltype(m_active)>(arg);} catch(std::invalid_argument &e) {return false;} return true;},
+         OptionFlags::RequiredArgument);
+      register_option("i", "inactive", "TIME", "Inactive timeout in seconds",
+         [this](const char *arg){try {m_inactive = str2num<decltype(m_inactive)>(arg);} catch(std::invalid_argument &e) {return false;} return true;},
+         OptionFlags::RequiredArgument);
+      register_option("S", "split", "", "Split biflows into uniflows",
+         [this](const char *arg){ m_split_biflow = true; return true;}, OptionFlags::NoArgument);
+      register_option("fe", "frag-enable", "true|false", "Enable/disable fragmentation cache. Enabled (true) by default.",
+         [this](const char *arg){
+            if (strcmp(arg, "true") == 0) {
+               m_enable_fragmentation_cache = true;
+            } else if (strcmp(arg, "false") == 0) {
+               m_enable_fragmentation_cache = false;
+            } else {
+               return false;
+            }
+            return true;
+         }, OptionFlags::RequiredArgument);
+      register_option("fs", "frag-size", "size", "Size of fragmentation cache, must be at least 1. Default value is 10007.", [this](const char *arg) {
+         try {
+            m_frag_cache_size = str2num<decltype(m_frag_cache_size)>(arg);
+         } catch(std::invalid_argument &e) {
+            return false;
+         }
+         return m_frag_cache_size > 0;
+      });
+      register_option("ft", "frag-timeout", "TIME", "Timeout of fragments in fragmentation cache in seconds. Default value is 3.", [this](const char *arg) {
+         try {
+            m_frag_cache_timeout = str2num<decltype(m_frag_cache_timeout)>(arg);
+         } catch(std::invalid_argument &e) {
+            return false;
+         }
+         return true;
+      });
+   }
+
+
+} // ipxp

storage/cacheOptParser.hpp

@@ -0,0 +1,49 @@
+/**
+* \file
+ * \author Damir Zainullin <[email protected]>
+ * \brief Contains the CacheOptParser class for parsing cache options.
+ */
+/*
+ * 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.
+ */
+
+#pragma once
+
+#include <cstdint>
+#include <ipfixprobe/options.hpp>
+#include <config.h>
+
+namespace ipxp {
+
+class CacheOptParser : public OptionsParser
+{
+public:
+   uint32_t m_cache_size;
+   uint32_t m_line_size;
+   uint32_t m_active;
+   uint32_t m_inactive;
+   bool m_split_biflow;
+   bool m_enable_fragmentation_cache;
+   std::size_t m_frag_cache_size;
+   time_t m_frag_cache_timeout;
+
+   CacheOptParser();
+};
+
+
+} // ipxp