Сборка на Linux для s390x (zLinux)

ClickHouse имеет экспериментальную поддержку для s390x.

Сборка ClickHouse для s390x

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, установите целевую платформу для кросс-компиляции rust для s390x:

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, запустите ClickHouse с помощью 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"
• Убедитесь, что исполняемый файл ClickHouse запускается в режиме отладки перед запуском. (Также возможно создать 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": ".*"
                    }
                }
            ]
        }
    ]
}