check.cpp 52 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307
  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/check.h"
  5. #include <variant>
  6. #include "common/check.h"
  7. #include "common/error.h"
  8. #include "common/map.h"
  9. #include "common/variant_helpers.h"
  10. #include "common/vlog.h"
  11. #include "toolchain/base/kind_switch.h"
  12. #include "toolchain/base/pretty_stack_trace_function.h"
  13. #include "toolchain/check/context.h"
  14. #include "toolchain/check/diagnostic_helpers.h"
  15. #include "toolchain/check/function.h"
  16. #include "toolchain/check/handle.h"
  17. #include "toolchain/check/import.h"
  18. #include "toolchain/check/import_ref.h"
  19. #include "toolchain/check/sem_ir_diagnostic_converter.h"
  20. #include "toolchain/diagnostics/diagnostic.h"
  21. #include "toolchain/diagnostics/diagnostic_emitter.h"
  22. #include "toolchain/lex/token_kind.h"
  23. #include "toolchain/parse/node_ids.h"
  24. #include "toolchain/parse/tree.h"
  25. #include "toolchain/parse/tree_node_diagnostic_converter.h"
  26. #include "toolchain/sem_ir/file.h"
  27. #include "toolchain/sem_ir/ids.h"
  28. #include "toolchain/sem_ir/typed_insts.h"
  29. namespace Carbon::Check {
  30. namespace {
  31. struct UnitInfo {
  32. // A given import within the file, with its destination.
  33. struct Import {
  34. Parse::Tree::PackagingNames names;
  35. UnitInfo* unit_info;
  36. };
  37. // A file's imports corresponding to a single package, for the map.
  38. struct PackageImports {
  39. // Use the constructor so that the SmallVector is only constructed
  40. // as-needed.
  41. explicit PackageImports(IdentifierId package_id,
  42. Parse::ImportDeclId node_id)
  43. : package_id(package_id), node_id(node_id) {}
  44. // The identifier of the imported package.
  45. IdentifierId package_id;
  46. // The first `import` declaration in the file, which declared the package's
  47. // identifier (even if the import failed). Used for associating diagnostics
  48. // not specific to a single import.
  49. Parse::ImportDeclId node_id;
  50. // The associated `import` instruction. Only valid once a file is checked.
  51. SemIR::InstId import_decl_id = SemIR::InstId::Invalid;
  52. // Whether there's an import that failed to load.
  53. bool has_load_error = false;
  54. // The list of valid imports.
  55. llvm::SmallVector<Import> imports;
  56. };
  57. explicit UnitInfo(SemIR::CheckIRId check_ir_id, Unit& unit)
  58. : check_ir_id(check_ir_id),
  59. unit(&unit),
  60. converter(unit.tokens, unit.tokens->source().filename(),
  61. unit.parse_tree),
  62. err_tracker(*unit.consumer),
  63. emitter(converter, err_tracker) {}
  64. SemIR::CheckIRId check_ir_id;
  65. Unit* unit;
  66. // Emitter information.
  67. Parse::NodeLocConverter converter;
  68. ErrorTrackingDiagnosticConsumer err_tracker;
  69. DiagnosticEmitter<Parse::NodeLoc> emitter;
  70. // List of the outgoing imports. If a package includes unavailable library
  71. // imports, it has an entry with has_load_error set. Invalid imports (for
  72. // example, `import Main;`) aren't added because they won't add identifiers to
  73. // name lookup.
  74. llvm::SmallVector<PackageImports> package_imports;
  75. // A map of the package names to the outgoing imports above.
  76. Map<IdentifierId, int32_t> package_imports_map;
  77. // The remaining number of imports which must be checked before this unit can
  78. // be processed.
  79. int32_t imports_remaining = 0;
  80. // A list of incoming imports. This will be empty for `impl` files, because
  81. // imports only touch `api` files.
  82. llvm::SmallVector<UnitInfo*> incoming_imports;
  83. // The corresponding `api` unit if this is an `impl` file. The entry should
  84. // also be in the corresponding `PackageImports`.
  85. UnitInfo* api_for_impl = nullptr;
  86. };
  87. } // namespace
  88. // Collects direct imports, for CollectTransitiveImports.
  89. static auto CollectDirectImports(llvm::SmallVector<SemIR::ImportIR>& results,
  90. llvm::MutableArrayRef<int> ir_to_result_index,
  91. SemIR::InstId import_decl_id,
  92. const UnitInfo::PackageImports& imports,
  93. bool is_local) -> void {
  94. for (const auto& import : imports.imports) {
  95. const auto& direct_ir = **import.unit_info->unit->sem_ir;
  96. auto& index = ir_to_result_index[direct_ir.check_ir_id().index];
  97. if (index != -1) {
  98. // This should only happen when doing API imports for an implementation
  99. // file. Don't change the entry; is_export doesn't matter.
  100. continue;
  101. }
  102. index = results.size();
  103. results.push_back({.decl_id = import_decl_id,
  104. // Only tag exports in API files, ignoring the value in
  105. // implementation files.
  106. .is_export = is_local && import.names.is_export,
  107. .sem_ir = &direct_ir});
  108. }
  109. }
  110. // Collects transitive imports, handling deduplication. These will be unified
  111. // between local_imports and api_imports.
  112. static auto CollectTransitiveImports(
  113. SemIR::InstId import_decl_id, const UnitInfo::PackageImports* local_imports,
  114. const UnitInfo::PackageImports* api_imports, int total_ir_count)
  115. -> llvm::SmallVector<SemIR::ImportIR> {
  116. llvm::SmallVector<SemIR::ImportIR> results;
  117. // Track whether an IR was imported in full, including `export import`. This
  118. // distinguishes from IRs that are indirectly added without all names being
  119. // exported to this IR.
  120. llvm::SmallVector<int> ir_to_result_index(total_ir_count, -1);
  121. // First add direct imports. This means that if an entity is imported both
  122. // directly and indirectly, the import path will reflect the direct import.
  123. if (local_imports) {
  124. CollectDirectImports(results, ir_to_result_index, import_decl_id,
  125. *local_imports,
  126. /*is_local=*/true);
  127. }
  128. if (api_imports) {
  129. CollectDirectImports(results, ir_to_result_index, import_decl_id,
  130. *api_imports,
  131. /*is_local=*/false);
  132. }
  133. // Loop through direct imports for any indirect exports. The underlying vector
  134. // is appended during iteration, so take the size first.
  135. const int direct_imports = results.size();
  136. for (int direct_index : llvm::seq(direct_imports)) {
  137. bool is_export = results[direct_index].is_export;
  138. for (const auto& indirect_ir :
  139. results[direct_index].sem_ir->import_irs().array_ref()) {
  140. if (!indirect_ir.is_export) {
  141. continue;
  142. }
  143. auto& indirect_index =
  144. ir_to_result_index[indirect_ir.sem_ir->check_ir_id().index];
  145. if (indirect_index == -1) {
  146. indirect_index = results.size();
  147. // TODO: In the case of a recursive `export import`, this only points at
  148. // the outermost import. May want something that better reflects the
  149. // recursion.
  150. results.push_back({.decl_id = results[direct_index].decl_id,
  151. .is_export = is_export,
  152. .sem_ir = indirect_ir.sem_ir});
  153. } else if (is_export) {
  154. results[indirect_index].is_export = true;
  155. }
  156. }
  157. }
  158. return results;
  159. }
  160. // Imports the current package.
  161. static auto ImportCurrentPackage(Context& context, UnitInfo& unit_info,
  162. int total_ir_count,
  163. SemIR::InstId package_inst_id,
  164. SemIR::TypeId namespace_type_id) -> void {
  165. // Add imports from the current package.
  166. auto import_map_lookup =
  167. unit_info.package_imports_map.Lookup(IdentifierId::Invalid);
  168. if (!import_map_lookup) {
  169. // Push the scope; there are no names to add.
  170. context.scope_stack().Push(package_inst_id, SemIR::NameScopeId::Package);
  171. return;
  172. }
  173. UnitInfo::PackageImports& self_import =
  174. unit_info.package_imports[import_map_lookup.value()];
  175. if (self_import.has_load_error) {
  176. context.name_scopes().Get(SemIR::NameScopeId::Package).has_error = true;
  177. }
  178. ImportLibrariesFromCurrentPackage(
  179. context, namespace_type_id,
  180. CollectTransitiveImports(self_import.import_decl_id, &self_import,
  181. /*api_imports=*/nullptr, total_ir_count));
  182. context.scope_stack().Push(
  183. package_inst_id, SemIR::NameScopeId::Package,
  184. SemIR::GenericInstanceId::Invalid,
  185. context.name_scopes().Get(SemIR::NameScopeId::Package).has_error);
  186. }
  187. // Imports all other packages (excluding the current package).
  188. static auto ImportOtherPackages(Context& context, UnitInfo& unit_info,
  189. int total_ir_count,
  190. SemIR::TypeId namespace_type_id) -> void {
  191. // api_imports_list is initially the size of the current file's imports,
  192. // including for API files, for simplicity in iteration. It's only really used
  193. // when processing an implementation file, in order to combine the API file
  194. // imports.
  195. //
  196. // For packages imported by the API file, the IdentifierId is the package name
  197. // and the index is into the API's import list. Otherwise, the initial
  198. // {Invalid, -1} state remains.
  199. llvm::SmallVector<std::pair<IdentifierId, int32_t>> api_imports_list;
  200. api_imports_list.resize(unit_info.package_imports.size(),
  201. {IdentifierId::Invalid, -1});
  202. // When there's an API file, add the mapping to api_imports_list.
  203. if (unit_info.api_for_impl) {
  204. const auto& api_identifiers =
  205. unit_info.api_for_impl->unit->value_stores->identifiers();
  206. auto& impl_identifiers = unit_info.unit->value_stores->identifiers();
  207. for (auto [api_imports_index, api_imports] :
  208. llvm::enumerate(unit_info.api_for_impl->package_imports)) {
  209. // Skip the current package.
  210. if (!api_imports.package_id.is_valid()) {
  211. continue;
  212. }
  213. // Translate the package ID from the API file to the implementation file.
  214. auto impl_package_id =
  215. impl_identifiers.Add(api_identifiers.Get(api_imports.package_id));
  216. if (auto lookup = unit_info.package_imports_map.Lookup(impl_package_id)) {
  217. // On a hit, replace the entry to unify the API and implementation
  218. // imports.
  219. api_imports_list[lookup.value()] = {impl_package_id, api_imports_index};
  220. } else {
  221. // On a miss, add the package as API-only.
  222. api_imports_list.push_back({impl_package_id, api_imports_index});
  223. }
  224. }
  225. }
  226. for (auto [i, api_imports_entry] : llvm::enumerate(api_imports_list)) {
  227. // These variables are updated after figuring out which imports are present.
  228. auto import_decl_id = SemIR::InstId::Invalid;
  229. IdentifierId package_id = IdentifierId::Invalid;
  230. bool has_load_error = false;
  231. // Identify the local package imports if present.
  232. UnitInfo::PackageImports* local_imports = nullptr;
  233. if (i < unit_info.package_imports.size()) {
  234. local_imports = &unit_info.package_imports[i];
  235. if (!local_imports->package_id.is_valid()) {
  236. // Skip the current package.
  237. continue;
  238. }
  239. import_decl_id = local_imports->import_decl_id;
  240. package_id = local_imports->package_id;
  241. has_load_error |= local_imports->has_load_error;
  242. }
  243. // Identify the API package imports if present.
  244. UnitInfo::PackageImports* api_imports = nullptr;
  245. if (api_imports_entry.second != -1) {
  246. api_imports =
  247. &unit_info.api_for_impl->package_imports[api_imports_entry.second];
  248. if (local_imports) {
  249. CARBON_CHECK(package_id == api_imports_entry.first);
  250. } else {
  251. auto import_ir_inst_id = context.import_ir_insts().Add(
  252. {.ir_id = SemIR::ImportIRId::ApiForImpl,
  253. .inst_id = api_imports->import_decl_id});
  254. import_decl_id = context.AddInst<SemIR::ImportDecl>(
  255. import_ir_inst_id, {.package_id = SemIR::NameId::ForIdentifier(
  256. api_imports_entry.first)});
  257. package_id = api_imports_entry.first;
  258. }
  259. has_load_error |= api_imports->has_load_error;
  260. }
  261. // Do the actual import.
  262. ImportLibrariesFromOtherPackage(
  263. context, namespace_type_id, import_decl_id, package_id,
  264. CollectTransitiveImports(import_decl_id, local_imports, api_imports,
  265. total_ir_count),
  266. has_load_error);
  267. }
  268. }
  269. // Add imports to the root block.
  270. // TODO: Should this be importing all namespaces before anything else, including
  271. // for imports from other packages? Otherwise, name conflict resolution
  272. // involving something such as `fn F() -> Other.NS.A`, wherein `Other.NS`
  273. // hasn't been imported yet (before `Other.NS` had a constant assigned), could
  274. // result in an inconsistent scoping for `Other.NS.A` versus if it were imported
  275. // as part of scanning `Other.NS` (after `Other.NS` had a constant assigned).
  276. // This will probably require IRs separating out which namespaces they
  277. // declare (or declare entities inside).
  278. static auto InitPackageScopeAndImports(Context& context, UnitInfo& unit_info,
  279. int total_ir_count) -> void {
  280. // First create the constant values map for all imported IRs. We'll populate
  281. // these with mappings for namespaces as we go.
  282. size_t num_irs = 0;
  283. for (auto& package_imports : unit_info.package_imports) {
  284. num_irs += package_imports.imports.size();
  285. }
  286. if (!unit_info.api_for_impl) {
  287. // Leave an empty slot for ImportIRId::ApiForImpl.
  288. ++num_irs;
  289. }
  290. context.import_irs().Reserve(num_irs);
  291. context.import_ir_constant_values().reserve(num_irs);
  292. context.SetTotalIRCount(total_ir_count);
  293. // Importing makes many namespaces, so only canonicalize the type once.
  294. auto namespace_type_id =
  295. context.GetBuiltinType(SemIR::BuiltinInstKind::NamespaceType);
  296. // Define the package scope, with an instruction for `package` expressions to
  297. // reference.
  298. auto package_scope_id = context.name_scopes().Add(
  299. SemIR::InstId::PackageNamespace, SemIR::NameId::PackageNamespace,
  300. SemIR::NameScopeId::Invalid);
  301. CARBON_CHECK(package_scope_id == SemIR::NameScopeId::Package);
  302. auto package_inst_id = context.AddInst<SemIR::Namespace>(
  303. Parse::NodeId::Invalid, {.type_id = namespace_type_id,
  304. .name_scope_id = SemIR::NameScopeId::Package,
  305. .import_id = SemIR::InstId::Invalid});
  306. CARBON_CHECK(package_inst_id == SemIR::InstId::PackageNamespace);
  307. // If there is an implicit `api` import, set it first so that it uses the
  308. // ImportIRId::ApiForImpl when processed for imports.
  309. if (unit_info.api_for_impl) {
  310. const auto& names = context.parse_tree().packaging_decl()->names;
  311. auto import_decl_id = context.AddInst<SemIR::ImportDecl>(
  312. names.node_id,
  313. {.package_id = SemIR::NameId::ForIdentifier(names.package_id)});
  314. SetApiImportIR(context,
  315. {.decl_id = import_decl_id,
  316. .is_export = false,
  317. .sem_ir = &**unit_info.api_for_impl->unit->sem_ir});
  318. } else {
  319. SetApiImportIR(context,
  320. {.decl_id = SemIR::InstId::Invalid, .sem_ir = nullptr});
  321. }
  322. // Add import instructions for everything directly imported. Implicit imports
  323. // are handled separately.
  324. for (auto& package_imports : unit_info.package_imports) {
  325. CARBON_CHECK(!package_imports.import_decl_id.is_valid());
  326. package_imports.import_decl_id = context.AddInst<SemIR::ImportDecl>(
  327. package_imports.node_id, {.package_id = SemIR::NameId::ForIdentifier(
  328. package_imports.package_id)});
  329. }
  330. // Process the imports.
  331. if (unit_info.api_for_impl) {
  332. ImportApiFile(context, namespace_type_id,
  333. **unit_info.api_for_impl->unit->sem_ir);
  334. }
  335. ImportCurrentPackage(context, unit_info, total_ir_count, package_inst_id,
  336. namespace_type_id);
  337. CARBON_CHECK(context.scope_stack().PeekIndex() == ScopeIndex::Package);
  338. ImportOtherPackages(context, unit_info, total_ir_count, namespace_type_id);
  339. }
  340. namespace {
  341. // State used to track the next deferred function definition that we will
  342. // encounter and need to reorder.
  343. class NextDeferredDefinitionCache {
  344. public:
  345. explicit NextDeferredDefinitionCache(const Parse::Tree* tree) : tree_(tree) {
  346. SkipTo(Parse::DeferredDefinitionIndex(0));
  347. }
  348. // Set the specified deferred definition index as being the next one that will
  349. // be encountered.
  350. auto SkipTo(Parse::DeferredDefinitionIndex next_index) -> void {
  351. index_ = next_index;
  352. if (static_cast<std::size_t>(index_.index) ==
  353. tree_->deferred_definitions().size()) {
  354. start_id_ = Parse::NodeId::Invalid;
  355. } else {
  356. start_id_ = tree_->deferred_definitions().Get(index_).start_id;
  357. }
  358. }
  359. // Returns the index of the next deferred definition to be encountered.
  360. auto index() const -> Parse::DeferredDefinitionIndex { return index_; }
  361. // Returns the ID of the start node of the next deferred definition.
  362. auto start_id() const -> Parse::NodeId { return start_id_; }
  363. private:
  364. const Parse::Tree* tree_;
  365. Parse::DeferredDefinitionIndex index_ =
  366. Parse::DeferredDefinitionIndex::Invalid;
  367. Parse::NodeId start_id_ = Parse::NodeId::Invalid;
  368. };
  369. } // namespace
  370. // Determines whether this node kind is the start of a deferred definition
  371. // scope.
  372. static auto IsStartOfDeferredDefinitionScope(Parse::NodeKind kind) -> bool {
  373. switch (kind) {
  374. case Parse::NodeKind::ClassDefinitionStart:
  375. case Parse::NodeKind::ImplDefinitionStart:
  376. case Parse::NodeKind::InterfaceDefinitionStart:
  377. case Parse::NodeKind::NamedConstraintDefinitionStart:
  378. // TODO: Mixins.
  379. return true;
  380. default:
  381. return false;
  382. }
  383. }
  384. // Determines whether this node kind is the end of a deferred definition scope.
  385. static auto IsEndOfDeferredDefinitionScope(Parse::NodeKind kind) -> bool {
  386. switch (kind) {
  387. case Parse::NodeKind::ClassDefinition:
  388. case Parse::NodeKind::ImplDefinition:
  389. case Parse::NodeKind::InterfaceDefinition:
  390. case Parse::NodeKind::NamedConstraintDefinition:
  391. // TODO: Mixins.
  392. return true;
  393. default:
  394. return false;
  395. }
  396. }
  397. namespace {
  398. // A worklist of pending tasks to perform to check deferred function definitions
  399. // in the right order.
  400. class DeferredDefinitionWorklist {
  401. public:
  402. // A worklist task that indicates we should check a deferred function
  403. // definition that we previously skipped.
  404. struct CheckSkippedDefinition {
  405. // The definition that we skipped.
  406. Parse::DeferredDefinitionIndex definition_index;
  407. // The suspended function.
  408. SuspendedFunction suspended_fn;
  409. };
  410. // A worklist task that indicates we should enter a nested deferred definition
  411. // scope.
  412. struct EnterDeferredDefinitionScope {
  413. // The suspended scope. This is only set once we reach the end of the scope.
  414. std::optional<DeclNameStack::SuspendedName> suspended_name;
  415. // Whether this scope is itself within an outer deferred definition scope.
  416. // If so, we'll delay processing its contents until we reach the end of the
  417. // parent scope. For example:
  418. //
  419. // ```
  420. // class A {
  421. // class B {
  422. // fn F() -> A { return {}; }
  423. // }
  424. // } // A.B.F is type-checked here, with A complete.
  425. //
  426. // fn F() {
  427. // class C {
  428. // fn G() {}
  429. // } // C.G is type-checked here.
  430. // }
  431. // ```
  432. bool in_deferred_definition_scope;
  433. };
  434. // A worklist task that indicates we should leave a deferred definition scope.
  435. struct LeaveDeferredDefinitionScope {
  436. // Whether this scope is within another deferred definition scope.
  437. bool in_deferred_definition_scope;
  438. };
  439. // A pending type-checking task.
  440. using Task =
  441. std::variant<CheckSkippedDefinition, EnterDeferredDefinitionScope,
  442. LeaveDeferredDefinitionScope>;
  443. explicit DeferredDefinitionWorklist(llvm::raw_ostream* vlog_stream)
  444. : vlog_stream_(vlog_stream) {
  445. // See declaration of `worklist_`.
  446. worklist_.reserve(64);
  447. }
  448. static constexpr llvm::StringLiteral VlogPrefix =
  449. "DeferredDefinitionWorklist ";
  450. // Suspend the current function definition and push a task onto the worklist
  451. // to finish it later.
  452. auto SuspendFunctionAndPush(Context& context,
  453. Parse::DeferredDefinitionIndex index,
  454. Parse::FunctionDefinitionStartId node_id)
  455. -> void {
  456. worklist_.push_back(CheckSkippedDefinition{
  457. index, HandleFunctionDefinitionSuspend(context, node_id)});
  458. CARBON_VLOG() << VlogPrefix << "Push CheckSkippedDefinition " << index.index
  459. << "\n";
  460. }
  461. // Push a task to re-enter a function scope, so that functions defined within
  462. // it are type-checked in the right context.
  463. auto PushEnterDeferredDefinitionScope(Context& context) -> void {
  464. bool nested = !entered_scopes_.empty() &&
  465. entered_scopes_.back().scope_index ==
  466. context.decl_name_stack().PeekInitialScopeIndex();
  467. entered_scopes_.push_back(
  468. {.worklist_start_index = worklist_.size(),
  469. .scope_index = context.scope_stack().PeekIndex()});
  470. worklist_.push_back(
  471. EnterDeferredDefinitionScope{.suspended_name = std::nullopt,
  472. .in_deferred_definition_scope = nested});
  473. CARBON_VLOG() << VlogPrefix << "Push EnterDeferredDefinitionScope "
  474. << (nested ? "(nested)" : "(non-nested)") << "\n";
  475. }
  476. // Suspend the current deferred definition scope, which is finished but still
  477. // on the decl_name_stack, and push a task to leave the scope when we're
  478. // type-checking deferred definitions. Returns `true` if the current list of
  479. // deferred definitions should be type-checked immediately.
  480. auto SuspendFinishedScopeAndPush(Context& context) -> bool;
  481. // Pop the next task off the worklist.
  482. auto Pop() -> Task {
  483. if (vlog_stream_) {
  484. VariantMatch(
  485. worklist_.back(),
  486. [&](CheckSkippedDefinition& definition) {
  487. CARBON_VLOG() << VlogPrefix << "Handle CheckSkippedDefinition "
  488. << definition.definition_index.index << "\n";
  489. },
  490. [&](EnterDeferredDefinitionScope& enter) {
  491. CARBON_CHECK(enter.in_deferred_definition_scope);
  492. CARBON_VLOG() << VlogPrefix
  493. << "Handle EnterDeferredDefinitionScope (nested)\n";
  494. },
  495. [&](LeaveDeferredDefinitionScope& leave) {
  496. bool nested = leave.in_deferred_definition_scope;
  497. CARBON_VLOG() << VlogPrefix
  498. << "Handle LeaveDeferredDefinitionScope "
  499. << (nested ? "(nested)" : "(non-nested)") << "\n";
  500. });
  501. }
  502. return worklist_.pop_back_val();
  503. }
  504. // CHECK that the work list has no further work.
  505. auto VerifyEmpty() {
  506. CARBON_CHECK(worklist_.empty() && entered_scopes_.empty())
  507. << "Tasks left behind on worklist.";
  508. }
  509. private:
  510. llvm::raw_ostream* vlog_stream_;
  511. // A worklist of type-checking tasks we'll need to do later.
  512. //
  513. // Don't allocate any inline storage here. A Task is fairly large, so we never
  514. // want this to live on the stack. Instead, we reserve space in the
  515. // constructor for a fairly large number of deferred definitions.
  516. llvm::SmallVector<Task, 0> worklist_;
  517. // A deferred definition scope that is currently still open.
  518. struct EnteredScope {
  519. // The index in worklist_ of the EnterDeferredDefinitionScope task.
  520. size_t worklist_start_index;
  521. // The corresponding lexical scope index.
  522. ScopeIndex scope_index;
  523. };
  524. // The deferred definition scopes for the current checking actions.
  525. llvm::SmallVector<EnteredScope> entered_scopes_;
  526. };
  527. } // namespace
  528. auto DeferredDefinitionWorklist::SuspendFinishedScopeAndPush(Context& context)
  529. -> bool {
  530. auto start_index = entered_scopes_.pop_back_val().worklist_start_index;
  531. // If we've not found any deferred definitions in this scope, clean up the
  532. // stack.
  533. if (start_index == worklist_.size() - 1) {
  534. context.decl_name_stack().PopScope();
  535. worklist_.pop_back();
  536. CARBON_VLOG() << VlogPrefix << "Pop EnterDeferredDefinitionScope (empty)\n";
  537. return false;
  538. }
  539. // If we're finishing a nested deferred definition scope, keep track of that
  540. // but don't type-check deferred definitions now.
  541. auto& enter_scope = get<EnterDeferredDefinitionScope>(worklist_[start_index]);
  542. if (enter_scope.in_deferred_definition_scope) {
  543. // This is a nested deferred definition scope. Suspend the inner scope so we
  544. // can restore it when we come to type-check the deferred definitions.
  545. enter_scope.suspended_name = context.decl_name_stack().Suspend();
  546. // Enqueue a task to leave the nested scope.
  547. worklist_.push_back(
  548. LeaveDeferredDefinitionScope{.in_deferred_definition_scope = true});
  549. CARBON_VLOG() << VlogPrefix
  550. << "Push LeaveDeferredDefinitionScope (nested)\n";
  551. return false;
  552. }
  553. // We're at the end of a non-nested deferred definition scope. Prepare to
  554. // start checking deferred definitions. Enqueue a task to leave this outer
  555. // scope and end checking deferred definitions.
  556. worklist_.push_back(
  557. LeaveDeferredDefinitionScope{.in_deferred_definition_scope = false});
  558. CARBON_VLOG() << VlogPrefix
  559. << "Push LeaveDeferredDefinitionScope (non-nested)\n";
  560. // We'll process the worklist in reverse index order, so reverse the part of
  561. // it we're about to execute so we run our tasks in the order in which they
  562. // were pushed.
  563. std::reverse(worklist_.begin() + start_index, worklist_.end());
  564. // Pop the `EnterDeferredDefinitionScope` that's now on the end of the
  565. // worklist. We stay in that scope rather than suspending then immediately
  566. // resuming it.
  567. CARBON_CHECK(
  568. holds_alternative<EnterDeferredDefinitionScope>(worklist_.back()))
  569. << "Unexpected task in worklist.";
  570. worklist_.pop_back();
  571. CARBON_VLOG() << VlogPrefix
  572. << "Handle EnterDeferredDefinitionScope (non-nested)\n";
  573. return true;
  574. }
  575. namespace {
  576. // A traversal of the node IDs in the parse tree, in the order in which we need
  577. // to check them.
  578. class NodeIdTraversal {
  579. public:
  580. explicit NodeIdTraversal(Context& context, llvm::raw_ostream* vlog_stream)
  581. : context_(context),
  582. next_deferred_definition_(&context.parse_tree()),
  583. worklist_(vlog_stream) {
  584. chunks_.push_back(
  585. {.it = context.parse_tree().postorder().begin(),
  586. .end = context.parse_tree().postorder().end(),
  587. .next_definition = Parse::DeferredDefinitionIndex::Invalid});
  588. }
  589. // Finds the next `NodeId` to type-check. Returns nullopt if the traversal is
  590. // complete.
  591. auto Next() -> std::optional<Parse::NodeId>;
  592. // Performs any processing necessary after we type-check a node.
  593. auto Handle(Parse::NodeKind parse_kind) -> void {
  594. // When we reach the start of a deferred definition scope, add a task to the
  595. // worklist to check future skipped definitions in the new context.
  596. if (IsStartOfDeferredDefinitionScope(parse_kind)) {
  597. worklist_.PushEnterDeferredDefinitionScope(context_);
  598. }
  599. // When we reach the end of a deferred definition scope, add a task to the
  600. // worklist to leave the scope. If this is not a nested scope, start
  601. // checking the deferred definitions now.
  602. if (IsEndOfDeferredDefinitionScope(parse_kind)) {
  603. chunks_.back().checking_deferred_definitions =
  604. worklist_.SuspendFinishedScopeAndPush(context_);
  605. }
  606. }
  607. private:
  608. // A chunk of the parse tree that we need to type-check.
  609. struct Chunk {
  610. Parse::Tree::PostorderIterator it;
  611. Parse::Tree::PostorderIterator end;
  612. // The next definition that will be encountered after this chunk completes.
  613. Parse::DeferredDefinitionIndex next_definition;
  614. // Whether we are currently checking deferred definitions, rather than the
  615. // tokens of this chunk. If so, we'll pull tasks off `worklist` and execute
  616. // them until we're done with this batch of deferred definitions. Otherwise,
  617. // we'll pull node IDs from `*it` until it reaches `end`.
  618. bool checking_deferred_definitions = false;
  619. };
  620. // Re-enter a nested deferred definition scope.
  621. auto PerformTask(
  622. DeferredDefinitionWorklist::EnterDeferredDefinitionScope&& enter)
  623. -> void {
  624. CARBON_CHECK(enter.suspended_name)
  625. << "Entering a scope with no suspension information.";
  626. context_.decl_name_stack().Restore(std::move(*enter.suspended_name));
  627. }
  628. // Leave a nested or top-level deferred definition scope.
  629. auto PerformTask(
  630. DeferredDefinitionWorklist::LeaveDeferredDefinitionScope&& leave)
  631. -> void {
  632. if (!leave.in_deferred_definition_scope) {
  633. // We're done with checking deferred definitions.
  634. chunks_.back().checking_deferred_definitions = false;
  635. }
  636. context_.decl_name_stack().PopScope();
  637. }
  638. // Resume checking a deferred definition.
  639. auto PerformTask(
  640. DeferredDefinitionWorklist::CheckSkippedDefinition&& parse_definition)
  641. -> void {
  642. auto& [definition_index, suspended_fn] = parse_definition;
  643. const auto& definition_info =
  644. context_.parse_tree().deferred_definitions().Get(definition_index);
  645. HandleFunctionDefinitionResume(context_, definition_info.start_id,
  646. std::move(suspended_fn));
  647. chunks_.push_back(
  648. {.it = context_.parse_tree().postorder(definition_info.start_id).end(),
  649. .end = context_.parse_tree()
  650. .postorder(definition_info.definition_id)
  651. .end(),
  652. .next_definition = next_deferred_definition_.index()});
  653. ++definition_index.index;
  654. next_deferred_definition_.SkipTo(definition_index);
  655. }
  656. Context& context_;
  657. NextDeferredDefinitionCache next_deferred_definition_;
  658. DeferredDefinitionWorklist worklist_;
  659. llvm::SmallVector<Chunk> chunks_;
  660. };
  661. } // namespace
  662. auto NodeIdTraversal::Next() -> std::optional<Parse::NodeId> {
  663. while (true) {
  664. // If we're checking deferred definitions, find the next definition we
  665. // should check, restore its suspended state, and add a corresponding
  666. // `Chunk` to the top of the chunk list.
  667. if (chunks_.back().checking_deferred_definitions) {
  668. std::visit(
  669. [&](auto&& task) { PerformTask(std::forward<decltype(task)>(task)); },
  670. worklist_.Pop());
  671. continue;
  672. }
  673. // If we're not checking deferred definitions, produce the next parse node
  674. // for this chunk. If we've run out of parse nodes, we're done with this
  675. // chunk of the parse tree.
  676. if (chunks_.back().it == chunks_.back().end) {
  677. auto old_chunk = chunks_.pop_back_val();
  678. // If we're out of chunks, then we're done entirely.
  679. if (chunks_.empty()) {
  680. worklist_.VerifyEmpty();
  681. return std::nullopt;
  682. }
  683. next_deferred_definition_.SkipTo(old_chunk.next_definition);
  684. continue;
  685. }
  686. auto node_id = *chunks_.back().it;
  687. // If we've reached the start of a deferred definition, skip to the end of
  688. // it, and track that we need to check it later.
  689. if (node_id == next_deferred_definition_.start_id()) {
  690. const auto& definition_info =
  691. context_.parse_tree().deferred_definitions().Get(
  692. next_deferred_definition_.index());
  693. worklist_.SuspendFunctionAndPush(context_,
  694. next_deferred_definition_.index(),
  695. definition_info.start_id);
  696. // Continue type-checking the parse tree after the end of the definition.
  697. chunks_.back().it =
  698. context_.parse_tree().postorder(definition_info.definition_id).end();
  699. next_deferred_definition_.SkipTo(definition_info.next_definition_index);
  700. continue;
  701. }
  702. ++chunks_.back().it;
  703. return node_id;
  704. }
  705. }
  706. // Emits a diagnostic for each declaration in context.definitions_required()
  707. // that doesn't have a definition.
  708. static auto DiagnoseMissingDefinitions(Context& context,
  709. Context::DiagnosticEmitter& emitter)
  710. -> void {
  711. CARBON_DIAGNOSTIC(MissingDefinitionInImpl, Error,
  712. "No definition found for declaration in impl file");
  713. for (SemIR::InstId decl_inst_id : context.definitions_required()) {
  714. SemIR::Inst decl_inst = context.insts().Get(decl_inst_id);
  715. CARBON_KIND_SWITCH(context.insts().Get(decl_inst_id)) {
  716. case CARBON_KIND(SemIR::ClassDecl class_decl): {
  717. if (!context.classes().Get(class_decl.class_id).is_defined()) {
  718. emitter.Emit(decl_inst_id, MissingDefinitionInImpl);
  719. }
  720. break;
  721. }
  722. case CARBON_KIND(SemIR::FunctionDecl function_decl): {
  723. if (context.functions().Get(function_decl.function_id).definition_id ==
  724. SemIR::InstId::Invalid) {
  725. emitter.Emit(decl_inst_id, MissingDefinitionInImpl);
  726. }
  727. break;
  728. }
  729. case CARBON_KIND(SemIR::ImplDecl impl_decl): {
  730. if (!context.impls().Get(impl_decl.impl_id).is_defined()) {
  731. emitter.Emit(decl_inst_id, MissingDefinitionInImpl);
  732. }
  733. break;
  734. }
  735. case SemIR::InterfaceDecl::Kind: {
  736. // TODO: handle `interface` as well, once we can test it without
  737. // triggering https://github.com/carbon-language/carbon-lang/issues/4071
  738. CARBON_FATAL()
  739. << "TODO: Support interfaces in DiagnoseMissingDefinitions";
  740. }
  741. default: {
  742. CARBON_FATAL() << "Unexpected inst in definitions_required: "
  743. << decl_inst;
  744. }
  745. }
  746. }
  747. }
  748. // Loops over all nodes in the tree. On some errors, this may return early,
  749. // for example if an unrecoverable state is encountered.
  750. // NOLINTNEXTLINE(readability-function-size)
  751. static auto ProcessNodeIds(Context& context, llvm::raw_ostream* vlog_stream,
  752. ErrorTrackingDiagnosticConsumer& err_tracker,
  753. Parse::NodeLocConverter* converter) -> bool {
  754. NodeIdTraversal traversal(context, vlog_stream);
  755. Parse::NodeId node_id = Parse::NodeId::Invalid;
  756. // On crash, report which token we were handling.
  757. PrettyStackTraceFunction node_dumper([&](llvm::raw_ostream& output) {
  758. auto loc = converter->ConvertLoc(
  759. node_id, [](DiagnosticLoc, const Internal::DiagnosticBase<>&) {});
  760. loc.FormatLocation(output);
  761. output << ": Check::Handle" << context.parse_tree().node_kind(node_id)
  762. << "\n";
  763. loc.FormatSnippet(output);
  764. });
  765. while (auto maybe_node_id = traversal.Next()) {
  766. node_id = *maybe_node_id;
  767. auto parse_kind = context.parse_tree().node_kind(node_id);
  768. switch (parse_kind) {
  769. #define CARBON_PARSE_NODE_KIND(Name) \
  770. case Parse::NodeKind::Name: { \
  771. if (!HandleParseNode(context, Parse::Name##Id(node_id))) { \
  772. CARBON_CHECK(err_tracker.seen_error()) \
  773. << "Handle" #Name " returned false without printing a diagnostic"; \
  774. return false; \
  775. } \
  776. break; \
  777. }
  778. #include "toolchain/parse/node_kind.def"
  779. }
  780. traversal.Handle(parse_kind);
  781. }
  782. return true;
  783. }
  784. // Produces and checks the IR for the provided Parse::Tree.
  785. static auto CheckParseTree(
  786. llvm::MutableArrayRef<Parse::NodeLocConverter*> node_converters,
  787. UnitInfo& unit_info, int total_ir_count, llvm::raw_ostream* vlog_stream)
  788. -> void {
  789. unit_info.unit->sem_ir->emplace(
  790. unit_info.check_ir_id, *unit_info.unit->value_stores,
  791. unit_info.unit->tokens->source().filename().str());
  792. SemIR::File& sem_ir = **unit_info.unit->sem_ir;
  793. SemIRDiagnosticConverter converter(node_converters, &sem_ir);
  794. Context::DiagnosticEmitter emitter(converter, unit_info.err_tracker);
  795. Context context(*unit_info.unit->tokens, emitter, *unit_info.unit->parse_tree,
  796. sem_ir, vlog_stream);
  797. PrettyStackTraceFunction context_dumper(
  798. [&](llvm::raw_ostream& output) { context.PrintForStackDump(output); });
  799. // Add a block for the file.
  800. context.inst_block_stack().Push();
  801. InitPackageScopeAndImports(context, unit_info, total_ir_count);
  802. // Import all impls declared in imports.
  803. // TODO: Do this selectively when we see an impl query.
  804. ImportImpls(context);
  805. if (!ProcessNodeIds(context, vlog_stream, unit_info.err_tracker,
  806. &unit_info.converter)) {
  807. context.sem_ir().set_has_errors(true);
  808. return;
  809. }
  810. context.Finalize();
  811. DiagnoseMissingDefinitions(context, emitter);
  812. context.VerifyOnFinish();
  813. sem_ir.set_has_errors(unit_info.err_tracker.seen_error());
  814. #ifndef NDEBUG
  815. if (auto verify = sem_ir.Verify(); !verify.ok()) {
  816. CARBON_FATAL() << sem_ir << "Built invalid semantics IR: " << verify.error()
  817. << "\n";
  818. }
  819. #endif
  820. }
  821. // The package and library names, used as map keys.
  822. using ImportKey = std::pair<llvm::StringRef, llvm::StringRef>;
  823. // Returns a key form of the package object. file_package_id is only used for
  824. // imports, not the main package declaration; as a consequence, it will be
  825. // invalid for the main package declaration.
  826. static auto GetImportKey(UnitInfo& unit_info, IdentifierId file_package_id,
  827. Parse::Tree::PackagingNames names) -> ImportKey {
  828. auto* stores = unit_info.unit->value_stores;
  829. llvm::StringRef package_name =
  830. names.package_id.is_valid() ? stores->identifiers().Get(names.package_id)
  831. : file_package_id.is_valid() ? stores->identifiers().Get(file_package_id)
  832. : "";
  833. llvm::StringRef library_name =
  834. names.library_id.is_valid()
  835. ? stores->string_literal_values().Get(names.library_id)
  836. : "";
  837. return {package_name, library_name};
  838. }
  839. static constexpr llvm::StringLiteral ExplicitMainName = "Main";
  840. static auto RenderImportKey(ImportKey import_key) -> std::string {
  841. if (import_key.first.empty()) {
  842. import_key.first = ExplicitMainName;
  843. }
  844. if (import_key.second.empty()) {
  845. return import_key.first.str();
  846. }
  847. return llvm::formatv("{0}//{1}", import_key.first, import_key.second).str();
  848. }
  849. // Marks an import as required on both the source and target file.
  850. //
  851. // The ID comparisons between the import and unit are okay because they both
  852. // come from the same file.
  853. static auto TrackImport(Map<ImportKey, UnitInfo*>& api_map,
  854. Map<ImportKey, Parse::NodeId>* explicit_import_map,
  855. UnitInfo& unit_info, Parse::Tree::PackagingNames import)
  856. -> void {
  857. const auto& packaging = unit_info.unit->parse_tree->packaging_decl();
  858. IdentifierId file_package_id =
  859. packaging ? packaging->names.package_id : IdentifierId::Invalid;
  860. auto import_key = GetImportKey(unit_info, file_package_id, import);
  861. // True if the import has `Main` as the package name, even if it comes from
  862. // the file's packaging (diagnostics may differentiate).
  863. bool is_explicit_main = import_key.first == ExplicitMainName;
  864. // Explicit imports need more validation than implicit ones. We try to do
  865. // these in an order of imports that should be removed, followed by imports
  866. // that might be valid with syntax fixes.
  867. if (explicit_import_map) {
  868. // Diagnose redundant imports.
  869. if (auto insert_result =
  870. explicit_import_map->Insert(import_key, import.node_id);
  871. !insert_result.is_inserted()) {
  872. CARBON_DIAGNOSTIC(RepeatedImport, Error,
  873. "Library imported more than once.");
  874. CARBON_DIAGNOSTIC(FirstImported, Note, "First import here.");
  875. unit_info.emitter.Build(import.node_id, RepeatedImport)
  876. .Note(insert_result.value(), FirstImported)
  877. .Emit();
  878. return;
  879. }
  880. // True if the file's package is implicitly `Main` (by omitting an explicit
  881. // package name).
  882. bool is_file_implicit_main =
  883. !packaging || !packaging->names.package_id.is_valid();
  884. // True if the import is using implicit "current package" syntax (by
  885. // omitting an explicit package name).
  886. bool is_import_implicit_current_package = !import.package_id.is_valid();
  887. // True if the import is using `default` library syntax.
  888. bool is_import_default_library = !import.library_id.is_valid();
  889. // True if the import and file point at the same package, even by
  890. // incorrectly specifying the current package name to `import`.
  891. bool is_same_package = is_import_implicit_current_package ||
  892. import.package_id == file_package_id;
  893. // True if the import points at the same library as the file's library.
  894. bool is_same_library =
  895. is_same_package &&
  896. (packaging ? import.library_id == packaging->names.library_id
  897. : is_import_default_library);
  898. // Diagnose explicit imports of the same library, whether from `api` or
  899. // `impl`.
  900. if (is_same_library) {
  901. CARBON_DIAGNOSTIC(ExplicitImportApi, Error,
  902. "Explicit import of `api` from `impl` file is "
  903. "redundant with implicit import.");
  904. CARBON_DIAGNOSTIC(ImportSelf, Error, "File cannot import itself.");
  905. bool is_impl = !packaging || packaging->is_impl;
  906. unit_info.emitter.Emit(import.node_id,
  907. is_impl ? ExplicitImportApi : ImportSelf);
  908. return;
  909. }
  910. // Diagnose explicit imports of `Main//default`. There is no `api` for it.
  911. // This lets other diagnostics handle explicit `Main` package naming.
  912. if (is_file_implicit_main && is_import_implicit_current_package &&
  913. is_import_default_library) {
  914. CARBON_DIAGNOSTIC(ImportMainDefaultLibrary, Error,
  915. "Cannot import `Main//default`.");
  916. unit_info.emitter.Emit(import.node_id, ImportMainDefaultLibrary);
  917. return;
  918. }
  919. if (!is_import_implicit_current_package) {
  920. // Diagnose explicit imports of the same package that use the package
  921. // name.
  922. if (is_same_package || (is_file_implicit_main && is_explicit_main)) {
  923. CARBON_DIAGNOSTIC(
  924. ImportCurrentPackageByName, Error,
  925. "Imports from the current package must omit the package name.");
  926. unit_info.emitter.Emit(import.node_id, ImportCurrentPackageByName);
  927. return;
  928. }
  929. // Diagnose explicit imports from `Main`.
  930. if (is_explicit_main) {
  931. CARBON_DIAGNOSTIC(ImportMainPackage, Error,
  932. "Cannot import `Main` from other packages.");
  933. unit_info.emitter.Emit(import.node_id, ImportMainPackage);
  934. return;
  935. }
  936. }
  937. } else if (is_explicit_main) {
  938. // An implicit import with an explicit `Main` occurs when a `package` rule
  939. // has bad syntax, which will have been diagnosed when building the API map.
  940. // As a consequence, we return silently.
  941. return;
  942. }
  943. // Get the package imports, or create them if this is the first.
  944. auto create_imports = [&]() -> int32_t {
  945. int32_t index = unit_info.package_imports.size();
  946. unit_info.package_imports.push_back(
  947. UnitInfo::PackageImports(import.package_id, import.node_id));
  948. return index;
  949. };
  950. auto insert_result =
  951. unit_info.package_imports_map.Insert(import.package_id, create_imports);
  952. UnitInfo::PackageImports& package_imports =
  953. unit_info.package_imports[insert_result.value()];
  954. if (auto api_lookup = api_map.Lookup(import_key)) {
  955. // Add references between the file and imported api.
  956. UnitInfo* api = api_lookup.value();
  957. package_imports.imports.push_back({import, api});
  958. ++unit_info.imports_remaining;
  959. api->incoming_imports.push_back(&unit_info);
  960. // If this is the implicit import, note we have it.
  961. if (!explicit_import_map) {
  962. CARBON_CHECK(!unit_info.api_for_impl);
  963. unit_info.api_for_impl = api;
  964. }
  965. } else {
  966. // The imported api is missing.
  967. package_imports.has_load_error = true;
  968. CARBON_DIAGNOSTIC(LibraryApiNotFound, Error,
  969. "Corresponding API for '{0}' not found.", std::string);
  970. CARBON_DIAGNOSTIC(ImportNotFound, Error, "Imported API '{0}' not found.",
  971. std::string);
  972. unit_info.emitter.Emit(
  973. import.node_id,
  974. explicit_import_map ? ImportNotFound : LibraryApiNotFound,
  975. RenderImportKey(import_key));
  976. }
  977. }
  978. // Builds a map of `api` files which might be imported. Also diagnoses issues
  979. // related to the packaging because the strings are loaded as part of getting
  980. // the ImportKey (which we then do for `impl` files too).
  981. static auto BuildApiMapAndDiagnosePackaging(
  982. llvm::MutableArrayRef<UnitInfo> unit_infos) -> Map<ImportKey, UnitInfo*> {
  983. Map<ImportKey, UnitInfo*> api_map;
  984. for (auto& unit_info : unit_infos) {
  985. const auto& packaging = unit_info.unit->parse_tree->packaging_decl();
  986. // An import key formed from the `package` or `library` declaration. Or, for
  987. // Main//default, a placeholder key.
  988. auto import_key = packaging ? GetImportKey(unit_info, IdentifierId::Invalid,
  989. packaging->names)
  990. // Construct a boring key for Main//default.
  991. : ImportKey{"", ""};
  992. // Diagnose explicit `Main` uses before they become marked as possible
  993. // APIs.
  994. if (import_key.first == ExplicitMainName) {
  995. CARBON_DIAGNOSTIC(ExplicitMainPackage, Error,
  996. "`Main//default` must omit `package` declaration.");
  997. CARBON_DIAGNOSTIC(
  998. ExplicitMainLibrary, Error,
  999. "Use `library` declaration in `Main` package libraries.");
  1000. unit_info.emitter.Emit(packaging->names.node_id,
  1001. import_key.second.empty() ? ExplicitMainPackage
  1002. : ExplicitMainLibrary);
  1003. continue;
  1004. }
  1005. bool is_impl = packaging && packaging->is_impl;
  1006. // Add to the `api` map and diagnose duplicates. This occurs before the
  1007. // file extension check because we might emit both diagnostics in situations
  1008. // where the user forgets (or has syntax errors with) a package line
  1009. // multiple times.
  1010. if (!is_impl) {
  1011. auto insert_result = api_map.Insert(import_key, &unit_info);
  1012. if (!insert_result.is_inserted()) {
  1013. llvm::StringRef prev_filename =
  1014. insert_result.value()->unit->tokens->source().filename();
  1015. if (packaging) {
  1016. CARBON_DIAGNOSTIC(DuplicateLibraryApi, Error,
  1017. "Library's API previously provided by `{0}`.",
  1018. std::string);
  1019. unit_info.emitter.Emit(packaging->names.node_id, DuplicateLibraryApi,
  1020. prev_filename.str());
  1021. } else {
  1022. CARBON_DIAGNOSTIC(DuplicateMainApi, Error,
  1023. "Main//default previously provided by `{0}`.",
  1024. std::string);
  1025. // Use the invalid node because there's no node to associate with.
  1026. unit_info.emitter.Emit(Parse::NodeId::Invalid, DuplicateMainApi,
  1027. prev_filename.str());
  1028. }
  1029. }
  1030. }
  1031. // Validate file extensions. Note imports rely the packaging declaration,
  1032. // not the extension. If the input is not a regular file, for example
  1033. // because it is stdin, no filename checking is performed.
  1034. if (unit_info.unit->tokens->source().is_regular_file()) {
  1035. auto filename = unit_info.unit->tokens->source().filename();
  1036. static constexpr llvm::StringLiteral ApiExt = ".carbon";
  1037. static constexpr llvm::StringLiteral ImplExt = ".impl.carbon";
  1038. bool is_api_with_impl_ext = !is_impl && filename.ends_with(ImplExt);
  1039. auto want_ext = is_impl ? ImplExt : ApiExt;
  1040. if (is_api_with_impl_ext || !filename.ends_with(want_ext)) {
  1041. CARBON_DIAGNOSTIC(IncorrectExtension, Error,
  1042. "File extension of `{0}` required for `{1}`.",
  1043. llvm::StringLiteral, Lex::TokenKind);
  1044. auto diag = unit_info.emitter.Build(
  1045. packaging ? packaging->names.node_id : Parse::NodeId::Invalid,
  1046. IncorrectExtension, want_ext,
  1047. is_impl ? Lex::TokenKind::Impl : Lex::TokenKind::Api);
  1048. if (is_api_with_impl_ext) {
  1049. CARBON_DIAGNOSTIC(IncorrectExtensionImplNote, Note,
  1050. "File extension of `{0}` only allowed for `{1}`.",
  1051. llvm::StringLiteral, Lex::TokenKind);
  1052. diag.Note(Parse::NodeId::Invalid, IncorrectExtensionImplNote, ImplExt,
  1053. Lex::TokenKind::Impl);
  1054. }
  1055. diag.Emit();
  1056. }
  1057. }
  1058. }
  1059. return api_map;
  1060. }
  1061. auto CheckParseTrees(llvm::MutableArrayRef<Unit> units, bool prelude_import,
  1062. llvm::raw_ostream* vlog_stream) -> void {
  1063. // Prepare diagnostic emitters in case we run into issues during package
  1064. // checking.
  1065. //
  1066. // UnitInfo is big due to its SmallVectors, so we default to 0 on the stack.
  1067. llvm::SmallVector<UnitInfo, 0> unit_infos;
  1068. unit_infos.reserve(units.size());
  1069. llvm::SmallVector<Parse::NodeLocConverter*> node_converters;
  1070. node_converters.reserve(units.size());
  1071. for (auto [i, unit] : llvm::enumerate(units)) {
  1072. unit_infos.emplace_back(SemIR::CheckIRId(i), unit);
  1073. node_converters.push_back(&unit_infos.back().converter);
  1074. }
  1075. Map<ImportKey, UnitInfo*> api_map =
  1076. BuildApiMapAndDiagnosePackaging(unit_infos);
  1077. // Mark down imports for all files.
  1078. llvm::SmallVector<UnitInfo*> ready_to_check;
  1079. ready_to_check.reserve(units.size());
  1080. for (auto& unit_info : unit_infos) {
  1081. const auto& packaging = unit_info.unit->parse_tree->packaging_decl();
  1082. if (packaging && packaging->is_impl) {
  1083. // An `impl` has an implicit import of its `api`.
  1084. auto implicit_names = packaging->names;
  1085. implicit_names.package_id = IdentifierId::Invalid;
  1086. TrackImport(api_map, nullptr, unit_info, implicit_names);
  1087. }
  1088. Map<ImportKey, Parse::NodeId> explicit_import_map;
  1089. // Add the prelude import. It's added to explicit_import_map so that it can
  1090. // conflict with an explicit import of the prelude.
  1091. IdentifierId core_ident_id =
  1092. unit_info.unit->value_stores->identifiers().Add("Core");
  1093. if (prelude_import &&
  1094. !(packaging && packaging->names.package_id == core_ident_id)) {
  1095. auto prelude_id =
  1096. unit_info.unit->value_stores->string_literal_values().Add("prelude");
  1097. TrackImport(api_map, &explicit_import_map, unit_info,
  1098. {.node_id = Parse::InvalidNodeId(),
  1099. .package_id = core_ident_id,
  1100. .library_id = prelude_id});
  1101. }
  1102. for (const auto& import : unit_info.unit->parse_tree->imports()) {
  1103. TrackImport(api_map, &explicit_import_map, unit_info, import);
  1104. }
  1105. // If there were no imports, mark the file as ready to check for below.
  1106. if (unit_info.imports_remaining == 0) {
  1107. ready_to_check.push_back(&unit_info);
  1108. }
  1109. }
  1110. // Check everything with no dependencies. Earlier entries with dependencies
  1111. // will be checked as soon as all their dependencies have been checked.
  1112. for (int check_index = 0;
  1113. check_index < static_cast<int>(ready_to_check.size()); ++check_index) {
  1114. auto* unit_info = ready_to_check[check_index];
  1115. CheckParseTree(node_converters, *unit_info, units.size(), vlog_stream);
  1116. for (auto* incoming_import : unit_info->incoming_imports) {
  1117. --incoming_import->imports_remaining;
  1118. if (incoming_import->imports_remaining == 0) {
  1119. ready_to_check.push_back(incoming_import);
  1120. }
  1121. }
  1122. }
  1123. // If there are still units with remaining imports, it means there's a
  1124. // dependency loop.
  1125. if (ready_to_check.size() < unit_infos.size()) {
  1126. // Go through units and mask out unevaluated imports. This breaks everything
  1127. // associated with a loop equivalently, whether it's part of it or depending
  1128. // on a part of it.
  1129. // TODO: Better identify cycles, maybe try to untangle them.
  1130. for (auto& unit_info : unit_infos) {
  1131. if (unit_info.imports_remaining > 0) {
  1132. for (auto& package_imports : unit_info.package_imports) {
  1133. for (auto* import_it = package_imports.imports.begin();
  1134. import_it != package_imports.imports.end();) {
  1135. if (*import_it->unit_info->unit->sem_ir) {
  1136. // The import is checked, so continue.
  1137. ++import_it;
  1138. } else {
  1139. // The import hasn't been checked, indicating a cycle.
  1140. CARBON_DIAGNOSTIC(ImportCycleDetected, Error,
  1141. "Import cannot be used due to a cycle. Cycle "
  1142. "must be fixed to import.");
  1143. unit_info.emitter.Emit(import_it->names.node_id,
  1144. ImportCycleDetected);
  1145. // Make this look the same as an import which wasn't found.
  1146. package_imports.has_load_error = true;
  1147. if (unit_info.api_for_impl == import_it->unit_info) {
  1148. unit_info.api_for_impl = nullptr;
  1149. }
  1150. import_it = package_imports.imports.erase(import_it);
  1151. }
  1152. }
  1153. }
  1154. }
  1155. }
  1156. // Check the remaining file contents, which are probably broken due to
  1157. // incomplete imports.
  1158. for (auto& unit_info : unit_infos) {
  1159. if (unit_info.imports_remaining > 0) {
  1160. CheckParseTree(node_converters, unit_info, units.size(), vlog_stream);
  1161. }
  1162. }
  1163. }
  1164. }
  1165. } // namespace Carbon::Check