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