在 Linux 上构建 s390x（zLinux）版本

ClickHouse 目前对 s390x 提供实验性支持。

为 s390x 构建 ClickHouse

s390x 有两个与 OpenSSL 相关的构建选项：

默认情况下，在 s390x 上 OpenSSL 会被构建为共享库。这与其他所有平台不同，其他平台上 OpenSSL 会被构建为静态库。
如果仍然希望将 OpenSSL 构建为静态库，请在 CMake 中传入 -DENABLE_OPENSSL_DYNAMIC=0。

以下说明假定宿主机为 x86_64 架构，并且已经按照构建说明安装了本机构建所需的全部工具。同时还假定宿主机运行的是 Ubuntu 22.04，但下面的说明在 Ubuntu 20.04 上同样应当可行。

除了安装用于本机构建的工具外，还需要额外安装以下软件包：

apt-get install binutils-s390x-linux-gnu libc6-dev-s390x-cross gcc-s390x-linux-gnu binfmt-support qemu-user-static

如果您希望交叉编译 Rust 代码，请安装针对 s390x 的 Rust 交叉编译目标：

rustup target add s390x-unknown-linux-gnu

s390x 构建使用 mold 链接器，请从 https://github.com/rui314/mold/releases/download/v2.0.0/mold-2.0.0-x86_64-linux.tar.gz 下载并将其放入你的 $PATH 中。

要构建 s390x：

cmake -DCMAKE_TOOLCHAIN_FILE=cmake/linux/toolchain-s390x.cmake ..
ninja

运行

构建完成后，例如可以这样运行该二进制文件：

qemu-s390x-static -L /usr/s390x-linux-gnu ./clickhouse

调试

安装 LLDB：

apt-get install lldb-15

要调试 s390x 可执行文件，请在调试模式下通过 QEMU 运行 ClickHouse：

qemu-s390x-static -g 31338 -L /usr/s390x-linux-gnu ./clickhouse

在另一个 shell 中运行 LLDB 并附加到进程，将 <ClickHouse Parent Directory> 和 <build directory> 替换为与你环境相对应的值。

lldb-15
(lldb) target create ./clickhouse
Current executable set to '/<Clickhouse Parent Directory>/ClickHouse/<build directory>/programs/clickhouse' (s390x).
(lldb) settings set target.source-map <build directory> /<Clickhouse Parent Directory>/ClickHouse
(lldb) gdb-remote 31338
Process 1 stopped
* thread #1, stop reason = signal SIGTRAP
    frame #0: 0x0000004020e74cd0
->  0x4020e74cd0: lgr    %r2, %r15
    0x4020e74cd4: aghi   %r15, -160
    0x4020e74cd8: xc     0(8,%r15), 0(%r15)
    0x4020e74cde: brasl  %r14, 275429939040
(lldb) b main
Breakpoint 1: 9 locations.
(lldb) c
Process 1 resuming
Process 1 stopped
* thread #1, stop reason = breakpoint 1.1
    frame #0: 0x0000004005cd9fc0 clickhouse`main(argc_=1, argv_=0x0000004020e594a8) at main.cpp:450:17
   447  #if !defined(FUZZING_MODE)
   448  int main(int argc_, char ** argv_)
   449  {
-> 450      inside_main = true;
   451      SCOPE_EXIT({ inside_main = false; });
   452
   453      /// PHDR cache is required for query profiler to work reliably

Visual Studio Code 集成

需要安装 CodeLLDB 扩展以进行可视化调试。
如果使用 CMake Variants，可以通过 Command Variable 扩展实现动态启动配置。
请确保将后端指向你的 LLVM 安装，例如 "lldb.library": "/usr/lib/x86_64-linux-gnu/liblldb-15.so"。
请确保在启动前以调试模式运行 ClickHouse 可执行文件。（也可以创建一个 preLaunchTask 来自动化完成此操作）

示例配置

cmake-variants.yaml

buildType:
  default: relwithdebinfo
  choices:
    debug:
      short: Debug
      long: 生成调试信息
      buildType: Debug
    release:
      short: Release
      long: 优化生成代码
      buildType: Release
    relwithdebinfo:
      short: RelWithDebInfo
      long: 带调试信息的发布版本
      buildType: RelWithDebInfo
    tsan:
      short: MinSizeRel
      long: 最小体积发布版本
      buildType: MinSizeRel

toolchain:
  default: default
  description: 选择工具链
  choices:
    default:
      short: x86_64
      long: x86_64
    s390x:
      short: s390x
      long: s390x
      settings:
        CMAKE_TOOLCHAIN_FILE: cmake/linux/toolchain-s390x.cmake

launch.json

{
    "version": "0.2.0",
    "configurations": [
        {
            "type": "lldb",
            "request": "custom",
            "name": "(lldb) 使用 qemu 启动 s390x",
            "targetCreateCommands": ["target create ${command:cmake.launchTargetPath}"],
            "processCreateCommands": ["gdb-remote 2159"],
            "preLaunchTask": "运行 ClickHouse"
        }
    ]
}

settings.json

这也会将不同的构建产物放在 build 目录下的不同子目录中。

{
    "cmake.buildDirectory": "${workspaceFolder}/build/${buildKitVendor}-${buildKitVersion}-${variant:toolchain}-${variant:buildType}",
    "lldb.library": "/usr/lib/x86_64-linux-gnu/liblldb-15.so"
}

run-debug.sh

#! /bin/sh
echo '正在启动调试器会话'
cd $1
qemu-s390x-static -g 2159 -L /usr/s390x-linux-gnu $2 $3 $4

tasks.json

定义了一个任务，用于在与二进制文件同级的 tmp 文件夹中，以 server 模式运行已编译的可执行文件，并使用 programs/server/config.xml 下的配置。

{
    "version": "2.0.0",
    "tasks": [
        {
            "label": "运行 ClickHouse",
            "type": "shell",
            "isBackground": true,
            "command": "${workspaceFolder}/.vscode/run-debug.sh",
            "args": [
                "${command:cmake.launchTargetDirectory}/tmp",
                "${command:cmake.launchTargetPath}",
                "server",
                "--config-file=${workspaceFolder}/programs/server/config.xml"
            ],
            "problemMatcher": [
                {
                    "pattern": [
                        {
                            "regexp": ".",
                            "file": 1,
                            "location": 2,
                            "message": 3
                        }
                    ],
                    "background": {
                        "activeOnStart": true,
                        "beginsPattern": "^启动调试器会话",
                        "endsPattern": ".*"
                    }
                }
            ]
        }
    ]
}

为 s390x 构建 ClickHouse​

运行​

调试​

Visual Studio Code 集成​

示例配置​

cmake-variants.yaml​

launch.json​

settings.json​

run-debug.sh​

tasks.json​