fix(c): enable linking to static builds

lidavidm · lidavidm · commit 148dd2095b2e · 2025-04-23T23:08:34.000+09:00
Fixes #2562.
diff --git a/c/cmake_modules/GoUtils.cmake b/c/cmake_modules/GoUtils.cmake
@@ -57,7 +57,7 @@ function(adbc_add_static_library target_name base_name)
       PROPERTIES
       IMPORTED_LOCATION "${_IMPORT_PREFIX}/bin/${static_base_name}")
   else()
-    set(prefix "${_IMPORT_PREFIX}/${ADBC_IMPORT_LIB_DIR}")
+    set(prefix "${_IMPORT_PREFIX}/${ADBC_INSTALL_LIBDIR}")
     set_target_properties(${target_name}
       PROPERTIES
       IMPORTED_LOCATION "${prefix}/${static_base_name}")
diff --git a/c/driver/bigquery/AdbcDriverBigQueryConfig.cmake.in b/c/driver/bigquery/AdbcDriverBigQueryConfig.cmake.in
@@ -33,7 +33,7 @@ if(ADBC_BUILD_SHARED)
 endif()
 
 if(ADBC_BUILD_STATIC)
-  adbc_add_shared_library(
+  adbc_add_static_library(
     AdbcDriverBigQuery::adbc_driver_bigquery_static
     adbc_driver_bigquery)
 endif()
diff --git a/c/driver/flightsql/AdbcDriverFlightSQLConfig.cmake.in b/c/driver/flightsql/AdbcDriverFlightSQLConfig.cmake.in
@@ -33,7 +33,7 @@ if(ADBC_BUILD_SHARED)
 endif()
 
 if(ADBC_BUILD_STATIC)
-  adbc_add_shared_library(
+  adbc_add_static_library(
     AdbcDriverFlightSQL::adbc_driver_flightsql_static
     adbc_driver_flightsql)
 endif()
diff --git a/c/driver/postgresql/AdbcDriverPostgreSQLConfig.cmake.in b/c/driver/postgresql/AdbcDriverPostgreSQLConfig.cmake.in
@@ -17,8 +17,12 @@
 
 @PACKAGE_INIT@
 
+include(CMakeFindDependencyMacro)
+
 set(ADBC_VERSION "@ADBC_VERSION@")
 
 include("${CMAKE_CURRENT_LIST_DIR}/AdbcDriverPostgreSQLTargets.cmake")
 
+find_dependency(PostgreSQL)
+
 check_required_components(AdbcDriverPostgreSQL)
diff --git a/c/driver/postgresql/copy/writer.h b/c/driver/postgresql/copy/writer.h
@@ -498,9 +498,9 @@ class PostgresCopyListFieldWriter : public PostgresCopyFieldWriter {
       NANOARROW_RETURN_NOT_OK(WriteChecked<int32_t>(buffer, lb, error));
     }
 
-    ArrowBufferAppend(buffer, tmp->data, tmp->size_bytes);
+    NANOARROW_RETURN_NOT_OK(ArrowBufferAppend(buffer, tmp->data, tmp->size_bytes));
 
-    return ADBC_STATUS_OK;
+    return NANOARROW_OK;
   }
 
  private:
diff --git a/c/driver/postgresql/postgres_type.h b/c/driver/postgresql/postgres_type.h
@@ -349,7 +349,7 @@ class PostgresType {
         !typname_.empty() ? typname_.c_str() : PostgresTypname(type_id_);
     nanoarrow::UniqueBuffer buffer;
 
-    ArrowMetadataBuilderInit(buffer.get(), nullptr);
+    NANOARROW_RETURN_NOT_OK(ArrowMetadataBuilderInit(buffer.get(), nullptr));
     // TODO(lidavidm): we have deprecated this in favor of arrow.opaque,
     // remove once we feel enough time has passed
     NANOARROW_RETURN_NOT_OK(ArrowMetadataBuilderAppend(
diff --git a/c/driver/snowflake/AdbcDriverSnowflakeConfig.cmake.in b/c/driver/snowflake/AdbcDriverSnowflakeConfig.cmake.in
@@ -33,7 +33,7 @@ if(ADBC_BUILD_SHARED)
 endif()
 
 if(ADBC_BUILD_STATIC)
-  adbc_add_shared_library(
+  adbc_add_static_library(
     AdbcDriverSnowflake::adbc_driver_snowflake_static
     adbc_driver_snowflake)
 endif()
diff --git a/c/driver/sqlite/AdbcDriverSQLiteConfig.cmake.in b/c/driver/sqlite/AdbcDriverSQLiteConfig.cmake.in
@@ -17,8 +17,12 @@
 
 @PACKAGE_INIT@
 
+include(CMakeFindDependencyMacro)
+
 set(ADBC_VERSION "@ADBC_VERSION@")
 
 include("${CMAKE_CURRENT_LIST_DIR}/AdbcDriverSQLiteTargets.cmake")
 
+find_dependency(SQLite3)
+
 check_required_components(AdbcDriverSQLite)
diff --git a/c/integration/static_test/CMakeLists.txt b/c/integration/static_test/CMakeLists.txt
@@ -0,0 +1,46 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+cmake_minimum_required(VERSION 3.18)
+
+project(adbc-static-test LANGUAGES C CXX)
+set(CMAKE_C_STANDARD 11)
+set(CMAKE_C_STANDARD_REQUIRED ON)
+
+find_package(AdbcDriverBigQuery REQUIRED)
+find_package(AdbcDriverFlightSQL REQUIRED)
+find_package(AdbcDriverPostgreSQL REQUIRED)
+find_package(AdbcDriverSQLite REQUIRED)
+find_package(AdbcDriverSnowflake REQUIRED)
+
+find_package(fmt REQUIRED)
+find_package(nanoarrow REQUIRED)
+
+add_executable(static_test main.c)
+# We need to link the C++ standard library since some of the drivers are
+# written in C++.
+set_target_properties(static_test PROPERTIES LINKER_LANGUAGE CXX)
+target_link_libraries(static_test
+                      PRIVATE AdbcDriverBigQuery::adbc_driver_bigquery_static
+                              AdbcDriverFlightSQL::adbc_driver_flightsql_static
+                              AdbcDriverPostgreSQL::adbc_driver_postgresql_static
+                              AdbcDriverSQLite::adbc_driver_sqlite_static
+                              AdbcDriverSnowflake::adbc_driver_snowflake_static
+                              PostgreSQL::PostgreSQL
+                              SQLite::SQLite3
+                              fmt::fmt
+                              nanoarrow::nanoarrow)
diff --git a/c/integration/static_test/README.md b/c/integration/static_test/README.md
@@ -0,0 +1,23 @@
+<!---
+  Licensed to the Apache Software Foundation (ASF) under one
+  or more contributor license agreements.  See the NOTICE file
+  distributed with this work for additional information
+  regarding copyright ownership.  The ASF licenses this file
+  to you under the Apache License, Version 2.0 (the
+  "License"); you may not use this file except in compliance
+  with the License.  You may obtain a copy of the License at
+
+    http://www.apache.org/licenses/LICENSE-2.0
+
+  Unless required by applicable law or agreed to in writing,
+  software distributed under the License is distributed on an
+  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+  KIND, either express or implied.  See the License for the
+  specific language governing permissions and limitations
+  under the License.
+-->
+
+# Static Linking Test
+
+This is only used to test that static linking with multiple drivers behaves as
+expected.  See the docker-compose job `cpp-static-test`.
diff --git a/c/integration/static_test/main.c b/c/integration/static_test/main.c
@@ -0,0 +1,61 @@
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+#include <stdio.h>
+#include <stdlib.h>
+#include <string.h>
+
+#include <arrow-adbc/adbc.h>
+
+AdbcStatusCode PostgresqlDriverInit(int version, void* raw_driver,
+                                    struct AdbcError* error);
+AdbcStatusCode SqliteDriverInit(int version, void* raw_driver, struct AdbcError* error);
+
+int main(int argc, char** argv) {
+  struct AdbcError error;
+
+  struct AdbcDriver postgresql;
+  struct AdbcDriver sqlite;
+
+  memset(&error, 0, sizeof(error));
+  memset(&postgresql, 0, sizeof(postgresql));
+  memset(&sqlite, 0, sizeof(sqlite));
+
+  AdbcStatusCode status = PostgresqlDriverInit(ADBC_VERSION_1_1_0, &postgresql, &error);
+  if (status != ADBC_STATUS_OK) {
+    if (error.release) {
+      fprintf(stderr, "PostgresqlDriverInit failed: %s\n", error.message);
+      error.release(&error);
+    } else {
+      fprintf(stderr, "PostgresqlDriverInit failed\n");
+    }
+    return EXIT_FAILURE;
+  }
+
+  status = SqliteDriverInit(ADBC_VERSION_1_1_0, &sqlite, &error);
+  if (status != ADBC_STATUS_OK) {
+    if (error.release) {
+      fprintf(stderr, "SqliteDriverInit failed: %s\n", error.message);
+      error.release(&error);
+    } else {
+      fprintf(stderr, "SqliteDriverInit failed\n");
+    }
+    return EXIT_FAILURE;
+  }
+
+  return EXIT_SUCCESS;
+}
diff --git a/ci/scripts/cpp_static_test.sh b/ci/scripts/cpp_static_test.sh
@@ -0,0 +1,94 @@
+#!/usr/bin/env bash
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements.  See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership.  The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License.  You may obtain a copy of the License at
+#
+#   http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied.  See the License for the
+# specific language governing permissions and limitations
+# under the License.
+
+# Test building a simple application using the static drivers, ensuring that
+# symbols do not clash and all dependencies are present.
+# https://github.com/apache/arrow-adbc/issues/2562
+
+set -euo pipefail
+
+main() {
+    local -r source_dir="${1}"
+    local -r build_dir="${2}"
+    local -r install_dir="${3}"
+
+    mkdir -p "${build_dir}"
+
+    echo "Install fmt"
+    if [ ! -d "${build_dir}/fmt" ]; then
+        git clone https://github.com/fmtlib/fmt.git --branch 11.1.4 --depth 1 "${build_dir}/fmt"
+    fi
+    mkdir -p "${build_dir}/fmt/build"
+    pushd "${build_dir}/fmt/build"
+    cmake "${build_dir}/fmt" \
+          -DCMAKE_BUILD_TYPE=Release \
+          -DCMAKE_INSTALL_PREFIX="${install_dir}" \
+          -DCMAKE_POSITION_INDEPENDENT_CODE=TRUE \
+          -DFMT_DOC=OFF \
+          -DFMT_TEST=OFF
+    cmake --build "${build_dir}/fmt/build" --target install -j
+    popd
+
+    echo "Install nanoarrow"
+    if [ ! -d "${build_dir}/nanoarrow" ]; then
+        git clone https://github.com/apache/arrow-nanoarrow.git --depth 1 "${build_dir}/nanoarrow"
+    fi
+    mkdir -p "${build_dir}/nanoarrow/build"
+    pushd "${build_dir}/nanoarrow/build"
+    cmake "${build_dir}/nanoarrow" \
+          -DCMAKE_BUILD_TYPE=Release \
+          -DCMAKE_INSTALL_PREFIX="${install_dir}" \
+          -DCMAKE_POSITION_INDEPENDENT_CODE=TRUE
+    cmake --build "${build_dir}/nanoarrow/build" --target install -j
+    popd
+
+    echo "Install ADBC"
+    mkdir -p "${build_dir}/install"
+    pushd "${build_dir}/install"
+    env \
+        ADBC_BUILD_SHARED=OFF \
+        ADBC_BUILD_STATIC=ON \
+        ADBC_BUILD_TESTS=OFF \
+        ADBC_USE_ASAN=OFF \
+        ADBC_USE_UBSAN=OFF \
+        ADBC_CMAKE_ARGS="-DADBC_WITH_VENDORED_FMT=OFF -DADBC_WITH_VENDORED_NANOARROW=OFF" \
+        "${source_dir}/ci/scripts/cpp_build.sh" \
+        "${source_dir}" \
+        "${build_dir}/install" \
+        "${install_dir}"
+    popd
+
+    # No shared libraries should exist
+    if find "${install_dir}" | grep -E "libadbc.*\.so"; then
+        echo "Found ADBC shared libraries, which should not exist for this test"
+        return 1
+    fi
+
+    echo "Build test application"
+    mkdir -p "${build_dir}/test"
+    pushd "${build_dir}/test"
+    cmake "${source_dir}/c/integration/static_test" \
+          -DCMAKE_PREFIX_PATH="${install_dir}" \
+          -DCMAKE_VERBOSE_MAKEFILE=ON
+    cmake --build "${build_dir}" --target static_test
+
+    "${build_dir}/static_test"
+    popd
+}
+
+main "$@"
diff --git a/compose.yaml b/compose.yaml
@@ -34,6 +34,7 @@ services:
 
   # Build/test with latest Clang
   cpp-clang-latest:
+    image: ${REPO}:${ARCH}-cpp-clang-latest-adbc
     build:
       context: .
       dockerfile: ci/docker/cpp-clang-latest.dockerfile
@@ -44,6 +45,7 @@ services:
     command: "bash -c 'git config --global --add safe.directory /adbc && /adbc/ci/scripts/cpp_build.sh /adbc /adbc/build/clang-latest && env BUILD_ALL=0 BUILD_DRIVER_MANAGER=1 BUILD_DRIVER_SQLITE=1 /adbc/ci/scripts/cpp_test.sh /adbc/build/clang-latest'"
 
   cpp-gcc-latest:
+    image: ${REPO}:${ARCH}-cpp-gcc-latest-adbc
     build:
       context: .
       dockerfile: ci/docker/cpp-gcc-latest.dockerfile
@@ -54,6 +56,15 @@ services:
       - .:/adbc:delegated
     command: "bash -c 'git config --global --add safe.directory /adbc && /adbc/ci/scripts/cpp_build.sh /adbc /adbc/build/gcc-latest && env BUILD_ALL=0 BUILD_DRIVER_MANAGER=1 BUILD_DRIVER_SQLITE=1 /adbc/ci/scripts/cpp_test.sh /adbc/build/gcc-latest'"
 
+  # Test building and installing the static libraries, then try linking to them.
+  cpp-static-test:
+    image: ${REPO}:${ARCH}-cpp-clang-latest-adbc
+    volumes:
+      - .:/adbc:delegated
+    # TODO: this should use system fmt, nanoarrow
+    command: "bash -c 'git config --global --add safe.directory /adbc && env ADBC_BUILD_SHARED=OFF ADBC_BUILD_STATIC=ON ADBC_BUILD_TESTS=OFF ADBC_USE_ASAN=OFF ADBC_USE_UBSAN=OFF /adbc/ci/scripts/cpp_build.sh /adbc /adbc/build/static-deps /adbc/build/local && /adbc/ci/scripts/cpp_static_test.sh /adbc /adbc/build/static-test /adbc/build/local'"
+
+
   ############################ Documentation ###################################
 
   docs:

Original file line number	Diff line number	Diff line change
`@@ -498,9 +498,9 @@ class PostgresCopyListFieldWriter : public PostgresCopyFieldWriter {`
`498`	`498`	`NANOARROW_RETURN_NOT_OK(WriteChecked<int32_t>(buffer, lb, error));`
`499`	`499`	`}`
`500`	`500`
`501`		`- ArrowBufferAppend(buffer, tmp->data, tmp->size_bytes);`
	`501`	`+ NANOARROW_RETURN_NOT_OK(ArrowBufferAppend(buffer, tmp->data, tmp->size_bytes));`
`502`	`502`
`503`		`- return ADBC_STATUS_OK;`
	`503`	`+ return NANOARROW_OK;`
`504`	`504`	`}`
`505`	`505`
`506`	`506`	`private:`