1 from bindingstypes import *
10 def __init__(self, DEBUG: bool, target: Target, **kwargs):
12 self.c_array_class_caches = set()
13 self.c_type_map = dict(
20 self.java_type_map = dict(
23 self.java_hu_type_map = dict(
27 self.to_hu_conv_templates = dict(
28 ptr = '{human_type} {var_name}_hu_conv = null; if ({var_name} < 0 || {var_name} > 4096) { {var_name}_hu_conv = new {human_type}(null, {var_name}); }',
29 default = '{human_type} {var_name}_hu_conv = null; if ({var_name} < 0 || {var_name} > 4096) { {var_name}_hu_conv = new {human_type}(null, {var_name}); }'
32 self.bindings_header = """package org.ldk.impl;
33 import org.ldk.enums.*;
34 import org.ldk.impl.version;
36 import java.io.InputStream;
37 import java.io.IOException;
38 import java.nio.file.Files;
39 import java.nio.file.Path;
40 import java.nio.file.StandardCopyOption;
42 public class bindings {
45 // Try to load natively first, this works on Android and in testing.
46 System.loadLibrary(\"lightningjni\");
47 } catch (UnsatisfiedLinkError system_load_err) {
48 // Otherwise try to load from the library jar.
49 File tmpdir = new File(System.getProperty("java.io.tmpdir"), "ldk-java-nativelib");
50 tmpdir.mkdir(); // If it fails to create, assume it was there already
51 tmpdir.deleteOnExit();
52 String libname = "liblightningjni_" + System.getProperty("os.name").replaceAll(" ", "") +
53 "-" + System.getProperty("os.arch").replaceAll(" ", "") + ".nativelib";
54 try (InputStream is = bindings.class.getResourceAsStream("/" + libname)) {
55 Path libpath = new File(tmpdir.toPath().toString(), "liblightningjni.so").toPath();
56 Files.copy(is, libpath, StandardCopyOption.REPLACE_EXISTING);
57 Runtime.getRuntime().load(libpath.toString());
58 } catch (Exception e) {
59 System.err.println("Failed to load LDK native library.");
60 System.err.println("System LDK native library load failed with: " + system_load_err);
61 System.err.println("Resource-based LDK native library load failed with: " + e);
62 throw new IllegalArgumentException(e);
65 init(java.lang.Enum.class);
67 if (!get_lib_version_string().equals(version.get_ldk_java_bindings_version()))
68 throw new IllegalArgumentException("Compiled LDK library and LDK class failes do not match");
69 // Fetching the LDK versions from C also checks that the header and binaries match
70 System.err.println("Loaded LDK-Java Bindings " + version.get_ldk_java_bindings_version() + " with LDK " + get_ldk_version() + " and LDK-C-Bindings " + get_ldk_c_bindings_version());
72 static native void init(java.lang.Class c);
73 static native void init_class_cache();
74 static native String get_lib_version_string();
76 public static native String get_ldk_c_bindings_version();
77 public static native String get_ldk_version();
80 self.bindings_version_file = """package org.ldk.impl;
82 public class version {
83 public static String get_ldk_java_bindings_version() {
84 return "<git_version_ldk_garbagecollected>";
88 self.util_fn_pfx = """package org.ldk.structs;
89 import org.ldk.impl.bindings;
90 import org.ldk.enums.*;
91 import org.ldk.util.*;
92 import java.util.Arrays;
93 import java.lang.ref.Reference;
94 import javax.annotation.Nullable;
96 public class UtilMethods {
98 self.util_fn_sfx = "}"
99 self.common_base = """package org.ldk.structs;
100 import java.util.LinkedList;
103 LinkedList<Object> ptrs_to = new LinkedList();
104 protected CommonBase(long ptr) { assert ptr < 0 || ptr > 4096; this.ptr = ptr; }
108 self.txout_defn = """public class TxOut extends CommonBase {
109 /** The script_pubkey in this output */
110 public final byte[] script_pubkey;
111 /** The value, in satoshis, of this output */
112 public final long value;
114 TxOut(java.lang.Object _dummy, long ptr) {
116 this.script_pubkey = bindings.TxOut_get_script_pubkey(ptr);
117 this.value = bindings.TxOut_get_value(ptr);
119 public TxOut(long value, byte[] script_pubkey) {
120 super(bindings.TxOut_new(script_pubkey, value));
121 this.script_pubkey = bindings.TxOut_get_script_pubkey(ptr);
122 this.value = bindings.TxOut_get_value(ptr);
125 @Override @SuppressWarnings(\"deprecation\")
126 protected void finalize() throws Throwable {
128 if (ptr != 0) { bindings.TxOut_free(ptr); }
132 self.scalar_defn = """public class BigEndianScalar extends CommonBase {
133 /** The bytes of the scalar value, in big endian */
134 public final byte[] scalar_bytes;
136 BigEndianScalar(java.lang.Object _dummy, long ptr) {
138 this.scalar_bytes = bindings.BigEndianScalar_get_bytes(ptr);
140 public BigEndianScalar(byte[] scalar_bytes) {
141 super(bindings.BigEndianScalar_new(scalar_bytes));
142 this.scalar_bytes = bindings.BigEndianScalar_get_bytes(ptr);
145 @Override @SuppressWarnings(\"deprecation\")
146 protected void finalize() throws Throwable {
148 if (ptr != 0) { bindings.BigEndianScalar_free(ptr); }
153 self.c_file_pfx = """#include <jni.h>
154 // On OSX jlong (ie long long) is not equivalent to int64_t, so we override here
155 #define int64_t jlong
156 #include \"org_ldk_impl_bindings.h\"
157 #include <lightning.h>
159 #include <stdatomic.h>
162 #define LIKELY(v) __builtin_expect(!!(v), 1)
163 #define UNLIKELY(v) __builtin_expect(!!(v), 0)
167 if self.target == Target.ANDROID:
168 self.c_file_pfx = self.c_file_pfx + """
169 #include <android/log.h>
170 #define DEBUG_PRINT(...) __android_log_print(ANDROID_LOG_ERROR, "LDK", __VA_ARGS__)
174 static void* redirect_stderr(void* ignored) {
177 dup2(pipes[1], STDERR_FILENO);
179 memset(buf, 0, 8192);
181 while ((len = read(pipes[0], buf, 8191)) > 0) {
182 DEBUG_PRINT("%s\\n", buf);
183 memset(buf, 0, 8192);
185 DEBUG_PRINT("End of stderr???\\n");
188 void __attribute__((constructor)) spawn_stderr_redirection() {
190 pthread_create(&thread, NULL, &redirect_stderr, NULL);
194 self.c_file_pfx = self.c_file_pfx + "#define DEBUG_PRINT(...) fprintf(stderr, __VA_ARGS__)\n"
196 if not DEBUG or sys.platform == "darwin":
197 self.c_file_pfx = self.c_file_pfx + """#define MALLOC(a, _) malloc(a)
198 #define FREE(p) if ((uint64_t)(p) > 4096) { free(p); }
199 #define CHECK_ACCESS(p)
200 #define CHECK_INNER_FIELD_ACCESS_OR_NULL(v)
203 self.c_file_pfx += """#define DO_ASSERT(a) (void)(a)
207 self.c_file_pfx = self.c_file_pfx + """#include <assert.h>
208 // Always run a, then assert it is true:
209 #define DO_ASSERT(a) do { bool _assert_val = (a); assert(_assert_val); } while(0)
210 // Assert a is true or do nothing
211 #define CHECK(a) DO_ASSERT(a)
213 void __attribute__((constructor)) debug_log_version() {
214 if (check_get_ldk_version() == NULL)
215 DEBUG_PRINT("LDK version did not match the header we built against\\n");
216 if (check_get_ldk_bindings_version() == NULL)
217 DEBUG_PRINT("LDK C Bindings version did not match the header we built against\\n");
221 if sys.platform != "darwin":
222 self.c_file_pfx += """
223 // Running a leak check across all the allocations and frees of the JDK is a mess,
224 // so instead we implement our own naive leak checker here, relying on the -wrap
225 // linker option to wrap malloc/calloc/realloc/free, tracking everyhing allocated
226 // and free'd in Rust or C across the generated bindings shared library.
230 if self.target == Target.ANDROID:
231 self.c_file_pfx = self.c_file_pfx + """
235 // Implement the execinfo functions using _Unwind_backtrace. This seems to miss many Rust
236 // symbols, so we only use it on Android, where execinfo.h is unavailable.
238 struct BacktraceState {
242 static _Unwind_Reason_Code unwind_callback(struct _Unwind_Context* context, void* arg) {
243 struct BacktraceState* state = (struct BacktraceState*)arg;
244 uintptr_t pc = _Unwind_GetIP(context);
246 if (state->current == state->end) {
247 return _URC_END_OF_STACK;
249 *state->current++ = (void*)(pc);
252 return _URC_NO_REASON;
255 int backtrace(void** buffer, int max) {
256 struct BacktraceState state = { buffer, buffer + max };
257 _Unwind_Backtrace(unwind_callback, &state);
258 return state.current - buffer;
261 void backtrace_symbols_fd(void ** buffer, int count, int _fd) {
262 for (int idx = 0; idx < count; ++idx) {
264 if (dladdr(buffer[idx], &info) && info.dli_sname) {
265 DEBUG_PRINT("%p: %s", buffer[idx], info.dli_sname);
267 DEBUG_PRINT("%p: ???", buffer[idx]);
273 self.c_file_pfx = self.c_file_pfx + "#include <execinfo.h>\n"
274 self.c_file_pfx = self.c_file_pfx + """
277 static pthread_mutex_t allocation_mtx;
279 void __attribute__((constructor)) init_mtx() {
280 DO_ASSERT(!pthread_mutex_init(&allocation_mtx, NULL));
284 typedef struct allocation {
285 struct allocation* next;
287 const char* struct_name;
290 unsigned long alloc_len;
292 static allocation* allocation_ll = NULL;
294 void* __real_malloc(size_t len);
295 void* __real_calloc(size_t nmemb, size_t len);
296 static void new_allocation(void* res, const char* struct_name, size_t len) {
297 allocation* new_alloc = __real_malloc(sizeof(allocation));
298 new_alloc->ptr = res;
299 new_alloc->struct_name = struct_name;
300 new_alloc->bt_len = backtrace(new_alloc->bt, BT_MAX);
301 new_alloc->alloc_len = len;
302 DO_ASSERT(!pthread_mutex_lock(&allocation_mtx));
303 new_alloc->next = allocation_ll;
304 allocation_ll = new_alloc;
305 DO_ASSERT(!pthread_mutex_unlock(&allocation_mtx));
307 static void* MALLOC(size_t len, const char* struct_name) {
308 void* res = __real_malloc(len);
309 new_allocation(res, struct_name, len);
312 void __real_free(void* ptr);
313 static void alloc_freed(void* ptr) {
314 allocation* p = NULL;
315 DO_ASSERT(!pthread_mutex_lock(&allocation_mtx));
316 allocation* it = allocation_ll;
317 while (it->ptr != ptr) {
318 p = it; it = it->next;
320 DEBUG_PRINT("ERROR: Tried to free unknown pointer %p at:\\n", ptr);
322 int bt_len = backtrace(bt, BT_MAX);
323 backtrace_symbols_fd(bt, bt_len, STDERR_FILENO);
324 DEBUG_PRINT("\\n\\n");
325 DO_ASSERT(!pthread_mutex_unlock(&allocation_mtx));
326 return; // addrsan should catch malloc-unknown and print more info than we have
329 if (p) { p->next = it->next; } else { allocation_ll = it->next; }
330 DO_ASSERT(!pthread_mutex_unlock(&allocation_mtx));
331 DO_ASSERT(it->ptr == ptr);
334 static void FREE(void* ptr) {
335 if ((uint64_t)ptr <= 4096) return; // Rust loves to create pointers to the NULL page for dummys
340 void* __wrap_malloc(size_t len) {
341 void* res = __real_malloc(len);
342 new_allocation(res, "malloc call", len);
345 void* __wrap_calloc(size_t nmemb, size_t len) {
346 void* res = __real_calloc(nmemb, len);
347 new_allocation(res, "calloc call", len);
350 void __wrap_free(void* ptr) {
351 if (ptr == NULL) return;
356 static void CHECK_ACCESS(const void* ptr) {
357 DO_ASSERT(!pthread_mutex_lock(&allocation_mtx));
358 allocation* it = allocation_ll;
359 while (it->ptr != ptr) {
362 DEBUG_PRINT("ERROR: Tried to access unknown pointer %p at:\\n", ptr);
364 int bt_len = backtrace(bt, BT_MAX);
365 backtrace_symbols_fd(bt, bt_len, STDERR_FILENO);
366 DEBUG_PRINT("\\n\\n");
367 DO_ASSERT(!pthread_mutex_unlock(&allocation_mtx));
368 return; // addrsan should catch and print more info than we have
371 DO_ASSERT(!pthread_mutex_unlock(&allocation_mtx));
373 #define CHECK_INNER_FIELD_ACCESS_OR_NULL(v) \\
374 if (v.is_owned && v.inner != NULL) { \\
375 const void *p = __unmangle_inner_ptr(v.inner); \\
381 void* __real_realloc(void* ptr, size_t newlen);
382 void* __wrap_realloc(void* ptr, size_t len) {
383 if (ptr != NULL) alloc_freed(ptr);
384 void* res = __real_realloc(ptr, len);
385 new_allocation(res, "realloc call", len);
388 void __wrap_reallocarray(void* ptr, size_t new_sz) {
389 // Rust doesn't seem to use reallocarray currently
393 void __attribute__((destructor)) check_leaks() {
394 unsigned long alloc_count = 0;
395 unsigned long alloc_size = 0;
396 DEBUG_PRINT("The following LDK-allocated blocks still remain.\\n");
397 DEBUG_PRINT("Note that this is only accurate if System.gc(); System.runFinalization()\\n");
398 DEBUG_PRINT("was called prior to exit after all LDK objects were out of scope.\\n");
399 for (allocation* a = allocation_ll; a != NULL; a = a->next) {
400 DEBUG_PRINT("%s %p (%lu bytes) remains:\\n", a->struct_name, a->ptr, a->alloc_len);
401 backtrace_symbols_fd(a->bt, a->bt_len, STDERR_FILENO);
402 DEBUG_PRINT("\\n\\n");
404 alloc_size += a->alloc_len;
406 DEBUG_PRINT("%lu allocations remained for %lu bytes.\\n", alloc_count, alloc_size);
407 DEBUG_PRINT("Note that this is only accurate if System.gc(); System.runFinalization()\\n");
408 DEBUG_PRINT("was called prior to exit after all LDK objects were out of scope.\\n");
411 self.c_file_pfx = self.c_file_pfx + """
412 static jmethodID ordinal_meth = NULL;
413 JNIEXPORT void Java_org_ldk_impl_bindings_init(JNIEnv * env, jclass _b, jclass enum_class) {
414 ordinal_meth = (*env)->GetMethodID(env, enum_class, "ordinal", "()I");
415 CHECK(ordinal_meth != NULL);
418 // We assume that CVec_u8Z and u8slice are the same size and layout (and thus pointers to the two can be mixed)
419 _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKu8slice), "Vec<u8> and [u8] need to have been mapped identically");
420 _Static_assert(offsetof(LDKCVec_u8Z, data) == offsetof(LDKu8slice, data), "Vec<u8> and [u8] need to have been mapped identically");
421 _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKu8slice, datalen), "Vec<u8> and [u8] need to have been mapped identically");
423 _Static_assert(sizeof(jlong) == sizeof(int64_t), "We assume that j-types are the same as C types");
424 _Static_assert(sizeof(jbyte) == sizeof(char), "We assume that j-types are the same as C types");
425 _Static_assert(sizeof(void*) <= 8, "Pointers must fit into 64 bits");
427 typedef jlongArray int64_tArray;
428 typedef jbyteArray int8_tArray;
429 typedef jshortArray int16_tArray;
431 static inline jstring str_ref_to_java(JNIEnv *env, const char* chars, size_t len) {
432 // Sadly we need to create a temporary because Java can't accept a char* without a 0-terminator
433 char* conv_buf = MALLOC(len + 1, "str conv buf");
434 memcpy(conv_buf, chars, len);
436 jstring ret = (*env)->NewStringUTF(env, conv_buf);
440 static inline LDKStr java_to_owned_str(JNIEnv *env, jstring str) {
441 uint64_t str_len = (*env)->GetStringUTFLength(env, str);
442 char* newchars = MALLOC(str_len + 1, "String chars");
443 const char* jchars = (*env)->GetStringUTFChars(env, str, NULL);
444 memcpy(newchars, jchars, str_len);
445 newchars[str_len] = 0;
446 (*env)->ReleaseStringUTFChars(env, str, jchars);
450 .chars_is_owned = true
455 JNIEXPORT jstring JNICALL Java_org_ldk_impl_bindings_get_1ldk_1c_1bindings_1version(JNIEnv *env, jclass _c) {
456 return str_ref_to_java(env, check_get_ldk_bindings_version(), strlen(check_get_ldk_bindings_version()));
458 JNIEXPORT jstring JNICALL Java_org_ldk_impl_bindings_get_1ldk_1version(JNIEnv *env, jclass _c) {
459 return str_ref_to_java(env, check_get_ldk_version(), strlen(check_get_ldk_version()));
463 self.c_version_file = """JNIEXPORT jstring JNICALL Java_org_ldk_impl_bindings_get_1lib_1version_1string(JNIEnv *env, jclass _c) {
464 return str_ref_to_java(env, "<git_version_ldk_garbagecollected>", strlen("<git_version_ldk_garbagecollected>"));
467 self.hu_struct_file_prefix = """package org.ldk.structs;
469 import org.ldk.impl.bindings;
470 import org.ldk.enums.*;
471 import org.ldk.util.*;
472 import java.util.Arrays;
473 import java.lang.ref.Reference;
474 import javax.annotation.Nullable;
477 self.hu_struct_file_suffix = ""
478 self.c_fn_ty_pfx = "JNIEXPORT "
479 self.c_fn_args_pfx = "JNIEnv *env, jclass clz"
480 self.file_ext = ".java"
481 self.ptr_c_ty = "int64_t"
482 self.ptr_native_ty = "long"
483 self.u128_native_ty = "UInt128"
484 self.usize_c_ty = "int64_t"
485 self.usize_native_ty = "long"
486 self.native_zero_ptr = "0"
487 self.result_c_ty = "jclass"
488 self.ptr_arr = "jobjectArray"
489 self.is_arr_some_check = ("", " != NULL")
490 self.get_native_arr_len_call = ("(*env)->GetArrayLength(env, ", ")")
492 def bindings_footer(self):
495 def construct_jenv(self):
496 res = "JNIEnv *env;\n"
497 res += "jint get_jenv_res = (*j_calls->vm)->GetEnv(j_calls->vm, (void**)&env, JNI_VERSION_1_6);\n"
498 res += "if (get_jenv_res == JNI_EDETACHED) {\n"
499 if self.target == Target.ANDROID:
500 res += "\tDO_ASSERT((*j_calls->vm)->AttachCurrentThread(j_calls->vm, &env, NULL) == JNI_OK);\n"
502 res += "\tDO_ASSERT((*j_calls->vm)->AttachCurrentThread(j_calls->vm, (void**)&env, NULL) == JNI_OK);\n"
504 res += "\tDO_ASSERT(get_jenv_res == JNI_OK);\n"
507 def deconstruct_jenv(self):
508 res = "if (get_jenv_res == JNI_EDETACHED) {\n"
509 res += "\tDO_ASSERT((*j_calls->vm)->DetachCurrentThread(j_calls->vm) == JNI_OK);\n"
513 def release_native_arr_ptr_call(self, ty_info, arr_var, arr_ptr_var):
514 if ty_info.subty is None or not ty_info.subty.c_ty.endswith("Array"):
515 return "(*env)->ReleasePrimitiveArrayCritical(env, " + arr_var + ", " + arr_ptr_var + ", 0)"
517 def create_native_arr_call(self, arr_len, ty_info):
518 if ty_info.c_ty == "int8_tArray":
519 return "(*env)->NewByteArray(env, " + arr_len + ")"
520 elif ty_info.subty.c_ty.endswith("Array"):
521 clz_var = ty_info.java_fn_ty_arg[1:].replace("[", "arr_of_")
522 self.c_array_class_caches.add(clz_var)
523 return "(*env)->NewObjectArray(env, " + arr_len + ", " + clz_var + "_clz, NULL);\n"
525 return "(*env)->New" + ty_info.java_ty.strip("[]").title() + "Array(env, " + arr_len + ")"
526 def set_native_arr_contents(self, arr_name, arr_len, ty_info):
527 if ty_info.c_ty == "int8_tArray":
528 return ("(*env)->SetByteArrayRegion(env, " + arr_name + ", 0, " + arr_len + ", ", ")")
529 elif ty_info.c_ty == "int16_tArray":
530 return ("(*env)->SetShortArrayRegion(env, " + arr_name + ", 0, " + arr_len + ", ", ")")
533 def get_native_arr_contents(self, arr_name, dest_name, arr_len, ty_info, copy):
534 if ty_info.c_ty == "int8_tArray" or ty_info.c_ty == "int16_tArray":
535 fn_ty = "Byte" if ty_info.c_ty == "int8_tArray" else "Short"
537 return "(*env)->Get" + fn_ty + "ArrayRegion(env, " + arr_name + ", 0, " + arr_len + ", " + dest_name + ")"
539 return "(*env)->Get" + fn_ty + "ArrayElements (env, " + arr_name + ", NULL)"
540 elif not ty_info.java_ty[:len(ty_info.java_ty) - 2].endswith("[]"):
541 return "(*env)->Get" + ty_info.subty.java_ty.title() + "ArrayElements (env, " + arr_name + ", NULL)"
544 def get_native_arr_elem(self, arr_name, idxc, ty_info):
545 if self.get_native_arr_contents(arr_name, "", "", ty_info, False) is None:
546 return "(*env)->GetObjectArrayElement(env, " + arr_name + ", " + idxc + ")"
548 assert False # Only called if above is None
549 def get_native_arr_ptr_call(self, ty_info):
550 if ty_info.subty is not None and ty_info.subty.c_ty.endswith("Array"):
552 return ("(*env)->GetPrimitiveArrayCritical(env, ", ", NULL)")
553 def get_native_arr_entry_call(self, ty_info, arr_name, idxc, entry_access):
554 if ty_info.subty is None or not ty_info.subty.c_ty.endswith("Array"):
556 return "(*env)->SetObjectArrayElement(env, " + arr_name + ", " + idxc + ", " + entry_access + ")"
557 def cleanup_native_arr_ref_contents(self, arr_name, dest_name, arr_len, ty_info):
558 if ty_info.c_ty == "int8_tArray":
559 return "(*env)->ReleaseByteArrayElements(env, " + arr_name + ", (int8_t*)" + dest_name + ", 0);"
561 return "(*env)->Release" + ty_info.java_ty.strip("[]").title() + "ArrayElements(env, " + arr_name + ", " + dest_name + ", 0)"
563 def map_hu_array_elems(self, arr_name, conv_name, arr_ty, elem_ty):
564 if elem_ty.java_ty == "long" and elem_ty.java_hu_ty != "long":
565 return arr_name + " != null ? Arrays.stream(" + arr_name + ").mapToLong(" + conv_name + " -> " + elem_ty.from_hu_conv[0] + ").toArray() : null"
566 elif elem_ty.java_ty == "long":
567 return arr_name + " != null ? Arrays.stream(" + arr_name + ").map(" + conv_name + " -> " + elem_ty.from_hu_conv[0] + ").toArray() : null"
568 elif elem_ty.java_hu_ty == "UInt5":
569 return arr_name + " != null ? InternalUtils.convUInt5Array(" + arr_name + ") : null"
570 elif elem_ty.java_hu_ty == "WitnessVersion":
571 return arr_name + " != null ? InternalUtils.convWitnessVersionArray(" + arr_name + ") : null"
573 return arr_name + " != null ? Arrays.stream(" + arr_name + ").map(" + conv_name + " -> " + elem_ty.from_hu_conv[0] + ").toArray(" + arr_ty.java_ty + "::new) : null"
575 def str_ref_to_native_call(self, var_name, str_len):
576 return "str_ref_to_java(env, " + var_name + ", " + str_len + ")"
577 def str_ref_to_c_call(self, var_name):
578 return "java_to_owned_str(env, " + var_name + ")"
579 def str_to_hu_conv(self, var_name):
581 def str_from_hu_conv(self, var_name):
584 def c_fn_name_define_pfx(self, fn_name, has_args):
586 return "JNICALL Java_org_ldk_impl_bindings_" + fn_name.replace("_", "_1") + "(JNIEnv *env, jclass clz, "
587 return "JNICALL Java_org_ldk_impl_bindings_" + fn_name.replace("_", "_1") + "(JNIEnv *env, jclass clz"
591 for ty in sorted(self.c_array_class_caches):
592 res = res + "static jclass " + ty + "_clz = NULL;\n"
593 res = res + "JNIEXPORT void Java_org_ldk_impl_bindings_init_1class_1cache(JNIEnv * env, jclass clz) {\n"
594 for ty in sorted(self.c_array_class_caches):
595 res = res + "\t" + ty + "_clz = (*env)->FindClass(env, \"" + ty.replace("arr_of_", "[") + "\");\n"
596 res = res + "\tCHECK(" + ty + "_clz != NULL);\n"
597 res = res + "\t" + ty + "_clz = (*env)->NewGlobalRef(env, " + ty + "_clz);\n"
601 def var_decl_statement(self, ty_string, var_name, statement):
602 return ty_string + " " + var_name + " = " + statement
604 def get_java_arr_len(self, arr_name):
605 return arr_name + ".length"
606 def get_java_arr_elem(self, elem_ty, arr_name, idx):
607 return arr_name + "[" + idx + "]"
608 def constr_hu_array(self, ty_info, arr_len):
609 base_ty = ty_info.subty.java_hu_ty.split("[")[0].split("<")[0]
610 conv = "new " + base_ty + "[" + arr_len + "]"
611 if "[" in ty_info.subty.java_hu_ty.split("<")[0]:
612 # Do a bit of a dance to move any excess [] to the end
613 conv += "[" + ty_info.subty.java_hu_ty.split("<")[0].split("[")[1]
615 def cleanup_converted_native_array(self, ty_info, arr_name):
618 def primitive_arr_from_hu(self, arr_ty, fixed_len, arr_name):
619 mapped_ty = arr_ty.subty
620 if arr_ty.rust_obj == "LDKU128":
621 return ("" + arr_name + ".getLEBytes()", "")
622 if fixed_len is not None:
623 if mapped_ty.c_ty == "int8_t" or mapped_ty.c_ty == "uint8_t":
624 return ("InternalUtils.check_arr_len(" + arr_name + ", " + fixed_len + ")", "")
625 elif mapped_ty.c_ty == "int16_t" or mapped_ty.c_ty == "uint16_t":
626 return ("InternalUtils.check_arr_16_len(" + arr_name + ", " + fixed_len + ")", "")
631 def primitive_arr_to_hu(self, arr_ty, fixed_len, arr_name, conv_name):
632 if arr_ty.rust_obj == "LDKU128":
633 return "org.ldk.util.UInt128 " + conv_name + " = new org.ldk.util.UInt128(" + arr_name + ");"
636 def java_arr_ty_str(self, elem_ty_str):
637 return elem_ty_str + "[]"
639 def for_n_in_range(self, n, minimum, maximum):
640 return "for (int " + n + " = " + minimum + "; " + n + " < " + maximum + "; " + n + "++) {"
641 def for_n_in_arr(self, n, arr_name, arr_elem_ty):
642 return ("for (" + arr_elem_ty.java_hu_ty + " " + n + ": " + arr_name + ") { ", " }")
644 def get_ptr(self, var):
646 def set_null_skip_free(self, var):
647 return var + ".ptr" + " = 0;"
649 def add_ref(self, holder, referent):
650 return "if (" + holder + " != null) { " + holder + ".ptrs_to.add(" + referent + "); }"
652 def fully_qualified_hu_ty_path(self, ty):
653 if ty.java_fn_ty_arg.startswith("L") and ty.java_fn_ty_arg.endswith(";"):
654 return ty.java_fn_ty_arg.strip("L;").replace("/", ".")
655 if ty.java_hu_ty == "UnqualifiedError" or ty.java_hu_ty == "UInt128" or ty.java_hu_ty == "UInt5" or ty.java_hu_ty == "WitnessVersion":
656 return "org.ldk.util." + ty.java_hu_ty
657 if not ty.is_native_primitive and ty.rust_obj is not None and not "[]" in ty.java_hu_ty:
658 return "org.ldk.structs." + ty.java_hu_ty
661 def native_c_unitary_enum_map(self, struct_name, variants, enum_doc_comment):
662 out_java_enum = "package org.ldk.enums;\n\n"
665 out_c += "static inline LDK" + struct_name + " LDK" + struct_name + "_from_java(" + self.c_fn_args_pfx + ") {\n"
666 out_c += "\tjint ord = (*env)->CallIntMethod(env, clz, ordinal_meth);\n"
667 out_c += "\tif (UNLIKELY((*env)->ExceptionCheck(env))) {\n"
668 out_c += "\t\t(*env)->ExceptionDescribe(env);\n"
669 out_c += "\t\t(*env)->FatalError(env, \"A call to " + struct_name + ".ordinal() from rust threw an exception.\");\n"
671 out_c += "\tswitch (ord) {\n"
673 if enum_doc_comment is not None:
674 out_java_enum += "/**\n * " + enum_doc_comment.replace("\n", "\n * ") + "\n */\n"
675 out_java_enum += "public enum " + struct_name + " {\n"
677 for var, var_docs in variants:
678 if var_docs is not None:
679 out_java_enum += "\t/**\n\t * " + var_docs.replace("\n", "\n\t * ") + "\n\t */\n"
680 out_java_enum += "\t" + var + ",\n"
681 out_c = out_c + "\t\tcase %d: return %s;\n" % (ord_v, var)
683 out_java_enum = out_java_enum + "\t; static native void init();\n"
684 out_java_enum = out_java_enum + "\tstatic { init(); }\n"
685 out_java_enum = out_java_enum + "}"
686 out_java = out_java + "\tstatic { " + struct_name + ".values(); /* Force enum statics to run */ }\n"
688 out_c += "\t(*env)->FatalError(env, \"A call to " + struct_name + ".ordinal() from rust returned an invalid value.\");\n"
689 out_c += "\tabort(); // Unreachable, but will let the compiler know we don't return here\n"
692 out_c = out_c + "static jclass " + struct_name + "_class = NULL;\n"
693 for var, _ in variants:
694 out_c = out_c + "static jfieldID " + struct_name + "_" + var + " = NULL;\n"
695 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"
696 out_c = out_c + "\t" + struct_name + "_class = (*env)->NewGlobalRef(env, clz);\n"
697 out_c = out_c + "\tCHECK(" + struct_name + "_class != NULL);\n"
698 for var, _ in variants:
699 out_c = out_c + "\t" + struct_name + "_" + var + " = (*env)->GetStaticFieldID(env, " + struct_name + "_class, \"" + var + "\", \"Lorg/ldk/enums/" + struct_name + ";\");\n"
700 out_c = out_c + "\tCHECK(" + struct_name + "_" + var + " != NULL);\n"
701 out_c = out_c + "}\n"
702 out_c = out_c + "static inline jclass LDK" + struct_name + "_to_java(JNIEnv *env, LDK" + struct_name + " val) {\n"
703 out_c = out_c + "\tswitch (val) {\n"
705 for var, _ in variants:
706 out_c = out_c + "\t\tcase " + var + ":\n"
707 out_c = out_c + "\t\t\treturn (*env)->GetStaticObjectField(env, " + struct_name + "_class, " + struct_name + "_" + var + ");\n"
709 out_c = out_c + "\t\tdefault: abort();\n"
710 out_c = out_c + "\t}\n"
711 out_c = out_c + "}\n\n"
713 return (out_c, out_java_enum, out_java)
715 def c_unitary_enum_to_native_call(self, ty_info):
716 return (ty_info.rust_obj + "_to_java(env, ", ")")
717 def native_unitary_enum_to_c_call(self, ty_info):
718 return (ty_info.rust_obj + "_from_java(env, ", ")")
720 def c_complex_enum_pfx(self, struct_name, variants, init_meth_jty_strs):
723 out_c = out_c + "static jclass " + struct_name + "_" + var + "_class = NULL;\n"
724 out_c = out_c + "static jmethodID " + struct_name + "_" + var + "_meth = NULL;\n"
725 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"
726 for var_name in variants:
727 out_c += "\t" + struct_name + "_" + var_name + "_class =\n"
728 out_c += "\t\t(*env)->NewGlobalRef(env, (*env)->FindClass(env, \"org/ldk/impl/bindings$" + struct_name + "$" + var_name + "\"));\n"
729 out_c += "\tCHECK(" + struct_name + "_" + var_name + "_class != NULL);\n"
730 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"
731 out_c += "\tCHECK(" + struct_name + "_" + var_name + "_meth != NULL);\n"
732 out_c = out_c + "}\n"
735 def c_complex_enum_pass_ty(self, struct_name):
738 def c_constr_native_complex_enum(self, struct_name, variant, c_params):
739 ret = "(*env)->NewObject(env, " + struct_name + "_" + variant + "_class, " + struct_name + "_" + variant + "_meth"
740 for param in c_params:
741 ret = ret + ", " + param
744 def native_c_map_trait(self, struct_name, field_vars, flattened_field_vars, field_fns, trait_doc_comment):
748 # First generate most of the Java code, note that we need information about java method argument strings for C
749 out_java_trait = out_java_trait + self.hu_struct_file_prefix
750 if trait_doc_comment is not None:
751 out_java_trait += "/**\n * " + trait_doc_comment.replace("\n", "\n * ") + "\n */\n"
752 out_java_trait += "@SuppressWarnings(\"unchecked\") // We correctly assign various generic arrays\n"
753 out_java_trait = out_java_trait + "public class " + struct_name.replace("LDK","") + " extends CommonBase {\n"
754 out_java_trait = out_java_trait + "\tfinal bindings." + struct_name + " bindings_instance;\n"
755 out_java_trait = out_java_trait + "\t" + struct_name.replace("LDK", "") + "(Object _dummy, long ptr) { super(ptr); bindings_instance = null; }\n"
756 out_java_trait = out_java_trait + "\tprivate " + struct_name.replace("LDK", "") + "(bindings." + struct_name + " arg"
757 for var in flattened_field_vars:
758 if isinstance(var, ConvInfo):
759 out_java_trait = out_java_trait + ", " + var.java_hu_ty + " " + var.arg_name
761 out_java_trait = out_java_trait + ", bindings." + var[0] + " " + var[1]
762 out_java_trait = out_java_trait + ") {\n"
763 out_java_trait = out_java_trait + "\t\tsuper(bindings." + struct_name + "_new(arg"
764 for var in flattened_field_vars:
765 if isinstance(var, ConvInfo):
766 if var.from_hu_conv is not None:
767 out_java_trait = out_java_trait + ", " + var.from_hu_conv[0]
769 out_java_trait = out_java_trait + ", " + var.arg_name
771 out_java_trait = out_java_trait + ", " + var[1]
772 out_java_trait = out_java_trait + "));\n"
773 out_java_trait = out_java_trait + "\t\tthis.ptrs_to.add(arg);\n"
774 for var in flattened_field_vars:
775 if isinstance(var, ConvInfo):
776 if var.from_hu_conv is not None and var.from_hu_conv[1] != "":
777 out_java_trait = out_java_trait + "\t\t" + var.from_hu_conv[1].replace("\n", "\n\t\t") + ";\n"
779 out_java_trait = out_java_trait + "\t\tthis.ptrs_to.add(" + var[1] + ");\n"
780 out_java_trait += f""" this.bindings_instance = arg;
782 @Override @SuppressWarnings("deprecation")
783 protected void finalize() throws Throwable {{
784 if (ptr != 0) {{ bindings.{struct_name.replace("LDK","")}_free(ptr); }} super.finalize();
787 * Destroys the object, freeing associated resources. After this call, any access
788 * to this object may result in a SEGFAULT or worse.
790 * You should generally NEVER call this method. You should let the garbage collector
791 * do this for you when it finalizes objects. However, it may be useful for types
792 * which represent locks and should be closed immediately to avoid holding locks
795 public void destroy() {{
796 if (ptr != 0) {{ bindings.{struct_name.replace("LDK","")}_free(ptr); }}
801 java_trait_constr = "\tprivate static class " + struct_name + "Holder { " + struct_name.replace("LDK", "") + " held; }\n"
802 java_trait_constr = java_trait_constr + "\tpublic static " + struct_name.replace("LDK", "") + " new_impl(" + struct_name.replace("LDK", "") + "Interface arg"
803 for var in flattened_field_vars:
804 if isinstance(var, ConvInfo):
805 java_trait_constr = java_trait_constr + ", " + var.java_hu_ty + " " + var.arg_name
807 # Ideally we'd be able to take any instance of the interface, but our C code can only represent
808 # Java-implemented version, so we require users pass a Java implementation here :/
809 java_trait_constr = java_trait_constr + ", " + var[0].replace("LDK", "") + "." + var[0].replace("LDK", "") + "Interface " + var[1] + "_impl"
810 java_trait_constr = java_trait_constr + ") {\n\t\tfinal " + struct_name + "Holder impl_holder = new " + struct_name + "Holder();\n"
811 java_trait_constr = java_trait_constr + "\t\timpl_holder.held = new " + struct_name.replace("LDK", "") + "(new bindings." + struct_name + "() {\n"
812 out_java_trait = out_java_trait + "\tpublic static interface " + struct_name.replace("LDK", "") + "Interface {\n"
813 out_java = out_java + "\tpublic interface " + struct_name + " {\n"
815 for fn_line in field_fns:
816 java_meth_descr = "("
817 if fn_line.fn_name != "free" and fn_line.fn_name != "cloned":
818 out_java = out_java + "\t\t " + fn_line.ret_ty_info.java_ty + " " + fn_line.fn_name + "("
819 java_trait_constr = java_trait_constr + "\t\t\t@Override public " + fn_line.ret_ty_info.java_ty + " " + fn_line.fn_name + "("
820 out_java_trait += "\t\t/**\n\t\t * " + fn_line.docs.replace("\n", "\n\t\t * ") + "\n\t\t */\n"
821 out_java_trait = out_java_trait + "\t\t" + fn_line.ret_ty_info.java_hu_ty + " " + fn_line.fn_name + "("
823 for idx, arg_conv_info in enumerate(fn_line.args_ty):
825 out_java = out_java + ", "
826 java_trait_constr = java_trait_constr + ", "
827 out_java_trait = out_java_trait + ", "
828 out_java = out_java + arg_conv_info.java_ty + " " + arg_conv_info.arg_name
829 out_java_trait = out_java_trait + arg_conv_info.java_hu_ty + " " + arg_conv_info.arg_name
830 java_trait_constr = java_trait_constr + arg_conv_info.java_ty + " " + arg_conv_info.arg_name
831 java_meth_descr = java_meth_descr + arg_conv_info.java_fn_ty_arg
832 java_meth_descr = java_meth_descr + ")" + fn_line.ret_ty_info.java_fn_ty_arg
833 java_meths.append((fn_line.fn_name, java_meth_descr))
835 out_java = out_java + ");\n"
836 out_java_trait = out_java_trait + ");\n"
837 java_trait_constr = java_trait_constr + ") {\n"
839 for arg_info in fn_line.args_ty:
840 if arg_info.to_hu_conv is not None:
841 java_trait_constr = java_trait_constr + "\t\t\t\t" + arg_info.to_hu_conv.replace("\n", "\n\t\t\t\t") + "\n"
843 if fn_line.ret_ty_info.java_ty != "void":
844 java_trait_constr = java_trait_constr + "\t\t\t\t" + fn_line.ret_ty_info.java_hu_ty + " ret = arg." + fn_line.fn_name + "("
846 java_trait_constr = java_trait_constr + "\t\t\t\targ." + fn_line.fn_name + "("
848 for idx, arg_info in enumerate(fn_line.args_ty):
850 java_trait_constr = java_trait_constr + ", "
851 if arg_info.to_hu_conv_name is not None:
852 java_trait_constr = java_trait_constr + arg_info.to_hu_conv_name
854 java_trait_constr = java_trait_constr + arg_info.arg_name
856 java_trait_constr += ");\n"
857 java_trait_constr += "\t\t\t\tReference.reachabilityFence(arg);\n"
858 if fn_line.ret_ty_info.java_ty != "void":
859 if fn_line.ret_ty_info.from_hu_conv is not None:
860 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"
861 if fn_line.ret_ty_info.from_hu_conv[1] != "":
862 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"
863 #if fn_line.ret_ty_info.rust_obj in result_types:
864 java_trait_constr = java_trait_constr + "\t\t\t\treturn result;\n"
866 java_trait_constr = java_trait_constr + "\t\t\t\treturn ret;\n"
867 java_trait_constr = java_trait_constr + "\t\t\t}\n"
868 java_trait_constr = java_trait_constr + "\t\t}"
869 for var in field_vars:
870 if isinstance(var, ConvInfo):
871 java_trait_constr = java_trait_constr + ", " + var.arg_name
873 java_trait_constr += ", " + var[1] + ".new_impl(" + var[1] + "_impl"
875 for suparg in var[2]:
876 if isinstance(suparg, ConvInfo):
877 suptrait_constr += ", " + suparg.arg_name
879 suptrait_constr += ", " + suparg[1] + "_impl"
880 java_trait_constr += suptrait_constr + ").bindings_instance"
881 for suparg in var[2]:
882 if isinstance(suparg, ConvInfo):
883 java_trait_constr += ", " + suparg.arg_name
885 java_trait_constr += ", " + suparg[1] + ".new_impl("
886 # Blindly assume that we can just strip the first arg to build the args for the supertrait
887 java_trait_constr += suptrait_constr.split(", ", 1)[1]
888 java_trait_constr += ").bindings_instance"
889 out_java_trait = out_java_trait + "\t}\n"
890 out_java_trait = out_java_trait + java_trait_constr + ");\n\t\treturn impl_holder.held;\n\t}\n"
892 out_java = out_java + "\t}\n"
894 out_java = out_java + "\tpublic static native long " + struct_name + "_new(" + struct_name + " impl"
895 for var in flattened_field_vars:
896 if isinstance(var, ConvInfo):
897 out_java = out_java + ", " + var.java_ty + " " + var.arg_name
899 out_java = out_java + ", " + var[0] + " " + var[1]
900 out_java = out_java + ");\n"
902 # Now that we've written out our java code (and created java_meths), generate C
903 out_c = "typedef struct " + struct_name + "_JCalls {\n"
904 out_c = out_c + "\tatomic_size_t refcnt;\n"
905 out_c = out_c + "\tJavaVM *vm;\n"
906 out_c = out_c + "\tjweak o;\n"
907 for var in flattened_field_vars:
908 if isinstance(var, ConvInfo):
909 # We're a regular ol' field
913 out_c = out_c + "\t" + var[0] + "_JCalls* " + var[1] + ";\n"
915 if fn.fn_name != "free" and fn.fn_name != "cloned":
916 out_c = out_c + "\tjmethodID " + fn.fn_name + "_meth;\n"
917 out_c = out_c + "} " + struct_name + "_JCalls;\n"
919 for fn_line in field_fns:
920 if fn_line.fn_name == "free":
921 out_c = out_c + "static void " + struct_name + "_JCalls_free(void* this_arg) {\n"
922 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) this_arg;\n"
923 out_c = out_c + "\tif (atomic_fetch_sub_explicit(&j_calls->refcnt, 1, memory_order_acquire) == 1) {\n"
924 out_c += "\t\t" + self.construct_jenv().replace("\n", "\n\t\t").strip() + "\n"
925 out_c = out_c + "\t\t(*env)->DeleteWeakGlobalRef(env, j_calls->o);\n"
926 out_c += "\t\t" + self.deconstruct_jenv().replace("\n", "\n\t\t").strip() + "\n"
927 out_c = out_c + "\t\tFREE(j_calls);\n"
928 out_c = out_c + "\t}\n}\n"
930 for idx, fn_line in enumerate(field_fns):
931 if fn_line.fn_name != "free" and fn_line.fn_name != "cloned":
932 assert fn_line.ret_ty_info.ty_info.get_full_rust_ty()[1] == ""
933 out_c = out_c + fn_line.ret_ty_info.ty_info.get_full_rust_ty()[0] + " " + fn_line.fn_name + "_" + struct_name + "_jcall("
934 if fn_line.self_is_const:
935 out_c = out_c + "const void* this_arg"
937 out_c = out_c + "void* this_arg"
939 for idx, arg in enumerate(fn_line.args_ty):
940 out_c = out_c + ", " + arg.ty_info.get_full_rust_ty()[0] + " " + arg.arg_name + arg.ty_info.get_full_rust_ty()[1]
942 out_c = out_c + ") {\n"
943 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) this_arg;\n"
944 out_c += "\t" + self.construct_jenv().replace("\n", "\n\t").strip() + "\n"
946 for arg_info in fn_line.args_ty:
947 if arg_info.ret_conv is not None:
948 out_c = out_c + "\t" + arg_info.ret_conv[0].replace('\n', '\n\t')
949 out_c = out_c + arg_info.arg_name
950 out_c = out_c + arg_info.ret_conv[1].replace('\n', '\n\t') + "\n"
952 out_c = out_c + "\tjobject obj = (*env)->NewLocalRef(env, j_calls->o);\n\tCHECK(obj != NULL);\n"
953 if fn_line.ret_ty_info.c_ty.endswith("Array"):
954 out_c = out_c + "\t" + fn_line.ret_ty_info.c_ty + " ret = (*env)->CallObjectMethod(env, obj, j_calls->" + fn_line.fn_name + "_meth"
955 elif fn_line.ret_ty_info.c_ty == "void":
956 out_c += "\t(*env)->CallVoidMethod(env, obj, j_calls->" + fn_line.fn_name + "_meth"
957 elif fn_line.ret_ty_info.java_hu_ty == "String" or "org/ldk/enums" in fn_line.ret_ty_info.java_fn_ty_arg:
958 # Manually write out String methods as they're just an Object
959 out_c += "\t" + fn_line.ret_ty_info.c_ty + " ret = (*env)->CallObjectMethod(env, obj, j_calls->" + fn_line.fn_name + "_meth"
960 elif not fn_line.ret_ty_info.passed_as_ptr:
961 out_c += "\t" + fn_line.ret_ty_info.c_ty + " ret = (*env)->Call" + fn_line.ret_ty_info.java_ty.title() + "Method(env, obj, j_calls->" + fn_line.fn_name + "_meth"
963 out_c = out_c + "\tuint64_t ret = (*env)->CallLongMethod(env, obj, j_calls->" + fn_line.fn_name + "_meth"
965 for idx, arg_info in enumerate(fn_line.args_ty):
966 if arg_info.ret_conv is not None:
967 out_c = out_c + ", " + arg_info.ret_conv_name
969 out_c = out_c + ", " + arg_info.arg_name
970 out_c = out_c + ");\n"
972 out_c += "\tif (UNLIKELY((*env)->ExceptionCheck(env))) {\n"
973 out_c += "\t\t(*env)->ExceptionDescribe(env);\n"
974 out_c += "\t\t(*env)->FatalError(env, \"A call to " + fn_line.fn_name + " in " + struct_name + " from rust threw an exception.\");\n"
977 if fn_line.ret_ty_info.arg_conv is not None:
978 out_c += "\t" + fn_line.ret_ty_info.arg_conv.replace("\n", "\n\t") + "\n"
979 out_c += "\t" + self.deconstruct_jenv().replace("\n", "\n\t").strip() + "\n"
980 out_c += "\treturn " + fn_line.ret_ty_info.arg_conv_name + ";\n"
982 out_c += "\t" + self.deconstruct_jenv().replace("\n", "\n\t").strip() + "\n"
983 if not fn_line.ret_ty_info.passed_as_ptr and fn_line.ret_ty_info.c_ty != "void":
984 out_c += "\treturn ret;\n"
986 out_c = out_c + "}\n"
988 # If we can, write out a clone function whether we need one or not, as we use them in moving to rust
989 can_clone_with_ptr = True
990 for var in field_vars:
991 if isinstance(var, ConvInfo):
992 can_clone_with_ptr = False
993 if can_clone_with_ptr:
994 out_c = out_c + "static void " + struct_name + "_JCalls_cloned(" + struct_name + "* new_obj) {\n"
995 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) new_obj->this_arg;\n"
996 out_c = out_c + "\tatomic_fetch_add_explicit(&j_calls->refcnt, 1, memory_order_release);\n"
997 for var in flattened_field_vars:
998 if not isinstance(var, ConvInfo):
999 out_c = out_c + "\tatomic_fetch_add_explicit(&j_calls->" + var[2].replace(".", "->") + "->refcnt, 1, memory_order_release);\n"
1000 out_c = out_c + "}\n"
1002 out_c = out_c + "static inline " + struct_name + " " + struct_name + "_init (" + self.c_fn_args_pfx + ", jobject o"
1003 for var in flattened_field_vars:
1004 if isinstance(var, ConvInfo):
1005 out_c = out_c + ", " + var.c_ty + " " + var.arg_name
1007 out_c = out_c + ", jobject " + var[1]
1008 out_c = out_c + ") {\n"
1010 out_c = out_c + "\tjclass c = (*env)->GetObjectClass(env, o);\n"
1011 out_c = out_c + "\tCHECK(c != NULL);\n"
1012 out_c = out_c + "\t" + struct_name + "_JCalls *calls = MALLOC(sizeof(" + struct_name + "_JCalls), \"" + struct_name + "_JCalls\");\n"
1013 out_c = out_c + "\tatomic_init(&calls->refcnt, 1);\n"
1014 out_c = out_c + "\tDO_ASSERT((*env)->GetJavaVM(env, &calls->vm) == 0);\n"
1015 out_c = out_c + "\tcalls->o = (*env)->NewWeakGlobalRef(env, o);\n"
1017 for (fn_name, java_meth_descr) in java_meths:
1018 if fn_name != "free" and fn_name != "cloned":
1019 out_c = out_c + "\tcalls->" + fn_name + "_meth = (*env)->GetMethodID(env, c, \"" + fn_name + "\", \"" + java_meth_descr + "\");\n"
1020 out_c = out_c + "\tCHECK(calls->" + fn_name + "_meth != NULL);\n"
1022 for var in flattened_field_vars:
1023 if isinstance(var, ConvInfo) and var.arg_conv is not None:
1024 out_c = out_c + "\n\t" + var.arg_conv.replace("\n", "\n\t") +"\n"
1025 out_c = out_c + "\n\t" + struct_name + " ret = {\n"
1026 out_c = out_c + "\t\t.this_arg = (void*) calls,\n"
1027 for fn_line in field_fns:
1028 if fn_line.fn_name != "free" and fn_line.fn_name != "cloned":
1029 out_c = out_c + "\t\t." + fn_line.fn_name + " = " + fn_line.fn_name + "_" + struct_name + "_jcall,\n"
1030 elif fn_line.fn_name == "free":
1031 out_c = out_c + "\t\t.free = " + struct_name + "_JCalls_free,\n"
1033 out_c = out_c + "\t\t.cloned = " + struct_name + "_JCalls_cloned,\n"
1034 for var in field_vars:
1035 if isinstance(var, ConvInfo):
1036 if var.arg_conv_name is not None:
1037 out_c = out_c + "\t\t." + var.arg_name + " = " + var.arg_conv_name + ",\n"
1038 out_c = out_c + "\t\t.set_" + var.arg_name + " = NULL,\n"
1040 out_c = out_c + "\t\t." + var.var_name + " = " + var.var_name + ",\n"
1041 out_c = out_c + "\t\t.set_" + var.var_name + " = NULL,\n"
1043 out_c += "\t\t." + var[1] + " = " + var[0] + "_init(env, clz, " + var[1]
1044 for suparg in var[2]:
1045 if isinstance(suparg, ConvInfo):
1046 out_c = out_c + ", " + suparg.arg_name
1048 out_c = out_c + ", " + suparg[1]
1050 out_c = out_c + "\t};\n"
1051 for var in flattened_field_vars:
1052 if not isinstance(var, ConvInfo):
1053 out_c = out_c + "\tcalls->" + var[1] + " = ret." + var[2] + ".this_arg;\n"
1054 out_c = out_c + "\treturn ret;\n"
1055 out_c = out_c + "}\n"
1057 out_c = out_c + self.c_fn_ty_pfx + "int64_t " + self.c_fn_name_define_pfx(struct_name + "_new", True) + "jobject o"
1058 for var in flattened_field_vars:
1059 if isinstance(var, ConvInfo):
1060 out_c = out_c + ", " + var.c_ty + " " + var.arg_name
1062 out_c = out_c + ", jobject " + var[1]
1063 out_c = out_c + ") {\n"
1064 out_c = out_c + "\t" + struct_name + " *res_ptr = MALLOC(sizeof(" + struct_name + "), \"" + struct_name + "\");\n"
1065 out_c = out_c + "\t*res_ptr = " + struct_name + "_init(env, clz, o"
1066 for var in flattened_field_vars:
1067 if isinstance(var, ConvInfo):
1068 out_c = out_c + ", " + var.arg_name
1070 out_c = out_c + ", " + var[1]
1071 out_c = out_c + ");\n"
1072 out_c = out_c + "\treturn tag_ptr(res_ptr, true);\n"
1073 out_c = out_c + "}\n"
1075 for var in flattened_field_vars:
1076 if not isinstance(var, ConvInfo):
1077 out_java_trait += "\n\t/**\n"
1078 out_java_trait += "\t * Gets the underlying " + var[1] + ".\n"
1079 out_java_trait += "\t */\n"
1080 underscore_name = ''.join('_' + c.lower() if c.isupper() else c for c in var[1]).strip('_')
1081 out_java_trait += "\tpublic " + var[1] + " get_" + underscore_name + "() {\n"
1082 out_java_trait += "\t\t" + var[1] + " res = new " + var[1] + "(null, bindings." + struct_name + "_get_" + var[1] + "(this.ptr));\n"
1083 out_java_trait += "\t\tres.ptrs_to.add(this);\n"
1084 out_java_trait += "\t\treturn res;\n"
1085 out_java_trait += "\t}\n"
1086 out_java_trait += "\n"
1088 out_java += "\tpublic static native long " + struct_name + "_get_" + var[1] + "(long arg);\n"
1090 out_c += "JNIEXPORT int64_t JNICALL Java_org_ldk_impl_bindings_" + struct_name + "_1get_1" + var[1] + "(JNIEnv *env, jclass clz, int64_t arg) {\n"
1091 out_c += "\t" + struct_name + " *inp = (" + struct_name + " *)untag_ptr(arg);\n"
1092 out_c += "\treturn tag_ptr(&inp->" + var[2] + ", false);\n"
1095 return (out_java, out_java_trait, out_c)
1097 def trait_struct_inc_refcnt(self, ty_info):
1098 base_conv = "\nif (" + ty_info.var_name + "_conv.free == " + ty_info.rust_obj + "_JCalls_free) {\n"
1099 base_conv = base_conv + "\t// If this_arg is a JCalls struct, then we need to increment the refcnt in it.\n"
1100 base_conv = base_conv + "\t" + ty_info.rust_obj + "_JCalls_cloned(&" + ty_info.var_name + "_conv);\n}"
1103 def map_complex_enum(self, struct_name, variant_list, camel_to_snake, enum_doc_comment):
1104 java_hu_type = struct_name.replace("LDK", "").replace("COption", "Option")
1109 out_java_enum += (self.hu_struct_file_prefix)
1110 out_java_enum += "\n/**\n * " + enum_doc_comment.replace("\n", "\n * ") + "\n */\n"
1111 out_java_enum += "@SuppressWarnings(\"unchecked\") // We correctly assign various generic arrays\n"
1112 out_java_enum += ("public class " + java_hu_type + " extends CommonBase {\n")
1113 out_java_enum += ("\tprivate " + java_hu_type + "(Object _dummy, long ptr) { super(ptr); }\n")
1114 out_java_enum += ("\t@Override @SuppressWarnings(\"deprecation\")\n")
1115 out_java_enum += ("\tprotected void finalize() throws Throwable {\n")
1116 out_java_enum += ("\t\tsuper.finalize();\n")
1117 out_java_enum += ("\t\tif (ptr != 0) { bindings." + struct_name.replace("LDK", "") + "_free(ptr); }\n")
1118 out_java_enum += ("\t}\n")
1119 out_java_enum += ("\tstatic " + java_hu_type + " constr_from_ptr(long ptr) {\n")
1120 out_java_enum += ("\t\tbindings." + struct_name + " raw_val = bindings." + struct_name + "_ref_from_ptr(ptr);\n")
1121 java_hu_subclasses = ""
1123 init_meth_jty_strs = {}
1125 out_java += ("\tpublic static class " + struct_name + " {\n")
1126 out_java += ("\t\tprivate " + struct_name + "() {}\n")
1127 for var in variant_list:
1128 out_java += ("\t\tpublic final static class " + var.var_name + " extends " + struct_name + " {\n")
1129 if var.var_docs is not None:
1130 java_hu_subclasses += "\t/**\n\t * " + var.var_docs.replace("\n", "\n\t * ") + "\n\t */\n"
1131 java_hu_subclasses += "\tpublic final static class " + var.var_name + " extends " + java_hu_type + " {\n"
1132 out_java_enum += ("\t\tif (raw_val.getClass() == bindings." + struct_name + "." + var.var_name + ".class) {\n")
1133 out_java_enum += ("\t\t\treturn new " + var.var_name + "(ptr, (bindings." + struct_name + "." + var.var_name + ")raw_val);\n")
1134 init_meth_jty_str = ""
1135 init_meth_params = ""
1138 for idx, (field_ty, field_docs) in enumerate(var.fields):
1140 init_meth_params = init_meth_params + ", "
1142 java_ty = field_ty.java_ty
1143 if field_ty.java_fn_ty_arg.startswith("L") and field_ty.java_fn_ty_arg.endswith(";"):
1144 # If this is a simple enum, we have to reference it in the low-level bindings differently:
1145 java_ty = field_ty.java_fn_ty_arg.strip("L;").replace("/", ".")
1146 out_java += "\t\t\tpublic " + java_ty + " " + field_ty.arg_name + ";\n"
1147 if field_docs is not None:
1148 java_hu_subclasses += "\t\t/**\n\t\t * " + field_docs.replace("\n", "\n\t\t * ") + "\n\t\t*/\n"
1149 java_hu_subclasses += "\t\t"
1150 if field_ty.nullable:
1151 java_hu_subclasses += "@Nullable "
1152 java_hu_subclasses += "public final " + self.fully_qualified_hu_ty_path(field_ty) + " " + field_ty.arg_name + ";\n"
1153 init_meth_params = init_meth_params + java_ty + " " + field_ty.arg_name
1155 init_meth_body = init_meth_body + "this." + field_ty.arg_name + " = " + field_ty.arg_name + "; "
1156 if field_ty.to_hu_conv is not None:
1157 hu_conv_body = hu_conv_body + "\t\t\t" + field_ty.java_ty + " " + field_ty.arg_name + " = obj." + field_ty.arg_name + ";\n"
1158 hu_conv_body = hu_conv_body + "\t\t\t" + field_ty.to_hu_conv.replace("\n", "\n\t\t\t") + "\n"
1159 hu_conv_body = hu_conv_body + "\t\t\tthis." + field_ty.arg_name + " = " + field_ty.to_hu_conv_name + ";\n"
1161 hu_conv_body = hu_conv_body + "\t\t\tthis." + field_ty.arg_name + " = obj." + field_ty.arg_name + ";\n"
1162 init_meth_jty_str = init_meth_jty_str + field_ty.java_fn_ty_arg
1163 out_java += ("\t\t\t" + var.var_name + "(" + init_meth_params + ") { ")
1164 out_java += (init_meth_body)
1166 out_java += ("\t\t}\n")
1167 out_java_enum += ("\t\t}\n")
1168 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"
1169 java_hu_subclasses = java_hu_subclasses + hu_conv_body
1170 java_hu_subclasses = java_hu_subclasses + "\t\t}\n\t}\n"
1171 init_meth_jty_strs[var.var_name] = init_meth_jty_str
1172 out_java += ("\t\tstatic native void init();\n")
1173 out_java += ("\t}\n")
1174 out_java_enum += ("\t\tassert false; return null; // Unreachable without extending the (internal) bindings interface\n\t}\n\n")
1175 out_java_enum += (java_hu_subclasses)
1176 out_java += ("\tstatic { " + struct_name + ".init(); }\n")
1177 out_java += ("\tpublic static native " + struct_name + " " + struct_name + "_ref_from_ptr(long ptr);\n");
1179 out_c += (self.c_complex_enum_pfx(struct_name, [x.var_name for x in variant_list], init_meth_jty_strs))
1181 out_c += (self.c_fn_ty_pfx + self.c_complex_enum_pass_ty(struct_name) + " " + self.c_fn_name_define_pfx(struct_name + "_ref_from_ptr", True) + self.ptr_c_ty + " ptr) {\n")
1182 out_c += ("\t" + struct_name + " *obj = (" + struct_name + "*)untag_ptr(ptr);\n")
1183 out_c += ("\tswitch(obj->tag) {\n")
1184 for var in variant_list:
1185 out_c += ("\t\tcase " + struct_name + "_" + var.var_name + ": {\n")
1187 for idx, (field_map, field_docs) in enumerate(var.fields):
1188 if field_map.ret_conv is not None:
1189 out_c += ("\t\t\t" + field_map.ret_conv[0].replace("\n", "\n\t\t\t"))
1190 if var.tuple_variant:
1191 out_c += "obj->" + camel_to_snake(var.var_name)
1193 out_c += "obj->" + camel_to_snake(var.var_name) + "." + field_map.arg_name
1194 out_c += (field_map.ret_conv[1].replace("\n", "\n\t\t\t") + "\n")
1195 c_params.append(field_map.ret_conv_name)
1197 if var.tuple_variant:
1198 c_params.append("obj->" + camel_to_snake(var.var_name))
1200 c_params.append("obj->" + camel_to_snake(var.var_name) + "." + field_map.arg_name)
1201 out_c += ("\t\t\treturn " + self.c_constr_native_complex_enum(struct_name, var.var_name, c_params) + ";\n")
1202 out_c += ("\t\t}\n")
1203 out_c += ("\t\tdefault: abort();\n")
1204 out_c += ("\t}\n}\n")
1205 return (out_java, out_java_enum, out_c)
1207 def map_opaque_struct(self, struct_name, struct_doc_comment):
1208 out_opaque_struct_human = ""
1209 out_opaque_struct_human += self.hu_struct_file_prefix
1210 out_opaque_struct_human += "\n/**\n * " + struct_doc_comment.replace("\n", "\n * ") + "\n */\n"
1211 out_opaque_struct_human += "@SuppressWarnings(\"unchecked\") // We correctly assign various generic arrays\n"
1212 hu_name = struct_name.replace("LDKC2Tuple", "TwoTuple").replace("LDKC3Tuple", "ThreeTuple").replace("LDK", "")
1213 out_opaque_struct_human += ("public class " + hu_name + " extends CommonBase")
1214 if struct_name.startswith("LDKLocked") or struct_name.startswith("LDKReadOnly"):
1215 out_opaque_struct_human += (" implements AutoCloseable")
1216 out_opaque_struct_human += (" {\n")
1217 out_opaque_struct_human += ("\t" + hu_name + "(Object _dummy, long ptr) { super(ptr); }\n")
1218 if struct_name.startswith("LDKLocked") or struct_name.startswith("LDKReadOnly"):
1219 out_opaque_struct_human += ("\t@Override public void close() {\n")
1221 out_opaque_struct_human += ("\t@Override @SuppressWarnings(\"deprecation\")\n")
1222 out_opaque_struct_human += ("\tprotected void finalize() throws Throwable {\n")
1223 out_opaque_struct_human += ("\t\tsuper.finalize();\n")
1224 out_opaque_struct_human += ("\t\tif (ptr != 0) { bindings." + struct_name.replace("LDK","") + "_free(ptr); }\n")
1225 out_opaque_struct_human += ("\t}\n\n")
1226 return out_opaque_struct_human
1228 def map_tuple(self, struct_name):
1229 return self.map_opaque_struct(struct_name, "A Tuple")
1231 def map_result(self, struct_name, res_map, err_map):
1232 human_ty = struct_name.replace("LDKCResult", "Result")
1234 java_hu_struct += self.hu_struct_file_prefix
1235 java_hu_struct += "public class " + human_ty + " extends CommonBase {\n"
1236 java_hu_struct += "\tprivate " + human_ty + "(Object _dummy, long ptr) { super(ptr); }\n"
1237 java_hu_struct += "\tprotected void finalize() throws Throwable {\n"
1238 java_hu_struct += "\t\tif (ptr != 0) { bindings." + struct_name.replace("LDK","") + "_free(ptr); } super.finalize();\n"
1239 java_hu_struct += "\t}\n\n"
1240 java_hu_struct += "\tstatic " + human_ty + " constr_from_ptr(long ptr) {\n"
1241 java_hu_struct += "\t\tif (bindings." + struct_name.replace("LDK", "") + "_is_ok(ptr)) {\n"
1242 java_hu_struct += "\t\t\treturn new " + human_ty + "_OK(null, ptr);\n"
1243 java_hu_struct += "\t\t} else {\n"
1244 java_hu_struct += "\t\t\treturn new " + human_ty + "_Err(null, ptr);\n"
1245 java_hu_struct += "\t\t}\n"
1246 java_hu_struct += "\t}\n"
1248 java_hu_struct += "\tpublic static final class " + human_ty + "_OK extends " + human_ty + " {\n"
1250 if res_map.java_hu_ty != "void":
1251 java_hu_struct += "\t\tpublic final " + res_map.java_hu_ty + " res;\n"
1252 java_hu_struct += "\t\tprivate " + human_ty + "_OK(Object _dummy, long ptr) {\n"
1253 java_hu_struct += "\t\t\tsuper(_dummy, ptr);\n"
1254 if res_map.java_hu_ty == "void":
1256 elif res_map.to_hu_conv is not None:
1257 java_hu_struct += "\t\t\t" + res_map.java_ty + " res = bindings." + struct_name.replace("LDK", "") + "_get_ok(ptr);\n"
1258 java_hu_struct += "\t\t\t" + res_map.to_hu_conv.replace("\n", "\n\t\t\t")
1259 java_hu_struct += "\n\t\t\tthis.res = " + res_map.to_hu_conv_name + ";\n"
1261 java_hu_struct += "\t\t\tthis.res = bindings." + struct_name.replace("LDK", "") + "_get_ok(ptr);\n"
1262 java_hu_struct += "\t\t}\n"
1263 java_hu_struct += "\t}\n\n"
1265 java_hu_struct += "\tpublic static final class " + human_ty + "_Err extends " + human_ty + " {\n"
1266 if err_map.java_hu_ty != "void":
1267 java_hu_struct += "\t\tpublic final " + err_map.java_hu_ty + " err;\n"
1268 java_hu_struct += "\t\tprivate " + human_ty + "_Err(Object _dummy, long ptr) {\n"
1269 java_hu_struct += "\t\t\tsuper(_dummy, ptr);\n"
1270 if err_map.java_hu_ty == "void":
1272 elif err_map.to_hu_conv is not None:
1273 java_hu_struct += "\t\t\t" + err_map.java_ty + " err = bindings." + struct_name.replace("LDK", "") + "_get_err(ptr);\n"
1274 java_hu_struct += "\t\t\t" + err_map.to_hu_conv.replace("\n", "\n\t\t\t")
1275 java_hu_struct += "\n\t\t\tthis.err = " + err_map.to_hu_conv_name + ";\n"
1277 java_hu_struct += "\t\t\tthis.err = bindings." + struct_name.replace("LDK", "") + "_get_err(ptr);\n"
1278 java_hu_struct += "\t\t}\n"
1280 java_hu_struct += "\t}\n\n"
1281 return java_hu_struct
1283 def map_function(self, argument_types, c_call_string, method_name, meth_n, return_type_info, struct_meth, default_constructor_args, takes_self, takes_self_as_ref, args_known, type_mapping_generator, doc_comment):
1286 out_java_struct = None
1288 out_java += ("\tpublic static native ")
1289 out_c += (self.c_fn_ty_pfx)
1290 out_c += (return_type_info.c_ty)
1291 out_java += (return_type_info.java_ty)
1292 if return_type_info.ret_conv is not None:
1293 ret_conv_pfx, ret_conv_sfx = return_type_info.ret_conv
1294 out_java += (" " + method_name + "(")
1295 have_args = len(argument_types) > 1 or (len(argument_types) > 0 and argument_types[0].c_ty != "void")
1296 out_c += (" " + self.c_fn_name_define_pfx(method_name, have_args))
1298 for idx, arg_conv_info in enumerate(argument_types):
1302 if arg_conv_info.c_ty != "void":
1303 out_c += (arg_conv_info.c_ty + " " + arg_conv_info.arg_name)
1304 out_java += (arg_conv_info.java_ty + " " + arg_conv_info.arg_name)
1306 out_java_struct = ""
1307 extra_java_struct_out = ""
1309 out_java_struct += ("\t// Skipped " + method_name + "\n")
1311 if doc_comment is not None:
1312 out_java_struct += "\t/**\n\t * " + doc_comment.replace("\n", "\n\t * ") + "\n\t */\n"
1313 if return_type_info.nullable:
1314 out_java_struct += "\t@Nullable\n"
1317 out_java_struct += "\tpublic static " + return_type_info.java_hu_ty + " of("
1318 elif meth_n == "default":
1319 out_java_struct += "\tpublic static " + return_type_info.java_hu_ty + " with_default("
1321 out_java_struct += "\tpublic static " + return_type_info.java_hu_ty + " " + meth_n + "("
1322 elif meth_n == "clone_ptr" or (struct_meth.startswith("LDKCResult") and (meth_n == "get_ok" or meth_n == "get_err")):
1323 out_java_struct += ("\t" + return_type_info.java_hu_ty + " " + meth_n + "(")
1325 if meth_n == "hash" and return_type_info.java_hu_ty == "long":
1326 extra_java_struct_out = "\t@Override public int hashCode() {\n"
1327 extra_java_struct_out += "\t\treturn (int)this.hash();\n"
1328 extra_java_struct_out += "\t}\n"
1329 elif meth_n == "eq" and return_type_info.java_hu_ty == "boolean":
1330 extra_java_struct_out = "\t@Override public boolean equals(Object o) {\n"
1331 extra_java_struct_out += "\t\tif (!(o instanceof " + struct_meth + ")) return false;\n"
1332 extra_java_struct_out += "\t\treturn this.eq((" + struct_meth + ")o);\n"
1333 extra_java_struct_out += "\t}\n"
1334 out_java_struct += ("\tpublic " + return_type_info.java_hu_ty + " " + meth_n + "(")
1335 for idx, arg in enumerate(argument_types):
1337 if not takes_self or idx > 1:
1338 out_java_struct += ", "
1341 if arg.java_ty != "void":
1342 if arg.arg_name in default_constructor_args:
1343 assert not arg.nullable
1344 for explode_idx, explode_arg in enumerate(default_constructor_args[arg.arg_name]):
1345 if explode_idx != 0:
1346 out_java_struct += (", ")
1347 out_java_struct += (
1348 explode_arg.java_hu_ty + " " + arg.arg_name + "_" + explode_arg.arg_name)
1351 out_java_struct += "@Nullable "
1352 ty_string = self.fully_qualified_hu_ty_path(arg)
1353 out_java_struct += ty_string + " " + arg.arg_name
1354 out_java += (");\n")
1356 if out_java_struct is not None:
1357 out_java_struct += (") {\n")
1358 for info in argument_types:
1359 if info.arg_conv is not None:
1360 out_c += ("\t" + info.arg_conv.replace('\n', "\n\t") + "\n")
1361 if return_type_info.ret_conv is not None:
1362 out_c += ("\t" + ret_conv_pfx.replace('\n', '\n\t'))
1363 elif return_type_info.c_ty != "void":
1364 out_c += ("\t" + return_type_info.c_ty + " ret_val = ")
1367 if c_call_string is None:
1368 out_c += (method_name + "(")
1370 out_c += (c_call_string)
1371 for idx, info in enumerate(argument_types):
1372 if info.arg_conv_name is not None:
1375 elif c_call_string is not None:
1377 out_c += (info.arg_conv_name)
1379 if return_type_info.ret_conv is not None:
1380 out_c += (ret_conv_sfx.replace('\n', '\n\t'))
1383 for info in argument_types:
1384 if info.arg_conv_cleanup is not None:
1385 out_c += ("\n\t" + info.arg_conv_cleanup.replace("\n", "\n\t"))
1386 if return_type_info.ret_conv is not None:
1387 out_c += ("\n\treturn " + return_type_info.ret_conv_name + ";")
1388 elif return_type_info.c_ty != "void":
1389 out_c += ("\n\treturn ret_val;")
1390 out_c += ("\n}\n\n")
1393 out_java_struct += ("\t\t")
1394 if return_type_info.java_ty != "void":
1395 out_java_struct += (return_type_info.java_ty + " ret = ")
1396 out_java_struct += ("bindings." + method_name + "(")
1397 for idx, info in enumerate(argument_types):
1399 out_java_struct += (", ")
1400 if idx == 0 and takes_self:
1401 out_java_struct += ("this.ptr")
1402 elif info.arg_name in default_constructor_args:
1403 out_java_struct += ("bindings." + info.java_hu_ty + "_new(")
1404 for explode_idx, explode_arg in enumerate(default_constructor_args[info.arg_name]):
1405 if explode_idx != 0:
1406 out_java_struct += (", ")
1407 expl_arg_name = info.arg_name + "_" + explode_arg.arg_name
1408 if explode_arg.from_hu_conv is not None:
1409 out_java_struct += (
1410 explode_arg.from_hu_conv[0].replace(explode_arg.arg_name, expl_arg_name))
1412 out_java_struct += (expl_arg_name)
1413 out_java_struct += (")")
1414 elif info.from_hu_conv is not None:
1415 out_java_struct += (info.from_hu_conv[0])
1417 out_java_struct += (info.arg_name)
1418 out_java_struct += (");\n")
1420 # This is completely nuts. The OpenJDK JRE JIT will optimize out a object which is on
1421 # the stack, calling its finalizer immediately even if member methods are *actively
1422 # executing* on the same object, as long as said object is on the stack. There is no
1423 # concrete specification for when the optimizer is allowed to do this, and when it is
1424 # not, so there is absolutely no way to be certain that this fix suffices.
1426 # Instead, the "Java Language Specification" says only that an object is reachable
1427 # (i.e. will not yet be finalized) if it "can be accessed in any potential continuing
1428 # computation from any live thread". To any sensible reader this would mean actively
1429 # executing a member function on an object would make it not eligible for finalization.
1430 # But, no, dear reader, this statement does not say that. Well, okay, it says that,
1431 # very explicitly in fact, but those are just, like, words, man.
1433 # In the seemingly non-normative text further down, a few examples of things the
1434 # optimizer can do are given, including "if the values in an object's fields are
1435 # stored in registers[, t]he may then access the registers instead of the object, and
1436 # never access the object again[, implying] that the object is garbage". This appears
1437 # to fully contradict both the above statement, the API documentation in java.lang.ref
1438 # regarding when a reference is "strongly reachable", and basic common sense. There is
1439 # no concrete set of limitations stated, however, seemingly implying the JIT could
1440 # decide your code would run faster by simply garbage collecting everything
1441 # immediately, ensuring your code finishes soon, just by SEGFAULT. Thus, we're really
1442 # entirely flying blind here. We add some fences and hope that its sufficient, but
1443 # with no specification to rely on, we cannot be certain of anything.
1445 # TL;DR: The Java Language "Specification" provides no real guarantees on when an
1446 # object will be considered available for garbage collection once the JIT kicks in, so
1447 # we put in some fences and hope to god the JIT doesn't get smarter/more broken.
1448 for idx, info in enumerate(argument_types):
1449 if idx == 0 and takes_self:
1450 out_java_struct += ("\t\tReference.reachabilityFence(this);\n")
1451 elif info.arg_name in default_constructor_args:
1452 for explode_idx, explode_arg in enumerate(default_constructor_args[info.arg_name]):
1453 expl_arg_name = info.arg_name + "_" + explode_arg.arg_name
1454 out_java_struct += ("\t\tReference.reachabilityFence(" + expl_arg_name + ");\n")
1455 elif info.c_ty != "void":
1456 out_java_struct += ("\t\tReference.reachabilityFence(" + info.arg_name + ");\n")
1458 if return_type_info.java_ty == "long" and return_type_info.java_hu_ty != "long":
1459 out_java_struct += "\t\tif (ret >= 0 && ret <= 4096) { return null; }\n"
1461 if return_type_info.to_hu_conv is not None:
1463 out_java_struct += ("\t\t" + return_type_info.to_hu_conv.replace("\n", "\n\t\t").replace("this",
1464 return_type_info.to_hu_conv_name) + "\n")
1466 out_java_struct += ("\t\t" + return_type_info.to_hu_conv.replace("\n", "\n\t\t") + "\n")
1468 for idx, info in enumerate(argument_types):
1469 if idx == 0 and takes_self:
1471 elif info.arg_name in default_constructor_args:
1472 for explode_arg in default_constructor_args[info.arg_name]:
1473 expl_arg_name = info.arg_name + "_" + explode_arg.arg_name
1474 if explode_arg.from_hu_conv is not None and return_type_info.to_hu_conv_name:
1475 out_java_struct += ("\t\t" + explode_arg.from_hu_conv[1].replace(explode_arg.arg_name,
1476 expl_arg_name).replace(
1477 "this", return_type_info.to_hu_conv_name) + ";\n")
1478 elif info.from_hu_conv is not None and info.from_hu_conv[1] != "":
1479 if not takes_self and return_type_info.to_hu_conv_name is not None:
1480 out_java_struct += (
1481 "\t\t" + info.from_hu_conv[1].replace("this", return_type_info.to_hu_conv_name).replace("\n", "\n\t\t") + ";\n")
1483 out_java_struct += ("\t\t" + info.from_hu_conv[1].replace("\n", "\n\t\t") + ";\n")
1485 if takes_self and not takes_self_as_ref:
1486 out_java_struct += "\t\t" + argument_types[0].from_hu_conv[1].replace("\n", "\n\t\t").replace("this_arg", "this") + ";\n"
1487 if return_type_info.to_hu_conv_name is not None:
1488 out_java_struct += ("\t\treturn " + return_type_info.to_hu_conv_name + ";\n")
1489 elif return_type_info.java_ty != "void" and return_type_info.rust_obj != "LDK" + struct_meth:
1490 out_java_struct += ("\t\treturn ret;\n")
1491 out_java_struct += ("\t}\n\n")
1493 return (out_java, out_c, out_java_struct + extra_java_struct_out)