Cleanup logging system so it can be used by the config parser
[olsrd.git] / src / olsr_logging.h
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 #ifndef OLSR_LOGGING_H_
43 #define OLSR_LOGGING_H_
44
45 #include "common/list.h"
46 #include "defs.h"
47 #include "olsr_types.h"
48 #include "olsr_cfg_data.h"
49
50 #define LOGBUFFER_SIZE 1024
51
52 /**
53  * defines the severity of a logging event
54  */
55 enum log_severity {
56   SEVERITY_DEBUG,                      //!< SEVERITY_DEBUG
57   SEVERITY_INFO,                       //!< SEVERITY_INFO
58   SEVERITY_WARN,                       //!< SEVERITY_WARN
59   SEVERITY_ERR,                        //!< SEVERITY_ERR
60
61   /* this one must be the last of the enums ! */
62   LOG_SEVERITY_COUNT                   //!< LOG_SEVERITY_COUNT
63 };
64
65 /**
66  * these four macros should be used to generate OLSR logging output
67  *
68  * OLSR_DEBUG should be used for all output that is only usefull for debugging a specific
69  * part of the code. This could be information about the internal progress of a function,
70  * state of variables, ...
71  *
72  * OLSR_INFO should be used for all output that does not inform the user about a
73  * problem/error in OLSR. Examples would be "SPF run triggered" or "Hello package received
74  * from XXX.XXX.XXX.XXX".
75  *
76  * OLSR_WARN should be used for all error messages that do not prevent OLSR from continue
77  * to work.
78  *
79  * OLSR_ERROR is reserved for error output to the user just before the OLSR agent will be
80  * terminated.
81  */
82 #ifdef REMOVE_LOG_DEBUG
83 #define OLSR_DEBUG(source, format, args...) do { } while(0)
84 #define OLSR_DEBUG_NH(source, format, args...) do { } while(0)
85 #else
86 #define OLSR_DEBUG(source, format, args...) do { if (log_global_mask[SEVERITY_DEBUG][source]) olsr_log(SEVERITY_DEBUG, source, false, __FILE__, __LINE__, format, ##args); } while(0)
87 #define OLSR_DEBUG_NH(source, format, args...) do { if (log_global_mask[SEVERITY_DEBUG][source]) olsr_log(SEVERITY_DEBUG, source, true, __FILE__, __LINE__, format, ##args); } while(0)
88 #endif
89
90 #ifdef REMOVE_LOG_INFO
91 #define OLSR_INFO(source, format, args...) do { } while(0)
92 #define OLSR_INFO_NH(source, format, args...) do { } while(0)
93 #else
94 #define OLSR_INFO(source, format, args...) do { if (log_global_mask[SEVERITY_INFO][source]) olsr_log(SEVERITY_INFO, source, false, __FILE__, __LINE__, format, ##args); } while(0)
95 #define OLSR_INFO_NH(source, format, args...) do { if (log_global_mask[SEVERITY_INFO][source]) olsr_log(SEVERITY_INFO, source, true, __FILE__, __LINE__, format, ##args); } while(0)
96 #endif
97
98 #ifdef REMOVE_LOG_WARN
99 #define OLSR_WARN(source, format, args...) do { } while(0)
100 #define OLSR_WARN_NH(source, format, args...) do { } while(0)
101 #else
102 #define OLSR_WARN(source, format, args...) do { if (log_global_mask[SEVERITY_WARN][source]) olsr_log(SEVERITY_WARN, source, false, __FILE__, __LINE__, format, ##args); } while(0)
103 #define OLSR_WARN_NH(source, format, args...) do { if (log_global_mask[SEVERITY_WARN][source]) olsr_log(SEVERITY_WARN, source, true, __FILE__, __LINE__, format, ##args); } while(0)
104 #endif
105
106 #ifdef REMOVE_LOG_ERROR
107 #define OLSR_ERROR(source, format, args...) do { } while(0)
108 #define OLSR_ERROR_NH(source, format, args...) do { } while(0)
109 #else
110 #define OLSR_ERROR(source, format, args...) do { if (log_global_mask[SEVERITY_ERR][source]) olsr_log(SEVERITY_ERR, source, false, __FILE__, __LINE__, format, ##args); } while(0)
111 #define OLSR_ERROR_NH(source, format, args...) do { if (log_global_mask[SEVERITY_ERR][source]) olsr_log(SEVERITY_ERR, source, true, __FILE__, __LINE__, format, ##args); } while(0)
112 #endif
113
114 struct log_handler_entry {
115   struct list_entity node;
116   void (*handler)(enum log_severity, enum log_source,
117       bool, const char *, int, char *, int, int);
118
119   /* pointer to handlers own bitmask */
120   bool(*bitmask_ptr)[LOG_SEVERITY_COUNT][LOG_SOURCE_COUNT];
121
122   /* internal bitmask copy */
123   bool int_bitmask[LOG_SEVERITY_COUNT][LOG_SOURCE_COUNT];
124 };
125
126 void EXPORT(olsr_log_init) (void);
127 void EXPORT(olsr_log_cleanup) (void);
128
129 void EXPORT(olsr_log_applyconfig) (void);
130
131 struct log_handler_entry * EXPORT(olsr_log_addhandler) (void (*handler) (enum log_severity, enum log_source, bool,
132                                                    const char *, int, char *, int, int),
133                                   bool(*mask)[LOG_SEVERITY_COUNT][LOG_SOURCE_COUNT]);
134 void EXPORT(olsr_log_removehandler) (struct log_handler_entry *);
135 void EXPORT(olsr_log_updatemask) (void);
136
137 void EXPORT(olsr_log) (enum log_severity, enum log_source, bool, const char *, int, const char *, ...)
138   __attribute__ ((format(printf, 6, 7)));
139
140 extern bool EXPORT(log_global_mask)[LOG_SEVERITY_COUNT][LOG_SOURCE_COUNT];
141
142 #endif /* OLSR_LOGGING_H_ */