Merge pull request #34577 from wddgit/addLegacyWarning

Add warning that lists legacy modules if any are configured.

FWCore/Framework/interface/EventProcessor.h

@@ -306,6 +306,7 @@ namespace edm {
     std::shared_ptr<EDLooperBase>& looper() { return get_underlying_safe(looper_); }
 
     void warnAboutModulesRequiringLuminosityBLockSynchronization() const;
+    void warnAboutLegacyModules() const;
     //------------------------------------------------------------------
     //
     // Data members below.

FWCore/Framework/src/EventProcessor.cc

@@ -644,6 +644,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
@@ -1997,4 +1999,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

FWCore/Framework/src/Worker.h

@@ -92,6 +92,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;
@@ -216,6 +217,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);

FWCore/Framework/src/WorkerT.cc

@@ -803,6 +803,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>;

FWCore/Framework/src/WorkerT.h

@@ -43,6 +43,7 @@ namespace edm {
     }
 
     Types moduleType() const override;
+    ConcurrencyTypes moduleConcurrencyType() const override;
 
     bool wantsProcessBlocks() const final;
     bool wantsInputProcessBlocks() const final;

FWCore/Integration/test/run_TestGetBy.sh

@@ -8,19 +8,20 @@ pushd ${LOCAL_TMP_DIR}
 
   echo "testGetBy1"
   cmsRun -p ${LOCAL_TEST_DIR}/${test}1_cfg.py > testGetBy1.log 2>/dev/null || die "cmsRun ${test}1_cfg.py" $?
-  diff ${LOCAL_TEST_DIR}/unit_test_outputs/testGetBy1.log testGetBy1.log || die "comparing testGetBy1.log" $?
+  grep -v "LegacyModules" testGetBy1.log > testGetBy1_1.log
+  diff ${LOCAL_TEST_DIR}/unit_test_outputs/testGetBy1.log testGetBy1_1.log || die "comparing testGetBy1.log" $?
 
   echo "testGetBy2"
   cmsRun -p ${LOCAL_TEST_DIR}/${test}2_cfg.py > testGetBy2.log 2>/dev/null || die "cmsRun ${test}2_cfg.py" $?
-  grep -v "Initiating request to open file" testGetBy2.log | grep -v "Successfully opened file" | grep -v "Closed file" > testGetBy2_1.log
+  grep -v 'Initiating request to open file\|Successfully opened file\|Closed file\|LegacyModules' testGetBy2.log > testGetBy2_1.log
   diff ${LOCAL_TEST_DIR}/unit_test_outputs/testGetBy2.log testGetBy2_1.log || die "comparing testGetBy2.log" $?
 
   echo "testGetBy3"
   cmsRun -p ${LOCAL_TEST_DIR}/${test}3_cfg.py || die "cmsRun ${test}3_cfg.py" $?
 
   echo "testConsumesInfo"
   cmsRun -p ${LOCAL_TEST_DIR}/testConsumesInfo_cfg.py > testConsumesInfo.log 2>/dev/null || die "cmsRun testConsumesInfo_cfg.py" $?
-  grep -v "++" testConsumesInfo.log > testConsumesInfo_1.log
+  grep -v '++\|LegacyModules' testConsumesInfo.log > testConsumesInfo_1.log
   rm testConsumesInfo.log
   rm testConsumesInfo.root
   diff ${LOCAL_TEST_DIR}/unit_test_outputs/testConsumesInfo_1.log testConsumesInfo_1.log || die "comparing testConsumesInfo_1.log" $?

FWCore/Integration/test/unit_test_outputs/testConsumesInfo_1.log

@@ -150,6 +150,11 @@ For products only read from previous processes, 'skip current process' is added
   EndPathStatusInserter/'e'
   EndPathStatusInserter/'p1ep2'
 
+The following legacy modules are configured. Support for legacy modules
+is going to end soon. These modules need to be converted to have type
+edm::global, edm::stream, edm::one, or in rare cases edm::limited.
+  IntVectorProducer intVectorProducer
+%MSG
 Process name = PROD2
 paths:
   path1

FWCore/Integration/test/unit_test_outputs/testGetBy1.log

@@ -36,6 +36,11 @@ Module type=IntProducer, Module label=intProducerA, Parameter Set ID=38971365e81
 ++++ finished: constructing module with label 'intVectorProducer' id = 14
 ++ preallocate: 1 concurrent runs, 1 concurrent luminosity sections, 1 streams
 ++ starting: begin job
+The following legacy modules are configured. Support for legacy modules
+is going to end soon. These modules need to be converted to have type
+edm::global, edm::stream, edm::one, or in rare cases edm::limited.
+  IntVectorProducer intVectorProducer
+%MSG
 ++++ starting: begin job for module with label 'intProducerA' id = 9
 Module type=IntProducer, Module label=intProducerA, Parameter Set ID=38971365e8174cb2ccc12430661ba6d4
 ++++ finished: begin job for module with label 'intProducerA' id = 9

FWCore/Integration/test/unit_test_outputs/testGetBy2.log

@@ -22,6 +22,11 @@ Module type=IntProducer, Module label=intProducer, Parameter Set ID=0e62dace196e
 ++++ finished: constructing module with label 'intVectorProducer' id = 7
 ++ preallocate: 1 concurrent runs, 1 concurrent luminosity sections, 1 streams
 ++ starting: begin job
+The following legacy modules are configured. Support for legacy modules
+is going to end soon. These modules need to be converted to have type
+edm::global, edm::stream, edm::one, or in rare cases edm::limited.
+  IntVectorProducer intVectorProducer
+%MSG
 ++++ starting: begin job for module with label 'intProducerU' id = 6
 ++++ finished: begin job for module with label 'intProducerU' id = 6
 ++++ starting: begin job for module with label 'intVectorProducer' id = 7

FWCore/MessageService/test/UnitTestClient_A.cc

@@ -1,16 +1,21 @@
-#include "FWCore/MessageService/test/UnitTestClient_A.h"
-#include "FWCore/MessageLogger/interface/MessageLogger.h"
+#include "FWCore/Framework/interface/Frameworkfwd.h"
+#include "FWCore/Framework/interface/global/EDAnalyzer.h"
 #include "FWCore/Framework/interface/MakerMacros.h"
+#include "FWCore/MessageLogger/interface/MessageLogger.h"
+#include "FWCore/Utilities/interface/StreamID.h"
 
-#include <iostream>
 #include <string>
 
 namespace edmtest {
 
-  void UnitTestClient_A::analyze(edm::Event const& /*unused*/
-                                 ,
-                                 edm::EventSetup const& /*unused*/
-  ) {
+  class UnitTestClient_A : public edm::global::EDAnalyzer<> {
+  public:
+    explicit UnitTestClient_A(edm::ParameterSet const&) {}
+
+    void analyze(edm::StreamID, edm::Event const&, edm::EventSetup const&) const override;
+  };
+
+  void UnitTestClient_A::analyze(edm::StreamID, edm::Event const&, edm::EventSetup const&) const {
     std::string empty_;
     std::string file_ = "nameOfFile";
     LogDebug("cat_A") << "LogDebug was used to send this message";
@@ -24,8 +29,7 @@ namespace edmtest {
     edm::LogInfo("cat_A") << "LogInfo was used to send this message";
     edm::LogInfo("cat_B") << "LogInfo was used to send this other message";
     edm::LogInfo("FwkTest") << "<Message>LogInfo was used to send a job report</Message>";
-
-  }  // MessageLoggerClient::analyze()
+  }
 
 }  // namespace edmtest
 

FWCore/MessageService/test/UnitTestClient_Ad.cc

@@ -2,19 +2,24 @@
 #define EDM_ML_DEBUG
 #endif
 
-#include "FWCore/MessageService/test/UnitTestClient_Ad.h"
-#include "FWCore/MessageLogger/interface/MessageLogger.h"
+#include "FWCore/Framework/interface/Frameworkfwd.h"
+#include "FWCore/Framework/interface/global/EDAnalyzer.h"
 #include "FWCore/Framework/interface/MakerMacros.h"
+#include "FWCore/MessageLogger/interface/MessageLogger.h"
+#include "FWCore/Utilities/interface/StreamID.h"
 
-#include <iostream>
 #include <string>
 
 namespace edmtest {
 
-  void UnitTestClient_Ad::analyze(edm::Event const& /*unused*/
-                                  ,
-                                  edm::EventSetup const& /*unused*/
-  ) {
+  class UnitTestClient_Ad : public edm::global::EDAnalyzer<> {
+  public:
+    explicit UnitTestClient_Ad(edm::ParameterSet const&) {}
+
+    void analyze(edm::StreamID, edm::Event const&, edm::EventSetup const&) const override;
+  };
+
+  void UnitTestClient_Ad::analyze(edm::StreamID, edm::Event const&, edm::EventSetup const&) const {
     std::string empty_;
     std::string file_ = "nameOfFile";
     LogDebug("cat_A") << "LogDebug was used to send this message";
@@ -28,8 +33,7 @@ namespace edmtest {
     edm::LogInfo("cat_A") << "LogInfo was used to send this message";
     edm::LogInfo("cat_B") << "LogInfo was used to send this other message";
     edm::LogInfo("FwkTest") << "<Message>LogInfo was used to send a job report</Message>";
-
-  }  // MessageLoggerClient::analyze()
+  }
 
 }  // namespace edmtest
 

FWCore/MessageService/test/UnitTestClient_B.cc

@@ -1,25 +1,31 @@
-#include "FWCore/MessageService/test/UnitTestClient_B.h"
-#include "FWCore/MessageLogger/interface/MessageLogger.h"
-#include "FWCore/Framework/interface/MakerMacros.h"
+// UnitTestClient_B is used for testing LogStatistics and the reset behaviors
+// of statistics destinations.
 
-#include <iostream>
-#include <string>
+#include "FWCore/Framework/interface/Frameworkfwd.h"
+#include "FWCore/Framework/interface/MakerMacros.h"
+#include "FWCore/Framework/interface/one/EDAnalyzer.h"
+#include "FWCore/MessageLogger/interface/MessageLogger.h"
 
 namespace edmtest {
 
-  int UnitTestClient_B::nevent = 0;
+  class UnitTestClient_B : public edm::one::EDAnalyzer<> {
+  public:
+    explicit UnitTestClient_B(edm::ParameterSet const&) {}
+
+    void analyze(edm::Event const&, edm::EventSetup const&) override;
+
+  private:
+    int nevent = 0;
+  };
 
-  void UnitTestClient_B::analyze(edm::Event const& /*unused*/
-                                 ,
-                                 edm::EventSetup const& /*unused*/
-  ) {
+  void UnitTestClient_B::analyze(edm::Event const&, edm::EventSetup const&) {
     nevent++;
     for (int i = 0; i < nevent; ++i) {
       edm::LogError("cat_A") << "LogError was used to send this message";
     }
     edm::LogError("cat_B") << "LogError was used to send this other message";
     edm::LogStatistics();
-  }  // MessageLoggerClient::analyze()
+  }
 
 }  // namespace edmtest