pegasus/src/Pegasus/Common/Tracer.h - diff

Return to Tracer.h CVS log

Up to [Pegasus] / pegasus / src / Pegasus / Common

Diff for /pegasus/src/Pegasus/Common/Tracer.h between version 1.39 and 1.44

version 1.39, 2008/09/02 17:33:37

version 1.44, 2008/10/24 06:03:19

Line 39

#include <Pegasus/Common/System.h>

#include <Pegasus/Common/Logger.h>

#include <Pegasus/Common/InternalException.h>

#include <Pegasus/Common/TraceComponents.h>

#include <Pegasus/Common/TraceHandler.h>

#include <Pegasus/Common/Linkage.h>

#include <Pegasus/Common/SharedPtr.h>

PEGASUS_NAMESPACE_BEGIN

/**

Trace component identifiers. This list must be kept in sync with the

TRACE_COMPONENT_LIST in Tracer.cpp.

The tracer uses the _traceComponentMask 64bit field to mask

the user configured components.

Please ensure that no more than 64 Trace Component ID's are specified.

enum TraceComponentId

{

TRC_XML_PARSER,

TRC_XML_WRITER,

TRC_XML_READER,

TRC_XML_IO,

TRC_HTTP,

TRC_CIM_DATA,

TRC_REPOSITORY,

TRC_DISPATCHER,

TRC_OS_ABSTRACTION,

TRC_CONFIG,

TRC_IND_HANDLER,

TRC_AUTHENTICATION,

TRC_AUTHORIZATION,

TRC_USER_MANAGER,

TRC_REGISTRATION,

TRC_SHUTDOWN,

TRC_SERVER,

TRC_INDICATION_SERVICE,

TRC_INDICATION_SERVICE_INTERNAL,

TRC_MESSAGEQUEUESERVICE,

TRC_PROVIDERMANAGER,

TRC_OBJECTRESOLUTION,

TRC_WQL,

TRC_CQL,

TRC_THREAD,

TRC_IPC,

TRC_IND_HANDLE,

TRC_EXP_REQUEST_DISP,

TRC_SSL,

TRC_CONTROLPROVIDER,

TRC_CIMOM_HANDLE,

TRC_L10N,

TRC_EXPORT_CLIENT,

TRC_LISTENER,

TRC_DISCARDED_DATA,

TRC_PROVIDERAGENT,

TRC_IND_FORMATTER,

TRC_STATISTICAL_DATA,

TRC_CMPIPROVIDER,

TRC_INDICATION_GENERATION,

TRC_INDICATION_RECEIPT,

TRC_CMPIPROVIDERINTERFACE,

TRC_WSMSERVER,

TRC_LOGMSG

};

/** Token used for tracing functions.

struct TracerToken

{

Uint32 component;

TraceComponentId component;

const char* method;

};

Line 60

Line 115

{

public:

/** Trace facilities

File - tracing occurs to the trace file

Log - tracing occurs through the Pegasus Logger class

Line 101

Line 155

static void traceCString(

const char* fileName,

const Uint32 lineNum,

const Uint32 traceComponent,

const TraceComponentId traceComponent,

const char* cstring);

/** Traces the message in the given CIMException object. The message

Line 112

Line 166

@param cimException the CIMException to be traced.

static void traceCIMException(

const Uint32 traceComponent,

const TraceComponentId traceComponent,

const Uint32 level,

const CIMException& cimException);

Line 166

Line 220

/** Get trace facility currently in use

@return TRACE_FACILITY_FILE - if trace facility is file

TRACE_FACILITY_LOG - if trace facility is the log

TRACE_FACILITY_MEMORY - if trace facility is memory tracing

static Uint32 getTraceFacility();

Line 191

Line 246

TracerToken& token,

const char* file,

size_t line,

Uint32 component,

TraceComponentId traceComponent,

const char* method);

/** Traces method exit.

Line 235

Line 290

static Boolean isValidTraceFacility( const String& traceFacility );

/** Specify the name of the module being traced. If non-empty, this

/** Signals the trace to be running OOP and provides the file name

extension of the trace file. If non-empty, this

value is used as an extension to the name of the trace file.

@param moduleName Name of the module being traced.

@param oopTraceFileExtension Trace file extension.

static void setModuleName(const String& moduleName);

static void setOOPTraceFileExtension(const String& oopTraceFileExtension);

/**

Line 251

Line 307

// @return 0 if the component and level are not enabled

// 1 if the component and level are enabled

static Boolean isTraceEnabled(

const Uint32 traceComponent,

const TraceComponentId traceComponent,

const Uint32 level);

const Uint32 traceLevel)

{

return ((traceLevel & _traceLevelMask) &&

(_traceComponentMask & ((Uint64)1 << traceComponent)));

}

private:

Line 277

Line 337

static const Uint32 _NUM_COMPONENTS;

static const Uint32 _STRLEN_MAX_UNSIGNED_INT;

static const Uint32 _STRLEN_MAX_PID_TID;

AutoArrayPtr<Boolean> _traceComponentMask;

static Uint64 _traceComponentMask;

static Uint32 _traceLevelMask;

static Tracer* _tracerInstance;

Uint32 _traceMemoryBufferSize;

Uint32 _traceFacility;

//Is true if any components are set at the component mask

Boolean _runningOOP;

Boolean _componentsAreSet;

Uint32 _traceLevelMask;

TraceHandler* _traceHandler;

String _moduleName;

String _traceFile;

static Tracer* _tracerInstance;

String _oopTraceFileExtension;

// Message Strings for function Entry and Exit

static const char _METHOD_ENTER_MSG[];

Line 296

Line 357

// @param traceFacility type of trace handler to create

void _setTraceHandler( Uint32 traceFacility );

// Validates if the given file path if it is eligible for writing traces.

// @param fileName a file intended to be used to write traces

static Boolean _isValidTraceFile(String fileName);

// Traces the given message. Overloaded to include the file name and the

// line number as one of the parameters.

// @param traceComponent component being traced

Line 305

Line 370

static void _trace(

const char* fileName,

const Uint32 lineNum,

const Uint32 traceComponent,

const TraceComponentId traceComponent,

const char* fmt,

va_list argList);

Line 316

Line 381

// @param CIMException the CIMException to be traced.

static void _traceCIMException(

const Uint32 traceComponent,

const TraceComponentId traceComponent,

const CIMException& cimException);

// Called by all the trace interfaces to log message

Line 324

Line 389

// @param traceComponent component being traced

// @param cstring the string to be traced

static void _traceCString(

const Uint32 traceComponent,

const TraceComponentId traceComponent,

const char* message,

const char* cstring);

Line 334

Line 399

// @param *fmt printf style format string

// @param argList variable argument list

static void _trace(

const Uint32 traceComponent,

const TraceComponentId traceComponent,

const char* message,

const char* fmt,

va_list argList);

Line 347

Line 412

static void _traceMethod(

const char* fileName,

const Uint32 lineNum,

const Uint32 traceComponent,

const TraceComponentId traceComponent,

const char* methodEntryExit,

const char* method);

Line 365

Line 430

friend class TraceCallFrame;

friend class TracePropertyOwner;

friend class TraceMemoryHandler;

friend class TraceFileHandler;

};

//==============================================================================

Line 376

Line 443

#ifdef PEGASUS_REMOVE_TRACE

inline void Tracer::setTraceHandler( Uint32 traceFacility );

{

// empty function

}

inline void Tracer::traceCString(

const char* fileName,

const Uint32 lineNum,

const Uint32 traceComponent,

const TraceComponentId traceComponent,

const char* cstring)

{

// empty function

}

inline void Tracer::traceCIMException(

const Uint32 traceComponent,

const TraceComponentId traceComponent,

const Uint32 level,

const CIMException& cimException)

{

Line 422

Line 484

// empty function

}

inline Uint32 Tracer::setTraceFacility(const String& traceComponents)

inline Uint32 Tracer::setTraceFacility(const String& traceFacility)

{

// empty function

return 0;

Line 434

Line 496

return 0;

}

inline static Boolean Trace::setTraceMemoryBufferSize(Uint32 bufferSize)

inline Boolean Tracer::setTraceMemoryBufferSize(Uint32 bufferSize)

{

// empty function

return true;

Line 534

Line 596

PEGASUS_FORMAT(4, 5)

inline void invoke(

const Uint32 component,

const TraceComponentId component,

const Uint32 level,

const char* format,

...)

Legend:

Removed from v.1.39
changed lines
	Added in v.1.44

No CVS admin address has been configured