Files
carbon-lang/toolchain/check/node_id_traversal.h
T
Richard Smith 2472f44e44 Track pending thunks on the deferred definition worklist. (#5609)
Instead of using somewhat different approaches for defining in-line
methods at the end of the enclosing scope and defining thunks at the end
of the enclosing scope, we now use the same worklist for both.

This fixes a bug where we would crash when defining thunks if there
happens to be nothing else on the deferred definition worklist, leading
to our leaving the enclosing impl scope before we try to define the
pending thunk. That would only happen if the impl contains no in-line
member function bodies, so only if the impl has only a forward
declaration or a builtin declaration for every method. The latter
case happens (a lot) if we start using thunks in the prelude impls.

One complicating factor here is that this means the deferred definition
worklist moves from the layer containing `check/handle*` and
`check/check_unit.cpp` into the layer containing `check/context.cpp`.
Allowing that required moving a couple of other things that it depends
on -- notably `SuspendedFunction` and `HandleSuspendedFunction` --
around.
2025-06-10 22:09:31 +00:00

103 lines
3.6 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
#ifndef CARBON_TOOLCHAIN_CHECK_NODE_ID_TRAVERSAL_H_
#define CARBON_TOOLCHAIN_CHECK_NODE_ID_TRAVERSAL_H_
#include "common/ostream.h"
#include "llvm/ADT/SmallVector.h"
#include "toolchain/check/context.h"
#include "toolchain/check/deferred_definition_worklist.h"
#include "toolchain/parse/tree.h"
namespace Carbon::Check {
// A traversal of the node IDs in the parse tree, in the order in which we need
// to check them.
class NodeIdTraversal {
public:
// `context` must not be null.
explicit NodeIdTraversal(Context* context);
// Finds the next `NodeId` to type-check. Returns nullopt if the traversal is
// complete.
auto Next() -> std::optional<Parse::NodeId>;
// Performs any processing necessary after we type-check a node.
auto Handle(Parse::NodeKind parse_kind) -> void;
private:
// State used to track the next deferred function definition that we will
// encounter and need to reorder.
class NextDeferredDefinitionCache {
public:
explicit NextDeferredDefinitionCache(const Parse::Tree* tree);
// Set the specified deferred definition index as being the next one that
// will be encountered.
auto SkipTo(Parse::DeferredDefinitionIndex next_index) -> void;
// Returns the index of the next deferred definition to be encountered.
auto index() const -> Parse::DeferredDefinitionIndex { return index_; }
// Returns the ID of the start node of the next deferred definition.
auto start_id() const -> Parse::NodeId { return start_id_; }
private:
const Parse::Tree* tree_;
Parse::DeferredDefinitionIndex index_ =
Parse::DeferredDefinitionIndex::None;
Parse::NodeId start_id_ = Parse::NodeId::None;
};
// A chunk of the parse tree that we need to type-check.
struct Chunk {
Parse::Tree::PostorderIterator it;
Parse::Tree::PostorderIterator end;
// The next definition that will be encountered after this chunk completes.
Parse::DeferredDefinitionIndex next_definition;
// Whether we are currently checking deferred definitions, rather than the
// tokens of this chunk. If so, we'll pull tasks off `worklist` and execute
// them until we're done with this batch of deferred definitions. Otherwise,
// we'll pull node IDs from `*it` until it reaches `end`.
bool checking_deferred_definitions = false;
// If we're checking deferred definitions, the index of the first task to
// execute from `worklist`.
size_t first_worklist_index;
// If we're checking deferred definitions, the index of the next task to
// execute from `worklist`.
size_t next_worklist_index;
};
auto worklist() -> DeferredDefinitionWorklist& { return *worklist_; }
// Re-enter a nested deferred definition scope.
auto PerformTask(
DeferredDefinitionWorklist::EnterNestedDeferredDefinitionScope&& enter)
-> void;
// Leave a nested deferred definition scope.
auto PerformTask(
DeferredDefinitionWorklist::LeaveNestedDeferredDefinitionScope&& leave)
-> void;
// Resume checking a deferred definition.
auto PerformTask(
DeferredDefinitionWorklist::CheckSkippedDefinition&& parse_definition)
-> void;
// Define a thunk.
auto PerformTask(DeferredDefinitionWorklist::DefineThunk&& define_thunk)
-> void;
Context* context_;
NextDeferredDefinitionCache next_deferred_definition_;
DeferredDefinitionWorklist* worklist_;
llvm::SmallVector<Chunk> chunks_;
};
} // namespace Carbon::Check
#endif // CARBON_TOOLCHAIN_CHECK_NODE_ID_TRAVERSAL_H_