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        self.expect_expr("shadowed_one.member", result_value="47")
67        self.expect_expr("shadowed_one.one", result_value="142")
68
69    @skipIf(bugnumber="pr46284", debug_info="gmodules")
70    @skipIfWindows # Clang emits type info even with -flimit-debug-info
71    def test_two_debug(self):
72        self.build(dictionary=dict(STRIP_ONE="1"))
73        target = self.dbg.CreateTarget(self.getBuildArtifact("a.out"))
74
75        self._check_debug_info_is_limited(target)
76
77        lldbutil.run_to_name_breakpoint(self, "main",
78                extra_images=["one", "two"])
79
80        # This time, we should only see the members from the second library.
81        self.expect_expr("inherits_from_one.member", result_value="47")
82        self.expect("expr inherits_from_one.one", error=True,
83            substrs=["no member named 'one' in 'InheritsFromOne'"])
84        self.expect_expr("inherits_from_two.member", result_value="47")
85        self.expect("expr inherits_from_two.one", error=True,
86            substrs=["no member named 'one' in 'InheritsFromTwo'"])
87        self.expect_expr("inherits_from_two.two", result_value="242")
88
89        self.expect_expr("one_as_member.member", result_value="47")
90        self.expect("expr one_as_member.one.member", error=True,
91                substrs=["no member named 'member' in 'member::One'"])
92        self.expect_expr("two_as_member.member", result_value="47")
93        self.expect("expr two_as_member.two.one.member", error=True,
94                substrs=["no member named 'member' in 'member::One'"])
95        self.expect_expr("two_as_member.two.member", result_value="247")
96
97        self.expect("expr array_of_one[2].member", error=True,
98                substrs=["no member named 'member' in 'array::One'"])
99        self.expect("expr array_of_two[2].one[2].member", error=True,
100                substrs=["no member named 'member' in 'array::One'"])
101        self.expect_expr("array_of_two[2].member", result_value="274")
102
103        self.expect("expr get_one().member", error=True,
104                substrs=["calling 'get_one' with incomplete return type 'result::One'"])
105        self.expect("expr get_two().one().member", error=True,
106                substrs=["calling 'one' with incomplete return type 'result::One'"])
107        self.expect_expr("get_two().member", result_value="224")
108
109    @skipIf(bugnumber="pr46284", debug_info="gmodules")
110    @skipIfWindows # Clang emits type info even with -flimit-debug-info
111    def test_one_debug(self):
112        self.build(dictionary=dict(STRIP_TWO="1"))
113        target = self.dbg.CreateTarget(self.getBuildArtifact("a.out"))
114
115        self._check_debug_info_is_limited(target)
116
117        lldbutil.run_to_name_breakpoint(self, "main",
118                extra_images=["one", "two"])
119
120        # In this case we should only see the members from the second library.
121        # Note that we cannot see inherits_from_two.one because without debug
122        # info for "Two", we cannot determine that it in fact inherits from
123        # "One".
124        self.expect_expr("inherits_from_one.member", result_value="47")
125        self.expect_expr("inherits_from_one.one", result_value="142")
126        self.expect_expr("inherits_from_two.member", result_value="47")
127        self.expect("expr inherits_from_two.one", error=True,
128            substrs=["no member named 'one' in 'InheritsFromTwo'"])
129        self.expect("expr inherits_from_two.two", error=True,
130            substrs=["no member named 'two' in 'InheritsFromTwo'"])
131
132        self.expect_expr("one_as_member.member", result_value="47")
133        self.expect_expr("one_as_member.one.member", result_value="147")
134        self.expect_expr("two_as_member.member", result_value="47")
135        self.expect("expr two_as_member.two.one.member", error=True,
136                substrs=["no member named 'one' in 'member::Two'"])
137        self.expect("expr two_as_member.two.member", error=True,
138                substrs=["no member named 'member' in 'member::Two'"])
139
140        self.expect_expr("array_of_one[2].member", result_value="174")
141        self.expect("expr array_of_two[2].one[2].member", error=True,
142                substrs=["no member named 'one' in 'array::Two'"])
143        self.expect("expr array_of_two[2].member", error=True,
144                substrs=["no member named 'member' in 'array::Two'"])
145
146        self.expect_expr("get_one().member", result_value="124")
147        self.expect("expr get_two().one().member", error=True,
148                substrs=["calling 'get_two' with incomplete return type 'result::Two'"])
149        self.expect("expr get_two().member", error=True,
150                substrs=["calling 'get_two' with incomplete return type 'result::Two'"])
151