/
Log.h
428 lines (369 loc) · 14.8 KB
/
Log.h
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
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
/*
* Log.h
*
* Created on: 2013-2-1
* Author: fasiondog
*/
#pragma once
#ifndef HIKUU_LOG_H_
#define HIKUU_LOG_H_
#ifndef NOMINMAX
#define NOMINMAX
#endif
#include "config.h"
#include "exception.h"
// clang-format off
#if USE_SPDLOG_LOGGER
#include <spdlog/spdlog.h>
#include <spdlog/fmt/ostr.h>
#if HKU_USE_SPDLOG_ASYNC_LOGGER
#include "spdlog/async.h"
#endif
#endif
// clang-format on
#include <fmt/ostream.h>
#include <fmt/format.h>
#include <fmt/chrono.h>
#ifndef HKU_API
#define HKU_API
#endif
namespace hku {
/**
* @ingroup Utilities
* @addtogroup logging Logging tools 日志工具
* @details 打印等级:
* TRACE < DEBUG < INFO < WARN < ERROR < FATAL
* @{
*/
bool HKU_API isLogInMainThread();
void HKU_API increaseIORedicrectToPythonCount();
void HKU_API decreaseIORedicrectToPythonCount();
int HKU_API getIORedirectToPythonCount();
/**********************************************
* Use SPDLOG for logging
*********************************************/
#if USE_SPDLOG_LOGGER
/** 日志级别 */
enum LOG_LEVEL {
TRACE = SPDLOG_LEVEL_TRACE, ///< 跟踪
DEBUG = SPDLOG_LEVEL_DEBUG, ///< 调试
INFO = SPDLOG_LEVEL_INFO, ///< 一般信息
WARN = SPDLOG_LEVEL_WARN, ///< 告警
ERROR = SPDLOG_LEVEL_ERROR, ///< 错误
FATAL = SPDLOG_LEVEL_CRITICAL, ///< 致命
OFF = SPDLOG_LEVEL_OFF, ///< 关闭日志打印
};
/**
* 获取当前日志级别
* @return
*/
LOG_LEVEL HKU_API get_log_level();
/**
* 设置日志级别
* @param level 指定的日志级别
*/
void HKU_API set_log_level(LOG_LEVEL level);
std::shared_ptr<spdlog::logger> HKU_API getHikyuuLogger();
/*#define HKU_TRACE(...) SPDLOG_LOGGER_TRACE(hku::getHikyuuLogger(), __VA_ARGS__)
#define HKU_DEBUG(...) SPDLOG_LOGGER_DEBUG(hku::getHikyuuLogger(), __VA_ARGS__)
#define HKU_INFO(...) SPDLOG_LOGGER_INFO(hku::getHikyuuLogger(), __VA_ARGS__)
#define HKU_WARN(...) SPDLOG_LOGGER_WARN(hku::getHikyuuLogger(), __VA_ARGS__)
#define HKU_ERROR(...) SPDLOG_LOGGER_ERROR(hku::getHikyuuLogger(), __VA_ARGS__)
#define HKU_FATAL(...) SPDLOG_LOGGER_CRITICAL(hku::getHikyuuLogger(), __VA_ARGS__)*/
#define HKU_TRACE(...) \
do { \
if (isLogInMainThread() || getIORedirectToPythonCount() <= 0) { \
SPDLOG_LOGGER_TRACE(hku::getHikyuuLogger(), __VA_ARGS__); \
} \
} while (0)
#define HKU_DEBUG(...) \
do { \
if (isLogInMainThread() || getIORedirectToPythonCount() <= 0) { \
SPDLOG_LOGGER_DEBUG(hku::getHikyuuLogger(), __VA_ARGS__); \
} \
} while (0)
#define HKU_INFO(...) \
do { \
if (isLogInMainThread() || getIORedirectToPythonCount() <= 0) { \
SPDLOG_LOGGER_INFO(hku::getHikyuuLogger(), __VA_ARGS__); \
} \
} while (0)
#define HKU_WARN(...) \
do { \
if (isLogInMainThread() || getIORedirectToPythonCount() <= 0) { \
SPDLOG_LOGGER_WARN(hku::getHikyuuLogger(), __VA_ARGS__); \
} \
} while (0)
#define HKU_ERROR(...) \
do { \
if (isLogInMainThread() || getIORedirectToPythonCount() <= 0) { \
SPDLOG_LOGGER_ERROR(hku::getHikyuuLogger(), __VA_ARGS__); \
} \
} while (0)
#define HKU_FATAL(...) \
do { \
if (isLogInMainThread() || getIORedirectToPythonCount() <= 0) { \
SPDLOG_LOGGER_CRITICAL(hku::getHikyuuLogger(), __VA_ARGS__); \
} \
} while (0)
#if HKU_USE_SPDLOG_ASYNC_LOGGER
void initLogger();
#else
void initLogger();
#endif
#else
enum LOG_LEVEL {
TRACE = 0,
DEBUG = 1,
INFO = 2,
WARN = 3,
ERROR = 4,
FATAL = 5,
OFF = 6,
};
LOG_LEVEL HKU_API get_log_level();
void HKU_API set_log_level(LOG_LEVEL level);
void initLogger();
/** 获取系统当前时间,精确到毫秒,如:2001-01-02 13:01:02.001 */
std::string HKU_API getLocalTime();
#if LOG_ACTIVE_LEVEL <= 0
#define HKU_TRACE(...) \
fmt::print("[{}] [HKU-T] - {} ({}:{})\n", getLocalTime(), fmt::format(__VA_ARGS__), __FILE__, \
__LINE__);
#else
#define HKU_TRACE(...)
#endif
#if LOG_ACTIVE_LEVEL <= 1
#define HKU_DEBUG(...) \
fmt::print("[{}] [HKU-D] - {} ({}:{})\n", getLocalTime(), fmt::format(__VA_ARGS__), __FILE__, \
__LINE__);
#else
#define HKU_DEBUG(...)
#endif
#if LOG_ACTIVE_LEVEL <= 2
#define HKU_INFO(...) \
fmt::print("[{}] [HKU-I] - {} ({}:{})\n", getLocalTime(), fmt::format(__VA_ARGS__), __FILE__, \
__LINE__);
#else
#define HKU_INFO(...)
#endif
#if LOG_ACTIVE_LEVEL <= 3
#define HKU_WARN(...) \
fmt::print("[{}] [HKU-W] - {} ({}:{})\n", getLocalTime(), fmt::format(__VA_ARGS__), __FILE__, \
__LINE__);
#else
#define HKU_WARN(...)
#endif
#if LOG_ACTIVE_LEVEL <= 4
#define HKU_ERROR(...) \
fmt::print("[{}] [HKU-E] - {} ({}:{})\n", getLocalTime(), fmt::format(__VA_ARGS__), __FILE__, \
__LINE__);
#else
#define HKU_ERROR(...)
#endif
#if LOG_ACTIVE_LEVEL <= 5
#define HKU_FATAL(...) \
fmt::print("[{}] [HKU-F] - {} ({}:{})\n", getLocalTime(), fmt::format(__VA_ARGS__), __FILE__, \
__LINE__);
#else
#define HKU_FATAL(...)
#endif
#endif /* USE_SPDLOG_LOGGER */
///////////////////////////////////////////////////////////////////////////////
//
// clang/gcc 下使用 __PRETTY_FUNCTION__ 会包含函数参数,可以在编译时指定
// #define HKU_FUNCTION __PRETTY_FUNCTION__
//
///////////////////////////////////////////////////////////////////////////////
#ifndef HKU_FUNCTION
#define HKU_FUNCTION __FUNCTION__
#endif
/**
* 若表达式为 false,将抛出 hku::exception 异常, 并附带传入信息
* @note 用于外部入参及结果检查
*/
#define HKU_CHECK(expr, ...) \
do { \
if (!(expr)) { \
throw hku::exception(fmt::format("CHECK({}) {} [{}] ({}:{})", #expr, \
fmt::format(__VA_ARGS__), __FUNCTION__, __FILE__, \
__LINE__)); \
} \
} while (0)
/**
* 若表达式为 false,将抛出指定的异常, 并附带传入信息
* @note 用于外部入参及结果检查
*/
#define HKU_CHECK_THROW(expr, except, ...) \
do { \
if (!(expr)) { \
throw except(fmt::format("CHECK({}) {} [{}] ({}:{})", #expr, fmt::format(__VA_ARGS__), \
__FUNCTION__, __FILE__, __LINE__)); \
} \
} while (0)
#if HKU_DISABLE_ASSERT
#define HKU_ASSERT(expr)
#define HKU_ASSERT_M(expr, ...)
#else /* #if HKU_DISABLE_ASSERT */
/**
* 若表达式为 false,将抛出 hku::exception 异常
* @note 仅用于内部入参检查,编译时可通过 HKU_DISABLE_ASSERT 宏关闭
*/
#define HKU_ASSERT(expr) \
do { \
if (!(expr)) { \
std::string err_msg(fmt::format("ASSERT({})", #expr)); \
HKU_ERROR(err_msg); \
throw hku::exception( \
fmt::format("{} [{}] ({}:{})", err_msg, __FUNCTION__, __FILE__, __LINE__)); \
} \
} while (0)
/**
* 若表达式为 false,将抛出 hku::exception 异常, 并附带传入信息
* @note 仅用于内部入参检查,编译时可通过 HKU_DISABLE_ASSERT 宏关闭
*/
#define HKU_ASSERT_M(expr, ...) \
do { \
if (!(expr)) { \
std::string err_msg(fmt::format("ASSERT({}) {}", #expr, fmt::format(__VA_ARGS__))); \
HKU_ERROR(err_msg); \
throw hku::exception( \
fmt::format("{} [{}] ({}:{})", err_msg, __FUNCTION__, __FILE__, __LINE__)); \
} \
} while (0)
#endif /* #if HKU_DISABLE_ASSERT */
/** 抛出 hku::exception 及传入信息 */
#define HKU_THROW(...) \
do { \
throw hku::exception(fmt::format("EXCEPTION: {} [{}] ({}:{})", fmt::format(__VA_ARGS__), \
__FUNCTION__, __FILE__, __LINE__)); \
} while (0)
/** 抛出指定异常及传入信息 */
#define HKU_THROW_EXCEPTION(except, ...) \
do { \
throw except(fmt::format("EXCEPTION: {} [{}] ({}:{})", fmt::format(__VA_ARGS__), \
__FUNCTION__, __FILE__, __LINE__)); \
} while (0)
/**
* 满足指定条件时,打印 TRACE 信息
* @param expr 指定条件
*/
#define HKU_TRACE_IF(expr, ...) \
if (expr) { \
HKU_TRACE(__VA_ARGS__); \
}
/**
* 满足指定条件时,打印 DEBUG 信息, 并返回指定值
* @param expr 指定条件
*/
#define HKU_DEBUG_IF(expr, ...) \
if (expr) { \
HKU_DEBUG(__VA_ARGS__); \
}
/**
* 满足指定条件时,打印 INFO 信息, 并返回指定值
* @param expr 指定条件
*/
#define HKU_INFO_IF(expr, ...) \
if (expr) { \
HKU_INFO(__VA_ARGS__); \
}
/**
* 满足指定条件时,打印 WARN 信息, 并返回指定值
* @param expr 指定条件
*/
#define HKU_WARN_IF(expr, ...) \
if (expr) { \
HKU_WARN(__VA_ARGS__); \
}
/**
* 满足指定条件时,打印 ERROR 信息, 并返回指定值
* @param expr 指定条件
*/
#define HKU_ERROR_IF(expr, ...) \
if (expr) { \
HKU_ERROR(__VA_ARGS__); \
}
/**
* 满足指定条件时,打印 FATAL 信息, 并返回指定值
* @param expr 指定条件
*/
#define HKU_FATAL_IF(expr, ...) \
if (expr) { \
HKU_FATAL(__VA_ARGS__); \
}
/**
* 满足指定条件时,返回指定值
* @param expr 指定条件
* @param ret 返回值
*/
#define HKU_IF_RETURN(expr, ret) \
if (expr) { \
return ret; \
}
/**
* 满足指定条件时,打印 TRACE 信息, 并返回指定值
* @param expr 指定条件
* @param ret 返回值
*/
#define HKU_TRACE_IF_RETURN(expr, ret, ...) \
if (expr) { \
HKU_TRACE(__VA_ARGS__); \
return ret; \
}
/**
* 满足指定条件时,打印 DEBUG 信息, 并返回指定值
* @param expr 指定条件
* @param ret 返回值
*/
#define HKU_DEBUG_IF_RETURN(expr, ret, ...) \
if (expr) { \
HKU_DEBUG(__VA_ARGS__); \
return ret; \
}
/**
* 满足指定条件时,打印 INFO 信息, 并返回指定值
* @param expr 指定条件
* @param ret 返回值
*/
#define HKU_INFO_IF_RETURN(expr, ret, ...) \
if (expr) { \
HKU_INFO(__VA_ARGS__); \
return ret; \
}
/**
* 满足指定条件时,打印 WARN 信息, 并返回指定值
* @param expr 指定条件
* @param ret 返回值
*/
#define HKU_WARN_IF_RETURN(expr, ret, ...) \
if (expr) { \
HKU_WARN(__VA_ARGS__); \
return ret; \
}
/**
* 满足指定条件时,打印 ERROR 信息, 并返回指定值
* @param expr 指定条件
* @param ret 返回值
*/
#define HKU_ERROR_IF_RETURN(expr, ret, ...) \
if (expr) { \
HKU_ERROR(__VA_ARGS__); \
return ret; \
}
/**
* 满足指定条件时,打印 FATAL 信息, 并返回指定值
* @param expr 指定条件
* @param ret 返回值
*/
#define HKU_FATAL_IF_RETURN(expr, ret, ...) \
if (expr) { \
HKU_FATAL(__VA_ARGS__); \
return ret; \
}
extern std::string g_unknown_error_msg;
#define HKU_ERROR_UNKNOWN HKU_ERROR(g_unknown_error_msg)
#define HKU_FATAL_UNKNOWN HKU_ERROR(g_unknown_error_msg)
/** @} */
} /* namespace hku */
#endif /* HIKUU_LOG_H_ */