Project
Loading...
Searching...
No Matches
GPUWorkflowSpec.h
Go to the documentation of this file.
1// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
2// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
3// All rights not expressly granted are reserved.
4//
5// This software is distributed under the terms of the GNU General Public
6// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
7//
8// In applying this license CERN does not waive the privileges and immunities
9// granted to it by virtue of its status as an Intergovernmental Organization
10// or submit itself to any jurisdiction.
11
16
17#ifndef O2_GPU_WORKFLOW_SPEC_H
18#define O2_GPU_WORKFLOW_SPEC_H
19
21#include "Framework/Task.h"
25#include "Algorithm/Parser.h"
26#include <string>
27#include <array>
28#include <vector>
29#include <mutex>
30#include <functional>
31#include <queue>
32
33class TStopwatch;
34namespace fair::mq
35{
36struct RegionInfo;
37enum class State : int32_t;
38} // namespace fair::mq
39namespace o2
40{
41namespace base
42{
43struct GRPGeomRequest;
44} // namespace base
45namespace tpc
46{
47class CalibdEdxContainer;
48struct ClusterGroupHeader;
49class VDriftHelper;
50class CorrectionMapsLoader;
51class DeadChannelMapCreator;
52} // namespace tpc
53
54namespace trd
55{
56class GeometryFlat;
57} // namespace trd
58
59namespace its
60{
61template <int>
62class TimeFrame;
63class ITSTrackingInterface;
64} // namespace its
65
66namespace itsmft
67{
68class TopologyDictionary;
69} // namespace itsmft
70
71namespace dataformats
72{
74} // namespace dataformats
75
76namespace gpu
77{
78struct GPUO2InterfaceConfiguration;
79class GPUDisplayFrontendInterface;
80class CorrectionMapsHelper;
81class TPCFastTransform;
82struct GPUSettingsTF;
83class GPUO2Interface;
84struct TPCPadGainCalib;
85struct TPCZSLinkMapping;
86struct GPUSettingsO2;
87struct GPUSettingsProcessingNNclusterizer;
88class GPUO2InterfaceQA;
89struct GPUTrackingInOutPointers;
90struct GPUTrackingInOutZS;
91struct GPUInterfaceOutputs;
92struct GPUInterfaceInputUpdate;
93namespace gpurecoworkflow_internals
94{
98} // namespace gpurecoworkflow_internals
99
101{
102 public:
103 using CompletionPolicyData = std::vector<framework::InputSpec>;
104
105 struct Config {
106 int32_t itsTriggerType = 0;
107 int32_t lumiScaleMode = 0;
109 bool enableMShape = false;
110 bool enableCTPLumi = false;
112 int32_t tpcDeadMapSources = -1;
113 bool tpcUseMCTimeGain = false; // use time gain calibration for MC (true) or from data (false)
114 bool decompressTPC = false;
116 bool caClusterer = false;
117 bool zsDecoder = false;
118 bool zsOnTheFly = false;
119 bool outputTracks = false;
120 bool outputCompClusters = false;
122 bool outputCAClusters = false;
123 bool outputQA = false;
125 bool processMC = false;
127 bool askDISTSTF = true;
128 bool runTPCTracking = false;
129 bool runTRDTracking = false;
130 bool readTRDtracklets = false;
131 int32_t lumiScaleType = 0; // 0=off, 1=CTP, 2=TPC scalers
132 bool outputErrorQA = false;
133 bool runITSTracking = false;
134 bool itsOverrBeamEst = false;
135 bool tpcTriggerHandling = false;
136 bool isITS3 = false;
137 };
138
139 GPURecoWorkflowSpec(CompletionPolicyData* policyData, Config const& specconfig, std::vector<int32_t> const& tpcsectors, uint64_t tpcSectorMask, std::shared_ptr<o2::base::GRPGeomRequest>& ggr, std::function<bool(o2::framework::DataProcessingHeader::StartTime)>** gPolicyOrder = nullptr);
141 void init(o2::framework::InitContext& ic) final;
144 void stop() final;
145 void finaliseCCDB(o2::framework::ConcreteDataMatcher& matcher, void* obj) final;
149
150 void deinitialize();
151
152 private:
153 struct calibObjectStruct {
154 std::unique_ptr<TPCFastTransform> mFastTransform;
155 std::unique_ptr<TPCFastTransform> mFastTransformRef;
156 std::unique_ptr<TPCFastTransform> mFastTransformMShape;
157 std::unique_ptr<o2::tpc::CorrectionMapsLoader> mFastTransformHelper;
158 std::unique_ptr<TPCPadGainCalib> mTPCPadGainCalib;
159 std::unique_ptr<o2::tpc::CalibdEdxContainer> mdEdxCalibContainer;
160 };
161
163 void initFunctionTPCCalib(o2::framework::InitContext& ic);
164 void initFunctionITS(o2::framework::InitContext& ic);
166 void finaliseCCDBTPC(o2::framework::ConcreteDataMatcher& matcher, void* obj);
167 void finaliseCCDBITS(o2::framework::ConcreteDataMatcher& matcher, void* obj);
169 template <class T>
170 bool fetchCalibsCCDBTPC(o2::framework::ProcessingContext& pc, T& newCalibObjects, calibObjectStruct& oldCalibObjects);
171 bool fetchCalibsCCDBITS(o2::framework::ProcessingContext& pc);
173 void cleanOldCalibsTPCPtrs(calibObjectStruct& oldCalibObjects);
174
175 void doCalibUpdates(o2::framework::ProcessingContext& pc, calibObjectStruct& oldCalibObjects);
176
177 void doTrackTuneTPC(GPUTrackingInOutPointers& ptrs, char* buffout);
178
179 template <class D, class E, class F, class G, class H, class I, class J, class K>
180 void processInputs(o2::framework::ProcessingContext&, D&, E&, F&, G&, bool&, H&, I&, J&, K&);
181
182 int32_t runMain(o2::framework::ProcessingContext* pc, GPUTrackingInOutPointers* ptrs, GPUInterfaceOutputs* outputRegions, int32_t threadIndex = 0, GPUInterfaceInputUpdate* inputUpdateCallback = nullptr);
183 int32_t runITSTracking(o2::framework::ProcessingContext& pc);
184
185 int32_t handlePipeline(o2::framework::ProcessingContext& pc, GPUTrackingInOutPointers& ptrs, gpurecoworkflow_internals::GPURecoWorkflowSpec_TPCZSBuffers& tpcZSmeta, o2::gpu::GPUTrackingInOutZS& tpcZS, std::unique_ptr<gpurecoworkflow_internals::GPURecoWorkflow_QueueObject>& context);
186 void RunReceiveThread();
187 void RunWorkerThread(int32_t id);
188 void ExitPipeline();
189 void handlePipelineEndOfStream(o2::framework::EndOfStreamContext& ec);
190 void handlePipelineStop();
191 void initPipeline(o2::framework::InitContext& ic);
192 void enqueuePipelinedJob(GPUTrackingInOutPointers* ptrs, GPUInterfaceOutputs* outputRegions, gpurecoworkflow_internals::GPURecoWorkflow_QueueObject* context, bool inputFinal);
193 void finalizeInputPipelinedJob(GPUTrackingInOutPointers* ptrs, GPUInterfaceOutputs* outputRegions, gpurecoworkflow_internals::GPURecoWorkflow_QueueObject* context);
194 void receiveFMQStateCallback(fair::mq::State);
195
196 CompletionPolicyData* mPolicyData;
197 std::function<bool(o2::framework::DataProcessingHeader::StartTime)> mPolicyOrder;
198 std::unique_ptr<GPUO2Interface> mGPUReco;
199 std::unique_ptr<GPUDisplayFrontendInterface> mDisplayFrontend;
200
201 calibObjectStruct mCalibObjects;
202 std::unique_ptr<o2::tpc::DeadChannelMapCreator> mTPCDeadChannelMapCreator;
203 std::unique_ptr<o2::tpc::CalibdEdxContainer> mdEdxCalibContainerBufferNew;
204 std::unique_ptr<TPCPadGainCalib> mTPCPadGainCalibBufferNew;
205 std::queue<calibObjectStruct> mOldCalibObjects;
206 std::unique_ptr<TPCZSLinkMapping> mTPCZSLinkMapping;
207 std::unique_ptr<o2::tpc::VDriftHelper> mTPCVDriftHelper;
208 std::unique_ptr<o2::trd::GeometryFlat> mTRDGeometry;
209 std::unique_ptr<GPUO2InterfaceConfiguration> mConfig;
210 std::unique_ptr<GPUSettingsO2> mConfParam;
211 std::unique_ptr<TStopwatch> mTimer;
212 std::vector<std::array<uint32_t, 4>> mErrorQA;
213 int32_t mQATaskMask = 0;
214 std::unique_ptr<GPUO2InterfaceQA> mQA;
215 std::vector<int32_t> mClusterOutputIds;
216 std::vector<int32_t> mTPCSectors;
217 std::unique_ptr<o2::its::ITSTrackingInterface> mITSTrackingInterface;
218 std::unique_ptr<gpurecoworkflow_internals::GPURecoWorkflowSpec_PipelineInternals> mPipeline;
219 o2::its::TimeFrame<7>* mITSTimeFrame = nullptr;
220 std::vector<fair::mq::RegionInfo> mRegionInfos;
221 const o2::itsmft::TopologyDictionary* mITSDict = nullptr;
222 const o2::dataformats::MeanVertexObject* mMeanVertex;
223 uint64_t mTPCSectorMask = 0;
224 int64_t mCreationForCalib = -1;
225 int32_t mVerbosity = 0;
226 uint32_t mNTFs = 0;
227 uint32_t mNDebugDumps = 0;
228 uint32_t mNextThreadIndex = 0;
229 bool mUpdateGainMapCCDB = true;
230 std::unique_ptr<o2::gpu::GPUSettingsTF> mTFSettings;
231 std::unique_ptr<o2::gpu::GPUSettingsProcessingNNclusterizer> mNNClusterizerSettings;
232
233 Config mSpecConfig;
234 std::shared_ptr<o2::base::GRPGeomRequest> mGGR;
235 bool mGRPGeomUpdated = false;
236 bool mAutoContinuousMaxTimeBin = false;
237 bool mAutoSolenoidBz = false;
238 bool mMatLUTCreated = false;
239 bool mITSGeometryCreated = false;
240 bool mTRDGeometryCreated = false;
241 bool mPropagatorInstanceCreated = false;
242 int32_t mTPCCutAtTimeBin = -1;
243};
244
245} // end namespace gpu
246} // end namespace o2
247
248#endif // O2_GPU_WORKFLOW_SPEC_H
Utilities for parsing of data sequences.
std::vector< InputSpec > CompletionPolicyData
o2::framework::Outputs outputs()
std::vector< framework::InputSpec > CompletionPolicyData
void init(o2::framework::InitContext &ic) final
void endOfStream(o2::framework::EndOfStreamContext &ec) final
This is invoked whenever we have an EndOfStream event.
o2::framework::Inputs inputs()
void run(o2::framework::ProcessingContext &pc) final
void stop() final
This is invoked on stop.
void finaliseCCDB(o2::framework::ConcreteDataMatcher &matcher, void *obj) final
o2::framework::Options options()
o2::dataformats::MeanVertexObject MeanVertexObject
std::vector< ConfigParamSpec > Options
std::vector< InputSpec > Inputs
std::vector< OutputSpec > Outputs
a couple of static helper functions to create timestamp values for CCDB queries or override obsolete ...