carbon-language/carbon-lang
1
0
Fork 0
mirror of https://github.com/carbon-language/carbon-lang.git synced 2026-09-30 12:25:03 +01:00
Code Issues Packages Projects Releases 10 Wiki Activity
Files
b1f734e1cdcb9ecbf3147faccca7ff5532d53bf0
carbon-lang/toolchain/check/impl_lookup.cpp
T
Jon Ross-Perkins b1f734e1cd Switch EvalLookupSingleImplWitness from "concrete" to "final" terminology (#6246) 
A `final impl` can have a symbolic witness, but that witness is still
final. Using "final" here per discussion on
[#generics-and-templates](https://discord.com/channels/655572317891461132/941071822756143115/1428851511672312120).

I'm also changing the variant a little because `concrete_witness` was
only called when `has_concrete_value` was true, so it can be more
careful about its contract. Having a more explicit `None` also
simplifies `has_value`. I think it doesn't change the overall cost much
past that.
2025-10-20 17:25:26 +00:00

972 lines
39 KiB
C++
Raw Blame History

// 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/impl_lookup.h"
#include <algorithm>
#include <functional>
#include <utility>
#include <variant>
#include "toolchain/base/kind_switch.h"
#include "toolchain/check/deduce.h"
#include "toolchain/check/diagnostic_helpers.h"
#include "toolchain/check/eval.h"
#include "toolchain/check/facet_type.h"
#include "toolchain/check/generic.h"
#include "toolchain/check/impl.h"
#include "toolchain/check/import_ref.h"
#include "toolchain/check/inst.h"
#include "toolchain/check/subst.h"
#include "toolchain/check/type.h"
#include "toolchain/check/type_completion.h"
#include "toolchain/check/type_structure.h"
#include "toolchain/sem_ir/facet_type_info.h"
#include "toolchain/sem_ir/ids.h"
#include "toolchain/sem_ir/impl.h"
#include "toolchain/sem_ir/inst.h"
#include "toolchain/sem_ir/typed_insts.h"
namespace Carbon::Check {
// Returns IRs which are allowed to define an `impl` involving the arguments.
// This is limited by the orphan rule.
static auto FindAssociatedImportIRs(
Context& context, SemIR::ConstantId query_self_const_id,
SemIR::SpecificInterface query_specific_interface)
-> llvm::SmallVector<SemIR::ImportIRId> {
llvm::SmallVector<SemIR::ImportIRId> result;
// Add an entity to our result.
auto add_entity = [&](const SemIR::EntityWithParamsBase& entity) {
// We will look for impls in the import IR associated with the first owning
// declaration.
auto decl_id = entity.first_owning_decl_id;
if (!decl_id.has_value()) {
return;
}
if (auto ir_id = GetCanonicalImportIRInst(context, decl_id).ir_id();
ir_id.has_value()) {
result.push_back(ir_id);
}
};
llvm::SmallVector<SemIR::InstId> worklist;
// Push the contents of an instruction block onto our worklist.
auto push_block = [&](SemIR::InstBlockId block_id) {
if (block_id.has_value()) {
llvm::append_range(worklist, context.inst_blocks().Get(block_id));
}
};
// Add the arguments of a specific to the worklist.
auto push_args = [&](SemIR::SpecificId specific_id) {
if (specific_id.has_value()) {
push_block(context.specifics().Get(specific_id).args_id);
}
};
worklist.push_back(context.constant_values().GetInstId(query_self_const_id));
add_entity(context.interfaces().Get(query_specific_interface.interface_id));
push_args(query_specific_interface.specific_id);
while (!worklist.empty()) {
auto inst_id = worklist.pop_back_val();
// Visit the operands of the constant.
auto inst = context.insts().Get(inst_id);
for (auto arg : {inst.arg0_and_kind(), inst.arg1_and_kind()}) {
CARBON_KIND_SWITCH(arg) {
case CARBON_KIND(SemIR::InstId inst_id): {
if (inst_id.has_value()) {
worklist.push_back(inst_id);
}
break;
}
case CARBON_KIND(SemIR::TypeInstId inst_id): {
if (inst_id.has_value()) {
worklist.push_back(inst_id);
}
break;
}
case CARBON_KIND(SemIR::InstBlockId inst_block_id): {
push_block(inst_block_id);
break;
}
case CARBON_KIND(SemIR::ClassId class_id): {
add_entity(context.classes().Get(class_id));
break;
}
case CARBON_KIND(SemIR::InterfaceId interface_id): {
add_entity(context.interfaces().Get(interface_id));
break;
}
case CARBON_KIND(SemIR::FacetTypeId facet_type_id): {
const auto& facet_type_info =
context.facet_types().Get(facet_type_id);
for (const auto& impl : facet_type_info.extend_constraints) {
add_entity(context.interfaces().Get(impl.interface_id));
push_args(impl.specific_id);
}
for (const auto& impl : facet_type_info.self_impls_constraints) {
add_entity(context.interfaces().Get(impl.interface_id));
push_args(impl.specific_id);
}
break;
}
case CARBON_KIND(SemIR::FunctionId function_id): {
add_entity(context.functions().Get(function_id));
break;
}
case CARBON_KIND(SemIR::SpecificId specific_id): {
push_args(specific_id);
break;
}
default: {
break;
}
}
}
}
// Deduplicate.
llvm::sort(result, [](SemIR::ImportIRId a, SemIR::ImportIRId b) {
return a.index < b.index;
});
result.erase(llvm::unique(result), result.end());
return result;
}
// Returns true if a cycle was found and diagnosed.
static auto FindAndDiagnoseImplLookupCycle(
Context& context,
const llvm::SmallVector<Context::ImplLookupStackEntry>& stack,
SemIR::LocId loc_id, SemIR::ConstantId query_self_const_id,
SemIR::ConstantId query_facet_type_const_id) -> bool {
// Deduction of the interface parameters can do further impl lookups, and we
// need to ensure we terminate.
//
// https://docs.carbon-lang.dev/docs/design/generics/details.html#acyclic-rule
// - We look for violations of the acyclic rule by seeing if a previous lookup
// had all the same type inputs.
// - The `query_facet_type_const_id` encodes the entire facet type being
// looked up, including any specific parameters for a generic interface.
//
// TODO: Implement the termination rule, which requires looking at the
// complexity of the types on the top of (or throughout?) the stack:
// https://docs.carbon-lang.dev/docs/design/generics/details.html#termination-rule
for (auto [i, entry] : llvm::enumerate(stack)) {
if (entry.query_self_const_id == query_self_const_id &&
entry.query_facet_type_const_id == query_facet_type_const_id) {
auto facet_type_type_id =
context.types().GetTypeIdForTypeConstantId(query_facet_type_const_id);
CARBON_DIAGNOSTIC(ImplLookupCycle, Error,
"cycle found in search for impl of {0} for type {1}",
SemIR::TypeId, SemIR::TypeId);
auto builder = context.emitter().Build(
loc_id, ImplLookupCycle, facet_type_type_id,
context.types().GetTypeIdForTypeConstantId(query_self_const_id));
for (const auto& active_entry : llvm::drop_begin(stack, i)) {
if (active_entry.impl_loc.has_value()) {
CARBON_DIAGNOSTIC(ImplLookupCycleNote, Note,
"determining if this impl clause matches", );
builder.Note(active_entry.impl_loc, ImplLookupCycleNote);
}
}
builder.Emit();
return true;
}
}
return false;
}
struct InterfacesFromConstantId {
llvm::SmallVector<SemIR::SpecificInterface> interfaces;
SemIR::BuiltinConstraintMask builtin_constraint_mask;
bool other_requirements;
};
// Gets the set of `SpecificInterface`s that are required by a facet type
// (as a constant value), and any special requirements.
static auto GetInterfacesFromConstantId(
Context& context, SemIR::ConstantId query_facet_type_const_id)
-> InterfacesFromConstantId {
auto facet_type_inst_id =
context.constant_values().GetInstId(query_facet_type_const_id);
auto facet_type_inst =
context.insts().GetAs<SemIR::FacetType>(facet_type_inst_id);
const auto& facet_type_info =
context.facet_types().Get(facet_type_inst.facet_type_id);
auto identified_id = RequireIdentifiedFacetType(context, facet_type_inst);
auto interfaces_array_ref =
context.identified_facet_types().Get(identified_id).required_interfaces();
// Returns a copy to avoid use-after-free when the identified_facet_types
// store resizes.
return {
.interfaces = {interfaces_array_ref.begin(), interfaces_array_ref.end()},
.builtin_constraint_mask = facet_type_info.builtin_constraint_mask,
.other_requirements = facet_type_info.other_requirements};
}
static auto GetWitnessIdForImpl(Context& context, SemIR::LocId loc_id,
bool query_is_concrete,
SemIR::ConstantId query_self_const_id,
const SemIR::SpecificInterface& interface,
SemIR::ImplId impl_id) -> EvalImplLookupResult {
const SemIR::Impl& impl = context.impls().Get(impl_id);
// The impl may have generic arguments, in which case we need to deduce them
// to find what they are given the specific type and interface query. We use
// that specific to map values in the impl to the deduced values.
auto specific_id = SemIR::SpecificId::None;
if (impl.generic_id.has_value()) {
specific_id = DeduceImplArguments(
context, loc_id, impl, query_self_const_id, interface.specific_id);
if (!specific_id.has_value()) {
return EvalImplLookupResult::MakeNone();
}
}
// The self type of the impl must match the type in the query, or this is an
// `impl T as ...` for some other type `T` and should not be considered.
auto deduced_self_const_id = SemIR::GetConstantValueInSpecific(
context.sem_ir(), specific_id, impl.self_id);
// In a generic `impl forall` the self type can be a FacetAccessType, which
// will not be the same constant value as a query facet value. We move through
// to the facet value here, and if the query was a FacetAccessType we did the
// same there so they still match.
deduced_self_const_id =
GetCanonicalFacetOrTypeValue(context, deduced_self_const_id);
if (query_self_const_id != deduced_self_const_id) {
return EvalImplLookupResult::MakeNone();
}
// The impl's constraint is a facet type which it is implementing for the self
// type: the `I` in `impl ... as I`. The deduction step may be unable to be
// fully applied to the types in the constraint and result in an error here,
// in which case it does not match the query.
auto deduced_constraint_id =
context.constant_values().GetInstId(SemIR::GetConstantValueInSpecific(
context.sem_ir(), specific_id, impl.constraint_id));
if (deduced_constraint_id == SemIR::ErrorInst::InstId) {
return EvalImplLookupResult::MakeNone();
}
auto deduced_constraint_facet_type_id =
context.insts()
.GetAs<SemIR::FacetType>(deduced_constraint_id)
.facet_type_id;
const auto& deduced_constraint_facet_type_info =
context.facet_types().Get(deduced_constraint_facet_type_id);
CARBON_CHECK(deduced_constraint_facet_type_info.extend_constraints.size() ==
1);
if (deduced_constraint_facet_type_info.other_requirements ||
!deduced_constraint_facet_type_info.builtin_constraint_mask.empty()) {
return EvalImplLookupResult::MakeNone();
}
// The specifics in the queried interface must match the deduced specifics in
// the impl's constraint facet type.
auto impl_interface_specific_id =
deduced_constraint_facet_type_info.extend_constraints[0].specific_id;
auto query_interface_specific_id = interface.specific_id;
if (impl_interface_specific_id != query_interface_specific_id) {
return EvalImplLookupResult::MakeNone();
}
LoadImportRef(context, impl.witness_id);
if (specific_id.has_value()) {
// We need a definition of the specific `impl` so we can access its
// witness.
ResolveSpecificDefinition(context, loc_id, specific_id);
}
if (query_is_concrete || impl.is_final) {
// TODO: These final results should be cached somehow. Positive (non-None)
// results could be cached globally, as they can not change. But
// negative results can change after a final impl is written, so
// they can only be cached in a limited way, or the cache needs to
// be invalidated by writing a final impl that would match.
return EvalImplLookupResult::MakeFinal(
context.constant_values().GetInstId(SemIR::GetConstantValueInSpecific(
context.sem_ir(), specific_id, impl.witness_id)));
} else {
return EvalImplLookupResult::MakeNonFinal();
}
}
// Finds a lookup result from `query_self_inst_id` if it is a facet value that
// names the query interface in its facet type. Note that `query_self_inst_id`
// is allowed to be a non-canonical facet value in order to find a concrete
// witness, so it's not referenced as a constant value.
static auto LookupImplWitnessInSelfFacetValue(
Context& context, SemIR::InstId self_facet_value_inst_id,
SemIR::SpecificInterface query_specific_interface) -> EvalImplLookupResult {
auto facet_type = context.types().TryGetAs<SemIR::FacetType>(
context.insts().Get(self_facet_value_inst_id).type_id());
if (!facet_type) {
return EvalImplLookupResult::MakeNone();
}
// The position of the interface in `required_interfaces()` is also the
// position of the witness for that interface in `FacetValue`.
auto identified_id = RequireIdentifiedFacetType(context, *facet_type);
auto facet_type_required_interfaces =
llvm::enumerate(context.identified_facet_types()
.Get(identified_id)
.required_interfaces());
auto it = llvm::find_if(facet_type_required_interfaces, [=](auto e) {
return e.value() == query_specific_interface;
});
if (it == facet_type_required_interfaces.end()) {
return EvalImplLookupResult::MakeNone();
}
auto index = (*it).index();
if (auto facet_value = context.insts().TryGetAs<SemIR::FacetValue>(
self_facet_value_inst_id)) {
auto witness_id =
context.inst_blocks().Get(facet_value->witnesses_block_id)[index];
if (context.insts().Is<SemIR::ImplWitness>(witness_id)) {
return EvalImplLookupResult::MakeFinal(witness_id);
}
}
return EvalImplLookupResult::MakeNonFinal();
}
// Substitutes witnesess in place of `LookupImplWitness` queries into `.Self`,
// when the witness is for the same interface as the one `.Self` is referring
// to.
//
// This allows access to the `FacetType` and its constraints from the witness,
// and allows `ImplWitnessAccess` instructions to be immediately resolved to a
// more specific value when possible.
class SubstWitnessesCallbacks : public SubstInstCallbacks {
public:
// `context` must not be null.
explicit SubstWitnessesCallbacks(
Context* context, SemIR::LocId loc_id,
llvm::ArrayRef<SemIR::SpecificInterface> interfaces,
llvm::ArrayRef<SemIR::InstId> witness_inst_ids)
: SubstInstCallbacks(context),
loc_id_(loc_id),
interfaces_(interfaces),
witness_inst_ids_(witness_inst_ids) {}
auto Subst(SemIR::InstId& inst_id) -> SubstResult override {
// `FacetType` can be concrete even when it has rewrite constraints that
// have a symbolic dependency on `.Self`. See use of
// `GetConstantValueIgnoringPeriodSelf` in eval. So in order to recurse into
// `FacetType` we must check for it before the `is_concrete` early return.
if (context().insts().Is<SemIR::FacetType>(inst_id)) {
++facet_type_depth_;
return SubstOperands;
}
if (context().constant_values().Get(inst_id).is_concrete()) {
return FullySubstituted;
}
auto access = context().insts().TryGetAs<SemIR::ImplWitnessAccess>(inst_id);
if (!access) {
return SubstOperands;
}
auto lookup =
context().insts().GetAs<SemIR::LookupImplWitness>(access->witness_id);
auto bind_name = context().insts().TryGetAs<SemIR::BindSymbolicName>(
lookup.query_self_inst_id);
if (!bind_name) {
return SubstOperands;
}
const auto& self_entity_name =
context().entity_names().Get(bind_name->entity_name_id);
if (self_entity_name.name_id != SemIR::NameId::PeriodSelf) {
return SubstOperands;
}
// TODO: Once we are numbering `EntityName`, (see the third model in
// https://docs.google.com/document/d/1Yt-i5AmF76LSvD4TrWRIAE_92kii6j5yFiW-S7ahzlg/edit?tab=t.0#heading=h.7urbxcq23olv)
// then verify that the index here is equal to the `facet_type_depth_`,
// which would mean that it is a reference to the top-level `Self`, which is
// being replaced with the impl lookup query self facet value (and then we
// use the witness derived from it).
//
// For now, we only substitute if depth == 0, which is incorrect inside
// nested facet types, as it can miss references in specifics up to the top
// level facet value.
if (facet_type_depth_ > 0) {
return SubstOperands;
}
auto witness_id =
FindWitnessForInterface(lookup.query_specific_interface_id);
if (!witness_id.has_value()) {
return SubstOperands;
}
inst_id = RebuildNewInst(
context().insts().GetLocIdForDesugaring(loc_id_),
SemIR::ImplWitnessAccess{.type_id = GetSingletonType(
context(), SemIR::WitnessType::TypeInstId),
.witness_id = witness_id,
.index = access->index});
// Once we replace a witness, we either have a concrete value or some
// reference to an associated constant that came from the witness's facet
// type. We don't want to substitute into the witness's facet type, so we
// don't recurse on whatever came from the witness.
return FullySubstituted;
}
auto Rebuild(SemIR::InstId orig_inst_id, SemIR::Inst new_inst)
-> SemIR::InstId override {
if (context().insts().Is<SemIR::FacetType>(orig_inst_id)) {
--facet_type_depth_;
}
return RebuildNewInst(loc_id_, new_inst);
}
auto ReuseUnchanged(SemIR::InstId orig_inst_id) -> SemIR::InstId override {
if (context().insts().Is<SemIR::FacetType>(orig_inst_id)) {
--facet_type_depth_;
}
return orig_inst_id;
}
private:
auto FindWitnessForInterface(SemIR::SpecificInterfaceId specific_interface_id)
-> SemIR::InstId {
auto lookup_query_interface =
context().specific_interfaces().Get(specific_interface_id);
for (auto [interface, witness_inst_id] :
llvm::zip(interfaces_, witness_inst_ids_)) {
// If the `LookupImplWitness` for `.Self` is not looking for the same
// interface as we have a witness for, this is not the right witness to
// use to replace the lookup for `.Self`.
if (interface.interface_id == lookup_query_interface.interface_id) {
return witness_inst_id;
}
}
return SemIR::InstId::None;
}
SemIR::LocId loc_id_;
llvm::ArrayRef<SemIR::SpecificInterface> interfaces_;
llvm::ArrayRef<SemIR::InstId> witness_inst_ids_;
int facet_type_depth_ = 0;
};
static auto VerifyQueryFacetTypeConstraints(
Context& context, SemIR::LocId loc_id,
SemIR::InstId query_facet_type_inst_id,
llvm::ArrayRef<SemIR::SpecificInterface> interfaces,
llvm::ArrayRef<SemIR::InstId> witness_inst_ids) -> bool {
CARBON_CHECK(context.insts().Is<SemIR::FacetType>(query_facet_type_inst_id));
const auto& facet_type_info = context.facet_types().Get(
context.insts()
.GetAs<SemIR::FacetType>(query_facet_type_inst_id)
.facet_type_id);
if (!facet_type_info.rewrite_constraints.empty()) {
auto callbacks =
SubstWitnessesCallbacks(&context, loc_id, interfaces, witness_inst_ids);
for (const auto& rewrite : facet_type_info.rewrite_constraints) {
auto lhs_id = SubstInst(context, rewrite.lhs_id, callbacks);
auto rhs_id = SubstInst(context, rewrite.rhs_id, callbacks);
if (lhs_id != rhs_id) {
// TODO: Provide a diagnostic note and location for which rewrite
// constraint was not satisfied, if a diagnostic is going to be
// displayed for the LookupImplWitessFailure. This will require plumbing
// through a callback that lets us add a Note to another diagnostic.
return false;
}
}
}
// TODO: Validate that the witnesses satisfy the other requirements in the
// `facet_type_info`.
return true;
}
// Begin a search for an impl declaration matching the query. We do this by
// creating an LookupImplWitness instruction and evaluating. If it's able to
// find a final concrete impl, then it will evaluate to that `ImplWitness` but
// if not, it will evaluate to itself as a symbolic witness to be further
// evaluated with a more specific query when building a specific for the generic
// context the query came from.
static auto GetOrAddLookupImplWitness(Context& context, SemIR::LocId loc_id,
SemIR::ConstantId query_self_const_id,
SemIR::SpecificInterface interface)
-> SemIR::InstId {
auto witness_const_id = EvalOrAddInst(
context, context.insts().GetLocIdForDesugaring(loc_id),
SemIR::LookupImplWitness{
.type_id = GetSingletonType(context, SemIR::WitnessType::TypeInstId),
.query_self_inst_id =
context.constant_values().GetInstId(query_self_const_id),
.query_specific_interface_id =
context.specific_interfaces().Add(interface),
});
// We use a NotConstant result from eval to communicate back an impl
// lookup failure. See `EvalConstantInst()` for `LookupImplWitness`.
if (!witness_const_id.is_constant()) {
return SemIR::InstId::None;
}
return context.constant_values().GetInstId(witness_const_id);
}
// Returns true if the `Self` should impl `Destroy`.
static auto TypeCanDestroy(Context& context,
SemIR::ConstantId query_self_const_id) -> bool {
auto inst = context.insts().Get(context.constant_values().GetInstId(
GetCanonicalFacetOrTypeValue(context, query_self_const_id)));
// For facet values, look if the FacetType provides the same.
if (auto facet_type =
context.types().TryGetAs<SemIR::FacetType>(inst.type_id())) {
const auto& info = context.facet_types().Get(facet_type->facet_type_id);
if (info.builtin_constraint_mask.HasAnyOf(
SemIR::BuiltinConstraintMask::TypeCanDestroy)) {
return true;
}
}
CARBON_KIND_SWITCH(inst) {
case CARBON_KIND(SemIR::ClassType class_type): {
auto class_info = context.classes().Get(class_type.class_id);
// Incomplete and abstract classes can't be destroyed.
// TODO: Return false if the object repr doesn't impl `Destroy`.
// TODO: Return false for C++ types that lack a destructor.
return class_info.is_complete() &&
class_info.inheritance_kind !=
SemIR::Class::InheritanceKind::Abstract;
}
case SemIR::ArrayType::Kind:
case SemIR::ConstType::Kind:
case SemIR::MaybeUnformedType::Kind:
case SemIR::PartialType::Kind:
case SemIR::StructType::Kind:
case SemIR::TupleType::Kind:
// TODO: Return false for types that indirectly reference a type that
// doesn't impl `Destroy`.
return true;
case SemIR::BoolType::Kind:
case SemIR::PointerType::Kind:
// Trivially destructible.
return true;
default:
return false;
}
}
auto LookupImplWitness(Context& context, SemIR::LocId loc_id,
SemIR::ConstantId query_self_const_id,
SemIR::ConstantId query_facet_type_const_id)
-> SemIR::InstBlockIdOrError {
if (query_self_const_id == SemIR::ErrorInst::ConstantId ||
query_facet_type_const_id == SemIR::ErrorInst::ConstantId) {
return SemIR::InstBlockIdOrError::MakeError();
}
{
// The query self value is a type value or a facet value.
auto query_self_type_id =
context.insts()
.Get(context.constant_values().GetInstId(query_self_const_id))
.type_id();
CARBON_CHECK(context.types().Is<SemIR::TypeType>(query_self_type_id) ||
context.types().Is<SemIR::FacetType>(query_self_type_id));
// The query facet type value is indeed a facet type.
CARBON_CHECK(context.insts().Is<SemIR::FacetType>(
context.constant_values().GetInstId(query_facet_type_const_id)));
}
auto [interfaces, builtin_constraint_mask, other_requirements] =
GetInterfacesFromConstantId(context, query_facet_type_const_id);
if (other_requirements) {
// TODO: Remove this when other requirements go away.
return SemIR::InstBlockId::None;
}
if (builtin_constraint_mask.HasAnyOf(
SemIR::BuiltinConstraintMask::TypeCanDestroy) &&
!TypeCanDestroy(context, query_self_const_id)) {
return SemIR::InstBlockId::None;
}
if (interfaces.empty()) {
return SemIR::InstBlockId::Empty;
}
if (FindAndDiagnoseImplLookupCycle(context, context.impl_lookup_stack(),
loc_id, query_self_const_id,
query_facet_type_const_id)) {
return SemIR::InstBlockIdOrError::MakeError();
}
auto& stack = context.impl_lookup_stack();
stack.push_back({
.query_self_const_id = query_self_const_id,
.query_facet_type_const_id = query_facet_type_const_id,
});
// We need to find a witness for each interface in `interfaces`. Every
// consumer of a facet type needs to agree on the order of interfaces used for
// its witnesses.
llvm::SmallVector<SemIR::InstId> result_witness_ids;
for (const auto& interface : interfaces) {
// TODO: Since both `interfaces` and `query_self_const_id` are sorted lists,
// do an O(N+M) merge instead of O(N*M) nested loops.
auto result_witness_id = GetOrAddLookupImplWitness(
context, loc_id, query_self_const_id, interface);
if (result_witness_id.has_value()) {
result_witness_ids.push_back(result_witness_id);
} else {
// At least one queried interface in the facet type has no witness for the
// given type, we can stop looking for more.
break;
}
}
stack.pop_back();
// All interfaces in the query facet type must have been found to be available
// through some impl, or directly on the value's facet type if
// `query_self_const_id` is a facet value.
if (result_witness_ids.size() != interfaces.size()) {
return SemIR::InstBlockId::None;
}
// Verify rewrite constraints in the query constraint are satisfied after
// applying the rewrites from the found witnesses.
if (!VerifyQueryFacetTypeConstraints(
context, loc_id,
context.constant_values().GetInstId(query_facet_type_const_id),
interfaces, result_witness_ids)) {
return SemIR::InstBlockId::None;
}
return context.inst_blocks().AddCanonical(result_witness_ids);
}
// Returns whether the query is concrete, it is false if the self type or
// interface specifics have a symbolic dependency.
static auto QueryIsConcrete(Context& context, SemIR::ConstantId self_const_id,
const SemIR::SpecificInterface& specific_interface)
-> bool {
if (!self_const_id.is_concrete()) {
return false;
}
if (!specific_interface.specific_id.has_value()) {
return true;
}
auto args_id =
context.specifics().Get(specific_interface.specific_id).args_id;
for (auto inst_id : context.inst_blocks().Get(args_id)) {
if (!context.constant_values().Get(inst_id).is_concrete()) {
return false;
}
}
return true;
}
namespace {
// A class to filter imported impls based on whether they could possibly match a
// query, prior to importing them. For now we only consider impls that are for
// an interface that's being queried.
//
// TODO: There's a lot more we could do to filter out impls that can't possibly
// match.
class ImportImplFilter {
public:
explicit ImportImplFilter(Context& context, SemIR::ImportIRId import_ir_id,
SemIR::SpecificInterface interface)
: context_(&context),
interface_id_(interface.interface_id),
import_ir_id_(import_ir_id),
import_ir_(context_->import_irs().Get(import_ir_id).sem_ir),
cached_import_interface_id_(SemIR::InterfaceId::None) {}
// Returns whether the given impl is potentially relevant for the current
// query.
auto IsRelevantImpl(SemIR::ImplId import_impl_id) -> bool {
auto impl_interface_id =
import_ir_->impls().Get(import_impl_id).interface.interface_id;
if (!impl_interface_id.has_value()) {
// This indicates that an error occurred when type-checking the impl.
// TODO: Use an explicit error value for this rather than None.
return false;
}
return IsRelevantInterface(impl_interface_id);
}
private:
// Returns whether an impl for the given interface might be relevant to the
// current query.
auto IsRelevantInterface(SemIR::InterfaceId import_interface_id) -> bool {
if (!cached_import_interface_id_.has_value()) {
if (IsSameInterface(import_interface_id, interface_id_)) {
cached_import_interface_id_ = import_interface_id;
return true;
}
} else if (cached_import_interface_id_ == import_interface_id) {
return true;
}
return false;
}
// Returns whether the given interfaces from two different IRs are the same.
auto IsSameInterface(SemIR::InterfaceId import_interface_id,
SemIR::InterfaceId local_interface_id) -> bool {
// The names must be the same.
if (import_ir_->names().GetAsStringIfIdentifier(
import_ir_->interfaces().Get(import_interface_id).name_id) !=
context_->names().GetAsStringIfIdentifier(
context_->interfaces().Get(local_interface_id).name_id)) {
return false;
}
// Compare the interfaces themselves.
// TODO: Should we check the scope of the interface before doing this?
auto local_version_of_import_interface_id =
ImportInterface(*context_, import_ir_id_, import_interface_id);
return local_version_of_import_interface_id == local_interface_id;
}
Context* context_;
// The interface being looked up.
SemIR::InterfaceId interface_id_;
// The IR that we are currently importing impls from.
SemIR::ImportIRId import_ir_id_;
const SemIR::File* import_ir_;
// The interface ID of `interface_id_` in `import_ir_`, if known.
SemIR::InterfaceId cached_import_interface_id_;
};
} // namespace
struct CandidateImpl {
SemIR::ImplId impl_id;
SemIR::InstId loc_inst_id;
// Used for sorting the candidates to find the most-specialized match.
TypeStructure type_structure;
};
// Returns the list of candidates impls for lookup to select from.
static auto CollectCandidateImplsForQuery(
Context& context, bool final_only, SemIR::ConstantId query_self_const_id,
const TypeStructure& query_type_structure,
SemIR::SpecificInterface& query_specific_interface)
-> llvm::SmallVector<CandidateImpl> {
auto import_irs = FindAssociatedImportIRs(context, query_self_const_id,
query_specific_interface);
for (auto import_ir_id : import_irs) {
// Instead of importing all impls, only import ones that are in some way
// connected to this query.
ImportImplFilter filter(context, import_ir_id, query_specific_interface);
for (auto [import_impl_id, _] :
context.import_irs().Get(import_ir_id).sem_ir->impls().enumerate()) {
if (filter.IsRelevantImpl(import_impl_id)) {
// TODO: Track the relevant impls and only consider those ones and any
// local impls, rather than looping over all impls below.
ImportImpl(context, import_ir_id, import_impl_id);
}
}
}
llvm::SmallVector<CandidateImpl> candidate_impls;
for (auto [id, impl] : context.impls().enumerate()) {
if (final_only && !IsImplEffectivelyFinal(context, impl)) {
continue;
}
// If the impl's interface_id differs from the query, then this impl can
// not possibly provide the queried interface.
if (impl.interface.interface_id != query_specific_interface.interface_id) {
continue;
}
// When the impl's interface_id matches, but the interface is generic, the
// impl may or may not match based on restrictions in the generic
// parameters of the impl.
//
// As a shortcut, if the impl's constraint is not symbolic (does not
// depend on any generic parameters), then we can determine whether we match
// by looking if the specific ids match exactly.
auto impl_interface_const_id =
context.constant_values().Get(impl.constraint_id);
if (!impl_interface_const_id.is_symbolic() &&
impl.interface.specific_id != query_specific_interface.specific_id) {
continue;
}
// This check comes first to avoid deduction with an invalid impl. We use
// an error value to indicate an error during creation of the impl, such
// as a recursive impl which will cause deduction to recurse infinitely.
if (impl.witness_id == SemIR::ErrorInst::InstId) {
continue;
}
CARBON_CHECK(impl.witness_id.has_value());
// Build the type structure used for choosing the best the candidate.
auto type_structure =
BuildTypeStructure(context, impl.self_id, impl.interface);
if (!type_structure) {
continue;
}
// TODO: We can skip the comparison here if the `impl_interface_const_id` is
// not symbolic, since when the interface and specific ids match, and they
// aren't symbolic, the structure will be identical.
if (!query_type_structure.CompareStructure(
TypeStructure::CompareTest::IsEqualToOrMoreSpecificThan,
*type_structure)) {
continue;
}
candidate_impls.push_back(
{id, impl.definition_id, std::move(*type_structure)});
}
auto compare = [](auto& lhs, auto& rhs) -> bool {
return lhs.type_structure < rhs.type_structure;
};
// Stable sort is used so that impls that are seen first are preferred when
// they have an equal priority ordering.
// TODO: Allow Carbon code to provide a priority ordering explicitly. For
// now they have all the same priority, so the priority is the order in
// which they are found in code.
llvm::stable_sort(candidate_impls, compare);
return candidate_impls;
}
auto EvalLookupSingleImplWitness(Context& context, SemIR::LocId loc_id,
SemIR::LookupImplWitness eval_query,
SemIR::InstId self_facet_value_inst_id,
bool poison_final_results)
-> EvalImplLookupResult {
auto query_specific_interface =
context.specific_interfaces().Get(eval_query.query_specific_interface_id);
auto facet_lookup_result = LookupImplWitnessInSelfFacetValue(
context, self_facet_value_inst_id, query_specific_interface);
if (facet_lookup_result.has_final_value()) {
return facet_lookup_result;
}
// If the self type is a facet that provides a witness, then we are in an
// `interface` or an `impl`. In both cases, we don't want to do any impl
// lookups. The query will eventually resolve to a concrete witness when it
// can get it from the self facet value, when it has a specific applied in the
// future.
//
// In particular, this avoids a LookupImplWitness instruction in the eval
// block of an impl declaration from doing impl lookup. Specifically the
// lookup of the implicit .Self in `impl ... where .X`. If it does impl lookup
// when the eval block is run, it finds the same `impl`, tries to build a
// specific from it, which runs the eval block, creating a recursive loop that
// crashes.
bool self_facet_provides_witness = facet_lookup_result.has_value();
if (self_facet_provides_witness) {
if (auto bind = context.insts().TryGetAs<SemIR::BindSymbolicName>(
eval_query.query_self_inst_id)) {
const auto& entity = context.entity_names().Get(bind->entity_name_id);
if (entity.name_id == SemIR::NameId::PeriodSelf ||
entity.name_id == SemIR::NameId::SelfType) {
return EvalImplLookupResult::MakeNonFinal();
}
}
}
// Ensure specifics don't substitute in weird things for the query self.
CARBON_CHECK(context.types().IsFacetType(
context.insts().Get(eval_query.query_self_inst_id).type_id()));
SemIR::ConstantId query_self_const_id =
context.constant_values().Get(eval_query.query_self_inst_id);
auto query_type_structure = BuildTypeStructure(
context, context.constant_values().GetInstId(query_self_const_id),
query_specific_interface);
if (!query_type_structure) {
return EvalImplLookupResult::MakeNone();
}
bool query_is_concrete =
QueryIsConcrete(context, query_self_const_id, query_specific_interface);
// If we have a symbolic witness in the self query, then the query can not be
// concrete: the query includes a symbolic self value.
CARBON_CHECK(!self_facet_provides_witness || !query_is_concrete);
// If the self value is a (symbolic) facet value that has a symbolic witness,
// then we don't need to do impl lookup, except that we want to find any final
// impls to return a concrete witness if possible. So we limit the query to
// final impls only in that case. Note as in the CHECK above, the query can
// not be concrete in this case, so only final impls can produce a concrete
// witness for this query.
auto candidate_impls = CollectCandidateImplsForQuery(
context, self_facet_provides_witness, query_self_const_id,
*query_type_structure, query_specific_interface);
for (const auto& candidate : candidate_impls) {
// In deferred lookup for a symbolic impl witness, while building a
// specific, there may be no stack yet as this may be the first lookup. If
// further lookups are started as a result in deduce, they will build the
// stack.
//
// NOTE: Don't retain a reference into the stack, it may be invalidated if
// we do further impl lookups when GetWitnessIdForImpl() does deduction.
if (!context.impl_lookup_stack().empty()) {
context.impl_lookup_stack().back().impl_loc = candidate.loc_inst_id;
}
auto result = GetWitnessIdForImpl(
context, loc_id, query_is_concrete, query_self_const_id,
query_specific_interface, candidate.impl_id);
if (result.has_value()) {
// Record the query which found a final impl witness. It's illegal to
// write a final impl afterward that would match the same query.
//
// If the impl was effectively final, then we don't need to poison here. A
// change of query result will already be diagnosed at the point where the
// new impl decl was written that changes the result.
if (poison_final_results && result.has_final_value() &&
!IsImplEffectivelyFinal(context,
context.impls().Get(candidate.impl_id))) {
context.poisoned_concrete_impl_lookup_queries().push_back(
{.loc_id = loc_id,
.query = eval_query,
.impl_witness = result.final_witness()});
}
return result;
}
}
if (self_facet_provides_witness) {
// If we did not find a final impl, but the self value is a facet that
// provides a symbolic witness, when we record that an impl will exist for
// the specific, but is yet unknown.
return EvalImplLookupResult::MakeNonFinal();
}
return EvalImplLookupResult::MakeNone();
}
auto LookupMatchesImpl(Context& context, SemIR::LocId loc_id,
SemIR::ConstantId query_self_const_id,
SemIR::SpecificInterface query_specific_interface,
SemIR::ImplId target_impl) -> bool {
if (query_self_const_id == SemIR::ErrorInst::ConstantId) {
return false;
}
auto result = GetWitnessIdForImpl(
context, loc_id, /*query_is_concrete=*/false, query_self_const_id,
query_specific_interface, target_impl);
return result.has_value();
}
} // namespace Carbon::Check
Reference in New Issue View Git Blame Copy Permalink