module: add support for update-interval

Problem: Fluxion `find` search times are large for large resources
graphs. To serve many users effectively, the resource status RPC
response needs to return quickly. To return resource allocation status
quickly, we will need a cache that is updated after a configured
interval of seconds.

Add support for `update-interval` configuration option for the resource
module.

Author: milroy

resource/modules/resource_match_opts.cpp

@@ -70,6 +70,11 @@ const std::string &resource_prop_t::get_prune_filters () const
     return m_prune_filters;
 }
 
+const int resource_prop_t::get_update_interval () const
+{
+    return m_update_interval;
+}
+
 void resource_prop_t::set_load_file (const std::string &p)
 {
     m_load_file = p;
@@ -125,6 +130,11 @@ void resource_prop_t::add_to_prune_filters (const std::string &p)
     m_prune_filters += p;
 }
 
+void resource_prop_t::set_update_interval (const int i)
+{
+    m_update_interval = i;
+}
+
 bool resource_prop_t::is_load_file_set () const
 {
     return m_load_file != RESOURCE_OPTS_UNSET_STR;
@@ -165,9 +175,14 @@ bool resource_prop_t::is_prune_filters_set () const
     return m_prune_filters != RESOURCE_OPTS_UNSET_STR;
 }
 
+bool resource_prop_t::is_update_interval_set () const
+{
+    return m_update_interval != 0;
+}
+
 json_t *resource_prop_t::jsonify () const
 {
-    return json_pack ("{ s:s? s:s? s:s? s:s? s:s? s:s? s:i s:s? }",
+    return json_pack ("{ s:s? s:s? s:s? s:s? s:s? s:s? s:i s:s? s:i }",
                           "load-file", is_load_file_set ()
                               ? get_load_file ().c_str ()
                               : nullptr,
@@ -191,7 +206,10 @@ json_t *resource_prop_t::jsonify () const
                               : 0,
                           "prune-filters", is_prune_filters_set ()
                               ? get_prune_filters ().c_str ()
-                              : nullptr);
+                              : nullptr,
+                          "update-interval", is_update_interval_set ()
+                              ? get_update_interval ()
+                              : 0);
 }
 
 
@@ -280,6 +298,12 @@ resource_opts_t::resource_opts_t ()
                                     ::resource_opts_key_t
                                         ::PRUNE_FILTERS)));
     inserted &= ret.second;
+    ret= m_tab.insert (std::pair<std::string, int> (
+              "update-interval",
+              static_cast<int> (resource_opts_t
+                                    ::resource_opts_key_t
+                                        ::UPDATE_INTERVAL)));
+    inserted &= ret.second;
 
     if (!inserted)
         throw std::bad_alloc ();
@@ -325,6 +349,11 @@ const std::string &resource_opts_t::get_prune_filters () const
     return m_resource_prop.get_prune_filters ();
 }
 
+const int resource_opts_t::get_update_interval () const
+{
+    return m_resource_prop.get_update_interval ();
+}
+
 const resource_prop_t &resource_opts_t::get_resource_prop () const
 {
     return m_resource_prop;
@@ -370,6 +399,11 @@ void resource_opts_t::set_prune_filters (const std::string &o)
     m_resource_prop.set_prune_filters (o);
 }
 
+void resource_opts_t::set_update_interval (const int i)
+{
+    m_resource_prop.set_update_interval (i);
+}
+
 bool resource_opts_t::is_load_file_set () const
 {
     return m_resource_prop.is_load_file_set ();
@@ -410,6 +444,11 @@ bool resource_opts_t::is_prune_filters_set () const
     return m_resource_prop.is_prune_filters_set ();
 }
 
+bool resource_opts_t::is_update_interval_set () const
+{
+    return m_resource_prop.is_update_interval_set ();
+}
+
 resource_opts_t &resource_opts_t::canonicalize ()
 {
     return *this;
@@ -441,6 +480,9 @@ resource_opts_t &resource_opts_t::operator+= (const resource_opts_t &src)
     if (src.m_resource_prop.is_prune_filters_set ())
         m_resource_prop.set_prune_filters (
             src.m_resource_prop.get_prune_filters ());
+    if (src.m_resource_prop.is_update_interval_set ())
+        m_resource_prop.set_update_interval (
+            src.m_resource_prop.get_update_interval ());
     return *this;
 }
 
@@ -543,6 +585,15 @@ int resource_opts_t::parse (const std::string &k,
         }
         break;
 
+    case static_cast<int> (resource_opts_key_t::UPDATE_INTERVAL):
+        if (is_number (v)) {
+            int s = std::stoi (v);
+            if ( !(s <= 0 || s > 2000000)) {
+                m_resource_prop.set_update_interval (s);
+            }
+        }
+        break;
+
     default:
         info += "Unknown option (" + k + ").";
         errno = EINVAL;

resource/modules/resource_match_opts.hpp

@@ -35,6 +35,7 @@ class resource_prop_t {
     const int get_reserve_vtx_vec () const;
     const std::string &get_prune_filters () const;
     const resource_prop_t &get_resource_prop () const;
+    const int get_update_interval () const;
 
     void set_load_file (const std::string &o);
     bool set_load_format (const std::string &o);
@@ -45,6 +46,7 @@ class resource_prop_t {
     void set_reserve_vtx_vec (const int i);
     void set_prune_filters (const std::string &o);
     void add_to_prune_filters (const std::string &o);
+    void set_update_interval (const int i);
 
     bool is_load_file_set () const;
     bool is_load_format_set () const;
@@ -54,6 +56,7 @@ class resource_prop_t {
     bool is_match_subsystems_set () const;
     bool is_reserve_vtx_vec_set () const;
     bool is_prune_filters_set () const;
+    bool is_update_interval_set () const;
 
     json_t *jsonify () const;
 
@@ -66,6 +69,7 @@ class resource_prop_t {
     std::string m_match_subsystems = RESOURCE_OPTS_UNSET_STR;
     int m_reserve_vtx_vec = 0;
     std::string m_prune_filters = RESOURCE_OPTS_UNSET_STR;
+    int m_update_interval = 0;
 };
 
 
@@ -82,6 +86,7 @@ class resource_opts_t : public optmgr_parse_t {
         MATCH_SUBSYSTEMS          = 50, // subsystem
         RESERVE_VTX_VEC           = 60, // reserve-vtx-vec
         PRUNE_FILTERS             = 70, // prune-filter
+        UPDATE_INTERVAL           = 80, // update-interval
         UNKNOWN                   = 5000
     };
 
@@ -102,6 +107,7 @@ class resource_opts_t : public optmgr_parse_t {
     const int get_reserve_vtx_vec () const;
     const std::string &get_prune_filters () const;
     const resource_prop_t &get_resource_prop () const;
+    const int get_update_interval () const;
 
     void set_load_file (const std::string &o);
     bool set_load_format (const std::string &o);
@@ -111,6 +117,7 @@ class resource_opts_t : public optmgr_parse_t {
     void set_match_subsystems (const std::string &o);
     void set_reserve_vtx_vec (const int i);
     void set_prune_filters (const std::string &o);
+    void set_update_interval (const int i);
 
     bool is_load_file_set () const;
     bool is_load_format_set () const;
@@ -120,6 +127,7 @@ class resource_opts_t : public optmgr_parse_t {
     bool is_match_subsystems_set () const;
     bool is_reserve_vtx_vec_set () const;
     bool is_prune_filters_set () const;
+    bool is_update_interval_set () const;
 
     /*! Canonicalize the option set -- apply the general resource properties
      */