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