Merge #158

158: Add sysroot support for GNU based toolchains r=jethrogb a=landhb

This PR adds sysroot detection for GNU based toolchains for targets like `aarch64-unknown-linux-musl`. This prevents bindgen from using incorrect headers when generating bindings. 

For instance when using cross, the aarch64 musl sysroot is installed in /usr/local/aarch64-linux-musl/ but bindgen/clang will attempt to look for headers in /usr/include unless `--sysroot` is provided.

Co-authored-by: landhb <[email protected]>
Co-authored-by: Jethro Beekman <[email protected]>

Author: 3 people

.travis.yml

@@ -20,17 +20,26 @@ addons:
     - clang-3.9
     - clang-11
     - cmake
+    - qemu-user
 rust:
    - stable
-   - beta
-   - nightly
-   - nightly-2021-03-25
 env:
+  jobs:
+    # Matrix build of 3 targets against Rust stable
+    - TARGET=x86_64-unknown-linux-gnu ZLIB_INSTALLED=true AES_NI_SUPPORT=true
+    - TARGET=aarch64-unknown-linux-musl
+    - TARGET=x86_64-fortanix-unknown-sgx
   global:
     - RUST_BACKTRACE=1
     # Pinned to this particular nightly version because of core_io. This can be
     # re-pinned whenever core_io is updated to the latest nightly.
     - CORE_IO_NIGHTLY=nightly-2021-03-25
     - LLVM_CONFIG_PATH=llvm-config-3.9
+jobs:
+  include:
+    # Test additional Rust toolchains on x86_64
+    - rust: beta
+    - rust: nightly
+    - rust: nightly-2021-03-25
 script:
   - ./ct.sh

ct.sh

@@ -1,4 +1,4 @@
-#!/bin/sh
+#!/bin/bash
 set -ex
 cd "$(dirname "$0")"
 
@@ -9,26 +9,50 @@ if [ -z $TRAVIS_RUST_VERSION ]; then
     exit 1
 fi
 
+if [ "$TARGET" == "aarch64-unknown-linux-musl" ]; then
+  pushd /tmp && wget https://musl.cc/aarch64-linux-musl-cross.tgz;
+  tar -xzf aarch64-linux-musl-cross.tgz;
+  popd;
+fi
+
 export CFLAGS_x86_64_fortanix_unknown_sgx="-isystem/usr/include/x86_64-linux-gnu -mlvi-hardening -mllvm -x86-experimental-lvi-inline-asm-hardening"
 export CC_x86_64_fortanix_unknown_sgx=clang-11
+export CC_aarch64_unknown_linux_musl=/tmp/aarch64-linux-musl-cross/bin/aarch64-linux-musl-gcc
+export CARGO_TARGET_AARCH64_UNKNOWN_LINUX_MUSL_LINKER=/tmp/aarch64-linux-musl-cross/bin/aarch64-linux-musl-gcc
+export CARGO_TARGET_AARCH64_UNKNOWN_LINUX_MUSL_RUNNER=qemu-aarch64
+
+# Temporary workaround for MbedTLS 2.26.0 https://github.com/ARMmbed/mbedtls/pull/4237
+export CFLAGS_aarch64_unknown_linux_musl="-Wformat-truncation"
 
-if [ $TRAVIS_RUST_VERSION = "stable" ] || [ $TRAVIS_RUST_VERSION = "beta" ] || [ $TRAVIS_RUST_VERSION = "nightly" ]; then
+if [ "$TRAVIS_RUST_VERSION" == "stable" ] || [ "$TRAVIS_RUST_VERSION" == "beta" ] || [ "$TRAVIS_RUST_VERSION" == "nightly" ]; then
+    # Install the rust toolchain
     rustup default $TRAVIS_RUST_VERSION
-    # make sure that explicitly providing the default target works
-    cargo test --target x86_64-unknown-linux-gnu
-    cargo test --features zlib
-    cargo test --features pkcs12
-    cargo test --features pkcs12_rc2
-    cargo test --features force_aesni_support
-    cargo test --features dsa
+    rustup target add --toolchain $TRAVIS_RUST_VERSION $TARGET
 
-    rustup target add --toolchain $TRAVIS_RUST_VERSION x86_64-fortanix-unknown-sgx
-    cargo +$TRAVIS_RUST_VERSION test --no-run --target=x86_64-fortanix-unknown-sgx
+    # The SGX target cannot be run under test like a ELF binary
+    if [ "$TARGET" != "x86_64-fortanix-unknown-sgx" ]; then 
+        # make sure that explicitly providing the default target works
+        cargo test --target $TARGET
+        cargo test --features pkcs12 --target $TARGET
+        cargo test --features pkcs12_rc2 --target $TARGET
+        cargo test --features dsa --target $TARGET
+
+        # If zlib is installed, test the zlib feature
+        if [ -n "$ZLIB_INSTALLED" ]; then
+            cargo test --features zlib --target $TARGET
+        fi
+
+        # If AES-NI is supported, test the feature
+        if [ -n "$AES_NI_SUPPORT" ]; then
+            cargo test --features force_aesni_support --target $TARGET
+        fi
+    else
+        cargo +$TRAVIS_RUST_VERSION test --no-run --target=$TARGET
+    fi
 
 elif [ $TRAVIS_RUST_VERSION = $CORE_IO_NIGHTLY ]; then
     cargo +$CORE_IO_NIGHTLY test --no-default-features --features no_std_deps,rdrand,time
     cargo +$CORE_IO_NIGHTLY test --no-default-features --features no_std_deps,rdrand
-
 else
     echo "Unknown version $TRAVIS_RUST_VERSION"
     exit 1

mbedtls-sys/build/bindgen.rs

@@ -98,6 +98,24 @@ impl super::BuildConfig {
             cc.flag(cflag);
         }
 
+        // Determine the sysroot for this compiler so that bindgen
+        // uses the correct headers
+        let compiler = cc.get_compiler();
+        if compiler.is_like_gnu() {
+            let output = compiler.to_command().args(&["--print-sysroot"]).output();
+            match output {
+                Ok(sysroot) => {
+                    let path = std::str::from_utf8(&sysroot.stdout).expect("Malformed sysroot");
+                    let trimmed_path = path
+                        .strip_suffix("\r\n")
+                        .or(path.strip_suffix("\n"))
+                        .unwrap_or(&path);
+                    cc.flag(&format!("--sysroot={}", trimmed_path));
+                }
+                _ => {} // skip toolchains without a configured sysroot
+            };
+        }
+
         let bindings = bindgen::builder()
             .clang_args(cc.get_compiler().args().iter().map(|arg| arg.to_str().unwrap()))
             .header_contents("bindgen-input.h", &input)

mbedtls/src/bignum/mod.rs

@@ -173,7 +173,7 @@ impl Mpi {
             mpi_write_string(
                 &self.inner,
                 radix,
-                buf.as_mut_ptr() as *mut i8,
+                buf.as_mut_ptr() as *mut _,
                 buf.len(),
                 &mut olen,
             )

mbedtls/src/pk/mod.rs

@@ -131,7 +131,7 @@ const CUSTOM_PK_INFO: pk_info_t = {
         sign_func: None,
         verify_func: None,
         get_bitlen: None,
-        name: b"\0" as *const u8 as *const i8,
+        name: b"\0" as *const u8 as *const _,
         ctx_alloc_func: Some(alloc_custom_pk_ctx),
         ctx_free_func: Some(free_custom_pk_ctx),
     }