This revision was automatically updated to reflect the committed changes.
Closed by commit rGc9a39a896c95: [lldb] Add a display name to ClangASTContext
instances (authored by teemperor).
Changed prior to commit:
https://reviews.llvm.org/D72391?vs=236786&id=239495#toc
Repository:
rG LLVM Github Monorepo
CHANGES SINCE LAST ACTION
https://reviews.llvm.org/D72391/new/
https://reviews.llvm.org/D72391
Files:
lldb/include/lldb/Symbol/ClangASTContext.h
lldb/source/Plugins/ExpressionParser/Clang/ClangASTSource.cpp
lldb/source/Plugins/ExpressionParser/Clang/ClangExpressionParser.cpp
lldb/source/Plugins/ExpressionParser/Clang/ClangModulesDeclVendor.cpp
lldb/source/Plugins/LanguageRuntime/ObjC/AppleObjCRuntime/AppleObjCDeclVendor.cpp
lldb/source/Plugins/LanguageRuntime/ObjC/AppleObjCRuntime/AppleObjCTypeEncodingParser.cpp
lldb/source/Symbol/ClangASTContext.cpp
lldb/unittests/Symbol/TestClangASTContext.cpp
lldb/unittests/SymbolFile/DWARF/DWARFASTParserClangTests.cpp
lldb/unittests/TestingSupport/Symbol/ClangTestUtils.h
Index: lldb/unittests/TestingSupport/Symbol/ClangTestUtils.h
===================================================================
--- lldb/unittests/TestingSupport/Symbol/ClangTestUtils.h
+++ lldb/unittests/TestingSupport/Symbol/ClangTestUtils.h
@@ -22,7 +22,8 @@
}
inline std::unique_ptr<ClangASTContext> createAST() {
- return std::make_unique<ClangASTContext>(HostInfo::GetTargetTriple());
+ return std::make_unique<ClangASTContext>("test ASTContext",
+ HostInfo::GetTargetTriple());
}
inline CompilerType createRecord(ClangASTContext &ast, llvm::StringRef name) {
Index: lldb/unittests/SymbolFile/DWARF/DWARFASTParserClangTests.cpp
===================================================================
--- lldb/unittests/SymbolFile/DWARF/DWARFASTParserClangTests.cpp
+++ lldb/unittests/SymbolFile/DWARF/DWARFASTParserClangTests.cpp
@@ -39,7 +39,7 @@
// defining here, causing this test to fail, feel free to delete it.
TEST_F(DWARFASTParserClangTests,
EnsureAllDIEsInDeclContextHaveBeenParsedParsesOnlyMatchingEntries) {
- ClangASTContext ast_ctx(HostInfoBase::GetTargetTriple());
+ ClangASTContext ast_ctx("dummy ASTContext", HostInfoBase::GetTargetTriple());
DWARFASTParserClangStub ast_parser(ast_ctx);
DWARFUnit *unit = nullptr;
Index: lldb/unittests/Symbol/TestClangASTContext.cpp
===================================================================
--- lldb/unittests/Symbol/TestClangASTContext.cpp
+++ lldb/unittests/Symbol/TestClangASTContext.cpp
@@ -26,7 +26,8 @@
SubsystemRAII<FileSystem, HostInfo> subsystems;
void SetUp() override {
- m_ast.reset(new ClangASTContext(HostInfo::GetTargetTriple()));
+ m_ast.reset(
+ new ClangASTContext("test ASTContext", HostInfo::GetTargetTriple()));
}
void TearDown() override { m_ast.reset(); }
@@ -220,6 +221,16 @@
VerifyEncodingAndBitSize(*m_ast, eEncodingIEEE754, 64);
}
+TEST_F(TestClangASTContext, TestDisplayName) {
+ ClangASTContext ast("some name", llvm::Triple());
+ EXPECT_EQ("some name", ast.getDisplayName());
+}
+
+TEST_F(TestClangASTContext, TestDisplayNameEmpty) {
+ ClangASTContext ast("", llvm::Triple());
+ EXPECT_EQ("", ast.getDisplayName());
+}
+
TEST_F(TestClangASTContext, TestIsClangType) {
clang::ASTContext &context = m_ast->getASTContext();
lldb::opaque_compiler_type_t bool_ctype =
Index: lldb/source/Symbol/ClangASTContext.cpp
===================================================================
--- lldb/source/Symbol/ClangASTContext.cpp
+++ lldb/source/Symbol/ClangASTContext.cpp
@@ -499,7 +499,9 @@
Opts.NoInlineDefine = !Opt;
}
-ClangASTContext::ClangASTContext(llvm::Triple target_triple) {
+ClangASTContext::ClangASTContext(llvm::StringRef name,
+ llvm::Triple target_triple) {
+ m_display_name = name.str();
if (!target_triple.str().empty())
SetTargetTriple(target_triple.str());
// The caller didn't pass an ASTContext so create a new one for this
@@ -507,7 +509,9 @@
CreateASTContext();
}
-ClangASTContext::ClangASTContext(ASTContext &existing_ctxt) {
+ClangASTContext::ClangASTContext(llvm::StringRef name,
+ ASTContext &existing_ctxt) {
+ m_display_name = name.str();
SetTargetTriple(existing_ctxt.getTargetInfo().getTriple().str());
m_ast_up.reset(&existing_ctxt);
@@ -556,9 +560,11 @@
}
}
- if (module)
- return std::make_shared<ClangASTContext>(triple);
- else if (target && target->IsValid())
+ if (module) {
+ std::string ast_name =
+ "ASTContext for '" + module->GetFileSpec().GetPath() + "'";
+ return std::make_shared<ClangASTContext>(ast_name, triple);
+ } else if (target && target->IsValid())
return std::make_shared<ClangASTContextForExpressions>(*target, triple);
return lldb::TypeSystemSP();
}
@@ -9252,7 +9258,8 @@
ClangASTContextForExpressions::ClangASTContextForExpressions(
Target &target, llvm::Triple triple)
- : ClangASTContext(triple), m_target_wp(target.shared_from_this()),
+ : ClangASTContext("scratch ASTContext", triple),
+ m_target_wp(target.shared_from_this()),
m_persistent_variables(new ClangPersistentVariables) {
m_scratch_ast_source_up.reset(new ClangASTSource(
target.shared_from_this(), target.GetClangASTImporter()));
Index: lldb/source/Plugins/LanguageRuntime/ObjC/AppleObjCRuntime/AppleObjCTypeEncodingParser.cpp
===================================================================
--- lldb/source/Plugins/LanguageRuntime/ObjC/AppleObjCRuntime/AppleObjCTypeEncodingParser.cpp
+++ lldb/source/Plugins/LanguageRuntime/ObjC/AppleObjCRuntime/AppleObjCTypeEncodingParser.cpp
@@ -23,10 +23,9 @@
ObjCLanguageRuntime &runtime)
: ObjCLanguageRuntime::EncodingToType(), m_runtime(runtime) {
if (!m_scratch_ast_ctx_up)
- m_scratch_ast_ctx_up.reset(new ClangASTContext(runtime.GetProcess()
- ->GetTarget()
- .GetArchitecture()
- .GetTriple()));
+ m_scratch_ast_ctx_up.reset(new ClangASTContext(
+ "AppleObjCTypeEncodingParser ASTContext",
+ runtime.GetProcess()->GetTarget().GetArchitecture().GetTriple()));
}
std::string AppleObjCTypeEncodingParser::ReadStructName(StringLexer &type) {
Index: lldb/source/Plugins/LanguageRuntime/ObjC/AppleObjCRuntime/AppleObjCDeclVendor.cpp
===================================================================
--- lldb/source/Plugins/LanguageRuntime/ObjC/AppleObjCRuntime/AppleObjCDeclVendor.cpp
+++ lldb/source/Plugins/LanguageRuntime/ObjC/AppleObjCRuntime/AppleObjCDeclVendor.cpp
@@ -143,10 +143,9 @@
AppleObjCDeclVendor::AppleObjCDeclVendor(ObjCLanguageRuntime &runtime)
: ClangDeclVendor(eAppleObjCDeclVendor), m_runtime(runtime),
- m_ast_ctx(runtime.GetProcess()
- ->GetTarget()
- .GetArchitecture()
- .GetTriple()),
+ m_ast_ctx(
+ "AppleObjCDeclVendor AST",
+ runtime.GetProcess()->GetTarget().GetArchitecture().GetTriple()),
m_type_realizer_sp(m_runtime.GetEncodingToType()) {
m_external_source = new AppleObjCExternalASTSource(*this);
llvm::IntrusiveRefCntPtr<clang::ExternalASTSource> external_source_owning_ptr(
Index: lldb/source/Plugins/ExpressionParser/Clang/ClangModulesDeclVendor.cpp
===================================================================
--- lldb/source/Plugins/ExpressionParser/Clang/ClangModulesDeclVendor.cpp
+++ lldb/source/Plugins/ExpressionParser/Clang/ClangModulesDeclVendor.cpp
@@ -160,7 +160,9 @@
m_parser(std::move(parser)) {
// Initialize our ClangASTContext.
- m_ast_context.reset(new ClangASTContext(m_compiler_instance->getASTContext()));
+ m_ast_context.reset(
+ new ClangASTContext("ClangModulesDeclVendor ASTContext",
+ m_compiler_instance->getASTContext()));
}
void ClangModulesDeclVendorImpl::ReportModuleExportsHelper(
Index: lldb/source/Plugins/ExpressionParser/Clang/ClangExpressionParser.cpp
===================================================================
--- lldb/source/Plugins/ExpressionParser/Clang/ClangExpressionParser.cpp
+++ lldb/source/Plugins/ExpressionParser/Clang/ClangExpressionParser.cpp
@@ -606,7 +606,8 @@
m_compiler->createASTContext();
clang::ASTContext &ast_context = m_compiler->getASTContext();
- m_ast_context.reset(new ClangASTContext(ast_context));
+ m_ast_context.reset(new ClangASTContext(
+ "Expression ASTContext for '" + m_filename + "'", ast_context));
std::string module_name("$__lldb_module");
Index: lldb/source/Plugins/ExpressionParser/Clang/ClangASTSource.cpp
===================================================================
--- lldb/source/Plugins/ExpressionParser/Clang/ClangASTSource.cpp
+++ lldb/source/Plugins/ExpressionParser/Clang/ClangASTSource.cpp
@@ -203,8 +203,8 @@
LLDB_LOG(log,
" CompleteTagDecl[{0}] on (ASTContext*){1} Completing "
"(TagDecl*){2} named {3}",
- current_id, static_cast<void *>(m_ast_context),
- static_cast<void *>(tag_decl), tag_decl->getName());
+ current_id, m_clang_ast_context->getDisplayName(), tag_decl,
+ tag_decl->getName());
LLDB_LOG(log, " CTD[%u] Before:\n{0}", current_id,
ClangUtil::DumpDecl(tag_decl));
@@ -336,9 +336,10 @@
Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS));
LLDB_LOG(log,
- " [CompleteObjCInterfaceDecl] on (ASTContext*){0} Completing "
- "an ObjCInterfaceDecl named {1}",
- m_ast_context, interface_decl->getName());
+ " [CompleteObjCInterfaceDecl] on (ASTContext*){0} '{1}' "
+ "Completing an ObjCInterfaceDecl named {1}",
+ m_ast_context, m_clang_ast_context->getDisplayName(),
+ interface_decl->getName());
LLDB_LOG(log, " [COID] Before:\n{0}",
ClangUtil::DumpDecl(interface_decl));
@@ -441,24 +442,25 @@
if (log) {
if (const NamedDecl *context_named_decl = dyn_cast<NamedDecl>(context_decl))
LLDB_LOG(log,
- "FindExternalLexicalDecls[{0}] on (ASTContext*){1} in '{2}' "
- "(%sDecl*){3}",
- current_id, static_cast<void *>(m_ast_context),
+ "FindExternalLexicalDecls[{0}] on (ASTContext*){1} '{2}' in "
+ "'{3}' (%sDecl*){4}",
+ current_id, m_ast_context, m_clang_ast_context->getDisplayName(),
context_named_decl->getNameAsString().c_str(),
context_decl->getDeclKindName(),
static_cast<const void *>(context_decl));
else if (context_decl)
- LLDB_LOG(
- log,
- "FindExternalLexicalDecls[{0}] on (ASTContext*){1} in ({2}Decl*){3}",
- current_id, static_cast<void *>(m_ast_context),
- context_decl->getDeclKindName(),
- static_cast<const void *>(context_decl));
+ LLDB_LOG(log,
+ "FindExternalLexicalDecls[{0}] on (ASTContext*){1} '{2}' in "
+ "({3}Decl*){4}",
+ current_id, m_ast_context, m_clang_ast_context->getDisplayName(),
+ context_decl->getDeclKindName(),
+ static_cast<const void *>(context_decl));
else
- LLDB_LOG(
- log,
- "FindExternalLexicalDecls[{0}] on (ASTContext*){1} in a NULL context",
- current_id, static_cast<const void *>(m_ast_context));
+ LLDB_LOG(log,
+ "FindExternalLexicalDecls[{0}] on (ASTContext*){1} '{2}' in a "
+ "NULL context",
+ current_id, m_ast_context,
+ m_clang_ast_context->getDisplayName());
}
ClangASTImporter::DeclOrigin original = m_ast_importer_sp->GetDeclOrigin(context_decl);
@@ -466,10 +468,10 @@
if (!original.Valid())
return;
- LLDB_LOG(
- log, " FELD[{0}] Original decl (ASTContext*){1:x} (Decl*){2:x}:\n{3}",
- current_id, static_cast<void *>(original.ctx),
- static_cast<void *>(original.decl), ClangUtil::DumpDecl(original.decl));
+ LLDB_LOG(log, " FELD[{0}] Original decl {1} (Decl*){2:x}:\n{3}", current_id,
+ static_cast<void *>(original.ctx),
+ static_cast<void *>(original.decl),
+ ClangUtil::DumpDecl(original.decl));
if (ObjCInterfaceDecl *original_iface_decl =
dyn_cast<ObjCInterfaceDecl>(original.decl)) {
@@ -563,20 +565,22 @@
if (!context.m_decl_context)
LLDB_LOG(log,
"ClangASTSource::FindExternalVisibleDecls[{0}] on "
- "(ASTContext*){1} for '{2}' in a NULL DeclContext",
- current_id, m_ast_context, name);
+ "(ASTContext*){1} '{2}' for '{3}' in a NULL DeclContext",
+ current_id, m_ast_context, m_clang_ast_context->getDisplayName(),
+ name);
else if (const NamedDecl *context_named_decl =
dyn_cast<NamedDecl>(context.m_decl_context))
LLDB_LOG(log,
"ClangASTSource::FindExternalVisibleDecls[{0}] on "
- "(ASTContext*){1} for '{2}' in '{3}'",
- current_id, m_ast_context, name, context_named_decl->getName());
+ "(ASTContext*){1} '{2}' for '{3}' in '{4}'",
+ current_id, m_ast_context, m_clang_ast_context->getDisplayName(),
+ name, context_named_decl->getName());
else
LLDB_LOG(log,
"ClangASTSource::FindExternalVisibleDecls[{0}] on "
- "(ASTContext*){1} for '{2}' in a '{3}'",
- current_id, m_ast_context, name,
- context.m_decl_context->getDeclKindName());
+ "(ASTContext*){1} '{2}' for '{3}' in a '{4}'",
+ current_id, m_ast_context, m_clang_ast_context->getDisplayName(),
+ name, context.m_decl_context->getDeclKindName());
}
context.m_namespace_map = std::make_shared<ClangASTImporter::NamespaceMap>();
@@ -1042,9 +1046,10 @@
ConstString selector_name(ss.GetString());
LLDB_LOG(log,
- "ClangASTSource::FindObjCMethodDecls[{0}] on (ASTContext*){1} "
- "for selector [{2} {3}]",
- current_id, m_ast_context, interface_decl->getName(), selector_name);
+ "ClangASTSource::FindObjCMethodDecls[{0}] on (ASTContext*){1} '{2}' "
+ "for selector [{3} {4}]",
+ current_id, m_ast_context, m_clang_ast_context->getDisplayName(),
+ interface_decl->getName(), selector_name);
SymbolContextList sc_list;
const bool include_symbols = false;
@@ -1337,9 +1342,9 @@
LLDB_LOG(log,
"ClangASTSource::FindObjCPropertyAndIvarDecls[{0}] on "
- "(ASTContext*){1} for '{2}.{3}'",
- current_id, m_ast_context, parser_iface_decl->getName(),
- context.m_decl_name.getAsString());
+ "(ASTContext*){1} '{2}' for '{3}.{4}'",
+ current_id, m_ast_context, m_clang_ast_context->getDisplayName(),
+ parser_iface_decl->getName(), context.m_decl_name.getAsString());
if (FindObjCPropertyAndIvarDeclsWithOrigin(
current_id, context, *this, origin_iface_decl))
@@ -1553,9 +1558,10 @@
Log *log(lldb_private::GetLogIfAllCategoriesSet(LIBLLDB_LOG_EXPRESSIONS));
LLDB_LOG(log,
- "LayoutRecordType[{0}] on (ASTContext*){1} for (RecordDecl*){2} "
- "[name = '{3}']",
- current_id, m_ast_context, record, record->getName());
+ "LayoutRecordType[{0}] on (ASTContext*){1} '{2}' for (RecordDecl*)"
+ "{3} [name = '{4}']",
+ current_id, m_ast_context, m_clang_ast_context->getDisplayName(),
+ record, record->getName());
DeclFromParser<const RecordDecl> parser_record(record);
DeclFromUser<const RecordDecl> origin_record(
@@ -1676,15 +1682,16 @@
if (log) {
if (parent_map && parent_map->size())
LLDB_LOG(log,
- "CompleteNamespaceMap[{0}] on (ASTContext*){1} Searching for "
- "namespace {2} in namespace {3}",
- current_id, m_ast_context, name,
- parent_map->begin()->second.GetName());
+ "CompleteNamespaceMap[{0}] on (ASTContext*){1} '{2}' Searching "
+ "for namespace {3} in namespace {4}",
+ current_id, m_ast_context, m_clang_ast_context->getDisplayName(),
+ name, parent_map->begin()->second.GetName());
else
LLDB_LOG(log,
- "CompleteNamespaceMap[{0}] on (ASTContext*){1} Searching for "
- "namespace {2}",
- current_id, m_ast_context, name);
+ "CompleteNamespaceMap[{0}] on (ASTContext*){1} '{2}' Searching "
+ "for namespace {3}",
+ current_id, m_ast_context, m_clang_ast_context->getDisplayName(),
+ name);
}
if (parent_map) {
Index: lldb/include/lldb/Symbol/ClangASTContext.h
===================================================================
--- lldb/include/lldb/Symbol/ClangASTContext.h
+++ lldb/include/lldb/Symbol/ClangASTContext.h
@@ -57,17 +57,20 @@
/// Constructs a ClangASTContext with an ASTContext using the given triple.
///
+ /// \param name The name for the ClangASTContext (for logging purposes)
/// \param triple The llvm::Triple used for the ASTContext. The triple defines
/// certain characteristics of the ASTContext and its types
/// (e.g., whether certain primitive types exist or what their
/// signedness is).
- explicit ClangASTContext(llvm::Triple triple);
+ explicit ClangASTContext(llvm::StringRef name, llvm::Triple triple);
/// Constructs a ClangASTContext that uses an existing ASTContext internally.
/// Useful when having an existing ASTContext created by Clang.
///
+ /// \param name The name for the ClangASTContext (for logging purposes)
/// \param existing_ctxt An existing ASTContext.
- explicit ClangASTContext(clang::ASTContext &existing_ctxt);
+ explicit ClangASTContext(llvm::StringRef name,
+ clang::ASTContext &existing_ctxt);
~ClangASTContext() override;
@@ -104,6 +107,10 @@
return llvm::dyn_cast<ClangASTContext>(&type_system_or_err.get());
}
+ /// Returns the display name of this ClangASTContext that indicates what
+ /// purpose it serves in LLDB. Used for example in logs.
+ llvm::StringRef getDisplayName() const { return m_display_name; }
+
clang::ASTContext &getASTContext();
clang::MangleContext *getMangleContext();
@@ -947,6 +954,10 @@
std::unique_ptr<clang::MangleContext> m_mangle_ctx_up;
uint32_t m_pointer_byte_size = 0;
bool m_ast_owned = false;
+ /// A string describing what this ClangASTContext represents (e.g.,
+ /// AST for debug information, an expression, some other utility ClangAST).
+ /// Useful for logging and debugging.
+ std::string m_display_name;
typedef llvm::DenseMap<const clang::Decl *, ClangASTMetadata> DeclMetadataMap;
/// Maps Decls to their associated ClangASTMetadata.
_______________________________________________
lldb-commits mailing list
lldb-commits@lists.llvm.org
https://lists.llvm.org/cgi-bin/mailman/listinfo/lldb-commits
