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
|
"""
Test lldb data formatter subsystem.
"""
import lldb
from lldbsuite.test.lldbtest import *
import lldbsuite.test.lldbutil as lldbutil
class AdvDataFormatterTestCase(TestBase):
def setUp(self):
# Call super's setUp().
TestBase.setUp(self)
# Find the line number to break at.
self.line = line_number("main.cpp", "// Set break point at this line.")
def test_with_run_command(self):
"""Test that that file and class static variables display correctly."""
self.build()
self.runCmd("file " + self.getBuildArtifact("a.out"), CURRENT_EXECUTABLE_SET)
lldbutil.run_break_set_by_file_and_line(
self, "main.cpp", self.line, num_expected_locations=1, loc_exact=True
)
self.runCmd("run", RUN_SUCCEEDED)
# The stop reason of the thread should be breakpoint.
self.expect(
"thread list",
STOPPED_DUE_TO_BREAKPOINT,
substrs=["stopped", "stop reason = breakpoint"],
)
# This is the function to remove the custom formats in order to have a
# clean slate for the next test case.
def cleanup():
self.runCmd("type format clear", check=False)
self.runCmd("type summary clear", check=False)
self.runCmd("settings set target.max-children-count 256", check=False)
self.runCmd("settings clear target.max-children-depth", check=False)
# Execute the cleanup function during test case tear down.
self.addTearDownHook(cleanup)
self.runCmd('type summary add --summary-string "pippo" "i_am_cool"')
self.runCmd('type summary add --summary-string "pluto" -x "i_am_cool[a-z]*"')
self.expect("frame variable cool_boy", substrs=["pippo"])
self.expect("frame variable cooler_boy", substrs=["pluto"])
self.runCmd("type summary delete i_am_cool")
self.expect("frame variable cool_boy", substrs=["pluto"])
self.runCmd("type summary clear")
self.runCmd('type summary add --summary-string "${var[]}" -x "^int\\[[0-9]\\]')
self.expect("frame variable int_array", substrs=["1,2,3,4,5"])
self.expect("frame variable const_int_array", substrs=["11,12,13,14,15"])
# this will fail if we don't do [] as regex correctly
self.runCmd('type summary add --summary-string "${var[].integer}" "i_am_cool[]')
self.expect("frame variable cool_array", substrs=["1,1,1,1,6"])
self.runCmd("type summary clear")
self.runCmd('type summary add --summary-string "${var[1-0]%x}" "int"')
self.expect("frame variable iAmInt", substrs=["01"])
self.runCmd('type summary add --summary-string "${var[0-1]%x}" "int"')
self.expect("frame variable iAmInt", substrs=["01"])
self.runCmd("type summary clear")
self.runCmd('type summary add --summary-string "${var[0-1]%x}" int')
self.runCmd('type summary add --summary-string "${var[0-31]%x}" float')
self.expect("frame variable *pointer", substrs=["0x", "2"])
# check fix for <rdar://problem/11338654> LLDB crashes when using a
# "type summary" that uses bitfields with no format
self.runCmd('type summary add --summary-string "${var[0-1]}" int')
self.expect("frame variable iAmInt", substrs=["9 1"])
self.expect("frame variable cool_array[3].floating", substrs=["0x"])
self.runCmd(
'type summary add --summary-string "low bits are ${*var[0-1]} tgt is ${*var}" "int *"'
)
self.expect("frame variable pointer", substrs=["low bits are", "tgt is 6"])
self.expect(
'frame variable int_array --summary-string "${*var[0-1]}"', substrs=["3"]
)
self.runCmd("type summary clear")
self.runCmd('type summary add --summary-string "${var[0-1]}" -x "int\[[0-9]\]"')
self.expect("frame variable int_array", substrs=["1,2"])
self.runCmd('type summary add --summary-string "${var[0-1]}" "int[]"')
self.expect("frame variable int_array", substrs=["1,2"])
# Test the patterns are matched in reverse-chronological order.
self.runCmd('type summary add --summary-string "${var[2-3]}" "int[]"')
self.expect("frame variable int_array", substrs=["3,4"])
self.runCmd("type summary clear")
self.runCmd('type summary add -c -x "i_am_cool\[[0-9]\]"')
self.runCmd("type summary add -c i_am_cool")
self.expect(
"frame variable cool_array",
substrs=[
"[0]",
"integer",
"floating",
"character",
"[1]",
"integer",
"floating",
"character",
"[2]",
"integer",
"floating",
"character",
"[3]",
"integer",
"floating",
"character",
"[4]",
"integer",
"floating",
"character",
],
)
self.runCmd(
'type summary add --summary-string "int = ${*var.int_pointer}, float = ${*var.float_pointer}" IWrapPointers'
)
self.expect("frame variable wrapper", substrs=["int = 4", "float = 1.1"])
self.runCmd(
'type summary add --summary-string "low bits = ${*var.int_pointer[2]}" IWrapPointers -p'
)
self.expect("frame variable wrapper", substrs=["low bits = 1"])
self.expect("frame variable *wrap_pointer", substrs=["low bits = 1"])
self.runCmd("type summary clear")
self.expect(
'frame variable int_array --summary-string "${var[0][0-2]%hex}"',
substrs=["0x", "7"],
)
self.runCmd("type summary clear")
self.runCmd(
'type summary add --summary-string "${*var[].x[0-3]%hex} is a bitfield on a set of integers" -x "SimpleWithPointers\[[0-9]\]"'
)
self.expect(
'frame variable couple --summary-string "${*var.sp.x[0-2]} are low bits of integer ${*var.sp.x}. If I pretend it is an array I get ${var.sp.x[0-5]}"',
substrs=[
"1 are low bits of integer 9.",
"If I pretend it is an array I get [9,",
],
)
# if the summary has an error, we still display the value
self.expect(
'frame variable couple --summary-string "${*var.sp.foo[0-2]"',
substrs=["(Couple) couple = {", "x = 0x", "y = 0x", "z = 0x", "s = 0x"],
)
self.runCmd(
'type summary add --summary-string "${*var.sp.x[0-2]} are low bits of integer ${*var.sp.x}. If I pretend it is an array I get ${var.sp.x[0-5]}" Couple'
)
self.expect(
"frame variable sparray", substrs=["[0x0000000f,0x0000000c,0x00000009]"]
)
# check that we can format a variable in a summary even if a format is
# defined for its datatype
self.runCmd("type format add -f hex int")
self.runCmd('type summary add --summary-string "x=${var.x%d}" Simple')
self.expect("frame variable a_simple_object", substrs=["x=3"])
self.expect("frame variable a_simple_object", matching=False, substrs=["0x0"])
# now check that the default is applied if we do not hand out a format
self.runCmd('type summary add --summary-string "x=${var.x}" Simple')
self.expect("frame variable a_simple_object", matching=False, substrs=["x=3"])
self.expect(
"frame variable a_simple_object", matching=True, substrs=["x=0x00000003"]
)
self.expect_var_path("constInt", value="0x0000002a")
self.expect_var_path("volatileInt", value="0x0000002b")
self.expect_var_path("constVolatileInt", value="0x0000002c")
# check that we can correctly cap the number of children shown
self.runCmd("settings set target.max-children-count 5")
self.expect(
"frame variable a_long_guy",
matching=True,
substrs=["a_1", "b_1", "c_1", "d_1", "e_1", "..."],
)
# check that no further stuff is printed (not ALL values are checked!)
self.expect(
"frame variable a_long_guy",
matching=False,
substrs=[
"f_1",
"g_1",
"h_1",
"i_1",
"j_1",
"q_1",
"a_2",
"f_2",
"t_2",
"w_2",
],
)
self.runCmd("settings set target.max-children-count 1")
self.expect("frame variable a_long_guy", matching=True, substrs=["a_1", "..."])
self.expect(
"frame variable a_long_guy",
matching=False,
substrs=["b_1", "c_1", "d_1", "e_1"],
)
self.expect(
"frame variable a_long_guy",
matching=False,
substrs=[
"f_1",
"g_1",
"h_1",
"i_1",
"j_1",
"q_1",
"a_2",
"f_2",
"t_2",
"w_2",
],
)
self.runCmd("settings set target.max-children-count 30")
self.expect(
"frame variable a_long_guy",
matching=True,
substrs=[
"a_1",
"b_1",
"c_1",
"d_1",
"e_1",
"z_1",
"a_2",
"b_2",
"c_2",
"d_2",
"...",
],
)
self.expect(
"frame variable a_long_guy",
matching=False,
substrs=["e_2", "n_2", "r_2", "i_2", "k_2", "o_2"],
)
# override the cap
self.expect(
"frame variable a_long_guy --show-all-children",
matching=True,
substrs=[
"a_1",
"b_1",
"c_1",
"d_1",
"e_1",
"z_1",
"a_2",
"b_2",
"c_2",
"d_2",
],
)
self.expect(
"frame variable a_long_guy --show-all-children",
matching=True,
substrs=[
"e_2",
"i_2",
"k_2",
"n_2",
"o_2",
"r_2",
],
)
self.expect(
"frame variable a_long_guy --show-all-children",
matching=False,
substrs=["..."],
)
# The below tests need the hex formatting of int removed.
self.runCmd("type format delete int")
# First, check the following:
# 1. Verify the default max-children-depth (6) is applied
# 2. Ensure the one-time warning is printed
warning = "*** Some of the displayed variables have a greater depth"
self.expect(
"frame variable quite_nested",
matching=True,
substrs=["six ={...}", warning],
)
self.expect(
"frame variable quite_nested",
matching=False,
substrs=["leaf = 41", warning],
)
# Check that both ways of overriding max-children-depth work.
self.expect(
"frame variable --depth 8 quite_nested",
matching=True,
substrs=["leaf = 41"],
)
self.runCmd("settings set target.max-children-depth 8")
self.expect("frame variable quite_nested", matching=True, substrs=["leaf = 41"])
|