Migrate Generators to New Random Service Interface

Migrate generators to use the new interface of the
random number generator service designed to work
with the multithreaded Framework. The main interface
change is to require a StreamID or LuminosityBlockIndex
argument to the getEngine function. In most cases,
this required moving code from the constructor to
the event or beginLuminosityBlock method. Then a pointer
to the engine was percolated or passed in some way
to the point where it was used.

In some cases, I added declarations of shared resources
where it was obvious they were needed, but I did not
thoroughly check for and declare all shared resources
that will eventually be needed.

Note that this was done in two parts. The first pull
request was already merged into 7_0_X some time ago.
It took care of Pythia 8 and ExternalDecays. The
rest of the generators are taken care of in this pull
request.

Note that the content of this pull request is almost
identical to pull requests 1982 and 2150. Pull request
1982 was signed by all L2's. The only differences are
related to resolving conflicts that occurred when
unrelated development was merged in. It was also rebased
twice.

Author: wddgit

FWCore/Concurrency/interface/SharedResourceNames.h

@@ -28,6 +28,7 @@ namespace edm {
     static const std::string kPhotos;
     static const std::string kTauola;
     static const std::string kEvtGen;
+    static const std::string kHerwig6;
   };
 
   // Each time the following function is called, it returns a different

FWCore/Concurrency/src/SharedResourceNames.cc

@@ -10,6 +10,7 @@ const std::string edm::SharedResourceNames::kPythia8 = "Pythia8";
 const std::string edm::SharedResourceNames::kPhotos = "Photos";
 const std::string edm::SharedResourceNames::kTauola = "Tauola";
 const std::string edm::SharedResourceNames::kEvtGen = "EvtGen";
+const std::string edm::SharedResourceNames::kHerwig6 = "Herwig6";
 
 static std::atomic<unsigned int> counter;
 

FWCore/ServiceRegistry/interface/RandomEngineSentry.h

@@ -26,42 +26,45 @@ namespace edm {
   template <class T> class RandomEngineSentry {
   public:
 
-    explicit RandomEngineSentry(T* t, CLHEP::HepRandomEngine* engine): t_(t) {
+    explicit RandomEngineSentry(T* t, CLHEP::HepRandomEngine* engine): t_(t), engine_(engine) {
       if(t) {
         t->setRandomEngine(engine);
       }
     }
 
-    explicit RandomEngineSentry(T* t, StreamID const& streamID): t_(t) {
+    explicit RandomEngineSentry(T* t, StreamID const& streamID): t_(t), engine_(nullptr) {
       if(t) {
         Service<RandomNumberGenerator> rng;
         if (!rng.isAvailable()) {
           throw cms::Exception("Configuration")
               << "Attempt to get a random engine when the RandomNumberGeneratorService is not configured.\n"
                  "You must configure the service if you want an engine.\n";
         }
-        CLHEP::HepRandomEngine& engine = rng->getEngine(streamID);
-        t->setRandomEngine(&engine);
+        engine_ = &rng->getEngine(streamID);
+        t->setRandomEngine(engine_);
       }
     }
 
-    explicit RandomEngineSentry(T* t, LuminosityBlockIndex const& lumi): t_(t) {
+    explicit RandomEngineSentry(T* t, LuminosityBlockIndex const& lumi): t_(t), engine_(nullptr) {
       if(t) {
         Service<RandomNumberGenerator> rng;
         if (!rng.isAvailable()) {
           throw cms::Exception("Configuration")
               << "Attempt to get a random engine when the RandomNumberGeneratorService is not configured.\n"
                  "You must configure the service if you want an engine.\n";
         }
-        CLHEP::HepRandomEngine& engine = rng->getEngine(lumi);
-        t->setRandomEngine(&engine);
+        engine_ = &rng->getEngine(lumi);
+        t->setRandomEngine(engine_);
       }
     }
 
     ~RandomEngineSentry() { if(t_) t_->setRandomEngine(nullptr); }
 
+    CLHEP::HepRandomEngine* randomEngine() const { return engine_; }
+
   private:
     T* t_;
+    CLHEP::HepRandomEngine* engine_;
   };
 }
 #endif

GeneratorInterface/AMPTInterface/interface/AMPTHadronizer.h

@@ -3,7 +3,6 @@
 
 #include "FWCore/ParameterSet/interface/ParameterSet.h"
 #include "GeneratorInterface/Core/interface/BaseHadronizer.h"
-#include "CLHEP/Random/RandomEngine.h"
 
 #include <map>
 #include <string>
@@ -16,7 +15,9 @@ namespace HepMC {
   class GenVertex;
 }
 
-extern CLHEP::HepRandomEngine* _amptRandomEngine;
+namespace CLHEP {
+  class HepRandomEngine;
+}
 
 namespace gen
 {
@@ -50,6 +51,8 @@ namespace gen
 
   private:
 
+    virtual void doSetRandomEngine(CLHEP::HepRandomEngine* v) override;
+
     void					add_heavy_ion_rec(HepMC::GenEvent *evt);
     HepMC::GenParticle*	                        build_ampt( int index, int barcode );	
     HepMC::GenVertex*                           build_ampt_vertex(int i, int id);

GeneratorInterface/AMPTInterface/src/AMPTHadronizer.cc

@@ -7,10 +7,6 @@
 #include "FWCore/Framework/interface/Run.h"
 #include "FWCore/MessageLogger/interface/MessageLogger.h"
 #include "FWCore/ParameterSet/interface/ParameterSet.h"
-#include "FWCore/ServiceRegistry/interface/Service.h"
-#include "FWCore/Utilities/interface/RandomNumberGenerator.h"
-#include "FWCore/Utilities/interface/EDMException.h"
-#include "GeneratorInterface/Core/interface/RNDMEngineAccess.h"
 
 #include "GeneratorInterface/AMPTInterface/interface/AMPTHadronizer.h"
 #include "GeneratorInterface/AMPTInterface/interface/AMPTWrapper.h"
@@ -30,14 +26,14 @@ using namespace edm;
 using namespace std;
 using namespace gen;
 
-CLHEP::HepRandomEngine* _amptRandomEngine;
+static CLHEP::HepRandomEngine* amptRandomEngine;
 
 extern "C"
 {
   float gen::ranart_(int *idummy)
   {
     if(0) idummy = idummy; 
-    float rannum = _amptRandomEngine->flat();
+    float rannum = amptRandomEngine->flat();
     return rannum;
   }
 }
@@ -47,7 +43,7 @@ extern "C"
   float gen::ran1_(int *idummy)
   {
     if(0) idummy = idummy;
-    return _amptRandomEngine->flat();
+    return amptRandomEngine->flat();
   }
 }
 
@@ -100,17 +96,19 @@ AMPTHadronizer::AMPTHadronizer(const ParameterSet &pset) :
     cosphi0_(1.),
     rotate_(pset.getParameter<bool>("rotateEventPlane"))
 {
-  // Default constructor
-  edm::Service<RandomNumberGenerator> rng;
-  _amptRandomEngine = &(rng->getEngine());
 }
 
-
 //_____________________________________________________________________
 AMPTHadronizer::~AMPTHadronizer()
 {
 }
 
+//_____________________________________________________________________
+void AMPTHadronizer::doSetRandomEngine(CLHEP::HepRandomEngine* v)
+{
+  amptRandomEngine = v;
+}
+
 //_____________________________________________________________________
 void AMPTHadronizer::add_heavy_ion_rec(HepMC::GenEvent *evt)
 {

GeneratorInterface/BeamHaloGenerator/interface/BeamHaloProducer.h

@@ -10,19 +10,26 @@
 
 #include "FWCore/Framework/interface/one/EDProducer.h"
 #include "FWCore/Framework/interface/Event.h"
+#include "FWCore/Framework/interface/LuminosityBlock.h"
 #include "FWCore/Framework/interface/Run.h"
 #include "FWCore/ParameterSet/interface/ParameterSet.h"
 
+namespace CLHEP {
+  class HepRandomEngine;
+}
+
 namespace edm
 {
-  class BeamHaloProducer : public one::EDProducer<EndRunProducer> {
+  class BeamHaloProducer : public one::EDProducer<EndRunProducer, one::WatchLuminosityBlocks> {
   public:
 
     /// Constructor
     BeamHaloProducer(const ParameterSet &);
     /// Destructor
     virtual ~BeamHaloProducer();
 
+    void setRandomEngine(CLHEP::HepRandomEngine* v);
+
   private:
 	bool call_ki_bhg_init(long& seed);
         bool call_bh_set_parameters(int* ival, float* fval,const std::string cval_string);
@@ -31,8 +38,10 @@ namespace edm
 
   private:
 
-    virtual void produce(Event & e, const EventSetup & es);
-    virtual void endRunProduce(Run & r, const EventSetup & es);
+    virtual void produce(Event & e, const EventSetup & es) override;
+    virtual void endRunProduce(Run & r, const EventSetup & es) override;
+    virtual void beginLuminosityBlock(LuminosityBlock const&, EventSetup const&) override;
+    virtual void endLuminosityBlock(LuminosityBlock const&, EventSetup const&) override { }
 
     void clear();
 
@@ -46,6 +55,8 @@ namespace edm
 	float EG_MIN_;
 	float EG_MAX_;
 	std::string G3FNAME_;
+
+    bool isInitialized_;
   };
 
 }

GeneratorInterface/BeamHaloGenerator/src/BeamHaloProducer.cc

@@ -3,9 +3,8 @@
 
 #include "FWCore/Framework/interface/Event.h"
 #include "FWCore/Framework/interface/Run.h"
-#include "FWCore/ServiceRegistry/interface/Service.h"
+#include "FWCore/ServiceRegistry/interface/RandomEngineSentry.h"
 #include "FWCore/Utilities/interface/Exception.h"
-#include "FWCore/Utilities/interface/RandomNumberGenerator.h"
 
 #include "SimDataFormats/GeneratorProducts/interface/HepMCProduct.h"
 #include "SimDataFormats/GeneratorProducts/interface/GenRunInfoProduct.h"
@@ -58,7 +57,8 @@ BeamHaloProducer::~BeamHaloProducer() {
 
 
 BeamHaloProducer::BeamHaloProducer( const ParameterSet & pset) :
-	evt(0)
+  evt(0),
+  isInitialized_(false)
 {
 
    int iparam[8];
@@ -83,17 +83,6 @@ BeamHaloProducer::BeamHaloProducer( const ParameterSet & pset) :
    cparam     = pset.getUntrackedParameter<std::string>("G3FNAME","input.txt");
    call_bh_set_parameters(iparam,fparam,cparam);
 
-
-// -- Seed for randomnumbers
-    Service<RandomNumberGenerator> rng;
-    _BeamHalo_randomEngine = &(rng->getEngine());
-    long seed = (long)(rng->mySeed());
-
-
-// -- initialisation
-   call_ki_bhg_init(seed);
-
-
   produces<HepMCProduct>();
   produces<GenEventInfoProduct>();
   produces<GenRunInfoProduct, InRun>();
@@ -106,7 +95,26 @@ void BeamHaloProducer::clear()
 {
 }
 
+void BeamHaloProducer::setRandomEngine(CLHEP::HepRandomEngine* v) {
+  _BeamHalo_randomEngine = v;
+}
+
+void BeamHaloProducer::beginLuminosityBlock(LuminosityBlock const& lumi, EventSetup const&)
+{
+  if(!isInitialized_) {
+    isInitialized_ = true;
+    RandomEngineSentry<BeamHaloProducer> randomEngineSentry(this, lumi.index());
+
+    // -- initialisation
+    long seed = 1; // This seed is not actually used
+    call_ki_bhg_init(seed);
+  }
+}
+
 void BeamHaloProducer::produce(Event & e, const EventSetup & es) {
+
+  RandomEngineSentry<BeamHaloProducer> randomEngineSentry(this, e.streamID());
+
 	// cout << "in produce " << endl;
 
   //    	auto_ptr<HepMCProduct> bare_product(new HepMCProduct());

GeneratorInterface/CascadeInterface/BuildFile.xml

@@ -1,4 +1,5 @@
 <use   name="boost"/>
+<use   name="FWCore/Concurrency"/>
 <use   name="FWCore/Framework"/>
 <use   name="SimDataFormats/GeneratorProducts"/>
 <use   name="GeneratorInterface/Core"/>

GeneratorInterface/CascadeInterface/plugins/Cascade2Hadronizer.cc

@@ -1,8 +1,5 @@
 #include "GeneratorInterface/CascadeInterface/plugins/Cascade2Hadronizer.h"
 
-#include "GeneratorInterface/Core/interface/RNDMEngineAccess.h"
-
-
 #include "HepMC/GenEvent.h" 
 #include "HepMC/PdfInfo.h"
 #include "HepMC/PythiaWrapper6_4.h"  
@@ -12,17 +9,16 @@
 #include "HepMC/IO_HEPEVT.h"
 #include "HepMC/IO_GenEvent.h"
 
+#include "FWCore/Concurrency/interface/SharedResourceNames.h"
 #include "FWCore/MessageLogger/interface/MessageLogger.h"
 #include "GeneratorInterface/Core/interface/FortranCallback.h"
+#include "GeneratorInterface/Core/interface/FortranInstance.h"
 
 HepMC::IO_HEPEVT hepevtio;
 
 #include "HepPID/ParticleIDTranslations.hh"
 
-#include "FWCore/ServiceRegistry/interface/Service.h"
-#include "FWCore/Utilities/interface/RandomNumberGenerator.h"
-#include "CLHEP/Random/RandFlat.h"
-#include "FWCore/Utilities/interface/Exception.h"
+#include "FWCore/Utilities/interface/EDMException.h"
 
 //-- Pythia6 routines and functionalities to pass around Pythia6 params
 
@@ -31,20 +27,22 @@ HepMC::IO_HEPEVT hepevtio;
 
 #include "SimDataFormats/GeneratorProducts/interface/GenRunInfoProduct.h"
 
+#include "CLHEP/Random/RandomEngine.h"
+
 using namespace edm;
 using namespace std;
 
 #define debug 0
 
-CLHEP::RandFlat* fFlat_extern;
+static CLHEP::HepRandomEngine* cascade2RandomEngine;
 
 extern "C" {
 
   double dcasrn_(int *idummy) {
 
     static int call = 0;
 
-    double rdm_nb = fFlat_extern->fire();
+    double rdm_nb = cascade2RandomEngine->flat();
 
     if(debug && ++call < 100) cout<<"dcasrn from c++, call: "<<call<<" random number: "<<rdm_nb<<endl;
 
@@ -54,7 +52,7 @@ extern "C" {
 
 
 namespace gen {
-  
+
   class Pythia6ServiceWithCallback : public Pythia6Service {
 
   public:
@@ -82,16 +80,12 @@ namespace gen {
     double p[5][pyjets_maxn], v[5][pyjets_maxn];
   } pyjets_local;
 
+  const std::vector<std::string> Cascade2Hadronizer::theSharedResources = { edm::SharedResourceNames::kPythia6,
+                                                                            gen::FortranInstance::kFortranInstance };
+
   Cascade2Hadronizer::Cascade2Hadronizer(edm::ParameterSet const& pset) 
     : BaseHadronizer(pset),
       fPy6Service(new Pythia6ServiceWithCallback(pset)), //-- this will store py6 parameters for further settings 
-      
-      //-- fRandomEngine(&getEngineReference()),
-
-      //-- defined in GeneratorInterface/Core/src/RNDMEngineAccess.cc
-      //-- CLHEP::HepRandomEngine& gen::getEngineReference()
-      //-- { edm::Service<edm::RandomNumberGenerator> rng;
-      //--  return rng->getEngine(); }
 
       fComEnergy(pset.getParameter<double>("comEnergy")),
       fextCrossSection(pset.getUntrackedParameter<double>("crossSection",-1.)),
@@ -107,12 +101,6 @@ namespace gen {
 
     fParameters = pset.getParameter<ParameterSet>("Cascade2Parameters");
 
-    edm::Service<edm::RandomNumberGenerator> rng;
-    if(debug) cout<<"seed: "<<rng->mySeed()<<endl;
-    CLHEP::HepRandomEngine& engine = rng->getEngine();
-    fFlat = new CLHEP::RandFlat(engine);
-    fFlat_extern = fFlat;
-
     fConvertToPDG = false;
     if(pset.exists("doPDGConvert"))
       fConvertToPDG = pset.getParameter<bool>("doPDGConvert");
@@ -143,6 +131,11 @@ namespace gen {
     if(fPy6Service != 0) delete fPy6Service;
   }
 
+  void Cascade2Hadronizer::doSetRandomEngine(CLHEP::HepRandomEngine* v) {
+    cascade2RandomEngine = v;
+    fPy6Service->setRandomEngine(v);
+  }
+
   void Cascade2Hadronizer::flushTmpStorage(){
 
     pyjets_local.n = 0 ;