route get/set working, remotecontrol plugin updated
[oonf.git] / src / core / olsr_logging.h
1
2 /*
3  * The olsr.org Optimized Link-State Routing daemon(olsrd)
4  * Copyright (c) 2004-2011, 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 #ifndef OLSR_LOGGING_H_
43 #define OLSR_LOGGING_H_
44
45 struct log_handler_entry;
46
47 #include "stdlib.h"
48 #include "string.h"
49
50 #include "common/common_types.h"
51 #include "common/autobuf.h"
52 #include "common/list.h"
53 #include "builddata/data.h"
54
55 /**
56  * defines the severity of a logging event
57  */
58 enum log_severity {
59   SEVERITY_DEBUG,                      //!< SEVERITY_DEBUG
60   SEVERITY_INFO,                       //!< SEVERITY_INFO
61   SEVERITY_WARN,                       //!< SEVERITY_WARN
62
63   /* this one must be the last of the enums ! */
64   LOG_SEVERITY_COUNT                   //!< LOG_SEVERITY_COUNT
65 };
66
67 /*
68  * Defines the source of a logging event.
69  * Keep this in the same order as the log_source and
70  * log_severity enums (see olsr_logging_sources.h).
71  */
72 enum log_source {
73   LOG_ALL,
74   LOG_LOGGING,
75   LOG_CONFIG,
76   LOG_MAIN,
77   LOG_SOCKET,
78   LOG_TIMER,
79   LOG_MEMCOOKIE,
80   LOG_SOCKET_STREAM,
81   LOG_SOCKET_PACKET,
82   LOG_INTERFACE,
83   LOG_OS_NET,
84   LOG_OS_SYSTEM,
85   LOG_OS_ROUTING,
86   LOG_PLUGINLOADER,
87   LOG_TELNET,
88   LOG_PLUGINS,
89   LOG_HTTP,
90
91   /* this one must be the last of the enums ! */
92   LOG_CORESOURCE_COUNT
93 };
94
95 struct log_parameters {
96   enum log_severity severity;
97   enum log_source source;
98   bool no_header;
99   const char *file;
100   int line;
101   char *buffer;
102   int timeLength;
103   int prefixLength;
104 };
105
106 /**
107  * these four macros should be used to generate OLSR logging output
108  *
109  * OLSR_DEBUG should be used for all output that is only usefull for debugging a specific
110  * part of the code. This could be information about the internal progress of a function,
111  * state of variables, ...
112  *
113  * OLSR_INFO should be used for all output that does not inform the user about a
114  * problem/error in OLSR. Examples would be "SPF run triggered" or "Hello package received
115  * from XXX.XXX.XXX.XXX".
116  *
117  * OLSR_WARN should be used for all error messages.
118  *
119  * OLSR_WARN_OOM should be called in an out-of-memory event to display some warning
120  * without allocating more memory.
121  */
122
123 #define _OLSR_LOG(severity, source, no_header, format, args...) do { if (log_global_mask[source].log_for_severity[severity]) olsr_log(severity, source, no_header, __FILE__, __LINE__, format, ##args); } while(0)
124
125 #ifdef REMOVE_LOG_DEBUG
126 #define OLSR_DEBUG(source, format, args...) do { } while(0)
127 #define OLSR_DEBUG_NH(source, format, args...) do { } while(0)
128 #else
129 #define OLSR_DEBUG(source, format, args...) _OLSR_LOG(SEVERITY_DEBUG, source, false, format, ##args)
130 #define OLSR_DEBUG_NH(source, format, args...) _OLSR_LOG(SEVERITY_DEBUG, source, true, format, ##args)
131 #endif
132
133 #ifdef REMOVE_LOG_INFO
134 #define OLSR_INFO(source, format, args...) do { } while(0)
135 #define OLSR_INFO_NH(source, format, args...) do { } while(0)
136 #else
137 #define OLSR_INFO(source, format, args...) _OLSR_LOG(SEVERITY_INFO, source, false, format, ##args)
138 #define OLSR_INFO_NH(source, format, args...) _OLSR_LOG(SEVERITY_INFO, source, true, format, ##args)
139 #endif
140
141 #ifdef REMOVE_LOG_WARN
142 #define OLSR_WARN(source, format, args...) do { } while(0)
143 #define OLSR_WARN_NH(source, format, args...) do { } while(0)
144
145 #define OLSR_WARN_OOM(source) do { } while(0)
146 #else
147 #define OLSR_WARN(source, format, args...) _OLSR_LOG(SEVERITY_WARN, source, false, format, ##args)
148 #define OLSR_WARN_NH(source, format, args...) _OLSR_LOG(SEVERITY_WARN, source, true, format, ##args)
149
150 #define OLSR_WARN_OOM(source) do { if (log_global_mask[source].log_for_severity[SEVERITY_WARN]) olsr_log_oom(SEVERITY_WARN, source, __FILE__, __LINE__); } while(0)
151 #endif
152
153 typedef void log_handler_cb(struct log_handler_entry *, struct log_parameters *);
154
155 struct log_handler_mask_entry {
156   bool log_for_severity[LOG_SEVERITY_COUNT];
157 };
158
159 struct log_handler_entry {
160   struct list_entity node;
161   log_handler_cb *handler;
162
163   /* pointer to handlers own bitmask */
164   struct log_handler_mask_entry *bitmask;
165
166   /* internal bitmask copy */
167   struct log_handler_mask_entry *int_bitmask;
168
169   /* custom pointer for log handler */
170   void *custom;
171 };
172
173 EXPORT extern struct log_handler_mask_entry *log_global_mask;
174 EXPORT extern const char **LOG_SOURCE_NAMES;
175 EXPORT extern const char *LOG_SEVERITY_NAMES[];
176
177 EXPORT int olsr_log_init(const struct olsr_builddata *, enum log_severity,
178     const char **lognames, size_t level_count)
179   __attribute__((warn_unused_result));
180 EXPORT void olsr_log_cleanup(void);
181
182 EXPORT void olsr_log_addhandler(struct log_handler_entry *);
183 EXPORT void olsr_log_removehandler(struct log_handler_entry *);
184 EXPORT void olsr_log_updatemask(void);
185
186 EXPORT enum log_source olsr_log_get_sourcecount(void);
187 EXPORT const struct olsr_builddata *olsr_log_get_builddata(void);
188 EXPORT void olsr_log_printversion(struct autobuf *abuf);
189
190 EXPORT void olsr_log(enum log_severity, enum log_source, bool, const char *, int, const char *, ...)
191   __attribute__ ((format(printf, 6, 7)));
192
193 EXPORT void olsr_log_oom(enum log_severity, enum log_source, const char *, int);
194
195 EXPORT void olsr_log_stderr(struct log_handler_entry *,
196     struct log_parameters *);
197 EXPORT void olsr_log_syslog(struct log_handler_entry *,
198     struct log_parameters *);
199 EXPORT void olsr_log_file(struct log_handler_entry *,
200     struct log_parameters *);
201
202 /**
203  * Allocates an empty logging mask.
204  * @return pointer to logging mask, NULL if not enough memory
205  */
206 static INLINE struct log_handler_mask_entry *
207 olsr_log_allocate_mask(void) {
208   return calloc(olsr_log_get_sourcecount(), sizeof(struct log_handler_mask_entry));
209 }
210
211 /**
212  * Free the memory of an allocated logging mask.
213  * @param mask pointer to mask
214  */
215 static INLINE void
216 olsr_log_free_mask(struct log_handler_mask_entry *mask) {
217   free(mask);
218 }
219
220 /**
221  * Copies a logging mask
222  * @param dst destination logging mask
223  * @param src source logging mask
224  */
225 static INLINE void
226 olsr_log_copy_mask(struct log_handler_mask_entry *dst, struct log_handler_mask_entry *src) {
227   memcpy(dst, src, sizeof(struct log_handler_mask_entry) * olsr_log_get_sourcecount());
228 }
229
230 /**
231  * Clears a logging mask
232  * @param mask logging mask to be cleared
233  */
234 static INLINE void
235 olsr_log_clear_mask(struct log_handler_mask_entry *mask) {
236   memset(mask, 0, sizeof(struct log_handler_mask_entry) * olsr_log_get_sourcecount());
237 }
238
239 #endif /* OLSR_LOGGING_H_ */