interface/global/EDProducerBase.h

0001 #ifndef FWCore_Framework_global_EDProducerBase_h
0002 #define FWCore_Framework_global_EDProducerBase_h
0003 // -*- C++ -*-
0004 //
0005 // Package:     FWCore/Framework
0006 // Class  :     EDProducerBase
0007 //
0008 /**\class EDProducerBase EDProducerBase.h "EDProducerBase.h"
0009
0010  Description: [one line class summary]
0011
0012  Usage:
0013     <usage>
0014
0015 */
0016 //
0017 // Original Author:  Chris Jones
0018 //         Created:  Thu, 18 Jul 2013 11:51:14 GMT
0019 //
0020
0021 // system include files
0022 #include <memory>
0023
0024 // user include files
0025 #include "FWCore/Framework/interface/ProducerBase.h"
0026 #include "FWCore/Framework/interface/EDConsumerBase.h"
0027 #include "FWCore/Framework/interface/Frameworkfwd.h"
0028 #include "DataFormats/Provenance/interface/ModuleDescription.h"
0029 #include "FWCore/ParameterSet/interface/ParameterSetfwd.h"
0030 #include "FWCore/Concurrency/interface/WaitingTaskHolder.h"
0031
0032 // forward declarations
0033
0034 namespace edm {
0035   class ModuleCallingContext;
0036   class PreallocationConfiguration;
0037   class StreamID;
0038   class GlobalSchedule;
0039   class ActivityRegistry;
0040   class ThinnedAssociationsHelper;
0041   class EventForTransformer;
0042   class ServiceWeakToken;
0043
0044   namespace maker {
0045     template <typename T>
0046     class ModuleHolderT;
0047   }
0048
0049   namespace global {
0050
0051     class EDProducerBase : public ProducerBase, public EDConsumerBase {
0052     public:
0053       template <typename T>
0054       friend class edm::maker::ModuleHolderT;
0055       template <typename T>
0056       friend class edm::WorkerT;
0057       typedef EDProducerBase ModuleType;
0058
0059       friend class edm::GlobalSchedule;
0060
0061       EDProducerBase();
0062       ~EDProducerBase() override;
0063
0064       static void fillDescriptions(ConfigurationDescriptions& descriptions);
0065       static void prevalidate(ConfigurationDescriptions& descriptions);
0066       static const std::string& baseType();
0067
0068       // Warning: the returned moduleDescription will be invalid during construction
0069       ModuleDescription const& moduleDescription() const { return moduleDescription_; }
0070
0071       virtual bool wantsProcessBlocks() const noexcept = 0;
0072       virtual bool wantsInputProcessBlocks() const noexcept = 0;
0073       virtual bool wantsGlobalRuns() const noexcept = 0;
0074       virtual bool wantsGlobalLuminosityBlocks() const noexcept = 0;
0075       virtual bool wantsStreamRuns() const noexcept = 0;
0076       virtual bool wantsStreamLuminosityBlocks() const noexcept = 0;
0077
0078     private:
0079       bool doEvent(EventTransitionInfo const&, ActivityRegistry*, ModuleCallingContext const*);
0080       void doAcquire(EventTransitionInfo const&, ActivityRegistry*, ModuleCallingContext const*, WaitingTaskHolder&&);
0081       void doTransformAsync(WaitingTaskHolder iTask,
0082                             size_t iTransformIndex,
0083                             EventPrincipal const& iEvent,
0084                             ActivityRegistry*,
0085                             ModuleCallingContext,
0086                             ServiceWeakToken const&) noexcept;
0087       void doPreallocate(PreallocationConfiguration const&);
0088       void doBeginJob();
0089       void doEndJob();
0090
0091       void doBeginStream(StreamID);
0092       void doEndStream(StreamID);
0093       void doStreamBeginRun(StreamID, RunTransitionInfo const&, ModuleCallingContext const*);
0094       void doStreamEndRun(StreamID, RunTransitionInfo const&, ModuleCallingContext const*);
0095       void doStreamBeginLuminosityBlock(StreamID, LumiTransitionInfo const&, ModuleCallingContext const*);
0096       void doStreamEndLuminosityBlock(StreamID, LumiTransitionInfo const&, ModuleCallingContext const*);
0097
0098       void doBeginProcessBlock(ProcessBlockPrincipal const&, ModuleCallingContext const*);
0099       void doAccessInputProcessBlock(ProcessBlockPrincipal const&, ModuleCallingContext const*);
0100       void doEndProcessBlock(ProcessBlockPrincipal const&, ModuleCallingContext const*);
0101       void doBeginRun(RunTransitionInfo const&, ModuleCallingContext const*);
0102       void doEndRun(RunTransitionInfo const&, ModuleCallingContext const*);
0103       void doBeginLuminosityBlock(LumiTransitionInfo const&, ModuleCallingContext const*);
0104       void doEndLuminosityBlock(LumiTransitionInfo const&, ModuleCallingContext const*);
0105
0106       void doRespondToOpenInputFile(FileBlock const&) {}
0107       void doRespondToCloseInputFile(FileBlock const&) {}
0108       void doRespondToCloseOutputFile() { clearInputProcessBlockCaches(); }
0109       void doRegisterThinnedAssociations(ProductRegistry const&, ThinnedAssociationsHelper&) {}
0110
0111       void registerProductsAndCallbacks(EDProducerBase* module, SignallingProductRegistryFiller* reg) {
0112         registerProducts(module, reg, moduleDescription_);
0113       }
0114       std::string workerType() const { return "WorkerT<EDProducer>"; }
0115
0116       virtual void produce(StreamID, Event&, EventSetup const&) const = 0;
0117       //For now this is a placeholder
0118       /*virtual*/ void preActionBeforeRunEventAsync(WaitingTaskHolder iTask,
0119                                                     ModuleCallingContext const& iModuleCallingContext,
0120                                                     Principal const& iPrincipal) const noexcept {}
0121
0122       virtual void beginJob() {}
0123       virtual void endJob() {}
0124
0125       virtual void preallocStreams(unsigned int);
0126       virtual void preallocRuns(unsigned int);
0127       virtual void preallocRunsSummary(unsigned int);
0128       virtual void preallocLumis(unsigned int);
0129       virtual void preallocLumisSummary(unsigned int);
0130       virtual void preallocate(PreallocationConfiguration const&);
0131       virtual void doBeginStream_(StreamID id);
0132       virtual void doEndStream_(StreamID id);
0133       virtual void doStreamBeginRun_(StreamID id, Run const& rp, EventSetup const& c);
0134       virtual void doStreamEndRun_(StreamID id, Run const& rp, EventSetup const& c);
0135       virtual void doStreamEndRunSummary_(StreamID id, Run const& rp, EventSetup const& c);
0136       virtual void doStreamBeginLuminosityBlock_(StreamID id, LuminosityBlock const& lbp, EventSetup const& c);
0137       virtual void doStreamEndLuminosityBlock_(StreamID id, LuminosityBlock const& lbp, EventSetup const& c);
0138       virtual void doStreamEndLuminosityBlockSummary_(StreamID id, LuminosityBlock const& lbp, EventSetup const& c);
0139
0140       virtual void doBeginProcessBlock_(ProcessBlock const&);
0141       virtual void doAccessInputProcessBlock_(ProcessBlock const&);
0142       virtual void doEndProcessBlock_(ProcessBlock const&);
0143       virtual void doBeginRun_(Run const& rp, EventSetup const& c);
0144       virtual void doBeginRunSummary_(Run const& rp, EventSetup const& c);
0145       virtual void doEndRunSummary_(Run const& rp, EventSetup const& c);
0146       virtual void doEndRun_(Run const& rp, EventSetup const& c);
0147       virtual void doBeginLuminosityBlock_(LuminosityBlock const& lbp, EventSetup const& c);
0148       virtual void doBeginLuminosityBlockSummary_(LuminosityBlock const& rp, EventSetup const& c);
0149       virtual void doEndLuminosityBlockSummary_(LuminosityBlock const& lb, EventSetup const& c);
0150       virtual void doEndLuminosityBlock_(LuminosityBlock const& lb, EventSetup const& c);
0151
0152       virtual void doBeginProcessBlockProduce_(ProcessBlock&);
0153       virtual void doEndProcessBlockProduce_(ProcessBlock&);
0154       virtual void doBeginRunProduce_(Run& rp, EventSetup const& c);
0155       virtual void doEndRunProduce_(Run& rp, EventSetup const& c);
0156       virtual void doBeginLuminosityBlockProduce_(LuminosityBlock& lbp, EventSetup const& c);
0157       virtual void doEndLuminosityBlockProduce_(LuminosityBlock& lbp, EventSetup const& c);
0158
0159       virtual size_t transformIndex_(edm::ProductDescription const& iBranch) const noexcept;
0160       virtual ProductResolverIndex transformPrefetch_(std::size_t iIndex) const noexcept;
0161       virtual void transformAsync_(WaitingTaskHolder iTask,
0162                                    std::size_t iIndex,
0163                                    edm::EventForTransformer& iEvent,
0164                                    edm::ActivityRegistry* iAct,
0165                                    ServiceWeakToken const& iToken) const noexcept;
0166
0167       virtual void clearInputProcessBlockCaches();
0168       virtual bool hasAccumulator() const noexcept { return false; }
0169
0170       virtual bool hasAcquire() const noexcept { return false; }
0171
0172       virtual void doAcquire_(StreamID, Event const&, edm::EventSetup const&, WaitingTaskHolder&&);
0173
0174       void setModuleDescription(ModuleDescription const& md) { moduleDescription_ = md; }
0175       ModuleDescription moduleDescription_;
0176       std::unique_ptr<std::vector<BranchID>[]> previousParentages_;
0177       std::unique_ptr<std::vector<BranchID>[]> gotBranchIDsFromAcquire_;
0178       std::unique_ptr<ParentageID[]> previousParentageIds_;
0179     };
0180
0181   }  // namespace global
0182 }  // namespace edm
0183
0184 #endif