XrdSysLogger Class Reference

#include <XrdSysLogger.hh>

Collaboration diagram for XrdSysLogger:

Classes
class	Task

Public Member Functions
	XrdSysLogger (int ErrFD=STDERR_FILENO, int xrotate=1)
	~XrdSysLogger ()
	Destructor.
void	AddMsg (const char *msg)
void	AtMidnight (Task *mnTask)
int	Bind (const char *path, int lfh=0)
void	Capture (XrdOucTListFIFO *tFIFO)
void	Flush ()
	Flush any pending output.
int	originalFD ()
int	ParseKeep (const char *arg)
void	Put (int iovcnt, struct iovec *iov)
void	setHiRes ()
	Set log file timstamp to high resolution (hh:mm:ss.uuuu).
void	setKeep (long long knum)
void	setRotate (int onoff)
char *	traceBeg ()
char	traceEnd ()
const char *	xlogFN ()
void	zHandler ()

Static Public Member Functions
static void	setForwarding (bool onoff)
	Set call-out to logging plug-in on or off.

Static Public Attributes
static const int	onFifo = (int)0x80000000

Detailed Description

Definition at line 52 of file XrdSysLogger.hh.

Constructor & Destructor Documentation

XrdSysLogger()

XrdSysLogger::XrdSysLogger	(	int	ErrFD = STDERR_FILENO,
		int	xrotate = 1 )

Constructor

Parameters

ErrFD	is the filedescriptor of where error messages normally go if this class is not used. Default is stderr.
xrotate	when not zero performs internal log rotatation. Otherwise, log rotation is suppressed. See also setRotate().

Definition at line 141 of file XrdSysLogger.cc.

{
   char * logFN;
 
   ePath = 0;
   eInt  = 0;
   eFD   = ErrFD;
   eKeep = 0;
   doLFR = (dorotate != 0);
   msgList = 0;
   taskQ   = 0;
   lfhTID  = 0;
   hiRes   = false;
   fifoFN  = 0;
   reserved1 = 0;
 
// Establish default log file name
//
   if (!(logFN = getenv("XrdSysLOGFILE"))) logFN = getenv("XrdOucLOGFILE");
 
// Establish message routing
//
   if (ErrFD != STDERR_FILENO) baseFD = ErrFD;
      else {baseFD = ErrFD;
            if (logFN)
               {baseFD = XrdSysFD_Dup(ErrFD);
                Bind(logFN, 1);
               }
           }
}

References Bind().

Here is the call graph for this function:

~XrdSysLogger()

XrdSysLogger::~XrdSysLogger ( )

inline

Destructor.

Definition at line 71 of file XrdSysLogger.hh.

        {
          RmLogRotateLock();
          if (ePath)
            free(ePath);
        }

Member Function Documentation

AddMsg()

void XrdSysLogger::AddMsg

(

const char *

msg

)

Add a message to be printed at midnight.

Parameters

msg	The message to be printed. A copy of the message is saved.

Definition at line 176 of file XrdSysLogger.cc.

{
   mmMsg *tP, *nP = new mmMsg;
 
// Fill out new message
//
   nP->next = 0;
   nP->msg  = strdup(msg);
   nP->mlen = strlen(msg);
 
// Add new line character if one is missing (we steal the null byte for this)
//
   if (nP->mlen > 1 && nP->msg[nP->mlen-1] != '\n')
      {nP->msg[nP->mlen] = '\n'; nP->mlen += 1;}
 
// Add this message to the end of the list
//
   Logger_Mutex.Lock();
   if (!(tP = msgList)) msgList = nP;
      else {while(tP->next) tP = tP->next;
            tP->next = nP;
           }
   Logger_Mutex.UnLock();
}

AtMidnight()

void XrdSysLogger::AtMidnight

(

XrdSysLogger::Task *

mnTask

)

Definition at line 205 of file XrdSysLogger.cc.

{
 
// Place this task on the task queue
//
   Logger_Mutex.Lock();
   mnTask->next = taskQ;
   taskQ = mnTask;
   Logger_Mutex.UnLock();
}

Bind()

int XrdSysLogger::Bind	(	const char *	path,
		int	lfh = 0 )

Definition at line 220 of file XrdSysLogger.cc.

{
   XrdSysLoggerRP rtParms(this);
   int rc;
 
// Kill logfile handler thread if parameters will be changing
//
   if (lfh > 0) lfh = 1;
   if (lfhTID && (eInt != lfh || !path))
      {XrdSysThread::Kill(lfhTID);
       lfhTID = 0;
      }
 
// Bind to stderr if no path specified
//
   if (ePath) free(ePath);
   eInt   = 0;
   ePath  = 0;
   if (fifoFN) free(fifoFN);
   fifoFN = 0; doLFR = false;
   if (!path) return 0;
 
// Bind to a log file
//
   eInt  = lfh;
   ePath = strdup(path);
   doLFR = (lfh > 0);
   if ((rc = ReBind(0))) return rc;
 
// Lock the logs if XRootD is suppose to handle log rotation itself
//
  rc = HandleLogRotateLock( doLFR );
  if( rc )
    return -rc;
 
// Handle specifics of lofile rotation
//
   if (eInt == onFifo) {if ((rc = FifoMake())) return -rc;}
      else if (eInt < 0 && !XrdSysUtils::SigBlock(-eInt))
              {rc = errno;
               BLAB("Unable to block logfile signal " <<-eInt <<"; "
                    <<XrdSysE2T(rc));
               eInt = 0;
               return -rc;
              }
 
// Start a log rotation thread
//
   rc = XrdSysThread::Run(&lfhTID, XrdSysLoggerRT, (void *)&rtParms, 0,
                          "Logfile handler");
   if (!rc) rtParms.active.Wait();
   return (rc > 0 ? -rc : rc);
}

References XrdSysLoggerRP::active, BLAB, XrdSysThread::Kill(), onFifo, XrdSysThread::Run(), XrdSysUtils::SigBlock(), XrdSysSemaphore::Wait(), XrdSysE2T(), and XrdSysLoggerRT().

Referenced by XrdSysLogger(), and XrdSysLogging::Configure().

Here is the call graph for this function:

Here is the caller graph for this function:

Capture()

void XrdSysLogger::Capture

(

XrdOucTListFIFO *

tFIFO

)

Capture allows you to capture all messages (they are not routed). This is a global setting so use with caution!

Parameters

tFIFO

Pointer to the XrdOucTListFIFO where messages are saved. If the pointer is nil, capturing is turned off.

Definition at line 278 of file XrdSysLogger.cc.

{
 
// Obtain the serailization mutex
//
   Logger_Mutex.Lock();
 
// Set the base for capturing messages
//
   tFifo = tFIFO;
 
// Release the serailization mutex
//
   Logger_Mutex.UnLock();
}

Flush()

void XrdSysLogger::Flush ( )

inline

Flush any pending output.

Definition at line 152 of file XrdSysLogger.hh.

{fsync(eFD);}

References fsync.

originalFD()

int XrdSysLogger::originalFD ( )

inline

Get the file descriptor passed at construction time.

Returns

the file descriptor passed to the constructor.

Definition at line 160 of file XrdSysLogger.hh.

{return baseFD;}

ParseKeep()

int XrdSysLogger::ParseKeep

(

const char *

arg

)

Parse the keep option argument.

Parameters

arg	Pointer to the argument. The argument syntax is: <count> | <size> | fifo | <signame>

Returns

!0 Parsing succeeded. The return value is the argument that must be passed as the lfh parameter to Bind().

=0 Invalid keep argument.

Definition at line 298 of file XrdSysLogger.cc.

{
   char *eP;
 
// First check to see if this is a sig type
//
   eKeep = 0;
   if (isalpha(*arg))
      {if (!strcmp(arg, "fifo")) return onFifo;
       return -XrdSysUtils::GetSigNum(arg);
      }
 
// Process an actual keep count
//
   eKeep = strtoll(arg, &eP, 10);
   if (!(*eP) || eKeep < 0) {eKeep = -eKeep; return 1;}
 
// Process an actual keep size
//
   if (*(eP+1)) return 0;
         if (*eP == 'k' || *eP == 'K') eKeep *= 1024LL;
    else if (*eP == 'm' || *eP == 'M') eKeep *= 1024LL*1024LL;
    else if (*eP == 'g' || *eP == 'G') eKeep *= 1024LL*1024LL*1024LL;
    else if (*eP == 't' || *eP == 'T') eKeep *= 1024LL*1024LL*1024LL*1024LL;
    else return 0;
 
// All done
//
   return 1;
}

References XrdSysUtils::GetSigNum(), and onFifo.

Here is the call graph for this function:

Put()

void XrdSysLogger::Put	(	int	iovcnt,
		struct iovec *	iov )

Output data and optionally prefix with date/time

Parameters

iovcnt	The number of elements in iov vector.
iov	The vector describing what to print. If iov[0].iov_base is zero, the message is prefixed by date and time.

Definition at line 333 of file XrdSysLogger.cc.

{
    struct timeval tVal;
    unsigned long  tID = XrdSysThread::Num();
    int retc;
    char tbuff[32];
 
// Get current time
//
   gettimeofday(&tVal, 0);
 
// Forward the message if there is a plugin involved here
//
   if (doForward)
      {bool xEnd;
       if (iov[0].iov_base) xEnd = XrdSysLogging::Forward(tVal,tID,iov,iovcnt);
          else xEnd = XrdSysLogging::Forward(tVal, tID, &iov[1], iovcnt-1);
       if (xEnd) return;
      }
 
// Prefix message with time if calle wants it so
//
   if (!iov[0].iov_base)
      {iov[0].iov_base = tbuff;
       iov[0].iov_len  = TimeStamp(tVal, tID, tbuff, sizeof(tbuff), hiRes);
      }
 
// Obtain the serailization mutex if need be
//
   Logger_Mutex.Lock();
 
// If we are capturing messages, do so now
//
   if (tFifo)
      {Snatch(iov, iovcnt);
       Logger_Mutex.UnLock();
       return;
      }
 
// In theory, writev may write out a partial list. This rarely happens in
// practice and so we ignore that possibility (recovery is pretty tough).
//
   do { retc = writev(eFD, (const struct iovec *)iov, iovcnt);}
               while (retc < 0 && errno == EINTR);
 
// Release the serailization mutex if need be
//
   Logger_Mutex.UnLock();
}

References XrdSysLogging::Forward(), XrdSysThread::Num(), and writev.

Referenced by XrdSysTrace::operator<<().

Here is the call graph for this function:

Here is the caller graph for this function:

setForwarding()

void XrdSysLogger::setForwarding ( bool onoff )

inlinestatic

Set call-out to logging plug-in on or off.

Definition at line 190 of file XrdSysLogger.hh.

{doForward = onoff;}

Referenced by XrdSysLogging::Configure().

Here is the caller graph for this function:

setHiRes()

void XrdSysLogger::setHiRes ( )

inline

Set log file timstamp to high resolution (hh:mm:ss.uuuu).

Definition at line 196 of file XrdSysLogger.hh.

{hiRes = true;}

Referenced by XrdSysLogging::Configure().

Here is the caller graph for this function:

setKeep()

void XrdSysLogger::setKeep ( long long knum )

inline

Set log file keep value.

Parameters

knum	The keep value. If knum < 0 then abs(knum) files are kept. Otherwise, only knum bytes of log files are kept.

Definition at line 205 of file XrdSysLogger.hh.

{eKeep = knum;}

setRotate()

void XrdSysLogger::setRotate ( int onoff )

inline

Set log file rotation on/off.

Parameters

onoff

When !0 turns on log file rotations. Otherwise, rotation is turned off.

Definition at line 214 of file XrdSysLogger.hh.

{doLFR = onoff;}

traceBeg()

char * XrdSysLogger::traceBeg ( )

inline

Start trace message serialization. This method must be followed by a call to traceEnd().

Returns

pointer to the time buffer to be used as the msg timestamp.

Definition at line 223 of file XrdSysLogger.hh.

{Logger_Mutex.Lock(); Time(TBuff); return TBuff;}

traceEnd()

char XrdSysLogger::traceEnd ( )

inline

Stop trace message serialization. This method must be preceeded by a call to traceBeg().

Returns

pointer to a new line character to terminate the message.

Definition at line 232 of file XrdSysLogger.hh.

{Logger_Mutex.UnLock(); return '\n';}

xlogFN()

const char * XrdSysLogger::xlogFN ( )

inline

Get the log file routing.

Returns

the filename of the log file or "stderr".

Definition at line 240 of file XrdSysLogger.hh.

{return (ePath ? ePath : "stderr");}

zHandler()

void XrdSysLogger::zHandler

(

)

Internal method to handle the logfile. This is public because it needs to be called by an external thread.

Definition at line 809 of file XrdSysLogger.cc.

{
   mmMsg   *mP;
   sigset_t sigset;
   pthread_t tid;
   int      signo, rc;
   Task     *tP;
 
// If we will be handling via signals, set it up now
//
   if (eInt < 0 && !fifoFN)
      {signo = -eInt;
       if ((sigemptyset(&sigset) == -1)
       ||  (sigaddset(&sigset,signo) == -1))
          {rc = errno;
           BLAB("Unable to use logfile signal " <<signo <<"; " <<XrdSysE2T(rc));
           eInt = 0;
          }
      }
 
// This is a perpetual loop to handle the log file
//
   while(1)
        {     if (fifoFN)    FifoWait();
         else if (eInt >= 0) XrdSysTimer::Wait4Midnight();
         else if ((sigwait(&sigset, &signo) == -1))
                 {rc = errno;
                  BLAB("Unable to wait on logfile signal " <<signo
                       <<"; " <<XrdSysE2T(rc));
                  eInt = 0;
                  continue;
                 }
 
         Logger_Mutex.Lock();
         ReBind();
 
         mP = msgList;
         while(mP)
              {putEmsg(mP->msg, mP->mlen);
               mP = mP->next;
              }
         tP = taskQ;
         Logger_Mutex.UnLock();
 
         if (tP)
            {if (XrdSysThread::Run(&tid, XrdSysLoggerMN, (void *)tP, 0,
                                   "Midnight Ringer Task"))
                {char eBuff[256];
                 rc = sprintf(eBuff, "Error %d (%s) running ringer task.\n",
                                     errno, XrdSysE2T(errno));
                 putEmsg(eBuff, rc);
                }
            }
        }
}

References BLAB, XrdSysThread::Run(), XrdSysTimer::Wait4Midnight(), XrdSysE2T(), and XrdSysLoggerMN().

Referenced by XrdSysLoggerRT().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

onFifo

const int XrdSysLogger::onFifo = (int)0x80000000

static

Bind allows you to bind the file descriptor passed at construction time to a file with an optional periodic closing and opening of the file.

Parameters

path

The log file path. The file is created, if need be. If path is null, messages are routed to stderr and the lfh argument is ignored.

lfh

Log file handling: >0 file is to be closed and opened at midnight. This implies automatic log rotation. =0 file is to be left open all the time. This implies no log rotation. <0 file is to be closed and opened only on signal abs(lfh) unless the value equals onFifo. In this case a fifo is used to control log file rotation. The name of the fifo is path with the filename component prefixed by dot. This implies manual log rotation. Warning! Using signals requires that Bind() be called before starting any threads so that the signal is properly blocked.

Returns

0 Processing successful.

<0 Unable to bind, returned value is -errno of the reason.

Definition at line 134 of file XrdSysLogger.hh.

Referenced by Bind(), and ParseKeep().

---

The documentation for this class was generated from the following files:

• XrdSysLogger.hh
• XrdSysLogger.cc