|
version 1.34, 2008/05/12 09:17:34
|
version 1.39, 2008/09/02 17:33:37
|
|
|
|
| #include <Pegasus/Common/Logger.h> | #include <Pegasus/Common/Logger.h> |
| #include <Pegasus/Common/InternalException.h> | #include <Pegasus/Common/InternalException.h> |
| #include <Pegasus/Common/TraceComponents.h> | #include <Pegasus/Common/TraceComponents.h> |
| #include <Pegasus/Common/TraceFileHandler.h> |
#include <Pegasus/Common/TraceHandler.h> |
| #include <Pegasus/Common/Linkage.h> | #include <Pegasus/Common/Linkage.h> |
| #include <Pegasus/Common/SharedPtr.h> | #include <Pegasus/Common/SharedPtr.h> |
| | |
|
|
|
| { | { |
| public: | public: |
| | |
| |
|
| |
/** Trace facilities |
| |
File - tracing occurs to the trace file |
| |
Log - tracing occurs through the Pegasus Logger class |
| |
Keep the TRACE_FACILITY_LIST in sync with the TRACE_FACILITY_INDEX, |
| |
so that the index matches the according string in the list. |
| |
*/ |
| |
static char const* TRACE_FACILITY_LIST[]; |
| |
|
| |
enum TRACE_FACILITY_INDEX |
| |
{ |
| |
TRACE_FACILITY_FILE = 0, |
| |
TRACE_FACILITY_LOG = 1, |
| |
TRACE_FACILITY_MEMORY = 2 |
| |
}; |
| |
|
| |
|
| /** Levels of trace | /** Levels of trace |
| Trace messages are written to the trace file only if they are at or | Trace messages are written to the trace file only if they are at or |
| above a given trace level | above a given trace level |
|
|
|
| static void setTraceComponents( | static void setTraceComponents( |
| const String& traceComponents); | const String& traceComponents); |
| | |
| |
/** Set trace facility to be used |
| |
@param traceFacility facility to be used for tracing, |
| |
for example Log or File. |
| |
@return 0 if trace facility is valid |
| |
1 if trace facility is invalid |
| |
*/ |
| |
static Uint32 setTraceFacility(const String& traceFacility); |
| |
|
| |
/** Get trace facility currently in use |
| |
@return TRACE_FACILITY_FILE - if trace facility is file |
| |
TRACE_FACILITY_LOG - if trace facility is the log |
| |
*/ |
| |
static Uint32 getTraceFacility(); |
| |
|
| |
/** Set buffer size to be used for the memory tracing facility |
| |
@param bufferSize buffer size in Kbyte to be used for memory tracing |
| |
@return true if function was successfully. |
| |
*/ |
| |
static Boolean setTraceMemoryBufferSize(Uint32 bufferSize); |
| |
|
| |
/** Flushes the trace buffer to traceFilePath. This method will only |
| |
have an effect when traceFacility=Memory. |
| |
*/ |
| |
static void flushTrace(); |
| |
|
| /** Traces method entry. | /** Traces method entry. |
| @param token TracerToken | @param token TracerToken |
| @param fileName filename of the trace originator | @param fileName filename of the trace originator |
|
|
|
| const String& traceComponents, | const String& traceComponents, |
| String& invalidComponents); | String& invalidComponents); |
| | |
| |
/** Validates the trace facility string value |
| |
@param traceFacility The trace facility as string |
| |
@return 1 if the trace facility is valid |
| |
0 if the trace facility is invalid |
| |
*/ |
| |
static Boolean isValidTraceFacility( const String& traceFacility ); |
| |
|
| /** Specify the name of the module being traced. If non-empty, this | /** Specify the name of the module being traced. If non-empty, this |
| value is used as an extension to the name of the trace file. | value is used as an extension to the name of the trace file. |
| @param moduleName Name of the module being traced. | @param moduleName Name of the module being traced. |
|
|
|
| static const Uint32 _STRLEN_MAX_UNSIGNED_INT; | static const Uint32 _STRLEN_MAX_UNSIGNED_INT; |
| static const Uint32 _STRLEN_MAX_PID_TID; | static const Uint32 _STRLEN_MAX_PID_TID; |
| AutoArrayPtr<Boolean> _traceComponentMask; | AutoArrayPtr<Boolean> _traceComponentMask; |
| |
Uint32 _traceMemoryBufferSize; |
| |
Uint32 _traceFacility; |
| //Is true if any components are set at the component mask | //Is true if any components are set at the component mask |
| Boolean _componentsAreSet; | Boolean _componentsAreSet; |
| Uint32 _traceLevelMask; | Uint32 _traceLevelMask; |
| AutoPtr<TraceFileHandler> _traceHandler; |
TraceHandler* _traceHandler; |
| String _moduleName; | String _moduleName; |
| static Tracer* _tracerInstance; | static Tracer* _tracerInstance; |
| | |
|
|
|
| static const char _METHOD_ENTER_MSG[]; | static const char _METHOD_ENTER_MSG[]; |
| static const char _METHOD_EXIT_MSG[]; | static const char _METHOD_EXIT_MSG[]; |
| | |
| |
// Factory function to create an instance of the matching trace handler |
| |
// for the given type of traceFacility. |
| |
// @param traceFacility type of trace handler to create |
| |
void _setTraceHandler( Uint32 traceFacility ); |
| |
|
| // Traces the given message. Overloaded to include the file name and the | // Traces the given message. Overloaded to include the file name and the |
| // line number as one of the parameters. | // line number as one of the parameters. |
| // @param traceComponent component being traced | // @param traceComponent component being traced |
|
|
|
| | |
| #ifdef PEGASUS_REMOVE_TRACE | #ifdef PEGASUS_REMOVE_TRACE |
| | |
| |
inline void Tracer::setTraceHandler( Uint32 traceFacility ); |
| |
{ |
| |
// empty function |
| |
} |
| |
|
| inline void Tracer::traceCString( | inline void Tracer::traceCString( |
| const char* fileName, | const char* fileName, |
| const Uint32 lineNum, | const Uint32 lineNum, |
|
|
|
| // empty function | // empty function |
| } | } |
| | |
| |
inline Uint32 Tracer::setTraceFacility(const String& traceComponents) |
| |
{ |
| |
// empty function |
| |
return 0; |
| |
} |
| |
|
| |
inline Uint32 Tracer::getTraceFacility() |
| |
{ |
| |
// empty function |
| |
return 0; |
| |
} |
| |
|
| |
inline static Boolean Trace::setTraceMemoryBufferSize(Uint32 bufferSize) |
| |
{ |
| |
// empty function |
| |
return true; |
| |
} |
| |
|
| |
inline void Tracer::flushTrace() |
| |
{ |
| |
// empty function |
| |
return; |
| |
} |
| |
|
| #endif /* PEGASUS_REMOVE_TRACE */ | #endif /* PEGASUS_REMOVE_TRACE */ |
| | |
| //============================================================================== | //============================================================================== |
|
|
|
| | |
| # define PEG_METHOD_ENTER(comp,meth) | # define PEG_METHOD_ENTER(comp,meth) |
| # define PEG_METHOD_EXIT() | # define PEG_METHOD_EXIT() |
| # define PEG_TRACE_STRING(comp,level,string) |
|
| # define PEG_TRACE(VAR_ARGS) | # define PEG_TRACE(VAR_ARGS) |
| # define PEG_TRACE_CSTRING(comp,level,chars) | # define PEG_TRACE_CSTRING(comp,level,chars) |
| | |
| #else /* PEGASUS_REMOVE_TRACE */ | #else /* PEGASUS_REMOVE_TRACE */ |
| | |
| |
// remover trace code for method enter/exit |
| |
# ifdef PEGASUS_REMOVE_METHODTRACE |
| |
# define PEG_METHOD_ENTER(comp,meth) |
| |
# define PEG_METHOD_EXIT() |
| |
# else |
| # define PEG_METHOD_ENTER(comp, meth) \ | # define PEG_METHOD_ENTER(comp, meth) \ |
| TracerToken __tracerToken; \ | TracerToken __tracerToken; \ |
| __tracerToken.method = 0; \ | __tracerToken.method = 0; \ |
|
|
|
| Tracer::traceExit(__tracerToken PEGASUS_COMMA_FILE_LINE); \ | Tracer::traceExit(__tracerToken PEGASUS_COMMA_FILE_LINE); \ |
| } \ | } \ |
| while (0) | while (0) |
| |
# endif |
| // Macro for Trace String. the do construct allows this to appear |
|
| // as a single statement. |
|
| # define PEG_TRACE_STRING(comp, level, string) \ |
|
| do \ |
|
| { \ |
|
| if (Tracer::isTraceOn()) \ |
|
| { \ |
|
| if (Tracer::isTraceEnabled(comp, level)) \ |
|
| { \ |
|
| Tracer::traceCString(PEGASUS_FILE_LINE_COMMA \ |
|
| comp, \ |
|
| (const char*) (string).getCString()); \ |
|
| } \ |
|
| } \ |
|
| } \ |
|
| while (0) |
|
| | |
| // Macro to trace character lists. the do construct allows this to appear | // Macro to trace character lists. the do construct allows this to appear |
| // as a single statement. | // as a single statement. |
Return to
Tracer.h
CVS log
Up to [Pegasus] / pegasus / src / Pegasus / Common