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