_ Git - ldk-c-bindings/blob - genbindings.sh

   1 #!/usr/bin/env bash
   2
   3 set -e
   4 set -x
   5
   6 if [ ! -d "$1/lightning" -o "$2" != "true" -a "$2" != "false" ]; then
   7         echo "USAGE: $0 path-to-rust-lightning allow-std"
   8         echo "allow-std must be either 'true' or 'false' to indicate if we should be built relying on time and pthread support"
   9         exit 1
  10 fi
  11
  12 export LC_ALL=C
  13
  14 # On reasonable systems, we can use realpath here, but OSX is a diva with 20-year-old software.
  15 ORIG_PWD="$(pwd)"
  16 cd "$1"
  17 LIGHTNING_PATH="$(pwd)"
  18 LIGHTNING_GIT="$(git describe --tag --dirty --abbrev=16)"
  19 cd "$ORIG_PWD"
  20
  21 # Generate (and reasonably test) C bindings
  22
  23 # First we set various compiler flags...
  24 HOST_PLATFORM="$(rustc --version --verbose | grep "host:")"
  25
  26 # Set path to include our rustc wrapper as well as cbindgen
  27 export LDK_RUSTC_PATH="$(which rustc)"
  28 export RUSTC="$(pwd)/deterministic-build-wrappers/rustc"
  29 PATH="$PATH:~/.cargo/bin"
  30
  31 # Set up CFLAGS and RUSTFLAGS vars appropriately for building libsecp256k1 and demo apps...
  32 BASE_CFLAGS="" # CFLAGS for libsecp256k1
  33 LOCAL_CFLAGS="" # CFLAGS for demo apps
  34
  35 # Remap paths so that our builds are deterministic
  36 BASE_RUSTFLAGS="--cfg=c_bindings --remap-path-prefix $LIGHTNING_PATH=rust-lightning --remap-path-prefix $(pwd)=ldk-c-bindings --remap-path-prefix $HOME/.cargo="
  37
  38 # If the C compiler supports it, also set -ffile-prefix-map
  39 echo "int main() {}" > genbindings_path_map_test_file.c
  40 clang -o /dev/null -ffile-prefix-map=$HOME/.cargo= genbindings_path_map_test_file.c > /dev/null 2>&1 &&
  41 export BASE_CFLAGS="-ffile-prefix-map=$HOME/.cargo="
  42
  43 BASE_CFLAGS="$BASE_CFLAGS -frandom-seed=42"
  44 LOCAL_CFLAGS="-Wall -Wno-nullability-completeness -pthread -Iinclude/"
  45
  46 HOST_OSX=false
  47 if [ "$HOST_PLATFORM" = "host: x86_64-apple-darwin" ]; then
  48         HOST_OSX=true
  49 elif [ "$HOST_PLATFORM" = "host: aarch64-apple-darwin" ]; then
  50         HOST_OSX=true
  51 fi
  52
  53 BASE_HOST_CFLAGS="$BASE_CFLAGS"
  54
  55 if [ "$HOST_OSX" = "true" ]; then
  56         export MACOSX_DEPLOYMENT_TARGET=10.9
  57         LOCAL_CFLAGS="$LOCAL_CFLAGS -isysroot$(xcrun --show-sdk-path) -mmacosx-version-min=10.9"
  58         BASE_HOST_CFLAGS="$BASE_HOST_CFLAGS -isysroot$(xcrun --show-sdk-path) -mmacosx-version-min=10.9"
  59         # Targeting aarch64 appears to be supported only starting with Big Sur, so check it before use
  60         clang -o /dev/null $BASE_HOST_CFLAGS --target=aarch64-apple-darwin -mcpu=apple-a14 genbindings_path_map_test_file.c &&
  61         export CFLAGS_aarch64_apple_darwin="$BASE_HOST_CFLAGS --target=aarch64-apple-darwin -mcpu=apple-a14" ||
  62         echo "WARNING: Can not build targeting aarch64-apple-darin. Upgrade to Big Sur or try upstream clang"
  63 fi
  64
  65 rm genbindings_path_map_test_file.c
  66
  67 ENV_TARGET=$(rustc --version --verbose | grep host | awk '{ print $2 }' | sed 's/-/_/g')
  68 case "$ENV_TARGET" in
  69         "x86_64"*)
  70                 export RUSTFLAGS="$BASE_RUSTFLAGS -C target-cpu=sandybridge"
  71                 export CFLAGS_$ENV_TARGET="$BASE_HOST_CFLAGS -march=sandybridge -mcpu=sandybridge -mtune=sandybridge"
  72                 ;;
  73         "aarch64_apple_darwin")
  74                 export RUSTFLAGS="$BASE_RUSTFLAGS -C target-cpu=apple-a14"
  75                 export CFLAGS_$ENV_TARGET="$BASE_HOST_CFLAGS -mcpu=apple-a14"
  76                 ;;
  77         *)
  78                 # Assume this isn't targeted at another host and build for the host's CPU.
  79                 export RUSTFLAGS="$BASE_RUSTFLAGS -C target-cpu=native"
  80                 export CFLAGS_$ENV_TARGET="$BASE_HOST_CFLAGS -mcpu=native"
  81                 ;;
  82 esac
  83
  84 # First build the latest c-bindings-gen binary
  85 cd c-bindings-gen && cargo build --release && cd ..
  86
  87 # Then wipe all the existing C bindings (because we're being run in the right directory)
  88 # note that we keep the few manually-generated files first:
  89 mv lightning-c-bindings/src/c_types/mod.rs ./
  90 mv lightning-c-bindings/src/bitcoin ./
  91
  92 # Before we try to sed the Cargo.toml, generate version define tags
  93 # (ignoring any files that we're about to generate)
  94
  95 git checkout lightning-c-bindings/src
  96 git checkout lightning-c-bindings/include
  97 BINDINGS_GIT="$(git describe --tag --dirty --abbrev=16)"
  98 echo "$(cat <<EOF
  99 #ifndef _LDK_HEADER_VER
 100 static inline int _ldk_strncmp(const char *s1, const char *s2, uint64_t n) {
 101         if (n && *s1 != *s2) return 1;
 102         while (n && *s1 != 0 && *s2 != 0) {
 103                 s1++; s2++; n--;
 104                 if (n && *s1 != *s2) return 1;
 105         }
 106         return 0;
 107 }
 108
 109 #define _LDK_HEADER_VER "${LIGHTNING_GIT}"
 110 #define _LDK_C_BINDINGS_HEADER_VER "${BINDINGS_GIT}"
 111 static inline const char* check_get_ldk_version() {
 112         LDKStr bin_ver = _ldk_get_compiled_version();
 113         if (_ldk_strncmp(_LDK_HEADER_VER, (const char*)bin_ver.chars, bin_ver.len) != 0) {
 114         // Version mismatch, we don't know what we're running!
 115                 return 0;
 116         }
 117         return _LDK_HEADER_VER;
 118 }
 119 static inline const char* check_get_ldk_bindings_version() {
 120         LDKStr bin_ver = _ldk_c_bindings_get_compiled_version();
 121         if (_ldk_strncmp(_LDK_C_BINDINGS_HEADER_VER, (const char*)bin_ver.chars, bin_ver.len) != 0) {
 122         // Version mismatch, we don't know what we're running!
 123                 return 0;
 124         }
 125         return _LDK_C_BINDINGS_HEADER_VER;
 126 }
 127 #endif /* _LDK_HEADER_VER */
 128 EOF
 129 )" > lightning-c-bindings/include/ldk_ver.h
 130
 131 rm -rf lightning-c-bindings/src
 132
 133 mkdir -p lightning-c-bindings/src/{c_types,lightning}
 134 mv ./mod.rs lightning-c-bindings/src/c_types/
 135 mv ./bitcoin lightning-c-bindings/src/
 136
 137 # Finally, run the c-bindings-gen binary, building fresh bindings.
 138 OUT="$(pwd)/lightning-c-bindings/src"
 139 OUT_TEMPL="$(pwd)/lightning-c-bindings/src/c_types/derived.rs"
 140 OUT_F="$(pwd)/lightning-c-bindings/include/ldk_rust_types.h"
 141 OUT_CPP="$(pwd)/lightning-c-bindings/include/lightningpp.hpp"
 142 BIN="$(pwd)/c-bindings-gen/target/release/c-bindings-gen"
 143
 144 function add_crate() {
 145         pushd "$LIGHTNING_PATH/$1"
 146         RUSTC_BOOTSTRAP=1 cargo rustc --profile=check --no-default-features $3 -- --cfg=c_bindings -Zunpretty=expanded > /tmp/$1-crate-source.txt
 147         popd
 148         if [ "$HOST_OSX" = "true" ]; then
 149                 sed -i".original" "1i\\
 150 pub mod $2 {
 151 " /tmp/$1-crate-source.txt
 152         else
 153                 sed -i "1ipub mod $2 {\n" /tmp/$1-crate-source.txt
 154         fi
 155         echo "}" >> /tmp/$1-crate-source.txt
 156         cat /tmp/$1-crate-source.txt >> /tmp/crate-source.txt
 157         rm /tmp/$1-crate-source.txt
 158         if [ "$HOST_OSX" = "true" ]; then
 159                 # OSX sed is for some reason not compatible with GNU sed
 160                 sed -E -i '' 's|#*'$1' = \{ .*|'$1' = \{ path = "'"$LIGHTNING_PATH"'/'$1'", default-features = false }|' lightning-c-bindings/Cargo.toml
 161         else
 162                 sed -E -i 's|#*'$1' = \{ .*|'$1' = \{ path = "'"$LIGHTNING_PATH"'/'$1'", default-features = false }|' lightning-c-bindings/Cargo.toml
 163         fi
 164 }
 165
 166 function drop_crate() {
 167         if [ "$HOST_OSX" = "true" ]; then
 168                 # OSX sed is for some reason not compatible with GNU sed
 169                 sed -E -i '' 's|'$1' = \{ (.*)|#'$1' = \{ \1|' lightning-c-bindings/Cargo.toml
 170         else
 171                 sed -E -i 's|'$1' = \{ (.*)|#'$1' = \{ \1|' lightning-c-bindings/Cargo.toml
 172         fi
 173 }
 174
 175 echo > /tmp/crate-source.txt
 176 if [ "$2" = "true" ]; then
 177         add_crate lightning lightning --features=std
 178         add_crate "lightning-persister" "lightning_persister"
 179         add_crate "lightning-background-processor" "lightning_background_processor"
 180         add_crate "lightning-invoice" "lightning_invoice" --features=std
 181         CARGO_BUILD_ARGS="--features=std"
 182 else
 183         add_crate lightning lightning --features=no-std
 184         drop_crate "lightning-persister"
 185         drop_crate "lightning-background-processor"
 186         add_crate "lightning-invoice" "lightning_invoice" --features=no-std
 187         CARGO_BUILD_ARGS="--features=no-std"
 188 fi
 189
 190 cat /tmp/crate-source.txt | RUST_BACKTRACE=1 "$BIN" "$OUT/" "$OUT_TEMPL" "$OUT_F" "$OUT_CPP"
 191
 192 echo "$(cat <<EOF
 193 #[no_mangle]
 194 pub extern "C" fn _ldk_get_compiled_version() -> crate::c_types::Str {
 195         "${LIGHTNING_GIT}".into()
 196 }
 197 #[no_mangle]
 198 pub extern "C" fn _ldk_c_bindings_get_compiled_version() -> crate::c_types::Str {
 199         "${BINDINGS_GIT}".into()
 200 }
 201 EOF
 202 )" >> lightning-c-bindings/src/version.rs
 203
 204 # Now cd to lightning-c-bindings, build the generated bindings, and call cbindgen to build a C header file
 205 cd lightning-c-bindings
 206
 207 RUSTFLAGS="$RUSTFLAGS --cfg=test_mod_pointers" cargo build $CARGO_BUILD_ARGS
 208 if [ "$CFLAGS_aarch64_apple_darwin" != "" ]; then
 209         RUSTFLAGS="$BASE_RUSTFLAGS -C target-cpu=apple-a14" cargo build $CARGO_BUILD_ARGS --target aarch64-apple-darwin
 210 fi
 211 cbindgen -v --config cbindgen.toml -o include/lightning.h >/dev/null 2>&1
 212
 213 # cbindgen is relatively braindead when exporting typedefs -
 214 # it happily exports all our typedefs for private types, even with the
 215 # generics we specified in C mode! So we drop all those types manually here.
 216 if [ "$HOST_OSX" = "true" ]; then
 217         # OSX sed is for some reason not compatible with GNU sed
 218         sed -i '' 's/typedef LDKnative.*Import.*LDKnative.*;//g' include/lightning.h
 219
 220         # stdlib.h doesn't exist in clang's wasm sysroot, and cbindgen
 221         # doesn't actually use it anyway, so drop the import.
 222         sed -i '' 's/#include <stdlib.h>/#include "ldk_rust_types.h"/g' include/lightning.h
 223 else
 224         sed -i 's/typedef LDKnative.*Import.*LDKnative.*;//g' include/lightning.h
 225
 226         # stdlib.h doesn't exist in clang's wasm sysroot, and cbindgen
 227         # doesn't actually use it anyway, so drop the import.
 228         sed -i 's/#include <stdlib.h>/#include "ldk_rust_types.h"/g' include/lightning.h
 229 fi
 230
 231 # Build C++ class methods which call trait methods
 232 set +x # Echoing every command is very verbose here
 233 OLD_IFS="$IFS"
 234 export IFS=''
 235 echo '#include <string.h>' > include/lightningpp_new.hpp
 236 echo 'namespace LDK {' >> include/lightningpp_new.hpp
 237 echo '// Forward declarations' >> include/lightningpp_new.hpp
 238 cat include/lightningpp.hpp | sed -n 's/class \(.*\) {/class \1;/p' >> include/lightningpp_new.hpp
 239 echo '' >> include/lightningpp_new.hpp
 240
 241 DECLS=""
 242 while read LINE; do
 243         case "$LINE" in
 244                 "#include <string.h>")
 245                         # We already printed this above.
 246                         ;;
 247                 "namespace LDK {")
 248                         # We already printed this above.
 249                         ;;
 250                 "}")
 251                         # We'll print this at the end
 252                         ;;
 253                 "XXX"*)
 254                         NEW_STRUCT_NAME="$(echo "$LINE" | awk '{ print $2 }')"
 255                         if [ "$NEW_STRUCT_NAME" != "$STRUCT_NAME" ]; then
 256                                 STRUCT_CONTENTS="$(cat include/lightning.h  | sed -n -e "/struct LDK$NEW_STRUCT_NAME/{:s" -e "/\} LDK$NEW_STRUCT_NAME;/!{N" -e "b s" -e "}" -e p -e "}")"
 257                         fi
 258                         STRUCT_NAME="$NEW_STRUCT_NAME"
 259                         METHOD_NAME="$(echo "$LINE" | awk '{ print $3 }')"
 260                         METHOD="$(echo "$STRUCT_CONTENTS" | grep "(\*$METHOD_NAME)")"
 261                         if [ "$METHOD" = "" ]; then
 262                                 echo "Unable to find method declaration for $LINE"
 263                                 exit 1
 264                         fi
 265                         RETVAL="$(echo "$METHOD" | sed 's/[ ]*\([A-Za-z0-9 _]*\)(\*\(.*\)).*/\1/' | sed 's/^struct LDK/LDK::/g' | tr -d ' ')"
 266                         [ "$RETVAL" = "LDK::SecretKey" ] && RETVAL="LDKSecretKey"
 267                         [ "$RETVAL" = "LDK::PublicKey" ] && RETVAL="LDKPublicKey"
 268                         [ "$RETVAL" = "LDK::ThirtyTwoBytes" ] && RETVAL="LDKThirtyTwoBytes"
 269                         PARAMS="$(echo "$METHOD" | sed 's/.*(\*.*)(\(const \)*void \*this_arg\(, \)*\(.*\));/\3/')"
 270
 271                         echo -e "\tinline $RETVAL $METHOD_NAME($PARAMS);" >> include/lightningpp_new.hpp
 272                         DECLS="$DECLS"$'\n'"inline $RETVAL $STRUCT_NAME::$METHOD_NAME($PARAMS) {"
 273
 274                         DECLS="$DECLS"$'\n'$'\t'
 275                         [ "$RETVAL" != "void" ] && DECLS="$DECLS$RETVAL ret = "
 276                         DECLS="$DECLS(self.$METHOD_NAME)(self.this_arg"
 277
 278                         IFS=','; for PARAM in $PARAMS; do
 279                                 DECLS="$DECLS, "
 280                                 DECLS="$DECLS$(echo $PARAM | sed 's/.* (*\**\([a-zA-Z0-9_]*\)\()[\[0-9\]*]\)*/\1/')"
 281                         done
 282                         IFS=''
 283
 284                         DECLS="$DECLS);"
 285                         [ "$RETVAL" != "void" ] && DECLS="$DECLS"$'\n'$'\t'"return ret;"
 286                         DECLS="$DECLS"$'\n'"}"
 287                         ;;
 288                 *)
 289                         echo "$LINE" >> include/lightningpp_new.hpp
 290         esac
 291 done < include/lightningpp.hpp
 292 echo "$DECLS" >> include/lightningpp_new.hpp
 293 echo "}" >> include/lightningpp_new.hpp
 294 export IFS="$OLD_IFS"
 295 set -x
 296 mv include/lightningpp_new.hpp include/lightningpp.hpp
 297
 298 # Finally, sanity-check the generated C and C++ bindings with demo apps:
 299 # Naively run the C demo app:
 300 gcc $LOCAL_CFLAGS -Wall -g -pthread demo.c target/debug/libldk.a -ldl -lm
 301 ./a.out
 302
 303 # And run the C++ demo app
 304 if [ "$2" = "true" ]; then
 305         g++ $LOCAL_CFLAGS -std=c++11 -Wall -g -pthread demo.cpp -Ltarget/debug/ -lldk -ldl
 306         LD_LIBRARY_PATH=target/debug/ ./a.out > /dev/null
 307 fi
 308
 309 # Finally, run the C++ demo app with our native networking library
 310 # in valgrind to test memory model correctness and lack of leaks.
 311 gcc $LOCAL_CFLAGS -fPIC -std=c99 -Wall -g -pthread -I../ldk-net ../ldk-net/ldk_net.c -c -o ldk_net.o
 312 if [ "$2" = "true" ]; then
 313         g++ $LOCAL_CFLAGS -std=c++11 -Wall -g -pthread -DREAL_NET -I../ldk-net ldk_net.o demo.cpp target/debug/libldk.a -ldl -lm
 314         if [ -x "`which valgrind`" -a "$(uname -m)" != "ppc64le" ]; then
 315                 valgrind --error-exitcode=4 --memcheck:leak-check=full --show-leak-kinds=all ./a.out
 316                 echo
 317         else
 318                 echo "WARNING: Please install valgrind for more testing"
 319                 ./a.out
 320         fi
 321 fi
 322
 323
 324 # Test a statically-linked C++ version, tracking the resulting binary size and runtime
 325 # across debug, LTO, and cross-language LTO builds (using the same compiler each time).
 326 if [ "$2" = "true" ]; then
 327         clang++ $LOCAL_CFLAGS -std=c++11 demo.cpp target/debug/libldk.a -ldl
 328         strip ./a.out
 329         echo " C++ Bin size and runtime w/o optimization:"
 330         ls -lha a.out
 331         time ./a.out > /dev/null
 332 fi
 333
 334 # Then, check with memory sanitizer, if we're on Linux and have rustc nightly
 335 if [ "$HOST_PLATFORM" = "host: x86_64-unknown-linux-gnu" ]; then
 336         if cargo +nightly --version >/dev/null 2>&1; then
 337                 LLVM_V=$(rustc +nightly --version --verbose | grep "LLVM version" | awk '{ print substr($3, 0, 2); }')
 338                 if [ -x "$(which clang-$LLVM_V)" ]; then
 339                         cargo +nightly clean
 340                         cargo +nightly rustc $CARGO_BUILD_ARGS -Zbuild-std=std,panic_abort --target x86_64-unknown-linux-gnu -v -- -Zsanitizer=memory -Zsanitizer-memory-track-origins -Cforce-frame-pointers=yes
 341                         mv target/x86_64-unknown-linux-gnu/debug/libldk.* target/debug/
 342
 343                         # Sadly, std doesn't seem to compile into something that is memsan-safe as of Aug 2020,
 344                         # so we'll always fail, not to mention we may be linking against git rustc LLVM which
 345                         # may differ from clang-llvm, so just allow everything here to fail.
 346                         set +e
 347
 348                         # First the C demo app...
 349                         clang-$LLVM_V $LOCAL_CFLAGS -fsanitize=memory -fsanitize-memory-track-origins -g demo.c target/debug/libldk.a -ldl
 350                         ./a.out
 351
 352                         if [ "$2" = "true" ]; then
 353                                 # ...then the C++ demo app
 354                                 clang++-$LLVM_V $LOCAL_CFLAGS -std=c++11 -fsanitize=memory -fsanitize-memory-track-origins -g demo.cpp target/debug/libldk.a -ldl
 355                                 ./a.out >/dev/null
 356
 357                                 # ...then the C++ demo app with the ldk_net network implementation
 358                                 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
 359                                 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
 360                                 ./a.out >/dev/null
 361                         fi
 362
 363                         # restore exit-on-failure
 364                         set -e
 365                 else
 366                         echo "WARNING: Can't use memory sanitizer without clang-$LLVM_V"
 367                 fi
 368         else
 369                 echo "WARNING: Can't use memory sanitizer without rustc nightly"
 370         fi
 371 else
 372         echo "WARNING: Can't use memory sanitizer on non-Linux, non-x86 platforms"
 373 fi
 374
 375 RUSTC_LLVM_V=$(rustc --version --verbose | grep "LLVM version" | awk '{ print substr($3, 0, 2); }')
 376
 377 if [ "$HOST_OSX" = "true" ]; then
 378         # Apple is special, as always, and their versions of clang aren't
 379         # compatible with upstream LLVM.
 380         if [ "$(clang --version | grep 'Apple clang')" != "" ]; then
 381                 echo "Apple clang isn't compatible with upstream clang, install upstream clang"
 382                 CLANG_LLVM_V="0"
 383         else
 384                 CLANG_LLVM_V=$(clang --version | head -n1 | awk '{ print substr($3, 0, 2); }')
 385                 if [ -x "$(which ld64.lld)" ]; then
 386                         LLD_LLVM_V="$(ld64.lld --version | awk '{ print substr($2, 0, 2); }')"
 387                 fi
 388         fi
 389 else
 390         CLANG_LLVM_V=$(clang --version | head -n1 | awk '{ print substr($4, 0, 2); }')
 391         if [ -x "$(which ld.lld)" ]; then
 392                 LLD_LLVM_V="$(ld.lld --version | awk '{ print $2; }')"
 393                 if [ "$LLD_LLVM_V" = "LLD" ]; then # eg if the output is "Debian LLD ..."
 394                         LLD_LLVM_V="$(ld.lld --version | awk '{ print substr($3, 0, 2); }')"
 395                 else
 396                         LLD_LLVM_V="$(ld.lld --version | awk '{ print substr($2, 0, 2); }')"
 397                 fi
 398         fi
 399 fi
 400
 401
 402 if [ "$CLANG_LLVM_V" = "$RUSTC_LLVM_V" ]; then
 403         CLANG=clang
 404         CLANGPP=clang++
 405         if [ "$LLD_LLVM_V" = "$CLANG_LLVM_V" ]; then
 406                 LLD=lld
 407         fi
 408 elif [ -x "$(which clang-$RUSTC_LLVM_V)" ]; then
 409         CLANG="$(which clang-$RUSTC_LLVM_V)"
 410         CLANGPP="$(which clang++-$RUSTC_LLVM_V || echo clang++)"
 411         if [ "$($CLANG --version)" != "$($CLANGPP --version)" ]; then
 412                 echo "$CLANG and $CLANGPP are not the same version of clang!"
 413                 unset CLANG
 414                 unset CLANGPP
 415         fi
 416         if [ "$LLD_LLVM_V" != "$RUSTC_LLVM_V" ]; then
 417                 LLD="lld"
 418                 [ -x "$(which lld-$RUSTC_LLVM_V)" ] && LLD="lld-$RUSTC_LLVM_V"
 419                 LLD_LLVM_V="$(ld.lld-$RUSTC_LLVM_V --version | awk '{ print $2; }')"
 420                 if [ "$LLD_LLVM_V" = "LLD" ]; then # eg if the output is "Debian LLD ..."
 421                         LLD_LLVM_V="$(ld.lld-$RUSTC_LLVM_V --version | awk '{ print substr($3, 0, 2); }')"
 422                 else
 423                         LLD_LLVM_V="$(ld.lld-$RUSTC_LLVM_V --version | awk '{ print substr($2, 0, 2); }')"
 424                 fi
 425                 if [ "$LLD_LLVM_V" != "$RUSTC_LLVM_V" ]; then
 426                         echo "Could not find a workable version of lld, not using cross-language LTO"
 427                         unset LLD
 428                 fi
 429         fi
 430 fi
 431
 432 if [ "$CLANG" != "" -a "$CLANGPP" = "" ]; then
 433         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"
 434         echo "You should create a symlink called clang++-$RUSTC_LLVM_V pointing to $CLANG in $(dirname $CLANG)"
 435 fi
 436
 437 # Finally, if we're on OSX or on Linux, build the final debug binary with address sanitizer (and leave it there)
 438 if [ "$HOST_PLATFORM" = "host: x86_64-unknown-linux-gnu" -o "$HOST_PLATFORM" = "host: x86_64-apple-darwin" ]; then
 439         if [ "$CLANGPP" != "" ]; then
 440                 if [ "$HOST_OSX" = "true" ]; then
 441                         # OSX sed is for some reason not compatible with GNU sed
 442                         sed -i .bk 's/,"cdylib"]/]/g' Cargo.toml
 443                 else
 444                         sed -i.bk 's/,"cdylib"]/]/g' Cargo.toml
 445                 fi
 446                 if [ "$CFLAGS_aarch64_apple_darwin" != "" ]; then
 447                         RUSTFLAGS="$BASE_RUSTFLAGS -C target-cpu=apple-a14" RUSTC_BOOTSTRAP=1 cargo rustc $CARGO_BUILD_ARGS --target aarch64-apple-darwin -v -- -Zsanitizer=address -Cforce-frame-pointers=yes || ( mv Cargo.toml.bk Cargo.toml; exit 1)
 448                 fi
 449                 RUSTFLAGS="$RUSTFLAGS --cfg=test_mod_pointers" RUSTC_BOOTSTRAP=1 cargo rustc $CARGO_BUILD_ARGS -v -- -Zsanitizer=address -Cforce-frame-pointers=yes || ( mv Cargo.toml.bk Cargo.toml; exit 1)
 450                 mv Cargo.toml.bk Cargo.toml
 451
 452                 # First the C demo app...
 453                 $CLANG $LOCAL_CFLAGS -fsanitize=address -g demo.c target/debug/libldk.a -ldl
 454                 ASAN_OPTIONS='detect_leaks=1 detect_invalid_pointer_pairs=1 detect_stack_use_after_return=1' ./a.out
 455
 456                 if [ "$2" = "true" ]; then
 457                         # ...then the C++ demo app
 458                         $CLANGPP $LOCAL_CFLAGS -std=c++11 -fsanitize=address -g demo.cpp target/debug/libldk.a -ldl
 459                         ASAN_OPTIONS='detect_leaks=1 detect_invalid_pointer_pairs=1 detect_stack_use_after_return=1' ./a.out >/dev/null
 460
 461                         # ...then the C++ demo app with the ldk_net network implementation
 462                         $CLANG $LOCAL_CFLAGS -fPIC -fsanitize=address -g -I../ldk-net ../ldk-net/ldk_net.c -c -o ldk_net.o
 463                         $CLANGPP $LOCAL_CFLAGS -std=c++11 -fsanitize=address -g -DREAL_NET -I../ldk-net ldk_net.o demo.cpp target/debug/libldk.a -ldl
 464                         ASAN_OPTIONS='detect_leaks=1 detect_invalid_pointer_pairs=1 detect_stack_use_after_return=1' ./a.out >/dev/null
 465                 fi
 466         else
 467                 echo "WARNING: Please install clang-$RUSTC_LLVM_V and clang++-$RUSTC_LLVM_V to build with address sanitizer"
 468         fi
 469 else
 470         echo "WARNING: Can't use address sanitizer on non-Linux, non-OSX non-x86 platforms"
 471 fi
 472
 473 # Now build with LTO on on both C++ and rust, but without cross-language LTO:
 474 # Clear stale release build artifacts from previous runs
 475 cargo clean --release
 476 CARGO_PROFILE_RELEASE_LTO=true RUSTFLAGS="$RUSTFLAGS -C embed-bitcode=yes -C lto" cargo build $CARGO_BUILD_ARGS -v --release
 477 if [ "$2" = "true" ]; then
 478         clang++ $LOCAL_CFLAGS -std=c++11 -O2 demo.cpp target/release/libldk.a -ldl
 479 fi
 480
 481 strip ./a.out
 482 echo "C++ Bin size and runtime with only RL (LTO) optimized:"
 483 ls -lha a.out
 484 time ./a.out > /dev/null
 485
 486 if [ "$CLANGPP" != "" ]; then
 487         # If we can use cross-language LTO, use it for building C dependencies (i.e. libsecp256k1) as well
 488         export CC="$CLANG"
 489         # The cc-rs crate tries to force -fdata-sections and -ffunction-sections on, which
 490         # breaks -fembed-bitcode, so we turn off cc-rs' default flags and specify exactly
 491         # what we want here.
 492         export CFLAGS_$ENV_TARGET="$BASE_HOST_CFLAGS -fPIC -fembed-bitcode -march=sandybridge -mcpu=sandybridge -mtune=sandybridge"
 493         export CRATE_CC_NO_DEFAULTS=true
 494 fi
 495
 496 if [ "$2" = "false" -a "$(rustc --print target-list | grep wasm32-wasi)" != "" ]; then
 497         # Test to see if clang supports wasm32 as a target (which is needed to build rust-secp256k1)
 498         echo "int main() {}" > genbindings_wasm_test_file.c
 499         if clang -nostdlib -o /dev/null --target=wasm32-wasi -Wl,--no-entry genbindings_wasm_test_file.c > /dev/null 2>&1; then
 500                 # And if it does, build a WASM binary without capturing errors
 501                 export CFLAGS_wasm32_wasi="$BASE_CFLAGS -target wasm32 -O1"
 502                 RUSTFLAGS="$BASE_RUSTFLAGS -C opt-level=1 --cfg=test_mod_pointers" cargo build $CARGO_BUILD_ARGS -v --target=wasm32-wasi
 503                 export CFLAGS_wasm32_wasi="$BASE_CFLAGS -fembed-bitcode -target wasm32 -Oz"
 504                 RUSTFLAGS="$BASE_RUSTFLAGS -C embed-bitcode=yes -C opt-level=z -C linker-plugin-lto -C lto" CARGO_PROFILE_RELEASE_LTO=true cargo build $CARGO_BUILD_ARGS -v --release --target=wasm32-wasi
 505         else
 506                 echo "Cannot build WASM lib as clang does not seem to support the wasm32-wasi target"
 507         fi
 508         rm genbindings_wasm_test_file.c
 509 fi
 510
 511 EXTRA_TARGETS=( $LDK_C_BINDINGS_EXTRA_TARGETS )
 512 EXTRA_CCS=( $LDK_C_BINDINGS_EXTRA_TARGET_CCS )
 513
 514 if [ ${#EXTRA_TARGETS[@]} != ${#EXTRA_CCS[@]} ]; then
 515         echo "LDK_C_BINDINGS_EXTRA_TARGETS and LDK_C_BINDINGS_EXTRA_TARGET_CCS didn't have the same number of elements!"
 516         exit 1
 517 fi
 518
 519 for IDX in ${!EXTRA_TARGETS[@]}; do
 520         EXTRA_ENV_TARGET=$(echo "${EXTRA_TARGETS[$IDX]}" | sed 's/-/_/g')
 521         export CFLAGS_$EXTRA_ENV_TARGET="$BASE_CFLAGS"
 522         export CC_$EXTRA_ENV_TARGET=${EXTRA_CCS[$IDX]}
 523         RUSTFLAGS="$BASE_RUSTFLAGS -C embed-bitcode=yes -C lto -C linker=${EXTRA_CCS[$IDX]}" CARGO_PROFILE_RELEASE_LTO=true cargo build $CARGO_BUILD_ARGS -v --release --target "${EXTRA_TARGETS[$IDX]}"
 524 done
 525
 526 if [ "$CLANGPP" != "" -a "$LLD" != "" ]; then
 527         # Finally, test cross-language LTO. Note that this will fail if rustc and clang++
 528         # build against different versions of LLVM (eg when rustc is installed via rustup
 529         # or Ubuntu packages). This should work fine on Distros which do more involved
 530         # packaging than simply shipping the rustup binaries (eg Debian should Just Work
 531         # here).
 532         LINK_ARG_FLAGS="-C link-arg=-fuse-ld=$LLD"
 533         if [ "$HOST_OSX" = "true" ]; then
 534                 export LDK_CLANG_PATH=$(which $CLANG)
 535                 export CLANG="$(pwd)/../deterministic-build-wrappers/clang-lto-link-osx"
 536                 for ARG in "CFLAGS_aarch64_apple_darwin"; do
 537                         MANUAL_LINK_CFLAGS="$MANUAL_LINK_CFLAGS -C link-arg=$ARG"
 538                 done
 539                 export CFLAGS_aarch64_apple_darwin="$CFLAGS_aarch64_apple_darwin -O3 -fPIC -fembed-bitcode"
 540                 LINK_ARG_FLAGS="$LINK_ARG_FLAGS -C link-arg="-isysroot$(xcrun --show-sdk-path)" -C link-arg=-mmacosx-version-min=10.9"
 541                 RUSTFLAGS="$BASE_RUSTFLAGS -C target-cpu=apple-a14 -C embed-bitcode=yes -C linker-plugin-lto -C lto -C linker=$CLANG $LINK_ARG_FLAGS -C link-arg=-mcpu=apple-a14" CARGO_PROFILE_RELEASE_LTO=true cargo build $CARGO_BUILD_ARGS -v --release --target aarch64-apple-darwin
 542         fi
 543         export CFLAGS_$ENV_TARGET="$BASE_HOST_CFLAGS -O3 -fPIC -fembed-bitcode -march=sandybridge -mcpu=sandybridge -mtune=sandybridge"
 544         # Rust doesn't recognize CFLAGS changes, so we need to clean build artifacts
 545         cargo clean --release
 546         CARGO_PROFILE_RELEASE_LTO=true RUSTFLAGS="$RUSTFLAGS -C embed-bitcode=yes -C linker-plugin-lto -C lto -C linker=$CLANG $LINK_ARG_FLAGS -C link-arg=-march=sandybridge -C link-arg=-mcpu=sandybridge -C link-arg=-mtune=sandybridge" cargo build $CARGO_BUILD_ARGS -v --release
 547
 548         if [ "$2" = "true" ]; then
 549                 $CLANGPP $LOCAL_CFLAGS -flto -fuse-ld=$LLD -O2 demo.cpp target/release/libldk.a -ldl
 550                 strip ./a.out
 551                 echo "C++ Bin size and runtime with cross-language LTO:"
 552                 ls -lha a.out
 553                 time ./a.out > /dev/null
 554         fi
 555 else
 556         if [ "$CFLAGS_aarch64_apple_darwin" != "" ]; then
 557                 RUSTFLAGS="$BASE_RUSTFLAGS -C embed-bitcode=yes -C lto -C target-cpu=apple-a14" CARGO_PROFILE_RELEASE_LTO=true cargo build $CARGO_BUILD_ARGS -v --release --target aarch64-apple-darwin
 558         fi
 559         echo "WARNING: Building with cross-language LTO is not avilable without clang-$RUSTC_LLVM_V"
 560 fi