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