---

GLAST/LAT > DAQ and FSW > FSW > Doxygen Index > CMX / V2-8-3

Constituent: cmx_asBuilt     Tag: mv2304

---

         

---

CMX_asBuiltPub.h File Reference

Public include file for the CMX-as-built identity scheme. Provides function prototypes for the callable interface routines and a structure typedef that callers of these routines will need to make forward references. More...

#include <time.h>

Include dependency graph for CMX_asBuiltPub.h:

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

Defines
#define	CAB_O_EPOCH   (0x3a4fc880)
#define	CAB_L_INDEX   (4)
Typedefs
typedef enum _CMX_asBuiltIndex	CMX_asBuiltIndex
	Typedef for enum _CMX_asBuiltIndex.
typedef _CMX_asBuiltIdentity	CMX_asBuiltIdentity
	Typedef for struct _CMX_asBuiltIdentity.
typedef _CMX_asBuiltLoad	CMX_asBuiltLoad
	Typedef for struct _CMX_asBuiltLoad.
Enumerations
enum	_CMX_asBuiltIndex {   CAB_K_MODULE = 0,   CAB_K_FILE = 1,   CAB_K_KEY = 2,   CAB_K_SPARE_1 = 3 }
	Indices into the user data storage area of a CMX identity record. More...
Functions
CMX_asBuiltIdentity *	CMX_asBuiltFind (const char *pkg, const char *con)
	Find a CMX-as-built identity block by package/constituent name.
const char *	CMX_asBuiltGetConstit (CMX_asBuiltIdentity *ident)
	Return (a pointer to) the constituent name recorded by CMX-as-built.
unsigned int	CMX_asBuiltGetData (CMX_asBuiltIdentity *ident, CMX_asBuiltIndex index, void **value)
	Get data in one of the slots in the user data area.
const char *	CMX_asBuiltGetDescrip (CMX_asBuiltIdentity *ident)
	Return (a pointer to) the user supplied descriptive string recorded by CMX-as-built.
const char *	CMX_asBuiltGetPackage (CMX_asBuiltIdentity *ident)
	Return (a pointer to) the package name recorded by CMX-as-built.
int	CMX_asBuiltGetRevision (CMX_asBuiltIdentity *ident)
	Return the CMX-as-built information revision level.
const char *	CMX_asBuiltGetSite (CMX_asBuiltIdentity *ident)
	Return (a pointer to) the build site name recorded by CMX-as-built.
const char *	CMX_asBuiltGetTarget (CMX_asBuiltIdentity *ident)
	Return (a pointer to) the build target name recorded by CMX-as-built.
time_t	CMX_asBuiltGetTime (CMX_asBuiltIdentity *ident)
	Return the build time-stamp recorded by CMX-as-built.
const char *	CMX_asBuiltGetUser (CMX_asBuiltIdentity *ident)
	Return (a pointer to) the builder's userid recorded by CMX-as-built.
unsigned int	CMX_asBuiltGetVersion (CMX_asBuiltIdentity *ident, char *version, short *major, short *minor, short *patch)
	Return version information as recorded by CMX-as-built.
unsigned int	CMX_asBuiltInsert (CMX_asBuiltIdentity *ident)
	Insert a CMX-as-built identity block into the list.
unsigned int	CMX_asBuiltRemove (CMX_asBuiltIdentity *ident)
	Remove a CMX-as-built identity block from the list.
CMX_asBuiltIdentity *	CMX_asBuiltScan (CMX_asBuiltIdentity *ident)
	Scan the CMX-as-built identity block list.
CMX_asBuiltIdentity *	CMX_asBuiltScanBackward (CMX_asBuiltLoad **load)
	Scan the CMX-as-built load-order block list (backward chronology).
CMX_asBuiltIdentity *	CMX_asBuiltScanForward (CMX_asBuiltLoad **load)
	Scan the CMX-as-built load-order block list (forward chronology).
unsigned int	CMX_asBuiltSetData (CMX_asBuiltIdentity *ident, CMX_asBuiltIndex index, void *value)
	Set one of the slots in the user data area.
unsigned int	CMX_asBuiltValid (CMX_asBuiltIdentity *ident)
	Validate an identity block pointer.

---

Detailed Description

Public include file for the CMX-as-built identity scheme. Provides function prototypes for the callable interface routines and a structure typedef that callers of these routines will need to make forward references.

CVS $Id: CMX_asBuiltPub.h,v 1.5 2005/11/04 04:04:01 apw Exp $

---

Enumeration Type Documentation

enum _CMX_asBuiltIndex

Indices into the user data storage area of a CMX identity record. CMX_asBuilt allows a user to store 4 32-byte quantities into the CMX_as_built information structures. This enumeration is used to define their uses. Enumerator: CAB_K_MODULE  VxWorks module ID CAB_K_FILE  Filename (in compressed format) CAB_K_KEY  File key CAB_K_SPARE_1  Spare 1

---

Function Documentation

CMX_asBuiltIdentity * CMX_asBuiltFind (  const char *  pkg, const char *  con )

Find a CMX-as-built identity block by package/constituent name. Parameters: pkg  (in) Package name con  (in) Constituent name Use the package and constituent names to locate a CMX-as-built identity block. Return values: NULL  Identity block not found or invalid pkg con name pointers. x  Pointer to identity block

const char * CMX_asBuiltGetConstit (  CMX_asBuiltIdentity *  ident  )

Return (a pointer to) the constituent name recorded by CMX-as-built. Parameters: ident  (in) Pointer to identity block Returns a pointer to the contituent name associated with the identity block pointed to by ident. Return values: NULL  Identity block pointer invalid x  Pointer to the constituent name

unsigned int CMX_asBuiltGetData (  CMX_asBuiltIdentity *  ident, CMX_asBuiltIndex  index, void **  value )

Get data in one of the slots in the user data area. Parameters: ident  (in) Pointer to identity block (if NULL, most recent) index  (in) Index of location to fetch from value  (in) Value stored in the index Stores a 4 byte user word in the data slot indicated. Typically used to tie CMX-as-built information to other information generated at load time (the VxWorks module ID and the compressed file name from TFFS). Return values: 0  Success 1  Identity block pointer invalid or unknown auxiliary block revision

const char * CMX_asBuiltGetDescrip (  CMX_asBuiltIdentity *  ident  )

Return (a pointer to) the user supplied descriptive string recorded by CMX-as-built. Parameters: ident  (in) Pointer to identity block Returns a pointer to the user supplied descriptive string associated with the identity block pointed to by ident. Return values: NULL  Identity block pointer invalid x  Pointer to the descriptive string

const char * CMX_asBuiltGetPackage (  CMX_asBuiltIdentity *  ident  )

Return (a pointer to) the package name recorded by CMX-as-built. Parameters: ident  (in) Pointer to identity block Returns a pointer to the package name associated with the identity block pointed to by ident. Return values: NULL  Identity block pointer invalid x  Pointer to the package name

int CMX_asBuiltGetRevision (  CMX_asBuiltIdentity *  ident  )

Return the CMX-as-built information revision level. Parameters: ident  (in) Pointer to identity block Returns the revision level Return values: -1  Identity block pointer invalid or unknown auxiliary block revision x  Revision level

const char * CMX_asBuiltGetSite (  CMX_asBuiltIdentity *  ident  )

Return (a pointer to) the build site name recorded by CMX-as-built. Parameters: ident  (in) Pointer to identity block Returns a pointer to the build site name associated with the identity block pointed to by ident. Return values: NULL  Identity block pointer invalid x  Pointer to the build site name

const char * CMX_asBuiltGetTarget (  CMX_asBuiltIdentity *  ident  )

Return (a pointer to) the build target name recorded by CMX-as-built. Parameters: ident  (in) Pointer to identity block Returns a pointer to the build target name associated with the identity block pointed to by ident. Return values: NULL  Identity block pointer invalid x  Pointer to the build target name

time_t CMX_asBuiltGetTime (  CMX_asBuiltIdentity *  ident  )

Return the build time-stamp recorded by CMX-as-built. Parameters: ident  (in) Pointer to identity block Returns the build time-stamp for the identity block pointed to by ident. Time is an unsigned integer number in seconds since the epoch defined as "2001-01-01 00:00:01 minus one second"). The value zero is reserved to indicate an error. Return values: 0  Identity block pointer invalid x  Build time-stamp

const char * CMX_asBuiltGetUser (  CMX_asBuiltIdentity *  ident  )

Return (a pointer to) the builder's userid recorded by CMX-as-built. Parameters: ident  (in) Pointer to identity block Returns a pointer to the userid of the builder associated with the identity block pointed to by ident. Return values: NULL  Identity block pointer invalid x  Pointer to the builder's userid

unsigned int CMX_asBuiltGetVersion (  CMX_asBuiltIdentity *  ident, char *  version, short *  major, short *  minor, short *  patch )

Return version information as recorded by CMX-as-built. Parameters: ident  (in) Pointer to identity block version  (out) Version ('T', 'D', 'P' and 'U') major  (out) Major revision number (only valid when version = 'P') minor  (out) Minor revision number (only valid when version = 'P') patch  (out) Patch revision number (only valid when version = 'P') Returns the CMX-as-built version information for the identity block pointed to by ident. Return values: 0  Success x  Identity block pointer invalid or unknown auxiliary block revision

unsigned int CMX_asBuiltInsert (  CMX_asBuiltIdentity *  ident  )

Insert a CMX-as-built identity block into the list. Parameters: ident  (in) Pointer to identity block Inserts a CMX-as-built identity block into the list of identity blocks. Not a common entry point for users to call, but essential to the static constructor code which does the deed. Return values: 0  Success x  Identity block pointer invalid

unsigned int CMX_asBuiltRemove (  CMX_asBuiltIdentity *  ident  )

Remove a CMX-as-built identity block from the list. Parameters: ident  (in) Pointer to identity block Removes a CMX-as-built identity block from the list of identity blocks. Not a common entry point for users to call, but essential to the static destructor code which does the deed. Return values: 0  Success x  Identity block pointer invalid or not found on list

CMX_asBuiltIdentity * CMX_asBuiltScan (  CMX_asBuiltIdentity *  ident  )

Scan the CMX-as-built identity block list. Parameters: ident  (in/out) Pointer to identity block A call to this routine with a NULL pointer will return the first identity block in the list. Successive calls with the returned pointer will return the next identity block on the list. The returned pointer is NULL when the list is exhausted. Return values: NULL  End of list or identity block pointer invalid x  Pointer to next CMX-as-built identity block

CMX_asBuiltIdentity * CMX_asBuiltScanBackward (  CMX_asBuiltLoad **  load  )

Scan the CMX-as-built load-order block list (backward chronology). Parameters: load  (in/out) Pointer to load-order block Scan through the list of loaded modules in load-order from most recent to earliest. The first call to this routine should use a NULL pointer for the load parameter. Subsequent calls (without touching the value of load) will walk the list. When the list is exhausted, both the returned identity block value and the load pointer will be NULL. Return values: NULL  End of list or load-order block pointer invalid x  Pointer to next CMX-as-built identity block

CMX_asBuiltIdentity * CMX_asBuiltScanForward (  CMX_asBuiltLoad **  load  )

Scan the CMX-as-built load-order block list (forward chronology). Parameters: load  (in/out) Pointer to load-order block Scan through the list of loaded modules in load-order from earliest to most recent. The first call to this routine should use a NULL pointer for the load parameter. Subsequent calls (without touching the value of load) will walk the list. When the list is exhausted, both the returned identity block value and the load pointer will be NULL. Return values: NULL  End of list or load-order block pointer invalid x  Pointer to next CMX-as-built identity block

unsigned int CMX_asBuiltSetData (  CMX_asBuiltIdentity *  ident, CMX_asBuiltIndex  index, void *  value )

Set one of the slots in the user data area. Parameters: ident  (in) Pointer to identity block (if NULL, most recent) index  (in) Index of location to store into value  (in) Value to store in index Stores a 4 byte user word in the data slot indicated. Typically used to tie CMX-as-built information to other information generated at load time (the VxWorks module ID and the compressed file name from TFFS). Return values: 0  Success x  Identity block pointer invalid or unknown auxiliary block revision

unsigned int CMX_asBuiltValid (  CMX_asBuiltIdentity *  ident  )

Validate an identity block pointer. Parameters: ident  (in) Pointer to identity block Guard against NULL or nonsense identity block pointers. Return values: 0  Pointer is invalid 1  Pointer is valid

---