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