1""" 2Test SBTarget APIs. 3""" 4 5from __future__ import print_function 6 7 8import unittest2 9import os 10import lldb 11from lldbsuite.test.decorators import * 12from lldbsuite.test.lldbtest import * 13from lldbsuite.test import lldbutil 14 15 16class TargetAPITestCase(TestBase): 17 18 mydir = TestBase.compute_mydir(__file__) 19 20 def setUp(self): 21 # Call super's setUp(). 22 TestBase.setUp(self) 23 # Find the line number to of function 'c'. 24 self.line1 = line_number( 25 'main.c', '// Find the line number for breakpoint 1 here.') 26 self.line2 = line_number( 27 'main.c', '// Find the line number for breakpoint 2 here.') 28 self.line_main = line_number( 29 "main.c", "// Set a break at entry to main.") 30 31 # rdar://problem/9700873 32 # Find global variable value fails for dwarf if inferior not started 33 # (Was CrashTracer: [USER] 1 crash in Python at _lldb.so: lldb_private::MemoryCache::Read + 94) 34 # 35 # It does not segfaults now. But for dwarf, the variable value is None if 36 # the inferior process does not exist yet. The radar has been updated. 37 #@unittest232.skip("segmentation fault -- skipping") 38 @add_test_categories(['pyapi']) 39 def test_find_global_variables(self): 40 """Exercise SBTarget.FindGlobalVariables() API.""" 41 d = {'EXE': 'b.out'} 42 self.build(dictionary=d) 43 self.setTearDownCleanup(dictionary=d) 44 self.find_global_variables('b.out') 45 46 @add_test_categories(['pyapi']) 47 def test_find_compile_units(self): 48 """Exercise SBTarget.FindCompileUnits() API.""" 49 d = {'EXE': 'b.out'} 50 self.build(dictionary=d) 51 self.setTearDownCleanup(dictionary=d) 52 self.find_compile_units(self.getBuildArtifact('b.out')) 53 54 @add_test_categories(['pyapi']) 55 @expectedFailureAll(oslist=["windows"], bugnumber="llvm.org/pr24778") 56 def test_find_functions(self): 57 """Exercise SBTarget.FindFunctions() API.""" 58 d = {'EXE': 'b.out'} 59 self.build(dictionary=d) 60 self.setTearDownCleanup(dictionary=d) 61 self.find_functions('b.out') 62 63 @add_test_categories(['pyapi']) 64 def test_get_description(self): 65 """Exercise SBTarget.GetDescription() API.""" 66 self.build() 67 self.get_description() 68 69 @add_test_categories(['pyapi']) 70 @expectedFailureAll(oslist=["windows"], bugnumber='llvm.org/pr21765') 71 def test_resolve_symbol_context_with_address(self): 72 """Exercise SBTarget.ResolveSymbolContextForAddress() API.""" 73 self.build() 74 self.resolve_symbol_context_with_address() 75 76 @add_test_categories(['pyapi']) 77 def test_get_platform(self): 78 d = {'EXE': 'b.out'} 79 self.build(dictionary=d) 80 self.setTearDownCleanup(dictionary=d) 81 target = self.create_simple_target('b.out') 82 platform = target.platform 83 self.assertTrue(platform, VALID_PLATFORM) 84 85 @add_test_categories(['pyapi']) 86 def test_get_data_byte_size(self): 87 d = {'EXE': 'b.out'} 88 self.build(dictionary=d) 89 self.setTearDownCleanup(dictionary=d) 90 target = self.create_simple_target('b.out') 91 self.assertEqual(target.data_byte_size, 1) 92 93 @add_test_categories(['pyapi']) 94 def test_get_code_byte_size(self): 95 d = {'EXE': 'b.out'} 96 self.build(dictionary=d) 97 self.setTearDownCleanup(dictionary=d) 98 target = self.create_simple_target('b.out') 99 self.assertEqual(target.code_byte_size, 1) 100 101 @add_test_categories(['pyapi']) 102 def test_resolve_file_address(self): 103 d = {'EXE': 'b.out'} 104 self.build(dictionary=d) 105 self.setTearDownCleanup(dictionary=d) 106 target = self.create_simple_target('b.out') 107 108 # find the file address in the .data section of the main 109 # module 110 data_section = self.find_data_section(target) 111 data_section_addr = data_section.file_addr 112 113 # resolve the above address, and compare the address produced 114 # by the resolution against the original address/section 115 res_file_addr = target.ResolveFileAddress(data_section_addr) 116 self.assertTrue(res_file_addr.IsValid()) 117 118 self.assertEqual(data_section_addr, res_file_addr.file_addr) 119 120 data_section2 = res_file_addr.section 121 self.assertIsNotNone(data_section2) 122 self.assertEqual(data_section.name, data_section2.name) 123 124 @add_test_categories(['pyapi']) 125 @skipIfReproducer # SBTarget::ReadMemory is not instrumented. 126 def test_read_memory(self): 127 d = {'EXE': 'b.out'} 128 self.build(dictionary=d) 129 self.setTearDownCleanup(dictionary=d) 130 target = self.create_simple_target('b.out') 131 132 breakpoint = target.BreakpointCreateByLocation( 133 "main.c", self.line_main) 134 self.assertTrue(breakpoint, VALID_BREAKPOINT) 135 136 # Put debugger into synchronous mode so when we target.LaunchSimple returns 137 # it will guaranteed to be at the breakpoint 138 self.dbg.SetAsync(False) 139 140 # Launch the process, and do not stop at the entry point. 141 process = target.LaunchSimple( 142 None, None, self.get_process_working_directory()) 143 144 # find the file address in the .data section of the main 145 # module 146 data_section = self.find_data_section(target) 147 sb_addr = lldb.SBAddress(data_section, 0) 148 error = lldb.SBError() 149 content = target.ReadMemory(sb_addr, 1, error) 150 self.assertTrue(error.Success(), "Make sure memory read succeeded") 151 self.assertEqual(len(content), 1) 152 153 154 @add_test_categories(['pyapi']) 155 @skipIfWindows # stdio manipulation unsupported on Windows 156 def test_launch_simple(self): 157 d = {'EXE': 'b.out'} 158 self.build(dictionary=d) 159 self.setTearDownCleanup(dictionary=d) 160 target = self.create_simple_target('b.out') 161 162 process = target.LaunchSimple( 163 ['foo', 'bar'], ['baz'], self.get_process_working_directory()) 164 self.runCmd("run") 165 output = process.GetSTDOUT(9999) 166 self.assertIn('arg: foo', output) 167 self.assertIn('arg: bar', output) 168 self.assertIn('env: baz', output) 169 170 self.runCmd("setting set target.run-args foo") 171 self.runCmd("setting set target.env-vars bar=baz") 172 process = target.LaunchSimple(None, None, 173 self.get_process_working_directory()) 174 self.runCmd("run") 175 output = process.GetSTDOUT(9999) 176 self.assertIn('arg: foo', output) 177 self.assertIn('env: bar=baz', output) 178 179 self.runCmd("settings set target.disable-stdio true") 180 process = target.LaunchSimple( 181 None, None, self.get_process_working_directory()) 182 self.runCmd("run") 183 output = process.GetSTDOUT(9999) 184 self.assertEqual(output, "") 185 186 def create_simple_target(self, fn): 187 exe = self.getBuildArtifact(fn) 188 target = self.dbg.CreateTarget(exe) 189 self.assertTrue(target, VALID_TARGET) 190 return target 191 192 def find_data_section(self, target): 193 mod = target.GetModuleAtIndex(0) 194 data_section = None 195 for s in mod.sections: 196 sect_type = s.GetSectionType() 197 if sect_type == lldb.eSectionTypeData: 198 data_section = s 199 break 200 elif sect_type == lldb.eSectionTypeContainer: 201 for i in range(s.GetNumSubSections()): 202 ss = s.GetSubSectionAtIndex(i) 203 sect_type = ss.GetSectionType() 204 if sect_type == lldb.eSectionTypeData: 205 data_section = ss 206 break 207 208 self.assertIsNotNone(data_section) 209 return data_section 210 211 def find_global_variables(self, exe_name): 212 """Exercise SBTaget.FindGlobalVariables() API.""" 213 exe = self.getBuildArtifact(exe_name) 214 215 # Create a target by the debugger. 216 target = self.dbg.CreateTarget(exe) 217 self.assertTrue(target, VALID_TARGET) 218 219 # rdar://problem/9700873 220 # Find global variable value fails for dwarf if inferior not started 221 # (Was CrashTracer: [USER] 1 crash in Python at _lldb.so: lldb_private::MemoryCache::Read + 94) 222 # 223 # Remove the lines to create a breakpoint and to start the inferior 224 # which are workarounds for the dwarf case. 225 226 breakpoint = target.BreakpointCreateByLocation('main.c', self.line1) 227 self.assertTrue(breakpoint, VALID_BREAKPOINT) 228 229 # Now launch the process, and do not stop at entry point. 230 process = target.LaunchSimple( 231 None, None, self.get_process_working_directory()) 232 self.assertTrue(process, PROCESS_IS_VALID) 233 # Make sure we hit our breakpoint: 234 thread_list = lldbutil.get_threads_stopped_at_breakpoint( 235 process, breakpoint) 236 self.assertTrue(len(thread_list) == 1) 237 238 value_list = target.FindGlobalVariables( 239 'my_global_var_of_char_type', 3) 240 self.assertTrue(value_list.GetSize() == 1) 241 my_global_var = value_list.GetValueAtIndex(0) 242 self.DebugSBValue(my_global_var) 243 self.assertTrue(my_global_var) 244 self.expect(my_global_var.GetName(), exe=False, 245 startstr="my_global_var_of_char_type") 246 self.expect(my_global_var.GetTypeName(), exe=False, 247 startstr="char") 248 self.expect(my_global_var.GetValue(), exe=False, 249 startstr="'X'") 250 251 252 if not configuration.is_reproducer(): 253 # While we are at it, let's also exercise the similar 254 # SBModule.FindGlobalVariables() API. 255 for m in target.module_iter(): 256 if os.path.normpath(m.GetFileSpec().GetDirectory()) == self.getBuildDir() and m.GetFileSpec().GetFilename() == exe_name: 257 value_list = m.FindGlobalVariables( 258 target, 'my_global_var_of_char_type', 3) 259 self.assertTrue(value_list.GetSize() == 1) 260 self.assertTrue( 261 value_list.GetValueAtIndex(0).GetValue() == "'X'") 262 break 263 264 def find_compile_units(self, exe): 265 """Exercise SBTarget.FindCompileUnits() API.""" 266 source_name = "main.c" 267 268 # Create a target by the debugger. 269 target = self.dbg.CreateTarget(exe) 270 self.assertTrue(target, VALID_TARGET) 271 272 list = target.FindCompileUnits(lldb.SBFileSpec(source_name, False)) 273 # Executable has been built just from one source file 'main.c', 274 # so we may check only the first element of list. 275 self.assertTrue( 276 list[0].GetCompileUnit().GetFileSpec().GetFilename() == source_name) 277 278 def find_functions(self, exe_name): 279 """Exercise SBTaget.FindFunctions() API.""" 280 exe = self.getBuildArtifact(exe_name) 281 282 # Create a target by the debugger. 283 target = self.dbg.CreateTarget(exe) 284 self.assertTrue(target, VALID_TARGET) 285 286 # Try it with a null name: 287 list = target.FindFunctions(None, lldb.eFunctionNameTypeAuto) 288 self.assertTrue(list.GetSize() == 0) 289 290 list = target.FindFunctions('c', lldb.eFunctionNameTypeAuto) 291 self.assertTrue(list.GetSize() == 1) 292 293 for sc in list: 294 self.assertTrue( 295 sc.GetModule().GetFileSpec().GetFilename() == exe_name) 296 self.assertTrue(sc.GetSymbol().GetName() == 'c') 297 298 def get_description(self): 299 """Exercise SBTaget.GetDescription() API.""" 300 exe = self.getBuildArtifact("a.out") 301 302 # Create a target by the debugger. 303 target = self.dbg.CreateTarget(exe) 304 self.assertTrue(target, VALID_TARGET) 305 306 from lldbsuite.test.lldbutil import get_description 307 308 # get_description() allows no option to mean 309 # lldb.eDescriptionLevelBrief. 310 desc = get_description(target) 311 #desc = get_description(target, option=lldb.eDescriptionLevelBrief) 312 if not desc: 313 self.fail("SBTarget.GetDescription() failed") 314 self.expect(desc, exe=False, 315 substrs=['a.out']) 316 self.expect(desc, exe=False, matching=False, 317 substrs=['Target', 'Module', 'Breakpoint']) 318 319 desc = get_description(target, option=lldb.eDescriptionLevelFull) 320 if not desc: 321 self.fail("SBTarget.GetDescription() failed") 322 self.expect(desc, exe=False, 323 substrs=['a.out', 'Target', 'Module', 'Breakpoint']) 324 325 @not_remote_testsuite_ready 326 @add_test_categories(['pyapi']) 327 @no_debug_info_test 328 @skipIfReproducer # Inferior doesn't run during replay. 329 def test_launch_new_process_and_redirect_stdout(self): 330 """Exercise SBTaget.Launch() API with redirected stdout.""" 331 self.build() 332 exe = self.getBuildArtifact("a.out") 333 334 # Create a target by the debugger. 335 target = self.dbg.CreateTarget(exe) 336 self.assertTrue(target, VALID_TARGET) 337 338 # Add an extra twist of stopping the inferior in a breakpoint, and then continue till it's done. 339 # We should still see the entire stdout redirected once the process is 340 # finished. 341 line = line_number('main.c', '// a(3) -> c(3)') 342 breakpoint = target.BreakpointCreateByLocation('main.c', line) 343 344 # Now launch the process, do not stop at entry point, and redirect stdout to "stdout.txt" file. 345 # The inferior should run to completion after "process.Continue()" 346 # call. 347 local_path = self.getBuildArtifact("stdout.txt") 348 if os.path.exists(local_path): 349 os.remove(local_path) 350 351 if lldb.remote_platform: 352 stdout_path = lldbutil.append_to_process_working_directory(self, 353 "lldb-stdout-redirect.txt") 354 else: 355 stdout_path = local_path 356 error = lldb.SBError() 357 process = target.Launch( 358 self.dbg.GetListener(), 359 None, 360 None, 361 None, 362 stdout_path, 363 None, 364 None, 365 0, 366 False, 367 error) 368 process.Continue() 369 #self.runCmd("process status") 370 if lldb.remote_platform: 371 # copy output file to host 372 lldb.remote_platform.Get( 373 lldb.SBFileSpec(stdout_path), 374 lldb.SBFileSpec(local_path)) 375 376 # The 'stdout.txt' file should now exist. 377 self.assertTrue( 378 os.path.isfile(local_path), 379 "'stdout.txt' exists due to redirected stdout via SBTarget.Launch() API.") 380 381 # Read the output file produced by running the program. 382 with open(local_path, 'r') as f: 383 output = f.read() 384 385 self.expect(output, exe=False, 386 substrs=["a(1)", "b(2)", "a(3)"]) 387 388 def resolve_symbol_context_with_address(self): 389 """Exercise SBTaget.ResolveSymbolContextForAddress() API.""" 390 exe = self.getBuildArtifact("a.out") 391 392 # Create a target by the debugger. 393 target = self.dbg.CreateTarget(exe) 394 self.assertTrue(target, VALID_TARGET) 395 396 # Now create the two breakpoints inside function 'a'. 397 breakpoint1 = target.BreakpointCreateByLocation('main.c', self.line1) 398 breakpoint2 = target.BreakpointCreateByLocation('main.c', self.line2) 399 self.trace("breakpoint1:", breakpoint1) 400 self.trace("breakpoint2:", breakpoint2) 401 self.assertTrue(breakpoint1 and 402 breakpoint1.GetNumLocations() == 1, 403 VALID_BREAKPOINT) 404 self.assertTrue(breakpoint2 and 405 breakpoint2.GetNumLocations() == 1, 406 VALID_BREAKPOINT) 407 408 # Now launch the process, and do not stop at entry point. 409 process = target.LaunchSimple( 410 None, None, self.get_process_working_directory()) 411 self.assertTrue(process, PROCESS_IS_VALID) 412 413 # Frame #0 should be on self.line1. 414 self.assertTrue(process.GetState() == lldb.eStateStopped) 415 thread = lldbutil.get_stopped_thread( 416 process, lldb.eStopReasonBreakpoint) 417 self.assertTrue( 418 thread.IsValid(), 419 "There should be a thread stopped due to breakpoint condition") 420 #self.runCmd("process status") 421 frame0 = thread.GetFrameAtIndex(0) 422 lineEntry = frame0.GetLineEntry() 423 self.assertTrue(lineEntry.GetLine() == self.line1) 424 425 address1 = lineEntry.GetStartAddress() 426 427 # Continue the inferior, the breakpoint 2 should be hit. 428 process.Continue() 429 self.assertTrue(process.GetState() == lldb.eStateStopped) 430 thread = lldbutil.get_stopped_thread( 431 process, lldb.eStopReasonBreakpoint) 432 self.assertTrue( 433 thread.IsValid(), 434 "There should be a thread stopped due to breakpoint condition") 435 #self.runCmd("process status") 436 frame0 = thread.GetFrameAtIndex(0) 437 lineEntry = frame0.GetLineEntry() 438 self.assertTrue(lineEntry.GetLine() == self.line2) 439 440 address2 = lineEntry.GetStartAddress() 441 442 self.trace("address1:", address1) 443 self.trace("address2:", address2) 444 445 # Now call SBTarget.ResolveSymbolContextForAddress() with the addresses 446 # from our line entry. 447 context1 = target.ResolveSymbolContextForAddress( 448 address1, lldb.eSymbolContextEverything) 449 context2 = target.ResolveSymbolContextForAddress( 450 address2, lldb.eSymbolContextEverything) 451 452 self.assertTrue(context1 and context2) 453 self.trace("context1:", context1) 454 self.trace("context2:", context2) 455 456 # Verify that the context point to the same function 'a'. 457 symbol1 = context1.GetSymbol() 458 symbol2 = context2.GetSymbol() 459 self.assertTrue(symbol1 and symbol2) 460 self.trace("symbol1:", symbol1) 461 self.trace("symbol2:", symbol2) 462 463 from lldbsuite.test.lldbutil import get_description 464 desc1 = get_description(symbol1) 465 desc2 = get_description(symbol2) 466 self.assertTrue(desc1 and desc2 and desc1 == desc2, 467 "The two addresses should resolve to the same symbol") 468