Merge pull request #9612 from adrian-prantl/refactor-symbolcontext

Refactor symbolcontext

Author: adrian-prantl

lldb/source/Plugins/TypeSystem/Swift/TypeSystemSwiftTypeRef.cpp

@@ -1752,17 +1752,16 @@ ConstString TypeSystemSwiftTypeRef::GetSwiftModuleFor(const SymbolContext &sc) {
   return {};
 }
 
-SwiftASTContext *TypeSystemSwiftTypeRef::GetSwiftASTContextFromExecutionScope(
+SymbolContext TypeSystemSwiftTypeRef::GetSymbolContext(
     ExecutionContextScope *exe_scope) const {
-  if (exe_scope) {
-    ExecutionContext exe_ctx;
-    exe_scope->CalculateExecutionContext(exe_ctx);
-    return GetSwiftASTContextFromExecutionContext(&exe_ctx);
-  }
-  return GetSwiftASTContextFromExecutionContext(nullptr);
+  if (!exe_scope)
+    return {};
+  ExecutionContext exe_ctx;
+  exe_scope->CalculateExecutionContext(exe_ctx);
+  return GetSymbolContext(&exe_ctx);
 }
 
-SwiftASTContext *TypeSystemSwiftTypeRef::GetSwiftASTContextFromExecutionContext(
+SymbolContext TypeSystemSwiftTypeRef::GetSymbolContext(
     const ExecutionContext *exe_ctx) const {
   SymbolContext sc;
   if (exe_ctx) {
@@ -1776,16 +1775,17 @@ SwiftASTContext *TypeSystemSwiftTypeRef::GetSwiftASTContextFromExecutionContext(
     if (auto target_sp = GetTargetWP().lock())
       sc = SymbolContext(target_sp, target_sp->GetExecutableModule());
 
+  return sc;
+}
+
+SwiftASTContext *
+TypeSystemSwiftTypeRef::GetSwiftASTContext(const SymbolContext &sc) const {
   if (!sc.module_sp) {
-    LLDB_LOGF(GetLog(LLDBLog::Types),
+    LLDB_LOGV(GetLog(LLDBLog::Types),
               "Cannot create a SwiftASTContext without an execution context");
     return nullptr;
   }
-  return GetSwiftASTContext(sc);
-}
 
-SwiftASTContext *
-TypeSystemSwiftTypeRef::GetSwiftASTContext(const SymbolContext &sc) const {
   std::lock_guard<std::mutex> guard(m_swift_ast_context_lock);
   // There is only one per-module context.
   const char *key = nullptr;
@@ -1810,6 +1810,12 @@ TypeSystemSwiftTypeRef::GetSwiftASTContext(const SymbolContext &sc) const {
 
 SwiftASTContext *TypeSystemSwiftTypeRefForExpressions::GetSwiftASTContext(
     const SymbolContext &sc) const {
+  if (!sc.module_sp) {
+    LLDB_LOGV(GetLog(LLDBLog::Types),
+              "Cannot create a SwiftASTContext without an execution context");
+    return nullptr;
+  }
+
   // Compute the cache key.
   const char *key = nullptr;
   ConstString module = GetSwiftModuleFor(sc);
@@ -1951,7 +1957,7 @@ TypeSystemSwiftTypeRef::GetMangledTypeName(opaque_compiler_type_t type) {
 
 void *TypeSystemSwiftTypeRef::ReconstructType(opaque_compiler_type_t type,
                                               const ExecutionContext *exe_ctx) {
-  if (auto *swift_ast_context = GetSwiftASTContextFromExecutionContext(exe_ctx))
+  if (auto *swift_ast_context = GetSwiftASTContext(GetSymbolContext(exe_ctx)))
     return llvm::expectedToStdOptional(
                swift_ast_context->ReconstructType(GetMangledTypeName(type)))
         .value_or(nullptr);
@@ -1970,7 +1976,7 @@ CompilerType
 TypeSystemSwiftTypeRef::ReconstructType(CompilerType type,
                                         const ExecutionContext *exe_ctx) {
   assert(type.GetTypeSystem().dyn_cast_or_null<TypeSystemSwiftTypeRef>());
-  if (auto *swift_ast_context = GetSwiftASTContextFromExecutionContext(exe_ctx))
+  if (auto *swift_ast_context = GetSwiftASTContext(GetSymbolContext(exe_ctx)))
     return {swift_ast_context->weak_from_this(),
             ReconstructType(type.GetOpaqueQualType(), exe_ctx)};
   return {};
@@ -2362,7 +2368,7 @@ constexpr ExecutionContextScope *g_no_exe_ctx = nullptr;
              .GetSwiftValidateTypeSystem())                                    \
       return result;                                                           \
     ExecutionContext _exe_ctx(EXE_CTX);                                        \
-    if (!GetSwiftASTContextFromExecutionContext(&_exe_ctx))                    \
+    if (!GetSwiftASTContext(GetSymbolContext(&_exe_ctx)))                      \
       return result;                                                           \
     if (ShouldSkipValidation(TYPE))                                            \
       return result;                                                           \
@@ -2377,8 +2383,9 @@ constexpr ExecutionContextScope *g_no_exe_ctx = nullptr;
         _exe_ctx == ExecutionContext() ? nullptr : &_exe_ctx);                 \
     bool equivalent =                                                          \
         !ReconstructType(TYPE) /* missing .swiftmodule */ ||                   \
-        (Equivalent(result, GetSwiftASTContextFromExecutionContext(&_exe_ctx)  \
-                                ->REFERENCE ARGS));                            \
+        (Equivalent(                                                           \
+            result,                                                            \
+            GetSwiftASTContext(GetSymbolContext(&_exe_ctx))->REFERENCE ARGS)); \
     if (!equivalent)                                                           \
       llvm::dbgs() << "failing type was " << (const char *)TYPE << "\n";       \
     assert(equivalent &&                                                       \
@@ -2393,7 +2400,7 @@ constexpr ExecutionContextScope *g_no_exe_ctx = nullptr;
              .GetSwiftValidateTypeSystem())                                    \
       return result;                                                           \
     ExecutionContext _exe_ctx(EXE_CTX);                                        \
-    if (!GetSwiftASTContextFromExecutionContext(&_exe_ctx))                    \
+    if (!GetSwiftASTContext(GetSymbolContext(&_exe_ctx)))                      \
       return result;                                                           \
     if (ShouldSkipValidation(TYPE))                                            \
       return result;                                                           \
@@ -2411,7 +2418,7 @@ constexpr ExecutionContextScope *g_no_exe_ctx = nullptr;
       equivalent =                                                             \
           (Equivalent(llvm::expectedToStdOptional(std::move(result)),          \
                       llvm::expectedToStdOptional(                             \
-                          GetSwiftASTContextFromExecutionContext(&_exe_ctx)    \
+                          GetSwiftASTContext(GetSymbolContext(&_exe_ctx))      \
                               ->REFERENCE ARGS)));                             \
     } else { /* missing .swiftmodule */                                        \
       if (!result)                                                             \
@@ -3111,7 +3118,7 @@ TypeSystemSwiftTypeRef::GetBitSize(opaque_compiler_type_t type,
                 AsMangledName(type));
 
       if (auto *swift_ast_context =
-              GetSwiftASTContextFromExecutionScope(exe_scope))
+              GetSwiftASTContext(GetSymbolContext(exe_scope)))
         return swift_ast_context->GetBitSize(ReconstructType(type, exe_scope),
                                              exe_scope);
     }
@@ -3158,7 +3165,7 @@ TypeSystemSwiftTypeRef::GetByteStride(opaque_compiler_type_t type,
               "Couldn't compute stride of type %s using SwiftLanguageRuntime.",
               AsMangledName(type));
     if (auto *swift_ast_context =
-            GetSwiftASTContextFromExecutionScope(exe_scope))
+            GetSwiftASTContext(GetSymbolContext(exe_scope)))
       return swift_ast_context->GetByteStride(ReconstructType(type), exe_scope);
     return {};
   };
@@ -3279,7 +3286,7 @@ TypeSystemSwiftTypeRef::GetNumChildren(opaque_compiler_type_t type,
             AsMangledName(type));
 
   // Try SwiftASTContext.
-  if (auto *swift_ast_context = GetSwiftASTContextFromExecutionContext(exe_ctx))
+  if (auto *swift_ast_context = GetSwiftASTContext(GetSymbolContext(exe_ctx)))
     if (auto n = llvm::expectedToStdOptional(swift_ast_context->GetNumChildren(
             ReconstructType(type, exe_ctx), omit_empty_base_classes,
             exe_ctx))) {
@@ -3340,7 +3347,7 @@ uint32_t TypeSystemSwiftTypeRef::GetNumFields(opaque_compiler_type_t type,
             "Using SwiftASTContext::GetNumFields fallback for type %s",
             AsMangledName(type));
 
-  if (auto *swift_ast_context = GetSwiftASTContextFromExecutionContext(exe_ctx))
+  if (auto *swift_ast_context = GetSwiftASTContext(GetSymbolContext(exe_ctx)))
     return swift_ast_context->GetNumFields(ReconstructType(type, exe_ctx), exe_ctx);
   return {};
 }
@@ -3415,7 +3422,7 @@ TypeSystemSwiftTypeRef::GetChildCompilerTypeAtIndex(
              "Had to engage SwiftASTContext fallback for type {0}, field #{1}.",
              AsMangledName(type), idx);
     if (auto *swift_ast_context =
-            GetSwiftASTContextFromExecutionContext(exe_ctx))
+            GetSwiftASTContext(GetSymbolContext(exe_ctx)))
       return swift_ast_context->GetChildCompilerTypeAtIndex(
           ReconstructType(type, exe_ctx), exe_ctx, idx, transparent_pointers,
           omit_empty_base_classes, ignore_array_bounds, child_name,
@@ -3430,7 +3437,7 @@ TypeSystemSwiftTypeRef::GetChildCompilerTypeAtIndex(
     if (ast_num_children)
       return *ast_num_children;
     if (auto *swift_ast_context =
-            GetSwiftASTContextFromExecutionContext(exe_ctx))
+            GetSwiftASTContext(GetSymbolContext(exe_ctx)))
       ast_num_children = llvm::expectedToStdOptional(
           swift_ast_context->GetNumChildren(ReconstructType(type, exe_ctx),
                                             omit_empty_base_classes, exe_ctx));
@@ -3693,15 +3700,15 @@ size_t TypeSystemSwiftTypeRef::GetIndexOfChildMemberWithName(
         if (!ModuleList::GetGlobalModuleListProperties()
                  .GetSwiftValidateTypeSystem())
           return index_size;
-        if (!GetSwiftASTContextFromExecutionContext(exe_ctx))
+        if (!GetSwiftASTContext(GetSymbolContext(exe_ctx)))
           return index_size;
         auto swift_scratch_ctx_lock = SwiftScratchContextLock(exe_ctx);
         auto ast_type = ReconstructType(type, exe_ctx);
         if (!ast_type)
           return index_size;
         std::vector<uint32_t> ast_child_indexes;
         auto ast_index_size =
-            GetSwiftASTContextFromExecutionContext(exe_ctx)
+            GetSwiftASTContext(GetSymbolContext(exe_ctx))
                 ->GetIndexOfChildMemberWithName(ast_type, name, exe_ctx,
                                                 omit_empty_base_classes,
                                                 ast_child_indexes);
@@ -3741,7 +3748,7 @@ size_t TypeSystemSwiftTypeRef::GetIndexOfChildMemberWithName(
             "type %s",
             AsMangledName(type));
 
-  if (auto *swift_ast_context = GetSwiftASTContextFromExecutionContext(exe_ctx))
+  if (auto *swift_ast_context = GetSwiftASTContext(GetSymbolContext(exe_ctx)))
     return swift_ast_context->GetIndexOfChildMemberWithName(
         ReconstructType(type, exe_ctx), name, exe_ctx, omit_empty_base_classes,
         child_indexes);
@@ -4039,7 +4046,7 @@ TypeSystemSwiftTypeRef::GetInstanceType(opaque_compiler_type_t type,
       // type alias in the REPL. In these cases, fallback to asking the AST
       // for the canonical type.
       if (auto *swift_ast_context =
-              GetSwiftASTContextFromExecutionScope(exe_scope))
+              GetSwiftASTContext(GetSymbolContext(exe_scope)))
         return swift_ast_context->GetInstanceType(
             ReconstructType(type, exe_scope), exe_scope);
       return {};
@@ -4283,7 +4290,7 @@ void TypeSystemSwiftTypeRef::DumpTypeDescription(
   // Also dump the swift ast context info, as this functions should not be in
   // any critical path.
   if (auto *swift_ast_context =
-          GetSwiftASTContextFromExecutionScope(exe_scope)) {
+          GetSwiftASTContext(GetSymbolContext(exe_scope))) {
     s->PutCString("Source code info:\n");
     swift_ast_context->DumpTypeDescription(
         ReconstructType(type, exe_scope), s, print_help_if_available,
@@ -4419,7 +4426,7 @@ bool TypeSystemSwiftTypeRef::DumpTypeValue(
       // No result available from the runtime, fallback to the AST. This occurs
       // for some Clang imported enums.
       if (auto *swift_ast_context =
-              GetSwiftASTContextFromExecutionScope(exe_scope)) {
+              GetSwiftASTContext(GetSymbolContext(exe_scope))) {
         ExecutionContext exe_ctx;
         exe_scope->CalculateExecutionContext(exe_ctx);
         if (swift_ast_context->DumpTypeValue(
@@ -4438,7 +4445,7 @@ bool TypeSystemSwiftTypeRef::DumpTypeValue(
       // typedefs such as CFString in the REPL. More investigation is
       // needed.
       if (auto *swift_ast_context =
-              GetSwiftASTContextFromExecutionScope(exe_scope))
+              GetSwiftASTContext(GetSymbolContext(exe_scope)))
         return swift_ast_context->DumpTypeValue(
             ReconstructType(type, exe_scope), s, format, data, data_offset,
             data_byte_size, bitfield_bit_size, bitfield_bit_offset, exe_scope,
@@ -4463,7 +4470,7 @@ bool TypeSystemSwiftTypeRef::DumpTypeValue(
     bool unresolved_typealias = false;
     CollectTypeInfo(dem, node, unresolved_typealias);
     if (!node || unresolved_typealias) {
-      if (auto swift_ast_ctx = GetSwiftASTContextFromExecutionScope(exe_scope))
+      if (auto swift_ast_ctx = GetSwiftASTContext(GetSymbolContext(exe_scope)))
         return swift_ast_ctx->DumpTypeValue(
             ReconstructType(type, exe_scope), s, format, data, data_offset,
             data_byte_size, bitfield_bit_size, bitfield_bit_offset, exe_scope,
@@ -4541,7 +4548,7 @@ TypeSystemSwiftTypeRef::GetTypeBitAlign(opaque_compiler_type_t type,
     // defined in the expression. In that case we don't have debug
     // info for it, so defer to SwiftASTContext.
     if (llvm::isa_and_nonnull<SwiftASTContextForExpressions>(
-            GetSwiftASTContextFromExecutionScope(exe_scope))) {
+            GetSwiftASTContext(GetSymbolContext(exe_scope)))) {
       ExecutionContext exe_ctx;
       if (exe_scope)exe_scope->CalculateExecutionContext(exe_ctx);
       return ReconstructType({weak_from_this(), type}, &exe_ctx)

lldb/source/Plugins/TypeSystem/Swift/TypeSystemSwiftTypeRef.h

@@ -70,10 +70,8 @@ class TypeSystemSwiftTypeRef : public TypeSystemSwift {
   /// Get the corresponding SwiftASTContext, and create one if necessary.
   SwiftASTContext *GetSwiftASTContext(const SymbolContext &sc) const override;
   /// Convenience helpers.
-  SwiftASTContext *
-  GetSwiftASTContextFromExecutionScope(ExecutionContextScope *exe_scope) const;
-  SwiftASTContext *
-  GetSwiftASTContextFromExecutionContext(const ExecutionContext *exe_ctx) const;
+  SymbolContext GetSymbolContext(ExecutionContextScope *exe_scope) const;
+  SymbolContext GetSymbolContext(const ExecutionContext *exe_ctx) const;
   /// Return SwiftASTContext, iff one has already been created.
   virtual SwiftASTContext *
   GetSwiftASTContextOrNull(const SymbolContext &sc) const;