c65a613de5f1d49201f8c5c3008493687a01b5cb
[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 #include <sys/time.h>
48
49 #include "olsr_cfg.h"
50 #include "olsr_cfg_data.h"
51 #include "olsr_logging.h"
52 #include "log.h"
53
54 struct log_handler_entry {
55   void (*handler)
56     (enum log_severity, enum log_source, bool, const char *, int, char *, int);
57     bool(*bitmask)[LOG_SEVERITY_COUNT][LOG_SOURCE_COUNT];
58 };
59
60 static struct log_handler_entry log_handler[MAX_LOG_HANDLER];
61 static int log_handler_count = 0;
62
63 static bool log_global_mask[LOG_SEVERITY_COUNT][LOG_SOURCE_COUNT];
64
65 static bool log_initialized = false;
66 static FILE *log_fileoutput = NULL;
67
68 static void olsr_log_stderr(enum log_severity severity, enum log_source source,
69                             bool no_header, const char *file, int line, char *buffer, int prefixLength);
70 static void olsr_log_syslog(enum log_severity severity, enum log_source source,
71                             bool no_header, const char *file, int line, char *buffer, int prefixLength);
72 static void olsr_log_file(enum log_severity severity, enum log_source source,
73                           bool no_header, const char *file, int line, char *buffer, int prefixLength);
74
75 /**
76  * Called by main method just after configuration options have been parsed
77  */
78 void
79 olsr_log_init(void)
80 {
81   char error[256];
82   bool printError = false;
83   int i, j;
84
85   /* clear global mask */
86   for (j = 0; j < LOG_SEVERITY_COUNT; j++) {
87     for (i = 0; i < LOG_SOURCE_COUNT; i++) {
88       log_global_mask[j][i] = false;
89     }
90   }
91
92   if (olsr_cnf->log_target_file) {
93     log_fileoutput = fopen(olsr_cnf->log_target_file, "a");
94     if (log_fileoutput) {
95       olsr_log_addhandler(&olsr_log_file, NULL);
96     } else {
97       /* handle file error for logging output */
98       bool otherLog = olsr_cnf->log_target_stderr || olsr_cnf->log_target_syslog;
99
100       /* delay output of error until other loggers are initialized */
101       snprintf(error, sizeof(error), "Cannot open log output file %s. %s\n",
102                olsr_cnf->log_target_file, otherLog ? "" : "Falling back to stderr logging.");
103       printError = true;
104
105       /* activate stderr logger if no other logger is chosen by user */
106       if (!otherLog) {
107         olsr_cnf->log_target_stderr = true;
108       }
109     }
110   }
111   if (olsr_cnf->log_target_syslog) {
112     olsr_open_syslog("olsrd");
113     olsr_log_addhandler(&olsr_log_syslog, NULL);
114   }
115   if (olsr_cnf->log_target_stderr) {
116     olsr_log_addhandler(&olsr_log_stderr, NULL);
117   }
118   log_initialized = true;
119
120   if (printError) {
121     OLSR_WARN(LOG_LOGGING, "%s", error);
122   } else {
123     OLSR_INFO(LOG_LOGGING, "Initialized Logger...\n");
124   }
125 }
126
127 /**
128  * Called just before olsr_shutdown finishes
129  */
130 void
131 olsr_log_cleanup(void)
132 {
133   if (log_fileoutput) {
134     fflush(log_fileoutput);
135     fclose(log_fileoutput);
136   }
137 }
138
139 /**
140  * Call this function to register a custom logevent handler
141  * @param handler pointer to handler function
142  * @param mask pointer to custom event filter or NULL if handler use filter
143  *   from olsr_cnf
144  */
145 void
146 olsr_log_addhandler(void (*handler) (enum log_severity, enum log_source, bool,
147                                      const char *, int, char *, int), bool(*mask)[LOG_SEVERITY_COUNT][LOG_SOURCE_COUNT])
148 {
149
150   assert(log_handler_count < MAX_LOG_HANDLER);
151
152   log_handler[log_handler_count].handler = handler;
153   log_handler[log_handler_count].bitmask = mask;
154   log_handler_count++;
155
156   olsr_log_updatemask();
157 }
158
159 /**
160  * Call this function to remove a logevent handler
161  * @param handler pointer to handler function
162  */
163 void
164 olsr_log_removehandler(void (*handler) (enum log_severity, enum log_source, bool, const char *, int, char *, int))
165 {
166   int i;
167   for (i = 0; i < log_handler_count; i++) {
168     if (handler == log_handler[i].handler) {
169       if (i < log_handler_count - 1) {
170         memmove(&log_handler[i], &log_handler[i + 1], (log_handler_count - i - 1) * sizeof(*log_handler));
171       }
172       log_handler_count--;
173     }
174   }
175
176   olsr_log_updatemask();
177 }
178
179 /**
180  * Recalculate the combination of the olsr_cnf log event mask and all (if any)
181  * custom masks of logfile handlers. Must be called every times a event mask
182  * changes.
183  */
184 void
185 olsr_log_updatemask(void)
186 {
187   int i, j, k;
188
189   for (k = 0; k < LOG_SEVERITY_COUNT; k++) {
190     for (j = 0; j < LOG_SOURCE_COUNT; j++) {
191       log_global_mask[k][j] = olsr_cnf->log_event[k][j];
192
193       for (i = 0; i < log_handler_count; i++) {
194         if (log_handler[i].bitmask != NULL && (*(log_handler[i].bitmask))[k][j]) {
195           log_global_mask[k][j] = true;
196           break;
197         }
198       }
199     }
200   }
201 }
202
203 /**
204  * This function should not be called directly, use the macros OLSR_{DEBUG,INFO,WARN,ERROR} !
205  *
206  * Generates a logfile entry and calls all log handler to store/output it.
207  *
208  * @param severity severity of the log event (LOG_DEBUG to LOG_ERROR)
209  * @param source source of the log event (LOG_LOGGING, ... )
210  * @param file filename where the logging macro have been called
211  * @param line line number where the logging macro have been called
212  * @param format printf format string for log output plus a variable number of arguments
213  */
214 void
215 olsr_log(enum log_severity severity, enum log_source source, bool no_header, const char *file, int line, const char *format, ...)
216 {
217   static char logbuffer[LOGBUFFER_SIZE];
218   va_list ap;
219   int p1 = 0, p2 = 0, i;
220   struct tm now, *tm_ptr;
221   struct timeval timeval;
222
223   /* test if event is consumed by any log handler */
224   if (!log_global_mask[severity][source])
225     return;                     /* no log handler is interested in this event, so drop it */
226
227   va_start(ap, format);
228
229   /* calculate local time */
230   gettimeofday(&timeval, NULL);
231
232   /* there is no localtime_r in win32 */
233   tm_ptr = localtime((time_t *) & timeval.tv_sec);
234   now = *tm_ptr;
235
236   /* generate log string (insert file/line in DEBUG mode) */
237   if (!no_header) {
238     p1 = snprintf(logbuffer, LOGBUFFER_SIZE, "%d:%02d:%02d.%03ld %s(%s) %s %d: ",
239                   now.tm_hour, now.tm_min, now.tm_sec, (long)(timeval.tv_usec / 1000),
240                   LOG_SEVERITY_NAMES[severity], LOG_SOURCE_NAMES[source], file, line);
241   }
242   p2 = vsnprintf(&logbuffer[p1], LOGBUFFER_SIZE - p1, format, ap);
243
244   assert(p1 + p2 < LOGBUFFER_SIZE);
245
246   /* remove \n at the end of the line if necessary */
247   if (logbuffer[p1 + p2 - 1] == '\n') {
248     logbuffer[p1 + p2 - 1] = 0;
249     p2--;
250   }
251
252   /* output all events to stderr if logsystem has not been initialized */
253   if (!log_initialized) {
254 #if DEBUG
255     fputs(logbuffer, stderr);
256 #endif
257     return;
258   }
259
260   /* call all log handlers */
261   for (i = 0; i < log_handler_count; i++) {
262     log_handler[i].handler(severity, source, no_header, file, line, logbuffer, p1);
263   }
264   va_end(ap);
265 }
266
267 static void
268 olsr_log_stderr(enum log_severity severity, enum log_source source,
269                 bool no_header __attribute__ ((unused)),
270                 const char *file __attribute__ ((unused)), int line __attribute__ ((unused)),
271                 char *buffer, int prefixLength __attribute__ ((unused)))
272 {
273   if (olsr_cnf->log_event[severity][source]) {
274     fprintf(stderr, "%s\n", buffer);
275   }
276 }
277
278 static void
279 olsr_log_file(enum log_severity severity, enum log_source source,
280               bool no_header __attribute__ ((unused)),
281               const char *file __attribute__ ((unused)), int line __attribute__ ((unused)),
282               char *buffer, int prefixLength __attribute__ ((unused)))
283 {
284   if (olsr_cnf->log_event[severity][source]) {
285     fprintf(log_fileoutput, "%s\n", buffer);
286   }
287 }
288
289 static void
290 olsr_log_syslog(enum log_severity severity, enum log_source source,
291                 bool no_header __attribute__ ((unused)),
292                 const char *file __attribute__ ((unused)), int line __attribute__ ((unused)),
293                 char *buffer, int prefixLength __attribute__ ((unused)))
294 {
295   if (olsr_cnf->log_event[severity][source]) {
296     olsr_print_syslog(severity, "%s\n", buffer);
297   }
298 }