Refactor NodeStack APIs to better handle the increase of distinct ID types. (#2864)

I'm looking at adding CallableId, so figured I'd do this API refactoring which should reduce code duplication. This increases the amount of cross-calls between APIs because it may not be an issue for performance after optimizations, and should simplify reading of the API.

Also note the prior static_asserts on layout were missing a couple types, which is why I'm moving them into Entry where it's going to be more obvious when something's added.
This commit is contained in:
Jon Ross-Perkins
2023-06-01 16:39:02 -07:00
committed by GitHub
parent c83eea3ce2
commit a1a7251716
7 changed files with 166 additions and 259 deletions
@@ -4,167 +4,10 @@
#include "toolchain/semantics/semantics_node_stack.h"
#include "common/vlog.h"
#include "toolchain/semantics/semantics_node.h"
namespace Carbon {
auto SemanticsNodeStack::PushEntry(Entry entry, DebugLog debug_log) -> void {
CARBON_VLOG() << "Node Push " << stack_.size() << ": "
<< parse_tree_->node_kind(entry.parse_node) << " -> ";
switch (debug_log) {
case DebugLog::None:
CARBON_VLOG() << "<none>";
break;
case DebugLog::NodeId:
CARBON_VLOG() << entry.node_id;
break;
case DebugLog::NodeBlockId:
CARBON_VLOG() << entry.node_block_id;
break;
case DebugLog::NameId:
CARBON_VLOG() << entry.name_id;
break;
case DebugLog::TypeId:
CARBON_VLOG() << entry.type_id;
break;
}
CARBON_VLOG() << "\n";
CARBON_CHECK(stack_.size() < (1 << 20))
<< "Excessive stack size: likely infinite loop";
stack_.push_back(entry);
}
auto SemanticsNodeStack::PopEntry() -> Entry {
auto back = stack_.pop_back_val();
CARBON_VLOG() << "Node Pop " << stack_.size() << ": any ("
<< parse_tree_->node_kind(back.parse_node) << ") -> "
<< back.node_id << "\n";
return back;
}
auto SemanticsNodeStack::PopEntry(ParseNodeKind pop_parse_kind) -> Entry {
auto back = stack_.pop_back_val();
CARBON_VLOG() << "Node Pop " << stack_.size() << ": " << pop_parse_kind
<< " -> " << back.node_id << "\n";
RequireParseKind(back, pop_parse_kind);
return back;
}
auto SemanticsNodeStack::RequireParseKind(Entry entry,
ParseNodeKind require_kind) -> void {
auto actual_kind = parse_tree_->node_kind(entry.parse_node);
CARBON_CHECK(require_kind == actual_kind)
<< "Expected " << require_kind << ", found " << actual_kind;
}
// RequireSoloParseNode and RequireValidId rely on type punning. They read
// node_id.is_valid, even though that may not be the active union member.
// These asserts enforce standard layout in order to help ensure that works.
// TODO: Use is_layout_compatible in C++20.
static_assert(std::is_standard_layout_v<SemanticsNodeId>,
"Need standard layout for type punning");
static_assert(std::is_standard_layout_v<SemanticsStringId>,
"Need standard layout for type punning");
auto SemanticsNodeStack::RequireSoloParseNode(Entry entry) -> void {
// See above comment on type punning.
CARBON_CHECK(!entry.node_id.is_valid())
<< "Expected invalid id on " << parse_tree_->node_kind(entry.parse_node)
<< ", was " << entry.node_id << " (may not be node)";
}
auto SemanticsNodeStack::RequireValidId(Entry entry) -> void {
// See above comment on type punning.
CARBON_CHECK(entry.node_id.is_valid())
<< "Expected valid id on " << parse_tree_->node_kind(entry.parse_node);
}
auto SemanticsNodeStack::PopAndDiscardId() -> void {
auto back = PopEntry();
RequireValidId(back);
}
auto SemanticsNodeStack::PopAndDiscardId(ParseNodeKind pop_parse_kind) -> void {
auto back = PopEntry(pop_parse_kind);
RequireValidId(back);
}
auto SemanticsNodeStack::PopAndDiscardSoloParseNode(
ParseNodeKind pop_parse_kind) -> void {
auto back = PopEntry(pop_parse_kind);
RequireSoloParseNode(back);
}
auto SemanticsNodeStack::PopForSoloParseNode() -> ParseTree::Node {
auto back = PopEntry();
RequireSoloParseNode(back);
return back.parse_node;
}
auto SemanticsNodeStack::PopForSoloParseNode(ParseNodeKind pop_parse_kind)
-> ParseTree::Node {
auto back = PopEntry(pop_parse_kind);
RequireSoloParseNode(back);
return back.parse_node;
}
auto SemanticsNodeStack::PopForNodeId() -> SemanticsNodeId {
auto back = PopEntry();
RequireValidId(back);
return back.node_id;
}
auto SemanticsNodeStack::PopForNodeId(ParseNodeKind pop_parse_kind)
-> SemanticsNodeId {
auto back = PopEntry(pop_parse_kind);
RequireValidId(back);
return back.node_id;
}
auto SemanticsNodeStack::PopForParseNodeAndNodeId()
-> std::pair<ParseTree::Node, SemanticsNodeId> {
auto back = PopEntry();
RequireValidId(back);
return {back.parse_node, back.node_id};
}
auto SemanticsNodeStack::PopForParseNodeAndNodeId(ParseNodeKind pop_parse_kind)
-> std::pair<ParseTree::Node, SemanticsNodeId> {
auto back = PopEntry(pop_parse_kind);
RequireValidId(back);
return {back.parse_node, back.node_id};
}
auto SemanticsNodeStack::PopForNodeBlockId(ParseNodeKind pop_parse_kind)
-> SemanticsNodeBlockId {
auto back = PopEntry(pop_parse_kind);
RequireValidId(back);
return back.node_block_id;
}
auto SemanticsNodeStack::PopForTypeId(ParseNodeKind pop_parse_kind)
-> SemanticsTypeId {
auto back = PopEntry(pop_parse_kind);
RequireValidId(back);
return back.type_id;
}
auto SemanticsNodeStack::PopForParseNodeAndNameId(ParseNodeKind pop_parse_kind)
-> std::pair<ParseTree::Node, SemanticsStringId> {
auto back = PopEntry(pop_parse_kind);
RequireValidId(back);
return {back.parse_node, back.name_id};
}
auto SemanticsNodeStack::PeekForNameId(ParseNodeKind parse_kind)
-> SemanticsStringId {
auto back = stack_.back();
RequireParseKind(back, parse_kind);
RequireValidId(back);
return back.name_id;
}
auto SemanticsNodeStack::PrintForStackDump(llvm::raw_ostream& output) const
-> void {
output << "SemanticsNodeStack:\n";