context.cpp 50 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315
  1. // Part of the Carbon Language project, under the Apache License v2.0 with LLVM
  2. // Exceptions. See /LICENSE for license information.
  3. // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
  4. #include "toolchain/check/context.h"
  5. #include <optional>
  6. #include <string>
  7. #include <utility>
  8. #include "common/check.h"
  9. #include "common/vlog.h"
  10. #include "llvm/ADT/Sequence.h"
  11. #include "toolchain/base/kind_switch.h"
  12. #include "toolchain/check/decl_name_stack.h"
  13. #include "toolchain/check/eval.h"
  14. #include "toolchain/check/generic.h"
  15. #include "toolchain/check/generic_region_stack.h"
  16. #include "toolchain/check/import.h"
  17. #include "toolchain/check/import_ref.h"
  18. #include "toolchain/check/inst_block_stack.h"
  19. #include "toolchain/check/merge.h"
  20. #include "toolchain/diagnostics/diagnostic_emitter.h"
  21. #include "toolchain/diagnostics/format_providers.h"
  22. #include "toolchain/lex/tokenized_buffer.h"
  23. #include "toolchain/parse/node_ids.h"
  24. #include "toolchain/parse/node_kind.h"
  25. #include "toolchain/sem_ir/builtin_inst_kind.h"
  26. #include "toolchain/sem_ir/file.h"
  27. #include "toolchain/sem_ir/formatter.h"
  28. #include "toolchain/sem_ir/generic.h"
  29. #include "toolchain/sem_ir/ids.h"
  30. #include "toolchain/sem_ir/import_ir.h"
  31. #include "toolchain/sem_ir/inst.h"
  32. #include "toolchain/sem_ir/inst_kind.h"
  33. #include "toolchain/sem_ir/name_scope.h"
  34. #include "toolchain/sem_ir/typed_insts.h"
  35. namespace Carbon::Check {
  36. Context::Context(const Lex::TokenizedBuffer& tokens, DiagnosticEmitter& emitter,
  37. const Parse::Tree& parse_tree,
  38. llvm::function_ref<const Parse::TreeAndSubtrees&()>
  39. get_parse_tree_and_subtrees,
  40. SemIR::File& sem_ir, llvm::raw_ostream* vlog_stream)
  41. : tokens_(&tokens),
  42. emitter_(&emitter),
  43. parse_tree_(&parse_tree),
  44. get_parse_tree_and_subtrees_(get_parse_tree_and_subtrees),
  45. sem_ir_(&sem_ir),
  46. vlog_stream_(vlog_stream),
  47. node_stack_(parse_tree, vlog_stream),
  48. inst_block_stack_("inst_block_stack_", sem_ir, vlog_stream),
  49. pattern_block_stack_("pattern_block_stack_", sem_ir, vlog_stream),
  50. param_and_arg_refs_stack_(sem_ir, vlog_stream, node_stack_),
  51. args_type_info_stack_("args_type_info_stack_", sem_ir, vlog_stream),
  52. decl_name_stack_(this),
  53. scope_stack_(sem_ir_->identifiers()),
  54. global_init_(this) {
  55. // Map the builtin `<error>` and `type` type constants to their corresponding
  56. // special `TypeId` values.
  57. type_ids_for_type_constants_.Insert(
  58. SemIR::ConstantId::ForTemplateConstant(SemIR::InstId::BuiltinError),
  59. SemIR::TypeId::Error);
  60. type_ids_for_type_constants_.Insert(
  61. SemIR::ConstantId::ForTemplateConstant(SemIR::InstId::BuiltinTypeType),
  62. SemIR::TypeId::TypeType);
  63. // TODO: Remove this and add a `VerifyOnFinish` once we properly push and pop
  64. // in the right places.
  65. generic_region_stack().Push();
  66. }
  67. auto Context::TODO(SemIRLoc loc, std::string label) -> bool {
  68. CARBON_DIAGNOSTIC(SemanticsTodo, Error, "semantics TODO: `{0}`", std::string);
  69. emitter_->Emit(loc, SemanticsTodo, std::move(label));
  70. return false;
  71. }
  72. auto Context::VerifyOnFinish() -> void {
  73. // Information in all the various context objects should be cleaned up as
  74. // various pieces of context go out of scope. At this point, nothing should
  75. // remain.
  76. // node_stack_ will still contain top-level entities.
  77. scope_stack_.VerifyOnFinish();
  78. inst_block_stack_.VerifyOnFinish();
  79. pattern_block_stack_.VerifyOnFinish();
  80. param_and_arg_refs_stack_.VerifyOnFinish();
  81. }
  82. // Finish producing an instruction. Set its constant value, and register it in
  83. // any applicable instruction lists.
  84. auto Context::FinishInst(SemIR::InstId inst_id, SemIR::Inst inst) -> void {
  85. GenericRegionStack::DependencyKind dep_kind =
  86. GenericRegionStack::DependencyKind::None;
  87. // If the instruction has a symbolic constant type, track that we need to
  88. // substitute into it.
  89. if (types().GetConstantId(inst.type_id()).is_symbolic()) {
  90. dep_kind |= GenericRegionStack::DependencyKind::SymbolicType;
  91. }
  92. // If the instruction has a constant value, compute it.
  93. auto const_id = TryEvalInst(*this, inst_id, inst);
  94. constant_values().Set(inst_id, const_id);
  95. if (const_id.is_constant()) {
  96. CARBON_VLOG("Constant: {0} -> {1}\n", inst,
  97. constant_values().GetInstId(const_id));
  98. // If the constant value is symbolic, track that we need to substitute into
  99. // it.
  100. if (const_id.is_symbolic()) {
  101. dep_kind |= GenericRegionStack::DependencyKind::SymbolicConstant;
  102. }
  103. }
  104. // Keep track of dependent instructions.
  105. if (dep_kind != GenericRegionStack::DependencyKind::None) {
  106. // TODO: Also check for template-dependent instructions.
  107. generic_region_stack().AddDependentInst(
  108. {.inst_id = inst_id, .kind = dep_kind});
  109. }
  110. }
  111. // Returns whether a parse node associated with an imported instruction of kind
  112. // `imported_kind` is usable as the location of a corresponding local
  113. // instruction of kind `local_kind`.
  114. static auto HasCompatibleImportedNodeKind(SemIR::InstKind imported_kind,
  115. SemIR::InstKind local_kind) -> bool {
  116. if (imported_kind == local_kind) {
  117. return true;
  118. }
  119. if (imported_kind == SemIR::ImportDecl::Kind &&
  120. local_kind == SemIR::Namespace::Kind) {
  121. static_assert(
  122. std::is_convertible_v<decltype(SemIR::ImportDecl::Kind)::TypedNodeId,
  123. decltype(SemIR::Namespace::Kind)::TypedNodeId>);
  124. return true;
  125. }
  126. return false;
  127. }
  128. auto Context::CheckCompatibleImportedNodeKind(
  129. SemIR::ImportIRInstId imported_loc_id, SemIR::InstKind kind) -> void {
  130. auto& import_ir_inst = import_ir_insts().Get(imported_loc_id);
  131. const auto* import_ir = import_irs().Get(import_ir_inst.ir_id).sem_ir;
  132. auto imported_kind = import_ir->insts().Get(import_ir_inst.inst_id).kind();
  133. CARBON_CHECK(
  134. HasCompatibleImportedNodeKind(imported_kind, kind),
  135. "Node of kind {0} created with location of imported node of kind {1}",
  136. kind, imported_kind);
  137. }
  138. auto Context::AddPlaceholderInstInNoBlock(SemIR::LocIdAndInst loc_id_and_inst)
  139. -> SemIR::InstId {
  140. auto inst_id = sem_ir().insts().AddInNoBlock(loc_id_and_inst);
  141. CARBON_VLOG("AddPlaceholderInst: {0}\n", loc_id_and_inst.inst);
  142. constant_values().Set(inst_id, SemIR::ConstantId::Invalid);
  143. return inst_id;
  144. }
  145. auto Context::AddPlaceholderInst(SemIR::LocIdAndInst loc_id_and_inst)
  146. -> SemIR::InstId {
  147. auto inst_id = AddPlaceholderInstInNoBlock(loc_id_and_inst);
  148. inst_block_stack_.AddInstId(inst_id);
  149. return inst_id;
  150. }
  151. auto Context::ReplaceLocIdAndInstBeforeConstantUse(
  152. SemIR::InstId inst_id, SemIR::LocIdAndInst loc_id_and_inst) -> void {
  153. sem_ir().insts().SetLocIdAndInst(inst_id, loc_id_and_inst);
  154. CARBON_VLOG("ReplaceInst: {0} -> {1}\n", inst_id, loc_id_and_inst.inst);
  155. FinishInst(inst_id, loc_id_and_inst.inst);
  156. }
  157. auto Context::ReplaceInstBeforeConstantUse(SemIR::InstId inst_id,
  158. SemIR::Inst inst) -> void {
  159. sem_ir().insts().Set(inst_id, inst);
  160. CARBON_VLOG("ReplaceInst: {0} -> {1}\n", inst_id, inst);
  161. FinishInst(inst_id, inst);
  162. }
  163. auto Context::DiagnoseDuplicateName(SemIRLoc dup_def, SemIRLoc prev_def)
  164. -> void {
  165. CARBON_DIAGNOSTIC(NameDeclDuplicate, Error,
  166. "duplicate name being declared in the same scope");
  167. CARBON_DIAGNOSTIC(NameDeclPrevious, Note, "name is previously declared here");
  168. emitter_->Build(dup_def, NameDeclDuplicate)
  169. .Note(prev_def, NameDeclPrevious)
  170. .Emit();
  171. }
  172. auto Context::DiagnoseNameNotFound(SemIRLoc loc, SemIR::NameId name_id)
  173. -> void {
  174. CARBON_DIAGNOSTIC(NameNotFound, Error, "name `{0}` not found", SemIR::NameId);
  175. emitter_->Emit(loc, NameNotFound, name_id);
  176. }
  177. auto Context::NoteAbstractClass(SemIR::ClassId class_id,
  178. DiagnosticBuilder& builder) -> void {
  179. const auto& class_info = classes().Get(class_id);
  180. CARBON_CHECK(
  181. class_info.inheritance_kind == SemIR::Class::InheritanceKind::Abstract,
  182. "Class is not abstract");
  183. CARBON_DIAGNOSTIC(ClassAbstractHere, Note,
  184. "class was declared abstract here");
  185. builder.Note(class_info.definition_id, ClassAbstractHere);
  186. }
  187. auto Context::NoteIncompleteClass(SemIR::ClassId class_id,
  188. DiagnosticBuilder& builder) -> void {
  189. const auto& class_info = classes().Get(class_id);
  190. CARBON_CHECK(!class_info.is_defined(), "Class is not incomplete");
  191. if (class_info.definition_id.is_valid()) {
  192. CARBON_DIAGNOSTIC(ClassIncompleteWithinDefinition, Note,
  193. "class is incomplete within its definition");
  194. builder.Note(class_info.definition_id, ClassIncompleteWithinDefinition);
  195. } else {
  196. CARBON_DIAGNOSTIC(ClassForwardDeclaredHere, Note,
  197. "class was forward declared here");
  198. builder.Note(class_info.latest_decl_id(), ClassForwardDeclaredHere);
  199. }
  200. }
  201. auto Context::NoteUndefinedInterface(SemIR::InterfaceId interface_id,
  202. DiagnosticBuilder& builder) -> void {
  203. const auto& interface_info = interfaces().Get(interface_id);
  204. CARBON_CHECK(!interface_info.is_defined(), "Interface is not incomplete");
  205. if (interface_info.is_being_defined()) {
  206. CARBON_DIAGNOSTIC(InterfaceUndefinedWithinDefinition, Note,
  207. "interface is currently being defined");
  208. builder.Note(interface_info.definition_id,
  209. InterfaceUndefinedWithinDefinition);
  210. } else {
  211. CARBON_DIAGNOSTIC(InterfaceForwardDeclaredHere, Note,
  212. "interface was forward declared here");
  213. builder.Note(interface_info.latest_decl_id(), InterfaceForwardDeclaredHere);
  214. }
  215. }
  216. auto Context::AddNameToLookup(SemIR::NameId name_id, SemIR::InstId target_id)
  217. -> void {
  218. if (auto existing = scope_stack().LookupOrAddName(name_id, target_id);
  219. existing.is_valid()) {
  220. DiagnoseDuplicateName(target_id, existing);
  221. }
  222. }
  223. auto Context::LookupNameInDecl(SemIR::LocId loc_id, SemIR::NameId name_id,
  224. SemIR::NameScopeId scope_id) -> SemIR::InstId {
  225. if (!scope_id.is_valid()) {
  226. // Look for a name in the current scope only. There are two cases where the
  227. // name would be in an outer scope:
  228. //
  229. // - The name is the sole component of the declared name:
  230. //
  231. // class A;
  232. // fn F() {
  233. // class A;
  234. // }
  235. //
  236. // In this case, the inner A is not the same class as the outer A, so
  237. // lookup should not find the outer A.
  238. //
  239. // - The name is a qualifier of some larger declared name:
  240. //
  241. // class A { class B; }
  242. // fn F() {
  243. // class A.B {}
  244. // }
  245. //
  246. // In this case, we're not in the correct scope to define a member of
  247. // class A, so we should reject, and we achieve this by not finding the
  248. // name A from the outer scope.
  249. return scope_stack().LookupInCurrentScope(name_id);
  250. } else {
  251. // We do not look into `extend`ed scopes here. A qualified name in a
  252. // declaration must specify the exact scope in which the name was originally
  253. // introduced:
  254. //
  255. // base class A { fn F(); }
  256. // class B { extend base: A; }
  257. //
  258. // // Error, no `F` in `B`.
  259. // fn B.F() {}
  260. return LookupNameInExactScope(loc_id, name_id, scope_id,
  261. name_scopes().Get(scope_id))
  262. .first;
  263. }
  264. }
  265. auto Context::LookupUnqualifiedName(Parse::NodeId node_id,
  266. SemIR::NameId name_id, bool required)
  267. -> LookupResult {
  268. // TODO: Check for shadowed lookup results.
  269. // Find the results from ancestor lexical scopes. These will be combined with
  270. // results from non-lexical scopes such as namespaces and classes.
  271. auto [lexical_result, non_lexical_scopes] =
  272. scope_stack().LookupInLexicalScopes(name_id);
  273. // Walk the non-lexical scopes and perform lookups into each of them.
  274. for (auto [index, lookup_scope_id, specific_id] :
  275. llvm::reverse(non_lexical_scopes)) {
  276. if (auto non_lexical_result = LookupQualifiedName(
  277. node_id, name_id,
  278. {.name_scope_id = lookup_scope_id, .specific_id = specific_id},
  279. /*required=*/false);
  280. non_lexical_result.inst_id.is_valid()) {
  281. return non_lexical_result;
  282. }
  283. }
  284. if (lexical_result.is_valid()) {
  285. // A lexical scope never needs an associated specific. If there's a
  286. // lexically enclosing generic, then it also encloses the point of use of
  287. // the name.
  288. return {.specific_id = SemIR::SpecificId::Invalid,
  289. .inst_id = lexical_result};
  290. }
  291. // We didn't find anything at all.
  292. if (required) {
  293. DiagnoseNameNotFound(node_id, name_id);
  294. }
  295. return {.specific_id = SemIR::SpecificId::Invalid,
  296. .inst_id = SemIR::InstId::BuiltinError};
  297. }
  298. auto Context::LookupNameInExactScope(SemIRLoc loc, SemIR::NameId name_id,
  299. SemIR::NameScopeId scope_id,
  300. const SemIR::NameScope& scope)
  301. -> std::pair<SemIR::InstId, SemIR::AccessKind> {
  302. if (auto lookup = scope.name_map.Lookup(name_id)) {
  303. auto entry = scope.names[lookup.value()];
  304. LoadImportRef(*this, entry.inst_id);
  305. return {entry.inst_id, entry.access_kind};
  306. }
  307. if (!scope.import_ir_scopes.empty()) {
  308. // TODO: Enforce other access modifiers for imports.
  309. return {ImportNameFromOtherPackage(*this, loc, scope_id,
  310. scope.import_ir_scopes, name_id),
  311. SemIR::AccessKind::Public};
  312. }
  313. return {SemIR::InstId::Invalid, SemIR::AccessKind::Public};
  314. }
  315. // Prints diagnostics on invalid qualified name access.
  316. static auto DiagnoseInvalidQualifiedNameAccess(Context& context, SemIRLoc loc,
  317. SemIR::InstId scope_result_id,
  318. SemIR::NameId name_id,
  319. SemIR::AccessKind access_kind,
  320. bool is_parent_access,
  321. AccessInfo access_info) -> void {
  322. auto class_type = context.insts().TryGetAs<SemIR::ClassType>(
  323. context.constant_values().GetInstId(access_info.constant_id));
  324. if (!class_type) {
  325. return;
  326. }
  327. // TODO: Support scoped entities other than just classes.
  328. auto class_info = context.classes().Get(class_type->class_id);
  329. auto parent_type_id = class_info.self_type_id;
  330. if (access_kind == SemIR::AccessKind::Private && is_parent_access) {
  331. if (auto base_decl = context.insts().TryGetAsIfValid<SemIR::BaseDecl>(
  332. class_info.base_id)) {
  333. parent_type_id = base_decl->base_type_id;
  334. } else if (auto adapt_decl =
  335. context.insts().TryGetAsIfValid<SemIR::AdaptDecl>(
  336. class_info.adapt_id)) {
  337. parent_type_id = adapt_decl->adapted_type_id;
  338. } else {
  339. CARBON_FATAL("Expected parent for parent access");
  340. }
  341. }
  342. CARBON_DIAGNOSTIC(
  343. ClassInvalidMemberAccess, Error,
  344. "cannot access {0:private|protected} member `{1}` of type {2}",
  345. BoolAsSelect, SemIR::NameId, SemIR::TypeId);
  346. CARBON_DIAGNOSTIC(ClassMemberDeclaration, Note, "declared here");
  347. context.emitter()
  348. .Build(loc, ClassInvalidMemberAccess,
  349. access_kind == SemIR::AccessKind::Private, name_id, parent_type_id)
  350. .Note(scope_result_id, ClassMemberDeclaration)
  351. .Emit();
  352. }
  353. // Returns whether the access is prohibited by the access modifiers.
  354. static auto IsAccessProhibited(std::optional<AccessInfo> access_info,
  355. SemIR::AccessKind access_kind,
  356. bool is_parent_access) -> bool {
  357. if (!access_info) {
  358. return false;
  359. }
  360. switch (access_kind) {
  361. case SemIR::AccessKind::Public:
  362. return false;
  363. case SemIR::AccessKind::Protected:
  364. return access_info->highest_allowed_access == SemIR::AccessKind::Public;
  365. case SemIR::AccessKind::Private:
  366. return access_info->highest_allowed_access !=
  367. SemIR::AccessKind::Private ||
  368. is_parent_access;
  369. }
  370. }
  371. // Information regarding a prohibited access.
  372. struct ProhibitedAccessInfo {
  373. // The resulting inst of the lookup.
  374. SemIR::InstId scope_result_id;
  375. // The access kind of the lookup.
  376. SemIR::AccessKind access_kind;
  377. // If the lookup is from an extended scope. For example, if this is a base
  378. // class member access from a class that extends it.
  379. bool is_parent_access;
  380. };
  381. auto Context::LookupQualifiedName(SemIRLoc loc, SemIR::NameId name_id,
  382. LookupScope scope, bool required,
  383. std::optional<AccessInfo> access_info)
  384. -> LookupResult {
  385. llvm::SmallVector<LookupScope> scopes = {scope};
  386. // TODO: Support reporting of multiple prohibited access.
  387. llvm::SmallVector<ProhibitedAccessInfo> prohibited_accesses;
  388. LookupResult result = {.specific_id = SemIR::SpecificId::Invalid,
  389. .inst_id = SemIR::InstId::Invalid};
  390. bool has_error = false;
  391. bool is_parent_access = false;
  392. // Walk this scope and, if nothing is found here, the scopes it extends.
  393. while (!scopes.empty()) {
  394. auto [scope_id, specific_id] = scopes.pop_back_val();
  395. const auto& name_scope = name_scopes().Get(scope_id);
  396. has_error |= name_scope.has_error;
  397. auto [scope_result_id, access_kind] =
  398. LookupNameInExactScope(loc, name_id, scope_id, name_scope);
  399. auto is_access_prohibited =
  400. IsAccessProhibited(access_info, access_kind, is_parent_access);
  401. // Keep track of prohibited accesses, this will be useful for reporting
  402. // multiple prohibited accesses if we can't find a suitable lookup.
  403. if (is_access_prohibited) {
  404. prohibited_accesses.push_back({
  405. .scope_result_id = scope_result_id,
  406. .access_kind = access_kind,
  407. .is_parent_access = is_parent_access,
  408. });
  409. }
  410. if (!scope_result_id.is_valid() || is_access_prohibited) {
  411. // If nothing is found in this scope or if we encountered an invalid
  412. // access, look in its extended scopes.
  413. auto extended = name_scope.extended_scopes;
  414. scopes.reserve(scopes.size() + extended.size());
  415. for (auto extended_id : llvm::reverse(extended)) {
  416. // TODO: Track a constant describing the extended scope, and substitute
  417. // into it to determine its corresponding specific.
  418. scopes.push_back({.name_scope_id = extended_id,
  419. .specific_id = SemIR::SpecificId::Invalid});
  420. }
  421. is_parent_access |= !extended.empty();
  422. continue;
  423. }
  424. // If this is our second lookup result, diagnose an ambiguity.
  425. if (result.inst_id.is_valid()) {
  426. // TODO: This is currently not reachable because the only scope that can
  427. // extend is a class scope, and it can only extend a single base class.
  428. // Add test coverage once this is possible.
  429. CARBON_DIAGNOSTIC(
  430. NameAmbiguousDueToExtend, Error,
  431. "ambiguous use of name `{0}` found in multiple extended scopes",
  432. SemIR::NameId);
  433. emitter_->Emit(loc, NameAmbiguousDueToExtend, name_id);
  434. // TODO: Add notes pointing to the scopes.
  435. return {.specific_id = SemIR::SpecificId::Invalid,
  436. .inst_id = SemIR::InstId::BuiltinError};
  437. }
  438. result.inst_id = scope_result_id;
  439. result.specific_id = specific_id;
  440. }
  441. if (required && !result.inst_id.is_valid()) {
  442. if (!has_error) {
  443. if (prohibited_accesses.empty()) {
  444. DiagnoseNameNotFound(loc, name_id);
  445. } else {
  446. // TODO: We should report multiple prohibited accesses in case we don't
  447. // find a valid lookup. Reporting the last one should suffice for now.
  448. auto [scope_result_id, access_kind, is_parent_access] =
  449. prohibited_accesses.back();
  450. // Note, `access_info` is guaranteed to have a value here, since
  451. // `prohibited_accesses` is non-empty.
  452. DiagnoseInvalidQualifiedNameAccess(*this, loc, scope_result_id, name_id,
  453. access_kind, is_parent_access,
  454. *access_info);
  455. }
  456. }
  457. return {.specific_id = SemIR::SpecificId::Invalid,
  458. .inst_id = SemIR::InstId::BuiltinError};
  459. }
  460. return result;
  461. }
  462. // Returns the scope of the Core package, or Invalid if it's not found.
  463. //
  464. // TODO: Consider tracking the Core package in SemIR so we don't need to use
  465. // name lookup to find it.
  466. static auto GetCorePackage(Context& context, SemIRLoc loc)
  467. -> SemIR::NameScopeId {
  468. auto core_ident_id = context.identifiers().Add("Core");
  469. auto packaging = context.parse_tree().packaging_decl();
  470. if (packaging && packaging->names.package_id == core_ident_id) {
  471. return SemIR::NameScopeId::Package;
  472. }
  473. auto core_name_id = SemIR::NameId::ForIdentifier(core_ident_id);
  474. // Look up `package.Core`.
  475. auto [core_inst_id, _] = context.LookupNameInExactScope(
  476. loc, core_name_id, SemIR::NameScopeId::Package,
  477. context.name_scopes().Get(SemIR::NameScopeId::Package));
  478. if (core_inst_id.is_valid()) {
  479. // We expect it to be a namespace.
  480. if (auto namespace_inst =
  481. context.insts().TryGetAs<SemIR::Namespace>(core_inst_id)) {
  482. // TODO: Decide whether to allow the case where `Core` is not a package.
  483. return namespace_inst->name_scope_id;
  484. }
  485. }
  486. CARBON_DIAGNOSTIC(CoreNotFound, Error,
  487. "package `Core` implicitly referenced here, but not found");
  488. context.emitter().Emit(loc, CoreNotFound);
  489. return SemIR::NameScopeId::Invalid;
  490. }
  491. auto Context::LookupNameInCore(SemIRLoc loc, llvm::StringRef name)
  492. -> SemIR::InstId {
  493. auto core_package_id = GetCorePackage(*this, loc);
  494. if (!core_package_id.is_valid()) {
  495. return SemIR::InstId::BuiltinError;
  496. }
  497. auto name_id = SemIR::NameId::ForIdentifier(identifiers().Add(name));
  498. auto [inst_id, _] = LookupNameInExactScope(
  499. loc, name_id, core_package_id, name_scopes().Get(core_package_id));
  500. if (!inst_id.is_valid()) {
  501. CARBON_DIAGNOSTIC(
  502. CoreNameNotFound, Error,
  503. "name `Core.{0}` implicitly referenced here, but not found",
  504. SemIR::NameId);
  505. emitter_->Emit(loc, CoreNameNotFound, name_id);
  506. return SemIR::InstId::BuiltinError;
  507. }
  508. // Look through import_refs and aliases.
  509. return constant_values().GetConstantInstId(inst_id);
  510. }
  511. template <typename BranchNode, typename... Args>
  512. static auto AddDominatedBlockAndBranchImpl(Context& context,
  513. Parse::NodeId node_id, Args... args)
  514. -> SemIR::InstBlockId {
  515. if (!context.inst_block_stack().is_current_block_reachable()) {
  516. return SemIR::InstBlockId::Unreachable;
  517. }
  518. auto block_id = context.inst_blocks().AddDefaultValue();
  519. context.AddInst<BranchNode>(node_id, {block_id, args...});
  520. return block_id;
  521. }
  522. auto Context::AddDominatedBlockAndBranch(Parse::NodeId node_id)
  523. -> SemIR::InstBlockId {
  524. return AddDominatedBlockAndBranchImpl<SemIR::Branch>(*this, node_id);
  525. }
  526. auto Context::AddDominatedBlockAndBranchWithArg(Parse::NodeId node_id,
  527. SemIR::InstId arg_id)
  528. -> SemIR::InstBlockId {
  529. return AddDominatedBlockAndBranchImpl<SemIR::BranchWithArg>(*this, node_id,
  530. arg_id);
  531. }
  532. auto Context::AddDominatedBlockAndBranchIf(Parse::NodeId node_id,
  533. SemIR::InstId cond_id)
  534. -> SemIR::InstBlockId {
  535. return AddDominatedBlockAndBranchImpl<SemIR::BranchIf>(*this, node_id,
  536. cond_id);
  537. }
  538. auto Context::AddConvergenceBlockAndPush(Parse::NodeId node_id, int num_blocks)
  539. -> void {
  540. CARBON_CHECK(num_blocks >= 2, "no convergence");
  541. SemIR::InstBlockId new_block_id = SemIR::InstBlockId::Unreachable;
  542. for ([[maybe_unused]] auto _ : llvm::seq(num_blocks)) {
  543. if (inst_block_stack().is_current_block_reachable()) {
  544. if (new_block_id == SemIR::InstBlockId::Unreachable) {
  545. new_block_id = inst_blocks().AddDefaultValue();
  546. }
  547. AddInst<SemIR::Branch>(node_id, {.target_id = new_block_id});
  548. }
  549. inst_block_stack().Pop();
  550. }
  551. inst_block_stack().Push(new_block_id);
  552. }
  553. auto Context::AddConvergenceBlockWithArgAndPush(
  554. Parse::NodeId node_id, std::initializer_list<SemIR::InstId> block_args)
  555. -> SemIR::InstId {
  556. CARBON_CHECK(block_args.size() >= 2, "no convergence");
  557. SemIR::InstBlockId new_block_id = SemIR::InstBlockId::Unreachable;
  558. for (auto arg_id : block_args) {
  559. if (inst_block_stack().is_current_block_reachable()) {
  560. if (new_block_id == SemIR::InstBlockId::Unreachable) {
  561. new_block_id = inst_blocks().AddDefaultValue();
  562. }
  563. AddInst<SemIR::BranchWithArg>(
  564. node_id, {.target_id = new_block_id, .arg_id = arg_id});
  565. }
  566. inst_block_stack().Pop();
  567. }
  568. inst_block_stack().Push(new_block_id);
  569. // Acquire the result value.
  570. SemIR::TypeId result_type_id = insts().Get(*block_args.begin()).type_id();
  571. return AddInst<SemIR::BlockArg>(
  572. node_id, {.type_id = result_type_id, .block_id = new_block_id});
  573. }
  574. auto Context::SetBlockArgResultBeforeConstantUse(SemIR::InstId select_id,
  575. SemIR::InstId cond_id,
  576. SemIR::InstId if_true,
  577. SemIR::InstId if_false)
  578. -> void {
  579. CARBON_CHECK(insts().Is<SemIR::BlockArg>(select_id));
  580. // Determine the constant result based on the condition value.
  581. SemIR::ConstantId const_id = SemIR::ConstantId::NotConstant;
  582. auto cond_const_id = constant_values().Get(cond_id);
  583. if (!cond_const_id.is_template()) {
  584. // Symbolic or non-constant condition means a non-constant result.
  585. } else if (auto literal = insts().TryGetAs<SemIR::BoolLiteral>(
  586. constant_values().GetInstId(cond_const_id))) {
  587. const_id = constant_values().Get(literal.value().value.ToBool() ? if_true
  588. : if_false);
  589. } else {
  590. CARBON_CHECK(cond_const_id == SemIR::ConstantId::Error,
  591. "Unexpected constant branch condition.");
  592. const_id = SemIR::ConstantId::Error;
  593. }
  594. if (const_id.is_constant()) {
  595. CARBON_VLOG("Constant: {0} -> {1}\n", insts().Get(select_id),
  596. constant_values().GetInstId(const_id));
  597. constant_values().Set(select_id, const_id);
  598. }
  599. }
  600. auto Context::AddCurrentCodeBlockToFunction(Parse::NodeId node_id) -> void {
  601. CARBON_CHECK(!inst_block_stack().empty(), "no current code block");
  602. if (return_scope_stack().empty()) {
  603. CARBON_CHECK(node_id.is_valid(),
  604. "No current function, but node_id not provided");
  605. TODO(node_id,
  606. "Control flow expressions are currently only supported inside "
  607. "functions.");
  608. return;
  609. }
  610. if (!inst_block_stack().is_current_block_reachable()) {
  611. // Don't include unreachable blocks in the function.
  612. return;
  613. }
  614. auto function_id =
  615. insts()
  616. .GetAs<SemIR::FunctionDecl>(return_scope_stack().back().decl_id)
  617. .function_id;
  618. functions()
  619. .Get(function_id)
  620. .body_block_ids.push_back(inst_block_stack().PeekOrAdd());
  621. }
  622. auto Context::is_current_position_reachable() -> bool {
  623. if (!inst_block_stack().is_current_block_reachable()) {
  624. return false;
  625. }
  626. // Our current position is at the end of a reachable block. That position is
  627. // reachable unless the previous instruction is a terminator instruction.
  628. auto block_contents = inst_block_stack().PeekCurrentBlockContents();
  629. if (block_contents.empty()) {
  630. return true;
  631. }
  632. const auto& last_inst = insts().Get(block_contents.back());
  633. return last_inst.kind().terminator_kind() !=
  634. SemIR::TerminatorKind::Terminator;
  635. }
  636. auto Context::Finalize() -> void {
  637. // Pop information for the file-level scope.
  638. sem_ir().set_top_inst_block_id(inst_block_stack().Pop());
  639. scope_stack().Pop();
  640. // Finalizes the list of exports on the IR.
  641. inst_blocks().Set(SemIR::InstBlockId::Exports, exports_);
  642. // Finalizes the ImportRef inst block.
  643. inst_blocks().Set(SemIR::InstBlockId::ImportRefs, import_ref_ids_);
  644. // Finalizes __global_init.
  645. global_init_.Finalize();
  646. }
  647. namespace {
  648. // Worklist-based type completion mechanism.
  649. //
  650. // When attempting to complete a type, we may find other types that also need to
  651. // be completed: types nested within that type, and the value representation of
  652. // the type. In order to complete a type without recursing arbitrarily deeply,
  653. // we use a worklist of tasks:
  654. //
  655. // - An `AddNestedIncompleteTypes` step adds a task for all incomplete types
  656. // nested within a type to the work list.
  657. // - A `BuildValueRepr` step computes the value representation for a
  658. // type, once all of its nested types are complete, and marks the type as
  659. // complete.
  660. class TypeCompleter {
  661. public:
  662. TypeCompleter(Context& context, Context::BuildDiagnosticFn diagnoser)
  663. : context_(context), diagnoser_(diagnoser) {}
  664. // Attempts to complete the given type. Returns true if it is now complete,
  665. // false if it could not be completed.
  666. auto Complete(SemIR::TypeId type_id) -> bool {
  667. Push(type_id);
  668. while (!work_list_.empty()) {
  669. if (!ProcessStep()) {
  670. return false;
  671. }
  672. }
  673. return true;
  674. }
  675. private:
  676. // Adds `type_id` to the work list, if it's not already complete.
  677. auto Push(SemIR::TypeId type_id) -> void {
  678. if (!context_.types().IsComplete(type_id)) {
  679. work_list_.push_back(
  680. {.type_id = type_id, .phase = Phase::AddNestedIncompleteTypes});
  681. }
  682. }
  683. // Runs the next step.
  684. auto ProcessStep() -> bool {
  685. auto [type_id, phase] = work_list_.back();
  686. // We might have enqueued the same type more than once. Just skip the
  687. // type if it's already complete.
  688. if (context_.types().IsComplete(type_id)) {
  689. work_list_.pop_back();
  690. return true;
  691. }
  692. auto inst_id = context_.types().GetInstId(type_id);
  693. auto inst = context_.insts().Get(inst_id);
  694. auto old_work_list_size = work_list_.size();
  695. switch (phase) {
  696. case Phase::AddNestedIncompleteTypes:
  697. if (!AddNestedIncompleteTypes(inst)) {
  698. return false;
  699. }
  700. CARBON_CHECK(work_list_.size() >= old_work_list_size,
  701. "AddNestedIncompleteTypes should not remove work items");
  702. work_list_[old_work_list_size - 1].phase = Phase::BuildValueRepr;
  703. break;
  704. case Phase::BuildValueRepr: {
  705. auto value_rep = BuildValueRepr(type_id, inst);
  706. context_.types().SetValueRepr(type_id, value_rep);
  707. CARBON_CHECK(old_work_list_size == work_list_.size(),
  708. "BuildValueRepr should not change work items");
  709. work_list_.pop_back();
  710. // Also complete the value representation type, if necessary. This
  711. // should never fail: the value representation shouldn't require any
  712. // additional nested types to be complete.
  713. if (!context_.types().IsComplete(value_rep.type_id)) {
  714. work_list_.push_back(
  715. {.type_id = value_rep.type_id, .phase = Phase::BuildValueRepr});
  716. }
  717. // For a pointer representation, the pointee also needs to be complete.
  718. if (value_rep.kind == SemIR::ValueRepr::Pointer) {
  719. if (value_rep.type_id == SemIR::TypeId::Error) {
  720. break;
  721. }
  722. auto pointee_type_id =
  723. context_.sem_ir().GetPointeeType(value_rep.type_id);
  724. if (!context_.types().IsComplete(pointee_type_id)) {
  725. work_list_.push_back(
  726. {.type_id = pointee_type_id, .phase = Phase::BuildValueRepr});
  727. }
  728. }
  729. break;
  730. }
  731. }
  732. return true;
  733. }
  734. // Adds any types nested within `type_inst` that need to be complete for
  735. // `type_inst` to be complete to our work list.
  736. auto AddNestedIncompleteTypes(SemIR::Inst type_inst) -> bool {
  737. CARBON_KIND_SWITCH(type_inst) {
  738. case CARBON_KIND(SemIR::ArrayType inst): {
  739. Push(inst.element_type_id);
  740. break;
  741. }
  742. case CARBON_KIND(SemIR::StructType inst): {
  743. for (auto field_id : context_.inst_blocks().Get(inst.fields_id)) {
  744. Push(context_.insts()
  745. .GetAs<SemIR::StructTypeField>(field_id)
  746. .field_type_id);
  747. }
  748. break;
  749. }
  750. case CARBON_KIND(SemIR::TupleType inst): {
  751. for (auto element_type_id :
  752. context_.type_blocks().Get(inst.elements_id)) {
  753. Push(element_type_id);
  754. }
  755. break;
  756. }
  757. case CARBON_KIND(SemIR::ClassType inst): {
  758. auto& class_info = context_.classes().Get(inst.class_id);
  759. if (!class_info.is_defined()) {
  760. if (diagnoser_) {
  761. auto builder = diagnoser_();
  762. context_.NoteIncompleteClass(inst.class_id, builder);
  763. builder.Emit();
  764. }
  765. return false;
  766. }
  767. if (inst.specific_id.is_valid()) {
  768. ResolveSpecificDefinition(context_, inst.specific_id);
  769. }
  770. Push(class_info.GetObjectRepr(context_.sem_ir(), inst.specific_id));
  771. break;
  772. }
  773. case CARBON_KIND(SemIR::ConstType inst): {
  774. Push(inst.inner_id);
  775. break;
  776. }
  777. default:
  778. break;
  779. }
  780. return true;
  781. }
  782. // Makes an empty value representation, which is used for types that have no
  783. // state, such as empty structs and tuples.
  784. auto MakeEmptyValueRepr() const -> SemIR::ValueRepr {
  785. return {.kind = SemIR::ValueRepr::None,
  786. .type_id = context_.GetTupleType({})};
  787. }
  788. // Makes a value representation that uses pass-by-copy, copying the given
  789. // type.
  790. auto MakeCopyValueRepr(SemIR::TypeId rep_id,
  791. SemIR::ValueRepr::AggregateKind aggregate_kind =
  792. SemIR::ValueRepr::NotAggregate) const
  793. -> SemIR::ValueRepr {
  794. return {.kind = SemIR::ValueRepr::Copy,
  795. .aggregate_kind = aggregate_kind,
  796. .type_id = rep_id};
  797. }
  798. // Makes a value representation that uses pass-by-address with the given
  799. // pointee type.
  800. auto MakePointerValueRepr(SemIR::TypeId pointee_id,
  801. SemIR::ValueRepr::AggregateKind aggregate_kind =
  802. SemIR::ValueRepr::NotAggregate) const
  803. -> SemIR::ValueRepr {
  804. // TODO: Should we add `const` qualification to `pointee_id`?
  805. return {.kind = SemIR::ValueRepr::Pointer,
  806. .aggregate_kind = aggregate_kind,
  807. .type_id = context_.GetPointerType(pointee_id)};
  808. }
  809. // Gets the value representation of a nested type, which should already be
  810. // complete.
  811. auto GetNestedValueRepr(SemIR::TypeId nested_type_id) const {
  812. CARBON_CHECK(context_.types().IsComplete(nested_type_id),
  813. "Nested type should already be complete");
  814. auto value_rep = context_.types().GetValueRepr(nested_type_id);
  815. CARBON_CHECK(value_rep.kind != SemIR::ValueRepr::Unknown,
  816. "Complete type should have a value representation");
  817. return value_rep;
  818. }
  819. auto BuildValueReprForInst(SemIR::TypeId type_id,
  820. SemIR::BuiltinInst builtin) const
  821. -> SemIR::ValueRepr {
  822. switch (builtin.builtin_inst_kind) {
  823. case SemIR::BuiltinInstKind::TypeType:
  824. case SemIR::BuiltinInstKind::AutoType:
  825. case SemIR::BuiltinInstKind::Error:
  826. case SemIR::BuiltinInstKind::Invalid:
  827. case SemIR::BuiltinInstKind::BoolType:
  828. case SemIR::BuiltinInstKind::IntLiteralType:
  829. case SemIR::BuiltinInstKind::IntType:
  830. case SemIR::BuiltinInstKind::FloatType:
  831. case SemIR::BuiltinInstKind::NamespaceType:
  832. case SemIR::BuiltinInstKind::BoundMethodType:
  833. case SemIR::BuiltinInstKind::WitnessType:
  834. case SemIR::BuiltinInstKind::SpecificFunctionType:
  835. case SemIR::BuiltinInstKind::VtableType:
  836. return MakeCopyValueRepr(type_id);
  837. case SemIR::BuiltinInstKind::StringType:
  838. // TODO: Decide on string value semantics. This should probably be a
  839. // custom value representation carrying a pointer and size or
  840. // similar.
  841. return MakePointerValueRepr(type_id);
  842. }
  843. llvm_unreachable("All builtin kinds were handled above");
  844. }
  845. auto BuildStructOrTupleValueRepr(std::size_t num_elements,
  846. SemIR::TypeId elementwise_rep,
  847. bool same_as_object_rep) const
  848. -> SemIR::ValueRepr {
  849. SemIR::ValueRepr::AggregateKind aggregate_kind =
  850. same_as_object_rep ? SemIR::ValueRepr::ValueAndObjectAggregate
  851. : SemIR::ValueRepr::ValueAggregate;
  852. if (num_elements == 1) {
  853. // The value representation for a struct or tuple with a single element
  854. // is a struct or tuple containing the value representation of the
  855. // element.
  856. // TODO: Consider doing the same whenever `elementwise_rep` is
  857. // sufficiently small.
  858. return MakeCopyValueRepr(elementwise_rep, aggregate_kind);
  859. }
  860. // For a struct or tuple with multiple fields, we use a pointer
  861. // to the elementwise value representation.
  862. return MakePointerValueRepr(elementwise_rep, aggregate_kind);
  863. }
  864. auto BuildValueReprForInst(SemIR::TypeId type_id,
  865. SemIR::StructType struct_type) const
  866. -> SemIR::ValueRepr {
  867. // TODO: Share more code with tuples.
  868. auto fields = context_.inst_blocks().Get(struct_type.fields_id);
  869. if (fields.empty()) {
  870. return MakeEmptyValueRepr();
  871. }
  872. // Find the value representation for each field, and construct a struct
  873. // of value representations.
  874. llvm::SmallVector<SemIR::InstId> value_rep_fields;
  875. value_rep_fields.reserve(fields.size());
  876. bool same_as_object_rep = true;
  877. for (auto field_id : fields) {
  878. auto field = context_.insts().GetAs<SemIR::StructTypeField>(field_id);
  879. auto field_value_rep = GetNestedValueRepr(field.field_type_id);
  880. if (field_value_rep.type_id != field.field_type_id) {
  881. same_as_object_rep = false;
  882. field.field_type_id = field_value_rep.type_id;
  883. field_id = context_.constant_values().GetInstId(
  884. TryEvalInst(context_, SemIR::InstId::Invalid, field));
  885. }
  886. value_rep_fields.push_back(field_id);
  887. }
  888. auto value_rep = same_as_object_rep
  889. ? type_id
  890. : context_.GetStructType(
  891. context_.inst_blocks().Add(value_rep_fields));
  892. return BuildStructOrTupleValueRepr(fields.size(), value_rep,
  893. same_as_object_rep);
  894. }
  895. auto BuildValueReprForInst(SemIR::TypeId type_id,
  896. SemIR::TupleType tuple_type) const
  897. -> SemIR::ValueRepr {
  898. // TODO: Share more code with structs.
  899. auto elements = context_.type_blocks().Get(tuple_type.elements_id);
  900. if (elements.empty()) {
  901. return MakeEmptyValueRepr();
  902. }
  903. // Find the value representation for each element, and construct a tuple
  904. // of value representations.
  905. llvm::SmallVector<SemIR::TypeId> value_rep_elements;
  906. value_rep_elements.reserve(elements.size());
  907. bool same_as_object_rep = true;
  908. for (auto element_type_id : elements) {
  909. auto element_value_rep = GetNestedValueRepr(element_type_id);
  910. if (element_value_rep.type_id != element_type_id) {
  911. same_as_object_rep = false;
  912. }
  913. value_rep_elements.push_back(element_value_rep.type_id);
  914. }
  915. auto value_rep = same_as_object_rep
  916. ? type_id
  917. : context_.GetTupleType(value_rep_elements);
  918. return BuildStructOrTupleValueRepr(elements.size(), value_rep,
  919. same_as_object_rep);
  920. }
  921. auto BuildValueReprForInst(SemIR::TypeId type_id,
  922. SemIR::ArrayType /*inst*/) const
  923. -> SemIR::ValueRepr {
  924. // For arrays, it's convenient to always use a pointer representation,
  925. // even when the array has zero or one element, in order to support
  926. // indexing.
  927. return MakePointerValueRepr(type_id, SemIR::ValueRepr::ObjectAggregate);
  928. }
  929. auto BuildValueReprForInst(SemIR::TypeId /*type_id*/,
  930. SemIR::ClassType inst) const -> SemIR::ValueRepr {
  931. auto& class_info = context_.classes().Get(inst.class_id);
  932. // The value representation of an adapter is the value representation of
  933. // its adapted type.
  934. if (class_info.adapt_id.is_valid()) {
  935. return GetNestedValueRepr(SemIR::GetTypeInSpecific(
  936. context_.sem_ir(), inst.specific_id,
  937. context_.insts()
  938. .GetAs<SemIR::AdaptDecl>(class_info.adapt_id)
  939. .adapted_type_id));
  940. }
  941. // Otherwise, the value representation for a class is a pointer to the
  942. // object representation.
  943. // TODO: Support customized value representations for classes.
  944. // TODO: Pick a better value representation when possible.
  945. return MakePointerValueRepr(
  946. class_info.GetObjectRepr(context_.sem_ir(), inst.specific_id),
  947. SemIR::ValueRepr::ObjectAggregate);
  948. }
  949. template <typename InstT>
  950. requires(
  951. InstT::Kind
  952. .template IsAnyOf<SemIR::AssociatedEntityType, SemIR::FacetType,
  953. SemIR::FunctionType, SemIR::GenericClassType,
  954. SemIR::GenericInterfaceType, SemIR::InterfaceType,
  955. SemIR::UnboundElementType, SemIR::WhereExpr>())
  956. auto BuildValueReprForInst(SemIR::TypeId /*type_id*/, InstT /*inst*/) const
  957. -> SemIR::ValueRepr {
  958. // These types have no runtime operations, so we use an empty value
  959. // representation.
  960. //
  961. // TODO: There is information we could model here:
  962. // - For an interface, we could use a witness.
  963. // - For an associated entity, we could use an index into the witness.
  964. // - For an unbound element, we could use an index or offset.
  965. return MakeEmptyValueRepr();
  966. }
  967. template <typename InstT>
  968. requires(InstT::Kind.template IsAnyOf<SemIR::BindSymbolicName,
  969. SemIR::InterfaceWitnessAccess>())
  970. auto BuildValueReprForInst(SemIR::TypeId type_id, InstT /*inst*/) const
  971. -> SemIR::ValueRepr {
  972. // For symbolic types, we arbitrarily pick a copy representation.
  973. return MakeCopyValueRepr(type_id);
  974. }
  975. template <typename InstT>
  976. requires(InstT::Kind.template IsAnyOf<SemIR::FloatType, SemIR::IntType,
  977. SemIR::PointerType>())
  978. auto BuildValueReprForInst(SemIR::TypeId type_id, InstT /*inst*/) const
  979. -> SemIR::ValueRepr {
  980. return MakeCopyValueRepr(type_id);
  981. }
  982. auto BuildValueReprForInst(SemIR::TypeId /*type_id*/,
  983. SemIR::ConstType inst) const -> SemIR::ValueRepr {
  984. // The value representation of `const T` is the same as that of `T`.
  985. // Objects are not modifiable through their value representations.
  986. return GetNestedValueRepr(inst.inner_id);
  987. }
  988. template <typename InstT>
  989. requires(InstT::Kind.is_type() == SemIR::InstIsType::Never)
  990. auto BuildValueReprForInst(SemIR::TypeId /*type_id*/, InstT inst) const
  991. -> SemIR::ValueRepr {
  992. CARBON_FATAL("Type refers to non-type inst {0}", inst);
  993. }
  994. // Builds and returns the value representation for the given type. All nested
  995. // types, as found by AddNestedIncompleteTypes, are known to be complete.
  996. auto BuildValueRepr(SemIR::TypeId type_id, SemIR::Inst inst) const
  997. -> SemIR::ValueRepr {
  998. // Use overload resolution to select the implementation, producing compile
  999. // errors when BuildValueReprForInst isn't defined for a given instruction.
  1000. CARBON_KIND_SWITCH(inst) {
  1001. #define CARBON_SEM_IR_INST_KIND(Name) \
  1002. case CARBON_KIND(SemIR::Name typed_inst): { \
  1003. return BuildValueReprForInst(type_id, typed_inst); \
  1004. }
  1005. #include "toolchain/sem_ir/inst_kind.def"
  1006. }
  1007. }
  1008. enum class Phase : int8_t {
  1009. // The next step is to add nested types to the list of types to complete.
  1010. AddNestedIncompleteTypes,
  1011. // The next step is to build the value representation for the type.
  1012. BuildValueRepr,
  1013. };
  1014. struct WorkItem {
  1015. SemIR::TypeId type_id;
  1016. Phase phase;
  1017. };
  1018. Context& context_;
  1019. llvm::SmallVector<WorkItem> work_list_;
  1020. Context::BuildDiagnosticFn diagnoser_;
  1021. };
  1022. } // namespace
  1023. auto Context::TryToCompleteType(SemIR::TypeId type_id,
  1024. BuildDiagnosticFn diagnoser,
  1025. BuildDiagnosticFn abstract_diagnoser) -> bool {
  1026. if (!TypeCompleter(*this, diagnoser).Complete(type_id)) {
  1027. return false;
  1028. }
  1029. if (!abstract_diagnoser) {
  1030. return true;
  1031. }
  1032. if (auto class_type = types().TryGetAs<SemIR::ClassType>(type_id)) {
  1033. auto& class_info = classes().Get(class_type->class_id);
  1034. if (class_info.inheritance_kind !=
  1035. SemIR::Class::InheritanceKind::Abstract) {
  1036. return true;
  1037. }
  1038. auto builder = abstract_diagnoser();
  1039. if (!builder) {
  1040. return false;
  1041. }
  1042. NoteAbstractClass(class_type->class_id, builder);
  1043. builder.Emit();
  1044. return false;
  1045. }
  1046. return true;
  1047. }
  1048. auto Context::TryToDefineType(SemIR::TypeId type_id,
  1049. BuildDiagnosticFn diagnoser) -> bool {
  1050. if (!TryToCompleteType(type_id, diagnoser)) {
  1051. return false;
  1052. }
  1053. if (auto interface = types().TryGetAs<SemIR::InterfaceType>(type_id)) {
  1054. auto interface_id = interface->interface_id;
  1055. if (!interfaces().Get(interface_id).is_defined()) {
  1056. auto builder = diagnoser();
  1057. NoteUndefinedInterface(interface_id, builder);
  1058. builder.Emit();
  1059. return false;
  1060. }
  1061. if (interface->specific_id.is_valid()) {
  1062. ResolveSpecificDefinition(*this, interface->specific_id);
  1063. }
  1064. }
  1065. return true;
  1066. }
  1067. auto Context::GetTypeIdForTypeConstant(SemIR::ConstantId constant_id)
  1068. -> SemIR::TypeId {
  1069. CARBON_CHECK(constant_id.is_constant(),
  1070. "Canonicalizing non-constant type: {0}", constant_id);
  1071. auto type_id =
  1072. insts().Get(constant_values().GetInstId(constant_id)).type_id();
  1073. // TODO: For now, we allow values of facet type to be used as types.
  1074. CARBON_CHECK(IsFacetType(type_id) || constant_id == SemIR::ConstantId::Error,
  1075. "Forming type ID for non-type constant of type {0}",
  1076. types().GetAsInst(type_id));
  1077. return SemIR::TypeId::ForTypeConstant(constant_id);
  1078. }
  1079. // Gets or forms a type_id for a type, given the instruction kind and arguments.
  1080. template <typename InstT, typename... EachArgT>
  1081. static auto GetTypeImpl(Context& context, EachArgT... each_arg)
  1082. -> SemIR::TypeId {
  1083. // TODO: Remove inst_id parameter from TryEvalInst.
  1084. InstT inst = {SemIR::TypeId::TypeType, each_arg...};
  1085. return context.GetTypeIdForTypeConstant(
  1086. TryEvalInst(context, SemIR::InstId::Invalid, inst));
  1087. }
  1088. // Gets or forms a type_id for a type, given the instruction kind and arguments,
  1089. // and completes the type. This should only be used when type completion cannot
  1090. // fail.
  1091. template <typename InstT, typename... EachArgT>
  1092. static auto GetCompleteTypeImpl(Context& context, EachArgT... each_arg)
  1093. -> SemIR::TypeId {
  1094. auto type_id = GetTypeImpl<InstT>(context, each_arg...);
  1095. bool complete = context.TryToCompleteType(type_id);
  1096. CARBON_CHECK(complete, "Type completion should not fail");
  1097. return type_id;
  1098. }
  1099. auto Context::GetStructType(SemIR::InstBlockId refs_id) -> SemIR::TypeId {
  1100. return GetTypeImpl<SemIR::StructType>(*this, refs_id);
  1101. }
  1102. auto Context::GetTupleType(llvm::ArrayRef<SemIR::TypeId> type_ids)
  1103. -> SemIR::TypeId {
  1104. return GetTypeImpl<SemIR::TupleType>(*this,
  1105. type_blocks().AddCanonical(type_ids));
  1106. }
  1107. auto Context::GetAssociatedEntityType(SemIR::TypeId interface_type_id,
  1108. SemIR::TypeId entity_type_id)
  1109. -> SemIR::TypeId {
  1110. return GetTypeImpl<SemIR::AssociatedEntityType>(*this, interface_type_id,
  1111. entity_type_id);
  1112. }
  1113. auto Context::GetBuiltinType(SemIR::BuiltinInstKind kind) -> SemIR::TypeId {
  1114. CARBON_CHECK(kind != SemIR::BuiltinInstKind::Invalid);
  1115. auto type_id = GetTypeIdForTypeInst(SemIR::InstId::ForBuiltin(kind));
  1116. // To keep client code simpler, complete builtin types before returning them.
  1117. bool complete = TryToCompleteType(type_id);
  1118. CARBON_CHECK(complete, "Failed to complete builtin type");
  1119. return type_id;
  1120. }
  1121. auto Context::GetFunctionType(SemIR::FunctionId fn_id,
  1122. SemIR::SpecificId specific_id) -> SemIR::TypeId {
  1123. return GetCompleteTypeImpl<SemIR::FunctionType>(*this, fn_id, specific_id);
  1124. }
  1125. auto Context::GetGenericClassType(SemIR::ClassId class_id,
  1126. SemIR::SpecificId enclosing_specific_id)
  1127. -> SemIR::TypeId {
  1128. return GetCompleteTypeImpl<SemIR::GenericClassType>(*this, class_id,
  1129. enclosing_specific_id);
  1130. }
  1131. auto Context::GetGenericInterfaceType(SemIR::InterfaceId interface_id,
  1132. SemIR::SpecificId enclosing_specific_id)
  1133. -> SemIR::TypeId {
  1134. return GetCompleteTypeImpl<SemIR::GenericInterfaceType>(
  1135. *this, interface_id, enclosing_specific_id);
  1136. }
  1137. auto Context::GetPointerType(SemIR::TypeId pointee_type_id) -> SemIR::TypeId {
  1138. return GetTypeImpl<SemIR::PointerType>(*this, pointee_type_id);
  1139. }
  1140. auto Context::GetUnboundElementType(SemIR::TypeId class_type_id,
  1141. SemIR::TypeId element_type_id)
  1142. -> SemIR::TypeId {
  1143. return GetTypeImpl<SemIR::UnboundElementType>(*this, class_type_id,
  1144. element_type_id);
  1145. }
  1146. auto Context::GetUnqualifiedType(SemIR::TypeId type_id) -> SemIR::TypeId {
  1147. if (auto const_type = types().TryGetAs<SemIR::ConstType>(type_id)) {
  1148. return const_type->inner_id;
  1149. }
  1150. return type_id;
  1151. }
  1152. auto Context::PrintForStackDump(llvm::raw_ostream& output) const -> void {
  1153. output << "Check::Context\n";
  1154. // In a stack dump, this is probably indented by a tab. We treat that as 8
  1155. // spaces then add a couple to indent past the Context label.
  1156. constexpr int Indent = 10;
  1157. SemIR::Formatter formatter(*tokens_, *parse_tree_, *sem_ir_);
  1158. node_stack_.PrintForStackDump(formatter, Indent, output);
  1159. inst_block_stack_.PrintForStackDump(formatter, Indent, output);
  1160. pattern_block_stack_.PrintForStackDump(formatter, Indent, output);
  1161. param_and_arg_refs_stack_.PrintForStackDump(formatter, Indent, output);
  1162. args_type_info_stack_.PrintForStackDump(formatter, Indent, output);
  1163. }
  1164. auto Context::DumpFormattedFile() const -> void {
  1165. SemIR::Formatter formatter(*tokens_, *parse_tree_, *sem_ir_);
  1166. formatter.Print(llvm::errs());
  1167. }
  1168. } // namespace Carbon::Check