Skip to content

Commit

Permalink
feat(java/driver/jni): add JNI bindings to native driver manager
Browse files Browse the repository at this point in the history
  • Loading branch information
lidavidm committed Jan 3, 2025
1 parent a3d6589 commit 7df6826
Show file tree
Hide file tree
Showing 23 changed files with 1,258 additions and 6 deletions.
34 changes: 34 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -316,6 +316,40 @@ mvn install -Perrorprone
[checker-framework]: https://checkerframework.org/
[errorprone]: https://errorprone.info/

#### JNI

To build the JNI bridge, the native components must be built.

```
# Build the driver manager
export ADBC_BUILD_STATIC=ON
export ADBC_BUILD_TESTS=OFF
export ADBC_USE_ASAN=OFF
export ADBC_USE_UBSAN=OFF
export BUILD_ALL=OFF
export BUILD_DRIVER_MANAGER=ON
export BUILD_DRIVER_SQLITE=ON
./ci/scripts/cpp_build.sh $(pwd) $(pwd)/build $(pwd)/local
# Build the JNI libraries
./ci/scripts/java_jni_build.sh $(pwd) $(pwd)/java/build $(pwd)/local
```

Now build the Java code with the `jni` Maven profile enabled. To run tests,
the SQLite driver must also be present in (DY)LD_LIBRARY_PATH.

```
export LD_LIBRARY_PATH=$(pwd)/local/lib
pushd java
mvn install -Pjni
popd
```

This will build a JAR with native libraries for a single platform. If the
native libraries are built for multiple platforms, they can all be copied to
appropriate paths in the resources directory to build a single JAR that works
across multiple platforms.

### Python

Python libraries are managed with [setuptools][setuptools]. See
Expand Down
2 changes: 1 addition & 1 deletion c/driver_manager/adbc_driver_manager.cc
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,7 @@ struct ManagedLibrary {

void* handle = dlopen(library, RTLD_NOW | RTLD_LOCAL);
if (!handle) {
error_message = "[DriverManager] dlopen() failed: ";
error_message = "dlopen() failed: ";
error_message += dlerror();

// If applicable, append the shared library prefix/extension and
Expand Down
4 changes: 1 addition & 3 deletions docker-compose.yml
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,6 @@ services:
build:
context: .
dockerfile: ci/docker/cpp-clang-latest.dockerfile
args:
VCPKG: ${VCPKG}
volumes:
- .:/adbc:delegated
command: "bash -c 'export PATH=$PATH:/opt/go/bin CC=$(which clang) CXX=$(which clang++) && git config --global --add safe.directory /adbc && /adbc/ci/scripts/cpp_build.sh /adbc /adbc/build && env BUILD_ALL=0 BUILD_DRIVER_MANAGER=1 BUILD_DRIVER_SQLITE=1 /adbc/ci/scripts/cpp_test.sh /adbc/build'"
Expand All @@ -56,7 +54,7 @@ services:
command: |
/bin/bash -c 'git config --global --add safe.directory /adbc && source /opt/conda/etc/profile.d/conda.sh && mamba create -y -n adbc -c conda-forge go --file /adbc/ci/conda_env_cpp.txt --file /adbc/ci/conda_env_docs.txt --file /adbc/ci/conda_env_java.txt --file /adbc/ci/conda_env_python.txt && conda activate adbc && /adbc/ci/scripts/cpp_build.sh /adbc /adbc/build && /adbc/ci/scripts/go_build.sh /adbc /adbc/build && /adbc/ci/scripts/python_build.sh /adbc /adbc/build && /adbc/ci/scripts/r_build.sh /adbc && /adbc/ci/scripts/docs_build.sh /adbc'
############################ Java JARs ######################################
################################### Java ###################################

java-dist:
image: ${ARCH}/maven:${MAVEN}-jdk-${JDK}
Expand Down
61 changes: 61 additions & 0 deletions java/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -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.

cmake_minimum_required(VERSION 3.16)
message(STATUS "Building using CMake version: ${CMAKE_VERSION}")

# find_package() uses <PackageName>_ROOT variables.
# https://cmake.org/cmake/help/latest/policy/CMP0074.html
if(POLICY CMP0074)
cmake_policy(SET CMP0074 NEW)
endif()

project(adbc-java)

if("${CMAKE_CXX_STANDARD}" STREQUAL "")
set(CMAKE_CXX_STANDARD 17)
endif()
set(CMAKE_CXX_STANDARD_REQUIRED ON)

include(GNUInstallDirs)

# Dependencies

find_package(Java REQUIRED)
find_package(JNI REQUIRED)

include(UseJava)

# ADBC_ARCH_DIR is derived from the architecture. The user can override this
# variable if auto-detection fails.
if("${ADBC_ARCH_DIR}" STREQUAL "")
if("${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "aarch64")
set(ADBC_ARCH_DIR "aarch_64")
elseif("${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "i386")
set(ADBC_ARCH_DIR "x86_64")
elseif("${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "arm64")
set(ADBC_ARCH_DIR "aarch_64")
elseif("${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "AMD64")
set(ADBC_ARCH_DIR "x86_64")
elseif("${CMAKE_SYSTEM_PROCESSOR}" STREQUAL "x86_64")
set(ADBC_ARCH_DIR "x86_64")
else()
message(FATAL_ERROR "Unsupported architecture: ${CMAKE_SYSTEM_PROCESSOR}")
endif()
endif()

add_subdirectory(driver/jni)
3 changes: 1 addition & 2 deletions java/driver/flight-sql/pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,7 @@
<dependency>
<groupId>com.github.ben-manes.caffeine</groupId>
<artifactId>caffeine</artifactId>
<!-- Latest version still supporting Java 8 -->
<version>2.9.3</version>
<version>3.1.8</version>
</dependency>
<dependency>
<groupId>com.google.protobuf</groupId>
Expand Down
38 changes: 38 additions & 0 deletions java/driver/jni/CMakeLists.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# 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.

find_package(AdbcDriverManager)

add_jar(adbc_driver_jni_jar
SOURCES src/main/java/org/apache/arrow/adbc/driver/jni/impl/NativeAdbc.java
src/main/java/org/apache/arrow/adbc/driver/jni/impl/NativeAdbcException.java
src/main/java/org/apache/arrow/adbc/driver/jni/impl/NativeHandle.java
src/main/java/org/apache/arrow/adbc/driver/jni/impl/NativeHandleType.java
src/main/java/org/apache/arrow/adbc/driver/jni/impl/NativeQueryResult.java
GENERATE_NATIVE_HEADERS
adbc_driver_jni_headers)

add_library(adbc_driver_jni SHARED src/main/cpp/jni_wrapper.cc)
target_link_libraries(adbc_driver_jni adbc_driver_jni_headers JNI::JNI
AdbcDriverManager::adbc_driver_manager_static)

set(ADBC_DRIVER_JNI_C_LIBDIR "adbc_driver_jni/${ADBC_ARCH_DIR}")
set(ADBC_DRIVER_JNI_C_BINDIR "adbc_driver_jni/${ADBC_ARCH_DIR}")

install(TARGETS adbc_driver_jni
LIBRARY DESTINATION ${ADBC_DRIVER_JNI_C_LIBDIR}
RUNTIME DESTINATION ${ADBC_DRIVER_JNI_C_BINDIR})
102 changes: 102 additions & 0 deletions java/driver/jni/pom.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--
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.
-->
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.apache.arrow.adbc</groupId>
<artifactId>arrow-adbc-java-root</artifactId>
<version>0.16.0-SNAPSHOT</version>
<relativePath>../../pom.xml</relativePath>
</parent>

<artifactId>adbc-driver-jni</artifactId>
<packaging>jar</packaging>
<name>Arrow ADBC Driver Native</name>
<description>An ADBC driver wrapping the native driver manager.</description>

<dependencies>
<!-- Arrow -->
<dependency>
<groupId>org.apache.arrow</groupId>
<artifactId>arrow-c-data</artifactId>
</dependency>
<dependency>
<groupId>org.apache.arrow</groupId>
<artifactId>arrow-memory-core</artifactId>
</dependency>
<dependency>
<groupId>org.apache.arrow</groupId>
<artifactId>arrow-vector</artifactId>
</dependency>

<dependency>
<groupId>org.apache.arrow.adbc</groupId>
<artifactId>adbc-core</artifactId>
</dependency>
<dependency>
<groupId>org.apache.arrow.adbc</groupId>
<artifactId>adbc-driver-manager</artifactId>
</dependency>

<!-- Static analysis and linting -->
<dependency>
<groupId>org.checkerframework</groupId>
<artifactId>checker-qual</artifactId>
</dependency>

<!-- Testing -->
<dependency>
<groupId>org.assertj</groupId>
<artifactId>assertj-core</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.vintage</groupId>
<artifactId>junit-vintage-engine</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.apache.arrow</groupId>
<artifactId>flight-sql-jdbc-core</artifactId>
<version>${dep.arrow.version}</version>
<classifier>tests</classifier>
<scope>test</scope>
</dependency>
</dependencies>

<build>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-surefire-plugin</artifactId>
<configuration combine.self="append">
<systemPropertyVariables>
<arrow.test.dataRoot>${project.basedir}/../../../testing/data</arrow.test.dataRoot>
</systemPropertyVariables>
</configuration>
</plugin>
</plugins>
</build>
</project>
Loading

0 comments on commit 7df6826

Please sign in to comment.