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