Merge pull request swiftlang#455 from adrian-prantl/57756763-master

Cherry-pick fix for rdar://57756763

Author: adrian-prantl

lldb/include/lldb/DataFormatters/FormatCache.h

@@ -33,36 +33,22 @@ class FormatCache {
 
   public:
     Entry();
-    Entry(lldb::TypeFormatImplSP);
-    Entry(lldb::TypeSummaryImplSP);
-    Entry(lldb::SyntheticChildrenSP);
-    Entry(lldb::TypeValidatorImplSP);
-    Entry(lldb::TypeFormatImplSP, lldb::TypeSummaryImplSP,
-          lldb::SyntheticChildrenSP, lldb::TypeValidatorImplSP);
 
+    template<typename ImplSP> bool IsCached();
     bool IsFormatCached();
-
     bool IsSummaryCached();
-
     bool IsSyntheticCached();
-
     bool IsValidatorCached();
 
-    lldb::TypeFormatImplSP GetFormat();
-
-    lldb::TypeSummaryImplSP GetSummary();
-
-    lldb::SyntheticChildrenSP GetSynthetic();
-
-    lldb::TypeValidatorImplSP GetValidator();
-
-    void SetFormat(lldb::TypeFormatImplSP);
-
-    void SetSummary(lldb::TypeSummaryImplSP);
-
-    void SetSynthetic(lldb::SyntheticChildrenSP);
+    void Get(lldb::TypeFormatImplSP &);
+    void Get(lldb::TypeSummaryImplSP &);
+    void Get(lldb::SyntheticChildrenSP &);
+    void Get(lldb::TypeValidatorImplSP &);
 
-    void SetValidator(lldb::TypeValidatorImplSP);
+    void Set(lldb::TypeFormatImplSP);
+    void Set(lldb::TypeSummaryImplSP);
+    void Set(lldb::SyntheticChildrenSP);
+    void Set(lldb::TypeValidatorImplSP);
   };
   typedef std::map<ConstString, Entry> CacheMap;
   CacheMap m_map;
@@ -76,32 +62,19 @@ class FormatCache {
 public:
   FormatCache();
 
-  bool GetFormat(ConstString type, lldb::TypeFormatImplSP &format_sp);
-
-  bool GetSummary(ConstString type, lldb::TypeSummaryImplSP &summary_sp);
-
-  bool GetSynthetic(ConstString type,
-                    lldb::SyntheticChildrenSP &synthetic_sp);
-
-  bool GetValidator(ConstString type,
-                    lldb::TypeValidatorImplSP &summary_sp);
-
-  void SetFormat(ConstString type, lldb::TypeFormatImplSP &format_sp);
-
-  void SetSummary(ConstString type, lldb::TypeSummaryImplSP &summary_sp);
-
-  void SetSynthetic(ConstString type,
-                    lldb::SyntheticChildrenSP &synthetic_sp);
-
-  void SetValidator(ConstString type,
-                    lldb::TypeValidatorImplSP &synthetic_sp);
+  template <typename ImplSP> bool Get(ConstString type, ImplSP &format_impl_sp);
+  void Set(ConstString type, lldb::TypeFormatImplSP &format_sp);
+  void Set(ConstString type, lldb::TypeSummaryImplSP &summary_sp);
+  void Set(ConstString type, lldb::SyntheticChildrenSP &synthetic_sp);
+  void Set(ConstString type, lldb::TypeValidatorImplSP &synthetic_sp);
 
   void Clear();
 
   uint64_t GetCacheHits() { return m_cache_hits; }
 
   uint64_t GetCacheMisses() { return m_cache_misses; }
 };
+
 } // namespace lldb_private
 
 #endif // lldb_FormatCache_h_

lldb/include/lldb/DataFormatters/FormatManager.h

@@ -221,14 +221,10 @@ class FormatManager : public IFormatChangeListener {
   ConstString m_vectortypes_category_name;
   ConstString m_runtime_synths_category_name;
 
-  lldb::TypeFormatImplSP GetHardcodedFormat(FormattersMatchData &);
-
-  lldb::TypeSummaryImplSP GetHardcodedSummaryFormat(FormattersMatchData &);
-
-  lldb::SyntheticChildrenSP
-  GetHardcodedSyntheticChildren(FormattersMatchData &);
-
-  lldb::TypeValidatorImplSP GetHardcodedValidator(FormattersMatchData &);
+  template <typename ImplSP>
+  ImplSP Get(ValueObject &valobj, lldb::DynamicValueType use_dynamic);
+  template <typename ImplSP> ImplSP GetCached(FormattersMatchData &match_data);
+  template <typename ImplSP> ImplSP GetHardcoded(FormattersMatchData &);
 
   TypeCategoryMap &GetCategories() { return m_categories_map; }
 

lldb/include/lldb/DataFormatters/TypeCategory.h

@@ -333,16 +333,16 @@ class TypeCategoryImpl {
       return m_enabled_position;
   }
 
-  bool Get(ValueObject &valobj, const FormattersMatchVector &candidates,
+  bool Get(lldb::LanguageType lang, const FormattersMatchVector &candidates,
            lldb::TypeFormatImplSP &entry, uint32_t *reason = nullptr);
 
-  bool Get(ValueObject &valobj, const FormattersMatchVector &candidates,
+  bool Get(lldb::LanguageType lang, const FormattersMatchVector &candidates,
            lldb::TypeSummaryImplSP &entry, uint32_t *reason = nullptr);
 
-  bool Get(ValueObject &valobj, const FormattersMatchVector &candidates,
+  bool Get(lldb::LanguageType lang, const FormattersMatchVector &candidates,
            lldb::SyntheticChildrenSP &entry, uint32_t *reason = nullptr);
 
-  bool Get(ValueObject &valobj, const FormattersMatchVector &candidates,
+  bool Get(lldb::LanguageType lang, const FormattersMatchVector &candidates,
            lldb::TypeValidatorImplSP &entry, uint32_t *reason = nullptr);
 
   void Clear(FormatCategoryItems items = ALL_ITEM_TYPES);
@@ -394,7 +394,7 @@ class TypeCategoryImpl {
 
   void Disable() { Enable(false, UINT32_MAX); }
 
-  bool IsApplicable(ValueObject &valobj);
+  bool IsApplicable(lldb::LanguageType lang);
 
   uint32_t GetLastEnabledPosition() { return m_enabled_position; }
 

lldb/include/lldb/DataFormatters/TypeCategoryMap.h

@@ -77,14 +77,7 @@ class TypeCategoryMap {
 
   uint32_t GetCount() { return m_map.size(); }
 
-  lldb::TypeFormatImplSP GetFormat(FormattersMatchData &match_data);
-
-  lldb::TypeSummaryImplSP GetSummaryFormat(FormattersMatchData &match_data);
-
-  lldb::SyntheticChildrenSP
-  GetSyntheticChildren(FormattersMatchData &match_data);
-
-  lldb::TypeValidatorImplSP GetValidator(FormattersMatchData &match_data);
+  template <typename ImplSP> void Get(FormattersMatchData &, ImplSP &);
 
 private:
   class delete_matching_categories {

lldb/packages/Python/lldbsuite/test/functionalities/data-formatter/data-formatter-caching/Makefile

@@ -0,0 +1,3 @@
+C_SOURCES := a.c b.c
+
+include Makefile.rules

lldb/packages/Python/lldbsuite/test/functionalities/data-formatter/data-formatter-caching/TestDataFormatterCaching.py

@@ -0,0 +1,27 @@
+import lldb
+from lldbsuite.test.lldbtest import *
+from lldbsuite.test.decorators import *
+import lldbsuite.test.lldbutil as lldbutil
+
+
+class TestDataFormatterCaching(TestBase):
+
+    mydir = TestBase.compute_mydir(__file__)
+
+    def setUp(self):
+        TestBase.setUp(self)
+
+    def test_with_run_command(self):
+        """
+        Test that hardcoded summary formatter matches aren't improperly cached.
+        """
+        self.build()
+        target, process, thread, bkpt = lldbutil.run_to_source_breakpoint(
+            self, 'break here', lldb.SBFileSpec('a.c'))
+        valobj = self.frame().FindVariable('f')
+        self.assertEqual(valobj.GetValue(), '4')
+        bkpt_b = target.BreakpointCreateBySourceRegex('break here',
+                                                      lldb.SBFileSpec('b.c'))
+        lldbutil.continue_to_breakpoint(process, bkpt_b)
+        valobj = self.frame().FindVariable('f4')
+        self.assertEqual(valobj.GetSummary(), '(1, 2, 3, 4)')

lldb/packages/Python/lldbsuite/test/functionalities/data-formatter/data-formatter-caching/a.c

@@ -0,0 +1,7 @@
+typedef float float4;
+
+int main() {
+  float4 f = 4.0f;
+  // break here
+  return a(); 
+}

lldb/packages/Python/lldbsuite/test/functionalities/data-formatter/data-formatter-caching/b.c

@@ -0,0 +1,8 @@
+typedef float float4 __attribute__((ext_vector_type(4)));
+void stop() {}
+int a() {
+  float4 f4 = {1, 2, 3, 4};
+  // break here
+  stop();
+  return 0;
+}

lldb/packages/Python/lldbsuite/test/lang/swift/dwarfimporter/C/TestSwiftDWARFImporterC.py

@@ -51,21 +51,56 @@ def test_dwarf_importer(self):
         lldbutil.check_variable(self,
                                 target.FindFirstGlobalVariable("point"),
                                 typename='__ObjC.Point', num_children=2)
-        self.expect("ta v point", substrs=["x = 1", "y = 2"])
-        self.expect("ta v enumerator", substrs=[".yellow"])
-        self.expect("ta v pureSwiftStruct", substrs=["pure swift"])
-        self.expect("ta v swiftStructCMember",
+        self.expect("target variable point", substrs=["x = 1", "y = 2"])
+        self.expect("target variable enumerator", substrs=[".yellow"])
+        self.expect("target variable pureSwiftStruct", substrs=["pure swift"])
+        self.expect("target variable swiftStructCMember",
                     substrs=["point", "x = 3", "y = 4",
                              "sub", "x = 1", "y = 2", "z = 3",
                              "swift struct c member"])
-        self.expect("ta v typedef", substrs=["x = 5", "y = 6"])
-        self.expect("ta v union", substrs=["(DoubleLongUnion)", "long_val = 42"])
-        self.expect("ta v fromSubmodule",
+        self.expect("target variable typedef", substrs=["x = 5", "y = 6"])
+        self.expect("target variable union",
+                    substrs=["(DoubleLongUnion)", "long_val = 42"])
+        self.expect("target variable fromSubmodule",
                     substrs=["(FromSubmodule)", "x = 1", "y = 2", "z = 3"])
         process.Clear()
         target.Clear()
         lldb.SBDebugger.MemoryPressureDetected()
 
+    @skipIf(archs=['ppc64le'], bugnumber='SR-10214')
+    @swiftTest
+    # This test needs a working Remote Mirrors implementation.
+    @skipIf(oslist=['linux', 'windows'])
+    def test_dwarf_importer_exprs(self):
+        lldb.SBDebugger.MemoryPressureDetected()
+        self.runCmd("settings set symbols.use-swift-dwarfimporter true")
+        self.build()
+        target, process, thread, bkpt = lldbutil.run_to_source_breakpoint(
+            self, 'break here', lldb.SBFileSpec('main.swift'))
+        lldbutil.check_variable(self,
+                                target.FindFirstGlobalVariable("pureSwift"),
+                                value="42")
+        lldbutil.check_variable(self,
+                                target.FindFirstGlobalVariable("point"),
+                                typename='__ObjC.Point', num_children=2)
+        self.expect("expr point", substrs=["x = 1", "y = 2"])
+        self.expect("expr enumerator", substrs=[".yellow"])
+        self.expect("expr pureSwiftStruct", substrs=["pure swift"])
+        self.expect("expr swiftStructCMember",
+                    substrs=["point", "x = 3", "y = 4",
+                             "sub", "x = 1", "y = 2", "z = 3",
+                             "swift struct c member"])
+        self.expect("expr typedef", substrs=["x = 5", "y = 6"])
+        # FIXME: lookup fails for:
+        #   a.union.unsafeMutableAddressor : __C.DoubleLongUnion
+        self.expect("expr union", error=True)
+        #self.expect("expr union", substrs=["(DoubleLongUnion)", "long_val = 42"])
+        self.expect("expr fromSubmodule",
+                    substrs=["(FromSubmodule)", "x = 1", "y = 2", "z = 3"])
+        process.Clear()
+        target.Clear()
+        lldb.SBDebugger.MemoryPressureDetected()
+        
     @skipIf(archs=['ppc64le'], bugnumber='SR-10214')
     @swiftTest
     def test_negative(self):
@@ -81,7 +116,7 @@ def test_negative(self):
                                 target.FindFirstGlobalVariable("point"),
                                 typename="Point", num_children=2)
         # This works as a Clang type.
-        self.expect("ta v point", substrs=["x = 1", "y = 2"])
+        self.expect("target variable point", substrs=["x = 1", "y = 2"])
         # This can't be resolved.
         lldbutil.check_variable(self,
                                 target.FindFirstGlobalVariable("swiftStructCMember"),
@@ -97,4 +132,3 @@ def test_negative(self):
         process.Clear()
         target.Clear()
         lldb.SBDebugger.MemoryPressureDetected()
-        self.runCmd("settings set symbols.use-swift-dwarfimporter true")

lldb/packages/Python/lldbsuite/test/lang/swift/dwarfimporter/Objective-C/TestSwiftDWARFImporterObjC.py

@@ -37,7 +37,7 @@ def build(self):
 
     @skipUnlessDarwin
     @swiftTest
-    def test_dwarf_importer(self):
+    def test(self):
         self.runCmd("settings set symbols.use-swift-dwarfimporter true")
 
         self.build()
@@ -52,12 +52,32 @@ def test_dwarf_importer(self):
                                 num_children=0)
         self.expect("target var obj", substrs=["ObjCClass",
                                                "private_ivar", "42"])
-        # FIXME: This triggers an assertion in ClangImporter:
-        #        "ObjC property without getter"
-        #self.expect("target var swiftChild", substrs=["ObjCClass",
-        #                                              "private_ivar", "42"])
+
+        self.expect("target var swiftChild", substrs=["ObjCClass",
+                                                      "private_ivar", "42"])
         # This is a Clang type, since Clang doesn't generate DWARF for protocols.
         self.expect("target var -d no-dyn proto", substrs=["(id)", "proto"])
         # This is a Swift type.
         self.expect("target var -d run proto", substrs=["(ProtoImpl)", "proto"])
         self.expect("target var -O proto", substrs=["<ProtoImpl"])
+
+    @skipUnlessDarwin
+    @swiftTest
+    def test_expr(self):
+        self.runCmd("settings set symbols.use-swift-dwarfimporter true")
+
+        self.build()
+        target, process, thread, bkpt = lldbutil.run_to_source_breakpoint(
+            self, 'break here', lldb.SBFileSpec('main.swift'))
+        lldbutil.check_variable(self,
+                                target.FindFirstGlobalVariable("pureSwift"),
+                                value="42")
+        lldbutil.check_variable(self,
+                                target.FindFirstGlobalVariable("obj"),
+                                typename="Swift.Optional<__ObjC.ObjCClass>",
+                                num_children=0)
+        self.expect("expr obj", substrs=["ObjCClass",
+                                         "private_ivar", "42"])
+        # FIXME: Removing this makes the expression below fail!
+        self.expect("target var swiftChild")
+        self.expect("expr swiftChild!.number", substrs=["42"])

lldb/packages/Python/lldbsuite/test/lang/swift/variables/objc_optionals/TestSwiftObjCOptionals.py

@@ -56,17 +56,20 @@ def do_check_visuals(self):
     def do_check_api(self):
         """Check formatting for T? and T! when T is an ObjC type"""
         optColor_Some = self.frame().FindVariable("optColor_Some")
+
+        # SwiftOptionalSyntheticFrontEnd passes GetNumChildren
+        # through to the .some object.  NSColor has no children.
         lldbutil.check_variable(
             self,
             optColor_Some,
             use_dynamic=False,
-            num_children=1)
+            num_children=0)
         uoptColor_Some = self.frame().FindVariable("uoptColor_Some")
         lldbutil.check_variable(
             self,
             uoptColor_Some,
             use_dynamic=False,
-            num_children=1)
+            num_children=0)
 
 if __name__ == '__main__':
     import atexit