File indexing completed on 2024-05-11 03:34:09
0001 #ifndef FWCore_Framework_global_EDProducerBase_h
0002 #define FWCore_Framework_global_EDProducerBase_h
0003
0004
0005
0006
0007
0008
0009
0010
0011
0012
0013
0014
0015
0016
0017
0018
0019
0020
0021
0022 #include <memory>
0023
0024
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
0033
0034 namespace edm {
0035 class ModuleCallingContext;
0036 class PreallocationConfiguration;
0037 class StreamID;
0038 class GlobalSchedule;
0039 class ActivityRegistry;
0040 class ThinnedAssociationsHelper;
0041 class WaitingTaskWithArenaHolder;
0042 class EventForTransformer;
0043 class ServiceWeakToken;
0044
0045 namespace maker {
0046 template <typename T>
0047 class ModuleHolderT;
0048 }
0049
0050 namespace global {
0051
0052 class EDProducerBase : public ProducerBase, public EDConsumerBase {
0053 public:
0054 template <typename T>
0055 friend class edm::maker::ModuleHolderT;
0056 template <typename T>
0057 friend class edm::WorkerT;
0058 typedef EDProducerBase ModuleType;
0059
0060 friend class edm::GlobalSchedule;
0061
0062 EDProducerBase();
0063 ~EDProducerBase() override;
0064
0065 static void fillDescriptions(ConfigurationDescriptions& descriptions);
0066 static void prevalidate(ConfigurationDescriptions& descriptions);
0067 static const std::string& baseType();
0068
0069
0070 ModuleDescription const& moduleDescription() const { return moduleDescription_; }
0071
0072 virtual bool wantsProcessBlocks() const noexcept = 0;
0073 virtual bool wantsInputProcessBlocks() const noexcept = 0;
0074 virtual bool wantsGlobalRuns() const noexcept = 0;
0075 virtual bool wantsGlobalLuminosityBlocks() const noexcept = 0;
0076 virtual bool wantsStreamRuns() const noexcept = 0;
0077 virtual bool wantsStreamLuminosityBlocks() const noexcept = 0;
0078
0079 private:
0080 bool doEvent(EventTransitionInfo const&, ActivityRegistry*, ModuleCallingContext const*);
0081 void doAcquire(EventTransitionInfo const&,
0082 ActivityRegistry*,
0083 ModuleCallingContext const*,
0084 WaitingTaskWithArenaHolder&);
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 void doBeginJob();
0093 void doEndJob();
0094
0095 void doBeginStream(StreamID);
0096 void doEndStream(StreamID);
0097 void doStreamBeginRun(StreamID, RunTransitionInfo const&, ModuleCallingContext const*);
0098 void doStreamEndRun(StreamID, RunTransitionInfo const&, ModuleCallingContext const*);
0099 void doStreamBeginLuminosityBlock(StreamID, LumiTransitionInfo const&, ModuleCallingContext const*);
0100 void doStreamEndLuminosityBlock(StreamID, LumiTransitionInfo const&, ModuleCallingContext const*);
0101
0102 void doBeginProcessBlock(ProcessBlockPrincipal const&, ModuleCallingContext const*);
0103 void doAccessInputProcessBlock(ProcessBlockPrincipal const&, ModuleCallingContext const*);
0104 void doEndProcessBlock(ProcessBlockPrincipal const&, ModuleCallingContext const*);
0105 void doBeginRun(RunTransitionInfo const&, ModuleCallingContext const*);
0106 void doEndRun(RunTransitionInfo const&, ModuleCallingContext const*);
0107 void doBeginLuminosityBlock(LumiTransitionInfo const&, ModuleCallingContext const*);
0108 void doEndLuminosityBlock(LumiTransitionInfo const&, ModuleCallingContext const*);
0109
0110 void doRespondToOpenInputFile(FileBlock const&) {}
0111 void doRespondToCloseInputFile(FileBlock const&) {}
0112 void doRespondToCloseOutputFile() { clearInputProcessBlockCaches(); }
0113 void doRegisterThinnedAssociations(ProductRegistry const&, ThinnedAssociationsHelper&) {}
0114
0115 void registerProductsAndCallbacks(EDProducerBase* module, ProductRegistry* reg) {
0116 registerProducts(module, reg, moduleDescription_);
0117 }
0118 std::string workerType() const { return "WorkerT<EDProducer>"; }
0119
0120 virtual void produce(StreamID, Event&, EventSetup const&) const = 0;
0121
0122 void preActionBeforeRunEventAsync(WaitingTaskHolder iTask,
0123 ModuleCallingContext const& iModuleCallingContext,
0124 Principal const& iPrincipal) const noexcept {}
0125
0126 virtual void beginJob() {}
0127 virtual void endJob() {}
0128
0129 virtual void preallocStreams(unsigned int);
0130 virtual void preallocRuns(unsigned int);
0131 virtual void preallocRunsSummary(unsigned int);
0132 virtual void preallocLumis(unsigned int);
0133 virtual void preallocLumisSummary(unsigned int);
0134 virtual void preallocate(PreallocationConfiguration const&);
0135 virtual void doBeginStream_(StreamID id);
0136 virtual void doEndStream_(StreamID id);
0137 virtual void doStreamBeginRun_(StreamID id, Run const& rp, EventSetup const& c);
0138 virtual void doStreamEndRun_(StreamID id, Run const& rp, EventSetup const& c);
0139 virtual void doStreamEndRunSummary_(StreamID id, Run const& rp, EventSetup const& c);
0140 virtual void doStreamBeginLuminosityBlock_(StreamID id, LuminosityBlock const& lbp, EventSetup const& c);
0141 virtual void doStreamEndLuminosityBlock_(StreamID id, LuminosityBlock const& lbp, EventSetup const& c);
0142 virtual void doStreamEndLuminosityBlockSummary_(StreamID id, LuminosityBlock const& lbp, EventSetup const& c);
0143
0144 virtual void doBeginProcessBlock_(ProcessBlock const&);
0145 virtual void doAccessInputProcessBlock_(ProcessBlock const&);
0146 virtual void doEndProcessBlock_(ProcessBlock const&);
0147 virtual void doBeginRun_(Run const& rp, EventSetup const& c);
0148 virtual void doBeginRunSummary_(Run const& rp, EventSetup const& c);
0149 virtual void doEndRunSummary_(Run const& rp, EventSetup const& c);
0150 virtual void doEndRun_(Run const& rp, EventSetup const& c);
0151 virtual void doBeginLuminosityBlock_(LuminosityBlock const& lbp, EventSetup const& c);
0152 virtual void doBeginLuminosityBlockSummary_(LuminosityBlock const& rp, EventSetup const& c);
0153 virtual void doEndLuminosityBlockSummary_(LuminosityBlock const& lb, EventSetup const& c);
0154 virtual void doEndLuminosityBlock_(LuminosityBlock const& lb, EventSetup const& c);
0155
0156 virtual void doBeginProcessBlockProduce_(ProcessBlock&);
0157 virtual void doEndProcessBlockProduce_(ProcessBlock&);
0158 virtual void doBeginRunProduce_(Run& rp, EventSetup const& c);
0159 virtual void doEndRunProduce_(Run& rp, EventSetup const& c);
0160 virtual void doBeginLuminosityBlockProduce_(LuminosityBlock& lbp, EventSetup const& c);
0161 virtual void doEndLuminosityBlockProduce_(LuminosityBlock& lbp, EventSetup const& c);
0162
0163 virtual size_t transformIndex_(edm::BranchDescription const& iBranch) const noexcept;
0164 virtual ProductResolverIndex transformPrefetch_(std::size_t iIndex) const noexcept;
0165 virtual void transformAsync_(WaitingTaskHolder iTask,
0166 std::size_t iIndex,
0167 edm::EventForTransformer& iEvent,
0168 edm::ActivityRegistry* iAct,
0169 ServiceWeakToken const& iToken) const noexcept;
0170
0171 virtual void clearInputProcessBlockCaches();
0172 virtual bool hasAccumulator() const noexcept { return false; }
0173
0174 virtual bool hasAcquire() const noexcept { return false; }
0175
0176 virtual void doAcquire_(StreamID, Event const&, edm::EventSetup const&, WaitingTaskWithArenaHolder&);
0177
0178 void setModuleDescription(ModuleDescription const& md) { moduleDescription_ = md; }
0179 ModuleDescription moduleDescription_;
0180 std::unique_ptr<std::vector<BranchID>[]> previousParentages_;
0181 std::unique_ptr<std::vector<BranchID>[]> gotBranchIDsFromAcquire_;
0182 std::unique_ptr<ParentageID[]> previousParentageIds_;
0183 };
0184
0185 }
0186 }
0187
0188 #endif