6 if [ ! -d "$1/lightning" ]; then
7 echo "USAGE: $0 path-to-rust-lightning"
11 # On reasonable systems, we can use realpath here, but OSX is a diva with 20-year-old software.
14 LIGHTNING_PATH="$(pwd)"
17 # Generate (and reasonably test) C bindings
19 # First build the latest c-bindings-gen binary
20 cd c-bindings-gen && cargo build --release && cd ..
22 # Then wipe all the existing C bindings (because we're being run in the right directory)
23 # note that we keep the few manually-generated files first:
24 mv lightning-c-bindings/src/c_types/mod.rs ./
25 mv lightning-c-bindings/src/bitcoin ./
27 rm -rf lightning-c-bindings/src
29 mkdir -p lightning-c-bindings/src/c_types/
30 mv ./mod.rs lightning-c-bindings/src/c_types/
31 mv ./bitcoin lightning-c-bindings/src/
33 # Finally, run the c-bindings-gen binary, building fresh bindings.
34 OUT="$(pwd)/lightning-c-bindings/src"
35 OUT_TEMPL="$(pwd)/lightning-c-bindings/src/c_types/derived.rs"
36 OUT_F="$(pwd)/lightning-c-bindings/include/rust_types.h"
37 OUT_CPP="$(pwd)/lightning-c-bindings/include/lightningpp.hpp"
38 BIN="$(pwd)/c-bindings-gen/target/release/c-bindings-gen"
40 pushd "$LIGHTNING_PATH"
41 RUSTC_BOOTSTRAP=1 cargo rustc --profile=check -- -Zunstable-options --pretty=expanded |
42 RUST_BACKTRACE=1 "$BIN" "$OUT/" lightning "$OUT_TEMPL" "$OUT_F" "$OUT_CPP"
45 HOST_PLATFORM="$(rustc --version --verbose | grep "host:")"
46 if [ "$HOST_PLATFORM" = "host: x86_64-apple-darwin" ]; then
47 # OSX sed is for some reason not compatible with GNU sed
48 sed -i '' 's|lightning = { .*|lightning = { path = "'"$LIGHTNING_PATH"'" }|' lightning-c-bindings/Cargo.toml
50 sed -i 's|lightning = { .*|lightning = { path = "'"$LIGHTNING_PATH"'" }|' lightning-c-bindings/Cargo.toml
53 # Set path to include our rustc wrapper as well as cbindgen
54 PATH="$(pwd)/deterministic-build-wrappers:$PATH:~/.cargo/bin"
55 # Now cd to lightning-c-bindings, build the generated bindings, and call cbindgen to build a C header file
56 cd lightning-c-bindings
57 # Remap paths so that our builds are deterministic
58 export RUSTFLAGS="--remap-path-prefix $LIGHTNING_PATH=rust-lightning --remap-path-prefix $(pwd)=ldk-c-bindings --remap-path-prefix $HOME/.cargo= -C target-cpu=generic"
59 export CFLAGS="-ffile-prefix-map=$HOME/.cargo="
62 cbindgen -v --config cbindgen.toml -o include/lightning.h >/dev/null 2>&1
64 # cbindgen is relatively braindead when exporting typedefs -
65 # it happily exports all our typedefs for private types, even with the
66 # generics we specified in C mode! So we drop all those types manually here.
67 if [ "$HOST_PLATFORM" = "host: x86_64-apple-darwin" ]; then
68 # OSX sed is for some reason not compatible with GNU sed
69 sed -i '' 's/typedef LDKnative.*Import.*LDKnative.*;//g' include/lightning.h
71 # stdlib.h doesn't exist in clang's wasm sysroot, and cbindgen
72 # doesn't actually use it anyway, so drop the import.
73 sed -i '' 's/#include <stdlib.h>//g' include/lightning.h
75 sed -i 's/typedef LDKnative.*Import.*LDKnative.*;//g' include/lightning.h
77 # stdlib.h doesn't exist in clang's wasm sysroot, and cbindgen
78 # doesn't actually use it anyway, so drop the import.
79 sed -i 's/#include <stdlib.h>//g' include/lightning.h
82 # Finally, sanity-check the generated C and C++ bindings with demo apps:
84 LOCAL_CFLAGS="-Wall -Wno-nullability-completeness -pthread"
86 # Naively run the C demo app:
87 gcc $LOCAL_CFLAGS -Wall -g -pthread demo.c target/debug/libldk.a -ldl
90 # And run the C++ demo app in valgrind to test memory model correctness and lack of leaks.
91 g++ $LOCAL_CFLAGS -std=c++11 -Wall -g -pthread demo.cpp -Ltarget/debug/ -lldk -ldl
92 if [ -x "`which valgrind`" ]; then
93 LD_LIBRARY_PATH=target/debug/ valgrind --error-exitcode=4 --memcheck:leak-check=full --show-leak-kinds=all ./a.out
96 echo "WARNING: Please install valgrind for more testing"
99 # Test a statically-linked C++ version, tracking the resulting binary size and runtime
100 # across debug, LTO, and cross-language LTO builds (using the same compiler each time).
101 clang++ $LOCAL_CFLAGS -std=c++11 demo.cpp target/debug/libldk.a -ldl
103 echo " C++ Bin size and runtime w/o optimization:"
105 time ./a.out > /dev/null
107 # Then, check with memory sanitizer, if we're on Linux and have rustc nightly
108 if [ "$HOST_PLATFORM" = "host: x86_64-unknown-linux-gnu" ]; then
109 if cargo +nightly --version >/dev/null 2>&1; then
110 LLVM_V=$(rustc +nightly --version --verbose | grep "LLVM version" | awk '{ print substr($3, 0, 2); }')
111 if [ -x "$(which clang-$LLVM_V)" ]; then
113 cargo +nightly rustc -Zbuild-std --target x86_64-unknown-linux-gnu -v -- -Zsanitizer=memory -Zsanitizer-memory-track-origins -Cforce-frame-pointers=yes
114 mv target/x86_64-unknown-linux-gnu/debug/libldk.* target/debug/
116 # Sadly, std doesn't seem to compile into something that is memsan-safe as of Aug 2020,
117 # so we'll always fail, not to mention we may be linking against git rustc LLVM which
118 # may differ from clang-llvm, so just allow everything here to fail.
121 # First the C demo app...
122 clang-$LLVM_V $LOCAL_CFLAGS -fsanitize=memory -fsanitize-memory-track-origins -g demo.c target/debug/libldk.a -ldl
125 # ...then the C++ demo app
126 clang++-$LLVM_V $LOCAL_CFLAGS -std=c++11 -fsanitize=memory -fsanitize-memory-track-origins -g demo.cpp target/debug/libldk.a -ldl
129 # restore exit-on-failure
132 echo "WARNING: Can't use memory sanitizer without clang-$LLVM_V"
135 echo "WARNING: Can't use memory sanitizer without rustc nightly"
138 echo "WARNING: Can't use memory sanitizer on non-Linux, non-x86 platforms"
141 RUSTC_LLVM_V=$(rustc --version --verbose | grep "LLVM version" | awk '{ print substr($3, 0, 2); }' | tr -d '.')
143 if [ "$HOST_PLATFORM" = "host: x86_64-apple-darwin" ]; then
144 # Apple is special, as always, and decided that they must ensure that there is no way to identify
145 # the LLVM version used. Why? Just to make your life hard.
146 # This list is taken from https://en.wikipedia.org/wiki/Xcode
147 APPLE_CLANG_V=$(clang --version | head -n1 | awk '{ print $4 }')
148 if [ "$APPLE_CLANG_V" = "10.0.0" ]; then
150 elif [ "$APPLE_CLANG_V" = "10.0.1" ]; then
152 elif [ "$APPLE_CLANG_V" = "11.0.0" ]; then
154 elif [ "$APPLE_CLANG_V" = "11.0.3" ]; then
156 elif [ "$APPLE_CLANG_V" = "12.0.0" ]; then
159 echo "WARNING: Unable to identify Apple clang LLVM version"
163 CLANG_LLVM_V=$(clang --version | head -n1 | awk '{ print substr($4, 0, 2); }' | tr -d '.')
166 if [ "$CLANG_LLVM_V" = "$RUSTC_LLVM_V" ]; then
169 elif [ "$(which clang-$RUSTC_LLVM_V)" != "" ]; then
170 CLANG="$(which clang-$RUSTC_LLVM_V)"
171 CLANGPP="$(which clang++-$RUSTC_LLVM_V)"
174 if [ "$CLANG" != "" -a "$CLANGPP" = "" ]; then
175 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"
176 echo "You should create a symlink called clang++-$RUSTC_LLVM_V pointing to $CLANG in $(dirname $CLANG)"
179 # Finally, if we're on OSX or on Linux, build the final debug binary with address sanitizer (and leave it there)
180 if [ "$HOST_PLATFORM" = "host: x86_64-unknown-linux-gnu" -o "$HOST_PLATFORM" = "host: x86_64-apple-darwin" ]; then
181 if [ "$CLANGPP" != "" ]; then
182 if [ "$HOST_PLATFORM" = "host: x86_64-apple-darwin" ]; then
183 # OSX sed is for some reason not compatible with GNU sed
184 sed -i .bk 's/,"cdylib"]/]/g' Cargo.toml
186 sed -i.bk 's/,"cdylib"]/]/g' Cargo.toml
188 RUSTC_BOOTSTRAP=1 cargo rustc -v -- -Zsanitizer=address -Cforce-frame-pointers=yes || ( mv Cargo.toml.bk Cargo.toml; exit 1)
189 mv Cargo.toml.bk Cargo.toml
191 # First the C demo app...
192 $CLANG $LOCAL_CFLAGS -fsanitize=address -g demo.c target/debug/libldk.a -ldl
193 ASAN_OPTIONS='detect_leaks=1 detect_invalid_pointer_pairs=1 detect_stack_use_after_return=1' ./a.out
195 # ...then the C++ demo app
196 $CLANGPP $LOCAL_CFLAGS -std=c++11 -fsanitize=address -g demo.cpp target/debug/libldk.a -ldl
197 ASAN_OPTIONS='detect_leaks=1 detect_invalid_pointer_pairs=1 detect_stack_use_after_return=1' ./a.out >/dev/null
199 echo "WARNING: Please install clang-$RUSTC_LLVM_V and clang++-$RUSTC_LLVM_V to build with address sanitizer"
202 echo "WARNING: Can't use address sanitizer on non-Linux, non-OSX non-x86 platforms"
205 # Now build with LTO on on both C++ and rust, but without cross-language LTO:
206 # Clear stale release build artifacts from previous runs
207 cargo clean --release
208 CARGO_PROFILE_RELEASE_LTO=true cargo rustc -v --release -- -C lto
209 clang++ $LOCAL_CFLAGS -std=c++11 -flto -O2 demo.cpp target/release/libldk.a -ldl
211 if [ "$HOST_PLATFORM" != "host: x86_64-apple-darwin" -a "$CLANGPP" != "" ]; then
212 # If we can use cross-language LTO, use it for building C dependencies (i.e. libsecp256k1) as well
214 export CFLAGS_wasm32_wasi="-target wasm32"
217 if [ "$(rustc --print target-list | grep wasm32-wasi)" != "" ]; then
218 # Test to see if clang supports wasm32 as a target (which is needed to build rust-secp256k1)
219 echo "int main() {}" > genbindings_wasm_test_file.c
220 clang -nostdlib -o /dev/null --target=wasm32-wasi -Wl,--no-entry genbindings_wasm_test_file.c > /dev/null 2>&1 &&
221 # And if it does, build a WASM binary without capturing errors
222 cargo rustc -v --target=wasm32-wasi -- -C embed-bitcode=yes &&
223 # Now that we've done our last non-LTO build, turn on LTO in CFLAGS as well
224 export CFLAGS="$CFLAGS -flto" &&
225 CARGO_PROFILE_RELEASE_LTO=true cargo rustc -v --release --target=wasm32-wasi -- -C opt-level=s -C linker-plugin-lto -C lto ||
226 echo "Cannot build WASM lib as clang does not seem to support the wasm32-wasi target"
227 rm genbindings_wasm_test_file.c
231 echo "C++ Bin size and runtime with only RL (LTO) optimized:"
233 time ./a.out > /dev/null
235 if [ "$HOST_PLATFORM" != "host: x86_64-apple-darwin" -a "$CLANGPP" != "" ]; then
236 # Finally, test cross-language LTO. Note that this will fail if rustc and clang++
237 # build against different versions of LLVM (eg when rustc is installed via rustup
238 # or Ubuntu packages). This should work fine on Distros which do more involved
239 # packaging than simply shipping the rustup binaries (eg Debian should Just Work
241 export CFLAGS="$CFLAGS -flto"
242 # Rust doesn't recognize CFLAGS changes, so we need to clean build artifacts
243 cargo clean --release
244 CARGO_PROFILE_RELEASE_LTO=true cargo rustc -v --release -- -C linker-plugin-lto -C lto -C link-arg=-fuse-ld=lld
245 $CLANGPP $LOCAL_CFLAGS -flto -fuse-ld=lld -O2 demo.cpp target/release/libldk.a -ldl
247 echo "C++ Bin size and runtime with cross-language LTO:"
249 time ./a.out > /dev/null
251 echo "WARNING: Building with cross-language LTO is not avilable on OSX or without clang-$RUSTC_LLVM_V"