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 #include <stdio.h>
  28
  29 /* Here is some guidance on logging levels to use:
  30  *
  31  * LOG_DEBUG    - For all messages that are enabled by optional debugging
  32  *                features, typically preceded by "if (IS...DEBUG...)"
  33  * LOG_INFO     - Information that may be of interest, but everything seems
  34  *                to be working properly.
  35  * LOG_NOTICE   - Only for message pertaining to daemon startup or shutdown.
  36  * LOG_WARNING  - Warning conditions: unexpected events, but the daemon believes
  37  *                it can continue to operate correctly.
  38  * LOG_ERR      - Error situations indicating malfunctions.  Probably require
  39  *                attention.
  40  *
  41  * Note: LOG_CRIT, LOG_ALERT, and LOG_EMERG are currently not used anywhere,
  42  * please use LOG_ERR instead.
  43  */
  44
  45 typedef enum
  46 {
  47   ZLOG_NONE,
  48   ZLOG_DEFAULT,
  49   ZLOG_ZEBRA,
  50   ZLOG_RIP,
  51   ZLOG_BGP,
  52   ZLOG_OSPF,
  53   ZLOG_RIPNG,
  54   ZLOG_BABEL,
  55   ZLOG_OSPF6,
  56   ZLOG_ISIS,
  57   ZLOG_PIM,
  58   ZLOG_MASC,
  59   ZLOG_NHRP,
  60 } zlog_proto_t;
  61
  62 /* If maxlvl is set to ZLOG_DISABLED, then no messages will be sent
  63    to that logging destination. */
  64 #define ZLOG_DISABLED   (LOG_EMERG-1)
  65
  66 typedef enum
  67 {
  68   ZLOG_DEST_SYSLOG = 0,
  69   ZLOG_DEST_STDOUT,
  70   ZLOG_DEST_MONITOR,
  71   ZLOG_DEST_FILE
  72 } zlog_dest_t;
  73 #define ZLOG_NUM_DESTS          (ZLOG_DEST_FILE+1)
  74
  75 struct zlog
  76 {
  77   const char *ident;    /* daemon name (first arg to openlog) */
  78   zlog_proto_t protocol;
  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                               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 zlog_err (const char *format, ...) PRINTF_ATTRIBUTE(1, 2);
 121 extern void zlog_warn (const char *format, ...) PRINTF_ATTRIBUTE(1, 2);
 122 extern void zlog_info (const char *format, ...) PRINTF_ATTRIBUTE(1, 2);
 123 extern void zlog_notice (const char *format, ...) PRINTF_ATTRIBUTE(1, 2);
 124 extern void zlog_debug (const char *format, ...) PRINTF_ATTRIBUTE(1, 2);
 125
 126 /* For bgpd's peer oriented log. */
 127 extern void plog_err (struct zlog *, const char *format, ...)
 128   PRINTF_ATTRIBUTE(2, 3);
 129 extern void plog_warn (struct zlog *, const char *format, ...)
 130   PRINTF_ATTRIBUTE(2, 3);
 131 extern void plog_info (struct zlog *, const char *format, ...)
 132   PRINTF_ATTRIBUTE(2, 3);
 133 extern void plog_notice (struct zlog *, const char *format, ...)
 134   PRINTF_ATTRIBUTE(2, 3);
 135 extern void plog_debug (struct zlog *, const char *format, ...)
 136   PRINTF_ATTRIBUTE(2, 3);
 137
 138 extern void zlog_thread_info (int log_level);
 139
 140 /* Set logging level for the given destination.  If the log_level
 141    argument is ZLOG_DISABLED, then the destination is disabled.
 142    This function should not be used for file logging (use zlog_set_file
 143    or zlog_reset_file instead). */
 144 extern void zlog_set_level (struct zlog *zl, zlog_dest_t, int log_level);
 145
 146 /* Set logging to the given filename at the specified level. */
 147 extern int zlog_set_file (struct zlog *zl, const char *filename, int log_level);
 148 /* Disable file logging. */
 149 extern int zlog_reset_file (struct zlog *zl);
 150
 151 /* Rotate log. */
 152 extern int zlog_rotate (struct zlog *);
 153
 154 /* For hackey message lookup and check */
 155 #define LOOKUP_DEF(x, y, def) mes_lookup(x, x ## _max, y, def, #x)
 156 #define LOOKUP(x, y) LOOKUP_DEF(x, y, "(no item found)")
 157
 158 extern const char *lookup (const struct message *, int);
 159 extern const char *mes_lookup (const struct message *meslist,
 160                                int max, int index,
 161                                const char *no_item, const char *mesname);
 162
 163 extern const char *zlog_priority[];
 164 extern const char *zlog_proto_names[];
 165
 166 /* Safe version of strerror -- never returns NULL. */
 167 extern const char *safe_strerror(int errnum);
 168
 169 /* To be called when a fatal signal is caught. */
 170 extern void zlog_signal(int signo, const char *action
 171 #ifdef SA_SIGINFO
 172                         , siginfo_t *siginfo, void *program_counter
 173 #endif
 174                        );
 175
 176 /* Log a backtrace. */
 177 extern void zlog_backtrace(int priority);
 178
 179 /* Log a backtrace, but in an async-signal-safe way.  Should not be
 180    called unless the program is about to exit or abort, since it messes
 181    up the state of zlog file pointers.  If program_counter is non-NULL,
 182    that is logged in addition to the current backtrace. */
 183 extern void zlog_backtrace_sigsafe(int priority, void *program_counter);
 184
 185 /* Puts a current timestamp in buf and returns the number of characters
 186    written (not including the terminating NUL).  The purpose of
 187    this function is to avoid calls to localtime appearing all over the code.
 188    It caches the most recent localtime result and can therefore
 189    avoid multiple calls within the same second.  If buflen is too small,
 190    *buf will be set to '\0', and 0 will be returned. */
 191 #define QUAGGA_TIMESTAMP_LEN 40
 192 extern size_t quagga_timestamp(int timestamp_precision /* # subsecond digits */,
 193                                char *buf, size_t buflen);
 194
 195 extern void zlog_hexdump(void *mem, unsigned int len);
 196
 197 /* structure useful for avoiding repeated rendering of the same timestamp */
 198 struct timestamp_control {
 199    size_t len;          /* length of rendered timestamp */
 200    int precision;       /* configuration parameter */
 201    int already_rendered; /* should be initialized to 0 */
 202    char buf[QUAGGA_TIMESTAMP_LEN];      /* will contain the rendered timestamp */
 203 };
 204
 205 /* Defines for use in command construction: */
 206
 207 #define LOG_LEVELS "(emergencies|alerts|critical|errors|warnings|notifications|informational|debugging)"
 208
 209 #define LOG_LEVEL_DESC \
 210   "System is unusable\n" \
 211   "Immediate action needed\n" \
 212   "Critical conditions\n" \
 213   "Error conditions\n" \
 214   "Warning conditions\n" \
 215   "Normal but significant conditions\n" \
 216   "Informational messages\n" \
 217   "Debugging messages\n"
 218
 219 #define LOG_FACILITIES "(kern|user|mail|daemon|auth|syslog|lpr|news|uucp|cron|local0|local1|local2|local3|local4|local5|local6|local7)"
 220
 221 #define LOG_FACILITY_DESC \
 222        "Kernel\n" \
 223        "User process\n" \
 224        "Mail system\n" \
 225        "System daemons\n" \
 226        "Authorization system\n" \
 227        "Syslog itself\n" \
 228        "Line printer system\n" \
 229        "USENET news\n" \
 230        "Unix-to-Unix copy system\n" \
 231        "Cron/at facility\n" \
 232        "Local use\n" \
 233        "Local use\n" \
 234        "Local use\n" \
 235        "Local use\n" \
 236        "Local use\n" \
 237        "Local use\n" \
 238        "Local use\n" \
 239        "Local use\n"
 240
 241 #endif /* _ZEBRA_LOG_H */