SysprogsProfiler.h File Reference

Go to the source code of this file.

Functions
void	InitializeSamplingProfiler ()
	Should be called from your main() function after initializing the system clock. More...
void	SysprogsProfiler_ProcessSample (void *PC, void *SP, void *FP, void *LR)
	Should be called from the timer ISR implemented by the platform driver. More...
void	InitializeInstrumentingProfiler ()
	Should be called from your main() function before using the instrumenting profiler. More...
void	ReportTicksPerSecond (unsigned ticksPerSecond)
	Reports the profiler clock resolution to the host. More...

Detailed Description

Profiler Framework The Sysprogs Profiler framework consists of 3 components:

• Profiler core
• Platform driver
• Interface driver

The profiler core collects the data from the stack and compresses it using the common format.

The platform driver configures one of the hardware timers to trigger periodic interrupts and calls the SysprogsProfiler_ProcessSample() function from the ISR.

The interface driver sends arbitrary packets of data to the profiler client running on your development machine. The profiler framework includes a universal driver that uses the fast semihosting mechanism to transfer the data at approximately 40-50KB/s.

Function Documentation

void InitializeInstrumentingProfiler

(

)

Should be called from your main() function before using the instrumenting profiler.

void InitializeSamplingProfiler

(

)

Should be called from your main() function after initializing the system clock.

Remarks

If this function is not implemented, you are missing a profiler driver for your platform. See the STM32 driver for an implementation example.

void ReportTicksPerSecond

(

unsigned

ticksPerSecond

)

Reports the profiler clock resolution to the host.

Use this function to report the resolution of the profiler clock (i.e. the meaning of the values returned by SysprogsInstrumentingProfiler_QueryAndResetPerformanceCounter) to the host. This allows VisualGDB to report physical time values instead of just ticks.

void SysprogsProfiler_ProcessSample	(	void *	PC,
		void *	SP,
		void *	FP,
		void *	LR
	)

Should be called from the timer ISR implemented by the platform driver.

The arguments specify the values of the key ARM registers at the time the main code was interrupted by the ISR. The profiler will automatically reconstruct the stack from those and count it in the final report.