X-Git-Url: http://git.bitcoin.ninja/index.cgi?p=ldk-c-bindings;a=blobdiff_plain;f=genbindings.sh;h=739699977e58319c4c12188761f35e5a11c951a5;hp=8fd11889910401d21b01cbd6d81393a36ef34495;hb=d3d51441b4cd98389308d4cfaba6548f25598c4c;hpb=6f808498a34b80af2646097f138c54132c48d6f9 diff --git a/genbindings.sh b/genbindings.sh index 8fd1188..7396999 100755 --- a/genbindings.sh +++ b/genbindings.sh @@ -9,15 +9,11 @@ if [ ! -d "$1/lightning" -o "$2" != "true" -a "$2" != "false" ]; then exit 1 fi -if [ "$2" = "true" ]; then - FEATURES_ARGS='--features=allow_wallclock_use' - FEATURES='"allow_wallclock_use"' -fi - # On reasonable systems, we can use realpath here, but OSX is a diva with 20-year-old software. ORIG_PWD="$(pwd)" cd "$1" LIGHTNING_PATH="$(pwd)" +LIGHTNING_GIT="$(git describe --tag --dirty)" cd "$ORIG_PWD" # Generate (and reasonably test) C bindings @@ -30,6 +26,42 @@ cd c-bindings-gen && cargo build --release && cd .. mv lightning-c-bindings/src/c_types/mod.rs ./ mv lightning-c-bindings/src/bitcoin ./ +# Before we try to sed the Cargo.toml, generate version define tags +# (ignoring any files that we're about to generate) + +git checkout lightning-c-bindings/src +git checkout lightning-c-bindings/include +BINDINGS_GIT="$(git describe --tag --dirty)" +echo -e "#ifndef _LDK_HEADER_VER" > lightning-c-bindings/include/ldk_ver.h +echo -e "static inline int _ldk_strncmp(const char *s1, const char *s2, uint64_t n) {" >> lightning-c-bindings/include/ldk_ver.h +echo -e "\tif (n && *s1 != *s2) return 1;" >> lightning-c-bindings/include/ldk_ver.h +echo -e "\twhile (n && *s1 != 0 && *s2 != 0) {" >> lightning-c-bindings/include/ldk_ver.h +echo -e "\t\ts1++; s2++; n--;" >> lightning-c-bindings/include/ldk_ver.h +echo -e "\t\tif (n && *s1 != *s2) return 1;" >> lightning-c-bindings/include/ldk_ver.h +echo -e "\t}" >> lightning-c-bindings/include/ldk_ver.h +echo -e "\treturn 0;" >> lightning-c-bindings/include/ldk_ver.h +echo -e "}" >> lightning-c-bindings/include/ldk_ver.h +echo -e "" >> lightning-c-bindings/include/ldk_ver.h +echo -e "#define _LDK_HEADER_VER \"$LIGHTNING_GIT\"" >> lightning-c-bindings/include/ldk_ver.h +echo -e "#define _LDK_C_BINDINGS_HEADER_VER \"$BINDINGS_GIT\"" >> lightning-c-bindings/include/ldk_ver.h +echo -e "static inline const char* check_get_ldk_version() {" >> lightning-c-bindings/include/ldk_ver.h +echo -e "\tLDKStr bin_ver = _ldk_get_compiled_version();" >> lightning-c-bindings/include/ldk_ver.h +echo -e "\tif (_ldk_strncmp(_LDK_HEADER_VER, (const char*)bin_ver.chars, bin_ver.len) != 0) {" >> lightning-c-bindings/include/ldk_ver.h +echo -e "\t// Version mismatch, we don't know what we're running!" >> lightning-c-bindings/include/ldk_ver.h +echo -e "\t\treturn 0;" >> lightning-c-bindings/include/ldk_ver.h +echo -e "\t}" >> lightning-c-bindings/include/ldk_ver.h +echo -e "\treturn _LDK_HEADER_VER;" >> lightning-c-bindings/include/ldk_ver.h +echo -e "}" >> lightning-c-bindings/include/ldk_ver.h +echo -e "static inline const char* check_get_ldk_bindings_version() {" >> lightning-c-bindings/include/ldk_ver.h +echo -e "\tLDKStr bin_ver = _ldk_c_bindings_get_compiled_version();" >> lightning-c-bindings/include/ldk_ver.h +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 +echo -e "\t// Version mismatch, we don't know what we're running!" >> lightning-c-bindings/include/ldk_ver.h +echo -e "\t\treturn 0;" >> lightning-c-bindings/include/ldk_ver.h +echo -e "\t}" >> lightning-c-bindings/include/ldk_ver.h +echo -e "\treturn _LDK_C_BINDINGS_HEADER_VER;" >> lightning-c-bindings/include/ldk_ver.h +echo -e "}" >> lightning-c-bindings/include/ldk_ver.h +echo -e "#endif /* _LDK_HEADER_VER */" >> lightning-c-bindings/include/ldk_ver.h + rm -rf lightning-c-bindings/src mkdir -p lightning-c-bindings/src/{c_types,lightning} @@ -39,57 +71,78 @@ mv ./bitcoin lightning-c-bindings/src/ # Finally, run the c-bindings-gen binary, building fresh bindings. OUT="$(pwd)/lightning-c-bindings/src" OUT_TEMPL="$(pwd)/lightning-c-bindings/src/c_types/derived.rs" -OUT_F="$(pwd)/lightning-c-bindings/include/rust_types.h" +OUT_F="$(pwd)/lightning-c-bindings/include/ldk_rust_types.h" OUT_CPP="$(pwd)/lightning-c-bindings/include/lightningpp.hpp" BIN="$(pwd)/c-bindings-gen/target/release/c-bindings-gen" -pushd "$LIGHTNING_PATH/lightning" -RUSTC_BOOTSTRAP=1 cargo rustc $FEATURES_ARGS --profile=check -- -Zunstable-options --pretty=expanded > /tmp/lightning-crate-source.txt -popd - HOST_PLATFORM="$(rustc --version --verbose | grep "host:")" -if [ "$HOST_PLATFORM" = "host: x86_64-apple-darwin" ]; then - # OSX sed is for some reason not compatible with GNU sed - sed -E -i '' 's/#!\[crate_name = "(.*)"\]/pub mod \1 {/' /tmp/lightning-crate-source.txt -else - sed -E -i 's/#!\[crate_name = "(.*)"\]/pub mod \1 {/' /tmp/lightning-crate-source.txt -fi -echo "}" >> /tmp/lightning-crate-source.txt -if [ "$2" = "true" ]; then - pushd "$LIGHTNING_PATH/lightning-persister" - RUSTC_BOOTSTRAP=1 cargo rustc --profile=check -- -Zunstable-options --pretty=expanded > /tmp/lightning-persist-crate-source.txt +function add_crate() { + pushd "$LIGHTNING_PATH/$1" + RUSTC_BOOTSTRAP=1 cargo rustc --profile=check $3 -- -Zunstable-options --pretty=expanded > /tmp/$1-crate-source.txt popd if [ "$HOST_PLATFORM" = "host: x86_64-apple-darwin" ]; then - sed -i".original" '1i\ -pub mod lightning_persister { -' /tmp/lightning-persist-crate-source.txt + sed -i".original" "1i\\ +pub mod $2 { +" /tmp/$1-crate-source.txt else - sed -i '1ipub mod lightning_persister {\n' /tmp/lightning-persist-crate-source.txt + sed -i "1ipub mod $2 {\n" /tmp/$1-crate-source.txt fi - echo "}" >> /tmp/lightning-persist-crate-source.txt - cat /tmp/lightning-persist-crate-source.txt >> /tmp/lightning-crate-source.txt - rm /tmp/lightning-persist-crate-source.txt -fi + echo "}" >> /tmp/$1-crate-source.txt + cat /tmp/$1-crate-source.txt >> /tmp/crate-source.txt + rm /tmp/$1-crate-source.txt + if [ "$HOST_PLATFORM" = "host: x86_64-apple-darwin" ]; then + # OSX sed is for some reason not compatible with GNU sed + sed -E -i '' 's|#?'$1' = \{ .*|'$1' = \{ path = "'"$LIGHTNING_PATH"'/'$1'" '"$4"' }|' lightning-c-bindings/Cargo.toml + else + sed -E -i 's|#?'$1' = \{ .*|'$1' = \{ path = "'"$LIGHTNING_PATH"'/'$1'" '"$4"' }|' lightning-c-bindings/Cargo.toml + fi +} -cat /tmp/lightning-crate-source.txt | RUST_BACKTRACE=1 "$BIN" "$OUT/" "$OUT_TEMPL" "$OUT_F" "$OUT_CPP" +function drop_crate() { + if [ "$HOST_PLATFORM" = "host: x86_64-apple-darwin" ]; then + # OSX sed is for some reason not compatible with GNU sed + sed -E -i '' 's|'$1' = \{ (.*)|#'$1' = \{ \1|' lightning-c-bindings/Cargo.toml + else + sed -E -i 's|'$1' = \{ (.*)|#'$1' = \{ \1|' lightning-c-bindings/Cargo.toml + fi +} -if [ "$HOST_PLATFORM" = "host: x86_64-apple-darwin" ]; then - # OSX sed is for some reason not compatible with GNU sed - sed -i '' 's|lightning = { .*|lightning = { path = "'"$LIGHTNING_PATH/lightning"'", features = ['"$FEATURES"'] }|' lightning-c-bindings/Cargo.toml - sed -E -i '' 's|lightning-(.*) = \{ .*|lightning-\1 = \{ path = "'"$LIGHTNING_PATH"'/lightning-\1" }|' lightning-c-bindings/Cargo.toml +echo > /tmp/crate-source.txt +if [ "$2" = "true" ]; then + add_crate lightning lightning --features=allow_wallclock_use ', features = ["allow_wallclock_use"]' + add_crate "lightning-persister" "lightning_persister" else - sed -i 's|lightning = { .*|lightning = { path = "'"$LIGHTNING_PATH/lightning"'", features = ['"$FEATURES"'] }|' lightning-c-bindings/Cargo.toml - sed -E -i 's|lightning-(.*) = \{ .*|lightning-\1 = \{ path = "'"$LIGHTNING_PATH"'/lightning-\1" }|' lightning-c-bindings/Cargo.toml + add_crate lightning lightning + drop_crate "lightning-persister" fi +add_crate "lightning-invoice" "lightning_invoice" + +cat /tmp/crate-source.txt | RUST_BACKTRACE=1 "$BIN" "$OUT/" "$OUT_TEMPL" "$OUT_F" "$OUT_CPP" + +echo -e '#[no_mangle]' >> lightning-c-bindings/src/version.rs +echo -e 'pub extern "C" fn _ldk_get_compiled_version() -> crate::c_types::Str {' >> lightning-c-bindings/src/version.rs +echo -e '\t"'"$LIGHTNING_GIT"'".into()' >> lightning-c-bindings/src/version.rs +echo -e '}' >> lightning-c-bindings/src/version.rs +echo -e '#[no_mangle]' >> lightning-c-bindings/src/version.rs +echo -e 'pub extern "C" fn _ldk_c_bindings_get_compiled_version() -> crate::c_types::Str {' >> lightning-c-bindings/src/version.rs +echo -e '\t"'"$BINDINGS_GIT"'".into()' >> lightning-c-bindings/src/version.rs +echo -e '}' >> lightning-c-bindings/src/version.rs # Set path to include our rustc wrapper as well as cbindgen PATH="$(pwd)/deterministic-build-wrappers:$PATH:~/.cargo/bin" # Now cd to lightning-c-bindings, build the generated bindings, and call cbindgen to build a C header file cd lightning-c-bindings + # Remap paths so that our builds are deterministic 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" + +# If the C compiler supports it, also set -ffile-prefix-map +echo "int main() {}" > genbindings_path_map_test_file.c +clang -o /dev/null -ffile-prefix-map=$HOME/.cargo= genbindings_path_map_test_file.c > /dev/null 2>&1 && +# Now that we've done our last non-LTO build, turn on LTO in CFLAGS as well export CFLAGS="-ffile-prefix-map=$HOME/.cargo=" +rm genbindings_path_map_test_file.c cargo build cbindgen -v --config cbindgen.toml -o include/lightning.h >/dev/null 2>&1 @@ -103,18 +156,18 @@ if [ "$HOST_PLATFORM" = "host: x86_64-apple-darwin" ]; then # stdlib.h doesn't exist in clang's wasm sysroot, and cbindgen # doesn't actually use it anyway, so drop the import. - sed -i '' 's/#include //g' include/lightning.h + sed -i '' 's/#include /#include /g' include/lightning.h else sed -i 's/typedef LDKnative.*Import.*LDKnative.*;//g' include/lightning.h # stdlib.h doesn't exist in clang's wasm sysroot, and cbindgen # doesn't actually use it anyway, so drop the import. - sed -i 's/#include //g' include/lightning.h + sed -i 's/#include /#include /g' include/lightning.h fi # Finally, sanity-check the generated C and C++ bindings with demo apps: -LOCAL_CFLAGS="-Wall -Wno-nullability-completeness -pthread" +LOCAL_CFLAGS="-Wall -Wno-nullability-completeness -pthread -Iinclude/" # Naively run the C demo app: gcc $LOCAL_CFLAGS -Wall -g -pthread demo.c target/debug/libldk.a -ldl @@ -241,41 +294,43 @@ cargo clean --release CARGO_PROFILE_RELEASE_LTO=true cargo rustc -v --release -- -C lto clang++ $LOCAL_CFLAGS -std=c++11 -flto -O2 demo.cpp target/release/libldk.a -ldl +strip ./a.out +echo "C++ Bin size and runtime with only RL (LTO) optimized:" +ls -lha a.out +time ./a.out > /dev/null + if [ "$HOST_PLATFORM" != "host: x86_64-apple-darwin" -a "$CLANGPP" != "" ]; then # If we can use cross-language LTO, use it for building C dependencies (i.e. libsecp256k1) as well export CC="$CLANG" - export CFLAGS_wasm32_wasi="-target wasm32" + # The cc-rs crate tries to force -fdata-sections and -ffunction-sections on, which + # breaks -fembed-bitcode, so we turn off cc-rs' default flags and specify exactly + # what we want here. + export CFLAGS="$CFLAGS -fPIC -fembed-bitcode" + export CRATE_CC_NO_DEFAULTS=true fi if [ "$2" = "false" -a "$(rustc --print target-list | grep wasm32-wasi)" != "" ]; then # Test to see if clang supports wasm32 as a target (which is needed to build rust-secp256k1) echo "int main() {}" > genbindings_wasm_test_file.c - clang -nostdlib -o /dev/null --target=wasm32-wasi -Wl,--no-entry genbindings_wasm_test_file.c > /dev/null 2>&1 && - # And if it does, build a WASM binary without capturing errors - cargo rustc -v --target=wasm32-wasi -- -C embed-bitcode=yes && - # Now that we've done our last non-LTO build, turn on LTO in CFLAGS as well - export CFLAGS="$CFLAGS -flto" && - CARGO_PROFILE_RELEASE_LTO=true cargo rustc -v --release --target=wasm32-wasi -- -C opt-level=s -C linker-plugin-lto -C lto || - echo "Cannot build WASM lib as clang does not seem to support the wasm32-wasi target" + if clang -nostdlib -o /dev/null --target=wasm32-wasi -Wl,--no-entry genbindings_wasm_test_file.c > /dev/null 2>&1; then + # And if it does, build a WASM binary without capturing errors + export CFLAGS_wasm32_wasi="-target wasm32" + cargo rustc -v --target=wasm32-wasi + export CFLAGS_wasm32_wasi="-target wasm32 -Os" + 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 + else + echo "Cannot build WASM lib as clang does not seem to support the wasm32-wasi target" + fi rm genbindings_wasm_test_file.c fi -strip ./a.out -echo "C++ Bin size and runtime with only RL (LTO) optimized:" -ls -lha a.out -time ./a.out > /dev/null - if [ "$HOST_PLATFORM" != "host: x86_64-apple-darwin" -a "$CLANGPP" != "" ]; then # Finally, test cross-language LTO. Note that this will fail if rustc and clang++ # build against different versions of LLVM (eg when rustc is installed via rustup # or Ubuntu packages). This should work fine on Distros which do more involved # packaging than simply shipping the rustup binaries (eg Debian should Just Work # here). - # The cc-rs crate tries to force -fdata-sections and -ffunction-sections on, which - # breaks -fembed-bitcode, so we turn off cc-rs' default flags and specify exactly - # what we want here. - export CFLAGS="$CFLAGS -O3 -fPIC -fembed-bitcode" - export CRATE_CC_NO_DEFAULTS=true + export CFLAGS="$CFLAGS -O3" # Rust doesn't recognize CFLAGS changes, so we need to clean build artifacts cargo clean --release CARGO_PROFILE_RELEASE_LTO=true cargo rustc -v --release -- -C linker-plugin-lto -C lto -C link-arg=-fuse-ld=lld