zig

fork of https://codeberg.org/ziglang/zig
Log | Files | Refs | README | LICENSE

commit b047641f26fe5839a289be65b33ccc8d1fce8777 (tree)
parent 49fe3f887e4e8297c8e1f2ce1355206cd5ac0969
Author: Andrew Kelley <andrew@ziglang.org>
Date:   Tue, 21 Apr 2026 21:05:39 -0700

distribute the lldb pretty printers

rather than having them only in the source tree in tools/, distribute
them to zig users.

gdb ones are too outdated, delete them.

stage1 also is useless now.

Diffstat:
Alib/lldb/pretty_printers.py | 948+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
Dtools/lldb_pretty_printers.py | 948-------------------------------------------------------------------------------
Dtools/std_gdb_pretty_printers.py | 142-------------------------------------------------------------------------------
Dtools/zig_gdb_pretty_printers.py | 63---------------------------------------------------------------
4 files changed, 948 insertions(+), 1153 deletions(-)

diff --git a/lib/lldb/pretty_printers.py b/lib/lldb/pretty_printers.py @@ -0,0 +1,948 @@ +# pretty printing for the zig language, zig standard library, and zig compiler. +# put commands in ~/.lldbinit to run them automatically when starting lldb +# `command script import /path/to/zig/lib/lldb/pretty_printers.py` to import this file +# `type category enable zig.lang` to enable pretty printing for the zig language +# `type category enable zig.std` to enable pretty printing for the zig standard library +# `type category enable zig.compiler` to enable pretty printing for the zig compiler +import lldb +import re + +# Helpers + +page_size = 1 << 12 + +def log2_int(i): return i.bit_length() - 1 + +def create_struct(parent, name, struct_type, inits): + struct_bytes, struct_data = bytearray(struct_type.size), lldb.SBData() + for field in struct_type.fields: + field_size = field.type.size + field_init = inits[field.name] + if isinstance(field_init, int): + match struct_data.byte_order: + case lldb.eByteOrderLittle: + byte_order = 'little' + case lldb.eByteOrderBig: + byte_order = 'big' + field_bytes = field_init.to_bytes(field_size, byte_order, signed=field.type.GetTypeFlags() & lldb.eTypeIsSigned != 0) + elif isinstance(field_init, lldb.SBValue): + field_bytes = field_init.data.uint8 + else: return + match struct_data.byte_order: + case lldb.eByteOrderLittle: + field_bytes = field_bytes[:field_size] + field_start = field.byte_offset + struct_bytes[field_start:field_start + len(field_bytes)] = field_bytes + case lldb.eByteOrderBig: + field_bytes = field_bytes[-field_size:] + field_end = field.byte_offset + field_size + struct_bytes[field_end - len(field_bytes):field_end] = field_bytes + struct_data.SetData(lldb.SBError(), struct_bytes, struct_data.byte_order, struct_data.GetAddressByteSize()) + return parent.CreateValueFromData(name, struct_data, struct_type) + +# Define Zig Language + +zig_keywords = { + 'addrspace', + 'align', + 'allowzero', + 'and', + 'anyframe', + 'anytype', + 'asm', + 'break', + 'callconv', + 'catch', + 'comptime', + 'const', + 'continue', + 'defer', + 'else', + 'enum', + 'errdefer', + 'error', + 'export', + 'extern', + 'fn', + 'for', + 'if', + 'inline', + 'noalias', + 'noinline', + 'nosuspend', + 'opaque', + 'or', + 'orelse', + 'packed', + 'pub', + 'resume', + 'return', + 'linksection', + 'struct', + 'suspend', + 'switch', + 'test', + 'threadlocal', + 'try', + 'union', + 'unreachable', + 'var', + 'volatile', + 'while', +} +zig_primitives = { + 'anyerror', + 'anyframe', + 'anyopaque', + 'bool', + 'c_int', + 'c_long', + 'c_longdouble', + 'c_longlong', + 'c_short', + 'c_uint', + 'c_ulong', + 'c_ulonglong', + 'c_ushort', + 'comptime_float', + 'comptime_int', + 'f128', + 'f16', + 'f32', + 'f64', + 'f80', + 'false', + 'isize', + 'noreturn', + 'null', + 'true', + 'type', + 'undefined', + 'usize', + 'void', +} +zig_integer_type = re.compile('[iu][1-9][0-9]+') +zig_identifier_regex = re.compile('[A-Z_a-z][0-9A-Z_a-z]*') +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) +def zig_IsFieldName(string): return string not in zig_keywords and zig_identifier_regex.fullmatch(string) + +class zig_Slice_SynthProvider: + def __init__(self, value, _=None): self.value = value + def update(self): + try: + self.ptr = self.value.GetChildMemberWithName('ptr') + self.len = self.value.GetChildMemberWithName('len').unsigned if self.ptr.unsigned > page_size else 0 + self.elem_type = self.ptr.type.GetPointeeType() + self.elem_size = self.elem_type.size + except: pass + def has_children(self): return True + def num_children(self): return self.len or 0 + def get_child_index(self, name): + try: return int(name.removeprefix('[').removesuffix(']')) + except: return -1 + def get_child_at_index(self, index): + if index not in range(self.len): return None + try: return self.ptr.CreateChildAtOffset('[%d]' % index, index * self.elem_size, self.elem_type) + except: return None + +def zig_String_decode(value, offset=0, length=None): + try: + value = value.GetNonSyntheticValue() + data = value.GetChildMemberWithName('ptr').GetPointeeData(offset, length if length is not None else value.GetChildMemberWithName('len').unsigned) + b = bytes(data.uint8) + b = b.replace(b'\\', b'\\\\') + b = b.replace(b'\n', b'\\n') + b = b.replace(b'\r', b'\\r') + b = b.replace(b'\t', b'\\t') + b = b.replace(b'"', b'\\"') + b = b.replace(b'\'', b'\\\'') + s = b.decode(encoding='ascii', errors='backslashreplace') + return s if s.isprintable() else ''.join((c if c.isprintable() else '\\x%02x' % ord(c) for c in s)) + except: return None +def zig_String_SummaryProvider(value, _=None): return '"%s"' % zig_String_decode(value) +def zig_String_AsIdentifier(value, pred): + string = zig_String_decode(value) + return string if pred(string) else '@"%s"' % string + +class zig_Optional_SynthProvider: + def __init__(self, value, _=None): self.value = value + def update(self): + try: + self.child = self.value.GetChildMemberWithName('some').unsigned == 1 and self.value.GetChildMemberWithName('data').Clone('child') + except: pass + def has_children(self): return bool(self.child) + def num_children(self): return int(self.child) + def get_child_index(self, name): return 0 if self.child and (name == 'child' or name == '?') else -1 + def get_child_at_index(self, index): return self.child if self.child and index == 0 else None +def zig_Optional_SummaryProvider(value, _=None): + child = value.GetChildMemberWithName('child') + return child or 'null' + +class zig_ErrorUnion_SynthProvider: + def __init__(self, value, _=None): self.value = value + def update(self): + try: + self.error_set = self.value.GetChildMemberWithName('tag').Clone('error_set') + self.payload = self.value.GetChildMemberWithName('value').Clone('payload') if self.error_set.unsigned == 0 else None + except: pass + def has_children(self): return True + def num_children(self): return 1 + def get_child_index(self, name): return 0 if name == ('payload' if self.payload else 'error_set') else -1 + def get_child_at_index(self, index): return self.payload or self.error_set if index == 0 else None + +class zig_TaggedUnion_SynthProvider: + def __init__(self, value, _=None): self.value = value + def update(self): + try: + self.tag = self.value.GetChildMemberWithName('tag') + self.payload = self.value.GetChildMemberWithName('payload').GetChildMemberWithName(self.tag.value) + except: pass + def has_children(self): return True + def num_children(self): return 1 + (self.payload is not None) + def get_child_index(self, name): + try: return ('tag', 'payload').index(name) + except: return -1 + def get_child_at_index(self, index): return (self.tag, self.payload)[index] if index in range(2) else None + +# Define Zig Standard Library + +class std_MultiArrayList_SynthProvider: + def __init__(self, value, _=None): self.value = value + def update(self): + try: + self.len = 0 + + value_type = self.value.type + for helper in self.value.target.FindFunctions('%s.dbHelper' % value_type.name, lldb.eFunctionNameTypeFull): + ptr_self_type, ptr_child_type, ptr_field_type, ptr_entry_type = helper.function.type.GetFunctionArgumentTypes() + if ptr_self_type.GetPointeeType() == value_type: break + else: return + + self.entry_type = ptr_entry_type.GetPointeeType() + self.bytes = self.value.GetChildMemberWithName('bytes') + self.len = self.value.GetChildMemberWithName('len').unsigned + self.capacity = self.value.GetChildMemberWithName('capacity').unsigned + except: pass + def has_children(self): return True + def num_children(self): return self.len + def get_child_index(self, name): + try: return int(name.removeprefix('[').removesuffix(']')) + except: return -1 + def get_child_at_index(self, index): + try: + if index not in range(self.len): return None + offset = 0 + data = lldb.SBData() + for field in self.entry_type.fields: + field_type = field.type.GetPointeeType() + field_size = field_type.size + data.Append(self.bytes.CreateChildAtOffset(field.name, offset + index * field_size, field_type).address_of.data) + offset += self.capacity * field_size + return self.bytes.CreateValueFromData('[%d]' % index, data, self.entry_type) + except: return None +class std_MultiArrayList_Slice_SynthProvider: + def __init__(self, value, _=None): self.value = value + def update(self): + try: + self.len = 0 + + value_type = self.value.type + for helper in self.value.target.FindFunctions('%s.dbHelper' % value_type.name, lldb.eFunctionNameTypeFull): + ptr_self_type, ptr_child_type, ptr_field_type, ptr_entry_type = helper.function.type.GetFunctionArgumentTypes() + if ptr_self_type.GetPointeeType() == value_type: break + else: return + + self.fields = {member.name: index for index, member in enumerate(ptr_field_type.GetPointeeType().enum_members)} + self.entry_type = ptr_entry_type.GetPointeeType() + self.ptrs = self.value.GetChildMemberWithName('ptrs') + self.len = self.value.GetChildMemberWithName('len').unsigned + self.capacity = self.value.GetChildMemberWithName('capacity').unsigned + except: pass + def has_children(self): return True + def num_children(self): return self.len + def get_child_index(self, name): + try: return int(name.removeprefix('[').removesuffix(']')) + except: return -1 + def get_child_at_index(self, index): + try: + if index not in range(self.len): return None + data = lldb.SBData() + for field in self.entry_type.fields: + field_type = field.type.GetPointeeType() + data.Append(self.ptrs.child[self.fields[field.name.removesuffix('_ptr')]].CreateChildAtOffset(field.name, index * field_type.size, field_type).address_of.data) + return self.ptrs.CreateValueFromData('[%d]' % index, data, self.entry_type) + except: return None + +def MultiArrayList_Entry(type): return '^multi_array_list\\.MultiArrayList\\(%s\\)\\.Entry__struct_[1-9][0-9]*$' % type + +class std_HashMapUnmanaged_SynthProvider: + def __init__(self, value, _=None): self.value = value + def update(self): + try: + self.capacity = 0 + self.indices = tuple() + + self.metadata = self.value.GetChildMemberWithName('metadata') + if not self.metadata.unsigned: return + + value_type = self.value.type + for helper in self.value.target.FindFunctions('%s.dbHelper' % value_type.name, lldb.eFunctionNameTypeFull): + ptr_self_type, ptr_hdr_type, ptr_entry_type = helper.function.type.GetFunctionArgumentTypes() + if ptr_self_type.GetPointeeType() == value_type: break + else: return + self.entry_type = ptr_entry_type.GetPointeeType() + + hdr_type = ptr_hdr_type.GetPointeeType() + hdr = self.metadata.CreateValueFromAddress('header', self.metadata.deref.load_addr - hdr_type.size, hdr_type) + self.values = hdr.GetChildMemberWithName('values') + self.keys = hdr.GetChildMemberWithName('keys') + self.capacity = hdr.GetChildMemberWithName('capacity').unsigned + + self.indices = tuple(i for i, value in enumerate(self.metadata.GetPointeeData(0, self.capacity).sint8) if value < 0) + except: pass + def has_children(self): return True + def num_children(self): return len(self.indices) + def get_capacity(self): return self.capacity + def get_child_index(self, name): + try: return int(name.removeprefix('[').removesuffix(']')) + except: return -1 + def get_child_at_index(self, index): + try: + 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)))} + data = lldb.SBData() + for field in self.entry_type.fields: data.Append(fields[field.name]) + return self.metadata.CreateValueFromData('[%d]' % index, data, self.entry_type) + except: return None +def std_HashMapUnmanaged_SummaryProvider(value, _=None): + synth = std_HashMapUnmanaged_SynthProvider(value.GetNonSyntheticValue(), _) + synth.update() + return 'len=%d capacity=%d' % (synth.num_children(), synth.get_capacity()) + +# formats a struct of fields of the form `name_ptr: *Type` by auto dereferencing its fields +class std_Entry_SynthProvider: + def __init__(self, value, _=None): self.value = value + def update(self): + try: + self.children = tuple(child.Clone(child.name.removesuffix('_ptr')) for child in self.value.children if child.type.GetPointeeType().size != 0) + self.indices = {child.name: i for i, child in enumerate(self.children)} + except: pass + def has_children(self): return self.num_children() != 0 + def num_children(self): return len(self.children) + def get_child_index(self, name): return self.indices.get(name) + def get_child_at_index(self, index): return self.children[index].deref if index in range(len(self.children)) else None + +# Define Zig Compiler + +class TagAndPayload_SynthProvider: + def __init__(self, value, _=None): self.value = value + def update(self): + try: + self.tag = self.value.GetChildMemberWithName('tag') or self.value.GetChildMemberWithName('tag_ptr').deref.Clone('tag') + data = self.value.GetChildMemberWithName('data_ptr') or self.value.GetChildMemberWithName('data') + self.payload = data.GetChildMemberWithName('payload').GetChildMemberWithName(data.GetChildMemberWithName('tag').value) + except: pass + def has_children(self): return True + def num_children(self): return 2 + def get_child_index(self, name): + try: return ('tag', 'payload').index(name) + except: return -1 + def get_child_at_index(self, index): return (self.tag, self.payload)[index] if index in range(2) else None + +def InstRef_SummaryProvider(value, _=None): + return value if any(value.unsigned == member.unsigned for member in value.type.enum_members) else ( + 'InternPool.Index(%d)' % value.unsigned if value.unsigned < 0x80000000 else 'instructions[%d]' % (value.unsigned - 0x80000000)) + +def InstIndex_SummaryProvider(value, _=None): + return 'instructions[%d]' % value.unsigned if value.unsigned < 0x80000000 else 'temps[%d]' % (value.unsigned - 0x80000000) + +class zig_DeclIndex_SynthProvider: + def __init__(self, value, _=None): self.value = value + def update(self): + try: + ip = InternPool_Find(self.value.thread) + if not ip: return + self.ptr = ip.GetChildMemberWithName('allocated_decls').GetChildAtIndex(self.value.unsigned).address_of.Clone('decl') + except: pass + def has_children(self): return True + def num_children(self): return 1 + def get_child_index(self, name): return 0 if name == 'decl' else -1 + def get_child_at_index(self, index): return self.ptr if index == 0 else None + +class Module_Namespace__Module_Namespace_Index_SynthProvider: + def __init__(self, value, _=None): self.value = value + def update(self): + try: + ip = InternPool_Find(self.value.thread) + if not ip: return + self.ptr = ip.GetChildMemberWithName('allocated_namespaces').GetChildAtIndex(self.value.unsigned).address_of.Clone('namespace') + except: pass + def has_children(self): return True + def num_children(self): return 1 + def get_child_index(self, name): return 0 if name == 'namespace' else -1 + def get_child_at_index(self, index): return self.ptr if index == 0 else None + +class TagOrPayloadPtr_SynthProvider: + def __init__(self, value, _=None): self.value = value + def update(self): + try: + value_type = self.value.type + for helper in self.value.target.FindFunctions('%s.dbHelper' % value_type.name, lldb.eFunctionNameTypeFull): + ptr_self_type, ptr_tag_to_payload_map_type = helper.function.type.GetFunctionArgumentTypes() + self_type = ptr_self_type.GetPointeeType() + if self_type == value_type: break + else: return + tag_to_payload_map = {field.name: field.type for field in ptr_tag_to_payload_map_type.GetPointeeType().fields} + + tag = self.value.GetChildMemberWithName('tag_if_small_enough') + if tag.unsigned < page_size: + self.tag = tag.Clone('tag') + self.payload = None + else: + ptr_otherwise = self.value.GetChildMemberWithName('ptr_otherwise') + self.tag = ptr_otherwise.GetChildMemberWithName('tag') + self.payload = ptr_otherwise.Cast(tag_to_payload_map[self.tag.value]).GetChildMemberWithName('data').Clone('payload') + except: pass + def has_children(self): return True + def num_children(self): return 1 + (self.payload is not None) + def get_child_index(self, name): + try: return ('tag', 'payload').index(name) + except: return -1 + def get_child_at_index(self, index): return (self.tag, self.payload)[index] if index in range(2) else None + +def Module_Decl_name(decl): + error = lldb.SBError() + return decl.process.ReadCStringFromMemory(decl.GetChildMemberWithName('name').deref.load_addr, 256, error) + +def Module_Namespace_RenderFullyQualifiedName(namespace): + parent = namespace.GetChildMemberWithName('parent') + if parent.unsigned < page_size: return zig_String_decode(namespace.GetChildMemberWithName('file_scope').GetChildMemberWithName('sub_file_path')).removesuffix('.zig').replace('/', '.') + return '.'.join((Module_Namespace_RenderFullyQualifiedName(parent), Module_Decl_name(namespace.GetChildMemberWithName('ty').GetChildMemberWithName('payload').GetChildMemberWithName('owner_decl').GetChildMemberWithName('decl')))) + +def Module_Decl_RenderFullyQualifiedName(decl): return '.'.join((Module_Namespace_RenderFullyQualifiedName(decl.GetChildMemberWithName('src_namespace')), Module_Decl_name(decl))) + +def OwnerDecl_RenderFullyQualifiedName(payload): return Module_Decl_RenderFullyQualifiedName(payload.GetChildMemberWithName('owner_decl').GetChildMemberWithName('decl')) + +def InternPool_Find(thread): + for frame in thread: + ip = frame.FindVariable('ip') or frame.FindVariable('intern_pool') + if ip: return ip + mod = frame.FindVariable('zcu') or frame.FindVariable('mod') or frame.FindVariable('module') + if mod: + ip = mod.GetChildMemberWithName('intern_pool') + if ip: return ip + +class InternPool_Index_SynthProvider: + def __init__(self, value, _=None): self.value = value + def update(self): + try: + index_type = self.value.type + for helper in self.value.target.FindFunctions('%s.dbHelper' % index_type.name, lldb.eFunctionNameTypeFull): + ptr_self_type, ptr_tag_to_encoding_map_type = helper.function.type.GetFunctionArgumentTypes() + if ptr_self_type.GetPointeeType() == index_type: break + else: return + tag_to_encoding_map = {field.name: field.type for field in ptr_tag_to_encoding_map_type.GetPointeeType().fields} + + ip = InternPool_Find(self.value.thread) + if not ip: return + self.item = ip.GetChildMemberWithName('items').GetChildAtIndex(self.value.unsigned) + extra = ip.GetChildMemberWithName('extra').GetChildMemberWithName('items') + self.tag = self.item.GetChildMemberWithName('tag').Clone('tag') + self.data = None + self.trailing = None + data = self.item.GetChildMemberWithName('data') + encoding_type = tag_to_encoding_map[self.tag.value] + dynamic_values = {} + for encoding_field in encoding_type.fields: + if encoding_field.name == 'data': + if encoding_field.type.IsPointerType(): + extra_index = data.unsigned + self.data = extra.GetChildAtIndex(extra_index).address_of.Cast(encoding_field.type).deref.Clone('data') + extra_index += encoding_field.type.GetPointeeType().num_fields + else: + self.data = data.Cast(encoding_field.type).Clone('data') + elif encoding_field.name == 'trailing': + trailing_data = lldb.SBData() + for trailing_field in encoding_field.type.fields: + trailing_data.Append(extra.GetChildAtIndex(extra_index).address_of.data) + trailing_len = dynamic_values['trailing.%s.len' % trailing_field.name].unsigned + trailing_data.Append(lldb.SBData.CreateDataFromInt(trailing_len, trailing_data.GetAddressByteSize())) + extra_index += trailing_len + self.trailing = self.data.CreateValueFromData('trailing', trailing_data, encoding_field.type) + else: + for path in encoding_field.type.GetPointeeType().name.removeprefix('%s::' % encoding_type.name).removeprefix('%s.' % encoding_type.name).partition('__')[0].split(' orelse '): + if path.startswith('data.'): + root = self.data + path = path[len('data'):] + else: return + dynamic_value = root.GetValueForExpressionPath(path) + if dynamic_value: + dynamic_values[encoding_field.name] = dynamic_value + break + except: pass + def has_children(self): return True + def num_children(self): return 2 + (self.trailing is not None) + def get_child_index(self, name): + try: return ('tag', 'data', 'trailing').index(name) + except: return -1 + def get_child_at_index(self, index): return (self.tag, self.data, self.trailing)[index] if index in range(3) else None + +def InternPool_NullTerminatedString_SummaryProvider(value, _=None): + try: + ip = InternPool_Find(value.thread) + if not ip: return + items = ip.GetChildMemberWithName('string_bytes').GetChildMemberWithName('items') + b = bytearray() + i = 0 + while True: + x = items.GetChildAtIndex(value.unsigned + i).GetValueAsUnsigned() + if x == 0: break + b.append(x) + i += 1 + s = b.decode(encoding='utf8', errors='backslashreplace') + s1 = s if s.isprintable() else ''.join((c if c.isprintable() else '\\x%02x' % ord(c) for c in s)) + return '"%s"' % s1 + except: + pass + +def type_Type_pointer(payload): + pointee_type = payload.GetChildMemberWithName('pointee_type') + sentinel = payload.GetChildMemberWithName('sentinel').GetChildMemberWithName('child') + align = payload.GetChildMemberWithName('align').unsigned + addrspace = payload.GetChildMemberWithName('addrspace').value + bit_offset = payload.GetChildMemberWithName('bit_offset').unsigned + host_size = payload.GetChildMemberWithName('host_size').unsigned + vector_index = payload.GetChildMemberWithName('vector_index') + allowzero = payload.GetChildMemberWithName('allowzero').unsigned + const = not payload.GetChildMemberWithName('mutable').unsigned + volatile = payload.GetChildMemberWithName('volatile').unsigned + size = payload.GetChildMemberWithName('size').value + + if size == 'One': summary = '*' + elif size == 'Many': summary = '[*' + elif size == 'Slice': summary = '[' + elif size == 'C': summary = '[*c' + if sentinel: summary += ':%s' % value_Value_SummaryProvider(sentinel) + if size != 'One': summary += ']' + if allowzero: summary += 'allowzero ' + 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 '') + if addrspace != 'generic': summary += 'addrspace(.%s) ' % addrspace + if const: summary += 'const ' + if volatile: summary += 'volatile ' + summary += type_Type_SummaryProvider(pointee_type) + return summary + +def type_Type_function(payload): + param_types = payload.GetChildMemberWithName('param_types').children + comptime_params = payload.GetChildMemberWithName('comptime_params').GetPointeeData(0, len(param_types)).uint8 + return_type = payload.GetChildMemberWithName('return_type') + alignment = payload.GetChildMemberWithName('alignment').unsigned + noalias_bits = payload.GetChildMemberWithName('noalias_bits').unsigned + cc = payload.GetChildMemberWithName('cc').value + is_var_args = payload.GetChildMemberWithName('is_var_args').unsigned + + 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)) + +def type_Type_SummaryProvider(value, _=None): + tag = value.GetChildMemberWithName('tag').value + return type_tag_handlers.get(tag, lambda payload: tag)(value.GetChildMemberWithName('payload')) + +type_tag_handlers = { + 'atomic_order': lambda payload: 'std.builtin.AtomicOrder', + 'atomic_rmw_op': lambda payload: 'std.builtin.AtomicRmwOp', + 'calling_convention': lambda payload: 'std.builtin.CallingConvention', + 'address_space': lambda payload: 'std.builtin.AddressSpace', + 'float_mode': lambda payload: 'std.builtin.FloatMode', + 'reduce_op': lambda payload: 'std.builtin.ReduceOp', + 'modifier': lambda payload: 'std.builtin.CallModifier', + 'prefetch_options': lambda payload: 'std.builtin.PrefetchOptions', + 'export_options': lambda payload: 'std.builtin.ExportOptions', + 'extern_options': lambda payload: 'std.builtin.ExternOptions', + 'type_info': lambda payload: 'std.builtin.Type', + + 'enum_literal': lambda payload: '@EnumLiteral()', + 'null': lambda payload: '@TypeOf(null)', + 'undefined': lambda payload: '@TypeOf(undefined)', + 'empty_struct_literal': lambda payload: '@TypeOf(.{})', + + 'anyerror_void_error_union': lambda payload: 'anyerror!void', + 'slice_const_u8': lambda payload: '[]const u8', + 'slice_const_u8_sentinel_0': lambda payload: '[:0]const u8', + 'fn_noreturn_no_args': lambda payload: 'fn() noreturn', + 'fn_void_no_args': lambda payload: 'fn() void', + 'fn_naked_noreturn_no_args': lambda payload: 'fn() callconv(.naked) noreturn', + 'fn_ccc_void_no_args': lambda payload: 'fn() callconv(.c) void', + 'ptr_usize': lambda payload: '*usize', + 'ptr_const_comptime_int': lambda payload: '*const comptime_int', + 'manyptr_u8': lambda payload: '[*]u8', + 'manyptr_const_u8': lambda payload: '[*]const u8', + 'manyptr_const_u8_sentinel_0': lambda payload: '[*:0]const u8', + + 'function': type_Type_function, + 'error_union': lambda payload: '%s!%s' % (type_Type_SummaryProvider(payload.GetChildMemberWithName('error_set')), type_Type_SummaryProvider(payload.GetChildMemberWithName('payload'))), + 'array_u8': lambda payload: '[%d]u8' % payload.unsigned, + 'array_u8_sentinel_0': lambda payload: '[%d:0]u8' % payload.unsigned, + 'vector': lambda payload: '@Vector(%d, %s)' % (payload.GetChildMemberWithName('len').unsigned, type_Type_SummaryProvider(payload.GetChildMemberWithName('elem_type'))), + 'array': lambda payload: '[%d]%s' % (payload.GetChildMemberWithName('len').unsigned, type_Type_SummaryProvider(payload.GetChildMemberWithName('elem_type'))), + 'array_sentinel': lambda payload: '[%d:%s]%s' % (payload.GetChildMemberWithName('len').unsigned, value_Value_SummaryProvider(payload.GetChildMemberWithName('sentinel')), type_Type_SummaryProvider(payload.GetChildMemberWithName('elem_type'))), + '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)), + '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)), + 'pointer': type_Type_pointer, + 'single_const_pointer': lambda payload: '*const %s' % type_Type_SummaryProvider(payload), + 'single_mut_pointer': lambda payload: '*%s' % type_Type_SummaryProvider(payload), + 'many_const_pointer': lambda payload: '[*]const %s' % type_Type_SummaryProvider(payload), + 'many_mut_pointer': lambda payload: '[*]%s' % type_Type_SummaryProvider(payload), + 'c_const_pointer': lambda payload: '[*c]const %s' % type_Type_SummaryProvider(payload), + 'c_mut_pointer': lambda payload: '[*c]%s' % type_Type_SummaryProvider(payload), + 'slice_const': lambda payload: '[]const %s' % type_Type_SummaryProvider(payload), + 'mut_slice': lambda payload: '[]%s' % type_Type_SummaryProvider(payload), + 'int_signed': lambda payload: 'i%d' % payload.unsigned, + 'int_unsigned': lambda payload: 'u%d' % payload.unsigned, + 'optional': lambda payload: '?%s' % type_Type_SummaryProvider(payload), + 'optional_single_mut_pointer': lambda payload: '?*%s' % type_Type_SummaryProvider(payload), + 'optional_single_const_pointer': lambda payload: '?*const %s' % type_Type_SummaryProvider(payload), + 'anyframe_T': lambda payload: 'anyframe->%s' % type_Type_SummaryProvider(payload), + 'error_set': lambda payload: type_tag_handlers['error_set_merged'](payload.GetChildMemberWithName('names')), + 'error_set_single': lambda payload: 'error{%s}' % zig_String_AsIdentifier(payload, zig_IsFieldName), + 'error_set_merged': lambda payload: 'error{%s}' % ','.join(zig_String_AsIdentifier(child.GetChildMemberWithName('key'), zig_IsFieldName) for child in payload.GetChildMemberWithName('entries').children), + 'error_set_inferred': lambda payload: '@typeInfo(@typeInfo(@TypeOf(%s)).@"fn".return_type.?).error_union.error_set' % OwnerDecl_RenderFullyQualifiedName(payload.GetChildMemberWithName('func')), + + 'enum_full': OwnerDecl_RenderFullyQualifiedName, + 'enum_nonexhaustive': OwnerDecl_RenderFullyQualifiedName, + 'enum_numbered': OwnerDecl_RenderFullyQualifiedName, + 'enum_simple': OwnerDecl_RenderFullyQualifiedName, + 'struct': OwnerDecl_RenderFullyQualifiedName, + 'union': OwnerDecl_RenderFullyQualifiedName, + 'union_safety_tagged': OwnerDecl_RenderFullyQualifiedName, + 'union_tagged': OwnerDecl_RenderFullyQualifiedName, + 'opaque': OwnerDecl_RenderFullyQualifiedName, +} + +def value_Value_str_lit(payload): + for frame in payload.thread: + mod = frame.FindVariable('zcu') or frame.FindVariable('mod') or frame.FindVariable('module') + if mod: break + else: return + return '"%s"' % zig_String_decode(mod.GetChildMemberWithName('string_literal_bytes').GetChildMemberWithName('items'), payload.GetChildMemberWithName('index').unsigned, payload.GetChildMemberWithName('len').unsigned) + +def value_Value_SummaryProvider(value, _=None): + tag = value.GetChildMemberWithName('tag').value + return value_tag_handlers.get(tag, lambda payload: tag.removesuffix('_type'))(value.GetChildMemberWithName('payload')) + +value_tag_handlers = { + 'undef': lambda payload: 'undefined', + 'zero': lambda payload: '0', + 'one': lambda payload: '1', + 'void_value': lambda payload: '{}', + 'unreachable_value': lambda payload: 'unreachable', + 'null_value': lambda payload: 'null', + 'bool_true': lambda payload: 'true', + 'bool_false': lambda payload: 'false', + + 'empty_struct_value': lambda payload: '.{}', + 'empty_array': lambda payload: '.{}', + + 'ty': type_Type_SummaryProvider, + 'int_type': lambda payload: '%c%d' % (payload.GetChildMemberWithName('bits').unsigned, 's' if payload.GetChildMemberWithName('signed').unsigned == 1 else 'u'), + 'int_u64': lambda payload: '%d' % payload.unsigned, + 'int_i64': lambda payload: '%d' % payload.signed, + 'int_big_positive': lambda payload: sum(child.unsigned << i * child.type.size * 8 for i, child in enumerate(payload.children)), + 'int_big_negative': lambda payload: '-%s' % value_tag_handlers['int_big_positive'](payload), + 'function': OwnerDecl_RenderFullyQualifiedName, + 'extern_fn': OwnerDecl_RenderFullyQualifiedName, + 'variable': lambda payload: value_Value_SummaryProvider(payload.GetChildMemberWithName('decl').GetChildMemberWithName('val')), + 'runtime_value': value_Value_SummaryProvider, + 'decl_ref': lambda payload: value_Value_SummaryProvider(payload.GetChildMemberWithName('decl').GetChildMemberWithName('val')), + 'decl_ref_mut': lambda payload: value_Value_SummaryProvider(payload.GetChildMemberWithName('decl_index').GetChildMemberWithName('decl').GetChildMemberWithName('val')), + 'comptime_field_ptr': lambda payload: '&%s' % value_Value_SummaryProvider(payload.GetChildMemberWithName('field_val')), + 'elem_ptr': lambda payload: '(%s)[%d]' % (value_Value_SummaryProvider(payload.GetChildMemberWithName('array_ptr')), payload.GetChildMemberWithName('index').unsigned), + 'field_ptr': lambda payload: '(%s).field[%d]' % (value_Value_SummaryProvider(payload.GetChildMemberWithName('container_ptr')), payload.GetChildMemberWithName('field_index').unsigned), + 'bytes': lambda payload: '"%s"' % zig_String_decode(payload), + 'str_lit': value_Value_str_lit, + 'repeated': lambda payload: '.{%s} ** _' % value_Value_SummaryProvider(payload), + 'empty_array_sentinel': lambda payload: '.{%s}' % value_Value_SummaryProvider(payload), + 'slice': lambda payload: '(%s)[0..%s]' % tuple(value_Value_SummaryProvider(payload.GetChildMemberWithName(name)) for name in ('ptr', 'len')), + 'float_16': lambda payload: payload.value, + 'float_32': lambda payload: payload.value, + 'float_64': lambda payload: payload.value, + 'float_80': lambda payload: payload.value, + 'float_128': lambda payload: payload.value, + 'enum_literal': lambda payload: '.%s' % zig_String_AsIdentifier(payload, zig_IsFieldName), + 'enum_field_index': lambda payload: 'field[%d]' % payload.unsigned, + 'error': lambda payload: 'error.%s' % zig_String_AsIdentifier(payload.GetChildMemberWithName('name'), zig_IsFieldName), + 'eu_payload': value_Value_SummaryProvider, + 'eu_payload_ptr': lambda payload: '&((%s).* catch unreachable)' % value_Value_SummaryProvider(payload.GetChildMemberWithName('container_ptr')), + 'opt_payload': value_Value_SummaryProvider, + 'opt_payload_ptr': lambda payload: '&(%s).*.?' % value_Value_SummaryProvider(payload.GetChildMemberWithName('container_ptr')), + 'aggregate': lambda payload: '.{%s}' % ', '.join(map(value_Value_SummaryProvider, payload.children)), + 'union': lambda payload: '.{.%s = %s}' % tuple(value_Value_SummaryProvider(payload.GetChildMemberWithName(name)) for name in ('tag', 'val')), + + 'lazy_align': lambda payload: '@alignOf(%s)' % type_Type_SummaryProvider(payload), + 'lazy_size': lambda payload: '@sizeOf(%s)' % type_Type_SummaryProvider(payload), +} + +# Define Zig Compiler (compiled with the self-hosted backend) + +class root_InternPool_Local_List_SynthProvider: + def __init__(self, value, _=None): self.value = value + def update(self): + capacity = self.value.EvaluateExpression('@as(*@This().Header, @alignCast(@ptrCast(@this().bytes - @This().bytes_offset))).capacity') + self.view = create_struct(self.value, '.view', self.value.type.FindDirectNestedType('View'), { 'bytes': self.value.GetChildMemberWithName('bytes'), 'len': capacity, 'capacity': capacity }).GetNonSyntheticValue() + def has_children(self): return True + def num_children(self): return 1 + def get_child_index(self, name): + try: return ('view',).index(name) + except: pass + def get_child_at_index(self, index): + try: return (self.view,)[index] + except: pass + +expr_path_re = re.compile(r'\{([^}]+)%([^%#}]+)(?:#([^%#}]+))?\}') +def root_InternPool_Index_SummaryProvider(value, _=None): + unwrapped = value.GetChildMemberWithName('unwrapped') + if not unwrapped: return '' # .none + tag = unwrapped.GetChildMemberWithName('tag') + tag_value = tag.value + summary = tag.CreateValueFromType(tag.type).GetChildMemberWithName('encodings').GetChildMemberWithName(tag_value.removeprefix('.').removeprefix('@"').removesuffix('"').replace(r'\"', '"')).GetChildMemberWithName('summary') + if not summary: return tag_value + return re.sub( + expr_path_re, + lambda matchobj: getattr(unwrapped.GetValueForExpressionPath(matchobj[1]), matchobj[2]).strip(matchobj[3] or ''), + summary.summary.removeprefix('.').removeprefix('@"').removesuffix('"').replace(r'\"', '"'), + ) + +class root_InternPool_Index_SynthProvider: + def __init__(self, value, _=None): self.value = value + def update(self): + self.unwrapped = None + wrapped = self.value.unsigned + if wrapped == (1 << 32) - 1: return + unwrapped_type = self.value.type.FindDirectNestedType('Unwrapped') + ip = self.value.CreateValueFromType(unwrapped_type).GetChildMemberWithName('debug_state').GetChildMemberWithName('intern_pool').GetNonSyntheticValue().GetChildMemberWithName('?') + tid_shift_30 = ip.GetChildMemberWithName('tid_shift_30').unsigned + self.unwrapped = create_struct(self.value, '.unwrapped', unwrapped_type, { 'tid': wrapped >> tid_shift_30, 'index': wrapped & (1 << tid_shift_30) - 1 }) + def has_children(self): return True + def num_children(self): return 0 + def get_child_index(self, name): + try: return ('unwrapped',).index(name) + except: pass + def get_child_at_index(self, index): + try: return (self.unwrapped,)[index] + except: pass + +class root_InternPool_Index_Unwrapped_SynthProvider: + def __init__(self, value, _=None): self.value = value + def update(self): + self.tag, self.index, self.data, self.payload, self.trailing = None, None, None, None, None + index = self.value.GetChildMemberWithName('index') + ip = self.value.CreateValueFromType(self.value.type).GetChildMemberWithName('debug_state').GetChildMemberWithName('intern_pool').GetNonSyntheticValue().GetChildMemberWithName('?') + shared = ip.GetChildMemberWithName('locals').GetSyntheticValue().child[self.value.GetChildMemberWithName('tid').unsigned].GetChildMemberWithName('shared') + item = shared.GetChildMemberWithName('items').GetChildMemberWithName('view').child[index.unsigned] + self.tag, item_data = item.GetChildMemberWithName('tag'), item.GetChildMemberWithName('data') + encoding = self.tag.CreateValueFromType(self.tag.type).GetChildMemberWithName('encodings').GetChildMemberWithName(self.tag.value.removeprefix('.').removeprefix('@"').removesuffix('"').replace(r'\"', '"')) + encoding_index, encoding_data, encoding_payload, encoding_trailing, encoding_config = encoding.GetChildMemberWithName('index'), encoding.GetChildMemberWithName('data'), encoding.GetChildMemberWithName('payload'), encoding.GetChildMemberWithName('trailing'), encoding.GetChildMemberWithName('config') + if encoding_index: + index_type = encoding_index.GetValueAsType() + index_bytes, index_data = index.data.uint8, lldb.SBData() + match index_data.byte_order: + case lldb.eByteOrderLittle: + index_bytes = bytes(index_bytes[:index_type.size]) + case lldb.eByteOrderBig: + index_bytes = bytes(index_bytes[-index_type.size:]) + index_data.SetData(lldb.SBError(), index_bytes, index_data.byte_order, index_data.GetAddressByteSize()) + self.index = self.value.CreateValueFromData('.index', index_data, index_type) + elif encoding_data: + data_type = encoding_data.GetValueAsType() + data_bytes, data_data = item_data.data.uint8, lldb.SBData() + match data_data.byte_order: + case lldb.eByteOrderLittle: + data_bytes = bytes(data_bytes[:data_type.size]) + case lldb.eByteOrderBig: + data_bytes = bytes(data_bytes[-data_type.size:]) + data_data.SetData(lldb.SBError(), data_bytes, data_data.byte_order, data_data.GetAddressByteSize()) + self.data = self.value.CreateValueFromData('.data', data_data, data_type) + elif encoding_payload: + extra = shared.GetChildMemberWithName('extra').GetChildMemberWithName('view').GetChildMemberWithName('0') + extra_index = item_data.unsigned + payload_type = encoding_payload.GetValueAsType() + payload_fields = dict() + for payload_field in payload_type.fields: + payload_fields[payload_field.name] = extra.child[extra_index] + extra_index += 1 + self.payload = create_struct(self.value, '.payload', payload_type, payload_fields) + if encoding_trailing and encoding_config: + trailing_type = encoding_trailing.GetValueAsType() + trailing_bytes, trailing_data = bytearray(trailing_type.size), lldb.SBData() + def eval_config(config_name): + expr = encoding_config.GetChildMemberWithName(config_name).summary.removeprefix('.').removeprefix('@"').removesuffix('"').replace(r'\"', '"') + if 'payload.' in expr: + return self.payload.EvaluateExpression(expr.replace('payload.', '@this().')) + elif expr.startswith('trailing.'): + field_type, field_byte_offset = trailing_type, 0 + expr_parts = expr.split('.') + for expr_part in expr_parts[1:]: + field = next(filter(lambda field: field.name == expr_part, field_type.fields)) + field_type = field.type + field_byte_offset += field.byte_offset + field_data = lldb.SBData() + field_bytes = trailing_bytes[field_byte_offset:field_byte_offset + field_type.size] + field_data.SetData(lldb.SBError(), field_bytes, field_data.byte_order, field_data.GetAddressByteSize()) + return self.value.CreateValueFromData('.%s' % expr_parts[-1], field_data, field_type) + else: + return self.value.frame.EvaluateExpression(expr) + for trailing_field in trailing_type.fields: + trailing_field_type = trailing_field.type + trailing_field_name = 'trailing.%s' % trailing_field.name + trailing_field_byte_offset = trailing_field.byte_offset + while True: + match [trailing_field_type_field.name for trailing_field_type_field in trailing_field_type.fields]: + case ['has_value', '?']: + has_value_field, child_field = trailing_field_type.fields + trailing_field_name = '%s.%s' % (trailing_field_name, child_field.name) + match eval_config(trailing_field_name).value: + case 'true': + if has_value_field.type.name == 'bool': + trailing_bytes[trailing_field_byte_offset + has_value_field.byte_offset] = True + trailing_field_type = child_field.type + trailing_field_byte_offset += child_field.byte_offset + case 'false': + break + case ['ptr', 'len']: + ptr_field, len_field = trailing_field_type.fields + ptr_field_byte_offset, len_field_byte_offset = trailing_field_byte_offset + ptr_field.byte_offset, trailing_field_byte_offset + len_field.byte_offset + trailing_bytes[ptr_field_byte_offset:ptr_field_byte_offset + ptr_field.type.size] = extra.child[extra_index].address_of.data.uint8 + len_field_value = eval_config('%s.len' % trailing_field_name) + len_field_size = len_field.type.size + match trailing_data.byte_order: + case lldb.eByteOrderLittle: + len_field_bytes = len_field_value.data.uint8[:len_field_size] + trailing_bytes[len_field_byte_offset:len_field_byte_offset + len(len_field_bytes)] = len_field_bytes + case lldb.eByteOrderBig: + len_field_bytes = len_field_value.data.uint8[-len_field_size:] + len_field_end = len_field_byte_offset + len_field_size + trailing_bytes[len_field_end - len(len_field_bytes):len_field_end] = len_field_bytes + extra_index += (ptr_field.type.GetPointeeType().size * len_field_value.unsigned + 3) // 4 + break + case _: + for offset in range(0, trailing_field_type.size, 4): + trailing_bytes[trailing_field_byte_offset + offset:trailing_field_byte_offset + offset + 4] = extra.child[extra_index].data.uint8 + extra_index += 1 + break + trailing_data.SetData(lldb.SBError(), trailing_bytes, trailing_data.byte_order, trailing_data.GetAddressByteSize()) + self.trailing = self.value.CreateValueFromData('.trailing', trailing_data, trailing_type) + def has_children(self): return True + def num_children(self): return 1 + ((self.index or self.data or self.payload) is not None) + (self.trailing is not None) + def get_child_index(self, name): + try: return ('tag', 'index' if self.index is not None else 'data' if self.data is not None else 'payload', 'trailing').index(name) + except: pass + def get_child_at_index(self, index): + try: return (self.tag, self.index or self.data or self.payload, self.trailing)[index] + except: pass + +def root_InternPool_String_SummaryProvider(value, _=None): + wrapped = value.unsigned + if wrapped == (1 << 32) - 1: return '' + ip = value.CreateValueFromType(value.type).GetChildMemberWithName('debug_state').GetChildMemberWithName('intern_pool').GetNonSyntheticValue().GetChildMemberWithName('?') + tid_shift_32 = ip.GetChildMemberWithName('tid_shift_32').unsigned + locals_value = ip.GetChildMemberWithName('locals').GetSyntheticValue() + local_value = locals_value.child[wrapped >> tid_shift_32] + if local_value is None: + wrapped = 0 + local_value = locals_value.child[0] + string = local_value.GetChildMemberWithName('shared').GetChildMemberWithName('strings').GetChildMemberWithName('view').GetChildMemberWithName('0').child[wrapped & (1 << tid_shift_32) - 1].address_of + string.format = lldb.eFormatCString + return string.value + +class root_InternPool_TrackedInst_Index_SynthProvider: + def __init__(self, value, _=None): self.value = value + def update(self): + self.tracked_inst = None + wrapped = self.value.unsigned + if wrapped == (1 << 32) - 1: return + ip = self.value.CreateValueFromType(self.value.type).GetChildMemberWithName('debug_state').GetChildMemberWithName('intern_pool').GetNonSyntheticValue().GetChildMemberWithName('?') + tid_shift_32 = ip.GetChildMemberWithName('tid_shift_32').unsigned + locals_value = ip.GetChildMemberWithName('locals').GetSyntheticValue() + local_value = locals_value.child[wrapped >> tid_shift_32] + if local_value is None: + wrapped = 0 + local_value = locals_value.child[0] + self.tracked_inst = local_value.GetChildMemberWithName('shared').GetChildMemberWithName('tracked_insts').GetChildMemberWithName('view').GetChildMemberWithName('0').child[wrapped & (1 << tid_shift_32) - 1] + def has_children(self): return False if self.tracked_inst is None else self.tracked_inst.GetNumChildren(1) > 0 + def num_children(self): return 0 if self.tracked_inst is None else self.tracked_inst.GetNumChildren() + def get_child_index(self, name): return -1 if self.tracked_inst is None else self.tracked_inst.GetIndexOfChildWithName(name) + def get_child_at_index(self, index): return None if self.tracked_inst is None else self.tracked_inst.GetChildAtIndex(index) + +class root_InternPool_Nav_Index_SynthProvider: + def __init__(self, value, _=None): self.value = value + def update(self): + self.nav = None + wrapped = self.value.unsigned + if wrapped == (1 << 32) - 1: return + ip = self.value.CreateValueFromType(self.value.type).GetChildMemberWithName('debug_state').GetChildMemberWithName('intern_pool').GetNonSyntheticValue().GetChildMemberWithName('?') + tid_shift_32 = ip.GetChildMemberWithName('tid_shift_32').unsigned + locals_value = ip.GetChildMemberWithName('locals').GetSyntheticValue() + local_value = locals_value.child[wrapped >> tid_shift_32] + if local_value is None: + wrapped = 0 + local_value = locals_value.child[0] + self.nav = local_value.GetChildMemberWithName('shared').GetChildMemberWithName('navs').GetChildMemberWithName('view').child[wrapped & (1 << tid_shift_32) - 1] + def has_children(self): return False if self.nav is None else self.nav.GetNumChildren(1) > 0 + def num_children(self): return 0 if self.nav is None else self.nav.GetNumChildren() + def get_child_index(self, name): return -1 if self.nav is None else self.nav.GetIndexOfChildWithName(name) + def get_child_at_index(self, index): return None if self.nav is None else self.nav.GetChildAtIndex(index) + +# Initialize + +def add(debugger, *, category, regex=False, type, identifier=None, synth=False, inline_children=False, expand=False, summary=False): + prefix = '.'.join((__name__, (identifier or type).replace('.', '_').replace(':', '_'))) + 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)) + if synth: debugger.HandleCommand('type synthetic add --category %s%s --python-class %s_SynthProvider "%s"' % (category, ' --regex' if regex else '', prefix, type)) + +def __lldb_init_module(debugger, _=None): + # Initialize Zig Categories + debugger.HandleCommand('type category define --language c99 zig.lang zig.std') + + # Initialize Zig Language + add(debugger, category='zig.lang', regex=True, type='^\\[\\]', identifier='zig_Slice', synth=True, expand=True, summary='len=${svar%#}') + add(debugger, category='zig.lang', type='[]u8', identifier='zig_String', summary=True) + add(debugger, category='zig.lang', regex=True, type='^\\?', identifier='zig_Optional', synth=True, summary=True) + add(debugger, category='zig.lang', regex=True, type='^(error{.*}|anyerror)!', identifier='zig_ErrorUnion', synth=True, inline_children=True, summary=True) + + # Initialize Zig Standard Library + add(debugger, category='zig.std', type='mem.Allocator', summary='${var.ptr}') + 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}') + add(debugger, category='zig.std', regex=True, type='^multi_array_list\\.MultiArrayList\\(.*\\)\\.Slice$', identifier='std_MultiArrayList_Slice', synth=True, expand=True, summary='len=${var.len} capacity=${var.capacity}') + add(debugger, category='zig.std', regex=True, type=MultiArrayList_Entry('.*'), identifier='std_Entry', synth=True, inline_children=True, summary=True) + add(debugger, category='zig.std', regex=True, type='^hash_map\\.HashMapUnmanaged\\(.*\\)$', identifier='std_HashMapUnmanaged', synth=True, expand=True, summary=True) + add(debugger, category='zig.std', regex=True, type='^hash_map\\.HashMapUnmanaged\\(.*\\)\\.Entry$', identifier = 'std_Entry', synth=True, inline_children=True, summary=True) + + # Initialize Zig Compiler + add(debugger, category='zig.compiler', type='Zir.Inst', identifier='TagAndPayload', synth=True, inline_children=True, summary=True) + add(debugger, category='zig.compiler', regex=True, type=MultiArrayList_Entry('Zir\\.Inst'), identifier='TagAndPayload', synth=True, inline_children=True, summary=True) + add(debugger, category='zig.compiler', regex=True, type='^Zir\\.Inst\\.Data\\.Data__struct_[1-9][0-9]*$', inline_children=True, summary=True) + add(debugger, category='zig.compiler', type='Zir.Inst::Zir.Inst.Ref', identifier='InstRef', summary=True) + add(debugger, category='zig.compiler', type='Zir.Inst::Zir.Inst.Index', identifier='InstIndex', summary=True) + add(debugger, category='zig.compiler', type='Air.Inst', identifier='TagAndPayload', synth=True, inline_children=True, summary=True) + add(debugger, category='zig.compiler', type='Air.Inst::Air.Inst.Ref', identifier='InstRef', summary=True) + add(debugger, category='zig.compiler', type='Air.Inst::Air.Inst.Index', identifier='InstIndex', summary=True) + add(debugger, category='zig.compiler', regex=True, type=MultiArrayList_Entry('Air\\.Inst'), identifier='TagAndPayload', synth=True, inline_children=True, summary=True) + add(debugger, category='zig.compiler', regex=True, type='^Air\\.Inst\\.Data\\.Data__struct_[1-9][0-9]*$', inline_children=True, summary=True) + add(debugger, category='zig.compiler', type='zig.DeclIndex', synth=True) + add(debugger, category='zig.compiler', type='Module.Namespace::Module.Namespace.Index', synth=True) + add(debugger, category='zig.compiler', type='Module.LazySrcLoc', identifier='zig_TaggedUnion', synth=True) + add(debugger, category='zig.compiler', type='InternPool.Index', synth=True) + add(debugger, category='zig.compiler', type='InternPool.NullTerminatedString', summary=True) + add(debugger, category='zig.compiler', type='InternPool.Key', identifier='zig_TaggedUnion', synth=True) + add(debugger, category='zig.compiler', type='InternPool.Key.Int.Storage', identifier='zig_TaggedUnion', synth=True) + add(debugger, category='zig.compiler', type='InternPool.Key.ErrorUnion.Value', identifier='zig_TaggedUnion', synth=True) + add(debugger, category='zig.compiler', type='InternPool.Key.Float.Storage', identifier='zig_TaggedUnion', synth=True) + add(debugger, category='zig.compiler', type='InternPool.Key.Ptr.Addr', identifier='zig_TaggedUnion', synth=True) + add(debugger, category='zig.compiler', type='InternPool.Key.Aggregate.Storage', identifier='zig_TaggedUnion', synth=True) + add(debugger, category='zig.compiler', type='arch.x86_64.CodeGen.MCValue', identifier='zig_TaggedUnion', synth=True, inline_children=True, summary=True) + + # Initialize Zig Compiler (compiled with the self-hosted backend) + add(debugger, category='zig', regex=True, type=r'^root\.InternPool\.Local\.List\(.*\)$', identifier='root_InternPool_Local_List', synth=True, expand=True, summary='capacity=${var%#}') + add(debugger, category='zig', type='root.InternPool.Index', synth=True, summary=True) + add(debugger, category='zig', type='root.InternPool.Index.Unwrapped', synth=True) + add(debugger, category='zig', regex=True, type=r'^root\.InternPool\.(Optional)?(NullTerminated)?String$', identifier='root_InternPool_String', summary=True) + add(debugger, category='zig', regex=True, type=r'^root\.InternPool\.TrackedInst\.Index(\.Optional)?$', identifier='root_InternPool_TrackedInst_Index', synth=True) + add(debugger, category='zig', regex=True, type=r'^root\.InternPool\.Nav\.Index(\.Optional)?$', identifier='root_InternPool_Nav_Index', synth=True) diff --git a/tools/lldb_pretty_printers.py b/tools/lldb_pretty_printers.py @@ -1,948 +0,0 @@ -# pretty printing for the zig language, zig standard library, and zig stage 2 compiler. -# put commands in ~/.lldbinit to run them automatically when starting lldb -# `command script import /path/to/zig/tools/lldb_pretty_printers.py` to import this file -# `type category enable zig.lang` to enable pretty printing for the zig language -# `type category enable zig.std` to enable pretty printing for the zig standard library -# `type category enable zig.stage2` to enable pretty printing for the zig stage 2 compiler -import lldb -import re - -# Helpers - -page_size = 1 << 12 - -def log2_int(i): return i.bit_length() - 1 - -def create_struct(parent, name, struct_type, inits): - struct_bytes, struct_data = bytearray(struct_type.size), lldb.SBData() - for field in struct_type.fields: - field_size = field.type.size - field_init = inits[field.name] - if isinstance(field_init, int): - match struct_data.byte_order: - case lldb.eByteOrderLittle: - byte_order = 'little' - case lldb.eByteOrderBig: - byte_order = 'big' - field_bytes = field_init.to_bytes(field_size, byte_order, signed=field.type.GetTypeFlags() & lldb.eTypeIsSigned != 0) - elif isinstance(field_init, lldb.SBValue): - field_bytes = field_init.data.uint8 - else: return - match struct_data.byte_order: - case lldb.eByteOrderLittle: - field_bytes = field_bytes[:field_size] - field_start = field.byte_offset - struct_bytes[field_start:field_start + len(field_bytes)] = field_bytes - case lldb.eByteOrderBig: - field_bytes = field_bytes[-field_size:] - field_end = field.byte_offset + field_size - struct_bytes[field_end - len(field_bytes):field_end] = field_bytes - struct_data.SetData(lldb.SBError(), struct_bytes, struct_data.byte_order, struct_data.GetAddressByteSize()) - return parent.CreateValueFromData(name, struct_data, struct_type) - -# Define Zig Language - -zig_keywords = { - 'addrspace', - 'align', - 'allowzero', - 'and', - 'anyframe', - 'anytype', - 'asm', - 'break', - 'callconv', - 'catch', - 'comptime', - 'const', - 'continue', - 'defer', - 'else', - 'enum', - 'errdefer', - 'error', - 'export', - 'extern', - 'fn', - 'for', - 'if', - 'inline', - 'noalias', - 'noinline', - 'nosuspend', - 'opaque', - 'or', - 'orelse', - 'packed', - 'pub', - 'resume', - 'return', - 'linksection', - 'struct', - 'suspend', - 'switch', - 'test', - 'threadlocal', - 'try', - 'union', - 'unreachable', - 'var', - 'volatile', - 'while', -} -zig_primitives = { - 'anyerror', - 'anyframe', - 'anyopaque', - 'bool', - 'c_int', - 'c_long', - 'c_longdouble', - 'c_longlong', - 'c_short', - 'c_uint', - 'c_ulong', - 'c_ulonglong', - 'c_ushort', - 'comptime_float', - 'comptime_int', - 'f128', - 'f16', - 'f32', - 'f64', - 'f80', - 'false', - 'isize', - 'noreturn', - 'null', - 'true', - 'type', - 'undefined', - 'usize', - 'void', -} -zig_integer_type = re.compile('[iu][1-9][0-9]+') -zig_identifier_regex = re.compile('[A-Z_a-z][0-9A-Z_a-z]*') -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) -def zig_IsFieldName(string): return string not in zig_keywords and zig_identifier_regex.fullmatch(string) - -class zig_Slice_SynthProvider: - def __init__(self, value, _=None): self.value = value - def update(self): - try: - self.ptr = self.value.GetChildMemberWithName('ptr') - self.len = self.value.GetChildMemberWithName('len').unsigned if self.ptr.unsigned > page_size else 0 - self.elem_type = self.ptr.type.GetPointeeType() - self.elem_size = self.elem_type.size - except: pass - def has_children(self): return True - def num_children(self): return self.len or 0 - def get_child_index(self, name): - try: return int(name.removeprefix('[').removesuffix(']')) - except: return -1 - def get_child_at_index(self, index): - if index not in range(self.len): return None - try: return self.ptr.CreateChildAtOffset('[%d]' % index, index * self.elem_size, self.elem_type) - except: return None - -def zig_String_decode(value, offset=0, length=None): - try: - value = value.GetNonSyntheticValue() - data = value.GetChildMemberWithName('ptr').GetPointeeData(offset, length if length is not None else value.GetChildMemberWithName('len').unsigned) - b = bytes(data.uint8) - b = b.replace(b'\\', b'\\\\') - b = b.replace(b'\n', b'\\n') - b = b.replace(b'\r', b'\\r') - b = b.replace(b'\t', b'\\t') - b = b.replace(b'"', b'\\"') - b = b.replace(b'\'', b'\\\'') - s = b.decode(encoding='ascii', errors='backslashreplace') - return s if s.isprintable() else ''.join((c if c.isprintable() else '\\x%02x' % ord(c) for c in s)) - except: return None -def zig_String_SummaryProvider(value, _=None): return '"%s"' % zig_String_decode(value) -def zig_String_AsIdentifier(value, pred): - string = zig_String_decode(value) - return string if pred(string) else '@"%s"' % string - -class zig_Optional_SynthProvider: - def __init__(self, value, _=None): self.value = value - def update(self): - try: - self.child = self.value.GetChildMemberWithName('some').unsigned == 1 and self.value.GetChildMemberWithName('data').Clone('child') - except: pass - def has_children(self): return bool(self.child) - def num_children(self): return int(self.child) - def get_child_index(self, name): return 0 if self.child and (name == 'child' or name == '?') else -1 - def get_child_at_index(self, index): return self.child if self.child and index == 0 else None -def zig_Optional_SummaryProvider(value, _=None): - child = value.GetChildMemberWithName('child') - return child or 'null' - -class zig_ErrorUnion_SynthProvider: - def __init__(self, value, _=None): self.value = value - def update(self): - try: - self.error_set = self.value.GetChildMemberWithName('tag').Clone('error_set') - self.payload = self.value.GetChildMemberWithName('value').Clone('payload') if self.error_set.unsigned == 0 else None - except: pass - def has_children(self): return True - def num_children(self): return 1 - def get_child_index(self, name): return 0 if name == ('payload' if self.payload else 'error_set') else -1 - def get_child_at_index(self, index): return self.payload or self.error_set if index == 0 else None - -class zig_TaggedUnion_SynthProvider: - def __init__(self, value, _=None): self.value = value - def update(self): - try: - self.tag = self.value.GetChildMemberWithName('tag') - self.payload = self.value.GetChildMemberWithName('payload').GetChildMemberWithName(self.tag.value) - except: pass - def has_children(self): return True - def num_children(self): return 1 + (self.payload is not None) - def get_child_index(self, name): - try: return ('tag', 'payload').index(name) - except: return -1 - def get_child_at_index(self, index): return (self.tag, self.payload)[index] if index in range(2) else None - -# Define Zig Standard Library - -class std_MultiArrayList_SynthProvider: - def __init__(self, value, _=None): self.value = value - def update(self): - try: - self.len = 0 - - value_type = self.value.type - for helper in self.value.target.FindFunctions('%s.dbHelper' % value_type.name, lldb.eFunctionNameTypeFull): - ptr_self_type, ptr_child_type, ptr_field_type, ptr_entry_type = helper.function.type.GetFunctionArgumentTypes() - if ptr_self_type.GetPointeeType() == value_type: break - else: return - - self.entry_type = ptr_entry_type.GetPointeeType() - self.bytes = self.value.GetChildMemberWithName('bytes') - self.len = self.value.GetChildMemberWithName('len').unsigned - self.capacity = self.value.GetChildMemberWithName('capacity').unsigned - except: pass - def has_children(self): return True - def num_children(self): return self.len - def get_child_index(self, name): - try: return int(name.removeprefix('[').removesuffix(']')) - except: return -1 - def get_child_at_index(self, index): - try: - if index not in range(self.len): return None - offset = 0 - data = lldb.SBData() - for field in self.entry_type.fields: - field_type = field.type.GetPointeeType() - field_size = field_type.size - data.Append(self.bytes.CreateChildAtOffset(field.name, offset + index * field_size, field_type).address_of.data) - offset += self.capacity * field_size - return self.bytes.CreateValueFromData('[%d]' % index, data, self.entry_type) - except: return None -class std_MultiArrayList_Slice_SynthProvider: - def __init__(self, value, _=None): self.value = value - def update(self): - try: - self.len = 0 - - value_type = self.value.type - for helper in self.value.target.FindFunctions('%s.dbHelper' % value_type.name, lldb.eFunctionNameTypeFull): - ptr_self_type, ptr_child_type, ptr_field_type, ptr_entry_type = helper.function.type.GetFunctionArgumentTypes() - if ptr_self_type.GetPointeeType() == value_type: break - else: return - - self.fields = {member.name: index for index, member in enumerate(ptr_field_type.GetPointeeType().enum_members)} - self.entry_type = ptr_entry_type.GetPointeeType() - self.ptrs = self.value.GetChildMemberWithName('ptrs') - self.len = self.value.GetChildMemberWithName('len').unsigned - self.capacity = self.value.GetChildMemberWithName('capacity').unsigned - except: pass - def has_children(self): return True - def num_children(self): return self.len - def get_child_index(self, name): - try: return int(name.removeprefix('[').removesuffix(']')) - except: return -1 - def get_child_at_index(self, index): - try: - if index not in range(self.len): return None - data = lldb.SBData() - for field in self.entry_type.fields: - field_type = field.type.GetPointeeType() - data.Append(self.ptrs.child[self.fields[field.name.removesuffix('_ptr')]].CreateChildAtOffset(field.name, index * field_type.size, field_type).address_of.data) - return self.ptrs.CreateValueFromData('[%d]' % index, data, self.entry_type) - except: return None - -def MultiArrayList_Entry(type): return '^multi_array_list\\.MultiArrayList\\(%s\\)\\.Entry__struct_[1-9][0-9]*$' % type - -class std_HashMapUnmanaged_SynthProvider: - def __init__(self, value, _=None): self.value = value - def update(self): - try: - self.capacity = 0 - self.indices = tuple() - - self.metadata = self.value.GetChildMemberWithName('metadata') - if not self.metadata.unsigned: return - - value_type = self.value.type - for helper in self.value.target.FindFunctions('%s.dbHelper' % value_type.name, lldb.eFunctionNameTypeFull): - ptr_self_type, ptr_hdr_type, ptr_entry_type = helper.function.type.GetFunctionArgumentTypes() - if ptr_self_type.GetPointeeType() == value_type: break - else: return - self.entry_type = ptr_entry_type.GetPointeeType() - - hdr_type = ptr_hdr_type.GetPointeeType() - hdr = self.metadata.CreateValueFromAddress('header', self.metadata.deref.load_addr - hdr_type.size, hdr_type) - self.values = hdr.GetChildMemberWithName('values') - self.keys = hdr.GetChildMemberWithName('keys') - self.capacity = hdr.GetChildMemberWithName('capacity').unsigned - - self.indices = tuple(i for i, value in enumerate(self.metadata.GetPointeeData(0, self.capacity).sint8) if value < 0) - except: pass - def has_children(self): return True - def num_children(self): return len(self.indices) - def get_capacity(self): return self.capacity - def get_child_index(self, name): - try: return int(name.removeprefix('[').removesuffix(']')) - except: return -1 - def get_child_at_index(self, index): - try: - 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)))} - data = lldb.SBData() - for field in self.entry_type.fields: data.Append(fields[field.name]) - return self.metadata.CreateValueFromData('[%d]' % index, data, self.entry_type) - except: return None -def std_HashMapUnmanaged_SummaryProvider(value, _=None): - synth = std_HashMapUnmanaged_SynthProvider(value.GetNonSyntheticValue(), _) - synth.update() - return 'len=%d capacity=%d' % (synth.num_children(), synth.get_capacity()) - -# formats a struct of fields of the form `name_ptr: *Type` by auto dereferencing its fields -class std_Entry_SynthProvider: - def __init__(self, value, _=None): self.value = value - def update(self): - try: - self.children = tuple(child.Clone(child.name.removesuffix('_ptr')) for child in self.value.children if child.type.GetPointeeType().size != 0) - self.indices = {child.name: i for i, child in enumerate(self.children)} - except: pass - def has_children(self): return self.num_children() != 0 - def num_children(self): return len(self.children) - def get_child_index(self, name): return self.indices.get(name) - def get_child_at_index(self, index): return self.children[index].deref if index in range(len(self.children)) else None - -# Define Zig Stage2 Compiler - -class TagAndPayload_SynthProvider: - def __init__(self, value, _=None): self.value = value - def update(self): - try: - self.tag = self.value.GetChildMemberWithName('tag') or self.value.GetChildMemberWithName('tag_ptr').deref.Clone('tag') - data = self.value.GetChildMemberWithName('data_ptr') or self.value.GetChildMemberWithName('data') - self.payload = data.GetChildMemberWithName('payload').GetChildMemberWithName(data.GetChildMemberWithName('tag').value) - except: pass - def has_children(self): return True - def num_children(self): return 2 - def get_child_index(self, name): - try: return ('tag', 'payload').index(name) - except: return -1 - def get_child_at_index(self, index): return (self.tag, self.payload)[index] if index in range(2) else None - -def InstRef_SummaryProvider(value, _=None): - return value if any(value.unsigned == member.unsigned for member in value.type.enum_members) else ( - 'InternPool.Index(%d)' % value.unsigned if value.unsigned < 0x80000000 else 'instructions[%d]' % (value.unsigned - 0x80000000)) - -def InstIndex_SummaryProvider(value, _=None): - return 'instructions[%d]' % value.unsigned if value.unsigned < 0x80000000 else 'temps[%d]' % (value.unsigned - 0x80000000) - -class zig_DeclIndex_SynthProvider: - def __init__(self, value, _=None): self.value = value - def update(self): - try: - ip = InternPool_Find(self.value.thread) - if not ip: return - self.ptr = ip.GetChildMemberWithName('allocated_decls').GetChildAtIndex(self.value.unsigned).address_of.Clone('decl') - except: pass - def has_children(self): return True - def num_children(self): return 1 - def get_child_index(self, name): return 0 if name == 'decl' else -1 - def get_child_at_index(self, index): return self.ptr if index == 0 else None - -class Module_Namespace__Module_Namespace_Index_SynthProvider: - def __init__(self, value, _=None): self.value = value - def update(self): - try: - ip = InternPool_Find(self.value.thread) - if not ip: return - self.ptr = ip.GetChildMemberWithName('allocated_namespaces').GetChildAtIndex(self.value.unsigned).address_of.Clone('namespace') - except: pass - def has_children(self): return True - def num_children(self): return 1 - def get_child_index(self, name): return 0 if name == 'namespace' else -1 - def get_child_at_index(self, index): return self.ptr if index == 0 else None - -class TagOrPayloadPtr_SynthProvider: - def __init__(self, value, _=None): self.value = value - def update(self): - try: - value_type = self.value.type - for helper in self.value.target.FindFunctions('%s.dbHelper' % value_type.name, lldb.eFunctionNameTypeFull): - ptr_self_type, ptr_tag_to_payload_map_type = helper.function.type.GetFunctionArgumentTypes() - self_type = ptr_self_type.GetPointeeType() - if self_type == value_type: break - else: return - tag_to_payload_map = {field.name: field.type for field in ptr_tag_to_payload_map_type.GetPointeeType().fields} - - tag = self.value.GetChildMemberWithName('tag_if_small_enough') - if tag.unsigned < page_size: - self.tag = tag.Clone('tag') - self.payload = None - else: - ptr_otherwise = self.value.GetChildMemberWithName('ptr_otherwise') - self.tag = ptr_otherwise.GetChildMemberWithName('tag') - self.payload = ptr_otherwise.Cast(tag_to_payload_map[self.tag.value]).GetChildMemberWithName('data').Clone('payload') - except: pass - def has_children(self): return True - def num_children(self): return 1 + (self.payload is not None) - def get_child_index(self, name): - try: return ('tag', 'payload').index(name) - except: return -1 - def get_child_at_index(self, index): return (self.tag, self.payload)[index] if index in range(2) else None - -def Module_Decl_name(decl): - error = lldb.SBError() - return decl.process.ReadCStringFromMemory(decl.GetChildMemberWithName('name').deref.load_addr, 256, error) - -def Module_Namespace_RenderFullyQualifiedName(namespace): - parent = namespace.GetChildMemberWithName('parent') - if parent.unsigned < page_size: return zig_String_decode(namespace.GetChildMemberWithName('file_scope').GetChildMemberWithName('sub_file_path')).removesuffix('.zig').replace('/', '.') - return '.'.join((Module_Namespace_RenderFullyQualifiedName(parent), Module_Decl_name(namespace.GetChildMemberWithName('ty').GetChildMemberWithName('payload').GetChildMemberWithName('owner_decl').GetChildMemberWithName('decl')))) - -def Module_Decl_RenderFullyQualifiedName(decl): return '.'.join((Module_Namespace_RenderFullyQualifiedName(decl.GetChildMemberWithName('src_namespace')), Module_Decl_name(decl))) - -def OwnerDecl_RenderFullyQualifiedName(payload): return Module_Decl_RenderFullyQualifiedName(payload.GetChildMemberWithName('owner_decl').GetChildMemberWithName('decl')) - -def InternPool_Find(thread): - for frame in thread: - ip = frame.FindVariable('ip') or frame.FindVariable('intern_pool') - if ip: return ip - mod = frame.FindVariable('zcu') or frame.FindVariable('mod') or frame.FindVariable('module') - if mod: - ip = mod.GetChildMemberWithName('intern_pool') - if ip: return ip - -class InternPool_Index_SynthProvider: - def __init__(self, value, _=None): self.value = value - def update(self): - try: - index_type = self.value.type - for helper in self.value.target.FindFunctions('%s.dbHelper' % index_type.name, lldb.eFunctionNameTypeFull): - ptr_self_type, ptr_tag_to_encoding_map_type = helper.function.type.GetFunctionArgumentTypes() - if ptr_self_type.GetPointeeType() == index_type: break - else: return - tag_to_encoding_map = {field.name: field.type for field in ptr_tag_to_encoding_map_type.GetPointeeType().fields} - - ip = InternPool_Find(self.value.thread) - if not ip: return - self.item = ip.GetChildMemberWithName('items').GetChildAtIndex(self.value.unsigned) - extra = ip.GetChildMemberWithName('extra').GetChildMemberWithName('items') - self.tag = self.item.GetChildMemberWithName('tag').Clone('tag') - self.data = None - self.trailing = None - data = self.item.GetChildMemberWithName('data') - encoding_type = tag_to_encoding_map[self.tag.value] - dynamic_values = {} - for encoding_field in encoding_type.fields: - if encoding_field.name == 'data': - if encoding_field.type.IsPointerType(): - extra_index = data.unsigned - self.data = extra.GetChildAtIndex(extra_index).address_of.Cast(encoding_field.type).deref.Clone('data') - extra_index += encoding_field.type.GetPointeeType().num_fields - else: - self.data = data.Cast(encoding_field.type).Clone('data') - elif encoding_field.name == 'trailing': - trailing_data = lldb.SBData() - for trailing_field in encoding_field.type.fields: - trailing_data.Append(extra.GetChildAtIndex(extra_index).address_of.data) - trailing_len = dynamic_values['trailing.%s.len' % trailing_field.name].unsigned - trailing_data.Append(lldb.SBData.CreateDataFromInt(trailing_len, trailing_data.GetAddressByteSize())) - extra_index += trailing_len - self.trailing = self.data.CreateValueFromData('trailing', trailing_data, encoding_field.type) - else: - for path in encoding_field.type.GetPointeeType().name.removeprefix('%s::' % encoding_type.name).removeprefix('%s.' % encoding_type.name).partition('__')[0].split(' orelse '): - if path.startswith('data.'): - root = self.data - path = path[len('data'):] - else: return - dynamic_value = root.GetValueForExpressionPath(path) - if dynamic_value: - dynamic_values[encoding_field.name] = dynamic_value - break - except: pass - def has_children(self): return True - def num_children(self): return 2 + (self.trailing is not None) - def get_child_index(self, name): - try: return ('tag', 'data', 'trailing').index(name) - except: return -1 - def get_child_at_index(self, index): return (self.tag, self.data, self.trailing)[index] if index in range(3) else None - -def InternPool_NullTerminatedString_SummaryProvider(value, _=None): - try: - ip = InternPool_Find(value.thread) - if not ip: return - items = ip.GetChildMemberWithName('string_bytes').GetChildMemberWithName('items') - b = bytearray() - i = 0 - while True: - x = items.GetChildAtIndex(value.unsigned + i).GetValueAsUnsigned() - if x == 0: break - b.append(x) - i += 1 - s = b.decode(encoding='utf8', errors='backslashreplace') - s1 = s if s.isprintable() else ''.join((c if c.isprintable() else '\\x%02x' % ord(c) for c in s)) - return '"%s"' % s1 - except: - pass - -def type_Type_pointer(payload): - pointee_type = payload.GetChildMemberWithName('pointee_type') - sentinel = payload.GetChildMemberWithName('sentinel').GetChildMemberWithName('child') - align = payload.GetChildMemberWithName('align').unsigned - addrspace = payload.GetChildMemberWithName('addrspace').value - bit_offset = payload.GetChildMemberWithName('bit_offset').unsigned - host_size = payload.GetChildMemberWithName('host_size').unsigned - vector_index = payload.GetChildMemberWithName('vector_index') - allowzero = payload.GetChildMemberWithName('allowzero').unsigned - const = not payload.GetChildMemberWithName('mutable').unsigned - volatile = payload.GetChildMemberWithName('volatile').unsigned - size = payload.GetChildMemberWithName('size').value - - if size == 'One': summary = '*' - elif size == 'Many': summary = '[*' - elif size == 'Slice': summary = '[' - elif size == 'C': summary = '[*c' - if sentinel: summary += ':%s' % value_Value_SummaryProvider(sentinel) - if size != 'One': summary += ']' - if allowzero: summary += 'allowzero ' - 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 '') - if addrspace != 'generic': summary += 'addrspace(.%s) ' % addrspace - if const: summary += 'const ' - if volatile: summary += 'volatile ' - summary += type_Type_SummaryProvider(pointee_type) - return summary - -def type_Type_function(payload): - param_types = payload.GetChildMemberWithName('param_types').children - comptime_params = payload.GetChildMemberWithName('comptime_params').GetPointeeData(0, len(param_types)).uint8 - return_type = payload.GetChildMemberWithName('return_type') - alignment = payload.GetChildMemberWithName('alignment').unsigned - noalias_bits = payload.GetChildMemberWithName('noalias_bits').unsigned - cc = payload.GetChildMemberWithName('cc').value - is_var_args = payload.GetChildMemberWithName('is_var_args').unsigned - - 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)) - -def type_Type_SummaryProvider(value, _=None): - tag = value.GetChildMemberWithName('tag').value - return type_tag_handlers.get(tag, lambda payload: tag)(value.GetChildMemberWithName('payload')) - -type_tag_handlers = { - 'atomic_order': lambda payload: 'std.builtin.AtomicOrder', - 'atomic_rmw_op': lambda payload: 'std.builtin.AtomicRmwOp', - 'calling_convention': lambda payload: 'std.builtin.CallingConvention', - 'address_space': lambda payload: 'std.builtin.AddressSpace', - 'float_mode': lambda payload: 'std.builtin.FloatMode', - 'reduce_op': lambda payload: 'std.builtin.ReduceOp', - 'modifier': lambda payload: 'std.builtin.CallModifier', - 'prefetch_options': lambda payload: 'std.builtin.PrefetchOptions', - 'export_options': lambda payload: 'std.builtin.ExportOptions', - 'extern_options': lambda payload: 'std.builtin.ExternOptions', - 'type_info': lambda payload: 'std.builtin.Type', - - 'enum_literal': lambda payload: '@EnumLiteral()', - 'null': lambda payload: '@TypeOf(null)', - 'undefined': lambda payload: '@TypeOf(undefined)', - 'empty_struct_literal': lambda payload: '@TypeOf(.{})', - - 'anyerror_void_error_union': lambda payload: 'anyerror!void', - 'slice_const_u8': lambda payload: '[]const u8', - 'slice_const_u8_sentinel_0': lambda payload: '[:0]const u8', - 'fn_noreturn_no_args': lambda payload: 'fn() noreturn', - 'fn_void_no_args': lambda payload: 'fn() void', - 'fn_naked_noreturn_no_args': lambda payload: 'fn() callconv(.naked) noreturn', - 'fn_ccc_void_no_args': lambda payload: 'fn() callconv(.c) void', - 'ptr_usize': lambda payload: '*usize', - 'ptr_const_comptime_int': lambda payload: '*const comptime_int', - 'manyptr_u8': lambda payload: '[*]u8', - 'manyptr_const_u8': lambda payload: '[*]const u8', - 'manyptr_const_u8_sentinel_0': lambda payload: '[*:0]const u8', - - 'function': type_Type_function, - 'error_union': lambda payload: '%s!%s' % (type_Type_SummaryProvider(payload.GetChildMemberWithName('error_set')), type_Type_SummaryProvider(payload.GetChildMemberWithName('payload'))), - 'array_u8': lambda payload: '[%d]u8' % payload.unsigned, - 'array_u8_sentinel_0': lambda payload: '[%d:0]u8' % payload.unsigned, - 'vector': lambda payload: '@Vector(%d, %s)' % (payload.GetChildMemberWithName('len').unsigned, type_Type_SummaryProvider(payload.GetChildMemberWithName('elem_type'))), - 'array': lambda payload: '[%d]%s' % (payload.GetChildMemberWithName('len').unsigned, type_Type_SummaryProvider(payload.GetChildMemberWithName('elem_type'))), - 'array_sentinel': lambda payload: '[%d:%s]%s' % (payload.GetChildMemberWithName('len').unsigned, value_Value_SummaryProvider(payload.GetChildMemberWithName('sentinel')), type_Type_SummaryProvider(payload.GetChildMemberWithName('elem_type'))), - '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)), - '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)), - 'pointer': type_Type_pointer, - 'single_const_pointer': lambda payload: '*const %s' % type_Type_SummaryProvider(payload), - 'single_mut_pointer': lambda payload: '*%s' % type_Type_SummaryProvider(payload), - 'many_const_pointer': lambda payload: '[*]const %s' % type_Type_SummaryProvider(payload), - 'many_mut_pointer': lambda payload: '[*]%s' % type_Type_SummaryProvider(payload), - 'c_const_pointer': lambda payload: '[*c]const %s' % type_Type_SummaryProvider(payload), - 'c_mut_pointer': lambda payload: '[*c]%s' % type_Type_SummaryProvider(payload), - 'slice_const': lambda payload: '[]const %s' % type_Type_SummaryProvider(payload), - 'mut_slice': lambda payload: '[]%s' % type_Type_SummaryProvider(payload), - 'int_signed': lambda payload: 'i%d' % payload.unsigned, - 'int_unsigned': lambda payload: 'u%d' % payload.unsigned, - 'optional': lambda payload: '?%s' % type_Type_SummaryProvider(payload), - 'optional_single_mut_pointer': lambda payload: '?*%s' % type_Type_SummaryProvider(payload), - 'optional_single_const_pointer': lambda payload: '?*const %s' % type_Type_SummaryProvider(payload), - 'anyframe_T': lambda payload: 'anyframe->%s' % type_Type_SummaryProvider(payload), - 'error_set': lambda payload: type_tag_handlers['error_set_merged'](payload.GetChildMemberWithName('names')), - 'error_set_single': lambda payload: 'error{%s}' % zig_String_AsIdentifier(payload, zig_IsFieldName), - 'error_set_merged': lambda payload: 'error{%s}' % ','.join(zig_String_AsIdentifier(child.GetChildMemberWithName('key'), zig_IsFieldName) for child in payload.GetChildMemberWithName('entries').children), - 'error_set_inferred': lambda payload: '@typeInfo(@typeInfo(@TypeOf(%s)).@"fn".return_type.?).error_union.error_set' % OwnerDecl_RenderFullyQualifiedName(payload.GetChildMemberWithName('func')), - - 'enum_full': OwnerDecl_RenderFullyQualifiedName, - 'enum_nonexhaustive': OwnerDecl_RenderFullyQualifiedName, - 'enum_numbered': OwnerDecl_RenderFullyQualifiedName, - 'enum_simple': OwnerDecl_RenderFullyQualifiedName, - 'struct': OwnerDecl_RenderFullyQualifiedName, - 'union': OwnerDecl_RenderFullyQualifiedName, - 'union_safety_tagged': OwnerDecl_RenderFullyQualifiedName, - 'union_tagged': OwnerDecl_RenderFullyQualifiedName, - 'opaque': OwnerDecl_RenderFullyQualifiedName, -} - -def value_Value_str_lit(payload): - for frame in payload.thread: - mod = frame.FindVariable('zcu') or frame.FindVariable('mod') or frame.FindVariable('module') - if mod: break - else: return - return '"%s"' % zig_String_decode(mod.GetChildMemberWithName('string_literal_bytes').GetChildMemberWithName('items'), payload.GetChildMemberWithName('index').unsigned, payload.GetChildMemberWithName('len').unsigned) - -def value_Value_SummaryProvider(value, _=None): - tag = value.GetChildMemberWithName('tag').value - return value_tag_handlers.get(tag, lambda payload: tag.removesuffix('_type'))(value.GetChildMemberWithName('payload')) - -value_tag_handlers = { - 'undef': lambda payload: 'undefined', - 'zero': lambda payload: '0', - 'one': lambda payload: '1', - 'void_value': lambda payload: '{}', - 'unreachable_value': lambda payload: 'unreachable', - 'null_value': lambda payload: 'null', - 'bool_true': lambda payload: 'true', - 'bool_false': lambda payload: 'false', - - 'empty_struct_value': lambda payload: '.{}', - 'empty_array': lambda payload: '.{}', - - 'ty': type_Type_SummaryProvider, - 'int_type': lambda payload: '%c%d' % (payload.GetChildMemberWithName('bits').unsigned, 's' if payload.GetChildMemberWithName('signed').unsigned == 1 else 'u'), - 'int_u64': lambda payload: '%d' % payload.unsigned, - 'int_i64': lambda payload: '%d' % payload.signed, - 'int_big_positive': lambda payload: sum(child.unsigned << i * child.type.size * 8 for i, child in enumerate(payload.children)), - 'int_big_negative': lambda payload: '-%s' % value_tag_handlers['int_big_positive'](payload), - 'function': OwnerDecl_RenderFullyQualifiedName, - 'extern_fn': OwnerDecl_RenderFullyQualifiedName, - 'variable': lambda payload: value_Value_SummaryProvider(payload.GetChildMemberWithName('decl').GetChildMemberWithName('val')), - 'runtime_value': value_Value_SummaryProvider, - 'decl_ref': lambda payload: value_Value_SummaryProvider(payload.GetChildMemberWithName('decl').GetChildMemberWithName('val')), - 'decl_ref_mut': lambda payload: value_Value_SummaryProvider(payload.GetChildMemberWithName('decl_index').GetChildMemberWithName('decl').GetChildMemberWithName('val')), - 'comptime_field_ptr': lambda payload: '&%s' % value_Value_SummaryProvider(payload.GetChildMemberWithName('field_val')), - 'elem_ptr': lambda payload: '(%s)[%d]' % (value_Value_SummaryProvider(payload.GetChildMemberWithName('array_ptr')), payload.GetChildMemberWithName('index').unsigned), - 'field_ptr': lambda payload: '(%s).field[%d]' % (value_Value_SummaryProvider(payload.GetChildMemberWithName('container_ptr')), payload.GetChildMemberWithName('field_index').unsigned), - 'bytes': lambda payload: '"%s"' % zig_String_decode(payload), - 'str_lit': value_Value_str_lit, - 'repeated': lambda payload: '.{%s} ** _' % value_Value_SummaryProvider(payload), - 'empty_array_sentinel': lambda payload: '.{%s}' % value_Value_SummaryProvider(payload), - 'slice': lambda payload: '(%s)[0..%s]' % tuple(value_Value_SummaryProvider(payload.GetChildMemberWithName(name)) for name in ('ptr', 'len')), - 'float_16': lambda payload: payload.value, - 'float_32': lambda payload: payload.value, - 'float_64': lambda payload: payload.value, - 'float_80': lambda payload: payload.value, - 'float_128': lambda payload: payload.value, - 'enum_literal': lambda payload: '.%s' % zig_String_AsIdentifier(payload, zig_IsFieldName), - 'enum_field_index': lambda payload: 'field[%d]' % payload.unsigned, - 'error': lambda payload: 'error.%s' % zig_String_AsIdentifier(payload.GetChildMemberWithName('name'), zig_IsFieldName), - 'eu_payload': value_Value_SummaryProvider, - 'eu_payload_ptr': lambda payload: '&((%s).* catch unreachable)' % value_Value_SummaryProvider(payload.GetChildMemberWithName('container_ptr')), - 'opt_payload': value_Value_SummaryProvider, - 'opt_payload_ptr': lambda payload: '&(%s).*.?' % value_Value_SummaryProvider(payload.GetChildMemberWithName('container_ptr')), - 'aggregate': lambda payload: '.{%s}' % ', '.join(map(value_Value_SummaryProvider, payload.children)), - 'union': lambda payload: '.{.%s = %s}' % tuple(value_Value_SummaryProvider(payload.GetChildMemberWithName(name)) for name in ('tag', 'val')), - - 'lazy_align': lambda payload: '@alignOf(%s)' % type_Type_SummaryProvider(payload), - 'lazy_size': lambda payload: '@sizeOf(%s)' % type_Type_SummaryProvider(payload), -} - -# Define Zig Stage2 Compiler (compiled with the self-hosted backend) - -class root_InternPool_Local_List_SynthProvider: - def __init__(self, value, _=None): self.value = value - def update(self): - capacity = self.value.EvaluateExpression('@as(*@This().Header, @alignCast(@ptrCast(@this().bytes - @This().bytes_offset))).capacity') - self.view = create_struct(self.value, '.view', self.value.type.FindDirectNestedType('View'), { 'bytes': self.value.GetChildMemberWithName('bytes'), 'len': capacity, 'capacity': capacity }).GetNonSyntheticValue() - def has_children(self): return True - def num_children(self): return 1 - def get_child_index(self, name): - try: return ('view',).index(name) - except: pass - def get_child_at_index(self, index): - try: return (self.view,)[index] - except: pass - -expr_path_re = re.compile(r'\{([^}]+)%([^%#}]+)(?:#([^%#}]+))?\}') -def root_InternPool_Index_SummaryProvider(value, _=None): - unwrapped = value.GetChildMemberWithName('unwrapped') - if not unwrapped: return '' # .none - tag = unwrapped.GetChildMemberWithName('tag') - tag_value = tag.value - summary = tag.CreateValueFromType(tag.type).GetChildMemberWithName('encodings').GetChildMemberWithName(tag_value.removeprefix('.').removeprefix('@"').removesuffix('"').replace(r'\"', '"')).GetChildMemberWithName('summary') - if not summary: return tag_value - return re.sub( - expr_path_re, - lambda matchobj: getattr(unwrapped.GetValueForExpressionPath(matchobj[1]), matchobj[2]).strip(matchobj[3] or ''), - summary.summary.removeprefix('.').removeprefix('@"').removesuffix('"').replace(r'\"', '"'), - ) - -class root_InternPool_Index_SynthProvider: - def __init__(self, value, _=None): self.value = value - def update(self): - self.unwrapped = None - wrapped = self.value.unsigned - if wrapped == (1 << 32) - 1: return - unwrapped_type = self.value.type.FindDirectNestedType('Unwrapped') - ip = self.value.CreateValueFromType(unwrapped_type).GetChildMemberWithName('debug_state').GetChildMemberWithName('intern_pool').GetNonSyntheticValue().GetChildMemberWithName('?') - tid_shift_30 = ip.GetChildMemberWithName('tid_shift_30').unsigned - self.unwrapped = create_struct(self.value, '.unwrapped', unwrapped_type, { 'tid': wrapped >> tid_shift_30, 'index': wrapped & (1 << tid_shift_30) - 1 }) - def has_children(self): return True - def num_children(self): return 0 - def get_child_index(self, name): - try: return ('unwrapped',).index(name) - except: pass - def get_child_at_index(self, index): - try: return (self.unwrapped,)[index] - except: pass - -class root_InternPool_Index_Unwrapped_SynthProvider: - def __init__(self, value, _=None): self.value = value - def update(self): - self.tag, self.index, self.data, self.payload, self.trailing = None, None, None, None, None - index = self.value.GetChildMemberWithName('index') - ip = self.value.CreateValueFromType(self.value.type).GetChildMemberWithName('debug_state').GetChildMemberWithName('intern_pool').GetNonSyntheticValue().GetChildMemberWithName('?') - shared = ip.GetChildMemberWithName('locals').GetSyntheticValue().child[self.value.GetChildMemberWithName('tid').unsigned].GetChildMemberWithName('shared') - item = shared.GetChildMemberWithName('items').GetChildMemberWithName('view').child[index.unsigned] - self.tag, item_data = item.GetChildMemberWithName('tag'), item.GetChildMemberWithName('data') - encoding = self.tag.CreateValueFromType(self.tag.type).GetChildMemberWithName('encodings').GetChildMemberWithName(self.tag.value.removeprefix('.').removeprefix('@"').removesuffix('"').replace(r'\"', '"')) - encoding_index, encoding_data, encoding_payload, encoding_trailing, encoding_config = encoding.GetChildMemberWithName('index'), encoding.GetChildMemberWithName('data'), encoding.GetChildMemberWithName('payload'), encoding.GetChildMemberWithName('trailing'), encoding.GetChildMemberWithName('config') - if encoding_index: - index_type = encoding_index.GetValueAsType() - index_bytes, index_data = index.data.uint8, lldb.SBData() - match index_data.byte_order: - case lldb.eByteOrderLittle: - index_bytes = bytes(index_bytes[:index_type.size]) - case lldb.eByteOrderBig: - index_bytes = bytes(index_bytes[-index_type.size:]) - index_data.SetData(lldb.SBError(), index_bytes, index_data.byte_order, index_data.GetAddressByteSize()) - self.index = self.value.CreateValueFromData('.index', index_data, index_type) - elif encoding_data: - data_type = encoding_data.GetValueAsType() - data_bytes, data_data = item_data.data.uint8, lldb.SBData() - match data_data.byte_order: - case lldb.eByteOrderLittle: - data_bytes = bytes(data_bytes[:data_type.size]) - case lldb.eByteOrderBig: - data_bytes = bytes(data_bytes[-data_type.size:]) - data_data.SetData(lldb.SBError(), data_bytes, data_data.byte_order, data_data.GetAddressByteSize()) - self.data = self.value.CreateValueFromData('.data', data_data, data_type) - elif encoding_payload: - extra = shared.GetChildMemberWithName('extra').GetChildMemberWithName('view').GetChildMemberWithName('0') - extra_index = item_data.unsigned - payload_type = encoding_payload.GetValueAsType() - payload_fields = dict() - for payload_field in payload_type.fields: - payload_fields[payload_field.name] = extra.child[extra_index] - extra_index += 1 - self.payload = create_struct(self.value, '.payload', payload_type, payload_fields) - if encoding_trailing and encoding_config: - trailing_type = encoding_trailing.GetValueAsType() - trailing_bytes, trailing_data = bytearray(trailing_type.size), lldb.SBData() - def eval_config(config_name): - expr = encoding_config.GetChildMemberWithName(config_name).summary.removeprefix('.').removeprefix('@"').removesuffix('"').replace(r'\"', '"') - if 'payload.' in expr: - return self.payload.EvaluateExpression(expr.replace('payload.', '@this().')) - elif expr.startswith('trailing.'): - field_type, field_byte_offset = trailing_type, 0 - expr_parts = expr.split('.') - for expr_part in expr_parts[1:]: - field = next(filter(lambda field: field.name == expr_part, field_type.fields)) - field_type = field.type - field_byte_offset += field.byte_offset - field_data = lldb.SBData() - field_bytes = trailing_bytes[field_byte_offset:field_byte_offset + field_type.size] - field_data.SetData(lldb.SBError(), field_bytes, field_data.byte_order, field_data.GetAddressByteSize()) - return self.value.CreateValueFromData('.%s' % expr_parts[-1], field_data, field_type) - else: - return self.value.frame.EvaluateExpression(expr) - for trailing_field in trailing_type.fields: - trailing_field_type = trailing_field.type - trailing_field_name = 'trailing.%s' % trailing_field.name - trailing_field_byte_offset = trailing_field.byte_offset - while True: - match [trailing_field_type_field.name for trailing_field_type_field in trailing_field_type.fields]: - case ['has_value', '?']: - has_value_field, child_field = trailing_field_type.fields - trailing_field_name = '%s.%s' % (trailing_field_name, child_field.name) - match eval_config(trailing_field_name).value: - case 'true': - if has_value_field.type.name == 'bool': - trailing_bytes[trailing_field_byte_offset + has_value_field.byte_offset] = True - trailing_field_type = child_field.type - trailing_field_byte_offset += child_field.byte_offset - case 'false': - break - case ['ptr', 'len']: - ptr_field, len_field = trailing_field_type.fields - ptr_field_byte_offset, len_field_byte_offset = trailing_field_byte_offset + ptr_field.byte_offset, trailing_field_byte_offset + len_field.byte_offset - trailing_bytes[ptr_field_byte_offset:ptr_field_byte_offset + ptr_field.type.size] = extra.child[extra_index].address_of.data.uint8 - len_field_value = eval_config('%s.len' % trailing_field_name) - len_field_size = len_field.type.size - match trailing_data.byte_order: - case lldb.eByteOrderLittle: - len_field_bytes = len_field_value.data.uint8[:len_field_size] - trailing_bytes[len_field_byte_offset:len_field_byte_offset + len(len_field_bytes)] = len_field_bytes - case lldb.eByteOrderBig: - len_field_bytes = len_field_value.data.uint8[-len_field_size:] - len_field_end = len_field_byte_offset + len_field_size - trailing_bytes[len_field_end - len(len_field_bytes):len_field_end] = len_field_bytes - extra_index += (ptr_field.type.GetPointeeType().size * len_field_value.unsigned + 3) // 4 - break - case _: - for offset in range(0, trailing_field_type.size, 4): - trailing_bytes[trailing_field_byte_offset + offset:trailing_field_byte_offset + offset + 4] = extra.child[extra_index].data.uint8 - extra_index += 1 - break - trailing_data.SetData(lldb.SBError(), trailing_bytes, trailing_data.byte_order, trailing_data.GetAddressByteSize()) - self.trailing = self.value.CreateValueFromData('.trailing', trailing_data, trailing_type) - def has_children(self): return True - def num_children(self): return 1 + ((self.index or self.data or self.payload) is not None) + (self.trailing is not None) - def get_child_index(self, name): - try: return ('tag', 'index' if self.index is not None else 'data' if self.data is not None else 'payload', 'trailing').index(name) - except: pass - def get_child_at_index(self, index): - try: return (self.tag, self.index or self.data or self.payload, self.trailing)[index] - except: pass - -def root_InternPool_String_SummaryProvider(value, _=None): - wrapped = value.unsigned - if wrapped == (1 << 32) - 1: return '' - ip = value.CreateValueFromType(value.type).GetChildMemberWithName('debug_state').GetChildMemberWithName('intern_pool').GetNonSyntheticValue().GetChildMemberWithName('?') - tid_shift_32 = ip.GetChildMemberWithName('tid_shift_32').unsigned - locals_value = ip.GetChildMemberWithName('locals').GetSyntheticValue() - local_value = locals_value.child[wrapped >> tid_shift_32] - if local_value is None: - wrapped = 0 - local_value = locals_value.child[0] - string = local_value.GetChildMemberWithName('shared').GetChildMemberWithName('strings').GetChildMemberWithName('view').GetChildMemberWithName('0').child[wrapped & (1 << tid_shift_32) - 1].address_of - string.format = lldb.eFormatCString - return string.value - -class root_InternPool_TrackedInst_Index_SynthProvider: - def __init__(self, value, _=None): self.value = value - def update(self): - self.tracked_inst = None - wrapped = self.value.unsigned - if wrapped == (1 << 32) - 1: return - ip = self.value.CreateValueFromType(self.value.type).GetChildMemberWithName('debug_state').GetChildMemberWithName('intern_pool').GetNonSyntheticValue().GetChildMemberWithName('?') - tid_shift_32 = ip.GetChildMemberWithName('tid_shift_32').unsigned - locals_value = ip.GetChildMemberWithName('locals').GetSyntheticValue() - local_value = locals_value.child[wrapped >> tid_shift_32] - if local_value is None: - wrapped = 0 - local_value = locals_value.child[0] - self.tracked_inst = local_value.GetChildMemberWithName('shared').GetChildMemberWithName('tracked_insts').GetChildMemberWithName('view').GetChildMemberWithName('0').child[wrapped & (1 << tid_shift_32) - 1] - def has_children(self): return False if self.tracked_inst is None else self.tracked_inst.GetNumChildren(1) > 0 - def num_children(self): return 0 if self.tracked_inst is None else self.tracked_inst.GetNumChildren() - def get_child_index(self, name): return -1 if self.tracked_inst is None else self.tracked_inst.GetIndexOfChildWithName(name) - def get_child_at_index(self, index): return None if self.tracked_inst is None else self.tracked_inst.GetChildAtIndex(index) - -class root_InternPool_Nav_Index_SynthProvider: - def __init__(self, value, _=None): self.value = value - def update(self): - self.nav = None - wrapped = self.value.unsigned - if wrapped == (1 << 32) - 1: return - ip = self.value.CreateValueFromType(self.value.type).GetChildMemberWithName('debug_state').GetChildMemberWithName('intern_pool').GetNonSyntheticValue().GetChildMemberWithName('?') - tid_shift_32 = ip.GetChildMemberWithName('tid_shift_32').unsigned - locals_value = ip.GetChildMemberWithName('locals').GetSyntheticValue() - local_value = locals_value.child[wrapped >> tid_shift_32] - if local_value is None: - wrapped = 0 - local_value = locals_value.child[0] - self.nav = local_value.GetChildMemberWithName('shared').GetChildMemberWithName('navs').GetChildMemberWithName('view').child[wrapped & (1 << tid_shift_32) - 1] - def has_children(self): return False if self.nav is None else self.nav.GetNumChildren(1) > 0 - def num_children(self): return 0 if self.nav is None else self.nav.GetNumChildren() - def get_child_index(self, name): return -1 if self.nav is None else self.nav.GetIndexOfChildWithName(name) - def get_child_at_index(self, index): return None if self.nav is None else self.nav.GetChildAtIndex(index) - -# Initialize - -def add(debugger, *, category, regex=False, type, identifier=None, synth=False, inline_children=False, expand=False, summary=False): - prefix = '.'.join((__name__, (identifier or type).replace('.', '_').replace(':', '_'))) - 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)) - if synth: debugger.HandleCommand('type synthetic add --category %s%s --python-class %s_SynthProvider "%s"' % (category, ' --regex' if regex else '', prefix, type)) - -def __lldb_init_module(debugger, _=None): - # Initialize Zig Categories - debugger.HandleCommand('type category define --language c99 zig.lang zig.std') - - # Initialize Zig Language - add(debugger, category='zig.lang', regex=True, type='^\\[\\]', identifier='zig_Slice', synth=True, expand=True, summary='len=${svar%#}') - add(debugger, category='zig.lang', type='[]u8', identifier='zig_String', summary=True) - add(debugger, category='zig.lang', regex=True, type='^\\?', identifier='zig_Optional', synth=True, summary=True) - add(debugger, category='zig.lang', regex=True, type='^(error{.*}|anyerror)!', identifier='zig_ErrorUnion', synth=True, inline_children=True, summary=True) - - # Initialize Zig Standard Library - add(debugger, category='zig.std', type='mem.Allocator', summary='${var.ptr}') - 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}') - add(debugger, category='zig.std', regex=True, type='^multi_array_list\\.MultiArrayList\\(.*\\)\\.Slice$', identifier='std_MultiArrayList_Slice', synth=True, expand=True, summary='len=${var.len} capacity=${var.capacity}') - add(debugger, category='zig.std', regex=True, type=MultiArrayList_Entry('.*'), identifier='std_Entry', synth=True, inline_children=True, summary=True) - add(debugger, category='zig.std', regex=True, type='^hash_map\\.HashMapUnmanaged\\(.*\\)$', identifier='std_HashMapUnmanaged', synth=True, expand=True, summary=True) - add(debugger, category='zig.std', regex=True, type='^hash_map\\.HashMapUnmanaged\\(.*\\)\\.Entry$', identifier = 'std_Entry', synth=True, inline_children=True, summary=True) - - # Initialize Zig Stage2 Compiler - add(debugger, category='zig.stage2', type='Zir.Inst', identifier='TagAndPayload', synth=True, inline_children=True, summary=True) - add(debugger, category='zig.stage2', regex=True, type=MultiArrayList_Entry('Zir\\.Inst'), identifier='TagAndPayload', synth=True, inline_children=True, summary=True) - add(debugger, category='zig.stage2', regex=True, type='^Zir\\.Inst\\.Data\\.Data__struct_[1-9][0-9]*$', inline_children=True, summary=True) - add(debugger, category='zig.stage2', type='Zir.Inst::Zir.Inst.Ref', identifier='InstRef', summary=True) - add(debugger, category='zig.stage2', type='Zir.Inst::Zir.Inst.Index', identifier='InstIndex', summary=True) - add(debugger, category='zig.stage2', type='Air.Inst', identifier='TagAndPayload', synth=True, inline_children=True, summary=True) - add(debugger, category='zig.stage2', type='Air.Inst::Air.Inst.Ref', identifier='InstRef', summary=True) - add(debugger, category='zig.stage2', type='Air.Inst::Air.Inst.Index', identifier='InstIndex', summary=True) - add(debugger, category='zig.stage2', regex=True, type=MultiArrayList_Entry('Air\\.Inst'), identifier='TagAndPayload', synth=True, inline_children=True, summary=True) - add(debugger, category='zig.stage2', regex=True, type='^Air\\.Inst\\.Data\\.Data__struct_[1-9][0-9]*$', inline_children=True, summary=True) - add(debugger, category='zig.stage2', type='zig.DeclIndex', synth=True) - add(debugger, category='zig.stage2', type='Module.Namespace::Module.Namespace.Index', synth=True) - add(debugger, category='zig.stage2', type='Module.LazySrcLoc', identifier='zig_TaggedUnion', synth=True) - add(debugger, category='zig.stage2', type='InternPool.Index', synth=True) - add(debugger, category='zig.stage2', type='InternPool.NullTerminatedString', summary=True) - add(debugger, category='zig.stage2', type='InternPool.Key', identifier='zig_TaggedUnion', synth=True) - add(debugger, category='zig.stage2', type='InternPool.Key.Int.Storage', identifier='zig_TaggedUnion', synth=True) - add(debugger, category='zig.stage2', type='InternPool.Key.ErrorUnion.Value', identifier='zig_TaggedUnion', synth=True) - add(debugger, category='zig.stage2', type='InternPool.Key.Float.Storage', identifier='zig_TaggedUnion', synth=True) - add(debugger, category='zig.stage2', type='InternPool.Key.Ptr.Addr', identifier='zig_TaggedUnion', synth=True) - add(debugger, category='zig.stage2', type='InternPool.Key.Aggregate.Storage', identifier='zig_TaggedUnion', synth=True) - add(debugger, category='zig.stage2', type='arch.x86_64.CodeGen.MCValue', identifier='zig_TaggedUnion', synth=True, inline_children=True, summary=True) - - # Initialize Zig Stage2 Compiler (compiled with the self-hosted backend) - add(debugger, category='zig', regex=True, type=r'^root\.InternPool\.Local\.List\(.*\)$', identifier='root_InternPool_Local_List', synth=True, expand=True, summary='capacity=${var%#}') - add(debugger, category='zig', type='root.InternPool.Index', synth=True, summary=True) - add(debugger, category='zig', type='root.InternPool.Index.Unwrapped', synth=True) - add(debugger, category='zig', regex=True, type=r'^root\.InternPool\.(Optional)?(NullTerminated)?String$', identifier='root_InternPool_String', summary=True) - add(debugger, category='zig', regex=True, type=r'^root\.InternPool\.TrackedInst\.Index(\.Optional)?$', identifier='root_InternPool_TrackedInst_Index', synth=True) - add(debugger, category='zig', regex=True, type=r'^root\.InternPool\.Nav\.Index(\.Optional)?$', identifier='root_InternPool_Nav_Index', synth=True) diff --git a/tools/std_gdb_pretty_printers.py b/tools/std_gdb_pretty_printers.py @@ -1,142 +0,0 @@ -# pretty printing for the standard library. -# put "source /path/to/std_gdb_pretty_printers.py" in ~/.gdbinit to load it automatically. -import re -import gdb.printing - -# Handles both ArrayList and ArrayListUnmanaged. -class ArrayListPrinter: - def __init__(self, val): - self.val = val - - def to_string(self): - type = self.val.type.name[len('std.array_list.'):] - type = re.sub(r'^ArrayListAligned(Unmanaged)?\((.*),null\)$', r'ArrayList\1(\2)', type) - return '%s of length %s, capacity %s' % (type, self.val['items']['len'], self.val['capacity']) - - def children(self): - for i in range(self.val['items']['len']): - item = self.val['items']['ptr'] + i - yield ('[%d]' % i, item.dereference()) - - def display_hint(self): - return 'array' - -class MultiArrayListPrinter: - def __init__(self, val): - self.val = val - - def child_type(self): - (helper_fn, _) = gdb.lookup_symbol('%s.dbHelper' % self.val.type.name) - return helper_fn.type.fields()[1].type.target() - - def to_string(self): - type = self.val.type.name[len('std.multi_array_list.'):] - return '%s of length %s, capacity %s' % (type, self.val['len'], self.val['capacity']) - - def slice(self): - fields = self.child_type().fields() - base = self.val['bytes'] - cap = self.val['capacity'] - len = self.val['len'] - - if len == 0: - return - - fields = sorted(fields, key=lambda field: field.type.alignof, reverse=True) - - for field in fields: - ptr = base.cast(field.type.pointer()).dereference().cast(field.type.array(len - 1)) - base += field.type.sizeof * cap - yield (field.name, ptr) - - def children(self): - for i, (name, ptr) in enumerate(self.slice()): - yield ('[%d]' % i, name) - yield ('[%d]' % i, ptr) - - def display_hint(self): - return 'map' - -# Handles both HashMap and HashMapUnmanaged. -class HashMapPrinter: - def __init__(self, val): - self.type = val.type - is_managed = re.search(r'^std\.hash_map\.HashMap\(', self.type.name) - self.val = val['unmanaged'] if is_managed else val - - def header_ptr_type(self): - (helper_fn, _) = gdb.lookup_symbol('%s.dbHelper' % self.val.type.name) - return helper_fn.type.fields()[1].type - - def header(self): - if self.val['metadata'] == 0: - return None - return (self.val['metadata'].cast(self.header_ptr_type()) - 1).dereference() - - def to_string(self): - type = self.type.name[len('std.hash_map.'):] - type = re.sub(r'^HashMap(Unmanaged)?\((.*),std.hash_map.AutoContext\(.*$', r'AutoHashMap\1(\2)', type) - hdr = self.header() - if hdr is not None: - cap = hdr['capacity'] - else: - cap = 0 - return '%s of length %s, capacity %s' % (type, self.val['size'], cap) - - def children(self): - hdr = self.header() - if hdr is None: - return - is_map = self.display_hint() == 'map' - for i in range(hdr['capacity']): - metadata = self.val['metadata'] + i - if metadata.dereference()['used'] == 1: - yield ('[%d]' % i, (hdr['keys'] + i).dereference()) - if is_map: - yield ('[%d]' % i, (hdr['values'] + i).dereference()) - - def display_hint(self): - for field in self.header_ptr_type().target().fields(): - if field.name == 'values': - return 'map' - return 'array' - -# Handles both ArrayHashMap and ArrayHashMapUnmanaged. -class ArrayHashMapPrinter: - def __init__(self, val): - self.type = val.type - is_managed = re.search(r'^std\.array_hash_map\.ArrayHashMap\(', self.type.name) - self.val = val['unmanaged'] if is_managed else val - - def to_string(self): - type = self.type.name[len('std.array_hash_map.'):] - type = re.sub(r'^ArrayHashMap(Unmanaged)?\((.*),std.array_hash_map.AutoContext\(.*$', r'AutoArrayHashMap\1(\2)', type) - return '%s of length %s' % (type, self.val['entries']['len']) - - def children(self): - entries = MultiArrayListPrinter(self.val['entries']) - len = self.val['entries']['len'] - fields = {} - for name, ptr in entries.slice(): - fields[str(name)] = ptr - - for i in range(len): - if 'key' in fields: - yield ('[%d]' % i, fields['key'][i]) - else: - yield ('[%d]' % i, '{}') - if 'value' in fields: - yield ('[%d]' % i, fields['value'][i]) - - def display_hint(self): - for name, ptr in MultiArrayListPrinter(self.val['entries']).slice(): - if name == 'value': - return 'map' - return 'array' - -pp = gdb.printing.RegexpCollectionPrettyPrinter('Zig standard library') -pp.add_printer('ArrayList', r'^std\.array_list\.ArrayListAligned(Unmanaged)?\(.*\)$', ArrayListPrinter) -pp.add_printer('MultiArrayList', r'^std\.multi_array_list\.MultiArrayList\(.*\)$', MultiArrayListPrinter) -pp.add_printer('HashMap', r'^std\.hash_map\.HashMap(Unmanaged)?\(.*\)$', HashMapPrinter) -pp.add_printer('ArrayHashMap', r'^std\.array_hash_map\.ArrayHashMap(Unmanaged)?\(.*\)$', ArrayHashMapPrinter) -gdb.printing.register_pretty_printer(gdb.current_objfile(), pp) diff --git a/tools/zig_gdb_pretty_printers.py b/tools/zig_gdb_pretty_printers.py @@ -1,63 +0,0 @@ -# pretty printing for the language. -# put "source /path/to/zig_gdb_pretty_printers.py" in ~/.gdbinit to load it automatically. -import gdb.printing - - -class ZigPrettyPrinter(gdb.printing.PrettyPrinter): - def __init__(self): - super().__init__('Zig') - - def __call__(self, val): - tag = val.type.tag - if tag is None: - return None - if tag == '[]u8': - return StringPrinter(val) - if tag.startswith('[]'): - return SlicePrinter(val) - if tag.startswith('?'): - return OptionalPrinter(val) - return None - - -class SlicePrinter: - def __init__(self, val): - self.val = val - - def to_string(self): - return f"{self.val['len']} items at {self.val['ptr']}" - - def children(self): - def it(val): - for i in range(int(val['len'])): - item = val['ptr'] + i - yield (f'[{i}]', item.dereference()) - return it(self.val) - - def display_hint(self): - return 'array' - - -class StringPrinter: - def __init__(self, val): - self.val = val - - def to_string(self): - return self.val['ptr'].string(length=int(self.val['len'])) - - def display_hint(self): - return 'string' - - -class OptionalPrinter: - def __init__(self, val): - self.val = val - - def to_string(self): - if self.val['some']: - return self.val['data'] - else: - return 'null' - - -gdb.printing.register_pretty_printer(gdb.current_objfile(), ZigPrettyPrinter())