log.h

Go to the documentation of this file.

/*
** Copyright (C) 2005 Russell Leighton
**
** This program is free software; you can redistribute it and/or modify
** it under the terms of the GNU General Public License as published by
** the Free Software Foundation; either version 2 of the License, or
** (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
** GNU General Public License for more details.
**
** You should have received a copy of the GNU General Public License
** along with this program; if not, write to the Free Software
** Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
*/


#ifndef __AW_LOG__
#define __AW_LOG__

#include "sys.h"
#include "thread.h"
#include "errors.h"
#include "util.h"

/*

Changes:

05/14/03 Russ Leighton
Add dedup option.

03/13/02 Russ Leighton
Made aw_log() thread safe.

01/19/2002 Russ Leighton
 Added support for filename and log rotation

May-8-2001 Russ Leighton 
 Start

*/

typedef enum {
  AW_LOGGER_ENABLED = 0x1,            /*< Can log */        
  AW_LOGGER_CACHEMSG = 0x2,           /*< Re-use max size string for log messages */       
  AW_LOGGER_ERR2SYSLOG = 0x4,         /*< If error_logger == NULL , on error use syslog  */     
  AW_LOGGER_ERR2STDERR = 0x8,         /*< If error_logger == NULL , on error use stderr */     
  AW_LOGGER_PREPEND_DATE = 0x10,      /*< Preprend formatted date using asctime(time()) */
  AW_LOGGER_DUP2SYSLOG = 0x20,        /*< Also log to syslog */
  AW_LOGGER_DUP2STDERR = 0x40,        /*< Also log to stderr */
  AW_LOGGER_APPEND_NEWLINE = 0x80,    /*< add a \n to end */
  AW_LOGGER_ROTATE_HR = 0x100,        /*< rotate logs on schedule (hr) */
  AW_LOGGER_ROTATE_DY = 0x200,        /*< rotate logs on schedule (day) */
  AW_LOGGER_ROTATE_MH = 0x400,        /*< rotate logs on schedule (month) */
  AW_LOGGER_DEDUP = 0x800,            /*< only print unique consecutive messages */
  AW_LOGGER_NBITS                     /*< must be last! */
} aw_logger_flag_t;



#define AW_LOGGER_IS_ROTATING(flags) \
( (flags)&(AW_LOGGER_ROTATE_HR | AW_LOGGER_ROTATE_DY | AW_LOGGER_ROTATE_MH) )


#define AW_LOGGER_DEFAULT_FLAGS (\
AW_LOGGER_ENABLED | \
AW_LOGGER_CACHEMSG | \
AW_LOGGER_ERR2SYSLOG | \
AW_LOGGER_ERR2STDERR | \
AW_LOGGER_PREPEND_DATE | \
AW_LOGGER_APPEND_NEWLINE \
)

typedef struct aw_logger_struct {

  sem_t lock;                                       /* make thread safe */

  int32_t min_level, max_level;                     /* level range of accepted log messages (inclusive) */

  const byte_t *filename;                           /* optional filename, if not NULL, I open()'d the fd and need to close() */

  int32_t fd;                                       /* file descriptor to write messages */

  u_int64_t byteswritten;                           /* total bytes written */

  const byte_t *(*strlevel)(int32_t level);       /* if not NULL, this adds a string level code to left of message */

  struct aw_logger_struct *error_logger;            /* this called if current logger has an error */


  /* --------- private */

  u_int32_t lastrotation;                           /* remember the hr/day/week of the last rotation */

  aw_logger_flag_t flags;                           /* config */

  struct aw_logger_struct                           /* aw_log() will evaluate a 'chain' of loggers */
   *head, *prev, *next;                    

  char *msg;                                        /* cached message string */
  u_int32_t msg_size;                               /* size of message */

  u_int32_t dup_count;                              /* number of consective dups */

} aw_logger_t;


typedef struct {

  /* Filename to open, overrides fd if not NULL */
  const byte_t *filename;

  /* File descriptor to write to */
  int fd;

  /* Minimum level of log messages accepted */
  int32_t min_level;

  /* Maximum level of log messages accepted */
  int32_t max_level;

  /* Function to call to map level to string token in log entry (can be NULL) */
  const byte_t *(*strlevel)(int32_t level);

  /* Capabilities */
  aw_logger_flag_t flags;

  /* Logger to call on error in logger itself (can be NULL) */
  aw_logger_t *error_logger;

} aw_logger_params_t;


int32_t aw_logger_init(aw_logger_t *logger, aw_logger_params_t *params);

int32_t aw_logger_clear(aw_logger_t *logger);


int32_t aw_log(aw_logger_t *logger, int32_t level, const char *fmt, ... ) __attribute__ ((format (printf, 3, 4)));

int32_t aw_logger_link(aw_logger_t *logger, aw_logger_t *chain);

void aw_logger_unlink(aw_logger_t *logger);

void aw_logger_setflags(aw_logger_t *logger, aw_logger_flag_t new_flags);

void aw_logger_enable(aw_logger_t *logger);

void aw_logger_disable(aw_logger_t *logger);

#endif

Aware 0.11.1 Copyright (C) 1998-2005 Russell Leighton (russ@elegant-software.com)