member_access.cpp 34 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770
  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/member_access.h"
  5. #include <optional>
  6. #include "llvm/ADT/STLExtras.h"
  7. #include "toolchain/base/kind_switch.h"
  8. #include "toolchain/check/action.h"
  9. #include "toolchain/check/context.h"
  10. #include "toolchain/check/convert.h"
  11. #include "toolchain/check/eval.h"
  12. #include "toolchain/check/impl_lookup.h"
  13. #include "toolchain/check/import_ref.h"
  14. #include "toolchain/check/interface.h"
  15. #include "toolchain/check/name_lookup.h"
  16. #include "toolchain/check/type.h"
  17. #include "toolchain/check/type_completion.h"
  18. #include "toolchain/diagnostics/diagnostic_emitter.h"
  19. #include "toolchain/sem_ir/expr_info.h"
  20. #include "toolchain/sem_ir/function.h"
  21. #include "toolchain/sem_ir/generic.h"
  22. #include "toolchain/sem_ir/ids.h"
  23. #include "toolchain/sem_ir/inst.h"
  24. #include "toolchain/sem_ir/name_scope.h"
  25. #include "toolchain/sem_ir/typed_insts.h"
  26. namespace Carbon::Check {
  27. // Returns the index of the specified class element within the class's
  28. // representation.
  29. static auto GetClassElementIndex(Context& context, SemIR::InstId element_id)
  30. -> SemIR::ElementIndex {
  31. auto element_inst = context.insts().Get(element_id);
  32. if (auto field = element_inst.TryAs<SemIR::FieldDecl>()) {
  33. return field->index;
  34. }
  35. if (auto base = element_inst.TryAs<SemIR::BaseDecl>()) {
  36. return base->index;
  37. }
  38. CARBON_FATAL("Unexpected value {0} in class element name", element_inst);
  39. }
  40. // Returns whether `function_id` is an instance method, that is, whether it has
  41. // an implicit `self` parameter.
  42. static auto IsInstanceMethod(const SemIR::File& sem_ir,
  43. SemIR::FunctionId function_id) -> bool {
  44. const auto& function = sem_ir.functions().Get(function_id);
  45. return function.self_param_id.has_value();
  46. }
  47. // Return whether `type_id`, the type of an associated entity, is for an
  48. // instance member (currently true only for instance methods).
  49. static auto IsInstanceType(Context& context, SemIR::TypeId type_id) -> bool {
  50. if (auto function_type =
  51. context.types().TryGetAs<SemIR::FunctionType>(type_id)) {
  52. return IsInstanceMethod(context.sem_ir(), function_type->function_id);
  53. }
  54. return false;
  55. }
  56. // Returns the highest allowed access. For example, if this returns `Protected`
  57. // then only `Public` and `Protected` accesses are allowed--not `Private`.
  58. static auto GetHighestAllowedAccess(Context& context, SemIR::LocId loc_id,
  59. SemIR::ConstantId name_scope_const_id)
  60. -> SemIR::AccessKind {
  61. SemIR::ScopeLookupResult lookup_result =
  62. LookupUnqualifiedName(context, loc_id.node_id(), SemIR::NameId::SelfType,
  63. /*required=*/false)
  64. .scope_result;
  65. CARBON_CHECK(!lookup_result.is_poisoned());
  66. if (!lookup_result.is_found()) {
  67. return SemIR::AccessKind::Public;
  68. }
  69. // TODO: Support other types for `Self`.
  70. auto self_class_type = context.insts().TryGetAs<SemIR::ClassType>(
  71. lookup_result.target_inst_id());
  72. if (!self_class_type) {
  73. return SemIR::AccessKind::Public;
  74. }
  75. auto self_class_info = context.classes().Get(self_class_type->class_id);
  76. // TODO: Support other types.
  77. if (auto class_type = context.insts().TryGetAs<SemIR::ClassType>(
  78. context.constant_values().GetInstId(name_scope_const_id))) {
  79. auto class_info = context.classes().Get(class_type->class_id);
  80. if (self_class_info.self_type_id == class_info.self_type_id) {
  81. return SemIR::AccessKind::Private;
  82. }
  83. // If the `type_id` of `Self` does not match with the one we're currently
  84. // accessing, try checking if this class is of the parent type of `Self`.
  85. if (auto base_type_id = self_class_info.GetBaseType(
  86. context.sem_ir(), self_class_type->specific_id);
  87. base_type_id.has_value()) {
  88. if (context.types().GetConstantId(base_type_id) == name_scope_const_id) {
  89. return SemIR::AccessKind::Protected;
  90. }
  91. // TODO: Also check whether this base class has a base class of its own.
  92. } else if (auto adapt_type_id = self_class_info.GetAdaptedType(
  93. context.sem_ir(), self_class_type->specific_id);
  94. adapt_type_id.has_value()) {
  95. if (context.types().GetConstantId(adapt_type_id) == name_scope_const_id) {
  96. // TODO: Should we be allowed to access protected fields of a type we
  97. // are adapting? The design doesn't allow this.
  98. return SemIR::AccessKind::Protected;
  99. }
  100. }
  101. }
  102. return SemIR::AccessKind::Public;
  103. }
  104. // Returns whether `scope` is a scope for which impl lookup should be performed
  105. // if we find an associated entity.
  106. static auto ScopeNeedsImplLookup(Context& context,
  107. SemIR::ConstantId name_scope_const_id)
  108. -> bool {
  109. SemIR::InstId inst_id =
  110. context.constant_values().GetInstId(name_scope_const_id);
  111. CARBON_CHECK(inst_id.has_value());
  112. SemIR::Inst inst = context.insts().Get(inst_id);
  113. if (inst.Is<SemIR::FacetType>()) {
  114. // Don't perform impl lookup if an associated entity is named as a member of
  115. // a facet type.
  116. return false;
  117. }
  118. if (inst.Is<SemIR::Namespace>()) {
  119. // Don't perform impl lookup if an associated entity is named as a namespace
  120. // member.
  121. // TODO: This case is not yet listed in the design.
  122. return false;
  123. }
  124. // Any other kind of scope is assumed to be a type that implements the
  125. // interface containing the associated entity, and impl lookup is performed.
  126. return true;
  127. }
  128. static auto AccessMemberOfImplWitness(Context& context, SemIR::LocId loc_id,
  129. SemIR::TypeId self_type_id,
  130. SemIR::InstId witness_id,
  131. SemIR::SpecificId interface_specific_id,
  132. SemIR::InstId member_id)
  133. -> SemIR::InstId {
  134. auto member_value_id = context.constant_values().GetConstantInstId(member_id);
  135. if (!member_value_id.has_value()) {
  136. if (member_value_id != SemIR::ErrorInst::SingletonInstId) {
  137. context.TODO(member_id, "non-constant associated entity");
  138. }
  139. return SemIR::ErrorInst::SingletonInstId;
  140. }
  141. auto assoc_entity =
  142. context.insts().TryGetAs<SemIR::AssociatedEntity>(member_value_id);
  143. if (!assoc_entity) {
  144. context.TODO(member_id, "unexpected value for associated entity");
  145. return SemIR::ErrorInst::SingletonInstId;
  146. }
  147. // Substitute the interface specific and `Self` type into the type of the
  148. // associated entity to find the type of the member access.
  149. LoadImportRef(context, assoc_entity->decl_id);
  150. auto assoc_type_id = GetTypeForSpecificAssociatedEntity(
  151. context, loc_id, interface_specific_id, assoc_entity->decl_id,
  152. self_type_id, witness_id);
  153. return GetOrAddInst<SemIR::ImplWitnessAccess>(context, loc_id,
  154. {.type_id = assoc_type_id,
  155. .witness_id = witness_id,
  156. .index = assoc_entity->index});
  157. }
  158. // Performs impl lookup for a member name expression. This finds the relevant
  159. // impl witness and extracts the corresponding impl member.
  160. static auto PerformImplLookup(
  161. Context& context, SemIR::LocId loc_id, SemIR::ConstantId type_const_id,
  162. SemIR::AssociatedEntityType assoc_type, SemIR::InstId member_id,
  163. MakeDiagnosticBuilderFn missing_impl_diagnoser = nullptr) -> SemIR::InstId {
  164. auto self_type_id = context.types().GetTypeIdForTypeConstantId(type_const_id);
  165. // TODO: Avoid forming and then immediately decomposing a `FacetType` here.
  166. auto interface_type_id = GetInterfaceType(context, assoc_type.interface_id,
  167. assoc_type.interface_specific_id);
  168. auto lookup_result = LookupImplWitness(context, loc_id, type_const_id,
  169. interface_type_id.AsConstantId());
  170. if (!lookup_result.has_value()) {
  171. if (missing_impl_diagnoser) {
  172. // TODO: Pass in the expression whose type we are printing.
  173. CARBON_DIAGNOSTIC(MissingImplInMemberAccessNote, Note,
  174. "type {1} does not implement interface {0}",
  175. SemIR::TypeId, SemIR::TypeId);
  176. missing_impl_diagnoser()
  177. .Note(loc_id, MissingImplInMemberAccessNote, interface_type_id,
  178. self_type_id)
  179. .Emit();
  180. } else {
  181. // TODO: Pass in the expression whose type we are printing.
  182. CARBON_DIAGNOSTIC(MissingImplInMemberAccess, Error,
  183. "cannot access member of interface {0} in type {1} "
  184. "that does not implement that interface",
  185. SemIR::TypeId, SemIR::TypeId);
  186. context.emitter().Emit(loc_id, MissingImplInMemberAccess,
  187. interface_type_id, self_type_id);
  188. }
  189. return SemIR::ErrorInst::SingletonInstId;
  190. }
  191. // The query facet type given to `LookupImplWitness()` had only a single
  192. // interface in it, so the returned witness set will have the same. Convert
  193. // from the InstBlockId to the single ImplWitness instruction.
  194. auto witness_id = SemIR::InstId::None;
  195. if (lookup_result.has_error_value()) {
  196. witness_id = SemIR::ErrorInst::SingletonInstId;
  197. } else {
  198. auto witnesses = context.inst_blocks().Get(lookup_result.inst_block_id());
  199. CARBON_CHECK(witnesses.size() == 1);
  200. witness_id = witnesses[0];
  201. }
  202. return AccessMemberOfImplWitness(context, loc_id, self_type_id, witness_id,
  203. assoc_type.interface_specific_id, member_id);
  204. }
  205. // Performs a member name lookup into the specified scope, including performing
  206. // impl lookup if necessary. If the scope result is `None`, assume an error has
  207. // already been diagnosed, and return `ErrorInst`.
  208. static auto LookupMemberNameInScope(Context& context, SemIR::LocId loc_id,
  209. SemIR::InstId base_id,
  210. SemIR::NameId name_id,
  211. SemIR::ConstantId name_scope_const_id,
  212. llvm::ArrayRef<LookupScope> lookup_scopes,
  213. bool lookup_in_type_of_base, bool required)
  214. -> SemIR::InstId {
  215. AccessInfo access_info = {
  216. .constant_id = name_scope_const_id,
  217. .highest_allowed_access =
  218. GetHighestAllowedAccess(context, loc_id, name_scope_const_id),
  219. };
  220. LookupResult result = LookupQualifiedName(
  221. context, loc_id, name_id, lookup_scopes, required, access_info);
  222. if (!result.scope_result.is_found()) {
  223. return SemIR::ErrorInst::SingletonInstId;
  224. }
  225. // TODO: This duplicates the work that HandleNameAsExpr does. Factor this out.
  226. auto type_id =
  227. SemIR::GetTypeOfInstInSpecific(context.sem_ir(), result.specific_id,
  228. result.scope_result.target_inst_id());
  229. CARBON_CHECK(type_id.has_value(), "Missing type for member {0}",
  230. context.insts().Get(result.scope_result.target_inst_id()));
  231. // If the named entity has a constant value that depends on its specific,
  232. // store the specific too.
  233. if (result.specific_id.has_value() &&
  234. context.constant_values()
  235. .Get(result.scope_result.target_inst_id())
  236. .is_symbolic()) {
  237. result.scope_result = SemIR::ScopeLookupResult::MakeFound(
  238. GetOrAddInst<SemIR::SpecificConstant>(
  239. context, loc_id,
  240. {.type_id = type_id,
  241. .inst_id = result.scope_result.target_inst_id(),
  242. .specific_id = result.specific_id}),
  243. SemIR::AccessKind::Public);
  244. }
  245. // TODO: Use a different kind of instruction that also references the
  246. // `base_id` so that `SemIR` consumers can find it.
  247. auto member_id = GetOrAddInst<SemIR::NameRef>(
  248. context, loc_id,
  249. {.type_id = type_id,
  250. .name_id = name_id,
  251. .value_id = result.scope_result.target_inst_id()});
  252. // If member name lookup finds an associated entity name, and the scope is not
  253. // a facet type, perform impl lookup.
  254. //
  255. // TODO: We need to do this as part of searching extended scopes, because a
  256. // lookup that finds an associated entity and also finds the corresponding
  257. // impl member is not supposed to be treated as ambiguous.
  258. if (auto assoc_type =
  259. context.types().TryGetAs<SemIR::AssociatedEntityType>(type_id)) {
  260. if (lookup_in_type_of_base) {
  261. SemIR::TypeId base_type_id = context.insts().Get(base_id).type_id();
  262. if (auto facet_access_type =
  263. context.types().TryGetAs<SemIR::FacetAccessType>(base_type_id)) {
  264. // Move from the type of a symbolic facet value up in typish-ness to its
  265. // FacetType to find the type to work with.
  266. base_id = facet_access_type->facet_value_inst_id;
  267. base_type_id = context.insts().Get(base_id).type_id();
  268. }
  269. if (auto facet_type =
  270. context.types().TryGetAs<SemIR::FacetType>(base_type_id)) {
  271. // Handles `T.F` when `T` is a non-type facet.
  272. auto base_as_type = ExprAsType(context, loc_id, base_id);
  273. auto assoc_interface = assoc_type->GetSpecificInterface();
  274. // First look for `assoc_interface` in the type of the base. If it is
  275. // found, get the witness that the interface is implemented from
  276. // `base_id`.
  277. auto identified_id = RequireIdentifiedFacetType(context, *facet_type);
  278. const auto& identified =
  279. context.identified_facet_types().Get(identified_id);
  280. // Witness that `T` implements the `assoc_interface`.
  281. SemIR::InstId witness_inst_id = SemIR::InstId::None;
  282. for (auto [index, base_interface] :
  283. llvm::enumerate(identified.required_interfaces())) {
  284. // Get the witness that `T` implements `base_type_id`.
  285. if (base_interface == assoc_interface) {
  286. witness_inst_id = GetOrAddInst(
  287. context, loc_id,
  288. SemIR::FacetAccessWitness{
  289. .type_id = GetSingletonType(
  290. context, SemIR::WitnessType::SingletonInstId),
  291. .facet_value_inst_id = base_id,
  292. .index = SemIR::ElementIndex(index)});
  293. break;
  294. }
  295. }
  296. // TODO: If that fails, would need to do impl lookup to see if the facet
  297. // value implements the interface of `*assoc_type`.
  298. if (!witness_inst_id.has_value()) {
  299. context.TODO(member_id,
  300. "associated entity not found in facet type, need to do "
  301. "impl lookup");
  302. return SemIR::ErrorInst::SingletonInstId;
  303. }
  304. member_id = AccessMemberOfImplWitness(
  305. context, loc_id, base_as_type.type_id, witness_inst_id,
  306. assoc_interface.specific_id, member_id);
  307. } else {
  308. // Handles `x.F` if `x` is of type `class C` that extends an interface
  309. // containing `F`.
  310. SemIR::ConstantId constant_id =
  311. context.types().GetConstantId(base_type_id);
  312. member_id = PerformImplLookup(context, loc_id, constant_id, *assoc_type,
  313. member_id);
  314. }
  315. } else if (ScopeNeedsImplLookup(context, name_scope_const_id)) {
  316. // Handles `T.F` where `T` is a type extending an interface containing
  317. // `F`.
  318. member_id = PerformImplLookup(context, loc_id, name_scope_const_id,
  319. *assoc_type, member_id);
  320. }
  321. }
  322. return member_id;
  323. }
  324. // Performs the instance binding step in member access. If the found member is a
  325. // field, forms a class member access. If the found member is an instance
  326. // method, forms a bound method. Otherwise, the member is returned unchanged.
  327. static auto PerformInstanceBinding(Context& context, SemIR::LocId loc_id,
  328. SemIR::InstId base_id,
  329. SemIR::InstId member_id) -> SemIR::InstId {
  330. // If the member is a function, check whether it's an instance method.
  331. if (auto callee = SemIR::GetCalleeFunction(context.sem_ir(), member_id);
  332. callee.function_id.has_value()) {
  333. if (!IsInstanceMethod(context.sem_ir(), callee.function_id) ||
  334. callee.self_id.has_value()) {
  335. // Found a static member function or an already-bound method.
  336. return member_id;
  337. }
  338. return GetOrAddInst<SemIR::BoundMethod>(
  339. context, loc_id,
  340. {.type_id =
  341. GetSingletonType(context, SemIR::BoundMethodType::SingletonInstId),
  342. .object_id = base_id,
  343. .function_decl_id = member_id});
  344. }
  345. // Otherwise, if it's a field, form a class element access.
  346. if (auto unbound_element_type =
  347. context.types().TryGetAs<SemIR::UnboundElementType>(
  348. context.insts().Get(member_id).type_id())) {
  349. // Convert the base to the type of the element if necessary.
  350. base_id = ConvertToValueOrRefOfType(context, loc_id, base_id,
  351. unbound_element_type->class_type_id);
  352. // Find the specified element, which could be either a field or a base
  353. // class, and build an element access expression.
  354. auto element_id = context.constant_values().GetConstantInstId(member_id);
  355. CARBON_CHECK(element_id.has_value(),
  356. "Non-constant value {0} of unbound element type",
  357. context.insts().Get(member_id));
  358. auto index = GetClassElementIndex(context, element_id);
  359. auto access_id = GetOrAddInst<SemIR::ClassElementAccess>(
  360. context, loc_id,
  361. {.type_id = unbound_element_type->element_type_id,
  362. .base_id = base_id,
  363. .index = index});
  364. if (SemIR::GetExprCategory(context.sem_ir(), base_id) ==
  365. SemIR::ExprCategory::Value &&
  366. SemIR::GetExprCategory(context.sem_ir(), access_id) !=
  367. SemIR::ExprCategory::Value) {
  368. // Class element access on a value expression produces an ephemeral
  369. // reference if the class's value representation is a pointer to the
  370. // object representation. Add a value binding in that case so that the
  371. // expression category of the result matches the expression category
  372. // of the base.
  373. access_id = ConvertToValueExpr(context, access_id);
  374. }
  375. return access_id;
  376. }
  377. // Not an instance member: no instance binding.
  378. return member_id;
  379. }
  380. // Validates that the index (required to be an IntValue) is valid within the
  381. // tuple size. Returns the index on success, or nullptr on failure.
  382. static auto ValidateTupleIndex(Context& context, SemIR::LocId loc_id,
  383. SemIR::InstId operand_inst_id,
  384. SemIR::IntValue index_inst, int size)
  385. -> std::optional<llvm::APInt> {
  386. llvm::APInt index_val = context.ints().Get(index_inst.int_id);
  387. if (index_val.uge(size)) {
  388. CARBON_DIAGNOSTIC(TupleIndexOutOfBounds, Error,
  389. "tuple element index `{0}` is past the end of type {1}",
  390. TypedInt, TypeOfInstId);
  391. context.emitter().Emit(loc_id, TupleIndexOutOfBounds,
  392. {.type = index_inst.type_id, .value = index_val},
  393. operand_inst_id);
  394. return std::nullopt;
  395. }
  396. return index_val;
  397. }
  398. auto PerformMemberAccess(Context& context, SemIR::LocId loc_id,
  399. SemIR::InstId base_id, SemIR::NameId name_id,
  400. bool required) -> SemIR::InstId {
  401. // TODO: Member access for dependent member names is supposed to perform a
  402. // lookup in both the template definition context and the template
  403. // instantiation context, and reject if both succeed but find different
  404. // things.
  405. if (required) {
  406. return HandleAction<SemIR::AccessMemberAction>(
  407. context, loc_id,
  408. {.type_id = SemIR::InstType::SingletonTypeId,
  409. .base_id = base_id,
  410. .name_id = name_id});
  411. } else {
  412. return HandleAction<SemIR::AccessOptionalMemberAction>(
  413. context, loc_id,
  414. {.type_id = SemIR::InstType::SingletonTypeId,
  415. .base_id = base_id,
  416. .name_id = name_id});
  417. }
  418. }
  419. // Common logic for `AccessMemberAction` and `AccessOptionalMemberAction`.
  420. static auto PerformActionHelper(Context& context, SemIR::LocId loc_id,
  421. SemIR::InstId base_id, SemIR::NameId name_id,
  422. bool required) -> SemIR::InstId {
  423. // If the base is a name scope, such as a class or namespace, perform lookup
  424. // into that scope.
  425. if (auto base_const_id = context.constant_values().Get(base_id);
  426. base_const_id.is_constant()) {
  427. llvm::SmallVector<LookupScope> lookup_scopes;
  428. if (AppendLookupScopesForConstant(context, loc_id, base_const_id,
  429. &lookup_scopes)) {
  430. return LookupMemberNameInScope(
  431. context, loc_id, base_id, name_id, base_const_id, lookup_scopes,
  432. /*lookup_in_type_of_base=*/false, /*required=*/required);
  433. }
  434. }
  435. // If the base isn't a scope, it must have a complete type.
  436. auto base_type_id = context.insts().Get(base_id).type_id();
  437. auto base_loc_id = context.insts().GetLocId(base_id);
  438. if (!RequireCompleteType(context, base_type_id, base_loc_id, [&] {
  439. CARBON_DIAGNOSTIC(IncompleteTypeInMemberAccess, Error,
  440. "member access into object of incomplete type {0}",
  441. TypeOfInstId);
  442. return context.emitter().Build(base_id, IncompleteTypeInMemberAccess,
  443. base_id);
  444. })) {
  445. return SemIR::ErrorInst::SingletonInstId;
  446. }
  447. // Materialize a temporary for the base expression if necessary.
  448. base_id = ConvertToValueOrRefExpr(context, base_id);
  449. base_type_id = context.insts().Get(base_id).type_id();
  450. auto base_type_const_id = context.types().GetConstantId(base_type_id);
  451. // Find the scope corresponding to the base type.
  452. llvm::SmallVector<LookupScope> lookup_scopes;
  453. if (!AppendLookupScopesForConstant(context, loc_id, base_type_const_id,
  454. &lookup_scopes)) {
  455. // The base type is not a name scope. Try some fallback options.
  456. if (auto struct_type = context.insts().TryGetAs<SemIR::StructType>(
  457. context.constant_values().GetInstId(base_type_const_id))) {
  458. // TODO: Do we need to optimize this with a lookup table for O(1)?
  459. for (auto [i, field] : llvm::enumerate(
  460. context.struct_type_fields().Get(struct_type->fields_id))) {
  461. if (name_id == field.name_id) {
  462. // TODO: Model this as producing a lookup result, and do instance
  463. // binding separately. Perhaps a struct type should be a name scope.
  464. return GetOrAddInst<SemIR::StructAccess>(
  465. context, loc_id,
  466. {.type_id = field.type_id,
  467. .struct_id = base_id,
  468. .index = SemIR::ElementIndex(i)});
  469. }
  470. }
  471. if (required) {
  472. CARBON_DIAGNOSTIC(QualifiedExprNameNotFound, Error,
  473. "type {0} does not have a member `{1}`", TypeOfInstId,
  474. SemIR::NameId);
  475. context.emitter().Emit(loc_id, QualifiedExprNameNotFound, base_id,
  476. name_id);
  477. return SemIR::ErrorInst::SingletonInstId;
  478. } else {
  479. return SemIR::InstId::None;
  480. }
  481. }
  482. if (base_type_id != SemIR::ErrorInst::SingletonTypeId) {
  483. CARBON_DIAGNOSTIC(QualifiedExprUnsupported, Error,
  484. "type {0} does not support qualified expressions",
  485. TypeOfInstId);
  486. context.emitter().Emit(loc_id, QualifiedExprUnsupported, base_id);
  487. }
  488. return SemIR::ErrorInst::SingletonInstId;
  489. }
  490. // Perform lookup into the base type.
  491. auto member_id = LookupMemberNameInScope(
  492. context, loc_id, base_id, name_id, base_type_const_id, lookup_scopes,
  493. /*lookup_in_type_of_base=*/true, /*required=*/required);
  494. // For name lookup into a facet, never perform instance binding.
  495. // TODO: According to the design, this should be a "lookup in base" lookup,
  496. // not a "lookup in type of base" lookup, and the facet itself should have
  497. // member names that directly name members of the `impl`.
  498. if (context.types().IsFacetType(base_type_id)) {
  499. return member_id;
  500. }
  501. // Perform instance binding if we found an instance member.
  502. member_id = PerformInstanceBinding(context, loc_id, base_id, member_id);
  503. return member_id;
  504. }
  505. auto PerformAction(Context& context, SemIR::LocId loc_id,
  506. SemIR::AccessMemberAction action) -> SemIR::InstId {
  507. return PerformActionHelper(context, loc_id, action.base_id, action.name_id,
  508. /*required=*/true);
  509. }
  510. auto PerformAction(Context& context, SemIR::LocId loc_id,
  511. SemIR::AccessOptionalMemberAction action) -> SemIR::InstId {
  512. return PerformActionHelper(context, loc_id, action.base_id, action.name_id,
  513. /*required=*/false);
  514. }
  515. // Logic shared by GetAssociatedValue() and PerformCompoundMemberAccess().
  516. static auto GetAssociatedValueImpl(Context& context, SemIR::LocId loc_id,
  517. SemIR::InstId base_id,
  518. const SemIR::AssociatedEntity& assoc_entity,
  519. SemIR::SpecificInterface interface)
  520. -> SemIR::InstId {
  521. // Convert to the interface type of the associated member, to get a facet
  522. // value.
  523. auto interface_type_id =
  524. GetInterfaceType(context, interface.interface_id, interface.specific_id);
  525. auto facet_inst_id =
  526. ConvertToValueOfType(context, loc_id, base_id, interface_type_id);
  527. if (facet_inst_id == SemIR::ErrorInst::SingletonInstId) {
  528. return SemIR::ErrorInst::SingletonInstId;
  529. }
  530. // That facet value has both the self type we need below and the witness
  531. // we are going to use to look up the value of the associated member.
  532. auto self_type_const_id = TryEvalInst(
  533. context, SemIR::InstId::None,
  534. SemIR::FacetAccessType{.type_id = SemIR::TypeType::SingletonTypeId,
  535. .facet_value_inst_id = facet_inst_id});
  536. // TODO: We should be able to lookup constant associated values from runtime
  537. // facet values by using their FacetType only, but we assume constant values
  538. // for impl lookup at the moment.
  539. if (!self_type_const_id.is_constant()) {
  540. context.TODO(loc_id, "associated value lookup on runtime facet value");
  541. return SemIR::ErrorInst::SingletonInstId;
  542. }
  543. auto self_type_id =
  544. context.types().GetTypeIdForTypeConstantId(self_type_const_id);
  545. auto witness_id =
  546. GetOrAddInst(context, loc_id,
  547. SemIR::FacetAccessWitness{
  548. .type_id = GetSingletonType(
  549. context, SemIR::WitnessType::SingletonInstId),
  550. .facet_value_inst_id = facet_inst_id,
  551. // There's only one interface in this facet type.
  552. .index = SemIR::ElementIndex(0)});
  553. // Before we can access the element of the witness, we need to figure out
  554. // the type of that element. It depends on the self type and the specific
  555. // interface.
  556. auto assoc_type_id = GetTypeForSpecificAssociatedEntity(
  557. context, loc_id, interface.specific_id, assoc_entity.decl_id,
  558. self_type_id, witness_id);
  559. // Now that we have the witness, an index into it, and the type of the
  560. // result, return the element of the witness.
  561. return GetOrAddInst<SemIR::ImplWitnessAccess>(context, loc_id,
  562. {.type_id = assoc_type_id,
  563. .witness_id = witness_id,
  564. .index = assoc_entity.index});
  565. }
  566. auto GetAssociatedValue(Context& context, SemIR::LocId loc_id,
  567. SemIR::InstId base_id,
  568. SemIR::InstId assoc_entity_inst_id,
  569. SemIR::SpecificInterface interface) -> SemIR::InstId {
  570. // TODO: This function shares a code with PerformCompoundMemberAccess(),
  571. // it would be nice to reduce the duplication.
  572. auto value_inst_id =
  573. context.constant_values().GetConstantInstId(assoc_entity_inst_id);
  574. CARBON_CHECK(value_inst_id.has_value());
  575. auto assoc_entity =
  576. context.insts().GetAs<SemIR::AssociatedEntity>(value_inst_id);
  577. auto decl_id = assoc_entity.decl_id;
  578. LoadImportRef(context, decl_id);
  579. return GetAssociatedValueImpl(context, loc_id, base_id, assoc_entity,
  580. interface);
  581. }
  582. auto PerformCompoundMemberAccess(Context& context, SemIR::LocId loc_id,
  583. SemIR::InstId base_id,
  584. SemIR::InstId member_expr_id,
  585. MakeDiagnosticBuilderFn missing_impl_diagnoser)
  586. -> SemIR::InstId {
  587. auto base_type_id = context.insts().Get(base_id).type_id();
  588. auto base_type_const_id = context.types().GetConstantId(base_type_id);
  589. auto member_id = member_expr_id;
  590. auto member = context.insts().Get(member_id);
  591. // If the member expression names an associated entity, impl lookup is always
  592. // performed using the type of the base expression.
  593. if (auto assoc_type = context.types().TryGetAs<SemIR::AssociatedEntityType>(
  594. member.type_id())) {
  595. // Step 1: figure out the type of the associated entity from the interface.
  596. auto value_inst_id = context.constant_values().GetConstantInstId(member_id);
  597. // TODO: According to
  598. // https://docs.carbon-lang.dev/docs/design/expressions/member_access.html#member-resolution
  599. // > For a compound member access, the second operand is evaluated as a
  600. // > compile-time constant to determine the member being accessed. The
  601. // > evaluation is required to succeed [...]
  602. if (!value_inst_id.has_value()) {
  603. context.TODO(loc_id, "Non-constant associated entity value");
  604. return SemIR::ErrorInst::SingletonInstId;
  605. }
  606. auto assoc_entity =
  607. context.insts().GetAs<SemIR::AssociatedEntity>(value_inst_id);
  608. auto decl_id = assoc_entity.decl_id;
  609. LoadImportRef(context, decl_id);
  610. auto decl_value_id = context.constant_values().GetConstantInstId(decl_id);
  611. auto decl_type_id = context.insts().Get(decl_value_id).type_id();
  612. if (IsInstanceType(context, decl_type_id)) {
  613. // Step 2a: For instance methods, lookup the impl of the interface for
  614. // this type and get the method.
  615. member_id =
  616. PerformImplLookup(context, loc_id, base_type_const_id, *assoc_type,
  617. member_id, missing_impl_diagnoser);
  618. // Next we will perform instance binding.
  619. } else {
  620. // Step 2b: For non-instance methods and associated constants, we access
  621. // the value of the associated constant, and don't do any instance
  622. // binding.
  623. return GetAssociatedValueImpl(context, loc_id, base_id, assoc_entity,
  624. assoc_type->GetSpecificInterface());
  625. }
  626. } else if (context.insts().Is<SemIR::TupleType>(
  627. context.constant_values().GetInstId(base_type_const_id))) {
  628. return PerformTupleAccess(context, loc_id, base_id, member_expr_id);
  629. }
  630. // Perform instance binding if we found an instance member.
  631. member_id = PerformInstanceBinding(context, loc_id, base_id, member_id);
  632. // If we didn't perform impl lookup or instance binding, that's an error
  633. // because the base expression is not used for anything.
  634. if (member_id == member_expr_id &&
  635. member.type_id() != SemIR::ErrorInst::SingletonTypeId) {
  636. CARBON_DIAGNOSTIC(CompoundMemberAccessDoesNotUseBase, Error,
  637. "member name of type {0} in compound member access is "
  638. "not an instance member or an interface member",
  639. TypeOfInstId);
  640. context.emitter().Emit(loc_id, CompoundMemberAccessDoesNotUseBase,
  641. member_id);
  642. }
  643. return member_id;
  644. }
  645. auto PerformTupleAccess(Context& context, SemIR::LocId loc_id,
  646. SemIR::InstId tuple_inst_id,
  647. SemIR::InstId index_inst_id) -> SemIR::InstId {
  648. tuple_inst_id = ConvertToValueOrRefExpr(context, tuple_inst_id);
  649. auto tuple_type_id = context.insts().Get(tuple_inst_id).type_id();
  650. auto tuple_type = context.types().TryGetAs<SemIR::TupleType>(tuple_type_id);
  651. if (!tuple_type) {
  652. CARBON_DIAGNOSTIC(TupleIndexOnANonTupleType, Error,
  653. "type {0} does not support tuple indexing; only "
  654. "tuples can be indexed that way",
  655. TypeOfInstId);
  656. context.emitter().Emit(loc_id, TupleIndexOnANonTupleType, tuple_inst_id);
  657. return SemIR::ErrorInst::SingletonInstId;
  658. }
  659. auto diag_non_constant_index = [&] {
  660. // TODO: Decide what to do if the index is a symbolic constant.
  661. CARBON_DIAGNOSTIC(TupleIndexNotConstant, Error,
  662. "tuple index must be a constant");
  663. context.emitter().Emit(loc_id, TupleIndexNotConstant);
  664. return SemIR::ErrorInst::SingletonInstId;
  665. };
  666. // Diagnose a non-constant index prior to conversion to IntLiteral, because
  667. // the conversion will fail if the index is not constant.
  668. if (!context.constant_values().Get(index_inst_id).is_concrete()) {
  669. return diag_non_constant_index();
  670. }
  671. SemIR::TypeId element_type_id = SemIR::ErrorInst::SingletonTypeId;
  672. auto index_node_id = context.insts().GetLocId(index_inst_id);
  673. index_inst_id = ConvertToValueOfType(
  674. context, index_node_id, index_inst_id,
  675. GetSingletonType(context, SemIR::IntLiteralType::SingletonInstId));
  676. auto index_const_id = context.constant_values().Get(index_inst_id);
  677. if (index_const_id == SemIR::ErrorInst::SingletonConstantId) {
  678. return SemIR::ErrorInst::SingletonInstId;
  679. } else if (!index_const_id.is_concrete()) {
  680. return diag_non_constant_index();
  681. }
  682. auto index_literal = context.insts().GetAs<SemIR::IntValue>(
  683. context.constant_values().GetInstId(index_const_id));
  684. auto type_block = context.type_blocks().Get(tuple_type->elements_id);
  685. std::optional<llvm::APInt> index_val = ValidateTupleIndex(
  686. context, loc_id, tuple_inst_id, index_literal, type_block.size());
  687. if (!index_val) {
  688. return SemIR::ErrorInst::SingletonInstId;
  689. }
  690. // TODO: Handle the case when `index_val->getZExtValue()` has too many bits.
  691. element_type_id = type_block[index_val->getZExtValue()];
  692. auto tuple_index = SemIR::ElementIndex(index_val->getZExtValue());
  693. return GetOrAddInst<SemIR::TupleAccess>(context, loc_id,
  694. {.type_id = element_type_id,
  695. .tuple_id = tuple_inst_id,
  696. .index = tuple_index});
  697. }
  698. } // namespace Carbon::Check