-
Notifications
You must be signed in to change notification settings - Fork 496
Expand file tree
/
Copy pathDCSConfigSpec.cxx
More file actions
473 lines (406 loc) · 17.3 KB
/
DCSConfigSpec.cxx
File metadata and controls
473 lines (406 loc) · 17.3 KB
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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
// Copyright 2019-2020 CERN and copyright holders of ALICE O2.
// See https://alice-o2.web.cern.ch/copyright for details of the copyright holders.
// All rights not expressly granted are reserved.
//
// This software is distributed under the terms of the GNU General Public
// License v3 (GPL Version 3), copied verbatim in the file "COPYING".
//
// In applying this license CERN does not waive the privileges and immunities
// granted to it by virtue of its status as an Intergovernmental Organization
// or submit itself to any jurisdiction.
/// @file DCSConfigSpec.h
/// @author Jens Wiechula
/// @brief DCS configuration processing
#include <memory>
#include <cassert>
#include <chrono>
#include <bitset>
#include <fstream>
#include <sstream>
#include <string>
#include <string_view>
#include <filesystem>
#include <unordered_map>
#include <vector>
#include "TFile.h"
#include "Framework/DataProcessorSpec.h"
#include "Framework/Task.h"
#include "Framework/Logger.h"
#include "Framework/ConfigParamRegistry.h"
#include "DetectorsCalibration/Utils.h"
#include "CommonUtils/StringUtils.h"
#include "CCDB/CCDBTimeStampUtils.h"
#include "CCDB/CcdbObjectInfo.h"
#include "CCDB/CcdbApi.h"
#include "CommonUtils/NameConf.h"
#include "TPCBaseRecSim/CDBInterface.h"
#include "TPCBase/CRUCalibHelpers.h"
#include "TPCBase/FEEConfig.h"
#include "TPCBase/FECInfo.h"
#include "TPCdcs/DCSConfigSpec.h"
namespace fs = std::filesystem;
using namespace o2::utils;
using namespace o2::framework;
constexpr auto CDBPayload = o2::calibration::Utils::gDataOriginCDBPayload;
constexpr auto CDBWrapper = o2::calibration::Utils::gDataOriginCDBWrapper;
namespace o2::tpc
{
const std::unordered_map<CDBType, o2::header::DataDescription> CDBDescMap{
{CDBType::ConfigFEE, o2::header::DataDescription{"TPC_FEEConfig"}},
};
class DCSConfigDevice : public o2::framework::Task
{
public:
struct TagInfo {
TagInfo(int t, std::string_view c)
{
tag = t;
comment = c.data();
}
int tag;
std::string comment;
};
using TagInfos = std::vector<TagInfo>;
DCSConfigDevice() = default;
void init(o2::framework::InitContext& ic) final;
void run(o2::framework::ProcessingContext& pc) final;
void writeRootFile(int tag);
void endOfStream(o2::framework::EndOfStreamContext& ec) final
{
LOGP(info, "endOfStream");
}
void stop() final
{
LOGP(info, "stop");
}
static TagInfos readTagInfos(gsl::span<const char> configBuff);
private:
struct membuf : std::streambuf {
membuf(char* base, std::ptrdiff_t n)
{
this->setg(base, base, base + n);
}
};
/// Names of calDet objects from CRU
static constexpr std::string_view CalDetNames = "ITfraction,ITexpLambda,ThresholdMap,Pedestals,CMkValues";
static constexpr int NCalDets = 5; ///< number of expected calDet objects
static constexpr std::string_view CRUConfigName = "CRUdata";
static constexpr std::string_view TagInfoName = "TagInfo";
static constexpr std::string_view RunInfoFileName = "TPCRunInfo.txt";
static constexpr int NLinksTotal = 2 * FECInfo::FECsTotal;
CDBStorage mCDBStorage;
o2::ccdb::CcdbApi mCCDBApi;
FEEConfig mFEEConfig;
std::unordered_map<std::string, std::vector<char>> mDataBuffer; ///< buffer for received data
std::unordered_map<std::string, long> mDataBufferTimes; ///< buffer for received data times
std::bitset<NCalDets> mFEEPadDataReceived; ///< check if all pad-wise data was received
bool mCRUConfigReceived = false; ///< if CRU config was received
bool mDumpToRootFile = false; ///< optional filename to dump data to
bool mDumpToTextFiles = false; ///< dump received data to text files
bool mReadFromRootFile = false; ///< read from root file instead of ccdb for testing
bool mDontWriteRunInfo = false; ///< read from root file instead of ccdb for testing
void updateRunInfo(gsl::span<const char> configBuff);
void fillFEEPad(std::string_view configFileName, gsl::span<const char> configBuff, bool update);
void fillCRUConfig(gsl::span<const char> configBuff, bool update);
void dumpToTextFile(std::string_view configFileName, gsl::span<const char> configBuff, std::string_view tagNames);
bool loadFEEConfig(int tag);
void updateTags(DataAllocator& output);
void updateCCDB(DataAllocator& output, const TagInfo& tagInfo);
};
void DCSConfigDevice::init(o2::framework::InitContext& ic)
{
mDumpToTextFiles = ic.options().get<bool>("dump-to-text-files");
mDumpToRootFile = ic.options().get<bool>("dump-to-root-file");
mReadFromRootFile = ic.options().get<bool>("read-from-root-file");
mDontWriteRunInfo = ic.options().get<bool>("dont-write-run-info");
const auto calDetNamesVec = Str::tokenize(CalDetNames.data(), ',');
assert(NCalDets == calDetNamesVec.size());
for (const auto& name : calDetNamesVec) {
mFEEConfig.padMaps[name.data()].setName(name.data());
}
mCCDBApi.init(o2::base::NameConf::getCCDBServer());
// set default meta data
mCDBStorage.setResponsible("Jens Wiechula (jens.wiechula@cern.ch)");
mCDBStorage.setIntervention(CDBIntervention::Automatic);
}
void DCSConfigDevice::run(o2::framework::ProcessingContext& pc)
{
auto configBuff = pc.inputs().get<gsl::span<char>>("inputConfig");
auto configFileName = pc.inputs().get<std::string>("inputConfigFileName");
const auto creation = pc.services().get<o2::framework::TimingInfo>().creation;
LOG(info) << "received input file " << configFileName << " of size " << configBuff.size();
// either we receive a run info file or an update of a FEE config tag
if (configFileName == RunInfoFileName) {
updateRunInfo(configBuff);
} else { // update tag
std::string objName = fs::path(configFileName).stem().c_str();
objName = objName.substr(3, objName.size());
// first buffer all the datao
auto& dataVec = mDataBuffer[objName];
auto& objTime = mDataBufferTimes[objName];
if (dataVec.size()) {
LOGP(warning, "Another object with name {} was already received before: {}, now: {}, old object will be overwritten", objName, objTime, creation);
dataVec.clear();
}
dataVec.insert(dataVec.begin(), configBuff.begin(), configBuff.end());
objTime = creation;
if (objName == TagInfoName) {
updateTags(pc.outputs());
}
}
}
void DCSConfigDevice::updateRunInfo(gsl::span<const char> configBuff)
{
const std::string line(configBuff.data(), configBuff.size());
const auto data = Str::tokenize(line, ',');
const std::string_view runInfoConf("Run number;SOX;Tag number;Run type");
if (data.size() != 4) {
LOGP(error, "{} has wrong format: {}, expected: {}, not writing RunInformation to CCDB", RunInfoFileName, line, runInfoConf);
return;
}
const auto tagString = data[2];
//
// retrieve ETag from FEEConfig to set up Redirect
const auto headers = mCCDBApi.retrieveHeaders(CDBTypeMap.at(CDBType::ConfigFEE), {}, std::stol(tagString));
std::map<std::string, std::string> md;
md[o2::base::NameConf::CCDBRunTag.data()] = data[0];
md["RunType"] = data[3];
md[o2::ccdb::CcdbObjectInfo::AdjustableEOV] = "true";
if (headers.find("ETag") != headers.end()) {
auto etag = headers.at("ETag");
etag.erase(std::remove(etag.begin(), etag.end(), '"'), etag.end());
md["Redirect"] = fmt::format("/{}/{}/{}", CDBTypeMap.at(CDBType::ConfigFEE), tagString, etag);
} else {
LOGP(error, "No ETag found for Tag {}, not setting Redirect in RunInfo", tagString);
}
const long startValRCT = std::stol(data[1]);
const long endValRCT = startValRCT + 48l * 60l * 60l * 1000l;
if (!mDontWriteRunInfo) {
o2::ccdb::CcdbObjectInfo w(CDBTypeMap.at(CDBType::ConfigRunInfo), "", "", md, startValRCT, endValRCT);
mCCDBApi.storeAsBinaryFile(nullptr, 0, "ignored", "", CDBTypeMap.at(CDBType::ConfigRunInfo), md, startValRCT, endValRCT);
if (!mCCDBApi.isSnapshotMode()) {
o2::ccdb::adjustOverriddenEOV(mCCDBApi, w);
}
}
std::string mdInfo = "[";
for (const auto& [key, val] : md) {
mdInfo += fmt::format("{} = {}, ", key, val);
}
mdInfo += "]";
LOGP(info, "Updated {} with {} for validity range {}, {}", CDBTypeMap.at(CDBType::ConfigRunInfo), mdInfo, startValRCT, endValRCT);
}
void DCSConfigDevice::updateCCDB(DataAllocator& output, const TagInfo& tagInfo)
{
mCDBStorage.setReason(tagInfo.comment);
std::map<std::string, std::string> md = mCDBStorage.getMetaData();
o2::ccdb::CcdbObjectInfo w(false);
o2::calibration::Utils::prepareCCDBobjectInfo(mFEEConfig, w, CDBTypeMap.at(CDBType::ConfigFEE), md, tagInfo.tag, tagInfo.tag + 1);
mFEEConfig.tag = FEEConfig::Tags(tagInfo.tag);
auto image = o2::ccdb::CcdbApi::createObjectImage(&mFEEConfig, &w);
LOGP(info, "Sending object {} / {} of size {} bytes, valid for {} : {} ", w.getPath(), w.getFileName(), image->size(), w.getStartValidityTimestamp(), w.getEndValidityTimestamp());
output.snapshot(Output{CDBPayload, CDBDescMap.at(CDBType::ConfigFEE), 0}, *image.get());
output.snapshot(Output{CDBWrapper, CDBDescMap.at(CDBType::ConfigFEE), 0}, w);
mFEEPadDataReceived.reset();
mCRUConfigReceived = false;
if (mDumpToRootFile) {
writeRootFile(tagInfo.tag);
}
mFEEConfig.clear();
}
void DCSConfigDevice::fillFEEPad(std::string_view configFileName, gsl::span<const char> configBuff, bool update)
{
auto& calPad = mFEEConfig.padMaps[configFileName.data()];
int nLines = 0;
if (configFileName == "ITfraction") {
nLines = cru_calib_helpers::fillCalPad<0>(calPad, configBuff);
mFEEPadDataReceived.set(0);
} else if (configFileName == "ITexpLambda") {
nLines = cru_calib_helpers::fillCalPad<0>(calPad, configBuff);
mFEEPadDataReceived.set(1);
} else if (configFileName == "ThresholdMap") {
nLines = cru_calib_helpers::fillCalPad<2>(calPad, configBuff);
mFEEPadDataReceived.set(2);
} else if (configFileName == "Pedestals") {
nLines = cru_calib_helpers::fillCalPad<2>(calPad, configBuff);
mFEEPadDataReceived.set(3);
} else if (configFileName == "CMkValues") {
nLines = cru_calib_helpers::fillCalPad<0>(calPad, configBuff);
mFEEPadDataReceived.set(4);
}
if (!update && (nLines != NLinksTotal)) {
LOGP(error, "Full FEEConfig expected, but only {} / {} lines read for object {}", nLines, NLinksTotal, configFileName);
} else {
LOGP(info, "updating CalDet object {} for {} links", configFileName, nLines);
}
}
void DCSConfigDevice::fillCRUConfig(gsl::span<const char> configBuff, bool update)
{
membuf sbuf((char*)configBuff.data(), configBuff.size());
std::istream in(&sbuf);
std::string line;
int nLines = 0;
while (std::getline(in, line)) {
const auto cru = std::stoi(line.substr(0, line.find_first_of(' ')));
if ((cru < 0) || (cru >= CRU::MaxCRU)) {
LOGP(error, "unexpected CRU number {} in line {}", cru, line);
continue;
}
const std::string cruData(line.substr(line.find_first_of(' ') + 1, line.size()));
auto& cruConfig = mFEEConfig.cruConfig[cru];
if (cruConfig.setValues(cruData)) {
++nLines;
}
}
if (!update && (nLines != CRU::MaxCRU)) {
LOGP(error, "Full FEEConfig expected, but only {} / {} lines read for CRUConfig", nLines, (int)CRU::MaxCRU);
} else {
LOGP(info, "updating CRUConfig for {} crus", nLines);
}
mCRUConfigReceived = true;
}
void DCSConfigDevice::dumpToTextFile(std::string_view objName, gsl::span<const char> configBuff, std::string_view tagNames)
{
const auto now = std::chrono::system_clock::now();
const long timeStart = std::chrono::duration_cast<std::chrono::milliseconds>(now.time_since_epoch()).count();
const auto outputFileName = fmt::format("TPC{}.{}.{}.txt", objName, tagNames, timeStart);
std::ofstream outFile(outputFileName);
outFile.write(configBuff.data(), configBuff.size());
outFile.close();
}
void DCSConfigDevice::updateTags(DataAllocator& outputs)
{
const auto tagInfos = readTagInfos(mDataBuffer.at(TagInfoName.data()));
std::string tagNames;
for (const auto& tagInfo : tagInfos) {
if (tagNames.size()) {
tagNames += "_";
}
tagNames += std::to_string(tagInfo.tag);
LOGP(info, "Updating TPC FEE config for tag {}", tagInfo.tag);
const auto update = loadFEEConfig(tagInfo.tag);
for (const auto& [objName, configBuff] : mDataBuffer) {
if (CalDetNames.find(objName) != std::string_view::npos) {
fillFEEPad(objName, configBuff, update);
} else if (objName == CRUConfigName) {
fillCRUConfig(configBuff, update);
}
}
if (!update && ((mFEEPadDataReceived.count() != NCalDets) || !mCRUConfigReceived)) {
std::string errorMessage;
if (mFEEPadDataReceived.count() != NCalDets) {
errorMessage = fmt::format("not all CalDet objects received: {} ({})", mFEEPadDataReceived.to_string(), CalDetNames);
}
if (!mCRUConfigReceived) {
if (errorMessage.size()) {
errorMessage += " and ";
}
errorMessage += "CRUConfig not reveived";
}
LOGP(error, "Full FEEConfig expected, but {}", errorMessage);
}
updateCCDB(outputs, tagInfo);
}
if (mDumpToTextFiles) {
for (const auto& [objName, configBuff] : mDataBuffer) {
dumpToTextFile(objName, configBuff, tagNames);
}
}
mDataBuffer.clear();
}
void DCSConfigDevice::writeRootFile(int tag)
{
const auto now = std::chrono::system_clock::now();
const long timeStart = std::chrono::duration_cast<std::chrono::milliseconds>(now.time_since_epoch()).count();
const auto outputFileName = fmt::format("TPCFEEConfig.{}.{}.root", tag, timeStart);
std::unique_ptr<TFile> outFile(TFile::Open(outputFileName.data(), "recreate"));
outFile->WriteObject(&mFEEConfig, "FEEConfig");
}
DCSConfigDevice::TagInfos DCSConfigDevice::readTagInfos(gsl::span<const char> configBuff)
{
membuf sbuf((char*)configBuff.data(), configBuff.size());
std::istream in(&sbuf);
std::string line;
TagInfos infos;
while (std::getline(in, line)) {
const auto firstComma = line.find_first_of(',');
int tag = -1;
try {
tag = std::stoi(std::string(line.substr(0, firstComma)));
} catch (...) {
}
const std::string comment(line.substr(firstComma + 1, line.size()));
if ((tag < 0) || comment.empty()) {
LOGP(warning, "Ill formatted line in 'TPC{}.txt': {}, expecting <tag,comment>, skipping", TagInfoName, line);
continue;
}
if (tag == 0) {
LOGP(warning, "Tag '{}' not accepted, must be > 0, skipping", tag);
continue;
}
infos.emplace_back(tag, comment);
}
return infos;
}
bool DCSConfigDevice::loadFEEConfig(int tag)
{
FEEConfig* feeConfig = nullptr;
if (mReadFromRootFile) {
// find last file of a tag in the local directory, assuming
std::vector<std::string> filenames;
for (const auto& entry : fs::directory_iterator("./")) {
const auto fileName = entry.path().filename().string();
// chek if root file and contains tag number
if (entry.is_regular_file() &&
fileName.find(".root") == (fileName.size() - 5) &&
fileName.find(fmt::format(".{}.", tag)) != std::string::npos) {
filenames.emplace_back(fileName);
}
}
if (filenames.size()) {
std::sort(filenames.begin(), filenames.end());
const auto& lastFile = filenames.back();
std::unique_ptr<TFile> inFile(TFile::Open(lastFile.data()));
if (inFile->IsOpen() && !inFile->IsZombie()) {
inFile->GetObject("FEEConfig", feeConfig);
}
if (feeConfig) {
LOGP(info, "Read FEEConfig from file {} for updating", lastFile);
}
}
} else {
std::map<std::string, std::string> headers;
feeConfig = mCCDBApi.retrieveFromTFileAny<FEEConfig>(CDBTypeMap.at(CDBType::ConfigFEE), std::map<std::string, std::string>(), tag, &headers);
if (feeConfig) {
LOGP(info, "Read FEEConfig from ccdb for updating: URL: {}, Validity: {} - {}, Last modfied: {}, ETag: {}", mCCDBApi.getURL(), headers["Valid-From"], headers["Valid-Until"], headers["Last-Modified"], headers["ETag"]);
}
}
if (!feeConfig) {
LOGP(warning, "Could not retrieve FEE config for tag {}, a new entry will be created, full config should be sent", tag);
mFEEConfig.clear();
return false;
}
mFEEConfig = *feeConfig;
if (mReadFromRootFile) {
delete feeConfig;
}
return true;
}
DataProcessorSpec getDCSConfigSpec()
{
std::vector<OutputSpec> outputs;
outputs.emplace_back(ConcreteDataTypeMatcher{o2::calibration::Utils::gDataOriginCDBPayload, CDBDescMap.at(CDBType::ConfigFEE)}, Lifetime::Sporadic);
outputs.emplace_back(ConcreteDataTypeMatcher{o2::calibration::Utils::gDataOriginCDBWrapper, CDBDescMap.at(CDBType::ConfigFEE)}, Lifetime::Sporadic);
return DataProcessorSpec{
"tpc-dcs-config",
Inputs{{"inputConfig", o2::header::gDataOriginTPC, "DCS_CONFIG_FILE", Lifetime::Sporadic},
{"inputConfigFileName", o2::header::gDataOriginTPC, "DCS_CONFIG_NAME", Lifetime::Sporadic}},
outputs,
AlgorithmSpec{adaptFromTask<DCSConfigDevice>()},
Options{
{"dump-to-text-files", VariantType::Bool, false, {"Optionally dump received data to text files"}},
{"dump-to-root-file", VariantType::Bool, false, {"Optionally write FEEConfig to root file"}},
{"read-from-root-file", VariantType::Bool, false, {"For testing purposes: read configuration from local root file instead of ccdb"}},
{"dont-write-run-info", VariantType::Bool, false, {"For testing purposes: skip writing RunInformation to ccdb"}},
}};
}
} // namespace o2::tpc