1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
"""
This python script provides LLDB formatters for Slang IR types.
To use it, see the `docs/debugging.md` file in this repo.
"""
import json
import lldb
class Children:
indices: dict[str, int]
values: list[lldb.SBValue]
def __init__(self):
self.indices = {}
self.values = []
def append(self, value: lldb.SBValue) -> None:
self.indices[value.name] = len(self.values)
self.values.append(value)
def __len__(self) -> int:
return len(self.values)
def get_index(self, name: str) -> int:
return self.indices[name]
def get_at_index(self, idx: int) -> lldb.SBValue:
return self.values[idx]
def IRUse_summary(valobj: lldb.SBValue, dict) -> str:
val = valobj.GetNonSyntheticValue()
return val.GetChildMemberWithName("usedValue").deref.summary
class IRInstListBase_synthetic(lldb.SBSyntheticValueProvider):
def __init__(self, valobj: lldb.SBValue, dict):
self.valobj = valobj
def num_children(self):
return len(self.children)
def get_child_index(self, name):
return self.children.get_index(name)
def get_child_at_index(self, idx):
return self.children.get_at_index(idx)
def update(self):
self.children = Children()
pointer = self.valobj.GetChildMemberWithName("first")
i = 0
while pointer.unsigned != 0:
child = pointer.deref
self.children.append(child.Clone(f"[{i}]"))
pointer = child.GetNonSyntheticValue().GetChildMemberWithName("next")
i += 1
if i >= 5000:
# The debugger can call this function on uninitialized
# values, so we need to ensure that we stop iterating at
# some point. Ideally we'd provide a synthetic child
# called something like `[more]` to see another batch of
# many children in the case where there really is just a
# very large list, but this is good enough because one
# can always manually follow `next` pointers.
break
def has_children(self):
return True
class IRInst_synthetic(lldb.SBSyntheticValueProvider):
def __init__(self, valobj: lldb.SBValue, dict):
self.valobj = valobj
def num_children(self):
return len(self.children)
def get_child_index(self, name):
return self.children.get_index(name)
def get_child_at_index(self, idx):
return self.children.get_at_index(idx)
def update(self):
self.children = Children()
if self.valobj.type.IsPointerType():
if self.valobj.unsigned != 0:
valobj = self.valobj.deref
for i in range(valobj.GetNumChildren()):
self.children.append(valobj.GetChildAtIndex(i))
return
target = self.valobj.target
ty = self.valobj.type
op = self.valobj.GetChildMemberWithName("m_op")
# literal values
value: list[tuple[str, lldb.SBValue]] = []
# Using `Cast` here seems to work just fine in the LLDB CLI with
# `v`, as well as in CodeLLDB, but for some reason it does not
# work correctly with `p`, causing the `[value]` child to be
# missing in that case. It is possible to fix that by using
# `EvaluateExpression` instead, but that significantly degrades
# performance, so we choose not to do it here.
if op.value == "kIROp_StringLit":
string_lit_t = target.FindFirstType("Slang::IRStringLit")
string_lit = self.valobj.Cast(string_lit_t)
val = string_lit.GetChildMemberWithName("value")
value = [("[value]", val.GetChildMemberWithName("stringVal"))]
elif op.value == "kIROp_IntLit":
int_lit_t = target.FindFirstType("Slang::IRIntLit")
int_lit = self.valobj.Cast(int_lit_t)
val = int_lit.GetChildMemberWithName("value")
value = [("[value]", val.GetChildMemberWithName("intVal"))]
# operands
operands: list[tuple[str, lldb.SBValue]] = []
offset = ty.GetByteSize()
ir_use_t = target.FindFirstType("Slang::IRUse")
ir_use_size = ir_use_t.GetByteSize()
operand_count = self.valobj.GetChildMemberWithName("operandCount").unsigned
# We must ensure that we don't loop for an unbounded amount of
# time, so we cap the number of operands displayed here. Ideally
# we'd provide a way to view more in the case of instructions
# with more than this many operands, though.
for index in range(min(operand_count, 10)):
name = f"[operand{index}]"
operand = self.valobj.CreateChildAtOffset(
name, offset + index * ir_use_size, ir_use_t
)
operands.append((name, operand))
for name, child in [
("[op]", op),
("[UID]", self.valobj.GetChildMemberWithName("_debugUID")),
(
"[type]",
self.valobj.GetChildMemberWithName("typeUse").GetChildMemberWithName(
"usedValue"
),
),
# TODO: [exportName]
# TODO: [importName]
# TODO: [name]
*value,
*operands,
(
"[decorations/children]",
self.valobj.GetChildMemberWithName("m_decorationsAndChildren"),
),
("[parent]", self.valobj.GetChildMemberWithName("parent")),
# TODO: Traverse the linked list to show all uses next to
# each other, rather than pointing to the first one.
("[uses]", self.valobj.GetChildMemberWithName("firstUse")),
]:
self.children.append(child.Clone(name))
def has_children(self):
return True
def IRInst_summary(valobj: lldb.SBValue, dict) -> str:
if valobj.type.IsPointerType():
return "nullptr" if valobj.unsigned == 0 else valobj.deref.summary
val = valobj.GetNonSyntheticValue()
op = val.GetChildMemberWithName("m_op")
return f"{{{op.value} {val.address_of.value}}}"
def stringval_summary(valobj: lldb.SBValue) -> str:
val = valobj.GetNonSyntheticValue()
num_chars = val.GetChildMemberWithName("numChars").unsigned
chars = val.GetChildMemberWithName("chars").GetPointeeData(0, num_chars).uint8
return json.dumps("".join(chr(chars[i]) for i in range(num_chars)))
def StringValue_summary(valobj: lldb.SBValue, dict) -> str:
return stringval_summary(valobj)
def StringSliceValue_summary(valobj: lldb.SBValue, dict) -> str:
return stringval_summary(valobj)
def __lldb_init_module(debugger: lldb.SBDebugger, internal_dict):
commands = [
# Slang::IRUse
"type summary add Slang::IRUse -F slang_lldb.IRUse_summary -w slang",
# Slang::IRInstListBase
"type synthetic add Slang::IRInstListBase -l slang_lldb.IRInstListBase_synthetic -w slang",
# Slang::IRInst
"type synthetic add Slang::IRInst -l slang_lldb.IRInst_synthetic -w slang",
"type summary add --expand Slang::IRInst -F slang_lldb.IRInst_summary -w slang",
# Slang::IRConstant::StringValue
"type summary add Slang::IRConstant::StringValue -F slang_lldb.StringValue_summary -w slang",
# Slang::IRConstant::StringSliceValue
"type summary add Slang::IRConstant::StringSliceValue -F slang_lldb.StringSliceValue_summary -w slang",
# Enable slang category
"type category enable slang",
]
for c in commands:
debugger.HandleCommand(c)
|
