1 //===--- CompilerInstance.cpp ---------------------------------------------===//
3 // The LLVM Compiler Infrastructure
5 // This file is distributed under the University of Illinois Open Source
6 // License. See LICENSE.TXT for details.
8 //===----------------------------------------------------------------------===//
10 #include "clang/Frontend/CompilerInstance.h"
11 #include "clang/AST/ASTConsumer.h"
12 #include "clang/AST/ASTContext.h"
13 #include "clang/AST/Decl.h"
14 #include "clang/Basic/Diagnostic.h"
15 #include "clang/Basic/FileManager.h"
16 #include "clang/Basic/SourceManager.h"
17 #include "clang/Basic/TargetInfo.h"
18 #include "clang/Basic/Version.h"
19 #include "clang/Config/config.h"
20 #include "clang/Frontend/ChainedDiagnosticConsumer.h"
21 #include "clang/Frontend/FrontendAction.h"
22 #include "clang/Frontend/FrontendActions.h"
23 #include "clang/Frontend/FrontendDiagnostic.h"
24 #include "clang/Frontend/LogDiagnosticPrinter.h"
25 #include "clang/Frontend/SerializedDiagnosticPrinter.h"
26 #include "clang/Frontend/TextDiagnosticPrinter.h"
27 #include "clang/Frontend/Utils.h"
28 #include "clang/Frontend/VerifyDiagnosticConsumer.h"
29 #include "clang/Lex/HeaderSearch.h"
30 #include "clang/Lex/PTHManager.h"
31 #include "clang/Lex/Preprocessor.h"
32 #include "clang/Sema/CodeCompleteConsumer.h"
33 #include "clang/Sema/Sema.h"
34 #include "clang/Serialization/ASTReader.h"
35 #include "clang/Serialization/GlobalModuleIndex.h"
36 #include "llvm/ADT/Statistic.h"
37 #include "llvm/Support/CrashRecoveryContext.h"
38 #include "llvm/Support/Errc.h"
39 #include "llvm/Support/FileSystem.h"
40 #include "llvm/Support/Host.h"
41 #include "llvm/Support/LockFileManager.h"
42 #include "llvm/Support/MemoryBuffer.h"
43 #include "llvm/Support/Path.h"
44 #include "llvm/Support/Program.h"
45 #include "llvm/Support/Signals.h"
46 #include "llvm/Support/Timer.h"
47 #include "llvm/Support/raw_ostream.h"
49 #include <system_error>
52 using namespace clang;
54 CompilerInstance::CompilerInstance(
55 std::shared_ptr<PCHContainerOperations> PCHContainerOps,
57 : ModuleLoader(BuildingModule), Invocation(new CompilerInvocation()),
58 ModuleManager(nullptr), ThePCHContainerOperations(PCHContainerOps),
59 BuildGlobalModuleIndex(false), HaveFullGlobalModuleIndex(false),
60 ModuleBuildFailed(false) {}
62 CompilerInstance::~CompilerInstance() {
63 assert(OutputFiles.empty() && "Still output files in flight?");
66 void CompilerInstance::setInvocation(CompilerInvocation *Value) {
70 bool CompilerInstance::shouldBuildGlobalModuleIndex() const {
71 return (BuildGlobalModuleIndex ||
72 (ModuleManager && ModuleManager->isGlobalIndexUnavailable() &&
73 getFrontendOpts().GenerateGlobalModuleIndex)) &&
77 void CompilerInstance::setDiagnostics(DiagnosticsEngine *Value) {
81 void CompilerInstance::setTarget(TargetInfo *Value) {
85 void CompilerInstance::setFileManager(FileManager *Value) {
88 VirtualFileSystem = Value->getVirtualFileSystem();
90 VirtualFileSystem.reset();
93 void CompilerInstance::setSourceManager(SourceManager *Value) {
97 void CompilerInstance::setPreprocessor(Preprocessor *Value) { PP = Value; }
99 void CompilerInstance::setASTContext(ASTContext *Value) { Context = Value; }
101 void CompilerInstance::setSema(Sema *S) {
105 void CompilerInstance::setASTConsumer(std::unique_ptr<ASTConsumer> Value) {
106 Consumer = std::move(Value);
109 void CompilerInstance::setCodeCompletionConsumer(CodeCompleteConsumer *Value) {
110 CompletionConsumer.reset(Value);
113 std::unique_ptr<Sema> CompilerInstance::takeSema() {
114 return std::move(TheSema);
117 IntrusiveRefCntPtr<ASTReader> CompilerInstance::getModuleManager() const {
118 return ModuleManager;
120 void CompilerInstance::setModuleManager(IntrusiveRefCntPtr<ASTReader> Reader) {
121 ModuleManager = Reader;
124 std::shared_ptr<ModuleDependencyCollector>
125 CompilerInstance::getModuleDepCollector() const {
126 return ModuleDepCollector;
129 void CompilerInstance::setModuleDepCollector(
130 std::shared_ptr<ModuleDependencyCollector> Collector) {
131 ModuleDepCollector = Collector;
135 static void SetUpDiagnosticLog(DiagnosticOptions *DiagOpts,
136 const CodeGenOptions *CodeGenOpts,
137 DiagnosticsEngine &Diags) {
139 std::unique_ptr<raw_ostream> StreamOwner;
140 raw_ostream *OS = &llvm::errs();
141 if (DiagOpts->DiagnosticLogFile != "-") {
142 // Create the output stream.
143 auto FileOS = llvm::make_unique<llvm::raw_fd_ostream>(
144 DiagOpts->DiagnosticLogFile, EC,
145 llvm::sys::fs::F_Append | llvm::sys::fs::F_Text);
147 Diags.Report(diag::warn_fe_cc_log_diagnostics_failure)
148 << DiagOpts->DiagnosticLogFile << EC.message();
150 FileOS->SetUnbuffered();
151 FileOS->SetUseAtomicWrites(true);
153 StreamOwner = std::move(FileOS);
157 // Chain in the diagnostic client which will log the diagnostics.
158 auto Logger = llvm::make_unique<LogDiagnosticPrinter>(*OS, DiagOpts,
159 std::move(StreamOwner));
161 Logger->setDwarfDebugFlags(CodeGenOpts->DwarfDebugFlags);
162 assert(Diags.ownsClient());
164 new ChainedDiagnosticConsumer(Diags.takeClient(), std::move(Logger)));
167 static void SetupSerializedDiagnostics(DiagnosticOptions *DiagOpts,
168 DiagnosticsEngine &Diags,
169 StringRef OutputFile) {
170 auto SerializedConsumer =
171 clang::serialized_diags::create(OutputFile, DiagOpts);
173 if (Diags.ownsClient()) {
174 Diags.setClient(new ChainedDiagnosticConsumer(
175 Diags.takeClient(), std::move(SerializedConsumer)));
177 Diags.setClient(new ChainedDiagnosticConsumer(
178 Diags.getClient(), std::move(SerializedConsumer)));
182 void CompilerInstance::createDiagnostics(DiagnosticConsumer *Client,
183 bool ShouldOwnClient) {
184 Diagnostics = createDiagnostics(&getDiagnosticOpts(), Client,
185 ShouldOwnClient, &getCodeGenOpts());
188 IntrusiveRefCntPtr<DiagnosticsEngine>
189 CompilerInstance::createDiagnostics(DiagnosticOptions *Opts,
190 DiagnosticConsumer *Client,
191 bool ShouldOwnClient,
192 const CodeGenOptions *CodeGenOpts) {
193 IntrusiveRefCntPtr<DiagnosticIDs> DiagID(new DiagnosticIDs());
194 IntrusiveRefCntPtr<DiagnosticsEngine>
195 Diags(new DiagnosticsEngine(DiagID, Opts));
197 // Create the diagnostic client for reporting errors or for
198 // implementing -verify.
200 Diags->setClient(Client, ShouldOwnClient);
202 Diags->setClient(new TextDiagnosticPrinter(llvm::errs(), Opts));
204 // Chain in -verify checker, if requested.
205 if (Opts->VerifyDiagnostics)
206 Diags->setClient(new VerifyDiagnosticConsumer(*Diags));
208 // Chain in -diagnostic-log-file dumper, if requested.
209 if (!Opts->DiagnosticLogFile.empty())
210 SetUpDiagnosticLog(Opts, CodeGenOpts, *Diags);
212 if (!Opts->DiagnosticSerializationFile.empty())
213 SetupSerializedDiagnostics(Opts, *Diags,
214 Opts->DiagnosticSerializationFile);
216 // Configure our handling of diagnostics.
217 ProcessWarningOptions(*Diags, *Opts);
224 void CompilerInstance::createFileManager() {
225 if (!hasVirtualFileSystem()) {
226 // TODO: choose the virtual file system based on the CompilerInvocation.
227 setVirtualFileSystem(vfs::getRealFileSystem());
229 FileMgr = new FileManager(getFileSystemOpts(), VirtualFileSystem);
234 void CompilerInstance::createSourceManager(FileManager &FileMgr) {
235 SourceMgr = new SourceManager(getDiagnostics(), FileMgr);
238 // Initialize the remapping of files to alternative contents, e.g.,
239 // those specified through other files.
240 static void InitializeFileRemapping(DiagnosticsEngine &Diags,
241 SourceManager &SourceMgr,
242 FileManager &FileMgr,
243 const PreprocessorOptions &InitOpts) {
244 // Remap files in the source manager (with buffers).
245 for (const auto &RB : InitOpts.RemappedFileBuffers) {
246 // Create the file entry for the file that we're mapping from.
247 const FileEntry *FromFile =
248 FileMgr.getVirtualFile(RB.first, RB.second->getBufferSize(), 0);
250 Diags.Report(diag::err_fe_remap_missing_from_file) << RB.first;
251 if (!InitOpts.RetainRemappedFileBuffers)
256 // Override the contents of the "from" file with the contents of
258 SourceMgr.overrideFileContents(FromFile, RB.second,
259 InitOpts.RetainRemappedFileBuffers);
262 // Remap files in the source manager (with other files).
263 for (const auto &RF : InitOpts.RemappedFiles) {
264 // Find the file that we're mapping to.
265 const FileEntry *ToFile = FileMgr.getFile(RF.second);
267 Diags.Report(diag::err_fe_remap_missing_to_file) << RF.first << RF.second;
271 // Create the file entry for the file that we're mapping from.
272 const FileEntry *FromFile =
273 FileMgr.getVirtualFile(RF.first, ToFile->getSize(), 0);
275 Diags.Report(diag::err_fe_remap_missing_from_file) << RF.first;
279 // Override the contents of the "from" file with the contents of
281 SourceMgr.overrideFileContents(FromFile, ToFile);
284 SourceMgr.setOverridenFilesKeepOriginalName(
285 InitOpts.RemappedFilesKeepOriginalName);
290 void CompilerInstance::createPreprocessor(TranslationUnitKind TUKind) {
291 const PreprocessorOptions &PPOpts = getPreprocessorOpts();
293 // Create a PTH manager if we are using some form of a token cache.
294 PTHManager *PTHMgr = nullptr;
295 if (!PPOpts.TokenCache.empty())
296 PTHMgr = PTHManager::Create(PPOpts.TokenCache, getDiagnostics());
298 // Create the Preprocessor.
299 HeaderSearch *HeaderInfo = new HeaderSearch(&getHeaderSearchOpts(),
304 PP = new Preprocessor(&getPreprocessorOpts(), getDiagnostics(), getLangOpts(),
305 getSourceManager(), *HeaderInfo, *this, PTHMgr,
306 /*OwnsHeaderSearch=*/true, TUKind);
307 PP->Initialize(getTarget());
309 // Note that this is different then passing PTHMgr to Preprocessor's ctor.
310 // That argument is used as the IdentifierInfoLookup argument to
311 // IdentifierTable's ctor.
313 PTHMgr->setPreprocessor(&*PP);
314 PP->setPTHManager(PTHMgr);
317 if (PPOpts.DetailedRecord)
318 PP->createPreprocessingRecord();
320 // Apply remappings to the source manager.
321 InitializeFileRemapping(PP->getDiagnostics(), PP->getSourceManager(),
322 PP->getFileManager(), PPOpts);
324 // Predefine macros and configure the preprocessor.
325 InitializePreprocessor(*PP, PPOpts, *getPCHContainerOperations(),
328 // Initialize the header search object.
329 ApplyHeaderSearchOptions(PP->getHeaderSearchInfo(), getHeaderSearchOpts(),
330 PP->getLangOpts(), PP->getTargetInfo().getTriple());
332 PP->setPreprocessedOutput(getPreprocessorOutputOpts().ShowCPP);
334 if (PP->getLangOpts().Modules)
335 PP->getHeaderSearchInfo().setModuleCachePath(getSpecificModuleCachePath());
337 // Handle generating dependencies, if requested.
338 const DependencyOutputOptions &DepOpts = getDependencyOutputOpts();
339 if (!DepOpts.OutputFile.empty())
340 TheDependencyFileGenerator.reset(
341 DependencyFileGenerator::CreateAndAttachToPreprocessor(*PP, DepOpts));
342 if (!DepOpts.DOTOutputFile.empty())
343 AttachDependencyGraphGen(*PP, DepOpts.DOTOutputFile,
344 getHeaderSearchOpts().Sysroot);
346 for (auto &Listener : DependencyCollectors)
347 Listener->attachToPreprocessor(*PP);
349 // If we don't have a collector, but we are collecting module dependencies,
350 // then we're the top level compiler instance and need to create one.
351 if (!ModuleDepCollector && !DepOpts.ModuleDependencyOutputDir.empty())
352 ModuleDepCollector = std::make_shared<ModuleDependencyCollector>(
353 DepOpts.ModuleDependencyOutputDir);
355 // Handle generating header include information, if requested.
356 if (DepOpts.ShowHeaderIncludes)
357 AttachHeaderIncludeGen(*PP);
358 if (!DepOpts.HeaderIncludeOutputFile.empty()) {
359 StringRef OutputPath = DepOpts.HeaderIncludeOutputFile;
360 if (OutputPath == "-")
362 AttachHeaderIncludeGen(*PP, /*ShowAllHeaders=*/true, OutputPath,
363 /*ShowDepth=*/false);
366 if (DepOpts.PrintShowIncludes) {
367 AttachHeaderIncludeGen(*PP, /*ShowAllHeaders=*/false, /*OutputPath=*/"",
368 /*ShowDepth=*/true, /*MSStyle=*/true);
372 std::string CompilerInstance::getSpecificModuleCachePath() {
373 // Set up the module path, including the hash for the
374 // module-creation options.
375 SmallString<256> SpecificModuleCache(
376 getHeaderSearchOpts().ModuleCachePath);
377 if (!getHeaderSearchOpts().DisableModuleHash)
378 llvm::sys::path::append(SpecificModuleCache,
379 getInvocation().getModuleHash());
380 return SpecificModuleCache.str();
385 void CompilerInstance::createASTContext() {
386 Preprocessor &PP = getPreprocessor();
387 Context = new ASTContext(getLangOpts(), PP.getSourceManager(),
388 PP.getIdentifierTable(), PP.getSelectorTable(),
389 PP.getBuiltinInfo());
390 Context->InitBuiltinTypes(getTarget());
395 void CompilerInstance::createPCHExternalASTSource(
396 StringRef Path, bool DisablePCHValidation, bool AllowPCHWithCompilerErrors,
397 void *DeserializationListener, bool OwnDeserializationListener) {
398 bool Preamble = getPreprocessorOpts().PrecompiledPreambleBytes.first != 0;
399 ModuleManager = createPCHExternalASTSource(
400 Path, getHeaderSearchOpts().Sysroot, DisablePCHValidation,
401 AllowPCHWithCompilerErrors, getPreprocessor(), getASTContext(),
402 *getPCHContainerOperations(), DeserializationListener,
403 OwnDeserializationListener, Preamble,
404 getFrontendOpts().UseGlobalModuleIndex);
407 IntrusiveRefCntPtr<ASTReader> CompilerInstance::createPCHExternalASTSource(
408 StringRef Path, const std::string &Sysroot, bool DisablePCHValidation,
409 bool AllowPCHWithCompilerErrors, Preprocessor &PP, ASTContext &Context,
410 const PCHContainerOperations &PCHContainerOps,
411 void *DeserializationListener, bool OwnDeserializationListener,
412 bool Preamble, bool UseGlobalModuleIndex) {
413 HeaderSearchOptions &HSOpts = PP.getHeaderSearchInfo().getHeaderSearchOpts();
415 IntrusiveRefCntPtr<ASTReader> Reader(new ASTReader(
416 PP, Context, PCHContainerOps, Sysroot.empty() ? "" : Sysroot.c_str(),
417 DisablePCHValidation, AllowPCHWithCompilerErrors,
418 /*AllowConfigurationMismatch*/ false, HSOpts.ModulesValidateSystemHeaders,
419 UseGlobalModuleIndex));
421 // We need the external source to be set up before we read the AST, because
422 // eagerly-deserialized declarations may use it.
423 Context.setExternalSource(Reader.get());
425 Reader->setDeserializationListener(
426 static_cast<ASTDeserializationListener *>(DeserializationListener),
427 /*TakeOwnership=*/OwnDeserializationListener);
428 switch (Reader->ReadAST(Path,
429 Preamble ? serialization::MK_Preamble
430 : serialization::MK_PCH,
432 ASTReader::ARR_None)) {
433 case ASTReader::Success:
434 // Set the predefines buffer as suggested by the PCH reader. Typically, the
435 // predefines buffer will be empty.
436 PP.setPredefines(Reader->getSuggestedPredefines());
439 case ASTReader::Failure:
440 // Unrecoverable failure: don't even try to process the input file.
443 case ASTReader::Missing:
444 case ASTReader::OutOfDate:
445 case ASTReader::VersionMismatch:
446 case ASTReader::ConfigurationMismatch:
447 case ASTReader::HadErrors:
448 // No suitable PCH file could be found. Return an error.
452 Context.setExternalSource(nullptr);
458 static bool EnableCodeCompletion(Preprocessor &PP,
459 const std::string &Filename,
462 // Tell the source manager to chop off the given file at a specific
464 const FileEntry *Entry = PP.getFileManager().getFile(Filename);
466 PP.getDiagnostics().Report(diag::err_fe_invalid_code_complete_file)
471 // Truncate the named file at the given line/column.
472 PP.SetCodeCompletionPoint(Entry, Line, Column);
476 void CompilerInstance::createCodeCompletionConsumer() {
477 const ParsedSourceLocation &Loc = getFrontendOpts().CodeCompletionAt;
478 if (!CompletionConsumer) {
479 setCodeCompletionConsumer(
480 createCodeCompletionConsumer(getPreprocessor(),
481 Loc.FileName, Loc.Line, Loc.Column,
482 getFrontendOpts().CodeCompleteOpts,
484 if (!CompletionConsumer)
486 } else if (EnableCodeCompletion(getPreprocessor(), Loc.FileName,
487 Loc.Line, Loc.Column)) {
488 setCodeCompletionConsumer(nullptr);
492 if (CompletionConsumer->isOutputBinary() &&
493 llvm::sys::ChangeStdoutToBinary()) {
494 getPreprocessor().getDiagnostics().Report(diag::err_fe_stdout_binary);
495 setCodeCompletionConsumer(nullptr);
499 void CompilerInstance::createFrontendTimer() {
500 FrontendTimer.reset(new llvm::Timer("Clang front-end timer"));
503 CodeCompleteConsumer *
504 CompilerInstance::createCodeCompletionConsumer(Preprocessor &PP,
505 const std::string &Filename,
508 const CodeCompleteOptions &Opts,
510 if (EnableCodeCompletion(PP, Filename, Line, Column))
513 // Set up the creation routine for code-completion.
514 return new PrintingCodeCompleteConsumer(Opts, OS);
517 void CompilerInstance::createSema(TranslationUnitKind TUKind,
518 CodeCompleteConsumer *CompletionConsumer) {
519 TheSema.reset(new Sema(getPreprocessor(), getASTContext(), getASTConsumer(),
520 TUKind, CompletionConsumer));
525 void CompilerInstance::addOutputFile(OutputFile &&OutFile) {
526 assert(OutFile.OS && "Attempt to add empty stream to output list!");
527 OutputFiles.push_back(std::move(OutFile));
530 void CompilerInstance::clearOutputFiles(bool EraseFiles) {
531 for (OutputFile &OF : OutputFiles) {
532 // Manually close the stream before we rename it.
535 if (!OF.TempFilename.empty()) {
537 llvm::sys::fs::remove(OF.TempFilename);
539 SmallString<128> NewOutFile(OF.Filename);
541 // If '-working-directory' was passed, the output filename should be
543 FileMgr->FixupRelativePath(NewOutFile);
544 if (std::error_code ec =
545 llvm::sys::fs::rename(OF.TempFilename, NewOutFile)) {
546 getDiagnostics().Report(diag::err_unable_to_rename_temp)
547 << OF.TempFilename << OF.Filename << ec.message();
549 llvm::sys::fs::remove(OF.TempFilename);
552 } else if (!OF.Filename.empty() && EraseFiles)
553 llvm::sys::fs::remove(OF.Filename);
557 NonSeekStream.reset();
561 CompilerInstance::createDefaultOutputFile(bool Binary, StringRef InFile,
562 StringRef Extension) {
563 return createOutputFile(getFrontendOpts().OutputFile, Binary,
564 /*RemoveFileOnSignal=*/true, InFile, Extension,
565 /*UseTemporary=*/true);
568 llvm::raw_null_ostream *CompilerInstance::createNullOutputFile() {
569 auto OS = llvm::make_unique<llvm::raw_null_ostream>();
570 llvm::raw_null_ostream *Ret = OS.get();
571 addOutputFile(OutputFile("", "", std::move(OS)));
576 CompilerInstance::createOutputFile(StringRef OutputPath, bool Binary,
577 bool RemoveFileOnSignal, StringRef InFile,
578 StringRef Extension, bool UseTemporary,
579 bool CreateMissingDirectories) {
580 std::string OutputPathName, TempPathName;
582 std::unique_ptr<raw_pwrite_stream> OS = createOutputFile(
583 OutputPath, EC, Binary, RemoveFileOnSignal, InFile, Extension,
584 UseTemporary, CreateMissingDirectories, &OutputPathName, &TempPathName);
586 getDiagnostics().Report(diag::err_fe_unable_to_open_output) << OutputPath
591 raw_pwrite_stream *Ret = OS.get();
592 // Add the output file -- but don't try to remove "-", since this means we are
594 addOutputFile(OutputFile((OutputPathName != "-") ? OutputPathName : "",
595 TempPathName, std::move(OS)));
600 std::unique_ptr<llvm::raw_pwrite_stream> CompilerInstance::createOutputFile(
601 StringRef OutputPath, std::error_code &Error, bool Binary,
602 bool RemoveFileOnSignal, StringRef InFile, StringRef Extension,
603 bool UseTemporary, bool CreateMissingDirectories,
604 std::string *ResultPathName, std::string *TempPathName) {
605 assert((!CreateMissingDirectories || UseTemporary) &&
606 "CreateMissingDirectories is only allowed when using temporary files");
608 std::string OutFile, TempFile;
609 if (!OutputPath.empty()) {
610 OutFile = OutputPath;
611 } else if (InFile == "-") {
613 } else if (!Extension.empty()) {
614 SmallString<128> Path(InFile);
615 llvm::sys::path::replace_extension(Path, Extension);
616 OutFile = Path.str();
621 std::unique_ptr<llvm::raw_fd_ostream> OS;
626 UseTemporary = false;
628 llvm::sys::fs::file_status Status;
629 llvm::sys::fs::status(OutputPath, Status);
630 if (llvm::sys::fs::exists(Status)) {
631 // Fail early if we can't write to the final destination.
632 if (!llvm::sys::fs::can_write(OutputPath))
635 // Don't use a temporary if the output is a special file. This handles
636 // things like '-o /dev/null'
637 if (!llvm::sys::fs::is_regular_file(Status))
638 UseTemporary = false;
644 // Create a temporary file.
645 SmallString<128> TempPath;
647 TempPath += "-%%%%%%%%";
650 llvm::sys::fs::createUniqueFile(TempPath, fd, TempPath);
652 if (CreateMissingDirectories &&
653 EC == llvm::errc::no_such_file_or_directory) {
654 StringRef Parent = llvm::sys::path::parent_path(OutputPath);
655 EC = llvm::sys::fs::create_directories(Parent);
657 EC = llvm::sys::fs::createUniqueFile(TempPath, fd, TempPath);
662 OS.reset(new llvm::raw_fd_ostream(fd, /*shouldClose=*/true));
663 OSFile = TempFile = TempPath.str();
665 // If we failed to create the temporary, fallback to writing to the file
666 // directly. This handles the corner case where we cannot write to the
667 // directory, but can write to the file.
672 OS.reset(new llvm::raw_fd_ostream(
674 (Binary ? llvm::sys::fs::F_None : llvm::sys::fs::F_Text)));
679 // Make sure the out stream file gets removed if we crash.
680 if (RemoveFileOnSignal)
681 llvm::sys::RemoveFileOnSignal(OSFile);
684 *ResultPathName = OutFile;
686 *TempPathName = TempFile;
688 if (!Binary || OS->supportsSeeking())
689 return std::move(OS);
691 auto B = llvm::make_unique<llvm::buffer_ostream>(*OS);
692 assert(!NonSeekStream);
693 NonSeekStream = std::move(OS);
697 // Initialization Utilities
699 bool CompilerInstance::InitializeSourceManager(const FrontendInputFile &Input){
700 return InitializeSourceManager(Input, getDiagnostics(),
701 getFileManager(), getSourceManager(),
705 bool CompilerInstance::InitializeSourceManager(const FrontendInputFile &Input,
706 DiagnosticsEngine &Diags,
707 FileManager &FileMgr,
708 SourceManager &SourceMgr,
709 const FrontendOptions &Opts) {
710 SrcMgr::CharacteristicKind
711 Kind = Input.isSystem() ? SrcMgr::C_System : SrcMgr::C_User;
713 if (Input.isBuffer()) {
714 SourceMgr.setMainFileID(SourceMgr.createFileID(
715 std::unique_ptr<llvm::MemoryBuffer>(Input.getBuffer()), Kind));
716 assert(!SourceMgr.getMainFileID().isInvalid() &&
717 "Couldn't establish MainFileID!");
721 StringRef InputFile = Input.getFile();
723 // Figure out where to get and map in the main file.
724 if (InputFile != "-") {
725 const FileEntry *File = FileMgr.getFile(InputFile, /*OpenFile=*/true);
727 Diags.Report(diag::err_fe_error_reading) << InputFile;
731 // The natural SourceManager infrastructure can't currently handle named
732 // pipes, but we would at least like to accept them for the main
733 // file. Detect them here, read them with the volatile flag so FileMgr will
734 // pick up the correct size, and simply override their contents as we do for
736 if (File->isNamedPipe()) {
737 auto MB = FileMgr.getBufferForFile(File, /*isVolatile=*/true);
739 // Create a new virtual file that will have the correct size.
740 File = FileMgr.getVirtualFile(InputFile, (*MB)->getBufferSize(), 0);
741 SourceMgr.overrideFileContents(File, std::move(*MB));
743 Diags.Report(diag::err_cannot_open_file) << InputFile
744 << MB.getError().message();
749 SourceMgr.setMainFileID(
750 SourceMgr.createFileID(File, SourceLocation(), Kind));
752 llvm::ErrorOr<std::unique_ptr<llvm::MemoryBuffer>> SBOrErr =
753 llvm::MemoryBuffer::getSTDIN();
754 if (std::error_code EC = SBOrErr.getError()) {
755 Diags.Report(diag::err_fe_error_reading_stdin) << EC.message();
758 std::unique_ptr<llvm::MemoryBuffer> SB = std::move(SBOrErr.get());
760 const FileEntry *File = FileMgr.getVirtualFile(SB->getBufferIdentifier(),
761 SB->getBufferSize(), 0);
762 SourceMgr.setMainFileID(
763 SourceMgr.createFileID(File, SourceLocation(), Kind));
764 SourceMgr.overrideFileContents(File, std::move(SB));
767 assert(!SourceMgr.getMainFileID().isInvalid() &&
768 "Couldn't establish MainFileID!");
772 // High-Level Operations
774 bool CompilerInstance::ExecuteAction(FrontendAction &Act) {
775 assert(hasDiagnostics() && "Diagnostics engine is not initialized!");
776 assert(!getFrontendOpts().ShowHelp && "Client must handle '-help'!");
777 assert(!getFrontendOpts().ShowVersion && "Client must handle '-version'!");
779 // FIXME: Take this as an argument, once all the APIs we used have moved to
780 // taking it as an input instead of hard-coding llvm::errs.
781 raw_ostream &OS = llvm::errs();
783 // Create the target instance.
784 setTarget(TargetInfo::CreateTargetInfo(getDiagnostics(),
785 getInvocation().TargetOpts));
789 // Inform the target of the language options.
791 // FIXME: We shouldn't need to do this, the target should be immutable once
792 // created. This complexity should be lifted elsewhere.
793 getTarget().adjust(getLangOpts());
795 // rewriter project will change target built-in bool type from its default.
796 if (getFrontendOpts().ProgramAction == frontend::RewriteObjC)
797 getTarget().noSignedCharForObjCBool();
799 // Validate/process some options.
800 if (getHeaderSearchOpts().Verbose)
801 OS << "clang -cc1 version " CLANG_VERSION_STRING
802 << " based upon " << BACKEND_PACKAGE_STRING
803 << " default target " << llvm::sys::getDefaultTargetTriple() << "\n";
805 if (getFrontendOpts().ShowTimers)
806 createFrontendTimer();
808 if (getFrontendOpts().ShowStats)
809 llvm::EnableStatistics();
811 for (unsigned i = 0, e = getFrontendOpts().Inputs.size(); i != e; ++i) {
812 // Reset the ID tables if we are reusing the SourceManager and parsing
814 if (hasSourceManager() && !Act.isModelParsingAction())
815 getSourceManager().clearIDTables();
817 if (Act.BeginSourceFile(*this, getFrontendOpts().Inputs[i])) {
823 // Notify the diagnostic client that all files were processed.
824 getDiagnostics().getClient()->finish();
826 if (getDiagnosticOpts().ShowCarets) {
827 // We can have multiple diagnostics sharing one diagnostic client.
828 // Get the total number of warnings/errors from the client.
829 unsigned NumWarnings = getDiagnostics().getClient()->getNumWarnings();
830 unsigned NumErrors = getDiagnostics().getClient()->getNumErrors();
833 OS << NumWarnings << " warning" << (NumWarnings == 1 ? "" : "s");
834 if (NumWarnings && NumErrors)
837 OS << NumErrors << " error" << (NumErrors == 1 ? "" : "s");
838 if (NumWarnings || NumErrors)
839 OS << " generated.\n";
842 if (getFrontendOpts().ShowStats && hasFileManager()) {
843 getFileManager().PrintStats();
847 return !getDiagnostics().getClient()->getNumErrors();
850 /// \brief Determine the appropriate source input kind based on language
852 static InputKind getSourceInputKindFromOptions(const LangOptions &LangOpts) {
858 return LangOpts.CPlusPlus? IK_ObjCXX : IK_ObjC;
859 return LangOpts.CPlusPlus? IK_CXX : IK_C;
862 /// \brief Compile a module file for the given module, using the options
863 /// provided by the importing compiler instance. Returns true if the module
864 /// was built without errors.
865 static bool compileModuleImpl(CompilerInstance &ImportingInstance,
866 SourceLocation ImportLoc,
868 StringRef ModuleFileName) {
870 = ImportingInstance.getPreprocessor().getHeaderSearchInfo().getModuleMap();
872 // Construct a compiler invocation for creating this module.
873 IntrusiveRefCntPtr<CompilerInvocation> Invocation
874 (new CompilerInvocation(ImportingInstance.getInvocation()));
876 PreprocessorOptions &PPOpts = Invocation->getPreprocessorOpts();
878 // For any options that aren't intended to affect how a module is built,
879 // reset them to their default values.
880 Invocation->getLangOpts()->resetNonModularOptions();
881 PPOpts.resetNonModularOptions();
883 // Remove any macro definitions that are explicitly ignored by the module.
884 // They aren't supposed to affect how the module is built anyway.
885 const HeaderSearchOptions &HSOpts = Invocation->getHeaderSearchOpts();
887 std::remove_if(PPOpts.Macros.begin(), PPOpts.Macros.end(),
888 [&HSOpts](const std::pair<std::string, bool> &def) {
889 StringRef MacroDef = def.first;
890 return HSOpts.ModulesIgnoreMacros.count(MacroDef.split('=').first) > 0;
892 PPOpts.Macros.end());
894 // Note the name of the module we're building.
895 Invocation->getLangOpts()->CurrentModule = Module->getTopLevelModuleName();
897 // Make sure that the failed-module structure has been allocated in
898 // the importing instance, and propagate the pointer to the newly-created
900 PreprocessorOptions &ImportingPPOpts
901 = ImportingInstance.getInvocation().getPreprocessorOpts();
902 if (!ImportingPPOpts.FailedModules)
903 ImportingPPOpts.FailedModules = new PreprocessorOptions::FailedModulesSet;
904 PPOpts.FailedModules = ImportingPPOpts.FailedModules;
906 // If there is a module map file, build the module using the module map.
907 // Set up the inputs/outputs so that we build the module from its umbrella
909 FrontendOptions &FrontendOpts = Invocation->getFrontendOpts();
910 FrontendOpts.OutputFile = ModuleFileName.str();
911 FrontendOpts.DisableFree = false;
912 FrontendOpts.GenerateGlobalModuleIndex = false;
913 FrontendOpts.Inputs.clear();
914 InputKind IK = getSourceInputKindFromOptions(*Invocation->getLangOpts());
916 // Don't free the remapped file buffers; they are owned by our caller.
917 PPOpts.RetainRemappedFileBuffers = true;
919 Invocation->getDiagnosticOpts().VerifyDiagnostics = 0;
920 assert(ImportingInstance.getInvocation().getModuleHash() ==
921 Invocation->getModuleHash() && "Module hash mismatch!");
923 // Construct a compiler instance that will be used to actually create the
925 CompilerInstance Instance(ImportingInstance.getPCHContainerOperations(),
926 /*BuildingModule=*/true);
927 Instance.setInvocation(&*Invocation);
929 Instance.createDiagnostics(new ForwardingDiagnosticConsumer(
930 ImportingInstance.getDiagnosticClient()),
931 /*ShouldOwnClient=*/true);
933 Instance.setVirtualFileSystem(&ImportingInstance.getVirtualFileSystem());
935 // Note that this module is part of the module build stack, so that we
936 // can detect cycles in the module graph.
937 Instance.setFileManager(&ImportingInstance.getFileManager());
938 Instance.createSourceManager(Instance.getFileManager());
939 SourceManager &SourceMgr = Instance.getSourceManager();
940 SourceMgr.setModuleBuildStack(
941 ImportingInstance.getSourceManager().getModuleBuildStack());
942 SourceMgr.pushModuleBuildStack(Module->getTopLevelModuleName(),
943 FullSourceLoc(ImportLoc, ImportingInstance.getSourceManager()));
945 // If we're collecting module dependencies, we need to share a collector
946 // between all of the module CompilerInstances.
947 Instance.setModuleDepCollector(ImportingInstance.getModuleDepCollector());
949 // Get or create the module map that we'll use to build this module.
950 std::string InferredModuleMapContent;
951 if (const FileEntry *ModuleMapFile =
952 ModMap.getContainingModuleMapFile(Module)) {
953 // Use the module map where this module resides.
954 FrontendOpts.Inputs.emplace_back(ModuleMapFile->getName(), IK);
956 SmallString<128> FakeModuleMapFile(Module->Directory->getName());
957 llvm::sys::path::append(FakeModuleMapFile, "__inferred_module.map");
958 FrontendOpts.Inputs.emplace_back(FakeModuleMapFile, IK);
960 llvm::raw_string_ostream OS(InferredModuleMapContent);
964 std::unique_ptr<llvm::MemoryBuffer> ModuleMapBuffer =
965 llvm::MemoryBuffer::getMemBuffer(InferredModuleMapContent);
966 ModuleMapFile = Instance.getFileManager().getVirtualFile(
967 FakeModuleMapFile, InferredModuleMapContent.size(), 0);
968 SourceMgr.overrideFileContents(ModuleMapFile, std::move(ModuleMapBuffer));
971 // Construct a module-generating action. Passing through the module map is
972 // safe because the FileManager is shared between the compiler instances.
973 GenerateModuleAction CreateModuleAction(
974 ModMap.getModuleMapFileForUniquing(Module), Module->IsSystem);
976 ImportingInstance.getDiagnostics().Report(ImportLoc,
977 diag::remark_module_build)
978 << Module->Name << ModuleFileName;
980 // Execute the action to actually build the module in-place. Use a separate
981 // thread so that we get a stack large enough.
982 const unsigned ThreadStackSize = 8 << 20;
983 llvm::CrashRecoveryContext CRC;
984 CRC.RunSafelyOnThread([&]() { Instance.ExecuteAction(CreateModuleAction); },
987 ImportingInstance.getDiagnostics().Report(ImportLoc,
988 diag::remark_module_build_done)
991 // Delete the temporary module map file.
992 // FIXME: Even though we're executing under crash protection, it would still
993 // be nice to do this with RemoveFileOnSignal when we can. However, that
994 // doesn't make sense for all clients, so clean this up manually.
995 Instance.clearOutputFiles(/*EraseFiles=*/true);
997 // We've rebuilt a module. If we're allowed to generate or update the global
998 // module index, record that fact in the importing compiler instance.
999 if (ImportingInstance.getFrontendOpts().GenerateGlobalModuleIndex) {
1000 ImportingInstance.setBuildGlobalModuleIndex(true);
1003 return !Instance.getDiagnostics().hasErrorOccurred();
1006 static bool compileAndLoadModule(CompilerInstance &ImportingInstance,
1007 SourceLocation ImportLoc,
1008 SourceLocation ModuleNameLoc, Module *Module,
1009 StringRef ModuleFileName) {
1010 DiagnosticsEngine &Diags = ImportingInstance.getDiagnostics();
1012 auto diagnoseBuildFailure = [&] {
1013 Diags.Report(ModuleNameLoc, diag::err_module_not_built)
1014 << Module->Name << SourceRange(ImportLoc, ModuleNameLoc);
1017 // FIXME: have LockFileManager return an error_code so that we can
1018 // avoid the mkdir when the directory already exists.
1019 StringRef Dir = llvm::sys::path::parent_path(ModuleFileName);
1020 llvm::sys::fs::create_directories(Dir);
1023 unsigned ModuleLoadCapabilities = ASTReader::ARR_Missing;
1024 llvm::LockFileManager Locked(ModuleFileName);
1026 case llvm::LockFileManager::LFS_Error:
1027 Diags.Report(ModuleNameLoc, diag::err_module_lock_failure)
1031 case llvm::LockFileManager::LFS_Owned:
1032 // We're responsible for building the module ourselves.
1033 if (!compileModuleImpl(ImportingInstance, ModuleNameLoc, Module,
1035 diagnoseBuildFailure();
1040 case llvm::LockFileManager::LFS_Shared:
1041 // Someone else is responsible for building the module. Wait for them to
1043 switch (Locked.waitForUnlock()) {
1044 case llvm::LockFileManager::Res_Success:
1045 ModuleLoadCapabilities |= ASTReader::ARR_OutOfDate;
1047 case llvm::LockFileManager::Res_OwnerDied:
1048 continue; // try again to get the lock.
1049 case llvm::LockFileManager::Res_Timeout:
1050 Diags.Report(ModuleNameLoc, diag::err_module_lock_timeout)
1052 // Clear the lock file so that future invokations can make progress.
1053 Locked.unsafeRemoveLockFile();
1059 // Try to read the module file, now that we've compiled it.
1060 ASTReader::ASTReadResult ReadResult =
1061 ImportingInstance.getModuleManager()->ReadAST(
1062 ModuleFileName, serialization::MK_ImplicitModule, ImportLoc,
1063 ModuleLoadCapabilities);
1065 if (ReadResult == ASTReader::OutOfDate &&
1066 Locked == llvm::LockFileManager::LFS_Shared) {
1067 // The module may be out of date in the presence of file system races,
1068 // or if one of its imports depends on header search paths that are not
1069 // consistent with this ImportingInstance. Try again...
1071 } else if (ReadResult == ASTReader::Missing) {
1072 diagnoseBuildFailure();
1073 } else if (ReadResult != ASTReader::Success &&
1074 !Diags.hasErrorOccurred()) {
1075 // The ASTReader didn't diagnose the error, so conservatively report it.
1076 diagnoseBuildFailure();
1078 return ReadResult == ASTReader::Success;
1082 /// \brief Diagnose differences between the current definition of the given
1083 /// configuration macro and the definition provided on the command line.
1084 static void checkConfigMacro(Preprocessor &PP, StringRef ConfigMacro,
1085 Module *Mod, SourceLocation ImportLoc) {
1086 IdentifierInfo *Id = PP.getIdentifierInfo(ConfigMacro);
1087 SourceManager &SourceMgr = PP.getSourceManager();
1089 // If this identifier has never had a macro definition, then it could
1090 // not have changed.
1091 if (!Id->hadMacroDefinition())
1093 auto *LatestLocalMD = PP.getLocalMacroDirectiveHistory(Id);
1095 // Find the macro definition from the command line.
1096 MacroInfo *CmdLineDefinition = nullptr;
1097 for (auto *MD = LatestLocalMD; MD; MD = MD->getPrevious()) {
1098 // We only care about the predefines buffer.
1099 FileID FID = SourceMgr.getFileID(MD->getLocation());
1100 if (FID.isInvalid() || FID != PP.getPredefinesFileID())
1102 if (auto *DMD = dyn_cast<DefMacroDirective>(MD))
1103 CmdLineDefinition = DMD->getMacroInfo();
1107 auto *CurrentDefinition = PP.getMacroInfo(Id);
1108 if (CurrentDefinition == CmdLineDefinition) {
1109 // Macro matches. Nothing to do.
1110 } else if (!CurrentDefinition) {
1111 // This macro was defined on the command line, then #undef'd later.
1113 PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
1114 << true << ConfigMacro << Mod->getFullModuleName();
1115 auto LatestDef = LatestLocalMD->getDefinition();
1116 assert(LatestDef.isUndefined() &&
1117 "predefined macro went away with no #undef?");
1118 PP.Diag(LatestDef.getUndefLocation(), diag::note_module_def_undef_here)
1121 } else if (!CmdLineDefinition) {
1122 // There was no definition for this macro in the predefines buffer,
1123 // but there was a local definition. Complain.
1124 PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
1125 << false << ConfigMacro << Mod->getFullModuleName();
1126 PP.Diag(CurrentDefinition->getDefinitionLoc(),
1127 diag::note_module_def_undef_here)
1129 } else if (!CurrentDefinition->isIdenticalTo(*CmdLineDefinition, PP,
1130 /*Syntactically=*/true)) {
1131 // The macro definitions differ.
1132 PP.Diag(ImportLoc, diag::warn_module_config_macro_undef)
1133 << false << ConfigMacro << Mod->getFullModuleName();
1134 PP.Diag(CurrentDefinition->getDefinitionLoc(),
1135 diag::note_module_def_undef_here)
1140 /// \brief Write a new timestamp file with the given path.
1141 static void writeTimestampFile(StringRef TimestampFile) {
1143 llvm::raw_fd_ostream Out(TimestampFile.str(), EC, llvm::sys::fs::F_None);
1146 /// \brief Prune the module cache of modules that haven't been accessed in
1148 static void pruneModuleCache(const HeaderSearchOptions &HSOpts) {
1149 struct stat StatBuf;
1150 llvm::SmallString<128> TimestampFile;
1151 TimestampFile = HSOpts.ModuleCachePath;
1152 llvm::sys::path::append(TimestampFile, "modules.timestamp");
1154 // Try to stat() the timestamp file.
1155 if (::stat(TimestampFile.c_str(), &StatBuf)) {
1156 // If the timestamp file wasn't there, create one now.
1157 if (errno == ENOENT) {
1158 writeTimestampFile(TimestampFile);
1163 // Check whether the time stamp is older than our pruning interval.
1164 // If not, do nothing.
1165 time_t TimeStampModTime = StatBuf.st_mtime;
1166 time_t CurrentTime = time(nullptr);
1167 if (CurrentTime - TimeStampModTime <= time_t(HSOpts.ModuleCachePruneInterval))
1170 // Write a new timestamp file so that nobody else attempts to prune.
1171 // There is a benign race condition here, if two Clang instances happen to
1172 // notice at the same time that the timestamp is out-of-date.
1173 writeTimestampFile(TimestampFile);
1175 // Walk the entire module cache, looking for unused module files and module
1178 SmallString<128> ModuleCachePathNative;
1179 llvm::sys::path::native(HSOpts.ModuleCachePath, ModuleCachePathNative);
1180 for (llvm::sys::fs::directory_iterator Dir(ModuleCachePathNative, EC), DirEnd;
1181 Dir != DirEnd && !EC; Dir.increment(EC)) {
1182 // If we don't have a directory, there's nothing to look into.
1183 if (!llvm::sys::fs::is_directory(Dir->path()))
1186 // Walk all of the files within this directory.
1187 for (llvm::sys::fs::directory_iterator File(Dir->path(), EC), FileEnd;
1188 File != FileEnd && !EC; File.increment(EC)) {
1189 // We only care about module and global module index files.
1190 StringRef Extension = llvm::sys::path::extension(File->path());
1191 if (Extension != ".pcm" && Extension != ".timestamp" &&
1192 llvm::sys::path::filename(File->path()) != "modules.idx")
1195 // Look at this file. If we can't stat it, there's nothing interesting
1197 if (::stat(File->path().c_str(), &StatBuf))
1200 // If the file has been used recently enough, leave it there.
1201 time_t FileAccessTime = StatBuf.st_atime;
1202 if (CurrentTime - FileAccessTime <=
1203 time_t(HSOpts.ModuleCachePruneAfter)) {
1208 llvm::sys::fs::remove(File->path());
1210 // Remove the timestamp file.
1211 std::string TimpestampFilename = File->path() + ".timestamp";
1212 llvm::sys::fs::remove(TimpestampFilename);
1215 // If we removed all of the files in the directory, remove the directory
1217 if (llvm::sys::fs::directory_iterator(Dir->path(), EC) ==
1218 llvm::sys::fs::directory_iterator() && !EC)
1219 llvm::sys::fs::remove(Dir->path());
1223 void CompilerInstance::createModuleManager() {
1224 if (!ModuleManager) {
1225 if (!hasASTContext())
1228 // If we're implicitly building modules but not currently recursively
1229 // building a module, check whether we need to prune the module cache.
1230 if (getLangOpts().ImplicitModules &&
1231 getSourceManager().getModuleBuildStack().empty() &&
1232 getHeaderSearchOpts().ModuleCachePruneInterval > 0 &&
1233 getHeaderSearchOpts().ModuleCachePruneAfter > 0) {
1234 pruneModuleCache(getHeaderSearchOpts());
1237 HeaderSearchOptions &HSOpts = getHeaderSearchOpts();
1238 std::string Sysroot = HSOpts.Sysroot;
1239 const PreprocessorOptions &PPOpts = getPreprocessorOpts();
1240 ModuleManager = new ASTReader(
1241 getPreprocessor(), *Context, *getPCHContainerOperations(),
1242 Sysroot.empty() ? "" : Sysroot.c_str(), PPOpts.DisablePCHValidation,
1243 /*AllowASTWithCompilerErrors=*/false,
1244 /*AllowConfigurationMismatch=*/false,
1245 HSOpts.ModulesValidateSystemHeaders,
1246 getFrontendOpts().UseGlobalModuleIndex);
1247 if (hasASTConsumer()) {
1248 ModuleManager->setDeserializationListener(
1249 getASTConsumer().GetASTDeserializationListener());
1250 getASTContext().setASTMutationListener(
1251 getASTConsumer().GetASTMutationListener());
1253 getASTContext().setExternalSource(ModuleManager);
1255 ModuleManager->InitializeSema(getSema());
1256 if (hasASTConsumer())
1257 ModuleManager->StartTranslationUnit(&getASTConsumer());
1261 bool CompilerInstance::loadModuleFile(StringRef FileName) {
1262 // Helper to recursively read the module names for all modules we're adding.
1263 // We mark these as known and redirect any attempt to load that module to
1264 // the files we were handed.
1265 struct ReadModuleNames : ASTReaderListener {
1266 CompilerInstance &CI;
1267 std::vector<StringRef> ModuleFileStack;
1268 std::vector<StringRef> ModuleNameStack;
1270 bool TopFileIsModule;
1272 ReadModuleNames(CompilerInstance &CI)
1273 : CI(CI), Failed(false), TopFileIsModule(false) {}
1275 bool needsImportVisitation() const override { return true; }
1277 void visitImport(StringRef FileName) override {
1278 if (!CI.ExplicitlyLoadedModuleFiles.insert(FileName).second) {
1279 if (ModuleFileStack.size() == 0)
1280 TopFileIsModule = true;
1284 ModuleFileStack.push_back(FileName);
1285 ModuleNameStack.push_back(StringRef());
1286 if (ASTReader::readASTFileControlBlock(FileName, CI.getFileManager(),
1287 *CI.getPCHContainerOperations(),
1289 CI.getDiagnostics().Report(
1290 SourceLocation(), CI.getFileManager().getBufferForFile(FileName)
1291 ? diag::err_module_file_invalid
1292 : diag::err_module_file_not_found)
1294 for (int I = ModuleFileStack.size() - 2; I >= 0; --I)
1295 CI.getDiagnostics().Report(SourceLocation(),
1296 diag::note_module_file_imported_by)
1297 << ModuleFileStack[I]
1298 << !ModuleNameStack[I].empty() << ModuleNameStack[I];
1301 ModuleNameStack.pop_back();
1302 ModuleFileStack.pop_back();
1305 void ReadModuleName(StringRef ModuleName) override {
1306 if (ModuleFileStack.size() == 1)
1307 TopFileIsModule = true;
1308 ModuleNameStack.back() = ModuleName;
1310 auto &ModuleFile = CI.ModuleFileOverrides[ModuleName];
1311 if (!ModuleFile.empty() &&
1312 CI.getFileManager().getFile(ModuleFile) !=
1313 CI.getFileManager().getFile(ModuleFileStack.back()))
1314 CI.getDiagnostics().Report(SourceLocation(),
1315 diag::err_conflicting_module_files)
1316 << ModuleName << ModuleFile << ModuleFileStack.back();
1317 ModuleFile = ModuleFileStack.back();
1321 // If we don't already have an ASTReader, create one now.
1323 createModuleManager();
1325 // Tell the module manager about this module file.
1326 if (getModuleManager()->getModuleManager().addKnownModuleFile(FileName)) {
1327 getDiagnostics().Report(SourceLocation(), diag::err_module_file_not_found)
1332 // Build our mapping of module names to module files from this file
1334 RMN.visitImport(FileName);
1339 // If we never found a module name for the top file, then it's not a module,
1340 // it's a PCH or preamble or something.
1341 if (!RMN.TopFileIsModule) {
1342 getDiagnostics().Report(SourceLocation(), diag::err_module_file_not_module)
1351 CompilerInstance::loadModule(SourceLocation ImportLoc,
1353 Module::NameVisibilityKind Visibility,
1354 bool IsInclusionDirective) {
1355 // Determine what file we're searching from.
1356 StringRef ModuleName = Path[0].first->getName();
1357 SourceLocation ModuleNameLoc = Path[0].second;
1359 // If we've already handled this import, just return the cached result.
1360 // This one-element cache is important to eliminate redundant diagnostics
1361 // when both the preprocessor and parser see the same import declaration.
1362 if (!ImportLoc.isInvalid() && LastModuleImportLoc == ImportLoc) {
1363 // Make the named module visible.
1364 if (LastModuleImportResult && ModuleName != getLangOpts().CurrentModule &&
1365 ModuleName != getLangOpts().ImplementationOfModule)
1366 ModuleManager->makeModuleVisible(LastModuleImportResult, Visibility,
1368 return LastModuleImportResult;
1371 clang::Module *Module = nullptr;
1373 // If we don't already have information on this module, load the module now.
1374 llvm::DenseMap<const IdentifierInfo *, clang::Module *>::iterator Known
1375 = KnownModules.find(Path[0].first);
1376 if (Known != KnownModules.end()) {
1377 // Retrieve the cached top-level module.
1378 Module = Known->second;
1379 } else if (ModuleName == getLangOpts().CurrentModule ||
1380 ModuleName == getLangOpts().ImplementationOfModule) {
1381 // This is the module we're building.
1382 Module = PP->getHeaderSearchInfo().lookupModule(ModuleName);
1383 Known = KnownModules.insert(std::make_pair(Path[0].first, Module)).first;
1385 // Search for a module with the given name.
1386 Module = PP->getHeaderSearchInfo().lookupModule(ModuleName);
1388 getDiagnostics().Report(ModuleNameLoc, diag::err_module_not_found)
1390 << SourceRange(ImportLoc, ModuleNameLoc);
1391 ModuleBuildFailed = true;
1392 return ModuleLoadResult();
1395 auto Override = ModuleFileOverrides.find(ModuleName);
1396 bool Explicit = Override != ModuleFileOverrides.end();
1397 if (!Explicit && !getLangOpts().ImplicitModules) {
1398 getDiagnostics().Report(ModuleNameLoc, diag::err_module_build_disabled)
1400 ModuleBuildFailed = true;
1401 return ModuleLoadResult();
1404 std::string ModuleFileName =
1405 Explicit ? Override->second
1406 : PP->getHeaderSearchInfo().getModuleFileName(Module);
1408 // If we don't already have an ASTReader, create one now.
1410 createModuleManager();
1412 if (TheDependencyFileGenerator)
1413 TheDependencyFileGenerator->AttachToASTReader(*ModuleManager);
1415 if (ModuleDepCollector)
1416 ModuleDepCollector->attachToASTReader(*ModuleManager);
1418 for (auto &Listener : DependencyCollectors)
1419 Listener->attachToASTReader(*ModuleManager);
1421 // Try to load the module file.
1423 Explicit ? 0 : ASTReader::ARR_OutOfDate | ASTReader::ARR_Missing;
1424 switch (ModuleManager->ReadAST(ModuleFileName,
1425 Explicit ? serialization::MK_ExplicitModule
1426 : serialization::MK_ImplicitModule,
1427 ImportLoc, ARRFlags)) {
1428 case ASTReader::Success:
1431 case ASTReader::OutOfDate:
1432 case ASTReader::Missing: {
1434 // ReadAST has already complained for us.
1435 ModuleLoader::HadFatalFailure = true;
1436 KnownModules[Path[0].first] = nullptr;
1437 return ModuleLoadResult();
1440 // The module file is missing or out-of-date. Build it.
1441 assert(Module && "missing module file");
1442 // Check whether there is a cycle in the module graph.
1443 ModuleBuildStack ModPath = getSourceManager().getModuleBuildStack();
1444 ModuleBuildStack::iterator Pos = ModPath.begin(), PosEnd = ModPath.end();
1445 for (; Pos != PosEnd; ++Pos) {
1446 if (Pos->first == ModuleName)
1450 if (Pos != PosEnd) {
1451 SmallString<256> CyclePath;
1452 for (; Pos != PosEnd; ++Pos) {
1453 CyclePath += Pos->first;
1454 CyclePath += " -> ";
1456 CyclePath += ModuleName;
1458 getDiagnostics().Report(ModuleNameLoc, diag::err_module_cycle)
1459 << ModuleName << CyclePath;
1460 return ModuleLoadResult();
1463 // Check whether we have already attempted to build this module (but
1465 if (getPreprocessorOpts().FailedModules &&
1466 getPreprocessorOpts().FailedModules->hasAlreadyFailed(ModuleName)) {
1467 getDiagnostics().Report(ModuleNameLoc, diag::err_module_not_built)
1469 << SourceRange(ImportLoc, ModuleNameLoc);
1470 ModuleBuildFailed = true;
1471 return ModuleLoadResult();
1474 // Try to compile and then load the module.
1475 if (!compileAndLoadModule(*this, ImportLoc, ModuleNameLoc, Module,
1477 assert(getDiagnostics().hasErrorOccurred() &&
1478 "undiagnosed error in compileAndLoadModule");
1479 if (getPreprocessorOpts().FailedModules)
1480 getPreprocessorOpts().FailedModules->addFailed(ModuleName);
1481 KnownModules[Path[0].first] = nullptr;
1482 ModuleBuildFailed = true;
1483 return ModuleLoadResult();
1486 // Okay, we've rebuilt and now loaded the module.
1490 case ASTReader::VersionMismatch:
1491 case ASTReader::ConfigurationMismatch:
1492 case ASTReader::HadErrors:
1493 ModuleLoader::HadFatalFailure = true;
1494 // FIXME: The ASTReader will already have complained, but can we showhorn
1495 // that diagnostic information into a more useful form?
1496 KnownModules[Path[0].first] = nullptr;
1497 return ModuleLoadResult();
1499 case ASTReader::Failure:
1500 ModuleLoader::HadFatalFailure = true;
1501 // Already complained, but note now that we failed.
1502 KnownModules[Path[0].first] = nullptr;
1503 ModuleBuildFailed = true;
1504 return ModuleLoadResult();
1507 // Cache the result of this top-level module lookup for later.
1508 Known = KnownModules.insert(std::make_pair(Path[0].first, Module)).first;
1511 // If we never found the module, fail.
1513 return ModuleLoadResult();
1515 // Verify that the rest of the module path actually corresponds to
1517 if (Path.size() > 1) {
1518 for (unsigned I = 1, N = Path.size(); I != N; ++I) {
1519 StringRef Name = Path[I].first->getName();
1520 clang::Module *Sub = Module->findSubmodule(Name);
1523 // Attempt to perform typo correction to find a module name that works.
1524 SmallVector<StringRef, 2> Best;
1525 unsigned BestEditDistance = (std::numeric_limits<unsigned>::max)();
1527 for (clang::Module::submodule_iterator J = Module->submodule_begin(),
1528 JEnd = Module->submodule_end();
1530 unsigned ED = Name.edit_distance((*J)->Name,
1531 /*AllowReplacements=*/true,
1533 if (ED <= BestEditDistance) {
1534 if (ED < BestEditDistance) {
1536 BestEditDistance = ED;
1539 Best.push_back((*J)->Name);
1543 // If there was a clear winner, user it.
1544 if (Best.size() == 1) {
1545 getDiagnostics().Report(Path[I].second,
1546 diag::err_no_submodule_suggest)
1547 << Path[I].first << Module->getFullModuleName() << Best[0]
1548 << SourceRange(Path[0].second, Path[I-1].second)
1549 << FixItHint::CreateReplacement(SourceRange(Path[I].second),
1552 Sub = Module->findSubmodule(Best[0]);
1557 // No submodule by this name. Complain, and don't look for further
1559 getDiagnostics().Report(Path[I].second, diag::err_no_submodule)
1560 << Path[I].first << Module->getFullModuleName()
1561 << SourceRange(Path[0].second, Path[I-1].second);
1569 // Don't make the module visible if we are in the implementation.
1570 if (ModuleName == getLangOpts().ImplementationOfModule)
1571 return ModuleLoadResult(Module, false);
1573 // Make the named module visible, if it's not already part of the module
1575 if (ModuleName != getLangOpts().CurrentModule) {
1576 if (!Module->IsFromModuleFile) {
1577 // We have an umbrella header or directory that doesn't actually include
1578 // all of the headers within the directory it covers. Complain about
1579 // this missing submodule and recover by forgetting that we ever saw
1581 // FIXME: Should we detect this at module load time? It seems fairly
1582 // expensive (and rare).
1583 getDiagnostics().Report(ImportLoc, diag::warn_missing_submodule)
1584 << Module->getFullModuleName()
1585 << SourceRange(Path.front().second, Path.back().second);
1587 return ModuleLoadResult(nullptr, true);
1590 // Check whether this module is available.
1591 clang::Module::Requirement Requirement;
1592 clang::Module::UnresolvedHeaderDirective MissingHeader;
1593 if (!Module->isAvailable(getLangOpts(), getTarget(), Requirement,
1595 if (MissingHeader.FileNameLoc.isValid()) {
1596 getDiagnostics().Report(MissingHeader.FileNameLoc,
1597 diag::err_module_header_missing)
1598 << MissingHeader.IsUmbrella << MissingHeader.FileName;
1600 getDiagnostics().Report(ImportLoc, diag::err_module_unavailable)
1601 << Module->getFullModuleName()
1602 << Requirement.second << Requirement.first
1603 << SourceRange(Path.front().second, Path.back().second);
1605 LastModuleImportLoc = ImportLoc;
1606 LastModuleImportResult = ModuleLoadResult();
1607 return ModuleLoadResult();
1610 ModuleManager->makeModuleVisible(Module, Visibility, ImportLoc);
1613 // Check for any configuration macros that have changed.
1614 clang::Module *TopModule = Module->getTopLevelModule();
1615 for (unsigned I = 0, N = TopModule->ConfigMacros.size(); I != N; ++I) {
1616 checkConfigMacro(getPreprocessor(), TopModule->ConfigMacros[I],
1620 LastModuleImportLoc = ImportLoc;
1621 LastModuleImportResult = ModuleLoadResult(Module, false);
1622 return LastModuleImportResult;
1625 void CompilerInstance::makeModuleVisible(Module *Mod,
1626 Module::NameVisibilityKind Visibility,
1627 SourceLocation ImportLoc) {
1629 createModuleManager();
1633 ModuleManager->makeModuleVisible(Mod, Visibility, ImportLoc);
1636 GlobalModuleIndex *CompilerInstance::loadGlobalModuleIndex(
1637 SourceLocation TriggerLoc) {
1639 createModuleManager();
1640 // Can't do anything if we don't have the module manager.
1643 // Get an existing global index. This loads it if not already
1645 ModuleManager->loadGlobalIndex();
1646 GlobalModuleIndex *GlobalIndex = ModuleManager->getGlobalIndex();
1647 // If the global index doesn't exist, create it.
1648 if (!GlobalIndex && shouldBuildGlobalModuleIndex() && hasFileManager() &&
1649 hasPreprocessor()) {
1650 llvm::sys::fs::create_directories(
1651 getPreprocessor().getHeaderSearchInfo().getModuleCachePath());
1652 GlobalModuleIndex::writeIndex(
1653 getFileManager(), *getPCHContainerOperations(),
1654 getPreprocessor().getHeaderSearchInfo().getModuleCachePath());
1655 ModuleManager->resetForReload();
1656 ModuleManager->loadGlobalIndex();
1657 GlobalIndex = ModuleManager->getGlobalIndex();
1659 // For finding modules needing to be imported for fixit messages,
1660 // we need to make the global index cover all modules, so we do that here.
1661 if (!HaveFullGlobalModuleIndex && GlobalIndex && !buildingModule()) {
1662 ModuleMap &MMap = getPreprocessor().getHeaderSearchInfo().getModuleMap();
1663 bool RecreateIndex = false;
1664 for (ModuleMap::module_iterator I = MMap.module_begin(),
1665 E = MMap.module_end(); I != E; ++I) {
1666 Module *TheModule = I->second;
1667 const FileEntry *Entry = TheModule->getASTFile();
1669 SmallVector<std::pair<IdentifierInfo *, SourceLocation>, 2> Path;
1670 Path.push_back(std::make_pair(
1671 getPreprocessor().getIdentifierInfo(TheModule->Name), TriggerLoc));
1672 std::reverse(Path.begin(), Path.end());
1673 // Load a module as hidden. This also adds it to the global index.
1674 loadModule(TheModule->DefinitionLoc, Path,
1675 Module::Hidden, false);
1676 RecreateIndex = true;
1679 if (RecreateIndex) {
1680 GlobalModuleIndex::writeIndex(
1681 getFileManager(), *getPCHContainerOperations(),
1682 getPreprocessor().getHeaderSearchInfo().getModuleCachePath());
1683 ModuleManager->resetForReload();
1684 ModuleManager->loadGlobalIndex();
1685 GlobalIndex = ModuleManager->getGlobalIndex();
1687 HaveFullGlobalModuleIndex = true;
1692 // Check global module index for missing imports.
1694 CompilerInstance::lookupMissingImports(StringRef Name,
1695 SourceLocation TriggerLoc) {
1696 // Look for the symbol in non-imported modules, but only if an error
1697 // actually occurred.
1698 if (!buildingModule()) {
1699 // Load global module index, or retrieve a previously loaded one.
1700 GlobalModuleIndex *GlobalIndex = loadGlobalModuleIndex(
1703 // Only if we have a global index.
1705 GlobalModuleIndex::HitSet FoundModules;
1707 // Find the modules that reference the identifier.
1708 // Note that this only finds top-level modules.
1709 // We'll let diagnoseTypo find the actual declaration module.
1710 if (GlobalIndex->lookupIdentifier(Name, FoundModules))
1717 void CompilerInstance::resetAndLeakSema() { BuryPointer(takeSema()); }