LSW_pubdefs.h File Reference

Public definitions for the LSW trace facilities. More...

#include <ITC/ITC_pubdefs.h>
#include <TRC/TRC_pubdefs.h>

Functions
unsigned int	LSW_canMonitor (ITC_NodeID nid)
	Test whether monitor records are available for node nid.
unsigned int	LSW_differMonitor (ITC_NodeID nid, TRC_Monitor *old, TRC_Top *top)
	Calculate a differential monitoring structure.
unsigned int	LSW_initialize (unsigned int rate)
	Initialize the LSW tracing facility.
unsigned int	LSW_start (void)
	Start the mLSW task.

---

Detailed Description

Public definitions for the LSW trace facilities.

CVS $Id: LSW_pubdefs.h,v 1.5 2011/03/29 20:50:12 apw Exp $

Author:

A.P.Waite

---

Function Documentation

unsigned int LSW_canMonitor

(

ITC_NodeID

nid

)

Test whether monitor records are available for node nid.

Parameters:

nid

(in) Node ID

Return values:

	0	Records are not available
	1	Records are available

LSW_canMonitor() tests whether monitor records are available for node nid.

References _LSW_Monitor::cnt, _LSW_Control::latest, LSW_CTL_STARTED, LSW_lcb, and _LSW_Control::state.

unsigned int LSW_differMonitor	(	ITC_NodeID	nid,
		TRC_Monitor *	old,
		TRC_Top *	top
	)

Calculate a differential monitoring structure.

Parameters:

	nid	(in) Node ID
	old	(in) Previous sample
	top	(in) Output destination of difference

LSW_differMonitor() differences an old TRC_Monitor record with the latest version of that record (all for node nid) and places the result in the output top structure.

All the real work is done by a TRC routine that knows how to do this.

References LSW_copyMonitor(), LSW_CTL_STARTED, LSW_lcb, and _LSW_Control::state.

unsigned int LSW_initialize

(

unsigned int

rate

)

Initialize the LSW tracing facility.

Parameters:

rate

(in) Rate of forced task switches (milliseconds) (default: 1000)

LSW_initialize() builds up the resources to run the LSW application and task.

References initializeCyclic(), initializeMonitor(), initializeTask(), LSW_CTL_BROKEN, LSW_CTL_INITIALIZED, LSW_CTL_UNINITIALIZED, _LSW_Control::mtx, _LSW_Control::rwi, and _LSW_Control::state.

unsigned int LSW_start

(

void

)

Start the mLSW task.

LSW_start() starts the mLSW task

References _LSW_Control::itc, LSW_CTL_BROKEN, LSW_CTL_INITIALIZED, LSW_CTL_STARTING, _LSW_Control::mtx, _LSW_Control::priority, snapStart(), and _LSW_Control::state.