[C#] Add `-unsafe` to mono-csc and build C library
[ldk-java] / genbindings.sh
1 #!/bin/bash
2 usage() {
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)"
10         exit 1
11 }
12 [ "$1" = "" ] && usage
13 [ "$3" != "true" -a "$3" != "false" -a "$3" != "leaks" ] && usage
14 [ "$4" != "true" -a "$4" != "false" ] && usage
15
16 set -e
17 set -x
18
19 function is_gnu_sed(){
20   sed --version >/dev/null 2>&1
21 }
22
23 if [ "$CC" = "" ]; then
24         CC=clang
25 fi
26
27 TARGET_STRING="$LDK_TARGET"
28 if [ "$TARGET_STRING" = "" ]; then
29         # We assume clang-style $CC --version here, but worst-case we just get an empty suffix
30         TARGET_STRING="$($CC --version | grep Target | awk '{ print $2 }')"
31 fi
32
33 IS_MAC=false
34 [ "$($CC --version | grep apple-darwin)" != "" ] && IS_MAC=true
35 IS_APPLE_CLANG=false
36 [ "$($CC --version | grep "Apple clang version")" != "" ] && IS_APPLE_CLANG=true
37
38 case "$TARGET_STRING" in
39         "x86_64-pc-linux"*)
40                 LDK_TARGET_SUFFIX="_Linux-amd64"
41                 LDK_JAR_TARGET=true
42                 ;;
43         "x86_64-apple-darwin"*)
44                 LDK_TARGET_SUFFIX="_MacOSX-x86_64"
45                 LDK_JAR_TARGET=true
46                 IS_MAC=true
47                 ;;
48         "aarch64-apple-darwin"*)
49                 LDK_TARGET_CPU="apple-a14"
50                 LDK_TARGET_SUFFIX="_MacOSX-aarch64"
51                 LDK_JAR_TARGET=true
52                 IS_MAC=true
53                 ;;
54         *)
55                 LDK_TARGET_SUFFIX="_${TARGET_STRING}"
56 esac
57 if [ "$LDK_TARGET_CPU" = "" ]; then
58         LDK_TARGET_CPU="sandybridge"
59 fi
60
61 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)="
62 [ "$IS_MAC" = "true" -a "$2" != "wasm" ] && COMMON_COMPILE="$COMMON_COMPILE --target=$TARGET_STRING -mcpu=$LDK_TARGET_CPU"
63
64 DEBUG_ARG="$3"
65 if [ "$3" = "leaks" ]; then
66         DEBUG_ARG="true"
67 fi
68
69 cp "$1/lightning-c-bindings/include/lightning.h" ./
70 if is_gnu_sed; then
71         sed -i "s/TransactionOutputs/C2Tuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZ/g" ./lightning.h
72 else
73         # OSX sed is for some reason not compatible with GNU sed
74         sed -i '' "s/TransactionOutputs/C2Tuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZ/g" ./lightning.h
75 fi
76 echo "#define LDKCVec_C2Tuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZZ LDKCVec_TransactionOutputsZ" > header.c
77 echo "#define CVec_C2Tuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZZ_free CVec_TransactionOutputsZ_free" >> header.c
78
79
80 if [ "$LDK_GARBAGECOLLECTED_GIT_OVERRIDE" = "" ]; then
81         export LDK_GARBAGECOLLECTED_GIT_OVERRIDE=$(git describe --tag --dirty)
82 fi
83 if [ "${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:0:1}" != "v" ]; then
84         echo "Version tag should start with a v" > /dev/stderr
85         exit 1
86 fi
87
88
89 if [ "$2" = "c_sharp" ]; then
90         echo "Creating C# bindings..."
91         mkdir -p c_sharp/src/org/ldk/{enums,structs,impl}
92         rm -f c_sharp/src/org/ldk/{enums,structs,impl}/*.cs
93         ./genbindings.py "./lightning.h" c_sharp/src/org/ldk/impl c_sharp/src/org/ldk c_sharp/ $DEBUG_ARG c_sharp $4 $TARGET_STRING
94         rm -f c_sharp/bindings.c
95         if [ "$3" = "true" ]; then
96                 echo "#define LDK_DEBUG_BUILD" > c_sharp/bindings.c
97         elif [ "$3" = "leaks" ]; then
98                 # For leak checking we use release libldk which doesn't expose
99                 # __unmangle_inner_ptr, but the C code expects to be able to call it.
100                 echo "#define __unmangle_inner_ptr(a) (a)" > c_sharp/bindings.c
101         fi
102         cat header.c >> c_sharp/bindings.c
103         cat header.c >> c_sharp/bindings.c
104         cat c_sharp/bindings.c.body >> c_sharp/bindings.c
105
106         IS_MAC=false
107         [ "$($CC --version | grep apple-darwin)" != "" ] && IS_MAC=true
108         IS_APPLE_CLANG=false
109         [ "$($CC --version | grep "Apple clang version")" != "" ] && IS_APPLE_CLANG=true
110
111         # Compiling C# bindings with Mono
112         MONO_COMPILE="-out:csharpldk.dll -langversion:3 -t:library -unsafe 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"
113         if [ "$3" = "true" ]; then
114                 mono-csc $MONO_COMPILE
115         else
116                 mono-csc -o $MONO_COMPILE
117         fi
118
119         echo "Building C# bindings..."
120         COMPILE="$COMMON_COMPILE -Isrc/main/jni -pthread -fPIC"
121         LINK="-ldl -shared"
122         [ "$IS_MAC" = "false" ] && LINK="$LINK -Wl,--no-undefined"
123         [ "$IS_MAC" = "true" ] && COMPILE="$COMPILE -mmacosx-version-min=10.9"
124         [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && LINK="$LINK -fuse-ld=lld"
125         [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && echo "WARNING: Need at least upstream clang 13!"
126         [ "$IS_MAC" = "false" -a "$3" != "false" ] && LINK="$LINK -Wl,-wrap,calloc -Wl,-wrap,realloc -Wl,-wrap,malloc -Wl,-wrap,free"
127
128         if [ "$3" = "true" ]; then
129                 $COMPILE $LINK -o libldkcsharp_debug$LDK_TARGET_SUFFIX.so -g -fsanitize=address -shared-libasan -rdynamic -I"$1"/lightning-c-bindings/include/ c_sharp/bindings.c "$1"/lightning-c-bindings/target/$LDK_TARGET/debug/libldk.a -lm
130         else
131                 $COMPILE -o bindings.o -c -flto -O3 -I"$1"/lightning-c-bindings/include/ c_sharp/bindings.c
132                 $COMPILE $LINK -o libldkcsharp_release$LDK_TARGET_SUFFIX.so -flto -O3 -Wl,--lto-O3 -Wl,-O3 -Wl,--version-script=c_sharp/libcode.version -I"$1"/lightning-c-bindings/include/ $2 bindings.o "$1"/lightning-c-bindings/target/$LDK_TARGET/release/libldk.a -lm
133                 [ "$IS_APPLE_CLANG" != "true" ] && llvm-strip libldkcsharp_release$LDK_TARGET_SUFFIX.so
134         fi
135 elif [ "$2" = "python" ]; then
136         echo "Creating Python bindings..."
137         mkdir -p python/src/{enums,structs,impl}
138         rm -f python/src/{enums,structs,impl}/*.py
139         ./genbindings.py "./lightning.h" python/src/impl python/src python/ $DEBUG_ARG python $4 $TARGET_STRING
140         rm -f python/bindings.c
141         if [ "$3" = "true" ]; then
142                 echo "#define LDK_DEBUG_BUILD" > python/bindings.c
143         elif [ "$3" = "leaks" ]; then
144                 # For leak checking we use release libldk which doesn't expose
145                 # __unmangle_inner_ptr, but the C code expects to be able to call it.
146                 echo "#define __unmangle_inner_ptr(a) (a)" > python/bindings.c
147         fi
148         echo "#define LDKCVec_C2Tuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZZ LDKCVec_TransactionOutputsZ" >> python/bindings.c
149         echo "#define CVec_C2Tuple_ThirtyTwoBytesCVec_C2Tuple_u32TxOutZZZZ_free CVec_TransactionOutputsZ_free" >> python/bindings.c
150         cat python/bindings.c.body >> python/bindings.c
151
152         IS_MAC=false
153         [ "$($CC --version | grep apple-darwin)" != "" ] && IS_MAC=true
154         IS_APPLE_CLANG=false
155         [ "$($CC --version | grep "Apple clang version")" != "" ] && IS_APPLE_CLANG=true
156
157         echo "Building Python bindings..."
158         COMPILE="$COMMON_COMPILE -Isrc/main/jni -pthread -fPIC"
159         LINK="-ldl -shared"
160         [ "$IS_MAC" = "false" ] && LINK="$LINK -Wl,--no-undefined"
161         [ "$IS_MAC" = "true" ] && COMPILE="$COMPILE -mmacosx-version-min=10.9"
162         [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && LINK="$LINK -fuse-ld=lld"
163         [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && echo "WARNING: Need at least upstream clang 13!"
164         [ "$IS_MAC" = "false" -a "$3" != "false" ] && LINK="$LINK -Wl,-wrap,calloc -Wl,-wrap,realloc -Wl,-wrap,malloc -Wl,-wrap,free"
165
166         exit 0 # Sadly compilation doesn't currently work
167         if [ "$3" = "true" ]; then
168                 $COMPILE $LINK -o liblightningpython_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
169         else
170                 $COMPILE -o bindings.o -c -flto -O3 -I"$1"/lightning-c-bindings/include/ $2 c_sharp/bindings.c
171                 $COMPILE $LINK -o liblightningpython_release$LDK_TARGET_SUFFIX.so -Wl,--version-script=python/libcode.version -flto -O3 -Wl,--lto-O3 -Wl,-O3 -I"$1"/lightning-c-bindings/include/ $2 bindings.o "$1"/lightning-c-bindings/target/$LDK_TARGET/release/libldk.a -lm
172                 [ "$IS_APPLE_CLANG" != "true" ] && llvm-strip liblightningpython_release$LDK_TARGET_SUFFIX.so
173         fi
174 elif [ "$2" = "wasm" ]; then
175         echo "Creating TS bindings..."
176         mkdir -p ts/{enums,structs}
177         rm -f ts/{enums,structs,}/*.{mjs,mts,mts.part}
178         if [ "$4" = "false" ]; then
179                 ./genbindings.py "./lightning.h" ts ts ts $DEBUG_ARG typescript node wasm
180         else
181                 ./genbindings.py "./lightning.h" ts ts ts $DEBUG_ARG typescript browser wasm
182         fi
183         rm -f ts/bindings.c
184         sed -i 's/^  "version": .*/  "version": "'${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}'",/g' ts/package.json
185         sed -i 's/^  "version": .*/  "version": "'${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}'",/g' node-net/package.json
186         sed -i 's/^    "lightningdevkit": .*/    "lightningdevkit": "'${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}'"/g' node-net/package.json
187         if [ "$3" = "true" ]; then
188                 echo "#define LDK_DEBUG_BUILD" > ts/bindings.c
189         elif [ "$3" = "leaks" ]; then
190                 # For leak checking we use release libldk which doesn't expose
191                 # __unmangle_inner_ptr, but the C code expects to be able to call it.
192                 echo "#define __unmangle_inner_ptr(a) (a)" > ts/bindings.c
193         fi
194         cat header.c >> ts/bindings.c
195         cat ts/bindings.c.body >> ts/bindings.c
196
197         echo "Building TS bindings..."
198         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"
199         # We only need malloc and assert/abort, but for now just use WASI for those:
200         EXTRA_LINK=/usr/lib/wasm32-wasi/libc.a
201         [ "$3" != "false" ] && COMPILE="$COMPILE -Wl,-wrap,calloc -Wl,-wrap,realloc -Wl,-wrap,reallocarray -Wl,-wrap,malloc -Wl,-wrap,aligned_alloc -Wl,-wrap,free"
202         if [ "$3" = "true" ]; then
203                 WASM_FILE=liblightningjs_debug.wasm
204                 $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
205         else
206                 WASM_FILE=liblightningjs_release.wasm
207                 $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
208         fi
209
210         if [ -x "$(which tsc)" ]; then
211                 cd ts
212                 for F in structs/*; do
213                         cat imports.mts.part | grep -v " $(basename -s .mts $F)[ ,]" | cat - $F > $F.tmp
214                         mv $F.tmp $F
215                 done
216                 rm imports.mts.part
217                 tsc --types node --typeRoots .
218                 cp ../$WASM_FILE liblightningjs.wasm
219                 cp ../README.md README.md
220                 cd ../node-net
221                 tsc --types node --typeRoots .
222                 echo Ready to publish!
223                 if [ -x "$(which node)" ]; then
224                         NODE_V="$(node --version)"
225                         if [ "${NODE_V:1:2}" -gt 14 ]; then
226                                 cd ../ts
227                                 node --stack_trace_limit=200 --trace-uncaught test/node.mjs
228                                 cd ../node-net
229                                 node --stack_trace_limit=200 --trace-uncaught test/test.mjs
230                         fi
231                 fi
232         fi
233 else
234         if is_gnu_sed; then
235                 sed -i "s/^    <version>.*<\/version>/    <version>${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}<\/version>/g" pom.xml
236         else
237           # OSX sed is for some reason not compatible with GNU sed
238                 sed -i '' "s/^    <version>.*<\/version>/    <version>${LDK_GARBAGECOLLECTED_GIT_OVERRIDE:1:100}<\/version>/g" pom.xml
239         fi
240
241         echo "Creating Java bindings..."
242         mkdir -p src/main/java/org/ldk/{enums,structs}
243         rm -f src/main/java/org/ldk/{enums,structs}/*.java
244         rm -f src/main/jni/*.h
245         if [ "$4" = "true" ]; then
246                 ./genbindings.py "./lightning.h" src/main/java/org/ldk/impl src/main/java/org/ldk src/main/jni/ $DEBUG_ARG android $4 $TARGET_STRING
247         else
248                 ./genbindings.py "./lightning.h" src/main/java/org/ldk/impl src/main/java/org/ldk src/main/jni/ $DEBUG_ARG java $4 $TARGET_STRING
249         fi
250         rm -f src/main/jni/bindings.c
251         if [ "$3" = "true" ]; then
252                 echo "#define LDK_DEBUG_BUILD" > src/main/jni/bindings.c
253         elif [ "$3" = "leaks" ]; then
254                 # For leak checking we use release libldk which doesn't expose
255                 # __unmangle_inner_ptr, but the C code expects to be able to call it.
256                 echo "#define __unmangle_inner_ptr(a) (a)" > src/main/jni/bindings.c
257         fi
258         cat header.c >> src/main/jni/bindings.c
259         cat header.c >> src/main/jni/bindings.c
260         cat src/main/jni/bindings.c.body >> src/main/jni/bindings.c
261         javac -h src/main/jni src/main/java/org/ldk/enums/*.java src/main/java/org/ldk/impl/*.java
262         rm src/main/java/org/ldk/enums/*.class src/main/java/org/ldk/impl/bindings*.class
263
264         echo "Building Java bindings..."
265         COMPILE="$COMMON_COMPILE -Isrc/main/jni -pthread -fPIC"
266         LINK="-ldl -shared"
267         [ "$IS_MAC" = "false" ] && LINK="$LINK -Wl,--no-undefined"
268         [ "$IS_MAC" = "true" ] && COMPILE="$COMPILE -mmacosx-version-min=10.9"
269         [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && LINK="$LINK -fuse-ld=lld"
270         [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && echo "WARNING: Need at least upstream clang 13!"
271         [ "$IS_MAC" = "false" -a "$3" != "false" ] && LINK="$LINK -Wl,-wrap,calloc -Wl,-wrap,realloc -Wl,-wrap,malloc -Wl,-wrap,free"
272         if [ "$3" = "true" ]; then
273                 $COMPILE $LINK -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
274         else
275                 [ "$IS_MAC" = "false" ] && LINK="$LINK -Wl,--no-undefined -flto -Wl,-O3 -Wl,--lto-O3"
276                 [ "$IS_MAC" = "false" ] && COMPILE="$COMPILE -flto"
277                 [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && LINK="$LINK -flto -Wl,-O3 -Wl,--lto-O3"
278                 [ "$IS_MAC" = "true" -a "$IS_APPLE_CLANG" = "false" ] && COMPILE="$COMPILE -flto"
279                 LDK_LIB="$1"/lightning-c-bindings/target/$LDK_TARGET/release/libldk.a
280                 if [ "$IS_MAC" = "false" -a "$4" = "false" ]; then
281                         LINK="$LINK -Wl,--version-script=libcode.version -fuse-ld=lld"
282                 fi
283                 $COMPILE -o bindings.o -c -O3 -I"$1"/lightning-c-bindings/include/ $2 src/main/jni/bindings.c
284                 $COMPILE $LINK -o liblightningjni_release$LDK_TARGET_SUFFIX.so -O3 -I"$1"/lightning-c-bindings/include/ $2 bindings.o $LDK_LIB -lm
285                 [ "$IS_APPLE_CLANG" != "true" ] && llvm-strip liblightningjni_release$LDK_TARGET_SUFFIX.so
286                 if [ "$LDK_JAR_TARGET" = "true" ]; then
287                         # Copy to JNI native directory for inclusion in JARs
288                         mkdir -p src/main/resources/
289                         cp liblightningjni_release$LDK_TARGET_SUFFIX.so src/main/resources/liblightningjni$LDK_TARGET_SUFFIX.nativelib
290                 fi
291         fi
292 fi