17eb374212ab4395fe6bb3001b713ba66fd710fd
[olsrd.git] / src / olsr_logging.c
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004-2009, the olsr.org team - see HISTORY file
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  *
11  * * Redistributions of source code must retain the above copyright
12  *   notice, this list of conditions and the following disclaimer.
13  * * Redistributions in binary form must reproduce the above copyright
14  *   notice, this list of conditions and the following disclaimer in
15  *   the documentation and/or other materials provided with the
16  *   distribution.
17  * * Neither the name of olsr.org, olsrd nor the names of its
18  *   contributors may be used to endorse or promote products derived
19  *   from this software without specific prior written permission.
20  *
21  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
22  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
23  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
24  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
25  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
26  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
27  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
28  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
29  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
31  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
32  * POSSIBILITY OF SUCH DAMAGE.
33  *
34  * Visit http://www.olsr.org for more information.
35  *
36  * If you find this software useful feel free to make a donation
37  * to the project. For more information see the website or contact
38  * the copyright holders.
39  *
40  */
41
42 #include <assert.h>
43 #include <stdarg.h>
44 #include <stdio.h>
45 #include <string.h>
46 #include <time.h>
47
48 #include "olsr_cfg.h"
49 #include "olsr_cfg_data.h"
50 #include "olsr_logging.h"
51 #include "os_system.h"
52 #include "os_time.h"
53
54 struct log_handler_entry {
55   void (*handler)
56     (enum log_severity, enum log_source, bool, const char *, int, char *, int, int);
57     bool(*bitmask)[LOG_SEVERITY_COUNT][LOG_SOURCE_COUNT];
58 };
59
60 bool log_global_mask[LOG_SEVERITY_COUNT][LOG_SOURCE_COUNT];
61
62 static struct log_handler_entry log_handler[MAX_LOG_HANDLER];
63 static int log_handler_count = 0;
64
65
66 static bool log_initialized = false;
67 static FILE *log_fileoutput = NULL;
68
69 static void olsr_log_stderr(enum log_severity severity, enum log_source source,
70                             bool no_header, const char *file, int line, char *buffer,
71                             int timeLength, int prefixLength);
72 static void olsr_log_syslog(enum log_severity severity, enum log_source source,
73                             bool no_header, const char *file, int line, char *buffer,
74                             int timeLength, int prefixLength);
75 static void olsr_log_file(enum log_severity severity, enum log_source source,
76                           bool no_header, const char *file, int line, char *buffer,
77                           int timeLength, int prefixLength);
78
79 /**
80  * Called by main method just after configuration options have been parsed
81  */
82 void
83 olsr_log_init(void)
84 {
85   char error[256];
86   bool printError = false;
87   int i, j;
88
89   /* clear global mask */
90   for (j = 0; j < LOG_SEVERITY_COUNT; j++) {
91     for (i = 0; i < LOG_SOURCE_COUNT; i++) {
92       log_global_mask[j][i] = false;
93     }
94   }
95
96   if (olsr_cnf->log_target_file) {
97     log_fileoutput = fopen(olsr_cnf->log_target_file, "a");
98     if (log_fileoutput) {
99       olsr_log_addhandler(&olsr_log_file, NULL);
100     } else {
101       /* handle file error for logging output */
102       bool otherLog = olsr_cnf->log_target_stderr || olsr_cnf->log_target_syslog;
103
104       /* delay output of error until other loggers are initialized */
105       snprintf(error, sizeof(error), "Cannot open log output file %s. %s\n",
106                olsr_cnf->log_target_file, otherLog ? "" : "Falling back to stderr logging.");
107       printError = true;
108
109       /* activate stderr logger if no other logger is chosen by user */
110       if (!otherLog) {
111         olsr_cnf->log_target_stderr = true;
112       }
113     }
114   }
115   if (olsr_cnf->log_target_syslog) {
116     olsr_log_addhandler(&olsr_log_syslog, NULL);
117   }
118   if (olsr_cnf->log_target_stderr) {
119     olsr_log_addhandler(&olsr_log_stderr, NULL);
120   }
121   log_initialized = true;
122
123   if (printError) {
124     OLSR_WARN(LOG_LOGGING, "%s", error);
125   } else {
126     OLSR_INFO(LOG_LOGGING, "Initialized Logger...\n");
127   }
128 }
129
130 /**
131  * Called just before olsr_shutdown finishes
132  */
133 void
134 olsr_log_cleanup(void)
135 {
136   if (log_fileoutput) {
137     fflush(log_fileoutput);
138     fclose(log_fileoutput);
139   }
140 }
141
142 /**
143  * Call this function to register a custom logevent handler
144  * @param handler pointer to handler function
145  * @param mask pointer to custom event filter or NULL if handler use filter
146  *   from olsr_cnf
147  */
148 void
149 olsr_log_addhandler(void (*handler) (enum log_severity, enum log_source, bool,
150                                      const char *, int, char *, int, int),
151                     bool(*mask)[LOG_SEVERITY_COUNT][LOG_SOURCE_COUNT])
152 {
153
154   assert(log_handler_count < MAX_LOG_HANDLER);
155
156   log_handler[log_handler_count].handler = handler;
157   log_handler[log_handler_count].bitmask = mask;
158   log_handler_count++;
159
160   olsr_log_updatemask();
161 }
162
163 /**
164  * Call this function to remove a logevent handler
165  * @param handler pointer to handler function
166  */
167 void
168 olsr_log_removehandler(void (*handler) (enum log_severity, enum log_source, bool, const char *, int, char *, int, int))
169 {
170   int i;
171   for (i = 0; i < log_handler_count; i++) {
172     if (handler == log_handler[i].handler) {
173       if (i < log_handler_count - 1) {
174         memmove(&log_handler[i], &log_handler[i + 1], (log_handler_count - i - 1) * sizeof(*log_handler));
175       }
176       log_handler_count--;
177     }
178   }
179
180   olsr_log_updatemask();
181 }
182
183 /**
184  * Recalculate the combination of the olsr_cnf log event mask and all (if any)
185  * custom masks of logfile handlers. Must be called every times a event mask
186  * changes.
187  */
188 void
189 olsr_log_updatemask(void)
190 {
191   int i, j, k;
192
193   for (k = 0; k < LOG_SEVERITY_COUNT; k++) {
194     for (j = 0; j < LOG_SOURCE_COUNT; j++) {
195       log_global_mask[k][j] = olsr_cnf->log_event[k][j];
196
197       for (i = 0; i < log_handler_count; i++) {
198         if (log_handler[i].bitmask != NULL && (*(log_handler[i].bitmask))[k][j]) {
199           log_global_mask[k][j] = true;
200           break;
201         }
202       }
203     }
204   }
205 }
206
207 /**
208  * This function should not be called directly, use the macros OLSR_{DEBUG,INFO,WARN,ERROR} !
209  *
210  * Generates a logfile entry and calls all log handler to store/output it.
211  *
212  * @param severity severity of the log event (LOG_DEBUG to LOG_ERROR)
213  * @param source source of the log event (LOG_LOGGING, ... )
214  * @param file filename where the logging macro have been called
215  * @param line line number where the logging macro have been called
216  * @param format printf format string for log output plus a variable number of arguments
217  */
218 void
219 olsr_log(enum log_severity severity, enum log_source source, bool no_header, const char *file, int line, const char *format, ...)
220 {
221   static char logbuffer[LOGBUFFER_SIZE];
222   va_list ap;
223   int p1 = 0, p2 = 0, p3 = 0, i;
224   struct tm now, *tm_ptr;
225   struct timeval timeval;
226
227   /* test if event is consumed by any log handler */
228   if (!log_global_mask[severity][source])
229     return;                     /* no log handler is interested in this event, so drop it */
230
231   va_start(ap, format);
232
233   /* calculate local time */
234   os_gettimeofday(&timeval, NULL);
235
236   /* there is no localtime_r in win32 */
237   tm_ptr = localtime((time_t *) & timeval.tv_sec);
238   now = *tm_ptr;
239
240   /* generate log string (insert file/line in DEBUG mode) */
241   if (!no_header) {
242     p1 = snprintf(logbuffer, LOGBUFFER_SIZE, "%d:%02d:%02d.%03ld ",
243                   now.tm_hour, now.tm_min, now.tm_sec, (long)(timeval.tv_usec / 1000));
244
245     p2 = snprintf(&logbuffer[p1], LOGBUFFER_SIZE - p1, "%s(%s) %s %d: ",
246         LOG_SEVERITY_NAMES[severity], LOG_SOURCE_NAMES[source], file, line);
247   }
248   p3 = vsnprintf(&logbuffer[p1+p2], LOGBUFFER_SIZE - p1 - p2, format, ap);
249
250   assert(p1 + p2 +p3 < LOGBUFFER_SIZE);
251
252   /* remove \n at the end of the line if necessary */
253   if (logbuffer[p1 + p2 + p3 - 1] == '\n') {
254     logbuffer[p1 + p2 + p3 - 1] = 0;
255     p3--;
256   }
257
258   /* output all events to stderr if logsystem has not been initialized */
259   if (!log_initialized) {
260 #if DEBUG
261     fputs(logbuffer, stderr);
262 #endif
263     return;
264   }
265
266   /* call all log handlers */
267   for (i = 0; i < log_handler_count; i++) {
268     log_handler[i].handler(severity, source, no_header, file, line, logbuffer, p1, p2-p1);
269   }
270   va_end(ap);
271 }
272
273 static void
274 olsr_log_stderr(enum log_severity severity, enum log_source source,
275                 bool no_header __attribute__ ((unused)),
276                 const char *file __attribute__ ((unused)), int line __attribute__ ((unused)),
277                 char *buffer,
278                 int timeLength __attribute__ ((unused)),
279                 int prefixLength __attribute__ ((unused)))
280 {
281   if (olsr_cnf->log_event[severity][source]) {
282     fprintf(stderr, "%s\n", buffer);
283   }
284 }
285
286 static void
287 olsr_log_file(enum log_severity severity, enum log_source source,
288               bool no_header __attribute__ ((unused)),
289               const char *file __attribute__ ((unused)), int line __attribute__ ((unused)),
290               char *buffer,
291               int timeLength __attribute__ ((unused)),
292               int prefixLength __attribute__ ((unused)))
293 {
294   if (olsr_cnf->log_event[severity][source]) {
295     fprintf(log_fileoutput, "%s\n", buffer);
296   }
297 }
298
299 static void
300 olsr_log_syslog(enum log_severity severity, enum log_source source,
301                 bool no_header __attribute__ ((unused)),
302                 const char *file __attribute__ ((unused)), int line __attribute__ ((unused)),
303                 char *buffer, int timeLength,
304                 int prefixLength __attribute__ ((unused)))
305 {
306   if (olsr_cnf->log_event[severity][source]) {
307     os_printline(severity, &buffer[timeLength]);
308   }
309 }