Back to home page

Project CMSSW displayed by LXR

 
 

    


File indexing completed on 2022-09-11 22:29:26

0001 #ifndef FWCore_Framework_limited_EDFilterBase_h
0002 #define FWCore_Framework_limited_EDFilterBase_h
0003 // -*- C++ -*-
0004 //
0005 // Package:     FWCore/Framework
0006 // Class  :     EDFilterBase
0007 //
0008 /**\class EDFilterBase EDFilterBase.h "EDFilterBase.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/LimitedTaskQueue.h"
0031 #include "FWCore/Concurrency/interface/WaitingTaskHolder.h"
0032 
0033 // forward declarations
0034 
0035 namespace edm {
0036   class ModuleCallingContext;
0037   class PreallocationConfiguration;
0038   class StreamID;
0039   class ActivityRegistry;
0040   class ThinnedAssociationsHelper;
0041   class EventForTransformer;
0042 
0043   namespace maker {
0044     template <typename T>
0045     class ModuleHolderT;
0046   }
0047 
0048   namespace limited {
0049 
0050     class EDFilterBase : 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 EDFilterBase ModuleType;
0057 
0058       EDFilterBase(ParameterSet const& pset);
0059       ~EDFilterBase() 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 = 0;
0069       virtual bool wantsInputProcessBlocks() const = 0;
0070       virtual bool wantsGlobalRuns() const = 0;
0071       virtual bool wantsGlobalLuminosityBlocks() const = 0;
0072       virtual bool wantsStreamRuns() const = 0;
0073       virtual bool wantsStreamLuminosityBlocks() const = 0;
0074 
0075       unsigned int concurrencyLimit() const { return queue_.concurrencyLimit(); }
0076 
0077       LimitedTaskQueue& queue() { return queue_; }
0078 
0079     private:
0080       bool doEvent(EventTransitionInfo const&, ActivityRegistry*, ModuleCallingContext const*);
0081       void doTransform(size_t iTransformIndex,
0082                        EventPrincipal const& iEvent,
0083                        ActivityRegistry*,
0084                        ModuleCallingContext const*);
0085 
0086       //For now this is a placeholder
0087       /*virtual*/ void preActionBeforeRunEventAsync(WaitingTaskHolder,
0088                                                     ModuleCallingContext const&,
0089                                                     Principal const&) const {}
0090 
0091       void doPreallocate(PreallocationConfiguration const&);
0092       void doBeginJob();
0093       void doEndJob();
0094 
0095       void doBeginStream(StreamID id);
0096       void doEndStream(StreamID id);
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(EDFilterBase* module, ProductRegistry* reg) {
0116         registerProducts(module, reg, moduleDescription_);
0117       }
0118       std::string workerType() const { return "WorkerT<EDProducer>"; }
0119 
0120       virtual bool filter(StreamID, Event&, EventSetup const&) const = 0;
0121       virtual void beginJob() {}
0122       virtual void endJob() {}
0123 
0124       virtual void preallocStreams(unsigned int);
0125       virtual void preallocLumis(unsigned int);
0126       virtual void preallocLumisSummary(unsigned int);
0127       virtual void preallocate(PreallocationConfiguration const&);
0128       virtual void doBeginStream_(StreamID id);
0129       virtual void doEndStream_(StreamID id);
0130       virtual void doStreamBeginRun_(StreamID id, Run const& rp, EventSetup const& c);
0131       virtual void doStreamEndRun_(StreamID id, Run const& rp, EventSetup const& c);
0132       virtual void doStreamEndRunSummary_(StreamID id, Run const& rp, EventSetup const& c);
0133       virtual void doStreamBeginLuminosityBlock_(StreamID id, LuminosityBlock const& lbp, EventSetup const& c);
0134       virtual void doStreamEndLuminosityBlock_(StreamID id, LuminosityBlock const& lbp, EventSetup const& c);
0135       virtual void doStreamEndLuminosityBlockSummary_(StreamID id, LuminosityBlock const& lbp, EventSetup const& c);
0136 
0137       virtual void doBeginProcessBlock_(ProcessBlock const&);
0138       virtual void doAccessInputProcessBlock_(ProcessBlock const&);
0139       virtual void doEndProcessBlock_(ProcessBlock const&);
0140       virtual void doBeginRun_(Run const& rp, EventSetup const& c);
0141       virtual void doBeginRunSummary_(Run const& rp, EventSetup const& c);
0142       virtual void doEndRunSummary_(Run const& rp, EventSetup const& c);
0143       virtual void doEndRun_(Run const& rp, EventSetup const& c);
0144       virtual void doBeginLuminosityBlock_(LuminosityBlock const& lbp, EventSetup const& c);
0145       virtual void doBeginLuminosityBlockSummary_(LuminosityBlock const& rp, EventSetup const& c);
0146       virtual void doEndLuminosityBlockSummary_(LuminosityBlock const& lb, EventSetup const& c);
0147       virtual void doEndLuminosityBlock_(LuminosityBlock const& lb, EventSetup const& c);
0148 
0149       virtual void doBeginProcessBlockProduce_(ProcessBlock&);
0150       virtual void doEndProcessBlockProduce_(ProcessBlock&);
0151       virtual void doBeginRunProduce_(Run& rp, EventSetup const& c);
0152       virtual void doEndRunProduce_(Run& rp, EventSetup const& c);
0153       virtual void doBeginLuminosityBlockProduce_(LuminosityBlock& lbp, EventSetup const& c);
0154       virtual void doEndLuminosityBlockProduce_(LuminosityBlock& lbp, EventSetup const& c);
0155 
0156       virtual size_t transformIndex_(edm::BranchDescription const& iBranch) const;
0157       virtual ProductResolverIndex transformPrefetch_(std::size_t iIndex) const;
0158       virtual void transform_(std::size_t iIndex, edm::EventForTransformer& iEvent) const;
0159 
0160       virtual void clearInputProcessBlockCaches();
0161 
0162       bool hasAcquire() const { return false; }
0163       bool hasAccumulator() const { return false; }
0164 
0165       void setModuleDescription(ModuleDescription const& md) { moduleDescription_ = md; }
0166       ModuleDescription moduleDescription_;
0167       std::unique_ptr<std::vector<BranchID>[]> previousParentages_;  //Per stream in the future?
0168       std::unique_ptr<ParentageID[]> previousParentageIds_;
0169 
0170       LimitedTaskQueue queue_;
0171     };
0172 
0173   }  // namespace limited
0174 }  // namespace edm
0175 
0176 #endif