context.cpp 54 KB

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