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.to_hu_conv_templates = dict(
21 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}); }',
22 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}); }'
25 self.bindings_header = """package org.ldk.impl;
26 import org.ldk.enums.*;
27 import org.ldk.impl.version;
29 import java.io.InputStream;
30 import java.io.IOException;
31 import java.nio.file.Files;
32 import java.nio.file.Path;
33 import java.nio.file.StandardCopyOption;
35 public class bindings {
36 public static class VecOrSliceDef {
40 public VecOrSliceDef(long dataptr, long datalen, long stride) {
41 this.dataptr = dataptr; this.datalen = datalen; this.stride = stride;
46 // Try to load natively first, this works on Android and in testing.
47 System.loadLibrary(\"lightningjni\");
48 } catch (UnsatisfiedLinkError system_load_err) {
49 // Otherwise try to load from the library jar.
50 File tmpdir = new File(System.getProperty("java.io.tmpdir"), "ldk-java-nativelib");
51 tmpdir.mkdir(); // If it fails to create, assume it was there already
52 tmpdir.deleteOnExit();
53 String libname = "liblightningjni_" + System.getProperty("os.name").replaceAll(" ", "") +
54 "-" + System.getProperty("os.arch").replaceAll(" ", "") + ".nativelib";
55 try (InputStream is = bindings.class.getResourceAsStream("/" + libname)) {
56 Path libpath = new File(tmpdir.toPath().toString(), "liblightningjni.so").toPath();
57 Files.copy(is, libpath, StandardCopyOption.REPLACE_EXISTING);
58 Runtime.getRuntime().load(libpath.toString());
59 } catch (Exception e) {
60 System.err.println("Failed to load LDK native library.");
61 System.err.println("System LDK native library load failed with: " + system_load_err);
62 System.err.println("Resource-based LDK native library load failed with: " + e);
63 throw new IllegalArgumentException(e);
66 init(java.lang.Enum.class, VecOrSliceDef.class);
68 if (!get_lib_version_string().equals(version.get_ldk_java_bindings_version()))
69 throw new IllegalArgumentException("Compiled LDK library and LDK class failes do not match");
70 // Fetching the LDK versions from C also checks that the header and binaries match
71 get_ldk_c_bindings_version();
74 static native void init(java.lang.Class c, java.lang.Class slicedef);
75 static native void init_class_cache();
76 static native String get_lib_version_string();
78 public static native String get_ldk_c_bindings_version();
79 public static native String get_ldk_version();
81 public static native boolean deref_bool(long ptr);
82 public static native long deref_long(long ptr);
83 public static native void free_heap_ptr(long ptr);
84 public static native byte[] read_bytes(long ptr, long len);
85 public static native byte[] get_u8_slice_bytes(long slice_ptr);
86 public static native long bytes_to_u8_vec(byte[] bytes);
87 public static native long new_txpointer_copy_data(byte[] txdata);
88 public static native void txpointer_free(long ptr);
89 public static native byte[] txpointer_get_buffer(long ptr);
90 public static native long vec_slice_len(long vec);
91 public static native long new_empty_slice_vec();
94 self.bindings_version_file = """package org.ldk.impl;
96 public class version {
97 public static String get_ldk_java_bindings_version() {
98 return "<git_version_ldk_garbagecollected>";
102 self.bindings_footer = "}\n"
104 self.util_fn_pfx = """package org.ldk.structs;
105 import org.ldk.impl.bindings;
106 import org.ldk.enums.*;
107 import org.ldk.util.*;
108 import java.util.Arrays;
109 import javax.annotation.Nullable;
111 public class UtilMethods {
113 self.util_fn_sfx = "}"
114 self.common_base = """package org.ldk.structs;
115 import java.util.LinkedList;
118 LinkedList<Object> ptrs_to = new LinkedList();
119 protected CommonBase(long ptr) { assert ptr < 0 || ptr > 4096; this.ptr = ptr; }
123 self.c_file_pfx = """#include <jni.h>
124 // On OSX jlong (ie long long) is not equivalent to int64_t, so we override here
125 #define int64_t jlong
126 #include \"org_ldk_impl_bindings.h\"
127 #include <lightning.h>
129 #include <stdatomic.h>
132 #define LIKELY(v) __builtin_expect(!!(v), 1)
133 #define UNLIKELY(v) __builtin_expect(!!(v), 0)
137 if self.target == Target.ANDROID:
138 self.c_file_pfx = self.c_file_pfx + """
139 #include <android/log.h>
140 #define DEBUG_PRINT(...) __android_log_print(ANDROID_LOG_ERROR, "LDK", __VA_ARGS__)
144 static void* redirect_stderr(void* ignored) {
147 dup2(pipes[1], STDERR_FILENO);
149 memset(buf, 0, 8192);
151 while ((len = read(pipes[0], buf, 8191)) > 0) {
152 DEBUG_PRINT("%s\\n", buf);
153 memset(buf, 0, 8192);
155 DEBUG_PRINT("End of stderr???\\n");
158 void __attribute__((constructor)) spawn_stderr_redirection() {
160 pthread_create(&thread, NULL, &redirect_stderr, NULL);
164 self.c_file_pfx = self.c_file_pfx + "#define DEBUG_PRINT(...) fprintf(stderr, __VA_ARGS__)\n"
166 if not DEBUG or sys.platform == "darwin":
167 self.c_file_pfx = self.c_file_pfx + """#define MALLOC(a, _) malloc(a)
168 #define FREE(p) if ((uint64_t)(p) > 4096) { free(p); }
169 #define CHECK_ACCESS(p)
170 #define CHECK_INNER_FIELD_ACCESS_OR_NULL(v)
173 self.c_file_pfx += """#define DO_ASSERT(a) (void)(a)
177 self.c_file_pfx = self.c_file_pfx + """#include <assert.h>
178 // Always run a, then assert it is true:
179 #define DO_ASSERT(a) do { bool _assert_val = (a); assert(_assert_val); } while(0)
180 // Assert a is true or do nothing
181 #define CHECK(a) DO_ASSERT(a)
183 void __attribute__((constructor)) debug_log_version() {
184 if (check_get_ldk_version() == NULL)
185 DEBUG_PRINT("LDK version did not match the header we built against\\n");
186 if (check_get_ldk_bindings_version() == NULL)
187 DEBUG_PRINT("LDK C Bindings version did not match the header we built against\\n");
188 DEBUG_PRINT("Loaded LDK-Java Bindings with LDK %s and LDK-C-Bindings %s\\n", check_get_ldk_version(), check_get_ldk_bindings_version());
192 if sys.platform != "darwin":
193 self.c_file_pfx += """
194 // Running a leak check across all the allocations and frees of the JDK is a mess,
195 // so instead we implement our own naive leak checker here, relying on the -wrap
196 // linker option to wrap malloc/calloc/realloc/free, tracking everyhing allocated
197 // and free'd in Rust or C across the generated bindings shared library.
201 if self.target == Target.ANDROID:
202 self.c_file_pfx = self.c_file_pfx + """
206 // Implement the execinfo functions using _Unwind_backtrace. This seems to miss many Rust
207 // symbols, so we only use it on Android, where execinfo.h is unavailable.
209 struct BacktraceState {
213 static _Unwind_Reason_Code unwind_callback(struct _Unwind_Context* context, void* arg) {
214 struct BacktraceState* state = (struct BacktraceState*)arg;
215 uintptr_t pc = _Unwind_GetIP(context);
217 if (state->current == state->end) {
218 return _URC_END_OF_STACK;
220 *state->current++ = (void*)(pc);
223 return _URC_NO_REASON;
226 int backtrace(void** buffer, int max) {
227 struct BacktraceState state = { buffer, buffer + max };
228 _Unwind_Backtrace(unwind_callback, &state);
229 return state.current - buffer;
232 void backtrace_symbols_fd(void ** buffer, int count, int _fd) {
233 for (int idx = 0; idx < count; ++idx) {
235 if (dladdr(buffer[idx], &info) && info.dli_sname) {
236 DEBUG_PRINT("%p: %s", buffer[idx], info.dli_sname);
238 DEBUG_PRINT("%p: ???", buffer[idx]);
244 self.c_file_pfx = self.c_file_pfx + "#include <execinfo.h>\n"
245 self.c_file_pfx = self.c_file_pfx + """
248 static pthread_mutex_t allocation_mtx;
250 void __attribute__((constructor)) init_mtx() {
251 DO_ASSERT(!pthread_mutex_init(&allocation_mtx, NULL));
255 typedef struct allocation {
256 struct allocation* next;
258 const char* struct_name;
261 unsigned long alloc_len;
263 static allocation* allocation_ll = NULL;
265 void* __real_malloc(size_t len);
266 void* __real_calloc(size_t nmemb, size_t len);
267 static void new_allocation(void* res, const char* struct_name, size_t len) {
268 allocation* new_alloc = __real_malloc(sizeof(allocation));
269 new_alloc->ptr = res;
270 new_alloc->struct_name = struct_name;
271 new_alloc->bt_len = backtrace(new_alloc->bt, BT_MAX);
272 new_alloc->alloc_len = len;
273 DO_ASSERT(!pthread_mutex_lock(&allocation_mtx));
274 new_alloc->next = allocation_ll;
275 allocation_ll = new_alloc;
276 DO_ASSERT(!pthread_mutex_unlock(&allocation_mtx));
278 static void* MALLOC(size_t len, const char* struct_name) {
279 void* res = __real_malloc(len);
280 new_allocation(res, struct_name, len);
283 void __real_free(void* ptr);
284 static void alloc_freed(void* ptr) {
285 allocation* p = NULL;
286 DO_ASSERT(!pthread_mutex_lock(&allocation_mtx));
287 allocation* it = allocation_ll;
288 while (it->ptr != ptr) {
289 p = it; it = it->next;
291 DEBUG_PRINT("ERROR: Tried to free unknown pointer %p at:\\n", ptr);
293 int bt_len = backtrace(bt, BT_MAX);
294 backtrace_symbols_fd(bt, bt_len, STDERR_FILENO);
295 DEBUG_PRINT("\\n\\n");
296 DO_ASSERT(!pthread_mutex_unlock(&allocation_mtx));
297 return; // addrsan should catch malloc-unknown and print more info than we have
300 if (p) { p->next = it->next; } else { allocation_ll = it->next; }
301 DO_ASSERT(!pthread_mutex_unlock(&allocation_mtx));
302 DO_ASSERT(it->ptr == ptr);
305 static void FREE(void* ptr) {
306 if ((uint64_t)ptr <= 4096) return; // Rust loves to create pointers to the NULL page for dummys
311 void* __wrap_malloc(size_t len) {
312 void* res = __real_malloc(len);
313 new_allocation(res, "malloc call", len);
316 void* __wrap_calloc(size_t nmemb, size_t len) {
317 void* res = __real_calloc(nmemb, len);
318 new_allocation(res, "calloc call", len);
321 void __wrap_free(void* ptr) {
322 if (ptr == NULL) return;
327 static void CHECK_ACCESS(const void* ptr) {
328 DO_ASSERT(!pthread_mutex_lock(&allocation_mtx));
329 allocation* it = allocation_ll;
330 while (it->ptr != ptr) {
333 DEBUG_PRINT("ERROR: Tried to access unknown pointer %p at:\\n", ptr);
335 int bt_len = backtrace(bt, BT_MAX);
336 backtrace_symbols_fd(bt, bt_len, STDERR_FILENO);
337 DEBUG_PRINT("\\n\\n");
338 DO_ASSERT(!pthread_mutex_unlock(&allocation_mtx));
339 return; // addrsan should catch and print more info than we have
342 DO_ASSERT(!pthread_mutex_unlock(&allocation_mtx));
344 #define CHECK_INNER_FIELD_ACCESS_OR_NULL(v) \\
345 if (v.is_owned && v.inner != NULL) { \\
346 const void *p = __unmangle_inner_ptr(v.inner); \\
352 void* __real_realloc(void* ptr, size_t newlen);
353 void* __wrap_realloc(void* ptr, size_t len) {
354 if (ptr != NULL) alloc_freed(ptr);
355 void* res = __real_realloc(ptr, len);
356 new_allocation(res, "realloc call", len);
359 void __wrap_reallocarray(void* ptr, size_t new_sz) {
360 // Rust doesn't seem to use reallocarray currently
364 void __attribute__((destructor)) check_leaks() {
365 unsigned long alloc_count = 0;
366 unsigned long alloc_size = 0;
367 DEBUG_PRINT("The following LDK-allocated blocks still remain.\\n");
368 DEBUG_PRINT("Note that this is only accurate if System.gc(); System.runFinalization()\\n");
369 DEBUG_PRINT("was called prior to exit after all LDK objects were out of scope.\\n");
370 for (allocation* a = allocation_ll; a != NULL; a = a->next) {
371 DEBUG_PRINT("%s %p (%lu bytes) remains:\\n", a->struct_name, a->ptr, a->alloc_len);
372 backtrace_symbols_fd(a->bt, a->bt_len, STDERR_FILENO);
373 DEBUG_PRINT("\\n\\n");
375 alloc_size += a->alloc_len;
377 DEBUG_PRINT("%lu allocations remained for %lu bytes.\\n", alloc_count, alloc_size);
378 DEBUG_PRINT("Note that this is only accurate if System.gc(); System.runFinalization()\\n");
379 DEBUG_PRINT("was called prior to exit after all LDK objects were out of scope.\\n");
382 self.c_file_pfx = self.c_file_pfx + """
383 static jmethodID ordinal_meth = NULL;
384 static jmethodID slicedef_meth = NULL;
385 static jclass slicedef_cls = NULL;
386 JNIEXPORT void Java_org_ldk_impl_bindings_init(JNIEnv * env, jclass _b, jclass enum_class, jclass slicedef_class) {
387 ordinal_meth = (*env)->GetMethodID(env, enum_class, "ordinal", "()I");
388 CHECK(ordinal_meth != NULL);
389 slicedef_meth = (*env)->GetMethodID(env, slicedef_class, "<init>", "(JJJ)V");
390 CHECK(slicedef_meth != NULL);
391 slicedef_cls = (*env)->NewGlobalRef(env, slicedef_class);
392 CHECK(slicedef_cls != NULL);
395 JNIEXPORT jboolean JNICALL Java_org_ldk_impl_bindings_deref_1bool (JNIEnv * env, jclass _a, jlong ptr) {
396 return *((bool*)ptr);
398 JNIEXPORT jlong JNICALL Java_org_ldk_impl_bindings_deref_1long (JNIEnv * env, jclass _a, jlong ptr) {
399 return *((long*)ptr);
401 JNIEXPORT void JNICALL Java_org_ldk_impl_bindings_free_1heap_1ptr (JNIEnv * env, jclass _a, jlong ptr) {
404 JNIEXPORT jbyteArray JNICALL Java_org_ldk_impl_bindings_read_1bytes (JNIEnv * env, jclass _b, jlong ptr, jlong len) {
405 jbyteArray ret_arr = (*env)->NewByteArray(env, len);
406 (*env)->SetByteArrayRegion(env, ret_arr, 0, len, (unsigned char*)ptr);
409 JNIEXPORT jbyteArray JNICALL Java_org_ldk_impl_bindings_get_1u8_1slice_1bytes (JNIEnv * env, jclass _b, jlong slice_ptr) {
410 LDKu8slice *slice = (LDKu8slice*)slice_ptr;
411 jbyteArray ret_arr = (*env)->NewByteArray(env, slice->datalen);
412 (*env)->SetByteArrayRegion(env, ret_arr, 0, slice->datalen, slice->data);
415 JNIEXPORT int64_t impl_bindings_bytes_1to_1u8_1vec (JNIEnv * env, jclass _b, jbyteArray bytes) {
416 LDKCVec_u8Z *vec = (LDKCVec_u8Z*)MALLOC(sizeof(LDKCVec_u8Z), "LDKCVec_u8");
417 vec->datalen = (*env)->GetArrayLength(env, bytes);
418 vec->data = (uint8_t*)MALLOC(vec->datalen, "LDKCVec_u8Z Bytes");
419 (*env)->GetByteArrayRegion (env, bytes, 0, vec->datalen, vec->data);
420 return (uint64_t)vec;
422 JNIEXPORT jbyteArray JNICALL Java_org_ldk_impl_bindings_txpointer_1get_1buffer (JNIEnv * env, jclass _b, jlong ptr) {
423 LDKTransaction *txdata = (LDKTransaction*)ptr;
425 slice.data = txdata->data;
426 slice.datalen = txdata->datalen;
427 return Java_org_ldk_impl_bindings_get_1u8_1slice_1bytes(env, _b, (uint64_t)&slice);
429 JNIEXPORT int64_t JNICALL Java_org_ldk_impl_bindings_new_1txpointer_1copy_1data (JNIEnv * env, jclass _b, jbyteArray bytes) {
430 LDKTransaction *txdata = (LDKTransaction*)MALLOC(sizeof(LDKTransaction), "LDKTransaction");
431 txdata->datalen = (*env)->GetArrayLength(env, bytes);
432 txdata->data = (uint8_t*)MALLOC(txdata->datalen, "Tx Data Bytes");
433 txdata->data_is_owned = false;
434 (*env)->GetByteArrayRegion (env, bytes, 0, txdata->datalen, txdata->data);
435 return (uint64_t)txdata;
437 JNIEXPORT void JNICALL Java_org_ldk_impl_bindings_txpointer_1free (JNIEnv * env, jclass _b, jlong ptr) {
438 LDKTransaction *tx = (LDKTransaction*)ptr;
439 tx->data_is_owned = true;
440 Transaction_free(*tx);
443 JNIEXPORT jlong JNICALL Java_org_ldk_impl_bindings_vec_1slice_1len (JNIEnv * env, jclass _a, jlong ptr) {
444 // Check offsets of a few Vec types are all consistent as we're meant to be generic across types
445 _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKCVec_SignatureZ, datalen), "Vec<*> needs to be mapped identically");
446 _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKCVec_MessageSendEventZ, datalen), "Vec<*> needs to be mapped identically");
447 _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKCVec_EventZ, datalen), "Vec<*> needs to be mapped identically");
448 _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKCVec_C2Tuple_usizeTransactionZZ, datalen), "Vec<*> needs to be mapped identically");
449 LDKCVec_u8Z *vec = (LDKCVec_u8Z*)ptr;
450 return (uint64_t)vec->datalen;
452 JNIEXPORT int64_t JNICALL Java_org_ldk_impl_bindings_new_1empty_1slice_1vec (JNIEnv * env, jclass _b) {
453 // Check sizes of a few Vec types are all consistent as we're meant to be generic across types
454 _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKCVec_SignatureZ), "Vec<*> needs to be mapped identically");
455 _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKCVec_MessageSendEventZ), "Vec<*> needs to be mapped identically");
456 _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKCVec_EventZ), "Vec<*> needs to be mapped identically");
457 _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKCVec_C2Tuple_usizeTransactionZZ), "Vec<*> needs to be mapped identically");
458 LDKCVec_u8Z *vec = (LDKCVec_u8Z*)MALLOC(sizeof(LDKCVec_u8Z), "Empty LDKCVec");
461 return (uint64_t)vec;
464 // We assume that CVec_u8Z and u8slice are the same size and layout (and thus pointers to the two can be mixed)
465 _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKu8slice), "Vec<u8> and [u8] need to have been mapped identically");
466 _Static_assert(offsetof(LDKCVec_u8Z, data) == offsetof(LDKu8slice, data), "Vec<u8> and [u8] need to have been mapped identically");
467 _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKu8slice, datalen), "Vec<u8> and [u8] need to have been mapped identically");
469 _Static_assert(sizeof(jlong) == sizeof(int64_t), "We assume that j-types are the same as C types");
470 _Static_assert(sizeof(jbyte) == sizeof(char), "We assume that j-types are the same as C types");
471 _Static_assert(sizeof(void*) <= 8, "Pointers must fit into 64 bits");
473 typedef jlongArray int64_tArray;
474 typedef jbyteArray int8_tArray;
476 static inline jstring str_ref_to_java(JNIEnv *env, const char* chars, size_t len) {
477 // Sadly we need to create a temporary because Java can't accept a char* without a 0-terminator
478 char* conv_buf = MALLOC(len + 1, "str conv buf");
479 memcpy(conv_buf, chars, len);
481 jstring ret = (*env)->NewStringUTF(env, conv_buf);
485 static inline LDKStr java_to_owned_str(JNIEnv *env, jstring str) {
486 uint64_t str_len = (*env)->GetStringUTFLength(env, str);
487 char* newchars = MALLOC(str_len + 1, "String chars");
488 const char* jchars = (*env)->GetStringUTFChars(env, str, NULL);
489 memcpy(newchars, jchars, str_len);
490 newchars[str_len] = 0;
491 (*env)->ReleaseStringUTFChars(env, str, jchars);
495 .chars_is_owned = true
500 JNIEXPORT jstring JNICALL Java_org_ldk_impl_bindings_get_1ldk_1c_1bindings_1version(JNIEnv *env, jclass _c) {
501 return str_ref_to_java(env, check_get_ldk_bindings_version(), strlen(check_get_ldk_bindings_version()));
503 JNIEXPORT jstring JNICALL Java_org_ldk_impl_bindings_get_1ldk_1version(JNIEnv *env, jclass _c) {
504 return str_ref_to_java(env, check_get_ldk_version(), strlen(check_get_ldk_version()));
508 self.c_version_file = """JNIEXPORT jstring JNICALL Java_org_ldk_impl_bindings_get_1lib_1version_1string(JNIEnv *env, jclass _c) {
509 return str_ref_to_java(env, "<git_version_ldk_garbagecollected>", strlen("<git_version_ldk_garbagecollected>"));
512 self.hu_struct_file_prefix = """package org.ldk.structs;
514 import org.ldk.impl.bindings;
515 import org.ldk.enums.*;
516 import org.ldk.util.*;
517 import java.util.Arrays;
518 import javax.annotation.Nullable;
521 self.c_fn_ty_pfx = "JNIEXPORT "
522 self.c_fn_args_pfx = "JNIEnv *env, jclass clz"
523 self.file_ext = ".java"
524 self.ptr_c_ty = "int64_t"
525 self.ptr_native_ty = "long"
526 self.result_c_ty = "jclass"
527 self.ptr_arr = "jobjectArray"
528 self.is_arr_some_check = ("", " != NULL")
529 self.get_native_arr_len_call = ("(*env)->GetArrayLength(env, ", ")")
531 def construct_jenv(self):
532 res = "JNIEnv *env;\n"
533 res += "jint get_jenv_res = (*j_calls->vm)->GetEnv(j_calls->vm, (void**)&env, JNI_VERSION_1_6);\n"
534 res += "if (get_jenv_res == JNI_EDETACHED) {\n"
535 if self.target == Target.ANDROID:
536 res += "\tDO_ASSERT((*j_calls->vm)->AttachCurrentThread(j_calls->vm, &env, NULL) == JNI_OK);\n"
538 res += "\tDO_ASSERT((*j_calls->vm)->AttachCurrentThread(j_calls->vm, (void**)&env, NULL) == JNI_OK);\n"
540 res += "\tDO_ASSERT(get_jenv_res == JNI_OK);\n"
543 def deconstruct_jenv(self):
544 res = "if (get_jenv_res == JNI_EDETACHED) {\n"
545 res += "\tDO_ASSERT((*j_calls->vm)->DetachCurrentThread(j_calls->vm) == JNI_OK);\n"
549 def release_native_arr_ptr_call(self, ty_info, arr_var, arr_ptr_var):
550 if ty_info.subty is None or not ty_info.subty.c_ty.endswith("Array"):
551 return "(*env)->ReleasePrimitiveArrayCritical(env, " + arr_var + ", " + arr_ptr_var + ", 0)"
553 def create_native_arr_call(self, arr_len, ty_info):
554 if ty_info.c_ty == "int8_tArray":
555 return "(*env)->NewByteArray(env, " + arr_len + ")"
556 elif ty_info.subty.c_ty.endswith("Array"):
557 clz_var = ty_info.java_fn_ty_arg[1:].replace("[", "arr_of_")
558 self.c_array_class_caches.add(clz_var)
559 return "(*env)->NewObjectArray(env, " + arr_len + ", " + clz_var + "_clz, NULL);\n"
561 return "(*env)->New" + ty_info.java_ty.strip("[]").title() + "Array(env, " + arr_len + ")"
562 def set_native_arr_contents(self, arr_name, arr_len, ty_info):
563 if ty_info.c_ty == "int8_tArray":
564 return ("(*env)->SetByteArrayRegion(env, " + arr_name + ", 0, " + arr_len + ", ", ")")
567 def get_native_arr_contents(self, arr_name, dest_name, arr_len, ty_info, copy):
568 if ty_info.c_ty == "int8_tArray":
570 return "(*env)->GetByteArrayRegion(env, " + arr_name + ", 0, " + arr_len + ", " + dest_name + ")"
572 return "(*env)->GetByteArrayElements (env, " + arr_name + ", NULL)"
573 elif not ty_info.java_ty[:len(ty_info.java_ty) - 2].endswith("[]"):
574 return "(*env)->Get" + ty_info.subty.java_ty.title() + "ArrayElements (env, " + arr_name + ", NULL)"
577 def get_native_arr_elem(self, arr_name, idxc, ty_info):
578 if self.get_native_arr_contents(arr_name, "", "", ty_info, False) is None:
579 return "(*env)->GetObjectArrayElement(env, " + arr_name + ", " + idxc + ")"
581 assert False # Only called if above is None
582 def get_native_arr_ptr_call(self, ty_info):
583 if ty_info.subty is not None and ty_info.subty.c_ty.endswith("Array"):
585 return ("(*env)->GetPrimitiveArrayCritical(env, ", ", NULL)")
586 def get_native_arr_entry_call(self, ty_info, arr_name, idxc, entry_access):
587 if ty_info.subty is None or not ty_info.subty.c_ty.endswith("Array"):
589 return "(*env)->SetObjectArrayElement(env, " + arr_name + ", " + idxc + ", " + entry_access + ")"
590 def cleanup_native_arr_ref_contents(self, arr_name, dest_name, arr_len, ty_info):
591 if ty_info.c_ty == "int8_tArray":
592 return "(*env)->ReleaseByteArrayElements(env, " + arr_name + ", (int8_t*)" + dest_name + ", 0);"
594 return "(*env)->Release" + ty_info.java_ty.strip("[]").title() + "ArrayElements(env, " + arr_name + ", " + dest_name + ", 0)"
596 def str_ref_to_native_call(self, var_name, str_len):
597 return "str_ref_to_java(env, " + var_name + ", " + str_len + ")"
598 def str_ref_to_c_call(self, var_name):
599 return "java_to_owned_str(env, " + var_name + ")"
601 def c_fn_name_define_pfx(self, fn_name, has_args):
603 return "JNICALL Java_org_ldk_impl_bindings_" + fn_name.replace("_", "_1") + "(JNIEnv *env, jclass clz, "
604 return "JNICALL Java_org_ldk_impl_bindings_" + fn_name.replace("_", "_1") + "(JNIEnv *env, jclass clz"
608 for ty in sorted(self.c_array_class_caches):
609 res = res + "static jclass " + ty + "_clz = NULL;\n"
610 res = res + "JNIEXPORT void Java_org_ldk_impl_bindings_init_1class_1cache(JNIEnv * env, jclass clz) {\n"
611 for ty in sorted(self.c_array_class_caches):
612 res = res + "\t" + ty + "_clz = (*env)->FindClass(env, \"" + ty.replace("arr_of_", "[") + "\");\n"
613 res = res + "\tCHECK(" + ty + "_clz != NULL);\n"
614 res = res + "\t" + ty + "_clz = (*env)->NewGlobalRef(env, " + ty + "_clz);\n"
618 def native_c_unitary_enum_map(self, struct_name, variants, enum_doc_comment):
619 out_java_enum = "package org.ldk.enums;\n\n"
622 out_c += "static inline LDK" + struct_name + " LDK" + struct_name + "_from_java(" + self.c_fn_args_pfx + ") {\n"
623 out_c += "\tjint ord = (*env)->CallIntMethod(env, clz, ordinal_meth);\n"
624 out_c += "\tif (UNLIKELY((*env)->ExceptionCheck(env))) {\n"
625 out_c += "\t\t(*env)->ExceptionDescribe(env);\n"
626 out_c += "\t\t(*env)->FatalError(env, \"A call to " + struct_name + ".ordinal() from rust threw an exception.\");\n"
628 out_c += "\tswitch (ord) {\n"
630 if enum_doc_comment is not None:
631 out_java_enum += "/**\n * " + enum_doc_comment.replace("\n", "\n * ") + "\n */\n"
632 out_java_enum += "public enum " + struct_name + " {\n"
634 for var, var_docs in variants:
635 if var_docs is not None:
636 out_java_enum += "\t/**\n\t * " + var_docs.replace("\n", "\n\t * ") + "\n\t */\n"
637 out_java_enum += "\t" + var + ",\n"
638 out_c = out_c + "\t\tcase %d: return %s;\n" % (ord_v, var)
640 out_java_enum = out_java_enum + "\t; static native void init();\n"
641 out_java_enum = out_java_enum + "\tstatic { init(); }\n"
642 out_java_enum = out_java_enum + "}"
643 out_java = out_java + "\tstatic { " + struct_name + ".values(); /* Force enum statics to run */ }\n"
645 out_c += "\t(*env)->FatalError(env, \"A call to " + struct_name + ".ordinal() from rust returned an invalid value.\");\n"
646 out_c += "\tabort(); // Unreachable, but will let the compiler know we don't return here\n"
649 out_c = out_c + "static jclass " + struct_name + "_class = NULL;\n"
650 for var, _ in variants:
651 out_c = out_c + "static jfieldID " + struct_name + "_" + var + " = NULL;\n"
652 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"
653 out_c = out_c + "\t" + struct_name + "_class = (*env)->NewGlobalRef(env, clz);\n"
654 out_c = out_c + "\tCHECK(" + struct_name + "_class != NULL);\n"
655 for var, _ in variants:
656 out_c = out_c + "\t" + struct_name + "_" + var + " = (*env)->GetStaticFieldID(env, " + struct_name + "_class, \"" + var + "\", \"Lorg/ldk/enums/" + struct_name + ";\");\n"
657 out_c = out_c + "\tCHECK(" + struct_name + "_" + var + " != NULL);\n"
658 out_c = out_c + "}\n"
659 out_c = out_c + "static inline jclass LDK" + struct_name + "_to_java(JNIEnv *env, LDK" + struct_name + " val) {\n"
660 out_c = out_c + "\tswitch (val) {\n"
662 for var, _ in variants:
663 out_c = out_c + "\t\tcase " + var + ":\n"
664 out_c = out_c + "\t\t\treturn (*env)->GetStaticObjectField(env, " + struct_name + "_class, " + struct_name + "_" + var + ");\n"
666 out_c = out_c + "\t\tdefault: abort();\n"
667 out_c = out_c + "\t}\n"
668 out_c = out_c + "}\n\n"
670 return (out_c, out_java_enum, out_java)
672 def c_unitary_enum_to_native_call(self, ty_info):
673 return (ty_info.rust_obj + "_to_java(env, ", ")")
674 def native_unitary_enum_to_c_call(self, ty_info):
675 return (ty_info.rust_obj + "_from_java(env, ", ")")
677 def c_complex_enum_pfx(self, struct_name, variants, init_meth_jty_strs):
680 out_c = out_c + "static jclass " + struct_name + "_" + var + "_class = NULL;\n"
681 out_c = out_c + "static jmethodID " + struct_name + "_" + var + "_meth = NULL;\n"
682 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"
683 for var_name in variants:
684 out_c += "\t" + struct_name + "_" + var_name + "_class =\n"
685 out_c += "\t\t(*env)->NewGlobalRef(env, (*env)->FindClass(env, \"org/ldk/impl/bindings$" + struct_name + "$" + var_name + "\"));\n"
686 out_c += "\tCHECK(" + struct_name + "_" + var_name + "_class != NULL);\n"
687 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"
688 out_c += "\tCHECK(" + struct_name + "_" + var_name + "_meth != NULL);\n"
689 out_c = out_c + "}\n"
692 def c_complex_enum_pass_ty(self, struct_name):
695 def c_constr_native_complex_enum(self, struct_name, variant, c_params):
696 ret = "(*env)->NewObject(env, " + struct_name + "_" + variant + "_class, " + struct_name + "_" + variant + "_meth"
697 for param in c_params:
698 ret = ret + ", " + param
701 def native_c_map_trait(self, struct_name, field_vars, flattened_field_vars, field_fns, trait_doc_comment):
705 # First generate most of the Java code, note that we need information about java method argument strings for C
706 out_java_trait = out_java_trait + self.hu_struct_file_prefix
707 if trait_doc_comment is not None:
708 out_java_trait += "/**\n * " + trait_doc_comment.replace("\n", "\n * ") + "\n */\n"
709 out_java_trait += "@SuppressWarnings(\"unchecked\") // We correctly assign various generic arrays\n"
710 out_java_trait = out_java_trait + "public class " + struct_name.replace("LDK","") + " extends CommonBase {\n"
711 out_java_trait = out_java_trait + "\tfinal bindings." + struct_name + " bindings_instance;\n"
712 out_java_trait = out_java_trait + "\t" + struct_name.replace("LDK", "") + "(Object _dummy, long ptr) { super(ptr); bindings_instance = null; }\n"
713 out_java_trait = out_java_trait + "\tprivate " + struct_name.replace("LDK", "") + "(bindings." + struct_name + " arg"
714 for var in flattened_field_vars:
715 if isinstance(var, ConvInfo):
716 out_java_trait = out_java_trait + ", " + var.java_hu_ty + " " + var.arg_name
718 out_java_trait = out_java_trait + ", bindings." + var[0] + " " + var[1]
719 out_java_trait = out_java_trait + ") {\n"
720 out_java_trait = out_java_trait + "\t\tsuper(bindings." + struct_name + "_new(arg"
721 for var in flattened_field_vars:
722 if isinstance(var, ConvInfo):
723 if var.from_hu_conv is not None:
724 out_java_trait = out_java_trait + ", " + var.from_hu_conv[0]
726 out_java_trait = out_java_trait + ", " + var.arg_name
728 out_java_trait = out_java_trait + ", " + var[1]
729 out_java_trait = out_java_trait + "));\n"
730 out_java_trait = out_java_trait + "\t\tthis.ptrs_to.add(arg);\n"
731 for var in flattened_field_vars:
732 if isinstance(var, ConvInfo):
733 if var.from_hu_conv is not None and var.from_hu_conv[1] != "":
734 out_java_trait = out_java_trait + "\t\t" + var.from_hu_conv[1].replace("\n", "\n\t\t") + ";\n"
736 out_java_trait = out_java_trait + "\t\tthis.ptrs_to.add(" + var[1] + ");\n"
737 out_java_trait = out_java_trait + "\t\tthis.bindings_instance = arg;\n"
738 out_java_trait = out_java_trait + "\t}\n"
739 out_java_trait = out_java_trait + "\t@Override @SuppressWarnings(\"deprecation\")\n"
740 out_java_trait = out_java_trait + "\tprotected void finalize() throws Throwable {\n"
741 out_java_trait = out_java_trait + "\t\tif (ptr != 0) { bindings." + struct_name.replace("LDK","") + "_free(ptr); } super.finalize();\n"
742 out_java_trait = out_java_trait + "\t}\n\n"
744 java_trait_constr = "\tprivate static class " + struct_name + "Holder { " + struct_name.replace("LDK", "") + " held; }\n"
745 java_trait_constr = java_trait_constr + "\tpublic static " + struct_name.replace("LDK", "") + " new_impl(" + struct_name.replace("LDK", "") + "Interface arg"
746 for var in flattened_field_vars:
747 if isinstance(var, ConvInfo):
748 java_trait_constr = java_trait_constr + ", " + var.java_hu_ty + " " + var.arg_name
750 # Ideally we'd be able to take any instance of the interface, but our C code can only represent
751 # Java-implemented version, so we require users pass a Java implementation here :/
752 java_trait_constr = java_trait_constr + ", " + var[0].replace("LDK", "") + "." + var[0].replace("LDK", "") + "Interface " + var[1] + "_impl"
753 java_trait_constr = java_trait_constr + ") {\n\t\tfinal " + struct_name + "Holder impl_holder = new " + struct_name + "Holder();\n"
754 java_trait_constr = java_trait_constr + "\t\timpl_holder.held = new " + struct_name.replace("LDK", "") + "(new bindings." + struct_name + "() {\n"
755 out_java_trait = out_java_trait + "\tpublic static interface " + struct_name.replace("LDK", "") + "Interface {\n"
756 out_java = out_java + "\tpublic interface " + struct_name + " {\n"
758 for fn_line in field_fns:
759 java_meth_descr = "("
760 if fn_line.fn_name != "free" and fn_line.fn_name != "cloned":
761 out_java = out_java + "\t\t " + fn_line.ret_ty_info.java_ty + " " + fn_line.fn_name + "("
762 java_trait_constr = java_trait_constr + "\t\t\t@Override public " + fn_line.ret_ty_info.java_ty + " " + fn_line.fn_name + "("
763 out_java_trait += "\t\t/**\n\t\t * " + fn_line.docs.replace("\n", "\n\t\t * ") + "\n\t\t */\n"
764 out_java_trait = out_java_trait + "\t\t" + fn_line.ret_ty_info.java_hu_ty + " " + fn_line.fn_name + "("
766 for idx, arg_conv_info in enumerate(fn_line.args_ty):
768 out_java = out_java + ", "
769 java_trait_constr = java_trait_constr + ", "
770 out_java_trait = out_java_trait + ", "
771 out_java = out_java + arg_conv_info.java_ty + " " + arg_conv_info.arg_name
772 out_java_trait = out_java_trait + arg_conv_info.java_hu_ty + " " + arg_conv_info.arg_name
773 java_trait_constr = java_trait_constr + arg_conv_info.java_ty + " " + arg_conv_info.arg_name
774 java_meth_descr = java_meth_descr + arg_conv_info.java_fn_ty_arg
775 java_meth_descr = java_meth_descr + ")" + fn_line.ret_ty_info.java_fn_ty_arg
776 java_meths.append((fn_line.fn_name, java_meth_descr))
778 out_java = out_java + ");\n"
779 out_java_trait = out_java_trait + ");\n"
780 java_trait_constr = java_trait_constr + ") {\n"
782 for arg_info in fn_line.args_ty:
783 if arg_info.to_hu_conv is not None:
784 java_trait_constr = java_trait_constr + "\t\t\t\t" + arg_info.to_hu_conv.replace("\n", "\n\t\t\t\t") + "\n"
786 if fn_line.ret_ty_info.java_ty != "void":
787 java_trait_constr = java_trait_constr + "\t\t\t\t" + fn_line.ret_ty_info.java_hu_ty + " ret = arg." + fn_line.fn_name + "("
789 java_trait_constr = java_trait_constr + "\t\t\t\targ." + fn_line.fn_name + "("
791 for idx, arg_info in enumerate(fn_line.args_ty):
793 java_trait_constr = java_trait_constr + ", "
794 if arg_info.to_hu_conv_name is not None:
795 java_trait_constr = java_trait_constr + arg_info.to_hu_conv_name
797 java_trait_constr = java_trait_constr + arg_info.arg_name
799 java_trait_constr = java_trait_constr + ");\n"
800 if fn_line.ret_ty_info.java_ty != "void":
801 if fn_line.ret_ty_info.from_hu_conv is not None:
802 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"
803 if fn_line.ret_ty_info.from_hu_conv[1] != "":
804 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"
805 #if fn_line.ret_ty_info.rust_obj in result_types:
806 java_trait_constr = java_trait_constr + "\t\t\t\treturn result;\n"
808 java_trait_constr = java_trait_constr + "\t\t\t\treturn ret;\n"
809 java_trait_constr = java_trait_constr + "\t\t\t}\n"
810 java_trait_constr = java_trait_constr + "\t\t}"
811 for var in field_vars:
812 if isinstance(var, ConvInfo):
813 java_trait_constr = java_trait_constr + ", " + var.arg_name
815 java_trait_constr += ", " + var[1] + ".new_impl(" + var[1] + "_impl"
816 for suparg in var[2]:
817 if isinstance(suparg, ConvInfo):
818 java_trait_constr += ", " + suparg.arg_name
820 java_trait_constr += ", " + suparg[1]
821 java_trait_constr += ").bindings_instance"
822 for suparg in var[2]:
823 if isinstance(suparg, ConvInfo):
824 java_trait_constr += ", " + suparg.arg_name
826 java_trait_constr += ", " + suparg[1]
827 out_java_trait = out_java_trait + "\t}\n"
828 out_java_trait = out_java_trait + java_trait_constr + ");\n\t\treturn impl_holder.held;\n\t}\n"
830 out_java = out_java + "\t}\n"
832 out_java = out_java + "\tpublic static native long " + struct_name + "_new(" + struct_name + " impl"
833 for var in flattened_field_vars:
834 if isinstance(var, ConvInfo):
835 out_java = out_java + ", " + var.java_ty + " " + var.arg_name
837 out_java = out_java + ", " + var[0] + " " + var[1]
838 out_java = out_java + ");\n"
840 # Now that we've written out our java code (and created java_meths), generate C
841 out_c = "typedef struct " + struct_name + "_JCalls {\n"
842 out_c = out_c + "\tatomic_size_t refcnt;\n"
843 out_c = out_c + "\tJavaVM *vm;\n"
844 out_c = out_c + "\tjweak o;\n"
845 for var in flattened_field_vars:
846 if isinstance(var, ConvInfo):
847 # We're a regular ol' field
851 out_c = out_c + "\t" + var[0] + "_JCalls* " + var[1] + ";\n"
853 if fn.fn_name != "free" and fn.fn_name != "cloned":
854 out_c = out_c + "\tjmethodID " + fn.fn_name + "_meth;\n"
855 out_c = out_c + "} " + struct_name + "_JCalls;\n"
857 for fn_line in field_fns:
858 if fn_line.fn_name == "free":
859 out_c = out_c + "static void " + struct_name + "_JCalls_free(void* this_arg) {\n"
860 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) this_arg;\n"
861 out_c = out_c + "\tif (atomic_fetch_sub_explicit(&j_calls->refcnt, 1, memory_order_acquire) == 1) {\n"
862 out_c += "\t\t" + self.construct_jenv().replace("\n", "\n\t\t").strip() + "\n"
863 out_c = out_c + "\t\t(*env)->DeleteWeakGlobalRef(env, j_calls->o);\n"
864 out_c += "\t\t" + self.deconstruct_jenv().replace("\n", "\n\t\t").strip() + "\n"
865 out_c = out_c + "\t\tFREE(j_calls);\n"
866 out_c = out_c + "\t}\n}\n"
868 for idx, fn_line in enumerate(field_fns):
869 if fn_line.fn_name != "free" and fn_line.fn_name != "cloned":
870 assert fn_line.ret_ty_info.ty_info.get_full_rust_ty()[1] == ""
871 out_c = out_c + fn_line.ret_ty_info.ty_info.get_full_rust_ty()[0] + " " + fn_line.fn_name + "_" + struct_name + "_jcall("
872 if fn_line.self_is_const:
873 out_c = out_c + "const void* this_arg"
875 out_c = out_c + "void* this_arg"
877 for idx, arg in enumerate(fn_line.args_ty):
878 out_c = out_c + ", " + arg.ty_info.get_full_rust_ty()[0] + " " + arg.arg_name + arg.ty_info.get_full_rust_ty()[1]
880 out_c = out_c + ") {\n"
881 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) this_arg;\n"
882 out_c += "\t" + self.construct_jenv().replace("\n", "\n\t").strip() + "\n"
884 for arg_info in fn_line.args_ty:
885 if arg_info.ret_conv is not None:
886 out_c = out_c + "\t" + arg_info.ret_conv[0].replace('\n', '\n\t')
887 out_c = out_c + arg_info.arg_name
888 out_c = out_c + arg_info.ret_conv[1].replace('\n', '\n\t') + "\n"
890 out_c = out_c + "\tjobject obj = (*env)->NewLocalRef(env, j_calls->o);\n\tCHECK(obj != NULL);\n"
891 if fn_line.ret_ty_info.c_ty.endswith("Array"):
892 out_c = out_c + "\t" + fn_line.ret_ty_info.c_ty + " ret = (*env)->CallObjectMethod(env, obj, j_calls->" + fn_line.fn_name + "_meth"
893 elif fn_line.ret_ty_info.c_ty == "void":
894 out_c += "\t(*env)->Call" + fn_line.ret_ty_info.java_ty.title() + "Method(env, obj, j_calls->" + fn_line.fn_name + "_meth"
895 elif fn_line.ret_ty_info.java_ty == "String":
896 # Manually write out String methods as they're just an Object
897 out_c += "\t" + fn_line.ret_ty_info.c_ty + " ret = (*env)->CallObjectMethod(env, obj, j_calls->" + fn_line.fn_name + "_meth"
898 elif not fn_line.ret_ty_info.passed_as_ptr:
899 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"
901 out_c = out_c + "\tuint64_t ret = (*env)->CallLongMethod(env, obj, j_calls->" + fn_line.fn_name + "_meth"
903 for idx, arg_info in enumerate(fn_line.args_ty):
904 if arg_info.ret_conv is not None:
905 out_c = out_c + ", " + arg_info.ret_conv_name
907 out_c = out_c + ", " + arg_info.arg_name
908 out_c = out_c + ");\n"
910 out_c += "\tif (UNLIKELY((*env)->ExceptionCheck(env))) {\n"
911 out_c += "\t\t(*env)->ExceptionDescribe(env);\n"
912 out_c += "\t\t(*env)->FatalError(env, \"A call to " + fn_line.fn_name + " in " + struct_name + " from rust threw an exception.\");\n"
915 if fn_line.ret_ty_info.arg_conv is not None:
916 out_c += "\t" + fn_line.ret_ty_info.arg_conv.replace("\n", "\n\t") + "\n"
917 out_c += "\t" + self.deconstruct_jenv().replace("\n", "\n\t").strip() + "\n"
918 out_c += "\treturn " + fn_line.ret_ty_info.arg_conv_name + ";\n"
920 out_c += "\t" + self.deconstruct_jenv().replace("\n", "\n\t").strip() + "\n"
921 if not fn_line.ret_ty_info.passed_as_ptr and fn_line.ret_ty_info.c_ty != "void":
922 out_c += "\treturn ret;\n"
924 out_c = out_c + "}\n"
926 # If we can, write out a clone function whether we need one or not, as we use them in moving to rust
927 can_clone_with_ptr = True
928 for var in field_vars:
929 if isinstance(var, ConvInfo):
930 can_clone_with_ptr = False
931 if can_clone_with_ptr:
932 out_c = out_c + "static void " + struct_name + "_JCalls_cloned(" + struct_name + "* new_obj) {\n"
933 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) new_obj->this_arg;\n"
934 out_c = out_c + "\tatomic_fetch_add_explicit(&j_calls->refcnt, 1, memory_order_release);\n"
935 for var in field_vars:
936 if not isinstance(var, ConvInfo):
937 out_c = out_c + "\tatomic_fetch_add_explicit(&j_calls->" + var[1] + "->refcnt, 1, memory_order_release);\n"
938 out_c = out_c + "}\n"
940 out_c = out_c + "static inline " + struct_name + " " + struct_name + "_init (" + self.c_fn_args_pfx + ", jobject o"
941 for var in flattened_field_vars:
942 if isinstance(var, ConvInfo):
943 out_c = out_c + ", " + var.c_ty + " " + var.arg_name
945 out_c = out_c + ", jobject " + var[1]
946 out_c = out_c + ") {\n"
948 out_c = out_c + "\tjclass c = (*env)->GetObjectClass(env, o);\n"
949 out_c = out_c + "\tCHECK(c != NULL);\n"
950 out_c = out_c + "\t" + struct_name + "_JCalls *calls = MALLOC(sizeof(" + struct_name + "_JCalls), \"" + struct_name + "_JCalls\");\n"
951 out_c = out_c + "\tatomic_init(&calls->refcnt, 1);\n"
952 out_c = out_c + "\tDO_ASSERT((*env)->GetJavaVM(env, &calls->vm) == 0);\n"
953 out_c = out_c + "\tcalls->o = (*env)->NewWeakGlobalRef(env, o);\n"
955 for (fn_name, java_meth_descr) in java_meths:
956 if fn_name != "free" and fn_name != "cloned":
957 out_c = out_c + "\tcalls->" + fn_name + "_meth = (*env)->GetMethodID(env, c, \"" + fn_name + "\", \"" + java_meth_descr + "\");\n"
958 out_c = out_c + "\tCHECK(calls->" + fn_name + "_meth != NULL);\n"
960 for var in flattened_field_vars:
961 if isinstance(var, ConvInfo) and var.arg_conv is not None:
962 out_c = out_c + "\n\t" + var.arg_conv.replace("\n", "\n\t") +"\n"
963 out_c = out_c + "\n\t" + struct_name + " ret = {\n"
964 out_c = out_c + "\t\t.this_arg = (void*) calls,\n"
965 for fn_line in field_fns:
966 if fn_line.fn_name != "free" and fn_line.fn_name != "cloned":
967 out_c = out_c + "\t\t." + fn_line.fn_name + " = " + fn_line.fn_name + "_" + struct_name + "_jcall,\n"
968 elif fn_line.fn_name == "free":
969 out_c = out_c + "\t\t.free = " + struct_name + "_JCalls_free,\n"
971 out_c = out_c + "\t\t.cloned = " + struct_name + "_JCalls_cloned,\n"
972 for var in field_vars:
973 if isinstance(var, ConvInfo):
974 if var.arg_conv_name is not None:
975 out_c = out_c + "\t\t." + var.arg_name + " = " + var.arg_conv_name + ",\n"
976 out_c = out_c + "\t\t.set_" + var.arg_name + " = NULL,\n"
978 out_c = out_c + "\t\t." + var.var_name + " = " + var.var_name + ",\n"
979 out_c = out_c + "\t\t.set_" + var.var_name + " = NULL,\n"
981 out_c += "\t\t." + var[1] + " = " + var[0] + "_init(env, clz, " + var[1]
982 for suparg in var[2]:
983 if isinstance(suparg, ConvInfo):
984 out_c = out_c + ", " + suparg.arg_name
986 out_c = out_c + ", " + suparg[1]
988 out_c = out_c + "\t};\n"
989 for var in flattened_field_vars:
990 if not isinstance(var, ConvInfo):
991 out_c = out_c + "\tcalls->" + var[1] + " = ret." + var[1] + ".this_arg;\n"
992 out_c = out_c + "\treturn ret;\n"
993 out_c = out_c + "}\n"
995 out_c = out_c + self.c_fn_ty_pfx + "int64_t " + self.c_fn_name_define_pfx(struct_name + "_new", True) + "jobject o"
996 for var in flattened_field_vars:
997 if isinstance(var, ConvInfo):
998 out_c = out_c + ", " + var.c_ty + " " + var.arg_name
1000 out_c = out_c + ", jobject " + var[1]
1001 out_c = out_c + ") {\n"
1002 out_c = out_c + "\t" + struct_name + " *res_ptr = MALLOC(sizeof(" + struct_name + "), \"" + struct_name + "\");\n"
1003 out_c = out_c + "\t*res_ptr = " + struct_name + "_init(env, clz, o"
1004 for var in flattened_field_vars:
1005 if isinstance(var, ConvInfo):
1006 out_c = out_c + ", " + var.arg_name
1008 out_c = out_c + ", " + var[1]
1009 out_c = out_c + ");\n"
1010 out_c = out_c + "\treturn (uint64_t)res_ptr;\n"
1011 out_c = out_c + "}\n"
1013 for var in flattened_field_vars:
1014 if not isinstance(var, ConvInfo):
1015 out_java_trait += "\n\t/**\n"
1016 out_java_trait += "\t * Gets the underlying " + var[1] + ".\n"
1017 out_java_trait += "\t */\n"
1018 underscore_name = ''.join('_' + c.lower() if c.isupper() else c for c in var[1]).strip('_')
1019 out_java_trait += "\tpublic " + var[1] + " get_" + underscore_name + "() {\n"
1020 out_java_trait += "\t\t" + var[1] + " res = new " + var[1] + "(null, bindings." + struct_name + "_get_" + var[1] + "(this.ptr));\n"
1021 out_java_trait += "\t\tthis.ptrs_to.add(res);\n"
1022 out_java_trait += "\t\treturn res;\n"
1023 out_java_trait += "\t}\n"
1024 out_java_trait += "\n"
1026 out_java += "\tpublic static native long " + struct_name + "_get_" + var[1] + "(long arg);\n"
1028 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"
1029 out_c += "\t" + struct_name + " *inp = (" + struct_name + " *)(arg & ~1);\n"
1030 out_c += "\tuint64_t res_ptr = (uint64_t)&inp->" + var[1] + ";\n"
1031 out_c += "\tDO_ASSERT((res_ptr & 1) == 0);\n"
1032 out_c += "\treturn (int64_t)(res_ptr | 1);\n"
1035 return (out_java, out_java_trait, out_c)
1037 def trait_struct_inc_refcnt(self, ty_info):
1038 base_conv = "\nif (" + ty_info.var_name + "_conv.free == " + ty_info.rust_obj + "_JCalls_free) {\n"
1039 base_conv = base_conv + "\t// If this_arg is a JCalls struct, then we need to increment the refcnt in it.\n"
1040 base_conv = base_conv + "\t" + ty_info.rust_obj + "_JCalls_cloned(&" + ty_info.var_name + "_conv);\n}"
1043 def map_complex_enum(self, struct_name, variant_list, camel_to_snake, enum_doc_comment):
1044 java_hu_type = struct_name.replace("LDK", "").replace("COption", "Option")
1049 out_java_enum += (self.hu_struct_file_prefix)
1050 out_java_enum += "\n/**\n * " + enum_doc_comment.replace("\n", "\n * ") + "\n */\n"
1051 out_java_enum += "@SuppressWarnings(\"unchecked\") // We correctly assign various generic arrays\n"
1052 out_java_enum += ("public class " + java_hu_type + " extends CommonBase {\n")
1053 out_java_enum += ("\tprivate " + java_hu_type + "(Object _dummy, long ptr) { super(ptr); }\n")
1054 out_java_enum += ("\t@Override @SuppressWarnings(\"deprecation\")\n")
1055 out_java_enum += ("\tprotected void finalize() throws Throwable {\n")
1056 out_java_enum += ("\t\tsuper.finalize();\n")
1057 out_java_enum += ("\t\tif (ptr != 0) { bindings." + struct_name.replace("LDK", "") + "_free(ptr); }\n")
1058 out_java_enum += ("\t}\n")
1059 out_java_enum += ("\tstatic " + java_hu_type + " constr_from_ptr(long ptr) {\n")
1060 out_java_enum += ("\t\tbindings." + struct_name + " raw_val = bindings." + struct_name + "_ref_from_ptr(ptr);\n")
1061 java_hu_subclasses = ""
1063 init_meth_jty_strs = {}
1065 out_java += ("\tpublic static class " + struct_name + " {\n")
1066 out_java += ("\t\tprivate " + struct_name + "() {}\n")
1067 for var in variant_list:
1068 out_java += ("\t\tpublic final static class " + var.var_name + " extends " + struct_name + " {\n")
1069 if var.var_docs is not None:
1070 java_hu_subclasses += "\t/**\n\t * " + var.var_docs.replace("\n", "\n\t * ") + "\n\t */\n"
1071 java_hu_subclasses += "\tpublic final static class " + var.var_name + " extends " + java_hu_type + " {\n"
1072 out_java_enum += ("\t\tif (raw_val.getClass() == bindings." + struct_name + "." + var.var_name + ".class) {\n")
1073 out_java_enum += ("\t\t\treturn new " + var.var_name + "(ptr, (bindings." + struct_name + "." + var.var_name + ")raw_val);\n")
1074 init_meth_jty_str = ""
1075 init_meth_params = ""
1078 for idx, (field_ty, field_docs) in enumerate(var.fields):
1080 init_meth_params = init_meth_params + ", "
1082 if field_ty.java_hu_ty == var.var_name:
1083 field_path = field_ty.java_fn_ty_arg.strip("L;").replace("/", ".")
1084 out_java += "\t\t\tpublic " + field_path + " " + field_ty.arg_name + ";\n"
1085 java_hu_subclasses = java_hu_subclasses + "\t\tpublic final " + field_path + " " + field_ty.arg_name + ";\n"
1086 init_meth_params = init_meth_params + field_path + " " + field_ty.arg_name
1088 out_java += "\t\t\tpublic " + field_ty.java_ty + " " + field_ty.arg_name + ";\n"
1089 if field_docs is not None:
1090 java_hu_subclasses += "\t\t/**\n\t\t * " + field_docs.replace("\n", "\n\t\t * ") + "\n\t\t*/\n"
1091 java_hu_subclasses += "\t\t"
1092 if field_ty.nullable:
1093 java_hu_subclasses += "@Nullable "
1094 java_hu_subclasses += "public final " + field_ty.java_hu_ty + " " + field_ty.arg_name + ";\n"
1095 init_meth_params = init_meth_params + field_ty.java_ty + " " + field_ty.arg_name
1096 init_meth_body = init_meth_body + "this." + field_ty.arg_name + " = " + field_ty.arg_name + "; "
1097 if field_ty.to_hu_conv is not None:
1098 hu_conv_body = hu_conv_body + "\t\t\t" + field_ty.java_ty + " " + field_ty.arg_name + " = obj." + field_ty.arg_name + ";\n"
1099 hu_conv_body = hu_conv_body + "\t\t\t" + field_ty.to_hu_conv.replace("\n", "\n\t\t\t") + "\n"
1100 hu_conv_body = hu_conv_body + "\t\t\tthis." + field_ty.arg_name + " = " + field_ty.to_hu_conv_name + ";\n"
1102 hu_conv_body = hu_conv_body + "\t\t\tthis." + field_ty.arg_name + " = obj." + field_ty.arg_name + ";\n"
1103 init_meth_jty_str = init_meth_jty_str + field_ty.java_fn_ty_arg
1104 out_java += ("\t\t\t" + var.var_name + "(" + init_meth_params + ") { ")
1105 out_java += (init_meth_body)
1107 out_java += ("\t\t}\n")
1108 out_java_enum += ("\t\t}\n")
1109 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"
1110 java_hu_subclasses = java_hu_subclasses + hu_conv_body
1111 java_hu_subclasses = java_hu_subclasses + "\t\t}\n\t}\n"
1112 init_meth_jty_strs[var.var_name] = init_meth_jty_str
1113 out_java += ("\t\tstatic native void init();\n")
1114 out_java += ("\t}\n")
1115 out_java_enum += ("\t\tassert false; return null; // Unreachable without extending the (internal) bindings interface\n\t}\n\n")
1116 out_java_enum += (java_hu_subclasses)
1117 out_java += ("\tstatic { " + struct_name + ".init(); }\n")
1118 out_java += ("\tpublic static native " + struct_name + " " + struct_name + "_ref_from_ptr(long ptr);\n");
1120 out_c += (self.c_complex_enum_pfx(struct_name, [x.var_name for x in variant_list], init_meth_jty_strs))
1122 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")
1123 out_c += ("\t" + struct_name + " *obj = (" + struct_name + "*)(ptr & ~1);\n")
1124 out_c += ("\tswitch(obj->tag) {\n")
1125 for var in variant_list:
1126 out_c += ("\t\tcase " + struct_name + "_" + var.var_name + ": {\n")
1128 for idx, (field_map, field_docs) in enumerate(var.fields):
1129 if field_map.ret_conv is not None:
1130 out_c += ("\t\t\t" + field_map.ret_conv[0].replace("\n", "\n\t\t\t"))
1131 if var.tuple_variant:
1132 out_c += "obj->" + camel_to_snake(var.var_name)
1134 out_c += "obj->" + camel_to_snake(var.var_name) + "." + field_map.arg_name
1135 out_c += (field_map.ret_conv[1].replace("\n", "\n\t\t\t") + "\n")
1136 c_params.append(field_map.ret_conv_name)
1138 if var.tuple_variant:
1139 c_params.append("obj->" + camel_to_snake(var.var_name))
1141 c_params.append("obj->" + camel_to_snake(var.var_name) + "." + field_map.arg_name)
1142 out_c += ("\t\t\treturn " + self.c_constr_native_complex_enum(struct_name, var.var_name, c_params) + ";\n")
1143 out_c += ("\t\t}\n")
1144 out_c += ("\t\tdefault: abort();\n")
1145 out_c += ("\t}\n}\n")
1146 return (out_java, out_java_enum, out_c)
1148 def map_opaque_struct(self, struct_name, struct_doc_comment):
1149 out_opaque_struct_human = ""
1150 out_opaque_struct_human += self.hu_struct_file_prefix
1151 out_opaque_struct_human += "\n/**\n * " + struct_doc_comment.replace("\n", "\n * ") + "\n */\n"
1152 out_opaque_struct_human += "@SuppressWarnings(\"unchecked\") // We correctly assign various generic arrays\n"
1153 hu_name = struct_name.replace("LDKC2Tuple", "TwoTuple").replace("LDKC3Tuple", "ThreeTuple").replace("LDK", "")
1154 out_opaque_struct_human += ("public class " + hu_name + " extends CommonBase")
1155 if struct_name.startswith("LDKLocked"):
1156 out_opaque_struct_human += (" implements AutoCloseable")
1157 out_opaque_struct_human += (" {\n")
1158 out_opaque_struct_human += ("\t" + hu_name + "(Object _dummy, long ptr) { super(ptr); }\n")
1159 if struct_name.startswith("LDKLocked"):
1160 out_opaque_struct_human += ("\t@Override public void close() {\n")
1162 out_opaque_struct_human += ("\t@Override @SuppressWarnings(\"deprecation\")\n")
1163 out_opaque_struct_human += ("\tprotected void finalize() throws Throwable {\n")
1164 out_opaque_struct_human += ("\t\tsuper.finalize();\n")
1165 out_opaque_struct_human += ("\t\tif (ptr != 0) { bindings." + struct_name.replace("LDK","") + "_free(ptr); }\n")
1166 out_opaque_struct_human += ("\t}\n\n")
1167 return out_opaque_struct_human
1169 def map_tuple(self, struct_name):
1170 return self.map_opaque_struct(struct_name, "A Tuple")
1172 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):
1175 out_java_struct = None
1177 out_java += ("\tpublic static native ")
1178 out_c += (self.c_fn_ty_pfx)
1179 out_c += (return_type_info.c_ty)
1180 out_java += (return_type_info.java_ty)
1181 if return_type_info.ret_conv is not None:
1182 ret_conv_pfx, ret_conv_sfx = return_type_info.ret_conv
1183 out_java += (" " + method_name + "(")
1184 have_args = len(argument_types) > 1 or (len(argument_types) > 0 and argument_types[0].c_ty != "void")
1185 out_c += (" " + self.c_fn_name_define_pfx(method_name, have_args))
1187 for idx, arg_conv_info in enumerate(argument_types):
1191 if arg_conv_info.c_ty != "void":
1192 out_c += (arg_conv_info.c_ty + " " + arg_conv_info.arg_name)
1193 out_java += (arg_conv_info.java_ty + " " + arg_conv_info.arg_name)
1195 out_java_struct = ""
1196 extra_java_struct_out = ""
1198 out_java_struct += ("\t// Skipped " + method_name + "\n")
1200 if doc_comment is not None:
1201 out_java_struct += "\t/**\n\t * " + doc_comment.replace("\n", "\n\t * ") + "\n\t */\n"
1202 if return_type_info.nullable:
1203 out_java_struct += "\t@Nullable\n"
1206 out_java_struct += "\tpublic static " + return_type_info.java_hu_ty + " of("
1207 elif meth_n == "default":
1208 out_java_struct += "\tpublic static " + return_type_info.java_hu_ty + " with_default("
1210 out_java_struct += "\tpublic static " + return_type_info.java_hu_ty + " " + meth_n + "("
1211 elif meth_n == "clone_ptr":
1212 out_java_struct += ("\t" + return_type_info.java_hu_ty + " " + meth_n + "(")
1214 if meth_n == "hash" and return_type_info.java_hu_ty == "long":
1215 extra_java_struct_out = "\t@Override public int hashCode() {\n"
1216 extra_java_struct_out += "\t\treturn (int)this.hash();\n"
1217 extra_java_struct_out += "\t}\n"
1218 elif meth_n == "eq" and return_type_info.java_hu_ty == "boolean":
1219 extra_java_struct_out = "\t@Override public boolean equals(Object o) {\n"
1220 extra_java_struct_out += "\t\tif (!(o instanceof " + struct_meth + ")) return false;\n"
1221 extra_java_struct_out += "\t\treturn this.eq((" + struct_meth + ")o);\n"
1222 extra_java_struct_out += "\t}\n"
1223 out_java_struct += ("\tpublic " + return_type_info.java_hu_ty + " " + meth_n + "(")
1224 for idx, arg in enumerate(argument_types):
1226 if not takes_self or idx > 1:
1227 out_java_struct += ", "
1230 if arg.java_ty != "void":
1231 if arg.arg_name in default_constructor_args:
1232 assert not arg.nullable
1233 for explode_idx, explode_arg in enumerate(default_constructor_args[arg.arg_name]):
1234 if explode_idx != 0:
1235 out_java_struct += (", ")
1236 out_java_struct += (
1237 explode_arg.java_hu_ty + " " + arg.arg_name + "_" + explode_arg.arg_name)
1240 out_java_struct += "@Nullable "
1241 ty_string = arg.java_hu_ty
1242 if arg.java_fn_ty_arg[0] == "L" and arg.java_fn_ty_arg[len(arg.java_fn_ty_arg) - 1] == ";":
1243 ty_string = arg.java_fn_ty_arg.strip("L;").replace("/", ".")
1244 out_java_struct += ty_string + " " + arg.arg_name
1245 out_java += (");\n")
1247 if out_java_struct is not None:
1248 out_java_struct += (") {\n")
1249 for info in argument_types:
1250 if info.arg_conv is not None:
1251 out_c += ("\t" + info.arg_conv.replace('\n', "\n\t") + "\n")
1252 if return_type_info.ret_conv is not None:
1253 out_c += ("\t" + ret_conv_pfx.replace('\n', '\n\t'))
1254 elif return_type_info.c_ty != "void":
1255 out_c += ("\t" + return_type_info.c_ty + " ret_val = ")
1258 if c_call_string is None:
1259 out_c += (method_name + "(")
1261 out_c += (c_call_string)
1262 for idx, info in enumerate(argument_types):
1263 if info.arg_conv_name is not None:
1266 elif c_call_string is not None:
1268 out_c += (info.arg_conv_name)
1270 if return_type_info.ret_conv is not None:
1271 out_c += (ret_conv_sfx.replace('\n', '\n\t'))
1274 for info in argument_types:
1275 if info.arg_conv_cleanup is not None:
1276 out_c += ("\n\t" + info.arg_conv_cleanup.replace("\n", "\n\t"))
1277 if return_type_info.ret_conv is not None:
1278 out_c += ("\n\treturn " + return_type_info.ret_conv_name + ";")
1279 elif return_type_info.c_ty != "void":
1280 out_c += ("\n\treturn ret_val;")
1281 out_c += ("\n}\n\n")
1284 out_java_struct += ("\t\t")
1285 if return_type_info.java_ty != "void":
1286 out_java_struct += (return_type_info.java_ty + " ret = ")
1287 out_java_struct += ("bindings." + method_name + "(")
1288 for idx, info in enumerate(argument_types):
1290 out_java_struct += (", ")
1291 if idx == 0 and takes_self:
1292 out_java_struct += ("this.ptr")
1293 elif info.arg_name in default_constructor_args:
1294 out_java_struct += ("bindings." + info.java_hu_ty + "_new(")
1295 for explode_idx, explode_arg in enumerate(default_constructor_args[info.arg_name]):
1296 if explode_idx != 0:
1297 out_java_struct += (", ")
1298 expl_arg_name = info.arg_name + "_" + explode_arg.arg_name
1299 if explode_arg.from_hu_conv is not None:
1300 out_java_struct += (
1301 explode_arg.from_hu_conv[0].replace(explode_arg.arg_name, expl_arg_name))
1303 out_java_struct += (expl_arg_name)
1304 out_java_struct += (")")
1305 elif info.from_hu_conv is not None:
1306 out_java_struct += (info.from_hu_conv[0])
1308 out_java_struct += (info.arg_name)
1309 out_java_struct += (");\n")
1310 if return_type_info.java_ty == "long" and return_type_info.java_hu_ty != "long":
1311 out_java_struct += "\t\tif (ret >= 0 && ret <= 4096) { return null; }\n"
1313 if return_type_info.to_hu_conv is not None:
1315 out_java_struct += ("\t\t" + return_type_info.to_hu_conv.replace("\n", "\n\t\t").replace("this",
1316 return_type_info.to_hu_conv_name) + "\n")
1318 out_java_struct += ("\t\t" + return_type_info.to_hu_conv.replace("\n", "\n\t\t") + "\n")
1320 for idx, info in enumerate(argument_types):
1321 if idx == 0 and takes_self:
1323 elif info.arg_name in default_constructor_args:
1324 for explode_arg in default_constructor_args[info.arg_name]:
1325 expl_arg_name = info.arg_name + "_" + explode_arg.arg_name
1326 if explode_arg.from_hu_conv is not None and return_type_info.to_hu_conv_name:
1327 out_java_struct += ("\t\t" + explode_arg.from_hu_conv[1].replace(explode_arg.arg_name,
1328 expl_arg_name).replace(
1329 "this", return_type_info.to_hu_conv_name) + ";\n")
1330 elif info.from_hu_conv is not None and info.from_hu_conv[1] != "":
1331 if not takes_self and return_type_info.to_hu_conv_name is not None:
1332 out_java_struct += (
1333 "\t\t" + info.from_hu_conv[1].replace("this", return_type_info.to_hu_conv_name).replace("\n", "\n\t\t") + ";\n")
1335 out_java_struct += ("\t\t" + info.from_hu_conv[1].replace("\n", "\n\t\t") + ";\n")
1337 if takes_self and not takes_self_as_ref:
1338 out_java_struct += "\t\t" + argument_types[0].from_hu_conv[1].replace("\n", "\n\t\t").replace("this_arg", "this") + ";\n"
1339 if return_type_info.to_hu_conv_name is not None:
1340 out_java_struct += ("\t\treturn " + return_type_info.to_hu_conv_name + ";\n")
1341 elif return_type_info.java_ty != "void" and return_type_info.rust_obj != "LDK" + struct_meth:
1342 out_java_struct += ("\t\treturn ret;\n")
1343 out_java_struct += ("\t}\n\n")
1345 return (out_java, out_c, out_java_struct + extra_java_struct_out)