git.bitcoin.ninja Git - rust-lightning/blob - genbindings.sh

   1 #!/usr/bin/env bash
   2
   3 set -e
   4 set -x
   5
   6 # Generate (and reasonably test) C bindings
   7
   8 # First build the latest c-bindings-gen binary
   9 cd c-bindings-gen && cargo build && cd ..
  10
  11 # Then wipe all the existing C bindings (because we're being run in the right directory)
  12 # note that we keep the few manually-generated files first:
  13 mv lightning-c-bindings/src/c_types/mod.rs ./
  14 mv lightning-c-bindings/src/bitcoin ./
  15
  16 rm -rf lightning-c-bindings/src
  17
  18 mkdir -p lightning-c-bindings/src/c_types/
  19 mv ./mod.rs lightning-c-bindings/src/c_types/
  20 mv ./bitcoin lightning-c-bindings/src/
  21
  22 # Finally, run the c-bindings-gen binary, building fresh bindings.
  23 SRC="$(pwd)/lightning/src"
  24 OUT="$(pwd)/lightning-c-bindings/src"
  25 OUT_TEMPL="$(pwd)/lightning-c-bindings/src/c_types/derived.rs"
  26 OUT_F="$(pwd)/lightning-c-bindings/include/rust_types.h"
  27 OUT_CPP="$(pwd)/lightning-c-bindings/include/lightningpp.hpp"
  28 RUST_BACKTRACE=1 ./c-bindings-gen/target/debug/c-bindings-gen $SRC/ $OUT/ lightning $OUT_TEMPL $OUT_F $OUT_CPP
  29
  30 # Now cd to lightning-c-bindings, build the generated bindings, and call cbindgen to build a C header file
  31 PATH="$PATH:~/.cargo/bin"
  32 cd lightning-c-bindings
  33 cargo build
  34 cbindgen -v --config cbindgen.toml -o include/lightning.h >/dev/null 2>&1
  35
  36 HOST_PLATFORM="$(rustc --version --verbose | grep "host:")"
  37
  38 # cbindgen is relatively braindead when exporting typedefs -
  39 # it happily exports all our typedefs for private types, even with the
  40 # generics we specified in C mode! So we drop all those types manually here.
  41 if [ "$HOST_PLATFORM" = "host: x86_64-apple-darwin" ]; then
  42         # OSX sed is for some reason not compatible with GNU sed
  43         sed -i '' 's/typedef LDKnative.*Import.*LDKnative.*;//g' include/lightning.h
  44 else
  45         sed -i 's/typedef LDKnative.*Import.*LDKnative.*;//g' include/lightning.h
  46 fi
  47
  48 # Finally, sanity-check the generated C and C++ bindings with demo apps:
  49
  50 # Naively run the C demo app:
  51 gcc -Wall -g -pthread demo.c target/debug/libldk.a -ldl
  52 ./a.out
  53
  54 # And run the C++ demo app in valgrind to test memory model correctness and lack of leaks.
  55 g++ -std=c++11 -Wall -g -pthread demo.cpp -Ltarget/debug/ -lldk -ldl
  56 if [ -x "`which valgrind`" ]; then
  57         LD_LIBRARY_PATH=target/debug/ valgrind --error-exitcode=4 --memcheck:leak-check=full --show-leak-kinds=all ./a.out
  58         echo
  59 else
  60         echo "WARNING: Please install valgrind for more testing"
  61 fi
  62
  63 # Test a statically-linked C++ version, tracking the resulting binary size and runtime
  64 # across debug, LTO, and cross-language LTO builds (using the same compiler each time).
  65 clang++ -std=c++11 -Wall -pthread demo.cpp target/debug/libldk.a -ldl
  66 strip ./a.out
  67 echo " C++ Bin size and runtime w/o optimization:"
  68 ls -lha a.out
  69 time ./a.out > /dev/null
  70
  71 # Then, check with memory sanitizer, if we're on Linux and have rustc nightly
  72 if [ "$HOST_PLATFORM" = "host: x86_64-unknown-linux-gnu" ]; then
  73         if cargo +nightly --version >/dev/null 2>&1; then
  74                 LLVM_V=$(rustc +nightly --version --verbose | grep "LLVM version" | awk '{ print substr($3, 0, 2); }')
  75                 if [ -x "$(which clang-$LLVM_V)" ]; then
  76                         cargo +nightly clean
  77                         cargo +nightly rustc -Zbuild-std --target x86_64-unknown-linux-gnu -v -- -Zsanitizer=memory -Zsanitizer-memory-track-origins -Cforce-frame-pointers=yes
  78                         mv target/x86_64-unknown-linux-gnu/debug/libldk.* target/debug/
  79
  80                         # Sadly, std doesn't seem to compile into something that is memsan-safe as of Aug 2020,
  81                         # so we'll always fail, not to mention we may be linking against git rustc LLVM which
  82                         # may differ from clang-llvm, so just allow everything here to fail.
  83                         set +e
  84
  85                         # First the C demo app...
  86                         clang-$LLVM_V -std=c++11 -fsanitize=memory -fsanitize-memory-track-origins -Wall -g -pthread demo.c target/debug/libldk.a -ldl
  87                         ./a.out
  88
  89                         # ...then the C++ demo app
  90                         clang++-$LLVM_V -std=c++11 -fsanitize=memory -fsanitize-memory-track-origins -Wall -g -pthread demo.cpp target/debug/libldk.a -ldl
  91                         ./a.out >/dev/null
  92
  93                         # restore exit-on-failure
  94                         set -e
  95                 else
  96                         echo "WARNING: Can't use memory sanitizer without clang-$LLVM_V"
  97                 fi
  98         else
  99                 echo "WARNING: Can't use memory sanitizer without rustc nightly"
 100         fi
 101 else
 102         echo "WARNING: Can't use memory sanitizer on non-Linux, non-x86 platforms"
 103 fi
 104
 105 RUSTC_LLVM_V=$(rustc --version --verbose | grep "LLVM version" | awk '{ print substr($3, 0, 2); }' | tr -d '.')
 106
 107 if [ "$HOST_PLATFORM" = "host: x86_64-apple-darwin" ]; then
 108         # Apple is special, as always, and decided that they must ensure that there is no way to identify
 109         # the LLVM version used. Why? Just to make your life hard.
 110         # This list is taken from https://en.wikipedia.org/wiki/Xcode
 111         APPLE_CLANG_V=$(clang --version | head -n1 | awk '{ print $4 }')
 112         if [ "$APPLE_CLANG_V" = "10.0.0" ]; then
 113                 CLANG_LLVM_V="6"
 114         elif [ "$APPLE_CLANG_V" = "10.0.1" ]; then
 115                 CLANG_LLVM_V="7"
 116         elif [ "$APPLE_CLANG_V" = "11.0.0" ]; then
 117                 CLANG_LLVM_V="8"
 118         elif [ "$APPLE_CLANG_V" = "11.0.3" ]; then
 119                 CLANG_LLVM_V="9"
 120         elif [ "$APPLE_CLANG_V" = "12.0.0" ]; then
 121                 CLANG_LLVM_V="10"
 122         else
 123                 echo "WARNING: Unable to identify Apple clang LLVM version"
 124                 CLANG_LLVM_V="0"
 125         fi
 126 else
 127         CLANG_LLVM_V=$(clang --version | head -n1 | awk '{ print substr($4, 0, 2); }' | tr -d '.')
 128 fi
 129
 130 if [ "$CLANG_LLVM_V" = "$RUSTC_LLVM_V" ]; then
 131         CLANG=clang
 132         CLANGPP=clang++
 133 elif [ "$(which clang-$RUSTC_LLVM_V)" != "" ]; then
 134         CLANG="$(which clang-$RUSTC_LLVM_V)"
 135         CLANGPP="$(which clang++-$RUSTC_LLVM_V)"
 136 fi
 137
 138 if [ "$CLANG" != "" -a "$CLANGPP" = "" ]; then
 139         echo "WARNING: It appears you have a clang-$RUSTC_LLVM_V but not clang++-$RUSTC_LLVM_V. This is common, but leaves us unable to compile C++ with LLVM $RUSTC_LLVM_V"
 140         echo "You should create a symlink called clang++-$RUSTC_LLVM_V pointing to $CLANG in $(dirname $CLANG)"
 141 fi
 142
 143 # Finally, if we're on OSX or on Linux, build the final debug binary with address sanitizer (and leave it there)
 144 if [ "$HOST_PLATFORM" = "host: x86_64-unknown-linux-gnu" -o "$HOST_PLATFORM" = "host: x86_64-apple-darwin" ]; then
 145         if [ "$CLANGPP" != "" ]; then
 146                 if [ "$HOST_PLATFORM" = "host: x86_64-apple-darwin" ]; then
 147                         # OSX sed is for some reason not compatible with GNU sed
 148                         sed -i .bk 's/,"cdylib"]/]/g' Cargo.toml
 149                 else
 150                         sed -i.bk 's/,"cdylib"]/]/g' Cargo.toml
 151                 fi
 152                 RUSTC_BOOTSTRAP=1 cargo rustc -v -- -Zsanitizer=address -Cforce-frame-pointers=yes || ( mv Cargo.toml.bk Cargo.toml; exit 1)
 153                 mv Cargo.toml.bk Cargo.toml
 154
 155                 # First the C demo app...
 156                 $CLANG -fsanitize=address -Wall -g -pthread demo.c target/debug/libldk.a -ldl
 157                 ASAN_OPTIONS='detect_leaks=1 detect_invalid_pointer_pairs=1 detect_stack_use_after_return=1' ./a.out
 158
 159                 # ...then the C++ demo app
 160                 $CLANGPP -std=c++11 -fsanitize=address -Wall -g -pthread demo.cpp target/debug/libldk.a -ldl
 161                 ASAN_OPTIONS='detect_leaks=1 detect_invalid_pointer_pairs=1 detect_stack_use_after_return=1' ./a.out >/dev/null
 162         else
 163                 echo "WARNING: Please install clang-$RUSTC_LLVM_V and clang++-$RUSTC_LLVM_V to build with address sanitizer"
 164         fi
 165 else
 166         echo "WARNING: Can't use address sanitizer on non-Linux, non-OSX non-x86 platforms"
 167 fi
 168
 169 # Now build with LTO on on both C++ and rust, but without cross-language LTO:
 170 CARGO_PROFILE_RELEASE_LTO=true cargo rustc -v --release -- -C lto
 171 clang++ -std=c++11 -Wall -flto -O2 -pthread demo.cpp target/release/libldk.a -ldl
 172 strip ./a.out
 173 echo "C++ Bin size and runtime with only RL (LTO) optimized:"
 174 ls -lha a.out
 175 time ./a.out > /dev/null
 176
 177 if [ "$HOST_PLATFORM" != "host: x86_64-apple-darwin" -a "$CLANGPP" != "" ]; then
 178         # Finally, test cross-language LTO. Note that this will fail if rustc and clang++
 179         # build against different versions of LLVM (eg when rustc is installed via rustup
 180         # or Ubuntu packages). This should work fine on Distros which do more involved
 181         # packaging than simply shipping the rustup binaries (eg Debian should Just Work
 182         # here).
 183         CARGO_PROFILE_RELEASE_LTO=true cargo rustc -v --release -- -C linker-plugin-lto -C lto -C link-arg=-fuse-ld=lld
 184         $CLANGPP -Wall -std=c++11 -flto -fuse-ld=lld -O2 -pthread demo.cpp target/release/libldk.a -ldl
 185         strip ./a.out
 186         echo "C++ Bin size and runtime with cross-language LTO:"
 187         ls -lha a.out
 188         time ./a.out > /dev/null
 189 else
 190         echo "WARNING: Building with cross-language LTO is not avilable on OSX or without clang-$RUSTC_LLVM_V"
 191 fi