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(
19 self.java_type_map = dict(
22 self.java_hu_type_map = dict(
26 self.to_hu_conv_templates = dict(
27 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}); }',
28 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}); }'
31 self.bindings_header = """package org.ldk.impl;
32 import org.ldk.enums.*;
33 import org.ldk.impl.version;
35 import java.io.InputStream;
36 import java.io.IOException;
37 import java.nio.file.Files;
38 import java.nio.file.Path;
39 import java.nio.file.StandardCopyOption;
41 public class bindings {
42 public static class VecOrSliceDef {
46 public VecOrSliceDef(long dataptr, long datalen, long stride) {
47 this.dataptr = dataptr; this.datalen = datalen; this.stride = stride;
52 // Try to load natively first, this works on Android and in testing.
53 System.loadLibrary(\"lightningjni\");
54 } catch (UnsatisfiedLinkError system_load_err) {
55 // Otherwise try to load from the library jar.
56 File tmpdir = new File(System.getProperty("java.io.tmpdir"), "ldk-java-nativelib");
57 tmpdir.mkdir(); // If it fails to create, assume it was there already
58 tmpdir.deleteOnExit();
59 String libname = "liblightningjni_" + System.getProperty("os.name").replaceAll(" ", "") +
60 "-" + System.getProperty("os.arch").replaceAll(" ", "") + ".nativelib";
61 try (InputStream is = bindings.class.getResourceAsStream("/" + libname)) {
62 Path libpath = new File(tmpdir.toPath().toString(), "liblightningjni.so").toPath();
63 Files.copy(is, libpath, StandardCopyOption.REPLACE_EXISTING);
64 Runtime.getRuntime().load(libpath.toString());
65 } catch (Exception e) {
66 System.err.println("Failed to load LDK native library.");
67 System.err.println("System LDK native library load failed with: " + system_load_err);
68 System.err.println("Resource-based LDK native library load failed with: " + e);
69 throw new IllegalArgumentException(e);
72 init(java.lang.Enum.class, VecOrSliceDef.class);
74 if (!get_lib_version_string().equals(version.get_ldk_java_bindings_version()))
75 throw new IllegalArgumentException("Compiled LDK library and LDK class failes do not match");
76 // Fetching the LDK versions from C also checks that the header and binaries match
77 get_ldk_c_bindings_version();
80 static native void init(java.lang.Class c, java.lang.Class slicedef);
81 static native void init_class_cache();
82 static native String get_lib_version_string();
84 public static native String get_ldk_c_bindings_version();
85 public static native String get_ldk_version();
87 public static native boolean deref_bool(long ptr);
88 public static native long deref_long(long ptr);
89 public static native void free_heap_ptr(long ptr);
90 public static native byte[] read_bytes(long ptr, long len);
91 public static native byte[] get_u8_slice_bytes(long slice_ptr);
92 public static native long bytes_to_u8_vec(byte[] bytes);
93 public static native long new_txpointer_copy_data(byte[] txdata);
94 public static native void txpointer_free(long ptr);
95 public static native byte[] txpointer_get_buffer(long ptr);
96 public static native long vec_slice_len(long vec);
97 public static native long new_empty_slice_vec();
100 self.bindings_version_file = """package org.ldk.impl;
102 public class version {
103 public static String get_ldk_java_bindings_version() {
104 return "<git_version_ldk_garbagecollected>";
108 self.bindings_footer = "}\n"
110 self.util_fn_pfx = """package org.ldk.structs;
111 import org.ldk.impl.bindings;
112 import org.ldk.enums.*;
113 import org.ldk.util.*;
114 import java.util.Arrays;
115 import java.lang.ref.Reference;
116 import javax.annotation.Nullable;
118 public class UtilMethods {
120 self.util_fn_sfx = "}"
121 self.common_base = """package org.ldk.structs;
122 import java.util.LinkedList;
125 LinkedList<Object> ptrs_to = new LinkedList();
126 protected CommonBase(long ptr) { assert ptr < 0 || ptr > 4096; this.ptr = ptr; }
130 self.txout_defn = """public class TxOut extends CommonBase {
131 /** The script_pubkey in this output */
132 public final byte[] script_pubkey;
133 /** The value, in satoshis, of this output */
134 public final long value;
136 TxOut(java.lang.Object _dummy, long ptr) {
138 this.script_pubkey = bindings.TxOut_get_script_pubkey(ptr);
139 this.value = bindings.TxOut_get_value(ptr);
141 public TxOut(long value, byte[] script_pubkey) {
142 super(bindings.TxOut_new(script_pubkey, value));
143 this.script_pubkey = bindings.TxOut_get_script_pubkey(ptr);
144 this.value = bindings.TxOut_get_value(ptr);
147 @Override @SuppressWarnings(\"deprecation\")
148 protected void finalize() throws Throwable {
150 if (ptr != 0) { bindings.TxOut_free(ptr); }
154 self.c_file_pfx = """#include <jni.h>
155 // On OSX jlong (ie long long) is not equivalent to int64_t, so we override here
156 #define int64_t jlong
157 #include \"org_ldk_impl_bindings.h\"
158 #include <lightning.h>
160 #include <stdatomic.h>
163 #define LIKELY(v) __builtin_expect(!!(v), 1)
164 #define UNLIKELY(v) __builtin_expect(!!(v), 0)
168 if self.target == Target.ANDROID:
169 self.c_file_pfx = self.c_file_pfx + """
170 #include <android/log.h>
171 #define DEBUG_PRINT(...) __android_log_print(ANDROID_LOG_ERROR, "LDK", __VA_ARGS__)
175 static void* redirect_stderr(void* ignored) {
178 dup2(pipes[1], STDERR_FILENO);
180 memset(buf, 0, 8192);
182 while ((len = read(pipes[0], buf, 8191)) > 0) {
183 DEBUG_PRINT("%s\\n", buf);
184 memset(buf, 0, 8192);
186 DEBUG_PRINT("End of stderr???\\n");
189 void __attribute__((constructor)) spawn_stderr_redirection() {
191 pthread_create(&thread, NULL, &redirect_stderr, NULL);
195 self.c_file_pfx = self.c_file_pfx + "#define DEBUG_PRINT(...) fprintf(stderr, __VA_ARGS__)\n"
197 if not DEBUG or sys.platform == "darwin":
198 self.c_file_pfx = self.c_file_pfx + """#define MALLOC(a, _) malloc(a)
199 #define FREE(p) if ((uint64_t)(p) > 4096) { free(p); }
200 #define CHECK_ACCESS(p)
201 #define CHECK_INNER_FIELD_ACCESS_OR_NULL(v)
204 self.c_file_pfx += """#define DO_ASSERT(a) (void)(a)
208 self.c_file_pfx = self.c_file_pfx + """#include <assert.h>
209 // Always run a, then assert it is true:
210 #define DO_ASSERT(a) do { bool _assert_val = (a); assert(_assert_val); } while(0)
211 // Assert a is true or do nothing
212 #define CHECK(a) DO_ASSERT(a)
214 void __attribute__((constructor)) debug_log_version() {
215 if (check_get_ldk_version() == NULL)
216 DEBUG_PRINT("LDK version did not match the header we built against\\n");
217 if (check_get_ldk_bindings_version() == NULL)
218 DEBUG_PRINT("LDK C Bindings version did not match the header we built against\\n");
219 DEBUG_PRINT("Loaded LDK-Java Bindings with LDK %s and LDK-C-Bindings %s\\n", check_get_ldk_version(), check_get_ldk_bindings_version());
223 if sys.platform != "darwin":
224 self.c_file_pfx += """
225 // Running a leak check across all the allocations and frees of the JDK is a mess,
226 // so instead we implement our own naive leak checker here, relying on the -wrap
227 // linker option to wrap malloc/calloc/realloc/free, tracking everyhing allocated
228 // and free'd in Rust or C across the generated bindings shared library.
232 if self.target == Target.ANDROID:
233 self.c_file_pfx = self.c_file_pfx + """
237 // Implement the execinfo functions using _Unwind_backtrace. This seems to miss many Rust
238 // symbols, so we only use it on Android, where execinfo.h is unavailable.
240 struct BacktraceState {
244 static _Unwind_Reason_Code unwind_callback(struct _Unwind_Context* context, void* arg) {
245 struct BacktraceState* state = (struct BacktraceState*)arg;
246 uintptr_t pc = _Unwind_GetIP(context);
248 if (state->current == state->end) {
249 return _URC_END_OF_STACK;
251 *state->current++ = (void*)(pc);
254 return _URC_NO_REASON;
257 int backtrace(void** buffer, int max) {
258 struct BacktraceState state = { buffer, buffer + max };
259 _Unwind_Backtrace(unwind_callback, &state);
260 return state.current - buffer;
263 void backtrace_symbols_fd(void ** buffer, int count, int _fd) {
264 for (int idx = 0; idx < count; ++idx) {
266 if (dladdr(buffer[idx], &info) && info.dli_sname) {
267 DEBUG_PRINT("%p: %s", buffer[idx], info.dli_sname);
269 DEBUG_PRINT("%p: ???", buffer[idx]);
275 self.c_file_pfx = self.c_file_pfx + "#include <execinfo.h>\n"
276 self.c_file_pfx = self.c_file_pfx + """
279 static pthread_mutex_t allocation_mtx;
281 void __attribute__((constructor)) init_mtx() {
282 DO_ASSERT(!pthread_mutex_init(&allocation_mtx, NULL));
286 typedef struct allocation {
287 struct allocation* next;
289 const char* struct_name;
292 unsigned long alloc_len;
294 static allocation* allocation_ll = NULL;
296 void* __real_malloc(size_t len);
297 void* __real_calloc(size_t nmemb, size_t len);
298 static void new_allocation(void* res, const char* struct_name, size_t len) {
299 allocation* new_alloc = __real_malloc(sizeof(allocation));
300 new_alloc->ptr = res;
301 new_alloc->struct_name = struct_name;
302 new_alloc->bt_len = backtrace(new_alloc->bt, BT_MAX);
303 new_alloc->alloc_len = len;
304 DO_ASSERT(!pthread_mutex_lock(&allocation_mtx));
305 new_alloc->next = allocation_ll;
306 allocation_ll = new_alloc;
307 DO_ASSERT(!pthread_mutex_unlock(&allocation_mtx));
309 static void* MALLOC(size_t len, const char* struct_name) {
310 void* res = __real_malloc(len);
311 new_allocation(res, struct_name, len);
314 void __real_free(void* ptr);
315 static void alloc_freed(void* ptr) {
316 allocation* p = NULL;
317 DO_ASSERT(!pthread_mutex_lock(&allocation_mtx));
318 allocation* it = allocation_ll;
319 while (it->ptr != ptr) {
320 p = it; it = it->next;
322 DEBUG_PRINT("ERROR: Tried to free unknown pointer %p at:\\n", ptr);
324 int bt_len = backtrace(bt, BT_MAX);
325 backtrace_symbols_fd(bt, bt_len, STDERR_FILENO);
326 DEBUG_PRINT("\\n\\n");
327 DO_ASSERT(!pthread_mutex_unlock(&allocation_mtx));
328 return; // addrsan should catch malloc-unknown and print more info than we have
331 if (p) { p->next = it->next; } else { allocation_ll = it->next; }
332 DO_ASSERT(!pthread_mutex_unlock(&allocation_mtx));
333 DO_ASSERT(it->ptr == ptr);
336 static void FREE(void* ptr) {
337 if ((uint64_t)ptr <= 4096) return; // Rust loves to create pointers to the NULL page for dummys
342 void* __wrap_malloc(size_t len) {
343 void* res = __real_malloc(len);
344 new_allocation(res, "malloc call", len);
347 void* __wrap_calloc(size_t nmemb, size_t len) {
348 void* res = __real_calloc(nmemb, len);
349 new_allocation(res, "calloc call", len);
352 void __wrap_free(void* ptr) {
353 if (ptr == NULL) return;
358 static void CHECK_ACCESS(const void* ptr) {
359 DO_ASSERT(!pthread_mutex_lock(&allocation_mtx));
360 allocation* it = allocation_ll;
361 while (it->ptr != ptr) {
364 DEBUG_PRINT("ERROR: Tried to access unknown pointer %p at:\\n", ptr);
366 int bt_len = backtrace(bt, BT_MAX);
367 backtrace_symbols_fd(bt, bt_len, STDERR_FILENO);
368 DEBUG_PRINT("\\n\\n");
369 DO_ASSERT(!pthread_mutex_unlock(&allocation_mtx));
370 return; // addrsan should catch and print more info than we have
373 DO_ASSERT(!pthread_mutex_unlock(&allocation_mtx));
375 #define CHECK_INNER_FIELD_ACCESS_OR_NULL(v) \\
376 if (v.is_owned && v.inner != NULL) { \\
377 const void *p = __unmangle_inner_ptr(v.inner); \\
383 void* __real_realloc(void* ptr, size_t newlen);
384 void* __wrap_realloc(void* ptr, size_t len) {
385 if (ptr != NULL) alloc_freed(ptr);
386 void* res = __real_realloc(ptr, len);
387 new_allocation(res, "realloc call", len);
390 void __wrap_reallocarray(void* ptr, size_t new_sz) {
391 // Rust doesn't seem to use reallocarray currently
395 void __attribute__((destructor)) check_leaks() {
396 unsigned long alloc_count = 0;
397 unsigned long alloc_size = 0;
398 DEBUG_PRINT("The following LDK-allocated blocks still remain.\\n");
399 DEBUG_PRINT("Note that this is only accurate if System.gc(); System.runFinalization()\\n");
400 DEBUG_PRINT("was called prior to exit after all LDK objects were out of scope.\\n");
401 for (allocation* a = allocation_ll; a != NULL; a = a->next) {
402 DEBUG_PRINT("%s %p (%lu bytes) remains:\\n", a->struct_name, a->ptr, a->alloc_len);
403 backtrace_symbols_fd(a->bt, a->bt_len, STDERR_FILENO);
404 DEBUG_PRINT("\\n\\n");
406 alloc_size += a->alloc_len;
408 DEBUG_PRINT("%lu allocations remained for %lu bytes.\\n", alloc_count, alloc_size);
409 DEBUG_PRINT("Note that this is only accurate if System.gc(); System.runFinalization()\\n");
410 DEBUG_PRINT("was called prior to exit after all LDK objects were out of scope.\\n");
413 self.c_file_pfx = self.c_file_pfx + """
414 static jmethodID ordinal_meth = NULL;
415 static jmethodID slicedef_meth = NULL;
416 static jclass slicedef_cls = NULL;
417 JNIEXPORT void Java_org_ldk_impl_bindings_init(JNIEnv * env, jclass _b, jclass enum_class, jclass slicedef_class) {
418 ordinal_meth = (*env)->GetMethodID(env, enum_class, "ordinal", "()I");
419 CHECK(ordinal_meth != NULL);
420 slicedef_meth = (*env)->GetMethodID(env, slicedef_class, "<init>", "(JJJ)V");
421 CHECK(slicedef_meth != NULL);
422 slicedef_cls = (*env)->NewGlobalRef(env, slicedef_class);
423 CHECK(slicedef_cls != NULL);
426 JNIEXPORT jboolean JNICALL Java_org_ldk_impl_bindings_deref_1bool (JNIEnv * env, jclass _a, jlong ptr) {
427 return *((bool*)ptr);
429 JNIEXPORT jlong JNICALL Java_org_ldk_impl_bindings_deref_1long (JNIEnv * env, jclass _a, jlong ptr) {
430 return *((long*)ptr);
432 JNIEXPORT void JNICALL Java_org_ldk_impl_bindings_free_1heap_1ptr (JNIEnv * env, jclass _a, jlong ptr) {
435 JNIEXPORT jbyteArray JNICALL Java_org_ldk_impl_bindings_read_1bytes (JNIEnv * env, jclass _b, jlong ptr, jlong len) {
436 jbyteArray ret_arr = (*env)->NewByteArray(env, len);
437 (*env)->SetByteArrayRegion(env, ret_arr, 0, len, (unsigned char*)ptr);
440 JNIEXPORT jbyteArray JNICALL Java_org_ldk_impl_bindings_get_1u8_1slice_1bytes (JNIEnv * env, jclass _b, jlong slice_ptr) {
441 LDKu8slice *slice = (LDKu8slice*)slice_ptr;
442 jbyteArray ret_arr = (*env)->NewByteArray(env, slice->datalen);
443 (*env)->SetByteArrayRegion(env, ret_arr, 0, slice->datalen, slice->data);
446 JNIEXPORT int64_t impl_bindings_bytes_1to_1u8_1vec (JNIEnv * env, jclass _b, jbyteArray bytes) {
447 LDKCVec_u8Z *vec = (LDKCVec_u8Z*)MALLOC(sizeof(LDKCVec_u8Z), "LDKCVec_u8");
448 vec->datalen = (*env)->GetArrayLength(env, bytes);
449 vec->data = (uint8_t*)MALLOC(vec->datalen, "LDKCVec_u8Z Bytes");
450 (*env)->GetByteArrayRegion (env, bytes, 0, vec->datalen, vec->data);
451 return (uint64_t)vec;
453 JNIEXPORT jbyteArray JNICALL Java_org_ldk_impl_bindings_txpointer_1get_1buffer (JNIEnv * env, jclass _b, jlong ptr) {
454 LDKTransaction *txdata = (LDKTransaction*)ptr;
456 slice.data = txdata->data;
457 slice.datalen = txdata->datalen;
458 return Java_org_ldk_impl_bindings_get_1u8_1slice_1bytes(env, _b, (uint64_t)&slice);
460 JNIEXPORT int64_t JNICALL Java_org_ldk_impl_bindings_new_1txpointer_1copy_1data (JNIEnv * env, jclass _b, jbyteArray bytes) {
461 LDKTransaction *txdata = (LDKTransaction*)MALLOC(sizeof(LDKTransaction), "LDKTransaction");
462 txdata->datalen = (*env)->GetArrayLength(env, bytes);
463 txdata->data = (uint8_t*)MALLOC(txdata->datalen, "Tx Data Bytes");
464 txdata->data_is_owned = false;
465 (*env)->GetByteArrayRegion (env, bytes, 0, txdata->datalen, txdata->data);
466 return (uint64_t)txdata;
468 JNIEXPORT void JNICALL Java_org_ldk_impl_bindings_txpointer_1free (JNIEnv * env, jclass _b, jlong ptr) {
469 LDKTransaction *tx = (LDKTransaction*)ptr;
470 tx->data_is_owned = true;
471 Transaction_free(*tx);
474 JNIEXPORT jlong JNICALL Java_org_ldk_impl_bindings_vec_1slice_1len (JNIEnv * env, jclass _a, jlong ptr) {
475 // Check offsets of a few Vec types are all consistent as we're meant to be generic across types
476 _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKCVec_SignatureZ, datalen), "Vec<*> needs to be mapped identically");
477 _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKCVec_MessageSendEventZ, datalen), "Vec<*> needs to be mapped identically");
478 _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKCVec_EventZ, datalen), "Vec<*> needs to be mapped identically");
479 _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKCVec_C2Tuple_usizeTransactionZZ, datalen), "Vec<*> needs to be mapped identically");
480 LDKCVec_u8Z *vec = (LDKCVec_u8Z*)ptr;
481 return (uint64_t)vec->datalen;
483 JNIEXPORT int64_t JNICALL Java_org_ldk_impl_bindings_new_1empty_1slice_1vec (JNIEnv * env, jclass _b) {
484 // Check sizes of a few Vec types are all consistent as we're meant to be generic across types
485 _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKCVec_SignatureZ), "Vec<*> needs to be mapped identically");
486 _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKCVec_MessageSendEventZ), "Vec<*> needs to be mapped identically");
487 _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKCVec_EventZ), "Vec<*> needs to be mapped identically");
488 _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKCVec_C2Tuple_usizeTransactionZZ), "Vec<*> needs to be mapped identically");
489 LDKCVec_u8Z *vec = (LDKCVec_u8Z*)MALLOC(sizeof(LDKCVec_u8Z), "Empty LDKCVec");
492 return (uint64_t)vec;
495 // We assume that CVec_u8Z and u8slice are the same size and layout (and thus pointers to the two can be mixed)
496 _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKu8slice), "Vec<u8> and [u8] need to have been mapped identically");
497 _Static_assert(offsetof(LDKCVec_u8Z, data) == offsetof(LDKu8slice, data), "Vec<u8> and [u8] need to have been mapped identically");
498 _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKu8slice, datalen), "Vec<u8> and [u8] need to have been mapped identically");
500 _Static_assert(sizeof(jlong) == sizeof(int64_t), "We assume that j-types are the same as C types");
501 _Static_assert(sizeof(jbyte) == sizeof(char), "We assume that j-types are the same as C types");
502 _Static_assert(sizeof(void*) <= 8, "Pointers must fit into 64 bits");
504 typedef jlongArray int64_tArray;
505 typedef jbyteArray int8_tArray;
507 static inline jstring str_ref_to_java(JNIEnv *env, const char* chars, size_t len) {
508 // Sadly we need to create a temporary because Java can't accept a char* without a 0-terminator
509 char* conv_buf = MALLOC(len + 1, "str conv buf");
510 memcpy(conv_buf, chars, len);
512 jstring ret = (*env)->NewStringUTF(env, conv_buf);
516 static inline LDKStr java_to_owned_str(JNIEnv *env, jstring str) {
517 uint64_t str_len = (*env)->GetStringUTFLength(env, str);
518 char* newchars = MALLOC(str_len + 1, "String chars");
519 const char* jchars = (*env)->GetStringUTFChars(env, str, NULL);
520 memcpy(newchars, jchars, str_len);
521 newchars[str_len] = 0;
522 (*env)->ReleaseStringUTFChars(env, str, jchars);
526 .chars_is_owned = true
531 JNIEXPORT jstring JNICALL Java_org_ldk_impl_bindings_get_1ldk_1c_1bindings_1version(JNIEnv *env, jclass _c) {
532 return str_ref_to_java(env, check_get_ldk_bindings_version(), strlen(check_get_ldk_bindings_version()));
534 JNIEXPORT jstring JNICALL Java_org_ldk_impl_bindings_get_1ldk_1version(JNIEnv *env, jclass _c) {
535 return str_ref_to_java(env, check_get_ldk_version(), strlen(check_get_ldk_version()));
539 self.c_version_file = """JNIEXPORT jstring JNICALL Java_org_ldk_impl_bindings_get_1lib_1version_1string(JNIEnv *env, jclass _c) {
540 return str_ref_to_java(env, "<git_version_ldk_garbagecollected>", strlen("<git_version_ldk_garbagecollected>"));
543 self.hu_struct_file_prefix = """package org.ldk.structs;
545 import org.ldk.impl.bindings;
546 import org.ldk.enums.*;
547 import org.ldk.util.*;
548 import java.util.Arrays;
549 import java.lang.ref.Reference;
550 import javax.annotation.Nullable;
553 self.c_fn_ty_pfx = "JNIEXPORT "
554 self.c_fn_args_pfx = "JNIEnv *env, jclass clz"
555 self.file_ext = ".java"
556 self.ptr_c_ty = "int64_t"
557 self.ptr_native_ty = "long"
558 self.result_c_ty = "jclass"
559 self.ptr_arr = "jobjectArray"
560 self.is_arr_some_check = ("", " != NULL")
561 self.get_native_arr_len_call = ("(*env)->GetArrayLength(env, ", ")")
563 def construct_jenv(self):
564 res = "JNIEnv *env;\n"
565 res += "jint get_jenv_res = (*j_calls->vm)->GetEnv(j_calls->vm, (void**)&env, JNI_VERSION_1_6);\n"
566 res += "if (get_jenv_res == JNI_EDETACHED) {\n"
567 if self.target == Target.ANDROID:
568 res += "\tDO_ASSERT((*j_calls->vm)->AttachCurrentThread(j_calls->vm, &env, NULL) == JNI_OK);\n"
570 res += "\tDO_ASSERT((*j_calls->vm)->AttachCurrentThread(j_calls->vm, (void**)&env, NULL) == JNI_OK);\n"
572 res += "\tDO_ASSERT(get_jenv_res == JNI_OK);\n"
575 def deconstruct_jenv(self):
576 res = "if (get_jenv_res == JNI_EDETACHED) {\n"
577 res += "\tDO_ASSERT((*j_calls->vm)->DetachCurrentThread(j_calls->vm) == JNI_OK);\n"
581 def release_native_arr_ptr_call(self, ty_info, arr_var, arr_ptr_var):
582 if ty_info.subty is None or not ty_info.subty.c_ty.endswith("Array"):
583 return "(*env)->ReleasePrimitiveArrayCritical(env, " + arr_var + ", " + arr_ptr_var + ", 0)"
585 def create_native_arr_call(self, arr_len, ty_info):
586 if ty_info.c_ty == "int8_tArray":
587 return "(*env)->NewByteArray(env, " + arr_len + ")"
588 elif ty_info.subty.c_ty.endswith("Array"):
589 clz_var = ty_info.java_fn_ty_arg[1:].replace("[", "arr_of_")
590 self.c_array_class_caches.add(clz_var)
591 return "(*env)->NewObjectArray(env, " + arr_len + ", " + clz_var + "_clz, NULL);\n"
593 return "(*env)->New" + ty_info.java_ty.strip("[]").title() + "Array(env, " + arr_len + ")"
594 def set_native_arr_contents(self, arr_name, arr_len, ty_info):
595 if ty_info.c_ty == "int8_tArray":
596 return ("(*env)->SetByteArrayRegion(env, " + arr_name + ", 0, " + arr_len + ", ", ")")
599 def get_native_arr_contents(self, arr_name, dest_name, arr_len, ty_info, copy):
600 if ty_info.c_ty == "int8_tArray":
602 return "(*env)->GetByteArrayRegion(env, " + arr_name + ", 0, " + arr_len + ", " + dest_name + ")"
604 return "(*env)->GetByteArrayElements (env, " + arr_name + ", NULL)"
605 elif not ty_info.java_ty[:len(ty_info.java_ty) - 2].endswith("[]"):
606 return "(*env)->Get" + ty_info.subty.java_ty.title() + "ArrayElements (env, " + arr_name + ", NULL)"
609 def get_native_arr_elem(self, arr_name, idxc, ty_info):
610 if self.get_native_arr_contents(arr_name, "", "", ty_info, False) is None:
611 return "(*env)->GetObjectArrayElement(env, " + arr_name + ", " + idxc + ")"
613 assert False # Only called if above is None
614 def get_native_arr_ptr_call(self, ty_info):
615 if ty_info.subty is not None and ty_info.subty.c_ty.endswith("Array"):
617 return ("(*env)->GetPrimitiveArrayCritical(env, ", ", NULL)")
618 def get_native_arr_entry_call(self, ty_info, arr_name, idxc, entry_access):
619 if ty_info.subty is None or not ty_info.subty.c_ty.endswith("Array"):
621 return "(*env)->SetObjectArrayElement(env, " + arr_name + ", " + idxc + ", " + entry_access + ")"
622 def cleanup_native_arr_ref_contents(self, arr_name, dest_name, arr_len, ty_info):
623 if ty_info.c_ty == "int8_tArray":
624 return "(*env)->ReleaseByteArrayElements(env, " + arr_name + ", (int8_t*)" + dest_name + ", 0);"
626 return "(*env)->Release" + ty_info.java_ty.strip("[]").title() + "ArrayElements(env, " + arr_name + ", " + dest_name + ", 0)"
628 def map_hu_array_elems(self, arr_name, conv_name, arr_ty, elem_ty):
629 if elem_ty.java_ty == "long" and elem_ty.java_hu_ty != "long":
630 return arr_name + " != null ? Arrays.stream(" + arr_name + ").mapToLong(" + conv_name + " -> " + elem_ty.from_hu_conv[0] + ").toArray() : null"
631 elif elem_ty.java_ty == "long":
632 return arr_name + " != null ? Arrays.stream(" + arr_name + ").map(" + conv_name + " -> " + elem_ty.from_hu_conv[0] + ").toArray() : null"
634 return arr_name + " != null ? Arrays.stream(" + arr_name + ").map(" + conv_name + " -> " + elem_ty.from_hu_conv[0] + ").toArray(" + arr_ty.java_ty + "::new) : null"
636 def str_ref_to_native_call(self, var_name, str_len):
637 return "str_ref_to_java(env, " + var_name + ", " + str_len + ")"
638 def str_ref_to_c_call(self, var_name):
639 return "java_to_owned_str(env, " + var_name + ")"
640 def str_to_hu_conv(self, var_name):
642 def str_from_hu_conv(self, var_name):
645 def c_fn_name_define_pfx(self, fn_name, has_args):
647 return "JNICALL Java_org_ldk_impl_bindings_" + fn_name.replace("_", "_1") + "(JNIEnv *env, jclass clz, "
648 return "JNICALL Java_org_ldk_impl_bindings_" + fn_name.replace("_", "_1") + "(JNIEnv *env, jclass clz"
652 for ty in sorted(self.c_array_class_caches):
653 res = res + "static jclass " + ty + "_clz = NULL;\n"
654 res = res + "JNIEXPORT void Java_org_ldk_impl_bindings_init_1class_1cache(JNIEnv * env, jclass clz) {\n"
655 for ty in sorted(self.c_array_class_caches):
656 res = res + "\t" + ty + "_clz = (*env)->FindClass(env, \"" + ty.replace("arr_of_", "[") + "\");\n"
657 res = res + "\tCHECK(" + ty + "_clz != NULL);\n"
658 res = res + "\t" + ty + "_clz = (*env)->NewGlobalRef(env, " + ty + "_clz);\n"
662 def var_decl_statement(self, ty_string, var_name, statement):
663 return ty_string + " " + var_name + " = " + statement
665 def get_java_arr_len(self, arr_name):
666 return arr_name + ".length"
667 def get_java_arr_elem(self, elem_ty, arr_name, idx):
668 return arr_name + "[" + idx + "]"
669 def constr_hu_array(self, ty_info, arr_len):
670 base_ty = ty_info.subty.java_hu_ty.split("[")[0].split("<")[0]
671 conv = "new " + base_ty + "[" + arr_len + "]"
672 if "[" in ty_info.subty.java_hu_ty.split("<")[0]:
673 # Do a bit of a dance to move any excess [] to the end
674 conv += "[" + ty_info.subty.java_hu_ty.split("<")[0].split("[")[1]
676 def cleanup_converted_native_array(self, ty_info, arr_name):
679 def primitive_arr_from_hu(self, mapped_ty, fixed_len, arr_name):
680 if fixed_len is not None:
681 return ("InternalUtils.check_arr_len(" + arr_name + ", " + fixed_len + ")", "")
683 def primitive_arr_to_hu(self, primitive_ty, fixed_len, arr_name, conv_name):
686 def java_arr_ty_str(self, elem_ty_str):
687 return elem_ty_str + "[]"
689 def for_n_in_range(self, n, minimum, maximum):
690 return "for (int " + n + " = " + minimum + "; " + n + " < " + maximum + "; " + n + "++) {"
691 def for_n_in_arr(self, n, arr_name, arr_elem_ty):
692 return ("for (" + arr_elem_ty.java_hu_ty + " " + n + ": " + arr_name + ") { ", " }")
694 def get_ptr(self, var):
696 def set_null_skip_free(self, var):
697 return var + ".ptr" + " = 0;"
699 def add_ref(self, holder, referent):
700 return holder + ".ptrs_to.add(" + referent + ")"
702 def native_c_unitary_enum_map(self, struct_name, variants, enum_doc_comment):
703 out_java_enum = "package org.ldk.enums;\n\n"
706 out_c += "static inline LDK" + struct_name + " LDK" + struct_name + "_from_java(" + self.c_fn_args_pfx + ") {\n"
707 out_c += "\tjint ord = (*env)->CallIntMethod(env, clz, ordinal_meth);\n"
708 out_c += "\tif (UNLIKELY((*env)->ExceptionCheck(env))) {\n"
709 out_c += "\t\t(*env)->ExceptionDescribe(env);\n"
710 out_c += "\t\t(*env)->FatalError(env, \"A call to " + struct_name + ".ordinal() from rust threw an exception.\");\n"
712 out_c += "\tswitch (ord) {\n"
714 if enum_doc_comment is not None:
715 out_java_enum += "/**\n * " + enum_doc_comment.replace("\n", "\n * ") + "\n */\n"
716 out_java_enum += "public enum " + struct_name + " {\n"
718 for var, var_docs in variants:
719 if var_docs is not None:
720 out_java_enum += "\t/**\n\t * " + var_docs.replace("\n", "\n\t * ") + "\n\t */\n"
721 out_java_enum += "\t" + var + ",\n"
722 out_c = out_c + "\t\tcase %d: return %s;\n" % (ord_v, var)
724 out_java_enum = out_java_enum + "\t; static native void init();\n"
725 out_java_enum = out_java_enum + "\tstatic { init(); }\n"
726 out_java_enum = out_java_enum + "}"
727 out_java = out_java + "\tstatic { " + struct_name + ".values(); /* Force enum statics to run */ }\n"
729 out_c += "\t(*env)->FatalError(env, \"A call to " + struct_name + ".ordinal() from rust returned an invalid value.\");\n"
730 out_c += "\tabort(); // Unreachable, but will let the compiler know we don't return here\n"
733 out_c = out_c + "static jclass " + struct_name + "_class = NULL;\n"
734 for var, _ in variants:
735 out_c = out_c + "static jfieldID " + struct_name + "_" + var + " = NULL;\n"
736 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"
737 out_c = out_c + "\t" + struct_name + "_class = (*env)->NewGlobalRef(env, clz);\n"
738 out_c = out_c + "\tCHECK(" + struct_name + "_class != NULL);\n"
739 for var, _ in variants:
740 out_c = out_c + "\t" + struct_name + "_" + var + " = (*env)->GetStaticFieldID(env, " + struct_name + "_class, \"" + var + "\", \"Lorg/ldk/enums/" + struct_name + ";\");\n"
741 out_c = out_c + "\tCHECK(" + struct_name + "_" + var + " != NULL);\n"
742 out_c = out_c + "}\n"
743 out_c = out_c + "static inline jclass LDK" + struct_name + "_to_java(JNIEnv *env, LDK" + struct_name + " val) {\n"
744 out_c = out_c + "\tswitch (val) {\n"
746 for var, _ in variants:
747 out_c = out_c + "\t\tcase " + var + ":\n"
748 out_c = out_c + "\t\t\treturn (*env)->GetStaticObjectField(env, " + struct_name + "_class, " + struct_name + "_" + var + ");\n"
750 out_c = out_c + "\t\tdefault: abort();\n"
751 out_c = out_c + "\t}\n"
752 out_c = out_c + "}\n\n"
754 return (out_c, out_java_enum, out_java)
756 def c_unitary_enum_to_native_call(self, ty_info):
757 return (ty_info.rust_obj + "_to_java(env, ", ")")
758 def native_unitary_enum_to_c_call(self, ty_info):
759 return (ty_info.rust_obj + "_from_java(env, ", ")")
761 def c_complex_enum_pfx(self, struct_name, variants, init_meth_jty_strs):
764 out_c = out_c + "static jclass " + struct_name + "_" + var + "_class = NULL;\n"
765 out_c = out_c + "static jmethodID " + struct_name + "_" + var + "_meth = NULL;\n"
766 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"
767 for var_name in variants:
768 out_c += "\t" + struct_name + "_" + var_name + "_class =\n"
769 out_c += "\t\t(*env)->NewGlobalRef(env, (*env)->FindClass(env, \"org/ldk/impl/bindings$" + struct_name + "$" + var_name + "\"));\n"
770 out_c += "\tCHECK(" + struct_name + "_" + var_name + "_class != NULL);\n"
771 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"
772 out_c += "\tCHECK(" + struct_name + "_" + var_name + "_meth != NULL);\n"
773 out_c = out_c + "}\n"
776 def c_complex_enum_pass_ty(self, struct_name):
779 def c_constr_native_complex_enum(self, struct_name, variant, c_params):
780 ret = "(*env)->NewObject(env, " + struct_name + "_" + variant + "_class, " + struct_name + "_" + variant + "_meth"
781 for param in c_params:
782 ret = ret + ", " + param
785 def native_c_map_trait(self, struct_name, field_vars, flattened_field_vars, field_fns, trait_doc_comment):
789 # First generate most of the Java code, note that we need information about java method argument strings for C
790 out_java_trait = out_java_trait + self.hu_struct_file_prefix
791 if trait_doc_comment is not None:
792 out_java_trait += "/**\n * " + trait_doc_comment.replace("\n", "\n * ") + "\n */\n"
793 out_java_trait += "@SuppressWarnings(\"unchecked\") // We correctly assign various generic arrays\n"
794 out_java_trait = out_java_trait + "public class " + struct_name.replace("LDK","") + " extends CommonBase {\n"
795 out_java_trait = out_java_trait + "\tfinal bindings." + struct_name + " bindings_instance;\n"
796 out_java_trait = out_java_trait + "\t" + struct_name.replace("LDK", "") + "(Object _dummy, long ptr) { super(ptr); bindings_instance = null; }\n"
797 out_java_trait = out_java_trait + "\tprivate " + struct_name.replace("LDK", "") + "(bindings." + struct_name + " arg"
798 for var in flattened_field_vars:
799 if isinstance(var, ConvInfo):
800 out_java_trait = out_java_trait + ", " + var.java_hu_ty + " " + var.arg_name
802 out_java_trait = out_java_trait + ", bindings." + var[0] + " " + var[1]
803 out_java_trait = out_java_trait + ") {\n"
804 out_java_trait = out_java_trait + "\t\tsuper(bindings." + struct_name + "_new(arg"
805 for var in flattened_field_vars:
806 if isinstance(var, ConvInfo):
807 if var.from_hu_conv is not None:
808 out_java_trait = out_java_trait + ", " + var.from_hu_conv[0]
810 out_java_trait = out_java_trait + ", " + var.arg_name
812 out_java_trait = out_java_trait + ", " + var[1]
813 out_java_trait = out_java_trait + "));\n"
814 out_java_trait = out_java_trait + "\t\tthis.ptrs_to.add(arg);\n"
815 for var in flattened_field_vars:
816 if isinstance(var, ConvInfo):
817 if var.from_hu_conv is not None and var.from_hu_conv[1] != "":
818 out_java_trait = out_java_trait + "\t\t" + var.from_hu_conv[1].replace("\n", "\n\t\t") + ";\n"
820 out_java_trait = out_java_trait + "\t\tthis.ptrs_to.add(" + var[1] + ");\n"
821 out_java_trait = out_java_trait + "\t\tthis.bindings_instance = arg;\n"
822 out_java_trait = out_java_trait + "\t}\n"
823 out_java_trait = out_java_trait + "\t@Override @SuppressWarnings(\"deprecation\")\n"
824 out_java_trait = out_java_trait + "\tprotected void finalize() throws Throwable {\n"
825 out_java_trait = out_java_trait + "\t\tif (ptr != 0) { bindings." + struct_name.replace("LDK","") + "_free(ptr); } super.finalize();\n"
826 out_java_trait = out_java_trait + "\t}\n\n"
828 java_trait_constr = "\tprivate static class " + struct_name + "Holder { " + struct_name.replace("LDK", "") + " held; }\n"
829 java_trait_constr = java_trait_constr + "\tpublic static " + struct_name.replace("LDK", "") + " new_impl(" + struct_name.replace("LDK", "") + "Interface arg"
830 for var in flattened_field_vars:
831 if isinstance(var, ConvInfo):
832 java_trait_constr = java_trait_constr + ", " + var.java_hu_ty + " " + var.arg_name
834 # Ideally we'd be able to take any instance of the interface, but our C code can only represent
835 # Java-implemented version, so we require users pass a Java implementation here :/
836 java_trait_constr = java_trait_constr + ", " + var[0].replace("LDK", "") + "." + var[0].replace("LDK", "") + "Interface " + var[1] + "_impl"
837 java_trait_constr = java_trait_constr + ") {\n\t\tfinal " + struct_name + "Holder impl_holder = new " + struct_name + "Holder();\n"
838 java_trait_constr = java_trait_constr + "\t\timpl_holder.held = new " + struct_name.replace("LDK", "") + "(new bindings." + struct_name + "() {\n"
839 out_java_trait = out_java_trait + "\tpublic static interface " + struct_name.replace("LDK", "") + "Interface {\n"
840 out_java = out_java + "\tpublic interface " + struct_name + " {\n"
842 for fn_line in field_fns:
843 java_meth_descr = "("
844 if fn_line.fn_name != "free" and fn_line.fn_name != "cloned":
845 out_java = out_java + "\t\t " + fn_line.ret_ty_info.java_ty + " " + fn_line.fn_name + "("
846 java_trait_constr = java_trait_constr + "\t\t\t@Override public " + fn_line.ret_ty_info.java_ty + " " + fn_line.fn_name + "("
847 out_java_trait += "\t\t/**\n\t\t * " + fn_line.docs.replace("\n", "\n\t\t * ") + "\n\t\t */\n"
848 out_java_trait = out_java_trait + "\t\t" + fn_line.ret_ty_info.java_hu_ty + " " + fn_line.fn_name + "("
850 for idx, arg_conv_info in enumerate(fn_line.args_ty):
852 out_java = out_java + ", "
853 java_trait_constr = java_trait_constr + ", "
854 out_java_trait = out_java_trait + ", "
855 out_java = out_java + arg_conv_info.java_ty + " " + arg_conv_info.arg_name
856 out_java_trait = out_java_trait + arg_conv_info.java_hu_ty + " " + arg_conv_info.arg_name
857 java_trait_constr = java_trait_constr + arg_conv_info.java_ty + " " + arg_conv_info.arg_name
858 java_meth_descr = java_meth_descr + arg_conv_info.java_fn_ty_arg
859 java_meth_descr = java_meth_descr + ")" + fn_line.ret_ty_info.java_fn_ty_arg
860 java_meths.append((fn_line.fn_name, java_meth_descr))
862 out_java = out_java + ");\n"
863 out_java_trait = out_java_trait + ");\n"
864 java_trait_constr = java_trait_constr + ") {\n"
866 for arg_info in fn_line.args_ty:
867 if arg_info.to_hu_conv is not None:
868 java_trait_constr = java_trait_constr + "\t\t\t\t" + arg_info.to_hu_conv.replace("\n", "\n\t\t\t\t") + "\n"
870 if fn_line.ret_ty_info.java_ty != "void":
871 java_trait_constr = java_trait_constr + "\t\t\t\t" + fn_line.ret_ty_info.java_hu_ty + " ret = arg." + fn_line.fn_name + "("
873 java_trait_constr = java_trait_constr + "\t\t\t\targ." + fn_line.fn_name + "("
875 for idx, arg_info in enumerate(fn_line.args_ty):
877 java_trait_constr = java_trait_constr + ", "
878 if arg_info.to_hu_conv_name is not None:
879 java_trait_constr = java_trait_constr + arg_info.to_hu_conv_name
881 java_trait_constr = java_trait_constr + arg_info.arg_name
883 java_trait_constr = java_trait_constr + ");\n"
884 if fn_line.ret_ty_info.java_ty != "void":
885 if fn_line.ret_ty_info.from_hu_conv is not None:
886 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"
887 if fn_line.ret_ty_info.from_hu_conv[1] != "":
888 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"
889 #if fn_line.ret_ty_info.rust_obj in result_types:
890 java_trait_constr = java_trait_constr + "\t\t\t\treturn result;\n"
892 java_trait_constr = java_trait_constr + "\t\t\t\treturn ret;\n"
893 java_trait_constr = java_trait_constr + "\t\t\t}\n"
894 java_trait_constr = java_trait_constr + "\t\t}"
895 for var in field_vars:
896 if isinstance(var, ConvInfo):
897 java_trait_constr = java_trait_constr + ", " + var.arg_name
899 java_trait_constr += ", " + var[1] + ".new_impl(" + var[1] + "_impl"
900 for suparg in var[2]:
901 if isinstance(suparg, ConvInfo):
902 java_trait_constr += ", " + suparg.arg_name
904 java_trait_constr += ", " + suparg[1]
905 java_trait_constr += ").bindings_instance"
906 for suparg in var[2]:
907 if isinstance(suparg, ConvInfo):
908 java_trait_constr += ", " + suparg.arg_name
910 java_trait_constr += ", " + suparg[1]
911 out_java_trait = out_java_trait + "\t}\n"
912 out_java_trait = out_java_trait + java_trait_constr + ");\n\t\treturn impl_holder.held;\n\t}\n"
914 out_java = out_java + "\t}\n"
916 out_java = out_java + "\tpublic static native long " + struct_name + "_new(" + struct_name + " impl"
917 for var in flattened_field_vars:
918 if isinstance(var, ConvInfo):
919 out_java = out_java + ", " + var.java_ty + " " + var.arg_name
921 out_java = out_java + ", " + var[0] + " " + var[1]
922 out_java = out_java + ");\n"
924 # Now that we've written out our java code (and created java_meths), generate C
925 out_c = "typedef struct " + struct_name + "_JCalls {\n"
926 out_c = out_c + "\tatomic_size_t refcnt;\n"
927 out_c = out_c + "\tJavaVM *vm;\n"
928 out_c = out_c + "\tjweak o;\n"
929 for var in flattened_field_vars:
930 if isinstance(var, ConvInfo):
931 # We're a regular ol' field
935 out_c = out_c + "\t" + var[0] + "_JCalls* " + var[1] + ";\n"
937 if fn.fn_name != "free" and fn.fn_name != "cloned":
938 out_c = out_c + "\tjmethodID " + fn.fn_name + "_meth;\n"
939 out_c = out_c + "} " + struct_name + "_JCalls;\n"
941 for fn_line in field_fns:
942 if fn_line.fn_name == "free":
943 out_c = out_c + "static void " + struct_name + "_JCalls_free(void* this_arg) {\n"
944 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) this_arg;\n"
945 out_c = out_c + "\tif (atomic_fetch_sub_explicit(&j_calls->refcnt, 1, memory_order_acquire) == 1) {\n"
946 out_c += "\t\t" + self.construct_jenv().replace("\n", "\n\t\t").strip() + "\n"
947 out_c = out_c + "\t\t(*env)->DeleteWeakGlobalRef(env, j_calls->o);\n"
948 out_c += "\t\t" + self.deconstruct_jenv().replace("\n", "\n\t\t").strip() + "\n"
949 out_c = out_c + "\t\tFREE(j_calls);\n"
950 out_c = out_c + "\t}\n}\n"
952 for idx, fn_line in enumerate(field_fns):
953 if fn_line.fn_name != "free" and fn_line.fn_name != "cloned":
954 assert fn_line.ret_ty_info.ty_info.get_full_rust_ty()[1] == ""
955 out_c = out_c + fn_line.ret_ty_info.ty_info.get_full_rust_ty()[0] + " " + fn_line.fn_name + "_" + struct_name + "_jcall("
956 if fn_line.self_is_const:
957 out_c = out_c + "const void* this_arg"
959 out_c = out_c + "void* this_arg"
961 for idx, arg in enumerate(fn_line.args_ty):
962 out_c = out_c + ", " + arg.ty_info.get_full_rust_ty()[0] + " " + arg.arg_name + arg.ty_info.get_full_rust_ty()[1]
964 out_c = out_c + ") {\n"
965 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) this_arg;\n"
966 out_c += "\t" + self.construct_jenv().replace("\n", "\n\t").strip() + "\n"
968 for arg_info in fn_line.args_ty:
969 if arg_info.ret_conv is not None:
970 out_c = out_c + "\t" + arg_info.ret_conv[0].replace('\n', '\n\t')
971 out_c = out_c + arg_info.arg_name
972 out_c = out_c + arg_info.ret_conv[1].replace('\n', '\n\t') + "\n"
974 out_c = out_c + "\tjobject obj = (*env)->NewLocalRef(env, j_calls->o);\n\tCHECK(obj != NULL);\n"
975 if fn_line.ret_ty_info.c_ty.endswith("Array"):
976 out_c = out_c + "\t" + fn_line.ret_ty_info.c_ty + " ret = (*env)->CallObjectMethod(env, obj, j_calls->" + fn_line.fn_name + "_meth"
977 elif fn_line.ret_ty_info.c_ty == "void":
978 out_c += "\t(*env)->Call" + fn_line.ret_ty_info.java_ty.title() + "Method(env, obj, j_calls->" + fn_line.fn_name + "_meth"
979 elif fn_line.ret_ty_info.java_hu_ty == "String":
980 # Manually write out String methods as they're just an Object
981 out_c += "\t" + fn_line.ret_ty_info.c_ty + " ret = (*env)->CallObjectMethod(env, obj, j_calls->" + fn_line.fn_name + "_meth"
982 elif not fn_line.ret_ty_info.passed_as_ptr:
983 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"
985 out_c = out_c + "\tuint64_t ret = (*env)->CallLongMethod(env, obj, j_calls->" + fn_line.fn_name + "_meth"
987 for idx, arg_info in enumerate(fn_line.args_ty):
988 if arg_info.ret_conv is not None:
989 out_c = out_c + ", " + arg_info.ret_conv_name
991 out_c = out_c + ", " + arg_info.arg_name
992 out_c = out_c + ");\n"
994 out_c += "\tif (UNLIKELY((*env)->ExceptionCheck(env))) {\n"
995 out_c += "\t\t(*env)->ExceptionDescribe(env);\n"
996 out_c += "\t\t(*env)->FatalError(env, \"A call to " + fn_line.fn_name + " in " + struct_name + " from rust threw an exception.\");\n"
999 if fn_line.ret_ty_info.arg_conv is not None:
1000 out_c += "\t" + fn_line.ret_ty_info.arg_conv.replace("\n", "\n\t") + "\n"
1001 out_c += "\t" + self.deconstruct_jenv().replace("\n", "\n\t").strip() + "\n"
1002 out_c += "\treturn " + fn_line.ret_ty_info.arg_conv_name + ";\n"
1004 out_c += "\t" + self.deconstruct_jenv().replace("\n", "\n\t").strip() + "\n"
1005 if not fn_line.ret_ty_info.passed_as_ptr and fn_line.ret_ty_info.c_ty != "void":
1006 out_c += "\treturn ret;\n"
1008 out_c = out_c + "}\n"
1010 # If we can, write out a clone function whether we need one or not, as we use them in moving to rust
1011 can_clone_with_ptr = True
1012 for var in field_vars:
1013 if isinstance(var, ConvInfo):
1014 can_clone_with_ptr = False
1015 if can_clone_with_ptr:
1016 out_c = out_c + "static void " + struct_name + "_JCalls_cloned(" + struct_name + "* new_obj) {\n"
1017 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) new_obj->this_arg;\n"
1018 out_c = out_c + "\tatomic_fetch_add_explicit(&j_calls->refcnt, 1, memory_order_release);\n"
1019 for var in field_vars:
1020 if not isinstance(var, ConvInfo):
1021 out_c = out_c + "\tatomic_fetch_add_explicit(&j_calls->" + var[1] + "->refcnt, 1, memory_order_release);\n"
1022 out_c = out_c + "}\n"
1024 out_c = out_c + "static inline " + struct_name + " " + struct_name + "_init (" + self.c_fn_args_pfx + ", jobject o"
1025 for var in flattened_field_vars:
1026 if isinstance(var, ConvInfo):
1027 out_c = out_c + ", " + var.c_ty + " " + var.arg_name
1029 out_c = out_c + ", jobject " + var[1]
1030 out_c = out_c + ") {\n"
1032 out_c = out_c + "\tjclass c = (*env)->GetObjectClass(env, o);\n"
1033 out_c = out_c + "\tCHECK(c != NULL);\n"
1034 out_c = out_c + "\t" + struct_name + "_JCalls *calls = MALLOC(sizeof(" + struct_name + "_JCalls), \"" + struct_name + "_JCalls\");\n"
1035 out_c = out_c + "\tatomic_init(&calls->refcnt, 1);\n"
1036 out_c = out_c + "\tDO_ASSERT((*env)->GetJavaVM(env, &calls->vm) == 0);\n"
1037 out_c = out_c + "\tcalls->o = (*env)->NewWeakGlobalRef(env, o);\n"
1039 for (fn_name, java_meth_descr) in java_meths:
1040 if fn_name != "free" and fn_name != "cloned":
1041 out_c = out_c + "\tcalls->" + fn_name + "_meth = (*env)->GetMethodID(env, c, \"" + fn_name + "\", \"" + java_meth_descr + "\");\n"
1042 out_c = out_c + "\tCHECK(calls->" + fn_name + "_meth != NULL);\n"
1044 for var in flattened_field_vars:
1045 if isinstance(var, ConvInfo) and var.arg_conv is not None:
1046 out_c = out_c + "\n\t" + var.arg_conv.replace("\n", "\n\t") +"\n"
1047 out_c = out_c + "\n\t" + struct_name + " ret = {\n"
1048 out_c = out_c + "\t\t.this_arg = (void*) calls,\n"
1049 for fn_line in field_fns:
1050 if fn_line.fn_name != "free" and fn_line.fn_name != "cloned":
1051 out_c = out_c + "\t\t." + fn_line.fn_name + " = " + fn_line.fn_name + "_" + struct_name + "_jcall,\n"
1052 elif fn_line.fn_name == "free":
1053 out_c = out_c + "\t\t.free = " + struct_name + "_JCalls_free,\n"
1055 out_c = out_c + "\t\t.cloned = " + struct_name + "_JCalls_cloned,\n"
1056 for var in field_vars:
1057 if isinstance(var, ConvInfo):
1058 if var.arg_conv_name is not None:
1059 out_c = out_c + "\t\t." + var.arg_name + " = " + var.arg_conv_name + ",\n"
1060 out_c = out_c + "\t\t.set_" + var.arg_name + " = NULL,\n"
1062 out_c = out_c + "\t\t." + var.var_name + " = " + var.var_name + ",\n"
1063 out_c = out_c + "\t\t.set_" + var.var_name + " = NULL,\n"
1065 out_c += "\t\t." + var[1] + " = " + var[0] + "_init(env, clz, " + var[1]
1066 for suparg in var[2]:
1067 if isinstance(suparg, ConvInfo):
1068 out_c = out_c + ", " + suparg.arg_name
1070 out_c = out_c + ", " + suparg[1]
1072 out_c = out_c + "\t};\n"
1073 for var in flattened_field_vars:
1074 if not isinstance(var, ConvInfo):
1075 out_c = out_c + "\tcalls->" + var[1] + " = ret." + var[1] + ".this_arg;\n"
1076 out_c = out_c + "\treturn ret;\n"
1077 out_c = out_c + "}\n"
1079 out_c = out_c + self.c_fn_ty_pfx + "int64_t " + self.c_fn_name_define_pfx(struct_name + "_new", True) + "jobject o"
1080 for var in flattened_field_vars:
1081 if isinstance(var, ConvInfo):
1082 out_c = out_c + ", " + var.c_ty + " " + var.arg_name
1084 out_c = out_c + ", jobject " + var[1]
1085 out_c = out_c + ") {\n"
1086 out_c = out_c + "\t" + struct_name + " *res_ptr = MALLOC(sizeof(" + struct_name + "), \"" + struct_name + "\");\n"
1087 out_c = out_c + "\t*res_ptr = " + struct_name + "_init(env, clz, o"
1088 for var in flattened_field_vars:
1089 if isinstance(var, ConvInfo):
1090 out_c = out_c + ", " + var.arg_name
1092 out_c = out_c + ", " + var[1]
1093 out_c = out_c + ");\n"
1094 out_c = out_c + "\treturn (uint64_t)res_ptr;\n"
1095 out_c = out_c + "}\n"
1097 for var in flattened_field_vars:
1098 if not isinstance(var, ConvInfo):
1099 out_java_trait += "\n\t/**\n"
1100 out_java_trait += "\t * Gets the underlying " + var[1] + ".\n"
1101 out_java_trait += "\t */\n"
1102 underscore_name = ''.join('_' + c.lower() if c.isupper() else c for c in var[1]).strip('_')
1103 out_java_trait += "\tpublic " + var[1] + " get_" + underscore_name + "() {\n"
1104 out_java_trait += "\t\t" + var[1] + " res = new " + var[1] + "(null, bindings." + struct_name + "_get_" + var[1] + "(this.ptr));\n"
1105 out_java_trait += "\t\tthis.ptrs_to.add(res);\n"
1106 out_java_trait += "\t\treturn res;\n"
1107 out_java_trait += "\t}\n"
1108 out_java_trait += "\n"
1110 out_java += "\tpublic static native long " + struct_name + "_get_" + var[1] + "(long arg);\n"
1112 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"
1113 out_c += "\t" + struct_name + " *inp = (" + struct_name + " *)(arg & ~1);\n"
1114 out_c += "\tuint64_t res_ptr = (uint64_t)&inp->" + var[1] + ";\n"
1115 out_c += "\tDO_ASSERT((res_ptr & 1) == 0);\n"
1116 out_c += "\treturn (int64_t)(res_ptr | 1);\n"
1119 return (out_java, out_java_trait, out_c)
1121 def trait_struct_inc_refcnt(self, ty_info):
1122 base_conv = "\nif (" + ty_info.var_name + "_conv.free == " + ty_info.rust_obj + "_JCalls_free) {\n"
1123 base_conv = base_conv + "\t// If this_arg is a JCalls struct, then we need to increment the refcnt in it.\n"
1124 base_conv = base_conv + "\t" + ty_info.rust_obj + "_JCalls_cloned(&" + ty_info.var_name + "_conv);\n}"
1127 def map_complex_enum(self, struct_name, variant_list, camel_to_snake, enum_doc_comment):
1128 java_hu_type = struct_name.replace("LDK", "").replace("COption", "Option")
1133 out_java_enum += (self.hu_struct_file_prefix)
1134 out_java_enum += "\n/**\n * " + enum_doc_comment.replace("\n", "\n * ") + "\n */\n"
1135 out_java_enum += "@SuppressWarnings(\"unchecked\") // We correctly assign various generic arrays\n"
1136 out_java_enum += ("public class " + java_hu_type + " extends CommonBase {\n")
1137 out_java_enum += ("\tprivate " + java_hu_type + "(Object _dummy, long ptr) { super(ptr); }\n")
1138 out_java_enum += ("\t@Override @SuppressWarnings(\"deprecation\")\n")
1139 out_java_enum += ("\tprotected void finalize() throws Throwable {\n")
1140 out_java_enum += ("\t\tsuper.finalize();\n")
1141 out_java_enum += ("\t\tif (ptr != 0) { bindings." + struct_name.replace("LDK", "") + "_free(ptr); }\n")
1142 out_java_enum += ("\t}\n")
1143 out_java_enum += ("\tstatic " + java_hu_type + " constr_from_ptr(long ptr) {\n")
1144 out_java_enum += ("\t\tbindings." + struct_name + " raw_val = bindings." + struct_name + "_ref_from_ptr(ptr);\n")
1145 java_hu_subclasses = ""
1147 init_meth_jty_strs = {}
1149 out_java += ("\tpublic static class " + struct_name + " {\n")
1150 out_java += ("\t\tprivate " + struct_name + "() {}\n")
1151 for var in variant_list:
1152 out_java += ("\t\tpublic final static class " + var.var_name + " extends " + struct_name + " {\n")
1153 if var.var_docs is not None:
1154 java_hu_subclasses += "\t/**\n\t * " + var.var_docs.replace("\n", "\n\t * ") + "\n\t */\n"
1155 java_hu_subclasses += "\tpublic final static class " + var.var_name + " extends " + java_hu_type + " {\n"
1156 out_java_enum += ("\t\tif (raw_val.getClass() == bindings." + struct_name + "." + var.var_name + ".class) {\n")
1157 out_java_enum += ("\t\t\treturn new " + var.var_name + "(ptr, (bindings." + struct_name + "." + var.var_name + ")raw_val);\n")
1158 init_meth_jty_str = ""
1159 init_meth_params = ""
1162 for idx, (field_ty, field_docs) in enumerate(var.fields):
1164 init_meth_params = init_meth_params + ", "
1166 if field_ty.java_hu_ty == var.var_name:
1167 field_path = field_ty.java_fn_ty_arg.strip("L;").replace("/", ".")
1168 out_java += "\t\t\tpublic " + field_path + " " + field_ty.arg_name + ";\n"
1169 java_hu_subclasses = java_hu_subclasses + "\t\tpublic final " + field_path + " " + field_ty.arg_name + ";\n"
1170 init_meth_params = init_meth_params + field_path + " " + field_ty.arg_name
1172 out_java += "\t\t\tpublic " + field_ty.java_ty + " " + field_ty.arg_name + ";\n"
1173 if field_docs is not None:
1174 java_hu_subclasses += "\t\t/**\n\t\t * " + field_docs.replace("\n", "\n\t\t * ") + "\n\t\t*/\n"
1175 java_hu_subclasses += "\t\t"
1176 if field_ty.nullable:
1177 java_hu_subclasses += "@Nullable "
1178 java_hu_subclasses += "public final " + field_ty.java_hu_ty + " " + field_ty.arg_name + ";\n"
1179 init_meth_params = init_meth_params + field_ty.java_ty + " " + field_ty.arg_name
1180 init_meth_body = init_meth_body + "this." + field_ty.arg_name + " = " + field_ty.arg_name + "; "
1181 if field_ty.to_hu_conv is not None:
1182 hu_conv_body = hu_conv_body + "\t\t\t" + field_ty.java_ty + " " + field_ty.arg_name + " = obj." + field_ty.arg_name + ";\n"
1183 hu_conv_body = hu_conv_body + "\t\t\t" + field_ty.to_hu_conv.replace("\n", "\n\t\t\t") + "\n"
1184 hu_conv_body = hu_conv_body + "\t\t\tthis." + field_ty.arg_name + " = " + field_ty.to_hu_conv_name + ";\n"
1186 hu_conv_body = hu_conv_body + "\t\t\tthis." + field_ty.arg_name + " = obj." + field_ty.arg_name + ";\n"
1187 init_meth_jty_str = init_meth_jty_str + field_ty.java_fn_ty_arg
1188 out_java += ("\t\t\t" + var.var_name + "(" + init_meth_params + ") { ")
1189 out_java += (init_meth_body)
1191 out_java += ("\t\t}\n")
1192 out_java_enum += ("\t\t}\n")
1193 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"
1194 java_hu_subclasses = java_hu_subclasses + hu_conv_body
1195 java_hu_subclasses = java_hu_subclasses + "\t\t}\n\t}\n"
1196 init_meth_jty_strs[var.var_name] = init_meth_jty_str
1197 out_java += ("\t\tstatic native void init();\n")
1198 out_java += ("\t}\n")
1199 out_java_enum += ("\t\tassert false; return null; // Unreachable without extending the (internal) bindings interface\n\t}\n\n")
1200 out_java_enum += (java_hu_subclasses)
1201 out_java += ("\tstatic { " + struct_name + ".init(); }\n")
1202 out_java += ("\tpublic static native " + struct_name + " " + struct_name + "_ref_from_ptr(long ptr);\n");
1204 out_c += (self.c_complex_enum_pfx(struct_name, [x.var_name for x in variant_list], init_meth_jty_strs))
1206 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")
1207 out_c += ("\t" + struct_name + " *obj = (" + struct_name + "*)(ptr & ~1);\n")
1208 out_c += ("\tswitch(obj->tag) {\n")
1209 for var in variant_list:
1210 out_c += ("\t\tcase " + struct_name + "_" + var.var_name + ": {\n")
1212 for idx, (field_map, field_docs) in enumerate(var.fields):
1213 if field_map.ret_conv is not None:
1214 out_c += ("\t\t\t" + field_map.ret_conv[0].replace("\n", "\n\t\t\t"))
1215 if var.tuple_variant:
1216 out_c += "obj->" + camel_to_snake(var.var_name)
1218 out_c += "obj->" + camel_to_snake(var.var_name) + "." + field_map.arg_name
1219 out_c += (field_map.ret_conv[1].replace("\n", "\n\t\t\t") + "\n")
1220 c_params.append(field_map.ret_conv_name)
1222 if var.tuple_variant:
1223 c_params.append("obj->" + camel_to_snake(var.var_name))
1225 c_params.append("obj->" + camel_to_snake(var.var_name) + "." + field_map.arg_name)
1226 out_c += ("\t\t\treturn " + self.c_constr_native_complex_enum(struct_name, var.var_name, c_params) + ";\n")
1227 out_c += ("\t\t}\n")
1228 out_c += ("\t\tdefault: abort();\n")
1229 out_c += ("\t}\n}\n")
1230 return (out_java, out_java_enum, out_c)
1232 def map_opaque_struct(self, struct_name, struct_doc_comment):
1233 out_opaque_struct_human = ""
1234 out_opaque_struct_human += self.hu_struct_file_prefix
1235 out_opaque_struct_human += "\n/**\n * " + struct_doc_comment.replace("\n", "\n * ") + "\n */\n"
1236 out_opaque_struct_human += "@SuppressWarnings(\"unchecked\") // We correctly assign various generic arrays\n"
1237 hu_name = struct_name.replace("LDKC2Tuple", "TwoTuple").replace("LDKC3Tuple", "ThreeTuple").replace("LDK", "")
1238 out_opaque_struct_human += ("public class " + hu_name + " extends CommonBase")
1239 if struct_name.startswith("LDKLocked"):
1240 out_opaque_struct_human += (" implements AutoCloseable")
1241 out_opaque_struct_human += (" {\n")
1242 out_opaque_struct_human += ("\t" + hu_name + "(Object _dummy, long ptr) { super(ptr); }\n")
1243 if struct_name.startswith("LDKLocked"):
1244 out_opaque_struct_human += ("\t@Override public void close() {\n")
1246 out_opaque_struct_human += ("\t@Override @SuppressWarnings(\"deprecation\")\n")
1247 out_opaque_struct_human += ("\tprotected void finalize() throws Throwable {\n")
1248 out_opaque_struct_human += ("\t\tsuper.finalize();\n")
1249 out_opaque_struct_human += ("\t\tif (ptr != 0) { bindings." + struct_name.replace("LDK","") + "_free(ptr); }\n")
1250 out_opaque_struct_human += ("\t}\n\n")
1251 return out_opaque_struct_human
1253 def map_tuple(self, struct_name):
1254 return self.map_opaque_struct(struct_name, "A Tuple")
1256 def map_result(self, struct_name, res_map, err_map):
1257 human_ty = struct_name.replace("LDKCResult", "Result")
1259 java_hu_struct += self.hu_struct_file_prefix
1260 java_hu_struct += "public class " + human_ty + " extends CommonBase {\n"
1261 java_hu_struct += "\tprivate " + human_ty + "(Object _dummy, long ptr) { super(ptr); }\n"
1262 java_hu_struct += "\tprotected void finalize() throws Throwable {\n"
1263 java_hu_struct += "\t\tif (ptr != 0) { bindings." + struct_name.replace("LDK","") + "_free(ptr); } super.finalize();\n"
1264 java_hu_struct += "\t}\n\n"
1265 java_hu_struct += "\tstatic " + human_ty + " constr_from_ptr(long ptr) {\n"
1266 java_hu_struct += "\t\tif (bindings." + struct_name.replace("LDK", "") + "_is_ok(ptr)) {\n"
1267 java_hu_struct += "\t\t\treturn new " + human_ty + "_OK(null, ptr);\n"
1268 java_hu_struct += "\t\t} else {\n"
1269 java_hu_struct += "\t\t\treturn new " + human_ty + "_Err(null, ptr);\n"
1270 java_hu_struct += "\t\t}\n"
1271 java_hu_struct += "\t}\n"
1273 java_hu_struct += "\tpublic static final class " + human_ty + "_OK extends " + human_ty + " {\n"
1275 if res_map.java_hu_ty != "void":
1276 java_hu_struct += "\t\tpublic final " + res_map.java_hu_ty + " res;\n"
1277 java_hu_struct += "\t\tprivate " + human_ty + "_OK(Object _dummy, long ptr) {\n"
1278 java_hu_struct += "\t\t\tsuper(_dummy, ptr);\n"
1279 if res_map.java_hu_ty == "void":
1281 elif res_map.to_hu_conv is not None:
1282 java_hu_struct += "\t\t\t" + res_map.java_ty + " res = bindings." + struct_name.replace("LDK", "") + "_get_ok(ptr);\n"
1283 java_hu_struct += "\t\t\t" + res_map.to_hu_conv.replace("\n", "\n\t\t\t")
1284 java_hu_struct += "\n\t\t\tthis.res = " + res_map.to_hu_conv_name + ";\n"
1286 java_hu_struct += "\t\t\tthis.res = bindings." + struct_name.replace("LDK", "") + "_get_ok(ptr);\n"
1287 java_hu_struct += "\t\t}\n"
1288 java_hu_struct += "\t}\n\n"
1290 java_hu_struct += "\tpublic static final class " + human_ty + "_Err extends " + human_ty + " {\n"
1291 if err_map.java_hu_ty != "void":
1292 java_hu_struct += "\t\tpublic final " + err_map.java_hu_ty + " err;\n"
1293 java_hu_struct += "\t\tprivate " + human_ty + "_Err(Object _dummy, long ptr) {\n"
1294 java_hu_struct += "\t\t\tsuper(_dummy, ptr);\n"
1295 if err_map.java_hu_ty == "void":
1297 elif err_map.to_hu_conv is not None:
1298 java_hu_struct += "\t\t\t" + err_map.java_ty + " err = bindings." + struct_name.replace("LDK", "") + "_get_err(ptr);\n"
1299 java_hu_struct += "\t\t\t" + err_map.to_hu_conv.replace("\n", "\n\t\t\t")
1300 java_hu_struct += "\n\t\t\tthis.err = " + err_map.to_hu_conv_name + ";\n"
1302 java_hu_struct += "\t\t\tthis.err = bindings." + struct_name.replace("LDK", "") + "_get_err(ptr);\n"
1303 java_hu_struct += "\t\t}\n"
1305 java_hu_struct += "\t}\n\n"
1306 return java_hu_struct
1308 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):
1311 out_java_struct = None
1313 out_java += ("\tpublic static native ")
1314 out_c += (self.c_fn_ty_pfx)
1315 out_c += (return_type_info.c_ty)
1316 out_java += (return_type_info.java_ty)
1317 if return_type_info.ret_conv is not None:
1318 ret_conv_pfx, ret_conv_sfx = return_type_info.ret_conv
1319 out_java += (" " + method_name + "(")
1320 have_args = len(argument_types) > 1 or (len(argument_types) > 0 and argument_types[0].c_ty != "void")
1321 out_c += (" " + self.c_fn_name_define_pfx(method_name, have_args))
1323 for idx, arg_conv_info in enumerate(argument_types):
1327 if arg_conv_info.c_ty != "void":
1328 out_c += (arg_conv_info.c_ty + " " + arg_conv_info.arg_name)
1329 out_java += (arg_conv_info.java_ty + " " + arg_conv_info.arg_name)
1331 out_java_struct = ""
1332 extra_java_struct_out = ""
1334 out_java_struct += ("\t// Skipped " + method_name + "\n")
1336 if doc_comment is not None:
1337 out_java_struct += "\t/**\n\t * " + doc_comment.replace("\n", "\n\t * ") + "\n\t */\n"
1338 if return_type_info.nullable:
1339 out_java_struct += "\t@Nullable\n"
1342 out_java_struct += "\tpublic static " + return_type_info.java_hu_ty + " of("
1343 elif meth_n == "default":
1344 out_java_struct += "\tpublic static " + return_type_info.java_hu_ty + " with_default("
1346 out_java_struct += "\tpublic static " + return_type_info.java_hu_ty + " " + meth_n + "("
1347 elif meth_n == "clone_ptr" or (struct_meth.startswith("LDKCResult") and (meth_n == "get_ok" or meth_n == "get_err")):
1348 out_java_struct += ("\t" + return_type_info.java_hu_ty + " " + meth_n + "(")
1350 if meth_n == "hash" and return_type_info.java_hu_ty == "long":
1351 extra_java_struct_out = "\t@Override public int hashCode() {\n"
1352 extra_java_struct_out += "\t\treturn (int)this.hash();\n"
1353 extra_java_struct_out += "\t}\n"
1354 elif meth_n == "eq" and return_type_info.java_hu_ty == "boolean":
1355 extra_java_struct_out = "\t@Override public boolean equals(Object o) {\n"
1356 extra_java_struct_out += "\t\tif (!(o instanceof " + struct_meth + ")) return false;\n"
1357 extra_java_struct_out += "\t\treturn this.eq((" + struct_meth + ")o);\n"
1358 extra_java_struct_out += "\t}\n"
1359 out_java_struct += ("\tpublic " + return_type_info.java_hu_ty + " " + meth_n + "(")
1360 for idx, arg in enumerate(argument_types):
1362 if not takes_self or idx > 1:
1363 out_java_struct += ", "
1366 if arg.java_ty != "void":
1367 if arg.arg_name in default_constructor_args:
1368 assert not arg.nullable
1369 for explode_idx, explode_arg in enumerate(default_constructor_args[arg.arg_name]):
1370 if explode_idx != 0:
1371 out_java_struct += (", ")
1372 out_java_struct += (
1373 explode_arg.java_hu_ty + " " + arg.arg_name + "_" + explode_arg.arg_name)
1376 out_java_struct += "@Nullable "
1377 ty_string = arg.java_hu_ty
1378 if arg.java_fn_ty_arg[0] == "L" and arg.java_fn_ty_arg[len(arg.java_fn_ty_arg) - 1] == ";":
1379 ty_string = arg.java_fn_ty_arg.strip("L;").replace("/", ".")
1380 out_java_struct += ty_string + " " + arg.arg_name
1381 out_java += (");\n")
1383 if out_java_struct is not None:
1384 out_java_struct += (") {\n")
1385 for info in argument_types:
1386 if info.arg_conv is not None:
1387 out_c += ("\t" + info.arg_conv.replace('\n', "\n\t") + "\n")
1388 if return_type_info.ret_conv is not None:
1389 out_c += ("\t" + ret_conv_pfx.replace('\n', '\n\t'))
1390 elif return_type_info.c_ty != "void":
1391 out_c += ("\t" + return_type_info.c_ty + " ret_val = ")
1394 if c_call_string is None:
1395 out_c += (method_name + "(")
1397 out_c += (c_call_string)
1398 for idx, info in enumerate(argument_types):
1399 if info.arg_conv_name is not None:
1402 elif c_call_string is not None:
1404 out_c += (info.arg_conv_name)
1406 if return_type_info.ret_conv is not None:
1407 out_c += (ret_conv_sfx.replace('\n', '\n\t'))
1410 for info in argument_types:
1411 if info.arg_conv_cleanup is not None:
1412 out_c += ("\n\t" + info.arg_conv_cleanup.replace("\n", "\n\t"))
1413 if return_type_info.ret_conv is not None:
1414 out_c += ("\n\treturn " + return_type_info.ret_conv_name + ";")
1415 elif return_type_info.c_ty != "void":
1416 out_c += ("\n\treturn ret_val;")
1417 out_c += ("\n}\n\n")
1420 out_java_struct += ("\t\t")
1421 if return_type_info.java_ty != "void":
1422 out_java_struct += (return_type_info.java_ty + " ret = ")
1423 out_java_struct += ("bindings." + method_name + "(")
1424 for idx, info in enumerate(argument_types):
1426 out_java_struct += (", ")
1427 if idx == 0 and takes_self:
1428 out_java_struct += ("this.ptr")
1429 elif info.arg_name in default_constructor_args:
1430 out_java_struct += ("bindings." + info.java_hu_ty + "_new(")
1431 for explode_idx, explode_arg in enumerate(default_constructor_args[info.arg_name]):
1432 if explode_idx != 0:
1433 out_java_struct += (", ")
1434 expl_arg_name = info.arg_name + "_" + explode_arg.arg_name
1435 if explode_arg.from_hu_conv is not None:
1436 out_java_struct += (
1437 explode_arg.from_hu_conv[0].replace(explode_arg.arg_name, expl_arg_name))
1439 out_java_struct += (expl_arg_name)
1440 out_java_struct += (")")
1441 elif info.from_hu_conv is not None:
1442 out_java_struct += (info.from_hu_conv[0])
1444 out_java_struct += (info.arg_name)
1445 out_java_struct += (");\n")
1447 # This is completely nuts. The OpenJDK JRE JIT will optimize out a object which is on
1448 # the stack, calling its finalizer immediately even if member methods are *actively
1449 # executing* on the same object, as long as said object is on the stack. There is no
1450 # concrete specification for when the optimizer is allowed to do this, and when it is
1451 # not, so there is absolutely no way to be certain that this fix suffices.
1453 # Instead, the "Java Language Specification" says only that an object is reachable
1454 # (i.e. will not yet be finalized) if it "can be accessed in any potential continuing
1455 # computation from any live thread". To any sensible reader this would mean actively
1456 # executing a member function on an object would make it not eligible for finalization.
1457 # But, no, dear reader, this statement does not say that. Well, okay, it says that,
1458 # very explicitly in fact, but those are just, like, words, man.
1460 # In the seemingly non-normative text further down, a few examples of things the
1461 # optimizer can do are given, including "if the values in an object's fields are
1462 # stored in registers[, t]he may then access the registers instead of the object, and
1463 # never access the object again[, implying] that the object is garbage". This appears
1464 # to fully contradict both the above statement, the API documentation in java.lang.ref
1465 # regarding when a reference is "strongly reachable", and basic common sense. There is
1466 # no concrete set of limitations stated, however, seemingly implying the JIT could
1467 # decide your code would run faster by simply garbage collecting everything
1468 # immediately, ensuring your code finishes soon, just by SEGFAULT. Thus, we're really
1469 # entirely flying blind here. We add some fences and hope that its sufficient, but
1470 # with no specification to rely on, we cannot be certain of anything.
1472 # TL;DR: The Java Language "Specification" provides no real guarantees on when an
1473 # object will be considered available for garbage collection once the JIT kicks in, so
1474 # we put in some fences and hope to god the JIT doesn't get smarter/more broken.
1475 for idx, info in enumerate(argument_types):
1476 if idx == 0 and takes_self:
1477 out_java_struct += ("\t\tReference.reachabilityFence(this);\n")
1478 elif info.arg_name in default_constructor_args:
1479 for explode_idx, explode_arg in enumerate(default_constructor_args[info.arg_name]):
1480 expl_arg_name = info.arg_name + "_" + explode_arg.arg_name
1481 out_java_struct += ("\t\tReference.reachabilityFence(" + expl_arg_name + ");\n")
1482 elif info.c_ty != "void":
1483 out_java_struct += ("\t\tReference.reachabilityFence(" + info.arg_name + ");\n")
1485 if return_type_info.java_ty == "long" and return_type_info.java_hu_ty != "long":
1486 out_java_struct += "\t\tif (ret >= 0 && ret <= 4096) { return null; }\n"
1488 if return_type_info.to_hu_conv is not None:
1490 out_java_struct += ("\t\t" + return_type_info.to_hu_conv.replace("\n", "\n\t\t").replace("this",
1491 return_type_info.to_hu_conv_name) + "\n")
1493 out_java_struct += ("\t\t" + return_type_info.to_hu_conv.replace("\n", "\n\t\t") + "\n")
1495 for idx, info in enumerate(argument_types):
1496 if idx == 0 and takes_self:
1498 elif info.arg_name in default_constructor_args:
1499 for explode_arg in default_constructor_args[info.arg_name]:
1500 expl_arg_name = info.arg_name + "_" + explode_arg.arg_name
1501 if explode_arg.from_hu_conv is not None and return_type_info.to_hu_conv_name:
1502 out_java_struct += ("\t\t" + explode_arg.from_hu_conv[1].replace(explode_arg.arg_name,
1503 expl_arg_name).replace(
1504 "this", return_type_info.to_hu_conv_name) + ";\n")
1505 elif info.from_hu_conv is not None and info.from_hu_conv[1] != "":
1506 if not takes_self and return_type_info.to_hu_conv_name is not None:
1507 out_java_struct += (
1508 "\t\t" + info.from_hu_conv[1].replace("this", return_type_info.to_hu_conv_name).replace("\n", "\n\t\t") + ";\n")
1510 out_java_struct += ("\t\t" + info.from_hu_conv[1].replace("\n", "\n\t\t") + ";\n")
1512 if takes_self and not takes_self_as_ref:
1513 out_java_struct += "\t\t" + argument_types[0].from_hu_conv[1].replace("\n", "\n\t\t").replace("this_arg", "this") + ";\n"
1514 if return_type_info.to_hu_conv_name is not None:
1515 out_java_struct += ("\t\treturn " + return_type_info.to_hu_conv_name + ";\n")
1516 elif return_type_info.java_ty != "void" and return_type_info.rust_obj != "LDK" + struct_meth:
1517 out_java_struct += ("\t\treturn ret;\n")
1518 out_java_struct += ("\t}\n\n")
1520 return (out_java, out_c, out_java_struct + extra_java_struct_out)