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