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"
12 SKIP_TESTS_ARGUMENT=$3
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"
26 # On reasonable systems, we can use realpath here, but OSX is a diva with 20-year-old software.
29 LIGHTNING_PATH="$(pwd)"
30 LIGHTNING_GIT="$(git describe --tag --dirty --abbrev=16)"
33 # Generate (and reasonably test) C bindings
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')
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"
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
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="
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="
56 BASE_CFLAGS="$BASE_CFLAGS -frandom-seed=42"
57 LOCAL_CFLAGS="-Wall -Wno-nullability-completeness -pthread -Iinclude/"
60 if [ "$HOST_PLATFORM" = "x86_64-apple-darwin" ]; then
62 elif [ "$HOST_PLATFORM" = "aarch64-apple-darwin" ]; then
66 BASE_HOST_CFLAGS="$BASE_CFLAGS"
68 if [ "$MACOS_SDK" = "" -a "$HOST_OSX" = "true" ]; then
69 MACOS_SDK="$(xcrun --show-sdk-path)"
70 [ "$MACOS_SDK" = "" ] && exit 1
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"
84 rm genbindings_path_map_test_file.c
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"
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"
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"
105 # First build the latest c-bindings-gen binary
106 cd c-bindings-gen && cargo build --release && cd ..
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 ./
113 # Before we try to sed the Cargo.toml, generate version define tags
114 # (ignoring any files that we're about to generate)
116 git checkout lightning-c-bindings/src
117 git checkout lightning-c-bindings/include
118 BINDINGS_GIT="$(git describe --tag --dirty --abbrev=16)"
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) {
125 if (n && *s1 != *s2) return 1;
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!
138 return _LDK_HEADER_VER;
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!
146 return _LDK_C_BINDINGS_HEADER_VER;
148 #endif /* _LDK_HEADER_VER */
150 )" > lightning-c-bindings/include/ldk_ver.h
152 rm -rf lightning-c-bindings/src
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/
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"
165 function is_gnu_sed(){
166 sed --version >/dev/null 2>&1
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
173 if [ "$HOST_OSX" = "true" ]; then
174 sed -i".original" "1i\\
176 " /tmp/$1-crate-source.txt
178 sed -i "1ipub mod $2 {\n" /tmp/$1-crate-source.txt
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
184 sed -E -i 's|#*'$1' = \{ .*|'$1' = \{ path = "'"$LIGHTNING_PATH"'/'$1'", default-features = false }|' lightning-c-bindings/Cargo.toml
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
191 function drop_crate() {
193 sed -E -i 's|'$1' = \{ (.*)|#'$1' = \{ \1|' lightning-c-bindings/Cargo.toml
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
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"
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"
217 cat /tmp/crate-source.txt | RUST_BACKTRACE=1 "$BIN" "$OUT/" "$OUT_TEMPL" "$OUT_F" "$OUT_CPP"
221 pub extern "C" fn _ldk_get_compiled_version() -> crate::c_types::Str {
222 "${LIGHTNING_GIT}".into()
225 pub extern "C" fn _ldk_c_bindings_get_compiled_version() -> crate::c_types::Str {
226 "${BINDINGS_GIT}".into()
229 )" >> lightning-c-bindings/src/version.rs
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
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
238 cbindgen -v --config cbindgen.toml -o include/lightning.h >/dev/null 2>&1
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.
244 sed -i 's/typedef LDKnative.*Import.*LDKnative.*;//g' include/lightning.h
246 # UnsafeCell is `repr(transparent)` so should be ignored here
247 sed -i 's/LDKUnsafeCell<\(.*\)> /struct \1 /g' include/lightning.h
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
253 # OSX sed is for some reason not compatible with GNU sed
254 sed -i '' 's/typedef LDKnative.*Import.*LDKnative.*;//g' include/lightning.h
256 # UnsafeCell is `repr(transparent)` so should be ignored by cbindgen
257 sed -i '' 's/LDKUnsafeCell<\(.*\)> /struct \1 /g' include/lightning.h
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
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
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
278 "#include <string.h>")
279 # We already printed this above.
282 # We already printed this above.
285 # We'll print this at the end
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 "}")"
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"
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/')"
305 echo -e "\tinline $RETVAL $METHOD_NAME($PARAMS);" >> include/lightningpp_new.hpp
306 DECLS="$DECLS"$'\n'"inline $RETVAL $STRUCT_NAME::$METHOD_NAME($PARAMS) {"
308 DECLS="$DECLS"$'\n'$'\t'
309 [ "$RETVAL" != "void" ] && DECLS="$DECLS$RETVAL ret = "
310 DECLS="$DECLS(self.$METHOD_NAME)(self.this_arg"
312 IFS=','; for PARAM in $PARAMS; do
314 DECLS="$DECLS$(echo $PARAM | sed 's/.* (*\**\([a-zA-Z0-9_]*\)\()[\[0-9\]*]\)*/\1/')"
319 [ "$RETVAL" != "void" ] && DECLS="$DECLS"$'\n'$'\t'"return ret;"
320 DECLS="$DECLS"$'\n'"}"
323 echo "$LINE" >> include/lightningpp_new.hpp
325 done < include/lightningpp.hpp
326 echo "$DECLS" >> include/lightningpp_new.hpp
327 echo "}" >> include/lightningpp_new.hpp
328 export IFS="$OLD_IFS"
330 mv include/lightningpp_new.hpp include/lightningpp.hpp
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
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
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
353 echo "WARNING: Please install valgrind for more testing"
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
365 echo " C++ Bin size and runtime w/o optimization:"
370 echo "Skipping tests!"
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 ( RUSTC_BOOTSTRAP=1 cargo build --features=std -v --release --target x86_64-apple-darwin -Zbuild-std=std,panic_abort > /dev/null 2>&1 ) || echo -n
378 ( RUSTC_BOOTSTRAP=1 cargo build --features=std -v --release --target aarch64-apple-darwin -Zbuild-std=std,panic_abort > /dev/null 2>&1 ) || echo -n
379 pushd ../deterministic-build-wrappers/compiler-builtins-dummy
380 cargo build > /dev/null 2>&1 || echo -n
382 # Sadly, std also depends on cc, and we can't pin it in that tree
383 # directly. Instead, we have to delete the file out of the cargo
384 # registry and build --offline to avoid it using the latest version.
385 NEW_CC_DEP="$CARGO_HOME"
386 [ "$NEW_CC_DEP" = "" ] && NEW_CC_DEP="$HOME"
387 [ -d "$NEW_CC_DEP/.cargo/registry/cache/"github.com-* ] && CARGO_REGISTRY_CACHE="$(echo "$NEW_CC_DEP/.cargo/registry/cache/"github.com-*)"
388 [ -d "$NEW_CC_DEP/.cargo/registry/cache/"index.crates.io-* ] && CARGO_REGISTRY_CACHE="$(echo "$NEW_CC_DEP/.cargo/registry/cache/"index.crates.io-*)"
389 if [ -d "$CARGO_REGISTRY_CACHE" ]; then
390 if [ -f "$CARGO_REGISTRY_CACHE/compiler_builtins-0.1.109.crate" ]; then
391 mv "$CARGO_REGISTRY_CACHE/compiler_builtins-0.1.109.crate" ./
393 if [ -f "$CARGO_REGISTRY_CACHE/cc-1.0.79.crate" ]; then
394 mv "$CARGO_REGISTRY_CACHE/cc-1.0.79.crate" ./
396 rm -f "$CARGO_REGISTRY_CACHE/"cc-*.crate
397 [ -f ./cc-1.0.79.crate ] && mv ./cc-1.0.79.crate "$CARGO_REGISTRY_CACHE/"
398 rm -f "$CARGO_REGISTRY_CACHE/"compiler_builtins-0.1.11*.crate
399 [ -f ./compiler_builtins-0.1.109.crate ] && mv ./compiler_builtins-0.1.109.crate "$CARGO_REGISTRY_CACHE/"
401 echo "Couldn't find cargo cache, build-std builds are likely to fail!"
405 # Then, check with memory sanitizer, if we're on Linux and have rustc nightly
406 if [ "$HOST_PLATFORM" = "x86_64-unknown-linux-gnu" ]; then
407 if cargo +nightly --version >/dev/null 2>&1; then
408 LLVM_V=$(rustc +nightly --version --verbose | grep "LLVM version" | awk '{ print substr($3, 0, 2); }')
409 if [ -x "$(which clang-$LLVM_V)" ]; then
413 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
414 mv target/x86_64-unknown-linux-gnu/debug/libldk.* target/debug/
416 # Sadly, std doesn't seem to compile into something that is memsan-safe as of Aug 2020,
417 # so we'll always fail, not to mention we may be linking against git rustc LLVM which
418 # may differ from clang-llvm, so just allow everything here to fail.
421 # First the C demo app...
422 clang-$LLVM_V $LOCAL_CFLAGS -fsanitize=memory -fsanitize-memory-track-origins -g demo.c target/debug/libldk.a -ldl
425 if [ "$2" = "true" ]; then
426 # ...then the C++ demo app
427 clang++-$LLVM_V $LOCAL_CFLAGS -std=c++11 -fsanitize=memory -fsanitize-memory-track-origins -g demo.cpp target/debug/libldk.a -ldl
430 # ...then the C++ demo app with the ldk_net network implementation
431 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
432 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
436 # restore exit-on-failure
439 echo "WARNING: Can't use memory sanitizer without clang-$LLVM_V"
442 echo "WARNING: Can't use memory sanitizer without rustc nightly"
445 echo "WARNING: Can't use memory sanitizer on non-Linux, non-x86 platforms"
448 RUSTC_LLVM_V=$(rustc --version --verbose | grep "LLVM version" | awk '{ print substr($3, 0, 2); }')
450 if [ "$HOST_OSX" = "true" ]; then
451 # Apple is special, as always, and their versions of clang aren't
452 # compatible with upstream LLVM.
453 if [ "$(clang --version | grep 'Apple clang')" != "" ]; then
454 echo "Apple clang isn't compatible with upstream clang, install upstream clang"
457 CLANG_LLVM_V=$(clang --version | head -n1 | awk '{ print substr($3, 0, 2); }')
458 if [ -x "$(which ld64.lld)" ]; then
459 LLD_LLVM_V="$(ld64.lld --version | awk '{ print substr($2, 0, 2); }')"
463 # Output is something like clang version 17.0.3 (Fedora 17.0.3-1.fc39) or Debian clang version 14.0.6
464 CLANG_LLVM_V=$(clang --version | head -n1 | awk '{ print substr($3, 0, 2); }')
465 [ "$CLANG_LLVM_V" = "ve" ] && CLANG_LLVM_V=$(clang --version | head -n1 | awk '{ print substr($4, 0, 2); }')
466 if [ -x "$(which ld.lld)" ]; then
467 LLD_LLVM_V="$(ld.lld --version | awk '{ print $2; }')"
468 if [ "$LLD_LLVM_V" = "LLD" ]; then # eg if the output is "Debian LLD ..."
469 LLD_LLVM_V="$(ld.lld --version | awk '{ print substr($3, 0, 2); }')"
471 LLD_LLVM_V="$(ld.lld --version | awk '{ print substr($2, 0, 2); }')"
477 if [ "$CLANG_LLVM_V" = "$RUSTC_LLVM_V" ]; then
480 if [ "$LLD_LLVM_V" = "$CLANG_LLVM_V" ]; then
483 elif [ -x "$(which clang-$RUSTC_LLVM_V)" ]; then
484 CLANG="$(which clang-$RUSTC_LLVM_V)"
485 CLANGPP="$(which clang++-$RUSTC_LLVM_V || echo clang++)"
486 if [ "$($CLANG --version)" != "$($CLANGPP --version)" ]; then
487 echo "$CLANG and $CLANGPP are not the same version of clang!"
491 if [ "$LLD_LLVM_V" != "$RUSTC_LLVM_V" ]; then
493 [ -x "$(which lld-$RUSTC_LLVM_V)" ] && LLD="lld-$RUSTC_LLVM_V"
494 LLD_LLVM_V="$(ld.lld-$RUSTC_LLVM_V --version | awk '{ print $2; }')"
495 if [ "$LLD_LLVM_V" = "LLD" ]; then # eg if the output is "Debian LLD ..."
496 LLD_LLVM_V="$(ld.lld-$RUSTC_LLVM_V --version | awk '{ print substr($3, 0, 2); }')"
498 LLD_LLVM_V="$(ld.lld-$RUSTC_LLVM_V --version | awk '{ print substr($2, 0, 2); }')"
500 if [ "$LLD_LLVM_V" != "$RUSTC_LLVM_V" ]; then
501 echo "Could not find a workable version of lld, not using cross-language LTO"
507 if [ "$CLANG" != "" -a "$CLANGPP" = "" ]; then
508 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"
509 echo "You should create a symlink called clang++-$RUSTC_LLVM_V pointing to $CLANG in $(dirname $CLANG)"
512 # Finally, if we're on Linux, build the final debug binary with address sanitizer (and leave it there)
513 if [ "$HOST_PLATFORM" = "x86_64-unknown-linux-gnu" ]; then
514 if [ "$CLANGPP" != "" ]; then
516 sed -i.bk 's/,"cdylib"]/]/g' Cargo.toml
518 # OSX sed is for some reason not compatible with GNU sed
519 sed -i .bk 's/,"cdylib"]/]/g' Cargo.toml
522 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)
523 mv Cargo.toml.bk Cargo.toml
525 # Sadly, address sanitizer appears to have had some regression on Debian and now fails to
526 # get past its init stage, so we disable it for now.
528 # First the C demo app...
529 #$CLANG $LOCAL_CFLAGS -fsanitize=address -g demo.c target/debug/libldk.a -ldl
530 #ASAN_OPTIONS='detect_leaks=1 detect_invalid_pointer_pairs=1 detect_stack_use_after_return=1' ./a.out
532 #if [ "$2" = "true" ]; then
533 # # ...then the C++ demo app
534 # $CLANGPP $LOCAL_CFLAGS -std=c++11 -fsanitize=address -g demo.cpp target/debug/libldk.a -ldl
535 # ASAN_OPTIONS='detect_leaks=1 detect_invalid_pointer_pairs=1 detect_stack_use_after_return=1' ./a.out >/dev/null
537 # # ...then the C++ demo app with the ldk_net network implementation
538 # $CLANG $LOCAL_CFLAGS -fPIC -fsanitize=address -g -I../ldk-net ../ldk-net/ldk_net.c -c -o ldk_net.o
539 # $CLANGPP $LOCAL_CFLAGS -std=c++11 -fsanitize=address -g -DREAL_NET -I../ldk-net ldk_net.o demo.cpp target/debug/libldk.a -ldl
540 # ASAN_OPTIONS='detect_leaks=1 detect_invalid_pointer_pairs=1 detect_stack_use_after_return=1' ./a.out >/dev/null
543 echo "WARNING: Please install clang-$RUSTC_LLVM_V and clang++-$RUSTC_LLVM_V to build with address sanitizer"
546 echo "WARNING: Can't use address sanitizer on non-Linux, non-x86 platforms"
549 # Now build with LTO on on both C++ and rust, but without cross-language LTO:
550 # Clear stale release build artifacts from previous runs
551 cargo clean --release
552 CARGO_PROFILE_RELEASE_LTO=true RUSTFLAGS="$RUSTFLAGS -C embed-bitcode=yes -C lto" cargo build $CARGO_BUILD_ARGS -v --release
553 if [ "$2" = "true" ]; then
554 clang++ $LOCAL_CFLAGS -std=c++11 -O2 demo.cpp target/release/libldk.a -ldl
559 echo "C++ Bin size and runtime with only RL (LTO) optimized:"
562 if [ "$CLANGPP" != "" ]; then
563 # If we can use cross-language LTO, use it for building C dependencies (i.e. libsecp256k1) as well
565 # The cc-rs crate tries to force -fdata-sections and -ffunction-sections on, which
566 # breaks -fembed-bitcode, so we turn off cc-rs' default flags and specify exactly
568 export CFLAGS_$ENV_TARGET="$BASE_HOST_CFLAGS -fPIC -fembed-bitcode"
569 export CRATE_CC_NO_DEFAULTS=true
572 if [ "$2" = "false" -a "$(rustc --print target-list | grep wasm32-wasi)" != "" ]; then
573 # Test to see if clang supports wasm32 as a target (which is needed to build rust-secp256k1)
574 echo "int main() {}" > genbindings_wasm_test_file.c
575 if clang -nostdlib -o /dev/null --target=wasm32-wasi -Wl,--no-entry genbindings_wasm_test_file.c > /dev/null 2>&1; then
576 # And if it does, build a WASM binary without capturing errors
577 export CFLAGS_wasm32_wasi="$BASE_CFLAGS -target wasm32-wasi -O1"
578 RUSTFLAGS="$BASE_RUSTFLAGS -C opt-level=1 --cfg=test_mod_pointers" cargo build $CARGO_BUILD_ARGS -v --target=wasm32-wasi
579 export CFLAGS_wasm32_wasi="$BASE_CFLAGS -fembed-bitcode -target wasm32-wasi -Oz"
580 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
582 echo "Cannot build WASM lib as clang does not seem to support the wasm32-wasi target"
584 rm genbindings_wasm_test_file.c
587 EXTRA_TARGETS=( $LDK_C_BINDINGS_EXTRA_TARGETS )
588 EXTRA_CCS=( $LDK_C_BINDINGS_EXTRA_TARGET_CCS )
589 EXTRA_LINK_LTO=( $LDK_C_BINDINGS_EXTRA_TARGET_LINK_LTO )
591 if [ ${#EXTRA_TARGETS[@]} != ${#EXTRA_CCS[@]} ]; then
592 echo "LDK_C_BINDINGS_EXTRA_TARGETS and LDK_C_BINDINGS_EXTRA_TARGET_CCS didn't have the same number of elements!"
596 for IDX in ${!EXTRA_TARGETS[@]}; do
597 EXTRA_ENV_TARGET=$(echo "${EXTRA_TARGETS[$IDX]}" | sed 's/-/_/g')
598 export CFLAGS_$EXTRA_ENV_TARGET="$BASE_CFLAGS"
599 export CC_$EXTRA_ENV_TARGET=${EXTRA_CCS[$IDX]}
601 case "$EXTRA_ENV_TARGET" in
603 export CFLAGS_$EXTRA_ENV_TARGET="$BASE_CFLAGS -march=sandybridge -mtune=sandybridge"
604 EXTRA_RUSTFLAGS="-C target-cpu=sandybridge"
607 [ "${EXTRA_LINK_LTO[$IDX]}" != "" ] && EXTRA_RUSTFLAGS="-C linker-plugin-lto"
608 RUSTFLAGS="$BASE_RUSTFLAGS -C embed-bitcode=yes -C lto -C linker=${EXTRA_CCS[$IDX]} $EXTRA_RUSTFLAGS" CARGO_PROFILE_RELEASE_LTO=true cargo build $CARGO_BUILD_ARGS -v --release --target "${EXTRA_TARGETS[$IDX]}"
611 if [ "$CLANGPP" != "" -a "$LLD" != "" ]; then
612 # Finally, test cross-language LTO. Note that this will fail if rustc and clang++
613 # build against different versions of LLVM (eg when rustc is installed via rustup
614 # or Ubuntu packages). This should work fine on Distros which do more involved
615 # packaging than simply shipping the rustup binaries (eg Debian should Just Work
617 LINK_ARG_FLAGS="-C link-arg=-fuse-ld=$LLD"
618 export LDK_CLANG_PATH=$(which $CLANG)
619 if [ "$MACOS_SDK" != "" ]; then
621 export CLANG="$(pwd)/../deterministic-build-wrappers/clang-lto-link-osx"
622 for ARG in $CFLAGS_aarch64_apple_darwin; do
623 MANUAL_LINK_CFLAGS="$MANUAL_LINK_CFLAGS -C link-arg=$ARG"
625 export CFLAGS_aarch64_apple_darwin="$CFLAGS_aarch64_apple_darwin -O3 -fPIC -fembed-bitcode"
626 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
627 if [ "$HOST_OSX" != "true" ]; then
628 # If we're not on OSX but can build OSX binaries, build the x86_64 OSX release now
629 MANUAL_LINK_CFLAGS=""
630 for ARG in $CFLAGS_x86_64_apple_darwin; do
631 MANUAL_LINK_CFLAGS="$MANUAL_LINK_CFLAGS -C link-arg=$ARG"
633 export CFLAGS_x86_64_apple_darwin="$CFLAGS_x86_64_apple_darwin -O3 -fPIC -fembed-bitcode"
634 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
637 # If we're on an M1 don't bother building X86 binaries
638 if [ "$HOST_PLATFORM" != "aarch64-apple-darwin" ]; then
639 [ "$HOST_OSX" != "true" ] && export CLANG="$LDK_CLANG_PATH"
640 export CFLAGS_$ENV_TARGET="$BASE_HOST_CFLAGS -O3 -fPIC -fembed-bitcode"
641 # Rust doesn't recognize CFLAGS changes, so we need to clean build artifacts
642 cargo clean --release
643 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
645 if [ "$2" = "true" ]; then
646 $CLANGPP $LOCAL_CFLAGS -flto -fuse-ld=$LLD -O2 -c demo.cpp -o demo.o
647 $CLANGPP $LOCAL_CFLAGS -flto -fuse-ld=$LLD -Wl,--lto-O2 -Wl,-O2 -O2 demo.o target/release/libldk.a -ldl
650 echo "C++ Bin size and runtime with cross-language LTO:"
655 if [ "$CFLAGS_aarch64_apple_darwin" != "" ]; then
656 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
658 echo "WARNING: Building with cross-language LTO is not avilable without clang-$RUSTC_LLVM_V and lld-$RUSTC_LLVM_V"