Add some coarse debug information to semantics. (#2382)

Example stack:

```
1.	node_stack_:
	0.	FunctionDefinitionStart
	1.	ReturnStatement -> node1
2.	node_block_stack_:
	0.	block0
	1.	block1
```

Example trace output:

```
*** SemanticsParseTreeHandler::Build Begin ***
Push 0: FunctionIntroducer
Push 1: DeclaredName
Push 2: ParameterListEnd
Pop 2: ParameterListEnd
Push 2: ParameterList
Pop 2: ParameterList
Pop 0: FunctionIntroducer
AddNode block0: FunctionDeclaration()
AddNode block0: BindName(ident0, node0)
AddNode block0: FunctionDefinition(node0, block1)
Push 0: FunctionDefinitionStart
Push 1: Literal -> IntegerLiteral
AddNode block1: IntegerLiteral(int0): node_xref1
Push 2: StatementEnd
Pop 2: StatementEnd
Pop 1: any (Literal) -> node0
Push 1: ReturnStatement -> ReturnExpression
AddNode block1: ReturnExpression(node0)
Pop 0: FunctionDefinitionStart
Push 0: FunctionDefinition
*** SemanticsParseTreeHandler::Build End ***
cross_reference_irs.size == 2,
cross_references = {
  node_xref0 = "xref(ir0, block0, node0)";
  node_xref1 = "xref(ir0, block0, node1)";
},
identifiers = {
  ident0 = "Foo";
},
integer_literals = {
  int0 = 0;
},
node_blocks = {
  block0 = {
    node0 = FunctionDeclaration();
    node1 = BindName(ident0, node0);
    node2 = FunctionDefinition(node0, block1);
  },
  block1 = {
    node0 = IntegerLiteral(int0): node_xref1;
    node1 = ReturnExpression(node0);
  },
}
```

Co-authored-by: Chandler Carruth <chandlerc@gmail.com>
This commit is contained in:
Jon Ross-Perkins
2022-11-11 14:10:13 -08:00
committed by GitHub
co-authored by Chandler Carruth
parent 25d1b62df0
commit 352fec1885
16 changed files with 275 additions and 27 deletions
@@ -17,13 +17,22 @@ class SemanticsParseTreeHandler {
// Stores references for work.
explicit SemanticsParseTreeHandler(const TokenizedBuffer& tokens,
const ParseTree& parse_tree,
SemanticsIR& semantics)
: tokens_(&tokens), parse_tree_(&parse_tree), semantics_(&semantics) {}
SemanticsIR& semantics,
llvm::raw_ostream* vlog_stream)
: tokens_(&tokens),
parse_tree_(&parse_tree),
semantics_(&semantics),
vlog_stream_(vlog_stream) {}
// Outputs the ParseTree information into SemanticsIR.
auto Build() -> void;
private:
// Prints the node_stack_ on stack dumps.
class PrettyStackTraceNodeStack;
// Prints the node_block_stack_ on stack dumps.
class PrettyStackTraceNodeBlockStack;
struct TraversalStackEntry {
ParseTree::Node parse_node;
llvm::Optional<SemanticsNodeId> result_id;
@@ -72,6 +81,9 @@ class SemanticsParseTreeHandler {
// The SemanticsIR being added to.
SemanticsIR* semantics_;
// Whether to print verbose output.
llvm::raw_ostream* vlog_stream_;
// The stack during Build. Will contain file-level parse nodes on return.
llvm::SmallVector<TraversalStackEntry> node_stack_;