check.cpp 52 KB

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