3 //**************************************************************************
4 //* This file is property of and copyright by the ALICE HLT Project *
5 //* ALICE Experiment at CERN, All rights reserved. *
7 //* Primary Authors: Matthias Richter <Matthias.Richter@ift.uib.no> *
8 //* for The ALICE HLT Project. *
10 //* Permission to use, copy, modify and distribute this software and its *
11 //* documentation strictly for non-commercial purposes is hereby granted *
12 //* without fee, provided that the above copyright notice appears in all *
13 //* copies and that both the copyright notice and this permission notice *
14 //* appear in the supporting documentation. The authors make no claims *
15 //* about the suitability of this software for any purpose. It is *
16 //* provided "as is" without express or implied warranty. *
17 //**************************************************************************
19 // @file AliHLTCTPData.cxx
20 // @author Matthias Richter
22 // @brief Container for CTP trigger classes and counters
25 #include "AliHLTCTPData.h"
27 #include "TObjString.h"
29 #include "AliHLTComponent.h"
30 #include "AliRawDataHeader.h"
32 /** ROOT macro for the implementation of ROOT specific class methods */
33 ClassImp(AliHLTCTPData)
35 AliHLTCTPData::AliHLTCTPData()
36 : TNamed("AliHLTCTPData", "HLT counters for the CTP")
40 , fClassIds(AliHLTReadoutList::Class(), gkNCTPTriggerClasses)
41 , fCounters(gkNCTPTriggerClasses)
45 // see header file for class documentation
47 // refer to README to build package
49 // visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
52 AliHLTCTPData::AliHLTCTPData(const char* parameter)
53 : TNamed("AliHLTCTPData", "HLT counters for the CTP")
57 , fClassIds(AliHLTReadoutList::Class(), gkNCTPTriggerClasses)
58 , fCounters(gkNCTPTriggerClasses)
61 // constructor, init the CTP trigger classes
62 InitCTPTriggerClasses(parameter);
65 AliHLTCTPData::~AliHLTCTPData()
71 AliHLTCTPData::AliHLTCTPData(const AliHLTCTPData& src)
72 : TNamed(src.GetName(), src.GetTitle())
75 , fTriggers(src.fTriggers)
76 , fClassIds(src.fClassIds)
77 , fCounters(src.Counters())
84 AliHLTCTPData& AliHLTCTPData::operator=(const AliHLTCTPData& src)
86 // assignment operator, clone content
88 SetName(src.GetName());
89 SetTitle(src.GetTitle());
92 fClassIds.ExpandCreate(gkNCTPTriggerClasses);
93 for (int i=0; i<gkNCTPTriggerClasses; i++) {
94 if (i>src.fClassIds.GetLast()) break;
95 ((TNamed*)fClassIds.At(i))->SetName(src.fClassIds.At(i)->GetName());
96 ((TNamed*)fClassIds.At(i))->SetTitle(src.fClassIds.At(i)->GetTitle());
98 fCounters=src.Counters();
105 int AliHLTCTPData::Add(const AliHLTCTPData& src, int factor, int &skipped)
107 // see header file for class documentation
110 for (int i=0; i<gkNCTPTriggerClasses; i++) {
112 c=fClassIds.At(i)->GetName();
113 if (c.IsNull()) continue;
114 if (c.CompareTo(src.fClassIds.At(i)->GetName())==0) {
115 fCounters[i]+=factor*src.Counter(i);
123 AliHLTCTPData& AliHLTCTPData::operator += (const AliHLTCTPData& src)
125 // see header file for class documentation
127 int nofInconsistencies=0;
128 Add(src, 1, nofInconsistencies);
129 if (nofInconsistencies>0) {
130 HLTError("Inconsistent operants: skipping %d of %d CTP classes for operation", nofInconsistencies, gkNCTPTriggerClasses);
135 AliHLTCTPData& AliHLTCTPData::operator -= (const AliHLTCTPData& src)
137 // see header file for class documentation
139 int nofInconsistencies=0;
140 Add(src, -1, nofInconsistencies);
141 if (nofInconsistencies>0) {
142 HLTError("Inconsistent operants: skipping %d of %d CTP classes for operation", nofInconsistencies, gkNCTPTriggerClasses);
147 AliHLTCTPData AliHLTCTPData::operator + (const AliHLTCTPData& src) const
149 // see header file for class documentation
151 AliHLTCTPData result(*this);
156 AliHLTCTPData AliHLTCTPData::operator - (const AliHLTCTPData& src) const
158 // see header file for class documentation
160 AliHLTCTPData result(*this);
165 int AliHLTCTPData::InitCTPTriggerClasses(const char* ctpString)
167 // see header file for function documentation
168 if (!ctpString) return -EINVAL;
170 HLTImportant("Parameter: %s", ctpString);
174 fClassIds.ExpandCreate(gkNCTPTriggerClasses);
176 // general format of the CTP_TRIGGER_CLASS parameter
177 // <bit position>:<Trigger class identifier string>:<detector-id-nr>-<detector-id-nr>-...,<bit position>:<Trigger class identifier string>:<detector-id-nr>-<detector-id-nr>-...,...
178 HLTDebug(": %s", ctpString);
179 TString string=ctpString;
180 if (string.BeginsWith("CTP_TRIGGER_CLASS=")) string.ReplaceAll("CTP_TRIGGER_CLASS=", "");
181 TObjArray* classEntries=string.Tokenize(",");
183 enum {kBit=0, kName, kDetectors};
184 for (int i=0; i<classEntries->GetEntriesFast(); i++) {
185 TString entry=((TObjString*)classEntries->At(i))->GetString();
186 TObjArray* entryParams=entry.Tokenize(":");
188 if (entryParams->GetEntriesFast()==3 &&
189 (((TObjString*)entryParams->At(kBit))->GetString()).IsDigit()) {
190 int index=(((TObjString*)entryParams->At(kBit))->GetString()).Atoi();
191 if (index<gkNCTPTriggerClasses) {
192 AliHLTReadoutList* pCTPClass=dynamic_cast<AliHLTReadoutList*>(fClassIds.At(index));
194 fMask|=(AliHLTUInt64_t)0x1 << index;
195 pCTPClass->SetTitle("CTP Class");
196 pCTPClass->SetName((((TObjString*)entryParams->At(kName))->GetString()).Data());
197 TObjArray* detectors=(((TObjString*)entryParams->At(kDetectors))->GetString()).Tokenize("-");
199 for (int dix=0; dix<detectors->GetEntriesFast(); dix++) {
200 if (!(((TObjString*)detectors->At(dix))->GetString()).IsDigit()) {
201 HLTError("invalid detector list format: trigger class entry %s", entry.Data());
204 // see AliHLTReadoutList::EDetectorId for defines of detectors
205 pCTPClass->Enable(0x1<<(((TObjString*)detectors->At(dix))->GetString()).Atoi());
212 // the trigger bitfield is fixed to 50 bits (gkNCTPTriggerClasses)
213 HLTError("invalid trigger class entry %s, index width of trigger bitfield exceeded (%d)", entry.Data(), gkNCTPTriggerClasses);
216 HLTError("invalid trigger class entry %s", entry.Data());
230 AliHLTUInt64_t AliHLTCTPData::ActiveTriggers(const AliHLTComponentTriggerData& trigData)
232 // extract active triggers from the trigger data
234 const AliRawDataHeader* cdh = NULL;
235 if (AliHLTComponent::ExtractTriggerData(trigData, NULL, NULL, &cdh, NULL) != 0) return (AliHLTUInt64_t)0;
236 if ((cdh->GetL1TriggerMessage() & 0x1) == 0x1) return 0x0; // invalid for software triggers.
237 // trigger mask is 50 bit wide and is stored in word 5 and 6 of the CDH
238 AliHLTUInt64_t triggerMask = cdh->GetTriggerClasses();
242 bool AliHLTCTPData::EvaluateCTPTriggerClass(const char* expression, const AliHLTComponentTriggerData& trigData) const
244 // see header file for function documentation
246 const AliRawDataHeader* cdh = NULL;
247 if (AliHLTComponent::ExtractTriggerData(trigData, NULL, NULL, &cdh, NULL, true) != 0) return false;
248 if ((cdh->GetL1TriggerMessage() & 0x1) == 0x1) return false; // invalid for software triggers.
249 // trigger mask is 50 bit wide and is stored in word 5 and 6 of the CDH
250 AliHLTUInt64_t triggerMask = cdh->GetTriggerClasses();
252 if (fMask!=0 && (triggerMask & fMask)==0) {
253 AliHLTEventTriggerData* evtData=reinterpret_cast<AliHLTEventTriggerData*>(trigData.fData);
254 HLTWarning("invalid trigger mask 0x%llx, unknown CTP trigger, initialized 0x%llx", triggerMask, fMask);
255 for (int i=0; i<8; i++) HLTWarning("\t CDH[%d]=0x%lx", i, evtData->fCommonHeader[i]);
259 return EvaluateCTPTriggerClass(expression, triggerMask);
262 bool AliHLTCTPData::EvaluateCTPTriggerClass(const char* expression, AliHLTUInt64_t triggerMask) const
264 // see header file for function documentation
266 // use a TFormula to interprete the expression
267 // all classname are replaced by '[n]' which means the n'th parameter in the formula
268 // the parameters are set to 0 or 1 depending on the bit in the trigger mask
269 const vector<unsigned> *pMap=&fMap;
270 vector<unsigned> tmp;
271 if (fMap.size()==0 && fClassIds.GetLast()>=0) {
272 // read map into temporary array and use it
275 static bool suppressWarning=false;
276 if (!suppressWarning) HLTWarning("map not yet initialized, creating local map (slow), suppressing further warnings");
277 suppressWarning=true;
279 vector<Double_t> par;
280 TString condition=expression;
281 for (unsigned index=0; index<pMap->size(); index++) {
282 const char* className=Name((*pMap)[index]);
283 if (className && strlen(className)>0) {
284 //HLTDebug("checking trigger class %s", className.Data());
285 if (condition.Contains(className)) {
286 TString replace; replace.Form("[%d]", (int)par.size());
287 //HLTDebug("replacing %s with %s in \"%s\"", className.Data(), replace.Data(), condition.Data());
288 condition.ReplaceAll(className, replace);
289 if (triggerMask&((AliHLTUInt64_t)0x1<<(*pMap)[index])) par.push_back(1.0);
290 else par.push_back(0.0);
295 TFormula form("trigger expression", condition);
296 if (form.Compile()!=0) {
297 HLTError("invalid expression %s", expression);
300 if (form.EvalPar(&par[0], &par[0])>0.5) return true;
304 void AliHLTCTPData::ResetCounters()
306 // see header file for function documentation
307 fCounters.Set(gkNCTPTriggerClasses);
311 int AliHLTCTPData::Index(const char* name) const
313 // see header file for function documentation
314 TObject* obj=fClassIds.FindObject(name);
315 return obj!=NULL?fClassIds.IndexOf(obj):-1;
318 int AliHLTCTPData::CheckTrigger(const char* name) const
320 // check status of a trigger class
321 int index=Index(name);
322 if (index<0) return index;
323 return (fTriggers&(0x1<<index))>0?1:0;
326 void AliHLTCTPData::Increment(const char* classIds)
328 // see header file for function documentation
329 TString string=classIds;
330 TObjArray* classEntries=string.Tokenize(",");
332 for (int i=0; i<classEntries->GetEntriesFast(); i++) {
333 int index=Index(((TObjString*)classEntries->At(i))->GetString().Data());
334 if (index>=0 && index<fCounters.GetSize()) fCounters[index]++;
340 void AliHLTCTPData::Increment(AliHLTUInt64_t triggerPattern)
342 // see header file for function documentation
343 AliHLTUInt64_t pattern=triggerPattern&fMask;
344 for (int i=0; i<fCounters.GetSize(); i++) {
345 if ((pattern&((AliHLTUInt64_t)0x1<<i))==0) continue;
350 void AliHLTCTPData::Increment(int classIdx)
352 // see header file for function documentation
353 if (classIdx<fCounters.GetSize() &&
354 (fMask&((AliHLTUInt64_t)0x1<<classIdx))) {
355 fCounters[classIdx]++;
360 int AliHLTCTPData::Increment(AliHLTComponentTriggerData& trigData)
362 // see header file for function documentation
363 const AliRawDataHeader* cdh = NULL;
364 int result = AliHLTComponent::ExtractTriggerData(trigData, NULL, NULL, &cdh, NULL, true);
365 if (result != 0) return result;
366 if ((cdh->GetL1TriggerMessage() & 0x1) == 0x1) return 0; // invalid for software triggers.
367 // trigger mask is 50 bit wide and is stored in word 5 and 6 of the CDH
368 AliHLTUInt64_t triggerMask = cdh->GetTriggerClasses();
370 if (fMask!=0 && (triggerMask & fMask)==0) {
371 AliHLTEventTriggerData* evtData=reinterpret_cast<AliHLTEventTriggerData*>(trigData.fData);
372 HLTWarning("invalid trigger mask 0x%llx, unknown CTP trigger, initialized 0x%llx", triggerMask, fMask);
373 for (int i=0; i<8; i++) HLTWarning("\t CDH[%d]=0x%lx", i, evtData->fCommonHeader[i]);
375 Increment(triggerMask);
379 AliHLTUInt64_t AliHLTCTPData::Counter(int index) const
381 // see header file for function documentation
382 if (index>=0 && index<Counters().GetSize()) return Counters()[index];
386 AliHLTUInt64_t AliHLTCTPData::Counter(const char* classId) const
388 // see header file for function documentation
389 return Counter(Index(classId));
392 const char* AliHLTCTPData::Name(int index) const
394 // see header file for function documentation
395 if (index>fClassIds.GetLast()) return NULL;
396 return fClassIds.At(index)->GetName();
399 int AliHLTCTPData::ReadMap(vector<unsigned> &map) const
401 // read the index map for class names
402 // for nested class names (e.g. 'myclass' is contained in
403 // 'myclassA') the longer names is added first to the map.
404 for (int index=0; index<=fClassIds.GetLast(); index++) {
405 vector<unsigned>::iterator element=map.begin();
406 for (; element!=map.end(); element++) {
407 TString name=Name(index);
408 if (name.Contains(Name(*element))) {
409 // current name contains another one already in the map
410 // -> add before and go to next entry
411 element=map.insert(element, index);
416 if (element==map.end()) {
417 // unique class name, append to map
418 map.push_back(index);
425 AliHLTReadoutList AliHLTCTPData::ReadoutList(const AliHLTComponentTriggerData& trigData) const
427 // see header file for function documentation
429 const AliRawDataHeader* cdh = NULL;
430 if (AliHLTComponent::ExtractTriggerData(trigData, NULL, NULL, &cdh, NULL, true) != 0) return AliHLTReadoutList();
431 // Check if we are dealing with a software trigger. If so then we need to return
432 // a readout list with everything set because the CTP trigger bits are invalid.
433 // Thus we assume that everything should be read out.
434 if ((cdh->GetL1TriggerMessage() & 0x1) == 0x1) return ~ AliHLTReadoutList();
435 // trigger mask is 50 bit wide and is stored in word 5 and 6 of the CDH
436 AliHLTUInt64_t triggerMask = cdh->GetTriggerClasses();
438 if (fMask!=0 && (triggerMask & fMask)==0) {
439 AliHLTEventTriggerData* evtData=reinterpret_cast<AliHLTEventTriggerData*>(trigData.fData);
440 HLTWarning("invalid trigger mask 0x%llx, unknown CTP trigger, initialized 0x%llx", triggerMask, fMask);
441 for (int i=0; i<8; i++) HLTWarning("\t CDH[%d]=0x%lx", i, evtData->fCommonHeader[i]);
444 return ReadoutList(triggerMask);
447 AliHLTReadoutList AliHLTCTPData::ReadoutList(AliHLTUInt64_t triggerMask) const
449 // take an 'OR' of all active trigger classes
450 AliHLTReadoutList list;
451 for (int i=0; i<gkNCTPTriggerClasses; i++) {
452 if (i>fClassIds.GetLast()) break;
453 if ((triggerMask&((AliHLTUInt64_t)0x1<<i))==0) continue;
454 AliHLTReadoutList* tcrl=(AliHLTReadoutList*)fClassIds.At(i);
462 void AliHLTCTPData::Print(Option_t* /*option*/) const
464 // see header file for function documentation
465 cout << GetTitle() << endl;
466 cout << "\tactive trigger mask: 0x" << hex << fTriggers << dec << endl;
468 for (int i=0; i<gkNCTPTriggerClasses; i++) {
469 if (i>=Counters().GetSize()) break;
470 if (i>fClassIds.GetLast()) break;
471 if ((fMask&((AliHLTUInt64_t)0x1<<i))==0) continue;
473 cout << "\t" << i << "\t" << Name(i) << "\t" << Counter(i) << endl;
475 if (count==0) cout << "\t(none)" << endl;