Update CI references to 0.0.122
[ldk-java] / csharp_strings.py
index c87bef6d2c75637c21dd11b4a7b4dd8b60fc5586..a73ee2035d310be2568fa48f71b94ab9994ea3e4 100644 (file)
@@ -3,7 +3,9 @@ from enum import Enum
 import sys
 
 class Target(Enum):
-    CSHARP = 1,
+    WINDOWS = 1,
+    LINUX = 2,
+    PTHREAD = 3,
 
 def first_to_lower(string: str) -> str:
     first = string[0]
@@ -23,16 +25,16 @@ class Consts:
         self.function_ptr_counter = 0
         self.function_ptrs = {}
         self.c_type_map = dict(
-            bool = ['bool'],
-            uint8_t = ['byte'],
-            uint16_t = ['short'],
-            uint32_t = ['int'],
-            uint64_t = ['long'],
-            int64_t = ['long'],
-            double = ['double'],
+            bool = ['bool', 'long', 'bool[]'],
+            uint8_t = ['byte', 'long', 'byte[]'],
+            uint16_t = ['short', 'long', 'short[]'],
+            uint32_t = ['int', 'long', 'int[]'],
+            uint64_t = ['long', 'long', 'long[]'],
+            int64_t = ['long', 'long', 'long[]'],
+            double = ['double', 'long', 'double[]'],
         )
         self.java_type_map = dict(
-            String = "string"
+            String = "long"
         )
         self.java_hu_type_map = dict(
             String = "string"
@@ -54,49 +56,13 @@ namespace org { namespace ldk { namespace impl {
 
 internal class bindings {
        static List<WeakReference> js_objs = new List<WeakReference>();
-       internal class ArrayCoder : ICustomMarshaler {
-               int size = 0;
-               public static ICustomMarshaler GetInstance(string pstrCookie) {
-                       return new ArrayCoder();
-               }
-
-               public Object MarshalNativeToManaged(IntPtr pNativeData) { throw new NotImplementedException(); }
-               public IntPtr MarshalManagedToNative(Object obj) {
-                       if (obj.GetType() == typeof(byte[])) {
-                               byte[] inp = (byte[])obj;
-                               IntPtr data = Marshal.AllocHGlobal(inp.Length + 8);
-                               Marshal.WriteInt64(data, inp.Length);
-                               Marshal.Copy(inp, 0, data + 8, inp.Length);
-                               this.size = inp.Length + 8;
-                               return data;
-                       } else {
-                               throw new NotImplementedException();
-                       }
-               }
-               public void CleanUpNativeData(IntPtr pNativeData) {
-                       Marshal.FreeHGlobal(pNativeData);
-               }
-               public void CleanUpManagedData(Object ManagedObj) { }
-               public int GetNativeDataSize() {
-                       // Blindly guess based on the last allocation, no idea how else to implement this.
-                       return this.size;
-               }
-       }
 
-       /*static {
-               init(java.lang.Enum.class, VecOrSliceDef.class);
-               init_class_cache();
-               if (!get_lib_version_string().equals(version.get_ldk_java_bindings_version()))
-                       throw new ArgumentException("Compiled LDK library and LDK class failes do not match");
-               // Fetching the LDK versions from C also checks that the header and binaries match
-               Console.Error.WriteLine("Loaded LDK-Java Bindings " + version.get_ldk_java_bindings_version() + " with LDK " + get_ldk_version() + " and LDK-C-Bindings " + get_ldk_c_bindings_version());
-       }*/
-       //static extern void init(java.lang.Class c);
-       //static native void init_class_cache();
 """
         self.bindings_header += self.native_meth_decl("get_lib_version_string", "string") + "();\n"
         self.bindings_header += self.native_meth_decl("get_ldk_c_bindings_version", "string") + "();\n"
         self.bindings_header += self.native_meth_decl("get_ldk_version", "string") + "();\n\n"
+        self.bindings_header += self.native_meth_decl("allocate_buffer", "long") + "(long buflen);\n\n"
+        self.bindings_header += self.native_meth_decl("free_buffer", "void") + "(long buf);\n\n"
 
         self.bindings_version_file = """
 
@@ -139,14 +105,14 @@ public class CommonBase {
        public readonly int previous_vout;
 
        internal TxIn(object _dummy, long ptr) : base(ptr) {
-               this.witness = bindings.TxIn_get_witness(ptr);
-               this.script_sig = bindings.TxIn_get_script_sig(ptr);
+               this.witness = InternalUtils.decodeUint8Array(bindings.TxIn_get_witness(ptr));
+               this.script_sig = InternalUtils.decodeUint8Array(bindings.TxIn_get_script_sig(ptr));
                this.sequence = bindings.TxIn_get_sequence(ptr);
-               this.previous_txid = bindings.TxIn_get_previous_txid(ptr);
+               this.previous_txid = InternalUtils.decodeUint8Array(bindings.TxIn_get_previous_txid(ptr));
                this.previous_vout = bindings.TxIn_get_previous_vout(ptr);
        }
        public TxIn(byte[] witness, byte[] script_sig, int sequence, byte[] previous_txid, int previous_vout)
-       : this(null, bindings.TxIn_new(witness, script_sig, sequence, previous_txid, previous_vout)) {}
+       : this(null, bindings.TxIn_new(InternalUtils.encodeUint8Array(witness), InternalUtils.encodeUint8Array(script_sig), sequence, InternalUtils.encodeUint8Array(previous_txid), previous_vout)) {}
 
        ~TxIn() {
                if (ptr != 0) { bindings.TxIn_free(ptr); }
@@ -160,10 +126,10 @@ public class CommonBase {
        public readonly long value;
 
     internal TxOut(object _dummy, long ptr) : base(ptr) {
-               this.script_pubkey = bindings.TxOut_get_script_pubkey(ptr);
+               this.script_pubkey = InternalUtils.decodeUint8Array(bindings.TxOut_get_script_pubkey(ptr));
                this.value = bindings.TxOut_get_value(ptr);
        }
-    public TxOut(long value, byte[] script_pubkey) : this(null, bindings.TxOut_new(script_pubkey, value)) {}
+    public TxOut(long value, byte[] script_pubkey) : this(null, bindings.TxOut_new(InternalUtils.encodeUint8Array(script_pubkey), value)) {}
 
        ~TxOut() {
                if (ptr != 0) { bindings.TxOut_free(ptr); }
@@ -175,10 +141,10 @@ public class CommonBase {
        public readonly byte[] scalar_bytes;
 
     internal BigEndianScalar(object _dummy, long ptr) : base(ptr) {
-               this.scalar_bytes = bindings.BigEndianScalar_get_bytes(ptr);
+               this.scalar_bytes = InternalUtils.decodeUint8Array(bindings.BigEndianScalar_get_bytes(ptr));
        }
-    public BigEndianScalar(byte[] scalar_bytes) : base(bindings.BigEndianScalar_new(scalar_bytes)) {
-               this.scalar_bytes = bindings.BigEndianScalar_get_bytes(ptr);
+    public BigEndianScalar(byte[] scalar_bytes) : base(bindings.BigEndianScalar_new(InternalUtils.encodeUint8Array(scalar_bytes))) {
+               this.scalar_bytes = InternalUtils.decodeUint8Array(bindings.BigEndianScalar_get_bytes(ptr));
        }
 
        ~BigEndianScalar() {
@@ -186,6 +152,28 @@ public class CommonBase {
        }
 }"""
 
+        self.witness_program_defn = """public class WitnessProgram : CommonBase {
+       /** The witness program bytes themselves */
+       public readonly byte[] program;
+       /** The witness version */
+       public readonly WitnessVersion version;
+
+       internal WitnessProgram(object _dummy, long ptr) : base(ptr) {
+               this.program = InternalUtils.decodeUint8Array(bindings.WitnessProgram_get_program(ptr));
+               this.version = new WitnessVersion(bindings.WitnessProgram_get_version(ptr));
+       }
+       static private long check_args(byte[] program, WitnessVersion version) {
+               if (program.Length < 2 || program.Length > 40) throw new ArgumentException();
+               if (version.getVal() == 0 && program.Length != 20 && program.Length != 32) throw new ArgumentException();
+               return InternalUtils.encodeUint8Array(program);
+       }
+       public WitnessProgram(byte[] program, WitnessVersion version) :
+               this(null, bindings.WitnessProgram_new(version.getVal(), check_args(program, version))) {}
+
+       ~WitnessProgram() {
+               if (ptr != 0) { bindings.WitnessProgram_free(ptr); }
+       }
+}"""
 
         self.c_file_pfx = """
 // On OSX jlong (ie long long) is not equivalent to int64_t, so we override here
@@ -202,7 +190,25 @@ public class CommonBase {
 
         self.c_file_pfx = self.c_file_pfx + "#include <stdio.h>\n#define DEBUG_PRINT(...) fprintf(stderr, __VA_ARGS__)\n"
 
-        if not DEBUG or sys.platform == "darwin":
+        if self.target == Target.WINDOWS:
+            self.c_file_pfx = self.c_file_pfx + """#include <heapapi.h>
+static HANDLE process_heap = NULL;
+static inline void* init_heap() {
+       if (UNLIKELY(process_heap == NULL)) {
+               // Assume pointer writes wont tear, which is true where we need it.
+               process_heap = GetProcessHeap();
+       }
+}
+static inline void* MALLOC(size_t a, const char* _) {
+       init_heap();
+       return HeapAlloc(process_heap, HEAP_ZERO_MEMORY, a);
+}
+#define do_MALLOC(a, b, _c) MALLOC(a, b)
+#define FREE(p) if ((uint64_t)(p) > 4096) { init_heap(); HeapFree(process_heap, 0, p); }
+#define CHECK_ACCESS(p)
+#define CHECK_INNER_FIELD_ACCESS_OR_NULL(v)
+"""
+        elif not DEBUG or self.target != Target.LINUX:
             self.c_file_pfx = self.c_file_pfx + """#define do_MALLOC(a, _b, _c) malloc(a)
 #define MALLOC(a, _) malloc(a)
 #define FREE(p) if ((uint64_t)(p) > 4096) { free(p); }
@@ -228,7 +234,7 @@ void __attribute__((constructor)) debug_log_version() {
 }
 """
 
-            if sys.platform != "darwin":
+            if self.target == Target.LINUX:
                 self.c_file_pfx += """
 // Running a leak check across all the allocations and frees of the JDK is a mess,
 // so instead we implement our own naive leak checker here, relying on the -wrap
@@ -363,7 +369,7 @@ void __attribute__((destructor)) check_leaks() {
        unsigned long alloc_count = 0;
        unsigned long alloc_size = 0;
        DEBUG_PRINT("The following LDK-allocated blocks still remain.\\n");
-       DEBUG_PRINT("Note that this is only accurate if System.gc(); System.runFinalization()\\n");
+       DEBUG_PRINT("Note that this is only accurate if System.GC.Collect(); GC.WaitForPendingFinalizers();\\n");
        DEBUG_PRINT("was called prior to exit after all LDK objects were out of scope.\\n");
        for (allocation* a = allocation_ll; a != NULL; a = a->next) {
                DEBUG_PRINT("%s %p (%lu bytes) remains:\\n", a->struct_name, a->ptr, a->alloc_len);
@@ -373,7 +379,7 @@ void __attribute__((destructor)) check_leaks() {
                alloc_size += a->alloc_len;
        }
        DEBUG_PRINT("%lu allocations remained for %lu bytes.\\n", alloc_count, alloc_size);
-       DEBUG_PRINT("Note that this is only accurate if System.gc(); System.runFinalization()\\n");
+       DEBUG_PRINT("Note that this is only accurate if System.GC.Collect(); GC.WaitForPendingFinalizers()\\n");
        DEBUG_PRINT("was called prior to exit after all LDK objects were out of scope.\\n");
 }
 """
@@ -386,6 +392,18 @@ _Static_assert(offsetof(LDKCVec_u8Z, datalen) == offsetof(LDKu8slice, datalen),
 
 _Static_assert(sizeof(void*) <= 8, "Pointers must fit into 64 bits");
 
+// Int types across Windows/Linux are different, so make sure we're using the right headers.
+_Static_assert(sizeof(void*) == sizeof(uintptr_t), "stdints must be correct");
+_Static_assert(sizeof(void*) == sizeof(intptr_t), "stdints must be correct");
+_Static_assert(sizeof(uint64_t) == 8, "stdints must be correct");
+_Static_assert(sizeof(int64_t) == 8, "stdints must be correct");
+_Static_assert(sizeof(uint32_t) == 4, "stdints must be correct");
+_Static_assert(sizeof(int32_t) == 4, "stdints must be correct");
+_Static_assert(sizeof(uint16_t) == 2, "stdints must be correct");
+_Static_assert(sizeof(int16_t) == 2, "stdints must be correct");
+_Static_assert(sizeof(uint8_t) == 1, "stdints must be correct");
+_Static_assert(sizeof(int8_t) == 1, "stdints must be correct");
+
 #define DECL_ARR_TYPE(ty, name) \\
        struct name##array { \\
                uint64_t arr_len; /* uint32_t would suffice but we want to align uint64_ts as well */ \\
@@ -426,6 +444,14 @@ static inline LDKStr str_ref_to_owned_c(const jstring str) {
 
 typedef bool jboolean;
 
+int64_t CS_LDK_allocate_buffer(int64_t len) {
+       return (int64_t)MALLOC(len, "C#-requested buffer");
+}
+
+void CS_LDK_free_buffer(int64_t buf) {
+       FREE((void*)buf);
+}
+
 jstring CS_LDK_get_ldk_c_bindings_version() {
        return str_ref_to_cs(check_get_ldk_bindings_version(), strlen(check_get_ldk_bindings_version()));
 }
@@ -512,20 +538,20 @@ namespace org { namespace ldk { namespace structs {
 
     def map_hu_array_elems(self, arr_name, conv_name, arr_ty, elem_ty, is_nullable):
         if elem_ty.java_hu_ty == "UInt5":
-            return arr_name + " != null ? InternalUtils.convUInt5Array(" + arr_name + ") : null"
+            return "InternalUtils.convUInt5Array(" + arr_name + ")"
         elif elem_ty.java_hu_ty == "WitnessVersion":
-            return arr_name + " != null ? InternalUtils.convWitnessVersionArray(" + arr_name + ") : null"
+            return "InternalUtils.convWitnessVersionArray(" + arr_name + ")"
         else:
-            return arr_name + " != null ? InternalUtils.mapArray(" + arr_name + ", " + conv_name + " => " + elem_ty.from_hu_conv[0] + ") : null"
+            return "InternalUtils.mapArray(" + arr_name + ", " + conv_name + " => " + elem_ty.from_hu_conv[0] + ")"
 
     def str_ref_to_native_call(self, var_name, str_len):
         return "str_ref_to_cs(" + var_name + ", " + str_len + ")"
     def str_ref_to_c_call(self, var_name):
         return "str_ref_to_owned_c(" + var_name + ")"
     def str_to_hu_conv(self, var_name):
-        return None
+        return "string " + var_name + "_conv = InternalUtils.decodeString(" + var_name + ");"
     def str_from_hu_conv(self, var_name):
-        return None
+        return ("InternalUtils.encodeString(" + var_name + ")", "")
 
     def init_str(self):
         ret = ""
@@ -547,9 +573,18 @@ int CS_LDK_register_{fn_suffix}_invoker(invoker_{fn_suffix} invoker) {{
         return ty_string + " " + var_name + " = " + statement
 
     def get_java_arr_len(self, arr_name):
-        return arr_name + ".Length"
+        return "InternalUtils.getArrayLength(" + arr_name + ")"
+
     def get_java_arr_elem(self, elem_ty, arr_name, idx):
-        return arr_name + "[" + idx + "]"
+        if elem_ty.c_ty == "int64_t" or elem_ty.c_ty == "uint64_t":
+            return "InternalUtils.getU64ArrayElem(" + arr_name + ", " + idx + ")"
+        elif elem_ty.c_ty.endswith("Array") or elem_ty.c_ty == "uintptr_t" or elem_ty.rust_obj == "LDKStr":
+            return "InternalUtils.getU64ArrayElem(" + arr_name + ", " + idx + ")"
+        elif elem_ty.rust_obj == "LDKU5":
+            return "InternalUtils.getU8ArrayElem(" + arr_name + ", " + idx + ")"
+        else:
+            assert False
+
     def constr_hu_array(self, ty_info, arr_len):
         base_ty = ty_info.subty.java_hu_ty.split("[")[0].split("<")[0]
         conv = "new " + base_ty + "[" + arr_len + "]"
@@ -558,22 +593,44 @@ int CS_LDK_register_{fn_suffix}_invoker(invoker_{fn_suffix} invoker) {{
             conv += "[" + ty_info.subty.java_hu_ty.split("<")[0].split("[")[1]
         return conv
     def cleanup_converted_native_array(self, ty_info, arr_name):
-        return None
+        return "bindings.free_buffer(" + arr_name + ");"
 
     def primitive_arr_from_hu(self, arr_ty, fixed_len, arr_name):
         mapped_ty = arr_ty.subty
+        inner = arr_name
         if arr_ty.rust_obj == "LDKU128":
-            return ("" + arr_name + ".getLEBytes()", "")
+            return ("InternalUtils.encodeUint8Array(" + arr_name + ".getLEBytes())", "")
         if fixed_len is not None:
-            return ("InternalUtils.check_arr_len(" + arr_name + ", " + fixed_len + ")", "")
-        return None
+            inner = "InternalUtils.check_arr_len(" + arr_name + ", " + fixed_len + ")"
+        if mapped_ty.c_ty.endswith("Array"):
+            return ("InternalUtils.encodeUint64Array(" + inner + ")", "")
+        elif mapped_ty.c_ty == "uint8_t" or mapped_ty.c_ty == "int8_t":
+            return ("InternalUtils.encodeUint8Array(" + inner + ")", "")
+        elif mapped_ty.c_ty == "uint16_t" or mapped_ty.c_ty == "int16_t":
+            return ("InternalUtils.encodeUint16Array(" + inner + ")", "")
+        elif mapped_ty.c_ty == "uint32_t":
+            return ("InternalUtils.encodeUint32Array(" + inner + ")", "")
+        elif mapped_ty.c_ty == "int64_t" or mapped_ty.c_ty == "uint64_t" or mapped_ty.rust_obj == "LDKStr":
+            return ("InternalUtils.encodeUint64Array(" + inner + ")", "")
+        else:
+            print(mapped_ty.c_ty)
+            assert False
+
     def primitive_arr_to_hu(self, arr_ty, fixed_len, arr_name, conv_name):
+        mapped_ty = arr_ty.subty
         if arr_ty.rust_obj == "LDKU128":
             return "org.ldk.util.UInt128 " + conv_name + " = new org.ldk.util.UInt128(" + arr_name + ");"
-        return None
+        elif mapped_ty.c_ty == "uint8_t" or mapped_ty.c_ty == "int8_t":
+            return "byte[] " + conv_name + " = InternalUtils.decodeUint8Array(" + arr_name + ");"
+        elif mapped_ty.c_ty == "uint16_t" or mapped_ty.c_ty == "int16_t":
+            return "short[] " + conv_name + " = InternalUtils.decodeUint16Array(" + arr_name + ");"
+        elif mapped_ty.c_ty == "uint64_t" or mapped_ty.c_ty == "int64_t":
+            return "long[] " + conv_name + " = InternalUtils.decodeUint64Array(" + arr_name + ");"
+        else:
+            assert False
 
     def java_arr_ty_str(self, elem_ty_str):
-        return elem_ty_str + "[]"
+        return "long"
 
     def for_n_in_range(self, n, minimum, maximum):
         return "for (int " + n + " = " + minimum + "; " + n + " < " + maximum + "; " + n + "++) {"
@@ -912,7 +969,10 @@ public class {struct_name.replace("LDK","")} : CommonBase {{
                 for arg_info in fn_line.args_ty:
                     fn_suffix += ty_to_c(arg_info.java_ty, arg_info)
                     fn_java_callback_args += ", " + arg_info.java_ty + " " + chr(ord("a") + idx)
-                    fn_c_callback_args += ", " + arg_info.c_ty + " " + chr(ord("a") + idx)
+                    if arg_info.c_ty.endswith("Array") or arg_info.c_ty == "jstring":
+                        fn_c_callback_args += ", int64_t " + chr(ord("a") + idx)
+                    else:
+                        fn_c_callback_args += ", " + arg_info.c_ty + " " + chr(ord("a") + idx)
                     if idx != 0:
                         fn_callback_call_args += ", "
                     fn_callback_call_args += chr(ord("a") + idx)
@@ -930,13 +990,16 @@ public class {struct_name.replace("LDK","")} : CommonBase {{
                     out_c += "\tuint64_t ret = js_invoke_function_" + fn_suffix + "(j_calls->instance_ptr, " + str(self.function_ptr_counter)
 
                 if fn_suffix not in self.function_ptrs:
-                    self.function_ptrs[fn_suffix] = {"args": [fn_java_callback_args, fn_c_callback_args], "ret": [fn_line.ret_ty_info.java_ty, fn_line.ret_ty_info.c_ty]}
+                    caller_ret_c_ty = fn_line.ret_ty_info.c_ty
+                    if fn_line.ret_ty_info.c_ty.endswith("Array") or fn_line.ret_ty_info.c_ty == "jstring":
+                        caller_ret_c_ty = "int64_t"
+                    self.function_ptrs[fn_suffix] = {"args": [fn_java_callback_args, fn_c_callback_args], "ret": [fn_line.ret_ty_info.java_ty, caller_ret_c_ty]}
                 self.function_ptrs[fn_suffix][self.function_ptr_counter] = (struct_name, fn_line.fn_name, fn_callback_call_args)
                 self.function_ptr_counter += 1
 
                 for idx, arg_info in enumerate(fn_line.args_ty):
                     if arg_info.ret_conv is not None:
-                        if arg_info.c_ty.endswith("Array"):
+                        if arg_info.c_ty.endswith("Array") or arg_info.c_ty == "jstring":
                             out_c += ", (int64_t)" + arg_info.ret_conv_name
                         else:
                             out_c += ", " + arg_info.ret_conv_name
@@ -1092,7 +1155,7 @@ public class {struct_name.replace("LDK","")} : CommonBase {{
                 fn_name = f"{struct_name}_{var.var_name}_get_{field_map.arg_name}"
                 out_c += self.c_fn_ty_pfx + field_map.c_ty + self.c_fn_name_define_pfx(fn_name, True) + self.ptr_c_ty + " ptr) {\n"
                 out_c += "\t" + struct_name + " *obj = (" + struct_name + "*)untag_ptr(ptr);\n"
-                out_c += f"\tassert(obj->tag == {struct_name}_{var.var_name});\n"
+                out_c += f"\tCHECK(obj->tag == {struct_name}_{var.var_name});\n"
                 if field_map.ret_conv is not None:
                     out_c += ("\t" + field_map.ret_conv[0].replace("\n", "\n\t"))
                     if var.tuple_variant:
@@ -1201,8 +1264,6 @@ public class {struct_name.replace("LDK","")} : CommonBase {{
                 out_c += (", ")
             if arg_conv_info.c_ty != "void":
                 out_c += (arg_conv_info.c_ty + " " + arg_conv_info.arg_name)
-                if "[]" in arg_conv_info.java_ty:
-                    out_java += "[MarshalAs(UnmanagedType.CustomMarshaler, MarshalType=\"org.ldk.impl.ArrayCoder\")] "
                 out_java += (arg_conv_info.java_ty + " _" + arg_conv_info.arg_name) # Add a _ to avoid using reserved words
 
         out_java_struct = ""
@@ -1423,10 +1484,11 @@ public class {struct_name.replace("LDK","")} : CommonBase {{
                }}
        }}
        public delegate {jret} {fn_suffix}_callback(int obj_ptr, int fn_id{jargs});
+       static {fn_suffix}_callback {fn_suffix}_callback_inst = c_callback_{fn_suffix};
 """)
                 bindings.write(self.native_meth_decl(f"register_{fn_suffix}_invoker", "int") + f"({fn_suffix}_callback callee);\n")
                 # Easiest way to get a static run is just define a variable, even if we dont care
-                bindings.write(f"\tstatic int _run_{fn_suffix}_registration = register_{fn_suffix}_invoker(c_callback_{fn_suffix});")
+                bindings.write(f"\tstatic int _run_{fn_suffix}_registration = register_{fn_suffix}_invoker({fn_suffix}_callback_inst);")
 
             bindings.write("""
 }