contrib/llvm/tools/clang/lib/Frontend/CompilerInstance.cpp

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