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