优化txsql编译体验

[willhan123]

TXSQL在编译过程中，会对系统环境有一定的依赖。完善CMakeFile信息，在发现gcc、cmake版本不符合预期的时候，打印出对具体版本的依赖，从而避免在make的时候报错

[7yi65]

广东技术师范大学-林钡镕-认领成功

[7yi65]

广东技术师范大学-林钡镕-认领成功

TXSQL 编译环境依赖出现问题

思路

1. 在 CMake 配置阶段检测依赖：避免等到 make 阶段才报错
2. 明确版本要求：为每个依赖指定最小版本
3. 友好的错误提示：提供明确的解决指南
4. 自动化修复建议：生成修复脚本

修改后的 CMakeLists.txt 关键代码段

cmake_minimum_required(VERSION 3.5)

# ========== 环境依赖检查 ==========
message(STATUS "Checking build environment dependencies")

# 1. 检查 GCC 版本
set(MIN_GCC_VERSION "7.3.0")
if(CMAKE_C_COMPILER_ID STREQUAL "GNU")
    if(CMAKE_C_COMPILER_VERSION VERSION_LESS ${MIN_GCC_VERSION})
        message(FATAL_ERROR
            "GCC version ${CMAKE_C_COMPILER_VERSION} is too old.\n"
            "TXSQL requires at least GCC ${MIN_GCC_VERSION}.\n\n"
            "Solution options:\n"
            "  a) Install newer GCC: sudo apt install gcc-10 g++-10\n"
            "  b) Set compiler explicitly: cmake -DCMAKE_C_COMPILER=/usr/bin/gcc-10 ...\n"
            "  c) Use devtoolset (CentOS): scl enable devtoolset-10 bash\n"
        )
    endif()
endif()

# 2. 检查 CMake 版本
set(MIN_CMAKE_VERSION "3.5.0")
if(CMAKE_VERSION VERSION_LESS ${MIN_CMAKE_VERSION})
    message(FATAL_ERROR
        "CMake version ${CMAKE_VERSION} is too old.\n"
        "TXSQL requires at least CMake ${MIN_CMAKE_VERSION}.\n\n"
        "Solution:\n"
        "  Install newer CMake:\n"
        "    wget https://github.com/Kitware/CMake/releases/download/v3.25.1/cmake-3.25.1-linux-x86_64.sh\n"
        "    chmod +x cmake-3.25.1-linux-x86_64.sh\n"
        "    sudo ./cmake-3.25.1-linux-x86_64.sh --prefix=/usr/local --skip-license\n"
    )
endif()

# 3. 检查 Boost 版本
set(MIN_BOOST_VERSION "1.77.0")
find_package(Boost 1.77.0 REQUIRED)
if(NOT Boost_FOUND)
    message(FATAL_ERROR
        "Boost version ${Boost_VERSION} is too old or not found.\n"
        "TXSQL requires at least Boost ${MIN_BOOST_VERSION}.\n\n"
        "Solution:\n"
        "  a) Install system Boost: sudo apt install libboost-all-dev\n"
        "  b) Manual install:\n"
        "      wget https://sourceforge.net/projects/boost/files/boost/1.77.0/boost_1_77_0.tar.bz2\n"
        "      tar -xjf boost_1_77_0.tar.bz2\n"
        "      cd boost_1_77_0\n"
        "      ./bootstrap.sh\n"
        "      ./b2 install --prefix=/usr/local\n"
        "  c) Let CMake download: cmake -DDOWNLOAD_BOOST=1 -DWITH_BOOST=../boost ...\n"
    )
endif()

# 4. 检查关键依赖包
set(REQUIRED_PACKAGES
    libaio-dev
    libnuma-dev
    libssl-dev
    zlib1g-dev
    libncurses-dev
    bison)

foreach(pkg ${REQUIRED_PACKAGES})
    execute_process(
        COMMAND dpkg -s ${pkg}
        RESULT_VARIABLE PKG_STATUS
        OUTPUT_QUIET
        ERROR_QUIET
    )
    
    if(NOT PKG_STATUS EQUAL 0)
        message(FATAL_ERROR
            "Missing required package: ${pkg}\n\n"
            "Install with:\n"
            "  Ubuntu/Debian: sudo apt install ${pkg}\n"
            "  CentOS/RHEL: sudo yum install ${pkg}\n"
            "  All dependencies: sudo apt install ${REQUIRED_PACKAGES}\n"
        )
    endif()
endforeach()

# 5. 内存检查 (特别针对 WSL)
if(CMAKE_HOST_SYSTEM_NAME MATCHES "Linux")
    execute_process(
        COMMAND free -b
        COMMAND grep Mem:
        COMMAND awk "{print \$2}"
        OUTPUT_VARIABLE TOTAL_MEM
        OUTPUT_STRIP_TRAILING_WHITESPACE
    )
    
    # 转换为 GB
    math(EXPR MEM_GB "${TOTAL_MEM} / 1024 / 1024 / 1024")
    
    if(MEM_GB LESS 4)
        message(WARNING
            "Low system memory detected: ${MEM_GB} GB\n"
            "TXSQL compilation requires at least 4GB RAM + 4GB Swap\n\n"
            "Recommended actions:\n"
            "  1. Create swap file:\n"
            "     sudo fallocate -l 4G /swapfile\n"
            "     sudo chmod 600 /swapfile\n"
            "     sudo mkswap /swapfile\n"
            "     sudo swapon /swapfile\n"
            "  2. Reduce make parallelism: make -j2\n"
            "  3. Close memory-intensive applications\n"
        )
    endif()
endif()

# 6. 架构检查
if(NOT CMAKE_SYSTEM_PROCESSOR MATCHES "x86_64|amd64")
    message(FATAL_ERROR
        "Unsupported architecture: ${CMAKE_SYSTEM_PROCESSOR}\n"
        "TXSQL currently only supports x86_64/amd64 systems\n"
    )
endif()

# 7. 生成环境报告
message(STATUS "==============================================")
message(STATUS "TXSQL Build Environment Report")
message(STATUS "  CMake Version: ${CMAKE_VERSION}")
message(STATUS "  C Compiler: ${CMAKE_C_COMPILER_ID} ${CMAKE_C_COMPILER_VERSION}")
message(STATUS "  C++ Compiler: ${CMAKE_CXX_COMPILER_ID} ${CMAKE_CXX_COMPILER_VERSION}")
message(STATUS "  Boost Version: ${Boost_VERSION}")
message(STATUS "  System Memory: ${MEM_GB} GB")
message(STATUS "==============================================")

# ========== 项目配置 ==========
project(TXSQL VERSION 8.0.30)

使用说明

1. 添加位置：将此代码段放在 CMakeLists.txt 文件的最开头
2. 自定义版本：根据实际需求调整 MIN_GCC_VERSION 等参数
3. 扩展检查：可根据需要添加更多依赖检查

错误处理流程示例

当环境不符合要求时，CMake 会输出友好的错误信息：

# 示例：GCC 版本过低
CMake Error at CMakeLists.txt:15 (message):
  GCC version 7.2.0 is too old.
  TXSQL requires at least GCC 7.3.0.

  Solution options:
    a) Install newer GCC: sudo apt install gcc-10 g++-10
    b) Set compiler explicitly: cmake -DCMAKE_C_COMPILER=/usr/bin/gcc-10 ...
    c) Use devtoolset (CentOS): scl enable devtoolset-10 bash

完整构建流程改进

#!/bin/bash
# build_txsql.sh - 增强版构建脚本

# 自动修复依赖
if ! command -v cmake &> /dev/null || \
   ! dpkg -s libaio-dev &> /dev/null || \
   ! dpkg -s libssl-dev &> /dev/null
then
    echo "Missing dependencies, attempting to fix..."
    sudo apt update
    sudo apt install -y cmake gcc g++ libaio-dev libnuma-dev libssl-dev
fi

# 配置阶段
mkdir -p build
cd build
cmake .. \
  -DCMAKE_INSTALL_PREFIX=/usr/local/txsql \
  -DMYSQL_DATADIR=/data/txsql/data \
  -DWITH_BOOST=/opt/boost/boost_1_77_0 \
  -DWITH_SSL=system \
  -DCMAKE_BUILD_TYPE=Release

# 编译阶段
make -j$(nproc)

# 安装阶段
sudo make install

项目维护建议

1. 创建依赖清单文件：dependencies.txt

# TXSQL Build Dependencies
gcc>=7.3
cmake>=3.5
boost>=1.77.0
libaio-dev
libnuma-dev
libssl-dev
zlib1g-dev
libncurses-dev
bison

2. 添加环境检测脚本：scripts/check_environment.sh

#!/bin/bash
# Check build environment
ERROR=0

check_tool() {
  if ! command -v $1 &> /dev/null; then
    echo "❌ Missing tool: $1"
    ERROR=1
  fi
}

check_pkg() {
  if ! dpkg -s $1 &> /dev/null; then
    echo "❌ Missing package: $1"
    ERROR=1
  fi
}

echo "Checking TXSQL build environment..."
check_tool gcc
check_tool g++
check_tool cmake
check_tool bison

check_pkg libaio-dev
check_pkg libnuma-dev
check_pkg libssl-dev
check_pkg zlib1g-dev

if [ $ERROR -eq 0 ]; then
  echo "✅ Environment check passed"
  exit 0
else
  echo "💡 Run this to fix: sudo apt install gcc g++ cmake bison libaio-dev libnuma-dev libssl-dev zlib1g-dev"
  exit 1
fi

[willhan123]

1. 建议先明确规则
2. cmake里不建议帮助用户做下载（网络/安全考虑）