Merge pull request #30 from TheBlueMatt/main

Clean up OSX support and build for aarch64-apple-darwin

diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
index b64b7c09c5d4b6e6b20500bfdaa0487be3965a1c..bf89b9f197f75533ddd074dfa3f8d2478c900c43 100644 (file)
--- a/.github/workflows/build.yml
+++ b/.github/workflows/build.yml
@@ -48,3 +48,46 @@ jobs:
             git diff --exit-code
           fi
 
+  osx:
+    strategy:
+      matrix:
+        include:
+          - platform: macos-10.15
+          - platform: macos-11
+    runs-on: ${{ matrix.platform }}
+    env:
+      TOOLCHAIN: stable
+    steps:
+      - name: Install other Rust platforms
+        run: rustup target install aarch64-apple-darwin
+      - name: Cache upstream LLVM/clang
+        id: cache-llvm
+        uses: actions/cache@v2
+        with:
+          path: clang+llvm-12.0.0-x86_64-apple-darwin.tar.xz
+          key: clang+llvm-12.0.0-x86_64-apple-darwin.tar.xz
+      - name: Fetch upstream LLVM/clang snapshot
+        if: steps.cache-llvm.outputs.cache-hit != 'true'
+        run: |
+          wget -O clang+llvm-12.0.0-x86_64-apple-darwin.tar.xz https://github.com/llvm/llvm-project/releases/download/llvmorg-12.0.0/clang+llvm-12.0.0-x86_64-apple-darwin.tar.xz
+          if [ "$(shasum -a 256 clang+llvm-12.0.0-x86_64-apple-darwin.tar.xz | awk '{ print $1 }')" != "7bc2259bf75c003f644882460fc8e844ddb23b27236fe43a2787870a4cd8ab50" ]; then
+            echo "Bad hash"
+            exit 1
+          fi
+      - name: Unpack upstream LLVM+clang and use it by default
+        run: |
+          tar xvvf clang+llvm-12.0.0-x86_64-apple-darwin.tar.xz
+      - name: Checkout source code
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Install cbindgen
+        run: cargo install --force cbindgen
+      - name: Checkout Rust-Lightning git
+        run: git clone https://github.com/rust-bitcoin/rust-lightning
+      - name: Rebuild bindings using Apple clang, and check the sample app builds + links
+        run: ./genbindings.sh ./rust-lightning true
+      - name: Rebuild bindings using upstream clang, and check the sample app builds + links
+        run: |
+          export PATH=`pwd`/clang+llvm-12.0.0-x86_64-apple-darwin/bin:$PATH
+          CC=clang ./genbindings.sh ./rust-lightning true

diff --git a/deterministic-build-wrappers/rustc b/deterministic-build-wrappers/rustc
index eba9cdad3940e73621325d33bb750144b62c842f..6a18b572101a2c72119b6876db86440e05b0d5a6 100755 (executable)
--- a/deterministic-build-wrappers/rustc
+++ b/deterministic-build-wrappers/rustc
@@ -27,4 +27,4 @@ for ((i=0; i<"${#args[@]}"; ++i)); do
     esac
 done
 
-/usr/bin/rustc "${args[@]}"
+$LDK_RUSTC_PATH "${args[@]}"

diff --git a/genbindings.sh b/genbindings.sh
index 0e426022ca334c03420239475f31fbb6bb07193f..812819dcbd3f98f98ab7195bfa8f9fcb85ad4647 100755 (executable)
--- a/genbindings.sh
+++ b/genbindings.sh
@@ -134,33 +134,54 @@ echo -e '\t"'"$BINDINGS_GIT"'".into()' >> lightning-c-bindings/src/version.rs
 echo -e '}' >> lightning-c-bindings/src/version.rs
 
 # Set path to include our rustc wrapper as well as cbindgen
+export LDK_RUSTC_PATH="$(which rustc)"
 PATH="$(pwd)/deterministic-build-wrappers:$PATH:~/.cargo/bin"
 # Now cd to lightning-c-bindings, build the generated bindings, and call cbindgen to build a C header file
 cd lightning-c-bindings
 
+# Set up CFLAGS and RUSTFLAGS vars appropriately for building libsecp256k1 and demo apps...
+BASE_CFLAGS="" # CFLAGS for libsecp256k1
+LOCAL_CFLAGS="" # CFLAGS for demo apps
+BASE_RUSTFLAGS="" # RUSTFLAGS
+
 # Remap paths so that our builds are deterministic
-export RUSTFLAGS="--remap-path-prefix $LIGHTNING_PATH=rust-lightning --remap-path-prefix $(pwd)=ldk-c-bindings --remap-path-prefix $HOME/.cargo= -C target-cpu=sandybridge"
+BASE_RUSTFLAGS="--remap-path-prefix $LIGHTNING_PATH=rust-lightning --remap-path-prefix $(pwd)=ldk-c-bindings --remap-path-prefix $HOME/.cargo="
 
 # If the C compiler supports it, also set -ffile-prefix-map
 echo "int main() {}" > genbindings_path_map_test_file.c
 clang -o /dev/null -ffile-prefix-map=$HOME/.cargo= genbindings_path_map_test_file.c > /dev/null 2>&1 &&
-# Now that we've done our last non-LTO build, turn on LTO in CFLAGS as well
-export BASE_CFLAGS="-ffile-prefix-map=$HOME/.cargo= -frandom-seed=42"
+export BASE_CFLAGS="-ffile-prefix-map=$HOME/.cargo="
+
+BASE_CFLAGS="$BASE_CFLAGS -frandom-seed=42"
+LOCAL_CFLAGS="-Wall -Wno-nullability-completeness -pthread -Iinclude/"
+
+if [ "$HOST_PLATFORM" = "host: x86_64-apple-darwin" ]; then
+       LOCAL_CFLAGS="$LOCAL_CFLAGS -isysroot$(xcrun --show-sdk-path)"
+       BASE_CFLAGS="$BASE_CFLAGS -isysroot$(xcrun --show-sdk-path)"
+       # Targeting aarch64 appears to be supported only starting with Big Sur, so check it before use
+       clang -o /dev/null -target=aarch64-apple-darwin -mcpu=apple-a14 genbindings_path_map_test_file.c > /dev/null 2>&1 &&
+       export CFLAGS_aarch64_apple_darwin="$BASE_CFLAGS -target=aarch64-apple-darwin -mcpu=apple-a14"
+fi
+
+rm genbindings_path_map_test_file.c
+
 ENV_TARGET=$(rustc --version --verbose | grep host | awk '{ print $2 }' | sed 's/-/_/g')
 case "$ENV_TARGET" in
        "x86_64"*)
-               export RUSTFLAGS="$RUSTFLAGS -C target-cpu=sandybridge"
+               export RUSTFLAGS="$BASE_RUSTFLAGS -C target-cpu=sandybridge"
                export CFLAGS_$ENV_TARGET="$BASE_CFLAGS -march=sandybridge -mcpu=sandybridge -mtune=sandybridge"
                ;;
        *)
                # Assume this isn't targeted at another host and build for the host's CPU.
-               export RUSTFLAGS="$RUSTFLAGS -C target-cpu=native"
+               export RUSTFLAGS="$BASE_RUSTFLAGS -C target-cpu=native"
                export CFLAGS_$ENV_TARGET="$BASE_CFLAGS -mcpu=native"
                ;;
 esac
-rm genbindings_path_map_test_file.c
 
 cargo build
+if [ "$CFLAGS_aarch64_apple_darwin" != "" ]; then
+       RUSTFLAGS="$BASE_RUSTFLAGS -C target-cpu=apple-a14" cargo build --target aarch64-apple-darwin
+fi
 cbindgen -v --config cbindgen.toml -o include/lightning.h >/dev/null 2>&1
 
 # cbindgen is relatively braindead when exporting typedefs -
@@ -182,9 +203,6 @@ else
 fi
 
 # Finally, sanity-check the generated C and C++ bindings with demo apps:
-
-LOCAL_CFLAGS="-Wall -Wno-nullability-completeness -pthread -Iinclude/"
-
 # Naively run the C demo app:
 gcc $LOCAL_CFLAGS -Wall -g -pthread demo.c target/debug/libldk.a -ldl
 ./a.out
@@ -243,23 +261,13 @@ fi
 RUSTC_LLVM_V=$(rustc --version --verbose | grep "LLVM version" | awk '{ print substr($3, 0, 2); }' | tr -d '.')
 
 if [ "$HOST_PLATFORM" = "host: x86_64-apple-darwin" ]; then
-       # Apple is special, as always, and decided that they must ensure that there is no way to identify
-       # the LLVM version used. Why? Just to make your life hard.
-       # This list is taken from https://en.wikipedia.org/wiki/Xcode
-       APPLE_CLANG_V=$(clang --version | head -n1 | awk '{ print $4 }')
-       if [ "$APPLE_CLANG_V" = "10.0.0" ]; then
-               CLANG_LLVM_V="6"
-       elif [ "$APPLE_CLANG_V" = "10.0.1" ]; then
-               CLANG_LLVM_V="7"
-       elif [ "$APPLE_CLANG_V" = "11.0.0" ]; then
-               CLANG_LLVM_V="8"
-       elif [ "$APPLE_CLANG_V" = "11.0.3" ]; then
-               CLANG_LLVM_V="9"
-       elif [ "$APPLE_CLANG_V" = "12.0.0" ]; then
-               CLANG_LLVM_V="10"
-       else
-               echo "WARNING: Unable to identify Apple clang LLVM version"
+       # Apple is special, as always, and their versions of clang aren't
+       # compatible with upstream LLVM.
+       if [ "$(clang --version | grep 'Apple clang')" != "" ]; then
+               echo "Apple clang isn't compatible with upstream clang, install upstream clang"
                CLANG_LLVM_V="0"
+       else
+               CLANG_LLVM_V=$(clang --version | head -n1 | awk '{ print substr($4, 0, 2); }' | tr -d '.')
        fi
 else
        CLANG_LLVM_V=$(clang --version | head -n1 | awk '{ print substr($4, 0, 2); }' | tr -d '.')
@@ -270,7 +278,12 @@ if [ "$CLANG_LLVM_V" = "$RUSTC_LLVM_V" ]; then
        CLANGPP=clang++
 elif [ "$(which clang-$RUSTC_LLVM_V)" != "" ]; then
        CLANG="$(which clang-$RUSTC_LLVM_V)"
-       CLANGPP="$(which clang++-$RUSTC_LLVM_V)"
+       CLANGPP="$(which clang++-$RUSTC_LLVM_V || echo clang++)"
+       if [ "$($CLANG --version)" != "$($CLANGPP --version)" ]; then
+               echo "$CLANG and $CLANGPP are not the same version of clang!"
+               unset CLANG
+               unset CLANGPP
+       fi
 fi
 
 if [ "$CLANG" != "" -a "$CLANGPP" = "" ]; then
@@ -287,6 +300,9 @@ if [ "$HOST_PLATFORM" = "host: x86_64-unknown-linux-gnu" -o "$HOST_PLATFORM" = "
                else
                        sed -i.bk 's/,"cdylib"]/]/g' Cargo.toml
                fi
+               if [ "$CFLAGS_aarch64_apple_darwin" != "" ]; then
+                       RUSTFLAGS="$BASE_RUSTFLAGS -C target-cpu=apple-a14" RUSTC_BOOTSTRAP=1 cargo rustc --target aarch64-apple-darwin -v -- -Zsanitizer=address -Cforce-frame-pointers=yes || ( mv Cargo.toml.bk Cargo.toml; exit 1)
+               fi
                RUSTC_BOOTSTRAP=1 cargo rustc -v -- -Zsanitizer=address -Cforce-frame-pointers=yes || ( mv Cargo.toml.bk Cargo.toml; exit 1)
                mv Cargo.toml.bk Cargo.toml
 
@@ -340,6 +356,10 @@ if [ "$2" = "false" -a "$(rustc --print target-list | grep wasm32-wasi)" != "" ]
        rm genbindings_wasm_test_file.c
 fi
 
+if [ "$CFLAGS_aarch64_apple_darwin" != "" ]; then
+       RUSTFLAGS="$BASE_RUSTFLAGS -C target-cpu=apple-a14" CARGO_PROFILE_RELEASE_LTO=true cargo rustc -v --release --target aarch64-apple-darwin -- -C lto
+fi
+
 if [ "$HOST_PLATFORM" != "host: x86_64-apple-darwin" -a "$CLANGPP" != "" ]; then
        # Finally, test cross-language LTO. Note that this will fail if rustc and clang++
        # build against different versions of LLVM (eg when rustc is installed via rustup