Introduction 中文介绍

What's this: This is a C tool library (works for unix(android)/windows).

note: the interface is relatively stable and will not be changed frequently at this stage. see commits log for more details, see latest code on develop branch.

---

Components

• log

  print log to file/console/logcat(if on Android) at the same time, of course you can config it.

  • logger : a logger facade. xlog and slog implement it
  • xlog : support print level/tag/tid/time with log message
  • slog : simple log, only print level/tag with log message

• thread

  posix style thread/semaphore api on windows(thanks for pthread-win32).

• data

  common data structure and operation: include array, hashmap, list, base64 ...

• file

  file util: include file_util_read/write, ini_reader/parser ...

• memory

  • string : include asprintf, stringbuilder, str_params, strlcpy, strlcat, strreplace, strsplit, strtrim, strutf8len ...
  • allocator : can trace heap memory, help you find memory leak or memory corruption.
  • mplite : a zero-malloc memory pool based on SQLite's memsys5 memory subsystem

• ring_buffer

  queue of ring: include ringbuffer, ring_msg_queue, msg_queue_handler, autocover_buffer ...

• time

  time_util: include current_milliseconds, fast_second2date ...

---

How to build

• common platforms (windows/linux/android)

  go to tool folder, and edit setup env script first(setup_env.bat/setup_env.sh) (for make sure cmake/ninja/ndk(for Android) location), then execute script to build it, it will copy the compiled product to the specified location

  for example:

  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

  there 3 way to integration pthread on windows：

  • 0: implementing the pthread interface using the windows api
  • 1: use pthread static library. if you use static library, don't forget dependency pthread lib
  • 2: use pthread dynamic library. you should place pthread dll on your project

• other platforms (cross-compilation)

  1. first, write cmake cross-compilation toolchain file on tool/cmake/toolchains folder:

  for define c/cxx compiler location and flags.

  example: create hisi.toolchain.cmake file on tool/cmake/toolchains folder, and write some config like this:

  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

  2. then execute cmake build script:

  for generate makefile and compile it

  example: go to tool folder, execute command:

  ./make_cross_platform.sh hisi Release

  if target platform(toolchain) only support compile static library, follow these steps:

  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

How to use

copy header and lib(static or shared) to your project, and link it, or just copy source and header file to your project.

Demo

see src_demo folder, it demonstrate to you simple use case.

License

This library is free software; you can redistribute it and or modify it under the terms of the Apache License 2.0

Contact me

email: hsjfox@foxmail.com

---

Release Log

• 1.8.0

  1. feat: support thread ready/about to stop status information for hook msg_queue_handler/fix_msg_queue_handler
  2. feat: support setting prefix and suffix for LOG-TAG, for example, on Android, it is easy to filter out all TAG logs of the process based on the prefix
  3. update: compilation script supports automatic search for the location of tools such as cmake/ninja/NDK, and supports batch compilation
  4. fix: fix mkdir does not grant write permissions to other users on Unix

• 1.7.0

  1. added: portable_thread.h thread abstraction layer to facilitate porting thread function implementations on different platforms
  2. update: make_cross_platform.sh supports automatically loading cross-compilation files (toolchain.cmake) and compiling.

• 1.6.0

  1. update: add pthread-win32 static library and dynamic library, Windows compilation supports 3 types of pthread dependency (0/1/2)
  2. fix: in Windows, include <windows.h> reports C5105 warning
  3. update: rename build folder to tool, automatically configure the file line ending type in gitattributes
  4. fix: lock xlog printing to avoid potential timeline issues caused by multi-threaded competition printing

• 1.5.6

  1. fix：when time_util hit cache, fmt_len over calculated.
  2. update: inih code, rename "ini_" to "ini_reader_", for prevent conflict with other projects
  3. added：cmake script support define PLATFORM and PLATFORM_ABI, format output dir structure
  4. feat: xlog support lock to enusure printing order on multi target
  5. add: README_zh-CN.md

• 1.5.5

  1. add more simple win32 pthread function(build with PRJ_WIN_PTHREAD_MODE=1)
  2. fix xlog macro wrong call
  3. support various visual studio version on windows build script

• 1.5.3

  1. add logger_facade, and xlog/slog implement it
  2. improve xlog performance: use our method to print function name and line number
  3. windows dll truly export all symbols( this feature supported by cmake )

• 1.5.2

  1. improve time_util_get_current_time_str performance
  2. improve xlog performance
  3. add flush mode on xlog

• 1.4.1

  1. add msg_queue/msg_queue_handler: support various msg
  2. rename old msg_queue/msg_queue_handler to fixed_msg_queue/fixed_msg_queue_handler
  3. extract msg_queue_errno to header.

• 1.0.0 ~ 1.4.0

  Release log not record on here, see commit log for more details. btw: suggest use the latest code for example, ver 1.4.0 commit log url is https://github.com/wind0ws/libcutils/commits/1.4.0