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 # On reasonable systems, we can use realpath here, but OSX is a diva with 20-year-old software.
15 LIGHTNING_PATH="$(pwd)"
16 LIGHTNING_GIT="$(git describe --tag --dirty)"
19 # Generate (and reasonably test) C bindings
21 # First build the latest c-bindings-gen binary
22 cd c-bindings-gen && cargo build --release && cd ..
24 # Then wipe all the existing C bindings (because we're being run in the right directory)
25 # note that we keep the few manually-generated files first:
26 mv lightning-c-bindings/src/c_types/mod.rs ./
27 mv lightning-c-bindings/src/bitcoin ./
29 # Before we try to sed the Cargo.toml, generate version define tags
30 # (ignoring any files that we're about to generate)
32 git checkout lightning-c-bindings/src
33 git checkout lightning-c-bindings/include
34 BINDINGS_GIT="$(git describe --tag --dirty)"
35 echo -e "#ifndef _LDK_HEADER_VER" > lightning-c-bindings/include/ldk_ver.h
36 echo -e "static inline int _ldk_strncmp(const char *s1, const char *s2, uint64_t n) {" >> lightning-c-bindings/include/ldk_ver.h
37 echo -e "\tif (n && *s1 != *s2) return 1;" >> lightning-c-bindings/include/ldk_ver.h
38 echo -e "\twhile (n && *s1 != 0 && *s2 != 0) {" >> lightning-c-bindings/include/ldk_ver.h
39 echo -e "\t\ts1++; s2++; n--;" >> lightning-c-bindings/include/ldk_ver.h
40 echo -e "\t\tif (n && *s1 != *s2) return 1;" >> lightning-c-bindings/include/ldk_ver.h
41 echo -e "\t}" >> lightning-c-bindings/include/ldk_ver.h
42 echo -e "\treturn 0;" >> lightning-c-bindings/include/ldk_ver.h
43 echo -e "}" >> lightning-c-bindings/include/ldk_ver.h
44 echo -e "" >> lightning-c-bindings/include/ldk_ver.h
45 echo -e "#define _LDK_HEADER_VER \"$LIGHTNING_GIT\"" >> lightning-c-bindings/include/ldk_ver.h
46 echo -e "#define _LDK_C_BINDINGS_HEADER_VER \"$BINDINGS_GIT\"" >> lightning-c-bindings/include/ldk_ver.h
47 echo -e "static inline const char* check_get_ldk_version() {" >> lightning-c-bindings/include/ldk_ver.h
48 echo -e "\tLDKStr bin_ver = _ldk_get_compiled_version();" >> lightning-c-bindings/include/ldk_ver.h
49 echo -e "\tif (_ldk_strncmp(_LDK_HEADER_VER, (const char*)bin_ver.chars, bin_ver.len) != 0) {" >> lightning-c-bindings/include/ldk_ver.h
50 echo -e "\t// Version mismatch, we don't know what we're running!" >> lightning-c-bindings/include/ldk_ver.h
51 echo -e "\t\treturn 0;" >> lightning-c-bindings/include/ldk_ver.h
52 echo -e "\t}" >> lightning-c-bindings/include/ldk_ver.h
53 echo -e "\treturn _LDK_HEADER_VER;" >> lightning-c-bindings/include/ldk_ver.h
54 echo -e "}" >> lightning-c-bindings/include/ldk_ver.h
55 echo -e "static inline const char* check_get_ldk_bindings_version() {" >> lightning-c-bindings/include/ldk_ver.h
56 echo -e "\tLDKStr bin_ver = _ldk_c_bindings_get_compiled_version();" >> lightning-c-bindings/include/ldk_ver.h
57 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
58 echo -e "\t// Version mismatch, we don't know what we're running!" >> lightning-c-bindings/include/ldk_ver.h
59 echo -e "\t\treturn 0;" >> lightning-c-bindings/include/ldk_ver.h
60 echo -e "\t}" >> lightning-c-bindings/include/ldk_ver.h
61 echo -e "\treturn _LDK_C_BINDINGS_HEADER_VER;" >> lightning-c-bindings/include/ldk_ver.h
62 echo -e "}" >> lightning-c-bindings/include/ldk_ver.h
63 echo -e "#endif /* _LDK_HEADER_VER */" >> lightning-c-bindings/include/ldk_ver.h
65 rm -rf lightning-c-bindings/src
67 mkdir -p lightning-c-bindings/src/{c_types,lightning}
68 mv ./mod.rs lightning-c-bindings/src/c_types/
69 mv ./bitcoin lightning-c-bindings/src/
71 # Finally, run the c-bindings-gen binary, building fresh bindings.
72 OUT="$(pwd)/lightning-c-bindings/src"
73 OUT_TEMPL="$(pwd)/lightning-c-bindings/src/c_types/derived.rs"
74 OUT_F="$(pwd)/lightning-c-bindings/include/ldk_rust_types.h"
75 OUT_CPP="$(pwd)/lightning-c-bindings/include/lightningpp.hpp"
76 BIN="$(pwd)/c-bindings-gen/target/release/c-bindings-gen"
78 HOST_PLATFORM="$(rustc --version --verbose | grep "host:")"
80 function add_crate() {
81 pushd "$LIGHTNING_PATH/$1"
82 RUSTC_BOOTSTRAP=1 cargo rustc --profile=check $3 -- -Zunstable-options --pretty=expanded > /tmp/$1-crate-source.txt
84 if [ "$HOST_PLATFORM" = "host: x86_64-apple-darwin" ]; then
85 sed -i".original" "1i\\
87 " /tmp/$1-crate-source.txt
89 sed -i "1ipub mod $2 {\n" /tmp/$1-crate-source.txt
91 echo "}" >> /tmp/$1-crate-source.txt
92 cat /tmp/$1-crate-source.txt >> /tmp/crate-source.txt
93 rm /tmp/$1-crate-source.txt
94 if [ "$HOST_PLATFORM" = "host: x86_64-apple-darwin" ]; then
95 # OSX sed is for some reason not compatible with GNU sed
96 sed -E -i '' 's|#?'$1' = \{ .*|'$1' = \{ path = "'"$LIGHTNING_PATH"'/'$1'" '"$4"' }|' lightning-c-bindings/Cargo.toml
98 sed -E -i 's|#?'$1' = \{ .*|'$1' = \{ path = "'"$LIGHTNING_PATH"'/'$1'" '"$4"' }|' lightning-c-bindings/Cargo.toml
102 function drop_crate() {
103 if [ "$HOST_PLATFORM" = "host: x86_64-apple-darwin" ]; then
104 # OSX sed is for some reason not compatible with GNU sed
105 sed -E -i '' 's|'$1' = \{ (.*)|#'$1' = \{ \1|' lightning-c-bindings/Cargo.toml
107 sed -E -i 's|'$1' = \{ (.*)|#'$1' = \{ \1|' lightning-c-bindings/Cargo.toml
111 echo > /tmp/crate-source.txt
112 if [ "$2" = "true" ]; then
113 add_crate lightning lightning --features=allow_wallclock_use ', features = ["allow_wallclock_use"]'
114 add_crate "lightning-persister" "lightning_persister"
115 add_crate "lightning-background-processor" "lightning_background_processor"
117 add_crate lightning lightning
118 drop_crate "lightning-persister"
119 drop_crate "lightning-background-processor"
121 add_crate "lightning-invoice" "lightning_invoice"
123 cat /tmp/crate-source.txt | RUST_BACKTRACE=1 "$BIN" "$OUT/" "$OUT_TEMPL" "$OUT_F" "$OUT_CPP"
125 echo -e '#[no_mangle]' >> lightning-c-bindings/src/version.rs
126 echo -e 'pub extern "C" fn _ldk_get_compiled_version() -> crate::c_types::Str {' >> lightning-c-bindings/src/version.rs
127 echo -e '\t"'"$LIGHTNING_GIT"'".into()' >> lightning-c-bindings/src/version.rs
128 echo -e '}' >> lightning-c-bindings/src/version.rs
129 echo -e '#[no_mangle]' >> lightning-c-bindings/src/version.rs
130 echo -e 'pub extern "C" fn _ldk_c_bindings_get_compiled_version() -> crate::c_types::Str {' >> lightning-c-bindings/src/version.rs
131 echo -e '\t"'"$BINDINGS_GIT"'".into()' >> lightning-c-bindings/src/version.rs
132 echo -e '}' >> lightning-c-bindings/src/version.rs
134 # Set path to include our rustc wrapper as well as cbindgen
135 PATH="$(pwd)/deterministic-build-wrappers:$PATH:~/.cargo/bin"
136 # Now cd to lightning-c-bindings, build the generated bindings, and call cbindgen to build a C header file
137 cd lightning-c-bindings
139 # Remap paths so that our builds are deterministic
140 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"
142 # If the C compiler supports it, also set -ffile-prefix-map
143 echo "int main() {}" > genbindings_path_map_test_file.c
144 clang -o /dev/null -ffile-prefix-map=$HOME/.cargo= genbindings_path_map_test_file.c > /dev/null 2>&1 &&
145 # Now that we've done our last non-LTO build, turn on LTO in CFLAGS as well
146 export CFLAGS="-ffile-prefix-map=$HOME/.cargo="
147 rm genbindings_path_map_test_file.c
150 cbindgen -v --config cbindgen.toml -o include/lightning.h >/dev/null 2>&1
152 # cbindgen is relatively braindead when exporting typedefs -
153 # it happily exports all our typedefs for private types, even with the
154 # generics we specified in C mode! So we drop all those types manually here.
155 if [ "$HOST_PLATFORM" = "host: x86_64-apple-darwin" ]; then
156 # OSX sed is for some reason not compatible with GNU sed
157 sed -i '' 's/typedef LDKnative.*Import.*LDKnative.*;//g' include/lightning.h
159 # stdlib.h doesn't exist in clang's wasm sysroot, and cbindgen
160 # doesn't actually use it anyway, so drop the import.
161 sed -i '' 's/#include <stdlib.h>/#include <ldk_rust_types.h>/g' include/lightning.h
163 sed -i 's/typedef LDKnative.*Import.*LDKnative.*;//g' include/lightning.h
165 # stdlib.h doesn't exist in clang's wasm sysroot, and cbindgen
166 # doesn't actually use it anyway, so drop the import.
167 sed -i 's/#include <stdlib.h>/#include <ldk_rust_types.h>/g' include/lightning.h
170 # Finally, sanity-check the generated C and C++ bindings with demo apps:
172 LOCAL_CFLAGS="-Wall -Wno-nullability-completeness -pthread -Iinclude/"
174 # Naively run the C demo app:
175 gcc $LOCAL_CFLAGS -Wall -g -pthread demo.c target/debug/libldk.a -ldl
178 # And run the C++ demo app in valgrind to test memory model correctness and lack of leaks.
179 g++ $LOCAL_CFLAGS -std=c++11 -Wall -g -pthread demo.cpp -Ltarget/debug/ -lldk -ldl
180 if [ -x "`which valgrind`" ]; then
181 LD_LIBRARY_PATH=target/debug/ valgrind --error-exitcode=4 --memcheck:leak-check=full --show-leak-kinds=all ./a.out
184 echo "WARNING: Please install valgrind for more testing"
187 # Test a statically-linked C++ version, tracking the resulting binary size and runtime
188 # across debug, LTO, and cross-language LTO builds (using the same compiler each time).
189 clang++ $LOCAL_CFLAGS -std=c++11 demo.cpp target/debug/libldk.a -ldl
191 echo " C++ Bin size and runtime w/o optimization:"
193 time ./a.out > /dev/null
195 # Then, check with memory sanitizer, if we're on Linux and have rustc nightly
196 if [ "$HOST_PLATFORM" = "host: x86_64-unknown-linux-gnu" ]; then
197 if cargo +nightly --version >/dev/null 2>&1; then
198 LLVM_V=$(rustc +nightly --version --verbose | grep "LLVM version" | awk '{ print substr($3, 0, 2); }')
199 if [ -x "$(which clang-$LLVM_V)" ]; then
201 cargo +nightly rustc -Zbuild-std --target x86_64-unknown-linux-gnu -v -- -Zsanitizer=memory -Zsanitizer-memory-track-origins -Cforce-frame-pointers=yes
202 mv target/x86_64-unknown-linux-gnu/debug/libldk.* target/debug/
204 # Sadly, std doesn't seem to compile into something that is memsan-safe as of Aug 2020,
205 # so we'll always fail, not to mention we may be linking against git rustc LLVM which
206 # may differ from clang-llvm, so just allow everything here to fail.
209 # First the C demo app...
210 clang-$LLVM_V $LOCAL_CFLAGS -fsanitize=memory -fsanitize-memory-track-origins -g demo.c target/debug/libldk.a -ldl
213 # ...then the C++ demo app
214 clang++-$LLVM_V $LOCAL_CFLAGS -std=c++11 -fsanitize=memory -fsanitize-memory-track-origins -g demo.cpp target/debug/libldk.a -ldl
217 # restore exit-on-failure
220 echo "WARNING: Can't use memory sanitizer without clang-$LLVM_V"
223 echo "WARNING: Can't use memory sanitizer without rustc nightly"
226 echo "WARNING: Can't use memory sanitizer on non-Linux, non-x86 platforms"
229 RUSTC_LLVM_V=$(rustc --version --verbose | grep "LLVM version" | awk '{ print substr($3, 0, 2); }' | tr -d '.')
231 if [ "$HOST_PLATFORM" = "host: x86_64-apple-darwin" ]; then
232 # Apple is special, as always, and decided that they must ensure that there is no way to identify
233 # the LLVM version used. Why? Just to make your life hard.
234 # This list is taken from https://en.wikipedia.org/wiki/Xcode
235 APPLE_CLANG_V=$(clang --version | head -n1 | awk '{ print $4 }')
236 if [ "$APPLE_CLANG_V" = "10.0.0" ]; then
238 elif [ "$APPLE_CLANG_V" = "10.0.1" ]; then
240 elif [ "$APPLE_CLANG_V" = "11.0.0" ]; then
242 elif [ "$APPLE_CLANG_V" = "11.0.3" ]; then
244 elif [ "$APPLE_CLANG_V" = "12.0.0" ]; then
247 echo "WARNING: Unable to identify Apple clang LLVM version"
251 CLANG_LLVM_V=$(clang --version | head -n1 | awk '{ print substr($4, 0, 2); }' | tr -d '.')
254 if [ "$CLANG_LLVM_V" = "$RUSTC_LLVM_V" ]; then
257 elif [ "$(which clang-$RUSTC_LLVM_V)" != "" ]; then
258 CLANG="$(which clang-$RUSTC_LLVM_V)"
259 CLANGPP="$(which clang++-$RUSTC_LLVM_V)"
262 if [ "$CLANG" != "" -a "$CLANGPP" = "" ]; then
263 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"
264 echo "You should create a symlink called clang++-$RUSTC_LLVM_V pointing to $CLANG in $(dirname $CLANG)"
267 # Finally, if we're on OSX or on Linux, build the final debug binary with address sanitizer (and leave it there)
268 if [ "$HOST_PLATFORM" = "host: x86_64-unknown-linux-gnu" -o "$HOST_PLATFORM" = "host: x86_64-apple-darwin" ]; then
269 if [ "$CLANGPP" != "" ]; then
270 if [ "$HOST_PLATFORM" = "host: x86_64-apple-darwin" ]; then
271 # OSX sed is for some reason not compatible with GNU sed
272 sed -i .bk 's/,"cdylib"]/]/g' Cargo.toml
274 sed -i.bk 's/,"cdylib"]/]/g' Cargo.toml
276 RUSTC_BOOTSTRAP=1 cargo rustc -v -- -Zsanitizer=address -Cforce-frame-pointers=yes || ( mv Cargo.toml.bk Cargo.toml; exit 1)
277 mv Cargo.toml.bk Cargo.toml
279 # First the C demo app...
280 $CLANG $LOCAL_CFLAGS -fsanitize=address -g demo.c target/debug/libldk.a -ldl
281 ASAN_OPTIONS='detect_leaks=1 detect_invalid_pointer_pairs=1 detect_stack_use_after_return=1' ./a.out
283 # ...then the C++ demo app
284 $CLANGPP $LOCAL_CFLAGS -std=c++11 -fsanitize=address -g demo.cpp target/debug/libldk.a -ldl
285 ASAN_OPTIONS='detect_leaks=1 detect_invalid_pointer_pairs=1 detect_stack_use_after_return=1' ./a.out >/dev/null
287 echo "WARNING: Please install clang-$RUSTC_LLVM_V and clang++-$RUSTC_LLVM_V to build with address sanitizer"
290 echo "WARNING: Can't use address sanitizer on non-Linux, non-OSX non-x86 platforms"
293 # Now build with LTO on on both C++ and rust, but without cross-language LTO:
294 # Clear stale release build artifacts from previous runs
295 cargo clean --release
296 CARGO_PROFILE_RELEASE_LTO=true cargo rustc -v --release -- -C lto
297 clang++ $LOCAL_CFLAGS -std=c++11 -flto -O2 demo.cpp target/release/libldk.a -ldl
300 echo "C++ Bin size and runtime with only RL (LTO) optimized:"
302 time ./a.out > /dev/null
304 if [ "$HOST_PLATFORM" != "host: x86_64-apple-darwin" -a "$CLANGPP" != "" ]; then
305 # If we can use cross-language LTO, use it for building C dependencies (i.e. libsecp256k1) as well
307 # The cc-rs crate tries to force -fdata-sections and -ffunction-sections on, which
308 # breaks -fembed-bitcode, so we turn off cc-rs' default flags and specify exactly
310 export CFLAGS="$CFLAGS -fPIC -fembed-bitcode"
311 export CRATE_CC_NO_DEFAULTS=true
314 if [ "$2" = "false" -a "$(rustc --print target-list | grep wasm32-wasi)" != "" ]; then
315 # Test to see if clang supports wasm32 as a target (which is needed to build rust-secp256k1)
316 echo "int main() {}" > genbindings_wasm_test_file.c
317 if clang -nostdlib -o /dev/null --target=wasm32-wasi -Wl,--no-entry genbindings_wasm_test_file.c > /dev/null 2>&1; then
318 # And if it does, build a WASM binary without capturing errors
319 export CFLAGS_wasm32_wasi="-target wasm32"
320 cargo rustc -v --target=wasm32-wasi
321 export CFLAGS_wasm32_wasi="-target wasm32 -Os"
322 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
324 echo "Cannot build WASM lib as clang does not seem to support the wasm32-wasi target"
326 rm genbindings_wasm_test_file.c
329 if [ "$HOST_PLATFORM" != "host: x86_64-apple-darwin" -a "$CLANGPP" != "" ]; then
330 # Finally, test cross-language LTO. Note that this will fail if rustc and clang++
331 # build against different versions of LLVM (eg when rustc is installed via rustup
332 # or Ubuntu packages). This should work fine on Distros which do more involved
333 # packaging than simply shipping the rustup binaries (eg Debian should Just Work
335 export CFLAGS="$CFLAGS -O3"
336 # Rust doesn't recognize CFLAGS changes, so we need to clean build artifacts
337 cargo clean --release
338 CARGO_PROFILE_RELEASE_LTO=true cargo rustc -v --release -- -C linker-plugin-lto -C lto -C link-arg=-fuse-ld=lld
339 $CLANGPP $LOCAL_CFLAGS -flto -fuse-ld=lld -O2 demo.cpp target/release/libldk.a -ldl
341 echo "C++ Bin size and runtime with cross-language LTO:"
343 time ./a.out > /dev/null
345 echo "WARNING: Building with cross-language LTO is not avilable on OSX or without clang-$RUSTC_LLVM_V"