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/Sema/Sema.h" 12 #include "clang/AST/ASTConsumer.h" 13 #include "clang/AST/ASTContext.h" 14 #include "clang/AST/Decl.h" 15 #include "clang/Basic/Diagnostic.h" 16 #include "clang/Basic/FileManager.h" 17 #include "clang/Basic/SourceManager.h" 18 #include "clang/Basic/TargetInfo.h" 19 #include "clang/Basic/Version.h" 20 #include "clang/Lex/HeaderSearch.h" 21 #include "clang/Lex/Preprocessor.h" 22 #include "clang/Lex/PTHManager.h" 23 #include "clang/Frontend/ChainedDiagnosticConsumer.h" 24 #include "clang/Frontend/FrontendAction.h" 25 #include "clang/Frontend/FrontendActions.h" 26 #include "clang/Frontend/FrontendDiagnostic.h" 27 #include "clang/Frontend/LogDiagnosticPrinter.h" 28 #include "clang/Frontend/SerializedDiagnosticPrinter.h" 29 #include "clang/Frontend/TextDiagnosticPrinter.h" 30 #include "clang/Frontend/VerifyDiagnosticConsumer.h" 31 #include "clang/Frontend/Utils.h" 32 #include "clang/Serialization/ASTReader.h" 33 #include "clang/Sema/CodeCompleteConsumer.h" 34 #include "llvm/Support/FileSystem.h" 35 #include "llvm/Support/MemoryBuffer.h" 36 #include "llvm/Support/raw_ostream.h" 37 #include "llvm/ADT/Statistic.h" 38 #include "llvm/Support/Timer.h" 39 #include "llvm/Support/Host.h" 40 #include "llvm/Support/LockFileManager.h" 41 #include "llvm/Support/Path.h" 42 #include "llvm/Support/Program.h" 43 #include "llvm/Support/Signals.h" 44 #include "llvm/Support/system_error.h" 45 #include "llvm/Support/CrashRecoveryContext.h" 46 #include "llvm/Config/config.h" 47 48 using namespace clang; 49 50 CompilerInstance::CompilerInstance() 51 : Invocation(new CompilerInvocation()), ModuleManager(0) { 52 } 53 54 CompilerInstance::~CompilerInstance() { 55 assert(OutputFiles.empty() && "Still output files in flight?"); 56 } 57 58 void CompilerInstance::setInvocation(CompilerInvocation *Value) { 59 Invocation = Value; 60 } 61 62 void CompilerInstance::setDiagnostics(DiagnosticsEngine *Value) { 63 Diagnostics = Value; 64 } 65 66 void CompilerInstance::setTarget(TargetInfo *Value) { 67 Target = Value; 68 } 69 70 void CompilerInstance::setFileManager(FileManager *Value) { 71 FileMgr = Value; 72 } 73 74 void CompilerInstance::setSourceManager(SourceManager *Value) { 75 SourceMgr = Value; 76 } 77 78 void CompilerInstance::setPreprocessor(Preprocessor *Value) { PP = Value; } 79 80 void CompilerInstance::setASTContext(ASTContext *Value) { Context = Value; } 81 82 void CompilerInstance::setSema(Sema *S) { 83 TheSema.reset(S); 84 } 85 86 void CompilerInstance::setASTConsumer(ASTConsumer *Value) { 87 Consumer.reset(Value); 88 } 89 90 void CompilerInstance::setCodeCompletionConsumer(CodeCompleteConsumer *Value) { 91 CompletionConsumer.reset(Value); 92 } 93 94 // Diagnostics 95 static void SetUpBuildDumpLog(DiagnosticOptions *DiagOpts, 96 unsigned argc, const char* const *argv, 97 DiagnosticsEngine &Diags) { 98 std::string ErrorInfo; 99 OwningPtr<raw_ostream> OS( 100 new llvm::raw_fd_ostream(DiagOpts->DumpBuildInformation.c_str(),ErrorInfo)); 101 if (!ErrorInfo.empty()) { 102 Diags.Report(diag::err_fe_unable_to_open_logfile) 103 << DiagOpts->DumpBuildInformation << ErrorInfo; 104 return; 105 } 106 107 (*OS) << "clang -cc1 command line arguments: "; 108 for (unsigned i = 0; i != argc; ++i) 109 (*OS) << argv[i] << ' '; 110 (*OS) << '\n'; 111 112 // Chain in a diagnostic client which will log the diagnostics. 113 DiagnosticConsumer *Logger = 114 new TextDiagnosticPrinter(*OS.take(), DiagOpts, /*OwnsOutputStream=*/true); 115 Diags.setClient(new ChainedDiagnosticConsumer(Diags.takeClient(), Logger)); 116 } 117 118 static void SetUpDiagnosticLog(DiagnosticOptions *DiagOpts, 119 const CodeGenOptions *CodeGenOpts, 120 DiagnosticsEngine &Diags) { 121 std::string ErrorInfo; 122 bool OwnsStream = false; 123 raw_ostream *OS = &llvm::errs(); 124 if (DiagOpts->DiagnosticLogFile != "-") { 125 // Create the output stream. 126 llvm::raw_fd_ostream *FileOS( 127 new llvm::raw_fd_ostream(DiagOpts->DiagnosticLogFile.c_str(), 128 ErrorInfo, llvm::raw_fd_ostream::F_Append)); 129 if (!ErrorInfo.empty()) { 130 Diags.Report(diag::warn_fe_cc_log_diagnostics_failure) 131 << DiagOpts->DumpBuildInformation << ErrorInfo; 132 } else { 133 FileOS->SetUnbuffered(); 134 FileOS->SetUseAtomicWrites(true); 135 OS = FileOS; 136 OwnsStream = true; 137 } 138 } 139 140 // Chain in the diagnostic client which will log the diagnostics. 141 LogDiagnosticPrinter *Logger = new LogDiagnosticPrinter(*OS, DiagOpts, 142 OwnsStream); 143 if (CodeGenOpts) 144 Logger->setDwarfDebugFlags(CodeGenOpts->DwarfDebugFlags); 145 Diags.setClient(new ChainedDiagnosticConsumer(Diags.takeClient(), Logger)); 146 } 147 148 static void SetupSerializedDiagnostics(DiagnosticOptions *DiagOpts, 149 DiagnosticsEngine &Diags, 150 StringRef OutputFile) { 151 std::string ErrorInfo; 152 OwningPtr<llvm::raw_fd_ostream> OS; 153 OS.reset(new llvm::raw_fd_ostream(OutputFile.str().c_str(), ErrorInfo, 154 llvm::raw_fd_ostream::F_Binary)); 155 156 if (!ErrorInfo.empty()) { 157 Diags.Report(diag::warn_fe_serialized_diag_failure) 158 << OutputFile << ErrorInfo; 159 return; 160 } 161 162 DiagnosticConsumer *SerializedConsumer = 163 clang::serialized_diags::create(OS.take(), DiagOpts); 164 165 166 Diags.setClient(new ChainedDiagnosticConsumer(Diags.takeClient(), 167 SerializedConsumer)); 168 } 169 170 void CompilerInstance::createDiagnostics(int Argc, const char* const *Argv, 171 DiagnosticConsumer *Client, 172 bool ShouldOwnClient, 173 bool ShouldCloneClient) { 174 Diagnostics = createDiagnostics(&getDiagnosticOpts(), Argc, Argv, Client, 175 ShouldOwnClient, ShouldCloneClient, 176 &getCodeGenOpts()); 177 } 178 179 IntrusiveRefCntPtr<DiagnosticsEngine> 180 CompilerInstance::createDiagnostics(DiagnosticOptions *Opts, 181 int Argc, const char* const *Argv, 182 DiagnosticConsumer *Client, 183 bool ShouldOwnClient, 184 bool ShouldCloneClient, 185 const CodeGenOptions *CodeGenOpts) { 186 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs()); 187 IntrusiveRefCntPtr<DiagnosticsEngine> 188 Diags(new DiagnosticsEngine(DiagID, Opts)); 189 190 // Create the diagnostic client for reporting errors or for 191 // implementing -verify. 192 if (Client) { 193 if (ShouldCloneClient) 194 Diags->setClient(Client->clone(*Diags), ShouldOwnClient); 195 else 196 Diags->setClient(Client, ShouldOwnClient); 197 } else 198 Diags->setClient(new TextDiagnosticPrinter(llvm::errs(), Opts)); 199 200 // Chain in -verify checker, if requested. 201 if (Opts->VerifyDiagnostics) 202 Diags->setClient(new VerifyDiagnosticConsumer(*Diags)); 203 204 // Chain in -diagnostic-log-file dumper, if requested. 205 if (!Opts->DiagnosticLogFile.empty()) 206 SetUpDiagnosticLog(Opts, CodeGenOpts, *Diags); 207 208 if (!Opts->DumpBuildInformation.empty()) 209 SetUpBuildDumpLog(Opts, Argc, Argv, *Diags); 210 211 if (!Opts->DiagnosticSerializationFile.empty()) 212 SetupSerializedDiagnostics(Opts, *Diags, 213 Opts->DiagnosticSerializationFile); 214 215 // Configure our handling of diagnostics. 216 ProcessWarningOptions(*Diags, *Opts); 217 218 return Diags; 219 } 220 221 // File Manager 222 223 void CompilerInstance::createFileManager() { 224 FileMgr = new FileManager(getFileSystemOpts()); 225 } 226 227 // Source Manager 228 229 void CompilerInstance::createSourceManager(FileManager &FileMgr) { 230 SourceMgr = new SourceManager(getDiagnostics(), FileMgr); 231 } 232 233 // Preprocessor 234 235 void CompilerInstance::createPreprocessor() { 236 const PreprocessorOptions &PPOpts = getPreprocessorOpts(); 237 238 // Create a PTH manager if we are using some form of a token cache. 239 PTHManager *PTHMgr = 0; 240 if (!PPOpts.TokenCache.empty()) 241 PTHMgr = PTHManager::Create(PPOpts.TokenCache, getDiagnostics()); 242 243 // Create the Preprocessor. 244 HeaderSearch *HeaderInfo = new HeaderSearch(&getHeaderSearchOpts(), 245 getFileManager(), 246 getDiagnostics(), 247 getLangOpts(), 248 &getTarget()); 249 PP = new Preprocessor(&getPreprocessorOpts(), 250 getDiagnostics(), getLangOpts(), &getTarget(), 251 getSourceManager(), *HeaderInfo, *this, PTHMgr, 252 /*OwnsHeaderSearch=*/true); 253 254 // Note that this is different then passing PTHMgr to Preprocessor's ctor. 255 // That argument is used as the IdentifierInfoLookup argument to 256 // IdentifierTable's ctor. 257 if (PTHMgr) { 258 PTHMgr->setPreprocessor(&*PP); 259 PP->setPTHManager(PTHMgr); 260 } 261 262 if (PPOpts.DetailedRecord) 263 PP->createPreprocessingRecord(PPOpts.DetailedRecordConditionalDirectives); 264 265 InitializePreprocessor(*PP, PPOpts, getHeaderSearchOpts(), getFrontendOpts()); 266 267 // Set up the module path, including the hash for the 268 // module-creation options. 269 SmallString<256> SpecificModuleCache( 270 getHeaderSearchOpts().ModuleCachePath); 271 if (!getHeaderSearchOpts().DisableModuleHash) 272 llvm::sys::path::append(SpecificModuleCache, 273 getInvocation().getModuleHash()); 274 PP->getHeaderSearchInfo().setModuleCachePath(SpecificModuleCache); 275 276 // Handle generating dependencies, if requested. 277 const DependencyOutputOptions &DepOpts = getDependencyOutputOpts(); 278 if (!DepOpts.OutputFile.empty()) 279 AttachDependencyFileGen(*PP, DepOpts); 280 if (!DepOpts.DOTOutputFile.empty()) 281 AttachDependencyGraphGen(*PP, DepOpts.DOTOutputFile, 282 getHeaderSearchOpts().Sysroot); 283 284 285 // Handle generating header include information, if requested. 286 if (DepOpts.ShowHeaderIncludes) 287 AttachHeaderIncludeGen(*PP); 288 if (!DepOpts.HeaderIncludeOutputFile.empty()) { 289 StringRef OutputPath = DepOpts.HeaderIncludeOutputFile; 290 if (OutputPath == "-") 291 OutputPath = ""; 292 AttachHeaderIncludeGen(*PP, /*ShowAllHeaders=*/true, OutputPath, 293 /*ShowDepth=*/false); 294 } 295 } 296 297 // ASTContext 298 299 void CompilerInstance::createASTContext() { 300 Preprocessor &PP = getPreprocessor(); 301 Context = new ASTContext(getLangOpts(), PP.getSourceManager(), 302 &getTarget(), PP.getIdentifierTable(), 303 PP.getSelectorTable(), PP.getBuiltinInfo(), 304 /*size_reserve=*/ 0); 305 } 306 307 // ExternalASTSource 308 309 void CompilerInstance::createPCHExternalASTSource(StringRef Path, 310 bool DisablePCHValidation, 311 bool AllowPCHWithCompilerErrors, 312 void *DeserializationListener){ 313 OwningPtr<ExternalASTSource> Source; 314 bool Preamble = getPreprocessorOpts().PrecompiledPreambleBytes.first != 0; 315 Source.reset(createPCHExternalASTSource(Path, getHeaderSearchOpts().Sysroot, 316 DisablePCHValidation, 317 AllowPCHWithCompilerErrors, 318 getPreprocessor(), getASTContext(), 319 DeserializationListener, 320 Preamble)); 321 ModuleManager = static_cast<ASTReader*>(Source.get()); 322 getASTContext().setExternalSource(Source); 323 } 324 325 ExternalASTSource * 326 CompilerInstance::createPCHExternalASTSource(StringRef Path, 327 const std::string &Sysroot, 328 bool DisablePCHValidation, 329 bool AllowPCHWithCompilerErrors, 330 Preprocessor &PP, 331 ASTContext &Context, 332 void *DeserializationListener, 333 bool Preamble) { 334 OwningPtr<ASTReader> Reader; 335 Reader.reset(new ASTReader(PP, Context, 336 Sysroot.empty() ? "" : Sysroot.c_str(), 337 DisablePCHValidation, 338 AllowPCHWithCompilerErrors)); 339 340 Reader->setDeserializationListener( 341 static_cast<ASTDeserializationListener *>(DeserializationListener)); 342 switch (Reader->ReadAST(Path, 343 Preamble ? serialization::MK_Preamble 344 : serialization::MK_PCH, 345 ASTReader::ARR_None)) { 346 case ASTReader::Success: 347 // Set the predefines buffer as suggested by the PCH reader. Typically, the 348 // predefines buffer will be empty. 349 PP.setPredefines(Reader->getSuggestedPredefines()); 350 return Reader.take(); 351 352 case ASTReader::Failure: 353 // Unrecoverable failure: don't even try to process the input file. 354 break; 355 356 case ASTReader::OutOfDate: 357 case ASTReader::VersionMismatch: 358 case ASTReader::ConfigurationMismatch: 359 case ASTReader::HadErrors: 360 // No suitable PCH file could be found. Return an error. 361 break; 362 } 363 364 return 0; 365 } 366 367 // Code Completion 368 369 static bool EnableCodeCompletion(Preprocessor &PP, 370 const std::string &Filename, 371 unsigned Line, 372 unsigned Column) { 373 // Tell the source manager to chop off the given file at a specific 374 // line and column. 375 const FileEntry *Entry = PP.getFileManager().getFile(Filename); 376 if (!Entry) { 377 PP.getDiagnostics().Report(diag::err_fe_invalid_code_complete_file) 378 << Filename; 379 return true; 380 } 381 382 // Truncate the named file at the given line/column. 383 PP.SetCodeCompletionPoint(Entry, Line, Column); 384 return false; 385 } 386 387 void CompilerInstance::createCodeCompletionConsumer() { 388 const ParsedSourceLocation &Loc = getFrontendOpts().CodeCompletionAt; 389 if (!CompletionConsumer) { 390 setCodeCompletionConsumer( 391 createCodeCompletionConsumer(getPreprocessor(), 392 Loc.FileName, Loc.Line, Loc.Column, 393 getFrontendOpts().CodeCompleteOpts, 394 llvm::outs())); 395 if (!CompletionConsumer) 396 return; 397 } else if (EnableCodeCompletion(getPreprocessor(), Loc.FileName, 398 Loc.Line, Loc.Column)) { 399 setCodeCompletionConsumer(0); 400 return; 401 } 402 403 if (CompletionConsumer->isOutputBinary() && 404 llvm::sys::Program::ChangeStdoutToBinary()) { 405 getPreprocessor().getDiagnostics().Report(diag::err_fe_stdout_binary); 406 setCodeCompletionConsumer(0); 407 } 408 } 409 410 void CompilerInstance::createFrontendTimer() { 411 FrontendTimer.reset(new llvm::Timer("Clang front-end timer")); 412 } 413 414 CodeCompleteConsumer * 415 CompilerInstance::createCodeCompletionConsumer(Preprocessor &PP, 416 const std::string &Filename, 417 unsigned Line, 418 unsigned Column, 419 const CodeCompleteOptions &Opts, 420 raw_ostream &OS) { 421 if (EnableCodeCompletion(PP, Filename, Line, Column)) 422 return 0; 423 424 // Set up the creation routine for code-completion. 425 return new PrintingCodeCompleteConsumer(Opts, OS); 426 } 427 428 void CompilerInstance::createSema(TranslationUnitKind TUKind, 429 CodeCompleteConsumer *CompletionConsumer) { 430 TheSema.reset(new Sema(getPreprocessor(), getASTContext(), getASTConsumer(), 431 TUKind, CompletionConsumer)); 432 } 433 434 // Output Files 435 436 void CompilerInstance::addOutputFile(const OutputFile &OutFile) { 437 assert(OutFile.OS && "Attempt to add empty stream to output list!"); 438 OutputFiles.push_back(OutFile); 439 } 440 441 void CompilerInstance::clearOutputFiles(bool EraseFiles) { 442 for (std::list<OutputFile>::iterator 443 it = OutputFiles.begin(), ie = OutputFiles.end(); it != ie; ++it) { 444 delete it->OS; 445 if (!it->TempFilename.empty()) { 446 if (EraseFiles) { 447 bool existed; 448 llvm::sys::fs::remove(it->TempFilename, existed); 449 } else { 450 SmallString<128> NewOutFile(it->Filename); 451 452 // If '-working-directory' was passed, the output filename should be 453 // relative to that. 454 FileMgr->FixupRelativePath(NewOutFile); 455 if (llvm::error_code ec = llvm::sys::fs::rename(it->TempFilename, 456 NewOutFile.str())) { 457 getDiagnostics().Report(diag::err_unable_to_rename_temp) 458 << it->TempFilename << it->Filename << ec.message(); 459 460 bool existed; 461 llvm::sys::fs::remove(it->TempFilename, existed); 462 } 463 } 464 } else if (!it->Filename.empty() && EraseFiles) 465 llvm::sys::Path(it->Filename).eraseFromDisk(); 466 467 } 468 OutputFiles.clear(); 469 } 470 471 llvm::raw_fd_ostream * 472 CompilerInstance::createDefaultOutputFile(bool Binary, 473 StringRef InFile, 474 StringRef Extension) { 475 return createOutputFile(getFrontendOpts().OutputFile, Binary, 476 /*RemoveFileOnSignal=*/true, InFile, Extension, 477 /*UseTemporary=*/true); 478 } 479 480 llvm::raw_fd_ostream * 481 CompilerInstance::createOutputFile(StringRef OutputPath, 482 bool Binary, bool RemoveFileOnSignal, 483 StringRef InFile, 484 StringRef Extension, 485 bool UseTemporary, 486 bool CreateMissingDirectories) { 487 std::string Error, OutputPathName, TempPathName; 488 llvm::raw_fd_ostream *OS = createOutputFile(OutputPath, Error, Binary, 489 RemoveFileOnSignal, 490 InFile, Extension, 491 UseTemporary, 492 CreateMissingDirectories, 493 &OutputPathName, 494 &TempPathName); 495 if (!OS) { 496 getDiagnostics().Report(diag::err_fe_unable_to_open_output) 497 << OutputPath << Error; 498 return 0; 499 } 500 501 // Add the output file -- but don't try to remove "-", since this means we are 502 // using stdin. 503 addOutputFile(OutputFile((OutputPathName != "-") ? OutputPathName : "", 504 TempPathName, OS)); 505 506 return OS; 507 } 508 509 llvm::raw_fd_ostream * 510 CompilerInstance::createOutputFile(StringRef OutputPath, 511 std::string &Error, 512 bool Binary, 513 bool RemoveFileOnSignal, 514 StringRef InFile, 515 StringRef Extension, 516 bool UseTemporary, 517 bool CreateMissingDirectories, 518 std::string *ResultPathName, 519 std::string *TempPathName) { 520 assert((!CreateMissingDirectories || UseTemporary) && 521 "CreateMissingDirectories is only allowed when using temporary files"); 522 523 std::string OutFile, TempFile; 524 if (!OutputPath.empty()) { 525 OutFile = OutputPath; 526 } else if (InFile == "-") { 527 OutFile = "-"; 528 } else if (!Extension.empty()) { 529 llvm::sys::Path Path(InFile); 530 Path.eraseSuffix(); 531 Path.appendSuffix(Extension); 532 OutFile = Path.str(); 533 } else { 534 OutFile = "-"; 535 } 536 537 OwningPtr<llvm::raw_fd_ostream> OS; 538 std::string OSFile; 539 540 if (UseTemporary && OutFile != "-") { 541 // Only create the temporary if the parent directory exists (or create 542 // missing directories is true) and we can actually write to OutPath, 543 // otherwise we want to fail early. 544 SmallString<256> AbsPath(OutputPath); 545 llvm::sys::fs::make_absolute(AbsPath); 546 llvm::sys::Path OutPath(AbsPath); 547 bool ParentExists = false; 548 if (llvm::sys::fs::exists(llvm::sys::path::parent_path(AbsPath.str()), 549 ParentExists)) 550 ParentExists = false; 551 bool Exists; 552 if ((CreateMissingDirectories || ParentExists) && 553 ((llvm::sys::fs::exists(AbsPath.str(), Exists) || !Exists) || 554 (OutPath.isRegularFile() && OutPath.canWrite()))) { 555 // Create a temporary file. 556 SmallString<128> TempPath; 557 TempPath = OutFile; 558 TempPath += "-%%%%%%%%"; 559 int fd; 560 if (llvm::sys::fs::unique_file(TempPath.str(), fd, TempPath, 561 /*makeAbsolute=*/false, 0664) 562 == llvm::errc::success) { 563 OS.reset(new llvm::raw_fd_ostream(fd, /*shouldClose=*/true)); 564 OSFile = TempFile = TempPath.str(); 565 } 566 } 567 } 568 569 if (!OS) { 570 OSFile = OutFile; 571 OS.reset( 572 new llvm::raw_fd_ostream(OSFile.c_str(), Error, 573 (Binary ? llvm::raw_fd_ostream::F_Binary : 0))); 574 if (!Error.empty()) 575 return 0; 576 } 577 578 // Make sure the out stream file gets removed if we crash. 579 if (RemoveFileOnSignal) 580 llvm::sys::RemoveFileOnSignal(llvm::sys::Path(OSFile)); 581 582 if (ResultPathName) 583 *ResultPathName = OutFile; 584 if (TempPathName) 585 *TempPathName = TempFile; 586 587 return OS.take(); 588 } 589 590 // Initialization Utilities 591 592 bool CompilerInstance::InitializeSourceManager(StringRef InputFile, 593 SrcMgr::CharacteristicKind Kind){ 594 return InitializeSourceManager(InputFile, Kind, getDiagnostics(), 595 getFileManager(), getSourceManager(), 596 getFrontendOpts()); 597 } 598 599 bool CompilerInstance::InitializeSourceManager(StringRef InputFile, 600 SrcMgr::CharacteristicKind Kind, 601 DiagnosticsEngine &Diags, 602 FileManager &FileMgr, 603 SourceManager &SourceMgr, 604 const FrontendOptions &Opts) { 605 // Figure out where to get and map in the main file. 606 if (InputFile != "-") { 607 const FileEntry *File = FileMgr.getFile(InputFile); 608 if (!File) { 609 Diags.Report(diag::err_fe_error_reading) << InputFile; 610 return false; 611 } 612 SourceMgr.createMainFileID(File, Kind); 613 614 // The natural SourceManager infrastructure can't currently handle named 615 // pipes, but we would at least like to accept them for the main 616 // file. Detect them here, read them with the more generic MemoryBuffer 617 // function, and simply override their contents as we do for STDIN. 618 if (File->isNamedPipe()) { 619 OwningPtr<llvm::MemoryBuffer> MB; 620 if (llvm::error_code ec = llvm::MemoryBuffer::getFile(InputFile, MB)) { 621 Diags.Report(diag::err_cannot_open_file) << InputFile << ec.message(); 622 return false; 623 } 624 SourceMgr.overrideFileContents(File, MB.take()); 625 } 626 } else { 627 OwningPtr<llvm::MemoryBuffer> SB; 628 if (llvm::MemoryBuffer::getSTDIN(SB)) { 629 // FIXME: Give ec.message() in this diag. 630 Diags.Report(diag::err_fe_error_reading_stdin); 631 return false; 632 } 633 const FileEntry *File = FileMgr.getVirtualFile(SB->getBufferIdentifier(), 634 SB->getBufferSize(), 0); 635 SourceMgr.createMainFileID(File, Kind); 636 SourceMgr.overrideFileContents(File, SB.take()); 637 } 638 639 assert(!SourceMgr.getMainFileID().isInvalid() && 640 "Couldn't establish MainFileID!"); 641 return true; 642 } 643 644 // High-Level Operations 645 646 bool CompilerInstance::ExecuteAction(FrontendAction &Act) { 647 assert(hasDiagnostics() && "Diagnostics engine is not initialized!"); 648 assert(!getFrontendOpts().ShowHelp && "Client must handle '-help'!"); 649 assert(!getFrontendOpts().ShowVersion && "Client must handle '-version'!"); 650 651 // FIXME: Take this as an argument, once all the APIs we used have moved to 652 // taking it as an input instead of hard-coding llvm::errs. 653 raw_ostream &OS = llvm::errs(); 654 655 // Create the target instance. 656 setTarget(TargetInfo::CreateTargetInfo(getDiagnostics(), getTargetOpts())); 657 if (!hasTarget()) 658 return false; 659 660 // Inform the target of the language options. 661 // 662 // FIXME: We shouldn't need to do this, the target should be immutable once 663 // created. This complexity should be lifted elsewhere. 664 getTarget().setForcedLangOptions(getLangOpts()); 665 666 // rewriter project will change target built-in bool type from its default. 667 if (getFrontendOpts().ProgramAction == frontend::RewriteObjC) 668 getTarget().noSignedCharForObjCBool(); 669 670 // Validate/process some options. 671 if (getHeaderSearchOpts().Verbose) 672 OS << "clang -cc1 version " CLANG_VERSION_STRING 673 << " based upon " << PACKAGE_STRING 674 << " default target " << llvm::sys::getDefaultTargetTriple() << "\n"; 675 676 if (getFrontendOpts().ShowTimers) 677 createFrontendTimer(); 678 679 if (getFrontendOpts().ShowStats) 680 llvm::EnableStatistics(); 681 682 for (unsigned i = 0, e = getFrontendOpts().Inputs.size(); i != e; ++i) { 683 // Reset the ID tables if we are reusing the SourceManager. 684 if (hasSourceManager()) 685 getSourceManager().clearIDTables(); 686 687 if (Act.BeginSourceFile(*this, getFrontendOpts().Inputs[i])) { 688 Act.Execute(); 689 Act.EndSourceFile(); 690 } 691 } 692 693 // Notify the diagnostic client that all files were processed. 694 getDiagnostics().getClient()->finish(); 695 696 if (getDiagnosticOpts().ShowCarets) { 697 // We can have multiple diagnostics sharing one diagnostic client. 698 // Get the total number of warnings/errors from the client. 699 unsigned NumWarnings = getDiagnostics().getClient()->getNumWarnings(); 700 unsigned NumErrors = getDiagnostics().getClient()->getNumErrors(); 701 702 if (NumWarnings) 703 OS << NumWarnings << " warning" << (NumWarnings == 1 ? "" : "s"); 704 if (NumWarnings && NumErrors) 705 OS << " and "; 706 if (NumErrors) 707 OS << NumErrors << " error" << (NumErrors == 1 ? "" : "s"); 708 if (NumWarnings || NumErrors) 709 OS << " generated.\n"; 710 } 711 712 if (getFrontendOpts().ShowStats && hasFileManager()) { 713 getFileManager().PrintStats(); 714 OS << "\n"; 715 } 716 717 return !getDiagnostics().getClient()->getNumErrors(); 718 } 719 720 /// \brief Determine the appropriate source input kind based on language 721 /// options. 722 static InputKind getSourceInputKindFromOptions(const LangOptions &LangOpts) { 723 if (LangOpts.OpenCL) 724 return IK_OpenCL; 725 if (LangOpts.CUDA) 726 return IK_CUDA; 727 if (LangOpts.ObjC1) 728 return LangOpts.CPlusPlus? IK_ObjCXX : IK_ObjC; 729 return LangOpts.CPlusPlus? IK_CXX : IK_C; 730 } 731 732 namespace { 733 struct CompileModuleMapData { 734 CompilerInstance &Instance; 735 GenerateModuleAction &CreateModuleAction; 736 }; 737 } 738 739 /// \brief Helper function that executes the module-generating action under 740 /// a crash recovery context. 741 static void doCompileMapModule(void *UserData) { 742 CompileModuleMapData &Data 743 = *reinterpret_cast<CompileModuleMapData *>(UserData); 744 Data.Instance.ExecuteAction(Data.CreateModuleAction); 745 } 746 747 /// \brief Compile a module file for the given module, using the options 748 /// provided by the importing compiler instance. 749 static void compileModule(CompilerInstance &ImportingInstance, 750 Module *Module, 751 StringRef ModuleFileName) { 752 llvm::LockFileManager Locked(ModuleFileName); 753 switch (Locked) { 754 case llvm::LockFileManager::LFS_Error: 755 return; 756 757 case llvm::LockFileManager::LFS_Owned: 758 // We're responsible for building the module ourselves. Do so below. 759 break; 760 761 case llvm::LockFileManager::LFS_Shared: 762 // Someone else is responsible for building the module. Wait for them to 763 // finish. 764 Locked.waitForUnlock(); 765 break; 766 } 767 768 ModuleMap &ModMap 769 = ImportingInstance.getPreprocessor().getHeaderSearchInfo().getModuleMap(); 770 771 // Construct a compiler invocation for creating this module. 772 IntrusiveRefCntPtr<CompilerInvocation> Invocation 773 (new CompilerInvocation(ImportingInstance.getInvocation())); 774 775 PreprocessorOptions &PPOpts = Invocation->getPreprocessorOpts(); 776 777 // For any options that aren't intended to affect how a module is built, 778 // reset them to their default values. 779 Invocation->getLangOpts()->resetNonModularOptions(); 780 PPOpts.resetNonModularOptions(); 781 782 // Note the name of the module we're building. 783 Invocation->getLangOpts()->CurrentModule = Module->getTopLevelModuleName(); 784 785 // Note that this module is part of the module build path, so that we 786 // can detect cycles in the module graph. 787 PPOpts.ModuleBuildPath.push_back(Module->getTopLevelModuleName()); 788 789 // If there is a module map file, build the module using the module map. 790 // Set up the inputs/outputs so that we build the module from its umbrella 791 // header. 792 FrontendOptions &FrontendOpts = Invocation->getFrontendOpts(); 793 FrontendOpts.OutputFile = ModuleFileName.str(); 794 FrontendOpts.DisableFree = false; 795 FrontendOpts.Inputs.clear(); 796 InputKind IK = getSourceInputKindFromOptions(*Invocation->getLangOpts()); 797 798 // Get or create the module map that we'll use to build this module. 799 SmallString<128> TempModuleMapFileName; 800 if (const FileEntry *ModuleMapFile 801 = ModMap.getContainingModuleMapFile(Module)) { 802 // Use the module map where this module resides. 803 FrontendOpts.Inputs.push_back(FrontendInputFile(ModuleMapFile->getName(), 804 IK)); 805 } else { 806 // Create a temporary module map file. 807 TempModuleMapFileName = Module->Name; 808 TempModuleMapFileName += "-%%%%%%%%.map"; 809 int FD; 810 if (llvm::sys::fs::unique_file(TempModuleMapFileName.str(), FD, 811 TempModuleMapFileName, 812 /*makeAbsolute=*/true) 813 != llvm::errc::success) { 814 ImportingInstance.getDiagnostics().Report(diag::err_module_map_temp_file) 815 << TempModuleMapFileName; 816 return; 817 } 818 // Print the module map to this file. 819 llvm::raw_fd_ostream OS(FD, /*shouldClose=*/true); 820 Module->print(OS); 821 FrontendOpts.Inputs.push_back( 822 FrontendInputFile(TempModuleMapFileName.str().str(), IK)); 823 } 824 825 // Don't free the remapped file buffers; they are owned by our caller. 826 PPOpts.RetainRemappedFileBuffers = true; 827 828 Invocation->getDiagnosticOpts().VerifyDiagnostics = 0; 829 assert(ImportingInstance.getInvocation().getModuleHash() == 830 Invocation->getModuleHash() && "Module hash mismatch!"); 831 832 // Construct a compiler instance that will be used to actually create the 833 // module. 834 CompilerInstance Instance; 835 Instance.setInvocation(&*Invocation); 836 Instance.createDiagnostics(/*argc=*/0, /*argv=*/0, 837 &ImportingInstance.getDiagnosticClient(), 838 /*ShouldOwnClient=*/true, 839 /*ShouldCloneClient=*/true); 840 841 // Construct a module-generating action. 842 GenerateModuleAction CreateModuleAction; 843 844 // Execute the action to actually build the module in-place. Use a separate 845 // thread so that we get a stack large enough. 846 const unsigned ThreadStackSize = 8 << 20; 847 llvm::CrashRecoveryContext CRC; 848 CompileModuleMapData Data = { Instance, CreateModuleAction }; 849 CRC.RunSafelyOnThread(&doCompileMapModule, &Data, ThreadStackSize); 850 851 // Delete the temporary module map file. 852 // FIXME: Even though we're executing under crash protection, it would still 853 // be nice to do this with RemoveFileOnSignal when we can. However, that 854 // doesn't make sense for all clients, so clean this up manually. 855 Instance.clearOutputFiles(/*EraseFiles=*/true); 856 if (!TempModuleMapFileName.empty()) 857 llvm::sys::Path(TempModuleMapFileName).eraseFromDisk(); 858 } 859 860 Module *CompilerInstance::loadModule(SourceLocation ImportLoc, 861 ModuleIdPath Path, 862 Module::NameVisibilityKind Visibility, 863 bool IsInclusionDirective) { 864 // If we've already handled this import, just return the cached result. 865 // This one-element cache is important to eliminate redundant diagnostics 866 // when both the preprocessor and parser see the same import declaration. 867 if (!ImportLoc.isInvalid() && LastModuleImportLoc == ImportLoc) { 868 // Make the named module visible. 869 if (LastModuleImportResult) 870 ModuleManager->makeModuleVisible(LastModuleImportResult, Visibility); 871 return LastModuleImportResult; 872 } 873 874 // Determine what file we're searching from. 875 StringRef ModuleName = Path[0].first->getName(); 876 SourceLocation ModuleNameLoc = Path[0].second; 877 878 clang::Module *Module = 0; 879 880 // If we don't already have information on this module, load the module now. 881 llvm::DenseMap<const IdentifierInfo *, clang::Module *>::iterator Known 882 = KnownModules.find(Path[0].first); 883 if (Known != KnownModules.end()) { 884 // Retrieve the cached top-level module. 885 Module = Known->second; 886 } else if (ModuleName == getLangOpts().CurrentModule) { 887 // This is the module we're building. 888 Module = PP->getHeaderSearchInfo().getModuleMap().findModule(ModuleName); 889 Known = KnownModules.insert(std::make_pair(Path[0].first, Module)).first; 890 } else { 891 // Search for a module with the given name. 892 Module = PP->getHeaderSearchInfo().lookupModule(ModuleName); 893 std::string ModuleFileName; 894 if (Module) 895 ModuleFileName = PP->getHeaderSearchInfo().getModuleFileName(Module); 896 else 897 ModuleFileName = PP->getHeaderSearchInfo().getModuleFileName(ModuleName); 898 899 if (ModuleFileName.empty()) { 900 getDiagnostics().Report(ModuleNameLoc, diag::err_module_not_found) 901 << ModuleName 902 << SourceRange(ImportLoc, ModuleNameLoc); 903 LastModuleImportLoc = ImportLoc; 904 LastModuleImportResult = 0; 905 return 0; 906 } 907 908 const FileEntry *ModuleFile 909 = getFileManager().getFile(ModuleFileName, /*OpenFile=*/false, 910 /*CacheFailure=*/false); 911 bool BuildingModule = false; 912 if (!ModuleFile && Module) { 913 // The module is not cached, but we have a module map from which we can 914 // build the module. 915 916 // Check whether there is a cycle in the module graph. 917 SmallVectorImpl<std::string> &ModuleBuildPath 918 = getPreprocessorOpts().ModuleBuildPath; 919 SmallVectorImpl<std::string>::iterator Pos 920 = std::find(ModuleBuildPath.begin(), ModuleBuildPath.end(), ModuleName); 921 if (Pos != ModuleBuildPath.end()) { 922 SmallString<256> CyclePath; 923 for (; Pos != ModuleBuildPath.end(); ++Pos) { 924 CyclePath += *Pos; 925 CyclePath += " -> "; 926 } 927 CyclePath += ModuleName; 928 929 getDiagnostics().Report(ModuleNameLoc, diag::err_module_cycle) 930 << ModuleName << CyclePath; 931 return 0; 932 } 933 934 getDiagnostics().Report(ModuleNameLoc, diag::warn_module_build) 935 << ModuleName; 936 BuildingModule = true; 937 compileModule(*this, Module, ModuleFileName); 938 ModuleFile = FileMgr->getFile(ModuleFileName); 939 } 940 941 if (!ModuleFile) { 942 getDiagnostics().Report(ModuleNameLoc, 943 BuildingModule? diag::err_module_not_built 944 : diag::err_module_not_found) 945 << ModuleName 946 << SourceRange(ImportLoc, ModuleNameLoc); 947 return 0; 948 } 949 950 // If we don't already have an ASTReader, create one now. 951 if (!ModuleManager) { 952 if (!hasASTContext()) 953 createASTContext(); 954 955 std::string Sysroot = getHeaderSearchOpts().Sysroot; 956 const PreprocessorOptions &PPOpts = getPreprocessorOpts(); 957 ModuleManager = new ASTReader(getPreprocessor(), *Context, 958 Sysroot.empty() ? "" : Sysroot.c_str(), 959 PPOpts.DisablePCHValidation); 960 if (hasASTConsumer()) { 961 ModuleManager->setDeserializationListener( 962 getASTConsumer().GetASTDeserializationListener()); 963 getASTContext().setASTMutationListener( 964 getASTConsumer().GetASTMutationListener()); 965 getPreprocessor().setPPMutationListener( 966 getASTConsumer().GetPPMutationListener()); 967 } 968 OwningPtr<ExternalASTSource> Source; 969 Source.reset(ModuleManager); 970 getASTContext().setExternalSource(Source); 971 if (hasSema()) 972 ModuleManager->InitializeSema(getSema()); 973 if (hasASTConsumer()) 974 ModuleManager->StartTranslationUnit(&getASTConsumer()); 975 } 976 977 // Try to load the module we found. 978 switch (ModuleManager->ReadAST(ModuleFile->getName(), 979 serialization::MK_Module, 980 ASTReader::ARR_None)) { 981 case ASTReader::Success: 982 break; 983 984 case ASTReader::OutOfDate: 985 case ASTReader::VersionMismatch: 986 case ASTReader::ConfigurationMismatch: 987 case ASTReader::HadErrors: 988 // FIXME: The ASTReader will already have complained, but can we showhorn 989 // that diagnostic information into a more useful form? 990 KnownModules[Path[0].first] = 0; 991 return 0; 992 993 case ASTReader::Failure: 994 // Already complained, but note now that we failed. 995 KnownModules[Path[0].first] = 0; 996 return 0; 997 } 998 999 if (!Module) { 1000 // If we loaded the module directly, without finding a module map first, 1001 // we'll have loaded the module's information from the module itself. 1002 Module = PP->getHeaderSearchInfo().getModuleMap() 1003 .findModule((Path[0].first->getName())); 1004 } 1005 1006 if (Module) 1007 Module->setASTFile(ModuleFile); 1008 1009 // Cache the result of this top-level module lookup for later. 1010 Known = KnownModules.insert(std::make_pair(Path[0].first, Module)).first; 1011 } 1012 1013 // If we never found the module, fail. 1014 if (!Module) 1015 return 0; 1016 1017 // Verify that the rest of the module path actually corresponds to 1018 // a submodule. 1019 if (Path.size() > 1) { 1020 for (unsigned I = 1, N = Path.size(); I != N; ++I) { 1021 StringRef Name = Path[I].first->getName(); 1022 clang::Module *Sub = Module->findSubmodule(Name); 1023 1024 if (!Sub) { 1025 // Attempt to perform typo correction to find a module name that works. 1026 llvm::SmallVector<StringRef, 2> Best; 1027 unsigned BestEditDistance = (std::numeric_limits<unsigned>::max)(); 1028 1029 for (clang::Module::submodule_iterator J = Module->submodule_begin(), 1030 JEnd = Module->submodule_end(); 1031 J != JEnd; ++J) { 1032 unsigned ED = Name.edit_distance((*J)->Name, 1033 /*AllowReplacements=*/true, 1034 BestEditDistance); 1035 if (ED <= BestEditDistance) { 1036 if (ED < BestEditDistance) { 1037 Best.clear(); 1038 BestEditDistance = ED; 1039 } 1040 1041 Best.push_back((*J)->Name); 1042 } 1043 } 1044 1045 // If there was a clear winner, user it. 1046 if (Best.size() == 1) { 1047 getDiagnostics().Report(Path[I].second, 1048 diag::err_no_submodule_suggest) 1049 << Path[I].first << Module->getFullModuleName() << Best[0] 1050 << SourceRange(Path[0].second, Path[I-1].second) 1051 << FixItHint::CreateReplacement(SourceRange(Path[I].second), 1052 Best[0]); 1053 1054 Sub = Module->findSubmodule(Best[0]); 1055 } 1056 } 1057 1058 if (!Sub) { 1059 // No submodule by this name. Complain, and don't look for further 1060 // submodules. 1061 getDiagnostics().Report(Path[I].second, diag::err_no_submodule) 1062 << Path[I].first << Module->getFullModuleName() 1063 << SourceRange(Path[0].second, Path[I-1].second); 1064 break; 1065 } 1066 1067 Module = Sub; 1068 } 1069 } 1070 1071 // Make the named module visible, if it's not already part of the module 1072 // we are parsing. 1073 if (ModuleName != getLangOpts().CurrentModule) { 1074 if (!Module->IsFromModuleFile) { 1075 // We have an umbrella header or directory that doesn't actually include 1076 // all of the headers within the directory it covers. Complain about 1077 // this missing submodule and recover by forgetting that we ever saw 1078 // this submodule. 1079 // FIXME: Should we detect this at module load time? It seems fairly 1080 // expensive (and rare). 1081 getDiagnostics().Report(ImportLoc, diag::warn_missing_submodule) 1082 << Module->getFullModuleName() 1083 << SourceRange(Path.front().second, Path.back().second); 1084 1085 return 0; 1086 } 1087 1088 // Check whether this module is available. 1089 StringRef Feature; 1090 if (!Module->isAvailable(getLangOpts(), getTarget(), Feature)) { 1091 getDiagnostics().Report(ImportLoc, diag::err_module_unavailable) 1092 << Module->getFullModuleName() 1093 << Feature 1094 << SourceRange(Path.front().second, Path.back().second); 1095 LastModuleImportLoc = ImportLoc; 1096 LastModuleImportResult = 0; 1097 return 0; 1098 } 1099 1100 ModuleManager->makeModuleVisible(Module, Visibility); 1101 } 1102 1103 // If this module import was due to an inclusion directive, create an 1104 // implicit import declaration to capture it in the AST. 1105 if (IsInclusionDirective && hasASTContext()) { 1106 TranslationUnitDecl *TU = getASTContext().getTranslationUnitDecl(); 1107 ImportDecl *ImportD = ImportDecl::CreateImplicit(getASTContext(), TU, 1108 ImportLoc, Module, 1109 Path.back().second); 1110 TU->addDecl(ImportD); 1111 if (Consumer) 1112 Consumer->HandleImplicitImportDecl(ImportD); 1113 } 1114 1115 LastModuleImportLoc = ImportLoc; 1116 LastModuleImportResult = Module; 1117 return Module; 1118 } 1119