1 from bindingstypes import ConvInfo
3 class TypeMappingGenerator:
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
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
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)
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)
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)
30 mapped_info.nullable = True
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":
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
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
51 if not arr_len.isdigit():
52 arg_conv = ty_info.rust_obj + " " + arr_name + "_ref;\n"
53 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"
54 if (not ty_info.is_ptr or not holds_ref) and ty_info.rust_obj != "LDKu8slice":
55 arg_conv = arg_conv + arr_name + "_ref." + ty_info.arr_access + " = MALLOC(" + arr_name + "_ref." + arr_len + ", \"" + ty_info.rust_obj + " Bytes\");\n"
56 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) + ";"
58 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) + ";"
59 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)
60 if ty_info.rust_obj == "LDKTransaction":
61 arg_conv = arg_conv + "\n" + arr_name + "_ref.data_is_owned = " + str(holds_ref).lower() + ";"
62 ret_conv = (ty_info.rust_obj + " " + arr_name + "_var = ", "")
63 ret_conv = (ret_conv[0], ";\nint8_tArray " + arr_name + "_arr = " + self.consts.create_native_arr_call(arr_name + "_var." + arr_len, ty_info) + ";\n")
64 (pfx, sfx) = self.consts.set_native_arr_contents(arr_name + "_arr", arr_name + "_var." + arr_len, ty_info)
65 ret_conv = (ret_conv[0], ret_conv[1] + pfx + arr_name + "_var." + ty_info.arr_access + sfx + ";")
66 if not holds_ref and ty_info.rust_obj != "LDKu8slice":
67 ret_conv = (ret_conv[0], ret_conv[1] + "\n" + ty_info.rust_obj.replace("LDK", "") + "_free(" + arr_name + "_var);")
68 elif ty_info.rust_obj is not None:
69 arg_conv = ty_info.rust_obj + " " + arr_name + "_ref;\n"
70 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"
71 arg_conv = arg_conv + self.consts.get_native_arr_contents(arr_name, arr_name + "_ref." + ty_info.arr_access, arr_len, ty_info, True) + ";"
72 ret_conv = (ret_conv[0], "." + ty_info.arr_access + set_sfx + ";")
73 from_hu_conv = ("InternalUtils.check_arr_len(" + arr_name + ", " + arr_len + ")", "")
75 arg_conv = "unsigned char " + arr_name + "_arr[" + arr_len + "];\n"
76 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"
77 arg_conv = arg_conv + self.consts.get_native_arr_contents(arr_name, arr_name + "_arr", arr_len, ty_info, True) + ";\n"
78 arg_conv = arg_conv + "unsigned char (*" + arr_name + "_ref)[" + arr_len + "] = &" + arr_name + "_arr;"
79 ret_conv = (ret_conv[0] + "*", set_sfx + ";")
80 from_hu_conv = ("InternalUtils.check_arr_len(" + arr_name + ", " + arr_len + ")", "")
81 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
82 arg_conv = arg_conv, arg_conv_name = arr_name + "_ref", arg_conv_cleanup = arg_conv_cleanup,
83 ret_conv = ret_conv, ret_conv_name = arr_name + "_arr", to_hu_conv = None, to_hu_conv_name = None,
84 from_hu_conv = from_hu_conv)
86 assert not arr_len.isdigit() # fixed length arrays not implemented
87 assert ty_info.java_ty[len(ty_info.java_ty) - 2:] == "[]"
90 conv_name = arr_name + "_conv_" + str(len(ty_info.java_hu_ty))
91 idxc = chr(ord('a') + (len(ty_info.java_hu_ty) % 26))
92 ty_info.subty.var_name = conv_name
93 #XXX: We'd really prefer to only ever set to False, avoiding lots of clone, but need smarter free logic
94 #if ty_info.is_ptr or holds_ref:
95 # ty_info.subty.requires_clone = False
96 ty_info.subty.requires_clone = not ty_info.is_ptr or not holds_ref
97 if not ty_info.subty.is_native_primitive and ty_info.subty.rust_obj == "LDKChannelMonitor":
98 # We take a Vec of references to ChannelMonitors as input to ChannelManagerReadArgs, if we clone them,
99 # we end up freeing the clones after creating the ChannelManagerReadArgs before calling the read
100 # function itself, resulting in a segfault. Thus, we manually check and ensure we don't clone for
101 # ChannelMonitors inside of vecs.
102 ty_info.subty.requires_clone = False
103 subty = self.map_type_with_info(ty_info.subty, False, None, is_free, holds_ref, False)
104 arg_conv = ty_info.rust_obj + " " + arr_name + "_constr;\n"
108 arg_conv += ty_info.rust_obj + " *" + arr_name + "_ptr = NULL;\n"
109 arg_conv += "if (" + self.consts.is_arr_some_check[0] + arr_name + self.consts.is_arr_some_check[1] + ") {\n"
110 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"
111 arg_conv += pf + "if (" + arr_name + "_constr." + arr_len + " > 0)\n"
112 if subty.is_native_primitive:
115 szof = subty.rust_obj
116 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"
117 arg_conv += pf + "else\n"
118 arg_conv += pf + "\t" + arr_name + "_constr." + ty_info.arr_access + " = NULL;\n"
119 get_arr = self.consts.get_native_arr_contents(arr_name, "NO_DEST", arr_name + "_constr." + arr_len, ty_info, False)
121 arg_conv += pf + subty.c_ty + "* " + arr_name + "_vals = " + get_arr + ";\n"
122 arg_conv += pf + "for (size_t " + idxc + " = 0; " + idxc + " < " + arr_name + "_constr." + arr_len + "; " + idxc + "++) {\n"
124 arg_conv += pf + "\t" + subty.c_ty + " " + conv_name + " = " + arr_name + "_vals[" + idxc + "];"
125 if subty.arg_conv is not None:
126 arg_conv += "\n\t" + pf + subty.arg_conv.replace("\n", "\n\t" + pf)
128 arg_conv += pf + "\t" + subty.c_ty + " " + conv_name + " = " + self.consts.get_native_arr_elem(arr_name, idxc, ty_info) + ";\n"
129 arg_conv += pf + "\t" + subty.arg_conv.replace("\n", "\n\t" + pf)
130 arg_conv += "\n\t" + pf + arr_name + "_constr." + ty_info.arr_access + "[" + idxc + "] = " + subty.arg_conv_name + ";\n" + pf + "}"
132 cleanup = self.consts.cleanup_native_arr_ref_contents(arr_name, arr_name + "_vals", arr_name + "_constr." + arr_len, ty_info)
133 if cleanup is not None:
134 arg_conv += "\n" + pf + cleanup + ";"
136 arg_conv_name = arr_name + "_ptr"
138 arg_conv_name = arr_name + "_constr"
139 arg_conv_cleanup = None
141 arg_conv_cleanup = "if (" + arr_name + "_ptr != NULL) { FREE(" + arr_name + "_constr." + ty_info.arr_access + "); }"
143 arg_conv += "\n\t" + arr_name + "_ptr = &" + arr_name + "_constr;\n}"
146 ret_conv = (ty_info.rust_obj + " *" + arr_name + "_var_ptr = ", "")
148 ret_conv = (ty_info.rust_obj + " " + arr_name + "_var = ", "")
149 if subty.ret_conv is None:
150 ret_conv = ("DUMMY", "DUMMY")
152 ret_conv = (ret_conv[0], ";\n" + ty_info.c_ty + " " + arr_name + "_arr = NULL;\n")
155 ret_conv = (ret_conv[0], ret_conv[1] + "if (" + arr_name + " != NULL) {\n")
156 ret_conv = (ret_conv[0], ret_conv[1] + "\t" + ty_info.rust_obj + " " + arr_name + "_var = *" + arr_name + "_var_ptr;\n")
158 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")
159 get_ptr_call = self.consts.get_native_arr_ptr_call(ty_info)
160 if get_ptr_call is not None:
161 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")
162 ret_conv = (ret_conv[0], ret_conv[1] + indent + "for (size_t " + idxc + " = 0; " + idxc + " < " + arr_name + "_var." + arr_len + "; " + idxc + "++) {\n")
163 ret_conv = (ret_conv[0], ret_conv[1] + indent + "\t" + subty.ret_conv[0].replace("\n", "\n\t" + indent))
164 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")
165 if get_ptr_call is not None:
166 ret_conv = (ret_conv[0], ret_conv[1] + indent + "\t" + arr_name + "_arr_ptr[" + idxc + "] = " + subty.ret_conv_name + ";\n" + indent + "}\n")
168 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")
169 cleanup = self.consts.release_native_arr_ptr_call(ty_info, arr_name + "_arr", arr_name + "_arr_ptr")
170 if cleanup is not None:
171 ret_conv = (ret_conv[0], ret_conv[1] + indent + cleanup + ";")
172 if not holds_ref and not is_nullable:
173 # XXX: The commented if's are a bit smarter freeing, but we need to be a nudge smarter still
174 # Note that we don't drop the full vec here - we're passing ownership to java (or have cloned) or free'd by now!
175 ret_conv = (ret_conv[0], ret_conv[1] + "\n" + indent + "FREE(" + arr_name + "_var." + ty_info.arr_access + ");")
176 #if subty.rust_obj is not None and subty.rust_obj in self.opaque_structs:
177 # ret_conv = (ret_conv[0], ret_conv[1] + "\nFREE(" + arr_name + "_var." + ty_info.arr_access + ");")
179 # ret_conv = (ret_conv[0], ret_conv[1] + "\n" + ty_info.rust_obj.replace("LDK", "") + "_free(" + arr_name + "_var);")
181 ret_conv = (ret_conv[0], ret_conv[1] + "\n}")
184 to_hu_conv_name = None
185 if subty.to_hu_conv is not None:
186 base_ty = ty_info.subty.java_hu_ty.split("[")[0].split("<")[0]
187 to_hu_conv = self.consts.var_decl_statement(ty_info.java_hu_ty, conv_name + "_arr", "new " + base_ty + "[" + arr_name + ".length]")
188 if "[" in ty_info.subty.java_hu_ty.split("<")[0]:
189 # Do a bit of a dance to move any excess [] to the end
190 to_hu_conv += "[" + ty_info.subty.java_hu_ty.split("<")[0].split("[")[1]
191 to_hu_conv += ";\nfor (int " + idxc + " = 0; " + idxc + " < " + arr_name + ".length; " + idxc + "++) {\n"
192 to_hu_conv += "\t" + self.consts.var_decl_statement(subty.java_ty, conv_name, arr_name + "[" + idxc + "]") + ";\n"
193 to_hu_conv += "\t" + subty.to_hu_conv.replace("\n", "\n\t") + "\n"
194 to_hu_conv += "\t" + conv_name + "_arr[" + idxc + "] = " + subty.to_hu_conv_name + ";\n}"
195 to_hu_conv_name = conv_name + "_arr"
197 if subty.from_hu_conv is not None:
199 if subty.from_hu_conv[1] != "":
200 hu_conv_b = "for (" + subty.java_hu_ty + " " + conv_name + ": " + arr_name + ") { " + subty.from_hu_conv[1] + "; }"
201 from_hu_conv = (self.consts.map_hu_array_elems(arr_name, conv_name, ty_info, subty), hu_conv_b)
203 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
204 arg_conv = arg_conv, arg_conv_name = arg_conv_name, arg_conv_cleanup = arg_conv_cleanup,
205 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)
206 elif ty_info.java_ty == "String":
207 assert not is_nullable
209 arg_conv = "LDKStr " + ty_info.var_name + "_conv = " + self.consts.str_ref_to_c_call(ty_info.var_name) + ";"
210 arg_conv_name = ty_info.var_name + "_conv"
212 arg_conv = "LDKStr dummy = { .chars = NULL, .len = 0, .chars_is_owned = false };"
213 arg_conv_name = "dummy"
214 if ty_info.arr_access is None:
215 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
216 arg_conv = arg_conv, arg_conv_name = arg_conv_name, arg_conv_cleanup = None,
217 ret_conv = ("const char* " + ty_info.var_name + "_str = ",
218 ";\njstring " + ty_info.var_name + "_conv = " + self.consts.str_ref_to_native_call(ty_info.var_name + "_str", "strlen(" + ty_info.var_name + "_str)") + ";"),
219 ret_conv_name = ty_info.var_name + "_conv",
220 to_hu_conv = None, to_hu_conv_name = None, from_hu_conv = None)
224 free_str = "\nStr_free(" + ty_info.var_name + "_str);"
225 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
226 arg_conv = arg_conv, arg_conv_name = arg_conv_name, arg_conv_cleanup = None,
227 ret_conv = ("LDKStr " + ty_info.var_name + "_str = ",
228 ";\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),
229 ret_conv_name = ty_info.var_name + "_conv", to_hu_conv = None, to_hu_conv_name = None, from_hu_conv = None)
230 elif ty_info.var_name == "" and not print_void:
231 # We don't have a parameter name, and want one, just call it arg
232 if not ty_info.is_native_primitive:
233 assert(not is_free or ty_info.rust_obj not in self.opaque_structs)
234 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
235 arg_conv = ty_info.rust_obj + " arg_conv = *(" + ty_info.rust_obj + "*)arg;\nFREE((void*)arg);",
236 arg_conv_name = "arg_conv", arg_conv_cleanup = None,
237 ret_conv = None, ret_conv_name = None, to_hu_conv = "TODO 7", to_hu_conv_name = None, from_hu_conv = None)
240 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
241 arg_conv = None, arg_conv_name = "arg", arg_conv_cleanup = None,
242 ret_conv = None, ret_conv_name = None, to_hu_conv = "TODO 8", to_hu_conv_name = None, from_hu_conv = None)
243 elif ty_info.is_native_primitive:
244 assert not is_nullable
245 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
246 arg_conv = None, arg_conv_name = ty_info.var_name, arg_conv_cleanup = None,
247 ret_conv = None, ret_conv_name = None, to_hu_conv = None, to_hu_conv_name = None, from_hu_conv = None)
249 if ty_info.var_name == "":
250 ty_info.var_name = "ret"
252 if ty_info.rust_obj in self.opaque_structs:
253 from_hu_conv = (ty_info.var_name + " == null ? 0 : " + self.consts.get_ptr(ty_info.var_name) + " & ~1", self.consts.add_ref("this", ty_info.var_name))
254 opaque_arg_conv = ty_info.rust_obj + " " + ty_info.var_name + "_conv;\n"
255 opaque_arg_conv = opaque_arg_conv + ty_info.var_name + "_conv.inner = (void*)(" + ty_info.var_name + " & (~1));\n"
256 if ty_info.is_ptr and holds_ref:
257 opaque_arg_conv += ty_info.var_name + "_conv.is_owned = false;\n"
259 opaque_arg_conv += ty_info.var_name + "_conv.is_owned = (" + ty_info.var_name + " & 1) || (" + ty_info.var_name + " == 0);\n"
260 opaque_arg_conv += "CHECK_INNER_FIELD_ACCESS_OR_NULL(" + ty_info.var_name + "_conv);"
261 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:
262 if (ty_info.rust_obj.replace("LDK", "") + "_clone") in self.clone_fns:
263 # 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.
264 # arg_conv is used when converting a function argument from java normally (with holds_ref set),
265 # and when converting a java value being returned from a trait method (with holds_ref unset).
266 # In the second case, we need to clone before returning to C (as once we return the GC can free the object),
267 # whereas in the first we prefer to clone in C to avoid additional Java code as much as possible.
269 opaque_arg_conv = opaque_arg_conv + "\n" + ty_info.var_name + "_conv = " + ty_info.rust_obj.replace("LDK", "") + "_clone(&" + ty_info.var_name + "_conv);"
270 from_hu_conv = (from_hu_conv[0], "")
272 from_hu_conv = (ty_info.var_name + " == null ? 0 : " + ty_info.var_name + ".clone_ptr()", "")
273 elif ty_info.passed_as_ptr:
274 opaque_arg_conv = opaque_arg_conv + "\n// Warning: we need a move here but no clone is available for " + ty_info.rust_obj
275 # TODO: Once we support features cloning (which just isn't in C yet), we can make this a compile error instead!
276 from_hu_conv = (from_hu_conv[0], from_hu_conv[1] + ";\n" +
277 "// Due to rust's strict-ownership memory model, in some cases we need to \"move\"\n" +
278 "// an object to pass exclusive ownership to the function being called.\n" +
279 "// In most cases, we avoid this being visible in GC'd languages by cloning the object\n" +
280 "// at the FFI layer, creating a new object which Rust can claim ownership of\n" +
281 "// However, in some cases (eg here), there is no way to clone an object, and thus\n" +
282 "// we actually have to pass full ownership to Rust.\n" +
283 "// Thus, after this call, " + ty_info.var_name + " is reset to null and is now a dummy object.\n" + self.consts.set_null_skip_free(ty_info.var_name))
285 opaque_ret_conv_suf = ";\n"
286 opaque_ret_conv_suf += "uint64_t " + ty_info.var_name + "_ref = 0;\n"
289 opaque_ret_conv_suf += "if ((uint64_t)" + ty_info.var_name + "_var.inner > 4096) {\n"
291 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
292 opaque_ret_conv_suf += indent + ty_info.var_name + "_var = " + ty_info.rust_obj.replace("LDK", "") + "_clone(" + ty_info.var_name + ");\n"
293 elif not holds_ref and ty_info.is_ptr:
294 opaque_ret_conv_suf += indent + "// Warning: we may need a move here but no clone is available for " + ty_info.rust_obj + "\n"
296 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"
297 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"
298 opaque_ret_conv_suf += "CHECK_INNER_FIELD_ACCESS_OR_NULL(" + ty_info.var_name + "_var);\n"
300 opaque_ret_conv_suf += indent + ty_info.var_name + "_ref = (uint64_t)" + ty_info.var_name + "_var.inner & ~1;"
302 opaque_ret_conv_suf += indent + ty_info.var_name + "_ref = (uint64_t)" + ty_info.var_name + "_var.inner;\n"
303 opaque_ret_conv_suf += indent + "if (" + ty_info.var_name + "_var.is_owned) {\n"
304 opaque_ret_conv_suf += indent + "\t" + ty_info.var_name + "_ref |= 1;\n"
305 opaque_ret_conv_suf += indent + "}"
307 opaque_ret_conv_suf += "\n}"
310 if not ty_info.is_ptr or holds_ref:
311 to_hu_conv_sfx = "\n" + self.consts.add_ref(ty_info.var_name + "_hu_conv", "this") + ";"
313 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
314 arg_conv = opaque_arg_conv, arg_conv_name = "&" + ty_info.var_name + "_conv", arg_conv_cleanup = None,
315 ret_conv = (ty_info.rust_obj + " " + ty_info.var_name + "_var = *", opaque_ret_conv_suf),
316 ret_conv_name = ty_info.var_name + "_ref",
317 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,
318 to_hu_conv_name = ty_info.var_name + "_hu_conv",
319 from_hu_conv = from_hu_conv)
321 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
322 arg_conv = opaque_arg_conv, arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
323 ret_conv = (ty_info.rust_obj + " " + ty_info.var_name + "_var = ", opaque_ret_conv_suf),
324 ret_conv_name = ty_info.var_name + "_ref",
325 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,
326 to_hu_conv_name = ty_info.var_name + "_hu_conv",
327 from_hu_conv = from_hu_conv)
329 assert not is_nullable
330 if not ty_info.is_ptr:
331 if ty_info.rust_obj in self.unitary_enums:
332 (ret_pfx, ret_sfx) = self.consts.c_unitary_enum_to_native_call(ty_info)
333 (arg_pfx, arg_sfx) = self.consts.native_unitary_enum_to_c_call(ty_info)
334 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
335 arg_conv = ty_info.rust_obj + " " + ty_info.var_name + "_conv = " + arg_pfx + ty_info.var_name + arg_sfx + ";",
336 arg_conv_name = ty_info.var_name + "_conv",
337 arg_conv_cleanup = None,
338 ret_conv = (ty_info.c_ty + " " + ty_info.var_name + "_conv = " + ret_pfx, ret_sfx + ";"),
339 ret_conv_name = ty_info.var_name + "_conv", to_hu_conv = None, to_hu_conv_name = None, from_hu_conv = None)
340 base_conv = "void* " + ty_info.var_name + "_ptr = (void*)(((uint64_t)" + ty_info.var_name + ") & ~1);\n"
341 base_conv += "CHECK_ACCESS(" + ty_info.var_name + "_ptr);\n"
342 base_conv += ty_info.rust_obj + " " + ty_info.var_name + "_conv = *(" + ty_info.rust_obj + "*)(" + ty_info.var_name + "_ptr);"
344 if ty_info.rust_obj in self.trait_structs:
345 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 = ", ";")
347 if (ty_info.rust_obj.replace("LDK", "") + "_clone") in self.clone_fns:
348 ret_conv = (ret_conv[0] + ty_info.rust_obj.replace("LDK", "") + "_clone(&", ");")
350 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")
351 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)"))
353 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
354 if needs_full_clone and (ty_info.rust_obj.replace("LDK", "") + "_clone") in self.clone_fns:
355 # arg_conv is used when converting a function argument from java normally (with holds_ref set),
356 # and when converting a java value being returned from a trait method (with holds_ref unset).
357 # In the second case, we need to clone before returning to C (as once we return the GC can free the object),
358 # whereas in the first we prefer to clone in C to avoid additional Java code as much as possible.
360 base_conv += "\n" + ty_info.var_name + "_conv = " + ty_info.rust_obj.replace("LDK", "") + "_clone(&" + ty_info.var_name + "_conv);"
362 from_hu_conv = (ty_info.var_name + " == null ? 0 : " + ty_info.var_name + ".clone_ptr()", "")
363 base_conv += "\n" + "FREE((void*)" + ty_info.var_name + ");"
365 base_conv = base_conv + self.consts.trait_struct_inc_refcnt(ty_info)
367 base_conv = base_conv + "// Warning: we may need a move here but no clone is available for " + ty_info.rust_obj + "\n"
369 base_conv = base_conv + "\n" + "FREE((void*)" + ty_info.var_name + ");"
370 if from_hu_conv is None:
371 from_hu_conv = (ty_info.var_name + " == null ? 0 : " + self.consts.get_ptr(ty_info.var_name), "")
372 from_hu_conv = (from_hu_conv[0], self.consts.add_ref("this", ty_info.var_name))
373 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
374 arg_conv = base_conv, arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
375 ret_conv = ret_conv, ret_conv_name = "(uint64_t)" + ty_info.var_name + "_ret",
376 to_hu_conv = self.consts.var_decl_statement(ty_info.java_hu_ty, "ret_hu_conv", "new " + ty_info.java_hu_ty + "(null, " + ty_info.var_name + ")") + ";\n" + self.consts.add_ref("ret_hu_conv", "this") + ";",
377 to_hu_conv_name = "ret_hu_conv", from_hu_conv = from_hu_conv)
378 needs_full_clone = not is_free and (not ty_info.is_ptr or ty_info.requires_clone == True) and ty_info.requires_clone != False
380 if "res" in ty_info.var_name: # XXX: This is a stupid hack
381 needs_full_clone = False
382 if needs_full_clone and (ty_info.rust_obj.replace("LDK", "") + "_clone") in self.clone_fns:
383 # arg_conv is used when converting a function argument from java normally (with holds_ref set),
384 # and when converting a java value being returned from a trait method (with holds_ref unset).
385 # In the second case, we need to clone before returning to C (as once we return the GC can free the object),
386 # whereas in the first we prefer to clone in C to avoid additional Java code as much as possible.
388 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));"
390 from_hu_conv = (ty_info.var_name + " == null ? 0 : " + ty_info.var_name + ".clone_ptr()", "")
391 base_conv += "\n" + "FREE((void*)" + ty_info.var_name + ");"
392 elif needs_full_clone:
393 base_conv = base_conv + "\n// Warning: we may need a move here but no clone is available for " + ty_info.rust_obj
394 if not needs_full_clone and ty_info.rust_obj != "LDKu8slice" and (not holds_ref or is_free):
395 # Don't bother free'ing slices passed in - Rust doesn't auto-free the
396 # underlying unlike Vecs, and it gives Java more freedom.
397 base_conv = base_conv + "\nFREE((void*)" + ty_info.var_name + ");"
398 if ty_info.rust_obj in self.complex_enums:
400 if needs_full_clone and (ty_info.rust_obj.replace("LDK", "") + "_clone") not in self.clone_fns:
401 # We really need a full clone here, but for now we just implement
402 # a manual clone explicitly for Option<Trait>s
403 if ty_info.contains_trait:
404 assert ty_info.rust_obj.startswith("LDKCOption") # We don't support contained traits for anything else yet
405 optional_ty = ty_info.rust_obj[11:-1]
406 assert "LDK" + optional_ty in self.trait_structs # We don't support contained traits for anything else yet
407 to_hu_conv_sfx = self.consts.add_ref("this", ty_info.var_name)
408 base_conv += "\nif (" + ty_info.var_name + "_conv.tag == " + ty_info.rust_obj + "_Some) {"
409 base_conv += "\n\t// Manually implement clone for Java trait instances"
410 optional_ty_info = self.java_c_types("LDK" + optional_ty + " " + ty_info.var_name, None)
411 base_conv += self.consts.trait_struct_inc_refcnt(optional_ty_info).\
412 replace("\n", "\n\t").replace(ty_info.var_name + "_conv", ty_info.var_name + "_conv.some")
414 ret_conv = ("uint64_t " + ty_info.var_name + "_ref = ((uint64_t)&", ") | 1;")
416 ret_conv = (ty_info.rust_obj + " *" + ty_info.var_name + "_copy = MALLOC(sizeof(" + ty_info.rust_obj + "), \"" + ty_info.rust_obj + "\");\n", "")
417 ret_conv = (ret_conv[0] + "*" + ty_info.var_name + "_copy = ", "")
418 ret_conv = (ret_conv[0], ";\nuint64_t " + ty_info.var_name + "_ref = (uint64_t)" + ty_info.var_name + "_copy;")
419 if from_hu_conv is None:
420 from_hu_conv = (self.consts.get_ptr(ty_info.var_name), "")
421 from_hu_conv = (from_hu_conv[0], to_hu_conv_sfx)
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 = ty_info.var_name + "_ref",
425 to_hu_conv = self.consts.var_decl_statement(ty_info.java_hu_ty, ty_info.var_name + "_hu_conv", ty_info.java_hu_ty + ".constr_from_ptr(" + ty_info.var_name + ")") + ";\n" + self.consts.add_ref(ty_info.var_name + "_hu_conv", "this") + ";",
426 to_hu_conv_name = ty_info.var_name + "_hu_conv", from_hu_conv = from_hu_conv)
427 if ty_info.rust_obj in self.result_types:
429 # If we're trying to return a ref, we have to clone.
430 # We just blindly assume its implemented and let the compiler fail if its not.
431 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 = ", ";")
432 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);")
434 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 = ", ";")
435 if from_hu_conv is None:
436 from_hu_conv = (ty_info.var_name + " != null ? " + self.consts.get_ptr(ty_info.var_name) + " : 0", "")
437 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
438 arg_conv = base_conv, arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
439 ret_conv = ret_conv, ret_conv_name = "(uint64_t)" + ty_info.var_name + "_conv",
440 to_hu_conv = self.consts.var_decl_statement(ty_info.java_hu_ty, ty_info.var_name + "_hu_conv", ty_info.java_hu_ty + ".constr_from_ptr(" + ty_info.var_name + ")") + ";",
441 to_hu_conv_name = ty_info.var_name + "_hu_conv", from_hu_conv = from_hu_conv)
442 if ty_info.rust_obj in self.tuple_types:
443 ret_conv_name = "((uint64_t)" + ty_info.var_name + "_conv)"
445 # If we're trying to return a ref, we have to clone.
446 if (ty_info.rust_obj.replace("LDK", "") + "_clone") not in self.clone_fns:
447 ret_conv = (ty_info.rust_obj + "* " + ty_info.var_name + "_conv = &", "")
448 ret_conv = (ret_conv[0], ";\n// Warning: we really need to clone here, but no clone is available for " + ty_info.rust_obj)
449 ret_conv_name += " | 1"
451 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 = ", ";")
452 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);")
454 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 = ", ";")
455 if not ty_info.is_ptr or holds_ref:
456 to_hu_conv_sfx = "\n" + self.consts.add_ref(ty_info.var_name + "_hu_conv", "this") + ";"
459 if from_hu_conv is None:
460 from_hu_conv = (ty_info.var_name + " != null ? " + self.consts.get_ptr(ty_info.var_name) + " : 0", "")
461 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
462 arg_conv = base_conv, arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
463 ret_conv = ret_conv, ret_conv_name = ret_conv_name,
464 to_hu_conv = self.consts.var_decl_statement(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,
465 to_hu_conv_name = ty_info.var_name + "_hu_conv", from_hu_conv = from_hu_conv)
467 # The manually-defined types - TxOut and u5
468 if ty_info.rust_obj == "LDKu5":
469 assert from_hu_conv is None
470 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
471 arg_conv = "", arg_conv_name = "(LDKu5){ ._0 = " + ty_info.var_name + " }", arg_conv_cleanup = None,
472 ret_conv = ("uint8_t " + ty_info.var_name + "_val = ", "._0;"), ret_conv_name = ty_info.var_name + "_val",
473 to_hu_conv = self.consts.var_decl_statement(ty_info.java_hu_ty, ty_info.var_name + "_conv", "new " + ty_info.java_hu_ty + "(" + ty_info.var_name + ")") + ";",
474 to_hu_conv_name = ty_info.var_name + "_conv", from_hu_conv = (ty_info.var_name + ".getVal()", ""))
476 assert ty_info.rust_obj == "LDKTxOut"
477 if not ty_info.is_ptr and not holds_ref:
478 ret_conv = ("LDKTxOut* " + ty_info.var_name + "_ref = MALLOC(sizeof(LDKTxOut), \"LDKTxOut\");\n*" + ty_info.var_name + "_ref = ", ";")
480 ret_conv = ("uint64_t " + ty_info.var_name + "_ref = ((uint64_t)&", ") | 1;")
481 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
482 arg_conv = base_conv, arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
483 ret_conv = ret_conv, ret_conv_name = "(uint64_t)" + ty_info.var_name + "_ref",
484 to_hu_conv = self.consts.var_decl_statement(ty_info.java_hu_ty, ty_info.var_name + "_conv", "new " +ty_info.java_hu_ty + "(null, " + ty_info.var_name + ")") + ";",
485 to_hu_conv_name = ty_info.var_name + "_conv", from_hu_conv = (self.consts.get_ptr(ty_info.var_name), ""))
488 if ty_info.rust_obj in self.complex_enums:
489 ret_conv = ("uint64_t ret_" + ty_info.var_name + " = (uint64_t)", " | 1; // Warning: We should clone here!")
490 from_hu_sfx = self.consts.add_ref("this", ty_info.var_name)
491 if ty_info.rust_obj.replace("LDK", "") + "_clone" in self.clone_fns:
492 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"
493 ret_conv_pfx += "*ret_" + ty_info.var_name + " = " + ty_info.rust_obj.replace("LDK", "") + "_clone("
494 ret_conv = (ret_conv_pfx, ");")
496 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
497 arg_conv = ty_info.rust_obj + "* " + ty_info.var_name + "_conv = (" + ty_info.rust_obj + "*)" + ty_info.var_name + ";",
498 arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
499 ret_conv = ret_conv, ret_conv_name = "(uint64_t)ret_" + ty_info.var_name,
500 to_hu_conv = self.consts.var_decl_statement(ty_info.java_hu_ty, ty_info.var_name + "_hu_conv", ty_info.java_hu_ty + ".constr_from_ptr(" + ty_info.var_name + ")") + ";",
501 to_hu_conv_name = ty_info.var_name + "_hu_conv",
502 from_hu_conv = (ty_info.var_name + " == null ? 0 : " + self.consts.get_ptr(ty_info.var_name) + " & ~1", from_hu_sfx))
503 elif ty_info.rust_obj in self.trait_structs:
504 if ty_info.nonnull_ptr:
505 arg_conv = "void* " + ty_info.var_name + "_ptr = (void*)(((uint64_t)" + ty_info.var_name + ") & ~1);\n"
506 arg_conv += "if (!(" + ty_info.var_name + " & 1)) { CHECK_ACCESS(" + ty_info.var_name + "_ptr); }\n"
507 arg_conv += ty_info.rust_obj + "* " + ty_info.var_name + "_conv = (" + ty_info.rust_obj + "*)" + ty_info.var_name + "_ptr;"
508 arg_conv_name = ty_info.var_name + "_conv"
510 # We map Option<Trait> as *mut Trait, which we can differentiate from &Trait by the NONNULL_PTR annotation.
511 # We handle the Option<Trait> case here.
512 arg_conv = ty_info.rust_obj + " *" + ty_info.var_name + "_conv_ptr = NULL;\n"
513 arg_conv += "if (" + ty_info.var_name + " != 0) {\n"
514 arg_conv += "\t" + ty_info.rust_obj + " " + ty_info.var_name + "_conv;\n"
515 arg_conv += "void* " + ty_info.var_name + "_ptr = (void*)(((uint64_t)" + ty_info.var_name + ") & ~1);\n"
516 arg_conv += "CHECK_ACCESS(" + ty_info.var_name + "_ptr);\n"
517 arg_conv += "\t" + ty_info.var_name + "_conv = *(" + ty_info.rust_obj + "*)" + ty_info.var_name + "_ptr;"
518 arg_conv += self.consts.trait_struct_inc_refcnt(ty_info).replace("\n", "\n\t")
519 arg_conv += "\n\t" + ty_info.var_name + "_conv_ptr = MALLOC(sizeof(" + ty_info.rust_obj + "), \"" + ty_info.rust_obj + "\");\n"
520 arg_conv += "\t*" + ty_info.var_name + "_conv_ptr = " + ty_info.var_name + "_conv;\n"
522 arg_conv_name = ty_info.var_name + "_conv_ptr"
523 if ty_info.rust_obj.replace("LDK", "") + "_clone" in self.clone_fns:
524 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
525 arg_conv = arg_conv, arg_conv_name = arg_conv_name, arg_conv_cleanup = None,
526 ret_conv = (ty_info.rust_obj + " *" + ty_info.var_name + "_clone = MALLOC(sizeof(" + ty_info.rust_obj + "), \"" + ty_info.rust_obj + "\");\n" +
527 "*" + ty_info.var_name + "_clone = " + ty_info.rust_obj.replace("LDK", "") + "_clone(", ");"),
528 ret_conv_name = "(uint64_t)" + ty_info.var_name + "_clone",
529 to_hu_conv = self.consts.var_decl_statement(ty_info.java_hu_ty, "ret_hu_conv", "new " + ty_info.java_hu_ty + "(null, " + ty_info.var_name + ")") + ";\n" + self.consts.add_ref("ret_hu_conv", "this") + ";",
530 to_hu_conv_name = "ret_hu_conv",
531 from_hu_conv = (ty_info.var_name + " == null ? 0 : " + self.consts.get_ptr(ty_info.var_name), ""))
533 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
534 arg_conv = arg_conv, arg_conv_name = arg_conv_name, arg_conv_cleanup = None,
535 ret_conv = ("// WARNING: This object doesn't live past this scope, needs clone!\nuint64_t ret_" + ty_info.var_name + " = ((uint64_t)", ") | 1;"),
536 ret_conv_name = "ret_" + ty_info.var_name,
537 to_hu_conv = self.consts.var_decl_statement(ty_info.java_hu_ty, "ret_hu_conv", "new " + ty_info.java_hu_ty + "(null, " + ty_info.var_name + ")") + ";\n" + self.consts.add_ref("ret_hu_conv", "this") + ";",
538 to_hu_conv_name = "ret_hu_conv",
539 from_hu_conv = (ty_info.var_name + " == null ? 0 : " + self.consts.get_ptr(ty_info.var_name), self.consts.add_ref("this", ty_info.var_name)))
540 return ConvInfo(ty_info = ty_info, arg_name = ty_info.var_name,
541 arg_conv = ty_info.rust_obj + "* " + ty_info.var_name + "_conv = (" + ty_info.rust_obj + "*)(" + ty_info.var_name + " & ~1);",
542 arg_conv_name = ty_info.var_name + "_conv", arg_conv_cleanup = None,
543 ret_conv = ("uint64_t ret_" + ty_info.var_name + " = (uint64_t)", ";"), ret_conv_name = "ret_" + ty_info.var_name,
544 to_hu_conv = "TODO 3", to_hu_conv_name = None, from_hu_conv = None) # its a pointer, no conv needed
545 assert False # We should have handled every case by now.