Skip to content

Commit 8056d92

Browse files
authored
[lldb][ClangExpressionParser] Implement ExternalSemaSource::ReadUndefinedButUsed (#104817)
While parsing an expression, Clang tries to diagnose usage of decls (with possibly non-external linkage) for which it hasn't been provided with a definition. This is the case, e.g., for functions with parameters that live in an anonymous namespace (those will have `UniqueExternal` linkage, this is computed [here in computeTypeLinkageInfo](https://github.com/llvm/llvm-project/blob/ea8bb4d633683f5cbfd82491620be3056f347a02/clang/lib/AST/Type.cpp#L4647-L4653)). Before diagnosing such situations, Clang calls `ExternalSemaSource::ReadUndefinedButUsed`. The intended use of this API is to extend the set of "used but not defined" decls with additional ones that the external source knows about. However, in LLDB's case, we never provide `FunctionDecl`s with a definition, and instead rely on the expression parser to resolve those symbols by linkage name. Thus, to avoid the Clang parser from erroring out in these situations, this patch implements `ReadUndefinedButUsed` which just removes the "undefined" non-external `FunctionDecl`s that Clang found. We also had to add an `ExternalSemaSource` to the `clang::Sema` instance LLDB creates. We previously didn't have any source on `Sema`. Because we add the `ExternalASTSourceWrapper` here, that means we'd also technically be adding the `ClangExpressionDeclMap` as an `ExternalASTSource` to `Sema`, which is fine because `Sema` will only be calling into the `ExternalSemaSource` APIs (though nothing currently strictly enforces this, which is a bit worrying). Note, the decision for whether to put a function into `UndefinedButUsed` is done in [Sema::MarkFunctionReferenced](https://github.com/llvm/llvm-project/blob/ea8bb4d633683f5cbfd82491620be3056f347a02/clang/lib/Sema/SemaExpr.cpp#L18083-L18087). The `UniqueExternal` linkage computation is done in [getLVForNamespaceScopeDecl](https://github.com/llvm/llvm-project/blob/ea8bb4d633683f5cbfd82491620be3056f347a02/clang/lib/AST/Decl.cpp#L821-L833). Fixes #104712
1 parent ddaa828 commit 8056d92

File tree

3 files changed

+44
-0
lines changed

3 files changed

+44
-0
lines changed

lldb/source/Plugins/ExpressionParser/Clang/ASTUtils.h

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
#include "clang/Sema/Sema.h"
1616
#include "clang/Sema/SemaConsumer.h"
1717
#include "llvm/ADT/IntrusiveRefCntPtr.h"
18+
#include "llvm/Support/Casting.h"
1819
#include <optional>
1920

2021
namespace clang {
@@ -138,6 +139,24 @@ class ExternalASTSourceWrapper : public clang::ExternalSemaSource {
138139
return m_Source->layoutRecordType(Record, Size, Alignment, FieldOffsets,
139140
BaseOffsets, VirtualBaseOffsets);
140141
}
142+
143+
/// This gets called when Sema is reconciling undefined but used decls.
144+
/// For LLDB's use-case, we never provide Clang with function definitions,
145+
/// instead we rely on linkage names and symbol resolution to call the
146+
/// correct funcitons during JITting. So this implementation clears
147+
/// any "undefined" FunctionDecls that Clang found while parsing.
148+
///
149+
/// \param[in,out] Undefined A set of used decls for which Clang has not
150+
/// been provided a definition with.
151+
///
152+
void ReadUndefinedButUsed(
153+
llvm::MapVector<clang::NamedDecl *, clang::SourceLocation> &Undefined)
154+
override {
155+
Undefined.remove_if([](auto const &decl_loc_pair) {
156+
const clang::NamedDecl *ND = decl_loc_pair.first;
157+
return llvm::isa_and_present<clang::FunctionDecl>(ND);
158+
});
159+
}
141160
};
142161

143162
/// Wraps an ASTConsumer into an SemaConsumer. Doesn't take ownership of the

lldb/source/Plugins/ExpressionParser/Clang/ClangExpressionParser.cpp

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1223,6 +1223,8 @@ ClangExpressionParser::ParseInternal(DiagnosticManager &diagnostic_manager,
12231223

12241224
clang::ExternalASTSource *ast_source = decl_map->CreateProxy();
12251225

1226+
auto *ast_source_wrapper = new ExternalASTSourceWrapper(ast_source);
1227+
12261228
if (ast_context.getExternalSource()) {
12271229
auto *module_wrapper =
12281230
new ExternalASTSourceWrapper(ast_context.getExternalSource());
@@ -1236,6 +1238,7 @@ ClangExpressionParser::ParseInternal(DiagnosticManager &diagnostic_manager,
12361238
} else {
12371239
ast_context.setExternalSource(ast_source);
12381240
}
1241+
m_compiler->getSema().addExternalSource(ast_source_wrapper);
12391242
decl_map->InstallASTContext(*m_ast_context);
12401243
}
12411244

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
// Tests that we can evaluate functions that Clang
2+
// classifies as having clang::Linkage::UniqueExternal
3+
// linkage. In this case, a function whose argument
4+
// is not legally usable outside this TU.
5+
6+
// RUN: %build %s -o %t
7+
// RUN: %lldb %t -o run -o "expression func(a)" -o exit | FileCheck %s
8+
9+
// CHECK: expression func(a)
10+
// CHECK: (int) $0 = 15
11+
12+
namespace {
13+
struct InAnon {};
14+
} // namespace
15+
16+
int func(InAnon a) { return 15; }
17+
18+
int main() {
19+
InAnon a;
20+
__builtin_debugtrap();
21+
return func(a);
22+
}

0 commit comments

Comments
 (0)