debug.c

   1 /*
   2  * Copyright (C) 2007 Stig Venaas <venaas@uninett.no>
   3  * Copyright (C) 2010 NORDUnet A/S
   4  *
   5  * Permission to use, copy, modify, and distribute this software for any
   6  * purpose with or without fee is hereby granted, provided that the above
   7  * copyright notice and this permission notice appear in all copies.
   8  */
   9
  10 #ifndef SYS_SOLARIS9
  11 #include <stdint.h>
  12 #endif
  13 #include <stdio.h>
  14 #include <stdlib.h>
  15 #include <stdarg.h>
  16 #include <string.h>
  17 #include <strings.h>
  18 #include <time.h>
  19 #include <sys/time.h>
  20 #include <syslog.h>
  21 #include <errno.h>
  22 #include <assert.h>
  23 #include "debug.h"
  24 #include "util.h"
  25
  26 static char *debug_ident = NULL;
  27 static uint8_t debug_level = DBG_INFO;
  28 static char *debug_filepath = NULL;
  29 static FILE *debug_file = NULL;
  30 static int debug_syslogfacility = 0;
  31 #if defined(WANT_FTICKS)
  32 static int fticks_syslogfacility = 0;
  33 #endif
  34 static uint8_t debug_timestamp = 0;
  35
  36 void debug_init(char *ident) {
  37     debug_file = stderr;
  38     setvbuf(debug_file, NULL, _IONBF, 0);
  39     debug_ident = ident;
  40 }
  41
  42 void debug_set_level(uint8_t level) {
  43     switch (level) {
  44     case 1:
  45         debug_level = DBG_ERR;
  46         return;
  47     case 2:
  48         debug_level = DBG_WARN;
  49         return;
  50     case 3:
  51         debug_level = DBG_NOTICE;
  52         return;
  53     case 4:
  54         debug_level = DBG_INFO;
  55         return;
  56     case 5:
  57         debug_level = DBG_DBG;
  58         return;
  59     }
  60 }
  61
  62 void debug_timestamp_on() {
  63     debug_timestamp = 1;
  64 }
  65
  66 uint8_t debug_get_level() {
  67     return debug_level;
  68 }
  69
  70 int debug_set_destination(char *dest, int log_type) {
  71     static const char *facstrings[] = { "LOG_DAEMON", "LOG_MAIL", "LOG_USER", "LOG_LOCAL0",
  72         "LOG_LOCAL1", "LOG_LOCAL2", "LOG_LOCAL3", "LOG_LOCAL4",
  73         "LOG_LOCAL5", "LOG_LOCAL6", "LOG_LOCAL7", NULL };
  74     static const int facvals[] = { LOG_DAEMON, LOG_MAIL, LOG_USER, LOG_LOCAL0,
  75         LOG_LOCAL1, LOG_LOCAL2, LOG_LOCAL3, LOG_LOCAL4,
  76         LOG_LOCAL5, LOG_LOCAL6, LOG_LOCAL7 };
  77     extern int errno;
  78     int i;
  79
  80     if (!strncasecmp(dest, "file:///", 8)) {
  81         if (log_type!=FTICKS_LOG) {
  82             debug_filepath = stringcopy(dest + 7, 0);
  83             debug_file = fopen(debug_filepath, "a");
  84             if (!debug_file) {
  85                 debug_file = stderr;
  86                 debugx(1, DBG_ERR, "Failed to open logfile %s\n%s",
  87                    debug_filepath, strerror(errno));
  88             }
  89             setvbuf(debug_file, NULL, _IONBF, 0);
  90         } else {
  91             debug(DBG_WARN, "FTicksSyslogFacility starting with file:/// not permitted, assuming default F-Ticks destination");
  92         }
  93         return 1;
  94     }
  95     if (!strncasecmp(dest, "x-syslog://", 11) || (log_type==FTICKS_LOG)) {
  96         if (!strncasecmp(dest, "x-syslog://", 11)) {
  97                 dest += 11;
  98                 if (*dest == '/')
  99                   dest++;
 100         }
 101         if (*dest) {
 102             for (i = 0; facstrings[i]; i++)
 103                 if (!strcasecmp(dest, facstrings[i]))
 104                     break;
 105             if (!facstrings[i])
 106                 debugx(1, DBG_ERR, "Unknown syslog facility %s", dest);
 107             if (log_type==FTICKS_LOG)
 108                 fticks_syslogfacility = facvals[i];
 109             else
 110                 debug_syslogfacility = facvals[i];
 111         } else {
 112                 if (log_type==FTICKS_LOG)
 113                    fticks_syslogfacility = 0;
 114                 else
 115                    debug_syslogfacility = LOG_DAEMON;
 116         }
 117         if (log_type==FTICKS_LOG) {
 118                 if (fticks_syslogfacility && !debug_syslogfacility) {
 119                     openlog(debug_ident, LOG_PID, fticks_syslogfacility);
 120                 }
 121         } else
 122                 openlog(debug_ident, LOG_PID, debug_syslogfacility);
 123         return 1;
 124     }
 125     debug(DBG_ERR, "Unknown log destination, exiting %s", dest);
 126     exit(1);
 127 }
 128
 129 void debug_reopen_log() {
 130     extern int errno;
 131
 132     /* not a file, noop, return success */
 133     if (!debug_filepath) {
 134         debug(DBG_ERR, "skipping reopen");
 135         return;
 136     }
 137
 138     if (debug_file != stderr)
 139         fclose(debug_file);
 140
 141     debug_file = fopen(debug_filepath, "a");
 142     if (debug_file)
 143         debug(DBG_ERR, "Reopened logfile %s", debug_filepath);
 144     else {
 145         debug_file = stderr;
 146         debug(DBG_ERR, "Failed to open logfile %s, using stderr\n%s",
 147               debug_filepath, strerror(errno));
 148     }
 149     setvbuf(debug_file, NULL, _IONBF, 0);
 150 }
 151
 152 void debug_logit(uint8_t level, const char *format, va_list ap) {
 153     struct timeval now;
 154     char *timebuf;
 155     int priority;
 156
 157     if (debug_syslogfacility) {
 158         switch (level) {
 159         case DBG_DBG:
 160             priority = LOG_DEBUG;
 161             break;
 162         case DBG_INFO:
 163             priority = LOG_INFO;
 164             break;
 165         case DBG_NOTICE:
 166             priority = LOG_NOTICE;
 167             break;
 168         case DBG_WARN:
 169             priority = LOG_WARNING;
 170             break;
 171         case DBG_ERR:
 172             priority = LOG_ERR;
 173             break;
 174         default:
 175             priority = LOG_DEBUG;
 176         }
 177         vsyslog(priority, format, ap);
 178     } else {
 179         if (debug_timestamp && (timebuf = malloc(256))) {
 180             gettimeofday(&now, NULL);
 181             ctime_r(&now.tv_sec, timebuf);
 182             timebuf[strlen(timebuf) - 1] = '\0';
 183             fprintf(debug_file, "%s: ", timebuf + 4);
 184             free(timebuf);
 185         }
 186         vfprintf(debug_file, format, ap);
 187         fprintf(debug_file, "\n");
 188     }
 189 }
 190
 191 void debug(uint8_t level, char *format, ...) {
 192     va_list ap;
 193     if (level < debug_level)
 194         return;
 195     va_start(ap, format);
 196     debug_logit(level, format, ap);
 197     va_end(ap);
 198 }
 199
 200 void debugx(int status, uint8_t level, char *format, ...) {
 201     if (level >= debug_level) {
 202         va_list ap;
 203         va_start(ap, format);
 204         debug_logit(level, format, ap);
 205         va_end(ap);
 206     }
 207     exit(status);
 208 }
 209
 210 void debugerrno(int err, uint8_t level, char *format, ...) {
 211     if (level >= debug_level) {
 212         va_list ap;
 213         size_t len = strlen(format);
 214         char *tmp = malloc(len + 1024 + 2);
 215         assert(tmp);
 216         strcpy(tmp, format);
 217         tmp[len++] = ':';
 218         tmp[len++] = ' ';
 219         if (strerror_r(err, tmp + len, 1024))
 220             tmp = format;
 221         va_start(ap, format);
 222         debug_logit(level, tmp, ap);
 223         va_end(ap);
 224     }
 225 }
 226
 227 void debugerrnox(int err, uint8_t level, char *format, ...) {
 228     if (level >= debug_level) {
 229         va_list ap;
 230         va_start(ap, format);
 231         debugerrno(err, level, format, ap);
 232         va_end(ap);
 233     }
 234     exit(err);
 235 }
 236
 237 #if defined(WANT_FTICKS)
 238 void fticks_debug(const char *format, ...) {
 239     int priority;
 240     va_list ap;
 241     va_start(ap, format);
 242     if (!debug_syslogfacility && !fticks_syslogfacility)
 243         debug_logit(0xff, format, ap);
 244     else {
 245         priority = LOG_DEBUG|fticks_syslogfacility;
 246         vsyslog(priority, format, ap);
 247         va_end(ap);
 248     }
 249 }
 250 #endif
 251 /* Local Variables: */
 252 /* c-file-style: "stroustrup" */
 253 /* End: */