DPL: pass ConfigContext to the PluginManager when creating AlgorithmSpec

This way a plugin can create more complex AlgorithmSpecs which depend on
the workflow options. This will be needed to properly read metadata from
parent files, and it opens the way to more service devices to be moved
in a plugin.

Author: ktf

Framework/AnalysisSupport/src/AODJAlienReaderHelpers.cxx

@@ -22,6 +22,7 @@
 #include "Framework/DeviceSpec.h"
 #include "Framework/RawDeviceService.h"
 #include "Framework/DataSpecUtils.h"
+#include "Framework/ConfigContext.h"
 #include "DataInputDirector.h"
 #include "Framework/SourceInfoHeader.h"
 #include "Framework/ChannelInfo.h"
@@ -117,7 +118,7 @@ static inline auto extractOriginalsTuple(framework::pack<Os...>, ProcessingConte
   return std::make_tuple(extractTypedOriginal<Os>(pc)...);
 }
 
-AlgorithmSpec AODJAlienReaderHelpers::rootFileReaderCallback()
+AlgorithmSpec AODJAlienReaderHelpers::rootFileReaderCallback(ConfigContext const& config)
 {
   auto callback = AlgorithmSpec{adaptStateful([](ConfigParamRegistry const& options,
                                                  DeviceSpec const& spec,

Framework/AnalysisSupport/src/AODJAlienReaderHelpers.h

@@ -24,7 +24,7 @@ namespace o2::framework::readers
 {
 
 struct AODJAlienReaderHelpers {
-  static AlgorithmSpec rootFileReaderCallback();
+  static AlgorithmSpec rootFileReaderCallback(ConfigContext const&context);
   static void dumpFileMetrics(o2::monitoring::Monitoring& monitoring, TFile* currentFile, uint64_t startedAt, uint64_t ioTime, int tfPerFile, int tfRead);
 };
 

Framework/AnalysisSupport/src/Plugin.cxx

@@ -26,9 +26,9 @@
 O2_DECLARE_DYNAMIC_LOG(analysis_support);
 
 struct ROOTFileReader : o2::framework::AlgorithmPlugin {
-  o2::framework::AlgorithmSpec create() override
+  o2::framework::AlgorithmSpec create(o2::framework::ConfigContext const& config) override
   {
-    return o2::framework::readers::AODJAlienReaderHelpers::rootFileReaderCallback();
+    return o2::framework::readers::AODJAlienReaderHelpers::rootFileReaderCallback(config);
   }
 };
 

Framework/CCDBSupport/src/Plugin.cxx

@@ -13,7 +13,7 @@
 #include "CCDBHelpers.h"
 
 struct CCDBFetcherPlugin : o2::framework::AlgorithmPlugin {
-  o2::framework::AlgorithmSpec create() final
+  o2::framework::AlgorithmSpec create(o2::framework::ConfigContext const&) final
   {
     return o2::framework::CCDBHelpers::fetchFromCCDB();
   }

Framework/Core/include/Framework/AlgorithmSpec.h

@@ -81,7 +81,7 @@ struct AlgorithmSpec {
 
 /// Helper class for an algorithm which is loaded as a plugin.
 struct AlgorithmPlugin {
-  virtual AlgorithmSpec create() = 0;
+  virtual AlgorithmSpec create(ConfigContext const&) = 0;
 };
 // Allow fetching inputs from the context using a string literal.
 template <StringLiteral lit, typename T>

Framework/Core/include/Framework/PluginManager.h

@@ -51,8 +51,9 @@ struct PluginManager {
   /// the DPLPluginHandle provided by the library.
   static void load(std::vector<PluginInfo>& infos, const char* dso, std::function<void(DPLPluginHandle*)>& onSuccess);
   /// Load an called @plugin from a library called @a library and
-  /// return the associtated AlgorithmSpec.
-  static auto loadAlgorithmFromPlugin(std::string library, std::string plugin) -> AlgorithmSpec;
+  /// @return the associated AlgorithmSpec.
+  /// The config @a context can be used to determine the workflow options which affect such plugin.
+  static auto loadAlgorithmFromPlugin(std::string library, std::string plugin, ConfigContext const& context) -> AlgorithmSpec;
   /// Wrap an algorithm with some lambda @wrapper which will be called
   /// with the original callback and the ProcessingContext.
   static auto wrapAlgorithm(AlgorithmSpec const& spec, WrapperProcessCallback&& wrapper) -> AlgorithmSpec;

Framework/Core/src/PluginManager.cxx

@@ -101,10 +101,10 @@ void PluginManager::load(std::vector<PluginInfo>& libs, const char* dso, std::fu
   onSuccess(pluginInstance);
 }
 
-auto PluginManager::loadAlgorithmFromPlugin(std::string library, std::string plugin) -> AlgorithmSpec
+auto PluginManager::loadAlgorithmFromPlugin(std::string library, std::string plugin, ConfigContext const& context) -> AlgorithmSpec
 {
   std::shared_ptr<AlgorithmSpec> algorithm{nullptr};
-  return AlgorithmSpec{[algorithm, library, plugin](InitContext& ic) mutable -> AlgorithmSpec::ProcessCallback {
+  return AlgorithmSpec{[algorithm, library, plugin, &context](InitContext& ic) mutable -> AlgorithmSpec::ProcessCallback {
     if (algorithm.get()) {
       return algorithm->onInit(ic);
     }
@@ -134,7 +134,7 @@ auto PluginManager::loadAlgorithmFromPlugin(std::string library, std::string plu
     if (!creator) {
       LOGP(fatal, "Could not find the {} plugin in {}.", plugin, libName);
     }
-    algorithm = std::make_shared<AlgorithmSpec>(creator->create());
+    algorithm = std::make_shared<AlgorithmSpec>(creator->create(context));
     return algorithm->onInit(ic);
   }};
 };

Framework/Core/src/WorkflowHelpers.cxx

@@ -432,7 +432,7 @@ void WorkflowHelpers::injectServiceDevices(WorkflowSpec& workflow, ConfigContext
     auto mctracks2aod = std::find_if(workflow.begin(), workflow.end(), [](auto const& x) { return x.name == "mctracks-to-aod"; });
     if (mctracks2aod == workflow.end()) {
       // add normal reader
-      auto&& algo = PluginManager::loadAlgorithmFromPlugin("O2FrameworkAnalysisSupport", "ROOTFileReader");
+      auto&& algo = PluginManager::loadAlgorithmFromPlugin("O2FrameworkAnalysisSupport", "ROOTFileReader", ctx);
       if (internalRateLimiting) {
         aodReader.algorithm = CommonDataProcessors::wrapWithRateLimiting(algo);
       } else {
@@ -520,7 +520,7 @@ void WorkflowHelpers::injectServiceDevices(WorkflowSpec& workflow, ConfigContext
     }
 
     // Load the CCDB backend from the plugin
-    ccdbBackend.algorithm = PluginManager::loadAlgorithmFromPlugin("O2FrameworkCCDBSupport", "CCDBFetcherPlugin");
+    ccdbBackend.algorithm = PluginManager::loadAlgorithmFromPlugin("O2FrameworkCCDBSupport", "CCDBFetcherPlugin", ctx);
     extraSpecs.push_back(ccdbBackend);
   } else {
     // If there is no CCDB requested, but we still ask for a FLP/DISTSUBTIMEFRAME/0xccdb