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 _ignored) {
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 throw new IllegalArgumentException(e);
62 init(java.lang.Enum.class, VecOrSliceDef.class);
64 if (!get_lib_version_string().equals(get_ldk_java_bindings_version()))
65 throw new IllegalArgumentException("Compiled LDK library and LDK class failes do not match");
66 // Fetching the LDK versions from C also checks that the header and binaries match
67 get_ldk_c_bindings_version();
70 static native void init(java.lang.Class c, java.lang.Class slicedef);
71 static native void init_class_cache();
72 static native String get_lib_version_string();
74 public static String get_ldk_java_bindings_version() {
75 return "<git_version_ldk_garbagecollected>";
77 public static native String get_ldk_c_bindings_version();
78 public static native String get_ldk_version();
80 public static native boolean deref_bool(long ptr);
81 public static native long deref_long(long ptr);
82 public static native void free_heap_ptr(long ptr);
83 public static native byte[] read_bytes(long ptr, long len);
84 public static native byte[] get_u8_slice_bytes(long slice_ptr);
85 public static native long bytes_to_u8_vec(byte[] bytes);
86 public static native long new_txpointer_copy_data(byte[] txdata);
87 public static native void txpointer_free(long ptr);
88 public static native byte[] txpointer_get_buffer(long ptr);
89 public static native long vec_slice_len(long vec);
90 public static native long new_empty_slice_vec();
94 self.bindings_footer = "}\n"
96 self.util_fn_pfx = """package org.ldk.structs;
97 import org.ldk.impl.bindings;
98 import java.util.Arrays;
99 import javax.annotation.Nullable;
100 import org.ldk.enums.*;
102 public class UtilMethods {
104 self.util_fn_sfx = "}"
105 self.common_base = """package org.ldk.structs;
106 import java.util.LinkedList;
109 LinkedList<Object> ptrs_to = new LinkedList();
110 protected CommonBase(long ptr) { assert ptr > 1024; this.ptr = ptr; }
114 self.c_file_pfx = """#include <jni.h>
115 // On OSX jlong (ie long long) is not equivalent to int64_t, so we override here
116 #define int64_t jlong
117 #include \"org_ldk_impl_bindings.h\"
118 #include <lightning.h>
120 #include <stdatomic.h>
125 if self.target == Target.ANDROID:
126 self.c_file_pfx = self.c_file_pfx + """
127 #include <android/log.h>
128 #define DEBUG_PRINT(...) __android_log_print(ANDROID_LOG_ERROR, "LDK", __VA_ARGS__)
132 static void* redirect_stderr(void* ignored) {
135 dup2(pipes[1], STDERR_FILENO);
137 memset(buf, 0, 8192);
139 while ((len = read(pipes[0], buf, 8191)) > 0) {
140 DEBUG_PRINT("%s\\n", buf);
141 memset(buf, 0, 8192);
143 DEBUG_PRINT("End of stderr???\\n");
146 void __attribute__((constructor)) spawn_stderr_redirection() {
148 pthread_create(&thread, NULL, &redirect_stderr, NULL);
152 self.c_file_pfx = self.c_file_pfx + "#define DEBUG_PRINT(...) fprintf(stderr, __VA_ARGS__)\n"
154 if not DEBUG or sys.platform == "darwin":
155 self.c_file_pfx = self.c_file_pfx + """#define MALLOC(a, _) malloc(a)
156 #define FREE(p) if ((uint64_t)(p) > 1024) { free(p); }
159 self.c_file_pfx += """#define DO_ASSERT(a) (void)(a)
163 self.c_file_pfx = self.c_file_pfx + """#include <assert.h>
164 // Always run a, then assert it is true:
165 #define DO_ASSERT(a) do { bool _assert_val = (a); assert(_assert_val); } while(0)
166 // Assert a is true or do nothing
167 #define CHECK(a) DO_ASSERT(a)
169 void __attribute__((constructor)) debug_log_version() {
170 if (check_get_ldk_version() == NULL)
171 DEBUG_PRINT("LDK version did not match the header we built against\\n");
172 if (check_get_ldk_bindings_version() == NULL)
173 DEBUG_PRINT("LDK C Bindings version did not match the header we built against\\n");
174 DEBUG_PRINT("Loaded LDK-Java Bindings with LDK %s and LDK-C-Bindings %s\\n", check_get_ldk_version(), check_get_ldk_bindings_version());
178 if sys.platform != "darwin":
179 self.c_file_pfx += """
180 // Running a leak check across all the allocations and frees of the JDK is a mess,
181 // so instead we implement our own naive leak checker here, relying on the -wrap
182 // linker option to wrap malloc/calloc/realloc/free, tracking everyhing allocated
183 // and free'd in Rust or C across the generated bindings shared library.
187 if self.target == Target.ANDROID:
188 self.c_file_pfx = self.c_file_pfx + """
192 // Implement the execinfo functions using _Unwind_backtrace. This seems to miss many Rust
193 // symbols, so we only use it on Android, where execinfo.h is unavailable.
195 struct BacktraceState {
199 static _Unwind_Reason_Code unwind_callback(struct _Unwind_Context* context, void* arg) {
200 struct BacktraceState* state = (struct BacktraceState*)arg;
201 uintptr_t pc = _Unwind_GetIP(context);
203 if (state->current == state->end) {
204 return _URC_END_OF_STACK;
206 *state->current++ = (void*)(pc);
209 return _URC_NO_REASON;
212 int backtrace(void** buffer, int max) {
213 struct BacktraceState state = { buffer, buffer + max };
214 _Unwind_Backtrace(unwind_callback, &state);
215 return state.current - buffer;
218 void backtrace_symbols_fd(void ** buffer, int count, int _fd) {
219 for (int idx = 0; idx < count; ++idx) {
221 if (dladdr(buffer[idx], &info) && info.dli_sname) {
222 DEBUG_PRINT("%p: %s", buffer[idx], info.dli_sname);
224 DEBUG_PRINT("%p: ???", buffer[idx]);
230 self.c_file_pfx = self.c_file_pfx + "#include <execinfo.h>\n"
231 self.c_file_pfx = self.c_file_pfx + """
233 static mtx_t allocation_mtx;
235 void __attribute__((constructor)) init_mtx() {
236 DO_ASSERT(mtx_init(&allocation_mtx, mtx_plain) == thrd_success);
240 typedef struct allocation {
241 struct allocation* next;
243 const char* struct_name;
246 unsigned long alloc_len;
248 static allocation* allocation_ll = NULL;
250 void* __real_malloc(size_t len);
251 void* __real_calloc(size_t nmemb, size_t len);
252 static void new_allocation(void* res, const char* struct_name, size_t len) {
253 allocation* new_alloc = __real_malloc(sizeof(allocation));
254 new_alloc->ptr = res;
255 new_alloc->struct_name = struct_name;
256 new_alloc->bt_len = backtrace(new_alloc->bt, BT_MAX);
257 new_alloc->alloc_len = len;
258 DO_ASSERT(mtx_lock(&allocation_mtx) == thrd_success);
259 new_alloc->next = allocation_ll;
260 allocation_ll = new_alloc;
261 DO_ASSERT(mtx_unlock(&allocation_mtx) == thrd_success);
263 static void* MALLOC(size_t len, const char* struct_name) {
264 void* res = __real_malloc(len);
265 new_allocation(res, struct_name, len);
268 void __real_free(void* ptr);
269 static void alloc_freed(void* ptr) {
270 allocation* p = NULL;
271 DO_ASSERT(mtx_lock(&allocation_mtx) == thrd_success);
272 allocation* it = allocation_ll;
273 while (it->ptr != ptr) {
274 p = it; it = it->next;
276 DEBUG_PRINT("Tried to free unknown pointer %p at:\\n", ptr);
278 int bt_len = backtrace(bt, BT_MAX);
279 backtrace_symbols_fd(bt, bt_len, STDERR_FILENO);
280 DEBUG_PRINT("\\n\\n");
281 DO_ASSERT(mtx_unlock(&allocation_mtx) == thrd_success);
282 return; // addrsan should catch malloc-unknown and print more info than we have
285 if (p) { p->next = it->next; } else { allocation_ll = it->next; }
286 DO_ASSERT(mtx_unlock(&allocation_mtx) == thrd_success);
287 DO_ASSERT(it->ptr == ptr);
290 static void FREE(void* ptr) {
291 if ((uint64_t)ptr < 1024) return; // Rust loves to create pointers to the NULL page for dummys
296 void* __wrap_malloc(size_t len) {
297 void* res = __real_malloc(len);
298 new_allocation(res, "malloc call", len);
301 void* __wrap_calloc(size_t nmemb, size_t len) {
302 void* res = __real_calloc(nmemb, len);
303 new_allocation(res, "calloc call", len);
306 void __wrap_free(void* ptr) {
307 if (ptr == NULL) return;
312 void* __real_realloc(void* ptr, size_t newlen);
313 void* __wrap_realloc(void* ptr, size_t len) {
314 if (ptr != NULL) alloc_freed(ptr);
315 void* res = __real_realloc(ptr, len);
316 new_allocation(res, "realloc call", len);
319 void __wrap_reallocarray(void* ptr, size_t new_sz) {
320 // Rust doesn't seem to use reallocarray currently
324 void __attribute__((destructor)) check_leaks() {
325 unsigned long alloc_count = 0;
326 unsigned long alloc_size = 0;
327 DEBUG_PRINT("The following LDK-allocated blocks still remain.\\n");
328 DEBUG_PRINT("Note that this is only accurate if System.gc(); System.runFinalization()\\n");
329 DEBUG_PRINT("was called prior to exit after all LDK objects were out of scope.\\n");
330 for (allocation* a = allocation_ll; a != NULL; a = a->next) {
331 DEBUG_PRINT("%s %p (%lu bytes) remains:\\n", a->struct_name, a->ptr, a->alloc_len);
332 backtrace_symbols_fd(a->bt, a->bt_len, STDERR_FILENO);
333 DEBUG_PRINT("\\n\\n");
335 alloc_size += a->alloc_len;
337 DEBUG_PRINT("%lu allocations remained for %lu bytes.\\n", alloc_count, alloc_size);
338 DEBUG_PRINT("Note that this is only accurate if System.gc(); System.runFinalization()\\n");
339 DEBUG_PRINT("was called prior to exit after all LDK objects were out of scope.\\n");
342 self.c_file_pfx = self.c_file_pfx + """
343 static jmethodID ordinal_meth = NULL;
344 static jmethodID slicedef_meth = NULL;
345 static jclass slicedef_cls = NULL;
346 JNIEXPORT void Java_org_ldk_impl_bindings_init(JNIEnv * env, jclass _b, jclass enum_class, jclass slicedef_class) {
347 ordinal_meth = (*env)->GetMethodID(env, enum_class, "ordinal", "()I");
348 CHECK(ordinal_meth != NULL);
349 slicedef_meth = (*env)->GetMethodID(env, slicedef_class, "<init>", "(JJJ)V");
350 CHECK(slicedef_meth != NULL);
351 slicedef_cls = (*env)->NewGlobalRef(env, slicedef_class);
352 CHECK(slicedef_cls != NULL);
355 JNIEXPORT jboolean JNICALL Java_org_ldk_impl_bindings_deref_1bool (JNIEnv * env, jclass _a, jlong ptr) {
356 return *((bool*)ptr);
358 JNIEXPORT jlong JNICALL Java_org_ldk_impl_bindings_deref_1long (JNIEnv * env, jclass _a, jlong ptr) {
359 return *((long*)ptr);
361 JNIEXPORT void JNICALL Java_org_ldk_impl_bindings_free_1heap_1ptr (JNIEnv * env, jclass _a, jlong ptr) {
364 JNIEXPORT jbyteArray JNICALL Java_org_ldk_impl_bindings_read_1bytes (JNIEnv * env, jclass _b, jlong ptr, jlong len) {
365 jbyteArray ret_arr = (*env)->NewByteArray(env, len);
366 (*env)->SetByteArrayRegion(env, ret_arr, 0, len, (unsigned char*)ptr);
369 JNIEXPORT jbyteArray JNICALL Java_org_ldk_impl_bindings_get_1u8_1slice_1bytes (JNIEnv * env, jclass _b, jlong slice_ptr) {
370 LDKu8slice *slice = (LDKu8slice*)slice_ptr;
371 jbyteArray ret_arr = (*env)->NewByteArray(env, slice->datalen);
372 (*env)->SetByteArrayRegion(env, ret_arr, 0, slice->datalen, slice->data);
375 JNIEXPORT int64_t impl_bindings_bytes_1to_1u8_1vec (JNIEnv * env, jclass _b, jbyteArray bytes) {
376 LDKCVec_u8Z *vec = (LDKCVec_u8Z*)MALLOC(sizeof(LDKCVec_u8Z), "LDKCVec_u8");
377 vec->datalen = (*env)->GetArrayLength(env, bytes);
378 vec->data = (uint8_t*)MALLOC(vec->datalen, "LDKCVec_u8Z Bytes");
379 (*env)->GetByteArrayRegion (env, bytes, 0, vec->datalen, vec->data);
380 return (uint64_t)vec;
382 JNIEXPORT jbyteArray JNICALL Java_org_ldk_impl_bindings_txpointer_1get_1buffer (JNIEnv * env, jclass _b, jlong ptr) {
383 LDKTransaction *txdata = (LDKTransaction*)ptr;
385 slice.data = txdata->data;
386 slice.datalen = txdata->datalen;
387 return Java_org_ldk_impl_bindings_get_1u8_1slice_1bytes(env, _b, (uint64_t)&slice);
389 JNIEXPORT int64_t JNICALL Java_org_ldk_impl_bindings_new_1txpointer_1copy_1data (JNIEnv * env, jclass _b, jbyteArray bytes) {
390 LDKTransaction *txdata = (LDKTransaction*)MALLOC(sizeof(LDKTransaction), "LDKTransaction");
391 txdata->datalen = (*env)->GetArrayLength(env, bytes);
392 txdata->data = (uint8_t*)MALLOC(txdata->datalen, "Tx Data Bytes");
393 txdata->data_is_owned = false;
394 (*env)->GetByteArrayRegion (env, bytes, 0, txdata->datalen, txdata->data);
395 return (uint64_t)txdata;
397 JNIEXPORT void JNICALL Java_org_ldk_impl_bindings_txpointer_1free (JNIEnv * env, jclass _b, jlong ptr) {
398 LDKTransaction *tx = (LDKTransaction*)ptr;
399 tx->data_is_owned = true;
400 Transaction_free(*tx);
403 JNIEXPORT jlong JNICALL Java_org_ldk_impl_bindings_vec_1slice_1len (JNIEnv * env, jclass _a, jlong ptr) {
404 // Check offsets of a few Vec types are all consistent as we're meant to be generic across types
405 _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKCVec_SignatureZ, datalen), "Vec<*> needs to be mapped identically");
406 _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKCVec_MessageSendEventZ, datalen), "Vec<*> needs to be mapped identically");
407 _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKCVec_EventZ, datalen), "Vec<*> needs to be mapped identically");
408 _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKCVec_C2Tuple_usizeTransactionZZ, datalen), "Vec<*> needs to be mapped identically");
409 LDKCVec_u8Z *vec = (LDKCVec_u8Z*)ptr;
410 return (uint64_t)vec->datalen;
412 JNIEXPORT int64_t JNICALL Java_org_ldk_impl_bindings_new_1empty_1slice_1vec (JNIEnv * env, jclass _b) {
413 // Check sizes of a few Vec types are all consistent as we're meant to be generic across types
414 _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKCVec_SignatureZ), "Vec<*> needs to be mapped identically");
415 _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKCVec_MessageSendEventZ), "Vec<*> needs to be mapped identically");
416 _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKCVec_EventZ), "Vec<*> needs to be mapped identically");
417 _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKCVec_C2Tuple_usizeTransactionZZ), "Vec<*> needs to be mapped identically");
418 LDKCVec_u8Z *vec = (LDKCVec_u8Z*)MALLOC(sizeof(LDKCVec_u8Z), "Empty LDKCVec");
421 return (uint64_t)vec;
424 // We assume that CVec_u8Z and u8slice are the same size and layout (and thus pointers to the two can be mixed)
425 _Static_assert(sizeof(LDKCVec_u8Z) == sizeof(LDKu8slice), "Vec<u8> and [u8] need to have been mapped identically");
426 _Static_assert(offsetof(LDKCVec_u8Z, data) == offsetof(LDKu8slice, data), "Vec<u8> and [u8] need to have been mapped identically");
427 _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKu8slice, datalen), "Vec<u8> and [u8] need to have been mapped identically");
429 _Static_assert(sizeof(jlong) == sizeof(int64_t), "We assume that j-types are the same as C types");
430 _Static_assert(sizeof(jbyte) == sizeof(char), "We assume that j-types are the same as C types");
431 _Static_assert(sizeof(void*) <= 8, "Pointers must fit into 64 bits");
433 typedef jlongArray int64_tArray;
434 typedef jbyteArray int8_tArray;
436 static inline jstring str_ref_to_java(JNIEnv *env, const char* chars, size_t len) {
437 // Sadly we need to create a temporary because Java can't accept a char* without a 0-terminator
438 char* conv_buf = MALLOC(len + 1, "str conv buf");
439 memcpy(conv_buf, chars, len);
441 jstring ret = (*env)->NewStringUTF(env, conv_buf);
445 static inline LDKStr java_to_owned_str(JNIEnv *env, jstring str) {
446 uint64_t str_len = (*env)->GetStringUTFLength(env, str);
447 char* newchars = MALLOC(str_len + 1, "String chars");
448 const char* jchars = (*env)->GetStringUTFChars(env, str, NULL);
449 memcpy(newchars, jchars, str_len);
450 newchars[str_len] = 0;
451 (*env)->ReleaseStringUTFChars(env, str, jchars);
455 .chars_is_owned = true
460 JNIEXPORT jstring JNICALL Java_org_ldk_impl_bindings_get_1lib_1version_1string(JNIEnv *env, jclass _c) {
461 return str_ref_to_java(env, "<git_version_ldk_garbagecollected>", strlen("<git_version_ldk_garbagecollected>"));
463 JNIEXPORT jstring JNICALL Java_org_ldk_impl_bindings_get_1ldk_1c_1bindings_1version(JNIEnv *env, jclass _c) {
464 return str_ref_to_java(env, check_get_ldk_bindings_version(), strlen(check_get_ldk_bindings_version()));
466 JNIEXPORT jstring JNICALL Java_org_ldk_impl_bindings_get_1ldk_1version(JNIEnv *env, jclass _c) {
467 return str_ref_to_java(env, check_get_ldk_version(), strlen(check_get_ldk_version()));
471 self.hu_struct_file_prefix = """package org.ldk.structs;
473 import org.ldk.impl.bindings;
474 import org.ldk.enums.*;
475 import org.ldk.util.*;
476 import java.util.Arrays;
477 import javax.annotation.Nullable;
480 self.c_fn_ty_pfx = "JNIEXPORT "
481 self.c_fn_args_pfx = "JNIEnv *env, jclass clz"
482 self.file_ext = ".java"
483 self.ptr_c_ty = "int64_t"
484 self.ptr_native_ty = "long"
485 self.result_c_ty = "jclass"
486 self.ptr_arr = "jobjectArray"
487 self.is_arr_some_check = ("", " != NULL")
488 self.get_native_arr_len_call = ("(*env)->GetArrayLength(env, ", ")")
490 def construct_jenv(self):
491 res = "JNIEnv *env;\n"
492 res += "jint get_jenv_res = (*j_calls->vm)->GetEnv(j_calls->vm, (void**)&env, JNI_VERSION_1_6);\n"
493 res += "if (get_jenv_res == JNI_EDETACHED) {\n"
494 if self.target == Target.ANDROID:
495 res += "\tDO_ASSERT((*j_calls->vm)->AttachCurrentThread(j_calls->vm, &env, NULL) == JNI_OK);\n"
497 res += "\tDO_ASSERT((*j_calls->vm)->AttachCurrentThread(j_calls->vm, (void**)&env, NULL) == JNI_OK);\n"
499 res += "\tDO_ASSERT(get_jenv_res == JNI_OK);\n"
502 def deconstruct_jenv(self):
503 res = "if (get_jenv_res == JNI_EDETACHED) {\n"
504 res += "\tDO_ASSERT((*j_calls->vm)->DetachCurrentThread(j_calls->vm) == JNI_OK);\n"
508 def release_native_arr_ptr_call(self, ty_info, arr_var, arr_ptr_var):
509 if ty_info.subty is None or not ty_info.subty.c_ty.endswith("Array"):
510 return "(*env)->ReleasePrimitiveArrayCritical(env, " + arr_var + ", " + arr_ptr_var + ", 0)"
512 def create_native_arr_call(self, arr_len, ty_info):
513 if ty_info.c_ty == "int8_tArray":
514 return "(*env)->NewByteArray(env, " + arr_len + ")"
515 elif ty_info.subty.c_ty.endswith("Array"):
516 clz_var = ty_info.java_fn_ty_arg[1:].replace("[", "arr_of_")
517 self.c_array_class_caches.add(clz_var)
518 return "(*env)->NewObjectArray(env, " + arr_len + ", " + clz_var + "_clz, NULL);\n"
520 return "(*env)->New" + ty_info.java_ty.strip("[]").title() + "Array(env, " + arr_len + ")"
521 def set_native_arr_contents(self, arr_name, arr_len, ty_info):
522 if ty_info.c_ty == "int8_tArray":
523 return ("(*env)->SetByteArrayRegion(env, " + arr_name + ", 0, " + arr_len + ", ", ")")
526 def get_native_arr_contents(self, arr_name, dest_name, arr_len, ty_info, copy):
527 if ty_info.c_ty == "int8_tArray":
529 return "(*env)->GetByteArrayRegion(env, " + arr_name + ", 0, " + arr_len + ", " + dest_name + ")"
531 return "(*env)->GetByteArrayElements (env, " + arr_name + ", NULL)"
532 elif not ty_info.java_ty[:len(ty_info.java_ty) - 2].endswith("[]"):
533 return "(*env)->Get" + ty_info.subty.java_ty.title() + "ArrayElements (env, " + arr_name + ", NULL)"
536 def get_native_arr_elem(self, arr_name, idxc, ty_info):
537 if self.get_native_arr_contents(arr_name, "", "", ty_info, False) is None:
538 return "(*env)->GetObjectArrayElement(env, " + arr_name + ", " + idxc + ")"
540 assert False # Only called if above is None
541 def get_native_arr_ptr_call(self, ty_info):
542 if ty_info.subty is not None and ty_info.subty.c_ty.endswith("Array"):
544 return ("(*env)->GetPrimitiveArrayCritical(env, ", ", NULL)")
545 def get_native_arr_entry_call(self, ty_info, arr_name, idxc, entry_access):
546 if ty_info.subty is None or not ty_info.subty.c_ty.endswith("Array"):
548 return "(*env)->SetObjectArrayElement(env, " + arr_name + ", " + idxc + ", " + entry_access + ")"
549 def cleanup_native_arr_ref_contents(self, arr_name, dest_name, arr_len, ty_info):
550 if ty_info.c_ty == "int8_tArray":
551 return "(*env)->ReleaseByteArrayElements(env, " + arr_name + ", (int8_t*)" + dest_name + ", 0);"
553 return "(*env)->Release" + ty_info.java_ty.strip("[]").title() + "ArrayElements(env, " + arr_name + ", " + dest_name + ", 0)"
555 def str_ref_to_native_call(self, var_name, str_len):
556 return "str_ref_to_java(env, " + var_name + ", " + str_len + ")"
557 def str_ref_to_c_call(self, var_name):
558 return "java_to_owned_str(env, " + var_name + ")"
560 def c_fn_name_define_pfx(self, fn_name, has_args):
562 return "JNICALL Java_org_ldk_impl_bindings_" + fn_name.replace("_", "_1") + "(JNIEnv *env, jclass clz, "
563 return "JNICALL Java_org_ldk_impl_bindings_" + fn_name.replace("_", "_1") + "(JNIEnv *env, jclass clz"
567 for ty in sorted(self.c_array_class_caches):
568 res = res + "static jclass " + ty + "_clz = NULL;\n"
569 res = res + "JNIEXPORT void Java_org_ldk_impl_bindings_init_1class_1cache(JNIEnv * env, jclass clz) {\n"
570 for ty in sorted(self.c_array_class_caches):
571 res = res + "\t" + ty + "_clz = (*env)->FindClass(env, \"" + ty.replace("arr_of_", "[") + "\");\n"
572 res = res + "\tCHECK(" + ty + "_clz != NULL);\n"
573 res = res + "\t" + ty + "_clz = (*env)->NewGlobalRef(env, " + ty + "_clz);\n"
577 def native_c_unitary_enum_map(self, struct_name, variants, enum_doc_comment):
578 out_java_enum = "package org.ldk.enums;\n\n"
581 out_c = out_c + "static inline LDK" + struct_name + " LDK" + struct_name + "_from_java(" + self.c_fn_args_pfx + ") {\n"
582 out_c = out_c + "\tswitch ((*env)->CallIntMethod(env, clz, ordinal_meth)) {\n"
584 if enum_doc_comment is not None:
585 out_java_enum += "/**\n * " + enum_doc_comment.replace("\n", "\n * ") + "\n */\n"
586 out_java_enum += "public enum " + struct_name + " {\n"
589 out_java_enum = out_java_enum + "\t" + var + ",\n"
590 out_c = out_c + "\t\tcase %d: return %s;\n" % (ord_v, var)
592 out_java_enum = out_java_enum + "\t; static native void init();\n"
593 out_java_enum = out_java_enum + "\tstatic { init(); }\n"
594 out_java_enum = out_java_enum + "}"
595 out_java = out_java + "\tstatic { " + struct_name + ".values(); /* Force enum statics to run */ }\n"
596 out_c = out_c + "\t}\n"
597 out_c = out_c + "\tabort();\n"
598 out_c = out_c + "}\n"
600 out_c = out_c + "static jclass " + struct_name + "_class = NULL;\n"
602 out_c = out_c + "static jfieldID " + struct_name + "_" + var + " = NULL;\n"
603 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"
604 out_c = out_c + "\t" + struct_name + "_class = (*env)->NewGlobalRef(env, clz);\n"
605 out_c = out_c + "\tCHECK(" + struct_name + "_class != NULL);\n"
607 out_c = out_c + "\t" + struct_name + "_" + var + " = (*env)->GetStaticFieldID(env, " + struct_name + "_class, \"" + var + "\", \"Lorg/ldk/enums/" + struct_name + ";\");\n"
608 out_c = out_c + "\tCHECK(" + struct_name + "_" + var + " != NULL);\n"
609 out_c = out_c + "}\n"
610 out_c = out_c + "static inline jclass LDK" + struct_name + "_to_java(JNIEnv *env, LDK" + struct_name + " val) {\n"
611 out_c = out_c + "\tswitch (val) {\n"
614 out_c = out_c + "\t\tcase " + var + ":\n"
615 out_c = out_c + "\t\t\treturn (*env)->GetStaticObjectField(env, " + struct_name + "_class, " + struct_name + "_" + var + ");\n"
617 out_c = out_c + "\t\tdefault: abort();\n"
618 out_c = out_c + "\t}\n"
619 out_c = out_c + "}\n\n"
621 return (out_c, out_java_enum, out_java)
623 def c_unitary_enum_to_native_call(self, ty_info):
624 return (ty_info.rust_obj + "_to_java(env, ", ")")
625 def native_unitary_enum_to_c_call(self, ty_info):
626 return (ty_info.rust_obj + "_from_java(env, ", ")")
628 def c_complex_enum_pfx(self, struct_name, variants, init_meth_jty_strs):
631 out_c = out_c + "static jclass " + struct_name + "_" + var + "_class = NULL;\n"
632 out_c = out_c + "static jmethodID " + struct_name + "_" + var + "_meth = NULL;\n"
633 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"
634 for var_name in variants:
635 out_c = out_c + "\t" + struct_name + "_" + var_name + "_class =\n"
636 if self.target == Target.ANDROID:
637 out_c = out_c + "\t\t(*env)->NewGlobalRef(env, (*env)->FindClass(env, \"org/ldk/impl/bindings$" + struct_name + "$" + var_name + "\"));\n"
639 out_c = out_c + "\t\t(*env)->NewGlobalRef(env, (*env)->FindClass(env, \"Lorg/ldk/impl/bindings$" + struct_name + "$" + var_name + ";\"));\n"
640 out_c = out_c + "\tCHECK(" + struct_name + "_" + var_name + "_class != NULL);\n"
641 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"
642 out_c = out_c + "\tCHECK(" + struct_name + "_" + var_name + "_meth != NULL);\n"
643 out_c = out_c + "}\n"
646 def c_complex_enum_pass_ty(self, struct_name):
649 def c_constr_native_complex_enum(self, struct_name, variant, c_params):
650 ret = "(*env)->NewObject(env, " + struct_name + "_" + variant + "_class, " + struct_name + "_" + variant + "_meth"
651 for param in c_params:
652 ret = ret + ", " + param
655 def native_c_map_trait(self, struct_name, field_vars, flattened_field_vars, field_fns, trait_doc_comment):
659 # First generate most of the Java code, note that we need information about java method argument strings for C
660 out_java_trait = out_java_trait + self.hu_struct_file_prefix
661 if trait_doc_comment is not None:
662 out_java_trait += "/**\n * " + trait_doc_comment.replace("\n", "\n * ") + "\n */\n"
663 out_java_trait += "@SuppressWarnings(\"unchecked\") // We correctly assign various generic arrays\n"
664 out_java_trait = out_java_trait + "public class " + struct_name.replace("LDK","") + " extends CommonBase {\n"
665 out_java_trait = out_java_trait + "\tfinal bindings." + struct_name + " bindings_instance;\n"
666 out_java_trait = out_java_trait + "\t" + struct_name.replace("LDK", "") + "(Object _dummy, long ptr) { super(ptr); bindings_instance = null; }\n"
667 out_java_trait = out_java_trait + "\tprivate " + struct_name.replace("LDK", "") + "(bindings." + struct_name + " arg"
668 for var in flattened_field_vars:
669 if isinstance(var, ConvInfo):
670 out_java_trait = out_java_trait + ", " + var.java_hu_ty + " " + var.arg_name
672 out_java_trait = out_java_trait + ", bindings." + var[0] + " " + var[1]
673 out_java_trait = out_java_trait + ") {\n"
674 out_java_trait = out_java_trait + "\t\tsuper(bindings." + struct_name + "_new(arg"
675 for var in flattened_field_vars:
676 if isinstance(var, ConvInfo):
677 if var.from_hu_conv is not None:
678 out_java_trait = out_java_trait + ", " + var.from_hu_conv[0]
680 out_java_trait = out_java_trait + ", " + var.arg_name
682 out_java_trait = out_java_trait + ", " + var[1]
683 out_java_trait = out_java_trait + "));\n"
684 out_java_trait = out_java_trait + "\t\tthis.ptrs_to.add(arg);\n"
685 for var in flattened_field_vars:
686 if isinstance(var, ConvInfo):
687 if var.from_hu_conv is not None and var.from_hu_conv[1] != "":
688 out_java_trait = out_java_trait + "\t\t" + var.from_hu_conv[1].replace("\n", "\n\t\t") + ";\n"
690 out_java_trait = out_java_trait + "\t\tthis.ptrs_to.add(" + var[1] + ");\n"
691 out_java_trait = out_java_trait + "\t\tthis.bindings_instance = arg;\n"
692 out_java_trait = out_java_trait + "\t}\n"
693 out_java_trait = out_java_trait + "\t@Override @SuppressWarnings(\"deprecation\")\n"
694 out_java_trait = out_java_trait + "\tprotected void finalize() throws Throwable {\n"
695 out_java_trait = out_java_trait + "\t\tif (ptr != 0) { bindings." + struct_name.replace("LDK","") + "_free(ptr); } super.finalize();\n"
696 out_java_trait = out_java_trait + "\t}\n\n"
698 java_trait_constr = "\tprivate static class " + struct_name + "Holder { " + struct_name.replace("LDK", "") + " held; }\n"
699 java_trait_constr = java_trait_constr + "\tpublic static " + struct_name.replace("LDK", "") + " new_impl(" + struct_name.replace("LDK", "") + "Interface arg"
700 for var in flattened_field_vars:
701 if isinstance(var, ConvInfo):
702 java_trait_constr = java_trait_constr + ", " + var.java_hu_ty + " " + var.arg_name
704 # Ideally we'd be able to take any instance of the interface, but our C code can only represent
705 # Java-implemented version, so we require users pass a Java implementation here :/
706 java_trait_constr = java_trait_constr + ", " + var[0].replace("LDK", "") + "." + var[0].replace("LDK", "") + "Interface " + var[1] + "_impl"
707 java_trait_constr = java_trait_constr + ") {\n\t\tfinal " + struct_name + "Holder impl_holder = new " + struct_name + "Holder();\n"
708 java_trait_constr = java_trait_constr + "\t\timpl_holder.held = new " + struct_name.replace("LDK", "") + "(new bindings." + struct_name + "() {\n"
709 out_java_trait = out_java_trait + "\tpublic static interface " + struct_name.replace("LDK", "") + "Interface {\n"
710 out_java = out_java + "\tpublic interface " + struct_name + " {\n"
712 for fn_line in field_fns:
713 java_meth_descr = "("
714 if fn_line.fn_name != "free" and fn_line.fn_name != "cloned":
715 out_java = out_java + "\t\t " + fn_line.ret_ty_info.java_ty + " " + fn_line.fn_name + "("
716 java_trait_constr = java_trait_constr + "\t\t\t@Override public " + fn_line.ret_ty_info.java_ty + " " + fn_line.fn_name + "("
717 out_java_trait += "\t\t/**\n\t\t * " + fn_line.docs.replace("\n", "\n\t\t * ") + "\n\t\t */\n"
718 out_java_trait = out_java_trait + "\t\t" + fn_line.ret_ty_info.java_hu_ty + " " + fn_line.fn_name + "("
720 for idx, arg_conv_info in enumerate(fn_line.args_ty):
722 out_java = out_java + ", "
723 java_trait_constr = java_trait_constr + ", "
724 out_java_trait = out_java_trait + ", "
725 out_java = out_java + arg_conv_info.java_ty + " " + arg_conv_info.arg_name
726 out_java_trait = out_java_trait + arg_conv_info.java_hu_ty + " " + arg_conv_info.arg_name
727 java_trait_constr = java_trait_constr + arg_conv_info.java_ty + " " + arg_conv_info.arg_name
728 java_meth_descr = java_meth_descr + arg_conv_info.java_fn_ty_arg
729 java_meth_descr = java_meth_descr + ")" + fn_line.ret_ty_info.java_fn_ty_arg
730 java_meths.append((fn_line.fn_name, java_meth_descr))
732 out_java = out_java + ");\n"
733 out_java_trait = out_java_trait + ");\n"
734 java_trait_constr = java_trait_constr + ") {\n"
736 for arg_info in fn_line.args_ty:
737 if arg_info.to_hu_conv is not None:
738 java_trait_constr = java_trait_constr + "\t\t\t\t" + arg_info.to_hu_conv.replace("\n", "\n\t\t\t\t") + "\n"
740 if fn_line.ret_ty_info.java_ty != "void":
741 java_trait_constr = java_trait_constr + "\t\t\t\t" + fn_line.ret_ty_info.java_hu_ty + " ret = arg." + fn_line.fn_name + "("
743 java_trait_constr = java_trait_constr + "\t\t\t\targ." + fn_line.fn_name + "("
745 for idx, arg_info in enumerate(fn_line.args_ty):
747 java_trait_constr = java_trait_constr + ", "
748 if arg_info.to_hu_conv_name is not None:
749 java_trait_constr = java_trait_constr + arg_info.to_hu_conv_name
751 java_trait_constr = java_trait_constr + arg_info.arg_name
753 java_trait_constr = java_trait_constr + ");\n"
754 if fn_line.ret_ty_info.java_ty != "void":
755 if fn_line.ret_ty_info.from_hu_conv is not None:
756 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"
757 if fn_line.ret_ty_info.from_hu_conv[1] != "":
758 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"
759 #if fn_line.ret_ty_info.rust_obj in result_types:
760 java_trait_constr = java_trait_constr + "\t\t\t\treturn result;\n"
762 java_trait_constr = java_trait_constr + "\t\t\t\treturn ret;\n"
763 java_trait_constr = java_trait_constr + "\t\t\t}\n"
764 java_trait_constr = java_trait_constr + "\t\t}"
765 for var in field_vars:
766 if isinstance(var, ConvInfo):
767 java_trait_constr = java_trait_constr + ", " + var.arg_name
769 java_trait_constr += ", " + var[1] + ".new_impl(" + var[1] + "_impl"
770 for suparg in var[2]:
771 if isinstance(suparg, ConvInfo):
772 java_trait_constr += ", " + suparg.arg_name
774 java_trait_constr += ", " + suparg[1]
775 java_trait_constr += ").bindings_instance"
776 for suparg in var[2]:
777 if isinstance(suparg, ConvInfo):
778 java_trait_constr += ", " + suparg.arg_name
780 java_trait_constr += ", " + suparg[1]
781 out_java_trait = out_java_trait + "\t}\n"
782 out_java_trait = out_java_trait + java_trait_constr + ");\n\t\treturn impl_holder.held;\n\t}\n"
784 out_java = out_java + "\t}\n"
786 out_java = out_java + "\tpublic static native long " + struct_name + "_new(" + struct_name + " impl"
787 for var in flattened_field_vars:
788 if isinstance(var, ConvInfo):
789 out_java = out_java + ", " + var.java_ty + " " + var.arg_name
791 out_java = out_java + ", " + var[0] + " " + var[1]
792 out_java = out_java + ");\n"
794 # Now that we've written out our java code (and created java_meths), generate C
795 out_c = "typedef struct " + struct_name + "_JCalls {\n"
796 out_c = out_c + "\tatomic_size_t refcnt;\n"
797 out_c = out_c + "\tJavaVM *vm;\n"
798 out_c = out_c + "\tjweak o;\n"
799 for var in flattened_field_vars:
800 if isinstance(var, ConvInfo):
801 # We're a regular ol' field
805 out_c = out_c + "\t" + var[0] + "_JCalls* " + var[1] + ";\n"
807 if fn.fn_name != "free" and fn.fn_name != "cloned":
808 out_c = out_c + "\tjmethodID " + fn.fn_name + "_meth;\n"
809 out_c = out_c + "} " + struct_name + "_JCalls;\n"
811 for fn_line in field_fns:
812 if fn_line.fn_name == "free":
813 out_c = out_c + "static void " + struct_name + "_JCalls_free(void* this_arg) {\n"
814 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) this_arg;\n"
815 out_c = out_c + "\tif (atomic_fetch_sub_explicit(&j_calls->refcnt, 1, memory_order_acquire) == 1) {\n"
816 out_c += "\t\t" + self.construct_jenv().replace("\n", "\n\t\t").strip() + "\n"
817 out_c = out_c + "\t\t(*env)->DeleteWeakGlobalRef(env, j_calls->o);\n"
818 out_c += "\t\t" + self.deconstruct_jenv().replace("\n", "\n\t\t").strip() + "\n"
819 out_c = out_c + "\t\tFREE(j_calls);\n"
820 out_c = out_c + "\t}\n}\n"
822 for idx, fn_line in enumerate(field_fns):
823 if fn_line.fn_name != "free" and fn_line.fn_name != "cloned":
824 assert fn_line.ret_ty_info.ty_info.get_full_rust_ty()[1] == ""
825 out_c = out_c + fn_line.ret_ty_info.ty_info.get_full_rust_ty()[0] + " " + fn_line.fn_name + "_" + struct_name + "_jcall("
826 if fn_line.self_is_const:
827 out_c = out_c + "const void* this_arg"
829 out_c = out_c + "void* this_arg"
831 for idx, arg in enumerate(fn_line.args_ty):
832 out_c = out_c + ", " + arg.ty_info.get_full_rust_ty()[0] + " " + arg.arg_name + arg.ty_info.get_full_rust_ty()[1]
834 out_c = out_c + ") {\n"
835 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) this_arg;\n"
836 out_c += "\t" + self.construct_jenv().replace("\n", "\n\t").strip() + "\n"
838 for arg_info in fn_line.args_ty:
839 if arg_info.ret_conv is not None:
840 out_c = out_c + "\t" + arg_info.ret_conv[0].replace('\n', '\n\t')
841 out_c = out_c + arg_info.arg_name
842 out_c = out_c + arg_info.ret_conv[1].replace('\n', '\n\t') + "\n"
844 out_c = out_c + "\tjobject obj = (*env)->NewLocalRef(env, j_calls->o);\n\tCHECK(obj != NULL);\n"
845 if fn_line.ret_ty_info.c_ty.endswith("Array"):
846 out_c = out_c + "\t" + fn_line.ret_ty_info.c_ty + " ret = (*env)->CallObjectMethod(env, obj, j_calls->" + fn_line.fn_name + "_meth"
847 elif fn_line.ret_ty_info.c_ty == "void":
848 out_c += "\t(*env)->Call" + fn_line.ret_ty_info.java_ty.title() + "Method(env, obj, j_calls->" + fn_line.fn_name + "_meth"
849 elif not fn_line.ret_ty_info.passed_as_ptr:
850 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"
852 out_c = out_c + "\tuint64_t ret = (*env)->CallLongMethod(env, obj, j_calls->" + fn_line.fn_name + "_meth"
854 for idx, arg_info in enumerate(fn_line.args_ty):
855 if arg_info.ret_conv is not None:
856 out_c = out_c + ", " + arg_info.ret_conv_name
858 out_c = out_c + ", " + arg_info.arg_name
859 out_c = out_c + ");\n"
861 out_c += "\tif ((*env)->ExceptionCheck(env)) {\n"
862 out_c += "\t\t(*env)->ExceptionDescribe(env);\n"
863 out_c += "\t\t(*env)->FatalError(env, \"A call to " + fn_line.fn_name + " in " + struct_name + " from rust threw an exception.\");\n"
866 if fn_line.ret_ty_info.arg_conv is not None:
867 out_c += "\t" + fn_line.ret_ty_info.arg_conv.replace("\n", "\n\t") + "\n"
868 out_c += "\t" + self.deconstruct_jenv().replace("\n", "\n\t").strip() + "\n"
869 out_c += "\treturn " + fn_line.ret_ty_info.arg_conv_name + ";\n"
871 out_c += "\t" + self.deconstruct_jenv().replace("\n", "\n\t").strip() + "\n"
872 if not fn_line.ret_ty_info.passed_as_ptr and fn_line.ret_ty_info.c_ty != "void":
873 out_c += "\treturn ret;\n"
875 out_c = out_c + "}\n"
877 # If we can, write out a clone function whether we need one or not, as we use them in moving to rust
878 can_clone_with_ptr = True
879 for var in field_vars:
880 if isinstance(var, ConvInfo):
881 can_clone_with_ptr = False
882 if can_clone_with_ptr:
883 out_c = out_c + "static void " + struct_name + "_JCalls_cloned(" + struct_name + "* new_obj) {\n"
884 out_c = out_c + "\t" + struct_name + "_JCalls *j_calls = (" + struct_name + "_JCalls*) new_obj->this_arg;\n"
885 out_c = out_c + "\tatomic_fetch_add_explicit(&j_calls->refcnt, 1, memory_order_release);\n"
886 for var in field_vars:
887 if not isinstance(var, ConvInfo):
888 out_c = out_c + "\tatomic_fetch_add_explicit(&j_calls->" + var[1] + "->refcnt, 1, memory_order_release);\n"
889 out_c = out_c + "}\n"
891 out_c = out_c + "static inline " + struct_name + " " + struct_name + "_init (" + self.c_fn_args_pfx + ", jobject o"
892 for var in flattened_field_vars:
893 if isinstance(var, ConvInfo):
894 out_c = out_c + ", " + var.c_ty + " " + var.arg_name
896 out_c = out_c + ", jobject " + var[1]
897 out_c = out_c + ") {\n"
899 out_c = out_c + "\tjclass c = (*env)->GetObjectClass(env, o);\n"
900 out_c = out_c + "\tCHECK(c != NULL);\n"
901 out_c = out_c + "\t" + struct_name + "_JCalls *calls = MALLOC(sizeof(" + struct_name + "_JCalls), \"" + struct_name + "_JCalls\");\n"
902 out_c = out_c + "\tatomic_init(&calls->refcnt, 1);\n"
903 out_c = out_c + "\tDO_ASSERT((*env)->GetJavaVM(env, &calls->vm) == 0);\n"
904 out_c = out_c + "\tcalls->o = (*env)->NewWeakGlobalRef(env, o);\n"
906 for (fn_name, java_meth_descr) in java_meths:
907 if fn_name != "free" and fn_name != "cloned":
908 out_c = out_c + "\tcalls->" + fn_name + "_meth = (*env)->GetMethodID(env, c, \"" + fn_name + "\", \"" + java_meth_descr + "\");\n"
909 out_c = out_c + "\tCHECK(calls->" + fn_name + "_meth != NULL);\n"
911 for var in flattened_field_vars:
912 if isinstance(var, ConvInfo) and var.arg_conv is not None:
913 out_c = out_c + "\n\t" + var.arg_conv.replace("\n", "\n\t") +"\n"
914 out_c = out_c + "\n\t" + struct_name + " ret = {\n"
915 out_c = out_c + "\t\t.this_arg = (void*) calls,\n"
916 for fn_line in field_fns:
917 if fn_line.fn_name != "free" and fn_line.fn_name != "cloned":
918 out_c = out_c + "\t\t." + fn_line.fn_name + " = " + fn_line.fn_name + "_" + struct_name + "_jcall,\n"
919 elif fn_line.fn_name == "free":
920 out_c = out_c + "\t\t.free = " + struct_name + "_JCalls_free,\n"
922 out_c = out_c + "\t\t.cloned = " + struct_name + "_JCalls_cloned,\n"
923 for var in field_vars:
924 if isinstance(var, ConvInfo):
925 if var.arg_conv_name is not None:
926 out_c = out_c + "\t\t." + var.arg_name + " = " + var.arg_conv_name + ",\n"
927 out_c = out_c + "\t\t.set_" + var.arg_name + " = NULL,\n"
929 out_c = out_c + "\t\t." + var.var_name + " = " + var.var_name + ",\n"
930 out_c = out_c + "\t\t.set_" + var.var_name + " = NULL,\n"
932 out_c += "\t\t." + var[1] + " = " + var[0] + "_init(env, clz, " + var[1]
933 for suparg in var[2]:
934 if isinstance(suparg, ConvInfo):
935 out_c = out_c + ", " + suparg.arg_name
937 out_c = out_c + ", " + suparg[1]
939 out_c = out_c + "\t};\n"
940 for var in flattened_field_vars:
941 if not isinstance(var, ConvInfo):
942 out_c = out_c + "\tcalls->" + var[1] + " = ret." + var[1] + ".this_arg;\n"
943 out_c = out_c + "\treturn ret;\n"
944 out_c = out_c + "}\n"
946 out_c = out_c + self.c_fn_ty_pfx + "int64_t " + self.c_fn_name_define_pfx(struct_name + "_new", True) + "jobject o"
947 for var in flattened_field_vars:
948 if isinstance(var, ConvInfo):
949 out_c = out_c + ", " + var.c_ty + " " + var.arg_name
951 out_c = out_c + ", jobject " + var[1]
952 out_c = out_c + ") {\n"
953 out_c = out_c + "\t" + struct_name + " *res_ptr = MALLOC(sizeof(" + struct_name + "), \"" + struct_name + "\");\n"
954 out_c = out_c + "\t*res_ptr = " + struct_name + "_init(env, clz, o"
955 for var in flattened_field_vars:
956 if isinstance(var, ConvInfo):
957 out_c = out_c + ", " + var.arg_name
959 out_c = out_c + ", " + var[1]
960 out_c = out_c + ");\n"
961 out_c = out_c + "\treturn (uint64_t)res_ptr;\n"
962 out_c = out_c + "}\n"
964 for var in flattened_field_vars:
965 if not isinstance(var, ConvInfo):
966 out_java_trait += "\n\t/**\n"
967 out_java_trait += "\t * Gets the underlying " + var[1] + ".\n"
968 out_java_trait += "\t */\n"
969 underscore_name = ''.join('_' + c.lower() if c.isupper() else c for c in var[1]).strip('_')
970 out_java_trait += "\tpublic " + var[1] + " get_" + underscore_name + "() {\n"
971 out_java_trait += "\t\t" + var[1] + " res = new " + var[1] + "(null, bindings." + struct_name + "_get_" + var[1] + "(this.ptr));\n"
972 out_java_trait += "\t\tthis.ptrs_to.add(res);\n"
973 out_java_trait += "\t\treturn res;\n"
974 out_java_trait += "\t}\n"
975 out_java_trait += "\n"
977 out_java += "\tpublic static native long " + struct_name + "_get_" + var[1] + "(long arg);\n"
979 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"
980 out_c += "\t" + struct_name + " *inp = (" + struct_name + " *)(arg & ~1);\n"
981 out_c += "\tuint64_t res_ptr = (uint64_t)&inp->" + var[1] + ";\n"
982 out_c += "\tDO_ASSERT((res_ptr & 1) == 0);\n"
983 out_c += "\treturn (int64_t)(res_ptr | 1);\n"
986 return (out_java, out_java_trait, out_c)
988 def trait_struct_inc_refcnt(self, ty_info):
989 base_conv = "\nif (" + ty_info.var_name + "_conv.free == " + ty_info.rust_obj + "_JCalls_free) {\n"
990 base_conv = base_conv + "\t// If this_arg is a JCalls struct, then we need to increment the refcnt in it.\n"
991 base_conv = base_conv + "\t" + ty_info.rust_obj + "_JCalls_cloned(&" + ty_info.var_name + "_conv);\n}"
994 def map_complex_enum(self, struct_name, variant_list, camel_to_snake, enum_doc_comment):
995 java_hu_type = struct_name.replace("LDK", "").replace("COption", "Option")
1000 out_java_enum += (self.hu_struct_file_prefix)
1001 out_java_enum += "\n/**\n * " + enum_doc_comment.replace("\n", "\n * ") + "\n */\n"
1002 out_java_enum += "@SuppressWarnings(\"unchecked\") // We correctly assign various generic arrays\n"
1003 out_java_enum += ("public class " + java_hu_type + " extends CommonBase {\n")
1004 out_java_enum += ("\tprivate " + java_hu_type + "(Object _dummy, long ptr) { super(ptr); }\n")
1005 out_java_enum += ("\t@Override @SuppressWarnings(\"deprecation\")\n")
1006 out_java_enum += ("\tprotected void finalize() throws Throwable {\n")
1007 out_java_enum += ("\t\tsuper.finalize();\n")
1008 out_java_enum += ("\t\tif (ptr != 0) { bindings." + struct_name.replace("LDK", "") + "_free(ptr); }\n")
1009 out_java_enum += ("\t}\n")
1010 out_java_enum += ("\tstatic " + java_hu_type + " constr_from_ptr(long ptr) {\n")
1011 out_java_enum += ("\t\tbindings." + struct_name + " raw_val = bindings." + struct_name + "_ref_from_ptr(ptr);\n")
1012 java_hu_subclasses = ""
1014 init_meth_jty_strs = {}
1016 out_java += ("\tpublic static class " + struct_name + " {\n")
1017 out_java += ("\t\tprivate " + struct_name + "() {}\n")
1018 for var in variant_list:
1019 out_java += ("\t\tpublic final static class " + var.var_name + " extends " + struct_name + " {\n")
1020 java_hu_subclasses = java_hu_subclasses + "\tpublic final static class " + var.var_name + " extends " + java_hu_type + " {\n"
1021 out_java_enum += ("\t\tif (raw_val.getClass() == bindings." + struct_name + "." + var.var_name + ".class) {\n")
1022 out_java_enum += ("\t\t\treturn new " + var.var_name + "(ptr, (bindings." + struct_name + "." + var.var_name + ")raw_val);\n")
1023 init_meth_jty_str = ""
1024 init_meth_params = ""
1027 for idx, (field_ty, field_docs) in enumerate(var.fields):
1029 init_meth_params = init_meth_params + ", "
1031 if field_ty.java_hu_ty == var.var_name:
1032 field_path = field_ty.java_fn_ty_arg.strip("L;").replace("/", ".")
1033 out_java += "\t\t\tpublic " + field_path + " " + field_ty.arg_name + ";\n"
1034 java_hu_subclasses = java_hu_subclasses + "\t\tpublic final " + field_path + " " + field_ty.arg_name + ";\n"
1035 init_meth_params = init_meth_params + field_path + " " + field_ty.arg_name
1037 out_java += "\t\t\tpublic " + field_ty.java_ty + " " + field_ty.arg_name + ";\n"
1038 if field_docs is not None:
1039 java_hu_subclasses += "\t\t/**\n\t\t * " + field_docs.replace("\n", "\n\t\t * ") + "\n\t\t*/\n"
1040 java_hu_subclasses += "\t\t"
1041 if field_ty.nullable:
1042 java_hu_subclasses += "@Nullable "
1043 java_hu_subclasses += "public final " + field_ty.java_hu_ty + " " + field_ty.arg_name + ";\n"
1044 init_meth_params = init_meth_params + field_ty.java_ty + " " + field_ty.arg_name
1045 init_meth_body = init_meth_body + "this." + field_ty.arg_name + " = " + field_ty.arg_name + "; "
1046 if field_ty.to_hu_conv is not None:
1047 hu_conv_body = hu_conv_body + "\t\t\t" + field_ty.java_ty + " " + field_ty.arg_name + " = obj." + field_ty.arg_name + ";\n"
1048 hu_conv_body = hu_conv_body + "\t\t\t" + field_ty.to_hu_conv.replace("\n", "\n\t\t\t") + "\n"
1049 hu_conv_body = hu_conv_body + "\t\t\tthis." + field_ty.arg_name + " = " + field_ty.to_hu_conv_name + ";\n"
1051 hu_conv_body = hu_conv_body + "\t\t\tthis." + field_ty.arg_name + " = obj." + field_ty.arg_name + ";\n"
1052 init_meth_jty_str = init_meth_jty_str + field_ty.java_fn_ty_arg
1053 out_java += ("\t\t\t" + var.var_name + "(" + init_meth_params + ") { ")
1054 out_java += (init_meth_body)
1056 out_java += ("\t\t}\n")
1057 out_java_enum += ("\t\t}\n")
1058 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"
1059 java_hu_subclasses = java_hu_subclasses + hu_conv_body
1060 java_hu_subclasses = java_hu_subclasses + "\t\t}\n\t}\n"
1061 init_meth_jty_strs[var.var_name] = init_meth_jty_str
1062 out_java += ("\t\tstatic native void init();\n")
1063 out_java += ("\t}\n")
1064 out_java_enum += ("\t\tassert false; return null; // Unreachable without extending the (internal) bindings interface\n\t}\n\n")
1065 out_java_enum += (java_hu_subclasses)
1066 out_java += ("\tstatic { " + struct_name + ".init(); }\n")
1067 out_java += ("\tpublic static native " + struct_name + " " + struct_name + "_ref_from_ptr(long ptr);\n");
1069 out_c += (self.c_complex_enum_pfx(struct_name, [x.var_name for x in variant_list], init_meth_jty_strs))
1071 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")
1072 out_c += ("\t" + struct_name + " *obj = (" + struct_name + "*)(ptr & ~1);\n")
1073 out_c += ("\tswitch(obj->tag) {\n")
1074 for var in variant_list:
1075 out_c += ("\t\tcase " + struct_name + "_" + var.var_name + ": {\n")
1077 for idx, (field_map, field_docs) in enumerate(var.fields):
1078 if field_map.ret_conv is not None:
1079 out_c += ("\t\t\t" + field_map.ret_conv[0].replace("\n", "\n\t\t\t"))
1080 if var.tuple_variant:
1081 out_c += "obj->" + camel_to_snake(var.var_name)
1083 out_c += "obj->" + camel_to_snake(var.var_name) + "." + field_map.arg_name
1084 out_c += (field_map.ret_conv[1].replace("\n", "\n\t\t\t") + "\n")
1085 c_params.append(field_map.ret_conv_name)
1087 if var.tuple_variant:
1088 c_params.append("obj->" + camel_to_snake(var.var_name))
1090 c_params.append("obj->" + camel_to_snake(var.var_name) + "." + field_map.arg_name)
1091 out_c += ("\t\t\treturn " + self.c_constr_native_complex_enum(struct_name, var.var_name, c_params) + ";\n")
1092 out_c += ("\t\t}\n")
1093 out_c += ("\t\tdefault: abort();\n")
1094 out_c += ("\t}\n}\n")
1095 return (out_java, out_java_enum, out_c)
1097 def map_opaque_struct(self, struct_name, struct_doc_comment):
1098 out_opaque_struct_human = ""
1099 out_opaque_struct_human += self.hu_struct_file_prefix
1100 out_opaque_struct_human += "\n/**\n * " + struct_doc_comment.replace("\n", "\n * ") + "\n */\n"
1101 out_opaque_struct_human += "@SuppressWarnings(\"unchecked\") // We correctly assign various generic arrays\n"
1102 out_opaque_struct_human += ("public class " + struct_name.replace("LDK","") + " extends CommonBase")
1103 if struct_name.startswith("LDKLocked"):
1104 out_opaque_struct_human += (" implements AutoCloseable")
1105 out_opaque_struct_human += (" {\n")
1106 out_opaque_struct_human += ("\t" + struct_name.replace("LDK", "") + "(Object _dummy, long ptr) { super(ptr); }\n")
1107 if struct_name.startswith("LDKLocked"):
1108 out_opaque_struct_human += ("\t@Override public void close() {\n")
1110 out_opaque_struct_human += ("\t@Override @SuppressWarnings(\"deprecation\")\n")
1111 out_opaque_struct_human += ("\tprotected void finalize() throws Throwable {\n")
1112 out_opaque_struct_human += ("\t\tsuper.finalize();\n")
1113 out_opaque_struct_human += ("\t\tif (ptr != 0) { bindings." + struct_name.replace("LDK","") + "_free(ptr); }\n")
1114 out_opaque_struct_human += ("\t}\n\n")
1115 return out_opaque_struct_human
1118 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):
1121 out_java_struct = None
1123 out_java += ("\tpublic static native ")
1124 out_c += (self.c_fn_ty_pfx)
1125 out_c += (return_type_info.c_ty)
1126 out_java += (return_type_info.java_ty)
1127 if return_type_info.ret_conv is not None:
1128 ret_conv_pfx, ret_conv_sfx = return_type_info.ret_conv
1129 out_java += (" " + method_name + "(")
1130 have_args = len(argument_types) > 1 or (len(argument_types) > 0 and argument_types[0].c_ty != "void")
1131 out_c += (" " + self.c_fn_name_define_pfx(method_name, have_args))
1133 for idx, arg_conv_info in enumerate(argument_types):
1137 if arg_conv_info.c_ty != "void":
1138 out_c += (arg_conv_info.c_ty + " " + arg_conv_info.arg_name)
1139 out_java += (arg_conv_info.java_ty + " " + arg_conv_info.arg_name)
1141 out_java_struct = ""
1143 out_java_struct += ("\t// Skipped " + method_name + "\n")
1145 meth_n = method_name[len(struct_meth) + 1 if len(struct_meth) != 0 else 0:].strip("_")
1146 if doc_comment is not None:
1147 out_java_struct += "\t/**\n\t * " + doc_comment.replace("\n", "\n\t * ") + "\n\t */\n"
1148 if return_type_info.nullable:
1149 out_java_struct += "\t@Nullable\n"
1152 out_java_struct += "\tpublic static " + return_type_info.java_hu_ty + " of("
1153 elif meth_n == "default":
1154 out_java_struct += "\tpublic static " + return_type_info.java_hu_ty + " with_default("
1156 out_java_struct += "\tpublic static " + return_type_info.java_hu_ty + " " + meth_n + "("
1158 out_java_struct += ("\tpublic " + return_type_info.java_hu_ty + " " + meth_n + "(")
1159 for idx, arg in enumerate(argument_types):
1161 if not takes_self or idx > 1:
1162 out_java_struct += ", "
1165 if arg.java_ty != "void":
1166 if arg.arg_name in default_constructor_args:
1167 assert not arg.nullable
1168 for explode_idx, explode_arg in enumerate(default_constructor_args[arg.arg_name]):
1169 if explode_idx != 0:
1170 out_java_struct += (", ")
1171 out_java_struct += (
1172 explode_arg.java_hu_ty + " " + arg.arg_name + "_" + explode_arg.arg_name)
1175 out_java_struct += "@Nullable "
1176 ty_string = arg.java_hu_ty
1177 if arg.java_fn_ty_arg[0] == "L" and arg.java_fn_ty_arg[len(arg.java_fn_ty_arg) - 1] == ";":
1178 ty_string = arg.java_fn_ty_arg.strip("L;").replace("/", ".")
1179 out_java_struct += ty_string + " " + arg.arg_name
1180 out_java += (");\n")
1182 if out_java_struct is not None:
1183 out_java_struct += (") {\n")
1184 for info in argument_types:
1185 if info.arg_conv is not None:
1186 out_c += ("\t" + info.arg_conv.replace('\n', "\n\t") + "\n")
1187 if return_type_info.ret_conv is not None:
1188 out_c += ("\t" + ret_conv_pfx.replace('\n', '\n\t'))
1189 elif return_type_info.c_ty != "void":
1190 out_c += ("\t" + return_type_info.c_ty + " ret_val = ")
1193 if c_call_string is None:
1194 out_c += (method_name + "(")
1196 out_c += (c_call_string)
1197 for idx, info in enumerate(argument_types):
1198 if info.arg_conv_name is not None:
1201 elif c_call_string is not None:
1203 out_c += (info.arg_conv_name)
1205 if return_type_info.ret_conv is not None:
1206 out_c += (ret_conv_sfx.replace('\n', '\n\t'))
1209 for info in argument_types:
1210 if info.arg_conv_cleanup is not None:
1211 out_c += ("\n\t" + info.arg_conv_cleanup.replace("\n", "\n\t"))
1212 if return_type_info.ret_conv is not None:
1213 out_c += ("\n\treturn " + return_type_info.ret_conv_name + ";")
1214 elif return_type_info.c_ty != "void":
1215 out_c += ("\n\treturn ret_val;")
1216 out_c += ("\n}\n\n")
1219 out_java_struct += ("\t\t")
1220 if return_type_info.java_ty != "void":
1221 out_java_struct += (return_type_info.java_ty + " ret = ")
1222 out_java_struct += ("bindings." + method_name + "(")
1223 for idx, info in enumerate(argument_types):
1225 out_java_struct += (", ")
1226 if idx == 0 and takes_self:
1227 out_java_struct += ("this.ptr")
1228 elif info.arg_name in default_constructor_args:
1229 out_java_struct += ("bindings." + info.java_hu_ty + "_new(")
1230 for explode_idx, explode_arg in enumerate(default_constructor_args[info.arg_name]):
1231 if explode_idx != 0:
1232 out_java_struct += (", ")
1233 expl_arg_name = info.arg_name + "_" + explode_arg.arg_name
1234 if explode_arg.from_hu_conv is not None:
1235 out_java_struct += (
1236 explode_arg.from_hu_conv[0].replace(explode_arg.arg_name, expl_arg_name))
1238 out_java_struct += (expl_arg_name)
1239 out_java_struct += (")")
1240 elif info.from_hu_conv is not None:
1241 out_java_struct += (info.from_hu_conv[0])
1243 out_java_struct += (info.arg_name)
1244 out_java_struct += (");\n")
1245 if return_type_info.java_ty == "long" and return_type_info.java_hu_ty != "long":
1246 out_java_struct += "\t\tif (ret < 1024) { return null; }\n"
1248 if return_type_info.to_hu_conv is not None:
1250 out_java_struct += ("\t\t" + return_type_info.to_hu_conv.replace("\n", "\n\t\t").replace("this",
1251 return_type_info.to_hu_conv_name) + "\n")
1253 out_java_struct += ("\t\t" + return_type_info.to_hu_conv.replace("\n", "\n\t\t") + "\n")
1255 for idx, info in enumerate(argument_types):
1256 if idx == 0 and takes_self:
1258 elif info.arg_name in default_constructor_args:
1259 for explode_arg in default_constructor_args[info.arg_name]:
1260 expl_arg_name = info.arg_name + "_" + explode_arg.arg_name
1261 if explode_arg.from_hu_conv is not None and return_type_info.to_hu_conv_name:
1262 out_java_struct += ("\t\t" + explode_arg.from_hu_conv[1].replace(explode_arg.arg_name,
1263 expl_arg_name).replace(
1264 "this", return_type_info.to_hu_conv_name) + ";\n")
1265 elif info.from_hu_conv is not None and info.from_hu_conv[1] != "":
1266 if not takes_self and return_type_info.to_hu_conv_name is not None:
1267 out_java_struct += (
1268 "\t\t" + info.from_hu_conv[1].replace("this", return_type_info.to_hu_conv_name).replace("\n", "\n\t\t") + ";\n")
1270 out_java_struct += ("\t\t" + info.from_hu_conv[1].replace("\n", "\n\t\t") + ";\n")
1272 if takes_self and not takes_self_as_ref:
1273 out_java_struct += "\t\t" + argument_types[0].from_hu_conv[1].replace("\n", "\n\t\t").replace("this_arg", "this") + ";\n"
1274 if return_type_info.to_hu_conv_name is not None:
1275 out_java_struct += ("\t\treturn " + return_type_info.to_hu_conv_name + ";\n")
1276 elif return_type_info.java_ty != "void" and return_type_info.rust_obj != "LDK" + struct_meth:
1277 out_java_struct += ("\t\treturn ret;\n")
1278 out_java_struct += ("\t}\n\n")
1280 return (out_java, out_c, out_java_struct)