GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > PBS / V2-10-12

Constituent: pbs     Tag: linux-gcc


Interface   Data Structures   File List   Data Fields   Globals  

PBS.h.px-xxx-xxx File Reference

PBS library, POSIX platform interface/macro implementation for PBS. More...

#include <pthread.h>

Include dependency graph for PBS.h.px-xxx-xxx:

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


Defines

#define PBS_TID()   (int)pthread_self ()
 Returns the id of the current task.
#define PBS_LOCK()
 Effectively at NOOP on this platform.

Typedefs

typedef enum _PBS_crashType PBS_crashType
 Typedef for enum.

Enumerations

enum  _PBS_crashType {
  PBS_CRASH_TYPE_VXWORKS = 0x1,
  PBS_CRASH_TYPE_COLD = 0x2,
  PBS_CRASH_TYPE_WATCHDOG = 0x3,
  PBS_CRASH_TYPE_PANIC = 0x4,
  PBS_CRASH_TYPE_EXCEPTION = 0x5,
  PBS_CRASH_TYPE_COMMAND = 0x6
}
 Enumerates all the reasons the system may be crashed. More...

Detailed Description

PBS library, POSIX platform interface/macro implementation for PBS.

Author:
JJRussell - russell@slac.stanford.edu
   CVS $Id: PBS.h.px-xxx-xxx,v 1.4 2005/09/13 13:02:06 russell Exp $

Define Documentation

 
#define PBS_LOCK  ) 
 

Effectively at NOOP on this platform.

This macro is meant to be used to stop activity prior to calling PBS_crash. PBS_lock is the first thing that PBS_crash does, so the user should call PBS_lock if and only if he feels that waiting till PBS_crash is called could cause problems.

Warning:
PBS_LOCK() is not meant to provide anything resembling locking interrupts on unsupported platforms. It is there simple as portability aid. No non-PPC code should depend on these routines to function correctly. The astute reader will notice that there is no PBS_UNLOCK. Since this functionality is only used when calling PBS_crash(), there is no need to for a PBS_UNLOCK().

 
#define PBS_TID  )     (int)pthread_self ()
 

Returns the id of the current task.

Returns:
ID of the current task
This macro is meant to be used to fill the TID field of PBS_crashCtx.


Typedef Documentation

PBS_crashType
 

Typedef for enum.

See also:
_PBS_crashType
The following codes are provide for compatibility reasons only

  • PBS_CRASH_TYPE_VXWORKS
  • PBS_CRASH_TYPE_COLD
  • PBS_CRASH_TYPE_WATCHDOG
  • PBS_CRASH_TYPE_EXCEPTION

The following codes are interesting in a POSIX environment

  • PBS_CRASH_TYPE_PANIC, generally from BUG_check
  • PBS_CRACH_TYPE_COMMAND, generally by command request


Enumeration Type Documentation

enum _PBS_crashType
 

Enumerates all the reasons the system may be crashed.

Enumerator:
PBS_CRASH_TYPE_VXWORKS  Boot VxWorks start type, issued internally by VXWORKS, provided for compatiability and testing reasons only
PBS_CRASH_TYPE_COLD  Boot cold start boot type, being start by a cold reset, provided for compatiability and testing reasons only
PBS_CRASH_TYPE_WATCHDOG  Boot watchdog start boot type, being started by a watchdog reset, provided for compatiability and testing reasons only
PBS_CRASH_TYPE_PANIC  Boot panic start boot type, typically a software inconsistancy, generally issued as a result of a call to BUG_check
PBS_CRASH_TYPE_EXCEPTION  Boot exception start boot type, being started as the result of an exception handler, provided for compatiability and testing reasons only
PBS_CRASH_TYPE_COMMAND  Boot commanded start boot type, being started as the result of an issued command


Generated on Fri Feb 2 06:08:09 2007 by  doxygen 1.4.4