Move functionality from Worker to ModuleHolder

- moved module finalization calls to ModuleHolder

Author: Dr15Jones

FWCore/Framework/interface/GlobalSchedule.h

@@ -99,8 +99,6 @@ namespace edm {
     /// returns the collection of pointers to workers
     AllWorkers const& allWorkers() const { return workerManagers_[0].allWorkers(); }
 
-    void releaseMemoryPostLookupSignal();
-
   private:
     /// returns the action table
     ExceptionToActionTable const& actionTable() const { return workerManagers_[0].actionTable(); }

FWCore/Framework/interface/WorkerManager.h

@@ -67,10 +67,7 @@ namespace edm {
     void setupResolvers(Principal& principal);
     void setupOnDemandSystem(EventTransitionInfo const&);
 
-    void beginJob(ProductRegistry const& iRegistry,
-                  eventsetup::ESRecordsToProductResolverIndices const&,
-                  ProcessBlockHelperBase const&,
-                  GlobalContext const&);
+    void beginJob(GlobalContext const&);
     void endJob(ExceptionCollector&, GlobalContext const&);
 
     void beginStream(StreamID, StreamContext const&);
@@ -99,8 +96,6 @@ namespace edm {
     }
     void resetAll();
 
-    void releaseMemoryPostLookupSignal();
-
   private:
     Worker* getWorkerForExistingModule(std::string const& label);
 

FWCore/Framework/interface/maker/ModuleHolder.h

@@ -23,14 +23,24 @@
 
 // user include files
 #include "FWCore/Framework/interface/maker/WorkerT.h"
-#include "FWCore/Framework/interface/OutputModuleCommunicatorT.h"
 #include "FWCore/Framework/interface/SignallingProductRegistryFiller.h"
+#include "FWCore/Framework/interface/OutputModuleCommunicator.h"
+
+#include "FWCore/Utilities/interface/BranchType.h"
+#include "FWCore/Utilities/interface/ProductResolverIndex.h"
+
+#include <unordered_map>
+#include <string>
 // forward declarations
 namespace edm {
   class ModuleDescription;
   class SignallingProductRegistryFiller;
   class ExceptionToActionTable;
   class PreallocationConfiguration;
+  class ProductResolverIndexHelper;
+  class ProductResolverIndexAndSkipBit;
+  class ProductRegistry;
+  class ThinnedAssociationsHelper;
 
   namespace maker {
     class ModuleHolder {
@@ -46,6 +56,22 @@ namespace edm {
       virtual void replaceModuleFor(Worker*) const = 0;
 
       virtual std::unique_ptr<OutputModuleCommunicator> createOutputModuleCommunicator() = 0;
+
+      void registerThinnedAssociations(ProductRegistry const& registry, ThinnedAssociationsHelper& helper);
+      //Used to make EDGetToken work
+      virtual void updateLookup(BranchType iBranchType, ProductResolverIndexHelper const&) = 0;
+      virtual void updateLookup(eventsetup::ESRecordsToProductResolverIndices const&) = 0;
+      virtual void releaseMemoryPostLookupSignal() = 0;
+      virtual void selectInputProcessBlocks(ProductRegistry const&, ProcessBlockHelperBase const&) = 0;
+      virtual void resolvePutIndicies(
+          BranchType iBranchType,
+          std::unordered_multimap<std::string, std::tuple<TypeID const*, const char*, edm::ProductResolverIndex>> const&
+              iIndicies) = 0;
+      virtual void convertCurrentProcessAlias(std::string const& processName) = 0;
+
+    private:
+      virtual void implRegisterThinnedAssociations(ProductRegistry const& registry,
+                                                   ThinnedAssociationsHelper& helper) = 0;
     };
 
     template <typename T>
@@ -59,7 +85,7 @@ namespace edm {
         assert(nullptr != w);
         w->setModule(m_mod);
       }
-      std::unique_ptr<Worker> makeWorker(ExceptionToActionTable const* actions) const override {
+      std::unique_ptr<Worker> makeWorker(ExceptionToActionTable const* actions) const final {
         return std::make_unique<edm::WorkerT<T>>(module(), moduleDescription(), actions);
       }
 
@@ -73,18 +99,30 @@ namespace edm {
           iModule.registerProductsAndCallbacks(&iModule, iReg);
         }
       };
-      ModuleDescription const& moduleDescription() const override { return m_mod->moduleDescription(); }
+      ModuleDescription const& moduleDescription() const final { return m_mod->moduleDescription(); }
 
       void finishModuleInitialization(ModuleDescription const& iDesc,
                                       PreallocationConfiguration const& iPrealloc,
                                       SignallingProductRegistryFiller* iReg) override {
         finishModuleInitialization(*m_mod, iDesc, iPrealloc, iReg);
       }
-      std::unique_ptr<OutputModuleCommunicator> createOutputModuleCommunicator() override {
-        return OutputModuleCommunicatorT<T>::createIfNeeded(m_mod.get());
+      std::unique_ptr<OutputModuleCommunicator> createOutputModuleCommunicator() final;
+
+      void updateLookup(BranchType iBranchType, ProductResolverIndexHelper const&) final;
+      void updateLookup(eventsetup::ESRecordsToProductResolverIndices const&) final;
+      void releaseMemoryPostLookupSignal() final;
+      void selectInputProcessBlocks(ProductRegistry const&, ProcessBlockHelperBase const&) final;
+      void resolvePutIndicies(
+          BranchType iBranchType,
+          std::unordered_multimap<std::string, std::tuple<TypeID const*, const char*, edm::ProductResolverIndex>> const&
+              iIndicies) final;
+      void convertCurrentProcessAlias(std::string const& processName) final {
+        m_mod->convertCurrentProcessAlias(processName);
       }
 
     private:
+      void implRegisterThinnedAssociations(ProductRegistry const& registry, ThinnedAssociationsHelper& helper) final;
+
       std::shared_ptr<T> m_mod;
     };
   }  // namespace maker

FWCore/Framework/interface/maker/Worker.h

@@ -131,9 +131,12 @@ namespace edm {
     virtual bool wantsStreamRuns() const noexcept = 0;
     virtual bool wantsStreamLuminosityBlocks() const noexcept = 0;
 
+    //returns non-nullptr if the module can only process one Run at a time
     virtual SerialTaskQueue* globalRunsQueue() = 0;
+    //returns non-nullptr if the module can only process one LuminosityBlock at a time
     virtual SerialTaskQueue* globalLuminosityBlocksQueue() = 0;
 
+    //Run only for OutputModules. Causes TriggerResults information to be used to decide if module should run.
     void prePrefetchSelectionAsync(oneapi::tbb::task_group&,
                                    WaitingTask* task,
                                    ServiceToken const&,
@@ -177,6 +180,7 @@ namespace edm {
                           StreamContext const*) noexcept;
 
     void callWhenDoneAsync(WaitingTaskHolder task) { waitingTasks_.add(std::move(task)); }
+    // Called if filter earlier in the path has failed.
     void skipOnPath(EventPrincipal const& iEvent);
     void beginJob(GlobalContext const&);
     void endJob(GlobalContext const&);
@@ -185,7 +189,6 @@ namespace edm {
     void respondToOpenInputFile(FileBlock const& fb) { implRespondToOpenInputFile(fb); }
     void respondToCloseInputFile(FileBlock const& fb) { implRespondToCloseInputFile(fb); }
     void respondToCloseOutputFile() { implRespondToCloseOutputFile(); }
-    void registerThinnedAssociations(ProductRegistry const& registry, ThinnedAssociationsHelper& helper);
 
     void reset() {
       cached_exception_ = std::exception_ptr();
@@ -209,18 +212,6 @@ namespace edm {
 
     void setEarlyDeleteHelper(EarlyDeleteHelper* iHelper);
 
-    //Used to make EDGetToken work
-    virtual void updateLookup(BranchType iBranchType, ProductResolverIndexHelper const&) = 0;
-    virtual void updateLookup(eventsetup::ESRecordsToProductResolverIndices const&) = 0;
-    virtual void releaseMemoryPostLookupSignal() = 0;
-    virtual void selectInputProcessBlocks(ProductRegistry const&, ProcessBlockHelperBase const&) = 0;
-    virtual void resolvePutIndicies(
-        BranchType iBranchType,
-        std::unordered_multimap<std::string, std::tuple<TypeID const*, const char*, edm::ProductResolverIndex>> const&
-            iIndicies) = 0;
-
-    virtual void convertCurrentProcessAlias(std::string const& processName) = 0;
-
     virtual std::vector<ModuleConsumesInfo> moduleConsumesInfos() const = 0;
     virtual std::vector<ModuleConsumesMinimalESInfo> moduleConsumesMinimalESInfos() const = 0;
 
@@ -314,8 +305,6 @@ namespace edm {
     virtual void implRespondToCloseInputFile(FileBlock const& fb) = 0;
     virtual void implRespondToCloseOutputFile() = 0;
 
-    virtual void implRegisterThinnedAssociations(ProductRegistry const&, ThinnedAssociationsHelper&) = 0;
-
     virtual TaskQueueAdaptor serializeRunModule() = 0;
 
     bool shouldRethrowException(std::exception_ptr iPtr,

FWCore/Framework/interface/maker/WorkerT.h

@@ -59,16 +59,6 @@ namespace edm {
     SerialTaskQueue* globalRunsQueue() final;
     SerialTaskQueue* globalLuminosityBlocksQueue() final;
 
-    void updateLookup(BranchType iBranchType, ProductResolverIndexHelper const&) final;
-    void updateLookup(eventsetup::ESRecordsToProductResolverIndices const&) final;
-    void releaseMemoryPostLookupSignal() final;
-    void selectInputProcessBlocks(ProductRegistry const&, ProcessBlockHelperBase const&) final;
-
-    void resolvePutIndicies(
-        BranchType iBranchType,
-        std::unordered_multimap<std::string, std::tuple<TypeID const*, const char*, edm::ProductResolverIndex>> const&
-            iIndicies) final;
-
     template <typename D>
     void callWorkerBeginStream(D, StreamID);
     template <typename D>
@@ -125,14 +115,9 @@ namespace edm {
     void implRespondToOpenInputFile(FileBlock const& fb) override;
     void implRespondToCloseInputFile(FileBlock const& fb) override;
     void implRespondToCloseOutputFile() override;
-    void implRegisterThinnedAssociations(ProductRegistry const&, ThinnedAssociationsHelper&) override;
     std::string workerType() const override;
     TaskQueueAdaptor serializeRunModule() override;
 
-    void convertCurrentProcessAlias(std::string const& processName) override {
-      module_->convertCurrentProcessAlias(processName);
-    }
-
     std::vector<ModuleConsumesInfo> moduleConsumesInfos() const override;
     std::vector<ModuleConsumesMinimalESInfo> moduleConsumesMinimalESInfos() const final {
       return module_->moduleConsumesMinimalESInfos();

FWCore/Framework/src/GlobalSchedule.cc

@@ -96,7 +96,7 @@ namespace edm {
         exceptionContext(ex, globalContext, "Handling pre signal, likely in a service function");
         throw;
       }
-      workerManagers_[managerIndex].beginJob(iRegistry, iESIndices, processBlockHelperBase, globalContext);
+      workerManagers_[managerIndex].beginJob(globalContext);
     } catch (...) {
       exceptionPtr = std::current_exception();
     }
@@ -176,12 +176,6 @@ namespace edm {
     }
   }
 
-  void GlobalSchedule::releaseMemoryPostLookupSignal() {
-    unsigned int const managerIndex =
-        numberOfConcurrentLumis_ + numberOfConcurrentRuns_ + numberOfConcurrentProcessBlocks_;
-    workerManagers_[managerIndex].releaseMemoryPostLookupSignal();
-  }
-
   std::vector<ModuleDescription const*> GlobalSchedule::getAllModuleDescriptions() const {
     std::vector<ModuleDescription const*> result;
     result.reserve(allWorkers().size());