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