Merge pull request #591 from ClickHouse/use-system-stdlib

Use the system C++ standard library and link the runtime statically

Author: slabko

.github/workflows/Coverage.yml

@@ -56,7 +56,7 @@ jobs:
         sudo apt upgrade -y
         sudo apt install -y \
           build-essential git cmake docker perl libdbi-perl libdbd-odbc-perl \
-          python-is-python3 python3 python3-pip python3-setuptools libpoco-dev libssl-dev libicu-dev
+          python-is-python3 python3 python3-pip python3-setuptools
         sudo apt install -y unixodbc unixodbc-dev
         sudo apt install -y clang llvm lldb
         sudo apt autoremove -y

.github/workflows/Linux.yml

@@ -33,11 +33,9 @@ jobs:
       matrix:
         os: [ubuntu-22.04]
         odbc_provider: [UnixODBC]
-        compiler: [Clang]
+        compiler: [Clang, GCC]
         build_type: [Debug, Release]
         architecture: [x86_64]
-        runtime_link: [static-runtime, dynamic-runtime]
-        third_parties: [bundled-third-parties, system-third-parties]
         # exclude:
         #   - os: ubuntu-18.04
         #     compiler: Clang
@@ -66,7 +64,7 @@ jobs:
         sudo apt update -q
         sudo apt remove -y php* node* mysql* mssql-tools
         sudo apt upgrade -y
-        sudo apt install -y build-essential git cmake docker perl libdbi-perl libdbd-odbc-perl python-is-python3 python3 python3-pip python3-setuptools libpoco-dev libssl-dev libicu-dev
+        sudo apt install -y build-essential git cmake docker perl libdbi-perl libdbd-odbc-perl python-is-python3 python3 python3-pip python3-setuptools
 
     - name: Install dependencies - UnixODBC
       if: ${{ matrix.odbc_provider == 'UnixODBC' }}
@@ -82,7 +80,8 @@ jobs:
 
     - name: Install dependencies - GCC
       if: ${{ matrix.compiler == 'GCC' }}
-      run: sudo apt install -y gcc g++ gdb
+      # GCC 12 is the oldest GCC with adequate C++23 support; Ubuntu 22.04 defaults to GCC 11.
+      run: sudo apt install -y gcc-12 g++-12 gdb
 
     - name: Install dependencies - Cleanup
       run: sudo apt autoremove -y
@@ -105,14 +104,12 @@ jobs:
         )
         dsn_string=$(IFS=';'; echo "${dsn_list[*]}")
 
-        CC=${{ fromJSON('{"Clang": "clang", "GCC": "gcc"}')[matrix.compiler] }} \
-        CXX=${{ fromJSON('{"Clang": "clang++", "GCC": "g++"}')[matrix.compiler] }} \
+        CC=${{ fromJSON('{"Clang": "clang", "GCC": "gcc-12"}')[matrix.compiler] }} \
+        CXX=${{ fromJSON('{"Clang": "clang++", "GCC": "g++-12"}')[matrix.compiler] }} \
         cmake -S ${{ github.workspace }}/source -B ${{ github.workspace }}/build \
           -DCMAKE_POLICY_VERSION_MINIMUM=3.5 \
           -DCMAKE_BUILD_TYPE=${{ matrix.build_type }} \
           -DODBC_PROVIDER=${{ matrix.odbc_provider }} \
-          -DCH_ODBC_RUNTIME_LINK_STATIC=${{ fromJSON('{"static-runtime": "ON", "dynamic-runtime": "OFF"}')[matrix.runtime_link] }} \
-          -DCH_ODBC_PREFER_BUNDLED_THIRD_PARTIES=${{ fromJSON('{"bundled-third-parties": "ON", "system-third-parties": "OFF"}')[matrix.third_parties] }} \
           -DTEST_DSN_LIST="$dsn_string" \
           -DBUILD_TESTING=YES
 
@@ -134,6 +131,21 @@ jobs:
         done
         exit $rc
 
+    - name: Check driver does not depend on a shared C++ runtime
+      working-directory: ${{ github.workspace }}/build/driver
+      run: |
+        rc=0
+        for f in libclickhouseodbc.so libclickhouseodbcw.so; do
+          if readelf -dW "$f" | grep -E 'NEEDED.*\b(libstdc\+\+|libgcc_s)\b'; then
+            echo "FAIL (shared C++ runtime dependency): $f"; rc=1
+          elif readelf -VW "$f" | grep -qE 'GLIBCXX_|CXXABI_'; then
+            echo "FAIL (libstdc++ symbol version requirement): $f"; rc=1
+          else
+            echo "ok (static C++ runtime):              $f"
+          fi
+        done
+        exit $rc
+
     - name: Package
       run: cmake --build ${{ github.workspace }}/build --config ${{ matrix.build_type }} --target package
 
@@ -143,7 +155,7 @@ jobs:
         ls -lahR ${{ github.workspace }}/build/
 
     - name: Upload the artifacts
-      if:  ${{ matrix.odbc_provider == 'UnixODBC' && matrix.build_type == 'Release' && matrix.runtime_link == 'dynamic-runtime' && matrix.third_parties == 'bundled-third-parties' }}
+      if:  ${{ matrix.odbc_provider == 'UnixODBC' && matrix.build_type == 'Release' }}
       uses: actions/upload-artifact@v4
       with:
           name: clickhouse-odbc-linux-${{ matrix.compiler }}-${{ matrix.odbc_provider }}-${{ matrix.build_type }}

.github/workflows/Sanitizer.yml

@@ -29,8 +29,12 @@ jobs:
       matrix:
         os: [ubuntu-24.04]
         build_type: [RelWithDebInfo]
-        third_parties: [bundled-third-parties]
-        sanitizer: [address, memory, undefined]
+        # MemorySanitizer is deliberately absent: it requires every library in the process
+        # (C++ standard library, OpenSSL, ICU, ...) to be MSan-instrumented, which is not
+        # the case since the driver uses the system C++ standard library. Uninitialized
+        # memory reads are covered by Valgrind's Memcheck instead, which needs no
+        # instrumentation and runs against a regular build.
+        checker: [address, undefined, valgrind]
 
     runs-on: ${{ matrix.os }}
 
@@ -57,6 +61,10 @@ jobs:
         chmod +x llvm.sh
         sudo ./llvm.sh 20 all
 
+    - name: Install dependencies - Valgrind
+      if: ${{ matrix.checker == 'valgrind' }}
+      run: sudo apt install -y valgrind
+
     - name: Clone the repo
       uses: actions/checkout@v4
       with:
@@ -71,7 +79,7 @@ jobs:
         -DCMAKE_POLICY_VERSION_MINIMUM=3.5
         -DCMAKE_BUILD_TYPE=${{ matrix.build_type }}
         -DTEST_DSN_LIST="ClickHouse DSN (ANSI);ClickHouse DSN (Unicode);ClickHouse DSN (ANSI) ZSTD;ClickHouse DSN (Unicode) ZSTD"
-        -DSANITIZE=${{ matrix.sanitizer }}
+        -DSANITIZE=${{ matrix.checker != 'valgrind' && matrix.checker || '' }}
         -DBUILD_TESTING=YES
 
     - name: Build
@@ -146,9 +154,31 @@ jobs:
         EOF
 
     - name: Test - Run C++ integration tests
+      if: ${{ matrix.checker != 'valgrind' }}
       working-directory: ${{ github.workspace }}/build
       run: |
         export ODBCSYSINI=
         export ODBCINSTINI="${{ github.workspace }}/run/.odbcinst.ini"
         export ODBCINI="${{ github.workspace }}/run/.odbc.ini"
         ctest --output-on-failure --build-config ${{ matrix.build_type }}
+
+    - name: Test - Run C++ integration tests under Valgrind
+      if: ${{ matrix.checker == 'valgrind' }}
+      working-directory: ${{ github.workspace }}/build/driver/test
+      timeout-minutes: 60
+      run: |
+        export ODBCSYSINI=
+        export ODBCINSTINI="${{ github.workspace }}/run/.odbcinst.ini"
+        export ODBCINI="${{ github.workspace }}/run/.odbc.ini"
+        rc=0
+        for dsn in "ClickHouse DSN (ANSI)" "ClickHouse DSN (Unicode)" "ClickHouse DSN (ANSI) ZSTD" "ClickHouse DSN (Unicode) ZSTD"; do
+          case "$dsn" in
+            *Unicode*) exe=./clickhouse-odbcw-client-it ;;
+            *)         exe=./clickhouse-odbc-client-it ;;
+          esac
+          echo "::group::$dsn"
+          valgrind --tool=memcheck --error-exitcode=1 --track-origins=yes --gen-suppressions=all \
+            "$exe" "$dsn" --gtest_filter='-*PerformanceTest*' || rc=1
+          echo "::endgroup::"
+        done
+        exit $rc

.github/workflows/Windows.yml

@@ -77,14 +77,28 @@ jobs:
           -DCMAKE_POLICY_VERSION_MINIMUM="3.5" `
           -DCMAKE_BUILD_TYPE=${{ matrix.build_type }} `
           -DODBC_PROVIDER=${{ matrix.odbc_provider }} `
-          -DCH_ODBC_RUNTIME_LINK_STATIC=OFF `
-          -DCH_ODBC_PREFER_BUNDLED_THIRD_PARTIES=ON `
           -DTEST_DSN_LIST="$dsnList" `
           -DBUILD_TESTING=YES
 
     - name: Build
       run: cmake --build ${{ github.workspace }}/build --config ${{ matrix.build_type }}
 
+    - name: Check driver does not depend on the Visual C++ Redistributable
+      working-directory: ${{ github.workspace }}/build/driver/${{ matrix.build_type }}
+      run: |
+        $failed = $false
+        foreach ($f in @("clickhouseodbc.dll", "clickhouseodbcw.dll")) {
+          $deps = (dumpbin /dependents $f) -join "`n"
+          if ($deps -match '(?i)\b(vcruntime|msvcp|ucrtbase|api-ms-win-crt)[^\s]*\.dll') {
+            Write-Host "FAIL (shared CRT dependency): $f"
+            Write-Host $deps
+            $failed = $true
+          } else {
+            Write-Host "ok (static CRT): $f"
+          }
+        }
+        if ($failed) { exit 1 }
+
     - name: Package
       run: cmake --build ${{ github.workspace }}/build --config ${{ matrix.build_type }} --target package
 

.github/workflows/WindowsSigning.yml

@@ -62,8 +62,6 @@ jobs:
         -DCMAKE_POLICY_VERSION_MINIMUM="3.5"
         -DCMAKE_BUILD_TYPE=${{ matrix.build_type }}
         -DODBC_PROVIDER=${{ matrix.odbc_provider }}
-        -DCH_ODBC_RUNTIME_LINK_STATIC=OFF
-        -DCH_ODBC_PREFER_BUNDLED_THIRD_PARTIES=ON
         -DTEST_DSN_LIST="ClickHouse DSN ANSI;ClickHouse DSN Unicode"
         -DBUILD_TESTING=NO
 

.github/workflows/macOS.yml

@@ -37,8 +37,6 @@ jobs:
         odbc_provider: [UnixODBC]
         compiler: [AppleClang]
         build_type: [Debug, Release]
-        runtime_link: [dynamic-runtime]
-        third_parties: [bundled-third-parties]
 
     runs-on: ${{ matrix.os }}
 
@@ -62,7 +60,7 @@ jobs:
     - name: Install dependencies - Common
       run: |
         brew remove -f --ignore-dependencies -q libiodbc unixodbc freetds php node composer
-        brew install git cmake perl python openssl poco icu4c binutils curl
+        brew install git cmake perl python binutils curl
         pip3 install --break-system-packages --user 'testflows==1.6.56'
 
     - name: Install dependencies - UnixODBC
@@ -107,10 +105,6 @@ jobs:
         -DCMAKE_POLICY_VERSION_MINIMUM=3.5 \
         -DCMAKE_BUILD_TYPE=${{ matrix.build_type }} \
         -DODBC_PROVIDER=${{ matrix.odbc_provider }} \
-        -DICU_ROOT="$(brew --prefix icu4c)" \
-        -DOPENSSL_ROOT_DIR="$(brew --prefix openssl)" \
-        -DCH_ODBC_RUNTIME_LINK_STATIC=${{ fromJSON('{"static-runtime": "ON", "dynamic-runtime": "OFF"}')[matrix.runtime_link] }} \
-        -DCH_ODBC_PREFER_BUNDLED_THIRD_PARTIES=${{ fromJSON('{"bundled-third-parties": "ON", "system-third-parties": "OFF"}')[matrix.third_parties] }} \
         -DTEST_DSN_LIST="$dsn_string" \
         -DBUILD_TESTING=YES
 

.gitmodules

@@ -14,9 +14,6 @@
 [submodule "contrib/nanodbc"]
 	path = contrib/nanodbc
 	url = https://github.com/ClickHouse/nanodbc.git
-[submodule "contrib/llvm-project"]
-	path = contrib/llvm-project
-	url = https://github.com/ClickHouse/llvm-project
 [submodule "contrib/zlib-ng"]
 	path = contrib/zlib-ng
 	url = https://github.com/ClickHouse/zlib-ng.git
@@ -29,9 +26,6 @@
 [submodule "contrib/double-conversion"]
 	path = contrib/double-conversion
 	url = https://github.com/ClickHouse/double-conversion
-[submodule "contrib/libunwind"]
-	path = contrib/libunwind
-	url = https://github.com/ClickHouse/libunwind
 [submodule "contrib/asio"]
 	path = contrib/asio
 	url = https://github.com/chriskohlhoff/asio