mirror of
https://github.com/carbon-language/carbon-lang.git
synced 2026-11-17 09:58:10 +00:00
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>
154 lines
5.8 KiB
C++
154 lines
5.8 KiB
C++
// Part of the Carbon Language project, under the Apache License v2.0 with LLVM
|
|
// Exceptions. See /LICENSE for license information.
|
|
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
|
|
|
|
#include "toolchain/check/sem_ir_diagnostic_converter.h"
|
|
|
|
namespace Carbon::Check {
|
|
|
|
auto SemIRDiagnosticConverter::ConvertLoc(SemIRLoc loc,
|
|
ContextFnT context_fn) const
|
|
-> DiagnosticLoc {
|
|
// Cursors for the current IR and instruction in that IR.
|
|
const auto* cursor_ir = sem_ir_;
|
|
auto cursor_inst_id = SemIR::InstId::Invalid;
|
|
|
|
// Notes an import on the diagnostic and updates cursors to point at the
|
|
// imported IR.
|
|
auto follow_import_ref = [&](SemIR::ImportIRInstId import_ir_inst_id) {
|
|
auto import_ir_inst = cursor_ir->import_ir_insts().Get(import_ir_inst_id);
|
|
const auto& import_ir = cursor_ir->import_irs().Get(import_ir_inst.ir_id);
|
|
CARBON_CHECK(import_ir.decl_id.is_valid(),
|
|
"If we get invalid locations here, we may need to more "
|
|
"thoroughly track ImportDecls.");
|
|
|
|
DiagnosticLoc in_import_loc;
|
|
auto import_loc_id = cursor_ir->insts().GetLocId(import_ir.decl_id);
|
|
if (import_loc_id.is_node_id()) {
|
|
// For imports in the current file, the location is simple.
|
|
in_import_loc = ConvertLocInFile(cursor_ir, import_loc_id.node_id(),
|
|
loc.token_only, context_fn);
|
|
} else if (import_loc_id.is_import_ir_inst_id()) {
|
|
// For implicit imports, we need to unravel the location a little
|
|
// further.
|
|
auto implicit_import_ir_inst =
|
|
cursor_ir->import_ir_insts().Get(import_loc_id.import_ir_inst_id());
|
|
const auto& implicit_ir =
|
|
cursor_ir->import_irs().Get(implicit_import_ir_inst.ir_id);
|
|
auto implicit_loc_id =
|
|
implicit_ir.sem_ir->insts().GetLocId(implicit_import_ir_inst.inst_id);
|
|
CARBON_CHECK(implicit_loc_id.is_node_id(),
|
|
"Should only be one layer of implicit imports");
|
|
in_import_loc =
|
|
ConvertLocInFile(implicit_ir.sem_ir, implicit_loc_id.node_id(),
|
|
loc.token_only, context_fn);
|
|
}
|
|
|
|
// TODO: Add an "In implicit import of prelude." note for the case where we
|
|
// don't have a location.
|
|
if (import_loc_id.is_valid()) {
|
|
CARBON_DIAGNOSTIC(InImport, Note, "In import.");
|
|
context_fn(in_import_loc, InImport);
|
|
}
|
|
|
|
cursor_ir = import_ir.sem_ir;
|
|
cursor_inst_id = import_ir_inst.inst_id;
|
|
};
|
|
|
|
// If the location is is an import, follows it and returns nullopt.
|
|
// Otherwise, it's a parse node, so return the final location.
|
|
auto handle_loc = [&](SemIR::LocId loc_id) -> std::optional<DiagnosticLoc> {
|
|
if (loc_id.is_import_ir_inst_id()) {
|
|
follow_import_ref(loc_id.import_ir_inst_id());
|
|
return std::nullopt;
|
|
} else {
|
|
// Parse nodes always refer to the current IR.
|
|
return ConvertLocInFile(cursor_ir, loc_id.node_id(), loc.token_only,
|
|
context_fn);
|
|
}
|
|
};
|
|
|
|
// Handle the base location.
|
|
if (loc.is_inst_id) {
|
|
cursor_inst_id = loc.inst_id;
|
|
} else {
|
|
if (auto diag_loc = handle_loc(loc.loc_id)) {
|
|
return *diag_loc;
|
|
}
|
|
CARBON_CHECK(cursor_inst_id.is_valid(), "Should have been set");
|
|
}
|
|
|
|
while (true) {
|
|
if (cursor_inst_id.is_valid()) {
|
|
auto cursor_inst = cursor_ir->insts().Get(cursor_inst_id);
|
|
if (auto bind_ref = cursor_inst.TryAs<SemIR::ExportDecl>();
|
|
bind_ref && bind_ref->value_id.is_valid()) {
|
|
cursor_inst_id = bind_ref->value_id;
|
|
continue;
|
|
}
|
|
|
|
// If the parse node is valid, use it for the location.
|
|
if (auto loc_id = cursor_ir->insts().GetLocId(cursor_inst_id);
|
|
loc_id.is_valid()) {
|
|
if (auto diag_loc = handle_loc(loc_id)) {
|
|
return *diag_loc;
|
|
}
|
|
continue;
|
|
}
|
|
|
|
// If a namespace has an instruction for an import, switch to looking at
|
|
// it.
|
|
if (auto ns = cursor_inst.TryAs<SemIR::Namespace>()) {
|
|
if (ns->import_id.is_valid()) {
|
|
cursor_inst_id = ns->import_id;
|
|
continue;
|
|
}
|
|
}
|
|
}
|
|
|
|
// Invalid parse node but not an import; just nothing to point at.
|
|
return ConvertLocInFile(cursor_ir, Parse::NodeId::Invalid, loc.token_only,
|
|
context_fn);
|
|
}
|
|
}
|
|
|
|
auto SemIRDiagnosticConverter::ConvertArg(llvm::Any arg) const -> llvm::Any {
|
|
if (auto* library_name_id = llvm::any_cast<SemIR::LibraryNameId>(&arg)) {
|
|
std::string library_name;
|
|
if (*library_name_id == SemIR::LibraryNameId::Default) {
|
|
library_name = "default library";
|
|
} else if (!library_name_id->is_valid()) {
|
|
library_name = "library <invalid>";
|
|
} else {
|
|
llvm::raw_string_ostream stream(library_name);
|
|
stream << "library \"";
|
|
stream << sem_ir_->string_literal_values().Get(
|
|
library_name_id->AsStringLiteralValueId());
|
|
stream << "\"";
|
|
}
|
|
return library_name;
|
|
}
|
|
if (auto* name_id = llvm::any_cast<SemIR::NameId>(&arg)) {
|
|
return sem_ir_->names().GetFormatted(*name_id).str();
|
|
}
|
|
if (auto* type_id = llvm::any_cast<SemIR::TypeId>(&arg)) {
|
|
return sem_ir_->StringifyType(*type_id);
|
|
}
|
|
if (auto* typed_int = llvm::any_cast<TypedInt>(&arg)) {
|
|
return llvm::APSInt(typed_int->value,
|
|
!sem_ir_->types().IsSignedInt(typed_int->type));
|
|
}
|
|
return DiagnosticConverter<SemIRLoc>::ConvertArg(arg);
|
|
}
|
|
|
|
auto SemIRDiagnosticConverter::ConvertLocInFile(const SemIR::File* sem_ir,
|
|
Parse::NodeId node_id,
|
|
bool token_only,
|
|
ContextFnT context_fn) const
|
|
-> DiagnosticLoc {
|
|
return node_converters_[sem_ir->check_ir_id().index].ConvertLoc(
|
|
Parse::NodeLoc(node_id, token_only), context_fn);
|
|
}
|
|
|
|
} // namespace Carbon::Check
|