epics/pcas
0
0
Fork 0
Code Issues Pull Requests Projects Wiki Activity

minor changes

Browse Source
This commit is contained in:
Marty Kraimer
1998-04-20 16:01:14 +00:00
parent 5f2780f773
commit b5927401bc
5 changed files with 14 additions and 162 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
src/libCom/errlog.h
View File

@@ -74,8 +74,8 @@ epicsShareFunc void epicsShareAPI errlogAddListener(
epicsShareFunc void epicsShareAPI errlogRemoveListener(
errlogListener listener);
epicsShareFunc void epicsShareAPI eltc(int yesno);
epicsShareFunc void epicsShareAPI errlogInit(int bufsize);
epicsShareFunc int epicsShareAPI eltc(int yesno);
epicsShareFunc int epicsShareAPI errlogInit(int bufsize);
/*other routines that write to log file*/
epicsShareFunc void epicsShareAPIV errPrintf(long status, const char *pFileName,

152
src/libCom/errlog.html
View File

@@ -1,152 +0,0 @@
<HTML>
<HEAD>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
<META NAME="GENERATOR" CONTENT="Mozilla/4.03 [en] (X11; U; SunOS 5.5.1 sun4u) [Netscape]">
</HEAD>
<BODY>
<H1>
Error Logging System</H1>
The error logging system provides:
<UL>
<LI>
Error message routines that can be called by&nbsp; ioc code.</LI>
<LI>
Provision for multiple system wide error loggers..</LI>
<LI>
A task (errlog) that handles the messages generated by the client routines.
It displays messages on the target console and also gives them to any registered
system wide error loggers.</LI>
<LI>
iocLog: A system wide error logger that writes all error message to a file.</LI>
</UL>
<H2>
Overview</H2>
<UL>
<LI>
The error message routines can be called by any non-interrupt level code.</LI>
<LI>
Task errlog manages the messages. Messages are placed in a message queue,
which is read by the errlog task. The message queue uses a fixed block
of memory to hold all messages. When the message queue is full additional
messages are rejected but a count of missed messages is kept. The next
time the message queue empties an extra message about the missed messages
is generated.</LI>
<LI>
The maximum message size&nbsp; is 256&nbsp; characters. If a message is
longer, the message is truncated and a message explaining that it was truncated
is appended. There is a chance that long messages corrupt memory. This&nbsp;
only happens if client code is defective. Long messages most likely result
from "%s" formats with a bad string argument.</LI>
<LI>
The error message routines are partially implemented on the host. The host
version just calls fprintf or vfprintf instead of using a separate task
and a message queue. Thus host messages are NOT sent to a system wide error
logger.</LI>
</UL>
<H2>
Client Routines</H2>
<I>Basic Routines</I>
<UL>
<PRE>typedef enum {
&nbsp;&nbsp;&nbsp; errlogInfo,errlogMinor,errlogMajor,errlogFatal
}errlogSevEnum;
int errlogPrintf(const char *pformat, ...);
int errlogVprintf(const char *pformat,va_list pvar);
int errlogSevPrintf(const errlogSevEnum severity,
&nbsp;&nbsp;&nbsp; const char *pformat, ...);
int errlogSevVprintf(const errlogSevEnum severity,
&nbsp;&nbsp;&nbsp; const char *pformat,va_list pvar);
int errlogMessage( const char *message);
char * errlogGetSevEnumString(const errlogSevEnum severity);
void errlogSetSevToLog(const errlogSevEnum severity );
errlogSevEnum errlogGetSevToLog(void);</PRE>
These are the basic client routines.
<P>errlogPrintf and errlogVprintf act just like printf and vprintf.
<P>errlogSevPrintf and errlogSevVprintf are similar except that they also
add the severity to the beginning of the message in the form "sevr=&lt;value>"
where value is on of "info, minor, major, fatal". Also the message is suppressed
if&nbsp; severity is less than the current severity to suppress.
<P>errlogMessage just logs message.
<P>errlogGetSevEnumString gets the string value of severity.
<P>errlogSetSevToLog sets the severity to log. errlogGetSevToLog gets the
current severity to log.</UL>
<I>Status Routines</I>
<BR>&nbsp;
<UL>
<PRE>void errMessage(long status, char *message);</PRE>
<PRE>void errPrintf(long status, const char *pFileName,
&nbsp;&nbsp;&nbsp; int lineno, const char *pformat, ...);</PRE>
errMessage is just a macro that calls errPrintf. errPrintf is meant to
be called as follows:
<PRE>&nbsp;errPrintf(status,__FILE__, __LINE__,"&lt;format>",...)</PRE>
&nbsp;The argument status is described in the Application Developer's guide.
The arguments __FILE__ and&nbsp; __LINE__ are standard C preprocessor variables.
<BR>&nbsp;</UL>
<I>Obsolete Routines</I>
<UL>
<PRE>int epicsPrintf(const char *pformat, ...);
int epicsVprintf(const char *pformat,va_list pvar);</PRE>
These are exactly like errlogPrintf and errlogVprintf. They are provided
because a lot of existing code calls them,.&nbsp;</UL>
<I>Add and Remove Log Listener</I>
<UL>
<PRE>typedef void(*errlogListener) (const char *message);
void errlogAddListener(errlogListener listener);
void errlogRemoveListener(errlogListener listener);</PRE>
These routines add/remove a callback that receives each error message.
<BR>&nbsp;</UL>
<I>target console routines</I>
<UL>
<PRE>void eltc(int yesno); /* error log to console (0 or 1) */
void errlogInit(int bufsize);</PRE>
</UL>
eltc determines if errlog task writes message to the console. If error
messages storms are occuring the command can be used to suppress the messages.
A argument of 0 suppresses the messages and any other value lets the message
go to the console.
<P>errlogInit can be used to initialize the error logging system with a
larger buffer. The default is 1280 bytes. An extra MAX_MESSAGE_SIZE (currently
256) bytes are allocated but never used. This is a small extra protection
against long error messages.
<H1>
iocLog</H1>
This consists of two modules: iocLogServer and iocLogClient. The client
code runs on each ioc and listens for the messages generated by the errlog
system. It also reports the messages from&nbsp; vxWorks logMsg.
<H3>
iocLogServer</H3>
This runs on a host. It receives messages for all enabled iocLogClients
in the local area network. The messages are written to a file. Epics base
provides a startup file "base/src/util/rc2.logServer", which is a shell
script to start the server. Consult this script for details.
<H3>
iocLogClient</H3>
This runs on each ioc. It is started by default when iocInit runs. The
global variable iocLogDisable can be used to enable/disable the messages
from being sent to the server. Setting this variable to (0,1) (enables,disables)
the messages generation. If iocLogDisable<TT> </TT>is set to 1 immediately
after iocCore is loaded then iocLogClient will not even initialize itself.
</BODY>
</HTML>

8
src/libCom/errlogVX.c
View File

@@ -232,10 +232,11 @@ epicsShareFunc void epicsShareAPI errlogRemoveListener(
if(!plistenerNode) printf("errlogRemoveListener did not find listener\n");
}
epicsShareFunc void epicsShareAPI eltc(int yesno)
epicsShareFunc int epicsShareAPI eltc(int yesno)
{
errlogInit(0);
pvtData.toConsole = yesno;
return(0);
}
epicsShareFunc void epicsShareAPIV errPrintf(long status, const char *pFileName,
@@ -288,12 +289,12 @@ epicsShareFunc void epicsShareAPIV errPrintf(long status, const char *pFileName,
}
#define optionsSemM SEM_Q_PRIORITY|SEM_DELETE_SAFE|SEM_INVERSION_SAFE
epicsShareFunc void epicsShareAPI errlogInit(int bufsize)
epicsShareFunc int epicsShareAPI errlogInit(int bufsize)
{
static int errlogInitFlag=0;
void *pbuffer;;
if(!vxTas(&errlogInitFlag)) return;
if(!vxTas(&errlogInitFlag)) return(0);
if(bufsize<BUFFER_SIZE) bufsize = BUFFER_SIZE;
pvtData.buffersize = bufsize;
ellInit(&pvtData.listenerList);
@@ -319,6 +320,7 @@ epicsShareFunc void epicsShareAPI errlogInit(int bufsize)
0,0,0,0,0,0,0,0,0,0);
/*For now make sure iocLogInit is called*/
iocLogInit();
return(0);
}
LOCAL void errlogTask(void)

8
src/libCom/error/errlog.c
View File

@@ -232,10 +232,11 @@ epicsShareFunc void epicsShareAPI errlogRemoveListener(
if(!plistenerNode) printf("errlogRemoveListener did not find listener\n");
}
epicsShareFunc void epicsShareAPI eltc(int yesno)
epicsShareFunc int epicsShareAPI eltc(int yesno)
{
errlogInit(0);
pvtData.toConsole = yesno;
return(0);
}
epicsShareFunc void epicsShareAPIV errPrintf(long status, const char *pFileName,
@@ -288,12 +289,12 @@ epicsShareFunc void epicsShareAPIV errPrintf(long status, const char *pFileName,
}
#define optionsSemM SEM_Q_PRIORITY|SEM_DELETE_SAFE|SEM_INVERSION_SAFE
epicsShareFunc void epicsShareAPI errlogInit(int bufsize)
epicsShareFunc int epicsShareAPI errlogInit(int bufsize)
{
static int errlogInitFlag=0;
void *pbuffer;;
if(!vxTas(&errlogInitFlag)) return;
if(!vxTas(&errlogInitFlag)) return(0);
if(bufsize<BUFFER_SIZE) bufsize = BUFFER_SIZE;
pvtData.buffersize = bufsize;
ellInit(&pvtData.listenerList);
@@ -319,6 +320,7 @@ epicsShareFunc void epicsShareAPI errlogInit(int bufsize)
0,0,0,0,0,0,0,0,0,0);
/*For now make sure iocLogInit is called*/
iocLogInit();
return(0);
}
LOCAL void errlogTask(void)

4
src/libCom/error/errlog.h
View File

@@ -74,8 +74,8 @@ epicsShareFunc void epicsShareAPI errlogAddListener(
epicsShareFunc void epicsShareAPI errlogRemoveListener(
errlogListener listener);
epicsShareFunc void epicsShareAPI eltc(int yesno);
epicsShareFunc void epicsShareAPI errlogInit(int bufsize);
epicsShareFunc int epicsShareAPI eltc(int yesno);
epicsShareFunc int epicsShareAPI errlogInit(int bufsize);
/*other routines that write to log file*/
epicsShareFunc void epicsShareAPIV errPrintf(long status, const char *pFileName,