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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
|
# encoding: utf-8
"""
Test lldb's frame recognizers.
"""
import lldb
from lldbsuite.test.decorators import *
from lldbsuite.test.lldbtest import *
from lldbsuite.test import lldbutil
import recognizer
class FrameRecognizerTestCase(TestBase):
NO_DEBUG_INFO_TESTCASE = True
@skipUnlessDarwin
def test_frame_recognizer_1(self):
self.build()
exe = self.getBuildArtifact("a.out")
# Clear internal & plugins recognizers that get initialized at launch
self.runCmd("frame recognizer clear")
self.runCmd(
"command script import "
+ os.path.join(self.getSourceDir(), "recognizer.py")
)
self.expect("frame recognizer list", substrs=["no matching results found."])
self.runCmd(
"frame recognizer add -l recognizer.MyFrameRecognizer -s a.out -n foo"
)
self.expect(
"frame recognizer list",
substrs=["0: recognizer.MyFrameRecognizer, module a.out, symbol foo"],
)
self.runCmd(
"frame recognizer add -l recognizer.MyOtherFrameRecognizer -s a.out -n bar -x"
)
self.expect(
"frame recognizer list",
substrs=[
"1: recognizer.MyOtherFrameRecognizer, module a.out, symbol bar (regexp)",
"0: recognizer.MyFrameRecognizer, module a.out, symbol foo",
],
)
self.runCmd("frame recognizer delete 0")
# Test that it deleted the recognizer with id 0.
self.expect(
"frame recognizer list",
substrs=[
"1: recognizer.MyOtherFrameRecognizer, module a.out, symbol bar (regexp)"
],
)
self.expect(
"frame recognizer list", matching=False, substrs=["MyFrameRecognizer"]
)
# Test that an invalid index and deleting the same index again
# is an error and doesn't do any changes.
self.expect(
"frame recognizer delete 2",
error=True,
substrs=["error: '2' is not a valid recognizer id."],
)
self.expect(
"frame recognizer delete 0",
error=True,
substrs=["error: '0' is not a valid recognizer id."],
)
# Recognizers should have the same state as above.
self.expect(
"frame recognizer list",
substrs=[
"1: recognizer.MyOtherFrameRecognizer, module a.out, symbol bar (regexp)"
],
)
self.expect(
"frame recognizer list", matching=False, substrs=["MyFrameRecognizer"]
)
self.runCmd("frame recognizer clear")
self.expect("frame recognizer list", substrs=["no matching results found."])
self.runCmd(
"frame recognizer add -l recognizer.MyFrameRecognizer -s a.out -n foo"
)
target, process, thread, _ = lldbutil.run_to_name_breakpoint(
self, "foo", exe_name=exe
)
frame = thread.GetSelectedFrame()
self.expect("frame variable", substrs=["(int) a = 42", "(int) b = 56"])
# Recognized arguments don't show up by default...
variables = frame.GetVariables(lldb.SBVariablesOptions())
self.assertEqual(variables.GetSize(), 0)
# ...unless you set target.display-recognized-arguments to 1...
self.runCmd("settings set target.display-recognized-arguments 1")
variables = frame.GetVariables(lldb.SBVariablesOptions())
self.assertEqual(variables.GetSize(), 2)
# ...and you can reset it back to 0 to hide them again...
self.runCmd("settings set target.display-recognized-arguments 0")
variables = frame.GetVariables(lldb.SBVariablesOptions())
self.assertEqual(variables.GetSize(), 0)
# ... or explicitly ask for them with SetIncludeRecognizedArguments(True).
opts = lldb.SBVariablesOptions()
opts.SetIncludeRecognizedArguments(True)
variables = frame.GetVariables(opts)
self.assertEqual(variables.GetSize(), 2)
self.assertEqual(variables.GetValueAtIndex(0).name, "a")
self.assertEqual(variables.GetValueAtIndex(0).signed, 42)
self.assertEqual(
variables.GetValueAtIndex(0).GetValueType(), lldb.eValueTypeVariableArgument
)
self.assertEqual(variables.GetValueAtIndex(1).name, "b")
self.assertEqual(variables.GetValueAtIndex(1).signed, 56)
self.assertEqual(
variables.GetValueAtIndex(1).GetValueType(), lldb.eValueTypeVariableArgument
)
self.expect(
"frame recognizer info 0",
substrs=["frame 0 is recognized by recognizer.MyFrameRecognizer"],
)
self.expect(
"frame recognizer info 999", error=True, substrs=["no frame with index 999"]
)
self.expect(
"frame recognizer info 1",
substrs=["frame 1 not recognized by any recognizer"],
)
# FIXME: The following doesn't work yet, but should be fixed.
"""
target, process, thread, _ = lldbutil.run_to_name_breakpoint(self, "bar",
exe_name = exe)
frame = thread.GetSelectedFrame()
self.expect("thread list", STOPPED_DUE_TO_BREAKPOINT,
substrs=['stopped', 'stop reason = breakpoint'])
self.expect("frame variable -t",
substrs=['(int *) a = '])
self.expect("frame variable -t *a",
substrs=['*a = 78'])
"""
@skipUnlessDarwin
def test_frame_recognizer_multi_symbol(self):
self.build()
exe = self.getBuildArtifact("a.out")
# Clear internal & plugins recognizers that get initialized at launch
self.runCmd("frame recognizer clear")
self.runCmd(
"command script import "
+ os.path.join(self.getSourceDir(), "recognizer.py")
)
self.expect("frame recognizer list", substrs=["no matching results found."])
self.runCmd(
"frame recognizer add -l recognizer.MyFrameRecognizer -s a.out -n foo -n bar"
)
self.expect(
"frame recognizer list",
substrs=[
"recognizer.MyFrameRecognizer, module a.out, symbol foo, symbol bar"
],
)
target, process, thread, _ = lldbutil.run_to_name_breakpoint(
self, "foo", exe_name=exe
)
frame = thread.GetSelectedFrame()
self.expect(
"frame recognizer info 0",
substrs=["frame 0 is recognized by recognizer.MyFrameRecognizer"],
)
target, process, thread, _ = lldbutil.run_to_name_breakpoint(
self, "bar", exe_name=exe
)
frame = thread.GetSelectedFrame()
self.expect(
"frame recognizer info 0",
substrs=["frame 0 is recognized by recognizer.MyFrameRecognizer"],
)
@skipUnlessDarwin
def test_frame_recognizer_target_specific(self):
self.build()
exe = self.getBuildArtifact("a.out")
# Clear internal & plugins recognizers that get initialized at launch
self.runCmd("frame recognizer clear")
# Create a target.
target, process, thread, _ = lldbutil.run_to_name_breakpoint(
self, "foo", exe_name=exe
)
self.runCmd(
"command script import "
+ os.path.join(self.getSourceDir(), "recognizer.py")
)
# Check that this doesn't contain our own FrameRecognizer somehow.
self.expect(
"frame recognizer list", matching=False, substrs=["MyFrameRecognizer"]
)
# Add a frame recognizer in that target.
self.runCmd(
"frame recognizer add -l recognizer.MyFrameRecognizer -s a.out -n foo -n bar"
)
self.expect(
"frame recognizer list",
substrs=[
"recognizer.MyFrameRecognizer, module a.out, symbol foo, symbol bar"
],
)
self.expect(
"frame recognizer info 0",
substrs=["frame 0 is recognized by recognizer.MyFrameRecognizer"],
)
# Create a second target. That one shouldn't have the frame recognizer.
target, process, thread, _ = lldbutil.run_to_name_breakpoint(
self, "bar", exe_name=exe
)
self.expect(
"frame recognizer info 0",
substrs=["frame 0 not recognized by any recognizer"],
)
# Add a frame recognizer to the new target.
self.runCmd(
"frame recognizer add -l recognizer.MyFrameRecognizer -s a.out -n bar"
)
self.expect(
"frame recognizer list",
substrs=["recognizer.MyFrameRecognizer, module a.out, symbol bar"],
)
# Now the new target should also recognize the frame.
self.expect(
"frame recognizer info 0",
substrs=["frame 0 is recognized by recognizer.MyFrameRecognizer"],
)
@skipUnlessDarwin
def test_frame_recognizer_not_only_first_instruction(self):
self.build()
exe = self.getBuildArtifact("a.out")
# Clear internal & plugins recognizers that get initialized at launch.
self.runCmd("frame recognizer clear")
self.runCmd(
"command script import "
+ os.path.join(self.getSourceDir(), "recognizer.py")
)
self.expect("frame recognizer list", substrs=["no matching results found."])
# Create a target.
target, process, thread, _ = lldbutil.run_to_name_breakpoint(
self, "foo", exe_name=exe
)
# Move the PC one instruction further.
self.runCmd("next")
# Add a frame recognizer in that target.
self.runCmd(
"frame recognizer add -l recognizer.MyFrameRecognizer -s a.out -n foo -n bar"
)
# It's not applied to foo(), because frame's PC is not at the first instruction of the function.
self.expect(
"frame recognizer info 0",
substrs=["frame 0 not recognized by any recognizer"],
)
# Add a frame recognizer with --first-instruction-only=true.
self.runCmd("frame recognizer clear")
self.runCmd(
"frame recognizer add -l recognizer.MyFrameRecognizer -s a.out -n foo -n bar --first-instruction-only=true"
)
# It's not applied to foo(), because frame's PC is not at the first instruction of the function.
self.expect(
"frame recognizer info 0",
substrs=["frame 0 not recognized by any recognizer"],
)
# Now add a frame recognizer with --first-instruction-only=false.
self.runCmd("frame recognizer clear")
self.runCmd(
"frame recognizer add -l recognizer.MyFrameRecognizer -s a.out -n foo -n bar --first-instruction-only=false"
)
# This time it should recognize the frame.
self.expect(
"frame recognizer info 0",
substrs=["frame 0 is recognized by recognizer.MyFrameRecognizer"],
)
opts = lldb.SBVariablesOptions()
opts.SetIncludeRecognizedArguments(True)
frame = thread.GetSelectedFrame()
variables = frame.GetVariables(opts)
self.assertEqual(variables.GetSize(), 2)
self.assertEqual(variables.GetValueAtIndex(0).name, "a")
self.assertEqual(variables.GetValueAtIndex(0).signed, 42)
self.assertEqual(
variables.GetValueAtIndex(0).GetValueType(), lldb.eValueTypeVariableArgument
)
self.assertEqual(variables.GetValueAtIndex(1).name, "b")
self.assertEqual(variables.GetValueAtIndex(1).signed, 56)
self.assertEqual(
variables.GetValueAtIndex(1).GetValueType(), lldb.eValueTypeVariableArgument
)
@no_debug_info_test
def test_frame_recognizer_delete_invalid_arg(self):
self.expect(
"frame recognizer delete a",
error=True,
substrs=["error: 'a' is not a valid recognizer id."],
)
self.expect(
'frame recognizer delete ""',
error=True,
substrs=["error: '' is not a valid recognizer id."],
)
self.expect(
"frame recognizer delete -1",
error=True,
substrs=["error: '-1' is not a valid recognizer id."],
)
self.expect(
"frame recognizer delete 4294967297",
error=True,
substrs=["error: '4294967297' is not a valid recognizer id."],
)
@no_debug_info_test
def test_frame_recognizer_info_invalid_arg(self):
self.expect(
"frame recognizer info a",
error=True,
substrs=["error: 'a' is not a valid frame index."],
)
self.expect(
'frame recognizer info ""',
error=True,
substrs=["error: '' is not a valid frame index."],
)
self.expect(
"frame recognizer info -1",
error=True,
substrs=["error: '-1' is not a valid frame index."],
)
self.expect(
"frame recognizer info 4294967297",
error=True,
substrs=["error: '4294967297' is not a valid frame index."],
)
@no_debug_info_test
def test_frame_recognizer_add_invalid_arg(self):
self.expect(
"frame recognizer add -f",
error=True,
substrs=["error: last option requires an argument"],
)
self.expect(
"frame recognizer add -f -1",
error=True,
substrs=["error: invalid boolean value '-1' passed for -f option"],
)
self.expect(
"frame recognizer add -f foo",
error=True,
substrs=["error: invalid boolean value 'foo' passed for -f option"],
)
|
