TMR.xx-x86-gcc.h File Reference

Provides the implementation of the timing macros on a X86 platform using the GCC compiler. More...

Defines
#define	TMR_GET()   TMR_get ()
	Macro to get the processor time.
#define	TMR_DELTA(_beg, _end)   TMR_delta (_beg, _end)
	Subtracts two times in ticks, returning the result in ticks.
#define	TMR_TO_NSECS(_ticks)   TMR_to_nsecs (_ticks)
	Convert a delta time in processor time units to nanoseconds.
#define	TMR_DELTA_IN_NSECS(_beg, _end)   TMR_delta_in_nsecs (_beg, _end)
	Subtracts two times in tickss, returning the result in nanoseconds.
#define	TMR_FORMAT   "%16lld"
	Provides a uniform way to format timer ticks.
Typedefs
typedef unsigned long long	TMR_tick
	The abstract type of a TMR tick.
Functions
unsigned int	TMR_ticks_to_nsecs (TMR_tick ticks)
	Convert a number of ticks to nanoseconds.
static TMR_tick	TMR_get ()
static TMR_tick	TMR_delta (TMR_tick beg, TMR_tick end)
	Computes the difference, in units of TMR_tick, between two times, in units of TMR_tick.1.
static unsigned int	TMR_to_nsecs (TMR_tick delta)
	Converts an elapsed time, obtained from TMR_delta, to nanoseconds.
static unsigned int	TMR_delta_in_nsecs (TMR_tick beg, TMR_tick end)
	Computes the difference, in units of TMR_tick, between two times, in units of TMR_tick.

---

Detailed Description

Provides the implementation of the timing macros on a X86 platform using the GCC compiler.

Author:

JJRussell - russell@slac.stanford.edu

   CVS $Id: TMR.xx-x86-gcc.h,v 1.1 2011/03/25 23:57:14 russell Exp $

ABSTRACT

x86 implementation of the TIMER facility. The implementation is based on-board CPU real time clock.

USAGE

See the documentation for the generic TMR facility.

---

Typedef Documentation

TMR_tick

The abstract type of a TMR tick.

This is the abstract type returned by TMR_GET(). Since it varies on a machine-by-machine basis, no direct manipulation of this data type should be attempted. Use only the TMR routines and macros with this type.

---

Function Documentation

static TMR_tick TMR_delta	(	TMR_tick	beg,
		TMR_tick	end
	)			[inline, static]

Computes the difference, in units of TMR_tick, between two times, in units of TMR_tick.1.

Returns:

The difference, in units of TMR_tick, between the two times.

static unsigned int TMR_delta_in_nsecs	(	TMR_tick	beg,
		TMR_tick	end
	)			[inline, static]

Computes the difference, in units of TMR_tick, between two times, in units of TMR_tick.

Returns:

The difference, in units of TMR_tick, between the two times.

References TMR_to_nsecs().

unsigned int TMR_ticks_to_nsecs

(

TMR_tick

ticks

)

Convert a number of ticks to nanoseconds.

Parameters:

ticks

The number of ticks to convert to nanoseconds

Returns:

The number of equivalent nanoseconds

static unsigned int TMR_to_nsecs

(

TMR_tick

delta

)

[inline, static]

Converts an elapsed time, obtained from TMR_delta, to nanoseconds.

Returns:

The converted time, in nanoseconds.

References TMR_ticks_to_nsecs().

Referenced by TMR_delta_in_nsecs().