_ 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                     to_hu_conv = ty_info.java_hu_ty + " " + conv_name + "_arr = new " + ty_info.subty.java_hu_ty.split("<")[0] + "[" + arr_name + ".length];\n"
 161                     to_hu_conv = to_hu_conv + "for (int " + idxc + " = 0; " + idxc + " < " + arr_name + ".length; " + idxc + "++) {\n"
 162                     to_hu_conv = to_hu_conv + "\t" + subty.java_ty + " " + conv_name + " = " + arr_name + "[" + idxc + "];\n"
 163                     to_hu_conv = to_hu_conv + "\t" + subty.to_hu_conv.replace("\n", "\n\t") + "\n"
 164                     to_hu_conv = to_hu_conv + "\t" + conv_name + "_arr[" + idxc + "] = " + subty.to_hu_conv_name + ";\n}"
 165                     to_hu_conv_name = conv_name + "_arr"
 166                 from_hu_conv = None
 167                 if subty.from_hu_conv is not None:
 168                     if subty.java_ty == "long" and subty.java_hu_ty != "long":
 169                         from_hu_conv = (arr_name + " != null ? Arrays.stream(" + arr_name + ").mapToLong(" + conv_name + " -> " + subty.from_hu_conv[0] + ").toArray() : null", "/* TODO 2 " + subty.java_hu_ty + "  */")
 170                     elif subty.java_ty == "long":
 171                         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 + "  */")
 172                     else:
 173                         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", "/* TODO 2 " + subty.java_hu_ty + "  */")
 174
 175                 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 176                     arg_conv = arg_conv, arg_conv_name = arg_conv_name, arg_conv_cleanup = arg_conv_cleanup,
 177                     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)
 178         elif ty_info.java_ty == "String":
 179             if not is_free:
 180                 arg_conv = "LDKStr " + ty_info.var_name + "_conv = " + self.consts.str_ref_to_c_call(ty_info.var_name) + ";"
 181                 arg_conv_name = ty_info.var_name + "_conv"
 182             else:
 183                 arg_conv = "LDKStr dummy = { .chars = NULL, .len = 0, .chars_is_owned = false };"
 184                 arg_conv_name = "dummy"
 185             if ty_info.arr_access is None:
 186                 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 187                     arg_conv = arg_conv, arg_conv_name = arg_conv_name, arg_conv_cleanup = None,
 188                     ret_conv = ("const char* " + ty_info.var_name + "_str = ",
 189                         ";\njstring " + ty_info.var_name + "_conv = " + self.consts.str_ref_to_native_call(ty_info.var_name + "_str", "strlen(" + ty_info.var_name + "_str)") + ";"),
 190                     ret_conv_name = ty_info.var_name + "_conv",
 191                     to_hu_conv = None, to_hu_conv_name = None, from_hu_conv = None)
 192             else:
 193                 free_str = ""
 194                 if not holds_ref:
 195                     free_str = "\nStr_free(" + ty_info.var_name + "_str);"
 196                 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 197                     arg_conv = arg_conv, arg_conv_name = arg_conv_name, arg_conv_cleanup = None,
 198                     ret_conv = ("LDKStr " + ty_info.var_name + "_str = ",
 199                         ";\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),
 200                     ret_conv_name = ty_info.var_name + "_conv", to_hu_conv = None, to_hu_conv_name = None, from_hu_conv = None)
 201         elif ty_info.var_name == "" and not print_void:
 202             # We don't have a parameter name, and want one, just call it arg
 203             if not ty_info.is_native_primitive:
 204                 assert(not is_free or ty_info.rust_obj not in self.opaque_structs)
 205                 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 206                     arg_conv = ty_info.rust_obj + " arg_conv = *(" + ty_info.rust_obj + "*)arg;\nFREE((void*)arg);",
 207                     arg_conv_name = "arg_conv", arg_conv_cleanup = None,
 208                     ret_conv = None, ret_conv_name = None, to_hu_conv = "TODO 7", to_hu_conv_name = None, from_hu_conv = None)
 209             else:
 210                 assert(not is_free)
 211                 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 212                     arg_conv = None, arg_conv_name = "arg", arg_conv_cleanup = None,
 213                     ret_conv = None, ret_conv_name = None, to_hu_conv = "TODO 8", to_hu_conv_name = None, from_hu_conv = None)
 214         elif ty_info.is_native_primitive:
 215             return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 216                 arg_conv = None, arg_conv_name = ty_info.var_name, arg_conv_cleanup = None,
 217                 ret_conv = None, ret_conv_name = None, to_hu_conv = None, to_hu_conv_name = None, from_hu_conv = None)
 218         else:
 219             if ty_info.var_name == "":
 220                 ty_info.var_name = "ret"
 221
 222             if ty_info.rust_obj in self.opaque_structs:
 223                 from_hu_conv = (ty_info.var_name + " == null ? 0 : " + ty_info.var_name + ".ptr & ~1", "this.ptrs_to.add(" + ty_info.var_name + ")")
 224                 opaque_arg_conv = ty_info.rust_obj + " " + ty_info.var_name + "_conv;\n"
 225                 opaque_arg_conv = opaque_arg_conv + ty_info.var_name + "_conv.inner = (void*)(" + ty_info.var_name + " & (~1));\n"
 226                 if ty_info.is_ptr and holds_ref:
 227                     opaque_arg_conv = opaque_arg_conv + ty_info.var_name + "_conv.is_owned = false;"
 228                 else:
 229                     opaque_arg_conv = opaque_arg_conv + ty_info.var_name + "_conv.is_owned = (" + ty_info.var_name + " & 1) || (" + ty_info.var_name + " == 0);"
 230                 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:
 231                     if (ty_info.rust_obj.replace("LDK", "") + "_clone") in self.clone_fns:
 232                         # 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.
 233                         opaque_arg_conv = opaque_arg_conv + "\n" + ty_info.var_name + "_conv = " + ty_info.rust_obj.replace("LDK", "") + "_clone(&" + ty_info.var_name + "_conv);"
 234                     elif ty_info.passed_as_ptr:
 235                         opaque_arg_conv = opaque_arg_conv + "\n// Warning: we need a move here but no clone is available for " + ty_info.rust_obj
 236                         # TODO: Once we support features cloning (which just isn't in C yet), we can make this a compile error instead!
 237                         from_hu_conv = (from_hu_conv[0], from_hu_conv[1] + ";\n" +
 238                             "// Due to rust's strict-ownership memory model, in some cases we need to \"move\"\n" +
 239                             "// an object to pass exclusive ownership to the function being called.\n" +
 240                             "// In most cases, we avoid this being visible in GC'd languages by cloning the object\n" +
 241                             "// at the FFI layer, creating a new object which Rust can claim ownership of\n" +
 242                             "// However, in some cases (eg here), there is no way to clone an object, and thus\n" +
 243                             "// we actually have to pass full ownership to Rust.\n" +
 244                             "// 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")
 245
 246                 opaque_ret_conv_suf = ";\n"
 247                 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
 248                     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"
 249                 elif not holds_ref and ty_info.is_ptr:
 250                     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"
 251
 252                 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"
 253                 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"
 254                 if holds_ref:
 255                     opaque_ret_conv_suf = opaque_ret_conv_suf + "uint64_t " + ty_info.var_name + "_ref = (uint64_t)" + ty_info.var_name + "_var.inner & ~1;"
 256                 else:
 257                     opaque_ret_conv_suf = opaque_ret_conv_suf + "uint64_t " + ty_info.var_name + "_ref = (uint64_t)" + ty_info.var_name + "_var.inner;\n"
 258                     opaque_ret_conv_suf = opaque_ret_conv_suf + "if (" + ty_info.var_name + "_var.is_owned) {\n"
 259                     opaque_ret_conv_suf = opaque_ret_conv_suf + "\t" + ty_info.var_name + "_ref |= 1;\n"
 260                     opaque_ret_conv_suf = opaque_ret_conv_suf + "}"
 261
 262                 if ty_info.is_ptr:
 263                     return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 264                         arg_conv = opaque_arg_conv, arg_conv_name = "&" + ty_info.var_name + "_conv", arg_conv_cleanup = None,
 265                         ret_conv = (ty_info.rust_obj + " " + ty_info.var_name + "_var = *", opaque_ret_conv_suf),
 266                         ret_conv_name = ty_info.var_name + "_ref",
 267                         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),
 268                         to_hu_conv_name = ty_info.var_name + "_hu_conv",
 269                         from_hu_conv = from_hu_conv)
 270                 else:
 271                     return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 272                         arg_conv = opaque_arg_conv, arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
 273                         ret_conv = (ty_info.rust_obj + " " + ty_info.var_name + "_var = ", opaque_ret_conv_suf),
 274                         ret_conv_name = ty_info.var_name + "_ref",
 275                         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) + "\n" + ty_info.var_name + "_hu_conv.ptrs_to.add(this);",
 276                         to_hu_conv_name = ty_info.var_name + "_hu_conv",
 277                         from_hu_conv = from_hu_conv)
 278
 279             if not ty_info.is_ptr:
 280                 if ty_info.rust_obj in self.unitary_enums:
 281                     (ret_pfx, ret_sfx) = self.consts.c_unitary_enum_to_native_call(ty_info)
 282                     (arg_pfx, arg_sfx) = self.consts.native_unitary_enum_to_c_call(ty_info)
 283                     return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 284                         arg_conv = ty_info.rust_obj + " " + ty_info.var_name + "_conv = " + arg_pfx + ty_info.var_name + arg_sfx + ";",
 285                         arg_conv_name = ty_info.var_name + "_conv",
 286                         arg_conv_cleanup = None,
 287                         ret_conv = (ty_info.c_ty + " " + ty_info.var_name + "_conv = " + ret_pfx, ret_sfx + ";"),
 288                         ret_conv_name = ty_info.var_name + "_conv", to_hu_conv = None, to_hu_conv_name = None, from_hu_conv = None)
 289                 base_conv = ty_info.rust_obj + " " + ty_info.var_name + "_conv = *(" + ty_info.rust_obj + "*)(((uint64_t)" + ty_info.var_name + ") & ~1);"
 290                 if ty_info.rust_obj in self.trait_structs:
 291                     ret_conv = (ty_info.rust_obj + "* ret = MALLOC(sizeof(" + ty_info.rust_obj + "), \"" + ty_info.rust_obj + "\");\n*ret = ", ";")
 292                     if holds_ref:
 293                         if (ty_info.rust_obj.replace("LDK", "") + "_clone") in self.clone_fns:
 294                             ret_conv = (ret_conv[0] + ty_info.rust_obj.replace("LDK", "") + "_clone(&", ");")
 295                         else:
 296                             ret_conv = (ret_conv[0], "; // Warning: We likely need to clone here, but no clone is available for " + ty_info.rust_obj)
 297                     if not is_free:
 298                         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
 299                         if needs_full_clone and (ty_info.rust_obj.replace("LDK", "") + "_clone") in self.clone_fns:
 300                             base_conv = base_conv + "\n" + ty_info.var_name + "_conv = " + ty_info.rust_obj.replace("LDK", "") + "_clone(&" + ty_info.var_name + "_conv);"
 301                         else:
 302                             base_conv = base_conv + self.consts.trait_struct_inc_refcnt(ty_info)
 303                             if needs_full_clone:
 304                                 base_conv = base_conv + "// Warning: we may need a move here but no clone is available for " + ty_info.rust_obj + "\n"
 305                     else:
 306                         base_conv = base_conv + "\n" + "FREE((void*)" + ty_info.var_name + ");"
 307                     return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 308                         arg_conv = base_conv, arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
 309                         ret_conv = ret_conv, ret_conv_name = "(uint64_t)ret",
 310                         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);",
 311                         to_hu_conv_name = "ret_hu_conv",
 312                         from_hu_conv = (ty_info.var_name + " == null ? 0 : " + ty_info.var_name + ".ptr", "this.ptrs_to.add(" + ty_info.var_name + ")"))
 313                 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
 314                 if needs_full_clone:
 315                     if "res" in ty_info.var_name: # XXX: This is a stupid hack
 316                         needs_full_clone = False
 317                     if needs_full_clone and (ty_info.rust_obj.replace("LDK", "") + "_clone") in self.clone_fns:
 318                         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));"
 319                     elif needs_full_clone:
 320                         base_conv = base_conv + "\n// Warning: we may need a move here but no clone is available for " + ty_info.rust_obj
 321                 if not needs_full_clone and ty_info.rust_obj != "LDKu8slice" and (not holds_ref or is_free):
 322                     # Don't bother free'ing slices passed in - Rust doesn't auto-free the
 323                     # underlying unlike Vecs, and it gives Java more freedom.
 324                     base_conv = base_conv + "\nFREE((void*)" + ty_info.var_name + ");"
 325                 if ty_info.rust_obj in self.complex_enums:
 326                     ret_conv = ("uint64_t " + ty_info.var_name + "_ref = ((uint64_t)&", ") | 1;")
 327                     if not holds_ref:
 328                         ret_conv = (ty_info.rust_obj + " *" + ty_info.var_name + "_copy = MALLOC(sizeof(" + ty_info.rust_obj + "), \"" + ty_info.rust_obj + "\");\n", "")
 329                         if ty_info.requires_clone == True: # Set in object array mapping
 330                             if (ty_info.rust_obj.replace("LDK", "") + "_clone") in self.clone_fns:
 331                                 ret_conv = (ret_conv[0] + "*" + ty_info.var_name + "_copy = " + ty_info.rust_obj.replace("LDK", "") + "_clone(&", ");\n")
 332                             else:
 333                                 ret_conv = (ret_conv[0] + "*" + ty_info.var_name + "_copy = ", "; // Warning: We likely need to clone here, but no clone is available for " + ty_inf.rust_obj + "\n")
 334                         else:
 335                             ret_conv = (ret_conv[0] + "*" + ty_info.var_name + "_copy = ", ";\n")
 336                         ret_conv = (ret_conv[0], ret_conv[1] + "uint64_t " + ty_info.var_name + "_ref = (uint64_t)" + ty_info.var_name + "_copy;")
 337                     return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 338                         arg_conv = base_conv, arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
 339                         ret_conv = ret_conv, ret_conv_name = ty_info.var_name + "_ref",
 340                         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);",
 341                         to_hu_conv_name = ty_info.var_name + "_hu_conv", from_hu_conv = (ty_info.var_name + ".ptr", ""))
 342                 if ty_info.rust_obj in self.result_types:
 343                     if holds_ref:
 344                         # If we're trying to return a ref, we have to clone.
 345                         # We just blindly assume its implemented and let the compiler fail if its not.
 346                         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 = ", ";")
 347                         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);")
 348                     else:
 349                         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 = ", ";")
 350                     return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 351                         arg_conv = base_conv, arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
 352                         ret_conv = ret_conv, ret_conv_name = "(uint64_t)" + ty_info.var_name + "_conv",
 353                         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 + ");",
 354                         to_hu_conv_name = ty_info.var_name + "_hu_conv", from_hu_conv = (ty_info.var_name + " != null ? " + ty_info.var_name + ".ptr : 0", ""))
 355                 if ty_info.rust_obj in self.tuple_types:
 356                     from_hu_conv_sfx = ""
 357                     from_hu_conv = "bindings." + self.tuple_types[ty_info.rust_obj][1].replace("LDK", "") + "_new("
 358                     to_hu_conv_pfx = ""
 359                     to_hu_conv_sfx = ty_info.java_hu_ty + " " + ty_info.var_name + "_conv = new " + ty_info.java_hu_ty + "("
 360                     to_hu_conv_refs = ""
 361                     for idx, conv in enumerate(self.tuple_types[ty_info.rust_obj][0]):
 362                         if idx != 0:
 363                             to_hu_conv_sfx = to_hu_conv_sfx + ", "
 364                             from_hu_conv = from_hu_conv + ", "
 365                         conv.var_name = ty_info.var_name + "_" + chr(idx + ord("a"))
 366                         conv_map = self.map_type_with_info(conv, False, None, is_free, holds_ref)
 367                         to_hu_conv_pfx = to_hu_conv_pfx + conv.java_ty + " " + ty_info.var_name + "_" + chr(idx + ord("a")) + " = "
 368                         if not conv.is_native_primitive and (conv_map.rust_obj.replace("LDK", "") + "_clone") in self.clone_fns and conv_map.rust_obj == "LDKTxOut":
 369                             to_hu_conv_pfx = to_hu_conv_pfx + "bindings." + conv_map.rust_obj.replace("LDK", "") + "_clone("
 370                         to_hu_conv_pfx = to_hu_conv_pfx + "bindings." + self.tuple_types[ty_info.rust_obj][1] + "_get_" + chr(idx + ord("a")) + "(" + ty_info.var_name + ")"
 371                         if not conv.is_native_primitive and (conv_map.rust_obj.replace("LDK", "") + "_clone") in self.clone_fns and conv_map.rust_obj == "LDKTxOut": # XXX
 372                             to_hu_conv_pfx = to_hu_conv_pfx + ")"
 373                         to_hu_conv_pfx = to_hu_conv_pfx + ";\n"
 374                         if conv_map.to_hu_conv is not None:
 375                             to_hu_conv_pfx = to_hu_conv_pfx + conv_map.to_hu_conv + ";\n"
 376                             to_hu_conv_sfx = to_hu_conv_sfx + conv_map.to_hu_conv_name
 377                             if to_hu_conv_refs is not None:
 378                                 if conv_map.c_ty.endswith("Array"):
 379                                     to_hu_conv_refs = None
 380                                 else:
 381                                     to_hu_conv_refs = to_hu_conv_refs + "\n" + conv_map.to_hu_conv_name + ".ptrs_to.add(" + ty_info.var_name + "_conv);"
 382                         else:
 383                             to_hu_conv_sfx = to_hu_conv_sfx + ty_info.var_name + "_" + chr(idx + ord("a"))
 384                         if conv_map.from_hu_conv is not None:
 385                             from_hu_conv = from_hu_conv + conv_map.from_hu_conv[0].replace(ty_info.var_name + "_" + chr(idx + ord("a")), ty_info.var_name + "." + chr(idx + ord("a")))
 386                             if conv_map.from_hu_conv[1] != "":
 387                                 from_hu_conv_sfx = from_hu_conv_sfx + conv_map.from_hu_conv[1].replace(conv.var_name, ty_info.var_name + "." + chr(idx + ord("a")))
 388                         else:
 389                             from_hu_conv = from_hu_conv + ty_info.var_name + "." + chr(idx + ord("a"))
 390
 391                     if to_hu_conv_refs is None:
 392                         to_hu_conv = to_hu_conv_pfx + to_hu_conv_sfx + ");\n// Warning: We may not free the C tuple object!"
 393                     else:
 394                         to_hu_conv = to_hu_conv_pfx + to_hu_conv_sfx + ", () -> {\n"
 395                         to_hu_conv = to_hu_conv + "\tbindings." + ty_info.rust_obj.replace("LDK", "") + "_free(" + ty_info.var_name + ");\n"
 396                         to_hu_conv = to_hu_conv + "});" + to_hu_conv_refs
 397                     if not ty_info.is_ptr and not holds_ref:
 398                         ret_conv = (ty_info.rust_obj + "* " + ty_info.var_name + "_ref = MALLOC(sizeof(" + ty_info.rust_obj + "), \"" + ty_info.rust_obj + "\");\n*" + ty_info.var_name + "_ref = ", ";")
 399                         return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 400                             arg_conv = base_conv, arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
 401                             ret_conv = ret_conv,
 402                             ret_conv_name = "(uint64_t)" + ty_info.var_name + "_ref",
 403                             to_hu_conv = to_hu_conv, to_hu_conv_name = ty_info.var_name + "_conv", from_hu_conv = (from_hu_conv + ")", from_hu_conv_sfx))
 404                     return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 405                         arg_conv = base_conv, arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
 406                         ret_conv = ("uint64_t " + ty_info.var_name + "_ref = (uint64_t)(&", ") | 1;"), ret_conv_name = ty_info.var_name + "_ref",
 407                         to_hu_conv = to_hu_conv, to_hu_conv_name = ty_info.var_name + "_conv", from_hu_conv = (from_hu_conv + ")", from_hu_conv_sfx))
 408
 409                 # The manually-defined types - TxOut and u5
 410                 if ty_info.rust_obj == "LDKu5":
 411                     return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 412                         arg_conv = "", arg_conv_name = "(LDKu5){ ._0 = " + ty_info.var_name + " }", arg_conv_cleanup = None,
 413                         ret_conv = ("uint8_t " + ty_info.var_name + "_val = ", "._0;"), ret_conv_name = ty_info.var_name + "_val",
 414                         to_hu_conv = ty_info.java_hu_ty + " " + ty_info.var_name + "_conv = new " + ty_info.java_hu_ty + "(" + ty_info.var_name + ");",
 415                         to_hu_conv_name = ty_info.var_name + "_conv", from_hu_conv = (ty_info.var_name + ".getVal()", ""))
 416
 417                 assert ty_info.rust_obj == "LDKTxOut"
 418                 if not ty_info.is_ptr and not holds_ref:
 419                     ret_conv = ("LDKTxOut* " + ty_info.var_name + "_ref = MALLOC(sizeof(LDKTxOut), \"LDKTxOut\");\n*" + ty_info.var_name + "_ref = ", ";")
 420                 else:
 421                     ret_conv = ("uint64_t " + ty_info.var_name + "_ref = ((uint64_t)&", ") | 1;")
 422                 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 423                     arg_conv = base_conv, arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
 424                     ret_conv = ret_conv, ret_conv_name = "(uint64_t)" + ty_info.var_name + "_ref",
 425                     to_hu_conv = ty_info.java_hu_ty + " " + ty_info.var_name + "_conv = new " +ty_info.java_hu_ty + "(null, " + ty_info.var_name + ");",
 426                     to_hu_conv_name = ty_info.var_name + "_conv", from_hu_conv = (ty_info.var_name + ".ptr", ""))
 427             elif ty_info.is_ptr:
 428                 assert(not is_free)
 429                 if ty_info.rust_obj in self.complex_enums:
 430                     return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 431                         arg_conv = ty_info.rust_obj + "* " + ty_info.var_name + "_conv = (" + ty_info.rust_obj + "*)" + ty_info.var_name + ";",
 432                         arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
 433                         ret_conv = ("uint64_t ret_" + ty_info.var_name + " = (uint64_t)", ";"), ret_conv_name = "ret_" + ty_info.var_name,
 434                         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 + ");",
 435                         to_hu_conv_name = ty_info.var_name + "_hu_conv",
 436                         from_hu_conv = (ty_info.var_name + " == null ? 0 : " + ty_info.var_name + ".ptr & ~1", "this.ptrs_to.add(" + ty_info.var_name + ")"))
 437                 elif ty_info.rust_obj in self.trait_structs:
 438                     if ty_info.nonnull_ptr:
 439                         arg_conv = ty_info.rust_obj + "* " + ty_info.var_name + "_conv = (" + ty_info.rust_obj + "*)(((uint64_t)" + ty_info.var_name + ") & ~1);"
 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 += "\t" + ty_info.var_name + "_conv = *(" + ty_info.rust_obj + "*)(((uint64_t)" + ty_info.var_name + ") & ~1);"
 448                         arg_conv += self.consts.trait_struct_inc_refcnt(ty_info).replace("\n", "\n\t")
 449                         arg_conv += "\n\t" + ty_info.var_name + "_conv_ptr = MALLOC(sizeof(" + ty_info.rust_obj + "), \"" + ty_info.rust_obj + "\");\n"
 450                         arg_conv += "\t*" + ty_info.var_name + "_conv_ptr = " + ty_info.var_name + "_conv;\n"
 451                         arg_conv += "}"
 452                         arg_conv_name = ty_info.var_name + "_conv_ptr"
 453                     if ty_info.rust_obj.replace("LDK", "") + "_clone" in self.clone_fns:
 454                         return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 455                             arg_conv = arg_conv, arg_conv_name = arg_conv_name, arg_conv_cleanup = None,
 456                             ret_conv = (ty_info.rust_obj + " *" + ty_info.var_name + "_clone = MALLOC(sizeof(" + ty_info.rust_obj + "), \"" + ty_info.rust_obj + "\");\n" +
 457                                 "*" + ty_info.var_name + "_clone = " + ty_info.rust_obj.replace("LDK", "") + "_clone(", ");"),
 458                             ret_conv_name = "(uint64_t)" + ty_info.var_name + "_clone",
 459                             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);",
 460                             to_hu_conv_name = "ret_hu_conv",
 461                             from_hu_conv = (ty_info.var_name + " == null ? 0 : " + ty_info.var_name + ".ptr", "this.ptrs_to.add(" + ty_info.var_name + ")"))
 462                     else:
 463                         return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 464                             arg_conv = arg_conv, arg_conv_name = arg_conv_name, arg_conv_cleanup = None,
 465                             ret_conv = ("uint64_t ret_" + ty_info.var_name + " = (uint64_t)", ";"), ret_conv_name = "ret_" + ty_info.var_name,
 466                             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);",
 467                             to_hu_conv_name = "ret_hu_conv",
 468                             from_hu_conv = (ty_info.var_name + " == null ? 0 : " + ty_info.var_name + ".ptr", "this.ptrs_to.add(" + ty_info.var_name + ")"))
 469                 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
 470                     arg_conv = ty_info.rust_obj + "* " + ty_info.var_name + "_conv = (" + ty_info.rust_obj + "*)(" + ty_info.var_name + " & ~1);",
 471                     arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
 472                     ret_conv = ("uint64_t ret_" + ty_info.var_name + " = (uint64_t)", ";"), ret_conv_name = "ret_" + ty_info.var_name,
 473                     to_hu_conv = "TODO 3", to_hu_conv_name = None, from_hu_conv = None) # its a pointer, no conv needed
 474             assert False # We should have handled every case by now.