pa_trace.h File Reference

Real-time safe event trace logging facility for debugging. More...

Go to the source code of this file.

Macros
#define	PA_TRACE_REALTIME_EVENTS   (0)
#define	PA_MAX_TRACE_RECORDS   (2048)
#define	PaUtil_ResetTraceMessages()
	Clear the trace buffer.
#define	PaUtil_AddTraceMessage(msg, data)
#define	PaUtil_DumpTraceMessages()
	Print all messages in the trace buffer to stdout and clear the trace buffer.
#define	PaUtil_InitializeHighSpeedLog(phLog, maxSizeInBytes)
#define	PaUtil_ResetHighSpeedLogTimeRef(hLog)
#define	PaUtil_AddHighSpeedLogMessage(...)
#define	PaUtil_DumpHighSpeedLog(hLog, fileName)
#define	PaUtil_DiscardHighSpeedLog(hLog)

Detailed Description

Real-time safe event trace logging facility for debugging.

Allows data to be logged to a fixed size trace buffer in a real-time execution context (such as at interrupt time). Each log entry consists of a message comprising a string pointer and an int. The trace buffer may be dumped to stdout later.

This facility is only active if PA_TRACE_REALTIME_EVENTS is set to 1, otherwise the trace functions expand to no-ops.

Macro Definition Documentation

PA_MAX_TRACE_RECORDS

#define PA_MAX_TRACE_RECORDS   (2048)

Maximum number of records stored in trace buffer

PA_TRACE_REALTIME_EVENTS

#define PA_TRACE_REALTIME_EVENTS   (0)

Set to 1 to enable logging using the trace functions defined below

PaUtil_AddHighSpeedLogMessage

#define PaUtil_AddHighSpeedLogMessage

(

...

)

Value:

(0)

PaUtil_AddTraceMessage

#define PaUtil_AddTraceMessage	(		msg,
			data )

Value:

/* noop */

PaUtil_DiscardHighSpeedLog

#define PaUtil_DiscardHighSpeedLog

(

hLog

)

Referenced by ProcessingThread().

PaUtil_DumpHighSpeedLog

#define PaUtil_DumpHighSpeedLog	(		hLog,
			fileName )

Referenced by ProcessingThread().

PaUtil_DumpTraceMessages

#define PaUtil_DumpTraceMessages

(

)

Value:

/* noop */

Print all messages in the trace buffer to stdout and clear the trace buffer.

Referenced by Pa_Terminate().

PaUtil_InitializeHighSpeedLog

#define PaUtil_InitializeHighSpeedLog	(		phLog,
			maxSizeInBytes )

Value:

(0)

Referenced by ProcessingThread().

PaUtil_ResetHighSpeedLogTimeRef

#define PaUtil_ResetHighSpeedLogTimeRef

(

hLog

)

PaUtil_ResetTraceMessages

#define PaUtil_ResetTraceMessages

(

)

Value:

/* noop */

Clear the trace buffer.

Referenced by Pa_Initialize().