1 //===--- SemaModule.cpp - Semantic Analysis for Modules -------------------===//
2 //
3 // Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions.
4 // See https://llvm.org/LICENSE.txt for license information.
5 // SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception
6 //
7 //===----------------------------------------------------------------------===//
8 //
9 //  This file implements semantic analysis for modules (C++ modules syntax,
10 //  Objective-C modules syntax, and Clang header modules).
11 //
12 //===----------------------------------------------------------------------===//
13 
14 #include "clang/AST/ASTConsumer.h"
15 #include "clang/Lex/HeaderSearch.h"
16 #include "clang/Lex/Preprocessor.h"
17 #include "clang/Sema/SemaInternal.h"
18 
19 using namespace clang;
20 using namespace sema;
21 
22 static void checkModuleImportContext(Sema &S, Module *M,
23                                      SourceLocation ImportLoc, DeclContext *DC,
24                                      bool FromInclude = false) {
25   SourceLocation ExternCLoc;
26 
27   if (auto *LSD = dyn_cast<LinkageSpecDecl>(DC)) {
28     switch (LSD->getLanguage()) {
29     case LinkageSpecDecl::lang_c:
30       if (ExternCLoc.isInvalid())
31         ExternCLoc = LSD->getBeginLoc();
32       break;
33     case LinkageSpecDecl::lang_cxx:
34       break;
35     }
36     DC = LSD->getParent();
37   }
38 
39   while (isa<LinkageSpecDecl>(DC) || isa<ExportDecl>(DC))
40     DC = DC->getParent();
41 
42   if (!isa<TranslationUnitDecl>(DC)) {
43     S.Diag(ImportLoc, (FromInclude && S.isModuleVisible(M))
44                           ? diag::ext_module_import_not_at_top_level_noop
45                           : diag::err_module_import_not_at_top_level_fatal)
46         << M->getFullModuleName() << DC;
47     S.Diag(cast<Decl>(DC)->getBeginLoc(),
48            diag::note_module_import_not_at_top_level)
49         << DC;
50   } else if (!M->IsExternC && ExternCLoc.isValid()) {
51     S.Diag(ImportLoc, diag::ext_module_import_in_extern_c)
52       << M->getFullModuleName();
53     S.Diag(ExternCLoc, diag::note_extern_c_begins_here);
54   }
55 }
56 
57 Sema::DeclGroupPtrTy
58 Sema::ActOnGlobalModuleFragmentDecl(SourceLocation ModuleLoc) {
59   if (!ModuleScopes.empty() &&
60       ModuleScopes.back().Module->Kind == Module::GlobalModuleFragment) {
61     // Under -std=c++2a -fmodules-ts, we can find an explicit 'module;' after
62     // already implicitly entering the global module fragment. That's OK.
63     assert(getLangOpts().CPlusPlusModules && getLangOpts().ModulesTS &&
64            "unexpectedly encountered multiple global module fragment decls");
65     ModuleScopes.back().BeginLoc = ModuleLoc;
66     return nullptr;
67   }
68 
69   // We start in the global module; all those declarations are implicitly
70   // module-private (though they do not have module linkage).
71   Module *GlobalModule =
72       PushGlobalModuleFragment(ModuleLoc, /*IsImplicit=*/false);
73 
74   // All declarations created from now on are owned by the global module.
75   auto *TU = Context.getTranslationUnitDecl();
76   TU->setModuleOwnershipKind(Decl::ModuleOwnershipKind::Visible);
77   TU->setLocalOwningModule(GlobalModule);
78 
79   // FIXME: Consider creating an explicit representation of this declaration.
80   return nullptr;
81 }
82 
83 Sema::DeclGroupPtrTy
84 Sema::ActOnModuleDecl(SourceLocation StartLoc, SourceLocation ModuleLoc,
85                       ModuleDeclKind MDK, ModuleIdPath Path, bool IsFirstDecl) {
86   assert((getLangOpts().ModulesTS || getLangOpts().CPlusPlusModules) &&
87          "should only have module decl in Modules TS or C++20");
88 
89   // A module implementation unit requires that we are not compiling a module
90   // of any kind. A module interface unit requires that we are not compiling a
91   // module map.
92   switch (getLangOpts().getCompilingModule()) {
93   case LangOptions::CMK_None:
94     // It's OK to compile a module interface as a normal translation unit.
95     break;
96 
97   case LangOptions::CMK_ModuleInterface:
98     if (MDK != ModuleDeclKind::Implementation)
99       break;
100 
101     // We were asked to compile a module interface unit but this is a module
102     // implementation unit. That indicates the 'export' is missing.
103     Diag(ModuleLoc, diag::err_module_interface_implementation_mismatch)
104       << FixItHint::CreateInsertion(ModuleLoc, "export ");
105     MDK = ModuleDeclKind::Interface;
106     break;
107 
108   case LangOptions::CMK_ModuleMap:
109     Diag(ModuleLoc, diag::err_module_decl_in_module_map_module);
110     return nullptr;
111 
112   case LangOptions::CMK_HeaderModule:
113     Diag(ModuleLoc, diag::err_module_decl_in_header_module);
114     return nullptr;
115   }
116 
117   assert(ModuleScopes.size() <= 1 && "expected to be at global module scope");
118 
119   // FIXME: Most of this work should be done by the preprocessor rather than
120   // here, in order to support macro import.
121 
122   // Only one module-declaration is permitted per source file.
123   if (!ModuleScopes.empty() &&
124       ModuleScopes.back().Module->isModulePurview()) {
125     Diag(ModuleLoc, diag::err_module_redeclaration);
126     Diag(VisibleModules.getImportLoc(ModuleScopes.back().Module),
127          diag::note_prev_module_declaration);
128     return nullptr;
129   }
130 
131   // Find the global module fragment we're adopting into this module, if any.
132   Module *GlobalModuleFragment = nullptr;
133   if (!ModuleScopes.empty() &&
134       ModuleScopes.back().Module->Kind == Module::GlobalModuleFragment)
135     GlobalModuleFragment = ModuleScopes.back().Module;
136 
137   // In C++20, the module-declaration must be the first declaration if there
138   // is no global module fragment.
139   if (getLangOpts().CPlusPlusModules && !IsFirstDecl && !GlobalModuleFragment) {
140     Diag(ModuleLoc, diag::err_module_decl_not_at_start);
141     SourceLocation BeginLoc =
142         ModuleScopes.empty()
143             ? SourceMgr.getLocForStartOfFile(SourceMgr.getMainFileID())
144             : ModuleScopes.back().BeginLoc;
145     if (BeginLoc.isValid()) {
146       Diag(BeginLoc, diag::note_global_module_introducer_missing)
147           << FixItHint::CreateInsertion(BeginLoc, "module;\n");
148     }
149   }
150 
151   // Flatten the dots in a module name. Unlike Clang's hierarchical module map
152   // modules, the dots here are just another character that can appear in a
153   // module name.
154   std::string ModuleName;
155   for (auto &Piece : Path) {
156     if (!ModuleName.empty())
157       ModuleName += ".";
158     ModuleName += Piece.first->getName();
159   }
160 
161   // If a module name was explicitly specified on the command line, it must be
162   // correct.
163   if (!getLangOpts().CurrentModule.empty() &&
164       getLangOpts().CurrentModule != ModuleName) {
165     Diag(Path.front().second, diag::err_current_module_name_mismatch)
166         << SourceRange(Path.front().second, Path.back().second)
167         << getLangOpts().CurrentModule;
168     return nullptr;
169   }
170   const_cast<LangOptions&>(getLangOpts()).CurrentModule = ModuleName;
171 
172   auto &Map = PP.getHeaderSearchInfo().getModuleMap();
173   Module *Mod;
174 
175   switch (MDK) {
176   case ModuleDeclKind::Interface: {
177     // We can't have parsed or imported a definition of this module or parsed a
178     // module map defining it already.
179     if (auto *M = Map.findModule(ModuleName)) {
180       Diag(Path[0].second, diag::err_module_redefinition) << ModuleName;
181       if (M->DefinitionLoc.isValid())
182         Diag(M->DefinitionLoc, diag::note_prev_module_definition);
183       else if (Optional<FileEntryRef> FE = M->getASTFile())
184         Diag(M->DefinitionLoc, diag::note_prev_module_definition_from_ast_file)
185             << FE->getName();
186       Mod = M;
187       break;
188     }
189 
190     // Create a Module for the module that we're defining.
191     Mod = Map.createModuleForInterfaceUnit(ModuleLoc, ModuleName,
192                                            GlobalModuleFragment);
193     assert(Mod && "module creation should not fail");
194     break;
195   }
196 
197   case ModuleDeclKind::Implementation:
198     std::pair<IdentifierInfo *, SourceLocation> ModuleNameLoc(
199         PP.getIdentifierInfo(ModuleName), Path[0].second);
200     Mod = getModuleLoader().loadModule(ModuleLoc, {ModuleNameLoc},
201                                        Module::AllVisible,
202                                        /*IsInclusionDirective=*/false);
203     if (!Mod) {
204       Diag(ModuleLoc, diag::err_module_not_defined) << ModuleName;
205       // Create an empty module interface unit for error recovery.
206       Mod = Map.createModuleForInterfaceUnit(ModuleLoc, ModuleName,
207                                              GlobalModuleFragment);
208     }
209     break;
210   }
211 
212   if (!GlobalModuleFragment) {
213     ModuleScopes.push_back({});
214     if (getLangOpts().ModulesLocalVisibility)
215       ModuleScopes.back().OuterVisibleModules = std::move(VisibleModules);
216   } else {
217     // We're done with the global module fragment now.
218     ActOnEndOfTranslationUnitFragment(TUFragmentKind::Global);
219   }
220 
221   // Switch from the global module fragment (if any) to the named module.
222   ModuleScopes.back().BeginLoc = StartLoc;
223   ModuleScopes.back().Module = Mod;
224   ModuleScopes.back().ModuleInterface = MDK != ModuleDeclKind::Implementation;
225   VisibleModules.setVisible(Mod, ModuleLoc);
226 
227   // From now on, we have an owning module for all declarations we see.
228   // However, those declarations are module-private unless explicitly
229   // exported.
230   auto *TU = Context.getTranslationUnitDecl();
231   TU->setModuleOwnershipKind(Decl::ModuleOwnershipKind::ModulePrivate);
232   TU->setLocalOwningModule(Mod);
233 
234   // FIXME: Create a ModuleDecl.
235   return nullptr;
236 }
237 
238 Sema::DeclGroupPtrTy
239 Sema::ActOnPrivateModuleFragmentDecl(SourceLocation ModuleLoc,
240                                      SourceLocation PrivateLoc) {
241   // C++20 [basic.link]/2:
242   //   A private-module-fragment shall appear only in a primary module
243   //   interface unit.
244   switch (ModuleScopes.empty() ? Module::GlobalModuleFragment
245                                : ModuleScopes.back().Module->Kind) {
246   case Module::ModuleMapModule:
247   case Module::GlobalModuleFragment:
248     Diag(PrivateLoc, diag::err_private_module_fragment_not_module);
249     return nullptr;
250 
251   case Module::PrivateModuleFragment:
252     Diag(PrivateLoc, diag::err_private_module_fragment_redefined);
253     Diag(ModuleScopes.back().BeginLoc, diag::note_previous_definition);
254     return nullptr;
255 
256   case Module::ModuleInterfaceUnit:
257     break;
258   }
259 
260   if (!ModuleScopes.back().ModuleInterface) {
261     Diag(PrivateLoc, diag::err_private_module_fragment_not_module_interface);
262     Diag(ModuleScopes.back().BeginLoc,
263          diag::note_not_module_interface_add_export)
264         << FixItHint::CreateInsertion(ModuleScopes.back().BeginLoc, "export ");
265     return nullptr;
266   }
267 
268   // FIXME: Check this isn't a module interface partition.
269   // FIXME: Check that this translation unit does not import any partitions;
270   // such imports would violate [basic.link]/2's "shall be the only module unit"
271   // restriction.
272 
273   // We've finished the public fragment of the translation unit.
274   ActOnEndOfTranslationUnitFragment(TUFragmentKind::Normal);
275 
276   auto &Map = PP.getHeaderSearchInfo().getModuleMap();
277   Module *PrivateModuleFragment =
278       Map.createPrivateModuleFragmentForInterfaceUnit(
279           ModuleScopes.back().Module, PrivateLoc);
280   assert(PrivateModuleFragment && "module creation should not fail");
281 
282   // Enter the scope of the private module fragment.
283   ModuleScopes.push_back({});
284   ModuleScopes.back().BeginLoc = ModuleLoc;
285   ModuleScopes.back().Module = PrivateModuleFragment;
286   ModuleScopes.back().ModuleInterface = true;
287   VisibleModules.setVisible(PrivateModuleFragment, ModuleLoc);
288 
289   // All declarations created from now on are scoped to the private module
290   // fragment (and are neither visible nor reachable in importers of the module
291   // interface).
292   auto *TU = Context.getTranslationUnitDecl();
293   TU->setModuleOwnershipKind(Decl::ModuleOwnershipKind::ModulePrivate);
294   TU->setLocalOwningModule(PrivateModuleFragment);
295 
296   // FIXME: Consider creating an explicit representation of this declaration.
297   return nullptr;
298 }
299 
300 DeclResult Sema::ActOnModuleImport(SourceLocation StartLoc,
301                                    SourceLocation ExportLoc,
302                                    SourceLocation ImportLoc,
303                                    ModuleIdPath Path) {
304   // Flatten the module path for a Modules TS module name.
305   std::pair<IdentifierInfo *, SourceLocation> ModuleNameLoc;
306   if (getLangOpts().ModulesTS) {
307     std::string ModuleName;
308     for (auto &Piece : Path) {
309       if (!ModuleName.empty())
310         ModuleName += ".";
311       ModuleName += Piece.first->getName();
312     }
313     ModuleNameLoc = {PP.getIdentifierInfo(ModuleName), Path[0].second};
314     Path = ModuleIdPath(ModuleNameLoc);
315   }
316 
317   Module *Mod =
318       getModuleLoader().loadModule(ImportLoc, Path, Module::AllVisible,
319                                    /*IsInclusionDirective=*/false);
320   if (!Mod)
321     return true;
322 
323   return ActOnModuleImport(StartLoc, ExportLoc, ImportLoc, Mod, Path);
324 }
325 
326 /// Determine whether \p D is lexically within an export-declaration.
327 static const ExportDecl *getEnclosingExportDecl(const Decl *D) {
328   for (auto *DC = D->getLexicalDeclContext(); DC; DC = DC->getLexicalParent())
329     if (auto *ED = dyn_cast<ExportDecl>(DC))
330       return ED;
331   return nullptr;
332 }
333 
334 DeclResult Sema::ActOnModuleImport(SourceLocation StartLoc,
335                                    SourceLocation ExportLoc,
336                                    SourceLocation ImportLoc,
337                                    Module *Mod, ModuleIdPath Path) {
338   VisibleModules.setVisible(Mod, ImportLoc);
339 
340   checkModuleImportContext(*this, Mod, ImportLoc, CurContext);
341 
342   // FIXME: we should support importing a submodule within a different submodule
343   // of the same top-level module. Until we do, make it an error rather than
344   // silently ignoring the import.
345   // Import-from-implementation is valid in the Modules TS. FIXME: Should we
346   // warn on a redundant import of the current module?
347   // FIXME: Import of a module from an implementation partition of the same
348   // module is permitted.
349   if (Mod->getTopLevelModuleName() == getLangOpts().CurrentModule &&
350       (getLangOpts().isCompilingModule() || !getLangOpts().ModulesTS)) {
351     Diag(ImportLoc, getLangOpts().isCompilingModule()
352                         ? diag::err_module_self_import
353                         : diag::err_module_import_in_implementation)
354         << Mod->getFullModuleName() << getLangOpts().CurrentModule;
355   }
356 
357   SmallVector<SourceLocation, 2> IdentifierLocs;
358   Module *ModCheck = Mod;
359   for (unsigned I = 0, N = Path.size(); I != N; ++I) {
360     // If we've run out of module parents, just drop the remaining identifiers.
361     // We need the length to be consistent.
362     if (!ModCheck)
363       break;
364     ModCheck = ModCheck->Parent;
365 
366     IdentifierLocs.push_back(Path[I].second);
367   }
368 
369   // If this was a header import, pad out with dummy locations.
370   // FIXME: Pass in and use the location of the header-name token in this case.
371   if (Path.empty()) {
372     for (; ModCheck; ModCheck = ModCheck->Parent) {
373       IdentifierLocs.push_back(SourceLocation());
374     }
375   }
376 
377   ImportDecl *Import = ImportDecl::Create(Context, CurContext, StartLoc,
378                                           Mod, IdentifierLocs);
379   CurContext->addDecl(Import);
380 
381   // Sequence initialization of the imported module before that of the current
382   // module, if any.
383   if (!ModuleScopes.empty())
384     Context.addModuleInitializer(ModuleScopes.back().Module, Import);
385 
386   // Re-export the module if needed.
387   if (!ModuleScopes.empty() && ModuleScopes.back().ModuleInterface) {
388     if (ExportLoc.isValid() || getEnclosingExportDecl(Import))
389       getCurrentModule()->Exports.emplace_back(Mod, false);
390   } else if (ExportLoc.isValid()) {
391     Diag(ExportLoc, diag::err_export_not_in_module_interface);
392   }
393 
394   return Import;
395 }
396 
397 void Sema::ActOnModuleInclude(SourceLocation DirectiveLoc, Module *Mod) {
398   checkModuleImportContext(*this, Mod, DirectiveLoc, CurContext, true);
399   BuildModuleInclude(DirectiveLoc, Mod);
400 }
401 
402 void Sema::BuildModuleInclude(SourceLocation DirectiveLoc, Module *Mod) {
403   // Determine whether we're in the #include buffer for a module. The #includes
404   // in that buffer do not qualify as module imports; they're just an
405   // implementation detail of us building the module.
406   //
407   // FIXME: Should we even get ActOnModuleInclude calls for those?
408   bool IsInModuleIncludes =
409       TUKind == TU_Module &&
410       getSourceManager().isWrittenInMainFile(DirectiveLoc);
411 
412   bool ShouldAddImport = !IsInModuleIncludes;
413 
414   // If this module import was due to an inclusion directive, create an
415   // implicit import declaration to capture it in the AST.
416   if (ShouldAddImport) {
417     TranslationUnitDecl *TU = getASTContext().getTranslationUnitDecl();
418     ImportDecl *ImportD = ImportDecl::CreateImplicit(getASTContext(), TU,
419                                                      DirectiveLoc, Mod,
420                                                      DirectiveLoc);
421     if (!ModuleScopes.empty())
422       Context.addModuleInitializer(ModuleScopes.back().Module, ImportD);
423     TU->addDecl(ImportD);
424     Consumer.HandleImplicitImportDecl(ImportD);
425   }
426 
427   getModuleLoader().makeModuleVisible(Mod, Module::AllVisible, DirectiveLoc);
428   VisibleModules.setVisible(Mod, DirectiveLoc);
429 }
430 
431 void Sema::ActOnModuleBegin(SourceLocation DirectiveLoc, Module *Mod) {
432   checkModuleImportContext(*this, Mod, DirectiveLoc, CurContext, true);
433 
434   ModuleScopes.push_back({});
435   ModuleScopes.back().Module = Mod;
436   if (getLangOpts().ModulesLocalVisibility)
437     ModuleScopes.back().OuterVisibleModules = std::move(VisibleModules);
438 
439   VisibleModules.setVisible(Mod, DirectiveLoc);
440 
441   // The enclosing context is now part of this module.
442   // FIXME: Consider creating a child DeclContext to hold the entities
443   // lexically within the module.
444   if (getLangOpts().trackLocalOwningModule()) {
445     for (auto *DC = CurContext; DC; DC = DC->getLexicalParent()) {
446       cast<Decl>(DC)->setModuleOwnershipKind(
447           getLangOpts().ModulesLocalVisibility
448               ? Decl::ModuleOwnershipKind::VisibleWhenImported
449               : Decl::ModuleOwnershipKind::Visible);
450       cast<Decl>(DC)->setLocalOwningModule(Mod);
451     }
452   }
453 }
454 
455 void Sema::ActOnModuleEnd(SourceLocation EomLoc, Module *Mod) {
456   if (getLangOpts().ModulesLocalVisibility) {
457     VisibleModules = std::move(ModuleScopes.back().OuterVisibleModules);
458     // Leaving a module hides namespace names, so our visible namespace cache
459     // is now out of date.
460     VisibleNamespaceCache.clear();
461   }
462 
463   assert(!ModuleScopes.empty() && ModuleScopes.back().Module == Mod &&
464          "left the wrong module scope");
465   ModuleScopes.pop_back();
466 
467   // We got to the end of processing a local module. Create an
468   // ImportDecl as we would for an imported module.
469   FileID File = getSourceManager().getFileID(EomLoc);
470   SourceLocation DirectiveLoc;
471   if (EomLoc == getSourceManager().getLocForEndOfFile(File)) {
472     // We reached the end of a #included module header. Use the #include loc.
473     assert(File != getSourceManager().getMainFileID() &&
474            "end of submodule in main source file");
475     DirectiveLoc = getSourceManager().getIncludeLoc(File);
476   } else {
477     // We reached an EOM pragma. Use the pragma location.
478     DirectiveLoc = EomLoc;
479   }
480   BuildModuleInclude(DirectiveLoc, Mod);
481 
482   // Any further declarations are in whatever module we returned to.
483   if (getLangOpts().trackLocalOwningModule()) {
484     // The parser guarantees that this is the same context that we entered
485     // the module within.
486     for (auto *DC = CurContext; DC; DC = DC->getLexicalParent()) {
487       cast<Decl>(DC)->setLocalOwningModule(getCurrentModule());
488       if (!getCurrentModule())
489         cast<Decl>(DC)->setModuleOwnershipKind(
490             Decl::ModuleOwnershipKind::Unowned);
491     }
492   }
493 }
494 
495 void Sema::createImplicitModuleImportForErrorRecovery(SourceLocation Loc,
496                                                       Module *Mod) {
497   // Bail if we're not allowed to implicitly import a module here.
498   if (isSFINAEContext() || !getLangOpts().ModulesErrorRecovery ||
499       VisibleModules.isVisible(Mod))
500     return;
501 
502   // Create the implicit import declaration.
503   TranslationUnitDecl *TU = getASTContext().getTranslationUnitDecl();
504   ImportDecl *ImportD = ImportDecl::CreateImplicit(getASTContext(), TU,
505                                                    Loc, Mod, Loc);
506   TU->addDecl(ImportD);
507   Consumer.HandleImplicitImportDecl(ImportD);
508 
509   // Make the module visible.
510   getModuleLoader().makeModuleVisible(Mod, Module::AllVisible, Loc);
511   VisibleModules.setVisible(Mod, Loc);
512 }
513 
514 /// We have parsed the start of an export declaration, including the '{'
515 /// (if present).
516 Decl *Sema::ActOnStartExportDecl(Scope *S, SourceLocation ExportLoc,
517                                  SourceLocation LBraceLoc) {
518   ExportDecl *D = ExportDecl::Create(Context, CurContext, ExportLoc);
519 
520   // Set this temporarily so we know the export-declaration was braced.
521   D->setRBraceLoc(LBraceLoc);
522 
523   // C++2a [module.interface]p1:
524   //   An export-declaration shall appear only [...] in the purview of a module
525   //   interface unit. An export-declaration shall not appear directly or
526   //   indirectly within [...] a private-module-fragment.
527   if (ModuleScopes.empty() || !ModuleScopes.back().Module->isModulePurview()) {
528     Diag(ExportLoc, diag::err_export_not_in_module_interface) << 0;
529   } else if (!ModuleScopes.back().ModuleInterface) {
530     Diag(ExportLoc, diag::err_export_not_in_module_interface) << 1;
531     Diag(ModuleScopes.back().BeginLoc,
532          diag::note_not_module_interface_add_export)
533         << FixItHint::CreateInsertion(ModuleScopes.back().BeginLoc, "export ");
534   } else if (ModuleScopes.back().Module->Kind ==
535              Module::PrivateModuleFragment) {
536     Diag(ExportLoc, diag::err_export_in_private_module_fragment);
537     Diag(ModuleScopes.back().BeginLoc, diag::note_private_module_fragment);
538   }
539 
540   for (const DeclContext *DC = CurContext; DC; DC = DC->getLexicalParent()) {
541     if (const auto *ND = dyn_cast<NamespaceDecl>(DC)) {
542       //   An export-declaration shall not appear directly or indirectly within
543       //   an unnamed namespace [...]
544       if (ND->isAnonymousNamespace()) {
545         Diag(ExportLoc, diag::err_export_within_anonymous_namespace);
546         Diag(ND->getLocation(), diag::note_anonymous_namespace);
547         // Don't diagnose internal-linkage declarations in this region.
548         D->setInvalidDecl();
549         break;
550       }
551 
552       //   A declaration is exported if it is [...] a namespace-definition
553       //   that contains an exported declaration.
554       //
555       // Defer exporting the namespace until after we leave it, in order to
556       // avoid marking all subsequent declarations in the namespace as exported.
557       if (!DeferredExportedNamespaces.insert(ND).second)
558         break;
559     }
560   }
561 
562   //   [...] its declaration or declaration-seq shall not contain an
563   //   export-declaration.
564   if (auto *ED = getEnclosingExportDecl(D)) {
565     Diag(ExportLoc, diag::err_export_within_export);
566     if (ED->hasBraces())
567       Diag(ED->getLocation(), diag::note_export);
568   }
569 
570   CurContext->addDecl(D);
571   PushDeclContext(S, D);
572   D->setModuleOwnershipKind(Decl::ModuleOwnershipKind::VisibleWhenImported);
573   return D;
574 }
575 
576 static bool checkExportedDeclContext(Sema &S, DeclContext *DC,
577                                      SourceLocation BlockStart);
578 
579 namespace {
580 enum class UnnamedDeclKind {
581   Empty,
582   StaticAssert,
583   Asm,
584   UsingDirective,
585   Context
586 };
587 }
588 
589 static llvm::Optional<UnnamedDeclKind> getUnnamedDeclKind(Decl *D) {
590   if (isa<EmptyDecl>(D))
591     return UnnamedDeclKind::Empty;
592   if (isa<StaticAssertDecl>(D))
593     return UnnamedDeclKind::StaticAssert;
594   if (isa<FileScopeAsmDecl>(D))
595     return UnnamedDeclKind::Asm;
596   if (isa<UsingDirectiveDecl>(D))
597     return UnnamedDeclKind::UsingDirective;
598   // Everything else either introduces one or more names or is ill-formed.
599   return llvm::None;
600 }
601 
602 unsigned getUnnamedDeclDiag(UnnamedDeclKind UDK, bool InBlock) {
603   switch (UDK) {
604   case UnnamedDeclKind::Empty:
605   case UnnamedDeclKind::StaticAssert:
606     // Allow empty-declarations and static_asserts in an export block as an
607     // extension.
608     return InBlock ? diag::ext_export_no_name_block : diag::err_export_no_name;
609 
610   case UnnamedDeclKind::UsingDirective:
611     // Allow exporting using-directives as an extension.
612     return diag::ext_export_using_directive;
613 
614   case UnnamedDeclKind::Context:
615     // Allow exporting DeclContexts that transitively contain no declarations
616     // as an extension.
617     return diag::ext_export_no_names;
618 
619   case UnnamedDeclKind::Asm:
620     return diag::err_export_no_name;
621   }
622   llvm_unreachable("unknown kind");
623 }
624 
625 static void diagExportedUnnamedDecl(Sema &S, UnnamedDeclKind UDK, Decl *D,
626                                     SourceLocation BlockStart) {
627   S.Diag(D->getLocation(), getUnnamedDeclDiag(UDK, BlockStart.isValid()))
628       << (unsigned)UDK;
629   if (BlockStart.isValid())
630     S.Diag(BlockStart, diag::note_export);
631 }
632 
633 /// Check that it's valid to export \p D.
634 static bool checkExportedDecl(Sema &S, Decl *D, SourceLocation BlockStart) {
635   // C++2a [module.interface]p3:
636   //   An exported declaration shall declare at least one name
637   if (auto UDK = getUnnamedDeclKind(D))
638     diagExportedUnnamedDecl(S, *UDK, D, BlockStart);
639 
640   //   [...] shall not declare a name with internal linkage.
641   if (auto *ND = dyn_cast<NamedDecl>(D)) {
642     // Don't diagnose anonymous union objects; we'll diagnose their members
643     // instead.
644     if (ND->getDeclName() && ND->getFormalLinkage() == InternalLinkage) {
645       S.Diag(ND->getLocation(), diag::err_export_internal) << ND;
646       if (BlockStart.isValid())
647         S.Diag(BlockStart, diag::note_export);
648     }
649   }
650 
651   // C++2a [module.interface]p5:
652   //   all entities to which all of the using-declarators ultimately refer
653   //   shall have been introduced with a name having external linkage
654   if (auto *USD = dyn_cast<UsingShadowDecl>(D)) {
655     NamedDecl *Target = USD->getUnderlyingDecl();
656     if (Target->getFormalLinkage() == InternalLinkage) {
657       S.Diag(USD->getLocation(), diag::err_export_using_internal) << Target;
658       S.Diag(Target->getLocation(), diag::note_using_decl_target);
659       if (BlockStart.isValid())
660         S.Diag(BlockStart, diag::note_export);
661     }
662   }
663 
664   // Recurse into namespace-scope DeclContexts. (Only namespace-scope
665   // declarations are exported.)
666   if (auto *DC = dyn_cast<DeclContext>(D))
667     if (DC->getRedeclContext()->isFileContext() && !isa<EnumDecl>(D))
668       return checkExportedDeclContext(S, DC, BlockStart);
669   return false;
670 }
671 
672 /// Check that it's valid to export all the declarations in \p DC.
673 static bool checkExportedDeclContext(Sema &S, DeclContext *DC,
674                                      SourceLocation BlockStart) {
675   bool AllUnnamed = true;
676   for (auto *D : DC->decls())
677     AllUnnamed &= checkExportedDecl(S, D, BlockStart);
678   return AllUnnamed;
679 }
680 
681 /// Complete the definition of an export declaration.
682 Decl *Sema::ActOnFinishExportDecl(Scope *S, Decl *D, SourceLocation RBraceLoc) {
683   auto *ED = cast<ExportDecl>(D);
684   if (RBraceLoc.isValid())
685     ED->setRBraceLoc(RBraceLoc);
686 
687   PopDeclContext();
688 
689   if (!D->isInvalidDecl()) {
690     SourceLocation BlockStart =
691         ED->hasBraces() ? ED->getBeginLoc() : SourceLocation();
692     for (auto *Child : ED->decls()) {
693       if (checkExportedDecl(*this, Child, BlockStart)) {
694         // If a top-level child is a linkage-spec declaration, it might contain
695         // no declarations (transitively), in which case it's ill-formed.
696         diagExportedUnnamedDecl(*this, UnnamedDeclKind::Context, Child,
697                                 BlockStart);
698       }
699     }
700   }
701 
702   return D;
703 }
704 
705 Module *Sema::PushGlobalModuleFragment(SourceLocation BeginLoc,
706                                        bool IsImplicit) {
707   ModuleMap &Map = PP.getHeaderSearchInfo().getModuleMap();
708   Module *GlobalModule =
709       Map.createGlobalModuleFragmentForModuleUnit(BeginLoc, getCurrentModule());
710   assert(GlobalModule && "module creation should not fail");
711 
712   // Enter the scope of the global module.
713   ModuleScopes.push_back({BeginLoc, GlobalModule,
714                           /*ModuleInterface=*/false,
715                           /*ImplicitGlobalModuleFragment=*/IsImplicit,
716                           /*VisibleModuleSet*/{}});
717   VisibleModules.setVisible(GlobalModule, BeginLoc);
718 
719   return GlobalModule;
720 }
721 
722 void Sema::PopGlobalModuleFragment() {
723   assert(!ModuleScopes.empty() && getCurrentModule()->isGlobalModule() &&
724          "left the wrong module scope, which is not global module fragment");
725   ModuleScopes.pop_back();
726 }
727