xref: /llvm-project/clang/lib/Frontend/CompilerInstance.cpp (revision 527040e0c87ac8d6cdde46be51c1a93e098bb5fd)
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/Frontend/ChainedDiagnosticConsumer.h"
20 #include "clang/Frontend/FrontendAction.h"
21 #include "clang/Frontend/FrontendActions.h"
22 #include "clang/Frontend/FrontendDiagnostic.h"
23 #include "clang/Frontend/LogDiagnosticPrinter.h"
24 #include "clang/Frontend/SerializedDiagnosticPrinter.h"
25 #include "clang/Frontend/TextDiagnosticPrinter.h"
26 #include "clang/Frontend/Utils.h"
27 #include "clang/Frontend/VerifyDiagnosticConsumer.h"
28 #include "clang/Lex/HeaderSearch.h"
29 #include "clang/Lex/PTHManager.h"
30 #include "clang/Lex/Preprocessor.h"
31 #include "clang/Sema/CodeCompleteConsumer.h"
32 #include "clang/Sema/Sema.h"
33 #include "clang/Serialization/ASTReader.h"
34 #include "clang/Serialization/GlobalModuleIndex.h"
35 #include "llvm/ADT/Statistic.h"
36 #include "llvm/Config/config.h"
37 #include "llvm/Support/CrashRecoveryContext.h"
38 #include "llvm/Support/FileSystem.h"
39 #include "llvm/Support/Host.h"
40 #include "llvm/Support/LockFileManager.h"
41 #include "llvm/Support/MemoryBuffer.h"
42 #include "llvm/Support/Path.h"
43 #include "llvm/Support/Program.h"
44 #include "llvm/Support/Signals.h"
45 #include "llvm/Support/Timer.h"
46 #include "llvm/Support/raw_ostream.h"
47 #include "llvm/Support/system_error.h"
48 #include <sys/stat.h>
49 #include <time.h>
50 
51 using namespace clang;
52 
53 CompilerInstance::CompilerInstance(bool BuildingModule)
54   : ModuleLoader(BuildingModule),
55     Invocation(new CompilerInvocation()), ModuleManager(0),
56     BuildGlobalModuleIndex(false), HaveFullGlobalModuleIndex(false),
57     ModuleBuildFailed(false) {
58 }
59 
60 CompilerInstance::~CompilerInstance() {
61   assert(OutputFiles.empty() && "Still output files in flight?");
62 }
63 
64 void CompilerInstance::setInvocation(CompilerInvocation *Value) {
65   Invocation = Value;
66 }
67 
68 bool CompilerInstance::shouldBuildGlobalModuleIndex() const {
69   return (BuildGlobalModuleIndex ||
70           (ModuleManager && ModuleManager->isGlobalIndexUnavailable() &&
71            getFrontendOpts().GenerateGlobalModuleIndex)) &&
72          !ModuleBuildFailed;
73 }
74 
75 void CompilerInstance::setDiagnostics(DiagnosticsEngine *Value) {
76   Diagnostics = Value;
77 }
78 
79 void CompilerInstance::setTarget(TargetInfo *Value) {
80   Target = Value;
81 }
82 
83 void CompilerInstance::setFileManager(FileManager *Value) {
84   FileMgr = Value;
85   if (Value)
86     VirtualFileSystem = Value->getVirtualFileSystem();
87   else
88     VirtualFileSystem.reset();
89 }
90 
91 void CompilerInstance::setSourceManager(SourceManager *Value) {
92   SourceMgr = Value;
93 }
94 
95 void CompilerInstance::setPreprocessor(Preprocessor *Value) { PP = Value; }
96 
97 void CompilerInstance::setASTContext(ASTContext *Value) { Context = Value; }
98 
99 void CompilerInstance::setSema(Sema *S) {
100   TheSema.reset(S);
101 }
102 
103 void CompilerInstance::setASTConsumer(ASTConsumer *Value) {
104   Consumer.reset(Value);
105 }
106 
107 void CompilerInstance::setCodeCompletionConsumer(CodeCompleteConsumer *Value) {
108   CompletionConsumer.reset(Value);
109 }
110 
111 IntrusiveRefCntPtr<ASTReader> CompilerInstance::getModuleManager() const {
112   return ModuleManager;
113 }
114 void CompilerInstance::setModuleManager(IntrusiveRefCntPtr<ASTReader> Reader) {
115   ModuleManager = Reader;
116 }
117 
118 // Diagnostics
119 static void SetUpDiagnosticLog(DiagnosticOptions *DiagOpts,
120                                const CodeGenOptions *CodeGenOpts,
121                                DiagnosticsEngine &Diags) {
122   std::string ErrorInfo;
123   bool OwnsStream = false;
124   raw_ostream *OS = &llvm::errs();
125   if (DiagOpts->DiagnosticLogFile != "-") {
126     // Create the output stream.
127     llvm::raw_fd_ostream *FileOS(new llvm::raw_fd_ostream(
128         DiagOpts->DiagnosticLogFile.c_str(), ErrorInfo,
129         llvm::sys::fs::F_Append | llvm::sys::fs::F_Text));
130     if (!ErrorInfo.empty()) {
131       Diags.Report(diag::warn_fe_cc_log_diagnostics_failure)
132         << DiagOpts->DiagnosticLogFile << ErrorInfo;
133     } else {
134       FileOS->SetUnbuffered();
135       FileOS->SetUseAtomicWrites(true);
136       OS = FileOS;
137       OwnsStream = true;
138     }
139   }
140 
141   // Chain in the diagnostic client which will log the diagnostics.
142   LogDiagnosticPrinter *Logger = new LogDiagnosticPrinter(*OS, DiagOpts,
143                                                           OwnsStream);
144   if (CodeGenOpts)
145     Logger->setDwarfDebugFlags(CodeGenOpts->DwarfDebugFlags);
146   Diags.setClient(new ChainedDiagnosticConsumer(Diags.takeClient(), Logger));
147 }
148 
149 static void SetupSerializedDiagnostics(DiagnosticOptions *DiagOpts,
150                                        DiagnosticsEngine &Diags,
151                                        StringRef OutputFile) {
152   std::string ErrorInfo;
153   std::unique_ptr<llvm::raw_fd_ostream> OS;
154   OS.reset(new llvm::raw_fd_ostream(OutputFile.str().c_str(), ErrorInfo,
155                                     llvm::sys::fs::F_None));
156 
157   if (!ErrorInfo.empty()) {
158     Diags.Report(diag::warn_fe_serialized_diag_failure)
159       << OutputFile << ErrorInfo;
160     return;
161   }
162 
163   DiagnosticConsumer *SerializedConsumer =
164       clang::serialized_diags::create(OS.release(), DiagOpts);
165 
166   Diags.setClient(new ChainedDiagnosticConsumer(Diags.takeClient(),
167                                                 SerializedConsumer));
168 }
169 
170 void CompilerInstance::createDiagnostics(DiagnosticConsumer *Client,
171                                          bool ShouldOwnClient) {
172   Diagnostics = createDiagnostics(&getDiagnosticOpts(), Client,
173                                   ShouldOwnClient, &getCodeGenOpts());
174 }
175 
176 IntrusiveRefCntPtr<DiagnosticsEngine>
177 CompilerInstance::createDiagnostics(DiagnosticOptions *Opts,
178                                     DiagnosticConsumer *Client,
179                                     bool ShouldOwnClient,
180                                     const CodeGenOptions *CodeGenOpts) {
181   IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
182   IntrusiveRefCntPtr<DiagnosticsEngine>
183       Diags(new DiagnosticsEngine(DiagID, Opts));
184 
185   // Create the diagnostic client for reporting errors or for
186   // implementing -verify.
187   if (Client) {
188     Diags->setClient(Client, ShouldOwnClient);
189   } else
190     Diags->setClient(new TextDiagnosticPrinter(llvm::errs(), Opts));
191 
192   // Chain in -verify checker, if requested.
193   if (Opts->VerifyDiagnostics)
194     Diags->setClient(new VerifyDiagnosticConsumer(*Diags));
195 
196   // Chain in -diagnostic-log-file dumper, if requested.
197   if (!Opts->DiagnosticLogFile.empty())
198     SetUpDiagnosticLog(Opts, CodeGenOpts, *Diags);
199 
200   if (!Opts->DiagnosticSerializationFile.empty())
201     SetupSerializedDiagnostics(Opts, *Diags,
202                                Opts->DiagnosticSerializationFile);
203 
204   // Configure our handling of diagnostics.
205   ProcessWarningOptions(*Diags, *Opts);
206 
207   return Diags;
208 }
209 
210 // File Manager
211 
212 void CompilerInstance::createFileManager() {
213   if (!hasVirtualFileSystem()) {
214     // TODO: choose the virtual file system based on the CompilerInvocation.
215     setVirtualFileSystem(vfs::getRealFileSystem());
216   }
217   FileMgr = new FileManager(getFileSystemOpts(), VirtualFileSystem);
218 }
219 
220 // Source Manager
221 
222 void CompilerInstance::createSourceManager(FileManager &FileMgr) {
223   SourceMgr = new SourceManager(getDiagnostics(), FileMgr);
224 }
225 
226 // Preprocessor
227 
228 void CompilerInstance::createPreprocessor(TranslationUnitKind TUKind) {
229   const PreprocessorOptions &PPOpts = getPreprocessorOpts();
230 
231   // Create a PTH manager if we are using some form of a token cache.
232   PTHManager *PTHMgr = 0;
233   if (!PPOpts.TokenCache.empty())
234     PTHMgr = PTHManager::Create(PPOpts.TokenCache, getDiagnostics());
235 
236   // Create the Preprocessor.
237   HeaderSearch *HeaderInfo = new HeaderSearch(&getHeaderSearchOpts(),
238                                               getSourceManager(),
239                                               getDiagnostics(),
240                                               getLangOpts(),
241                                               &getTarget());
242   PP = new Preprocessor(&getPreprocessorOpts(), getDiagnostics(), getLangOpts(),
243                         getSourceManager(), *HeaderInfo, *this, PTHMgr,
244                         /*OwnsHeaderSearch=*/true, TUKind);
245   PP->Initialize(getTarget());
246 
247   // Note that this is different then passing PTHMgr to Preprocessor's ctor.
248   // That argument is used as the IdentifierInfoLookup argument to
249   // IdentifierTable's ctor.
250   if (PTHMgr) {
251     PTHMgr->setPreprocessor(&*PP);
252     PP->setPTHManager(PTHMgr);
253   }
254 
255   if (PPOpts.DetailedRecord)
256     PP->createPreprocessingRecord();
257 
258   InitializePreprocessor(*PP, PPOpts, getHeaderSearchOpts(), getFrontendOpts());
259 
260   PP->setPreprocessedOutput(getPreprocessorOutputOpts().ShowCPP);
261 
262   // Set up the module path, including the hash for the
263   // module-creation options.
264   SmallString<256> SpecificModuleCache(
265                            getHeaderSearchOpts().ModuleCachePath);
266   if (!getHeaderSearchOpts().DisableModuleHash)
267     llvm::sys::path::append(SpecificModuleCache,
268                             getInvocation().getModuleHash());
269   PP->getHeaderSearchInfo().setModuleCachePath(SpecificModuleCache);
270 
271   // Handle generating dependencies, if requested.
272   const DependencyOutputOptions &DepOpts = getDependencyOutputOpts();
273   if (!DepOpts.OutputFile.empty())
274     TheDependencyFileGenerator.reset(
275         DependencyFileGenerator::CreateAndAttachToPreprocessor(*PP, DepOpts));
276   if (!DepOpts.DOTOutputFile.empty())
277     AttachDependencyGraphGen(*PP, DepOpts.DOTOutputFile,
278                              getHeaderSearchOpts().Sysroot);
279 
280 
281   // Handle generating header include information, if requested.
282   if (DepOpts.ShowHeaderIncludes)
283     AttachHeaderIncludeGen(*PP);
284   if (!DepOpts.HeaderIncludeOutputFile.empty()) {
285     StringRef OutputPath = DepOpts.HeaderIncludeOutputFile;
286     if (OutputPath == "-")
287       OutputPath = "";
288     AttachHeaderIncludeGen(*PP, /*ShowAllHeaders=*/true, OutputPath,
289                            /*ShowDepth=*/false);
290   }
291 
292   if (DepOpts.PrintShowIncludes) {
293     AttachHeaderIncludeGen(*PP, /*ShowAllHeaders=*/false, /*OutputPath=*/"",
294                            /*ShowDepth=*/true, /*MSStyle=*/true);
295   }
296 }
297 
298 // ASTContext
299 
300 void CompilerInstance::createASTContext() {
301   Preprocessor &PP = getPreprocessor();
302   Context = new ASTContext(getLangOpts(), PP.getSourceManager(),
303                            PP.getIdentifierTable(), PP.getSelectorTable(),
304                            PP.getBuiltinInfo());
305   Context->InitBuiltinTypes(getTarget());
306 }
307 
308 // ExternalASTSource
309 
310 void CompilerInstance::createPCHExternalASTSource(StringRef Path,
311                                                   bool DisablePCHValidation,
312                                                 bool AllowPCHWithCompilerErrors,
313                                                  void *DeserializationListener){
314   IntrusiveRefCntPtr<ExternalASTSource> Source;
315   bool Preamble = getPreprocessorOpts().PrecompiledPreambleBytes.first != 0;
316   Source = createPCHExternalASTSource(Path, getHeaderSearchOpts().Sysroot,
317                                           DisablePCHValidation,
318                                           AllowPCHWithCompilerErrors,
319                                           getPreprocessor(), getASTContext(),
320                                           DeserializationListener,
321                                           Preamble,
322                                        getFrontendOpts().UseGlobalModuleIndex);
323   ModuleManager = static_cast<ASTReader*>(Source.getPtr());
324   getASTContext().setExternalSource(Source);
325 }
326 
327 ExternalASTSource *
328 CompilerInstance::createPCHExternalASTSource(StringRef Path,
329                                              const std::string &Sysroot,
330                                              bool DisablePCHValidation,
331                                              bool AllowPCHWithCompilerErrors,
332                                              Preprocessor &PP,
333                                              ASTContext &Context,
334                                              void *DeserializationListener,
335                                              bool Preamble,
336                                              bool UseGlobalModuleIndex) {
337   HeaderSearchOptions &HSOpts = PP.getHeaderSearchInfo().getHeaderSearchOpts();
338 
339   std::unique_ptr<ASTReader> Reader;
340   Reader.reset(new ASTReader(PP, Context,
341                              Sysroot.empty() ? "" : Sysroot.c_str(),
342                              DisablePCHValidation,
343                              AllowPCHWithCompilerErrors,
344                              /*AllowConfigurationMismatch*/false,
345                              HSOpts.ModulesValidateSystemHeaders,
346                              UseGlobalModuleIndex));
347 
348   Reader->setDeserializationListener(
349             static_cast<ASTDeserializationListener *>(DeserializationListener));
350   switch (Reader->ReadAST(Path,
351                           Preamble ? serialization::MK_Preamble
352                                    : serialization::MK_PCH,
353                           SourceLocation(),
354                           ASTReader::ARR_None)) {
355   case ASTReader::Success:
356     // Set the predefines buffer as suggested by the PCH reader. Typically, the
357     // predefines buffer will be empty.
358     PP.setPredefines(Reader->getSuggestedPredefines());
359     return Reader.release();
360 
361   case ASTReader::Failure:
362     // Unrecoverable failure: don't even try to process the input file.
363     break;
364 
365   case ASTReader::Missing:
366   case ASTReader::OutOfDate:
367   case ASTReader::VersionMismatch:
368   case ASTReader::ConfigurationMismatch:
369   case ASTReader::HadErrors:
370     // No suitable PCH file could be found. Return an error.
371     break;
372   }
373 
374   return 0;
375 }
376 
377 // Code Completion
378 
379 static bool EnableCodeCompletion(Preprocessor &PP,
380                                  const std::string &Filename,
381                                  unsigned Line,
382                                  unsigned Column) {
383   // Tell the source manager to chop off the given file at a specific
384   // line and column.
385   const FileEntry *Entry = PP.getFileManager().getFile(Filename);
386   if (!Entry) {
387     PP.getDiagnostics().Report(diag::err_fe_invalid_code_complete_file)
388       << Filename;
389     return true;
390   }
391 
392   // Truncate the named file at the given line/column.
393   PP.SetCodeCompletionPoint(Entry, Line, Column);
394   return false;
395 }
396 
397 void CompilerInstance::createCodeCompletionConsumer() {
398   const ParsedSourceLocation &Loc = getFrontendOpts().CodeCompletionAt;
399   if (!CompletionConsumer) {
400     setCodeCompletionConsumer(
401       createCodeCompletionConsumer(getPreprocessor(),
402                                    Loc.FileName, Loc.Line, Loc.Column,
403                                    getFrontendOpts().CodeCompleteOpts,
404                                    llvm::outs()));
405     if (!CompletionConsumer)
406       return;
407   } else if (EnableCodeCompletion(getPreprocessor(), Loc.FileName,
408                                   Loc.Line, Loc.Column)) {
409     setCodeCompletionConsumer(0);
410     return;
411   }
412 
413   if (CompletionConsumer->isOutputBinary() &&
414       llvm::sys::ChangeStdoutToBinary()) {
415     getPreprocessor().getDiagnostics().Report(diag::err_fe_stdout_binary);
416     setCodeCompletionConsumer(0);
417   }
418 }
419 
420 void CompilerInstance::createFrontendTimer() {
421   FrontendTimer.reset(new llvm::Timer("Clang front-end timer"));
422 }
423 
424 CodeCompleteConsumer *
425 CompilerInstance::createCodeCompletionConsumer(Preprocessor &PP,
426                                                const std::string &Filename,
427                                                unsigned Line,
428                                                unsigned Column,
429                                                const CodeCompleteOptions &Opts,
430                                                raw_ostream &OS) {
431   if (EnableCodeCompletion(PP, Filename, Line, Column))
432     return 0;
433 
434   // Set up the creation routine for code-completion.
435   return new PrintingCodeCompleteConsumer(Opts, OS);
436 }
437 
438 void CompilerInstance::createSema(TranslationUnitKind TUKind,
439                                   CodeCompleteConsumer *CompletionConsumer) {
440   TheSema.reset(new Sema(getPreprocessor(), getASTContext(), getASTConsumer(),
441                          TUKind, CompletionConsumer));
442 }
443 
444 // Output Files
445 
446 void CompilerInstance::addOutputFile(const OutputFile &OutFile) {
447   assert(OutFile.OS && "Attempt to add empty stream to output list!");
448   OutputFiles.push_back(OutFile);
449 }
450 
451 void CompilerInstance::clearOutputFiles(bool EraseFiles) {
452   for (std::list<OutputFile>::iterator
453          it = OutputFiles.begin(), ie = OutputFiles.end(); it != ie; ++it) {
454     delete it->OS;
455     if (!it->TempFilename.empty()) {
456       if (EraseFiles) {
457         llvm::sys::fs::remove(it->TempFilename);
458       } else {
459         SmallString<128> NewOutFile(it->Filename);
460 
461         // If '-working-directory' was passed, the output filename should be
462         // relative to that.
463         FileMgr->FixupRelativePath(NewOutFile);
464         if (llvm::error_code ec = llvm::sys::fs::rename(it->TempFilename,
465                                                         NewOutFile.str())) {
466           getDiagnostics().Report(diag::err_unable_to_rename_temp)
467             << it->TempFilename << it->Filename << ec.message();
468 
469           llvm::sys::fs::remove(it->TempFilename);
470         }
471       }
472     } else if (!it->Filename.empty() && EraseFiles)
473       llvm::sys::fs::remove(it->Filename);
474 
475   }
476   OutputFiles.clear();
477 }
478 
479 llvm::raw_fd_ostream *
480 CompilerInstance::createDefaultOutputFile(bool Binary,
481                                           StringRef InFile,
482                                           StringRef Extension) {
483   return createOutputFile(getFrontendOpts().OutputFile, Binary,
484                           /*RemoveFileOnSignal=*/true, InFile, Extension,
485                           /*UseTemporary=*/true);
486 }
487 
488 llvm::raw_fd_ostream *
489 CompilerInstance::createOutputFile(StringRef OutputPath,
490                                    bool Binary, bool RemoveFileOnSignal,
491                                    StringRef InFile,
492                                    StringRef Extension,
493                                    bool UseTemporary,
494                                    bool CreateMissingDirectories) {
495   std::string Error, OutputPathName, TempPathName;
496   llvm::raw_fd_ostream *OS = createOutputFile(OutputPath, Error, Binary,
497                                               RemoveFileOnSignal,
498                                               InFile, Extension,
499                                               UseTemporary,
500                                               CreateMissingDirectories,
501                                               &OutputPathName,
502                                               &TempPathName);
503   if (!OS) {
504     getDiagnostics().Report(diag::err_fe_unable_to_open_output)
505       << OutputPath << Error;
506     return 0;
507   }
508 
509   // Add the output file -- but don't try to remove "-", since this means we are
510   // using stdin.
511   addOutputFile(OutputFile((OutputPathName != "-") ? OutputPathName : "",
512                 TempPathName, OS));
513 
514   return OS;
515 }
516 
517 llvm::raw_fd_ostream *
518 CompilerInstance::createOutputFile(StringRef OutputPath,
519                                    std::string &Error,
520                                    bool Binary,
521                                    bool RemoveFileOnSignal,
522                                    StringRef InFile,
523                                    StringRef Extension,
524                                    bool UseTemporary,
525                                    bool CreateMissingDirectories,
526                                    std::string *ResultPathName,
527                                    std::string *TempPathName) {
528   assert((!CreateMissingDirectories || UseTemporary) &&
529          "CreateMissingDirectories is only allowed when using temporary files");
530 
531   std::string OutFile, TempFile;
532   if (!OutputPath.empty()) {
533     OutFile = OutputPath;
534   } else if (InFile == "-") {
535     OutFile = "-";
536   } else if (!Extension.empty()) {
537     SmallString<128> Path(InFile);
538     llvm::sys::path::replace_extension(Path, Extension);
539     OutFile = Path.str();
540   } else {
541     OutFile = "-";
542   }
543 
544   std::unique_ptr<llvm::raw_fd_ostream> OS;
545   std::string OSFile;
546 
547   if (UseTemporary) {
548     if (OutFile == "-")
549       UseTemporary = false;
550     else {
551       llvm::sys::fs::file_status Status;
552       llvm::sys::fs::status(OutputPath, Status);
553       if (llvm::sys::fs::exists(Status)) {
554         // Fail early if we can't write to the final destination.
555         if (!llvm::sys::fs::can_write(OutputPath))
556           return 0;
557 
558         // Don't use a temporary if the output is a special file. This handles
559         // things like '-o /dev/null'
560         if (!llvm::sys::fs::is_regular_file(Status))
561           UseTemporary = false;
562       }
563     }
564   }
565 
566   if (UseTemporary) {
567     // Create a temporary file.
568     SmallString<128> TempPath;
569     TempPath = OutFile;
570     TempPath += "-%%%%%%%%";
571     int fd;
572     llvm::error_code EC =
573         llvm::sys::fs::createUniqueFile(TempPath.str(), fd, TempPath);
574 
575     if (CreateMissingDirectories &&
576         EC == llvm::errc::no_such_file_or_directory) {
577       StringRef Parent = llvm::sys::path::parent_path(OutputPath);
578       EC = llvm::sys::fs::create_directories(Parent);
579       if (!EC) {
580         EC = llvm::sys::fs::createUniqueFile(TempPath.str(), fd, TempPath);
581       }
582     }
583 
584     if (!EC) {
585       OS.reset(new llvm::raw_fd_ostream(fd, /*shouldClose=*/true));
586       OSFile = TempFile = TempPath.str();
587     }
588     // If we failed to create the temporary, fallback to writing to the file
589     // directly. This handles the corner case where we cannot write to the
590     // directory, but can write to the file.
591   }
592 
593   if (!OS) {
594     OSFile = OutFile;
595     OS.reset(new llvm::raw_fd_ostream(
596         OSFile.c_str(), Error,
597         (Binary ? llvm::sys::fs::F_None : llvm::sys::fs::F_Text)));
598     if (!Error.empty())
599       return 0;
600   }
601 
602   // Make sure the out stream file gets removed if we crash.
603   if (RemoveFileOnSignal)
604     llvm::sys::RemoveFileOnSignal(OSFile);
605 
606   if (ResultPathName)
607     *ResultPathName = OutFile;
608   if (TempPathName)
609     *TempPathName = TempFile;
610 
611   return OS.release();
612 }
613 
614 // Initialization Utilities
615 
616 bool CompilerInstance::InitializeSourceManager(const FrontendInputFile &Input){
617   return InitializeSourceManager(Input, getDiagnostics(),
618                                  getFileManager(), getSourceManager(),
619                                  getFrontendOpts());
620 }
621 
622 bool CompilerInstance::InitializeSourceManager(const FrontendInputFile &Input,
623                                                DiagnosticsEngine &Diags,
624                                                FileManager &FileMgr,
625                                                SourceManager &SourceMgr,
626                                                const FrontendOptions &Opts) {
627   SrcMgr::CharacteristicKind
628     Kind = Input.isSystem() ? SrcMgr::C_System : SrcMgr::C_User;
629 
630   if (Input.isBuffer()) {
631     SourceMgr.createMainFileIDForMemBuffer(Input.getBuffer(), Kind);
632     assert(!SourceMgr.getMainFileID().isInvalid() &&
633            "Couldn't establish MainFileID!");
634     return true;
635   }
636 
637   StringRef InputFile = Input.getFile();
638 
639   // Figure out where to get and map in the main file.
640   if (InputFile != "-") {
641     const FileEntry *File = FileMgr.getFile(InputFile, /*OpenFile=*/true);
642     if (!File) {
643       Diags.Report(diag::err_fe_error_reading) << InputFile;
644       return false;
645     }
646 
647     // The natural SourceManager infrastructure can't currently handle named
648     // pipes, but we would at least like to accept them for the main
649     // file. Detect them here, read them with the volatile flag so FileMgr will
650     // pick up the correct size, and simply override their contents as we do for
651     // STDIN.
652     if (File->isNamedPipe()) {
653       std::string ErrorStr;
654       if (llvm::MemoryBuffer *MB =
655               FileMgr.getBufferForFile(File, &ErrorStr, /*isVolatile=*/true)) {
656         // Create a new virtual file that will have the correct size.
657         File = FileMgr.getVirtualFile(InputFile, MB->getBufferSize(), 0);
658         SourceMgr.overrideFileContents(File, MB);
659       } else {
660         Diags.Report(diag::err_cannot_open_file) << InputFile << ErrorStr;
661         return false;
662       }
663     }
664 
665     SourceMgr.createMainFileID(File, Kind);
666   } else {
667     std::unique_ptr<llvm::MemoryBuffer> SB;
668     if (llvm::error_code ec = llvm::MemoryBuffer::getSTDIN(SB)) {
669       Diags.Report(diag::err_fe_error_reading_stdin) << ec.message();
670       return false;
671     }
672     const FileEntry *File = FileMgr.getVirtualFile(SB->getBufferIdentifier(),
673                                                    SB->getBufferSize(), 0);
674     SourceMgr.createMainFileID(File, Kind);
675     SourceMgr.overrideFileContents(File, SB.release());
676   }
677 
678   assert(!SourceMgr.getMainFileID().isInvalid() &&
679          "Couldn't establish MainFileID!");
680   return true;
681 }
682 
683 // High-Level Operations
684 
685 bool CompilerInstance::ExecuteAction(FrontendAction &Act) {
686   assert(hasDiagnostics() && "Diagnostics engine is not initialized!");
687   assert(!getFrontendOpts().ShowHelp && "Client must handle '-help'!");
688   assert(!getFrontendOpts().ShowVersion && "Client must handle '-version'!");
689 
690   // FIXME: Take this as an argument, once all the APIs we used have moved to
691   // taking it as an input instead of hard-coding llvm::errs.
692   raw_ostream &OS = llvm::errs();
693 
694   // Create the target instance.
695   setTarget(TargetInfo::CreateTargetInfo(getDiagnostics(), &getTargetOpts()));
696   if (!hasTarget())
697     return false;
698 
699   // Inform the target of the language options.
700   //
701   // FIXME: We shouldn't need to do this, the target should be immutable once
702   // created. This complexity should be lifted elsewhere.
703   getTarget().setForcedLangOptions(getLangOpts());
704 
705   // rewriter project will change target built-in bool type from its default.
706   if (getFrontendOpts().ProgramAction == frontend::RewriteObjC)
707     getTarget().noSignedCharForObjCBool();
708 
709   // Validate/process some options.
710   if (getHeaderSearchOpts().Verbose)
711     OS << "clang -cc1 version " CLANG_VERSION_STRING
712        << " based upon " << PACKAGE_STRING
713        << " default target " << llvm::sys::getDefaultTargetTriple() << "\n";
714 
715   if (getFrontendOpts().ShowTimers)
716     createFrontendTimer();
717 
718   if (getFrontendOpts().ShowStats)
719     llvm::EnableStatistics();
720 
721   for (unsigned i = 0, e = getFrontendOpts().Inputs.size(); i != e; ++i) {
722     // Reset the ID tables if we are reusing the SourceManager.
723     if (hasSourceManager())
724       getSourceManager().clearIDTables();
725 
726     if (Act.BeginSourceFile(*this, getFrontendOpts().Inputs[i])) {
727       Act.Execute();
728       Act.EndSourceFile();
729     }
730   }
731 
732   // Notify the diagnostic client that all files were processed.
733   getDiagnostics().getClient()->finish();
734 
735   if (getDiagnosticOpts().ShowCarets) {
736     // We can have multiple diagnostics sharing one diagnostic client.
737     // Get the total number of warnings/errors from the client.
738     unsigned NumWarnings = getDiagnostics().getClient()->getNumWarnings();
739     unsigned NumErrors = getDiagnostics().getClient()->getNumErrors();
740 
741     if (NumWarnings)
742       OS << NumWarnings << " warning" << (NumWarnings == 1 ? "" : "s");
743     if (NumWarnings && NumErrors)
744       OS << " and ";
745     if (NumErrors)
746       OS << NumErrors << " error" << (NumErrors == 1 ? "" : "s");
747     if (NumWarnings || NumErrors)
748       OS << " generated.\n";
749   }
750 
751   if (getFrontendOpts().ShowStats && hasFileManager()) {
752     getFileManager().PrintStats();
753     OS << "\n";
754   }
755 
756   return !getDiagnostics().getClient()->getNumErrors();
757 }
758 
759 /// \brief Determine the appropriate source input kind based on language
760 /// options.
761 static InputKind getSourceInputKindFromOptions(const LangOptions &LangOpts) {
762   if (LangOpts.OpenCL)
763     return IK_OpenCL;
764   if (LangOpts.CUDA)
765     return IK_CUDA;
766   if (LangOpts.ObjC1)
767     return LangOpts.CPlusPlus? IK_ObjCXX : IK_ObjC;
768   return LangOpts.CPlusPlus? IK_CXX : IK_C;
769 }
770 
771 /// \brief Compile a module file for the given module, using the options
772 /// provided by the importing compiler instance.
773 static void compileModuleImpl(CompilerInstance &ImportingInstance,
774                           SourceLocation ImportLoc,
775                           Module *Module,
776                           StringRef ModuleFileName) {
777   ModuleMap &ModMap
778     = ImportingInstance.getPreprocessor().getHeaderSearchInfo().getModuleMap();
779 
780   // Construct a compiler invocation for creating this module.
781   IntrusiveRefCntPtr<CompilerInvocation> Invocation
782     (new CompilerInvocation(ImportingInstance.getInvocation()));
783 
784   PreprocessorOptions &PPOpts = Invocation->getPreprocessorOpts();
785 
786   // For any options that aren't intended to affect how a module is built,
787   // reset them to their default values.
788   Invocation->getLangOpts()->resetNonModularOptions();
789   PPOpts.resetNonModularOptions();
790 
791   // Remove any macro definitions that are explicitly ignored by the module.
792   // They aren't supposed to affect how the module is built anyway.
793   const HeaderSearchOptions &HSOpts = Invocation->getHeaderSearchOpts();
794   PPOpts.Macros.erase(
795       std::remove_if(PPOpts.Macros.begin(), PPOpts.Macros.end(),
796                      [&HSOpts](const std::pair<std::string, bool> &def) {
797         StringRef MacroDef = def.first;
798         return HSOpts.ModulesIgnoreMacros.count(MacroDef.split('=').first) > 0;
799       }),
800       PPOpts.Macros.end());
801 
802   // Note the name of the module we're building.
803   Invocation->getLangOpts()->CurrentModule = Module->getTopLevelModuleName();
804 
805   // Make sure that the failed-module structure has been allocated in
806   // the importing instance, and propagate the pointer to the newly-created
807   // instance.
808   PreprocessorOptions &ImportingPPOpts
809     = ImportingInstance.getInvocation().getPreprocessorOpts();
810   if (!ImportingPPOpts.FailedModules)
811     ImportingPPOpts.FailedModules = new PreprocessorOptions::FailedModulesSet;
812   PPOpts.FailedModules = ImportingPPOpts.FailedModules;
813 
814   // If there is a module map file, build the module using the module map.
815   // Set up the inputs/outputs so that we build the module from its umbrella
816   // header.
817   FrontendOptions &FrontendOpts = Invocation->getFrontendOpts();
818   FrontendOpts.OutputFile = ModuleFileName.str();
819   FrontendOpts.DisableFree = false;
820   FrontendOpts.GenerateGlobalModuleIndex = false;
821   FrontendOpts.Inputs.clear();
822   InputKind IK = getSourceInputKindFromOptions(*Invocation->getLangOpts());
823 
824   // Don't free the remapped file buffers; they are owned by our caller.
825   PPOpts.RetainRemappedFileBuffers = true;
826 
827   Invocation->getDiagnosticOpts().VerifyDiagnostics = 0;
828   assert(ImportingInstance.getInvocation().getModuleHash() ==
829          Invocation->getModuleHash() && "Module hash mismatch!");
830 
831   // Construct a compiler instance that will be used to actually create the
832   // module.
833   CompilerInstance Instance(/*BuildingModule=*/true);
834   Instance.setInvocation(&*Invocation);
835 
836   Instance.createDiagnostics(new ForwardingDiagnosticConsumer(
837                                    ImportingInstance.getDiagnosticClient()),
838                              /*ShouldOwnClient=*/true);
839 
840   Instance.setVirtualFileSystem(&ImportingInstance.getVirtualFileSystem());
841 
842   // Note that this module is part of the module build stack, so that we
843   // can detect cycles in the module graph.
844   Instance.setFileManager(&ImportingInstance.getFileManager());
845   Instance.createSourceManager(Instance.getFileManager());
846   SourceManager &SourceMgr = Instance.getSourceManager();
847   SourceMgr.setModuleBuildStack(
848     ImportingInstance.getSourceManager().getModuleBuildStack());
849   SourceMgr.pushModuleBuildStack(Module->getTopLevelModuleName(),
850     FullSourceLoc(ImportLoc, ImportingInstance.getSourceManager()));
851 
852   // Get or create the module map that we'll use to build this module.
853   std::string InferredModuleMapContent;
854   if (const FileEntry *ModuleMapFile =
855           ModMap.getContainingModuleMapFile(Module)) {
856     // Use the module map where this module resides.
857     FrontendOpts.Inputs.push_back(
858         FrontendInputFile(ModuleMapFile->getName(), IK));
859   } else {
860     llvm::raw_string_ostream OS(InferredModuleMapContent);
861     Module->print(OS);
862     OS.flush();
863     FrontendOpts.Inputs.push_back(
864         FrontendInputFile("__inferred_module.map", IK));
865 
866     const llvm::MemoryBuffer *ModuleMapBuffer =
867         llvm::MemoryBuffer::getMemBuffer(InferredModuleMapContent);
868     ModuleMapFile = Instance.getFileManager().getVirtualFile(
869         "__inferred_module.map", InferredModuleMapContent.size(), 0);
870     SourceMgr.overrideFileContents(ModuleMapFile, ModuleMapBuffer);
871   }
872 
873   // Construct a module-generating action. Passing through Module->ModuleMap is
874   // safe because the FileManager is shared between the compiler instances.
875   GenerateModuleAction CreateModuleAction(Module->ModuleMap, Module->IsSystem);
876 
877   // Execute the action to actually build the module in-place. Use a separate
878   // thread so that we get a stack large enough.
879   const unsigned ThreadStackSize = 8 << 20;
880   llvm::CrashRecoveryContext CRC;
881   CRC.RunSafelyOnThread([&]() { Instance.ExecuteAction(CreateModuleAction); },
882                         ThreadStackSize);
883 
884   // Delete the temporary module map file.
885   // FIXME: Even though we're executing under crash protection, it would still
886   // be nice to do this with RemoveFileOnSignal when we can. However, that
887   // doesn't make sense for all clients, so clean this up manually.
888   Instance.clearOutputFiles(/*EraseFiles=*/true);
889 
890   // We've rebuilt a module. If we're allowed to generate or update the global
891   // module index, record that fact in the importing compiler instance.
892   if (ImportingInstance.getFrontendOpts().GenerateGlobalModuleIndex) {
893     ImportingInstance.setBuildGlobalModuleIndex(true);
894   }
895 }
896 
897 static void compileModule(CompilerInstance &ImportingInstance,
898                           SourceLocation ImportLoc,
899                           Module *Module,
900                           StringRef ModuleFileName) {
901   // FIXME: have LockFileManager return an error_code so that we can
902   // avoid the mkdir when the directory already exists.
903   StringRef Dir = llvm::sys::path::parent_path(ModuleFileName);
904   llvm::sys::fs::create_directories(Dir);
905 
906   while (1) {
907     llvm::LockFileManager Locked(ModuleFileName);
908     switch (Locked) {
909     case llvm::LockFileManager::LFS_Error:
910       return;
911 
912     case llvm::LockFileManager::LFS_Owned:
913       // We're responsible for building the module ourselves. Do so below.
914       break;
915 
916     case llvm::LockFileManager::LFS_Shared:
917       // Someone else is responsible for building the module. Wait for them to
918       // finish.
919       if (Locked.waitForUnlock() == llvm::LockFileManager::Res_OwnerDied)
920         continue; // try again to get the lock.
921       return;
922     }
923 
924     return compileModuleImpl(ImportingInstance, ImportLoc, Module,
925                              ModuleFileName);
926   }
927 }
928 
929 /// \brief Diagnose differences between the current definition of the given
930 /// configuration macro and the definition provided on the command line.
931 static void checkConfigMacro(Preprocessor &PP, StringRef ConfigMacro,
932                              Module *Mod, SourceLocation ImportLoc) {
933   IdentifierInfo *Id = PP.getIdentifierInfo(ConfigMacro);
934   SourceManager &SourceMgr = PP.getSourceManager();
935 
936   // If this identifier has never had a macro definition, then it could
937   // not have changed.
938   if (!Id->hadMacroDefinition())
939     return;
940 
941   // If this identifier does not currently have a macro definition,
942   // check whether it had one on the command line.
943   if (!Id->hasMacroDefinition()) {
944     MacroDirective::DefInfo LatestDef =
945         PP.getMacroDirectiveHistory(Id)->getDefinition();
946     for (MacroDirective::DefInfo Def = LatestDef; Def;
947            Def = Def.getPreviousDefinition()) {
948       FileID FID = SourceMgr.getFileID(Def.getLocation());
949       if (FID.isInvalid())
950         continue;
951 
952       // We only care about the predefines buffer.
953       if (FID != PP.getPredefinesFileID())
954         continue;
955 
956       // This macro was defined on the command line, then #undef'd later.
957       // Complain.
958       PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
959         << true << ConfigMacro << Mod->getFullModuleName();
960       if (LatestDef.isUndefined())
961         PP.Diag(LatestDef.getUndefLocation(), diag::note_module_def_undef_here)
962           << true;
963       return;
964     }
965 
966     // Okay: no definition in the predefines buffer.
967     return;
968   }
969 
970   // This identifier has a macro definition. Check whether we had a definition
971   // on the command line.
972   MacroDirective::DefInfo LatestDef =
973       PP.getMacroDirectiveHistory(Id)->getDefinition();
974   MacroDirective::DefInfo PredefinedDef;
975   for (MacroDirective::DefInfo Def = LatestDef; Def;
976          Def = Def.getPreviousDefinition()) {
977     FileID FID = SourceMgr.getFileID(Def.getLocation());
978     if (FID.isInvalid())
979       continue;
980 
981     // We only care about the predefines buffer.
982     if (FID != PP.getPredefinesFileID())
983       continue;
984 
985     PredefinedDef = Def;
986     break;
987   }
988 
989   // If there was no definition for this macro in the predefines buffer,
990   // complain.
991   if (!PredefinedDef ||
992       (!PredefinedDef.getLocation().isValid() &&
993        PredefinedDef.getUndefLocation().isValid())) {
994     PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
995       << false << ConfigMacro << Mod->getFullModuleName();
996     PP.Diag(LatestDef.getLocation(), diag::note_module_def_undef_here)
997       << false;
998     return;
999   }
1000 
1001   // If the current macro definition is the same as the predefined macro
1002   // definition, it's okay.
1003   if (LatestDef.getMacroInfo() == PredefinedDef.getMacroInfo() ||
1004       LatestDef.getMacroInfo()->isIdenticalTo(*PredefinedDef.getMacroInfo(),PP,
1005                                               /*Syntactically=*/true))
1006     return;
1007 
1008   // The macro definitions differ.
1009   PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
1010     << false << ConfigMacro << Mod->getFullModuleName();
1011   PP.Diag(LatestDef.getLocation(), diag::note_module_def_undef_here)
1012     << false;
1013 }
1014 
1015 /// \brief Write a new timestamp file with the given path.
1016 static void writeTimestampFile(StringRef TimestampFile) {
1017   std::string ErrorInfo;
1018   llvm::raw_fd_ostream Out(TimestampFile.str().c_str(), ErrorInfo,
1019                            llvm::sys::fs::F_None);
1020 }
1021 
1022 /// \brief Prune the module cache of modules that haven't been accessed in
1023 /// a long time.
1024 static void pruneModuleCache(const HeaderSearchOptions &HSOpts) {
1025   struct stat StatBuf;
1026   llvm::SmallString<128> TimestampFile;
1027   TimestampFile = HSOpts.ModuleCachePath;
1028   llvm::sys::path::append(TimestampFile, "modules.timestamp");
1029 
1030   // Try to stat() the timestamp file.
1031   if (::stat(TimestampFile.c_str(), &StatBuf)) {
1032     // If the timestamp file wasn't there, create one now.
1033     if (errno == ENOENT) {
1034       writeTimestampFile(TimestampFile);
1035     }
1036     return;
1037   }
1038 
1039   // Check whether the time stamp is older than our pruning interval.
1040   // If not, do nothing.
1041   time_t TimeStampModTime = StatBuf.st_mtime;
1042   time_t CurrentTime = time(0);
1043   if (CurrentTime - TimeStampModTime <= time_t(HSOpts.ModuleCachePruneInterval))
1044     return;
1045 
1046   // Write a new timestamp file so that nobody else attempts to prune.
1047   // There is a benign race condition here, if two Clang instances happen to
1048   // notice at the same time that the timestamp is out-of-date.
1049   writeTimestampFile(TimestampFile);
1050 
1051   // Walk the entire module cache, looking for unused module files and module
1052   // indices.
1053   llvm::error_code EC;
1054   SmallString<128> ModuleCachePathNative;
1055   llvm::sys::path::native(HSOpts.ModuleCachePath, ModuleCachePathNative);
1056   for (llvm::sys::fs::directory_iterator
1057          Dir(ModuleCachePathNative.str(), EC), DirEnd;
1058        Dir != DirEnd && !EC; Dir.increment(EC)) {
1059     // If we don't have a directory, there's nothing to look into.
1060     if (!llvm::sys::fs::is_directory(Dir->path()))
1061       continue;
1062 
1063     // Walk all of the files within this directory.
1064     for (llvm::sys::fs::directory_iterator File(Dir->path(), EC), FileEnd;
1065          File != FileEnd && !EC; File.increment(EC)) {
1066       // We only care about module and global module index files.
1067       StringRef Extension = llvm::sys::path::extension(File->path());
1068       if (Extension != ".pcm" && Extension != ".timestamp" &&
1069           llvm::sys::path::filename(File->path()) != "modules.idx")
1070         continue;
1071 
1072       // Look at this file. If we can't stat it, there's nothing interesting
1073       // there.
1074       if (::stat(File->path().c_str(), &StatBuf))
1075         continue;
1076 
1077       // If the file has been used recently enough, leave it there.
1078       time_t FileAccessTime = StatBuf.st_atime;
1079       if (CurrentTime - FileAccessTime <=
1080               time_t(HSOpts.ModuleCachePruneAfter)) {
1081         continue;
1082       }
1083 
1084       // Remove the file.
1085       llvm::sys::fs::remove(File->path());
1086 
1087       // Remove the timestamp file.
1088       std::string TimpestampFilename = File->path() + ".timestamp";
1089       llvm::sys::fs::remove(TimpestampFilename);
1090     }
1091 
1092     // If we removed all of the files in the directory, remove the directory
1093     // itself.
1094     if (llvm::sys::fs::directory_iterator(Dir->path(), EC) ==
1095             llvm::sys::fs::directory_iterator() && !EC)
1096       llvm::sys::fs::remove(Dir->path());
1097   }
1098 }
1099 
1100 void CompilerInstance::createModuleManager() {
1101   if (!ModuleManager) {
1102     if (!hasASTContext())
1103       createASTContext();
1104 
1105     // If we're not recursively building a module, check whether we
1106     // need to prune the module cache.
1107     if (getSourceManager().getModuleBuildStack().empty() &&
1108         getHeaderSearchOpts().ModuleCachePruneInterval > 0 &&
1109         getHeaderSearchOpts().ModuleCachePruneAfter > 0) {
1110       pruneModuleCache(getHeaderSearchOpts());
1111     }
1112 
1113     HeaderSearchOptions &HSOpts = getHeaderSearchOpts();
1114     std::string Sysroot = HSOpts.Sysroot;
1115     const PreprocessorOptions &PPOpts = getPreprocessorOpts();
1116     ModuleManager = new ASTReader(getPreprocessor(), *Context,
1117                                   Sysroot.empty() ? "" : Sysroot.c_str(),
1118                                   PPOpts.DisablePCHValidation,
1119                                   /*AllowASTWithCompilerErrors=*/false,
1120                                   /*AllowConfigurationMismatch=*/false,
1121                                   HSOpts.ModulesValidateSystemHeaders,
1122                                   getFrontendOpts().UseGlobalModuleIndex);
1123     if (hasASTConsumer()) {
1124       ModuleManager->setDeserializationListener(
1125         getASTConsumer().GetASTDeserializationListener());
1126       getASTContext().setASTMutationListener(
1127         getASTConsumer().GetASTMutationListener());
1128     }
1129     getASTContext().setExternalSource(ModuleManager);
1130     if (hasSema())
1131       ModuleManager->InitializeSema(getSema());
1132     if (hasASTConsumer())
1133       ModuleManager->StartTranslationUnit(&getASTConsumer());
1134   }
1135 }
1136 
1137 ModuleLoadResult
1138 CompilerInstance::loadModule(SourceLocation ImportLoc,
1139                              ModuleIdPath Path,
1140                              Module::NameVisibilityKind Visibility,
1141                              bool IsInclusionDirective) {
1142   // Determine what file we're searching from.
1143   StringRef ModuleName = Path[0].first->getName();
1144   SourceLocation ModuleNameLoc = Path[0].second;
1145 
1146   // If we've already handled this import, just return the cached result.
1147   // This one-element cache is important to eliminate redundant diagnostics
1148   // when both the preprocessor and parser see the same import declaration.
1149   if (!ImportLoc.isInvalid() && LastModuleImportLoc == ImportLoc) {
1150     // Make the named module visible.
1151     if (LastModuleImportResult && ModuleName != getLangOpts().CurrentModule)
1152       ModuleManager->makeModuleVisible(LastModuleImportResult, Visibility,
1153                                        ImportLoc, /*Complain=*/false);
1154     return LastModuleImportResult;
1155   }
1156 
1157   clang::Module *Module = 0;
1158 
1159   // If we don't already have information on this module, load the module now.
1160   llvm::DenseMap<const IdentifierInfo *, clang::Module *>::iterator Known
1161     = KnownModules.find(Path[0].first);
1162   if (Known != KnownModules.end()) {
1163     // Retrieve the cached top-level module.
1164     Module = Known->second;
1165   } else if (ModuleName == getLangOpts().CurrentModule) {
1166     // This is the module we're building.
1167     Module = PP->getHeaderSearchInfo().lookupModule(ModuleName);
1168     Known = KnownModules.insert(std::make_pair(Path[0].first, Module)).first;
1169   } else {
1170     // Search for a module with the given name.
1171     Module = PP->getHeaderSearchInfo().lookupModule(ModuleName);
1172     if (!Module) {
1173       getDiagnostics().Report(ModuleNameLoc, diag::err_module_not_found)
1174       << ModuleName
1175       << SourceRange(ImportLoc, ModuleNameLoc);
1176       ModuleBuildFailed = true;
1177       return ModuleLoadResult();
1178     }
1179 
1180     std::string ModuleFileName =
1181         PP->getHeaderSearchInfo().getModuleFileName(Module);
1182 
1183     // If we don't already have an ASTReader, create one now.
1184     if (!ModuleManager)
1185       createModuleManager();
1186 
1187     if (TheDependencyFileGenerator)
1188       TheDependencyFileGenerator->AttachToASTReader(*ModuleManager);
1189 
1190     // Try to load the module file.
1191     unsigned ARRFlags = ASTReader::ARR_OutOfDate | ASTReader::ARR_Missing;
1192     switch (ModuleManager->ReadAST(ModuleFileName, serialization::MK_Module,
1193                                    ImportLoc, ARRFlags)) {
1194     case ASTReader::Success:
1195       break;
1196 
1197     case ASTReader::OutOfDate:
1198     case ASTReader::Missing: {
1199       // The module file is missing or out-of-date. Build it.
1200       assert(Module && "missing module file");
1201       // Check whether there is a cycle in the module graph.
1202       ModuleBuildStack ModPath = getSourceManager().getModuleBuildStack();
1203       ModuleBuildStack::iterator Pos = ModPath.begin(), PosEnd = ModPath.end();
1204       for (; Pos != PosEnd; ++Pos) {
1205         if (Pos->first == ModuleName)
1206           break;
1207       }
1208 
1209       if (Pos != PosEnd) {
1210         SmallString<256> CyclePath;
1211         for (; Pos != PosEnd; ++Pos) {
1212           CyclePath += Pos->first;
1213           CyclePath += " -> ";
1214         }
1215         CyclePath += ModuleName;
1216 
1217         getDiagnostics().Report(ModuleNameLoc, diag::err_module_cycle)
1218           << ModuleName << CyclePath;
1219         return ModuleLoadResult();
1220       }
1221 
1222       // Check whether we have already attempted to build this module (but
1223       // failed).
1224       if (getPreprocessorOpts().FailedModules &&
1225           getPreprocessorOpts().FailedModules->hasAlreadyFailed(ModuleName)) {
1226         getDiagnostics().Report(ModuleNameLoc, diag::err_module_not_built)
1227           << ModuleName
1228           << SourceRange(ImportLoc, ModuleNameLoc);
1229         ModuleBuildFailed = true;
1230         return ModuleLoadResult();
1231       }
1232 
1233       // Try to compile the module.
1234       compileModule(*this, ModuleNameLoc, Module, ModuleFileName);
1235 
1236       // Try to read the module file, now that we've compiled it.
1237       ASTReader::ASTReadResult ReadResult
1238         = ModuleManager->ReadAST(ModuleFileName,
1239                                  serialization::MK_Module, ImportLoc,
1240                                  ASTReader::ARR_Missing);
1241       if (ReadResult != ASTReader::Success) {
1242         if (ReadResult == ASTReader::Missing) {
1243           getDiagnostics().Report(ModuleNameLoc,
1244                                   Module? diag::err_module_not_built
1245                                         : diag::err_module_not_found)
1246             << ModuleName
1247             << SourceRange(ImportLoc, ModuleNameLoc);
1248         }
1249 
1250         if (getPreprocessorOpts().FailedModules)
1251           getPreprocessorOpts().FailedModules->addFailed(ModuleName);
1252         KnownModules[Path[0].first] = 0;
1253         ModuleBuildFailed = true;
1254         return ModuleLoadResult();
1255       }
1256 
1257       // Okay, we've rebuilt and now loaded the module.
1258       break;
1259     }
1260 
1261     case ASTReader::VersionMismatch:
1262     case ASTReader::ConfigurationMismatch:
1263     case ASTReader::HadErrors:
1264       ModuleLoader::HadFatalFailure = true;
1265       // FIXME: The ASTReader will already have complained, but can we showhorn
1266       // that diagnostic information into a more useful form?
1267       KnownModules[Path[0].first] = 0;
1268       return ModuleLoadResult();
1269 
1270     case ASTReader::Failure:
1271       ModuleLoader::HadFatalFailure = true;
1272       // Already complained, but note now that we failed.
1273       KnownModules[Path[0].first] = 0;
1274       ModuleBuildFailed = true;
1275       return ModuleLoadResult();
1276     }
1277 
1278     // Cache the result of this top-level module lookup for later.
1279     Known = KnownModules.insert(std::make_pair(Path[0].first, Module)).first;
1280   }
1281 
1282   // If we never found the module, fail.
1283   if (!Module)
1284     return ModuleLoadResult();
1285 
1286   // Verify that the rest of the module path actually corresponds to
1287   // a submodule.
1288   if (Path.size() > 1) {
1289     for (unsigned I = 1, N = Path.size(); I != N; ++I) {
1290       StringRef Name = Path[I].first->getName();
1291       clang::Module *Sub = Module->findSubmodule(Name);
1292 
1293       if (!Sub) {
1294         // Attempt to perform typo correction to find a module name that works.
1295         SmallVector<StringRef, 2> Best;
1296         unsigned BestEditDistance = (std::numeric_limits<unsigned>::max)();
1297 
1298         for (clang::Module::submodule_iterator J = Module->submodule_begin(),
1299                                             JEnd = Module->submodule_end();
1300              J != JEnd; ++J) {
1301           unsigned ED = Name.edit_distance((*J)->Name,
1302                                            /*AllowReplacements=*/true,
1303                                            BestEditDistance);
1304           if (ED <= BestEditDistance) {
1305             if (ED < BestEditDistance) {
1306               Best.clear();
1307               BestEditDistance = ED;
1308             }
1309 
1310             Best.push_back((*J)->Name);
1311           }
1312         }
1313 
1314         // If there was a clear winner, user it.
1315         if (Best.size() == 1) {
1316           getDiagnostics().Report(Path[I].second,
1317                                   diag::err_no_submodule_suggest)
1318             << Path[I].first << Module->getFullModuleName() << Best[0]
1319             << SourceRange(Path[0].second, Path[I-1].second)
1320             << FixItHint::CreateReplacement(SourceRange(Path[I].second),
1321                                             Best[0]);
1322 
1323           Sub = Module->findSubmodule(Best[0]);
1324         }
1325       }
1326 
1327       if (!Sub) {
1328         // No submodule by this name. Complain, and don't look for further
1329         // submodules.
1330         getDiagnostics().Report(Path[I].second, diag::err_no_submodule)
1331           << Path[I].first << Module->getFullModuleName()
1332           << SourceRange(Path[0].second, Path[I-1].second);
1333         break;
1334       }
1335 
1336       Module = Sub;
1337     }
1338   }
1339 
1340   // Make the named module visible, if it's not already part of the module
1341   // we are parsing.
1342   if (ModuleName != getLangOpts().CurrentModule) {
1343     if (!Module->IsFromModuleFile) {
1344       // We have an umbrella header or directory that doesn't actually include
1345       // all of the headers within the directory it covers. Complain about
1346       // this missing submodule and recover by forgetting that we ever saw
1347       // this submodule.
1348       // FIXME: Should we detect this at module load time? It seems fairly
1349       // expensive (and rare).
1350       getDiagnostics().Report(ImportLoc, diag::warn_missing_submodule)
1351         << Module->getFullModuleName()
1352         << SourceRange(Path.front().second, Path.back().second);
1353 
1354       return ModuleLoadResult(0, true);
1355     }
1356 
1357     // Check whether this module is available.
1358     clang::Module::Requirement Requirement;
1359     clang::Module::HeaderDirective MissingHeader;
1360     if (!Module->isAvailable(getLangOpts(), getTarget(), Requirement,
1361                              MissingHeader)) {
1362       if (MissingHeader.FileNameLoc.isValid()) {
1363         getDiagnostics().Report(MissingHeader.FileNameLoc,
1364                                 diag::err_module_header_missing)
1365           << MissingHeader.IsUmbrella << MissingHeader.FileName;
1366       } else {
1367         getDiagnostics().Report(ImportLoc, diag::err_module_unavailable)
1368           << Module->getFullModuleName()
1369           << Requirement.second << Requirement.first
1370           << SourceRange(Path.front().second, Path.back().second);
1371       }
1372       LastModuleImportLoc = ImportLoc;
1373       LastModuleImportResult = ModuleLoadResult();
1374       return ModuleLoadResult();
1375     }
1376 
1377     ModuleManager->makeModuleVisible(Module, Visibility, ImportLoc,
1378                                      /*Complain=*/true);
1379   }
1380 
1381   // Check for any configuration macros that have changed.
1382   clang::Module *TopModule = Module->getTopLevelModule();
1383   for (unsigned I = 0, N = TopModule->ConfigMacros.size(); I != N; ++I) {
1384     checkConfigMacro(getPreprocessor(), TopModule->ConfigMacros[I],
1385                      Module, ImportLoc);
1386   }
1387 
1388   // If this module import was due to an inclusion directive, create an
1389   // implicit import declaration to capture it in the AST.
1390   if (IsInclusionDirective && hasASTContext()) {
1391     TranslationUnitDecl *TU = getASTContext().getTranslationUnitDecl();
1392     ImportDecl *ImportD = ImportDecl::CreateImplicit(getASTContext(), TU,
1393                                                      ImportLoc, Module,
1394                                                      Path.back().second);
1395     TU->addDecl(ImportD);
1396     if (Consumer)
1397       Consumer->HandleImplicitImportDecl(ImportD);
1398   }
1399 
1400   LastModuleImportLoc = ImportLoc;
1401   LastModuleImportResult = ModuleLoadResult(Module, false);
1402   return LastModuleImportResult;
1403 }
1404 
1405 void CompilerInstance::makeModuleVisible(Module *Mod,
1406                                          Module::NameVisibilityKind Visibility,
1407                                          SourceLocation ImportLoc,
1408                                          bool Complain){
1409   ModuleManager->makeModuleVisible(Mod, Visibility, ImportLoc, Complain);
1410 }
1411 
1412 GlobalModuleIndex *CompilerInstance::loadGlobalModuleIndex(
1413     SourceLocation TriggerLoc) {
1414   if (!ModuleManager)
1415     createModuleManager();
1416   // Can't do anything if we don't have the module manager.
1417   if (!ModuleManager)
1418     return 0;
1419   // Get an existing global index.  This loads it if not already
1420   // loaded.
1421   ModuleManager->loadGlobalIndex();
1422   GlobalModuleIndex *GlobalIndex = ModuleManager->getGlobalIndex();
1423   // If the global index doesn't exist, create it.
1424   if (!GlobalIndex && shouldBuildGlobalModuleIndex() && hasFileManager() &&
1425       hasPreprocessor()) {
1426     llvm::sys::fs::create_directories(
1427       getPreprocessor().getHeaderSearchInfo().getModuleCachePath());
1428     GlobalModuleIndex::writeIndex(
1429       getFileManager(),
1430       getPreprocessor().getHeaderSearchInfo().getModuleCachePath());
1431     ModuleManager->resetForReload();
1432     ModuleManager->loadGlobalIndex();
1433     GlobalIndex = ModuleManager->getGlobalIndex();
1434   }
1435   // For finding modules needing to be imported for fixit messages,
1436   // we need to make the global index cover all modules, so we do that here.
1437   if (!HaveFullGlobalModuleIndex && GlobalIndex && !buildingModule()) {
1438     ModuleMap &MMap = getPreprocessor().getHeaderSearchInfo().getModuleMap();
1439     bool RecreateIndex = false;
1440     for (ModuleMap::module_iterator I = MMap.module_begin(),
1441         E = MMap.module_end(); I != E; ++I) {
1442       Module *TheModule = I->second;
1443       const FileEntry *Entry = TheModule->getASTFile();
1444       if (!Entry) {
1445         SmallVector<std::pair<IdentifierInfo *, SourceLocation>, 2> Path;
1446         Path.push_back(std::make_pair(
1447 				  getPreprocessor().getIdentifierInfo(TheModule->Name), TriggerLoc));
1448         std::reverse(Path.begin(), Path.end());
1449 		    // Load a module as hidden.  This also adds it to the global index.
1450         loadModule(TheModule->DefinitionLoc, Path,
1451                                              Module::Hidden, false);
1452         RecreateIndex = true;
1453       }
1454     }
1455     if (RecreateIndex) {
1456       GlobalModuleIndex::writeIndex(
1457         getFileManager(),
1458         getPreprocessor().getHeaderSearchInfo().getModuleCachePath());
1459       ModuleManager->resetForReload();
1460       ModuleManager->loadGlobalIndex();
1461       GlobalIndex = ModuleManager->getGlobalIndex();
1462     }
1463     HaveFullGlobalModuleIndex = true;
1464   }
1465   return GlobalIndex;
1466 }
1467 
1468 // Check global module index for missing imports.
1469 bool
1470 CompilerInstance::lookupMissingImports(StringRef Name,
1471                                        SourceLocation TriggerLoc) {
1472   // Look for the symbol in non-imported modules, but only if an error
1473   // actually occurred.
1474   if (!buildingModule()) {
1475     // Load global module index, or retrieve a previously loaded one.
1476     GlobalModuleIndex *GlobalIndex = loadGlobalModuleIndex(
1477       TriggerLoc);
1478 
1479     // Only if we have a global index.
1480     if (GlobalIndex) {
1481       GlobalModuleIndex::HitSet FoundModules;
1482 
1483       // Find the modules that reference the identifier.
1484       // Note that this only finds top-level modules.
1485       // We'll let diagnoseTypo find the actual declaration module.
1486       if (GlobalIndex->lookupIdentifier(Name, FoundModules))
1487         return true;
1488     }
1489   }
1490 
1491   return false;
1492 }
1493