#ifndef ALIHLTLOGGING_H
#define ALIHLTLOGGING_H
-/* 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. *
* See cxx source for full Copyright notice */
/** @file AliHLTLogging.h
#include "AliHLTDataTypes.h"
#include "AliHLTStdIncludes.h"
+#include "TString.h"
#include "TObject.h"
+#include "TArrayC.h"
+class AliHLTComponentHandler;
//#define LOG_PREFIX "" // logging prefix, for later extensions
+#define ALILOG_WRAPPER_LIBRARY "libHLTrec.so"
/* the logging macros can be used inside methods of classes which inherit from
* AliHLTLogging
// the following macros are filtered by the Global and Local Log Filter
#define HLTBenchmark( ... ) LoggingVarargs(kHLTLogBenchmark, Class_Name() , FUNCTIONNAME() , __FILE__ , __LINE__ , __VA_ARGS__ )
-#define HLTDebug( ... ) LoggingVarargs(kHLTLogDebug, Class_Name() , FUNCTIONNAME() , __FILE__ , __LINE__ , __VA_ARGS__ )
-#define HLTInfo( ... ) LoggingVarargs(kHLTLogInfo, Class_Name() , FUNCTIONNAME() , __FILE__ , __LINE__ , __VA_ARGS__ )
-#define HLTWarning( ... ) LoggingVarargs(kHLTLogWarning, Class_Name() , FUNCTIONNAME() , __FILE__ , __LINE__ , __VA_ARGS__ )
-#define HLTError( ... ) LoggingVarargs(kHLTLogError, Class_Name() , FUNCTIONNAME() , __FILE__ , __LINE__ , __VA_ARGS__ )
-#define HLTFatal( ... ) LoggingVarargs(kHLTLogFatal, Class_Name() , FUNCTIONNAME() , __FILE__ , __LINE__ , __VA_ARGS__ )
+#ifdef __DEBUG
+#define HLTDebug( ... ) if (CheckFilter(kHLTLogDebug) && CheckGroup(Class_Name())) LoggingVarargs(kHLTLogDebug, Class_Name() , FUNCTIONNAME() , __FILE__ , __LINE__ , __VA_ARGS__ )
+#else
+#define HLTDebug( ... )
+#endif
+#define HLTInfo( ... ) if (CheckFilter(kHLTLogInfo)) LoggingVarargs(kHLTLogInfo, Class_Name() , FUNCTIONNAME() , __FILE__ , __LINE__ , __VA_ARGS__ )
+#define HLTWarning( ... ) if (CheckFilter(kHLTLogWarning)) LoggingVarargs(kHLTLogWarning, Class_Name() , FUNCTIONNAME() , __FILE__ , __LINE__ , __VA_ARGS__ )
+#define HLTError( ... ) if (CheckFilter(kHLTLogError)) LoggingVarargs(kHLTLogError, Class_Name() , FUNCTIONNAME() , __FILE__ , __LINE__ , __VA_ARGS__ )
+#define HLTFatal( ... ) if (CheckFilter(kHLTLogFatal)) LoggingVarargs(kHLTLogFatal, Class_Name() , FUNCTIONNAME() , __FILE__ , __LINE__ , __VA_ARGS__ )
+#define HLTImportant( ... ) if (CheckFilter(kHLTLogImportant))LoggingVarargs(kHLTLogImportant,Class_Name() , FUNCTIONNAME() , __FILE__ , __LINE__ , __VA_ARGS__ )
// helper macro to set the keyword
-#define HLTLogKeyword(a) AliHLTKeyword hltlogTmpkey__LINE__(this, a)
+#define HLTLogKeyword(a) AliHLTKeyword hltlogTmpkey(this, a)
#define HLT_DEFAULT_LOG_KEYWORD "no key"
AliHLTLogging& operator=(const AliHLTLogging&);
virtual ~AliHLTLogging();
- // logging filter for all objects
- //
- static AliHLTComponentLogSeverity SetGlobalLogLevel(AliHLTComponentLogSeverity iLogFilter) {fGlobalLogFilter=iLogFilter; return fGlobalLogFilter;}
-
- // logging filter for individual object
- //
- AliHLTComponentLogSeverity SetLocalLogLevel(AliHLTComponentLogSeverity iLogFilter) {fLocalLogFilter=iLogFilter; return fLocalLogFilter;}
-
- // set the default key word
- // the keyword is intended to simplify the use of logging macros
- //
+ /** set the default key word
+ * the keyword is intended to simplify the use of logging macros
+ */
void SetDefaultKeyword(const char* keyword) { fpDefaultKeyword=keyword; }
- // set a temporary keyword
- // returns the old key value
+ /**
+ * Set a temporary keyword
+ * returns the old key value
+ */
const char* SetKeyword(const char* keyword)
{
const char* currentKeyword=fpCurrentKeyword;
return currentKeyword;
}
- // get the current keyword
- //
+ /**
+ * Get the current keyword
+ */
const char* GetKeyword() const
{
if (fpCurrentKeyword) return fpCurrentKeyword;
return HLT_DEFAULT_LOG_KEYWORD;
}
+ /**
+ * Init the AliLogging class for use from external package.
+ * This initializes the logging callback. <br>
+ * Only deployed by external users of the C wrapper interface, not used
+ * when running in AliRoot
+ */
static int Init(AliHLTfctLogging pFun);
- // genaral logging function
- //
+ /**
+ * Init the message trap in AliLog.
+ * This initializes the AliLog trap, the AliLog class is the logging
+ * mechanism of AliRoot. The trap can fetch log messages written to
+ * AliLog, components and detector algorithms can use the AliLog
+ * mechanism to be as close as possible to Offline habits. <br>
+ * Only used with external users of the C wrapper interface, not used
+ * when running in AliRoot
+ */
+ static int InitAliLogTrap(AliHLTComponentHandler* pHandler);
+
+ /**
+ * Init the AliRoot logging function.
+ * All log messages are redirected to AliLog when running in AliRoot.
+ * Note: when running in PubSub, AliLog messages are redirected to PubSub,
+ * see AliHLTLogging::InitAliLogTrap
+ */
+ static int InitAliLogFunc(AliHLTComponentHandler* pHandler);
+
+ /**
+ * Genaral logging function
+ */
int Logging( AliHLTComponentLogSeverity severity, const char* origin, const char* keyword, const char* message, ... );
- // logging function with two origin parameters, used by the log macros
- //
+ /*
+ * Logging function with two origin parameters, used by the log macros
+ */
int LoggingVarargs(AliHLTComponentLogSeverity severity,
- const char* origin_class, const char* origin_func,
+ const char* originClass, const char* originFunc,
const char* file, int line, ... ) const;
- // apply filter, return 1 if message should pass
- //
+ /**
+ * Evaluate the group of the debug message from the class name.
+ * @return 1 if message should be printed
+ */
+ int CheckGroup(const char* originClass) const;
+
+ /**
+ * Set the black list of classes.
+ * If the white list is set, debug messages are skipped for
+ * all classes matching one of the regular expressions in the string.
+ */
+ static int SetBlackList(const char* classnames);
+
+ /**
+ * Set the white list of classes.
+ * If the white list is set, debug messages are only printed for
+ * classes matching one of the regular expressions in the string.
+ */
+ static int SetWhiteList(const char* classnames);
+
+ /**
+ * Apply filter
+ * @return 1 if message should pass
+ */
int CheckFilter(AliHLTComponentLogSeverity severity) const;
- // set global logging level
- //
+ /**
+ * Set global logging level
+ * logging filter for all objects
+ */
static void SetGlobalLoggingLevel(AliHLTComponentLogSeverity level);
- // set local logging level
- //
- void SetLocalLoggingLevel(AliHLTComponentLogSeverity level);
+ /**
+ * Get global logging level
+ * logging filter for all objects
+ */
+ static AliHLTComponentLogSeverity GetGlobalLoggingLevel();
/**
- * Print message to stdout
+ * Set local logging level
+ * logging filter for individual object
*/
- static int Message(void * param, AliHLTComponentLogSeverity severity, const char* origin, const char* keyword, const char* message);
+ virtual void SetLocalLoggingLevel(AliHLTComponentLogSeverity level);
-#ifndef NOALIROOT_LOGGING
/**
- * Print message through AliRoot log channels.
+ * Get local logging level
+ * logging filter for individual object
*/
- static int AliMessage(AliHLTComponentLogSeverity severity,
- const char* origin_class, const char* origin_func,
- const char* file, int line, const char* message);
-#endif
+ AliHLTComponentLogSeverity GetLocalLoggingLevel();
+
+ /**
+ * Print message to stdout
+ */
+ static int Message(void * param, AliHLTComponentLogSeverity severity, const char* origin, const char* keyword, const char* message);
/**
* Build the log string from format specifier and variadac arguments
*/
static const char* BuildLogString(const char *format, va_list ap);
- virtual void* GetParameter() {return NULL;}
+ /**
+ * Get parameter given by the external caller.
+ * This functionality is not yet implemented. It is intended
+ * to pass the parameter pointer given to the component at
+ * initialization back to the caller.
+ */
+ virtual void* GetParameter() const {return NULL;}
/**
* Switch logging through AliLog on or off
*/
void SwitchAliLog(int sw) {fgUseAliLog=(sw!=0);}
+ /** target stream for AliRoot logging methods */
+ static ostringstream fgLogstr; //! transient
+
+ /**
+ * The message function for dynamic use.
+ * In order to avoid dependencies on AliRoot libraries, libHLTbase loads
+ * the library dynamically and looks for the symbol.
+ */
+ typedef int (*AliHLTDynamicMessage)(AliHLTComponentLogSeverity severity,
+ const char* originClass,
+ const char* originFunc,
+ const char* file, int line,
+ const char* message);
+
+ /**
+ * The init function of the message callback for dynamic use.
+ * In order to avoid dependencies on AliRoot libraries, libHLTbase loads
+ * the library dynamically and looks for the symbol.
+ */
+ typedef int (*InitAliDynamicMessageCallback)();
+
protected:
+ /** the AliRoot logging function */
+ static AliHLTDynamicMessage fgAliLoggingFunc; //! transient
private:
/** the global logging filter */
- static AliHLTComponentLogSeverity fGlobalLogFilter; // see above
+ static AliHLTComponentLogSeverity fgGlobalLogFilter; // see above
/** the local logging filter for one class */
AliHLTComponentLogSeverity fLocalLogFilter; // see above
/** logging callback from the framework */
- static AliHLTfctLogging fLoggingFunc; // see above
+ static AliHLTfctLogging fgLoggingFunc; // see above
/** default keyword */
const char* fpDefaultKeyword; //! transient
/** current keyword */
const char* fpCurrentKeyword; //! transient
/** switch for logging through AliLog, default on */
static int fgUseAliLog; // see above
+ /**
+ * The global logging buffer.
+ * The buffer is created with an initial size and grown dynamically on
+ * demand.
+ */
+ static TArrayC fgAliHLTLoggingTarget; //! transient
+
+ /** the maximum size of the buffer */
+ static const int fgkALIHLTLOGGINGMAXBUFFERSIZE; //! transient
- ClassDef(AliHLTLogging, 1)
+ /** groups of classes not to print debug messages */
+ static TString fgBlackList; //! transient
+
+ /** groups of classes not to print debug messages */
+ static TString fgWhiteList; //! transient
+
+ ClassDef(AliHLTLogging, 3)
};
/* the class AliHLTKeyword is a simple helper class used by the HLTLogKeyword macro
}
private:
- AliHLTLogging* fpParent;
- const char* fpOriginal;
+ AliHLTLogging* fpParent; //! transient
+ const char* fpOriginal; //! transient
};
#endif
git://git.uio.no / u / mrichter / AliRoot.git / blobdiff