authorgravatar for andrew@ziglang.orgAndrew Kelley <andrew@ziglang.org> 2022-03-16 14:08:06-04:00
committergravatar for noreply@github.comGitHub <noreply@github.com> 2022-03-16 14:08:06-04:00
logd4a7a9ac4cf64ef6bf0b1aed16282c3d8b47b431
treef0d318ae9cf8ec6ca029aa9ecf4aa3d01dcf025c
parent8a43d67c3bf878fa32ef4876897a32969a4b5d24
parent4ff7553d6b918e4eef643d10bd8f41492355f39c
signaturebadge-question-mark Signed by PGP key 4AEE18F83AFDEB23

Merge pull request #11191 from Snektron/zig-gdb-improvements

Zig gdb improvements

9 files changed, 400 insertions(+), 41 deletions(-)

lib/std/hash_map.zig+14
...@@ -1,4 +1,5 @@...@@ -1,4 +1,5 @@
1const std = @import("std.zig");1const std = @import("std.zig");
2const builtin = @import("builtin");
2const assert = debug.assert;3const assert = debug.assert;
3const autoHash = std.hash.autoHash;4const autoHash = std.hash.autoHash;
4const debug = std.debug;5const debug = std.debug;
...@@ -1576,6 +1577,19 @@ pub fn HashMapUnmanaged(...@@ -1576,6 +1577,19 @@ pub fn HashMapUnmanaged(
1576 self.metadata = null;1577 self.metadata = null;
1577 self.available = 0;1578 self.available = 0;
1578 }1579 }
1580
1581 /// This function is used in tools/zig-gdb.py to fetch the header type to facilitate
1582 /// fancy debug printing for this type.
1583 fn gdbHelper(self: *Self, hdr: *Header) void {
1584 _ = self;
1585 _ = hdr;
1586 }
1587
1588 comptime {
1589 if (builtin.mode == .Debug) {
1590 _ = gdbHelper;
1591 }
1592 }
1579 };1593 };
1580}1594}
15811595
lib/std/multi_array_list.zig+14
...@@ -1,4 +1,5 @@...@@ -1,4 +1,5 @@
1const std = @import("std.zig");1const std = @import("std.zig");
2const builtin = @import("builtin");
2const assert = std.debug.assert;3const assert = std.debug.assert;
3const meta = std.meta;4const meta = std.meta;
4const mem = std.mem;5const mem = std.mem;
...@@ -433,6 +434,19 @@ pub fn MultiArrayList(comptime S: type) type {...@@ -433,6 +434,19 @@ pub fn MultiArrayList(comptime S: type) type {
433 fn FieldType(field: Field) type {434 fn FieldType(field: Field) type {
434 return meta.fieldInfo(S, field).field_type;435 return meta.fieldInfo(S, field).field_type;
435 }436 }
437
438 /// This function is used in tools/zig-gdb.py to fetch the child type to facilitate
439 /// fancy debug printing for this type.
440 fn gdbHelper(self: *Self, child: *S) void {
441 _ = self;
442 _ = child;
443 }
444
445 comptime {
446 if (builtin.mode == .Debug) {
447 _ = gdbHelper;
448 }
449 }
436 };450 };
437}451}
438452
src/type.zig+1
...@@ -5093,6 +5093,7 @@ pub const Type = extern union {...@@ -5093,6 +5093,7 @@ pub const Type = extern union {
5093 pub const no_payload_count = @enumToInt(last_no_payload_tag) + 1;5093 pub const no_payload_count = @enumToInt(last_no_payload_tag) + 1;
50945094
5095 pub fn Type(comptime t: Tag) type {5095 pub fn Type(comptime t: Tag) type {
5096 // Keep in sync with tools/zig-gdb.py
5096 return switch (t) {5097 return switch (t) {
5097 .u1,5098 .u1,
5098 .u8,5099 .u8,
src/value.zig+1
...@@ -20,6 +20,7 @@ pub const Value = extern union {...@@ -20,6 +20,7 @@ pub const Value = extern union {
20 tag_if_small_enough: Tag,20 tag_if_small_enough: Tag,
21 ptr_otherwise: *Payload,21 ptr_otherwise: *Payload,
2222
23 // Keep in sync with tools/zig-gdb.py
23 pub const Tag = enum(usize) {24 pub const Tag = enum(usize) {
24 // The first section of this enum are tags that require no payload.25 // The first section of this enum are tags that require no payload.
25 u1_type,26 u1_type,
tools/stage1_gdb_pretty_printers.py created+37
...@@ -0,0 +1,37 @@
1# pretty printing for stage1.
2# put "source /path/to/stage1_gdb_pretty_printers.py" in ~/.gdbinit to load it automatically.
3import gdb.printing
4
5class ZigListPrinter:
6 def __init__(self, val):
7 self.val = val
8
9 def to_string(self):
10 return '%s of length %d, capacity %d' % (self.val.type.name, int(self.val['length']), int(self.val['capacity']))
11
12 def children(self):
13 def it(ziglist):
14 for i in range(int(ziglist.val['length'])):
15 item = ziglist.val['items'] + i
16 yield ('[%d]' % i, item.dereference())
17 return it(self)
18
19 def display_hint(self):
20 return 'array'
21
22# handle both Buf and ZigList<char> because Buf* doesn't work otherwise (gdb bug?)
23class BufPrinter:
24 def __init__(self, val):
25 self.val = val['list'] if val.type.name == 'Buf' else val
26
27 def to_string(self):
28 return self.val['items'].string(length=int(self.val['length']))
29
30 def display_hint(self):
31 return 'string'
32
33pp = gdb.printing.RegexpCollectionPrettyPrinter('Zig stage1 compiler')
34pp.add_printer('Buf', '^Buf$', BufPrinter)
35pp.add_printer('ZigList<char>', '^ZigList<char>$', BufPrinter)
36pp.add_printer('ZigList', '^ZigList<.*>$', ZigListPrinter)
37gdb.printing.register_pretty_printer(gdb.current_objfile(), pp)
tools/stage2_gdb_pretty_printers.py created+189
...@@ -0,0 +1,189 @@
1# pretty printing for stage 2.
2# put "source /path/to/stage2_gdb_pretty_printers.py" in ~/.gdbinit to load it automatically.
3import re
4import gdb.printing
5
6class TypePrinter:
7 no_payload_count = 4096
8
9 # Keep in sync with src/type.zig
10 # Types which have no payload do not need to be entered here.
11 payload_type_names = {
12 'array_u8': 'type.Len',
13 'array_u8_sentinel_0': 'Len',
14
15 'single_const_pointer': 'ElemType',
16 'single_mut_pointer': 'ElemType',
17 'many_const_pointer': 'ElemType',
18 'many_mut_pointer': 'ElemType',
19 'c_const_pointer': 'ElemType',
20 'c_mut_pointer': 'ElemType',
21 'const_slice': 'ElemType',
22 'mut_slice': 'ElemType',
23 'optional': 'ElemType',
24 'optional_single_mut_pointer': 'ElemType',
25 'optional_single_const_pointer': 'ElemType',
26 'anyframe_T': 'ElemType',
27
28 'int_signed': 'Bits',
29 'int_unsigned': 'Bits',
30
31 'error_set': 'ErrorSet',
32 'error_set_inferred': 'ErrorSetInferred',
33 'error_set_merged': 'ErrorSetMerged',
34
35 'array': 'Array',
36 'vector': 'Array',
37
38 'array_sentinel': 'ArraySentinel',
39 'pointer': 'Pointer',
40 'function': 'Function',
41 'error_union': 'ErrorUnion',
42 'error_set_single': 'Name',
43 'opaque': 'Opaque',
44 'struct': 'Struct',
45 'union': 'Union',
46 'union_tagged': 'Union',
47 'enum_full, .enum_nonexhaustive': 'EnumFull',
48 'enum_simple': 'EnumSimple',
49 'enum_numbered': 'EnumNumbered',
50 'empty_struct': 'ContainerScope',
51 'tuple': 'Tuple',
52 'anon_struct': 'AnonStruct',
53 }
54
55 def __init__(self, val):
56 self.val = val
57
58 def tag(self):
59 tag_if_small_enough = self.val['tag_if_small_enough']
60 tag_type = tag_if_small_enough.type
61
62 if tag_if_small_enough < TypePrinter.no_payload_count:
63 return tag_if_small_enough
64 else:
65 return self.val['ptr_otherwise'].dereference()['tag']
66
67 def payload_type(self):
68 tag = self.tag()
69 if tag is None:
70 return None
71
72 type_name = TypePrinter.payload_type_names.get(str(tag))
73 if type_name is None:
74 return None
75 return gdb.lookup_type('struct type.%s' % type_name)
76
77 def to_string(self):
78 tag = self.tag()
79 if tag is None:
80 return '(invalid type)'
81 if self.val['tag_if_small_enough'] < TypePrinter.no_payload_count:
82 return '.%s' % str(tag)
83 return None
84
85 def children(self):
86 if self.val['tag_if_small_enough'] < TypePrinter.no_payload_count:
87 return
88
89 yield ('tag', '.%s' % str(self.tag()))
90
91 payload_type = self.payload_type()
92 if payload_type is not None:
93 yield ('payload', self.val['ptr_otherwise'].cast(payload_type.pointer()).dereference()['data'])
94
95class ValuePrinter:
96 no_payload_count = 4096
97
98 # Keep in sync with src/value.zig
99 # Values which have no payload do not need to be entered here.
100 payload_type_names = {
101 'big_int_positive': 'BigInt',
102 'big_int_negative': 'BigInt',
103
104 'extern_fn': 'ExternFn',
105
106 'decl_ref': 'Decl',
107
108 'repeated': 'SubValue',
109 'eu_payload': 'SubValue',
110 'opt_payload': 'SubValue',
111 'empty_array_sentinel': 'SubValue',
112
113 'eu_payload_ptr': 'PayloadPtr',
114 'opt_payload_ptr': 'PayloadPtr',
115
116 'bytes': 'Bytes',
117 'enum_literal': 'Bytes',
118
119 'slice': 'Slice',
120
121 'enum_field_index': 'U32',
122
123 'ty': 'Ty',
124 'int_type': 'IntType',
125 'int_u64': 'U64',
126 'int_i64': 'I64',
127 'function': 'Function',
128 'variable': 'Variable',
129 'decl_ref_mut': 'DeclRefMut',
130 'elem_ptr': 'ElemPtr',
131 'field_ptr': 'FieldPtr',
132 'float_16': 'Float_16',
133 'float_32': 'Float_32',
134 'float_64': 'Float_64',
135 'float_80': 'Float_80',
136 'float_128': 'Float_128',
137 'error': 'Error',
138 'inferred_alloc': 'InferredAlloc',
139 'inferred_alloc_comptime': 'InferredAllocComptime',
140 'aggregate': 'Aggregate',
141 'union': 'Union',
142 'bound_fn': 'BoundFn',
143 }
144
145 def __init__(self, val):
146 self.val = val
147
148 def tag(self):
149 tag_if_small_enough = self.val['tag_if_small_enough']
150 tag_type = tag_if_small_enough.type
151
152 if tag_if_small_enough < ValuePrinter.no_payload_count:
153 return tag_if_small_enough
154 else:
155 return self.val['ptr_otherwise'].dereference()['tag']
156
157 def payload_type(self):
158 tag = self.tag()
159 if tag is None:
160 return None
161
162 type_name = ValuePrinter.payload_type_names.get(str(tag))
163 if type_name is None:
164 return None
165 return gdb.lookup_type('struct value.%s' % type_name)
166
167 def to_string(self):
168 tag = self.tag()
169 if tag is None:
170 return '(invalid value)'
171 if self.val['tag_if_small_enough'] < ValuePrinter.no_payload_count:
172 return '.%s' % str(tag)
173 return None
174
175 def children(self):
176 if self.val['tag_if_small_enough'] < ValuePrinter.no_payload_count:
177 return
178
179 yield ('tag', '.%s' % str(self.tag()))
180
181 payload_type = self.payload_type()
182 if payload_type is not None:
183 yield ('payload', self.val['ptr_otherwise'].cast(payload_type.pointer()).dereference()['data'])
184
185pp = gdb.printing.RegexpCollectionPrettyPrinter('Zig stage2 compiler')
186pp.add_printer('Type', r'^type\.Type$', TypePrinter)
187pp.add_printer('Value', r'^value\.Value$', ValuePrinter)
188gdb.printing.register_pretty_printer(gdb.current_objfile(), pp)
189
tools/std_gdb_pretty_printers.py created+142
...@@ -0,0 +1,142 @@
1# pretty printing for the standard library.
2# put "source /path/to/stage2_gdb_pretty_printers.py" in ~/.gdbinit to load it automatically.
3import re
4import gdb.printing
5
6# Handles both ArrayList and ArrayListUnmanaged.
7class ArrayListPrinter:
8 def __init__(self, val):
9 self.val = val
10
11 def to_string(self):
12 type = self.val.type.name[len('std.array_list.'):]
13 type = re.sub(r'^ArrayListAligned(Unmanaged)?\((.*),null\)$', r'ArrayList\1(\2)', type)
14 return '%s of length %s, capacity %s' % (type, self.val['items']['len'], self.val['capacity'])
15
16 def children(self):
17 for i in range(self.val['items']['len']):
18 item = self.val['items']['ptr'] + i
19 yield ('[%d]' % i, item.dereference())
20
21 def display_hint(self):
22 return 'array'
23
24class MultiArrayListPrinter:
25 def __init__(self, val):
26 self.val = val
27
28 def child_type(self):
29 (helper_fn, _) = gdb.lookup_symbol('%s.gdbHelper' % self.val.type.name)
30 return helper_fn.type.fields()[1].type.target()
31
32 def to_string(self):
33 type = self.val.type.name[len('std.multi_array_list.'):]
34 return '%s of length %s, capacity %s' % (type, self.val['len'], self.val['capacity'])
35
36 def slice(self):
37 fields = self.child_type().fields()
38 base = self.val['bytes']
39 cap = self.val['capacity']
40 len = self.val['len']
41
42 if len == 0:
43 return
44
45 fields = sorted(fields, key=lambda field: field.type.alignof, reverse=True)
46
47 for field in fields:
48 ptr = base.cast(field.type.pointer()).dereference().cast(field.type.array(len - 1))
49 base += field.type.sizeof * cap
50 yield (field.name, ptr)
51
52 def children(self):
53 for i, (name, ptr) in enumerate(self.slice()):
54 yield ('[%d]' % i, name)
55 yield ('[%d]' % i, ptr)
56
57 def display_hint(self):
58 return 'map'
59
60# Handles both HashMap and HashMapUnmanaged.
61class HashMapPrinter:
62 def __init__(self, val):
63 self.type = val.type
64 is_managed = re.search(r'^std\.hash_map\.HashMap\(', self.type.name)
65 self.val = val['unmanaged'] if is_managed else val
66
67 def header_ptr_type(self):
68 (helper_fn, _) = gdb.lookup_symbol('%s.gdbHelper' % self.val.type.name)
69 return helper_fn.type.fields()[1].type
70
71 def header(self):
72 if self.val['metadata'] == 0:
73 return None
74 return (self.val['metadata'].cast(self.header_ptr_type()) - 1).dereference()
75
76 def to_string(self):
77 type = self.type.name[len('std.hash_map.'):]
78 type = re.sub(r'^HashMap(Unmanaged)?\((.*),std.hash_map.AutoContext\(.*$', r'AutoHashMap\1(\2)', type)
79 hdr = self.header()
80 if hdr is not None:
81 cap = hdr['capacity']
82 else:
83 cap = 0
84 return '%s of length %s, capacity %s' % (type, self.val['size'], cap)
85
86 def children(self):
87 hdr = self.header()
88 if hdr is None:
89 return
90 is_map = self.display_hint() == 'map'
91 for i in range(hdr['capacity']):
92 metadata = self.val['metadata'] + i
93 if metadata.dereference()['used'] == 1:
94 yield ('[%d]' % i, (hdr['keys'] + i).dereference())
95 if is_map:
96 yield ('[%d]' % i, (hdr['values'] + i).dereference())
97
98 def display_hint(self):
99 for field in self.header_ptr_type().target().fields():
100 if field.name == 'values':
101 return 'map'
102 return 'array'
103
104# Handles both ArrayHashMap and ArrayHashMapUnmanaged.
105class ArrayHashMapPrinter:
106 def __init__(self, val):
107 self.type = val.type
108 is_managed = re.search(r'^std\.array_hash_map\.ArrayHashMap\(', self.type.name)
109 self.val = val['unmanaged'] if is_managed else val
110
111 def to_string(self):
112 type = self.type.name[len('std.array_hash_map.'):]
113 type = re.sub(r'^ArrayHashMap(Unmanaged)?\((.*),std.array_hash_map.AutoContext\(.*$', r'AutoArrayHashMap\1(\2)', type)
114 return '%s of length %s' % (type, self.val['entries']['len'])
115
116 def children(self):
117 entries = MultiArrayListPrinter(self.val['entries'])
118 len = self.val['entries']['len']
119 fields = {}
120 for name, ptr in entries.slice():
121 fields[str(name)] = ptr
122
123 for i in range(len):
124 if 'key' in fields:
125 yield ('[%d]' % i, fields['key'][i])
126 else:
127 yield ('[%d]' % i, '{}')
128 if 'value' in fields:
129 yield ('[%d]' % i, fields['value'][i])
130
131 def display_hint(self):
132 for name, ptr in MultiArrayListPrinter(self.val['entries']).slice():
133 if name == 'value':
134 return 'map'
135 return 'array'
136
137pp = gdb.printing.RegexpCollectionPrettyPrinter('Zig standard library')
138pp.add_printer('ArrayList', r'^std\.array_list\.ArrayListAligned(Unmanaged)?\(.*\)$', ArrayListPrinter)
139pp.add_printer('MultiArrayList', r'^std\.multi_array_list\.MultiArrayList\(.*\)$', MultiArrayListPrinter)
140pp.add_printer('HashMap', r'^std\.hash_map\.HashMap(Unmanaged)?\(.*\)$', HashMapPrinter)
141pp.add_printer('ArrayHashMap', r'^std\.array_hash_map\.ArrayHashMap(Unmanaged)?\(.*\)$', ArrayHashMapPrinter)
142gdb.printing.register_pretty_printer(gdb.current_objfile(), pp)
tools/zig-gdb.py deleted-39
...@@ -1,39 +0,0 @@
1# pretty printing for stage1
2# put "source /path/to/zig-gdb.py" in ~/.gdbinit to load it automatically
3
4import gdb.printing
5
6class ZigListPrinter:
7 def __init__(self, val):
8 self.val = val
9
10 def to_string(self):
11 return '%s of length %d, capacity %d' % (self.val.type.name, int(self.val['length']), int(self.val['capacity']))
12
13 def children(self):
14 def it(ziglist):
15 for i in range(int(ziglist.val['length'])):
16 item = ziglist.val['items'] + i
17 yield ('[%d]' % i, item.dereference())
18 return it(self)
19
20 def display_hint(self):
21 return 'array'
22
23# handle both Buf and ZigList<char> because Buf* doesn't work otherwise (gdb bug?)
24class BufPrinter:
25 def __init__(self, val):
26 self.val = val['list'] if val.type.name == 'Buf' else val
27
28 def to_string(self):
29 return self.val['items'].string(length=int(self.val['length']))
30
31 def display_hint(self):
32 return 'string'
33
34pp = gdb.printing.RegexpCollectionPrettyPrinter('Zig stage1 compiler')
35pp.add_printer('Buf', '^Buf$', BufPrinter)
36pp.add_printer('ZigList<char>', '^ZigList<char>$', BufPrinter)
37pp.add_printer('ZigList', '^ZigList<.*>$', ZigListPrinter)
38
39gdb.printing.register_pretty_printer(gdb.current_objfile(), pp)
tools/zig_gdb_pretty_printers.py+2-2
...@@ -1,5 +1,5 @@...@@ -1,5 +1,5 @@
1# gdb pretty printers for Zig language constructs1# pretty printing for the language.
22# put "source /path/to/zig_gdb_pretty_printers.py" in ~/.gdbinit to load it automatically.
3import gdb.printing3import gdb.printing
44
5class ZigPrettyPrinter(gdb.printing.PrettyPrinter):5class ZigPrettyPrinter(gdb.printing.PrettyPrinter):