CAB_lookup.c File Reference

Collection of functions to support the CMX symbol lookup feature. More...

#include <stdio.h>
#include <string.h>
#include <CAB/CAB_asBuiltPub.h>
#include <CAB/CAB_lookupPub.h>
#include <CAB_lookupPrv.h>

Functions
const void *	CMX_lookupSymbol (const char *fnd)
	Translate a CMX lookup symbol to an address.
void	CMX_lookupInsert (CMX_LookupTable *tbl)
	Insert a CMX lookup table into the CMX lookup table list.
void	CMX_lookupRemove (CMX_LookupTable *tbl)
	Remove a CMX lookup table from the CMX lookup table list.
unsigned int	CMX_lookupScan (CMX_cb_LookupScan *rtn, void *prm)
	Scan the CMX symbol list.
Variables
static CMX_LookupTable	CMX_lookupRoot
	Head of the lookup table control block list.

---

Detailed Description

Collection of functions to support the CMX symbol lookup feature.

CAB_lookup.c provides the functions needed to manage and interrogate the CMX symbol lookup tables.

CVS $Id: CAB_lookup.c,v 1.2 2010/04/22 22:14:36 apw Exp $

---

Function Documentation

void CMX_lookupInsert

(

CMX_LookupTable *

tbl

)

Insert a CMX lookup table into the CMX lookup table list.

Parameters:

tbl

(in) Pointer to lookup table

CMX_lookupInsert() inserts a CMX lookup table into the doubly linked list of tables.

References _CMX_LookupTable::chk, _CMX_LookupTable::nxt, and _CMX_LookupTable::prv.

void CMX_lookupRemove

(

CMX_LookupTable *

tbl

)

Remove a CMX lookup table from the CMX lookup table list.

Parameters:

tbl

(in) Pointer to lookup table

CMX_lookupRemove() removes a CMX lookup table from the doubly linked list of tables.

References _CMX_LookupTable::chk, _CMX_LookupTable::nxt, and _CMX_LookupTable::prv.

unsigned int CMX_lookupScan	(	CMX_cb_LookupScan *	rtn,
		void *	prm
	)

Scan the CMX symbol list.

Parameters:

	rtn	(in) Routine called for each symbol
	prm	(in) User parameter passed through to callback

CMX_lookupScan() scans through all symbols managed by CMX lookup and calls the user provided callback routine for each symbol. If the callback returns a failure code (LSB of status code set), the scan is terminated.

Return values:

x

The most recent status code returned by the callback routine

References _CMX_LookupTable::cab, _CMX_LookupTable::nxt, and _CMX_LookupTable::sym.

const void * CMX_lookupSymbol

(

const char *

fnd

)

Translate a CMX lookup symbol to an address.

Parameters:

fnd

(in) Symbol name to find and translate

CMX_lookupSymbol() translates a CMX lookup managed symbol to an address.

Return values:

	NULL	No such symbol
	x	Symbol address

References _CMX_LookupSymbol::add, _CMX_LookupSymbol::nam, _CMX_LookupTable::nxt, and _CMX_LookupTable::sym.

---

Variable Documentation

static CMX_lookupTable CMX_lookupRoot [static]

Initial value:

{
    &CMX_lookupRoot, &CMX_lookupRoot, 0, 0, NULL, NULL, NULL, NULL
}

Head of the lookup table control block list.