mirror of
https://github.com/carbon-language/carbon-lang.git
synced 2026-10-05 13:51:05 +01:00
Switch CARBON_CHECK to a format string API (#4285)
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
co-authored by
Richard Smith
josh11b
Richard Smith
josh11b
parent
35dfa5f03c
commit
4845f40dff
+19
-20
@@ -555,8 +555,8 @@ class DeferredDefinitionWorklist {
|
||||
|
||||
// CHECK that the work list has no further work.
|
||||
auto VerifyEmpty() {
|
||||
CARBON_CHECK(worklist_.empty() && entered_scopes_.empty())
|
||||
<< "Tasks left behind on worklist.";
|
||||
CARBON_CHECK(worklist_.empty() && entered_scopes_.empty(),
|
||||
"Tasks left behind on worklist.");
|
||||
}
|
||||
|
||||
private:
|
||||
@@ -627,8 +627,8 @@ auto DeferredDefinitionWorklist::SuspendFinishedScopeAndPush(Context& context)
|
||||
// worklist. We stay in that scope rather than suspending then immediately
|
||||
// resuming it.
|
||||
CARBON_CHECK(
|
||||
holds_alternative<EnterDeferredDefinitionScope>(worklist_.back()))
|
||||
<< "Unexpected task in worklist.";
|
||||
holds_alternative<EnterDeferredDefinitionScope>(worklist_.back()),
|
||||
"Unexpected task in worklist.");
|
||||
worklist_.pop_back();
|
||||
CARBON_VLOG("{0}Handle EnterDeferredDefinitionScope (non-nested)\n",
|
||||
VlogPrefix);
|
||||
@@ -690,8 +690,8 @@ class NodeIdTraversal {
|
||||
auto PerformTask(
|
||||
DeferredDefinitionWorklist::EnterDeferredDefinitionScope&& enter)
|
||||
-> void {
|
||||
CARBON_CHECK(enter.suspended_name)
|
||||
<< "Entering a scope with no suspension information.";
|
||||
CARBON_CHECK(enter.suspended_name,
|
||||
"Entering a scope with no suspension information.");
|
||||
context_.decl_name_stack().Restore(std::move(*enter.suspended_name));
|
||||
}
|
||||
|
||||
@@ -815,12 +815,10 @@ static auto DiagnoseMissingDefinitions(Context& context,
|
||||
case SemIR::InterfaceDecl::Kind: {
|
||||
// TODO: handle `interface` as well, once we can test it without
|
||||
// triggering https://github.com/carbon-language/carbon-lang/issues/4071
|
||||
CARBON_FATAL()
|
||||
<< "TODO: Support interfaces in DiagnoseMissingDefinitions";
|
||||
CARBON_FATAL("TODO: Support interfaces in DiagnoseMissingDefinitions");
|
||||
}
|
||||
default: {
|
||||
CARBON_FATAL() << "Unexpected inst in definitions_required: "
|
||||
<< decl_inst;
|
||||
CARBON_FATAL("Unexpected inst in definitions_required: {0}", decl_inst);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -851,14 +849,15 @@ static auto ProcessNodeIds(Context& context, llvm::raw_ostream* vlog_stream,
|
||||
auto parse_kind = context.parse_tree().node_kind(node_id);
|
||||
|
||||
switch (parse_kind) {
|
||||
#define CARBON_PARSE_NODE_KIND(Name) \
|
||||
case Parse::NodeKind::Name: { \
|
||||
if (!HandleParseNode(context, Parse::Name##Id(node_id))) { \
|
||||
CARBON_CHECK(err_tracker.seen_error()) \
|
||||
<< "Handle" #Name " returned false without printing a diagnostic"; \
|
||||
return false; \
|
||||
} \
|
||||
break; \
|
||||
#define CARBON_PARSE_NODE_KIND(Name) \
|
||||
case Parse::NodeKind::Name: { \
|
||||
if (!HandleParseNode(context, Parse::Name##Id(node_id))) { \
|
||||
CARBON_CHECK(err_tracker.seen_error(), \
|
||||
"Handle" #Name \
|
||||
" returned false without printing a diagnostic"); \
|
||||
return false; \
|
||||
} \
|
||||
break; \
|
||||
}
|
||||
#include "toolchain/parse/node_kind.def"
|
||||
}
|
||||
@@ -919,8 +918,8 @@ static auto CheckParseTree(
|
||||
|
||||
#ifndef NDEBUG
|
||||
if (auto verify = sem_ir.Verify(); !verify.ok()) {
|
||||
CARBON_FATAL() << sem_ir << "Built invalid semantics IR: " << verify.error()
|
||||
<< "\n";
|
||||
CARBON_FATAL("{0}Built invalid semantics IR: {1}\n", sem_ir,
|
||||
verify.error());
|
||||
}
|
||||
#endif
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user