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 = new {human_type}(null, {var_name});',
22 default = '{human_type} {var_name}_hu_conv = new {human_type}(null, {var_name});'
25 self.bindings_header = """package org.ldk.impl;
26 import org.ldk.enums.*;
28 import java.io.InputStream;
29 import java.io.IOException;
30 import java.nio.file.Files;
31 import java.nio.file.Path;
32 import java.nio.file.StandardCopyOption;
34 public class bindings {
35 public static class VecOrSliceDef {
39 public VecOrSliceDef(long dataptr, long datalen, long stride) {
40 this.dataptr = dataptr; this.datalen = datalen; this.stride = stride;
45 // Try to load natively first, this works on Android and in testing.
46 System.loadLibrary(\"lightningjni\");
47 } catch (UnsatisfiedLinkError system_load_err) {
48 // Otherwise try to load from the library jar.
49 File tmpdir = new File(System.getProperty("java.io.tmpdir"), "ldk-java-nativelib");
50 tmpdir.mkdir(); // If it fails to create, assume it was there already
51 tmpdir.deleteOnExit();
52 String libname = "liblightningjni_" + System.getProperty("os.name").replaceAll(" ", "") +
53 "-" + System.getProperty("os.arch").replaceAll(" ", "") + ".nativelib";
54 try (InputStream is = bindings.class.getResourceAsStream("/" + libname)) {
55 Path libpath = new File(tmpdir.toPath().toString(), "liblightningjni.so").toPath();
56 Files.copy(is, libpath, StandardCopyOption.REPLACE_EXISTING);
57 Runtime.getRuntime().load(libpath.toString());
58 } catch (IOException e) {
59 System.err.println("Failed to load LDK native library.");
60 System.err.println("System LDK native library load failed with: " + system_load_err);
61 System.err.println("Resource-based LDK native library load failed with: " + e);
62 throw new IllegalArgumentException(e);
65 init(java.lang.Enum.class, VecOrSliceDef.class);
67 if (!get_lib_version_string().equals(get_ldk_java_bindings_version()))
68 throw new IllegalArgumentException("Compiled LDK library and LDK class failes do not match");
69 // Fetching the LDK versions from C also checks that the header and binaries match
70 get_ldk_c_bindings_version();
73 static native void init(java.lang.Class c, java.lang.Class slicedef);
74 static native void init_class_cache();
75 static native String get_lib_version_string();
77 public static String get_ldk_java_bindings_version() {
78 return "<git_version_ldk_garbagecollected>";
80 public static native String get_ldk_c_bindings_version();
81 public static native String get_ldk_version();
83 public static native boolean deref_bool(long ptr);
84 public static native long deref_long(long ptr);
85 public static native void free_heap_ptr(long ptr);
86 public static native byte[] read_bytes(long ptr, long len);
87 public static native byte[] get_u8_slice_bytes(long slice_ptr);
88 public static native long bytes_to_u8_vec(byte[] bytes);
89 public static native long new_txpointer_copy_data(byte[] txdata);
90 public static native void txpointer_free(long ptr);
91 public static native byte[] txpointer_get_buffer(long ptr);
92 public static native long vec_slice_len(long vec);
93 public static native long new_empty_slice_vec();
97 self.bindings_footer = "}\n"
99 self.util_fn_pfx = """package org.ldk.structs;
100 import org.ldk.impl.bindings;
101 import java.util.Arrays;
102 import javax.annotation.Nullable;
103 import org.ldk.enums.*;
105 public class UtilMethods {
107 self.util_fn_sfx = "}"
108 self.common_base = """package org.ldk.structs;
109 import java.util.LinkedList;
112 LinkedList<Object> ptrs_to = new LinkedList();
113 protected CommonBase(long ptr) { assert ptr > 1024; this.ptr = ptr; }
117 self.c_file_pfx = """#include <jni.h>
118 // On OSX jlong (ie long long) is not equivalent to int64_t, so we override here
119 #define int64_t jlong
120 #include \"org_ldk_impl_bindings.h\"
121 #include <lightning.h>
123 #include <stdatomic.h>
128 if self.target == Target.ANDROID:
129 self.c_file_pfx = self.c_file_pfx + """
130 #include <android/log.h>
131 #define DEBUG_PRINT(...) __android_log_print(ANDROID_LOG_ERROR, "LDK", __VA_ARGS__)
135 static void* redirect_stderr(void* ignored) {
138 dup2(pipes[1], STDERR_FILENO);
140 memset(buf, 0, 8192);
142 while ((len = read(pipes[0], buf, 8191)) > 0) {
143 DEBUG_PRINT("%s\\n", buf);
144 memset(buf, 0, 8192);
146 DEBUG_PRINT("End of stderr???\\n");
149 void __attribute__((constructor)) spawn_stderr_redirection() {
151 pthread_create(&thread, NULL, &redirect_stderr, NULL);
155 self.c_file_pfx = self.c_file_pfx + "#define DEBUG_PRINT(...) fprintf(stderr, __VA_ARGS__)\n"
157 if not DEBUG or sys.platform == "darwin":
158 self.c_file_pfx = self.c_file_pfx + """#define MALLOC(a, _) malloc(a)
159 #define FREE(p) if ((uint64_t)(p) > 1024) { free(p); }
162 self.c_file_pfx += """#define DO_ASSERT(a) (void)(a)
166 self.c_file_pfx = self.c_file_pfx + """#include <assert.h>
167 // Always run a, then assert it is true:
168 #define DO_ASSERT(a) do { bool _assert_val = (a); assert(_assert_val); } while(0)
169 // Assert a is true or do nothing
170 #define CHECK(a) DO_ASSERT(a)
172 void __attribute__((constructor)) debug_log_version() {
173 if (check_get_ldk_version() == NULL)
174 DEBUG_PRINT("LDK version did not match the header we built against\\n");
175 if (check_get_ldk_bindings_version() == NULL)
176 DEBUG_PRINT("LDK C Bindings version did not match the header we built against\\n");
177 DEBUG_PRINT("Loaded LDK-Java Bindings with LDK %s and LDK-C-Bindings %s\\n", check_get_ldk_version(), check_get_ldk_bindings_version());
181 if sys.platform != "darwin":
182 self.c_file_pfx += """
183 // Running a leak check across all the allocations and frees of the JDK is a mess,
184 // so instead we implement our own naive leak checker here, relying on the -wrap
185 // linker option to wrap malloc/calloc/realloc/free, tracking everyhing allocated
186 // and free'd in Rust or C across the generated bindings shared library.
190 if self.target == Target.ANDROID:
191 self.c_file_pfx = self.c_file_pfx + """
195 // Implement the execinfo functions using _Unwind_backtrace. This seems to miss many Rust
196 // symbols, so we only use it on Android, where execinfo.h is unavailable.
198 struct BacktraceState {
202 static _Unwind_Reason_Code unwind_callback(struct _Unwind_Context* context, void* arg) {
203 struct BacktraceState* state = (struct BacktraceState*)arg;
204 uintptr_t pc = _Unwind_GetIP(context);
206 if (state->current == state->end) {
207 return _URC_END_OF_STACK;
209 *state->current++ = (void*)(pc);
212 return _URC_NO_REASON;
215 int backtrace(void** buffer, int max) {
216 struct BacktraceState state = { buffer, buffer + max };
217 _Unwind_Backtrace(unwind_callback, &state);
218 return state.current - buffer;
221 void backtrace_symbols_fd(void ** buffer, int count, int _fd) {
222 for (int idx = 0; idx < count; ++idx) {
224 if (dladdr(buffer[idx], &info) && info.dli_sname) {
225 DEBUG_PRINT("%p: %s", buffer[idx], info.dli_sname);
227 DEBUG_PRINT("%p: ???", buffer[idx]);
233 self.c_file_pfx = self.c_file_pfx + "#include <execinfo.h>\n"
234 self.c_file_pfx = self.c_file_pfx + """
237 static pthread_mutex_t allocation_mtx;
239 void __attribute__((constructor)) init_mtx() {
240 DO_ASSERT(!pthread_mutex_init(&allocation_mtx, NULL));
244 typedef struct allocation {
245 struct allocation* next;
247 const char* struct_name;
250 unsigned long alloc_len;
252 static allocation* allocation_ll = NULL;
254 void* __real_malloc(size_t len);
255 void* __real_calloc(size_t nmemb, size_t len);
256 static void new_allocation(void* res, const char* struct_name, size_t len) {
257 allocation* new_alloc = __real_malloc(sizeof(allocation));
258 new_alloc->ptr = res;
259 new_alloc->struct_name = struct_name;
260 new_alloc->bt_len = backtrace(new_alloc->bt, BT_MAX);
261 new_alloc->alloc_len = len;
262 DO_ASSERT(!pthread_mutex_lock(&allocation_mtx));
263 new_alloc->next = allocation_ll;
264 allocation_ll = new_alloc;
265 DO_ASSERT(!pthread_mutex_unlock(&allocation_mtx));
267 static void* MALLOC(size_t len, const char* struct_name) {
268 void* res = __real_malloc(len);
269 new_allocation(res, struct_name, len);
272 void __real_free(void* ptr);
273 static void alloc_freed(void* ptr) {
274 allocation* p = NULL;
275 DO_ASSERT(!pthread_mutex_lock(&allocation_mtx));
276 allocation* it = allocation_ll;
277 while (it->ptr != ptr) {
278 p = it; it = it->next;
280 DEBUG_PRINT("Tried to free unknown pointer %p at:\\n", ptr);
282 int bt_len = backtrace(bt, BT_MAX);
283 backtrace_symbols_fd(bt, bt_len, STDERR_FILENO);
284 DEBUG_PRINT("\\n\\n");
285 DO_ASSERT(!pthread_mutex_unlock(&allocation_mtx));
286 return; // addrsan should catch malloc-unknown and print more info than we have
289 if (p) { p->next = it->next; } else { allocation_ll = it->next; }
290 DO_ASSERT(!pthread_mutex_unlock(&allocation_mtx));
291 DO_ASSERT(it->ptr == ptr);
294 static void FREE(void* ptr) {
295 if ((uint64_t)ptr < 1024) return; // Rust loves to create pointers to the NULL page for dummys
300 void* __wrap_malloc(size_t len) {
301 void* res = __real_malloc(len);
302 new_allocation(res, "malloc call", len);
305 void* __wrap_calloc(size_t nmemb, size_t len) {
306 void* res = __real_calloc(nmemb, len);
307 new_allocation(res, "calloc call", len);
310 void __wrap_free(void* ptr) {
311 if (ptr == NULL) return;
316 void* __real_realloc(void* ptr, size_t newlen);
317 void* __wrap_realloc(void* ptr, size_t len) {
318 if (ptr != NULL) alloc_freed(ptr);
319 void* res = __real_realloc(ptr, len);
320 new_allocation(res, "realloc call", len);
323 void __wrap_reallocarray(void* ptr, size_t new_sz) {
324 // Rust doesn't seem to use reallocarray currently
328 void __attribute__((destructor)) check_leaks() {
329 unsigned long alloc_count = 0;
330 unsigned long alloc_size = 0;
331 DEBUG_PRINT("The following LDK-allocated blocks still remain.\\n");
332 DEBUG_PRINT("Note that this is only accurate if System.gc(); System.runFinalization()\\n");
333 DEBUG_PRINT("was called prior to exit after all LDK objects were out of scope.\\n");
334 for (allocation* a = allocation_ll; a != NULL; a = a->next) {
335 DEBUG_PRINT("%s %p (%lu bytes) remains:\\n", a->struct_name, a->ptr, a->alloc_len);
336 backtrace_symbols_fd(a->bt, a->bt_len, STDERR_FILENO);
337 DEBUG_PRINT("\\n\\n");
339 alloc_size += a->alloc_len;
341 DEBUG_PRINT("%lu allocations remained for %lu bytes.\\n", alloc_count, alloc_size);
342 DEBUG_PRINT("Note that this is only accurate if System.gc(); System.runFinalization()\\n");
343 DEBUG_PRINT("was called prior to exit after all LDK objects were out of scope.\\n");
346 self.c_file_pfx = self.c_file_pfx + """
347 static jmethodID ordinal_meth = NULL;
348 static jmethodID slicedef_meth = NULL;
349 static jclass slicedef_cls = NULL;
350 JNIEXPORT void Java_org_ldk_impl_bindings_init(JNIEnv * env, jclass _b, jclass enum_class, jclass slicedef_class) {
351 ordinal_meth = (*env)->GetMethodID(env, enum_class, "ordinal", "()I");
352 CHECK(ordinal_meth != NULL);
353 slicedef_meth = (*env)->GetMethodID(env, slicedef_class, "<init>", "(JJJ)V");
354 CHECK(slicedef_meth != NULL);
355 slicedef_cls = (*env)->NewGlobalRef(env, slicedef_class);
356 CHECK(slicedef_cls != NULL);
359 JNIEXPORT jboolean JNICALL Java_org_ldk_impl_bindings_deref_1bool (JNIEnv * env, jclass _a, jlong ptr) {
360 return *((bool*)ptr);
362 JNIEXPORT jlong JNICALL Java_org_ldk_impl_bindings_deref_1long (JNIEnv * env, jclass _a, jlong ptr) {
363 return *((long*)ptr);
365 JNIEXPORT void JNICALL Java_org_ldk_impl_bindings_free_1heap_1ptr (JNIEnv * env, jclass _a, jlong ptr) {
368 JNIEXPORT jbyteArray JNICALL Java_org_ldk_impl_bindings_read_1bytes (JNIEnv * env, jclass _b, jlong ptr, jlong len) {
369 jbyteArray ret_arr = (*env)->NewByteArray(env, len);
370 (*env)->SetByteArrayRegion(env, ret_arr, 0, len, (unsigned char*)ptr);
373 JNIEXPORT jbyteArray JNICALL Java_org_ldk_impl_bindings_get_1u8_1slice_1bytes (JNIEnv * env, jclass _b, jlong slice_ptr) {
374 LDKu8slice *slice = (LDKu8slice*)slice_ptr;
375 jbyteArray ret_arr = (*env)->NewByteArray(env, slice->datalen);
376 (*env)->SetByteArrayRegion(env, ret_arr, 0, slice->datalen, slice->data);
379 JNIEXPORT int64_t impl_bindings_bytes_1to_1u8_1vec (JNIEnv * env, jclass _b, jbyteArray bytes) {
380 LDKCVec_u8Z *vec = (LDKCVec_u8Z*)MALLOC(sizeof(LDKCVec_u8Z), "LDKCVec_u8");
381 vec->datalen = (*env)->GetArrayLength(env, bytes);
382 vec->data = (uint8_t*)MALLOC(vec->datalen, "LDKCVec_u8Z Bytes");
383 (*env)->GetByteArrayRegion (env, bytes, 0, vec->datalen, vec->data);
384 return (uint64_t)vec;
386 JNIEXPORT jbyteArray JNICALL Java_org_ldk_impl_bindings_txpointer_1get_1buffer (JNIEnv * env, jclass _b, jlong ptr) {
387 LDKTransaction *txdata = (LDKTransaction*)ptr;
389 slice.data = txdata->data;
390 slice.datalen = txdata->datalen;
391 return Java_org_ldk_impl_bindings_get_1u8_1slice_1bytes(env, _b, (uint64_t)&slice);
393 JNIEXPORT int64_t JNICALL Java_org_ldk_impl_bindings_new_1txpointer_1copy_1data (JNIEnv * env, jclass _b, jbyteArray bytes) {
394 LDKTransaction *txdata = (LDKTransaction*)MALLOC(sizeof(LDKTransaction), "LDKTransaction");
395 txdata->datalen = (*env)->GetArrayLength(env, bytes);
396 txdata->data = (uint8_t*)MALLOC(txdata->datalen, "Tx Data Bytes");
397 txdata->data_is_owned = false;
398 (*env)->GetByteArrayRegion (env, bytes, 0, txdata->datalen, txdata->data);
399 return (uint64_t)txdata;
401 JNIEXPORT void JNICALL Java_org_ldk_impl_bindings_txpointer_1free (JNIEnv * env, jclass _b, jlong ptr) {
402 LDKTransaction *tx = (LDKTransaction*)ptr;
403 tx->data_is_owned = true;
404 Transaction_free(*tx);
407 JNIEXPORT jlong JNICALL Java_org_ldk_impl_bindings_vec_1slice_1len (JNIEnv * env, jclass _a, jlong ptr) {
408 // Check offsets of a few Vec types are all consistent as we're meant to be generic across types
409 _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKCVec_SignatureZ, datalen), "Vec<*> needs to be mapped identically");
410 _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKCVec_MessageSendEventZ, datalen), "Vec<*> needs to be mapped identically");
411 _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKCVec_EventZ, datalen), "Vec<*> needs to be mapped identically");
412 _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKCVec_C2Tuple_usizeTransactionZZ, datalen), "Vec<*> needs to be mapped identically");
413 LDKCVec_u8Z *vec = (LDKCVec_u8Z*)ptr;
414 return (uint64_t)vec->datalen;
416 JNIEXPORT int64_t JNICALL Java_org_ldk_impl_bindings_new_1empty_1slice_1vec (JNIEnv * env, jclass _b) {
417 // Check sizes of a few Vec types are all consistent as we're meant to be generic across types
418 _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKCVec_SignatureZ), "Vec<*> needs to be mapped identically");
419 _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKCVec_MessageSendEventZ), "Vec<*> needs to be mapped identically");
420 _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKCVec_EventZ), "Vec<*> needs to be mapped identically");
421 _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKCVec_C2Tuple_usizeTransactionZZ), "Vec<*> needs to be mapped identically");
422 LDKCVec_u8Z *vec = (LDKCVec_u8Z*)MALLOC(sizeof(LDKCVec_u8Z), "Empty LDKCVec");
425 return (uint64_t)vec;
428 // We assume that CVec_u8Z and u8slice are the same size and layout (and thus pointers to the two can be mixed)
429 _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKu8slice), "Vec<u8> and [u8] need to have been mapped identically");
430 _Static_assert(offsetof(LDKCVec_u8Z, data) == offsetof(LDKu8slice, data), "Vec<u8> and [u8] need to have been mapped identically");
431 _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKu8slice, datalen), "Vec<u8> and [u8] need to have been mapped identically");
433 _Static_assert(sizeof(jlong) == sizeof(int64_t), "We assume that j-types are the same as C types");
434 _Static_assert(sizeof(jbyte) == sizeof(char), "We assume that j-types are the same as C types");
435 _Static_assert(sizeof(void*) <= 8, "Pointers must fit into 64 bits");
437 typedef jlongArray int64_tArray;
438 typedef jbyteArray int8_tArray;
440 static inline jstring str_ref_to_java(JNIEnv *env, const char* chars, size_t len) {
441 // Sadly we need to create a temporary because Java can't accept a char* without a 0-terminator
442 char* conv_buf = MALLOC(len + 1, "str conv buf");
443 memcpy(conv_buf, chars, len);
445 jstring ret = (*env)->NewStringUTF(env, conv_buf);
449 static inline LDKStr java_to_owned_str(JNIEnv *env, jstring str) {
450 uint64_t str_len = (*env)->GetStringUTFLength(env, str);
451 char* newchars = MALLOC(str_len + 1, "String chars");
452 const char* jchars = (*env)->GetStringUTFChars(env, str, NULL);
453 memcpy(newchars, jchars, str_len);
454 newchars[str_len] = 0;
455 (*env)->ReleaseStringUTFChars(env, str, jchars);
459 .chars_is_owned = true
464 JNIEXPORT jstring JNICALL Java_org_ldk_impl_bindings_get_1lib_1version_1string(JNIEnv *env, jclass _c) {
465 return str_ref_to_java(env, "<git_version_ldk_garbagecollected>", strlen("<git_version_ldk_garbagecollected>"));
467 JNIEXPORT jstring JNICALL Java_org_ldk_impl_bindings_get_1ldk_1c_1bindings_1version(JNIEnv *env, jclass _c) {
468 return str_ref_to_java(env, check_get_ldk_bindings_version(), strlen(check_get_ldk_bindings_version()));
470 JNIEXPORT jstring JNICALL Java_org_ldk_impl_bindings_get_1ldk_1version(JNIEnv *env, jclass _c) {
471 return str_ref_to_java(env, check_get_ldk_version(), strlen(check_get_ldk_version()));
475 self.hu_struct_file_prefix = """package org.ldk.structs;
477 import org.ldk.impl.bindings;
478 import org.ldk.enums.*;
479 import org.ldk.util.*;
480 import java.util.Arrays;
481 import javax.annotation.Nullable;
484 self.c_fn_ty_pfx = "JNIEXPORT "
485 self.c_fn_args_pfx = "JNIEnv *env, jclass clz"
486 self.file_ext = ".java"
487 self.ptr_c_ty = "int64_t"
488 self.ptr_native_ty = "long"
489 self.result_c_ty = "jclass"
490 self.ptr_arr = "jobjectArray"
491 self.is_arr_some_check = ("", " != NULL")
492 self.get_native_arr_len_call = ("(*env)->GetArrayLength(env, ", ")")
494 def construct_jenv(self):
495 res = "JNIEnv *env;\n"
496 res += "jint get_jenv_res = (*j_calls->vm)->GetEnv(j_calls->vm, (void**)&env, JNI_VERSION_1_6);\n"
497 res += "if (get_jenv_res == JNI_EDETACHED) {\n"
498 if self.target == Target.ANDROID:
499 res += "\tDO_ASSERT((*j_calls->vm)->AttachCurrentThread(j_calls->vm, &env, NULL) == JNI_OK);\n"
501 res += "\tDO_ASSERT((*j_calls->vm)->AttachCurrentThread(j_calls->vm, (void**)&env, NULL) == JNI_OK);\n"
503 res += "\tDO_ASSERT(get_jenv_res == JNI_OK);\n"
506 def deconstruct_jenv(self):
507 res = "if (get_jenv_res == JNI_EDETACHED) {\n"
508 res += "\tDO_ASSERT((*j_calls->vm)->DetachCurrentThread(j_calls->vm) == JNI_OK);\n"
512 def release_native_arr_ptr_call(self, ty_info, arr_var, arr_ptr_var):
513 if ty_info.subty is None or not ty_info.subty.c_ty.endswith("Array"):
514 return "(*env)->ReleasePrimitiveArrayCritical(env, " + arr_var + ", " + arr_ptr_var + ", 0)"
516 def create_native_arr_call(self, arr_len, ty_info):
517 if ty_info.c_ty == "int8_tArray":
518 return "(*env)->NewByteArray(env, " + arr_len + ")"
519 elif ty_info.subty.c_ty.endswith("Array"):
520 clz_var = ty_info.java_fn_ty_arg[1:].replace("[", "arr_of_")
521 self.c_array_class_caches.add(clz_var)
522 return "(*env)->NewObjectArray(env, " + arr_len + ", " + clz_var + "_clz, NULL);\n"
524 return "(*env)->New" + ty_info.java_ty.strip("[]").title() + "Array(env, " + arr_len + ")"
525 def set_native_arr_contents(self, arr_name, arr_len, ty_info):
526 if ty_info.c_ty == "int8_tArray":
527 return ("(*env)->SetByteArrayRegion(env, " + arr_name + ", 0, " + arr_len + ", ", ")")
530 def get_native_arr_contents(self, arr_name, dest_name, arr_len, ty_info, copy):
531 if ty_info.c_ty == "int8_tArray":
533 return "(*env)->GetByteArrayRegion(env, " + arr_name + ", 0, " + arr_len + ", " + dest_name + ")"
535 return "(*env)->GetByteArrayElements (env, " + arr_name + ", NULL)"
536 elif not ty_info.java_ty[:len(ty_info.java_ty) - 2].endswith("[]"):
537 return "(*env)->Get" + ty_info.subty.java_ty.title() + "ArrayElements (env, " + arr_name + ", NULL)"
540 def get_native_arr_elem(self, arr_name, idxc, ty_info):
541 if self.get_native_arr_contents(arr_name, "", "", ty_info, False) is None:
542 return "(*env)->GetObjectArrayElement(env, " + arr_name + ", " + idxc + ")"
544 assert False # Only called if above is None
545 def get_native_arr_ptr_call(self, ty_info):
546 if ty_info.subty is not None and ty_info.subty.c_ty.endswith("Array"):
548 return ("(*env)->GetPrimitiveArrayCritical(env, ", ", NULL)")
549 def get_native_arr_entry_call(self, ty_info, arr_name, idxc, entry_access):
550 if ty_info.subty is None or not ty_info.subty.c_ty.endswith("Array"):
552 return "(*env)->SetObjectArrayElement(env, " + arr_name + ", " + idxc + ", " + entry_access + ")"
553 def cleanup_native_arr_ref_contents(self, arr_name, dest_name, arr_len, ty_info):
554 if ty_info.c_ty == "int8_tArray":
555 return "(*env)->ReleaseByteArrayElements(env, " + arr_name + ", (int8_t*)" + dest_name + ", 0);"
557 return "(*env)->Release" + ty_info.java_ty.strip("[]").title() + "ArrayElements(env, " + arr_name + ", " + dest_name + ", 0)"
559 def str_ref_to_native_call(self, var_name, str_len):
560 return "str_ref_to_java(env, " + var_name + ", " + str_len + ")"
561 def str_ref_to_c_call(self, var_name):
562 return "java_to_owned_str(env, " + var_name + ")"
564 def c_fn_name_define_pfx(self, fn_name, has_args):
566 return "JNICALL Java_org_ldk_impl_bindings_" + fn_name.replace("_", "_1") + "(JNIEnv *env, jclass clz, "
567 return "JNICALL Java_org_ldk_impl_bindings_" + fn_name.replace("_", "_1") + "(JNIEnv *env, jclass clz"
571 for ty in sorted(self.c_array_class_caches):
572 res = res + "static jclass " + ty + "_clz = NULL;\n"
573 res = res + "JNIEXPORT void Java_org_ldk_impl_bindings_init_1class_1cache(JNIEnv * env, jclass clz) {\n"
574 for ty in sorted(self.c_array_class_caches):
575 res = res + "\t" + ty + "_clz = (*env)->FindClass(env, \"" + ty.replace("arr_of_", "[") + "\");\n"
576 res = res + "\tCHECK(" + ty + "_clz != NULL);\n"
577 res = res + "\t" + ty + "_clz = (*env)->NewGlobalRef(env, " + ty + "_clz);\n"
581 def native_c_unitary_enum_map(self, struct_name, variants, enum_doc_comment):
582 out_java_enum = "package org.ldk.enums;\n\n"
585 out_c = out_c + "static inline LDK" + struct_name + " LDK" + struct_name + "_from_java(" + self.c_fn_args_pfx + ") {\n"
586 out_c = out_c + "\tswitch ((*env)->CallIntMethod(env, clz, ordinal_meth)) {\n"
588 if enum_doc_comment is not None:
589 out_java_enum += "/**\n * " + enum_doc_comment.replace("\n", "\n * ") + "\n */\n"
590 out_java_enum += "public enum " + struct_name + " {\n"
593 out_java_enum = out_java_enum + "\t" + var + ",\n"
594 out_c = out_c + "\t\tcase %d: return %s;\n" % (ord_v, var)
596 out_java_enum = out_java_enum + "\t; static native void init();\n"
597 out_java_enum = out_java_enum + "\tstatic { init(); }\n"
598 out_java_enum = out_java_enum + "}"
599 out_java = out_java + "\tstatic { " + struct_name + ".values(); /* Force enum statics to run */ }\n"
600 out_c = out_c + "\t}\n"
601 out_c = out_c + "\tabort();\n"
602 out_c = out_c + "}\n"
604 out_c = out_c + "static jclass " + struct_name + "_class = NULL;\n"
606 out_c = out_c + "static jfieldID " + struct_name + "_" + var + " = NULL;\n"
607 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"
608 out_c = out_c + "\t" + struct_name + "_class = (*env)->NewGlobalRef(env, clz);\n"
609 out_c = out_c + "\tCHECK(" + struct_name + "_class != NULL);\n"
611 out_c = out_c + "\t" + struct_name + "_" + var + " = (*env)->GetStaticFieldID(env, " + struct_name + "_class, \"" + var + "\", \"Lorg/ldk/enums/" + struct_name + ";\");\n"
612 out_c = out_c + "\tCHECK(" + struct_name + "_" + var + " != NULL);\n"
613 out_c = out_c + "}\n"
614 out_c = out_c + "static inline jclass LDK" + struct_name + "_to_java(JNIEnv *env, LDK" + struct_name + " val) {\n"
615 out_c = out_c + "\tswitch (val) {\n"
618 out_c = out_c + "\t\tcase " + var + ":\n"
619 out_c = out_c + "\t\t\treturn (*env)->GetStaticObjectField(env, " + struct_name + "_class, " + struct_name + "_" + var + ");\n"
621 out_c = out_c + "\t\tdefault: abort();\n"
622 out_c = out_c + "\t}\n"
623 out_c = out_c + "}\n\n"
625 return (out_c, out_java_enum, out_java)
627 def c_unitary_enum_to_native_call(self, ty_info):
628 return (ty_info.rust_obj + "_to_java(env, ", ")")
629 def native_unitary_enum_to_c_call(self, ty_info):
630 return (ty_info.rust_obj + "_from_java(env, ", ")")
632 def c_complex_enum_pfx(self, struct_name, variants, init_meth_jty_strs):
635 out_c = out_c + "static jclass " + struct_name + "_" + var + "_class = NULL;\n"
636 out_c = out_c + "static jmethodID " + struct_name + "_" + var + "_meth = NULL;\n"
637 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"
638 for var_name in variants:
639 out_c = out_c + "\t" + struct_name + "_" + var_name + "_class =\n"
640 if self.target == Target.ANDROID:
641 out_c = out_c + "\t\t(*env)->NewGlobalRef(env, (*env)->FindClass(env, \"org/ldk/impl/bindings$" + struct_name + "$" + var_name + "\"));\n"
643 out_c = out_c + "\t\t(*env)->NewGlobalRef(env, (*env)->FindClass(env, \"Lorg/ldk/impl/bindings$" + struct_name + "$" + var_name + ";\"));\n"
644 out_c = out_c + "\tCHECK(" + struct_name + "_" + var_name + "_class != NULL);\n"
645 out_c = out_c + "\t" + struct_name + "_" + var_name + "_meth = (*env)->GetMethodID(env, " + struct_name + "_" + var_name + "_class, \"<init>\", \"(" + init_meth_jty_strs[var_name] + ")V\");\n"
646 out_c = out_c + "\tCHECK(" + struct_name + "_" + var_name + "_meth != NULL);\n"
647 out_c = out_c + "}\n"
650 def c_complex_enum_pass_ty(self, struct_name):
653 def c_constr_native_complex_enum(self, struct_name, variant, c_params):
654 ret = "(*env)->NewObject(env, " + struct_name + "_" + variant + "_class, " + struct_name + "_" + variant + "_meth"
655 for param in c_params:
656 ret = ret + ", " + param
659 def native_c_map_trait(self, struct_name, field_vars, flattened_field_vars, field_fns, trait_doc_comment):
663 # First generate most of the Java code, note that we need information about java method argument strings for C
664 out_java_trait = out_java_trait + self.hu_struct_file_prefix
665 if trait_doc_comment is not None:
666 out_java_trait += "/**\n * " + trait_doc_comment.replace("\n", "\n * ") + "\n */\n"
667 out_java_trait += "@SuppressWarnings(\"unchecked\") // We correctly assign various generic arrays\n"
668 out_java_trait = out_java_trait + "public class " + struct_name.replace("LDK","") + " extends CommonBase {\n"
669 out_java_trait = out_java_trait + "\tfinal bindings." + struct_name + " bindings_instance;\n"
670 out_java_trait = out_java_trait + "\t" + struct_name.replace("LDK", "") + "(Object _dummy, long ptr) { super(ptr); bindings_instance = null; }\n"
671 out_java_trait = out_java_trait + "\tprivate " + struct_name.replace("LDK", "") + "(bindings." + struct_name + " arg"
672 for var in flattened_field_vars:
673 if isinstance(var, ConvInfo):
674 out_java_trait = out_java_trait + ", " + var.java_hu_ty + " " + var.arg_name
676 out_java_trait = out_java_trait + ", bindings." + var[0] + " " + var[1]
677 out_java_trait = out_java_trait + ") {\n"
678 out_java_trait = out_java_trait + "\t\tsuper(bindings." + struct_name + "_new(arg"
679 for var in flattened_field_vars:
680 if isinstance(var, ConvInfo):
681 if var.from_hu_conv is not None:
682 out_java_trait = out_java_trait + ", " + var.from_hu_conv[0]
684 out_java_trait = out_java_trait + ", " + var.arg_name
686 out_java_trait = out_java_trait + ", " + var[1]
687 out_java_trait = out_java_trait + "));\n"
688 out_java_trait = out_java_trait + "\t\tthis.ptrs_to.add(arg);\n"
689 for var in flattened_field_vars:
690 if isinstance(var, ConvInfo):
691 if var.from_hu_conv is not None and var.from_hu_conv[1] != "":
692 out_java_trait = out_java_trait + "\t\t" + var.from_hu_conv[1].replace("\n", "\n\t\t") + ";\n"
694 out_java_trait = out_java_trait + "\t\tthis.ptrs_to.add(" + var[1] + ");\n"
695 out_java_trait = out_java_trait + "\t\tthis.bindings_instance = arg;\n"
696 out_java_trait = out_java_trait + "\t}\n"
697 out_java_trait = out_java_trait + "\t@Override @SuppressWarnings(\"deprecation\")\n"
698 out_java_trait = out_java_trait + "\tprotected void finalize() throws Throwable {\n"
699 out_java_trait = out_java_trait + "\t\tif (ptr != 0) { bindings." + struct_name.replace("LDK","") + "_free(ptr); } super.finalize();\n"
700 out_java_trait = out_java_trait + "\t}\n\n"
702 java_trait_constr = "\tprivate static class " + struct_name + "Holder { " + struct_name.replace("LDK", "") + " held; }\n"
703 java_trait_constr = java_trait_constr + "\tpublic static " + struct_name.replace("LDK", "") + " new_impl(" + struct_name.replace("LDK", "") + "Interface arg"
704 for var in flattened_field_vars:
705 if isinstance(var, ConvInfo):
706 java_trait_constr = java_trait_constr + ", " + var.java_hu_ty + " " + var.arg_name
708 # Ideally we'd be able to take any instance of the interface, but our C code can only represent
709 # Java-implemented version, so we require users pass a Java implementation here :/
710 java_trait_constr = java_trait_constr + ", " + var[0].replace("LDK", "") + "." + var[0].replace("LDK", "") + "Interface " + var[1] + "_impl"
711 java_trait_constr = java_trait_constr + ") {\n\t\tfinal " + struct_name + "Holder impl_holder = new " + struct_name + "Holder();\n"
712 java_trait_constr = java_trait_constr + "\t\timpl_holder.held = new " + struct_name.replace("LDK", "") + "(new bindings." + struct_name + "() {\n"
713 out_java_trait = out_java_trait + "\tpublic static interface " + struct_name.replace("LDK", "") + "Interface {\n"
714 out_java = out_java + "\tpublic interface " + struct_name + " {\n"
716 for fn_line in field_fns:
717 java_meth_descr = "("
718 if fn_line.fn_name != "free" and fn_line.fn_name != "cloned":
719 out_java = out_java + "\t\t " + fn_line.ret_ty_info.java_ty + " " + fn_line.fn_name + "("
720 java_trait_constr = java_trait_constr + "\t\t\t@Override public " + fn_line.ret_ty_info.java_ty + " " + fn_line.fn_name + "("
721 out_java_trait += "\t\t/**\n\t\t * " + fn_line.docs.replace("\n", "\n\t\t * ") + "\n\t\t */\n"
722 out_java_trait = out_java_trait + "\t\t" + fn_line.ret_ty_info.java_hu_ty + " " + fn_line.fn_name + "("
724 for idx, arg_conv_info in enumerate(fn_line.args_ty):
726 out_java = out_java + ", "
727 java_trait_constr = java_trait_constr + ", "
728 out_java_trait = out_java_trait + ", "
729 out_java = out_java + arg_conv_info.java_ty + " " + arg_conv_info.arg_name
730 out_java_trait = out_java_trait + arg_conv_info.java_hu_ty + " " + arg_conv_info.arg_name
731 java_trait_constr = java_trait_constr + arg_conv_info.java_ty + " " + arg_conv_info.arg_name
732 java_meth_descr = java_meth_descr + arg_conv_info.java_fn_ty_arg
733 java_meth_descr = java_meth_descr + ")" + fn_line.ret_ty_info.java_fn_ty_arg
734 java_meths.append((fn_line.fn_name, java_meth_descr))
736 out_java = out_java + ");\n"
737 out_java_trait = out_java_trait + ");\n"
738 java_trait_constr = java_trait_constr + ") {\n"
740 for arg_info in fn_line.args_ty:
741 if arg_info.to_hu_conv is not None:
742 java_trait_constr = java_trait_constr + "\t\t\t\t" + arg_info.to_hu_conv.replace("\n", "\n\t\t\t\t") + "\n"
744 if fn_line.ret_ty_info.java_ty != "void":
745 java_trait_constr = java_trait_constr + "\t\t\t\t" + fn_line.ret_ty_info.java_hu_ty + " ret = arg." + fn_line.fn_name + "("
747 java_trait_constr = java_trait_constr + "\t\t\t\targ." + fn_line.fn_name + "("
749 for idx, arg_info in enumerate(fn_line.args_ty):
751 java_trait_constr = java_trait_constr + ", "
752 if arg_info.to_hu_conv_name is not None:
753 java_trait_constr = java_trait_constr + arg_info.to_hu_conv_name
755 java_trait_constr = java_trait_constr + arg_info.arg_name
757 java_trait_constr = java_trait_constr + ");\n"
758 if fn_line.ret_ty_info.java_ty != "void":
759 if fn_line.ret_ty_info.from_hu_conv is not None:
760 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"
761 if fn_line.ret_ty_info.from_hu_conv[1] != "":
762 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"
763 #if fn_line.ret_ty_info.rust_obj in result_types:
764 java_trait_constr = java_trait_constr + "\t\t\t\treturn result;\n"
766 java_trait_constr = java_trait_constr + "\t\t\t\treturn ret;\n"
767 java_trait_constr = java_trait_constr + "\t\t\t}\n"
768 java_trait_constr = java_trait_constr + "\t\t}"
769 for var in field_vars:
770 if isinstance(var, ConvInfo):
771 java_trait_constr = java_trait_constr + ", " + var.arg_name
773 java_trait_constr += ", " + var[1] + ".new_impl(" + var[1] + "_impl"
774 for suparg in var[2]:
775 if isinstance(suparg, ConvInfo):
776 java_trait_constr += ", " + suparg.arg_name
778 java_trait_constr += ", " + suparg[1]
779 java_trait_constr += ").bindings_instance"
780 for suparg in var[2]:
781 if isinstance(suparg, ConvInfo):
782 java_trait_constr += ", " + suparg.arg_name
784 java_trait_constr += ", " + suparg[1]
785 out_java_trait = out_java_trait + "\t}\n"
786 out_java_trait = out_java_trait + java_trait_constr + ");\n\t\treturn impl_holder.held;\n\t}\n"
788 out_java = out_java + "\t}\n"
790 out_java = out_java + "\tpublic static native long " + struct_name + "_new(" + struct_name + " impl"
791 for var in flattened_field_vars:
792 if isinstance(var, ConvInfo):
793 out_java = out_java + ", " + var.java_ty + " " + var.arg_name
795 out_java = out_java + ", " + var[0] + " " + var[1]
796 out_java = out_java + ");\n"
798 # Now that we've written out our java code (and created java_meths), generate C
799 out_c = "typedef struct " + struct_name + "_JCalls {\n"
800 out_c = out_c + "\tatomic_size_t refcnt;\n"
801 out_c = out_c + "\tJavaVM *vm;\n"
802 out_c = out_c + "\tjweak o;\n"
803 for var in flattened_field_vars:
804 if isinstance(var, ConvInfo):
805 # We're a regular ol' field
809 out_c = out_c + "\t" + var[0] + "_JCalls* " + var[1] + ";\n"
811 if fn.fn_name != "free" and fn.fn_name != "cloned":
812 out_c = out_c + "\tjmethodID " + fn.fn_name + "_meth;\n"
813 out_c = out_c + "} " + struct_name + "_JCalls;\n"
815 for fn_line in field_fns:
816 if fn_line.fn_name == "free":
817 out_c = out_c + "static void " + struct_name + "_JCalls_free(void* this_arg) {\n"
818 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) this_arg;\n"
819 out_c = out_c + "\tif (atomic_fetch_sub_explicit(&j_calls->refcnt, 1, memory_order_acquire) == 1) {\n"
820 out_c += "\t\t" + self.construct_jenv().replace("\n", "\n\t\t").strip() + "\n"
821 out_c = out_c + "\t\t(*env)->DeleteWeakGlobalRef(env, j_calls->o);\n"
822 out_c += "\t\t" + self.deconstruct_jenv().replace("\n", "\n\t\t").strip() + "\n"
823 out_c = out_c + "\t\tFREE(j_calls);\n"
824 out_c = out_c + "\t}\n}\n"
826 for idx, fn_line in enumerate(field_fns):
827 if fn_line.fn_name != "free" and fn_line.fn_name != "cloned":
828 assert fn_line.ret_ty_info.ty_info.get_full_rust_ty()[1] == ""
829 out_c = out_c + fn_line.ret_ty_info.ty_info.get_full_rust_ty()[0] + " " + fn_line.fn_name + "_" + struct_name + "_jcall("
830 if fn_line.self_is_const:
831 out_c = out_c + "const void* this_arg"
833 out_c = out_c + "void* this_arg"
835 for idx, arg in enumerate(fn_line.args_ty):
836 out_c = out_c + ", " + arg.ty_info.get_full_rust_ty()[0] + " " + arg.arg_name + arg.ty_info.get_full_rust_ty()[1]
838 out_c = out_c + ") {\n"
839 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) this_arg;\n"
840 out_c += "\t" + self.construct_jenv().replace("\n", "\n\t").strip() + "\n"
842 for arg_info in fn_line.args_ty:
843 if arg_info.ret_conv is not None:
844 out_c = out_c + "\t" + arg_info.ret_conv[0].replace('\n', '\n\t')
845 out_c = out_c + arg_info.arg_name
846 out_c = out_c + arg_info.ret_conv[1].replace('\n', '\n\t') + "\n"
848 out_c = out_c + "\tjobject obj = (*env)->NewLocalRef(env, j_calls->o);\n\tCHECK(obj != NULL);\n"
849 if fn_line.ret_ty_info.c_ty.endswith("Array"):
850 out_c = out_c + "\t" + fn_line.ret_ty_info.c_ty + " ret = (*env)->CallObjectMethod(env, obj, j_calls->" + fn_line.fn_name + "_meth"
851 elif fn_line.ret_ty_info.c_ty == "void":
852 out_c += "\t(*env)->Call" + fn_line.ret_ty_info.java_ty.title() + "Method(env, obj, j_calls->" + fn_line.fn_name + "_meth"
853 elif fn_line.ret_ty_info.java_ty == "String":
854 # Manually write out String methods as they're just an Object
855 out_c += "\t" + fn_line.ret_ty_info.c_ty + " ret = (*env)->CallObjectMethod(env, obj, j_calls->" + fn_line.fn_name + "_meth"
856 elif not fn_line.ret_ty_info.passed_as_ptr:
857 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"
859 out_c = out_c + "\tuint64_t ret = (*env)->CallLongMethod(env, obj, j_calls->" + fn_line.fn_name + "_meth"
861 for idx, arg_info in enumerate(fn_line.args_ty):
862 if arg_info.ret_conv is not None:
863 out_c = out_c + ", " + arg_info.ret_conv_name
865 out_c = out_c + ", " + arg_info.arg_name
866 out_c = out_c + ");\n"
868 out_c += "\tif ((*env)->ExceptionCheck(env)) {\n"
869 out_c += "\t\t(*env)->ExceptionDescribe(env);\n"
870 out_c += "\t\t(*env)->FatalError(env, \"A call to " + fn_line.fn_name + " in " + struct_name + " from rust threw an exception.\");\n"
873 if fn_line.ret_ty_info.arg_conv is not None:
874 out_c += "\t" + fn_line.ret_ty_info.arg_conv.replace("\n", "\n\t") + "\n"
875 out_c += "\t" + self.deconstruct_jenv().replace("\n", "\n\t").strip() + "\n"
876 out_c += "\treturn " + fn_line.ret_ty_info.arg_conv_name + ";\n"
878 out_c += "\t" + self.deconstruct_jenv().replace("\n", "\n\t").strip() + "\n"
879 if not fn_line.ret_ty_info.passed_as_ptr and fn_line.ret_ty_info.c_ty != "void":
880 out_c += "\treturn ret;\n"
882 out_c = out_c + "}\n"
884 # If we can, write out a clone function whether we need one or not, as we use them in moving to rust
885 can_clone_with_ptr = True
886 for var in field_vars:
887 if isinstance(var, ConvInfo):
888 can_clone_with_ptr = False
889 if can_clone_with_ptr:
890 out_c = out_c + "static void " + struct_name + "_JCalls_cloned(" + struct_name + "* new_obj) {\n"
891 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) new_obj->this_arg;\n"
892 out_c = out_c + "\tatomic_fetch_add_explicit(&j_calls->refcnt, 1, memory_order_release);\n"
893 for var in field_vars:
894 if not isinstance(var, ConvInfo):
895 out_c = out_c + "\tatomic_fetch_add_explicit(&j_calls->" + var[1] + "->refcnt, 1, memory_order_release);\n"
896 out_c = out_c + "}\n"
898 out_c = out_c + "static inline " + struct_name + " " + struct_name + "_init (" + self.c_fn_args_pfx + ", jobject o"
899 for var in flattened_field_vars:
900 if isinstance(var, ConvInfo):
901 out_c = out_c + ", " + var.c_ty + " " + var.arg_name
903 out_c = out_c + ", jobject " + var[1]
904 out_c = out_c + ") {\n"
906 out_c = out_c + "\tjclass c = (*env)->GetObjectClass(env, o);\n"
907 out_c = out_c + "\tCHECK(c != NULL);\n"
908 out_c = out_c + "\t" + struct_name + "_JCalls *calls = MALLOC(sizeof(" + struct_name + "_JCalls), \"" + struct_name + "_JCalls\");\n"
909 out_c = out_c + "\tatomic_init(&calls->refcnt, 1);\n"
910 out_c = out_c + "\tDO_ASSERT((*env)->GetJavaVM(env, &calls->vm) == 0);\n"
911 out_c = out_c + "\tcalls->o = (*env)->NewWeakGlobalRef(env, o);\n"
913 for (fn_name, java_meth_descr) in java_meths:
914 if fn_name != "free" and fn_name != "cloned":
915 out_c = out_c + "\tcalls->" + fn_name + "_meth = (*env)->GetMethodID(env, c, \"" + fn_name + "\", \"" + java_meth_descr + "\");\n"
916 out_c = out_c + "\tCHECK(calls->" + fn_name + "_meth != NULL);\n"
918 for var in flattened_field_vars:
919 if isinstance(var, ConvInfo) and var.arg_conv is not None:
920 out_c = out_c + "\n\t" + var.arg_conv.replace("\n", "\n\t") +"\n"
921 out_c = out_c + "\n\t" + struct_name + " ret = {\n"
922 out_c = out_c + "\t\t.this_arg = (void*) calls,\n"
923 for fn_line in field_fns:
924 if fn_line.fn_name != "free" and fn_line.fn_name != "cloned":
925 out_c = out_c + "\t\t." + fn_line.fn_name + " = " + fn_line.fn_name + "_" + struct_name + "_jcall,\n"
926 elif fn_line.fn_name == "free":
927 out_c = out_c + "\t\t.free = " + struct_name + "_JCalls_free,\n"
929 out_c = out_c + "\t\t.cloned = " + struct_name + "_JCalls_cloned,\n"
930 for var in field_vars:
931 if isinstance(var, ConvInfo):
932 if var.arg_conv_name is not None:
933 out_c = out_c + "\t\t." + var.arg_name + " = " + var.arg_conv_name + ",\n"
934 out_c = out_c + "\t\t.set_" + var.arg_name + " = NULL,\n"
936 out_c = out_c + "\t\t." + var.var_name + " = " + var.var_name + ",\n"
937 out_c = out_c + "\t\t.set_" + var.var_name + " = NULL,\n"
939 out_c += "\t\t." + var[1] + " = " + var[0] + "_init(env, clz, " + var[1]
940 for suparg in var[2]:
941 if isinstance(suparg, ConvInfo):
942 out_c = out_c + ", " + suparg.arg_name
944 out_c = out_c + ", " + suparg[1]
946 out_c = out_c + "\t};\n"
947 for var in flattened_field_vars:
948 if not isinstance(var, ConvInfo):
949 out_c = out_c + "\tcalls->" + var[1] + " = ret." + var[1] + ".this_arg;\n"
950 out_c = out_c + "\treturn ret;\n"
951 out_c = out_c + "}\n"
953 out_c = out_c + self.c_fn_ty_pfx + "int64_t " + self.c_fn_name_define_pfx(struct_name + "_new", True) + "jobject o"
954 for var in flattened_field_vars:
955 if isinstance(var, ConvInfo):
956 out_c = out_c + ", " + var.c_ty + " " + var.arg_name
958 out_c = out_c + ", jobject " + var[1]
959 out_c = out_c + ") {\n"
960 out_c = out_c + "\t" + struct_name + " *res_ptr = MALLOC(sizeof(" + struct_name + "), \"" + struct_name + "\");\n"
961 out_c = out_c + "\t*res_ptr = " + struct_name + "_init(env, clz, o"
962 for var in flattened_field_vars:
963 if isinstance(var, ConvInfo):
964 out_c = out_c + ", " + var.arg_name
966 out_c = out_c + ", " + var[1]
967 out_c = out_c + ");\n"
968 out_c = out_c + "\treturn (uint64_t)res_ptr;\n"
969 out_c = out_c + "}\n"
971 for var in flattened_field_vars:
972 if not isinstance(var, ConvInfo):
973 out_java_trait += "\n\t/**\n"
974 out_java_trait += "\t * Gets the underlying " + var[1] + ".\n"
975 out_java_trait += "\t */\n"
976 underscore_name = ''.join('_' + c.lower() if c.isupper() else c for c in var[1]).strip('_')
977 out_java_trait += "\tpublic " + var[1] + " get_" + underscore_name + "() {\n"
978 out_java_trait += "\t\t" + var[1] + " res = new " + var[1] + "(null, bindings." + struct_name + "_get_" + var[1] + "(this.ptr));\n"
979 out_java_trait += "\t\tthis.ptrs_to.add(res);\n"
980 out_java_trait += "\t\treturn res;\n"
981 out_java_trait += "\t}\n"
982 out_java_trait += "\n"
984 out_java += "\tpublic static native long " + struct_name + "_get_" + var[1] + "(long arg);\n"
986 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"
987 out_c += "\t" + struct_name + " *inp = (" + struct_name + " *)(arg & ~1);\n"
988 out_c += "\tuint64_t res_ptr = (uint64_t)&inp->" + var[1] + ";\n"
989 out_c += "\tDO_ASSERT((res_ptr & 1) == 0);\n"
990 out_c += "\treturn (int64_t)(res_ptr | 1);\n"
993 return (out_java, out_java_trait, out_c)
995 def trait_struct_inc_refcnt(self, ty_info):
996 base_conv = "\nif (" + ty_info.var_name + "_conv.free == " + ty_info.rust_obj + "_JCalls_free) {\n"
997 base_conv = base_conv + "\t// If this_arg is a JCalls struct, then we need to increment the refcnt in it.\n"
998 base_conv = base_conv + "\t" + ty_info.rust_obj + "_JCalls_cloned(&" + ty_info.var_name + "_conv);\n}"
1001 def map_complex_enum(self, struct_name, variant_list, camel_to_snake, enum_doc_comment):
1002 java_hu_type = struct_name.replace("LDK", "").replace("COption", "Option")
1007 out_java_enum += (self.hu_struct_file_prefix)
1008 out_java_enum += "\n/**\n * " + enum_doc_comment.replace("\n", "\n * ") + "\n */\n"
1009 out_java_enum += "@SuppressWarnings(\"unchecked\") // We correctly assign various generic arrays\n"
1010 out_java_enum += ("public class " + java_hu_type + " extends CommonBase {\n")
1011 out_java_enum += ("\tprivate " + java_hu_type + "(Object _dummy, long ptr) { super(ptr); }\n")
1012 out_java_enum += ("\t@Override @SuppressWarnings(\"deprecation\")\n")
1013 out_java_enum += ("\tprotected void finalize() throws Throwable {\n")
1014 out_java_enum += ("\t\tsuper.finalize();\n")
1015 out_java_enum += ("\t\tif (ptr != 0) { bindings." + struct_name.replace("LDK", "") + "_free(ptr); }\n")
1016 out_java_enum += ("\t}\n")
1017 out_java_enum += ("\tstatic " + java_hu_type + " constr_from_ptr(long ptr) {\n")
1018 out_java_enum += ("\t\tbindings." + struct_name + " raw_val = bindings." + struct_name + "_ref_from_ptr(ptr);\n")
1019 java_hu_subclasses = ""
1021 init_meth_jty_strs = {}
1023 out_java += ("\tpublic static class " + struct_name + " {\n")
1024 out_java += ("\t\tprivate " + struct_name + "() {}\n")
1025 for var in variant_list:
1026 out_java += ("\t\tpublic final static class " + var.var_name + " extends " + struct_name + " {\n")
1027 java_hu_subclasses = java_hu_subclasses + "\tpublic final static class " + var.var_name + " extends " + java_hu_type + " {\n"
1028 out_java_enum += ("\t\tif (raw_val.getClass() == bindings." + struct_name + "." + var.var_name + ".class) {\n")
1029 out_java_enum += ("\t\t\treturn new " + var.var_name + "(ptr, (bindings." + struct_name + "." + var.var_name + ")raw_val);\n")
1030 init_meth_jty_str = ""
1031 init_meth_params = ""
1034 for idx, (field_ty, field_docs) in enumerate(var.fields):
1036 init_meth_params = init_meth_params + ", "
1038 if field_ty.java_hu_ty == var.var_name:
1039 field_path = field_ty.java_fn_ty_arg.strip("L;").replace("/", ".")
1040 out_java += "\t\t\tpublic " + field_path + " " + field_ty.arg_name + ";\n"
1041 java_hu_subclasses = java_hu_subclasses + "\t\tpublic final " + field_path + " " + field_ty.arg_name + ";\n"
1042 init_meth_params = init_meth_params + field_path + " " + field_ty.arg_name
1044 out_java += "\t\t\tpublic " + field_ty.java_ty + " " + field_ty.arg_name + ";\n"
1045 if field_docs is not None:
1046 java_hu_subclasses += "\t\t/**\n\t\t * " + field_docs.replace("\n", "\n\t\t * ") + "\n\t\t*/\n"
1047 java_hu_subclasses += "\t\t"
1048 if field_ty.nullable:
1049 java_hu_subclasses += "@Nullable "
1050 java_hu_subclasses += "public final " + field_ty.java_hu_ty + " " + field_ty.arg_name + ";\n"
1051 init_meth_params = init_meth_params + field_ty.java_ty + " " + field_ty.arg_name
1052 init_meth_body = init_meth_body + "this." + field_ty.arg_name + " = " + field_ty.arg_name + "; "
1053 if field_ty.to_hu_conv is not None:
1054 hu_conv_body = hu_conv_body + "\t\t\t" + field_ty.java_ty + " " + field_ty.arg_name + " = obj." + field_ty.arg_name + ";\n"
1055 hu_conv_body = hu_conv_body + "\t\t\t" + field_ty.to_hu_conv.replace("\n", "\n\t\t\t") + "\n"
1056 hu_conv_body = hu_conv_body + "\t\t\tthis." + field_ty.arg_name + " = " + field_ty.to_hu_conv_name + ";\n"
1058 hu_conv_body = hu_conv_body + "\t\t\tthis." + field_ty.arg_name + " = obj." + field_ty.arg_name + ";\n"
1059 init_meth_jty_str = init_meth_jty_str + field_ty.java_fn_ty_arg
1060 out_java += ("\t\t\t" + var.var_name + "(" + init_meth_params + ") { ")
1061 out_java += (init_meth_body)
1063 out_java += ("\t\t}\n")
1064 out_java_enum += ("\t\t}\n")
1065 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"
1066 java_hu_subclasses = java_hu_subclasses + hu_conv_body
1067 java_hu_subclasses = java_hu_subclasses + "\t\t}\n\t}\n"
1068 init_meth_jty_strs[var.var_name] = init_meth_jty_str
1069 out_java += ("\t\tstatic native void init();\n")
1070 out_java += ("\t}\n")
1071 out_java_enum += ("\t\tassert false; return null; // Unreachable without extending the (internal) bindings interface\n\t}\n\n")
1072 out_java_enum += (java_hu_subclasses)
1073 out_java += ("\tstatic { " + struct_name + ".init(); }\n")
1074 out_java += ("\tpublic static native " + struct_name + " " + struct_name + "_ref_from_ptr(long ptr);\n");
1076 out_c += (self.c_complex_enum_pfx(struct_name, [x.var_name for x in variant_list], init_meth_jty_strs))
1078 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")
1079 out_c += ("\t" + struct_name + " *obj = (" + struct_name + "*)(ptr & ~1);\n")
1080 out_c += ("\tswitch(obj->tag) {\n")
1081 for var in variant_list:
1082 out_c += ("\t\tcase " + struct_name + "_" + var.var_name + ": {\n")
1084 for idx, (field_map, field_docs) in enumerate(var.fields):
1085 if field_map.ret_conv is not None:
1086 out_c += ("\t\t\t" + field_map.ret_conv[0].replace("\n", "\n\t\t\t"))
1087 if var.tuple_variant:
1088 out_c += "obj->" + camel_to_snake(var.var_name)
1090 out_c += "obj->" + camel_to_snake(var.var_name) + "." + field_map.arg_name
1091 out_c += (field_map.ret_conv[1].replace("\n", "\n\t\t\t") + "\n")
1092 c_params.append(field_map.ret_conv_name)
1094 if var.tuple_variant:
1095 c_params.append("obj->" + camel_to_snake(var.var_name))
1097 c_params.append("obj->" + camel_to_snake(var.var_name) + "." + field_map.arg_name)
1098 out_c += ("\t\t\treturn " + self.c_constr_native_complex_enum(struct_name, var.var_name, c_params) + ";\n")
1099 out_c += ("\t\t}\n")
1100 out_c += ("\t\tdefault: abort();\n")
1101 out_c += ("\t}\n}\n")
1102 return (out_java, out_java_enum, out_c)
1104 def map_opaque_struct(self, struct_name, struct_doc_comment):
1105 out_opaque_struct_human = ""
1106 out_opaque_struct_human += self.hu_struct_file_prefix
1107 out_opaque_struct_human += "\n/**\n * " + struct_doc_comment.replace("\n", "\n * ") + "\n */\n"
1108 out_opaque_struct_human += "@SuppressWarnings(\"unchecked\") // We correctly assign various generic arrays\n"
1109 out_opaque_struct_human += ("public class " + struct_name.replace("LDK","") + " extends CommonBase")
1110 if struct_name.startswith("LDKLocked"):
1111 out_opaque_struct_human += (" implements AutoCloseable")
1112 out_opaque_struct_human += (" {\n")
1113 out_opaque_struct_human += ("\t" + struct_name.replace("LDK", "") + "(Object _dummy, long ptr) { super(ptr); }\n")
1114 if struct_name.startswith("LDKLocked"):
1115 out_opaque_struct_human += ("\t@Override public void close() {\n")
1117 out_opaque_struct_human += ("\t@Override @SuppressWarnings(\"deprecation\")\n")
1118 out_opaque_struct_human += ("\tprotected void finalize() throws Throwable {\n")
1119 out_opaque_struct_human += ("\t\tsuper.finalize();\n")
1120 out_opaque_struct_human += ("\t\tif (ptr != 0) { bindings." + struct_name.replace("LDK","") + "_free(ptr); }\n")
1121 out_opaque_struct_human += ("\t}\n\n")
1122 return out_opaque_struct_human
1125 def map_function(self, argument_types, c_call_string, method_name, return_type_info, struct_meth, default_constructor_args, takes_self, takes_self_as_ref, args_known, type_mapping_generator, doc_comment):
1128 out_java_struct = None
1130 out_java += ("\tpublic static native ")
1131 out_c += (self.c_fn_ty_pfx)
1132 out_c += (return_type_info.c_ty)
1133 out_java += (return_type_info.java_ty)
1134 if return_type_info.ret_conv is not None:
1135 ret_conv_pfx, ret_conv_sfx = return_type_info.ret_conv
1136 out_java += (" " + method_name + "(")
1137 have_args = len(argument_types) > 1 or (len(argument_types) > 0 and argument_types[0].c_ty != "void")
1138 out_c += (" " + self.c_fn_name_define_pfx(method_name, have_args))
1140 for idx, arg_conv_info in enumerate(argument_types):
1144 if arg_conv_info.c_ty != "void":
1145 out_c += (arg_conv_info.c_ty + " " + arg_conv_info.arg_name)
1146 out_java += (arg_conv_info.java_ty + " " + arg_conv_info.arg_name)
1148 out_java_struct = ""
1150 out_java_struct += ("\t// Skipped " + method_name + "\n")
1152 meth_n = method_name[len(struct_meth) + 1 if len(struct_meth) != 0 else 0:].strip("_")
1153 if doc_comment is not None:
1154 out_java_struct += "\t/**\n\t * " + doc_comment.replace("\n", "\n\t * ") + "\n\t */\n"
1155 if return_type_info.nullable:
1156 out_java_struct += "\t@Nullable\n"
1159 out_java_struct += "\tpublic static " + return_type_info.java_hu_ty + " of("
1160 elif meth_n == "default":
1161 out_java_struct += "\tpublic static " + return_type_info.java_hu_ty + " with_default("
1163 out_java_struct += "\tpublic static " + return_type_info.java_hu_ty + " " + meth_n + "("
1165 out_java_struct += ("\tpublic " + return_type_info.java_hu_ty + " " + meth_n + "(")
1166 for idx, arg in enumerate(argument_types):
1168 if not takes_self or idx > 1:
1169 out_java_struct += ", "
1172 if arg.java_ty != "void":
1173 if arg.arg_name in default_constructor_args:
1174 assert not arg.nullable
1175 for explode_idx, explode_arg in enumerate(default_constructor_args[arg.arg_name]):
1176 if explode_idx != 0:
1177 out_java_struct += (", ")
1178 out_java_struct += (
1179 explode_arg.java_hu_ty + " " + arg.arg_name + "_" + explode_arg.arg_name)
1182 out_java_struct += "@Nullable "
1183 ty_string = arg.java_hu_ty
1184 if arg.java_fn_ty_arg[0] == "L" and arg.java_fn_ty_arg[len(arg.java_fn_ty_arg) - 1] == ";":
1185 ty_string = arg.java_fn_ty_arg.strip("L;").replace("/", ".")
1186 out_java_struct += ty_string + " " + arg.arg_name
1187 out_java += (");\n")
1189 if out_java_struct is not None:
1190 out_java_struct += (") {\n")
1191 for info in argument_types:
1192 if info.arg_conv is not None:
1193 out_c += ("\t" + info.arg_conv.replace('\n', "\n\t") + "\n")
1194 if return_type_info.ret_conv is not None:
1195 out_c += ("\t" + ret_conv_pfx.replace('\n', '\n\t'))
1196 elif return_type_info.c_ty != "void":
1197 out_c += ("\t" + return_type_info.c_ty + " ret_val = ")
1200 if c_call_string is None:
1201 out_c += (method_name + "(")
1203 out_c += (c_call_string)
1204 for idx, info in enumerate(argument_types):
1205 if info.arg_conv_name is not None:
1208 elif c_call_string is not None:
1210 out_c += (info.arg_conv_name)
1212 if return_type_info.ret_conv is not None:
1213 out_c += (ret_conv_sfx.replace('\n', '\n\t'))
1216 for info in argument_types:
1217 if info.arg_conv_cleanup is not None:
1218 out_c += ("\n\t" + info.arg_conv_cleanup.replace("\n", "\n\t"))
1219 if return_type_info.ret_conv is not None:
1220 out_c += ("\n\treturn " + return_type_info.ret_conv_name + ";")
1221 elif return_type_info.c_ty != "void":
1222 out_c += ("\n\treturn ret_val;")
1223 out_c += ("\n}\n\n")
1226 out_java_struct += ("\t\t")
1227 if return_type_info.java_ty != "void":
1228 out_java_struct += (return_type_info.java_ty + " ret = ")
1229 out_java_struct += ("bindings." + method_name + "(")
1230 for idx, info in enumerate(argument_types):
1232 out_java_struct += (", ")
1233 if idx == 0 and takes_self:
1234 out_java_struct += ("this.ptr")
1235 elif info.arg_name in default_constructor_args:
1236 out_java_struct += ("bindings." + info.java_hu_ty + "_new(")
1237 for explode_idx, explode_arg in enumerate(default_constructor_args[info.arg_name]):
1238 if explode_idx != 0:
1239 out_java_struct += (", ")
1240 expl_arg_name = info.arg_name + "_" + explode_arg.arg_name
1241 if explode_arg.from_hu_conv is not None:
1242 out_java_struct += (
1243 explode_arg.from_hu_conv[0].replace(explode_arg.arg_name, expl_arg_name))
1245 out_java_struct += (expl_arg_name)
1246 out_java_struct += (")")
1247 elif info.from_hu_conv is not None:
1248 out_java_struct += (info.from_hu_conv[0])
1250 out_java_struct += (info.arg_name)
1251 out_java_struct += (");\n")
1252 if return_type_info.java_ty == "long" and return_type_info.java_hu_ty != "long":
1253 out_java_struct += "\t\tif (ret < 1024) { return null; }\n"
1255 if return_type_info.to_hu_conv is not None:
1257 out_java_struct += ("\t\t" + return_type_info.to_hu_conv.replace("\n", "\n\t\t").replace("this",
1258 return_type_info.to_hu_conv_name) + "\n")
1260 out_java_struct += ("\t\t" + return_type_info.to_hu_conv.replace("\n", "\n\t\t") + "\n")
1262 for idx, info in enumerate(argument_types):
1263 if idx == 0 and takes_self:
1265 elif info.arg_name in default_constructor_args:
1266 for explode_arg in default_constructor_args[info.arg_name]:
1267 expl_arg_name = info.arg_name + "_" + explode_arg.arg_name
1268 if explode_arg.from_hu_conv is not None and return_type_info.to_hu_conv_name:
1269 out_java_struct += ("\t\t" + explode_arg.from_hu_conv[1].replace(explode_arg.arg_name,
1270 expl_arg_name).replace(
1271 "this", return_type_info.to_hu_conv_name) + ";\n")
1272 elif info.from_hu_conv is not None and info.from_hu_conv[1] != "":
1273 if not takes_self and return_type_info.to_hu_conv_name is not None:
1274 out_java_struct += (
1275 "\t\t" + info.from_hu_conv[1].replace("this", return_type_info.to_hu_conv_name).replace("\n", "\n\t\t") + ";\n")
1277 out_java_struct += ("\t\t" + info.from_hu_conv[1].replace("\n", "\n\t\t") + ";\n")
1279 if takes_self and not takes_self_as_ref:
1280 out_java_struct += "\t\t" + argument_types[0].from_hu_conv[1].replace("\n", "\n\t\t").replace("this_arg", "this") + ";\n"
1281 if return_type_info.to_hu_conv_name is not None:
1282 out_java_struct += ("\t\treturn " + return_type_info.to_hu_conv_name + ";\n")
1283 elif return_type_info.java_ty != "void" and return_type_info.rust_obj != "LDK" + struct_meth:
1284 out_java_struct += ("\t\treturn ret;\n")
1285 out_java_struct += ("\t}\n\n")
1287 return (out_java, out_c, out_java_struct)