lib/log.h

   1 /*
   2  * $Id$
   3  *
   4  * Zebra logging funcions.
   5  * Copyright (C) 1997, 1998, 1999 Kunihiro Ishiguro
   6  *
   7  * This file is part of GNU Zebra.
   8  *
   9  * GNU Zebra is free software; you can redistribute it and/or modify it
  10  * under the terms of the GNU General Public License as published by the
  11  * Free Software Foundation; either version 2, or (at your option) any
  12  * later version.
  13  *
  14  * GNU Zebra is distributed in the hope that it will be useful, but
  15  * WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  17  * General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License
  20  * along with GNU Zebra; see the file COPYING.  If not, write to the Free
  21  * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
  22  * 02111-1307, USA.
  23  */
  24
  25 #ifndef _ZEBRA_LOG_H
  26 #define _ZEBRA_LOG_H
  27
  28 #include <syslog.h>
  29
  30 /* Here is some guidance on logging levels to use:
  31  *
  32  * LOG_DEBUG    - For all messages that are enabled by optional debugging
  33  *                features, typically preceded by "if (IS...DEBUG...)"
  34  * LOG_INFO     - Information that may be of interest, but everything seems
  35  *                to be working properly.
  36  * LOG_NOTICE   - Only for message pertaining to daemon startup or shutdown.
  37  * LOG_WARNING  - Warning conditions: unexpected events, but the daemon believes
  38  *                it can continue to operate correctly.
  39  * LOG_ERR      - Error situations indicating malfunctions.  Probably require
  40  *                attention.
  41  *
  42  * Note: LOG_CRIT, LOG_ALERT, and LOG_EMERG are currently not used anywhere,
  43  * please use LOG_ERR instead.
  44  */
  45
  46 typedef enum
  47 {
  48   ZLOG_NONE,
  49   ZLOG_DEFAULT,
  50   ZLOG_ZEBRA,
  51   ZLOG_RIP,
  52   ZLOG_BGP,
  53   ZLOG_OSPF,
  54   ZLOG_RIPNG,
  55   ZLOG_OSPF6,
  56   ZLOG_ISIS,
  57   ZLOG_MASC
  58 } zlog_proto_t;
  59
  60 /* If maxlvl is set to ZLOG_DISABLED, then no messages will be sent
  61    to that logging destination. */
  62 #define ZLOG_DISABLED   (LOG_EMERG-1)
  63
  64 typedef enum
  65 {
  66   ZLOG_DEST_SYSLOG = 0,
  67   ZLOG_DEST_STDOUT,
  68   ZLOG_DEST_MONITOR,
  69   ZLOG_DEST_FILE
  70 } zlog_dest_t;
  71 #define ZLOG_NUM_DESTS          (ZLOG_DEST_FILE+1)
  72
  73 struct zlog
  74 {
  75   const char *ident;    /* daemon name (first arg to openlog) */
  76   zlog_proto_t protocol;
  77   int maxlvl[ZLOG_NUM_DESTS];   /* maximum priority to send to associated
  78                                    logging destination */
  79   int default_lvl;      /* maxlvl to use if none is specified */
  80   FILE *fp;
  81   char *filename;
  82   int facility;         /* as per syslog facility */
  83   int record_priority;  /* should messages logged through stdio include the
  84                            priority of the message? */
  85   int syslog_options;   /* 2nd arg to openlog */
  86   int timestamp_precision;      /* # of digits of subsecond precision */
  87 };
  88
  89 /* Message structure. */
  90 struct message
  91 {
  92   int key;
  93   const char *str;
  94 };
  95
  96 /* Default logging strucutre. */
  97 extern struct zlog *zlog_default;
  98
  99 /* Open zlog function */
 100 extern struct zlog *openzlog (const char *progname, zlog_proto_t protocol,
 101                               int syslog_options, int syslog_facility);
 102
 103 /* Close zlog function. */
 104 extern void closezlog (struct zlog *zl);
 105
 106 /* GCC have printf type attribute check.  */
 107 #ifdef __GNUC__
 108 #define PRINTF_ATTRIBUTE(a,b) __attribute__ ((__format__ (__printf__, a, b)))
 109 #else
 110 #define PRINTF_ATTRIBUTE(a,b)
 111 #endif /* __GNUC__ */
 112
 113 /* Generic function for zlog. */
 114 extern void zlog (struct zlog *zl, int priority, const char *format, ...) PRINTF_ATTRIBUTE(3, 4);
 115
 116 /* Handy zlog functions. */
 117 extern void zlog_err (const char *format, ...) PRINTF_ATTRIBUTE(1, 2);
 118 extern void zlog_warn (const char *format, ...) PRINTF_ATTRIBUTE(1, 2);
 119 extern void zlog_info (const char *format, ...) PRINTF_ATTRIBUTE(1, 2);
 120 extern void zlog_notice (const char *format, ...) PRINTF_ATTRIBUTE(1, 2);
 121 extern void zlog_debug (const char *format, ...) PRINTF_ATTRIBUTE(1, 2);
 122
 123 /* For bgpd's peer oriented log. */
 124 extern void plog_err (struct zlog *, const char *format, ...);
 125 extern void plog_warn (struct zlog *, const char *format, ...);
 126 extern void plog_info (struct zlog *, const char *format, ...);
 127 extern void plog_notice (struct zlog *, const char *format, ...);
 128 extern void plog_debug (struct zlog *, const char *format, ...);
 129
 130 /* Set logging level for the given destination.  If the log_level
 131    argument is ZLOG_DISABLED, then the destination is disabled.
 132    This function should not be used for file logging (use zlog_set_file
 133    or zlog_reset_file instead). */
 134 extern void zlog_set_level (struct zlog *zl, zlog_dest_t, int log_level);
 135
 136 /* Set logging to the given filename at the specified level. */
 137 extern int zlog_set_file (struct zlog *zl, const char *filename, int log_level);
 138 /* Disable file logging. */
 139 extern int zlog_reset_file (struct zlog *zl);
 140
 141 /* Rotate log. */
 142 extern int zlog_rotate (struct zlog *);
 143
 144 /* For hackey massage lookup and check */
 145 #define LOOKUP(x, y) mes_lookup(x, x ## _max, y, "(no item found)")
 146
 147 extern const char *lookup (struct message *, int);
 148 extern const char *mes_lookup (struct message *meslist,
 149                                int max, int index,
 150                                const char *no_item);
 151
 152 extern const char *zlog_priority[];
 153 extern const char *zlog_proto_names[];
 154
 155 /* Safe version of strerror -- never returns NULL. */
 156 extern const char *safe_strerror(int errnum);
 157
 158 /* To be called when a fatal signal is caught. */
 159 extern void zlog_signal(int signo, const char *action
 160 #ifdef SA_SIGINFO
 161                         , siginfo_t *siginfo, void *program_counter
 162 #endif
 163                        );
 164
 165 /* Log a backtrace. */
 166 extern void zlog_backtrace(int priority);
 167
 168 /* Log a backtrace, but in an async-signal-safe way.  Should not be
 169    called unless the program is about to exit or abort, since it messes
 170    up the state of zlog file pointers.  If program_counter is non-NULL,
 171    that is logged in addition to the current backtrace. */
 172 extern void zlog_backtrace_sigsafe(int priority, void *program_counter);
 173
 174 /* Puts a current timestamp in buf and returns the number of characters
 175    written (not including the terminating NUL).  The purpose of
 176    this function is to avoid calls to localtime appearing all over the code.
 177    It caches the most recent localtime result and can therefore
 178    avoid multiple calls within the same second.  If buflen is too small,
 179    *buf will be set to '\0', and 0 will be returned. */
 180 extern size_t quagga_timestamp(int timestamp_precision /* # subsecond digits */,
 181                                char *buf, size_t buflen);
 182
 183 /* structure useful for avoiding repeated rendering of the same timestamp */
 184 struct timestamp_control {
 185    size_t len;          /* length of rendered timestamp */
 186    int precision;       /* configuration parameter */
 187    int already_rendered; /* should be initialized to 0 */
 188    char buf[40];        /* will contain the rendered timestamp */
 189 };
 190
 191 /* Defines for use in command construction: */
 192
 193 #define LOG_LEVELS "(emergencies|alerts|critical|errors|warnings|notifications|informational|debugging)"
 194
 195 #define LOG_LEVEL_DESC \
 196   "System is unusable\n" \
 197   "Immediate action needed\n" \
 198   "Critical conditions\n" \
 199   "Error conditions\n" \
 200   "Warning conditions\n" \
 201   "Normal but significant conditions\n" \
 202   "Informational messages\n" \
 203   "Debugging messages\n"
 204
 205 #define LOG_FACILITIES "(kern|user|mail|daemon|auth|syslog|lpr|news|uucp|cron|local0|local1|local2|local3|local4|local5|local6|local7)"
 206
 207 #define LOG_FACILITY_DESC \
 208        "Kernel\n" \
 209        "User process\n" \
 210        "Mail system\n" \
 211        "System daemons\n" \
 212        "Authorization system\n" \
 213        "Syslog itself\n" \
 214        "Line printer system\n" \
 215        "USENET news\n" \
 216        "Unix-to-Unix copy system\n" \
 217        "Cron/at facility\n" \
 218        "Local use\n" \
 219        "Local use\n" \
 220        "Local use\n" \
 221        "Local use\n" \
 222        "Local use\n" \
 223        "Local use\n" \
 224        "Local use\n" \
 225        "Local use\n"
 226
 227 #endif /* _ZEBRA_LOG_H */