C/C++ 跨平台(android/unix/windows)工具库(xlog日志)，支持log打印、检测内存泄露

thresh0ld

已于 2024-05-31 19:24:40 修改

阅读量692

点赞数 9

分类专栏： C Android c++ 文章标签： c语言开发语言 c++ windows github android-studio linux

于 2023-12-15 16:21:47 首次发布

本文链接：https://blog.csdn.net/hsjMichael/article/details/135020073

版权

Android 同时被 3 个专栏收录

4 篇文章 0 订阅

订阅专栏

1 篇文章 0 订阅

订阅专栏

c++

1 篇文章 0 订阅

订阅专栏

项目源码链接：点击这里 --> libcutils

背景：

最初是因为在 android/linux/windows 等平台打log时没有一致化的log打印体验： windows/linux只有printf，直接打印不能自动换行、也没有TAG/时间戳/TID，分析问题日志极为不便，遂开发了xlog来实现多平台输出log格式一致化，均与 android 的 logcat 格式相同。
另外开发了 queue/base64/list/map/ringbuffer/msg_queue/msg_queue_handler 等一些常用组件.
lcu库不求大而全，力求精简实用，包含常用操作：队列、跨平台线程调用、锁、信号量、日志打印、内存检测等功能
当下已有tbox等优秀C开源库，之所以造新的轮子还是因为有些东西不满足项目需求，所以自己造自己的轮子。

简介

这是一个通用C工具库，支持 unix(android)/windows 等平台

当前api比较稳定，不会经常改动。详情请见commit提交日志, 最新代码请看develop分支

组件

log

支持同时打印日志到 file/console/logcat(Android), 也支持配置日志输出格式、等级.
- logger : logger门面. xlog 和 slog 实现它定义的宏
- xlog : 支持打印 level/tag/tid/time 这些log头和日志信息
- slog : 简易log实现，实际上是对printf的二次包装, 只支持打印level/TAG和日志信息
thread

支持Windows上使用posix风格的线程/信号量（thread/semaphore）接口(感谢 pthread-win32).
data

常用数据结构和操作接口: array, hashmap, list, base64 …
file

常用文件操作: file_util_read/write, ini_reader/parser …
memory
- string : asprintf, stringbuilder, str_params, strlcpy, strlcat, strreplace, strsplit, strtrim, strutf8len …
- allocator : 跟踪和检测heap内存，帮助你提早发现内存泄露和踩内存等问题.
- mplite : 内存池实现 SQLite’s memsys5 memory subsystem
ring_buffer

环形队列: ringbuffer, ring_msg_queue, msg_queue_handler, autocover_buffer …
time

常用时间操作: current_milliseconds, fast_second2date …

编译

常用平台 (windows/linux/android)

进入 tool 文件夹, 编辑环境路径脚本（setup_env.bat/setup_env.sh）
(为了设置 cmake/ninja/ndk(for Android) 等工具的路径位置),
然后执行脚本来编译, 编译完后会将产物拷贝到指定的位置

简要示例:

platform	onekey deploy build	manual build
windows	`deploy_for_windows.bat Release`	`make_windows.bat Win32 Release 1`
linux	`chmod +x *.sh && ./deploy_for_linux.sh Release`	`chmod +x *.sh && ./make_cross_platform.sh linux m64 Release`
android	`deploy_for_android.bat Release c++_static`	`make_android.bat armeabi-v7a Release`

windows 平台 posix pthread 实现方式有三种:

0: 使用 windows api 模拟实现 pthread 接口
1: 使用 pthread 静态库。如果你使用 lcu 静态库，记得还需要依赖这个 pthread 静态库
2: 使用 pthread 动态库。在你使用 lcu 库的工程运行目录里记得放 pthread 的dll

其他平台 (交叉编译)

首先，在 tool/cmake/toolchains 文件夹下写cmake交叉编译规则文件:

定义 c/cxx 编译器位置和平台编译参数.

示例: 在 tool/cmake/toolchains 文件夹下创建 hisi.toolchain.cmake 文件,
然后写一些类似下面的交叉编译配置信息:

SET(UNIX TRUE CACHE BOOL "")
SET(CMAKE_SYSTEM_NAME Linux) # this one is important
SET(CMAKE_SYSTEM_VERSION 1)  # this one not so much
# Tell the cmake script what the platform name is, must setup this for cross compile
SET(PLATFORM hisi)           # important: tell script the platform name

SET(CROSS_TOOLCHAIN_DIR "/root/toolchains/hisi-linux/x86-arm/arm-himix100-linux")
SET(CROSS_TOOLCHAIN_PATH_PREFIX "${CROSS_TOOLCHAIN_DIR}/bin/arm-himix100-linux-")
message(STATUS "current CROSS_TOOLCHAIN_PATH_PREFIX is => ${CROSS_TOOLCHAIN_PATH_PREFIX}")

#set compiler location
SET(CMAKE_C_COMPILER "${CROSS_TOOLCHAIN_PATH_PREFIX}gcc")
SET(CMAKE_CXX_COMPILER "${CROSS_TOOLCHAIN_PATH_PREFIX}g++")
SET(CMAKE_AR "${CROSS_TOOLCHAIN_PATH_PREFIX}ar")
SET(CMAKE_LINKER "${CROSS_TOOLCHAIN_PATH_PREFIX}ld")
SET(CMAKE_RANLIB "${CROSS_TOOLCHAIN_PATH_PREFIX}ranlib")
SET(CMAKE_STRIP "${CROSS_TOOLCHAIN_PATH_PREFIX}strip")

SET(CMAKE_FIND_ROOT_PATH  ${CROSS_TOOLCHAIN_DIR})
# Sysroot.
set(CMAKE_SYSROOT "${CROSS_TOOLCHAIN_DIR}/sysroot")
# search for programs in the build host directories
SET(CMAKE_FIND_ROOT_PATH_MODE_PROGRAM NEVER)
# for libraries and headers in the target directories
SET(CMAKE_FIND_ROOT_PATH_MODE_LIBRARY ONLY)
SET(CMAKE_FIND_ROOT_PATH_MODE_INCLUDE ONLY)

SET(PLATFORM_COMMON_FLAGS " -fPIC")
string(APPEND CMAKE_C_FLAGS          "${PLATFORM_COMMON_FLAGS}")
string(APPEND CMAKE_CXX_FLAGS        "${PLATFORM_COMMON_FLAGS}")
string(APPEND CMAKE_EXE_LINKER_FLAGS "${PLATFORM_COMMON_FLAGS} -fPIE")
add_definitions(-D_LCU_NOT_SUPPORT_PTHREAD_SETNAME) # custom compile definitions

执行 cmake 命令编译:

生成makefile并编译

示例: 进入 tool 文件夹里，执行命令:

./make_cross_platform.sh hisi Release

若平台(编译链)仅支持编译静态库，可以这么来编译:

cmake -H. -B./build_abcd -DBUILD_STATIC_LIBS=ON -DBUILD_SHARED_LIBS=OFF -DBUILD_DEMO=OFF -DCMAKE_TRY_COMPILE_TARGET_TYPE=STATIC_LIBRARY -DCMAKE_TOOLCHAIN_FILE=./cmake/toolchains/abcd.toolchain.cmake
cmake --build ./build_abcd --config Release --target lcu_static

使用

拷贝头文件和库（动态或静态）文件到你的项目中，并链接他们，或者直接拷贝源码到你的项目中。

示例

请看 src_demo 目录，每个模块有对应的测试用例.

许可证

本库是免费软件; 你可以根据Apache2.0许可证的条款重新分发或修改它. 详情请见 Apache License 2.0

联系方式

邮箱: hsjfox@foxmail.com

更新日志

1.8.0
1. 新增: 支持hook msg_queue_handler/fix_msg_queue_handler 的线程就绪/即将停止状态信息
2. 新增: 支持对 LOG_TAG 设置前缀后缀，比如在Android上就可以轻松根据前缀过滤出进程所有的TAG日志
3. 更新: 编译脚本支持自动查找 cmake/ninja/NDK 等工具的位置，支持批量编译
4. 修复: fix mkdir在unix上没有对其他用户赋予写入权限的问题
1.7.0
1. 新增: portable_thread.h 线程抽象层，方便移植不同平台的线程函数实现
2. 更新: make_cross_platform.sh 支持自动加载交叉编译文件（toolchain.cmake）并编译。
1.6.0
1. 更新: 添加 pthread-win32 静态库和动态库，Windows编译支持3种pthread依赖方式（0/1/2）
2. 修复: 在Windows下 include <windows.h> 报 C5105 警告
3. 更新: build文件夹重命名为tool，gitattributes自动配置文件换行符类型
4. 修复: xlog打印加锁，避免潜在的多线程竞争打印造成的时间线问题
1.5.6
1. 修复: time_util在命中时间cache时，多算了fmt_len的问题
2. 更新: inih同步更新，重命名inih方法“ini_”到“ini_reader_”, 防止与其他项目冲突
3. 新增: cmake脚本支持定义PLATFORM和PLATFORM_ABI, 统一化输出文件夹
4. 新增: xlog支持锁，在多target打印上保持一致的顺序
5. 新增: 中文文档
1.5.5
1. 新增: simple win32 pthread添加了更多的支持方法 (编译传参 PRJ_WIN_PTHREAD_MODE=1).
2. 修复: xlog 宏调用接口错误.
3. 新增: windows编译脚本支持更多版本的 visual studio.
1.5.3
1. 新增: logger_facade, xlog/slog 实现这个log门面.
2. 特性: 提高xlog 性能: 使用自定义的打印方法名和行数函数.
3. 修复: windows dll 导出符号问题 (借助cmake功能实现).
1.5.2
1. 特性: 提高 time_util_get_current_time_str 性能.
2. 特性: 提高 xlog 性能.
3. 新增: xlog添加flush模式，支持自动flush（默认）和每次print后flush.
1.4.1
1. 新增: 添加 msg_queue/msg_queue_handler: 支持各种msg类型
2. 重构: 重命名 msg_queue/msg_queue_handler 为 fixed_msg_queue/fixed_msg_queue_handler
3. 重构: 提取 msg_queue_errno 到头文件.
1.0.0 ~ 1.4.0

这里没有记录详细日志, 详情请见提交日志. BTW: 建议使用最新版本
示例: 1.4.0 版本的URL是 https://github.com/wind0ws/libcutils/commits/1.4.0