//* provided "as is" without express or implied warranty. *
//**************************************************************************
-/** @file AliHLTComponent.cxx
- @author Matthias Richter, Timm Steinbeck
- @date
- @brief Base class implementation for HLT components. */
+// @file AliHLTComponent.cxx
+// @author Matthias Richter, Timm Steinbeck
+// @date
+// @brief Base class implementation for HLT components. */
+// @note The class is both used in Online (PubSub) and Offline (AliRoot)
+// context
+
#if __GNUC__>= 3
using namespace std;
#include "AliHLTComponent.h"
#include "AliHLTComponentHandler.h"
#include "AliHLTMessage.h"
+#include "AliHLTCTPData.h"
+#include "AliRawDataHeader.h"
#include "TString.h"
#include "TMath.h"
#include "TObjArray.h"
#include "TClass.h"
#include "TStopwatch.h"
#include "TFormula.h"
+#include "TUUID.h"
+#include "TMD5.h"
+#include "TRandom3.h"
#include "AliHLTMemoryFile.h"
#include "AliHLTMisc.h"
#include <cassert>
+#include <ctime>
#include <stdint.h>
/**
fpStopwatches(new TObjArray(kSWTypeCount)),
fMemFiles(),
fpRunDesc(NULL),
- fpDDLList(NULL),
fCDBSetRunNoFunc(false),
fChainId(),
fChainIdCrc(0),
fpBenchmark(NULL),
- fRequireSteeringBlocks(false),
+ fFlags(0),
fEventType(gkAliEventTypeUnknown),
fComponentArgs(),
fEventDoneData(NULL),
fEventDoneDataSize(0),
fCompressionLevel(ALIHLTCOMPONENT_DEFAULT_OBJECT_COMPRESSION)
, fLastObjectSize(0)
- , fpTriggerClasses(NULL)
+ , fpCTPData(NULL)
+ , fPushbackPeriod(0)
+ , fLastPushBackTime(-1)
{
// see header file for class documentation
// or
delete [] reinterpret_cast<AliHLTUInt8_t*>( fEventDoneData );
fEventDoneData=NULL;
- if (fpTriggerClasses) {
- fpTriggerClasses->Delete();
- delete fpTriggerClasses;
+ if (fpCTPData) {
+ delete fpCTPData;
}
- fpTriggerClasses=NULL;
+ fpCTPData=NULL;
}
AliHLTComponentHandler* AliHLTComponent::fgpComponentHandler=NULL;
if (comenv) {
SetComponentEnvironment(comenv, environParam);
}
+ fPushbackPeriod=0;
+ fLastPushBackTime=-1;
+
fComponentArgs="";
const char** pArguments=NULL;
int iNofChildArgs=0;
} else {
HLTError("wrong parameter for argument -object-compression, number expected");
}
+ // -pushback-period=
+ } else if (argument.BeginsWith("-pushback-period=")) {
+ argument.ReplaceAll("-pushback-period=", "");
+ if (argument.IsDigit()) {
+ fPushbackPeriod=argument.Atoi();
+ } else {
+ HLTError("wrong parameter for argument -pushback-period, number expected");
+ }
+ // -disable-component-stat
+ } else if (argument.CompareTo("-disable-component-stat")==0) {
+ fFlags|=kDisableComponentStat;
} else {
pArguments[iNofChildArgs++]=argv[i];
}
HLTError("missing parameter for argument %s", argument.Data());
iResult=-EINVAL;
}
+ if (iResult>=0) {
+ iResult=CheckOCDBEntries();
+ }
if (iResult>=0) {
iResult=DoInit(iNofChildArgs, pArguments);
}
// explicitly
AliHLTComponentDataTypeList inputDt;
GetInputDataTypes(inputDt);
+ bool bRequireSteeringBlocks=false;
for (AliHLTComponentDataTypeList::iterator dt=inputDt.begin();
- dt!=inputDt.end() && !fRequireSteeringBlocks;
+ dt!=inputDt.end() && !bRequireSteeringBlocks;
dt++) {
- fRequireSteeringBlocks|=MatchExactly(*dt,kAliHLTDataTypeSOR);
- fRequireSteeringBlocks|=MatchExactly(*dt,kAliHLTDataTypeRunType);
- fRequireSteeringBlocks|=MatchExactly(*dt,kAliHLTDataTypeEOR);
- fRequireSteeringBlocks|=MatchExactly(*dt,kAliHLTDataTypeDDL);
- fRequireSteeringBlocks|=MatchExactly(*dt,kAliHLTDataTypeComponentStatistics);
+ bRequireSteeringBlocks|=MatchExactly(*dt,kAliHLTDataTypeSOR);
+ bRequireSteeringBlocks|=MatchExactly(*dt,kAliHLTDataTypeRunType);
+ bRequireSteeringBlocks|=MatchExactly(*dt,kAliHLTDataTypeEOR);
+ bRequireSteeringBlocks|=MatchExactly(*dt,kAliHLTDataTypeDDL);
+ bRequireSteeringBlocks|=MatchExactly(*dt,kAliHLTDataTypeComponentStatistics);
}
+ if (bRequireSteeringBlocks) fFlags|=kRequireSteeringBlocks;
}
if (pArguments) delete [] pArguments;
-#if defined(__DEBUG) || defined(HLT_COMPONENT_STATISTICS)
+#if defined(HLT_COMPONENT_STATISTICS)
// benchmarking stopwatch for the component statistics
fpBenchmark=new TStopwatch;
-#endif
+#endif // HLT_COMPONENT_STATISTICS
return iResult;
}
// AliHLTRunDesc is set before the SOR event in the SetRunDescription
// method. A couple of state flags should be defined but that is a bit more
// work to do. For the moment disable the warning (2009-07-01)
+ // 2009-09-08: now, the info is not cleared in the ProcessEvent, because it
+ // might be needed by components during the event processing.
//HLTWarning("did not receive EOR for run %d", fpRunDesc->fRunNo);
AliHLTRunDesc* pRunDesc=fpRunDesc;
fpRunDesc=NULL;
delete pRunDesc;
}
- if (fpTriggerClasses) {
- fpTriggerClasses->Delete();
- delete fpTriggerClasses;
+ if (fpCTPData) {
+ delete fpCTPData;
}
- fpTriggerClasses=NULL;
+ fpCTPData=NULL;
fEventCount=0;
+ fFlags=0;
return iResult;
}
TString descriptor=desc;
TObjArray* pTokens=descriptor.Tokenize(" ");
if (pTokens) {
- for (int i=0; i<pTokens->GetEntries() && iResult>=0; i++) {
+ for (int i=0; i<pTokens->GetEntriesFast() && iResult>=0; i++) {
TString argument=((TObjString*)pTokens->At(i++))->GetString();
if (!argument || argument.IsNull()) continue;
HLTWarning("unknown component description %s", argument.Data());
}
}
+ delete pTokens;
}
return iResult;
}
+int AliHLTComponent::ConfigureFromArgumentString(int argc, const char** argv)
+{
+ // see header file for function documentation
+ int iResult=0;
+ vector<const char*> array;
+ TObjArray choppedArguments;
+ TString argument="";
+ int i=0;
+ for (i=0; i<argc && iResult>=0; i++) {
+ argument=argv[i];
+ if (argument.IsWhitespace()) continue;
+
+ // special handling for single component arguments ending with
+ // a sequence of blanks
+ argument.Remove(0, argument.First(' '));
+ if (argument.IsWhitespace()) {
+ array.push_back(argv[i]);
+ continue;
+ }
+
+ // extra blank to insert blank token before leading quotes
+ argument=" ";
+ argument+=argv[i];
+ // insert blank in consecutive quotes to correctly tokenize
+ argument.ReplaceAll("''", "' '");
+ // replace newlines by blanks
+ argument.ReplaceAll("\n", " ");
+ if (argument.IsNull()) continue;
+ TObjArray* pTokensQuote=argument.Tokenize("'");
+ if (pTokensQuote) {
+ if (pTokensQuote->GetEntriesFast()>0) {
+ for (int k=0; k<pTokensQuote->GetEntriesFast(); k++) {
+ argument=((TObjString*)pTokensQuote->At(k))->GetString();
+ if (argument.IsWhitespace()) continue;
+ if (k%2) {
+ // every second entry is enclosed by quotes and thus
+ // one single argument
+ array.push_back(argument.Data());
+ } else {
+ TObjArray* pTokens=argument.Tokenize(" ");
+ if (pTokens) {
+ if (pTokens->GetEntriesFast()>0) {
+ for (int n=0; n<pTokens->GetEntriesFast(); n++) {
+ choppedArguments.AddLast(pTokens->At(n));
+ TString data=((TObjString*)pTokens->At(n))->GetString();
+ if (!data.IsNull()) {
+ array.push_back(data.Data());
+ }
+ }
+ pTokens->SetOwner(kFALSE);
+ }
+ delete pTokens;
+ }
+ }
+ }
+ pTokensQuote->SetOwner(kFALSE);
+ }
+ delete pTokensQuote;
+ }
+ }
+
+ for (i=0; (unsigned)i<array.size() && iResult>=0;) {
+ int result=ScanConfigurationArgument(array.size()-i, &array[i]);
+ if (result==0) {
+ HLTWarning("unknown component argument %s", array[i]);
+ i++;
+ } else if (result>0) {
+ i+=result;
+ } else {
+ iResult=result;
+ if (iResult==-EINVAL) {
+ HLTError("unknown argument %s", array[i]);
+ } else if (iResult==-EPROTO) {
+ HLTError("missing/wrong parameter for argument %s (%s)", array[i], (array.size()>(unsigned)i+1)?array[i+1]:"missing");
+ } else {
+ HLTError("scan of argument %s failed (%d)", array[i], iResult);
+ }
+ }
+ }
+
+ return iResult;
+}
+
+int AliHLTComponent::ConfigureFromCDBTObjString(const char* entries, const char* key)
+{
+ // load a list of OCDB objects and configure from the objects
+ // can either be a TObjString or a TMap with a TObjString:TObjString key-value pair
+ int iResult=0;
+ TString arguments;
+ TString confEntries=entries;
+ TObjArray* pTokens=confEntries.Tokenize(" ");
+ if (pTokens) {
+ for (int n=0; n<pTokens->GetEntriesFast(); n++) {
+ const char* path=((TObjString*)pTokens->At(n))->GetString().Data();
+ const char* chainId=GetChainId();
+ HLTInfo("configure from entry \"%s\"%s%s, chain id %s", path, key?" key ":"",key?key:"", (chainId!=NULL && chainId[0]!=0)?chainId:"<none>");
+ TObject* pOCDBObject = LoadAndExtractOCDBObject(path, key);
+ if (pOCDBObject) {
+ TObjString* pString=dynamic_cast<TObjString*>(pOCDBObject);
+ if (!pString) {
+ TMap* pMap=dynamic_cast<TMap*>(pOCDBObject);
+ if (pMap) {
+ // this is the case where no key has been specified and the OCDB
+ // object is a TMap, search for the default key
+ TObject* pObject=pMap->GetValue("default");
+ if (pObject && (pString=dynamic_cast<TObjString*>(pObject))!=NULL) {
+ HLTInfo("using default key of TMap of configuration object \"%s\"", path);
+ } else {
+ HLTError("no default key available in TMap of configuration object \"%s\"", path);
+ iResult=-ENOENT;
+ break;
+ }
+ }
+ }
+
+ if (pString) {
+ HLTInfo("received configuration object string: \'%s\'", pString->GetString().Data());
+ arguments+=pString->GetString().Data();
+ arguments+=" ";
+ } else {
+ HLTError("configuration object \"%s\"%s%s has wrong type, required TObjString", path, key?" key ":"",key?key:"");
+ iResult=-EINVAL;
+ }
+ } else {
+ HLTError("can not fetch object \"%s\" from OCDB", path);
+ iResult=-ENOENT;
+ }
+ }
+ delete pTokens;
+ }
+ if (iResult>=0 && !arguments.IsNull()) {
+ const char* array=arguments.Data();
+ iResult=ConfigureFromArgumentString(1, &array);
+ }
+ return iResult;
+}
+
+TObject* AliHLTComponent::LoadAndExtractOCDBObject(const char* path, int version, int subVersion, const char* key)
+{
+ // see header file for function documentation
+ AliCDBEntry* pEntry=AliHLTMisc::Instance().LoadOCDBEntry(path, GetRunNo(), version, subVersion);
+ if (!pEntry) return NULL;
+ TObject* pObject=AliHLTMisc::Instance().ExtractObject(pEntry);
+ TMap* pMap=dynamic_cast<TMap*>(pObject);
+ if (pMap && key) {
+ pObject=pMap->GetValue(key);
+ if (!pObject) {
+ pObject=pMap->GetValue("default");
+ if (pObject) {
+ HLTWarning("can not find object for key \"%s\" in TMap of configuration object \"%s\", using key \"default\"", key, path);
+ }
+ }
+ if (!pObject) {
+ HLTError("can not find object for key \"%s\" in TMap of configuration object \"%s\"", key, path);
+ return NULL;
+ }
+ }
+ return pObject;
+}
+
int AliHLTComponent::DoInit( int /*argc*/, const char** /*argv*/)
{
// default implementation, childs can overload
return 0;
}
+int AliHLTComponent::ScanConfigurationArgument(int /*argc*/, const char** /*argv*/)
+{
+ // default implementation, childs can overload
+ HLTLogKeyword("dummy");
+ HLTWarning("The function needs to be implemented by the component");
+ return 0;
+}
+
int AliHLTComponent::StartOfRun()
{
// default implementation, childs can overload
return 0;
}
+void AliHLTComponent::GetOCDBObjectDescription( TMap* const /*targetArray*/)
+{
+ // default implementation, childs can overload
+ HLTLogKeyword("dummy");
+}
+
+int AliHLTComponent::CheckOCDBEntries(const TMap* const externList)
+{
+ // check the availability of the OCDB entry descriptions in the TMap
+ // key : complete OCDB path of the entry
+ // value : auxiliary object - short description
+ // if the external map was not provided the function invokes
+ // interface function GetOCDBObjectDescription() to retrieve the list.
+ int iResult=0;
+ if (externList) {
+ iResult=AliHLTMisc::Instance().CheckOCDBEntries(externList);
+ } else {
+ TMap* pMap=new TMap;
+ if (pMap) {
+ pMap->SetOwnerKeyValue(kTRUE);
+ GetOCDBObjectDescription(pMap);
+ iResult=AliHLTMisc::Instance().CheckOCDBEntries(pMap);
+ delete pMap;
+ pMap=NULL;
+ }
+ }
+
+ return iResult;
+}
+
void AliHLTComponent::DataType2Text( const AliHLTComponentDataType& type, char output[kAliHLTComponentDataTypefIDsize+kAliHLTComponentDataTypefOriginSize+2] ) const
{
// see header file for function documentation
// see header file for function documentation
string out("");
+ // 'typeid' 'origin'
+ // aligned to 8 and 4 chars respectively, blocks enclosed in quotes and
+ // separated by blank e.g.
+ // 'DDL_RAW ' 'TPC '
+ if (mode==3) {
+ int i=0;
+ char tmp[8];
+ out+="'";
+ for (i=0; i<kAliHLTComponentDataTypefIDsize; i++) {
+ unsigned char* puc=(unsigned char*)type.fID;
+ if (puc[i]<32)
+ sprintf(tmp, "\\%x", type.fID[i]);
+ else
+ sprintf(tmp, "%c", type.fID[i]);
+ out+=tmp;
+ }
+ out+="' '";
+ for (i=0; i<kAliHLTComponentDataTypefOriginSize; i++) {
+ unsigned char* puc=(unsigned char*)type.fOrigin;
+ if ((puc[i])<32)
+ sprintf(tmp, "\\%x", type.fOrigin[i]);
+ else
+ sprintf(tmp, "%c", type.fOrigin[i]);
+ out+=tmp;
+ }
+ out+="'";
+ return out;
+ }
+
+ // origin typeid as numbers separated by colon e.g.
+ // aligned to 8 and 4 chars respectively, all characters separated by
+ // quotes, e.g.
+ // '84'80'67'32':'68'68'76'95'82'65'87'32'
if (mode==2) {
int i=0;
char tmp[8];
return out;
}
+ // origin typeid separated by colon e.g.
+ // aligned to 8 and 4 chars respectively, all characters separated by
+ // quotes, e.g.
+ // 'T'P'C' ':'D'D'L'_'R'A'W' '
if (mode==1) {
int i=0;
char tmp[8];
return out;
}
+ // origin typeid
+ // aligned to 8 and 4 chars respectively, separated by colon e.g.
+ // TPC :DDL_RAW
if (type==kAliHLTVoidDataType) {
out="VOID:VOID";
} else {
}
-int AliHLTComponent::GetEventDoneData( unsigned long size, AliHLTComponentEventDoneData** edd )
+int AliHLTComponent::GetEventDoneData( unsigned long size, AliHLTComponentEventDoneData** edd ) const
{
// see header file for function documentation
if (fEnvironment.fGetEventDoneDataFunc)
// see header file for function documentation
int iResult=0;
-
- if (size>fEventDoneDataSize) {
- AliHLTComponentEventDoneData* newEDD = reinterpret_cast<AliHLTComponentEventDoneData*>( new AliHLTUInt8_t[ sizeof(AliHLTComponentEventDoneData)+size ] );
+ unsigned long capacity=fEventDoneDataSize;
+ if (fEventDoneData) capacity-=sizeof(AliHLTComponentEventDoneData)+fEventDoneData->fDataSize;
+ if (size>capacity) {
+ unsigned long newSize=sizeof(AliHLTComponentEventDoneData)+size+(fEventDoneDataSize-capacity);
+ AliHLTComponentEventDoneData* newEDD = reinterpret_cast<AliHLTComponentEventDoneData*>( new AliHLTUInt8_t[newSize] );
if (!newEDD)
return -ENOMEM;
newEDD->fStructSize = sizeof(AliHLTComponentEventDoneData);
delete [] reinterpret_cast<AliHLTUInt8_t*>( fEventDoneData );
}
fEventDoneData = newEDD;
- fEventDoneDataSize = size;
+ fEventDoneDataSize = newSize;
}
return iResult;
int AliHLTComponent::PushEventDoneData( AliHLTUInt32_t eddDataWord )
{
+ // see header file for function documentation
if (!fEventDoneData)
return -ENOMEM;
if (fEventDoneData->fDataSize+sizeof(AliHLTUInt32_t)>fEventDoneDataSize)
void AliHLTComponent::ReleaseEventDoneData()
{
- if (fEventDoneData)
+ // see header file for function documentation
+ if (fEventDoneData)
delete [] reinterpret_cast<AliHLTUInt8_t*>( fEventDoneData );
fEventDoneData = NULL;
fEventDoneDataSize = 0;
HLTWarning("component %s indicates multiple output data types but GetOutputDataTypes returns %d", GetComponentID(), count);
}
}
- ((AliHLTComponent*)pConsumer)->GetInputDataTypes(itypes);
+ pConsumer->GetInputDataTypes(itypes);
AliHLTComponentDataTypeList::iterator otype=otypes.begin();
for (;otype!=otypes.end();otype++) {
//PrintDataTypeContent((*otype), "publisher \'%s\'");
if (!fpInputObjects) return 0;
TObjArray* array=fpInputObjects;
fpInputObjects=NULL;
- for (int i=0; i<array->GetEntries(); i++) {
+ for (int i=0; i<array->GetEntriesFast(); i++) {
TObject* pObj=array->At(i);
// grrr, garbage collection strikes back: When read via AliHLTMessage
// (CreateInputObject), and written to a TFile afterwards, the
int iResult=0;
int idx=fCurrentInputBlock;
if (pBlock) {
- if (fpInputObjects==NULL || (idx=FindInputBlock(pBlock))>=0) {
+ if ((idx=FindInputBlock(pBlock))>=0) {
} else {
HLTError("unknown Block %p", pBlock);
iResult=-ENOENT;
ALIHLTCOMPONENT_BASE_STOPWATCH();
int iResult=0;
fLastObjectSize=0;
+ if (fPushbackPeriod>0) {
+ // suppress the output
+ TDatime time;
+ if (fLastPushBackTime<0 || (int)time.Get()-fLastPushBackTime<fPushbackPeriod) return 0;
+ }
if (pObject) {
AliHLTMessage msg(kMESS_OBJECT);
msg.SetCompressionLevel(fCompressionLevel);
{
// see header file for function documentation
ALIHLTCOMPONENT_BASE_STOPWATCH();
+ if (fPushbackPeriod>0) {
+ // suppress the output
+ TDatime time;
+ if (fLastPushBackTime<0 || (int)time.Get()-fLastPushBackTime<fPushbackPeriod) return 0;
+ }
+
return InsertOutputBlock(pBuffer, iSize, dt, spec, pHeader, headerSize);
}
int AliHLTComponent::EstimateObjectSize(TObject* pObject) const
{
// see header file for function documentation
- if (!pObject) return -EINVAL;
- AliHLTMessage msg(kMESS_OBJECT);
- msg.WriteObject(pObject);
- return msg.Length();
+ if (!pObject) return 0;
+
+ AliHLTMessage msg(kMESS_OBJECT);
+ msg.WriteObject(pObject);
+ return msg.Length();
}
AliHLTMemoryFile* AliHLTComponent::CreateMemoryFile(int capacity, const char* dtID,
AliHLTComponentStatisticsList compStats;
bool bAddComponentTableEntry=false;
vector<AliHLTUInt32_t> parentComponentTables;
-#if defined(__DEBUG) || defined(HLT_COMPONENT_STATISTICS)
- AliHLTComponentStatistics outputStat;
- memset(&outputStat, 0, sizeof(AliHLTComponentStatistics));
- outputStat.fStructSize=sizeof(AliHLTComponentStatistics);
- outputStat.fId=fChainIdCrc;
- if (fpBenchmark) {
- fpBenchmark->Stop();
- outputStat.fComponentCycleTime=(AliHLTUInt32_t)(fpBenchmark->RealTime()*ALIHLTCOMPONENT_STATTIME_SCALER);
- fpBenchmark->Reset();
- fpBenchmark->Start();
+#if defined(HLT_COMPONENT_STATISTICS)
+ if ((fFlags&kDisableComponentStat)==0) {
+ AliHLTComponentStatistics outputStat;
+ memset(&outputStat, 0, sizeof(AliHLTComponentStatistics));
+ outputStat.fStructSize=sizeof(AliHLTComponentStatistics);
+ outputStat.fId=fChainIdCrc;
+ if (fpBenchmark) {
+ fpBenchmark->Stop();
+ outputStat.fComponentCycleTime=(AliHLTUInt32_t)(fpBenchmark->RealTime()*ALIHLTCOMPONENT_STATTIME_SCALER);
+ fpBenchmark->Reset();
+ fpBenchmark->Start();
+ }
+ compStats.push_back(outputStat);
}
- compStats.push_back(outputStat);
-#endif
+#endif // HLT_COMPONENT_STATISTICS
// data processing is skipped
// - if there are only steering events in the block list.
indexUpdtDCSEvent=i;
} else if (fpInputBlocks[i].fDataType==kAliHLTDataTypeEvent) {
fEventType=fpInputBlocks[i].fSpecification;
+ if (fEventType != gkAliEventTypeConfiguration and
+ fEventType != gkAliEventTypeReadPreprocessor
+ )
+ {
+ // We can actually get the event type from the CDH if it is valid.
+ // Otherwise just use the specification of the input block.
+ const AliRawDataHeader* cdh;
+ if (ExtractTriggerData(trigData, NULL, NULL, &cdh, NULL) == 0)
+ {
+ fEventType = ExtractEventTypeFromCDH(cdh);
+ }
+ }
// skip always in case of gkAliEventTypeConfiguration
if (fpInputBlocks[i].fSpecification==gkAliEventTypeConfiguration) bSkipDataProcessing|=skipModeForce;
}
}
if (indexEOREvent>=0) {
+ fLastPushBackTime=0; // always send at EOR
bAddComponentTableEntry=true;
if (fpRunDesc!=NULL) {
if (fpRunDesc) {
HLTDebug("EOR run no %d", fpRunDesc->fRunNo);
}
}
- AliHLTRunDesc* pRunDesc=fpRunDesc;
- fpRunDesc=NULL;
- delete pRunDesc;
+ // we do not unload the fpRunDesc struct here in order to have the run information
+ // available during the event processing
+ // https://savannah.cern.ch/bugs/?39711
+ // the info will be cleared in DeInit
}
} else {
HLTWarning("did not receive SOR, ignoring EOR");
// data processing is not skipped if the component explicitly asks
// for the private blocks
- if (fRequireSteeringBlocks) bSkipDataProcessing=0;
+ if ((fFlags&kRequireSteeringBlocks)!=0) bSkipDataProcessing=0;
+
+ if (fpCTPData) {
+ // set the active triggers for this event
+ fpCTPData->SetTriggers(trigData);
+ // increment CTP trigger counters if available
+ if (IsDataEvent()) fpCTPData->Increment(trigData);
+ }
AliHLTComponentBlockDataList blockData;
if (iResult>=0 && !bSkipDataProcessing)
// no output blocks, set size to 0
size=0;
}
+
+ // reset the internal EventData struct
FillEventData(fCurrentEventData);
+
+ // reset the active triggers
+ if (fpCTPData) fpCTPData->SetTriggers(0);
+
+ // set the time for the pushback period
+ if (fPushbackPeriod>0) {
+ // suppress the output
+ TDatime time;
+ if (fLastPushBackTime<0 || (int)time.Get()-fLastPushBackTime>=fPushbackPeriod) {
+ fLastPushBackTime=time.Get();
+ }
+ }
+
return iResult;
}
{
// see header file for function documentation
int iResult=0;
-#if defined(__DEBUG) || defined(HLT_COMPONENT_STATISTICS)
+ if ((fFlags&kDisableComponentStat)!=0) return 0;
+#if defined(HLT_COMPONENT_STATISTICS)
if (stats.size()==0) return -ENOENT;
// check if there is space for at least one entry
if (offset+sizeof(AliHLTComponentStatistics)>bufferSize) return 0;
if (blocks.size() && buffer && bufferSize && offset && stats.size()) {
// get rid of warning
}
-#endif
+#endif // HLT_COMPONENT_STATISTICS
return iResult;
}
{
// see header file for function documentation
int iResult=0;
-#if defined(__DEBUG) || defined(HLT_COMPONENT_STATISTICS)
+ if ((fFlags&kDisableComponentStat)!=0) return 0;
+#if defined(HLT_COMPONENT_STATISTICS)
// the payload consists of the AliHLTComponentTableEntry struct,
// followed by a an array of 32bit crc chain ids and the component
// description string
if (blocks.size() && buffer && bufferSize && offset && parents.size()) {
// get rid of warning
}
- #endif
+#endif // HLT_COMPONENT_STATISTICS
return iResult;
}
fgpCurrent=fpPrec;
}
-int AliHLTComponent::AliHLTStopwatchGuard::Hold(TStopwatch* pSucc)
+int AliHLTComponent::AliHLTStopwatchGuard::Hold(const TStopwatch* pSucc)
{
// see header file for function documentation
if (fpStopwatch!=NULL && fpStopwatch!=pSucc) fpStopwatch->Stop();
return fpStopwatch!=pSucc?1:0;
}
-int AliHLTComponent::AliHLTStopwatchGuard::Resume(TStopwatch* pSucc)
+int AliHLTComponent::AliHLTStopwatchGuard::Resume(const TStopwatch* pSucc)
{
// see header file for function documentation
if (fpStopwatch!=NULL && fpStopwatch!=pSucc) fpStopwatch->Start(kFALSE);
if (pStopwatches==NULL) return -EINVAL;
int iResult=0;
- for (int i=0 ; i<(int)kSWTypeCount && pStopwatches->GetEntries(); i++)
+ for (int i=0 ; i<(int)kSWTypeCount && pStopwatches->GetEntriesFast(); i++)
SetStopwatch(pStopwatches->At(i), (AliHLTStopwatchType)i);
return iResult;
}
AliHLTUInt32_t AliHLTComponent::GetRunNo() const
{
// see header file for function documentation
- if (fpRunDesc==NULL) return kAliHLTVoidRunNo;
+
+ // 2010-02-11 OCDB is now the reliable source for the run number, it is
+ // initialized either by aliroot or the external interface depending
+ // on the environment. It turned out that the rundescriptor is not set
+ // in the aliroot mode, resulting in an invalid run number. However this
+ // did not cause problems until now. OCDB initialization has been revised
+ // already in 10/2009. This was a remnant.
+ // Have to check whether we get rid of the rundescriptor at some point.
+ if (fpRunDesc==NULL) return AliHLTMisc::Instance().GetCDBRunNo();
+ if (fpRunDesc->fRunNo!=(unsigned)AliHLTMisc::Instance().GetCDBRunNo()) {
+ HLTWarning("run number mismatch: ocdb %d run descriptor %d", AliHLTMisc::Instance().GetCDBRunNo(), fpRunDesc->fRunNo);
+ }
return fpRunDesc->fRunNo;
}
return fpRunDesc->fRunType;
}
-bool AliHLTComponent::IsDataEvent(AliHLTUInt32_t* pTgt)
+AliHLTUInt32_t AliHLTComponent::GetTimeStamp() const
+{
+ // see header file for function documentation
+ if (fCurrentEventData.fEventCreation_s) {
+ return fCurrentEventData.fEventCreation_s;
+ }
+ // using the actual UTC if the time stamp was not set by the framework
+ return static_cast<AliHLTUInt32_t>(time(NULL));
+}
+
+AliHLTUInt32_t AliHLTComponent::GetPeriodNumber() const
+{
+ // see header file for function documentation
+ return (GetEventId()>>36)&0xfffffff;
+}
+
+AliHLTUInt32_t AliHLTComponent::GetOrbitNumber() const
+{
+ // see header file for function documentation
+ return (GetEventId()>>12)&0xffffff;
+}
+
+AliHLTUInt16_t AliHLTComponent::GetBunchCrossNumber() const
+{
+ // see header file for function documentation
+ return GetEventId()&0xfff;
+}
+
+bool AliHLTComponent::IsDataEvent(AliHLTUInt32_t* pTgt) const
{
// see header file for function documentation
if (pTgt) *pTgt=fEventType;
return (fEventType==gkAliEventTypeData ||
- fEventType==gkAliEventTypeDataReplay ||
- fEventType==gkAliEventTypeCalibration);
+ fEventType==gkAliEventTypeDataReplay);
}
int AliHLTComponent::CopyStruct(void* pStruct, unsigned int iStructSize, unsigned int iBlockNo,
return iResult;
}
-void AliHLTComponent::SetDDLBit(AliHLTEventDDL &list, Int_t ddlId, Bool_t state ) const
-{
- // see header file for function documentation
-
- // -- Detector offset
- Int_t ddlIdBase = TMath::FloorNint( (Double_t) ddlId / 256.0 );
-
- // -- Word Base = 1. word of detector ( TPC has 8 words, TOF 3 )
- Int_t wordBase = 0;
-
- if ( ddlIdBase <= 3 )
- wordBase = ddlIdBase;
- else if ( ddlIdBase > 3 && ddlIdBase < 5 )
- wordBase = ddlIdBase + 7;
- else
- wordBase = ddlIdBase + 9;
-
- // -- Bit index in Word
- Int_t bitIdx = ddlId % 32;
-
- // -- Index of word
- Int_t wordIdx = wordBase;
-
- // -- if TPC (3) or TOD (5) add word idx
- if ( ( ddlIdBase == 3 ) || ( ddlIdBase == 5 ) ) {
- wordIdx += TMath::FloorNint( (Double_t) ( ddlId - ( ddlIdBase * 256 ) ) / 32.0 );
- }
-
- // -- Set -- 'OR' word with bit mask;
- if ( state )
- list.fList[wordIdx] |= ( 0x00000001 << bitIdx );
- // -- Unset -- 'AND' word with bit mask;
- else
- list.fList[wordIdx] &= ( 0xFFFFFFFF ^ ( 0x00000001 << bitIdx ) );
-}
-
-Int_t AliHLTComponent::GetFirstUsedDDLWord(AliHLTEventDDL &list) const
-{
- // see header file for function documentation
-
- Int_t iResult = -1;
-
- for ( Int_t wordNdx = 0 ; wordNdx < gkAliHLTDDLListSize ; wordNdx++ ) {
-
- if ( list.fList[wordNdx] != 0 && iResult == -1 ) {
- // check for special cases TPC and TOF
- if ( wordNdx > 3 && wordNdx <= 10 ) {
- wordNdx = 10;
- iResult = 3;
- }
- else if ( wordNdx > 12 && wordNdx <= 14 ) {
- wordNdx = 14;
- iResult = 12;
- }
- else
- iResult = wordNdx;
- }
- else if ( list.fList[wordNdx] != 0 && iResult >= 0 ) {
- HLTError( "DDLIDs for minimum of TWO detectors ( %d, %d ) set, this function works only for ONE detector.", iResult, wordNdx );
- iResult = -1;
- break;
- }
- }
-
- return iResult;
-}
-
AliHLTUInt32_t AliHLTComponent::CalculateChecksum(const AliHLTUInt8_t* buffer, int size)
{
// see header file for function documentation
TObjArray* pTokens=descriptor.Tokenize("{");
if (pTokens) {
int n=0;
- if (pTokens->GetEntries()>n) {
+ if (pTokens->GetEntriesFast()>n) {
retChainId=((TObjString*)pTokens->At(n++))->GetString();
}
- if (pTokens->GetEntries()>n) {
+ if (pTokens->GetEntriesFast()>n) {
compId=((TObjString*)pTokens->At(n++))->GetString();
}
delete pTokens;
}
if (!compId.IsNull() && (pTokens=compId.Tokenize(":"))!=NULL) {
int n=0;
- if (pTokens->GetEntries()>n) {
+ if (pTokens->GetEntriesFast()>n) {
compId=((TObjString*)pTokens->At(n++))->GetString();
}
- if (pTokens->GetEntries()>n) {
+ if (pTokens->GetEntriesFast()>n) {
compArgs=((TObjString*)pTokens->At(n++))->GetString();
}
delete pTokens;
return 1;
}
+int AliHLTComponent::ExtractTriggerData(
+ const AliHLTComponentTriggerData& trigData,
+ const AliHLTUInt8_t (**attributes)[gkAliHLTBlockDAttributeCount],
+ AliHLTUInt64_t* status,
+ const AliRawDataHeader** cdh,
+ AliHLTReadoutList* readoutlist,
+ bool printErrors
+ )
+{
+ // see header file for function documentation
+
+ // Check that the trigger data structure is the correct size.
+ if (trigData.fStructSize != sizeof(AliHLTComponentTriggerData))
+ {
+ if (printErrors)
+ {
+ AliHLTLogging log;
+ log.LoggingVarargs(kHLTLogError, Class_Name(), FUNCTIONNAME(), __FILE__, __LINE__,
+ "Invalid trigger structure size: %d but expected %d.", trigData.fStructSize, sizeof(AliHLTComponentTriggerData)
+ );
+ }
+ return -ENOENT;
+ }
+
+ // Get the size of the AliHLTEventTriggerData structure without the readout list part.
+ // The way we do this here should also handle memory alignment correctly.
+ AliHLTEventTriggerData* dummy = NULL;
+ size_t sizeWithoutReadout = (char*)(&dummy->fReadoutList) - (char*)(dummy);
+
+ // Check that the trigger data pointer points to data of a size we can handle.
+ // Either it is the size of AliHLTEventTriggerData or the size of the old
+ // version of AliHLTEventTriggerData using AliHLTEventDDLV0.
+ if (trigData.fDataSize != sizeof(AliHLTEventTriggerData) and
+ trigData.fDataSize != sizeWithoutReadout + sizeof(AliHLTEventDDLV0)
+ )
+ {
+ if (printErrors)
+ {
+ AliHLTLogging log;
+ log.LoggingVarargs(kHLTLogError, Class_Name(), FUNCTIONNAME(), __FILE__, __LINE__,
+ "Invalid trigger data size: %d but expected %d.", trigData.fDataSize, sizeof(AliHLTEventTriggerData)
+ );
+ }
+ return -EBADF;
+ }
+
+ AliHLTEventTriggerData* evtData = reinterpret_cast<AliHLTEventTriggerData*>(trigData.fData);
+ assert(evtData != NULL);
+
+ // Check that the CDH has 8 words.
+ if (cdh != NULL and evtData->fCommonHeaderWordCnt != 8)
+ {
+ if (printErrors)
+ {
+ AliHLTLogging log;
+ log.LoggingVarargs(kHLTLogError, Class_Name(), FUNCTIONNAME(), __FILE__, __LINE__,
+ "Common Data Header (CDH) has wrong number of data words: %d but expected %d",
+ evtData->fCommonHeaderWordCnt, sizeof(AliRawDataHeader)/sizeof(AliHLTUInt32_t)
+ );
+ }
+ return -EBADMSG;
+ }
+
+ // Check that the readout list has the correct count of words. i.e. something we can handle,
+ if (readoutlist != NULL and
+ evtData->fReadoutList.fCount != (unsigned)gkAliHLTDDLListSizeV0 and
+ evtData->fReadoutList.fCount != (unsigned)gkAliHLTDDLListSizeV1
+ )
+ {
+ if (printErrors)
+ {
+ AliHLTLogging log;
+ log.LoggingVarargs(kHLTLogError, Class_Name(), FUNCTIONNAME(), __FILE__, __LINE__,
+ "Readout list structure has wrong number of data words: %d but expected %d",
+ evtData->fReadoutList.fCount, gkAliHLTDDLListSize
+ );
+ }
+ return -EPROTO;
+ }
+
+ if (attributes != NULL)
+ {
+ *attributes = &evtData->fAttributes;
+ }
+ if (status != NULL)
+ {
+ *status = evtData->fHLTStatus;
+ }
+ if (cdh != NULL)
+ {
+ const AliRawDataHeader* cdhptr = reinterpret_cast<const AliRawDataHeader*>(&evtData->fCommonHeader);
+ *cdh = cdhptr;
+ }
+ if (readoutlist != NULL)
+ {
+ *readoutlist = AliHLTReadoutList(evtData->fReadoutList);
+ }
+ return 0;
+}
+
+AliHLTUInt32_t AliHLTComponent::ExtractEventTypeFromCDH(const AliRawDataHeader* cdh)
+{
+ // see header file for function documentation
+
+ UChar_t l1msg = cdh->GetL1TriggerMessage();
+ if ((l1msg & 0x1) == 0x0) return gkAliEventTypeData;
+ // The L2SwC bit must be one if we got here, i.e. l1msg & 0x1 == 0x1.
+ if (((l1msg >> 2) & 0xF) == 0xE) return gkAliEventTypeStartOfRun;
+ if (((l1msg >> 2) & 0xF) == 0xF) return gkAliEventTypeEndOfRun;
+ // Check the C1T bit to see if this is a calibration event,
+ // if not then it must be some other software trigger event.
+ if (((l1msg >> 6) & 0x1) == 0x1) return gkAliEventTypeCalibration;
+ return gkAliEventTypeSoftware;
+}
+
int AliHLTComponent::LoggingVarargs(AliHLTComponentLogSeverity severity,
const char* originClass, const char* originFunc,
const char* file, int line, ... ) const
// without problems. But at this point we face the problem with virtual members which
// are not necessarily const.
AliHLTComponent* nonconst=const_cast<AliHLTComponent*>(this);
- AliHLTLogging::SetLogString("%s (%s, %p): ",
+ AliHLTLogging::SetLogString(this, ", %p", "%s (%s_pfmt_): ",
fChainId[0]!=0?fChainId.c_str():nonconst->GetComponentID(),
- nonconst->GetComponentID(), this);
+ nonconst->GetComponentID());
iResult=SendMessage(severity, originClass, originFunc, file, line, AliHLTLogging::BuildLogString(NULL, args, true /*append*/));
va_end(args);
return iResult;
}
+TUUID AliHLTComponent::GenerateGUID()
+{
+ // Generates a globally unique identifier.
+
+ // Start by creating a new UUID. We cannot use the one automatically generated
+ // by ROOT because the algorithm used will not guarantee unique IDs when generating
+ // these UUIDs at a high rate in parallel.
+ TUUID uuid;
+ // We then use the generated UUID to form part of the random number seeds which
+ // will be used to generate a proper random UUID. For good measure we use a MD5
+ // hash also. Note that we want to use the TUUID class because it will combine the
+ // host address information into the UUID. Using gSystem->GetHostByName() apparently
+ // can cause problems on Windows machines with a firewall, because it always tries
+ // to contact a DNS. The TUUID class handles this case appropriately.
+ union
+ {
+ UChar_t buf[16];
+ UShort_t word[8];
+ UInt_t dword[4];
+ };
+ uuid.GetUUID(buf);
+ TMD5 md5;
+ md5.Update(buf, sizeof(buf));
+ TMD5 md52 = md5;
+ md5.Final(buf);
+ dword[0] += gSystem->GetUid();
+ dword[1] += gSystem->GetGid();
+ dword[2] += gSystem->GetPid();
+ for (int i = 0; i < 4; ++i)
+ {
+ gRandom->SetSeed(dword[i]);
+ dword[i] = gRandom->Integer(0xFFFFFFFF);
+ }
+ md52.Update(buf, sizeof(buf));
+ md52.Final(buf);
+ // To keep to the standard we need to set the version and reserved bits.
+ word[3] = (word[3] & 0x0FFF) | 0x4000;
+ buf[8] = (buf[8] & 0x3F) | 0x80;
+
+ // Create the name of the new class and file.
+ char uuidstr[64];
+ sprintf(uuidstr, "%08x-%04x-%04x-%02x%02x-%02x%02x%02x%02x%02x%02x",
+ dword[0], word[2], word[3], buf[8], buf[9], buf[10], buf[11], buf[12], buf[13], buf[14], buf[15]
+ );
+
+ uuid.SetUUID(uuidstr);
+ return uuid;
+}
+
int AliHLTComponent::ScanECSParam(const char* ecsParam)
{
// see header file for function documentation
// format of the parameter string from ECS
// <command>;<parameterkey>=<parametervalue>;<parameterkey>=<parametervalue>;...
// search for a subset of the parameterkeys
+ // RUN_TYPE=
+ // RUN_NUMBER=
+ // HLT_IN_DDL_LIST=
+ // CTP_TRIGGER_CLASS=
+ // DATA_FORMAT_VERSION=
+ // BEAM_TYPE=
+ // HLT_OUT_DDL_LIST=
+ // HLT_TRIGGER_CODE=
+ // DETECTOR_LIST=
+ // HLT_MODE=
+ // The command apears not to be sent by the online framework
int iResult=0;
TString string=ecsParam;
TObjArray* parameter=string.Tokenize(";");
if (parameter) {
- for (int i=0; i<parameter->GetEntries(); i++) {
+ for (int i=0; i<parameter->GetEntriesFast(); i++) {
TString entry=((TObjString*)parameter->At(i))->GetString();
HLTDebug("scanning ECS entry: %s", entry.Data());
TObjArray* entryParams=entry.Tokenize("=");
if (entryParams) {
- if (entryParams->GetEntries()>1) {
+ if (entryParams->GetEntriesFast()>1) {
if ((((TObjString*)entryParams->At(0))->GetString()).CompareTo("CTP_TRIGGER_CLASS")==0) {
int result=InitCTPTriggerClasses((((TObjString*)entryParams->At(1))->GetString()).Data());
if (iResult>=0 && result<0) iResult=result;
return iResult;
}
-int AliHLTComponent::InitCTPTriggerClasses(const char* ctpString)
+int AliHLTComponent::SetupCTPData()
{
// see header file for function documentation
- if (!ctpString) return -EINVAL;
-
- if (fpTriggerClasses) {
- fpTriggerClasses->Delete();
- } else {
- fpTriggerClasses=new TObjArray(gkNCTPTriggerClasses);
- }
- if (!fpTriggerClasses) return -ENOMEM;
-
- // general format of the CTP_TRIGGER_CLASS parameter
- // <bit position>:<Trigger class identifier string>:<detector-id-nr>-<detector-id-nr>-...,<bit position>:<Trigger class identifier string>:<detector-id-nr>-<detector-id-nr>-...,...
- // the detector ids are ignored for the moment
- HLTDebug(": %s", ctpString);
- TString string=ctpString;
- TObjArray* classEntries=string.Tokenize(",");
- if (classEntries) {
- for (int i=0; i<classEntries->GetEntries(); i++) {
- TString entry=((TObjString*)classEntries->At(i))->GetString();
- TObjArray* entryParams=entry.Tokenize(":");
- if (entryParams) {
- if (entryParams->GetEntries()==3 &&
- (((TObjString*)entryParams->At(0))->GetString()).IsDigit()) {
- int index=(((TObjString*)entryParams->At(0))->GetString()).Atoi();
- if (index<gkNCTPTriggerClasses) {
- fpTriggerClasses->AddAt(new TNamed("TriggerClass", (((TObjString*)entryParams->At(1))->GetString()).Data()), index);
- } else {
- // the trigger bitfield is fixed to 50 bits (gkNCTPTriggerClasses)
- HLTError("invalid trigger class entry %s, index width of trigger bitfield", entry.Data());
- }
- } else {
- HLTError("invalid trigger class entry %s", entry.Data());
- }
- delete entryParams;
- }
- }
- delete classEntries;
- }
+ if (fpCTPData) delete fpCTPData;
+ fpCTPData=new AliHLTCTPData;
+ if (!fpCTPData) return -ENOMEM;
return 0;
}
+int AliHLTComponent::InitCTPTriggerClasses(const char* ctpString)
+{
+ // see header file for function documentation
+ if (!fpCTPData) return 0; // silently accept as the component has to announce that it want's the CTP info
+ return fpCTPData->InitCTPTriggerClasses(ctpString);
+}
+
bool AliHLTComponent::EvaluateCTPTriggerClass(const char* expression, AliHLTComponentTriggerData& trigData) const
{
// see header file for function documentation
- if (!fpTriggerClasses) {
- HLTError("trigger classes not initialized");
+ if (!fpCTPData) {
+ static bool bWarningThrown=false;
+ if (!bWarningThrown) HLTError("Trigger classes not initialized, use SetupCTPData from DoInit()");
+ bWarningThrown=true;
return false;
}
- if (trigData.fDataSize != sizeof(AliHLTEventTriggerData)) {
- HLTError("invalid trigger data size: %d expected %d", trigData.fDataSize, sizeof(AliHLTEventTriggerData));
+ return fpCTPData->EvaluateCTPTriggerClass(expression, trigData);
+}
+
+int AliHLTComponent::CheckCTPTrigger(const char* name) const
+{
+ // see header file for function documentation
+ if (!fpCTPData) {
+ static bool bWarningThrown=false;
+ if (!bWarningThrown) HLTError("Trigger classes not initialized, use SetupCTPData from DoInit()");
+ bWarningThrown=true;
return false;
}
- // trigger mask is 50 bit wide and is stored in word 5 and 6 of the CDH
- AliHLTEventTriggerData* evtData=reinterpret_cast<AliHLTEventTriggerData*>(trigData.fData);
- AliHLTUInt64_t triggerMask=evtData->fCommonHeader[6];
- triggerMask<<=32;
- triggerMask|=evtData->fCommonHeader[5];
+ return fpCTPData->CheckTrigger(name);
+}
- // use a TFormula to interprete the expression
- // all classname are replaced by '[n]' which means the n'th parameter in the formula
- // the parameters are set to 0 or 1 depending on the bit in the trigger mask
- //
- // TODO: this will most likely fail for class names like 'base', 'baseA', 'baseB'
- // the class names must be fully unique, none must be contained as substring in
- // another class name. Probably not needed for the moment but needs to be extended.
- vector<Double_t> par;
- TString condition=expression;
- for (int i=0; i<gkNCTPTriggerClasses; i++) {
- if (fpTriggerClasses->At(i)) {
- TString className=fpTriggerClasses->At(i)->GetTitle();
- //HLTDebug("checking trigger class %s", className.Data());
- if (condition.Contains(className)) {
- TString replace; replace.Form("[%d]", par.size());
- //HLTDebug("replacing %s with %s in \"%s\"", className.Data(), replace.Data(), condition.Data());
- condition.ReplaceAll(className, replace);
- if (triggerMask&((AliHLTUInt64_t)0x1<<i)) par.push_back(1.0);
- else par.push_back(0.0);
- }
- }
- }
+Double_t AliHLTComponent::GetBz()
+{
+ // Returns Bz.
+ return AliHLTMisc::Instance().GetBz();
+}
- TFormula form("trigger expression", condition);
- if (form.Compile()!=0) {
- HLTError("invalid expression %s", expression);
- return false;
- }
- if (form.EvalPar(&par[0], &par[0])>0.5) return true;
- return false;
+Double_t AliHLTComponent::GetBz(const Double_t *r)
+{
+ // Returns Bz (kG) at the point "r" .
+ return AliHLTMisc::Instance().GetBz(r);
+}
+
+void AliHLTComponent::GetBxByBz(const Double_t r[3], Double_t b[3])
+{
+ // Returns Bx, By and Bz (kG) at the point "r" .
+ AliHLTMisc::Instance().GetBxByBz(r, b);
}
git://git.uio.no / u / mrichter / AliRoot.git / blobdiff