Merge pull request ClickHouse#78590 from Algunenano/rust_build

Rust build improvements

Author: Algunenano

CMakeLists.txt

@@ -34,8 +34,6 @@ endmacro ()
 
 set(CMAKE_EXPORT_COMPILE_COMMANDS 1) # Write compile_commands.json
 set(CMAKE_LINK_DEPENDS_NO_SHARED 1) # Do not relink all depended targets on .so
-set(CMAKE_CONFIGURATION_TYPES "RelWithDebInfo;Debug;Release;MinSizeRel" CACHE STRING "" FORCE)
-set(CMAKE_DEBUG_POSTFIX "d" CACHE STRING "Generate debug library name with a postfix.")    # To be consistent with CMakeLists from contrib libs.
 
 # Enable the ability to organize targets into hierarchies of "folders" for capable GUI-based IDEs.
 # For more info see https://cmake.org/cmake/help/latest/prop_gbl/USE_FOLDERS.html

cmake/cpu_features.cmake

@@ -8,8 +8,10 @@
 
 option (ARCH_NATIVE "Add -march=native compiler flag. This makes your binaries non-portable but more performant code may be generated. This option overrides ENABLE_* options for specific instruction set. Highly not recommended to use." 0)
 
+set(RUSTFLAGS)
 if (ARCH_NATIVE)
     set (COMPILER_FLAGS "${COMPILER_FLAGS} -march=native")
+    list(APPEND RUSTFLAGS "-C" "target-feature=native")
 
     # Populate the ENABLE_ option flags. This is required for the build of some third-party dependencies, specifically snappy, which
     # (somewhat weirdly) expects the relative SNAPPY_HAVE_ preprocessor variables to be populated, in addition to the microarchitecture
@@ -56,6 +58,7 @@ elseif (ARCH_AARCH64)
         # crc32 is optional in v8.0 and mandatory in v8.1. Enable it as __crc32()* is used in lot's of places and even very old ARM CPUs
         # support it.
         set (COMPILER_FLAGS "${COMPILER_FLAGS} -march=armv8+crc")
+        list(APPEND RUSTFLAGS "-C" "target_feature=+crc,-neon")
     else ()
         # ARMv8.2 is quite ancient but the lowest common denominator supported by both Graviton 2 and 3 processors [1, 10]. In particular, it
         # includes LSE (made mandatory with ARMv8.1) which provides nice speedups without having to fall back to compat flag
@@ -87,6 +90,8 @@ elseif (ARCH_AARCH64)
         # [9]  https://developer.arm.com/documentation/dui0801/g/A64-Data-Transfer-Instructions/LDAPR?lang=en
         # [10] https://github.com/aws/aws-graviton-getting-started/blob/main/README.md
         set (COMPILER_FLAGS "${COMPILER_FLAGS} -march=armv8.2-a+simd+crypto+dotprod+ssbs+rcpc+bf16")
+        # Not adding `+v8.2a,+crypto` to rust because it complains about them being unstable
+        list(APPEND RUSTFLAGS "-C" "target_feature=+dotprod,+ssbs,+rcpc,+bf16")
     endif ()
 
     # Best-effort check: The build generates and executes intermediate binaries, e.g. protoc and llvm-tablegen. If we build on ARM for ARM
@@ -112,8 +117,10 @@ elseif (ARCH_PPC64LE)
     option (POWER9 "Build for Power 9 CPU and above" 0)
     if(POWER9)
         set (COMPILER_FLAGS "${COMPILER_FLAGS} -maltivec -mcpu=power9 -D__SSE2__=1 -DNO_WARN_X86_INTRINSICS")
+        list(APPEND RUSTFLAGS "-C" "target_feature=+power9-altivec")
     else ()
         set (COMPILER_FLAGS "${COMPILER_FLAGS} -maltivec -mcpu=power8 -D__SSE2__=1 -DNO_WARN_X86_INTRINSICS")
+        list(APPEND RUSTFLAGS "-C" "target_feature=+power8-altivec")
     endif ()
 
 elseif (ARCH_AMD64)
@@ -169,48 +176,60 @@ elseif (ARCH_AMD64)
 
     if (ENABLE_SSSE3)
         set (COMPILER_FLAGS "${COMPILER_FLAGS} -mssse3")
+        list(APPEND RUSTFLAGS "-C" "target_feature=+ssse3")
     endif ()
 
     if (ENABLE_SSE41)
         set (COMPILER_FLAGS "${COMPILER_FLAGS} -msse4.1")
+        list(APPEND RUSTFLAGS "-C" "target_feature=+sse4.1")
     endif ()
 
     if (ENABLE_SSE42)
         set (COMPILER_FLAGS "${COMPILER_FLAGS} -msse4.2")
+        list(APPEND RUSTFLAGS "-C" "target_feature=+sse4.2")
     endif ()
 
     if (ENABLE_PCLMULQDQ)
         set (COMPILER_FLAGS "${COMPILER_FLAGS} -mpclmul")
+        list(APPEND RUSTFLAGS "-C" "target_feature=+pclmulqdq")
     endif ()
 
     if (ENABLE_BMI)
         set (COMPILER_FLAGS "${COMPILER_FLAGS} -mbmi")
+        list(APPEND RUSTFLAGS "-C" "target_feature=+bmi1")
     endif ()
 
     if (ENABLE_POPCNT)
         set (COMPILER_FLAGS "${COMPILER_FLAGS} -mpopcnt")
+        list(APPEND RUSTFLAGS "-C" "target_feature=+popcnt")
     endif ()
 
     if (ENABLE_AVX)
         set (COMPILER_FLAGS "${COMPILER_FLAGS} -mavx")
+        list(APPEND RUSTFLAGS "-C" "target_feature=+avx")
     endif ()
 
     if (ENABLE_AVX2)
         set (COMPILER_FLAGS "${COMPILER_FLAGS} -mavx2")
+        list(APPEND RUSTFLAGS "-C" "target_feature=+avx2")
         if (ENABLE_BMI2)
             set (COMPILER_FLAGS "${COMPILER_FLAGS} -mbmi2")
+            list(APPEND RUSTFLAGS "-C" "target_feature=+bmi2")
         endif ()
     endif ()
 
     if (ENABLE_AVX512)
         set (COMPILER_FLAGS "${COMPILER_FLAGS} -mavx512f -mavx512bw -mavx512vl")
+        list(APPEND RUSTFLAGS "-C" "target_feature=+avx512f,+avx512bw,+avx512vl")
         if (ENABLE_AVX512_VBMI)
             set (COMPILER_FLAGS "${COMPILER_FLAGS} -mavx512vbmi")
+            list(APPEND RUSTFLAGS "-C" "target_feature=+avx512vbmi")
         endif ()
     endif ()
 
     if (ENABLE_AVX512_FOR_SPEC_OP)
         set (X86_INTRINSICS_FLAGS "-mbmi -mavx512f -mavx512bw -mavx512vl -mprefer-vector-width=256")
+        list(APPEND RUSTFLAGS "-C" "target_feature=+bmi1,+avx512f,+avx512bw,+avx512vl,+prefer-256-bit")
     endif ()
 
 else ()

contrib/corrosion

@@ -50,11 +50,15 @@ list(APPEND CMAKE_MODULE_PATH "${ClickHouse_SOURCE_DIR}/contrib/corrosion/cmake"
 # Define function corrosion_import_crate()
 include ("${ClickHouse_SOURCE_DIR}/contrib/corrosion/cmake/Corrosion.cmake")
 
-# NOTE: this can also be done by overriding rustc, but it not trivial with rustup.
-set(RUST_CFLAGS "${CMAKE_C_FLAGS}")
-
 set(CXX_INCLUDE_DIR "${ClickHouse_SOURCE_DIR}/contrib/llvm-project/libcxx/include")
-set(RUST_CXXFLAGS "${CMAKE_CXX_FLAGS} -isystem ${CXX_INCLUDE_DIR} -nostdinc++")
+
+if (CMAKE_BUILD_TYPE_UC STREQUAL "DEBUG")
+    set(RUST_CFLAGS "${CMAKE_C_FLAGS} ${CMAKE_C_FLAGS_DEBUG}")
+    set(RUST_CXXFLAGS "${CMAKE_CXX_FLAGS} ${CMAKE_CXX_FLAGS_DEBUG} -isystem ${CXX_INCLUDE_DIR} -nostdinc++")
+else ()
+    set(RUST_CFLAGS "${CMAKE_C_FLAGS} ${CMAKE_C_FLAGS_RELWITHDEBINFO}")
+    set(RUST_CXXFLAGS "${CMAKE_CXX_FLAGS} ${CMAKE_CXX_FLAGS_RELWITHDEBINFO} -isystem ${CXX_INCLUDE_DIR} -nostdinc++")
+endif()
 
 if (CMAKE_OSX_SYSROOT)
     set(RUST_CXXFLAGS "${RUST_CXXFLAGS} -isysroot ${CMAKE_OSX_SYSROOT}")
@@ -80,7 +84,7 @@ else()
     set(RUSTCWRAPPER "")
 endif()
 
-set(RUSTFLAGS)
+# Note that RUSTFLAGS is defined in cpu_features.cmake
 if (CMAKE_OSX_DEPLOYMENT_TARGET)
     list(APPEND RUSTFLAGS "-C" "link-arg=-mmacosx-version-min=${CMAKE_OSX_DEPLOYMENT_TARGET}")
 endif()
@@ -116,3 +120,18 @@ set(RUST_VENDOR_DIR "${CMAKE_CURRENT_SOURCE_DIR}/../rust_vendor")
 # This needs to be done for each project using set_property(INTERFACE_CORROSION_CARGO_FLAGS)
 configure_file("config.toml.in" "config.toml" @ONLY)
 set (RUST_CONFIG_FILE "${CMAKE_CURRENT_BINARY_DIR}/config.toml" CACHE INTERNAL "Rust config")
+
+function(clickhouse_import_crate)
+    if (CMAKE_BUILD_TYPE_UC STREQUAL "DEBUG")
+        set(profile "")
+    else()
+        if (ENABLE_THINLTO)
+            set(profile "release-thinlto")
+        else()
+            set(profile "release")
+        endif()
+    endif()
+
+    corrosion_import_crate(${ARGN} NO_STD PROFILE ${profile} CRATE_TYPES staticlib LOCKED FLAGS --offline NO_DEFAULT_FEATURES)
+
+endfunction()

contrib/corrosion-cmake/CMakeLists.txt

@@ -1,6 +1,9 @@
 [env]
+# Used by skim
 CC = "@CMAKE_C_COMPILER@"
+CC_@Rust_CARGO_TARGET@ = "@CMAKE_C_COMPILER@"
 CXX = "@CMAKE_CXX_COMPILER@"
+CXX_@Rust_CARGO_TARGET@ = "@CMAKE_CXX_COMPILER@"
 CFLAGS = "@RUST_CFLAGS@"
 CXXFLAGS = "@RUST_CXXFLAGS@"
 
@@ -12,6 +15,15 @@ rustdocflags = @RUSTFLAGS@
 [unstable]
 @RUST_CARGO_BUILD_STD@
 
+[profile.release]
+debug = false
+strip = true
+
+# We use LTO to slightly decrease binary size
+[profile.release-thinlto]
+inherits = "release"
+lto = true
+
 [source.crates-io]
 registry = 'sparse+https://index.crates.io/'
 replace-with = 'local-registry'

contrib/corrosion-cmake/config.toml.in

@@ -6,8 +6,9 @@ include(ExternalProject)
 
 set(USE_DELTA_KERNEL_RS ${ENABLE_LIBRARIES})
 
-# TODO: Improve this
-# MSAN: ld.lld: error: undefined symbol: ring_core_0_17_9__bn_mul_mont_nohw / ld.lld: error: undefined symbol: ring_core_0_17_9__chacha20_poly1305_seal_avx2 ...
+# MSAN: Disabled because ring does not generate the appropriate symbols
+# NO_ARMV81_OR_HIGHER: Disabled because ring assumes that Neon is available with ARM
+# Darwin: Issues with reqwest -> system-configuration (requires other frameworks)
 if (NOT ENABLE_LIBRARIES OR NOT OS_LINUX OR (NOT ARCH_AMD64 AND NOT ARCH_AARCH64) OR (SANITIZE STREQUAL "memory") OR NO_ARMV81_OR_HIGHER OR NOT ENABLE_RUST)
   message(STATUS "Disabling delta kernel because of incompatible platform or Rust is disabled")
   set(USE_DELTA_KERNEL_RS 0)
@@ -19,9 +20,14 @@ if (NOT ENABLE_DELTA_KERNEL_RS)
   return()
 endif()
 
-# Path for autogenerated files (`delta_kernel_ffi.hpp`)
-set(DELTA_KERNEL_TARGET_PATH ${DELTA_KERNEL_RS_BINARY_DIR}/include)
+# Ideally we would disable all features to remove dependencies but:
+# * default-engine: Needed for its s3 client (we can't pass our own s3 client via ffi)
+# * delta_kernel/cloud: s3 client
+clickhouse_import_crate(
+        MANIFEST_PATH "${DELTA_KERNEL_RS_SOURCE_DIR}/ffi/Cargo.toml"
+        FEATURES "default-engine, delta_kernel/cloud")
 
+# We use our own OpenSSL headers and libs
 if(ARCH_AMD64)
     if(OS_DARWIN)
         set(PLATFORM_DIRECTORY darwin_x86_64)
@@ -47,30 +53,12 @@ endif()
 file(COPY ${ClickHouse_SOURCE_DIR}/contrib/openssl-cmake/${PLATFORM_DIRECTORY}/include/ DESTINATION ${DELTA_KERNEL_RS_BINARY_DIR}/${PLATFORM_DIRECTORY})
 file(COPY ${ClickHouse_SOURCE_DIR}/contrib/openssl/include/ DESTINATION ${DELTA_KERNEL_RS_BINARY_DIR}/${PLATFORM_DIRECTORY})
 
-if ("${CMAKE_BUILD_TYPE_UC}" STREQUAL "DEBUG")
-    SET(SSLNAME "ssld")
-    SET(CRYPTONAME "cryptod")
-else()
-    SET(SSLNAME "ssl")
-    SET(CRYPTONAME "crypto")
-endif()
-
-if ("${CMAKE_BUILD_TYPE_UC}" STREQUAL "DEBUG")
-    set(CMAKE_CONFIGURATION_TYPES "${CMAKE_BUILD_TYPE};release")
-else()
-    set(CMAKE_CONFIGURATION_TYPES "${CMAKE_BUILD_TYPE};debug")
-endif()
-
-if (CMAKE_BUILD_TYPE_UC STREQUAL "DEBUG")
-    set(profile "")
-else()
-    set(profile "release")
-endif()
+# Path for autogenerated files (`delta_kernel_ffi.hpp`)
+set(DELTA_KERNEL_TARGET_PATH ${DELTA_KERNEL_RS_BINARY_DIR}/include)
 
-corrosion_import_crate(MANIFEST_PATH "${DELTA_KERNEL_RS_SOURCE_DIR}/ffi/Cargo.toml" NO_STD PROFILE ${profile} CRATE_TYPES staticlib ALL_FEATURES FLAGS --offline)
 corrosion_set_env_vars(delta_kernel_ffi
         "CARGO_TARGET_DIR=${DELTA_KERNEL_TARGET_PATH}"
-        "OPENSSL_LIBS=${SSLNAME}:${CRYPTONAME}"
+        "OPENSSL_LIBS=ssl:crypto"
         "OPENSSL_STATIC=1"
         "OPENSSL_LIB_DIR=${CMAKE_BINARY_DIR}/contrib/openssl-cmake/"
         "OPENSSL_INCLUDE_DIR=${DELTA_KERNEL_RS_BINARY_DIR}/${PLATFORM_DIRECTORY}")

contrib/delta-kernel-rs-cmake/CMakeLists.txt

@@ -148,6 +148,8 @@ if (NOT CMAKE_HOST_SYSTEM_NAME STREQUAL CMAKE_SYSTEM_NAME
             "-DOPENSSL_INCLUDE_DIR=${OPENSSL_BUILD_DIR}/include"
             "-DZLIB_ROOT_DIR=${zlib_source_dir}"
             "-DgRPC_SSL_PROVIDER=package"
+            # TODO: Bump c-ares
+            "-DCMAKE_POLICY_VERSION_MINIMUM=3.5"
             "${_gRPC_SOURCE_DIR}"
         WORKING_DIRECTORY "${GRPC_CPP_PLUGIN_BUILD_DIR}"
         COMMAND_ECHO STDOUT

contrib/grpc-cmake/CMakeLists.txt

@@ -1,3 +1,5 @@
+cmake_minimum_required(VERSION 3.25)
+
 # Actually, so many 3rd party libraries + unit tests need SSL that we cannot disable it
 # without breaking the build ...
 set(ENABLE_SSL 1 CACHE INTERNAL "")

contrib/openssl-cmake/CMakeLists.txt

@@ -15,40 +15,6 @@ if (OS_FREEBSD)
     return()
 endif()
 
-function(clickhouse_import_crate)
-    # This is a workaround for Corrosion case sensitive build type matching in
-    # _generator_add_cargo_targets(), that leads to different paths in
-    # IMPORTED_LOCATION and real path of the library.
-    #
-    # It uses CMAKE_CONFIGURATION_TYPES and $<CONFIG>, so here we preserve the
-    # case of ${CMAKE_BUILD_TYPE} in ${CMAKE_CONFIGURATION_TYPES}.
-    if ("${CMAKE_BUILD_TYPE_UC}" STREQUAL "DEBUG")
-        set(CMAKE_CONFIGURATION_TYPES "${CMAKE_BUILD_TYPE};release")
-    else()
-        set(CMAKE_CONFIGURATION_TYPES "${CMAKE_BUILD_TYPE};debug")
-    endif()
-
-    if (CMAKE_BUILD_TYPE_UC STREQUAL "DEBUG")
-        set(profile "")
-    else()
-        if (ENABLE_THINLTO)
-            set(profile "release-thinlto")
-        else()
-            set(profile "release")
-        endif()
-    endif()
-
-    corrosion_import_crate(${ARGN} NO_STD PROFILE ${profile} LOCKED FLAGS --offline)
-
-endfunction()
-
-# TODO: add via properties if necessary
-## -Wno-dollar-in-identifier-extension: cxx bridge complies names with '$'
-## -Wno-unused-macros: unused CXXBRIDGE1_RUST_STRING
-#set(CXXBRIDGE_CXXFLAGS "-Wno-dollar-in-identifier-extension -Wno-unused-macros")
-#set(RUST_CXXFLAGS "${RUST_CXXFLAGS} ${CXXBRIDGE_CXXFLAGS}")
-#message(STATUS "RUST_CXXFLAGS (for skim): ${RUST_CXXFLAGS}")
-
 clickhouse_import_crate(MANIFEST_PATH Cargo.toml)
 
 # Set cargo config (see contrib/delta-kernel-rs-cmake/CMakeLists.txt)

rust/workspace/CMakeLists.txt

@@ -6,14 +6,6 @@ members = [
 ]
 resolver = "2"
 
-[profile.release]
-debug = false
-
-# We use LTO to slightly decrease binary size
-[profile.release-thinlto]
-inherits = "release"
-lto = true
-
 [patch.crates-io]
 # Ref: https://github.com/lotabout/tuikit/pull/51
 tuikit = { git = "https://github.com/azat-rust/tuikit.git", rev = "e1994c0e03ff02c49cf1471f0cc3cbf185ce0104" }