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
|
"""
Test dwim-print with variables, variable paths, and expressions.
"""
import re
import lldb
from lldbsuite.test.lldbtest import *
from lldbsuite.test.decorators import *
import lldbsuite.test.lldbutil as lldbutil
class TestCase(TestBase):
def _run_cmd(self, cmd: str) -> str:
"""Run the given lldb command and return its output."""
result = lldb.SBCommandReturnObject()
self.ci.HandleCommand(cmd, result)
return result.GetOutput().rstrip()
VAR_IDENT = re.compile(r"(?:\$\d+|\w+) = ")
def _strip_result_var(self, string: str) -> str:
"""
Strip (persistent) result variables (ex '$0 = ', or 'someVar = ', etc).
This allows for using the output of `expression`/`frame variable`, to
compare it to `dwim-print` output, which disables result variables.
"""
return self.VAR_IDENT.subn("", string, 1)[0]
def _expect_cmd(
self,
dwim_cmd: str,
actual_cmd: str,
) -> None:
"""Run dwim-print and verify the output against the expected command."""
# Resolve the dwim-print command to either `expression` or `frame variable`.
substitute_cmd = dwim_cmd.replace("dwim-print", actual_cmd, 1)
interp = self.dbg.GetCommandInterpreter()
result = lldb.SBCommandReturnObject()
interp.ResolveCommand(substitute_cmd, result)
self.assertTrue(result.Succeeded(), result.GetError())
resolved_cmd = result.GetOutput()
if actual_cmd == "frame variable":
resolved_cmd = resolved_cmd.replace(" -- ", " ", 1)
resolved_cmd_output = self._run_cmd(resolved_cmd)
dwim_cmd_output = self._strip_result_var(resolved_cmd_output)
# Verify dwim-print chose the expected command.
self.runCmd("settings set dwim-print-verbosity full")
self.expect(
dwim_cmd,
substrs=[
f"note: ran `{resolved_cmd}`",
dwim_cmd_output,
],
)
def test_variables(self):
"""Test dwim-print with variables."""
self.build()
lldbutil.run_to_name_breakpoint(self, "main")
vars = ("argc", "argv")
for var in vars:
self._expect_cmd(f"dwim-print {var}", "frame variable")
def test_variable_paths(self):
"""Test dwim-print with variable path expressions."""
self.build()
lldbutil.run_to_name_breakpoint(self, "main")
exprs = ("&argc", "*argv", "argv[0]")
for expr in exprs:
self._expect_cmd(f"dwim-print {expr}", "expression")
def test_expressions(self):
"""Test dwim-print with expressions."""
self.build()
lldbutil.run_to_name_breakpoint(self, "main")
exprs = ("argc + 1", "(void)argc", "(int)abs(argc)")
for expr in exprs:
self._expect_cmd(f"dwim-print {expr}", "expression")
def test_dummy_target_expressions(self):
"""Test dwim-print's ability to evaluate expressions without a target."""
self._expect_cmd("dwim-print 1 + 2", "expression")
def test_gdb_format(self):
self.build()
lldbutil.run_to_name_breakpoint(self, "main")
self._expect_cmd(f"dwim-print/x argc", "frame variable")
self._expect_cmd(f"dwim-print/x argc + 1", "expression")
def test_format_flags(self):
self.build()
lldbutil.run_to_name_breakpoint(self, "main")
self._expect_cmd(f"dwim-print -fx -- argc", "frame variable")
self._expect_cmd(f"dwim-print -fx -- argc + 1", "expression")
def test_display_flags(self):
self.build()
lldbutil.run_to_name_breakpoint(self, "main")
self._expect_cmd(f"dwim-print -T -- argc", "frame variable")
self._expect_cmd(f"dwim-print -T -- argc + 1", "expression")
def test_expression_language(self):
"""Test that the language flag doesn't affect the choice of command."""
self.build()
lldbutil.run_to_name_breakpoint(self, "main")
self._expect_cmd(f"dwim-print -l c++ -- argc", "frame variable")
self._expect_cmd(f"dwim-print -l c++ -- argc + 1", "expression")
def test_empty_expression(self):
self.build()
lldbutil.run_to_name_breakpoint(self, "main")
error_msg = "error: 'dwim-print' takes a variable or expression"
self.expect(f"dwim-print", error=True, startstr=error_msg)
self.expect(f"dwim-print -- ", error=True, startstr=error_msg)
def test_nested_values(self):
"""Test dwim-print with nested values (structs, etc)."""
self.build()
lldbutil.run_to_source_breakpoint(
self, "break here", lldb.SBFileSpec("main.c")
)
self.runCmd("settings set auto-one-line-summaries false")
self._expect_cmd(f"dwim-print s", "frame variable")
self._expect_cmd(f"dwim-print (struct Structure)s", "expression")
def test_summary_strings(self):
"""Test dwim-print with nested values (structs, etc)."""
self.build()
lldbutil.run_to_source_breakpoint(
self, "break here", lldb.SBFileSpec("main.c")
)
self.runCmd("settings set auto-one-line-summaries false")
self.runCmd("type summary add -e -s 'stub summary' Structure")
self._expect_cmd(f"dwim-print s", "frame variable")
self._expect_cmd(f"dwim-print (struct Structure)s", "expression")
def test_void_result(self):
"""Test dwim-print does not surface an error message for void expressions."""
self.build()
lldbutil.run_to_source_breakpoint(
self, "break here", lldb.SBFileSpec("main.c")
)
self.expect("dwim-print (void)15", matching=False, patterns=["(?i)error"])
def test_preserves_persistent_variables(self):
"""Test dwim-print does not delete persistent variables."""
self.build()
lldbutil.run_to_source_breakpoint(
self, "break here", lldb.SBFileSpec("main.c")
)
self.expect("dwim-print int $i = 15")
# Run the same expression twice and verify success. This ensures the
# first command does not delete the persistent variable.
for _ in range(2):
self.expect("dwim-print $i", startstr="(int) 15")
def test_missing_type(self):
"""The expected output of po opaque is its address (no error)"""
self.build()
lldbutil.run_to_source_breakpoint(
self, "break here", lldb.SBFileSpec("main.c")
)
self.expect("dwim-print -O -- opaque", substrs=['0x'])
|
