X-Git-Url: http://git.bitcoin.ninja/index.cgi?p=ldk-c-bindings;a=blobdiff_plain;f=genbindings.sh;h=cd100f6a86f1fd00d81de86bc3a5df28435f910d;hp=812819dcbd3f98f98ab7195bfa8f9fcb85ad4647;hb=3559b05697ad226c82994bfb6b3d09657d21bbe2;hpb=e05f70891c1ee75306d62203ec61d272c18504c0 diff --git a/genbindings.sh b/genbindings.sh index 812819d..cd100f6 100755 --- a/genbindings.sh +++ b/genbindings.sh @@ -20,6 +20,55 @@ cd "$ORIG_PWD" # Generate (and reasonably test) C bindings +# First we set various compiler flags... +HOST_PLATFORM="$(rustc --version --verbose | grep "host:")" + +# Set path to include our rustc wrapper as well as cbindgen +export LDK_RUSTC_PATH="$(which rustc)" +export RUSTC="$(pwd)/deterministic-build-wrappers/rustc" +PATH="$PATH:~/.cargo/bin" + +# 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 +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 && +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 + export MACOSX_DEPLOYMENT_TARGET=10.9 + LOCAL_CFLAGS="$LOCAL_CFLAGS -isysroot$(xcrun --show-sdk-path) -mmacosx-version-min=10.9" + BASE_CFLAGS="$BASE_CFLAGS -isysroot$(xcrun --show-sdk-path) -mmacosx-version-min=10.9" + # Targeting aarch64 appears to be supported only starting with Big Sur, so check it before use + clang -o /dev/null $BASE_CFLAGS --target=aarch64-apple-darwin -mcpu=apple-a14 genbindings_path_map_test_file.c && + export CFLAGS_aarch64_apple_darwin="$BASE_CFLAGS --target=aarch64-apple-darwin -mcpu=apple-a14" || + echo "WARNING: Can not build targeting aarch64-apple-darin. Upgrade to Big Sur or try upstream clang" +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="$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="$BASE_RUSTFLAGS -C target-cpu=native" + export CFLAGS_$ENV_TARGET="$BASE_CFLAGS -mcpu=native" + ;; +esac + # First build the latest c-bindings-gen binary cd c-bindings-gen && cargo build --release && cd .. @@ -77,8 +126,6 @@ OUT_F="$(pwd)/lightning-c-bindings/include/ldk_rust_types.h" OUT_CPP="$(pwd)/lightning-c-bindings/include/lightningpp.hpp" BIN="$(pwd)/c-bindings-gen/target/release/c-bindings-gen" -HOST_PLATFORM="$(rustc --version --verbose | grep "host:")" - function add_crate() { pushd "$LIGHTNING_PATH/$1" RUSTC_BOOTSTRAP=1 cargo rustc --profile=check $3 -- -Zunstable-options --pretty=expanded > /tmp/$1-crate-source.txt @@ -133,51 +180,9 @@ echo -e 'pub extern "C" fn _ldk_c_bindings_get_compiled_version() -> crate::c_ty 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 -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 && -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="$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="$BASE_RUSTFLAGS -C target-cpu=native" - export CFLAGS_$ENV_TARGET="$BASE_CFLAGS -mcpu=native" - ;; -esac - cargo build if [ "$CFLAGS_aarch64_apple_darwin" != "" ]; then RUSTFLAGS="$BASE_RUSTFLAGS -C target-cpu=apple-a14" cargo build --target aarch64-apple-darwin @@ -207,15 +212,23 @@ fi gcc $LOCAL_CFLAGS -Wall -g -pthread demo.c target/debug/libldk.a -ldl ./a.out -# And run the C++ demo app in valgrind to test memory model correctness and lack of leaks. +# And run the C++ demo app g++ $LOCAL_CFLAGS -std=c++11 -Wall -g -pthread demo.cpp -Ltarget/debug/ -lldk -ldl +LD_LIBRARY_PATH=target/debug/ ./a.out > /dev/null + +# Finally, run the C++ demo app with our native networking library +# in valgrind to test memory model correctness and lack of leaks. +gcc $LOCAL_CFLAGS -std=c99 -Wall -g -pthread -I../ldk-net ../ldk-net/ldk_net.c -c -o ldk_net.o +g++ $LOCAL_CFLAGS -std=c++11 -Wall -g -pthread -DREAL_NET -I../ldk-net ldk_net.o demo.cpp target/debug/libldk.a -ldl if [ -x "`which valgrind`" ]; then - LD_LIBRARY_PATH=target/debug/ valgrind --error-exitcode=4 --memcheck:leak-check=full --show-leak-kinds=all ./a.out + valgrind --error-exitcode=4 --memcheck:leak-check=full --show-leak-kinds=all ./a.out echo else echo "WARNING: Please install valgrind for more testing" + ./a.out fi + # Test a statically-linked C++ version, tracking the resulting binary size and runtime # across debug, LTO, and cross-language LTO builds (using the same compiler each time). clang++ $LOCAL_CFLAGS -std=c++11 demo.cpp target/debug/libldk.a -ldl @@ -230,7 +243,7 @@ if [ "$HOST_PLATFORM" = "host: x86_64-unknown-linux-gnu" ]; then LLVM_V=$(rustc +nightly --version --verbose | grep "LLVM version" | awk '{ print substr($3, 0, 2); }') if [ -x "$(which clang-$LLVM_V)" ]; then cargo +nightly clean - cargo +nightly rustc -Zbuild-std --target x86_64-unknown-linux-gnu -v -- -Zsanitizer=memory -Zsanitizer-memory-track-origins -Cforce-frame-pointers=yes + cargo +nightly rustc -Zbuild-std=std,panic_abort --target x86_64-unknown-linux-gnu -v -- -Zsanitizer=memory -Zsanitizer-memory-track-origins -Cforce-frame-pointers=yes mv target/x86_64-unknown-linux-gnu/debug/libldk.* target/debug/ # Sadly, std doesn't seem to compile into something that is memsan-safe as of Aug 2020, @@ -246,6 +259,11 @@ if [ "$HOST_PLATFORM" = "host: x86_64-unknown-linux-gnu" ]; then clang++-$LLVM_V $LOCAL_CFLAGS -std=c++11 -fsanitize=memory -fsanitize-memory-track-origins -g demo.cpp target/debug/libldk.a -ldl ./a.out >/dev/null + # ...then the C++ demo app with the ldk_net network implementation + clang-$LLVM_V $LOCAL_CFLAGS -std=c99 -fsanitize=memory -fsanitize-memory-track-origins -g -I../ldk-net ../ldk-net/ldk_net.c -c -o ldk_net.o + clang++-$LLVM_V $LOCAL_CFLAGS -std=c++11 -fsanitize=memory -fsanitize-memory-track-origins -g -DREAL_NET -I../ldk-net ldk_net.o demo.cpp target/debug/libldk.a -ldl + ./a.out >/dev/null + # restore exit-on-failure set -e else @@ -258,7 +276,7 @@ else echo "WARNING: Can't use memory sanitizer on non-Linux, non-x86 platforms" fi -RUSTC_LLVM_V=$(rustc --version --verbose | grep "LLVM version" | awk '{ print substr($3, 0, 2); }' | tr -d '.') +RUSTC_LLVM_V=$(rustc --version --verbose | grep "LLVM version" | awk '{ print substr($3, 0, 4); }') if [ "$HOST_PLATFORM" = "host: x86_64-apple-darwin" ]; then # Apple is special, as always, and their versions of clang aren't @@ -267,16 +285,26 @@ if [ "$HOST_PLATFORM" = "host: x86_64-apple-darwin" ]; 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 '.') + CLANG_LLVM_V=$(clang --version | head -n1 | awk '{ print substr($4, 0, 4); }') + if [ -x "$(which ld64.lld)" ]; then + LLD_LLVM_V="$(ld64.lld --version | awk '{ print substr($2, 0, 4); }')" + fi fi else - CLANG_LLVM_V=$(clang --version | head -n1 | awk '{ print substr($4, 0, 2); }' | tr -d '.') + CLANG_LLVM_V=$(clang --version | head -n1 | awk '{ print substr($4, 0, 4); }') + if [ -x "$(which ld.lld)" ]; then + LLD_LLVM_V="$(ld.lld --version | awk '{ print substr($2, 0, 4); }')" + fi fi + if [ "$CLANG_LLVM_V" = "$RUSTC_LLVM_V" ]; then CLANG=clang CLANGPP=clang++ -elif [ "$(which clang-$RUSTC_LLVM_V)" != "" ]; then + if [ "$LLD_LLVM_V" = "$CLANG_LLVM_V" ]; then + LLD=lld + fi +elif [ -x "$(which clang-$RUSTC_LLVM_V)" ]; then CLANG="$(which clang-$RUSTC_LLVM_V)" CLANGPP="$(which clang++-$RUSTC_LLVM_V || echo clang++)" if [ "$($CLANG --version)" != "$($CLANGPP --version)" ]; then @@ -284,6 +312,14 @@ elif [ "$(which clang-$RUSTC_LLVM_V)" != "" ]; then unset CLANG unset CLANGPP fi + if [ "$LLD_LLVM_V" != "$RUSTC_LLVM_V" ]; then + LLD="$(which lld-$RUSTC_LLVM_V || echo lld)" + LLD_LLVM_V="$(ld.$LLD --version | awk '{ print substr($2, 0, 4); }')" + if [ "$LLD_LLVM_V" != "$RUSTC_LLVM_V" ]; then + echo "Could not find a workable version of lld, not using cross-language LTO" + unset LLD + fi + fi fi if [ "$CLANG" != "" -a "$CLANGPP" = "" ]; then @@ -313,6 +349,11 @@ if [ "$HOST_PLATFORM" = "host: x86_64-unknown-linux-gnu" -o "$HOST_PLATFORM" = " # ...then the C++ demo app $CLANGPP $LOCAL_CFLAGS -std=c++11 -fsanitize=address -g demo.cpp target/debug/libldk.a -ldl ASAN_OPTIONS='detect_leaks=1 detect_invalid_pointer_pairs=1 detect_stack_use_after_return=1' ./a.out >/dev/null + + # ...then the C++ demo app with the ldk_net network implementation + $CLANG $LOCAL_CFLAGS -fsanitize=address -g -I../ldk-net ../ldk-net/ldk_net.c -c -o ldk_net.o + $CLANGPP $LOCAL_CFLAGS -std=c++11 -fsanitize=address -g -DREAL_NET -I../ldk-net ldk_net.o demo.cpp target/debug/libldk.a -ldl + ASAN_OPTIONS='detect_leaks=1 detect_invalid_pointer_pairs=1 detect_stack_use_after_return=1' ./a.out >/dev/null else echo "WARNING: Please install clang-$RUSTC_LLVM_V and clang++-$RUSTC_LLVM_V to build with address sanitizer" fi @@ -324,7 +365,7 @@ fi # Clear stale release build artifacts from previous runs cargo clean --release CARGO_PROFILE_RELEASE_LTO=true cargo rustc -v --release -- -C lto -clang++ $LOCAL_CFLAGS -std=c++11 -flto -O2 demo.cpp target/release/libldk.a -ldl +clang++ $LOCAL_CFLAGS -std=c++11 -O2 demo.cpp target/release/libldk.a -ldl strip ./a.out echo "C++ Bin size and runtime with only RL (LTO) optimized:" @@ -356,11 +397,26 @@ if [ "$2" = "false" -a "$(rustc --print target-list | grep wasm32-wasi)" != "" ] rm genbindings_wasm_test_file.c fi +EXTRA_TARGETS=( $LDK_C_BINDINGS_EXTRA_TARGETS ) +EXTRA_CCS=( $LDK_C_BINDINGS_EXTRA_TARGET_CCS ) + +if [ ${#EXTRA_TARGETS[@]} != ${#EXTRA_CCS[@]} ]; then + echo "LDK_C_BINDINGS_EXTRA_TARGETS and LDK_C_BINDINGS_EXTRA_TARGET_CCS didn't have the same number of elements!" + exit 1 +fi + +for IDX in ${!EXTRA_TARGETS[@]}; do + EXTRA_ENV_TARGET=$(echo "${EXTRA_TARGETS[$IDX]}" | sed 's/-/_/g') + export CFLAGS_$EXTRA_ENV_TARGET="$BASE_CFLAGS" + export CC_$EXTRA_ENV_TARGET=${EXTRA_CCS[$IDX]} + RUSTFLAGS="$BASE_RUSTFLAGS -C linker=${EXTRA_CCS[$IDX]}" CARGO_PROFILE_RELEASE_LTO=true cargo rustc -v --release --target "${EXTRA_TARGETS[$IDX]}" -- -C lto +done + 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 +if [ "$HOST_PLATFORM" != "host: x86_64-apple-darwin" -a "$CLANGPP" != "" -a "$LLD" != "" ]; 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 # or Ubuntu packages). This should work fine on Distros which do more involved @@ -369,7 +425,7 @@ if [ "$HOST_PLATFORM" != "host: x86_64-apple-darwin" -a "$CLANGPP" != "" ]; then export CFLAGS_$ENV_TARGET="$BASE_CFLAGS -O3 -fPIC -fembed-bitcode -march=sandybridge" # Rust doesn't recognize CFLAGS changes, so we need to clean build artifacts cargo clean --release - CARGO_PROFILE_RELEASE_LTO=true cargo rustc -v --release -- -C linker-plugin-lto -C lto -C link-arg=-fuse-ld=lld + CARGO_PROFILE_RELEASE_LTO=true cargo rustc -v --release -- -C linker-plugin-lto -C lto -C linker=$CLANG -C link-arg=-fuse-ld=$LLD $CLANGPP $LOCAL_CFLAGS -flto -fuse-ld=lld -O2 demo.cpp target/release/libldk.a -ldl strip ./a.out echo "C++ Bin size and runtime with cross-language LTO:"