-// $Id:
+// @(#) $Id$
/**************************************************************************
- * Copyright(c) 1998-1999, ALICE Experiment at CERN, All rights reserved. *
+ * This file is property of and copyright by the ALICE HLT Project *
+ * ALICE Experiment at CERN, All rights reserved. *
* *
- * Authors: Matthias Richter <Matthias.Richter@ift.uib.no> *
- * Timm Steinbeck <timm@kip.uni-heidelberg.de> *
- * Artur Szostak <artursz@iafrica.com> *
- * for The ALICE Off-line Project. *
+ * Primary Authors: Matthias Richter <Matthias.Richter@ift.uib.no> *
+ * for The ALICE HLT Project. *
* *
* Permission to use, copy, modify and distribute this software and its *
* documentation strictly for non-commercial purposes is hereby granted *
* provided "as is" without express or implied warranty. *
**************************************************************************/
-///////////////////////////////////////////////////////////////////////////////
-// //
-// HLT logging tools //
-// //
-///////////////////////////////////////////////////////////////////////////////
+/** @file AliHLTLogging.cxx
+ @author Matthias Richter, Timm Steinbeck
+ @date
+ @brief Implementation of HLT logging primitives.
+*/
-#if __GNUC__== 3
+#if __GNUC__>= 3
using namespace std;
#endif
-#include <cerrno>
-#include "AliL3StandardIncludes.h"
+#include "AliHLTStdIncludes.h"
#include "AliHLTLogging.h"
-#include <cstdarg>
+#include "AliHLTComponentHandler.h"
+#include "TString.h"
+#include "Varargs.h"
#include <string>
+#include <sstream>
+#include <iostream>
-ClassImp(AliHLTLogging)
-
-char AliHLTLogging::fLogBuffer[LOG_BUFFER_SIZE]="";
-char AliHLTLogging::fOriginBuffer[LOG_BUFFER_SIZE]="";
-
-AliHLTComponent_LogSeverity AliHLTLogging::fGlobalLogFilter=kHLTLogAll;
-AliHLTfctLogging AliHLTLogging::fLoggingFunc=NULL;
+/** ROOT macro for the implementation of ROOT specific class methods */
+ClassImp(AliHLTLogging);
AliHLTLogging::AliHLTLogging()
+ :
+ fLocalLogFilter(fgLocalLogDefault),
+ fpDefaultKeyword(NULL),
+ fpCurrentKeyword(NULL)
+{
+ // see header file for class documentation
+ // or
+ // refer to README to build package
+ // or
+ // visit http://web.ift.uib.no/~kjeks/doc/alice-hlt
+}
+
+AliHLTLogging::AliHLTLogging(const AliHLTLogging&)
+ :
+ fLocalLogFilter(kHLTLogAll),
+ fpDefaultKeyword(NULL),
+ fpCurrentKeyword(NULL)
{
- fpDefaultKeyword=NULL;
- fpCurrentKeyword=NULL;
- //fLocalLogFilter=kHLTLogDefault;
- fLocalLogFilter=kHLTLogAll;
+ // see header file for class documentation
+ HLTFatal("copy constructor untested");
}
+AliHLTLogging& AliHLTLogging::operator=(const AliHLTLogging&)
+{
+ // see header file for class documentation
+ HLTFatal("assignment operator untested");
+ return *this;
+}
+
+ostringstream AliHLTLogging::fgLogstr;
+AliHLTComponentLogSeverity AliHLTLogging::fgGlobalLogFilter=kHLTLogAll;
+AliHLTComponentLogSeverity AliHLTLogging::fgLocalLogDefault=kHLTLogAll;
+AliHLTfctLogging AliHLTLogging::fgLoggingFunc=NULL;
+AliHLTLogging::AliHLTDynamicMessage AliHLTLogging::fgAliLoggingFunc=NULL;
+int AliHLTLogging::fgUseAliLog=1;
+
+TString AliHLTLogging::fgBlackList="";
+TString AliHLTLogging::fgWhiteList="";
AliHLTLogging::~AliHLTLogging()
{
+ // see header file for class documentation
}
+// the array will be grown dynamically, this is just an initial size
+TArrayC AliHLTLogging::fgAliHLTLoggingTarget(200);
+// the maximum size of the array
+const int AliHLTLogging::fgkALIHLTLOGGINGMAXBUFFERSIZE=10000;
+
int AliHLTLogging::Init(AliHLTfctLogging pFun)
-{
- if (fLoggingFunc!=NULL && fLoggingFunc!=pFun) {
- (*fLoggingFunc)(NULL/*fParam*/, kHLTLogWarning, "AliHLTLogging::Init", "no key", "overriding previously initialized logging function");
+{
+ // see header file for class documentation
+ if (fgLoggingFunc!=NULL && fgLoggingFunc!=pFun) {
+ (*fgLoggingFunc)(NULL/*fParam*/, kHLTLogWarning, "AliHLTLogging::Init", "no key", "overriding previously initialized logging function");
}
- fLoggingFunc=pFun;
+ fgLoggingFunc=pFun;
+
return 0;
}
-int AliHLTLogging::Message(void *param, AliHLTComponent_LogSeverity severity, const char* origin, const char* keyword, const char* message) {
+int AliHLTLogging::InitAliLogTrap(AliHLTComponentHandler* pHandler)
+{
+ // see header file for class documentation
+ // init the AliRoot logging trap
+ // AliLog messages are redirected to PubSub,
+ int iResult=0;
+ if (pHandler) {
+ // set temporary loglevel of component handler
+ AliHLTComponentLogSeverity loglevel=pHandler->GetLocalLoggingLevel();
+ pHandler->SetLocalLoggingLevel(kHLTLogError);
+
+ // load library containing AliRoot dependencies and initialization handler
+ pHandler->LoadLibrary(ALILOG_WRAPPER_LIBRARY, 0/* do not activate agents */);
+
+ // restore loglevel
+ pHandler->SetLocalLoggingLevel(loglevel);
+
+ // find the symbol
+ InitAliDynamicMessageCallback pFunc=(InitAliDynamicMessageCallback)pHandler->FindSymbol(ALILOG_WRAPPER_LIBRARY, "InitAliDynamicMessageCallback");
+ if (pFunc) {
+ iResult=(*pFunc)();
+ } else {
+ Message(NULL, kHLTLogError, "AliHLTLogging::InitAliLogTrap", "init logging",
+ "can not initialize AliLog callback");
+ iResult=-ENOSYS;
+ }
+ } else {
+ iResult=-EINVAL;
+ }
+
+ return iResult;
+}
+
+int AliHLTLogging::InitAliLogFunc(AliHLTComponentHandler* pHandler)
+{
+ // see header file for class documentation
+ int iResult=0;
+ if (pHandler) {
+ // set temporary loglevel of component handler
+ AliHLTComponentLogSeverity loglevel=pHandler->GetLocalLoggingLevel();
+ pHandler->SetLocalLoggingLevel(kHLTLogError);
+
+ // load library containing AliRoot dependencies and initialization handler
+ pHandler->LoadLibrary(ALILOG_WRAPPER_LIBRARY, 0/* do not activate agents */);
+
+ // restore loglevel
+ pHandler->SetLocalLoggingLevel(loglevel);
+
+ // find the symbol
+ fgAliLoggingFunc=(AliHLTLogging::AliHLTDynamicMessage)pHandler->FindSymbol(ALILOG_WRAPPER_LIBRARY, "AliDynamicMessage");
+ if (fgAliLoggingFunc==NULL) {
+ Message(NULL, kHLTLogError, "AliHLTLogging::InitAliLogFunc", "init logging",
+ "symbol lookp failure: can not find AliDynamicMessage, switching to HLT logging system");
+ iResult=-ENOSYS;
+ }
+ } else {
+ iResult=-EINVAL;
+ }
+
+ return iResult;
+}
+
+int AliHLTLogging::Message(void *param, AliHLTComponentLogSeverity severity,
+ const char* origin, const char* keyword,
+ const char* message)
+{
+ // see header file for class documentation
int iResult=0;
+ if (param==NULL) {
+ // this is currently just to get rid of the warning "unused parameter"
+ }
+
const char* strSeverity="";
switch (severity) {
case kHLTLogBenchmark:
case kHLTLogFatal:
strSeverity="fatal";
break;
+ case kHLTLogImportant:
+ strSeverity="notify";
+ break;
default:
break;
}
- cout << "HLT Log " << strSeverity << ": " << origin << " " << message;
- if (strcmp(keyword, HLT_DEFAULT_LOG_KEYWORD)!=0)
- cout << " (" << keyword << ")";
- cout << endl;
+ TString out="HLT Log ";
+ out+=strSeverity;
+ if (origin && origin[0]!=0) {out+=": <"; out+=origin; out+="> ";}
+ out+=" "; out+=message;
+ if (keyword!=NULL && strcmp(keyword, HLT_DEFAULT_LOG_KEYWORD)!=0) {
+ out+=" ("; out+=keyword; out +=")";
+ }
+ cout << out.Data() << endl;
return iResult;
}
-const char* AliHLTLogging::BuildLogString(const char *format, va_list ap) {
- int tgtLen=0;
- int iBufferSize=LOG_BUFFER_SIZE;
- char* tgtBuffer=fLogBuffer;
- tgtBuffer[tgtLen]=0;
+#if 0
+int AliHLTLogging::AliMessage(AliHLTComponentLogSeverity severity,
+ const char* originClass, const char* originFunc,
+ const char* file, int line, const char* message)
+{
+ // see header file for class documentation
-#if (defined LOG_PREFIX)
- tgtLen = snprintf(tgtBuffer, iBufferSize, LOG_PREFIX); // add logging prefix
+ switch (severity) {
+ case kHLTLogBenchmark:
+ AliLog::Message(AliLog::kInfo, message, "HLT", originClass, originFunc, file, line);
+ break;
+ case kHLTLogDebug:
+ AliLog::Message(AliLog::kDebug, message, "HLT", originClass, originFunc, file, line);
+ break;
+ case kHLTLogInfo:
+ AliLog::Message(AliLog::kInfo, message, "HLT", originClass, originFunc, file, line);
+ break;
+ case kHLTLogWarning:
+ AliLog::Message(AliLog::kWarning, message, "HLT", originClass, originFunc, file, line);
+ break;
+ case kHLTLogError:
+ AliLog::Message(AliLog::kError, message, "HLT", originClass, originFunc, file, line);
+ break;
+ case kHLTLogFatal:
+ AliLog::Message(AliLog::kWarning, message, "HLT", originClass, originFunc, file, line);
+ break;
+ default:
+ break;
+ }
+ return 0;
+}
#endif
- if (tgtLen>=0) {
- tgtBuffer+=tgtLen; iBufferSize-=tgtLen;
- tgtLen = vsnprintf(tgtBuffer, iBufferSize, format, ap);
- if (tgtLen>0) {
- tgtBuffer+=tgtLen;
-// if (tgtLen<LOG_BUFFER_SIZE-1) {
-// *tgtBuffer++='\n'; // add newline if space in buffer
-// }
- *tgtBuffer=0; // terminate the buffer
- }
+
+const char* AliHLTLogging::BuildLogString(const char *format, va_list ap, bool bAppend)
+{
+ // see header file for class documentation
+
+ int iResult=0;
+#ifdef R__VA_COPY
+ va_list bap;
+ R__VA_COPY(bap, ap);
+#endif //R__VA_COPY
+
+ // take the first argument from the list as format string if no
+ // format was given
+ const char* fmt = format;
+ if (fmt==NULL) fmt=va_arg(ap, const char*);
+
+ unsigned int iOffset=0;
+ if (bAppend) {
+ iOffset=strlen(fgAliHLTLoggingTarget.GetArray());
+ } else {
+ fgAliHLTLoggingTarget[0]=0;
}
- return fLogBuffer;
+ while (fmt!=NULL) {
+ iResult=vsnprintf(fgAliHLTLoggingTarget.GetArray()+iOffset, fgAliHLTLoggingTarget.GetSize()-iOffset, fmt, ap);
+ if (iResult==-1)
+ // for compatibility with older version of vsnprintf
+ iResult=fgAliHLTLoggingTarget.GetSize()*2;
+ else
+ iResult+=iOffset;
+
+ if (iResult<fgAliHLTLoggingTarget.GetSize())
+ // everything in the limit
+ break;
+
+ // terminate if buffer is already at the limit
+ if (fgAliHLTLoggingTarget.GetSize()>=fgkALIHLTLOGGINGMAXBUFFERSIZE)
+ {
+ fgAliHLTLoggingTarget[fgAliHLTLoggingTarget.GetSize()-1]=0;
+ break;
+ }
+
+ // check limitation and grow the buffer
+ if (iResult>fgkALIHLTLOGGINGMAXBUFFERSIZE) iResult=fgkALIHLTLOGGINGMAXBUFFERSIZE;
+ fgAliHLTLoggingTarget.Set(iResult+1);
+
+ // copy the original list and skip the first argument if this was the format string
+#ifdef R__VA_COPY
+ va_end(ap);
+ R__VA_COPY(ap, bap);
+#else
+ fgAliHLTLoggingTarget[fgAliHLTLoggingTarget.GetSize()-1]=0;
+ break;
+#endif //R__VA_COPY
+ if (format==NULL) va_arg(ap, const char*);
+ }
+#ifdef R__VA_COPY
+ va_end(bap);
+#endif //R__VA_COPY
+
+ return fgAliHLTLoggingTarget.GetArray();
}
-int AliHLTLogging::Logging(AliHLTComponent_LogSeverity severity, const char* origin, const char* keyword, const char* format, ... ) {
+const char* AliHLTLogging::SetLogString(const void* p, const char* pfmt, const char *format, ...)
+{
+ // see header file for class documentation
+ if (!p || !pfmt) return NULL;
+ TString formatstr=format;
+ TString pstr;
+#ifdef __DEBUG
+ pstr.Form(pfmt, p);
+#endif
+ formatstr.ReplaceAll("_pfmt_", pstr);
+ va_list args;
+ va_start(args, format);
+
+ const char* message=BuildLogString(formatstr.Data(), args);
+ va_end(args);
+
+ return message;
+}
+
+int AliHLTLogging::Logging(AliHLTComponentLogSeverity severity,
+ const char* origin, const char* keyword,
+ const char* format, ... )
+{
+ // see header file for class documentation
int iResult=CheckFilter(severity);
if (iResult>0) {
va_list args;
va_start(args, format);
- if (fLoggingFunc) {
- iResult = (*fLoggingFunc)(NULL/*fParam*/, severity, origin, keyword, AliHLTLogging::BuildLogString(format, args ));
+ if (fgLoggingFunc) {
+ iResult = (*fgLoggingFunc)(NULL/*fParam*/, severity, origin, keyword, AliHLTLogging::BuildLogString(format, args ));
} else {
- iResult = Message(NULL/*fParam*/, severity, origin, keyword, AliHLTLogging::BuildLogString(format, args ));
+ if (fgUseAliLog!=0 && fgAliLoggingFunc!=NULL)
+ iResult=(*fgAliLoggingFunc)(severity, NULL, origin, NULL, 0, AliHLTLogging::BuildLogString(format, args ));
+ else
+ iResult=Message(NULL/*fParam*/, severity, origin, keyword, AliHLTLogging::BuildLogString(format, args ));
}
+ va_end(args);
}
return iResult;
}
-int AliHLTLogging::LoggingVarargs( AliHLTComponent_LogSeverity severity, const char* origin_class, const char* origin_func, ... )
+int AliHLTLogging::LoggingVarargs(AliHLTComponentLogSeverity severity,
+ const char* originClass, const char* originFunc,
+ const char* file, int line, ... ) const
{
- int iResult=CheckFilter(severity);
- if (iResult>0) {
- int iMaxSize=LOG_BUFFER_SIZE-1;
- int iPos=0;
- const char* separator="";
- fOriginBuffer[iPos]=0;
- if (origin_class) {
- if ((int)strlen(origin_class)<iMaxSize-iPos) {
- strcpy(&fOriginBuffer[iPos], origin_class);
- iPos+=strlen(origin_class);
- separator="::";
- }
- }
- if (origin_func) {
- if ((int)strlen(origin_func)+(int)strlen(separator)<iMaxSize-iPos) {
- strcpy(&fOriginBuffer[iPos], separator);
- iPos+=strlen(separator);
- strcpy(&fOriginBuffer[iPos], origin_func);
- iPos+=strlen(origin_func);
- }
- }
- va_list args;
- va_start(args, origin_func);
- const char* format = va_arg(args, const char*);
+ // see header file for class documentation
+ int iResult=0;
- const char* message=format;
- char* qualifier=NULL;
- if ((qualifier=strchr(format, '%'))!=NULL) {
- message=AliHLTLogging::BuildLogString(format, args);
- }
- if (fLoggingFunc) {
- iResult=(*fLoggingFunc)(NULL/*fParam*/, severity, fOriginBuffer, GetKeyword(), message);
- } else {
- iResult=Message(NULL/*fParam*/, severity, fOriginBuffer, GetKeyword(), message);
- }
- va_end(args);
+ va_list args;
+ va_start(args, line);
+
+ iResult=SendMessage(severity, originClass, originFunc, file, line, AliHLTLogging::BuildLogString(NULL, args ));
+ va_end(args);
+
+ return iResult;
+}
+
+int AliHLTLogging::SendMessage(AliHLTComponentLogSeverity severity,
+ const char* originClass, const char* originFunc,
+ const char* file, int line,
+ const char* message) const
+{
+ // see header file for class documentation
+ int iResult=0;
+ const char* separator="";
+ TString origin;
+ if (originClass) {
+ origin+=originClass;
+ separator="::";
+ }
+ if (originFunc) {
+ origin+=separator;
+ origin+=originFunc;
+ }
+
+ if (fgLoggingFunc) {
+ iResult=(*fgLoggingFunc)(NULL/*fParam*/, severity, origin.Data(), GetKeyword(), message);
+ } else {
+ if (fgUseAliLog!=0 && fgAliLoggingFunc!=NULL)
+ iResult=(*fgAliLoggingFunc)(severity, originClass, originFunc, file, line, message);
+ else
+ iResult=Message(NULL/*fParam*/, severity, origin.Data(), GetKeyword(), message);
}
return iResult;
}
-int AliHLTLogging::CheckFilter(AliHLTComponent_LogSeverity severity)
+int AliHLTLogging::CheckFilter(AliHLTComponentLogSeverity severity) const
{
- int iResult=severity==kHLTLogNone || (severity&fGlobalLogFilter)>0 && (severity&fLocalLogFilter)>0;
+ // see header file for class documentation
+
+ int iResult=severity==kHLTLogNone || ((severity&fgGlobalLogFilter)>0 && (severity&fLocalLogFilter)>0);
return iResult;
}
+
+void AliHLTLogging::SetGlobalLoggingLevel(AliHLTComponentLogSeverity level)
+{
+ // see header file for class documentation
+
+ fgGlobalLogFilter=level;
+}
+
+AliHLTComponentLogSeverity AliHLTLogging::GetGlobalLoggingLevel()
+{
+ // see header file for class documentation
+
+ return fgGlobalLogFilter;
+}
+
+void AliHLTLogging::SetLocalLoggingLevel(AliHLTComponentLogSeverity level)
+{
+ // see header file for class documentation
+
+ fLocalLogFilter=level;
+}
+
+
+AliHLTComponentLogSeverity AliHLTLogging::GetLocalLoggingLevel()
+{
+ // see header file for class documentation
+
+ return fLocalLogFilter;
+}
+
+void AliHLTLogging::SetLocalLoggingDefault(AliHLTComponentLogSeverity level)
+{
+ // see header file for class documentation
+ fgLocalLogDefault=level;
+}
+
+int AliHLTLogging::CheckGroup(const char* /*originClass*/) const
+{
+ // see header file for class documentation
+
+ return 1;
+}
+
+int AliHLTLogging::SetBlackList(const char* classnames)
+{
+ // see header file for class documentation
+
+ if (classnames)
+ fgBlackList=classnames;
+ return 0;
+}
+
+int AliHLTLogging::SetWhiteList(const char* classnames)
+{
+ // see header file for class documentation
+
+ if (classnames)
+ fgWhiteList=classnames;
+ return 0;
+}