Add ConfigManager config options to metadata (#512)

* Add config options to metadata * Use ':' in channel option attribute names * Add test checking saved config options
LLNL · Oct 16, 2023 · 1340071 · 1340071
1 parent 7094755
commit 1340071
Show file tree

Hide file tree

Showing 16 changed files with 61 additions and 0 deletions.
diff --git a/include/caliper/ChannelController.h b/include/caliper/ChannelController.h
@@ -20,6 +20,8 @@ class Channel;
 
 typedef std::map<std::string, std::string> config_map_t;
 
+typedef std::map<std::string, std::string> info_map_t;
+
 /// \class ChannelController
 /// \ingroup ControlChannelAPI
 /// \brief Base class for %Caliper channel controllers
@@ -46,6 +48,9 @@ class ChannelController
     /// the underlying %Caliper channel has been created.
     config_map_t& config();
 
+    /// \brief Provide access to the underlying metadata info map.
+    info_map_t&   metadata();
+
     /// \brief Create the channel with the controller's
     ///   name, flags, and config map
     Channel*      create();

diff --git a/include/caliper/ConfigManager.h b/include/caliper/ConfigManager.h
@@ -109,6 +109,10 @@ class ConfigManager
         /// configuration flags that may be required.
         void update_channel_config(config_map_t& config) const;
 
+        /// \brief Update the config controller's metadata
+        ///    according to the selected options
+        void update_channel_metadata(info_map_t& metadata) const;
+
         /// \brief Returns a CalQL query based on the fields in \a input
         ///   and option list.
         ///

diff --git a/src/caliper/ChannelController.cpp b/src/caliper/ChannelController.cpp
@@ -15,6 +15,7 @@ struct ChannelController::ChannelControllerImpl
     std::string  name;
     int          flags;
     config_map_t config;
+    info_map_t   metadata;
 
     Channel*     channel = nullptr;
 
@@ -32,6 +33,25 @@ struct ChannelController::ChannelControllerImpl
     }
 };
 
+namespace
+{
+
+void add_channel_metadata(Caliper& c, Channel* channel, const info_map_t& metadata)
+{
+    for (const auto &entry : metadata) {
+        std::string key = channel->name();
+        key.append(":");
+        key.append(entry.first);
+
+        auto attr =
+            c.create_attribute(key, CALI_TYPE_STRING, CALI_ATTR_GLOBAL | CALI_ATTR_SKIP_EVENTS);
+
+        c.set(channel, attr, Variant(entry.second.c_str()));
+    }
+}
+
+} // namespace [anonymous]
+
 Channel*
 ChannelController::channel()
 {
@@ -50,6 +70,12 @@ ChannelController::copy_config() const
     return mP->config;
 }
 
+info_map_t&
+ChannelController::metadata()
+{
+    return mP->metadata;
+}
+
 Channel*
 ChannelController::create()
 {
@@ -76,6 +102,8 @@ ChannelController::create()
 
     on_create(&c, mP->channel);
 
+    add_channel_metadata(c, mP->channel, mP->metadata);
+
     //   Reset the object's channel pointer if the channel is destroyed
     // behind our back (e.g., in Caliper::release())
     mP->channel->events().finish_evt.connect([this](Caliper*, Channel*){

diff --git a/src/caliper/ConfigManager.cpp b/src/caliper/ConfigManager.cpp
@@ -50,6 +50,7 @@ ChannelController* make_basic_channel_controller(const char* name, const config_
                 }
 
                 opts.update_channel_config(config());
+                opts.update_channel_metadata(metadata());
             }
     };
 
@@ -510,6 +511,11 @@ struct ConfigManager::Options::OptionsImpl
         append_config(config);
     }
 
+    void
+    update_channel_metadata(info_map_t& info) {
+        info.insert(args.begin(), args.end());
+    }
+
     std::vector< const OptionSpec::query_arg_t* >
     get_enabled_query_args(const char* level) const {
         std::vector< const OptionSpec::query_arg_t* > ret;
@@ -803,6 +809,12 @@ ConfigManager::Options::update_channel_config(config_map_t& config) const
     mP->update_channel_config(config);
 }
 
+void
+ConfigManager::Options::update_channel_metadata(info_map_t& metadata) const
+{
+    mP->update_channel_metadata(metadata);
+}
+
 std::string
 ConfigManager::Options::build_query(const char* level, const std::map<std::string, std::string>& in, bool use_alias) const
 {

diff --git a/src/caliper/controllers/CudaActivityProfileController.cpp b/src/caliper/controllers/CudaActivityProfileController.cpp
@@ -82,6 +82,7 @@ class CudaActivityProfileController : public cali::ChannelController
             }
 
             opts.update_channel_config(config());
+            opts.update_channel_metadata(metadata());
         }
 };
 

diff --git a/src/caliper/controllers/CudaActivityReportController.cpp b/src/caliper/controllers/CudaActivityReportController.cpp
@@ -83,6 +83,7 @@ class CudaActivityReportController : public cali::ChannelController
             }
 
             opts.update_channel_config(config());
+            opts.update_channel_metadata(metadata());
         }
 };
 

diff --git a/src/caliper/controllers/HatchetRegionProfileController.cpp b/src/caliper/controllers/HatchetRegionProfileController.cpp
@@ -79,6 +79,7 @@ class HatchetRegionProfileController : public cali::ChannelController
             }
 
             opts.update_channel_config(config());
+            opts.update_channel_metadata(metadata());
         }
 };
 

diff --git a/src/caliper/controllers/HatchetSampleProfileController.cpp b/src/caliper/controllers/HatchetSampleProfileController.cpp
@@ -94,6 +94,7 @@ class HatchetSampleProfileController : public cali::ChannelController
             }
 
             opts.update_channel_config(config());
+            opts.update_channel_metadata(metadata());
         }
 };
 

diff --git a/src/caliper/controllers/LoopReportController.cpp b/src/caliper/controllers/LoopReportController.cpp
@@ -270,6 +270,7 @@ class LoopReportController : public cali::internal::CustomOutputController
             config()["CALI_LOOP_MONITOR_TARGET_LOOPS" ] = opts.get("target_loops").to_string();
 
         opts.update_channel_config(config());
+        opts.update_channel_metadata(metadata());
     }
 };
 

diff --git a/src/caliper/controllers/OpenMPReportController.cpp b/src/caliper/controllers/OpenMPReportController.cpp
@@ -100,6 +100,7 @@ class OpenMPReportController : public cali::ChannelController
             }
 
             opts.update_channel_config(config());
+            opts.update_channel_metadata(metadata());
         }
 };
 

diff --git a/src/caliper/controllers/ROCmActivityProfileController.cpp b/src/caliper/controllers/ROCmActivityProfileController.cpp
@@ -82,6 +82,7 @@ class RocmActivityProfileController : public cali::ChannelController
             }
 
             opts.update_channel_config(config());
+            opts.update_channel_metadata(metadata());
         }
 };
 

diff --git a/src/caliper/controllers/ROCmActivityReportController.cpp b/src/caliper/controllers/ROCmActivityReportController.cpp
@@ -83,6 +83,7 @@ class RocmActivityReportController : public cali::ChannelController
             }
 
             opts.update_channel_config(config());
+            opts.update_channel_metadata(metadata());
         }
 };
 

diff --git a/src/caliper/controllers/RuntimeReportController.cpp b/src/caliper/controllers/RuntimeReportController.cpp
@@ -86,6 +86,7 @@ class RuntimeReportController : public cali::ChannelController
             }
 
             opts.update_channel_config(config());
+            opts.update_channel_metadata(metadata());
         }
 };
 

diff --git a/src/caliper/controllers/SampleReportController.cpp b/src/caliper/controllers/SampleReportController.cpp
@@ -89,6 +89,7 @@ class SampleReportController : public cali::ChannelController
             }
 
             opts.update_channel_config(config());
+            opts.update_channel_metadata(metadata());
         }
 };
 

diff --git a/src/caliper/controllers/SpotController.cpp b/src/caliper/controllers/SpotController.cpp
@@ -508,6 +508,7 @@ class SpotController : public cali::internal::CustomOutputController
         }
 
         opts.update_channel_config(config());
+        opts.update_channel_metadata(metadata());
     }
 };
 

diff --git a/test/ci_app_tests/test_spot.py b/test/ci_app_tests/test_spot.py
@@ -56,6 +56,7 @@ def test_spot_regionprofile(self):
         self.assertEqual(r['spot.channel'], 'regionprofile')
 
         self.assertEqual('regionprofile', obj['globals']['spot.channels'])
+        self.assertEqual('true', obj['globals']['spot:region.count'])
 
     def test_spot_timeseries(self):
         target_cmd = [ './ci_test_macros', '0', 'spot(output=stdout,timeseries,timeseries.iteration_interval=15)', '75' ]