Replace Zig cross-compilation with native library artifact

benalexau · benalexau · commit e5b510c00a69 · 2025-10-30T15:56:03.000+11:00
Commit 288bb09 introduced Zig cross-compilation of LMDB (#217). Benchmarking as part of #262 revealed the cross-compiled libraries are significantly slower than LMDB compiled with native toolchains. Using the methodology from e634b3f: Library Source Score (ms) Delta vs Baseline -------------------------------------------------------------- System Arch Linux (GCC) 45.00 Baseline Fetched Arch Linux (GCC) 45.03 +0.05% Zig unoptimized (debug) 59.01 +31.12% Zig optimized (-O2 stripped) 58.82 +30.70% This removes Zig cross-compilation and adopts the org.lmdbjava:native artifact, which packages LMDB libraries compiled with native toolchains from distribution package managers. This simplifies building as Zig installation and cross-compile.sh are no longer required.
diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml
@@ -22,23 +22,9 @@ jobs:
         java-version: 25
         cache: maven
 
-    - name: Install Zig
-      uses: mlugg/setup-zig@v2
-
-    - name: Cross compile using Zig
-      run: ./cross-compile.sh
-
     - name: Build with Maven
       run: mvn -B verify -DgcRecordWrites=1000
 
-    - name: Store built native libraries for later jobs
-      uses: actions/upload-artifact@v4
-      with:
-        name: native-libraries
-        path: |
-          src/main/resources/org/lmdbjava/*.so
-          src/main/resources/org/lmdbjava/*.dll
-
     - name: Upload code coverage to Codecov
       uses: codecov/codecov-action@v5
       env:
@@ -65,12 +51,6 @@ jobs:
           java-version: ${{ matrix.java }}
           cache: maven
 
-      - name: Fetch built native libraries
-        uses: actions/download-artifact@v4
-        with:
-          name: native-libraries
-          path: src/main/resources/org/lmdbjava
-
       - name: Execute verifier
         run: mvn -B test -Dtest=VerifierTest -DverificationSeconds=10
 
@@ -104,12 +84,6 @@ jobs:
         gpg-private-key: ${{ secrets.gpg_private_key }}
         gpg-passphrase: MAVEN_GPG_PASSPHRASE
 
-    - name: Install Zig
-      uses: mlugg/setup-zig@v2
-
-    - name: Cross compile using Zig
-      run: ./cross-compile.sh
-
     - name: Publish Maven package
       run: mvn -B -Pcentral-deploy deploy -DskipTests
       env:
diff --git a/README.md b/README.md
@@ -57,21 +57,10 @@ any questions.
 
 ### Building
 
-This project uses [Zig](https://ziglang.org/) to cross-compile the LMDB native
-library for all supported architectures. To locally build LmdbJava you must
-firstly install a recent version of Zig and then execute the project's
-[cross-compile.sh](https://github.com/lmdbjava/lmdbjava/tree/master/cross-compile.sh)
-script. This only needs to be repeated when the `cross-compile.sh` script is
-updated (eg following a new official release of the upstream LMDB library).
-
-If you do not wish to install Zig and/or use an operating system which cannot
-easily execute the `cross-compile.sh` script, you can download the compiled
-LMDB native library for your platform from a location of your choice and set the
-`lmdbjava.native.lib` system property to the resulting file system
-location. Possible sources of a compiled LMDB native library include operating
-system package managers, running `cross-compile.sh` on a supported system, or
-copying it from the `org/lmdbjava` directory of any recent, officially released
-LmdbJava JAR.
+LmdbJava uses a standard Maven build. Its native libraries are provided by the
+[`org.lmdbjava:native`](https://github.com/lmdbjava/native) dependency.
+
+To use a different LMDB library, set `lmdbjava.native.lib` system property to the file path.
 
 ### Contributing
 
diff --git a/cross-compile.sh b/cross-compile.sh
diff --git a/pom.xml b/pom.xml
@@ -39,6 +39,7 @@
     <jnr-ffi.version>2.2.18</jnr-ffi.version>
     <junit.version>5.14.0</junit.version>
     <license-maven-plugin.version>4.6</license-maven-plugin.version>
+    <lmdbjava-native.version>0.9.33-2</lmdbjava-native.version>
     <maven-clean-plugin.version>3.5.0</maven-clean-plugin.version>
     <maven-compiler-plugin.version>3.14.1</maven-compiler-plugin.version>
     <maven-dependency-plugin.version>3.9.0</maven-dependency-plugin.version>
@@ -120,6 +121,11 @@
       <version>${junit.version}</version>
       <scope>test</scope>
     </dependency>
+    <dependency>
+      <groupId>org.lmdbjava</groupId>
+      <artifactId>native</artifactId>
+      <version>${lmdbjava-native.version}</version>
+    </dependency>
     <dependency>
       <groupId>org.mockito</groupId>
       <artifactId>mockito-inline</artifactId>
@@ -407,20 +413,9 @@
   </licenses>
   <developers>
     <developer>
-      <id>krisskross</id>
-      <name>Kristoffer Sjogren</name>
-      <email>stoffe -at- gmail.com</email>
-      <url>http://stoffe.deephacks.org/</url>
-      <organization/>
-      <timezone>+1</timezone>
-    </developer>
-    <developer>
-      <id>benalexau</id>
-      <name>Ben Alex</name>
-      <email>ben.alex@acegi.com.au</email>
-      <url>https://github.com/benalexau/</url>
-      <organization>Acegi Technology Pty Limited</organization>
-      <timezone>+10</timezone>
+      <id>lmdbjava</id>
+      <name>The LmdbJava Open Source Project</name>
+      <url>https://github.com/lmdbjava</url>
     </developer>
   </developers>
   <scm>
diff --git a/src/main/java/org/lmdbjava/TargetName.java b/src/main/java/org/lmdbjava/TargetName.java
@@ -43,7 +43,7 @@ public final class TargetName {
    * Java system property name that can be set to override the embedded library that will be used.
    * This is likely to be required if automatic resolution fails but the user still prefers to use
    * an LmdbJava-bundled library. This path must include the classpath prefix (usually <code>
-   * org/lmdbjava</code>).
+   * org/lmdbjava/native</code>).
    */
   public static final String LMDB_EMBEDDED_LIB_PROP = "lmdbjava.embedded.lib";
 
@@ -94,7 +94,7 @@ static String resolveFilename(
 
     final String pkg = TargetName.class.getPackage().getName().replace('.', '/');
     return pkg
-        + "/"
+        + "/native/"
         + resolveArch(arch)
         + "-"
         + resolveOs(os)
diff --git a/src/main/resources/org/lmdbjava/.gitignore b/src/main/resources/org/lmdbjava/.gitignore
diff --git a/src/test/java/org/lmdbjava/TargetNameTest.java b/src/test/java/org/lmdbjava/TargetNameTest.java
@@ -61,7 +61,7 @@ void externalTakesPriority() {
   }
 
   private void embed(final String lib, final String arch, final String os) {
-    assertThat(resolveFilename(NONE, NONE, arch, os)).isEqualTo("org/lmdbjava/" + lib);
+    assertThat(resolveFilename(NONE, NONE, arch, os)).isEqualTo("org/lmdbjava/native/" + lib);
     assertThat(isExternal(NONE)).isFalse();
   }
 }

Original file line number	Diff line number	Diff line change
`@@ -61,7 +61,7 @@ void externalTakesPriority() {`
`61`	`61`	`}`
`62`	`62`
`63`	`63`	`private void embed(final String lib, final String arch, final String os) {`
`64`		`- assertThat(resolveFilename(NONE, NONE, arch, os)).isEqualTo("org/lmdbjava/" + lib);`
	`64`	`+ assertThat(resolveFilename(NONE, NONE, arch, os)).isEqualTo("org/lmdbjava/native/" + lib);`
`65`	`65`	`assertThat(isExternal(NONE)).isFalse();`
`66`	`66`	`}`
`67`	`67`	`}`