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