errlog.h File Reference

#include <stdarg.h>
#include <stddef.h>
#include <stdio.h>
#include "libComAPI.h"
#include "compilerDependencies.h"

Include dependency graph for errlog.h:

Go to the source code of this file.

Macros
#define	errMessage(S, PM)   errPrintf(S, __FILE__, __LINE__, "%s", PM)
#define	epicsPrintf   errlogPrintf
#define	epicsVprintf   errlogVprintf

Typedefs
typedef void(*	errlogListener) (void *pPrivate, const char *message)

Enumerations
enum	errlogSevEnum { errlogInfo, errlogMinor, errlogMajor, errlogFatal }

Functions
LIBCOM_API int	errlogPrintf (const char *pformat,...) EPICS_PRINTF_STYLE(1
LIBCOM_API int LIBCOM_API int	errlogVprintf (const char *pformat, va_list pvar)
LIBCOM_API int	errlogSevPrintf (const errlogSevEnum severity, const char *pformat,...) EPICS_PRINTF_STYLE(2
LIBCOM_API int LIBCOM_API int	errlogSevVprintf (const errlogSevEnum severity, const char *pformat, va_list pvar)
LIBCOM_API int	errlogMessage (const char *message)
LIBCOM_API const char *	errlogGetSevEnumString (errlogSevEnum severity)
LIBCOM_API void	errlogSetSevToLog (errlogSevEnum severity)
LIBCOM_API errlogSevEnum	errlogGetSevToLog (void)
LIBCOM_API void	errlogAddListener (errlogListener listener, void *pPrivate)
LIBCOM_API int	errlogRemoveListeners (errlogListener listener, void *pPrivate)
LIBCOM_API int	eltc (int yesno)
LIBCOM_API int	errlogSetConsole (FILE *stream)
LIBCOM_API int	errlogInit (int bufsize)
LIBCOM_API int	errlogInit2 (int bufsize, int maxMsgSize)
LIBCOM_API void	errlogFlush (void)
LIBCOM_API void	errPrintf (long status, const char *pFileName, int lineno, const char *pformat,...) EPICS_PRINTF_STYLE(4
LIBCOM_API void LIBCOM_API int	errlogPrintfNoConsole (const char *pformat,...) EPICS_PRINTF_STYLE(1
LIBCOM_API void LIBCOM_API int LIBCOM_API int	errlogVprintfNoConsole (const char *pformat, va_list pvar)
LIBCOM_API void	errSymLookup (long status, char *pBuf, size_t bufLength)

Variables
LIBCOM_API int	errVerbose
LIBCOM_API const char *	errlogSevEnumString []

Macro Definition Documentation

#define epicsPrintf   errlogPrintf

Definition at line 51 of file errlog.h.

#define epicsVprintf   errlogVprintf

Definition at line 52 of file errlog.h.

#define errMessage	(		S,
			PM
	)		errPrintf(S, __FILE__, __LINE__, "%s", PM)

Definition at line 48 of file errlog.h.

Typedef Documentation

typedef void(* errlogListener) (void *pPrivate, const char *message)

Definition at line 24 of file errlog.h.

Enumeration Type Documentation

enum errlogSevEnum

Enumerator
errlogInfo
errlogMinor
errlogMajor
errlogFatal

Definition at line 26 of file errlog.h.

             {
    errlogInfo,
    errlogMinor,
    errlogMajor,
    errlogFatal
} errlogSevEnum;

Function Documentation

LIBCOM_API int eltc

(

int

yesno

)

Definition at line 368 of file errlog.c.

{
    errlogInit(0);
    errlogFlush();
    pvtData.toConsole = yesno;
    return 0;
}

LIBCOM_API void errlogAddListener	(	errlogListener	listener,
		void *	pPrivate
	)

Definition at line 317 of file errlog.c.

{
    listenerNode *plistenerNode;

    errlogInit(0);
    if (pvtData.atExit)
        return;

    plistenerNode = callocMustSucceed(1,sizeof(listenerNode),
        "errlogAddListener");
    epicsMutexMustLock(pvtData.listenerLock);
    plistenerNode->listener = listener;
    plistenerNode->pPrivate = pPrivate;
    ellAdd(&pvtData.listenerList,&plistenerNode->node);
    epicsMutexUnlock(pvtData.listenerLock);
}

LIBCOM_API void errlogFlush

(

void

)

Definition at line 529 of file errlog.c.

{
    int count;

    errlogInit(0);
    if (pvtData.atExit)
        return;

   /*If nothing in queue dont wake up errlogThread*/
    epicsMutexMustLock(pvtData.msgQueueLock);
    count = ellCount(&pvtData.msgQueue);
    epicsMutexUnlock(pvtData.msgQueueLock);
    if (count <= 0)
        return;

    /*must let errlogThread empty queue*/
    epicsMutexMustLock(pvtData.flushLock);
    epicsEventSignal(pvtData.flush);
    epicsEventSignal(pvtData.waitForWork);
    epicsEventMustWait(pvtData.waitForFlush);
    epicsMutexUnlock(pvtData.flushLock);
}

LIBCOM_API const char* errlogGetSevEnumString

(

errlogSevEnum

severity

)

Definition at line 297 of file errlog.c.

{
    errlogInit(0);
    if (severity > 3)
        return "unknown";
    return errlogSevEnumString[severity];
}

LIBCOM_API errlogSevEnum errlogGetSevToLog

(

void

)

Definition at line 311 of file errlog.c.

{
    errlogInit(0);
    return pvtData.sevToLog;
}

LIBCOM_API int errlogInit

(

int

bufsize

)

Definition at line 524 of file errlog.c.

{
    return errlogInit2(bufsize, MAX_MESSAGE_SIZE);
}

LIBCOM_API int errlogInit2	(	int	bufsize,
		int	maxMsgSize
	)

Definition at line 500 of file errlog.c.

{
    static epicsThreadOnceId errlogOnceFlag = EPICS_THREAD_ONCE_INIT;
    struct initArgs config;

    if (pvtData.atExit)
        return 0;

    if (bufsize < BUFFER_SIZE)
        bufsize = BUFFER_SIZE;
    config.bufsize = bufsize;

    if (maxMsgSize < MAX_MESSAGE_SIZE)
        maxMsgSize = MAX_MESSAGE_SIZE;
    config.maxMsgSize = maxMsgSize;

    epicsThreadOnce(&errlogOnceFlag, errlogInitPvt, &config);
    if (pvtData.errlogInitFailed) {
        fprintf(stderr,"errlogInit failed\n");
        exit(1);
    }
    return 0;
}

LIBCOM_API int errlogMessage

(

const char *

message

)

Definition at line 180 of file errlog.c.

{
    errlogPrintf("%s", message);
    return 0;
}

LIBCOM_API int errlogPrintf	(	const char *	pformat,
			...
	)

LIBCOM_API void LIBCOM_API int errlogPrintfNoConsole	(	const char *	pformat,
			...
	)

LIBCOM_API int errlogRemoveListeners	(	errlogListener	listener,
		void *	pPrivate
	)

Definition at line 334 of file errlog.c.

{
    listenerNode *plistenerNode;
    int count = 0;

    errlogInit(0);
    if (!pvtData.atExit)
        epicsMutexMustLock(pvtData.listenerLock);

    plistenerNode = (listenerNode *)ellFirst(&pvtData.listenerList);
    while (plistenerNode) {
        listenerNode *pnext = (listenerNode *)ellNext(&plistenerNode->node);

        if (plistenerNode->listener == listener &&
            plistenerNode->pPrivate == pPrivate) {
            ellDelete(&pvtData.listenerList, &plistenerNode->node);
            free(plistenerNode);
            ++count;
        }
        plistenerNode = pnext;
    }

    if (!pvtData.atExit)
        epicsMutexUnlock(pvtData.listenerLock);

    if (count == 0) {
        FILE *console = pvtData.console ? pvtData.console : stderr;

        fprintf(console,
            "errlogRemoveListeners: No listeners found\n");
    }
    return count;
}

LIBCOM_API int errlogSetConsole

(

FILE *

stream

)

Definition at line 376 of file errlog.c.

{
    errlogInit(0);
    pvtData.console = stream;
    return 0;
}

LIBCOM_API void errlogSetSevToLog

(

errlogSevEnum

severity

)

Definition at line 305 of file errlog.c.

{
    errlogInit(0);
    pvtData.sevToLog = severity;
}

LIBCOM_API int errlogSevPrintf	(	const errlogSevEnum	severity,
		const char *	pformat,
			...
	)

LIBCOM_API int LIBCOM_API int errlogSevVprintf	(	const errlogSevEnum	severity,
		const char *	pformat,
		va_list	pvar
	)

Definition at line 262 of file errlog.c.

{
    char *pnext;
    int nchar;
    int totalChar = 0;
    int isOkToBlock;

    if (epicsInterruptIsInterruptContext()) {
        epicsInterruptContextMessage
            ("errlogSevVprintf called from interrupt level\n");
        return 0;
    }

    errlogInit(0);
    if (pvtData.atExit)
        return 0;

    isOkToBlock = epicsThreadIsOkToBlock();
    pnext = msgbufGetFree(isOkToBlock);
    if (!pnext)
        return 0;

    nchar = sprintf(pnext, "sevr=%s ", errlogGetSevEnumString(severity));
    pnext += nchar; totalChar += nchar;
    nchar = tvsnPrint(pnext, pvtData.maxMsgSize - totalChar - 1, pFormat, pvar);
    pnext += nchar; totalChar += nchar;
    if (pnext[-1] != '\n') {
        strcpy(pnext,"\n");
        totalChar++;
    }
    msgbufSetSize(totalChar);
    return nchar;
}

LIBCOM_API int LIBCOM_API int errlogVprintf	(	const char *	pformat,
		va_list	pvar
	)

Definition at line 144 of file errlog.c.

{
    int nchar;
    char *pbuffer;
    int isOkToBlock;
    FILE *console;

    if (epicsInterruptIsInterruptContext()) {
        epicsInterruptContextMessage
            ("errlogVprintf called from interrupt level\n");
        return 0;
    }

    errlogInit(0);
    if (pvtData.atExit)
        return 0;
    isOkToBlock = epicsThreadIsOkToBlock();

    pbuffer = msgbufGetFree(isOkToBlock);
    if (!pbuffer) {
        console = pvtData.console ? pvtData.console : stderr;
        vfprintf(console, pFormat, pvar);
        fflush(console);
        return 0;
    }

    nchar = tvsnPrint(pbuffer, pvtData.maxMsgSize, pFormat?pFormat:"", pvar);
    if (pvtData.atExit || (isOkToBlock && pvtData.toConsole)) {
        console = pvtData.console ? pvtData.console : stderr;
        fprintf(console, "%s", pbuffer);
        fflush(console);
    }
    msgbufSetSize(nchar);
    return nchar;
}

LIBCOM_API void LIBCOM_API int LIBCOM_API int errlogVprintfNoConsole	(	const char *	pformat,
		va_list	pvar
	)

Definition at line 204 of file errlog.c.

{
    int nchar;
    char *pbuffer;

    if (epicsInterruptIsInterruptContext()) {
        epicsInterruptContextMessage
            ("errlogVprintfNoConsole called from interrupt level\n");
        return 0;
    }

    errlogInit(0);
    if (pvtData.atExit)
        return 0;

    pbuffer = msgbufGetFree(1);
    if (!pbuffer)
        return 0;

    nchar = tvsnPrint(pbuffer, pvtData.maxMsgSize, pFormat?pFormat:"", pvar);
    msgbufSetSize(nchar);
    return nchar;
}

LIBCOM_API void errPrintf	(	long	status,
		const char *	pFileName,
		int	lineno,
		const char *	pformat,
			...
	)

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);
}

Variable Documentation

LIBCOM_API const char* errlogSevEnumString[]

LIBCOM_API int errVerbose

Definition at line 41 of file errlog.c.