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