Linux上でのs390x（zLinux）用構築

ClickHouseはs390xに対して実験的なサポートを提供しています。

s390x用のClickHouseの構築

s390xには二つのOpenSSL関連のビルドオプションがあります：

デフォルトでは、OpenSSLはs390x上で共有ライブラリとしてビルドされます。他のすべてのプラットフォームでは、OpenSSLは静的ライブラリとしてビルドされます。
静的ライブラリとしてOpenSSLをビルドするには、-DENABLE_OPENSSL_DYNAMIC=0をCMakeに渡します。

これらの手順は、ホストマシンが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を使用してクリックハウスをデバッグモードで実行します：

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

別のシェルで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拡張が必要です。
Command Variable拡張はCMakE Variantsを使用している場合に動的な起動を助けることができます。
バックエンドをLLVMインストールに設定してください。例: "lldb.library": "/usr/lib/x86_64-linux-gnu/liblldb-15.so"
起動前にクリックハウス実行可能ファイルをデバッグモードで実行することを確認してください。（このプロセスを自動化するためにpreLaunchTaskを作成することも可能です）

例示的な構成

cmake-variants.yaml

buildType:
  default: relwithdebinfo
  choices:
    debug:
      short: Debug
      long: Emit debug information
      buildType: Debug
    release:
      short: Release
      long: Optimize generated code
      buildType: Release
    relwithdebinfo:
      short: RelWithDebInfo
      long: Release with Debug Info
      buildType: RelWithDebInfo
    tsan:
      short: MinSizeRel
      long: Minimum Size Release
      buildType: MinSizeRel

toolchain:
  default: default
  description: Select toolchain
  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) Launch s390x with qemu",
            "targetCreateCommands": ["target create ${command:cmake.launchTargetPath}"],
            "processCreateCommands": ["gdb-remote 2159"],
            "preLaunchTask": "Run 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 'Starting debugger session'
cd $1
qemu-s390x-static -g 2159 -L /usr/s390x-linux-gnu $2 $3 $4

tasks.json

serverモードでコンパイルされた実行ファイルをバイナリの隣のtmpフォルダの下で実行するタスクを定義し、programs/server/config.xmlからの設定を使用します。

{
    "version": "2.0.0",
    "tasks": [
        {
            "label": "Run 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": "^Starting debugger session",
                        "endsPattern": ".*"
                    }
                }
            ]
        }
    ]
}

s390x用のClickHouseの構築​

実行​

デバッグ​

Visual Studio Code統合​

例示的な構成​

cmake-variants.yaml​

launch.json​

settings.json​

run-debug.sh​

tasks.json​