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