|
version 1.32, 2007/09/14 18:33:50
|
version 1.35, 2008/05/15 17:24:34
|
|
|
|
| #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 |
| |
}; |
| |
|
| |
|
| /** 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 |
| LEVEL1 - Function Entry/Exit |
LEVEL1 - Severe and log messages |
| LEVEL2 - Basic flow trace messages, low data detail | LEVEL2 - Basic flow trace messages, low data detail |
| LEVEL3 - Inter-function logic flow, medium data detail | LEVEL3 - Inter-function logic flow, medium data detail |
| LEVEL4 - High data detail | LEVEL4 - High data detail |
|
|
|
| line number of the CIMException originator. | line number of the CIMException originator. |
| @param traceComponent component being traced | @param traceComponent component being traced |
| @param level trace level of the trace message | @param level trace level of the trace message |
| @param CIMException the CIMException to be traced. |
@param cimException the CIMException to be traced. |
| */ | */ |
| static void traceCIMException( | static void traceCIMException( |
| const Uint32 traceComponent, | const Uint32 traceComponent, |
|
|
|
| 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); |
| |
|
| /** 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 Boolean _traceOn; | static Boolean _traceOn; |
| | |
| |
/** Internal only Levels of trace |
| |
These cannot be used in any of the trace calls directly, but are set |
| |
by methods of the Tracer class for specific purposes, such as trace |
| |
Enter and traceExit. |
| |
LEVEL0 - Trace is switched off |
| |
LEVEL5 - used for method enter & exit |
| |
*/ |
| |
static const Uint32 LEVEL0; |
| |
static const Uint32 LEVEL5; |
| |
|
| static const char _COMPONENT_SEPARATOR; | static const char _COMPONENT_SEPARATOR; |
| static const Uint32 _NUM_COMPONENTS; | static const Uint32 _NUM_COMPONENTS; |
| 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; |
| static const Boolean _SUCCESS; |
|
| static const Boolean _FAILURE; |
|
| AutoArrayPtr<Boolean> _traceComponentMask; | AutoArrayPtr<Boolean> _traceComponentMask; |
| |
Uint32 _traceFacility; |
| |
//Is true if any components are set at the component mask |
| |
Boolean _componentsAreSet; |
| Uint32 _traceLevelMask; | Uint32 _traceLevelMask; |
| AutoPtr<TraceFileHandler> _traceHandler; |
AutoPtr<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[]; |
| | |
| // Message Strings for Logger |
// Factory function to create an instance of the matching trace handler |
| static const char _LOG_MSG[]; |
// for the given type of traceFacility. |
| |
// @param traceFacility type of trace handler to create |
| |
// @return an instance of a trace handler class. For invalid trace |
| |
// facilities always creates a traceFileHandler. |
| |
TraceHandler* getTraceHandler( 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. |
|
|
|
| static Tracer* _getInstance(); | static Tracer* _getInstance(); |
| | |
| friend class TraceCallFrame; | friend class TraceCallFrame; |
| |
friend class TracePropertyOwner; |
| }; | }; |
| | |
| //============================================================================== | //============================================================================== |
|
|
|
| // empty function | // empty function |
| } | } |
| | |
| |
inline Uint32 Tracer::setTraceFacility(const String& traceComponents) |
| |
{ |
| |
// empty function |
| |
} |
| |
|
| #endif /* PEGASUS_REMOVE_TRACE */ | #endif /* PEGASUS_REMOVE_TRACE */ |
| | |
| //============================================================================== | //============================================================================== |
|
|
|
| { \ | { \ |
| if (Tracer::isTraceOn()) \ | if (Tracer::isTraceOn()) \ |
| { \ | { \ |
| PEGASUS_ASSERT(level != Tracer::LEVEL1); \ |
|
| if (Tracer::isTraceEnabled(comp, level)) \ | if (Tracer::isTraceEnabled(comp, level)) \ |
| { \ | { \ |
| Tracer::traceCString(PEGASUS_FILE_LINE_COMMA \ | Tracer::traceCString(PEGASUS_FILE_LINE_COMMA \ |
|
|
|
| { \ | { \ |
| if (Tracer::isTraceOn()) \ | if (Tracer::isTraceOn()) \ |
| { \ | { \ |
| PEGASUS_ASSERT(level != Tracer::LEVEL1); \ |
|
| if (Tracer::isTraceEnabled(comp, level)) \ | if (Tracer::isTraceEnabled(comp, level)) \ |
| { \ | { \ |
| Tracer::traceCString(PEGASUS_FILE_LINE_COMMA comp, chars); \ | Tracer::traceCString(PEGASUS_FILE_LINE_COMMA comp, chars); \ |
Return to
Tracer.h
CVS log
Up to [Pegasus] / pegasus / src / Pegasus / Common