errSymTbl.h File Reference

#include <stddef.h>
#include "libComAPI.h"
#include "epicsTypes.h"

Include dependency graph for errSymTbl.h:

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

Go to the source code of this file.

Classes
struct	ERRSYMBOL
struct	ERRSYMTAB

Typedefs
typedef ERRSYMTAB *	ERRSYMTAB_ID

Functions
LIBCOM_API void	errSymLookup (long status, char *pBuf, size_t bufLength)
LIBCOM_API const char *	errSymMsg (long status)
LIBCOM_API void	errSymTest (epicsUInt16 modnum, epicsUInt16 begErrNum, epicsUInt16 endErrNum)
LIBCOM_API void	errSymTestPrint (long errNum)
LIBCOM_API int	errSymBld (void)
LIBCOM_API int	errSymbolAdd (long errNum, const char *name)
LIBCOM_API void	errSymDump (void)

Typedef Documentation

typedef ERRSYMTAB* ERRSYMTAB_ID

Definition at line 30 of file errSymTbl.h.

Function Documentation

LIBCOM_API int errSymBld

(

void

)

Definition at line 55 of file errSymLib.c.

{
    ERRSYMBOL      *errArray = errSymTbl->symbols;
    ERRNUMNODE     *perrNumNode = NULL;
    ERRNUMNODE     *pNextNode = NULL;
    ERRNUMNODE    **phashnode = NULL;
    int             i;
    int             modnum;

    if (initialized)
        return(0);

    hashtable = (ERRNUMNODE**)callocMustSucceed
        (NHASH, sizeof(ERRNUMNODE*),"errSymBld");
    for (i = 0; i < errSymTbl->nsymbols; i++, errArray++) {
        modnum = errArray->errNum >> 16;
        if (modnum < 501) {
            fprintf(stderr, "errSymBld: ERROR - Module number in errSymTbl < 501 was Module=%lx Name=%s\n",
                errArray->errNum, errArray->name);
            continue;
        }
        if ((errSymbolAdd(errArray->errNum, errArray->name)) < 0) {
            fprintf(stderr, "errSymBld: ERROR - errSymbolAdd() failed \n");
            continue;
        }
    }
    perrNumNode = (ERRNUMNODE *) ellFirst(&errnumlist);
    while (perrNumNode) {
        /* hash each perrNumNode->errNum */
        epicsUInt16 hashInd = errhash(perrNumNode->errNum);

        phashnode = (ERRNUMNODE**)&hashtable[hashInd];
        pNextNode = (ERRNUMNODE*) *phashnode;
        /* search for last node (NULL) of hashnode linked list */
        while (pNextNode) {
            phashnode = &pNextNode->hashnode;
            pNextNode = *phashnode;
        }
        *phashnode = perrNumNode;
        perrNumNode = (ERRNUMNODE *) ellNext((ELLNODE *) perrNumNode);
    }
    initialized = 1;
    return(0);
}

LIBCOM_API int errSymbolAdd	(	long	errNum,
		const char *	name
	)

Definition at line 118 of file errSymLib.c.

{
    ERRNUMNODE *pNew = (ERRNUMNODE*) callocMustSucceed(1,
        sizeof(ERRNUMNODE), "errSymbolAdd");

    pNew->errNum = errNum;
    pNew->message = name;
    ellAdd(&errnumlist, (ELLNODE*)pNew);
    return 0;
}

LIBCOM_API void errSymDump

(

void

)

Definition at line 204 of file errSymLib.c.

{
    int i;
    int msgcount = 0;

    if (!initialized) errSymBld();

    msgcount = 0;
    printf("errSymDump: number of hash slots = %d\n", NHASH);
    for (i = 0; i < NHASH; i++) {
        ERRNUMNODE **phashnode = &hashtable[i];
        ERRNUMNODE *pNextNode = *phashnode;
        int count = 0;

        while (pNextNode) {
            int modnum = pNextNode->errNum >> 16;
            int errnum = pNextNode->errNum & 0xffff;

            if (!count++) {
                printf("HASHNODE = %d\n", i);
            }
            printf("\tmod %d num %d \"%s\"\n",
                modnum , errnum , pNextNode->message);
            phashnode = &pNextNode->hashnode;
            pNextNode = *phashnode;
        }
        msgcount += count;
    }
    printf("\nerrSymDump: total number of error messages = %d\n", msgcount);
}

LIBCOM_API void errSymLookup	(	long	status,
		char *	pBuf,
		size_t	bufLength
	)

Definition at line 190 of file errSymLib.c.

{
    const char* msg = errSymLookupInternal(status);
    if(msg) {
        strncpy(pBuf, msg, bufLength-1);
        pBuf[bufLength-1] = '\0';
        return;
    }
    errRawCopy(status, pBuf, bufLength);
}

LIBCOM_API const char* errSymMsg

(

long

status

)

Definition at line 181 of file errSymLib.c.

{
    const char* msg = errSymLookupInternal(status);
    return msg ? msg : "<Unknown code>";
}

LIBCOM_API void errSymTest	(	epicsUInt16	modnum,
		epicsUInt16	begErrNum,
		epicsUInt16	endErrNum
	)

Definition at line 265 of file errSymLib.c.

{
    long         errNum;
    epicsUInt16  errnum;

    if (!initialized) errSymBld();
    if (modnum < 501)
        return;

    /* print range of error messages */
    for (errnum = begErrNum; errnum <= endErrNum; errnum++) {
        errNum = modnum << 16;
        errNum |= (errnum & 0xffff);
        errSymTestPrint(errNum);
    }
}

LIBCOM_API void errSymTestPrint

(

long

errNum

)

Definition at line 239 of file errSymLib.c.

{
    char        message[256];
    epicsUInt16 modnum;
    epicsUInt16 errnum;

    if (!initialized) errSymBld();

    message[0] = '\0';
    modnum = (epicsUInt16) (errNum >> 16);
    errnum = (epicsUInt16) (errNum & 0xffff);
    if (modnum < 501) {
        fprintf(stderr, "Usage:  errSymTestPrint(long errNum) \n");
        fprintf(stderr, "errSymTestPrint: module number < 501 \n");
        return;
    }
    errSymLookup(errNum, message, sizeof(message));
    if ( message[0] == '\0' ) return;
    printf("module %hu number %hu message=\"%s\"\n",
        modnum, errnum, message);
    return;
}