Compilar no Linux para s390x (zLinux)

O ClickHouse oferece suporte experimental a s390x.

Compilando o ClickHouse para s390x

Assim como outras plataformas, o s390x compila o OpenSSL como uma biblioteca estática. Se você quiser compilar com OpenSSL dinâmico, precisará passar -DENABLE_OPENSSL_DYNAMIC=1 ao CMake.

Estas instruções pressupõem que a máquina host seja Linux x86_64/ARM e tenha todas as ferramentas necessárias para compilação nativa, com base nas instruções de compilação. Também pressupõem que o host seja Ubuntu 22.04, mas as instruções a seguir também devem funcionar no Ubuntu 20.04.

Além de instalar as ferramentas usadas na compilação nativa, os pacotes adicionais a seguir precisam ser instalados:

apt-get mold
rustup target add s390x-unknown-linux-gnu

Para compilar em s390x:

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

Executando

Para emular, você precisará do binário estático do QEMU para modo usuário em s390x. No Ubuntu, ele pode ser instalado com:

apt-get install binfmt-support binutils-s390x-linux-gnu qemu-user-static

Depois de compilado, o binário pode ser executado, por exemplo, com:

qemu-s390x-static -L /usr/s390x-linux-gnu ./programs/clickhouse local --query "Select 2"
2

Depuração

Instale o LLDB:

apt-get install lldb-21

Para depurar um executável s390x, execute o ClickHouse usando o QEMU em modo de depuração:

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

Em outro shell, execute o LLDB e faça o attach; substitua <ClickHouse Parent Directory> e <build directory> pelos valores correspondentes ao seu ambiente.

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

Integração com o Visual Studio Code

A extensão CodeLLDB é necessária para a depuração visual.
A extensão Command Variable pode ajudar com inicializações dinâmicas ao usar CMake Variants.
Certifique-se de definir o backend para a sua instalação do LLVM, por exemplo: "lldb.library": "/usr/lib/x86_64-linux-gnu/liblldb-21.so"
Certifique-se de executar o executável clickhouse em modo de depuração antes de iniciar. (Também é possível criar uma preLaunchTask para automatizar isso)

Configurações de exemplo

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

Isso também colocaria builds diferentes em subpastas distintas da pasta build.

{
    "cmake.buildDirectory": "${workspaceFolder}/build/${buildKitVendor}-${buildKitVersion}-${variant:toolchain}-${variant:buildType}",
    "lldb.library": "/usr/lib/x86_64-linux-gnu/liblldb-21.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

Define uma tarefa para executar o executável compilado no modo server, em uma pasta tmp ao lado dos binários, com a configuração em 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": ".*"
                    }
                }
            ]
        }
    ]
}