| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616 |
- // 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/context.h"
- #include <optional>
- #include <string>
- #include <utility>
- #include "common/check.h"
- #include "common/vlog.h"
- #include "llvm/ADT/Sequence.h"
- #include "toolchain/base/kind_switch.h"
- #include "toolchain/check/decl_name_stack.h"
- #include "toolchain/check/eval.h"
- #include "toolchain/check/generic.h"
- #include "toolchain/check/generic_region_stack.h"
- #include "toolchain/check/import.h"
- #include "toolchain/check/import_ref.h"
- #include "toolchain/check/inst_block_stack.h"
- #include "toolchain/check/merge.h"
- #include "toolchain/diagnostics/diagnostic_emitter.h"
- #include "toolchain/diagnostics/format_providers.h"
- #include "toolchain/lex/tokenized_buffer.h"
- #include "toolchain/parse/node_ids.h"
- #include "toolchain/parse/node_kind.h"
- #include "toolchain/sem_ir/file.h"
- #include "toolchain/sem_ir/formatter.h"
- #include "toolchain/sem_ir/generic.h"
- #include "toolchain/sem_ir/ids.h"
- #include "toolchain/sem_ir/import_ir.h"
- #include "toolchain/sem_ir/inst.h"
- #include "toolchain/sem_ir/inst_kind.h"
- #include "toolchain/sem_ir/name_scope.h"
- #include "toolchain/sem_ir/type_info.h"
- #include "toolchain/sem_ir/typed_insts.h"
- namespace Carbon::Check {
- Context::Context(DiagnosticEmitter* emitter,
- llvm::function_ref<const Parse::TreeAndSubtrees&()>
- get_parse_tree_and_subtrees,
- SemIR::File* sem_ir, int imported_ir_count, int total_ir_count,
- llvm::raw_ostream* vlog_stream)
- : emitter_(emitter),
- get_parse_tree_and_subtrees_(get_parse_tree_and_subtrees),
- sem_ir_(sem_ir),
- vlog_stream_(vlog_stream),
- node_stack_(sem_ir->parse_tree(), vlog_stream),
- inst_block_stack_("inst_block_stack_", *sem_ir, vlog_stream),
- pattern_block_stack_("pattern_block_stack_", *sem_ir, vlog_stream),
- param_and_arg_refs_stack_(*sem_ir, vlog_stream, node_stack_),
- args_type_info_stack_("args_type_info_stack_", *sem_ir, vlog_stream),
- decl_name_stack_(this),
- scope_stack_(sem_ir_->identifiers()),
- vtable_stack_("vtable_stack_", *sem_ir, vlog_stream),
- global_init_(this) {
- // Prepare fields which relate to the number of IRs available for import.
- import_irs().Reserve(imported_ir_count);
- import_ir_constant_values_.reserve(imported_ir_count);
- check_ir_map_.resize(total_ir_count, SemIR::ImportIRId::None);
- // Map the builtin `<error>` and `type` type constants to their corresponding
- // special `TypeId` values.
- type_ids_for_type_constants_.Insert(
- SemIR::ConstantId::ForTemplateConstant(SemIR::ErrorInst::SingletonInstId),
- SemIR::ErrorInst::SingletonTypeId);
- type_ids_for_type_constants_.Insert(
- SemIR::ConstantId::ForTemplateConstant(SemIR::TypeType::SingletonInstId),
- SemIR::TypeType::SingletonTypeId);
- // TODO: Remove this and add a `VerifyOnFinish` once we properly push and pop
- // in the right places.
- generic_region_stack().Push();
- }
- auto Context::TODO(SemIRLoc loc, std::string label) -> bool {
- CARBON_DIAGNOSTIC(SemanticsTodo, Error, "semantics TODO: `{0}`", std::string);
- emitter_->Emit(loc, SemanticsTodo, std::move(label));
- return false;
- }
- auto Context::VerifyOnFinish() -> void {
- // Information in all the various context objects should be cleaned up as
- // various pieces of context go out of scope. At this point, nothing should
- // remain.
- // node_stack_ will still contain top-level entities.
- inst_block_stack_.VerifyOnFinish();
- pattern_block_stack_.VerifyOnFinish();
- param_and_arg_refs_stack_.VerifyOnFinish();
- args_type_info_stack_.VerifyOnFinish();
- CARBON_CHECK(struct_type_fields_stack_.empty());
- // TODO: Add verification for decl_name_stack_ and
- // decl_introducer_state_stack_.
- scope_stack_.VerifyOnFinish();
- // TODO: Add verification for generic_region_stack_.
- }
- auto Context::GetOrAddInst(SemIR::LocIdAndInst loc_id_and_inst)
- -> SemIR::InstId {
- if (loc_id_and_inst.loc_id.is_implicit()) {
- auto const_id =
- TryEvalInst(*this, SemIR::InstId::None, loc_id_and_inst.inst);
- if (const_id.has_value()) {
- CARBON_VLOG("GetOrAddInst: constant: {0}\n", loc_id_and_inst.inst);
- return constant_values().GetInstId(const_id);
- }
- }
- // TODO: For an implicit instruction, this reattempts evaluation.
- return AddInst(loc_id_and_inst);
- }
- // Finish producing an instruction. Set its constant value, and register it in
- // any applicable instruction lists.
- auto Context::FinishInst(SemIR::InstId inst_id, SemIR::Inst inst) -> void {
- GenericRegionStack::DependencyKind dep_kind =
- GenericRegionStack::DependencyKind::None;
- // If the instruction has a symbolic constant type, track that we need to
- // substitute into it.
- if (constant_values().DependsOnGenericParameter(
- types().GetConstantId(inst.type_id()))) {
- dep_kind |= GenericRegionStack::DependencyKind::SymbolicType;
- }
- // If the instruction has a constant value, compute it.
- auto const_id = TryEvalInst(*this, inst_id, inst);
- constant_values().Set(inst_id, const_id);
- if (const_id.is_constant()) {
- CARBON_VLOG("Constant: {0} -> {1}\n", inst,
- constant_values().GetInstId(const_id));
- // If the constant value is symbolic, track that we need to substitute into
- // it.
- if (constant_values().DependsOnGenericParameter(const_id)) {
- dep_kind |= GenericRegionStack::DependencyKind::SymbolicConstant;
- }
- }
- // Keep track of dependent instructions.
- if (dep_kind != GenericRegionStack::DependencyKind::None) {
- // TODO: Also check for template-dependent instructions.
- generic_region_stack().AddDependentInst(
- {.inst_id = inst_id, .kind = dep_kind});
- }
- }
- // Returns whether a parse node associated with an imported instruction of kind
- // `imported_kind` is usable as the location of a corresponding local
- // instruction of kind `local_kind`.
- static auto HasCompatibleImportedNodeKind(SemIR::InstKind imported_kind,
- SemIR::InstKind local_kind) -> bool {
- if (imported_kind == local_kind) {
- return true;
- }
- if (imported_kind == SemIR::ImportDecl::Kind &&
- local_kind == SemIR::Namespace::Kind) {
- static_assert(
- std::is_convertible_v<decltype(SemIR::ImportDecl::Kind)::TypedNodeId,
- decltype(SemIR::Namespace::Kind)::TypedNodeId>);
- return true;
- }
- return false;
- }
- auto Context::CheckCompatibleImportedNodeKind(
- SemIR::ImportIRInstId imported_loc_id, SemIR::InstKind kind) -> void {
- auto& import_ir_inst = import_ir_insts().Get(imported_loc_id);
- const auto* import_ir = import_irs().Get(import_ir_inst.ir_id).sem_ir;
- auto imported_kind = import_ir->insts().Get(import_ir_inst.inst_id).kind();
- CARBON_CHECK(
- HasCompatibleImportedNodeKind(imported_kind, kind),
- "Node of kind {0} created with location of imported node of kind {1}",
- kind, imported_kind);
- }
- auto Context::AddPlaceholderInstInNoBlock(SemIR::LocIdAndInst loc_id_and_inst)
- -> SemIR::InstId {
- auto inst_id = sem_ir().insts().AddInNoBlock(loc_id_and_inst);
- CARBON_VLOG("AddPlaceholderInst: {0}\n", loc_id_and_inst.inst);
- constant_values().Set(inst_id, SemIR::ConstantId::None);
- return inst_id;
- }
- auto Context::AddPlaceholderInst(SemIR::LocIdAndInst loc_id_and_inst)
- -> SemIR::InstId {
- auto inst_id = AddPlaceholderInstInNoBlock(loc_id_and_inst);
- inst_block_stack_.AddInstId(inst_id);
- return inst_id;
- }
- auto Context::ReplaceLocIdAndInstBeforeConstantUse(
- SemIR::InstId inst_id, SemIR::LocIdAndInst loc_id_and_inst) -> void {
- sem_ir().insts().SetLocIdAndInst(inst_id, loc_id_and_inst);
- CARBON_VLOG("ReplaceInst: {0} -> {1}\n", inst_id, loc_id_and_inst.inst);
- FinishInst(inst_id, loc_id_and_inst.inst);
- }
- auto Context::ReplaceInstBeforeConstantUse(SemIR::InstId inst_id,
- SemIR::Inst inst) -> void {
- sem_ir().insts().Set(inst_id, inst);
- CARBON_VLOG("ReplaceInst: {0} -> {1}\n", inst_id, inst);
- FinishInst(inst_id, inst);
- }
- auto Context::ReplaceInstPreservingConstantValue(SemIR::InstId inst_id,
- SemIR::Inst inst) -> void {
- auto old_const_id = sem_ir().constant_values().Get(inst_id);
- sem_ir().insts().Set(inst_id, inst);
- CARBON_VLOG("ReplaceInst: {0} -> {1}\n", inst_id, inst);
- auto new_const_id = TryEvalInst(*this, inst_id, inst);
- CARBON_CHECK(old_const_id == new_const_id);
- }
- auto Context::DiagnoseDuplicateName(SemIRLoc dup_def, SemIRLoc prev_def)
- -> void {
- CARBON_DIAGNOSTIC(NameDeclDuplicate, Error,
- "duplicate name being declared in the same scope");
- CARBON_DIAGNOSTIC(NameDeclPrevious, Note, "name is previously declared here");
- emitter_->Build(dup_def, NameDeclDuplicate)
- .Note(prev_def, NameDeclPrevious)
- .Emit();
- }
- auto Context::DiagnosePoisonedName(SemIR::LocId poisoning_loc_id,
- SemIR::InstId decl_inst_id) -> void {
- CARBON_CHECK(poisoning_loc_id.has_value(),
- "Trying to diagnose poisoned name with no poisoning location");
- CARBON_DIAGNOSTIC(NameUseBeforeDecl, Error,
- "name used before it was declared");
- CARBON_DIAGNOSTIC(NameUseBeforeDeclNote, Note, "declared here");
- emitter_->Build(poisoning_loc_id, NameUseBeforeDecl)
- .Note(decl_inst_id, NameUseBeforeDeclNote)
- .Emit();
- }
- auto Context::DiagnoseNameNotFound(SemIRLoc loc, SemIR::NameId name_id)
- -> void {
- CARBON_DIAGNOSTIC(NameNotFound, Error, "name `{0}` not found", SemIR::NameId);
- emitter_->Emit(loc, NameNotFound, name_id);
- }
- auto Context::DiagnoseMemberNameNotFound(
- SemIRLoc loc, SemIR::NameId name_id,
- llvm::ArrayRef<LookupScope> lookup_scopes) -> void {
- if (lookup_scopes.size() == 1 &&
- lookup_scopes.front().name_scope_id.has_value()) {
- auto specific_id = lookup_scopes.front().specific_id;
- auto scope_inst_id =
- specific_id.has_value()
- ? GetInstForSpecific(*this, specific_id)
- : name_scopes().Get(lookup_scopes.front().name_scope_id).inst_id();
- CARBON_DIAGNOSTIC(MemberNameNotFoundInScope, Error,
- "member name `{0}` not found in {1}", SemIR::NameId,
- InstIdAsType);
- emitter_->Emit(loc, MemberNameNotFoundInScope, name_id, scope_inst_id);
- return;
- }
- CARBON_DIAGNOSTIC(MemberNameNotFound, Error, "member name `{0}` not found",
- SemIR::NameId);
- emitter_->Emit(loc, MemberNameNotFound, name_id);
- }
- auto Context::NoteAbstractClass(SemIR::ClassId class_id,
- DiagnosticBuilder& builder) -> void {
- const auto& class_info = classes().Get(class_id);
- CARBON_CHECK(
- class_info.inheritance_kind == SemIR::Class::InheritanceKind::Abstract,
- "Class is not abstract");
- CARBON_DIAGNOSTIC(ClassAbstractHere, Note,
- "class was declared abstract here");
- builder.Note(class_info.definition_id, ClassAbstractHere);
- }
- auto Context::NoteIncompleteClass(SemIR::ClassId class_id,
- DiagnosticBuilder& builder) -> void {
- const auto& class_info = classes().Get(class_id);
- CARBON_CHECK(!class_info.is_defined(), "Class is not incomplete");
- if (class_info.has_definition_started()) {
- CARBON_DIAGNOSTIC(ClassIncompleteWithinDefinition, Note,
- "class is incomplete within its definition");
- builder.Note(class_info.definition_id, ClassIncompleteWithinDefinition);
- } else {
- CARBON_DIAGNOSTIC(ClassForwardDeclaredHere, Note,
- "class was forward declared here");
- builder.Note(class_info.latest_decl_id(), ClassForwardDeclaredHere);
- }
- }
- auto Context::NoteUndefinedInterface(SemIR::InterfaceId interface_id,
- DiagnosticBuilder& builder) -> void {
- const auto& interface_info = interfaces().Get(interface_id);
- CARBON_CHECK(!interface_info.is_defined(), "Interface is not incomplete");
- if (interface_info.is_being_defined()) {
- CARBON_DIAGNOSTIC(InterfaceUndefinedWithinDefinition, Note,
- "interface is currently being defined");
- builder.Note(interface_info.definition_id,
- InterfaceUndefinedWithinDefinition);
- } else {
- CARBON_DIAGNOSTIC(InterfaceForwardDeclaredHere, Note,
- "interface was forward declared here");
- builder.Note(interface_info.latest_decl_id(), InterfaceForwardDeclaredHere);
- }
- }
- auto Context::AddNameToLookup(SemIR::NameId name_id, SemIR::InstId target_id,
- ScopeIndex scope_index) -> void {
- if (auto existing =
- scope_stack().LookupOrAddName(name_id, target_id, scope_index);
- existing.has_value()) {
- DiagnoseDuplicateName(target_id, existing);
- }
- }
- auto Context::LookupNameInDecl(SemIR::LocId loc_id, SemIR::NameId name_id,
- SemIR::NameScopeId scope_id,
- ScopeIndex scope_index)
- -> SemIR::ScopeLookupResult {
- if (!scope_id.has_value()) {
- // Look for a name in the specified scope or a scope nested within it only.
- // There are two cases where the name would be in an outer scope:
- //
- // - The name is the sole component of the declared name:
- //
- // class A;
- // fn F() {
- // class A;
- // }
- //
- // In this case, the inner A is not the same class as the outer A, so
- // lookup should not find the outer A.
- //
- // - The name is a qualifier of some larger declared name:
- //
- // class A { class B; }
- // fn F() {
- // class A.B {}
- // }
- //
- // In this case, we're not in the correct scope to define a member of
- // class A, so we should reject, and we achieve this by not finding the
- // name A from the outer scope.
- //
- // There is also one case where the name would be in an inner scope:
- //
- // - The name is redeclared by a parameter of the same entity:
- //
- // fn F() {
- // class C(C:! type);
- // }
- //
- // In this case, the class C is not a redeclaration of its parameter, but
- // we find the parameter in order to diagnose a redeclaration error.
- return SemIR::ScopeLookupResult::MakeWrappedLookupResult(
- scope_stack().LookupInLexicalScopesWithin(name_id, scope_index),
- SemIR::AccessKind::Public);
- } else {
- // We do not look into `extend`ed scopes here. A qualified name in a
- // declaration must specify the exact scope in which the name was originally
- // introduced:
- //
- // base class A { fn F(); }
- // class B { extend base: A; }
- //
- // // Error, no `F` in `B`.
- // fn B.F() {}
- return LookupNameInExactScope(loc_id, name_id, scope_id,
- name_scopes().Get(scope_id),
- /*is_being_declared=*/true);
- }
- }
- auto Context::LookupUnqualifiedName(Parse::NodeId node_id,
- SemIR::NameId name_id, bool required)
- -> LookupResult {
- // TODO: Check for shadowed lookup results.
- // Find the results from ancestor lexical scopes. These will be combined with
- // results from non-lexical scopes such as namespaces and classes.
- auto [lexical_result, non_lexical_scopes] =
- scope_stack().LookupInLexicalScopes(name_id);
- // Walk the non-lexical scopes and perform lookups into each of them.
- for (auto [index, lookup_scope_id, specific_id] :
- llvm::reverse(non_lexical_scopes)) {
- if (auto non_lexical_result =
- LookupQualifiedName(node_id, name_id,
- LookupScope{.name_scope_id = lookup_scope_id,
- .specific_id = specific_id},
- /*required=*/false);
- non_lexical_result.scope_result.is_found()) {
- return non_lexical_result;
- }
- }
- if (lexical_result == SemIR::InstId::InitTombstone) {
- CARBON_DIAGNOSTIC(UsedBeforeInitialization, Error,
- "`{0}` used before initialization", SemIR::NameId);
- emitter_->Emit(node_id, UsedBeforeInitialization, name_id);
- return {.specific_id = SemIR::SpecificId::None,
- .scope_result = SemIR::ScopeLookupResult::MakeError()};
- }
- if (lexical_result.has_value()) {
- // A lexical scope never needs an associated specific. If there's a
- // lexically enclosing generic, then it also encloses the point of use of
- // the name.
- return {.specific_id = SemIR::SpecificId::None,
- .scope_result = SemIR::ScopeLookupResult::MakeFound(
- lexical_result, SemIR::AccessKind::Public)};
- }
- // We didn't find anything at all.
- if (required) {
- DiagnoseNameNotFound(node_id, name_id);
- }
- return {.specific_id = SemIR::SpecificId::None,
- .scope_result = SemIR::ScopeLookupResult::MakeError()};
- }
- auto Context::LookupNameInExactScope(SemIR::LocId loc_id, SemIR::NameId name_id,
- SemIR::NameScopeId scope_id,
- SemIR::NameScope& scope,
- bool is_being_declared)
- -> SemIR::ScopeLookupResult {
- if (auto entry_id = is_being_declared
- ? scope.Lookup(name_id)
- : scope.LookupOrPoison(loc_id, name_id)) {
- auto lookup_result = scope.GetEntry(*entry_id).result;
- if (!lookup_result.is_poisoned()) {
- LoadImportRef(*this, lookup_result.target_inst_id());
- }
- return lookup_result;
- }
- if (!scope.import_ir_scopes().empty()) {
- // TODO: Enforce other access modifiers for imports.
- return SemIR::ScopeLookupResult::MakeWrappedLookupResult(
- ImportNameFromOtherPackage(*this, loc_id, scope_id,
- scope.import_ir_scopes(), name_id),
- SemIR::AccessKind::Public);
- }
- return SemIR::ScopeLookupResult::MakeNotFound();
- }
- // Prints diagnostics on invalid qualified name access.
- static auto DiagnoseInvalidQualifiedNameAccess(Context& context, SemIRLoc loc,
- SemIR::InstId scope_result_id,
- SemIR::NameId name_id,
- SemIR::AccessKind access_kind,
- bool is_parent_access,
- AccessInfo access_info) -> void {
- auto class_type = context.insts().TryGetAs<SemIR::ClassType>(
- context.constant_values().GetInstId(access_info.constant_id));
- if (!class_type) {
- return;
- }
- // TODO: Support scoped entities other than just classes.
- const auto& class_info = context.classes().Get(class_type->class_id);
- auto parent_type_id = class_info.self_type_id;
- if (access_kind == SemIR::AccessKind::Private && is_parent_access) {
- if (auto base_type_id =
- class_info.GetBaseType(context.sem_ir(), class_type->specific_id);
- base_type_id.has_value()) {
- parent_type_id = base_type_id;
- } else if (auto adapted_type_id = class_info.GetAdaptedType(
- context.sem_ir(), class_type->specific_id);
- adapted_type_id.has_value()) {
- parent_type_id = adapted_type_id;
- } else {
- CARBON_FATAL("Expected parent for parent access");
- }
- }
- CARBON_DIAGNOSTIC(
- ClassInvalidMemberAccess, Error,
- "cannot access {0:private|protected} member `{1}` of type {2}",
- BoolAsSelect, SemIR::NameId, SemIR::TypeId);
- CARBON_DIAGNOSTIC(ClassMemberDeclaration, Note, "declared here");
- context.emitter()
- .Build(loc, ClassInvalidMemberAccess,
- access_kind == SemIR::AccessKind::Private, name_id, parent_type_id)
- .Note(scope_result_id, ClassMemberDeclaration)
- .Emit();
- }
- // Returns whether the access is prohibited by the access modifiers.
- static auto IsAccessProhibited(std::optional<AccessInfo> access_info,
- SemIR::AccessKind access_kind,
- bool is_parent_access) -> bool {
- if (!access_info) {
- return false;
- }
- switch (access_kind) {
- case SemIR::AccessKind::Public:
- return false;
- case SemIR::AccessKind::Protected:
- return access_info->highest_allowed_access == SemIR::AccessKind::Public;
- case SemIR::AccessKind::Private:
- return access_info->highest_allowed_access !=
- SemIR::AccessKind::Private ||
- is_parent_access;
- }
- }
- // Information regarding a prohibited access.
- struct ProhibitedAccessInfo {
- // The resulting inst of the lookup.
- SemIR::InstId scope_result_id;
- // The access kind of the lookup.
- SemIR::AccessKind access_kind;
- // If the lookup is from an extended scope. For example, if this is a base
- // class member access from a class that extends it.
- bool is_parent_access;
- };
- auto Context::AppendLookupScopesForConstant(
- SemIR::LocId loc_id, SemIR::ConstantId base_const_id,
- llvm::SmallVector<LookupScope>* scopes) -> bool {
- auto base_id = constant_values().GetInstId(base_const_id);
- auto base = insts().Get(base_id);
- if (auto base_as_namespace = base.TryAs<SemIR::Namespace>()) {
- scopes->push_back(
- LookupScope{.name_scope_id = base_as_namespace->name_scope_id,
- .specific_id = SemIR::SpecificId::None});
- return true;
- }
- if (auto base_as_class = base.TryAs<SemIR::ClassType>()) {
- RequireDefinedType(GetTypeIdForTypeConstant(base_const_id), loc_id, [&] {
- CARBON_DIAGNOSTIC(QualifiedExprInIncompleteClassScope, Error,
- "member access into incomplete class {0}",
- InstIdAsType);
- return emitter().Build(loc_id, QualifiedExprInIncompleteClassScope,
- base_id);
- });
- auto& class_info = classes().Get(base_as_class->class_id);
- scopes->push_back(LookupScope{.name_scope_id = class_info.scope_id,
- .specific_id = base_as_class->specific_id});
- return true;
- }
- if (auto base_as_facet_type = base.TryAs<SemIR::FacetType>()) {
- RequireDefinedType(GetTypeIdForTypeConstant(base_const_id), loc_id, [&] {
- CARBON_DIAGNOSTIC(QualifiedExprInUndefinedInterfaceScope, Error,
- "member access into undefined interface {0}",
- InstIdAsType);
- return emitter().Build(loc_id, QualifiedExprInUndefinedInterfaceScope,
- base_id);
- });
- const auto& facet_type_info =
- facet_types().Get(base_as_facet_type->facet_type_id);
- for (auto interface : facet_type_info.impls_constraints) {
- auto& interface_info = interfaces().Get(interface.interface_id);
- scopes->push_back(LookupScope{.name_scope_id = interface_info.scope_id,
- .specific_id = interface.specific_id});
- }
- return true;
- }
- if (base_const_id == SemIR::ErrorInst::SingletonConstantId) {
- // Lookup into this scope should fail without producing an error.
- scopes->push_back(LookupScope{.name_scope_id = SemIR::NameScopeId::None,
- .specific_id = SemIR::SpecificId::None});
- return true;
- }
- // TODO: Per the design, if `base_id` is any kind of type, then lookup should
- // treat it as a name scope, even if it doesn't have members. For example,
- // `(i32*).X` should fail because there's no name `X` in `i32*`, not because
- // there's no name `X` in `type`.
- return false;
- }
- auto Context::LookupQualifiedName(SemIR::LocId loc_id, SemIR::NameId name_id,
- llvm::ArrayRef<LookupScope> lookup_scopes,
- bool required,
- std::optional<AccessInfo> access_info)
- -> LookupResult {
- llvm::SmallVector<LookupScope> scopes(lookup_scopes);
- // TODO: Support reporting of multiple prohibited access.
- llvm::SmallVector<ProhibitedAccessInfo> prohibited_accesses;
- LookupResult result = {
- .specific_id = SemIR::SpecificId::None,
- .scope_result = SemIR::ScopeLookupResult::MakeNotFound()};
- bool has_error = false;
- bool is_parent_access = false;
- // Walk this scope and, if nothing is found here, the scopes it extends.
- while (!scopes.empty()) {
- auto [scope_id, specific_id] = scopes.pop_back_val();
- if (!scope_id.has_value()) {
- has_error = true;
- continue;
- }
- auto& name_scope = name_scopes().Get(scope_id);
- has_error |= name_scope.has_error();
- const SemIR::ScopeLookupResult scope_result =
- LookupNameInExactScope(loc_id, name_id, scope_id, name_scope);
- SemIR::AccessKind access_kind = scope_result.access_kind();
- auto is_access_prohibited =
- IsAccessProhibited(access_info, access_kind, is_parent_access);
- // Keep track of prohibited accesses, this will be useful for reporting
- // multiple prohibited accesses if we can't find a suitable lookup.
- if (is_access_prohibited) {
- prohibited_accesses.push_back({
- .scope_result_id = scope_result.target_inst_id(),
- .access_kind = access_kind,
- .is_parent_access = is_parent_access,
- });
- }
- if (!scope_result.is_found() || is_access_prohibited) {
- // If nothing is found in this scope or if we encountered an invalid
- // access, look in its extended scopes.
- const auto& extended = name_scope.extended_scopes();
- scopes.reserve(scopes.size() + extended.size());
- for (auto extended_id : llvm::reverse(extended)) {
- // Substitute into the constant describing the extended scope to
- // determine its corresponding specific.
- CARBON_CHECK(extended_id.has_value());
- LoadImportRef(*this, extended_id);
- SemIR::ConstantId const_id =
- GetConstantValueInSpecific(sem_ir(), specific_id, extended_id);
- DiagnosticAnnotationScope annotate_diagnostics(
- &emitter(), [&](auto& builder) {
- CARBON_DIAGNOSTIC(FromExtendHere, Note,
- "declared as an extended scope here");
- builder.Note(extended_id, FromExtendHere);
- });
- if (!AppendLookupScopesForConstant(loc_id, const_id, &scopes)) {
- // TODO: Handle case where we have a symbolic type and instead should
- // look in its type.
- }
- }
- is_parent_access |= !extended.empty();
- continue;
- }
- // If this is our second lookup result, diagnose an ambiguity.
- if (result.scope_result.is_found()) {
- CARBON_DIAGNOSTIC(
- NameAmbiguousDueToExtend, Error,
- "ambiguous use of name `{0}` found in multiple extended scopes",
- SemIR::NameId);
- emitter_->Emit(loc_id, NameAmbiguousDueToExtend, name_id);
- // TODO: Add notes pointing to the scopes.
- return {.specific_id = SemIR::SpecificId::None,
- .scope_result = SemIR::ScopeLookupResult::MakeError()};
- }
- result.scope_result = scope_result;
- result.specific_id = specific_id;
- }
- if (required && !result.scope_result.is_found()) {
- if (!has_error) {
- if (prohibited_accesses.empty()) {
- DiagnoseMemberNameNotFound(loc_id, name_id, lookup_scopes);
- } else {
- // TODO: We should report multiple prohibited accesses in case we don't
- // find a valid lookup. Reporting the last one should suffice for now.
- auto [scope_result_id, access_kind, is_parent_access] =
- prohibited_accesses.back();
- // Note, `access_info` is guaranteed to have a value here, since
- // `prohibited_accesses` is non-empty.
- DiagnoseInvalidQualifiedNameAccess(*this, loc_id, scope_result_id,
- name_id, access_kind,
- is_parent_access, *access_info);
- }
- }
- CARBON_CHECK(!result.scope_result.is_poisoned());
- return {.specific_id = SemIR::SpecificId::None,
- .scope_result = SemIR::ScopeLookupResult::MakeError()};
- }
- return result;
- }
- // Returns the scope of the Core package, or `None` if it's not found.
- //
- // TODO: Consider tracking the Core package in SemIR so we don't need to use
- // name lookup to find it.
- static auto GetCorePackage(Context& context, SemIR::LocId loc_id,
- llvm::StringRef name) -> SemIR::NameScopeId {
- auto core_ident_id = context.identifiers().Add("Core");
- auto packaging = context.parse_tree().packaging_decl();
- if (packaging && packaging->names.package_id == core_ident_id) {
- return SemIR::NameScopeId::Package;
- }
- auto core_name_id = SemIR::NameId::ForIdentifier(core_ident_id);
- // Look up `package.Core`.
- auto core_scope_result = context.LookupNameInExactScope(
- loc_id, core_name_id, SemIR::NameScopeId::Package,
- context.name_scopes().Get(SemIR::NameScopeId::Package));
- if (core_scope_result.is_found()) {
- // We expect it to be a namespace.
- if (auto namespace_inst = context.insts().TryGetAs<SemIR::Namespace>(
- core_scope_result.target_inst_id())) {
- // TODO: Decide whether to allow the case where `Core` is not a package.
- return namespace_inst->name_scope_id;
- }
- }
- CARBON_DIAGNOSTIC(
- CoreNotFound, Error,
- "`Core.{0}` implicitly referenced here, but package `Core` not found",
- std::string);
- context.emitter().Emit(loc_id, CoreNotFound, name.str());
- return SemIR::NameScopeId::None;
- }
- auto Context::LookupNameInCore(SemIR::LocId loc_id, llvm::StringRef name)
- -> SemIR::InstId {
- auto core_package_id = GetCorePackage(*this, loc_id, name);
- if (!core_package_id.has_value()) {
- return SemIR::ErrorInst::SingletonInstId;
- }
- auto name_id = SemIR::NameId::ForIdentifier(identifiers().Add(name));
- auto scope_result = LookupNameInExactScope(
- loc_id, name_id, core_package_id, name_scopes().Get(core_package_id));
- if (!scope_result.is_found()) {
- CARBON_DIAGNOSTIC(
- CoreNameNotFound, Error,
- "name `Core.{0}` implicitly referenced here, but not found",
- SemIR::NameId);
- emitter_->Emit(loc_id, CoreNameNotFound, name_id);
- return SemIR::ErrorInst::SingletonInstId;
- }
- // Look through import_refs and aliases.
- return constant_values().GetConstantInstId(scope_result.target_inst_id());
- }
- template <typename BranchNode, typename... Args>
- static auto AddDominatedBlockAndBranchImpl(Context& context,
- Parse::NodeId node_id, Args... args)
- -> SemIR::InstBlockId {
- if (!context.inst_block_stack().is_current_block_reachable()) {
- return SemIR::InstBlockId::Unreachable;
- }
- auto block_id = context.inst_blocks().AddDefaultValue();
- context.AddInst<BranchNode>(node_id, {block_id, args...});
- return block_id;
- }
- auto Context::AddDominatedBlockAndBranch(Parse::NodeId node_id)
- -> SemIR::InstBlockId {
- return AddDominatedBlockAndBranchImpl<SemIR::Branch>(*this, node_id);
- }
- auto Context::AddDominatedBlockAndBranchWithArg(Parse::NodeId node_id,
- SemIR::InstId arg_id)
- -> SemIR::InstBlockId {
- return AddDominatedBlockAndBranchImpl<SemIR::BranchWithArg>(*this, node_id,
- arg_id);
- }
- auto Context::AddDominatedBlockAndBranchIf(Parse::NodeId node_id,
- SemIR::InstId cond_id)
- -> SemIR::InstBlockId {
- return AddDominatedBlockAndBranchImpl<SemIR::BranchIf>(*this, node_id,
- cond_id);
- }
- auto Context::AddConvergenceBlockAndPush(Parse::NodeId node_id, int num_blocks)
- -> void {
- CARBON_CHECK(num_blocks >= 2, "no convergence");
- SemIR::InstBlockId new_block_id = SemIR::InstBlockId::Unreachable;
- for ([[maybe_unused]] auto _ : llvm::seq(num_blocks)) {
- if (inst_block_stack().is_current_block_reachable()) {
- if (new_block_id == SemIR::InstBlockId::Unreachable) {
- new_block_id = inst_blocks().AddDefaultValue();
- }
- CARBON_CHECK(node_id.has_value());
- AddInst<SemIR::Branch>(node_id, {.target_id = new_block_id});
- }
- inst_block_stack().Pop();
- }
- inst_block_stack().Push(new_block_id);
- AddToRegion(new_block_id, node_id);
- }
- auto Context::AddConvergenceBlockWithArgAndPush(
- Parse::NodeId node_id, std::initializer_list<SemIR::InstId> block_args)
- -> SemIR::InstId {
- CARBON_CHECK(block_args.size() >= 2, "no convergence");
- SemIR::InstBlockId new_block_id = SemIR::InstBlockId::Unreachable;
- for (auto arg_id : block_args) {
- if (inst_block_stack().is_current_block_reachable()) {
- if (new_block_id == SemIR::InstBlockId::Unreachable) {
- new_block_id = inst_blocks().AddDefaultValue();
- }
- AddInst<SemIR::BranchWithArg>(
- node_id, {.target_id = new_block_id, .arg_id = arg_id});
- }
- inst_block_stack().Pop();
- }
- inst_block_stack().Push(new_block_id);
- AddToRegion(new_block_id, node_id);
- // Acquire the result value.
- SemIR::TypeId result_type_id = insts().Get(*block_args.begin()).type_id();
- return AddInst<SemIR::BlockArg>(
- node_id, {.type_id = result_type_id, .block_id = new_block_id});
- }
- auto Context::SetBlockArgResultBeforeConstantUse(SemIR::InstId select_id,
- SemIR::InstId cond_id,
- SemIR::InstId if_true,
- SemIR::InstId if_false)
- -> void {
- CARBON_CHECK(insts().Is<SemIR::BlockArg>(select_id));
- // Determine the constant result based on the condition value.
- SemIR::ConstantId const_id = SemIR::ConstantId::NotConstant;
- auto cond_const_id = constant_values().Get(cond_id);
- if (!cond_const_id.is_template()) {
- // Symbolic or non-constant condition means a non-constant result.
- } else if (auto literal = insts().TryGetAs<SemIR::BoolLiteral>(
- constant_values().GetInstId(cond_const_id))) {
- const_id = constant_values().Get(literal.value().value.ToBool() ? if_true
- : if_false);
- } else {
- CARBON_CHECK(cond_const_id == SemIR::ErrorInst::SingletonConstantId,
- "Unexpected constant branch condition.");
- const_id = SemIR::ErrorInst::SingletonConstantId;
- }
- if (const_id.is_constant()) {
- CARBON_VLOG("Constant: {0} -> {1}\n", insts().Get(select_id),
- constant_values().GetInstId(const_id));
- constant_values().Set(select_id, const_id);
- }
- }
- auto Context::AddToRegion(SemIR::InstBlockId block_id, SemIR::LocId loc_id)
- -> void {
- if (region_stack_.empty()) {
- TODO(loc_id,
- "Control flow expressions are currently only supported inside "
- "functions.");
- return;
- }
- if (block_id == SemIR::InstBlockId::Unreachable) {
- return;
- }
- region_stack_.AppendToTop(block_id);
- }
- auto Context::BeginSubpattern() -> void {
- inst_block_stack().Push();
- PushRegion(inst_block_stack().PeekOrAdd());
- }
- auto Context::EndSubpatternAsExpr(SemIR::InstId result_id)
- -> SemIR::ExprRegionId {
- if (region_stack_.PeekArray().size() > 1) {
- // End the exit block with a branch to a successor block, whose contents
- // will be determined later.
- AddInst(SemIR::LocIdAndInst::NoLoc<SemIR::Branch>(
- {.target_id = inst_blocks().AddDefaultValue()}));
- } else {
- // This single-block region will be inserted as a SpliceBlock, so we don't
- // need control flow out of it.
- }
- auto block_id = inst_block_stack().Pop();
- CARBON_CHECK(block_id == region_stack_.PeekArray().back());
- // TODO: Is it possible to validate that this region is genuinely
- // single-entry, single-exit?
- return sem_ir().expr_regions().Add(
- {.block_ids = PopRegion(), .result_id = result_id});
- }
- auto Context::EndSubpatternAsEmpty() -> void {
- auto block_id = inst_block_stack().Pop();
- CARBON_CHECK(block_id == region_stack_.PeekArray().back());
- CARBON_CHECK(region_stack_.PeekArray().size() == 1);
- CARBON_CHECK(inst_blocks().Get(block_id).empty());
- region_stack_.PopArray();
- }
- auto Context::InsertHere(SemIR::ExprRegionId region_id) -> SemIR::InstId {
- auto region = sem_ir_->expr_regions().Get(region_id);
- auto loc_id = insts().GetLocId(region.result_id);
- auto exit_block = inst_blocks().Get(region.block_ids.back());
- if (region.block_ids.size() == 1) {
- // TODO: Is it possible to avoid leaving an "orphan" block in the IR in the
- // first two cases?
- if (exit_block.empty()) {
- return region.result_id;
- }
- if (exit_block.size() == 1) {
- inst_block_stack_.AddInstId(exit_block.front());
- return region.result_id;
- }
- return AddInst<SemIR::SpliceBlock>(
- loc_id, {.type_id = insts().Get(region.result_id).type_id(),
- .block_id = region.block_ids.front(),
- .result_id = region.result_id});
- }
- if (region_stack_.empty()) {
- TODO(loc_id,
- "Control flow expressions are currently only supported inside "
- "functions.");
- return SemIR::ErrorInst::SingletonInstId;
- }
- AddInst(SemIR::LocIdAndInst::NoLoc<SemIR::Branch>(
- {.target_id = region.block_ids.front()}));
- inst_block_stack_.Pop();
- // TODO: this will cumulatively cost O(MN) running time for M blocks
- // at the Nth level of the stack. Figure out how to do better.
- region_stack_.AppendToTop(region.block_ids);
- auto resume_with_block_id =
- insts().GetAs<SemIR::Branch>(exit_block.back()).target_id;
- CARBON_CHECK(inst_blocks().GetOrEmpty(resume_with_block_id).empty());
- inst_block_stack_.Push(resume_with_block_id);
- AddToRegion(resume_with_block_id, loc_id);
- return region.result_id;
- }
- auto Context::is_current_position_reachable() -> bool {
- if (!inst_block_stack().is_current_block_reachable()) {
- return false;
- }
- // Our current position is at the end of a reachable block. That position is
- // reachable unless the previous instruction is a terminator instruction.
- auto block_contents = inst_block_stack().PeekCurrentBlockContents();
- if (block_contents.empty()) {
- return true;
- }
- const auto& last_inst = insts().Get(block_contents.back());
- return last_inst.kind().terminator_kind() !=
- SemIR::TerminatorKind::Terminator;
- }
- auto Context::Finalize() -> void {
- // Pop information for the file-level scope.
- sem_ir().set_top_inst_block_id(inst_block_stack().Pop());
- scope_stack().Pop();
- // Finalizes the list of exports on the IR.
- inst_blocks().Set(SemIR::InstBlockId::Exports, exports_);
- // Finalizes the ImportRef inst block.
- inst_blocks().Set(SemIR::InstBlockId::ImportRefs, import_ref_ids_);
- // Finalizes __global_init.
- global_init_.Finalize();
- }
- namespace {
- // Worklist-based type completion mechanism.
- //
- // When attempting to complete a type, we may find other types that also need to
- // be completed: types nested within that type, and the value representation of
- // the type. In order to complete a type without recursing arbitrarily deeply,
- // we use a worklist of tasks:
- //
- // - An `AddNestedIncompleteTypes` step adds a task for all incomplete types
- // nested within a type to the work list.
- // - A `BuildValueRepr` step computes the value representation for a
- // type, once all of its nested types are complete, and marks the type as
- // complete.
- class TypeCompleter {
- public:
- TypeCompleter(Context& context, SemIRLoc loc,
- Context::BuildDiagnosticFn diagnoser)
- : context_(context), loc_(loc), diagnoser_(diagnoser) {}
- // Attempts to complete the given type. Returns true if it is now complete,
- // false if it could not be completed.
- auto Complete(SemIR::TypeId type_id) -> bool {
- Push(type_id);
- while (!work_list_.empty()) {
- if (!ProcessStep()) {
- return false;
- }
- }
- return true;
- }
- private:
- // Adds `type_id` to the work list, if it's not already complete.
- auto Push(SemIR::TypeId type_id) -> void {
- if (!context_.types().IsComplete(type_id)) {
- work_list_.push_back(
- {.type_id = type_id, .phase = Phase::AddNestedIncompleteTypes});
- }
- }
- // Runs the next step.
- auto ProcessStep() -> bool {
- auto [type_id, phase] = work_list_.back();
- // We might have enqueued the same type more than once. Just skip the
- // type if it's already complete.
- if (context_.types().IsComplete(type_id)) {
- work_list_.pop_back();
- return true;
- }
- auto inst_id = context_.types().GetInstId(type_id);
- auto inst = context_.insts().Get(inst_id);
- auto old_work_list_size = work_list_.size();
- switch (phase) {
- case Phase::AddNestedIncompleteTypes:
- if (!AddNestedIncompleteTypes(inst)) {
- return false;
- }
- CARBON_CHECK(work_list_.size() >= old_work_list_size,
- "AddNestedIncompleteTypes should not remove work items");
- work_list_[old_work_list_size - 1].phase = Phase::BuildValueRepr;
- break;
- case Phase::BuildValueRepr: {
- auto value_rep = BuildValueRepr(type_id, inst);
- context_.types().SetValueRepr(type_id, value_rep);
- CARBON_CHECK(old_work_list_size == work_list_.size(),
- "BuildValueRepr should not change work items");
- work_list_.pop_back();
- // Also complete the value representation type, if necessary. This
- // should never fail: the value representation shouldn't require any
- // additional nested types to be complete.
- if (!context_.types().IsComplete(value_rep.type_id)) {
- work_list_.push_back(
- {.type_id = value_rep.type_id, .phase = Phase::BuildValueRepr});
- }
- // For a pointer representation, the pointee also needs to be complete.
- if (value_rep.kind == SemIR::ValueRepr::Pointer) {
- if (value_rep.type_id == SemIR::ErrorInst::SingletonTypeId) {
- break;
- }
- auto pointee_type_id =
- context_.sem_ir().GetPointeeType(value_rep.type_id);
- if (!context_.types().IsComplete(pointee_type_id)) {
- work_list_.push_back(
- {.type_id = pointee_type_id, .phase = Phase::BuildValueRepr});
- }
- }
- break;
- }
- }
- return true;
- }
- // Adds any types nested within `type_inst` that need to be complete for
- // `type_inst` to be complete to our work list.
- auto AddNestedIncompleteTypes(SemIR::Inst type_inst) -> bool {
- CARBON_KIND_SWITCH(type_inst) {
- case CARBON_KIND(SemIR::ArrayType inst): {
- Push(inst.element_type_id);
- break;
- }
- case CARBON_KIND(SemIR::StructType inst): {
- for (auto field : context_.struct_type_fields().Get(inst.fields_id)) {
- Push(field.type_id);
- }
- break;
- }
- case CARBON_KIND(SemIR::TupleType inst): {
- for (auto element_type_id :
- context_.type_blocks().Get(inst.elements_id)) {
- Push(element_type_id);
- }
- break;
- }
- case CARBON_KIND(SemIR::ClassType inst): {
- auto& class_info = context_.classes().Get(inst.class_id);
- if (!class_info.is_defined()) {
- if (diagnoser_) {
- auto builder = diagnoser_();
- context_.NoteIncompleteClass(inst.class_id, builder);
- builder.Emit();
- }
- return false;
- }
- if (inst.specific_id.has_value()) {
- ResolveSpecificDefinition(context_, loc_, inst.specific_id);
- }
- if (auto adapted_type_id =
- class_info.GetAdaptedType(context_.sem_ir(), inst.specific_id);
- adapted_type_id.has_value()) {
- Push(adapted_type_id);
- } else {
- Push(class_info.GetObjectRepr(context_.sem_ir(), inst.specific_id));
- }
- break;
- }
- case CARBON_KIND(SemIR::ConstType inst): {
- Push(inst.inner_id);
- break;
- }
- default:
- break;
- }
- return true;
- }
- // Makes an empty value representation, which is used for types that have no
- // state, such as empty structs and tuples.
- auto MakeEmptyValueRepr() const -> SemIR::ValueRepr {
- return {.kind = SemIR::ValueRepr::None,
- .type_id = context_.GetTupleType({})};
- }
- // Makes a value representation that uses pass-by-copy, copying the given
- // type.
- auto MakeCopyValueRepr(SemIR::TypeId rep_id,
- SemIR::ValueRepr::AggregateKind aggregate_kind =
- SemIR::ValueRepr::NotAggregate) const
- -> SemIR::ValueRepr {
- return {.kind = SemIR::ValueRepr::Copy,
- .aggregate_kind = aggregate_kind,
- .type_id = rep_id};
- }
- // Makes a value representation that uses pass-by-address with the given
- // pointee type.
- auto MakePointerValueRepr(SemIR::TypeId pointee_id,
- SemIR::ValueRepr::AggregateKind aggregate_kind =
- SemIR::ValueRepr::NotAggregate) const
- -> SemIR::ValueRepr {
- // TODO: Should we add `const` qualification to `pointee_id`?
- return {.kind = SemIR::ValueRepr::Pointer,
- .aggregate_kind = aggregate_kind,
- .type_id = context_.GetPointerType(pointee_id)};
- }
- // Gets the value representation of a nested type, which should already be
- // complete.
- auto GetNestedValueRepr(SemIR::TypeId nested_type_id) const {
- CARBON_CHECK(context_.types().IsComplete(nested_type_id),
- "Nested type should already be complete");
- auto value_rep = context_.types().GetValueRepr(nested_type_id);
- CARBON_CHECK(value_rep.kind != SemIR::ValueRepr::Unknown,
- "Complete type should have a value representation");
- return value_rep;
- }
- template <typename InstT>
- requires(InstT::Kind.template IsAnyOf<
- SemIR::AutoType, SemIR::BoolType, SemIR::BoundMethodType,
- SemIR::ErrorInst, SemIR::IntLiteralType, SemIR::LegacyFloatType,
- SemIR::NamespaceType, SemIR::SpecificFunctionType, SemIR::TypeType,
- SemIR::VtableType, SemIR::WitnessType>())
- auto BuildValueReprForInst(SemIR::TypeId type_id, InstT /*inst*/) const
- -> SemIR::ValueRepr {
- return MakeCopyValueRepr(type_id);
- }
- auto BuildValueReprForInst(SemIR::TypeId type_id,
- SemIR::StringType /*inst*/) const
- -> SemIR::ValueRepr {
- // TODO: Decide on string value semantics. This should probably be a
- // custom value representation carrying a pointer and size or
- // similar.
- return MakePointerValueRepr(type_id);
- }
- auto BuildStructOrTupleValueRepr(size_t num_elements,
- SemIR::TypeId elementwise_rep,
- bool same_as_object_rep) const
- -> SemIR::ValueRepr {
- SemIR::ValueRepr::AggregateKind aggregate_kind =
- same_as_object_rep ? SemIR::ValueRepr::ValueAndObjectAggregate
- : SemIR::ValueRepr::ValueAggregate;
- if (num_elements == 1) {
- // The value representation for a struct or tuple with a single element
- // is a struct or tuple containing the value representation of the
- // element.
- // TODO: Consider doing the same whenever `elementwise_rep` is
- // sufficiently small.
- return MakeCopyValueRepr(elementwise_rep, aggregate_kind);
- }
- // For a struct or tuple with multiple fields, we use a pointer
- // to the elementwise value representation.
- return MakePointerValueRepr(elementwise_rep, aggregate_kind);
- }
- auto BuildValueReprForInst(SemIR::TypeId type_id,
- SemIR::StructType struct_type) const
- -> SemIR::ValueRepr {
- auto fields = context_.struct_type_fields().Get(struct_type.fields_id);
- if (fields.empty()) {
- return MakeEmptyValueRepr();
- }
- // Find the value representation for each field, and construct a struct
- // of value representations.
- llvm::SmallVector<SemIR::StructTypeField> value_rep_fields;
- value_rep_fields.reserve(fields.size());
- bool same_as_object_rep = true;
- for (auto field : fields) {
- auto field_value_rep = GetNestedValueRepr(field.type_id);
- if (!field_value_rep.IsCopyOfObjectRepr(context_.sem_ir(),
- field.type_id)) {
- same_as_object_rep = false;
- field.type_id = field_value_rep.type_id;
- }
- value_rep_fields.push_back(field);
- }
- auto value_rep =
- same_as_object_rep
- ? type_id
- : context_.GetStructType(
- context_.struct_type_fields().AddCanonical(value_rep_fields));
- return BuildStructOrTupleValueRepr(fields.size(), value_rep,
- same_as_object_rep);
- }
- auto BuildValueReprForInst(SemIR::TypeId type_id,
- SemIR::TupleType tuple_type) const
- -> SemIR::ValueRepr {
- // TODO: Share more code with structs.
- auto elements = context_.type_blocks().Get(tuple_type.elements_id);
- if (elements.empty()) {
- return MakeEmptyValueRepr();
- }
- // Find the value representation for each element, and construct a tuple
- // of value representations.
- llvm::SmallVector<SemIR::TypeId> value_rep_elements;
- value_rep_elements.reserve(elements.size());
- bool same_as_object_rep = true;
- for (auto element_type_id : elements) {
- auto element_value_rep = GetNestedValueRepr(element_type_id);
- if (!element_value_rep.IsCopyOfObjectRepr(context_.sem_ir(),
- element_type_id)) {
- same_as_object_rep = false;
- }
- value_rep_elements.push_back(element_value_rep.type_id);
- }
- auto value_rep = same_as_object_rep
- ? type_id
- : context_.GetTupleType(value_rep_elements);
- return BuildStructOrTupleValueRepr(elements.size(), value_rep,
- same_as_object_rep);
- }
- auto BuildValueReprForInst(SemIR::TypeId type_id,
- SemIR::ArrayType /*inst*/) const
- -> SemIR::ValueRepr {
- // For arrays, it's convenient to always use a pointer representation,
- // even when the array has zero or one element, in order to support
- // indexing.
- return MakePointerValueRepr(type_id, SemIR::ValueRepr::ObjectAggregate);
- }
- auto BuildValueReprForInst(SemIR::TypeId /*type_id*/,
- SemIR::ClassType inst) const -> SemIR::ValueRepr {
- auto& class_info = context_.classes().Get(inst.class_id);
- // The value representation of an adapter is the value representation of
- // its adapted type.
- if (auto adapted_type_id =
- class_info.GetAdaptedType(context_.sem_ir(), inst.specific_id);
- adapted_type_id.has_value()) {
- return GetNestedValueRepr(adapted_type_id);
- }
- // Otherwise, the value representation for a class is a pointer to the
- // object representation.
- // TODO: Support customized value representations for classes.
- // TODO: Pick a better value representation when possible.
- return MakePointerValueRepr(
- class_info.GetObjectRepr(context_.sem_ir(), inst.specific_id),
- SemIR::ValueRepr::ObjectAggregate);
- }
- template <typename InstT>
- requires(InstT::Kind.template IsAnyOf<
- SemIR::AssociatedEntityType, SemIR::FacetAccessType,
- SemIR::FacetType, SemIR::FunctionType,
- SemIR::FunctionTypeWithSelfType, SemIR::GenericClassType,
- SemIR::GenericInterfaceType, SemIR::UnboundElementType,
- SemIR::WhereExpr>())
- auto BuildValueReprForInst(SemIR::TypeId /*type_id*/, InstT /*inst*/) const
- -> SemIR::ValueRepr {
- // These types have no runtime operations, so we use an empty value
- // representation.
- //
- // TODO: There is information we could model here:
- // - For an interface, we could use a witness.
- // - For an associated entity, we could use an index into the witness.
- // - For an unbound element, we could use an index or offset.
- return MakeEmptyValueRepr();
- }
- template <typename InstT>
- requires(InstT::Kind.template IsAnyOf<SemIR::BindSymbolicName,
- SemIR::ImplWitnessAccess>())
- auto BuildValueReprForInst(SemIR::TypeId type_id, InstT /*inst*/) const
- -> SemIR::ValueRepr {
- // For symbolic types, we arbitrarily pick a copy representation.
- return MakeCopyValueRepr(type_id);
- }
- template <typename InstT>
- requires(InstT::Kind.template IsAnyOf<SemIR::FloatType, SemIR::IntType,
- SemIR::PointerType>())
- auto BuildValueReprForInst(SemIR::TypeId type_id, InstT /*inst*/) const
- -> SemIR::ValueRepr {
- return MakeCopyValueRepr(type_id);
- }
- auto BuildValueReprForInst(SemIR::TypeId /*type_id*/,
- SemIR::ConstType inst) const -> SemIR::ValueRepr {
- // The value representation of `const T` is the same as that of `T`.
- // Objects are not modifiable through their value representations.
- return GetNestedValueRepr(inst.inner_id);
- }
- template <typename InstT>
- requires(InstT::Kind.is_type() == SemIR::InstIsType::Never)
- auto BuildValueReprForInst(SemIR::TypeId /*type_id*/, InstT inst) const
- -> SemIR::ValueRepr {
- CARBON_FATAL("Type refers to non-type inst {0}", inst);
- }
- // Builds and returns the value representation for the given type. All nested
- // types, as found by AddNestedIncompleteTypes, are known to be complete.
- auto BuildValueRepr(SemIR::TypeId type_id, SemIR::Inst inst) const
- -> SemIR::ValueRepr {
- // Use overload resolution to select the implementation, producing compile
- // errors when BuildValueReprForInst isn't defined for a given instruction.
- CARBON_KIND_SWITCH(inst) {
- #define CARBON_SEM_IR_INST_KIND(Name) \
- case CARBON_KIND(SemIR::Name typed_inst): { \
- return BuildValueReprForInst(type_id, typed_inst); \
- }
- #include "toolchain/sem_ir/inst_kind.def"
- }
- }
- enum class Phase : int8_t {
- // The next step is to add nested types to the list of types to complete.
- AddNestedIncompleteTypes,
- // The next step is to build the value representation for the type.
- BuildValueRepr,
- };
- struct WorkItem {
- SemIR::TypeId type_id;
- Phase phase;
- };
- Context& context_;
- llvm::SmallVector<WorkItem> work_list_;
- SemIRLoc loc_;
- Context::BuildDiagnosticFn diagnoser_;
- };
- } // namespace
- auto Context::TryToCompleteType(SemIR::TypeId type_id, SemIRLoc loc,
- BuildDiagnosticFn diagnoser) -> bool {
- return TypeCompleter(*this, loc, diagnoser).Complete(type_id);
- }
- auto Context::CompleteTypeOrCheckFail(SemIR::TypeId type_id) -> void {
- bool complete =
- TypeCompleter(*this, SemIR::LocId::None, nullptr).Complete(type_id);
- CARBON_CHECK(complete, "Expected {0} to be a complete type",
- types().GetAsInst(type_id));
- }
- auto Context::RequireCompleteType(SemIR::TypeId type_id, SemIR::LocId loc_id,
- BuildDiagnosticFn diagnoser) -> bool {
- CARBON_CHECK(diagnoser);
- if (!TypeCompleter(*this, loc_id, diagnoser).Complete(type_id)) {
- return false;
- }
- // For a symbolic type, create an instruction to require the corresponding
- // specific type to be complete.
- if (type_id.AsConstantId().is_symbolic()) {
- // TODO: Deduplicate these.
- AddInstInNoBlock(SemIR::LocIdAndInst(
- loc_id,
- SemIR::RequireCompleteType{
- .type_id = GetSingletonType(SemIR::WitnessType::SingletonInstId),
- .complete_type_id = type_id}));
- }
- return true;
- }
- auto Context::RequireConcreteType(SemIR::TypeId type_id, SemIR::LocId loc_id,
- BuildDiagnosticFn diagnoser,
- BuildDiagnosticFn abstract_diagnoser)
- -> bool {
- CARBON_CHECK(abstract_diagnoser);
- if (!RequireCompleteType(type_id, loc_id, diagnoser)) {
- return false;
- }
- if (auto class_type = types().TryGetAs<SemIR::ClassType>(type_id)) {
- auto& class_info = classes().Get(class_type->class_id);
- if (class_info.inheritance_kind !=
- SemIR::Class::InheritanceKind::Abstract) {
- return true;
- }
- auto builder = abstract_diagnoser();
- if (!builder) {
- return false;
- }
- NoteAbstractClass(class_type->class_id, builder);
- builder.Emit();
- return false;
- }
- return true;
- }
- auto Context::RequireDefinedType(SemIR::TypeId type_id, SemIR::LocId loc_id,
- BuildDiagnosticFn diagnoser) -> bool {
- if (!RequireCompleteType(type_id, loc_id, diagnoser)) {
- return false;
- }
- if (auto facet_type = types().TryGetAs<SemIR::FacetType>(type_id)) {
- const auto& facet_type_info = facet_types().Get(facet_type->facet_type_id);
- for (auto interface : facet_type_info.impls_constraints) {
- auto interface_id = interface.interface_id;
- if (!interfaces().Get(interface_id).is_defined()) {
- auto builder = diagnoser();
- NoteUndefinedInterface(interface_id, builder);
- builder.Emit();
- return false;
- }
- if (interface.specific_id.has_value()) {
- ResolveSpecificDefinition(*this, loc_id, interface.specific_id);
- }
- }
- // TODO: Finish facet type resolution.
- //
- // Note that we will need Self to be passed into facet type resolution.
- // The `.Self` of a facet type created by `where` will then be bound to the
- // provided self type.
- //
- // For example, in `T:! X where ...`, we will bind the `.Self` of the
- // `where` facet type to `T`, and in `(X where ...) where ...`, we will bind
- // the inner `.Self` to the outer `.Self`.
- //
- // If the facet type contains a rewrite, we may have deferred converting the
- // rewritten value to the type of the associated constant. That conversion
- // should also be performed as part of resolution, and may depend on the
- // Self type.
- }
- return true;
- }
- auto Context::GetTypeIdForTypeConstant(SemIR::ConstantId constant_id)
- -> SemIR::TypeId {
- CARBON_CHECK(constant_id.is_constant(),
- "Canonicalizing non-constant type: {0}", constant_id);
- auto type_id =
- insts().Get(constant_values().GetInstId(constant_id)).type_id();
- // TODO: For now, we allow values of facet type to be used as types.
- CARBON_CHECK(IsFacetType(type_id) ||
- constant_id == SemIR::ErrorInst::SingletonConstantId,
- "Forming type ID for non-type constant of type {0}",
- types().GetAsInst(type_id));
- return SemIR::TypeId::ForTypeConstant(constant_id);
- }
- auto Context::FacetTypeFromInterface(SemIR::InterfaceId interface_id,
- SemIR::SpecificId specific_id)
- -> SemIR::FacetType {
- SemIR::FacetTypeId facet_type_id = facet_types().Add(
- SemIR::FacetTypeInfo{.impls_constraints = {{interface_id, specific_id}},
- .other_requirements = false});
- return {.type_id = SemIR::TypeType::SingletonTypeId,
- .facet_type_id = facet_type_id};
- }
- // Gets or forms a type_id for a type, given the instruction kind and arguments.
- template <typename InstT, typename... EachArgT>
- static auto GetTypeImpl(Context& context, EachArgT... each_arg)
- -> SemIR::TypeId {
- // TODO: Remove inst_id parameter from TryEvalInst.
- InstT inst = {SemIR::TypeType::SingletonTypeId, each_arg...};
- return context.GetTypeIdForTypeConstant(
- TryEvalInst(context, SemIR::InstId::None, inst));
- }
- // Gets or forms a type_id for a type, given the instruction kind and arguments,
- // and completes the type. This should only be used when type completion cannot
- // fail.
- template <typename InstT, typename... EachArgT>
- static auto GetCompleteTypeImpl(Context& context, EachArgT... each_arg)
- -> SemIR::TypeId {
- auto type_id = GetTypeImpl<InstT>(context, each_arg...);
- context.CompleteTypeOrCheckFail(type_id);
- return type_id;
- }
- auto Context::GetStructType(SemIR::StructTypeFieldsId fields_id)
- -> SemIR::TypeId {
- return GetTypeImpl<SemIR::StructType>(*this, fields_id);
- }
- auto Context::GetTupleType(llvm::ArrayRef<SemIR::TypeId> type_ids)
- -> SemIR::TypeId {
- return GetTypeImpl<SemIR::TupleType>(*this,
- type_blocks().AddCanonical(type_ids));
- }
- auto Context::GetAssociatedEntityType(SemIR::TypeId interface_type_id)
- -> SemIR::TypeId {
- return GetTypeImpl<SemIR::AssociatedEntityType>(*this, interface_type_id);
- }
- auto Context::GetSingletonType(SemIR::InstId singleton_id) -> SemIR::TypeId {
- CARBON_CHECK(SemIR::IsSingletonInstId(singleton_id));
- auto type_id = GetTypeIdForTypeInst(singleton_id);
- // To keep client code simpler, complete builtin types before returning them.
- CompleteTypeOrCheckFail(type_id);
- return type_id;
- }
- auto Context::GetClassType(SemIR::ClassId class_id,
- SemIR::SpecificId specific_id) -> SemIR::TypeId {
- return GetTypeImpl<SemIR::ClassType>(*this, class_id, specific_id);
- }
- auto Context::GetFunctionType(SemIR::FunctionId fn_id,
- SemIR::SpecificId specific_id) -> SemIR::TypeId {
- return GetCompleteTypeImpl<SemIR::FunctionType>(*this, fn_id, specific_id);
- }
- auto Context::GetFunctionTypeWithSelfType(
- SemIR::InstId interface_function_type_id, SemIR::InstId self_id)
- -> SemIR::TypeId {
- return GetCompleteTypeImpl<SemIR::FunctionTypeWithSelfType>(
- *this, interface_function_type_id, self_id);
- }
- auto Context::GetGenericClassType(SemIR::ClassId class_id,
- SemIR::SpecificId enclosing_specific_id)
- -> SemIR::TypeId {
- return GetCompleteTypeImpl<SemIR::GenericClassType>(*this, class_id,
- enclosing_specific_id);
- }
- auto Context::GetGenericInterfaceType(SemIR::InterfaceId interface_id,
- SemIR::SpecificId enclosing_specific_id)
- -> SemIR::TypeId {
- return GetCompleteTypeImpl<SemIR::GenericInterfaceType>(
- *this, interface_id, enclosing_specific_id);
- }
- auto Context::GetInterfaceType(SemIR::InterfaceId interface_id,
- SemIR::SpecificId specific_id) -> SemIR::TypeId {
- return GetTypeImpl<SemIR::FacetType>(
- *this, FacetTypeFromInterface(interface_id, specific_id).facet_type_id);
- }
- auto Context::GetPointerType(SemIR::TypeId pointee_type_id) -> SemIR::TypeId {
- return GetTypeImpl<SemIR::PointerType>(*this, pointee_type_id);
- }
- auto Context::GetUnboundElementType(SemIR::TypeId class_type_id,
- SemIR::TypeId element_type_id)
- -> SemIR::TypeId {
- return GetTypeImpl<SemIR::UnboundElementType>(*this, class_type_id,
- element_type_id);
- }
- auto Context::PrintForStackDump(llvm::raw_ostream& output) const -> void {
- output << "Check::Context\n";
- // In a stack dump, this is probably indented by a tab. We treat that as 8
- // spaces then add a couple to indent past the Context label.
- constexpr int Indent = 10;
- node_stack_.PrintForStackDump(Indent, output);
- inst_block_stack_.PrintForStackDump(Indent, output);
- pattern_block_stack_.PrintForStackDump(Indent, output);
- param_and_arg_refs_stack_.PrintForStackDump(Indent, output);
- args_type_info_stack_.PrintForStackDump(Indent, output);
- }
- auto Context::DumpFormattedFile() const -> void {
- SemIR::Formatter formatter(sem_ir_);
- formatter.Print(llvm::errs());
- }
- } // namespace Carbon::Check
|