Files
carbon-lang/toolchain/lower/mangler.cpp
T
4845f40dff 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>
2024-09-12 16:42:08 +00:00

116 lines
4.0 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/lower/mangler.h"
#include "toolchain/base/kind_switch.h"
#include "toolchain/sem_ir/entry_point.h"
namespace Carbon::Lower {
auto Mangler::MangleInverseQualifiedNameScope(llvm::raw_ostream& os,
SemIR::NameScopeId name_scope_id)
-> void {
// Maintain a stack of names for delayed rendering of interface impls.
struct NameEntry {
SemIR::NameScopeId name_scope_id;
// The prefix emitted before this name component. If '\0', no prefix will be
// emitted.
// - Namespace components are separated by '.'.
// - The two components of an interface are separated by ':'.
char prefix;
};
llvm::SmallVector<NameEntry> names_to_render;
names_to_render.push_back({.name_scope_id = name_scope_id, .prefix = '.'});
while (!names_to_render.empty()) {
auto [name_scope_id, prefix] = names_to_render.pop_back_val();
if (prefix) {
os << prefix;
}
if (name_scope_id == SemIR::NameScopeId::Package) {
if (auto package_id = sem_ir().package_id(); package_id.is_valid()) {
os << sem_ir().identifiers().Get(package_id);
} else {
os << "Main";
}
continue;
}
const auto& name_scope = sem_ir().name_scopes().Get(name_scope_id);
CARBON_KIND_SWITCH(sem_ir().insts().Get(name_scope.inst_id)) {
case CARBON_KIND(SemIR::ImplDecl impl_decl): {
const auto& impl = sem_ir().impls().Get(impl_decl.impl_id);
auto interface_type =
types().GetAs<SemIR::InterfaceType>(impl.constraint_id);
const auto& interface =
sem_ir().interfaces().Get(interface_type.interface_id);
names_to_render.push_back(
{.name_scope_id = interface.scope_id, .prefix = ':'});
CARBON_KIND_SWITCH(types().GetAsInst(impl.self_id)) {
case CARBON_KIND(SemIR::ClassType class_type): {
auto next_name_scope_id =
sem_ir().classes().Get(class_type.class_id).scope_id;
names_to_render.push_back(
{.name_scope_id = next_name_scope_id, .prefix = '\0'});
break;
}
case CARBON_KIND(SemIR::BuiltinInst builtin_inst): {
os << builtin_inst.builtin_inst_kind.label();
break;
}
default:
CARBON_FATAL("Attempting to mangle unsupported SemIR.");
break;
}
// Skip the tail of the loop that adds the parent name scope to the
// stack - the scope in which the impl was defined is not part of the
// mangling, the constraint and interface alone uniquelify identify an
// impl.
continue;
}
case CARBON_KIND(SemIR::ClassDecl class_decl): {
os << names().GetAsStringIfIdentifier(
sem_ir().classes().Get(class_decl.class_id).name_id);
break;
}
case CARBON_KIND(SemIR::InterfaceDecl interface_decl): {
os << names().GetAsStringIfIdentifier(
sem_ir().interfaces().Get(interface_decl.interface_id).name_id);
break;
}
case SemIR::Namespace::Kind: {
os << names().GetAsStringIfIdentifier(name_scope.name_id);
break;
}
default:
CARBON_FATAL("Attempting to mangle unsupported SemIR.");
break;
}
names_to_render.push_back(
{.name_scope_id = name_scope.parent_scope_id, .prefix = '.'});
}
}
auto Mangler::Mangle(SemIR::FunctionId function_id) -> std::string {
// FIXME: Add support for generic entities.
const auto& function = sem_ir().functions().Get(function_id);
if (SemIR::IsEntryPoint(sem_ir(), function_id)) {
return "main";
}
std::string result;
llvm::raw_string_ostream os(result);
os << "_C";
os << names().GetAsStringIfIdentifier(function.name_id);
MangleInverseQualifiedNameScope(os, function.parent_scope_id);
return os.str();
}
} // namespace Carbon::Lower