Use JSON specs to describe services (LLNL#436)

* Start simplifying RuntimeConfig

* Implement service JSON specs

* Move more services to new spec format

* Small fixes

* Convert CUDA services to new JSON spec

* Convert roctracer service to JSON spec

* Rename timestamp -> timer

* Use new JSON spec in mpi service

Author: daboehme

include/caliper/CaliperService.h

@@ -19,8 +19,10 @@ typedef void (*ServiceRegisterFn)(Caliper* c, Channel* chn);
 /// To register services, provide a list of CaliperService entries
 /// to Caliper::add_services() _before_ %Caliper is initialized.
 struct CaliperService {
-    const char*       name;        ///< Service name (short, no spaces).
-    ServiceRegisterFn register_fn; ///< Registration function.
+    /// \brief Name (old style) or JSON spec (new) of the service
+    const char*       name_or_spec;
+    /// \brief Registration function
+    ServiceRegisterFn register_fn;
 };
 
 } // namespace cali

include/caliper/common/RuntimeConfig.h

@@ -20,7 +20,7 @@ namespace cali
 
 struct ConfigSetImpl;
 
-class ConfigSet 
+class ConfigSet
 {
     std::shared_ptr<ConfigSetImpl> mP;
 
@@ -52,17 +52,22 @@ class RuntimeConfig
     struct RuntimeConfigImpl;
 
     std::shared_ptr<RuntimeConfigImpl> mP;
-    
+
 public:
 
+    typedef std::vector< std::pair<std::string, std::string > > config_entry_list_t;
+
     RuntimeConfig();
 
     /// \brief Get config entry with given \a key from given \a set
     StringConverter get(const char* set, const char* key);
 
-    /// \brief Initialize a ConfigSet.
+    /// \brief Initialize a ConfigSet from ConfigSet::Entry list (old method)
     ConfigSet       init(const char* name, const ConfigSet::Entry* set);
 
+    /// \brief Initialize a ConfigSet
+    ConfigSet       init(const char* name, const config_entry_list_t&);
+
     /// \brief Pre-set config entry \a key to \a value.
     ///
     /// The value may be overwritten by configuration files or environment
@@ -77,7 +82,7 @@ class RuntimeConfig
 
     /// \brief Import config values from the given the \a values map
     void            import(const std::map<std::string, std::string>& values);
-    
+
     bool            allow_read_env();
 
     /// \brief Enable or disable reading of configuration settings
@@ -103,7 +108,7 @@ class RuntimeConfig
     // --- Static API (temporary)
     //
 
-    static RuntimeConfig  get_default_config(); 
+    static RuntimeConfig  get_default_config();
 
 }; // class RuntimeConfig
 

src/caliper/controllers/HatchetRegionProfileController.cpp

@@ -116,7 +116,7 @@ const char* controller_spec =
     " \"name\"        : \"hatchet-region-profile\","
     " \"description\" : \"Record a region time profile for processing with hatchet\","
     " \"categories\"  : [ \"adiak\", \"metric\", \"output\", \"region\", \"event\" ],"
-    " \"services\"    : [ \"aggregate\", \"event\", \"timestamp\" ],"
+    " \"services\"    : [ \"aggregate\", \"event\", \"timer\" ],"
     " \"config\"      : "
     "   { \"CALI_CHANNEL_FLUSH_ON_EXIT\"      : \"false\","
     "     \"CALI_EVENT_ENABLE_SNAPSHOT_INFO\" : \"false\","

src/caliper/controllers/LoopReportController.cpp

@@ -278,7 +278,7 @@ const char* loop_report_controller_spec =
     " \"name\"        : \"loop-report\","
     " \"description\" : \"Print summary and time-series information for loops\","
     " \"categories\"  : [ \"metric\", \"output\" ],"
-    " \"services\"    : [ \"loop_monitor\", \"timestamp\", \"trace\" ],"
+    " \"services\"    : [ \"loop_monitor\", \"timer\", \"trace\" ],"
     " \"config\"      : "
     "   { \"CALI_CHANNEL_FLUSH_ON_EXIT\"      : \"false\","
     "     \"CALI_CHANNEL_CONFIG_CHECK\"       : \"false\","

src/caliper/controllers/ROCmActivityProfileController.cpp

@@ -121,7 +121,7 @@ const char* controller_spec = R"json(
      "name"        : "rocm-activity-profile",
      "description" : "Record AMD ROCm activities and a write profile",
      "categories"  : [ "adiak", "metric", "output", "region", "event" ],
-     "services"    : [ "aggregate", "roctracer", "event", "timestamp" ],
+     "services"    : [ "aggregate", "roctracer", "event", "timer" ],
      "config"      :
        { "CALI_CHANNEL_FLUSH_ON_EXIT"        : "false",
          "CALI_EVENT_ENABLE_SNAPSHOT_INFO"   : "false",

src/caliper/controllers/ROCmActivityReportController.cpp

@@ -120,7 +120,7 @@ const char* controller_spec = R"json(
      "name"        : "rocm-activity-report",
      "description" : "Record and print AMD ROCm activities (kernel executions, memcopies, etc.)",
      "categories"  : [ "output", "region", "treeformatter", "event" ],
-     "services"    : [ "aggregate", "roctracer", "event", "timestamp" ],
+     "services"    : [ "aggregate", "roctracer", "event", "timer" ],
      "config"      :
        { "CALI_CHANNEL_FLUSH_ON_EXIT"       : "false",
          "CALI_EVENT_ENABLE_SNAPSHOT_INFO"  : "false",

src/caliper/controllers/RuntimeReportController.cpp

@@ -119,7 +119,7 @@ const char* runtime_report_spec =
     " \"name\"        : \"runtime-report\","
     " \"description\" : \"Print a time profile for annotated regions\","
     " \"categories\"  : [ \"metric\", \"output\", \"region\", \"treeformatter\", \"event\" ],"
-    " \"services\"    : [ \"aggregate\", \"event\", \"timestamp\" ],"
+    " \"services\"    : [ \"aggregate\", \"event\", \"timer\" ],"
     " \"config\"      : "
     "   { \"CALI_CHANNEL_FLUSH_ON_EXIT\"      : \"false\","
     "     \"CALI_EVENT_ENABLE_SNAPSHOT_INFO\" : \"false\","

src/caliper/controllers/SpotController.cpp

@@ -214,7 +214,7 @@ const char* spot_timeseries_spec =
     " \"name\"        : \"spot.timeseries\","
     " \"description\" : \"Collect time-series information for loops\","
     " \"categories\"  : [ \"metric\" ],"
-    " \"services\"    : [ \"loop_monitor\", \"timestamp\", \"trace\" ],"
+    " \"services\"    : [ \"loop_monitor\", \"timer\", \"trace\" ],"
     " \"config\"      : "
     "   { \"CALI_CHANNEL_FLUSH_ON_EXIT\"      : \"false\","
     "     \"CALI_CHANNEL_CONFIG_CHECK\"       : \"false\","
@@ -545,7 +545,7 @@ const char* spot_controller_spec =
     " \"name\"        : \"spot\","
     " \"description\" : \"Record a time profile for the Spot web visualization framework\","
     " \"categories\"  : [ \"adiak\", \"metric\", \"output\", \"region\", \"event\" ],"
-    " \"services\"    : [ \"aggregate\", \"event\", \"timestamp\" ],"
+    " \"services\"    : [ \"aggregate\", \"event\", \"timer\" ],"
     " \"config\"      : "
     "   { \"CALI_CHANNEL_FLUSH_ON_EXIT\"      : \"false\","
     "     \"CALI_CHANNEL_CONFIG_CHECK\"       : \"false\","

src/caliper/controllers/controllers.cpp

@@ -12,7 +12,7 @@ const char* event_trace_spec =
     "{"
     " \"name\"        : \"event-trace\","
     " \"description\" : \"Record a trace of region enter/exit events in .cali format\","
-    " \"services\"    : [ \"event\", \"recorder\", \"timestamp\", \"trace\" ],"
+    " \"services\"    : [ \"event\", \"recorder\", \"timer\", \"trace\" ],"
     " \"categories\"  : [ \"output\", \"event\" ],"
     " \"config\"      : "
     "   { \"CALI_CHANNEL_FLUSH_ON_EXIT\"   : \"false\","
@@ -82,7 +82,7 @@ const char* roctx_spec =
 const char* mpireport_spec =
     "{"
     " \"name\"        : \"mpi-report\","
-    " \"services\"    : [ \"aggregate\", \"event\", \"mpi\", \"mpireport\", \"timestamp\" ],"
+    " \"services\"    : [ \"aggregate\", \"event\", \"mpi\", \"mpireport\", \"timer\" ],"
     " \"description\" : \"Print time spent in MPI functions\","
     " \"categories\"  : [ \"event\" ],"
     " \"config\"      : "

src/common/RuntimeConfig.cpp

@@ -64,7 +64,7 @@ namespace
         // make uppercase PREFIX_NAMESPACE_KEY string
 
         string str = string("CALI_") + name + string("_") + key;
-        
+
         transform(str.begin(), str.end(), str.begin(), ::toupper);
 
         return str;
@@ -84,46 +84,41 @@ struct ConfigSetImpl
 {
     // --- data
 
-    struct ConfigValue {
-        ConfigSet::Entry entry;
-        std::string      value;
-    };
-
-    unordered_map<string, ConfigValue> m_dict;
+    std::unordered_map<string, StringConverter> m_dict;
 
     // --- interface
 
     StringConverter get(const char* key) const {
         auto it = m_dict.find(key);
-        return (it == m_dict.end() ? StringConverter() : StringConverter(it->second.value));
+        return (it == m_dict.end() ? StringConverter() : it->second);
     }
 
-    void init(const char* name, const ConfigSet::Entry* list, bool read_env, const ::config_profile_t& profile, const ::config_profile_t& top_profile)
+    void init(const char* name, const RuntimeConfig::config_entry_list_t& list, bool read_env, const ::config_profile_t& profile, const ::config_profile_t& top_profile)
     {
-        for (const ConfigSet::Entry* e = list; e && e->key; ++e) {
-            ConfigValue newent  { *e, string(e->value) };
-            string      varname { ::config_var_name(name, e->key) };
+        for (const auto &e : list) {
+            std::string varname { ::config_var_name(name, e.first) };
+            std::string value   { e.second };
 
             // See if there is an entry in the top config profile
             auto topit = top_profile.find(varname);
 
             if (topit != top_profile.end()) {
-                newent.value = topit->second;
+                value = topit->second;
             } else {
                 // See if there is an entry in the base config profile
                 auto it = profile.find(varname);
                 if (it != profile.end())
-                    newent.value = it->second;
+                    value = it->second;
 
                 if (read_env) {
                     // See if there is a config variable set
-                    char* val = getenv(::config_var_name(name, e->key).c_str());
+                    char* val = getenv(::config_var_name(name, e.first).c_str());
                     if (val)
-                        newent.value = val;
+                        value = val;
                 }
             }
 
-            m_dict.emplace(make_pair(string(e->key), newent));
+            m_dict.emplace(make_pair(e.first, StringConverter(value)));
         }
     }
 };
@@ -136,7 +131,6 @@ struct ConfigSetImpl
 struct RuntimeConfig::RuntimeConfigImpl
 {
     // --- data
-    static const ConfigSet::Entry            s_configdata[];
 
     bool                                     m_allow_read_env = true;
 
@@ -215,9 +209,14 @@ struct RuntimeConfig::RuntimeConfigImpl
     }
 
     void init_config_database() {
+        const config_entry_list_t configdata {
+            { "profile", "default"        },
+            { "file",    "caliper.config" }
+        };
+
         // read pre-init config set to get config file name from env var
         ConfigSetImpl init_config_cfg;
-        init_config_cfg.init("config", s_configdata, m_allow_read_env, m_combined_profile, m_top_profile);
+        init_config_cfg.init("config", configdata, m_allow_read_env, m_combined_profile, m_top_profile);
 
         // read config files
         read_config_files(init_config_cfg.get("file").to_stringlist());
@@ -230,7 +229,7 @@ struct RuntimeConfig::RuntimeConfigImpl
 
         // read "config" config again: profile may have been set in the file
         shared_ptr<ConfigSetImpl> config_cfg { new ConfigSetImpl };
-        config_cfg->init("config", s_configdata, m_allow_read_env, m_combined_profile, m_top_profile);
+        config_cfg->init("config", configdata, m_allow_read_env, m_combined_profile, m_top_profile);
 
         m_database.insert(make_pair("config", config_cfg));
 
@@ -275,7 +274,7 @@ struct RuntimeConfig::RuntimeConfigImpl
             m_top_profile[p.first] = p.second;
     }
 
-    shared_ptr<ConfigSetImpl> init_configset(const char* name, const ConfigSet::Entry* list) {
+    shared_ptr<ConfigSetImpl> init_configset(const char* name, const config_entry_list_t& list) {
         if (m_database.empty())
             init_config_database();
 
@@ -295,25 +294,11 @@ struct RuntimeConfig::RuntimeConfigImpl
     void print(std::ostream& os) const {
         for ( auto set : m_database )
             for ( auto entry : set.second->m_dict )
-                os << "# " << entry.second.entry.descr
-                   << " (" << cali_type2string(entry.second.entry.type) << ")\n"
-                   << ::config_var_name(set.first, entry.first)
-                   << '=' << entry.second.value << std::endl;
+                os << ::config_var_name(set.first, entry.first)
+                   << '=' << entry.second.to_string() << std::endl;
     }
 };
 
-const ConfigSet::Entry RuntimeConfig::RuntimeConfigImpl::s_configdata[] = {
-    { "profile",  CALI_TYPE_STRING, "default",
-      "Configuration profile",
-      "Configuration profile"
-    },
-    { "file",     CALI_TYPE_STRING, "caliper.config",
-      "List of configuration files",
-      "Comma-separated list of configuration files"
-    },
-    ConfigSet::Terminator
-};
-
 } // namespace cali
 
 
@@ -329,7 +314,7 @@ StringConverter
 ConfigSet::get(const char* key) const
 {
     if (!mP)
-        return std::string();
+        return StringConverter();
 
     return mP->get(key);
 }
@@ -351,6 +336,17 @@ RuntimeConfig::get(const char* set, const char* key)
 
 ConfigSet
 RuntimeConfig::init(const char* name, const ConfigSet::Entry* list)
+{
+    config_entry_list_t converted_list;
+
+    for (const ConfigSet::Entry* e = list; e && e->key; ++e)
+        converted_list.emplace_back( std::make_pair<std::string, std::string>(e->key, e->value) );
+
+    return ConfigSet(mP->init_configset(name, converted_list));
+}
+
+ConfigSet
+RuntimeConfig::init(const char* name, const config_entry_list_t& list)
 {
     return ConfigSet(mP->init_configset(name, list));
 }

src/mpi/services/mpiwrap/MpiWrap.cpp

@@ -3,6 +3,8 @@
 
 #include "caliper/CaliperService.h"
 
+#include "../../services/Services.h"
+
 #include "caliper/Caliper.h"
 
 #include "caliper/common/Log.h"
@@ -20,7 +22,7 @@ Attribute mpisize_attr     { Attribute::invalid };
 Attribute mpicall_attr     { Attribute::invalid };
 Attribute mpi_call_id_attr { Attribute::invalid };
 
-extern void mpiwrap_init(Caliper* c, Channel* chn);
+extern void mpiwrap_init(Caliper* c, Channel* chn, cali::ConfigSet& cfg);
 
 extern Attribute subscription_event_attr;
 
@@ -29,6 +31,27 @@ extern Attribute subscription_event_attr;
 namespace
 {
 
+const char* mpi_service_spec = R"json(
+{   "name": "mpi",
+    "description": "MPI function wrapping and message tracing",
+    "config": [
+        {   "name": "blacklist",
+            "description": "List of MPI functions to filter",
+            "type": "string"
+        },
+        {   "name": "whitelist",
+            "description": "List of MPI functions to instrument",
+            "type": "string"
+        },
+        {   "name": "msg_tracing",
+            "description": "List of MPI functions to instrument",
+            "type": "bool",
+            "value": "false"
+        }
+    ]
+}
+)json";
+
 void mpi_register(Caliper* c, Channel* chn)
 {
     Variant v_true(true);
@@ -55,7 +78,10 @@ void mpi_register(Caliper* c, Channel* chn)
                                 CALI_ATTR_SCOPE_THREAD  |
                                 CALI_ATTR_ASVALUE       |
                                 CALI_ATTR_SKIP_EVENTS);
-    mpiwrap_init(c, chn);
+
+    ConfigSet cfg = services::init_config_from_spec(chn->config(), mpi_service_spec);
+
+    mpiwrap_init(c, chn, cfg);
 
     Log(1).stream() << chn->name() << ": Registered MPI service" << std::endl;
 }
@@ -66,6 +92,6 @@ void mpi_register(Caliper* c, Channel* chn)
 namespace cali
 {
 
-CaliperService mpiwrap_service = { "mpi", ::mpi_register };
+CaliperService mpiwrap_service = { ::mpi_service_spec, ::mpi_register };
 
 } // namespace cali