log.c File Reference

Logger definitions. More...

#include <stdio.h>
#include <stdarg.h>
#include <time.h>
#include <string.h>
#include <pthread.h>
#include "rnr/rnrconfig.h"
#include "rnr/log.h"
#include "rnr/new.h"

Go to the source code of this file.

Macros
#define	LOG_VAR_FILENAME   LOGNS_PUT(LogFileName)
	define in namespace
#define	LOG_VAR_FP   LOGNS_PUT(LogFp)
	define in namespace

Functions
static const char *	LOGNS_PUT (LogFileName)
	Log File Name.
static FILE *	LOGNS_PUT (LogFp)
	Opened Log file.
int	LOG_SET_THRESHOLD (int nLevel)
	Set new logging threshold level. More...
int	LOG_GET_THRESHOLD ()
	Get current logging threshold level. More...
void	LOG_SET_COLOR_ENABLE (bool_t enable)
	Enable/disable logging in color. More...
void	LOG_SET_TIMESTAMP_ENABLE (bool_t enable)
	Enable/disable log timestamps. More...
int	LOG_SET_LOGFILE (const char *sLogFileName)
	Set new logging output file. More...
const char *	LOG_GET_LOGFILE ()
	Get logging output stream file name. More...
void	LOG_ATTACH_LOGFP (FILE *fp, const char *sFpFileName)
	Attach opened file pointer as the new logging output stream. More...
FILE *	LOG_GET_LOGFP ()
	Get current logging output stream file pointer. More...
void	LOGGER (const char *sFmt,...)
	Print loggging diagnostics, debug, error, and system error messages to log output stream.. More...
static int	LogVaFmtType (char *sFmt)
	Parse function call argument format string to determine type. More...
void	LOGGER_CALL (const char *sPreface, int nLevel, const char *sFile, int nLine, const char *sFuncName,...)
	Print function call diagnostics tracing to log output stream.. More...

Variables
int	LOG_VAR_THRESHOLD = LOG_LEVEL_DFT
	Log threshold level (log iff level <= threshold)
bool_t	LOG_VAR_COLOR_EN = LOG_COLOR_EN_DFT
	Log in color (false = disable, true = enable)
static bool_t	LOG_VAR_TIMESTAMP_EN = LOG_TIMESTAMP_EN_DFT
	Timestamp logging (false = disable, true = enable)
static pthread_mutex_t	MutexLog = PTHREAD_MUTEX_INITIALIZER

Detailed Description

Logger definitions.

LastChangedDate

2014-12-06 13:48:30 -0700 (Sat, 06 Dec 2014)

Rev

3823

Logging supports error and diagnostics (debugging) reports to stderr or a specified file. Logging reporting is filtered by a simple threshold level.

Author

Robin Knight (robin.nosp@m..kni.nosp@m.ght@r.nosp@m.oadn.nosp@m.arrow.nosp@m.s.co.nosp@m.m)

Copyright

© 2005-2018. RoadNarrows LLC..
http://www.roadnarrows.com
All Rights Reserved

Definition in file log.c.

Function Documentation

void LOG_ATTACH_LOGFP	(	FILE *	fp,
		const char *	sFpFileName
	)

Attach opened file pointer as the new logging output stream.

Actual Identifier: <LOGNS>LogAttachLogFp()

Parameters

fp	Opened FILE*.
sFpFileName	File name associated with fp.

Definition at line 282 of file log.c.

References LOG_VAR_FILENAME, LOG_VAR_FP, and new_strdup().

{
  LOG_VAR_FP        = fp;
  delete((char *)LOG_VAR_FILENAME);
  LOG_VAR_FILENAME  = new_strdup(sFpFileName);
}

const char* LOG_GET_LOGFILE

(

)

Get logging output stream file name.

Actual Identifier: <LOGNS>LogGetFileName()

Returns

On success, returns 0. On failure, return -1 with errno set appropriately.

Definition at line 260 of file log.c.

References LOG_FILENAME_DFT, LOG_VAR_FILENAME, and NULL.

{
  if( LOG_VAR_FILENAME != NULL )
  {
    return LOG_VAR_FILENAME;
  }
  else
  {
    return LOG_FILENAME_DFT;
  }
}

FILE* LOG_GET_LOGFP

(

)

Get current logging output stream file pointer.

This function is handing if an application has some complicated output for the logging stream.

Actual Identifier: <LOGNS>LogGetLogFp()

Returns

FILE*

Definition at line 301 of file log.c.

References LOG_VAR_FP.

Referenced by init(), and NewSearchPathDList().

{
  return LOG_VAR_FP;
}

int LOG_GET_THRESHOLD

(

)

Get current logging threshold level.

This function is always defined to safeley determine if logging is available.

Actual Identifier: <LOGNS>LogGetThresholdLevel()

Returns

Current logging threshold. If logging is not available, (i.e. LOG was not defined) then LOGGING_NA is returned.

Definition at line 142 of file log.c.

References LOG_VAR_THRESHOLD, and LOGGING_NA.

{
#ifdef LOG
  return LOG_VAR_THRESHOLD;
#else
  return LOGGING_NA;
#endif // LOG
}

void LOG_SET_COLOR_ENABLE

(

bool_t

enable

)

Enable/disable logging in color.

This function is always defined to allow blind sets.

Actual Identifier: <LOGNS>LogSetColorEnable()

Parameters

enable

Enable(true) or disable(false).

Definition at line 160 of file log.c.

References LOG_VAR_COLOR_EN.

Referenced by OptsLogDisableColor().

{
#ifdef LOG
  LOG_VAR_COLOR_EN = enable;
#endif // LOG
}

int LOG_SET_LOGFILE

(

const char *

sLogFileName

)

Set new logging output file.

The file is opened and truncated.

This function is always defined allow blind sets.

Actual Identifier: <LOGNS>LogSetLogFile()

Todo:

On file open add time-stamp first entry.

Parameters

sLogFileName

Name of new log file.

Returns

On success, returns 0. On failure, return -1 with errno set appropriately.

Definition at line 199 of file log.c.

References LOG_FILENAME_STDERR, LOG_FILENAME_STDOUT, LOG_VAR_FILENAME, LOG_VAR_FP, LOGDIAG1, LOGSYSERROR, new_strdup(), and NULL.

Referenced by OptsLogSetFile().

{
#ifdef LOG
  FILE  *fp;

  // already opened
  if( (LOG_VAR_FILENAME != NULL) && !strcmp(sLogFileName, LOG_VAR_FILENAME) )
  {
    return 0;
  }

  //
  // "Open" new log file.
  //
  if( !strcmp(sLogFileName, LOG_FILENAME_STDERR) )
  {
    fp = stderr;
  }
  else if( !strcmp(sLogFileName, LOG_FILENAME_STDOUT) )
  {
    fp = stdout;
  }
  else if( (fp = fopen(sLogFileName, "a+")) == NULL )
  {
    LOGSYSERROR("%s", sLogFileName);
    return -1;
  }

  LOGDIAG1("--- End Of Log %s ---", LOG_VAR_FILENAME);

  // 
  // Close old log file.
  //
  if( (LOG_VAR_FILENAME != NULL) 
      && strcmp(LOG_VAR_FILENAME, LOG_FILENAME_STDERR) 
      && strcmp(LOG_VAR_FILENAME, LOG_FILENAME_STDOUT) )
  {
    fclose(LOG_VAR_FP);
  }

  //
  // Set new log file data
  //
  LOG_VAR_FP        = fp;
  delete((char *)LOG_VAR_FILENAME);
  LOG_VAR_FILENAME  = new_strdup(sLogFileName);
  LOGDIAG1("--- Start Of Log %s ---", LOG_VAR_FILENAME);
#endif // LOG

  return 0;
}

int LOG_SET_THRESHOLD

(

int

nLevel

)

Set new logging threshold level.

All logging at the level <= threshold level will be enabled.

This function is always defined allow blind sets.

Actual Identifier: <LOGNS>LogSetThresholdLevel()

Parameters

nLevel

New threshold level.

Returns

New adjusted logging level. If logging is not availble (i.e. LOG was not defined) then LOGGING_NA is returned.

Definition at line 96 of file log.c.

References LOG_LEVEL_DIAG1, LOG_LEVEL_OFF, LOG_VAR_COLOR_EN, LOG_VAR_THRESHOLD, LOGARGS_DIAG, LOGARGS_DIAG_PLAIN, LOGGER(), and LOGGING_NA.

Referenced by CmdLog(), main(), and OptsLogSetLevel().

{
#ifdef LOG
  int   nOldLevel;

  nOldLevel = LOG_VAR_THRESHOLD;

  if( nLevel < LOG_LEVEL_OFF )
  {
    LOG_VAR_THRESHOLD = LOG_LEVEL_OFF;
  }
  else
  {
    LOG_VAR_THRESHOLD = nLevel;
  }

  if( (nOldLevel >= LOG_LEVEL_DIAG1) || (LOG_VAR_THRESHOLD >= LOG_LEVEL_DIAG1) )
  {
    if( LOG_VAR_COLOR_EN )
    {
      LOGGER(LOGARGS_DIAG(2, "Logging level set to %d", LOG_VAR_THRESHOLD));
    }
    else
    {
      LOGGER(LOGARGS_DIAG_PLAIN(2, "Logging level set to %d",
            LOG_VAR_THRESHOLD));
    }
  }

  return LOG_VAR_THRESHOLD;
#else
  return LOGGING_NA;
#endif // LOG
}

void LOG_SET_TIMESTAMP_ENABLE

(

bool_t

enable

)

Enable/disable log timestamps.

This function is always defined to allow blind sets.

Actual Identifier: <LOGNS>LogSetTimestampEnable()

Parameters

enable

Enable(true) or disable(false).

Definition at line 176 of file log.c.

References LOG_VAR_TIMESTAMP_EN.

Referenced by OptsLogDisableTimestamp().

{
#ifdef LOG
  LOG_VAR_TIMESTAMP_EN = enable;
#endif // LOG
}

void LOGGER	(	const char *	sFmt,
			...
	)

Print loggging diagnostics, debug, error, and system error messages to log output stream..

Actual Identifier: <LOGNS>LogPrintf()

Parameters

sFmt	Format string.
...	Variable format arguments.

Definition at line 317 of file log.c.

References LOG_FILENAME_STDERR, LOG_FP_DFT, LOG_VAR_FILENAME, LOG_VAR_FP, LOG_WITH_TIMESTAMP, new_strdup(), and NULL.

Referenced by LOG_SET_THRESHOLD().

{
  va_list   ap;

  pthread_mutex_lock(&MutexLog);

  // lazy init
  if( LOG_VAR_FP == NULL )
  {
    LOG_VAR_FP = LOG_FP_DFT;
    LOG_VAR_FILENAME = new_strdup(LOG_FILENAME_STDERR);
  }

  if( LOG_WITH_TIMESTAMP() )
  {
    struct timespec tsNow;

    clock_gettime(CLOCK_REALTIME, &tsNow);
    fprintf(LOG_VAR_FP, "[%ld.%09ld] ", tsNow.tv_sec, tsNow.tv_nsec);
  }

  va_start(ap, sFmt);
  vfprintf(LOG_VAR_FP, sFmt, ap);
  fprintf(LOG_VAR_FP, "\n");
  va_end(ap);
  fflush(LOG_VAR_FP);

  pthread_mutex_unlock(&MutexLog);
}

void LOGGER_CALL	(	const char *	sPreface,
		int	nLevel,
		const char *	sFile,
		int	nLine,
		const char *	sFuncName,
			...
	)

Print function call diagnostics tracing to log output stream..

Actual Identifier: <LOGNS>LogCallPrintf()

Parameters

sPreface	Logging preface string.
nLevel	Logging level.
sFile	File holding function definition.
nLine	File line number.
sFuncName	Function name string.
...	Pairs of function format_string,argument pairs terminated by NULL,0

Definition at line 445 of file log.c.

References LOG_COLOR_DIAG, LOG_COLOR_POST, LOG_FILENAME_STDERR, LOG_FP_DFT, LOG_VAR_FILENAME, LOG_VAR_FP, LOG_WITH_TIMESTAMP, LogColorEnable, LogVaFmtType(), new_strdup(), and NULL.

{
  bool_t  bIsOk = true;
  char   *sArgFmt;
  char   *sSep = ""; 
  va_list ap;

  pthread_mutex_lock(&MutexLog);

  // lazy init
  if( LOG_VAR_FP == NULL )
  {
    LOG_VAR_FP = LOG_FP_DFT;
    LOG_VAR_FILENAME = new_strdup(LOG_FILENAME_STDERR);
  }

  if( LOG_WITH_TIMESTAMP() )
  {
    struct timespec tsNow;

    clock_gettime(CLOCK_REALTIME, &tsNow);
    fprintf(LOG_VAR_FP, "[%ld.%09ld] ", tsNow.tv_sec, tsNow.tv_nsec);
  }

  va_start(ap, sFuncName);

  if( LogColorEnable )
  {
    fprintf(LOG_VAR_FP,
          "%s" LOG_COLOR_DIAG "Diag%d: %s[%d] " LOG_COLOR_POST "%s(",
          sPreface, nLevel-1, sFile, nLine, sFuncName);
  }
  else
  {
    fprintf(LOG_VAR_FP,
          "%s" "Diag%d: %s[%d] " "%s(",
          sPreface, nLevel-1, sFile, nLine, sFuncName);
  }

  while( bIsOk )
  {
    // function call argument format
    sArgFmt = va_arg(ap, char *);
    if( sArgFmt == NULL )
    {
      break;
    }

    // separator
    fprintf(LOG_VAR_FP, "%s", sSep);
    sSep = ",";

    // function call argument type and print
    switch( LogVaFmtType(sArgFmt) )
    {
      case 'd':
        fprintf(LOG_VAR_FP, sArgFmt, va_arg(ap, int));
        break;
      case 'l':
        fprintf(LOG_VAR_FP, sArgFmt, va_arg(ap, long));
        break;
      case 'u':
        fprintf(LOG_VAR_FP, sArgFmt, va_arg(ap, unsigned int));
        break;
      case 'U':
        fprintf(LOG_VAR_FP, sArgFmt, va_arg(ap, unsigned long));
        break;
      case 'f':
        fprintf(LOG_VAR_FP, sArgFmt, va_arg(ap, double));
        break;
      case 's':
        fprintf(LOG_VAR_FP, sArgFmt, va_arg(ap, char *));
        break;
      case 'p':
        fprintf(LOG_VAR_FP, sArgFmt, va_arg(ap, void *));
        break;
      case 'c':
        fprintf(LOG_VAR_FP, sArgFmt, va_arg(ap, int));
        break;
      default:
        fprintf(LOG_VAR_FP, "UNKNOWN_FORMAT");
        bIsOk = false;
        break;
    }
  }

  fprintf(LOG_VAR_FP, ")\n");
  va_end(ap);

  fflush(LOG_VAR_FP);

  pthread_mutex_unlock(&MutexLog);
}

static int LogVaFmtType ( char *  sFmt )

static

Parse function call argument format string to determine type.

Type range is determined by what va_arg() takes.

Parameters

sFmt	Argument format string.

Returns

Quasi-specifier as in fprintf(3). Returns '?' for unreckonized formats.

Definition at line 359 of file log.c.

Referenced by LOGGER_CALL().

{
  bool_t  bPercent = false;
  char   *s;
  char    last;
  char    length = 'i';

  for(last=0, s=sFmt; s && *s; last = *s, s++)
  {
    if( *s == '%')
    {
      if( last == '%' )
      {
        bPercent = false;
        length = 'i';
      }
      else
      {
        bPercent = true;
      }
    }

    else if( bPercent )
    {
      switch( *s )
      {
        case 'h':
          length = 'h'; // short
          break;
        case 'l':
          length = 'l'; // long
          break;
        case 'c':
          return 'c';   // char
        case 'e':
        case 'E':
        case 'f':
        case 'F':
        case 'g':
        case 'G':
          return 'f';   // double
        case 'd':
        case 'i':
          switch( length )
          {
            case 'l':
              return 'l';   // long integer
            default:
              return 'd';   // integer
          }
          break;
        case 'o':
        case 'u':
        case 'x':
        case 'X':
          switch( length )
          {
            case 'l':
              return 'U';   // long unsigned
            default:
              return 'u';   // unsigned integer
          }
          break;
        case 's':
          return 's';   // string
        case 'p':
          return 'p';   // pointer
      }
    }
  }
  return '?';
}