c8fd130a2c
Currently most of the test files have a separate dwarf and a separate dsym test with almost identical content (only the build step is different). With adding dwo symbol file handling to the test suit it would increase this to a 3-way duplication. The purpose of this change is to eliminate this redundancy with generating 2 test case (one dwarf and one dsym) for each test function specified (dwo handling will be added at a later commit). Main design goals: * There should be no boilerplate code in each test file to support the multiple debug info in most of the tests (custom scenarios are acceptable in special cases) so adding a new test case is easier and we can't miss one of the debug info type. * In case of a test failure, the debug symbols used during the test run have to be cleanly visible from the output of dotest.py to make debugging easier both from build bot logs and from local test runs * Each test case should have a unique, fully qualified name so we can run exactly 1 test with "-f <test-case>.<test-function>" syntax * Test output should be grouped based on test files the same way as it happens now (displaying dwarf/dsym results separately isn't preferable) Proposed solution (main logic in lldbtest.py, rest of them are test cases fixed up for the new style): * Have only 1 test fuction in the test files what will run for all debug info separately and this test function should call just "self.build(...)" to build an inferior with the right debug info * When a class is created by python (the class object, not the class instance), we will generate a new test method for each debug info format in the test class with the name "<test-function>_<debug-info>" and remove the original test method. This way unittest2 see multiple test methods (1 for each debug info, pretty much as of now) and will handle the test selection and the failure reporting correctly (the debug info will be visible from the end of the test name) * Add new annotation @no_debug_info_test to disable the generation of multiple tests for each debug info format when the test don't have an inferior Differential revision: http://reviews.llvm.org/D13028 llvm-svn: 248883
375 lines
15 KiB
Python
375 lines
15 KiB
Python
"""
|
|
Test SBTarget APIs.
|
|
"""
|
|
|
|
import os, time
|
|
import re
|
|
import unittest2
|
|
import lldb, lldbutil
|
|
from lldbtest import *
|
|
|
|
class TargetAPITestCase(TestBase):
|
|
|
|
mydir = TestBase.compute_mydir(__file__)
|
|
|
|
def setUp(self):
|
|
# Call super's setUp().
|
|
TestBase.setUp(self)
|
|
# Find the line number to of function 'c'.
|
|
self.line1 = line_number('main.c', '// Find the line number for breakpoint 1 here.')
|
|
self.line2 = line_number('main.c', '// Find the line number for breakpoint 2 here.')
|
|
self.line_main = line_number("main.c", "// Set a break at entry to main.")
|
|
|
|
#rdar://problem/9700873
|
|
# Find global variable value fails for dwarf if inferior not started
|
|
# (Was CrashTracer: [USER] 1 crash in Python at _lldb.so: lldb_private::MemoryCache::Read + 94)
|
|
#
|
|
# It does not segfaults now. But for dwarf, the variable value is None if
|
|
# the inferior process does not exist yet. The radar has been updated.
|
|
#@unittest232.skip("segmentation fault -- skipping")
|
|
@python_api_test
|
|
def test_find_global_variables(self):
|
|
"""Exercise SBTarget.FindGlobalVariables() API."""
|
|
d = {'EXE': 'b.out'}
|
|
self.build(dictionary=d)
|
|
self.setTearDownCleanup(dictionary=d)
|
|
self.find_global_variables('b.out')
|
|
|
|
@python_api_test
|
|
@expectedFailureWindows("llvm.org/pr24778")
|
|
def test_find_functions(self):
|
|
"""Exercise SBTarget.FindFunctions() API."""
|
|
d = {'EXE': 'b.out'}
|
|
self.build(dictionary=d)
|
|
self.setTearDownCleanup(dictionary=d)
|
|
self.find_functions('b.out')
|
|
|
|
@python_api_test
|
|
def test_get_description(self):
|
|
"""Exercise SBTarget.GetDescription() API."""
|
|
self.build()
|
|
self.get_description()
|
|
|
|
@python_api_test
|
|
def test_launch_new_process_and_redirect_stdout(self):
|
|
"""Exercise SBTarget.Launch() API."""
|
|
self.build()
|
|
self.launch_new_process_and_redirect_stdout()
|
|
|
|
@python_api_test
|
|
def test_resolve_symbol_context_with_address(self):
|
|
"""Exercise SBTarget.ResolveSymbolContextForAddress() API."""
|
|
self.build()
|
|
self.resolve_symbol_context_with_address()
|
|
|
|
@python_api_test
|
|
def test_get_platform(self):
|
|
d = {'EXE': 'b.out'}
|
|
self.build(dictionary=d)
|
|
self.setTearDownCleanup(dictionary=d)
|
|
target = self.create_simple_target('b.out')
|
|
platform = target.platform
|
|
self.assertTrue(platform, VALID_PLATFORM)
|
|
|
|
@python_api_test
|
|
def test_get_data_byte_size(self):
|
|
d = {'EXE': 'b.out'}
|
|
self.build(dictionary=d)
|
|
self.setTearDownCleanup(dictionary=d)
|
|
target = self.create_simple_target('b.out')
|
|
self.assertEquals(target.data_byte_size, 1)
|
|
|
|
@python_api_test
|
|
def test_get_code_byte_size(self):
|
|
d = {'EXE': 'b.out'}
|
|
self.build(dictionary=d)
|
|
self.setTearDownCleanup(dictionary=d)
|
|
target = self.create_simple_target('b.out')
|
|
self.assertEquals(target.code_byte_size, 1)
|
|
|
|
@python_api_test
|
|
def test_resolve_file_address(self):
|
|
d = {'EXE': 'b.out'}
|
|
self.build(dictionary=d)
|
|
self.setTearDownCleanup(dictionary=d)
|
|
target = self.create_simple_target('b.out')
|
|
|
|
# find the file address in the .data section of the main
|
|
# module
|
|
data_section = self.find_data_section(target)
|
|
data_section_addr = data_section.file_addr
|
|
|
|
# resolve the above address, and compare the address produced
|
|
# by the resolution against the original address/section
|
|
res_file_addr = target.ResolveFileAddress(data_section_addr)
|
|
self.assertTrue(res_file_addr.IsValid())
|
|
|
|
self.assertEquals(data_section_addr, res_file_addr.file_addr)
|
|
|
|
data_section2 = res_file_addr.section
|
|
self.assertIsNotNone(data_section2)
|
|
self.assertEquals(data_section.name, data_section2.name)
|
|
|
|
@python_api_test
|
|
def test_read_memory(self):
|
|
d = {'EXE': 'b.out'}
|
|
self.build(dictionary=d)
|
|
self.setTearDownCleanup(dictionary=d)
|
|
target = self.create_simple_target('b.out')
|
|
|
|
breakpoint = target.BreakpointCreateByLocation("main.c", self.line_main)
|
|
self.assertTrue(breakpoint, VALID_BREAKPOINT)
|
|
|
|
# Put debugger into synchronous mode so when we target.LaunchSimple returns
|
|
# it will guaranteed to be at the breakpoint
|
|
self.dbg.SetAsync(False)
|
|
|
|
# Launch the process, and do not stop at the entry point.
|
|
process = target.LaunchSimple (None, None, self.get_process_working_directory())
|
|
|
|
# find the file address in the .data section of the main
|
|
# module
|
|
data_section = self.find_data_section(target)
|
|
sb_addr = lldb.SBAddress(data_section, 0)
|
|
error = lldb.SBError()
|
|
content = target.ReadMemory(sb_addr, 1, error)
|
|
self.assertTrue(error.Success(), "Make sure memory read succeeded")
|
|
self.assertEquals(len(content), 1)
|
|
|
|
def create_simple_target(self, fn):
|
|
exe = os.path.join(os.getcwd(), fn)
|
|
target = self.dbg.CreateTarget(exe)
|
|
self.assertTrue(target, VALID_TARGET)
|
|
return target
|
|
|
|
def find_data_section(self, target):
|
|
mod = target.GetModuleAtIndex(0)
|
|
data_section = None
|
|
for s in mod.sections:
|
|
sect_type = s.GetSectionType()
|
|
if sect_type == lldb.eSectionTypeData:
|
|
data_section = s
|
|
break
|
|
elif sect_type == lldb.eSectionTypeContainer:
|
|
for i in range(s.GetNumSubSections()):
|
|
ss = s.GetSubSectionAtIndex(i)
|
|
sect_type = ss.GetSectionType()
|
|
if sect_type == lldb.eSectionTypeData:
|
|
data_section = ss
|
|
break
|
|
|
|
self.assertIsNotNone(data_section)
|
|
return data_section
|
|
|
|
def find_global_variables(self, exe_name):
|
|
"""Exercise SBTaget.FindGlobalVariables() API."""
|
|
exe = os.path.join(os.getcwd(), exe_name)
|
|
|
|
# Create a target by the debugger.
|
|
target = self.dbg.CreateTarget(exe)
|
|
self.assertTrue(target, VALID_TARGET)
|
|
|
|
#rdar://problem/9700873
|
|
# Find global variable value fails for dwarf if inferior not started
|
|
# (Was CrashTracer: [USER] 1 crash in Python at _lldb.so: lldb_private::MemoryCache::Read + 94)
|
|
#
|
|
# Remove the lines to create a breakpoint and to start the inferior
|
|
# which are workarounds for the dwarf case.
|
|
|
|
breakpoint = target.BreakpointCreateByLocation('main.c', self.line1)
|
|
self.assertTrue(breakpoint, VALID_BREAKPOINT)
|
|
|
|
# Now launch the process, and do not stop at entry point.
|
|
process = target.LaunchSimple (None, None, self.get_process_working_directory())
|
|
self.assertTrue(process, PROCESS_IS_VALID)
|
|
# Make sure we hit our breakpoint:
|
|
thread_list = lldbutil.get_threads_stopped_at_breakpoint (process, breakpoint)
|
|
self.assertTrue (len(thread_list) == 1)
|
|
|
|
value_list = target.FindGlobalVariables('my_global_var_of_char_type', 3)
|
|
self.assertTrue(value_list.GetSize() == 1)
|
|
my_global_var = value_list.GetValueAtIndex(0)
|
|
self.DebugSBValue(my_global_var)
|
|
self.assertTrue(my_global_var)
|
|
self.expect(my_global_var.GetName(), exe=False,
|
|
startstr = "my_global_var_of_char_type")
|
|
self.expect(my_global_var.GetTypeName(), exe=False,
|
|
startstr = "char")
|
|
self.expect(my_global_var.GetValue(), exe=False,
|
|
startstr = "'X'")
|
|
|
|
# While we are at it, let's also exercise the similar SBModule.FindGlobalVariables() API.
|
|
for m in target.module_iter():
|
|
if os.path.normpath(m.GetFileSpec().GetDirectory()) == os.getcwd() and m.GetFileSpec().GetFilename() == exe_name:
|
|
value_list = m.FindGlobalVariables(target, 'my_global_var_of_char_type', 3)
|
|
self.assertTrue(value_list.GetSize() == 1)
|
|
self.assertTrue(value_list.GetValueAtIndex(0).GetValue() == "'X'")
|
|
break
|
|
|
|
def find_functions(self, exe_name):
|
|
"""Exercise SBTaget.FindFunctions() API."""
|
|
exe = os.path.join(os.getcwd(), exe_name)
|
|
|
|
# Create a target by the debugger.
|
|
target = self.dbg.CreateTarget(exe)
|
|
self.assertTrue(target, VALID_TARGET)
|
|
|
|
list = target.FindFunctions('c', lldb.eFunctionNameTypeAuto)
|
|
self.assertTrue(list.GetSize() == 1)
|
|
|
|
for sc in list:
|
|
self.assertTrue(sc.GetModule().GetFileSpec().GetFilename() == exe_name)
|
|
self.assertTrue(sc.GetSymbol().GetName() == 'c')
|
|
|
|
def get_description(self):
|
|
"""Exercise SBTaget.GetDescription() API."""
|
|
exe = os.path.join(os.getcwd(), "a.out")
|
|
|
|
# Create a target by the debugger.
|
|
target = self.dbg.CreateTarget(exe)
|
|
self.assertTrue(target, VALID_TARGET)
|
|
|
|
from lldbutil import get_description
|
|
|
|
# get_description() allows no option to mean lldb.eDescriptionLevelBrief.
|
|
desc = get_description(target)
|
|
#desc = get_description(target, option=lldb.eDescriptionLevelBrief)
|
|
if not desc:
|
|
self.fail("SBTarget.GetDescription() failed")
|
|
self.expect(desc, exe=False,
|
|
substrs = ['a.out'])
|
|
self.expect(desc, exe=False, matching=False,
|
|
substrs = ['Target', 'Module', 'Breakpoint'])
|
|
|
|
desc = get_description(target, option=lldb.eDescriptionLevelFull)
|
|
if not desc:
|
|
self.fail("SBTarget.GetDescription() failed")
|
|
self.expect(desc, exe=False,
|
|
substrs = ['a.out', 'Target', 'Module', 'Breakpoint'])
|
|
|
|
@not_remote_testsuite_ready
|
|
def launch_new_process_and_redirect_stdout(self):
|
|
"""Exercise SBTaget.Launch() API with redirected stdout."""
|
|
exe = os.path.join(os.getcwd(), "a.out")
|
|
|
|
# Create a target by the debugger.
|
|
target = self.dbg.CreateTarget(exe)
|
|
self.assertTrue(target, VALID_TARGET)
|
|
|
|
# Add an extra twist of stopping the inferior in a breakpoint, and then continue till it's done.
|
|
# We should still see the entire stdout redirected once the process is finished.
|
|
line = line_number('main.c', '// a(3) -> c(3)')
|
|
breakpoint = target.BreakpointCreateByLocation('main.c', line)
|
|
|
|
# Now launch the process, do not stop at entry point, and redirect stdout to "stdout.txt" file.
|
|
# The inferior should run to completion after "process.Continue()" call.
|
|
local_path = "stdout.txt";
|
|
if lldb.remote_platform:
|
|
stdout_path = lldbutil.append_to_process_working_directory("lldb-stdout-redirect.txt")
|
|
else:
|
|
stdout_path = local_path
|
|
error = lldb.SBError()
|
|
process = target.Launch (self.dbg.GetListener(), None, None, None, stdout_path, None, None, 0, False, error)
|
|
process.Continue()
|
|
#self.runCmd("process status")
|
|
if lldb.remote_platform:
|
|
# copy output file to host
|
|
lldb.remote_platform.Get(lldb.SBFileSpec(stdout_path), lldb.SBFileSpec(local_path))
|
|
|
|
# The 'stdout.txt' file should now exist.
|
|
self.assertTrue(os.path.isfile("stdout.txt"),
|
|
"'stdout.txt' exists due to redirected stdout via SBTarget.Launch() API.")
|
|
|
|
# Read the output file produced by running the program.
|
|
with open('stdout.txt', 'r') as f:
|
|
output = f.read()
|
|
|
|
# Let's delete the 'stdout.txt' file as a cleanup step.
|
|
try:
|
|
os.remove("stdout.txt")
|
|
pass
|
|
except OSError:
|
|
pass
|
|
|
|
self.expect(output, exe=False,
|
|
substrs = ["a(1)", "b(2)", "a(3)"])
|
|
|
|
|
|
def resolve_symbol_context_with_address(self):
|
|
"""Exercise SBTaget.ResolveSymbolContextForAddress() API."""
|
|
exe = os.path.join(os.getcwd(), "a.out")
|
|
|
|
# Create a target by the debugger.
|
|
target = self.dbg.CreateTarget(exe)
|
|
self.assertTrue(target, VALID_TARGET)
|
|
|
|
# Now create the two breakpoints inside function 'a'.
|
|
breakpoint1 = target.BreakpointCreateByLocation('main.c', self.line1)
|
|
breakpoint2 = target.BreakpointCreateByLocation('main.c', self.line2)
|
|
#print "breakpoint1:", breakpoint1
|
|
#print "breakpoint2:", breakpoint2
|
|
self.assertTrue(breakpoint1 and
|
|
breakpoint1.GetNumLocations() == 1,
|
|
VALID_BREAKPOINT)
|
|
self.assertTrue(breakpoint2 and
|
|
breakpoint2.GetNumLocations() == 1,
|
|
VALID_BREAKPOINT)
|
|
|
|
# Now launch the process, and do not stop at entry point.
|
|
process = target.LaunchSimple (None, None, self.get_process_working_directory())
|
|
self.assertTrue(process, PROCESS_IS_VALID)
|
|
|
|
# Frame #0 should be on self.line1.
|
|
self.assertTrue(process.GetState() == lldb.eStateStopped)
|
|
thread = lldbutil.get_stopped_thread(process, lldb.eStopReasonBreakpoint)
|
|
self.assertTrue(thread.IsValid(), "There should be a thread stopped due to breakpoint condition")
|
|
#self.runCmd("process status")
|
|
frame0 = thread.GetFrameAtIndex(0)
|
|
lineEntry = frame0.GetLineEntry()
|
|
self.assertTrue(lineEntry.GetLine() == self.line1)
|
|
|
|
address1 = lineEntry.GetStartAddress()
|
|
|
|
# Continue the inferior, the breakpoint 2 should be hit.
|
|
process.Continue()
|
|
self.assertTrue(process.GetState() == lldb.eStateStopped)
|
|
thread = lldbutil.get_stopped_thread(process, lldb.eStopReasonBreakpoint)
|
|
self.assertTrue(thread.IsValid(), "There should be a thread stopped due to breakpoint condition")
|
|
#self.runCmd("process status")
|
|
frame0 = thread.GetFrameAtIndex(0)
|
|
lineEntry = frame0.GetLineEntry()
|
|
self.assertTrue(lineEntry.GetLine() == self.line2)
|
|
|
|
address2 = lineEntry.GetStartAddress()
|
|
|
|
#print "address1:", address1
|
|
#print "address2:", address2
|
|
|
|
# Now call SBTarget.ResolveSymbolContextForAddress() with the addresses from our line entry.
|
|
context1 = target.ResolveSymbolContextForAddress(address1, lldb.eSymbolContextEverything)
|
|
context2 = target.ResolveSymbolContextForAddress(address2, lldb.eSymbolContextEverything)
|
|
|
|
self.assertTrue(context1 and context2)
|
|
#print "context1:", context1
|
|
#print "context2:", context2
|
|
|
|
# Verify that the context point to the same function 'a'.
|
|
symbol1 = context1.GetSymbol()
|
|
symbol2 = context2.GetSymbol()
|
|
self.assertTrue(symbol1 and symbol2)
|
|
#print "symbol1:", symbol1
|
|
#print "symbol2:", symbol2
|
|
|
|
from lldbutil import get_description
|
|
desc1 = get_description(symbol1)
|
|
desc2 = get_description(symbol2)
|
|
self.assertTrue(desc1 and desc2 and desc1 == desc2,
|
|
"The two addresses should resolve to the same symbol")
|
|
|
|
|
|
if __name__ == '__main__':
|
|
import atexit
|
|
lldb.SBDebugger.Initialize()
|
|
atexit.register(lambda: lldb.SBDebugger.Terminate())
|
|
unittest2.main()
|