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