cdylib: apply versioning to symbols

Author: folkertdev

.github/workflows/checks.yaml

@@ -123,7 +123,7 @@ jobs:
 
       # build
       - name: cargo build
-        run: cargo build --target ${{matrix.target}} ${{ matrix.flags }}
+        run: cargo build -vv --target ${{matrix.target}} ${{ matrix.flags }}
 
       # ensure tests for "real" features work standalone
       - name: cargo test --no-default-features --features ...
@@ -390,6 +390,13 @@ jobs:
         run: |
           cargo build --release --target ${{matrix.target}} --features=semver-prefix
           objdump -tT target/${{matrix.target}}/release/deps/libz_rs.so | grep -q -E "LIBZ_RS_SYS_v0.[0-9]+.x_uncompress" || (echo "symbol not found!" && exit 1)
+      - name: "cdylib: version-symbols"
+        working-directory: libz-rs-sys-cdylib
+        run: |
+          cargo build --release --target ${{matrix.target}} --features=version-symbols
+          objdump -T target/${{matrix.target}}/release/deps/libz_rs.so
+          objdump -T target/${{matrix.target}}/release/deps/libz_rs.so | grep "ZLIB"
+          objdump -T target/${{matrix.target}}/release/deps/libz_rs.so | grep -q -E "ZLIB_1.2.2.3 deflateTune" || (echo "symbol not found!" && exit 1)
       - run: sudo apt-get update && sudo apt-get install -y --no-install-recommends valgrind
       - name: "cdylib: example.c"
         env:

libz-rs-sys-cdylib/Cargo.toml

@@ -12,7 +12,7 @@ rust-version = "1.75" # MSRV
 
 [lib]
 name = "z_rs" # turns into e.g. `libz_rs.so`
-crate-type = ["cdylib", "lib"]
+crate-type = ["cdylib", "staticlib", "lib"]
 
 [profile.dev]
 panic = "abort" # abort on panics. This is crucial, unwinding would cause UB!
@@ -29,6 +29,7 @@ c-allocator = ["libz-rs-sys/c-allocator"] # by default, use malloc/free for memo
 rust-allocator = ["libz-rs-sys/rust-allocator", "libz-rs-sys/std"] # by default, use the rust global alloctor for memory allocation
 custom-prefix = ["libz-rs-sys/custom-prefix"] # use the LIBZ_RS_SYS_PREFIX to prefix all exported symbols
 semver-prefix = ["libz-rs-sys/semver-prefix"] # prefix all symbols in a semver-compatible way
+version-symbols = []
 capi = []
 gz = ["dep:libc"] # support for the `gz*` functions is experimental
 gzprintf = []

libz-rs-sys-cdylib/build.rs

@@ -0,0 +1,25 @@
+use std::{env, path::PathBuf};
+
+fn main() {
+    // Prevent fighting over the symbol version between libz-rs and us in the test crate.
+    if env::var_os("CARGO_FEATURE_VERSION_SYMBOLS").is_none() {
+        return;
+    }
+
+    let os = env::var("CARGO_CFG_TARGET_OS").unwrap_or_default();
+    match os.as_str() {
+        "linux" | "android" => { /* fall through */ }
+        _ => return,
+    };
+
+    let map = PathBuf::from(env::var("CARGO_MANIFEST_DIR").unwrap()).join("zlib.map");
+
+    println!("cargo:rerun-if-changed={}", map.display());
+
+    println!(
+        "cargo:rustc-link-arg=-Wl,--version-script={}",
+        map.display()
+    );
+
+    println!("cargo:rustc-link-arg=-Wl,--undefined-version");
+}

libz-rs-sys-cdylib/zlib.map

@@ -0,0 +1,98 @@
+ZLIB_1.2.0 {
+  global:
+    compressBound;
+    deflateBound;
+    inflateBack;
+    inflateBackEnd;
+    inflateBackInit_;
+    inflateCopy;
+  local:
+    deflate_copyright;
+    inflate_copyright;
+    zcalloc;
+    zcfree;
+    z_errmsg;
+    gz_error;
+    gz_intmax;
+    _*;
+};
+
+ZLIB_1.2.0.2 {
+    gzclearerr;
+    gzungetc;
+    zlibCompileFlags;
+} ZLIB_1.2.0;
+
+ZLIB_1.2.0.8 {
+    deflatePrime;
+} ZLIB_1.2.0.2;
+
+ZLIB_1.2.2 {
+    adler32_combine;
+    crc32_combine;
+    deflateSetHeader;
+    inflateGetHeader;
+} ZLIB_1.2.0.8;
+
+ZLIB_1.2.2.3 {
+    deflateTune;
+    gzdirect;
+} ZLIB_1.2.2;
+
+ZLIB_1.2.2.4 {
+    inflatePrime;
+} ZLIB_1.2.2.3;
+
+ZLIB_1.2.3.3 {
+    adler32_combine64;
+    crc32_combine64;
+    gzopen64;
+    gzseek64;
+    gztell64;
+    inflateUndermine;
+} ZLIB_1.2.2.4;
+
+ZLIB_1.2.3.4 {
+    inflateReset2;
+    inflateMark;
+} ZLIB_1.2.3.3;
+
+ZLIB_1.2.3.5 {
+    gzbuffer;
+    gzoffset;
+    gzoffset64;
+    gzclose_r;
+    gzclose_w;
+} ZLIB_1.2.3.4;
+
+ZLIB_1.2.5.1 {
+    deflatePending;
+} ZLIB_1.2.3.5;
+
+ZLIB_1.2.5.2 {
+    deflateResetKeep;
+    gzgetc_;
+    inflateResetKeep;
+} ZLIB_1.2.5.1;
+
+ZLIB_1.2.7.1 {
+    inflateGetDictionary;
+    gzvprintf;
+} ZLIB_1.2.5.2;
+
+ZLIB_1.2.9 {
+    inflateCodesUsed;
+    inflateValidate;
+    uncompress2;
+    gzfread;
+    gzfwrite;
+    deflateGetDictionary;
+    adler32_z;
+    crc32_z;
+} ZLIB_1.2.7.1;
+
+ZLIB_1.2.12 {
+    crc32_combine_gen;
+    crc32_combine_gen64;
+    crc32_combine_op;
+} ZLIB_1.2.9;