interface/one/EDProducerBase.h

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