3 echo "USAGE: path/to/ldk-c-bindings [wasm|\"JNI_CFLAGS\"] debug android_web"
4 echo "For JNI_CFLAGS you probably want -I/usr/lib/jvm/java-11-openjdk-amd64/include/ -I/usr/lib/jvm/java-11-openjdk-amd64/include/linux/"
5 echo "If JNI_CFLAGS is instead set to wasm, we build for wasm/TypeScript instead of Java"
6 echo "debug should either be true, false, or leaks"
7 echo "debug of leaks turns on leak tracking on an optimized release bianry"
8 echo "android_web should either be true or false and indicates if we build for android (Java) or web (WASM)"
9 echo "Note that web currently generates the same results as !web (ie Node.JS)"
12 [ "$1" = "" ] && usage
13 [ "$3" != "true" -a "$3" != "false" -a "$3" != "leaks" ] && usage
14 [ "$4" != "true" -a "$4" != "false" ] && usage
19 function is_gnu_sed(){
20 sed --version >/dev/null 2>&1
23 if [ "$CC" != "" ]; then
24 COMMON_COMPILE="$CC -std=c11 -Wall -Wextra -Wno-unused-parameter -Wno-ignored-qualifiers -Wno-unused-function -Wno-nullability-completeness -Wno-pointer-sign -Wdate-time -ffile-prefix-map=$(pwd)="
27 COMMON_COMPILE="clang -std=c11 -Wall -Wextra -Wno-unused-parameter -Wno-ignored-qualifiers -Wno-unused-function -Wno-nullability-completeness -Wno-pointer-sign -Wdate-time -ffile-prefix-map=$(pwd)="
31 if [ "$3" = "leaks" ]; then
35 cp "$1/lightning-c-bindings/include/lightning.h" ./
37 sed -i "s/TransactionOutputs/C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ/g" ./lightning.h
39 # OSX sed is for some reason not compatible with GNU sed
40 sed -i '' "s/TransactionOutputs/C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZ/g" ./lightning.h
43 if [ "$LDK_GARBAGECOLLECTED_GIT_OVERRIDE" = "" ]; then
44 export LDK_GARBAGECOLLECTED_GIT_OVERRIDE=$(git describe --tag --dirty)
46 if [ "${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:0:1}" != "v" ]; then
47 echo "Version tag should start with a v" > /dev/stderr
52 if [ "$2" = "c_sharp" ]; then
53 TARGET_STRING="$LDK_TARGET"
54 if [ "$TARGET_STRING" = "" ]; then
55 # We assume clang-style $CC --version here, but worst-case we just get an empty suffix
56 TARGET_STRING="$($CC --version | grep Target | awk '{ print $2 }')"
58 case "$TARGET_STRING" in
60 LDK_TARGET_SUFFIX="_Linux-amd64"
63 "x86_64-apple-darwin"*)
64 LDK_TARGET_SUFFIX="_MacOSX-x86_64"
67 "aarch64-apple-darwin"*)
68 LDK_TARGET_CPU="apple-a14"
69 LDK_TARGET_SUFFIX="_MacOSX-aarch64"
73 LDK_TARGET_SUFFIX="_${TARGET_STRING}"
75 if [ "$LDK_TARGET_CPU" = "" ]; then
76 LDK_TARGET_CPU="sandybridge"
79 echo "Creating C# bindings..."
80 mkdir -p c_sharp/src/org/ldk/{enums,structs,impl}
81 rm -f c_sharp/src/org/ldk/{enums,structs,impl}/*.cs
82 ./genbindings.py "./lightning.h" c_sharp/src/org/ldk/impl c_sharp/src/org/ldk c_sharp/ $DEBUG_ARG c_sharp $4
83 rm -f c_sharp/bindings.c
84 if [ "$3" = "true" ]; then
85 echo "#define LDK_DEBUG_BUILD" > c_sharp/bindings.c
86 elif [ "$3" = "leaks" ]; then
87 # For leak checking we use release libldk which doesn't expose
88 # __unmangle_inner_ptr, but the C code expects to be able to call it.
89 echo "#define __unmangle_inner_ptr(a) (a)" > c_sharp/bindings.c
91 echo "#define LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZZ LDKCVec_TransactionOutputsZ" >> c_sharp/bindings.c
92 echo "#define CVec_C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZZ_free CVec_TransactionOutputsZ_free" >> c_sharp/bindings.c
93 cat c_sharp/bindings.c.body >> c_sharp/bindings.c
96 [ "$($CC --version | grep apple-darwin)" != "" ] && IS_MAC=true
98 [ "$($CC --version | grep "Apple clang version")" != "" ] && IS_APPLE_CLANG=true
100 # Compiling C# bindings with Mono
101 MONO_COMPILE="-out:csharpldk.dll -langversion:3 -t:library c_sharp/src/org/ldk/enums/*.cs c_sharp/src/org/ldk/impl/*.cs c_sharp/src/org/ldk/util/*.cs c_sharp/src/org/ldk/structs/*.cs"
102 if [ "$3" = "true" ]; then
103 mono-csc $MONO_COMPILE
105 mono-csc -o $MONO_COMPILE
108 mv ./-out:csharpldk.dll csharpldk.dll # Mono is braindead, apparently
110 echo "Building C# bindings..."
111 COMPILE="$COMMON_COMPILE -mcpu=$LDK_TARGET_CPU -Isrc/main/jni -pthread -ldl -shared -fPIC"
112 [ "$IS_MAC" = "false" ] && COMPILE="$COMPILE -Wl,--no-undefined"
113 [ "$IS_MAC" = "true" ] && COMPILE="$COMPILE -mmacosx-version-min=10.9"
114 [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && COMPILE="$COMPILE -fuse-ld=lld"
115 [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && echo "WARNING: Need at least upstream clang 13!"
116 [ "$IS_MAC" = "false" -a "$3" != "false" ] && COMPILE="$COMPILE -Wl,-wrap,calloc -Wl,-wrap,realloc -Wl,-wrap,malloc -Wl,-wrap,free"
118 exit 0 # Sadly compilation doesn't currently work
119 if [ "$3" = "true" ]; then
120 $COMPILE -o liblightningjni_debug$LDK_TARGET_SUFFIX.so -g -fsanitize=address -shared-libasan -rdynamic -I"$1"/lightning-c-bindings/include/ $2 c_sharp/bindings.c "$1"/lightning-c-bindings/target/$LDK_TARGET/debug/libldk.a -lm
122 $COMPILE -o liblightningjni_release$LDK_TARGET_SUFFIX.so -s -flto -O3 -Wl,--version-script=c_sharp/libcode.version -I"$1"/lightning-c-bindings/include/ $2 c_sharp/bindings.c "$1"/lightning-c-bindings/target/$LDK_TARGET/release/libldk.a -lm
124 elif [ "$2" = "wasm" ]; then
125 echo "Creating TS bindings..."
126 mkdir -p ts/{enums,structs}
127 rm -f ts/{enums,structs,}/*.{mjs,mts,mts.part}
128 if [ "$4" = "false" ]; then
129 ./genbindings.py "./lightning.h" ts ts ts $DEBUG_ARG typescript node
131 ./genbindings.py "./lightning.h" ts ts ts $DEBUG_ARG typescript browser
134 sed -i 's/^ "version": .*/ "version": "'${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}'",/g' ts/package.json
135 sed -i 's/^ "version": .*/ "version": "'${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}'",/g' node-net/package.json
136 sed -i 's/^ "lightningdevkit": .*/ "lightningdevkit": "'${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}'"/g' node-net/package.json
137 if [ "$3" = "true" ]; then
138 echo "#define LDK_DEBUG_BUILD" > ts/bindings.c
139 elif [ "$3" = "leaks" ]; then
140 # For leak checking we use release libldk which doesn't expose
141 # __unmangle_inner_ptr, but the C code expects to be able to call it.
142 echo "#define __unmangle_inner_ptr(a) (a)" > ts/bindings.c
144 echo "#define LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZZ LDKCVec_TransactionOutputsZ" >> ts/bindings.c
145 echo "#define CVec_C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZZ_free CVec_TransactionOutputsZ_free" >> ts/bindings.c
146 cat ts/bindings.c.body >> ts/bindings.c
148 echo "Building TS bindings..."
149 COMPILE="$COMMON_COMPILE -flto -Wl,--no-entry -nostdlib --target=wasm32-wasi -Wl,-z -Wl,stack-size=$((8*1024*1024)) -Wl,--initial-memory=$((16*1024*1024)) -Wl,--max-memory=$((1024*1024*1024)) -Wl,--global-base=4096"
150 # We only need malloc and assert/abort, but for now just use WASI for those:
151 EXTRA_LINK=/usr/lib/wasm32-wasi/libc.a
152 [ "$3" != "false" ] && COMPILE="$COMPILE -Wl,-wrap,calloc -Wl,-wrap,realloc -Wl,-wrap,reallocarray -Wl,-wrap,malloc -Wl,-wrap,aligned_alloc -Wl,-wrap,free"
153 if [ "$3" = "true" ]; then
154 WASM_FILE=liblightningjs_debug.wasm
155 $COMPILE -o liblightningjs_debug.wasm -g -O1 -I"$1"/lightning-c-bindings/include/ ts/bindings.c "$1"/lightning-c-bindings/target/wasm32-wasi/debug/libldk.a $EXTRA_LINK
157 WASM_FILE=liblightningjs_release.wasm
158 $COMPILE -o liblightningjs_release.wasm -s -Oz -I"$1"/lightning-c-bindings/include/ ts/bindings.c "$1"/lightning-c-bindings/target/wasm32-wasi/release/libldk.a $EXTRA_LINK
161 if [ -x "$(which tsc)" ]; then
163 for F in structs/*; do
164 cat imports.mts.part | grep -v " $(basename -s .mts $F)[ ,]" | cat - $F > $F.tmp
168 tsc --types node --typeRoots .
169 cp ../$WASM_FILE liblightningjs.wasm
170 cp ../README.md README.md
172 tsc --types node --typeRoots .
173 echo Ready to publish!
174 if [ -x "$(which node)" ]; then
175 NODE_V="$(node --version)"
176 if [ "${NODE_V:1:2}" -gt 14 ]; then
178 node --stack_trace_limit=200 --trace-uncaught test/node.mjs
180 node --stack_trace_limit=200 --trace-uncaught test/test.mjs
185 TARGET_STRING="$LDK_TARGET"
186 if [ "$TARGET_STRING" = "" ]; then
187 # We assume clang-style $CC --version here, but worst-case we just get an empty suffix
188 TARGET_STRING="$($CC --version | grep Target | awk '{ print $2 }')"
190 case "$TARGET_STRING" in
192 LDK_TARGET_SUFFIX="_Linux-amd64"
195 "x86_64-apple-darwin"*)
196 LDK_TARGET_SUFFIX="_MacOSX-x86_64"
199 "aarch64-apple-darwin"*)
200 LDK_TARGET_CPU="apple-a14"
201 LDK_TARGET_SUFFIX="_MacOSX-aarch64"
205 LDK_TARGET_SUFFIX="_${TARGET_STRING}"
207 if [ "$LDK_TARGET_CPU" = "" ]; then
208 LDK_TARGET_CPU="sandybridge"
212 sed -i "s/^ <version>.*<\/version>/ <version>${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}<\/version>/g" pom.xml
214 # OSX sed is for some reason not compatible with GNU sed
215 sed -i '' "s/^ <version>.*<\/version>/ <version>${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}<\/version>/g" pom.xml
218 echo "Creating Java bindings..."
219 mkdir -p src/main/java/org/ldk/{enums,structs}
220 rm -f src/main/java/org/ldk/{enums,structs}/*.java
221 rm -f src/main/jni/*.h
222 if [ "$4" = "true" ]; then
223 ./genbindings.py "./lightning.h" src/main/java/org/ldk/impl src/main/java/org/ldk src/main/jni/ $DEBUG_ARG android $4
225 ./genbindings.py "./lightning.h" src/main/java/org/ldk/impl src/main/java/org/ldk src/main/jni/ $DEBUG_ARG java $4
227 rm -f src/main/jni/bindings.c
228 if [ "$3" = "true" ]; then
229 echo "#define LDK_DEBUG_BUILD" > src/main/jni/bindings.c
230 elif [ "$3" = "leaks" ]; then
231 # For leak checking we use release libldk which doesn't expose
232 # __unmangle_inner_ptr, but the C code expects to be able to call it.
233 echo "#define __unmangle_inner_ptr(a) (a)" > src/main/jni/bindings.c
235 echo "#define LDKCVec_C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZZ LDKCVec_TransactionOutputsZ" >> src/main/jni/bindings.c
236 echo "#define CVec_C2Tuple_TxidCVec_C2Tuple_u32TxOutZZZZ_free CVec_TransactionOutputsZ_free" >> src/main/jni/bindings.c
237 cat src/main/jni/bindings.c.body >> src/main/jni/bindings.c
238 javac -h src/main/jni src/main/java/org/ldk/enums/*.java src/main/java/org/ldk/impl/*.java
239 rm src/main/java/org/ldk/enums/*.class src/main/java/org/ldk/impl/bindings*.class
242 [ "$($CC --version | grep apple-darwin)" != "" ] && IS_MAC=true
244 [ "$($CC --version | grep "Apple clang version")" != "" ] && IS_APPLE_CLANG=true
246 echo "Building Java bindings..."
247 COMPILE="$COMMON_COMPILE -mcpu=$LDK_TARGET_CPU -Isrc/main/jni -pthread -ldl -shared -fPIC"
248 [ "$IS_MAC" = "false" ] && COMPILE="$COMPILE -Wl,--no-undefined"
249 [ "$IS_MAC" = "true" ] && COMPILE="$COMPILE -mmacosx-version-min=10.9"
250 [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && COMPILE="$COMPILE -fuse-ld=lld"
251 [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && echo "WARNING: Need at least upstream clang 13!"
252 [ "$IS_MAC" = "false" -a "$3" != "false" ] && COMPILE="$COMPILE -Wl,-wrap,calloc -Wl,-wrap,realloc -Wl,-wrap,malloc -Wl,-wrap,free"
253 if [ "$3" = "true" ]; then
254 $COMPILE -o liblightningjni_debug$LDK_TARGET_SUFFIX.so -g -fsanitize=address -shared-libasan -rdynamic -I"$1"/lightning-c-bindings/include/ $2 src/main/jni/bindings.c "$1"/lightning-c-bindings/target/$LDK_TARGET/debug/libldk.a -lm
256 LDK_LIB="$1"/lightning-c-bindings/target/$LDK_TARGET/release/libldk.a
257 if [ "$IS_MAC" = "false" -a "$4" = "false" ]; then
258 COMPILE="$COMPILE -Wl,--version-script=libcode.version -fuse-ld=lld"
259 # __cxa_thread_atexit_impl is used to more effeciently cleanup per-thread local storage by rust libstd.
260 # However, it is not available on glibc versions 2.17 or earlier, and rust libstd has a null-check and
261 # fallback in case it is missing.
262 # Because it is weak-linked on the rust side, we should be able to simply define it
263 # explicitly, forcing rust to use the fallback. However, for some reason involving ancient
264 # dark magic and haunted code segments, overriding the weak symbol only impacts sites which
265 # *call* the symbol in question, not sites which *compare with* the symbol in question.
266 # This means that the NULL check in rust's libstd will always think the function is
267 # callable while the function which is called ends up being NULL (leading to a jmp to the
268 # zero page and a quick SEGFAULT).
269 # This issue persists not only with directly providing a symbol, but also ld.lld's -wrap
270 # and --defsym arguments.
271 # In smaller programs, it appears to be possible to work around this with -Bsymbolic and
272 # -nostdlib, however when applied the full-sized JNI library here it no longer works.
273 # After exhausting nearly every flag documented in lld, the only reliable method appears
274 # to be editing the LDK binary. Luckily, LLVM's tooling makes this rather easy as we can
275 # disassemble it into very readable code, edit it, and then reassemble it.
276 # Note that if we do so we don't have to bother overriding the actual call, LLVM should
277 # optimize it away, which also provides a good check that there isn't anything actually
278 # relying on it elsewhere.
279 [ ! -f "$1"/lightning-c-bindings/target/$LDK_TARGET/release/libldk.a ] && exit 1
280 if [ "$(ar t "$1"/lightning-c-bindings/target/$LDK_TARGET/release/libldk.a | grep -v "\.o$" || echo)" != "" ]; then
281 echo "Archive contained non-object files!"
284 if [ "$(ar t "$1"/lightning-c-bindings/target/$LDK_TARGET/release/libldk.a | grep ldk.*-cgu.*.rcgu.o | wc -l)" != "1" ]; then
285 echo "Archive contained more than one LDK object file"
290 ar x --output=tmp "$1"/lightning-c-bindings/target/$LDK_TARGET/release/libldk.a
292 llvm-dis ldk*-cgu.*.rcgu.o
293 sed -i 's/br i1 icmp eq (i8\* @__cxa_thread_atexit_impl, i8\* null)/br i1 icmp eq (i8* null, i8* null)/g' ldk*-cgu.*.rcgu.o.ll
294 llvm-as ldk*-cgu.*.rcgu.o.ll -o ./libldk.bc
297 LDK_LIB="tmp/libldk.bc tmp/libldk.a"
299 $COMPILE -o liblightningjni_release$LDK_TARGET_SUFFIX.so -s -flto -O3 -I"$1"/lightning-c-bindings/include/ $2 src/main/jni/bindings.c $LDK_LIB -lm
300 if [ "$IS_MAC" = "false" -a "$4" = "false" ]; then
301 GLIBC_SYMBS="$(objdump -T liblightningjni_release$LDK_TARGET_SUFFIX.so | grep GLIBC_ | grep -v "GLIBC_2\.2\." | grep -v "GLIBC_2\.3\(\.\| \)" | grep -v "GLIBC_2.\(14\|17\) " || echo)"
302 if [ "$GLIBC_SYMBS" != "" ]; then
303 echo "Unexpected glibc version dependency! Some users need glibc 2.17 support, symbols for newer glibcs cannot be included."
307 REALLOC_ARRAY_SYMBS="$(objdump -T liblightningjni_release$LDK_TARGET_SUFFIX.so | grep reallocarray || echo)"
308 if [ "$REALLOC_ARRAY_SYMBS" != "" ]; then
309 echo "Unexpected reallocarray dependency!"
313 if [ "$LDK_JAR_TARGET" = "true" ]; then
314 # Copy to JNI native directory for inclusion in JARs
315 mkdir -p src/main/resources/
316 cp liblightningjni_release$LDK_TARGET_SUFFIX.so src/main/resources/liblightningjni$LDK_TARGET_SUFFIX.nativelib