Make destructor breakpoint location test more resilient

[labath]

Summary

The original breakpoint location test was failing for linux, because the compilers here tend to
merge the full-object and subobject destructors even at -O0 (as a result, we are getting only 2
breakpoint locations, and not 4 as the test expected. The fixup in r266164 substantially weakened
the test, as it now did not check whether both kinds of destructors were being found.

Because of these contraints, I have altered the logic of the test. It sets the
breakpoint by name, and then independently verifies that the breakpoint is set on the correct
demangled symbol name (which is not very meaningful since both kinds of destructors demangle to
the same name) *and* the correct symbol address (which is obtained by looking up the mangled
symbol name).

[clayborg]

Looks good.

[labath]

One more tweak to make the test work on linux clang: I've needed to move the constructors out-of-line to make sure the compiler generates the expected symbols.

lldb/trunk/packages/Python/lldbsuite/test/functionalities/breakpoint/cpp/TestCPPBreakpointLocations.py

def test (self):
         self.build ()
         self.breakpoint_id_tests ()
 
     def verify_breakpoint_locations(self, target, bp_dict):
         
         name = bp_dict['name']
         names = bp_dict['loc_names']
         bp = target.BreakpointCreateByName (name)
-        self.assertTrue (bp.GetNumLocations() <= len(names), "Make sure we find the right number of breakpoint locations")
+        self.assertEquals(bp.GetNumLocations(), len(names), "Make sure we find the right number of breakpoint locations")
         
         bp_loc_names = list()
         for bp_loc in bp:
             bp_loc_names.append(bp_loc.GetAddress().GetFunction().GetName())
             
         for name in names:
             found = name in bp_loc_names
             if not found:
                 print("Didn't find '%s' in: %s" % (name, bp_loc_names))
             self.assertTrue (found, "Make sure we find all required locations")
         
     def breakpoint_id_tests (self):
         
         # Create a target by the debugger.
         exe = os.path.join(os.getcwd(), "a.out")
         target = self.dbg.CreateTarget(exe)
         self.assertTrue(target, VALID_TARGET)
         bp_dicts = [
             { 'name' : 'func1', 'loc_names' : [ 'a::c::func1()', 'b::c::func1()'] },
             { 'name' : 'func2', 'loc_names' : [ 'a::c::func2()', 'c::d::func2()'] },
             { 'name' : 'func3', 'loc_names' : [ 'a::c::func3()', 'b::c::func3()', 'c::d::func3()'] },
-            { 'name' : '~c', 'loc_names' : [ 'a::c::~c()', 'b::c::~c()', 'a::c::~c()', 'b::c::~c()'] },
             { 'name' : 'c::func1', 'loc_names' : [ 'a::c::func1()', 'b::c::func1()'] },
             { 'name' : 'c::func2', 'loc_names' : [ 'a::c::func2()'] },
             { 'name' : 'c::func3', 'loc_names' : [ 'a::c::func3()', 'b::c::func3()'] },
-            { 'name' : 'c::~c', 'loc_names' : [ 'a::c::~c()', 'b::c::~c()', 'a::c::~c()', 'b::c::~c()'] },
             { 'name' : 'a::c::func1', 'loc_names' : [ 'a::c::func1()'] },
             { 'name' : 'b::c::func1', 'loc_names' : [ 'b::c::func1()'] },
             { 'name' : 'c::d::func2', 'loc_names' : [ 'c::d::func2()'] },
             { 'name' : 'a::c::func1()', 'loc_names' : [ 'a::c::func1()'] },
             { 'name' : 'b::c::func1()', 'loc_names' : [ 'b::c::func1()'] },
             { 'name' : 'c::d::func2()', 'loc_names' : [ 'c::d::func2()'] },
-            { 'name' : 'c::~c()', 'loc_names' : [ 'a::c::~c()', 'b::c::~c()', 'a::c::~c()', 'b::c::~c()'] },
         ]
         
         for bp_dict in bp_dicts:
             self.verify_breakpoint_locations(target, bp_dict)
+
+    @expectedFailureAll(oslist=["windows"], bugnumber="llvm.org/pr24764")
+    def test_destructors(self):
+        self.build()
+        exe = os.path.join(os.getcwd(), "a.out")
+        target = self.dbg.CreateTarget(exe)
+
+        # Don't skip prologue, so we can check the breakpoint address more easily
+        self.runCmd("settings set target.skip-prologue false")
+        try:
+            names = ['~c', 'c::~c', 'c::~c()']
+            loc_names = {'a::c::~c()', 'b::c::~c()'}
+            # TODO: For windows targets we should put windows mangled names here
+            symbols = ['_ZN1a1cD1Ev', '_ZN1a1cD2Ev', '_ZN1b1cD1Ev', '_ZN1b1cD2Ev']
+
+            for name in names:
+                bp = target.BreakpointCreateByName(name)
+
+                bp_loc_names = { bp_loc.GetAddress().GetFunction().GetName() for bp_loc in bp }
+                self.assertEquals(bp_loc_names, loc_names, "Breakpoint set on the correct symbol")
+
+                bp_addresses = { bp_loc.GetLoadAddress() for bp_loc in bp }
+                symbol_addresses = set()
+                for symbol in symbols:
+                    sc_list = target.FindSymbols(symbol, lldb.eSymbolTypeCode)
+                    self.assertEquals(sc_list.GetSize(), 1, "Found symbol " + symbol)
+                    symbol = sc_list.GetContextAtIndex(0).GetSymbol()
+                    symbol_addresses.add(symbol.GetStartAddress().GetLoadAddress(target))
+
+                self.assertEquals(symbol_addresses, bp_addresses, "Breakpoint set on correct address")
+        finally:
+            self.runCmd("settings clear target.skip-prologue")

lldb/trunk/packages/Python/lldbsuite/test/functionalities/breakpoint/cpp/main.cpp

 //===-- main.cpp ------------------------------------------------*- C++ -*-===//
 //
 //                     The LLVM Compiler Infrastructure
 //
 // This file is distributed under the University of Illinois Open Source
 // License. See LICENSE.TXT for details.
 //
 //===----------------------------------------------------------------------===//
 #include <stdio.h>
 #include <stdint.h>
 
 namespace a {
     class c {
     public:
-        c () {}
-        ~c() {}
+        c();
+        ~c();
         void func1() 
         {
             puts (__PRETTY_FUNCTION__);
         }
         void func2() 
         {
             puts (__PRETTY_FUNCTION__);
         }
         void func3() 
         {
             puts (__PRETTY_FUNCTION__);
         }
     };
+
+    c::c() {}
+    c::~c() {}
 }
 
 namespace b {
     class c {
     public:
-        c () {}
-        ~c() {}
+        c();
+        ~c();
         void func1() 
         {
             puts (__PRETTY_FUNCTION__);
         }
         void func3() 
         {
             puts (__PRETTY_FUNCTION__);
         }
     };
+
+    c::c() {}
+    c::~c() {}
 }
 
 namespace c {
     class d {
     public:
         d () {}
         ~d() {}
         void func2()