mirror of
https://github.com/ClickHouse/ClickHouse.git
synced 2024-11-15 12:14:18 +00:00
123 lines
4.6 KiB
Markdown
123 lines
4.6 KiB
Markdown
---
|
|
slug: /en/development/build-cross-s390x
|
|
sidebar_position: 69
|
|
title: How to Build, Run and Debug ClickHouse on Linux for s390x (zLinux)
|
|
sidebar_label: Build on Linux for s390x (zLinux)
|
|
---
|
|
|
|
As of writing (2023/3/10) building for s390x considered to be experimental. Not all features can be enabled, has broken features and is currently under active development.
|
|
|
|
|
|
## Building
|
|
|
|
As s390x does not support boringssl, it uses OpenSSL and has two related build options.
|
|
- By default, the s390x build will dynamically link to OpenSSL libraries. It will build OpenSSL shared objects, so it's not necessary to install OpenSSL beforehand. (This option is recommended in all cases.)
|
|
- Another option is to build OpenSSL in-tree. In this case two build flags need to be supplied to cmake
|
|
```bash
|
|
-DENABLE_OPENSSL_DYNAMIC=0 -DENABLE_OPENSSL=1
|
|
```
|
|
|
|
These instructions assume that the host machine is x86_64 and has all the tooling required to build natively based on the [build instructions](../development/build.md). It also assumes that the host is Ubuntu 22.04 but the following instructions should also work on Ubuntu 20.04.
|
|
|
|
In addition to installing the tooling used to build natively, the following additional packages need to be installed:
|
|
|
|
```bash
|
|
apt-get install binutils-s390x-linux-gnu libc6-dev-s390x-cross gcc-s390x-linux-gnu binfmt-support qemu-user-static
|
|
```
|
|
|
|
If you wish to cross compile rust code install the rust cross compile target for s390x:
|
|
```bash
|
|
rustup target add s390x-unknown-linux-gnu
|
|
```
|
|
|
|
To build for s390x:
|
|
```bash
|
|
cmake -DCMAKE_TOOLCHAIN_FILE=cmake/linux/toolchain-s390x.cmake ..
|
|
ninja
|
|
```
|
|
|
|
## Running
|
|
|
|
Once built, the binary can be run with, eg.:
|
|
|
|
```bash
|
|
qemu-s390x-static -L /usr/s390x-linux-gnu ./clickhouse
|
|
```
|
|
|
|
## Debugging
|
|
|
|
Install LLDB:
|
|
|
|
```bash
|
|
apt-get install lldb-15
|
|
```
|
|
|
|
To Debug a s390x executable, run clickhouse using QEMU in debug mode:
|
|
|
|
```bash
|
|
qemu-s390x-static -g 31338 -L /usr/s390x-linux-gnu ./clickhouse
|
|
```
|
|
|
|
In another shell run LLDB and attach, replace `<Clickhouse Parent Directory>` and `<build directory>` with the values corresponding to your environment.
|
|
```bash
|
|
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 integration
|
|
|
|
- (CodeLLDB extension)[https://github.com/vadimcn/vscode-lldb] is required for visual debugging, the (Command Variable)[https://github.com/rioj7/command-variable] extension can help dynamic launches if using (cmake variants)[https://github.com/microsoft/vscode-cmake-tools/blob/main/docs/variants.md].
|
|
- Make sure to set the backend to your llvm installation eg. `"lldb.library": "/usr/lib/x86_64-linux-gnu/liblldb-15.so"`
|
|
- Launcher:
|
|
```json
|
|
{
|
|
"version": "0.2.0",
|
|
"configurations": [
|
|
{
|
|
"name": "Debug",
|
|
"type": "lldb",
|
|
"request": "custom",
|
|
"targetCreateCommands": ["target create ${command:cmake.launchTargetDirectory}/clickhouse"],
|
|
"processCreateCommands": ["settings set target.source-map ${input:targetdir} ${workspaceFolder}", "gdb-remote 31338"],
|
|
"sourceMap": { "${input:targetdir}": "${workspaceFolder}" },
|
|
}
|
|
],
|
|
"inputs": [
|
|
{
|
|
"id": "targetdir",
|
|
"type": "command",
|
|
"command": "extension.commandvariable.transform",
|
|
"args": {
|
|
"text": "${command:cmake.launchTargetDirectory}",
|
|
"find": ".*/([^/]+)/[^/]+$",
|
|
"replace": "$1"
|
|
}
|
|
}
|
|
]
|
|
}
|
|
```
|
|
- Make sure to run the clickhouse executable in debug mode prior to launch. (It is also possible to create a `preLaunchTask` that automates this) |