| ... | ... | @@ -0,0 +1,575 @@ |
| 1 | # pretty printing for the zig language, zig standard library, and zig stage 2 compiler. |
| 2 | # put commands in ~/.lldbinit to run them automatically when starting lldb |
| 3 | # `command script /path/to/stage2_lldb_pretty_printers.py` to import this file |
| 4 | # `type category enable zig` to enable pretty printing for the zig language |
| 5 | # `type category enable zig.std` to enable pretty printing for the zig standard library |
| 6 | # `type category enable zig.stage2` to enable pretty printing for the zig stage 2 compiler |
| 7 | import lldb |
| 8 | import re |
| 9 | |
| 10 | page_size = 1 << 12 |
| 11 | |
| 12 | def log2_int(i): return i.bit_length() - 1 |
| 13 | |
| 14 | # Define Zig Language |
| 15 | |
| 16 | zig_keywords = { |
| 17 | 'addrspace', |
| 18 | 'align', |
| 19 | 'allowzero', |
| 20 | 'and', |
| 21 | 'anyframe', |
| 22 | 'anytype', |
| 23 | 'asm', |
| 24 | 'async', |
| 25 | 'await', |
| 26 | 'break', |
| 27 | 'callconv', |
| 28 | 'catch', |
| 29 | 'comptime', |
| 30 | 'const', |
| 31 | 'continue', |
| 32 | 'defer', |
| 33 | 'else', |
| 34 | 'enum', |
| 35 | 'errdefer', |
| 36 | 'error', |
| 37 | 'export', |
| 38 | 'extern', |
| 39 | 'fn', |
| 40 | 'for', |
| 41 | 'if', |
| 42 | 'inline', |
| 43 | 'noalias', |
| 44 | 'noinline', |
| 45 | 'nosuspend', |
| 46 | 'opaque', |
| 47 | 'or', |
| 48 | 'orelse', |
| 49 | 'packed', |
| 50 | 'pub', |
| 51 | 'resume', |
| 52 | 'return', |
| 53 | 'linksection', |
| 54 | 'struct', |
| 55 | 'suspend', |
| 56 | 'switch', |
| 57 | 'test', |
| 58 | 'threadlocal', |
| 59 | 'try', |
| 60 | 'union', |
| 61 | 'unreachable', |
| 62 | 'usingnamespace', |
| 63 | 'var', |
| 64 | 'volatile', |
| 65 | 'while', |
| 66 | } |
| 67 | zig_primitives = { |
| 68 | 'anyerror', |
| 69 | 'anyframe', |
| 70 | 'anyopaque', |
| 71 | 'bool', |
| 72 | 'c_int', |
| 73 | 'c_long', |
| 74 | 'c_longdouble', |
| 75 | 'c_longlong', |
| 76 | 'c_short', |
| 77 | 'c_uint', |
| 78 | 'c_ulong', |
| 79 | 'c_ulonglong', |
| 80 | 'c_ushort', |
| 81 | 'comptime_float', |
| 82 | 'comptime_int', |
| 83 | 'f128', |
| 84 | 'f16', |
| 85 | 'f32', |
| 86 | 'f64', |
| 87 | 'f80', |
| 88 | 'false', |
| 89 | 'isize', |
| 90 | 'noreturn', |
| 91 | 'null', |
| 92 | 'true', |
| 93 | 'type', |
| 94 | 'undefined', |
| 95 | 'usize', |
| 96 | 'void', |
| 97 | } |
| 98 | zig_integer_type = re.compile('[iu][1-9][0-9]+') |
| 99 | zig_identifier_regex = re.compile('[A-Z_a-z][0-9A-Z_a-z]*') |
| 100 | def zig_IsVariableName(string): return string != '_' and string not in zig_keywords and string not in zig_primitives and not zig_integer_type.fullmatch(string) and zig_identifier_regex.fullmatch(string) |
| 101 | def zig_IsFieldName(string): return string not in zig_keywords and zig_identifier_regex.fullmatch(string) |
| 102 | |
| 103 | class zig_Slice_SynthProvider: |
| 104 | def __init__(self, value, _=None): self.value = value |
| 105 | def update(self): |
| 106 | try: |
| 107 | self.ptr = self.value.GetChildMemberWithName('ptr') |
| 108 | self.len = self.value.GetChildMemberWithName('len').unsigned if self.ptr.unsigned > page_size else 0 |
| 109 | self.elem_type = self.ptr.type.GetPointeeType() |
| 110 | self.elem_size = self.elem_type.size |
| 111 | except: pass |
| 112 | def has_children(self): return True |
| 113 | def num_children(self): return self.len or 0 |
| 114 | def get_child_index(self, name): |
| 115 | try: return int(name.removeprefix('[').removesuffix(']')) |
| 116 | except: return -1 |
| 117 | def get_child_at_index(self, index): |
| 118 | if index < 0 or index >= self.len: return None |
| 119 | try: return self.ptr.CreateChildAtOffset('[%d]' % index, index * self.elem_size, self.elem_type) |
| 120 | except: return None |
| 121 | |
| 122 | def zig_String_decode(value, offset=0, length=None): |
| 123 | try: |
| 124 | value = value.GetNonSyntheticValue() |
| 125 | data = value.GetChildMemberWithName('ptr').GetPointeeData(offset, length if length is not None else value.GetChildMemberWithName('len').unsigned) |
| 126 | b = bytes(data.uint8) |
| 127 | b = b.replace(b'\\', b'\\\\') |
| 128 | b = b.replace(b'\n', b'\\n') |
| 129 | b = b.replace(b'\r', b'\\r') |
| 130 | b = b.replace(b'\t', b'\\t') |
| 131 | b = b.replace(b'"', b'\\"') |
| 132 | b = b.replace(b'\'', b'\\\'') |
| 133 | s = b.decode(encoding='ascii', errors='backslashreplace') |
| 134 | return s if s.isprintable() else ''.join((c if c.isprintable() else '\\x%02x' % ord(c) for c in s)) |
| 135 | except: return None |
| 136 | def zig_String_SummaryProvider(value, _=None): return '"%s"' % zig_String_decode(value) |
| 137 | def zig_String_AsIdentifier(value, pred): |
| 138 | string = zig_String_decode(value) |
| 139 | return string if pred(string) else '@"%s"' % string |
| 140 | |
| 141 | class zig_Optional_SynthProvider: |
| 142 | def __init__(self, value, _=None): self.value = value |
| 143 | def update(self): |
| 144 | try: |
| 145 | self.child = self.value.GetChildMemberWithName('some').unsigned == 1 and self.value.GetChildMemberWithName('data').Clone('child') |
| 146 | except: pass |
| 147 | def has_children(self): return bool(self.child) |
| 148 | def num_children(self): return int(self.child) |
| 149 | def get_child_index(self, name): return 0 if self.child and (name == 'child' or name == '?') else -1 |
| 150 | def get_child_at_index(self, index): return self.child if self.child and index == 0 else None |
| 151 | def zig_Optional_SummaryProvider(value, _=None): |
| 152 | child = value.GetChildMemberWithName('child') |
| 153 | return child or 'null' |
| 154 | |
| 155 | class zig_ErrorUnion_SynthProvider: |
| 156 | def __init__(self, value, _=None): self.value = value |
| 157 | def update(self): |
| 158 | try: |
| 159 | self.error_set = self.value.GetChildMemberWithName('tag').Clone('error_set') |
| 160 | self.payload = self.value.GetChildMemberWithName('value').Clone('payload') if self.error_set.unsigned == 0 else None |
| 161 | except: pass |
| 162 | def has_children(self): return True |
| 163 | def num_children(self): return 1 |
| 164 | def get_child_index(self, name): return 0 if name == ('payload' if self.payload else 'error_set') else -1 |
| 165 | def get_child_at_index(self, index): return self.payload or self.error_set if index == 0 else None |
| 166 | |
| 167 | # Define Zig Standard Library |
| 168 | |
| 169 | class std_SegmentedList_SynthProvider: |
| 170 | def __init__(self, value, _=None): self.value = value |
| 171 | def update(self): |
| 172 | try: |
| 173 | self.prealloc_segment = self.value.GetChildMemberWithName('prealloc_segment') |
| 174 | self.dynamic_segments = zig_Slice_SynthProvider(self.value.GetChildMemberWithName('dynamic_segments')) |
| 175 | self.dynamic_segments.update() |
| 176 | self.len = self.value.GetChildMemberWithName('len').unsigned |
| 177 | except: pass |
| 178 | def has_children(self): return True |
| 179 | def num_children(self): return self.len |
| 180 | def get_child_index(self, name): |
| 181 | try: return int(name.removeprefix('[').removesuffix(']')) |
| 182 | except: return -1 |
| 183 | def get_child_at_index(self, index): |
| 184 | try: |
| 185 | if index < 0 or index >= self.len: return None |
| 186 | prealloc_item_count = len(self.prealloc_segment) |
| 187 | if index < prealloc_item_count: return self.prealloc_segment.child[index] |
| 188 | prealloc_exp = prealloc_item_count.bit_length() - 1 |
| 189 | shelf_index = log2_int(index + 1) if prealloc_item_count == 0 else log2_int(index + prealloc_item_count) - prealloc_exp - 1 |
| 190 | shelf = self.dynamic_segments.get_child_at_index(shelf_index) |
| 191 | box_index = (index + 1) - (1 << shelf_index) if prealloc_item_count == 0 else index + prealloc_item_count - (1 << ((prealloc_exp + 1) + shelf_index)) |
| 192 | elem_type = shelf.type.GetPointeeType() |
| 193 | return shelf.CreateChildAtOffset('[%d]' % index, box_index * elem_type.size, elem_type) |
| 194 | except: return None |
| 195 | |
| 196 | class std_MultiArrayList_SynthProvider: |
| 197 | def __init__(self, value, _=None): self.value = value |
| 198 | def update(self): |
| 199 | try: |
| 200 | self.len = 0 |
| 201 | |
| 202 | value_type = self.value.type |
| 203 | for helper in self.value.target.FindFunctions('%s.dbHelper' % value_type.name, lldb.eFunctionNameTypeFull): |
| 204 | ptr_self_type, ptr_child_type, ptr_entry_type = helper.function.type.GetFunctionArgumentTypes() |
| 205 | if ptr_self_type.GetPointeeType() == value_type: break |
| 206 | else: return |
| 207 | |
| 208 | self.entry_type = ptr_entry_type.GetPointeeType() |
| 209 | self.bytes = self.value.GetChildMemberWithName('bytes') |
| 210 | self.len = self.value.GetChildMemberWithName('len').unsigned |
| 211 | self.capacity = self.value.GetChildMemberWithName('capacity').unsigned |
| 212 | except: pass |
| 213 | def has_children(self): return True |
| 214 | def num_children(self): return self.len |
| 215 | def get_child_index(self, name): |
| 216 | try: return int(name.removeprefix('[').removesuffix(']')) |
| 217 | except: return -1 |
| 218 | def get_child_at_index(self, index): |
| 219 | try: |
| 220 | if index < 0 or index >= self.len: return None |
| 221 | offset = 0 |
| 222 | data = lldb.SBData() |
| 223 | for field in self.entry_type.fields: |
| 224 | ptr_field_type = field.type |
| 225 | field_size = ptr_field_type.GetPointeeType().size |
| 226 | data.Append(self.bytes.CreateChildAtOffset(field.name, offset + index * field_size, ptr_field_type).address_of.data) |
| 227 | offset += self.capacity * field_size |
| 228 | return self.bytes.CreateValueFromData('[%d]' % index, data, self.entry_type) |
| 229 | except: return None |
| 230 | |
| 231 | class std_HashMapUnmanaged_SynthProvider: |
| 232 | def __init__(self, value, _=None): self.value = value |
| 233 | def update(self): |
| 234 | try: |
| 235 | self.capacity = 0 |
| 236 | self.indices = tuple() |
| 237 | |
| 238 | self.metadata = self.value.GetChildMemberWithName('metadata') |
| 239 | if not self.metadata.unsigned: return |
| 240 | |
| 241 | value_type = self.value.type |
| 242 | for helper in self.value.target.FindFunctions('%s.dbHelper' % value_type.name, lldb.eFunctionNameTypeFull): |
| 243 | ptr_self_type, ptr_hdr_type, ptr_entry_type = helper.function.type.GetFunctionArgumentTypes() |
| 244 | if ptr_self_type.GetPointeeType() == value_type: break |
| 245 | else: return |
| 246 | self.entry_type = ptr_entry_type.GetPointeeType() |
| 247 | |
| 248 | hdr_type = ptr_hdr_type.GetPointeeType() |
| 249 | hdr = self.metadata.CreateValueFromAddress('header', self.metadata.deref.load_addr - hdr_type.size, hdr_type) |
| 250 | self.values = hdr.GetChildMemberWithName('values') |
| 251 | self.keys = hdr.GetChildMemberWithName('keys') |
| 252 | self.capacity = hdr.GetChildMemberWithName('capacity').unsigned |
| 253 | |
| 254 | self.indices = tuple(i for i, value in enumerate(self.metadata.GetPointeeData(0, self.capacity).sint8) if value < 0) |
| 255 | except: pass |
| 256 | def has_children(self): return True |
| 257 | def num_children(self): return len(self.indices) |
| 258 | def get_capacity(self): return self.capacity |
| 259 | def get_child_index(self, name): |
| 260 | try: return int(name.removeprefix('[').removesuffix(']')) |
| 261 | except: return -1 |
| 262 | def get_child_at_index(self, index): |
| 263 | try: |
| 264 | fields = {name: base.CreateChildAtOffset(name, self.indices[index] * pointee_type.size, pointee_type).address_of.data for name, base, pointee_type in ((name, base, base.type.GetPointeeType()) for name, base in (('key_ptr', self.keys), ('value_ptr', self.values)))} |
| 265 | data = lldb.SBData() |
| 266 | for field in self.entry_type.fields: data.Append(fields[field.name]) |
| 267 | return self.metadata.CreateValueFromData('[%d]' % index, data, self.entry_type) |
| 268 | except: return None |
| 269 | def std_HashMapUnmanaged_SummaryProvider(value, _=None): |
| 270 | synth = std_HashMapUnmanaged_SynthProvider(value.GetNonSyntheticValue(), _) |
| 271 | synth.update() |
| 272 | return 'len=%d capacity=%d' % (synth.num_children(), synth.get_capacity()) |
| 273 | |
| 274 | # formats a struct of fields of the form `name_ptr: *Type` by auto dereferencing its fields |
| 275 | class std_Entry_SynthProvider: |
| 276 | def __init__(self, value, _=None): self.value = value |
| 277 | def update(self): |
| 278 | try: |
| 279 | self.children = tuple(child.Clone(child.name.removesuffix('_ptr')) for child in self.value.children if child.type.GetPointeeType().size != 0) |
| 280 | self.indices = {child.name: i for i, child in enumerate(self.children)} |
| 281 | except: pass |
| 282 | def has_children(self): return self.num_children() != 0 |
| 283 | def num_children(self): return len(self.children) |
| 284 | def get_child_index(self, name): return self.indices.get(name) |
| 285 | def get_child_at_index(self, index): return self.children[index].deref if index >= 0 and index < len(self.children) else None |
| 286 | |
| 287 | # Define Zig Stage2 Compiler |
| 288 | |
| 289 | class TagAndPayload_SynthProvider: |
| 290 | def __init__(self, value, _=None): self.value = value |
| 291 | def update(self): |
| 292 | try: |
| 293 | self.tag = self.value.GetChildMemberWithName('tag') or self.value.GetChildMemberWithName('tag_ptr').deref.Clone('tag') |
| 294 | data = self.value.GetChildMemberWithName('data_ptr') or self.value.GetChildMemberWithName('data') |
| 295 | self.payload = data.GetChildMemberWithName('payload').GetChildMemberWithName(data.GetChildMemberWithName('tag').value) |
| 296 | except: pass |
| 297 | def has_children(self): return True |
| 298 | def num_children(self): return 2 |
| 299 | def get_child_index(self, name): |
| 300 | try: return ('tag', 'payload').index(name) |
| 301 | except: return -1 |
| 302 | def get_child_at_index(self, index): return (self.tag, self.payload)[index] if index >= 0 and index < 2 else None |
| 303 | |
| 304 | def Inst_Ref_SummaryProvider(value, _=None): |
| 305 | members = value.type.enum_members |
| 306 | return value if any(value.unsigned == member.unsigned for member in members) else 'instructions[%d]' % (value.unsigned - len(members)) |
| 307 | |
| 308 | class Module_Decl__Module_Decl_Index_SynthProvider: |
| 309 | def __init__(self, value, _=None): self.value = value |
| 310 | def update(self): |
| 311 | try: |
| 312 | for frame in self.value.thread: |
| 313 | mod = frame.FindVariable('mod') or frame.FindVariable('module') |
| 314 | if mod: break |
| 315 | else: return |
| 316 | self.ptr = mod.GetChildMemberWithName('allocated_decls').GetChildAtIndex(self.value.unsigned).Clone('decl') |
| 317 | except: pass |
| 318 | def has_children(self): return True |
| 319 | def num_children(self): return 1 |
| 320 | def get_child_index(self, name): return 0 if name == 'decl' else -1 |
| 321 | def get_child_at_index(self, index): return self.ptr if index == 0 else None |
| 322 | |
| 323 | class TagOrPayloadPtr_SynthProvider: |
| 324 | def __init__(self, value, _=None): self.value = value |
| 325 | def update(self): |
| 326 | try: |
| 327 | value_type = self.value.type |
| 328 | for helper in self.value.target.FindFunctions('%s.dbHelper' % value_type.name, lldb.eFunctionNameTypeFull): |
| 329 | ptr_self_type, ptr_tag_to_payload_map_type = helper.function.type.GetFunctionArgumentTypes() |
| 330 | self_type = ptr_self_type.GetPointeeType() |
| 331 | if self_type == value_type: break |
| 332 | else: return |
| 333 | tag_to_payload_map = {field.name: field.type for field in ptr_tag_to_payload_map_type.GetPointeeType().fields} |
| 334 | |
| 335 | tag = self.value.GetChildMemberWithName('tag_if_small_enough') |
| 336 | if tag.unsigned < page_size: |
| 337 | self.tag = tag.Clone('tag') |
| 338 | self.payload = None |
| 339 | else: |
| 340 | ptr_otherwise = self.value.GetChildMemberWithName('ptr_otherwise') |
| 341 | self.tag = ptr_otherwise.GetChildMemberWithName('tag') |
| 342 | self.payload = ptr_otherwise.Cast(tag_to_payload_map[self.tag.value]).GetChildMemberWithName('data').Clone('payload') |
| 343 | except: pass |
| 344 | def has_children(self): return True |
| 345 | def num_children(self): return 1 + (self.payload is not None) |
| 346 | def get_child_index(self, name): |
| 347 | try: return ('tag', 'payload').index(name) |
| 348 | except: return -1 |
| 349 | def get_child_at_index(self, index): return (self.tag, self.payload)[index] if index >= 0 and index < 2 else None |
| 350 | |
| 351 | def Module_Decl_name(decl): |
| 352 | error = lldb.SBError() |
| 353 | return decl.process.ReadCStringFromMemory(decl.GetChildMemberWithName('name').deref.load_addr, 256, error) |
| 354 | |
| 355 | def Module_Namespace_RenderFullyQualifiedName(namespace): |
| 356 | parent = namespace.GetChildMemberWithName('parent') |
| 357 | if parent.unsigned < page_size: return zig_String_decode(namespace.GetChildMemberWithName('file_scope').GetChildMemberWithName('sub_file_path')).removesuffix('.zig').replace('/', '.') |
| 358 | return '.'.join((Module_Namespace_RenderFullyQualifiedName(parent), Module_Decl_name(namespace.GetChildMemberWithName('ty').GetChildMemberWithName('payload').GetChildMemberWithName('owner_decl').GetChildMemberWithName('decl')))) |
| 359 | |
| 360 | def Module_Decl_RenderFullyQualifiedName(decl): return '.'.join((Module_Namespace_RenderFullyQualifiedName(decl.GetChildMemberWithName('src_namespace')), Module_Decl_name(decl))) |
| 361 | |
| 362 | def OwnerDecl_RenderFullyQualifiedName(payload): return Module_Decl_RenderFullyQualifiedName(payload.GetChildMemberWithName('owner_decl').GetChildMemberWithName('decl')) |
| 363 | |
| 364 | def type_Type_pointer(payload): |
| 365 | pointee_type = payload.GetChildMemberWithName('pointee_type') |
| 366 | sentinel = payload.GetChildMemberWithName('sentinel').GetChildMemberWithName('child') |
| 367 | align = payload.GetChildMemberWithName('align').unsigned |
| 368 | addrspace = payload.GetChildMemberWithName('addrspace').value |
| 369 | bit_offset = payload.GetChildMemberWithName('bit_offset').unsigned |
| 370 | host_size = payload.GetChildMemberWithName('host_size').unsigned |
| 371 | vector_index = payload.GetChildMemberWithName('vector_index') |
| 372 | allowzero = payload.GetChildMemberWithName('allowzero').unsigned |
| 373 | const = not payload.GetChildMemberWithName('mutable').unsigned |
| 374 | volatile = payload.GetChildMemberWithName('volatile').unsigned |
| 375 | size = payload.GetChildMemberWithName('size').value |
| 376 | |
| 377 | if size == 'One': summary = '*' |
| 378 | elif size == 'Many': summary = '[*' |
| 379 | elif size == 'Slice': summary = '[' |
| 380 | elif size == 'C': summary = '[*c' |
| 381 | if sentinel: summary += ':%s' % value_Value_SummaryProvider(sentinel) |
| 382 | if size != 'One': summary += ']' |
| 383 | if allowzero: summary += 'allowzero ' |
| 384 | if align != 0 or host_size != 0 or vector_index.value != 'none': summary += 'align(%d%s%s) ' % (align, ':%d:%d' % (bit_offset, host_size) if bit_offset != 0 or host_size != 0 else '', ':?' if vector_index.value == 'runtime' else ':%d' % vector_index.unsigned if vector_index.value != 'none' else '') |
| 385 | if addrspace != 'generic': summary += 'addrspace(.%s) ' % addrspace |
| 386 | if const: summary += 'const ' |
| 387 | if volatile: summary += 'volatile ' |
| 388 | summary += type_Type_SummaryProvider(pointee_type) |
| 389 | return summary |
| 390 | |
| 391 | def type_Type_function(payload): |
| 392 | param_types = payload.GetChildMemberWithName('param_types').children |
| 393 | comptime_params = payload.GetChildMemberWithName('comptime_params').GetPointeeData(0, len(param_types)).uint8 |
| 394 | return_type = payload.GetChildMemberWithName('return_type') |
| 395 | alignment = payload.GetChildMemberWithName('alignment').unsigned |
| 396 | noalias_bits = payload.GetChildMemberWithName('noalias_bits').unsigned |
| 397 | cc = payload.GetChildMemberWithName('cc').value |
| 398 | is_var_args = payload.GetChildMemberWithName('is_var_args').unsigned |
| 399 | |
| 400 | return 'fn(%s)%s%s %s' % (', '.join(tuple(''.join(('comptime ' if comptime_param else '', 'noalias ' if noalias_bits & 1 << i else '', type_Type_SummaryProvider(param_type))) for i, (comptime_param, param_type) in enumerate(zip(comptime_params, param_types))) + (('...',) if is_var_args else ())), ' align(%d)' % alignment if alignment != 0 else '', ' callconv(.%s)' % cc if cc != 'Unspecified' else '', type_Type_SummaryProvider(return_type)) |
| 401 | |
| 402 | def type_Type_SummaryProvider(value, _=None): |
| 403 | tag = value.GetChildMemberWithName('tag').value |
| 404 | return type_tag_handlers.get(tag, lambda payload: tag)(value.GetChildMemberWithName('payload')) |
| 405 | |
| 406 | type_tag_handlers = { |
| 407 | 'atomic_order': lambda payload: 'std.builtin.AtomicOrder', |
| 408 | 'atomic_rmw_op': lambda payload: 'std.builtin.AtomicRmwOp', |
| 409 | 'calling_convention': lambda payload: 'std.builtin.CallingConvention', |
| 410 | 'address_space': lambda payload: 'std.builtin.AddressSpace', |
| 411 | 'float_mode': lambda payload: 'std.builtin.FloatMode', |
| 412 | 'reduce_op': lambda payload: 'std.builtin.ReduceOp', |
| 413 | 'modifier': lambda payload: 'std.builtin.CallModifier', |
| 414 | 'prefetch_options': lambda payload: 'std.builtin.PrefetchOptions', |
| 415 | 'export_options': lambda payload: 'std.builtin.ExportOptions', |
| 416 | 'extern_options': lambda payload: 'std.builtin.ExternOptions', |
| 417 | 'type_info': lambda payload: 'std.builtin.Type', |
| 418 | |
| 419 | 'enum_literal': lambda payload: '@TypeOf(.enum_literal)', |
| 420 | 'null': lambda payload: '@TypeOf(null)', |
| 421 | 'undefined': lambda payload: '@TypeOf(undefined)', |
| 422 | 'empty_struct_literal': lambda payload: '@TypeOf(.{})', |
| 423 | |
| 424 | 'anyerror_void_error_union': lambda payload: 'anyerror!void', |
| 425 | 'const_slice_u8': lambda payload: '[]const u8', |
| 426 | 'const_slice_u8_sentinel_0': lambda payload: '[:0]const u8', |
| 427 | 'fn_noreturn_no_args': lambda payload: 'fn() noreturn', |
| 428 | 'fn_void_no_args': lambda payload: 'fn() void', |
| 429 | 'fn_naked_noreturn_no_args': lambda payload: 'fn() callconv(.Naked) noreturn', |
| 430 | 'fn_ccc_void_no_args': lambda payload: 'fn() callconv(.C) void', |
| 431 | 'single_const_pointer_to_comptime_int': lambda payload: '*const comptime_int', |
| 432 | 'manyptr_u8': lambda payload: '[*]u8', |
| 433 | 'manyptr_const_u8': lambda payload: '[*]const u8', |
| 434 | 'manyptr_const_u8_sentinel_0': lambda payload: '[*:0]const u8', |
| 435 | |
| 436 | 'function': type_Type_function, |
| 437 | 'error_union': lambda payload: '%s!%s' % (type_Type_SummaryProvider(payload.GetChildMemberWithName('error_set')), type_Type_SummaryProvider(payload.GetChildMemberWithName('payload'))), |
| 438 | 'array_u8': lambda payload: '[%d]u8' % payload.unsigned, |
| 439 | 'array_u8_sentinel_0': lambda payload: '[%d:0]u8' % payload.unsigned, |
| 440 | 'vector': lambda payload: '@Vector(%d, %s)' % (payload.GetChildMemberWithName('len').unsigned, type_Type_SummaryProvider(payload.GetChildMemberWithName('elem_type'))), |
| 441 | 'array': lambda payload: '[%d]%s' % (payload.GetChildMemberWithName('len').unsigned, type_Type_SummaryProvider(payload.GetChildMemberWithName('elem_type'))), |
| 442 | 'array_sentinel': lambda payload: '[%d:%s]%s' % (payload.GetChildMemberWithName('len').unsigned, value_Value_SummaryProvider(payload.GetChildMemberWithName('sentinel')), type_Type_SummaryProvider(payload.GetChildMemberWithName('elem_type'))), |
| 443 | 'tuple': lambda payload: 'tuple{%s}' % ', '.join(('comptime %%s = %s' % value_Value_SummaryProvider(value) if value.GetChildMemberWithName('tag').value != 'unreachable_value' else '%s') % type_Type_SummaryProvider(type) for type, value in zip(payload.GetChildMemberWithName('types').children, payload.GetChildMemberWithName('values').children)), |
| 444 | 'anon_struct': lambda payload: 'struct{%s}' % ', '.join(('comptime %%s: %%s = %s' % value_Value_SummaryProvider(value) if value.GetChildMemberWithName('tag').value != 'unreachable_value' else '%s: %s') % (zig_String_AsIdentifier(name, zig_IsFieldName), type_Type_SummaryProvider(type)) for name, type, value in zip(payload.GetChildMemberWithName('names').children, payload.GetChildMemberWithName('types').children, payload.GetChildMemberWithName('values').children)), |
| 445 | 'pointer': type_Type_pointer, |
| 446 | 'single_const_pointer': lambda payload: '*const %s' % type_Type_SummaryProvider(payload), |
| 447 | 'single_mut_pointer': lambda payload: '*%s' % type_Type_SummaryProvider(payload), |
| 448 | 'many_const_pointer': lambda payload: '[*]const %s' % type_Type_SummaryProvider(payload), |
| 449 | 'many_mut_pointer': lambda payload: '[*]%s' % type_Type_SummaryProvider(payload), |
| 450 | 'c_const_pointer': lambda payload: '[*c]const %s' % type_Type_SummaryProvider(payload), |
| 451 | 'c_mut_pointer': lambda payload: '[*c]%s' % type_Type_SummaryProvider(payload), |
| 452 | 'const_slice': lambda payload: '[]const %s' % type_Type_SummaryProvider(payload), |
| 453 | 'mut_slice': lambda payload: '[]%s' % type_Type_SummaryProvider(payload), |
| 454 | 'int_signed': lambda payload: 'i%d' % payload.unsigned, |
| 455 | 'int_unsigned': lambda payload: 'u%d' % payload.unsigned, |
| 456 | 'optional': lambda payload: '?%s' % type_Type_SummaryProvider(payload), |
| 457 | 'optional_single_mut_pointer': lambda payload: '?*%s' % type_Type_SummaryProvider(payload), |
| 458 | 'optional_single_const_pointer': lambda payload: '?*const %s' % type_Type_SummaryProvider(payload), |
| 459 | 'anyframe_T': lambda payload: 'anyframe->%s' % type_Type_SummaryProvider(payload), |
| 460 | 'error_set': lambda payload: type_tag_handlers['error_set_merged'](payload.GetChildMemberWithName('names')), |
| 461 | 'error_set_single': lambda payload: 'error{%s}' % zig_String_AsIdentifier(payload, zig_IsFieldName), |
| 462 | 'error_set_merged': lambda payload: 'error{%s}' % ','.join(zig_String_AsIdentifier(child.GetChildMemberWithName('key'), zig_IsFieldName) for child in payload.GetChildMemberWithName('entries').children), |
| 463 | 'error_set_inferred': lambda payload: '@typeInfo(@typeInfo(@TypeOf(%s)).Fn.return_type.?).ErrorUnion.error_set' % OwnerDecl_RenderFullyQualifiedName(payload.GetChildMemberWithName('func')), |
| 464 | |
| 465 | 'enum_full': OwnerDecl_RenderFullyQualifiedName, |
| 466 | 'enum_nonexhaustive': OwnerDecl_RenderFullyQualifiedName, |
| 467 | 'enum_numbered': OwnerDecl_RenderFullyQualifiedName, |
| 468 | 'enum_simple': OwnerDecl_RenderFullyQualifiedName, |
| 469 | 'struct': OwnerDecl_RenderFullyQualifiedName, |
| 470 | 'union': OwnerDecl_RenderFullyQualifiedName, |
| 471 | 'union_safety_tagged': OwnerDecl_RenderFullyQualifiedName, |
| 472 | 'union_tagged': OwnerDecl_RenderFullyQualifiedName, |
| 473 | 'opaque': OwnerDecl_RenderFullyQualifiedName, |
| 474 | } |
| 475 | |
| 476 | def value_Value_str_lit(payload): |
| 477 | for frame in payload.thread: |
| 478 | mod = frame.FindVariable('mod') or frame.FindVariable('module') |
| 479 | if mod: break |
| 480 | else: return |
| 481 | return '"%s"' % zig_String_decode(mod.GetChildMemberWithName('string_literal_bytes').GetChildMemberWithName('items'), payload.GetChildMemberWithName('index').unsigned, payload.GetChildMemberWithName('len').unsigned) |
| 482 | |
| 483 | def value_Value_SummaryProvider(value, _=None): |
| 484 | tag = value.GetChildMemberWithName('tag').value |
| 485 | return value_tag_handlers.get(tag, lambda payload: tag.removesuffix('_type'))(value.GetChildMemberWithName('payload')) |
| 486 | |
| 487 | value_tag_handlers = { |
| 488 | 'undef': lambda payload: 'undefined', |
| 489 | 'zero': lambda payload: '0', |
| 490 | 'one': lambda payload: '1', |
| 491 | 'void_value': lambda payload: '{}', |
| 492 | 'unreachable_value': lambda payload: 'unreachable', |
| 493 | 'null_value': lambda payload: 'null', |
| 494 | 'bool_true': lambda payload: 'true', |
| 495 | 'bool_false': lambda payload: 'false', |
| 496 | |
| 497 | 'empty_struct_value': lambda payload: '.{}', |
| 498 | 'empty_array': lambda payload: '.{}', |
| 499 | |
| 500 | 'ty': type_Type_SummaryProvider, |
| 501 | 'int_type': lambda payload: '%c%d' % (payload.GetChildMemberWithName('bits').unsigned, 's' if payload.GetChildMemberWithName('signed').unsigned == 1 else 'u'), |
| 502 | 'int_u64': lambda payload: '%d' % payload.unsigned, |
| 503 | 'int_i64': lambda payload: '%d' % payload.signed, |
| 504 | 'int_big_positive': lambda payload: sum(child.unsigned << i * child.type.size * 8 for i, child in enumerate(payload.children)), |
| 505 | 'int_big_negative': lambda payload: '-%s' % value_tag_handlers['int_big_positive'](payload), |
| 506 | 'function': OwnerDecl_RenderFullyQualifiedName, |
| 507 | 'extern_fn': OwnerDecl_RenderFullyQualifiedName, |
| 508 | 'variable': lambda payload: value_Value_SummaryProvider(payload.GetChildMemberWithName('decl').GetChildMemberWithName('val')), |
| 509 | 'runtime_value': value_Value_SummaryProvider, |
| 510 | 'decl_ref': lambda payload: value_Value_SummaryProvider(payload.GetChildMemberWithName('decl').GetChildMemberWithName('val')), |
| 511 | 'decl_ref_mut': lambda payload: value_Value_SummaryProvider(payload.GetChildMemberWithName('decl_index').GetChildMemberWithName('decl').GetChildMemberWithName('val')), |
| 512 | 'comptime_field_ptr': lambda payload: '&%s' % value_Value_SummaryProvider(payload.GetChildMemberWithName('field_val')), |
| 513 | 'elem_ptr': lambda payload: '(%s)[%d]' % (value_Value_SummaryProvider(payload.GetChildMemberWithName('array_ptr')), payload.GetChildMemberWithName('index').unsigned), |
| 514 | 'field_ptr': lambda payload: '(%s).field[%d]' % (value_Value_SummaryProvider(payload.GetChildMemberWithName('container_ptr')), payload.GetChildMemberWithName('field_index').unsigned), |
| 515 | 'bytes': lambda payload: '"%s"' % zig_String_decode(payload), |
| 516 | 'str_lit': value_Value_str_lit, |
| 517 | 'repeated': lambda payload: '.{%s} ** _' % value_Value_SummaryProvider(payload), |
| 518 | 'empty_array_sentinel': lambda payload: '.{%s}' % value_Value_SummaryProvider(payload), |
| 519 | 'slice': lambda payload: '(%s)[0..%s]' % tuple(value_Value_SummaryProvider(payload.GetChildMemberWithName(name)) for name in ('ptr', 'len')), |
| 520 | 'float_16': lambda payload: payload.value, |
| 521 | 'float_32': lambda payload: payload.value, |
| 522 | 'float_64': lambda payload: payload.value, |
| 523 | 'float_80': lambda payload: payload.value, |
| 524 | 'float_128': lambda payload: payload.value, |
| 525 | 'enum_literal': lambda payload: '.%s' % zig_String_AsIdentifier(payload, zig_IsFieldName), |
| 526 | 'enum_field_index': lambda payload: 'field[%d]' % payload.unsigned, |
| 527 | 'error': lambda payload: 'error.%s' % zig_String_AsIdentifier(payload.GetChildMemberWithName('name'), zig_IsFieldName), |
| 528 | 'eu_payload': value_Value_SummaryProvider, |
| 529 | 'eu_payload_ptr': lambda payload: '&((%s).* catch unreachable)' % value_Value_SummaryProvider(payload.GetChildMemberWithName('container_ptr')), |
| 530 | 'opt_payload': value_Value_SummaryProvider, |
| 531 | 'opt_payload_ptr': lambda payload: '&(%s).*.?' % value_Value_SummaryProvider(payload.GetChildMemberWithName('container_ptr')), |
| 532 | 'aggregate': lambda payload: '.{%s}' % ', '.join(map(value_Value_SummaryProvider, payload.children)), |
| 533 | 'union': lambda payload: '.{.%s = %s}' % tuple(value_Value_SummaryProvider(payload.GetChildMemberWithName(name)) for name in ('tag', 'val')), |
| 534 | |
| 535 | 'lazy_align': lambda payload: '@alignOf(%s)' % type_Type_SummaryProvider(payload), |
| 536 | 'lazy_size': lambda payload: '@sizeOf(%s)' % type_Type_SummaryProvider(payload), |
| 537 | } |
| 538 | |
| 539 | # Initialize |
| 540 | |
| 541 | def add(debugger, *, category, regex=False, type, identifier=None, synth=False, inline_children=False, expand=False, summary=False): |
| 542 | prefix = '.'.join((__name__, (identifier or type).replace('.', '_').replace(':', '_'))) |
| 543 | if summary: debugger.HandleCommand('type summary add --category %s%s%s "%s"' % (category, ' --inline-children' if inline_children else ''.join((' --expand' if expand else '', ' --python-function %s_SummaryProvider' % prefix if summary == True else ' --summary-string "%s"' % summary)), ' --regex' if regex else '', type)) |
| 544 | if synth: debugger.HandleCommand('type synthetic add --category %s%s --python-class %s_SynthProvider "%s"' % (category, ' --regex' if regex else '', prefix, type)) |
| 545 | |
| 546 | def MultiArrayList_Entry(type): return '^multi_array_list\\.MultiArrayList\\(%s\\)\\.Entry__struct_[1-9][0-9]*$' % type |
| 547 | |
| 548 | def __lldb_init_module(debugger, _=None): |
| 549 | # Initialize Zig Language |
| 550 | add(debugger, category='zig', regex=True, type='^\\[\\]', identifier='zig_Slice', synth=True, expand=True, summary='len=${svar%#}') |
| 551 | add(debugger, category='zig', type='[]u8', identifier='zig_String', summary=True) |
| 552 | add(debugger, category='zig', regex=True, type='^\\?', identifier='zig_Optional', synth=True, summary=True) |
| 553 | add(debugger, category='zig', regex=True, type='^(error{.*}|anyerror)!', identifier='zig_ErrorUnion', synth=True, inline_children=True, summary=True) |
| 554 | |
| 555 | # Initialize Zig Standard Library |
| 556 | add(debugger, category='zig.std', type='mem.Allocator', summary='${var.ptr}') |
| 557 | add(debugger, category='zig.std', regex=True, type='^segmented_list\\.SegmentedList\\(.*\\)$', identifier='std_SegmentedList', synth=True, expand=True, summary='len=${var.len}') |
| 558 | add(debugger, category='zig.std', regex=True, type='^multi_array_list\\.MultiArrayList\\(.*\\)$', identifier='std_MultiArrayList', synth=True, expand=True, summary='len=${var.len} capacity=${var.capacity}') |
| 559 | add(debugger, category='zig.std', regex=True, type=MultiArrayList_Entry('.*'), identifier='std_Entry', synth=True, inline_children=True, summary=True) |
| 560 | add(debugger, category='zig.std', regex=True, type='^hash_map\\.HashMapUnmanaged\\(.*\\)$', identifier='std_HashMapUnmanaged', synth=True, expand=True, summary=True) |
| 561 | add(debugger, category='zig.std', regex=True, type='^hash_map\\.HashMapUnmanaged\\(.*\\)\\.Entry$', identifier = 'std_Entry', synth=True, inline_children=True, summary=True) |
| 562 | |
| 563 | # Initialize Zig Stage2 Compiler |
| 564 | add(debugger, category='zig.stage2', type='Zir.Inst', identifier='TagAndPayload', synth=True, inline_children=True, summary=True) |
| 565 | add(debugger, category='zig.stage2', regex=True, type=MultiArrayList_Entry('Zir\\.Inst'), identifier='TagAndPayload', synth=True, inline_children=True, summary=True) |
| 566 | add(debugger, category='zig.stage2', regex=True, type='^Zir\\.Inst\\.Data\\.Data__struct_[1-9][0-9]*$', inline_children=True, summary=True) |
| 567 | add(debugger, category='zig.stage2', type='Zir.Inst::Zir.Inst.Ref', identifier='Inst_Ref', summary=True) |
| 568 | add(debugger, category='zig.stage2', type='Air.Inst', identifier='TagAndPayload', synth=True, inline_children=True, summary=True) |
| 569 | add(debugger, category='zig.stage2', regex=True, type=MultiArrayList_Entry('Air\\.Inst'), identifier='TagAndPayload', synth=True, inline_children=True, summary=True) |
| 570 | add(debugger, category='zig.stage2', regex=True, type='^Air\\.Inst\\.Data\\.Data__struct_[1-9][0-9]*$', inline_children=True, summary=True) |
| 571 | add(debugger, category='zig.stage2', type='Module.Decl::Module.Decl.Index', synth=True) |
| 572 | add(debugger, category='zig.stage2', type='type.Type', identifier='TagOrPayloadPtr', synth=True) |
| 573 | add(debugger, category='zig.stage2', type='type.Type', summary=True) |
| 574 | add(debugger, category='zig.stage2', type='value.Value', identifier='TagOrPayloadPtr', synth=True) |
| 575 | add(debugger, category='zig.stage2', type='value.Value', summary=True) |