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