---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > LSW / V2-0-0

Constituent: lsw     Tag: linux-gcc

---

         

---

LSW_pubdefs.h File Reference

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

#include "ITC/ITC_pubdefs.h"
#include "TRC/TRC_pubdefs.h"

Include dependency graph for LSW_pubdefs.h:

This graph shows which files directly or indirectly include this file:

Functions
unsigned int	LSW_copyMonitor (ITC_NodeID nid, TRC_Monitor *mon)
	Make a coherent (thread safe) copy of a monitor record.
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.2 2007/03/22 01:55:58 apw Exp $

Author:

A.P.Waite

---

Function Documentation

unsigned int LSW_copyMonitor (  ITC_NodeID  nid, TRC_Monitor *  mon )

Make a coherent (thread safe) copy of a monitor record. Parameters: nid  (in) Node ID mon  (out) Monitor record Return values: LSW_CANTCOPY  Cannot make a coherent copy LSW_NODENOT  Not a monitored node LSW_NORECORD  Monitor record not available LSW_NOTINIT  LSW system not initialized LSW_PARMNULL  Caller passed a null parameter LSW_SUCCESS  Success Warning: Quite apart from the usual snafus (node ID out of range, mon pointer is NULL), there are circumstances where this routine can fail. This is limited to the case of the calling task not seeing enough cycles to copy the complete monitor record before it gets updated again. This should be a very rare occurence, but calling routines should check the return code for this (as they should be doing anyway!). LSW_copyMonitor() makes a copy (in a thread safe manner) of the latest monitor record for node nid.

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.

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.

unsigned int LSW_start (  void   )

Start the mLSW task. LSW_start() starts the mLSW task

---