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 @skipIfRemote # stdio manipulation unsupported on remote iOS devices<rdar://problem/54581135> 157 @skipIf(oslist=["linux"], archs=["arm", "aarch64"]) 158 @no_debug_info_test 159 def test_launch_simple(self): 160 d = {'EXE': 'b.out'} 161 self.build(dictionary=d) 162 self.setTearDownCleanup(dictionary=d) 163 target = self.create_simple_target('b.out') 164 165 # Set the debugger to synchronous mode so we only continue after the 166 # process has exited. 167 self.dbg.SetAsync(False) 168 169 process = target.LaunchSimple( 170 ['foo', 'bar'], ['baz'], self.get_process_working_directory()) 171 process.Continue() 172 self.assertEqual(process.GetState(), lldb.eStateExited) 173 output = process.GetSTDOUT(9999) 174 self.assertIn('arg: foo', output) 175 self.assertIn('arg: bar', output) 176 self.assertIn('env: baz', output) 177 178 self.runCmd("setting set target.run-args foo") 179 self.runCmd("setting set target.env-vars bar=baz") 180 process = target.LaunchSimple(None, None, 181 self.get_process_working_directory()) 182 process.Continue() 183 self.assertEqual(process.GetState(), lldb.eStateExited) 184 output = process.GetSTDOUT(9999) 185 self.assertIn('arg: foo', output) 186 self.assertIn('env: bar=baz', output) 187 188 self.runCmd("settings set target.disable-stdio true") 189 process = target.LaunchSimple( 190 None, None, self.get_process_working_directory()) 191 process.Continue() 192 self.assertEqual(process.GetState(), lldb.eStateExited) 193 output = process.GetSTDOUT(9999) 194 self.assertEqual(output, "") 195 196 def create_simple_target(self, fn): 197 exe = self.getBuildArtifact(fn) 198 target = self.dbg.CreateTarget(exe) 199 self.assertTrue(target, VALID_TARGET) 200 return target 201 202 def find_data_section(self, target): 203 mod = target.GetModuleAtIndex(0) 204 data_section = None 205 for s in mod.sections: 206 sect_type = s.GetSectionType() 207 if sect_type == lldb.eSectionTypeData: 208 data_section = s 209 break 210 elif sect_type == lldb.eSectionTypeContainer: 211 for i in range(s.GetNumSubSections()): 212 ss = s.GetSubSectionAtIndex(i) 213 sect_type = ss.GetSectionType() 214 if sect_type == lldb.eSectionTypeData: 215 data_section = ss 216 break 217 218 self.assertIsNotNone(data_section) 219 return data_section 220 221 def find_global_variables(self, exe_name): 222 """Exercise SBTaget.FindGlobalVariables() API.""" 223 exe = self.getBuildArtifact(exe_name) 224 225 # Create a target by the debugger. 226 target = self.dbg.CreateTarget(exe) 227 self.assertTrue(target, VALID_TARGET) 228 229 # rdar://problem/9700873 230 # Find global variable value fails for dwarf if inferior not started 231 # (Was CrashTracer: [USER] 1 crash in Python at _lldb.so: lldb_private::MemoryCache::Read + 94) 232 # 233 # Remove the lines to create a breakpoint and to start the inferior 234 # which are workarounds for the dwarf case. 235 236 breakpoint = target.BreakpointCreateByLocation('main.c', self.line1) 237 self.assertTrue(breakpoint, VALID_BREAKPOINT) 238 239 # Now launch the process, and do not stop at entry point. 240 process = target.LaunchSimple( 241 None, None, self.get_process_working_directory()) 242 self.assertTrue(process, PROCESS_IS_VALID) 243 # Make sure we hit our breakpoint: 244 thread_list = lldbutil.get_threads_stopped_at_breakpoint( 245 process, breakpoint) 246 self.assertTrue(len(thread_list) == 1) 247 248 value_list = target.FindGlobalVariables( 249 'my_global_var_of_char_type', 3) 250 self.assertTrue(value_list.GetSize() == 1) 251 my_global_var = value_list.GetValueAtIndex(0) 252 self.DebugSBValue(my_global_var) 253 self.assertTrue(my_global_var) 254 self.expect(my_global_var.GetName(), exe=False, 255 startstr="my_global_var_of_char_type") 256 self.expect(my_global_var.GetTypeName(), exe=False, 257 startstr="char") 258 self.expect(my_global_var.GetValue(), exe=False, 259 startstr="'X'") 260 261 262 if not configuration.is_reproducer(): 263 # While we are at it, let's also exercise the similar 264 # SBModule.FindGlobalVariables() API. 265 for m in target.module_iter(): 266 if os.path.normpath(m.GetFileSpec().GetDirectory()) == self.getBuildDir() and m.GetFileSpec().GetFilename() == exe_name: 267 value_list = m.FindGlobalVariables( 268 target, 'my_global_var_of_char_type', 3) 269 self.assertTrue(value_list.GetSize() == 1) 270 self.assertTrue( 271 value_list.GetValueAtIndex(0).GetValue() == "'X'") 272 break 273 274 def find_compile_units(self, exe): 275 """Exercise SBTarget.FindCompileUnits() API.""" 276 source_name = "main.c" 277 278 # Create a target by the debugger. 279 target = self.dbg.CreateTarget(exe) 280 self.assertTrue(target, VALID_TARGET) 281 282 list = target.FindCompileUnits(lldb.SBFileSpec(source_name, False)) 283 # Executable has been built just from one source file 'main.c', 284 # so we may check only the first element of list. 285 self.assertTrue( 286 list[0].GetCompileUnit().GetFileSpec().GetFilename() == source_name) 287 288 def find_functions(self, exe_name): 289 """Exercise SBTaget.FindFunctions() API.""" 290 exe = self.getBuildArtifact(exe_name) 291 292 # Create a target by the debugger. 293 target = self.dbg.CreateTarget(exe) 294 self.assertTrue(target, VALID_TARGET) 295 296 # Try it with a null name: 297 list = target.FindFunctions(None, lldb.eFunctionNameTypeAuto) 298 self.assertTrue(list.GetSize() == 0) 299 300 list = target.FindFunctions('c', lldb.eFunctionNameTypeAuto) 301 self.assertTrue(list.GetSize() == 1) 302 303 for sc in list: 304 self.assertTrue( 305 sc.GetModule().GetFileSpec().GetFilename() == exe_name) 306 self.assertTrue(sc.GetSymbol().GetName() == 'c') 307 308 def get_description(self): 309 """Exercise SBTaget.GetDescription() API.""" 310 exe = self.getBuildArtifact("a.out") 311 312 # Create a target by the debugger. 313 target = self.dbg.CreateTarget(exe) 314 self.assertTrue(target, VALID_TARGET) 315 316 from lldbsuite.test.lldbutil import get_description 317 318 # get_description() allows no option to mean 319 # lldb.eDescriptionLevelBrief. 320 desc = get_description(target) 321 #desc = get_description(target, option=lldb.eDescriptionLevelBrief) 322 if not desc: 323 self.fail("SBTarget.GetDescription() failed") 324 self.expect(desc, exe=False, 325 substrs=['a.out']) 326 self.expect(desc, exe=False, matching=False, 327 substrs=['Target', 'Module', 'Breakpoint']) 328 329 desc = get_description(target, option=lldb.eDescriptionLevelFull) 330 if not desc: 331 self.fail("SBTarget.GetDescription() failed") 332 self.expect(desc, exe=False, 333 substrs=['a.out', 'Target', 'Module', 'Breakpoint']) 334 335 @not_remote_testsuite_ready 336 @add_test_categories(['pyapi']) 337 @no_debug_info_test 338 @skipIfReproducer # Inferior doesn't run during replay. 339 def test_launch_new_process_and_redirect_stdout(self): 340 """Exercise SBTaget.Launch() API with redirected stdout.""" 341 self.build() 342 exe = self.getBuildArtifact("a.out") 343 344 # Create a target by the debugger. 345 target = self.dbg.CreateTarget(exe) 346 self.assertTrue(target, VALID_TARGET) 347 348 # Add an extra twist of stopping the inferior in a breakpoint, and then continue till it's done. 349 # We should still see the entire stdout redirected once the process is 350 # finished. 351 line = line_number('main.c', '// a(3) -> c(3)') 352 breakpoint = target.BreakpointCreateByLocation('main.c', line) 353 354 # Now launch the process, do not stop at entry point, and redirect stdout to "stdout.txt" file. 355 # The inferior should run to completion after "process.Continue()" 356 # call. 357 local_path = self.getBuildArtifact("stdout.txt") 358 if os.path.exists(local_path): 359 os.remove(local_path) 360 361 if lldb.remote_platform: 362 stdout_path = lldbutil.append_to_process_working_directory(self, 363 "lldb-stdout-redirect.txt") 364 else: 365 stdout_path = local_path 366 error = lldb.SBError() 367 process = target.Launch( 368 self.dbg.GetListener(), 369 None, 370 None, 371 None, 372 stdout_path, 373 None, 374 None, 375 0, 376 False, 377 error) 378 process.Continue() 379 #self.runCmd("process status") 380 if lldb.remote_platform: 381 # copy output file to host 382 lldb.remote_platform.Get( 383 lldb.SBFileSpec(stdout_path), 384 lldb.SBFileSpec(local_path)) 385 386 # The 'stdout.txt' file should now exist. 387 self.assertTrue( 388 os.path.isfile(local_path), 389 "'stdout.txt' exists due to redirected stdout via SBTarget.Launch() API.") 390 391 # Read the output file produced by running the program. 392 with open(local_path, 'r') as f: 393 output = f.read() 394 395 self.expect(output, exe=False, 396 substrs=["a(1)", "b(2)", "a(3)"]) 397 398 def resolve_symbol_context_with_address(self): 399 """Exercise SBTaget.ResolveSymbolContextForAddress() API.""" 400 exe = self.getBuildArtifact("a.out") 401 402 # Create a target by the debugger. 403 target = self.dbg.CreateTarget(exe) 404 self.assertTrue(target, VALID_TARGET) 405 406 # Now create the two breakpoints inside function 'a'. 407 breakpoint1 = target.BreakpointCreateByLocation('main.c', self.line1) 408 breakpoint2 = target.BreakpointCreateByLocation('main.c', self.line2) 409 self.trace("breakpoint1:", breakpoint1) 410 self.trace("breakpoint2:", breakpoint2) 411 self.assertTrue(breakpoint1 and 412 breakpoint1.GetNumLocations() == 1, 413 VALID_BREAKPOINT) 414 self.assertTrue(breakpoint2 and 415 breakpoint2.GetNumLocations() == 1, 416 VALID_BREAKPOINT) 417 418 # Now launch the process, and do not stop at entry point. 419 process = target.LaunchSimple( 420 None, None, self.get_process_working_directory()) 421 self.assertTrue(process, PROCESS_IS_VALID) 422 423 # Frame #0 should be on self.line1. 424 self.assertTrue(process.GetState() == lldb.eStateStopped) 425 thread = lldbutil.get_stopped_thread( 426 process, lldb.eStopReasonBreakpoint) 427 self.assertTrue( 428 thread.IsValid(), 429 "There should be a thread stopped due to breakpoint condition") 430 #self.runCmd("process status") 431 frame0 = thread.GetFrameAtIndex(0) 432 lineEntry = frame0.GetLineEntry() 433 self.assertTrue(lineEntry.GetLine() == self.line1) 434 435 address1 = lineEntry.GetStartAddress() 436 437 # Continue the inferior, the breakpoint 2 should be hit. 438 process.Continue() 439 self.assertTrue(process.GetState() == lldb.eStateStopped) 440 thread = lldbutil.get_stopped_thread( 441 process, lldb.eStopReasonBreakpoint) 442 self.assertTrue( 443 thread.IsValid(), 444 "There should be a thread stopped due to breakpoint condition") 445 #self.runCmd("process status") 446 frame0 = thread.GetFrameAtIndex(0) 447 lineEntry = frame0.GetLineEntry() 448 self.assertTrue(lineEntry.GetLine() == self.line2) 449 450 address2 = lineEntry.GetStartAddress() 451 452 self.trace("address1:", address1) 453 self.trace("address2:", address2) 454 455 # Now call SBTarget.ResolveSymbolContextForAddress() with the addresses 456 # from our line entry. 457 context1 = target.ResolveSymbolContextForAddress( 458 address1, lldb.eSymbolContextEverything) 459 context2 = target.ResolveSymbolContextForAddress( 460 address2, lldb.eSymbolContextEverything) 461 462 self.assertTrue(context1 and context2) 463 self.trace("context1:", context1) 464 self.trace("context2:", context2) 465 466 # Verify that the context point to the same function 'a'. 467 symbol1 = context1.GetSymbol() 468 symbol2 = context2.GetSymbol() 469 self.assertTrue(symbol1 and symbol2) 470 self.trace("symbol1:", symbol1) 471 self.trace("symbol2:", symbol2) 472 473 from lldbsuite.test.lldbutil import get_description 474 desc1 = get_description(symbol1) 475 desc2 = get_description(symbol2) 476 self.assertTrue(desc1 and desc2 and desc1 == desc2, 477 "The two addresses should resolve to the same symbol") 478