1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
|
/*
* Copyright (c) 2017, The OpenThread Authors.
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* 2. Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* 3. Neither the name of the copyright holder nor the
* names of its contributors may be used to endorse or promote products
* derived from this software without specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/
/**
* @file
* This file define logging interface.
*/
#ifndef OTBR_COMMON_LOGGING_HPP_
#define OTBR_COMMON_LOGGING_HPP_
#include "openthread-br/config.h"
#include <stdarg.h>
#include <stddef.h>
#ifndef OTBR_LOG_TAG
#error "OTBR_LOG_TAG is not defined"
#endif
#include "common/types.hpp"
/**
* Logging level.
*
*/
typedef enum
{
OTBR_LOG_EMERG, ///< System is unusable
OTBR_LOG_ALERT, ///< Action must be taken immediately
OTBR_LOG_CRIT, ///< Critical conditions
OTBR_LOG_ERR, ///< Error conditions
OTBR_LOG_WARNING, ///< Warning conditions
OTBR_LOG_NOTICE, ///< Normal but significant condition
OTBR_LOG_INFO, ///< Informational
OTBR_LOG_DEBUG, ///< Debug level messages
} otbrLogLevel;
/**
* Get current log level.
*/
otbrLogLevel otbrLogGetLevel(void);
/**
* Set current log level.
*/
void otbrLogSetLevel(otbrLogLevel aLevel);
/**
* Control log to syslog.
*
* @param[in] enable True to log to/via syslog.
*
*/
void otbrLogEnableSyslog(bool aEnabled);
/**
* This function initialize the logging service.
*
* @param[in] aIdent Identity of the logger.
* @param[in] aLevel Log level of the logger.
* @param[in] aPrintStderr Whether to log to stderr.
*
*/
void otbrLogInit(const char *aIdent, otbrLogLevel aLevel, bool aPrintStderr);
/**
* This function log at level @p aLevel.
*
* @param[in] aLevel Log level of the logger.
* @param[in] aLogTag Log tag.
* @param[in] aFormat Format string as in printf.
*
*/
void otbrLog(otbrLogLevel aLevel, const char *aLogTag, const char *aFormat, ...);
/**
* This function log at level @p aLevel.
*
* @param[in] aLevel Log level of the logger.
* @param[in] aFormat Format string as in printf.
* @param[in] aArgList The variable-length arguments list.
*
*/
void otbrLogv(otbrLogLevel aLevel, const char *aFormat, va_list aArgList);
/**
* This function writes logs without filtering with the log level.
*
* @param[in] aLevel Log level of the logger.
* @param[in] aFormat Format string as in printf.
* @param[in] aArgList The variable-length arguments list.
*
*/
void otbrLogvNoFilter(otbrLogLevel aLevel, const char *aFormat, va_list aArgList);
/**
* This function dump memory as hex string at level @p aLevel.
*
* @param[in] aLevel Log level of the logger.
* @param[in] aLogTag Log tag.
* @param[in] aPrefix String before dumping memory.
* @param[in] aMemory The pointer to the memory to be dumped.
* @param[in] aSize The size of memory in bytes to be dumped.
*
*/
void otbrDump(otbrLogLevel aLevel, const char *aLogTag, const char *aPrefix, const void *aMemory, size_t aSize);
/**
* This function converts error code to string.
*
* @param[in] aError The error code.
*
* @returns The string information of error.
*
*/
const char *otbrErrorString(otbrError aError);
/**
* This function deinitializes the logging service.
*
*/
void otbrLogDeinit(void);
/**
* This macro log an action result according to @p aError.
*
* If @p aError is OTBR_ERROR_NONE, the log level will be OTBR_LOG_INFO,
* otherwise OTBR_LOG_WARNING.
*
* @param[in] aError The action result.
* @param[in] aFormat Format string as in printf.
* @param[in] ... Arguments for the format specification.
*
*/
#define otbrLogResult(aError, aFormat, ...) \
do \
{ \
otbrError _err = (aError); \
otbrLog(_err == OTBR_ERROR_NONE ? OTBR_LOG_INFO : OTBR_LOG_WARNING, OTBR_LOG_TAG, aFormat ": %s", \
##__VA_ARGS__, otbrErrorString(_err)); \
} while (0)
/**
* @def otbrLogEmerg
*
* Log at level emergency.
*
* @param[in] ... Arguments for the format specification.
*
*/
/**
* @def otbrLogAlert
*
* Log at level alert.
*
* @param[in] ... Arguments for the format specification.
*
*/
/**
* @def otbrLogCrit
*
* Log at level critical.
*
* @param[in] ... Arguments for the format specification.
*
*/
/**
* @def otbrLogErr
*
* Log at level error.
*
* @param[in] ... Arguments for the format specification.
*
*/
/**
* @def otbrLogWarning
*
* Log at level warning.
*
* @param[in] ... Arguments for the format specification.
*
*/
/**
* @def otbrLogNotice
*
* Log at level notice.
*
* @param[in] ... Arguments for the format specification.
*
*/
/**
* @def otbrLogInfo
*
* Log at level information.
*
* @param[in] ... Arguments for the format specification.
*
*/
/**
* @def otbrLogDebug
*
* Log at level debug.
*
* @param[in] ... Arguments for the format specification.
*
*/
#define otbrLogEmerg(...) otbrLog(OTBR_LOG_EMERG, OTBR_LOG_TAG, __VA_ARGS__)
#define otbrLogAlert(...) otbrLog(OTBR_LOG_ALERT, OTBR_LOG_TAG, __VA_ARGS__)
#define otbrLogCrit(...) otbrLog(OTBR_LOG_CRIT, OTBR_LOG_TAG, __VA_ARGS__)
#define otbrLogErr(...) otbrLog(OTBR_LOG_ERR, OTBR_LOG_TAG, __VA_ARGS__)
#define otbrLogWarning(...) otbrLog(OTBR_LOG_WARNING, OTBR_LOG_TAG, __VA_ARGS__)
#define otbrLogNotice(...) otbrLog(OTBR_LOG_NOTICE, OTBR_LOG_TAG, __VA_ARGS__)
#define otbrLogInfo(...) otbrLog(OTBR_LOG_INFO, OTBR_LOG_TAG, __VA_ARGS__)
#define otbrLogDebug(...) otbrLog(OTBR_LOG_DEBUG, OTBR_LOG_TAG, __VA_ARGS__)
#endif // OTBR_COMMON_LOGGING_HPP_
|
