initiate language-dependent type mappings from C
[ldk-java] / java_strings.py
1 from bindingstypes import *
2
3 class Consts:
4     def __init__(self, DEBUG):
5
6         self.c_type_map = dict(
7             byte = ['byte'],
8         )
9
10         self.common_base = """package org.ldk.structs;
11 import java.util.LinkedList;
12 class CommonBase {
13         long ptr;
14         LinkedList<Object> ptrs_to = new LinkedList();
15         protected CommonBase(long ptr) { this.ptr = ptr; }
16         public long _test_only_get_ptr() { return this.ptr; }
17 }
18 """
19
20         self.c_file_pfx = """#include \"org_ldk_impl_bindings.h\"
21 #include <rust_types.h>
22 #include <lightning.h>
23 #include <string.h>
24 #include <stdatomic.h>
25 #include <stdlib.h>
26 """
27
28         if not DEBUG:
29             self.c_file_pfx = self.c_file_pfx + """#define MALLOC(a, _) malloc(a)
30 #define FREE(p) if ((long)(p) > 1024) { free(p); }
31 #define DO_ASSERT(a) (void)(a)
32 #define CHECK(a)
33 """
34         else:
35             self.c_file_pfx = self.c_file_pfx + """#include <assert.h>
36 // Always run a, then assert it is true:
37 #define DO_ASSERT(a) do { bool _assert_val = (a); assert(_assert_val); } while(0)
38 // Assert a is true or do nothing
39 #define CHECK(a) DO_ASSERT(a)
40
41 // Running a leak check across all the allocations and frees of the JDK is a mess,
42 // so instead we implement our own naive leak checker here, relying on the -wrap
43 // linker option to wrap malloc/calloc/realloc/free, tracking everyhing allocated
44 // and free'd in Rust or C across the generated bindings shared library.
45 #include <threads.h>
46 #include <execinfo.h>
47 #include <unistd.h>
48 static mtx_t allocation_mtx;
49
50 void __attribute__((constructor)) init_mtx() {
51         DO_ASSERT(mtx_init(&allocation_mtx, mtx_plain) == thrd_success);
52 }
53
54 #define BT_MAX 128
55 typedef struct allocation {
56         struct allocation* next;
57         void* ptr;
58         const char* struct_name;
59         void* bt[BT_MAX];
60         int bt_len;
61 } allocation;
62 static allocation* allocation_ll = NULL;
63
64 void* __real_malloc(size_t len);
65 void* __real_calloc(size_t nmemb, size_t len);
66 static void new_allocation(void* res, const char* struct_name) {
67         allocation* new_alloc = __real_malloc(sizeof(allocation));
68         new_alloc->ptr = res;
69         new_alloc->struct_name = struct_name;
70         new_alloc->bt_len = backtrace(new_alloc->bt, BT_MAX);
71         DO_ASSERT(mtx_lock(&allocation_mtx) == thrd_success);
72         new_alloc->next = allocation_ll;
73         allocation_ll = new_alloc;
74         DO_ASSERT(mtx_unlock(&allocation_mtx) == thrd_success);
75 }
76 static void* MALLOC(size_t len, const char* struct_name) {
77         void* res = __real_malloc(len);
78         new_allocation(res, struct_name);
79         return res;
80 }
81 void __real_free(void* ptr);
82 static void alloc_freed(void* ptr) {
83         allocation* p = NULL;
84         DO_ASSERT(mtx_lock(&allocation_mtx) == thrd_success);
85         allocation* it = allocation_ll;
86         while (it->ptr != ptr) {
87                 p = it; it = it->next;
88                 if (it == NULL) {
89                         fprintf(stderr, "Tried to free unknown pointer %p at:\\n", ptr);
90                         void* bt[BT_MAX];
91                         int bt_len = backtrace(bt, BT_MAX);
92                         backtrace_symbols_fd(bt, bt_len, STDERR_FILENO);
93                         fprintf(stderr, "\\n\\n");
94                         DO_ASSERT(mtx_unlock(&allocation_mtx) == thrd_success);
95                         return; // addrsan should catch malloc-unknown and print more info than we have
96                 }
97         }
98         if (p) { p->next = it->next; } else { allocation_ll = it->next; }
99         DO_ASSERT(mtx_unlock(&allocation_mtx) == thrd_success);
100         DO_ASSERT(it->ptr == ptr);
101         __real_free(it);
102 }
103 static void FREE(void* ptr) {
104         if ((long)ptr < 1024) return; // Rust loves to create pointers to the NULL page for dummys
105         alloc_freed(ptr);
106         __real_free(ptr);
107 }
108
109 void* __wrap_malloc(size_t len) {
110         void* res = __real_malloc(len);
111         new_allocation(res, "malloc call");
112         return res;
113 }
114 void* __wrap_calloc(size_t nmemb, size_t len) {
115         void* res = __real_calloc(nmemb, len);
116         new_allocation(res, "calloc call");
117         return res;
118 }
119 void __wrap_free(void* ptr) {
120         if (ptr == NULL) return;
121         alloc_freed(ptr);
122         __real_free(ptr);
123 }
124
125 void* __real_realloc(void* ptr, size_t newlen);
126 void* __wrap_realloc(void* ptr, size_t len) {
127         if (ptr != NULL) alloc_freed(ptr);
128         void* res = __real_realloc(ptr, len);
129         new_allocation(res, "realloc call");
130         return res;
131 }
132 void __wrap_reallocarray(void* ptr, size_t new_sz) {
133         // Rust doesn't seem to use reallocarray currently
134         DO_ASSERT(false);
135 }
136
137 void __attribute__((destructor)) check_leaks() {
138         for (allocation* a = allocation_ll; a != NULL; a = a->next) {
139                 fprintf(stderr, "%s %p remains:\\n", a->struct_name, a->ptr);
140                 backtrace_symbols_fd(a->bt, a->bt_len, STDERR_FILENO);
141                 fprintf(stderr, "\\n\\n");
142         }
143         DO_ASSERT(allocation_ll == NULL);
144 }
145 """
146         self.c_file_pfx = self.c_file_pfx + """
147 static jmethodID ordinal_meth = NULL;
148 static jmethodID slicedef_meth = NULL;
149 static jclass slicedef_cls = NULL;
150 JNIEXPORT void Java_org_ldk_impl_bindings_init(JNIEnv * env, jclass _b, jclass enum_class, jclass slicedef_class) {
151         ordinal_meth = (*env)->GetMethodID(env, enum_class, "ordinal", "()I");
152         CHECK(ordinal_meth != NULL);
153         slicedef_meth = (*env)->GetMethodID(env, slicedef_class, "<init>", "(JJJ)V");
154         CHECK(slicedef_meth != NULL);
155         slicedef_cls = (*env)->NewGlobalRef(env, slicedef_class);
156         CHECK(slicedef_cls != NULL);
157 }
158
159 JNIEXPORT jboolean JNICALL Java_org_ldk_impl_bindings_deref_1bool (JNIEnv * env, jclass _a, jlong ptr) {
160         return *((bool*)ptr);
161 }
162 JNIEXPORT jlong JNICALL Java_org_ldk_impl_bindings_deref_1long (JNIEnv * env, jclass _a, jlong ptr) {
163         return *((long*)ptr);
164 }
165 JNIEXPORT void JNICALL Java_org_ldk_impl_bindings_free_1heap_1ptr (JNIEnv * env, jclass _a, jlong ptr) {
166         FREE((void*)ptr);
167 }
168 JNIEXPORT jbyteArray JNICALL Java_org_ldk_impl_bindings_read_1bytes (JNIEnv * env, jclass _b, jlong ptr, jlong len) {
169         jbyteArray ret_arr = (*env)->NewByteArray(env, len);
170         (*env)->SetByteArrayRegion(env, ret_arr, 0, len, (unsigned char*)ptr);
171         return ret_arr;
172 }
173 JNIEXPORT jbyteArray JNICALL Java_org_ldk_impl_bindings_get_1u8_1slice_1bytes (JNIEnv * env, jclass _b, jlong slice_ptr) {
174         LDKu8slice *slice = (LDKu8slice*)slice_ptr;
175         jbyteArray ret_arr = (*env)->NewByteArray(env, slice->datalen);
176         (*env)->SetByteArrayRegion(env, ret_arr, 0, slice->datalen, slice->data);
177         return ret_arr;
178 }
179 JNIEXPORT long JNICALL Java_org_ldk_impl_bindings_bytes_1to_1u8_1vec (JNIEnv * env, jclass _b, jbyteArray bytes) {
180         LDKCVec_u8Z *vec = (LDKCVec_u8Z*)MALLOC(sizeof(LDKCVec_u8Z), "LDKCVec_u8");
181         vec->datalen = (*env)->GetArrayLength(env, bytes);
182         vec->data = (uint8_t*)MALLOC(vec->datalen, "LDKCVec_u8Z Bytes");
183         (*env)->GetByteArrayRegion (env, bytes, 0, vec->datalen, vec->data);
184         return (long)vec;
185 }
186 JNIEXPORT jbyteArray JNICALL Java_org_ldk_impl_bindings_txpointer_1get_1buffer (JNIEnv * env, jclass _b, jlong ptr) {
187         LDKTransaction *txdata = (LDKTransaction*)ptr;
188         LDKu8slice slice;
189         slice.data = txdata->data;
190         slice.datalen = txdata->datalen;
191         return Java_org_ldk_impl_bindings_get_1u8_1slice_1bytes(env, _b, (long)&slice);
192 }
193 JNIEXPORT long JNICALL Java_org_ldk_impl_bindings_new_1txpointer_1copy_1data (JNIEnv * env, jclass _b, jbyteArray bytes) {
194         LDKTransaction *txdata = (LDKTransaction*)MALLOC(sizeof(LDKTransaction), "LDKTransaction");
195         txdata->datalen = (*env)->GetArrayLength(env, bytes);
196         txdata->data = (uint8_t*)MALLOC(txdata->datalen, "Tx Data Bytes");
197         txdata->data_is_owned = false;
198         (*env)->GetByteArrayRegion (env, bytes, 0, txdata->datalen, txdata->data);
199         return (long)txdata;
200 }
201 JNIEXPORT void JNICALL Java_org_ldk_impl_bindings_txpointer_1free (JNIEnv * env, jclass _b, jlong ptr) {
202         LDKTransaction *tx = (LDKTransaction*)ptr;
203         tx->data_is_owned = true;
204         Transaction_free(*tx);
205         FREE((void*)ptr);
206 }
207 JNIEXPORT jlong JNICALL Java_org_ldk_impl_bindings_vec_1slice_1len (JNIEnv * env, jclass _a, jlong ptr) {
208         // Check offsets of a few Vec types are all consistent as we're meant to be generic across types
209         _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKCVec_SignatureZ, datalen), "Vec<*> needs to be mapped identically");
210         _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKCVec_MessageSendEventZ, datalen), "Vec<*> needs to be mapped identically");
211         _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKCVec_EventZ, datalen), "Vec<*> needs to be mapped identically");
212         _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKCVec_C2Tuple_usizeTransactionZZ, datalen), "Vec<*> needs to be mapped identically");
213         LDKCVec_u8Z *vec = (LDKCVec_u8Z*)ptr;
214         return (long)vec->datalen;
215 }
216 JNIEXPORT long JNICALL Java_org_ldk_impl_bindings_new_1empty_1slice_1vec (JNIEnv * env, jclass _b) {
217         // Check sizes of a few Vec types are all consistent as we're meant to be generic across types
218         _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKCVec_SignatureZ), "Vec<*> needs to be mapped identically");
219         _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKCVec_MessageSendEventZ), "Vec<*> needs to be mapped identically");
220         _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKCVec_EventZ), "Vec<*> needs to be mapped identically");
221         _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKCVec_C2Tuple_usizeTransactionZZ), "Vec<*> needs to be mapped identically");
222         LDKCVec_u8Z *vec = (LDKCVec_u8Z*)MALLOC(sizeof(LDKCVec_u8Z), "Empty LDKCVec");
223         vec->data = NULL;
224         vec->datalen = 0;
225         return (long)vec;
226 }
227
228 // We assume that CVec_u8Z and u8slice are the same size and layout (and thus pointers to the two can be mixed)
229 _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKu8slice), "Vec<u8> and [u8] need to have been mapped identically");
230 _Static_assert(offsetof(LDKCVec_u8Z, data) == offsetof(LDKu8slice, data), "Vec<u8> and [u8] need to have been mapped identically");
231 _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKu8slice, datalen), "Vec<u8> and [u8] need to have been mapped identically");
232
233 _Static_assert(sizeof(jlong) == sizeof(int64_t), "We assume that j-types are the same as C types");
234 _Static_assert(sizeof(jbyte) == sizeof(char), "We assume that j-types are the same as C types");
235 _Static_assert(sizeof(void*) <= 8, "Pointers must fit into 64 bits");
236
237 typedef jlongArray int64_tArray;
238 typedef jbyteArray int8_tArray;
239
240 """
241
242         self.hu_struct_file_prefix = """package org.ldk.structs;
243
244 import org.ldk.impl.bindings;
245 import org.ldk.enums.*;
246 import org.ldk.util.*;
247 import java.util.Arrays;
248
249 @SuppressWarnings("unchecked") // We correctly assign various generic arrays
250 """
251         self.c_fn_ty_pfx = "JNIEXPORT "
252         self.c_fn_name_pfx = "JNICALL Java_org_ldk_impl_bindings_"
253         self.c_fn_args_pfx = "JNIEnv *env, jclass clz"
254         self.file_ext = ".java"
255         self.ptr_c_ty = "int64_t"
256         self.ptr_native_ty = "long"
257         self.result_c_ty = "jclass"
258         self.ptr_arr = "jobjectArray"
259         self.get_native_arr_len_call = ("(*env)->GetArrayLength(env, ", ")")
260         self.get_native_arr_ptr_call = ("(*env)->GetPrimitiveArrayCritical(env, ", ", NULL)")
261
262     def release_native_arr_ptr_call(self, arr_var, arr_ptr_var):
263         return "(*env)->ReleasePrimitiveArrayCritical(env, " + arr_var + ", " + arr_ptr_var + ", 0)"
264     def create_native_arr_call(self, arr_len, ty_info):
265         if ty_info.c_ty == "int8_tArray":
266             return "(*env)->NewByteArray(env, " + arr_len + ")"
267         else:
268             return "(*env)->New" + ty_info.java_ty.strip("[]").title() + "Array(env, " + arr_len + ")"
269     def set_native_arr_contents(self, arr_name, arr_len, ty_info):
270         if ty_info.c_ty == "int8_tArray":
271             return ("(*env)->SetByteArrayRegion(env, " + arr_name + ", 0, " + arr_len + ", ", ")")
272         else:
273             assert False
274     def get_native_arr_contents(self, arr_name, dest_name, arr_len, ty_info, copy):
275         if ty_info.c_ty == "int8_tArray":
276             if copy:
277                 return "(*env)->GetByteArrayRegion(env, " + arr_name + ", 0, " + arr_len + ", " + dest_name + ")"
278             else:
279                 return "(*env)->GetByteArrayElements (env, " + arr_name + ", NULL)"
280         elif not ty_info.java_ty[:len(ty_info.java_ty) - 2].endswith("[]"):
281             return "(*env)->Get" + ty_info.subty.java_ty.title() + "ArrayElements (env, " + arr_name + ", NULL)"
282         else:
283             return None
284     def get_native_arr_elem(self, arr_name, idxc, ty_info):
285         if self.get_native_arr_contents(arr_name, "", "", ty_info, False) is None:
286             return "(*env)->GetObjectArrayElement(env, " + arr_name + ", " + idxc + ")"
287         else:
288             assert False # Only called if above is None
289     def cleanup_native_arr_ref_contents(self, arr_name, dest_name, arr_len, ty_info):
290         if ty_info.c_ty == "int8_tArray":
291             return "(*env)->ReleaseByteArrayElements(env, " + arr_name + ", (int8_t*)" + dest_name + ", 0);"
292         else:
293             return "(*env)->Release" + ty_info.java_ty.strip("[]").title() + "ArrayElements(env, " + arr_name + ", " + dest_name + ", 0)"
294
295     def init_str(self, c_array_class_caches):
296         res = ""
297         for ty in c_array_class_caches:
298             res = res + "static jclass " + ty + "_clz = NULL;\n"
299         res = res + "JNIEXPORT void Java_org_ldk_impl_bindings_init_1class_1cache(JNIEnv * env, jclass clz) {\n"
300         for ty in c_array_class_caches:
301             res = res + "\t" + ty + "_clz = (*env)->FindClass(env, \"" + ty.replace("arr_of_", "[") + "\");\n"
302             res = res + "\tCHECK(" + ty + "_clz != NULL);\n"
303             res = res + "\t" + ty + "_clz = (*env)->NewGlobalRef(env, " + ty + "_clz);\n"
304         res = res + "}\n"
305         return res
306
307     def native_c_unitary_enum_map(self, struct_name, variants):
308         out_java_enum = "package org.ldk.enums;\n\n"
309         out_java = ""
310         out_c = ""
311         out_c = out_c + "static inline " + struct_name + " " + struct_name + "_from_java(" + self.c_fn_args_pfx + ") {\n"
312         out_c = out_c + "\tswitch ((*env)->CallIntMethod(env, clz, ordinal_meth)) {\n"
313
314         out_java_enum = out_java_enum + "public enum " + struct_name + " {\n"
315         ord_v = 0
316         for var in variants:
317             out_java_enum = out_java_enum + "\t" + var + ",\n"
318             out_c = out_c + "\t\tcase %d: return %s;\n" % (ord_v, var)
319             ord_v = ord_v + 1
320         out_java_enum = out_java_enum + "\t; static native void init();\n"
321         out_java_enum = out_java_enum + "\tstatic { init(); }\n"
322         out_java_enum = out_java_enum + "}"
323         out_java = out_java + "\tstatic { " + struct_name + ".values(); /* Force enum statics to run */ }\n"
324         out_c = out_c + "\t}\n"
325         out_c = out_c + "\tabort();\n"
326         out_c = out_c + "}\n"
327
328         out_c = out_c + "static jclass " + struct_name + "_class = NULL;\n"
329         for var in variants:
330             out_c = out_c + "static jfieldID " + struct_name + "_" + var + " = NULL;\n"
331         out_c = out_c + self.c_fn_ty_pfx + "void JNICALL Java_org_ldk_enums_" + struct_name.replace("_", "_1") + "_init (" + self.c_fn_args_pfx + ") {\n"
332         out_c = out_c + "\t" + struct_name + "_class = (*env)->NewGlobalRef(env, clz);\n"
333         out_c = out_c + "\tCHECK(" + struct_name + "_class != NULL);\n"
334         for var in variants:
335             out_c = out_c + "\t" + struct_name + "_" + var + " = (*env)->GetStaticFieldID(env, " + struct_name + "_class, \"" + var + "\", \"Lorg/ldk/enums/" + struct_name + ";\");\n"
336             out_c = out_c + "\tCHECK(" + struct_name + "_" + var + " != NULL);\n"
337         out_c = out_c + "}\n"
338         out_c = out_c + "static inline jclass " + struct_name + "_to_java(JNIEnv *env, " + struct_name + " val) {\n"
339         out_c = out_c + "\tswitch (val) {\n"
340         ord_v = 0
341         for var in variants:
342             out_c = out_c + "\t\tcase " + var + ":\n"
343             out_c = out_c + "\t\t\treturn (*env)->GetStaticObjectField(env, " + struct_name + "_class, " + struct_name + "_" + var + ");\n"
344             ord_v = ord_v + 1
345         out_c = out_c + "\t\tdefault: abort();\n"
346         out_c = out_c + "\t}\n"
347         out_c = out_c + "}\n\n"
348
349         return (out_c, out_java_enum, out_java)
350
351     def c_unitary_enum_to_native_call(self, ty_info):
352         return (ty_info.rust_obj + "_to_java(env, ", ")")
353     def native_unitary_enum_to_c_call(self, ty_info):
354         return (ty_info.rust_obj + "_from_java(env, ", ")")
355
356     def c_complex_enum_pfx(self, struct_name, variants, init_meth_jty_strs):
357         out_c = ""
358         for var in variants:
359             out_c = out_c + "static jclass " + struct_name + "_" + var + "_class = NULL;\n"
360             out_c = out_c + "static jmethodID " + struct_name + "_" + var + "_meth = NULL;\n"
361         out_c = out_c + self.c_fn_ty_pfx + "void JNICALL Java_org_ldk_impl_bindings_00024" + struct_name.replace("_", "_1") + "_init (" + self.c_fn_args_pfx + ") {\n"
362         for var_name in variants:
363             out_c = out_c + "\t" + struct_name + "_" + var_name + "_class =\n"
364             out_c = out_c + "\t\t(*env)->NewGlobalRef(env, (*env)->FindClass(env, \"Lorg/ldk/impl/bindings$" + struct_name + "$" + var_name + ";\"));\n"
365             out_c = out_c + "\tCHECK(" + struct_name + "_" + var_name + "_class != NULL);\n"
366             out_c = out_c + "\t" + struct_name + "_" + var_name + "_meth = (*env)->GetMethodID(env, " + struct_name + "_" + var_name + "_class, \"<init>\", \"(" + init_meth_jty_strs[var_name] + ")V\");\n"
367             out_c = out_c + "\tCHECK(" + struct_name + "_" + var_name + "_meth != NULL);\n"
368         out_c = out_c + "}\n"
369         return out_c
370
371     def c_complex_enum_pass_ty(self, struct_name):
372         return "jobject"
373
374     def c_constr_native_complex_enum(self, struct_name, variant, c_params):
375         ret = "(*env)->NewObject(env, " + struct_name + "_" + variant + "_class, " + struct_name + "_" + variant + "_meth"
376         for param in c_params:
377             ret = ret + ", " + param
378         return ret + ")"
379
380     def native_c_map_trait(self, struct_name, field_vars, field_fns):
381         out_java_trait = ""
382         out_java = ""
383
384         # First generate most of the Java code, note that we need information about java method argument strings for C
385         out_java_trait = out_java_trait + self.hu_struct_file_prefix
386         out_java_trait = out_java_trait + "public class " + struct_name.replace("LDK","") + " extends CommonBase {\n"
387         out_java_trait = out_java_trait + "\tfinal bindings." + struct_name + " bindings_instance;\n"
388         out_java_trait = out_java_trait + "\t" + struct_name.replace("LDK", "") + "(Object _dummy, long ptr) { super(ptr); bindings_instance = null; }\n"
389         out_java_trait = out_java_trait + "\tprivate " + struct_name.replace("LDK", "") + "(bindings." + struct_name + " arg"
390         for var in field_vars:
391             if isinstance(var, ConvInfo):
392                 out_java_trait = out_java_trait + ", " + var.java_hu_ty + " " + var.arg_name
393             else:
394                 out_java_trait = out_java_trait + ", bindings." + var[0] + " " + var[1]
395         out_java_trait = out_java_trait + ") {\n"
396         out_java_trait = out_java_trait + "\t\tsuper(bindings." + struct_name + "_new(arg"
397         for var in field_vars:
398             if isinstance(var, ConvInfo):
399                 if var.from_hu_conv is not None:
400                     out_java_trait = out_java_trait + ", " + var.from_hu_conv[0]
401                 else:
402                     out_java_trait = out_java_trait + ", " + var.arg_name
403             else:
404                 out_java_trait = out_java_trait + ", " + var[1]
405         out_java_trait = out_java_trait + "));\n"
406         out_java_trait = out_java_trait + "\t\tthis.ptrs_to.add(arg);\n"
407         for var in field_vars:
408             if isinstance(var, ConvInfo):
409                 if var.from_hu_conv is not None and var.from_hu_conv[1] != "":
410                     out_java_trait = out_java_trait + "\t\t" + var.from_hu_conv[1] + ";\n"
411             else:
412                 out_java_trait = out_java_trait + "\t\tthis.ptrs_to.add(" + var[1] + ");\n"
413         out_java_trait = out_java_trait + "\t\tthis.bindings_instance = arg;\n"
414         out_java_trait = out_java_trait + "\t}\n"
415         out_java_trait = out_java_trait + "\t@Override @SuppressWarnings(\"deprecation\")\n"
416         out_java_trait = out_java_trait + "\tprotected void finalize() throws Throwable {\n"
417         out_java_trait = out_java_trait + "\t\tif (ptr != 0) { bindings." + struct_name.replace("LDK","") + "_free(ptr); } super.finalize();\n"
418         out_java_trait = out_java_trait + "\t}\n\n"
419
420         java_trait_constr = "\tprivate static class " + struct_name + "Holder { " + struct_name.replace("LDK", "") + " held; }\n"
421         java_trait_constr = java_trait_constr + "\tpublic static " + struct_name.replace("LDK", "") + " new_impl(" + struct_name.replace("LDK", "") + "Interface arg"
422         for var in field_vars:
423             if isinstance(var, ConvInfo):
424                 java_trait_constr = java_trait_constr + ", " + var.java_hu_ty + " " + var.arg_name
425             else:
426                 # Ideally we'd be able to take any instance of the interface, but our C code can only represent
427                 # Java-implemented version, so we require users pass a Java implementation here :/
428                 java_trait_constr = java_trait_constr + ", " + var[0].replace("LDK", "") + "." + var[0].replace("LDK", "") + "Interface " + var[1] + "_impl"
429         java_trait_constr = java_trait_constr + ") {\n\t\tfinal " + struct_name + "Holder impl_holder = new " + struct_name + "Holder();\n"
430         java_trait_constr = java_trait_constr + "\t\timpl_holder.held = new " + struct_name.replace("LDK", "") + "(new bindings." + struct_name + "() {\n"
431         out_java_trait = out_java_trait + "\tpublic static interface " + struct_name.replace("LDK", "") + "Interface {\n"
432         out_java = out_java + "\tpublic interface " + struct_name + " {\n"
433         java_meths = []
434         for fn_line in field_fns:
435             java_meth_descr = "("
436             if fn_line.fn_name != "free" and fn_line.fn_name != "clone":
437                 out_java = out_java + "\t\t " + fn_line.ret_ty_info.java_ty + " " + fn_line.fn_name + "("
438                 java_trait_constr = java_trait_constr + "\t\t\t@Override public " + fn_line.ret_ty_info.java_ty + " " + fn_line.fn_name + "("
439                 out_java_trait = out_java_trait + "\t\t" + fn_line.ret_ty_info.java_hu_ty + " " + fn_line.fn_name + "("
440
441                 for idx, arg_conv_info in enumerate(fn_line.args_ty):
442                     if idx >= 1:
443                         out_java = out_java + ", "
444                         java_trait_constr = java_trait_constr + ", "
445                         out_java_trait = out_java_trait + ", "
446                     out_java = out_java + arg_conv_info.java_ty + " " + arg_conv_info.arg_name
447                     out_java_trait = out_java_trait + arg_conv_info.java_hu_ty + " " + arg_conv_info.arg_name
448                     java_trait_constr = java_trait_constr + arg_conv_info.java_ty + " " + arg_conv_info.arg_name
449                     java_meth_descr = java_meth_descr + arg_conv_info.java_fn_ty_arg
450                 java_meth_descr = java_meth_descr + ")" + fn_line.ret_ty_info.java_fn_ty_arg
451                 java_meths.append((fn_line.fn_name, java_meth_descr))
452
453                 out_java = out_java + ");\n"
454                 out_java_trait = out_java_trait + ");\n"
455                 java_trait_constr = java_trait_constr + ") {\n"
456
457                 for arg_info in fn_line.args_ty:
458                     if arg_info.to_hu_conv is not None:
459                         java_trait_constr = java_trait_constr + "\t\t\t\t" + arg_info.to_hu_conv.replace("\n", "\n\t\t\t\t") + "\n"
460
461                 if fn_line.ret_ty_info.java_ty != "void":
462                     java_trait_constr = java_trait_constr + "\t\t\t\t" + fn_line.ret_ty_info.java_hu_ty + " ret = arg." + fn_line.fn_name + "("
463                 else:
464                     java_trait_constr = java_trait_constr + "\t\t\t\targ." + fn_line.fn_name + "("
465
466                 for idx, arg_info in enumerate(fn_line.args_ty):
467                     if idx != 0:
468                         java_trait_constr = java_trait_constr + ", "
469                     if arg_info.to_hu_conv_name is not None:
470                         java_trait_constr = java_trait_constr + arg_info.to_hu_conv_name
471                     else:
472                         java_trait_constr = java_trait_constr + arg_info.arg_name
473
474                 java_trait_constr = java_trait_constr + ");\n"
475                 if fn_line.ret_ty_info.java_ty != "void":
476                     if fn_line.ret_ty_info.from_hu_conv is not None:
477                         java_trait_constr = java_trait_constr + "\t\t\t\t" + fn_line.ret_ty_info.java_ty + " result = " + fn_line.ret_ty_info.from_hu_conv[0] + ";\n"
478                         if fn_line.ret_ty_info.from_hu_conv[1] != "":
479                             java_trait_constr = java_trait_constr + "\t\t\t\t" + fn_line.ret_ty_info.from_hu_conv[1].replace("this", "impl_holder.held") + ";\n"
480                         #if fn_line.ret_ty_info.rust_obj in result_types:
481                         # XXX: We need to handle this in conversion logic so that its cross-language!
482                             # Avoid double-free by breaking the result - we should learn to clone these and then we can be safe instead
483                         #    java_trait_constr = java_trait_constr + "\t\t\t\tret.ptr = 0;\n"
484                         java_trait_constr = java_trait_constr + "\t\t\t\treturn result;\n"
485                     else:
486                         java_trait_constr = java_trait_constr + "\t\t\t\treturn ret;\n"
487                 java_trait_constr = java_trait_constr + "\t\t\t}\n"
488         java_trait_constr = java_trait_constr + "\t\t}"
489         for var in field_vars:
490             if isinstance(var, ConvInfo):
491                 java_trait_constr = java_trait_constr + ", " + var.arg_name
492             else:
493                 java_trait_constr = java_trait_constr + ", " + var[1] + ".new_impl(" + var[1] + "_impl).bindings_instance"
494         out_java_trait = out_java_trait + "\t}\n"
495         out_java_trait = out_java_trait + java_trait_constr + ");\n\t\treturn impl_holder.held;\n\t}\n"
496
497         out_java = out_java + "\t}\n"
498
499         out_java = out_java + "\tpublic static native long " + struct_name + "_new(" + struct_name + " impl"
500         for var in field_vars:
501             if isinstance(var, ConvInfo):
502                 out_java = out_java + ", " + var.java_ty + " " + var.arg_name
503             else:
504                 out_java = out_java + ", " + var[0] + " " + var[1]
505         out_java = out_java + ");\n"
506         out_java = out_java + "\tpublic static native " + struct_name + " " + struct_name + "_get_obj_from_jcalls(long val);\n"
507
508         # Now that we've written out our java code (and created java_meths), generate C
509         out_c = "typedef struct " + struct_name + "_JCalls {\n"
510         out_c = out_c + "\tatomic_size_t refcnt;\n"
511         out_c = out_c + "\tJavaVM *vm;\n"
512         out_c = out_c + "\tjweak o;\n"
513         for var in field_vars:
514             if isinstance(var, ConvInfo):
515                 # We're a regular ol' field
516                 pass
517             else:
518                 # We're a supertrait
519                 out_c = out_c + "\t" + var[0] + "_JCalls* " + var[1] + ";\n"
520         for fn in field_fns:
521             if fn.fn_name != "free" and fn.fn_name != "clone":
522                 out_c = out_c + "\tjmethodID " + fn.fn_name + "_meth;\n"
523         out_c = out_c + "} " + struct_name + "_JCalls;\n"
524
525         for fn_line in field_fns:
526             if fn_line.fn_name == "free":
527                 out_c = out_c + "static void " + struct_name + "_JCalls_free(void* this_arg) {\n"
528                 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) this_arg;\n"
529                 out_c = out_c + "\tif (atomic_fetch_sub_explicit(&j_calls->refcnt, 1, memory_order_acquire) == 1) {\n"
530                 out_c = out_c + "\t\tJNIEnv *env;\n"
531                 out_c = out_c + "\t\tDO_ASSERT((*j_calls->vm)->GetEnv(j_calls->vm, (void**)&env, JNI_VERSION_1_8) == JNI_OK);\n"
532                 out_c = out_c + "\t\t(*env)->DeleteWeakGlobalRef(env, j_calls->o);\n"
533                 out_c = out_c + "\t\tFREE(j_calls);\n"
534                 out_c = out_c + "\t}\n}\n"
535
536         for idx, fn_line in enumerate(field_fns):
537             if fn_line.fn_name != "free" and fn_line.fn_name != "clone":
538                 assert fn_line.ret_ty_info.ty_info.get_full_rust_ty()[1] == ""
539                 out_c = out_c + fn_line.ret_ty_info.ty_info.get_full_rust_ty()[0] + " " + fn_line.fn_name + "_jcall("
540                 if fn_line.self_is_const:
541                     out_c = out_c + "const void* this_arg"
542                 else:
543                     out_c = out_c + "void* this_arg"
544
545                 for idx, arg in enumerate(fn_line.args_ty):
546                     out_c = out_c + ", " + arg.ty_info.get_full_rust_ty()[0] + " " + arg.arg_name + arg.ty_info.get_full_rust_ty()[1]
547
548                 out_c = out_c + ") {\n"
549                 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) this_arg;\n"
550                 out_c = out_c + "\tJNIEnv *env;\n"
551                 out_c = out_c + "\tDO_ASSERT((*j_calls->vm)->GetEnv(j_calls->vm, (void**)&env, JNI_VERSION_1_8) == JNI_OK);\n"
552
553                 for arg_info in fn_line.args_ty:
554                     if arg_info.ret_conv is not None:
555                         out_c = out_c + "\t" + arg_info.ret_conv[0].replace('\n', '\n\t')
556                         out_c = out_c + arg_info.arg_name
557                         out_c = out_c + arg_info.ret_conv[1].replace('\n', '\n\t') + "\n"
558
559                 out_c = out_c + "\tjobject obj = (*env)->NewLocalRef(env, j_calls->o);\n\tCHECK(obj != NULL);\n"
560                 if fn_line.ret_ty_info.c_ty.endswith("Array"):
561                     out_c = out_c + "\t" + fn_line.ret_ty_info.c_ty + " arg = (*env)->CallObjectMethod(env, obj, j_calls->" + fn_line.fn_name + "_meth"
562                 elif not fn_line.ret_ty_info.passed_as_ptr:
563                     out_c = out_c + "\treturn (*env)->Call" + fn_line.ret_ty_info.java_ty.title() + "Method(env, obj, j_calls->" + fn_line.fn_name + "_meth"
564                 else:
565                     out_c = out_c + "\t" + fn_line.ret_ty_info.rust_obj + "* ret = (" + fn_line.ret_ty_info.rust_obj + "*)(*env)->CallLongMethod(env, obj, j_calls->" + fn_line.fn_name + "_meth"
566
567                 for idx, arg_info in enumerate(fn_line.args_ty):
568                     if arg_info.ret_conv is not None:
569                         out_c = out_c + ", " + arg_info.ret_conv_name
570                     else:
571                         out_c = out_c + ", " + arg_info.arg_name
572                 out_c = out_c + ");\n"
573                 if fn_line.ret_ty_info.arg_conv is not None:
574                     out_c = out_c + "\t" + fn_line.ret_ty_info.arg_conv.replace("\n", "\n\t") + "\n\treturn " + fn_line.ret_ty_info.arg_conv_name + ";\n"
575
576                 out_c = out_c + "}\n"
577
578         # Write out a clone function whether we need one or not, as we use them in moving to rust
579         out_c = out_c + "static void* " + struct_name + "_JCalls_clone(const void* this_arg) {\n"
580         out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) this_arg;\n"
581         out_c = out_c + "\tatomic_fetch_add_explicit(&j_calls->refcnt, 1, memory_order_release);\n"
582         for var in field_vars:
583             if not isinstance(var, ConvInfo):
584                 out_c = out_c + "\tatomic_fetch_add_explicit(&j_calls->" + var[1] + "->refcnt, 1, memory_order_release);\n"
585         out_c = out_c + "\treturn (void*) this_arg;\n"
586         out_c = out_c + "}\n"
587
588         out_c = out_c + "static inline " + struct_name + " " + struct_name + "_init (" + self.c_fn_args_pfx + ", jobject o"
589         for var in field_vars:
590             if isinstance(var, ConvInfo):
591                 out_c = out_c + ", " + var.c_ty + " " + var.arg_name
592             else:
593                 out_c = out_c + ", jobject " + var[1]
594         out_c = out_c + ") {\n"
595
596         out_c = out_c + "\tjclass c = (*env)->GetObjectClass(env, o);\n"
597         out_c = out_c + "\tCHECK(c != NULL);\n"
598         out_c = out_c + "\t" + struct_name + "_JCalls *calls = MALLOC(sizeof(" + struct_name + "_JCalls), \"" + struct_name + "_JCalls\");\n"
599         out_c = out_c + "\tatomic_init(&calls->refcnt, 1);\n"
600         out_c = out_c + "\tDO_ASSERT((*env)->GetJavaVM(env, &calls->vm) == 0);\n"
601         out_c = out_c + "\tcalls->o = (*env)->NewWeakGlobalRef(env, o);\n"
602
603         for (fn_name, java_meth_descr) in java_meths:
604             if fn_name != "free" and fn_name != "clone":
605                 out_c = out_c + "\tcalls->" + fn_name + "_meth = (*env)->GetMethodID(env, c, \"" + fn_name + "\", \"" + java_meth_descr + "\");\n"
606                 out_c = out_c + "\tCHECK(calls->" + fn_name + "_meth != NULL);\n"
607
608         for var in field_vars:
609             if isinstance(var, ConvInfo) and var.arg_conv is not None:
610                 out_c = out_c + "\n\t" + var.arg_conv.replace("\n", "\n\t") +"\n"
611         out_c = out_c + "\n\t" + struct_name + " ret = {\n"
612         out_c = out_c + "\t\t.this_arg = (void*) calls,\n"
613         for fn_line in field_fns:
614             if fn_line.fn_name != "free" and fn_line.fn_name != "clone":
615                 out_c = out_c + "\t\t." + fn_line.fn_name + " = " + fn_line.fn_name + "_jcall,\n"
616             elif fn_line.fn_name == "free":
617                 out_c = out_c + "\t\t.free = " + struct_name + "_JCalls_free,\n"
618             else:
619                 out_c = out_c + "\t\t.clone = " + struct_name + "_JCalls_clone,\n"
620         for var in field_vars:
621             if isinstance(var, ConvInfo):
622                 if var.arg_conv_name is not None:
623                     out_c = out_c + "\t\t." + var.arg_name + " = " + var.arg_conv_name + ",\n"
624                     out_c = out_c + "\t\t.set_" + var.arg_name + " = NULL,\n"
625                 else:
626                     out_c = out_c + "\t\t." + var.var_name + " = " + var.var_name + ",\n"
627                     out_c = out_c + "\t\t.set_" + var.var_name + " = NULL,\n"
628             else:
629                 out_c = out_c + "\t\t." + var[1] + " = " + var[0] + "_init(env, clz, " + var[1] + "),\n"
630         out_c = out_c + "\t};\n"
631         for var in field_vars:
632             if not isinstance(var, ConvInfo):
633                 out_c = out_c + "\tcalls->" + var[1] + " = ret." + var[1] + ".this_arg;\n"
634         out_c = out_c + "\treturn ret;\n"
635         out_c = out_c + "}\n"
636
637         out_c = out_c + self.c_fn_ty_pfx + "long " + self.c_fn_name_pfx + struct_name.replace("_", "_1") + "_1new (" + self.c_fn_args_pfx + ", jobject o"
638         for var in field_vars:
639             if isinstance(var, ConvInfo):
640                 out_c = out_c + ", " + var.c_ty + " " + var.arg_name
641             else:
642                 out_c = out_c + ", jobject " + var[1]
643         out_c = out_c + ") {\n"
644         out_c = out_c + "\t" + struct_name + " *res_ptr = MALLOC(sizeof(" + struct_name + "), \"" + struct_name + "\");\n"
645         out_c = out_c + "\t*res_ptr = " + struct_name + "_init(env, clz, o"
646         for var in field_vars:
647             if isinstance(var, ConvInfo):
648                 out_c = out_c + ", " + var.arg_name
649             else:
650                 out_c = out_c + ", " + var[1]
651         out_c = out_c + ");\n"
652         out_c = out_c + "\treturn (long)res_ptr;\n"
653         out_c = out_c + "}\n"
654
655         out_c = out_c + self.c_fn_ty_pfx + "jobject " + self.c_fn_name_pfx + struct_name.replace("_", "_1") + "_1get_1obj_1from_1jcalls (" + self.c_fn_args_pfx + ", " + self.ptr_c_ty + " val) {\n"
656         out_c = out_c + "\tjobject ret = (*env)->NewLocalRef(env, ((" + struct_name + "_JCalls*)val)->o);\n"
657         out_c = out_c + "\tCHECK(ret != NULL);\n"
658         out_c = out_c + "\treturn ret;\n"
659         out_c = out_c + "}\n"
660
661         return (out_java, out_java_trait, out_c)
662
663     def map_complex_enum(self, struct_name, variant_list, camel_to_snake):
664         java_hu_type = struct_name.replace("LDK", "")
665         out_java_enum = ""
666         out_java = ""
667         out_c = ""
668
669         out_java_enum += (self.hu_struct_file_prefix)
670         out_java_enum += ("public class " + java_hu_type + " extends CommonBase {\n")
671         out_java_enum += ("\tprivate " + java_hu_type + "(Object _dummy, long ptr) { super(ptr); }\n")
672         out_java_enum += ("\t@Override @SuppressWarnings(\"deprecation\")\n")
673         out_java_enum += ("\tprotected void finalize() throws Throwable {\n")
674         out_java_enum += ("\t\tsuper.finalize();\n")
675         out_java_enum += ("\t\tif (ptr != 0) { bindings." + java_hu_type + "_free(ptr); }\n")
676         out_java_enum += ("\t}\n")
677         out_java_enum += ("\tstatic " + java_hu_type + " constr_from_ptr(long ptr) {\n")
678         out_java_enum += ("\t\tbindings." + struct_name + " raw_val = bindings." + struct_name + "_ref_from_ptr(ptr);\n")
679         java_hu_subclasses = ""
680
681         init_meth_jty_strs = {}
682
683         out_java +=  ("\tpublic static class " + struct_name + " {\n")
684         out_java +=  ("\t\tprivate " + struct_name + "() {}\n")
685         for var in variant_list:
686             out_java +=  ("\t\tpublic final static class " + var.var_name + " extends " + struct_name + " {\n")
687             java_hu_subclasses = java_hu_subclasses + "\tpublic final static class " + var.var_name + " extends " + java_hu_type + " {\n"
688             out_java_enum += ("\t\tif (raw_val.getClass() == bindings." + struct_name + "." + var.var_name + ".class) {\n")
689             out_java_enum += ("\t\t\treturn new " + var.var_name + "(ptr, (bindings." + struct_name + "." + var.var_name + ")raw_val);\n")
690             init_meth_jty_str = ""
691             init_meth_params = ""
692             init_meth_body = ""
693             hu_conv_body = ""
694             for idx, field_ty in enumerate(var.fields):
695                 out_java += ("\t\t\tpublic " + field_ty.java_ty + " " + field_ty.arg_name + ";\n")
696                 java_hu_subclasses = java_hu_subclasses + "\t\tpublic final " + field_ty.java_hu_ty + " " + field_ty.arg_name + ";\n"
697                 if field_ty.to_hu_conv is not None:
698                     hu_conv_body = hu_conv_body + "\t\t\t" + field_ty.java_ty + " " + field_ty.arg_name + " = obj." + field_ty.arg_name + ";\n"
699                     hu_conv_body = hu_conv_body + "\t\t\t" + field_ty.to_hu_conv.replace("\n", "\n\t\t\t") + "\n"
700                     hu_conv_body = hu_conv_body + "\t\t\tthis." + field_ty.arg_name + " = " + field_ty.to_hu_conv_name + ";\n"
701                 else:
702                     hu_conv_body = hu_conv_body + "\t\t\tthis." + field_ty.arg_name + " = obj." + field_ty.arg_name + ";\n"
703                 init_meth_jty_str = init_meth_jty_str + field_ty.java_fn_ty_arg
704                 if idx > 0:
705                     init_meth_params = init_meth_params + ", "
706                 init_meth_params = init_meth_params + field_ty.java_ty + " " + field_ty.arg_name
707                 init_meth_body = init_meth_body + "this." + field_ty.arg_name + " = " + field_ty.arg_name + "; "
708             out_java +=  ("\t\t\t" + var.var_name + "(" + init_meth_params + ") { ")
709             out_java +=  (init_meth_body)
710             out_java +=  ("}\n")
711             out_java += ("\t\t}\n")
712             out_java_enum += ("\t\t}\n")
713             java_hu_subclasses = java_hu_subclasses + "\t\tprivate " + var.var_name + "(long ptr, bindings." + struct_name + "." + var.var_name + " obj) {\n\t\t\tsuper(null, ptr);\n"
714             java_hu_subclasses = java_hu_subclasses + hu_conv_body
715             java_hu_subclasses = java_hu_subclasses + "\t\t}\n\t}\n"
716             init_meth_jty_strs[var.var_name] = init_meth_jty_str
717         out_java += ("\t\tstatic native void init();\n")
718         out_java += ("\t}\n")
719         out_java_enum += ("\t\tassert false; return null; // Unreachable without extending the (internal) bindings interface\n\t}\n\n")
720         out_java_enum += (java_hu_subclasses)
721         out_java += ("\tstatic { " + struct_name + ".init(); }\n")
722         out_java += ("\tpublic static native " + struct_name + " " + struct_name + "_ref_from_ptr(long ptr);\n");
723
724         out_c += (self.c_complex_enum_pfx(struct_name, [x.var_name for x in variant_list], init_meth_jty_strs))
725
726         out_c += (self.c_fn_ty_pfx + self.c_complex_enum_pass_ty(struct_name) + " " + self.c_fn_name_pfx + struct_name.replace("_", "_1") + "_1ref_1from_1ptr (" + self.c_fn_args_pfx + ", " + self.ptr_c_ty + " ptr) {\n")
727         out_c += ("\t" + struct_name + " *obj = (" + struct_name + "*)ptr;\n")
728         out_c += ("\tswitch(obj->tag) {\n")
729         for var in variant_list:
730             out_c += ("\t\tcase " + struct_name + "_" + var.var_name + ": {\n")
731             c_params = []
732             for idx, field_map in enumerate(var.fields):
733                 if field_map.ret_conv is not None:
734                     out_c += ("\t\t\t" + field_map.ret_conv[0].replace("\n", "\n\t\t\t"))
735                     out_c += ("obj->" + camel_to_snake(var.var_name) + "." + field_map.arg_name)
736                     out_c += (field_map.ret_conv[1].replace("\n", "\n\t\t\t") + "\n")
737                     c_params.append(field_map.ret_conv_name)
738                 else:
739                     c_params.append("obj->" + camel_to_snake(var.var_name) + "." + field_map.arg_name)
740             out_c += ("\t\t\treturn " + self.c_constr_native_complex_enum(struct_name, var.var_name, c_params) + ";\n")
741             out_c += ("\t\t}\n")
742         out_c += ("\t\tdefault: abort();\n")
743         out_c += ("\t}\n}\n")
744         out_java_enum += ("}\n")
745         return (out_java, out_java_enum, out_c)