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