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