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