Add warning message with configured legacy modules

cms-sw · Jul 21, 2021 · 673972e · 673972e
1 parent 82fc9f2
commit 673972e
Show file tree

Hide file tree

Showing 5 changed files with 97 additions and 0 deletions.
diff --git a/FWCore/Framework/interface/EventProcessor.h b/FWCore/Framework/interface/EventProcessor.h
@@ -303,6 +303,7 @@ namespace edm {
     std::shared_ptr<EDLooperBase>& looper() { return get_underlying_safe(looper_); }
 
     void warnAboutModulesRequiringLuminosityBLockSynchronization() const;
+    void warnAboutLegacyModules() const;
     //------------------------------------------------------------------
     //
     // Data members below.

diff --git a/FWCore/Framework/src/EventProcessor.cc b/FWCore/Framework/src/EventProcessor.cc
@@ -642,6 +642,8 @@ namespace edm {
     if (preallocations_.numberOfLuminosityBlocks() > 1) {
       warnAboutModulesRequiringLuminosityBLockSynchronization();
     }
+    warnAboutLegacyModules();
+
     //NOTE:  This implementation assumes 'Job' means one call
     // the EventProcessor::run
     // If it really means once per 'application' then this code will
@@ -2100,4 +2102,19 @@ namespace edm {
       }
     }
   }
+
+  void EventProcessor::warnAboutLegacyModules() const {
+    std::unique_ptr<LogSystem> s;
+    for (auto worker : schedule_->allWorkers()) {
+      if (worker->moduleConcurrencyType() == Worker::kLegacy) {
+        if (not s) {
+          s = std::make_unique<LogSystem>("LegacyModules");
+          (*s) << "The following legacy modules are configured. Support for legacy modules\n"
+                  "is going to end soon. These modules need to be converted to have type\n"
+                  "edm::global, edm::stream, edm::one, or in rare cases edm::limited.";
+        }
+        (*s) << "\n  " << worker->description()->moduleName() << " " << worker->description()->moduleLabel();
+      }
+    }
+  }
 }  // namespace edm
diff --git a/FWCore/Framework/src/Worker.h b/FWCore/Framework/src/Worker.h
@@ -91,6 +91,7 @@ namespace edm {
   public:
     enum State { Ready, Pass, Fail, Exception };
     enum Types { kAnalyzer, kFilter, kProducer, kOutputModule };
+    enum ConcurrencyTypes { kGlobal, kLimited, kOne, kStream, kLegacy };
     struct TaskQueueAdaptor {
       SerialTaskQueueChain* serial_ = nullptr;
       LimitedTaskQueue* limited_ = nullptr;
@@ -214,6 +215,7 @@ namespace edm {
     virtual std::vector<ConsumesInfo> consumesInfo() const = 0;
 
     virtual Types moduleType() const = 0;
+    virtual ConcurrencyTypes moduleConcurrencyType() const = 0;
 
     void clearCounters() {
       timesRun_.store(0, std::memory_order_release);

diff --git a/FWCore/Framework/src/WorkerT.cc b/FWCore/Framework/src/WorkerT.cc
@@ -769,6 +769,82 @@ namespace edm {
     return Worker::kAnalyzer;
   }
 
+  template <>
+  Worker::ConcurrencyTypes WorkerT<EDAnalyzer>::moduleConcurrencyType() const {
+    return Worker::kLegacy;
+  }
+  template <>
+  Worker::ConcurrencyTypes WorkerT<EDProducer>::moduleConcurrencyType() const {
+    return Worker::kLegacy;
+  }
+  template <>
+  Worker::ConcurrencyTypes WorkerT<EDFilter>::moduleConcurrencyType() const {
+    return Worker::kLegacy;
+  }
+  template <>
+  Worker::ConcurrencyTypes WorkerT<edm::one::EDProducerBase>::moduleConcurrencyType() const {
+    return Worker::kOne;
+  }
+  template <>
+  Worker::ConcurrencyTypes WorkerT<edm::one::EDFilterBase>::moduleConcurrencyType() const {
+    return Worker::kOne;
+  }
+  template <>
+  Worker::ConcurrencyTypes WorkerT<edm::one::EDAnalyzerBase>::moduleConcurrencyType() const {
+    return Worker::kOne;
+  }
+  template <>
+  Worker::ConcurrencyTypes WorkerT<edm::one::OutputModuleBase>::moduleConcurrencyType() const {
+    return Worker::kOne;
+  }
+
+  template <>
+  Worker::ConcurrencyTypes WorkerT<edm::global::EDProducerBase>::moduleConcurrencyType() const {
+    return Worker::kGlobal;
+  }
+  template <>
+  Worker::ConcurrencyTypes WorkerT<edm::global::EDFilterBase>::moduleConcurrencyType() const {
+    return Worker::kGlobal;
+  }
+  template <>
+  Worker::ConcurrencyTypes WorkerT<edm::global::EDAnalyzerBase>::moduleConcurrencyType() const {
+    return Worker::kGlobal;
+  }
+  template <>
+  Worker::ConcurrencyTypes WorkerT<edm::global::OutputModuleBase>::moduleConcurrencyType() const {
+    return Worker::kGlobal;
+  }
+
+  template <>
+  Worker::ConcurrencyTypes WorkerT<edm::limited::EDProducerBase>::moduleConcurrencyType() const {
+    return Worker::kLimited;
+  }
+  template <>
+  Worker::ConcurrencyTypes WorkerT<edm::limited::EDFilterBase>::moduleConcurrencyType() const {
+    return Worker::kLimited;
+  }
+  template <>
+  Worker::ConcurrencyTypes WorkerT<edm::limited::EDAnalyzerBase>::moduleConcurrencyType() const {
+    return Worker::kLimited;
+  }
+  template <>
+  Worker::ConcurrencyTypes WorkerT<edm::limited::OutputModuleBase>::moduleConcurrencyType() const {
+    return Worker::kLimited;
+  }
+
+  template <>
+  Worker::ConcurrencyTypes WorkerT<edm::stream::EDProducerAdaptorBase>::moduleConcurrencyType() const {
+    return Worker::kStream;
+  }
+  template <>
+  Worker::ConcurrencyTypes WorkerT<edm::stream::EDFilterAdaptorBase>::moduleConcurrencyType() const {
+    return Worker::kStream;
+  }
+  template <>
+  Worker::ConcurrencyTypes WorkerT<edm::stream::EDAnalyzerAdaptorBase>::moduleConcurrencyType() const {
+    return Worker::kStream;
+  }
+
   //Explicitly instantiate our needed templates to avoid having the compiler
   // instantiate them in all of our libraries
   template class WorkerT<EDProducer>;

diff --git a/FWCore/Framework/src/WorkerT.h b/FWCore/Framework/src/WorkerT.h
@@ -42,6 +42,7 @@ namespace edm {
     }
 
     Types moduleType() const override;
+    ConcurrencyTypes moduleConcurrencyType() const override;
 
     bool wantsProcessBlocks() const final;
     bool wantsInputProcessBlocks() const final;