xref: /llvm-project/lldb/packages/Python/lldbsuite/test/lldbinline.py (revision b9c1b51e45b845debb76d8658edabca70ca56079)
1from __future__ import print_function
2from __future__ import absolute_import
3
4# System modules
5import os
6
7# Third-party modules
8
9# LLDB modules
10import lldb
11from .lldbtest import *
12from . import configuration
13from . import lldbutil
14from .decorators import *
15
16
17def source_type(filename):
18    _, extension = os.path.splitext(filename)
19    return {
20        '.c': 'C_SOURCES',
21        '.cpp': 'CXX_SOURCES',
22        '.cxx': 'CXX_SOURCES',
23        '.cc': 'CXX_SOURCES',
24        '.m': 'OBJC_SOURCES',
25        '.mm': 'OBJCXX_SOURCES'
26    }.get(extension, None)
27
28
29class CommandParser:
30
31    def __init__(self):
32        self.breakpoints = []
33
34    def parse_one_command(self, line):
35        parts = line.split('//%')
36
37        command = None
38        new_breakpoint = True
39
40        if len(parts) == 2:
41            command = parts[1].strip()  # take off whitespace
42            new_breakpoint = parts[0].strip() != ""
43
44        return (command, new_breakpoint)
45
46    def parse_source_files(self, source_files):
47        for source_file in source_files:
48            file_handle = open(source_file)
49            lines = file_handle.readlines()
50            line_number = 0
51            # non-NULL means we're looking through whitespace to find
52            # additional commands
53            current_breakpoint = None
54            for line in lines:
55                line_number = line_number + 1  # 1-based, so we do this first
56                (command, new_breakpoint) = self.parse_one_command(line)
57
58                if new_breakpoint:
59                    current_breakpoint = None
60
61                if command is not None:
62                    if current_breakpoint is None:
63                        current_breakpoint = {}
64                        current_breakpoint['file_name'] = source_file
65                        current_breakpoint['line_number'] = line_number
66                        current_breakpoint['command'] = command
67                        self.breakpoints.append(current_breakpoint)
68                    else:
69                        current_breakpoint['command'] = current_breakpoint[
70                            'command'] + "\n" + command
71
72    def set_breakpoints(self, target):
73        for breakpoint in self.breakpoints:
74            breakpoint['breakpoint'] = target.BreakpointCreateByLocation(
75                breakpoint['file_name'], breakpoint['line_number'])
76
77    def handle_breakpoint(self, test, breakpoint_id):
78        for breakpoint in self.breakpoints:
79            if breakpoint['breakpoint'].GetID() == breakpoint_id:
80                test.execute_user_command(breakpoint['command'])
81                return
82
83
84class InlineTest(TestBase):
85    # Internal implementation
86
87    def getRerunArgs(self):
88        # The -N option says to NOT run a if it matches the option argument, so
89        # if we are using dSYM we say to NOT run dwarf (-N dwarf) and vice
90        # versa.
91        if self.using_dsym is None:
92            # The test was skipped altogether.
93            return ""
94        elif self.using_dsym:
95            return "-N dwarf %s" % (self.mydir)
96        else:
97            return "-N dsym %s" % (self.mydir)
98
99    def BuildMakefile(self):
100        if os.path.exists("Makefile"):
101            return
102
103        categories = {}
104
105        for f in os.listdir(os.getcwd()):
106            t = source_type(f)
107            if t:
108                if t in list(categories.keys()):
109                    categories[t].append(f)
110                else:
111                    categories[t] = [f]
112
113        makefile = open("Makefile", 'w+')
114
115        level = os.sep.join(
116            [".."] * len(self.mydir.split(os.sep))) + os.sep + "make"
117
118        makefile.write("LEVEL = " + level + "\n")
119
120        for t in list(categories.keys()):
121            line = t + " := " + " ".join(categories[t])
122            makefile.write(line + "\n")
123
124        if ('OBJCXX_SOURCES' in list(categories.keys())) or (
125                'OBJC_SOURCES' in list(categories.keys())):
126            makefile.write(
127                "LDFLAGS = $(CFLAGS) -lobjc -framework Foundation\n")
128
129        if ('CXX_SOURCES' in list(categories.keys())):
130            makefile.write("CXXFLAGS += -std=c++11\n")
131
132        makefile.write("include $(LEVEL)/Makefile.rules\n")
133        makefile.write("\ncleanup:\n\trm -f Makefile *.d\n\n")
134        makefile.flush()
135        makefile.close()
136
137    @skipUnlessDarwin
138    def __test_with_dsym(self):
139        self.using_dsym = True
140        self.BuildMakefile()
141        self.buildDsym()
142        self.do_test()
143
144    def __test_with_dwarf(self):
145        self.using_dsym = False
146        self.BuildMakefile()
147        self.buildDwarf()
148        self.do_test()
149
150    def __test_with_dwo(self):
151        self.using_dsym = False
152        self.BuildMakefile()
153        self.buildDwo()
154        self.do_test()
155
156    def __test_with_gmodules(self):
157        self.using_dsym = False
158        self.BuildMakefile()
159        self.buildGModules()
160        self.do_test()
161
162    def execute_user_command(self, __command):
163        exec(__command, globals(), locals())
164
165    def do_test(self):
166        exe_name = "a.out"
167        exe = os.path.join(os.getcwd(), exe_name)
168        source_files = [f for f in os.listdir(os.getcwd()) if source_type(f)]
169        target = self.dbg.CreateTarget(exe)
170
171        parser = CommandParser()
172        parser.parse_source_files(source_files)
173        parser.set_breakpoints(target)
174
175        process = target.LaunchSimple(None, None, os.getcwd())
176
177        while lldbutil.get_stopped_thread(process, lldb.eStopReasonBreakpoint):
178            thread = lldbutil.get_stopped_thread(
179                process, lldb.eStopReasonBreakpoint)
180            breakpoint_id = thread.GetStopReasonDataAtIndex(0)
181            parser.handle_breakpoint(self, breakpoint_id)
182            process.Continue()
183
184    # Utilities for testcases
185
186    def check_expression(self, expression, expected_result, use_summary=True):
187        value = self.frame().EvaluateExpression(expression)
188        self.assertTrue(value.IsValid(), expression + "returned a valid value")
189        if self.TraceOn():
190            print(value.GetSummary())
191            print(value.GetValue())
192        if use_summary:
193            answer = value.GetSummary()
194        else:
195            answer = value.GetValue()
196        report_str = "%s expected: %s got: %s" % (
197            expression, expected_result, answer)
198        self.assertTrue(answer == expected_result, report_str)
199
200
201def ApplyDecoratorsToFunction(func, decorators):
202    tmp = func
203    if isinstance(decorators, list):
204        for decorator in decorators:
205            tmp = decorator(tmp)
206    elif hasattr(decorators, '__call__'):
207        tmp = decorators(tmp)
208    return tmp
209
210
211def MakeInlineTest(__file, __globals, decorators=None):
212    # Adjust the filename if it ends in .pyc.  We want filenames to
213    # reflect the source python file, not the compiled variant.
214    if __file is not None and __file.endswith(".pyc"):
215        # Strip the trailing "c"
216        __file = __file[0:-1]
217
218    # Derive the test name from the current file name
219    file_basename = os.path.basename(__file)
220    InlineTest.mydir = TestBase.compute_mydir(__file)
221
222    test_name, _ = os.path.splitext(file_basename)
223    # Build the test case
224    test = type(test_name, (InlineTest,), {'using_dsym': None})
225    test.name = test_name
226
227    target_platform = lldb.DBG.GetSelectedPlatform().GetTriple().split('-')[2]
228    if test_categories.is_supported_on_platform(
229            "dsym", target_platform, configuration.compilers):
230        test.test_with_dsym = ApplyDecoratorsToFunction(
231            test._InlineTest__test_with_dsym, decorators)
232    if test_categories.is_supported_on_platform(
233            "dwarf", target_platform, configuration.compilers):
234        test.test_with_dwarf = ApplyDecoratorsToFunction(
235            test._InlineTest__test_with_dwarf, decorators)
236    if test_categories.is_supported_on_platform(
237            "dwo", target_platform, configuration.compilers):
238        test.test_with_dwo = ApplyDecoratorsToFunction(
239            test._InlineTest__test_with_dwo, decorators)
240    if test_categories.is_supported_on_platform(
241            "gmodules", target_platform, configuration.compilers):
242        test.test_with_gmodules = ApplyDecoratorsToFunction(
243            test._InlineTest__test_with_gmodules, decorators)
244
245    # Add the test case to the globals, and hide InlineTest
246    __globals.update({test_name: test})
247
248    # Keep track of the original test filename so we report it
249    # correctly in test results.
250    test.test_filename = __file
251    return test
252