carbon-language/carbon-lang
1
0
Fork 0
mirror of https://github.com/carbon-language/carbon-lang.git synced 2026-09-24 22:02:23 +01:00
Code Issues Packages Projects Releases 10 Wiki Activity

Switch CARBON_CHECK to a format string API (#4285)

Browse Source 
This switches `DCHECK` and `FATAL` as well.

The goal is to reduce the code size impact of these assertions so that
we can keep more of them enabled. Currently, the largest cost I see from
`CHECK` is not the actual check or the cold code itself, but actually
the failure to inline trivial functions due to the presence of the cold
code. This means that our goal isn't to reduce apparent code size in the
final binary but the LLVM IR cost assessed for these routines in the
inliner, which closely correlates with code size but is a bit different.

As discussed in #4283, experimentation shows that a single function call
with a minimal number of arguments is the lowest cost model for these.
This is easily achieved with a format-string API that internally uses
`llvm::formatv`. This PR is essentially the `CHECK` version of #4283.

However, the check macros are substantially harder to make work with
both format strings and streaming because they also take a condition.
Also, unexpectedly, I was very successful at devising a regular
expression based automated rewrite from the streaming to the format
string form with only low 10s of manual fixes. This includes compacting
strings broken up across lines, etc. Given how well that went, I've
prepared this PR which just directly switches to the format string API
and migrate everything to use it.

One nice side-effect is that the format string approach ends up greatly
simplifying the implementation here as well.

This is ... *shockingly* effective. Parsing speeds up by more than 3%
with just this change. And checking speeds up by **8%** with this change
alone:
```
BM_CompileAPIFileDenseDecls<Phase::Parse>/256      86.3µs ± 1%  82.9µs ± 1%  -3.94%  (p=0.000 n=17+19)
BM_CompileAPIFileDenseDecls<Phase::Parse>/1024      431µs ± 1%   415µs ± 1%  -3.76%  (p=0.000 n=18+19)
BM_CompileAPIFileDenseDecls<Phase::Parse>/4096     1.77ms ± 1%  1.71ms ± 1%  -3.18%  (p=0.000 n=18+19)
BM_CompileAPIFileDenseDecls<Phase::Parse>/16384    7.44ms ± 1%  7.17ms ± 2%  -3.56%  (p=0.000 n=18+20)
BM_CompileAPIFileDenseDecls<Phase::Parse>/65536    30.7ms ± 1%  29.7ms ± 1%  -3.15%  (p=0.000 n=18+20)
BM_CompileAPIFileDenseDecls<Phase::Parse>/262144    131ms ± 1%   127ms ± 1%  -2.81%  (p=0.000 n=18+18)
BM_CompileAPIFileDenseDecls<Phase::Check>/256       878µs ± 2%   800µs ± 1%  -8.91%  (p=0.000 n=19+20)
BM_CompileAPIFileDenseDecls<Phase::Check>/1024     1.88ms ± 2%  1.72ms ± 1%  -8.56%  (p=0.000 n=19+20)
BM_CompileAPIFileDenseDecls<Phase::Check>/4096     5.78ms ± 2%  5.28ms ± 1%  -8.70%  (p=0.000 n=20+18)
BM_CompileAPIFileDenseDecls<Phase::Check>/16384    21.9ms ± 1%  20.1ms ± 1%  -8.02%  (p=0.000 n=18+20)
BM_CompileAPIFileDenseDecls<Phase::Check>/65536    90.4ms ± 2%  83.1ms ± 1%  -8.04%  (p=0.000 n=19+20)
BM_CompileAPIFileDenseDecls<Phase::Check>/262144    381ms ± 2%   352ms ± 1%  -7.79%  (p=0.000 n=19+19)
```

---------

Co-authored-by: Richard Smith <richard@metafoo.co.uk>
Co-authored-by: josh11b <15258583+josh11b@users.noreply.github.com>
This commit is contained in:
Chandler Carruth
2024-09-12 16:42:08 +00:00
committed by GitHub
co-authored by Richard Smith josh11b
parent 35dfa5f03c
commit 4845f40dff
140 changed files with 1234 additions and 1161 deletions
Download Patch File Download Diff File Expand all files Collapse all files
toolchain/check/scope_stack.cpp
+32 -30
View File
@@ -10,7 +10,7 @@
namespace Carbon::Check {
auto ScopeStack::VerifyOnFinish() -> void {
CARBON_CHECK(scope_stack_.empty()) << scope_stack_.size();
CARBON_CHECK(scope_stack_.empty(), "{0}", scope_stack_.size());
}
auto ScopeStack::Push(SemIR::InstId scope_inst_id, SemIR::NameScopeId scope_id,
@@ -41,13 +41,13 @@ auto ScopeStack::Push(SemIR::InstId scope_inst_id, SemIR::NameScopeId scope_id,
// For lexical lookups, unqualified lookup doesn't know how to find the
// associated specific, so if we start adding lexical scopes associated with
// specifics, we'll need to somehow track them in lookup.
CARBON_CHECK(!specific_id.is_valid())
<< "Lexical scope should not have an associated specific.";
CARBON_CHECK(!specific_id.is_valid(),
"Lexical scope should not have an associated specific.");
}
// TODO: Handle this case more gracefully.
CARBON_CHECK(next_scope_index_.index != std::numeric_limits<int32_t>::max())
<< "Ran out of scopes";
CARBON_CHECK(next_scope_index_.index != std::numeric_limits<int32_t>::max(),
"Ran out of scopes");
++next_scope_index_.index;
}
@@ -56,8 +56,8 @@ auto ScopeStack::Pop() -> void {
scope.names.ForEach([&](SemIR::NameId str_id) {
auto& lexical_results = lexical_lookup_.Get(str_id);
CARBON_CHECK(lexical_results.back().scope_index == scope.index)
<< "Inconsistent scope index for name " << str_id;
CARBON_CHECK(lexical_results.back().scope_index == scope.index,
"Inconsistent scope index for name {0}", str_id);
lexical_results.pop_back();
});
@@ -74,10 +74,11 @@ auto ScopeStack::Pop() -> void {
CARBON_CHECK(
scope.next_compile_time_bind_index.index ==
static_cast<int32_t>(compile_time_binding_stack_.all_values_size()))
<< "Wrong number of entries in compile-time binding stack, have "
<< compile_time_binding_stack_.all_values_size() << ", expected "
<< scope.next_compile_time_bind_index.index;
static_cast<int32_t>(compile_time_binding_stack_.all_values_size()),
"Wrong number of entries in compile-time binding stack, have {0}, "
"expected {1}",
compile_time_binding_stack_.all_values_size(),
scope.next_compile_time_bind_index.index);
compile_time_binding_stack_.PopArray();
}
@@ -85,9 +86,9 @@ auto ScopeStack::PopTo(ScopeIndex index) -> void {
while (PeekIndex() > index) {
Pop();
}
CARBON_CHECK(PeekIndex() == index)
<< "Scope index " << index << " does not enclose the current scope "
<< PeekIndex();
CARBON_CHECK(PeekIndex() == index,
"Scope index {0} does not enclose the current scope {1}", index,
PeekIndex());
}
auto ScopeStack::LookupInCurrentScope(SemIR::NameId name_id) -> SemIR::InstId {
@@ -135,8 +136,8 @@ auto ScopeStack::LookupOrAddName(SemIR::NameId name_id, SemIR::InstId target_id)
-> SemIR::InstId {
if (!scope_stack_.back().names.Insert(name_id).is_inserted()) {
auto existing = lexical_lookup_.Get(name_id).back().inst_id;
CARBON_CHECK(existing.is_valid())
<< "Name in scope but not in lexical lookups";
CARBON_CHECK(existing.is_valid(),
"Name in scope but not in lexical lookups");
return existing;
}
++scope_stack_.back().num_names;
@@ -144,24 +145,25 @@ auto ScopeStack::LookupOrAddName(SemIR::NameId name_id, SemIR::InstId target_id)
// TODO: Reject if we previously performed a failed lookup for this name
// in this scope or a scope nested within it.
auto& lexical_results = lexical_lookup_.Get(name_id);
CARBON_CHECK(lexical_results.empty() ||
lexical_results.back().scope_index < PeekIndex())
<< "Failed to clean up after scope nested within the current scope";
CARBON_CHECK(
lexical_results.empty() ||
lexical_results.back().scope_index < PeekIndex(),
"Failed to clean up after scope nested within the current scope");
lexical_results.push_back({.inst_id = target_id, .scope_index = PeekIndex()});
return SemIR::InstId::Invalid;
}
auto ScopeStack::SetReturnedVarOrGetExisting(SemIR::InstId inst_id)
-> SemIR::InstId {
CARBON_CHECK(!return_scope_stack_.empty()) << "`returned var` in no function";
CARBON_CHECK(!return_scope_stack_.empty(), "`returned var` in no function");
auto& returned_var = return_scope_stack_.back().returned_var;
if (returned_var.is_valid()) {
return returned_var;
}
returned_var = inst_id;
CARBON_CHECK(!scope_stack_.back().has_returned_var)
<< "Scope has returned var but none is set";
CARBON_CHECK(!scope_stack_.back().has_returned_var,
"Scope has returned var but none is set");
if (inst_id.is_valid()) {
scope_stack_.back().has_returned_var = true;
}
@@ -169,7 +171,7 @@ auto ScopeStack::SetReturnedVarOrGetExisting(SemIR::InstId inst_id)
}
auto ScopeStack::Suspend() -> SuspendedScope {
CARBON_CHECK(!scope_stack_.empty()) << "No scope to suspend";
CARBON_CHECK(!scope_stack_.empty(), "No scope to suspend");
SuspendedScope result = {.entry = scope_stack_.pop_back_val(),
.suspended_items = {}};
if (result.entry.scope_id.is_valid()) {
@@ -198,8 +200,8 @@ auto ScopeStack::Suspend() -> SuspendedScope {
compile_time_binding_stack_.PopArray();
// This would be easy to support if we had a need, but currently we do not.
CARBON_CHECK(!result.entry.has_returned_var)
<< "Should not suspend a scope with a returned var.";
CARBON_CHECK(!result.entry.has_returned_var,
"Should not suspend a scope with a returned var.");
return result;
}
@@ -216,11 +218,11 @@ auto ScopeStack::Restore(SuspendedScope scope) -> void {
CARBON_CHECK(
scope.entry.next_compile_time_bind_index.index ==
static_cast<int32_t>(compile_time_binding_stack_.all_values_size()))
<< "Wrong number of entries in compile-time binding stack "
"when restoring, have "
<< compile_time_binding_stack_.all_values_size() << ", expected "
<< scope.entry.next_compile_time_bind_index.index;
static_cast<int32_t>(compile_time_binding_stack_.all_values_size()),
"Wrong number of entries in compile-time binding stack when restoring, "
"have {0}, expected {1}",
compile_time_binding_stack_.all_values_size(),
scope.entry.next_compile_time_bind_index.index);
if (scope.entry.scope_id.is_valid()) {
non_lexical_scope_stack_.push_back(