/
ProducingModuleAdaptorBase.h
188 lines (150 loc) · 7.58 KB
/
ProducingModuleAdaptorBase.h
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
#ifndef FWCore_Framework_stream_ProducingModuleAdaptorBase_h
#define FWCore_Framework_stream_ProducingModuleAdaptorBase_h
// -*- C++ -*-
//
// Package: FWCore/Framework
// Class : ProducingModuleAdaptorBase
//
/**\class edm::stream::ProducingModuleAdaptorBase ProducingModuleAdaptorBase.h "FWCore/Framework/interface/stream/ProducingModuleAdaptorBase.h"
Description: [one line class summary]
Usage:
<usage>
*/
//
// Original Author: Chris Jones
// Created: Fri, 02 Aug 2013 18:09:15 GMT
//
// system include files
#include <map>
#include <string>
#include <vector>
#include <unordered_map>
// user include files
#include "DataFormats/Provenance/interface/BranchType.h"
#include "FWCore/Utilities/interface/ProductResolverIndex.h"
#include "FWCore/Framework/interface/Frameworkfwd.h"
#include "DataFormats/Provenance/interface/ModuleDescription.h"
#include "FWCore/ParameterSet/interface/ParameterSetfwd.h"
#include "FWCore/Utilities/interface/StreamID.h"
#include "FWCore/Utilities/interface/RunIndex.h"
#include "FWCore/Utilities/interface/LuminosityBlockIndex.h"
#include "FWCore/Framework/interface/Event.h"
#include "FWCore/Framework/interface/Run.h"
#include "FWCore/Framework/interface/LuminosityBlock.h"
#include "FWCore/ServiceRegistry/interface/ConsumesInfo.h"
// forward declarations
namespace edm {
class Event;
class ModuleCallingContext;
class ProductResolverIndexHelper;
class EDConsumerBase;
class PreallocationConfiguration;
class ProductResolverIndexAndSkipBit;
class ProductRegistry;
class ThinnedAssociationsHelper;
namespace maker {
template <typename T>
class ModuleHolderT;
}
namespace eventsetup {
class ESRecordsToProxyIndices;
}
namespace stream {
template <typename T>
class ProducingModuleAdaptorBase {
public:
template <typename U>
friend class edm::WorkerT;
template <typename U>
friend class edm::maker::ModuleHolderT;
ProducingModuleAdaptorBase();
virtual ~ProducingModuleAdaptorBase();
// ---------- const member functions ---------------------
// ---------- static member functions --------------------
// ---------- member functions ---------------------------
const ModuleDescription& moduleDescription() const { return moduleDescription_; }
virtual bool wantsGlobalRuns() const = 0;
virtual bool wantsGlobalLuminosityBlocks() const = 0;
virtual bool hasAcquire() const = 0;
virtual bool hasAccumulator() const = 0;
bool wantsStreamRuns() const { return true; }
bool wantsStreamLuminosityBlocks() const { return true; }
void registerProductsAndCallbacks(ProducingModuleAdaptorBase const*, ProductRegistry* reg);
void itemsToGet(BranchType, std::vector<ProductResolverIndexAndSkipBit>&) const;
void itemsMayGet(BranchType, std::vector<ProductResolverIndexAndSkipBit>&) const;
std::vector<ProductResolverIndexAndSkipBit> const& itemsToGetFrom(BranchType) const;
void updateLookup(BranchType iBranchType, ProductResolverIndexHelper const&, bool iPrefetchMayGet);
void updateLookup(eventsetup::ESRecordsToProxyIndices const&);
void modulesWhoseProductsAreConsumed(std::vector<ModuleDescription const*>& modules,
ProductRegistry const& preg,
std::map<std::string, ModuleDescription const*> const& labelsToDesc,
std::string const& processName) const;
void convertCurrentProcessAlias(std::string const& processName);
std::vector<ConsumesInfo> consumesInfo() const;
using ModuleToResolverIndicies =
std::unordered_multimap<std::string, std::tuple<edm::TypeID const*, const char*, edm::ProductResolverIndex>>;
void resolvePutIndicies(BranchType iBranchType,
ModuleToResolverIndicies const& iIndicies,
std::string const& moduleLabel);
std::vector<edm::ProductResolverIndex> const& indiciesForPutProducts(BranchType iBranchType) const;
protected:
template <typename F>
void createStreamModules(F iFunc) {
for (auto& m : m_streamModules) {
m = iFunc();
m->setModuleDescriptionPtr(&moduleDescription_);
}
}
void commit(Run& iRun) { iRun.commit_(m_streamModules[0]->indiciesForPutProducts(InRun)); }
void commit(LuminosityBlock& iLumi) { iLumi.commit_(m_streamModules[0]->indiciesForPutProducts(InLumi)); }
template <typename I>
void commit(Event& iEvent, I* iID) {
iEvent.commit_(m_streamModules[0]->indiciesForPutProducts(InEvent), iID);
}
const EDConsumerBase* consumer() { return m_streamModules[0]; }
const ProducerBase* producer() { return m_streamModules[0]; }
private:
ProducingModuleAdaptorBase(const ProducingModuleAdaptorBase&) = delete; // stop default
const ProducingModuleAdaptorBase& operator=(const ProducingModuleAdaptorBase&) = delete; // stop default
void doPreallocate(PreallocationConfiguration const&);
virtual void preallocLumis(unsigned int) {}
virtual void setupStreamModules() = 0;
virtual void doBeginJob() = 0;
virtual void doEndJob() = 0;
void doBeginStream(StreamID id);
void doEndStream(StreamID id);
void doStreamBeginRun(StreamID id, RunPrincipal const& ep, EventSetupImpl const& c, ModuleCallingContext const*);
virtual void setupRun(T*, RunIndex) = 0;
void doStreamEndRun(StreamID id, RunPrincipal const& ep, EventSetupImpl const& c, ModuleCallingContext const*);
virtual void streamEndRunSummary(T*, edm::Run const&, edm::EventSetup const&) = 0;
void doStreamBeginLuminosityBlock(StreamID id,
LuminosityBlockPrincipal const& ep,
EventSetupImpl const& c,
ModuleCallingContext const*);
virtual void setupLuminosityBlock(T*, LuminosityBlockIndex) = 0;
void doStreamEndLuminosityBlock(StreamID id,
LuminosityBlockPrincipal const& ep,
EventSetupImpl const& c,
ModuleCallingContext const*);
virtual void streamEndLuminosityBlockSummary(T*, edm::LuminosityBlock const&, edm::EventSetup const&) = 0;
virtual void doBeginRun(RunPrincipal const& rp, EventSetupImpl const& c, ModuleCallingContext const*) = 0;
virtual void doEndRun(RunPrincipal const& rp, EventSetupImpl const& c, ModuleCallingContext const*) = 0;
virtual void doBeginLuminosityBlock(LuminosityBlockPrincipal const& lbp,
EventSetupImpl const& c,
ModuleCallingContext const*) = 0;
virtual void doEndLuminosityBlock(LuminosityBlockPrincipal const& lbp,
EventSetupImpl const& c,
ModuleCallingContext const*) = 0;
//For now, the following are just dummy implemenations with no ability for users to override
void doRespondToOpenInputFile(FileBlock const& fb);
void doRespondToCloseInputFile(FileBlock const& fb);
void doRegisterThinnedAssociations(ProductRegistry const&, ThinnedAssociationsHelper&);
// ---------- member data --------------------------------
void setModuleDescription(ModuleDescription const& md) { moduleDescription_ = md; }
ModuleDescription moduleDescription_;
protected:
std::vector<T*> m_streamModules;
};
} // namespace stream
} // namespace edm
#endif