Merge pull request #31 from lkpworkspace/dev

v0.9.2
- feature
  - 支持编写进程间/机器间通信组件并添加示例
  - 支持docker
  - 支持deb打包
  - 子模块支持deb打包
- api
  - Send/SendRequest方法删除dst_addr参数
- other
  - 消息调度线程timeout从1000ms减小到100ms

Author: lkpworkspace

.github/workflows/linux.yml

@@ -87,6 +87,7 @@ jobs:
           cmake -S . -B ${{github.workspace}}/build_${{matrix.build_type}} \
             -DCMAKE_CXX_STANDARD=${{matrix.std}} \
             -DCMAKE_CXX_STANDARD_REQUIRED=ON \
+            -DMYFRAME_USE_CV=OFF \
             -DCMAKE_BUILD_TYPE=${{matrix.build_type}} \
             -DCMAKE_PREFIX_PATH="${{github.workspace}}/jsoncpp;${{github.workspace}}/glog" \
             -DCMAKE_INSTALL_PREFIX=${{github.workspace}}/install \

CMakeLists.txt

@@ -1,12 +1,15 @@
 cmake_minimum_required(VERSION 3.10)
-project(myframe VERSION 0.9.1)
+project(myframe VERSION 0.9.2)
 
 ### option
-option(MYFRAME_USE_CV "Using conditional variables for thread communication" OFF)
-option(MYFRAME_INSTALL_DEPS "Install deps" ON)
+option(MYFRAME_USE_CV "Using conditional variables for thread communication" ON)
+option(MYFRAME_INSTALL_DEPS "Install deps" OFF)
 option(MYFRAME_GENERATE_EXAMPLE "Generate example library" ON)
 option(MYFRAME_GENERATE_TEST "Generate test executable program" ON)
 
+### cmake module
+set(CMAKE_MODULE_PATH "${CMAKE_SOURCE_DIR}/cmake")
+
 ### compile option
 set(CMAKE_C_VISIBILITY_PRESET hidden)
 set(CMAKE_CXX_VISIBILITY_PRESET hidden)
@@ -20,16 +23,9 @@ else()
   message(STATUS "Set default cxx standard 17")
 endif()
 
-### output path
-set(MYFRAME_OUTPUT_ROOT "${CMAKE_BINARY_DIR}/output")
-set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${MYFRAME_OUTPUT_ROOT}/lib)
-set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${MYFRAME_OUTPUT_ROOT}/lib)
-set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${MYFRAME_OUTPUT_ROOT}/bin)
-
 ### install path
 if (CMAKE_INSTALL_PREFIX_INITIALIZED_TO_DEFAULT)
-  set(CMAKE_INSTALL_PREFIX "$ENV{HOME}/${CMAKE_PROJECT_NAME}" CACHE PATH "myframe default install prefix" FORCE)
-  message(STATUS "Set default install prefix $ENV{HOME}/${CMAKE_PROJECT_NAME}")
+  message(STATUS "Set default install prefix ${CMAKE_INSTALL_PREFIX}")
 else()
   message(STATUS "Set install prefix ${CMAKE_INSTALL_PREFIX}")
 endif()
@@ -46,90 +42,41 @@ find_package(Threads REQUIRED)
 find_package(jsoncpp REQUIRED)
 find_package(glog REQUIRED)
 
-link_libraries(
-  Threads::Threads
-  ${CMAKE_DL_LIBS}
-  glog::glog
-  jsoncpp_lib
-)
-
-### include dir
-include_directories(.)
-
 ### sub directory
 add_subdirectory(myframe)
 add_subdirectory(launcher)
 if (MYFRAME_GENERATE_EXAMPLE)
-    add_subdirectory(examples)
+  add_subdirectory(examples)
 endif()
 if (MYFRAME_GENERATE_TEST)
-    add_subdirectory(test)
+  add_subdirectory(test)
 endif()
 
 ### install file/dir
 install(FILES
-    "LICENSE"
-    PERMISSIONS OWNER_READ GROUP_READ WORLD_READ
-    DESTINATION .
+  "LICENSE"
+  PERMISSIONS
+  OWNER_READ OWNER_WRITE
+  GROUP_READ
+  WORLD_READ
+  DESTINATION .
+)
+install(PROGRAMS
+  "tools/gen_mod_proj.py"
+  DESTINATION ${MYFRAME_BIN_DIR}
 )
 install(DIRECTORY templates DESTINATION .)
-install(DIRECTORY tools DESTINATION .)
-install(DIRECTORY conf DESTINATION .)
 install(DIRECTORY DESTINATION ${MYFRAME_LOG_DIR})
 install(DIRECTORY DESTINATION ${MYFRAME_SERVICE_DIR})
-install(CODE "
-  file(
-    WRITE ${CMAKE_INSTALL_PREFIX}/version.txt
-    \"${${PROJECT_NAME}_VERSION_MAJOR}.${${PROJECT_NAME}_VERSION_MINOR}.${${PROJECT_NAME}_VERSION_PATCH}\"
-  )
-")
 if (MYFRAME_INSTALL_DEPS)
-if (${CMAKE_VERSION} VERSION_GREATER_EQUAL "3.21")
-  install(IMPORTED_RUNTIME_ARTIFACTS jsoncpp_lib)
-  install(IMPORTED_RUNTIME_ARTIFACTS glog::glog)
-  install(IMPORTED_RUNTIME_ARTIFACTS gflags)
-endif()
+  if (${CMAKE_VERSION} VERSION_GREATER_EQUAL "3.21")
+    install(IMPORTED_RUNTIME_ARTIFACTS jsoncpp_lib)
+    install(IMPORTED_RUNTIME_ARTIFACTS glog::glog)
+    install(IMPORTED_RUNTIME_ARTIFACTS gflags)
+  else()
+    message(WARNING "Can not install deps lib, cmake version ${CMAKE_VERSION} < 3.21")
+  endif()
 endif()
 
 ### package
-include(InstallRequiredSystemLibraries)
-set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE")
-set(CPACK_PACKAGE_VERSION_MAJOR "${${PROJECT_NAME}_VERSION_MAJOR}")
-set(CPACK_PACKAGE_VERSION_MINOR "${${PROJECT_NAME}_VERSION_MINOR}")
-set(CPACK_PACKAGE_VERSION_PATCH "${${PROJECT_NAME}_VERSION_PATCH}")
-include(CPack)
-
-### export cmake file
-install(EXPORT "${PROJECT_NAME}Targets"
-  FILE "${PROJECT_NAME}Targets.cmake"
-  DESTINATION lib/cmake/${PROJECT_NAME}
-)
-
-include(CMakePackageConfigHelpers)
-# generate the config file that is includes the exports
-configure_package_config_file(${CMAKE_CURRENT_SOURCE_DIR}/Config.cmake.in
-  "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake"
-  INSTALL_DESTINATION "lib/cmake/${PROJECT_NAME}"
-  NO_SET_AND_CHECK_MACRO
-  NO_CHECK_REQUIRED_COMPONENTS_MACRO
-)
-
-# generate the version file for the config file
-write_basic_package_version_file(
-  "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake"
-  VERSION "${PROJECT_VERSION}"
-  COMPATIBILITY SameMinorVersion
-)
-
-# install the configuration file
-install(FILES
-  "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake"
-  "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake"
-  DESTINATION lib/cmake/${PROJECT_NAME}
-)
-
-# generate the export targets for the build tree
-# needs to be after the install(TARGETS ) command
-export(EXPORT "${PROJECT_NAME}Targets"
-  FILE "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Targets.cmake"
-)
+include(Packing)

Config.cmake.in

@@ -25,11 +25,6 @@ worker自驱动，可以通过消息与actor交互;
 * [github ci windows](.github/workflows/windows.yml)
 * [github ci macOS](.github/workflows/macos.yml)
 
-## 运行所有的example
-```sh
-path/to/myframe/bin/launcher -p app
-```
-
 ### Hello,World 示例
 ```c
 #include <string.h>

README.md

@@ -0,0 +1,34 @@
+# export cmake file
+install(EXPORT "${PROJECT_NAME}Targets"
+  FILE "${PROJECT_NAME}Targets.cmake"
+  DESTINATION lib/cmake/${PROJECT_NAME}
+)
+
+include(CMakePackageConfigHelpers)
+# generate the config file that is includes the exports
+configure_package_config_file(${CMAKE_CURRENT_SOURCE_DIR}/Config.cmake.in
+  "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake"
+  INSTALL_DESTINATION "lib/cmake/${PROJECT_NAME}"
+  NO_SET_AND_CHECK_MACRO
+  NO_CHECK_REQUIRED_COMPONENTS_MACRO
+)
+
+# generate the version file for the config file
+write_basic_package_version_file(
+  "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake"
+  VERSION "${PROJECT_VERSION}"
+  COMPATIBILITY SameMinorVersion
+)
+
+# install the configuration file
+install(FILES
+  "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Config.cmake"
+  "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}ConfigVersion.cmake"
+  DESTINATION lib/cmake/${PROJECT_NAME}
+)
+
+# generate the export targets for the build tree
+# needs to be after the install(TARGETS ) command
+export(EXPORT "${PROJECT_NAME}Targets"
+  FILE "${CMAKE_CURRENT_BINARY_DIR}/${PROJECT_NAME}Targets.cmake"
+)

cmake/InstallingConfigs.cmake

@@ -0,0 +1,29 @@
+include(InstallRequiredSystemLibraries)
+
+set(CPACK_PACKAGE_NAME ${PROJECT_NAME} CACHE STRING "The resulting package name")
+set(CPACK_PACKAGE_DESCRIPTION_SUMMARY "C++ application framework"
+    CACHE STRING "Package description for the package metadata"
+)
+set(CPACK_STRIP_FILES YES)
+set(CPACK_INSTALL_DEFAULT_DIRECTORY_PERMISSIONS
+    OWNER_READ OWNER_WRITE OWNER_EXECUTE
+    GROUP_READ GROUP_EXECUTE
+    WORLD_READ WORLD_EXECUTE
+)
+set(CPACK_PACKAGE_VERSION_MAJOR ${PROJECT_VERSION_MAJOR})
+set(CPACK_PACKAGE_VERSION_MINOR ${PROJECT_VERSION_MINOR})
+set(CPACK_PACKAGE_VERSION_PATCH ${PROJECT_VERSION_PATCH})
+set(CPACK_PACKAGE_CONTACT "[email protected]")
+set(CPACK_RESOURCE_FILE_LICENSE "${CMAKE_CURRENT_SOURCE_DIR}/LICENSE")
+set(CPACK_RESOURCE_FILE_README "${CMAKE_CURRENT_SOURCE_DIR}/README.md")
+
+# group
+set(CPACK_COMPONENTS_GROUPING ALL_COMPONENTS_IN_ONE)
+
+# deb
+set(CPACK_DEBIAN_PACKAGE_MAINTAINER "likepeng <${CPACK_PACKAGE_CONTACT}>")
+set(CPACK_DEBIAN_FILE_NAME DEB-DEFAULT)
+set(CPACK_DEB_COMPONENT_INSTALL YES)
+set(CPACK_DEBIAN_PACKAGE_SHLIBDEPS YES)
+
+include(CPack)

cmake/Packing.cmake

@@ -54,7 +54,7 @@
 
 ### 创建组件工程
 ```sh
-python3 path/to/myframe/tools/gen_mod_proj.py --dir="path/to/proj_dir/" --name="mod_name"
+python path/to/myframe/bin/gen_mod_proj.py --dir="path/to/proj_dir/" --name="mod_name"
 ```
 
 ### 组件工程目录说明
@@ -66,7 +66,8 @@ python3 path/to/myframe/tools/gen_mod_proj.py --dir="path/to/proj_dir/" --name="
 
 ### 组件工程构建安装
 ```sh
-cmake -S . -B build -DCMAKE_INSTALL_PREFIX="path/to/myframe" -DCMAKE_PREFIX_PATH="path/to/jsoncpp;path/to/glog"
+# 如果myframe库和依赖库安装到系统目录里，则不需要设置CMAKE_PREFIX_PATH变量
+cmake -S . -B build -DCMAKE_PREFIX_PATH="path/to/myframe;path/to/jsoncpp;path/to/glog"
 cmake --build build --config Release --target install
 ```
 

doc/development_guide.md

@@ -0,0 +1,33 @@
+# myframe docker
+主要用于创建myframe docker容器镜像；
+包含编译好的myframe，可以运行example，benchmark和创建运行组件工程。
+
+## 目录
+myframe安装目录：`/usr/local`
+
+## docker操作
+```sh
+# eg:
+#   arch: < aarch64 | amd64 >
+#   myframe_version: 0.9.1
+
+## 构建docker镜像
+bash docker_build.bash <myframe_version>
+
+## 下载docker镜像
+docker pull docker.io/likepeng0418/myframe:<arch>-<myframe_version>
+
+## 创建运行docker容器
+docker run -itd \
+    --name "myframe_run" \
+    myframe:${<arch>-<myframe_version>} \
+    /bin/bash
+
+## 进入docker容器
+docker exec -it \
+    -it "myframe_run" \
+    /bin/bash
+```
+
+## 在docker中开发
+[开发手册](../doc/development_guide.md)

docker/README.md

@@ -0,0 +1,46 @@
+FROM docker.io/library/ubuntu:22.04
+SHELL ["/bin/bash", "-c"]
+
+ENV DEBIAN_FRONTEND noninteractive
+ARG cpu_arch=unknown
+COPY docker/ubuntu2204_${cpu_arch}.sourcelist /etc/apt/sources.list
+# RUN yes | unminimize
+RUN apt update \
+    && apt  install -y --no-install-recommends \
+    build-essential cmake \
+    wget python3 vim \
+    libunwind-dev libgflags-dev
+
+WORKDIR /tmp
+RUN wget -q --content-disposition --no-check-certificate \
+    https://github.com/open-source-parsers/jsoncpp/archive/refs/tags/1.9.5.tar.gz
+RUN tar -xf jsoncpp-1.9.5.tar.gz \
+ && cmake -S jsoncpp-1.9.5 -B build-jsoncpp \
+    -DCMAKE_INSTALL_PREFIX=/usr/local \
+    -DBUILD_OBJECT_LIBS=OFF \
+    -DJSONCPP_WITH_TESTS=OFF \
+    -DJSONCPP_WITH_POST_BUILD_UNITTEST=OFF \
+    -DJSONCPP_WITH_PKGCONFIG_SUPPORT=OFF \
+ && cmake --build build-jsoncpp --target install \
+ && rm -rf jsoncpp-1.9.5.tar.gz jsoncpp-1.9.5 build-jsoncpp
+
+RUN wget -q --content-disposition --no-check-certificate \
+    https://github.com/google/glog/archive/refs/tags/v0.6.0.tar.gz
+RUN tar -xf glog-0.6.0.tar.gz \
+ && cmake -S glog-0.6.0 -B build-glog \
+    -DCMAKE_INSTALL_PREFIX=/usr/local \
+    -DWITH_PKGCONFIG=OFF \
+    -DWITH_GTEST=OFF \
+ && cmake --build build-glog --target install \
+ && rm -rf glog-0.6.0.tar.gz glog-0.6.0 build-glog
+
+ARG myframe_version=latest
+RUN wget -q --content-disposition --no-check-certificate \
+    https://github.com/lkpworkspace/myframe/archive/refs/tags/v${myframe_version}.tar.gz
+RUN tar -xf myframe-${myframe_version}.tar.gz
+RUN cmake -S myframe-${myframe_version} -B build-myframe \
+    -DCMAKE_CXX_STANDARD=17 \
+    -DCMAKE_CXX_STANDARD_REQUIRED=ON \
+    -DCMAKE_INSTALL_PREFIX=/usr/local \
+ && cmake --build build-myframe --target install \
+ && rm -rf myframe-${myframe_version}.tar.gz myframe-${myframe_version} build-myframe

docker/dev.dockerfile

@@ -0,0 +1,53 @@
+#!/usr/bin/env bash
+readonly PWD0="$(dirname "$(readlink -fn "$0")")"
+readonly MYFRAME_ROOT="$(dirname ${PWD0})"
+
+readonly IMAGE_NAME="myframe"
+
+set -e
+
+function main {
+  cd "${PWD0}"
+
+  local -a cmd=()
+  if command -v docker; then
+    cmd+=("docker" "build")
+  else
+    echo "No docker existed!"
+    exit 1
+  fi
+
+  local arc="$(uname -m)"
+  local cpu_arch="unknown"
+  case "${arc}" in
+  "aarch64" | "arm64")
+    arc="aarch64"
+    cpu_arch="arm"
+    ;;
+  "x86_64" | "amd64")
+    arc="amd64"
+    cpu_arch="x86"
+    ;;
+  *)
+    echo "Unknown arch: ${arc}"
+    exit 1
+    ;;
+  esac
+
+  local tag="${arc}-$1"
+
+  "${cmd[@]}" \
+    --build-arg myframe_version=$1 \
+    --build-arg cpu_arch=${cpu_arch} \
+    --ulimit nofile=102400:102400 \
+    -f "dev.dockerfile" \
+    -t "${IMAGE_NAME}:${tag}" \
+    "${MYFRAME_ROOT}"
+}
+
+if [ "$#" -ne 1 ]; then
+    echo "Error: No arguments provided. Usage: $0 \"myframe_version\""
+    exit 1
+fi
+
+main "$@"