2 import debugger_pretty_printers_common as rustpp
4 # ===============================================================================
5 # LLDB Pretty Printing Module for Rust
6 # ===============================================================================
9 class LldbType(rustpp.Type):
11 def __init__(self, ty):
12 super(LldbType, self).__init__()
16 def get_unqualified_type_name(self):
17 qualified_name = self.ty.GetName()
19 if qualified_name is None:
22 return rustpp.extract_type_name(qualified_name).replace("&'static ", "&")
24 def get_dwarf_type_kind(self):
25 type_class = self.ty.GetTypeClass()
27 if type_class == lldb.eTypeClassStruct:
28 return rustpp.DWARF_TYPE_CODE_STRUCT
30 if type_class == lldb.eTypeClassUnion:
31 return rustpp.DWARF_TYPE_CODE_UNION
33 if type_class == lldb.eTypeClassPointer:
34 return rustpp.DWARF_TYPE_CODE_PTR
36 if type_class == lldb.eTypeClassArray:
37 return rustpp.DWARF_TYPE_CODE_ARRAY
39 if type_class == lldb.eTypeClassEnumeration:
40 return rustpp.DWARF_TYPE_CODE_ENUM
45 assert ((self.get_dwarf_type_kind() == rustpp.DWARF_TYPE_CODE_STRUCT) or
46 (self.get_dwarf_type_kind() == rustpp.DWARF_TYPE_CODE_UNION))
47 if self.fields is None:
48 self.fields = list(self.ty.fields)
51 def get_wrapped_value(self):
55 class LldbValue(rustpp.Value):
56 def __init__(self, lldb_val):
59 super(LldbValue, self).__init__(wty)
60 self.lldb_val = lldb_val
63 def get_child_at_index(self, index):
64 child = self.children.get(index)
66 lldb_field = self.lldb_val.GetChildAtIndex(index)
67 child = LldbValue(lldb_field)
68 self.children[index] = child
72 return self.lldb_val.GetValueAsUnsigned()
74 def get_wrapped_value(self):
78 def print_val(lldb_val, internal_dict):
79 val = LldbValue(lldb_val)
80 type_kind = val.type.get_type_kind()
82 if (type_kind == rustpp.TYPE_KIND_REGULAR_STRUCT or
83 type_kind == rustpp.TYPE_KIND_REGULAR_UNION or
84 type_kind == rustpp.TYPE_KIND_EMPTY):
85 return print_struct_val(val,
87 omit_first_field=False,
91 if type_kind == rustpp.TYPE_KIND_STRUCT_VARIANT:
92 return print_struct_val(val,
94 omit_first_field=True,
98 if type_kind == rustpp.TYPE_KIND_SLICE:
99 return print_vec_slice_val(val, internal_dict)
101 if type_kind == rustpp.TYPE_KIND_STR_SLICE:
102 return print_str_slice_val(val, internal_dict)
104 if type_kind == rustpp.TYPE_KIND_STD_VEC:
105 return print_std_vec_val(val, internal_dict)
107 if type_kind == rustpp.TYPE_KIND_STD_STRING:
108 return print_std_string_val(val, internal_dict)
110 if type_kind == rustpp.TYPE_KIND_TUPLE:
111 return print_struct_val(val,
113 omit_first_field=False,
117 if type_kind == rustpp.TYPE_KIND_TUPLE_STRUCT:
118 return print_struct_val(val,
120 omit_first_field=False,
121 omit_type_name=False,
124 if type_kind == rustpp.TYPE_KIND_CSTYLE_VARIANT:
125 return val.type.get_unqualified_type_name()
127 if type_kind == rustpp.TYPE_KIND_TUPLE_VARIANT:
128 return print_struct_val(val,
130 omit_first_field=True,
131 omit_type_name=False,
134 if type_kind == rustpp.TYPE_KIND_SINGLETON_ENUM:
135 return print_val(lldb_val.GetChildAtIndex(0), internal_dict)
137 if type_kind == rustpp.TYPE_KIND_PTR:
138 return print_pointer_val(val, internal_dict)
140 if type_kind == rustpp.TYPE_KIND_FIXED_SIZE_VEC:
141 return print_fixed_size_vec_val(val, internal_dict)
143 if type_kind == rustpp.TYPE_KIND_REGULAR_ENUM:
144 # This is a regular enum, extract the discriminant
145 discriminant_val = rustpp.get_discriminant_value_as_integer(val)
146 return print_val(lldb_val.GetChildAtIndex(discriminant_val), internal_dict)
148 if type_kind == rustpp.TYPE_KIND_COMPRESSED_ENUM:
149 encoded_enum_info = rustpp.EncodedEnumInfo(val)
150 if encoded_enum_info.is_null_variant():
151 return encoded_enum_info.get_null_variant_name()
153 non_null_val = encoded_enum_info.get_non_null_variant_val()
154 return print_val(non_null_val.get_wrapped_value(), internal_dict)
156 # No pretty printer has been found
157 return lldb_val.GetValue()
160 # =---------------------------------------------------------------------------------------
161 # Type-Specialized Printing Functions
162 # =---------------------------------------------------------------------------------------
164 def print_struct_val(val, internal_dict, omit_first_field, omit_type_name, is_tuple_like):
166 Prints a struct, tuple, or tuple struct value with Rust syntax.
167 Ignores any fields before field_start_index.
169 assert (val.type.get_dwarf_type_kind() == rustpp.DWARF_TYPE_CODE_STRUCT or
170 val.type.get_dwarf_type_kind() == rustpp.DWARF_TYPE_CODE_UNION)
175 type_name = val.type.get_unqualified_type_name()
178 template = "%(type_name)s(%(body)s)"
181 template = "%(type_name)s {\n%(body)s\n}"
184 fields = val.type.get_fields()
186 def render_child(child_index):
188 if not is_tuple_like:
189 field_name = fields[child_index].name
190 this += field_name + ": "
192 field_val = val.get_child_at_index(child_index)
194 if not field_val.get_wrapped_value().IsValid():
195 field = fields[child_index]
196 # LLDB is not good at handling zero-sized values, so we have to help
198 if field.GetType().GetByteSize() == 0:
199 return this + rustpp.extract_type_name(field.GetType().GetName())
201 return this + "<invalid value>"
203 return this + print_val(field_val.get_wrapped_value(), internal_dict)
206 field_start_index = 1
208 field_start_index = 0
210 body = separator.join([render_child(idx) for idx in range(field_start_index, len(fields))])
212 return template % {"type_name": type_name,
216 def print_pointer_val(val, internal_dict):
217 """Prints a pointer value with Rust syntax"""
218 assert val.type.get_dwarf_type_kind() == rustpp.DWARF_TYPE_CODE_PTR
220 type_name = val.type.get_unqualified_type_name()
221 if type_name and type_name[0:1] in ["&", "*"]:
222 sigil = type_name[0:1]
224 return sigil + hex(val.as_integer())
227 def print_fixed_size_vec_val(val, internal_dict):
228 assert val.type.get_dwarf_type_kind() == rustpp.DWARF_TYPE_CODE_ARRAY
229 lldb_val = val.get_wrapped_value()
233 for i in range(lldb_val.num_children):
234 output += print_val(lldb_val.GetChildAtIndex(i), internal_dict)
235 if i != lldb_val.num_children - 1:
242 def print_vec_slice_val(val, internal_dict):
243 (length, data_ptr) = rustpp.extract_length_and_ptr_from_slice(val)
244 return "&[%s]" % print_array_of_values(val.get_wrapped_value().GetName(),
250 def print_std_vec_val(val, internal_dict):
251 (length, data_ptr, cap) = rustpp.extract_length_ptr_and_cap_from_std_vec(val)
252 return "vec![%s]" % print_array_of_values(val.get_wrapped_value().GetName(),
258 def print_str_slice_val(val, internal_dict):
259 (length, data_ptr) = rustpp.extract_length_and_ptr_from_slice(val)
260 return read_utf8_string(data_ptr, length)
263 def print_std_string_val(val, internal_dict):
264 vec = val.get_child_at_index(0)
265 (length, data_ptr, cap) = rustpp.extract_length_ptr_and_cap_from_std_vec(vec)
266 return read_utf8_string(data_ptr, length)
268 # =-----------------------------------------------------------------------
270 # =-----------------------------------------------------------------------
273 def print_array_of_values(array_name, data_ptr_val, length, internal_dict):
274 """Prints a contiguous memory range, interpreting it as values of the
275 pointee-type of data_ptr_val."""
277 data_ptr_type = data_ptr_val.type
278 assert data_ptr_type.get_dwarf_type_kind() == rustpp.DWARF_TYPE_CODE_PTR
280 element_type = data_ptr_type.get_wrapped_value().GetPointeeType()
281 element_type_size = element_type.GetByteSize()
283 start_address = data_ptr_val.as_integer()
284 raw_value = data_ptr_val.get_wrapped_value()
286 def render_element(i):
287 address = start_address + i * element_type_size
288 element_val = raw_value.CreateValueFromAddress(array_name + ("[%s]" % i),
291 return print_val(element_val, internal_dict)
293 return ', '.join([render_element(i) for i in range(length)])
296 def read_utf8_string(ptr_val, byte_count):
299 error = lldb.SBError()
300 process = ptr_val.get_wrapped_value().GetProcess()
301 data = process.ReadMemory(ptr_val.as_integer(), byte_count, error)
303 return '"%s"' % data.decode(encoding='UTF-8')
305 return '<error: %s>' % error.GetCString()