feat: turn dynamic lib into static (#8)

* replace dynamic to static lib * add precompiled library * add darwin arm64 * .a files * simplify readme * small fix * add linux arm64 * add readme --------- Co-authored-by: colinlyguo <[email protected]>
scroll-tech · Jun 5, 2024 · 32bfc9f · 32bfc9f
1 parent d7bcb62
commit 32bfc9f
Show file tree

Hide file tree

Showing 12 changed files with 41 additions and 30 deletions.
diff --git a/.gitignore b/.gitignore
@@ -5,7 +5,6 @@
 *.exe
 *.exe~
 *.dll
-*.a
 *.so
 *.dylib
 

diff --git a/Makefile b/Makefile
@@ -9,4 +9,4 @@ fmt:
 	gofumpt -l -w .
 
 test:
-	./run_test.sh
+	go test -v -race -gcflags="-l" -ldflags="-s=false" -coverprofile=coverage.txt -covermode=atomic ./...
diff --git a/README.md b/README.md
@@ -1,20 +1,22 @@
 # da-codec
 
+Scroll's DA encoding/decoding libraries.
+
 ## Running unit tests
 ```
-# Prepare dev-container
-docker pull scrolltech/go-rust-builder:go-1.21-rust-nightly-2023-12-03 --platform linux/amd64
-docker run -it --rm -v "$(PWD):/workspace" -w /workspace scrolltech/go-rust-builder:go-1.21-rust-nightly-2023-12-03
+go test -v -race ./...
+```
 
-# Compile libzstd
-cd libzstd && make libzstd && cd ..
-mkdir -p /scroll/lib/
-cp -f $(pwd)/libzstd/target/release/libscroll_zstd.so /scroll/lib/
+## FAQ
 
-# Set the environment variable
-export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:/scroll/lib/
-export CGO_LDFLAGS="-L/scroll/lib/ -Wl,-rpath,/scroll/lib/"
+**Q: Why the repo contains `libscroll_zstd*.a` binary files?**
 
-# Run unit tests
-go test -v -race ./...
-```
+A: This simplifies package installation with `go get` without the need to perform additional steps for building the `libscroll_zstd*.a`.
+
+**Q: Which platforms/architectures are supported?**
+
+A: `linux/amd64`, `linux/arm64`, `darwin/arm64`. Pull requests for other platforms/architectures are accepted.
+
+**Q: I don't trust `libscroll_zstd*.a` binary files from the repo or these files don't work on my OS/ARCH. How to rebuild them?**
+
+A: Just run `cd libzstd && make libzstd` if your OS/ARCH is supported.
diff --git a/encoding/codecv2/codecv2.go b/encoding/codecv2/codecv2.go
@@ -1,7 +1,6 @@
 package codecv2
 
 /*
-#cgo LDFLAGS: -lm -ldl -lscroll_zstd
 #include <stdint.h>
 char* compress_scroll_batch_bytes(uint8_t* src, uint64_t src_size, uint8_t* output_buf, uint64_t *output_buf_size);
 */

diff --git a/encoding/codecv2/libscroll_zstd_darwin_arm64.a b/encoding/codecv2/libscroll_zstd_darwin_arm64.a
diff --git a/encoding/codecv2/libscroll_zstd_darwin_arm64.go b/encoding/codecv2/libscroll_zstd_darwin_arm64.go
@@ -0,0 +1,6 @@
+package codecv2
+
+/*
+#cgo LDFLAGS: ${SRCDIR}/libscroll_zstd_darwin_arm64.a
+*/
+import "C"
diff --git a/encoding/codecv2/libscroll_zstd_linux_amd64.a b/encoding/codecv2/libscroll_zstd_linux_amd64.a
diff --git a/encoding/codecv2/libscroll_zstd_linux_amd64.go b/encoding/codecv2/libscroll_zstd_linux_amd64.go
@@ -0,0 +1,9 @@
+//go:build !musl
+// +build !musl
+
+package codecv2
+
+/*
+#cgo LDFLAGS: ${SRCDIR}/libscroll_zstd_linux_amd64.a
+*/
+import "C"
diff --git a/encoding/codecv2/libscroll_zstd_linux_arm64.a b/encoding/codecv2/libscroll_zstd_linux_arm64.a
diff --git a/encoding/codecv2/libscroll_zstd_linux_arm64.go b/encoding/codecv2/libscroll_zstd_linux_arm64.go
@@ -0,0 +1,9 @@
+//go:build !musl
+// +build !musl
+
+package codecv2
+
+/*
+#cgo LDFLAGS: ${SRCDIR}/libscroll_zstd_linux_arm64.a
+*/
+import "C"
diff --git a/libzstd/Cargo.toml b/libzstd/Cargo.toml
@@ -9,7 +9,7 @@ version = "0.1.0"
 edition = "2021"
 
 [lib]
-crate-type = ["cdylib"]
+crate-type = ["staticlib"]
 
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html

diff --git a/run_test.sh b/run_test.sh
-Original file line number
+Diff line change
@@ Expand Up / @@ -5,7 +5,6 @@ @@
     *.exe
     *.exe~
     *.dll
-    *.a
     *.so
     *.dylib
@@ Expand Down @@