Skip to content

Commit 030047c

Browse files
authored
[Clang] Eagerly instantiate used constexpr function upon definition. (llvm#73463)
Despite CWG2497 not being resolved, it is reasonable to expect the following code to compile (and which is supported by other compilers) ```cpp template<typename T> constexpr T f(); constexpr int g() { return f<int>(); } // #1 template<typename T> constexpr T f() { return 123; } int k[g()]; // #2 ``` To that end, we eagerly instantiate all referenced specializations of constexpr functions when they are defined. We maintain a map of (pattern, [instantiations]) independent of `PendingInstantiations` to avoid having to iterate that list after each function definition. We should apply the same logic to constexpr variables, but I wanted to keep the PR small. Fixes llvm#73232
1 parent 8a66510 commit 030047c

14 files changed

+165
-2
lines changed

clang/docs/ReleaseNotes.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -793,6 +793,11 @@ Bug Fixes to C++ Support
793793
- Fix crash when parsing nested requirement. Fixes:
794794
(`#73112 <https://github.com/llvm/llvm-project/issues/73112>`_)
795795

796+
- Clang now immediately instantiates function template specializations
797+
at the end of the definition of the corresponding function template
798+
when the definition appears after the first point of instantiation.
799+
(`#73232 <https://github.com/llvm/llvm-project/issues/73232>`_)
800+
796801
Bug Fixes to AST Handling
797802
^^^^^^^^^^^^^^^^^^^^^^^^^
798803
- Fixed an import failure of recursive friend class template.

clang/include/clang/Sema/ExternalSemaSource.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -181,6 +181,9 @@ class ExternalSemaSource : public ExternalASTSource {
181181
SmallVectorImpl<std::pair<ValueDecl *,
182182
SourceLocation> > &Pending) {}
183183

184+
virtual void ReadPendingInstantiationsOfConstexprEntity(
185+
const NamedDecl *D, llvm::SmallSetVector<NamedDecl *, 4> &Decls){};
186+
184187
/// Read the set of late parsed template functions for this source.
185188
///
186189
/// The external source should insert its own late parsed template functions

clang/include/clang/Sema/MultiplexExternalSemaSource.h

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -319,6 +319,9 @@ class MultiplexExternalSemaSource : public ExternalSemaSource {
319319
void ReadPendingInstantiations(
320320
SmallVectorImpl<std::pair<ValueDecl*, SourceLocation> >& Pending) override;
321321

322+
virtual void ReadPendingInstantiationsOfConstexprEntity(
323+
const NamedDecl *D, llvm::SmallSetVector<NamedDecl *, 4> &Decls) override;
324+
322325
/// Read the set of late parsed template functions for this source.
323326
///
324327
/// The external source should insert its own late parsed template functions

clang/include/clang/Sema/Sema.h

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,7 @@
5959
#include "clang/Sema/TypoCorrection.h"
6060
#include "clang/Sema/Weak.h"
6161
#include "llvm/ADT/ArrayRef.h"
62+
#include "llvm/ADT/DenseMap.h"
6263
#include "llvm/ADT/SetVector.h"
6364
#include "llvm/ADT/SmallBitVector.h"
6465
#include "llvm/ADT/SmallPtrSet.h"
@@ -10087,6 +10088,12 @@ class Sema final {
1008710088
/// but have not yet been performed.
1008810089
std::deque<PendingImplicitInstantiation> PendingInstantiations;
1008910090

10091+
/// Track constexpr functions referenced before they are (lexically) defined.
10092+
/// The key is the pattern, associated with a list of specialisations that
10093+
/// need to be instantiated when the pattern is defined.
10094+
llvm::DenseMap<NamedDecl *, SmallVector<NamedDecl *>>
10095+
PendingInstantiationsOfConstexprEntities;
10096+
1009010097
/// Queue of implicit template instantiations that cannot be performed
1009110098
/// eagerly.
1009210099
SmallVector<PendingImplicitInstantiation, 1> LateParsedInstantiations;
@@ -10405,6 +10412,9 @@ class Sema final {
1040510412
bool Recursive = false,
1040610413
bool DefinitionRequired = false,
1040710414
bool AtEndOfTU = false);
10415+
10416+
void PerformPendingInstantiationsOfConstexprFunctions(FunctionDecl *Template);
10417+
1040810418
VarTemplateSpecializationDecl *BuildVarTemplateInstantiation(
1040910419
VarTemplateDecl *VarTemplate, VarDecl *FromVar,
1041010420
const TemplateArgumentList &TemplateArgList,

clang/include/clang/Serialization/ASTBitCodes.h

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -695,6 +695,10 @@ enum ASTRecordTypes {
695695
/// Record code for an unterminated \#pragma clang assume_nonnull begin
696696
/// recorded in a preamble.
697697
PP_ASSUME_NONNULL_LOC = 67,
698+
699+
/// Record code for constexpr templated entities that have been used but not
700+
/// yet instantiated.
701+
PENDING_INSTANTIATIONS_OF_CONSTEXPR_ENTITIES = 68,
698702
};
699703

700704
/// Record types used within a source manager block.

clang/include/clang/Serialization/ASTReader.h

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -814,6 +814,9 @@ class ASTReader
814814
/// is the instantiation location.
815815
SmallVector<serialization::DeclID, 64> PendingInstantiations;
816816

817+
llvm::DenseMap<serialization::DeclID, std::set<serialization::DeclID>>
818+
PendingInstantiationsOfConstexprEntities;
819+
817820
//@}
818821

819822
/// \name DiagnosticsEngine-relevant special data
@@ -2101,6 +2104,9 @@ class ASTReader
21012104
SmallVectorImpl<std::pair<ValueDecl *,
21022105
SourceLocation>> &Pending) override;
21032106

2107+
virtual void ReadPendingInstantiationsOfConstexprEntity(
2108+
const NamedDecl *D, llvm::SmallSetVector<NamedDecl *, 4> &Decls) override;
2109+
21042110
void ReadLateParsedTemplates(
21052111
llvm::MapVector<const FunctionDecl *, std::unique_ptr<LateParsedTemplate>>
21062112
&LPTMap) override;

clang/lib/Sema/MultiplexExternalSemaSource.cpp

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -310,6 +310,12 @@ void MultiplexExternalSemaSource::ReadPendingInstantiations(
310310
Sources[i]->ReadPendingInstantiations(Pending);
311311
}
312312

313+
void MultiplexExternalSemaSource::ReadPendingInstantiationsOfConstexprEntity(
314+
const NamedDecl *D, llvm::SmallSetVector<NamedDecl *, 4> &Decls) {
315+
for (size_t i = 0; i < Sources.size(); ++i)
316+
Sources[i]->ReadPendingInstantiationsOfConstexprEntity(D, Decls);
317+
};
318+
313319
void MultiplexExternalSemaSource::ReadLateParsedTemplates(
314320
llvm::MapVector<const FunctionDecl *, std::unique_ptr<LateParsedTemplate>>
315321
&LPTMap) {

clang/lib/Sema/SemaDecl.cpp

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16275,6 +16275,9 @@ Decl *Sema::ActOnFinishFunctionBody(Decl *dcl, Stmt *Body,
1627516275
if (FD && !FD->isDeleted())
1627616276
checkTypeSupport(FD->getType(), FD->getLocation(), FD);
1627716277

16278+
if (FD && FD->isConstexpr() && FD->isTemplated())
16279+
PerformPendingInstantiationsOfConstexprFunctions(FD);
16280+
1627816281
return dcl;
1627916282
}
1628016283

clang/lib/Sema/SemaExpr.cpp

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19053,12 +19053,17 @@ void Sema::MarkFunctionReferenced(SourceLocation Loc, FunctionDecl *Func,
1905319053
CodeSynthesisContexts.size())
1905419054
PendingLocalImplicitInstantiations.push_back(
1905519055
std::make_pair(Func, PointOfInstantiation));
19056-
else if (Func->isConstexpr())
19056+
else if (Func->isConstexpr()) {
1905719057
// Do not defer instantiations of constexpr functions, to avoid the
1905819058
// expression evaluator needing to call back into Sema if it sees a
1905919059
// call to such a function.
1906019060
InstantiateFunctionDefinition(PointOfInstantiation, Func);
19061-
else {
19061+
if (!Func->isDefined()) {
19062+
PendingInstantiationsOfConstexprEntities
19063+
[Func->getTemplateInstantiationPattern()->getCanonicalDecl()]
19064+
.push_back(Func);
19065+
}
19066+
} else {
1906219067
Func->setInstantiationIsPending(true);
1906319068
PendingInstantiations.push_back(
1906419069
std::make_pair(Func, PointOfInstantiation));

clang/lib/Sema/SemaTemplateInstantiateDecl.cpp

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6495,6 +6495,34 @@ void Sema::PerformPendingInstantiations(bool LocalOnly) {
64956495
PendingInstantiations.swap(delayedPCHInstantiations);
64966496
}
64976497

6498+
// Instantiate all referenced specializations of the given function template
6499+
// definition. This make sure that constexpr function templates that are defined
6500+
// after the point of instantiation of their use can be evaluated after they
6501+
// are defined. see CWG2497.
6502+
void Sema::PerformPendingInstantiationsOfConstexprFunctions(FunctionDecl *Tpl) {
6503+
6504+
auto InstantiateAll = [&](const auto &Range) {
6505+
for (NamedDecl *D : Range) {
6506+
FunctionDecl *Fun = cast<FunctionDecl>(D);
6507+
InstantiateFunctionDefinition(Fun->getPointOfInstantiation(), Fun);
6508+
}
6509+
};
6510+
6511+
auto It =
6512+
PendingInstantiationsOfConstexprEntities.find(Tpl->getCanonicalDecl());
6513+
if (It != PendingInstantiationsOfConstexprEntities.end()) {
6514+
auto Decls = std::move(It->second);
6515+
PendingInstantiationsOfConstexprEntities.erase(It);
6516+
InstantiateAll(Decls);
6517+
}
6518+
6519+
llvm::SmallSetVector<NamedDecl *, 4> Decls;
6520+
if (ExternalSource) {
6521+
ExternalSource->ReadPendingInstantiationsOfConstexprEntity(Tpl, Decls);
6522+
InstantiateAll(Decls);
6523+
}
6524+
}
6525+
64986526
void Sema::PerformDependentDiagnostics(const DeclContext *Pattern,
64996527
const MultiLevelTemplateArgumentList &TemplateArgs) {
65006528
for (auto *DD : Pattern->ddiags()) {

0 commit comments

Comments
 (0)