lib/log.h

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