Complete complete types early when importing types from Clang module DWARF.

[aprantl]

Summary

This affects -gmodules only.

Under normal operation pcm_type is a shallow forward declaration
that gets completed later. This is necessary to support cyclic
data structures. If, however, pcm_type is already complete (for
example, because it was loaded for a different target before),
the definition needs to be imported right away, too.
Type::ResolveClangType() effectively ignores the ResolveState
inside type_sp and only looks at IsDefined(), so it never calls
ClangASTImporter::ASTImporterDelegate::ImportDefinitionTo(),
which does extra work for Objective-C classes. This would result
in only the forward declaration to be visible.

An alternative implementation would be to sink this into Type::ResolveClangType ( https://github.com/llvm/llvm-project/blob/88235812a71d99c082e7aa2ef9356d43d1f83a80/lldb/source/Symbol/Type.cpp#L589) though it isn't clear to me how to best do this from a layering perspective.

rdar://problem/52134074

[aprantl]

Ping.

[vsk]

lldb/source/Plugins/SymbolFile/DWARF/DWARFASTParserClang.cpp

236

AIUI, when RequireCompleteType returns false, type completion has failed and a diagnostic is emitted. When that happens, should ParseTypeFromClangModule still proceed to create the type?

[aprantl]

lldb/source/Plugins/SymbolFile/DWARF/DWARFASTParserClang.cpp

236

I believe yes, because even the forward declaration alone will be of (limited) usefulness to represent pointer types.

[aprantl]

lldb/source/Plugins/SymbolFile/DWARF/DWARFASTParserClang.cpp

236

That said, pcm_type.IsDefined() already tells us that the type has been completed successfully once, so this would be a hard situation to get into.

[JDevlieghere]

LGTM

lldb/packages/Python/lldbsuite/test/lang/objc/modules-app-update/Makefile

+CFLAGS_EXTRAS = -I$(BUILDDIR)
+USE_PRIVATE_MODULE_CACHE := YES
+OBJC_SOURCES := main.m foo.m
+
+include Makefile.rules

lldb/packages/Python/lldbsuite/test/lang/objc/modules-app-update/TestClangModulesAppUpdate.py

+from __future__ import print_function
+
+import unittest2
+import os
+import shutil
+
+import lldb
+from lldbsuite.test.decorators import *
+from lldbsuite.test.lldbtest import *
+from lldbsuite.test import lldbutil
+
+
+class TestClangModuleAppUpdate(TestBase):
+    mydir = TestBase.compute_mydir(__file__)
+
+    def setUp(self):
+        TestBase.setUp(self)
+
+    @skipUnlessDarwin
+    @skipIf(debug_info=no_match(["gmodules"]))
+    def test_rebuild_app_modules_untouched(self):
+        with open(self.getBuildArtifact("module.modulemap"), "w") as f:
+            f.write("""
+                    module Foo { header "f.h" }
+                    """)
+        with open(self.getBuildArtifact("f.h"), "w") as f:
+            f.write("""
+                    @import Foundation;
+                    @interface Foo : NSObject {
+                       int i;
+                    }
+                    +(instancetype)init;
+                    @end
+                    """)
+
+        mod_cache = self.getBuildArtifact("private-module-cache")
+        import os
+        if os.path.isdir(mod_cache):
+          shutil.rmtree(mod_cache)
+        self.build()
+        self.assertTrue(os.path.isdir(mod_cache), "module cache exists")
+
+        target, process, _, bkpt = lldbutil.run_to_source_breakpoint(
+            self, "break here", lldb.SBFileSpec("main.m"))
+        bar = target.FindTypes('Bar').GetTypeAtIndex(0)
+        foo = bar.GetDirectBaseClassAtIndex(0).GetType()
+        self.assertEqual(foo.GetNumberOfFields(), 1)
+        self.assertEqual(foo.GetFieldAtIndex(0).GetName(), "i")
+
+        # Rebuild.
+        process.Kill()
+        os.remove(self.getBuildArtifact('main.o'))
+        os.remove(self.getBuildArtifact('a.out'))
+        self.build()
+
+        # Reattach.
+        target, process, _, _ = lldbutil.run_to_breakpoint_do_run(self, target, bkpt)
+        bar = target.FindTypes('Bar').GetTypeAtIndex(0)
+        foo = bar.GetDirectBaseClassAtIndex(0).GetType()
+        self.assertEqual(foo.GetNumberOfFields(), 1)
+        self.assertEqual(foo.GetFieldAtIndex(0).GetName(), "i")

lldb/packages/Python/lldbsuite/test/lang/objc/modules-app-update/foo.m

+@import Foundation;
+@import Foo;
+@implementation Foo
++(instancetype)init {
+  return [super init];
+}
+@end

lldb/packages/Python/lldbsuite/test/lang/objc/modules-app-update/main.m

+@import Umbrella;
+
+@interface Bar : Foo
++(instancetype)init;
+@end
+
+@implementation Bar
++(instancetype)init {
+  return [super init];
+}
+@end
+
+int main(int argc, char **argv) {
+  id bar = [Bar new];
+  [bar i]; // break here
+  return 0;
+}

lldb/packages/Python/lldbsuite/test/lang/objc/modules-app-update/module.modulemap

+module Umbrella {
+  header "umbrella.h"
+  export *
+}

lldb/packages/Python/lldbsuite/test/lang/objc/modules-app-update/umbrella.h

+@import Foo;

lldb/source/Plugins/SymbolFile/DWARF/DWARFASTParserClang.cpp

TypeSP DWARFASTParserClang::ParseTypeFromClangModule(const SymbolContext &sc,
   die.GetDeclContext(decl_context);
   TypeMap pcm_types;
 
   // The type in the Clang module must have the same language as the current CU.
   LanguageSet languages;
   languages.Insert(die.GetCU()->GetLanguageType());
   llvm::DenseSet<SymbolFile *> searched_symbol_files;
   clang_module_sp->GetSymbolFile()->FindTypes(decl_context, languages,
                                               searched_symbol_files, pcm_types);
   if (pcm_types.Empty()) {
     // Since this type is defined in one of the Clang modules imported
     // by this symbol file, search all of them. Instead of calling
     // sym_file->FindTypes(), which would return this again, go straight
     // to the imported modules.
     auto &sym_file = die.GetCU()->GetSymbolFileDWARF();
 
     // Well-formed clang modules never form cycles; guard against corrupted
TypeSP DWARFASTParserClang::ParseTypeFromClangModule(const SymbolContext &sc,
 
   lldb_private::CompilerType pcm_type = pcm_type_sp->GetForwardCompilerType();
   lldb_private::CompilerType type =
       GetClangASTImporter().CopyType(m_ast, pcm_type);
 
   if (!type)
     return TypeSP();
 
+  // Under normal operation pcm_type is a shallow forward declaration
+  // that gets completed later. This is necessary to support cyclic
+  // data structures. If, however, pcm_type is already complete (for
+  // example, because it was loaded for a different target before),
+  // the definition needs to be imported right away, too.
+  // Type::ResolveClangType() effectively ignores the ResolveState
+  // inside type_sp and only looks at IsDefined(), so it never calls
+  // ClangASTImporter::ASTImporterDelegate::ImportDefinitionTo(),
+  // which does extra work for Objective-C classes. This would result
+  // in only the forward declaration to be visible.
+  if (pcm_type.IsDefined())
+    GetClangASTImporter().RequireCompleteType(ClangUtil::GetQualType(type));
+
   SymbolFileDWARF *dwarf = die.GetDWARF();
   TypeSP type_sp(new Type(
       die.GetID(), dwarf, pcm_type_sp->GetName(), pcm_type_sp->GetByteSize(),
       nullptr, LLDB_INVALID_UID, Type::eEncodingInvalid,
       &pcm_type_sp->GetDeclaration(), type, Type::ResolveState::Forward));
 
   dwarf->GetTypeList().Insert(type_sp);
   dwarf->GetDIEToType()[die.GetDIE()] = type_sp.get();