8 Commits

19 changed files with 650 additions and 320 deletions

92
.clang-tidy Normal file
View File

@@ -0,0 +1,92 @@
---
Checks: '-*,
clang-analyzer-core.*,
clang-analyzer-cplusplus.*,
modernize-redundant-void-arg,
modernize-use-bool-literals,
modernize-use-equals-default,
modernize-use-nullptr,
modernize-use-override,
google-explicit-constructor,
google-readability-casting,
readability-braces-around-statements,
readability-identifier-naming.ClassCase,
readability-identifier-naming.StructCase,
readability-identifier-naming.TypedefCase,
readability-identifier-naming.EnumCase,
readability-non-const-parameter,
cert-dcl21-cpp,
bugprone-undelegated-constructor,
bugprone-macro-parentheses,
bugprone-macro-repeated-side-effects,
bugprone-forward-declaration-namespace,
bugprone-bool-pointer-implicit-conversion,
bugprone-misplaced-widening-cast,
cppcoreguidelines-narrowing-conversions,
misc-unconventional-assign-operator,
misc-unused-parameters'
WarningsAsErrors: ''
HeaderFilterRegex: ''
CheckOptions:
# 现代化Modernize
- key: modernize-redundant-void-arg
value: 'true' # 检查并移除函数声明中冗余的 void 参数。
- key: modernize-use-bool-literals
value: 'true' # 建议使用布尔字面量 true 和 false 代替整数值 0 和 1。
- key: modernize-use-equals-default
value: 'true' # 建议在默认构造函数、复制构造函数和赋值运算符中使用 = default以简化代码。
- key: modernize-use-nullptr
value: 'true' # 建议使用 nullptr 代替 NULL 或 0 来表示空指针。
- key: modernize-use-override
value: 'true' # 建议在覆盖基类虚函数时使用 override 关键字,以增加代码的清晰性和安全性。
# Google 代码风格Google
- key: google-explicit-constructor
value: 'true' # 检查并建议在单参数构造函数中使用 explicit 关键字,以防止隐式转换。
- key: google-readability-casting
value: 'true' # 检查并建议使用 C++ 风格的类型转换(如 static_cast、dynamic_cast、const_cast 和 reinterpret_cast代替 C 风格的类型转换。
# 可读性Readability
- key: readability-braces-around-statements
value: 'true' # 建议在单行语句周围添加大括号,以提高代码的可读性和一致性。
- key: readability-identifier-naming.ClassCase
value: 'CamelCase' # 类名应使用 CamelCase 风格,例如 MyClassName。
- key: readability-identifier-naming.StructCase
value: 'CamelCase' # 结构体名应使用 CamelCase 风格,例如 MyStructName。
- key: readability-identifier-naming.TypedefCase
value: 'CamelCase' # 类型定义应使用 CamelCase 风格,例如 MyTypeDef。
- key: readability-identifier-naming.EnumCase
value: 'CamelCase' # 枚举名应使用 CamelCase 风格,例如 MyEnumName。
- key: readability-non-const-parameter
value: 'true' # 检查并标识非 const 参数,以提高代码的可读性和安全性。
# CERT 安全编码标准CERT
- key: cert-dcl21-cpp
value: 'true' # 检查并标识在头文件中不应包含无命名空间的 using 声明和指令,以防止命名空间污染。
# Bug 检测Bugprone
- key: bugprone-undelegated-constructor
value: 'true' # 检查并标识未委托的构造函数,以确保构造函数的正确性。
- key: bugprone-macro-parentheses
value: 'true' # 检查并建议在宏定义中使用括号,以防止潜在的错误。
- key: bugprone-macro-repeated-side-effects
value: 'true' # 检查并标识宏中重复的副作用,以防止潜在的错误。
- key: bugprone-forward-declaration-namespace
value: 'true' # 检查并标识命名空间前向声明的潜在问题。
- key: bugprone-bool-pointer-implicit-conversion
value: 'true' # 检查并标识布尔指针的隐式转换,以防止潜在的错误。
- key: bugprone-misplaced-widening-cast
value: 'true' # 检查并标识错误的宽化转换,以防止潜在的错误。
# C++ 核心指南CppCoreGuidelines
- key: cppcoreguidelines-narrowing-conversions
value: 'true' # 检查并标识可能导致数据丢失的窄化转换。
# 杂项Miscellaneous
- key: misc-unconventional-assign-operator
value: 'true' # 检查并标识不常见的赋值操作符重载,以确保代码的一致性和可维护性。
- key: misc-unused-parameters
value: 'true' # 检测未使用的参数。
...

View File

@@ -3,6 +3,7 @@ cmake_minimum_required(VERSION 3.28...3.30)
project(logging) project(logging)
set(CMAKE_C_STANDARD 99) set(CMAKE_C_STANDARD 99)
set(CMAKE_C_CLANG_TIDY "clang-tidy")
if(MSVC) if(MSVC)
add_compile_options("/source-charset:utf-8") add_compile_options("/source-charset:utf-8")

View File

@@ -32,13 +32,11 @@ cmake --install .
#include "logging.h" #include "logging.h"
int main() { int main() {
Logger *logger = newDefaultLogger("testLogger", LOG_DEBUG); Log_info("This is an info message");
Log_error("This is an error message%s", "123");
log_info("This is an info message"); Log_fatal("This is an fatal message");
log_error("This is an error message%s", "123"); Log_debug("This is a debug message");
log_fatal("This is an fatal message"); Log_warning("This is a warning message%s", "123");
log_debug("This is a debug message");
log_warning("This is a warning message%s", "123");
destroyDefaultLogger(); destroyDefaultLogger();
return 0; return 0;
@@ -51,14 +49,14 @@ int main() {
#include "logging/logging-handler.h" #include "logging/logging-handler.h"
int main() { int main() {
Logger *logger = newDefaultLogger("testLogger", LOG_DEBUG); log_Handler *hander = loggingHandlerFile("test_log", 1024 * 1024 * 10);
logger->addHandler(loggingHandlerFile("test1", 1024*1024)); addHandler(getDefaultLogger(), hander);
log_info("This is an info message"); Log_info("This is an info message");
log_error("This is an error message%s", "123"); Log_error("This is an error message%s", "123");
log_fatal("This is an fatal message"); Log_fatal("This is an fatal message");
log_debug("This is a debug message"); Log_debug("This is a debug message");
log_warning("This is a warning message%s", "123"); Log_warning("This is a warning message%s", "123");
destroyDefaultLogger(); destroyDefaultLogger();
return 0; return 0;
@@ -69,92 +67,51 @@ int main() {
> Support adding custom filters, currently with built-in substring filters > Support adding custom filters, currently with built-in substring filters
> The function of an filter is to redirect filtered logs to the filter's dedicated processor > The function of an filter is to redirect filtered logs to the filter's dedicated processor
#### example
Redirects filtered logs to a dedicated file processor
```c
#include "logging.h"
#include <stdio.h>
int main() {
Logger *logger = newDefaultLogger("testLogger", LOG_DEBUG);
log_info("This is an info message");
log_error("This is an error message%s", "123");
log_fatal("This is an fatal message");
log_debug("This is a debug message");
log_warning("This is a warning message%s", "123");
char *test1[] = {"123", "tt", NULL};
log_filter *tint = loggingFilterSubStr(
test1,
LOG_DEBUG,
loggingHandlerFile("test_interceptor", 1024 * 1024),
true);
logger->addFilter(tint);
printf("\n");
printf("filter added\n");
printf("\n");
log_info("This is an info message");
log_error("This is an error message%s", "123");
log_fatal("This is an fatal message");
log_debug("This is a debug message");
log_warning("This is a warning message%s", "123");
destroyDefaultLogger();
return 0;
}
```
#### Multiple substring filters #### Multiple substring filters
```c ```c
#include "logging.h" #include "logging.h"
#include "logging/logging-core.h"
#include "logging/logging-filter.h"
#include <stdbool.h> #include <stdbool.h>
#include <stdio.h> #include <stdio.h>
#include <time.h> #include <time.h>
int main() { int main() {
Logger *logger = newDefaultLogger("testLogger", LOG_DEBUG); Log_info("This is an info message");
Log_error("This is an error message%s", "123");
Log_fatal("This is an fatal message");
Log_debug("This is a debug message");
Log_warning("This is a warning message%s", "123");
log_info("This is an info message"); char *test1[] = {"This", NULL};
log_error("This is an error message%s", "123");
log_fatal("This is an fatal message");
log_debug("This is a debug message");
log_warning("This is a warning message%s", "123");
char *test1[] = {"This",NULL}; log_filter *tint =
loggingFilterSubStr(test1,
LOG_DEBUG,
loggingHandlerFile("test_interceptor", 1024 * 1024),
false);
log_filter *tint = loggingFilterSubStr( addFilter(getDefaultLogger(), tint);
test1,
LOG_DEBUG,
loggingHandlerFile("test_interceptor", 1024 * 1024),
false);
logger->addFilter(tint); char *test2[] = {"123", NULL};
char *test2[] = {"123",NULL};
log_filter *tint1 = loggingFilterSubStr( log_filter *tint1 = loggingFilterSubStr(
test2, test2,
LOG_DEBUG, LOG_ERROR,
loggingHandlerFile("test_interceptor1", 1024 * 1024), loggingHandlerFile("test_interceptor1", 1024 * 1024),
true); true);
logger->addFilter(tint1); addFilter(getDefaultLogger(), tint1);
printf("\n"); printf("\n");
printf("filter added\n"); printf("filter added\n");
printf("\n"); printf("\n");
log_info("This is an info message"); Log_info("This is an info message");
log_error("This is an error message%s", "123"); Log_error("This is an error message%s", "123");
log_fatal("This is an fatal message"); Log_fatal("This is an fatal message");
log_debug("This is a debug message"); Log_debug("This is a debug message");
log_warning("This is a warning message%s", "123"); Log_warning("This is a warning message%s", "123");
destroyDefaultLogger(); destroyDefaultLogger();
return 0; return 0;

View File

@@ -47,8 +47,6 @@ cmake --install .
#include "logging.h" #include "logging.h"
int main() { int main() {
Logger *logger = newDefaultLogger("testLogger", LOG_DEBUG);
Log_info("This is an info message"); Log_info("This is an info message");
Log_error("This is an error message%s", "123"); Log_error("This is an error message%s", "123");
Log_fatal("This is an fatal message"); Log_fatal("This is an fatal message");
@@ -66,8 +64,8 @@ int main() {
#include "logging/logging-handler.h" #include "logging/logging-handler.h"
int main() { int main() {
Logger *logger = newDefaultLogger("testLogger", LOG_DEBUG); log_Handler *hander = loggingHandlerFile("test_log", 1024 * 1024 * 10);
logger->addHandler(loggingHandlerFile("test1", 1024*1024)); addHandler(getDefaultLogger(), hander);
Log_info("This is an info message"); Log_info("This is an info message");
Log_error("This is an error message%s", "123"); Log_error("This is an error message%s", "123");
@@ -85,82 +83,41 @@ int main() {
> 过滤器的作用:可以将过滤到的日志重定向到过滤器的专属处理器中 > 过滤器的作用:可以将过滤到的日志重定向到过滤器的专属处理器中
#### 单个子串过滤器
将过滤到的日志重定向到专属处理器中
```c
#include "logging.h"
#include <stdio.h>
int main() {
Logger *logger = newDefaultLogger("testLogger", LOG_DEBUG);
Log_info("This is an info message");
Log_error("This is an error message%s", "123");
Log_fatal("This is an fatal message");
Log_debug("This is a debug message");
Log_warning("This is a warning message%s", "123");
char *test1[] = {"123", "tt", NULL};
log_filter *tint = loggingFilterSubStr(
test1,
LOG_DEBUG,
loggingHandlerFile("test_interceptor", 1024 * 1024),
true);
logger->addFilter(tint);
printf("\n");
printf("filter added\n");
printf("\n");
Log_info("This is an info message");
Log_error("This is an error message%s", "123");
Log_fatal("This is an fatal message");
Log_debug("This is a debug message");
Log_warning("This is a warning message%s", "123");
destroyDefaultLogger();
return 0;
}
```
#### 多个子串过滤器 #### 多个子串过滤器
```c ```c
#include "logging.h" #include "logging.h"
#include "logging/logging-core.h"
#include "logging/logging-filter.h"
#include <stdbool.h> #include <stdbool.h>
#include <stdio.h> #include <stdio.h>
#include <time.h> #include <time.h>
int main() { int main() {
Logger *logger = newDefaultLogger("testLogger", LOG_DEBUG);
Log_info("This is an info message"); Log_info("This is an info message");
Log_error("This is an error message%s", "123"); Log_error("This is an error message%s", "123");
Log_fatal("This is an fatal message"); Log_fatal("This is an fatal message");
Log_debug("This is a debug message"); Log_debug("This is a debug message");
Log_warning("This is a warning message%s", "123"); Log_warning("This is a warning message%s", "123");
char *test1[] = {"This",NULL}; char *test1[] = {"This", NULL};
log_filter *tint = loggingFilterSubStr( log_filter *tint =
test1, loggingFilterSubStr(test1,
LOG_DEBUG, LOG_DEBUG,
loggingHandlerFile("test_interceptor", 1024 * 1024), loggingHandlerFile("test_interceptor", 1024 * 1024),
false); false);
logger->addFilter(tint); addFilter(getDefaultLogger(), tint);
char *test2[] = {"123",NULL}; char *test2[] = {"123", NULL};
log_filter *tint1 = loggingFilterSubStr( log_filter *tint1 = loggingFilterSubStr(
test2, test2,
LOG_DEBUG, LOG_ERROR,
loggingHandlerFile("test_interceptor1", 1024 * 1024), loggingHandlerFile("test_interceptor1", 1024 * 1024),
true); true);
logger->addFilter(tint1); addFilter(getDefaultLogger(), tint1);
printf("\n"); printf("\n");
printf("filter added\n"); printf("filter added\n");

View File

@@ -5,7 +5,7 @@ import os
class loggingRecipe(ConanFile): class loggingRecipe(ConanFile):
name = "logging" name = "logging"
version = "0.5.1" version = "1.0.0"
license = "MIT" license = "MIT"
author = "321640253@qq.com" author = "321640253@qq.com"
url = "https://github.com/WangZhongDian/logging.git" url = "https://github.com/WangZhongDian/logging.git"

View File

@@ -3,6 +3,7 @@
#include <stdarg.h> #include <stdarg.h>
#include <stdbool.h> #include <stdbool.h>
#include <stddef.h>
#include "logging/logging-core.h" #include "logging/logging-core.h"
#include "logging/logging-filter.h" #include "logging/logging-filter.h"
@@ -12,51 +13,72 @@
extern "C" { extern "C" {
#endif #endif
// 默认日志器宏
#define Log_fatal(format, ...) \ #define Log_fatal(format, ...) \
log_fatal(__FILE__, __LINE__, format, ##__VA_ARGS__) logMessage(NULL, LOG_FATAL, __FILE__, __LINE__, format, ##__VA_ARGS__)
#define Log_error(format, ...) \ #define Log_error(format, ...) \
log_error(__FILE__, __LINE__, format, ##__VA_ARGS__) logMessage(NULL, LOG_ERROR, __FILE__, __LINE__, format, ##__VA_ARGS__)
#define Log_warning(format, ...) \ #define Log_warning(format, ...) \
log_warning(__FILE__, __LINE__, format, ##__VA_ARGS__) logMessage(NULL, LOG_WARNING, __FILE__, __LINE__, format, ##__VA_ARGS__)
#define Log_info(format, ...) \ #define Log_info(format, ...) \
log_info(__FILE__, __LINE__, format, ##__VA_ARGS__) logMessage(NULL, LOG_INFO, __FILE__, __LINE__, format, ##__VA_ARGS__)
#define Log_debug(format, ...) \ #define Log_debug(format, ...) \
log_debug(__FILE__, __LINE__, format, ##__VA_ARGS__) logMessage(NULL, LOG_DEBUG, __FILE__, __LINE__, format, ##__VA_ARGS__)
// 日志器宏
#define log_fatal(logger, format, ...) \
logMessage(logger, LOG_FATAL, __FILE__, __LINE__, format, ##__VA_ARGS__)
#define log_error(logger, format, ...) \
logMessage(logger, LOG_ERROR, __FILE__, __LINE__, format, ##__VA_ARGS__)
#define log_warning(logger, format, ...) \
logMessage(logger, LOG_WARNING, __FILE__, __LINE__, format, ##__VA_ARGS__)
#define log_info(logger, format, ...) \
logMessage(logger, LOG_INFO, __FILE__, __LINE__, format, ##__VA_ARGS__)
#define log_debug(logger, format, ...) \
logMessage(logger, LOG_DEBUG, __FILE__, __LINE__, format, ##__VA_ARGS__)
typedef struct Logger { typedef struct Logger {
log_level level; log_level level;
log_Handler *handler; log_Handler *handler;
log_filter *filter; log_filter *filter;
const char *name; const char *name;
bool (*addHandler)(log_Handler *handler);
bool (*addFilter)(log_filter *filter);
} Logger; } Logger;
void log_fatal(const char *file, int line, const char *format, ...); bool addHandler(Logger *logger, log_Handler *handler);
void log_error(const char *file, int line, const char *format, ...); bool addFilter(Logger *logger, log_filter *filter);
void log_warning(const char *file, int line, const char *format, ...);
void log_info(const char *file, int line, const char *format, ...); void logMessage(Logger *logger,
void log_debug(const char *file, int line, const char *format, ...); log_level level,
const char *file,
int line,
const char *message,
...);
/** /**
* @brief * @brief 创建一个日志句柄对象
创建默认日志对象,日志对象为单例模式后续可通过getDefaultLogger方法获取 * @param name 日志器名称
重复调用该方法不会创建新的日志对象,只会返回默认日志对象,并且会修改默认日志对象的名称和等级 * @return 日志句柄对象
* @param name 日志名称 */
* @param level 日志等级 Logger *newLogger(const char *name);
* @return Logger* 日志对象指针
*/
Logger *newDefaultLogger(const char *name, log_level level);
/** /**
* @brief 获取默认日志对象 * @brief 获取默认日志对象
* @return 默认日志对象
*/ */
Logger *getDefaultLogger(void); Logger *getDefaultLogger(void);
Logger *getLogger(const char *name);
/** /**
* @brief 销毁日志对象,该方法会销毁默认日志对象 * @brief 销毁日志对象,该方法会销毁默认日志对象
*/ */
log_status destroyDefaultLogger(void); void destroyDefaultLogger(void);
/**
* @brief 销毁日志对象
* @param logger 日志对象
* @return void
*/
void destroyLogger(Logger *logger);
#ifdef __cplusplus #ifdef __cplusplus
} }

View File

@@ -13,6 +13,14 @@ typedef enum {
LOG_DEBUG, LOG_DEBUG,
} log_level; } log_level;
static const char *LOG_LEVEL_STR[] = {
"FATAL",
"ERROR",
"WARNING",
"INFO",
"DEBUG",
};
typedef enum { typedef enum {
L_ERROR, L_ERROR,
L_OK, L_OK,

View File

@@ -1,6 +1,6 @@
[project] [project]
name = "logging" name = "logging"
version = "0.1.0" version = "1.0.0"
description = "Add your description here" description = "Add your description here"
readme = "README.md" readme = "README.md"
requires-python = ">=3.12" requires-python = ">=3.12"

View File

@@ -24,15 +24,17 @@ static void get_next(char *str, int *next) {
} }
static bool kmp_search(char *substr, char *master) { static bool kmp_search(char *substr, char *master) {
if (substr == NULL) if (substr == NULL) {
return true; // 空串全匹配 return true; // 空串全匹配
if (master == NULL) }
if (master == NULL) {
return false; return false;
int i = 0; }
int j = 0; int i = 0;
int substrlen = strlen(substr); int j = 0;
int masterlen = strlen(master); size_t substrlen = strlen(substr);
int *next = (int *)malloc(sizeof(int) * (substrlen + 1)); size_t masterlen = strlen(master);
int *next = (int *)malloc(sizeof(int) * (substrlen + 1));
get_next(substr, next); get_next(substr, next);
while (i < masterlen && j < substrlen) { while (i < masterlen && j < substrlen) {
@@ -49,10 +51,11 @@ static bool kmp_search(char *substr, char *master) {
} }
free(next); free(next);
if (j == substrlen) if (j == substrlen) {
return true; return true;
else } else {
return false; return false;
}
} }
static bool _disposeSubstring(log_filter *filter, static bool _disposeSubstring(log_filter *filter,
@@ -63,14 +66,16 @@ static bool _disposeSubstring(log_filter *filter,
keywords_t *keyword = (keywords_t *)(filter + 1); keywords_t *keyword = (keywords_t *)(filter + 1);
if (keyword->key == NULL && keyword->next == NULL) { if (keyword->key == NULL && keyword->next == NULL) {
if (level <= filter->level) if (level <= filter->level) {
return true; return true;
}
return false; return false;
} }
while (keyword != NULL && level <= filter->level) { while (keyword != NULL && level <= filter->level) {
if (kmp_search(keyword->key, (char *)message)) if (kmp_search(keyword->key, (char *)message)) {
return true; return true;
}
keyword = keyword->next; keyword = keyword->next;
} }
@@ -94,8 +99,9 @@ static void _freeFilter(log_filter *filter) {
filter->handler->_free(filter->handler); filter->handler->_free(filter->handler);
} }
if (it_keyword->key != NULL) if (it_keyword->key != NULL) {
free(it_keyword->key); free(it_keyword->key);
}
free(filter); free(filter);
} }

View File

@@ -7,7 +7,7 @@
// log_Handler_file_ex_t与log_Handler处于连续内存中 // log_Handler_file_ex_t与log_Handler处于连续内存中
// 使用char*指针进行偏移达到以偏移1个字节为单位的偏移 // 使用char*指针进行偏移达到以偏移1个字节为单位的偏移
#define Handler_file_EX_PRT(handler) \ #define Handler_file_EX_PRT(handler) \
((log_Handler_file_ex_t *)((char *)handler + sizeof(log_Handler))) ((log_Handler_file_ex_t *)((char *)(handler) + sizeof(log_Handler)))
#define FILE_NAME_MAX_SIZE 50 #define FILE_NAME_MAX_SIZE 50
@@ -46,9 +46,10 @@ static void outputFileHandler(log_Handler *handler, const char *message) {
fputs(message, handler->stream); fputs(message, handler->stream);
log_Handler_file_ex_t *handler_ex = Handler_file_EX_PRT(handler); log_Handler_file_ex_t *handler_ex = Handler_file_EX_PRT(handler);
handler_ex->file_size += strlen(message); handler_ex->file_size += strlen(message);
if (handler_ex->file_size > handler_ex->file_size_max) if (handler_ex->file_size > handler_ex->file_size_max) {
changeFile(handler); changeFile(handler);
} }
}
log_Handler *loggingHandlerFile(const char *file_name, unsigned int max_size) { log_Handler *loggingHandlerFile(const char *file_name, unsigned int max_size) {
char new_file_name[FILE_NAME_MAX_SIZE]; char new_file_name[FILE_NAME_MAX_SIZE];
@@ -62,24 +63,27 @@ log_Handler *loggingHandlerFile(const char *file_name, unsigned int max_size) {
do { do {
sprintf(new_file_name, "%s_%d.log", file_name, suffix++); sprintf(new_file_name, "%s_%d.log", file_name, suffix++);
fp = fopen(new_file_name, "at"); fp = fopen(new_file_name, "at");
if (fp == NULL) if (fp == NULL) {
goto ERROR; goto ERROR;
}
file_size = getFileSize(fp); file_size = getFileSize(fp);
} while (file_size > max_size); } while (file_size > max_size);
/// 分配log_Handler与记录文件大小的空间 /// 分配log_Handler与记录文件大小的空间
handler = (log_Handler *)malloc(sizeof(log_Handler) + handler = (log_Handler *)malloc(sizeof(log_Handler) +
sizeof(log_Handler_file_ex_t)); sizeof(log_Handler_file_ex_t));
if (handler == NULL) if (handler == NULL) {
goto ERROR; goto ERROR;
}
handler_ex = Handler_file_EX_PRT(handler); handler_ex = Handler_file_EX_PRT(handler);
handler_ex->file_size_max = max_size; handler_ex->file_size_max = max_size;
handler_ex->file_size = file_size; handler_ex->file_size = file_size;
handler_ex->suffix = suffix; handler_ex->suffix = suffix;
handler_ex->file_name = strdup(file_name); handler_ex->file_name = strdup(file_name);
if (handler_ex->file_name == NULL) if (handler_ex->file_name == NULL) {
goto ERROR; goto ERROR;
}
handler->stream = fp; handler->stream = fp;
handler->apply_color = false; handler->apply_color = false;
@@ -88,8 +92,9 @@ log_Handler *loggingHandlerFile(const char *file_name, unsigned int max_size) {
return handler; return handler;
ERROR: ERROR:
if (fp) if (fp) {
fclose(fp); fclose(fp);
}
if (handler) { if (handler) {
free(Handler_file_EX_PRT(handler)->file_name); // 直接释放无需检查NULL free(Handler_file_EX_PRT(handler)->file_name); // 直接释放无需检查NULL
free(handler); free(handler);

View File

@@ -1,6 +1,7 @@
#include "logging.h" #include "logging.h"
#include "logging/logging-core.h" #include "logging/logging-core.h"
#include "logging/logging-handler.h" #include "logging/logging-handler.h"
#include "utils/logging-map.h"
#include "utils/logging-utils.h" #include "utils/logging-utils.h"
#include <stdbool.h> #include <stdbool.h>
#include <stdio.h> #include <stdio.h>
@@ -18,23 +19,25 @@
#define LOG_BUFFER_SIZE 4096 // 日志缓冲区大小,单个日志长度不能超过该值 #define LOG_BUFFER_SIZE 4096 // 日志缓冲区大小,单个日志长度不能超过该值
static Logger *G_LOGGER = NULL; // 全局日志对象,唯一实例 static Logger *ROOT_LOGGER = NULL; // 日志对象,唯一实例
static Map *LOGGER_MAP = NULL; // 日志对象映射表
/** /**
* @brief 为日志添加一个handler * @brief 为日志添加一个handler
* @param handler 处理器对象 * @param handler 处理器对象
*/ */
static bool addHandler(log_Handler *handler) { bool addHandler(Logger *logger, log_Handler *handler) {
if (G_LOGGER == NULL || handler == NULL) { if (logger == NULL || handler == NULL) {
return false; return false;
} }
if (G_LOGGER->handler == NULL) { if (logger->handler == NULL) {
G_LOGGER->handler = handler; logger->handler = handler;
return true; return true;
} }
G_LOGGER->handler->_free(G_LOGGER->handler); logger->handler->_free(logger->handler);
G_LOGGER->handler = handler; logger->handler = handler;
return true; return true;
} }
@@ -42,21 +45,17 @@ static bool addHandler(log_Handler *handler) {
* @brief 为日志添加一个filter * @brief 为日志添加一个filter
* @param filter 过滤器对象 * @param filter 过滤器对象
*/ */
/** bool addFilter(Logger *logger, log_filter *filter) {
* @brief 为日志添加一个filter if (logger == NULL || filter == NULL) {
* @param filter 过滤器对象
*/
static bool addFilter(log_filter *filter) {
if (G_LOGGER == NULL || filter == NULL) {
return false; return false;
} }
if (G_LOGGER->filter == NULL) { if (logger->filter == NULL) {
G_LOGGER->filter = filter; logger->filter = filter;
G_LOGGER->filter->next = NULL; logger->filter->next = NULL;
return true; return true;
} }
log_filter *it = G_LOGGER->filter; log_filter *it = logger->filter;
while (it->next != NULL) { while (it->next != NULL) {
it = it->next; it = it->next;
} }
@@ -80,33 +79,35 @@ static bool addFilter(log_filter *filter) {
* @param color 应用的颜色 * @param color 应用的颜色
* @param message 日志内容 * @param message 日志内容
*/ */
static void output_to_handler(log_Handler *handler, static void output_to_handler(Logger *logger,
char *level, char *level,
const char *color, const char *color,
const char *message) { const char *message) {
char timeStr[20]; char timeStr[20];
getTimeStr(timeStr); getTimeStr(timeStr);
char logStr[LOG_BUFFER_SIZE * 2]; char logStr[LOG_BUFFER_SIZE * 2];
if (handler->apply_color) if (logger->handler->apply_color) {
snprintf(logStr, snprintf(logStr,
LOG_BUFFER_SIZE * 2, LOG_BUFFER_SIZE * 2,
"[%s]: %s %s%s%s %s\n", "[%s]: %s %s%s%s %s\n",
G_LOGGER->name, logger->name,
timeStr, timeStr,
color, color,
level, level,
RESET, RESET,
message); message);
else } else {
snprintf(logStr, snprintf(logStr,
LOG_BUFFER_SIZE * 2, LOG_BUFFER_SIZE * 2,
"[%s]: %s %s %s\n", "[%s]: %s %s %s\n",
G_LOGGER->name, logger->name,
timeStr, timeStr,
level, level,
message); message);
}
handler->output(handler, logStr); logger->handler->output(logger->handler, logStr);
} }
/** /**
@@ -117,133 +118,153 @@ static void output_to_handler(log_Handler *handler,
* @param ... 格式化参数列表 * @param ... 格式化参数列表
* @return * @return
*/ */
static void log_cope(log_level level_e, static void
char *level, log_cope(Logger *logger, char *level, const char *color, const char *message) {
const char *color, if (logger == NULL) {
const char *message) {
if (G_LOGGER == NULL) {
return; return;
} }
if (G_LOGGER->handler == NULL) { if (logger->handler == NULL) {
return; return;
} }
log_filter *it = G_LOGGER->filter; log_filter *it = logger->filter;
log_Handler *handler = G_LOGGER->handler; log_Handler *handler = logger->handler;
while (it != NULL) { while (it != NULL) {
if (it->_dispose(it, level_e, message)) { if (it->_dispose(it, logger->level, message)) {
output_to_handler(it->handler, level, color, message); output_to_handler(logger, level, color, message);
if (it->jump_out) if (it->jump_out) {
return; return;
}
} }
it = it->next; it = it->next;
} }
output_to_handler(handler, level, color, message); output_to_handler(logger, level, color, message);
} }
void log_fatal(const char *file, int line, const char *message, ...) { void logMessage(Logger *logger,
if (G_LOGGER->level >= LOG_ERROR) { log_level level,
char logStr[LOG_BUFFER_SIZE]; const char *file,
char finalLogStr[LOG_BUFFER_SIZE * 2]; int line,
const char *message,
...) {
Logger *_logger = NULL;
if (logger == NULL) {
if (ROOT_LOGGER == NULL) {
ROOT_LOGGER = newLogger("ROOT"); // 创建根日志对象
}
_logger = ROOT_LOGGER;
} else {
_logger = logger; // 使用传入的日志对象
}
if (_logger->level >= level) {
char logStr
[LOG_BUFFER_SIZE]; // 定义一个缓冲区,用于存储格式化后的日志字符串
char finalLogStr[LOG_BUFFER_SIZE *
2]; // 定义一个缓冲区,用于存储最终输出的日志字符串
va_list args; va_list args;
va_start(args, message); va_start(args, message);
vsprintf(logStr, message, args); vsprintf(logStr, message, args);
va_end(args); va_end(args);
snprintf( snprintf(
finalLogStr, LOG_BUFFER_SIZE * 2, "[%s:%d] %s", file, line, logStr); finalLogStr, LOG_BUFFER_SIZE * 2, "[%s:%d] %s", file, line, logStr);
log_cope(LOG_FATAL, "Fatal", RED_B, finalLogStr);
switch (level) {
case LOG_DEBUG:
log_cope(_logger, "Debug", BLUE, finalLogStr);
break;
case LOG_INFO:
log_cope(_logger, "Info", GREEN, finalLogStr);
break;
case LOG_WARNING:
log_cope(_logger, "Warning", YELLOW, finalLogStr);
break;
case LOG_ERROR:
log_cope(_logger, "Error", RED, finalLogStr);
break;
case LOG_FATAL:
log_cope(_logger, "Fatal", RED_B, finalLogStr);
break;
default:
break;
}
} }
} }
void log_error(const char *file, int line, const char *message, ...) {
if (G_LOGGER->level >= LOG_ERROR) {
char logStr[LOG_BUFFER_SIZE];
char finalLogStr[LOG_BUFFER_SIZE * 2];
va_list args;
va_start(args, message);
vsprintf(logStr, message, args);
va_end(args);
snprintf(
finalLogStr, LOG_BUFFER_SIZE * 2, "[%s:%d] %s", file, line, logStr);
log_cope(LOG_ERROR, "Error", RED, finalLogStr);
}
}
void log_warning(const char *file, int line, const char *message, ...) {
if (G_LOGGER->level >= LOG_WARNING) {
char logStr[LOG_BUFFER_SIZE];
char finalLogStr[LOG_BUFFER_SIZE * 2];
va_list args;
va_start(args, message);
vsprintf(logStr, message, args);
va_end(args);
snprintf(
finalLogStr, LOG_BUFFER_SIZE * 2, "[%s:%d] %s", file, line, logStr);
log_cope(LOG_WARNING, "Warning", YELLOW, finalLogStr);
}
}
void log_info(const char *file, int line, const char *message, ...) {
if (G_LOGGER->level >= LOG_INFO) {
char logStr[LOG_BUFFER_SIZE];
char finalLogStr[LOG_BUFFER_SIZE * 2];
va_list args;
va_start(args, message);
vsprintf(logStr, message, args);
va_end(args);
snprintf(
finalLogStr, LOG_BUFFER_SIZE * 2, "[%s:%d] %s", file, line, logStr);
log_cope(LOG_INFO, "Info", GREEN, finalLogStr);
}
}
void log_debug(const char *file, int line, const char *message, ...) {
if (G_LOGGER->level >= LOG_DEBUG) {
char logStr[LOG_BUFFER_SIZE];
char finalLogStr[LOG_BUFFER_SIZE * 2];
va_list args;
va_start(args, message);
vsprintf(logStr, message, args);
va_end(args);
snprintf(
finalLogStr, LOG_BUFFER_SIZE * 2, "[%s:%d] %s", file, line, logStr);
log_cope(LOG_DEBUG, "Debug", CYAN, finalLogStr);
}
}
Logger *newDefaultLogger(const char *name, log_level level) {
if (G_LOGGER != NULL) {
G_LOGGER->name = name;
G_LOGGER->level = level;
return G_LOGGER;
}
Logger *logger = (Logger *)malloc(sizeof(Logger));
logger->addHandler = addHandler;
logger->addFilter = addFilter;
logger->level = level;
logger->handler = loggingHandlerConsole();
logger->name = name;
logger->filter = NULL;
G_LOGGER = logger;
return G_LOGGER;
}
/** /**
* @brief 销毁日志对象 * @brief 创建一个日志句柄
* @param name 日志器名称
* @return 日志器对象
*/ */
log_status destroyDefaultLogger(void) { Logger *newLogger(const char *name) {
if (G_LOGGER != NULL) { Logger *logger = (Logger *)malloc(sizeof(Logger));
if (G_LOGGER->handler != NULL) { if (logger == NULL) {
G_LOGGER->handler->_free(G_LOGGER->handler); return NULL;
}
if (LOGGER_MAP == NULL) {
LOGGER_MAP = map_create(sizeof(Logger **));
}
logger->level = LOG_INFO;
logger->handler = loggingHandlerConsole();
logger->name = name;
logger->filter = NULL;
map_put(LOGGER_MAP, name, &logger);
return logger;
}
Logger *getDefaultLogger(void) {
if (ROOT_LOGGER != NULL) {
return ROOT_LOGGER;
}
ROOT_LOGGER = newLogger("ROOT");
return ROOT_LOGGER;
}
/**
* @brief 获取日志器对象
* @param name 日志器名称
* @param level 日志等级
* @return 日志器对象
*/
Logger *getLogger(const char *name) {
if (name == NULL) {
return NULL;
}
if (LOGGER_MAP == NULL) {
LOGGER_MAP = map_create(sizeof(Logger **));
}
Logger **cache_logger_ptr = (Logger **)map_get(LOGGER_MAP, name);
if (cache_logger_ptr != NULL) {
return *cache_logger_ptr;
}
Logger *logger = (Logger *)malloc(sizeof(Logger));
logger->level = LOG_INFO;
logger->handler = loggingHandlerConsole();
logger->name = name;
logger->filter = NULL;
map_put(LOGGER_MAP, name, &logger);
return logger;
}
void destroyLogger(Logger *logger) {
if (logger != NULL) {
if (logger->handler != NULL) {
logger->handler->_free(logger->handler);
} }
if (G_LOGGER->filter != NULL) { if (logger->filter != NULL) {
log_filter *it = G_LOGGER->filter; log_filter *it = logger->filter;
log_filter *next = NULL; log_filter *next = NULL;
while (it != NULL) { while (it != NULL) {
next = it->next; next = it->next;
@@ -251,16 +272,21 @@ log_status destroyDefaultLogger(void) {
it = next; it = next;
} }
} }
free(logger);
free(G_LOGGER);
G_LOGGER = NULL;
} }
return L_OK;
} }
Logger *getDefaultLogger(void) { static void
if (G_LOGGER == NULL) { __destroyLoggerForeach(const char *key, void *value, void *user_data) {
return NULL; (void)user_data;
} (void)key;
return G_LOGGER; destroyLogger(*(Logger **)value);
}
/**
* @brief 销毁日志对象
*/
void destroyDefaultLogger(void) {
map_foreach(LOGGER_MAP, __destroyLoggerForeach, NULL);
map_destroy(LOGGER_MAP);
} }

143
src/utils/logging-map.c Normal file
View File

@@ -0,0 +1,143 @@
#include "logging-map.h"
#include <stdlib.h>
#include <string.h>
/* 哈希函数FNV-1a */
static uint32_t hash_bytes(const void *data, size_t len) {
const uint8_t *p = data;
uint32_t h = 2166136261u;
while (len--) {
h ^= *p++;
h *= 16777619u;
}
return h;
}
/* 创建空 map */
Map *map_create(size_t value_len) {
Map *m = calloc(1, sizeof(*m));
m->value_len = value_len;
m->bucket_cap = 8; /* 初始桶数 */
m->bucket = calloc(m->bucket_cap, sizeof(Node *));
return m;
}
/* 根据 key 找到桶下标 */
static size_t bucket_index(Map *m, const char *key) {
size_t len = strlen(key);
uint32_t h = hash_bytes(key, len);
return h & (m->bucket_cap - 1); /* 要求 bucket_cap 是 2 的幂 */
}
/* 在桶链中线性查找 */
static Node *find_in_chain(Node *head, const char *key) {
for (; head; head = head->next) {
if (strcmp(head->key, key) == 0) {
return head;
}
}
return NULL;
}
/* 扩容2× 桶数,重新哈希所有节点 */
static void map_resize(Map *m) {
size_t new_cap = m->bucket_cap * 2;
Node **new_bucket = calloc(new_cap, sizeof(Node *));
for (size_t i = 0; i < m->bucket_cap; ++i) {
Node *node = m->bucket[i];
while (node) {
Node *next = node->next;
size_t idx =
hash_bytes(node->key, strlen(node->key)) & (new_cap - 1);
node->next = new_bucket[idx];
new_bucket[idx] = node;
node = next;
}
}
free(m->bucket);
m->bucket = new_bucket;
m->bucket_cap = new_cap;
}
/* 插入或覆盖 */
void map_put(Map *m, const char *key, const void *value) {
if (m->size * 4 >= m->bucket_cap * 3) { /* 装载因子 0.75 */
map_resize(m);
}
size_t idx = bucket_index(m, key);
Node *node = find_in_chain(m->bucket[idx], key);
if (node) { /* 覆盖旧值 */
memcpy(node->value, value, m->value_len);
return;
}
/* 新建节点 */
node = malloc(sizeof(*node));
node->value = malloc(m->value_len);
node->next = m->bucket[idx];
node->key = malloc(strlen(key) + 1);
memcpy(node->key, key, strlen(key) + 1);
memcpy(node->value, value, m->value_len);
m->bucket[idx] = node;
++m->size;
}
/* 查找 */
void *map_get(Map *m, const char *key) {
size_t idx = bucket_index(m, key);
Node *node = find_in_chain(m->bucket[idx], key);
return node ? node->value : NULL;
}
/* 删除 */
bool map_erase(Map *m, const char *key) {
size_t idx = bucket_index(m, key);
Node **link = &m->bucket[idx];
for (; *link; link = &(*link)->next) {
if (strcmp((*link)->key, key) == 0) {
Node *to_del = *link;
*link = to_del->next;
free(to_del->key);
free(to_del->value);
free(to_del);
--m->size;
return true;
}
}
return false;
}
/* 销毁 */
void map_destroy(Map *m) {
for (size_t i = 0; i < m->bucket_cap; ++i) {
Node *node = m->bucket[i];
while (node) {
Node *next = node->next;
free(node->key);
free(node->value);
free(node);
node = next;
}
}
free(m->bucket);
free(m);
}
/* 遍历 */
void map_foreach(Map *m,
void (*callback)(const char *key,
void *value,
void *user_data),
void *user_data) {
for (size_t i = 0; i < m->bucket_cap; ++i) {
Node *node = m->bucket[i];
while (node) {
callback(node->key, node->value, user_data);
node = node->next;
}
}
}

45
src/utils/logging-map.h Normal file
View File

@@ -0,0 +1,45 @@
#ifndef __LOGGING_MAP_H__
#define __LOGGING_MAP_H__
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
typedef struct Node {
struct Node *next;
char *key;
void *value;
} Node;
struct Map {
size_t value_len;
size_t bucket_cap;
size_t size; /* 当前元素个数 */
Node **bucket; /* 指针数组 */
};
typedef struct Map Map;
/* 创建空 mapkey_len/value_len 以字节为单位 */
Map *map_create(size_t value_len);
/* 插入或覆盖:<key> 必须指向 key_len 字节;同理 value */
void map_put(Map *m, const char *key, const void *value);
/* 查找:找到返回 value 指针;未找到返回 NULL */
void *map_get(Map *m, const char *key);
/* 删除:返回 true 表示确实删掉了 */
bool map_erase(Map *m, const char *key);
/* 遍历: 遍历所有元素*/
void map_foreach(Map *m,
void (*callback)(const char *key,
void *value,
void *user_data),
void *user_data);
/* 销毁并释放所有内存 */
void map_destroy(Map *m);
#endif /* __LOGGING_MAP_H__ */

View File

@@ -2,6 +2,8 @@ project(test)
enable_testing() enable_testing()
include_directories(${CMAKE_SOURCE_DIR}/src)
#测试简单基本应用 #测试简单基本应用
add_executable(${PROJECT_NAME}simple test-simple.c) add_executable(${PROJECT_NAME}simple test-simple.c)
target_link_libraries(${PROJECT_NAME}simple logging) target_link_libraries(${PROJECT_NAME}simple logging)
@@ -17,3 +19,13 @@ add_test(test_file ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}file${CMAKE_EXECUT
add_executable(${PROJECT_NAME}filter test-filter.c) add_executable(${PROJECT_NAME}filter test-filter.c)
target_link_libraries(${PROJECT_NAME}filter logging) target_link_libraries(${PROJECT_NAME}filter logging)
add_test(test_filter ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}filter${CMAKE_EXECUTEABLE_SUFFIX}) add_test(test_filter ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}filter${CMAKE_EXECUTEABLE_SUFFIX})
#测试多log多次获取
add_executable(${PROJECT_NAME}logs test-logs.c)
target_link_libraries(${PROJECT_NAME}logs logging)
add_test(test_logs ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}logs${CMAKE_EXECUTEABLE_SUFFIX})
#测试工具map
add_executable(${PROJECT_NAME}map test-map.c)
target_link_libraries(${PROJECT_NAME}map logging)
add_test(test_map ${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}map${CMAKE_EXECUTEABLE_SUFFIX})

View File

@@ -6,8 +6,6 @@
#include <time.h> #include <time.h>
int main() { int main() {
Logger *logger = newDefaultLogger(__FILE__, LOG_DEBUG);
Log_info("This is an info message"); Log_info("This is an info message");
Log_error("This is an error message%s", "123"); Log_error("This is an error message%s", "123");
Log_fatal("This is an fatal message"); Log_fatal("This is an fatal message");
@@ -22,7 +20,7 @@ int main() {
loggingHandlerFile("test_interceptor", 1024 * 1024), loggingHandlerFile("test_interceptor", 1024 * 1024),
false); false);
logger->addFilter(tint); addFilter(getDefaultLogger(), tint);
char *test2[] = {"123", NULL}; char *test2[] = {"123", NULL};
@@ -32,7 +30,7 @@ int main() {
loggingHandlerFile("test_interceptor1", 1024 * 1024), loggingHandlerFile("test_interceptor1", 1024 * 1024),
true); true);
logger->addFilter(tint1); addFilter(getDefaultLogger(), tint1);
printf("\n"); printf("\n");
printf("filter added\n"); printf("filter added\n");

View File

@@ -2,9 +2,8 @@
#include "logging/logging-handler.h" #include "logging/logging-handler.h"
int main() { int main() {
Logger *logger = newDefaultLogger("testLogger", LOG_DEBUG);
log_Handler *hander = loggingHandlerFile("test_log", 1024 * 1024 * 10); log_Handler *hander = loggingHandlerFile("test_log", 1024 * 1024 * 10);
logger->addHandler(hander); addHandler(getDefaultLogger(), hander);
Log_info("This is an info message"); Log_info("This is an info message");
Log_error("This is an error message%s", "123"); Log_error("This is an error message%s", "123");

24
tests/test-logs.c Normal file
View File

@@ -0,0 +1,24 @@
#include "logging.h"
#include "logging/logging-core.h"
#include <stdio.h>
int main() {
Logger *t1 = getLogger("Test1");
t1->level = LOG_ERROR;
Logger *t2 = getLogger("Test2");
t2->level = LOG_DEBUG;
Logger *t11 = getLogger("Test1");
if (t1 == t11) {
printf("t1 and t11 are the same\n");
printf("t1 log level: %s", LOG_LEVEL_STR[t11->level]);
} else {
printf("t1 and t11 are different\n");
return 1;
}
destroyDefaultLogger();
return 0;
}

37
tests/test-map.c Normal file
View File

@@ -0,0 +1,37 @@
#include "utils/logging-map.h"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
void foreach_callback(const char *key, void *value, void *user_data) {
(void)user_data;
printf("foreach key: %s, value: %d\n", key, *(int *)value);
}
int main(int argc, char *argv[]) {
(void)argc;
(void)argv;
Map *map = map_create(sizeof(int));
const char *keys[] = {"key1", "key22", "key33", "key44", "key55"};
for (int i = 0; i < 5; i++) {
printf("put key %s,value %d\n", keys[i], i);
map_put(map, keys[i], &i);
}
for (int i = 0; i < 5; i++) {
int *value = map_get(map, keys[i]);
printf("get value: %d\n", *value);
if (*value != i) {
return 1;
}
}
map_foreach(map, foreach_callback, NULL);
map_destroy(map);
return 0;
}

View File

@@ -1,8 +1,6 @@
#include "logging.h" #include "logging.h"
int main() { int main() {
Logger *logger = newDefaultLogger(__FILE__, LOG_DEBUG);
Log_info("This is an info message"); Log_info("This is an info message");
Log_error("This is an error message%s", "123"); Log_error("This is an error message%s", "123");
Log_fatal("This is an fatal message"); Log_fatal("This is an fatal message");