_ Git - ldk-java/blob - gen_type_mapping.py

   1 from bindingstypes import ConvInfo
   2
   3 class TypeMappingGenerator:
   4
   5     def __init__(self, java_c_types, consts, opaque_structs, clone_fns, unitary_enums, trait_structs, complex_enums, result_types, tuple_types):
   6         # trick our way around circular imports
   7         self.java_c_types = java_c_types
   8         self.consts = consts
   9         self.opaque_structs = opaque_structs
  10         self.clone_fns = clone_fns
  11         self.unitary_enums = unitary_enums
  12         self.trait_structs = trait_structs
  13         self.complex_enums = complex_enums
  14         self.result_types = result_types
  15         self.tuple_types = tuple_types
  16
  17     def map_type(self, fn_arg, print_void, ret_arr_len, is_free, holds_ref):
  18         ty_info = self.java_c_types(fn_arg, ret_arr_len)
  19         mapped_info = self.map_type_with_info(ty_info, print_void, ret_arr_len, is_free, holds_ref)
  20         return mapped_info
  21
  22     def map_type_with_info(self, ty_info, print_void, ret_arr_len, is_free, holds_ref):
  23         if ty_info.c_ty == "void":
  24             if not print_void:
  25                 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
  26                     arg_conv = None, arg_conv_name = None, arg_conv_cleanup = None,
  27                     ret_conv = None, ret_conv_name = None, to_hu_conv = None, to_hu_conv_name = None, from_hu_conv = None)
  28         if ty_info.c_ty.endswith("Array"):
  29             arr_len = ty_info.arr_len
  30             if arr_len is not None:
  31                 arr_name = ty_info.var_name
  32             else:
  33                 arr_name = "ret"
  34                 arr_len = ret_arr_len
  35             if ty_info.c_ty == "int8_tArray":
  36                 (set_pfx, set_sfx) = self.consts.set_native_arr_contents(arr_name + "_arr", arr_len, ty_info)
  37                 ret_conv = ("int8_tArray " + arr_name + "_arr = " + self.consts.create_native_arr_call(arr_len, ty_info) + ";\n" + set_pfx, "")
  38                 arg_conv_cleanup = None
  39                 if not arr_len.isdigit():
  40                     arg_conv = ty_info.rust_obj + " " + arr_name + "_ref;\n"
  41                     arg_conv = arg_conv + arr_name + "_ref." + arr_len + " = " +  self.consts.get_native_arr_len_call[0] + arr_name + self.consts.get_native_arr_len_call[1] + ";\n"
  42                     if (not ty_info.is_ptr or not holds_ref) and ty_info.rust_obj != "LDKu8slice":
  43                         arg_conv = arg_conv + arr_name + "_ref." + ty_info.arr_access + " = MALLOC(" + arr_name + "_ref." + arr_len + ", \"" + ty_info.rust_obj + " Bytes\");\n"
  44                         arg_conv = arg_conv + self.consts.get_native_arr_contents(arr_name, arr_name + "_ref." + ty_info.arr_access, arr_name + "_ref." + arr_len, ty_info, True) + ";"
  45                     else:
  46                         arg_conv = arg_conv + arr_name + "_ref." + ty_info.arr_access + " = " + self.consts.get_native_arr_contents(arr_name, "NO_DEST", arr_name + "_ref." + arr_len, ty_info, False) + ";"
  47                         arg_conv_cleanup = self.consts.cleanup_native_arr_ref_contents(arr_name, arr_name + "_ref." + ty_info.arr_access, arr_name + "_ref." + arr_len, ty_info)
  48                     if ty_info.rust_obj == "LDKTransaction":
  49                         arg_conv = arg_conv + "\n" + arr_name + "_ref.data_is_owned = " + str(holds_ref).lower() + ";"
  50                     ret_conv = (ty_info.rust_obj + " " + arr_name + "_var = ", "")
  51                     ret_conv = (ret_conv[0], ";\nint8_tArray " + arr_name + "_arr = " + self.consts.create_native_arr_call(arr_name + "_var." + arr_len, ty_info) + ";\n")
  52                     (pfx, sfx) = self.consts.set_native_arr_contents(arr_name + "_arr", arr_name + "_var." + arr_len, ty_info)
  53                     ret_conv = (ret_conv[0], ret_conv[1] + pfx + arr_name + "_var." + ty_info.arr_access + sfx + ";")
  54                     if not holds_ref and ty_info.rust_obj != "LDKu8slice":
  55                         ret_conv = (ret_conv[0], ret_conv[1] + "\n" + ty_info.rust_obj.replace("LDK", "") + "_free(" + arr_name + "_var);")
  56                 elif ty_info.rust_obj is not None:
  57                     arg_conv = ty_info.rust_obj + " " + arr_name + "_ref;\n"
  58                     arg_conv = arg_conv + "CHECK(" + self.consts.get_native_arr_len_call[0] + arr_name + self.consts.get_native_arr_len_call[1] + " == " + arr_len + ");\n"
  59                     arg_conv = arg_conv + self.consts.get_native_arr_contents(arr_name, arr_name + "_ref." + ty_info.arr_access, arr_len, ty_info, True) + ";"
  60                     ret_conv = (ret_conv[0], "." + ty_info.arr_access + set_sfx + ";")
  61                 else:
  62                     arg_conv = "unsigned char " + arr_name + "_arr[" + arr_len + "];\n"
  63                     arg_conv = arg_conv + "CHECK(" + self.consts.get_native_arr_len_call[0] + arr_name + self.consts.get_native_arr_len_call[1] + " == " + arr_len + ");\n"
  64                     arg_conv = arg_conv + self.consts.get_native_arr_contents(arr_name, arr_name + "_arr", arr_len, ty_info, True) + ";\n"
  65                     arg_conv = arg_conv + "unsigned char (*" + arr_name + "_ref)[" + arr_len + "] = &" + arr_name + "_arr;"
  66                     ret_conv = (ret_conv[0] + "*", set_sfx + ";")
  67                 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
  68                     arg_conv = arg_conv, arg_conv_name = arr_name + "_ref", arg_conv_cleanup = arg_conv_cleanup,
  69                     ret_conv = ret_conv, ret_conv_name = arr_name + "_arr", to_hu_conv = None, to_hu_conv_name = None, from_hu_conv = None)
  70             else:
  71                 assert not arr_len.isdigit() # fixed length arrays not implemented
  72                 assert ty_info.java_ty[len(ty_info.java_ty) - 2:] == "[]"
  73                 if arr_name == "":
  74                     arr_name = "ret"
  75                 conv_name = arr_name + "_conv_" + str(len(ty_info.java_hu_ty))
  76                 idxc = chr(ord('a') + (len(ty_info.java_hu_ty) % 26))
  77                 ty_info.subty.var_name = conv_name
  78                 #XXX: We'd really prefer to only ever set to False, avoiding lots of clone, but need smarter free logic
  79                 #if ty_info.is_ptr or holds_ref:
  80                 #    ty_info.subty.requires_clone = False
  81                 ty_info.subty.requires_clone = not ty_info.is_ptr or not holds_ref
  82                 if not ty_info.subty.is_native_primitive and ty_info.subty.rust_obj == "LDKChannelMonitor":
  83                     # We take a Vec of references to ChannelMonitors as input to ChannelManagerReadArgs, if we clone them,
  84                     # we end up freeing the clones after creating the ChannelManagerReadArgs before calling the read
  85                     # function itself, resulting in a segfault. Thus, we manually check and ensure we don't clone for
  86                     # ChannelMonitors inside of vecs.
  87                     ty_info.subty.requires_clone = False
  88                 subty = self.map_type_with_info(ty_info.subty, False, None, is_free, holds_ref)
  89                 arg_conv = ty_info.rust_obj + " " + arr_name + "_constr;\n"
  90                 pf = ""
  91                 if ty_info.is_ptr:
  92                     pf = "\t"
  93                     arg_conv += ty_info.rust_obj + " *" + arr_name + "_ptr = NULL;\n"
  94                     arg_conv += "if (" + self.consts.is_arr_some_check[0] + arr_name + self.consts.is_arr_some_check[1] + ") {\n"
  95                 arg_conv += pf + arr_name + "_constr." + arr_len + " = " + self.consts.get_native_arr_len_call[0] + arr_name + self.consts.get_native_arr_len_call[1] + ";\n"
  96                 arg_conv += pf + "if (" + arr_name + "_constr." + arr_len + " > 0)\n"
  97                 if subty.is_native_primitive:
  98                     szof = subty.c_ty
  99                 else:
 100                     szof = subty.rust_obj
 101                 arg_conv += pf + "\t" + arr_name + "_constr." + ty_info.arr_access + " = MALLOC(" + arr_name + "_constr." + arr_len + " * sizeof(" + szof + "), \"" + ty_info.rust_obj + " Elements\");\n"
 102                 arg_conv += pf + "else\n"
 103                 arg_conv += pf + "\t" + arr_name + "_constr." + ty_info.arr_access + " = NULL;\n"
 104                 get_arr = self.consts.get_native_arr_contents(arr_name, "NO_DEST", arr_name + "_constr." + arr_len, ty_info, False)
 105                 if get_arr != None:
 106                     arg_conv += pf + subty.c_ty + "* " + arr_name + "_vals = " + get_arr + ";\n"
 107                 arg_conv += pf + "for (size_t " + idxc + " = 0; " + idxc + " < " + arr_name + "_constr." + arr_len + "; " + idxc + "++) {\n"
 108                 if get_arr != None:
 109                     arg_conv += pf + "\t" + subty.c_ty + " " + conv_name + " = " + arr_name + "_vals[" + idxc + "];"
 110                     if subty.arg_conv is not None:
 111                         arg_conv += "\n\t" + pf + subty.arg_conv.replace("\n", "\n\t" + pf)
 112                 else:
 113                     arg_conv += pf + "\t" + subty.c_ty + " " + conv_name + " = " + self.consts.get_native_arr_elem(arr_name, idxc, ty_info) + ";\n"
 114                     arg_conv += pf + "\t" + subty.arg_conv.replace("\n", "\n\t" + pf)
 115                 arg_conv += "\n\t" + pf + arr_name + "_constr." + ty_info.arr_access + "[" + idxc + "] = " + subty.arg_conv_name + ";\n" + pf + "}"
 116                 if get_arr != None:
 117                     cleanup = self.consts.cleanup_native_arr_ref_contents(arr_name, arr_name + "_vals", arr_name + "_constr." + arr_len, ty_info)
 118                     if cleanup is not None:
 119                         arg_conv += "\n" + pf + cleanup + ";"
 120                 if ty_info.is_ptr:
 121                     arg_conv_name = arr_name + "_ptr"
 122                 else:
 123                     arg_conv_name = arr_name + "_constr"
 124                 arg_conv_cleanup = None
 125                 if ty_info.is_ptr:
 126                     arg_conv_cleanup = "if (" + arr_name + "_ptr != NULL) { FREE(" + arr_name + "_constr." + ty_info.arr_access + "); }"
 127                 if ty_info.is_ptr:
 128                     arg_conv += "\n\t" + arr_name + "_ptr = &" + arr_name + "_constr;\n}"
 129
 130                 ret_conv = (ty_info.rust_obj + " " + arr_name + "_var = ", "")
 131                 if subty.ret_conv is None:
 132                     ret_conv = ("DUMMY", "DUMMY")
 133                 else:
 134                     ret_conv = (ret_conv[0], ";\n" + ty_info.c_ty + " " + arr_name + "_arr = " + self.consts.create_native_arr_call(arr_name + "_var." + arr_len, ty_info) + ";\n")
 135                     get_ptr_call = self.consts.get_native_arr_ptr_call(ty_info)
 136                     if get_ptr_call is not None:
 137                         ret_conv = (ret_conv[0], ret_conv[1] + subty.c_ty + " *" + arr_name + "_arr_ptr = " + get_ptr_call[0] + arr_name + "_arr" + get_ptr_call[1] + ";\n")
 138                     ret_conv = (ret_conv[0], ret_conv[1] + "for (size_t " + idxc + " = 0; " + idxc + " < " + arr_name + "_var." + arr_len + "; " + idxc + "++) {\n")
 139                     ret_conv = (ret_conv[0], ret_conv[1] + "\t" + subty.ret_conv[0].replace("\n", "\n\t"))
 140                     ret_conv = (ret_conv[0], ret_conv[1] + arr_name + "_var." + ty_info.arr_access + "[" + idxc + "]" + subty.ret_conv[1].replace("\n", "\n\t"))
 141                     if get_ptr_call is not None:
 142                         ret_conv = (ret_conv[0], ret_conv[1] + "\n\t" + arr_name + "_arr_ptr[" + idxc + "] = " + subty.ret_conv_name + ";\n}")
 143                     else:
 144                         ret_conv = (ret_conv[0], ret_conv[1] + "\n\t" + self.consts.get_native_arr_entry_call(ty_info, arr_name + "_arr", idxc, subty.ret_conv_name) + ";\n}")
 145                     cleanup = self.consts.release_native_arr_ptr_call(ty_info, arr_name + "_arr", arr_name + "_arr_ptr")
 146                     if cleanup is not None:
 147                         ret_conv = (ret_conv[0], ret_conv[1] + "\n" + cleanup + ";")
 148                 if not holds_ref:
 149                     # XXX: The commented if's are a bit smarter freeing, but we need to be a nudge smarter still
 150                     # Note that we don't drop the full vec here - we're passing ownership to java (or have cloned) or free'd by now!
 151                     ret_conv = (ret_conv[0], ret_conv[1] + "\nFREE(" + arr_name + "_var." + ty_info.arr_access + ");")
 152                     #if subty.rust_obj is not None and subty.rust_obj in self.opaque_structs:
 153                     #    ret_conv = (ret_conv[0], ret_conv[1] + "\nFREE(" + arr_name + "_var." + ty_info.arr_access + ");")
 154                     #else:
 155                     #    ret_conv = (ret_conv[0], ret_conv[1] + "\n" + ty_info.rust_obj.replace("LDK", "") + "_free(" + arr_name + "_var);")
 156
 157                 to_hu_conv = None
 158                 to_hu_conv_name = None
 159                 if subty.to_hu_conv is not None:
 160                     base_ty = ty_info.subty.java_hu_ty.split("[")[0].split("<")[0]
 161                     to_hu_conv = ty_info.java_hu_ty + " " + conv_name + "_arr = new " + base_ty + "[" + arr_name + ".length]"
 162                     if "[" in ty_info.subty.java_hu_ty.split("<")[0]:
 163                         # Do a bit of a dance to move any excess [] to the end
 164                         to_hu_conv += "[" + ty_info.subty.java_hu_ty.split("<")[0].split("[")[1]
 165                     to_hu_conv += ";\nfor (int " + idxc + " = 0; " + idxc + " < " + arr_name + ".length; " + idxc + "++) {\n"
 166                     to_hu_conv += "\t" + subty.java_ty + " " + conv_name + " = " + arr_name + "[" + idxc + "];\n"
 167                     to_hu_conv += "\t" + subty.to_hu_conv.replace("\n", "\n\t") + "\n"
 168                     to_hu_conv += "\t" + conv_name + "_arr[" + idxc + "] = " + subty.to_hu_conv_name + ";\n}"
 169                     to_hu_conv_name = conv_name + "_arr"
 170                 from_hu_conv = None
 171                 if subty.from_hu_conv is not None:
 172                     hu_conv_b = ""
 173                     if subty.from_hu_conv[1] != "":
 174                         hu_conv_b = "for (" + subty.java_hu_ty + " " + conv_name + ": " + arr_name + ") { " + subty.from_hu_conv[1] + "; }"
 175                     if subty.java_ty == "long" and subty.java_hu_ty != "long":
 176                         from_hu_conv = (arr_name + " != null ? Arrays.stream(" + arr_name + ").mapToLong(" + conv_name + " -> " + subty.from_hu_conv[0] + ").toArray() : null",
 177                             hu_conv_b)
 178                     elif subty.java_ty == "long":
 179                         from_hu_conv = (arr_name + " != null ? Arrays.stream(" + arr_name + ").map(" + conv_name + " -> " + subty.from_hu_conv[0] + ").toArray() : null", "/* TODO 2 " + subty.java_hu_ty + "  */")
 180                     else:
 181                         from_hu_conv = (arr_name + " != null ? Arrays.stream(" + arr_name + ").map(" + conv_name + " -> " + subty.from_hu_conv[0] + ").toArray(" + ty_info.java_ty + "::new) : null",
 182                             hu_conv_b)
 183
 184                 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 185                     arg_conv = arg_conv, arg_conv_name = arg_conv_name, arg_conv_cleanup = arg_conv_cleanup,
 186                     ret_conv = ret_conv, ret_conv_name = arr_name + "_arr", to_hu_conv = to_hu_conv, to_hu_conv_name = to_hu_conv_name, from_hu_conv = from_hu_conv)
 187         elif ty_info.java_ty == "String":
 188             if not is_free:
 189                 arg_conv = "LDKStr " + ty_info.var_name + "_conv = " + self.consts.str_ref_to_c_call(ty_info.var_name) + ";"
 190                 arg_conv_name = ty_info.var_name + "_conv"
 191             else:
 192                 arg_conv = "LDKStr dummy = { .chars = NULL, .len = 0, .chars_is_owned = false };"
 193                 arg_conv_name = "dummy"
 194             if ty_info.arr_access is None:
 195                 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 196                     arg_conv = arg_conv, arg_conv_name = arg_conv_name, arg_conv_cleanup = None,
 197                     ret_conv = ("const char* " + ty_info.var_name + "_str = ",
 198                         ";\njstring " + ty_info.var_name + "_conv = " + self.consts.str_ref_to_native_call(ty_info.var_name + "_str", "strlen(" + ty_info.var_name + "_str)") + ";"),
 199                     ret_conv_name = ty_info.var_name + "_conv",
 200                     to_hu_conv = None, to_hu_conv_name = None, from_hu_conv = None)
 201             else:
 202                 free_str = ""
 203                 if not holds_ref:
 204                     free_str = "\nStr_free(" + ty_info.var_name + "_str);"
 205                 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 206                     arg_conv = arg_conv, arg_conv_name = arg_conv_name, arg_conv_cleanup = None,
 207                     ret_conv = ("LDKStr " + ty_info.var_name + "_str = ",
 208                         ";\njstring " + ty_info.var_name + "_conv = " + self.consts.str_ref_to_native_call(ty_info.var_name + "_str." + ty_info.arr_access, ty_info.var_name + "_str." + ty_info.arr_len) + ";" + free_str),
 209                     ret_conv_name = ty_info.var_name + "_conv", to_hu_conv = None, to_hu_conv_name = None, from_hu_conv = None)
 210         elif ty_info.var_name == "" and not print_void:
 211             # We don't have a parameter name, and want one, just call it arg
 212             if not ty_info.is_native_primitive:
 213                 assert(not is_free or ty_info.rust_obj not in self.opaque_structs)
 214                 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 215                     arg_conv = ty_info.rust_obj + " arg_conv = *(" + ty_info.rust_obj + "*)arg;\nFREE((void*)arg);",
 216                     arg_conv_name = "arg_conv", arg_conv_cleanup = None,
 217                     ret_conv = None, ret_conv_name = None, to_hu_conv = "TODO 7", to_hu_conv_name = None, from_hu_conv = None)
 218             else:
 219                 assert(not is_free)
 220                 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 221                     arg_conv = None, arg_conv_name = "arg", arg_conv_cleanup = None,
 222                     ret_conv = None, ret_conv_name = None, to_hu_conv = "TODO 8", to_hu_conv_name = None, from_hu_conv = None)
 223         elif ty_info.is_native_primitive:
 224             return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 225                 arg_conv = None, arg_conv_name = ty_info.var_name, arg_conv_cleanup = None,
 226                 ret_conv = None, ret_conv_name = None, to_hu_conv = None, to_hu_conv_name = None, from_hu_conv = None)
 227         else:
 228             if ty_info.var_name == "":
 229                 ty_info.var_name = "ret"
 230
 231             if ty_info.rust_obj in self.opaque_structs:
 232                 from_hu_conv = (ty_info.var_name + " == null ? 0 : " + ty_info.var_name + ".ptr & ~1", "this.ptrs_to.add(" + ty_info.var_name + ")")
 233                 opaque_arg_conv = ty_info.rust_obj + " " + ty_info.var_name + "_conv;\n"
 234                 opaque_arg_conv = opaque_arg_conv + ty_info.var_name + "_conv.inner = (void*)(" + ty_info.var_name + " & (~1));\n"
 235                 if ty_info.is_ptr and holds_ref:
 236                     opaque_arg_conv = opaque_arg_conv + ty_info.var_name + "_conv.is_owned = false;"
 237                 else:
 238                     opaque_arg_conv = opaque_arg_conv + ty_info.var_name + "_conv.is_owned = (" + ty_info.var_name + " & 1) || (" + ty_info.var_name + " == 0);"
 239                 if not is_free and (not ty_info.is_ptr or not holds_ref or ty_info.requires_clone == True) and ty_info.requires_clone != False:
 240                     if (ty_info.rust_obj.replace("LDK", "") + "_clone") in self.clone_fns:
 241                         # TODO: This is a bit too naive, even with the checks above, we really need to know if rust wants a ref or not, not just if its pass as a ptr.
 242                         opaque_arg_conv = opaque_arg_conv + "\n" + ty_info.var_name + "_conv = " + ty_info.rust_obj.replace("LDK", "") + "_clone(&" + ty_info.var_name + "_conv);"
 243                         from_hu_conv = (from_hu_conv[0], "")
 244                     elif ty_info.passed_as_ptr:
 245                         opaque_arg_conv = opaque_arg_conv + "\n// Warning: we need a move here but no clone is available for " + ty_info.rust_obj
 246                         # TODO: Once we support features cloning (which just isn't in C yet), we can make this a compile error instead!
 247                         from_hu_conv = (from_hu_conv[0], from_hu_conv[1] + ";\n" +
 248                             "// Due to rust's strict-ownership memory model, in some cases we need to \"move\"\n" +
 249                             "// an object to pass exclusive ownership to the function being called.\n" +
 250                             "// In most cases, we avoid this being visible in GC'd languages by cloning the object\n" +
 251                             "// at the FFI layer, creating a new object which Rust can claim ownership of\n" +
 252                             "// However, in some cases (eg here), there is no way to clone an object, and thus\n" +
 253                             "// we actually have to pass full ownership to Rust.\n" +
 254                             "// Thus, after this call, " + ty_info.var_name + " is reset to null and is now a dummy object.\n" + ty_info.var_name + ".ptr = 0")
 255
 256                 opaque_ret_conv_suf = ";\n"
 257                 if not holds_ref and ty_info.is_ptr and (ty_info.rust_obj.replace("LDK", "") + "_clone") in self.clone_fns: # is_ptr, not holds_ref implies passing a pointed-to value to java, which needs copied
 258                     opaque_ret_conv_suf = opaque_ret_conv_suf + ty_info.var_name + "_var = " + ty_info.rust_obj.replace("LDK", "") + "_clone(" + ty_info.var_name + ");\n"
 259                 elif not holds_ref and ty_info.is_ptr:
 260                     opaque_ret_conv_suf = opaque_ret_conv_suf + "// Warning: we may need a move here but no clone is available for " + ty_info.rust_obj + "\n"
 261
 262                 opaque_ret_conv_suf = opaque_ret_conv_suf + "CHECK((((uint64_t)" + ty_info.var_name + "_var.inner) & 1) == 0); // We rely on a free low bit, malloc guarantees this.\n"
 263                 opaque_ret_conv_suf = opaque_ret_conv_suf + "CHECK((((uint64_t)&" + ty_info.var_name + "_var) & 1) == 0); // We rely on a free low bit, pointer alignment guarantees this.\n"
 264                 if holds_ref:
 265                     opaque_ret_conv_suf = opaque_ret_conv_suf + "uint64_t " + ty_info.var_name + "_ref = (uint64_t)" + ty_info.var_name + "_var.inner & ~1;"
 266                 else:
 267                     opaque_ret_conv_suf = opaque_ret_conv_suf + "uint64_t " + ty_info.var_name + "_ref = (uint64_t)" + ty_info.var_name + "_var.inner;\n"
 268                     opaque_ret_conv_suf = opaque_ret_conv_suf + "if (" + ty_info.var_name + "_var.is_owned) {\n"
 269                     opaque_ret_conv_suf = opaque_ret_conv_suf + "\t" + ty_info.var_name + "_ref |= 1;\n"
 270                     opaque_ret_conv_suf = opaque_ret_conv_suf + "}"
 271
 272                 to_hu_conv_sfx = ""
 273                 if not ty_info.is_ptr or holds_ref:
 274                     to_hu_conv_sfx = "\n" + ty_info.var_name + "_hu_conv.ptrs_to.add(this);"
 275                 if ty_info.is_ptr:
 276                     return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 277                         arg_conv = opaque_arg_conv, arg_conv_name = "&" + ty_info.var_name + "_conv", arg_conv_cleanup = None,
 278                         ret_conv = (ty_info.rust_obj + " " + ty_info.var_name + "_var = *", opaque_ret_conv_suf),
 279                         ret_conv_name = ty_info.var_name + "_ref",
 280                         to_hu_conv = self.consts.to_hu_conv_templates['ptr'].replace('{human_type}', ty_info.java_hu_ty).replace('{var_name}', ty_info.var_name) + to_hu_conv_sfx,
 281                         to_hu_conv_name = ty_info.var_name + "_hu_conv",
 282                         from_hu_conv = from_hu_conv)
 283                 else:
 284                     return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 285                         arg_conv = opaque_arg_conv, arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
 286                         ret_conv = (ty_info.rust_obj + " " + ty_info.var_name + "_var = ", opaque_ret_conv_suf),
 287                         ret_conv_name = ty_info.var_name + "_ref",
 288                         to_hu_conv = self.consts.to_hu_conv_templates['default'].replace('{human_type}', ty_info.java_hu_ty).replace('{var_name}', ty_info.var_name) + to_hu_conv_sfx,
 289                         to_hu_conv_name = ty_info.var_name + "_hu_conv",
 290                         from_hu_conv = from_hu_conv)
 291
 292             if not ty_info.is_ptr:
 293                 if ty_info.rust_obj in self.unitary_enums:
 294                     (ret_pfx, ret_sfx) = self.consts.c_unitary_enum_to_native_call(ty_info)
 295                     (arg_pfx, arg_sfx) = self.consts.native_unitary_enum_to_c_call(ty_info)
 296                     return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 297                         arg_conv = ty_info.rust_obj + " " + ty_info.var_name + "_conv = " + arg_pfx + ty_info.var_name + arg_sfx + ";",
 298                         arg_conv_name = ty_info.var_name + "_conv",
 299                         arg_conv_cleanup = None,
 300                         ret_conv = (ty_info.c_ty + " " + ty_info.var_name + "_conv = " + ret_pfx, ret_sfx + ";"),
 301                         ret_conv_name = ty_info.var_name + "_conv", to_hu_conv = None, to_hu_conv_name = None, from_hu_conv = None)
 302                 base_conv = "void* " + ty_info.var_name + "_ptr = (void*)(((uint64_t)" + ty_info.var_name + ") & ~1);\n"
 303                 base_conv += "CHECK_ACCESS(" + ty_info.var_name + "_ptr);\n"
 304                 base_conv += ty_info.rust_obj + " " + ty_info.var_name + "_conv = *(" + ty_info.rust_obj + "*)(" + ty_info.var_name + "_ptr);"
 305                 if ty_info.rust_obj in self.trait_structs:
 306                     ret_conv = (ty_info.rust_obj + "* " + ty_info.var_name + "_ret =MALLOC(sizeof(" + ty_info.rust_obj + "), \"" + ty_info.rust_obj + "\");\n*" + ty_info.var_name + "_ret = ", ";")
 307                     if holds_ref:
 308                         if (ty_info.rust_obj.replace("LDK", "") + "_clone") in self.clone_fns:
 309                             ret_conv = (ret_conv[0] + ty_info.rust_obj.replace("LDK", "") + "_clone(&", ");")
 310                         else:
 311                             ret_conv = (ret_conv[0], ";\n// Warning: We likely need to clone here, but no clone is available, so we just do it for Java instances")
 312                             ret_conv = (ret_conv[0], ret_conv[1] + "" + self.consts.trait_struct_inc_refcnt(ty_info).replace(ty_info.var_name + "_conv", "(*" + ty_info.var_name + "_ret)"))
 313                     if not is_free:
 314                         needs_full_clone = not is_free and (not ty_info.is_ptr and not holds_ref or ty_info.requires_clone == True) and ty_info.requires_clone != False
 315                         if needs_full_clone and (ty_info.rust_obj.replace("LDK", "") + "_clone") in self.clone_fns:
 316                             base_conv = base_conv + "\n" + ty_info.var_name + "_conv = " + ty_info.rust_obj.replace("LDK", "") + "_clone(&" + ty_info.var_name + "_conv);"
 317                         else:
 318                             base_conv = base_conv + self.consts.trait_struct_inc_refcnt(ty_info)
 319                             if needs_full_clone:
 320                                 base_conv = base_conv + "// Warning: we may need a move here but no clone is available for " + ty_info.rust_obj + "\n"
 321                     else:
 322                         base_conv = base_conv + "\n" + "FREE((void*)" + ty_info.var_name + ");"
 323                     return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 324                         arg_conv = base_conv, arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
 325                         ret_conv = ret_conv, ret_conv_name = "(uint64_t)" + ty_info.var_name + "_ret",
 326                         to_hu_conv = ty_info.java_hu_ty + " ret_hu_conv = new " + ty_info.java_hu_ty + "(null, " + ty_info.var_name + ");\nret_hu_conv.ptrs_to.add(this);",
 327                         to_hu_conv_name = "ret_hu_conv",
 328                         from_hu_conv = (ty_info.var_name + " == null ? 0 : " + ty_info.var_name + ".ptr", "this.ptrs_to.add(" + ty_info.var_name + ")"))
 329                 needs_full_clone = not is_free and (not ty_info.is_ptr or ty_info.requires_clone == True) and ty_info.requires_clone != False
 330                 if needs_full_clone:
 331                     if "res" in ty_info.var_name: # XXX: This is a stupid hack
 332                         needs_full_clone = False
 333                     if needs_full_clone and (ty_info.rust_obj.replace("LDK", "") + "_clone") in self.clone_fns:
 334                         base_conv = base_conv + "\n" + ty_info.var_name + "_conv = " + ty_info.rust_obj.replace("LDK", "") + "_clone((" + ty_info.rust_obj + "*)(((uint64_t)" + ty_info.var_name + ") & ~1));"
 335                     elif needs_full_clone:
 336                         base_conv = base_conv + "\n// Warning: we may need a move here but no clone is available for " + ty_info.rust_obj
 337                 if not needs_full_clone and ty_info.rust_obj != "LDKu8slice" and (not holds_ref or is_free):
 338                     # Don't bother free'ing slices passed in - Rust doesn't auto-free the
 339                     # underlying unlike Vecs, and it gives Java more freedom.
 340                     base_conv = base_conv + "\nFREE((void*)" + ty_info.var_name + ");"
 341                 if ty_info.rust_obj in self.complex_enums:
 342                     if needs_full_clone and (ty_info.rust_obj.replace("LDK", "") + "_clone") not in self.clone_fns:
 343                         # We really need a full clone here, but for now we just implement
 344                         # a manual clone explicitly for Option<Trait>s
 345                         if ty_info.rust_obj.startswith("LDKCOption"):
 346                             optional_ty = ty_info.rust_obj[11:-1]
 347                             if "LDK" + optional_ty in self.trait_structs:
 348                                 base_conv += "\nif (" + ty_info.var_name + "_conv.tag == " + ty_info.rust_obj + "_Some) {"
 349                                 base_conv += "\n\t// Manually implement clone for Java trait instances"
 350                                 optional_ty_info = self.java_c_types("LDK" + optional_ty + " " + ty_info.var_name, None)
 351                                 base_conv += self.consts.trait_struct_inc_refcnt(optional_ty_info).\
 352                                     replace("\n", "\n\t").replace(ty_info.var_name + "_conv", ty_info.var_name + "_conv.some")
 353                                 base_conv += "\n}"
 354                     ret_conv = ("uint64_t " + ty_info.var_name + "_ref = ((uint64_t)&", ") | 1;")
 355                     if not holds_ref:
 356                         ret_conv = (ty_info.rust_obj + " *" + ty_info.var_name + "_copy = MALLOC(sizeof(" + ty_info.rust_obj + "), \"" + ty_info.rust_obj + "\");\n", "")
 357                         ret_conv = (ret_conv[0] + "*" + ty_info.var_name + "_copy = ", "")
 358                         ret_conv = (ret_conv[0], ";\nuint64_t " + ty_info.var_name + "_ref = (uint64_t)" + ty_info.var_name + "_copy;")
 359                     return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 360                         arg_conv = base_conv, arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
 361                         ret_conv = ret_conv, ret_conv_name = ty_info.var_name + "_ref",
 362                         to_hu_conv = ty_info.java_hu_ty + " " + ty_info.var_name + "_hu_conv = " + ty_info.java_hu_ty + ".constr_from_ptr(" + ty_info.var_name + ");\n" + ty_info.var_name + "_hu_conv.ptrs_to.add(this);",
 363                         to_hu_conv_name = ty_info.var_name + "_hu_conv", from_hu_conv = (ty_info.var_name + ".ptr", ""))
 364                 if ty_info.rust_obj in self.result_types:
 365                     if holds_ref:
 366                         # If we're trying to return a ref, we have to clone.
 367                         # We just blindly assume its implemented and let the compiler fail if its not.
 368                         ret_conv = (ty_info.rust_obj + "* " + ty_info.var_name + "_conv = MALLOC(sizeof(" + ty_info.rust_obj + "), \"" + ty_info.rust_obj + "\");\n*" + ty_info.var_name + "_conv = ", ";")
 369                         ret_conv = (ret_conv[0], ret_conv[1] + "\n*" + ty_info.var_name + "_conv = " + ty_info.rust_obj.replace("LDK", "") + "_clone(" + ty_info.var_name + "_conv);")
 370                     else:
 371                         ret_conv = (ty_info.rust_obj + "* " + ty_info.var_name + "_conv = MALLOC(sizeof(" + ty_info.rust_obj + "), \"" + ty_info.rust_obj + "\");\n*" + ty_info.var_name + "_conv = ", ";")
 372                     return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 373                         arg_conv = base_conv, arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
 374                         ret_conv = ret_conv, ret_conv_name = "(uint64_t)" + ty_info.var_name + "_conv",
 375                         to_hu_conv = ty_info.java_hu_ty + " " + ty_info.var_name + "_hu_conv = " + ty_info.java_hu_ty + ".constr_from_ptr(" + ty_info.var_name + ");",
 376                         to_hu_conv_name = ty_info.var_name + "_hu_conv", from_hu_conv = (ty_info.var_name + " != null ? " + ty_info.var_name + ".ptr : 0", ""))
 377                 if ty_info.rust_obj in self.tuple_types:
 378                     ret_conv_name = "((uint64_t)" + ty_info.var_name + "_conv)"
 379                     if holds_ref:
 380                         # If we're trying to return a ref, we have to clone.
 381                         # We just blindly assume its implemented and let the compiler fail if its not.
 382                         ret_conv = (ty_info.rust_obj + "* " + ty_info.var_name + "_conv = MALLOC(sizeof(" + ty_info.rust_obj + "), \"" + ty_info.rust_obj + "\");\n*" + ty_info.var_name + "_conv = ", ";")
 383                         if (ty_info.rust_obj.replace("LDK", "") + "_clone") not in self.clone_fns:
 384                             ret_conv = (ret_conv[0], ret_conv[1] + "\n// Warning: we really need to clone here, but no clone is available for " + ty_info.rust_obj)
 385                             ret_conv_name += " | 1"
 386                         else:
 387                             ret_conv = (ret_conv[0], ret_conv[1] + "\n*" + ty_info.var_name + "_conv = " + ty_info.rust_obj.replace("LDK", "") + "_clone(" + ty_info.var_name + "_conv);")
 388                     else:
 389                         ret_conv = (ty_info.rust_obj + "* " + ty_info.var_name + "_conv = MALLOC(sizeof(" + ty_info.rust_obj + "), \"" + ty_info.rust_obj + "\");\n*" + ty_info.var_name + "_conv = ", ";")
 390                     if not ty_info.is_ptr or holds_ref:
 391                         to_hu_conv_sfx = "\n" + ty_info.var_name + "_hu_conv.ptrs_to.add(this);"
 392                     else:
 393                         to_hu_conv_sfx = ""
 394                     return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 395                         arg_conv = base_conv, arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
 396                         ret_conv = ret_conv, ret_conv_name = ret_conv_name,
 397                         to_hu_conv = ty_info.java_hu_ty + " " + ty_info.var_name + "_hu_conv = new " + ty_info.java_hu_ty + "(null, " + ty_info.var_name + ");" + to_hu_conv_sfx,
 398                         to_hu_conv_name = ty_info.var_name + "_hu_conv", from_hu_conv = (ty_info.var_name + " != null ? " + ty_info.var_name + ".ptr : 0", ""))
 399
 400                 # The manually-defined types - TxOut and u5
 401                 if ty_info.rust_obj == "LDKu5":
 402                     return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 403                         arg_conv = "", arg_conv_name = "(LDKu5){ ._0 = " + ty_info.var_name + " }", arg_conv_cleanup = None,
 404                         ret_conv = ("uint8_t " + ty_info.var_name + "_val = ", "._0;"), ret_conv_name = ty_info.var_name + "_val",
 405                         to_hu_conv = ty_info.java_hu_ty + " " + ty_info.var_name + "_conv = new " + ty_info.java_hu_ty + "(" + ty_info.var_name + ");",
 406                         to_hu_conv_name = ty_info.var_name + "_conv", from_hu_conv = (ty_info.var_name + ".getVal()", ""))
 407
 408                 assert ty_info.rust_obj == "LDKTxOut"
 409                 if not ty_info.is_ptr and not holds_ref:
 410                     ret_conv = ("LDKTxOut* " + ty_info.var_name + "_ref = MALLOC(sizeof(LDKTxOut), \"LDKTxOut\");\n*" + ty_info.var_name + "_ref = ", ";")
 411                 else:
 412                     ret_conv = ("uint64_t " + ty_info.var_name + "_ref = ((uint64_t)&", ") | 1;")
 413                 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 414                     arg_conv = base_conv, arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
 415                     ret_conv = ret_conv, ret_conv_name = "(uint64_t)" + ty_info.var_name + "_ref",
 416                     to_hu_conv = ty_info.java_hu_ty + " " + ty_info.var_name + "_conv = new " +ty_info.java_hu_ty + "(null, " + ty_info.var_name + ");",
 417                     to_hu_conv_name = ty_info.var_name + "_conv", from_hu_conv = (ty_info.var_name + ".ptr", ""))
 418             elif ty_info.is_ptr:
 419                 assert(not is_free)
 420                 if ty_info.rust_obj in self.complex_enums:
 421                     ret_conv = ("uint64_t ret_" + ty_info.var_name + " = (uint64_t)", " | 1; // Warning: We should clone here!")
 422                     from_hu_sfx = "this.ptrs_to.add(" + ty_info.var_name + ")"
 423                     if ty_info.rust_obj.replace("LDK", "") + "_clone" in self.clone_fns:
 424                         ret_conv_pfx = ty_info.rust_obj + " *ret_" + ty_info.var_name + " = MALLOC(sizeof(" + ty_info.rust_obj + "), \"" + ty_info.rust_obj + " ret conversion\");\n"
 425                         ret_conv_pfx += "*ret_" + ty_info.var_name + " = " + ty_info.rust_obj.replace("LDK", "") + "_clone("
 426                         ret_conv = (ret_conv_pfx, ");")
 427                         from_hu_sfx = ""
 428                     return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 429                         arg_conv = ty_info.rust_obj + "* " + ty_info.var_name + "_conv = (" + ty_info.rust_obj + "*)" + ty_info.var_name + ";",
 430                         arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
 431                         ret_conv = ret_conv, ret_conv_name = "(uint64_t)ret_" + ty_info.var_name,
 432                         to_hu_conv = ty_info.java_hu_ty + " " + ty_info.var_name + "_hu_conv = " + ty_info.java_hu_ty + ".constr_from_ptr(" + ty_info.var_name + ");",
 433                         to_hu_conv_name = ty_info.var_name + "_hu_conv",
 434                         from_hu_conv = (ty_info.var_name + " == null ? 0 : " + ty_info.var_name + ".ptr & ~1", from_hu_sfx))
 435                 elif ty_info.rust_obj in self.trait_structs:
 436                     if ty_info.nonnull_ptr:
 437                         arg_conv = "void* " + ty_info.var_name + "_ptr = (void*)(((uint64_t)" + ty_info.var_name + ") & ~1);\n"
 438                         arg_conv += "if (!(" + ty_info.var_name + " & 1)) { CHECK_ACCESS(" + ty_info.var_name + "_ptr); }\n"
 439                         arg_conv += ty_info.rust_obj + "* " + ty_info.var_name + "_conv = (" + ty_info.rust_obj + "*)" + ty_info.var_name + "_ptr;"
 440                         arg_conv_name = ty_info.var_name + "_conv"
 441                     else:
 442                         # We map Option<Trait> as *mut Trait, which we can differentiate from &Trait by the NONNULL_PTR annotation.
 443                         # We handle the Option<Trait> case here.
 444                         arg_conv = ty_info.rust_obj + " *" + ty_info.var_name + "_conv_ptr = NULL;\n"
 445                         arg_conv += "if (" + ty_info.var_name + " != 0) {\n"
 446                         arg_conv += "\t" + ty_info.rust_obj + " " + ty_info.var_name + "_conv;\n"
 447                         arg_conv += "void* " + ty_info.var_name + "_ptr = (void*)(((uint64_t)" + ty_info.var_name + ") & ~1);\n"
 448                         arg_conv += "CHECK_ACCESS(" + ty_info.var_name + "_ptr);\n"
 449                         arg_conv += "\t" + ty_info.var_name + "_conv = *(" + ty_info.rust_obj + "*)" + ty_info.var_name + "_ptr;"
 450                         arg_conv += self.consts.trait_struct_inc_refcnt(ty_info).replace("\n", "\n\t")
 451                         arg_conv += "\n\t" + ty_info.var_name + "_conv_ptr = MALLOC(sizeof(" + ty_info.rust_obj + "), \"" + ty_info.rust_obj + "\");\n"
 452                         arg_conv += "\t*" + ty_info.var_name + "_conv_ptr = " + ty_info.var_name + "_conv;\n"
 453                         arg_conv += "}"
 454                         arg_conv_name = ty_info.var_name + "_conv_ptr"
 455                     if ty_info.rust_obj.replace("LDK", "") + "_clone" in self.clone_fns:
 456                         return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 457                             arg_conv = arg_conv, arg_conv_name = arg_conv_name, arg_conv_cleanup = None,
 458                             ret_conv = (ty_info.rust_obj + " *" + ty_info.var_name + "_clone = MALLOC(sizeof(" + ty_info.rust_obj + "), \"" + ty_info.rust_obj + "\");\n" +
 459                                 "*" + ty_info.var_name + "_clone = " + ty_info.rust_obj.replace("LDK", "") + "_clone(", ");"),
 460                             ret_conv_name = "(uint64_t)" + ty_info.var_name + "_clone",
 461                             to_hu_conv = ty_info.java_hu_ty + " ret_hu_conv = new " + ty_info.java_hu_ty + "(null, " + ty_info.var_name + ");\nret_hu_conv.ptrs_to.add(this);",
 462                             to_hu_conv_name = "ret_hu_conv",
 463                             from_hu_conv = (ty_info.var_name + " == null ? 0 : " + ty_info.var_name + ".ptr", ""))
 464                     else:
 465                         return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 466                             arg_conv = arg_conv, arg_conv_name = arg_conv_name, arg_conv_cleanup = None,
 467                             ret_conv = ("uint64_t ret_" + ty_info.var_name + " = (uint64_t)", ";"), ret_conv_name = "ret_" + ty_info.var_name,
 468                             to_hu_conv = ty_info.java_hu_ty + " ret_hu_conv = new " + ty_info.java_hu_ty + "(null, " + ty_info.var_name + ");\nret_hu_conv.ptrs_to.add(this);",
 469                             to_hu_conv_name = "ret_hu_conv",
 470                             from_hu_conv = (ty_info.var_name + " == null ? 0 : " + ty_info.var_name + ".ptr", "this.ptrs_to.add(" + ty_info.var_name + ")"))
 471                 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 472                     arg_conv = ty_info.rust_obj + "* " + ty_info.var_name + "_conv = (" + ty_info.rust_obj + "*)(" + ty_info.var_name + " & ~1);",
 473                     arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
 474                     ret_conv = ("uint64_t ret_" + ty_info.var_name + " = (uint64_t)", ";"), ret_conv_name = "ret_" + ty_info.var_name,
 475                     to_hu_conv = "TODO 3", to_hu_conv_name = None, from_hu_conv = None) # its a pointer, no conv needed
 476             assert False # We should have handled every case by now.