xref: /llvm-project/clang/lib/Frontend/CompilerInstance.cpp (revision f1966cf6467e60c60d1c3fe6fa8b669d79ecf8e9)
1 //===--- CompilerInstance.cpp ---------------------------------------------===//
2 //
3 //                     The LLVM Compiler Infrastructure
4 //
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
7 //
8 //===----------------------------------------------------------------------===//
9 
10 #include "clang/Frontend/CompilerInstance.h"
11 #include "clang/AST/ASTConsumer.h"
12 #include "clang/AST/ASTContext.h"
13 #include "clang/AST/Decl.h"
14 #include "clang/Basic/Diagnostic.h"
15 #include "clang/Basic/FileManager.h"
16 #include "clang/Basic/SourceManager.h"
17 #include "clang/Basic/TargetInfo.h"
18 #include "clang/Basic/Version.h"
19 #include "clang/Config/config.h"
20 #include "clang/Frontend/ChainedDiagnosticConsumer.h"
21 #include "clang/Frontend/FrontendAction.h"
22 #include "clang/Frontend/FrontendActions.h"
23 #include "clang/Frontend/FrontendDiagnostic.h"
24 #include "clang/Frontend/LogDiagnosticPrinter.h"
25 #include "clang/Frontend/SerializedDiagnosticPrinter.h"
26 #include "clang/Frontend/TextDiagnosticPrinter.h"
27 #include "clang/Frontend/Utils.h"
28 #include "clang/Frontend/VerifyDiagnosticConsumer.h"
29 #include "clang/Lex/HeaderSearch.h"
30 #include "clang/Lex/PTHManager.h"
31 #include "clang/Lex/Preprocessor.h"
32 #include "clang/Lex/PreprocessorOptions.h"
33 #include "clang/Sema/CodeCompleteConsumer.h"
34 #include "clang/Sema/Sema.h"
35 #include "clang/Serialization/ASTReader.h"
36 #include "clang/Serialization/GlobalModuleIndex.h"
37 #include "llvm/ADT/Statistic.h"
38 #include "llvm/Support/CrashRecoveryContext.h"
39 #include "llvm/Support/Errc.h"
40 #include "llvm/Support/FileSystem.h"
41 #include "llvm/Support/Host.h"
42 #include "llvm/Support/LockFileManager.h"
43 #include "llvm/Support/MemoryBuffer.h"
44 #include "llvm/Support/Path.h"
45 #include "llvm/Support/Program.h"
46 #include "llvm/Support/Signals.h"
47 #include "llvm/Support/Timer.h"
48 #include "llvm/Support/raw_ostream.h"
49 #include <sys/stat.h>
50 #include <system_error>
51 #include <time.h>
52 #include <utility>
53 
54 using namespace clang;
55 
56 CompilerInstance::CompilerInstance(
57     std::shared_ptr<PCHContainerOperations> PCHContainerOps,
58     bool BuildingModule)
59     : ModuleLoader(BuildingModule), Invocation(new CompilerInvocation()),
60       ThePCHContainerOperations(std::move(PCHContainerOps)) {}
61 
62 CompilerInstance::~CompilerInstance() {
63   assert(OutputFiles.empty() && "Still output files in flight?");
64 }
65 
66 void CompilerInstance::setInvocation(
67     std::shared_ptr<CompilerInvocation> Value) {
68   Invocation = std::move(Value);
69 }
70 
71 bool CompilerInstance::shouldBuildGlobalModuleIndex() const {
72   return (BuildGlobalModuleIndex ||
73           (ModuleManager && ModuleManager->isGlobalIndexUnavailable() &&
74            getFrontendOpts().GenerateGlobalModuleIndex)) &&
75          !ModuleBuildFailed;
76 }
77 
78 void CompilerInstance::setDiagnostics(DiagnosticsEngine *Value) {
79   Diagnostics = Value;
80 }
81 
82 void CompilerInstance::setTarget(TargetInfo *Value) { Target = Value; }
83 void CompilerInstance::setAuxTarget(TargetInfo *Value) { AuxTarget = Value; }
84 
85 void CompilerInstance::setFileManager(FileManager *Value) {
86   FileMgr = Value;
87   if (Value)
88     VirtualFileSystem = Value->getVirtualFileSystem();
89   else
90     VirtualFileSystem.reset();
91 }
92 
93 void CompilerInstance::setSourceManager(SourceManager *Value) {
94   SourceMgr = Value;
95 }
96 
97 void CompilerInstance::setPreprocessor(std::shared_ptr<Preprocessor> Value) {
98   PP = std::move(Value);
99 }
100 
101 void CompilerInstance::setASTContext(ASTContext *Value) {
102   Context = Value;
103 
104   if (Context && Consumer)
105     getASTConsumer().Initialize(getASTContext());
106 }
107 
108 void CompilerInstance::setSema(Sema *S) {
109   TheSema.reset(S);
110 }
111 
112 void CompilerInstance::setASTConsumer(std::unique_ptr<ASTConsumer> Value) {
113   Consumer = std::move(Value);
114 
115   if (Context && Consumer)
116     getASTConsumer().Initialize(getASTContext());
117 }
118 
119 void CompilerInstance::setCodeCompletionConsumer(CodeCompleteConsumer *Value) {
120   CompletionConsumer.reset(Value);
121 }
122 
123 std::unique_ptr<Sema> CompilerInstance::takeSema() {
124   return std::move(TheSema);
125 }
126 
127 IntrusiveRefCntPtr<ASTReader> CompilerInstance::getModuleManager() const {
128   return ModuleManager;
129 }
130 void CompilerInstance::setModuleManager(IntrusiveRefCntPtr<ASTReader> Reader) {
131   ModuleManager = std::move(Reader);
132 }
133 
134 std::shared_ptr<ModuleDependencyCollector>
135 CompilerInstance::getModuleDepCollector() const {
136   return ModuleDepCollector;
137 }
138 
139 void CompilerInstance::setModuleDepCollector(
140     std::shared_ptr<ModuleDependencyCollector> Collector) {
141   ModuleDepCollector = std::move(Collector);
142 }
143 
144 static void collectHeaderMaps(const HeaderSearch &HS,
145                               std::shared_ptr<ModuleDependencyCollector> MDC) {
146   SmallVector<std::string, 4> HeaderMapFileNames;
147   HS.getHeaderMapFileNames(HeaderMapFileNames);
148   for (auto &Name : HeaderMapFileNames)
149     MDC->addFile(Name);
150 }
151 
152 static void collectIncludePCH(CompilerInstance &CI,
153                               std::shared_ptr<ModuleDependencyCollector> MDC) {
154   const PreprocessorOptions &PPOpts = CI.getPreprocessorOpts();
155   if (PPOpts.ImplicitPCHInclude.empty())
156     return;
157 
158   StringRef PCHInclude = PPOpts.ImplicitPCHInclude;
159   FileManager &FileMgr = CI.getFileManager();
160   const DirectoryEntry *PCHDir = FileMgr.getDirectory(PCHInclude);
161   if (!PCHDir) {
162     MDC->addFile(PCHInclude);
163     return;
164   }
165 
166   std::error_code EC;
167   SmallString<128> DirNative;
168   llvm::sys::path::native(PCHDir->getName(), DirNative);
169   vfs::FileSystem &FS = *FileMgr.getVirtualFileSystem();
170   SimpleASTReaderListener Validator(CI.getPreprocessor());
171   for (vfs::directory_iterator Dir = FS.dir_begin(DirNative, EC), DirEnd;
172        Dir != DirEnd && !EC; Dir.increment(EC)) {
173     // Check whether this is an AST file. ASTReader::isAcceptableASTFile is not
174     // used here since we're not interested in validating the PCH at this time,
175     // but only to check whether this is a file containing an AST.
176     if (!ASTReader::readASTFileControlBlock(
177             Dir->getName(), FileMgr, CI.getPCHContainerReader(),
178             /*FindModuleFileExtensions=*/false, Validator,
179             /*ValidateDiagnosticOptions=*/false))
180       MDC->addFile(Dir->getName());
181   }
182 }
183 
184 static void collectVFSEntries(CompilerInstance &CI,
185                               std::shared_ptr<ModuleDependencyCollector> MDC) {
186   if (CI.getHeaderSearchOpts().VFSOverlayFiles.empty())
187     return;
188 
189   // Collect all VFS found.
190   SmallVector<vfs::YAMLVFSEntry, 16> VFSEntries;
191   for (const std::string &VFSFile : CI.getHeaderSearchOpts().VFSOverlayFiles) {
192     llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> Buffer =
193         llvm::MemoryBuffer::getFile(VFSFile);
194     if (!Buffer)
195       return;
196     vfs::collectVFSFromYAML(std::move(Buffer.get()), /*DiagHandler*/ nullptr,
197                             VFSFile, VFSEntries);
198   }
199 
200   for (auto &E : VFSEntries)
201     MDC->addFile(E.VPath, E.RPath);
202 }
203 
204 // Diagnostics
205 static void SetUpDiagnosticLog(DiagnosticOptions *DiagOpts,
206                                const CodeGenOptions *CodeGenOpts,
207                                DiagnosticsEngine &Diags) {
208   std::error_code EC;
209   std::unique_ptr<raw_ostream> StreamOwner;
210   raw_ostream *OS = &llvm::errs();
211   if (DiagOpts->DiagnosticLogFile != "-") {
212     // Create the output stream.
213     auto FileOS = llvm::make_unique<llvm::raw_fd_ostream>(
214         DiagOpts->DiagnosticLogFile, EC,
215         llvm::sys::fs::F_Append | llvm::sys::fs::F_Text);
216     if (EC) {
217       Diags.Report(diag::warn_fe_cc_log_diagnostics_failure)
218           << DiagOpts->DiagnosticLogFile << EC.message();
219     } else {
220       FileOS->SetUnbuffered();
221       OS = FileOS.get();
222       StreamOwner = std::move(FileOS);
223     }
224   }
225 
226   // Chain in the diagnostic client which will log the diagnostics.
227   auto Logger = llvm::make_unique<LogDiagnosticPrinter>(*OS, DiagOpts,
228                                                         std::move(StreamOwner));
229   if (CodeGenOpts)
230     Logger->setDwarfDebugFlags(CodeGenOpts->DwarfDebugFlags);
231   assert(Diags.ownsClient());
232   Diags.setClient(
233       new ChainedDiagnosticConsumer(Diags.takeClient(), std::move(Logger)));
234 }
235 
236 static void SetupSerializedDiagnostics(DiagnosticOptions *DiagOpts,
237                                        DiagnosticsEngine &Diags,
238                                        StringRef OutputFile) {
239   auto SerializedConsumer =
240       clang::serialized_diags::create(OutputFile, DiagOpts);
241 
242   if (Diags.ownsClient()) {
243     Diags.setClient(new ChainedDiagnosticConsumer(
244         Diags.takeClient(), std::move(SerializedConsumer)));
245   } else {
246     Diags.setClient(new ChainedDiagnosticConsumer(
247         Diags.getClient(), std::move(SerializedConsumer)));
248   }
249 }
250 
251 void CompilerInstance::createDiagnostics(DiagnosticConsumer *Client,
252                                          bool ShouldOwnClient) {
253   Diagnostics = createDiagnostics(&getDiagnosticOpts(), Client,
254                                   ShouldOwnClient, &getCodeGenOpts());
255 }
256 
257 IntrusiveRefCntPtr<DiagnosticsEngine>
258 CompilerInstance::createDiagnostics(DiagnosticOptions *Opts,
259                                     DiagnosticConsumer *Client,
260                                     bool ShouldOwnClient,
261                                     const CodeGenOptions *CodeGenOpts) {
262   IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
263   IntrusiveRefCntPtr<DiagnosticsEngine>
264       Diags(new DiagnosticsEngine(DiagID, Opts));
265 
266   // Create the diagnostic client for reporting errors or for
267   // implementing -verify.
268   if (Client) {
269     Diags->setClient(Client, ShouldOwnClient);
270   } else
271     Diags->setClient(new TextDiagnosticPrinter(llvm::errs(), Opts));
272 
273   // Chain in -verify checker, if requested.
274   if (Opts->VerifyDiagnostics)
275     Diags->setClient(new VerifyDiagnosticConsumer(*Diags));
276 
277   // Chain in -diagnostic-log-file dumper, if requested.
278   if (!Opts->DiagnosticLogFile.empty())
279     SetUpDiagnosticLog(Opts, CodeGenOpts, *Diags);
280 
281   if (!Opts->DiagnosticSerializationFile.empty())
282     SetupSerializedDiagnostics(Opts, *Diags,
283                                Opts->DiagnosticSerializationFile);
284 
285   // Configure our handling of diagnostics.
286   ProcessWarningOptions(*Diags, *Opts);
287 
288   return Diags;
289 }
290 
291 // File Manager
292 
293 void CompilerInstance::createFileManager() {
294   if (!hasVirtualFileSystem()) {
295     // TODO: choose the virtual file system based on the CompilerInvocation.
296     setVirtualFileSystem(vfs::getRealFileSystem());
297   }
298   FileMgr = new FileManager(getFileSystemOpts(), VirtualFileSystem);
299 }
300 
301 // Source Manager
302 
303 void CompilerInstance::createSourceManager(FileManager &FileMgr) {
304   SourceMgr = new SourceManager(getDiagnostics(), FileMgr);
305 }
306 
307 // Initialize the remapping of files to alternative contents, e.g.,
308 // those specified through other files.
309 static void InitializeFileRemapping(DiagnosticsEngine &Diags,
310                                     SourceManager &SourceMgr,
311                                     FileManager &FileMgr,
312                                     const PreprocessorOptions &InitOpts) {
313   // Remap files in the source manager (with buffers).
314   for (const auto &RB : InitOpts.RemappedFileBuffers) {
315     // Create the file entry for the file that we're mapping from.
316     const FileEntry *FromFile =
317         FileMgr.getVirtualFile(RB.first, RB.second->getBufferSize(), 0);
318     if (!FromFile) {
319       Diags.Report(diag::err_fe_remap_missing_from_file) << RB.first;
320       if (!InitOpts.RetainRemappedFileBuffers)
321         delete RB.second;
322       continue;
323     }
324 
325     // Override the contents of the "from" file with the contents of
326     // the "to" file.
327     SourceMgr.overrideFileContents(FromFile, RB.second,
328                                    InitOpts.RetainRemappedFileBuffers);
329   }
330 
331   // Remap files in the source manager (with other files).
332   for (const auto &RF : InitOpts.RemappedFiles) {
333     // Find the file that we're mapping to.
334     const FileEntry *ToFile = FileMgr.getFile(RF.second);
335     if (!ToFile) {
336       Diags.Report(diag::err_fe_remap_missing_to_file) << RF.first << RF.second;
337       continue;
338     }
339 
340     // Create the file entry for the file that we're mapping from.
341     const FileEntry *FromFile =
342         FileMgr.getVirtualFile(RF.first, ToFile->getSize(), 0);
343     if (!FromFile) {
344       Diags.Report(diag::err_fe_remap_missing_from_file) << RF.first;
345       continue;
346     }
347 
348     // Override the contents of the "from" file with the contents of
349     // the "to" file.
350     SourceMgr.overrideFileContents(FromFile, ToFile);
351   }
352 
353   SourceMgr.setOverridenFilesKeepOriginalName(
354       InitOpts.RemappedFilesKeepOriginalName);
355 }
356 
357 // Preprocessor
358 
359 void CompilerInstance::createPreprocessor(TranslationUnitKind TUKind) {
360   const PreprocessorOptions &PPOpts = getPreprocessorOpts();
361 
362   // Create a PTH manager if we are using some form of a token cache.
363   PTHManager *PTHMgr = nullptr;
364   if (!PPOpts.TokenCache.empty())
365     PTHMgr = PTHManager::Create(PPOpts.TokenCache, getDiagnostics());
366 
367   // Create the Preprocessor.
368   HeaderSearch *HeaderInfo =
369       new HeaderSearch(getHeaderSearchOptsPtr(), getSourceManager(),
370                        getDiagnostics(), getLangOpts(), &getTarget());
371   PP = std::make_shared<Preprocessor>(
372       Invocation->getPreprocessorOptsPtr(), getDiagnostics(), getLangOpts(),
373       getSourceManager(), *HeaderInfo, *this, PTHMgr,
374       /*OwnsHeaderSearch=*/true, TUKind);
375   PP->Initialize(getTarget(), getAuxTarget());
376 
377   // Note that this is different then passing PTHMgr to Preprocessor's ctor.
378   // That argument is used as the IdentifierInfoLookup argument to
379   // IdentifierTable's ctor.
380   if (PTHMgr) {
381     PTHMgr->setPreprocessor(&*PP);
382     PP->setPTHManager(PTHMgr);
383   }
384 
385   if (PPOpts.DetailedRecord)
386     PP->createPreprocessingRecord();
387 
388   // Apply remappings to the source manager.
389   InitializeFileRemapping(PP->getDiagnostics(), PP->getSourceManager(),
390                           PP->getFileManager(), PPOpts);
391 
392   // Predefine macros and configure the preprocessor.
393   InitializePreprocessor(*PP, PPOpts, getPCHContainerReader(),
394                          getFrontendOpts());
395 
396   // Initialize the header search object.  In CUDA compilations, we use the aux
397   // triple (the host triple) to initialize our header search, since we need to
398   // find the host headers in order to compile the CUDA code.
399   const llvm::Triple *HeaderSearchTriple = &PP->getTargetInfo().getTriple();
400   if (PP->getTargetInfo().getTriple().getOS() == llvm::Triple::CUDA &&
401       PP->getAuxTargetInfo())
402     HeaderSearchTriple = &PP->getAuxTargetInfo()->getTriple();
403 
404   ApplyHeaderSearchOptions(PP->getHeaderSearchInfo(), getHeaderSearchOpts(),
405                            PP->getLangOpts(), *HeaderSearchTriple);
406 
407   PP->setPreprocessedOutput(getPreprocessorOutputOpts().ShowCPP);
408 
409   if (PP->getLangOpts().Modules && PP->getLangOpts().ImplicitModules)
410     PP->getHeaderSearchInfo().setModuleCachePath(getSpecificModuleCachePath());
411 
412   // Handle generating dependencies, if requested.
413   const DependencyOutputOptions &DepOpts = getDependencyOutputOpts();
414   if (!DepOpts.OutputFile.empty())
415     TheDependencyFileGenerator.reset(
416         DependencyFileGenerator::CreateAndAttachToPreprocessor(*PP, DepOpts));
417   if (!DepOpts.DOTOutputFile.empty())
418     AttachDependencyGraphGen(*PP, DepOpts.DOTOutputFile,
419                              getHeaderSearchOpts().Sysroot);
420 
421   // If we don't have a collector, but we are collecting module dependencies,
422   // then we're the top level compiler instance and need to create one.
423   if (!ModuleDepCollector && !DepOpts.ModuleDependencyOutputDir.empty()) {
424     ModuleDepCollector = std::make_shared<ModuleDependencyCollector>(
425         DepOpts.ModuleDependencyOutputDir);
426   }
427 
428   // If there is a module dep collector, register with other dep collectors
429   // and also (a) collect header maps and (b) TODO: input vfs overlay files.
430   if (ModuleDepCollector) {
431     addDependencyCollector(ModuleDepCollector);
432     collectHeaderMaps(PP->getHeaderSearchInfo(), ModuleDepCollector);
433     collectIncludePCH(*this, ModuleDepCollector);
434     collectVFSEntries(*this, ModuleDepCollector);
435   }
436 
437   for (auto &Listener : DependencyCollectors)
438     Listener->attachToPreprocessor(*PP);
439 
440   // Handle generating header include information, if requested.
441   if (DepOpts.ShowHeaderIncludes)
442     AttachHeaderIncludeGen(*PP, DepOpts);
443   if (!DepOpts.HeaderIncludeOutputFile.empty()) {
444     StringRef OutputPath = DepOpts.HeaderIncludeOutputFile;
445     if (OutputPath == "-")
446       OutputPath = "";
447     AttachHeaderIncludeGen(*PP, DepOpts,
448                            /*ShowAllHeaders=*/true, OutputPath,
449                            /*ShowDepth=*/false);
450   }
451 
452   if (DepOpts.PrintShowIncludes) {
453     AttachHeaderIncludeGen(*PP, DepOpts,
454                            /*ShowAllHeaders=*/true, /*OutputPath=*/"",
455                            /*ShowDepth=*/true, /*MSStyle=*/true);
456   }
457 }
458 
459 std::string CompilerInstance::getSpecificModuleCachePath() {
460   // Set up the module path, including the hash for the
461   // module-creation options.
462   SmallString<256> SpecificModuleCache(getHeaderSearchOpts().ModuleCachePath);
463   if (!SpecificModuleCache.empty() && !getHeaderSearchOpts().DisableModuleHash)
464     llvm::sys::path::append(SpecificModuleCache,
465                             getInvocation().getModuleHash());
466   return SpecificModuleCache.str();
467 }
468 
469 // ASTContext
470 
471 void CompilerInstance::createASTContext() {
472   Preprocessor &PP = getPreprocessor();
473   auto *Context = new ASTContext(getLangOpts(), PP.getSourceManager(),
474                                  PP.getIdentifierTable(), PP.getSelectorTable(),
475                                  PP.getBuiltinInfo());
476   Context->InitBuiltinTypes(getTarget(), getAuxTarget());
477   setASTContext(Context);
478 }
479 
480 // ExternalASTSource
481 
482 void CompilerInstance::createPCHExternalASTSource(
483     StringRef Path, bool DisablePCHValidation, bool AllowPCHWithCompilerErrors,
484     void *DeserializationListener, bool OwnDeserializationListener) {
485   bool Preamble = getPreprocessorOpts().PrecompiledPreambleBytes.first != 0;
486   ModuleManager = createPCHExternalASTSource(
487       Path, getHeaderSearchOpts().Sysroot, DisablePCHValidation,
488       AllowPCHWithCompilerErrors, getPreprocessor(), getASTContext(),
489       getPCHContainerReader(),
490       getFrontendOpts().ModuleFileExtensions,
491       DeserializationListener,
492       OwnDeserializationListener, Preamble,
493       getFrontendOpts().UseGlobalModuleIndex);
494 }
495 
496 IntrusiveRefCntPtr<ASTReader> CompilerInstance::createPCHExternalASTSource(
497     StringRef Path, StringRef Sysroot, bool DisablePCHValidation,
498     bool AllowPCHWithCompilerErrors, Preprocessor &PP, ASTContext &Context,
499     const PCHContainerReader &PCHContainerRdr,
500     ArrayRef<std::shared_ptr<ModuleFileExtension>> Extensions,
501     void *DeserializationListener, bool OwnDeserializationListener,
502     bool Preamble, bool UseGlobalModuleIndex) {
503   HeaderSearchOptions &HSOpts = PP.getHeaderSearchInfo().getHeaderSearchOpts();
504 
505   IntrusiveRefCntPtr<ASTReader> Reader(new ASTReader(
506       PP, Context, PCHContainerRdr, Extensions,
507       Sysroot.empty() ? "" : Sysroot.data(), DisablePCHValidation,
508       AllowPCHWithCompilerErrors, /*AllowConfigurationMismatch*/ false,
509       HSOpts.ModulesValidateSystemHeaders, UseGlobalModuleIndex));
510 
511   // We need the external source to be set up before we read the AST, because
512   // eagerly-deserialized declarations may use it.
513   Context.setExternalSource(Reader.get());
514 
515   Reader->setDeserializationListener(
516       static_cast<ASTDeserializationListener *>(DeserializationListener),
517       /*TakeOwnership=*/OwnDeserializationListener);
518   switch (Reader->ReadAST(Path,
519                           Preamble ? serialization::MK_Preamble
520                                    : serialization::MK_PCH,
521                           SourceLocation(),
522                           ASTReader::ARR_None)) {
523   case ASTReader::Success:
524     // Set the predefines buffer as suggested by the PCH reader. Typically, the
525     // predefines buffer will be empty.
526     PP.setPredefines(Reader->getSuggestedPredefines());
527     return Reader;
528 
529   case ASTReader::Failure:
530     // Unrecoverable failure: don't even try to process the input file.
531     break;
532 
533   case ASTReader::Missing:
534   case ASTReader::OutOfDate:
535   case ASTReader::VersionMismatch:
536   case ASTReader::ConfigurationMismatch:
537   case ASTReader::HadErrors:
538     // No suitable PCH file could be found. Return an error.
539     break;
540   }
541 
542   Context.setExternalSource(nullptr);
543   return nullptr;
544 }
545 
546 // Code Completion
547 
548 static bool EnableCodeCompletion(Preprocessor &PP,
549                                  StringRef Filename,
550                                  unsigned Line,
551                                  unsigned Column) {
552   // Tell the source manager to chop off the given file at a specific
553   // line and column.
554   const FileEntry *Entry = PP.getFileManager().getFile(Filename);
555   if (!Entry) {
556     PP.getDiagnostics().Report(diag::err_fe_invalid_code_complete_file)
557       << Filename;
558     return true;
559   }
560 
561   // Truncate the named file at the given line/column.
562   PP.SetCodeCompletionPoint(Entry, Line, Column);
563   return false;
564 }
565 
566 void CompilerInstance::createCodeCompletionConsumer() {
567   const ParsedSourceLocation &Loc = getFrontendOpts().CodeCompletionAt;
568   if (!CompletionConsumer) {
569     setCodeCompletionConsumer(
570       createCodeCompletionConsumer(getPreprocessor(),
571                                    Loc.FileName, Loc.Line, Loc.Column,
572                                    getFrontendOpts().CodeCompleteOpts,
573                                    llvm::outs()));
574     if (!CompletionConsumer)
575       return;
576   } else if (EnableCodeCompletion(getPreprocessor(), Loc.FileName,
577                                   Loc.Line, Loc.Column)) {
578     setCodeCompletionConsumer(nullptr);
579     return;
580   }
581 
582   if (CompletionConsumer->isOutputBinary() &&
583       llvm::sys::ChangeStdoutToBinary()) {
584     getPreprocessor().getDiagnostics().Report(diag::err_fe_stdout_binary);
585     setCodeCompletionConsumer(nullptr);
586   }
587 }
588 
589 void CompilerInstance::createFrontendTimer() {
590   FrontendTimerGroup.reset(
591       new llvm::TimerGroup("frontend", "Clang front-end time report"));
592   FrontendTimer.reset(
593       new llvm::Timer("frontend", "Clang front-end timer",
594                       *FrontendTimerGroup));
595 }
596 
597 CodeCompleteConsumer *
598 CompilerInstance::createCodeCompletionConsumer(Preprocessor &PP,
599                                                StringRef Filename,
600                                                unsigned Line,
601                                                unsigned Column,
602                                                const CodeCompleteOptions &Opts,
603                                                raw_ostream &OS) {
604   if (EnableCodeCompletion(PP, Filename, Line, Column))
605     return nullptr;
606 
607   // Set up the creation routine for code-completion.
608   return new PrintingCodeCompleteConsumer(Opts, OS);
609 }
610 
611 void CompilerInstance::createSema(TranslationUnitKind TUKind,
612                                   CodeCompleteConsumer *CompletionConsumer) {
613   TheSema.reset(new Sema(getPreprocessor(), getASTContext(), getASTConsumer(),
614                          TUKind, CompletionConsumer));
615   // Attach the external sema source if there is any.
616   if (ExternalSemaSrc) {
617     TheSema->addExternalSource(ExternalSemaSrc.get());
618     ExternalSemaSrc->InitializeSema(*TheSema);
619   }
620 }
621 
622 // Output Files
623 
624 void CompilerInstance::addOutputFile(OutputFile &&OutFile) {
625   OutputFiles.push_back(std::move(OutFile));
626 }
627 
628 void CompilerInstance::clearOutputFiles(bool EraseFiles) {
629   for (OutputFile &OF : OutputFiles) {
630     if (!OF.TempFilename.empty()) {
631       if (EraseFiles) {
632         llvm::sys::fs::remove(OF.TempFilename);
633       } else {
634         SmallString<128> NewOutFile(OF.Filename);
635 
636         // If '-working-directory' was passed, the output filename should be
637         // relative to that.
638         FileMgr->FixupRelativePath(NewOutFile);
639         if (std::error_code ec =
640                 llvm::sys::fs::rename(OF.TempFilename, NewOutFile)) {
641           getDiagnostics().Report(diag::err_unable_to_rename_temp)
642             << OF.TempFilename << OF.Filename << ec.message();
643 
644           llvm::sys::fs::remove(OF.TempFilename);
645         }
646       }
647     } else if (!OF.Filename.empty() && EraseFiles)
648       llvm::sys::fs::remove(OF.Filename);
649   }
650   OutputFiles.clear();
651   NonSeekStream.reset();
652 }
653 
654 std::unique_ptr<raw_pwrite_stream>
655 CompilerInstance::createDefaultOutputFile(bool Binary, StringRef InFile,
656                                           StringRef Extension) {
657   return createOutputFile(getFrontendOpts().OutputFile, Binary,
658                           /*RemoveFileOnSignal=*/true, InFile, Extension,
659                           /*UseTemporary=*/true);
660 }
661 
662 std::unique_ptr<raw_pwrite_stream> CompilerInstance::createNullOutputFile() {
663   return llvm::make_unique<llvm::raw_null_ostream>();
664 }
665 
666 std::unique_ptr<raw_pwrite_stream>
667 CompilerInstance::createOutputFile(StringRef OutputPath, bool Binary,
668                                    bool RemoveFileOnSignal, StringRef InFile,
669                                    StringRef Extension, bool UseTemporary,
670                                    bool CreateMissingDirectories) {
671   std::string OutputPathName, TempPathName;
672   std::error_code EC;
673   std::unique_ptr<raw_pwrite_stream> OS = createOutputFile(
674       OutputPath, EC, Binary, RemoveFileOnSignal, InFile, Extension,
675       UseTemporary, CreateMissingDirectories, &OutputPathName, &TempPathName);
676   if (!OS) {
677     getDiagnostics().Report(diag::err_fe_unable_to_open_output) << OutputPath
678                                                                 << EC.message();
679     return nullptr;
680   }
681 
682   // Add the output file -- but don't try to remove "-", since this means we are
683   // using stdin.
684   addOutputFile(
685       OutputFile((OutputPathName != "-") ? OutputPathName : "", TempPathName));
686 
687   return OS;
688 }
689 
690 std::unique_ptr<llvm::raw_pwrite_stream> CompilerInstance::createOutputFile(
691     StringRef OutputPath, std::error_code &Error, bool Binary,
692     bool RemoveFileOnSignal, StringRef InFile, StringRef Extension,
693     bool UseTemporary, bool CreateMissingDirectories,
694     std::string *ResultPathName, std::string *TempPathName) {
695   assert((!CreateMissingDirectories || UseTemporary) &&
696          "CreateMissingDirectories is only allowed when using temporary files");
697 
698   std::string OutFile, TempFile;
699   if (!OutputPath.empty()) {
700     OutFile = OutputPath;
701   } else if (InFile == "-") {
702     OutFile = "-";
703   } else if (!Extension.empty()) {
704     SmallString<128> Path(InFile);
705     llvm::sys::path::replace_extension(Path, Extension);
706     OutFile = Path.str();
707   } else {
708     OutFile = "-";
709   }
710 
711   std::unique_ptr<llvm::raw_fd_ostream> OS;
712   std::string OSFile;
713 
714   if (UseTemporary) {
715     if (OutFile == "-")
716       UseTemporary = false;
717     else {
718       llvm::sys::fs::file_status Status;
719       llvm::sys::fs::status(OutputPath, Status);
720       if (llvm::sys::fs::exists(Status)) {
721         // Fail early if we can't write to the final destination.
722         if (!llvm::sys::fs::can_write(OutputPath)) {
723           Error = make_error_code(llvm::errc::operation_not_permitted);
724           return nullptr;
725         }
726 
727         // Don't use a temporary if the output is a special file. This handles
728         // things like '-o /dev/null'
729         if (!llvm::sys::fs::is_regular_file(Status))
730           UseTemporary = false;
731       }
732     }
733   }
734 
735   if (UseTemporary) {
736     // Create a temporary file.
737     SmallString<128> TempPath;
738     TempPath = OutFile;
739     TempPath += "-%%%%%%%%";
740     int fd;
741     std::error_code EC =
742         llvm::sys::fs::createUniqueFile(TempPath, fd, TempPath);
743 
744     if (CreateMissingDirectories &&
745         EC == llvm::errc::no_such_file_or_directory) {
746       StringRef Parent = llvm::sys::path::parent_path(OutputPath);
747       EC = llvm::sys::fs::create_directories(Parent);
748       if (!EC) {
749         EC = llvm::sys::fs::createUniqueFile(TempPath, fd, TempPath);
750       }
751     }
752 
753     if (!EC) {
754       OS.reset(new llvm::raw_fd_ostream(fd, /*shouldClose=*/true));
755       OSFile = TempFile = TempPath.str();
756     }
757     // If we failed to create the temporary, fallback to writing to the file
758     // directly. This handles the corner case where we cannot write to the
759     // directory, but can write to the file.
760   }
761 
762   if (!OS) {
763     OSFile = OutFile;
764     OS.reset(new llvm::raw_fd_ostream(
765         OSFile, Error,
766         (Binary ? llvm::sys::fs::F_None : llvm::sys::fs::F_Text)));
767     if (Error)
768       return nullptr;
769   }
770 
771   // Make sure the out stream file gets removed if we crash.
772   if (RemoveFileOnSignal)
773     llvm::sys::RemoveFileOnSignal(OSFile);
774 
775   if (ResultPathName)
776     *ResultPathName = OutFile;
777   if (TempPathName)
778     *TempPathName = TempFile;
779 
780   if (!Binary || OS->supportsSeeking())
781     return std::move(OS);
782 
783   auto B = llvm::make_unique<llvm::buffer_ostream>(*OS);
784   assert(!NonSeekStream);
785   NonSeekStream = std::move(OS);
786   return std::move(B);
787 }
788 
789 // Initialization Utilities
790 
791 bool CompilerInstance::InitializeSourceManager(const FrontendInputFile &Input){
792   return InitializeSourceManager(
793       Input, getDiagnostics(), getFileManager(), getSourceManager(),
794       hasPreprocessor() ? &getPreprocessor().getHeaderSearchInfo() : nullptr,
795       getDependencyOutputOpts(), getFrontendOpts());
796 }
797 
798 // static
799 bool CompilerInstance::InitializeSourceManager(
800     const FrontendInputFile &Input, DiagnosticsEngine &Diags,
801     FileManager &FileMgr, SourceManager &SourceMgr, HeaderSearch *HS,
802     DependencyOutputOptions &DepOpts, const FrontendOptions &Opts) {
803   SrcMgr::CharacteristicKind
804     Kind = Input.isSystem() ? SrcMgr::C_System : SrcMgr::C_User;
805 
806   if (Input.isBuffer()) {
807     SourceMgr.setMainFileID(SourceMgr.createFileID(
808         std::unique_ptr<llvm::MemoryBuffer>(Input.getBuffer()), Kind));
809     assert(SourceMgr.getMainFileID().isValid() &&
810            "Couldn't establish MainFileID!");
811     return true;
812   }
813 
814   StringRef InputFile = Input.getFile();
815 
816   // Figure out where to get and map in the main file.
817   if (InputFile != "-") {
818     const FileEntry *File;
819     if (Opts.FindPchSource.empty()) {
820       File = FileMgr.getFile(InputFile, /*OpenFile=*/true);
821     } else {
822       // When building a pch file in clang-cl mode, the .h file is built as if
823       // it was included by a cc file.  Since the driver doesn't know about
824       // all include search directories, the frontend must search the input
825       // file through HeaderSearch here, as if it had been included by the
826       // cc file at Opts.FindPchSource.
827       const FileEntry *FindFile = FileMgr.getFile(Opts.FindPchSource);
828       if (!FindFile) {
829         Diags.Report(diag::err_fe_error_reading) << Opts.FindPchSource;
830         return false;
831       }
832       const DirectoryLookup *UnusedCurDir;
833       SmallVector<std::pair<const FileEntry *, const DirectoryEntry *>, 16>
834           Includers;
835       Includers.push_back(std::make_pair(FindFile, FindFile->getDir()));
836       File = HS->LookupFile(InputFile, SourceLocation(), /*isAngled=*/false,
837                             /*FromDir=*/nullptr,
838                             /*CurDir=*/UnusedCurDir, Includers,
839                             /*SearchPath=*/nullptr,
840                             /*RelativePath=*/nullptr,
841                             /*RequestingModule=*/nullptr,
842                             /*SuggestedModule=*/nullptr, /*SkipCache=*/true);
843       // Also add the header to /showIncludes output.
844       if (File)
845         DepOpts.ShowIncludesPretendHeader = File->getName();
846     }
847     if (!File) {
848       Diags.Report(diag::err_fe_error_reading) << InputFile;
849       return false;
850     }
851 
852     // The natural SourceManager infrastructure can't currently handle named
853     // pipes, but we would at least like to accept them for the main
854     // file. Detect them here, read them with the volatile flag so FileMgr will
855     // pick up the correct size, and simply override their contents as we do for
856     // STDIN.
857     if (File->isNamedPipe()) {
858       auto MB = FileMgr.getBufferForFile(File, /*isVolatile=*/true);
859       if (MB) {
860         // Create a new virtual file that will have the correct size.
861         File = FileMgr.getVirtualFile(InputFile, (*MB)->getBufferSize(), 0);
862         SourceMgr.overrideFileContents(File, std::move(*MB));
863       } else {
864         Diags.Report(diag::err_cannot_open_file) << InputFile
865                                                  << MB.getError().message();
866         return false;
867       }
868     }
869 
870     SourceMgr.setMainFileID(
871         SourceMgr.createFileID(File, SourceLocation(), Kind));
872   } else {
873     llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> SBOrErr =
874         llvm::MemoryBuffer::getSTDIN();
875     if (std::error_code EC = SBOrErr.getError()) {
876       Diags.Report(diag::err_fe_error_reading_stdin) << EC.message();
877       return false;
878     }
879     std::unique_ptr<llvm::MemoryBuffer> SB = std::move(SBOrErr.get());
880 
881     const FileEntry *File = FileMgr.getVirtualFile(SB->getBufferIdentifier(),
882                                                    SB->getBufferSize(), 0);
883     SourceMgr.setMainFileID(
884         SourceMgr.createFileID(File, SourceLocation(), Kind));
885     SourceMgr.overrideFileContents(File, std::move(SB));
886   }
887 
888   assert(SourceMgr.getMainFileID().isValid() &&
889          "Couldn't establish MainFileID!");
890   return true;
891 }
892 
893 // High-Level Operations
894 
895 bool CompilerInstance::ExecuteAction(FrontendAction &Act) {
896   assert(hasDiagnostics() && "Diagnostics engine is not initialized!");
897   assert(!getFrontendOpts().ShowHelp && "Client must handle '-help'!");
898   assert(!getFrontendOpts().ShowVersion && "Client must handle '-version'!");
899 
900   // FIXME: Take this as an argument, once all the APIs we used have moved to
901   // taking it as an input instead of hard-coding llvm::errs.
902   raw_ostream &OS = llvm::errs();
903 
904   // Create the target instance.
905   setTarget(TargetInfo::CreateTargetInfo(getDiagnostics(),
906                                          getInvocation().TargetOpts));
907   if (!hasTarget())
908     return false;
909 
910   // Create TargetInfo for the other side of CUDA compilation.
911   if (getLangOpts().CUDA && !getFrontendOpts().AuxTriple.empty()) {
912     auto TO = std::make_shared<TargetOptions>();
913     TO->Triple = getFrontendOpts().AuxTriple;
914     TO->HostTriple = getTarget().getTriple().str();
915     setAuxTarget(TargetInfo::CreateTargetInfo(getDiagnostics(), TO));
916   }
917 
918   // Inform the target of the language options.
919   //
920   // FIXME: We shouldn't need to do this, the target should be immutable once
921   // created. This complexity should be lifted elsewhere.
922   getTarget().adjust(getLangOpts());
923 
924   // Adjust target options based on codegen options.
925   getTarget().adjustTargetOptions(getCodeGenOpts(), getTargetOpts());
926 
927   // rewriter project will change target built-in bool type from its default.
928   if (getFrontendOpts().ProgramAction == frontend::RewriteObjC)
929     getTarget().noSignedCharForObjCBool();
930 
931   // Validate/process some options.
932   if (getHeaderSearchOpts().Verbose)
933     OS << "clang -cc1 version " CLANG_VERSION_STRING
934        << " based upon " << BACKEND_PACKAGE_STRING
935        << " default target " << llvm::sys::getDefaultTargetTriple() << "\n";
936 
937   if (getFrontendOpts().ShowTimers)
938     createFrontendTimer();
939 
940   if (getFrontendOpts().ShowStats || !getFrontendOpts().StatsFile.empty())
941     llvm::EnableStatistics(false);
942 
943   for (const FrontendInputFile &FIF : getFrontendOpts().Inputs) {
944     // Reset the ID tables if we are reusing the SourceManager and parsing
945     // regular files.
946     if (hasSourceManager() && !Act.isModelParsingAction())
947       getSourceManager().clearIDTables();
948 
949     if (Act.BeginSourceFile(*this, FIF)) {
950       Act.Execute();
951       Act.EndSourceFile();
952     }
953   }
954 
955   // Notify the diagnostic client that all files were processed.
956   getDiagnostics().getClient()->finish();
957 
958   if (getDiagnosticOpts().ShowCarets) {
959     // We can have multiple diagnostics sharing one diagnostic client.
960     // Get the total number of warnings/errors from the client.
961     unsigned NumWarnings = getDiagnostics().getClient()->getNumWarnings();
962     unsigned NumErrors = getDiagnostics().getClient()->getNumErrors();
963 
964     if (NumWarnings)
965       OS << NumWarnings << " warning" << (NumWarnings == 1 ? "" : "s");
966     if (NumWarnings && NumErrors)
967       OS << " and ";
968     if (NumErrors)
969       OS << NumErrors << " error" << (NumErrors == 1 ? "" : "s");
970     if (NumWarnings || NumErrors)
971       OS << " generated.\n";
972   }
973 
974   if (getFrontendOpts().ShowStats) {
975     if (hasFileManager()) {
976       getFileManager().PrintStats();
977       OS << '\n';
978     }
979     llvm::PrintStatistics(OS);
980   }
981   StringRef StatsFile = getFrontendOpts().StatsFile;
982   if (!StatsFile.empty()) {
983     std::error_code EC;
984     auto StatS = llvm::make_unique<llvm::raw_fd_ostream>(StatsFile, EC,
985                                                          llvm::sys::fs::F_Text);
986     if (EC) {
987       getDiagnostics().Report(diag::warn_fe_unable_to_open_stats_file)
988           << StatsFile << EC.message();
989     } else {
990       llvm::PrintStatisticsJSON(*StatS);
991     }
992   }
993 
994   return !getDiagnostics().getClient()->getNumErrors();
995 }
996 
997 /// \brief Determine the appropriate source input kind based on language
998 /// options.
999 static InputKind getSourceInputKindFromOptions(const LangOptions &LangOpts) {
1000   if (LangOpts.OpenCL)
1001     return IK_OpenCL;
1002   if (LangOpts.CUDA)
1003     return IK_CUDA;
1004   if (LangOpts.ObjC1)
1005     return LangOpts.CPlusPlus? IK_ObjCXX : IK_ObjC;
1006   return LangOpts.CPlusPlus? IK_CXX : IK_C;
1007 }
1008 
1009 /// \brief Compile a module file for the given module, using the options
1010 /// provided by the importing compiler instance. Returns true if the module
1011 /// was built without errors.
1012 static bool compileModuleImpl(CompilerInstance &ImportingInstance,
1013                               SourceLocation ImportLoc,
1014                               Module *Module,
1015                               StringRef ModuleFileName) {
1016   ModuleMap &ModMap
1017     = ImportingInstance.getPreprocessor().getHeaderSearchInfo().getModuleMap();
1018 
1019   // Construct a compiler invocation for creating this module.
1020   auto Invocation =
1021       std::make_shared<CompilerInvocation>(ImportingInstance.getInvocation());
1022 
1023   PreprocessorOptions &PPOpts = Invocation->getPreprocessorOpts();
1024 
1025   // For any options that aren't intended to affect how a module is built,
1026   // reset them to their default values.
1027   Invocation->getLangOpts()->resetNonModularOptions();
1028   PPOpts.resetNonModularOptions();
1029 
1030   // Remove any macro definitions that are explicitly ignored by the module.
1031   // They aren't supposed to affect how the module is built anyway.
1032   HeaderSearchOptions &HSOpts = Invocation->getHeaderSearchOpts();
1033   PPOpts.Macros.erase(
1034       std::remove_if(PPOpts.Macros.begin(), PPOpts.Macros.end(),
1035                      [&HSOpts](const std::pair<std::string, bool> &def) {
1036         StringRef MacroDef = def.first;
1037         return HSOpts.ModulesIgnoreMacros.count(
1038                    llvm::CachedHashString(MacroDef.split('=').first)) > 0;
1039       }),
1040       PPOpts.Macros.end());
1041 
1042   // Note the name of the module we're building.
1043   Invocation->getLangOpts()->CurrentModule = Module->getTopLevelModuleName();
1044 
1045   // Make sure that the failed-module structure has been allocated in
1046   // the importing instance, and propagate the pointer to the newly-created
1047   // instance.
1048   PreprocessorOptions &ImportingPPOpts
1049     = ImportingInstance.getInvocation().getPreprocessorOpts();
1050   if (!ImportingPPOpts.FailedModules)
1051     ImportingPPOpts.FailedModules =
1052         std::make_shared<PreprocessorOptions::FailedModulesSet>();
1053   PPOpts.FailedModules = ImportingPPOpts.FailedModules;
1054 
1055   // If there is a module map file, build the module using the module map.
1056   // Set up the inputs/outputs so that we build the module from its umbrella
1057   // header.
1058   FrontendOptions &FrontendOpts = Invocation->getFrontendOpts();
1059   FrontendOpts.OutputFile = ModuleFileName.str();
1060   FrontendOpts.DisableFree = false;
1061   FrontendOpts.GenerateGlobalModuleIndex = false;
1062   FrontendOpts.BuildingImplicitModule = true;
1063   // Force implicitly-built modules to hash the content of the module file.
1064   HSOpts.ModulesHashContent = true;
1065   FrontendOpts.Inputs.clear();
1066   InputKind IK = getSourceInputKindFromOptions(*Invocation->getLangOpts());
1067 
1068   // Don't free the remapped file buffers; they are owned by our caller.
1069   PPOpts.RetainRemappedFileBuffers = true;
1070 
1071   Invocation->getDiagnosticOpts().VerifyDiagnostics = 0;
1072   assert(ImportingInstance.getInvocation().getModuleHash() ==
1073          Invocation->getModuleHash() && "Module hash mismatch!");
1074 
1075   // Construct a compiler instance that will be used to actually create the
1076   // module.
1077   CompilerInstance Instance(ImportingInstance.getPCHContainerOperations(),
1078                             /*BuildingModule=*/true);
1079   auto &Inv = *Invocation;
1080   Instance.setInvocation(std::move(Invocation));
1081 
1082   Instance.createDiagnostics(new ForwardingDiagnosticConsumer(
1083                                    ImportingInstance.getDiagnosticClient()),
1084                              /*ShouldOwnClient=*/true);
1085 
1086   Instance.setVirtualFileSystem(&ImportingInstance.getVirtualFileSystem());
1087 
1088   // Note that this module is part of the module build stack, so that we
1089   // can detect cycles in the module graph.
1090   Instance.setFileManager(&ImportingInstance.getFileManager());
1091   Instance.createSourceManager(Instance.getFileManager());
1092   SourceManager &SourceMgr = Instance.getSourceManager();
1093   SourceMgr.setModuleBuildStack(
1094     ImportingInstance.getSourceManager().getModuleBuildStack());
1095   SourceMgr.pushModuleBuildStack(Module->getTopLevelModuleName(),
1096     FullSourceLoc(ImportLoc, ImportingInstance.getSourceManager()));
1097 
1098   // If we're collecting module dependencies, we need to share a collector
1099   // between all of the module CompilerInstances. Other than that, we don't
1100   // want to produce any dependency output from the module build.
1101   Instance.setModuleDepCollector(ImportingInstance.getModuleDepCollector());
1102   Inv.getDependencyOutputOpts() = DependencyOutputOptions();
1103 
1104   // Get or create the module map that we'll use to build this module.
1105   std::string InferredModuleMapContent;
1106   if (const FileEntry *ModuleMapFile =
1107           ModMap.getContainingModuleMapFile(Module)) {
1108     // Use the module map where this module resides.
1109     FrontendOpts.Inputs.emplace_back(ModuleMapFile->getName(), IK);
1110   } else {
1111     SmallString<128> FakeModuleMapFile(Module->Directory->getName());
1112     llvm::sys::path::append(FakeModuleMapFile, "__inferred_module.map");
1113     FrontendOpts.Inputs.emplace_back(FakeModuleMapFile, IK);
1114 
1115     llvm::raw_string_ostream OS(InferredModuleMapContent);
1116     Module->print(OS);
1117     OS.flush();
1118 
1119     std::unique_ptr<llvm::MemoryBuffer> ModuleMapBuffer =
1120         llvm::MemoryBuffer::getMemBuffer(InferredModuleMapContent);
1121     ModuleMapFile = Instance.getFileManager().getVirtualFile(
1122         FakeModuleMapFile, InferredModuleMapContent.size(), 0);
1123     SourceMgr.overrideFileContents(ModuleMapFile, std::move(ModuleMapBuffer));
1124   }
1125 
1126   // Construct a module-generating action. Passing through the module map is
1127   // safe because the FileManager is shared between the compiler instances.
1128   GenerateModuleFromModuleMapAction CreateModuleAction(
1129       ModMap.getModuleMapFileForUniquing(Module), Module->IsSystem);
1130 
1131   ImportingInstance.getDiagnostics().Report(ImportLoc,
1132                                             diag::remark_module_build)
1133     << Module->Name << ModuleFileName;
1134 
1135   // Execute the action to actually build the module in-place. Use a separate
1136   // thread so that we get a stack large enough.
1137   const unsigned ThreadStackSize = 8 << 20;
1138   llvm::CrashRecoveryContext CRC;
1139   CRC.RunSafelyOnThread([&]() { Instance.ExecuteAction(CreateModuleAction); },
1140                         ThreadStackSize);
1141 
1142   ImportingInstance.getDiagnostics().Report(ImportLoc,
1143                                             diag::remark_module_build_done)
1144     << Module->Name;
1145 
1146   // Delete the temporary module map file.
1147   // FIXME: Even though we're executing under crash protection, it would still
1148   // be nice to do this with RemoveFileOnSignal when we can. However, that
1149   // doesn't make sense for all clients, so clean this up manually.
1150   Instance.clearOutputFiles(/*EraseFiles=*/true);
1151 
1152   // We've rebuilt a module. If we're allowed to generate or update the global
1153   // module index, record that fact in the importing compiler instance.
1154   if (ImportingInstance.getFrontendOpts().GenerateGlobalModuleIndex) {
1155     ImportingInstance.setBuildGlobalModuleIndex(true);
1156   }
1157 
1158   return !Instance.getDiagnostics().hasErrorOccurred();
1159 }
1160 
1161 static bool compileAndLoadModule(CompilerInstance &ImportingInstance,
1162                                  SourceLocation ImportLoc,
1163                                  SourceLocation ModuleNameLoc, Module *Module,
1164                                  StringRef ModuleFileName) {
1165   DiagnosticsEngine &Diags = ImportingInstance.getDiagnostics();
1166 
1167   auto diagnoseBuildFailure = [&] {
1168     Diags.Report(ModuleNameLoc, diag::err_module_not_built)
1169         << Module->Name << SourceRange(ImportLoc, ModuleNameLoc);
1170   };
1171 
1172   // FIXME: have LockFileManager return an error_code so that we can
1173   // avoid the mkdir when the directory already exists.
1174   StringRef Dir = llvm::sys::path::parent_path(ModuleFileName);
1175   llvm::sys::fs::create_directories(Dir);
1176 
1177   while (1) {
1178     unsigned ModuleLoadCapabilities = ASTReader::ARR_Missing;
1179     llvm::LockFileManager Locked(ModuleFileName);
1180     switch (Locked) {
1181     case llvm::LockFileManager::LFS_Error:
1182       // PCMCache takes care of correctness and locks are only necessary for
1183       // performance. Fallback to building the module in case of any lock
1184       // related errors.
1185       Diags.Report(ModuleNameLoc, diag::remark_module_lock_failure)
1186           << Module->Name << Locked.getErrorMessage();
1187       // Clear out any potential leftover.
1188       Locked.unsafeRemoveLockFile();
1189       // FALLTHROUGH
1190     case llvm::LockFileManager::LFS_Owned:
1191       // We're responsible for building the module ourselves.
1192       if (!compileModuleImpl(ImportingInstance, ModuleNameLoc, Module,
1193                              ModuleFileName)) {
1194         diagnoseBuildFailure();
1195         return false;
1196       }
1197       break;
1198 
1199     case llvm::LockFileManager::LFS_Shared:
1200       // Someone else is responsible for building the module. Wait for them to
1201       // finish.
1202       switch (Locked.waitForUnlock()) {
1203       case llvm::LockFileManager::Res_Success:
1204         ModuleLoadCapabilities |= ASTReader::ARR_OutOfDate;
1205         break;
1206       case llvm::LockFileManager::Res_OwnerDied:
1207         continue; // try again to get the lock.
1208       case llvm::LockFileManager::Res_Timeout:
1209         // Since PCMCache takes care of correctness, we try waiting for another
1210         // process to complete the build so clang does not do it done twice. If
1211         // case of timeout, build it ourselves.
1212         Diags.Report(ModuleNameLoc, diag::remark_module_lock_timeout)
1213             << Module->Name;
1214         // Clear the lock file so that future invokations can make progress.
1215         Locked.unsafeRemoveLockFile();
1216         continue;
1217       }
1218       break;
1219     }
1220 
1221     // Try to read the module file, now that we've compiled it.
1222     ASTReader::ASTReadResult ReadResult =
1223         ImportingInstance.getModuleManager()->ReadAST(
1224             ModuleFileName, serialization::MK_ImplicitModule, ImportLoc,
1225             ModuleLoadCapabilities);
1226 
1227     if (ReadResult == ASTReader::OutOfDate &&
1228         Locked == llvm::LockFileManager::LFS_Shared) {
1229       // The module may be out of date in the presence of file system races,
1230       // or if one of its imports depends on header search paths that are not
1231       // consistent with this ImportingInstance.  Try again...
1232       continue;
1233     } else if (ReadResult == ASTReader::Missing) {
1234       diagnoseBuildFailure();
1235     } else if (ReadResult != ASTReader::Success &&
1236                !Diags.hasErrorOccurred()) {
1237       // The ASTReader didn't diagnose the error, so conservatively report it.
1238       diagnoseBuildFailure();
1239     }
1240     return ReadResult == ASTReader::Success;
1241   }
1242 }
1243 
1244 /// \brief Diagnose differences between the current definition of the given
1245 /// configuration macro and the definition provided on the command line.
1246 static void checkConfigMacro(Preprocessor &PP, StringRef ConfigMacro,
1247                              Module *Mod, SourceLocation ImportLoc) {
1248   IdentifierInfo *Id = PP.getIdentifierInfo(ConfigMacro);
1249   SourceManager &SourceMgr = PP.getSourceManager();
1250 
1251   // If this identifier has never had a macro definition, then it could
1252   // not have changed.
1253   if (!Id->hadMacroDefinition())
1254     return;
1255   auto *LatestLocalMD = PP.getLocalMacroDirectiveHistory(Id);
1256 
1257   // Find the macro definition from the command line.
1258   MacroInfo *CmdLineDefinition = nullptr;
1259   for (auto *MD = LatestLocalMD; MD; MD = MD->getPrevious()) {
1260     // We only care about the predefines buffer.
1261     FileID FID = SourceMgr.getFileID(MD->getLocation());
1262     if (FID.isInvalid() || FID != PP.getPredefinesFileID())
1263       continue;
1264     if (auto *DMD = dyn_cast<DefMacroDirective>(MD))
1265       CmdLineDefinition = DMD->getMacroInfo();
1266     break;
1267   }
1268 
1269   auto *CurrentDefinition = PP.getMacroInfo(Id);
1270   if (CurrentDefinition == CmdLineDefinition) {
1271     // Macro matches. Nothing to do.
1272   } else if (!CurrentDefinition) {
1273     // This macro was defined on the command line, then #undef'd later.
1274     // Complain.
1275     PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
1276       << true << ConfigMacro << Mod->getFullModuleName();
1277     auto LatestDef = LatestLocalMD->getDefinition();
1278     assert(LatestDef.isUndefined() &&
1279            "predefined macro went away with no #undef?");
1280     PP.Diag(LatestDef.getUndefLocation(), diag::note_module_def_undef_here)
1281       << true;
1282     return;
1283   } else if (!CmdLineDefinition) {
1284     // There was no definition for this macro in the predefines buffer,
1285     // but there was a local definition. Complain.
1286     PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
1287       << false << ConfigMacro << Mod->getFullModuleName();
1288     PP.Diag(CurrentDefinition->getDefinitionLoc(),
1289             diag::note_module_def_undef_here)
1290       << false;
1291   } else if (!CurrentDefinition->isIdenticalTo(*CmdLineDefinition, PP,
1292                                                /*Syntactically=*/true)) {
1293     // The macro definitions differ.
1294     PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
1295       << false << ConfigMacro << Mod->getFullModuleName();
1296     PP.Diag(CurrentDefinition->getDefinitionLoc(),
1297             diag::note_module_def_undef_here)
1298       << false;
1299   }
1300 }
1301 
1302 /// \brief Write a new timestamp file with the given path.
1303 static void writeTimestampFile(StringRef TimestampFile) {
1304   std::error_code EC;
1305   llvm::raw_fd_ostream Out(TimestampFile.str(), EC, llvm::sys::fs::F_None);
1306 }
1307 
1308 /// \brief Prune the module cache of modules that haven't been accessed in
1309 /// a long time.
1310 static void pruneModuleCache(const HeaderSearchOptions &HSOpts) {
1311   struct stat StatBuf;
1312   llvm::SmallString<128> TimestampFile;
1313   TimestampFile = HSOpts.ModuleCachePath;
1314   assert(!TimestampFile.empty());
1315   llvm::sys::path::append(TimestampFile, "modules.timestamp");
1316 
1317   // Try to stat() the timestamp file.
1318   if (::stat(TimestampFile.c_str(), &StatBuf)) {
1319     // If the timestamp file wasn't there, create one now.
1320     if (errno == ENOENT) {
1321       writeTimestampFile(TimestampFile);
1322     }
1323     return;
1324   }
1325 
1326   // Check whether the time stamp is older than our pruning interval.
1327   // If not, do nothing.
1328   time_t TimeStampModTime = StatBuf.st_mtime;
1329   time_t CurrentTime = time(nullptr);
1330   if (CurrentTime - TimeStampModTime <= time_t(HSOpts.ModuleCachePruneInterval))
1331     return;
1332 
1333   // Write a new timestamp file so that nobody else attempts to prune.
1334   // There is a benign race condition here, if two Clang instances happen to
1335   // notice at the same time that the timestamp is out-of-date.
1336   writeTimestampFile(TimestampFile);
1337 
1338   // Walk the entire module cache, looking for unused module files and module
1339   // indices.
1340   std::error_code EC;
1341   SmallString<128> ModuleCachePathNative;
1342   llvm::sys::path::native(HSOpts.ModuleCachePath, ModuleCachePathNative);
1343   for (llvm::sys::fs::directory_iterator Dir(ModuleCachePathNative, EC), DirEnd;
1344        Dir != DirEnd && !EC; Dir.increment(EC)) {
1345     // If we don't have a directory, there's nothing to look into.
1346     if (!llvm::sys::fs::is_directory(Dir->path()))
1347       continue;
1348 
1349     // Walk all of the files within this directory.
1350     for (llvm::sys::fs::directory_iterator File(Dir->path(), EC), FileEnd;
1351          File != FileEnd && !EC; File.increment(EC)) {
1352       // We only care about module and global module index files.
1353       StringRef Extension = llvm::sys::path::extension(File->path());
1354       if (Extension != ".pcm" && Extension != ".timestamp" &&
1355           llvm::sys::path::filename(File->path()) != "modules.idx")
1356         continue;
1357 
1358       // Look at this file. If we can't stat it, there's nothing interesting
1359       // there.
1360       if (::stat(File->path().c_str(), &StatBuf))
1361         continue;
1362 
1363       // If the file has been used recently enough, leave it there.
1364       time_t FileAccessTime = StatBuf.st_atime;
1365       if (CurrentTime - FileAccessTime <=
1366               time_t(HSOpts.ModuleCachePruneAfter)) {
1367         continue;
1368       }
1369 
1370       // Remove the file.
1371       llvm::sys::fs::remove(File->path());
1372 
1373       // Remove the timestamp file.
1374       std::string TimpestampFilename = File->path() + ".timestamp";
1375       llvm::sys::fs::remove(TimpestampFilename);
1376     }
1377 
1378     // If we removed all of the files in the directory, remove the directory
1379     // itself.
1380     if (llvm::sys::fs::directory_iterator(Dir->path(), EC) ==
1381             llvm::sys::fs::directory_iterator() && !EC)
1382       llvm::sys::fs::remove(Dir->path());
1383   }
1384 }
1385 
1386 void CompilerInstance::createModuleManager() {
1387   if (!ModuleManager) {
1388     if (!hasASTContext())
1389       createASTContext();
1390 
1391     // If we're implicitly building modules but not currently recursively
1392     // building a module, check whether we need to prune the module cache.
1393     if (getSourceManager().getModuleBuildStack().empty() &&
1394         !getPreprocessor().getHeaderSearchInfo().getModuleCachePath().empty() &&
1395         getHeaderSearchOpts().ModuleCachePruneInterval > 0 &&
1396         getHeaderSearchOpts().ModuleCachePruneAfter > 0) {
1397       pruneModuleCache(getHeaderSearchOpts());
1398     }
1399 
1400     HeaderSearchOptions &HSOpts = getHeaderSearchOpts();
1401     std::string Sysroot = HSOpts.Sysroot;
1402     const PreprocessorOptions &PPOpts = getPreprocessorOpts();
1403     std::unique_ptr<llvm::Timer> ReadTimer;
1404     if (FrontendTimerGroup)
1405       ReadTimer = llvm::make_unique<llvm::Timer>("reading_modules",
1406                                                  "Reading modules",
1407                                                  *FrontendTimerGroup);
1408     ModuleManager = new ASTReader(
1409         getPreprocessor(), getASTContext(), getPCHContainerReader(),
1410         getFrontendOpts().ModuleFileExtensions,
1411         Sysroot.empty() ? "" : Sysroot.c_str(), PPOpts.DisablePCHValidation,
1412         /*AllowASTWithCompilerErrors=*/false,
1413         /*AllowConfigurationMismatch=*/false,
1414         HSOpts.ModulesValidateSystemHeaders,
1415         getFrontendOpts().UseGlobalModuleIndex,
1416         std::move(ReadTimer));
1417     if (hasASTConsumer()) {
1418       ModuleManager->setDeserializationListener(
1419         getASTConsumer().GetASTDeserializationListener());
1420       getASTContext().setASTMutationListener(
1421         getASTConsumer().GetASTMutationListener());
1422     }
1423     getASTContext().setExternalSource(ModuleManager);
1424     if (hasSema())
1425       ModuleManager->InitializeSema(getSema());
1426     if (hasASTConsumer())
1427       ModuleManager->StartTranslationUnit(&getASTConsumer());
1428 
1429     if (TheDependencyFileGenerator)
1430       TheDependencyFileGenerator->AttachToASTReader(*ModuleManager);
1431     for (auto &Listener : DependencyCollectors)
1432       Listener->attachToASTReader(*ModuleManager);
1433   }
1434 }
1435 
1436 bool CompilerInstance::loadModuleFile(StringRef FileName) {
1437   llvm::Timer Timer;
1438   if (FrontendTimerGroup)
1439     Timer.init("preloading." + FileName.str(), "Preloading " + FileName.str(),
1440                *FrontendTimerGroup);
1441   llvm::TimeRegion TimeLoading(FrontendTimerGroup ? &Timer : nullptr);
1442 
1443   // Helper to recursively read the module names for all modules we're adding.
1444   // We mark these as known and redirect any attempt to load that module to
1445   // the files we were handed.
1446   struct ReadModuleNames : ASTReaderListener {
1447     CompilerInstance &CI;
1448     llvm::SmallVector<IdentifierInfo*, 8> LoadedModules;
1449 
1450     ReadModuleNames(CompilerInstance &CI) : CI(CI) {}
1451 
1452     void ReadModuleName(StringRef ModuleName) override {
1453       LoadedModules.push_back(
1454           CI.getPreprocessor().getIdentifierInfo(ModuleName));
1455     }
1456 
1457     void registerAll() {
1458       for (auto *II : LoadedModules) {
1459         CI.KnownModules[II] = CI.getPreprocessor()
1460                                   .getHeaderSearchInfo()
1461                                   .getModuleMap()
1462                                   .findModule(II->getName());
1463       }
1464       LoadedModules.clear();
1465     }
1466 
1467     void markAllUnavailable() {
1468       for (auto *II : LoadedModules) {
1469         if (Module *M = CI.getPreprocessor()
1470                             .getHeaderSearchInfo()
1471                             .getModuleMap()
1472                             .findModule(II->getName())) {
1473           M->HasIncompatibleModuleFile = true;
1474 
1475           // Mark module as available if the only reason it was unavailable
1476           // was missing headers.
1477           SmallVector<Module *, 2> Stack;
1478           Stack.push_back(M);
1479           while (!Stack.empty()) {
1480             Module *Current = Stack.pop_back_val();
1481             if (Current->IsMissingRequirement) continue;
1482             Current->IsAvailable = true;
1483             Stack.insert(Stack.end(),
1484                          Current->submodule_begin(), Current->submodule_end());
1485           }
1486         }
1487       }
1488       LoadedModules.clear();
1489     }
1490   };
1491 
1492   // If we don't already have an ASTReader, create one now.
1493   if (!ModuleManager)
1494     createModuleManager();
1495 
1496   auto Listener = llvm::make_unique<ReadModuleNames>(*this);
1497   auto &ListenerRef = *Listener;
1498   ASTReader::ListenerScope ReadModuleNamesListener(*ModuleManager,
1499                                                    std::move(Listener));
1500 
1501   // Try to load the module file.
1502   switch (ModuleManager->ReadAST(FileName, serialization::MK_ExplicitModule,
1503                                  SourceLocation(),
1504                                  ASTReader::ARR_ConfigurationMismatch)) {
1505   case ASTReader::Success:
1506     // We successfully loaded the module file; remember the set of provided
1507     // modules so that we don't try to load implicit modules for them.
1508     ListenerRef.registerAll();
1509     return true;
1510 
1511   case ASTReader::ConfigurationMismatch:
1512     // Ignore unusable module files.
1513     getDiagnostics().Report(SourceLocation(), diag::warn_module_config_mismatch)
1514         << FileName;
1515     // All modules provided by any files we tried and failed to load are now
1516     // unavailable; includes of those modules should now be handled textually.
1517     ListenerRef.markAllUnavailable();
1518     return true;
1519 
1520   default:
1521     return false;
1522   }
1523 }
1524 
1525 ModuleLoadResult
1526 CompilerInstance::loadModule(SourceLocation ImportLoc,
1527                              ModuleIdPath Path,
1528                              Module::NameVisibilityKind Visibility,
1529                              bool IsInclusionDirective) {
1530   // Determine what file we're searching from.
1531   StringRef ModuleName = Path[0].first->getName();
1532   SourceLocation ModuleNameLoc = Path[0].second;
1533 
1534   // If we've already handled this import, just return the cached result.
1535   // This one-element cache is important to eliminate redundant diagnostics
1536   // when both the preprocessor and parser see the same import declaration.
1537   if (ImportLoc.isValid() && LastModuleImportLoc == ImportLoc) {
1538     // Make the named module visible.
1539     if (LastModuleImportResult && ModuleName != getLangOpts().CurrentModule)
1540       ModuleManager->makeModuleVisible(LastModuleImportResult, Visibility,
1541                                        ImportLoc);
1542     return LastModuleImportResult;
1543   }
1544 
1545   clang::Module *Module = nullptr;
1546 
1547   // If we don't already have information on this module, load the module now.
1548   llvm::DenseMap<const IdentifierInfo *, clang::Module *>::iterator Known
1549     = KnownModules.find(Path[0].first);
1550   if (Known != KnownModules.end()) {
1551     // Retrieve the cached top-level module.
1552     Module = Known->second;
1553   } else if (ModuleName == getLangOpts().CurrentModule) {
1554     // This is the module we're building.
1555     Module = PP->getHeaderSearchInfo().lookupModule(ModuleName);
1556     Known = KnownModules.insert(std::make_pair(Path[0].first, Module)).first;
1557   } else {
1558     // Search for a module with the given name.
1559     Module = PP->getHeaderSearchInfo().lookupModule(ModuleName);
1560     HeaderSearchOptions &HSOpts =
1561         PP->getHeaderSearchInfo().getHeaderSearchOpts();
1562 
1563     std::string ModuleFileName;
1564     bool LoadFromPrebuiltModulePath = false;
1565     // We try to load the module from the prebuilt module paths. If not
1566     // successful, we then try to find it in the module cache.
1567     if (!HSOpts.PrebuiltModulePaths.empty()) {
1568       // Load the module from the prebuilt module path.
1569       ModuleFileName = PP->getHeaderSearchInfo().getModuleFileName(
1570           ModuleName, "", /*UsePrebuiltPath*/ true);
1571       if (!ModuleFileName.empty())
1572         LoadFromPrebuiltModulePath = true;
1573     }
1574     if (!LoadFromPrebuiltModulePath && Module) {
1575       // Load the module from the module cache.
1576       ModuleFileName = PP->getHeaderSearchInfo().getModuleFileName(Module);
1577     } else if (!LoadFromPrebuiltModulePath) {
1578       // We can't find a module, error out here.
1579       getDiagnostics().Report(ModuleNameLoc, diag::err_module_not_found)
1580       << ModuleName
1581       << SourceRange(ImportLoc, ModuleNameLoc);
1582       ModuleBuildFailed = true;
1583       return ModuleLoadResult();
1584     }
1585 
1586     if (ModuleFileName.empty()) {
1587       if (Module && Module->HasIncompatibleModuleFile) {
1588         // We tried and failed to load a module file for this module. Fall
1589         // back to textual inclusion for its headers.
1590         return ModuleLoadResult::ConfigMismatch;
1591       }
1592 
1593       getDiagnostics().Report(ModuleNameLoc, diag::err_module_build_disabled)
1594           << ModuleName;
1595       ModuleBuildFailed = true;
1596       return ModuleLoadResult();
1597     }
1598 
1599     // If we don't already have an ASTReader, create one now.
1600     if (!ModuleManager)
1601       createModuleManager();
1602 
1603     llvm::Timer Timer;
1604     if (FrontendTimerGroup)
1605       Timer.init("loading." + ModuleFileName, "Loading " + ModuleFileName,
1606                  *FrontendTimerGroup);
1607     llvm::TimeRegion TimeLoading(FrontendTimerGroup ? &Timer : nullptr);
1608 
1609     // Try to load the module file. If we are trying to load from the prebuilt
1610     // module path, we don't have the module map files and don't know how to
1611     // rebuild modules.
1612     unsigned ARRFlags = LoadFromPrebuiltModulePath ?
1613                         ASTReader::ARR_ConfigurationMismatch :
1614                         ASTReader::ARR_OutOfDate | ASTReader::ARR_Missing;
1615     switch (ModuleManager->ReadAST(ModuleFileName,
1616                                    LoadFromPrebuiltModulePath ?
1617                                    serialization::MK_PrebuiltModule :
1618                                    serialization::MK_ImplicitModule,
1619                                    ImportLoc,
1620                                    ARRFlags)) {
1621     case ASTReader::Success: {
1622       if (LoadFromPrebuiltModulePath && !Module) {
1623         Module = PP->getHeaderSearchInfo().lookupModule(ModuleName);
1624         if (!Module || !Module->getASTFile() ||
1625             FileMgr->getFile(ModuleFileName) != Module->getASTFile()) {
1626           // Error out if Module does not refer to the file in the prebuilt
1627           // module path.
1628           getDiagnostics().Report(ModuleNameLoc, diag::err_module_prebuilt)
1629               << ModuleName;
1630           ModuleBuildFailed = true;
1631           KnownModules[Path[0].first] = nullptr;
1632           return ModuleLoadResult();
1633         }
1634       }
1635       break;
1636     }
1637 
1638     case ASTReader::OutOfDate:
1639     case ASTReader::Missing: {
1640       if (LoadFromPrebuiltModulePath) {
1641         // We can't rebuild the module without a module map. Since ReadAST
1642         // already produces diagnostics for these two cases, we simply
1643         // error out here.
1644         ModuleBuildFailed = true;
1645         KnownModules[Path[0].first] = nullptr;
1646         return ModuleLoadResult();
1647       }
1648 
1649       // The module file is missing or out-of-date. Build it.
1650       assert(Module && "missing module file");
1651       // Check whether there is a cycle in the module graph.
1652       ModuleBuildStack ModPath = getSourceManager().getModuleBuildStack();
1653       ModuleBuildStack::iterator Pos = ModPath.begin(), PosEnd = ModPath.end();
1654       for (; Pos != PosEnd; ++Pos) {
1655         if (Pos->first == ModuleName)
1656           break;
1657       }
1658 
1659       if (Pos != PosEnd) {
1660         SmallString<256> CyclePath;
1661         for (; Pos != PosEnd; ++Pos) {
1662           CyclePath += Pos->first;
1663           CyclePath += " -> ";
1664         }
1665         CyclePath += ModuleName;
1666 
1667         getDiagnostics().Report(ModuleNameLoc, diag::err_module_cycle)
1668           << ModuleName << CyclePath;
1669         return ModuleLoadResult();
1670       }
1671 
1672       // Check whether we have already attempted to build this module (but
1673       // failed).
1674       if (getPreprocessorOpts().FailedModules &&
1675           getPreprocessorOpts().FailedModules->hasAlreadyFailed(ModuleName)) {
1676         getDiagnostics().Report(ModuleNameLoc, diag::err_module_not_built)
1677           << ModuleName
1678           << SourceRange(ImportLoc, ModuleNameLoc);
1679         ModuleBuildFailed = true;
1680         return ModuleLoadResult();
1681       }
1682 
1683       // Try to compile and then load the module.
1684       if (!compileAndLoadModule(*this, ImportLoc, ModuleNameLoc, Module,
1685                                 ModuleFileName)) {
1686         assert(getDiagnostics().hasErrorOccurred() &&
1687                "undiagnosed error in compileAndLoadModule");
1688         if (getPreprocessorOpts().FailedModules)
1689           getPreprocessorOpts().FailedModules->addFailed(ModuleName);
1690         KnownModules[Path[0].first] = nullptr;
1691         ModuleBuildFailed = true;
1692         return ModuleLoadResult();
1693       }
1694 
1695       // Okay, we've rebuilt and now loaded the module.
1696       break;
1697     }
1698 
1699     case ASTReader::ConfigurationMismatch:
1700       if (LoadFromPrebuiltModulePath)
1701         getDiagnostics().Report(SourceLocation(),
1702                                 diag::warn_module_config_mismatch)
1703             << ModuleFileName;
1704       // Fall through to error out.
1705     case ASTReader::VersionMismatch:
1706     case ASTReader::HadErrors:
1707       ModuleLoader::HadFatalFailure = true;
1708       // FIXME: The ASTReader will already have complained, but can we shoehorn
1709       // that diagnostic information into a more useful form?
1710       KnownModules[Path[0].first] = nullptr;
1711       return ModuleLoadResult();
1712 
1713     case ASTReader::Failure:
1714       ModuleLoader::HadFatalFailure = true;
1715       // Already complained, but note now that we failed.
1716       KnownModules[Path[0].first] = nullptr;
1717       ModuleBuildFailed = true;
1718       return ModuleLoadResult();
1719     }
1720 
1721     // Cache the result of this top-level module lookup for later.
1722     Known = KnownModules.insert(std::make_pair(Path[0].first, Module)).first;
1723   }
1724 
1725   // If we never found the module, fail.
1726   if (!Module)
1727     return ModuleLoadResult();
1728 
1729   // Verify that the rest of the module path actually corresponds to
1730   // a submodule.
1731   if (Path.size() > 1) {
1732     for (unsigned I = 1, N = Path.size(); I != N; ++I) {
1733       StringRef Name = Path[I].first->getName();
1734       clang::Module *Sub = Module->findSubmodule(Name);
1735 
1736       if (!Sub) {
1737         // Attempt to perform typo correction to find a module name that works.
1738         SmallVector<StringRef, 2> Best;
1739         unsigned BestEditDistance = (std::numeric_limits<unsigned>::max)();
1740 
1741         for (clang::Module::submodule_iterator J = Module->submodule_begin(),
1742                                             JEnd = Module->submodule_end();
1743              J != JEnd; ++J) {
1744           unsigned ED = Name.edit_distance((*J)->Name,
1745                                            /*AllowReplacements=*/true,
1746                                            BestEditDistance);
1747           if (ED <= BestEditDistance) {
1748             if (ED < BestEditDistance) {
1749               Best.clear();
1750               BestEditDistance = ED;
1751             }
1752 
1753             Best.push_back((*J)->Name);
1754           }
1755         }
1756 
1757         // If there was a clear winner, user it.
1758         if (Best.size() == 1) {
1759           getDiagnostics().Report(Path[I].second,
1760                                   diag::err_no_submodule_suggest)
1761             << Path[I].first << Module->getFullModuleName() << Best[0]
1762             << SourceRange(Path[0].second, Path[I-1].second)
1763             << FixItHint::CreateReplacement(SourceRange(Path[I].second),
1764                                             Best[0]);
1765 
1766           Sub = Module->findSubmodule(Best[0]);
1767         }
1768       }
1769 
1770       if (!Sub) {
1771         // No submodule by this name. Complain, and don't look for further
1772         // submodules.
1773         getDiagnostics().Report(Path[I].second, diag::err_no_submodule)
1774           << Path[I].first << Module->getFullModuleName()
1775           << SourceRange(Path[0].second, Path[I-1].second);
1776         break;
1777       }
1778 
1779       Module = Sub;
1780     }
1781   }
1782 
1783   // Make the named module visible, if it's not already part of the module
1784   // we are parsing.
1785   if (ModuleName != getLangOpts().CurrentModule) {
1786     if (!Module->IsFromModuleFile) {
1787       // We have an umbrella header or directory that doesn't actually include
1788       // all of the headers within the directory it covers. Complain about
1789       // this missing submodule and recover by forgetting that we ever saw
1790       // this submodule.
1791       // FIXME: Should we detect this at module load time? It seems fairly
1792       // expensive (and rare).
1793       getDiagnostics().Report(ImportLoc, diag::warn_missing_submodule)
1794         << Module->getFullModuleName()
1795         << SourceRange(Path.front().second, Path.back().second);
1796 
1797       return ModuleLoadResult::MissingExpected;
1798     }
1799 
1800     // Check whether this module is available.
1801     clang::Module::Requirement Requirement;
1802     clang::Module::UnresolvedHeaderDirective MissingHeader;
1803     if (!Module->isAvailable(getLangOpts(), getTarget(), Requirement,
1804                              MissingHeader)) {
1805       if (MissingHeader.FileNameLoc.isValid()) {
1806         getDiagnostics().Report(MissingHeader.FileNameLoc,
1807                                 diag::err_module_header_missing)
1808           << MissingHeader.IsUmbrella << MissingHeader.FileName;
1809       } else {
1810         getDiagnostics().Report(ImportLoc, diag::err_module_unavailable)
1811           << Module->getFullModuleName()
1812           << Requirement.second << Requirement.first
1813           << SourceRange(Path.front().second, Path.back().second);
1814       }
1815       LastModuleImportLoc = ImportLoc;
1816       LastModuleImportResult = ModuleLoadResult();
1817       return ModuleLoadResult();
1818     }
1819 
1820     ModuleManager->makeModuleVisible(Module, Visibility, ImportLoc);
1821   }
1822 
1823   // Check for any configuration macros that have changed.
1824   clang::Module *TopModule = Module->getTopLevelModule();
1825   for (unsigned I = 0, N = TopModule->ConfigMacros.size(); I != N; ++I) {
1826     checkConfigMacro(getPreprocessor(), TopModule->ConfigMacros[I],
1827                      Module, ImportLoc);
1828   }
1829 
1830   LastModuleImportLoc = ImportLoc;
1831   LastModuleImportResult = ModuleLoadResult(Module);
1832   return LastModuleImportResult;
1833 }
1834 
1835 void CompilerInstance::makeModuleVisible(Module *Mod,
1836                                          Module::NameVisibilityKind Visibility,
1837                                          SourceLocation ImportLoc) {
1838   if (!ModuleManager)
1839     createModuleManager();
1840   if (!ModuleManager)
1841     return;
1842 
1843   ModuleManager->makeModuleVisible(Mod, Visibility, ImportLoc);
1844 }
1845 
1846 GlobalModuleIndex *CompilerInstance::loadGlobalModuleIndex(
1847     SourceLocation TriggerLoc) {
1848   if (getPreprocessor().getHeaderSearchInfo().getModuleCachePath().empty())
1849     return nullptr;
1850   if (!ModuleManager)
1851     createModuleManager();
1852   // Can't do anything if we don't have the module manager.
1853   if (!ModuleManager)
1854     return nullptr;
1855   // Get an existing global index.  This loads it if not already
1856   // loaded.
1857   ModuleManager->loadGlobalIndex();
1858   GlobalModuleIndex *GlobalIndex = ModuleManager->getGlobalIndex();
1859   // If the global index doesn't exist, create it.
1860   if (!GlobalIndex && shouldBuildGlobalModuleIndex() && hasFileManager() &&
1861       hasPreprocessor()) {
1862     llvm::sys::fs::create_directories(
1863       getPreprocessor().getHeaderSearchInfo().getModuleCachePath());
1864     GlobalModuleIndex::writeIndex(
1865         getFileManager(), getPCHContainerReader(),
1866         getPreprocessor().getHeaderSearchInfo().getModuleCachePath());
1867     ModuleManager->resetForReload();
1868     ModuleManager->loadGlobalIndex();
1869     GlobalIndex = ModuleManager->getGlobalIndex();
1870   }
1871   // For finding modules needing to be imported for fixit messages,
1872   // we need to make the global index cover all modules, so we do that here.
1873   if (!HaveFullGlobalModuleIndex && GlobalIndex && !buildingModule()) {
1874     ModuleMap &MMap = getPreprocessor().getHeaderSearchInfo().getModuleMap();
1875     bool RecreateIndex = false;
1876     for (ModuleMap::module_iterator I = MMap.module_begin(),
1877         E = MMap.module_end(); I != E; ++I) {
1878       Module *TheModule = I->second;
1879       const FileEntry *Entry = TheModule->getASTFile();
1880       if (!Entry) {
1881         SmallVector<std::pair<IdentifierInfo *, SourceLocation>, 2> Path;
1882         Path.push_back(std::make_pair(
1883             getPreprocessor().getIdentifierInfo(TheModule->Name), TriggerLoc));
1884         std::reverse(Path.begin(), Path.end());
1885         // Load a module as hidden.  This also adds it to the global index.
1886         loadModule(TheModule->DefinitionLoc, Path, Module::Hidden, false);
1887         RecreateIndex = true;
1888       }
1889     }
1890     if (RecreateIndex) {
1891       GlobalModuleIndex::writeIndex(
1892           getFileManager(), getPCHContainerReader(),
1893           getPreprocessor().getHeaderSearchInfo().getModuleCachePath());
1894       ModuleManager->resetForReload();
1895       ModuleManager->loadGlobalIndex();
1896       GlobalIndex = ModuleManager->getGlobalIndex();
1897     }
1898     HaveFullGlobalModuleIndex = true;
1899   }
1900   return GlobalIndex;
1901 }
1902 
1903 // Check global module index for missing imports.
1904 bool
1905 CompilerInstance::lookupMissingImports(StringRef Name,
1906                                        SourceLocation TriggerLoc) {
1907   // Look for the symbol in non-imported modules, but only if an error
1908   // actually occurred.
1909   if (!buildingModule()) {
1910     // Load global module index, or retrieve a previously loaded one.
1911     GlobalModuleIndex *GlobalIndex = loadGlobalModuleIndex(
1912       TriggerLoc);
1913 
1914     // Only if we have a global index.
1915     if (GlobalIndex) {
1916       GlobalModuleIndex::HitSet FoundModules;
1917 
1918       // Find the modules that reference the identifier.
1919       // Note that this only finds top-level modules.
1920       // We'll let diagnoseTypo find the actual declaration module.
1921       if (GlobalIndex->lookupIdentifier(Name, FoundModules))
1922         return true;
1923     }
1924   }
1925 
1926   return false;
1927 }
1928 void CompilerInstance::resetAndLeakSema() { BuryPointer(takeSema()); }
1929 
1930 void CompilerInstance::setExternalSemaSource(
1931     IntrusiveRefCntPtr<ExternalSemaSource> ESS) {
1932   ExternalSemaSrc = std::move(ESS);
1933 }
1934