-
Notifications
You must be signed in to change notification settings - Fork 13.3k
[Serialization] Fix lazy template loading #133057
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
The code is applied from ODRHash::AddDecl with the reasoning given in the comment, to reduce collisions. This was particularly visible with STL types templated on std::pair where its template arguments were not taken into account.
It is unclear (to me) why this needs to be done "for safety", but this change significantly improves the effectiveness of lazy loading.
Similar as the last commit, it is unclear why we need to load all specializations, including non-partial ones, when we have a TPL.
While it is correct to assign a single fixed hash to all template arguments, it can reduce the effectiveness of lazy loading and is not actually needed: we are allowed to ignore parts that cannot be handled because they will be analogously ignored by all hashings.
@llvm/pr-subscribers-clang-modules @llvm/pr-subscribers-clang Author: Jonas Hahnfeld (hahnjo) Changes
Full diff: https://github.com/llvm/llvm-project/pull/133057.diff 3 Files Affected:
diff --git a/clang/lib/AST/DeclTemplate.cpp b/clang/lib/AST/DeclTemplate.cpp
index c0f5be51db5f3..8560c3928aa84 100644
--- a/clang/lib/AST/DeclTemplate.cpp
+++ b/clang/lib/AST/DeclTemplate.cpp
@@ -367,12 +367,6 @@ bool RedeclarableTemplateDecl::loadLazySpecializationsImpl(
if (!ExternalSource)
return false;
- // If TPL is not null, it implies that we're loading specializations for
- // partial templates. We need to load all specializations in such cases.
- if (TPL)
- return ExternalSource->LoadExternalSpecializations(this->getCanonicalDecl(),
- /*OnlyPartial=*/false);
-
return ExternalSource->LoadExternalSpecializations(this->getCanonicalDecl(),
Args);
}
diff --git a/clang/lib/Serialization/ASTReader.cpp b/clang/lib/Serialization/ASTReader.cpp
index 0cd2cedb48dd9..eb0496c97eb3b 100644
--- a/clang/lib/Serialization/ASTReader.cpp
+++ b/clang/lib/Serialization/ASTReader.cpp
@@ -7891,14 +7891,8 @@ void ASTReader::CompleteRedeclChain(const Decl *D) {
}
}
- if (Template) {
- // For partitial specialization, load all the specializations for safety.
- if (isa<ClassTemplatePartialSpecializationDecl,
- VarTemplatePartialSpecializationDecl>(D))
- Template->loadLazySpecializationsImpl();
- else
- Template->loadLazySpecializationsImpl(Args);
- }
+ if (Template)
+ Template->loadLazySpecializationsImpl(Args);
}
CXXCtorInitializer **
diff --git a/clang/lib/Serialization/TemplateArgumentHasher.cpp b/clang/lib/Serialization/TemplateArgumentHasher.cpp
index 3c7177b83ba52..5fb363c4ab148 100644
--- a/clang/lib/Serialization/TemplateArgumentHasher.cpp
+++ b/clang/lib/Serialization/TemplateArgumentHasher.cpp
@@ -21,17 +21,6 @@ using namespace clang;
namespace {
class TemplateArgumentHasher {
- // If we bail out during the process of calculating hash values for
- // template arguments for any reason. We're allowed to do it since
- // TemplateArgumentHasher are only required to give the same hash value
- // for the same template arguments, but not required to give different
- // hash value for different template arguments.
- //
- // So in the worst case, it is still a valid implementation to give all
- // inputs the same BailedOutValue as output.
- bool BailedOut = false;
- static constexpr unsigned BailedOutValue = 0x12345678;
-
llvm::FoldingSetNodeID ID;
public:
@@ -41,14 +30,7 @@ class TemplateArgumentHasher {
void AddInteger(unsigned V) { ID.AddInteger(V); }
- unsigned getValue() {
- if (BailedOut)
- return BailedOutValue;
-
- return ID.computeStableHash();
- }
-
- void setBailedOut() { BailedOut = true; }
+ unsigned getValue() { return ID.computeStableHash(); }
void AddType(const Type *T);
void AddQualType(QualType T);
@@ -92,8 +74,7 @@ void TemplateArgumentHasher::AddTemplateArgument(TemplateArgument TA) {
case TemplateArgument::Expression:
// If we meet expression in template argument, it implies
// that the template is still dependent. It is meaningless
- // to get a stable hash for the template. Bail out simply.
- BailedOut = true;
+ // to get a stable hash for the template.
break;
case TemplateArgument::Pack:
AddInteger(TA.pack_size());
@@ -110,10 +91,9 @@ void TemplateArgumentHasher::AddStructuralValue(const APValue &Value) {
// 'APValue::Profile' uses pointer values to make hash for LValue and
// MemberPointer, but they differ from one compiler invocation to another.
- // It may be difficult to handle such cases. Bail out simply.
+ // It may be difficult to handle such cases.
if (Kind == APValue::LValue || Kind == APValue::MemberPointer) {
- BailedOut = true;
return;
}
@@ -135,14 +115,11 @@ void TemplateArgumentHasher::AddTemplateName(TemplateName Name) {
case TemplateName::DependentTemplate:
case TemplateName::SubstTemplateTemplateParm:
case TemplateName::SubstTemplateTemplateParmPack:
- BailedOut = true;
break;
case TemplateName::UsingTemplate: {
UsingShadowDecl *USD = Name.getAsUsingShadowDecl();
if (USD)
AddDecl(USD->getTargetDecl());
- else
- BailedOut = true;
break;
}
case TemplateName::DeducedTemplate:
@@ -167,7 +144,6 @@ void TemplateArgumentHasher::AddDeclarationName(DeclarationName Name) {
case DeclarationName::ObjCZeroArgSelector:
case DeclarationName::ObjCOneArgSelector:
case DeclarationName::ObjCMultiArgSelector:
- BailedOut = true;
break;
case DeclarationName::CXXConstructorName:
case DeclarationName::CXXDestructorName:
@@ -194,16 +170,29 @@ void TemplateArgumentHasher::AddDeclarationName(DeclarationName Name) {
void TemplateArgumentHasher::AddDecl(const Decl *D) {
const NamedDecl *ND = dyn_cast<NamedDecl>(D);
if (!ND) {
- BailedOut = true;
return;
}
AddDeclarationName(ND->getDeclName());
+
+ // If this was a specialization we should take into account its template
+ // arguments. This helps to reduce collisions coming when visiting template
+ // specialization types (eg. when processing type template arguments).
+ ArrayRef<TemplateArgument> Args;
+ if (auto *CTSD = dyn_cast<ClassTemplateSpecializationDecl>(D))
+ Args = CTSD->getTemplateArgs().asArray();
+ else if (auto *VTSD = dyn_cast<VarTemplateSpecializationDecl>(D))
+ Args = VTSD->getTemplateArgs().asArray();
+ else if (auto *FD = dyn_cast<FunctionDecl>(D))
+ if (FD->getTemplateSpecializationArgs())
+ Args = FD->getTemplateSpecializationArgs()->asArray();
+
+ for (auto &TA : Args)
+ AddTemplateArgument(TA);
}
void TemplateArgumentHasher::AddQualType(QualType T) {
if (T.isNull()) {
- BailedOut = true;
return;
}
SplitQualType split = T.split();
@@ -213,7 +202,6 @@ void TemplateArgumentHasher::AddQualType(QualType T) {
// Process a Type pointer. Add* methods call back into TemplateArgumentHasher
// while Visit* methods process the relevant parts of the Type.
-// Any unhandled type will make the hash computation bail out.
class TypeVisitorHelper : public TypeVisitor<TypeVisitorHelper> {
typedef TypeVisitor<TypeVisitorHelper> Inherited;
llvm::FoldingSetNodeID &ID;
@@ -245,9 +233,6 @@ class TypeVisitorHelper : public TypeVisitor<TypeVisitorHelper> {
void Visit(const Type *T) { Inherited::Visit(T); }
- // Unhandled types. Bail out simply.
- void VisitType(const Type *T) { Hash.setBailedOut(); }
-
void VisitAdjustedType(const AdjustedType *T) {
AddQualType(T->getOriginalType());
}
|
While I may not able to look into them in detail recently, it may be helpful to split this into seperate patches to review and to land. |
I initially considered this, but @vgvassilev said in root-project/root#17722 (comment) he prefers a single PR, also for external testing. |
@ilya-biryukov, would you mind giving this PR a test on your infrastructure and if it works maybe share some performance results? |
Performance measurements with LLVMI tested these patches for building LLVM itself with modules ( I did some measurements for individual files, chosen by searching for large object files and excluding generated files. For each version, I first build LLVM completely to populate the
before*: reverting fb2c9d9, c5e4afe, 30ea0f0, 20e9049 on current |
Backport upstream PR llvm/llvm-project#133057
Backport upstream PR llvm/llvm-project#133057
Sure, let me try kicking it off. Note that our infrastructure is much better at detecting the compilations timing out than providing proper benchmarking at scale (there are a few targeted benchmarks too, though). I'll try to give you what we have, though. |
Maybe you can test it with this and land it with different patches. So that we can revert one of them if either of them are problematic but other parts are fine. |
This comes from the logic: if we have a partial template specialization |
Backport upstream PR llvm/llvm-project#133057
I'm ok with pushing the commits one-by-one after the PR is reviewed, just let me know.
Sure, but in my understanding, that's not needed on the //--- partial.cppm
export module partial;
export template <typename S, typename T, typename U>
struct Partial {
static constexpr int Value() { return 0; }
};
export template <typename T, typename U>
struct Partial<int, T, U> {
static constexpr int Value() { return 1; }
};
//--- partial.cpp
import partial;
static_assert(Partial<int, double, double>::Value() == 1); (I assume that's what you have in mind?) I see two calls to |
This is a relatively small patch focused on reducing the round trips to modules deserialization. I see this as an atomic change that if it goes in partially would defeat its purpose. What's the goal of a partial optimization? |
If it works, I feel good with it. |
I think partial optimizations are optimization too. If these codes are not dependent on each other, it should be better to split them. Given the scale of the patch, it may not be serious problem actually. I still think it is better to land them separately, but if you want to save some typings. I don't feel too bad. |
Honestly I am more concerned about the tests that @ilya-biryukov is running. As long as they are happy I do not particularly care about commit style. Although it'd be weird to land 40 line patch in many commits :) |
I don't feel odd. I remember it is (or was) LLVM's policy that smaller patches are preferred : ) |
Backport upstream PR llvm/llvm-project#133057
The small-scale benchmarks we had show 10% improvement in CPU and 23% improvement in memory usage for some compilations! We did hit one compiler error that does not reproduce without modules, however: We're in the process of getting a small reproducer (please bear with us, it takes some time) that we can share. @emaxx-google is working on it. |
That's very good news. I think we can further reduce these times. IIRC, we still deserialize declarations that we do not need. One of the places to look is the logic that kicks in when at module loading time:
Ouch. If that's the only issue on your infrastructure that's probably not so bad.
|
Here's the (almost) minimized reproducer for this UPD: To run the reproducer, first "unpack" the archive into separate files using LLVM's |
Thanks for the efforts! I only had a very quick look and it seems the paste is not complete. For example, class Class1 {
public: and many other definitions look incomplete as well. Can you check if there was maybe a mistake? |
That's how it looks like - the minimizer tool (based on C-Reduce/C-Vise) basically works by randomly removing chunks of code, which does often end up with code that looks corrupted. The tool could at least do a better job by merging/inlining unnecessary headers, macros, etc., but at least the output, as shared, should be sufficient to trigger the error in question ( |
I had a closer look, but I get plenty of compile errors already on
I haven't even applied the change in this PR - what am I missing? |
You're right - before sharing the reproducer I cross-checked that the error isn't produced by a slightly older version of Clang (a few weeks old), but I didn't check the most recent version. Apparently something changed in the last few weeks that affects this error regardless of your change. OK, I'm re-running the minimization now, this time with the interestingness test being "the given error is produced by compiler1 and not produced by compiler2=dd3addf954ac7e704fccc7d011217ba10461c883". |
Backport upstream PR llvm/llvm-project#133057
Backport upstream PR llvm/llvm-project#133057
Hi @emaxx-google, any updates on the second minimization run? |
Here's a new reproducer, this time verifying that a semi-fresh tip-of-the-tree doesn't trigger the same error: https://pastebin.com/7tYfjazz. Apologies for the delay. |
Thanks. I gave it a try, but I don't see any |
Creduce-like tools are very bad at finding reject valid codes. @emaxx-google, can you paste your interestingness test? |
@@ -367,12 +367,6 @@ bool RedeclarableTemplateDecl::loadLazySpecializationsImpl( | |||
if (!ExternalSource) | |||
return false; | |||
|
|||
// If TPL is not null, it implies that we're loading specializations for | |||
// partial templates. We need to load all specializations in such cases. | |||
if (TPL) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Then we can remove TPL arguments
// If we bail out during the process of calculating hash values for | ||
// template arguments for any reason. We're allowed to do it since | ||
// TemplateArgumentHasher are only required to give the same hash value | ||
// for the same template arguments, but not required to give different | ||
// hash value for different template arguments. | ||
// | ||
// So in the worst case, it is still a valid implementation to give all | ||
// inputs the same BailedOutValue as output. | ||
bool BailedOut = false; | ||
static constexpr unsigned BailedOutValue = 0x12345678; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I have a concern for this. If we have two semantically same Decl/Type but not literally same, if we give them different hash value, we will pay for additional specialization cost.
I didn't investigate the error - but could it come from autogenerated operators?
Here's the (slightly smaller) input: https://pastebin.com/dBy1T9fc . The simplified script: https://pastebin.com/udVTaPYV . Its output: https://pastebin.com/Mcq0Y0rf . |
Aaaah, the important line is --- main.log 2025-04-11 14:31:26.655249634 +0200
+++ clang-modules-rebased.log 2025-04-11 14:30:12.184305904 +0200
@@ -417,12 +417,15 @@
TR7.cc:4:1: error: a type specifier is required for all declarations
4 | std (
| ^
-TR7.cc:8:1: error: 'operator type-parameter-0-0' is a private member of 'sr::g<char, sr::kh, wjr>'
+TR7.cc:7:3: error: use of overloaded operator '=' is ambiguous (with operand types 'uz<wd>' and 'g<char, kh, wjr>')
+ 7 | q =
+ | ~ ^
8 | dp(h, '\n')
- | ^~~~~~~~~~~
-./UL8.h:6:1: note: implicitly declared private here
- 6 | operator pzx(;
- | ^
+ | ~~~~~~~~~~~
+L3Z:31:7: note: candidate function (the implicit copy assignment operator)
+ 31 | class uz {typede x t;
+ | ^
+L3Z:31:7: note: candidate function (the implicit move assignment operator)
TR7.cc:8:12: error: expected ';' after expression
8 | dp(h, '\n')
| ^ When I have time, I will need to see that I turn the reduced example into actual valid code to understand what is going on... |
A reduce strategy that often worked for me is to have the broken compiler in modules mode but the working compiler in non-modules mode. If you prepend a tool such as https://github.com/Teemperor/hippie you can get all read by the compiler files in a readable area. Then you can use (-isysroot or the same tool to feed them back to the compiler). In this case you will have a "flat" TU which can run in both modules and non-modules mode. I hope that helps with that case, too... PS: Then the interestingness test becomes |
I spent some time turning it into valid code, but then noticed that the |
Understood. JFYI I've been running another minimization task, this time without the We do have tools to filter out unrelated files, still the initial input size is that big. But we continue looking into various aspects of the minimization performance. |
ODRHash::AddDecl
with the reasoning given in the comment, to reduce collisions. This was particularly visible with STL types templated onstd::pair
where its template arguments were not taken into account.TPL
.TemplateArgumentHasher
: While it is correct to assign a single fixed hash to all templatearguments, it can reduce the effectiveness of lazy loading and is not actually needed: we are allowed to ignore parts that cannot be handled because they will be analogously ignored by all hashings.