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