Linuxでs390x（zLinux）用にビルド

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

s390x用にClickHouseをビルドする

s390xには2つの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キャッシュは、クエリプロファイラが信頼性を持って機能するために必要です

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: デバッグ情報を出力
      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": "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 'デバッガセッションを開始します'
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": "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": "^デバッガセッションを開始します",
                        "endsPattern": ".*"
                    }
                }
            ]
        }
    ]
}

s390x用にClickHouseをビルドする​

実行する​

デバッグ​

Visual Studio Code統合​

例の設定​

cmake-variants.yaml​

launch.json​

settings.json​

run-debug.sh​

tasks.json​