1"""
2Test completing types using information from other shared libraries.
3"""
4
5import os
6import lldb
7from lldbsuite.test.decorators import *
8from lldbsuite.test.lldbtest import *
9from lldbsuite.test import lldbutil
10
11
12class LimitDebugInfoTestCase(TestBase):
13
14    mydir = TestBase.compute_mydir(__file__)
15
16    def _check_type(self, target, name):
17        exe = target.FindModule(lldb.SBFileSpec("a.out"))
18        type_ = exe.FindFirstType(name)
19        self.trace("type_: %s"%type_)
20        self.assertTrue(type_)
21        base = type_.GetDirectBaseClassAtIndex(0).GetType()
22        self.trace("base:%s"%base)
23        self.assertTrue(base)
24        self.assertEquals(base.GetNumberOfFields(), 0)
25
26    def _check_debug_info_is_limited(self, target):
27        # Without other shared libraries we should only see the member declared
28        # in the derived class. This serves as a sanity check that we are truly
29        # building with limited debug info.
30        self._check_type(target, "InheritsFromOne")
31        self._check_type(target, "InheritsFromTwo")
32
33    @skipIf(bugnumber="pr46284", debug_info="gmodules")
34    @skipIfWindows # Clang emits type info even with -flimit-debug-info
35    def test_one_and_two_debug(self):
36        self.build()
37        target = self.dbg.CreateTarget(self.getBuildArtifact("a.out"))
38
39        self._check_debug_info_is_limited(target)
40
41        lldbutil.run_to_name_breakpoint(self, "main",
42                extra_images=["one", "two"])
43
44        # But when other shared libraries are loaded, we should be able to see
45        # all members.
46        self.expect_expr("inherits_from_one.member", result_value="47")
47        self.expect_expr("inherits_from_one.one", result_value="142")
48        self.expect_expr("inherits_from_two.member", result_value="47")
49        self.expect_expr("inherits_from_two.one", result_value="142")
50        self.expect_expr("inherits_from_two.two", result_value="242")
51
52        self.expect_expr("one_as_member.member", result_value="47")
53        self.expect_expr("one_as_member.one.member", result_value="147")
54        self.expect_expr("two_as_member.member", result_value="47")
55        self.expect_expr("two_as_member.two.one.member", result_value="147")
56        self.expect_expr("two_as_member.two.member", result_value="247")
57
58        self.expect_expr("array_of_one[2].member", result_value="174")
59        self.expect_expr("array_of_two[2].one[2].member", result_value="174")
60        self.expect_expr("array_of_two[2].member", result_value="274")
61
62        self.expect_expr("get_one().member", result_value="124")
63        self.expect_expr("get_two().one().member", result_value="124")
64        self.expect_expr("get_two().member", result_value="224")
65
66    @skipIf(bugnumber="pr46284", debug_info="gmodules")
67    @skipIfWindows # Clang emits type info even with -flimit-debug-info
68    def test_two_debug(self):
69        self.build(dictionary=dict(STRIP_ONE="1"))
70        target = self.dbg.CreateTarget(self.getBuildArtifact("a.out"))
71
72        self._check_debug_info_is_limited(target)
73
74        lldbutil.run_to_name_breakpoint(self, "main",
75                extra_images=["one", "two"])
76
77        # This time, we should only see the members from the second library.
78        self.expect_expr("inherits_from_one.member", result_value="47")
79        self.expect("expr inherits_from_one.one", error=True,
80            substrs=["no member named 'one' in 'InheritsFromOne'"])
81        self.expect_expr("inherits_from_two.member", result_value="47")
82        self.expect("expr inherits_from_two.one", error=True,
83            substrs=["no member named 'one' in 'InheritsFromTwo'"])
84        self.expect_expr("inherits_from_two.two", result_value="242")
85
86        self.expect_expr("one_as_member.member", result_value="47")
87        self.expect("expr one_as_member.one.member", error=True,
88                substrs=["no member named 'member' in 'member::One'"])
89        self.expect_expr("two_as_member.member", result_value="47")
90        self.expect("expr two_as_member.two.one.member", error=True,
91                substrs=["no member named 'member' in 'member::One'"])
92        self.expect_expr("two_as_member.two.member", result_value="247")
93
94        self.expect("expr array_of_one[2].member", error=True,
95                substrs=["no member named 'member' in 'array::One'"])
96        self.expect("expr array_of_two[2].one[2].member", error=True,
97                substrs=["no member named 'member' in 'array::One'"])
98        self.expect_expr("array_of_two[2].member", result_value="274")
99
100        self.expect("expr get_one().member", error=True,
101                substrs=["calling 'get_one' with incomplete return type 'result::One'"])
102        self.expect("expr get_two().one().member", error=True,
103                substrs=["calling 'one' with incomplete return type 'result::One'"])
104        self.expect_expr("get_two().member", result_value="224")
105
106    @skipIf(bugnumber="pr46284", debug_info="gmodules")
107    @skipIfWindows # Clang emits type info even with -flimit-debug-info
108    def test_one_debug(self):
109        self.build(dictionary=dict(STRIP_TWO="1"))
110        target = self.dbg.CreateTarget(self.getBuildArtifact("a.out"))
111
112        self._check_debug_info_is_limited(target)
113
114        lldbutil.run_to_name_breakpoint(self, "main",
115                extra_images=["one", "two"])
116
117        # In this case we should only see the members from the second library.
118        # Note that we cannot see inherits_from_two.one because without debug
119        # info for "Two", we cannot determine that it in fact inherits from
120        # "One".
121        self.expect_expr("inherits_from_one.member", result_value="47")
122        self.expect_expr("inherits_from_one.one", result_value="142")
123        self.expect_expr("inherits_from_two.member", result_value="47")
124        self.expect("expr inherits_from_two.one", error=True,
125            substrs=["no member named 'one' in 'InheritsFromTwo'"])
126        self.expect("expr inherits_from_two.two", error=True,
127            substrs=["no member named 'two' in 'InheritsFromTwo'"])
128
129        self.expect_expr("one_as_member.member", result_value="47")
130        self.expect_expr("one_as_member.one.member", result_value="147")
131        self.expect_expr("two_as_member.member", result_value="47")
132        self.expect("expr two_as_member.two.one.member", error=True,
133                substrs=["no member named 'one' in 'member::Two'"])
134        self.expect("expr two_as_member.two.member", error=True,
135                substrs=["no member named 'member' in 'member::Two'"])
136
137        self.expect_expr("array_of_one[2].member", result_value="174")
138        self.expect("expr array_of_two[2].one[2].member", error=True,
139                substrs=["no member named 'one' in 'array::Two'"])
140        self.expect("expr array_of_two[2].member", error=True,
141                substrs=["no member named 'member' in 'array::Two'"])
142
143        self.expect_expr("get_one().member", result_value="124")
144        self.expect("expr get_two().one().member", error=True,
145                substrs=["calling 'get_two' with incomplete return type 'result::Two'"])
146        self.expect("expr get_two().member", error=True,
147                substrs=["calling 'get_two' with incomplete return type 'result::Two'"])
148